msgreply.h

Go to the documentation of this file.

/*
 * util/data/msgreply.h - store message and reply data. 
 *
 * 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 UTIL_DATA_MSGREPLY_H
#define UTIL_DATA_MSGREPLY_H
#include "util/storage/lruhash.h"
#include "util/data/packed_rrset.h"
struct sldns_buffer;
struct comm_reply;
struct alloc_cache;
struct iovec;
struct regional;
struct edns_data;
struct edns_option;
struct inplace_cb;
struct module_qstate;
struct module_env;
struct msg_parse;
struct rrset_parse;
struct local_rrset;
struct dns_msg;

#define PREFETCH_TTL_CALC(ttl) ((ttl) - (ttl)/10)

struct query_info {
    uint8_t* qname;
    size_t qname_len;
    uint16_t qtype;
    uint16_t qclass;
    struct local_rrset* local_alias;
};

struct rrset_ref {
    struct ub_packed_rrset_key* key;
    rrset_id_type id;
};

struct reply_info {
    uint16_t flags;

    uint8_t authoritative;

    uint8_t qdcount;

    uint32_t padding;

    time_t ttl;

    time_t prefetch_ttl;

    enum sec_status security;

    size_t an_numrrsets;

    size_t ns_numrrsets; 
    size_t ar_numrrsets;

    size_t rrset_count;

    struct ub_packed_rrset_key** rrsets;

    struct rrset_ref ref[1];
};

struct msgreply_entry {
    struct query_info key;
    struct lruhash_entry entry;
};

struct reply_info*
construct_reply_info_base(struct regional* region, uint16_t flags, size_t qd,
        time_t ttl, time_t prettl, size_t an, size_t ns, size_t ar,
        size_t total, enum sec_status sec);

int query_info_parse(struct query_info* m, struct sldns_buffer* query);

int reply_info_parse(struct sldns_buffer* pkt, struct alloc_cache* alloc,
    struct query_info* qinf, struct reply_info** rep, 
    struct regional* region, struct edns_data* edns);

int parse_create_msg(struct sldns_buffer* pkt, struct msg_parse* msg,
        struct alloc_cache* alloc, struct query_info* qinf,
    struct reply_info** rep, struct regional* region);

struct reply_info* parse_reply_in_temp_region(struct sldns_buffer* pkt,
    struct regional* region, struct query_info* qi);

void reply_info_sortref(struct reply_info* rep);

void reply_info_set_ttls(struct reply_info* rep, time_t timenow);

void reply_info_parsedelete(struct reply_info* rep, struct alloc_cache* alloc);

int query_info_compare(void* m1, void* m2);

void query_info_clear(struct query_info* m);

size_t msgreply_sizefunc(void* k, void* d);

void query_entry_delete(void *q, void* arg);

void reply_info_delete(void* d, void* arg);

hashvalue_type query_info_hash(struct query_info *q, uint16_t flags);

struct msgreply_entry* query_info_entrysetup(struct query_info* q,
    struct reply_info* r, hashvalue_type h);

struct reply_info* reply_info_copy(struct reply_info* rep, 
    struct alloc_cache* alloc, struct regional* region);

int reply_info_alloc_rrset_keys(struct reply_info* rep,
    struct alloc_cache* alloc, struct regional* region);

int parse_copy_decompress_rrset(struct sldns_buffer* pkt, struct msg_parse* msg,
    struct rrset_parse *pset, struct regional* region, 
    struct ub_packed_rrset_key* pk);

uint8_t* reply_find_final_cname_target(struct query_info* qinfo,
    struct reply_info* rep);

int reply_check_cname_chain(struct query_info* qinfo, struct reply_info* rep);

int reply_all_rrsets_secure(struct reply_info* rep);

struct ub_packed_rrset_key* reply_find_answer_rrset(struct query_info* qinfo,
    struct reply_info* rep);

struct ub_packed_rrset_key* reply_find_rrset_section_an(struct reply_info* rep,
    uint8_t* name, size_t namelen, uint16_t type, uint16_t dclass);

struct ub_packed_rrset_key* reply_find_rrset_section_ns(struct reply_info* rep,
    uint8_t* name, size_t namelen, uint16_t type, uint16_t dclass);

struct ub_packed_rrset_key* reply_find_rrset(struct reply_info* rep,
    uint8_t* name, size_t namelen, uint16_t type, uint16_t dclass);

void log_dns_msg(const char* str, struct query_info* qinfo,
    struct reply_info* rep);

void log_reply_info(enum verbosity_value v, struct query_info *qinf,
    struct sockaddr_storage *addr, socklen_t addrlen, struct timeval dur,
    int cached, struct sldns_buffer *rmsg);

void log_query_info(enum verbosity_value v, const char* str, 
    struct query_info* qinf);

int edns_opt_append(struct edns_data* edns, struct regional* region,
    uint16_t code, size_t len, uint8_t* data);

int edns_opt_list_append(struct edns_option** list, uint16_t code, size_t len,
    uint8_t* data, struct regional* region);

int edns_opt_list_remove(struct edns_option** list, uint16_t code);

struct edns_option* edns_opt_list_find(struct edns_option* list, uint16_t code);

int inplace_cb_reply_call(struct module_env* env, struct query_info* qinfo,
    struct module_qstate* qstate, struct reply_info* rep, int rcode,
    struct edns_data* edns, struct regional* region);

int inplace_cb_reply_cache_call(struct module_env* env,
    struct query_info* qinfo, struct module_qstate* qstate,
    struct reply_info* rep, int rcode, struct edns_data* edns,
    struct regional* region);

int inplace_cb_reply_local_call(struct module_env* env,
    struct query_info* qinfo, struct module_qstate* qstate,
    struct reply_info* rep, int rcode, struct edns_data* edns,
    struct regional* region);

int inplace_cb_reply_servfail_call(struct module_env* env,
    struct query_info* qinfo, struct module_qstate* qstate,
    struct reply_info* rep, int rcode, struct edns_data* edns,
    struct regional* region);

int inplace_cb_query_call(struct module_env* env, struct query_info* qinfo,
    uint16_t flags, struct sockaddr_storage* addr, socklen_t addrlen,
    uint8_t* zone, size_t zonelen, struct module_qstate* qstate,
    struct regional* region);

int inplace_cb_edns_back_parsed_call(struct module_env* env, 
    struct module_qstate* qstate);

int inplace_cb_query_response_call(struct module_env* env,
    struct module_qstate* qstate, struct dns_msg* response);

struct edns_option* edns_opt_copy_region(struct edns_option* list,
    struct regional* region);

struct edns_option* edns_opt_copy_alloc(struct edns_option* list);

void edns_opt_list_free(struct edns_option* list);

int edns_opt_compare(struct edns_option* p, struct edns_option* q);

int edns_opt_list_compare(struct edns_option* p, struct edns_option* q);
 
#endif /* UTIL_DATA_MSGREPLY_H */