Worker thread functions. More...

#include <freeradius-devel/io/channel.h>
#include <freeradius-devel/io/listen.h>
#include <freeradius-devel/io/message.h>
#include <freeradius-devel/io/worker.h>
#include <freeradius-devel/unlang/base.h>
#include <freeradius-devel/unlang/call.h>
#include <freeradius-devel/unlang/interpret.h>
#include <freeradius-devel/server/request.h>
#include <freeradius-devel/server/time_tracking.h>
#include <freeradius-devel/util/dlist.h>
#include <freeradius-devel/util/minmax_heap.h>
#include <freeradius-devel/util/slab.h>
#include <freeradius-devel/util/time.h>
#include <freeradius-devel/util/timer.h>
#include <stdalign.h>

Include dependency graph for worker.c:

Go to the source code of this file.

Data Structures
struct	fr_worker_channel_t

struct	fr_worker_listen_t

struct	fr_worker_s
	A worker which takes packets from a master, and processes them. More...

Macros
#define	CACHE_LINE_SIZE 64

#define	CHECK_CONFIG(_x, _min, _max)

#define	CHECK_CONFIG_TIME_DELTA(_x, _min, _max)

#define	LOG_DST worker->log

#define	LOG_PREFIX worker->name

#define	WORKER_VERIFY

Functions
static int	_fr_worker_rb_free (void *arg)

static int	_worker_request_deinit (request_t request, UNUSED void uctx)

static void	_worker_request_detach (request_t request, void uctx)
	Make us responsible for running the request.

