worker.h

Go to the documentation of this file.

/*
 * daemon/worker.h - worker that handles a pending list of requests.
 *
 * Copyright (c) 2007, NLnet Labs. All rights reserved.
 *
 * This software is open source.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of the NLNET LABS nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

 
#ifndef DAEMON_WORKER_H
#define DAEMON_WORKER_H
 
#include "libunbound/worker.h"
#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"
#include "dnstap/dnstap.h"
struct listen_dnsport;
struct outside_network;
struct config_file;
struct daemon;
struct listen_port;
struct ub_randstate;
struct regional;
struct tube;
struct daemon_remote;
struct query_info;

enum worker_commands {
    worker_cmd_quit,
    worker_cmd_stats,
    worker_cmd_stats_noreset,
    worker_cmd_remote
};

struct worker {
    int thread_num;
    struct daemon* daemon;
    ub_thread_type thr_id;
    struct tube* cmd;
    struct comm_base* base;
    struct listen_dnsport* front;
    struct outside_network* back;
    int* ports;
    int numports;
    struct comm_signal* comsig;
    struct comm_point* cmd_com;
    struct comm_timer* stat_timer;
    time_t err_limit_time;
    unsigned int err_limit_count;

    struct ub_randstate* rndstate;
    int need_to_exit;
    struct alloc_cache alloc;
    struct ub_server_stats stats;
    struct regional* scratchpad;

    struct module_env env;
 
#ifdef USE_DNSTAP
    struct dt_env dtenv;
#endif
};

struct worker* worker_create(struct daemon* daemon, int id, int* ports, int n);

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

void worker_work(struct worker* worker);

void worker_delete(struct worker* worker);

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

void worker_stats_clear(struct worker* worker);
 
#endif /* DAEMON_WORKER_H */