8e67c2e9af908dc35ce6c1ae52aa5fca1c5717d1
[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  *  2009-04-28  added string and interger versions for the EQ and DIFF
27  *              operators (andrei)
28  *  2009-05-05  casts operator for int & string (andrei)
29  *  2010-03-16  space for an int2str result inside rval_cache (andrei)
30  */
31
32 #ifndef _rvalue_h_
33 #define _rvalue_h_
34
35 #include "str.h"
36 #include "ut.h"
37 #include "usr_avp.h"
38 #include "select.h"
39 #include "pvar.h"
40 #include "route.h"
41 #include "parser/msg_parser.h"
42 #include "action.h"
43
44 enum rval_type{
45         RV_NONE, RV_INT, RV_STR, /* basic types */
46         RV_BEXPR, RV_ACTION_ST,  /* special values */
47         RV_SEL, RV_AVP, RV_PVAR
48 };
49
50 enum rval_expr_op{
51         RVE_NONE_OP,  /* uninit / empty */
52         RVE_RVAL_OP,  /* special op, means that the expr. is in fact a rval */
53         RVE_UMINUS_OP, /* one member expression, returns -(val) */
54         RVE_BOOL_OP,  /* one member evaluate as bool. : (val!=0)*/
55         RVE_LNOT_OP,  /* one member evaluate as bool. : (!val)*/
56         RVE_MUL_OP,   /* 2 members, returns left * right */
57         RVE_DIV_OP,   /* 2 members, returns left / right */
58         RVE_MOD_OP,   /* 2 members, returns left % right */
59         RVE_MINUS_OP, /* 2 members, returns left - right */
60         RVE_BAND_OP,  /* 2 members, returns left | right */
61         RVE_BOR_OP,   /* 2 members, returns left & right */
62         RVE_LAND_OP,  /* 2 members, returns left && right */
63         RVE_LOR_OP,   /* 2 members, returns left || right */
64         RVE_GT_OP,    /*  2 members, returns left > right */
65         RVE_GTE_OP,   /*  2 members, returns left >= right */
66         RVE_LT_OP,    /*  2 members, returns left  < right */
67         RVE_LTE_OP,   /*  2 members, returns left <= right */
68         RVE_IEQ_OP, /*  2 members, int == version, returns left == right */
69         RVE_IDIFF_OP,/* 2 members, int != version, returns left != right */
70         RVE_IPLUS_OP, /* 2 members, integer +, returns int(a)+int(b) */
71         /* common int & str */
72         RVE_PLUS_OP,  /* generic plus (int or str) returns left + right */
73         RVE_EQ_OP,    /*  2 members, returns left == right  (int)*/
74         RVE_DIFF_OP,  /*  2 members, returns left != right  (int)*/
75         /* str only */
76         RVE_CONCAT_OP,/* 2 members, string concat, returns left . right (str)*/
77         RVE_STRLEN_OP, /* one member, string length:, returns strlen(val) (int)*/
78         RVE_STREMPTY_OP, /* one member, returns val=="" (bool) */
79         RVE_STREQ_OP,  /* 2 members, string == , returns left == right (bool)*/
80         RVE_STRDIFF_OP,/* 2 members, string != , returns left != right (bool)*/
81         RVE_MATCH_OP,  /* 2 members, string ~),  returns left matches re(right) */
82         /* avp, pvars a.s.o */
83         RVE_DEFINED_OP, /* one member, returns is_defined(val) (bool) */
84         RVE_INT_OP,   /* one member, returns (int)val  (int) */
85         RVE_STR_OP    /* one member, returns (str)val  (str) */
86 };
87
88
89 struct str_re{
90         str s;
91         regex_t* regex;
92 };
93
94 union rval_val{
95         void* p;
96         long  l;
97         str s;
98         avp_spec_t avps;
99         select_t sel;
100         pv_spec_t pvs;
101         struct action* action;
102         struct expr* bexpr;
103         struct str_re re;
104 };
105
106
107 struct rvalue{
108         enum rval_type type;
109         int refcnt; /**< refcnt, on 0 the structure is destroyed */
110         union rval_val v;
111         int bsize; /**< extra data size */
112         short flags;
113         char buf[1]; /**< extra data, like string contents can be stored here */
114 };
115
116
117 /* rvalue flags */
118 #define RV_CNT_ALLOCED_F  1  /* free contents  (pkg mem allocated) */
119 #define RV_RV_ALLOCED_F   2  /* free rv itself (pkg_free(rv)) */
120 #define RV_ALL_ALLOCED_F  (RV_CNT_ALLOCED|RV_RV_ALLOCED)
121 #define RV_RE_F  4 /* string is a RE with a valid v->re member */
122 #define RV_RE_ALLOCED_F 8 /* v->re.regex must be freed */
123
124
125 struct rval_expr{
126         enum rval_expr_op op;
127         union{
128                 struct rval_expr* rve;
129                 struct rvalue rval;
130         }left;
131         union{
132                 struct rval_expr* rve;
133                 struct rvalue rval;
134         }right;
135         struct cfg_pos fpos;
136 };
137
138
139 enum rval_cache_type{
140         RV_CACHE_EMPTY,
141         RV_CACHE_PVAR,
142         RV_CACHE_AVP,
143         RV_CACHE_SELECT,
144         RV_CACHE_INT2STR
145 };
146
147 /** value cache for a rvalue struct.
148   * Used to optimize functions that would need to 
149   * get the value repeatedly (e.g. rval_get_btype() and then rval_get_int())
150   */
151 struct rval_cache{
152         enum rval_cache_type cache_type;
153         enum rval_type val_type;
154         union{
155                 int_str avp_val; /**< avp value */
156                 pv_value_t pval; /**< pvar value */
157         }c;
158         char i2s[INT2STR_MAX_LEN]; /**< space for converting an int to string*/
159 };
160
161
162
163 /** allocates a new rval (should be freed by rval_destroy()). */
164 struct rvalue* rval_new_empty(int extra_size);
165 struct rvalue* rval_new_str(str* s, int extra_size);
166 struct rvalue* rval_new(enum rval_type t, union rval_val* v, int extra_size);
167
168 /** inits a rvalue structure- */
169 void rval_init(struct rvalue* rv, enum rval_type t, union rval_val* v,
170                                         int flags);
171 /** frees a rval_new(), rval_convert() or rval_expr_eval() returned rval. */
172 void rval_destroy(struct rvalue* rv);
173
174 /** frees a rval contents */
175 void rval_clean(struct rvalue* rv);
176
177 /** init a rval_cache struct */
178 #define rval_cache_init(rvc) \
179         do{ (rvc)->cache_type=RV_CACHE_EMPTY; (rvc)->val_type=RV_NONE; }while(0)
180
181 /** destroy a rval_cache struct contents */
182 void rval_cache_clean(struct rval_cache* rvc);
183
184
185 /** convert a rvalue to another type.  */
186 struct rvalue* rval_convert(struct run_act_ctx* h, struct sip_msg* msg, 
187                                                         enum rval_type type, struct rvalue* v,
188                                                         struct rval_cache* c);
189
190 /** get the integer value of an rvalue. */
191 int rval_get_int(struct run_act_ctx* h, struct sip_msg* msg, int* i, 
192                                 struct rvalue* rv, struct rval_cache* cache);
193 /** get the string value of an rv. */
194 int rval_get_str(struct run_act_ctx* h, struct sip_msg* msg,
195                                                                 str* s, struct rvalue* rv,
196                                                                 struct rval_cache* cache);
197 /** get the string value of an rv in a tmp variable */
198 int rval_get_tmp_str(struct run_act_ctx* h, struct sip_msg* msg,
199                                                                 str* tmpv, struct rvalue* rv,
200                                                                 struct rval_cache* cache,
201                                                                 struct rval_cache* tmp_cache);
202
203 /** evals an integer expr  to an int. */
204 int rval_expr_eval_int( struct run_act_ctx* h, struct sip_msg* msg,
205                                                 int* res, struct rval_expr* rve);
206 /** evals a rval expr.. */
207 struct rvalue* rval_expr_eval(struct run_act_ctx* h, struct sip_msg* msg,
208                                                                 struct rval_expr* rve);
209 /** evals an integer expr  to an int or rvalue. */
210 int rval_expr_eval_rvint( struct run_act_ctx* h, struct sip_msg* msg,
211                                                  struct rvalue** rv_res, int* i_res,
212                                                  struct rval_expr* rve, struct rval_cache* cache);
213
214
215 /** guess the type of an expression.  */
216 enum rval_type rve_guess_type(struct rval_expr* rve);
217 /** returns true if expression is constant. */
218 int rve_is_constant(struct rval_expr* rve);
219 /** returns true if the expression can have side-effect */
220 int rve_has_side_effects(struct rval_expr* rve);
221 /** returns 1 if expression is valid (type-wise).*/
222 int rve_check_type(enum rval_type* type, struct rval_expr* rve,
223                                         struct rval_expr** bad_rve, enum rval_type* bad_type,
224                                         enum rval_type* exp_type);
225 /** returns a string name for type (debugging).*/
226 char* rval_type_name(enum rval_type type);
227
228 /** create a RVE_RVAL_OP rval_expr, containing a single rval of the given type
229   */
230 struct rval_expr* mk_rval_expr_v(enum rval_type rv_type, void* val,
231                                                                         struct cfg_pos* pos);
232 /** create a unary op. rval_expr.. */
233 struct rval_expr* mk_rval_expr1(enum rval_expr_op op, struct rval_expr* rve1,
234                                                                         struct cfg_pos* pos);
235 /** create a rval_expr. from 2 other rval exprs, using op. */
236 struct rval_expr* mk_rval_expr2(enum rval_expr_op op, struct rval_expr* rve1,
237                                                                                                           struct rval_expr* rve2,
238                                                                                                           struct cfg_pos* pos);
239 /** destroys a pkg_malloc'ed rve. */
240 void rve_destroy(struct rval_expr* rve);
241
242 /** fix a rval_expr. */
243 int fix_rval_expr(void* p);
244 #endif /* _rvalue_h */