1 /* Error handler for noninteractive utilities
2 Copyright (C) 1990-1998, 2000-2007, 2009 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>
90 # if !HAVE_DECL_STRERROR_R && STRERROR_R_CHAR_P
91 # ifndef HAVE_DECL_STRERROR_R
92 "this configure-time declaration test was not run"
97 /* The calling program should define program_name and set it to the
98 name of the executing program. */
99 extern char *program_name;
101 # if HAVE_STRERROR_R || defined strerror_r
102 # define __strerror_r strerror_r
103 # endif /* HAVE_STRERROR_R || defined strerror_r */
104 #endif /* not _LIBC */
107 print_errno_message (int errnum)
111 #if defined HAVE_STRERROR_R || _LIBC
113 # if STRERROR_R_CHAR_P || _LIBC
114 s = __strerror_r (errnum, errbuf, sizeof errbuf);
116 if (__strerror_r (errnum, errbuf, sizeof errbuf) == 0)
122 s = strerror (errnum);
127 s = _("Unknown system error");
131 __fxprintf (NULL, ": %s", s);
133 fprintf (stderr, ": %s", s);
138 error_tail (int status, int errnum, const char *message, va_list args)
141 if (_IO_fwide (stderr, 0) > 0)
143 # define ALLOCA_LIMIT 2000
144 size_t len = strlen (message) + 1;
145 wchar_t *wmessage = NULL;
149 bool use_malloc = false;
153 if (__libc_use_alloca (len * sizeof (wchar_t)))
154 wmessage = (wchar_t *) alloca (len * sizeof (wchar_t));
160 wchar_t *p = (wchar_t *) realloc (wmessage,
161 len * sizeof (wchar_t));
165 fputws_unlocked (L"out of memory\n", stderr);
172 memset (&st, '\0', sizeof (st));
175 res = mbsrtowcs (wmessage, &tmp, len, &st);
179 if (__builtin_expect (len >= SIZE_MAX / 2, 0))
181 /* This really should not happen if everything is fine. */
189 if (res == (size_t) -1)
191 /* The string cannot be converted. */
197 wmessage = (wchar_t *) L"???";
200 __vfwprintf (stderr, wmessage, args);
207 vfprintf (stderr, message, args);
210 ++error_message_count;
212 print_errno_message (errnum);
214 __fxprintf (NULL, "\n");
224 /* Print the program name and error message MESSAGE, which is a printf-style
225 format string with optional args.
226 If ERRNUM is nonzero, print its corresponding system error message.
227 Exit with status STATUS if it is nonzero. */
229 error (int status, int errnum, const char *message, ...)
233 #if defined _LIBC && defined __libc_ptf_call
234 /* We do not want this call to be cut short by a thread
235 cancellation. Therefore disable cancellation for now. */
236 int state = PTHREAD_CANCEL_ENABLE;
237 __libc_ptf_call (pthread_setcancelstate, (PTHREAD_CANCEL_DISABLE, &state),
241 #if !_LIBC && defined F_GETFL
242 /* POSIX states that fflush (stdout) after fclose is unspecified; it
243 is safe in glibc, but not on all other platforms. fflush (NULL)
244 is always defined, but too draconian. */
245 if (0 <= fcntl (1, F_GETFL))
249 _IO_flockfile (stderr);
251 if (error_print_progname)
252 (*error_print_progname) ();
256 __fxprintf (NULL, "%s: ", program_name);
258 fprintf (stderr, "%s: ", program_name);
262 va_start (args, message);
263 error_tail (status, errnum, message, args);
266 _IO_funlockfile (stderr);
267 # ifdef __libc_ptf_call
268 __libc_ptf_call (pthread_setcancelstate, (state, NULL), 0);
273 /* Sometimes we want to have at most one error per line. This
274 variable controls whether this mode is selected or not. */
275 int error_one_per_line;
278 error_at_line (int status, int errnum, const char *file_name,
279 unsigned int line_number, const char *message, ...)
283 if (error_one_per_line)
285 static const char *old_file_name;
286 static unsigned int old_line_number;
288 if (old_line_number == line_number
289 && (file_name == old_file_name
290 || strcmp (old_file_name, file_name) == 0))
291 /* Simply return and print nothing. */
294 old_file_name = file_name;
295 old_line_number = line_number;
298 #if defined _LIBC && defined __libc_ptf_call
299 /* We do not want this call to be cut short by a thread
300 cancellation. Therefore disable cancellation for now. */
301 int state = PTHREAD_CANCEL_ENABLE;
302 __libc_ptf_call (pthread_setcancelstate, (PTHREAD_CANCEL_DISABLE, &state),
306 #if !_LIBC && defined F_GETFL
307 /* POSIX states that fflush (stdout) after fclose is unspecified; it
308 is safe in glibc, but not on all other platforms. fflush (NULL)
309 is always defined, but too draconian. */
310 if (0 <= fcntl (1, F_GETFL))
314 _IO_flockfile (stderr);
316 if (error_print_progname)
317 (*error_print_progname) ();
321 __fxprintf (NULL, "%s:", program_name);
323 fprintf (stderr, "%s:", program_name);
328 __fxprintf (NULL, file_name != NULL ? "%s:%d: " : " ",
329 file_name, line_number);
331 fprintf (stderr, file_name != NULL ? "%s:%d: " : " ",
332 file_name, line_number);
335 va_start (args, message);
336 error_tail (status, errnum, message, args);
339 _IO_funlockfile (stderr);
340 # ifdef __libc_ptf_call
341 __libc_ptf_call (pthread_setcancelstate, (state, NULL), 0);
347 /* Make the weak alias. */
349 # undef error_at_line
350 weak_alias (__error, error)
351 weak_alias (__error_at_line, error_at_line)