Home | History | Annotate | Line # | Download | only in sh
error.h revision 1.15 
      1 /*	$NetBSD: error.h,v 1.15 2002/11/24 22:35:39 christos Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1991, 1993
      5  *	The Regents of the University of California.  All rights reserved.
      6  *
      7  * This code is derived from software contributed to Berkeley by
      8  * Kenneth Almquist.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *	This product includes software developed by the University of
     21  *	California, Berkeley and its contributors.
     22  * 4. Neither the name of the University nor the names of its contributors
     23  *    may be used to endorse or promote products derived from this software
     24  *    without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     36  * SUCH DAMAGE.
     37  *
     38  *	@(#)error.h	8.2 (Berkeley) 5/4/95
     39  */
     40 
     41 #include <stdarg.h>
     42 
     43 /*
     44  * Types of operations (passed to the errmsg routine).
     45  */
     46 
     47 #define E_OPEN 01	/* opening a file */
     48 #define E_CREAT 02	/* creating a file */
     49 #define E_EXEC 04	/* executing a program */
     50 
     51 
     52 /*
     53  * We enclose jmp_buf in a structure so that we can declare pointers to
     54  * jump locations.  The global variable handler contains the location to
     55  * jump to when an exception occurs, and the global variable exception
     56  * contains a code identifying the exeception.  To implement nested
     57  * exception handlers, the user should save the value of handler on entry
     58  * to an inner scope, set handler to point to a jmploc structure for the
     59  * inner scope, and restore handler on exit from the scope.
     60  */
     61 
     62 #include <setjmp.h>
     63 
     64 struct jmploc {
     65 	jmp_buf loc;
     66 };
     67 
     68 extern struct jmploc *handler;
     69 extern int exception;
     70 extern int exerrno;	/* error for EXEXEC */
     71 
     72 /* exceptions */
     73 #define EXINT 0		/* SIGINT received */
     74 #define EXERROR 1	/* a generic error */
     75 #define EXSHELLPROC 2	/* execute a shell procedure */
     76 #define EXEXEC 3	/* command execution failed */
     77 
     78 
     79 /*
     80  * These macros allow the user to suspend the handling of interrupt signals
     81  * over a period of time.  This is similar to SIGHOLD to or sigblock, but
     82  * much more efficient and portable.  (But hacking the kernel is so much
     83  * more fun than worrying about efficiency and portability. :-))
     84  */
     85 
     86 extern volatile int suppressint;
     87 extern volatile int intpending;
     88 
     89 #define INTOFF suppressint++
     90 #define INTON { if (--suppressint == 0 && intpending) onint(); }
     91 #define FORCEINTON {suppressint = 0; if (intpending) onint();}
     92 #define CLEAR_PENDING_INT intpending = 0
     93 #define int_pending() intpending
     94 
     95 void exraise(int) __attribute__((__noreturn__));
     96 void onint(void);
     97 void error(const char *, ...) __attribute__((__noreturn__));
     98 void exerror(int, const char *, ...) __attribute__((__noreturn__));
     99 const char *errmsg(int, int);
    100 
    101 void sh_err(int, const char *, ...) __attribute__((__noreturn__));
    102 void sh_verr(int, const char *, va_list) __attribute__((__noreturn__));
    103 void sh_errx(int, const char *, ...) __attribute__((__noreturn__));
    104 void sh_verrx(int, const char *, va_list) __attribute__((__noreturn__));
    105 void sh_warn(const char *, ...);
    106 void sh_vwarn(const char *, va_list);
    107 void sh_warnx(const char *, ...);
    108 void sh_vwarnx(const char *, va_list);
    109 
    110 void sh_exit(int) __attribute__((__noreturn__));
    111 
    112 
    113 /*
    114  * BSD setjmp saves the signal mask, which violates ANSI C and takes time,
    115  * so we use _setjmp instead.
    116  */
    117 
    118 #if defined(BSD) && !defined(__SVR4)
    119 #define setjmp(jmploc)	_setjmp(jmploc)
    120 #define longjmp(jmploc, val)	_longjmp(jmploc, val)
    121 #endif
    122