core: Add some documentation to the malloc_trim code

This adds documentation to handle_cli_malloc_trim() indicating how it
can be useful when debugging OOM conditions.

Change-Id: I1936185e78035bf123cd5e097b793a55eeebdc78
This commit is contained in:
Sean Bright
2018-12-03 17:41:56 -05:00
parent ff02c93d9e
commit 8f5df046f6

View File

@@ -1781,30 +1781,43 @@ static char *handle_cli_wait_fullybooted(struct ast_cli_entry *e, int cmd, struc
#ifdef HAVE_MALLOC_TRIM #ifdef HAVE_MALLOC_TRIM
/* BUGBUG malloc_trim() is a libc specific function. Non-portable. */
static char *handle_cli_malloc_trim(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
extern int malloc_trim(size_t __pad) __THROW;
switch (cmd) { /*!
case CLI_INIT: * \internal
e->command = "malloc trim"; * \brief Attempt to reclaim unused heap memory.
e->usage = *
"Usage: malloc trim\n" * Users have reported that asterisk will sometimes be killed because it can't allocate
" Try to give excess memory back to the OS.\n"; * more than around 3G of memory on a 32 bit system.
return NULL; *
case CLI_GENERATE: * Using malloc_trim() will help us to determine if it's because there's a leak or because
return NULL; * the heap is so fragmented that there isn't enough contiguous memory available.
} *
* \note malloc_trim() is a GNU extension and is therefore not portable.
*/
static char *handle_cli_malloc_trim(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
extern int malloc_trim(size_t __pad) __THROW;
if (malloc_trim(0)) { switch (cmd) {
ast_cli(a->fd, "Returned some memory to the OS.\n"); case CLI_INIT:
} else { e->command = "malloc trim";
ast_cli(a->fd, "No memory returned to the OS.\n"); e->usage =
} "Usage: malloc trim\n"
" Try to give excess memory back to the OS.\n";
return CLI_SUCCESS; return NULL;
case CLI_GENERATE:
return NULL;
} }
if (malloc_trim(0)) {
ast_cli(a->fd, "Returned some memory to the OS.\n");
} else {
ast_cli(a->fd, "No memory returned to the OS.\n");
}
return CLI_SUCCESS;
}
#endif #endif
static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a); static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);