libexplain/mmap_or_die.c File Reference

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

Go to the source code of this file.

Functions
void *	explain_mmap_or_die (void *data, size_t data_size, int prot, int flags, int fildes, off_t offset)
void *	explain_mmap_on_error (void *data, size_t data_size, int prot, int flags, int fildes, off_t offset)

---

Function Documentation

void* explain_mmap_on_error	(	void *	data,
		size_t	data_size,
		int	prot,
		int	flags,
		int	fildes,
		off_t	offset
	)

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

Parameters:

data	The data, exactly as to be passed to the mmap(2) system call.
data_size	The data_size, exactly as to be passed to the mmap(2) system call.
prot	The prot, exactly as to be passed to the mmap(2) system call.
flags	The flags, exactly as to be passed to the mmap(2) system call.
fildes	The fildes, exactly as to be passed to the mmap(2) system call.
offset	The offset, exactly as to be passed to the mmap(2) system call.

Returns:

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

Example:

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

 void *result = explain_mmap_on_error(data, data_size, prot, flags, fildes,
     offset);
 if (!result)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 56 of file mmap_or_die.c.

void* explain_mmap_or_die	(	void *	data,
		size_t	data_size,
		int	prot,
		int	flags,
		int	fildes,
		off_t	offset
	)

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

Parameters:

data	The data, exactly as to be passed to the mmap(2) system call.
data_size	The data_size, exactly as to be passed to the mmap(2) system call.
prot	The prot, exactly as to be passed to the mmap(2) system call.
flags	The flags, exactly as to be passed to the mmap(2) system call.
fildes	The fildes, exactly as to be passed to the mmap(2) system call.
offset	The offset, exactly as to be passed to the mmap(2) system call.

Returns:

This function only returns on success, see mmap(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_mmap_or_die(data, data_size, prot, flags, fildes, offset);

Definition at line 27 of file mmap_or_die.c.