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