The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
trunk.c
Go to the documentation of this file.
1/*
2 * This program is is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or (at
5 * your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
15 */
16
17/**
18 * $Id: b88a8b88d94d4e9f212bb2fd5a16001669cc52f9 $
19 *
20 * @file src/lib/server/trunk.c
21 * @brief A management API for bonding multiple connections together.
22 *
23 * @copyright 2019-2020 Arran Cudbard-Bell (a.cudbardb@freeradius.org)
24 * @copyright 2019-2020 The FreeRADIUS server project
25 */
26
27#define LOG_PREFIX trunk->log_prefix
28
29#ifdef NDEBUG
30# define TALLOC_GET_TYPE_ABORT_NOOP 1
31#endif
32
33typedef struct trunk_request_s trunk_request_t;
34typedef struct trunk_connection_s trunk_connection_t;
35typedef struct trunk_s trunk_t;
36#define _TRUNK_PRIVATE 1
37#include <freeradius-devel/server/trunk.h>
38
39#include <freeradius-devel/server/trigger.h>
40#include <freeradius-devel/util/debug.h>
41#include <freeradius-devel/util/misc.h>
42#include <freeradius-devel/util/syserror.h>
43#include <freeradius-devel/util/minmax_heap.h>
44
45#ifdef HAVE_STDATOMIC_H
46# include <stdatomic.h>
47# ifndef ATOMIC_VAR_INIT
48# define ATOMIC_VAR_INIT(_x) (_x)
49# endif
50#else
51# include <freeradius-devel/util/stdatomic.h>
52#endif
53
54static atomic_uint_fast64_t request_counter = ATOMIC_VAR_INIT(1);
55
56#ifdef TESTING_TRUNK
57static fr_time_t test_time_base = fr_time_wrap(1);
58
59static fr_time_t test_time(void)
60{
61 return test_time_base;
62}
63
64#define fr_time test_time
65#endif
66
67#ifndef NDEBUG
68/** The maximum number of state logs to record per request
69 *
70 */
71#define TRUNK_REQUEST_STATE_LOG_MAX 20
72
73/** Trace state machine changes for a particular request
74 *
75 */
76typedef struct {
77 fr_dlist_head_t *log_head; //!< To allow the log entry to remove itself on free.
78 fr_dlist_t entry; //!< Entry in the linked list.
79 trunk_request_state_t from; //!< What state we transitioned from.
80 trunk_request_state_t to; //!< What state we transitioned to.
81
82 trunk_connection_t *tconn; //!< The request was associated with.
83 ///< Pointer may now be invalid, do no de-reference.
84
85 uint64_t tconn_id; //!< If the treq was associated with a connection
86 ///< the connection ID.
87 trunk_connection_state_t tconn_state; //!< If the treq was associated with a connection
88 ///< the connection state at the time of the
89 ///< state transition.
90
91 char const *function; //!< State change occurred in.
92 int line; //!< Line change occurred on.
93} trunk_request_state_log_t;
94#endif
95
96/** Wraps a normal request
97 *
98 */
99struct trunk_request_s {
100 struct trunk_request_pub_s pub; //!< Public fields in the trunk request.
101 ///< This *MUST* be the first field in this
102 ///< structure.
103
104 uint64_t id; //!< Trunk request ID.
105
106 fr_heap_index_t heap_id; //!< Used to track the request conn->pending heap.
107
108 fr_dlist_t entry; //!< Used to track the trunk request in the conn->sent
109 ///< or trunk->backlog request.
110
111 trunk_cancel_reason_t cancel_reason; //!< Why this request was cancelled.
112
113 fr_time_t last_freed; //!< Last time this request was freed.
114
115 bool bound_to_conn; //!< Fail the request if there's an attempt to
116 ///< re-enqueue it.
117
118 bool sent; //!< Trunk request has been sent at least once.
119 ///< Used so that re-queueing doesn't increase trunk
120 ///< `sent` count.
121
122#ifndef NDEBUG
123 fr_dlist_head_t log; //!< State change log.
124#endif
125};
126
127
128/** Associates request queues with a connection
129 *
130 * @dotfile src/lib/server/trunk_conn.gv "Trunk connection state machine"
131 * @dotfile src/lib/server/trunk_req.gv "Trunk request state machine"
132 */
133struct trunk_connection_s {
134 struct trunk_connection_pub_s pub; //!< Public fields in the trunk connection.
135 ///< This *MUST* be the first field in this
136 ///< structure.
137
138 fr_heap_index_t heap_id; //!< Used to track the connection in the connected
139 ///< heap.
140
141 fr_dlist_t entry; //!< Used to track the connection in the connecting,
142 ///< full and failed lists.
143
144 /** @name State
145 * @{
146 */
147 trunk_connection_event_t events; //!< The current events we expect to be notified on.
148 /** @} */
149
150 /** @name Request lists
151 * @{
152 */
153 fr_heap_t *pending; //!< Requests waiting to be sent.
154
155 trunk_request_t *partial; //!< Partially written request.
156
157 fr_dlist_head_t sent; //!< Sent request.
158
159 fr_dlist_head_t reapable; //!< Idle request.
160
161 fr_dlist_head_t cancel; //!< Requests in the cancel state.
162
163 trunk_request_t *cancel_partial; //!< Partially written cancellation request.
164
165 fr_dlist_head_t cancel_sent; //!< Sent cancellation request.
166 /** @} */
167
168 /** @name Statistics
169 * @{
170 */
171 uint64_t sent_count; //!< The number of requests that have been sent using
172 ///< this connection.
173 /** @} */
174
175 /** @name Timers
176 * @{
177 */
178 fr_timer_t *lifetime_ev; //!< Maximum time this connection can be open.
179 /** @} */
180};
181
182/** An entry in a trunk watch function list
183 *
184 */
185typedef struct trunk_watch_entry_s {
186 fr_dlist_t entry; //!< List entry.
187 trunk_watch_t func; //!< Function to call when a trunk enters
188 ///< the state this list belongs to
189 bool oneshot; //!< Remove the function after it's called once.
190 bool enabled; //!< Whether the watch entry is enabled.
191 void *uctx; //!< User data to pass to the function.
192} trunk_watch_entry_t;
193
194/** Map connection states to trigger names
195 *
196 * Must stay in the same order as #trunk_connection_state_t
197 */
198static fr_table_num_indexed_bit_pos_t const trunk_conn_trigger_names[] = {
199 { L("pool.connection_halted"), TRUNK_CONN_HALTED }, /* 0x0000 - bit 0 */
200 { L("pool.connection_init"), TRUNK_CONN_INIT }, /* 0x0001 - bit 1 */
201 { L("pool.connection_connecting"), TRUNK_CONN_CONNECTING }, /* 0x0002 - bit 2 */
202 { L("pool.connection_active"), TRUNK_CONN_ACTIVE }, /* 0x0004 - bit 3 */
203 { L("pool.connection_closed"), TRUNK_CONN_CLOSED }, /* 0x0008 - bit 4 */
204 { L("pool.connection_full"), TRUNK_CONN_FULL }, /* 0x0010 - bit 5 */
205 { L("pool.connection_inactive"), TRUNK_CONN_INACTIVE }, /* 0x0020 - bit 6 */
206 { L("pool.connection_inactive_draining"), TRUNK_CONN_INACTIVE_DRAINING }, /* 0x0040 - bit 7 */
207 { L("pool.connection_draining"), TRUNK_CONN_DRAINING }, /* 0x0080 - bit 8 */
208 { L("pool.connection_draining_to_free"), TRUNK_CONN_DRAINING_TO_FREE } /* 0x0100 - bit 9 */
209};
210static size_t trunk_conn_trigger_names_len = NUM_ELEMENTS(trunk_conn_trigger_names);
211
212/** Main trunk management handle
213 *
214 */
215struct trunk_s {
216 struct trunk_pub_s pub; //!< Public fields in the trunk connection.
217 ///< This *MUST* be the first field in this
218 ///< structure.
219
220 char const *log_prefix; //!< What to prepend to messages.
221
222 fr_event_list_t *el; //!< Event list used by this trunk and the connection.
223
224 trunk_conf_t conf; //!< Trunk common configuration.
225
226 fr_dlist_head_t free_requests; //!< Requests in the unassigned state. Waiting to be
227 ///< enqueued.
228
229 fr_heap_t *backlog; //!< The request backlog. Requests we couldn't
230 ///< immediately assign to a connection.
231
232 /** @name Connection lists
233 *
234 * A connection must always be in exactly one of these lists
235 * or trees.
236 *
237 * @{
238 */
239 fr_dlist_head_t init; //!< Connections which have not yet started
240 ///< connecting.
241
242 fr_dlist_head_t connecting; //!< Connections which are not yet in the open state.
243
244 fr_minmax_heap_t *active; //!< Connections which can service requests.
245
246 fr_dlist_head_t full; //!< Connections which have too many outstanding
247 ///< requests.
248
249 fr_dlist_head_t inactive; //!< Connections which have been signalled to be
250 ///< inactive by the API client.
251
252 fr_dlist_head_t inactive_draining; //!< Connections which have been signalled to be
253 ///< inactive by the API client, which the trunk
254 ///< manager is draining to close.
255
256 fr_dlist_head_t failed; //!< Connections that'll be reconnected shortly.
257
258 fr_dlist_head_t closed; //!< Connections that have closed. Either due to
259 ///< shutdown, reconnection or failure.
260
261 fr_dlist_head_t draining; //!< Connections that will be freed once all their
262 ///< requests are complete, but can be reactivated.
263
264 fr_dlist_head_t draining_to_free; //!< Connections that will be freed once all their
265 ///< requests are complete.
266
267 fr_dlist_head_t to_free; //!< Connections we're done with and will free on
268 //!< the next call to trunk_manage.
269 //!< This prevents connections from being freed
270 //!< whilst we're inside callbacks.
271 /** @} */
272
273 /** @name Callbacks
274 * @{
275 */
276 trunk_io_funcs_t funcs; //!< I/O functions.
277
278 void *in_handler; //!< Which handler we're inside.
279
280 void *uctx; //!< Uctx data to pass to alloc.
281
282 fr_dlist_head_t watch[TRUNK_STATE_MAX]; //!< To be called when trunk changes state.
283
284 trunk_watch_entry_t *next_watcher; //!< Watcher about to be run. Used to prevent nested watchers.
285 /** @} */
286
287 /** @name Timers
288 * @{
289 */
290 fr_timer_t *manage_ev; //!< Periodic connection management event.
291 /** @} */
292
293 /** @name Log rate limiting entries
294 * @{
295 */
296 fr_rate_limit_t limit_max_requests_alloc_log; //!< Rate limit on "Refusing to alloc requests - Limit of * requests reached"
297
298 fr_rate_limit_t limit_last_failure_log; //!< Rate limit on "Refusing to enqueue requests - No active conns"
299 /** @} */
300
301 /** @name State
302 * @{
303 */
304 bool freeing; //!< Trunk is being freed, don't spawn new
305 ///< connections or re-enqueue.
306
307 bool started; //!< Has the trunk been started.
308
309 bool managing_connections; //!< Whether the trunk is allowed to manage
310 ///< (open/close) connections.
311
312 uint64_t last_req_per_conn; //!< The last request to connection ratio we calculated.
313 /** @} */
314
315 fr_pair_list_t *trigger_args; //!< Passed to trigger
316
317 bool trigger_undef[NUM_ELEMENTS(trunk_conn_trigger_names)]; //!< Record that a specific trigger is undefined.
318
319 CONF_PAIR *trigger_cp[NUM_ELEMENTS(trunk_conn_trigger_names)]; //!< Cached trigger CONF_PAIRs
320};
321
322int trunk_trigger_cf_parse(TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, conf_parser_t const *rule);
323
324static conf_parser_t const trunk_config_request[] = {
325 { FR_CONF_OFFSET("per_connection_max", trunk_conf_t, max_req_per_conn), .dflt = "2000" },
326 { FR_CONF_OFFSET("per_connection_target", trunk_conf_t, target_req_per_conn), .dflt = "1000" },
327 { FR_CONF_OFFSET("free_delay", trunk_conf_t, req_cleanup_delay), .dflt = "10.0" },
328 { FR_CONF_OFFSET("triggers", trunk_conf_t, req_triggers), .func = trunk_trigger_cf_parse },
329
330 CONF_PARSER_TERMINATOR
331};
332
333static conf_parser_t const trunk_config_connection[] = {
334 { FR_CONF_OFFSET("connect_timeout", connection_conf_t, connection_timeout), .dflt = "3.0" },
335 { FR_CONF_OFFSET("reconnect_delay", connection_conf_t, reconnection_delay), .dflt = "1" },
336
337 CONF_PARSER_TERMINATOR
338};
339
340#ifndef TRUNK_TESTS
341conf_parser_t const trunk_config[] = {
342 { FR_CONF_OFFSET("start", trunk_conf_t, start), .dflt = "1" },
343 { FR_CONF_OFFSET("min", trunk_conf_t, min), .dflt = "1" },
344 { FR_CONF_OFFSET("max", trunk_conf_t, max), .dflt = "5" },
345 { FR_CONF_OFFSET("connecting", trunk_conf_t, connecting), .dflt = "2" },
346 { FR_CONF_OFFSET("uses", trunk_conf_t, max_uses), .dflt = "0" },
347 { FR_CONF_OFFSET("lifetime", trunk_conf_t, lifetime), .dflt = "0" },
348 { FR_CONF_OFFSET("idle_timeout", trunk_conf_t, idle_timeout), .dflt = "0" },
349
350 { FR_CONF_OFFSET("open_delay", trunk_conf_t, open_delay), .dflt = "0.2" },
351 { FR_CONF_OFFSET("close_delay", trunk_conf_t, close_delay), .dflt = "10.0" },
352
353 { FR_CONF_OFFSET("manage_interval", trunk_conf_t, manage_interval), .dflt = "0.2" },
354
355 { FR_CONF_OFFSET("max_backlog", trunk_conf_t, max_backlog), .dflt = "1000" },
356
357 { FR_CONF_OFFSET("backlog_on_failed_conn", trunk_conf_t, backlog_on_failed_conn), },
358
359 { FR_CONF_OFFSET("triggers", trunk_conf_t, conn_triggers), .func = trunk_trigger_cf_parse },
360
361 { FR_CONF_OFFSET_SUBSECTION("connection", 0, trunk_conf_t, conn_conf, trunk_config_connection), .subcs_size = sizeof(trunk_config_connection) },
362 { FR_CONF_POINTER("request", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) trunk_config_request },
363
364 CONF_PARSER_TERMINATOR
365};
366#endif
367
368#ifndef NDEBUG
369/** Map request states to trigger names
370 *
371 * Must stay in the same order as #trunk_connection_state_t
372 */
373static fr_table_num_indexed_bit_pos_t const trunk_req_trigger_names[] = {
374 { L("pool.request_init"), TRUNK_REQUEST_STATE_INIT }, /* 0x0000 - bit 0 */
375 { L("pool.request_unassigned"), TRUNK_REQUEST_STATE_UNASSIGNED }, /* 0x0001 - bit 1 */
376 { L("pool.request_backlog"), TRUNK_REQUEST_STATE_BACKLOG }, /* 0x0002 - bit 2 */
377 { L("pool.request_pending"), TRUNK_REQUEST_STATE_PENDING }, /* 0x0004 - bit 3 */
378 { L("pool.request_partial"), TRUNK_REQUEST_STATE_PARTIAL }, /* 0x0008 - bit 4 */
379 { L("pool.request_sent"), TRUNK_REQUEST_STATE_SENT }, /* 0x0010 - bit 5 */
380 { L("pool.request_state_reapable"), TRUNK_REQUEST_STATE_REAPABLE }, /* 0x0020 - bit 6 */
381 { L("pool.request_complete"), TRUNK_REQUEST_STATE_COMPLETE }, /* 0x0040 - bit 7 */
382 { L("pool.request_state_failed"), TRUNK_REQUEST_STATE_FAILED }, /* 0x0080 - bit 8 */
383 { L("pool.request_state_cancel"), TRUNK_REQUEST_STATE_CANCEL }, /* 0x0100 - bit 9 */
384 { L("pool.request_state_cancel_sent"), TRUNK_REQUEST_STATE_CANCEL_SENT }, /* 0x0200 - bit 10 */
385 { L("pool.request_state_cancel_partial"), TRUNK_REQUEST_STATE_CANCEL_PARTIAL }, /* 0x0400 - bit 11 */
386 { L("pool.request_state_cancel_complete"), TRUNK_REQUEST_STATE_CANCEL_COMPLETE }, /* 0x0800 - bit 12 */
387};
388static size_t trunk_req_trigger_names_len = NUM_ELEMENTS(trunk_req_trigger_names);
389#endif
390
391static fr_table_num_ordered_t const trunk_request_states[] = {
392 { L("INIT"), TRUNK_REQUEST_STATE_INIT },
393 { L("UNASSIGNED"), TRUNK_REQUEST_STATE_UNASSIGNED },
394 { L("BACKLOG"), TRUNK_REQUEST_STATE_BACKLOG },
395 { L("PENDING"), TRUNK_REQUEST_STATE_PENDING },
396 { L("PARTIAL"), TRUNK_REQUEST_STATE_PARTIAL },
397 { L("SENT"), TRUNK_REQUEST_STATE_SENT },
398 { L("REAPABLE"), TRUNK_REQUEST_STATE_REAPABLE },
399 { L("COMPLETE"), TRUNK_REQUEST_STATE_COMPLETE },
400 { L("FAILED"), TRUNK_REQUEST_STATE_FAILED },
401 { L("CANCEL"), TRUNK_REQUEST_STATE_CANCEL },
402 { L("CANCEL-SENT"), TRUNK_REQUEST_STATE_CANCEL_SENT },
403 { L("CANCEL-PARTIAL"), TRUNK_REQUEST_STATE_CANCEL_PARTIAL },
404 { L("CANCEL-COMPLETE"), TRUNK_REQUEST_STATE_CANCEL_COMPLETE }
405};
406static size_t trunk_request_states_len = NUM_ELEMENTS(trunk_request_states);
407
408static fr_table_num_ordered_t const trunk_states[] = {
409 { L("IDLE"), TRUNK_STATE_IDLE },
410 { L("ACTIVE"), TRUNK_STATE_ACTIVE },
411 { L("PENDING"), TRUNK_STATE_PENDING }
412};
413static size_t trunk_states_len = NUM_ELEMENTS(trunk_states);
414
415static fr_table_num_ordered_t const trunk_connection_states[] = {
416 { L("INIT"), TRUNK_CONN_INIT },
417 { L("HALTED"), TRUNK_CONN_HALTED },
418 { L("CONNECTING"), TRUNK_CONN_CONNECTING },
419 { L("ACTIVE"), TRUNK_CONN_ACTIVE },
420 { L("CLOSED"), TRUNK_CONN_CLOSED },
421 { L("FULL"), TRUNK_CONN_FULL },
422 { L("INACTIVE"), TRUNK_CONN_INACTIVE },
423 { L("INACTIVE-DRAINING"), TRUNK_CONN_INACTIVE_DRAINING },
424 { L("DRAINING"), TRUNK_CONN_DRAINING },
425 { L("DRAINING-TO-FREE"), TRUNK_CONN_DRAINING_TO_FREE }
426};
427static size_t trunk_connection_states_len = NUM_ELEMENTS(trunk_connection_states);
428
429static fr_table_num_ordered_t const trunk_cancellation_reasons[] = {
430 { L("TRUNK_CANCEL_REASON_NONE"), TRUNK_CANCEL_REASON_NONE },
431 { L("TRUNK_CANCEL_REASON_SIGNAL"), TRUNK_CANCEL_REASON_SIGNAL },
432 { L("TRUNK_CANCEL_REASON_MOVE"), TRUNK_CANCEL_REASON_MOVE },
433 { L("TRUNK_CANCEL_REASON_REQUEUE"), TRUNK_CANCEL_REASON_REQUEUE }
434};
435static size_t trunk_cancellation_reasons_len = NUM_ELEMENTS(trunk_cancellation_reasons);
436
437static fr_table_num_ordered_t const trunk_connection_events[] = {
438 { L("TRUNK_CONN_EVENT_NONE"), TRUNK_CONN_EVENT_NONE },
439 { L("TRUNK_CONN_EVENT_READ"), TRUNK_CONN_EVENT_READ },
440 { L("TRUNK_CONN_EVENT_WRITE"), TRUNK_CONN_EVENT_WRITE },
441 { L("TRUNK_CONN_EVENT_BOTH"), TRUNK_CONN_EVENT_BOTH },
442};
443static size_t trunk_connection_events_len = NUM_ELEMENTS(trunk_connection_events);
444
445#define CONN_TRIGGER(_state) do { \
446 uint8_t idx = fr_high_bit_pos(_state); \
447 if (trunk->conf.conn_triggers && !trunk->trigger_undef[idx]) { \
448 if (trigger(unlang_interpret_get_thread_default(), trunk->conf.conn_trigger_cs, \
449 &trunk->trigger_cp[idx], \
450 fr_table_str_by_value(trunk_conn_trigger_names, _state, \
451 "<INVALID>"), true, trunk->trigger_args) == -1) { \
452 trunk->trigger_undef[idx] = true; \
453 } \
454 } \
455} while (0)
456
457#define CONN_STATE_TRANSITION(_new, _log) \
458do { \
459 _log("[%" PRIu64 "] Trunk connection changed state %s -> %s", \
460 tconn->pub.conn->id, \
461 fr_table_str_by_value(trunk_connection_states, tconn->pub.state, "<INVALID>"), \
462 fr_table_str_by_value(trunk_connection_states, _new, "<INVALID>")); \
463 tconn->pub.state = _new; \
464 CONN_TRIGGER(_new); \
465 trunk_requests_per_connection(NULL, NULL, trunk, fr_time(), false); \
466} while (0)
467
468#define CONN_BAD_STATE_TRANSITION(_new) \
469do { \
470 if (!fr_cond_assert_msg(0, "[%" PRIu64 "] Trunk connection invalid transition %s -> %s", \
471 tconn->pub.conn->id, \
472 fr_table_str_by_value(trunk_connection_states, tconn->pub.state, "<INVALID>"), \
473 fr_table_str_by_value(trunk_connection_states, _new, "<INVALID>"))) return; \
474} while (0)
475
476#ifndef NDEBUG
477void trunk_request_state_log_entry_add(char const *function, int line,
478 trunk_request_t *treq, trunk_request_state_t new) CC_HINT(nonnull);
479
480#define REQUEST_TRIGGER(_state) do { \
481 if (trunk->conf.req_triggers) { \
482 trigger(unlang_interpret_get_thread_default(), \
483 trunk->conf.req_trigger_cs, NULL, fr_table_str_by_value(trunk_req_trigger_names, _state, \
484 "<INVALID>"), true, trunk->trigger_args); \
485 } \
486} while (0)
487
488/** Record a request state transition and log appropriate output
489 *
490 */
491#define REQUEST_STATE_TRANSITION(_new) \
492do { \
493 request_t *request = treq->pub.request; \
494 ROPTIONAL(RDEBUG3, DEBUG3, "Trunk request %" PRIu64 " changed state %s -> %s", \
495 treq->id, \
496 fr_table_str_by_value(trunk_request_states, treq->pub.state, "<INVALID>"), \
497 fr_table_str_by_value(trunk_request_states, _new, "<INVALID>")); \
498 trunk_request_state_log_entry_add(__FUNCTION__, __LINE__, treq, _new); \
499 treq->pub.state = _new; \
500 REQUEST_TRIGGER(_new); \
501} while (0)
502#define REQUEST_BAD_STATE_TRANSITION(_new) \
503do { \
504 trunk_request_state_log(&default_log, L_ERR, __FILE__, __LINE__, treq); \
505 if (!fr_cond_assert_msg(0, "Trunk request %" PRIu64 " invalid transition %s -> %s", \
506 treq->id, \
507 fr_table_str_by_value(trunk_request_states, treq->pub.state, "<INVALID>"), \
508 fr_table_str_by_value(trunk_request_states, _new, "<INVALID>"))) return; \
509} while (0)
510#else
511/** Record a request state transition
512 *
513 */
514#define REQUEST_STATE_TRANSITION(_new) \
515do { \
516 request_t *request = treq->pub.request; \
517 ROPTIONAL(RDEBUG3, DEBUG3, "Trunk request %" PRIu64 " changed state %s -> %s", \
518 treq->id, \
519 fr_table_str_by_value(trunk_request_states, treq->pub.state, "<INVALID>"), \
520 fr_table_str_by_value(trunk_request_states, _new, "<INVALID>")); \
521 treq->pub.state = _new; \
522} while (0)
523#define REQUEST_BAD_STATE_TRANSITION(_new) \
524do { \
525 if (!fr_cond_assert_msg(0, "Trunk request %" PRIu64 " invalid transition %s -> %s", \
526 treq->id, \
527 fr_table_str_by_value(trunk_request_states, treq->pub.state, "<INVALID>"), \
528 fr_table_str_by_value(trunk_request_states, _new, "<INVALID>"))) return; \
529} while (0)
530#endif
531
532
533/** Call the cancel callback if set
534 *
535 */
536#define DO_REQUEST_CANCEL(_treq, _reason) \
537do { \
538 if ((_treq)->pub.trunk->funcs.request_cancel) { \
539 request_t *request = (_treq)->pub.request; \
540 void *_prev = (_treq)->pub.trunk->in_handler; \
541 (_treq)->pub.trunk->in_handler = (void *)(_treq)->pub.trunk->funcs.request_cancel; \
542 ROPTIONAL(RDEBUG3, DEBUG3, "Calling request_cancel(conn=%p, preq=%p, reason=%s, uctx=%p)", \
543 (_treq)->pub.tconn->pub.conn, \
544 (_treq)->pub.preq, \
545 fr_table_str_by_value(trunk_cancellation_reasons, \
546 (_reason), \
547 "<INVALID>"), \
548 (_treq)->pub.trunk->uctx); \
549 (_treq)->pub.trunk->funcs.request_cancel((_treq)->pub.tconn->pub.conn, (_treq)->pub.preq, (_reason), (_treq)->pub.trunk->uctx); \
550 (_treq)->pub.trunk->in_handler = _prev; \
551 } \
552} while(0)
553
554/** Call the "conn_release" callback (if set)
555 *
556 */
557#define DO_REQUEST_CONN_RELEASE(_treq) \
558do { \
559 if ((_treq)->pub.trunk->funcs.request_conn_release) { \
560 request_t *request = (_treq)->pub.request; \
561 void *_prev = (_treq)->pub.trunk->in_handler; \
562 (_treq)->pub.trunk->in_handler = (void *)(_treq)->pub.trunk->funcs.request_conn_release; \
563 ROPTIONAL(RDEBUG3, DEBUG3, "Calling request_conn_release(conn=%p, preq=%p, uctx=%p)", \
564 (_treq)->pub.tconn->pub.conn, \
565 (_treq)->pub.preq, \
566 (_treq)->pub.trunk->uctx); \
567 (_treq)->pub.trunk->funcs.request_conn_release((_treq)->pub.tconn->pub.conn, (_treq)->pub.preq, (_treq)->pub.trunk->uctx); \
568 (_treq)->pub.trunk->in_handler = _prev; \
569 } \
570} while(0)
571
572/** Call the complete callback (if set)
573 *
574 */
575#define DO_REQUEST_COMPLETE(_treq) \
576do { \
577 if ((_treq)->pub.trunk->funcs.request_complete) { \
578 request_t *request = (_treq)->pub.request; \
579 void *_prev = (_treq)->pub.trunk->in_handler; \
580 ROPTIONAL(RDEBUG3, DEBUG3, "Calling request_complete(request=%p, preq=%p, rctx=%p, uctx=%p)", \
581 (_treq)->pub.request, \
582 (_treq)->pub.preq, \
583 (_treq)->pub.rctx, \
584 (_treq)->pub.trunk->uctx); \
585 (_treq)->pub.trunk->in_handler = (void *)(_treq)->pub.trunk->funcs.request_complete; \
586 (_treq)->pub.trunk->funcs.request_complete((_treq)->pub.request, (_treq)->pub.preq, (_treq)->pub.rctx, (_treq)->pub.trunk->uctx); \
587 (_treq)->pub.trunk->in_handler = _prev; \
588 } \
589} while(0)
590
591/** Call the fail callback (if set)
592 *
593 */
594#define DO_REQUEST_FAIL(_treq, _prev_state) \
595do { \
596 if ((_treq)->pub.trunk->funcs.request_fail) { \
597 request_t *request = (_treq)->pub.request; \
598 void *_prev = (_treq)->pub.trunk->in_handler; \
599 ROPTIONAL(RDEBUG3, DEBUG3, "Calling request_fail(request=%p, preq=%p, rctx=%p, state=%s uctx=%p)", \
600 (_treq)->pub.request, \
601 (_treq)->pub.preq, \
602 (_treq)->pub.rctx, \
603 fr_table_str_by_value(trunk_request_states, (_prev_state), "<INVALID>"), \
604 (_treq)->pub.trunk->uctx); \
605 (_treq)->pub.trunk->in_handler = (void *)(_treq)->pub.trunk->funcs.request_fail; \
606 (_treq)->pub.trunk->funcs.request_fail((_treq)->pub.request, (_treq)->pub.preq, (_treq)->pub.rctx, _prev_state, (_treq)->pub.trunk->uctx); \
607 (_treq)->pub.trunk->in_handler = _prev; \
608 } \
609} while(0)
610
611/** Call the free callback (if set)
612 *
613 */
614#define DO_REQUEST_FREE(_treq) \
615do { \
616 if ((_treq)->pub.trunk->funcs.request_free) { \
617 request_t *request = (_treq)->pub.request; \
618 void *_prev = (_treq)->pub.trunk->in_handler; \
619 ROPTIONAL(RDEBUG3, DEBUG3, "Calling request_free(request=%p, preq=%p, uctx=%p)", \
620 (_treq)->pub.request, \
621 (_treq)->pub.preq, \
622 (_treq)->pub.trunk->uctx); \
623 (_treq)->pub.trunk->in_handler = (void *)(_treq)->pub.trunk->funcs.request_free; \
624 (_treq)->pub.trunk->funcs.request_free((_treq)->pub.request, (_treq)->pub.preq, (_treq)->pub.trunk->uctx); \
625 (_treq)->pub.trunk->in_handler = _prev; \
626 } \
627} while(0)
628
629/** Write one or more requests to a connection
630 *
631 */
632#define DO_REQUEST_MUX(_tconn) \
633do { \
634 void *_prev = (_tconn)->pub.trunk->in_handler; \
635 DEBUG3("[%" PRIu64 "] Calling request_mux(el=%p, tconn=%p, conn=%p, uctx=%p)", \
636 (_tconn)->pub.conn->id, \
637 (_tconn)->pub.trunk->el, \
638 (_tconn), \
639 (_tconn)->pub.conn, \
640 (_tconn)->pub.trunk->uctx); \
641 (_tconn)->pub.trunk->in_handler = (void *)(_tconn)->pub.trunk->funcs.request_mux; \
642 (_tconn)->pub.trunk->funcs.request_mux((_tconn)->pub.trunk->el, (_tconn), (_tconn)->pub.conn, (_tconn)->pub.trunk->uctx); \
643 (_tconn)->pub.trunk->in_handler = _prev; \
644} while(0)
645
646/** Read one or more requests from a connection
647 *
648 */
649#define DO_REQUEST_DEMUX(_tconn) \
650do { \
651 void *_prev = (_tconn)->pub.trunk->in_handler; \
652 DEBUG3("[%" PRIu64 "] Calling request_demux(tconn=%p, conn=%p, uctx=%p)", \
653 (_tconn)->pub.conn->id, \
654 (_tconn), \
655 (_tconn)->pub.conn, \
656 (_tconn)->pub.trunk->uctx); \
657 (_tconn)->pub.trunk->in_handler = (void *)(_tconn)->pub.trunk->funcs.request_demux; \
658 (_tconn)->pub.trunk->funcs.request_demux((_tconn)->pub.trunk->el, (_tconn), (_tconn)->pub.conn, (_tconn)->pub.trunk->uctx); \
659 (_tconn)->pub.trunk->in_handler = _prev; \
660} while(0)
661
662/** Write one or more cancellation requests to a connection
663 *
664 */
665#define DO_REQUEST_CANCEL_MUX(_tconn) \
666do { \
667 if ((_tconn)->pub.trunk->funcs.request_cancel_mux) { \
668 void *_prev = (_tconn)->pub.trunk->in_handler; \
669 DEBUG3("[%" PRIu64 "] Calling request_cancel_mux(tconn=%p, conn=%p, uctx=%p)", \
670 (_tconn)->pub.conn->id, \
671 (_tconn), \
672 (_tconn)->pub.conn, \
673 (_tconn)->pub.trunk->uctx); \
674 (_tconn)->pub.trunk->in_handler = (void *)(_tconn)->pub.trunk->funcs.request_cancel_mux; \
675 (_tconn)->pub.trunk->funcs.request_cancel_mux((_tconn)->pub.trunk->el, (_tconn), (_tconn)->pub.conn, (_tconn)->pub.trunk->uctx); \
676 (_tconn)->pub.trunk->in_handler = _prev; \
677 } \
678} while(0)
679
680/** Allocate a new connection
681 *
682 */
683#define DO_CONNECTION_ALLOC(_tconn) \
684do { \
685 void *_prev = trunk->in_handler; \
686 DEBUG3("Calling connection_alloc(tconn=%p, el=%p, conf=%p, log_prefix=\"%s\", uctx=%p)", \
687 (_tconn), \
688 (_tconn)->pub.trunk->el, \
689 (_tconn)->pub.trunk->conf.conn_conf, \
690 trunk->log_prefix, \
691 (_tconn)->pub.trunk->uctx); \
692 (_tconn)->pub.trunk->in_handler = (void *) (_tconn)->pub.trunk->funcs.connection_alloc; \
693 (_tconn)->pub.conn = trunk->funcs.connection_alloc((_tconn), (_tconn)->pub.trunk->el, (_tconn)->pub.trunk->conf.conn_conf, (_tconn)->pub.trunk->log_prefix, trunk->uctx); \
694 (_tconn)->pub.trunk->in_handler = _prev; \
695 if (!(_tconn)->pub.conn) { \
696 ERROR("Failed creating new connection"); \
697 talloc_free(tconn); \
698 return -1; \
699 } \
700} while(0)
701
702/** Change what events the connection should be notified about
703 *
704 */
705#define DO_CONNECTION_NOTIFY(_tconn, _events) \
706do { \
707 if ((_tconn)->pub.trunk->funcs.connection_notify) { \
708 void *_prev = (_tconn)->pub.trunk->in_handler; \
709 DEBUG3("[%" PRIu64 "] Calling connection_notify(tconn=%p, conn=%p, el=%p, events=%s, uctx=%p)", \
710 (_tconn)->pub.conn->id, \
711 (_tconn), \
712 (_tconn)->pub.conn, \
713 (_tconn)->pub.trunk->el, \
714 fr_table_str_by_value(trunk_connection_events, (_events), "<INVALID>"), \
715 (_tconn)->pub.trunk->uctx); \
716 (_tconn)->pub.trunk->in_handler = (void *)(_tconn)->pub.trunk->funcs.connection_notify; \
717 (_tconn)->pub.trunk->funcs.connection_notify((_tconn), (_tconn)->pub.conn, (_tconn)->pub.trunk->el, (_events), (_tconn)->pub.trunk->uctx); \
718 (_tconn)->pub.trunk->in_handler = _prev; \
719 } \
720} while(0)
721
722#define IN_HANDLER(_trunk) (((_trunk)->in_handler) != NULL)
723#define IN_REQUEST_MUX(_trunk) (((_trunk)->funcs.request_mux) && ((_trunk)->in_handler == (void *)(_trunk)->funcs.request_mux))
724#define IN_REQUEST_DEMUX(_trunk) (((_trunk)->funcs.request_demux) && ((_trunk)->in_handler == (void *)(_trunk)->funcs.request_demux))
725#define IN_REQUEST_CANCEL_MUX(_trunk) (((_trunk)->funcs.request_cancel_mux) && ((_trunk)->in_handler == (void *)(_trunk)->funcs.request_cancel_mux))
726
727#define IS_SERVICEABLE(_tconn) ((_tconn)->pub.state & TRUNK_CONN_SERVICEABLE)
728#define IS_PROCESSING(_tconn) ((tconn)->pub.state & TRUNK_CONN_PROCESSING)
729
730/** Remove the current request from the backlog
731 *
732 */
733#define REQUEST_EXTRACT_BACKLOG(_treq) \
734do { \
735 int _ret; \
736 _ret = fr_heap_extract(&(_treq)->pub.trunk->backlog, _treq); \
737 if (!fr_cond_assert_msg(_ret == 0, "Failed extracting conn from backlog heap: %s", fr_strerror())) break; \
738} while (0)
739
740/** Remove the current request from the pending list
741 *
742 */
743#define REQUEST_EXTRACT_PENDING(_treq) \
744do { \
745 int _ret; \
746 _ret = fr_heap_extract(&(_treq)->pub.tconn->pending, _treq); \
747 if (!fr_cond_assert_msg(_ret == 0, "Failed extracting conn from pending heap: %s", fr_strerror())) break; \
748} while (0)
749
750/** Remove the current request from the partial slot
751 *
752 */
753#define REQUEST_EXTRACT_PARTIAL(_treq) \
754do { \
755 fr_assert((_treq)->pub.tconn->partial == treq); \
756 tconn->partial = NULL; \
757} while (0)
758
759/** Remove the current request from the sent list
760 *
761 */
762#define REQUEST_EXTRACT_SENT(_treq) fr_dlist_remove(&tconn->sent, treq)
763
764/** Remove the current request from the reapable list
765 *
766 */
767#define REQUEST_EXTRACT_REAPABLE(_treq) fr_dlist_remove(&tconn->reapable, treq)
768
769/** Remove the current request from the cancel list
770 *
771 */
772#define REQUEST_EXTRACT_CANCEL(_treq) fr_dlist_remove(&tconn->cancel, treq)
773
774/** Remove the current request from the cancel_partial slot
775 *
776 */
777#define REQUEST_EXTRACT_CANCEL_PARTIAL(_treq) \
778do { \
779 fr_assert((_treq)->pub.tconn->cancel_partial == treq); \
780 tconn->cancel_partial = NULL; \
781} while (0)
782
783/** Remove the current request from the cancel sent list
784 *
785 */
786#define REQUEST_EXTRACT_CANCEL_SENT(_treq) fr_dlist_remove(&tconn->cancel_sent, treq)
787
788/** Reorder the connections in the active heap
789 *
790 * fr_heap_extract will also error out if heap_id is bad - no need for assert
791 */
792#define CONN_REORDER(_tconn) \
793do { \
794 int _ret; \
795 if ((fr_minmax_heap_num_elements((_tconn)->pub.trunk->active) == 1)) break; \
796 if (!fr_cond_assert((_tconn)->pub.state == TRUNK_CONN_ACTIVE)) break; \
797 _ret = fr_minmax_heap_extract((_tconn)->pub.trunk->active, (_tconn)); \
798 if (!fr_cond_assert_msg(_ret == 0, "Failed extracting conn from active heap: %s", fr_strerror())) break; \
799 fr_minmax_heap_insert((_tconn)->pub.trunk->active, (_tconn)); \
800} while (0)
801
802/** Call a list of watch functions associated with a state
803 *
804 */
805static inline void trunk_watch_call(trunk_t *trunk, fr_dlist_head_t *list, trunk_state_t state)
806{
807 /*
808 * Nested watcher calls are not allowed
809 * and shouldn't be possible because of
810 * deferred signal processing.
811 */
812 fr_assert(trunk->next_watcher == NULL);
813
814 while ((trunk->next_watcher = fr_dlist_next(list, trunk->next_watcher))) {
815 trunk_watch_entry_t *entry = trunk->next_watcher;
816 bool oneshot = entry->oneshot; /* Watcher could be freed, so store now */
817
818 if (!entry->enabled) continue;
819 if (oneshot) trunk->next_watcher = fr_dlist_remove(list, entry);
820
821 entry->func(trunk, trunk->pub.state, state, entry->uctx);
822
823 if (oneshot) talloc_free(entry);
824 }
825 trunk->next_watcher = NULL;
826}
827
828/** Call the state change watch functions
829 *
830 */
831#define CALL_WATCHERS(_trunk, _state) \
832do { \
833 if (fr_dlist_empty(&(_trunk)->watch[_state])) break; \
834 trunk_watch_call((_trunk), &(_trunk)->watch[_state], _state); \
835} while(0)
836
837/** Remove a watch function from a trunk state list
838 *
839 * @param[in] trunk The trunk to remove the watcher from.
840 * @param[in] state to remove the watch from.
841 * @param[in] watch Function to remove.
842 * @return
843 * - 0 if the function was removed successfully.
844 * - -1 if the function wasn't present in the watch list.
845 * - -2 if an invalid state was passed.
846 */
847int trunk_del_watch(trunk_t *trunk, trunk_state_t state, trunk_watch_t watch)
848{
849 trunk_watch_entry_t *entry = NULL;
850 fr_dlist_head_t *list;
851
852 if (state >= TRUNK_STATE_MAX) return -2;
853
854 list = &trunk->watch[state];
855 while ((entry = fr_dlist_next(list, entry))) {
856 if (entry->func == watch) {
857 if (trunk->next_watcher == entry) {
858 trunk->next_watcher = fr_dlist_remove(list, entry);
859 } else {
860 fr_dlist_remove(list, entry);
861 }
862 talloc_free(entry);
863 return 0;
864 }
865 }
866
867 return -1;
868}
869
870/** Add a watch entry to the trunk state list
871 *
872 * @param[in] trunk The trunk to add the watcher to.
873 * @param[in] state to watch for.
874 * @param[in] watch Function to add.
875 * @param[in] oneshot Should this watcher only be run once.
876 * @param[in] uctx Context to pass to function.
877 * @return
878 * - NULL if an invalid state is passed.
879 * - A new watch entry handle on success.
880 */
881trunk_watch_entry_t *trunk_add_watch(trunk_t *trunk, trunk_state_t state,
882 trunk_watch_t watch, bool oneshot, void const *uctx)
883{
884 trunk_watch_entry_t *entry;
885 fr_dlist_head_t *list;
886
887 if (state >= TRUNK_STATE_MAX) return NULL;
888
889 list = &trunk->watch[state];
890 MEM(entry = talloc_zero(trunk, trunk_watch_entry_t));
891
892 entry->func = watch;
893 entry->oneshot = oneshot;
894 entry->enabled = true;
895 memcpy(&entry->uctx, &uctx, sizeof(entry->uctx));
896 fr_dlist_insert_tail(list, entry);
897
898 return entry;
899}
900
901#define TRUNK_STATE_TRANSITION(_new) \
902do { \
903 DEBUG3("Trunk changed state %s -> %s", \
904 fr_table_str_by_value(trunk_states, trunk->pub.state, "<INVALID>"), \
905 fr_table_str_by_value(trunk_states, _new, "<INVALID>")); \
906 CALL_WATCHERS(trunk, _new); \
907 trunk->pub.state = _new; \
908} while (0)
909
910static void trunk_request_enter_backlog(trunk_request_t *treq, bool new);
911static void trunk_request_enter_pending(trunk_request_t *treq, trunk_connection_t *tconn, bool new);
912static void trunk_request_enter_partial(trunk_request_t *treq);
913static void trunk_request_enter_sent(trunk_request_t *treq);
914static void trunk_request_enter_reapable(trunk_request_t *treq);
915static void trunk_request_enter_failed(trunk_request_t *treq);
916static void trunk_request_enter_complete(trunk_request_t *treq);
917static void trunk_request_enter_cancel(trunk_request_t *treq, trunk_cancel_reason_t reason);
918static void trunk_request_enter_cancel_sent(trunk_request_t *treq);
919static void trunk_request_enter_cancel_complete(trunk_request_t *treq);
920
921static uint64_t trunk_requests_per_connection(uint16_t *conn_count_out, uint32_t *req_conn_out,
922 trunk_t *trunk, fr_time_t now, NDEBUG_UNUSED bool verify);
923
924static int trunk_connection_spawn(trunk_t *trunk, fr_time_t now);
925static inline void trunk_connection_auto_full(trunk_connection_t *tconn);
926static inline void trunk_connection_auto_unfull(trunk_connection_t *tconn);
927static inline void trunk_connection_readable(trunk_connection_t *tconn);
928static inline void trunk_connection_writable(trunk_connection_t *tconn);
929static void trunk_connection_event_update(trunk_connection_t *tconn);
930static void trunk_connection_enter_full(trunk_connection_t *tconn);
931static void trunk_connection_enter_inactive(trunk_connection_t *tconn);
932static void trunk_connection_enter_inactive_draining(trunk_connection_t *tconn);
933static void trunk_connection_enter_draining(trunk_connection_t *tconn);
934static void trunk_connection_enter_draining_to_free(trunk_connection_t *tconn);
935static void trunk_connection_enter_active(trunk_connection_t *tconn);
936
937static void trunk_rebalance(trunk_t *trunk);
938static void trunk_manage(trunk_t *trunk, fr_time_t now);
939static void _trunk_timer(fr_timer_list_t *tl, fr_time_t now, void *uctx);
940static void trunk_backlog_drain(trunk_t *trunk);
941
942/** Compare two protocol requests
943 *
944 * Allows protocol requests to be prioritised with a function
945 * specified by the API client. Defaults to by pointer address
946 * if no function is specified.
947 *
948 * @param[in] a treq to compare to b.
949 * @param[in] b treq to compare to a.
950 * @return
951 * - +1 if a > b.
952 * - 0 if a == b.
953 * - -1 if a < b.
954 */
955static int8_t _trunk_request_prioritise(void const *a, void const *b)
956{
957 trunk_request_t const *treq_a = talloc_get_type_abort_const(a, trunk_request_t);
958 trunk_request_t const *treq_b = talloc_get_type_abort_const(b, trunk_request_t);
959
960 fr_assert(treq_a->pub.trunk == treq_b->pub.trunk);
961
962 return treq_a->pub.trunk->funcs.request_prioritise(treq_a->pub.preq, treq_b->pub.preq);
963}
964
965/** Remove a request from all connection lists
966 *
967 * A common function used by init, fail, complete state functions to disassociate
968 * a request from a connection in preparation for freeing or reassignment.
969 *
970 * Despite its unassuming name, this function is *the* place to put calls to
971 * functions which need to be called when the number of requests associated with
972 * a connection changes.
973 *
974 * Trunk requests will always be passed to this function before they're removed
975 * from a connection, even if the requests are being freed.
976 *
977 * @param[in] treq to trigger a state change for.
978 */
979static void trunk_request_remove_from_conn(trunk_request_t *treq)
980{
981 trunk_connection_t *tconn = treq->pub.tconn;
982 trunk_t *trunk = treq->pub.trunk;
983
984 if (!fr_cond_assert(!tconn || (tconn->pub.trunk == trunk))) return;
985
986 switch (treq->pub.state) {
987 case TRUNK_REQUEST_STATE_UNASSIGNED:
988 return; /* Not associated with connection */
989
990 case TRUNK_REQUEST_STATE_PENDING:
991 REQUEST_EXTRACT_PENDING(treq);
992 break;
993
994 case TRUNK_REQUEST_STATE_PARTIAL:
995 REQUEST_EXTRACT_PARTIAL(treq);
996 break;
997
998 case TRUNK_REQUEST_STATE_SENT:
999 REQUEST_EXTRACT_SENT(treq);
1000 break;
1001
1002 case TRUNK_REQUEST_STATE_REAPABLE:
1003 REQUEST_EXTRACT_REAPABLE(treq);
1004 break;
1005
1006 case TRUNK_REQUEST_STATE_CANCEL:
1007 REQUEST_EXTRACT_CANCEL(treq);
1008 break;
1009
1010 case TRUNK_REQUEST_STATE_CANCEL_PARTIAL:
1011 REQUEST_EXTRACT_CANCEL_PARTIAL(treq);
1012 break;
1013
1014 case TRUNK_REQUEST_STATE_CANCEL_SENT:
1015 REQUEST_EXTRACT_CANCEL_SENT(treq);
1016 break;
1017
1018 default:
1019 fr_assert(0);
1020 break;
1021 }
1022
1023 /*
1024 * If the request wasn't associated with a
1025 * connection, then there's nothing more
1026 * to do.
1027 */
1028 if (!tconn) return;
1029
1030 {
1031 request_t *request = treq->pub.request;
1032
1033 ROPTIONAL(RDEBUG3, DEBUG3, "%s Trunk connection released request %" PRIu64,
1034 tconn->pub.conn->name, treq->id);
1035 }
1036 /*
1037 * Release any connection specific resources the
1038 * treq holds.
1039 */
1040 DO_REQUEST_CONN_RELEASE(treq);
1041
1042 switch (tconn->pub.state){
1043 case TRUNK_CONN_FULL:
1044 trunk_connection_auto_unfull(tconn); /* Check if we can switch back to active */
1045 if (tconn->pub.state == TRUNK_CONN_FULL) break; /* Only fallthrough if conn is now active */
1046 FALL_THROUGH;
1047
1048 case TRUNK_CONN_ACTIVE:
1049 CONN_REORDER(tconn);
1050 break;
1051
1052 default:
1053 break;
1054 }
1055
1056 treq->pub.tconn = NULL;
1057
1058 /*
1059 * Request removed from the connection
1060 * see if we need up deregister I/O events.
1061 */
1062 trunk_connection_event_update(tconn);
1063}
1064
1065/** Transition a request to the unassigned state, in preparation for re-assignment
1066 *
1067 * @note treq->tconn may be inviable after calling
1068 * if treq->conn and connection_signals_pause are not used.
1069 * This is due to call to trunk_request_remove_from_conn.
1070 *
1071 * @param[in] treq to trigger a state change for.
1072 */
1073static void trunk_request_enter_unassigned(trunk_request_t *treq)
1074{
1075 trunk_t *trunk = treq->pub.trunk;
1076
1077 switch (treq->pub.state) {
1078 case TRUNK_REQUEST_STATE_UNASSIGNED:
1079 return;
1080
1081 case TRUNK_REQUEST_STATE_BACKLOG:
1082 REQUEST_EXTRACT_BACKLOG(treq);
1083 break;
1084
1085 case TRUNK_REQUEST_STATE_PENDING:
1086 case TRUNK_REQUEST_STATE_CANCEL:
1087 case TRUNK_REQUEST_STATE_CANCEL_PARTIAL:
1088 case TRUNK_REQUEST_STATE_CANCEL_SENT:
1089 trunk_request_remove_from_conn(treq);
1090 break;
1091
1092 default:
1093 REQUEST_BAD_STATE_TRANSITION(TRUNK_REQUEST_STATE_UNASSIGNED);
1094 }
1095
1096 REQUEST_STATE_TRANSITION(TRUNK_REQUEST_STATE_UNASSIGNED);
1097}
1098
1099/** Transition a request to the backlog state, adding it to the backlog of the trunk
1100 *
1101 * @note treq->tconn and treq may be inviable after calling
1102 * if treq->conn and connection_signals_pause are not used.
1103 * This is due to call to trunk_manage.
1104 *
1105 * @param[in] treq to trigger a state change for.
1106 * @param[in] new Whether this is a new request.
1107 */
1108static void trunk_request_enter_backlog(trunk_request_t *treq, bool new)
1109{
1110 trunk_connection_t *tconn = treq->pub.tconn;
1111 trunk_t *trunk = treq->pub.trunk;
1112
1113 switch (treq->pub.state) {
1114 case TRUNK_REQUEST_STATE_INIT:
1115 case TRUNK_REQUEST_STATE_UNASSIGNED:
1116 break;
1117
1118 case TRUNK_REQUEST_STATE_PENDING:
1119 REQUEST_EXTRACT_PENDING(treq);
1120 break;
1121
1122 case TRUNK_REQUEST_STATE_CANCEL:
1123 REQUEST_EXTRACT_CANCEL(treq);
1124 break;
1125
1126 default:
1127 REQUEST_BAD_STATE_TRANSITION(TRUNK_REQUEST_STATE_BACKLOG);
1128 }
1129
1130 REQUEST_STATE_TRANSITION(TRUNK_REQUEST_STATE_BACKLOG);
1131 fr_heap_insert(&trunk->backlog, treq); /* Insert into the backlog heap */
1132
1133 /*
1134 * A new request has entered the trunk.
1135 * Re-calculate request/connection ratios.
1136 */
1137 if (new) trunk_requests_per_connection(NULL, NULL, trunk, fr_time(), false);
1138
1139 /*
1140 * To reduce latency, if there's no connections
1141 * in the connecting state, call the trunk manage
1142 * function immediately.
1143 *
1144 * Likewise, if there's draining connections
1145 * which could be moved back to active call
1146 * the trunk manage function.
1147 *
1148 * Remember requests only enter the backlog if
1149 * there's no connections which can service them.
1150 */
1151 if ((trunk_connection_count_by_state(treq->pub.trunk, TRUNK_CONN_CONNECTING) == 0) ||
1152 (trunk_connection_count_by_state(treq->pub.trunk, TRUNK_CONN_DRAINING) > 0)) {
1153 trunk_connection_manage_schedule(treq->pub.trunk);
1154 }
1155}
1156
1157/** Transition a request to the pending state, adding it to the backlog of an active connection
1158 *
1159 * All trunk requests being added to a connection get passed to this function.
1160 * All trunk requests being removed from a connection get passed to #trunk_request_remove_from_conn.
1161 *
1162 * @note treq->tconn and treq may be inviable after calling
1163 * if treq->conn and connection_signals_pause is not used.
1164 * This is due to call to trunk_connection_event_update.
1165 *
1166 * @param[in] treq to trigger a state change for.
1167 * @param[in] tconn to enqueue the request on.
1168 * @param[in] new Whether this is a new request.
1169 */
1170static void trunk_request_enter_pending(trunk_request_t *treq, trunk_connection_t *tconn, bool new)
1171{
1172 trunk_t *trunk = treq->pub.trunk;
1173
1174 fr_assert(tconn->pub.trunk == trunk);
1175 fr_assert(IS_PROCESSING(tconn));
1176
1177 switch (treq->pub.state) {
1178 case TRUNK_REQUEST_STATE_INIT:
1179 case TRUNK_REQUEST_STATE_UNASSIGNED:
1180 fr_assert(!treq->pub.tconn);
1181 break;
1182
1183 case TRUNK_REQUEST_STATE_BACKLOG:
1184 fr_assert(!treq->pub.tconn);
1185 REQUEST_EXTRACT_BACKLOG(treq);
1186 break;
1187
1188 case TRUNK_REQUEST_STATE_CANCEL: /* Moved from another connection */
1189 REQUEST_EXTRACT_CANCEL(treq);
1190 break;
1191
1192 default:
1193 REQUEST_BAD_STATE_TRANSITION(TRUNK_REQUEST_STATE_PENDING);
1194 }
1195
1196 /*
1197 * Assign the new connection first this first so
1198 * it appears in the state log.
1199 */
1200 treq->pub.tconn = tconn;
1201
1202 REQUEST_STATE_TRANSITION(TRUNK_REQUEST_STATE_PENDING);
1203
1204 {
1205 request_t *request = treq->pub.request;
1206
1207 ROPTIONAL(RDEBUG, DEBUG3, "%s Trunk connection assigned request %"PRIu64,
1208 tconn->pub.conn->name, treq->id);
1209 }
1210 fr_heap_insert(&tconn->pending, treq);
1211
1212 /*
1213 * A new request has entered the trunk.
1214 * Re-calculate request/connection ratios.
1215 */
1216 if (new) trunk_requests_per_connection(NULL, NULL, trunk, fr_time(), false);
1217
1218 /*
1219 * Check if we need to automatically transition the
1220 * connection to full.
1221 */
1222 trunk_connection_auto_full(tconn);
1223
1224 /*
1225 * Reorder the connection in the heap now it has an
1226 * additional request.
1227 */
1228 if (tconn->pub.state == TRUNK_CONN_ACTIVE) CONN_REORDER(tconn);
1229
1230 /*
1231 * We have a new request, see if we need to register
1232 * for I/O events.
1233 */
1234 trunk_connection_event_update(tconn);
1235}
1236
1237/** Transition a request to the partial state, indicating that is has been partially sent
1238 *
1239 * @param[in] treq to trigger a state change for.
1240 */
1241static void trunk_request_enter_partial(trunk_request_t *treq)
1242{
1243 trunk_connection_t *tconn = treq->pub.tconn;
1244 trunk_t *trunk = treq->pub.trunk;
1245
1246 if (!fr_cond_assert(!tconn || (tconn->pub.trunk == trunk))) return;
1247
1248 switch (treq->pub.state) {
1249 case TRUNK_REQUEST_STATE_PENDING: /* All requests go through pending, even requeued ones */
1250 REQUEST_EXTRACT_PENDING(treq);
1251 break;
1252
1253 default:
1254 REQUEST_BAD_STATE_TRANSITION(TRUNK_REQUEST_STATE_PARTIAL);
1255 }
1256
1257 fr_assert(!tconn->partial);
1258 tconn->partial = treq;
1259
1260 REQUEST_STATE_TRANSITION(TRUNK_REQUEST_STATE_PARTIAL);
1261}
1262
1263/** Transition a request to the sent state, indicating that it's been sent in its entirety
1264 *
1265 * @note treq->tconn and treq may be inviable after calling
1266 * if treq->conn and connection_signals_pause is not used.
1267 * This is due to call to trunk_connection_event_update.
1268 *
1269 * @param[in] treq to trigger a state change for.
1270 */
1271static void trunk_request_enter_sent(trunk_request_t *treq)
1272{
1273 trunk_connection_t *tconn = treq->pub.tconn;
1274 trunk_t *trunk = treq->pub.trunk;
1275
1276 if (!fr_cond_assert(!tconn || (tconn->pub.trunk == trunk))) return;
1277
1278 switch (treq->pub.state) {
1279 case TRUNK_REQUEST_STATE_PENDING:
1280 REQUEST_EXTRACT_PENDING(treq);
1281 break;
1282
1283 case TRUNK_REQUEST_STATE_PARTIAL:
1284 REQUEST_EXTRACT_PARTIAL(treq);
1285 break;
1286
1287 default:
1288 REQUEST_BAD_STATE_TRANSITION(TRUNK_REQUEST_STATE_SENT);
1289 }
1290
1291 REQUEST_STATE_TRANSITION(TRUNK_REQUEST_STATE_SENT);
1292 fr_dlist_insert_tail(&tconn->sent, treq);
1293
1294 /*
1295 * Update the connection's sent stats if this is the
1296 * first time this request is being sent.
1297 */
1298 if (!treq->sent) {
1299 trunk->pub.last_write_success = fr_time();
1300
1301 tconn->pub.last_write_success = trunk->pub.last_write_success;
1302 tconn->sent_count++;
1303 treq->sent = true;
1304
1305 /*
1306 * Enforces max_uses
1307 */
1308 if ((trunk->conf.max_uses > 0) && (tconn->sent_count >= trunk->conf.max_uses)) {
1309 DEBUG3("Trunk hit max uses %" PRIu64 " at %d", trunk->conf.max_uses, __LINE__);
1310 trunk_connection_enter_draining_to_free(tconn);
1311 }
1312 }
1313
1314 /*
1315 * We just sent a request, we probably need
1316 * to tell the event loop we want to be
1317 * notified if there's data available.
1318 */
1319 trunk_connection_event_update(tconn);
1320}
1321
1322/** Transition a request to the reapable state, indicating that it's been sent in its entirety, but no response is expected
1323 *
1324 * @note Largely a replica of trunk_request_enter_sent.
1325 *
1326 * @param[in] treq to trigger a state change for.
1327 */
1328static void trunk_request_enter_reapable(trunk_request_t *treq)
1329{
1330 trunk_connection_t *tconn = treq->pub.tconn;
1331 trunk_t *trunk = treq->pub.trunk;
1332
1333 if (!fr_cond_assert(!tconn || (tconn->pub.trunk == trunk))) return;
1334
1335 switch (treq->pub.state) {
1336 case TRUNK_REQUEST_STATE_PENDING:
1337 REQUEST_EXTRACT_PENDING(treq);
1338 break;
1339
1340 case TRUNK_REQUEST_STATE_PARTIAL:
1341 REQUEST_EXTRACT_PARTIAL(treq);
1342 break;
1343
1344 default:
1345 REQUEST_BAD_STATE_TRANSITION(TRUNK_REQUEST_STATE_SENT);
1346 }
1347
1348 REQUEST_STATE_TRANSITION(TRUNK_REQUEST_STATE_REAPABLE);
1349 fr_dlist_insert_tail(&tconn->reapable, treq);
1350
1351 if (!treq->sent) {
1352 tconn->sent_count++;
1353 treq->sent = true;
1354
1355 if ((trunk->conf.max_uses > 0) && (tconn->sent_count >= trunk->conf.max_uses)) {
1356 DEBUG3("Trunk hit max uses %" PRIu64 " at %d", trunk->conf.max_uses, __LINE__);
1357 trunk_connection_enter_draining_to_free(tconn);
1358 }
1359 }
1360
1361 trunk_connection_event_update(tconn);
1362}
1363
1364/** Transition a request to the cancel state, placing it in a connection's cancellation list
1365 *
1366 * If a request_cancel_send callback is provided, that callback will
1367 * be called periodically for requests which were cancelled due to
1368 * a signal.
1369 *
1370 * The request_cancel_send callback will dequeue cancelled requests
1371 * and inform a remote server that the result is no longer required.
1372 *
1373 * A request must enter this state before being added to the backlog
1374 * of another connection if it's been sent or partially sent.
1375 *
1376 * @note treq->tconn and treq may be inviable after calling
1377 * if treq->conn and connection_signals_pause is not used.
1378 * This is due to call to trunk_connection_event_update.
1379 *
1380 * @param[in] treq to trigger a state change for.
1381 * @param[in] reason Why the request was cancelled.
1382 * Should be one of:
1383 * - TRUNK_CANCEL_REASON_SIGNAL request cancelled
1384 * because of a signal from the interpreter.
1385 * - TRUNK_CANCEL_REASON_MOVE request cancelled
1386 * because the connection failed and it needs
1387 * to be assigned to a new connection.
1388 * - TRUNK_CANCEL_REASON_REQUEUE request cancelled
1389 * as it needs to be resent on the same connection.
1390 */
1391static void trunk_request_enter_cancel(trunk_request_t *treq, trunk_cancel_reason_t reason)
1392{
1393 trunk_connection_t *tconn = treq->pub.tconn;
1394 trunk_t *trunk = treq->pub.trunk;
1395
1396 if (!fr_cond_assert(!tconn || (tconn->pub.trunk == trunk))) return;
1397
1398 switch (treq->pub.state) {
1399 case TRUNK_REQUEST_STATE_PARTIAL:
1400 REQUEST_EXTRACT_PARTIAL(treq);
1401 break;
1402
1403 case TRUNK_REQUEST_STATE_SENT:
1404 REQUEST_EXTRACT_SENT(treq);
1405 break;
1406
1407 case TRUNK_REQUEST_STATE_REAPABLE:
1408 REQUEST_EXTRACT_REAPABLE(treq);
1409 break;
1410
1411 default:
1412 REQUEST_BAD_STATE_TRANSITION(TRUNK_REQUEST_STATE_CANCEL);
1413 }
1414
1415 REQUEST_STATE_TRANSITION(TRUNK_REQUEST_STATE_CANCEL);
1416 fr_dlist_insert_tail(&tconn->cancel, treq);
1417 treq->cancel_reason = reason;
1418
1419 DO_REQUEST_CANCEL(treq, reason);
1420
1421 /*
1422 * Our treq is no longer bound to an actual
1423 * request_t *, as we can't guarantee the
1424 * lifetime of the original request_t *.
1425 */
1426 if (treq->cancel_reason == TRUNK_CANCEL_REASON_SIGNAL) treq->pub.request = NULL;
1427
1428 /*
1429 * Register for I/O write events if we need to.
1430 */
1431 trunk_connection_event_update(treq->pub.tconn);
1432}
1433
1434/** Transition a request to the cancel_partial state, placing it in a connection's cancel_partial slot
1435 *
1436 * The request_demux function is then responsible for signalling
1437 * that the cancel request is complete when the remote server
1438 * acknowledges the cancellation request.
1439 *
1440 * @param[in] treq to trigger a state change for.
1441 */
1442static void trunk_request_enter_cancel_partial(trunk_request_t *treq)
1443{
1444 trunk_connection_t *tconn = treq->pub.tconn;
1445 trunk_t *trunk = treq->pub.trunk;
1446
1447 if (!fr_cond_assert(!tconn || (tconn->pub.trunk == trunk))) return;
1448 fr_assert(trunk->funcs.request_cancel_mux);
1449 fr_assert(treq->cancel_reason == TRUNK_CANCEL_REASON_SIGNAL);
1450
1451 switch (treq->pub.state) {
1452 case TRUNK_REQUEST_STATE_CANCEL: /* The only valid state cancel_sent can be reached from */
1453 REQUEST_EXTRACT_CANCEL(treq);
1454 break;
1455
1456 default:
1457 REQUEST_BAD_STATE_TRANSITION(TRUNK_REQUEST_STATE_CANCEL_PARTIAL);
1458 }
1459
1460 REQUEST_STATE_TRANSITION(TRUNK_REQUEST_STATE_CANCEL_PARTIAL);
1461 fr_assert(!tconn->partial);
1462 tconn->cancel_partial = treq;
1463}
1464
1465/** Transition a request to the cancel_sent state, placing it in a connection's cancel_sent list
1466 *
1467 * The request_demux function is then responsible for signalling
1468 * that the cancel request is complete when the remote server
1469 * acknowledges the cancellation request.
1470 *
1471 * @note treq->tconn and treq may be inviable after calling
1472 * if treq->conn and connection_signals_pause is not used.
1473 * This is due to call to trunk_connection_event_update.
1474 *
1475 * @param[in] treq to trigger a state change for.
1476 */
1477static void trunk_request_enter_cancel_sent(trunk_request_t *treq)
1478{
1479 trunk_connection_t *tconn = treq->pub.tconn;
1480 trunk_t *trunk = treq->pub.trunk;
1481
1482 if (!fr_cond_assert(!tconn || (tconn->pub.trunk == trunk))) return;
1483 fr_assert(trunk->funcs.request_cancel_mux);
1484 fr_assert(treq->cancel_reason == TRUNK_CANCEL_REASON_SIGNAL);
1485
1486 switch (treq->pub.state) {
1487 case TRUNK_REQUEST_STATE_CANCEL_PARTIAL:
1488 REQUEST_EXTRACT_CANCEL_PARTIAL(treq);
1489 break;
1490
1491 case TRUNK_REQUEST_STATE_CANCEL:
1492 REQUEST_EXTRACT_CANCEL(treq);
1493 break;
1494
1495 default:
1496 REQUEST_BAD_STATE_TRANSITION(TRUNK_REQUEST_STATE_CANCEL_SENT);
1497 }
1498
1499 REQUEST_STATE_TRANSITION(TRUNK_REQUEST_STATE_CANCEL_SENT);
1500 fr_dlist_insert_tail(&tconn->cancel_sent, treq);
1501
1502 /*
1503 * De-register for I/O write events
1504 * and register the read events
1505 * to drain the cancel ACKs.
1506 */
1507 trunk_connection_event_update(treq->pub.tconn);
1508}
1509
1510/** Cancellation was acked, the request is complete, free it
1511 *
1512 * The API client will not be informed, as the original request_t *
1513 * will likely have been freed by this point.
1514 *
1515 * @note treq will be inviable after a call to this function.
1516 * treq->tconn may be inviable after calling
1517 * if treq->conn and connection_signals_pause is not used.
1518 * This is due to call to trunk_request_remove_from_conn.
1519 *
1520 * @param[in] treq to mark as complete.
1521 */
1522static void trunk_request_enter_cancel_complete(trunk_request_t *treq)
1523{
1524 trunk_connection_t *tconn = treq->pub.tconn;
1525 trunk_t *trunk = treq->pub.trunk;
1526
1527 if (!fr_cond_assert(!tconn || (tconn->pub.trunk == trunk))) return;
1528 if (!fr_cond_assert(!treq->pub.request)) return; /* Only a valid state for request_t * which have been cancelled */
1529
1530 switch (treq->pub.state) {
1531 case TRUNK_REQUEST_STATE_CANCEL_SENT:
1532 case TRUNK_REQUEST_STATE_CANCEL:
1533 break;
1534
1535 default:
1536 REQUEST_BAD_STATE_TRANSITION(TRUNK_REQUEST_STATE_CANCEL_COMPLETE);
1537 }
1538
1539 trunk_request_remove_from_conn(treq);
1540
1541 REQUEST_STATE_TRANSITION(TRUNK_REQUEST_STATE_CANCEL_COMPLETE);
1542 trunk_request_free(&treq); /* Free the request */
1543}
1544
1545/** Request completed successfully, inform the API client and free the request
1546 *
1547 * @note treq will be inviable after a call to this function.
1548 * treq->tconn may also be inviable due to call to
1549 * trunk_request_remove_from_conn.
1550 *
1551 * @param[in] treq to mark as complete.
1552 */
1553static void trunk_request_enter_complete(trunk_request_t *treq)
1554{
1555 trunk_connection_t *tconn = treq->pub.tconn;
1556 trunk_t *trunk = treq->pub.trunk;
1557
1558 if (!fr_cond_assert(!tconn || (tconn->pub.trunk == trunk))) return;
1559
1560 switch (treq->pub.state) {
1561 case TRUNK_REQUEST_STATE_SENT:
1562 case TRUNK_REQUEST_STATE_PENDING:
1563 case TRUNK_REQUEST_STATE_REAPABLE:
1564 trunk_request_remove_from_conn(treq);
1565 break;
1566
1567 default:
1568 REQUEST_BAD_STATE_TRANSITION(TRUNK_REQUEST_STATE_COMPLETE);
1569 }
1570
1571 REQUEST_STATE_TRANSITION(TRUNK_REQUEST_STATE_COMPLETE);
1572 DO_REQUEST_COMPLETE(treq);
1573 trunk_request_free(&treq); /* Free the request */
1574}
1575
1576/** Request failed, inform the API client and free the request
1577 *
1578 * @note treq will be inviable after a call to this function.
1579 * treq->tconn may also be inviable due to call to
1580 * trunk_request_remove_from_conn.
1581 *
1582 * @param[in] treq to mark as failed.
1583 */
1584static void trunk_request_enter_failed(trunk_request_t *treq)
1585{
1586 trunk_connection_t *tconn = treq->pub.tconn;
1587 trunk_t *trunk = treq->pub.trunk;
1588 trunk_request_state_t prev = treq->pub.state;
1589
1590 if (!fr_cond_assert(!tconn || (tconn->pub.trunk == trunk))) return;
1591
1592 switch (treq->pub.state) {
1593 case TRUNK_REQUEST_STATE_BACKLOG:
1594 REQUEST_EXTRACT_BACKLOG(treq);
1595 break;
1596
1597 default:
1598 trunk_request_remove_from_conn(treq);
1599 break;
1600 }
1601
1602 REQUEST_STATE_TRANSITION(TRUNK_REQUEST_STATE_FAILED);
1603 DO_REQUEST_FAIL(treq, prev);
1604 trunk_request_free(&treq); /* Free the request */
1605}
1606
1607/** Check to see if a trunk request can be enqueued
1608 *
1609 * @param[out] tconn_out Connection the request may be enqueued on.
1610 * @param[in] trunk To enqueue requests on.
1611 * @param[in] request associated with the treq (if any).
1612 * @return
1613 * - TRUNK_ENQUEUE_OK caller should enqueue request on provided tconn.
1614 * - TRUNK_ENQUEUE_IN_BACKLOG Request should be queued in the backlog.
1615 * - TRUNK_ENQUEUE_NO_CAPACITY Unable to enqueue request as we have no spare
1616 * connections or backlog space.
1617 * - TRUNK_ENQUEUE_DST_UNAVAILABLE Can't enqueue because the destination is
1618 * unreachable.
1619 */
1620static trunk_enqueue_t trunk_request_check_enqueue(trunk_connection_t **tconn_out, trunk_t *trunk,
1621 request_t *request)
1622{
1623 trunk_connection_t *tconn;
1624 /*
1625 * If we have an active connection then
1626 * return that.
1627 */
1628 tconn = fr_minmax_heap_min_peek(trunk->active);
1629 if (tconn) {
1630 *tconn_out = tconn;
1631 return TRUNK_ENQUEUE_OK;
1632 }
1633
1634 /*
1635 * Unlike the connection pool, we don't need
1636 * to drive any internal processes by feeding
1637 * it requests.
1638 *
1639 * If the last event to occur was a failure
1640 * we refuse to enqueue new requests until
1641 * one or more connections comes online.
1642 */
1643 if (!trunk->conf.backlog_on_failed_conn &&
1644 fr_time_gt(trunk->pub.last_failed, fr_time_wrap(0)) &&
1645 fr_time_lt(trunk->pub.last_connected, trunk->pub.last_failed)) {
1646 RATE_LIMIT_LOCAL_ROPTIONAL(&trunk->limit_last_failure_log,
1647 RWARN, WARN, "Refusing to enqueue requests - "
1648 "No active connections and last event was a connection failure");
1649
1650 return TRUNK_ENQUEUE_DST_UNAVAILABLE;
1651 }
1652
1653
1654 /*
1655 * Only enforce if we're limiting maximum
1656 * number of connections, and maximum
1657 * number of requests per connection.
1658 *
1659 * The alloc function also checks this
1660 * which is why this is only done for
1661 * debug builds.
1662 */
1663 if (trunk->conf.max_req_per_conn && trunk->conf.max) {
1664 uint64_t limit;
1665
1666 limit = trunk->conf.max * (uint64_t)trunk->conf.max_req_per_conn;
1667 if (limit > 0) {
1668 uint64_t total_reqs;
1669
1670 total_reqs = trunk_request_count_by_state(trunk, TRUNK_CONN_ALL,
1671 TRUNK_REQUEST_STATE_ALL);
1672 if (total_reqs >= (limit + trunk->conf.max_backlog)) {
1673 RATE_LIMIT_LOCAL_ROPTIONAL(&trunk->limit_max_requests_alloc_log,
1674 RWARN, WARN, "Refusing to alloc requests - "
1675 "Limit of %"PRIu64" (max = %u * per_connection_max = %u) "
1676 "plus %u backlog requests reached",
1677 limit, trunk->conf.max, trunk->conf.max_req_per_conn,
1678 trunk->conf.max_backlog);
1679 return TRUNK_ENQUEUE_NO_CAPACITY;
1680 }
1681 }
1682 }
1683
1684 return TRUNK_ENQUEUE_IN_BACKLOG;
1685}
1686
1687/** Enqueue a request which has never been assigned to a connection or was previously cancelled
1688 *
1689 * @param[in] treq to re enqueue. Must have been removed
1690 * from its existing connection with
1691 * #trunk_connection_requests_dequeue.
1692 * @return
1693 * - TRUNK_ENQUEUE_OK Request was re-enqueued.
1694 * - TRUNK_ENQUEUE_NO_CAPACITY Request enqueueing failed because we're at capacity.
1695 * - TRUNK_ENQUEUE_DST_UNAVAILABLE Enqueuing failed for some reason.
1696 * Usually because the connection to the resource is down.
1697 */
1698static trunk_enqueue_t trunk_request_enqueue_existing(trunk_request_t *treq)
1699{
1700 trunk_t *trunk = treq->pub.trunk;
1701 trunk_connection_t *tconn = NULL;
1702 trunk_enqueue_t ret;
1703
1704 /*
1705 * Must *NOT* still be assigned to another connection
1706 */
1707 fr_assert(!treq->pub.tconn);
1708
1709 ret = trunk_request_check_enqueue(&tconn, trunk, treq->pub.request);
1710 switch (ret) {
1711 case TRUNK_ENQUEUE_OK:
1712 if (trunk->conf.always_writable) {
1713 connection_signals_pause(tconn->pub.conn);
1714 trunk_request_enter_pending(treq, tconn, false);
1715 trunk_connection_writable(tconn);
1716 connection_signals_resume(tconn->pub.conn);
1717 } else {
1718 trunk_request_enter_pending(treq, tconn, false);
1719 }
1720 break;
1721
1722 case TRUNK_ENQUEUE_IN_BACKLOG:
1723 /*
1724 * No more connections and request
1725 * is already in the backlog.
1726 *
1727 * Signal our caller it should stop
1728 * trying to drain the backlog.
1729 */
1730 if (treq->pub.state == TRUNK_REQUEST_STATE_BACKLOG) return TRUNK_ENQUEUE_NO_CAPACITY;
1731 trunk_request_enter_backlog(treq, false);
1732 break;
1733
1734 default:
1735 break;
1736 }
1737
1738 return ret;
1739}
1740
1741/** Shift requests in the specified states onto new connections
1742 *
1743 * This function will blindly dequeue any requests in the specified state and get
1744 * them back to the unassigned state, cancelling any sent or partially sent requests.
1745 *
1746 * This function does not check that dequeuing a request in a particular state is a
1747 * sane or sensible thing to do, that's up to the caller!
1748 *
1749 * @param[out] out A list to insert the newly dequeued and unassigned
1750 * requests into.
1751 * @param[in] tconn to dequeue requests from.
1752 * @param[in] states Dequeue request in these states.
1753 * @param[in] max The maximum number of requests to dequeue. 0 for unlimited.
1754 */
1755static uint64_t trunk_connection_requests_dequeue(fr_dlist_head_t *out, trunk_connection_t *tconn,
1756 int states, uint64_t max)
1757{
1758 trunk_request_t *treq;
1759 uint64_t count = 0;
1760
1761 if (max == 0) max = UINT64_MAX;
1762
1763#define OVER_MAX_CHECK if (++count > max) return (count - 1)
1764
1765#define DEQUEUE_ALL(_src_list, _state) do { \
1766 while ((treq = fr_dlist_head(_src_list))) { \
1767 OVER_MAX_CHECK; \
1768 fr_assert(treq->pub.state == (_state)); \
1769 trunk_request_enter_unassigned(treq); \
1770 fr_dlist_insert_tail(out, treq); \
1771 } } while (0)
1772
1773 /*
1774 * Don't need to do anything with
1775 * cancellation requests.
1776 */
1777 if (states & TRUNK_REQUEST_STATE_CANCEL) DEQUEUE_ALL(&tconn->cancel,
1778 TRUNK_REQUEST_STATE_CANCEL);
1779
1780 /*
1781 * ...same with cancel inform
1782 */
1783 if (states & TRUNK_REQUEST_STATE_CANCEL_SENT) DEQUEUE_ALL(&tconn->cancel_sent,
1784 TRUNK_REQUEST_STATE_CANCEL_SENT);
1785
1786 /*
1787 * ....same with cancel partial
1788 */
1789 if (states & TRUNK_REQUEST_STATE_CANCEL_PARTIAL) {
1790 OVER_MAX_CHECK;
1791 treq = tconn->cancel_partial;
1792 if (treq) {
1793 fr_assert(treq->pub.state == TRUNK_REQUEST_STATE_CANCEL_PARTIAL);
1794 trunk_request_enter_unassigned(treq);
1795 fr_dlist_insert_tail(out, treq);
1796 }
1797 }
1798
1799 /*
1800 * ...and pending.
1801 */
1802 if (states & TRUNK_REQUEST_STATE_PENDING) {
1803 while ((treq = fr_heap_peek(tconn->pending))) {
1804 OVER_MAX_CHECK;
1805 fr_assert(treq->pub.state == TRUNK_REQUEST_STATE_PENDING);
1806 trunk_request_enter_unassigned(treq);
1807 fr_dlist_insert_tail(out, treq);
1808 }
1809 }
1810
1811 /*
1812 * Cancel partially sent requests
1813 */
1814 if (states & TRUNK_REQUEST_STATE_PARTIAL) {
1815 OVER_MAX_CHECK;
1816 treq = tconn->partial;
1817 if (treq) {
1818 fr_assert(treq->pub.state == TRUNK_REQUEST_STATE_PARTIAL);
1819
1820 /*
1821 * Don't allow the connection to change state whilst
1822 * we're draining requests from it.
1823 */
1824 connection_signals_pause(tconn->pub.conn);
1825 trunk_request_enter_cancel(treq, TRUNK_CANCEL_REASON_MOVE);
1826 trunk_request_enter_unassigned(treq);
1827 fr_dlist_insert_tail(out, treq);
1828 connection_signals_resume(tconn->pub.conn);
1829 }
1830 }
1831
1832 /*
1833 * Cancel sent requests
1834 */
1835 if (states & TRUNK_REQUEST_STATE_SENT) {
1836 /*
1837 * Don't allow the connection to change state whilst
1838 * we're draining requests from it.
1839 */
1840 connection_signals_pause(tconn->pub.conn);
1841 while ((treq = fr_dlist_head(&tconn->sent))) {
1842 OVER_MAX_CHECK;
1843 fr_assert(treq->pub.state == TRUNK_REQUEST_STATE_SENT);
1844
1845 trunk_request_enter_cancel(treq, TRUNK_CANCEL_REASON_MOVE);
1846 trunk_request_enter_unassigned(treq);
1847 fr_dlist_insert_tail(out, treq);
1848 }
1849 connection_signals_resume(tconn->pub.conn);
1850 }
1851
1852 return count;
1853}
1854
1855/** Remove requests in specified states from a connection, attempting to distribute them to new connections
1856 *
1857 * @param[in] tconn To remove requests from.
1858 * @param[in] states One or more states or'd together.
1859 * @param[in] max The maximum number of requests to dequeue.
1860 * 0 for unlimited.
1861 * @param[in] fail_bound If true causes any requests bound to the connection to fail.
1862 * If false bound requests will not be moved.
1863 *
1864 * @return the number of requests re-queued.
1865 */
1866static uint64_t trunk_connection_requests_requeue_priv(trunk_connection_t *tconn, int states, uint64_t max, bool fail_bound)
1867{
1868 trunk_t *trunk = tconn->pub.trunk;
1869 fr_dlist_head_t to_process;
1870 trunk_request_t *treq = NULL;
1871 uint64_t moved = 0;
1872
1873 if (max == 0) max = UINT64_MAX;
1874
1875 fr_dlist_talloc_init(&to_process, trunk_request_t, entry);
1876
1877 /*
1878 * Prevent the connection changing state whilst we're
1879 * working with it.
1880 *
1881 * There's a user callback that can be called by
1882 * trunk_request_enqueue_existing which can reconnect
1883 * the connection.
1884 */
1885 connection_signals_pause(tconn->pub.conn);
1886
1887 /*
1888 * Remove non-cancelled requests from the connection
1889 */
1890 moved += trunk_connection_requests_dequeue(&to_process, tconn, states & ~TRUNK_REQUEST_STATE_CANCEL_ALL, max);
1891
1892 /*
1893 * Prevent requests being requeued on the same trunk
1894 * connection, which would break rebalancing.
1895 *
1896 * This is a bit of a hack, but nothing should test
1897 * for connection/list consistency in this code,
1898 * and if something is added later, it'll be flagged
1899 * by the tests.
1900 */
1901 if (tconn->pub.state == TRUNK_CONN_ACTIVE) {
1902 int ret;
1903
1904 ret = fr_minmax_heap_extract(trunk->active, tconn);
1905 if (!fr_cond_assert_msg(ret == 0,
1906 "Failed extracting conn from active heap: %s", fr_strerror())) goto done;
1907
1908 }
1909
1910 /*
1911 * Loop over all the requests we gathered and
1912 * redistribute them to new connections.
1913 */
1914 while ((treq = fr_dlist_next(&to_process, treq))) {
1915 trunk_request_t *prev;
1916
1917 prev = fr_dlist_remove(&to_process, treq);
1918
1919 /*
1920 * Attempts to re-queue a request
1921 * that's bound to a connection
1922 * results in a failure.
1923 */
1924 if (treq->bound_to_conn) {
1925 if (fail_bound || !IS_SERVICEABLE(tconn)) {
1926 trunk_request_enter_failed(treq);
1927 } else {
1928 trunk_request_enter_pending(treq, tconn, false);
1929 }
1930 goto next;
1931 }
1932
1933 switch (trunk_request_enqueue_existing(treq)) {
1934 case TRUNK_ENQUEUE_OK:
1935 break;
1936
1937 /*
1938 * A connection failed, and
1939 * there's no other connections
1940 * available to deal with the
1941 * load, it's been placed back
1942 * in the backlog.
1943 */
1944 case TRUNK_ENQUEUE_IN_BACKLOG:
1945 break;
1946
1947 /*
1948 * If we fail to re-enqueue then
1949 * there's nothing to do except
1950 * fail the request.
1951 */
1952 case TRUNK_ENQUEUE_DST_UNAVAILABLE:
1953 case TRUNK_ENQUEUE_NO_CAPACITY:
1954 case TRUNK_ENQUEUE_FAIL:
1955 trunk_request_enter_failed(treq);
1956 break;
1957 }
1958 next:
1959 treq = prev;
1960 }
1961
1962 /*
1963 * Add the connection back into the active list
1964 */
1965 if (tconn->pub.state == TRUNK_CONN_ACTIVE) {
1966 int ret;
1967
1968 ret = fr_minmax_heap_insert(trunk->active, tconn);
1969 if (!fr_cond_assert_msg(ret == 0,
1970 "Failed re-inserting conn into active heap: %s", fr_strerror())) goto done;
1971 }
1972 if (moved >= max) goto done;
1973
1974 /*
1975 * Deal with the cancelled requests specially we can't
1976 * queue them up again as they were only valid on that
1977 * specific connection.
1978 *
1979 * We just need to run them to completion which, as
1980 * they should already be in the unassigned state,
1981 * just means freeing them.
1982 */
1983 moved += trunk_connection_requests_dequeue(&to_process, tconn,
1984 states & TRUNK_REQUEST_STATE_CANCEL_ALL, max - moved);
1985 while ((treq = fr_dlist_next(&to_process, treq))) {
1986 trunk_request_t *prev;
1987
1988 prev = fr_dlist_remove(&to_process, treq);
1989 trunk_request_free(&treq);
1990 treq = prev;
1991 }
1992
1993done:
1994
1995 /*
1996 * Always re-calculate the request/connection
1997 * ratio at the end.
1998 *
1999 * This avoids having the state transition
2000 * functions do it.
2001 *
2002 * The ratio would be wrong when they calculated
2003 * it anyway, because a bunch of requests are
2004 * dequeued from the connection and temporarily
2005 * cease to exist from the perspective of the
2006 * trunk_requests_per_connection code.
2007 */
2008 trunk_requests_per_connection(NULL, NULL, trunk, fr_time(), false);
2009
2010 connection_signals_resume(tconn->pub.conn);
2011 return moved;
2012}
2013
2014/** Move requests off of a connection and requeue elsewhere
2015 *
2016 * @note We don't re-queue on draining or draining to free, as requests should have already been
2017 * moved off of the connection. It's also dangerous as the trunk management code main
2018 * clean up a connection in this state when it's run on re-queue, and then the caller
2019 * may try and access a now freed connection.
2020 *
2021 * @param[in] tconn to move requests off of.
2022 * @param[in] states Only move requests in this state.
2023 * @param[in] max The maximum number of requests to dequeue. 0 for unlimited.
2024 * @param[in] fail_bound If true causes any requests bound to the connection to fail.
2025 * If false bound requests will not be moved.
2026 * @return The number of requests requeued.
2027 */
2028uint64_t trunk_connection_requests_requeue(trunk_connection_t *tconn, int states, uint64_t max, bool fail_bound)
2029{
2030 switch (tconn->pub.state) {
2031 case TRUNK_CONN_ACTIVE:
2032 case TRUNK_CONN_FULL:
2033 case TRUNK_CONN_INACTIVE:
2034 return trunk_connection_requests_requeue_priv(tconn, states, max, fail_bound);
2035
2036 default:
2037 return 0;
2038 }
2039}
2040
2041/** Signal a partial write
2042 *
2043 * Where there's high load, and the outbound write buffer is full
2044 *
2045 * @param[in] treq to signal state change for.
2046 */
2047void trunk_request_signal_partial(trunk_request_t *treq)
2048{
2049 if (!fr_cond_assert_msg(treq->pub.trunk, "treq not associated with trunk")) return;
2050
2051 if (!fr_cond_assert_msg(IN_REQUEST_MUX(treq->pub.trunk),
2052 "%s can only be called from within request_mux handler", __FUNCTION__)) return;
2053
2054 switch (treq->pub.state) {
2055 case TRUNK_REQUEST_STATE_PENDING:
2056 trunk_request_enter_partial(treq);
2057 break;
2058
2059 default:
2060 return;
2061 }
2062}
2063
2064/** Signal that the request was written to a connection successfully
2065 *
2066 * @param[in] treq to signal state change for.
2067 */
2068void trunk_request_signal_sent(trunk_request_t *treq)
2069{
2070 if (!fr_cond_assert_msg(treq->pub.trunk, "treq not associated with trunk")) return;
2071
2072 if (!fr_cond_assert_msg(IN_REQUEST_MUX(treq->pub.trunk),
2073 "%s can only be called from within request_mux handler", __FUNCTION__)) return;
2074
2075 switch (treq->pub.state) {
2076 case TRUNK_REQUEST_STATE_PENDING:
2077 case TRUNK_REQUEST_STATE_PARTIAL:
2078 trunk_request_enter_sent(treq);
2079 break;
2080
2081 default:
2082 return;
2083 }
2084}
2085
2086/** Signal that the request was written to a connection successfully, but no response is expected
2087 *
2088 * @param[in] treq to signal state change for.
2089 */
2090void trunk_request_signal_reapable(trunk_request_t *treq)
2091{
2092 if (!fr_cond_assert_msg(treq->pub.trunk, "treq not associated with trunk")) return;
2093
2094 if (!fr_cond_assert_msg(IN_REQUEST_MUX(treq->pub.trunk),
2095 "%s can only be called from within request_mux handler", __FUNCTION__)) return;
2096
2097 switch (treq->pub.state) {
2098 case TRUNK_REQUEST_STATE_PENDING:
2099 case TRUNK_REQUEST_STATE_PARTIAL:
2100 trunk_request_enter_reapable(treq);
2101 break;
2102
2103 default:
2104 return;
2105 }
2106}
2107
2108/** Signal that a trunk request is complete
2109 *
2110 * The API client will be informed that the request is now complete.
2111 */
2112void trunk_request_signal_complete(trunk_request_t *treq)
2113{
2114 trunk_t *trunk = treq->pub.trunk;
2115
2116 if (!fr_cond_assert_msg(trunk, "treq not associated with trunk")) return;
2117
2118 /*
2119 * We assume that if the request is being signalled
2120 * as complete from the demux function, that it was
2121 * a successful read.
2122 *
2123 * If this assumption turns out to be incorrect
2124 * then we need to add an argument to signal_complete
2125 * to indicate if this is a successful read.
2126 */
2127 if (IN_REQUEST_DEMUX(trunk)) {
2128 trunk_connection_t *tconn = treq->pub.tconn;
2129
2130 trunk->pub.last_read_success = fr_time();
2131 tconn->pub.last_read_success = trunk->pub.last_read_success;
2132 }
2133
2134 switch (treq->pub.state) {
2135 case TRUNK_REQUEST_STATE_SENT:
2136 case TRUNK_REQUEST_STATE_PENDING: /* Got immediate response, i.e. cached */
2137 case TRUNK_REQUEST_STATE_REAPABLE:
2138 trunk_request_enter_complete(treq);
2139 break;
2140
2141 default:
2142 return;
2143 }
2144}
2145
2146/** Signal that a trunk request failed
2147 *
2148 * The API client will be informed that the request has failed.
2149 */
2150void trunk_request_signal_fail(trunk_request_t *treq)
2151{
2152 if (!fr_cond_assert_msg(treq->pub.trunk, "treq not associated with trunk")) return;
2153
2154 trunk_request_enter_failed(treq);
2155}
2156
2157/** Cancel a trunk request
2158 *
2159 * treq can be in any state, but requests to cancel if the treq is not in
2160 * the TRUNK_REQUEST_STATE_PARTIAL or TRUNK_REQUEST_STATE_SENT state will be ignored.
2161 *
2162 * The complete or failed callbacks will not be called here, as it's assumed the request_t *
2163 * is now inviable as it's being cancelled.
2164 *
2165 * The free function however, is called, and that should be used to perform necessary
2166 * cleanup.
2167 *
2168 * @param[in] treq to signal state change for.
2169 */
2170void trunk_request_signal_cancel(trunk_request_t *treq)
2171{
2172 trunk_t *trunk;
2173
2174 /*
2175 * Ensure treq hasn't been freed
2176 */
2177 (void)talloc_get_type_abort(treq, trunk_request_t);
2178
2179 if (!fr_cond_assert_msg(treq->pub.trunk, "treq not associated with trunk")) return;
2180
2181 if (!fr_cond_assert_msg(!IN_HANDLER(treq->pub.trunk),
2182 "%s cannot be called within a handler", __FUNCTION__)) return;
2183
2184 trunk = treq->pub.trunk;
2185
2186 switch (treq->pub.state) {
2187 /*
2188 * We don't call the complete or failed callbacks
2189 * as the request and rctx are no longer viable.
2190 */
2191 case TRUNK_REQUEST_STATE_PARTIAL:
2192 case TRUNK_REQUEST_STATE_SENT:
2193 {
2194 trunk_connection_t *tconn = treq->pub.tconn;
2195
2196 /*
2197 * Don't allow connection state changes
2198 */
2199 connection_signals_pause(tconn->pub.conn);
2200 trunk_request_enter_cancel(treq, TRUNK_CANCEL_REASON_SIGNAL);
2201 if (!fr_cond_assert_msg(treq->pub.state == TRUNK_REQUEST_STATE_CANCEL,
2202 "Bad state %s after cancellation",
2203 fr_table_str_by_value(trunk_request_states, treq->pub.state, "<INVALID>"))) {
2204 connection_signals_resume(tconn->pub.conn);
2205 return;
2206 }
2207 /*
2208 * No cancel muxer. We're done.
2209 *
2210 * If we do have a cancel mux function,
2211 * the next time this connection becomes
2212 * writable, we'll call the cancel mux
2213 * function.
2214 *
2215 * We don't run the complete or failed
2216 * callbacks here as the request is
2217 * being cancelled.
2218 */
2219 if (!trunk->funcs.request_cancel_mux) {
2220 trunk_request_enter_unassigned(treq);
2221 trunk_request_free(&treq);
2222 }
2223 connection_signals_resume(tconn->pub.conn);
2224 }
2225 break;
2226
2227 /*
2228 * We're already in the process of cancelling a
2229 * request, so ignore duplicate signals.
2230 */
2231 case TRUNK_REQUEST_STATE_CANCEL:
2232 case TRUNK_REQUEST_STATE_CANCEL_PARTIAL:
2233 case TRUNK_REQUEST_STATE_CANCEL_SENT:
2234 case TRUNK_REQUEST_STATE_CANCEL_COMPLETE:
2235 break;
2236
2237 /*
2238 * For any other state, we just release the request
2239 * from its current connection and free it.
2240 */
2241 default:
2242 trunk_request_enter_unassigned(treq);
2243 trunk_request_free(&treq);
2244 break;
2245 }
2246}
2247
2248/** Signal a partial cancel write
2249 *
2250 * Where there's high load, and the outbound write buffer is full
2251 *
2252 * @param[in] treq to signal state change for.
2253 */
2254void trunk_request_signal_cancel_partial(trunk_request_t *treq)
2255{
2256 if (!fr_cond_assert_msg(treq->pub.trunk, "treq not associated with trunk")) return;
2257
2258 if (!fr_cond_assert_msg(IN_REQUEST_CANCEL_MUX(treq->pub.trunk),
2259 "%s can only be called from within request_cancel_mux handler", __FUNCTION__)) return;
2260
2261 switch (treq->pub.state) {
2262 case TRUNK_REQUEST_STATE_CANCEL:
2263 trunk_request_enter_cancel_partial(treq);
2264 break;
2265
2266 default:
2267 return;
2268 }
2269}
2270
2271/** Signal that a remote server has been notified of the cancellation
2272 *
2273 * Called from request_cancel_mux to indicate that the datastore has been informed
2274 * that the response is no longer needed.
2275 *
2276 * @param[in] treq to signal state change for.
2277 */
2278void trunk_request_signal_cancel_sent(trunk_request_t *treq)
2279{
2280 if (!fr_cond_assert_msg(treq->pub.trunk, "treq not associated with trunk")) return;
2281
2282 if (!fr_cond_assert_msg(IN_REQUEST_CANCEL_MUX(treq->pub.trunk),
2283 "%s can only be called from within request_cancel_mux handler", __FUNCTION__)) return;
2284
2285 switch (treq->pub.state) {
2286 case TRUNK_REQUEST_STATE_CANCEL:
2287 case TRUNK_REQUEST_STATE_CANCEL_PARTIAL:
2288 trunk_request_enter_cancel_sent(treq);
2289 break;
2290
2291 default:
2292 break;
2293 }
2294}
2295
2296/** Signal that a remote server acked our cancellation
2297 *
2298 * Called from request_demux to indicate that it got an ack for the cancellation.
2299 *
2300 * @param[in] treq to signal state change for.
2301 */
2302void trunk_request_signal_cancel_complete(trunk_request_t *treq)
2303{
2304 if (!fr_cond_assert_msg(treq->pub.trunk, "treq not associated with trunk")) return;
2305
2306 if (!fr_cond_assert_msg(IN_REQUEST_DEMUX(treq->pub.trunk) || IN_REQUEST_CANCEL_MUX(treq->pub.trunk),
2307 "%s can only be called from within request_demux or request_cancel_mux handlers",
2308 __FUNCTION__)) return;
2309
2310 switch (treq->pub.state) {
2311 case TRUNK_REQUEST_STATE_CANCEL_SENT:
2312 /*
2313 * This is allowed, as we may not need to wait
2314 * for the database to ACK our cancellation
2315 * request.
2316 *
2317 * Note: TRUNK_REQUEST_STATE_CANCEL_PARTIAL
2318 * is not allowed here, as that'd mean we'd half
2319 * written the cancellation request out to the
2320 * socket, and then decided to abandon it.
2321 *
2322 * That'd leave the socket in an unusable state.
2323 */
2324 case TRUNK_REQUEST_STATE_CANCEL:
2325 trunk_request_enter_cancel_complete(treq);
2326 break;
2327
2328 default:
2329 break;
2330 }
2331}
2332
2333/** If the trunk request is freed then update the target requests
2334 *
2335 * gperftools showed calling the request free function directly was slightly faster
2336 * than using talloc_free.
2337 *
2338 * @param[in] treq_to_free request.
2339 */
2340void trunk_request_free(trunk_request_t **treq_to_free)
2341{
2342 trunk_request_t *treq = *treq_to_free;
2343 trunk_t *trunk = treq->pub.trunk;
2344
2345 if (unlikely(!treq)) return;
2346
2347 /*
2348 * The only valid states a trunk request can be
2349 * freed from.
2350 */
2351 switch (treq->pub.state) {
2352 case TRUNK_REQUEST_STATE_INIT:
2353 case TRUNK_REQUEST_STATE_UNASSIGNED:
2354 case TRUNK_REQUEST_STATE_COMPLETE:
2355 case TRUNK_REQUEST_STATE_FAILED:
2356 case TRUNK_REQUEST_STATE_CANCEL_COMPLETE:
2357 break;
2358
2359 default:
2360 if (!fr_cond_assert(0)) return;
2361 }
2362
2363 /*
2364 * Zero out the pointer to prevent double frees
2365 */
2366 *treq_to_free = NULL;
2367
2368 /*
2369 * Call the API client callback to free
2370 * any associated memory.
2371 */
2372 DO_REQUEST_FREE(treq);
2373
2374 /*
2375 * Update the last above/below target stats
2376 * We only do this when we alloc or free
2377 * connections, or on connection
2378 * state changes.
2379 */
2380 trunk_requests_per_connection(NULL, NULL, treq->pub.trunk, fr_time(), false);
2381
2382 /*
2383 * This tracks the total number of requests
2384 * allocated and not freed or returned to
2385 * the free list.
2386 */
2387 if (fr_cond_assert(trunk->pub.req_alloc > 0)) trunk->pub.req_alloc--;
2388
2389 /*
2390 * No cleanup delay, means cleanup immediately
2391 */
2392 if (!fr_time_delta_ispos(trunk->conf.req_cleanup_delay)) {
2393 treq->pub.state = TRUNK_REQUEST_STATE_INIT;
2394
2395#ifndef NDEBUG
2396 /*
2397 * Ensure anything parented off the treq
2398 * is freed. We do this to trigger
2399 * the destructors for the log entries.
2400 */
2401 talloc_free_children(treq);
2402
2403 /*
2404 * State log should now be empty as entries
2405 * remove themselves from the dlist
2406 * on free.
2407 */
2408 fr_assert_msg(fr_dlist_num_elements(&treq->log) == 0,
2409 "Should have 0 remaining log entries, have %u", fr_dlist_num_elements(&treq->log));
2410#endif
2411
2412 talloc_free(treq);
2413 return;
2414 }
2415
2416 /*
2417 * Ensure anything parented off the treq
2418 * is freed.
2419 */
2420 talloc_free_children(treq);
2421
2422#ifndef NDEBUG
2423 /*
2424 * State log should now be empty as entries
2425 * remove themselves from the dlist
2426 * on free.
2427 */
2428 fr_assert_msg(fr_dlist_num_elements(&treq->log) == 0,
2429 "Should have 0 remaining log entries, have %u", fr_dlist_num_elements(&treq->log));
2430#endif
2431
2432 /*
2433 *
2434 * Return the trunk request back to the init state.
2435 */
2436 *treq = (trunk_request_t){
2437 .pub = {
2438 .state = TRUNK_REQUEST_STATE_INIT,
2439 .trunk = treq->pub.trunk,
2440 },
2441 .cancel_reason = TRUNK_CANCEL_REASON_NONE,
2442 .last_freed = fr_time(),
2443#ifndef NDEBUG
2444 .log = treq->log /* Keep the list head, to save reinitialisation */
2445#endif
2446 };
2447
2448 /*
2449 * Insert at the head, so that we can free
2450 * requests that have been unused for N
2451 * seconds from the tail.
2452 */
2453 fr_dlist_insert_tail(&trunk->free_requests, treq);
2454}
2455
2456/** Actually free the trunk request
2457 *
2458 */
2459static int _trunk_request_free(trunk_request_t *treq)
2460{
2461 trunk_t *trunk = treq->pub.trunk;
2462
2463 switch (treq->pub.state) {
2464 case TRUNK_REQUEST_STATE_INIT:
2465 case TRUNK_REQUEST_STATE_UNASSIGNED:
2466 break;
2467
2468 default:
2469 fr_assert(0);
2470 break;
2471 }
2472
2473 fr_dlist_remove(&trunk->free_requests, treq);
2474
2475 return 0;
2476}
2477
2478/** (Pre-)Allocate a new trunk request
2479 *
2480 * If trunk->conf.req_pool_headers or trunk->conf.req_pool_size are not zero then the
2481 * request will be a talloc pool, which can be used to hold the preq.
2482 *
2483 * @note Do not use MEM to check the result of this allocated as it may fail for
2484 * non-fatal reasons.
2485 *
2486 * @param[in] trunk to add request to.
2487 * @param[in] request to wrap in a trunk request (treq).
2488 * @return
2489 * - A newly allocated request.
2490 * - NULL if too many requests are allocated.
2491 */
2492trunk_request_t *trunk_request_alloc(trunk_t *trunk, request_t *request)
2493{
2494 trunk_request_t *treq;
2495
2496 /*
2497 * The number of treqs currently allocated
2498 * exceeds the maximum number allowed.
2499 */
2500 if (trunk->conf.max_req_per_conn && trunk->conf.max) {
2501 uint64_t limit;
2502
2503 limit = (uint64_t) trunk->conf.max_req_per_conn * trunk->conf.max;
2504 if (trunk->pub.req_alloc >= (limit + trunk->conf.max_backlog)) {
2505 RATE_LIMIT_LOCAL_ROPTIONAL(&trunk->limit_max_requests_alloc_log,
2506 RWARN, WARN, "Refusing to alloc requests - "
2507 "Limit of %"PRIu64" (max = %u * per_connection_max = %u) "
2508 "plus %u backlog requests reached",
2509 limit, trunk->conf.max, trunk->conf.max_req_per_conn,
2510 trunk->conf.max_backlog);
2511 return NULL;
2512 }
2513 }
2514
2515 /*
2516 * Allocate or reuse an existing request
2517 */
2518 treq = fr_dlist_head(&trunk->free_requests);
2519 if (treq) {
2520 fr_dlist_remove(&trunk->free_requests, treq);
2521 fr_assert(treq->pub.state == TRUNK_REQUEST_STATE_INIT);
2522 fr_assert(treq->pub.trunk == trunk);
2523 fr_assert(treq->pub.tconn == NULL);
2524 fr_assert(treq->cancel_reason == TRUNK_CANCEL_REASON_NONE);
2525 fr_assert(fr_time_gt(treq->last_freed, fr_time_wrap(0)));
2526 trunk->pub.req_alloc_reused++;
2527 } else {
2528 MEM(treq = talloc_pooled_object(trunk, trunk_request_t,
2529 trunk->conf.req_pool_headers, trunk->conf.req_pool_size));
2530 talloc_set_destructor(treq, _trunk_request_free);
2531
2532 *treq = (trunk_request_t){
2533 .pub = {
2534 .state = TRUNK_REQUEST_STATE_INIT,
2535 .trunk = trunk
2536 },
2537 .cancel_reason = TRUNK_CANCEL_REASON_NONE
2538 };
2539 trunk->pub.req_alloc_new++;
2540#ifndef NDEBUG
2541 fr_dlist_init(&treq->log, trunk_request_state_log_t, entry);
2542#endif
2543 }
2544
2545 trunk->pub.req_alloc++;
2546 treq->id = atomic_fetch_add_explicit(&request_counter, 1, memory_order_relaxed);
2547 /* heap_id - initialised when treq inserted into pending */
2548 /* list - empty */
2549 /* preq - populated later */
2550 /* rctx - populated later */
2551 treq->pub.request = request;
2552
2553 return treq;
2554}
2555
2556/** Enqueue a request that needs data written to the trunk
2557 *
2558 * When a request_t * needs to make an asynchronous request to an external datastore
2559 * it should call this function, specifying a preq (protocol request) containing
2560 * the data necessary to request information from the external datastore, and an
2561 * rctx (resume ctx) used to hold the decoded response and/or any error codes.
2562 *
2563 * After a treq is successfully enqueued it will either be assigned immediately
2564 * to the pending queue of a connection, or if no connections are available,
2565 * (depending on the trunk configuration) the treq will be placed in the trunk's
2566 * global backlog.
2567 *
2568 * After receiving a positive return code from this function the caller should
2569 * immediately yield, to allow the various timers and I/O handlers that drive tconn
2570 * (trunk connection) and treq state changes to be called.
2571 *
2572 * When a tconn becomes writable (or the trunk is configured to be always writable)
2573 * the #trunk_request_mux_t callback will be called to dequeue, encode and
2574 * send any pending requests for that tconn. The #trunk_request_mux_t callback
2575 * is also responsible for tracking the outbound requests to allow the
2576 * #trunk_request_demux_t callback to match inbound responses with the original
2577 * treq. Once the #trunk_request_mux_t callback is done processing the treq
2578 * it signals what state the treq should enter next using one of the
2579 * trunk_request_signal_* functions.
2580 *
2581 * When a tconn becomes readable the user specified #trunk_request_demux_t
2582 * callback is called to process any responses, match them with the original treq.
2583 * and signal what state they should enter next using one of the
2584 * trunk_request_signal_* functions.
2585 *
2586 * @param[in,out] treq_out A trunk request handle. If the memory pointed to
2587 * is NULL, a new treq will be allocated.
2588 * Otherwise treq should point to memory allocated
2589 * with trunk_request_alloc.
2590 * @param[in] trunk to enqueue request on.
2591 * @param[in] request to enqueue.
2592 * @param[in] preq Protocol request to write out. Will be freed when
2593 * treq is freed. Should ideally be parented by the
2594 * treq if possible.
2595 * Use #trunk_request_alloc for pre-allocation of
2596 * the treq.
2597 * @param[in] rctx The resume context to write any result to.
2598 * @return
2599 * - TRUNK_ENQUEUE_OK.
2600 * - TRUNK_ENQUEUE_IN_BACKLOG.
2601 * - TRUNK_ENQUEUE_NO_CAPACITY.
2602 * - TRUNK_ENQUEUE_DST_UNAVAILABLE
2603 * - TRUNK_ENQUEUE_FAIL
2604 */
2605trunk_enqueue_t trunk_request_enqueue(trunk_request_t **treq_out, trunk_t *trunk,
2606 request_t *request, void *preq, void *rctx)
2607{
2608 trunk_connection_t *tconn = NULL;
2609 trunk_request_t *treq;
2610 trunk_enqueue_t ret;
2611
2612 if (!fr_cond_assert_msg(!IN_HANDLER(trunk),
2613 "%s cannot be called within a handler", __FUNCTION__)) return TRUNK_ENQUEUE_FAIL;
2614
2615 if (!fr_cond_assert_msg(!*treq_out || ((*treq_out)->pub.state == TRUNK_REQUEST_STATE_INIT),
2616 "%s requests must be in \"init\" state", __FUNCTION__)) return TRUNK_ENQUEUE_FAIL;
2617
2618 /*
2619 * If delay_start was set, we may need
2620 * to insert the timer for the connection manager.
2621 */
2622 if (unlikely(!trunk->started)) {
2623 if (trunk_start(trunk) < 0) return TRUNK_ENQUEUE_FAIL;
2624 }
2625
2626 ret = trunk_request_check_enqueue(&tconn, trunk, request);
2627 switch (ret) {
2628 case TRUNK_ENQUEUE_OK:
2629 if (*treq_out) {
2630 treq = *treq_out;
2631 } else {
2632 *treq_out = treq = trunk_request_alloc(trunk, request);
2633 if (!treq) return TRUNK_ENQUEUE_FAIL;
2634 }
2635 treq->pub.preq = preq;
2636 treq->pub.rctx = rctx;
2637 if (trunk->conf.always_writable) {
2638 connection_signals_pause(tconn->pub.conn);
2639 trunk_request_enter_pending(treq, tconn, true);
2640 trunk_connection_writable(tconn);
2641 connection_signals_resume(tconn->pub.conn);
2642 } else {
2643 trunk_request_enter_pending(treq, tconn, true);
2644 }
2645 break;
2646
2647 case TRUNK_ENQUEUE_IN_BACKLOG:
2648 if (*treq_out) {
2649 treq = *treq_out;
2650 } else {
2651 *treq_out = treq = trunk_request_alloc(trunk, request);
2652 if (!treq) return TRUNK_ENQUEUE_FAIL;
2653 }
2654 treq->pub.preq = preq;
2655 treq->pub.rctx = rctx;
2656 trunk_request_enter_backlog(treq, true);
2657 break;
2658
2659 default:
2660 /*
2661 * If a trunk request was provided
2662 * populate the preq and rctx fields
2663 * so that if it's freed with
2664 * trunk_request_free, the free
2665 * function works as intended.
2666 */
2667 if (*treq_out) {
2668 treq = *treq_out;
2669 treq->pub.preq = preq;
2670 treq->pub.rctx = rctx;
2671 }
2672 return ret;
2673 }
2674
2675 return ret;
2676}
2677
2678/** Re-enqueue a request on the same connection
2679 *
2680 * If the treq has been sent, we assume that we're being signalled to requeue
2681 * because something outside of the trunk API has determined that a retransmission
2682 * is required. The easiest way to perform that retransmission is to clean up
2683 * any tracking information for the request, and the requeue it for transmission.
2684 *
2685 * IF re-queueing fails, the request will enter the fail state. It should not be
2686 * accessed if this occurs.
2687 *
2688 * @param[in] treq to requeue (retransmit).
2689 * @return
2690 * - TRUNK_ENQUEUE_OK.
2691 * - TRUNK_ENQUEUE_DST_UNAVAILABLE - Connection cannot service requests.
2692 * - TRUNK_ENQUEUE_FAIL - Request isn't in a valid state to be reassigned.
2693 */
2694trunk_enqueue_t trunk_request_requeue(trunk_request_t *treq)
2695{
2696 trunk_connection_t *tconn = treq->pub.tconn; /* Existing conn */
2697
2698 if (!tconn) return TRUNK_ENQUEUE_FAIL;
2699
2700 if (!IS_PROCESSING(tconn)) {
2701 trunk_request_enter_failed(treq);
2702 return TRUNK_ENQUEUE_DST_UNAVAILABLE;
2703 }
2704
2705 switch (treq->pub.state) {
2706 case TRUNK_REQUEST_STATE_PARTIAL:
2707 case TRUNK_REQUEST_STATE_SENT:
2708 case TRUNK_REQUEST_STATE_REAPABLE:
2709 connection_signals_pause(tconn->pub.conn);
2710 trunk_request_enter_cancel(treq, TRUNK_CANCEL_REASON_REQUEUE);
2711 trunk_request_enter_pending(treq, tconn, false);
2712 if (treq->pub.trunk->conf.always_writable) {
2713 trunk_connection_writable(tconn);
2714 }
2715 connection_signals_resume(tconn->pub.conn);
2716 break;
2717
2718 case TRUNK_REQUEST_STATE_BACKLOG: /* Do nothing.... */
2719 case TRUNK_REQUEST_STATE_PENDING: /* Do nothing.... */
2720 break;
2721
2722 default:
2723 trunk_request_enter_failed(treq);
2724 return TRUNK_ENQUEUE_FAIL;
2725 }
2726
2727 return TRUNK_ENQUEUE_OK;
2728}
2729
2730/** Enqueue additional requests on a specific connection
2731 *
2732 * This may be used to create a series of requests on a single connection, or to generate
2733 * in-band status checks.
2734 *
2735 * @note If conf->always_writable, then the muxer will be called immediately. The caller
2736 * must be able to handle multiple calls to its muxer gracefully.
2737 *
2738 * @param[in,out] treq_out A trunk request handle. If the memory pointed to
2739 * is NULL, a new treq will be allocated.
2740 * Otherwise treq should point to memory allocated
2741 * with trunk_request_alloc.
2742 * @param[in] tconn to enqueue request on.
2743 * @param[in] request to enqueue.
2744 * @param[in] preq Protocol request to write out. Will be freed when
2745 * treq is freed. Should ideally be parented by the
2746 * treq if possible.
2747 * Use #trunk_request_alloc for pre-allocation of
2748 * the treq.
2749 * @param[in] rctx The resume context to write any result to.
2750 * @param[in] ignore_limits Ignore max_req_per_conn. Useful to force status
2751 * checks through even if the connection is at capacity.
2752 * Will also allow enqueuing on "inactive", "draining",
2753 * "draining-to-free" connections.
2754 * @return
2755 * - TRUNK_ENQUEUE_OK.
2756 * - TRUNK_ENQUEUE_NO_CAPACITY - At max_req_per_conn_limit
2757 * - TRUNK_ENQUEUE_DST_UNAVAILABLE - Connection cannot service requests.
2758 */
2759trunk_enqueue_t trunk_request_enqueue_on_conn(trunk_request_t **treq_out, trunk_connection_t *tconn,
2760 request_t *request, void *preq, void *rctx,
2761 bool ignore_limits)
2762{
2763 trunk_request_t *treq;
2764 trunk_t *trunk = tconn->pub.trunk;
2765
2766 if (!fr_cond_assert_msg(!*treq_out || ((*treq_out)->pub.state == TRUNK_REQUEST_STATE_INIT),
2767 "%s requests must be in \"init\" state", __FUNCTION__)) return TRUNK_ENQUEUE_FAIL;
2768
2769 if (!IS_SERVICEABLE(tconn)) return TRUNK_ENQUEUE_DST_UNAVAILABLE;
2770
2771 /*
2772 * Limits check
2773 */
2774 if (!ignore_limits) {
2775 if (trunk->conf.max_req_per_conn &&
2776 (trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_ALL) >=
2777 trunk->conf.max_req_per_conn)) return TRUNK_ENQUEUE_NO_CAPACITY;
2778
2779 if (tconn->pub.state != TRUNK_CONN_ACTIVE) return TRUNK_ENQUEUE_NO_CAPACITY;
2780 }
2781
2782 if (*treq_out) {
2783 treq = *treq_out;
2784 } else {
2785 MEM(*treq_out = treq = trunk_request_alloc(trunk, request));
2786 }
2787
2788 treq->pub.preq = preq;
2789 treq->pub.rctx = rctx;
2790 treq->bound_to_conn = true; /* Don't let the request be transferred */
2791
2792 if (trunk->conf.always_writable) {
2793 connection_signals_pause(tconn->pub.conn);
2794 trunk_request_enter_pending(treq, tconn, true);
2795 trunk_connection_writable(tconn);
2796 connection_signals_resume(tconn->pub.conn);
2797 } else {
2798 trunk_request_enter_pending(treq, tconn, true);
2799 }
2800
2801 return TRUNK_ENQUEUE_OK;
2802}
2803
2804#ifndef NDEBUG
2805/** Used for sanity checks to ensure all log entries have been freed
2806 *
2807 */
2808static int _state_log_entry_free(trunk_request_state_log_t *slog)
2809{
2810 fr_dlist_remove(slog->log_head, slog);
2811
2812 return 0;
2813}
2814
2815void trunk_request_state_log_entry_add(char const *function, int line,
2816 trunk_request_t *treq, trunk_request_state_t new)
2817{
2818 trunk_request_state_log_t *slog = NULL;
2819
2820 if (fr_dlist_num_elements(&treq->log) >= TRUNK_REQUEST_STATE_LOG_MAX) {
2821 slog = fr_dlist_head(&treq->log);
2822 fr_assert_msg(slog, "slog list head NULL but element counter was %u",
2823 fr_dlist_num_elements(&treq->log));
2824 (void)fr_dlist_remove(&treq->log, slog); /* Returns NULL when removing the list head */
2825 memset(slog, 0, sizeof(*slog));
2826 } else {
2827 MEM(slog = talloc_zero(treq, trunk_request_state_log_t));
2828 talloc_set_destructor(slog, _state_log_entry_free);
2829 }
2830
2831 slog->log_head = &treq->log;
2832 slog->from = treq->pub.state;
2833 slog->to = new;
2834 slog->function = function;
2835 slog->line = line;
2836 if (treq->pub.tconn) {
2837 slog->tconn = treq->pub.tconn;
2838 slog->tconn_id = treq->pub.tconn->pub.conn->id;
2839 slog->tconn_state = treq->pub.tconn->pub.state;
2840 }
2841
2842 fr_dlist_insert_tail(&treq->log, slog);
2843
2844}
2845
2846void trunk_request_state_log(fr_log_t const *log, fr_log_type_t log_type, char const *file, int line,
2847 trunk_request_t const *treq)
2848{
2849 trunk_request_state_log_t *slog = NULL;
2850
2851 int i;
2852
2853 for (slog = fr_dlist_head(&treq->log), i = 0;
2854 slog;
2855 slog = fr_dlist_next(&treq->log, slog), i++) {
2856 fr_log(log, log_type, file, line, "[%u] %s:%i - in conn %"PRIu64" in state %s - %s -> %s",
2857 i, slog->function, slog->line,
2858 slog->tconn_id,
2859 slog->tconn ? fr_table_str_by_value(trunk_connection_states,
2860 slog->tconn_state, "<INVALID>") : "none",
2861 fr_table_str_by_value(trunk_request_states, slog->from, "<INVALID>"),
2862 fr_table_str_by_value(trunk_request_states, slog->to, "<INVALID>"));
2863 }
2864}
2865#endif
2866
2867/** Return the count number of connections in the specified states
2868 *
2869 * @param[in] trunk to retrieve counts for.
2870 * @param[in] conn_state One or more #trunk_connection_state_t states or'd together.
2871 * @return The number of connections in the specified states.
2872 */
2873uint16_t trunk_connection_count_by_state(trunk_t *trunk, int conn_state)
2874{
2875 uint16_t count = 0;
2876
2877 if (conn_state & TRUNK_CONN_INIT) count += fr_dlist_num_elements(&trunk->init);
2878 if (conn_state & TRUNK_CONN_CONNECTING) count += fr_dlist_num_elements(&trunk->connecting);
2879 if (conn_state & TRUNK_CONN_ACTIVE) count += fr_minmax_heap_num_elements(trunk->active);
2880 if (conn_state & TRUNK_CONN_FULL) count += fr_dlist_num_elements(&trunk->full);
2881 if (conn_state & TRUNK_CONN_INACTIVE) count += fr_dlist_num_elements(&trunk->inactive);
2882 if (conn_state & TRUNK_CONN_INACTIVE_DRAINING) count += fr_dlist_num_elements(&trunk->inactive_draining);
2883 if (conn_state & TRUNK_CONN_CLOSED) count += fr_dlist_num_elements(&trunk->closed);
2884 if (conn_state & TRUNK_CONN_DRAINING) count += fr_dlist_num_elements(&trunk->draining);
2885 if (conn_state & TRUNK_CONN_DRAINING_TO_FREE) count += fr_dlist_num_elements(&trunk->draining_to_free);
2886
2887 return count;
2888}
2889
2890/** Return the count number of requests associated with a trunk connection
2891 *
2892 * @param[in] tconn to return request count for.
2893 * @param[in] req_state One or more request states or'd together.
2894 *
2895 * @return The number of requests in the specified states, associated with a tconn.
2896 */
2897uint32_t trunk_request_count_by_connection(trunk_connection_t const *tconn, int req_state)
2898{
2899 uint32_t count = 0;
2900
2901 if (req_state & TRUNK_REQUEST_STATE_PENDING) count += fr_heap_num_elements(tconn->pending);
2902 if (req_state & TRUNK_REQUEST_STATE_PARTIAL) count += tconn->partial ? 1 : 0;
2903 if (req_state & TRUNK_REQUEST_STATE_SENT) count += fr_dlist_num_elements(&tconn->sent);
2904 if (req_state & TRUNK_REQUEST_STATE_REAPABLE) count += fr_dlist_num_elements(&tconn->reapable);
2905 if (req_state & TRUNK_REQUEST_STATE_CANCEL) count += fr_dlist_num_elements(&tconn->cancel);
2906 if (req_state & TRUNK_REQUEST_STATE_CANCEL_PARTIAL) count += tconn->cancel_partial ? 1 : 0;
2907 if (req_state & TRUNK_REQUEST_STATE_CANCEL_SENT) count += fr_dlist_num_elements(&tconn->cancel_sent);
2908
2909 return count;
2910}
2911
2912/** Automatically mark a connection as full
2913 *
2914 * @param[in] tconn to potentially mark as full.
2915 */
2916static inline void trunk_connection_auto_full(trunk_connection_t *tconn)
2917{
2918 trunk_t *trunk = tconn->pub.trunk;
2919 uint32_t count;
2920
2921 if (tconn->pub.state != TRUNK_CONN_ACTIVE) return;
2922
2923 /*
2924 * Enforces max_req_per_conn
2925 */
2926 if (trunk->conf.max_req_per_conn > 0) {
2927 count = trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_ALL);
2928 if (count >= trunk->conf.max_req_per_conn) trunk_connection_enter_full(tconn);
2929 }
2930}
2931
2932/** Return whether a trunk connection should currently be considered full
2933 *
2934 * @param[in] tconn to check.
2935 * @return
2936 * - true if the connection is full.
2937 * - false if the connection is not full.
2938 */
2939static inline bool trunk_connection_is_full(trunk_connection_t *tconn)
2940{
2941 trunk_t *trunk = tconn->pub.trunk;
2942 uint32_t count;
2943
2944 /*
2945 * Enforces max_req_per_conn
2946 */
2947 count = trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_ALL);
2948 if ((trunk->conf.max_req_per_conn == 0) || (count < trunk->conf.max_req_per_conn)) return false;
2949
2950 return true;
2951}
2952
2953/** Automatically mark a connection as active or reconnect it
2954 *
2955 * @param[in] tconn to potentially mark as active or reconnect.
2956 */
2957static inline void trunk_connection_auto_unfull(trunk_connection_t *tconn)
2958{
2959 if (tconn->pub.state != TRUNK_CONN_FULL) return;
2960
2961 /*
2962 * Enforces max_req_per_conn
2963 */
2964 if (!trunk_connection_is_full(tconn)) trunk_connection_enter_active(tconn);
2965}
2966
2967/** A connection is readable. Call the request_demux function to read pending requests
2968 *
2969 */
2970static inline void trunk_connection_readable(trunk_connection_t *tconn)
2971{
2972 trunk_t *trunk = tconn->pub.trunk;
2973
2974 DO_REQUEST_DEMUX(tconn);
2975}
2976
2977/** A connection is writable. Call the request_mux function to write pending requests
2978 *
2979 */
2980static inline void trunk_connection_writable(trunk_connection_t *tconn)
2981{
2982 trunk_t *trunk = tconn->pub.trunk;
2983
2984 /*
2985 * Call the cancel_sent function (if we have one)
2986 * to inform a backend datastore we no longer
2987 * care about the result
2988 */
2989 if (trunk->funcs.request_cancel_mux && trunk_request_count_by_connection(tconn,
2990 TRUNK_REQUEST_STATE_CANCEL |
2991 TRUNK_REQUEST_STATE_CANCEL_PARTIAL)) {
2992 DO_REQUEST_CANCEL_MUX(tconn);
2993 }
2994 if (!trunk_request_count_by_connection(tconn,
2995 TRUNK_REQUEST_STATE_PENDING |
2996 TRUNK_REQUEST_STATE_PARTIAL)) return;
2997 DO_REQUEST_MUX(tconn);
2998}
2999
3000/** Update the registrations for I/O events we're interested in
3001 *
3002 */
3003static void trunk_connection_event_update(trunk_connection_t *tconn)
3004{
3005 trunk_t *trunk = tconn->pub.trunk;
3006 trunk_connection_event_t events = TRUNK_CONN_EVENT_NONE;
3007
3008 switch (tconn->pub.state) {
3009 /*
3010 * We only register I/O events if the trunk connection is
3011 * in one of these states.
3012 *
3013 * For the other states the trunk shouldn't be processing
3014 * requests.
3015 */
3016 case TRUNK_CONN_ACTIVE:
3017 case TRUNK_CONN_FULL:
3018 case TRUNK_CONN_INACTIVE:
3019 case TRUNK_CONN_INACTIVE_DRAINING:
3020 case TRUNK_CONN_DRAINING:
3021 case TRUNK_CONN_DRAINING_TO_FREE:
3022 /*
3023 * If the connection is always writable,
3024 * then we don't care about write events.
3025 */
3026 if (!trunk->conf.always_writable &&
3027 trunk_request_count_by_connection(tconn,
3028 TRUNK_REQUEST_STATE_PARTIAL |
3029 TRUNK_REQUEST_STATE_PENDING |
3030 (trunk->funcs.request_cancel_mux ?
3031 TRUNK_REQUEST_STATE_CANCEL |
3032 TRUNK_REQUEST_STATE_CANCEL_PARTIAL : 0)) > 0) {
3033 events |= TRUNK_CONN_EVENT_WRITE;
3034 }
3035
3036 if (trunk_request_count_by_connection(tconn,
3037 TRUNK_REQUEST_STATE_SENT |
3038 (trunk->funcs.request_cancel_mux ?
3039 TRUNK_REQUEST_STATE_CANCEL_SENT : 0)) > 0) {
3040 events |= TRUNK_CONN_EVENT_READ;
3041 }
3042 break;
3043
3044 default:
3045 break;
3046 }
3047
3048 if (tconn->events != events) {
3049 /*
3050 * There may be a fatal error which results
3051 * in the connection being freed.
3052 *
3053 * Stop that from happening until after
3054 * we're done using it.
3055 */
3056 connection_signals_pause(tconn->pub.conn);
3057 DO_CONNECTION_NOTIFY(tconn, events);
3058 tconn->events = events;
3059 connection_signals_resume(tconn->pub.conn);
3060 }
3061}
3062
3063/** Remove a trunk connection from whichever list it's currently in
3064 *
3065 * @param[in] tconn to remove.
3066 */
3067static void trunk_connection_remove(trunk_connection_t *tconn)
3068{
3069 trunk_t *trunk = tconn->pub.trunk;
3070
3071 switch (tconn->pub.state) {
3072 case TRUNK_CONN_ACTIVE:
3073 {
3074 int ret;
3075
3076 ret = fr_minmax_heap_extract(trunk->active, tconn);
3077 if (!fr_cond_assert_msg(ret == 0, "Failed extracting conn from active heap: %s", fr_strerror())) return;
3078 }
3079 return;
3080
3081 case TRUNK_CONN_INIT:
3082 fr_dlist_remove(&trunk->init, tconn);
3083 break;
3084
3085 case TRUNK_CONN_CONNECTING:
3086 fr_dlist_remove(&trunk->connecting, tconn);
3087 return;
3088
3089 case TRUNK_CONN_CLOSED:
3090 fr_dlist_remove(&trunk->closed, tconn);
3091 return;
3092
3093 case TRUNK_CONN_FULL:
3094 fr_dlist_remove(&trunk->full, tconn);
3095 return;
3096
3097 case TRUNK_CONN_INACTIVE:
3098 fr_dlist_remove(&trunk->inactive, tconn);
3099 return;
3100
3101 case TRUNK_CONN_INACTIVE_DRAINING:
3102 fr_dlist_remove(&trunk->inactive_draining, tconn);
3103 return;
3104
3105 case TRUNK_CONN_DRAINING:
3106 fr_dlist_remove(&trunk->draining, tconn);
3107 return;
3108
3109 case TRUNK_CONN_DRAINING_TO_FREE:
3110 fr_dlist_remove(&trunk->draining_to_free, tconn);
3111 return;
3112
3113 case TRUNK_CONN_HALTED:
3114 return;
3115 }
3116}
3117
3118/** Transition a connection to the full state
3119 *
3120 * Called whenever a trunk connection is at the maximum number of requests.
3121 * Removes the connection from the connected heap, and places it in the full list.
3122 */
3123static void trunk_connection_enter_full(trunk_connection_t *tconn)
3124{
3125 trunk_t *trunk = tconn->pub.trunk;
3126
3127 switch (tconn->pub.state) {
3128 case TRUNK_CONN_ACTIVE:
3129 trunk_connection_remove(tconn);
3130 break;
3131
3132 default:
3133 CONN_BAD_STATE_TRANSITION(TRUNK_CONN_FULL);
3134 }
3135
3136 fr_dlist_insert_head(&trunk->full, tconn);
3137 CONN_STATE_TRANSITION(TRUNK_CONN_FULL, DEBUG2);
3138}
3139
3140/** Transition a connection to the inactive state
3141 *
3142 * Called whenever the API client wants to stop new requests being enqueued
3143 * on a trunk connection.
3144 */
3145static void trunk_connection_enter_inactive(trunk_connection_t *tconn)
3146{
3147 trunk_t *trunk = tconn->pub.trunk;
3148
3149 switch (tconn->pub.state) {
3150 case TRUNK_CONN_ACTIVE:
3151 case TRUNK_CONN_FULL:
3152 trunk_connection_remove(tconn);
3153 break;
3154
3155 default:
3156 CONN_BAD_STATE_TRANSITION(TRUNK_CONN_INACTIVE);
3157 }
3158
3159 fr_dlist_insert_head(&trunk->inactive, tconn);
3160 CONN_STATE_TRANSITION(TRUNK_CONN_INACTIVE, DEBUG2);
3161}
3162
3163/** Transition a connection to the inactive-draining state
3164 *
3165 * Called whenever the trunk manager wants to drain an inactive connection
3166 * of its requests.
3167 */
3168static void trunk_connection_enter_inactive_draining(trunk_connection_t *tconn)
3169{
3170 trunk_t *trunk = tconn->pub.trunk;
3171
3172 switch (tconn->pub.state) {
3173 case TRUNK_CONN_INACTIVE:
3174 case TRUNK_CONN_DRAINING:
3175 trunk_connection_remove(tconn);
3176 break;
3177
3178 default:
3179 CONN_BAD_STATE_TRANSITION(TRUNK_CONN_INACTIVE_DRAINING);
3180 }
3181
3182 fr_dlist_insert_head(&trunk->inactive_draining, tconn);
3183 CONN_STATE_TRANSITION(TRUNK_CONN_INACTIVE_DRAINING, INFO);
3184
3185 /*
3186 * Immediately re-enqueue all pending
3187 * requests, so the connection is drained
3188 * quicker.
3189 */
3190 trunk_connection_requests_requeue_priv(tconn, TRUNK_REQUEST_STATE_PENDING, 0, false);
3191}
3192
3193/** Transition a connection to the draining state
3194 *
3195 * Removes the connection from the active heap so it won't be assigned any new
3196 * connections.
3197 */
3198static void trunk_connection_enter_draining(trunk_connection_t *tconn)
3199{
3200 trunk_t *trunk = tconn->pub.trunk;
3201
3202 switch (tconn->pub.state) {
3203 case TRUNK_CONN_ACTIVE:
3204 case TRUNK_CONN_FULL:
3205 case TRUNK_CONN_INACTIVE:
3206 case TRUNK_CONN_INACTIVE_DRAINING:
3207 trunk_connection_remove(tconn);
3208 break;
3209
3210 default:
3211 CONN_BAD_STATE_TRANSITION(TRUNK_CONN_DRAINING);
3212 }
3213
3214 fr_dlist_insert_head(&trunk->draining, tconn);
3215 CONN_STATE_TRANSITION(TRUNK_CONN_DRAINING, INFO);
3216
3217 /*
3218 * Immediately re-enqueue all pending
3219 * requests, so the connection is drained
3220 * quicker.
3221 */
3222 trunk_connection_requests_requeue_priv(tconn, TRUNK_REQUEST_STATE_PENDING, 0, false);
3223}
3224
3225/** Transition a connection to the draining-to-reconnect state
3226 *
3227 * Removes the connection from the active heap so it won't be assigned any new
3228 * connections.
3229 */
3230static void trunk_connection_enter_draining_to_free(trunk_connection_t *tconn)
3231{
3232 trunk_t *trunk = tconn->pub.trunk;
3233
3234 FR_TIMER_DISARM(tconn->lifetime_ev);
3235
3236 switch (tconn->pub.state) {
3237 case TRUNK_CONN_ACTIVE:
3238 case TRUNK_CONN_FULL:
3239 case TRUNK_CONN_INACTIVE:
3240 case TRUNK_CONN_INACTIVE_DRAINING:
3241 case TRUNK_CONN_DRAINING:
3242 trunk_connection_remove(tconn);
3243 break;
3244
3245 default:
3246 CONN_BAD_STATE_TRANSITION(TRUNK_CONN_DRAINING_TO_FREE);
3247 }
3248
3249 fr_dlist_insert_head(&trunk->draining_to_free, tconn);
3250 CONN_STATE_TRANSITION(TRUNK_CONN_DRAINING_TO_FREE, INFO);
3251
3252 /*
3253 * Immediately re-enqueue all pending
3254 * requests, so the connection is drained
3255 * quicker.
3256 */
3257 trunk_connection_requests_requeue_priv(tconn, TRUNK_REQUEST_STATE_PENDING, 0, false);
3258}
3259
3260
3261/** Transition a connection back to the active state
3262 *
3263 * This should only be called on a connection which is in the full state,
3264 * inactive state, draining state or connecting state.
3265 */
3266static void trunk_connection_enter_active(trunk_connection_t *tconn)
3267{
3268 trunk_t *trunk = tconn->pub.trunk;
3269 int ret;
3270
3271 switch (tconn->pub.state) {
3272 case TRUNK_CONN_FULL:
3273 case TRUNK_CONN_INACTIVE:
3274 case TRUNK_CONN_INACTIVE_DRAINING:
3275 case TRUNK_CONN_DRAINING:
3276 trunk_connection_remove(tconn);
3277 break;
3278
3279 case TRUNK_CONN_INIT:
3280 case TRUNK_CONN_CONNECTING:
3281 trunk_connection_remove(tconn);
3282 fr_assert(trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_ALL) == trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_PENDING));
3283 break;
3284
3285 default:
3286 CONN_BAD_STATE_TRANSITION(TRUNK_CONN_ACTIVE);
3287 }
3288
3289 ret = fr_minmax_heap_insert(trunk->active, tconn); /* re-insert into the active heap*/
3290 if (!fr_cond_assert_msg(ret == 0, "Failed inserting connection into active heap: %s", fr_strerror())) {
3291 trunk_connection_enter_inactive_draining(tconn);
3292 return;
3293 }
3294
3295 CONN_STATE_TRANSITION(TRUNK_CONN_ACTIVE, DEBUG2);
3296
3297 /*
3298 * Reorder the connections
3299 */
3300 CONN_REORDER(tconn);
3301
3302 /*
3303 * Rebalance requests
3304 */
3305 trunk_rebalance(trunk);
3306
3307 /*
3308 * We place requests into the backlog
3309 * because there were no connections
3310 * available to handle them.
3311 *
3312 * If a connection has become active
3313 * chances are those backlogged requests
3314 * can now be enqueued, so try and do
3315 * that now.
3316 *
3317 * If there's requests sitting in the
3318 * backlog indefinitely, it's because
3319 * they were inserted there erroneously
3320 * when there were active connections
3321 * which could have handled them.
3322 */
3323 trunk_backlog_drain(trunk);
3324}
3325
3326/** Connection transitioned to the the init state
3327 *
3328 * Reflect the connection state change in the lists we use to track connections.
3329 *
3330 * @note This function is only called from the connection API as a watcher.
3331 *
3332 * @param[in] conn The connection which changes state.
3333 * @param[in] prev The connection is was in.
3334 * @param[in] state The connection is now in.
3335 * @param[in] uctx The trunk_connection_t wrapping the connection.
3336 */
3337static void _trunk_connection_on_init(UNUSED connection_t *conn,
3338 UNUSED connection_state_t prev,
3339 UNUSED connection_state_t state,
3340 void *uctx)
3341{
3342 trunk_connection_t *tconn = talloc_get_type_abort(uctx, trunk_connection_t);
3343 trunk_t *trunk = tconn->pub.trunk;
3344
3345 switch (tconn->pub.state) {
3346 case TRUNK_CONN_HALTED:
3347 break;
3348
3349 case TRUNK_CONN_CLOSED:
3350 trunk_connection_remove(tconn);
3351 break;
3352
3353 default:
3354 CONN_BAD_STATE_TRANSITION(TRUNK_CONN_INIT);
3355 }
3356
3357 fr_dlist_insert_head(&trunk->init, tconn);
3358 CONN_STATE_TRANSITION(TRUNK_CONN_INIT, DEBUG2);
3359}
3360
3361/** Connection transitioned to the connecting state
3362 *
3363 * Reflect the connection state change in the lists we use to track connections.
3364 *
3365 * @note This function is only called from the connection API as a watcher.
3366 *
3367 * @param[in] conn The connection which changes state.
3368 * @param[in] prev The connection is was in.
3369 * @param[in] state The connection is now in.
3370 * @param[in] uctx The trunk_connection_t wrapping the connection.
3371 */
3372static void _trunk_connection_on_connecting(UNUSED connection_t *conn,
3373 UNUSED connection_state_t prev,
3374 UNUSED connection_state_t state,
3375 void *uctx)
3376{
3377 trunk_connection_t *tconn = talloc_get_type_abort(uctx, trunk_connection_t);
3378 trunk_t *trunk = tconn->pub.trunk;
3379
3380 switch (tconn->pub.state) {
3381 case TRUNK_CONN_INIT:
3382 case TRUNK_CONN_CLOSED:
3383 trunk_connection_remove(tconn);
3384 break;
3385
3386 default:
3387 CONN_BAD_STATE_TRANSITION(TRUNK_CONN_CONNECTING);
3388 }
3389
3390 /*
3391 * If a connection just entered the
3392 * connecting state, it should have
3393 * no requests associated with it.
3394 */
3395 fr_assert(trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_ALL) == 0);
3396
3397 fr_dlist_insert_head(&trunk->connecting, tconn); /* MUST remain a head insertion for reconnect logic */
3398 CONN_STATE_TRANSITION(TRUNK_CONN_CONNECTING, INFO);
3399}
3400
3401/** Connection transitioned to the shutdown state
3402 *
3403 * If we're not already in the draining-to-free state, transition there now.
3404 *
3405 * The idea is that if something signalled the connection to shutdown, we need
3406 * to reflect that by dequeuing any pending requests, not accepting new ones,
3407 * and waiting for the existing requests to complete.
3408 *
3409 * @note This function is only called from the connection API as a watcher.
3410 *
3411 * @param[in] conn The connection which changes state.
3412 * @param[in] prev The connection is was in.
3413 * @param[in] state The connection is now in.
3414 * @param[in] uctx The trunk_connection_t wrapping the connection.
3415 */
3416static void _trunk_connection_on_shutdown(UNUSED connection_t *conn,
3417 UNUSED connection_state_t prev,
3418 UNUSED connection_state_t state,
3419 void *uctx)
3420{
3421 trunk_connection_t *tconn = talloc_get_type_abort(uctx, trunk_connection_t);
3422
3423 switch (tconn->pub.state) {
3424 case TRUNK_CONN_DRAINING_TO_FREE: /* Do Nothing */
3425 return;
3426
3427 case TRUNK_CONN_ACTIVE: /* Transition to draining-to-free */
3428 case TRUNK_CONN_FULL:
3429 case TRUNK_CONN_INACTIVE:
3430 case TRUNK_CONN_INACTIVE_DRAINING:
3431 case TRUNK_CONN_DRAINING:
3432 break;
3433
3434 case TRUNK_CONN_INIT:
3435 case TRUNK_CONN_CONNECTING:
3436 case TRUNK_CONN_CLOSED:
3437 case TRUNK_CONN_HALTED:
3438 CONN_BAD_STATE_TRANSITION(TRUNK_CONN_DRAINING_TO_FREE);
3439 }
3440
3441 trunk_connection_enter_draining_to_free(tconn);
3442}
3443
3444/** Trigger a reconnection of the trunk connection
3445 *
3446 * @param[in] tl timer list the timer was inserted into.
3447 * @param[in] now Current time.
3448 * @param[in] uctx The tconn.
3449 */
3450static void _trunk_connection_lifetime_expire(UNUSED fr_timer_list_t *tl, UNUSED fr_time_t now, void *uctx)
3451{
3452 trunk_connection_t *tconn = talloc_get_type_abort(uctx, trunk_connection_t);
3453
3454 trunk_connection_enter_draining_to_free(tconn);
3455}
3456
3457/** Connection transitioned to the connected state
3458 *
3459 * Reflect the connection state change in the lists we use to track connections.
3460 *
3461 * @note This function is only called from the connection API as a watcher.
3462 *
3463 * @param[in] conn The connection which changes state.
3464 * @param[in] prev The connection is was in.
3465 * @param[in] state The connection is now in.
3466 * @param[in] uctx The trunk_connection_t wrapping the connection.
3467 */
3468static void _trunk_connection_on_connected(UNUSED connection_t *conn,
3469 UNUSED connection_state_t prev,
3470 UNUSED connection_state_t state,
3471 void *uctx)
3472{
3473 trunk_connection_t *tconn = talloc_get_type_abort(uctx, trunk_connection_t);
3474 trunk_t *trunk = tconn->pub.trunk;
3475
3476 /*
3477 * If a connection was just connected, it should only
3478 * have a pending list of requests. This state is found
3479 * in the rlm_radius module, which starts a new trunk,
3480 * and then immediately enqueues a request onto it. The
3481 * alternative for rlm_radius is to keep it's own queue
3482 * of pending requests before the trunk is fully
3483 * initialized. And then enqueue them onto the trunk
3484 * when the trunk is connected.
3485 *
3486 * It's instead easier (and makes more sense) to allow
3487 * the trunk to accept packets into its queue. If there
3488 * are no connections within a period of time, then the
3489 * requests will retry, or will time out.
3490 */
3491 fr_assert(trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_ALL) == trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_PENDING));
3492
3493 /*
3494 * Set here, as the active state can
3495 * be transitioned to from full and
3496 * draining too.
3497 */
3498 trunk->pub.last_connected = fr_time();
3499
3500 /*
3501 * Insert a timer to reconnect the
3502 * connection periodically.
3503 */
3504 if (fr_time_delta_ispos(trunk->conf.lifetime)) {
3505 if (fr_timer_in(tconn, trunk->el->tl, &tconn->lifetime_ev,
3506 trunk->conf.lifetime, false, _trunk_connection_lifetime_expire, tconn) < 0) {
3507 PERROR("Failed inserting connection reconnection timer event, halting connection");
3508 connection_signal_shutdown(tconn->pub.conn);
3509 return;
3510 }
3511 }
3512
3513 trunk_connection_enter_active(tconn);
3514}
3515
3516/** Connection failed after it was connected
3517 *
3518 * Reflect the connection state change in the lists we use to track connections.
3519 *
3520 * @note This function is only called from the connection API as a watcher.
3521 *
3522 * @param[in] conn The connection which changes state.
3523 * @param[in] prev The connection is was in.
3524 * @param[in] state The connection is now in.
3525 * @param[in] uctx The trunk_connection_t wrapping the connection.
3526 */
3527static void _trunk_connection_on_closed(UNUSED connection_t *conn,
3528 UNUSED connection_state_t prev,
3529 UNUSED connection_state_t state,
3530 void *uctx)
3531{
3532 trunk_connection_t *tconn = talloc_get_type_abort(uctx, trunk_connection_t);
3533 trunk_t *trunk = tconn->pub.trunk;
3534 bool need_requeue = false;
3535
3536 switch (tconn->pub.state) {
3537 case TRUNK_CONN_ACTIVE:
3538 case TRUNK_CONN_FULL:
3539 case TRUNK_CONN_INACTIVE:
3540 case TRUNK_CONN_INACTIVE_DRAINING:
3541 case TRUNK_CONN_DRAINING:
3542 case TRUNK_CONN_DRAINING_TO_FREE:
3543 need_requeue = true;
3544 trunk_connection_remove(tconn);
3545 break;
3546
3547 case TRUNK_CONN_INIT: /* Initialisation failed */
3548 case TRUNK_CONN_CONNECTING:
3549 trunk_connection_remove(tconn);
3550 fr_assert(trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_ALL) == 0);
3551 break;
3552
3553 case TRUNK_CONN_CLOSED:
3554 case TRUNK_CONN_HALTED: /* Can't move backwards? */
3555 CONN_BAD_STATE_TRANSITION(TRUNK_CONN_CLOSED);
3556 }
3557
3558 fr_dlist_insert_head(&trunk->closed, tconn); /* MUST remain a head insertion for reconnect logic */
3559 CONN_STATE_TRANSITION(TRUNK_CONN_CLOSED, INFO);
3560
3561 /*
3562 * Now *AFTER* the connection has been
3563 * removed from the active, pool
3564 * re-enqueue the requests.
3565 */
3566 if (need_requeue) trunk_connection_requests_requeue_priv(tconn, TRUNK_REQUEST_STATE_ALL, 0, true);
3567
3568 /*
3569 * There should be no requests left on this
3570 * connection. They should have all been
3571 * moved off or failed.
3572 */
3573 fr_assert(trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_ALL) == 0);
3574
3575 /*
3576 * Clear statistics and flags
3577 */
3578 tconn->sent_count = 0;
3579
3580 /*
3581 * Remove the reconnect event
3582 */
3583 if (fr_time_delta_ispos(trunk->conf.lifetime)) FR_TIMER_DELETE(&tconn->lifetime_ev);
3584
3585 /*
3586 * Remove the I/O events
3587 */
3588 trunk_connection_event_update(tconn);
3589}
3590
3591/** Connection failed
3592 *
3593 * @param[in] conn The connection which changes state.
3594 * @param[in] prev The connection is was in.
3595 * @param[in] state The connection is now in.
3596 * @param[in] uctx The trunk_connection_t wrapping the connection.
3597 */
3598static void _trunk_connection_on_failed(connection_t *conn,
3599 connection_state_t prev,
3600 connection_state_t state,
3601 void *uctx)
3602{
3603 trunk_connection_t *tconn = talloc_get_type_abort(uctx, trunk_connection_t);
3604 trunk_t *trunk = tconn->pub.trunk;
3605
3606 /*
3607 * Need to set this first as it
3608 * determines whether requests are
3609 * re-queued or fail outright.
3610 */
3611 trunk->pub.last_failed = fr_time();
3612
3613 /*
3614 * Failed in the init state, transition the
3615 * connection to closed, else we get an
3616 * INIT -> INIT transition which triggers
3617 * an assert.
3618 */
3619 if (prev == CONNECTION_STATE_INIT) _trunk_connection_on_closed(conn, prev, state, uctx);
3620
3621 /*
3622 * See what the state of the trunk is
3623 * if there are no connections that could
3624 * potentially accept requests in the near
3625 * future, then fail all the requests in the
3626 * trunk backlog.
3627 */
3628 if ((state == CONNECTION_STATE_CONNECTED) &&
3629 (trunk_connection_count_by_state(trunk,
3630 (TRUNK_CONN_ACTIVE |
3631 TRUNK_CONN_FULL |
3632 TRUNK_CONN_DRAINING)) == 0)) trunk_backlog_drain(trunk);
3633}
3634
3635/** Connection transitioned to the halted state
3636 *
3637 * Remove the connection remove all lists, as it's likely about to be freed.
3638 *
3639 * Setting the trunk back to the init state ensures that if the code is ever
3640 * refactored and #connection_signal_reconnect is used after a connection
3641 * is halted, then everything is maintained in a valid state.
3642 *
3643 * @note This function is only called from the connection API as a watcher.
3644 *
3645 * @param[in] conn The connection which changes state.
3646 * @param[in] prev The connection is was in.
3647 * @param[in] state The connection is now in.
3648 * @param[in] uctx The trunk_connection_t wrapping the connection.
3649 */
3650static void _trunk_connection_on_halted(UNUSED connection_t *conn,
3651 UNUSED connection_state_t prev,
3652 UNUSED connection_state_t state,
3653 void *uctx)
3654{
3655 trunk_connection_t *tconn = talloc_get_type_abort(uctx, trunk_connection_t);
3656 trunk_t *trunk = tconn->pub.trunk;
3657
3658 switch (tconn->pub.state) {
3659 case TRUNK_CONN_INIT:
3660 case TRUNK_CONN_CLOSED:
3661 trunk_connection_remove(tconn);
3662 break;
3663
3664 default:
3665 CONN_BAD_STATE_TRANSITION(TRUNK_CONN_HALTED);
3666 }
3667
3668 /*
3669 * It began life in the halted state,
3670 * and will end life in the halted state.
3671 */
3672 CONN_STATE_TRANSITION(TRUNK_CONN_HALTED, DEBUG2);
3673
3674 /*
3675 * There should be no requests left on this
3676 * connection. They should have all been
3677 * moved off or failed.
3678 */
3679 fr_assert(trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_ALL) == 0);
3680
3681 /*
3682 * And free the connection...
3683 */
3684 if (trunk->in_handler) {
3685 /*
3686 * ...later.
3687 */
3688 fr_dlist_insert_tail(&trunk->to_free, tconn);
3689 return;
3690 }
3691 talloc_free(tconn);
3692}
3693
3694/** Free a connection
3695 *
3696 * Enforces orderly free order of children of the tconn
3697 */
3698static int _trunk_connection_free(trunk_connection_t *tconn)
3699{
3700 fr_assert(tconn->pub.state == TRUNK_CONN_HALTED);
3701 fr_assert(!fr_dlist_entry_in_list(&tconn->entry)); /* Should not be in a list */
3702
3703 /*
3704 * Loop over all the requests we gathered
3705 * and transition them to the failed state,
3706 * freeing them.
3707 *
3708 * Usually, requests will be re-queued when
3709 * a connection enters the closed state,
3710 * but in this case because the whole trunk
3711 * is being freed, we don't bother, and
3712 * just signal to the API client that the
3713 * requests failed.
3714 */
3715 if (tconn->pub.trunk->freeing) {
3716 fr_dlist_head_t to_fail;
3717 trunk_request_t *treq = NULL;
3718
3719 fr_dlist_talloc_init(&to_fail, trunk_request_t, entry);
3720
3721 /*
3722 * Remove requests from this connection
3723 */
3724 trunk_connection_requests_dequeue(&to_fail, tconn, TRUNK_REQUEST_STATE_ALL, 0);
3725 while ((treq = fr_dlist_next(&to_fail, treq))) {
3726 trunk_request_t *prev;
3727
3728 prev = fr_dlist_remove(&to_fail, treq);
3729 trunk_request_enter_failed(treq);
3730 treq = prev;
3731 }
3732 }
3733
3734 /*
3735 * Ensure we're not signalled by the connection
3736 * as it processes its backlog of state changes,
3737 * as we are about to be freed.
3738 */
3739 connection_del_watch_pre(tconn->pub.conn, CONNECTION_STATE_INIT, _trunk_connection_on_init);
3740 connection_del_watch_post(tconn->pub.conn, CONNECTION_STATE_CONNECTING, _trunk_connection_on_connecting);
3741 connection_del_watch_post(tconn->pub.conn, CONNECTION_STATE_CONNECTED, _trunk_connection_on_connected);
3742 connection_del_watch_pre(tconn->pub.conn, CONNECTION_STATE_CLOSED, _trunk_connection_on_closed);
3743 connection_del_watch_post(tconn->pub.conn, CONNECTION_STATE_SHUTDOWN, _trunk_connection_on_shutdown);
3744 connection_del_watch_pre(tconn->pub.conn, CONNECTION_STATE_FAILED, _trunk_connection_on_failed);
3745 connection_del_watch_post(tconn->pub.conn, CONNECTION_STATE_HALTED, _trunk_connection_on_halted);
3746
3747 /*
3748 * This may return -1, indicating the free was deferred
3749 * this is fine. It just means the conn will be freed
3750 * after all the handlers have exited.
3751 */
3752 (void)talloc_free(tconn->pub.conn);
3753 tconn->pub.conn = NULL;
3754
3755 return 0;
3756}
3757
3758/** Attempt to spawn a new connection
3759 *
3760 * Calls the API client's alloc() callback to create a new connection_t,
3761 * then inserts the connection into the 'connecting' list.
3762 *
3763 * @param[in] trunk to spawn connection in.
3764 * @param[in] now The current time.
3765 */
3766static int trunk_connection_spawn(trunk_t *trunk, fr_time_t now)
3767{
3768 trunk_connection_t *tconn;
3769
3770
3771 /*
3772 * Call the API client's callback to create
3773 * a new connection_t.
3774 */
3775 MEM(tconn = talloc_zero(trunk, trunk_connection_t));
3776 tconn->pub.trunk = trunk;
3777 tconn->pub.state = TRUNK_CONN_HALTED; /* All connections start in the halted state */
3778
3779 /*
3780 * Allocate a new connection_t or fail.
3781 */
3782 DO_CONNECTION_ALLOC(tconn);
3783
3784 MEM(tconn->pending = fr_heap_talloc_alloc(tconn, _trunk_request_prioritise, trunk_request_t, heap_id, 0));
3785 fr_dlist_talloc_init(&tconn->sent, trunk_request_t, entry);
3786 fr_dlist_talloc_init(&tconn->reapable, trunk_request_t, entry);
3787 fr_dlist_talloc_init(&tconn->cancel, trunk_request_t, entry);
3788 fr_dlist_talloc_init(&tconn->cancel_sent, trunk_request_t, entry);
3789
3790 /*
3791 * OK, we have the connection, now setup watch
3792 * points so we know when it changes state.
3793 *
3794 * This lets us automatically move the tconn
3795 * between the different lists in the trunk
3796 * with minimum extra code.
3797 */
3798 connection_add_watch_pre(tconn->pub.conn, CONNECTION_STATE_INIT,
3799 _trunk_connection_on_init, false, tconn); /* Before init() has been called */
3800
3801 connection_add_watch_post(tconn->pub.conn, CONNECTION_STATE_CONNECTING,
3802 _trunk_connection_on_connecting, false, tconn); /* After init() has been called */
3803
3804 connection_add_watch_post(tconn->pub.conn, CONNECTION_STATE_CONNECTED,
3805 _trunk_connection_on_connected, false, tconn); /* After open() has been called */
3806
3807 connection_add_watch_pre(tconn->pub.conn, CONNECTION_STATE_CLOSED,
3808 _trunk_connection_on_closed, false, tconn); /* Before close() has been called */
3809
3810 connection_add_watch_pre(tconn->pub.conn, CONNECTION_STATE_FAILED,
3811 _trunk_connection_on_failed, false, tconn); /* Before failed() has been called */
3812
3813 connection_add_watch_post(tconn->pub.conn, CONNECTION_STATE_SHUTDOWN,
3814 _trunk_connection_on_shutdown, false, tconn); /* After shutdown() has been called */
3815
3816 connection_add_watch_post(tconn->pub.conn, CONNECTION_STATE_HALTED,
3817 _trunk_connection_on_halted, false, tconn); /* About to be freed */
3818
3819 talloc_set_destructor(tconn, _trunk_connection_free);
3820
3821 connection_signal_init(tconn->pub.conn); /* annnnd GO! */
3822
3823 trunk->pub.last_open = now;
3824
3825 return 0;
3826}
3827
3828/** Pop a cancellation request off a connection's cancellation queue
3829 *
3830 * The request we return is advanced by the request moving out of the
3831 * cancel state and into the cancel_sent or cancel_complete state.
3832 *
3833 * One of these signalling functions must be called after the request
3834 * has been popped:
3835 *
3836 * - #trunk_request_signal_cancel_sent
3837 * The remote datastore has been informed, but we need to wait for acknowledgement.
3838 * The #trunk_request_demux_t callback must handle the acks calling
3839 * #trunk_request_signal_cancel_complete when an ack is received.
3840 *
3841 * - #trunk_request_signal_cancel_complete
3842 * The request was cancelled and we don't need to wait, clean it up immediately.
3843 *
3844 * @param[out] treq_out to process
3845 * @param[in] tconn Connection to drain cancellation request from.
3846 * @return
3847 * - 1 if no more requests.
3848 * - 0 if a new request was written to treq_out.
3849 * - -1 if the connection was previously freed. Caller *MUST NOT* touch any
3850 * memory or requests associated with the connection.
3851 * - -2 if called outside of the cancel muxer.
3852 */
3853int trunk_connection_pop_cancellation(trunk_request_t **treq_out, trunk_connection_t *tconn)
3854{
3855 if (unlikely(tconn->pub.state == TRUNK_CONN_HALTED)) return -1;
3856
3857 if (!fr_cond_assert_msg(IN_REQUEST_CANCEL_MUX(tconn->pub.trunk),
3858 "%s can only be called from within request_cancel_mux handler",
3859 __FUNCTION__)) return -2;
3860
3861 *treq_out = tconn->cancel_partial ? tconn->cancel_partial : fr_dlist_head(&tconn->cancel);
3862 if (!*treq_out) return 1;
3863
3864 return 0;
3865}
3866
3867/** Pop a request off a connection's pending queue
3868 *
3869 * The request we return is advanced by the request moving out of the partial or
3870 * pending states, when the mux function signals us.
3871 *
3872 * If the same request is returned again and again, it means the muxer isn't actually
3873 * doing anything with the request we returned, and it's and error in the muxer code.
3874 *
3875 * One of these signalling functions must be used after the request has been popped:
3876 *
3877 * - #trunk_request_signal_complete
3878 * The request was completed. Either we got a synchronous response, or we knew the
3879 * response without contacting an external server (cache).
3880 *
3881 * - #trunk_request_signal_fail
3882 * Failed muxing the request due to a permanent issue, i.e. an invalid request.
3883 *
3884 * - #trunk_request_signal_partial
3885 * Wrote part of a request. This request will be returned on the next call to this
3886 * function so that the request_mux function can finish writing it. Only useful
3887 * for stream type connections. Datagram type connections cannot have partial
3888 * writes.
3889 *
3890 * - #trunk_request_signal_sent Successfully sent a request.
3891 *
3892 * @param[out] treq_out to process
3893 * @param[in] tconn to pop a request from.
3894 * @return
3895 * - 1 if no more requests.
3896 * - 0 if a new request was written to treq_out.
3897 * - -1 if the connection was previously freed. Caller *MUST NOT* touch any
3898 * memory or requests associated with the connection.
3899 * - -2 if called outside of the muxer.
3900 */
3901int trunk_connection_pop_request(trunk_request_t **treq_out, trunk_connection_t *tconn)
3902{
3903 if (unlikely(tconn->pub.state == TRUNK_CONN_HALTED)) return -1;
3904
3905 if (!fr_cond_assert_msg(IN_REQUEST_MUX(tconn->pub.trunk),
3906 "%s can only be called from within request_mux handler",
3907 __FUNCTION__)) return -2;
3908
3909 *treq_out = tconn->partial ? tconn->partial : fr_heap_peek(tconn->pending);
3910 if (!*treq_out) return 1;
3911
3912 return 0;
3913}
3914
3915/** Signal that a trunk connection is writable
3916 *
3917 * Should be called from the 'write' I/O handler to signal that requests can be enqueued.
3918 *
3919 * @param[in] tconn to signal.
3920 */
3921void trunk_connection_signal_writable(trunk_connection_t *tconn)
3922{
3923 trunk_t *trunk = tconn->pub.trunk;
3924
3925 if (!fr_cond_assert_msg(!IN_HANDLER(tconn->pub.trunk),
3926 "%s cannot be called within a handler", __FUNCTION__)) return;
3927
3928 DEBUG3("[%" PRIu64 "] Signalled writable", tconn->pub.conn->id);
3929
3930 trunk_connection_writable(tconn);
3931}
3932
3933/** Signal that a trunk connection is readable
3934 *
3935 * Should be called from the 'read' I/O handler to signal that requests should be dequeued.
3936 *
3937 * @param[in] tconn to signal.
3938 */
3939void trunk_connection_signal_readable(trunk_connection_t *tconn)
3940{
3941 trunk_t *trunk = tconn->pub.trunk;
3942
3943 if (!fr_cond_assert_msg(!IN_HANDLER(tconn->pub.trunk),
3944 "%s cannot be called within a handler", __FUNCTION__)) return;
3945
3946 DEBUG3("[%" PRIu64 "] Signalled readable", tconn->pub.conn->id);
3947
3948 trunk_connection_readable(tconn);
3949}
3950
3951/** Signal a trunk connection cannot accept more requests
3952 *
3953 * @param[in] tconn to signal.
3954 */
3955void trunk_connection_signal_inactive(trunk_connection_t *tconn)
3956{
3957 /* Can be called anywhere */
3958
3959 switch (tconn->pub.state) {
3960 case TRUNK_CONN_ACTIVE:
3961 case TRUNK_CONN_FULL:
3962 trunk_connection_enter_inactive(tconn);
3963 break;
3964
3965 case TRUNK_CONN_DRAINING:
3966 trunk_connection_enter_inactive_draining(tconn);
3967 break;
3968
3969 default:
3970 return;
3971 }
3972}
3973
3974/** Signal a trunk connection is no longer full
3975 *
3976 * @param[in] tconn to signal.
3977 */
3978void trunk_connection_signal_active(trunk_connection_t *tconn)
3979{
3980 switch (tconn->pub.state) {
3981 case TRUNK_CONN_FULL:
3982 trunk_connection_auto_unfull(tconn); /* Mark as active if it should be active */
3983 break;
3984
3985 case TRUNK_CONN_INACTIVE:
3986 /*
3987 * Do the appropriate state transition based on
3988 * how many requests the trunk connection is
3989 * currently servicing.
3990 */
3991 if (trunk_connection_is_full(tconn)) {
3992 trunk_connection_enter_full(tconn);
3993 break;
3994 }
3995 trunk_connection_enter_active(tconn);
3996 break;
3997
3998 /*
3999 * Unsetting the active flag just moves
4000 * the connection back to the normal
4001 * draining state.
4002 */
4003 case TRUNK_CONN_INACTIVE_DRAINING: /* Only an external signal can trigger this transition */
4004 trunk_connection_enter_draining(tconn);
4005 break;
4006
4007 default:
4008 return;
4009 }
4010}
4011
4012/** Signal a trunk connection is no longer viable
4013 *
4014 * @param[in] tconn to signal.
4015 * @param[in] reason the connection is being reconnected.
4016 */
4021
4022/** Standard I/O read function
4023 *
4024 * Underlying FD in now readable, so call the trunk to read any pending requests
4025 * from this connection.
4026 *
4027 * @param[in] el The event list signalling.
4028 * @param[in] fd that's now readable.
4029 * @param[in] flags describing the read event.
4030 * @param[in] uctx The trunk connection handle (tconn).
4031 */
4032void trunk_connection_callback_readable(UNUSED fr_event_list_t *el, UNUSED int fd, UNUSED int flags, void *uctx)
4033{
4034 trunk_connection_t *tconn = talloc_get_type_abort(uctx, trunk_connection_t);
4035
4036 trunk_connection_signal_readable(tconn);
4037}
4038
4039/** Standard I/O write function
4040 *
4041 * Underlying FD is now writable, so call the trunk to write any pending requests
4042 * to this connection.
4043 *
4044 * @param[in] el The event list signalling.
4045 * @param[in] fd that's now writable.
4046 * @param[in] flags describing the write event.
4047 * @param[in] uctx The trunk connection handle (tcon).
4048 */
4049void trunk_connection_callback_writable(UNUSED fr_event_list_t *el, UNUSED int fd, UNUSED int flags, void *uctx)
4050{
4051 trunk_connection_t *tconn = talloc_get_type_abort(uctx, trunk_connection_t);
4052
4053 trunk_connection_signal_writable(tconn);
4054}
4055
4056
4057/** Returns true if the trunk connection is in one of the specified states
4058 *
4059 * @param[in] tconn To check state for.
4060 * @param[in] state to check
4061 * @return
4062 * - True if trunk connection is in a particular state.
4063 * - False if trunk connection is not in a particular state.
4064 */
4065bool trunk_connection_in_state(trunk_connection_t *tconn, int state)
4066{
4067 return (bool)(tconn->pub.state & state);
4068}
4069
4070/** Close connections in a particular connection list if they have no requests associated with them
4071 *
4072 * @param[in] trunk containing connections we want to close.
4073 * @param[in] head of list of connections to examine.
4074 */
4075static void trunk_connection_close_if_empty(trunk_t *trunk, fr_dlist_head_t *head)
4076{
4077 trunk_connection_t *tconn = NULL;
4078
4079 while ((tconn = fr_dlist_next(head, tconn))) {
4080 trunk_connection_t *prev;
4081
4082 if (trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_ALL) != 0) continue;
4083
4084 prev = fr_dlist_prev(head, tconn);
4085
4086 DEBUG3("Closing %s connection with no requests",
4087 fr_table_str_by_value(trunk_connection_states, tconn->pub.state, "<INVALID>"));
4088 /*
4089 * Close the connection as gracefully
4090 * as possible by signalling it should
4091 * shutdown.
4092 *
4093 * The connection, should, if serviced
4094 * correctly by the underlying library,
4095 * automatically transition to halted after
4096 * all pending reads/writes are
4097 * complete at which point we'll be informed
4098 * and free our tconn wrapper.
4099 */
4100 connection_signal_shutdown(tconn->pub.conn);
4101 tconn = prev;
4102 }
4103}
4104
4105/** Rebalance connections across active trunk members when a new connection becomes active
4106 *
4107 * We don't have any visibility into the connection prioritisation algorithm
4108 * it's essentially a black box.
4109 *
4110 * We can however determine when the correct level of requests per connection
4111 * has been reached, by dequeuing and requeing requests up until the point
4112 * where the connection that just had a request dequeued, receives the same
4113 * request back.
4114 *
4115 * @param[in] trunk The trunk to rebalance.
4116 */
4117static void trunk_rebalance(trunk_t *trunk)
4118{
4119 trunk_connection_t *head;
4120
4121 head = fr_minmax_heap_min_peek(trunk->active);
4122
4123 /*
4124 * Only rebalance if the top and bottom of
4125 * the heap are not equal.
4126 */
4127 if (trunk->funcs.connection_prioritise(fr_minmax_heap_max_peek(trunk->active), head) == 0) return;
4128
4129 DEBUG3("Rebalancing requests");
4130
4131 /*
4132 * Keep requeuing requests from the connection
4133 * at the bottom of the heap until the
4134 * connection at the top is shifted from that
4135 * position.
4136 */
4137 while ((fr_minmax_heap_min_peek(trunk->active) == head) &&
4138 trunk_connection_requests_requeue_priv(fr_minmax_heap_max_peek(trunk->active),
4139 TRUNK_REQUEST_STATE_PENDING, 1, false));
4140}
4141
4142/** Implements the algorithm we use to manage requests per connection levels
4143 *
4144 * This is executed periodically using a timer event, and opens/closes
4145 * connections.
4146 *
4147 * The aim is to try and keep the request per connection level in a sweet spot,
4148 * where there's enough outstanding work for the connection/pipelining to work
4149 * efficiently, but not so much so that we encounter increased latency.
4150 *
4151 * In the request enqueue and dequeue functions we record every time the
4152 * average number of requests per connection goes above the target count
4153 * and record every time the average number of requests per connection goes
4154 * below the target count.
4155 *
4156 * This may sound expensive, but in all cases we're just summing counters.
4157 * CPU time required does not increase with additional requests, only with
4158 * large numbers of connections.
4159 *
4160 * If we do encounter scaling issues, we can always maintain the counters
4161 * as aggregates as an optimisation later.
4162 *
4163 * If when the management function runs, the trunk was above the target
4164 * most recently, we:
4165 * - Return if we've been in this state for a shorter period than 'open_delay'.
4166 * - Return if we're at max.
4167 * - Return if opening a new connection will take us below the load target.
4168 * - Return if we last opened a connection within 'open_delay'.
4169 * - Otherwise we attempt to open a new connection.
4170 *
4171 * If the trunk we below the target most recently, we:
4172 * - Return if we've been in this state for a shorter period than 'close_delay'.
4173 * - Return if we're at min.
4174 * - Return if we have no connections.
4175 * - Close a connection if min is 0, and we have no outstanding
4176 * requests. Then return.
4177 * - Return if closing a new connection will take us above the load target.
4178 * - Return if we last closed a connection within 'closed_delay'.
4179 * - Otherwise we move a connection to draining state.
4180 */
4181static void trunk_manage(trunk_t *trunk, fr_time_t now)
4182{
4183 trunk_connection_t *tconn = NULL;
4184 trunk_request_t *treq;
4185 uint32_t average = 0;
4186 uint32_t req_count;
4187 uint16_t conn_count;
4188 trunk_state_t new_state;
4189
4190 DEBUG4("Managing trunk");
4191
4192 /*
4193 * Cleanup requests in our request cache which
4194 * have been reapable for too long.
4195 */
4196 while ((treq = fr_dlist_tail(&trunk->free_requests)) &&
4197 fr_time_lteq(fr_time_add(treq->last_freed, trunk->conf.req_cleanup_delay), now)) talloc_free(treq);
4198
4199 /*
4200 * If we have idle connections, then close them.
4201 */
4202 if (fr_time_delta_ispos(trunk->conf.idle_timeout)) {
4203 fr_minmax_heap_iter_t iter;
4204 fr_time_t idle_cutoff = fr_time_sub(now, trunk->conf.idle_timeout);
4205
4206 for (tconn = fr_minmax_heap_iter_init(trunk->active, &iter);
4207 tconn;
4208 tconn = fr_minmax_heap_iter_next(trunk->active, &iter)) {
4209 /*
4210 * The connection has outstanding requests without replies, don't do anything.
4211 */
4212 if (fr_heap_num_elements(tconn->pending) > 0) continue;
4213
4214 /*
4215 * The connection was last active after the idle cutoff time, don't do anything.
4216 */
4217 if (fr_time_gt(tconn->pub.last_write_success, idle_cutoff)) continue;
4218
4219 /*
4220 * This connection has been inactive since before the idle timeout. Drain it,
4221 * and free it.
4222 */
4223 trunk_connection_enter_draining_to_free(tconn);
4224 }
4225 }
4226
4227 /*
4228 * Free any connections which have drained
4229 * and we didn't reactivate during the last
4230 * round of management.
4231 */
4232 trunk_connection_close_if_empty(trunk, &trunk->inactive_draining);
4233 trunk_connection_close_if_empty(trunk, &trunk->draining);
4234 trunk_connection_close_if_empty(trunk, &trunk->draining_to_free);
4235
4236 /*
4237 * Process deferred connection freeing
4238 */
4239 if (!trunk->in_handler) {
4240 while ((tconn = fr_dlist_head(&trunk->to_free))) talloc_free(fr_dlist_remove(&trunk->to_free, tconn));
4241 }
4242
4243 /*
4244 * Update the state of the trunk
4245 */
4246 if (trunk_connection_count_by_state(trunk, TRUNK_CONN_ACTIVE)) {
4247 new_state = TRUNK_STATE_ACTIVE;
4248 } else {
4249 /*
4250 * INIT / CONNECTING / FULL mean connections will become active
4251 * so the trunk is PENDING
4252 */
4253 new_state = trunk_connection_count_by_state(trunk, TRUNK_CONN_INIT |
4254 TRUNK_CONN_CONNECTING |
4255 TRUNK_CONN_FULL) ?
4256 TRUNK_STATE_PENDING : TRUNK_STATE_IDLE;
4257 }
4258
4259 if (new_state != trunk->pub.state) TRUNK_STATE_TRANSITION(new_state);
4260
4261 /*
4262 * A trunk can be signalled to not proactively
4263 * manage connections if a destination is known
4264 * to be unreachable, and doing so would result
4265 * in spurious connections still being opened.
4266 *
4267 * We still run other connection management
4268 * functions and just short circuit the function
4269 * here.
4270 */
4271 if (!trunk->managing_connections) return;
4272
4273 /*
4274 * We're above the target requests per connection
4275 * spawn more connections!
4276 */
4277 if (fr_time_gteq(trunk->pub.last_above_target, trunk->pub.last_below_target)) {
4278 /*
4279 * If connecting is provided, check we
4280 * wouldn't have too many connections in
4281 * the connecting state.
4282 *
4283 * This is a throttle in the case of transitory
4284 * load spikes, or a backend becoming
4285 * unavailable.
4286 */
4287 if ((trunk->conf.connecting > 0) &&
4288 (trunk_connection_count_by_state(trunk, TRUNK_CONN_CONNECTING) >=
4289 trunk->conf.connecting)) {
4290 DEBUG4("Not opening connection - Too many (%u) connections in the connecting state",
4291 trunk->conf.connecting);
4292 return;
4293 }
4294
4295 trunk_requests_per_connection(&conn_count, &req_count, trunk, now, true);
4296
4297 /*
4298 * Only apply hysteresis if we have at least
4299 * one available connection.
4300 */
4301 if (conn_count && fr_time_gt(fr_time_add(trunk->pub.last_above_target, trunk->conf.open_delay), now)) {
4302 DEBUG4("Not opening connection - Need to be above target for %pVs. It's been %pVs",
4303 fr_box_time_delta(trunk->conf.open_delay),
4304 fr_box_time_delta(fr_time_sub(now, trunk->pub.last_above_target)));
4305 return; /* too soon */
4306 }
4307
4308 /*
4309 * We don't consider 'draining' connections
4310 * in the max calculation, as if we do
4311 * determine that we need to spawn a new
4312 * request, then we'd move all 'draining'
4313 * connections to active before spawning
4314 * any new connections.
4315 */
4316 if ((trunk->conf.max > 0) && (conn_count >= trunk->conf.max)) {
4317 DEBUG4("Not opening connection - Have %u connections, need %u or below",
4318 conn_count, trunk->conf.max);
4319 return;
4320 }
4321
4322 /*
4323 * We consider requests pending on all connections
4324 * and the trunk's backlog as that's the current count
4325 * load.
4326 */
4327 if (!req_count) {
4328 DEBUG4("Not opening connection - No outstanding requests");
4329 return;
4330 }
4331
4332 /*
4333 * Do the n+1 check, i.e. if we open one connection
4334 * will that take us below our target threshold.
4335 */
4336 if (conn_count > 0) {
4337 average = ROUND_UP_DIV(req_count, (conn_count + 1));
4338 if (average < trunk->conf.target_req_per_conn) {
4339 DEBUG4("Not opening connection - Would leave us below our target requests "
4340 "per connection (now %u, after open %u)",
4341 ROUND_UP_DIV(req_count, conn_count), average);
4342 return;
4343 }
4344 } else {
4345 (void)trunk_connection_spawn(trunk, now);
4346 return;
4347 }
4348
4349 /*
4350 * If we've got a connection in the draining list
4351 * move it back into the active list if we've
4352 * been requested to add a connection back in.
4353 */
4354 tconn = fr_dlist_head(&trunk->draining);
4355 if (tconn) {
4356 if (trunk_connection_is_full(tconn)) {
4357 trunk_connection_enter_full(tconn);
4358 } else {
4359 trunk_connection_enter_active(tconn);
4360 }
4361 return;
4362 }
4363
4364 /*
4365 * Implement delay if there's no connections that
4366 * could be immediately re-activated.
4367 */
4368 if (fr_time_gt(fr_time_add(trunk->pub.last_open, trunk->conf.open_delay), now)) {
4369 DEBUG4("Not opening connection - Need to wait %pVs before opening another connection. "
4370 "It's been %pVs",
4371 fr_box_time_delta(trunk->conf.open_delay),
4372 fr_box_time_delta(fr_time_sub(now, trunk->pub.last_open)));
4373 return;
4374 }
4375
4376 DEBUG4("Opening connection - Above target requests per connection (now %u, target %u)",
4377 ROUND_UP_DIV(req_count, conn_count), trunk->conf.target_req_per_conn);
4378 /* last_open set by trunk_connection_spawn */
4379 (void)trunk_connection_spawn(trunk, now);
4380 }
4381
4382 /*
4383 * We're below the target requests per connection.
4384 * Free some connections...
4385 */
4386 else if (fr_time_gt(trunk->pub.last_below_target, trunk->pub.last_above_target)) {
4387 if (fr_time_gt(fr_time_add(trunk->pub.last_below_target, trunk->conf.close_delay), now)) {
4388 DEBUG4("Not closing connection - Need to be below target for %pVs. It's been %pVs",
4389 fr_box_time_delta(trunk->conf.close_delay),
4390 fr_box_time_delta(fr_time_sub(now, trunk->pub.last_below_target)));
4391 return; /* too soon */
4392 }
4393
4394 trunk_requests_per_connection(&conn_count, &req_count, trunk, now, true);
4395
4396 if (!conn_count) {
4397 DEBUG4("Not closing connection - No connections to close!");
4398 return;
4399 }
4400
4401 if ((trunk->conf.min > 0) && ((conn_count - 1) < trunk->conf.min)) {
4402 DEBUG4("Not closing connection - Have %u connections, need %u or above",
4403 conn_count, trunk->conf.min);
4404 return;
4405 }
4406
4407 if (!req_count) {
4408 DEBUG4("Closing connection - No outstanding requests");
4409 goto close;
4410 }
4411
4412 /*
4413 * The minimum number of connections must be set
4414 * to zero for this to work.
4415 * min == 0, no requests, close all the connections.
4416 * This is useful for backup databases, when
4417 * maintaining the connection would lead to lots of
4418 * log file churn.
4419 */
4420 if (conn_count == 1) {
4421 DEBUG4("Not closing connection - Would leave connections "
4422 "and there are still %u outstanding requests", req_count);
4423 return;
4424 }
4425
4426 /*
4427 * Do the n-1 check, i.e. if we close one connection
4428 * will that take us above our target threshold.
4429 */
4430 average = ROUND_UP_DIV(req_count, (conn_count - 1));
4431 if (average > trunk->conf.target_req_per_conn) {
4432 DEBUG4("Not closing connection - Would leave us above our target requests per connection "
4433 "(now %u, after close %u)", ROUND_UP_DIV(req_count, conn_count), average);
4434 return;
4435 }
4436
4437 DEBUG4("Closing connection - Below target requests per connection (now %u, target %u)",
4438 ROUND_UP_DIV(req_count, conn_count), trunk->conf.target_req_per_conn);
4439
4440 close:
4441 if (fr_time_gt(fr_time_add(trunk->pub.last_closed, trunk->conf.close_delay), now)) {
4442 DEBUG4("Not closing connection - Need to wait %pVs before closing another connection. "
4443 "It's been %pVs",
4444 fr_box_time_delta(trunk->conf.close_delay),
4445 fr_box_time_delta(fr_time_sub(now, trunk->pub.last_closed)));
4446 return;
4447 }
4448
4449 /*
4450 * If the last event on the trunk was a connection failure and
4451 * there is only one connection, this may well be a reconnect
4452 * attempt after a failure - and needs to persist otherwise
4453 * the last event will be a failure and no new connection will
4454 * be made, leading to no new requests being enqueued.
4455 */
4456 if (fr_time_gt(trunk->pub.last_failed, fr_time_wrap(0)) &&
4457 fr_time_lt(trunk->pub.last_connected, trunk->pub.last_failed) && (conn_count == 1)) {
4458 DEBUG4("Not closing remaining connection - last event was a failure");
4459 return;
4460 }
4461
4462 /*
4463 * Inactive connections get counted in the
4464 * set of viable connections, but are likely
4465 * to be congested or dead, so we drain
4466 * (and possibly eventually free) those first.
4467 */
4468 if ((tconn = fr_dlist_tail(&trunk->inactive))) {
4469 /*
4470 * If the connection has no requests associated
4471 * with it then immediately free.
4472 */
4473 if (trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_ALL) == 0) {
4474 connection_signal_halt(tconn->pub.conn); /* Also frees the tconn */
4475 } else {
4476 trunk_connection_enter_inactive_draining(tconn);
4477 }
4478 /*
4479 * It is possible to have too may connecting
4480 * connections when the connections are
4481 * taking a while to open and the number
4482 * of requests decreases.
4483 */
4484 } else if ((tconn = fr_dlist_tail(&trunk->connecting))) {
4485 connection_signal_halt(tconn->pub.conn); /* Also frees the tconn */
4486
4487 /*
4488 * Finally if there are no "connecting"
4489 * connections to close, and no "inactive"
4490 * connections, start draining "active"
4491 * connections.
4492 */
4493 } else if ((tconn = fr_minmax_heap_max_peek(trunk->active))) {
4494 /*
4495 * If the connection has no requests associated
4496 * with it then immediately free.
4497 */
4498 if (trunk_request_count_by_connection(tconn, TRUNK_REQUEST_STATE_ALL) == 0) {
4499 connection_signal_halt(tconn->pub.conn); /* Also frees the tconn */
4500 } else {
4501 trunk_connection_enter_draining(tconn);
4502 }
4503 }
4504
4505 trunk->pub.last_closed = now;
4506
4507 return;
4508 }
4509}
4510
4511/** Event to periodically call the connection management function
4512 *
4513 * @param[in] tl this event belongs to.
4514 * @param[in] now current time.
4515 * @param[in] uctx The trunk.
4516 */
4517static void _trunk_timer(fr_timer_list_t *tl, fr_time_t now, void *uctx)
4518{
4519 trunk_t *trunk = talloc_get_type_abort(uctx, trunk_t);
4520
4521 trunk_manage(trunk, now);
4522
4523 if (fr_time_delta_ispos(trunk->conf.manage_interval)) {
4524 if (fr_timer_in(trunk, tl, &trunk->manage_ev, trunk->conf.manage_interval,
4525 false, _trunk_timer, trunk) < 0) {
4526 PERROR("Failed inserting trunk management event");
4527 /* Not much we can do, hopefully the trunk will be freed soon */
4528 }
4529 }
4530}
4531
4532/** Return a count of requests on a connection in a specific state
4533 *
4534 * @param[in] trunk to retrieve counts for.
4535 * @param[in] conn_state One or more connection states or'd together.
4536 * @param[in] req_state One or more request states or'd together.
4537 * @return The number of requests in a particular state, on connection in a particular state.
4538 */
4539uint64_t trunk_request_count_by_state(trunk_t *trunk, int conn_state, int req_state)
4540{
4541 uint64_t count = 0;
4542 trunk_connection_t *tconn = NULL;
4543 fr_minmax_heap_iter_t iter;
4544
4545#define COUNT_BY_STATE(_state, _list) \
4546do { \
4547 if (conn_state & (_state)) { \
4548 tconn = NULL; \
4549 while ((tconn = fr_dlist_next(&trunk->_list, tconn))) { \
4550 count += trunk_request_count_by_connection(tconn, req_state); \
4551 } \
4552 } \
4553} while (0)
4554
4555 if (conn_state & TRUNK_CONN_ACTIVE) {
4556 for (tconn = fr_minmax_heap_iter_init(trunk->active, &iter);
4557 tconn;
4558 tconn = fr_minmax_heap_iter_next(trunk->active, &iter)) {
4559 count += trunk_request_count_by_connection(tconn, req_state);
4560 }
4561 }
4562
4563 COUNT_BY_STATE(TRUNK_CONN_FULL, full);
4564 COUNT_BY_STATE(TRUNK_CONN_INACTIVE, inactive);
4565 COUNT_BY_STATE(TRUNK_CONN_INACTIVE_DRAINING, inactive_draining);
4566 COUNT_BY_STATE(TRUNK_CONN_DRAINING, draining);
4567 COUNT_BY_STATE(TRUNK_CONN_DRAINING_TO_FREE, draining_to_free);
4568
4569 if (req_state & TRUNK_REQUEST_STATE_BACKLOG) count += fr_heap_num_elements(trunk->backlog);
4570
4571 return count;
4572}
4573
4574/** Update timestamps for when we last had a transition from above target to below target or vice versa
4575 *
4576 * Should be called on every time a connection or request is allocated or freed.
4577 *
4578 * @param[out] conn_count_out How many connections we considered.
4579 * @param[out] req_count_out How many requests we considered.
4580 * @param[in] trunk to operate on.
4581 * @param[in] now The current time.
4582 * @param[in] verify if true (and this is a debug build), then assert if req_per_conn
4583 * has changed.
4584 * @return
4585 * - 0 if the average couldn't be calculated (no requests or no connections).
4586 * - The average number of requests per connection.
4587 */
4588static uint64_t trunk_requests_per_connection(uint16_t *conn_count_out, uint32_t *req_count_out,
4589 trunk_t *trunk, fr_time_t now,
4590 NDEBUG_UNUSED bool verify)
4591{
4592 uint32_t req_count = 0;
4593 uint16_t conn_count = 0;
4594 uint64_t req_per_conn = 0;
4595
4596 fr_assert(fr_time_gt(now, fr_time_wrap(0)));
4597
4598 /*
4599 * No need to update these as the trunk is being freed
4600 */
4601 if (trunk->freeing) goto done;
4602
4603 /*
4604 * Count all connections except draining and draining to free.
4605 *
4606 * Omitting these connection states artificially raises the
4607 * request to connection ratio, so that we can preemptively spawn
4608 * new connections.
4609 *
4610 * In the case of TRUNK_CONN_DRAINING | TRUNK_CONN_INACTIVE_DRAINING
4611 * the trunk management code has enough hysteresis to not
4612 * immediately reactivate the connection.
4613 *
4614 * In the case of TRUNK_CONN_DRAINING_TO_FREE the trunk
4615 * management code should spawn a new connection to takes its place.
4616 *
4617 * Connections placed in the DRAINING_TO_FREE state are being
4618 * closed preemptively to deal with bugs on the server we're
4619 * talking to, or misconfigured firewalls which are trashing
4620 * TCP/UDP connection states.
4621 */
4622 conn_count = trunk_connection_count_by_state(trunk, TRUNK_CONN_ALL ^
4623 (TRUNK_CONN_DRAINING |
4624 TRUNK_CONN_INACTIVE_DRAINING |
4625 TRUNK_CONN_DRAINING_TO_FREE));
4626
4627 /*
4628 * Requests on all connections
4629 */
4630 req_count = trunk_request_count_by_state(trunk,
4631 TRUNK_CONN_ALL ^
4632 TRUNK_CONN_DRAINING_TO_FREE, TRUNK_REQUEST_STATE_ALL);
4633
4634 /*
4635 * No connections, but we do have requests
4636 */
4637 if (conn_count == 0) {
4638 if ((req_count > 0) && (trunk->conf.target_req_per_conn > 0)) goto above_target;
4639 goto done;
4640 }
4641
4642 if (req_count == 0) {
4643 if (trunk->conf.target_req_per_conn > 0) goto below_target;
4644 goto done;
4645 }
4646
4647 /*
4648 * Calculate the req_per_conn
4649 */
4650 req_per_conn = ROUND_UP_DIV(req_count, conn_count);
4651 if (req_per_conn > trunk->conf.target_req_per_conn) {
4652 above_target:
4653 /*
4654 * Edge - Below target to above target (too many requests per conn - spawn more)
4655 *
4656 * The equality check is correct here as both values start at 0.
4657 */
4658 if (fr_time_lteq(trunk->pub.last_above_target, trunk->pub.last_below_target)) trunk->pub.last_above_target = now;
4659 } else if (req_per_conn < trunk->conf.target_req_per_conn) {
4660 below_target:
4661 /*
4662 * Edge - Above target to below target (too few requests per conn - close some)
4663 *
4664 * The equality check is correct here as both values start at 0.
4665 */
4666 if (fr_time_lteq(trunk->pub.last_below_target, trunk->pub.last_above_target)) trunk->pub.last_below_target = now;
4667 }
4668
4669done:
4670 if (conn_count_out) *conn_count_out = conn_count;
4671 if (req_count_out) *req_count_out = req_count;
4672
4673 /*
4674 * Check we haven't missed a call to trunk_requests_per_connection
4675 */
4676 fr_assert(!verify || (trunk->last_req_per_conn == 0) || (req_per_conn == trunk->last_req_per_conn));
4677
4678 trunk->last_req_per_conn = req_per_conn;
4679
4680 return req_per_conn;
4681}
4682
4683/** Drain the backlog of as many requests as possible
4684 *
4685 * @param[in] trunk To drain backlog requests for.
4686 */
4687static void trunk_backlog_drain(trunk_t *trunk)
4688{
4689 trunk_request_t *treq;
4690
4691 if (fr_heap_num_elements(trunk->backlog) == 0) return;
4692
4693 /*
4694 * If it's always writable, this isn't
4695 * really a noteworthy event.
4696 */
4697 if (!trunk->conf.always_writable) DEBUG3("Draining backlog of requests");
4698
4699 /*
4700 * Do *NOT* add an artificial limit
4701 * here. We rely on all available
4702 * connections entering the full
4703 * state and transitioning back to
4704 * active in order to drain the
4705 * backlog.
4706 */
4707 while ((treq = fr_heap_peek(trunk->backlog))) {
4708 switch (trunk_request_enqueue_existing(treq)) {
4709 case TRUNK_ENQUEUE_OK:
4710 continue;
4711
4712 /*
4713 * Signal to stop
4714 */
4715 case TRUNK_ENQUEUE_IN_BACKLOG:
4716 break;
4717
4718 /*
4719 * Failed enqueueing the request,
4720 * have it enter the failed state
4721 * which will free it and
4722 * re-enliven the yielded request.
4723 */
4724 case TRUNK_ENQUEUE_DST_UNAVAILABLE:
4725 case TRUNK_ENQUEUE_FAIL:
4726 trunk_request_enter_failed(treq);
4727 continue;
4728
4729 case TRUNK_ENQUEUE_NO_CAPACITY:
4730 fr_assert(fr_minmax_heap_num_elements(trunk->active) == 0);
4731 return;
4732 }
4733 }
4734}
4735
4736/** Force the trunk to re-establish its connections
4737 *
4738 * @param[in] trunk to signal.
4739 * @param[in] states One or more states or'd together.
4740 * @param[in] reason Why the connections are being signalled to reconnect.
4741 */
4742void trunk_reconnect(trunk_t *trunk, int states, connection_reason_t reason)
4743{
4744
4745#define RECONNECT_BY_STATE(_state, _list) \
4746do { \
4747 if (states & (_state)) { \
4748 size_t i; \
4749 for (i = fr_dlist_num_elements(&trunk->_list); i > 0; i--) { \
4750 connection_signal_reconnect(((trunk_connection_t *)fr_dlist_tail(&trunk->_list))->pub.conn, reason); \
4751 } \
4752 } \
4753} while (0)
4754
4755 /*
4756 * Connections in the 'connecting' state
4757 * may re-enter that state, so we need to
4758 * be careful not to enter an infinite
4759 * loop, as we iterate over the list
4760 * again and again.
4761 */
4762 RECONNECT_BY_STATE(TRUNK_CONN_CONNECTING, connecting);
4763
4764 if (states & TRUNK_CONN_ACTIVE) {
4765 trunk_connection_t *tconn;
4766 while ((tconn = fr_minmax_heap_min_peek(trunk->active))) connection_signal_reconnect(tconn->pub.conn, reason);
4767 }
4768
4769 RECONNECT_BY_STATE(TRUNK_CONN_INIT, init);
4770 RECONNECT_BY_STATE(TRUNK_CONN_FULL, full);
4771 RECONNECT_BY_STATE(TRUNK_CONN_INACTIVE, inactive);
4772 RECONNECT_BY_STATE(TRUNK_CONN_INACTIVE_DRAINING, inactive_draining);
4773 RECONNECT_BY_STATE(TRUNK_CONN_CLOSED, closed);
4774 RECONNECT_BY_STATE(TRUNK_CONN_DRAINING, draining);
4775 RECONNECT_BY_STATE(TRUNK_CONN_DRAINING_TO_FREE, draining_to_free);
4776}
4777
4778/** Start the trunk running
4779 *
4780 */
4781int trunk_start(trunk_t *trunk)
4782{
4783 uint16_t i;
4784
4785 if (unlikely(trunk->started)) return 0;
4786
4787 /*
4788 * Spawn the initial set of connections
4789 */
4790 for (i = 0; i < trunk->conf.start; i++) {
4791 DEBUG("[%i] Starting initial connection", i);
4792 if (trunk_connection_spawn(trunk, fr_time()) != 0) return -1;
4793 }
4794
4795 /*
4796 * If the idle timeout is set, AND there's no management interval, OR the management interval is
4797 * less than the idle timeout, update the management interval.
4798 */
4799 if (fr_time_delta_ispos(trunk->conf.idle_timeout) &&
4800 (!fr_time_delta_ispos(trunk->conf.manage_interval) ||
4801 fr_time_delta_gt(trunk->conf.manage_interval, trunk->conf.idle_timeout))) {
4802 trunk->conf.manage_interval = trunk->conf.idle_timeout;
4803 }
4804
4805 if (fr_time_delta_ispos(trunk->conf.manage_interval)) {
4806 /*
4807 * Insert the event timer to manage
4808 * the interval between managing connections.
4809 */
4810 if (fr_timer_in(trunk, trunk->el->tl, &trunk->manage_ev, trunk->conf.manage_interval,
4811 false, _trunk_timer, trunk) < 0) {
4812 PERROR("Failed inserting trunk management event");
4813 return -1;
4814 }
4815 }
4816 trunk->started = true;
4817 trunk->managing_connections = true;
4818
4819 return 0;
4820}
4821
4822/** Allow the trunk to open and close connections in response to load
4823 *
4824 */
4825void trunk_connection_manage_start(trunk_t *trunk)
4826{
4827 if (!trunk->started || trunk->managing_connections) return;
4828
4829 DEBUG3("Connection management enabled");
4830 trunk->managing_connections = true;
4831}
4832
4833/** Stop the trunk from opening and closing connections in response to load
4834 *
4835 */
4836void trunk_connection_manage_stop(trunk_t *trunk)
4837{
4838 if (!trunk->started || !trunk->managing_connections) return;
4839
4840 DEBUG3("Connection management disabled");
4841 trunk->managing_connections = false;
4842}
4843
4844/** Schedule a trunk management event for the next time the event loop is executed
4845 */
4846int trunk_connection_manage_schedule(trunk_t *trunk)
4847{
4848 if (!trunk->started || !trunk->managing_connections) return 0;
4849
4850 if (fr_timer_in(trunk, trunk->el->tl, &trunk->manage_ev, fr_time_delta_wrap(0),
4851 false, _trunk_timer, trunk) < 0) {
4852 PERROR("Failed inserting trunk management event");
4853 return -1;
4854 }
4855
4856 return 0;
4857}
4858
4859/** Order connections by queue depth
4860 *
4861 */
4862static int8_t _trunk_connection_order_by_shortest_queue(void const *one, void const *two)
4863{
4864 trunk_connection_t const *a = talloc_get_type_abort_const(one, trunk_connection_t);
4865 trunk_connection_t const *b = talloc_get_type_abort_const(two, trunk_connection_t);
4866
4867 uint32_t a_count = trunk_request_count_by_connection(a, TRUNK_REQUEST_STATE_ALL);
4868 uint32_t b_count = trunk_request_count_by_connection(b, TRUNK_REQUEST_STATE_ALL);
4869
4870 /*
4871 * Add a fudge factor of 1 to reduce spurious rebalancing
4872 */
4873 return ((a_count > b_count) && ((a_count - b_count) > 1)) - ((b_count > a_count) && ((b_count - a_count) > 1));
4874}
4875
4876/** Free a trunk, gracefully closing all connections.
4877 *
4878 */
4879static int _trunk_free(trunk_t *trunk)
4880{
4881 trunk_connection_t *tconn;
4882 trunk_request_t *treq;
4883 trunk_watch_entry_t *watch;
4884 size_t i;
4885
4886 DEBUG4("Trunk free %p", trunk);
4887
4888 trunk->freeing = true; /* Prevent re-enqueuing */
4889
4890 /*
4891 * We really don't want this firing after
4892 * we've freed everything.
4893 */
4894 FR_TIMER_DELETE_RETURN(&trunk->manage_ev);
4895
4896 /*
4897 * Now free the connections in each of the lists.
4898 *
4899 * Each time a connection is freed it removes itself from the list
4900 * its in, which means the head should keep advancing automatically.
4901 */
4902 while ((tconn = fr_minmax_heap_min_peek(trunk->active))) connection_signal_halt(tconn->pub.conn);
4903 while ((tconn = fr_dlist_head(&trunk->init))) connection_signal_halt(tconn->pub.conn);
4904 while ((tconn = fr_dlist_head(&trunk->connecting))) connection_signal_halt(tconn->pub.conn);
4905 while ((tconn = fr_dlist_head(&trunk->full))) connection_signal_halt(tconn->pub.conn);
4906 while ((tconn = fr_dlist_head(&trunk->inactive))) connection_signal_halt(tconn->pub.conn);
4907 while ((tconn = fr_dlist_head(&trunk->inactive_draining))) connection_signal_halt(tconn->pub.conn);
4908 while ((tconn = fr_dlist_head(&trunk->closed))) connection_signal_halt(tconn->pub.conn);
4909 while ((tconn = fr_dlist_head(&trunk->draining))) connection_signal_halt(tconn->pub.conn);
4910 while ((tconn = fr_dlist_head(&trunk->draining_to_free))) connection_signal_halt(tconn->pub.conn);
4911
4912 /*
4913 * Process any deferred connection frees
4914 */
4915 while ((tconn = fr_dlist_head(&trunk->to_free))) talloc_free(fr_dlist_remove(&trunk->to_free, tconn));
4916
4917 /*
4918 * Free any requests left in the backlog
4919 */
4920 while ((treq = fr_heap_peek(trunk->backlog))) trunk_request_enter_failed(treq);
4921
4922 /*
4923 * Free any requests in our request cache
4924 */
4925 while ((treq = fr_dlist_head(&trunk->free_requests))) talloc_free(treq);
4926
4927 /*
4928 * Free any entries in the watch lists
4929 */
4930 for (i = 0; i < NUM_ELEMENTS(trunk->watch); i++) {
4931 while ((watch = fr_dlist_pop_head(&trunk->watch[i]))) talloc_free(watch);
4932 }
4933
4934 return 0;
4935}
4936
4937/** Allocate a new collection of connections
4938 *
4939 * This function should be called first to allocate a new trunk connection.
4940 *
4941 * After the trunk has been allocated, #trunk_request_alloc and
4942 * #trunk_request_enqueue should be used to allocate memory for trunk
4943 * requests, and pass a preq (protocol request) to the trunk for
4944 * processing.
4945 *
4946 * The trunk will then asynchronously process the request, writing the result
4947 * to a specified rctx. See #trunk_request_enqueue for more details.
4948 *
4949 * @note Trunks may not be shared between multiple threads under any circumstances.
4950 *
4951 * @param[in] ctx To use for any memory allocations. Must be thread local.
4952 * @param[in] el to use for I/O and timer events.
4953 * @param[in] funcs Callback functions.
4954 * @param[in] conf Common user configurable parameters.
4955 * @param[in] log_prefix To prepend to global messages.
4956 * @param[in] uctx User data to pass to the alloc function.
4957 * @param[in] delay_start If true, then we will not spawn any connections
4958 * until the first request is enqueued.
4959 * @param[in] trigger_args Pairs to pass to trigger requests, if triggers are enabled.
4960 * @return
4961 * - New trunk handle on success.
4962 * - NULL on error.
4963 */
4964trunk_t *trunk_alloc(TALLOC_CTX *ctx, fr_event_list_t *el,
4965 trunk_io_funcs_t const *funcs, trunk_conf_t const *conf,
4966 char const *log_prefix, void const *uctx, bool delay_start, fr_pair_list_t *trigger_args)
4967{
4968 trunk_t *trunk;
4969 size_t i;
4970
4971 /*
4972 * Check we have the functions we need
4973 */
4974 if (!fr_cond_assert(funcs->connection_alloc)) return NULL;
4975
4976 MEM(trunk = talloc_zero(ctx, trunk_t));
4977 trunk->el = el;
4978 trunk->log_prefix = talloc_strdup(trunk, log_prefix);
4979 trunk->trigger_args = trigger_args;
4980
4981 memcpy(&trunk->funcs, funcs, sizeof(trunk->funcs));
4982 if (!trunk->funcs.connection_prioritise) {
4983 trunk->funcs.connection_prioritise = _trunk_connection_order_by_shortest_queue;
4984 }
4985 if (!trunk->funcs.request_prioritise) trunk->funcs.request_prioritise = fr_pointer_cmp;
4986
4987 memcpy(&trunk->conf, conf, sizeof(trunk->conf));
4988
4989 memcpy(&trunk->uctx, &uctx, sizeof(trunk->uctx));
4990 talloc_set_destructor(trunk, _trunk_free);
4991
4992 /*
4993 * Unused request list...
4994 */
4995 fr_dlist_talloc_init(&trunk->free_requests, trunk_request_t, entry);
4996
4997 /*
4998 * Request backlog queue
4999 */
5000 MEM(trunk->backlog = fr_heap_talloc_alloc(trunk, _trunk_request_prioritise,
5001 trunk_request_t, heap_id, 0));
5002
5003 /*
5004 * Connection queues and trees
5005 */
5006 MEM(trunk->active = fr_minmax_heap_talloc_alloc(trunk, trunk->funcs.connection_prioritise,
5007 trunk_connection_t, heap_id, 0));
5008 fr_dlist_talloc_init(&trunk->init, trunk_connection_t, entry);
5009 fr_dlist_talloc_init(&trunk->connecting, trunk_connection_t, entry);
5010 fr_dlist_talloc_init(&trunk->full, trunk_connection_t, entry);
5011 fr_dlist_talloc_init(&trunk->inactive, trunk_connection_t, entry);
5012 fr_dlist_talloc_init(&trunk->inactive_draining, trunk_connection_t, entry);
5013 fr_dlist_talloc_init(&trunk->closed, trunk_connection_t, entry);
5014 fr_dlist_talloc_init(&trunk->draining, trunk_connection_t, entry);
5015 fr_dlist_talloc_init(&trunk->draining_to_free, trunk_connection_t, entry);
5016 fr_dlist_talloc_init(&trunk->to_free, trunk_connection_t, entry);
5017
5018 /*
5019 * Watch lists
5020 */
5021 for (i = 0; i < NUM_ELEMENTS(trunk->watch); i++) {
5022 fr_dlist_talloc_init(&trunk->watch[i], trunk_watch_entry_t, entry);
5023 }
5024
5025 DEBUG4("Trunk allocated %p", trunk);
5026
5027 if (!delay_start) {
5028 if (trunk_start(trunk) < 0) {
5029 talloc_free(trunk);
5030 return NULL;
5031 }
5032 }
5033
5034 return trunk;
5035}
5036
5037/** Check for a module trigger section when parsing the `triggers` option.
5038 *
5039 */
5040int trunk_trigger_cf_parse(TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
5041{
5042 trunk_conf_t *conf = parent;
5043 CONF_SECTION *cs = cf_item_to_section(cf_parent(ci));
5044
5045 if (cf_pair_parse_value(ctx, out, parent, ci, rule)< 0) return -1;
5046
5047 /*
5048 * If the parent section of the `triggers` option contains a trigger
5049 * section then store it as the module CONF SECTION for the appropriate
5050 * trigger group.
5051 */
5052 if (cf_section_find(cs, "trigger", NULL)) {
5053 if (strcmp(cf_section_name(cs), "request") == 0) {
5054 conf->req_trigger_cs = cs;
5055 } else {
5056 conf->conn_trigger_cs = cs;
5057 }
5058 }
5059
5060 return 0;
5061}
5062
5063#ifndef TALLOC_GET_TYPE_ABORT_NOOP
5064/** Verify a trunk
5065 *
5066 * A trunk has some number of connections, which each have some number of requests. The connections and
5067 * requests are in differing kinds of containers depending on their state and how they are used, and may
5068 * have fields that can only be validated by comparison with a parent. We had planned on passing a "context"
5069 * down with the ancestral values, but that breaks the foo_verify() API. Each foo_verify() will only verify the
5070 * foo's children.
5071 */
5072void trunk_verify(char const *file, int line, trunk_t *trunk)
5073{
5074 fr_fatal_assert_msg(trunk, "CONSISTENCY CHECK FAILED %s[%i]: trunk_t pointer was NULL", file, line);
5075 (void) talloc_get_type_abort(trunk, trunk_t);
5076
5077 for (size_t i = 0; i < NUM_ELEMENTS(trunk->watch); i++) {
5078 _fr_dlist_verify(file, line, &trunk->watch[i]);
5079 }
5080
5081#define IO_FUNC_VERIFY(_func) \
5082 fr_fatal_assert_msg(trunk->funcs._func, "CONSISTENCY_CHECK_FAILED %s[%i}: " #_func " was NULL", file, line)
5083
5084 /*
5085 * Only a few of the function pointers *must* be non-NULL..
5086 */
5087 IO_FUNC_VERIFY(connection_alloc);
5088 IO_FUNC_VERIFY(connection_prioritise);
5089 IO_FUNC_VERIFY(request_prioritise);
5090
5091#define TRUNK_TCONN_CHECKS(_tconn, _state) \
5092do { \
5093 fr_fatal_assert_msg(trunk == _tconn->pub.trunk, \
5094 "CONSISTENCY_CHECK_FAILED %s[%i}: connection-trunk mismatch", file, line); \
5095 fr_fatal_assert_msg(_state == _tconn->pub.state, \
5096 "CONSISTENCY_CHECK_FAILED %s[%i}: connection-state mismatch", file, line); \
5097} while (0)
5098
5099#define TCONN_DLIST_VERIFY(_dlist, _state) \
5100do { \
5101 _fr_dlist_verify(file, line, &(trunk->_dlist)); \
5102 fr_dlist_foreach(&(trunk->_dlist), trunk_connection_t, tconn) { \
5103 trunk_connection_verify(file, line, tconn); \
5104 TRUNK_TCONN_CHECKS(tconn, _state); \
5105 } \
5106} while (0)
5107
5108#define TCONN_MINMAX_HEAP_VERIFY(_heap, _state) \
5109do {\
5110 fr_minmax_heap_verify(file, line, trunk->_heap); \
5111 fr_minmax_heap_foreach(trunk->_heap, trunk_connection_t, tconn) { \
5112 trunk_connection_verify(file, line, tconn); \
5113 TRUNK_TCONN_CHECKS(tconn, _state); \
5114 }} \
5115} while (0)
5116
5117 fr_dlist_verify(&(trunk->free_requests));
5118 FR_HEAP_VERIFY(trunk->backlog);
5119
5120 TCONN_DLIST_VERIFY(init, TRUNK_CONN_INIT);
5121 TCONN_DLIST_VERIFY(connecting, TRUNK_CONN_CONNECTING);
5122 TCONN_MINMAX_HEAP_VERIFY(active, TRUNK_CONN_ACTIVE);
5123 TCONN_DLIST_VERIFY(full, TRUNK_CONN_FULL);
5124 TCONN_DLIST_VERIFY(inactive, TRUNK_CONN_INACTIVE);
5125 TCONN_DLIST_VERIFY(inactive_draining, TRUNK_CONN_INACTIVE_DRAINING);
5126 /* TCONN_DLIST_VERIFY(failed, ???); */
5127 TCONN_DLIST_VERIFY(closed, TRUNK_CONN_CLOSED);
5128 TCONN_DLIST_VERIFY(draining, TRUNK_CONN_DRAINING);
5129 TCONN_DLIST_VERIFY(draining_to_free, TRUNK_CONN_DRAINING_TO_FREE);
5130 TCONN_DLIST_VERIFY(to_free, TRUNK_CONN_HALTED);
5131}
5132
5133void trunk_connection_verify(char const *file, int line, trunk_connection_t *tconn)
5134{
5135 fr_fatal_assert_msg(tconn, "CONSISTENCY CHECK FAILED %s[%i]: trunk_connection_t pointer was NULL", file, line);
5136 (void) talloc_get_type_abort(tconn, trunk_connection_t);
5137
5138 (void) talloc_get_type_abort(tconn->pub.trunk, trunk_t);
5139
5140 /*
5141 * shouldn't be both in heap and on list--but it doesn't look like moves
5142 * to active heap wipe the dlist pointers.
5143 */
5144
5145#define TCONN_TREQ_CHECKS(_treq, _state) \
5146do { \
5147 fr_fatal_assert_msg(tconn == _treq->pub.tconn, \
5148 "CONSISTENCY_CHECK_FAILED %s[%i}: trunk request-tconn mismatch", file, line); \
5149 fr_fatal_assert_msg(tconn->pub.trunk == _treq->pub.trunk, \
5150 "CONSISTENCY_CHECK_FAILED %s[%i}: trunk request-trunk mismatch", file, line); \
5151 fr_fatal_assert_msg(_state == _treq->pub.state, \
5152 "CONSISTENCY_CHECK_FAILED %s[%i}: trunk request-state mismatch", file, line); \
5153} while (0)
5154
5155#define TREQ_DLIST_VERIFY(_dlist, _state) \
5156do { \
5157 _fr_dlist_verify(file, line, &(tconn->_dlist)); \
5158 fr_dlist_foreach(&(tconn->_dlist), trunk_request_t, treq) { \
5159 trunk_request_verify(file, line, treq); \
5160 TCONN_TREQ_CHECKS(treq, _state); \
5161 } \
5162} while (0)
5163
5164#define TREQ_HEAP_VERIFY(_heap, _state) \
5165do { \
5166 fr_heap_iter_t _iter; \
5167 fr_heap_verify(file, line, tconn->_heap); \
5168 for (trunk_request_t *treq = fr_heap_iter_init(tconn->_heap, &_iter); \
5169 treq; \
5170 treq = fr_heap_iter_next(tconn->_heap, &_iter)) { \
5171 trunk_request_verify(file, line, treq); \
5172 TCONN_TREQ_CHECKS(treq, _state); \
5173 } \
5174} while (0)
5175
5176#define TREQ_OPTION_VERIFY(_option, _state) \
5177do { \
5178 if (tconn->_option) { \
5179 trunk_request_verify(file, line, tconn->_option); \
5180 TCONN_TREQ_CHECKS(tconn->_option, _state); \
5181 } \
5182} while (0)
5183
5184 /* verify associated requests */
5185 TREQ_HEAP_VERIFY(pending, TRUNK_REQUEST_STATE_PENDING);
5186 TREQ_DLIST_VERIFY(sent, TRUNK_REQUEST_STATE_SENT);
5187 TREQ_DLIST_VERIFY(cancel, TRUNK_REQUEST_STATE_CANCEL);
5188 TREQ_DLIST_VERIFY(cancel_sent, TRUNK_REQUEST_STATE_CANCEL_SENT);
5189 TREQ_OPTION_VERIFY(partial, TRUNK_REQUEST_STATE_PARTIAL);
5190 TREQ_OPTION_VERIFY(cancel_partial, TRUNK_REQUEST_STATE_CANCEL_PARTIAL);
5191}
5192
5193void trunk_request_verify(char const *file, int line, trunk_request_t *treq)
5194{
5195 fr_fatal_assert_msg(treq, "CONSISTENCY CHECK FAILED %s[%i]: trunk_request_t pointer was NULL", file, line);
5196 (void) talloc_get_type_abort(treq, trunk_request_t);
5197
5198#ifdef WITH_VERIFY_PTR
5199 if (treq->pub.request) request_verify(file, line, treq->pub.request);
5200#endif
5201}
5202
5203
5204bool trunk_search(trunk_t *trunk, void *ptr)
5205{
5206#define TCONN_DLIST_SEARCH(_dlist) \
5207do { \
5208 fr_dlist_foreach(&(trunk->_dlist), trunk_connection_t, tconn) { \
5209 if (ptr == tconn) { \
5210 fr_fprintf(stderr, "trunk_search: tconn %p on " #_dlist "\n", ptr); \
5211 return true; \
5212 } \
5213 if (trunk_connection_search(tconn, ptr)) { \
5214 fr_fprintf(stderr, " in tconn %p on " #_dlist "\n", tconn); \
5215 return true; \
5216 } \
5217 } \
5218} while (0)
5219
5220#define TCONN_MINMAX_HEAP_SEARCH(_heap) \
5221do { \
5222 fr_minmax_heap_foreach(trunk->_heap, trunk_connection_t, tconn) { \
5223 if (ptr == tconn) { \
5224 fr_fprintf(stderr, "trunk_search: tconn %p on " #_heap "\n", ptr); \
5225 return true; \
5226 } \
5227 if (trunk_connection_search(tconn, ptr)) { \
5228 fr_fprintf(stderr, " on tconn %p on " #_heap "\n", tconn); \
5229 return true; \
5230 } \
5231 }}\
5232} while (0)
5233
5234 TCONN_DLIST_SEARCH(init);
5235 TCONN_DLIST_SEARCH(connecting);
5236 TCONN_MINMAX_HEAP_SEARCH(active);
5237 TCONN_DLIST_SEARCH(full);
5238 TCONN_DLIST_SEARCH(inactive);
5239 TCONN_DLIST_SEARCH(inactive_draining);
5240 TCONN_DLIST_SEARCH(failed);
5241 TCONN_DLIST_SEARCH(closed);
5242 TCONN_DLIST_SEARCH(draining);
5243 TCONN_DLIST_SEARCH(draining_to_free);
5244 TCONN_DLIST_SEARCH(to_free);
5245
5246 return false;
5247}
5248
5249bool trunk_connection_search(trunk_connection_t *tconn, void *ptr)
5250{
5251#define TREQ_DLIST_SEARCH(_dlist) \
5252do { \
5253 fr_dlist_foreach(&(tconn->_dlist), trunk_request_t, treq) { \
5254 if (ptr == treq) { \
5255 fr_fprintf(stderr, "trunk_search: treq %p on " #_dlist "\n", ptr); \
5256 return true; \
5257 } \
5258 if (trunk_request_search(treq, ptr)) { \
5259 fr_fprintf(stderr, "trunk_search: preq %p found on " #_dlist, ptr); \
5260 return true; \
5261 } \
5262 } \
5263} while (0)
5264
5265#define TREQ_HEAP_SEARCH(_heap) \
5266do { \
5267 fr_heap_iter_t _iter; \
5268 for (trunk_request_t *treq = fr_heap_iter_init(tconn->_heap, &_iter); \
5269 treq; \
5270 treq = fr_heap_iter_next(tconn->_heap, &_iter)) { \
5271 if (ptr == treq) { \
5272 fr_fprintf(stderr, "trunk_search: treq %p in " #_heap "\n", ptr); \
5273 return true; \
5274 } \
5275 if (trunk_request_search(treq, ptr)) { \
5276 fr_fprintf(stderr, "trunk_search: preq %p found in " #_heap, ptr); \
5277 return true; \
5278 } \
5279 } \
5280} while (0)
5281
5282#define TREQ_OPTION_SEARCH(_option) \
5283do { \
5284 if (tconn->_option) { \
5285 if (ptr == tconn->_option) { \
5286 fr_fprintf(stderr, "trunk_search: treq %p is " #_option "\n", ptr); \
5287 return true; \
5288 } \
5289 if (trunk_request_search(tconn->_option, ptr)) { \
5290 fr_fprintf(stderr, "trunk_search: preq %p found in " #_option, ptr); \
5291 return true; \
5292 } \
5293 } \
5294} while (0)
5295
5296 /* search associated requests */
5297 TREQ_HEAP_SEARCH(pending);
5298 TREQ_DLIST_SEARCH(sent);
5299 TREQ_DLIST_SEARCH(cancel);
5300 TREQ_DLIST_SEARCH(cancel_sent);
5301 TREQ_OPTION_SEARCH(partial);
5302 TREQ_OPTION_SEARCH(cancel_partial);
5303
5304 return false;
5305}
5306
5307bool trunk_request_search(trunk_request_t *treq, void *ptr)
5308{
5309 return treq->pub.preq == ptr;
5310}
5311#endif
file
int const char * file
Definition acutest.h:704
line
int const char int line
Definition acutest.h:704
request_verify
void request_verify(UNUSED char const *file, UNUSED int line, UNUSED request_t *request)
Definition atomic_queue_test.c:45
init
static bool init
Definition fuzzer.c:42
L
#define L(_str)
Helper for initialising arrays of string literals.
Definition build.h:209
NDEBUG_UNUSED
#define NDEBUG_UNUSED
Definition build.h:328
FALL_THROUGH
#define FALL_THROUGH
clang 10 doesn't recognised the FALL-THROUGH comment anymore
Definition build.h:324
unlikely
#define unlikely(_x)
Definition build.h:383
UNUSED
#define UNUSED
Definition build.h:317
NUM_ELEMENTS
#define NUM_ELEMENTS(_t)
Definition build.h:339
cf_pair_parse_value
int cf_pair_parse_value(TALLOC_CTX *ctx, void *out, UNUSED void *base, CONF_ITEM *ci, conf_parser_t const *rule)
Parses a CONF_PAIR into a C data type.
Definition cf_parse.c:214
CONF_PARSER_TERMINATOR
#define CONF_PARSER_TERMINATOR
Definition cf_parse.h:660
conf_parser_s::func
cf_parse_t func
Override default parsing behaviour for the specified type with a custom parsing function.
Definition cf_parse.h:614
FR_CONF_OFFSET
#define FR_CONF_OFFSET(_name, _struct, _field)
conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct
Definition cf_parse.h:283
FR_CONF_POINTER
#define FR_CONF_POINTER(_name, _type, _flags, _res_p)
conf_parser_t which parses a single CONF_PAIR producing a single global result
Definition cf_parse.h:337
FR_CONF_OFFSET_SUBSECTION
#define FR_CONF_OFFSET_SUBSECTION(_name, _flags, _struct, _field, _subcs)
conf_parser_t which populates a sub-struct using a CONF_SECTION
Definition cf_parse.h:312
CONF_FLAG_SUBSECTION
@ CONF_FLAG_SUBSECTION
Instead of putting the information into a configuration structure, the configuration file routines MA...
Definition cf_parse.h:426
conf_parser_s
Defines a CONF_PAIR to C data type mapping.
Definition cf_parse.h:597
cf_item
Common header for all CONF_* types.
Definition cf_priv.h:49
cf_pair
Configuration AVP similar to a fr_pair_t.
Definition cf_priv.h:70
cf_section
A section grouping multiple CONF_PAIR.
Definition cf_priv.h:101
cf_section_find
CONF_SECTION * cf_section_find(CONF_SECTION const *cs, char const *name1, char const *name2)
Find a CONF_SECTION with name1 and optionally name2.
Definition cf_util.c:1027
cf_item_to_section
CONF_SECTION * cf_item_to_section(CONF_ITEM const *ci)
Cast a CONF_ITEM to a CONF_SECTION.
Definition cf_util.c:683
cf_section_name
char const * cf_section_name(CONF_SECTION const *cs)
Return name2 if set, else name1.
Definition cf_util.c:1196
cf_parent
#define cf_parent(_cf)
Definition cf_util.h:101
connection_state_t
connection_state_t
Definition connection.h:47
CONNECTION_STATE_FAILED
@ CONNECTION_STATE_FAILED
Connection has failed.
Definition connection.h:56
CONNECTION_STATE_HALTED
@ CONNECTION_STATE_HALTED
The connection is in a halted stat.
Definition connection.h:48
CONNECTION_STATE_CLOSED
@ CONNECTION_STATE_CLOSED
Connection has been closed.
Definition connection.h:57
CONNECTION_STATE_CONNECTED
@ CONNECTION_STATE_CONNECTED
File descriptor is open (ready for writing).
Definition connection.h:54
CONNECTION_STATE_INIT
@ CONNECTION_STATE_INIT
Init state, sets up connection.
Definition connection.h:51
CONNECTION_STATE_CONNECTING
@ CONNECTION_STATE_CONNECTING
Waiting for connection to establish.
Definition connection.h:52
CONNECTION_STATE_SHUTDOWN
@ CONNECTION_STATE_SHUTDOWN
Connection is shutting down.
Definition connection.h:55
connection_reason_t
connection_reason_t
Definition connection.h:84
connection_conf_t
Definition connection.h:92
min
static size_t min(size_t x, size_t y)
Definition dbuff.c:66
fr_cond_assert
#define fr_cond_assert(_x)
Calls panic_action ifndef NDEBUG, else logs error and evaluates to value of _x.
Definition debug.h:131
fr_assert_msg
#define fr_assert_msg(_x, _msg,...)
Calls panic_action ifndef NDEBUG, else logs error and causes the server to exit immediately with code...
Definition debug.h:202
fr_cond_assert_msg
#define fr_cond_assert_msg(_x, _fmt,...)
Calls panic_action ifndef NDEBUG, else logs error and evaluates to value of _x.
Definition debug.h:148
fr_fatal_assert_msg
#define fr_fatal_assert_msg(_x, _fmt,...)
Calls panic_action ifndef NDEBUG, else logs error and causes the server to exit immediately with code...
Definition debug.h:176
MEM
#define MEM(x)
Definition debug.h:36
DEBUG
#define DEBUG(fmt,...)
Definition dhcpclient.c:39
fr_dlist_init
#define fr_dlist_init(_head, _type, _field)
Initialise the head structure of a doubly linked list.
Definition dlist.h:260
fr_dlist_head
static void * fr_dlist_head(fr_dlist_head_t const *list_head)
Return the HEAD item of a list or NULL if the list is empty.
Definition dlist.h:486
_fr_dlist_verify
static void _fr_dlist_verify(char const *file, int line, fr_dlist_head_t const *list_head)
Check all items in the list are valid.
Definition dlist.h:735
fr_dlist_remove
static void * fr_dlist_remove(fr_dlist_head_t *list_head, void *ptr)
Remove an item from the list.
Definition dlist.h:638
fr_dlist_entry_in_list
static bool fr_dlist_entry_in_list(fr_dlist_t const *entry)
Check if a list entry is part of a list.
Definition dlist.h:163
fr_dlist_prev
static void * fr_dlist_prev(fr_dlist_head_t const *list_head, void const *ptr)
Get the previous item in a list.
Definition dlist.h:588
fr_dlist_num_elements
static unsigned int fr_dlist_num_elements(fr_dlist_head_t const *head)
Return the number of elements in the dlist.
Definition dlist.h:939
fr_dlist_pop_head
static void * fr_dlist_pop_head(fr_dlist_head_t *list_head)
Remove the head item in a list.
Definition dlist.h:672
fr_dlist_tail
static void * fr_dlist_tail(fr_dlist_head_t const *list_head)
Return the TAIL item of a list or NULL if the list is empty.
Definition dlist.h:531
fr_dlist_insert_tail
static int fr_dlist_insert_tail(fr_dlist_head_t *list_head, void *ptr)
Insert an item into the tail of a list.
Definition dlist.h:378
fr_dlist_verify
#define fr_dlist_verify(_head)
Definition dlist.h:755
fr_dlist_talloc_init
#define fr_dlist_talloc_init(_head, _type, _field)
Initialise the head structure of a doubly linked list.
Definition dlist.h:275
fr_dlist_insert_head
static int fr_dlist_insert_head(fr_dlist_head_t *list_head, void *ptr)
Insert an item into the head of a list.
Definition dlist.h:338
fr_dlist_next
static void * fr_dlist_next(fr_dlist_head_t const *list_head, void const *ptr)
Get the next item in a list.
Definition dlist.h:555
fr_dlist_head_t
Head of a doubly linked list.
Definition dlist.h:51
fr_dlist_s
Entry in a doubly linked list.
Definition dlist.h:41
fr_heap_insert
int fr_heap_insert(fr_heap_t **hp, void *data)
Insert a new element into the heap.
Definition heap.c:146
fr_heap_index_t
unsigned int fr_heap_index_t
Definition heap.h:80
fr_heap_peek
static void * fr_heap_peek(fr_heap_t *h)
Return the item from the top of the heap but don't pop it.
Definition heap.h:136
FR_HEAP_VERIFY
#define FR_HEAP_VERIFY(_heap)
Definition heap.h:212
fr_heap_num_elements
static unsigned int fr_heap_num_elements(fr_heap_t *h)
Return the number of elements in the heap.
Definition heap.h:179
fr_heap_talloc_alloc
#define fr_heap_talloc_alloc(_ctx, _cmp, _talloc_type, _field, _init)
Creates a heap that verifies elements are of a specific talloc type.
Definition heap.h:115
fr_heap_t
The main heap structure.
Definition heap.h:66
PERROR
#define PERROR(_fmt,...)
Definition log.h:228
DEBUG3
#define DEBUG3(_fmt,...)
Definition log.h:266
ROPTIONAL
#define ROPTIONAL(_l_request, _l_global, _fmt,...)
Use different logging functions depending on whether request is NULL or not.
Definition log.h:528
RDEBUG3
#define RDEBUG3(fmt,...)
Definition log.h:343
RWARN
#define RWARN(fmt,...)
Definition log.h:297
DEBUG4
#define DEBUG4(_fmt,...)
Definition log.h:267
RATE_LIMIT_LOCAL_ROPTIONAL
#define RATE_LIMIT_LOCAL_ROPTIONAL(_entry, _l_request, _l_global, _fmt,...)
Rate limit messages using a local limiting entry.
Definition log.h:606
fr_rate_limit_t
Track when a log message was last repeated.
Definition log.h:547
talloc_free
talloc_free(reap)
fr_event_list_s
Stores all information relating to an event list.
Definition event.c:377
fr_log
void fr_log(fr_log_t const *log, fr_log_type_t type, char const *file, int line, char const *fmt,...)
Send a server log message to its destination.
Definition log.c:577
fr_log_type_t
fr_log_type_t
Definition log.h:54
ROUND_UP_DIV
#define ROUND_UP_DIV(_x, _y)
Get the ceiling value of integer division.
Definition math.h:211
uint16_t
unsigned short uint16_t
Definition merged_model.c:31
uint32_t
unsigned int uint32_t
Definition merged_model.c:33
request_t
Definition merged_model.c:210
fr_minmax_heap_insert
int fr_minmax_heap_insert(fr_minmax_heap_t *hp, void *data)
Definition minmax_heap.c:424
fr_minmax_heap_iter_next
void * fr_minmax_heap_iter_next(fr_minmax_heap_t *hp, fr_minmax_heap_iter_t *iter)
Get the next entry in a minmax heap.
Definition minmax_heap.c:573
fr_minmax_heap_min_peek
void * fr_minmax_heap_min_peek(fr_minmax_heap_t *hp)
Definition minmax_heap.c:449
fr_minmax_heap_max_peek
void * fr_minmax_heap_max_peek(fr_minmax_heap_t *hp)
Definition minmax_heap.c:466
fr_minmax_heap_num_elements
unsigned int fr_minmax_heap_num_elements(fr_minmax_heap_t *hp)
Return the number of elements in the minmax heap.
Definition minmax_heap.c:533
fr_minmax_heap_iter_init
void * fr_minmax_heap_iter_init(fr_minmax_heap_t *hp, fr_minmax_heap_iter_t *iter)
Iterate over entries in a minmax heap.
Definition minmax_heap.c:551
fr_minmax_heap_extract
int fr_minmax_heap_extract(fr_minmax_heap_t *hp, void *data)
Definition minmax_heap.c:486
fr_minmax_heap_s
Definition minmax_heap.c:53
fr_minmax_heap_iter_t
unsigned int fr_minmax_heap_iter_t
Definition minmax_heap.h:38
fr_minmax_heap_talloc_alloc
#define fr_minmax_heap_talloc_alloc(_ctx, _cmp, _talloc_type, _field, _init)
Creates a minmax heap that verifies elements are of a specific talloc type.
Definition minmax_heap.h:85
fr_pointer_cmp
int8_t fr_pointer_cmp(void const *a, void const *b)
Compares two pointers.
Definition misc.c:450
request_prioritise
static int8_t request_prioritise(void const *one, void const *two)
Definition bio.c:1153
fr_assert
#define fr_assert(_expr)
Definition rad_assert.h:38
done
static bool done
Definition radclient.c:83
RDEBUG
#define RDEBUG(fmt,...)
Definition radclient.h:53
DEBUG2
#define DEBUG2(fmt,...)
Definition radclient.h:43
WARN
#define WARN(fmt,...)
Definition radclient.h:47
INFO
#define INFO(fmt,...)
Definition radict.c:60
events
static fr_event_list_t * events
Definition radsniff.c:59
conf
static rs_t * conf
Definition radsniff.c:53
connection_signal_shutdown
void connection_signal_shutdown(connection_t *conn)
Shuts down a connection gracefully.
Definition connection.c:1230
connection_del_watch_post
int connection_del_watch_post(connection_t *conn, connection_state_t state, connection_watch_t watch)
Remove a watch function from a post list.
Definition connection.c:474
connection_signal_halt
void connection_signal_halt(connection_t *conn)
Shuts down a connection ungracefully.
Definition connection.c:1293
connection_signals_resume
void connection_signals_resume(connection_t *conn)
Resume processing of deferred signals.
Definition connection.c:321
connection_signal_reconnect
void connection_signal_reconnect(connection_t *conn, connection_reason_t reason)
Asynchronously signal the connection should be reconnected.
Definition connection.c:1169
connection_signal_init
void connection_signal_init(connection_t *conn)
Asynchronously signal a halted connection to start.
Definition connection.c:1109
connection_alloc
connection_t * connection_alloc(TALLOC_CTX *ctx, fr_event_list_t *el, connection_funcs_t const *funcs, connection_conf_t const *conf, char const *log_prefix, void const *uctx)
Allocate a new connection.
Definition connection.c:1513
connection_add_watch_pre
connection_watch_entry_t * connection_add_watch_pre(connection_t *conn, connection_state_t state, connection_watch_t watch, bool oneshot, void const *uctx)
Add a callback to be executed before a state function has been called.
Definition connection.c:512
connection_add_watch_post
connection_watch_entry_t * connection_add_watch_post(connection_t *conn, connection_state_t state, connection_watch_t watch, bool oneshot, void const *uctx)
Add a callback to be executed after a state function has been called.
Definition connection.c:534
connection_del_watch_pre
int connection_del_watch_pre(connection_t *conn, connection_state_t state, connection_watch_t watch)
Remove a watch function from a pre list.
Definition connection.c:457
connection_signals_pause
void connection_signals_pause(connection_t *conn)
Pause processing of deferred signals.
Definition connection.c:312
connection_s
Definition connection.c:87
test_time_base
static fr_time_t test_time_base
Definition slab_tests.c:42
count
return count
Definition module.c:155
test_time
fr_time_t test_time
Definition state_test.c:3
fr_time
#define fr_time()
Allow us to arbitrarily manipulate time.
Definition state_test.c:8
memory_order_relaxed
@ memory_order_relaxed
Definition stdatomic.h:127
atomic_fetch_add_explicit
#define atomic_fetch_add_explicit(object, operand, order)
Definition stdatomic.h:302
ATOMIC_VAR_INIT
#define ATOMIC_VAR_INIT(value)
Definition stdatomic.h:88
fr_log_s
Definition log.h:96
pair_list_s
Definition pair.h:52
fr_table_str_by_value
#define fr_table_str_by_value(_table, _number, _def)
Convert an integer to a string.
Definition table.h:772
fr_table_num_indexed_bit_pos_t
An element in a table indexed by bit position.
Definition table.h:83
fr_table_num_ordered_t
An element in an arbitrarily ordered array of name to num mappings.
Definition table.h:57
talloc_get_type_abort_const
#define talloc_get_type_abort_const
Definition talloc.h:244
talloc_pooled_object
#define talloc_pooled_object(_ctx, _type, _num_subobjects, _total_subobjects_size)
Definition talloc.h:180
fr_time_gteq
#define fr_time_gteq(_a, _b)
Definition time.h:238
fr_time_delta_wrap
#define fr_time_delta_wrap(_time)
Definition time.h:152
fr_time_wrap
#define fr_time_wrap(_time)
Definition time.h:145
fr_time_lteq
#define fr_time_lteq(_a, _b)
Definition time.h:240
fr_time_delta_ispos
#define fr_time_delta_ispos(_a)
Definition time.h:290
fr_time_add
#define fr_time_add(_a, _b)
Add a time/time delta together.
Definition time.h:196
fr_time_gt
#define fr_time_gt(_a, _b)
Definition time.h:237
fr_time_sub
#define fr_time_sub(_a, _b)
Subtract one time from another.
Definition time.h:229
fr_time_lt
#define fr_time_lt(_a, _b)
Definition time.h:239
fr_time_delta_gt
#define fr_time_delta_gt(_a, _b)
Definition time.h:283
fr_time_s
"server local" time.
Definition time.h:69
fr_timer_list_s
An event timer list.
Definition timer.c:50
fr_timer_s
A timer event.
Definition timer.c:84
FR_TIMER_DELETE
#define FR_TIMER_DELETE(_ev_p)
Definition timer.h:103
FR_TIMER_DELETE_RETURN
#define FR_TIMER_DELETE_RETURN(_ev_p)
Definition timer.h:110
fr_timer_in
#define fr_timer_in(...)
Definition timer.h:87
FR_TIMER_DISARM
#define FR_TIMER_DISARM(_ev)
Definition timer.h:91
trunk_search
bool trunk_search(trunk_t *trunk, void *ptr)
Definition trunk.c:5204
request_counter
static atomic_uint_fast64_t request_counter
Definition trunk.c:54
trunk_s::trigger_cp
CONF_PAIR * trigger_cp[NUM_ELEMENTS(trunk_conn_trigger_names)]
Cached trigger CONF_PAIRs.
Definition trunk.c:319
trunk_connection_enter_active
static void trunk_connection_enter_active(trunk_connection_t *tconn)
Transition a connection back to the active state.
Definition trunk.c:3266
CONN_REORDER
#define CONN_REORDER(_tconn)
Reorder the connections in the active heap.
Definition trunk.c:792
trunk_req_trigger_names_len
static size_t trunk_req_trigger_names_len
Definition trunk.c:388
trunk_connection_pop_cancellation
int trunk_connection_pop_cancellation(trunk_request_t **treq_out, trunk_connection_t *tconn)
Pop a cancellation request off a connection's cancellation queue.
Definition trunk.c:3853
trunk_connection_s::cancel
fr_dlist_head_t cancel
Requests in the cancel state.
Definition trunk.c:161
trunk_connection_manage_schedule
int trunk_connection_manage_schedule(trunk_t *trunk)
Schedule a trunk management event for the next time the event loop is executed.
Definition trunk.c:4846
REQUEST_EXTRACT_SENT
#define REQUEST_EXTRACT_SENT(_treq)
Remove the current request from the sent list.
Definition trunk.c:762
_trunk_connection_on_shutdown
static void _trunk_connection_on_shutdown(UNUSED connection_t *conn, UNUSED connection_state_t prev, UNUSED connection_state_t state, void *uctx)
Connection transitioned to the shutdown state.
Definition trunk.c:3416
trunk_watch_entry_t
struct trunk_watch_entry_s trunk_watch_entry_t
An entry in a trunk watch function list.
trunk_connection_s::reapable
fr_dlist_head_t reapable
Idle request.
Definition trunk.c:159
trunk_connection_s::pending
fr_heap_t * pending
Requests waiting to be sent.
Definition trunk.c:153
trunk_s::conf
trunk_conf_t conf
Trunk common configuration.
Definition trunk.c:224
trunk_connection_states_len
static size_t trunk_connection_states_len
Definition trunk.c:427
REQUEST_EXTRACT_REAPABLE
#define REQUEST_EXTRACT_REAPABLE(_treq)
Remove the current request from the reapable list.
Definition trunk.c:767
trunk_request_state_log_t::tconn
trunk_connection_t * tconn
The request was associated with.
Definition trunk.c:82
trunk_connection_callback_readable
void trunk_connection_callback_readable(UNUSED fr_event_list_t *el, UNUSED int fd, UNUSED int flags, void *uctx)
Standard I/O read function.
Definition trunk.c:4032
trunk_s::limit_last_failure_log
fr_rate_limit_t limit_last_failure_log
Rate limit on "Refusing to enqueue requests - No active conns".
Definition trunk.c:298
trunk_verify
void trunk_verify(char const *file, int line, trunk_t *trunk)
Verify a trunk.
Definition trunk.c:5072
trunk_s::manage_ev
fr_timer_t * manage_ev
Periodic connection management event.
Definition trunk.c:290
IN_HANDLER
#define IN_HANDLER(_trunk)
Definition trunk.c:722
trunk_connection_states
static fr_table_num_ordered_t const trunk_connection_states[]
Definition trunk.c:415
trunk_reconnect
void trunk_reconnect(trunk_t *trunk, int states, connection_reason_t reason)
Force the trunk to re-establish its connections.
Definition trunk.c:4742
trunk_connection_callback_writable
void trunk_connection_callback_writable(UNUSED fr_event_list_t *el, UNUSED int fd, UNUSED int flags, void *uctx)
Standard I/O write function.
Definition trunk.c:4049
trunk_watch_entry_s::uctx
void * uctx
User data to pass to the function.
Definition trunk.c:191
trunk_request_enter_pending
static void trunk_request_enter_pending(trunk_request_t *treq, trunk_connection_t *tconn, bool new)
Transition a request to the pending state, adding it to the backlog of an active connection.
Definition trunk.c:1170
trunk_request_remove_from_conn
static void trunk_request_remove_from_conn(trunk_request_t *treq)
Remove a request from all connection lists.
Definition trunk.c:979
trunk_s::limit_max_requests_alloc_log
fr_rate_limit_t limit_max_requests_alloc_log
Rate limit on "Refusing to alloc requests - Limit of * requests reached".
Definition trunk.c:296
trunk_request_state_log_t::to
trunk_request_state_t to
What state we transitioned to.
Definition trunk.c:80
_trunk_request_prioritise
static int8_t _trunk_request_prioritise(void const *a, void const *b)
Compare two protocol requests.
Definition trunk.c:955
trunk_manage
static void trunk_manage(trunk_t *trunk, fr_time_t now)
Implements the algorithm we use to manage requests per connection levels.
Definition trunk.c:4181
_trunk_connection_free
static int _trunk_connection_free(trunk_connection_t *tconn)
Free a connection.
Definition trunk.c:3698
trunk_s::funcs
trunk_io_funcs_t funcs
I/O functions.
Definition trunk.c:276
trunk_s::draining
fr_dlist_head_t draining
Connections that will be freed once all their requests are complete, but can be reactivated.
Definition trunk.c:261
REQUEST_EXTRACT_CANCEL_PARTIAL
#define REQUEST_EXTRACT_CANCEL_PARTIAL(_treq)
Remove the current request from the cancel_partial slot.
Definition trunk.c:777
trunk_trigger_cf_parse
int trunk_trigger_cf_parse(TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
Check for a module trigger section when parsing the triggers option.
Definition trunk.c:5040
trunk_start
int trunk_start(trunk_t *trunk)
Start the trunk running.
Definition trunk.c:4781
trunk_request_signal_partial
void trunk_request_signal_partial(trunk_request_t *treq)
Signal a partial write.
Definition trunk.c:2047
trunk_request_signal_fail
void trunk_request_signal_fail(trunk_request_t *treq)
Signal that a trunk request failed.
Definition trunk.c:2150
TREQ_OPTION_SEARCH
#define TREQ_OPTION_SEARCH(_option)
trunk_request_signal_cancel_sent
void trunk_request_signal_cancel_sent(trunk_request_t *treq)
Signal that a remote server has been notified of the cancellation.
Definition trunk.c:2278
trunk_connection_enter_draining_to_free
static void trunk_connection_enter_draining_to_free(trunk_connection_t *tconn)
Transition a connection to the draining-to-reconnect state.
Definition trunk.c:3230
trunk_watch_entry_s::func
trunk_watch_t func
Function to call when a trunk enters.
Definition trunk.c:187
trunk_connection_signal_readable
void trunk_connection_signal_readable(trunk_connection_t *tconn)
Signal that a trunk connection is readable.
Definition trunk.c:3939
DO_REQUEST_FREE
#define DO_REQUEST_FREE(_treq)
Call the free callback (if set)
Definition trunk.c:614
trunk_request_alloc
trunk_request_t * trunk_request_alloc(trunk_t *trunk, request_t *request)
(Pre-)Allocate a new trunk request
Definition trunk.c:2492
_trunk_connection_on_halted
static void _trunk_connection_on_halted(UNUSED connection_t *conn, UNUSED connection_state_t prev, UNUSED connection_state_t state, void *uctx)
Connection transitioned to the halted state.
Definition trunk.c:3650
REQUEST_EXTRACT_BACKLOG
#define REQUEST_EXTRACT_BACKLOG(_treq)
Remove the current request from the backlog.
Definition trunk.c:733
trunk_connection_s::heap_id
fr_heap_index_t heap_id
Used to track the connection in the connected heap.
Definition trunk.c:138
trunk_s::closed
fr_dlist_head_t closed
Connections that have closed.
Definition trunk.c:258
trunk_s::watch
fr_dlist_head_t watch[TRUNK_STATE_MAX]
To be called when trunk changes state.
Definition trunk.c:282
trunk_watch_call
static void trunk_watch_call(trunk_t *trunk, fr_dlist_head_t *list, trunk_state_t state)
Call a list of watch functions associated with a state.
Definition trunk.c:805
trunk_request_enter_cancel_complete
static void trunk_request_enter_cancel_complete(trunk_request_t *treq)
Cancellation was acked, the request is complete, free it.
Definition trunk.c:1522
trunk_request_state_log_t::line
int line
Line change occurred on.
Definition trunk.c:92
trunk_connection_enter_inactive_draining
static void trunk_connection_enter_inactive_draining(trunk_connection_t *tconn)
Transition a connection to the inactive-draining state.
Definition trunk.c:3168
CONN_STATE_TRANSITION
#define CONN_STATE_TRANSITION(_new, _log)
Definition trunk.c:457
trunk_requests_per_connection
static uint64_t trunk_requests_per_connection(uint16_t *conn_count_out, uint32_t *req_conn_out, trunk_t *trunk, fr_time_t now, NDEBUG_UNUSED bool verify)
Update timestamps for when we last had a transition from above target to below target or vice versa.
Definition trunk.c:4588
trunk_connection_events_len
static size_t trunk_connection_events_len
Definition trunk.c:443
_trunk_connection_on_failed
static void _trunk_connection_on_failed(connection_t *conn, connection_state_t prev, connection_state_t state, void *uctx)
Connection failed.
Definition trunk.c:3598
trunk_watch_entry_s::oneshot
bool oneshot
Remove the function after it's called once.
Definition trunk.c:189
trunk_s::started
bool started
Has the trunk been started.
Definition trunk.c:307
trunk_states_len
static size_t trunk_states_len
Definition trunk.c:413
TCONN_DLIST_VERIFY
#define TCONN_DLIST_VERIFY(_dlist, _state)
IO_FUNC_VERIFY
#define IO_FUNC_VERIFY(_func)
trunk_request_count_by_connection
uint32_t trunk_request_count_by_connection(trunk_connection_t const *tconn, int req_state)
Return the count number of requests associated with a trunk connection.
Definition trunk.c:2897
trunk_s::last_req_per_conn
uint64_t last_req_per_conn
The last request to connection ratio we calculated.
Definition trunk.c:312
DO_REQUEST_COMPLETE
#define DO_REQUEST_COMPLETE(_treq)
Call the complete callback (if set)
Definition trunk.c:575
trunk_connection_auto_full
static void trunk_connection_auto_full(trunk_connection_t *tconn)
Automatically mark a connection as full.
Definition trunk.c:2916
trunk_connection_remove
static void trunk_connection_remove(trunk_connection_t *tconn)
Remove a trunk connection from whichever list it's currently in.
Definition trunk.c:3067
TRUNK_REQUEST_STATE_LOG_MAX
#define TRUNK_REQUEST_STATE_LOG_MAX
The maximum number of state logs to record per request.
Definition trunk.c:71
trunk_connection_writable
static void trunk_connection_writable(trunk_connection_t *tconn)
A connection is writable.
Definition trunk.c:2980
OVER_MAX_CHECK
#define OVER_MAX_CHECK
trunk_connection_s::events
trunk_connection_event_t events
The current events we expect to be notified on.
Definition trunk.c:147
trunk_add_watch
trunk_watch_entry_t * trunk_add_watch(trunk_t *trunk, trunk_state_t state, trunk_watch_t watch, bool oneshot, void const *uctx)
Add a watch entry to the trunk state list.
Definition trunk.c:881
_trunk_free
static int _trunk_free(trunk_t *trunk)
Free a trunk, gracefully closing all connections.
Definition trunk.c:4879
trunk_s::failed
fr_dlist_head_t failed
Connections that'll be reconnected shortly.
Definition trunk.c:256
trunk_rebalance
static void trunk_rebalance(trunk_t *trunk)
Rebalance connections across active trunk members when a new connection becomes active.
Definition trunk.c:4117
trunk_backlog_drain
static void trunk_backlog_drain(trunk_t *trunk)
Drain the backlog of as many requests as possible.
Definition trunk.c:4687
DO_REQUEST_CANCEL
#define DO_REQUEST_CANCEL(_treq, _reason)
Call the cancel callback if set.
Definition trunk.c:536
_trunk_connection_order_by_shortest_queue
static int8_t _trunk_connection_order_by_shortest_queue(void const *one, void const *two)
Order connections by queue depth.
Definition trunk.c:4862
trunk_request_s::pub
struct trunk_request_pub_s pub
Public fields in the trunk request.
Definition trunk.c:100
TCONN_MINMAX_HEAP_VERIFY
#define TCONN_MINMAX_HEAP_VERIFY(_heap, _state)
trunk_connection_s::cancel_partial
trunk_request_t * cancel_partial
Partially written cancellation request.
Definition trunk.c:163
TCONN_MINMAX_HEAP_SEARCH
#define TCONN_MINMAX_HEAP_SEARCH(_heap)
trunk_connection_requests_requeue
uint64_t trunk_connection_requests_requeue(trunk_connection_t *tconn, int states, uint64_t max, bool fail_bound)
Move requests off of a connection and requeue elsewhere.
Definition trunk.c:2028
trunk_watch_entry_s::enabled
bool enabled
Whether the watch entry is enabled.
Definition trunk.c:190
trunk_request_s::last_freed
fr_time_t last_freed
Last time this request was freed.
Definition trunk.c:113
DO_REQUEST_CONN_RELEASE
#define DO_REQUEST_CONN_RELEASE(_treq)
Call the "conn_release" callback (if set)
Definition trunk.c:557
TREQ_DLIST_SEARCH
#define TREQ_DLIST_SEARCH(_dlist)
REQUEST_EXTRACT_CANCEL
#define REQUEST_EXTRACT_CANCEL(_treq)
Remove the current request from the cancel list.
Definition trunk.c:772
trunk_connection_is_full
static bool trunk_connection_is_full(trunk_connection_t *tconn)
Return whether a trunk connection should currently be considered full.
Definition trunk.c:2939
trunk_s::pub
struct trunk_pub_s pub
Public fields in the trunk connection.
Definition trunk.c:216
trunk_request_s::cancel_reason
trunk_cancel_reason_t cancel_reason
Why this request was cancelled.
Definition trunk.c:111
REQUEST_BAD_STATE_TRANSITION
#define REQUEST_BAD_STATE_TRANSITION(_new)
Definition trunk.c:502
trunk_request_enqueue_on_conn
trunk_enqueue_t trunk_request_enqueue_on_conn(trunk_request_t **treq_out, trunk_connection_t *tconn, request_t *request, void *preq, void *rctx, bool ignore_limits)
Enqueue additional requests on a specific connection.
Definition trunk.c:2759
_trunk_connection_on_closed
static void _trunk_connection_on_closed(UNUSED connection_t *conn, UNUSED connection_state_t prev, UNUSED connection_state_t state, void *uctx)
Connection failed after it was connected.
Definition trunk.c:3527
trunk_connection_events
static fr_table_num_ordered_t const trunk_connection_events[]
Definition trunk.c:437
trunk_request_enqueue
trunk_enqueue_t trunk_request_enqueue(trunk_request_t **treq_out, trunk_t *trunk, request_t *request, void *preq, void *rctx)
Enqueue a request that needs data written to the trunk.
Definition trunk.c:2605
TCONN_DLIST_SEARCH
#define TCONN_DLIST_SEARCH(_dlist)
trunk_request_enter_unassigned
static void trunk_request_enter_unassigned(trunk_request_t *treq)
Transition a request to the unassigned state, in preparation for re-assignment.
Definition trunk.c:1073
trunk_request_t
struct trunk_request_s trunk_request_t
Definition trunk.c:33
trunk_s::in_handler
void * in_handler
Which handler we're inside.
Definition trunk.c:278
trunk_s::freeing
bool freeing
Trunk is being freed, don't spawn new connections or re-enqueue.
Definition trunk.c:304
trunk_states
static fr_table_num_ordered_t const trunk_states[]
Definition trunk.c:408
trunk_connection_readable
static void trunk_connection_readable(trunk_connection_t *tconn)
A connection is readable.
Definition trunk.c:2970
IS_SERVICEABLE
#define IS_SERVICEABLE(_tconn)
Definition trunk.c:727
trunk_request_requeue
trunk_enqueue_t trunk_request_requeue(trunk_request_t *treq)
Re-enqueue a request on the same connection.
Definition trunk.c:2694
IS_PROCESSING
#define IS_PROCESSING(_tconn)
Definition trunk.c:728
RECONNECT_BY_STATE
#define RECONNECT_BY_STATE(_state, _list)
trunk_connection_enter_draining
static void trunk_connection_enter_draining(trunk_connection_t *tconn)
Transition a connection to the draining state.
Definition trunk.c:3198
trunk_req_trigger_names
static fr_table_num_indexed_bit_pos_t const trunk_req_trigger_names[]
Map request states to trigger names.
Definition trunk.c:373
trunk_request_s::entry
fr_dlist_t entry
Used to track the trunk request in the conn->sent or trunk->backlog request.
Definition trunk.c:108
trunk_connection_close_if_empty
static void trunk_connection_close_if_empty(trunk_t *trunk, fr_dlist_head_t *head)
Close connections in a particular connection list if they have no requests associated with them.
Definition trunk.c:4075
trunk_request_signal_cancel_complete
void trunk_request_signal_cancel_complete(trunk_request_t *treq)
Signal that a remote server acked our cancellation.
Definition trunk.c:2302
trunk_request_check_enqueue
static trunk_enqueue_t trunk_request_check_enqueue(trunk_connection_t **tconn_out, trunk_t *trunk, request_t *request)
Check to see if a trunk request can be enqueued.
Definition trunk.c:1620
DO_REQUEST_MUX
#define DO_REQUEST_MUX(_tconn)
Write one or more requests to a connection.
Definition trunk.c:632
REQUEST_EXTRACT_PARTIAL
#define REQUEST_EXTRACT_PARTIAL(_treq)
Remove the current request from the partial slot.
Definition trunk.c:753
trunk_connection_s::sent
fr_dlist_head_t sent
Sent request.
Definition trunk.c:157
trunk_request_enter_partial
static void trunk_request_enter_partial(trunk_request_t *treq)
Transition a request to the partial state, indicating that is has been partially sent.
Definition trunk.c:1241
trunk_connection_s::lifetime_ev
fr_timer_t * lifetime_ev
Maximum time this connection can be open.
Definition trunk.c:178
trunk_connection_pop_request
int trunk_connection_pop_request(trunk_request_t **treq_out, trunk_connection_t *tconn)
Pop a request off a connection's pending queue.
Definition trunk.c:3901
trunk_s::connecting
fr_dlist_head_t connecting
Connections which are not yet in the open state.
Definition trunk.c:242
TRUNK_STATE_TRANSITION
#define TRUNK_STATE_TRANSITION(_new)
Definition trunk.c:901
trunk_request_signal_cancel
void trunk_request_signal_cancel(trunk_request_t *treq)
Cancel a trunk request.
Definition trunk.c:2170
trunk_request_state_log_entry_add
void trunk_request_state_log_entry_add(char const *function, int line, trunk_request_t *treq, trunk_request_state_t new)
Definition trunk.c:2815
trunk_connection_spawn
static int trunk_connection_spawn(trunk_t *trunk, fr_time_t now)
Attempt to spawn a new connection.
Definition trunk.c:3766
trunk_del_watch
int trunk_del_watch(trunk_t *trunk, trunk_state_t state, trunk_watch_t watch)
Remove a watch function from a trunk state list.
Definition trunk.c:847
_trunk_timer
static void _trunk_timer(fr_timer_list_t *tl, fr_time_t now, void *uctx)
Event to periodically call the connection management function.
Definition trunk.c:4517
trunk_connection_s::pub
struct trunk_connection_pub_s pub
Public fields in the trunk connection.
Definition trunk.c:134
trunk_request_enter_reapable
static void trunk_request_enter_reapable(trunk_request_t *treq)
Transition a request to the reapable state, indicating that it's been sent in its entirety,...
Definition trunk.c:1328
trunk_connection_count_by_state
uint16_t trunk_connection_count_by_state(trunk_t *trunk, int conn_state)
Return the count number of connections in the specified states.
Definition trunk.c:2873
IN_REQUEST_DEMUX
#define IN_REQUEST_DEMUX(_trunk)
Definition trunk.c:724
DO_REQUEST_FAIL
#define DO_REQUEST_FAIL(_treq, _prev_state)
Call the fail callback (if set)
Definition trunk.c:594
trunk_request_enter_cancel
static void trunk_request_enter_cancel(trunk_request_t *treq, trunk_cancel_reason_t reason)
Transition a request to the cancel state, placing it in a connection's cancellation list.
Definition trunk.c:1391
trunk_request_enqueue_existing
static trunk_enqueue_t trunk_request_enqueue_existing(trunk_request_t *treq)
Enqueue a request which has never been assigned to a connection or was previously cancelled.
Definition trunk.c:1698
trunk_s::managing_connections
bool managing_connections
Whether the trunk is allowed to manage (open/close) connections.
Definition trunk.c:309
DO_CONNECTION_ALLOC
#define DO_CONNECTION_ALLOC(_tconn)
Allocate a new connection.
Definition trunk.c:683
trunk_request_state_log_t::function
char const * function
State change occurred in.
Definition trunk.c:91
trunk_request_states_len
static size_t trunk_request_states_len
Definition trunk.c:406
trunk_s::init
fr_dlist_head_t init
Connections which have not yet started connecting.
Definition trunk.c:239
trunk_request_state_log_t::log_head
fr_dlist_head_t * log_head
To allow the log entry to remove itself on free.
Definition trunk.c:77
trunk_request_enter_cancel_partial
static void trunk_request_enter_cancel_partial(trunk_request_t *treq)
Transition a request to the cancel_partial state, placing it in a connection's cancel_partial slot.
Definition trunk.c:1442
_trunk_connection_on_connected
static void _trunk_connection_on_connected(UNUSED connection_t *conn, UNUSED connection_state_t prev, UNUSED connection_state_t state, void *uctx)
Connection transitioned to the connected state.
Definition trunk.c:3468
trunk_alloc
trunk_t * trunk_alloc(TALLOC_CTX *ctx, fr_event_list_t *el, trunk_io_funcs_t const *funcs, trunk_conf_t const *conf, char const *log_prefix, void const *uctx, bool delay_start, fr_pair_list_t *trigger_args)
Allocate a new collection of connections.
Definition trunk.c:4964
trunk_s::to_free
fr_dlist_head_t to_free
Connections we're done with and will free on the next call to trunk_manage.
Definition trunk.c:267
trunk_connection_s::partial
trunk_request_t * partial
Partially written request.
Definition trunk.c:155
trunk_request_enter_failed
static void trunk_request_enter_failed(trunk_request_t *treq)
Request failed, inform the API client and free the request.
Definition trunk.c:1584
trunk_s::active
fr_minmax_heap_t * active
Connections which can service requests.
Definition trunk.c:244
trunk_config
conf_parser_t const trunk_config[]
Config parser definitions to populate a trunk_conf_t.
Definition trunk.c:341
trunk_request_enter_complete
static void trunk_request_enter_complete(trunk_request_t *treq)
Request completed successfully, inform the API client and free the request.
Definition trunk.c:1553
trunk_request_enter_sent
static void trunk_request_enter_sent(trunk_request_t *treq)
Transition a request to the sent state, indicating that it's been sent in its entirety.
Definition trunk.c:1271
DO_REQUEST_CANCEL_MUX
#define DO_REQUEST_CANCEL_MUX(_tconn)
Write one or more cancellation requests to a connection.
Definition trunk.c:665
trunk_connection_enter_full
static void trunk_connection_enter_full(trunk_connection_t *tconn)
Transition a connection to the full state.
Definition trunk.c:3123
trunk_request_free
void trunk_request_free(trunk_request_t **treq_to_free)
If the trunk request is freed then update the target requests.
Definition trunk.c:2340
DO_REQUEST_DEMUX
#define DO_REQUEST_DEMUX(_tconn)
Read one or more requests from a connection.
Definition trunk.c:649
trunk_connection_requests_dequeue
static uint64_t trunk_connection_requests_dequeue(fr_dlist_head_t *out, trunk_connection_t *tconn, int states, uint64_t max)
Shift requests in the specified states onto new connections.
Definition trunk.c:1755
_trunk_request_free
static int _trunk_request_free(trunk_request_t *treq)
Actually free the trunk request.
Definition trunk.c:2459
trunk_s::log_prefix
char const * log_prefix
What to prepend to messages.
Definition trunk.c:220
REQUEST_EXTRACT_PENDING
#define REQUEST_EXTRACT_PENDING(_treq)
Remove the current request from the pending list.
Definition trunk.c:743
_trunk_connection_lifetime_expire
static void _trunk_connection_lifetime_expire(UNUSED fr_timer_list_t *tl, UNUSED fr_time_t now, void *uctx)
Trigger a reconnection of the trunk connection.
Definition trunk.c:3450
trunk_connection_event_update
static void trunk_connection_event_update(trunk_connection_t *tconn)
Update the registrations for I/O events we're interested in.
Definition trunk.c:3003
trunk_config_request
static conf_parser_t const trunk_config_request[]
Definition trunk.c:324
trunk_s::full
fr_dlist_head_t full
Connections which have too many outstanding requests.
Definition trunk.c:246
DEQUEUE_ALL
#define DEQUEUE_ALL(_src_list, _state)
trunk_request_enter_backlog
static void trunk_request_enter_backlog(trunk_request_t *treq, bool new)
Transition a request to the backlog state, adding it to the backlog of the trunk.
Definition trunk.c:1108
trunk_request_states
static fr_table_num_ordered_t const trunk_request_states[]
Definition trunk.c:391
_trunk_connection_on_connecting
static void _trunk_connection_on_connecting(UNUSED connection_t *conn, UNUSED connection_state_t prev, UNUSED connection_state_t state, void *uctx)
Connection transitioned to the connecting state.
Definition trunk.c:3372
trunk_conn_trigger_names
static fr_table_num_indexed_bit_pos_t const trunk_conn_trigger_names[]
Map connection states to trigger names.
Definition trunk.c:198
trunk_s::draining_to_free
fr_dlist_head_t draining_to_free
Connections that will be freed once all their requests are complete.
Definition trunk.c:264
trunk_request_s::id
uint64_t id
Trunk request ID.
Definition trunk.c:104
trunk_connection_s::sent_count
uint64_t sent_count
The number of requests that have been sent using this connection.
Definition trunk.c:171
_trunk_connection_on_init
static void _trunk_connection_on_init(UNUSED connection_t *conn, UNUSED connection_state_t prev, UNUSED connection_state_t state, void *uctx)
Connection transitioned to the the init state.
Definition trunk.c:3337
DO_CONNECTION_NOTIFY
#define DO_CONNECTION_NOTIFY(_tconn, _events)
Change what events the connection should be notified about.
Definition trunk.c:705
TREQ_DLIST_VERIFY
#define TREQ_DLIST_VERIFY(_dlist, _state)
trunk_s::inactive
fr_dlist_head_t inactive
Connections which have been signalled to be inactive by the API client.
Definition trunk.c:249
trunk_s::trigger_undef
bool trigger_undef[NUM_ELEMENTS(trunk_conn_trigger_names)]
Record that a specific trigger is undefined.
Definition trunk.c:317
trunk_connection_manage_stop
void trunk_connection_manage_stop(trunk_t *trunk)
Stop the trunk from opening and closing connections in response to load.
Definition trunk.c:4836
TREQ_HEAP_VERIFY
#define TREQ_HEAP_VERIFY(_heap, _state)
trunk_connection_signal_active
void trunk_connection_signal_active(trunk_connection_t *tconn)
Signal a trunk connection is no longer full.
Definition trunk.c:3978
trunk_request_s::log
fr_dlist_head_t log
State change log.
Definition trunk.c:123
trunk_request_state_log_t::tconn_id
uint64_t tconn_id
If the treq was associated with a connection the connection ID.
Definition trunk.c:85
trunk_connection_s::entry
fr_dlist_t entry
Used to track the connection in the connecting, full and failed lists.
Definition trunk.c:141
trunk_request_enter_cancel_sent
static void trunk_request_enter_cancel_sent(trunk_request_t *treq)
Transition a request to the cancel_sent state, placing it in a connection's cancel_sent list.
Definition trunk.c:1477
trunk_connection_enter_inactive
static void trunk_connection_enter_inactive(trunk_connection_t *tconn)
Transition a connection to the inactive state.
Definition trunk.c:3145
trunk_request_state_log_t::from
trunk_request_state_t from
What state we transitioned from.
Definition trunk.c:79
trunk_s::trigger_args
fr_pair_list_t * trigger_args
Passed to trigger.
Definition trunk.c:315
trunk_connection_s::cancel_sent
fr_dlist_head_t cancel_sent
Sent cancellation request.
Definition trunk.c:165
trunk_connection_manage_start
void trunk_connection_manage_start(trunk_t *trunk)
Allow the trunk to open and close connections in response to load.
Definition trunk.c:4825
trunk_s::inactive_draining
fr_dlist_head_t inactive_draining
Connections which have been signalled to be inactive by the API client, which the trunk manager is dr...
Definition trunk.c:252
trunk_connection_signal_inactive
void trunk_connection_signal_inactive(trunk_connection_t *tconn)
Signal a trunk connection cannot accept more requests.
Definition trunk.c:3955
_state_log_entry_free
static int _state_log_entry_free(trunk_request_state_log_t *slog)
Used for sanity checks to ensure all log entries have been freed.
Definition trunk.c:2808
trunk_connection_verify
void trunk_connection_verify(char const *file, int line, trunk_connection_t *tconn)
Definition trunk.c:5133
trunk_s::backlog
fr_heap_t * backlog
The request backlog.
Definition trunk.c:229
IN_REQUEST_CANCEL_MUX
#define IN_REQUEST_CANCEL_MUX(_trunk)
Definition trunk.c:725
trunk_request_verify
void trunk_request_verify(char const *file, int line, trunk_request_t *treq)
Definition trunk.c:5193
trunk_request_count_by_state
uint64_t trunk_request_count_by_state(trunk_t *trunk, int conn_state, int req_state)
Return a count of requests on a connection in a specific state.
Definition trunk.c:4539
trunk_request_signal_cancel_partial
void trunk_request_signal_cancel_partial(trunk_request_t *treq)
Signal a partial cancel write.
Definition trunk.c:2254
trunk_request_signal_sent
void trunk_request_signal_sent(trunk_request_t *treq)
Signal that the request was written to a connection successfully.
Definition trunk.c:2068
COUNT_BY_STATE
#define COUNT_BY_STATE(_state, _list)
trunk_s::uctx
void * uctx
Uctx data to pass to alloc.
Definition trunk.c:280
TREQ_OPTION_VERIFY
#define TREQ_OPTION_VERIFY(_option, _state)
trunk_connection_search
bool trunk_connection_search(trunk_connection_t *tconn, void *ptr)
Definition trunk.c:5249
CONN_BAD_STATE_TRANSITION
#define CONN_BAD_STATE_TRANSITION(_new)
Definition trunk.c:468
trunk_request_s::heap_id
fr_heap_index_t heap_id
Used to track the request conn->pending heap.
Definition trunk.c:106
REQUEST_STATE_TRANSITION
#define REQUEST_STATE_TRANSITION(_new)
Record a request state transition and log appropriate output.
Definition trunk.c:491
trunk_s::next_watcher
trunk_watch_entry_t * next_watcher
Watcher about to be run. Used to prevent nested watchers.
Definition trunk.c:284
trunk_connection_requests_requeue_priv
static uint64_t trunk_connection_requests_requeue_priv(trunk_connection_t *tconn, int states, uint64_t max, bool fail_bound)
Remove requests in specified states from a connection, attempting to distribute them to new connectio...
Definition trunk.c:1866
trunk_request_s::sent
bool sent
Trunk request has been sent at least once.
Definition trunk.c:118
trunk_request_signal_complete
void trunk_request_signal_complete(trunk_request_t *treq)
Signal that a trunk request is complete.
Definition trunk.c:2112
trunk_connection_auto_unfull
static void trunk_connection_auto_unfull(trunk_connection_t *tconn)
Automatically mark a connection as active or reconnect it.
Definition trunk.c:2957
trunk_connection_signal_reconnect
void trunk_connection_signal_reconnect(trunk_connection_t *tconn, connection_reason_t reason)
Signal a trunk connection is no longer viable.
Definition trunk.c:4017
trunk_connection_signal_writable
void trunk_connection_signal_writable(trunk_connection_t *tconn)
Signal that a trunk connection is writable.
Definition trunk.c:3921
trunk_request_search
bool trunk_request_search(trunk_request_t *treq, void *ptr)
Definition trunk.c:5307
trunk_watch_entry_s::entry
fr_dlist_t entry
List entry.
Definition trunk.c:186
trunk_config_connection
static conf_parser_t const trunk_config_connection[]
Definition trunk.c:333
trunk_request_state_log_t::tconn_state
trunk_connection_state_t tconn_state
If the treq was associated with a connection the connection state at the time of the state transition...
Definition trunk.c:87
trunk_request_s::bound_to_conn
bool bound_to_conn
Fail the request if there's an attempt to re-enqueue it.
Definition trunk.c:115
trunk_cancellation_reasons_len
static size_t trunk_cancellation_reasons_len
Definition trunk.c:435
trunk_cancellation_reasons
static fr_table_num_ordered_t const trunk_cancellation_reasons[]
Definition trunk.c:429
trunk_conn_trigger_names_len
static size_t trunk_conn_trigger_names_len
Definition trunk.c:210
trunk_s::el
fr_event_list_t * el
Event list used by this trunk and the connection.
Definition trunk.c:222
trunk_request_state_log
void trunk_request_state_log(fr_log_t const *log, fr_log_type_t log_type, char const *file, int line, trunk_request_t const *treq)
Definition trunk.c:2846
IN_REQUEST_MUX
#define IN_REQUEST_MUX(_trunk)
Definition trunk.c:723
trunk_s::free_requests
fr_dlist_head_t free_requests
Requests in the unassigned state.
Definition trunk.c:226
trunk_connection_in_state
bool trunk_connection_in_state(trunk_connection_t *tconn, int state)
Returns true if the trunk connection is in one of the specified states.
Definition trunk.c:4065
TREQ_HEAP_SEARCH
#define TREQ_HEAP_SEARCH(_heap)
REQUEST_EXTRACT_CANCEL_SENT
#define REQUEST_EXTRACT_CANCEL_SENT(_treq)
Remove the current request from the cancel sent list.
Definition trunk.c:786
trunk_request_state_log_t::entry
fr_dlist_t entry
Entry in the linked list.
Definition trunk.c:78
trunk_request_signal_reapable
void trunk_request_signal_reapable(trunk_request_t *treq)
Signal that the request was written to a connection successfully, but no response is expected.
Definition trunk.c:2090
trunk_connection_s
Associates request queues with a connection.
Definition trunk.c:133
trunk_request_s
Wraps a normal request.
Definition trunk.c:99
trunk_request_state_log_t
Trace state machine changes for a particular request.
Definition trunk.c:76
trunk_s
Main trunk management handle.
Definition trunk.c:215
trunk_watch_entry_s
An entry in a trunk watch function list.
Definition trunk.c:185
trunk_conf_t::max
uint16_t max
Maximum number of connections in the trunk.
Definition trunk.h:231
trunk_conf_t::max_req_per_conn
uint32_t max_req_per_conn
Maximum requests per connection.
Definition trunk.h:240
trunk_pub_s::last_write_success
fr_time_t _CONST last_write_success
Last time we wrote to the connection.
Definition trunk.h:320
trunk_request_pub_s::trunk
trunk_t *_CONST trunk
Trunk this request belongs to.
Definition trunk.h:351
trunk_conf_t::backlog_on_failed_conn
bool backlog_on_failed_conn
Assign requests to the backlog when there are no available connections and the last connection event ...
Definition trunk.h:281
trunk_conf_t::min
uint16_t min
Shouldn't let connections drop below this number.
Definition trunk.h:229
TRUNK_REQUEST_STATE_ALL
#define TRUNK_REQUEST_STATE_ALL
All request states.
Definition trunk.h:195
trunk_request_pub_s::rctx
void *_CONST rctx
Resume ctx of the module.
Definition trunk.h:357
trunk_connection_pub_s::trunk
trunk_t *_CONST trunk
Trunk this connection belongs to.
Definition trunk.h:379
trunk_io_funcs_t::connection_prioritise
fr_heap_cmp_t connection_prioritise
Ordering function for connections.
Definition trunk.h:741
trunk_connection_state_t
trunk_connection_state_t
Used for sanity checks and to track which list the connection is in.
Definition trunk.h:87
TRUNK_CONN_FULL
@ TRUNK_CONN_FULL
Connection is full and can't accept any more requests.
Definition trunk.h:95
TRUNK_CONN_CONNECTING
@ TRUNK_CONN_CONNECTING
Connection is connecting.
Definition trunk.h:90
TRUNK_CONN_DRAINING
@ TRUNK_CONN_DRAINING
Connection will be closed once it has no more outstanding requests, if it's not reactivated.
Definition trunk.h:101
TRUNK_CONN_INACTIVE_DRAINING
@ TRUNK_CONN_INACTIVE_DRAINING
Connection is inactive, can't accept any more requests, and will be closed once it has no more outsta...
Definition trunk.h:97
TRUNK_CONN_INACTIVE
@ TRUNK_CONN_INACTIVE
Connection is inactive and can't accept any more requests.
Definition trunk.h:96
TRUNK_CONN_HALTED
@ TRUNK_CONN_HALTED
Halted, ready to be freed.
Definition trunk.h:88
TRUNK_CONN_CLOSED
@ TRUNK_CONN_CLOSED
Connection was closed, either explicitly or due to failure.
Definition trunk.h:94
TRUNK_CONN_INIT
@ TRUNK_CONN_INIT
In the initial state.
Definition trunk.h:89
TRUNK_CONN_DRAINING_TO_FREE
@ TRUNK_CONN_DRAINING_TO_FREE
Connection will be closed once it has no more outstanding requests.
Definition trunk.h:103
TRUNK_CONN_ACTIVE
@ TRUNK_CONN_ACTIVE
Connection is connected and ready to service requests.
Definition trunk.h:91
trunk_conf_t::req_pool_headers
unsigned req_pool_headers
How many chunk headers the talloc pool allocated with the treq should contain.
Definition trunk.h:266
trunk_request_pub_s::request
request_t *_CONST request
The request that we're writing the data on behalf of.
Definition trunk.h:359
trunk_pub_s::last_open
fr_time_t _CONST last_open
Last time the connection management function opened a connection.
Definition trunk.h:310
trunk_conf_t::idle_timeout
fr_time_delta_t idle_timeout
how long a connection can remain idle for
Definition trunk.h:250
trunk_connection_pub_s::state
trunk_connection_state_t _CONST state
What state the connection is in.
Definition trunk.h:371
trunk_conf_t::req_pool_size
size_t req_pool_size
The size of the talloc pool allocated with the treq.
Definition trunk.h:269
trunk_conf_t::max_uses
uint64_t max_uses
The maximum time a connection can be used.
Definition trunk.h:246
trunk_conf_t::lifetime
fr_time_delta_t lifetime
Time between reconnects.
Definition trunk.h:248
trunk_conf_t::connecting
uint16_t connecting
Maximum number of connections that can be in the connecting state.
Definition trunk.h:233
trunk_pub_s::req_alloc_reused
uint64_t _CONST req_alloc_reused
How many requests were reused.
Definition trunk.h:334
trunk_conf_t::max_backlog
uint32_t max_backlog
Maximum number of requests that can be in the backlog.
Definition trunk.h:244
trunk_pub_s::last_failed
fr_time_t _CONST last_failed
Last time a connection failed.
Definition trunk.h:318
trunk_request_pub_s::state
trunk_request_state_t _CONST state
Which list the request is now located in.
Definition trunk.h:349
trunk_connection_pub_s::last_write_success
fr_time_t _CONST last_write_success
Last time we wrote to the connection.
Definition trunk.h:375
trunk_request_pub_s::tconn
trunk_connection_t *_CONST tconn
Connection this request belongs to.
Definition trunk.h:353
trunk_io_funcs_t::connection_alloc
trunk_connection_alloc_t connection_alloc
Allocate a new connection_t.
Definition trunk.h:737
trunk_pub_s::last_read_success
fr_time_t _CONST last_read_success
Last time we read a response.
Definition trunk.h:322
trunk_pub_s::last_below_target
fr_time_t _CONST last_below_target
Last time average utilisation went below the target value.
Definition trunk.h:307
trunk_connection_pub_s::last_read_success
fr_time_t _CONST last_read_success
Last time we read from the connection.
Definition trunk.h:377
trunk_conf_t::close_delay
fr_time_delta_t close_delay
How long we must be below target utilisation to close an existing connection.
Definition trunk.h:255
trunk_conf_t::start
uint16_t start
How many connections to start.
Definition trunk.h:227
trunk_conf_t::req_cleanup_delay
fr_time_delta_t req_cleanup_delay
How long must a request in the unassigned (free) list not have been used for before it's cleaned up a...
Definition trunk.h:259
TRUNK_REQUEST_STATE_CANCEL_ALL
#define TRUNK_REQUEST_STATE_CANCEL_ALL
All requests in various cancellation states.
Definition trunk.h:213
trunk_conf_t::always_writable
bool always_writable
Set to true if our ability to write requests to a connection handle is not dependent on the state of ...
Definition trunk.h:271
trunk_connection_event_t
trunk_connection_event_t
What type of I/O events the trunk connection is currently interested in receiving.
Definition trunk.h:72
TRUNK_CONN_EVENT_BOTH
@ TRUNK_CONN_EVENT_BOTH
Trunk should be notified if a connection is readable or writable.
Definition trunk.h:79
TRUNK_CONN_EVENT_WRITE
@ TRUNK_CONN_EVENT_WRITE
Trunk should be notified if a connection is writable.
Definition trunk.h:77
TRUNK_CONN_EVENT_NONE
@ TRUNK_CONN_EVENT_NONE
Don't notify the trunk on connection state changes.
Definition trunk.h:73
TRUNK_CONN_EVENT_READ
@ TRUNK_CONN_EVENT_READ
Trunk should be notified if a connection is readable.
Definition trunk.h:75
TRUNK_CONN_ALL
#define TRUNK_CONN_ALL
All connection states.
Definition trunk.h:111
trunk_io_funcs_t::request_prioritise
fr_heap_cmp_t request_prioritise
Ordering function for requests.
Definition trunk.h:743
trunk_pub_s::req_alloc
uint64_t _CONST req_alloc
The number of requests currently allocated that have not been freed or returned to the free list.
Definition trunk.h:328
trunk_cancel_reason_t
trunk_cancel_reason_t
Reasons for a request being cancelled.
Definition trunk.h:55
TRUNK_CANCEL_REASON_NONE
@ TRUNK_CANCEL_REASON_NONE
Request has not been cancelled.
Definition trunk.h:56
TRUNK_CANCEL_REASON_SIGNAL
@ TRUNK_CANCEL_REASON_SIGNAL
Request cancelled due to a signal.
Definition trunk.h:57
TRUNK_CANCEL_REASON_REQUEUE
@ TRUNK_CANCEL_REASON_REQUEUE
A previously sent request is being requeued.
Definition trunk.h:59
TRUNK_CANCEL_REASON_MOVE
@ TRUNK_CANCEL_REASON_MOVE
Request cancelled because it's being moved.
Definition trunk.h:58
trunk_pub_s::req_alloc_new
uint64_t _CONST req_alloc_new
How many requests we've allocated.
Definition trunk.h:332
trunk_conf_t::open_delay
fr_time_delta_t open_delay
How long we must be above target utilisation to spawn a new connection.
Definition trunk.h:252
trunk_connection_pub_s::conn
connection_t *_CONST conn
The underlying connection.
Definition trunk.h:373
trunk_state_t
trunk_state_t
Definition trunk.h:62
TRUNK_STATE_MAX
@ TRUNK_STATE_MAX
Definition trunk.h:66
TRUNK_STATE_PENDING
@ TRUNK_STATE_PENDING
Trunk has connections, but none are active.
Definition trunk.h:65
TRUNK_STATE_ACTIVE
@ TRUNK_STATE_ACTIVE
Trunk has active connections.
Definition trunk.h:64
TRUNK_STATE_IDLE
@ TRUNK_STATE_IDLE
Trunk has no connections.
Definition trunk.h:63
trunk_pub_s::last_closed
fr_time_t _CONST last_closed
Last time the connection management function closed a connection.
Definition trunk.h:313
trunk_watch_t
void(* trunk_watch_t)(trunk_t *trunk, trunk_state_t prev, trunk_state_t state, void *uctx)
Receive a notification when a trunk enters a particular state.
Definition trunk.h:728
trunk_conf_t::manage_interval
fr_time_delta_t manage_interval
How often we run the management algorithm to open/close connections.
Definition trunk.h:263
trunk_enqueue_t
trunk_enqueue_t
Definition trunk.h:148
TRUNK_ENQUEUE_DST_UNAVAILABLE
@ TRUNK_ENQUEUE_DST_UNAVAILABLE
Destination is down.
Definition trunk.h:153
TRUNK_ENQUEUE_FAIL
@ TRUNK_ENQUEUE_FAIL
General failure.
Definition trunk.h:154
TRUNK_ENQUEUE_OK
@ TRUNK_ENQUEUE_OK
Operation was successful.
Definition trunk.h:150
TRUNK_ENQUEUE_NO_CAPACITY
@ TRUNK_ENQUEUE_NO_CAPACITY
At maximum number of connections, and no connection has capacity.
Definition trunk.h:151
TRUNK_ENQUEUE_IN_BACKLOG
@ TRUNK_ENQUEUE_IN_BACKLOG
Request should be enqueued in backlog.
Definition trunk.h:149
trunk_request_pub_s::preq
void *_CONST preq
Data for the muxer to write to the connection.
Definition trunk.h:355
trunk_conf_t::target_req_per_conn
uint32_t target_req_per_conn
How many pending requests should ideally be running on each connection.
Definition trunk.h:236
trunk_pub_s::last_connected
fr_time_t _CONST last_connected
Last time a connection connected.
Definition trunk.h:316
trunk_io_funcs_t::request_cancel_mux
trunk_request_cancel_mux_t request_cancel_mux
!< Read one or more requests from a connection.
Definition trunk.h:750
trunk_request_state_t
trunk_request_state_t
Used for sanity checks and to simplify freeing.
Definition trunk.h:161
TRUNK_REQUEST_STATE_PARTIAL
@ TRUNK_REQUEST_STATE_PARTIAL
Some of the request was written to the socket, more of it should be written later.
Definition trunk.h:170
TRUNK_REQUEST_STATE_REAPABLE
@ TRUNK_REQUEST_STATE_REAPABLE
Request has been written, needs to persist, but we are not currently waiting for any response.
Definition trunk.h:173
TRUNK_REQUEST_STATE_UNASSIGNED
@ TRUNK_REQUEST_STATE_UNASSIGNED
Transition state - Request currently not assigned to any connection.
Definition trunk.h:165
TRUNK_REQUEST_STATE_INIT
@ TRUNK_REQUEST_STATE_INIT
Initial state.
Definition trunk.h:162
TRUNK_REQUEST_STATE_CANCEL_SENT
@ TRUNK_REQUEST_STATE_CANCEL_SENT
We've informed the remote server that the request has been cancelled.
Definition trunk.h:185
TRUNK_REQUEST_STATE_COMPLETE
@ TRUNK_REQUEST_STATE_COMPLETE
The request is complete.
Definition trunk.h:182
TRUNK_REQUEST_STATE_FAILED
@ TRUNK_REQUEST_STATE_FAILED
The request failed.
Definition trunk.h:183
TRUNK_REQUEST_STATE_CANCEL
@ TRUNK_REQUEST_STATE_CANCEL
A request on a particular socket was cancel.
Definition trunk.h:184
TRUNK_REQUEST_STATE_CANCEL_PARTIAL
@ TRUNK_REQUEST_STATE_CANCEL_PARTIAL
We partially wrote a cancellation request.
Definition trunk.h:187
TRUNK_REQUEST_STATE_BACKLOG
@ TRUNK_REQUEST_STATE_BACKLOG
In the backlog.
Definition trunk.h:167
TRUNK_REQUEST_STATE_CANCEL_COMPLETE
@ TRUNK_REQUEST_STATE_CANCEL_COMPLETE
Remote server has acknowledged our cancellation.
Definition trunk.h:188
TRUNK_REQUEST_STATE_PENDING
@ TRUNK_REQUEST_STATE_PENDING
In the queue of a connection and is pending writing.
Definition trunk.h:168
TRUNK_REQUEST_STATE_SENT
@ TRUNK_REQUEST_STATE_SENT
Was written to a socket. Waiting for a response.
Definition trunk.h:172
trunk_pub_s::state
trunk_state_t _CONST state
Current state of the trunk.
Definition trunk.h:337
trunk_pub_s::last_above_target
fr_time_t _CONST last_above_target
Last time average utilisation went above the target value.
Definition trunk.h:304
trunk_conf_t
Common configuration parameters for a trunk.
Definition trunk.h:224
trunk_connection_pub_s
Public fields for the trunk connection.
Definition trunk.h:370
trunk_io_funcs_t
I/O functions to pass to trunk_alloc.
Definition trunk.h:736
trunk_pub_s
Public fields for the trunk.
Definition trunk.h:300
trunk_request_pub_s
Public fields for the trunk request.
Definition trunk.h:348
close
close(uq->fd)
el
static fr_event_list_t * el
Definition unit_test_attribute.c:281
head
static fr_slen_t head
Definition xlat.h:420
parent
static fr_slen_t parent
Definition pair.h:857
fr_strerror
char const * fr_strerror(void)
Get the last library error.
Definition strerror.c:553
fr_box_time_delta
#define fr_box_time_delta(_val)
Definition value.h:365
nonnull
int nonnull(2, 5))
out
static size_t char ** out
Definition value.h:1023
Generated by   doxygen 1.9.8