Home | History | Annotate | Line # | Download | only in sh 
      1 /*	$NetBSD: error.h,v 1.25 2023/03/21 08:31:30 hannken 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. Neither the name of the University nor the names of its contributors
     19  *    may be used to endorse or promote products derived from this software
     20  *    without specific prior written permission.
     21  *
     22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     32  * SUCH DAMAGE.
     33  *
     34  *	@(#)error.h	8.2 (Berkeley) 5/4/95
     35  */
     36 
     37 #include <stdarg.h>
     38 
     39 /*
     40  * Types of operations (passed to the errmsg routine).
     41  */
     42 
     43 #define E_OPEN		0x1	/* opening a file */
     44 #define E_CREAT		0x2	/* creating a file */
     45 #define E_EXEC		0x4	/* executing a program */
     46 
     47 
     48 /*
     49  * We enclose jmp_buf in a structure so that we can declare pointers to
     50  * jump locations.  The global variable handler contains the location to
     51  * jump to when an exception occurs, and the global variable exception
     52  * contains a code identifying the exeception.  To implement nested
     53  * exception handlers, the user should save the value of handler on entry
     54  * to an inner scope, set handler to point to a jmploc structure for the
     55  * inner scope, and restore handler on exit from the scope.
     56  */
     57 
     58 #include <setjmp.h>
     59 
     60 struct jmploc {
     61 	sigjmp_buf loc;
     62 };
     63 
     64 extern volatile int errors_suppressed;
     65 extern const char * volatile currentcontext;
     66 
     67 extern struct jmploc *handler;
     68 extern int exception;
     69 extern int exerrno;	/* error for EXEXEC */
     70 
     71 /* exceptions */
     72 #define EXINT 0		/* SIGINT received */
     73 #define EXERROR 1	/* a generic error */
     74 #define EXSHELLPROC 2	/* execute a shell procedure */
     75 #define EXEXEC 3	/* command execution failed */
     76 #define EXEXIT 4	/* shell wants to exit(exitstatus) */
     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 do { if (--suppressint == 0 && intpending) onint(); } while (0)
     91 #define FORCEINTON do { suppressint = 0; if (intpending) onint(); } while (0)
     92 #define CLEAR_PENDING_INT (intpending = 0)
     93 #define int_pending() intpending
     94 
     95 #if ! defined(SHELL_BUILTIN)
     96 void exraise(int) __dead;
     97 void onint(void);
     98 void error(const char *, ...) __dead __printflike(1, 2);
     99 void exerror(int, const char *, ...) __dead __printflike(2, 3);
    100 const char *errmsg(int, int);
    101 #endif /* ! SHELL_BUILTIN */
    102 
    103 void sh_err(int, const char *, ...) __dead __printflike(2, 3);
    104 void sh_verr(int, const char *, va_list) __dead __printflike(2, 0);
    105 void sh_errx(int, const char *, ...) __dead __printflike(2, 3);
    106 void sh_verrx(int, const char *, va_list) __dead __printflike(2, 0);
    107 void sh_warn(const char *, ...) __printflike(1, 2);
    108 void sh_vwarn(const char *, va_list) __printflike(1, 0);
    109 void sh_warnx(const char *, ...) __printflike(1, 2);
    110 void sh_vwarnx(const char *, va_list) __printflike(1, 0);
    111 
    112 void sh_exit(int) __dead;
    113 
    114 
    115 /*
    116  * BSD setjmp saves the signal mask, which violates ANSI C and takes time,
    117  * so we use sigsetjmp instead, and explicitly do not save it.
    118  * sh does a lot of setjmp() calls (fewer longjmp though).
    119  */
    120 
    121 #define setjmp(jmploc)		sigsetjmp((jmploc), 0)
    122 #define longjmp(jmploc, val)	siglongjmp((jmploc), (val))
    123