Mercurial > hg > freeDiameter
annotate include/freeDiameter/libfreeDiameter.h @ 179:0ea50d66ad1b
Fix segfault
author | Sebastien Decugis <sdecugis@nict.go.jp> |
---|---|
date | Wed, 03 Feb 2010 18:08:10 +0900 |
parents | 2b2f78036749 |
children | 1f39f0c51094 |
rev | line source |
---|---|
0 | 1 /********************************************************************************************************* |
2 * Software License Agreement (BSD License) * | |
3 * Author: Sebastien Decugis <sdecugis@nict.go.jp> * | |
4 * * | |
5 * Copyright (c) 2009, WIDE Project and NICT * | |
6 * All rights reserved. * | |
7 * * | |
8 * Redistribution and use of this software in source and binary forms, with or without modification, are * | |
9 * permitted provided that the following conditions are met: * | |
10 * * | |
11 * * Redistributions of source code must retain the above * | |
12 * copyright notice, this list of conditions and the * | |
13 * following disclaimer. * | |
14 * * | |
15 * * Redistributions in binary form must reproduce the above * | |
16 * copyright notice, this list of conditions and the * | |
17 * following disclaimer in the documentation and/or other * | |
18 * materials provided with the distribution. * | |
19 * * | |
20 * * Neither the name of the WIDE Project or NICT nor the * | |
21 * names of its contributors may be used to endorse or * | |
22 * promote products derived from this software without * | |
23 * specific prior written permission of WIDE Project and * | |
24 * NICT. * | |
25 * * | |
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED * | |
27 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A * | |
28 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR * | |
29 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * | |
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * | |
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR * | |
32 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * | |
33 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * | |
34 *********************************************************************************************************/ | |
35 | |
1
bafb831ba688
Fix names to proper case for freeDiameter
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
0
diff
changeset
|
36 /* This file contains the definitions of functions and types used by the libfreeDiameter library. |
0 | 37 * |
1
bafb831ba688
Fix names to proper case for freeDiameter
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
0
diff
changeset
|
38 * This library is meant to be used by both the freeDiameter daemon and its extensions. |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
39 * It provides the tools to manipulate Diameter messages and related data. |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
40 * This file should always be included as #include <freeDiameter/libfreeDiameter.h> |
0 | 41 * |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
42 * The file contains the following parts: |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
43 * DEBUG |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
44 * MACROS |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
45 * THREADS |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
46 * LISTS |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
47 * DICTIONARY |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
48 * SESSIONS |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
49 * MESSAGES |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
50 * DISPATCH |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
51 * QUEUES |
0 | 52 */ |
53 | |
54 #ifndef _LIBFREEDIAMETER_H | |
55 #define _LIBFREEDIAMETER_H | |
56 | |
57 #ifndef FD_IS_CONFIG | |
1
bafb831ba688
Fix names to proper case for freeDiameter
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
0
diff
changeset
|
58 #error "You must include 'freeDiameter-host.h' before this file." |
0 | 59 #endif /* FD_IS_CONFIG */ |
60 | |
61 #include <pthread.h> | |
137
5510f73e1737
Replace non-posix pthread_yield with posix sched_yield
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
135
diff
changeset
|
62 #include <sched.h> |
0 | 63 #include <string.h> |
64 #include <assert.h> | |
65 #include <errno.h> | |
66 #include <arpa/inet.h> | |
67 #include <sys/socket.h> | |
68 #include <netdb.h> | |
69 #include <stdio.h> | |
70 #include <stdlib.h> | |
71 #include <unistd.h> | |
72 | |
73 /*============================================================*/ | |
74 /* DEBUG */ | |
75 /*============================================================*/ | |
76 #ifndef ASSERT | |
77 #define ASSERT(x) assert(x) | |
78 #endif /* ASSERT */ | |
79 | |
80 /* | |
81 * FUNCTION: fd_log_debug | |
82 * | |
83 * PARAMETERS: | |
84 * format : Same format string as in the printf function | |
85 * ... : Same list as printf | |
86 * | |
87 * DESCRIPTION: | |
88 * Log internal information for use of developpers only. | |
89 * The format and arguments may contain UTF-8 encoded data. The | |
90 * output medium (file or console) is expected to support this encoding. | |
91 * | |
92 * This function assumes that a global mutex called "fd_log_lock" exists | |
93 * in the address space of the current process. | |
94 * | |
95 * RETURN VALUE: | |
96 * None. | |
97 */ | |
98 void fd_log_debug ( char * format, ... ); | |
99 extern pthread_mutex_t fd_log_lock; | |
174
2b2f78036749
Added simple command-line switch to turn on full debug for specific function or file
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
168
diff
changeset
|
100 extern char * fd_debug_one_function; |
2b2f78036749
Added simple command-line switch to turn on full debug for specific function or file
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
168
diff
changeset
|
101 extern char * fd_debug_one_file; |
0 | 102 |
103 /* | |
104 * FUNCTION: fd_log_threadname | |
105 * | |
106 * PARAMETERS: | |
107 * name : \0-terminated string containing a name to identify the current thread. | |
108 * | |
109 * DESCRIPTION: | |
110 * Name the current thread, useful for debugging multi-threaded problems. | |
111 * | |
112 * This function assumes that a global thread-specific key called "fd_log_thname" exists | |
113 * in the address space of the current process. | |
114 * | |
115 * RETURN VALUE: | |
116 * None. | |
117 */ | |
118 void fd_log_threadname ( char * name ); | |
119 extern pthread_key_t fd_log_thname; | |
120 | |
121 /* | |
122 * FUNCTION: fd_log_time | |
123 * | |
124 * PARAMETERS: | |
22
0b3b46da2c12
Progress on server code
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
20
diff
changeset
|
125 * ts : The timestamp to log, or NULL for "now" |
0 | 126 * buf : An array where the time must be stored |
127 * len : size of the buffer | |
128 * | |
129 * DESCRIPTION: | |
22
0b3b46da2c12
Progress on server code
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
20
diff
changeset
|
130 * Writes the timestamp (in human readable format) in a buffer. |
0 | 131 * |
132 * RETURN VALUE: | |
133 * pointer to buf. | |
134 */ | |
22
0b3b46da2c12
Progress on server code
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
20
diff
changeset
|
135 char * fd_log_time ( struct timespec * ts, char * buf, size_t len ); |
0 | 136 |
137 | |
138 /* levels definitions */ | |
139 #define NONE 0 /* Display no debug message */ | |
140 #define INFO 1 /* Display errors only */ | |
141 #define FULL 2 /* Display additional information to follow code execution */ | |
142 #define ANNOYING 4 /* Very verbose, for example in loops */ | |
143 #define FCTS 6 /* Display entry parameters of most functions */ | |
144 #define CALL 9 /* Display calls to most functions (with CHECK macros) */ | |
145 | |
146 /* Default level is INFO */ | |
147 #ifndef TRACE_LEVEL | |
148 #define TRACE_LEVEL INFO | |
149 #endif /* TRACE_LEVEL */ | |
150 | |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
151 /* The level of the file being compiled. */ |
0 | 152 static int local_debug_level = TRACE_LEVEL; |
153 | |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
154 /* A global level, changed by configuration or cmd line for example. default is 0. */ |
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
155 extern int fd_g_debug_lvl; |
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
156 |
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
157 /* Some portability code to get nice function name in __PRETTY_FUNCTION__ */ |
0 | 158 #if __STDC_VERSION__ < 199901L |
159 # if __GNUC__ >= 2 | |
160 # define __func__ __FUNCTION__ | |
161 # else /* __GNUC__ >= 2 */ | |
162 # define __func__ "<unknown>" | |
163 # endif /* __GNUC__ >= 2 */ | |
164 #endif /* __STDC_VERSION__ < 199901L */ | |
165 #ifndef __PRETTY_FUNCTION__ | |
166 #define __PRETTY_FUNCTION__ __func__ | |
167 #endif /* __PRETTY_FUNCTION__ */ | |
168 | |
169 /* Boolean for tracing at a certain level */ | |
174
2b2f78036749
Added simple command-line switch to turn on full debug for specific function or file
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
168
diff
changeset
|
170 #define TRACE_BOOL(_level_) ( ((_level_) <= local_debug_level + fd_g_debug_lvl) \ |
2b2f78036749
Added simple command-line switch to turn on full debug for specific function or file
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
168
diff
changeset
|
171 || (fd_debug_one_function && !strcmp(fd_debug_one_function, __PRETTY_FUNCTION__)) \ |
2b2f78036749
Added simple command-line switch to turn on full debug for specific function or file
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
168
diff
changeset
|
172 || (fd_debug_one_file && !strcmp(fd_debug_one_file, __FILE__) ) ) |
0 | 173 |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
174 /* The general debug macro, each call results in two lines of debug messages (change the macro for more compact output) */ |
0 | 175 #define TRACE_DEBUG(level,format,args... ) { \ |
176 if ( TRACE_BOOL(level) ) { \ | |
177 char __buf[25]; \ | |
178 char * __thn = ((char *)pthread_getspecific(fd_log_thname) ?: "unnamed"); \ | |
10
c5c99c73c2bf
Added some extensions and functions in the daemon
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
8
diff
changeset
|
179 fd_log_debug("\t | tid:%-20s\t%s\tin %s@%s:%d\n" \ |
0 | 180 "\t%s|%*s" format "\n", \ |
22
0b3b46da2c12
Progress on server code
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
20
diff
changeset
|
181 __thn, fd_log_time(NULL, __buf, sizeof(__buf)), __PRETTY_FUNCTION__, __FILE__, __LINE__, \ |
0 | 182 (level < FULL)?"@":" ",level, "", ## args); \ |
183 } \ | |
184 } | |
185 | |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
186 /* Helper for function entry -- for very detailed trace of the execution */ |
0 | 187 #define TRACE_ENTRY(_format,_args... ) \ |
29
5ba91682f0bc
Added a test for cnxctx (tbc) and fixed some bugs
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
25
diff
changeset
|
188 TRACE_DEBUG(FCTS, "[enter] %s(" _format ") {" #_args "}", __PRETTY_FUNCTION__, ##_args ); |
0 | 189 |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
190 /* Helper for debugging by adding traces -- for debuging a specific location of the code */ |
0 | 191 #define TRACE_HERE() \ |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
192 TRACE_DEBUG(NONE, " -- debug checkpoint -- "); |
0 | 193 |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
194 /* Helper for tracing the CHECK_* macros bellow -- very very verbose code execution! */ |
0 | 195 #define TRACE_DEBUG_ALL( str ) \ |
196 TRACE_DEBUG(CALL, str ); | |
197 | |
13
ef9ef3bf4752
Progress on peer state machine
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
10
diff
changeset
|
198 /* For development only, to keep track of TODO locations in the code */ |
ef9ef3bf4752
Progress on peer state machine
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
10
diff
changeset
|
199 #ifndef ERRORS_ON_TODO |
ef9ef3bf4752
Progress on peer state machine
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
10
diff
changeset
|
200 #define TODO( _msg, _args... ) \ |
14
14cf6daf716d
Some progress on peers module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
13
diff
changeset
|
201 TRACE_DEBUG(NONE, "TODO: " _msg , ##_args); |
13
ef9ef3bf4752
Progress on peer state machine
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
10
diff
changeset
|
202 #else /* ERRORS_ON_TODO */ |
ef9ef3bf4752
Progress on peer state machine
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
10
diff
changeset
|
203 #define TODO( _msg, _args... ) \ |
ef9ef3bf4752
Progress on peer state machine
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
10
diff
changeset
|
204 "TODO" = _msg ## _args; /* just a stupid compilation error to spot the todo */ |
ef9ef3bf4752
Progress on peer state machine
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
10
diff
changeset
|
205 #endif /* ERRORS_ON_TODO */ |
ef9ef3bf4752
Progress on peer state machine
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
10
diff
changeset
|
206 |
0 | 207 |
208 /* Macros to check a return value and branch out in case of error. | |
209 * These macro must be used only when errors are highly improbable, not for expected errors. | |
210 */ | |
211 | |
212 /* Check the return value of a system function and execute fallback in case of error */ | |
213 #define CHECK_SYS_DO( __call__, __fallback__ ) { \ | |
214 int __ret__; \ | |
215 TRACE_DEBUG_ALL( "Check SYS: " #__call__ ); \ | |
216 __ret__ = (__call__); \ | |
217 if (__ret__ < 0) { \ | |
218 int __err__ = errno; /* We may handle EINTR here */ \ | |
219 TRACE_DEBUG(NONE, "ERROR: in '" #__call__ "' :\t%s", strerror(__err__));\ | |
220 __fallback__; \ | |
221 } \ | |
222 } | |
223 /* Check the return value of a system function, return error code on error */ | |
224 #define CHECK_SYS( __call__ ) { \ | |
225 int __ret__; \ | |
226 TRACE_DEBUG_ALL( "Check SYS: " #__call__ ); \ | |
227 __ret__ = (__call__); \ | |
228 if (__ret__ < 0) { \ | |
229 int __err__ = errno; /* We may handle EINTR here */ \ | |
230 TRACE_DEBUG(NONE, "ERROR: in '" #__call__ "' :\t%s", strerror(__err__));\ | |
231 return __err__; \ | |
232 } \ | |
233 } | |
234 | |
235 /* Check the return value of a POSIX function and execute fallback in case of error or special value */ | |
236 #define CHECK_POSIX_DO2( __call__, __speval__, __fallback1__, __fallback2__ ) { \ | |
237 int __ret__; \ | |
238 TRACE_DEBUG_ALL( "Check POSIX: " #__call__ ); \ | |
239 __ret__ = (__call__); \ | |
240 if (__ret__ != 0) { \ | |
241 if (__ret__ == (__speval__)) { \ | |
242 __fallback1__; \ | |
243 } else { \ | |
244 TRACE_DEBUG(NONE, "ERROR: in '" #__call__ "':\t%s", strerror(__ret__)); \ | |
245 __fallback2__; \ | |
246 } \ | |
247 } \ | |
248 } | |
249 | |
250 /* Check the return value of a POSIX function and execute fallback in case of error */ | |
251 #define CHECK_POSIX_DO( __call__, __fallback__ ) \ | |
252 CHECK_POSIX_DO2( (__call__), 0, , __fallback__ ); | |
253 | |
254 /* Check the return value of a POSIX function and return it if error */ | |
255 #define CHECK_POSIX( __call__ ) { \ | |
256 int __v__; \ | |
257 CHECK_POSIX_DO( __v__ = (__call__), return __v__ ); \ | |
258 } | |
259 | |
260 /* Check that a memory allocator did not return NULL, otherwise log an error and execute fallback */ | |
261 #define CHECK_MALLOC_DO( __call__, __fallback__ ) { \ | |
262 void * __ret__; \ | |
263 TRACE_DEBUG_ALL( "Check MALLOC: " #__call__ ); \ | |
264 __ret__ = (void *)( __call__ ); \ | |
265 if (__ret__ == NULL) { \ | |
266 int __err__ = errno; \ | |
267 TRACE_DEBUG(NONE, "ERROR: in '" #__call__ "':\t%s", strerror(__err__)); \ | |
268 __fallback__; \ | |
269 } \ | |
270 } | |
271 | |
272 /* Check that a memory allocator did not return NULL, otherwise return ENOMEM */ | |
273 #define CHECK_MALLOC( __call__ ) \ | |
274 CHECK_MALLOC_DO( __call__, return ENOMEM ); | |
275 | |
276 | |
277 /* The next macros can be used also for expected errors */ | |
278 | |
279 /* Check parameters at function entry, execute fallback on error */ | |
280 #define CHECK_PARAMS_DO( __bool__, __fallback__ ) \ | |
281 TRACE_DEBUG_ALL( "Check PARAMS: " #__bool__ ); \ | |
282 if ( ! (__bool__) ) { \ | |
283 TRACE_DEBUG(INFO, "Invalid parameter received in '" #__bool__ "'"); \ | |
284 __fallback__; \ | |
285 } | |
286 /* Check parameters at function entry, return EINVAL if the boolean is false (similar to assert) */ | |
287 #define CHECK_PARAMS( __bool__ ) \ | |
288 CHECK_PARAMS_DO( __bool__, return EINVAL ); | |
289 | |
290 /* Check the return value of an internal function, log and propagate */ | |
291 #define CHECK_FCT_DO( __call__, __fallback__ ) { \ | |
292 int __ret__; \ | |
293 TRACE_DEBUG_ALL( "Check FCT: " #__call__ ); \ | |
294 __ret__ = (__call__); \ | |
295 if (__ret__ != 0) { \ | |
296 TRACE_DEBUG(INFO, "Error in '" #__call__ "':\t%s", strerror(__ret__)); \ | |
297 __fallback__; \ | |
298 } \ | |
299 } | |
300 /* Check the return value of a function call, return any error code */ | |
301 #define CHECK_FCT( __call__ ) { \ | |
302 int __v__; \ | |
303 CHECK_FCT_DO( __v__ = (__call__), return __v__ ); \ | |
304 } | |
305 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
306 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
307 /*============================================================*/ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
308 /* MACROS */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
309 /*============================================================*/ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
310 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
311 /* helper macros (pre-processor hacks to allow macro arguments) */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
312 #define __str( arg ) #arg |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
313 #define _stringize( arg ) __str( arg ) |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
314 #define __agr( arg1, arg2 ) arg1 ## arg2 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
315 #define _aggregate( arg1, arg2 ) __agr( arg1, arg2 ) |
0 | 316 |
317 /* Some aliases to socket addresses structures */ | |
318 #define sSS struct sockaddr_storage | |
319 #define sSA struct sockaddr | |
320 #define sSA4 struct sockaddr_in | |
321 #define sSA6 struct sockaddr_in6 | |
322 | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
323 /* Dump one sockaddr Node information */ |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
324 #define sSA_DUMP_NODE( sa, flag ) { \ |
0 | 325 sSA * __sa = (sSA *)(sa); \ |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
326 char __addrbuf[INET6_ADDRSTRLEN]; \ |
0 | 327 if (__sa) { \ |
328 int __rc = getnameinfo(__sa, \ | |
329 sizeof(sSS), \ | |
330 __addrbuf, \ | |
331 sizeof(__addrbuf), \ | |
332 NULL, \ | |
333 0, \ | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
334 flag); \ |
0 | 335 if (__rc) \ |
23
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
336 fd_log_debug("%s", (char *)gai_strerror(__rc)); \ |
0 | 337 else \ |
23
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
338 fd_log_debug("%s", &__addrbuf[0]); \ |
0 | 339 } else { \ |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
340 fd_log_debug("(NULL / ANY)"); \ |
0 | 341 } \ |
342 } | |
24
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
343 /* Same but with the port (service) also */ |
23
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
344 #define sSA_DUMP_NODE_SERV( sa, flag ) { \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
345 sSA * __sa = (sSA *)(sa); \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
346 char __addrbuf[INET6_ADDRSTRLEN]; \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
347 char __servbuf[32]; \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
348 if (__sa) { \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
349 int __rc = getnameinfo(__sa, \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
350 sizeof(sSS), \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
351 __addrbuf, \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
352 sizeof(__addrbuf), \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
353 __servbuf, \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
354 sizeof(__servbuf), \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
355 flag); \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
356 if (__rc) \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
357 fd_log_debug("%s", (char *)gai_strerror(__rc)); \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
358 else \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
359 fd_log_debug("[%s]:%s", &__addrbuf[0],&__servbuf[0]); \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
360 } else { \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
361 fd_log_debug("(NULL / ANY)"); \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
362 } \ |
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
363 } |
24
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
364 /* Inside a debug trace */ |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
365 #define TRACE_DEBUG_sSA(level, prefix, sa, flags, suffix ) { \ |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
366 if ( TRACE_BOOL(level) ) { \ |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
367 char __buf[25]; \ |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
368 char * __thn = ((char *)pthread_getspecific(fd_log_thname) ?: "unnamed"); \ |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
369 fd_log_debug("\t | tid:%-20s\t%s\tin %s@%s:%d\n" \ |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
370 "\t%s|%*s" prefix , \ |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
371 __thn, fd_log_time(NULL, __buf, sizeof(__buf)), __PRETTY_FUNCTION__, __FILE__, __LINE__,\ |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
372 (level < FULL)?"@":" ",level, ""); \ |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
373 sSA_DUMP_NODE_SERV( sa, flags ); \ |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
374 fd_log_debug(suffix "\n"); \ |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
375 } \ |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
376 } |
23
db6c40b8b307
Added some code in cnxctx.c mainly
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
22
diff
changeset
|
377 |
0 | 378 |
20
277ec00d793e
Backup before typhoon... Progress on server side
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
14
diff
changeset
|
379 /* A l4 protocol name (TCP / SCTP) */ |
33
e6fcdf12b9a0
Added a lot of TODOs :)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
29
diff
changeset
|
380 #ifdef DISABLE_SCTP |
e6fcdf12b9a0
Added a lot of TODOs :)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
29
diff
changeset
|
381 #define IPPROTO_NAME( _proto ) \ |
e6fcdf12b9a0
Added a lot of TODOs :)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
29
diff
changeset
|
382 (((_proto) == IPPROTO_TCP) ? "TCP" : \ |
e6fcdf12b9a0
Added a lot of TODOs :)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
29
diff
changeset
|
383 "Unknown") |
e6fcdf12b9a0
Added a lot of TODOs :)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
29
diff
changeset
|
384 #else /* DISABLE_SCTP */ |
20
277ec00d793e
Backup before typhoon... Progress on server side
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
14
diff
changeset
|
385 #define IPPROTO_NAME( _proto ) \ |
277ec00d793e
Backup before typhoon... Progress on server side
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
14
diff
changeset
|
386 ( ((_proto) == IPPROTO_TCP) ? "TCP" : \ |
277ec00d793e
Backup before typhoon... Progress on server side
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
14
diff
changeset
|
387 (((_proto) == IPPROTO_SCTP) ? "SCTP" : \ |
277ec00d793e
Backup before typhoon... Progress on server side
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
14
diff
changeset
|
388 "Unknown")) |
33
e6fcdf12b9a0
Added a lot of TODOs :)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
29
diff
changeset
|
389 #endif /* DISABLE_SCTP */ |
20
277ec00d793e
Backup before typhoon... Progress on server side
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
14
diff
changeset
|
390 |
0 | 391 /* The sockaddr length of a sSS structure */ |
392 #define sSSlen( _ss_ ) \ | |
393 ( (socklen_t) ( ((_ss_)->ss_family == AF_INET) ? (sizeof(sSA4)) : \ | |
394 (((_ss_)->ss_family == AF_INET6) ? (sizeof(sSA6)) : \ | |
395 0 ) ) ) | |
396 | |
397 /* Define the value of IP loopback address */ | |
398 #ifndef INADDR_LOOPBACK | |
399 #define INADDR_LOOPBACK inet_addr("127.0.0.1") | |
400 #endif /* INADDR_LOOPBACK */ | |
401 | |
134
6b2989c066a6
Fixed loopback test for correct network order
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
131
diff
changeset
|
402 /* An IP equivalent to IN6_IS_ADDR_LOOPBACK */ |
6b2989c066a6
Fixed loopback test for correct network order
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
131
diff
changeset
|
403 #ifndef IN_IS_ADDR_LOOPBACK |
6b2989c066a6
Fixed loopback test for correct network order
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
131
diff
changeset
|
404 #define IN_IS_ADDR_LOOPBACK(a) \ |
6b2989c066a6
Fixed loopback test for correct network order
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
131
diff
changeset
|
405 ((((long int) (a)->s_addr) & ntohl(0xff000000)) == ntohl(0x7f000000)) |
6b2989c066a6
Fixed loopback test for correct network order
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
131
diff
changeset
|
406 #endif /* IN_IS_ADDR_LOOPBACK */ |
6b2989c066a6
Fixed loopback test for correct network order
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
131
diff
changeset
|
407 |
135
bbb8ddba4c85
Filter out more invalid addresses
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
134
diff
changeset
|
408 /* An IP equivalent to IN6_IS_ADDR_UNSPECIFIED */ |
bbb8ddba4c85
Filter out more invalid addresses
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
134
diff
changeset
|
409 #ifndef IN_IS_ADDR_UNSPECIFIED |
bbb8ddba4c85
Filter out more invalid addresses
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
134
diff
changeset
|
410 #define IN_IS_ADDR_UNSPECIFIED(a) \ |
bbb8ddba4c85
Filter out more invalid addresses
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
134
diff
changeset
|
411 (((long int) (a)->s_addr) == 0x00000000) |
bbb8ddba4c85
Filter out more invalid addresses
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
134
diff
changeset
|
412 #endif /* IN_IS_ADDR_UNSPECIFIED */ |
bbb8ddba4c85
Filter out more invalid addresses
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
134
diff
changeset
|
413 |
134
6b2989c066a6
Fixed loopback test for correct network order
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
131
diff
changeset
|
414 |
0 | 415 /* create a V4MAPPED address */ |
416 #define IN6_ADDR_V4MAP( a6, a4 ) { \ | |
417 ((uint32_t *)(a6))[0] = 0; \ | |
418 ((uint32_t *)(a6))[1] = 0; \ | |
419 ((uint32_t *)(a6))[2] = htonl(0xffff); \ | |
420 ((uint32_t *)(a6))[3] = (uint32_t)(a4); \ | |
421 } | |
422 | |
423 /* Retrieve a v4 value from V4MAPPED address ( takes a s6_addr as param) */ | |
424 #define IN6_ADDR_V4UNMAP( a6 ) \ | |
425 (((in_addr_t *)(a6))[3]) | |
426 | |
427 | |
428 /* We provide macros to convert 64 bit values to and from network byte-order, on systems where it is not already provided. */ | |
429 #ifndef HAVE_NTOHLL /* Defined in config.h, if the ntohll symbol is defined on the system */ | |
430 # if HOST_BIG_ENDIAN | |
431 /* In big-endian systems, we don't have to change the values, since the order is the same as network */ | |
432 # define ntohll(x) (x) | |
433 # define htonll(x) (x) | |
434 # else /* HOST_BIG_ENDIAN */ | |
435 /* For these systems, we must reverse the bytes. Use ntohl and htonl on sub-32 blocs, and inverse these blocs. */ | |
436 # define ntohll(x) (typeof (x))( (((uint64_t)ntohl( (uint32_t)(x))) << 32 ) | ((uint64_t) ntohl( ((uint64_t)(x)) >> 32 ))) | |
437 # define htonll(x) (typeof (x))( (((uint64_t)htonl( (uint32_t)(x))) << 32 ) | ((uint64_t) htonl( ((uint64_t)(x)) >> 32 ))) | |
438 # endif /* HOST_BIG_ENDIAN */ | |
439 #endif /* HAVE_NTOHLL */ | |
440 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
441 /* This macro will give the next multiple of 4 for an integer (used for padding sizes of AVP). */ |
0 | 442 #define PAD4(_x) ((_x) + ( (4 - (_x)) & 3 ) ) |
443 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
444 /* Useful to display as safe ASCII a value (will garbage UTF-8 output...) */ |
0 | 445 #define ASCII(_c) ( ((_c < 32) || (_c > 127)) ? ( _c ? '?' : ' ' ) : _c ) |
446 | |
447 /* Compare timespec structures */ | |
448 #define TS_IS_INFERIOR( ts1, ts2 ) \ | |
449 ( ((ts1)->tv_sec < (ts2)->tv_sec ) \ | |
5
c2d2729e3603
Completed new session module tests; some bugs fixed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
3
diff
changeset
|
450 || (((ts1)->tv_sec == (ts2)->tv_sec ) && ((ts1)->tv_nsec < (ts2)->tv_nsec) )) |
0 | 451 |
452 | |
25
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
453 /* Trace a binary buffer content */ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
454 #define TRACE_DEBUG_BUFFER(level, prefix, buf, bufsz, suffix ) { \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
455 if ( TRACE_BOOL(level) ) { \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
456 int __i; \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
457 size_t __sz = (size_t)(bufsz); \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
458 uint8_t * __buf = (uint8_t *)(buf); \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
459 char * __thn = ((char *)pthread_getspecific(fd_log_thname) ?: "unnamed"); \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
460 fd_log_debug("\t | tid:%-20s\t%s\tin %s@%s:%d\n" \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
461 "\t%s|%*s" prefix , \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
462 __thn, fd_log_time(NULL, __buf, sizeof(__buf)), __PRETTY_FUNCTION__, __FILE__, __LINE__,\ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
463 (level < FULL)?"@":" ",level, ""); \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
464 for (__i = 0; __i < __sz; __i++) { \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
465 fd_log_debug("%02.2hhx", __buf[__i]); \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
466 } \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
467 fd_log_debug(suffix "\n"); \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
468 } \ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
469 } |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
470 |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
471 |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
472 |
0 | 473 /*============================================================*/ |
474 /* THREADS */ | |
475 /*============================================================*/ | |
476 | |
477 /* Terminate a thread */ | |
478 static __inline__ int fd_thr_term(pthread_t * th) | |
479 { | |
480 int ret = 0; | |
481 void * th_ret = NULL; | |
482 | |
483 CHECK_PARAMS(th); | |
484 | |
485 /* Test if it was already terminated */ | |
486 if (*th == (pthread_t)NULL) | |
487 return 0; | |
488 | |
489 /* Cancel the thread if it is still running - ignore error if it was already terminated */ | |
490 (void) pthread_cancel(*th); | |
491 | |
492 /* Then join the thread */ | |
493 CHECK_POSIX_DO( ret = pthread_join(*th, &th_ret), /* continue */ ); | |
494 | |
495 if (th_ret != NULL) { | |
29
5ba91682f0bc
Added a test for cnxctx (tbc) and fixed some bugs
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
25
diff
changeset
|
496 TRACE_DEBUG(ANNOYING, "The thread returned the following value: %p (ignored)", th_ret); |
0 | 497 } |
498 | |
499 /* Clean the location */ | |
500 *th = (pthread_t)NULL; | |
501 | |
502 return ret; | |
503 } | |
504 | |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
505 /* Cleanups for cancellation (all threads should be safely cancelable...) */ |
0 | 506 static __inline__ void fd_cleanup_mutex( void * mutex ) |
507 { | |
508 CHECK_POSIX_DO( pthread_mutex_unlock((pthread_mutex_t *)mutex), /* */); | |
509 } | |
510 | |
511 static __inline__ void fd_cleanup_rwlock( void * rwlock ) | |
512 { | |
513 CHECK_POSIX_DO( pthread_rwlock_unlock((pthread_rwlock_t *)rwlock), /* */); | |
514 } | |
515 | |
516 static __inline__ void fd_cleanup_buffer( void * buffer ) | |
517 { | |
518 free(buffer); | |
519 } | |
24
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
520 static __inline__ void fd_cleanup_socket(void * sockptr) |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
521 { |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
522 if (sockptr) { |
179 | 523 CHECK_SYS_DO( close(*(int *)sockptr), /* ignore */ ); |
24
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
524 *(int *)sockptr = 0; |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
525 } |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
526 } |
bd83ce9328ed
Cleanups and completed sctp code (not finished)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
23
diff
changeset
|
527 |
0 | 528 |
529 /*============================================================*/ | |
530 /* LISTS */ | |
531 /*============================================================*/ | |
532 | |
533 /* The following structure represents a chained list element */ | |
534 struct fd_list { | |
535 struct fd_list *next; /* next element in the list */ | |
536 struct fd_list *prev; /* previous element in the list */ | |
537 struct fd_list *head; /* head of the list */ | |
538 void *o; /* additional avialbe pointer used for start of the parento object or other purpose */ | |
539 }; | |
540 | |
541 /* Initialize a list element */ | |
14
14cf6daf716d
Some progress on peers module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
13
diff
changeset
|
542 #define FD_LIST_INITIALIZER( _list_name ) \ |
14cf6daf716d
Some progress on peers module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
13
diff
changeset
|
543 { .next = & _list_name, .prev = & _list_name, .head = & _list_name, .o = NULL } |
14cf6daf716d
Some progress on peers module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
13
diff
changeset
|
544 #define FD_LIST_INITIALIZER_O( _list_name, _obj ) \ |
14cf6daf716d
Some progress on peers module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
13
diff
changeset
|
545 { .next = & _list_name, .prev = & _list_name, .head = & _list_name, .o = _obj } |
0 | 546 void fd_list_init ( struct fd_list * list, void *obj ); |
547 | |
548 /* Return boolean, true if the list is empty */ | |
14
14cf6daf716d
Some progress on peers module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
13
diff
changeset
|
549 #define FD_IS_LIST_EMPTY( _list ) ((((struct fd_list *)(_list))->head == (_list)) && (((struct fd_list *)(_list))->next == (_list))) |
0 | 550 |
551 /* Insert an item in a list at known position */ | |
552 void fd_list_insert_after ( struct fd_list * ref, struct fd_list * item ); | |
553 void fd_list_insert_before ( struct fd_list * ref, struct fd_list * item ); | |
554 | |
25
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
555 /* Move a list at the end of another */ |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
556 void fd_list_move_end(struct fd_list * ref, struct fd_list * senti); |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
557 |
0 | 558 /* Insert an item in an ordered list -- ordering function provided. If duplicate object found, EEXIST and it is returned in ref_duplicate */ |
559 int fd_list_insert_ordered( struct fd_list * head, struct fd_list * item, int (*cmp_fct)(void *, void *), void ** ref_duplicate); | |
560 | |
561 /* Unlink an item from a list */ | |
562 void fd_list_unlink ( struct fd_list * item ); | |
563 | |
564 /* Compute a hash value of a string (session id, diameter id, ...) */ | |
565 uint32_t fd_hash ( char * string, size_t len ); | |
566 | |
567 | |
568 | |
569 /*============================================================*/ | |
570 /* DICTIONARY */ | |
571 /*============================================================*/ | |
572 /* Structure that contains the complete dictionary definitions */ | |
573 struct dictionary; | |
574 | |
575 /* Structure that contains a dictionary object */ | |
576 struct dict_object; | |
577 | |
578 /* Types of object in the dictionary. */ | |
579 enum dict_object_type { | |
580 DICT_VENDOR = 1, /* Vendor */ | |
581 DICT_APPLICATION, /* Diameter Application */ | |
582 DICT_TYPE, /* AVP data type */ | |
583 DICT_ENUMVAL, /* Named constant (value of an enumerated AVP type) */ | |
584 DICT_AVP, /* AVP */ | |
585 DICT_COMMAND, /* Diameter Command */ | |
586 DICT_RULE /* a Rule for AVP in command or grouped AVP */ | |
587 #define DICT_TYPE_MAX DICT_RULE | |
588 }; | |
589 | |
590 /* Initialize a dictionary */ | |
591 int fd_dict_init(struct dictionary ** dict); | |
592 /* Destroy a dictionary */ | |
593 int fd_dict_fini(struct dictionary ** dict); | |
594 | |
595 /* | |
596 * FUNCTION: fd_dict_new | |
597 * | |
598 * PARAMETERS: | |
599 * dict : Pointer to the dictionnary where the object is created | |
600 * type : What kind of object must be created | |
601 * data : pointer to the data for the object. | |
602 * type parameter is used to determine the type of data (see bellow for detail). | |
603 * parent : a reference to a parent object, if needed. | |
604 * ref : upon successful creation, reference to new object is stored here if !null. | |
605 * | |
606 * DESCRIPTION: | |
607 * Create a new object in the dictionary. | |
608 * See following object sections in this header file for more information on data and parent parameters format. | |
609 * | |
610 * RETURN VALUE: | |
611 * 0 : The object is created in the dictionary. | |
612 * EINVAL : A parameter is invalid. | |
613 * EEXIST : This object is already defined in the dictionary (with conflicting data). | |
614 * If "ref" is not NULL, it points to the existing element on return. | |
615 * (other standard errors may be returned, too, with their standard meaning. Example: | |
616 * ENOMEM : Memory allocation for the new object element failed.) | |
617 */ | |
618 int fd_dict_new ( struct dictionary * dict, enum dict_object_type type, void * data, struct dict_object * parent, struct dict_object **ref ); | |
619 | |
620 /* | |
621 * FUNCTION: fd_dict_search | |
622 * | |
623 * PARAMETERS: | |
624 * dict : Pointer to the dictionnary where the object is searched | |
625 * type : type of object that is being searched | |
626 * criteria : how the object must be searched. See object-related sections bellow for more information. | |
627 * what : depending on criteria, the data that must be searched. | |
628 * result : On successful return, pointer to the object is stored here. | |
629 * retval : this value is returned if the object is not found and result is not NULL. | |
630 * | |
631 * DESCRIPTION: | |
632 * Perform a search in the dictionary. | |
633 * See the object-specific sections bellow to find how to look for each objects. | |
634 * If the "result" parameter is NULL, the function is used to check if an object is in the dictionary. | |
635 * Otherwise, a reference to the object is stored in result if found. | |
636 * If result is not NULL and the object is not found, retval is returned (should be 0 or ENOENT usually) | |
637 * | |
638 * RETURN VALUE: | |
639 * 0 : The object has been found in the dictionary, or *result is NULL. | |
640 * EINVAL : A parameter is invalid. | |
641 * ENOENT : No matching object has been found, and result was NULL. | |
642 */ | |
643 int fd_dict_search ( struct dictionary * dict, enum dict_object_type type, int criteria, void * what, struct dict_object **result, int retval ); | |
644 | |
645 /* Special case: get the generic error command object */ | |
646 int fd_dict_get_error_cmd(struct dictionary * dict, struct dict_object **obj); | |
647 | |
648 /* | |
649 * FUNCTION: fd_dict_getval | |
650 * | |
651 * PARAMETERS: | |
652 * object : Pointer to a dictionary object. | |
653 * data : pointer to a structure to hold the data for the object. | |
654 * The type is the same as "data" parameter in fd_dict_new function. | |
655 * | |
656 * DESCRIPTION: | |
657 * Retrieve content of a dictionary object. | |
658 * See following object sections in this header file for more information on data and parent parameters format. | |
659 * | |
660 * RETURN VALUE: | |
661 * 0 : The content of the object has been retrieved. | |
662 * EINVAL : A parameter is invalid. | |
663 */ | |
664 int fd_dict_getval ( struct dict_object * object, void * val); | |
665 int fd_dict_gettype ( struct dict_object * object, enum dict_object_type * type); | |
666 int fd_dict_getdict ( struct dict_object * object, struct dictionary ** dict); | |
667 | |
668 /* Debug functions */ | |
669 void fd_dict_dump_object(struct dict_object * obj); | |
670 void fd_dict_dump(struct dictionary * dict); | |
671 | |
672 /* | |
673 *************************************************************************** | |
674 * | |
675 * Vendor object | |
676 * | |
677 * These types are used to manage vendors in the dictionary | |
678 * | |
679 *************************************************************************** | |
680 */ | |
681 | |
682 /* Type to hold a Vendor ID: "SMI Network Management Private Enterprise Codes" (RFC3232) */ | |
683 typedef uint32_t vendor_id_t; | |
684 | |
685 /* Type to hold data associated to a vendor */ | |
686 struct dict_vendor_data { | |
687 vendor_id_t vendor_id; /* ID of a vendor */ | |
688 char *vendor_name; /* The name of this vendor */ | |
689 }; | |
690 | |
691 /* The criteria for searching a vendor object in the dictionary */ | |
692 enum { | |
693 VENDOR_BY_ID = 10, /* "what" points to a vendor_id_t */ | |
694 VENDOR_BY_NAME, /* "what" points to a string */ | |
695 VENDOR_OF_APPLICATION /* "what" points to a struct dict_object containing an application (see bellow) */ | |
696 }; | |
697 | |
698 /*** | |
699 * API usage : | |
700 | |
701 Note: the value of "vendor_name" is copied when the object is created, and the string may be disposed afterwards. | |
702 On the other side, when value is retrieved with dict_getval, the string is not copied and MUST NOT be freed. It will | |
703 be freed automatically along with the object itself with call to dict_fini later. | |
704 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
705 - fd_dict_new: |
0 | 706 The "parent" parameter is not used for vendors. |
707 Sample code to create a vendor: | |
708 { | |
709 int ret; | |
710 struct dict_object * myvendor; | |
711 struct dict_vendor_data myvendordata = { 23455, "my vendor name" }; -- just an example... | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
712 ret = fd_dict_new ( dict, DICT_VENDOR, &myvendordata, NULL, &myvendor ); |
0 | 713 } |
714 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
715 - fd_dict_search: |
0 | 716 Sample codes to look for a vendor object, by its id or name: |
717 { | |
718 int ret; | |
719 struct dict_object * vendor_found; | |
720 vendor_id_t vendorid = 23455; | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
721 ret = fd_dict_search ( dict, DICT_VENDOR, VENDOR_BY_ID, &vendorid, &vendor_found, ENOENT); |
0 | 722 - or - |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
723 ret = fd_dict_search ( dict, DICT_VENDOR, VENDOR_BY_NAME, "my vendor name", &vendor_found, ENOENT); |
0 | 724 } |
725 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
726 - fd_dict_getval: |
0 | 727 Sample code to retrieve the data from a vendor object: |
728 { | |
729 int ret; | |
730 struct dict_object * myvendor; | |
731 struct dict_vendor_data myvendordata; | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
732 ret = fd_dict_search ( dict, DICT_VENDOR, VENDOR_BY_NAME, "my vendor name", &myvendor, ENOENT); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
733 ret = fd_dict_getval ( myvendor, &myvendordata ); |
0 | 734 printf("my vendor id: %d\n", myvendordata.vendor_id ); |
735 } | |
736 | |
737 */ | |
43
2db15632a63d
Added a large part of connection establishment logic, to test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
34
diff
changeset
|
738 |
2db15632a63d
Added a large part of connection establishment logic, to test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
34
diff
changeset
|
739 /* Special function: */ |
2db15632a63d
Added a large part of connection establishment logic, to test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
34
diff
changeset
|
740 uint32_t * fd_dict_get_vendorid_list(struct dictionary * dict); |
0 | 741 |
742 /* | |
743 *************************************************************************** | |
744 * | |
745 * Application object | |
746 * | |
747 * These types are used to manage Diameter applications in the dictionary | |
748 * | |
749 *************************************************************************** | |
750 */ | |
751 | |
752 /* Type to hold a Diameter application ID: IANA assigned value for this application. */ | |
753 typedef uint32_t application_id_t; | |
754 | |
755 /* Type to hold data associated to an application */ | |
756 struct dict_application_data { | |
757 application_id_t application_id; /* ID of the application */ | |
758 char *application_name; /* The name of this application */ | |
759 }; | |
760 | |
761 /* The criteria for searching an application object in the dictionary */ | |
762 enum { | |
763 APPLICATION_BY_ID = 20, /* "what" points to a application_id_t */ | |
764 APPLICATION_BY_NAME, /* "what" points to a string */ | |
765 APPLICATION_OF_TYPE, /* "what" points to a struct dict_object containing a type object (see bellow) */ | |
766 APPLICATION_OF_COMMAND /* "what" points to a struct dict_object containing a command (see bellow) */ | |
767 }; | |
768 | |
769 /*** | |
770 * API usage : | |
771 | |
772 The "parent" parameter of dict_new may point to a vendor object to inform of what vendor defines the application. | |
773 for standard-track applications, the "parent" parameter should be NULL. | |
774 The vendor associated to an application is retrieved with VENDOR_OF_APPLICATION search criteria on vendors. | |
775 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
776 - fd_dict_new: |
0 | 777 Sample code for application creation: |
778 { | |
779 int ret; | |
780 struct dict_object * vendor; | |
781 struct dict_object * appl; | |
782 struct dict_vendor_data vendor_data = { | |
783 23455, | |
784 "my vendor name" | |
785 }; | |
786 struct dict_application_data app_data = { | |
787 9789, | |
788 "my vendor's application" | |
789 }; | |
790 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
791 ret = fd_dict_new ( dict, DICT_VENDOR, &vendor_data, NULL, &vendor ); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
792 ret = fd_dict_new ( dict, DICT_APPLICATION, &app_data, vendor, &appl ); |
0 | 793 } |
794 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
795 - fd_dict_search: |
0 | 796 Sample code to retrieve the vendor of an application |
797 { | |
798 int ret; | |
799 struct dict_object * vendor, * appli; | |
800 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
801 ret = fd_dict_search ( dict, DICT_APPLICATION, APPLICATION_BY_NAME, "my vendor's application", &appli, ENOENT); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
802 ret = fd_dict_search ( dict, DICT_VENDOR, VENDOR_OF_APPLICATION, appli, &vendor, ENOENT); |
0 | 803 } |
804 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
805 - fd_dict_getval: |
0 | 806 Sample code to retrieve the data from an application object: |
807 { | |
808 int ret; | |
809 struct dict_object * appli; | |
810 struct dict_application_data appl_data; | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
811 ret = fd_dict_search ( dict, DICT_APPLICATION, APPLICATION_BY_NAME, "my vendor's application", &appli, ENOENT); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
812 ret = fd_dict_getval ( appli, &appl_data ); |
0 | 813 printf("my application id: %s\n", appl_data.application_id ); |
814 } | |
815 | |
816 */ | |
817 | |
818 /* | |
819 *************************************************************************** | |
820 * | |
821 * Type object | |
822 * | |
823 * These types are used to manage AVP data types in the dictionary | |
824 * | |
825 *************************************************************************** | |
826 */ | |
827 | |
828 /* Type to store any AVP value */ | |
829 union avp_value { | |
830 struct { | |
831 uint8_t *data; /* bytes buffer */ | |
832 size_t len; /* length of the data buffer */ | |
833 } os; /* Storage for an octet string, data is alloc'd and must be freed */ | |
834 int32_t i32; /* integer 32 */ | |
835 int64_t i64; /* integer 64 */ | |
836 uint32_t u32; /* unsigned 32 */ | |
837 uint64_t u64; /* unsigned 64 */ | |
838 float f32; /* float 32 */ | |
839 double f64; /* float 64 */ | |
840 }; | |
841 | |
842 /* These are the basic AVP types defined in RFC3588bis */ | |
843 enum dict_avp_basetype { | |
844 AVP_TYPE_GROUPED, | |
845 AVP_TYPE_OCTETSTRING, | |
846 AVP_TYPE_INTEGER32, | |
847 AVP_TYPE_INTEGER64, | |
848 AVP_TYPE_UNSIGNED32, | |
849 AVP_TYPE_UNSIGNED64, | |
850 AVP_TYPE_FLOAT32, | |
851 AVP_TYPE_FLOAT64 | |
852 #define AVP_TYPE_MAX AVP_TYPE_FLOAT64 | |
853 }; | |
854 | |
855 /* Callbacks that can be associated with a derived type to easily interpret the AVP value. */ | |
856 /* | |
857 * CALLBACK: dict_avpdata_interpret | |
858 * | |
859 * PARAMETERS: | |
860 * val : Pointer to the AVP value that must be interpreted. | |
861 * interpreted : The result of interpretation is stored here. The format and meaning depends on each type. | |
862 * | |
863 * DESCRIPTION: | |
864 * This callback can be provided with a derived type in order to facilitate the interpretation of formated data. | |
865 * For example, when an AVP of type "Address" is received, it can be used to convert the octetstring into a struct sockaddr. | |
866 * This callback is not called directly, but through the message's API msg_avp_value_interpret function. | |
867 * | |
868 * RETURN VALUE: | |
869 * 0 : Operation complete. | |
870 * !0 : An error occurred, the error code is returned. | |
871 */ | |
872 typedef int (*dict_avpdata_interpret) (union avp_value * value, void * interpreted); | |
873 /* | |
874 * CALLBACK: dict_avpdata_encode | |
875 * | |
876 * PARAMETERS: | |
877 * data : The formated data that must be stored in the AVP value. | |
878 * val : Pointer to the AVP value storage area where the data must be stored. | |
879 * | |
880 * DESCRIPTION: | |
881 * This callback can be provided with a derived type in order to facilitate the encoding of formated data. | |
882 * For example, it can be used to convert a struct sockaddr in an AVP value of type Address. | |
883 * This callback is not called directly, but through the message's API msg_avp_value_encode function. | |
884 * If the callback is defined for an OctetString based type, the created string must be malloc'd. free will be called | |
885 * automatically later. | |
886 * | |
887 * RETURN VALUE: | |
888 * 0 : Operation complete. | |
889 * !0 : An error occurred, the error code is returned. | |
890 */ | |
891 typedef int (*dict_avpdata_encode) (void * data, union avp_value * val); | |
892 | |
893 | |
894 /* Type to hold data associated to a derived AVP data type */ | |
895 struct dict_type_data { | |
896 enum dict_avp_basetype type_base; /* How the data of such AVP must be interpreted */ | |
897 char *type_name; /* The name of this type */ | |
898 dict_avpdata_interpret type_interpret;/* cb to convert the AVP value in more comprehensive format (or NULL) */ | |
899 dict_avpdata_encode type_encode; /* cb to convert formatted data into an AVP value (or NULL) */ | |
156
e2dc300819b3
Fix overwriten thread location
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
137
diff
changeset
|
900 void (*type_dump)(union avp_value * val); /* cb called by fd_msg_dump_one for this type of data (if != NULL) */ |
0 | 901 }; |
902 | |
903 /* The criteria for searching a type object in the dictionary */ | |
904 enum { | |
905 TYPE_BY_NAME = 30, /* "what" points to a string */ | |
906 TYPE_OF_ENUMVAL, /* "what" points to a struct dict_object containing an enumerated constant (DICT_ENUMVAL, see bellow). */ | |
907 TYPE_OF_AVP /* "what" points to a struct dict_object containing an AVP object. */ | |
908 }; | |
909 | |
910 | |
911 /*** | |
912 * API usage : | |
913 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
914 - fd_dict_new: |
0 | 915 The "parent" parameter may point to an application object, when a type is defined by a Diameter application. |
916 | |
917 Sample code: | |
918 { | |
919 int ret; | |
920 struct dict_object * mytype; | |
921 struct dict_type_data mytypedata = | |
922 { | |
923 AVP_TYPE_OCTETSTRING, | |
924 "Address", | |
925 NULL, | |
926 NULL | |
927 }; | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
928 ret = fd_dict_new ( dict, DICT_TYPE, &mytypedata, NULL, &mytype ); |
0 | 929 } |
930 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
931 - fd_dict_search: |
0 | 932 Sample code: |
933 { | |
934 int ret; | |
935 struct dict_object * address_type; | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
936 ret = fd_dict_search ( dict, DICT_TYPE, TYPE_BY_NAME, "Address", &address_type, ENOENT); |
0 | 937 } |
938 | |
939 */ | |
940 | |
941 /* | |
942 *************************************************************************** | |
943 * | |
944 * Enumerated values object | |
945 * | |
946 * These types are used to manage named constants of some AVP, | |
947 * for enumerated types. Waaad allows contants for types others than Unsigned32 | |
948 * | |
949 *************************************************************************** | |
950 */ | |
951 | |
952 /* Type to hold data of named constants for AVP */ | |
953 struct dict_enumval_data { | |
954 char *enum_name; /* The name of this constant */ | |
955 union avp_value enum_value; /* Value of the constant. Union term depends on parent type's base type. */ | |
956 }; | |
957 | |
958 /* The criteria for searching a constant in the dictionary */ | |
959 enum { | |
960 ENUMVAL_BY_STRUCT = 40, /* "what" points to a struct dict_enumval_request as defined bellow */ | |
961 }; | |
962 | |
963 struct dict_enumval_request { | |
964 /* Identifier of the parent type, one of the following must not be NULL */ | |
965 struct dict_object *type_obj; | |
966 char *type_name; | |
967 | |
968 /* Search criteria for the constant */ | |
969 struct dict_enumval_data search; /* search.enum_value is used only if search.enum_name == NULL */ | |
970 }; | |
971 | |
972 /*** | |
973 * API usage : | |
974 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
975 - fd_dict_new: |
0 | 976 The "parent" parameter must point to a derived type object. |
977 Sample code to create a type "Boolean" with two constants "True" and "False": | |
978 { | |
979 int ret; | |
980 struct dict_object * type_boolean; | |
981 struct dict_type_data type_boolean_data = | |
982 { | |
983 AVP_TYPE_INTEGER32, | |
984 "Boolean", | |
985 NULL, | |
986 NULL | |
987 }; | |
988 struct dict_enumval_data boolean_false = | |
989 { | |
990 .enum_name="False", | |
991 .enum_value.i32 = 0 | |
992 }; | |
993 struct dict_enumval_data boolean_true = | |
994 { | |
995 .enum_name="True", | |
996 .enum_value.i32 = -1 | |
997 }; | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
998 ret = fd_dict_new ( dict, DICT_TYPE, &type_boolean_data, NULL, &type_boolean ); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
999 ret = fd_dict_new ( dict, DICT_ENUMVAL, &boolean_false, type_boolean, NULL ); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1000 ret = fd_dict_new ( dict, DICT_ENUMVAL, &boolean_true , type_boolean, NULL ); |
0 | 1001 |
1002 } | |
1003 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1004 - fd_dict_search: |
0 | 1005 Sample code to look for a constant name, by its value: |
1006 { | |
1007 int ret; | |
1008 struct dict_object * value_found; | |
1009 struct dict_enumval_request boolean_by_value = | |
1010 { | |
1011 .type_name = "Boolean", | |
1012 .search.enum_name=NULL, | |
1013 .search.enum_value.i32 = -1 | |
1014 }; | |
1015 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1016 ret = fd_dict_search ( dict, DICT_ENUMVAL, ENUMVAL_BY_STRUCT, &boolean_by_value, &value_found, ENOENT); |
0 | 1017 } |
1018 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1019 - fd_dict_getval: |
0 | 1020 Sample code to retrieve the data from a constant object: |
1021 { | |
1022 int ret; | |
1023 struct dict_object * value_found; | |
1024 struct dict_enumval_data boolean_data = NULL; | |
1025 struct dict_enumval_request boolean_by_value = | |
1026 { | |
1027 .type_name = "Boolean", | |
1028 .search.enum_name=NULL, | |
1029 .search.enum_value.i32 = 0 | |
1030 }; | |
1031 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1032 ret = fd_dict_search ( dict, DICT_ENUMVAL, ENUMVAL_BY_STRUCT, &boolean_by_value, &value_found, ENOENT); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1033 ret = fd_dict_getval ( value_found, &boolean_data ); |
0 | 1034 printf(" Boolean with value 0: %s", boolean_data.enum_name ); |
1035 } | |
1036 */ | |
1037 | |
1038 /* | |
1039 *************************************************************************** | |
1040 * | |
1041 * AVP object | |
1042 * | |
1043 * These objects are used to manage AVP definitions in the dictionary | |
1044 * | |
1045 *************************************************************************** | |
1046 */ | |
1047 | |
1048 /* Type to hold an AVP code. For vendor 0, these codes are assigned by IANA. Otherwise, it is managed by the vendor */ | |
1049 typedef uint32_t avp_code_t; | |
1050 | |
1051 /* Values of AVP flags */ | |
1052 #define AVP_FLAG_VENDOR 0x80 | |
1053 #define AVP_FLAG_MANDATORY 0x40 | |
1054 #define AVP_FLAG_RESERVED3 0x20 | |
1055 #define AVP_FLAG_RESERVED4 0x10 | |
1056 #define AVP_FLAG_RESERVED5 0x08 | |
1057 #define AVP_FLAG_RESERVED6 0x04 | |
1058 #define AVP_FLAG_RESERVED7 0x02 | |
1059 #define AVP_FLAG_RESERVED8 0x01 | |
1060 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1061 /* For dumping flags and values */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1062 #define DUMP_AVPFL_str "%c%c" |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1063 #define DUMP_AVPFL_val(_val) (_val & AVP_FLAG_VENDOR)?'V':'-' , (_val & AVP_FLAG_MANDATORY)?'M':'-' |
0 | 1064 |
1065 /* Type to hold data associated to an avp */ | |
1066 struct dict_avp_data { | |
1067 avp_code_t avp_code; /* Code of the avp */ | |
1068 vendor_id_t avp_vendor; /* Vendor of the AVP, or 0 */ | |
1069 char *avp_name; /* Name of this AVP */ | |
1070 uint8_t avp_flag_mask; /* Mask of fixed AVP flags */ | |
1071 uint8_t avp_flag_val; /* Values of the fixed flags */ | |
1072 enum dict_avp_basetype avp_basetype; /* Basic type of data found in the AVP */ | |
1073 }; | |
1074 | |
1075 /* The criteria for searching an avp object in the dictionary */ | |
1076 enum { | |
1077 AVP_BY_CODE = 50, /* "what" points to an avp_code_t, vendor is always 0 */ | |
1078 AVP_BY_NAME, /* "what" points to a string, vendor is always 0 */ | |
1079 AVP_BY_CODE_AND_VENDOR, /* "what" points to a struct dict_avp_request (see bellow), where avp_vendor and avp_code are set */ | |
1080 AVP_BY_NAME_AND_VENDOR /* "what" points to a struct dict_avp_request (see bellow), where avp_vendor and avp_name are set */ | |
1081 }; | |
1082 | |
1083 /* Struct used for some researchs */ | |
1084 struct dict_avp_request { | |
1085 vendor_id_t avp_vendor; | |
1086 avp_code_t avp_code; | |
1087 char *avp_name; | |
1088 }; | |
1089 | |
1090 | |
1091 /*** | |
1092 * API usage : | |
1093 | |
1094 If "parent" parameter is not NULL during AVP creation, it must point to a DICT_TYPE object. | |
1095 The extended type is then attached to the AVP. In case where it is an enumerated type, the value of | |
1096 AVP is automatically interpreted in debug messages, and in message checks. | |
1097 The derived type of an AVP can be retrieved with: dict_search ( DICT_TYPE, TYPE_OF_AVP, avp, ... ) | |
1098 | |
1099 To create the rules (ABNF) for children of Grouped AVP, see the DICT_RULE related part. | |
1100 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1101 - fd_dict_new: |
0 | 1102 Sample code for AVP creation: |
1103 { | |
1104 int ret; | |
1105 struct dict_object * user_name_avp; | |
1106 struct dict_object * boolean_type; | |
1107 struct dict_object * sample_boolean_avp; | |
1108 struct dict_avp_data user_name_data = { | |
1109 1, // code | |
1110 0, // vendor | |
1111 "User-Name", // name | |
1112 AVP_FLAG_VENDOR | AVP_FLAG_MANDATORY, // fixed mask: V and M values must always be defined as follow. other flags can be set or cleared | |
1113 AVP_FLAG_MANDATORY, // the V flag must be cleared, the M flag must be set. | |
1114 AVP_TYPE_OCTETSTRING // User-Name AVP contains OctetString data (further precision such as UTF8String can be given with a parent derived type) | |
1115 }; | |
1116 struct dict_avp_data sample_boolean_data = { | |
1117 31337, | |
1118 23455, | |
1119 "Sample-Boolean", | |
1120 AVP_FLAG_VENDOR | AVP_FLAG_MANDATORY, | |
1121 AVP_FLAG_VENDOR, | |
1122 AVP_TYPE_INTEGER32 // This MUST be the same as parent type's | |
1123 }; | |
1124 | |
1125 -- Create an AVP with a base type -- | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1126 ret = fd_dict_new ( dict, DICT_AVP, &user_name_data, NULL, &user_name_avp ); |
0 | 1127 |
1128 -- Create an AVP with a derived type -- | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1129 ret = fd_dict_search ( dict, DICT_TYPE, TYPE_BY_NAME, "Boolean", &boolean_type, ENOENT); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1130 ret = fd_dict_new ( dict, DICT_AVP, &sample_boolean_data , boolean_type, &sample_boolean_avp ); |
0 | 1131 |
1132 } | |
1133 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1134 - fd_dict_search: |
0 | 1135 Sample code to look for an AVP |
1136 { | |
1137 int ret; | |
1138 struct dict_object * avp_username; | |
1139 struct dict_object * avp_sampleboolean; | |
1140 struct dict_avp_request avpvendorboolean = | |
1141 { | |
1142 .avp_vendor = 23455, | |
1143 .avp_name = "Sample-Boolean" | |
1144 }; | |
1145 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1146 ret = fd_dict_search ( dict, DICT_AVP, AVP_BY_NAME, "User-Name", &avp_username, ENOENT); |
0 | 1147 |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1148 ret = fd_dict_search ( dict, DICT_AVP, AVP_BY_NAME_AND_VENDOR, &avpvendorboolean, &avp_sampleboolean, ENOENT); |
0 | 1149 |
1150 } | |
1151 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1152 - fd_dict_getval: |
0 | 1153 Sample code to retrieve the data from an AVP object: |
1154 { | |
1155 int ret; | |
1156 struct dict_object * avp_username; | |
1157 struct dict_avp_data user_name_data; | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1158 ret = fd_dict_search ( dict, DICT_AVP, AVP_BY_NAME, "User-Name", &avp_username, ENOENT); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1159 ret = fd_dict_getval ( avp_username, &user_name_data ); |
0 | 1160 printf("User-Name code: %d\n", user_name_data.avp_code ); |
1161 } | |
1162 | |
1163 */ | |
1164 | |
1165 /* | |
1166 *************************************************************************** | |
1167 * | |
1168 * Command object | |
1169 * | |
1170 * These types are used to manage commands objects in the dictionary | |
1171 * | |
1172 *************************************************************************** | |
1173 */ | |
1174 | |
1175 /* Type to hold a Diameter command code: IANA assigned values. 0x0-0x7fffff=standard, 0x800000-0xfffffd=vendors, 0xfffffe-0xffffff=experimental */ | |
1176 typedef uint32_t command_code_t; | |
1177 | |
1178 /* Values of command flags */ | |
1179 #define CMD_FLAG_REQUEST 0x80 | |
1180 #define CMD_FLAG_PROXIABLE 0x40 | |
1181 #define CMD_FLAG_ERROR 0x20 | |
1182 #define CMD_FLAG_RETRANSMIT 0x10 | |
1183 #define CMD_FLAG_RESERVED5 0x08 | |
1184 #define CMD_FLAG_RESERVED6 0x04 | |
1185 #define CMD_FLAG_RESERVED7 0x02 | |
1186 #define CMD_FLAG_RESERVED8 0x01 | |
1187 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1188 /* For dumping flags and values */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1189 #define DUMP_CMDFL_str "%c%c%c%c" |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1190 #define DUMP_CMDFL_val(_val) (_val & CMD_FLAG_REQUEST)?'R':'-' , (_val & CMD_FLAG_PROXIABLE)?'P':'-' , (_val & CMD_FLAG_ERROR)?'E':'-' , (_val & CMD_FLAG_RETRANSMIT)?'T':'-' |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1191 |
0 | 1192 /* Type to hold data associated to a command */ |
1193 struct dict_cmd_data { | |
1194 command_code_t cmd_code; /* code of the command */ | |
1195 char *cmd_name; /* Name of the command */ | |
1196 uint8_t cmd_flag_mask; /* Mask of fixed-value flags */ | |
1197 uint8_t cmd_flag_val; /* values of the fixed flags */ | |
1198 }; | |
1199 | |
1200 /* The criteria for searching an avp object in the dictionary */ | |
1201 enum { | |
1202 CMD_BY_NAME = 60, /* "what" points to a string */ | |
1203 CMD_BY_CODE_R, /* "what" points to a command_code_t. The "Request" command is returned. */ | |
1204 CMD_BY_CODE_A, /* "what" points to a command_code_t. The "Answer" command is returned. */ | |
1205 CMD_ANSWER /* "what" points to a struct dict_object of a request command. The corresponding "Answer" command is returned. */ | |
1206 }; | |
1207 | |
1208 | |
1209 /*** | |
1210 * API usage : | |
1211 | |
1212 The "parent" parameter of dict_new may point to an application object to inform of what application defines the command. | |
1213 The application associated to a command is retrieved with APPLICATION_OF_COMMAND search criteria on applications. | |
1214 | |
1215 To create the rules for children of commands, see the DICT_RULE related part. | |
1216 | |
1217 Note that the "Request" and "Answer" commands are two independant objects. This allows to have different rules for each. | |
1218 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1219 - fd_dict_new: |
0 | 1220 Sample code for command creation: |
1221 { | |
1222 int ret; | |
1223 struct dict_object * cer; | |
1224 struct dict_object * cea; | |
1225 struct dict_cmd_data ce_data = { | |
1226 257, // code | |
1227 "Capabilities-Exchange-Request", // name | |
1228 CMD_FLAG_REQUEST, // mask | |
1229 CMD_FLAG_REQUEST // value. Only the "R" flag is constrained here, set. | |
1230 }; | |
1231 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1232 ret = fd_dict_new (dict, DICT_COMMAND, &ce_data, NULL, &cer ); |
0 | 1233 |
1234 ce_data.cmd_name = "Capabilities-Exchange-Answer"; | |
1235 ce_data.cmd_flag_val = 0; // Same constraint on "R" flag, but this time it must be cleared. | |
1236 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1237 ret = fd_dict_new ( dict, DICT_COMMAND, &ce_data, NULL, &cea ); |
0 | 1238 } |
1239 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1240 - fd_dict_search: |
0 | 1241 Sample code to look for a command |
1242 { | |
1243 int ret; | |
1244 struct dict_object * cer, * cea; | |
1245 command_code_t code = 257; | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1246 ret = fd_dict_search ( dict, DICT_COMMAND, CMD_BY_NAME, "Capabilities-Exchange-Request", &cer, ENOENT); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1247 ret = fd_dict_search ( dict, DICT_COMMAND, CMD_BY_CODE_R, &code, &cer, ENOENT); |
0 | 1248 } |
1249 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1250 - fd_dict_getval: |
0 | 1251 Sample code to retrieve the data from a command object: |
1252 { | |
1253 int ret; | |
1254 struct dict_object * cer; | |
1255 struct dict_object * cea; | |
1256 struct dict_cmd_data cea_data; | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1257 ret = fd_dict_search ( dict, DICT_COMMAND, CMD_BY_NAME, "Capabilities-Exchange-Request", &cer, ENOENT); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1258 ret = fd_dict_search ( dict, DICT_COMMAND, CMD_ANSWER, cer, &cea, ENOENT); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1259 ret = fd_dict_getval ( cea, &cea_data ); |
0 | 1260 printf("Answer to CER: %s\n", cea_data.cmd_name ); |
1261 } | |
1262 | |
1263 */ | |
1264 | |
1265 /* | |
1266 *************************************************************************** | |
1267 * | |
1268 * Rule object | |
1269 * | |
1270 * These objects are used to manage rules in the dictionary (ABNF implementation) | |
1271 * This is used for checking messages validity (more powerful than a DTD) | |
1272 * | |
1273 *************************************************************************** | |
1274 */ | |
1275 | |
1276 /* This defines the kind of rule that is defined */ | |
1277 enum rule_position { | |
1278 RULE_FIXED_HEAD = 1, /* The AVP must be at the head of the group. The rule_order field is used to specify the position. */ | |
1279 RULE_REQUIRED, /* The AVP must be present in the parent, but its position is not defined. */ | |
1280 RULE_OPTIONAL, /* The AVP may be present in the message. Used to specify a max number of occurences for example */ | |
1281 RULE_FIXED_TAIL /* The AVP must be at the end of the group. The rule_order field is used to specify the position. */ | |
1282 }; | |
1283 | |
1284 /* Content of a RULE object data */ | |
1285 struct dict_rule_data { | |
1286 struct dict_object *rule_avp; /* Pointer to the AVP object that is concerned by this rule */ | |
1287 enum rule_position rule_position; /* The position in which the rule_avp must appear in the parent */ | |
1288 unsigned rule_order; /* for RULE_FIXED_* rules, the place. 1,2,3.. for HEAD rules; ...,3,2,1 for TAIL rules. */ | |
1289 int rule_min; /* Minimum number of occurences. -1 means "default": 0 for optional rules, 1 for other rules */ | |
1290 int rule_max; /* Maximum number of occurences. -1 means no maximum. 0 means the AVP is forbidden. */ | |
1291 }; | |
1292 | |
1293 /* The criteria for searching a rule in the dictionary */ | |
1294 enum { | |
1295 RULE_BY_AVP_AND_PARENT = 70 /* "what" points to a struct dict_rule_request -- see bellow. This is used to query "what is the rule for this AVP in this group?" */ | |
1296 }; | |
1297 | |
1298 /* Structure for querying the dictionary about a rule */ | |
1299 struct dict_rule_request { | |
1300 struct dict_object *rule_parent; /* The grouped avp or command to which the rule apply */ | |
1301 struct dict_object *rule_avp; /* The AVP concerned by this rule */ | |
1302 }; | |
1303 | |
1304 | |
1305 /*** | |
1306 * API usage : | |
1307 | |
1308 The "parent" parameter can not be NULL. It points to the object (grouped avp or command) to which this rule apply (i.e. for which the ABNF is defined). | |
1309 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1310 - fd_dict_new: |
0 | 1311 Sample code for rule creation. Let's create the Proxy-Info grouped AVP for example. |
1312 { | |
1313 int ret; | |
1314 struct dict_object * proxy_info_avp; | |
1315 struct dict_object * proxy_host_avp; | |
1316 struct dict_object * proxy_state_avp; | |
1317 struct dict_object * diameteridentity_type; | |
1318 struct dict_rule_data rule_data; | |
1319 struct dict_type_data di_type_data = { AVP_TYPE_OCTETSTRING, "DiameterIdentity", NULL, NULL }; | |
1320 struct dict_avp_data proxy_info_data = { 284, 0, "Proxy-Info", AVP_FLAG_VENDOR | AVP_FLAG_MANDATORY, AVP_FLAG_MANDATORY, AVP_TYPE_GROUPED }; | |
1321 struct dict_avp_data proxy_host_data = { 280, 0, "Proxy-Host", AVP_FLAG_VENDOR | AVP_FLAG_MANDATORY, AVP_FLAG_MANDATORY, AVP_TYPE_OCTETSTRING }; | |
1322 struct dict_avp_data proxy_state_data = { 33, 0, "Proxy-State",AVP_FLAG_VENDOR | AVP_FLAG_MANDATORY, AVP_FLAG_MANDATORY, AVP_TYPE_OCTETSTRING }; | |
1323 | |
1324 -- Create the parent AVP | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1325 ret = fd_dict_new ( dict, DICT_AVP, &proxy_info_data, NULL, &proxy_info_avp ); |
0 | 1326 |
1327 -- Create the first child AVP. | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1328 ret = fd_dict_new ( dict, DICT_TYPE, &di_type_data, NULL, &diameteridentity_type ); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1329 ret = fd_dict_new ( dict, DICT_AVP, &proxy_host_data, diameteridentity_type, &proxy_host_avp ); |
0 | 1330 |
1331 -- Create the other child AVP | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1332 ret = fd_dict_new ( dict, DICT_AVP, &proxy_state_data, NULL, &proxy_state_avp ); |
0 | 1333 |
1334 -- Now we can create the rules. Both children AVP are mandatory. | |
1335 rule_data.rule_position = RULE_REQUIRED; | |
1336 rule_data.rule_min = -1; | |
1337 rule_data.rule_max = -1; | |
1338 | |
1339 rule_data.rule_avp = proxy_host_avp; | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1340 ret = fd_dict_new ( dict, DICT_RULE, &rule_data, proxy_info_avp, NULL ); |
0 | 1341 |
1342 rule_data.rule_avp = proxy_state_avp; | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1343 ret = fd_dict_new ( dict, DICT_RULE, &rule_data, proxy_info_avp, NULL ); |
0 | 1344 } |
1345 | |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1346 - fd_dict_search and fd_dict_getval are similar to previous examples. |
0 | 1347 |
1348 */ | |
1349 | |
1350 /* Define some hard-coded values */ | |
43
2db15632a63d
Added a large part of connection establishment logic, to test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
34
diff
changeset
|
1351 /* Application */ |
2db15632a63d
Added a large part of connection establishment logic, to test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
34
diff
changeset
|
1352 #define AI_RELAY 0xffffffff |
2db15632a63d
Added a large part of connection establishment logic, to test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
34
diff
changeset
|
1353 |
0 | 1354 /* Commands Codes */ |
1355 #define CC_CAPABILITIES_EXCHANGE 257 | |
1356 #define CC_RE_AUTH 258 | |
1357 #define CC_ACCOUNTING 271 | |
1358 #define CC_ABORT_SESSION 274 | |
1359 #define CC_SESSION_TERMINATION 275 | |
1360 #define CC_DEVICE_WATCHDOG 280 | |
1361 #define CC_DISCONNECT_PEER 282 | |
1362 | |
1363 /* AVPs (Vendor 0) */ | |
87 | 1364 #define AC_USER_NAME 1 |
0 | 1365 #define AC_PROXY_STATE 33 |
1366 #define AC_HOST_IP_ADDRESS 257 | |
1367 #define AC_AUTH_APPLICATION_ID 258 | |
1368 #define AC_ACCT_APPLICATION_ID 259 | |
1369 #define AC_VENDOR_SPECIFIC_APPLICATION_ID 260 | |
1370 #define AC_REDIRECT_HOST_USAGE 261 | |
1371 #define AC_REDIRECT_MAX_CACHE_TIME 262 | |
1372 #define AC_SESSION_ID 263 | |
1373 #define AC_ORIGIN_HOST 264 | |
1374 #define AC_SUPPORTED_VENDOR_ID 265 | |
1375 #define AC_VENDOR_ID 266 | |
1376 #define AC_FIRMWARE_REVISION 267 | |
1377 #define AC_RESULT_CODE 268 | |
1378 #define AC_PRODUCT_NAME 269 | |
1379 #define AC_DISCONNECT_CAUSE 273 | |
1380 #define ACV_DC_REBOOTING 0 | |
1381 #define ACV_DC_BUSY 1 | |
1382 #define ACV_DC_NOT_FRIEND 2 | |
1383 #define AC_ORIGIN_STATE_ID 278 | |
1384 #define AC_FAILED_AVP 279 | |
1385 #define AC_PROXY_HOST 280 | |
1386 #define AC_ERROR_MESSAGE 281 | |
1387 #define AC_ROUTE_RECORD 282 | |
1388 #define AC_DESTINATION_REALM 283 | |
1389 #define AC_PROXY_INFO 284 | |
1390 #define AC_REDIRECT_HOST 292 | |
1391 #define AC_DESTINATION_HOST 293 | |
1392 #define AC_ERROR_REPORTING_HOST 294 | |
1393 #define AC_ORIGIN_REALM 296 | |
1394 #define AC_INBAND_SECURITY_ID 299 | |
43
2db15632a63d
Added a large part of connection establishment logic, to test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
34
diff
changeset
|
1395 #define ACV_ISI_NO_INBAND_SECURITY 0 |
2db15632a63d
Added a large part of connection establishment logic, to test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
34
diff
changeset
|
1396 #define ACV_ISI_TLS 1 |
0 | 1397 |
1398 /* Error codes */ | |
1399 #define ER_DIAMETER_SUCCESS 2001 | |
1400 #define ER_DIAMETER_REALM_NOT_SERVED 3003 | |
1401 #define ER_DIAMETER_TOO_BUSY 3004 | |
1402 #define ER_DIAMETER_REDIRECT_INDICATION 3006 | |
131
50d1dc19b221
Hopefully removed infinite loop
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
124
diff
changeset
|
1403 #define ER_ELECTION_LOST 4003 |
0 | 1404 |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1405 |
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1406 /*============================================================*/ |
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1407 /* SESSIONS */ |
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1408 /*============================================================*/ |
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1409 |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1410 /* Modules that want to associate a state with a Session-Id must first register a handler of this type */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1411 struct session_handler; |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1412 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1413 /* This opaque structure represents a session associated with a Session-Id */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1414 struct session; |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1415 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1416 /* The state information that a module associate with a session -- each module define its own data format */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1417 typedef void session_state; |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1418 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1419 /* |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1420 * FUNCTION: fd_sess_handler_create |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1421 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1422 * PARAMETERS: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1423 * handler : location where the new handler must be stored. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1424 * cleanup : a callback function that must be called when the session with associated data is destroyed. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1425 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1426 * DESCRIPTION: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1427 * Create a new session handler. This is needed by a module to associate a state with a session object. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1428 * The cleanup handler is called when the session timeout expires, or fd_sess_destroy is called. It must free |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1429 * the state associated with the session, and eventually trig other actions (send a STR, ...). |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1430 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1431 * RETURN VALUE: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1432 * 0 : The new handler has been created. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1433 * EINVAL : A parameter is invalid. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1434 * ENOMEM : Not enough memory to complete the operation |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1435 */ |
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1436 int fd_sess_handler_create_internal ( struct session_handler ** handler, void (*cleanup)(char * sid, session_state * state) ); |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1437 /* Macro to avoid casting everywhere */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1438 #define fd_sess_handler_create( _handler, _cleanup ) \ |
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1439 fd_sess_handler_create_internal( (_handler), (void (*)(char *, session_state *))(_cleanup) ) |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1440 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1441 /* |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1442 * FUNCTION: fd_sess_handler_destroy |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1443 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1444 * PARAMETERS: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1445 * handler : location of an handler created by fd_sess_handler_create. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1446 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1447 * DESCRIPTION: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1448 * This destroys a session handler (typically called when an application is shutting down). |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1449 * If sessions states are registered with this handler, the cleanup callback is called on them. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1450 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1451 * RETURN VALUE: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1452 * 0 : The handler was destroyed. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1453 * EINVAL : A parameter is invalid. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1454 * ENOMEM : Not enough memory to complete the operation |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1455 */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1456 int fd_sess_handler_destroy ( struct session_handler ** handler ); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1457 |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1458 |
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1459 |
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1460 /* |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1461 * FUNCTION: fd_sess_new |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1462 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1463 * PARAMETERS: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1464 * session : The location where the session object will be created upon success. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1465 * diamId : \0-terminated string containing a Diameter Identity. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1466 * opt : Additional string. Usage is described bellow. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1467 * optlen : if opt is \0-terminated, this can be 0. Otherwise, the length of opt. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1468 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1469 * DESCRIPTION: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1470 * Create a new session object. The Session-Id string associated with this session is generated as follow: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1471 * If diamId parameter is provided, the string is created according to the RFC: <diamId>;<high32>;<low32>[;opt] where |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1472 * diamId is a Diameter Identity. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1473 * high32 and low32 are the parts of a monotonic 64 bits counter initialized to (time, 0) at startup. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1474 * opt is an optional string that can be concatenated to the identifier. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1475 * If diamId is NULL, the string is exactly the content of opt. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1476 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1477 * RETURN VALUE: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1478 * 0 : The session is created. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1479 * EINVAL : A parameter is invalid. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1480 * EALREADY : A session with the same name already exists (returned in *session) |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1481 * ENOMEM : Not enough memory to complete the operation |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1482 */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1483 int fd_sess_new ( struct session ** session, char * diamId, char * opt, size_t optlen ); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1484 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1485 /* |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1486 * FUNCTION: fd_sess_fromsid |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1487 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1488 * PARAMETERS: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1489 * sid : pointer to a string containing a Session-Id (UTF-8). |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1490 * len : length of the sid string (which does not need to be '\0'-terminated) |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1491 * session : On success, pointer to the session object created / retrieved. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1492 * new : if not NULL, set to 1 on return if the session object has been created, 0 if it was simply retrieved. |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1493 * |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1494 * DESCRIPTION: |
85
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
1495 * Retrieve a session object from a Session-Id string. In case no session object was previously existing with this |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1496 * id, a new object is silently created (equivalent to fd_sess_new with flag SESSION_NEW_FULL). |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1497 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1498 * RETURN VALUE: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1499 * 0 : The session parameter has been updated. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1500 * EINVAL : A parameter is invalid. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1501 * ENOMEM : Not enough memory to complete the operation |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1502 */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1503 int fd_sess_fromsid ( char * sid, size_t len, struct session ** session, int * new); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1504 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1505 /* |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1506 * FUNCTION: fd_sess_getsid |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1507 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1508 * PARAMETERS: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1509 * session : Pointer to a session object. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1510 * sid : On success, the location of a (\0-terminated) string is stored here. |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1511 * |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1512 * DESCRIPTION: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1513 * Retrieve the session identifier (Session-Id) corresponding to a session object. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1514 * The returned sid is an UTF-8 string terminated by \0, suitable for calls to strlen and strcpy. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1515 * It may be used for example to set the value of an AVP. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1516 * Note that the sid string is not copied, just its reference... do not free it! |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1517 * |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1518 * RETURN VALUE: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1519 * 0 : The sid parameter has been updated. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1520 * EINVAL : A parameter is invalid. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1521 */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1522 int fd_sess_getsid ( struct session * session, char ** sid ); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1523 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1524 /* |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1525 * FUNCTION: fd_sess_settimeout |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1526 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1527 * PARAMETERS: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1528 * session : The session for which to set the timeout. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1529 * timeout : The date when the session times out. |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1530 * |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1531 * DESCRIPTION: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1532 * Set the lifetime for a given session object. This function may be |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1533 * called several times on the same object to update the timeout value. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1534 * When the timeout date is reached, the cleanup handler of each |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1535 * module that registered data with this session is called, then the |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1536 * session is cleared. |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1537 * |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1538 * There is a possible race condition between cleanup of the session |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1539 * and use of its data; applications should ensure that they are not |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1540 * using data from a session that is about to expire / expired. |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1541 * |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1542 * RETURN VALUE: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1543 * 0 : The session timeout has been updated. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1544 * EINVAL : A parameter is invalid. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1545 */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1546 int fd_sess_settimeout( struct session * session, const struct timespec * timeout ); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1547 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1548 /* |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1549 * FUNCTION: fd_sess_destroy |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1550 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1551 * PARAMETERS: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1552 * session : Pointer to a session object. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1553 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1554 * DESCRIPTION: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1555 * Destroys a session an all associated data, if any. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1556 * Equivalent to a session timeout expired, but the effect is immediate. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1557 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1558 * RETURN VALUE: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1559 * 0 : The session no longer exists. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1560 * EINVAL : A parameter is invalid. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1561 */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1562 int fd_sess_destroy ( struct session ** session ); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1563 |
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1564 /* |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1565 * FUNCTION: fd_sess_reclaim |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1566 * |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1567 * PARAMETERS: |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1568 * session : Pointer to a session object. |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1569 * |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1570 * DESCRIPTION: |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1571 * Destroys the resources of a session, only if no session_state is associated with it. |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1572 * |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1573 * RETURN VALUE: |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1574 * 0 : The session no longer exists. |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1575 * EINVAL : A parameter is invalid. |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1576 */ |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1577 int fd_sess_reclaim ( struct session ** session ); |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1578 |
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1579 |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1580 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1581 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1582 /* |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1583 * FUNCTION: fd_sess_state_store |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1584 * |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1585 * PARAMETERS: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1586 * handler : The handler with which the state is registered. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1587 * session : The session object with which the state is registered. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1588 * state : An application state (opaque data) to store with the session. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1589 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1590 * DESCRIPTION: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1591 * Stores an application state with a session. This state can later be retrieved |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1592 * with fd_sess_state_retrieve, or implicitly in the cleanup handler when the session |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1593 * is destroyed. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1594 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1595 * RETURN VALUE: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1596 * 0 : The state has been stored. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1597 * EINVAL : A parameter is invalid. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1598 * EALREADY : Data was already associated with this session and client. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1599 * ENOMEM : Not enough memory to complete the operation |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1600 */ |
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1601 int fd_sess_state_store_internal ( struct session_handler * handler, struct session * session, session_state ** state ); |
5
c2d2729e3603
Completed new session module tests; some bugs fixed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
3
diff
changeset
|
1602 #define fd_sess_state_store( _handler, _session, _state ) \ |
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1603 fd_sess_state_store_internal( (_handler), (_session), (void *)(_state) ) |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1604 |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1605 /* |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1606 * FUNCTION: fd_sess_state_retrieve |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1607 * |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1608 * PARAMETERS: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1609 * handler : The handler with which the state was registered. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1610 * session : The session object with which the state was registered. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1611 * state : Location where the state must be saved if it is found. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1612 * |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1613 * DESCRIPTION: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1614 * Retrieves a state saved by fd_sess_state_store. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1615 * After this function has been called, the state is no longer associated with |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1616 * the session. A new call to fd_sess_state_store must be performed in order to |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1617 * store again the data with the session. |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1618 * |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1619 * RETURN VALUE: |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1620 * 0 : *state is updated (NULL or points to the state if it was found). |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1621 * EINVAL : A parameter is invalid. |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1622 */ |
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1623 int fd_sess_state_retrieve_internal ( struct session_handler * handler, struct session * session, session_state ** state ); |
5
c2d2729e3603
Completed new session module tests; some bugs fixed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
3
diff
changeset
|
1624 #define fd_sess_state_retrieve( _handler, _session, _state ) \ |
6
b0d377c79d80
Progress on dispatch API spec; added fd_sess_reclaim function and test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
5
diff
changeset
|
1625 fd_sess_state_retrieve_internal( (_handler), (_session), (void *)(_state) ) |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1626 |
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1627 |
3
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1628 /* For debug */ |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1629 void fd_sess_dump(int level, struct session * session); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1630 void fd_sess_dump_hdl(int level, struct session_handler * handler); |
ef303f1078ab
Progress; added session module; testsess to be completed
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
2
diff
changeset
|
1631 |
2
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1632 |
d8ce06172629
Added a global debug level var
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
1
diff
changeset
|
1633 /*============================================================*/ |
83
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1634 /* ROUTING */ |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1635 /*============================================================*/ |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1636 |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1637 /* The following functions are helpers for the routing module. |
168
6db078b955e3
Completed rt_default extension
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
156
diff
changeset
|
1638 The routing data is stored in the message itself. */ |
83
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1639 |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1640 /* Structure that contains the routing data for a message */ |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1641 struct rt_data; |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1642 |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1643 /* Following functions are helpers to create the routing data of a message */ |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1644 int fd_rtd_init(struct rt_data ** rtd); |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1645 void fd_rtd_free(struct rt_data ** rtd); |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1646 |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1647 /* Add a peer to the candidates list */ |
168
6db078b955e3
Completed rt_default extension
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
156
diff
changeset
|
1648 int fd_rtd_candidate_add(struct rt_data * rtd, char * peerid, char * realm); |
83
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1649 |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1650 /* Remove a peer from the candidates (if it is found) */ |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1651 void fd_rtd_candidate_del(struct rt_data * rtd, char * peerid, size_t sz /* if !0, peerid does not need to be \0 terminated */); |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1652 |
88
9e2db1647d6f
Completed routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
87
diff
changeset
|
1653 /* Extract the list of valid candidates, and initialize their scores to 0 */ |
124
cc42d8607114
Completed cleanups of queues when the daemon is stopping
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
114
diff
changeset
|
1654 void fd_rtd_candidate_extract(struct rt_data * rtd, struct fd_list ** candidates, int ini_score); |
88
9e2db1647d6f
Completed routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
87
diff
changeset
|
1655 |
83
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1656 /* If a peer returned a protocol error for this message, save it so that we don't try to send it there again */ |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1657 int fd_rtd_error_add(struct rt_data * rtd, char * sentto, uint8_t * origin, size_t originsz, uint32_t rcode); |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1658 |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1659 /* The extracted list items have the following structure: */ |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1660 struct rtd_candidate { |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1661 struct fd_list chain; /* link in the list returned by the previous fct */ |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1662 char * diamid; /* the diameter Id of the peer */ |
168
6db078b955e3
Completed rt_default extension
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
156
diff
changeset
|
1663 char * realm; /* the diameter realm of the peer (if known) */ |
83
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1664 int score; /* the current routing score for this peer, see fd_rt_out_register definition for details */ |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1665 }; |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1666 |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1667 /* Reorder the list of peers */ |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1668 int fd_rtd_candidate_reorder(struct fd_list * candidates); |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1669 |
85
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
1670 /* Note : it is fine for a callback to add a new entry in the candidates list after the list has been extracted. The diamid must then be malloc'd. */ |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
1671 /* Beware that this could lead to routing loops */ |
83
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1672 |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
1673 /*============================================================*/ |
0 | 1674 /* MESSAGES */ |
1675 /*============================================================*/ | |
1676 | |
1677 /* The following types are opaque */ | |
1678 struct msg; /* A message: command with children AVPs (possibly grand children) */ | |
1679 struct avp; /* AVP object */ | |
1680 | |
1681 /* Some details about chaining: | |
1682 * | |
1683 * A message is made of a header ( msg ) and 0 or more AVPs ( avp ). | |
1684 * The structure is a kind of tree, where some AVPs (grouped AVPs) can contain other AVPs. | |
1685 * Exemple: | |
1686 * msg | |
1687 * |-avp | |
1688 * |-gavp | |
1689 * | |-avp | |
1690 * | |-avp | |
1691 * | \-avp | |
1692 * |-avp | |
1693 * \-avp | |
1694 * | |
1695 */ | |
1696 | |
1697 /* The following type is used to point to either a msg or an AVP */ | |
1698 typedef void msg_or_avp; | |
1699 | |
1700 /* The Diameter protocol version */ | |
1701 #define DIAMETER_VERSION 1 | |
1702 | |
1703 /* In the two following types, some fields are marked (READONLY). | |
1704 * This means that the content of these fields will be overwritten by the daemon so modifying it is useless. | |
1705 */ | |
1706 | |
1707 /* The following structure represents the header of a message. All data is in host byte order. */ | |
1708 struct msg_hdr { | |
1709 uint8_t msg_version; /* (READONLY) Version of Diameter: must be DIAMETER_VERSION. */ | |
1710 uint32_t msg_length; /* (READONLY)(3 bytes) indicates the length of the message */ | |
1711 uint8_t msg_flags; /* Message flags: CMD_FLAG_* */ | |
1712 command_code_t msg_code; /* (3 bytes) the command-code. See dictionary-api.h for more detail */ | |
1713 application_id_t msg_appl; /* The application issuing this message */ | |
1714 uint32_t msg_hbhid; /* The Hop-by-Hop identifier of the message */ | |
1715 uint32_t msg_eteid; /* The End-to-End identifier of the message */ | |
1716 }; | |
1717 | |
1718 /* The following structure represents the visible content of an AVP. All data is in host byte order. */ | |
1719 struct avp_hdr { | |
1720 avp_code_t avp_code; /* the AVP Code */ | |
1721 uint8_t avp_flags; /* AVP_FLAG_* flags */ | |
1722 uint32_t avp_len; /* (READONLY)(Only 3 bytes are used) the length of the AVP as described in the RFC */ | |
1723 vendor_id_t avp_vendor; /* Only used if AVP_FLAG_VENDOR is present */ | |
1724 union avp_value *avp_value; /* pointer to the value of the AVP. NULL means that the value is not set / not understood. | |
1725 One should not directly change this value. Use the msg_avp_setvalue function instead. | |
1726 The content of the pointed structure can be changed directly, with this restriction: | |
1727 if the AVP is an OctetString, and you change the value of the pointer avp_value->os.data, then | |
1728 you must call free() on the previous value, and the new one must be free()-able. | |
1729 */ | |
1730 }; | |
1731 | |
1732 /* The following enum is used to browse inside message hierarchy (msg, gavp, avp) */ | |
1733 enum msg_brw_dir { | |
1734 MSG_BRW_NEXT = 1, /* Get the next element at the same level, or NULL if this is the last element. */ | |
1735 MSG_BRW_PREV, /* Get the previous element at the same level, or NULL if this is the first element. */ | |
1736 MSG_BRW_FIRST_CHILD, /* Get the first child AVP of this element, if any. */ | |
1737 MSG_BRW_LAST_CHILD, /* Get the last child AVP of this element, if any. */ | |
1738 MSG_BRW_PARENT, /* Get the parent element of this element, if any. Only the msg_t object has no parent. */ | |
1739 MSG_BRW_WALK /* This is equivalent to FIRST_CHILD or NEXT or PARENT->next, first that is not NULL. Use this to walk inside all AVPs. */ | |
1740 }; | |
1741 | |
1742 /* Some flags used in the functions bellow */ | |
1743 #define MSGFL_ALLOC_ETEID 0x01 /* When creating a message, a new end-to-end ID is allocated and set in the message */ | |
1744 #define MSGFL_ANSW_ERROR 0x02 /* When creating an answer message, set the 'E' bit and use the generic error ABNF instead of command-specific ABNF */ | |
112
6a294d977878
Default to add Session-Id in answers
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
90
diff
changeset
|
1745 #define MSGFL_ANSW_NOSID 0x04 /* When creating an answer message, do not add the Session-Id even if present in request */ |
6a294d977878
Default to add Session-Id in answers
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
90
diff
changeset
|
1746 #define MSGFL_MAX MSGFL_ANSW_NOSID /* The biggest valid flag value */ |
0 | 1747 |
1748 /**************************************************/ | |
1749 /* Message creation, manipulation, disposal */ | |
1750 /**************************************************/ | |
1751 /* | |
1752 * FUNCTION: fd_msg_avp_new | |
1753 * | |
1754 * PARAMETERS: | |
1755 * model : Pointer to a DICT_AVP dictionary object describing the avp to create, or NULL. | |
1756 * flags : Flags to use in creation (not used yet, should be 0). | |
1757 * avp : Upon success, pointer to the new avp is stored here. | |
1758 * | |
1759 * DESCRIPTION: | |
1760 * Create a new AVP instance. | |
1761 * | |
1762 * RETURN VALUE: | |
1763 * 0 : The AVP is created. | |
1764 * EINVAL : A parameter is invalid. | |
1765 * (other standard errors may be returned, too, with their standard meaning. Example: | |
1766 * ENOMEM : Memory allocation for the new avp failed.) | |
1767 */ | |
1768 int fd_msg_avp_new ( struct dict_object * model, int flags, struct avp ** avp ); | |
1769 | |
1770 /* | |
1771 * FUNCTION: fd_msg_new | |
1772 * | |
1773 * PARAMETERS: | |
1774 * model : Pointer to a DICT_COMMAND dictionary object describing the message to create, or NULL. | |
1775 * flags : combination of MSGFL_* flags. | |
1776 * msg : Upon success, pointer to the new message is stored here. | |
1777 * | |
1778 * DESCRIPTION: | |
1779 * Create a new empty Diameter message. | |
1780 * | |
1781 * RETURN VALUE: | |
1782 * 0 : The message is created. | |
1783 * EINVAL : A parameter is invalid. | |
1784 * (other standard errors may be returned, too, with their standard meaning. Example: | |
1785 * ENOMEM : Memory allocation for the new message failed.) | |
1786 */ | |
1787 int fd_msg_new ( struct dict_object * model, int flags, struct msg ** msg ); | |
1788 | |
1789 /* | |
1790 * FUNCTION: msg_new_answer_from_req | |
1791 * | |
1792 * PARAMETERS: | |
1793 * dict : Pointer to the dictionary containing the model of the query. | |
1794 * msg : The location of the query on function call. Updated by the location of answer message on return. | |
1795 * flag : Pass MSGFL_ANSW_ERROR to indicate if the answer is an error message (will set the 'E' bit) | |
1796 * | |
1797 * DESCRIPTION: | |
1798 * This function creates the empty answer message corresponding to a request. | |
1799 * The header is set properly (R flag, ccode, appid, hbhid, eteid) | |
1800 * The Session-Id AVP is copied if present. | |
1801 * The calling code should usually call fd_msg_rescode_set function on the answer. | |
1802 * Upon return, the original query may be retrieved by calling fd_msg_answ_getq on the message. | |
1803 * | |
1804 * RETURN VALUE: | |
1805 * 0 : Operation complete. | |
1806 * !0 : an error occurred. | |
1807 */ | |
1808 int fd_msg_new_answer_from_req ( struct dictionary * dict, struct msg ** msg, int flag ); | |
1809 | |
1810 /* | |
1811 * FUNCTION: fd_msg_browse | |
1812 * | |
1813 * PARAMETERS: | |
1814 * reference : Pointer to a struct msg or struct avp. | |
1815 * dir : Direction for browsing | |
1816 * found : If not NULL, updated with the element that has been found, if any, or NULL if no element was found / an error occurred. | |
1817 * depth : If not NULL, points to an integer representing the "depth" of this object in the tree. This is a relative value, updated on return. | |
1818 * | |
1819 * DESCRIPTION: | |
1820 * Explore the content of a message object (hierarchy). If "found" is null, only error checking is performed. | |
1821 * If "depth" is provided, it is updated as follow on successful function return: | |
1822 * - not modified for MSG_BRW_NEXT and MSG_BRW_PREV. | |
1823 * - *depth = *depth + 1 for MSG_BRW_FIRST_CHILD and MSG_BRW_LAST_CHILD. | |
1824 * - *depth = *depth - 1 for MSG_BRW_PARENT. | |
1825 * - *depth = *depth + X for MSG_BRW_WALK, with X between 1 (returned the 1st child) and -N (returned the Nth parent's next). | |
1826 * | |
1827 * RETURN VALUE: | |
1828 * 0 : found has been updated (if non NULL). | |
1829 * EINVAL : A parameter is invalid. | |
1830 * ENOENT : No element has been found where requested, and "found" was NULL (otherwise, *found is set to NULL and 0 is returned). | |
1831 */ | |
1832 int fd_msg_browse_internal ( msg_or_avp * reference, enum msg_brw_dir dir, msg_or_avp ** found, int * depth ); | |
1833 /* Macro to avoid having to cast the third parameter everywhere */ | |
1834 #define fd_msg_browse( ref, dir, found, depth ) \ | |
1835 fd_msg_browse_internal( (ref), (dir), (void *)(found), (depth) ) | |
1836 | |
1837 | |
1838 /* | |
1839 * FUNCTION: fd_msg_avp_add | |
1840 * | |
1841 * PARAMETERS: | |
1842 * reference : Pointer to a valid msg or avp. | |
1843 * dir : location where the new AVP should be inserted, relative to the reference. MSG_BRW_PARENT and MSG_BRW_WALK are not valid. | |
1844 * avp : pointer to the AVP object that must be inserted. | |
1845 * | |
1846 * DESCRIPTION: | |
1847 * Adds an AVP into an object that can contain it: grouped AVP or message. | |
1848 * | |
1849 * RETURN VALUE: | |
1850 * 0 : The AVP has been added. | |
1851 * EINVAL : A parameter is invalid. | |
1852 */ | |
1853 int fd_msg_avp_add ( msg_or_avp * reference, enum msg_brw_dir dir, struct avp *avp); | |
1854 | |
1855 /* | |
1856 * FUNCTION: fd_msg_search_avp | |
1857 * | |
1858 * PARAMETERS: | |
1859 * msg : The message structure in which to search the AVP. | |
1860 * what : The dictionary model of the AVP to search. | |
1861 * avp : location where the AVP reference is stored if found. | |
1862 * | |
1863 * DESCRIPTION: | |
1864 * Search the first top-level AVP of a given model inside a message. | |
1865 * Note: only the first instance of the AVP is returned by this function. | |
1866 * Note: only top-level AVPs are searched, not inside grouped AVPs. | |
1867 * Use msg_browse if you need more advanced research features. | |
1868 * | |
1869 * RETURN VALUE: | |
1870 * 0 : The AVP has been found. | |
1871 * EINVAL : A parameter is invalid. | |
1872 * ENOENT : No AVP has been found, and "avp" was NULL (otherwise, *avp is set to NULL and 0 returned). | |
1873 */ | |
1874 int fd_msg_search_avp ( struct msg * msg, struct dict_object * what, struct avp ** avp ); | |
1875 | |
1876 /* | |
1877 * FUNCTION: fd_msg_free | |
1878 * | |
1879 * PARAMETERS: | |
1880 * object : pointer to the message or AVP object that must be unlinked and freed. | |
1881 * | |
1882 * DESCRIPTION: | |
1883 * Unlink and free a message or AVP object and its children. | |
1884 * If the object is an AVP linked into a message, the AVP is removed before being freed. | |
1885 * | |
1886 * RETURN VALUE: | |
1887 * 0 : The message has been freed. | |
1888 * EINVAL : A parameter is invalid. | |
1889 */ | |
1890 int fd_msg_free ( msg_or_avp * object ); | |
1891 | |
1892 /***************************************/ | |
1893 /* Dump functions */ | |
1894 /***************************************/ | |
1895 /* | |
1896 * FUNCTION: fd_msg_dump_* | |
1897 * | |
1898 * PARAMETERS: | |
1899 * level : the log level (INFO, FULL, ...) at which the object is dumped | |
1900 * obj : A msg or avp object. | |
1901 * | |
1902 * DESCRIPTION: | |
1903 * These functions dump the content of a message to the debug log | |
1904 * either recursively or only the object itself. | |
1905 * | |
1906 * RETURN VALUE: | |
1907 * - | |
1908 */ | |
1909 void fd_msg_dump_walk ( int level, msg_or_avp *obj ); | |
1910 void fd_msg_dump_one ( int level, msg_or_avp *obj ); | |
1911 | |
1912 | |
1913 /*********************************************/ | |
1914 /* Message metadata management functions */ | |
1915 /*********************************************/ | |
1916 /* | |
1917 * FUNCTION: fd_msg_model | |
1918 * | |
1919 * PARAMETERS: | |
1920 * reference : Pointer to a valid msg or avp. | |
1921 * model : on success, pointer to the dictionary model of this command or AVP. NULL if the model is unknown. | |
1922 * | |
1923 * DESCRIPTION: | |
1924 * Retrieve the dictionary object describing this message or avp. If the object is unknown or the fd_msg_parse_dict has not been called, | |
1925 * *model is set to NULL. | |
1926 * | |
1927 * RETURN VALUE: | |
1928 * 0 : The model has been set. | |
1929 * EINVAL : A parameter is invalid. | |
1930 */ | |
1931 int fd_msg_model ( msg_or_avp * reference, struct dict_object ** model ); | |
1932 | |
1933 /* | |
1934 * FUNCTION: fd_msg_hdr | |
1935 * | |
1936 * PARAMETERS: | |
1937 * msg : Pointer to a valid message object. | |
1938 * pdata : Upon success, pointer to the msg_hdr structure of this message. The fields may be modified. | |
1939 * | |
1940 * DESCRIPTION: | |
1941 * Retrieve location of modifiable section of a message. | |
1942 * | |
1943 * RETURN VALUE: | |
1944 * 0 : The location has been written. | |
1945 * EINVAL : A parameter is invalid. | |
1946 */ | |
1947 int fd_msg_hdr ( struct msg *msg, struct msg_hdr **pdata ); | |
1948 | |
1949 /* | |
1950 * FUNCTION: fd_msg_avp_hdr | |
1951 * | |
1952 * PARAMETERS: | |
1953 * avp : Pointer to a valid avp object. | |
1954 * pdata : Upon success, pointer to the avp_hdr structure of this avp. The fields may be modified. | |
1955 * | |
1956 * DESCRIPTION: | |
1957 * Retrieve location of modifiable data of an avp. | |
1958 * | |
1959 * RETURN VALUE: | |
1960 * 0 : The location has been written. | |
1961 * EINVAL : A parameter is invalid. | |
1962 */ | |
1963 int fd_msg_avp_hdr ( struct avp *avp, struct avp_hdr **pdata ); | |
1964 | |
1965 /* | |
1966 * FUNCTION: fd_msg_answ_associate, fd_msg_answ_getq, fd_msg_answ_detach | |
1967 * | |
1968 * PARAMETERS: | |
1969 * answer : the received answer message | |
1970 * query : the corresponding query that had been sent | |
1971 * | |
1972 * DESCRIPTION: | |
1973 * fd_msg_answ_associate associates a query msg with the received answer. | |
1974 * Query is retrieved with fd_msg_answ_getq. | |
1975 * If answer message is freed, the query is also freed. | |
1976 * If the msg_answ_detach function is called, the association is removed. | |
1977 * This is meant to be called from the daemon only. | |
1978 * | |
1979 * RETURN VALUE: | |
1980 * 0 : ok | |
1981 * EINVAL: a parameter is invalid | |
1982 */ | |
1983 int fd_msg_answ_associate( struct msg * answer, struct msg * query ); | |
1984 int fd_msg_answ_getq ( struct msg * answer, struct msg ** query ); | |
1985 int fd_msg_answ_detach ( struct msg * answer ); | |
1986 | |
1987 /* | |
1988 * FUNCTION: fd_msg_anscb_associate, fd_msg_anscb_get | |
1989 * | |
1990 * PARAMETERS: | |
1991 * msg : the answer message | |
1992 * anscb : the callback to associate with the message | |
1993 * data : the data to pass to the callback | |
1994 * | |
1995 * DESCRIPTION: | |
1996 * Associate or retrieve a callback with an answer message. | |
1997 * This is meant to be called from the daemon only. | |
1998 * | |
1999 * RETURN VALUE: | |
2000 * 0 : ok | |
2001 * EINVAL: a parameter is invalid | |
2002 */ | |
2003 int fd_msg_anscb_associate( struct msg * msg, void ( *anscb)(void *, struct msg **), void * data ); | |
2004 int fd_msg_anscb_get ( struct msg * msg, void (**anscb)(void *, struct msg **), void ** data ); | |
2005 | |
2006 /* | |
2007 * FUNCTION: fd_msg_rt_associate, fd_msg_rt_get | |
2008 * | |
2009 * PARAMETERS: | |
2010 * msg : the query message to be sent | |
2011 * list : the ordered list of possible next-peers | |
2012 * | |
2013 * DESCRIPTION: | |
2014 * Associate a routing list with a query, and retrieve it. | |
2015 * If the message is freed, the list is also freed. | |
2016 * | |
2017 * RETURN VALUE: | |
2018 * 0 : ok | |
2019 * EINVAL: a parameter is invalid | |
2020 */ | |
83
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
2021 int fd_msg_rt_associate( struct msg * msg, struct rt_data ** rtd ); |
c662d3eb6ff6
Started support for routing module
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
43
diff
changeset
|
2022 int fd_msg_rt_get ( struct msg * msg, struct rt_data ** rtd ); |
0 | 2023 |
2024 /* | |
2025 * FUNCTION: fd_msg_is_routable | |
2026 * | |
2027 * PARAMETERS: | |
2028 * msg : A msg object. | |
2029 * | |
2030 * DESCRIPTION: | |
2031 * This function returns a boolean telling if a given message is routable in the Diameter network, | |
2032 * or if it is a local link message only (ex: CER/CEA, DWR/DWA, ...). | |
2033 * | |
2034 * RETURN VALUE: | |
2035 * 0 : The message is not routable / an error occurred. | |
2036 * 1 : The message is routable. | |
2037 */ | |
2038 int fd_msg_is_routable ( struct msg * msg ); | |
2039 | |
2040 /* | |
2041 * FUNCTION: fd_msg_source_(g/s)et | |
2042 * | |
2043 * PARAMETERS: | |
2044 * msg : A msg object. | |
2045 * diamid : The diameter id of the peer from which this message was received. | |
2046 * hash : The hash for the diamid value. | |
2047 * add_rr : if true, a Route-Record AVP is added to the message with content diamid. In that case, dict must be supplied. | |
2048 * dict : a dictionary with definition of Route-Record AVP (if add_rr is true) | |
2049 * | |
2050 * DESCRIPTION: | |
2051 * Store or retrieve the diameted id of the peer from which this message was received. | |
2052 * Will be used for example by the routing module to add the Route-Record AVP in forwarded requests, | |
2053 * or to direct answers to the appropriate peer. | |
2054 * | |
2055 * RETURN VALUE: | |
2056 * 0 : Operation complete. | |
2057 * !0 : an error occurred. | |
2058 */ | |
34
0e2b57789361
Backup for the WE, some warnings remaining
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
33
diff
changeset
|
2059 int fd_msg_source_set( struct msg * msg, char * diamid, int add_rr, struct dictionary * dict ); |
0e2b57789361
Backup for the WE, some warnings remaining
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
33
diff
changeset
|
2060 int fd_msg_source_get( struct msg * msg, char ** diamid ); |
0 | 2061 |
2062 /* | |
2063 * FUNCTION: fd_msg_eteid_get | |
2064 * | |
2065 * PARAMETERS: | |
2066 * - | |
2067 * | |
2068 * DESCRIPTION: | |
2069 * Get a new unique end-to-end id value for the local peer. | |
2070 * | |
2071 * RETURN VALUE: | |
2072 * The new assigned value. No error code is defined. | |
2073 */ | |
2074 uint32_t fd_msg_eteid_get ( void ); | |
2075 | |
2076 | |
85
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2077 /* |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2078 * FUNCTION: fd_msg_sess_get |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2079 * |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2080 * PARAMETERS: |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2081 * dict : the dictionary that contains the Session-Id AVP definition |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2082 * msg : A valid message. |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2083 * session : Location to store the session pointer when retrieved. |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2084 * new : Indicates if the session has been created. |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2085 * |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2086 * DESCRIPTION: |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2087 * This function retrieves or creates the session object corresponding to a message. |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2088 * If the message does not contain a Session-Id AVP, *session == NULL on return. |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2089 * Note that the Session-Id AVP must never be modified after created in a message. |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2090 * |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2091 * RETURN VALUE: |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2092 * 0 : success |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2093 * !0 : standard error code. |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2094 */ |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2095 int fd_msg_sess_get(struct dictionary * dict, struct msg * msg, struct session ** session, int * new); |
e5fcd672caff
Added new function to retrieve messages sessions easily
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
83
diff
changeset
|
2096 |
0 | 2097 /***************************************/ |
2098 /* Manage AVP values */ | |
2099 /***************************************/ | |
2100 | |
2101 /* | |
2102 * FUNCTION: fd_msg_avp_setvalue | |
2103 * | |
2104 * PARAMETERS: | |
2105 * avp : Pointer to a valid avp object with a NULL avp_value pointer. The model must be known. | |
2106 * value : pointer to an avp_value. The content will be COPIED into the internal storage area. | |
2107 * If data type is an octetstring, the data is also copied. | |
2108 * If value is a NULL pointer, the previous data is erased and value is unset in the AVP. | |
2109 * | |
2110 * DESCRIPTION: | |
2111 * Initialize the avp_value field of an AVP header. | |
2112 * | |
2113 * RETURN VALUE: | |
2114 * 0 : The avp_value pointer has been set. | |
2115 * EINVAL : A parameter is invalid. | |
2116 */ | |
2117 int fd_msg_avp_setvalue ( struct avp *avp, union avp_value *value ); | |
2118 | |
2119 /* | |
2120 * FUNCTION: fd_msg_avp_value_encode | |
2121 * | |
2122 * PARAMETERS: | |
2123 * avp : Pointer to a valid avp object with a NULL avp_value. The model must be known. | |
2124 * data : Pointer to the data that must be encoded as AVP value and stored in the AVP. | |
2125 * This is only valid for AVPs of derived type for which type_data_encode callback is set. (ex: Address type) | |
2126 * | |
2127 * DESCRIPTION: | |
2128 * Initialize the avp_value field of an AVP object from formatted data, using the AVP's type "type_data_encode" callback. | |
2129 * | |
2130 * RETURN VALUE: | |
2131 * 0 : The avp_value has been set. | |
2132 * EINVAL : A parameter is invalid. | |
2133 * ENOTSUP : There is no appropriate callback registered with this AVP's type. | |
2134 */ | |
2135 int fd_msg_avp_value_encode ( void *data, struct avp *avp ); | |
2136 | |
2137 /* | |
2138 * FUNCTION: fd_msg_avp_value_interpret | |
2139 * | |
2140 * PARAMETERS: | |
2141 * avp : Pointer to a valid avp object with a non-NULL avp_value value. | |
2142 * data : Upon success, formatted interpretation of the AVP value is stored here. | |
2143 * | |
2144 * DESCRIPTION: | |
2145 * Interpret the content of an AVP of Derived type and store the result in data pointer. The structure | |
2146 * of the data pointer is dependent on the AVP type. This function calls the "type_data_interpret" callback | |
2147 * of the type. | |
2148 * | |
2149 * RETURN VALUE: | |
2150 * 0 : The avp_value has been set. | |
2151 * EINVAL : A parameter is invalid. | |
2152 * ENOTSUP : There is no appropriate callback registered with this AVP's type. | |
2153 */ | |
2154 int fd_msg_avp_value_interpret ( struct avp *avp, void *data ); | |
2155 | |
2156 | |
2157 /***************************************/ | |
2158 /* Message parsing functions */ | |
2159 /***************************************/ | |
2160 | |
2161 /* | |
2162 * FUNCTION: fd_msg_bufferize | |
2163 * | |
2164 * PARAMETERS: | |
2165 * msg : A valid msg object. All AVPs must have a value set. | |
2166 * buffer : Upon success, this points to a buffer (malloc'd) containing the message ready for network transmission (or security transformations). | |
2167 * The buffer may be freed after use. | |
2168 * len : if not NULL, the size of the buffer is written here. In any case, this size is updated in the msg header. | |
2169 * | |
2170 * DESCRIPTION: | |
2171 * Renders a message in memory as a buffer that can be sent over the network to the next peer. | |
2172 * | |
2173 * RETURN VALUE: | |
2174 * 0 : The location has been written. | |
2175 * EINVAL : The buffer does not contain a valid Diameter message. | |
2176 * ENOMEM : Unable to allocate enough memory to create the buffer object. | |
2177 */ | |
2178 int fd_msg_bufferize ( struct msg * msg, unsigned char ** buffer, size_t * len ); | |
2179 | |
2180 /* | |
2181 * FUNCTION: fd_msg_parse_buffer | |
2182 * | |
2183 * PARAMETERS: | |
2184 * buffer : Pointer to a buffer containing a message received from the network. | |
2185 * buflen : the size in bytes of the buffer. | |
2186 * msg : Upon success, this points to a valid msg object. No AVP value is resolved in this object, nor grouped AVP. | |
2187 * | |
2188 * DESCRIPTION: | |
2189 * This function parses a buffer an creates a msg object to represent the structure of the message. | |
2190 * Since no dictionary lookup is performed, the values of the AVPs are not interpreted. To interpret the values, | |
2191 * the returned message object must be passed to fd_msg_parse_dict function. | |
2192 * The buffer pointer is saved inside the message and will be freed when not needed anymore. | |
2193 * | |
2194 * RETURN VALUE: | |
2195 * 0 : The location has been written. | |
2196 * ENOMEM : Unable to allocate enough memory to create the msg object. | |
2197 * EBADMSG : The buffer does not contain a valid Diameter message (or is truncated). | |
2198 * EINVAL : A parameter is invalid. | |
2199 */ | |
2200 int fd_msg_parse_buffer ( unsigned char ** buffer, size_t buflen, struct msg ** msg ); | |
2201 | |
114
5b3868944e2b
Reporting errors in parse_dict function
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
112
diff
changeset
|
2202 /* Parsing Error Information structure */ |
5b3868944e2b
Reporting errors in parse_dict function
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
112
diff
changeset
|
2203 struct fd_pei { |
5b3868944e2b
Reporting errors in parse_dict function
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
112
diff
changeset
|
2204 char * pei_errcode; /* name of the error code to use */ |
5b3868944e2b
Reporting errors in parse_dict function
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
112
diff
changeset
|
2205 struct avp * pei_avp; /* pointer to invalid or missing AVP (to be freed) */ |
5b3868944e2b
Reporting errors in parse_dict function
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
112
diff
changeset
|
2206 char * pei_message; /* Overwrite default message if needed */ |
5b3868944e2b
Reporting errors in parse_dict function
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
112
diff
changeset
|
2207 int pei_protoerr; /* do we set the 'E' bit in the error message ? */ |
5b3868944e2b
Reporting errors in parse_dict function
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
112
diff
changeset
|
2208 }; |
5b3868944e2b
Reporting errors in parse_dict function
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
112
diff
changeset
|
2209 |
0 | 2210 /* |
2211 * FUNCTION: fd_msg_parse_dict | |
2212 * | |
2213 * PARAMETERS: | |
2214 * object : A msg or AVP object as returned by fd_msg_parse_buffer. | |
2215 * dict : the dictionary containing the objects definitions to use for resolving all AVPs. | |
114
5b3868944e2b
Reporting errors in parse_dict function
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
112
diff
changeset
|
2216 * error_info : If not NULL, will contain the detail about error upon return. May be used to generate an error reply. |
0 | 2217 * |
2218 * DESCRIPTION: | |
2219 * This function looks up for the command and each children AVP definitions in the dictionary. | |
2220 * If the dictionary definition is found, avp_model is set and the value of the AVP is interpreted accordingly and: | |
2221 * - for grouped AVPs, the children AVP are created and interpreted also. | |
2222 * - for numerical AVPs, the value is converted to host byte order and saved in the avp_value field. | |
2223 * - for octetstring AVPs, the string is copied into a new buffer and its address is saved in avp_value. | |
2224 * If the dictionary definition is not found, avp_model is set to NULL and | |
2225 * the content of the AVP is saved as an octetstring in an internal structure. avp_value is NULL. | |
2226 * As a result, after this function has been called, there is no more dependency of the msg object to the message buffer, that is be freed. | |
2227 * | |
2228 * RETURN VALUE: | |
2229 * 0 : The message has been fully parsed as described. | |
2230 * EINVAL : The msg parameter is invalid for this operation. | |
2231 * ENOMEM : Unable to allocate enough memory to complete the operation. | |
2232 * ENOTSUP : No dictionary definition for the command or one of the mandatory AVP was found. | |
2233 */ | |
114
5b3868944e2b
Reporting errors in parse_dict function
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
112
diff
changeset
|
2234 int fd_msg_parse_dict ( msg_or_avp * object, struct dictionary * dict, struct fd_pei *error_info ); |
34
0e2b57789361
Backup for the WE, some warnings remaining
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
33
diff
changeset
|
2235 |
0 | 2236 /* |
2237 * FUNCTION: fd_msg_parse_rules | |
2238 * | |
2239 * PARAMETERS: | |
2240 * object : A msg or grouped avp object that must be verified. | |
2241 * dict : The dictionary containing the rules definitions. | |
34
0e2b57789361
Backup for the WE, some warnings remaining
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
33
diff
changeset
|
2242 * error_info : If not NULL, the first problem information will be saved here. |
0 | 2243 * |
2244 * DESCRIPTION: | |
2245 * Check that the children of the object do not conflict with the dictionary rules (ABNF compliance). | |
2246 * | |
2247 * RETURN VALUE: | |
2248 * 0 : The message has been fully parsed and complies to the defined rules. | |
2249 * EBADMSG : A conflict was detected, or a mandatory AVP is unknown in the dictionary. | |
2250 * EINVAL : The msg or avp object is invalid for this operation. | |
2251 * ENOMEM : Unable to allocate enough memory to complete the operation. | |
2252 */ | |
34
0e2b57789361
Backup for the WE, some warnings remaining
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
33
diff
changeset
|
2253 int fd_msg_parse_rules ( msg_or_avp * object, struct dictionary * dict, struct fd_pei *error_info); |
0e2b57789361
Backup for the WE, some warnings remaining
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
33
diff
changeset
|
2254 |
0 | 2255 |
2256 | |
2257 /* | |
2258 * FUNCTION: fd_msg_update_length | |
2259 * | |
2260 * PARAMETERS: | |
2261 * object : Pointer to a valid msg or avp. | |
2262 * | |
2263 * DESCRIPTION: | |
2264 * Update the length field of the object passed as parameter. | |
2265 * As a side effect, all children objects are also updated. Therefore, all avp_value fields of | |
2266 * the children AVPs must be set, or an error will occur. | |
2267 * | |
2268 * RETURN VALUE: | |
2269 * 0 : The size has been recomputed. | |
2270 * EINVAL : A parameter is invalid. | |
2271 */ | |
2272 int fd_msg_update_length ( msg_or_avp * object ); | |
2273 | |
2274 | |
7
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2275 /*============================================================*/ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2276 /* DISPATCH */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2277 /*============================================================*/ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2278 |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2279 /* Dispatch module (passing incoming messages to extensions registered callbacks) |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2280 * is split between the library and the daemon. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2281 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2282 * The library provides the support for associating dispatch callbacks with |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2283 * dictionary objects. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2284 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2285 * The daemon is responsible for calling the callbacks for a message when appropriate. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2286 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2287 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2288 * The dispatch module has two main roles: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2289 * - help determine if a message can be handled locally (during the routing step) |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2290 * This decision involves only the application-id of the message. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2291 * - pass the message to the callback(s) that will handle it (during the dispatch step) |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2292 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2293 * The first role is handled by the daemon. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2294 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2295 * About the second, these are the possibilities for registering a dispatch callback: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2296 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2297 * -> For All messages. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2298 * This callback is called for all messages that are handled locally. This should be used only |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2299 * for debug purpose. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2300 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2301 * -> by AVP value (constants only). |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2302 * This callback will be called when a message is received and contains an AVP with a specified enumerated value. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2303 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2304 * -> by AVP. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2305 * This callback will be called when the received message contains a certain AVP. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2306 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2307 * -> by command-code. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2308 * This callback will be called when the message is a specific command (and 'R' flag). |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2309 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2310 * -> by application. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2311 * This callback will be called when the message has a specific application-id. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2312 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2313 * ( by vendor: would this be useful? it may be added later) |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2314 */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2315 enum disp_how { |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2316 DISP_HOW_ANY = 1, /* Any message. This should be only used for debug. */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2317 DISP_HOW_APPID, /* Any message with the specified application-id */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2318 DISP_HOW_CC, /* Messages of the specified command-code (request or answer). App id may be specified. */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2319 DISP_HOW_AVP, /* Messages containing a specific AVP. Command-code and App id may be specified. */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2320 DISP_HOW_AVP_ENUMVAL /* Messages containing a specific AVP with a specific enumerated value. Command-code and App id may be specified. */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2321 }; |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2322 /* |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2323 * Several criteria may be selected at the same time, for example command-code AND application id. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2324 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2325 * If several callbacks are registered for the same object, they are called in the order they were registered. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2326 * The order in which the callbacks are called is: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2327 * DISP_HOW_ANY |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2328 * DISP_HOW_AVP_ENUMVAL & DISP_HOW_AVP |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2329 * DISP_HOW_CC |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2330 * DISP_HOW_APPID |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2331 */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2332 |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2333 /* When a callback is registered, a "when" argument is passed in addition to the disp_how value, |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2334 * to specify which values the criteria must match. */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2335 struct disp_when { |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2336 struct dict_object * app; |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2337 struct dict_object * command; |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2338 struct dict_object * avp; |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2339 struct dict_object * value; |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2340 }; |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2341 |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2342 /* Note that all the dictionary objects should really belong to the same dictionary! |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2343 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2344 * Here is the details on this "when" argument, depending on the disp_how value. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2345 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2346 * DISP_HOW_ANY. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2347 * In this case, "when" must be NULL. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2348 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2349 * DISP_HOW_APPID. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2350 * Only the "app_id" field must be set, other fields are ignored. It points to a dictionary object of type DICT_APPLICATION. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2351 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2352 * DISP_HOW_CC. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2353 * The "command" field must be defined and point to a dictionary object of type DICT_COMMAND. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2354 * The "app_id" may be also set. In the case it is set, it restricts the callback to be called only with this command-code and app id. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2355 * The other fields are ignored. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2356 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2357 * DISP_HOW_AVP. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2358 * The "avp" field of the structure must be set and point to a dictionary object of type DICT_AVP. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2359 * The "app_id" field may be set to restrict the messages matching to a specific app id. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2360 * The "command" field may also be set to a valid DICT_COMMAND object. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2361 * The content of the "value" field is ignored. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2362 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2363 * DISP_HOW_AVP_ENUMVAL. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2364 * All fields have the same constraints and meaning as in DISP_REG_AVP. In addition, the "value" field must be set |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2365 * and points to a valid DICT_ENUMVAL object. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2366 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2367 * Here is a sumary of the fields: ( M : must be set; m : may be set; 0 : ignored ) |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2368 * field: app_id command avp value |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2369 * APPID : M 0 0 0 |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2370 * CC : m M 0 0 |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2371 * AVP : m m M 0 |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2372 * ENUMVA: m m M M |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2373 */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2374 |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2375 enum disp_action { |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2376 DISP_ACT_CONT, /* The next handler should be called, unless *msg == NULL. */ |
90
2c9444152e4b
Added the dispatch thread code
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
88
diff
changeset
|
2377 DISP_ACT_SEND, /* The updated message must be sent. No further callback is called. */ |
2c9444152e4b
Added the dispatch thread code
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
88
diff
changeset
|
2378 DISP_ACT_ERROR /* An error must be created and sent as a reply -- not valid for callbacks, only for fd_msg_dispatch. */ |
7
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2379 }; |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2380 /* The callbacks that are registered have the following prototype: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2381 * int dispatch_callback( struct msg ** msg, struct avp * avp, struct session * session, enum disp_action * action ); |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2382 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2383 * CALLBACK: dispatch_callback |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2384 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2385 * PARAMETERS: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2386 * msg : the received message on function entry. may be updated to answer on return (see description) |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2387 * avp : for callbacks registered with DISP_HOW_AVP or DISP_HOW_AVP_ENUMVAL, direct link to the triggering AVP. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2388 * session : if the message contains a Session-Id AVP, the corresponding session object, NULL otherwise. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2389 * action : upon return, this tells the daemon what to do next. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2390 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2391 * DESCRIPTION: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2392 * Called when a received message matchs the condition for which the callback was registered. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2393 * This callback may do any kind of processing on the message, including: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2394 * - create an answer for a request. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2395 * - proxy a request or message, add / remove the Proxy-Info AVP, then forward the message. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2396 * - update a routing table or start a connection with a new peer, then forward the message. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2397 * - ... |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2398 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2399 * When *action == DISP_ACT_SEND on callback return, the msg pointed by *msg is passed to the routing module for sending. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2400 * When *action == DISP_ACT_CONT, the next registered callback is called. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2401 * When the last callback gives also DISP_ACT_CONT action value, a default handler is called. It's behavior is as follow: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2402 * - if the message is an answer, it is discarded. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2403 * - if the message is a request, it is passed again to the routing stack, and marked as non-local handling. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2404 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2405 * RETURN VALUE: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2406 * 0 : The callback executed successfully and updated *action appropriately. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2407 * !0 : standard errors. In case of error, the message is discarded. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2408 */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2409 |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2410 /* This structure represents a handler for a registered callback, allowing its de-registration */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2411 struct disp_hdl; |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2412 |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2413 /* |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2414 * FUNCTION: fd_disp_register |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2415 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2416 * PARAMETERS: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2417 * cb : The callback function to register (see dispatch_callback description above). |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2418 * how : How the callback must be registered. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2419 * when : Values that must match, depending on the how argument. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2420 * handle : On success, a handler to the registered callback is stored here if not NULL. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2421 * This handler can be used to unregister the cb. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2422 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2423 * DESCRIPTION: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2424 * Register a new callback to handle messages delivered locally. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2425 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2426 * RETURN VALUE: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2427 * 0 : The callback is registered. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2428 * EINVAL : A parameter is invalid. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2429 * ENOMEM : Not enough memory to complete the operation |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2430 */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2431 int fd_disp_register ( int (*cb)( struct msg **, struct avp *, struct session *, enum disp_action *), |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2432 enum disp_how how, struct disp_when * when, struct disp_hdl ** handle ); |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2433 |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2434 /* |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2435 * FUNCTION: fd_disp_unregister |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2436 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2437 * PARAMETERS: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2438 * handle : Location of the handle of the callback that must be unregistered. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2439 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2440 * DESCRIPTION: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2441 * Removes a callback previously registered by fd_disp_register. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2442 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2443 * RETURN VALUE: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2444 * 0 : The callback is unregistered. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2445 * EINVAL : A parameter is invalid. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2446 */ |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2447 int fd_disp_unregister ( struct disp_hdl ** handle ); |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2448 |
90
2c9444152e4b
Added the dispatch thread code
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
88
diff
changeset
|
2449 /* Destroy all handlers */ |
2c9444152e4b
Added the dispatch thread code
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
88
diff
changeset
|
2450 void fd_disp_unregister_all ( void ); |
2c9444152e4b
Added the dispatch thread code
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
88
diff
changeset
|
2451 |
7
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2452 /* |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2453 * FUNCTION: fd_msg_dispatch |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2454 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2455 * PARAMETERS: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2456 * msg : A msg object that have already been fd_msg_parse_dict. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2457 * session : The session corresponding to this object, if any. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2458 * action : Upon return, the action that must be taken on the message |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2459 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2460 * DESCRIPTION: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2461 * Call all handlers registered for a given message. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2462 * The session must have already been resolved on entry. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2463 * The msg pointed may be updated during this process. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2464 * Upon return, the action parameter points to what must be done next. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2465 * |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2466 * RETURN VALUE: |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2467 * 0 : Success. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2468 * EINVAL : A parameter is invalid. |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2469 * (other errors) |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2470 */ |
90
2c9444152e4b
Added the dispatch thread code
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
88
diff
changeset
|
2471 int fd_msg_dispatch ( struct msg ** msg, struct session * session, enum disp_action *action, const char ** error_code ); |
7
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2472 |
e5af94b04946
Added dispatch module and tests
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
6
diff
changeset
|
2473 |
0 | 2474 |
2475 /*============================================================*/ | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2476 /* QUEUES */ |
0 | 2477 /*============================================================*/ |
2478 | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2479 /* Management of FIFO queues of elements */ |
0 | 2480 |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2481 /* A queue is an opaque object */ |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2482 struct fifo; |
0 | 2483 |
2484 /* | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2485 * FUNCTION: fd_fifo_new |
0 | 2486 * |
2487 * PARAMETERS: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2488 * queue : Upon success, a pointer to the new queue is saved here. |
0 | 2489 * |
2490 * DESCRIPTION: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2491 * Create a new empty queue. |
0 | 2492 * |
2493 * RETURN VALUE : | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2494 * 0 : The queue has been initialized successfully. |
0 | 2495 * EINVAL : The parameter is invalid. |
2496 * ENOMEM : Not enough memory to complete the creation. | |
2497 */ | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2498 int fd_fifo_new ( struct fifo ** queue ); |
0 | 2499 |
2500 /* | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2501 * FUNCTION: fd_fifo_del |
0 | 2502 * |
2503 * PARAMETERS: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2504 * queue : Pointer to an empty queue to delete. |
0 | 2505 * |
2506 * DESCRIPTION: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2507 * Destroys a queue. This is only possible if no thread is waiting for an element, |
0 | 2508 * and the queue is empty. |
2509 * | |
2510 * RETURN VALUE: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2511 * 0 : The queue has been destroyed successfully. |
0 | 2512 * EINVAL : The parameter is invalid. |
2513 */ | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2514 int fd_fifo_del ( struct fifo ** queue ); |
0 | 2515 |
2516 /* | |
25
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2517 * FUNCTION: fd_fifo_move |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2518 * |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2519 * PARAMETERS: |
43
2db15632a63d
Added a large part of connection establishment logic, to test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
34
diff
changeset
|
2520 * old : Location of a FIFO that is to be emptied. |
25
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2521 * new : A FIFO that will receive the old data. |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2522 * loc_update : if non NULL, a place to store the pointer to new FIFO atomically with the move. |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2523 * |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2524 * DESCRIPTION: |
43
2db15632a63d
Added a large part of connection establishment logic, to test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
34
diff
changeset
|
2525 * Empties a queue and move its content to another one atomically. |
25
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2526 * |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2527 * RETURN VALUE: |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2528 * 0 : The queue has been destroyed successfully. |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2529 * EINVAL : A parameter is invalid. |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2530 */ |
43
2db15632a63d
Added a large part of connection establishment logic, to test
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
34
diff
changeset
|
2531 int fd_fifo_move ( struct fifo * old, struct fifo * new, struct fifo ** loc_update ); |
25
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2532 |
67ca08d5bc48
Completed connection context files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
24
diff
changeset
|
2533 /* |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2534 * FUNCTION: fd_fifo_length |
0 | 2535 * |
2536 * PARAMETERS: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2537 * queue : The queue from which to retrieve the number of elements. |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2538 * length : Upon success, the current number of elements in the queue is stored here. |
0 | 2539 * |
2540 * DESCRIPTION: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2541 * Retrieve the number of elements in a queue. |
0 | 2542 * |
2543 * RETURN VALUE: | |
2544 * 0 : The length of the queue has been written. | |
2545 * EINVAL : A parameter is invalid. | |
2546 */ | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2547 int fd_fifo_length ( struct fifo * queue, int * length ); |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2548 int fd_fifo_length_noerr ( struct fifo * queue ); /* no error checking version */ |
0 | 2549 |
2550 /* | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2551 * FUNCTION: fd_fifo_setthrhd |
0 | 2552 * |
2553 * PARAMETERS: | |
2554 * queue : The queue for which the thresholds are being set. | |
2555 * data : An opaque pointer that is passed to h_cb and l_cb callbacks. | |
2556 * high : The high-level threshold. If the number of elements in the queue increase to this value, h_cb is called. | |
2557 * h_cb : if not NULL, a callback to call when the queue lengh is bigger than "high". | |
2558 * low : The low-level threshold. Must be < high. | |
2559 * l_cb : If the number of elements decrease to low, this callback is called. | |
2560 * | |
2561 * DESCRIPTION: | |
2562 * This function allows to adjust the number of producer / consumer threads of a queue. | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2563 * If the consumer are slower than the producers, the number of elements in the queue increase. |
0 | 2564 * By setting a "high" value, we allow a callback to be called when this number is too high. |
2565 * The typical use would be to create an additional consumer thread in this callback. | |
2566 * If the queue continues to grow, the callback will be called again when the length is 2 * high, then 3*high, ... N * high | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2567 * (the callback itself should implement a limit on the number of consumers that can be created) |
0 | 2568 * When the queue starts to decrease, and the number of elements go under ((N - 1) * high + low, the l_cb callback is called |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2569 * and would typially stop one of the consumer threads. If the queue continues to reduce, l_cb is again called at (N-2)*high + low, |
0 | 2570 * and so on. |
2571 * | |
2572 * Since there is no destructor for the data pointer, if cleanup operations are required, they should be performed in | |
2573 * l_cb when the length of the queue is becoming < low. | |
2574 * | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2575 * Note that the callbacks are called synchronously, during fd_fifo_post or fd_fifo_get. Their operation should be quick. |
0 | 2576 * |
2577 * RETURN VALUE: | |
2578 * 0 : The thresholds have been set | |
2579 * EINVAL : A parameter is invalid. | |
2580 */ | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2581 int fd_fifo_setthrhd ( struct fifo * queue, void * data, uint16_t high, void (*h_cb)(struct fifo *, void **), uint16_t low, void (*l_cb)(struct fifo *, void **) ); |
0 | 2582 |
2583 /* | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2584 * FUNCTION: fd_fifo_post |
0 | 2585 * |
2586 * PARAMETERS: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2587 * queue : The queue in which the element must be posted. |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2588 * item : The element that is put in the queue. |
0 | 2589 * |
2590 * DESCRIPTION: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2591 * An element is added in a queue. Elements are retrieved from the queue in FIFO order |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2592 * with the fd_fifo_get, fd_fifo_tryget, or fd_fifo_timedget functions. |
0 | 2593 * |
2594 * RETURN VALUE: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2595 * 0 : The element is queued. |
0 | 2596 * EINVAL : A parameter is invalid. |
2597 * ENOMEM : Not enough memory to complete the operation. | |
2598 */ | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2599 int fd_fifo_post_int ( struct fifo * queue, void ** item ); |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2600 #define fd_fifo_post(queue, item) \ |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2601 fd_fifo_post_int((queue), (void *)(item)) |
0 | 2602 |
2603 /* | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2604 * FUNCTION: fd_fifo_get |
0 | 2605 * |
2606 * PARAMETERS: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2607 * queue : The queue from which the first element must be retrieved. |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2608 * item : On return, the first element of the queue is stored here. |
0 | 2609 * |
2610 * DESCRIPTION: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2611 * This function retrieves the first element from a queue. If the queue is empty, the function will block the |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2612 * thread until a new element is posted to the queue, or until the thread is canceled (in which case the |
0 | 2613 * function does not return). |
2614 * | |
2615 * RETURN VALUE: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2616 * 0 : A new element has been retrieved. |
0 | 2617 * EINVAL : A parameter is invalid. |
2618 */ | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2619 int fd_fifo_get_int ( struct fifo * queue, void ** item ); |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2620 #define fd_fifo_get(queue, item) \ |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2621 fd_fifo_get_int((queue), (void *)(item)) |
0 | 2622 |
2623 /* | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2624 * FUNCTION: fd_fifo_tryget |
0 | 2625 * |
2626 * PARAMETERS: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2627 * queue : The queue from which the element must be retrieved. |
124
cc42d8607114
Completed cleanups of queues when the daemon is stopping
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
114
diff
changeset
|
2628 * item : On return, the first element of the queue is stored here. |
0 | 2629 * |
2630 * DESCRIPTION: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2631 * This function is similar to fd_fifo_get, except that it will not block if |
0 | 2632 * the queue is empty, but return EWOULDBLOCK instead. |
2633 * | |
2634 * RETURN VALUE: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2635 * 0 : A new element has been retrieved. |
0 | 2636 * EINVAL : A parameter is invalid. |
2637 * EWOULDBLOCK : The queue was empty. | |
2638 */ | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2639 int fd_fifo_tryget_int ( struct fifo * queue, void ** item ); |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2640 #define fd_fifo_tryget(queue, item) \ |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2641 fd_fifo_tryget_int((queue), (void *)(item)) |
0 | 2642 |
2643 /* | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2644 * FUNCTION: fd_fifo_timedget |
0 | 2645 * |
2646 * PARAMETERS: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2647 * queue : The queue from which the element must be retrieved. |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2648 * item : On return, the element is stored here. |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2649 * abstime : the absolute time until which we allow waiting for an item. |
0 | 2650 * |
2651 * DESCRIPTION: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2652 * This function is similar to fd_fifo_get, except that it will block if the queue is empty |
0 | 2653 * only until the absolute time abstime (see pthread_cond_timedwait for + info). |
2654 * If the queue is still empty when the time expires, the function returns ETIMEDOUT | |
2655 * | |
2656 * RETURN VALUE: | |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2657 * 0 : A new item has been retrieved. |
0 | 2658 * EINVAL : A parameter is invalid. |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2659 * ETIMEDOUT : The time out has passed and no item has been received. |
0 | 2660 */ |
8
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2661 int fd_fifo_timedget_int ( struct fifo * queue, void ** item, const struct timespec *abstime ); |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2662 #define fd_fifo_timedget(queue, item, abstime) \ |
3e143f047f78
Backup for the week-end
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
7
diff
changeset
|
2663 fd_fifo_timedget_int((queue), (void *)(item), (abstime)) |
0 | 2664 |
10
c5c99c73c2bf
Added some extensions and functions in the daemon
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
8
diff
changeset
|
2665 /* Dump a fifo list and optionally its inner elements -- beware of deadlocks! */ |
c5c99c73c2bf
Added some extensions and functions in the daemon
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
8
diff
changeset
|
2666 void fd_fifo_dump(int level, char * name, struct fifo * queue, void (*dump_item)(int level, void * item)); |
c5c99c73c2bf
Added some extensions and functions in the daemon
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
8
diff
changeset
|
2667 |
0 | 2668 #endif /* _LIBFREEDIAMETER_H */ |