This file describes the worker structure that holds a list of pending requests and handles them. More...

#include "util/netevent.h"
#include "util/locks.h"
#include "util/alloc.h"
#include "util/data/msgreply.h"
#include "util/data/msgparse.h"
#include "daemon/stats.h"
#include "util/module.h"

Data Structures
struct	worker
	Structure holding working information for unbound. More...
Enumerations
enum	worker_commands { worker_cmd_quit, worker_cmd_stats, worker_cmd_stats_noreset, worker_cmd_remote }
	worker commands More...
Functions
struct worker *	worker_create (struct daemon daemon, int id, int ports, int n)
	Create the worker structure.
int	worker_init (struct worker worker, struct config_file cfg, struct listen_port *ports, int do_sigs)
	Initialize worker.
void	worker_work (struct worker *worker)
	Make worker work.
void	worker_delete (struct worker *worker)
	Delete worker.
void	worker_send_cmd (struct worker *worker, enum worker_commands cmd)
	Send a command to a worker.
void	worker_sighandler (int sig, void *arg)
	Worker signal handler function.
struct outbound_entry *	worker_send_query (uint8_t qname, size_t qnamelen, uint16_t qtype, uint16_t qclass, uint16_t flags, int dnssec, int want_dnssec, struct sockaddr_storage addr, socklen_t addrlen, uint8_t zone, size_t zonelen, struct module_qstate q)
	Worker service routine to send serviced queries to authoritative servers.
void	worker_handle_control_cmd (struct tube tube, uint8_t msg, size_t len, int error, void *arg)
	process control messages from the main thread.
int	worker_handle_request (struct comm_point c, void arg, int error, struct comm_reply *repinfo)
	handles callbacks from listening event interface
int	worker_handle_reply (struct comm_point c, void arg, int error, struct comm_reply *reply_info)
	process incoming replies from the network
int	worker_handle_service_reply (struct comm_point c, void arg, int error, struct comm_reply *reply_info)
	process incoming serviced query replies from the network
void	worker_alloc_cleanup (void *arg)
	cleanup the cache to remove all rrset IDs from it, arg is worker
void	worker_stats_clear (struct worker *worker)
	Init worker stats - includes server_stats_init, outside network and mesh.
void	worker_stat_timer_cb (void *arg)
	statistics timer callback handler
void	worker_probe_timer_cb (void *arg)
	probe timer callback handler

Detailed Description

This file describes the worker structure that holds a list of pending requests and handles them.

Enumeration Type Documentation

enum worker_commands

worker commands

Enumerator:

worker_cmd_quit	make the worker quit
worker_cmd_stats	obtain statistics
worker_cmd_stats_noreset	obtain statistics without statsclear
worker_cmd_remote	execute remote control command

Function Documentation

struct worker* worker_create	(	struct daemon *	daemon,
		int	id,
		int *	ports,
		int	n
	)		`[read]`

Create the worker structure.

Bare bones version, zeroed struct, with backpointers only. Use worker_init on it later.

Parameters:

daemon,:	the daemon that this worker thread is part of.
id,:	the thread number from 0.. numthreads-1.
ports,:	the ports it is allowed to use, array.
n,:	the number of ports.

Returns:: : the new worker or NULL on alloc failure.

References worker::cmd, worker::daemon, log_err(), memdup(), worker::numports, worker::ports, daemon::rand, worker::rndstate, worker::thread_num, tube_create(), tube_delete(), and ub_initstate().

Referenced by daemon_create_workers().

int worker_init	(	struct worker *	worker,
		struct config_file *	cfg,
		struct listen_port *	ports,
		int	do_sigs
	)

Initialize worker.

Allocates event base, listens to ports

Parameters:

worker,:	worker to initialize, created with worker_create.
cfg,:	configuration settings.
ports,:	list of shared query ports.
do_sigs,:	if true, worker installs signal handlers.

Returns:: : false on error.

