libexplain/iocontrol.h

Go to the documentation of this file.

/*
 * libexplain - Explain errno values returned by libc functions
 * Copyright (C) 2009-2011, 2013 Peter Miller
 * Written by Peter Miller <pmiller@opensource.org.au>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIBEXPLAIN_IOCONTROL_H
#define LIBEXPLAIN_IOCONTROL_H

struct explain_string_buffer_t; /* forward */
typedef struct explain_iocontrol_t explain_iocontrol_t;

typedef void (*expain_iocontrol_print_func_t)(const explain_iocontrol_t *p,
    struct explain_string_buffer_t *sb, int errnum, int fildes, int request,
    const void *data);

struct explain_iocontrol_t
{
    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;
};

const explain_iocontrol_t *explain_iocontrol_find_by_number(int fildes,
    int request, const void *data);

const explain_iocontrol_t *explain_iocontrol_request_by_name(const char *name);

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

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

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

int explain_parse_ioctl_request_or_die(const char *text);

void explain_iocontrol_statistics(int *total, int *active);

void explain_iocontrol_check_conflicts(void);

int explain_iocontrol_disambiguate_true(int fildes, int request,
    const void *data);

int explain_iocontrol_disambiguate_false(int fildes, int request,
    const void *data);

int explain_iocontrol_disambiguate_is_a_socket(int fildes, int request,
    const void *data);

int explain_iocontrol_disambiguate_is_not_a_socket(int fildes, int request,
    const void *data);

int explain_iocontrol_disambiguate_is_if_eql(int fildes, int request,
    const void *data);

int explain_iocontrol_disambiguate_is_v4l2(int fildes, int request,
    const void *data);

int explain_iocontrol_disambiguate_scc(int fildes, int request,
    const void *data);

int explain_iocontrol_disambiguate_net_dev_name(int fildes, const char *name);

void explain_iocontrol_check_conflicts(void);

#define NOT_A_POINTER (unsigned)(-1)

#define VOID_STAR (unsigned)(-2)

#define IOCONTROL_FLAG_SIZE_DOES_NOT_AGREE  0x0001

#define IOCONTROL_FLAG_NON_META             0x0002

#define IOCONTROL_FLAG_RW                   0x0004

#define DISAMBIGUATE_USE 0

#define DISAMBIGUATE_DO_NOT_USE -1

#endif /* LIBEXPLAIN_IOCONTROL_H */
/* vim: set ts=8 sw=4 et : */