#include <iocontrol.h>

Data Fields
const char *	name
int	number
int(*	disambiguate )(int fildes, int request, const void *data)
expain_iocontrol_print_func_t	print_name
expain_iocontrol_print_func_t	print_data
expain_iocontrol_print_func_t	print_explanation
void(*	print_data_returned )(const explain_iocontrol_t p, struct explain_string_buffer_t sb, int errnum, int fildes, int request, const void *data)
unsigned	data_size
const char *	data_type
unsigned	flags
const char *	file
int	line

Detailed Description

The explain_iocontrol_t type is used to represent an ioctl(2) call, providing name and number.

Note:: This information is not kept in a single table for all values, like every other set of constants, because (a) some values are ambiguous, and (b) the includes files have bugs making it impossible to include all of them in the same combilation unit.

Definition at line 60 of file iocontrol.h.

Field Documentation

unsigned explain_iocontrol_t::data_size

The data_size member is used to remember the sizeof the data pointed to by the ioctl data argument. This is used by ioctl scan to allocate data of the correct size.

If set to NOT_A_POINTER, it means that the data passed to the ioctl is not a pointer (an intptr_t instead).

Definition at line 145 of file iocontrol.h.

const char* explain_iocontrol_t::data_type

The data_type member is used to remember the type of the data pointed to by the ioctl data argument. This is used to improve the description, but also to provide this to static analysis tools.

Definition at line 152 of file iocontrol.h.

int(* explain_iocontrol_t::disambiguate)(int fildes, int request, const void *data)

The disambiguate method is used to ambiguous ioctl(2) request values, to attempt to discern which was intended from information about the state of the file descriptor, and the request itself. This is not always possible, given that the code is not psychic.

If the NULL pointer value is used, the value is assumed to be non-ambiguous. This is almost always the case.

Returns 0 on success (i.e. a match), -1 on failure (i.e. not a match).

Definition at line 88 of file iocontrol.h.

const char* explain_iocontrol_t::file

The file member is used to rememebr the name of the file this ioctl is defined in, by using __FILE__ in the initialiser. This is needed to obtain useful error message out of the explain_iocontrol_check_conflicts function.

Definition at line 167 of file iocontrol.h.

unsigned explain_iocontrol_t::flags

The flags member is used to store assorted information about the ioctl, mostly of interest when checking ioctl data for internal consistency.

Definition at line 159 of file iocontrol.h.

int explain_iocontrol_t::line

The line member is used to rememebr the line number of the source file this ioctl is defined in, by using __LINE__ in the initialiser. This is needed to obtain useful error message out of the explain_iocontrol_check_conflicts function.

Definition at line 175 of file iocontrol.h.

const char* explain_iocontrol_t::name

The name of the ioctl(2) request.

Set to NULL for systems on which this ioctl does not apply.

Definition at line 67 of file iocontrol.h.

int explain_iocontrol_t::number

The numeric value of the ioctl(2) request.

Set to zero (0) for systems on which this ioctl does not apply.

Definition at line 74 of file iocontrol.h.

expain_iocontrol_print_func_t explain_iocontrol_t::print_data

The print_data member is a pointer to a function that is used to print a representation of the data argument passed to an ioctl(2) system call.

Definition at line 105 of file iocontrol.h.

void(* explain_iocontrol_t::print_data_returned)(const explain_iocontrol_t *p, struct explain_string_buffer_t *sb, int errnum, int fildes, int request, const void *data)

The print_data_returned method is used to print a representation of the data argument returned by an ioctl(2) system call.

Parameters:

p	Pointer to the explain_iocontrol_t instance, rather like "this" in C++ code.
sb	The string buffer to print into.
errnum	The error number that caused all this, obtained from the global errno variable, possibly indirectly.
fildes	The original fildes, exactly as passed to the ioctl(2) system call.
request	The original request, exactly as passed to the ioctl(2) system call.
data	The original data, exactly as passed to the ioctl(2) system call.

Definition at line 133 of file iocontrol.h.

expain_iocontrol_print_func_t explain_iocontrol_t::print_explanation

The print_explanation member is a pointer to a function that is used to print an representation of the data returned by a successful ioctl(2) system call.

Definition at line 112 of file iocontrol.h.

expain_iocontrol_print_func_t explain_iocontrol_t::print_name

The print_name member is a pointer to a function that is is used to print the name of a request argument passed to an ioctl(2) system call.

If the NULL pointer is used, the default action is to print the name member.

Definition at line 98 of file iocontrol.h.

The documentation for this struct was generated from the following file:

libexplain/iocontrol.h

Data Fields

Detailed Description

Field Documentation