Data Structures | Defines | Typedefs | Functions
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.6.13"
#define LDNS_REVISION   ((1<<16)|(6<<8)|(13))
#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_CALLOC(type, count)   ((type *) calloc((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 struct
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.
int ldns_hexstring_to_data (uint8_t *data, const char *str)
 Converts a hex string to binary data.
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).
struct tm * ldns_serial_arithmitics_gmtime_r (int32_t time, time_t now, struct tm *result)
 The function interprets time as the number of seconds since epoch with respect to now using serial arithmitics (rfc1982).
int ldns_init_random (FILE *fd, unsigned int size)
 Seed the random function.
uint16_t ldns_get_random (void)
 Get random number.
char * ldns_bubblebabble (uint8_t *data, size_t len)
 Encode data as BubbleBabble.
int ldns_b32_ntop (uint8_t const *src, size_t srclength, char *target, size_t targsize)
int b32_ntop (uint8_t const *src, size_t srclength, char *target, size_t targsize)
int ldns_b32_ntop_extended_hex (uint8_t const *src, size_t srclength, char *target, size_t targsize)
int b32_ntop_extended_hex (uint8_t const *src, size_t srclength, char *target, size_t targsize)
int ldns_b32_pton (char const *src, size_t hashed_owner_str_len, uint8_t *target, size_t targsize)
int b32_pton (char const *src, size_t hashed_owner_str_len, uint8_t *target, size_t targsize)
int ldns_b32_pton_extended_hex (char const *src, size_t hashed_owner_str_len, uint8_t *target, size_t targsize)
int b32_pton_extended_hex (char const *src, size_t hashed_owner_str_len, uint8_t *target, size_t targsize)

Define Documentation

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

Definition at line 27 of file util.h.

#define LDNS_VERSION   "1.6.13"

Definition at line 30 of file util.h.

#define LDNS_REVISION   ((1<<16)|(6<<8)|(13))

Definition at line 31 of file util.h.

#define INLINE   static inline

splint static inline workaround

Definition at line 42 of file util.h.

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

Memory management macros.

Definition at line 49 of file util.h.

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

Definition at line 51 of file util.h.

#define LDNS_CALLOC (   type,
  count 
)    ((type *) calloc((count), sizeof(type)))

Definition at line 53 of file util.h.

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

Definition at line 55 of file util.h.

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

Definition at line 57 of file util.h.

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

Definition at line 60 of file util.h.

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

Definition at line 63 of file util.h.


Typedef Documentation

Definition at line 160 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]tablethe lookup table to search in
[in]namewhat 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]tablethe lookup table to search in
[in]idwhat 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]bitsarray holding the bits
[in]indexto the wanted bit
Returns:

Definition at line 88 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]bitsarray holding the bits
[in]indexto the wanted bit
Returns:
1 or 0 depending no the bit state

Definition at line 98 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]bytethe bit to set the bit in
[in]bit_nrthe bit to set (0 <= n <= 7)
[in]valuewhether to set the bit to 1 or 0
Returns:
1 or 0 depending no the bit state

Definition at line 108 of file util.c.

int ldns_hexdigit_to_int ( char  ch)

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

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

Definition at line 124 of file util.c.

char ldns_int_to_hexdigit ( int  ch)

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

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

Definition at line 149 of file util.c.

int ldns_hexstring_to_data ( uint8_t *  data,
const char *  str 
)

Converts a hex string to binary data.

Parameters:
[out]dataThe binary result is placed here. At least strlen(str)/2 bytes should be allocated
[in]strThe hex string to convert. This string should not contain spaces
Returns:
The number of bytes of converted data, or -1 if one of the arguments * is NULL, or -2 if the string length is not an even number

Definition at line 174 of file util.c.

References ldns_hexdigit_to_int().

const char* ldns_version ( void  )

Show the internal library version.

Returns:
a string with the version in it

Definition at line 196 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]tma struct tm* with the date
Returns:
the seconds since epoch

Definition at line 230 of file util.c.

struct tm* ldns_serial_arithmitics_gmtime_r ( int32_t  time,
time_t  now,
struct tm *  result 
) [read]

The function interprets time as the number of seconds since epoch with respect to now using serial arithmitics (rfc1982).

That number of seconds is then converted to broken-out time information. This is especially usefull when converting the inception and expiration fields of RRSIG records.

Parameters:
[in]timenumber of seconds since epoch (midnight, January 1st, 1970) to be intepreted as a serial arithmitics number relative to now.
[in]nownumber of seconds since epoch (midnight, January 1st, 1970) to which the time value is compared to determine the final value.
[out]resultthe struct with the broken-out time information
Returns:
result on success or NULL on error

Definition at line 334 of file util.c.

References gmtime_r().

int ldns_init_random ( FILE *  fd,
unsigned int  size 
)

Seed the random function.

If the file descriptor is specified, the random generator is seeded with data from that file. If not, /dev/urandom is used.

applications should call this if they need entropy data within ldns If openSSL is available, it is automatically seeded from /dev/urandom or /dev/random.

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

Parameters:
[in]fda file providing entropy data for the seed
[in]sizethe number of bytes to use as entropy data. If this is 0, only the minimal amount is taken (usually 4 bytes)
Returns:
0 if seeding succeeds, 1 if it fails

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 357 of file util.c.

References LDNS_XMALLOC, LDNS_FREE, and srandom.

uint16_t ldns_get_random ( void  )

Get random number.

Returns:
random number.

Definition at line 429 of file util.c.

References random.

char* ldns_bubblebabble ( uint8_t *  data,
size_t  len 
)

Encode data as BubbleBabble.

Parameters:
[in]dataa pointer to data to be encoded
[in]lensize the number of bytes of data
Returns:
a string of BubbleBabble

Definition at line 447 of file util.c.

References LDNS_XMALLOC.

int ldns_b32_ntop ( uint8_t const *  src,
size_t  srclength,
char *  target,
size_t  targsize 
)
int b32_ntop ( uint8_t const *  src,
size_t  srclength,
char *  target,
size_t  targsize 
)
int ldns_b32_ntop_extended_hex ( uint8_t const *  src,
size_t  srclength,
char *  target,
size_t  targsize 
)
int b32_ntop_extended_hex ( uint8_t const *  src,
size_t  srclength,
char *  target,
size_t  targsize 
)
int ldns_b32_pton ( char const *  src,
size_t  hashed_owner_str_len,
uint8_t *  target,
size_t  targsize 
)
int b32_pton ( char const *  src,
size_t  hashed_owner_str_len,
uint8_t *  target,
size_t  targsize 
)
int ldns_b32_pton_extended_hex ( char const *  src,
size_t  hashed_owner_str_len,
uint8_t *  target,
size_t  targsize 
)
int b32_pton_extended_hex ( char const *  src,
size_t  hashed_owner_str_len,
uint8_t *  target,
size_t  targsize 
)