libexplain  1.4.D001
Functions
libexplain/buffer/errno/mmap.c File Reference
#include <libexplain/ac/errno.h>
#include <libexplain/ac/fcntl.h>
#include <libexplain/ac/sys/mman.h>
#include <libexplain/ac/sys/resource.h>
#include <libexplain/ac/sys/stat.h>
#include <libexplain/buffer/eacces.h>
#include <libexplain/buffer/eagain.h>
#include <libexplain/buffer/ebadf.h>
#include <libexplain/buffer/einval.h>
#include <libexplain/buffer/enfile.h>
#include <libexplain/buffer/enodev.h>
#include <libexplain/buffer/enomem.h>
#include <libexplain/buffer/eperm.h>
#include <libexplain/buffer/errno/generic.h>
#include <libexplain/buffer/errno/mmap.h>
#include <libexplain/buffer/etxtbsy.h>
#include <libexplain/buffer/fildes.h>
#include <libexplain/buffer/gettext.h>
#include <libexplain/buffer/int.h>
#include <libexplain/buffer/mmap_flags.h>
#include <libexplain/buffer/mmap_prot.h>
#include <libexplain/buffer/mount_point.h>
#include <libexplain/buffer/must_be_multiple_of_page_size.h>
#include <libexplain/buffer/off_t.h>
#include <libexplain/buffer/open_flags.h>
#include <libexplain/buffer/pointer.h>
#include <libexplain/buffer/size_t.h>
#include <libexplain/buffer/wrong_file_type.h>
#include <libexplain/explanation.h>
#include <libexplain/getpagesize.h>
#include <libexplain/parse_bits.h>

Go to the source code of this file.

Functions

static void explain_buffer_errno_mmap_system_call (explain_string_buffer_t *sb, int errnum, void *data, size_t data_size, int prot, int flags, int fildes, off_t offset)
void explain_buffer_errno_mmap_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, void *data, size_t data_size, int prot, int flags, int fildes, off_t offset)
void explain_buffer_errno_mmap (explain_string_buffer_t *sb, int errnum, void *data, size_t data_size, int prot, int flags, int fildes, off_t offset)

Function Documentation

void explain_buffer_errno_mmap ( explain_string_buffer_t sb,
int  errnum,
void *  data,
size_t  data_size,
int  prot,
int  flags,
int  fildes,
off_t  offset 
)

The explain_buffer_errno_mmap function is used to obtain an explanation of an error returned by the mmap(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:
sbThe string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
errnumThe error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
dataThe original data, exactly as passed to the mmap(2) system call.
data_sizeThe original data_size, exactly as passed to the mmap(2) system call.
protThe original prot, exactly as passed to the mmap(2) system call.
flagsThe original flags, exactly as passed to the mmap(2) system call.
fildesThe original fildes, exactly as passed to the mmap(2) system call.
offsetThe original offset, exactly as passed to the mmap(2) system call.

Definition at line 401 of file mmap.c.

void explain_buffer_errno_mmap_explanation ( explain_string_buffer_t sb,
int  errnum,
const char *  syscall_name,
void *  data,
size_t  data_size,
int  prot,
int  flags,
int  fildes,
off_t  offset 
)

The explain_buffer_errno_mmap_explanation function is used to obtain the explanation (the part after "because") of an error returned by the mmap(2) system call (and similar).

Parameters:
sbThe string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
errnumThe error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
syscall_nameThe name of the offending system call.
dataThe original data, exactly as passed to the mmap(2) system call.
data_sizeThe original data_size, exactly as passed to the mmap(2) system call.
protThe original prot, exactly as passed to the mmap(2) system call.
flagsThe original flags, exactly as passed to the mmap(2) system call.
fildesThe original fildes, exactly as passed to the mmap(2) system call.
offsetThe original offset, exactly as passed to the mmap(2) system call.

xgettext: This message is used to explain an EAGAIN error reported by the mmap(2) syatem call, in the case where the file has been locked.

Definition at line 85 of file mmap.c.

static void explain_buffer_errno_mmap_system_call ( explain_string_buffer_t sb,
int  errnum,
void *  data,
size_t  data_size,
int  prot,
int  flags,
int  fildes,
off_t  offset 
) [static]

Definition at line 54 of file mmap.c.