1/*
2 * daemon/daemon.h - collection of workers that handles requests.
3 *
4 * Copyright (c) 2007, NLnet Labs. All rights reserved.
5 *
6 * This software is open source.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 *
19 * Neither the name of the NLNET LABS nor the names of its contributors may
20 * be used to endorse or promote products derived from this software without
21 * specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
29 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 */
35
36/**
37 * \file
38 *
39 * The daemon consists of global settings and a number of workers.
40 */
41
42#ifndef DAEMON_H
43#define DAEMON_H
44
45#include "util/locks.h"
46#include "util/alloc.h"
47#include "services/modstack.h"
48struct config_file;
49struct worker;
50struct listen_port;
51struct slabhash;
52struct module_env;
53struct rrset_cache;
54struct acl_list;
55struct local_zones;
56struct views;
57struct ub_randstate;
58struct daemon_remote;
59struct respip_set;
60struct shm_main_info;
61
62#include "dnstap/dnstap_config.h"
63#ifdef USE_DNSTAP
64struct dt_env;
65#endif
66
67#include "dnscrypt/dnscrypt_config.h"
68#ifdef USE_DNSCRYPT
69struct dnsc_env;
70#endif
71
72/**
73 * Structure holding worker list.
74 * Holds globally visible information.
75 */
76struct daemon {
77	/** The config settings */
78	struct config_file* cfg;
79	/** the chroot dir in use, NULL if none */
80	char* chroot;
81	/** pidfile that is used */
82	char* pidfile;
83	/** port number that has ports opened. */
84	int listening_port;
85	/** array of listening ports, opened.  Listening ports per worker,
86	 * or just one element[0] shared by the worker threads. */
87	struct listen_port** ports;
88	/** size of ports array */
89	size_t num_ports;
90	/** reuseport is enabled if true */
91	int reuseport;
92	/** port number for remote that has ports opened. */
93	int rc_port;
94	/** listening ports for remote control */
95	struct listen_port* rc_ports;
96	/** remote control connections management (for first worker) */
97	struct daemon_remote* rc;
98	/** ssl context for listening to dnstcp over ssl, and connecting ssl */
99	void* listen_sslctx, *connect_sslctx;
100	/** num threads allocated */
101	int num;
102	/** num threads allocated in the previous config or 0 at first */
103	int old_num;
104	/** the worker entries */
105	struct worker** workers;
106	/** per-worker allocation cache */
107	struct alloc_cache **worker_allocs;
108	/** do we need to exit unbound (or is it only a reload?) */
109	int need_to_exit;
110	/** master random table ; used for port div between threads on reload*/
111	struct ub_randstate* rand;
112	/** master allocation cache */
113	struct alloc_cache superalloc;
114	/** the module environment master value, copied and changed by threads*/
115	struct module_env* env;
116	/** stack of module callbacks */
117	struct module_stack mods;
118	/** access control, which client IPs are allowed to connect */
119	struct acl_list* acl;
120	/** access control, which interfaces are allowed to connect */
121	struct acl_list* acl_interface;
122	/** TCP connection limit, limit connections from client IPs */
123	struct tcl_list* tcl;
124	/** local authority zones */
125	struct local_zones* local_zones;
126	/** last time of statistics printout */
127	struct timeval time_last_stat;
128	/** time when daemon started */
129	struct timeval time_boot;
130	/** views structure containing view tree */
131	struct views* views;
132#ifdef USE_DNSTAP
133	/** the dnstap environment master value, copied and changed by threads*/
134	struct dt_env* dtenv;
135#endif
136	struct shm_main_info* shm_info;
137	/** response-ip set with associated actions and tags. */
138	struct respip_set* respip_set;
139	/** some response-ip tags or actions are configured if true */
140	int use_response_ip;
141	/** some RPZ policies are configured */
142	int use_rpz;
143#ifdef USE_DNSCRYPT
144	/** the dnscrypt environment */
145	struct dnsc_env* dnscenv;
146#endif
147	/** reuse existing cache on reload if other conditions allow it. */
148	int reuse_cache;
149};
150
151/**
152 * Initialize daemon structure.
153 * @return: The daemon structure, or NULL on error.
154 */
155struct daemon* daemon_init(void);
156
157/**
158 * Open shared listening ports (if needed).
159 * The cfg member pointer must have been set for the daemon.
160 * @param daemon: the daemon.
161 * @return: false on error.
162 */
163int daemon_open_shared_ports(struct daemon* daemon);
164
165/**
166 * Fork workers and start service.
167 * When the routine exits, it is no longer forked.
168 * @param daemon: the daemon.
169 */
170void daemon_fork(struct daemon* daemon);
171
172/**
173 * Close off the worker thread information.
174 * Bring the daemon back into state ready for daemon_fork again.
175 * @param daemon: the daemon.
176 */
177void daemon_cleanup(struct daemon* daemon);
178
179/**
180 * Delete workers, close listening ports.
181 * @param daemon: the daemon.
182 */
183void daemon_delete(struct daemon* daemon);
184
185/**
186 * Apply config settings.
187 * @param daemon: the daemon.
188 * @param cfg: new config settings.
189 */
190void daemon_apply_cfg(struct daemon* daemon, struct config_file* cfg);
191
192#endif /* DAEMON_H */
193