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