/usr/include/libexplain/vsnprintf.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 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 | /*
* libexplain - Explain errno values returned by libc functions
* Copyright (C) 2010, 2011, 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_VSNPRINTF_H
#define LIBEXPLAIN_VSNPRINTF_H
/**
* @file
* @brief explain vsnprintf(3) errors
*
* These functions may be used to obtain explanations for errors returned
* by the <i>vsnprintf</i>(3) system call.
*/
#include <libexplain/gcc_attributes.h>
#include <libexplain/large_file_support.h>
#include <libexplain/gcc_attributes.h>
#include <stdarg.h>
#include <stdio.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* The explain_vsnprintf_or_die function is used to call the
* <i>vsnprintf</i>(3) system call. On failure an explanation will be
* printed to stderr, obtained from the <i>#explain_vsnprintf</i>(3)
* function, and then the process terminates by calling
* <tt>exit(EXIT_FAILURE)</tt>.
*
* @param data
* The data, exactly as to be passed to the <i>vsnprintf</i>(3) system
* call.
* @param data_size
* The data_size, exactly as to be passed to the <i>vsnprintf</i>(3)
* system call.
* @param format
* The format, exactly as to be passed to the <i>vsnprintf</i>(3)
* system call.
* @param ap
* The ap, exactly as to be passed to the <i>vsnprintf</i>(3) system
* call.
* @returns
* This function only returns on success, see <i>vsnprintf</i>(3) for
* more information. On failure, prints an explanation and exits, it
* does not return.
*
* @par Example:
* This function is intended to be used in a fashion similar to the
* following example:
* @code
* int result = explain_vsnprintf_or_die(data, data_size, format, ap);
* @endcode
*/
int explain_vsnprintf_or_die(char *data, size_t data_size, const char *format,
va_list ap)
LIBEXPLAIN_FORMAT_VPRINTF(3);
/**
* The explain_vsnprintf_on_error function is used to call the
* <i>vsnprintf</i>(3) system call. On failure an explanation will be
* printed to stderr, obtained from the <i>#explain_vsnprintf</i>(3)
* function.
*
* @param data
* The data, exactly as to be passed to the <i>vsnprintf</i>(3) system
* call.
* @param data_size
* The data_size, exactly as to be passed to the <i>vsnprintf</i>(3)
* system call.
* @param format
* The format, exactly as to be passed to the <i>vsnprintf</i>(3)
* system call.
* @param ap
* The ap, exactly as to be passed to the <i>vsnprintf</i>(3) system
* call.
* @returns
* The value returned by the wrapped <i>vsnprintf</i>(3) system call.
*
* @par Example:
* This function is intended to be used in a fashion similar to the
* following example:
* @code
* errno = 0;
* int result = explain_vsnprintf_on_error(data, data_size, format, ap);
* if (result < 0 && errno != 0)
* {
* ...cope with error
* ...no need to print error message
* }
* @endcode
*/
int explain_vsnprintf_on_error(char *data, size_t data_size, const char *format,
va_list ap)
LIBEXPLAIN_FORMAT_VPRINTF(3);
/**
* The explain_vsnprintf function is used to obtain an explanation of an
* error returned by the <i>vsnprintf</i>(3) system call. The least the
* message will contain is the value of <tt>strerror(errno)</tt>, 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.
*
* @param data
* The original data, exactly as passed to the <i>vsnprintf</i>(3)
* system call.
* @param data_size
* The original data_size, exactly as passed to the
* <i>vsnprintf</i>(3) system call.
* @param format
* The original format, exactly as passed to the <i>vsnprintf</i>(3)
* system call.
* @param ap
* The original ap, exactly as passed to the <i>vsnprintf</i>(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.
*
* @par Example:
* This function is intended to be used in a fashion similar to the
* following example:
* @code
* errno = 0;
* int result = vsnprintf(data, data_size, format, ap);
* if (result < 0 && errno != 0)
* {
* fprintf(stderr, "%s\n", explain_vsnprintf(data, data_size, format, ap));
* exit(EXIT_FAILURE);
* }
* @endcode
* @par
* The above code example is available pre-packaged as the
* #explain_vsnprintf_or_die function.
*/
const char *explain_vsnprintf(char *data, size_t data_size, const char *format,
va_list ap)
LIBEXPLAIN_FORMAT_VPRINTF(3)
LIBEXPLAIN_WARN_UNUSED_RESULT;
/**
* The explain_errno_vsnprintf function is used to obtain an explanation
* of an error returned by the <i>vsnprintf</i>(3) system call. The least
* the message will contain is the value of <tt>strerror(errnum)</tt>, but
* usually it will do much better, and indicate the underlying cause in
* more detail.
*
* @param 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 <b>any</b> code between the system
* call to be explained and this function, because many libc functions
* will alter the value of errno.
* @param data
* The original data, exactly as passed to the <i>vsnprintf</i>(3)
* system call.
* @param data_size
* The original data_size, exactly as passed to the
* <i>vsnprintf</i>(3) system call.
* @param format
* The original format, exactly as passed to the <i>vsnprintf</i>(3)
* system call.
* @param ap
* The original ap, exactly as passed to the <i>vsnprintf</i>(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.
*
* @par Example:
* This function is intended to be used in a fashion similar to the
* following example:
* @code
* errno = 0;
* int result = vsnprintf(data, data_size, format, ap);
* if (result < 0 && errno != 0)
* {
* int err = errno;
* fprintf(stderr, "%s\n", explain_errno_vsnprintf(err, data, data_size,
* format, ap));
* exit(EXIT_FAILURE);
* }
* @endcode
* @par
* The above code example is available pre-packaged as the
* #explain_vsnprintf_or_die function.
*/
const char *explain_errno_vsnprintf(int errnum, char *data, size_t data_size,
const char *format, va_list ap)
LIBEXPLAIN_FORMAT_VPRINTF(4)
LIBEXPLAIN_WARN_UNUSED_RESULT;
/**
* The explain_message_vsnprintf function is used to obtain an explanation
* of an error returned by the <i>vsnprintf</i>(3) system call. The least
* the message will contain is the value of <tt>strerror(errnum)</tt>, 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.
*
* @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 data
* The original data, exactly as passed to the <i>vsnprintf</i>(3)
* system call.
* @param data_size
* The original data_size, exactly as passed to the
* <i>vsnprintf</i>(3) system call.
* @param format
* The original format, exactly as passed to the <i>vsnprintf</i>(3)
* system call.
* @param ap
* The original ap, exactly as passed to the <i>vsnprintf</i>(3)
* system call.
*
* @par Example:
* This function is intended to be used in a fashion similar to the
* following example:
* @code
* errno = 0;
* int result = vsnprintf(data, data_size, format, ap);
* if (result < 0 && errno != 0)
* {
* char message[3000];
* explain_message_vsnprintf(message, sizeof(message), data, data_size,
* format, ap);
* fprintf(stderr, "%s\n", message);
* exit(EXIT_FAILURE);
* }
* @endcode
* @par
* The above code example is available pre-packaged as the
* #explain_vsnprintf_or_die function.
*/
void explain_message_vsnprintf(char *message, int message_size, char *data,
size_t data_size, const char *format, va_list ap)
LIBEXPLAIN_FORMAT_VPRINTF(5);
/**
* The explain_message_errno_vsnprintf function is used to obtain an
* explanation of an error returned by the <i>vsnprintf</i>(3) system
* call. The least the message will contain is the value of
* <tt>strerror(errnum)</tt>, but usually it will do much better, and
* indicate the underlying cause in more detail.
*
* @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 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 <b>any</b> code between the system
* call to be explained and this function, because many libc functions
* will alter the value of errno.
* @param data
* The original data, exactly as passed to the <i>vsnprintf</i>(3)
* system call.
* @param data_size
* The original data_size, exactly as passed to the
* <i>vsnprintf</i>(3) system call.
* @param format
* The original format, exactly as passed to the <i>vsnprintf</i>(3)
* system call.
* @param ap
* The original ap, exactly as passed to the <i>vsnprintf</i>(3)
* system call.
*
* @par Example:
* This function is intended to be used in a fashion similar to the
* following example:
* @code
* errno = 0;
* int result = vsnprintf(data, data_size, format, ap);
* if (result < 0 && errno != 0)
* {
* int err = errno;
* char message[3000];
* explain_message_errno_vsnprintf(message, sizeof(message), err, data,
* data_size, format, ap);
* fprintf(stderr, "%s\n", message);
* exit(EXIT_FAILURE);
* }
* @endcode
* @par
* The above code example is available pre-packaged as the
* #explain_vsnprintf_or_die function.
*/
void explain_message_errno_vsnprintf(char *message, int message_size,
int errnum, char *data, size_t data_size, const char *format, va_list ap)
LIBEXPLAIN_FORMAT_VPRINTF(6);
#ifdef __cplusplus
}
#endif
/* vim: set ts=8 sw=4 et : */
#endif /* LIBEXPLAIN_VSNPRINTF_H */
|