libexplain/waitpid.h File Reference

explain waitpid(2) errors More...

#include <libexplain/gcc_attributes.h>

Go to the source code of this file.

Functions
int	explain_waitpid_or_die (int pid, int *status, int options)
int	explain_waitpid_on_error (int pid, int *status, int options) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_waitpid (int pid, int *status, int options) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_errno_waitpid (int errnum, int pid, int *status, int options) LIBEXPLAIN_WARN_UNUSED_RESULT
void	explain_message_waitpid (char *message, int message_size, int pid, int *status, int options)
void	explain_message_errno_waitpid (char *message, int message_size, int errnum, int pid, int *status, int options)

---

Detailed Description

explain waitpid(2) errors

Definition in file waitpid.h.

---

Function Documentation

const char* explain_errno_waitpid	(	int	errnum,
		int	pid,
		int *	status,
		int	options
	)

The explain_errno_waitpid function is used to obtain an explanation of an error returned by the waitpid(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.

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

 pid_t result = waitpid(pid, status, options);
 if (result < 0)
 {
     int err = errno;
     fprintf(stderr, "%s\n", explain_errno_waitpid(err, pid, status,
         options));
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_waitpid_or_die function.

Parameters:

errnum	The 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.
pid	The original pid, exactly as passed to the waitpid(2) system call.
status	The original status, exactly as passed to the waitpid(2) system call.
options	The original options, exactly as passed to the waitpid(2) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

void explain_message_errno_waitpid	(	char *	message,
		int	message_size,
		int	errnum,
		int	pid,
		int *	status,
		int	options
	)

The explain_message_errno_waitpid function is used to obtain an explanation of an error returned by the waitpid(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.

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

 pid_t result = waitpid(pid, status, options);
 if (result < 0)
 {
     int err = errno;
     char message[3000];
     explain_message_errno_waitpid(message, sizeof(message), err, pid,
         status, options);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_waitpid_or_die function.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
errnum	The 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.
pid	The original pid, exactly as passed to the waitpid(2) system call.
status	The original status, exactly as passed to the waitpid(2) system call.
options	The original options, exactly as passed to the waitpid(2) system call.

void explain_message_waitpid	(	char *	message,
		int	message_size,
		int	pid,
		int *	status,
		int	options
	)

The explain_message_waitpid function is used to obtain an explanation of an error returned by the waitpid(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.

The errno global variable will be used to obtain the error value to be decoded.

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

 pid_t result = waitpid(pid, status, options);
 if (result < 0)
 {
     char message[3000];
     explain_message_waitpid(message, sizeof(message), pid, status, options);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_waitpid_or_die function.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
pid	The original pid, exactly as passed to the waitpid(2) system call.
status	The original status, exactly as passed to the waitpid(2) system call.
options	The original options, exactly as passed to the waitpid(2) system call.

const char* explain_waitpid	(	int	pid,
		int *	status,
		int	options
	)

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

The errno global variable will be used to obtain the error value to be decoded.

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

 pid_t result = waitpid(pid, status, options);
 if (result < 0)
 {
     fprintf(stderr, "%s\n", explain_waitpid(pid, status, options));
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_waitpid_or_die function.

Parameters:

pid	The original pid, exactly as passed to the waitpid(2) system call.
status	The original status, exactly as passed to the waitpid(2) system call.
options	The original options, exactly as passed to the waitpid(2) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

int explain_waitpid_on_error	(	int	pid,
		int *	status,
		int	options
	)

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

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

 pid_t result = explain_waitpid_on_error(pid, status, options);
 if (result < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

pid	The pid, exactly as to be passed to the waitpid(2) system call.
status	The status, exactly as to be passed to the waitpid(2) system call.
options	The options, exactly as to be passed to the waitpid(2) system call.

Returns:

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

int explain_waitpid_or_die	(	int	pid,
		int *	status,
		int	options
	)

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

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

 pid_t result = explain_waitpid_or_die(pid, status, options);

Parameters:

pid	The pid, exactly as to be passed to the waitpid(2) system call.
status	The status, exactly as to be passed to the waitpid(2) system call.
options	The options, exactly as to be passed to the waitpid(2) system call.

Returns:

This function only returns on success. On failure, prints an explanation and exits, it does not return.