c0c2e0e7bf75983c9d79146f3cefd3fb26bbf853
[sip-router] / rvalue.h
1 /* 
2  * Copyright (C) 2008 iptelorg GmbH
3  *
4  * Permission to use, copy, modify, and distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16  
17 /**
18  * @file 
19  * @brief SIP-router core :: rvalue expressions
20  * @ingroup core
21  * Module: \ref core
22  */
23  
24 /* 
25  * History:
26  * --------
27  *  2008-11-30  initial version (andrei)
28  *  2009-04-28  added string and interger versions for the EQ and DIFF
29  *              operators (andrei)
30  *  2009-05-05  casts operator for int & string (andrei)
31  *  2010-03-16  space for an int2str result inside rval_cache (andrei)
32  */
33
34 #ifndef _rvalue_h_
35 #define _rvalue_h_
36
37 #include "str.h"
38 #include "ut.h"
39 #include "usr_avp.h"
40 #include "select.h"
41 #include "pvar.h"
42 #include "route.h"
43 #include "parser/msg_parser.h"
44 #include "action.h"
45
46 enum rval_type{
47         RV_NONE, RV_INT, RV_STR, /* basic types */
48         RV_BEXPR, RV_ACTION_ST,  /* special values */
49         RV_SEL, RV_AVP, RV_PVAR
50 };
51
52 enum rval_expr_op{
53         RVE_NONE_OP,  /**< uninit / empty */
54         RVE_RVAL_OP,  /**< special op, means that the expr. is in fact a rval */
55         RVE_UMINUS_OP, /**< one member expression, returns -(val) */
56         RVE_BOOL_OP,  /**< one member evaluate as bool. : (val!=0)*/
57         RVE_LNOT_OP,  /**< one member evaluate as bool. : (!val)*/
58         RVE_BNOT_OP,  /**< one member evaluate as binary : (~ val)*/
59         RVE_MUL_OP,   /**< 2 members, returns left * right */
60         RVE_DIV_OP,   /**< 2 members, returns left / right */
61         RVE_MOD_OP,   /**< 2 members, returns left % right */
62         RVE_MINUS_OP, /**< 2 members, returns left - right */
63         RVE_BAND_OP,  /**< 2 members, returns left | right */
64         RVE_BOR_OP,   /**< 2 members, returns left & right */
65         RVE_BXOR_OP,   /**< 2 members, returns left XOR right */
66         RVE_BLSHIFT_OP, /**< 2 members, returns left << right */
67         RVE_BRSHIFT_OP, /**< 2 members, returns left >> right */
68         RVE_LAND_OP,  /**< 2 members, returns left && right */
69         RVE_LOR_OP,   /**< 2 members, returns left || right */
70         RVE_GT_OP,    /**<  2 members, returns left > right */
71         RVE_GTE_OP,   /**<  2 members, returns left >= right */
72         RVE_LT_OP,    /**<  2 members, returns left  < right */
73         RVE_LTE_OP,   /**<  2 members, returns left <= right */
74         RVE_IEQ_OP,   /**<  2 members, int == version, returns left == right */
75         RVE_IDIFF_OP, /**< 2 members, int != version, returns left != right */
76         RVE_IPLUS_OP, /**< 2 members, integer +, returns int(a)+int(b) */
77         /* common int & str */
78         RVE_PLUS_OP,  /**< generic plus (int or str) returns left + right */
79         RVE_EQ_OP,    /**<  2 members, returns left == right  (int)*/
80         RVE_DIFF_OP,  /**<  2 members, returns left != right  (int)*/
81         /* str only */
82         RVE_CONCAT_OP, /**< 2 members, string concat, returns left . right (str)*/
83         RVE_STRLEN_OP, /**< one member, string length:, returns strlen(val) (int)*/
84         RVE_STREMPTY_OP, /**< one member, returns val=="" (bool) */
85         RVE_STREQ_OP,  /**< 2 members, string == , returns left == right (bool)*/
86         RVE_STRDIFF_OP,/**< 2 members, string != , returns left != right (bool)*/
87         RVE_MATCH_OP,  /**< 2 members, string ~),  returns left matches re(right) */
88         /* avp, pvars a.s.o */
89         RVE_DEFINED_OP, /**< one member, returns is_defined(val) (bool) */
90         RVE_NOTDEFINED_OP, /**< one member, returns is_not_defined(val) (bool) */
91         RVE_INT_OP,   /**< one member, returns (int)val  (int) */
92         RVE_STR_OP    /**< one member, returns (str)val  (str) */
93 };
94
95
96 struct str_re{
97         str s;
98         regex_t* regex;
99 };
100
101 union rval_val{
102         void* p;
103         long  l;
104         str s;
105         avp_spec_t avps;
106         select_t sel;
107         pv_spec_t pvs;
108         struct action* action;
109         struct expr* bexpr;
110         struct str_re re;
111 };
112
113
114 struct rvalue{
115         enum rval_type type;
116         int refcnt; /**< refcnt, on 0 the structure is destroyed */
117         union rval_val v;
118         int bsize; /**< extra data size */
119         short flags;
120         char buf[1]; /**< extra data, like string contents can be stored here */
121 };
122
123
124 /* rvalue flags */
125 #define RV_CNT_ALLOCED_F  1  /**< free contents  (pkg mem allocated) */
126 #define RV_RV_ALLOCED_F   2  /**< free rv itself (pkg_free(rv)) */
127 #define RV_ALL_ALLOCED_F  (RV_CNT_ALLOCED|RV_RV_ALLOCED)
128 #define RV_RE_F  4 /**< string is a RE with a valid v->re member */
129 #define RV_RE_ALLOCED_F 8 /**< v->re.regex must be freed */
130
131 struct rval_expr{
132         enum rval_expr_op op;
133         union{
134                 struct rval_expr* rve;
135                 struct rvalue rval;
136         }left;
137         union{
138                 struct rval_expr* rve;
139                 struct rvalue rval;
140         }right;
141         struct cfg_pos fpos;
142 };
143
144
145 enum rval_cache_type{
146         RV_CACHE_EMPTY,
147         RV_CACHE_PVAR,
148         RV_CACHE_AVP,
149         RV_CACHE_SELECT,
150         RV_CACHE_INT2STR
151 };
152
153 /** value cache for a rvalue struct.
154   * Used to optimize functions that would need to 
155   * get the value repeatedly (e.g. rval_get_btype() and then rval_get_int())
156   */
157 struct rval_cache{
158         enum rval_cache_type cache_type;
159         enum rval_type val_type;
160         union{
161                 int_str avp_val; /**< avp value */
162                 pv_value_t pval; /**< pvar value */
163         }c;
164         char i2s[INT2STR_MAX_LEN]; /**< space for converting an int to string*/
165 };
166
167
168
169 /** allocates a new rval (should be freed by rval_destroy()). */
170 struct rvalue* rval_new_empty(int extra_size);
171 struct rvalue* rval_new_str(str* s, int extra_size);
172
173 /**
174  * @brief create a new pk_malloc'ed rvalue from a rval_val union
175  * @param t rvalue type
176  * @param v rvalue value
177  * @param extra_size extra space to allocate
178  * (so that future string operation can reuse the space)
179  * @return new rv or 0 on error
180  */
181 struct rvalue* rval_new(enum rval_type t, union rval_val* v, int extra_size);
182
183 /** inits a rvalue structure- */
184 void rval_init(struct rvalue* rv, enum rval_type t, union rval_val* v,
185                                         int flags);
186 /** frees a rval_new(), rval_convert() or rval_expr_eval() returned rval. */
187 void rval_destroy(struct rvalue* rv);
188
189 /** frees a rval contents */
190 void rval_clean(struct rvalue* rv);
191
192 /** init a rval_cache struct */
193 #define rval_cache_init(rvc) \
194         do{ (rvc)->cache_type=RV_CACHE_EMPTY; (rvc)->val_type=RV_NONE; }while(0)
195
196 /** destroy a rval_cache struct contents */
197 void rval_cache_clean(struct rval_cache* rvc);
198
199
200 /**
201  * @brief Convert a rvalue to another rvalue, of a specific type
202  *
203  * Convert a rvalue to another rvalue, of a specific type.
204  * The result is read-only in most cases (can be a reference
205  * to another rvalue, can be checked by using rv_chg_in_place()) and
206  * _must_ be rval_destroy()'ed.
207  *
208  * @param h run action context
209  * @param msg SIP mesasge
210  * @param type - type to convert to
211  * @param v - rvalue to convert
212  * @param c - rval_cache (cached v value if known/filled by another
213  *            function), can be 0 (unknown/not needed)
214  * @return pointer to a rvalue (reference to an existing one or a new
215  * one, @see rv_chg_in_place() and the above comment), or 0 on error.
216  */
217 struct rvalue* rval_convert(struct run_act_ctx* h, struct sip_msg* msg, 
218                                                         enum rval_type type, struct rvalue* v,
219                                                         struct rval_cache* c);
220
221 /** get the integer value of an rvalue. */
222 int rval_get_int(struct run_act_ctx* h, struct sip_msg* msg, int* i, 
223                                 struct rvalue* rv, struct rval_cache* cache);
224 /** get the string value of an rv. */
225 int rval_get_str(struct run_act_ctx* h, struct sip_msg* msg,
226                                                                 str* s, struct rvalue* rv,
227                                                                 struct rval_cache* cache);
228 /** get the string value of an rv in a tmp variable */
229 int rval_get_tmp_str(struct run_act_ctx* h, struct sip_msg* msg,
230                                                                 str* tmpv, struct rvalue* rv,
231                                                                 struct rval_cache* cache,
232                                                                 struct rval_cache* tmp_cache);
233
234 /** evals an integer expr  to an int. */
235 int rval_expr_eval_int( struct run_act_ctx* h, struct sip_msg* msg,
236                                                 int* res, struct rval_expr* rve);
237
238 /**
239  * @brief Evals a rval expression
240  * @warning result must be rval_destroy()'ed if non-null (it might be
241  * a reference to another rval). The result can be modified only
242  * if rv_chg_in_place() returns true.
243  * @param h run action context
244  * @param msg SIP message
245  * @param rve rvalue expression
246  * @return rvalue on success, 0 on error
247  */
248 struct rvalue* rval_expr_eval(struct run_act_ctx* h, struct sip_msg* msg,
249                                                                 struct rval_expr* rve);
250
251 /**
252  * @brief Evals a rval expression into an int or another rv(str)
253  * @warning rv result (rv_res) must be rval_destroy()'ed if non-null
254  * (it might be a reference to another rval). The result can be
255  * modified only if rv_chg_in_place() returns true.
256  * @param h run action context
257  * @param msg SIP message
258  * @param res_rv pointer to rvalue result, if non-null it means the 
259  * expression evaluated to a non-int (str), which will be stored here.
260  * @param res_i pointer to int result, if res_rv==0 and the function
261  * returns success => the result is an int which will be stored here.
262  * @param rve expression that will be evaluated.
263  * @param cache write-only value cache, it might be filled if non-null and
264  * empty (rval_cache_init()). If non-null, it _must_ be rval_cache_clean()'ed
265  * when done. 
266  * @return 0 on success, -1 on error, sets *res_rv or *res_i.
267  */
268 int rval_expr_eval_rvint( struct run_act_ctx* h, struct sip_msg* msg,
269                                                  struct rvalue** rv_res, int* i_res,
270                                                  struct rval_expr* rve, struct rval_cache* cache);
271
272
273 /** guess the type of an expression.  */
274 enum rval_type rve_guess_type(struct rval_expr* rve);
275 /** returns true if expression is constant. */
276 int rve_is_constant(struct rval_expr* rve);
277 /** returns true if the expression can have side-effect */
278 int rve_has_side_effects(struct rval_expr* rve);
279
280 /**
281  * @brief Returns 1 if expression is valid (type-wise)
282  * @param type filled with the type of the expression (RV_INT, RV_STR or
283  *                RV_NONE if it's dynamic)
284  * @param rve  checked expression
285  * @param bad_rve set on failure to the subexpression for which the 
286  * type check failed
287  * @param bad_t set on failure to the type of the bad subexpression
288  * @param exp_t set on failure to the expected type for the bad
289  * subexpression
290  * @return 0 or 1 and sets *type to the resulting type
291  * (RV_INT, RV_STR or RV_NONE if it can be found only at runtime)
292  */
293 int rve_check_type(enum rval_type* type, struct rval_expr* rve,
294                                         struct rval_expr** bad_rve, enum rval_type* bad_type,
295                                         enum rval_type* exp_type);
296 /** returns a string name for type (debugging).*/
297 char* rval_type_name(enum rval_type type);
298
299 /** create a RVE_RVAL_OP rval_expr, containing a single rval of the given type
300   */
301 struct rval_expr* mk_rval_expr_v(enum rval_type rv_type, void* val,
302                                                                         struct cfg_pos* pos);
303
304 /**
305  * @brief Create a unary op. rval_expr
306  * ret= op rve1
307  * @param op   - rval expr. unary operator
308  * @param rve1 - rval expr. on which the operator will act.
309  * @param pos configuration position
310  * @return new pkg_malloc'ed rval_expr or 0 on error.
311  */
312 struct rval_expr* mk_rval_expr1(enum rval_expr_op op, struct rval_expr* rve1,
313                                                                         struct cfg_pos* pos);
314
315 /**
316  * @brief Create a rval_expr. from 2 other rval exprs, using op
317  * ret = rve1 op rve2
318  * @param op   - rval expr. operator
319  * @param rve1 - rval expr. on which the operator will act.
320  * @param rve2 - rval expr. on which the operator will act.
321  * @param pos configuration position
322  * @return new pkg_malloc'ed rval_expr or 0 on error.
323  */
324 struct rval_expr* mk_rval_expr2(enum rval_expr_op op, struct rval_expr* rve1,
325                                                                                                           struct rval_expr* rve2,
326                                                                                                           struct cfg_pos* pos);
327 /** destroys a pkg_malloc'ed rve. */
328 void rve_destroy(struct rval_expr* rve);
329
330 /** fix a rval_expr. */
331 int fix_rval_expr(void* p);
332 #endif /* _rvalue_h */