schedule.h File Reference

Scheduler communication. More...

#include <freeradius-devel/io/channel.h>
#include <freeradius-devel/io/network.h>
#include <freeradius-devel/io/worker.h>
#include <freeradius-devel/util/log.h>

Include dependency graph for schedule.h:

Go to the source code of this file.

Data Structures
struct	fr_schedule_config_t

Typedefs
typedef struct fr_schedule_s	fr_schedule_t
typedef void(*	fr_schedule_thread_detach_t) (void *uctx)
	Explicitly free resources allocated by fr_schedule_thread_instantiate_t.
typedef int(*	fr_schedule_thread_instantiate_t) (TALLOC_CTX *ctx, fr_event_list_t *el, void *uctx)
	Setup a new thread.

Functions
fr_schedule_t *	fr_schedule_create (TALLOC_CTX *ctx, fr_event_list_t *el, fr_log_t *log, fr_log_lvl_t lvl, fr_schedule_thread_instantiate_t worker_thread_instantiate, fr_schedule_thread_detach_t worked_thread_detach, fr_schedule_config_t *config))
	Create a scheduler and spawn the child threads.
int	fr_schedule_destroy (fr_schedule_t **sc)
	Destroy a scheduler, and tell its child threads to exit.
fr_network_t *	fr_schedule_directory_add (fr_schedule_t *sc, fr_listen_t *li)
	Add a directory NOTE_EXTEND to a scheduler.
fr_network_t *	fr_schedule_listen_add (fr_schedule_t *sc, fr_listen_t *li)
	Add a fr_listen_t to a scheduler.
int	fr_schedule_pthread_create (pthread_t *thread, void *(*func)(void *), void *arg)
	Creates a new thread using our standard set of options.
int	fr_schedule_worker_id (void)
	Return the worker id for the current thread.

Detailed Description

Scheduler communication.

Id

9c91134ac01cdb2464aff87433a43c5d449e122e

Copyright

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

Definition in file schedule.h.

---

Data Structure Documentation

fr_schedule_config_t

struct fr_schedule_config_t

Definition at line 63 of file schedule.h.

Collaboration diagram for fr_schedule_config_t:

Data Fields
uint32_t	max_networks	number of network threads
uint32_t	max_workers	number of network threads
fr_network_config_t	network	configuration for each network;
fr_time_delta_t	stats_interval	print channel statistics
fr_worker_config_t	worker	configuration for each worker

Typedef Documentation

fr_schedule_t

typedef struct fr_schedule_s fr_schedule_t

Definition at line 32 of file schedule.h.

fr_schedule_thread_detach_t

typedef void(* fr_schedule_thread_detach_t) (void *uctx)

Explicitly free resources allocated by fr_schedule_thread_instantiate_t.

Parameters

[in]

uctx

User data passed to callback.

Definition at line 61 of file schedule.h.

fr_schedule_thread_instantiate_t

typedef int(* fr_schedule_thread_instantiate_t) (TALLOC_CTX *ctx, fr_event_list_t *el, void *uctx)

Setup a new thread.

Parameters

[in]	ctx	to allocate any thread specific memory in.
[in]	el	Event list used by the thread.
[in]	uctx	User data passed to callback.

Returns

• 0 on success.
• -1 on failure.

Definition at line 55 of file schedule.h.

Function Documentation

fr_schedule_create()

fr_schedule_t * fr_schedule_create	(	TALLOC_CTX *	ctx,
		fr_event_list_t *	el,
		fr_log_t *	logger,
		fr_log_lvl_t	lvl,
		fr_schedule_thread_instantiate_t	worker_thread_instantiate,
		fr_schedule_thread_detach_t	worker_thread_detach,
		fr_schedule_config_t *	config
	)

Create a scheduler and spawn the child threads.

Parameters

[in]	ctx	talloc context.
[in]	el	event list, only for single-threaded mode.
[in]	logger	destination for all logging messages.
[in]	lvl	log level.
[in]	worker_thread_instantiate	callback for new worker threads.
[in]	worker_thread_detach	callback to destroy resources allocated by worker_thread_instantiate.
[in]	config	configuration for the scheduler

Returns

• NULL on error
• fr_schedule_t new scheduler

Definition at line 466 of file schedule.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_schedule_destroy()

int fr_schedule_destroy

(

fr_schedule_t **

sc_to_free

)

Destroy a scheduler, and tell its child threads to exit.

Note

This may be called with no worker or network threads in the case of a instantiation error. This function should deal with that condition gracefully.

Parameters

[in]

sc_to_free

the scheduler

Returns

• <0 on error
• 0 on success

Definition at line 768 of file schedule.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_schedule_directory_add()

fr_network_t * fr_schedule_directory_add	(	fr_schedule_t *	sc,
		fr_listen_t *	li
	)

Add a directory NOTE_EXTEND to a scheduler.

Parameters

[in]	sc	the scheduler
[in]	li	the ctx and callbacks for the transport.

Returns

• NULL on error
• the fr_network_t that the socket was added to.

Definition at line 924 of file schedule.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_schedule_listen_add()

fr_network_t * fr_schedule_listen_add	(	fr_schedule_t *	sc,
		fr_listen_t *	li
	)

Add a fr_listen_t to a scheduler.

Parameters

[in]	sc	the scheduler
[in]	li	the ctx and callbacks for the transport.

Returns

• NULL on error
• the fr_network_t that the socket was added to.

Definition at line 892 of file schedule.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_schedule_pthread_create()

int fr_schedule_pthread_create	(	pthread_t *	thread,
		void *(*)(void *)	func,
		void *	arg
	)

Creates a new thread using our standard set of options.

New threads are:

• Joinable, i.e. you can call pthread_join on them to confirm they've exited
• Immune to catchable signals.

Parameters

[out]	thread	handled that was created by pthread_create.
[in]	func	entry point for the thread.
[in]	arg	Argument to pass to func.

Returns

• 0 on success.
• -1 on failure.

Definition at line 428 of file schedule.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_schedule_worker_id()

int fr_schedule_worker_id

(

void

)

Return the worker id for the current thread.

Returns

worker ID

Definition at line 157 of file schedule.c.

Here is the caller graph for this function: