kamailio.cfg: removed sample db_mode parameter for domain module
[sip-router] / select.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2005-2006 iptelorg GmbH
5  *
6  * This file is part of ser, a free SIP server.
7  *
8  * ser is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * For a license to use the ser software under conditions
14  * other than those described here, or to purchase support for this
15  * software, please contact iptel.org by e-mail at the following addresses:
16  *    info@iptel.org
17  *
18  * ser is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License 
24  * along with this program; if not, write to the Free Software 
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  *
27  * History:
28  * --------
29  *  2005-12-19  select framework (mma)
30  *  2006-01-19  multiple nested calls, IS_ALIAS -> NESTED flag renamed (mma)
31  */
32
33  
34 #ifndef _SELECT_H
35 #define _SELECT_H
36
37 #include "str.h"
38 #include "parser/msg_parser.h"
39
40 #define MAX_SELECT_PARAMS 32
41 #define MAX_NESTED_CALLS  4
42
43 /* Flags for parser table FLAG bitfiels 
44  */
45 #define DIVERSION_MASK   0x00FF
46
47 /* if DIVERSION is set and the function is accepted
48  * the param is changed into SEL_PARAM_DIV and the value is set to (flags & DIVERSION_MASK)
49  *  - it is valuable for STR params (saves parsing time)
50  *  - does not release the memory occupied by the parameter
51  */
52 #define DIVERSION        1<<8
53
54 /* set if any parameter is expected at this stage
55  * (the function must be resolved further)
56  */
57 #define SEL_PARAM_EXPECTED   1<<9
58
59 /* accept if following parameter is STR (any)
60  * consume that extra parameter in one step
61  */
62 #define CONSUME_NEXT_STR 1<<10
63
64 /* accept if following parameter is INT
65  * consume that extra parameter in one ste
66  */
67 #define CONSUME_NEXT_INT 1<<11
68
69 /* accept all the following parameters
70  * without checking them
71  */
72 #define CONSUME_ALL     1<<12
73
74 /* next parameter is optional (use with CONSUME_NEXT_STR or CONSUME_NEXT_INT
75  * resolution is accepted even if there is no other parameter
76  * or the parameter is of wrong type
77  */
78 #define OPTIONAL         1<<13
79
80 /* left function is noted to be called
81  * rigth function continues in resolution
82  * NOTE: the parameter is not consumed for PARENT, 
83  * so you can leave it as ..,SEL_PARAM_INT, 0,..
84  *
85  * run_select then calls all functions with PARENT flag
86  * in the order of resolution until the final call or 
87  * the result is != 0 (<0 error, 1 null str) 
88  * the only one parameter passed between nested calls
89  * is the result str*
90  */
91 #define NESTED          1<<14
92
93 /* "fixup call" would be done, when the structure is resolved to this node
94  * which means call with res and msg NULL
95  *
96  * if the fixup call return value <0, the select resolution will fail
97  */
98 #define FIXUP_CALL      1<<15
99
100 /*
101  * Selector call parameter
102  */
103 typedef enum {
104         SEL_PARAM_INT,  /* Integer parameter */
105         SEL_PARAM_STR,  /* String parameter */
106         SEL_PARAM_DIV,  /* Integer value got from parsing table */
107         SEL_PARAM_PTR   /* void* data got from e.g. fixup call */
108 } select_param_type_t;
109         
110 typedef union {
111         int i;  /* Integer value */
112         str s;  /* String value */
113         void* p;/* Any data ptr */
114 } select_param_value_t;
115         
116 typedef struct sel_param {
117         select_param_type_t type;
118         select_param_value_t v;
119 } select_param_t;
120
121 struct select;
122
123 typedef int (*select_f)(str* res, struct select* s, struct sip_msg* msg);
124
125 typedef struct select {
126         select_f f[MAX_NESTED_CALLS];
127         int param_offset[MAX_NESTED_CALLS+1];
128         /* contains broken down select string (@foo.bar[-2].foo -> 4 entries) */
129         select_param_t params[MAX_SELECT_PARAMS];
130         /* how many elements are used in 'params' */
131         int n;
132 } select_t;
133
134 typedef struct {
135         select_f curr_f;
136         select_param_type_t type;
137         str name;
138         select_f new_f;
139         int flags;
140 } select_row_t;
141
142 typedef struct select_table {
143   select_row_t *table;
144   struct select_table *next;
145 } select_table_t;
146
147 /* the level of the select call that is beeing evaluated
148  * by the child process
149  */
150 extern int select_level;
151
152 /* pointer to the SIP uri beeing processed.
153  * Nested function calls can pass information to each
154  * other using this pointer. Only for performace reasons.
155  * (Miklos)
156  */
157 extern struct sip_uri   *select_uri_p;
158
159 /*
160  * Lookup corresponding select function based on
161  * the select parameters
162  */
163 int resolve_select(select_t* s);
164
165 /*
166  * Run the select function
167  */
168 int run_select(str* res, select_t* s, struct sip_msg* msg);
169
170 /*
171  * Print select for debugging purposes 
172  */
173 void print_select(select_t* s);
174
175 /*
176  * Register modules' own select parser table
177  */
178 int register_select_table(select_row_t *table);
179
180 /*
181  * Tries to parse string pointed by *p (up to first non alpha char) into select structure
182  * if parsing succeeded, call resolve_select
183  * if resolving passes, returns final structure
184  * *p moves to first unused char
185  * return 0
186  *
187  * if memory allocation fails, returns -1
188  * if parsing or resolving fails, returns -2
189  */
190 int parse_select (char** p, select_t** s);
191
192 /**
193  * Frees the select obtained with parse_select().
194  */
195 void free_select(select_t *s);
196 /*
197  * Select parser, result is stored in SHARED memory
198  * 
199  * If you call this, you must ensure, that the string which
200  * is beeing parsed MUST be at the same place for all child
201  * processes, e.g. allocated in the shared memory as well
202  *
203  * parameters and results same as parse_select
204  */
205 int shm_parse_select (char** p, select_t** s);
206
207 /**
208  * Frees the select obtained with shm_parse_select().
209  */
210 void shm_free_select(select_t *s);
211
212
213 #define SELECT_F(function) extern int function (str* res, select_t* s, struct sip_msg* msg);
214 #define ABSTRACT_F(function) int function (str* res, select_t* s, struct sip_msg* msg) {return -1;}
215
216 #endif /* _SELECT_H */