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