contrib/unbound/daemon/worker.h

   1 /*
   2  * daemon/worker.h - worker that handles a pending list of 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  * This file describes the worker structure that holds a list of
  40  * pending requests and handles them.
  41  */
  42
  43 #ifndef DAEMON_WORKER_H
  44 #define DAEMON_WORKER_H
  45
  46 #include "libunbound/worker.h"
  47 #include "util/netevent.h"
  48 #include "util/locks.h"
  49 #include "util/alloc.h"
  50 #include "util/data/msgreply.h"
  51 #include "util/data/msgparse.h"
  52 #include "daemon/stats.h"
  53 #include "util/module.h"
  54 #include "dnstap/dnstap.h"
  55 struct listen_dnsport;
  56 struct outside_network;
  57 struct config_file;
  58 struct daemon;
  59 struct listen_port;
  60 struct ub_randstate;
  61 struct regional;
  62 struct tube;
  63 struct daemon_remote;
  64
  65 /** worker commands */
  66 enum worker_commands {
  67         /** make the worker quit */
  68         worker_cmd_quit,
  69         /** obtain statistics */
  70         worker_cmd_stats,
  71         /** obtain statistics without statsclear */
  72         worker_cmd_stats_noreset,
  73         /** execute remote control command */
  74         worker_cmd_remote
  75 };
  76
  77 /**
  78  * Structure holding working information for unbound.
  79  * Holds globally visible information.
  80  */
  81 struct worker {
  82         /** the thread number (in daemon array). First in struct for debug. */
  83         int thread_num;
  84         /** global shared daemon structure */
  85         struct daemon* daemon;
  86         /** thread id */
  87         ub_thread_t thr_id;
  88         /** pipe, for commands for this worker */
  89         struct tube* cmd;
  90         /** the event base this worker works with */
  91         struct comm_base* base;
  92         /** the frontside listening interface where request events come in */
  93         struct listen_dnsport* front;
  94         /** the backside outside network interface to the auth servers */
  95         struct outside_network* back;
  96         /** ports to be used by this worker. */
  97         int* ports;
  98         /** number of ports for this worker */
  99         int numports;
 100         /** the signal handler */
 101         struct comm_signal* comsig;
 102         /** commpoint to listen to commands. */
 103         struct comm_point* cmd_com;
 104         /** timer for statistics */
 105         struct comm_timer* stat_timer;
 106         /** ratelimit for errors, time value */
 107         time_t err_limit_time;
 108         /** ratelimit for errors, packet count */
 109         unsigned int err_limit_count;
 110
 111         /** random() table for this worker. */
 112         struct ub_randstate* rndstate;
 113         /** do we need to restart or quit (on signal) */
 114         int need_to_exit;
 115         /** allocation cache for this thread */
 116         struct alloc_cache alloc;
 117         /** per thread statistics */
 118         struct server_stats stats;
 119         /** thread scratch regional */
 120         struct regional* scratchpad;
 121
 122         /** module environment passed to modules, changed for this thread */
 123         struct module_env env;
 124
 125 #ifdef USE_DNSTAP
 126         /** dnstap environment, changed for this thread */
 127         struct dt_env dtenv;
 128 #endif
 129 };
 130
 131 /**
 132  * Create the worker structure. Bare bones version, zeroed struct,
 133  * with backpointers only. Use worker_init on it later.
 134  * @param daemon: the daemon that this worker thread is part of.
 135  * @param id: the thread number from 0.. numthreads-1.
 136  * @param ports: the ports it is allowed to use, array.
 137  * @param n: the number of ports.
 138  * @return: the new worker or NULL on alloc failure.
 139  */
 140 struct worker* worker_create(struct daemon* daemon, int id, int* ports, int n);
 141
 142 /**
 143  * Initialize worker.
 144  * Allocates event base, listens to ports
 145  * @param worker: worker to initialize, created with worker_create.
 146  * @param cfg: configuration settings.
 147  * @param ports: list of shared query ports.
 148  * @param do_sigs: if true, worker installs signal handlers.
 149  * @return: false on error.
 150  */
 151 int worker_init(struct worker* worker, struct config_file *cfg,
 152         struct listen_port* ports, int do_sigs);
 153
 154 /**
 155  * Make worker work.
 156  */
 157 void worker_work(struct worker* worker);
 158
 159 /**
 160  * Delete worker.
 161  */
 162 void worker_delete(struct worker* worker);
 163
 164 /**
 165  * Send a command to a worker. Uses blocking writes.
 166  * @param worker: worker to send command to.
 167  * @param cmd: command to send.
 168  */
 169 void worker_send_cmd(struct worker* worker, enum worker_commands cmd);
 170
 171 /**
 172  * Init worker stats - includes server_stats_init, outside network and mesh.
 173  * @param worker: the worker to init
 174  */
 175 void worker_stats_clear(struct worker* worker);
 176
 177 #endif /* DAEMON_WORKER_H */