alloc.h File Reference

This file contains memory allocation functions. More...

#include "util/locks.h"

Data Structures
struct	alloc_cache
	Structure that provides allocation. More...
Defines
#define	alloc_special_clean(x)   (x)->id = 0;
	clean the special type.
#define	alloc_special_next(x)   ((alloc_special_t*)((x)->entry.overflow_next))
	access next pointer.
#define	alloc_set_special_next(x, y)   ((x)->entry.overflow_next) = (struct lruhash_entry*)(y);
	set next pointer.
#define	ALLOC_SPECIAL_MAX   10
	how many blocks to cache locally.
Typedefs
typedef struct ub_packed_rrset_key	alloc_special_t
	The special type, packed rrset.
Functions
void	alloc_init (struct alloc_cache *alloc, struct alloc_cache *super, int thread_num)
	Init alloc (zeroes the struct).
void	alloc_clear (struct alloc_cache *alloc)
	Free the alloc.
alloc_special_t *	alloc_special_obtain (struct alloc_cache *alloc)
	Get a new special_t element.
void	alloc_special_release (struct alloc_cache *alloc, alloc_special_t *mem)
	Return special_t back to pool.
uint64_t	alloc_get_id (struct alloc_cache *alloc)
	Set ID number of special type to a fresh new ID number.
size_t	alloc_get_mem (struct alloc_cache *alloc)
	Get memory size of alloc cache, alloc structure including special types.
void	alloc_stats (struct alloc_cache *alloc)
	Print debug information (statistics).
struct regional *	alloc_reg_obtain (struct alloc_cache *alloc)
	Get a new regional for query states.
void	alloc_reg_release (struct alloc_cache *alloc, struct regional *r)
	Put regional for query states back into alloc cache.
void	alloc_set_id_cleanup (struct alloc_cache *alloc, void(*cleanup)(void *), void *arg)
	Set cleanup on ID overflow callback function.

---

Detailed Description

This file contains memory allocation functions.

The reasons for this service are: o Avoid locking costs of getting global lock to call malloc(). o The packed rrset type needs to be kept on special freelists, so that they are reused for other packet rrset allocations.

---

Define Documentation

#define alloc_special_clean

(

x

)

(x)->id = 0;

clean the special type.

Pass pointer.

Referenced by alloc_special_release().

#define alloc_special_next

(

x

)

((alloc_special_t*)((x)->entry.overflow_next))

access next pointer.

(in available spot). Pass pointer.

Referenced by alloc_clear(), alloc_special_obtain(), pushintosuper(), and alloc_get_mem().

#define alloc_set_special_next	(		x,
			y
	)		((x)->entry.overflow_next) = (struct lruhash_entry*)(y);

set next pointer.

(in available spot). Pass pointers.

Referenced by prealloc(), alloc_clear(), pushintosuper(), and alloc_special_release().

#define ALLOC_SPECIAL_MAX   10

how many blocks to cache locally.

Referenced by prealloc(), pushintosuper(), and alloc_special_release().

---

Typedef Documentation

typedef struct ub_packed_rrset_key alloc_special_t

The special type, packed rrset.

Not allowed to be used for other memory

---

Function Documentation

void alloc_init	(	struct alloc_cache *	alloc,
		struct alloc_cache *	super,
		int	thread_num
	)

Init alloc (zeroes the struct).

Parameters:

alloc,:	this parameter is allocated by the caller.
super,:	super to use (init that before with super_init). Pass this argument NULL to init the toplevel alloc structure.
thread_num,:	thread number for id creation of special type.

References alloc_cache::super, alloc_cache::thread_num, alloc_cache::next_id, THRNUM_SHIFT, alloc_cache::last_id, alloc_cache::max_reg_blocks, alloc_cache::num_reg_blocks, alloc_cache::reg_list, alloc_cache::cleanup, alloc_cache::cleanup_arg, prealloc_blocks(), and alloc_cache::lock.

Referenced by daemon_init(), worker_init(), context_obtain_alloc(), ub_ctx_create(), alloc_test(), msgparse_test(), verifytest_file(), dstest_file(), and nsec3_hash_test().

void alloc_clear

(

struct alloc_cache *

alloc

)

Free the alloc.

Pushes all the cached items into the super structure. Or deletes them if alloc->super is NULL. Does not free the alloc struct itself (it was also allocated by caller).

Parameters:

alloc,:

is almost zeroed on exit (except some stats).

