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