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