1 /* Error handler for noninteractive utilities
2 Copyright (C) 1990-1998, 2000-2007, 2009-2012 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
18 /* Written by David MacKenzie <djm@gnu.ai.mit.edu>. */
31 #if !_LIBC && ENABLE_NLS
33 # define _(msgid) gettext (msgid)
41 # define mbsrtowcs __mbsrtowcs
45 # include "unlocked-io.h"
49 # define _(String) String
52 /* If NULL, error will flush stdout, then print on stderr the program
53 name, a colon and a space. Otherwise, error will call this
54 function without parameters instead. */
55 void (*error_print_progname) (void);
57 /* This variable is incremented each time 'error' is called. */
58 unsigned int error_message_count;
61 /* In the GNU C library, there is a predefined variable for this. */
63 # define program_name program_invocation_name
66 # include <libio/libioP.h>
68 /* In GNU libc we want do not want to use the common name 'error' directly.
69 Instead make it a weak alias. */
70 extern void __error (int status, int errnum, const char *message, ...)
71 __attribute__ ((__format__ (__printf__, 3, 4)));
72 extern void __error_at_line (int status, int errnum, const char *file_name,
73 unsigned int line_number, const char *message,
75 __attribute__ ((__format__ (__printf__, 5, 6)));;
76 # define error __error
77 # define error_at_line __error_at_line
79 # include <libio/iolibio.h>
80 # define fflush(s) INTUSE(_IO_fflush) (s)
82 # define putc(c, fp) INTUSE(_IO_putc) (c, fp)
84 # include <bits/libc-lock.h>
91 # if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
92 /* Get declarations of the native Windows API functions. */
93 # define WIN32_LEAN_AND_MEAN
95 /* Get _get_osfhandle. */
96 # include "msvc-nothrow.h"
99 /* The gnulib override of fcntl is not needed in this file. */
102 # if !HAVE_DECL_STRERROR_R
103 # ifndef HAVE_DECL_STRERROR_R
104 "this configure-time declaration test was not run"
106 # if STRERROR_R_CHAR_P
113 /* The calling program should define program_name and set it to the
114 name of the executing program. */
115 extern char *program_name;
117 # if HAVE_STRERROR_R || defined strerror_r
118 # define __strerror_r strerror_r
119 # endif /* HAVE_STRERROR_R || defined strerror_r */
120 #endif /* not _LIBC */
123 /* Return non-zero if FD is open. */
127 # if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
128 /* On native Windows: The initial state of unassigned standard file
129 descriptors is that they are open but point to an INVALID_HANDLE_VALUE.
130 There is no fcntl, and the gnulib replacement fcntl does not support
132 return (HANDLE) _get_osfhandle (fd) != INVALID_HANDLE_VALUE;
135 # error Please port fcntl to your platform
137 return 0 <= fcntl (fd, F_GETFL);
148 # if GNULIB_FREOPEN_SAFER
149 /* Use of gnulib's freopen-safer module normally ensures that
151 whenever stdout is open. */
152 stdout_fd = STDOUT_FILENO;
154 /* POSIX states that fileno (stdout) after fclose is unspecified. But in
155 practice it is not a problem, because stdout is statically allocated and
156 the fd of a FILE stream is stored as a field in its allocated memory. */
157 stdout_fd = fileno (stdout);
159 /* POSIX states that fflush (stdout) after fclose is unspecified; it
160 is safe in glibc, but not on all other platforms. fflush (NULL)
161 is always defined, but too draconian. */
162 if (0 <= stdout_fd && is_open (stdout_fd))
168 print_errno_message (int errnum)
172 #if defined HAVE_STRERROR_R || _LIBC
174 # if STRERROR_R_CHAR_P || _LIBC
175 s = __strerror_r (errnum, errbuf, sizeof errbuf);
177 if (__strerror_r (errnum, errbuf, sizeof errbuf) == 0)
183 s = strerror (errnum);
188 s = _("Unknown system error");
192 __fxprintf (NULL, ": %s", s);
194 fprintf (stderr, ": %s", s);
199 error_tail (int status, int errnum, const char *message, va_list args)
202 if (_IO_fwide (stderr, 0) > 0)
204 # define ALLOCA_LIMIT 2000
205 size_t len = strlen (message) + 1;
206 wchar_t *wmessage = NULL;
210 bool use_malloc = false;
214 if (__libc_use_alloca (len * sizeof (wchar_t)))
215 wmessage = (wchar_t *) alloca (len * sizeof (wchar_t));
221 wchar_t *p = (wchar_t *) realloc (wmessage,
222 len * sizeof (wchar_t));
226 fputws_unlocked (L"out of memory\n", stderr);
233 memset (&st, '\0', sizeof (st));
236 res = mbsrtowcs (wmessage, &tmp, len, &st);
240 if (__builtin_expect (len >= SIZE_MAX / 2, 0))
242 /* This really should not happen if everything is fine. */
250 if (res == (size_t) -1)
252 /* The string cannot be converted. */
258 wmessage = (wchar_t *) L"???";
261 __vfwprintf (stderr, wmessage, args);
268 vfprintf (stderr, message, args);
271 ++error_message_count;
273 print_errno_message (errnum);
275 __fxprintf (NULL, "\n");
285 /* Print the program name and error message MESSAGE, which is a printf-style
286 format string with optional args.
287 If ERRNUM is nonzero, print its corresponding system error message.
288 Exit with status STATUS if it is nonzero. */
290 error (int status, int errnum, const char *message, ...)
294 #if defined _LIBC && defined __libc_ptf_call
295 /* We do not want this call to be cut short by a thread
296 cancellation. Therefore disable cancellation for now. */
297 int state = PTHREAD_CANCEL_ENABLE;
298 __libc_ptf_call (pthread_setcancelstate, (PTHREAD_CANCEL_DISABLE, &state),
304 _IO_flockfile (stderr);
306 if (error_print_progname)
307 (*error_print_progname) ();
311 __fxprintf (NULL, "%s: ", program_name);
313 fprintf (stderr, "%s: ", program_name);
317 va_start (args, message);
318 error_tail (status, errnum, message, args);
321 _IO_funlockfile (stderr);
322 # ifdef __libc_ptf_call
323 __libc_ptf_call (pthread_setcancelstate, (state, NULL), 0);
328 /* Sometimes we want to have at most one error per line. This
329 variable controls whether this mode is selected or not. */
330 int error_one_per_line;
333 error_at_line (int status, int errnum, const char *file_name,
334 unsigned int line_number, const char *message, ...)
338 if (error_one_per_line)
340 static const char *old_file_name;
341 static unsigned int old_line_number;
343 if (old_line_number == line_number
344 && (file_name == old_file_name
345 || strcmp (old_file_name, file_name) == 0))
346 /* Simply return and print nothing. */
349 old_file_name = file_name;
350 old_line_number = line_number;
353 #if defined _LIBC && defined __libc_ptf_call
354 /* We do not want this call to be cut short by a thread
355 cancellation. Therefore disable cancellation for now. */
356 int state = PTHREAD_CANCEL_ENABLE;
357 __libc_ptf_call (pthread_setcancelstate, (PTHREAD_CANCEL_DISABLE, &state),
363 _IO_flockfile (stderr);
365 if (error_print_progname)
366 (*error_print_progname) ();
370 __fxprintf (NULL, "%s:", program_name);
372 fprintf (stderr, "%s:", program_name);
377 __fxprintf (NULL, file_name != NULL ? "%s:%d: " : " ",
378 file_name, line_number);
380 fprintf (stderr, file_name != NULL ? "%s:%d: " : " ",
381 file_name, line_number);
384 va_start (args, message);
385 error_tail (status, errnum, message, args);
388 _IO_funlockfile (stderr);
389 # ifdef __libc_ptf_call
390 __libc_ptf_call (pthread_setcancelstate, (state, NULL), 0);
396 /* Make the weak alias. */
398 # undef error_at_line
399 weak_alias (__error, error)
400 weak_alias (__error_at_line, error_at_line)