a bunch of small refactorings in the dialog module
[sip-router] / rvalue.h
1 /* 
2  * $Id$
3  * 
4  * Copyright (C) 2008 iptelorg GmbH
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 /**
19  * @file 
20  * @brief rvalue expressions
21  */
22 /* 
23  * History:
24  * --------
25  *  2008-11-30  initial version (andrei)
26  */
27
28 #ifndef _rvalue_h_
29 #define _rvalue_h_
30
31 #include "str.h"
32 #include "usr_avp.h"
33 #include "select.h"
34 #include "pvar.h"
35 #include "route.h"
36 #include "parser/msg_parser.h"
37 #include "action.h"
38
39 enum rval_type{
40         RV_NONE, RV_INT, RV_STR, /* basic types */
41         RV_BEXPR, RV_ACTION_ST,  /* special values */
42         RV_SEL, RV_AVP, RV_PVAR
43 };
44
45 enum rval_expr_op{
46         RVE_NONE_OP,  /* uninit / empty */
47         RVE_RVAL_OP,  /* special op, means that the expr. is in fact a rval */
48         RVE_UMINUS_OP, /* one member expression, returns -(val) */
49         RVE_BOOL_OP,  /* one member evaluate as bool. : (val!=0)*/
50         RVE_LNOT_OP,  /* one member evaluate as bool. : (!val)*/
51         RVE_MUL_OP,   /* 2 members, returns left * right */
52         RVE_DIV_OP,   /* 2 members, returns left / right */
53         RVE_MINUS_OP, /* 2 members, returns left - right */
54         RVE_BAND_OP,  /* 2 members, returns left | right */
55         RVE_BOR_OP,   /* 2 members, returns left & right */
56         RVE_LAND_OP,  /* 2 members, returns left && right */
57         RVE_LOR_OP,   /* 2 members, returns left || right */
58         RVE_GT_OP,    /*  2 members, returns left > right */
59         RVE_GTE_OP,   /*  2 members, returns left >= right */
60         RVE_LT_OP,    /*  2 members, returns left  < right */
61         RVE_LTE_OP,   /*  2 members, returns left <= right */
62         RVE_IPLUS_OP, /* 2 members, integer +, returns int(a)+int(b) */
63         /* common int & str */
64         RVE_PLUS_OP,  /* generic plus (int or str) returns left + right */
65         RVE_EQ_OP,    /*  2 members, returns left == right  (int)*/
66         RVE_DIFF_OP,  /*  2 members, returns left != right  (int)*/
67         /* str only */
68         RVE_CONCAT_OP,/* 2 members, string concat, returns left . right (str)*/
69         RVE_STRLEN_OP, /* one member, string length:, returns strlen(val) (int)*/
70         RVE_STREMPTY_OP, /* one member, returns val=="" (bool) */
71         /* avp, pvars a.s.o */
72         RVE_DEFINED_OP, /* one member, returns is_defined(val) (bool) */
73 };
74
75
76 union rval_val{
77         void* p;
78         long  l;
79         str s;
80         avp_spec_t avps;
81         select_t sel;
82         pv_spec_t pvs;
83         struct action* action;
84         struct expr* bexpr;
85 };
86
87
88 struct rvalue{
89         enum rval_type type;
90         int refcnt; /**< refcnt, on 0 the structure is destroyed */
91         union rval_val v;
92         int bsize; /**< extra data size */
93         short flags;
94         char buf[1]; /**< extra data, like string contents can be stored here */
95 };
96
97
98 /* rvalue flags */
99 #define RV_CNT_ALLOCED_F  1  /* free contents  (pkg mem allocated) */
100 #define RV_RV_ALLOCED_F   2  /* free rv itself (pkg_free(rv)) */
101 #define RV_ALL_ALLOCED_F  (RV_CNT_ALLOCED|RV_RV_ALLOCED)
102
103
104 struct rval_expr{
105         enum rval_expr_op op;
106         union{
107                 struct rval_expr* rve;
108                 struct rvalue rval;
109         }left;
110         union{
111                 struct rval_expr* rve;
112                 struct rvalue rval;
113         }right;
114         struct cfg_pos fpos;
115 };
116
117
118 enum rval_cache_type{
119         RV_CACHE_EMPTY,
120         RV_CACHE_PVAR,
121         RV_CACHE_AVP
122 };
123
124 /** value cache for a rvalue struct.
125   * Used to optimize functions that would need to 
126   * get the value repeatedly (e.g. rval_get_btype() and then rval_get_int())
127   */
128 struct rval_cache{
129         enum rval_cache_type cache_type;
130         enum rval_type val_type;
131         union{
132                 int_str avp_val; /**< avp value */
133                 pv_value_t pval; /**< pvar value */
134         }c;
135 };
136
137
138
139 /** allocates a new rval (should be freed by rval_destroy()). */
140 struct rvalue* rval_new_empty(int extra_size);
141 struct rvalue* rval_new_str(str* s, int extra_size);
142 struct rvalue* rval_new(enum rval_type t, union rval_val* v, int extra_size);
143
144 /** inits a rvalue structure- */
145 void rval_init(struct rvalue* rv, enum rval_type t, union rval_val* v,
146                                         int flags);
147 /** frees a rval_new(), rval_convert() or rval_expr_eval() returned rval. */
148 void rval_destroy(struct rvalue* rv);
149
150 /** frees a rval contents */
151 void rval_clean(struct rvalue* rv);
152
153 /** init a rval_cache struct */
154 #define rval_cache_init(rvc) \
155         do{ (rvc)->cache_type=RV_CACHE_EMPTY; (rvc)->val_type=RV_NONE; }while(0)
156
157 /** destroy a rval_cache struct contents */
158 void rval_cache_clean(struct rval_cache* rvc);
159
160
161 /** convert a rvalue to another type.  */
162 struct rvalue* rval_convert(struct run_act_ctx* h, struct sip_msg* msg, 
163                                                         enum rval_type type, struct rvalue* v,
164                                                         struct rval_cache* c);
165
166 /** get the integer value of an rvalue. */
167 int rval_get_int(struct run_act_ctx* h, struct sip_msg* msg, int* i, 
168                                 struct rvalue* rv, struct rval_cache* cache);
169 /** get the string value of an rv. */
170 int rval_get_str(struct run_act_ctx* h, struct sip_msg* msg,
171                                                                 str* s, struct rvalue* rv,
172                                                                 struct rval_cache* cache);
173 /** get the string value of an rv in a tmp variable */
174 int rval_get_tmp_str(struct run_act_ctx* h, struct sip_msg* msg,
175                                                                 str* tmpv, struct rvalue* rv,
176                                                                 struct rval_cache* cache,
177                                                                 struct rval_cache* tmp_cache);
178
179 /** evals an integer expr  to an int. */
180 int rval_expr_eval_int( struct run_act_ctx* h, struct sip_msg* msg,
181                                                 int* res, struct rval_expr* rve);
182 /** evals a rval expr.. */
183 struct rvalue* rval_expr_eval(struct run_act_ctx* h, struct sip_msg* msg,
184                                                                 struct rval_expr* rve);
185 /** evals an integer expr  to an int or rvalue. */
186 int rval_expr_eval_rvint( struct run_act_ctx* h, struct sip_msg* msg,
187                                                  struct rvalue** rv_res, int* i_res,
188                                                  struct rval_expr* rve, struct rval_cache* cache);
189
190
191 /** guess the type of an expression.  */
192 enum rval_type rve_guess_type(struct rval_expr* rve);
193 /** returns true if expression is constant. */
194 int rve_is_constant(struct rval_expr* rve);
195 /** returns true if the expression can have side-effect */
196 int rve_has_side_effects(struct rval_expr* rve);
197 /** returns 1 if expression is valid (type-wise).*/
198 int rve_check_type(enum rval_type* type, struct rval_expr* rve,
199                                         struct rval_expr** bad_rve, enum rval_type* bad_type,
200                                         enum rval_type* exp_type);
201 /** returns a string name for type (debugging).*/
202 char* rval_type_name(enum rval_type type);
203
204 /** create a RVE_RVAL_OP rval_expr, containing a single rval of the given type
205   */
206 struct rval_expr* mk_rval_expr_v(enum rval_type rv_type, void* val,
207                                                                         struct cfg_pos* pos);
208 /** create a unary op. rval_expr.. */
209 struct rval_expr* mk_rval_expr1(enum rval_expr_op op, struct rval_expr* rve1,
210                                                                         struct cfg_pos* pos);
211 /** create a rval_expr. from 2 other rval exprs, using op. */
212 struct rval_expr* mk_rval_expr2(enum rval_expr_op op, struct rval_expr* rve1,
213                                                                                                           struct rval_expr* rve2,
214                                                                                                           struct cfg_pos* pos);
215 /** destroys a pkg_malloc'ed rve. */
216 void rve_destroy(struct rval_expr* rve);
217
218 /** fix a rval_expr. */
219 int fix_rval_expr(void** p);
220 #endif /* _rvalue_h */