memory.h File Reference

Memory management wrappers. More...

#include <stddef.h>

Include dependency graph for memory.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	MAX(a, b)   (((a) < (b)) ? (b) : (a))
#define	MIN(a, b)   (((a) < (b)) ? (a) : (b))
#define	CLAMP(val, lo, hi)   MIN(hi, MAX(lo, val))
#define	ROUND_UP(NUM, STEP)   ((((NUM) + (STEP) -1) / (STEP)) * (STEP))
#define	mutt_array_size(x)   (sizeof(x) / sizeof((x)[0]))
#define	MUTT_MEM_CALLOC(n, type)   ((type *) mutt_mem_calloc(n, sizeof(type)))
#define	MUTT_MEM_MALLOC(n, type)   ((type *) mutt_mem_mallocarray(n, sizeof(type)))
#define	MUTT_MEM_REALLOC(pptr, n, type)
#define	FREE(x)   mutt_mem_free(x)

Functions
void *	mutt_mem_calloc (size_t nmemb, size_t size)
	Allocate zeroed memory on the heap.
void	mutt_mem_free (void *ptr)
	Release memory allocated on the heap.
void *	mutt_mem_malloc (size_t size)
	Allocate memory on the heap.
void *	mutt_mem_mallocarray (size_t nmemb, size_t size)
	Allocate memory on the heap (array version)
void	mutt_mem_realloc (void *pptr, size_t size)
	Resize a block of memory on the heap.
void	mutt_mem_reallocarray (void *pptr, size_t nmemb, size_t size)
	Resize a block of memory on the heap (array version)

Detailed Description

Memory management wrappers.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file memory.h.

Macro Definition Documentation

MAX

#define MAX	(		a,
			b
	)		(((a) < (b)) ? (b) : (a))

Definition at line 31 of file memory.h.

MIN

#define MIN	(		a,
			b
	)		(((a) < (b)) ? (a) : (b))

Definition at line 32 of file memory.h.

CLAMP

#define CLAMP	(		val,
			lo,
			hi
	)		MIN(hi, MAX(lo, val))

Definition at line 33 of file memory.h.

ROUND_UP

#define ROUND_UP	(		NUM,
			STEP
	)		((((NUM) + (STEP) -1) / (STEP)) * (STEP))

Definition at line 36 of file memory.h.

mutt_array_size

#define mutt_array_size

(

x

)

(sizeof(x) / sizeof((x)[0]))

Definition at line 38 of file memory.h.

MUTT_MEM_CALLOC

#define MUTT_MEM_CALLOC	(		n,
			type
	)		((type *) mutt_mem_calloc(n, sizeof(type)))

Definition at line 40 of file memory.h.

MUTT_MEM_MALLOC

#define MUTT_MEM_MALLOC	(		n,
			type
	)		((type *) mutt_mem_mallocarray(n, sizeof(type)))

Definition at line 41 of file memory.h.

MUTT_MEM_REALLOC

#define MUTT_MEM_REALLOC	(		pptr,
			n,
			type
	)

Value:

(                                                                             \
  _Generic(*(pptr), type *: mutt_mem_reallocarray(pptr, n, sizeof(type)))     \
)

Definition at line 43 of file memory.h.

FREE

#define FREE

(

x

)

mutt_mem_free(x)

Definition at line 55 of file memory.h.

Function Documentation

mutt_mem_calloc()

void * mutt_mem_calloc	(	size_t	nmemb,
		size_t	size
	)

Allocate zeroed memory on the heap.

Parameters

nmemb	Number of blocks
size	Size of blocks

Return values

ptr	Memory on the heap

Note

On error, this function will never return NULL. It will print an error and exit the program.

The caller should call mutt_mem_free() to release the memory

Definition at line 76 of file memory.c.

{
  if ((nmemb == 0) || (size == 0))
    return NULL;
 
  void *p = calloc(nmemb, size);
  if (!p)
  {
    mutt_error("%s", strerror(errno)); // LCOV_EXCL_LINE
    mutt_exit(1);                      // LCOV_EXCL_LINE
  }
  return p;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_mem_free()

void mutt_mem_free

(

void *

ptr

)

Release memory allocated on the heap.

Parameters

ptr	Memory to release

Definition at line 94 of file memory.c.

{
  if (!ptr)
    return;
  void **p = (void **) ptr;
  free(*p);
  *p = NULL;
}

mutt_mem_malloc()

void * mutt_mem_malloc

(

size_t

size

)

Allocate memory on the heap.

Parameters

size	Size of block to allocate

Return values

ptr	Memory on the heap

Note

On error, this function will never return NULL. It will print an error and exit the program.

The caller should call mutt_mem_free() to release the memory

Definition at line 113 of file memory.c.

{
  return mutt_mem_mallocarray(size, 1);
}

Here is the call graph for this function:

mutt_mem_mallocarray()

void * mutt_mem_mallocarray	(	size_t	nmemb,
		size_t	size
	)

Allocate memory on the heap (array version)

Parameters

nmemb	Number of blocks
size	Size of blocks

Return values

ptr	Memory on the heap

Note

On error, this function will never return NULL. It will print an error and exit the program.

The caller should call mutt_mem_free() to release the memory

Definition at line 129 of file memory.c.

{
  void *p = NULL;
  mutt_mem_reallocarray(&p, nmemb, size);
  return p;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_mem_realloc()

void mutt_mem_realloc	(	void *	pptr,
		size_t	size
	)

Resize a block of memory on the heap.

Parameters

pptr	Address of pointer to memory block to resize
size	New size

Note

On error, this function will never return NULL. It will print an error and exit the program.

If the new size is zero, the block will be freed.

Definition at line 146 of file memory.c.

{
  mutt_mem_reallocarray(pptr, size, 1);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_mem_reallocarray()

void mutt_mem_reallocarray	(	void *	pptr,
		size_t	nmemb,
		size_t	size
	)

Resize a block of memory on the heap (array version)

Parameters

pptr	Address of pointer to memory block to resize
nmemb	Number of blocks
size	Size of blocks

Note

On error, this function will never return NULL. It will print an error and exit the program.

If the new size is zero, the block will be freed.

Definition at line 162 of file memory.c.

{
  if (!pptr)
    return;
 
  void **pp = (void **) pptr;
 
  if ((nmemb == 0) || (size == 0))
  {
    free(*pp);
    *pp = NULL;
    return;
  }
 
  void *r = reallocarray(*pp, nmemb, size);
  if (!r)
  {
    mutt_error("%s", strerror(errno)); // LCOV_EXCL_LINE
    mutt_exit(1);                      // LCOV_EXCL_LINE
  }
 
  *pp = r;
}

Here is the call graph for this function:

Here is the caller graph for this function: