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