diff options
-rw-r--r-- | build_tools/cflags.xml | 2 | ||||
-rw-r--r-- | include/asterisk.h | 1 | ||||
-rw-r--r-- | include/asterisk/strings.h | 10 | ||||
-rw-r--r-- | include/asterisk/threadstorage.h | 70 | ||||
-rw-r--r-- | main/Makefile | 2 | ||||
-rw-r--r-- | main/asterisk.c | 3 | ||||
-rw-r--r-- | main/threadstorage.c | 227 |
7 files changed, 302 insertions, 13 deletions
diff --git a/build_tools/cflags.xml b/build_tools/cflags.xml index 7c2fbddff..994c96203 100644 --- a/build_tools/cflags.xml +++ b/build_tools/cflags.xml @@ -5,6 +5,8 @@ </member> <member name="DEBUG_THREADS" displayname="Enable Thread Debugging"> </member> + <member name="DEBUG_THREADLOCALS" displayname="Enable Thread-Local-Storage Debugging"> + </member> <member name="DETECT_DEADLOCKS" displayname="Detect Deadlocks"> </member> <member name="DO_CRASH" displayname="Crash on fatal errors"> diff --git a/include/asterisk.h b/include/asterisk.h index 7bbb75f3a..52db3b91f 100644 --- a/include/asterisk.h +++ b/include/asterisk.h @@ -81,6 +81,7 @@ void ast_builtins_init(void); /*!< Provided by cli.c */ int dnsmgr_init(void); /*!< Provided by dnsmgr.c */ void dnsmgr_start_refresh(void); /*!< Provided by dnsmgr.c */ int dnsmgr_reload(void); /*!< Provided by dnsmgr.c */ +void threadstorage_init(void); /*!< Provided by threadstorage.c */ /* Many headers need 'ast_channel' to be defined */ struct ast_channel; diff --git a/include/asterisk/strings.h b/include/asterisk/strings.h index f79e9b2fe..53486d1b0 100644 --- a/include/asterisk/strings.h +++ b/include/asterisk/strings.h @@ -365,6 +365,10 @@ void ast_str_reset(struct ast_str *buf), AST_INLINE_API( int ast_str_make_space(struct ast_str **buf, size_t new_len), { +#if defined(DEBUG_THREADLOCALS) + struct ast_str *old_buf = *buf; +#endif /* defined(DEBUG_THREADLOCALS) */ + if (new_len <= (*buf)->len) return 0; /* success */ if ((*buf)->ts == DS_ALLOCA || (*buf)->ts == DS_STATIC) @@ -372,8 +376,12 @@ int ast_str_make_space(struct ast_str **buf, size_t new_len), *buf = (struct ast_str *)ast_realloc(*buf, new_len + sizeof(struct ast_str)); if (*buf == NULL) /* XXX watch out, we leak memory here */ return -1; - if ((*buf)->ts != DS_MALLOC) + if ((*buf)->ts != DS_MALLOC) { pthread_setspecific((*buf)->ts->key, *buf); +#if defined(DEBUG_THREADLOCALS) + __ast_threadstorage_object_replace(old_buf, *buf, new_len + sizeof(struct ast_str)); +#endif /* defined(DEBUG_THREADLOCALS) */ + } (*buf)->len = new_len; return 0; diff --git a/include/asterisk/threadstorage.h b/include/asterisk/threadstorage.h index 469f46389..442101113 100644 --- a/include/asterisk/threadstorage.h +++ b/include/asterisk/threadstorage.h @@ -62,6 +62,12 @@ struct ast_threadstorage { int (*custom_init)(void *); /*!< Custom initialization function specific to the object */ }; +#if defined(DEBUG_THREADLOCALS) +void __ast_threadstorage_object_add(void *key, size_t len, const char *file, const char *function, unsigned int line); +void __ast_threadstorage_object_remove(void *key); +void __ast_threadstorage_object_replace(void *key_old, void *key_new, size_t len); +#endif /* defined(DEBUG_THREADLOCALS) */ + /*! * \brief Define a thread storage variable * @@ -93,17 +99,36 @@ struct ast_threadstorage { * AST_THREADSTORAGE_CUSTOM(my_buf, my_init, my_cleanup); * \endcode */ -#define AST_THREADSTORAGE_CUSTOM(name, c_init, c_cleanup) \ -static void init_##name(void); \ -static struct ast_threadstorage name = { \ - .once = PTHREAD_ONCE_INIT, \ - .key_init = init_##name, \ - .custom_init = c_init, \ -}; \ -static void init_##name(void) \ -{ \ - pthread_key_create(&(name).key, c_cleanup); \ +#if !defined(DEBUG_THREADLOCALS) +#define AST_THREADSTORAGE_CUSTOM(name, c_init, c_cleanup) \ +static void __init_##name(void); \ +static struct ast_threadstorage name = { \ + .once = PTHREAD_ONCE_INIT, \ + .key_init = __init_##name, \ + .custom_init = c_init, \ +}; \ +static void __init_##name(void) \ +{ \ + pthread_key_create(&(name).key, c_cleanup); \ +} +#else /* defined(DEBUG_THREADLOCALS) */ +#define AST_THREADSTORAGE_CUSTOM(name, c_init, c_cleanup) \ +static void __init_##name(void); \ +static struct ast_threadstorage name = { \ + .once = PTHREAD_ONCE_INIT, \ + .key_init = __init_##name, \ + .custom_init = c_init, \ +}; \ +static void __cleanup_##name(void *data) \ +{ \ + __ast_threadstorage_object_remove(data); \ + c_cleanup(data); \ +} \ +static void __init_##name(void) \ +{ \ + pthread_key_create(&(name).key, __cleanup_##name); \ } +#endif /* defined(DEBUG_THREADLOCALS) */ /*! * \brief Retrieve thread storage @@ -135,6 +160,7 @@ static void init_##name(void) \ * } * \endcode */ +#if !defined(DEBUG_THREADLOCALS) AST_INLINE_API( void *ast_threadstorage_get(struct ast_threadstorage *ts, size_t init_size), { @@ -154,7 +180,29 @@ void *ast_threadstorage_get(struct ast_threadstorage *ts, size_t init_size), return buf; } ) +#else /* defined(DEBUG_THREADLOCALS) */ +AST_INLINE_API( +void *__ast_threadstorage_get(struct ast_threadstorage *ts, size_t init_size), +{ + void *buf; + + pthread_once(&ts->once, ts->key_init); + if (!(buf = pthread_getspecific(ts->key))) { + if (!(buf = ast_calloc(1, init_size))) + return NULL; + if (ts->custom_init && ts->custom_init(buf)) { + free(buf); + return NULL; + } + pthread_setspecific(ts->key, buf); + __ast_threadstorage_object_add(buf, init_size, file, function, line); + } + + return buf; +} +) -void __ast_threadstorage_cleanup(void *); +#define ast_threadstorage_get(ts, init_size) __ast_threadstorage_get(ts, init_size, __FILE__, __PRETTY_FUNCTION__, __LINE__) +#endif /* defined(DEBUG_THREADLOCALS) */ #endif /* ASTERISK_THREADSTORAGE_H */ diff --git a/main/Makefile b/main/Makefile index e35df85b2..1430fc045 100644 --- a/main/Makefile +++ b/main/Makefile @@ -26,7 +26,7 @@ OBJS= io.o sched.o logger.o frame.o loader.o config.o channel.o \ utils.o plc.o jitterbuf.o dnsmgr.o devicestate.o \ netsock.o slinfactory.o ast_expr2.o ast_expr2f.o \ cryptostub.o sha1.o http.o fixedjitterbuf.o abstract_jb.o \ - strcompat.o + strcompat.o threadstorage.o # we need to link in the objects statically, not as a library, because # otherwise modules will not have them available if none of the static diff --git a/main/asterisk.c b/main/asterisk.c index db085a07e..cc147f13f 100644 --- a/main/asterisk.c +++ b/main/asterisk.c @@ -2686,6 +2686,9 @@ int main(int argc, char *argv[]) printf(term_quit()); exit(1); } + + threadstorage_init(); + if (load_modules(1)) { /* Load modules */ printf(term_quit()); exit(1); diff --git a/main/threadstorage.c b/main/threadstorage.c new file mode 100644 index 000000000..b4d38c045 --- /dev/null +++ b/main/threadstorage.c @@ -0,0 +1,227 @@ +/* + * Asterisk -- An open source telephony toolkit. + * + * Copyright (C) 1999 - 2005, Digium, Inc. + * + * Kevin P. Fleming <kpfleming@digium.com> + * + * See http://www.asterisk.org for more information about + * the Asterisk project. Please do not directly contact + * any of the maintainers of this project for assistance; + * the project provides a web site, mailing lists and IRC + * channels for your use. + * + * This program is free software, distributed under the terms of + * the GNU General Public License Version 2. See the LICENSE file + * at the top of the source tree. + */ + +/*! \file + * + * \brief Debugging support for thread-local-storage objects + * + * \author Kevin P. Fleming <kpfleming@digium.com> + */ + +#include "asterisk.h" + +#if defined(DEBUG_THREADLOCALS) + +ASTERISK_FILE_VERSION(__FILE__, "$Revision$") + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> + +#include "asterisk/logger.h" +#include "asterisk/strings.h" +#include "asterisk/utils.h" +#include "asterisk/threadstorage.h" +#include "asterisk/linkedlists.h" +#include "asterisk/cli.h" + +struct tls_object { + void *key; + size_t size; + const char *file; + const char *function; + unsigned int line; + pthread_t thread; + AST_LIST_ENTRY(tls_object) entry; +}; + +static AST_LIST_HEAD_STATIC(tls_objects, tls_object); + +void __ast_threadstorage_object_add(void *key, size_t len, const char *file, const char *function, unsigned int line) +{ + struct tls_object *to; + + if (!(to = ast_calloc(sizeof(*to), 1))) + return; + + to->key = key; + to->size = len; + to->file = file; + to->function = function; + to->line = line; + to->thread = pthread_self(); + + AST_LIST_LOCK(&tls_objects); + AST_LIST_INSERT_TAIL(&tls_objects, to, entry); + AST_LIST_UNLOCK(&tls_objects); +} + +void __ast_threadstorage_object_remove(void *key) +{ + struct tls_object *to; + + AST_LIST_LOCK(&tls_objects); + AST_LIST_TRAVERSE_SAFE_BEGIN(&tls_objects, to, entry) { + if (to->key == key) { + AST_LIST_REMOVE_CURRENT(&tls_objects, entry); + break; + } + } + AST_LIST_TRAVERSE_SAFE_END; + AST_LIST_UNLOCK(&tls_objects); + if (to) + free(to); +} + +void __ast_threadstorage_object_replace(void *key_old, void *key_new, size_t len) +{ + struct tls_object *to; + + AST_LIST_LOCK(&tls_objects); + AST_LIST_TRAVERSE_SAFE_BEGIN(&tls_objects, to, entry) { + if (to->key == key_old) { + to->key = key_new; + to->size = len; + break; + } + } + AST_LIST_TRAVERSE_SAFE_END; + AST_LIST_UNLOCK(&tls_objects); +} + +static int handle_show_allocations(int fd, int argc, char *argv[]) +{ + char *fn = NULL; + size_t len = 0; + unsigned int count = 0; + struct tls_object *to; + + if (argc > 3) + fn = argv[3]; + + AST_LIST_LOCK(&tls_objects); + + AST_LIST_TRAVERSE(&tls_objects, to, entry) { + if (fn && strcasecmp(to->file, fn)) + continue; + + ast_cli(fd, "%10d bytes allocated in %20s at line %5d of %25s (thread %p)\n", + (int) to->size, to->function, to->line, to->file, (void *) to->thread); + len += to->size; + count++; + } + + AST_LIST_UNLOCK(&tls_objects); + + ast_cli(fd, "%10d bytes allocated in %d allocation%s\n", (int) len, count, count > 1 ? "s" : ""); + + return RESULT_SUCCESS; +} + +static int handle_show_summary(int fd, int argc, char *argv[]) +{ + char *fn = NULL; + size_t len = 0; + unsigned int count = 0; + struct tls_object *to; + struct file { + const char *name; + size_t len; + unsigned int count; + AST_LIST_ENTRY(file) entry; + } *file; + AST_LIST_HEAD_NOLOCK_STATIC(file_summary, file); + + if (argc > 3) + fn = argv[3]; + + AST_LIST_LOCK(&tls_objects); + + AST_LIST_TRAVERSE(&tls_objects, to, entry) { + if (fn && strcasecmp(to->file, fn)) + continue; + + AST_LIST_TRAVERSE(&file_summary, file, entry) { + if ((!fn && (file->name == to->file)) || (fn && (file->name == to->function))) + break; + } + + if (!file) { + file = alloca(sizeof(*file)); + memset(file, 0, sizeof(*file)); + file->name = fn ? to->function : to->file; + AST_LIST_INSERT_TAIL(&file_summary, file, entry); + } + + file->len += to->size; + file->count++; + } + + AST_LIST_UNLOCK(&tls_objects); + + AST_LIST_TRAVERSE(&file_summary, file, entry) { + len += file->len; + count += file->count; + if (fn) { + ast_cli(fd, "%10d bytes in %d allocation%ss in function %s\n", + (int) file->len, file->count, file->count > 1 ? "s" : "", file->name); + } else { + ast_cli(fd, "%10d bytes in %d allocation%s in file %s\n", + (int) file->len, file->count, file->count > 1 ? "s" : "", file->name); + } + } + + ast_cli(fd, "%10d bytes allocated in %d allocation%s\n", (int) len, count, count > 1 ? "s" : ""); + + return RESULT_SUCCESS; +} + +static struct ast_cli_entry cli[] = { + { + .cmda = { "threadstorage", "show", "allocations", NULL }, + .handler = handle_show_allocations, + .summary = "Display outstanding thread local storage allocations", + .usage = + "Usage: threadstorage show allocations [<file>]\n" + " Dumps a list of all thread-specific memory allocations,\n" + "optionally limited to those from a specific file\n", + }, + { + .cmda = { "threadstorage", "show", "summary", NULL }, + .handler = handle_show_summary, + .summary = "Summarize outstanding memory allocations", + .usage = + "Usage: threadstorage show summary [<file>]\n" + " Summarizes thread-specific memory allocations by file, or optionally\n" + "by function, if a file is specified\n", + }, +}; + +void threadstorage_init(void) +{ + ast_cli_register_multiple(cli, sizeof(cli) / sizeof(cli[0])); +} + +#else /* !defined(DEBUG_THREADLOCALS) */ + +void threadstorage_init(void) +{ +} + +#endif /* !defined(DEBUG_THREADLOCALS) */ + |