1 /* Error handler for noninteractive utilities
2 Copyright (C) 1990-1998, 2000-2007, 2009-2010 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 Win32 API functions. */
93 # define WIN32_LEAN_AND_MEAN
97 # if !HAVE_DECL_STRERROR_R && STRERROR_R_CHAR_P
98 # ifndef HAVE_DECL_STRERROR_R
99 "this configure-time declaration test was not run"
104 /* The calling program should define program_name and set it to the
105 name of the executing program. */
106 extern char *program_name;
108 # if HAVE_STRERROR_R || defined strerror_r
109 # define __strerror_r strerror_r
110 # endif /* HAVE_STRERROR_R || defined strerror_r */
111 #endif /* not _LIBC */
114 /* Return non-zero if FD is open. */
118 # if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
119 /* On Win32: The initial state of unassigned standard file descriptors is
120 that they are open but point to an INVALID_HANDLE_VALUE. There is no
121 fcntl, and the gnulib replacement fcntl does not support F_GETFL. */
122 return (HANDLE) _get_osfhandle (fd) != INVALID_HANDLE_VALUE;
125 # error Please port fcntl to your platform
127 return 0 <= fcntl (fd, F_GETFL);
138 # if GNULIB_FREOPEN_SAFER
139 /* Use of gnulib's freopen-safer module normally ensures that
141 whenever stdout is open. */
142 stdout_fd = STDOUT_FILENO;
144 /* POSIX states that fileno (stdout) after fclose is unspecified. But in
145 practice it is not a problem, because stdout is statically allocated and
146 the fd of a FILE stream is stored as a field in its allocated memory. */
147 stdout_fd = fileno (stdout);
149 /* POSIX states that fflush (stdout) after fclose is unspecified; it
150 is safe in glibc, but not on all other platforms. fflush (NULL)
151 is always defined, but too draconian. */
152 if (0 <= stdout_fd && is_open (stdout_fd))
158 print_errno_message (int errnum)
162 #if defined HAVE_STRERROR_R || _LIBC
164 # if STRERROR_R_CHAR_P || _LIBC
165 s = __strerror_r (errnum, errbuf, sizeof errbuf);
167 if (__strerror_r (errnum, errbuf, sizeof errbuf) == 0)
173 s = strerror (errnum);
178 s = _("Unknown system error");
182 __fxprintf (NULL, ": %s", s);
184 fprintf (stderr, ": %s", s);
189 error_tail (int status, int errnum, const char *message, va_list args)
192 if (_IO_fwide (stderr, 0) > 0)
194 # define ALLOCA_LIMIT 2000
195 size_t len = strlen (message) + 1;
196 wchar_t *wmessage = NULL;
200 bool use_malloc = false;
204 if (__libc_use_alloca (len * sizeof (wchar_t)))
205 wmessage = (wchar_t *) alloca (len * sizeof (wchar_t));
211 wchar_t *p = (wchar_t *) realloc (wmessage,
212 len * sizeof (wchar_t));
216 fputws_unlocked (L"out of memory\n", stderr);
223 memset (&st, '\0', sizeof (st));
226 res = mbsrtowcs (wmessage, &tmp, len, &st);
230 if (__builtin_expect (len >= SIZE_MAX / 2, 0))
232 /* This really should not happen if everything is fine. */
240 if (res == (size_t) -1)
242 /* The string cannot be converted. */
248 wmessage = (wchar_t *) L"???";
251 __vfwprintf (stderr, wmessage, args);
258 vfprintf (stderr, message, args);
261 ++error_message_count;
263 print_errno_message (errnum);
265 __fxprintf (NULL, "\n");
275 /* Print the program name and error message MESSAGE, which is a printf-style
276 format string with optional args.
277 If ERRNUM is nonzero, print its corresponding system error message.
278 Exit with status STATUS if it is nonzero. */
280 error (int status, int errnum, const char *message, ...)
284 #if defined _LIBC && defined __libc_ptf_call
285 /* We do not want this call to be cut short by a thread
286 cancellation. Therefore disable cancellation for now. */
287 int state = PTHREAD_CANCEL_ENABLE;
288 __libc_ptf_call (pthread_setcancelstate, (PTHREAD_CANCEL_DISABLE, &state),
294 _IO_flockfile (stderr);
296 if (error_print_progname)
297 (*error_print_progname) ();
301 __fxprintf (NULL, "%s: ", program_name);
303 fprintf (stderr, "%s: ", program_name);
307 va_start (args, message);
308 error_tail (status, errnum, message, args);
311 _IO_funlockfile (stderr);
312 # ifdef __libc_ptf_call
313 __libc_ptf_call (pthread_setcancelstate, (state, NULL), 0);
318 /* Sometimes we want to have at most one error per line. This
319 variable controls whether this mode is selected or not. */
320 int error_one_per_line;
323 error_at_line (int status, int errnum, const char *file_name,
324 unsigned int line_number, const char *message, ...)
328 if (error_one_per_line)
330 static const char *old_file_name;
331 static unsigned int old_line_number;
333 if (old_line_number == line_number
334 && (file_name == old_file_name
335 || strcmp (old_file_name, file_name) == 0))
336 /* Simply return and print nothing. */
339 old_file_name = file_name;
340 old_line_number = line_number;
343 #if defined _LIBC && defined __libc_ptf_call
344 /* We do not want this call to be cut short by a thread
345 cancellation. Therefore disable cancellation for now. */
346 int state = PTHREAD_CANCEL_ENABLE;
347 __libc_ptf_call (pthread_setcancelstate, (PTHREAD_CANCEL_DISABLE, &state),
353 _IO_flockfile (stderr);
355 if (error_print_progname)
356 (*error_print_progname) ();
360 __fxprintf (NULL, "%s:", program_name);
362 fprintf (stderr, "%s:", program_name);
367 __fxprintf (NULL, file_name != NULL ? "%s:%d: " : " ",
368 file_name, line_number);
370 fprintf (stderr, file_name != NULL ? "%s:%d: " : " ",
371 file_name, line_number);
374 va_start (args, message);
375 error_tail (status, errnum, message, args);
378 _IO_funlockfile (stderr);
379 # ifdef __libc_ptf_call
380 __libc_ptf_call (pthread_setcancelstate, (state, NULL), 0);
386 /* Make the weak alias. */
388 # undef error_at_line
389 weak_alias (__error, error)
390 weak_alias (__error_at_line, error_at_line)