iter_fwd.c File Reference

This file contains functions to assist the iterator module. More...

#include "config.h"
#include "iterator/iter_fwd.h"
#include "iterator/iter_delegpt.h"
#include "util/log.h"
#include "util/config_file.h"
#include "util/net_help.h"
#include "util/data/dname.h"
#include "sldns/rrdef.h"
#include "sldns/str2wire.h"

Functions

int fwd_cmp (const void *k1, const void *k2)
 compare two fwd entries
 
struct iter_forwardsforwards_create (void)
 Create forwards. More...
 
static void fwd_zone_free (struct iter_forward_zone *n)
 
static void delfwdnode (rbnode_type *n, void *ATTR_UNUSED(arg))
 
static void fwd_del_tree (struct iter_forwards *fwd)
 
void forwards_delete (struct iter_forwards *fwd)
 Delete forwards. More...
 
static int forwards_insert_data (struct iter_forwards *fwd, uint16_t c, uint8_t *nm, size_t nmlen, int nmlabs, struct delegpt *dp)
 insert info into forward structure
 
static int forwards_insert (struct iter_forwards *fwd, uint16_t c, struct delegpt *dp)
 insert new info into forward structure given dp
 
static void fwd_init_parents (struct iter_forwards *fwd)
 initialise parent pointers in the tree
 
static struct delegptread_fwds_name (struct config_stub *s)
 set zone name
 
static int read_fwds_host (struct config_stub *s, struct delegpt *dp)
 set fwd host names
 
static int read_fwds_addr (struct config_stub *s, struct delegpt *dp)
 set fwd server addresses
 
static int read_forwards (struct iter_forwards *fwd, struct config_file *cfg)
 read forwards config
 
static int fwd_add_stub_hole (struct iter_forwards *fwd, uint16_t c, uint8_t *nm)
 insert a stub hole (if necessary) for stub name
 
static int make_stub_holes (struct iter_forwards *fwd, struct config_file *cfg)
 make NULL entries for stubs
 
int forwards_apply_cfg (struct iter_forwards *fwd, struct config_file *cfg)
 Process forwards config. More...
 
struct delegptforwards_find (struct iter_forwards *fwd, uint8_t *qname, uint16_t qclass, int nolock)
 Find forward zone exactly by name The return value is contents of the forwards structure. More...
 
struct delegptforwards_lookup (struct iter_forwards *fwd, uint8_t *qname, uint16_t qclass, int nolock)
 Find forward zone information For this qname/qclass find forward zone information, returns delegation point with server names and addresses, or NULL if no forwarding is needed. More...
 
struct delegptforwards_lookup_root (struct iter_forwards *fwd, uint16_t qclass, int nolock)
 Same as forwards_lookup, but for the root only. More...
 
static int next_root_locked (struct iter_forwards *fwd, uint16_t *dclass)
 
int forwards_next_root (struct iter_forwards *fwd, uint16_t *dclass, int nolock)
 Find next root item in forwards lookup tree. More...
 
size_t forwards_get_mem (struct iter_forwards *fwd)
 Get memory in use by forward storage Locks and unlocks the structure. More...
 
static struct iter_forward_zonefwd_zone_find (struct iter_forwards *fwd, uint16_t c, uint8_t *nm)
 
int forwards_add_zone (struct iter_forwards *fwd, uint16_t c, struct delegpt *dp, int nolock)
 Add zone to forward structure. More...
 
void forwards_delete_zone (struct iter_forwards *fwd, uint16_t c, uint8_t *nm, int nolock)
 Remove zone from forward structure. More...
 
int forwards_add_stub_hole (struct iter_forwards *fwd, uint16_t c, uint8_t *nm, int nolock)
 Add stub hole (empty entry in forward table, that makes resolution skip a forward-zone because the stub zone should override the forward zone). More...
 
void forwards_delete_stub_hole (struct iter_forwards *fwd, uint16_t c, uint8_t *nm, int nolock)
 Remove stub hole, if one exists. More...
 

Detailed Description

This file contains functions to assist the iterator module.

Keep track of forward zones and config settings.

Function Documentation

◆ forwards_create()

struct iter_forwards* forwards_create ( void  )

Create forwards.

Returns
new forwards or NULL on error.

References iter_forwards::lock.

Referenced by check_fwd(), and context_finalize().

◆ forwards_delete()

void forwards_delete ( struct iter_forwards fwd)

Delete forwards.

Parameters
fwdto delete.

References iter_forwards::lock.

Referenced by daemon_cleanup().

◆ forwards_apply_cfg()

int forwards_apply_cfg ( struct iter_forwards fwd,
struct config_file cfg 
)

Process forwards config.

Parameters
fwdwhere to store.
cfgconfig options.
Returns
0 on error.

References iter_forwards::lock, and iter_forwards::tree.

Referenced by check_fwd(), and context_finalize().

◆ forwards_find()

struct delegpt* forwards_find ( struct iter_forwards fwd,
uint8_t *  qname,
uint16_t  qclass,
int  nolock 
)

Find forward zone exactly by name The return value is contents of the forwards structure.

Caller should lock and unlock a readlock on the forwards structure if nolock is set. Otherwise caller should unlock the readlock on the forwards structure if a value was returned.

