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