![]() |
Code_Saturne
CFD tool
|
#include "ecs_def.h"
#include <assert.h>
#include <errno.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "ecs_mem.h"
#include "ecs_mem_usage.h"
Functions | |
void | ecs_mem_init (const char *log_file_name) |
Initialize memory handling. More... | |
void | ecs_mem_end (void) |
End memory handling. More... | |
int | ecs_mem_initialized (void) |
Indicates if ecs_mem_...() functions are initialized. More... | |
void * | ecs_mem_malloc (size_t ni, size_t size, const char *var_name, const char *file_name, int line_num) |
Allocate memory for ni elements of size bytes. More... | |
void * | ecs_mem_realloc (void *ptr, size_t ni, size_t size, const char *var_name, const char *file_name, int line_num) |
Reallocate memory for ni elements of size bytes. More... | |
void * | ecs_mem_free (void *ptr, const char *var_name, const char *file_name, int line_num) |
Free allocated memory. More... | |
size_t | ecs_mem_size_current (void) |
Return current theoretical dynamic memory allocated. More... | |
size_t | ecs_mem_size_max (void) |
Return maximum theoretical dynamic memory allocated. More... | |
void ecs_mem_end | ( | void | ) |
End memory handling.
This function should be called after all other ecs_mem_...() functions. In case of memory allocation logging, it writes final information to the log file and closes is.
void* ecs_mem_free | ( | void * | ptr, |
const char * | var_name, | ||
const char * | file_name, | ||
int | line_num | ||
) |
Free allocated memory.
This function calls free(), but adds tracing capabilities, and automatically calls the ecs_error() errorhandler if it fails to free the corresponding memory. In case of a NULL pointer argument, the function simply returns.
[in] | ptr | pointer to previous memory location (if NULL, ecs_alloc() called). |
[in] | var_name | allocated variable name string |
[in] | file_name | name of calling source file |
[in] | line_num | line number in calling source file |
void ecs_mem_init | ( | const char * | log_file_name | ) |
Initialize memory handling.
This function should be called before any other ecs_mem_...() function. To activate memory allocation logging, a logfile name should be given as an argument. The resulting file will be a regular, local file. If this file cannot be opened for some reason, logging is silently de-activated.
log_file_name | name of optional log_file (if NULL, no log). |
int ecs_mem_initialized | ( | void | ) |
Indicates if ecs_mem_...() functions are initialized.
void* ecs_mem_malloc | ( | size_t | ni, |
size_t | size, | ||
const char * | var_name, | ||
const char * | file_name, | ||
int | line_num | ||
) |
Allocate memory for ni elements of size bytes.
This function calls malloc(), but adds tracing capabilities, and automatically calls the ecs_error() errorhandler if it fails to allocate the required memory.
[in] | ni | number of elements. |
[in] | size | element size. |
[in] | var_name | allocated variable name string. |
[in] | file_name | name of calling source file. |
[in] | line_num | line number in calling source file. |
void* ecs_mem_realloc | ( | void * | ptr, |
size_t | ni, | ||
size_t | size, | ||
const char * | var_name, | ||
const char * | file_name, | ||
int | line_num | ||
) |
Reallocate memory for ni elements of size bytes.
This function calls realloc(), but adds tracing capabilities, and automatically calls the ecs_error() errorhandler if it fails to allocate the required memory.
[in] | ptr | pointer to previous memory location (if NULL, ecs_alloc() called). |
[in] | ni | number of elements. |
[in] | size | element size. |
[in] | var_name | allocated variable name string. |
[in] | file_name | name of calling source file. |
[in] | line_num | line number in calling source file. |
size_t ecs_mem_size_current | ( | void | ) |
Return current theoretical dynamic memory allocated.
size_t ecs_mem_size_max | ( | void | ) |
Return maximum theoretical dynamic memory allocated.