static void	_worker_request_done_detached (request_t request, UNUSED rlm_rcode_t rcode, UNUSED void uctx)
	Detached request (i.e.

static void	_worker_request_done_external (request_t request, UNUSED rlm_rcode_t rcode, void uctx)
	External request is now complete.

static void	_worker_request_done_internal (request_t request, UNUSED rlm_rcode_t rcode, void uctx)
	Internal request (i.e.

static void	_worker_request_internal_init (request_t request, void uctx)
	Internal request (i.e.

static void	_worker_request_prioritise (request_t request, void uctx)
	Update a request's priority.

static void	_worker_request_resume (request_t request, UNUSED void uctx)
	Interpreter is starting to work on request again.

static void	_worker_request_runnable (request_t request, void uctx)
	Request is now runnable.

static bool	_worker_request_scheduled (request_t const request, UNUSED void uctx)
	Check if a request is scheduled.

static void	_worker_request_timeout (UNUSED fr_timer_list_t tl, UNUSED fr_time_t when, void uctx)
	Enforce max_request_time.

static void	_worker_request_yield (request_t request, UNUSED void uctx)
	Interpreter yielded request.

static int	cmd_stats_worker (FILE fp, UNUSED FILE fp_err, void ctx, fr_cmd_info_t const info)

	FR_SLAB_FUNCS (request, request_t)

	FR_SLAB_TYPES (request, request_t)

void	fr_worker (fr_worker_t *worker)
	The main loop and entry point of the stand-alone worker thread.

fr_worker_t *	fr_worker_alloc (TALLOC_CTX ctx, fr_event_list_t el, char const name, fr_log_t const logger, fr_log_lvl_t lvl, fr_worker_config_t *config)
	Create a worker.

fr_channel_t *	fr_worker_channel_create (fr_worker_t worker, TALLOC_CTX ctx, fr_control_t *master)
	Create a channel to the worker.

void	fr_worker_debug (fr_worker_t worker, FILE fp)
	Print debug information about the worker structure.

void	fr_worker_destroy (fr_worker_t *worker)
	Destroy a worker.

int	fr_worker_listen_cancel (fr_worker_t worker, fr_listen_t const li)

static int	fr_worker_listen_cancel_self (fr_worker_t worker, fr_listen_t const li)

void	fr_worker_post_event (UNUSED fr_event_list_t el, UNUSED fr_time_t now, void uctx)
	Post-event handler.

int	fr_worker_pre_event (UNUSED fr_time_t now, UNUSED fr_time_delta_t wake, void *uctx)
	Pre-event handler.

static fr_ring_buffer_t *	fr_worker_rb_init (void)
	Initialise thread local storage.

int	fr_worker_request_timeout_set (fr_worker_t worker, request_t request, fr_time_delta_t timeout)
	Set, or re-set the request timer.

int	fr_worker_stats (fr_worker_t const worker, int num, uint64_t stats)

static bool	is_worker_thread (fr_worker_t const *worker)

static char *	itoa_internal (TALLOC_CTX *ctx, uint64_t number)

static void	worker_channel_callback (void ctx, void const data, size_t data_size, fr_time_t now)
	Handle a control plane message sent to the worker via a channel.

static int8_t	worker_dedup_cmp (void const one, void const two)
	Track a request_t in the "dedup" tree.

static void	worker_exit (fr_worker_t *worker)

static void	worker_listen_cancel_callback (void ctx, void const data, NDEBUG_UNUSED size_t data_size, UNUSED fr_time_t now)
	A socket is going away, so clean up any requests which use this socket.

static int8_t	worker_listener_cmp (void const one, void const two)

static void	worker_nak (fr_worker_t worker, fr_channel_data_t cd, fr_time_t now)
	Send a NAK to the network thread.

static uint32_t	worker_num_requests (fr_worker_t *worker)

static void	worker_recv_request (void ctx, fr_channel_t ch, fr_channel_data_t *cd)
	Callback which handles a message being received on the worker side.

static void	worker_request_bootstrap (fr_worker_t worker, fr_channel_data_t cd, fr_time_t now)

static void	worker_request_init (fr_worker_t worker, request_t request, fr_time_t now)
	Initialize various request fields needed by the worker.

static void	worker_request_name_number (request_t *request)

static void	worker_request_time_tracking_end (fr_worker_t worker, request_t request, fr_time_t now)

static int	worker_request_time_tracking_start (fr_worker_t worker, request_t request, fr_time_t now)
	Start time tracking for a request, and mark it as runnable.

static void	worker_requests_cancel (fr_worker_channel_t *ch)

static void	worker_run_request (fr_worker_t *worker, fr_time_t start)
	Run a request.

static int8_t	worker_runnable_cmp (void const one, void const two)
	Track a request_t in the "runnable" heap.

static void	worker_send_reply (fr_worker_t worker, request_t request, bool send_reply, fr_time_t now)
	Send a response packet to the network side.

static void	worker_stop_request (request_t **request_p)
	Signal the unlang interpreter that it needs to stop running the request.

Variables
fr_cmd_table_t	cmd_worker_table []

static _Thread_local fr_ring_buffer_t *	fr_worker_rb

static atomic_uint64_t	request_number = 0

Detailed Description

Worker thread functions.

Id: ee61e79bc16394659f9666602d6e1049ef8df784

The "worker" thread is the one responsible for the bulk of the work done when processing a request. Workers are spawned by the scheduler, and create a kqueue (KQ) and control-plane Atomic Queue (AQ) for control-plane communication.

When a network thread discovers that it needs more workers, it asks the scheduler for a KQ/AQ combination. The network thread then creates a channel dedicated to that worker, and sends the channel to the worker in a "new channel" message. The worker receives the channel, and sends an ACK back to the network thread.

The network thread then sends the worker new packets, which the worker receives and processes.

When a packet is decoded, it is put into the "runnable" heap, and also into the timeout sublist. The main loop fr_worker() then pulls new requests off of this heap and runs them. The main event loop checks the head of the timeout sublist, and forcefully terminates any requests which have been running for too long.

If a request is yielded, it is placed onto the yielded list in the worker "tracking" data structure.

Copyright: 2016 Alan DeKok (aland.nosp@m.@fre.nosp@m.eradi.nosp@m.us.o.nosp@m.rg)

Definition in file worker.c.

Data Structure Documentation

◆ fr_worker_channel_t

struct fr_worker_channel_t

Definition at line 86 of file worker.c.

Collaboration diagram for fr_worker_channel_t:

Data Fields
fr_channel_t *	ch
fr_dlist_head_t	dlist

◆ fr_worker_listen_t

struct fr_worker_listen_t

Definition at line 147 of file worker.c.

Collaboration diagram for fr_worker_listen_t:

Data Fields
fr_dlist_head_t	dlist	of requests associated with this listener.
fr_listen_t const *	listener	incoming packets
fr_rb_node_t	node	in tree of listeners

◆ fr_worker_s

struct fr_worker_s

A worker which takes packets from a master, and processes them.

Definition at line 99 of file worker.c.

Collaboration diagram for fr_worker_s:

Data Fields
fr_atomic_queue_t *	aq_control	atomic queue for control messages sent to me
fr_worker_channel_t *	channel	list of channels
fr_worker_config_t	config	external configuration
fr_control_t *	control	the control plane
fr_time_elapsed_t	cpu_time	histogram of total CPU time per request
fr_rb_tree_t *	dedup	de-dup tree
fr_event_list_t *	el	our event list
bool	exiting	are we exiting?
unlang_interpret_t *	intp	Worker's local interpreter.
fr_rb_tree_t *	listeners	so we can cancel requests when a listener goes away
fr_log_t const *	log	log destination
fr_log_lvl_t	lvl	log level
fr_time_delta_t	max_request_time	maximum time a request can be processed
char const *	name	name of this worker
uint64_t	num_active	number of active requests
int	num_channels	actual number of channels
uint64_t	num_naks	number of messages which were nak'd
fr_time_delta_t	predicted	How long we predict a request will take to execute.
fr_heap_t *	runnable	current runnable requests which we've spent time processing
request_slab_list_t *	slab	slab allocator for request_t
fr_io_stats_t	stats	input / output stats
pthread_t	thread_id	my thread ID
fr_timer_list_t *	timeout	Track when requests timeout using a dlist.
fr_timer_list_t *	timeout_custom	Track when requests timeout using an lst. requests must always be in one of these lists.
fr_time_tracking_t	tracking	how much time the worker has spent doing things.
fr_time_elapsed_t	wall_clock	histogram of wall clock time per request
bool	was_sleeping	used to suppress multiple sleep signals in a row

Macro Definition Documentation

◆ CACHE_LINE_SIZE

#define CACHE_LINE_SIZE 64

Definition at line 78 of file worker.c.

◆ CHECK_CONFIG

#define CHECK_CONFIG	(	_x,
		_min,
		_max
	)

Value:

                do { \
                if (!worker->config._x) worker->config._x = _min; \
                if (worker->config._x < _min) worker->config._x = _min; \
                if (worker->config._x > _max) worker->config._x = _max; \
       } while (0)

◆ CHECK_CONFIG_TIME_DELTA

#define CHECK_CONFIG_TIME_DELTA	(	_x,
		_min,
		_max
	)

Value:

                do { \
                if (fr_time_delta_lt(worker->config._x, _min)) worker->config._x = _min; \
                if (fr_time_delta_gt(worker->config._x, _max)) worker->config._x = _max; \
       } while (0)

◆ LOG_DST

#define LOG_DST worker->log

Definition at line 52 of file worker.c.

◆ LOG_PREFIX

#define LOG_PREFIX worker->name

Definition at line 51 of file worker.c.

◆ WORKER_VERIFY

#define WORKER_VERIFY

Definition at line 75 of file worker.c.

Function Documentation

◆ _fr_worker_rb_free()

static int _fr_worker_rb_free ( void * arg )

static

Definition at line 172 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _worker_request_deinit()

static int _worker_request_deinit	(	request_t *	request,
		UNUSED void *	uctx
	)

static

Definition at line 799 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _worker_request_detach()

static void _worker_request_detach	(	request_t *	request,
		void *	uctx
	)

static

Make us responsible for running the request.

Definition at line 1231 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _worker_request_done_detached()

static void _worker_request_done_detached	(	request_t *	request,
		UNUSED rlm_rcode_t	rcode,
		UNUSED void *	uctx
	)

static

Detached request (i.e.

one generated by the interpreter with no parent) is now complete

As the request has no parent, then there's nothing to free it so we have to.

Definition at line 1198 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _worker_request_done_external()

static void _worker_request_done_external	(	request_t *	request,
		UNUSED rlm_rcode_t	rcode,
		void *	uctx
	)

static

External request is now complete.

Definition at line 1113 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _worker_request_done_internal()

static void _worker_request_done_internal	(	request_t *	request,
		UNUSED rlm_rcode_t	rcode,
		void *	uctx
	)

static

Internal request (i.e.

one generated by the interpreter) is now complete

Whatever generated the request is now responsible for freeing it.

Definition at line 1182 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _worker_request_internal_init()

static void _worker_request_internal_init	(	request_t *	request,
		void *	uctx
	)

static

Internal request (i.e.

one generated by the interpreter) is now complete

Definition at line 1094 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _worker_request_prioritise()

static void _worker_request_prioritise	(	request_t *	request,
		void *	uctx
	)

static

Update a request's priority.

Definition at line 1299 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _worker_request_resume()

static void _worker_request_resume	(	request_t *	request,
		UNUSED void *	uctx
	)

static

Interpreter is starting to work on request again.

Definition at line 1282 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _worker_request_runnable()

static void _worker_request_runnable	(	request_t *	request,
		void *	uctx
	)

static

Request is now runnable.

Definition at line 1262 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _worker_request_scheduled()

static bool _worker_request_scheduled	(	request_t const *	request,
		UNUSED void *	uctx
	)

static

Check if a request is scheduled.

Definition at line 1291 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _worker_request_timeout()

static void _worker_request_timeout	(	UNUSED fr_timer_list_t *	tl,
		UNUSED fr_time_t	when,
		void *	uctx
	)

static

Enforce max_request_time.

Run periodically, and tries to clean up requests which were received by the network thread more than max_request_time seconds ago. In the interest of not adding a timer for every packet, the requests are given a 1 second leeway.

Parameters

[in]	tl	the worker's timer list.
[in]	when	the current time
[in]	uctx	the request_t timing out.

Definition at line 533 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _worker_request_yield()

static void _worker_request_yield	(	request_t *	request,
		UNUSED void *	uctx
	)

static

Interpreter yielded request.

Definition at line 1273 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmd_stats_worker()

static int cmd_stats_worker	(	FILE *	fp,
		UNUSED FILE *	fp_err,
		void *	ctx,
		fr_cmd_info_t const *	info
	)

static

Definition at line 1735 of file worker.c.

Here is the call graph for this function:

◆ FR_SLAB_FUNCS()

FR_SLAB_FUNCS	(	request	,
		request_t
	)

◆ FR_SLAB_TYPES()

FR_SLAB_TYPES	(	request	,
		request_t
	)

◆ fr_worker()

void fr_worker ( fr_worker_t * worker )

The main loop and entry point of the stand-alone worker thread.

Where there is only one thread, the event loop runs fr_worker_pre_event() and fr_worker_post_event() instead, And then fr_worker_post_event() takes care of calling worker_run_request() to actually run the request.

Parameters

[in] worker the worker data structure to manage

Definition at line 1526 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_worker_alloc()

fr_worker_t * fr_worker_alloc	(	TALLOC_CTX *	ctx,
		fr_event_list_t *	el,
		char const *	name,
		fr_log_t const *	logger,
		fr_log_lvl_t	lvl,
		fr_worker_config_t *	config
	)

Create a worker.

Parameters

[in]	ctx	the talloc context
[in]	name	the name of this worker
[in]	el	the event list
[in]	logger	the destination for all logging messages
[in]	lvl	log level
[in]	config	various configuration parameters

Returns

NULL on error
fr_worker_t on success

Definition at line 1371 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_worker_channel_create()

fr_channel_t * fr_worker_channel_create	(	fr_worker_t *	worker,
		TALLOC_CTX *	ctx,
		fr_control_t *	master
	)

Create a channel to the worker.

Called by the master (i.e. network) thread when it needs to create a new channel to a particuler worker.

Parameters

[in]	worker	the worker
[in]	master	the control plane of the master
[in]	ctx	the context in which the channel will be created

Definition at line 1642 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_worker_debug()

void fr_worker_debug	(	fr_worker_t *	worker,
		FILE *	fp
	)

Print debug information about the worker structure.

Parameters

[in]	worker	the worker
[in]	fp	the file where the debug output is printed.

Definition at line 1617 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_worker_destroy()

void fr_worker_destroy ( fr_worker_t * worker )

Destroy a worker.

The input channels are signaled, and local messages are cleaned up.

This should be called to EXPLICITLY destroy a worker, when some fatal error has occurred on the worker side, and we need to destroy it.

We signal all pending requests in the backlog to stop, and tell the network side that it should not send us any more requests.

Parameters

[in] worker the worker to destroy.

Definition at line 1029 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_worker_listen_cancel()

int fr_worker_listen_cancel	(	fr_worker_t *	worker,
		fr_listen_t const *	li
	)

Definition at line 1669 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_worker_listen_cancel_self()

static int fr_worker_listen_cancel_self	(	fr_worker_t *	worker,
		fr_listen_t const *	li
	)

static

Definition at line 371 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_worker_post_event()

void fr_worker_post_event	(	UNUSED fr_event_list_t *	el,
		UNUSED fr_time_t	now,
		void *	uctx
	)

Post-event handler.

This should be run ONLY in single-threaded mode!

Definition at line 1605 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_worker_pre_event()

int fr_worker_pre_event	(	UNUSED fr_time_t	now,
		UNUSED fr_time_delta_t	wake,
		void *	uctx
	)

Pre-event handler.

This should be run ONLY in single-threaded mode!

Definition at line 1584 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_worker_rb_init()

static fr_ring_buffer_t * fr_worker_rb_init ( void )

inlinestatic

Initialise thread local storage.

Returns: fr_ring_buffer_t for messages

Definition at line 181 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_worker_request_timeout_set()

int fr_worker_request_timeout_set	(	fr_worker_t *	worker,
		request_t *	request,
		fr_time_delta_t	timeout
	)

Set, or re-set the request timer.

Automatically moves requests between the timer lists (timeout, custom_timeout).

Can be used to set the initial timeout, or extend the timeout of a request.

Parameters

[in]	worker	the worker containing the timeout lists.
[in]	request	that we're timing out.
[in]	timeout	the timeout to set.

Returns

0 on success.
-1 on failure.

Definition at line 557 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_worker_stats()

int fr_worker_stats	(	fr_worker_t const *	worker,
		int	num,
		uint64_t *	stats
	)

Definition at line 1718 of file worker.c.

◆ is_worker_thread()

static bool is_worker_thread ( fr_worker_t const * worker )

inlinestatic

Definition at line 199 of file worker.c.

Here is the caller graph for this function:

◆ itoa_internal()

static char * itoa_internal	(	TALLOC_CTX *	ctx,
		uint64_t	number
	)

static

Definition at line 746 of file worker.c.

Here is the caller graph for this function:

◆ worker_channel_callback()

static void worker_channel_callback	(	void *	ctx,
		void const *	data,
		size_t	data_size,
		fr_time_t	now
	)

static

Handle a control plane message sent to the worker via a channel.

Parameters

[in]	ctx	the worker
[in]	data	the message
[in]	data_size	size of the data
[in]	now	the current time

Definition at line 254 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_dedup_cmp()

static int8_t worker_dedup_cmp	(	void const *	one,
		void const *	two
	)

static

Track a request_t in the "dedup" tree.

Definition at line 1006 of file worker.c.

Here is the caller graph for this function:

◆ worker_exit()

static void worker_exit ( fr_worker_t * worker )

static

Definition at line 232 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_listen_cancel_callback()

static void worker_listen_cancel_callback	(	void *	ctx,
		void const *	data,
		NDEBUG_UNUSED size_t	data_size,
		UNUSED fr_time_t	now
	)

static

A socket is going away, so clean up any requests which use this socket.

Parameters

[in]	ctx	the worker
[in]	data	the message
[in]	data_size	size of the data
[in]	now	the current time

Definition at line 398 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_listener_cmp()

static int8_t worker_listener_cmp	(	void const *	one,
		void const *	two
	)

static

Definition at line 160 of file worker.c.

Here is the caller graph for this function:

◆ worker_nak()

static void worker_nak	(	fr_worker_t *	worker,
		fr_channel_data_t *	cd,
		fr_time_t	now
	)

static

Send a NAK to the network thread.

The network thread believes that a worker is running a request until that request has been NAK'd. We typically NAK requests when they've been hanging around in the worker's backlog too long, or there was an error executing the request.

Parameters

[in]	worker	the worker
[in]	cd	the message to NAK
[in]	now	when the message is NAKd

Definition at line 420 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_num_requests()

static uint32_t worker_num_requests ( fr_worker_t * worker )

inlinestatic

Definition at line 794 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_recv_request()

static void worker_recv_request	(	void *	ctx,
		fr_channel_t *	ch,
		fr_channel_data_t *	cd
	)

static

Callback which handles a message being received on the worker side.

Parameters

[in]	ctx	the worker
[in]	ch	the channel to drain
[in]	cd	the message (if any) to start with

Definition at line 213 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_request_bootstrap()

static void worker_request_bootstrap	(	fr_worker_t *	worker,
		fr_channel_data_t *	cd,
		fr_time_t	now
	)

static

Definition at line 804 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_request_init()

static void worker_request_init	(	fr_worker_t *	worker,
		request_t *	request,
		fr_time_t	now
	)

inlinestatic

Initialize various request fields needed by the worker.

Definition at line 769 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_request_name_number()

static void worker_request_name_number ( request_t * request )

inlinestatic

Definition at line 786 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_request_time_tracking_end()

static void worker_request_time_tracking_end	(	fr_worker_t *	worker,
		request_t *	request,
		fr_time_t	now
	)

static

Definition at line 604 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_request_time_tracking_start()

static int worker_request_time_tracking_start	(	fr_worker_t *	worker,
		request_t *	request,
		fr_time_t	now
	)

static

Start time tracking for a request, and mark it as runnable.

Definition at line 575 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_requests_cancel()

static void worker_requests_cancel ( fr_worker_channel_t * ch )

static

Definition at line 223 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_run_request()

static void worker_run_request	(	fr_worker_t *	worker,
		fr_time_t	start
	)

inlinestatic

Run a request.

Until it either yields, or is done.

This function is also responsible for sending replies, and cleaning up the request.

Parameters

[in]	worker	the worker
[in]	start	the current time

Definition at line 1322 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_runnable_cmp()

static int8_t worker_runnable_cmp	(	void const *	one,
		void const *	two
	)

static

Track a request_t in the "runnable" heap.

Higher priorities take precedence, followed by lower sequence numbers

Definition at line 989 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_send_reply()

static void worker_send_reply	(	fr_worker_t *	worker,
		request_t *	request,
		bool	send_reply,
		fr_time_t	now
	)

static

Send a response packet to the network side.

Parameters

[in]	worker	This worker.
[in]	request	we're sending a reply for.
[in]	send_reply	whether the network side sends a reply
[in]	now	The current time

Definition at line 621 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ worker_stop_request()

static void worker_stop_request ( request_t ** request_p )

static

Signal the unlang interpreter that it needs to stop running the request.

Signalling is a synchronous operation. Whatever I/O requests the request is currently performing are immediately cancelled, and all the frames are popped off the unlang stack.

Modules and unlang keywords explicitly register signal handlers to deal with their yield points being cancelled/interrupted via this function.

The caller should assume the request is no longer viable after calling this function.

Parameters

[in] request_p Pointer to the request to cancel. Will be set to NULL.

Definition at line 513 of file worker.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ cmd_worker_table

fr_cmd_table_t cmd_worker_table[]

Initial value:

= {
        {
                .parent = "stats",
                .name = "worker",
                .help = "Statistics for workers threads.",
                .read_only = true
        },
 
        {
                .parent = "stats worker",
                .add_name = true,
                .name = "self",
                .syntax = "[(count|cpu)]",
                .func = cmd_stats_worker,
                .help = "Show statistics for a specific worker thread.",
                .read_only = true
        },
 
        CMD_TABLE_END
}

Definition at line 1771 of file worker.c.

◆ fr_worker_rb

_Thread_local fr_ring_buffer_t* fr_worker_rb

static

Definition at line 84 of file worker.c.

◆ request_number

atomic_uint64_t request_number = 0

static

Definition at line 79 of file worker.c.

Data Structures

Macros

Functions

Variables

Detailed Description

Data Structure Documentation

◆ fr_worker_channel_t

◆ fr_worker_listen_t

◆ fr_worker_s

Macro Definition Documentation

◆ CACHE_LINE_SIZE

◆ CHECK_CONFIG

◆ CHECK_CONFIG_TIME_DELTA

◆ LOG_DST

◆ LOG_PREFIX

◆ WORKER_VERIFY

Function Documentation

◆ _fr_worker_rb_free()

◆ _worker_request_deinit()

◆ _worker_request_detach()

◆ _worker_request_done_detached()

◆ _worker_request_done_external()

◆ _worker_request_done_internal()

◆ _worker_request_internal_init()

◆ _worker_request_prioritise()

◆ _worker_request_resume()

◆ _worker_request_runnable()

◆ _worker_request_scheduled()

◆ _worker_request_timeout()

◆ _worker_request_yield()

◆ cmd_stats_worker()

◆ FR_SLAB_FUNCS()

◆ FR_SLAB_TYPES()

◆ fr_worker()

◆ fr_worker_alloc()

◆ fr_worker_channel_create()

◆ fr_worker_debug()

◆ fr_worker_destroy()

◆ fr_worker_listen_cancel()

◆ fr_worker_listen_cancel_self()

◆ fr_worker_post_event()

◆ fr_worker_pre_event()

◆ fr_worker_rb_init()

◆ fr_worker_request_timeout_set()

◆ fr_worker_stats()

◆ is_worker_thread()

◆ itoa_internal()

◆ worker_channel_callback()

◆ worker_dedup_cmp()

◆ worker_exit()

◆ worker_listen_cancel_callback()

◆ worker_listener_cmp()

◆ worker_nak()

◆ worker_num_requests()

◆ worker_recv_request()

◆ worker_request_bootstrap()

◆ worker_request_init()

◆ worker_request_name_number()

◆ worker_request_time_tracking_end()

◆ worker_request_time_tracking_start()

◆ worker_requests_cancel()

◆ worker_run_request()

◆ worker_runnable_cmp()

◆ worker_send_reply()

◆ worker_stop_request()

Variable Documentation

◆ cmd_worker_table

◆ fr_worker_rb

◆ request_number