cuberite/libevent
1
0
Fork 0
mirror of https://github.com/cuberite/libevent.git synced 2025-09-10 04:50:37 -04:00
Code Issues Packages Projects Releases Wiki Activity

Catch attempts to enable debug_mode too late

Browse Source 
Debug mode needs to be enabled before any event is setup or any
event_base is created.  Otherwise, we will not have recorded when events
were first setup or added, and so it will look like a bug later when we
delete or free them.

I have already confused myself because of this requirement, so let's
make Libevent catch it for the next poor forgetful developer like me.
This commit is contained in:
Nick Mathewson 2010-04-28 12:03:08 -04:00
parent cb6707405c
commit 9ecf0d486d
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
event.c
View File

@ -178,6 +178,8 @@ eq_debug_entry(const struct event_debug_entry *a,
} }
int _event_debug_mode_on = 0; int _event_debug_mode_on = 0;
/* Set if it's too late to enable event_debug_mode. */
static int event_debug_mode_too_late = 0;
static void *_event_debug_map_lock = NULL; static void *_event_debug_map_lock = NULL;
static HT_HEAD(event_debug_map, event_debug_entry) global_debug_map = static HT_HEAD(event_debug_map, event_debug_entry) global_debug_map =
HT_INITIALIZER(); HT_INITIALIZER();
@ -207,6 +209,7 @@ HT_GENERATE(event_debug_map, event_debug_entry, node, hash_debug_entry,
} \ } \
EVLOCK_UNLOCK(_event_debug_map_lock, 0); \ EVLOCK_UNLOCK(_event_debug_map_lock, 0); \
} \ } \
event_debug_mode_too_late = 1; \
} while (0) } while (0)
/* Macro: record that ev is no longer setup */ /* Macro: record that ev is no longer setup */
#define _event_debug_note_teardown(ev) do { \ #define _event_debug_note_teardown(ev) do { \
@ -219,6 +222,7 @@ HT_GENERATE(event_debug_map, event_debug_entry, node, hash_debug_entry,
mm_free(dent); \ mm_free(dent); \
EVLOCK_UNLOCK(_event_debug_map_lock, 0); \ EVLOCK_UNLOCK(_event_debug_map_lock, 0); \
} \ } \
event_debug_mode_too_late = 1; \
} while (0) } while (0)
/* Macro: record that ev is now added */ /* Macro: record that ev is now added */
#define _event_debug_note_add(ev) do { \ #define _event_debug_note_add(ev) do { \
@ -236,6 +240,7 @@ HT_GENERATE(event_debug_map, event_debug_entry, node, hash_debug_entry,
} \ } \
EVLOCK_UNLOCK(_event_debug_map_lock, 0); \ EVLOCK_UNLOCK(_event_debug_map_lock, 0); \
} \ } \
event_debug_mode_too_late = 1; \
} while (0) } while (0)
/* Macro: record that ev is no longer added */ /* Macro: record that ev is no longer added */
#define _event_debug_note_del(ev) do { \ #define _event_debug_note_del(ev) do { \
@ -253,6 +258,7 @@ HT_GENERATE(event_debug_map, event_debug_entry, node, hash_debug_entry,
} \ } \
EVLOCK_UNLOCK(_event_debug_map_lock, 0); \ EVLOCK_UNLOCK(_event_debug_map_lock, 0); \
} \ } \
event_debug_mode_too_late = 1; \
} while (0) } while (0)
/* Macro: assert that ev is setup (i.e., okay to add or inspect) */ /* Macro: assert that ev is setup (i.e., okay to add or inspect) */
#define _event_debug_assert_is_setup(ev) do { \ #define _event_debug_assert_is_setup(ev) do { \
@ -285,7 +291,6 @@ HT_GENERATE(event_debug_map, event_debug_entry, node, hash_debug_entry,
EVLOCK_UNLOCK(_event_debug_map_lock, 0); \ EVLOCK_UNLOCK(_event_debug_map_lock, 0); \
} \ } \
} while (0) } while (0)
#else #else
#define _event_debug_note_setup(ev) \ #define _event_debug_note_setup(ev) \
((void)0) ((void)0)
@ -479,6 +484,9 @@ event_enable_debug_mode(void)
#ifndef _EVENT_DISABLE_DEBUG_MODE #ifndef _EVENT_DISABLE_DEBUG_MODE
if (_event_debug_mode_on) if (_event_debug_mode_on)
event_errx(1, "%s was called twice!", __func__); event_errx(1, "%s was called twice!", __func__);
if (event_debug_mode_too_late)
event_errx(1, "%s must be called *before* creating any events "
"or event_bases",__func__);
_event_debug_mode_on = 1; _event_debug_mode_on = 1;
@ -513,6 +521,7 @@ event_base_new_with_config(const struct event_config *cfg)
int should_check_environment; int should_check_environment;
#ifndef _EVENT_DISABLE_DEBUG_MODE #ifndef _EVENT_DISABLE_DEBUG_MODE
event_debug_mode_too_late = 1;
if (_event_debug_mode_on && !_event_debug_map_lock) { if (_event_debug_mode_on && !_event_debug_map_lock) {
EVTHREAD_ALLOC_LOCK(_event_debug_map_lock, 0); EVTHREAD_ALLOC_LOCK(_event_debug_map_lock, 0);
} }