References alloc_cache::super, alloc_cache::lock, alloc_cache::quar, alloc_special_next, alloc_set_special_next, alloc_cache::num_quar, ub_packed_rrset_key::entry, lruhash_entry::lock, alloc_cache::reg_list, regional::next, and alloc_cache::num_reg_blocks.

Referenced by daemon_delete(), worker_delete(), ub_ctx_delete(), alloc_test(), msgparse_test(), verifytest_file(), dstest_file(), and nsec3_hash_test().

alloc_special_t* alloc_special_obtain

(

struct alloc_cache *

alloc

)

Get a new special_t element.

Parameters:

alloc,:

where to alloc it.

Returns:

: memory block. Will not return NULL (instead fatal_exit). The block is zeroed.

References log_assert, alloc_cache::quar, alloc_special_next, alloc_cache::num_quar, ub_packed_rrset_key::id, alloc_get_id(), alloc_cache::super, alloc_cache::lock, prealloc(), log_err(), and alloc_setup_special().

Referenced by move_into_cache(), store_rrset(), alloc_test(), repinfo_alloc_rrset_keys(), and packed_rrset_copy_alloc().

void alloc_special_release	(	struct alloc_cache *	alloc,
		alloc_special_t *	mem
	)

Return special_t back to pool.

The block is cleaned up (zeroed) which also invalidates the ID inside.

Parameters:

alloc,:	where to alloc it.
mem,:	block to free.

References log_assert, alloc_cache::super, alloc_cache::lock, alloc_special_clean, alloc_cache::num_quar, ALLOC_SPECIAL_MAX, pushintosuper(), alloc_set_special_next, and alloc_cache::quar.

Referenced by store_rrset(), alloc_test(), ub_packed_rrset_parsedelete(), ub_rrset_key_delete(), and packed_rrset_copy_alloc().

uint64_t alloc_get_id

(

struct alloc_cache *

alloc

)

Set ID number of special type to a fresh new ID number.

In case of ID number overflow, the rrset cache has to be cleared.

Parameters:

alloc,:

the alloc cache

Returns:

: fresh id is returned.

References alloc_cache::next_id, alloc_cache::last_id, log_warn(), fptr_ok, fptr_whitelist_alloc_cleanup(), alloc_cache::cleanup, alloc_cache::cleanup_arg, alloc_cache::thread_num, and THRNUM_SHIFT.

Referenced by rrset_update_id(), and alloc_special_obtain().

size_t alloc_get_mem

(

struct alloc_cache *

alloc

)

Get memory size of alloc cache, alloc structure including special types.

Parameters:

alloc,:

on what alloc.

Returns:

size in bytes.

References alloc_cache::super, alloc_cache::lock, alloc_cache::num_quar, alloc_cache::quar, alloc_special_next, ub_packed_rrset_key::entry, lruhash_entry::lock, alloc_cache::num_reg_blocks, and ALLOC_REG_SIZE.

Referenced by worker_mem_report().

void alloc_stats

(

struct alloc_cache *

alloc

)

Print debug information (statistics).

Parameters:

alloc,:

on what alloc.

References log_info(), alloc_cache::super, alloc_cache::num_quar, and alloc_cache::num_reg_blocks.

Referenced by alloc_test().

struct regional* alloc_reg_obtain

(

struct alloc_cache *

alloc

)

[read]

Get a new regional for query states.

Parameters:

alloc,:

where to alloc it.

Returns:

regional for use or NULL on alloc failure.

References alloc_cache::num_reg_blocks, alloc_cache::reg_list, regional::next, regional_create_custom(), and ALLOC_REG_SIZE.

Referenced by mesh_state_create().

void alloc_reg_release	(	struct alloc_cache *	alloc,
		struct regional *	r
	)

Put regional for query states back into alloc cache.

Parameters:

alloc,:	where to alloc it.
r,:	regional to put back.

References alloc_cache::num_reg_blocks, alloc_cache::max_reg_blocks, regional_destroy(), regional_free_all(), log_assert, regional::next, and alloc_cache::reg_list.

Referenced by mesh_state_create(), and mesh_state_cleanup().

void alloc_set_id_cleanup	(	struct alloc_cache *	alloc,
		void(*)(void *)	cleanup,
		void *	arg
	)

Set cleanup on ID overflow callback function.

This should remove all RRset ID references from the program. Clear the caches.

Parameters:

alloc,:	the alloc
cleanup,:	the callback function, called as cleanup(arg).
arg,:	user argument to callback function.

References alloc_cache::cleanup, and alloc_cache::cleanup_arg.

Referenced by worker_init(), and libworker_setup().