Merged revisions 144924-144925 via svnmerge from
[asterisk/asterisk.git] / main / astmm.c
index 4c3f5ca..4659d5b 100644 (file)
  * \author Mark Spencer <markster@digium.com>
  */
 
-#ifdef __AST_DEBUG_MALLOC
-
 #include "asterisk.h"
 
+#ifdef __AST_DEBUG_MALLOC
+
 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
-#include <stdio.h>
-#include <string.h>
+#include "asterisk/paths.h"    /* use ast_config_AST_LOG_DIR */
+#include <stddef.h>
 #include <time.h>
 
 #include "asterisk/cli.h"
-#include "asterisk/logger.h"
-#include "asterisk/options.h"
 #include "asterisk/lock.h"
 #include "asterisk/strings.h"
 #include "asterisk/unaligned.h"
@@ -66,23 +64,36 @@ enum func_type {
 
 static FILE *mmlog;
 
+/* NOTE: Be EXTREMELY careful with modifying this structure; the total size of this structure
+   must result in 'automatic' alignment so that the 'fence' field lands exactly at the end of
+   the structure in memory (and thus immediately before the allocated region the fence is
+   supposed to be used to monitor). In other words, we cannot allow the compiler to insert
+   any padding between this structure and anything following it, so add up the sizes of all the
+   fields and compare to sizeof(struct ast_region)... if they don't match, then the compiler
+   is padding the structure and either the fields need to be rearranged to eliminate internal
+   padding, or a dummy field will need to be inserted before the 'fence' field to push it to
+   the end of the actual space it will consume. Note that this must be checked for both 32-bit
+   and 64-bit platforms, as the sizes of pointers and 'size_t' differ on these platforms.
+*/
+
 static struct ast_region {
        struct ast_region *next;
-       char file[40];
+       size_t len;
+       char file[64];
        char func[40];
        unsigned int lineno;
        enum func_type which;
        unsigned int cache;             /* region was allocated as part of a cache pool */
-       size_t len;
        unsigned int fence;
        unsigned char data[0];
 } *regions[SOME_PRIME];
 
 #define HASH(a) \
        (((unsigned long)(a)) % SOME_PRIME)
-       
-AST_MUTEX_DEFINE_STATIC(reglock);
-AST_MUTEX_DEFINE_STATIC(showmemorylock);
+
+/*! Tracking this mutex will cause infinite recursion, as the mutex tracking
+ *  code allocates memory */
+AST_MUTEX_DEFINE_STATIC_NOTRACKING(reglock);
 
 #define astmm_log(...)                               \
        do {                                         \
@@ -145,10 +156,15 @@ static inline size_t __ast_sizeof_region(void *ptr)
 
 static void __ast_free_region(void *ptr, const char *file, int lineno, const char *func)
 {
-       int hash = HASH(ptr);
+       int hash;
        struct ast_region *reg, *prev = NULL;
        unsigned int *fence;
 
+       if (!ptr)
+               return;
+
+       hash = HASH(ptr);
+
        ast_mutex_lock(&reglock);
        for (reg = regions[hash]; reg; reg = reg->next) {
                if (reg->data == ptr) {
@@ -305,7 +321,7 @@ int __ast_vasprintf(char **strp, const char *fmt, va_list ap, const char *file,
        return size;
 }
 
-static int handle_show_memory(int fd, int argc, char *argv[])
+static char *handle_memory_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 {
        char *fn = NULL;
        struct ast_region *reg;
@@ -315,10 +331,23 @@ static int handle_show_memory(int fd, int argc, char *argv[])
        unsigned int count = 0;
        unsigned int *fence;
 
-       if (argc > 3)
-               fn = argv[3];
+       switch (cmd) {
+       case CLI_INIT:
+               e->command = "memory show allocations";
+               e->usage =
+                       "Usage: memory show allocations [<file>]\n"
+                       "       Dumps a list of all segments of allocated memory, optionally\n"
+                       "       limited to those from a specific file\n";
+               return NULL;
+       case CLI_GENERATE:
+               return NULL;
+       }
+
+
+       if (a->argc > 3)
+               fn = a->argv[3];
 
-       ast_mutex_lock(&showmemorylock);
+       ast_mutex_lock(&reglock);
        for (x = 0; x < SOME_PRIME; x++) {
                for (reg = regions[x]; reg; reg = reg->next) {
                        if (!fn || !strcasecmp(fn, reg->file) || !strcasecmp(fn, "anomolies")) {
@@ -334,7 +363,7 @@ static int handle_show_memory(int fd, int argc, char *argv[])
                                }
                        }
                        if (!fn || !strcasecmp(fn, reg->file)) {
-                               ast_cli(fd, "%10d bytes allocated%s in %20s at line %5d of %s\n", 
+                               ast_cli(a->fd, "%10d bytes allocated%s in %20s at line %5d of %s\n", 
                                        (int) reg->len, reg->cache ? " (cache)" : "", 
                                        reg->func, reg->lineno, reg->file);
                                len += reg->len;
@@ -344,17 +373,17 @@ static int handle_show_memory(int fd, int argc, char *argv[])
                        }
                }
        }
-       ast_mutex_unlock(&showmemorylock);
+       ast_mutex_unlock(&reglock);
        
        if (cache_len)
-               ast_cli(fd, "%d bytes allocated (%d in caches) in %d allocations\n", len, cache_len, count);
+               ast_cli(a->fd, "%d bytes allocated (%d in caches) in %d allocations\n", len, cache_len, count);
        else
-               ast_cli(fd, "%d bytes allocated in %d allocations\n", len, count);
+               ast_cli(a->fd, "%d bytes allocated in %d allocations\n", len, count);
        
-       return RESULT_SUCCESS;
+       return CLI_SUCCESS;
 }
 
-static int handle_show_memory_summary(int fd, int argc, char *argv[])
+static char *handle_memory_show_summary(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 {
        char *fn = NULL;
        int x;
@@ -370,8 +399,20 @@ static int handle_show_memory_summary(int fd, int argc, char *argv[])
                struct file_summary *next;
        } *list = NULL, *cur;
        
-       if (argc > 3) 
-               fn = argv[3];
+       switch (cmd) {
+       case CLI_INIT:
+               e->command = "memory show summary";
+               e->usage =
+                       "Usage: memory show summary [<file>]\n"
+                       "       Summarizes heap memory allocations by file, or optionally\n"
+                       "by function, if a file is specified\n";
+               return NULL;
+       case CLI_GENERATE:
+               return NULL;
+       }
+
+       if (a->argc > 3) 
+               fn = a->argv[3];
 
        ast_mutex_lock(&reglock);
        for (x = 0; x < SOME_PRIME; x++) {
@@ -406,64 +447,53 @@ static int handle_show_memory_summary(int fd, int argc, char *argv[])
                count += cur->count;
                if (cur->cache_len) {
                        if (fn) {
-                               ast_cli(fd, "%10d bytes (%10d cache) in %d allocations in function '%s' of '%s'\n", 
+                               ast_cli(a->fd, "%10d bytes (%10d cache) in %d allocations in function '%s' of '%s'\n", 
                                        cur->len, cur->cache_len, cur->count, cur->fn, fn);
                        } else {
-                               ast_cli(fd, "%10d bytes (%10d cache) in %d allocations in file '%s'\n", 
+                               ast_cli(a->fd, "%10d bytes (%10d cache) in %d allocations in file '%s'\n", 
                                        cur->len, cur->cache_len, cur->count, cur->fn);
                        }
                } else {
                        if (fn) {
-                               ast_cli(fd, "%10d bytes in %d allocations in function '%s' of '%s'\n", 
+                               ast_cli(a->fd, "%10d bytes in %d allocations in function '%s' of '%s'\n", 
                                        cur->len, cur->count, cur->fn, fn);
                        } else {
-                               ast_cli(fd, "%10d bytes in %d allocations in file '%s'\n", 
+                               ast_cli(a->fd, "%10d bytes in %d allocations in file '%s'\n", 
                                        cur->len, cur->count, cur->fn);
                        }
                }
        }
 
        if (cache_len)
-               ast_cli(fd, "%d bytes allocated (%d in caches) in %d allocations\n", len, cache_len, count);
+               ast_cli(a->fd, "%d bytes allocated (%d in caches) in %d allocations\n", len, cache_len, count);
        else
-               ast_cli(fd, "%d bytes allocated in %d allocations\n", len, count);
+               ast_cli(a->fd, "%d bytes allocated in %d allocations\n", len, count);
 
-       return RESULT_SUCCESS;
+       return CLI_SUCCESS;
 }
 
-static char show_memory_help[] = 
-"Usage: memory show allocations [<file>]\n"
-"       Dumps a list of all segments of allocated memory, optionally\n"
-"limited to those from a specific file\n";
-
-static char show_memory_summary_help[] = 
-"Usage: memory show summary [<file>]\n"
-"       Summarizes heap memory allocations by file, or optionally\n"
-"by function, if a file is specified\n";
-
 static struct ast_cli_entry cli_memory[] = {
-       { { "memory", "show", "allocations", NULL },
-       handle_show_memory, "Display outstanding memory allocations",
-       show_memory_help },
-
-       { { "memory", "show", "summary", NULL },
-       handle_show_memory_summary, "Summarize outstanding memory allocations",
-       show_memory_summary_help },
+       AST_CLI_DEFINE(handle_memory_show, "Display outstanding memory allocations"),
+       AST_CLI_DEFINE(handle_memory_show_summary, "Summarize outstanding memory allocations"),
 };
 
 void __ast_mm_init(void)
 {
        char filename[PATH_MAX];
+       size_t pad = sizeof(struct ast_region) - offsetof(struct ast_region, data);
+
+       if (pad) {
+               ast_log(LOG_ERROR, "struct ast_region has %d bytes of padding! This must be eliminated for low-fence checking to work properly!\n", (int) pad);
+       }
 
        ast_cli_register_multiple(cli_memory, sizeof(cli_memory) / sizeof(struct ast_cli_entry));
        
-       snprintf(filename, sizeof(filename), "%s/mmlog", (char *)ast_config_AST_LOG_DIR);
+       snprintf(filename, sizeof(filename), "%s/mmlog", ast_config_AST_LOG_DIR);
        
-       if (option_verbose)
-               ast_verbose("Asterisk Malloc Debugger Started (see %s))\n", filename);
+       ast_verb(1, "Asterisk Malloc Debugger Started (see %s))\n", filename);
        
        if ((mmlog = fopen(filename, "a+"))) {
-               fprintf(mmlog, "%ld - New session\n", time(NULL));
+               fprintf(mmlog, "%ld - New session\n", (long)time(NULL));
                fflush(mmlog);
        }
 }