gen/FreeBSD/err.c

   1 /*-
   2  * Copyright (c) 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #if defined(LIBC_SCCS) && !defined(lint)
  31 static char sccsid[] = "@(#)err.c       8.1 (Berkeley) 6/4/93";
  32 #endif /* LIBC_SCCS and not lint */
  33 #include <sys/cdefs.h>
  34 __FBSDID("$FreeBSD: src/lib/libc/gen/err.c,v 1.15 2008/04/03 20:36:44 imp Exp $");
  35
  36 #include "namespace.h"
  37 #include <err.h>
  38 #include <errno.h>
  39 #include <stdarg.h>
  40 #include <stdio.h>
  41 #include <stdlib.h>
  42 #include <string.h>
  43 #include <vis.h>
  44 #include "un-namespace.h"
  45
  46 #ifdef __BLOCKS__
  47 #include <Block.h>
  48 #endif /* __BLOCKS__ */
  49 #include "libc_private.h"
  50
  51 #define ERR_EXIT_UNDEF  0
  52 #ifdef __BLOCKS__
  53 #define ERR_EXIT_BLOCK  1
  54 #endif /* __BLOCKS__ */
  55 #define ERR_EXIT_FUNC   2
  56 struct _e_err_exit {
  57         unsigned int type;
  58 #ifdef __BLOCKS__
  59         union {
  60 #endif /* __BLOCKS__ */
  61                 void (*func)(int);
  62 #ifdef __BLOCKS__
  63                 void (^block)(int);
  64         };
  65 #endif /* __BLOCKS__ */
  66 };
  67
  68 #ifdef BUILDING_VARIANT
  69
  70 __private_extern__ FILE *_e_err_file; /* file to use for error output */
  71 __private_extern__ struct _e_err_exit _e_err_exit;
  72 __private_extern__ void _e_visprintf(FILE * __restrict, const char * __restrict, va_list);
  73
  74 #else /* !BUILDING_VARIANT */
  75
  76 __private_extern__ FILE *_e_err_file = NULL; /* file to use for error output */
  77 __private_extern__ struct _e_err_exit _e_err_exit = {ERR_EXIT_UNDEF};
  78
  79 /*
  80  * zero means pass as is
  81  * 255 means use \nnn (octal)
  82  * otherwise use \x (x is value)
  83  * (NUL isn't used)
  84  */
  85 static const unsigned char escape[256] = {
  86      /* NUL */
  87          0, /* Unused: strings can't contain nulls */
  88      /*      SOH  STX  ETX  EOT  ENQ  ACK  BEL */
  89              255, 255, 255, 255, 255, 255, 'a',
  90      /* BS   HT   NL   VT   NP   CR   SO   SI  */
  91         'b',  0,   0,  'v', 'f', 'r', 255, 255,
  92      /* DLE  DC1  DC2  DC3  DC4  NAK  SYN  ETB */
  93         255, 255, 255, 255, 255, 255, 255, 255,
  94      /* CAN  EM   SUB  ESC  FS   GS   RS   US  */
  95         255, 255, 255, 255, 255, 255, 255, 255,
  96      /* the rest are zero */
  97 };
  98
  99 /*
 100  * Make characters visible.  If we can't allocate enough
 101  * memory, we fall back on vfprintf().
 102  */
 103 __private_extern__ void
 104 _e_visprintf(FILE * __restrict stream, const char * __restrict format, va_list ap)
 105 {
 106         int failed = 0;
 107         char *str, *visstr;
 108         va_list backup;
 109
 110         va_copy(backup, ap);
 111         vasprintf(&str, format, ap);
 112         if (str != NULL) {
 113                 if ((visstr = malloc(4 * strlen(str) + 1)) != NULL) {
 114                         unsigned char *fp = (unsigned char *)str;
 115                         unsigned char *tp = (unsigned char *)visstr;
 116                         while(*fp) {
 117                                 switch(escape[*fp]) {
 118                                 case 0:
 119                                         *tp++ = *fp;
 120                                         break;
 121                                 case 255:
 122                                         sprintf((char *)tp, "\\%03o", *fp);
 123                                         tp += 4;
 124                                         break;
 125                                 default:
 126                                         *tp++ = '\\';
 127                                         *tp++ = escape[*fp];
 128                                         break;
 129                                 }
 130                                 fp++;
 131                         }
 132                         *tp = 0;
 133                         fputs(visstr, stream);
 134                         free(visstr);
 135                 } else
 136                         failed = 1;
 137                 free(str);
 138         } else
 139                 failed = 1;
 140         if (failed)
 141                 vfprintf(stream, format, backup);
 142         va_end(backup);
 143 }
 144
 145 /*
 146  * This is declared to take a `void *' so that the caller is not required
 147  * to include <stdio.h> first.  However, it is really a `FILE *', and the
 148  * manual page documents it as such.
 149  */
 150 void
 151 err_set_file(void *fp)
 152 {
 153         if (fp)
 154                 _e_err_file = fp;
 155         else
 156                 _e_err_file = stderr;
 157 }
 158
 159 void
 160 err_set_exit(void (*ef)(int))
 161 {
 162 #ifdef __BLOCKS__
 163         if (_e_err_exit.type == ERR_EXIT_BLOCK) {
 164                 Block_release(_e_err_exit.block);
 165                 _e_err_exit.block = NULL;
 166         }
 167 #endif /* __BLOCKS__ */
 168         _e_err_exit.type = ef ? ERR_EXIT_FUNC : ERR_EXIT_UNDEF;
 169         _e_err_exit.func = ef;
 170 }
 171
 172 #ifdef __BLOCKS__
 173 void
 174 err_set_exit_b(void (^ef)(int))
 175 {
 176         if (_e_err_exit.type == ERR_EXIT_BLOCK) {
 177                 Block_release(_e_err_exit.block);
 178         }
 179         _e_err_exit.type = ef ? ERR_EXIT_BLOCK : ERR_EXIT_UNDEF;
 180         _e_err_exit.block = Block_copy(ef);
 181 }
 182 #endif /* __BLOCKS__ */
 183 #endif /* !BUILDING_VARIANT */
 184
 185 __weak_reference(_err, err);
 186
 187 void
 188 _err(int eval, const char *fmt, ...)
 189 {
 190         va_list ap;
 191         va_start(ap, fmt);
 192         verrc(eval, errno, fmt, ap);
 193         va_end(ap);
 194 }
 195
 196 void
 197 verr(eval, fmt, ap)
 198         int eval;
 199         const char *fmt;
 200         va_list ap;
 201 {
 202         verrc(eval, errno, fmt, ap);
 203 }
 204
 205 void
 206 errc(int eval, int code, const char *fmt, ...)
 207 {
 208         va_list ap;
 209         va_start(ap, fmt);
 210         verrc(eval, code, fmt, ap);
 211         va_end(ap);
 212 }
 213
 214 void
 215 verrc(int eval, int code, const char *fmt, va_list ap)
 216 {
 217         if (_e_err_file == 0)
 218                 err_set_file((FILE *)0);
 219         fprintf(_e_err_file, "%s: ", _getprogname());
 220         if (fmt != NULL) {
 221                 _e_visprintf(_e_err_file, fmt, ap);
 222                 fprintf(_e_err_file, ": ");
 223         }
 224         fprintf(_e_err_file, "%s\n", strerror(code));
 225         if (_e_err_exit.type) {
 226 #ifdef __BLOCKS__
 227                 if (_e_err_exit.type == ERR_EXIT_BLOCK) {
 228                         _e_err_exit.block(eval);
 229                 } else {
 230                         _e_err_exit.func(eval);
 231                 }
 232 #else
 233                 _e_err_exit.func(eval);
 234 #endif /* __BLOCKS__ */
 235         }
 236         exit(eval);
 237 }
 238
 239 void
 240 errx(int eval, const char *fmt, ...)
 241 {
 242         va_list ap;
 243         va_start(ap, fmt);
 244         verrx(eval, fmt, ap);
 245         va_end(ap);
 246 }
 247
 248 void
 249 verrx(int eval, const char *fmt, va_list ap)
 250 {
 251         if (_e_err_file == 0)
 252                 err_set_file((FILE *)0);
 253         fprintf(_e_err_file, "%s: ", _getprogname());
 254         if (fmt != NULL)
 255                 _e_visprintf(_e_err_file, fmt, ap);
 256         fprintf(_e_err_file, "\n");
 257         if (_e_err_exit.type) {
 258 #ifdef __BLOCKS__
 259                 if (_e_err_exit.type == ERR_EXIT_BLOCK) {
 260                         _e_err_exit.block(eval);
 261                 } else {
 262                         _e_err_exit.func(eval);
 263                 }
 264 #else
 265                 _e_err_exit.func(eval);
 266 #endif /* __BLOCKS__ */
 267         }
 268         exit(eval);
 269 }
 270
 271 __weak_reference(_warn, warn);
 272
 273 void
 274 _warn(const char *fmt, ...)
 275 {
 276         va_list ap;
 277         va_start(ap, fmt);
 278         vwarnc(errno, fmt, ap);
 279         va_end(ap);
 280 }
 281
 282 void
 283 vwarn(const char *fmt, va_list ap)
 284 {
 285         vwarnc(errno, fmt, ap);
 286 }
 287
 288 void
 289 warnc(int code, const char *fmt, ...)
 290 {
 291         va_list ap;
 292         va_start(ap, fmt);
 293         vwarnc(code, fmt, ap);
 294         va_end(ap);
 295 }
 296
 297 void
 298 vwarnc(int code, const char *fmt, va_list ap)
 299 {
 300         if (_e_err_file == 0)
 301                 err_set_file((FILE *)0);
 302         fprintf(_e_err_file, "%s: ", _getprogname());
 303         if (fmt != NULL) {
 304                 _e_visprintf(_e_err_file, fmt, ap);
 305                 fprintf(_e_err_file, ": ");
 306         }
 307         fprintf(_e_err_file, "%s\n", strerror(code));
 308 }
 309
 310 void
 311 warnx(const char *fmt, ...)
 312 {
 313         va_list ap;
 314         va_start(ap, fmt);
 315         vwarnx(fmt, ap);
 316         va_end(ap);
 317 }
 318
 319 void
 320 vwarnx(const char *fmt, va_list ap)
 321 {
 322         if (_e_err_file == 0)
 323                 err_set_file((FILE *)0);
 324         fprintf(_e_err_file, "%s: ", _getprogname());
 325         if (fmt != NULL)
 326                 _e_visprintf(_e_err_file, fmt, ap);
 327         fprintf(_e_err_file, "\n");
 328 }