ckd_alloc.h File Reference

Sphinx's memory allocation/deallocation routines. More...

`#include <stdlib.h>`
`#include <setjmp.h>`
`#include <sphinxbase/sphinxbase_export.h>`
`#include <sphinxbase/prim_type.h>`

Go to the source code of this file.

## Macros

#define | ckd_calloc(n, sz) __ckd_calloc__((n),(sz),__FILE__,__LINE__)
| Macros to simplify the use of above functions. More...
#define | ckd_malloc(sz) __ckd_malloc__((sz),__FILE__,__LINE__)
| Macro for ckd_malloc
#define | ckd_realloc(ptr, sz) __ckd_realloc__(ptr,(sz),__FILE__,__LINE__)
| Macro for ckd_realloc
#define | ckd_salloc(ptr) __ckd_salloc__(ptr,__FILE__,__LINE__)
| Macro for ckd_salloc
#define | ckd_calloc_2d(d1, d2, sz) __ckd_calloc_2d__((d1),(d2),(sz),__FILE__,__LINE__)
| Macro for ckd_calloc_2d
#define | ckd_calloc_3d(d1, d2, d3, sz) __ckd_calloc_3d__((d1),(d2),(d3),(sz),__FILE__,__LINE__)
| Macro for ckd_calloc_3d
#define | ckd_calloc_4d(d1, d2, d3, d4, s) __ckd_calloc_4d__((d1), (d2), (d3), (d4), (s), __FILE__, __LINE__)
| Macro for ckd_calloc_4d
#define | ckd_alloc_2d_ptr(d1, d2, bf, sz) __ckd_alloc_2d_ptr((d1), (d2), (bf), (sz), __FILE__, __LINE__)
| Macro for ckd_alloc_2d_ptr
#define | ckd_free_2d_ptr(bf) ckd_free(bf)
| Free only the pointer arrays allocated with ckd_alloc_2d_ptr().
#define | ckd_alloc_3d_ptr(d1, d2, d3, bf, sz) __ckd_alloc_3d_ptr((d1), (d2), (d3), (bf), (sz), __FILE__, __LINE__)
| Macro for ckd_alloc_3d_ptr
#define | ckd_free_3d_ptr(bf) ckd_free_2d(bf)
| Free only the pointer arrays allocated with ckd_alloc_3d_ptr().

## Functions

jmp_buf * | ckd_set_jump (jmp_buf *env, int abort)
| Control behaviour of the program when allocation fails. More...
void | ckd_fail (char *format,...)
| Fail (with a message) according to behaviour specified by ckd_set_jump().
SPHINXBASE_EXPORT void * | __ckd_calloc__ (size_t n_elem, size_t elem_size, const char *caller_file, int caller_line)
SPHINXBASE_EXPORT void * | __ckd_malloc__ (size_t size, const char *caller_file, int caller_line)
SPHINXBASE_EXPORT void * | __ckd_realloc__ (void *ptr, size_t new_size, const char *caller_file, int caller_line)
SPHINXBASE_EXPORT char * | __ckd_salloc__ (const char *origstr, const char *caller_file, int caller_line)
| Like strdup, except that if an error occurs it prints a diagnostic message and exits.
SPHINXBASE_EXPORT void * | __ckd_calloc_2d__ (size_t d1, size_t d2, size_t elemsize, const char *caller_file, int caller_line)
| Allocate a 2-D array and return ptr to it (ie, ptr to vector of ptrs). More...
SPHINXBASE_EXPORT void * | __ckd_calloc_3d__ (size_t d1, size_t d2, size_t d3, size_t elemsize, const char *caller_file, int caller_line)
| Allocate a 3-D array and return ptr to it. More...
SPHINXBASE_EXPORT void **** | __ckd_calloc_4d__ (size_t d1, size_t d2, size_t d3, size_t d4, size_t elem_size, char *caller_file, int caller_line)
| Allocate a 34D array and return ptr to it. More...
SPHINXBASE_EXPORT void * | __ckd_alloc_3d_ptr (size_t d1, size_t d2, size_t d3, void *store, size_t elem_size, char *caller_file, int caller_line)
| Overlay a 3-D array over a previously allocated storage area.
SPHINXBASE_EXPORT void * | __ckd_alloc_2d_ptr (size_t d1, size_t d2, void *store, size_t elem_size, char *caller_file, int caller_line)
| Overlay a s-D array over a previously allocated storage area.
SPHINXBASE_EXPORT void | ckd_free (void *ptr)
| Test and free a 1-D array.
SPHINXBASE_EXPORT void | ckd_free_2d (void *ptr)
| Free a 2-D array (ptr) previously allocated by ckd_calloc_2d.
SPHINXBASE_EXPORT void | ckd_free_3d (void *ptr)
| Free a 3-D array (ptr) previously allocated by ckd_calloc_3d.
SPHINXBASE_EXPORT void | ckd_free_4d (void *ptr)
| Free a 4-D array (ptr) previously allocated by ckd_calloc_4d.

