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