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