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