lib/error.c

   1 /* Error handler for noninteractive utilities
   2    Copyright (C) 1990-1998, 2000-2002, 2003 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   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 2, or (at your option)
   8    any later version.
   9
  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.
  14
  15    You should have received a copy of the GNU General Public License along
  16    with this program; if not, write to the Free Software Foundation,
  17    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  18
  19 /* Written by David MacKenzie <djm@gnu.ai.mit.edu>.  */
  20
  21 #ifdef HAVE_CONFIG_H
  22 # include <config.h>
  23 #endif
  24
  25 #include "error.h"
  26
  27 #include <stdarg.h>
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31
  32 #ifdef _LIBC
  33 # include <libintl.h>
  34 #else
  35 # include "gettext.h"
  36 #endif
  37
  38 #ifdef _LIBC
  39 # include <wchar.h>
  40 # define mbsrtowcs __mbsrtowcs
  41 #endif
  42
  43 #if !_LIBC
  44 # include "unlocked-io.h"
  45 #endif
  46
  47 #ifndef _
  48 # define _(String) String
  49 #endif
  50
  51 /* If NULL, error will flush stdout, then print on stderr the program
  52    name, a colon and a space.  Otherwise, error will call this
  53    function without parameters instead.  */
  54 void (*error_print_progname) (void);
  55
  56 /* This variable is incremented each time `error' is called.  */
  57 unsigned int error_message_count;
  58
  59 #ifdef _LIBC
  60 /* In the GNU C library, there is a predefined variable for this.  */
  61
  62 # define program_name program_invocation_name
  63 # include <errno.h>
  64 # include <libio/libioP.h>
  65
  66 /* In GNU libc we want do not want to use the common name `error' directly.
  67    Instead make it a weak alias.  */
  68 extern void __error (int status, int errnum, const char *message, ...)
  69      __attribute__ ((__format__ (__printf__, 3, 4)));
  70 extern void __error_at_line (int status, int errnum, const char *file_name,
  71                              unsigned int line_number, const char *message,
  72                              ...)
  73      __attribute__ ((__format__ (__printf__, 5, 6)));;
  74 # define error __error
  75 # define error_at_line __error_at_line
  76
  77 # include <libio/iolibio.h>
  78 # define fflush(s) INTUSE(_IO_fflush) (s)
  79 # undef putc
  80 # define putc(c, fp) INTUSE(_IO_putc) (c, fp)
  81
  82 # include <bits/libc-lock.h>
  83
  84 #else /* not _LIBC */
  85
  86 # if !HAVE_DECL_STRERROR_R && STRERROR_R_CHAR_P
  87 #  ifndef HAVE_DECL_STRERROR_R
  88 "this configure-time declaration test was not run"
  89 #  endif
  90 char *strerror_r ();
  91 # endif
  92
  93 #ifndef SIZE_MAX
  94 # define SIZE_MAX ((size_t) -1)
  95 #endif
  96
  97 /* The calling program should define program_name and set it to the
  98    name of the executing program.  */
  99 extern char *program_name;
 100
 101 # if HAVE_STRERROR_R || defined strerror_r
 102 #  define __strerror_r strerror_r
 103 # endif
 104 #endif  /* not _LIBC */
 105
 106 static void
 107 print_errno_message (int errnum)
 108 {
 109   char const *s;
 110
 111 #if defined HAVE_STRERROR_R || _LIBC
 112   char errbuf[1024];
 113 # if STRERROR_R_CHAR_P || _LIBC
 114   s = __strerror_r (errnum, errbuf, sizeof errbuf);
 115 # else
 116   if (__strerror_r (errnum, errbuf, sizeof errbuf) == 0)
 117     s = errbuf;
 118   else
 119     s = 0;
 120 # endif
 121 #else
 122   s = strerror (errnum);
 123 #endif
 124
 125 #if !_LIBC
 126   if (! s)
 127     s = _("Unknown system error");
 128 #endif
 129
 130 #if _LIBC
 131   if (_IO_fwide (stderr, 0) > 0)
 132     {
 133       __fwprintf (stderr, L": %s", s);
 134       return;
 135     }
 136 #endif
 137
 138   fprintf (stderr, ": %s", s);
 139 }
 140
 141 static void
 142 error_tail (int status, int errnum, const char *message, va_list args)
 143 {
 144 #if _LIBC
 145   if (_IO_fwide (stderr, 0) > 0)
 146     {
 147 # define ALLOCA_LIMIT 2000
 148       size_t len = strlen (message) + 1;
 149       const wchar_t *wmessage = L"out of memory";
 150       mbstate_t st;
 151       size_t res;
 152       const char *tmp;
 153       wchar_t *wbuf = (len < ALLOCA_LIMIT
 154                        ? (void *) alloca (len * sizeof *wbuf)
 155                        : len <= SIZE_MAX / sizeof *wbuf
 156                        ? malloc (len * sizeof *wbuf)
 157                        : NULL);
 158
 159       if (wbuf)
 160         {
 161           memset (&st, '\0', sizeof (st));
 162           tmp =message;
 163           res = mbsrtowcs (wbuf, &tmp, len, &st);
 164           wmessage = res == (size_t) -1 ? L"???" : wbuf;
 165         }
 166
 167       __vfwprintf (stderr, wmessage, args);
 168       if (! (len < ALLOCA_LIMIT))
 169         free (wbuf);
 170     }
 171   else
 172 #endif
 173     vfprintf (stderr, message, args);
 174   va_end (args);
 175
 176   ++error_message_count;
 177   if (errnum)
 178     print_errno_message (errnum);
 179 #if _LIBC
 180   if (_IO_fwide (stderr, 0) > 0)
 181     putwc (L'\n', stderr);
 182   else
 183 #endif
 184     putc ('\n', stderr);
 185   fflush (stderr);
 186   if (status)
 187     exit (status);
 188 }
 189
 190
 191 /* Print the program name and error message MESSAGE, which is a printf-style
 192    format string with optional args.
 193    If ERRNUM is nonzero, print its corresponding system error message.
 194    Exit with status STATUS if it is nonzero.  */
 195 void
 196 error (int status, int errnum, const char *message, ...)
 197 {
 198   va_list args;
 199
 200 #if defined _LIBC && defined __libc_ptf_call
 201   /* We do not want this call to be cut short by a thread
 202      cancellation.  Therefore disable cancellation for now.  */
 203   int state = PTHREAD_CANCEL_ENABLE;
 204   __libc_ptf_call (pthread_setcancelstate, (PTHREAD_CANCEL_DISABLE, &state),
 205                    0);
 206 #endif
 207
 208   fflush (stdout);
 209 #ifdef _LIBC
 210   _IO_flockfile (stderr);
 211 #endif
 212   if (error_print_progname)
 213     (*error_print_progname) ();
 214   else
 215     {
 216 #if _LIBC
 217       if (_IO_fwide (stderr, 0) > 0)
 218         __fwprintf (stderr, L"%s: ", program_name);
 219       else
 220 #endif
 221         fprintf (stderr, "%s: ", program_name);
 222     }
 223
 224   va_start (args, message);
 225   error_tail (status, errnum, message, args);
 226
 227 #ifdef _LIBC
 228   _IO_funlockfile (stderr);
 229 # ifdef __libc_ptf_call
 230   __libc_ptf_call (pthread_setcancelstate, (state, NULL), 0);
 231 # endif
 232 #endif
 233 }
 234 \f
 235 /* Sometimes we want to have at most one error per line.  This
 236    variable controls whether this mode is selected or not.  */
 237 int error_one_per_line;
 238
 239 void
 240 error_at_line (int status, int errnum, const char *file_name,
 241                unsigned int line_number, const char *message, ...)
 242 {
 243   va_list args;
 244
 245   if (error_one_per_line)
 246     {
 247       static const char *old_file_name;
 248       static unsigned int old_line_number;
 249
 250       if (old_line_number == line_number
 251           && (file_name == old_file_name
 252               || strcmp (old_file_name, file_name) == 0))
 253         /* Simply return and print nothing.  */
 254         return;
 255
 256       old_file_name = file_name;
 257       old_line_number = line_number;
 258     }
 259
 260 #if defined _LIBC && defined __libc_ptf_call
 261   /* We do not want this call to be cut short by a thread
 262      cancellation.  Therefore disable cancellation for now.  */
 263   int state = PTHREAD_CANCEL_ENABLE;
 264   __libc_ptf_call (pthread_setcancelstate, (PTHREAD_CANCEL_DISABLE, &state),
 265                    0);
 266 #endif
 267
 268   fflush (stdout);
 269 #ifdef _LIBC
 270   _IO_flockfile (stderr);
 271 #endif
 272   if (error_print_progname)
 273     (*error_print_progname) ();
 274   else
 275     {
 276 #if _LIBC
 277       if (_IO_fwide (stderr, 0) > 0)
 278         __fwprintf (stderr, L"%s: ", program_name);
 279       else
 280 #endif
 281         fprintf (stderr, "%s:", program_name);
 282     }
 283
 284   if (file_name != NULL)
 285     {
 286 #if _LIBC
 287       if (_IO_fwide (stderr, 0) > 0)
 288         __fwprintf (stderr, L"%s:%d: ", file_name, line_number);
 289       else
 290 #endif
 291         fprintf (stderr, "%s:%d: ", file_name, line_number);
 292     }
 293
 294   va_start (args, message);
 295   error_tail (status, errnum, message, args);
 296
 297 #ifdef _LIBC
 298   _IO_funlockfile (stderr);
 299 # ifdef __libc_ptf_call
 300   __libc_ptf_call (pthread_setcancelstate, (state, NULL), 0);
 301 # endif
 302 #endif
 303 }
 304
 305 #ifdef _LIBC
 306 /* Make the weak alias.  */
 307 # undef error
 308 # undef error_at_line
 309 weak_alias (__error, error)
 310 weak_alias (__error_at_line, error_at_line)
 311 #endif