Electroneum
iter_fwd.h File Reference
#include "util/rbtree.h"
Include dependency graph for iter_fwd.h:

Go to the source code of this file.

Classes

struct  iter_forwards
 
struct  iter_forward_zone
 

Functions

struct iter_forwardsforwards_create (void)
 
void forwards_delete (struct iter_forwards *fwd)
 
int forwards_apply_cfg (struct iter_forwards *fwd, struct config_file *cfg)
 
struct delegptforwards_find (struct iter_forwards *fwd, uint8_t *qname, uint16_t qclass)
 
struct delegptforwards_lookup (struct iter_forwards *fwd, uint8_t *qname, uint16_t qclass)
 
struct delegptforwards_lookup_root (struct iter_forwards *fwd, uint16_t qclass)
 
int forwards_next_root (struct iter_forwards *fwd, uint16_t *qclass)
 
size_t forwards_get_mem (struct iter_forwards *fwd)
 
int fwd_cmp (const void *k1, const void *k2)
 
int forwards_add_zone (struct iter_forwards *fwd, uint16_t c, struct delegpt *dp)
 
void forwards_delete_zone (struct iter_forwards *fwd, uint16_t c, uint8_t *nm)
 
int forwards_add_stub_hole (struct iter_forwards *fwd, uint16_t c, uint8_t *nm)
 
void forwards_delete_stub_hole (struct iter_forwards *fwd, uint16_t c, uint8_t *nm)
 

Detailed Description

This file contains functions to assist the iterator module. Keep track of forward zones, and read those from config.

Definition in file iter_fwd.h.

Function Documentation

◆ forwards_add_stub_hole()

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

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.

Parameters
fwdthe forward data structure
cclass of zone
nmname of zone (in uncompressed wireformat).
Returns
false on failure (out of memory);

◆ forwards_add_zone()

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

Add zone to forward structure. For external use since it recalcs the tree parents.

Parameters
fwdthe forward data structure
cclass of zone
dpdelegation point with name and target nameservers for new forward zone. malloced.
Returns
false on failure (out of memory);

◆ 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.

◆ forwards_create()

struct iter_forwards* forwards_create ( void  )

Create forwards

Returns
new forwards or NULL on error.

◆ forwards_delete()

void forwards_delete ( struct iter_forwards fwd)

Delete forwards.

Parameters
fwdto delete.

◆ forwards_delete_stub_hole()

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

Remove stub hole, if one exists.

Parameters
fwdthe forward data structure
cclass of zone
nmname of zone (in uncompressed wireformat).

◆ forwards_delete_zone()

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

Remove zone from forward structure. For external use since it recalcs the tree parents.

Parameters
fwdthe forward data structure
cclass of zone
nmname of zone (in uncompressed wireformat).

◆ forwards_find()

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

Find forward zone exactly by name

Parameters
fwdforward storage.
qnameThe qname of the query.
qclassThe qclass of the query.
Returns
: A delegation point or null.

◆ forwards_get_mem()

size_t forwards_get_mem ( struct iter_forwards fwd)

Get memory in use by forward storage

Parameters
fwdforward storage.
Returns
bytes in use

◆ forwards_lookup()

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

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.

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

◆ forwards_lookup_root()

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

Same as forwards_lookup, but for the root only

Parameters
fwdforward storage.
qclassThe qclass of the query.
Returns
: A delegation point if root forward exists, otherwise null.

◆ forwards_next_root()

int forwards_next_root ( struct iter_forwards fwd,
uint16_t qclass 
)

Find next root item in forwards lookup tree.

Parameters
fwdthe forward storage
qclassclass to look at next, or higher.
Returns
false if none found, or if true stored in qclass.

◆ fwd_cmp()

int fwd_cmp ( const void *  k1,
const void *  k2 
)

compare two fwd entries