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