val_neg.h

Go to the documentation of this file.

/*
 * validator/val_neg.h - validator aggressive negative caching functions.
 *
 * Copyright (c) 2008, 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 VALIDATOR_VAL_NEG_H
#define VALIDATOR_VAL_NEG_H
#include "util/locks.h"
#include "util/rbtree.h"
struct sldns_buffer;
struct val_neg_data;
struct config_file;
struct reply_info;
struct rrset_cache;
struct regional;
struct query_info;
struct dns_msg;
struct ub_packed_rrset_key;

struct val_neg_cache {
    lock_basic_type lock;
    rbtree_type tree;
    struct val_neg_data* first;
    struct val_neg_data* last;
    size_t use;
    size_t max;
    size_t nsec3_max_iter;
    size_t num_neg_cache_noerror;
    size_t num_neg_cache_nxdomain;
};

struct val_neg_zone {
    rbnode_type node;
    uint8_t* name;
    size_t len;
    int labs;

    struct val_neg_zone* parent;

    int count;

    int nsec3_hash;
    size_t nsec3_iter;
    uint8_t* nsec3_salt;
    size_t nsec3_saltlen;

    rbtree_type tree;

    uint16_t dclass;
    uint8_t in_use;
};

struct val_neg_data {
    rbnode_type node;
    uint8_t* name;
    size_t len;
    int labs;

    struct val_neg_data* parent;

    int count;

    struct val_neg_zone* zone;

    struct val_neg_data* prev;
    struct val_neg_data* next;

    uint8_t in_use;
};

struct val_neg_cache* val_neg_create(struct config_file* cfg, size_t maxiter);

size_t val_neg_get_mem(struct val_neg_cache* neg);

void neg_cache_delete(struct val_neg_cache* neg);

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

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

void val_neg_addreply(struct val_neg_cache* neg, struct reply_info* rep);

void val_neg_addreferral(struct val_neg_cache* neg, struct reply_info* rep,
    uint8_t* zone);

int val_neg_dlvlookup(struct val_neg_cache* neg, uint8_t* qname, size_t len,
    uint16_t qclass, struct rrset_cache* rrset_cache, time_t now);

struct dns_msg* val_neg_getmsg(struct val_neg_cache* neg, 
    struct query_info* qinfo, struct regional* region, 
    struct rrset_cache* rrset_cache, struct sldns_buffer* buf, time_t now,
    int addsoa, uint8_t* topname, struct config_file* cfg);
 
 
/**** functions exposed for unit test ****/
void neg_insert_data(struct val_neg_cache* neg,
        struct val_neg_zone* zone, struct ub_packed_rrset_key* nsec);

void neg_delete_data(struct val_neg_cache* neg, struct val_neg_data* el);

struct val_neg_zone* neg_find_zone(struct val_neg_cache* neg,
        uint8_t* nm, size_t len, uint16_t dclass);

struct val_neg_zone* neg_create_zone(struct val_neg_cache* neg,
        uint8_t* nm, size_t nm_len, uint16_t dclass);

void val_neg_zone_take_inuse(struct val_neg_zone* zone);
 
#endif /* VALIDATOR_VAL_NEG_H */