register(k): pack contact info based on header for searching existing ul records
[sip-router] / route_struct.h
1 /*
2  * $Id$
3  *
4  *
5  * Copyright (C) 2001-2003 FhG Fokus
6  *
7  * This file is part of ser, a free SIP server.
8  *
9  * ser is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version
13  *
14  * For a license to use the ser software under conditions
15  * other than those described here, or to purchase support for this
16  * software, please contact iptel.org by e-mail at the following addresses:
17  *    info@iptel.org
18  *
19  * ser is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software
26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27  */
28 /* History:
29  * --------
30  *
31  *  2003-04-12  FORCE_RPORT_T added (andrei)
32  *  2003-04-22  strip_tail added (jiri)
33  *  2003-10-10  >,<,>=,<=, != and MSGLEN_O added (andrei)
34  *  2003-10-28  FORCE_TCP_ALIAS added (andrei)
35  *  2004-02-24  added LOAD_AVP_T and AVP_TO_URI_T (bogdan)
36  *  2005-12-11  added SND{IP,PORT,PROTO,AF}_O & TO{IP,PORT}_O (andrei)
37  *  2005-12-19  select framework added SELECT_O and SELECT_ST (mma)
38  *  2008-12-17  added UDP_MTU_TRY_PROTO_T (andrei)
39  */
40
41
42 #ifndef route_struct_h
43 #define route_struct_h
44
45 #include <sys/types.h>
46 #include <regex.h>
47 #include "select.h"
48 #include "usr_avp.h"
49
50 #define EXPR_DROP -127  /* used only by the expression and if evaluator */
51 /*
52  * Other important values (no macros for them yet):
53  * expr true = 1
54  * expr false = 0 (used only inside the expression and if evaluator)
55  *
56  * action continue  or if used in condition true = 1
57  * action drop/quit/stop script processing = 0
58  * action error or if used in condition false = -1 (<0 and !=EXPR_DROP)
59  *
60  */
61
62
63 /* expression type */
64 enum expr_type { EXP_T=1, ELEM_T };
65 enum expr_op {
66         /* expression operator if type==EXP_T */
67         LOGAND_OP=1, LOGOR_OP, NOT_OP, BINAND_OP, BINOR_OP,
68         /* expression operator if type==ELEM_T */
69         EQUAL_OP=10, MATCH_OP, GT_OP, LT_OP, GTE_OP, LTE_OP, DIFF_OP, NO_OP
70 };
71 /* expression left member "special" type (if type==ELEM_T)
72   (start at 51 for debugging purposes: it's better to not overlap with 
73    expr_r_type)
74 */
75 enum _expr_l_type{
76            METHOD_O=51, URI_O, FROM_URI_O, TO_URI_O, SRCIP_O, SRCPORT_O,
77            DSTIP_O, DSTPORT_O, PROTO_O, AF_O, MSGLEN_O, ACTION_O,
78            NUMBER_O, AVP_O, SNDIP_O, SNDPORT_O, TOIP_O, TOPORT_O, SNDPROTO_O,
79            SNDAF_O, RETCODE_O, SELECT_O, PVAR_O, RVEXP_O, SELECT_UNFIXED_O};
80 /* action types */
81 enum action_type{
82                 FORWARD_T=1, SEND_T, DROP_T, LOG_T, ERROR_T, ROUTE_T, EXEC_T,
83                 SET_HOST_T, SET_HOSTPORT_T, SET_USER_T, SET_USERPASS_T,
84                 SET_PORT_T, SET_URI_T, SET_HOSTPORTTRANS_T, SET_HOSTALL_T,
85                 SET_USERPHONE_T,
86                 IF_T, SWITCH_T /* only until fixup*/,
87                 BLOCK_T, EVAL_T, SWITCH_JT_T, SWITCH_COND_T, MATCH_COND_T, WHILE_T,
88                 /* module function calls with string only parameters */
89                 MODULE0_T, MODULE1_T, MODULE2_T, MODULE3_T, MODULE4_T, MODULE5_T,
90                 MODULE6_T, MODULEX_T,
91                 /* module function calls, that have some RVE parameters */
92                 MODULE1_RVE_T, MODULE2_RVE_T, MODULE3_RVE_T,
93                 MODULE4_RVE_T, MODULE5_RVE_T, MODULE6_RVE_T, MODULEX_RVE_T,
94                 SETFLAG_T, RESETFLAG_T, ISFLAGSET_T ,
95                 AVPFLAG_OPER_T,
96                 LEN_GT_T, PREFIX_T, STRIP_T,STRIP_TAIL_T,
97                 APPEND_BRANCH_T, REMOVE_BRANCH_T, CLEAR_BRANCHES_T,
98                 REVERT_URI_T,
99                 FORWARD_TCP_T,
100                 FORWARD_UDP_T,
101                 FORWARD_TLS_T,
102                 FORWARD_SCTP_T,
103                 SEND_TCP_T,
104                 FORCE_RPORT_T,
105                 ADD_LOCAL_RPORT_T,
106                 SET_ADV_ADDR_T,
107                 SET_ADV_PORT_T,
108                 FORCE_TCP_ALIAS_T,
109                 LOAD_AVP_T,
110                 AVP_TO_URI_T,
111                 FORCE_SEND_SOCKET_T,
112                 ASSIGN_T,
113                 ADD_T,
114                 UDP_MTU_TRY_PROTO_T,
115                 SET_FWD_NO_CONNECT_T,
116                 SET_RPL_NO_CONNECT_T,
117                 SET_FWD_CLOSE_T,
118                 SET_RPL_CLOSE_T,
119                 CFG_SELECT_T,
120                 CFG_RESET_T
121 };
122
123 #define is_mod_func(a) ((a)->type>=MODULE0_T && (a)->type<=MODULEX_RVE_T)
124
125 /* parameter types for actions or types for expression right operands
126    (WARNING right operands only, not working for left operands) */
127 enum _operand_subtype{
128                 NOSUBTYPE=0, STRING_ST, NET_ST, NUMBER_ST, IP_ST, RE_ST, PROXY_ST,
129                 EXPR_ST, ACTIONS_ST, MODEXP_ST, MODFIXUP_ST, URIHOST_ST, URIPORT_ST,
130                 MYSELF_ST, STR_ST, SOCKID_ST, SOCKETINFO_ST, ACTION_ST, AVP_ST,
131                 SELECT_ST, PVAR_ST,
132                 LVAL_ST,  RVE_ST,
133                 RETCODE_ST, CASE_ST,
134                 BLOCK_ST, JUMPTABLE_ST, CONDTABLE_ST, MATCH_CONDTABLE_ST,
135                 SELECT_UNFIXED_ST,
136                 STRING_RVE_ST /* RVE converted to a string (fparam hack) */,
137                 RVE_FREE_FIXUP_ST /* (str)RVE fixed up by a reversable fixup */,
138                 FPARAM_DYN_ST /* temporary only (fparam hack) */,
139                 CFG_GROUP_ST
140 };
141
142 typedef enum _expr_l_type expr_l_type;
143 typedef enum _operand_subtype expr_r_type;
144 typedef enum _operand_subtype action_param_type;
145
146 /* run flags */
147 #define EXIT_R_F   1
148 #define RETURN_R_F 2
149 #define BREAK_R_F  4
150 #define DROP_R_F   8
151 #define IGNORE_ON_BREAK_R_F 256
152
153
154 struct cfg_pos{
155         int s_line;
156         int e_line;
157         unsigned short s_col;
158         unsigned short e_col;
159         char *fname;
160 };
161
162
163 /* Expression operand */
164 union exp_op {
165         void* param;
166         long numval; /* must have the same size as a void*/
167         struct expr* expr;
168         char* string;
169         avp_spec_t* attr;
170         select_t* select;
171         regex_t* re;
172         struct net* net;
173         struct _str str;
174 };
175
176 struct expr{
177         enum expr_type type; /* exp, exp_elem */
178         enum expr_op op; /* and, or, not | ==,  =~ */
179         expr_l_type l_type;
180         expr_r_type r_type;
181         union exp_op l;
182         union exp_op r;
183 };
184
185 typedef struct {
186         action_param_type type;
187         union {
188                 long number;
189                 char* string;
190                 struct _str str;
191                 void* data;
192                 avp_spec_t* attr;
193                 select_t* select;
194         } u;
195 } action_u_t;
196
197 /* maximum internal array/params
198  * for module function calls val[0] and val[1] store a pointer to the
199  * function and the number of params, the rest are the function params 
200  */
201 #define MAX_ACTIONS (2+6)
202
203 struct action{
204         int cline;
205         char *cfile;
206         enum action_type type;  /* forward, drop, log, send ...*/
207         int count;
208         struct action* next;
209         action_u_t val[MAX_ACTIONS];
210 };
211
212 typedef struct action cfg_action_t;
213
214 struct expr* mk_exp(int op, struct expr* left, struct expr* right);
215 struct expr* mk_elem(int op, expr_l_type ltype, void* lparam,
216                                                          expr_r_type rtype, void* rparam);
217
218 /* @param type - type of the action
219    @param count - count of couples {type,val} (variable number of parameters)*/
220 struct action* mk_action(enum action_type type, int count, ...);
221
222 struct action* append_action(struct action* a, struct action* b);
223
224 void print_action(struct action* a);
225 void print_actions(struct action* a);
226 void print_expr(struct expr* exp);
227
228 /** joins to cfg file positions into a new one. */
229 void cfg_pos_join(struct cfg_pos* res,
230                                                         struct cfg_pos* pos1, struct cfg_pos* pos2);
231
232 struct action *get_action_from_param(void **param, int param_no);
233 #endif
234