EPICS_base/epics-base
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

doc and log for *MustSucceed()

Browse Source 
Replace the "never returns NULL." statement which is
manifestly not true.
This commit is contained in:
Michael Davidsaver
2025-02-07 09:06:13 -08:00
parent 144f9756ea
commit 1d19ba4cc2
2 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
modules/libcom/src/misc/cantProceed.c
View File

@ -24,7 +24,7 @@ LIBCOM_API void * callocMustSucceed(size_t count, size_t size, const char *msg)
void * mem = NULL;
if (count > 0 && size > 0) {
while ((mem = calloc(count, size)) == NULL) {
errlogPrintf("%s: callocMustSucceed(%lu, %lu) - calloc failed\n",
errlogPrintf("%s: callocMustSucceed(%lu, %lu) - " ERL_ERROR " calloc failed\n",
msg, (unsigned long)count, (unsigned long)size);
errlogPrintf("Thread %s (%p) suspending.\n",
epicsThreadGetNameSelf(), (void *)epicsThreadGetIdSelf());
@ -40,7 +40,7 @@ LIBCOM_API void * mallocMustSucceed(size_t size, const char *msg)
void * mem = NULL;
if (size > 0) {
while ((mem = malloc(size)) == NULL) {
errlogPrintf("%s: mallocMustSucceed(%lu) - malloc failed\n",
errlogPrintf("%s: mallocMustSucceed(%lu) - " ERL_ERROR " malloc failed\n",
msg, (unsigned long)size);
errlogPrintf("Thread %s (%p) suspending.\n",
epicsThreadGetNameSelf(), (void *)epicsThreadGetIdSelf());

18
modules/libcom/src/misc/cantProceed.h
View File

@ -56,18 +56,24 @@ LIBCOM_API void cantProceed(
* gracefully when memory runs out.
*/
/** @{ */
/** \brief A calloc() that never returns NULL.
/** \brief A calloc() which suspends on error.
* \param count Number of objects.
* \param size Size of each object.
* \param errorMessage What this memory is needed for.
* \return Pointer to zeroed allocated memory.
* \param errorMessage Context added to logged error message
* \return Pointer to zeroed allocated memory. Should later be free() d
*
* Will always return NULL for a zero length allocation.
* Will never return NULL otherwise.
*/
LIBCOM_API void * callocMustSucceed(size_t count, size_t size,
const char *errorMessage);
/** \brief A malloc() that never returns NULL.
/** \brief A malloc() which suspends on error.
* \param size Size of block to allocate.
* \param errorMessage What this memory is needed for.
* \return Pointer to allocated memory.
* \param errorMessage Context added to logged error message
* \return Pointer to allocated memory. Should later be free() d
*
* Will always return NULL for a zero length allocation.
* Will never return NULL otherwise.
*/
LIBCOM_API void * mallocMustSucceed(size_t size, const char *errorMessage);
/** @} */