1 /* Error handler for noninteractive utilities
2 Copyright (C) 1990-1998, 2000-2007, 2009-2019 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 <https://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
42 # define USE_UNLOCKED_IO 0
43 # define _GL_ATTRIBUTE_FORMAT_PRINTF(a, b)
44 # define _GL_ARG_NONNULL(a)
46 # include "getprogname.h"
50 # include "unlocked-io.h"
54 # define _(String) String
57 /* If NULL, error will flush stdout, then print on stderr the program
58 name, a colon and a space. Otherwise, error will call this
59 function without parameters instead. */
60 void (*error_print_progname
) (void);
62 /* This variable is incremented each time 'error' is called. */
63 unsigned int error_message_count
;
66 /* In the GNU C library, there is a predefined variable for this. */
68 # define program_name program_invocation_name
71 # include <libio/libioP.h>
73 /* In GNU libc we want do not want to use the common name 'error' directly.
74 Instead make it a weak alias. */
75 extern void __error (int status
, int errnum
, const char *message
, ...)
76 __attribute__ ((__format__ (__printf__
, 3, 4)));
77 extern void __error_at_line (int status
, int errnum
, const char *file_name
,
78 unsigned int line_number
, const char *message
,
80 __attribute__ ((__format__ (__printf__
, 5, 6)));
81 # define error __error
82 # define error_at_line __error_at_line
84 # include <libio/iolibio.h>
85 # define fflush(s) _IO_fflush (s)
87 # define putc(c, fp) _IO_putc (c, fp)
89 # include <bits/libc-lock.h>
96 # if defined _WIN32 && ! defined __CYGWIN__
97 /* Get declarations of the native Windows API functions. */
98 # define WIN32_LEAN_AND_MEAN
100 /* Get _get_osfhandle. */
101 # if GNULIB_MSVC_NOTHROW
102 # include "msvc-nothrow.h"
108 /* The gnulib override of fcntl is not needed in this file. */
111 # if !(GNULIB_STRERROR_R_POSIX || HAVE_DECL_STRERROR_R)
112 # ifndef HAVE_DECL_STRERROR_R
113 "this configure-time declaration test was not run"
115 # if STRERROR_R_CHAR_P
116 char *strerror_r (int errnum
, char *buf
, size_t buflen
);
118 int strerror_r (int errnum
, char *buf
, size_t buflen
);
122 # define program_name getprogname ()
124 # if GNULIB_STRERROR_R_POSIX || HAVE_STRERROR_R || defined strerror_r
125 # define __strerror_r strerror_r
126 # endif /* GNULIB_STRERROR_R_POSIX || HAVE_STRERROR_R || defined strerror_r */
127 #endif /* not _LIBC */
130 /* Return non-zero if FD is open. */
134 # if defined _WIN32 && ! defined __CYGWIN__
135 /* On native Windows: The initial state of unassigned standard file
136 descriptors is that they are open but point to an INVALID_HANDLE_VALUE.
137 There is no fcntl, and the gnulib replacement fcntl does not support
139 return (HANDLE
) _get_osfhandle (fd
) != INVALID_HANDLE_VALUE
;
142 # error Please port fcntl to your platform
144 return 0 <= fcntl (fd
, F_GETFL
);
155 # if GNULIB_FREOPEN_SAFER
156 /* Use of gnulib's freopen-safer module normally ensures that
158 whenever stdout is open. */
159 stdout_fd
= STDOUT_FILENO
;
161 /* POSIX states that fileno (stdout) after fclose is unspecified. But in
162 practice it is not a problem, because stdout is statically allocated and
163 the fd of a FILE stream is stored as a field in its allocated memory. */
164 stdout_fd
= fileno (stdout
);
166 /* POSIX states that fflush (stdout) after fclose is unspecified; it
167 is safe in glibc, but not on all other platforms. fflush (NULL)
168 is always defined, but too draconian. */
169 if (0 <= stdout_fd
&& is_open (stdout_fd
))
175 print_errno_message (int errnum
)
179 #if _LIBC || GNULIB_STRERROR_R_POSIX || defined HAVE_STRERROR_R
181 # if _LIBC || (!GNULIB_STRERROR_R_POSIX && STRERROR_R_CHAR_P)
182 s
= __strerror_r (errnum
, errbuf
, sizeof errbuf
);
184 if (__strerror_r (errnum
, errbuf
, sizeof errbuf
) == 0)
190 s
= strerror (errnum
);
195 s
= _("Unknown system error");
199 __fxprintf (NULL
, ": %s", s
);
201 fprintf (stderr
, ": %s", s
);
205 static void _GL_ATTRIBUTE_FORMAT_PRINTF (3, 0) _GL_ARG_NONNULL ((3))
206 error_tail (int status
, int errnum
, const char *message
, va_list args
)
209 if (_IO_fwide (stderr
, 0) > 0)
211 size_t len
= strlen (message
) + 1;
212 wchar_t *wmessage
= NULL
;
216 bool use_malloc
= false;
220 if (__libc_use_alloca (len
* sizeof (wchar_t)))
221 wmessage
= (wchar_t *) alloca (len
* sizeof (wchar_t));
227 wchar_t *p
= (wchar_t *) realloc (wmessage
,
228 len
* sizeof (wchar_t));
232 fputws_unlocked (L
"out of memory\n", stderr
);
239 memset (&st
, '\0', sizeof (st
));
242 res
= mbsrtowcs (wmessage
, &tmp
, len
, &st
);
246 if (__builtin_expect (len
>= SIZE_MAX
/ sizeof (wchar_t) / 2, 0))
248 /* This really should not happen if everything is fine. */
256 if (res
== (size_t) -1)
258 /* The string cannot be converted. */
264 wmessage
= (wchar_t *) L
"???";
267 __vfwprintf (stderr
, wmessage
, args
);
274 vfprintf (stderr
, message
, args
);
276 ++error_message_count
;
278 print_errno_message (errnum
);
280 __fxprintf (NULL
, "\n");
290 /* Print the program name and error message MESSAGE, which is a printf-style
291 format string with optional args.
292 If ERRNUM is nonzero, print its corresponding system error message.
293 Exit with status STATUS if it is nonzero. */
295 error (int status
, int errnum
, const char *message
, ...)
299 #if defined _LIBC && defined __libc_ptf_call
300 /* We do not want this call to be cut short by a thread
301 cancellation. Therefore disable cancellation for now. */
302 int state
= PTHREAD_CANCEL_ENABLE
;
303 __libc_ptf_call (pthread_setcancelstate
, (PTHREAD_CANCEL_DISABLE
, &state
),
309 _IO_flockfile (stderr
);
311 if (error_print_progname
)
312 (*error_print_progname
) ();
316 __fxprintf (NULL
, "%s: ", program_name
);
318 fprintf (stderr
, "%s: ", program_name
);
322 va_start (args
, message
);
323 error_tail (status
, errnum
, message
, args
);
327 _IO_funlockfile (stderr
);
328 # ifdef __libc_ptf_call
329 __libc_ptf_call (pthread_setcancelstate
, (state
, NULL
), 0);
334 /* Sometimes we want to have at most one error per line. This
335 variable controls whether this mode is selected or not. */
336 int error_one_per_line
;
339 error_at_line (int status
, int errnum
, const char *file_name
,
340 unsigned int line_number
, const char *message
, ...)
344 if (error_one_per_line
)
346 static const char *old_file_name
;
347 static unsigned int old_line_number
;
349 if (old_line_number
== line_number
350 && (file_name
== old_file_name
351 || (old_file_name
!= NULL
353 && strcmp (old_file_name
, file_name
) == 0)))
355 /* Simply return and print nothing. */
358 old_file_name
= file_name
;
359 old_line_number
= line_number
;
362 #if defined _LIBC && defined __libc_ptf_call
363 /* We do not want this call to be cut short by a thread
364 cancellation. Therefore disable cancellation for now. */
365 int state
= PTHREAD_CANCEL_ENABLE
;
366 __libc_ptf_call (pthread_setcancelstate
, (PTHREAD_CANCEL_DISABLE
, &state
),
372 _IO_flockfile (stderr
);
374 if (error_print_progname
)
375 (*error_print_progname
) ();
379 __fxprintf (NULL
, "%s:", program_name
);
381 fprintf (stderr
, "%s:", program_name
);
386 __fxprintf (NULL
, file_name
!= NULL
? "%s:%u: " : " ",
387 file_name
, line_number
);
389 fprintf (stderr
, file_name
!= NULL
? "%s:%u: " : " ",
390 file_name
, line_number
);
393 va_start (args
, message
);
394 error_tail (status
, errnum
, message
, args
);
398 _IO_funlockfile (stderr
);
399 # ifdef __libc_ptf_call
400 __libc_ptf_call (pthread_setcancelstate
, (state
, NULL
), 0);
406 /* Make the weak alias. */
408 # undef error_at_line
409 weak_alias (__error
, error
)
410 weak_alias (__error_at_line
, error_at_line
)