libexplain/munmap_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/sys/mman.h>
#include <libexplain/munmap.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
void	explain_munmap_or_die (void *data, size_t data_size)
int	explain_munmap_on_error (void *data, size_t data_size)

---

Function Documentation

int explain_munmap_on_error	(	void *	data,
		size_t	data_size
	)

The explain_munmap_on_error function is used to call the munmap(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_munmap(3) function.

Parameters:

data	The data, exactly as to be passed to the munmap(2) system call.
data_size	The data_size, exactly as to be passed to the munmap(2) system call.

Returns:

The value returned by the wrapped munmap(2) system call.

Example:

This function is intended to be used in a fashion similar to the following example:

 if (explain_munmap_on_error(data, data_size) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 37 of file munmap_or_die.c.

void explain_munmap_or_die	(	void *	data,
		size_t	data_size
	)

The explain_munmap_or_die function is used to call the munmap(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_munmap(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

Parameters:

data	The data, exactly as to be passed to the munmap(2) system call.
data_size	The data_size, exactly as to be passed to the munmap(2) system call.

Returns:

This function only returns on success, see munmap(2) for more information. On failure, prints an explanation and exits, it does not return.

Example:

This function is intended to be used in a fashion similar to the following example:

 explain_munmap_or_die(data, data_size);

Definition at line 27 of file munmap_or_die.c.