util.h File Reference

Go to the source code of this file.

Data Structures

struct  ldns_schwartzian_compare_struct
 Structure to do a Schwartzian-like transformation, for instance when sorting. More...
struct  ldns_struct_lookup_table
 A general purpose lookup table. More...

Defines

#define dprintf(X, Y)   fprintf(stderr, (X), (Y))
#define LDNS_VERSION   "1.2.2 "
#define INLINE   static inline
 splint static inline workaround
#define LDNS_MALLOC(type)   LDNS_XMALLOC(type, 1)
 Memory management macros.
#define LDNS_XMALLOC(type, count)   ((type *) malloc((count) * sizeof(type)))
#define LDNS_REALLOC(ptr, type)   LDNS_XREALLOC((ptr), type, 1)
#define LDNS_XREALLOC(ptr, type, count)   ((type *) realloc((ptr), (count) * sizeof(type)))
#define LDNS_FREE(ptr)   do { free((ptr)); (ptr) = NULL; } while (0)
#define LDNS_DEP   printf("DEPRECATED FUNCTION!\n");

Typedefs

typedef ldns_struct_lookup_table ldns_lookup_table

Functions

ldns_lookup_tableldns_lookup_by_name (ldns_lookup_table table[], const char *name)
 Looks up the table entry by name, returns NULL if not found.
ldns_lookup_tableldns_lookup_by_id (ldns_lookup_table table[], int id)
 Looks up the table entry by id, returns NULL if not found.
int ldns_get_bit (uint8_t bits[], size_t index)
 Returns the value of the specified bit The bits are counted from left to right, so bit #0 is the left most bit.
int ldns_get_bit_r (uint8_t bits[], size_t index)
 Returns the value of the specified bit The bits are counted from right to left, so bit #0 is the right most bit.
void ldns_set_bit (uint8_t *byte, int bit_nr, bool value)
 sets the specified bit in the specified byte to 1 if value is true, 0 if false The bits are counted from right to left, so bit #0 is the right most bit.
int ldns_hexdigit_to_int (char ch)
 Returns the int value of the given (hex) digit.
char ldns_int_to_hexdigit (int ch)
 Returns the char (hex) representation of the given int.
const char * ldns_version (void)
 Show the internal library version.
time_t mktime_from_utc (const struct tm *tm)
 Convert TM to seconds since epoch (midnight, January 1st, 1970).
int ldns_init_random (FILE *fd, unsigned int size)
 Seed the random function.


Define Documentation

#define dprintf ( X,
 )     fprintf(stderr, (X), (Y))

Definition at line 20 of file util.h.

#define LDNS_VERSION   "1.2.2 "

Definition at line 23 of file util.h.

#define INLINE   static inline

splint static inline workaround

Definition at line 31 of file util.h.

#define LDNS_MALLOC ( type   )     LDNS_XMALLOC(type, 1)

Memory management macros.

Definition at line 37 of file util.h.

#define LDNS_XMALLOC ( type,
count   )     ((type *) malloc((count) * sizeof(type)))

Definition at line 39 of file util.h.

#define LDNS_REALLOC ( ptr,
type   )     LDNS_XREALLOC((ptr), type, 1)

Definition at line 41 of file util.h.

#define LDNS_XREALLOC ( ptr,
type,
count   )     ((type *) realloc((ptr), (count) * sizeof(type)))

Definition at line 43 of file util.h.

#define LDNS_FREE ( ptr   )     do { free((ptr)); (ptr) = NULL; } while (0)

Definition at line 46 of file util.h.

#define LDNS_DEP   printf("DEPRECATED FUNCTION!\n");

Definition at line 49 of file util.h.


Typedef Documentation

typedef struct ldns_struct_lookup_table ldns_lookup_table

Definition at line 146 of file util.h.


Function Documentation

ldns_lookup_table* ldns_lookup_by_name ( ldns_lookup_table  table[],
const char *  name 
)

Looks up the table entry by name, returns NULL if not found.

Parameters:
[in] table the lookup table to search in
[in] name what to search for
Returns:
the item found

ldns_lookup_table* ldns_lookup_by_id ( ldns_lookup_table  table[],
int  id 
)

Looks up the table entry by id, returns NULL if not found.

Parameters:
[in] table the lookup table to search in
[in] id what to search for
Returns:
the item found

int ldns_get_bit ( uint8_t  bits[],
size_t  index 
)

Returns the value of the specified bit The bits are counted from left to right, so bit #0 is the left most bit.

Parameters:
[in] bits array holding the bits
[in] index to the wanted bit
Returns:

Definition at line 76 of file util.c.

int ldns_get_bit_r ( uint8_t  bits[],
size_t  index 
)

Returns the value of the specified bit The bits are counted from right to left, so bit #0 is the right most bit.

Parameters:
[in] bits array holding the bits
[in] index to the wanted bit
Returns:
1 or 0 depending no the bit state

Definition at line 86 of file util.c.

void ldns_set_bit ( uint8_t *  byte,
int  bit_nr,
bool  value 
)

sets the specified bit in the specified byte to 1 if value is true, 0 if false The bits are counted from right to left, so bit #0 is the right most bit.

Parameters:
[in] byte the bit to set the bit in
[in] bit_nr the bit to set (0 <= n <= 7)
[in] value whether to set the bit to 1 or 0
Returns:
1 or 0 depending no the bit state

Definition at line 96 of file util.c.

int ldns_hexdigit_to_int ( char  ch  ) 

Returns the int value of the given (hex) digit.

Parameters:
[in] ch the hex char to convert
Returns:
the converted decimal value

Definition at line 108 of file util.c.

char ldns_int_to_hexdigit ( int  ch  ) 

Returns the char (hex) representation of the given int.

Parameters:
[in] ch the int to convert
Returns:
the converted hex char

Definition at line 133 of file util.c.

const char* ldns_version ( void   ) 

Show the internal library version.

Returns:
a string with the version in it

Definition at line 158 of file util.c.

References LDNS_VERSION.

time_t mktime_from_utc ( const struct tm *  tm  ) 

Convert TM to seconds since epoch (midnight, January 1st, 1970).

Like timegm(3), which is not always available.

Parameters:
[in] tm a struct tm* with the date
Returns:
the seconds since epoch

Definition at line 186 of file util.c.

int ldns_init_random ( FILE *  fd,
unsigned int  size 
)

Seed the random function.

If you need more entropy, or have no openssl available, this function MUST be called at the start of the program

If openssl *is* available, this function just adds more entropy

Definition at line 222 of file util.c.

References LDNS_FREE, and LDNS_XMALLOC.


Generated on Thu Nov 29 14:15:12 2007 for ldns by  doxygen 1.5.1