Parameters
fwdforward storage.
qnameThe qname of the query.
qclassThe qclass of the query.
nolockSkip locking, locking is handled by the caller.
Returns
: A delegation point or null.

References iter_forward_zone::dclass, dname_count_size_labels(), iter_forward_zone::dp, rbnode_type::key, iter_forwards::lock, iter_forward_zone::name, iter_forward_zone::namelabs, iter_forward_zone::namelen, iter_forward_zone::node, rbtree_search(), and iter_forwards::tree.

◆ forwards_lookup()

struct delegpt* forwards_lookup ( struct iter_forwards fwd,
uint8_t *  qname,
uint16_t  qclass,
int  nolock 
)

Find forward zone information For this qname/qclass find forward zone information, returns delegation point with server names and addresses, or NULL if no forwarding is needed.

The return value is contents of the forwards structure. Caller should lock and unlock a readlock on the forwards structure if nolock is set. Otherwise caller should unlock the readlock on the forwards structure if a value was returned.

Parameters
fwdforward storage.
qnameThe qname of the query.
qclassThe qclass of the query.
nolockSkip locking, locking is handled by the caller.
Returns
: A delegation point if the query has to be forwarded to that list, otherwise null.

References iter_forward_zone::dclass, dname_count_size_labels(), dname_lab_cmp(), iter_forward_zone::dp, rbnode_type::key, iter_forwards::lock, iter_forward_zone::name, iter_forward_zone::namelabs, iter_forward_zone::namelen, iter_forward_zone::node, iter_forward_zone::parent, rbtree_find_less_equal(), and iter_forwards::tree.

Referenced by forward_request(), forwards_lookup_root(), iter_stub_fwd_no_cache(), and print_root_fwds().

◆ forwards_lookup_root()

struct delegpt* forwards_lookup_root ( struct iter_forwards fwd,
uint16_t  qclass,
int  nolock 
)

Same as forwards_lookup, but for the root only.

Parameters
fwdforward storage.
qclassThe qclass of the query.
nolockSkip locking, locking is handled by the caller.
Returns
: A delegation point if root forward exists, otherwise null.

References forwards_lookup().

◆ forwards_next_root()

int forwards_next_root ( struct iter_forwards fwd,
uint16_t *  qclass,
int  nolock 
)

Find next root item in forwards lookup tree.

Handles its own locking unless nolock is set. In that case the caller should lock and unlock a readlock on the forwards structure.

Parameters
fwdthe forward storage
qclassclass to look at next, or higher.
nolockSkip locking, locking is handled by the caller.
Returns
false if none found, or if true stored in qclass.

References iter_forwards::lock.

Referenced by iter_get_next_root().

◆ forwards_get_mem()

size_t forwards_get_mem ( struct iter_forwards fwd)

Get memory in use by forward storage Locks and unlocks the structure.

Parameters
fwdforward storage.
Returns
bytes in use

References delegpt_get_mem(), iter_forward_zone::dp, iter_forwards::lock, iter_forward_zone::namelen, RBTREE_FOR, and iter_forwards::tree.

◆ forwards_add_zone()

int forwards_add_zone ( struct iter_forwards fwd,
uint16_t  c,
struct delegpt dp,
int  nolock 
)

Add zone to forward structure.

For external use since it recalcs the tree parents. Handles its own locking unless nolock is set. In that case the caller should lock and unlock a writelock on the forwards structure.

Parameters
fwdthe forward data structure
cclass of zone
dpdelegation point with name and target nameservers for new forward zone. malloced.
nolockSkip locking, locking is handled by the caller.
Returns
false on failure (out of memory);

References iter_forwards::lock.

Referenced by do_forward().

◆ forwards_delete_zone()

void forwards_delete_zone ( struct iter_forwards fwd,
uint16_t  c,
uint8_t *  nm,
int  nolock 
)

Remove zone from forward structure.

For external use since it recalcs the tree parents. Handles its own locking unless nolock is set. In that case the caller should lock and unlock a writelock on the forwards structure.

Parameters
fwdthe forward data structure
cclass of zone
nmname of zone (in uncompressed wireformat).
nolockSkip locking, locking is handled by the caller.

References iter_forwards::lock.

Referenced by do_forward().

◆ forwards_add_stub_hole()

int forwards_add_stub_hole ( struct iter_forwards fwd,
uint16_t  c,
uint8_t *  nm,
int  nolock 
)

Add stub hole (empty entry in forward table, that makes resolution skip a forward-zone because the stub zone should override the forward zone).

Does not add one if not necessary. Handles its own locking unless nolock is set. In that case the caller should lock and unlock a writelock on the forwards structure.

Parameters
fwdthe forward data structure
cclass of zone
nmname of zone (in uncompressed wireformat).
nolockSkip locking, locking is handled by the caller.
Returns
false on failure (out of memory);

References iter_forwards::lock.

◆ forwards_delete_stub_hole()

void forwards_delete_stub_hole ( struct iter_forwards fwd,
uint16_t  c,
uint8_t *  nm,
int  nolock 
)

Remove stub hole, if one exists.

Handles its own locking unless nolock is set. In that case the caller should lock and unlock a writelock on the forwards structure.

Parameters
fwdthe forward data structure
cclass of zone
nmname of zone (in uncompressed wireformat).
nolockSkip locking, locking is handled by the caller.

References iter_forwards::lock.