usr/dash/error.h

/*-
 * Copyright (c) 1991, 1993
 *	The Regents of the University of California.  All rights reserved.
 * Copyright (c) 1997-2005
 *	Herbert Xu <herbert@gondor.apana.org.au>.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Kenneth Almquist.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)error.h	8.2 (Berkeley) 5/4/95
 */

#ifndef DASH_ERROR_H
#define DASH_ERROR_H

#include <setjmp.h>
#include <signal.h>

/*
 * Types of operations (passed to the errmsg routine).
 */

#define E_OPEN 01	/* opening a file */
#define E_CREAT 02	/* creating a file */
#define E_EXEC 04	/* executing a program */


/*
 * We enclose jmp_buf in a structure so that we can declare pointers to
 * jump locations.  The global variable handler contains the location to
 * jump to when an exception occurs, and the global variable exception
 * contains a code identifying the exeception.  To implement nested
 * exception handlers, the user should save the value of handler on entry
 * to an inner scope, set handler to point to a jmploc structure for the
 * inner scope, and restore handler on exit from the scope.
 */

struct jmploc {
	jmp_buf loc;
};

extern struct jmploc *handler;
extern int exception;

/* exceptions */
#define EXINT 0		/* SIGINT received */
#define EXERROR 1	/* a generic error */
#define EXSHELLPROC 2	/* execute a shell procedure */
#define EXEXEC 3	/* command execution failed */
#define EXEXIT 4	/* exit the shell */
#define EXSIG 5		/* trapped signal in wait(1) */


/*
 * These macros allow the user to suspend the handling of interrupt signals
 * over a period of time.  This is similar to SIGHOLD to or sigblock, but
 * much more efficient and portable.  (But hacking the kernel is so much
 * more fun than worrying about efficiency and portability. :-))
 */

extern int suppressint;
extern volatile sig_atomic_t intpending;
extern int exsig;

#define barrier() ({ __asm__ __volatile__ ("": : :"memory"); })
#define INTOFF \
	({ \
		suppressint++; \
		barrier(); \
		0; \
	})
#ifdef REALLY_SMALL
void __inton(void);
#define INTON __inton()
#else
#define INTON \
	({ \
		barrier(); \
		if (--suppressint == 0 && intpending) onint(); \
		0; \
	})
#endif
#define FORCEINTON \
	({ \
		barrier(); \
		suppressint = 0; \
		if (intpending) onint(); \
		0; \
	})
#define SAVEINT(v) ((v) = suppressint)
#define RESTOREINT(v) \
	({ \
		barrier(); \
		if ((suppressint = (v)) == 0 && intpending) onint(); \
		0; \
	})
#define CLEAR_PENDING_INT intpending = 0
#define int_pending() intpending
#define EXSIGON() \
	({ \
		exsig++; \
		barrier(); \
		if (pendingsigs) \
			exraise(EXSIG); \
		0; \
	})
/* EXSIG is turned off by evalbltin(). */

void exraise(int) __attribute__((__noreturn__));
#ifdef USE_NORETURN
void onint(void) __attribute__((__noreturn__));
#else
void onint(void);
#endif
void sh_error(const char *, ...) __attribute__((__noreturn__));
void exerror(int, const char *, ...) __attribute__((__noreturn__));
const char *errmsg(int, int);

void sh_warnx(const char *, ...);

#endif		/* DASH_ERROR_H */
1	/*-
2	* Copyright (c) 1991, 1993
3	* The Regents of the University of California. All rights reserved.
4	* Copyright (c) 1997-2005
5	* Herbert Xu <herbert@gondor.apana.org.au>. 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	#ifndef DASH_ERROR_H
38	#define DASH_ERROR_H
39
40	#include <setjmp.h>
41	#include <signal.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	struct jmploc {
63	jmp_buf loc;
64	};
65
66	extern struct jmploc *handler;
67	extern int exception;
68
69	/* exceptions */
70	#define EXINT 0 /* SIGINT received */
71	#define EXERROR 1 /* a generic error */
72	#define EXSHELLPROC 2 /* execute a shell procedure */
73	#define EXEXEC 3 /* command execution failed */
74	#define EXEXIT 4 /* exit the shell */
75	#define EXSIG 5 /* trapped signal in wait(1) */
76
77
78	/*
79	* These macros allow the user to suspend the handling of interrupt signals
80	* over a period of time. This is similar to SIGHOLD to or sigblock, but
81	* much more efficient and portable. (But hacking the kernel is so much
82	* more fun than worrying about efficiency and portability. :-))
83	*/
84
85	extern int suppressint;
86	extern volatile sig_atomic_t intpending;
87	extern int exsig;
88
89	#define barrier() ({ __asm__ __volatile__ ("": : :"memory"); })
90	#define INTOFF \
91	({ \
92	suppressint++; \
93	barrier(); \
94	0; \
95	})
96	#ifdef REALLY_SMALL
97	void __inton(void);
98	#define INTON __inton()
99	#else
100	#define INTON \
101	({ \
102	barrier(); \
103	if (--suppressint == 0 && intpending) onint(); \
104	0; \
105	})
106	#endif
107	#define FORCEINTON \
108	({ \
109	barrier(); \
110	suppressint = 0; \
111	if (intpending) onint(); \
112	0; \
113	})
114	#define SAVEINT(v) ((v) = suppressint)
115	#define RESTOREINT(v) \
116	({ \
117	barrier(); \
118	if ((suppressint = (v)) == 0 && intpending) onint(); \
119	0; \
120	})
121	#define CLEAR_PENDING_INT intpending = 0
122	#define int_pending() intpending
123	#define EXSIGON() \
124	({ \
125	exsig++; \
126	barrier(); \
127	if (pendingsigs) \
128	exraise(EXSIG); \
129	0; \
130	})
131	/* EXSIG is turned off by evalbltin(). */
132
133	void exraise(int) __attribute__((__noreturn__));
134	#ifdef USE_NORETURN
135	void onint(void) __attribute__((__noreturn__));
136	#else
137	void onint(void);
138	#endif
139	void sh_error(const char *, ...) __attribute__((__noreturn__));
140	void exerror(int, const char *, ...) __attribute__((__noreturn__));
141	const char *errmsg(int, int);
142
143	void sh_warnx(const char *, ...);
144
145	#endif /* DASH_ERROR_H */