## Detailed Description

Sphinx's memory allocation/deallocation routines.

Implementation of efficient memory allocation deallocation for multiple dimensional arrays.

Definition in file ckd_alloc.h.

## Macro Definition Documentation

#define ckd_calloc | ( |  | n,
|  |  | sz
| ) |  | __ckd_calloc__((n),(sz),__FILE__,__LINE__)

Macros to simplify the use of above functions.

One should use these, rather than target functions directly. Macro for ckd_calloc

Definition at line 248 of file ckd_alloc.h.

Referenced by __ckd_calloc_4d__(), agc_init(), bio_fread_1d(), bio_fwrite(), bio_read_wavfile(), bio_readhdr(), bit_encode_attach(), cmd_ln_init(), cmd_ln_parse_file_r(), cmd_ln_parse_r(), feat_array_alloc(), feat_init(), feat_lda_transform(), feat_s2mfc2feat(), feat_set_subvecs(), fopen_compchk(), glist_add_float32(), glist_add_float64(), glist_add_int32(), glist_add_ptr(), glist_add_uint32(), glist_insert_float32(), glist_insert_float64(), glist_insert_int32(), glist_insert_ptr(), glist_insert_uint32(), hash_table_iter(), hash_table_new(), heap_new(), huff_code_build_int(), huff_code_build_str(), huff_code_read(), jsgf_grammar_new(), lineiter_start(), listelem_alloc_init(), logmath_init(), logmath_read(), mmio_file_read(), ngram_iter(), ngram_model_add_class(), ngram_model_set_init(), ngram_model_set_iter(), ngram_model_set_map_words(), ngram_model_set_read(), ngram_prob(), ngram_score(), parse_subvecs(), pctr_new(), sbevent_init(), sbmsgq_init(), sbmtx_init(), sbthread_start(), string_join(), and yin_init().

## Function Documentation

SPHINXBASE_EXPORT void* __ckd_calloc_2d__ | ( | size_t | d1,
|  | size_t | d2,
|  | size_t | elemsize,
|  | const char * | caller_file,
|  | int | caller_line
| ) |  |

Allocate a 2-D array and return ptr to it (ie, ptr to vector of ptrs).

The data area is allocated in one block so it can also be treated as a 1-D array.

Definition at line 220 of file ckd_alloc.c.

SPHINXBASE_EXPORT void* __ckd_calloc_3d__ | ( | size_t | d1,
|  | size_t | d2,
|  | size_t | d3,
|  | size_t | elemsize,
|  | const char * | caller_file,
|  | int | caller_line
| ) |  |

Allocate a 3-D array and return ptr to it.

The data area is allocated in one block so it can also be treated as a 1-D array.

Definition at line 262 of file ckd_alloc.c.

SPHINXBASE_EXPORT void**** __ckd_calloc_4d__ | ( | size_t | d1,
|  | size_t | d2,
|  | size_t | d3,
|  | size_t | d4,
|  | size_t | elem_size,
|  | char * | caller_file,
|  | int | caller_line
| ) |  |

Allocate a 34D array and return ptr to it.

The data area is allocated in one block so it can also be treated as a 1-D array.

Definition at line 307 of file ckd_alloc.c.

References ckd_calloc, and E_FATAL.

jmp_buf* ckd_set_jump | ( | jmp_buf * | env,
|  | int | abort
| ) |  |

Control behaviour of the program when allocation fails.

Although your program is probably toast when memory allocation fails, it is also probably a good idea to be able to catch these errors and alert the user in some way. Either that, or you might want the program to call abort() so that you can debug the failed code. This function allows you to control that behaviour.

Parameters

  env | Pointer to a `jmp_buf` initialized with setjmp(), or NULL to remove a previously set jump target.
  abort | If non-zero, the program will call abort() when allocation fails rather than exiting or calling longjmp().

Returns
  Pointer to a previously set `jmp_buf`, if any.

Definition at line 109 of file ckd_alloc.c.