Merge commit 'origin/ser_core_cvs'
[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 enum { EXP_T=1, ELEM_T };
64 enum { LOGAND_OP=1, LOGOR_OP, NOT_OP, BINAND_OP, BINOR_OP };
65 enum { EQUAL_OP=10, MATCH_OP, GT_OP, LT_OP, GTE_OP, LTE_OP, DIFF_OP, NO_OP };
66 enum { METHOD_O=1, URI_O, FROM_URI_O, TO_URI_O, SRCIP_O, SRCPORT_O,
67            DSTIP_O, DSTPORT_O, PROTO_O, AF_O, MSGLEN_O, DEFAULT_O, ACTION_O,
68            NUMBER_O, AVP_O, SNDIP_O, SNDPORT_O, TOIP_O, TOPORT_O, SNDPROTO_O,
69            SNDAF_O, RETCODE_O, SELECT_O, PVAR_O, RVEXP_O};
70
71 enum { FORWARD_T=1, SEND_T, DROP_T, LOG_T, ERROR_T, ROUTE_T, EXEC_T,
72                 SET_HOST_T, SET_HOSTPORT_T, SET_USER_T, SET_USERPASS_T,
73                 SET_PORT_T, SET_URI_T, SET_HOSTPORTTRANS_T, SET_HOSTALL_T,
74                 SET_USERPHONE_T,
75                 IF_T, SWITCH_T /* only until fixup*/,
76                 BLOCK_T, EVAL_T, SWITCH_JT_T, SWITCH_COND_T, MATCH_COND_T, WHILE_T,
77                 MODULE_T, MODULE3_T, MODULE4_T, MODULE5_T, MODULE6_T, MODULEX_T,
78                 SETFLAG_T, RESETFLAG_T, ISFLAGSET_T ,
79                 AVPFLAG_OPER_T,
80                 LEN_GT_T, PREFIX_T, STRIP_T,STRIP_TAIL_T,
81                 APPEND_BRANCH_T,
82                 REVERT_URI_T,
83                 FORWARD_TCP_T,
84                 FORWARD_UDP_T,
85                 FORWARD_TLS_T,
86                 FORWARD_SCTP_T,
87                 SEND_TCP_T,
88                 FORCE_RPORT_T,
89                 SET_ADV_ADDR_T,
90                 SET_ADV_PORT_T,
91                 FORCE_TCP_ALIAS_T,
92                 LOAD_AVP_T,
93                 AVP_TO_URI_T,
94                 FORCE_SEND_SOCKET_T,
95                 ASSIGN_T,
96                 ADD_T,
97                 UDP_MTU_TRY_PROTO_T
98 };
99 enum { NOSUBTYPE=0, STRING_ST, NET_ST, NUMBER_ST, IP_ST, RE_ST, PROXY_ST,
100                 EXPR_ST, ACTIONS_ST, MODEXP_ST, MODFIXUP_ST, URIHOST_ST, URIPORT_ST,
101                 MYSELF_ST, STR_ST, SOCKID_ST, SOCKETINFO_ST, ACTION_ST, AVP_ST,
102                 SELECT_ST, PVAR_ST,
103                 LVAL_ST,  RVE_ST,
104                 RETCODE_ST, CASE_ST,
105                 BLOCK_ST, JUMPTABLE_ST, CONDTABLE_ST, MATCH_CONDTABLE_ST
106 };
107
108 /* run flags */
109 #define EXIT_R_F   1
110 #define RETURN_R_F 2
111 #define BREAK_R_F  4
112
113
114 struct cfg_pos{
115         int s_line;
116         int e_line;
117         unsigned short s_col;
118         unsigned short e_col;
119 };
120
121
122 /* Expression operand */
123 union exp_op {
124         void* param;
125         long numval; /* must have the same size as a void*/
126         struct expr* expr;
127         char* string;
128         avp_spec_t* attr;
129         select_t* select;
130         regex_t* re;
131         struct net* net;
132         struct _str str;
133 };
134
135 struct expr{
136         int type; /* exp, exp_elem */
137         int op; /* and, or, not | ==,  =~ */
138         int l_type, r_type;
139         union exp_op l;
140         union exp_op r;
141 };
142
143 typedef struct {
144         int type;
145         union {
146                 long number;
147                 char* string;
148                 struct _str str;
149                 void* data;
150                 avp_spec_t* attr;
151                 select_t* select;
152         } u;
153 } action_u_t;
154
155 /* maximum internal array/params
156  * for module function calls val[0] and val[1] store a pointer to the
157  * function and the number of params, the rest are the function params 
158  */
159 #define MAX_ACTIONS (2+6)
160
161 struct action{
162         int type;  /* forward, drop, log, send ...*/
163         int count;
164         struct action* next;
165         action_u_t val[MAX_ACTIONS];
166 };
167
168 struct expr* mk_exp(int op, struct expr* left, struct expr* right);
169 struct expr* mk_elem(int op, int ltype, void* lparam, int rtype, void* rparam);
170
171 struct action* mk_action(int type, int count/* of couples {type,val} */, .../* int type1, void *val1 [, int type2, void *val2, ...] */);
172 struct action* append_action(struct action* a, struct action* b);
173
174 void print_action(struct action* a);
175 void print_actions(struct action* a);
176 void print_expr(struct expr* exp);
177
178 /** joins to cfg file positions into a new one. */
179 void cfg_pos_join(struct cfg_pos* res,
180                                                         struct cfg_pos* pos1, struct cfg_pos* pos2);
181 #endif
182