The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
request.h
Go to the documentation of this file.
1#pragma once
2/*
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
16 */
17
18/**
19 * $Id: dbf1d53798f0d73e01928c3b207004aeb0efc8ca $
20 *
21 * @file lib/server/request.h
22 * @brief The main request structure, and allocation functions.
23 *
24 * @copyright 1999-2018 The FreeRADIUS server project
25 */
26RCSIDH(request_h, "$Id: dbf1d53798f0d73e01928c3b207004aeb0efc8ca $")
27
28/*
29 * Forward declarations to avoid dependency loops
30 */
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35typedef struct fr_async_s fr_async_t;
36typedef struct request_s request_t;
37
38typedef struct fr_client_s fr_client_t;
39
40#ifdef __cplusplus
41}
42#endif
43
44#include <freeradius-devel/server/log.h>
45#include <freeradius-devel/server/rcode.h>
46#include <freeradius-devel/server/signal.h>
47#include <freeradius-devel/util/event.h>
48#include <freeradius-devel/util/heap.h>
49#include <freeradius-devel/util/packet.h>
50#include <freeradius-devel/util/dlist.h>
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
56#ifndef NDEBUG
57# define REQUEST_MAGIC (0xdeadbeef)
58#endif
59
60/*
61 * Stack pool +
62 * Stack Frames +
63 * packets +
64 * extra
65 */
66#define REQUEST_POOL_HEADERS ( \
67 1 + \
68 UNLANG_STACK_MAX + \
69 2 + \
70 10 \
71 )
72
73/*
74 * Stack memory +
75 * pair lists and root +
76 * packets +
77 * extra
78 */
79#define REQUEST_POOL_SIZE ( \
80 (UNLANG_FRAME_PRE_ALLOC * UNLANG_STACK_MAX) + \
81 (sizeof(fr_pair_t) * 5) + \
82 (sizeof(fr_packet_t) * 2) + \
83 128 \
84 )
85
86typedef enum {
87 REQUEST_ACTIVE = 1, //!< Request is active (running or runnable)
88 REQUEST_STOP_PROCESSING, //!< Request has been signalled to stop
89 REQUEST_DONE, //!< Request has completed
91#define REQUEST_MASTER_NUM_STATES (REQUEST_COUNTED + 1)
92
103
110
111/** Convenience macro for accessing the request list
112 *
113 * This should be used in the form `&request->request_pairs`
114 * to get a pointer to the head of the request list.
115 */
116#define request_pairs pair_list.request->children
117
118/** Talloc ctx for allocating request pairs under
119 */
120#define request_ctx pair_list.request
121
122/** Convenience macro for accessing the reply list
123 *
124 * This should be used in the form `&request->reply_pairs`
125 * to get a pointer to the head of the request list.
126 */
127#define reply_pairs pair_list.reply->children
128
129/** Talloc ctx for allocating reply pairs under
130 */
131#define reply_ctx pair_list.reply
132
133/** Convenience macro for accessing the control list
134 *
135 * This should be used in the form `&request->control_pairs`
136 * to get a pointer to the head of the request list.
137 */
138#define control_pairs pair_list.control->children
139
140/** Talloc ctx for allocating control pairs under
141 */
142#define control_ctx pair_list.control
143
144/** Convenience macro for accessing the state list
145 *
146 * This should be used in the form `&request->session_state_pairs`
147 * to get a pointer to the head of the request list.
148 */
149#define session_state_pairs pair_list.state->children
150
151/** Talloc ctx for allocating reply pairs under
152 */
153#define session_state_ctx pair_list.state
154
155/** Convenience macro for accessing the state list
156 *
157 * This should be used in the form `&request->local_pairs`
158 * to get a pointer to the head of the local list.
159 */
160#define local_pairs pair_list.local->children
161
162/** Talloc ctx for allocating local variagbles
163 */
164#define local_ctx pair_list.local
165
166/** Pair lists accessible from the request
167 *
168 */
169typedef struct {
170 fr_pair_t *request; //!< Pair containing the request list.
171 fr_pair_t *reply; //!< Pair containing the reply list.
172 fr_pair_t *control; //!< Pair containing the control list.
173 fr_pair_t *state; //!< Pair containing the state list.
174 fr_pair_t *local; //!< Pair containing local variables
176
177typedef enum {
178 REQUEST_TYPE_EXTERNAL = 0, //!< A request received on the wire.
179 REQUEST_TYPE_INTERNAL, //!< A request generated internally.
180 REQUEST_TYPE_DETACHED //!< A request that was generated internally, but is now detached
181 ///< (not associated with a parent request.)
183
184#define request_is_external(_x) ((_x)->type == REQUEST_TYPE_EXTERNAL)
185#define request_is_internal(_x) ((_x)->type == REQUEST_TYPE_INTERNAL)
186#define request_is_detached(_x) ((_x)->type == REQUEST_TYPE_DETACHED)
187#define request_is_detachable(_x) ((_x)->flags.detachable)
188#define request_is_dynamic_client(_x) ((_x)->flags.dynamic_client)
189#define request_set_dynamic_client(_x) ((_x)->flags.dynamic_client = true)
190
191struct request_s {
192#ifndef NDEBUG
193 uint32_t magic; //!< Magic number used to detect memory corruption,
194 //!< or request structs that have not been properly initialised.
195
196 uint64_t ins_count; //!< count of instructions we've ran
197 uint64_t ins_max; //!< max instruction to bail out at
198
199#endif
200 void *stack; //!< unlang interpreter stack.
201
202 request_type_t type; //!< What type of request this is.
203
204 request_t *parent; //!< Request that generated this request.
205
206 uint64_t number; //!< Monotonically increasing request number. Reset on server restart.
207 uint64_t child_number; //!< Monotonically increasing number for children of this request
208 char const *name; //!< for debug printing, as (%d) is no longer sufficient
209
210 uint64_t seq_start; //!< State sequence ID. Stable identifier for a sequence of requests
211 //!< and responses.
212 fr_dict_t const *proto_dict; //!< Dictionary of the protocol that this request belongs to.
213 fr_dict_t const *local_dict; //!< dictionary for local variables
214
215 fr_pair_t *pair_root; //!< Root attribute which contains the
216 ///< other list attributes as children.
217
218 /** Pair lists associated with the request
219 *
220 * @warning DO NOT allocate pairs directly beneath the root
221 * or in the ctx of the request.
222 * They MUST be allocated beneath their appropriate
223 * list attribute.
224 */
225 request_pair_lists_t pair_list; //!< Structure containing all pair lists.
226
227 fr_dlist_head_t data; //!< Request data.
228
229 /** Capabilities flags for this request
230 *
231 */
232 struct {
233 uint8_t detachable : 1; //!< This request may be detached from its parent..
234 uint8_t dynamic_client : 1; //!< this is a dynamic client request
236
237 /** Logging information
238 *
239 */
240 struct {
241 log_dst_t *dst; //!< First in a list of log destinations.
242
243 fr_log_lvl_t lvl; //!< Log messages with lvl >= to this should be logged.
244
245 rindent_t indent; //!< Indentation for log messages.
247
248 char const *component; //!< Section the request is in.
249 char const *module; //!< Module the request is currently being processed by.
250
251 fr_packet_t *packet; //!< Incoming request.
252 fr_packet_t *reply; //!< Outgoing response.
253
254 fr_client_t *client; //!< The client that originally sent us the request.
255
256 request_master_state_t master_state; //!< Set by the master thread to signal the child that's currently
257 //!< working with the request, to do something.
258 bool counted; //!< Set if the request has been counted in the stats.
259
260 rlm_rcode_t rcode; //!< Last rcode returned by a module
261
262 fr_rb_node_t dedup_node; //!< entry in the deduplication tree.
263
264 fr_timer_t *timeout; //!< Timer event for this request. This tracks when we need to
265 ///< forcefully terminate a request.
266
267 uint32_t options; //!< mainly for proxying EAP-MSCHAPv2.
268
269 fr_async_t *async; //!< for new async listeners
270
271 char const *alloc_file; //!< File the request was allocated in.
272
273 int alloc_line; //!< Line the request was allocated on.
274
275 fr_dlist_t listen_entry; //!< request's entry in the list for this listener / socket
276 fr_heap_index_t runnable; //!< entry in the heap of runnable packets
277
278}; /* request_t typedef */
279
280/** Optional arguments for initialising requests
281 *
282 */
283typedef struct {
284 fr_dict_t const *namespace; //!< The namespace this request implements.
285
286 request_t *parent; //!< If set, the request is a child request used to run
287 ///< policy sections and additional virtual servers.
288
289 request_pair_lists_t pair_list; //!< Alternative pair list heads.
290 ///< These allow a request to expose nested attributes as
291 ///< request or reply lists from the parent.
292
293 bool detachable; //!< Request should be detachable, i.e. able to run even
294 ///< if its parent exits.
296
297#ifdef WITH_VERIFY_PTR
298# define REQUEST_VERIFY(_x) request_verify(__FILE__, __LINE__, _x)
299#else
300/*
301 * Even if were building without WITH_VERIFY_PTR
302 * the pointer must not be NULL when these various macros are used
303 * so we can add some sneaky asserts.
304 */
305# define REQUEST_VERIFY(_x) fr_assert(_x)
306#endif
307
308#define RAD_REQUEST_LVL_NONE (0) //!< No debug messages should be printed.
309#define RAD_REQUEST_LVL_DEBUG (1)
310#define RAD_REQUEST_LVL_DEBUG2 (2)
311#define RAD_REQUEST_LVL_DEBUG3 (3)
312#define RAD_REQUEST_LVL_DEBUG4 (4)
313
314#define RAD_REQUEST_OPTION_CTX (1 << 1)
315#define RAD_REQUEST_OPTION_DETAIL (1 << 2)
316
317#define request_init(_ctx, _type, _args) \
318 _request_init(__FILE__, __LINE__, _ctx, _type, _args)
319
320int _request_init(char const *file, int line,
321 request_t *request, request_type_t type,
323
324int request_slab_deinit(request_t *request);
325
326/** Allocate a new external request outside of the request pool
327 *
328 * @param[in] _ctx Talloc ctx to allocate the request in.
329 * @param[in] _args Optional arguments that control how the request is initialised.
330 */
331#define request_local_alloc_external(_ctx, _args) \
332 _request_local_alloc(__FILE__, __LINE__, (_ctx), REQUEST_TYPE_EXTERNAL, (_args))
333
334/** Allocate a new internal request outside of the request pool
335 *
336 * @param[in] _ctx Talloc ctx to allocate the request in.
337 * @param[in] _args Optional arguments that control how the request is initialised.
338 */
339#define request_local_alloc_internal(_ctx, _args) \
340 _request_local_alloc(__FILE__, __LINE__, (_ctx), REQUEST_TYPE_INTERNAL, (_args))
341
342request_t *_request_local_alloc(char const *file, int line, TALLOC_CTX *ctx,
344
345fr_pair_t *request_state_replace(request_t *request, fr_pair_t *state) CC_HINT(nonnull(1));
346
347int request_detach(request_t *child);
348
349int request_global_init(void);
351
352void request_log_prepend(request_t *request, fr_log_t *log, fr_log_lvl_t lvl);
353
354#ifdef WITH_VERIFY_PTR
355void request_verify(char const *file, int line, request_t const *request); /* only for special debug builds */
356#endif
357
358#ifdef __cplusplus
359}
360#endif
int const char * file
Definition acutest.h:702
va_list args
Definition acutest.h:770
int const char int line
Definition acutest.h:702
void request_verify(UNUSED char const *file, UNUSED int line, UNUSED request_t *request)
#define RCSIDH(h, id)
Definition build.h:486
#define HIDDEN
Definition build.h:316
Head of a doubly linked list.
Definition dlist.h:51
Entry in a doubly linked list.
Definition dlist.h:41
unsigned int fr_heap_index_t
Definition heap.h:80
Minimal data structure to use the new code.
Definition listen.h:59
Describes a host allowed to send packets to the server.
Definition client.h:80
Definition log.h:70
fr_log_lvl_t
Definition log.h:67
unsigned int uint32_t
unsigned char uint8_t
rlm_rcode_t
Return codes indicating the result of the module call.
Definition rcode.h:40
struct request_s::@68 log
Logging information.
request_type_t type
What type of request this is.
Definition request.h:202
fr_dict_attr_t const * request_attr_request
Definition request.c:43
struct request_s::@67 flags
Capabilities flags for this request.
bool counted
Set if the request has been counted in the stats.
Definition request.h:258
fr_rb_node_t dedup_node
entry in the deduplication tree.
Definition request.h:262
uint64_t child_number
Monotonically increasing number for children of this request.
Definition request.h:207
fr_dict_t const * proto_dict
Dictionary of the protocol that this request belongs to.
Definition request.h:212
fr_pair_t * local
Pair containing local variables.
Definition request.h:174
int request_slab_deinit(request_t *request)
Callback for slabs to deinitialise the request.
Definition request.c:378
bool detachable
Request should be detachable, i.e.
Definition request.h:293
HIDDEN fr_dict_attr_t const * request_attr_root
Definition request.c:42
fr_pair_t * pair_root
Root attribute which contains the other list attributes as children.
Definition request.h:215
request_pair_lists_t pair_list
Alternative pair list heads.
Definition request.h:289
request_t * _request_local_alloc(char const *file, int line, TALLOC_CTX *ctx, request_type_t type, request_init_args_t const *args)
Allocate a request that's not in the free list.
Definition request.c:477
fr_packet_t * reply
Outgoing response.
Definition request.h:252
void request_log_prepend(request_t *request, fr_log_t *log, fr_log_lvl_t lvl)
Prepend another logging destination to the list.
Definition request.c:92
uint64_t seq_start
State sequence ID.
Definition request.h:210
fr_client_t * client
The client that originally sent us the request.
Definition request.h:254
fr_dict_attr_t const * request_attr_control
Definition request.c:45
int alloc_line
Line the request was allocated on.
Definition request.h:273
fr_dict_t const * local_dict
dictionary for local variables
Definition request.h:213
char const * alloc_file
File the request was allocated in.
Definition request.h:271
request_type_t
Definition request.h:177
@ REQUEST_TYPE_EXTERNAL
A request received on the wire.
Definition request.h:178
@ REQUEST_TYPE_INTERNAL
A request generated internally.
Definition request.h:179
@ REQUEST_TYPE_DETACHED
A request that was generated internally, but is now detached (not associated with a parent request....
Definition request.h:180
fr_dict_attr_t const * request_attr_local
Definition request.c:47
fr_dict_attr_t const * request_attr_state
Definition request.c:46
fr_dict_attr_t const * request_attr_reply
Definition request.c:44
char const *fr_packet_t * packet
< Module the request is currently being processed by.
Definition request.h:251
uint64_t ins_max
max instruction to bail out at
Definition request.h:197
fr_heap_index_t runnable
entry in the heap of runnable packets
Definition request.h:276
uint32_t options
mainly for proxying EAP-MSCHAPv2.
Definition request.h:267
void request_global_free(void)
int request_global_init(void)
Definition request.c:589
int request_detach(request_t *child)
Unlink a subrequest from its parent.
Definition request.c:535
void * stack
unlang interpreter stack.
Definition request.h:200
fr_pair_t * request
Pair containing the request list.
Definition request.h:170
request_pair_lists_t pair_list
Pair lists associated with the request.
Definition request.h:225
request_t * parent
Request that generated this request.
Definition request.h:204
rlm_rcode_t rcode
Last rcode returned by a module.
Definition request.h:260
fr_dlist_t listen_entry
request's entry in the list for this listener / socket
Definition request.h:275
fr_pair_t * request_state_replace(request_t *request, fr_pair_t *state))
Replace the session_state_ctx with a new one.
Definition request.c:504
request_state_t
Definition request.h:93
@ REQUEST_INIT
Definition request.h:94
@ REQUEST_SEND
Definition request.h:97
@ REQUEST_OTHER_1
Definition request.h:98
@ REQUEST_RECV
Definition request.h:95
@ REQUEST_OTHER_3
Definition request.h:100
@ REQUEST_OTHER_4
Definition request.h:101
@ REQUEST_OTHER_2
Definition request.h:99
@ REQUEST_PROCESS
Definition request.h:96
uint64_t number
Monotonically increasing request number. Reset on server restart.
Definition request.h:206
int _request_init(char const *file, int line, request_t *request, request_type_t type, request_init_args_t const *args)
Setup logging and other fields for a request.
Definition request.c:237
request_t * parent
< The namespace this request implements.
Definition request.h:284
request_master_state_t master_state
Set by the master thread to signal the child that's currently working with the request,...
Definition request.h:256
fr_timer_t * timeout
Timer event for this request.
Definition request.h:264
uint64_t ins_count
count of instructions we've ran
Definition request.h:196
char const * component
Section the request is in.
Definition request.h:248
fr_async_t * async
for new async listeners
Definition request.h:269
fr_pair_t * reply
Pair containing the reply list.
Definition request.h:171
char const * name
for debug printing, as (d) is no longer sufficient
Definition request.h:208
fr_pair_t * state
Pair containing the state list.
Definition request.h:173
fr_dlist_head_t data
Request data.
Definition request.h:227
request_master_state_t
Definition request.h:86
@ REQUEST_ACTIVE
Request is active (running or runnable)
Definition request.h:87
@ REQUEST_DONE
Request has completed.
Definition request.h:89
@ REQUEST_STOP_PROCESSING
Request has been signalled to stop.
Definition request.h:88
uint32_t magic
Magic number used to detect memory corruption, or request structs that have not been properly initial...
Definition request.h:193
fr_pair_t * control
Pair containing the control list.
Definition request.h:172
Optional arguments for initialising requests.
Definition request.h:283
Pair lists accessible from the request.
Definition request.h:169
fr_aka_sim_id_type_t type
Definition log.h:96
Stores an attribute, a value and various bits of other data.
Definition pair.h:68
A timer event.
Definition timer.c:75
int nonnull(2, 5))