References worker::alloc, module_env::alloc, alloc_init(), alloc_set_id_cleanup(), module_env::anchors, module_env::attach_sub, autr_get_num_anchors(), worker::back, worker::base, module_env::cfg, worker::cmd, comm_base_timept(), comm_signal_create(), comm_timer_create(), comm_timer_set(), worker::comsig, worker::daemon, daemon_remote_open_accept(), module_env::detach_subs, module_env::detect_cycle, config_file::do_ip4, config_file::do_ip6, config_file::do_tcp, config_file::do_udp, daemon::env, worker::env, forwards_apply_cfg(), forwards_create(), worker::front, module_env::fwds, config_file::incoming_num_tcp, module_env::infra_cache, module_env::kill_sub, listen_create(), daemon::listen_sslctx, log_err(), log_set_time(), module_env::mesh, mesh_attach_sub(), mesh_create(), mesh_detach_subs(), mesh_detect_cycle(), mesh_state_delete(), daemon::mods, config_file::msg_buffer_size, worker::need_to_exit, module_env::now, module_env::now_tv, config_file::num_out_ifs, worker::numports, config_file::out_ifs, config_file::outgoing_num_ports, config_file::outgoing_num_tcp, outside_network_create(), worker::ports, module_env::probe_timer, daemon::rc, daemon::rc_ports, regional_create_custom(), module_env::rnd, worker::rndstate, module_env::scratch, module_env::scratch_buffer, worker::scratchpad, module_env::send_query, server_stats_init(), config_file::stat_interval, worker::stat_timer, worker::stats, daemon::superalloc, worker::thread_num, tube_setup_bg_listen(), ub_thread_sig_unblock(), config_file::unwanted_threshold, config_file::use_caps_bits_for_id, VERB_ALGO, verbose(), module_env::worker, worker_alloc_cleanup(), worker_delete(), worker_handle_control_cmd(), worker_handle_request(), worker_mem_report(), worker_probe_timer_cb(), worker_restart_timer(), worker_send_query(), worker_sighandler(), and worker_stat_timer_cb().

Referenced by daemon_fork(), and thread_start().

void worker_send_cmd	(	struct worker *	worker,
		enum worker_commands	cmd
	)

Send a command to a worker.

Uses blocking writes.

Parameters:

worker,:	worker to send command to.
cmd,:	command to send.

References worker::cmd, log_err(), and tube_write_msg().

Referenced by daemon_stop_others(), distribute_cmd(), and server_stats_obtain().

void worker_sighandler	(	int	sig,
		void *	arg
	)

Worker signal handler function.

User argument is the worker itself.

Parameters:

sig,:	signal number.
arg,:	the worker (main worker) that handles signals.

References worker::base, comm_base_exit(), log_err(), worker::need_to_exit, VERB_QUERY, and verbose().

Referenced by fptr_whitelist_comm_signal(), signal_handling_playback(), and worker_init().

struct outbound_entry* worker_send_query	(	uint8_t *	qname,
		size_t	qnamelen,
		uint16_t	qtype,
		uint16_t	qclass,
		uint16_t	flags,
		int	dnssec,
		int	want_dnssec,
		struct sockaddr_storage *	addr,
		socklen_t	addrlen,
		uint8_t *	zone,
		size_t	zonelen,
		struct module_qstate *	q
	)		`[read]`

Worker service routine to send serviced queries to authoritative servers.

Parameters:

qname,:	query name. (host order)
qnamelen,:	length in bytes of qname, including trailing 0.
qtype,:	query type. (host order)
qclass,:	query class. (host order)
flags,:	host order flags word, with opcode and CD bit.
dnssec,:	if set, EDNS record will have DO bit set.
want_dnssec,:	signatures needed.
addr,:	where to.
addrlen,:	length of addr.
zone,:	wireformat dname of the zone.
zonelen,:	length of zone name.
q,:	wich query state to reactivate upon return.