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