1 /* $NetBSD: shell.h,v 1.34 2025/02/27 08:39:53 andvar 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 * @(#)shell.h 8.2 (Berkeley) 5/4/95 35 */ 36 37 /* 38 * The follow should be set to reflect the type of system you have: 39 * JOBS -> 1 if you have Berkeley job control, 0 otherwise. 40 * define BSD if you are running 4.2 BSD or later. 41 * define SYSV if you are running under System V. 42 * define DEBUG=1 to compile in debugging ('set -o debug' to turn on) 43 * define DEBUG=2 to compile in and enable debugging. 44 * define DEBUG=3 for DEBUG==2 + enable most standard debug output 45 * define DEBUG=4 for DEBUG==2 + enable absolutely everything 46 * define DO_SHAREDVFORK to indicate that vfork(2) shares its address 47 * with its parent. 48 * define BOGUS_NOT_COMMAND to allow ! reserved words in weird places 49 * (traditional ash behaviour.) 50 * 51 * When debugging is on, debugging info will be written to ./trace and 52 * a quit signal will generate a core dump. 53 */ 54 55 #ifndef SHELL_H 56 #define SHELL_H 57 #include <sys/param.h> 58 59 #define JOBS 1 /* spaces in this line are important, do not alter */ 60 #ifndef BSD 61 #define BSD 1 62 #endif 63 64 #ifndef DO_SHAREDVFORK 65 #if defined(__NetBSD_Version__) && __NetBSD_Version__ >= 104000000 66 #define DO_SHAREDVFORK 67 #endif 68 #endif 69 70 typedef void *pointer; 71 #ifndef NULL 72 #define NULL (void *)0 73 #endif 74 #ifndef STATIC 75 #define STATIC /* empty */ 76 #endif 77 #define MKINIT /* empty */ 78 79 #include <stdbool.h> 80 #include <sys/cdefs.h> 81 82 extern const char nullstr[1]; /* null string */ 83 extern bool privileged; 84 85 #ifdef SMALL 86 #undef DEBUG 87 #endif 88 89 #ifdef DEBUG 90 91 extern uint64_t DFlags; 92 extern int ShNest; 93 94 /* 95 * This is selected as there are 26 letters in ascii - not that that 96 * matters for anything, just makes it easier to assign a different 97 * command letter to each debug option. We currently use only 18 98 * so this could be reduced, but that is of no real benefit. It can also 99 * be increased, but that both limits the maximum value that can be 100 * used with DBG_EXTRAS(), and causes problems with verbose option naming. 101 */ 102 #define DBG_VBOSE_SHIFT 27 103 #define DBG_EXTRAS(n) ((DBG_VBOSE_SHIFT * 2) + (n)) 104 105 /* 106 * Macros to enable tracing, so the maintainer can control 107 * just how much debug output is dumped to the trace file 108 * 109 * In the X forms, "xtra" can be any legal C statement(s) without (bare) commas 110 * executed if the relevant debug flag is enabled, after any tracing output. 111 */ 112 #define CTRACE(when, param) do { \ 113 if ((DFlags & (when)) != 0) \ 114 trace param; \ 115 } while (0) 116 117 #define CCTRACE(when,cond,param) do { \ 118 if ((cond) && (DFlags & (when)) != 0) \ 119 trace param; \ 120 } while (0) 121 122 #define CTRACEV(when, param) do { \ 123 if ((DFlags & (when)) != 0) \ 124 tracev param; \ 125 } while (0) 126 127 #define XTRACE(when, param, xtra) do { \ 128 if ((DFlags & (when)) != 0) { \ 129 trace param; \ 130 xtra; \ 131 } \ 132 } while (0) 133 134 #define VTRACE(when, param) do { \ 135 if ((DFlags & \ 136 (when)<<DBG_VBOSE_SHIFT) != 0) \ 137 trace param; \ 138 } while (0) 139 140 #define CVTRACE(when,cond,param) do { \ 141 if ((cond) && (DFlags & \ 142 (when)<<DBG_VBOSE_SHIFT) != 0) \ 143 trace param; \ 144 } while (0) 145 146 #define VTRACEV(when, param) do { \ 147 if ((DFlags & \ 148 (when)<<DBG_VBOSE_SHIFT) != 0) \ 149 tracev param; \ 150 } while (0) 151 152 #define VXTRACE(when, param, xtra) do { \ 153 if ((DFlags & \ 154 (when)<<DBG_VBOSE_SHIFT) != 0) {\ 155 trace param; \ 156 xtra; \ 157 } \ 158 } while (0) 159 160 #define SHELL_FORKED() ShNest++ 161 #define VFORK_BLOCK { const int _ShNest = ShNest; 162 #define VFORK_END } 163 #define VFORK_UNDO() ShNest = _ShNest 164 165 #define DBG_ALWAYS (1LL << 0) 166 #define DBG_PARSE (1LL << 1) /* r (read commands) */ 167 #define DBG_EVAL (1LL << 2) /* e */ 168 #define DBG_EXPAND (1LL << 3) /* x */ 169 #define DBG_JOBS (1LL << 4) /* j */ 170 #define DBG_PROCS (1LL << 5) /* p */ 171 #define DBG_REDIR (1LL << 6) /* f (fds) */ 172 #define DBG_CMDS (1LL << 7) /* c */ 173 #define DBG_ERRS (1LL << 8) /* z (?) */ 174 #define DBG_WAIT (1LL << 9) /* w */ 175 #define DBG_TRAP (1LL << 10) /* t */ 176 #define DBG_VARS (1LL << 11) /* v */ 177 #define DBG_INPUT (1LL << 12) /* i */ 178 #define DBG_OUTPUT (1LL << 13) /* o */ 179 #define DBG_MEM (1LL << 14) /* m */ 180 #define DBG_ARITH (1LL << 15) /* a */ 181 #define DBG_HISTORY (1LL << 16) /* h */ 182 #define DBG_SIG (1LL << 17) /* s */ 183 #define DBG_MATCH (1LL << 18) /* g (glob) */ 184 #define DBG_LEXER (1LL << 19) /* l */ 185 186 /* 187 * reserved extras: b=builtins y=alias 188 * still free: d k n q u 189 */ 190 191 /* use VTRACE(DBG_ALWAYS, (...)) to test this one */ 192 #define DBG_VERBOSE (1LL << DBG_VBOSE_SHIFT) 193 194 /* DBG_EXTRAS 0 .. 9 (max) only - non-alpha options (no VTRACE !!) */ 195 #define DBG_U0 (1LL << DBG_EXTRAS(0)) /* 0 - ad-hoc extra flags */ 196 #define DBG_U1 (1LL << DBG_EXTRAS(1)) /* 1 - for short term */ 197 #define DBG_U2 (1LL << DBG_EXTRAS(2)) /* 2 - extra tracing */ 198 #define DBG_U3 (1LL << DBG_EXTRAS(3)) /* 3 - when needed */ 199 /* 4, 5, & 6 currently free */ 200 #define DBG_LINE (1LL << DBG_EXTRAS(7)) /* @ ($LINENO) */ 201 #define DBG_PID (1LL << DBG_EXTRAS(8)) /* $ ($$) */ 202 #define DBG_NEST (1LL << DBG_EXTRAS(9)) /* ^ */ 203 204 /* 26 lower case, 26 upper case, always, verbose, and 10 extras: 64 bits */ 205 206 extern void set_debug(const char *, int); 207 208 #else /* DEBUG */ 209 210 #define CTRACE(when, param) /* conditional normal trace */ 211 #define CCTRACE(when, cond, param) /* more conditional normal trace */ 212 #define CTRACEV(when, param) /* conditional varargs trace */ 213 #define XTRACE(when, param, extra) /* conditional trace, plus more */ 214 #define VTRACE(when, param) /* conditional verbose trace */ 215 #define CVTRACE(when, cond, param) /* more conditional verbose trace */ 216 #define VTRACEV(when, param) /* conditional verbose varargs trace */ 217 #define VXTRACE(when, param, extra) /* cond verbose trace, plus more */ 218 219 #define SHELL_FORKED() 220 #define VFORK_BLOCK 221 #define VFORK_END 222 #define VFORK_UNDO() 223 224 #endif /* DEBUG */ 225 226 #endif /* SHELL_H */ 227