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