igt_hook_create ()

int
igt_hook_create (const char **hook_strs,
                 size_t n,
                 struct igt_hook **igt_hook_ptr);

Allocate and initialize an igt_hook structure.

This function parses the hook descriptors in hook_strs and initializes the struct. The pointer to the allocated structure is stored in igt_hook_ptr .

Each hook descriptor comes from the argument to --hook of the test executable being run.

If an error happens, the returned error number can be passed to igt_hook_error_str() to get a human-readable error message.

igt_hook_free ()

void
igt_hook_free (struct igt_hook *igt_hook);

De-initialize an igt_hook struct returned by igt_hook_create() .

This is a no-op if igt_hook is NULL.

igt_hook_event_notify ()

void
igt_hook_event_notify (struct igt_hook *igt_hook,
                       struct igt_hook_evt *evt);

Push a new igt_hook event.

The argument to igt_hook can be NULL, which is equivalent to a no-op.

This function must be used to notify on a new igt_hook event. Calling it will cause execution of the hook script if the event type matches the filters provided during initialization of igt_hook .

igt_hook_error_str ()

const char *
igt_hook_error_str (int error);

Return a human-readable string containing a description of an error number generated by one of the igt_hook_* functions.

The string will be the result of strerror() for errors from the C standard library or a custom description specific to igt_hook.

igt_hook_print_help ()

void
igt_hook_print_help (FILE *f,
                     const char *option_name);

Print a detailed user help text on hook usage.

enum igt_hook_evt_type

Events tracked by igt_hook. Those events occur at specific points during the execution of a test.

struct igt_hook_evt

struct igt_hook_evt {
	enum igt_hook_evt_type evt_type;
	const char *target_name;
	const char *result;
};

An event tracked by igt_hook, which is done with @igt_hook_event_notify() . This must be zero initialized and fields relevant to the event type must be set before passing its reference to igt_hook_event_notify() .

struct igt_hook

struct igt_hook;

Opaque struct to hold data related to hook support.