From: Florian Krohm Date: Sat, 13 Sep 2014 22:31:13 +0000 (+0000) Subject: Document the NULL-ness of the return values of HT_construct and HT_to_array. X-Git-Tag: svn/VALGRIND_3_11_0~1000 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a51a7bb1db03010702cf362c5337e2ee2e0a4c8f;p=thirdparty%2Fvalgrind.git Document the NULL-ness of the return values of HT_construct and HT_to_array. Audit call sites. git-svn-id: svn://svn.valgrind.org/valgrind/trunk@14532 --- diff --git a/drd/drd_malloc_wrappers.c b/drd/drd_malloc_wrappers.c index 4e1cfc279d..0f9896467e 100644 --- a/drd/drd_malloc_wrappers.c +++ b/drd/drd_malloc_wrappers.c @@ -293,7 +293,6 @@ void DRD_(register_malloc_wrappers)(const StartUsingMem start_callback, { tl_assert(s_malloc_list == 0); s_malloc_list = VG_(HT_construct)("drd_malloc_list"); - tl_assert(s_malloc_list); tl_assert(start_callback); tl_assert(stop_callback); diff --git a/include/pub_tool_hashtable.h b/include/pub_tool_hashtable.h index d640c39e47..21dd0b234a 100644 --- a/include/pub_tool_hashtable.h +++ b/include/pub_tool_hashtable.h @@ -54,7 +54,7 @@ typedef struct _VgHashTable * VgHashTable; /* Make a new table. Allocates the memory with VG_(calloc)(), so can be freed with VG_(free)(). The table starts small but will periodically be expanded. This is transparent to the users of this - module. */ + module. The function never returns NULL. */ extern VgHashTable VG_(HT_construct) ( const HChar* name ); /* Count the number of nodes in a table. */ @@ -95,7 +95,8 @@ extern void VG_(HT_print_stats) ( VgHashTable table, HT_Cmp_t cmp ); /* Allocates a suitably-sized array, copies pointers to all the hashtable elements into it, then returns both the array and the size of it. The - array must be freed with VG_(free). */ + array must be freed with VG_(free). If the hashtable is empty, the + function returns NULL and assigns *nelems = 0. */ extern VgHashNode** VG_(HT_to_array) ( VgHashTable t, /*OUT*/ UInt* n_elems ); /* Reset the table's iterator to point to the first element. */