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