This file is indexed.

/usr/include/libexplain/getaddrinfo.h is in libexplain-dev 1.4.D001-6.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/*
 * libexplain - Explain errno values returned by libc functions
 * Copyright (C) 2008, 2009, 2013 Peter Miller
 *
 * 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_GETADDRINFO_H
#define LIBEXPLAIN_GETADDRINFO_H

/**
  * @file
  * @brief explain getaddrinfo(3) errors
  */

#include <libexplain/gcc_attributes.h>

#ifdef __cplusplus
extern "C" {
#endif

struct addrinfo; /* forward */

/**
  * The explain_getaddrinfo_or_die function is used to call the
  * getaddrinfo(3) system call.  On failure an explanation will be
  * printed to stderr, obtained from explain_errcode_getaddrinfo(3),
  * 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:
  * @code
  * explain_getaddrinfo_or_die(node, service, hints, res);
  * @endcode
  *
  * @param node
  *     The node, exactly as to be passed to the getaddrinfo(3) system
  *     call.
  * @param service
  *     The service, exactly as to be passed to the getaddrinfo(3)
  *     system call.
  * @param hints
  *     The hints, exactly as to be passed to the getaddrinfo(3) system
  *     call.
  * @param res
  *     The res, exactly as to be passed to the getaddrinfo(3) system
  *     call.
  * @returns
  *     This function only returns on success.  On failure, prints an
  *     explanation and exits, it does not return.
  */
void explain_getaddrinfo_or_die(const char *node, const char *service,
    const struct addrinfo *hints, struct addrinfo **res);

/**
  * The explain_getaddrinfo_on_error function is used to call the
  * getaddrinfo(3) system call.  On failure an explanation will be
  * printed to stderr, but it still returns.
  *
  * This function is intended to be used in a fashion similar to the
  * following example:
  * @code
  * if (explain_getaddrinfo_on_error(node, service, hints, res))
  * {
  *     ...handle error
  *     ...error message already printed
  * }
  * @endcode
  *
  * @param node
  *     The node, exactly as to be passed to the getaddrinfo(3) system
  *     call.
  * @param service
  *     The service, exactly as to be passed to the getaddrinfo(3)
  *     system call.
  * @param hints
  *     The hints, exactly as to be passed to the getaddrinfo(3) system
  *     call.
  * @param res
  *     The res, exactly as to be passed to the getaddrinfo(3) system
  *     call.
  * @returns
  *     This function only returns on success.  On failure, prints an
  *     explanation and exits, it does not return.
  */
int explain_getaddrinfo_on_error(const char *node, const char *service,
    const struct addrinfo *hints, struct addrinfo **res);

/**
  * The explain_errcode_getaddrinfo function is used to obtain an
  * explanation of an error returned by the getaddrinfo(3) system
  * call.  The least the message will contain is the value of
  * gai_strerror(errcode), 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:
  * @code
  * int errcode = getaddrinfo(node, service, hints, res);
  * if (errcode == EAI_SYSTEM)
  *     errcode = errno;
  * if (errcode)
  * {
  *     fprintf(stderr, "%s\n", explain_errcode_getaddrinfo(errcode,
  *         node, service, hints, res));
  *     exit(EXIT_FAILURE);
  * }
  * @endcode
  *
  * @param errnum
  *     The error value to be decoded, as returned by the getaddrinfo(3)
  *     system call.
  * @param node
  *     The original node, exactly as passed to the getaddrinfo(3)
  *     system call.
  * @param service
  *     The original service, exactly as passed to the getaddrinfo(3)
  *     system call.
  * @param hints
  *     The original hints, exactly as passed to the getaddrinfo(3)
  *     system call.
  * @param res
  *     The original res, exactly as passed to the getaddrinfo(3) 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 <b>not</b> thread safe, because it shares a
  *     return buffer across all threads, and many other functions in
  *     this library.
  */
const char *explain_errcode_getaddrinfo(int errnum, const char *node,
    const char *service, const struct addrinfo *hints, struct addrinfo **res)
                                                  LIBEXPLAIN_WARN_UNUSED_RESULT;

/**
  * The explain_message_errcode_getaddrinfo function is used to
  * obtain an explanation of an error returned by the getaddrinfo(3)
  * system call.  The least the message will contain is the value of
  * gai_strerror(errcode), 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:
  * @code
  * int errcode = getaddrinfo(node, service, hints, res);
  * if (errcode == EAI_SYSTEM)
  *     errcode = errno;
  * if (errcode)
  * {
  *     char message[3000];
  *     explain_message_errcode_getaddrinfo(message, sizeof(message),
  *         errcode, node, service, hints, res);
  *     fprintf(stderr, "%s\n", message);
  *     exit(EXIT_FAILURE);
  * }
  * @endcode
  *
  * @param message
  *     The location in which to store the returned message.  If a
  *     suitable message return buffer is supplied, this function is
  *     thread safe.
  * @param message_size
  *     The size in bytes of the location in which to store the returned
  *     message.
  * @param errcode
  *     The error value to be decoded, as returned by the getaddrinfo
  *     system call.
  * @param node
  *     The original node, exactly as passed to the getaddrinfo(3)
  *     system call.
  * @param service
  *     The original service, exactly as passed to the getaddrinfo(3)
  *     system call.
  * @param hints
  *     The original hints, exactly as passed to the getaddrinfo(3)
  *     system call.
  * @param res
  *     The original res, exactly as passed to the getaddrinfo(3) system
  *     call.
  */
void explain_message_errcode_getaddrinfo(char *message, int message_size,
    int errcode, const char *node, const char *service,
    const struct addrinfo *hints, struct addrinfo **res);

#ifdef __cplusplus
}
#endif

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