context.h

Go to the documentation of this file.

/*
 * libunbound/context.h - validating context for unbound internal use
 *
 * 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 LIBUNBOUND_CONTEXT_H
#define LIBUNBOUND_CONTEXT_H
#include "util/locks.h"
#include "util/alloc.h"
#include "util/rbtree.h"
#include "services/modstack.h"
#include "libunbound/unbound.h"
#include "libunbound/unbound-event.h"
#include "util/data/packed_rrset.h"
struct libworker;
struct tube;
struct sldns_buffer;
struct ub_event_base;

struct ub_ctx {
    /* --- pipes --- */
    lock_basic_type qqpipe_lock;
    struct tube* qq_pipe;
    lock_basic_type rrpipe_lock;
    struct tube* rr_pipe;
 
    /* --- shared data --- */
    lock_basic_type cfglock;
    int finalized;

    int created_bg;
    pid_t bg_pid;
    ub_thread_type bg_tid;

    int dothread;
    int thr_next_num;
    int logfile_override;
    FILE* log_out;
    struct alloc_cache* alloc_list;

    struct alloc_cache superalloc;
    struct module_env* env;
    struct module_stack mods;
    struct local_zones* local_zones;
    struct ub_randstate* seed_rnd;

    struct ub_event_base* event_base;
    struct libworker* event_worker;

    int next_querynum;
    size_t num_async; 
    rbtree_type queries;
};

struct ctx_query {
    struct rbnode_type node;
    int querynum;
    int async;
    int cancelled;

    ub_callback_type cb;
        ub_event_callback_type cb_event;
    void* cb_arg;

    uint8_t* msg;
    size_t msg_len;
    enum sec_status msg_security;
    struct libworker* w;

    struct ub_result* res;
};

enum ub_ctx_err {
    UB_NOERROR = 0,
    UB_SOCKET = -1,
    UB_NOMEM = -2,
    UB_SYNTAX = -3,
    UB_SERVFAIL = -4,
    UB_FORKFAIL = -5,
    UB_AFTERFINAL = -6,
    UB_INITFAIL = -7,
    UB_PIPE = -8,
    UB_READFILE = -9,
    UB_NOID = -10
};

enum ub_ctx_cmd {
    UB_LIBCMD_QUIT = 0,
    UB_LIBCMD_NEWQUERY,
    UB_LIBCMD_CANCEL,
    UB_LIBCMD_ANSWER
};

int context_finalize(struct ub_ctx* ctx);

int context_query_cmp(const void* a, const void* b);

void context_query_delete(struct ctx_query* q);

struct ctx_query* context_new(struct ub_ctx* ctx, const char* name, int rrtype,
        int rrclass,  ub_callback_type cb, ub_event_callback_type cb_event,
    void* cbarg);

struct alloc_cache* context_obtain_alloc(struct ub_ctx* ctx, int locking);

void context_release_alloc(struct ub_ctx* ctx, struct alloc_cache* alloc,
    int locking);

uint8_t* context_serialize_new_query(struct ctx_query* q, uint32_t* len);

uint8_t* context_serialize_answer(struct ctx_query* q, int err, 
    struct sldns_buffer* pkt, uint32_t* len);

uint8_t* context_serialize_cancel(struct ctx_query* q, uint32_t* len);

uint8_t* context_serialize_quit(uint32_t* len);

enum ub_ctx_cmd context_serial_getcmd(uint8_t* p, uint32_t len);

struct ctx_query* context_lookup_new_query(struct ub_ctx* ctx, 
    uint8_t* p, uint32_t len);

struct ctx_query* context_deserialize_new_query(struct ub_ctx* ctx, 
    uint8_t* p, uint32_t len);

struct ctx_query* context_deserialize_answer(struct ub_ctx* ctx, 
    uint8_t* p, uint32_t len, int* err);

struct ctx_query* context_deserialize_cancel(struct ub_ctx* ctx, 
    uint8_t* p, uint32_t len);
 
#endif /* LIBUNBOUND_CONTEXT_H */