1 /* vi: set sw=4 ts=4: */
3 * A prototype Bourne shell grammar parser.
4 * Intended to follow the original Thompson and Ritchie
5 * "small and simple is beautiful" philosophy, which
6 * incidentally is a good match to today's BusyBox.
8 * Copyright (C) 2000,2001 Larry Doolittle <larry@doolittle.boa.org>
9 * Copyright (C) 2008,2009 Denys Vlasenko <vda.linux@googlemail.com>
11 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
14 * The parser routines proper are all original material, first
15 * written Dec 2000 and Jan 2001 by Larry Doolittle. The
16 * execution engine, the builtins, and much of the underlying
17 * support has been adapted from busybox-0.49pre's lash, which is
18 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
19 * written by Erik Andersen <andersen@codepoet.org>. That, in turn,
20 * is based in part on ladsh.c, by Michael K. Johnson and Erik W.
21 * Troan, which they placed in the public domain. I don't know
22 * how much of the Johnson/Troan code has survived the repeated
26 * o_addchr derived from similar w_addchar function in glibc-2.2.
27 * parse_redirect, redirect_opt_num, and big chunks of main
28 * and many builtins derived from contributions by Erik Andersen.
29 * Miscellaneous bugfixes from Matt Kraai.
31 * There are two big (and related) architecture differences between
32 * this parser and the lash parser. One is that this version is
33 * actually designed from the ground up to understand nearly all
34 * of the Bourne grammar. The second, consequential change is that
35 * the parser and input reader have been turned inside out. Now,
36 * the parser is in control, and asks for input as needed. The old
37 * way had the input reader in control, and it asked for parsing to
38 * take place as needed. The new way makes it much easier to properly
39 * handle the recursion implicit in the various substitutions, especially
40 * across continuation lines.
43 * grep for "TODO" and fix (some of them are easy)
44 * make complex ${var%...} constructs support optional
45 * make here documents optional
46 * special variables (done: PWD, PPID, RANDOM)
47 * follow IFS rules more precisely, including update semantics
50 * builtins mandated by standards we don't support:
51 * [un]alias, command, fc, getopts, times:
52 * command -v CMD: print "/path/to/CMD"
53 * prints "CMD" for builtins
54 * prints "alias ALIAS='EXPANSION'" for aliases
55 * prints nothing and sets $? to 1 if not found
56 * command -V CMD: print "CMD is /path/CMD|a shell builtin|etc"
57 * command [-p] CMD: run CMD, even if a function CMD also exists
58 * (can use this to override standalone shell as well)
59 * -p: use default $PATH
60 * command BLTIN: disables special-ness (e.g. errors do not abort)
61 * getopts: getopt() for shells
62 * times: print getrusage(SELF/CHILDREN).ru_utime/ru_stime
63 * fc -l[nr] [BEG] [END]: list range of commands in history
64 * fc [-e EDITOR] [BEG] [END]: edit/rerun range of commands
65 * fc -s [PAT=REP] [CMD]: rerun CMD, replacing PAT with REP
68 * redirection of stdout+stderr: &> and >&
69 * reserved words: function select
70 * advanced test: [[ ]]
71 * process substitution: <(list) and >(list)
74 * Each EXPR is an arithmetic expression (ARITHMETIC EVALUATION)
75 * If the last arg evaluates to 0, let returns 1; 0 otherwise.
76 * NB: let `echo 'a=a + 1'` - error (IOW: multi-word expansion is used)
78 * The EXPR is evaluated according to ARITHMETIC EVALUATION.
79 * This is exactly equivalent to let "EXPR".
80 * $[EXPR]: synonym for $((EXPR))
81 * indirect expansion: ${!VAR}
82 * substring op on @: ${@:n:m}
85 * Some builtins mandated by standards:
86 * newgrp [GRP]: not a builtin in bash but a suid binary
87 * which spawns a new shell with new group ID
88 * In bash, export builtin is special, its arguments are assignments
89 * and therefore expansion of them should be "one-word" expansion:
90 * $ export i=`echo 'a b'` # export has one arg: "i=a b"
92 * $ ls i=`echo 'a b'` # ls has two args: "i=a" and "b"
93 * ls: cannot access i=a: No such file or directory
94 * ls: cannot access b: No such file or directory
95 * Note1: same applies to local builtin.
96 * Note2: bash 3.2.33(1) does this only if export word itself
98 * $ export i=`echo 'aaa bbb'`; echo "$i"
100 * $ "export" i=`echo 'aaa bbb'`; echo "$i"
104 //config: bool "hush (64 kb)"
107 //config: hush is a small shell. It handles the normal flow control
108 //config: constructs such as if/then/elif/else/fi, for/in/do/done, while loops,
109 //config: case/esac. Redirections, here documents, $((arithmetic))
110 //config: and functions are supported.
112 //config: It will compile and work on no-mmu systems.
114 //config: It does not handle select, aliases, tilde expansion,
115 //config: &>file and >&file redirection of stdout+stderr.
117 //config:config HUSH_BASH_COMPAT
118 //config: bool "bash-compatible extensions"
120 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
122 //config:config HUSH_BRACE_EXPANSION
123 //config: bool "Brace expansion"
125 //config: depends on HUSH_BASH_COMPAT
127 //config: Enable {abc,def} extension.
129 //config:config HUSH_INTERACTIVE
130 //config: bool "Interactive mode"
132 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
134 //config: Enable interactive mode (prompt and command editing).
135 //config: Without this, hush simply reads and executes commands
136 //config: from stdin just like a shell script from a file.
137 //config: No prompt, no PS1/PS2 magic shell variables.
139 //config:config HUSH_SAVEHISTORY
140 //config: bool "Save command history to .hush_history"
142 //config: depends on HUSH_INTERACTIVE && FEATURE_EDITING_SAVEHISTORY
144 //config:config HUSH_JOB
145 //config: bool "Job control"
147 //config: depends on HUSH_INTERACTIVE
149 //config: Enable job control: Ctrl-Z backgrounds, Ctrl-C interrupts current
150 //config: command (not entire shell), fg/bg builtins work. Without this option,
151 //config: "cmd &" still works by simply spawning a process and immediately
152 //config: prompting for next command (or executing next command in a script),
153 //config: but no separate process group is formed.
155 //config:config HUSH_TICK
156 //config: bool "Support process substitution"
158 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
160 //config: Enable `command` and $(command).
162 //config:config HUSH_IF
163 //config: bool "Support if/then/elif/else/fi"
165 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
167 //config:config HUSH_LOOPS
168 //config: bool "Support for, while and until loops"
170 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
172 //config:config HUSH_CASE
173 //config: bool "Support case ... esac statement"
175 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
177 //config: Enable case ... esac statement. +400 bytes.
179 //config:config HUSH_FUNCTIONS
180 //config: bool "Support funcname() { commands; } syntax"
182 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
184 //config: Enable support for shell functions. +800 bytes.
186 //config:config HUSH_LOCAL
187 //config: bool "local builtin"
189 //config: depends on HUSH_FUNCTIONS
191 //config: Enable support for local variables in functions.
193 //config:config HUSH_RANDOM_SUPPORT
194 //config: bool "Pseudorandom generator and $RANDOM variable"
196 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
198 //config: Enable pseudorandom generator and dynamic variable "$RANDOM".
199 //config: Each read of "$RANDOM" will generate a new pseudorandom value.
201 //config:config HUSH_MODE_X
202 //config: bool "Support 'hush -x' option and 'set -x' command"
204 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
206 //config: This instructs hush to print commands before execution.
207 //config: Adds ~300 bytes.
209 //config:config HUSH_ECHO
210 //config: bool "echo builtin"
212 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
214 //config:config HUSH_PRINTF
215 //config: bool "printf builtin"
217 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
219 //config:config HUSH_TEST
220 //config: bool "test builtin"
222 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
224 //config:config HUSH_HELP
225 //config: bool "help builtin"
227 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
229 //config:config HUSH_EXPORT
230 //config: bool "export builtin"
232 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
234 //config:config HUSH_EXPORT_N
235 //config: bool "Support 'export -n' option"
237 //config: depends on HUSH_EXPORT
239 //config: export -n unexports variables. It is a bash extension.
241 //config:config HUSH_READONLY
242 //config: bool "readonly builtin"
244 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
246 //config: Enable support for read-only variables.
248 //config:config HUSH_KILL
249 //config: bool "kill builtin (supports kill %jobspec)"
251 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
253 //config:config HUSH_WAIT
254 //config: bool "wait builtin"
256 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
258 //config:config HUSH_TRAP
259 //config: bool "trap builtin"
261 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
263 //config:config HUSH_TYPE
264 //config: bool "type builtin"
266 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
268 //config:config HUSH_READ
269 //config: bool "read builtin"
271 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
273 //config:config HUSH_SET
274 //config: bool "set builtin"
276 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
278 //config:config HUSH_UNSET
279 //config: bool "unset builtin"
281 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
283 //config:config HUSH_ULIMIT
284 //config: bool "ulimit builtin"
286 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
288 //config:config HUSH_UMASK
289 //config: bool "umask builtin"
291 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
293 //config:config HUSH_MEMLEAK
294 //config: bool "memleak builtin (debugging)"
296 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
298 //applet:IF_HUSH(APPLET(hush, BB_DIR_BIN, BB_SUID_DROP))
299 // APPLET_ODDNAME:name main location suid_type help
300 //applet:IF_SH_IS_HUSH( APPLET_ODDNAME(sh, hush, BB_DIR_BIN, BB_SUID_DROP, hush))
301 //applet:IF_BASH_IS_HUSH(APPLET_ODDNAME(bash, hush, BB_DIR_BIN, BB_SUID_DROP, hush))
303 //kbuild:lib-$(CONFIG_HUSH) += hush.o match.o shell_common.o
304 //kbuild:lib-$(CONFIG_SH_IS_HUSH) += hush.o match.o shell_common.o
305 //kbuild:lib-$(CONFIG_BASH_IS_HUSH) += hush.o match.o shell_common.o
306 //kbuild:lib-$(CONFIG_HUSH_RANDOM_SUPPORT) += random.o
308 /* -i (interactive) and -s (read stdin) are also accepted,
309 * but currently do nothing, therefore aren't shown in help.
310 * NOMMU-specific options are not meant to be used by users,
311 * therefore we don't show them either.
313 //usage:#define hush_trivial_usage
314 //usage: "[-enxl] [-c 'SCRIPT' [ARG0 [ARGS]] / FILE [ARGS]]"
315 //usage:#define hush_full_usage "\n\n"
316 //usage: "Unix shell interpreter"
318 #if !(defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
319 || defined(__APPLE__) \
321 # include <malloc.h> /* for malloc_trim */
324 /* #include <dmalloc.h> */
326 # include <fnmatch.h>
328 #include <sys/utsname.h> /* for setting $HOSTNAME */
330 #include "busybox.h" /* for APPLET_IS_NOFORK/NOEXEC */
332 #include "shell_common.h"
335 #if ENABLE_HUSH_RANDOM_SUPPORT
338 # define CLEAR_RANDOM_T(rnd) ((void)0)
340 #ifndef F_DUPFD_CLOEXEC
341 # define F_DUPFD_CLOEXEC F_DUPFD
344 # define PIPE_BUF 4096 /* amount of buffering in a pipe */
348 /* So far, all bash compat is controlled by one config option */
349 /* Separate defines document which part of code implements what */
350 #define BASH_PATTERN_SUBST ENABLE_HUSH_BASH_COMPAT
351 #define BASH_SUBSTR ENABLE_HUSH_BASH_COMPAT
352 #define BASH_SOURCE ENABLE_HUSH_BASH_COMPAT
353 #define BASH_HOSTNAME_VAR ENABLE_HUSH_BASH_COMPAT
354 #define BASH_TEST2 (ENABLE_HUSH_BASH_COMPAT && ENABLE_HUSH_TEST)
358 #define LEAK_HUNTING 0
359 #define BUILD_AS_NOMMU 0
360 /* Enable/disable sanity checks. Ok to enable in production,
361 * only adds a bit of bloat. Set to >1 to get non-production level verbosity.
362 * Keeping 1 for now even in released versions.
365 /* Slightly bigger (+200 bytes), but faster hush.
366 * So far it only enables a trick with counting SIGCHLDs and forks,
367 * which allows us to do fewer waitpid's.
368 * (we can detect a case where neither forks were done nor SIGCHLDs happened
369 * and therefore waitpid will return the same result as last time)
371 #define ENABLE_HUSH_FAST 0
372 /* TODO: implement simplified code for users which do not need ${var%...} ops
373 * So far ${var%...} ops are always enabled:
375 #define ENABLE_HUSH_DOLLAR_OPS 1
380 # undef USE_FOR_NOMMU
383 # define USE_FOR_NOMMU(...) __VA_ARGS__
384 # define USE_FOR_MMU(...)
387 #include "NUM_APPLETS.h"
389 /* STANDALONE does not make sense, and won't compile */
390 # undef CONFIG_FEATURE_SH_STANDALONE
391 # undef ENABLE_FEATURE_SH_STANDALONE
392 # undef IF_FEATURE_SH_STANDALONE
393 # undef IF_NOT_FEATURE_SH_STANDALONE
394 # define ENABLE_FEATURE_SH_STANDALONE 0
395 # define IF_FEATURE_SH_STANDALONE(...)
396 # define IF_NOT_FEATURE_SH_STANDALONE(...) __VA_ARGS__
399 #if !ENABLE_HUSH_INTERACTIVE
400 # undef ENABLE_FEATURE_EDITING
401 # define ENABLE_FEATURE_EDITING 0
402 # undef ENABLE_FEATURE_EDITING_FANCY_PROMPT
403 # define ENABLE_FEATURE_EDITING_FANCY_PROMPT 0
404 # undef ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
405 # define ENABLE_FEATURE_EDITING_SAVE_ON_EXIT 0
408 /* Do we support ANY keywords? */
409 #if ENABLE_HUSH_IF || ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
410 # define HAS_KEYWORDS 1
411 # define IF_HAS_KEYWORDS(...) __VA_ARGS__
412 # define IF_HAS_NO_KEYWORDS(...)
414 # define HAS_KEYWORDS 0
415 # define IF_HAS_KEYWORDS(...)
416 # define IF_HAS_NO_KEYWORDS(...) __VA_ARGS__
419 /* If you comment out one of these below, it will be #defined later
420 * to perform debug printfs to stderr: */
421 #define debug_printf(...) do {} while (0)
422 /* Finer-grained debug switches */
423 #define debug_printf_parse(...) do {} while (0)
424 #define debug_print_tree(a, b) do {} while (0)
425 #define debug_printf_exec(...) do {} while (0)
426 #define debug_printf_env(...) do {} while (0)
427 #define debug_printf_jobs(...) do {} while (0)
428 #define debug_printf_expand(...) do {} while (0)
429 #define debug_printf_varexp(...) do {} while (0)
430 #define debug_printf_glob(...) do {} while (0)
431 #define debug_printf_redir(...) do {} while (0)
432 #define debug_printf_list(...) do {} while (0)
433 #define debug_printf_subst(...) do {} while (0)
434 #define debug_printf_clean(...) do {} while (0)
436 #define ERR_PTR ((void*)(long)1)
438 #define JOB_STATUS_FORMAT "[%u] %-22s %.40s\n"
440 #define _SPECIAL_VARS_STR "_*@$!?#"
441 #define SPECIAL_VARS_STR ("_*@$!?#" + 1)
442 #define NUMERIC_SPECVARS_STR ("_*@$!?#" + 3)
443 #if BASH_PATTERN_SUBST
444 /* Support / and // replace ops */
445 /* Note that // is stored as \ in "encoded" string representation */
446 # define VAR_ENCODED_SUBST_OPS "\\/%#:-=+?"
447 # define VAR_SUBST_OPS ("\\/%#:-=+?" + 1)
448 # define MINUS_PLUS_EQUAL_QUESTION ("\\/%#:-=+?" + 5)
450 # define VAR_ENCODED_SUBST_OPS "%#:-=+?"
451 # define VAR_SUBST_OPS "%#:-=+?"
452 # define MINUS_PLUS_EQUAL_QUESTION ("%#:-=+?" + 3)
455 #define SPECIAL_VAR_SYMBOL 3
459 static const char hush_version_str[] ALIGN1 = "HUSH_VERSION="BB_VER;
461 /* This supports saving pointers malloced in vfork child,
462 * to be freed in the parent.
465 typedef struct nommu_save_t {
467 struct variable *old_vars;
469 char **argv_from_re_execing;
482 #if ENABLE_HUSH_LOOPS
489 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
494 /* three pseudo-keywords support contrived "case" syntax: */
495 RES_CASE_IN, /* "case ... IN", turns into RES_MATCH when IN is observed */
496 RES_MATCH , /* "word)" */
497 RES_CASE_BODY, /* "this command is inside CASE" */
504 typedef struct o_string {
506 int length; /* position where data is appended */
509 /* At least some part of the string was inside '' or "",
510 * possibly empty one: word"", wo''rd etc. */
511 smallint has_quoted_part;
512 smallint has_empty_slot;
513 smallint o_assignment; /* 0:maybe, 1:yes, 2:no */
516 EXP_FLAG_SINGLEWORD = 0x80, /* must be 0x80 */
518 /* Protect newly added chars against globbing
519 * by prepending \ to *, ?, [, \ */
520 EXP_FLAG_ESC_GLOB_CHARS = 0x1,
523 MAYBE_ASSIGNMENT = 0,
524 DEFINITELY_ASSIGNMENT = 1,
526 /* Not an assignment, but next word may be: "if v=xyz cmd;" */
529 /* Used for initialization: o_string foo = NULL_O_STRING; */
530 #define NULL_O_STRING { NULL }
532 #ifndef debug_printf_parse
533 static const char *const assignment_flag[] = {
535 "DEFINITELY_ASSIGNMENT",
541 typedef struct in_str {
543 #if ENABLE_HUSH_INTERACTIVE
544 smallint promptmode; /* 0: PS1, 1: PS2 */
551 /* The descrip member of this structure is only used to make
552 * debugging output pretty */
553 static const struct {
555 signed char default_fd;
558 { O_RDONLY, 0, "<" },
559 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
560 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
561 { O_CREAT|O_RDWR, 1, "<>" },
562 { O_RDONLY, 0, "<<" },
563 /* Should not be needed. Bogus default_fd helps in debugging */
564 /* { O_RDONLY, 77, "<<" }, */
567 struct redir_struct {
568 struct redir_struct *next;
569 char *rd_filename; /* filename */
570 int rd_fd; /* fd to redirect */
571 /* fd to redirect to, or -3 if rd_fd is to be closed (n>&-) */
573 smallint rd_type; /* (enum redir_type) */
574 /* note: for heredocs, rd_filename contains heredoc delimiter,
575 * and subsequently heredoc itself; and rd_dup is a bitmask:
576 * bit 0: do we need to trim leading tabs?
577 * bit 1: is heredoc quoted (<<'delim' syntax) ?
580 typedef enum redir_type {
582 REDIRECT_OVERWRITE = 1,
585 REDIRECT_HEREDOC = 4,
586 REDIRECT_HEREDOC2 = 5, /* REDIRECT_HEREDOC after heredoc is loaded */
589 REDIRFD_SYNTAX_ERR = -2,
590 REDIRFD_TO_FILE = -1,
591 /* otherwise, rd_fd is redirected to rd_dup */
593 HEREDOC_SKIPTABS = 1,
599 pid_t pid; /* 0 if exited */
600 int assignment_cnt; /* how many argv[i] are assignments? */
601 smallint cmd_type; /* CMD_xxx */
603 #define CMD_SUBSHELL 1
605 /* used for "[[ EXPR ]]" */
606 # define CMD_SINGLEWORD_NOGLOB 2
608 #if ENABLE_HUSH_FUNCTIONS
609 # define CMD_FUNCDEF 3
612 smalluint cmd_exitcode;
613 /* if non-NULL, this "command" is { list }, ( list ), or a compound statement */
616 char *group_as_string;
618 #if ENABLE_HUSH_FUNCTIONS
619 struct function *child_func;
620 /* This field is used to prevent a bug here:
621 * while...do f1() {a;}; f1; f1() {b;}; f1; done
622 * When we execute "f1() {a;}" cmd, we create new function and clear
623 * cmd->group, cmd->group_as_string, cmd->argv[0].
624 * When we execute "f1() {b;}", we notice that f1 exists,
625 * and that its "parent cmd" struct is still "alive",
626 * we put those fields back into cmd->xxx
627 * (struct function has ->parent_cmd ptr to facilitate that).
628 * When we loop back, we can execute "f1() {a;}" again and set f1 correctly.
629 * Without this trick, loop would execute a;b;b;b;...
630 * instead of correct sequence a;b;a;b;...
631 * When command is freed, it severs the link
632 * (sets ->child_func->parent_cmd to NULL).
635 char **argv; /* command name and arguments */
636 /* argv vector may contain variable references (^Cvar^C, ^C0^C etc)
637 * and on execution these are substituted with their values.
638 * Substitution can make _several_ words out of one argv[n]!
639 * Example: argv[0]=='.^C*^C.' here: echo .$*.
640 * References of the form ^C`cmd arg^C are `cmd arg` substitutions.
642 struct redir_struct *redirects; /* I/O redirections */
644 /* Is there anything in this command at all? */
645 #define IS_NULL_CMD(cmd) \
646 (!(cmd)->group && !(cmd)->argv && !(cmd)->redirects)
650 int num_cmds; /* total number of commands in pipe */
651 int alive_cmds; /* number of commands running (not exited) */
652 int stopped_cmds; /* number of commands alive, but stopped */
654 unsigned jobid; /* job number */
655 pid_t pgrp; /* process group ID for the job */
656 char *cmdtext; /* name of job */
658 struct command *cmds; /* array of commands in pipe */
659 smallint followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
660 IF_HAS_KEYWORDS(smallint pi_inverted;) /* "! cmd | cmd" */
661 IF_HAS_KEYWORDS(smallint res_word;) /* needed for if, for, while, until... */
663 typedef enum pipe_style {
669 /* Is there anything in this pipe at all? */
670 #define IS_NULL_PIPE(pi) \
671 ((pi)->num_cmds == 0 IF_HAS_KEYWORDS( && (pi)->res_word == RES_NONE))
673 /* This holds pointers to the various results of parsing */
674 struct parse_context {
675 /* linked list of pipes */
676 struct pipe *list_head;
677 /* last pipe (being constructed right now) */
679 /* last command in pipe (being constructed right now) */
680 struct command *command;
681 /* last redirect in command->redirects list */
682 struct redir_struct *pending_redirect;
688 smallint ctx_inverted; /* "! cmd | cmd" */
690 smallint ctx_dsemicolon; /* ";;" seen */
692 /* bitmask of FLAG_xxx, for figuring out valid reserved words */
694 /* group we are enclosed in:
695 * example: "if pipe1; pipe2; then pipe3; fi"
696 * when we see "if" or "then", we malloc and copy current context,
697 * and make ->stack point to it. then we parse pipeN.
698 * when closing "then" / fi" / whatever is found,
699 * we move list_head into ->stack->command->group,
700 * copy ->stack into current context, and delete ->stack.
701 * (parsing of { list } and ( list ) doesn't use this method)
703 struct parse_context *stack;
707 /* On program start, environ points to initial environment.
708 * putenv adds new pointers into it, unsetenv removes them.
709 * Neither of these (de)allocates the strings.
710 * setenv allocates new strings in malloc space and does putenv,
711 * and thus setenv is unusable (leaky) for shell's purposes */
712 #define setenv(...) setenv_is_leaky_dont_use()
714 struct variable *next;
715 char *varstr; /* points to "name=" portion */
716 #if ENABLE_HUSH_LOCAL
717 unsigned func_nest_level;
719 int max_len; /* if > 0, name is part of initial env; else name is malloced */
720 smallint flg_export; /* putenv should be done on this var */
721 smallint flg_read_only;
729 #if ENABLE_HUSH_FUNCTIONS
731 struct function *next;
733 struct command *parent_cmd;
736 char *body_as_string;
742 /* set -/+o OPT support. (TODO: make it optional)
743 * bash supports the following opts:
754 * interactive-comments on
772 static const char o_opt_strings[] ALIGN1 =
776 #if ENABLE_HUSH_MODE_X
784 #if ENABLE_HUSH_MODE_X
792 struct FILE_list *next;
798 /* "Globals" within this file */
799 /* Sorted roughly by size (smaller offsets == smaller code) */
801 /* interactive_fd != 0 means we are an interactive shell.
802 * If we are, then saved_tty_pgrp can also be != 0, meaning
803 * that controlling tty is available. With saved_tty_pgrp == 0,
804 * job control still works, but terminal signals
805 * (^C, ^Z, ^Y, ^\) won't work at all, and background
806 * process groups can only be created with "cmd &".
807 * With saved_tty_pgrp != 0, hush will use tcsetpgrp()
808 * to give tty to the foreground process group,
809 * and will take it back when the group is stopped (^Z)
812 #if ENABLE_HUSH_INTERACTIVE
813 /* 'interactive_fd' is a fd# open to ctty, if we have one
814 * _AND_ if we decided to act interactively */
818 # define G_interactive_fd (G.interactive_fd)
820 # define G_interactive_fd 0
822 #if ENABLE_FEATURE_EDITING
823 line_input_t *line_input_state;
828 #if ENABLE_HUSH_RANDOM_SUPPORT
834 pid_t saved_tty_pgrp;
835 struct pipe *job_list;
836 # define G_saved_tty_pgrp (G.saved_tty_pgrp)
838 # define G_saved_tty_pgrp 0
840 /* How deeply are we in context where "set -e" is ignored */
842 /* "set -e" rules (do we follow them correctly?):
843 * Exit if pipe, list, or compound command exits with a non-zero status.
844 * Shell does not exit if failed command is part of condition in
845 * if/while, part of && or || list except the last command, any command
846 * in a pipe but the last, or if the command's return value is being
847 * inverted with !. If a compound command other than a subshell returns a
848 * non-zero status because a command failed while -e was being ignored, the
849 * shell does not exit. A trap on ERR, if set, is executed before the shell
850 * exits [ERR is a bashism].
852 * If a compound command or function executes in a context where -e is
853 * ignored, none of the commands executed within are affected by the -e
854 * setting. If a compound command or function sets -e while executing in a
855 * context where -e is ignored, that setting does not have any effect until
856 * the compound command or the command containing the function call completes.
859 char o_opt[NUM_OPT_O];
860 #if ENABLE_HUSH_MODE_X
861 # define G_x_mode (G.o_opt[OPT_O_XTRACE])
865 smallint flag_SIGINT;
866 #if ENABLE_HUSH_LOOPS
867 smallint flag_break_continue;
869 #if ENABLE_HUSH_FUNCTIONS
870 /* 0: outside of a function (or sourced file)
871 * -1: inside of a function, ok to use return builtin
872 * 1: return is invoked, skip all till end of func
874 smallint flag_return_in_progress;
875 # define G_flag_return_in_progress (G.flag_return_in_progress)
877 # define G_flag_return_in_progress 0
879 smallint exiting; /* used to prevent EXIT trap recursion */
880 /* These four support $?, $#, and $1 */
881 smalluint last_exitcode;
882 smalluint last_bg_pid_exitcode;
884 /* are global_argv and global_argv[1..n] malloced? (note: not [0]) */
885 smalluint global_args_malloced;
886 # define G_global_args_malloced (G.global_args_malloced)
888 # define G_global_args_malloced 0
890 /* how many non-NULL argv's we have. NB: $# + 1 */
894 char *argv0_for_re_execing;
896 #if ENABLE_HUSH_LOOPS
897 unsigned depth_break_continue;
898 unsigned depth_of_loop;
902 struct variable *top_var;
903 char **expanded_assignments;
904 #if ENABLE_HUSH_FUNCTIONS
905 struct function *top_func;
906 # if ENABLE_HUSH_LOCAL
907 struct variable **shadowed_vars_pp;
908 unsigned func_nest_level;
911 /* Signal and trap handling */
913 unsigned count_SIGCHLD;
914 unsigned handled_SIGCHLD;
915 smallint we_have_children;
917 struct FILE_list *FILE_list;
918 /* Which signals have non-DFL handler (even with no traps set)?
919 * Set at the start to:
920 * (SIGQUIT + maybe SPECIAL_INTERACTIVE_SIGS + maybe SPECIAL_JOBSTOP_SIGS)
921 * SPECIAL_INTERACTIVE_SIGS are cleared after fork.
922 * The rest is cleared right before execv syscalls.
923 * Other than these two times, never modified.
925 unsigned special_sig_mask;
927 unsigned fatal_sig_mask;
928 # define G_fatal_sig_mask (G.fatal_sig_mask)
930 # define G_fatal_sig_mask 0
933 char **traps; /* char *traps[NSIG] */
934 # define G_traps G.traps
936 # define G_traps ((char**)NULL)
938 sigset_t pending_set;
939 #if ENABLE_HUSH_MEMLEAK
940 unsigned long memleak_value;
946 #if ENABLE_FEATURE_EDITING
947 char user_input_buf[CONFIG_FEATURE_EDITING_MAX_LEN];
950 #define G (*ptr_to_globals)
951 /* Not #defining name to G.name - this quickly gets unwieldy
952 * (too many defines). Also, I actually prefer to see when a variable
953 * is global, thus "G." prefix is a useful hint */
954 #define INIT_G() do { \
955 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
956 /* memset(&G.sa, 0, sizeof(G.sa)); */ \
957 sigfillset(&G.sa.sa_mask); \
958 G.sa.sa_flags = SA_RESTART; \
962 /* Function prototypes for builtins */
963 static int builtin_cd(char **argv) FAST_FUNC;
965 static int builtin_echo(char **argv) FAST_FUNC;
967 static int builtin_eval(char **argv) FAST_FUNC;
968 static int builtin_exec(char **argv) FAST_FUNC;
969 static int builtin_exit(char **argv) FAST_FUNC;
970 #if ENABLE_HUSH_EXPORT
971 static int builtin_export(char **argv) FAST_FUNC;
973 #if ENABLE_HUSH_READONLY
974 static int builtin_readonly(char **argv) FAST_FUNC;
977 static int builtin_fg_bg(char **argv) FAST_FUNC;
978 static int builtin_jobs(char **argv) FAST_FUNC;
981 static int builtin_help(char **argv) FAST_FUNC;
983 #if MAX_HISTORY && ENABLE_FEATURE_EDITING
984 static int builtin_history(char **argv) FAST_FUNC;
986 #if ENABLE_HUSH_LOCAL
987 static int builtin_local(char **argv) FAST_FUNC;
989 #if ENABLE_HUSH_MEMLEAK
990 static int builtin_memleak(char **argv) FAST_FUNC;
992 #if ENABLE_HUSH_PRINTF
993 static int builtin_printf(char **argv) FAST_FUNC;
995 static int builtin_pwd(char **argv) FAST_FUNC;
997 static int builtin_read(char **argv) FAST_FUNC;
1000 static int builtin_set(char **argv) FAST_FUNC;
1002 static int builtin_shift(char **argv) FAST_FUNC;
1003 static int builtin_source(char **argv) FAST_FUNC;
1004 #if ENABLE_HUSH_TEST || BASH_TEST2
1005 static int builtin_test(char **argv) FAST_FUNC;
1007 #if ENABLE_HUSH_TRAP
1008 static int builtin_trap(char **argv) FAST_FUNC;
1010 #if ENABLE_HUSH_TYPE
1011 static int builtin_type(char **argv) FAST_FUNC;
1013 static int builtin_true(char **argv) FAST_FUNC;
1014 #if ENABLE_HUSH_UMASK
1015 static int builtin_umask(char **argv) FAST_FUNC;
1017 #if ENABLE_HUSH_UNSET
1018 static int builtin_unset(char **argv) FAST_FUNC;
1020 #if ENABLE_HUSH_KILL
1021 static int builtin_kill(char **argv) FAST_FUNC;
1023 #if ENABLE_HUSH_WAIT
1024 static int builtin_wait(char **argv) FAST_FUNC;
1026 #if ENABLE_HUSH_LOOPS
1027 static int builtin_break(char **argv) FAST_FUNC;
1028 static int builtin_continue(char **argv) FAST_FUNC;
1030 #if ENABLE_HUSH_FUNCTIONS
1031 static int builtin_return(char **argv) FAST_FUNC;
1034 /* Table of built-in functions. They can be forked or not, depending on
1035 * context: within pipes, they fork. As simple commands, they do not.
1036 * When used in non-forking context, they can change global variables
1037 * in the parent shell process. If forked, of course they cannot.
1038 * For example, 'unset foo | whatever' will parse and run, but foo will
1039 * still be set at the end. */
1040 struct built_in_command {
1042 int (*b_function)(char **argv) FAST_FUNC;
1043 #if ENABLE_HUSH_HELP
1044 const char *b_descr;
1045 # define BLTIN(cmd, func, help) { cmd, func, help }
1047 # define BLTIN(cmd, func, help) { cmd, func }
1051 static const struct built_in_command bltins1[] = {
1052 BLTIN("." , builtin_source , "Run commands in file"),
1053 BLTIN(":" , builtin_true , NULL),
1055 BLTIN("bg" , builtin_fg_bg , "Resume job in background"),
1057 #if ENABLE_HUSH_LOOPS
1058 BLTIN("break" , builtin_break , "Exit loop"),
1060 BLTIN("cd" , builtin_cd , "Change directory"),
1061 #if ENABLE_HUSH_LOOPS
1062 BLTIN("continue" , builtin_continue, "Start new loop iteration"),
1064 BLTIN("eval" , builtin_eval , "Construct and run shell command"),
1065 BLTIN("exec" , builtin_exec , "Execute command, don't return to shell"),
1066 BLTIN("exit" , builtin_exit , NULL),
1067 #if ENABLE_HUSH_EXPORT
1068 BLTIN("export" , builtin_export , "Set environment variables"),
1071 BLTIN("fg" , builtin_fg_bg , "Bring job to foreground"),
1073 #if ENABLE_HUSH_HELP
1074 BLTIN("help" , builtin_help , NULL),
1076 #if MAX_HISTORY && ENABLE_FEATURE_EDITING
1077 BLTIN("history" , builtin_history , "Show history"),
1080 BLTIN("jobs" , builtin_jobs , "List jobs"),
1082 #if ENABLE_HUSH_KILL
1083 BLTIN("kill" , builtin_kill , "Send signals to processes"),
1085 #if ENABLE_HUSH_LOCAL
1086 BLTIN("local" , builtin_local , "Set local variables"),
1088 #if ENABLE_HUSH_MEMLEAK
1089 BLTIN("memleak" , builtin_memleak , NULL),
1091 #if ENABLE_HUSH_READ
1092 BLTIN("read" , builtin_read , "Input into variable"),
1094 #if ENABLE_HUSH_READONLY
1095 BLTIN("readonly" , builtin_readonly, "Make variables read-only"),
1097 #if ENABLE_HUSH_FUNCTIONS
1098 BLTIN("return" , builtin_return , "Return from function"),
1101 BLTIN("set" , builtin_set , "Set positional parameters"),
1103 BLTIN("shift" , builtin_shift , "Shift positional parameters"),
1105 BLTIN("source" , builtin_source , NULL),
1107 #if ENABLE_HUSH_TRAP
1108 BLTIN("trap" , builtin_trap , "Trap signals"),
1110 BLTIN("true" , builtin_true , NULL),
1111 #if ENABLE_HUSH_TYPE
1112 BLTIN("type" , builtin_type , "Show command type"),
1114 #if ENABLE_HUSH_ULIMIT
1115 BLTIN("ulimit" , shell_builtin_ulimit, "Control resource limits"),
1117 #if ENABLE_HUSH_UMASK
1118 BLTIN("umask" , builtin_umask , "Set file creation mask"),
1120 #if ENABLE_HUSH_UNSET
1121 BLTIN("unset" , builtin_unset , "Unset variables"),
1123 #if ENABLE_HUSH_WAIT
1124 BLTIN("wait" , builtin_wait , "Wait for process to finish"),
1127 /* These builtins won't be used if we are on NOMMU and need to re-exec
1128 * (it's cheaper to run an external program in this case):
1130 static const struct built_in_command bltins2[] = {
1131 #if ENABLE_HUSH_TEST
1132 BLTIN("[" , builtin_test , NULL),
1135 BLTIN("[[" , builtin_test , NULL),
1137 #if ENABLE_HUSH_ECHO
1138 BLTIN("echo" , builtin_echo , NULL),
1140 #if ENABLE_HUSH_PRINTF
1141 BLTIN("printf" , builtin_printf , NULL),
1143 BLTIN("pwd" , builtin_pwd , NULL),
1144 #if ENABLE_HUSH_TEST
1145 BLTIN("test" , builtin_test , NULL),
1153 /* prevent disasters with G.debug_indent < 0 */
1154 # define indent() fdprintf(2, "%*s", (G.debug_indent * 2) & 0xff, "")
1155 # define debug_enter() (G.debug_indent++)
1156 # define debug_leave() (G.debug_indent--)
1158 # define indent() ((void)0)
1159 # define debug_enter() ((void)0)
1160 # define debug_leave() ((void)0)
1163 #ifndef debug_printf
1164 # define debug_printf(...) (indent(), fdprintf(2, __VA_ARGS__))
1167 #ifndef debug_printf_parse
1168 # define debug_printf_parse(...) (indent(), fdprintf(2, __VA_ARGS__))
1171 #ifndef debug_printf_exec
1172 #define debug_printf_exec(...) (indent(), fdprintf(2, __VA_ARGS__))
1175 #ifndef debug_printf_env
1176 # define debug_printf_env(...) (indent(), fdprintf(2, __VA_ARGS__))
1179 #ifndef debug_printf_jobs
1180 # define debug_printf_jobs(...) (indent(), fdprintf(2, __VA_ARGS__))
1181 # define DEBUG_JOBS 1
1183 # define DEBUG_JOBS 0
1186 #ifndef debug_printf_expand
1187 # define debug_printf_expand(...) (indent(), fdprintf(2, __VA_ARGS__))
1188 # define DEBUG_EXPAND 1
1190 # define DEBUG_EXPAND 0
1193 #ifndef debug_printf_varexp
1194 # define debug_printf_varexp(...) (indent(), fdprintf(2, __VA_ARGS__))
1197 #ifndef debug_printf_glob
1198 # define debug_printf_glob(...) (indent(), fdprintf(2, __VA_ARGS__))
1199 # define DEBUG_GLOB 1
1201 # define DEBUG_GLOB 0
1204 #ifndef debug_printf_redir
1205 # define debug_printf_redir(...) (indent(), fdprintf(2, __VA_ARGS__))
1208 #ifndef debug_printf_list
1209 # define debug_printf_list(...) (indent(), fdprintf(2, __VA_ARGS__))
1212 #ifndef debug_printf_subst
1213 # define debug_printf_subst(...) (indent(), fdprintf(2, __VA_ARGS__))
1216 #ifndef debug_printf_clean
1217 # define debug_printf_clean(...) (indent(), fdprintf(2, __VA_ARGS__))
1218 # define DEBUG_CLEAN 1
1220 # define DEBUG_CLEAN 0
1224 static void debug_print_strings(const char *prefix, char **vv)
1227 fdprintf(2, "%s:\n", prefix);
1229 fdprintf(2, " '%s'\n", *vv++);
1232 # define debug_print_strings(prefix, vv) ((void)0)
1236 /* Leak hunting. Use hush_leaktool.sh for post-processing.
1239 static void *xxmalloc(int lineno, size_t size)
1241 void *ptr = xmalloc((size + 0xff) & ~0xff);
1242 fdprintf(2, "line %d: malloc %p\n", lineno, ptr);
1245 static void *xxrealloc(int lineno, void *ptr, size_t size)
1247 ptr = xrealloc(ptr, (size + 0xff) & ~0xff);
1248 fdprintf(2, "line %d: realloc %p\n", lineno, ptr);
1251 static char *xxstrdup(int lineno, const char *str)
1253 char *ptr = xstrdup(str);
1254 fdprintf(2, "line %d: strdup %p\n", lineno, ptr);
1257 static void xxfree(void *ptr)
1259 fdprintf(2, "free %p\n", ptr);
1262 # define xmalloc(s) xxmalloc(__LINE__, s)
1263 # define xrealloc(p, s) xxrealloc(__LINE__, p, s)
1264 # define xstrdup(s) xxstrdup(__LINE__, s)
1265 # define free(p) xxfree(p)
1269 /* Syntax and runtime errors. They always abort scripts.
1270 * In interactive use they usually discard unparsed and/or unexecuted commands
1271 * and return to the prompt.
1272 * HUSH_DEBUG >= 2 prints line number in this file where it was detected.
1275 # define die_if_script(lineno, ...) die_if_script(__VA_ARGS__)
1276 # define syntax_error(lineno, msg) syntax_error(msg)
1277 # define syntax_error_at(lineno, msg) syntax_error_at(msg)
1278 # define syntax_error_unterm_ch(lineno, ch) syntax_error_unterm_ch(ch)
1279 # define syntax_error_unterm_str(lineno, s) syntax_error_unterm_str(s)
1280 # define syntax_error_unexpected_ch(lineno, ch) syntax_error_unexpected_ch(ch)
1283 static void die_if_script(unsigned lineno, const char *fmt, ...)
1288 bb_error_msg("hush.c:%u", lineno);
1291 bb_verror_msg(fmt, p, NULL);
1293 if (!G_interactive_fd)
1297 static void syntax_error(unsigned lineno UNUSED_PARAM, const char *msg)
1300 bb_error_msg("syntax error: %s", msg);
1302 bb_error_msg("syntax error");
1305 static void syntax_error_at(unsigned lineno UNUSED_PARAM, const char *msg)
1307 bb_error_msg("syntax error at '%s'", msg);
1310 static void syntax_error_unterm_str(unsigned lineno UNUSED_PARAM, const char *s)
1312 bb_error_msg("syntax error: unterminated %s", s);
1315 static void syntax_error_unterm_ch(unsigned lineno, char ch)
1317 char msg[2] = { ch, '\0' };
1318 syntax_error_unterm_str(lineno, msg);
1321 static void syntax_error_unexpected_ch(unsigned lineno UNUSED_PARAM, int ch)
1327 bb_error_msg("hush.c:%u", lineno);
1329 bb_error_msg("syntax error: unexpected %s", ch == EOF ? "EOF" : msg);
1333 # undef die_if_script
1334 # undef syntax_error
1335 # undef syntax_error_at
1336 # undef syntax_error_unterm_ch
1337 # undef syntax_error_unterm_str
1338 # undef syntax_error_unexpected_ch
1340 # define die_if_script(...) die_if_script(__LINE__, __VA_ARGS__)
1341 # define syntax_error(msg) syntax_error(__LINE__, msg)
1342 # define syntax_error_at(msg) syntax_error_at(__LINE__, msg)
1343 # define syntax_error_unterm_ch(ch) syntax_error_unterm_ch(__LINE__, ch)
1344 # define syntax_error_unterm_str(s) syntax_error_unterm_str(__LINE__, s)
1345 # define syntax_error_unexpected_ch(ch) syntax_error_unexpected_ch(__LINE__, ch)
1349 #if ENABLE_HUSH_INTERACTIVE
1350 static void cmdedit_update_prompt(void);
1352 # define cmdedit_update_prompt() ((void)0)
1356 /* Utility functions
1358 /* Replace each \x with x in place, return ptr past NUL. */
1359 static char *unbackslash(char *src)
1361 char *dst = src = strchrnul(src, '\\');
1365 if ((*dst++ = *src++) == '\0')
1371 static char **add_strings_to_strings(char **strings, char **add, int need_to_dup)
1392 v = xrealloc(strings, (count1 + count2 + 1) * sizeof(char*));
1393 v[count1 + count2] = NULL;
1396 v[count1 + i] = (need_to_dup ? xstrdup(add[i]) : add[i]);
1400 static char **xx_add_strings_to_strings(int lineno, char **strings, char **add, int need_to_dup)
1402 char **ptr = add_strings_to_strings(strings, add, need_to_dup);
1403 fdprintf(2, "line %d: add_strings_to_strings %p\n", lineno, ptr);
1406 #define add_strings_to_strings(strings, add, need_to_dup) \
1407 xx_add_strings_to_strings(__LINE__, strings, add, need_to_dup)
1410 /* Note: takes ownership of "add" ptr (it is not strdup'ed) */
1411 static char **add_string_to_strings(char **strings, char *add)
1416 return add_strings_to_strings(strings, v, /*dup:*/ 0);
1419 static char **xx_add_string_to_strings(int lineno, char **strings, char *add)
1421 char **ptr = add_string_to_strings(strings, add);
1422 fdprintf(2, "line %d: add_string_to_strings %p\n", lineno, ptr);
1425 #define add_string_to_strings(strings, add) \
1426 xx_add_string_to_strings(__LINE__, strings, add)
1429 static void free_strings(char **strings)
1443 static int fcntl_F_DUPFD(int fd, int avoid_fd)
1447 newfd = fcntl(fd, F_DUPFD, avoid_fd + 1);
1457 static int xdup_and_close(int fd, int F_DUPFD_maybe_CLOEXEC, int avoid_fd)
1461 newfd = fcntl(fd, F_DUPFD_maybe_CLOEXEC, avoid_fd + 1);
1467 /* fd was not open? */
1477 /* Manipulating the list of open FILEs */
1478 static FILE *remember_FILE(FILE *fp)
1481 struct FILE_list *n = xmalloc(sizeof(*n));
1482 n->next = G.FILE_list;
1486 close_on_exec_on(n->fd);
1490 static void fclose_and_forget(FILE *fp)
1492 struct FILE_list **pp = &G.FILE_list;
1494 struct FILE_list *cur = *pp;
1495 if (cur->fp == fp) {
1504 static int save_FILEs_on_redirect(int fd, int avoid_fd)
1506 struct FILE_list *fl = G.FILE_list;
1509 /* We use it only on script files, they are all CLOEXEC */
1510 fl->fd = xdup_and_close(fd, F_DUPFD_CLOEXEC, avoid_fd);
1511 debug_printf_redir("redirect_fd %d: matches a script fd, moving it to %d\n", fd, fl->fd);
1518 static void restore_redirected_FILEs(void)
1520 struct FILE_list *fl = G.FILE_list;
1522 int should_be = fileno(fl->fp);
1523 if (fl->fd != should_be) {
1524 debug_printf_redir("restoring script fd from %d to %d\n", fl->fd, should_be);
1525 xmove_fd(fl->fd, should_be);
1531 #if ENABLE_FEATURE_SH_STANDALONE && BB_MMU
1532 static void close_all_FILE_list(void)
1534 struct FILE_list *fl = G.FILE_list;
1536 /* fclose would also free FILE object.
1537 * It is disastrous if we share memory with a vforked parent.
1538 * I'm not sure we never come here after vfork.
1539 * Therefore just close fd, nothing more.
1541 /*fclose(fl->fp); - unsafe */
1549 /* Helpers for setting new $n and restoring them back
1551 typedef struct save_arg_t {
1555 IF_HUSH_SET(smallint sv_g_malloced;)
1558 static void save_and_replace_G_args(save_arg_t *sv, char **argv)
1560 sv->sv_argv0 = argv[0];
1561 sv->sv_g_argv = G.global_argv;
1562 sv->sv_g_argc = G.global_argc;
1563 IF_HUSH_SET(sv->sv_g_malloced = G.global_args_malloced;)
1565 argv[0] = G.global_argv[0]; /* retain $0 */
1566 G.global_argv = argv;
1567 IF_HUSH_SET(G.global_args_malloced = 0;)
1569 G.global_argc = 1 + string_array_len(argv + 1);
1572 static void restore_G_args(save_arg_t *sv, char **argv)
1575 if (G.global_args_malloced) {
1576 /* someone ran "set -- arg1 arg2 ...", undo */
1577 char **pp = G.global_argv;
1578 while (*++pp) /* note: does not free $0 */
1580 free(G.global_argv);
1583 argv[0] = sv->sv_argv0;
1584 G.global_argv = sv->sv_g_argv;
1585 G.global_argc = sv->sv_g_argc;
1586 IF_HUSH_SET(G.global_args_malloced = sv->sv_g_malloced;)
1590 /* Basic theory of signal handling in shell
1591 * ========================================
1592 * This does not describe what hush does, rather, it is current understanding
1593 * what it _should_ do. If it doesn't, it's a bug.
1594 * http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
1596 * Signals are handled only after each pipe ("cmd | cmd | cmd" thing)
1597 * is finished or backgrounded. It is the same in interactive and
1598 * non-interactive shells, and is the same regardless of whether
1599 * a user trap handler is installed or a shell special one is in effect.
1600 * ^C or ^Z from keyboard seems to execute "at once" because it usually
1601 * backgrounds (i.e. stops) or kills all members of currently running
1604 * Wait builtin is interruptible by signals for which user trap is set
1605 * or by SIGINT in interactive shell.
1607 * Trap handlers will execute even within trap handlers. (right?)
1609 * User trap handlers are forgotten when subshell ("(cmd)") is entered,
1610 * except for handlers set to '' (empty string).
1612 * If job control is off, backgrounded commands ("cmd &")
1613 * have SIGINT, SIGQUIT set to SIG_IGN.
1615 * Commands which are run in command substitution ("`cmd`")
1616 * have SIGTTIN, SIGTTOU, SIGTSTP set to SIG_IGN.
1618 * Ordinary commands have signals set to SIG_IGN/DFL as inherited
1619 * by the shell from its parent.
1621 * Signals which differ from SIG_DFL action
1622 * (note: child (i.e., [v]forked) shell is not an interactive shell):
1625 * SIGTERM (interactive): ignore
1626 * SIGHUP (interactive):
1627 * send SIGCONT to stopped jobs, send SIGHUP to all jobs and exit
1628 * SIGTTIN, SIGTTOU, SIGTSTP (if job control is on): ignore
1629 * Note that ^Z is handled not by trapping SIGTSTP, but by seeing
1630 * that all pipe members are stopped. Try this in bash:
1631 * while :; do :; done - ^Z does not background it
1632 * (while :; do :; done) - ^Z backgrounds it
1633 * SIGINT (interactive): wait for last pipe, ignore the rest
1634 * of the command line, show prompt. NB: ^C does not send SIGINT
1635 * to interactive shell while shell is waiting for a pipe,
1636 * since shell is bg'ed (is not in foreground process group).
1637 * Example 1: this waits 5 sec, but does not execute ls:
1638 * "echo $$; sleep 5; ls -l" + "kill -INT <pid>"
1639 * Example 2: this does not wait and does not execute ls:
1640 * "echo $$; sleep 5 & wait; ls -l" + "kill -INT <pid>"
1641 * Example 3: this does not wait 5 sec, but executes ls:
1642 * "sleep 5; ls -l" + press ^C
1643 * Example 4: this does not wait and does not execute ls:
1644 * "sleep 5 & wait; ls -l" + press ^C
1646 * (What happens to signals which are IGN on shell start?)
1647 * (What happens with signal mask on shell start?)
1649 * Old implementation
1650 * ==================
1651 * We use in-kernel pending signal mask to determine which signals were sent.
1652 * We block all signals which we don't want to take action immediately,
1653 * i.e. we block all signals which need to have special handling as described
1654 * above, and all signals which have traps set.
1655 * After each pipe execution, we extract any pending signals via sigtimedwait()
1658 * unsigned special_sig_mask: a mask of such "special" signals
1659 * sigset_t blocked_set: current blocked signal set
1662 * clear bit in blocked_set unless it is also in special_sig_mask
1663 * "trap 'cmd' SIGxxx":
1664 * set bit in blocked_set (even if 'cmd' is '')
1665 * after [v]fork, if we plan to be a shell:
1666 * unblock signals with special interactive handling
1667 * (child shell is not interactive),
1668 * unset all traps except '' (note: regardless of child shell's type - {}, (), etc)
1669 * after [v]fork, if we plan to exec:
1670 * POSIX says fork clears pending signal mask in child - no need to clear it.
1671 * Restore blocked signal set to one inherited by shell just prior to exec.
1673 * Note: as a result, we do not use signal handlers much. The only uses
1674 * are to count SIGCHLDs
1675 * and to restore tty pgrp on signal-induced exit.
1678 * Standard says "When a subshell is entered, traps that are not being ignored
1679 * are set to the default actions". bash interprets it so that traps which
1680 * are set to '' (ignore) are NOT reset to defaults. We do the same.
1682 * Problem: the above approach makes it unwieldy to catch signals while
1683 * we are in read builtin, or while we read commands from stdin:
1684 * masked signals are not visible!
1686 * New implementation
1687 * ==================
1688 * We record each signal we are interested in by installing signal handler
1689 * for them - a bit like emulating kernel pending signal mask in userspace.
1690 * We are interested in: signals which need to have special handling
1691 * as described above, and all signals which have traps set.
1692 * Signals are recorded in pending_set.
1693 * After each pipe execution, we extract any pending signals
1696 * unsigned special_sig_mask: a mask of shell-special signals.
1697 * unsigned fatal_sig_mask: a mask of signals on which we restore tty pgrp.
1698 * char *traps[sig] if trap for sig is set (even if it's '').
1699 * sigset_t pending_set: set of sigs we received.
1702 * if sig is in special_sig_mask, set handler back to:
1703 * record_pending_signo, or to IGN if it's a tty stop signal
1704 * if sig is in fatal_sig_mask, set handler back to sigexit.
1705 * else: set handler back to SIG_DFL
1706 * "trap 'cmd' SIGxxx":
1707 * set handler to record_pending_signo.
1709 * set handler to SIG_IGN.
1710 * after [v]fork, if we plan to be a shell:
1711 * set signals with special interactive handling to SIG_DFL
1712 * (because child shell is not interactive),
1713 * unset all traps except '' (note: regardless of child shell's type - {}, (), etc)
1714 * after [v]fork, if we plan to exec:
1715 * POSIX says fork clears pending signal mask in child - no need to clear it.
1717 * To make wait builtin interruptible, we handle SIGCHLD as special signal,
1718 * otherwise (if we leave it SIG_DFL) sigsuspend in wait builtin will not wake up on it.
1721 * Standard says "When a subshell is entered, traps that are not being ignored
1722 * are set to the default actions". bash interprets it so that traps which
1723 * are set to '' (ignore) are NOT reset to defaults. We do the same.
1726 SPECIAL_INTERACTIVE_SIGS = 0
1731 SPECIAL_JOBSTOP_SIGS = 0
1740 static void record_pending_signo(int sig)
1742 sigaddset(&G.pending_set, sig);
1743 #if ENABLE_HUSH_FAST
1744 if (sig == SIGCHLD) {
1746 //bb_error_msg("[%d] SIGCHLD_handler: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1751 static sighandler_t install_sighandler(int sig, sighandler_t handler)
1753 struct sigaction old_sa;
1755 /* We could use signal() to install handlers... almost:
1756 * except that we need to mask ALL signals while handlers run.
1757 * I saw signal nesting in strace, race window isn't small.
1758 * SA_RESTART is also needed, but in Linux, signal()
1759 * sets SA_RESTART too.
1761 /* memset(&G.sa, 0, sizeof(G.sa)); - already done */
1762 /* sigfillset(&G.sa.sa_mask); - already done */
1763 /* G.sa.sa_flags = SA_RESTART; - already done */
1764 G.sa.sa_handler = handler;
1765 sigaction(sig, &G.sa, &old_sa);
1766 return old_sa.sa_handler;
1769 static void hush_exit(int exitcode) NORETURN;
1771 static void restore_ttypgrp_and__exit(void) NORETURN;
1772 static void restore_ttypgrp_and__exit(void)
1774 /* xfunc has failed! die die die */
1775 /* no EXIT traps, this is an escape hatch! */
1777 hush_exit(xfunc_error_retval);
1782 /* Needed only on some libc:
1783 * It was observed that on exit(), fgetc'ed buffered data
1784 * gets "unwound" via lseek(fd, -NUM, SEEK_CUR).
1785 * With the net effect that even after fork(), not vfork(),
1786 * exit() in NOEXECed applet in "sh SCRIPT":
1787 * noexec_applet_here
1788 * echo END_OF_SCRIPT
1789 * lseeks fd in input FILE object from EOF to "e" in "echo END_OF_SCRIPT".
1790 * This makes "echo END_OF_SCRIPT" executed twice.
1791 * Similar problems can be seen with die_if_script() -> xfunc_die()
1792 * and in `cmd` handling.
1793 * If set as die_func(), this makes xfunc_die() exit via _exit(), not exit():
1795 static void fflush_and__exit(void) NORETURN;
1796 static void fflush_and__exit(void)
1799 _exit(xfunc_error_retval);
1802 /* After [v]fork, in child: do not restore tty pgrp on xfunc death */
1803 # define disable_restore_tty_pgrp_on_exit() (die_func = fflush_and__exit)
1804 /* After [v]fork, in parent: restore tty pgrp on xfunc death */
1805 # define enable_restore_tty_pgrp_on_exit() (die_func = restore_ttypgrp_and__exit)
1807 /* Restores tty foreground process group, and exits.
1808 * May be called as signal handler for fatal signal
1809 * (will resend signal to itself, producing correct exit state)
1810 * or called directly with -EXITCODE.
1811 * We also call it if xfunc is exiting.
1813 static void sigexit(int sig) NORETURN;
1814 static void sigexit(int sig)
1816 /* Careful: we can end up here after [v]fork. Do not restore
1817 * tty pgrp then, only top-level shell process does that */
1818 if (G_saved_tty_pgrp && getpid() == G.root_pid) {
1819 /* Disable all signals: job control, SIGPIPE, etc.
1820 * Mostly paranoid measure, to prevent infinite SIGTTOU.
1822 sigprocmask_allsigs(SIG_BLOCK);
1823 tcsetpgrp(G_interactive_fd, G_saved_tty_pgrp);
1826 /* Not a signal, just exit */
1830 kill_myself_with_sig(sig); /* does not return */
1834 # define disable_restore_tty_pgrp_on_exit() ((void)0)
1835 # define enable_restore_tty_pgrp_on_exit() ((void)0)
1839 static sighandler_t pick_sighandler(unsigned sig)
1841 sighandler_t handler = SIG_DFL;
1842 if (sig < sizeof(unsigned)*8) {
1843 unsigned sigmask = (1 << sig);
1847 if (G_fatal_sig_mask & sigmask)
1851 /* sig has special handling? */
1852 if (G.special_sig_mask & sigmask) {
1853 handler = record_pending_signo;
1854 /* TTIN/TTOU/TSTP can't be set to record_pending_signo
1855 * in order to ignore them: they will be raised
1856 * in an endless loop when we try to do some
1857 * terminal ioctls! We do have to _ignore_ these.
1859 if (SPECIAL_JOBSTOP_SIGS & sigmask)
1866 /* Restores tty foreground process group, and exits. */
1867 static void hush_exit(int exitcode)
1869 #if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1870 save_history(G.line_input_state);
1874 if (G.exiting <= 0 && G_traps && G_traps[0] && G_traps[0][0]) {
1876 /* argv[0] is unused */
1877 argv[1] = G_traps[0];
1879 G.exiting = 1; /* prevent EXIT trap recursion */
1880 /* Note: G_traps[0] is not cleared!
1881 * "trap" will still show it, if executed
1886 #if ENABLE_FEATURE_CLEAN_UP
1888 struct variable *cur_var;
1889 if (G.cwd != bb_msg_unknown)
1891 cur_var = G.top_var;
1893 struct variable *tmp = cur_var;
1894 if (!cur_var->max_len)
1895 free(cur_var->varstr);
1896 cur_var = cur_var->next;
1904 sigexit(- (exitcode & 0xff));
1911 //TODO: return a mask of ALL handled sigs?
1912 static int check_and_run_traps(void)
1919 if (sigisemptyset(&G.pending_set))
1924 if (sigismember(&G.pending_set, sig)) {
1925 sigdelset(&G.pending_set, sig);
1928 } while (sig < NSIG);
1931 if (G_traps && G_traps[sig]) {
1932 debug_printf_exec("%s: sig:%d handler:'%s'\n", __func__, sig, G.traps[sig]);
1933 if (G_traps[sig][0]) {
1934 /* We have user-defined handler */
1935 smalluint save_rcode;
1937 /* argv[0] is unused */
1938 argv[1] = G_traps[sig];
1940 save_rcode = G.last_exitcode;
1942 //FIXME: shouldn't it be set to 128 + sig instead?
1943 G.last_exitcode = save_rcode;
1945 } /* else: "" trap, ignoring signal */
1948 /* not a trap: special action */
1951 debug_printf_exec("%s: sig:%d default SIGINT handler\n", __func__, sig);
1958 debug_printf_exec("%s: sig:%d default SIGHUP handler\n", __func__, sig);
1959 /* bash is observed to signal whole process groups,
1960 * not individual processes */
1961 for (job = G.job_list; job; job = job->next) {
1964 debug_printf_exec("HUPing pgrp %d\n", job->pgrp);
1965 if (kill(- job->pgrp, SIGHUP) == 0)
1966 kill(- job->pgrp, SIGCONT);
1971 #if ENABLE_HUSH_FAST
1973 debug_printf_exec("%s: sig:%d default SIGCHLD handler\n", __func__, sig);
1975 //bb_error_msg("[%d] check_and_run_traps: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1977 * We don't do 'last_sig = sig' here -> NOT returning this sig.
1978 * This simplifies wait builtin a bit.
1982 default: /* ignored: */
1983 debug_printf_exec("%s: sig:%d default handling is to ignore\n", __func__, sig);
1984 /* SIGTERM, SIGQUIT, SIGTTIN, SIGTTOU, SIGTSTP */
1986 * We don't do 'last_sig = sig' here -> NOT returning this sig.
1987 * Example: wait is not interrupted by TERM
1988 * in interactive shell, because TERM is ignored.
1997 static const char *get_cwd(int force)
1999 if (force || G.cwd == NULL) {
2000 /* xrealloc_getcwd_or_warn(arg) calls free(arg),
2001 * we must not try to free(bb_msg_unknown) */
2002 if (G.cwd == bb_msg_unknown)
2004 G.cwd = xrealloc_getcwd_or_warn((char *)G.cwd);
2006 G.cwd = bb_msg_unknown;
2013 * Shell and environment variable support
2015 static struct variable **get_ptr_to_local_var(const char *name, unsigned len)
2017 struct variable **pp;
2018 struct variable *cur;
2021 while ((cur = *pp) != NULL) {
2022 if (strncmp(cur->varstr, name, len) == 0 && cur->varstr[len] == '=')
2029 static const char* FAST_FUNC get_local_var_value(const char *name)
2031 struct variable **vpp;
2032 unsigned len = strlen(name);
2034 if (G.expanded_assignments) {
2035 char **cpp = G.expanded_assignments;
2038 if (strncmp(cp, name, len) == 0 && cp[len] == '=')
2039 return cp + len + 1;
2044 vpp = get_ptr_to_local_var(name, len);
2046 return (*vpp)->varstr + len + 1;
2048 if (strcmp(name, "PPID") == 0)
2049 return utoa(G.root_ppid);
2050 // bash compat: UID? EUID?
2051 #if ENABLE_HUSH_RANDOM_SUPPORT
2052 if (strcmp(name, "RANDOM") == 0)
2053 return utoa(next_random(&G.random_gen));
2058 /* str holds "NAME=VAL" and is expected to be malloced.
2059 * We take ownership of it.
2061 #define SETFLAG_EXPORT (1 << 0)
2062 #define SETFLAG_UNEXPORT (1 << 1)
2063 #define SETFLAG_MAKE_RO (1 << 2)
2064 #define SETFLAG_LOCAL_SHIFT 3
2065 static int set_local_var(char *str, unsigned flags)
2067 struct variable **var_pp;
2068 struct variable *cur;
2069 char *free_me = NULL;
2072 IF_HUSH_LOCAL(unsigned local_lvl = (flags >> SETFLAG_LOCAL_SHIFT);)
2074 eq_sign = strchr(str, '=');
2075 if (!eq_sign) { /* not expected to ever happen? */
2080 name_len = eq_sign - str + 1; /* including '=' */
2081 var_pp = &G.top_var;
2082 while ((cur = *var_pp) != NULL) {
2083 if (strncmp(cur->varstr, str, name_len) != 0) {
2084 var_pp = &cur->next;
2088 /* We found an existing var with this name */
2089 if (cur->flg_read_only) {
2090 bb_error_msg("%s: readonly variable", str);
2092 //NOTE: in bash, assignment in "export READONLY_VAR=Z" fails, and sets $?=1,
2093 //but export per se succeeds (does put the var in env). We don't mimic that.
2096 if (flags & SETFLAG_UNEXPORT) { // && cur->flg_export ?
2097 debug_printf_env("%s: unsetenv '%s'\n", __func__, str);
2102 #if ENABLE_HUSH_LOCAL
2103 if (cur->func_nest_level < local_lvl) {
2104 /* New variable is declared as local,
2105 * and existing one is global, or local
2106 * from enclosing function.
2107 * Remove and save old one: */
2108 *var_pp = cur->next;
2109 cur->next = *G.shadowed_vars_pp;
2110 *G.shadowed_vars_pp = cur;
2111 /* bash 3.2.33(1) and exported vars:
2113 * # f() { local z=a; env | grep ^z; }
2119 if (cur->flg_export)
2120 flags |= SETFLAG_EXPORT;
2124 if (strcmp(cur->varstr + name_len, eq_sign + 1) == 0) {
2129 if (cur->max_len != 0) {
2130 if (cur->max_len >= strlen(str)) {
2131 /* This one is from startup env, reuse space */
2132 strcpy(cur->varstr, str);
2137 goto set_str_and_exp;
2139 /* max_len == 0 signifies "malloced" var, which we can
2140 * (and have to) free. But we can't free(cur->varstr) here:
2141 * if cur->flg_export is 1, it is in the environment.
2142 * We should either unsetenv+free, or wait until putenv,
2143 * then putenv(new)+free(old).
2145 free_me = cur->varstr;
2146 goto set_str_and_exp;
2149 /* Not found - create new variable struct */
2150 cur = xzalloc(sizeof(*cur));
2151 IF_HUSH_LOCAL(cur->func_nest_level = local_lvl;)
2152 cur->next = *var_pp;
2158 #if !BB_MMU || ENABLE_HUSH_READONLY
2159 if (flags & SETFLAG_MAKE_RO) {
2160 cur->flg_read_only = 1;
2163 if (flags & SETFLAG_EXPORT)
2164 cur->flg_export = 1;
2165 if (name_len == 4 && cur->varstr[0] == 'P' && cur->varstr[1] == 'S')
2166 cmdedit_update_prompt();
2167 if (cur->flg_export) {
2168 if (flags & SETFLAG_UNEXPORT) {
2169 cur->flg_export = 0;
2170 /* unsetenv was already done */
2173 debug_printf_env("%s: putenv '%s'\n", __func__, cur->varstr);
2174 i = putenv(cur->varstr);
2175 /* only now we can free old exported malloced string */
2184 /* Used at startup and after each cd */
2185 static void set_pwd_var(unsigned flag)
2187 set_local_var(xasprintf("PWD=%s", get_cwd(/*force:*/ 1)), flag);
2190 static int unset_local_var_len(const char *name, int name_len)
2192 struct variable *cur;
2193 struct variable **var_pp;
2196 return EXIT_SUCCESS;
2197 var_pp = &G.top_var;
2198 while ((cur = *var_pp) != NULL) {
2199 if (strncmp(cur->varstr, name, name_len) == 0 && cur->varstr[name_len] == '=') {
2200 if (cur->flg_read_only) {
2201 bb_error_msg("%s: readonly variable", name);
2202 return EXIT_FAILURE;
2204 *var_pp = cur->next;
2205 debug_printf_env("%s: unsetenv '%s'\n", __func__, cur->varstr);
2206 bb_unsetenv(cur->varstr);
2207 if (name_len == 3 && cur->varstr[0] == 'P' && cur->varstr[1] == 'S')
2208 cmdedit_update_prompt();
2212 return EXIT_SUCCESS;
2214 var_pp = &cur->next;
2216 return EXIT_SUCCESS;
2219 #if ENABLE_HUSH_UNSET
2220 static int unset_local_var(const char *name)
2222 return unset_local_var_len(name, strlen(name));
2226 static void unset_vars(char **strings)
2234 const char *eq = strchrnul(*v, '=');
2235 unset_local_var_len(*v, (int)(eq - *v));
2241 #if BASH_HOSTNAME_VAR || ENABLE_FEATURE_SH_MATH || ENABLE_HUSH_READ
2242 static void FAST_FUNC set_local_var_from_halves(const char *name, const char *val)
2244 char *var = xasprintf("%s=%s", name, val);
2245 set_local_var(var, /*flag:*/ 0);
2251 * Helpers for "var1=val1 var2=val2 cmd" feature
2253 static void add_vars(struct variable *var)
2255 struct variable *next;
2259 var->next = G.top_var;
2261 if (var->flg_export) {
2262 debug_printf_env("%s: restoring exported '%s'\n", __func__, var->varstr);
2263 putenv(var->varstr);
2265 debug_printf_env("%s: restoring variable '%s'\n", __func__, var->varstr);
2271 static struct variable *set_vars_and_save_old(char **strings)
2274 struct variable *old = NULL;
2280 struct variable *var_p;
2281 struct variable **var_pp;
2284 eq = strchr(*s, '=');
2286 var_pp = get_ptr_to_local_var(*s, eq - *s);
2289 if (var_p->flg_read_only) {
2291 bb_error_msg("%s: readonly variable", *s);
2293 * "VAR=V BLTIN" unsets VARs after BLTIN completes.
2294 * If VAR is readonly, leaving it in the list
2295 * after asssignment error (msg above)
2296 * causes doubled error message later, on unset.
2298 debug_printf_env("removing/freeing '%s' element\n", *s);
2301 do { *p = p[1]; p++; } while (*p);
2304 /* Remove variable from global linked list */
2305 debug_printf_env("%s: removing '%s'\n", __func__, var_p->varstr);
2306 *var_pp = var_p->next;
2307 /* Add it to returned list */
2311 set_local_var(*s, SETFLAG_EXPORT);
2323 static void reinit_unicode_for_hush(void)
2325 /* Unicode support should be activated even if LANG is set
2326 * _during_ shell execution, not only if it was set when
2327 * shell was started. Therefore, re-check LANG every time:
2329 if (ENABLE_FEATURE_CHECK_UNICODE_IN_ENV
2330 || ENABLE_UNICODE_USING_LOCALE
2332 const char *s = get_local_var_value("LC_ALL");
2333 if (!s) s = get_local_var_value("LC_CTYPE");
2334 if (!s) s = get_local_var_value("LANG");
2340 * in_str support (strings, and "strings" read from files).
2343 #if ENABLE_HUSH_INTERACTIVE
2344 /* To test correct lineedit/interactive behavior, type from command line:
2350 * It exercises a lot of corner cases.
2352 static void cmdedit_update_prompt(void)
2354 if (ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
2355 G.PS1 = get_local_var_value("PS1");
2358 G.PS2 = get_local_var_value("PS2");
2365 static const char *setup_prompt_string(int promptmode)
2367 const char *prompt_str;
2368 debug_printf("setup_prompt_string %d ", promptmode);
2369 if (!ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
2370 /* Set up the prompt */
2371 if (promptmode == 0) { /* PS1 */
2373 /* bash uses $PWD value, even if it is set by user.
2374 * It uses current dir only if PWD is unset.
2375 * We always use current dir. */
2376 G.PS1 = xasprintf("%s %c ", get_cwd(0), (geteuid() != 0) ? '$' : '#');
2381 prompt_str = (promptmode == 0) ? G.PS1 : G.PS2;
2382 debug_printf("prompt_str '%s'\n", prompt_str);
2385 static int get_user_input(struct in_str *i)
2388 const char *prompt_str;
2390 prompt_str = setup_prompt_string(i->promptmode);
2391 # if ENABLE_FEATURE_EDITING
2393 reinit_unicode_for_hush();
2394 if (G.flag_SIGINT) {
2395 /* There was ^C'ed, make it look prettier: */
2399 /* buglet: SIGINT will not make new prompt to appear _at once_,
2400 * only after <Enter>. (^C works immediately) */
2401 r = read_line_input(G.line_input_state, prompt_str,
2402 G.user_input_buf, CONFIG_FEATURE_EDITING_MAX_LEN-1,
2405 /* read_line_input intercepts ^C, "convert" it to SIGINT */
2407 write(STDOUT_FILENO, "^C", 2);
2410 check_and_run_traps();
2411 if (r != 0 && !G.flag_SIGINT)
2413 /* ^C or SIGINT: repeat */
2414 G.last_exitcode = 128 + SIGINT;
2417 /* EOF/error detected */
2419 i->peek_buf[0] = r = EOF;
2422 i->p = G.user_input_buf;
2423 return (unsigned char)*i->p++;
2427 if (i->last_char == '\0' || i->last_char == '\n') {
2428 /* Why check_and_run_traps here? Try this interactively:
2429 * $ trap 'echo INT' INT; (sleep 2; kill -INT $$) &
2430 * $ <[enter], repeatedly...>
2431 * Without check_and_run_traps, handler never runs.
2433 check_and_run_traps();
2434 fputs(prompt_str, stdout);
2437 //FIXME: here ^C or SIGINT will have effect only after <Enter>
2439 /* In !ENABLE_FEATURE_EDITING we don't use read_line_input,
2440 * no ^C masking happens during fgetc, no special code for ^C:
2441 * it generates SIGINT as usual.
2443 check_and_run_traps();
2445 G.last_exitcode = 128 + SIGINT;
2452 /* This is the magic location that prints prompts
2453 * and gets data back from the user */
2454 static int fgetc_interactive(struct in_str *i)
2457 /* If it's interactive stdin, get new line. */
2458 if (G_interactive_fd && i->file == stdin) {
2459 /* Returns first char (or EOF), the rest is in i->p[] */
2460 ch = get_user_input(i);
2461 i->promptmode = 1; /* PS2 */
2463 /* Not stdin: script file, sourced file, etc */
2464 do ch = fgetc(i->file); while (ch == '\0');
2469 static inline int fgetc_interactive(struct in_str *i)
2472 do ch = fgetc(i->file); while (ch == '\0');
2475 #endif /* INTERACTIVE */
2477 static int i_getch(struct in_str *i)
2482 /* string-based in_str */
2483 ch = (unsigned char)*i->p;
2492 /* FILE-based in_str */
2494 #if ENABLE_FEATURE_EDITING
2495 /* This can be stdin, check line editing char[] buffer */
2496 if (i->p && *i->p != '\0') {
2497 ch = (unsigned char)*i->p++;
2501 /* peek_buf[] is an int array, not char. Can contain EOF. */
2502 ch = i->peek_buf[0];
2504 int ch2 = i->peek_buf[1];
2505 i->peek_buf[0] = ch2;
2506 if (ch2 == 0) /* very likely, avoid redundant write */
2512 ch = fgetc_interactive(i);
2514 debug_printf("file_get: got '%c' %d\n", ch, ch);
2519 static int i_peek(struct in_str *i)
2524 /* string-based in_str */
2525 /* Doesn't report EOF on NUL. None of the callers care. */
2526 return (unsigned char)*i->p;
2529 /* FILE-based in_str */
2531 #if ENABLE_FEATURE_EDITING && ENABLE_HUSH_INTERACTIVE
2532 /* This can be stdin, check line editing char[] buffer */
2533 if (i->p && *i->p != '\0')
2534 return (unsigned char)*i->p;
2536 /* peek_buf[] is an int array, not char. Can contain EOF. */
2537 ch = i->peek_buf[0];
2541 /* Need to get a new char */
2542 ch = fgetc_interactive(i);
2543 debug_printf("file_peek: got '%c' %d\n", ch, ch);
2545 /* Save it by either rolling back line editing buffer, or in i->peek_buf[0] */
2546 #if ENABLE_FEATURE_EDITING && ENABLE_HUSH_INTERACTIVE
2552 i->peek_buf[0] = ch;
2553 /*i->peek_buf[1] = 0; - already is */
2557 /* Only ever called if i_peek() was called, and did not return EOF.
2558 * IOW: we know the previous peek saw an ordinary char, not EOF, not NUL,
2559 * not end-of-line. Therefore we never need to read a new editing line here.
2561 static int i_peek2(struct in_str *i)
2565 /* There are two cases when i->p[] buffer exists.
2566 * (1) it's a string in_str.
2567 * (2) It's a file, and we have a saved line editing buffer.
2568 * In both cases, we know that i->p[0] exists and not NUL, and
2569 * the peek2 result is in i->p[1].
2572 return (unsigned char)i->p[1];
2574 /* Now we know it is a file-based in_str. */
2576 /* peek_buf[] is an int array, not char. Can contain EOF. */
2577 /* Is there 2nd char? */
2578 ch = i->peek_buf[1];
2580 /* We did not read it yet, get it now */
2581 do ch = fgetc(i->file); while (ch == '\0');
2582 i->peek_buf[1] = ch;
2585 debug_printf("file_peek2: got '%c' %d\n", ch, ch);
2589 static void setup_file_in_str(struct in_str *i, FILE *f)
2591 memset(i, 0, sizeof(*i));
2592 /* i->promptmode = 0; - PS1 (memset did it) */
2597 static void setup_string_in_str(struct in_str *i, const char *s)
2599 memset(i, 0, sizeof(*i));
2600 /* i->promptmode = 0; - PS1 (memset did it) */
2601 /*i->file = NULL */;
2609 #define B_CHUNK (32 * sizeof(char*))
2611 static void o_reset_to_empty_unquoted(o_string *o)
2614 o->has_quoted_part = 0;
2619 static void o_free(o_string *o)
2622 memset(o, 0, sizeof(*o));
2625 static ALWAYS_INLINE void o_free_unsafe(o_string *o)
2630 static void o_grow_by(o_string *o, int len)
2632 if (o->length + len > o->maxlen) {
2633 o->maxlen += (2 * len) | (B_CHUNK-1);
2634 o->data = xrealloc(o->data, 1 + o->maxlen);
2638 static void o_addchr(o_string *o, int ch)
2640 debug_printf("o_addchr: '%c' o->length=%d o=%p\n", ch, o->length, o);
2641 if (o->length < o->maxlen) {
2642 /* likely. avoid o_grow_by() call */
2644 o->data[o->length] = ch;
2646 o->data[o->length] = '\0';
2654 /* Valid only if we know o_string is not empty */
2655 static void o_delchr(o_string *o)
2658 o->data[o->length] = '\0';
2662 static void o_addblock(o_string *o, const char *str, int len)
2665 memcpy(&o->data[o->length], str, len);
2667 o->data[o->length] = '\0';
2670 static void o_addstr(o_string *o, const char *str)
2672 o_addblock(o, str, strlen(str));
2676 static void nommu_addchr(o_string *o, int ch)
2682 # define nommu_addchr(o, str) ((void)0)
2685 static void o_addstr_with_NUL(o_string *o, const char *str)
2687 o_addblock(o, str, strlen(str) + 1);
2691 * HUSH_BRACE_EXPANSION code needs corresponding quoting on variable expansion side.
2692 * Currently, "v='{q,w}'; echo $v" erroneously expands braces in $v.
2693 * Apparently, on unquoted $v bash still does globbing
2694 * ("v='*.txt'; echo $v" prints all .txt files),
2695 * but NOT brace expansion! Thus, there should be TWO independent
2696 * quoting mechanisms on $v expansion side: one protects
2697 * $v from brace expansion, and other additionally protects "$v" against globbing.
2698 * We have only second one.
2701 #if ENABLE_HUSH_BRACE_EXPANSION
2702 # define MAYBE_BRACES "{}"
2704 # define MAYBE_BRACES ""
2707 /* My analysis of quoting semantics tells me that state information
2708 * is associated with a destination, not a source.
2710 static void o_addqchr(o_string *o, int ch)
2713 char *found = strchr("*?[\\" MAYBE_BRACES, ch);
2718 o->data[o->length] = '\\';
2721 o->data[o->length] = ch;
2723 o->data[o->length] = '\0';
2726 static void o_addQchr(o_string *o, int ch)
2729 if ((o->o_expflags & EXP_FLAG_ESC_GLOB_CHARS)
2730 && strchr("*?[\\" MAYBE_BRACES, ch)
2733 o->data[o->length] = '\\';
2737 o->data[o->length] = ch;
2739 o->data[o->length] = '\0';
2742 static void o_addqblock(o_string *o, const char *str, int len)
2747 int ordinary_cnt = strcspn(str, "*?[\\" MAYBE_BRACES);
2748 if (ordinary_cnt > len) /* paranoia */
2750 o_addblock(o, str, ordinary_cnt);
2751 if (ordinary_cnt == len)
2752 return; /* NUL is already added by o_addblock */
2753 str += ordinary_cnt;
2754 len -= ordinary_cnt + 1; /* we are processing + 1 char below */
2758 if (ch) { /* it is necessarily one of "*?[\\" MAYBE_BRACES */
2760 o->data[o->length] = '\\';
2764 o->data[o->length] = ch;
2767 o->data[o->length] = '\0';
2770 static void o_addQblock(o_string *o, const char *str, int len)
2772 if (!(o->o_expflags & EXP_FLAG_ESC_GLOB_CHARS)) {
2773 o_addblock(o, str, len);
2776 o_addqblock(o, str, len);
2779 static void o_addQstr(o_string *o, const char *str)
2781 o_addQblock(o, str, strlen(str));
2784 /* A special kind of o_string for $VAR and `cmd` expansion.
2785 * It contains char* list[] at the beginning, which is grown in 16 element
2786 * increments. Actual string data starts at the next multiple of 16 * (char*).
2787 * list[i] contains an INDEX (int!) into this string data.
2788 * It means that if list[] needs to grow, data needs to be moved higher up
2789 * but list[i]'s need not be modified.
2790 * NB: remembering how many list[i]'s you have there is crucial.
2791 * o_finalize_list() operation post-processes this structure - calculates
2792 * and stores actual char* ptrs in list[]. Oh, it NULL terminates it as well.
2794 #if DEBUG_EXPAND || DEBUG_GLOB
2795 static void debug_print_list(const char *prefix, o_string *o, int n)
2797 char **list = (char**)o->data;
2798 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2802 fdprintf(2, "%s: list:%p n:%d string_start:%d length:%d maxlen:%d glob:%d quoted:%d escape:%d\n",
2803 prefix, list, n, string_start, o->length, o->maxlen,
2804 !!(o->o_expflags & EXP_FLAG_GLOB),
2806 !!(o->o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
2809 fdprintf(2, " list[%d]=%d '%s' %p\n", i, (int)(uintptr_t)list[i],
2810 o->data + (int)(uintptr_t)list[i] + string_start,
2811 o->data + (int)(uintptr_t)list[i] + string_start);
2815 const char *p = o->data + (int)(uintptr_t)list[n - 1] + string_start;
2817 fdprintf(2, " total_sz:%ld\n", (long)((p + strlen(p) + 1) - o->data));
2821 # define debug_print_list(prefix, o, n) ((void)0)
2824 /* n = o_save_ptr_helper(str, n) "starts new string" by storing an index value
2825 * in list[n] so that it points past last stored byte so far.
2826 * It returns n+1. */
2827 static int o_save_ptr_helper(o_string *o, int n)
2829 char **list = (char**)o->data;
2833 if (!o->has_empty_slot) {
2834 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2835 string_len = o->length - string_start;
2836 if (!(n & 0xf)) { /* 0, 0x10, 0x20...? */
2837 debug_printf_list("list[%d]=%d string_start=%d (growing)\n", n, string_len, string_start);
2838 /* list[n] points to string_start, make space for 16 more pointers */
2839 o->maxlen += 0x10 * sizeof(list[0]);
2840 o->data = xrealloc(o->data, o->maxlen + 1);
2841 list = (char**)o->data;
2842 memmove(list + n + 0x10, list + n, string_len);
2843 o->length += 0x10 * sizeof(list[0]);
2845 debug_printf_list("list[%d]=%d string_start=%d\n",
2846 n, string_len, string_start);
2849 /* We have empty slot at list[n], reuse without growth */
2850 string_start = ((n+1 + 0xf) & ~0xf) * sizeof(list[0]); /* NB: n+1! */
2851 string_len = o->length - string_start;
2852 debug_printf_list("list[%d]=%d string_start=%d (empty slot)\n",
2853 n, string_len, string_start);
2854 o->has_empty_slot = 0;
2856 o->has_quoted_part = 0;
2857 list[n] = (char*)(uintptr_t)string_len;
2861 /* "What was our last o_save_ptr'ed position (byte offset relative o->data)?" */
2862 static int o_get_last_ptr(o_string *o, int n)
2864 char **list = (char**)o->data;
2865 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2867 return ((int)(uintptr_t)list[n-1]) + string_start;
2870 #if ENABLE_HUSH_BRACE_EXPANSION
2871 /* There in a GNU extension, GLOB_BRACE, but it is not usable:
2872 * first, it processes even {a} (no commas), second,
2873 * I didn't manage to make it return strings when they don't match
2874 * existing files. Need to re-implement it.
2878 static int glob_needed(const char *s)
2887 if (*s == '*' || *s == '[' || *s == '?' || *s == '{')
2893 /* Return pointer to next closing brace or to comma */
2894 static const char *next_brace_sub(const char *cp)
2898 while (*cp != '\0') {
2905 if ((*cp == '}' && depth-- == 0) || (*cp == ',' && depth == 0))
2911 return *cp != '\0' ? cp : NULL;
2913 /* Recursive brace globber. Note: may garble pattern[]. */
2914 static int glob_brace(char *pattern, o_string *o, int n)
2916 char *new_pattern_buf;
2923 debug_printf_glob("glob_brace('%s')\n", pattern);
2929 if (*begin == '{') {
2930 /* Find the first sub-pattern and at the same time
2931 * find the rest after the closing brace */
2932 next = next_brace_sub(begin);
2934 /* An illegal expression */
2938 /* "{abc}" with no commas - illegal
2939 * brace expr, disregard and skip it */
2945 if (*begin == '\\' && begin[1] != '\0')
2949 debug_printf_glob("begin:%s\n", begin);
2950 debug_printf_glob("next:%s\n", next);
2952 /* Now find the end of the whole brace expression */
2954 while (*rest != '}') {
2955 rest = next_brace_sub(rest);
2957 /* An illegal expression */
2960 debug_printf_glob("rest:%s\n", rest);
2962 rest_len = strlen(++rest) + 1;
2964 /* We are sure the brace expression is well-formed */
2966 /* Allocate working buffer large enough for our work */
2967 new_pattern_buf = xmalloc(strlen(pattern));
2969 /* We have a brace expression. BEGIN points to the opening {,
2970 * NEXT points past the terminator of the first element, and REST
2971 * points past the final }. We will accumulate result names from
2972 * recursive runs for each brace alternative in the buffer using
2977 /* Construct the new glob expression */
2980 mempcpy(new_pattern_buf,
2981 /* We know the prefix for all sub-patterns */
2982 pattern, begin - pattern),
2986 /* Note: glob_brace() may garble new_pattern_buf[].
2987 * That's why we re-copy prefix every time (1st memcpy above).
2989 n = glob_brace(new_pattern_buf, o, n);
2991 /* We saw the last entry */
2995 next = next_brace_sub(next);
2997 free(new_pattern_buf);
3005 memset(&globdata, 0, sizeof(globdata));
3006 gr = glob(pattern, 0, NULL, &globdata);
3007 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
3009 if (gr == GLOB_NOMATCH) {
3010 globfree(&globdata);
3011 /* NB: garbles parameter */
3012 unbackslash(pattern);
3013 o_addstr_with_NUL(o, pattern);
3014 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
3015 return o_save_ptr_helper(o, n);
3017 if (gr == GLOB_NOSPACE)
3018 bb_error_msg_and_die(bb_msg_memory_exhausted);
3019 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
3020 * but we didn't specify it. Paranoia again. */
3021 bb_error_msg_and_die("glob error %d on '%s'", gr, pattern);
3023 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
3024 char **argv = globdata.gl_pathv;
3026 o_addstr_with_NUL(o, *argv);
3027 n = o_save_ptr_helper(o, n);
3033 globfree(&globdata);
3037 /* Performs globbing on last list[],
3038 * saving each result as a new list[].
3040 static int perform_glob(o_string *o, int n)
3042 char *pattern, *copy;
3044 debug_printf_glob("start perform_glob: n:%d o->data:%p\n", n, o->data);
3046 return o_save_ptr_helper(o, n);
3047 pattern = o->data + o_get_last_ptr(o, n);
3048 debug_printf_glob("glob pattern '%s'\n", pattern);
3049 if (!glob_needed(pattern)) {
3050 /* unbackslash last string in o in place, fix length */
3051 o->length = unbackslash(pattern) - o->data;
3052 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
3053 return o_save_ptr_helper(o, n);
3056 copy = xstrdup(pattern);
3057 /* "forget" pattern in o */
3058 o->length = pattern - o->data;
3059 n = glob_brace(copy, o, n);
3062 debug_print_list("perform_glob returning", o, n);
3066 #else /* !HUSH_BRACE_EXPANSION */
3069 static int glob_needed(const char *s)
3078 if (*s == '*' || *s == '[' || *s == '?')
3084 /* Performs globbing on last list[],
3085 * saving each result as a new list[].
3087 static int perform_glob(o_string *o, int n)
3093 debug_printf_glob("start perform_glob: n:%d o->data:%p\n", n, o->data);
3095 return o_save_ptr_helper(o, n);
3096 pattern = o->data + o_get_last_ptr(o, n);
3097 debug_printf_glob("glob pattern '%s'\n", pattern);
3098 if (!glob_needed(pattern)) {
3100 /* unbackslash last string in o in place, fix length */
3101 o->length = unbackslash(pattern) - o->data;
3102 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
3103 return o_save_ptr_helper(o, n);
3106 memset(&globdata, 0, sizeof(globdata));
3107 /* Can't use GLOB_NOCHECK: it does not unescape the string.
3108 * If we glob "*.\*" and don't find anything, we need
3109 * to fall back to using literal "*.*", but GLOB_NOCHECK
3110 * will return "*.\*"!
3112 gr = glob(pattern, 0, NULL, &globdata);
3113 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
3115 if (gr == GLOB_NOMATCH) {
3116 globfree(&globdata);
3119 if (gr == GLOB_NOSPACE)
3120 bb_error_msg_and_die(bb_msg_memory_exhausted);
3121 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
3122 * but we didn't specify it. Paranoia again. */
3123 bb_error_msg_and_die("glob error %d on '%s'", gr, pattern);
3125 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
3126 char **argv = globdata.gl_pathv;
3127 /* "forget" pattern in o */
3128 o->length = pattern - o->data;
3130 o_addstr_with_NUL(o, *argv);
3131 n = o_save_ptr_helper(o, n);
3137 globfree(&globdata);
3139 debug_print_list("perform_glob returning", o, n);
3143 #endif /* !HUSH_BRACE_EXPANSION */
3145 /* If o->o_expflags & EXP_FLAG_GLOB, glob the string so far remembered.
3146 * Otherwise, just finish current list[] and start new */
3147 static int o_save_ptr(o_string *o, int n)
3149 if (o->o_expflags & EXP_FLAG_GLOB) {
3150 /* If o->has_empty_slot, list[n] was already globbed
3151 * (if it was requested back then when it was filled)
3152 * so don't do that again! */
3153 if (!o->has_empty_slot)
3154 return perform_glob(o, n); /* o_save_ptr_helper is inside */
3156 return o_save_ptr_helper(o, n);
3159 /* "Please convert list[n] to real char* ptrs, and NULL terminate it." */
3160 static char **o_finalize_list(o_string *o, int n)
3165 n = o_save_ptr(o, n); /* force growth for list[n] if necessary */
3167 debug_print_list("finalized", o, n);
3168 debug_printf_expand("finalized n:%d\n", n);
3169 list = (char**)o->data;
3170 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
3174 list[n] = o->data + (int)(uintptr_t)list[n] + string_start;
3179 static void free_pipe_list(struct pipe *pi);
3181 /* Returns pi->next - next pipe in the list */
3182 static struct pipe *free_pipe(struct pipe *pi)
3187 debug_printf_clean("free_pipe (pid %d)\n", getpid());
3188 for (i = 0; i < pi->num_cmds; i++) {
3189 struct command *command;
3190 struct redir_struct *r, *rnext;
3192 command = &pi->cmds[i];
3193 debug_printf_clean(" command %d:\n", i);
3194 if (command->argv) {
3198 for (a = 0, p = command->argv; *p; a++, p++) {
3199 debug_printf_clean(" argv[%d] = %s\n", a, *p);
3202 free_strings(command->argv);
3203 //command->argv = NULL;
3205 /* not "else if": on syntax error, we may have both! */
3206 if (command->group) {
3207 debug_printf_clean(" begin group (cmd_type:%d)\n",
3209 free_pipe_list(command->group);
3210 debug_printf_clean(" end group\n");
3211 //command->group = NULL;
3213 /* else is crucial here.
3214 * If group != NULL, child_func is meaningless */
3215 #if ENABLE_HUSH_FUNCTIONS
3216 else if (command->child_func) {
3217 debug_printf_exec("cmd %p releases child func at %p\n", command, command->child_func);
3218 command->child_func->parent_cmd = NULL;
3222 free(command->group_as_string);
3223 //command->group_as_string = NULL;
3225 for (r = command->redirects; r; r = rnext) {
3226 debug_printf_clean(" redirect %d%s",
3227 r->rd_fd, redir_table[r->rd_type].descrip);
3228 /* guard against the case >$FOO, where foo is unset or blank */
3229 if (r->rd_filename) {
3230 debug_printf_clean(" fname:'%s'\n", r->rd_filename);
3231 free(r->rd_filename);
3232 //r->rd_filename = NULL;
3234 debug_printf_clean(" rd_dup:%d\n", r->rd_dup);
3238 //command->redirects = NULL;
3240 free(pi->cmds); /* children are an array, they get freed all at once */
3244 //pi->cmdtext = NULL;
3252 static void free_pipe_list(struct pipe *pi)
3256 debug_printf_clean("pipe reserved word %d\n", pi->res_word);
3258 debug_printf_clean("pipe followup code %d\n", pi->followup);
3264 /*** Parsing routines ***/
3266 #ifndef debug_print_tree
3267 static void debug_print_tree(struct pipe *pi, int lvl)
3269 static const char *const PIPE[] = {
3275 static const char *RES[] = {
3276 [RES_NONE ] = "NONE" ,
3279 [RES_THEN ] = "THEN" ,
3280 [RES_ELIF ] = "ELIF" ,
3281 [RES_ELSE ] = "ELSE" ,
3284 # if ENABLE_HUSH_LOOPS
3285 [RES_FOR ] = "FOR" ,
3286 [RES_WHILE] = "WHILE",
3287 [RES_UNTIL] = "UNTIL",
3289 [RES_DONE ] = "DONE" ,
3291 # if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
3294 # if ENABLE_HUSH_CASE
3295 [RES_CASE ] = "CASE" ,
3296 [RES_CASE_IN ] = "CASE_IN" ,
3297 [RES_MATCH] = "MATCH",
3298 [RES_CASE_BODY] = "CASE_BODY",
3299 [RES_ESAC ] = "ESAC" ,
3301 [RES_XXXX ] = "XXXX" ,
3302 [RES_SNTX ] = "SNTX" ,
3304 static const char *const CMDTYPE[] = {
3308 # if ENABLE_HUSH_FUNCTIONS
3317 fdprintf(2, "%*spipe %d res_word=%s followup=%d %s\n", lvl*2, "",
3318 pin, RES[pi->res_word], pi->followup, PIPE[pi->followup]);
3320 while (prn < pi->num_cmds) {
3321 struct command *command = &pi->cmds[prn];
3322 char **argv = command->argv;
3324 fdprintf(2, "%*s cmd %d assignment_cnt:%d",
3326 command->assignment_cnt);
3327 if (command->group) {
3328 fdprintf(2, " group %s: (argv=%p)%s%s\n",
3329 CMDTYPE[command->cmd_type],
3332 , " group_as_string:", command->group_as_string
3337 debug_print_tree(command->group, lvl+1);
3341 if (argv) while (*argv) {
3342 fdprintf(2, " '%s'", *argv);
3352 #endif /* debug_print_tree */
3354 static struct pipe *new_pipe(void)
3357 pi = xzalloc(sizeof(struct pipe));
3358 /*pi->res_word = RES_NONE; - RES_NONE is 0 anyway */
3362 /* Command (member of a pipe) is complete, or we start a new pipe
3363 * if ctx->command is NULL.
3364 * No errors possible here.
3366 static int done_command(struct parse_context *ctx)
3368 /* The command is really already in the pipe structure, so
3369 * advance the pipe counter and make a new, null command. */
3370 struct pipe *pi = ctx->pipe;
3371 struct command *command = ctx->command;
3373 #if 0 /* Instead we emit error message at run time */
3374 if (ctx->pending_redirect) {
3375 /* For example, "cmd >" (no filename to redirect to) */
3376 die_if_script("syntax error: %s", "invalid redirect");
3377 ctx->pending_redirect = NULL;
3382 if (IS_NULL_CMD(command)) {
3383 debug_printf_parse("done_command: skipping null cmd, num_cmds=%d\n", pi->num_cmds);
3387 debug_printf_parse("done_command: ++num_cmds=%d\n", pi->num_cmds);
3388 //debug_print_tree(ctx->list_head, 20);
3390 debug_printf_parse("done_command: initializing, num_cmds=%d\n", pi->num_cmds);
3393 /* Only real trickiness here is that the uncommitted
3394 * command structure is not counted in pi->num_cmds. */
3395 pi->cmds = xrealloc(pi->cmds, sizeof(*pi->cmds) * (pi->num_cmds+1));
3396 ctx->command = command = &pi->cmds[pi->num_cmds];
3398 memset(command, 0, sizeof(*command));
3399 return pi->num_cmds; /* used only for 0/nonzero check */
3402 static void done_pipe(struct parse_context *ctx, pipe_style type)
3406 debug_printf_parse("done_pipe entered, followup %d\n", type);
3407 /* Close previous command */
3408 not_null = done_command(ctx);
3410 ctx->pipe->pi_inverted = ctx->ctx_inverted;
3411 ctx->ctx_inverted = 0;
3412 ctx->pipe->res_word = ctx->ctx_res_w;
3414 if (type == PIPE_BG && ctx->list_head != ctx->pipe) {
3415 /* Necessary since && and || have precedence over &:
3416 * "cmd1 && cmd2 &" must spawn both cmds, not only cmd2,
3417 * in a backgrounded subshell.
3420 struct command *command;
3422 /* Is this actually this construct, all pipes end with && or ||? */
3423 pi = ctx->list_head;
3424 while (pi != ctx->pipe) {
3425 if (pi->followup != PIPE_AND && pi->followup != PIPE_OR)
3430 debug_printf_parse("BG with more than one pipe, converting to { p1 &&...pN; } &\n");
3431 pi->followup = PIPE_SEQ; /* close pN _not_ with "&"! */
3432 pi = xzalloc(sizeof(*pi));
3433 pi->followup = PIPE_BG;
3435 pi->cmds = xzalloc(sizeof(pi->cmds[0]));
3436 command = &pi->cmds[0];
3437 if (CMD_NORMAL != 0) /* "if xzalloc didn't do that already" */
3438 command->cmd_type = CMD_NORMAL;
3439 command->group = ctx->list_head;
3441 command->group_as_string = xstrndup(
3442 ctx->as_string.data,
3443 ctx->as_string.length - 1 /* do not copy last char, "&" */
3446 /* Replace all pipes in ctx with one newly created */
3447 ctx->list_head = ctx->pipe = pi;
3450 ctx->pipe->followup = type;
3453 /* Without this check, even just <enter> on command line generates
3454 * tree of three NOPs (!). Which is harmless but annoying.
3455 * IOW: it is safe to do it unconditionally. */
3458 || ctx->ctx_res_w == RES_FI
3460 #if ENABLE_HUSH_LOOPS
3461 || ctx->ctx_res_w == RES_DONE
3462 || ctx->ctx_res_w == RES_FOR
3463 || ctx->ctx_res_w == RES_IN
3465 #if ENABLE_HUSH_CASE
3466 || ctx->ctx_res_w == RES_ESAC
3470 debug_printf_parse("done_pipe: adding new pipe: "
3471 "not_null:%d ctx->ctx_res_w:%d\n",
3472 not_null, ctx->ctx_res_w);
3474 ctx->pipe->next = new_p;
3476 /* RES_THEN, RES_DO etc are "sticky" -
3477 * they remain set for pipes inside if/while.
3478 * This is used to control execution.
3479 * RES_FOR and RES_IN are NOT sticky (needed to support
3480 * cases where variable or value happens to match a keyword):
3482 #if ENABLE_HUSH_LOOPS
3483 if (ctx->ctx_res_w == RES_FOR
3484 || ctx->ctx_res_w == RES_IN)
3485 ctx->ctx_res_w = RES_NONE;
3487 #if ENABLE_HUSH_CASE
3488 if (ctx->ctx_res_w == RES_MATCH)
3489 ctx->ctx_res_w = RES_CASE_BODY;
3490 if (ctx->ctx_res_w == RES_CASE)
3491 ctx->ctx_res_w = RES_CASE_IN;
3493 ctx->command = NULL; /* trick done_command below */
3494 /* Create the memory for command, roughly:
3495 * ctx->pipe->cmds = new struct command;
3496 * ctx->command = &ctx->pipe->cmds[0];
3499 //debug_print_tree(ctx->list_head, 10);
3501 debug_printf_parse("done_pipe return\n");
3504 static void initialize_context(struct parse_context *ctx)
3506 memset(ctx, 0, sizeof(*ctx));
3507 ctx->pipe = ctx->list_head = new_pipe();
3508 /* Create the memory for command, roughly:
3509 * ctx->pipe->cmds = new struct command;
3510 * ctx->command = &ctx->pipe->cmds[0];
3515 /* If a reserved word is found and processed, parse context is modified
3516 * and 1 is returned.
3519 struct reserved_combo {
3522 unsigned char assignment_flag;
3526 FLAG_END = (1 << RES_NONE ),
3528 FLAG_IF = (1 << RES_IF ),
3529 FLAG_THEN = (1 << RES_THEN ),
3530 FLAG_ELIF = (1 << RES_ELIF ),
3531 FLAG_ELSE = (1 << RES_ELSE ),
3532 FLAG_FI = (1 << RES_FI ),
3534 # if ENABLE_HUSH_LOOPS
3535 FLAG_FOR = (1 << RES_FOR ),
3536 FLAG_WHILE = (1 << RES_WHILE),
3537 FLAG_UNTIL = (1 << RES_UNTIL),
3538 FLAG_DO = (1 << RES_DO ),
3539 FLAG_DONE = (1 << RES_DONE ),
3540 FLAG_IN = (1 << RES_IN ),
3542 # if ENABLE_HUSH_CASE
3543 FLAG_MATCH = (1 << RES_MATCH),
3544 FLAG_ESAC = (1 << RES_ESAC ),
3546 FLAG_START = (1 << RES_XXXX ),
3549 static const struct reserved_combo* match_reserved_word(o_string *word)
3551 /* Mostly a list of accepted follow-up reserved words.
3552 * FLAG_END means we are done with the sequence, and are ready
3553 * to turn the compound list into a command.
3554 * FLAG_START means the word must start a new compound list.
3556 static const struct reserved_combo reserved_list[] = {
3558 { "!", RES_NONE, NOT_ASSIGNMENT , 0 },
3559 { "if", RES_IF, MAYBE_ASSIGNMENT, FLAG_THEN | FLAG_START },
3560 { "then", RES_THEN, MAYBE_ASSIGNMENT, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
3561 { "elif", RES_ELIF, MAYBE_ASSIGNMENT, FLAG_THEN },
3562 { "else", RES_ELSE, MAYBE_ASSIGNMENT, FLAG_FI },
3563 { "fi", RES_FI, NOT_ASSIGNMENT , FLAG_END },
3565 # if ENABLE_HUSH_LOOPS
3566 { "for", RES_FOR, NOT_ASSIGNMENT , FLAG_IN | FLAG_DO | FLAG_START },
3567 { "while", RES_WHILE, MAYBE_ASSIGNMENT, FLAG_DO | FLAG_START },
3568 { "until", RES_UNTIL, MAYBE_ASSIGNMENT, FLAG_DO | FLAG_START },
3569 { "in", RES_IN, NOT_ASSIGNMENT , FLAG_DO },
3570 { "do", RES_DO, MAYBE_ASSIGNMENT, FLAG_DONE },
3571 { "done", RES_DONE, NOT_ASSIGNMENT , FLAG_END },
3573 # if ENABLE_HUSH_CASE
3574 { "case", RES_CASE, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_START },
3575 { "esac", RES_ESAC, NOT_ASSIGNMENT , FLAG_END },
3578 const struct reserved_combo *r;
3580 for (r = reserved_list; r < reserved_list + ARRAY_SIZE(reserved_list); r++) {
3581 if (strcmp(word->data, r->literal) == 0)
3586 /* Return 0: not a keyword, 1: keyword
3588 static int reserved_word(o_string *word, struct parse_context *ctx)
3590 # if ENABLE_HUSH_CASE
3591 static const struct reserved_combo reserved_match = {
3592 "", RES_MATCH, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_ESAC
3595 const struct reserved_combo *r;
3597 if (word->has_quoted_part)
3599 r = match_reserved_word(word);
3603 debug_printf("found reserved word %s, res %d\n", r->literal, r->res);
3604 # if ENABLE_HUSH_CASE
3605 if (r->res == RES_IN && ctx->ctx_res_w == RES_CASE_IN) {
3606 /* "case word IN ..." - IN part starts first MATCH part */
3607 r = &reserved_match;
3610 if (r->flag == 0) { /* '!' */
3611 if (ctx->ctx_inverted) { /* bash doesn't accept '! ! true' */
3612 syntax_error("! ! command");
3613 ctx->ctx_res_w = RES_SNTX;
3615 ctx->ctx_inverted = 1;
3618 if (r->flag & FLAG_START) {
3619 struct parse_context *old;
3621 old = xmemdup(ctx, sizeof(*ctx));
3622 debug_printf_parse("push stack %p\n", old);
3623 initialize_context(ctx);
3625 } else if (/*ctx->ctx_res_w == RES_NONE ||*/ !(ctx->old_flag & (1 << r->res))) {
3626 syntax_error_at(word->data);
3627 ctx->ctx_res_w = RES_SNTX;
3630 /* "{...} fi" is ok. "{...} if" is not
3632 * if { echo foo; } then { echo bar; } fi */
3633 if (ctx->command->group)
3634 done_pipe(ctx, PIPE_SEQ);
3637 ctx->ctx_res_w = r->res;
3638 ctx->old_flag = r->flag;
3639 word->o_assignment = r->assignment_flag;
3640 debug_printf_parse("word->o_assignment='%s'\n", assignment_flag[word->o_assignment]);
3642 if (ctx->old_flag & FLAG_END) {
3643 struct parse_context *old;
3645 done_pipe(ctx, PIPE_SEQ);
3646 debug_printf_parse("pop stack %p\n", ctx->stack);
3648 old->command->group = ctx->list_head;
3649 old->command->cmd_type = CMD_NORMAL;
3651 /* At this point, the compound command's string is in
3652 * ctx->as_string... except for the leading keyword!
3653 * Consider this example: "echo a | if true; then echo a; fi"
3654 * ctx->as_string will contain "true; then echo a; fi",
3655 * with "if " remaining in old->as_string!
3659 int len = old->as_string.length;
3660 /* Concatenate halves */
3661 o_addstr(&old->as_string, ctx->as_string.data);
3662 o_free_unsafe(&ctx->as_string);
3663 /* Find where leading keyword starts in first half */
3664 str = old->as_string.data + len;
3665 if (str > old->as_string.data)
3666 str--; /* skip whitespace after keyword */
3667 while (str > old->as_string.data && isalpha(str[-1]))
3669 /* Ugh, we're done with this horrid hack */
3670 old->command->group_as_string = xstrdup(str);
3671 debug_printf_parse("pop, remembering as:'%s'\n",
3672 old->command->group_as_string);
3675 *ctx = *old; /* physical copy */
3680 #endif /* HAS_KEYWORDS */
3682 /* Word is complete, look at it and update parsing context.
3683 * Normal return is 0. Syntax errors return 1.
3684 * Note: on return, word is reset, but not o_free'd!
3686 static int done_word(o_string *word, struct parse_context *ctx)
3688 struct command *command = ctx->command;
3690 debug_printf_parse("done_word entered: '%s' %p\n", word->data, command);
3691 if (word->length == 0 && !word->has_quoted_part) {
3692 debug_printf_parse("done_word return 0: true null, ignored\n");
3696 if (ctx->pending_redirect) {
3697 /* We do not glob in e.g. >*.tmp case. bash seems to glob here
3698 * only if run as "bash", not "sh" */
3699 /* http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
3701 * ...the word that follows the redirection operator
3702 * shall be subjected to tilde expansion, parameter expansion,
3703 * command substitution, arithmetic expansion, and quote
3704 * removal. Pathname expansion shall not be performed
3705 * on the word by a non-interactive shell; an interactive
3706 * shell may perform it, but shall do so only when
3707 * the expansion would result in one word."
3709 ctx->pending_redirect->rd_filename = xstrdup(word->data);
3710 /* Cater for >\file case:
3711 * >\a creates file a; >\\a, >"\a", >"\\a" create file \a
3712 * Same with heredocs:
3713 * for <<\H delim is H; <<\\H, <<"\H", <<"\\H" - \H
3715 if (ctx->pending_redirect->rd_type == REDIRECT_HEREDOC) {
3716 unbackslash(ctx->pending_redirect->rd_filename);
3717 /* Is it <<"HEREDOC"? */
3718 if (word->has_quoted_part) {
3719 ctx->pending_redirect->rd_dup |= HEREDOC_QUOTED;
3722 debug_printf_parse("word stored in rd_filename: '%s'\n", word->data);
3723 ctx->pending_redirect = NULL;
3726 # if ENABLE_HUSH_CASE
3727 if (ctx->ctx_dsemicolon
3728 && strcmp(word->data, "esac") != 0 /* not "... pattern) cmd;; esac" */
3730 /* already done when ctx_dsemicolon was set to 1: */
3731 /* ctx->ctx_res_w = RES_MATCH; */
3732 ctx->ctx_dsemicolon = 0;
3735 if (!command->argv /* if it's the first word... */
3736 # if ENABLE_HUSH_LOOPS
3737 && ctx->ctx_res_w != RES_FOR /* ...not after FOR or IN */
3738 && ctx->ctx_res_w != RES_IN
3740 # if ENABLE_HUSH_CASE
3741 && ctx->ctx_res_w != RES_CASE
3744 int reserved = reserved_word(word, ctx);
3745 debug_printf_parse("checking for reserved-ness: %d\n", reserved);
3747 o_reset_to_empty_unquoted(word);
3748 debug_printf_parse("done_word return %d\n",
3749 (ctx->ctx_res_w == RES_SNTX));
3750 return (ctx->ctx_res_w == RES_SNTX);
3753 if (strcmp(word->data, "[[") == 0) {
3754 command->cmd_type = CMD_SINGLEWORD_NOGLOB;
3760 if (command->group) {
3761 /* "{ echo foo; } echo bar" - bad */
3762 syntax_error_at(word->data);
3763 debug_printf_parse("done_word return 1: syntax error, "
3764 "groups and arglists don't mix\n");
3768 /* If this word wasn't an assignment, next ones definitely
3769 * can't be assignments. Even if they look like ones. */
3770 if (word->o_assignment != DEFINITELY_ASSIGNMENT
3771 && word->o_assignment != WORD_IS_KEYWORD
3773 word->o_assignment = NOT_ASSIGNMENT;
3775 if (word->o_assignment == DEFINITELY_ASSIGNMENT) {
3776 command->assignment_cnt++;
3777 debug_printf_parse("++assignment_cnt=%d\n", command->assignment_cnt);
3779 debug_printf_parse("word->o_assignment was:'%s'\n", assignment_flag[word->o_assignment]);
3780 word->o_assignment = MAYBE_ASSIGNMENT;
3782 debug_printf_parse("word->o_assignment='%s'\n", assignment_flag[word->o_assignment]);
3784 if (word->has_quoted_part
3785 /* optimization: and if it's ("" or '') or ($v... or `cmd`...): */
3786 && (word->data[0] == '\0' || word->data[0] == SPECIAL_VAR_SYMBOL)
3787 /* (otherwise it's known to be not empty and is already safe) */
3789 /* exclude "$@" - it can expand to no word despite "" */
3790 char *p = word->data;
3791 while (p[0] == SPECIAL_VAR_SYMBOL
3792 && (p[1] & 0x7f) == '@'
3793 && p[2] == SPECIAL_VAR_SYMBOL
3798 command->argv = add_string_to_strings(command->argv, xstrdup(word->data));
3799 debug_print_strings("word appended to argv", command->argv);
3802 #if ENABLE_HUSH_LOOPS
3803 if (ctx->ctx_res_w == RES_FOR) {
3804 if (word->has_quoted_part
3805 || !is_well_formed_var_name(command->argv[0], '\0')
3807 /* bash says just "not a valid identifier" */
3808 syntax_error("not a valid identifier in for");
3811 /* Force FOR to have just one word (variable name) */
3812 /* NB: basically, this makes hush see "for v in ..."
3813 * syntax as if it is "for v; in ...". FOR and IN become
3814 * two pipe structs in parse tree. */
3815 done_pipe(ctx, PIPE_SEQ);
3818 #if ENABLE_HUSH_CASE
3819 /* Force CASE to have just one word */
3820 if (ctx->ctx_res_w == RES_CASE) {
3821 done_pipe(ctx, PIPE_SEQ);
3825 o_reset_to_empty_unquoted(word);
3827 debug_printf_parse("done_word return 0\n");
3832 /* Peek ahead in the input to find out if we have a "&n" construct,
3833 * as in "2>&1", that represents duplicating a file descriptor.
3835 * REDIRFD_CLOSE if >&- "close fd" construct is seen,
3836 * REDIRFD_SYNTAX_ERR if syntax error,
3837 * REDIRFD_TO_FILE if no & was seen,
3838 * or the number found.
3841 #define parse_redir_right_fd(as_string, input) \
3842 parse_redir_right_fd(input)
3844 static int parse_redir_right_fd(o_string *as_string, struct in_str *input)
3850 return REDIRFD_TO_FILE;
3852 ch = i_getch(input); /* get the & */
3853 nommu_addchr(as_string, ch);
3856 ch = i_getch(input);
3857 nommu_addchr(as_string, ch);
3858 return REDIRFD_CLOSE;
3862 while (ch != EOF && isdigit(ch)) {
3863 d = d*10 + (ch-'0');
3865 ch = i_getch(input);
3866 nommu_addchr(as_string, ch);
3871 //TODO: this is the place to catch ">&file" bashism (redirect both fd 1 and 2)
3873 bb_error_msg("ambiguous redirect");
3874 return REDIRFD_SYNTAX_ERR;
3877 /* Return code is 0 normal, 1 if a syntax error is detected
3879 static int parse_redirect(struct parse_context *ctx,
3882 struct in_str *input)
3884 struct command *command = ctx->command;
3885 struct redir_struct *redir;
3886 struct redir_struct **redirp;
3889 dup_num = REDIRFD_TO_FILE;
3890 if (style != REDIRECT_HEREDOC) {
3891 /* Check for a '>&1' type redirect */
3892 dup_num = parse_redir_right_fd(&ctx->as_string, input);
3893 if (dup_num == REDIRFD_SYNTAX_ERR)
3896 int ch = i_peek(input);
3897 dup_num = (ch == '-'); /* HEREDOC_SKIPTABS bit is 1 */
3898 if (dup_num) { /* <<-... */
3899 ch = i_getch(input);
3900 nommu_addchr(&ctx->as_string, ch);
3905 if (style == REDIRECT_OVERWRITE && dup_num == REDIRFD_TO_FILE) {
3906 int ch = i_peek(input);
3908 /* >|FILE redirect ("clobbering" >).
3909 * Since we do not support "set -o noclobber" yet,
3910 * >| and > are the same for now. Just eat |.
3912 ch = i_getch(input);
3913 nommu_addchr(&ctx->as_string, ch);
3917 /* Create a new redir_struct and append it to the linked list */
3918 redirp = &command->redirects;
3919 while ((redir = *redirp) != NULL) {
3920 redirp = &(redir->next);
3922 *redirp = redir = xzalloc(sizeof(*redir));
3923 /* redir->next = NULL; */
3924 /* redir->rd_filename = NULL; */
3925 redir->rd_type = style;
3926 redir->rd_fd = (fd == -1) ? redir_table[style].default_fd : fd;
3928 debug_printf_parse("redirect type %d %s\n", redir->rd_fd,
3929 redir_table[style].descrip);
3931 redir->rd_dup = dup_num;
3932 if (style != REDIRECT_HEREDOC && dup_num != REDIRFD_TO_FILE) {
3933 /* Erik had a check here that the file descriptor in question
3934 * is legit; I postpone that to "run time"
3935 * A "-" representation of "close me" shows up as a -3 here */
3936 debug_printf_parse("duplicating redirect '%d>&%d'\n",
3937 redir->rd_fd, redir->rd_dup);
3939 #if 0 /* Instead we emit error message at run time */
3940 if (ctx->pending_redirect) {
3941 /* For example, "cmd > <file" */
3942 die_if_script("syntax error: %s", "invalid redirect");
3945 /* Set ctx->pending_redirect, so we know what to do at the
3946 * end of the next parsed word. */
3947 ctx->pending_redirect = redir;
3952 /* If a redirect is immediately preceded by a number, that number is
3953 * supposed to tell which file descriptor to redirect. This routine
3954 * looks for such preceding numbers. In an ideal world this routine
3955 * needs to handle all the following classes of redirects...
3956 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
3957 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
3958 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
3959 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
3961 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
3963 * ... If n is quoted, the number shall not be recognized as part of
3964 * the redirection expression. For example:
3966 * writes the character 2 into file a"
3967 * We are getting it right by setting ->has_quoted_part on any \<char>
3969 * A -1 return means no valid number was found,
3970 * the caller should use the appropriate default for this redirection.
3972 static int redirect_opt_num(o_string *o)
3976 if (o->data == NULL)
3978 num = bb_strtou(o->data, NULL, 10);
3979 if (errno || num < 0)
3981 o_reset_to_empty_unquoted(o);
3986 #define fetch_till_str(as_string, input, word, skip_tabs) \
3987 fetch_till_str(input, word, skip_tabs)
3989 static char *fetch_till_str(o_string *as_string,
3990 struct in_str *input,
3994 o_string heredoc = NULL_O_STRING;
3996 int prev = 0; /* not \ */
4002 ch = i_getch(input);
4004 nommu_addchr(as_string, ch);
4005 if ((ch == '\n' || ch == EOF)
4006 && ((heredoc_flags & HEREDOC_QUOTED) || prev != '\\')
4008 if (strcmp(heredoc.data + past_EOL, word) == 0) {
4009 heredoc.data[past_EOL] = '\0';
4010 debug_printf_parse("parsed heredoc '%s'\n", heredoc.data);
4011 return heredoc.data;
4013 while (ch == '\n') {
4014 o_addchr(&heredoc, ch);
4017 past_EOL = heredoc.length;
4019 ch = i_getch(input);
4021 nommu_addchr(as_string, ch);
4022 } while ((heredoc_flags & HEREDOC_SKIPTABS) && ch == '\t');
4026 o_free_unsafe(&heredoc);
4029 o_addchr(&heredoc, ch);
4030 nommu_addchr(as_string, ch);
4031 if (prev == '\\' && ch == '\\')
4032 /* Correctly handle foo\\<eol> (not a line cont.) */
4033 prev = 0; /* not \ */
4039 /* Look at entire parse tree for not-yet-loaded REDIRECT_HEREDOCs
4040 * and load them all. There should be exactly heredoc_cnt of them.
4042 static int fetch_heredocs(int heredoc_cnt, struct parse_context *ctx, struct in_str *input)
4044 struct pipe *pi = ctx->list_head;
4046 while (pi && heredoc_cnt) {
4048 struct command *cmd = pi->cmds;
4050 debug_printf_parse("fetch_heredocs: num_cmds:%d cmd argv0:'%s'\n",
4052 cmd->argv ? cmd->argv[0] : "NONE");
4053 for (i = 0; i < pi->num_cmds; i++) {
4054 struct redir_struct *redir = cmd->redirects;
4056 debug_printf_parse("fetch_heredocs: %d cmd argv0:'%s'\n",
4057 i, cmd->argv ? cmd->argv[0] : "NONE");
4059 if (redir->rd_type == REDIRECT_HEREDOC) {
4062 redir->rd_type = REDIRECT_HEREDOC2;
4063 /* redir->rd_dup is (ab)used to indicate <<- */
4064 p = fetch_till_str(&ctx->as_string, input,
4065 redir->rd_filename, redir->rd_dup);
4067 syntax_error("unexpected EOF in here document");
4070 free(redir->rd_filename);
4071 redir->rd_filename = p;
4074 redir = redir->next;
4081 /* Should be 0. If it isn't, it's a parse error */
4083 bb_error_msg_and_die("heredoc BUG 2");
4089 static int run_list(struct pipe *pi);
4091 #define parse_stream(pstring, input, end_trigger) \
4092 parse_stream(input, end_trigger)
4094 static struct pipe *parse_stream(char **pstring,
4095 struct in_str *input,
4099 #if !ENABLE_HUSH_FUNCTIONS
4100 #define parse_group(dest, ctx, input, ch) \
4101 parse_group(ctx, input, ch)
4103 static int parse_group(o_string *dest, struct parse_context *ctx,
4104 struct in_str *input, int ch)
4106 /* dest contains characters seen prior to ( or {.
4107 * Typically it's empty, but for function defs,
4108 * it contains function name (without '()'). */
4109 struct pipe *pipe_list;
4111 struct command *command = ctx->command;
4113 debug_printf_parse("parse_group entered\n");
4114 #if ENABLE_HUSH_FUNCTIONS
4115 if (ch == '(' && !dest->has_quoted_part) {
4117 if (done_word(dest, ctx))
4120 goto skip; /* (... */
4121 if (command->argv[1]) { /* word word ... (... */
4122 syntax_error_unexpected_ch('(');
4125 /* it is "word(..." or "word (..." */
4127 ch = i_getch(input);
4128 while (ch == ' ' || ch == '\t');
4130 syntax_error_unexpected_ch(ch);
4133 nommu_addchr(&ctx->as_string, ch);
4135 ch = i_getch(input);
4136 while (ch == ' ' || ch == '\t' || ch == '\n');
4138 syntax_error_unexpected_ch(ch);
4141 nommu_addchr(&ctx->as_string, ch);
4142 command->cmd_type = CMD_FUNCDEF;
4147 #if 0 /* Prevented by caller */
4148 if (command->argv /* word [word]{... */
4149 || dest->length /* word{... */
4150 || dest->has_quoted_part /* ""{... */
4153 debug_printf_parse("parse_group return 1: "
4154 "syntax error, groups and arglists don't mix\n");
4159 #if ENABLE_HUSH_FUNCTIONS
4165 command->cmd_type = CMD_SUBSHELL;
4167 /* bash does not allow "{echo...", requires whitespace */
4169 if (ch != ' ' && ch != '\t' && ch != '\n'
4170 && ch != '(' /* but "{(..." is allowed (without whitespace) */
4172 syntax_error_unexpected_ch(ch);
4176 ch = i_getch(input);
4177 nommu_addchr(&ctx->as_string, ch);
4183 # define as_string NULL
4185 char *as_string = NULL;
4187 pipe_list = parse_stream(&as_string, input, endch);
4190 o_addstr(&ctx->as_string, as_string);
4192 /* empty ()/{} or parse error? */
4193 if (!pipe_list || pipe_list == ERR_PTR) {
4194 /* parse_stream already emitted error msg */
4197 debug_printf_parse("parse_group return 1: "
4198 "parse_stream returned %p\n", pipe_list);
4201 command->group = pipe_list;
4203 as_string[strlen(as_string) - 1] = '\0'; /* plink ')' or '}' */
4204 command->group_as_string = as_string;
4205 debug_printf_parse("end of group, remembering as:'%s'\n",
4206 command->group_as_string);
4210 debug_printf_parse("parse_group return 0\n");
4212 /* command remains "open", available for possible redirects */
4215 static int i_getch_and_eat_bkslash_nl(struct in_str *input)
4220 ch = i_getch(input);
4223 ch2 = i_peek(input);
4226 /* backslash+newline, skip it */
4231 static int i_peek_and_eat_bkslash_nl(struct in_str *input)
4239 ch2 = i_peek2(input);
4242 /* backslash+newline, skip it */
4248 #if ENABLE_HUSH_TICK || ENABLE_FEATURE_SH_MATH || ENABLE_HUSH_DOLLAR_OPS
4249 /* Subroutines for copying $(...) and `...` things */
4250 static int add_till_backquote(o_string *dest, struct in_str *input, int in_dquote);
4252 static int add_till_single_quote(o_string *dest, struct in_str *input)
4255 int ch = i_getch(input);
4257 syntax_error_unterm_ch('\'');
4265 /* "...\"...`..`...." - do we need to handle "...$(..)..." too? */
4266 static int add_till_double_quote(o_string *dest, struct in_str *input)
4269 int ch = i_getch(input);
4271 syntax_error_unterm_ch('"');
4276 if (ch == '\\') { /* \x. Copy both chars. */
4278 ch = i_getch(input);
4282 if (!add_till_backquote(dest, input, /*in_dquote:*/ 1))
4287 //if (ch == '$') ...
4290 /* Process `cmd` - copy contents until "`" is seen. Complicated by
4292 * "Within the backquoted style of command substitution, backslash
4293 * shall retain its literal meaning, except when followed by: '$', '`', or '\'.
4294 * The search for the matching backquote shall be satisfied by the first
4295 * backquote found without a preceding backslash; during this search,
4296 * if a non-escaped backquote is encountered within a shell comment,
4297 * a here-document, an embedded command substitution of the $(command)
4298 * form, or a quoted string, undefined results occur. A single-quoted
4299 * or double-quoted string that begins, but does not end, within the
4300 * "`...`" sequence produces undefined results."
4302 * echo `echo '\'TEST\`echo ZZ\`BEST` \TESTZZBEST
4304 static int add_till_backquote(o_string *dest, struct in_str *input, int in_dquote)
4307 int ch = i_getch(input);
4311 /* \x. Copy both unless it is \`, \$, \\ and maybe \" */
4312 ch = i_getch(input);
4316 && (!in_dquote || ch != '"')
4318 o_addchr(dest, '\\');
4322 syntax_error_unterm_ch('`');
4328 /* Process $(cmd) - copy contents until ")" is seen. Complicated by
4329 * quoting and nested ()s.
4330 * "With the $(command) style of command substitution, all characters
4331 * following the open parenthesis to the matching closing parenthesis
4332 * constitute the command. Any valid shell script can be used for command,
4333 * except a script consisting solely of redirections which produces
4334 * unspecified results."
4336 * echo $(echo '(TEST)' BEST) (TEST) BEST
4337 * echo $(echo 'TEST)' BEST) TEST) BEST
4338 * echo $(echo \(\(TEST\) BEST) ((TEST) BEST
4340 * Also adapted to eat ${var%...} and $((...)) constructs, since ... part
4341 * can contain arbitrary constructs, just like $(cmd).
4342 * In bash compat mode, it needs to also be able to stop on ':' or '/'
4343 * for ${var:N[:M]} and ${var/P[/R]} parsing.
4345 #define DOUBLE_CLOSE_CHAR_FLAG 0x80
4346 static int add_till_closing_bracket(o_string *dest, struct in_str *input, unsigned end_ch)
4349 char dbl = end_ch & DOUBLE_CLOSE_CHAR_FLAG;
4350 # if BASH_SUBSTR || BASH_PATTERN_SUBST
4351 char end_char2 = end_ch >> 8;
4353 end_ch &= (DOUBLE_CLOSE_CHAR_FLAG - 1);
4356 ch = i_getch(input);
4358 syntax_error_unterm_ch(end_ch);
4362 # if BASH_SUBSTR || BASH_PATTERN_SUBST
4368 /* we look for closing )) of $((EXPR)) */
4369 if (i_peek_and_eat_bkslash_nl(input) == end_ch) {
4370 i_getch(input); /* eat second ')' */
4375 if (ch == '(' || ch == '{') {
4376 ch = (ch == '(' ? ')' : '}');
4377 if (!add_till_closing_bracket(dest, input, ch))
4383 if (!add_till_single_quote(dest, input))
4389 if (!add_till_double_quote(dest, input))
4395 if (!add_till_backquote(dest, input, /*in_dquote:*/ 0))
4401 /* \x. Copy verbatim. Important for \(, \) */
4402 ch = i_getch(input);
4404 syntax_error_unterm_ch(')');
4409 /* "backslash+newline", ignore both */
4410 o_delchr(dest); /* undo insertion of '\' */
4420 #endif /* ENABLE_HUSH_TICK || ENABLE_FEATURE_SH_MATH || ENABLE_HUSH_DOLLAR_OPS */
4422 /* Return code: 0 for OK, 1 for syntax error */
4424 #define parse_dollar(as_string, dest, input, quote_mask) \
4425 parse_dollar(dest, input, quote_mask)
4426 #define as_string NULL
4428 static int parse_dollar(o_string *as_string,
4430 struct in_str *input, unsigned char quote_mask)
4432 int ch = i_peek_and_eat_bkslash_nl(input); /* first character after the $ */
4434 debug_printf_parse("parse_dollar entered: ch='%c'\n", ch);
4436 ch = i_getch(input);
4437 nommu_addchr(as_string, ch);
4439 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4441 debug_printf_parse(": '%c'\n", ch);
4442 o_addchr(dest, ch | quote_mask);
4444 ch = i_peek_and_eat_bkslash_nl(input);
4445 if (!isalnum(ch) && ch != '_') {
4446 /* End of variable name reached */
4449 ch = i_getch(input);
4450 nommu_addchr(as_string, ch);
4452 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4453 } else if (isdigit(ch)) {
4455 ch = i_getch(input);
4456 nommu_addchr(as_string, ch);
4457 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4458 debug_printf_parse(": '%c'\n", ch);
4459 o_addchr(dest, ch | quote_mask);
4460 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4461 } else switch (ch) {
4463 case '!': /* last bg pid */
4464 case '?': /* last exit code */
4465 case '#': /* number of args */
4466 case '*': /* args */
4467 case '@': /* args */
4468 goto make_one_char_var;
4470 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4472 ch = i_getch(input); /* eat '{' */
4473 nommu_addchr(as_string, ch);
4475 ch = i_getch_and_eat_bkslash_nl(input); /* first char after '{' */
4476 /* It should be ${?}, or ${#var},
4477 * or even ${?+subst} - operator acting on a special variable,
4478 * or the beginning of variable name.
4481 || (!strchr(_SPECIAL_VARS_STR, ch) && !isalnum(ch)) /* not one of those */
4484 syntax_error_unterm_str("${name}");
4485 debug_printf_parse("parse_dollar return 0: unterminated ${name}\n");
4488 nommu_addchr(as_string, ch);
4491 /* It's possible to just call add_till_closing_bracket() at this point.
4492 * However, this regresses some of our testsuite cases
4493 * which check invalid constructs like ${%}.
4494 * Oh well... let's check that the var name part is fine... */
4500 debug_printf_parse(": '%c'\n", ch);
4502 ch = i_getch(input);
4503 nommu_addchr(as_string, ch);
4507 if (!isalnum(ch) && ch != '_') {
4509 unsigned char last_ch;
4510 /* handle parameter expansions
4511 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_02
4513 if (!strchr(VAR_SUBST_OPS, ch)) /* ${var<bad_char>... */
4514 goto bad_dollar_syntax;
4516 /* Eat everything until closing '}' (or ':') */
4520 && !strchr(MINUS_PLUS_EQUAL_QUESTION, i_peek(input))
4522 /* It's ${var:N[:M]} thing */
4523 end_ch = '}' * 0x100 + ':';
4525 if (BASH_PATTERN_SUBST
4528 /* It's ${var/[/]pattern[/repl]} thing */
4529 if (i_peek(input) == '/') { /* ${var//pattern[/repl]}? */
4531 nommu_addchr(as_string, '/');
4534 end_ch = '}' * 0x100 + '/';
4540 #if ENABLE_HUSH_DOLLAR_OPS
4541 last_ch = add_till_closing_bracket(dest, input, end_ch);
4542 if (last_ch == 0) /* error? */
4545 #error Simple code to only allow ${var} is not implemented
4548 o_addstr(as_string, dest->data + pos);
4549 o_addchr(as_string, last_ch);
4552 if ((BASH_SUBSTR || BASH_PATTERN_SUBST)
4553 && (end_ch & 0xff00)
4555 /* close the first block: */
4556 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4557 /* while parsing N from ${var:N[:M]}
4558 * or pattern from ${var/[/]pattern[/repl]} */
4559 if ((end_ch & 0xff) == last_ch) {
4560 /* got ':' or '/'- parse the rest */
4565 if (BASH_SUBSTR && end_ch == '}' * 0x100 + ':') {
4566 /* it's ${var:N} - emulate :999999999 */
4567 o_addstr(dest, "999999999");
4568 } /* else: it's ${var/[/]pattern} */
4573 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4576 #if ENABLE_FEATURE_SH_MATH || ENABLE_HUSH_TICK
4580 ch = i_getch(input);
4581 nommu_addchr(as_string, ch);
4582 # if ENABLE_FEATURE_SH_MATH
4583 if (i_peek_and_eat_bkslash_nl(input) == '(') {
4584 ch = i_getch(input);
4585 nommu_addchr(as_string, ch);
4586 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4587 o_addchr(dest, /*quote_mask |*/ '+');
4590 if (!add_till_closing_bracket(dest, input, ')' | DOUBLE_CLOSE_CHAR_FLAG))
4591 return 0; /* error */
4593 o_addstr(as_string, dest->data + pos);
4594 o_addchr(as_string, ')');
4595 o_addchr(as_string, ')');
4597 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4601 # if ENABLE_HUSH_TICK
4602 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4603 o_addchr(dest, quote_mask | '`');
4606 if (!add_till_closing_bracket(dest, input, ')'))
4607 return 0; /* error */
4609 o_addstr(as_string, dest->data + pos);
4610 o_addchr(as_string, ')');
4612 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4618 ch = i_getch(input);
4619 nommu_addchr(as_string, ch);
4620 ch = i_peek_and_eat_bkslash_nl(input);
4621 if (isalnum(ch)) { /* it's $_name or $_123 */
4626 /* TODO: $_ and $-: */
4627 /* $_ Shell or shell script name; or last argument of last command
4628 * (if last command wasn't a pipe; if it was, bash sets $_ to "");
4629 * but in command's env, set to full pathname used to invoke it */
4630 /* $- Option flags set by set builtin or shell options (-i etc) */
4632 o_addQchr(dest, '$');
4634 debug_printf_parse("parse_dollar return 1 (ok)\n");
4640 # if BASH_PATTERN_SUBST
4641 #define encode_string(as_string, dest, input, dquote_end, process_bkslash) \
4642 encode_string(dest, input, dquote_end, process_bkslash)
4644 /* only ${var/pattern/repl} (its pattern part) needs additional mode */
4645 #define encode_string(as_string, dest, input, dquote_end, process_bkslash) \
4646 encode_string(dest, input, dquote_end)
4648 #define as_string NULL
4652 # if BASH_PATTERN_SUBST
4653 /* all parameters are needed, no macro tricks */
4655 #define encode_string(as_string, dest, input, dquote_end, process_bkslash) \
4656 encode_string(as_string, dest, input, dquote_end)
4659 static int encode_string(o_string *as_string,
4661 struct in_str *input,
4663 int process_bkslash)
4665 #if !BASH_PATTERN_SUBST
4666 const int process_bkslash = 1;
4672 ch = i_getch(input);
4674 nommu_addchr(as_string, ch);
4675 if (ch == dquote_end) { /* may be only '"' or EOF */
4676 debug_printf_parse("encode_string return 1 (ok)\n");
4679 /* note: can't move it above ch == dquote_end check! */
4681 syntax_error_unterm_ch('"');
4682 return 0; /* error */
4686 next = i_peek(input);
4688 debug_printf_parse("\" ch=%c (%d) escape=%d\n",
4689 ch, ch, !!(dest->o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
4690 if (process_bkslash && ch == '\\') {
4692 syntax_error("\\<eof>");
4696 * "The backslash retains its special meaning [in "..."]
4697 * only when followed by one of the following characters:
4698 * $, `, ", \, or <newline>. A double quote may be quoted
4699 * within double quotes by preceding it with a backslash."
4700 * NB: in (unquoted) heredoc, above does not apply to ",
4701 * therefore we check for it by "next == dquote_end" cond.
4703 if (next == dquote_end || strchr("$`\\\n", next)) {
4704 ch = i_getch(input); /* eat next */
4706 goto again; /* skip \<newline> */
4707 } /* else: ch remains == '\\', and we double it below: */
4708 o_addqchr(dest, ch); /* \c if c is a glob char, else just c */
4709 nommu_addchr(as_string, ch);
4713 if (!parse_dollar(as_string, dest, input, /*quote_mask:*/ 0x80)) {
4714 debug_printf_parse("encode_string return 0: "
4715 "parse_dollar returned 0 (error)\n");
4720 #if ENABLE_HUSH_TICK
4722 //unsigned pos = dest->length;
4723 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4724 o_addchr(dest, 0x80 | '`');
4725 if (!add_till_backquote(dest, input, /*in_dquote:*/ dquote_end == '"'))
4726 return 0; /* error */
4727 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4728 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
4732 o_addQchr(dest, ch);
4738 * Scan input until EOF or end_trigger char.
4739 * Return a list of pipes to execute, or NULL on EOF
4740 * or if end_trigger character is met.
4741 * On syntax error, exit if shell is not interactive,
4742 * reset parsing machinery and start parsing anew,
4743 * or return ERR_PTR.
4745 static struct pipe *parse_stream(char **pstring,
4746 struct in_str *input,
4749 struct parse_context ctx;
4750 o_string dest = NULL_O_STRING;
4753 /* Single-quote triggers a bypass of the main loop until its mate is
4754 * found. When recursing, quote state is passed in via dest->o_expflags.
4756 debug_printf_parse("parse_stream entered, end_trigger='%c'\n",
4757 end_trigger ? end_trigger : 'X');
4760 /* If very first arg is "" or '', dest.data may end up NULL.
4761 * Preventing this: */
4762 o_addchr(&dest, '\0');
4765 /* We used to separate words on $IFS here. This was wrong.
4766 * $IFS is used only for word splitting when $var is expanded,
4767 * here we should use blank chars as separators, not $IFS
4770 if (MAYBE_ASSIGNMENT != 0)
4771 dest.o_assignment = MAYBE_ASSIGNMENT;
4772 initialize_context(&ctx);
4775 const char *is_blank;
4776 const char *is_special;
4780 redir_type redir_style;
4782 ch = i_getch(input);
4783 debug_printf_parse(": ch=%c (%d) escape=%d\n",
4784 ch, ch, !!(dest.o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
4789 syntax_error_unterm_str("here document");
4792 if (end_trigger == ')') {
4793 syntax_error_unterm_ch('(');
4796 if (end_trigger == '}') {
4797 syntax_error_unterm_ch('{');
4801 if (done_word(&dest, &ctx)) {
4805 done_pipe(&ctx, PIPE_SEQ);
4807 /* If we got nothing... */
4808 /* (this makes bare "&" cmd a no-op.
4809 * bash says: "syntax error near unexpected token '&'") */
4810 if (pi->num_cmds == 0
4811 IF_HAS_KEYWORDS(&& pi->res_word == RES_NONE)
4817 debug_printf_parse("as_string1 '%s'\n", ctx.as_string.data);
4819 *pstring = ctx.as_string.data;
4821 o_free_unsafe(&ctx.as_string);
4824 debug_printf_parse("parse_stream return %p\n", pi);
4827 nommu_addchr(&ctx.as_string, ch);
4831 next = i_peek(input);
4833 is_special = "{}<>;&|()#'" /* special outside of "str" */
4834 "\\$\"" IF_HUSH_TICK("`"); /* always special */
4835 /* Are { and } special here? */
4836 if (ctx.command->argv /* word [word]{... - non-special */
4837 || dest.length /* word{... - non-special */
4838 || dest.has_quoted_part /* ""{... - non-special */
4839 || (next != ';' /* }; - special */
4840 && next != ')' /* }) - special */
4841 && next != '(' /* {( - special */
4842 && next != '&' /* }& and }&& ... - special */
4843 && next != '|' /* }|| ... - special */
4844 && !strchr(defifs, next) /* {word - non-special */
4847 /* They are not special, skip "{}" */
4850 is_special = strchr(is_special, ch);
4851 is_blank = strchr(defifs, ch);
4853 if (!is_special && !is_blank) { /* ordinary char */
4855 o_addQchr(&dest, ch);
4856 if ((dest.o_assignment == MAYBE_ASSIGNMENT
4857 || dest.o_assignment == WORD_IS_KEYWORD)
4859 && is_well_formed_var_name(dest.data, '=')
4861 dest.o_assignment = DEFINITELY_ASSIGNMENT;
4862 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag[dest.o_assignment]);
4868 if (done_word(&dest, &ctx)) {
4872 /* Is this a case when newline is simply ignored?
4874 * "cmd | <newline> cmd ..."
4875 * "case ... in <newline> word) ..."
4877 if (IS_NULL_CMD(ctx.command)
4878 && dest.length == 0 && !dest.has_quoted_part
4880 /* This newline can be ignored. But...
4881 * Without check #1, interactive shell
4882 * ignores even bare <newline>,
4883 * and shows the continuation prompt:
4884 * ps1_prompt$ <enter>
4885 * ps2> _ <=== wrong, should be ps1
4886 * Without check #2, "cmd & <newline>"
4887 * is similarly mistreated.
4888 * (BTW, this makes "cmd & cmd"
4889 * and "cmd && cmd" non-orthogonal.
4890 * Really, ask yourself, why
4891 * "cmd && <newline>" doesn't start
4892 * cmd but waits for more input?
4893 * The only reason is that it might be
4894 * a "cmd1 && <nl> cmd2 &" construct,
4895 * cmd1 may need to run in BG).
4897 struct pipe *pi = ctx.list_head;
4898 if (pi->num_cmds != 0 /* check #1 */
4899 && pi->followup != PIPE_BG /* check #2 */
4904 /* Treat newline as a command separator. */
4905 done_pipe(&ctx, PIPE_SEQ);
4906 debug_printf_parse("heredoc_cnt:%d\n", heredoc_cnt);
4908 if (fetch_heredocs(heredoc_cnt, &ctx, input)) {
4913 dest.o_assignment = MAYBE_ASSIGNMENT;
4914 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag[dest.o_assignment]);
4916 /* note: if (is_blank) continue;
4917 * will still trigger for us */
4921 /* "cmd}" or "cmd }..." without semicolon or &:
4922 * } is an ordinary char in this case, even inside { cmd; }
4923 * Pathological example: { ""}; } should exec "}" cmd
4926 if (dest.length != 0 /* word} */
4927 || dest.has_quoted_part /* ""} */
4931 if (!IS_NULL_CMD(ctx.command)) { /* cmd } */
4932 /* Generally, there should be semicolon: "cmd; }"
4933 * However, bash allows to omit it if "cmd" is
4934 * a group. Examples:
4937 * { echo 0 >&2 | { echo 1; } }
4938 * { while false; do :; done }
4939 * { case a in b) ;; esac }
4941 if (ctx.command->group)
4945 if (!IS_NULL_PIPE(ctx.pipe)) /* cmd | } */
4946 /* Can't be an end of {cmd}, skip the check */
4947 goto skip_end_trigger;
4948 /* else: } does terminate a group */
4951 if (end_trigger && end_trigger == ch
4952 && (ch != ';' || heredoc_cnt == 0)
4953 #if ENABLE_HUSH_CASE
4955 || ctx.ctx_res_w != RES_MATCH
4956 || (!dest.has_quoted_part && strcmp(dest.data, "esac") == 0)
4961 /* This is technically valid:
4962 * { cat <<HERE; }; echo Ok
4966 * but we don't support this.
4967 * We require heredoc to be in enclosing {}/(),
4970 syntax_error_unterm_str("here document");
4973 if (done_word(&dest, &ctx)) {
4976 done_pipe(&ctx, PIPE_SEQ);
4977 dest.o_assignment = MAYBE_ASSIGNMENT;
4978 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag[dest.o_assignment]);
4979 /* Do we sit outside of any if's, loops or case's? */
4981 IF_HAS_KEYWORDS(|| (ctx.ctx_res_w == RES_NONE && ctx.old_flag == 0))
4985 debug_printf_parse("as_string2 '%s'\n", ctx.as_string.data);
4987 *pstring = ctx.as_string.data;
4989 o_free_unsafe(&ctx.as_string);
4992 debug_printf_parse("parse_stream return %p: "
4993 "end_trigger char found\n",
4995 return ctx.list_head;
5002 /* Catch <, > before deciding whether this word is
5003 * an assignment. a=1 2>z b=2: b=2 is still assignment */
5006 redir_fd = redirect_opt_num(&dest);
5007 if (done_word(&dest, &ctx)) {
5010 redir_style = REDIRECT_OVERWRITE;
5012 redir_style = REDIRECT_APPEND;
5013 ch = i_getch(input);
5014 nommu_addchr(&ctx.as_string, ch);
5017 else if (next == '(') {
5018 syntax_error(">(process) not supported");
5022 if (parse_redirect(&ctx, redir_fd, redir_style, input))
5024 continue; /* back to top of while (1) */
5026 redir_fd = redirect_opt_num(&dest);
5027 if (done_word(&dest, &ctx)) {
5030 redir_style = REDIRECT_INPUT;
5032 redir_style = REDIRECT_HEREDOC;
5034 debug_printf_parse("++heredoc_cnt=%d\n", heredoc_cnt);
5035 ch = i_getch(input);
5036 nommu_addchr(&ctx.as_string, ch);
5037 } else if (next == '>') {
5038 redir_style = REDIRECT_IO;
5039 ch = i_getch(input);
5040 nommu_addchr(&ctx.as_string, ch);
5043 else if (next == '(') {
5044 syntax_error("<(process) not supported");
5048 if (parse_redirect(&ctx, redir_fd, redir_style, input))
5050 continue; /* back to top of while (1) */
5052 if (dest.length == 0 && !dest.has_quoted_part) {
5053 /* skip "#comment" */
5056 if (ch == EOF || ch == '\n')
5059 /* note: we do not add it to &ctx.as_string */
5061 nommu_addchr(&ctx.as_string, '\n');
5062 continue; /* back to top of while (1) */
5067 /* It's "\<newline>" */
5069 /* Remove trailing '\' from ctx.as_string */
5070 ctx.as_string.data[--ctx.as_string.length] = '\0';
5072 ch = i_getch(input); /* eat it */
5073 continue; /* back to top of while (1) */
5078 if (dest.o_assignment == MAYBE_ASSIGNMENT
5079 /* check that we are not in word in "a=1 2>word b=1": */
5080 && !ctx.pending_redirect
5082 /* ch is a special char and thus this word
5083 * cannot be an assignment */
5084 dest.o_assignment = NOT_ASSIGNMENT;
5085 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag[dest.o_assignment]);
5088 /* Note: nommu_addchr(&ctx.as_string, ch) is already done */
5091 case '#': /* non-comment #: "echo a#b" etc */
5092 o_addQchr(&dest, ch);
5096 syntax_error("\\<eof>");
5099 ch = i_getch(input);
5100 /* note: ch != '\n' (that case does not reach this place) */
5101 o_addchr(&dest, '\\');
5102 /*nommu_addchr(&ctx.as_string, '\\'); - already done */
5103 o_addchr(&dest, ch);
5104 nommu_addchr(&ctx.as_string, ch);
5105 /* Example: echo Hello \2>file
5106 * we need to know that word 2 is quoted */
5107 dest.has_quoted_part = 1;
5110 if (!parse_dollar(&ctx.as_string, &dest, input, /*quote_mask:*/ 0)) {
5111 debug_printf_parse("parse_stream parse error: "
5112 "parse_dollar returned 0 (error)\n");
5117 dest.has_quoted_part = 1;
5118 if (next == '\'' && !ctx.pending_redirect) {
5119 insert_empty_quoted_str_marker:
5120 nommu_addchr(&ctx.as_string, next);
5121 i_getch(input); /* eat second ' */
5122 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
5123 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
5126 ch = i_getch(input);
5128 syntax_error_unterm_ch('\'');
5131 nommu_addchr(&ctx.as_string, ch);
5134 o_addqchr(&dest, ch);
5139 dest.has_quoted_part = 1;
5140 if (next == '"' && !ctx.pending_redirect)
5141 goto insert_empty_quoted_str_marker;
5142 if (dest.o_assignment == NOT_ASSIGNMENT)
5143 dest.o_expflags |= EXP_FLAG_ESC_GLOB_CHARS;
5144 if (!encode_string(&ctx.as_string, &dest, input, '"', /*process_bkslash:*/ 1))
5146 dest.o_expflags &= ~EXP_FLAG_ESC_GLOB_CHARS;
5148 #if ENABLE_HUSH_TICK
5150 USE_FOR_NOMMU(unsigned pos;)
5152 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
5153 o_addchr(&dest, '`');
5154 USE_FOR_NOMMU(pos = dest.length;)
5155 if (!add_till_backquote(&dest, input, /*in_dquote:*/ 0))
5158 o_addstr(&ctx.as_string, dest.data + pos);
5159 o_addchr(&ctx.as_string, '`');
5161 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
5162 //debug_printf_subst("SUBST RES3 '%s'\n", dest.data + pos);
5167 #if ENABLE_HUSH_CASE
5170 if (done_word(&dest, &ctx)) {
5173 done_pipe(&ctx, PIPE_SEQ);
5174 #if ENABLE_HUSH_CASE
5175 /* Eat multiple semicolons, detect
5176 * whether it means something special */
5181 ch = i_getch(input);
5182 nommu_addchr(&ctx.as_string, ch);
5183 if (ctx.ctx_res_w == RES_CASE_BODY) {
5184 ctx.ctx_dsemicolon = 1;
5185 ctx.ctx_res_w = RES_MATCH;
5191 /* We just finished a cmd. New one may start
5192 * with an assignment */
5193 dest.o_assignment = MAYBE_ASSIGNMENT;
5194 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag[dest.o_assignment]);
5197 if (done_word(&dest, &ctx)) {
5201 ch = i_getch(input);
5202 nommu_addchr(&ctx.as_string, ch);
5203 done_pipe(&ctx, PIPE_AND);
5205 done_pipe(&ctx, PIPE_BG);
5209 if (done_word(&dest, &ctx)) {
5212 #if ENABLE_HUSH_CASE
5213 if (ctx.ctx_res_w == RES_MATCH)
5214 break; /* we are in case's "word | word)" */
5216 if (next == '|') { /* || */
5217 ch = i_getch(input);
5218 nommu_addchr(&ctx.as_string, ch);
5219 done_pipe(&ctx, PIPE_OR);
5221 /* we could pick up a file descriptor choice here
5222 * with redirect_opt_num(), but bash doesn't do it.
5223 * "echo foo 2| cat" yields "foo 2". */
5228 #if ENABLE_HUSH_CASE
5229 /* "case... in [(]word)..." - skip '(' */
5230 if (ctx.ctx_res_w == RES_MATCH
5231 && ctx.command->argv == NULL /* not (word|(... */
5232 && dest.length == 0 /* not word(... */
5233 && dest.has_quoted_part == 0 /* not ""(... */
5239 if (parse_group(&dest, &ctx, input, ch) != 0) {
5244 #if ENABLE_HUSH_CASE
5245 if (ctx.ctx_res_w == RES_MATCH)
5249 /* proper use of this character is caught by end_trigger:
5250 * if we see {, we call parse_group(..., end_trigger='}')
5251 * and it will match } earlier (not here). */
5252 syntax_error_unexpected_ch(ch);
5253 G.last_exitcode = 2;
5257 bb_error_msg_and_die("BUG: unexpected %c\n", ch);
5262 G.last_exitcode = 1;
5265 struct parse_context *pctx;
5266 IF_HAS_KEYWORDS(struct parse_context *p2;)
5268 /* Clean up allocated tree.
5269 * Sample for finding leaks on syntax error recovery path.
5270 * Run it from interactive shell, watch pmap `pidof hush`.
5271 * while if false; then false; fi; do break; fi
5272 * Samples to catch leaks at execution:
5273 * while if (true | { true;}); then echo ok; fi; do break; done
5274 * while if (true | { true;}); then echo ok; fi; do (if echo ok; break; then :; fi) | cat; break; done
5278 /* Update pipe/command counts,
5279 * otherwise freeing may miss some */
5280 done_pipe(pctx, PIPE_SEQ);
5281 debug_printf_clean("freeing list %p from ctx %p\n",
5282 pctx->list_head, pctx);
5283 debug_print_tree(pctx->list_head, 0);
5284 free_pipe_list(pctx->list_head);
5285 debug_printf_clean("freed list %p\n", pctx->list_head);
5287 o_free_unsafe(&pctx->as_string);
5289 IF_HAS_KEYWORDS(p2 = pctx->stack;)
5293 IF_HAS_KEYWORDS(pctx = p2;)
5294 } while (HAS_KEYWORDS && pctx);
5307 /*** Execution routines ***/
5309 /* Expansion can recurse, need forward decls: */
5310 #if !BASH_PATTERN_SUBST && !ENABLE_HUSH_CASE
5311 /* only ${var/pattern/repl} (its pattern part) needs additional mode */
5312 #define expand_string_to_string(str, do_unbackslash) \
5313 expand_string_to_string(str)
5315 static char *expand_string_to_string(const char *str, int do_unbackslash);
5316 #if ENABLE_HUSH_TICK
5317 static int process_command_subs(o_string *dest, const char *s);
5320 /* expand_strvec_to_strvec() takes a list of strings, expands
5321 * all variable references within and returns a pointer to
5322 * a list of expanded strings, possibly with larger number
5323 * of strings. (Think VAR="a b"; echo $VAR).
5324 * This new list is allocated as a single malloc block.
5325 * NULL-terminated list of char* pointers is at the beginning of it,
5326 * followed by strings themselves.
5327 * Caller can deallocate entire list by single free(list). */
5329 /* A horde of its helpers come first: */
5331 static void o_addblock_duplicate_backslash(o_string *o, const char *str, int len)
5333 while (--len >= 0) {
5336 #if ENABLE_HUSH_BRACE_EXPANSION
5337 if (c == '{' || c == '}') {
5338 /* { -> \{, } -> \} */
5340 /* And now we want to add { or } and continue:
5343 * luckily, just falling through achieves this.
5349 /* \z -> \\\z; \<eol> -> \\<eol> */
5354 o_addchr(o, *str++);
5360 /* Store given string, finalizing the word and starting new one whenever
5361 * we encounter IFS char(s). This is used for expanding variable values.
5362 * End-of-string does NOT finalize word: think about 'echo -$VAR-'.
5363 * Return in *ended_with_ifs:
5364 * 1 - ended with IFS char, else 0 (this includes case of empty str).
5366 static int expand_on_ifs(int *ended_with_ifs, o_string *output, int n, const char *str)
5368 int last_is_ifs = 0;
5373 if (!*str) /* EOL - do not finalize word */
5375 word_len = strcspn(str, G.ifs);
5377 /* We have WORD_LEN leading non-IFS chars */
5378 if (!(output->o_expflags & EXP_FLAG_GLOB)) {
5379 o_addblock(output, str, word_len);
5381 /* Protect backslashes against globbing up :)
5382 * Example: "v='\*'; echo b$v" prints "b\*"
5383 * (and does not try to glob on "*")
5385 o_addblock_duplicate_backslash(output, str, word_len);
5386 /*/ Why can't we do it easier? */
5387 /*o_addblock(output, str, word_len); - WRONG: "v='\*'; echo Z$v" prints "Z*" instead of "Z\*" */
5388 /*o_addqblock(output, str, word_len); - WRONG: "v='*'; echo Z$v" prints "Z*" instead of Z* files */
5392 if (!*str) /* EOL - do not finalize word */
5396 /* We know str here points to at least one IFS char */
5398 str += strspn(str, G.ifs); /* skip IFS chars */
5399 if (!*str) /* EOL - do not finalize word */
5402 /* Start new word... but not always! */
5403 /* Case "v=' a'; echo ''$v": we do need to finalize empty word: */
5404 if (output->has_quoted_part
5405 /* Case "v=' a'; echo $v":
5406 * here nothing precedes the space in $v expansion,
5407 * therefore we should not finish the word
5408 * (IOW: if there *is* word to finalize, only then do it):
5410 || (n > 0 && output->data[output->length - 1])
5412 o_addchr(output, '\0');
5413 debug_print_list("expand_on_ifs", output, n);
5414 n = o_save_ptr(output, n);
5419 *ended_with_ifs = last_is_ifs;
5420 debug_print_list("expand_on_ifs[1]", output, n);
5424 /* Helper to expand $((...)) and heredoc body. These act as if
5425 * they are in double quotes, with the exception that they are not :).
5426 * Just the rules are similar: "expand only $var and `cmd`"
5428 * Returns malloced string.
5429 * As an optimization, we return NULL if expansion is not needed.
5431 #if !BASH_PATTERN_SUBST
5432 /* only ${var/pattern/repl} (its pattern part) needs additional mode */
5433 #define encode_then_expand_string(str, process_bkslash, do_unbackslash) \
5434 encode_then_expand_string(str)
5436 static char *encode_then_expand_string(const char *str, int process_bkslash, int do_unbackslash)
5438 #if !BASH_PATTERN_SUBST
5439 const int do_unbackslash = 1;
5442 struct in_str input;
5443 o_string dest = NULL_O_STRING;
5445 if (!strchr(str, '$')
5446 && !strchr(str, '\\')
5447 #if ENABLE_HUSH_TICK
5448 && !strchr(str, '`')
5454 /* We need to expand. Example:
5455 * echo $(($a + `echo 1`)) $((1 + $((2)) ))
5457 setup_string_in_str(&input, str);
5458 encode_string(NULL, &dest, &input, EOF, process_bkslash);
5459 //TODO: error check (encode_string returns 0 on error)?
5460 //bb_error_msg("'%s' -> '%s'", str, dest.data);
5461 exp_str = expand_string_to_string(dest.data, /*unbackslash:*/ do_unbackslash);
5462 //bb_error_msg("'%s' -> '%s'", dest.data, exp_str);
5463 o_free_unsafe(&dest);
5467 #if ENABLE_FEATURE_SH_MATH
5468 static arith_t expand_and_evaluate_arith(const char *arg, const char **errmsg_p)
5470 arith_state_t math_state;
5474 math_state.lookupvar = get_local_var_value;
5475 math_state.setvar = set_local_var_from_halves;
5476 //math_state.endofname = endofname;
5477 exp_str = encode_then_expand_string(arg, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
5478 res = arith(&math_state, exp_str ? exp_str : arg);
5481 *errmsg_p = math_state.errmsg;
5482 if (math_state.errmsg)
5483 die_if_script(math_state.errmsg);
5488 #if BASH_PATTERN_SUBST
5489 /* ${var/[/]pattern[/repl]} helpers */
5490 static char *strstr_pattern(char *val, const char *pattern, int *size)
5493 char *end = scan_and_match(val, pattern, SCAN_MOVE_FROM_RIGHT + SCAN_MATCH_LEFT_HALF);
5494 debug_printf_varexp("val:'%s' pattern:'%s' end:'%s'\n", val, pattern, end);
5501 /* Optimization: if "*pat" did not match the start of "string",
5502 * we know that "tring", "ring" etc will not match too:
5504 if (pattern[0] == '*')
5509 static char *replace_pattern(char *val, const char *pattern, const char *repl, char exp_op)
5511 char *result = NULL;
5512 unsigned res_len = 0;
5513 unsigned repl_len = strlen(repl);
5517 char *s = strstr_pattern(val, pattern, &size);
5521 result = xrealloc(result, res_len + (s - val) + repl_len + 1);
5522 memcpy(result + res_len, val, s - val);
5524 strcpy(result + res_len, repl);
5525 res_len += repl_len;
5526 debug_printf_varexp("val:'%s' s:'%s' result:'%s'\n", val, s, result);
5532 if (val[0] && result) {
5533 result = xrealloc(result, res_len + strlen(val) + 1);
5534 strcpy(result + res_len, val);
5535 debug_printf_varexp("val:'%s' result:'%s'\n", val, result);
5537 debug_printf_varexp("result:'%s'\n", result);
5540 #endif /* BASH_PATTERN_SUBST */
5543 * Handles <SPECIAL_VAR_SYMBOL>varname...<SPECIAL_VAR_SYMBOL> construct.
5545 static NOINLINE const char *expand_one_var(char **to_be_freed_pp, char *arg, char **pp)
5547 const char *val = NULL;
5548 char *to_be_freed = NULL;
5553 char exp_save = exp_save; /* for compiler */
5554 char *exp_saveptr; /* points to expansion operator */
5555 char *exp_word = exp_word; /* for compiler */
5558 *p = '\0'; /* replace trailing SPECIAL_VAR_SYMBOL */
5560 exp_saveptr = arg[1] ? strchr(VAR_ENCODED_SUBST_OPS, arg[1]) : NULL;
5562 first_char = arg[0] = arg0 & 0x7f;
5565 if (first_char == '#' /* ${#... */
5566 && arg[1] && !exp_saveptr /* not ${#} and not ${#<op_char>...} */
5568 /* It must be length operator: ${#var} */
5572 /* Maybe handle parameter expansion */
5573 if (exp_saveptr /* if 2nd char is one of expansion operators */
5574 && strchr(NUMERIC_SPECVARS_STR, first_char) /* 1st char is special variable */
5576 /* ${?:0}, ${#[:]%0} etc */
5577 exp_saveptr = var + 1;
5579 /* ${?}, ${var}, ${var:0}, ${var[:]%0} etc */
5580 exp_saveptr = var+1 + strcspn(var+1, VAR_ENCODED_SUBST_OPS);
5582 exp_op = exp_save = *exp_saveptr;
5584 exp_word = exp_saveptr + 1;
5585 if (exp_op == ':') {
5586 exp_op = *exp_word++;
5587 //TODO: try ${var:} and ${var:bogus} in non-bash config
5589 && (!exp_op || !strchr(MINUS_PLUS_EQUAL_QUESTION, exp_op))
5591 /* oops... it's ${var:N[:M]}, not ${var:?xxx} or some such */
5596 *exp_saveptr = '\0';
5597 } /* else: it's not an expansion op, but bare ${var} */
5600 /* Look up the variable in question */
5601 if (isdigit(var[0])) {
5602 /* parse_dollar should have vetted var for us */
5603 int n = xatoi_positive(var);
5604 if (n < G.global_argc)
5605 val = G.global_argv[n];
5606 /* else val remains NULL: $N with too big N */
5610 val = utoa(G.root_pid);
5612 case '!': /* bg pid */
5613 val = G.last_bg_pid ? utoa(G.last_bg_pid) : "";
5615 case '?': /* exitcode */
5616 val = utoa(G.last_exitcode);
5618 case '#': /* argc */
5619 val = utoa(G.global_argc ? G.global_argc-1 : 0);
5622 val = get_local_var_value(var);
5626 /* Handle any expansions */
5627 if (exp_op == 'L') {
5628 reinit_unicode_for_hush();
5629 debug_printf_expand("expand: length(%s)=", val);
5630 val = utoa(val ? unicode_strlen(val) : 0);
5631 debug_printf_expand("%s\n", val);
5632 } else if (exp_op) {
5633 if (exp_op == '%' || exp_op == '#') {
5634 /* Standard-mandated substring removal ops:
5635 * ${parameter%word} - remove smallest suffix pattern
5636 * ${parameter%%word} - remove largest suffix pattern
5637 * ${parameter#word} - remove smallest prefix pattern
5638 * ${parameter##word} - remove largest prefix pattern
5640 * Word is expanded to produce a glob pattern.
5641 * Then var's value is matched to it and matching part removed.
5643 if (val && val[0]) {
5647 unsigned scan_flags = pick_scan(exp_op, *exp_word);
5648 if (exp_op == *exp_word) /* ## or %% */
5650 exp_exp_word = encode_then_expand_string(exp_word, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
5652 exp_word = exp_exp_word;
5653 /* HACK ALERT. We depend here on the fact that
5654 * G.global_argv and results of utoa and get_local_var_value
5655 * are actually in writable memory:
5656 * scan_and_match momentarily stores NULs there. */
5658 loc = scan_and_match(t, exp_word, scan_flags);
5659 //bb_error_msg("op:%c str:'%s' pat:'%s' res:'%s'",
5660 // exp_op, t, exp_word, loc);
5662 if (loc) { /* match was found */
5663 if (scan_flags & SCAN_MATCH_LEFT_HALF) /* #[#] */
5664 val = loc; /* take right part */
5666 val = to_be_freed = xstrndup(val, loc - val); /* left */
5670 #if BASH_PATTERN_SUBST
5671 else if (exp_op == '/' || exp_op == '\\') {
5672 /* It's ${var/[/]pattern[/repl]} thing.
5673 * Note that in encoded form it has TWO parts:
5674 * var/pattern<SPECIAL_VAR_SYMBOL>repl<SPECIAL_VAR_SYMBOL>
5675 * and if // is used, it is encoded as \:
5676 * var\pattern<SPECIAL_VAR_SYMBOL>repl<SPECIAL_VAR_SYMBOL>
5678 /* Empty variable always gives nothing: */
5679 // "v=''; echo ${v/*/w}" prints "", not "w"
5680 if (val && val[0]) {
5681 /* pattern uses non-standard expansion.
5682 * repl should be unbackslashed and globbed
5683 * by the usual expansion rules:
5685 * v='a bz'; echo "${v/a*z/a*z}" prints "a*z"
5686 * v='a bz'; echo "${v/a*z/\z}" prints "\z"
5687 * v='a bz'; echo ${v/a*z/a*z} prints "az"
5688 * v='a bz'; echo ${v/a*z/\z} prints "z"
5689 * (note that a*z _pattern_ is never globbed!)
5691 char *pattern, *repl, *t;
5692 pattern = encode_then_expand_string(exp_word, /*process_bkslash:*/ 0, /*unbackslash:*/ 0);
5694 pattern = xstrdup(exp_word);
5695 debug_printf_varexp("pattern:'%s'->'%s'\n", exp_word, pattern);
5696 *p++ = SPECIAL_VAR_SYMBOL;
5698 p = strchr(p, SPECIAL_VAR_SYMBOL);
5700 repl = encode_then_expand_string(exp_word, /*process_bkslash:*/ arg0 & 0x80, /*unbackslash:*/ 1);
5701 debug_printf_varexp("repl:'%s'->'%s'\n", exp_word, repl);
5702 /* HACK ALERT. We depend here on the fact that
5703 * G.global_argv and results of utoa and get_local_var_value
5704 * are actually in writable memory:
5705 * replace_pattern momentarily stores NULs there. */
5707 to_be_freed = replace_pattern(t,
5709 (repl ? repl : exp_word),
5711 if (to_be_freed) /* at least one replace happened */
5717 #endif /* BASH_PATTERN_SUBST */
5718 else if (exp_op == ':') {
5719 #if BASH_SUBSTR && ENABLE_FEATURE_SH_MATH
5720 /* It's ${var:N[:M]} bashism.
5721 * Note that in encoded form it has TWO parts:
5722 * var:N<SPECIAL_VAR_SYMBOL>M<SPECIAL_VAR_SYMBOL>
5727 beg = expand_and_evaluate_arith(exp_word, &errmsg);
5730 debug_printf_varexp("beg:'%s'=%lld\n", exp_word, (long long)beg);
5731 *p++ = SPECIAL_VAR_SYMBOL;
5733 p = strchr(p, SPECIAL_VAR_SYMBOL);
5735 len = expand_and_evaluate_arith(exp_word, &errmsg);
5738 debug_printf_varexp("len:'%s'=%lld\n", exp_word, (long long)len);
5740 /* negative beg counts from the end */
5741 beg = (arith_t)strlen(val) + beg;
5742 if (beg < 0) /* ${v: -999999} is "" */
5745 debug_printf_varexp("from val:'%s'\n", val);
5747 /* in bash, len=-n means strlen()-n */
5748 len = (arith_t)strlen(val) - beg + len;
5749 if (len < 0) /* bash compat */
5750 die_if_script("%s: substring expression < 0", var);
5752 if (len <= 0 || !val || beg >= strlen(val)) {
5756 /* Paranoia. What if user entered 9999999999999
5757 * which fits in arith_t but not int? */
5760 val = to_be_freed = xstrndup(val + beg, len);
5762 debug_printf_varexp("val:'%s'\n", val);
5763 #else /* not (HUSH_SUBSTR_EXPANSION && FEATURE_SH_MATH) */
5764 die_if_script("malformed ${%s:...}", var);
5767 } else { /* one of "-=+?" */
5768 /* Standard-mandated substitution ops:
5769 * ${var?word} - indicate error if unset
5770 * If var is unset, word (or a message indicating it is unset
5771 * if word is null) is written to standard error
5772 * and the shell exits with a non-zero exit status.
5773 * Otherwise, the value of var is substituted.
5774 * ${var-word} - use default value
5775 * If var is unset, word is substituted.
5776 * ${var=word} - assign and use default value
5777 * If var is unset, word is assigned to var.
5778 * In all cases, final value of var is substituted.
5779 * ${var+word} - use alternative value
5780 * If var is unset, null is substituted.
5781 * Otherwise, word is substituted.
5783 * Word is subjected to tilde expansion, parameter expansion,
5784 * command substitution, and arithmetic expansion.
5785 * If word is not needed, it is not expanded.
5787 * Colon forms (${var:-word}, ${var:=word} etc) do the same,
5788 * but also treat null var as if it is unset.
5790 int use_word = (!val || ((exp_save == ':') && !val[0]));
5792 use_word = !use_word;
5793 debug_printf_expand("expand: op:%c (null:%s) test:%i\n", exp_op,
5794 (exp_save == ':') ? "true" : "false", use_word);
5796 to_be_freed = encode_then_expand_string(exp_word, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
5798 exp_word = to_be_freed;
5799 if (exp_op == '?') {
5800 /* mimic bash message */
5801 die_if_script("%s: %s",
5803 exp_word[0] ? exp_word : "parameter null or not set"
5805 //TODO: how interactive bash aborts expansion mid-command?
5810 if (exp_op == '=') {
5811 /* ${var=[word]} or ${var:=[word]} */
5812 if (isdigit(var[0]) || var[0] == '#') {
5813 /* mimic bash message */
5814 die_if_script("$%s: cannot assign in this way", var);
5817 char *new_var = xasprintf("%s=%s", var, val);
5818 set_local_var(new_var, /*flag:*/ 0);
5822 } /* one of "-=+?" */
5824 *exp_saveptr = exp_save;
5830 *to_be_freed_pp = to_be_freed;
5834 /* Expand all variable references in given string, adding words to list[]
5835 * at n, n+1,... positions. Return updated n (so that list[n] is next one
5836 * to be filled). This routine is extremely tricky: has to deal with
5837 * variables/parameters with whitespace, $* and $@, and constructs like
5838 * 'echo -$*-'. If you play here, you must run testsuite afterwards! */
5839 static NOINLINE int expand_vars_to_list(o_string *output, int n, char *arg)
5841 /* output->o_expflags & EXP_FLAG_SINGLEWORD (0x80) if we are in
5842 * expansion of right-hand side of assignment == 1-element expand.
5844 char cant_be_null = 0; /* only bit 0x80 matters */
5845 int ended_in_ifs = 0; /* did last unquoted expansion end with IFS chars? */
5848 debug_printf_expand("expand_vars_to_list: arg:'%s' singleword:%x\n", arg,
5849 !!(output->o_expflags & EXP_FLAG_SINGLEWORD));
5850 debug_print_list("expand_vars_to_list", output, n);
5851 n = o_save_ptr(output, n);
5852 debug_print_list("expand_vars_to_list[0]", output, n);
5854 while ((p = strchr(arg, SPECIAL_VAR_SYMBOL)) != NULL) {
5856 char *to_be_freed = NULL;
5857 const char *val = NULL;
5858 #if ENABLE_HUSH_TICK
5859 o_string subst_result = NULL_O_STRING;
5861 #if ENABLE_FEATURE_SH_MATH
5862 char arith_buf[sizeof(arith_t)*3 + 2];
5866 o_addchr(output, '\0');
5867 n = o_save_ptr(output, n);
5871 o_addblock(output, arg, p - arg);
5872 debug_print_list("expand_vars_to_list[1]", output, n);
5874 p = strchr(p, SPECIAL_VAR_SYMBOL);
5876 /* Fetch special var name (if it is indeed one of them)
5877 * and quote bit, force the bit on if singleword expansion -
5878 * important for not getting v=$@ expand to many words. */
5879 first_ch = arg[0] | (output->o_expflags & EXP_FLAG_SINGLEWORD);
5881 /* Is this variable quoted and thus expansion can't be null?
5882 * "$@" is special. Even if quoted, it can still
5883 * expand to nothing (not even an empty string),
5884 * thus it is excluded. */
5885 if ((first_ch & 0x7f) != '@')
5886 cant_be_null |= first_ch;
5888 switch (first_ch & 0x7f) {
5889 /* Highest bit in first_ch indicates that var is double-quoted */
5893 if (!G.global_argv[1])
5896 cant_be_null |= first_ch; /* do it for "$@" _now_, when we know it's not empty */
5897 if (!(first_ch & 0x80)) { /* unquoted $* or $@ */
5898 while (G.global_argv[i]) {
5899 n = expand_on_ifs(NULL, output, n, G.global_argv[i]);
5900 debug_printf_expand("expand_vars_to_list: argv %d (last %d)\n", i, G.global_argc - 1);
5901 if (G.global_argv[i++][0] && G.global_argv[i]) {
5902 /* this argv[] is not empty and not last:
5903 * put terminating NUL, start new word */
5904 o_addchr(output, '\0');
5905 debug_print_list("expand_vars_to_list[2]", output, n);
5906 n = o_save_ptr(output, n);
5907 debug_print_list("expand_vars_to_list[3]", output, n);
5911 /* If EXP_FLAG_SINGLEWORD, we handle assignment 'a=....$@.....'
5912 * and in this case should treat it like '$*' - see 'else...' below */
5913 if (first_ch == ('@'|0x80) /* quoted $@ */
5914 && !(output->o_expflags & EXP_FLAG_SINGLEWORD) /* not v="$@" case */
5917 o_addQstr(output, G.global_argv[i]);
5918 if (++i >= G.global_argc)
5920 o_addchr(output, '\0');
5921 debug_print_list("expand_vars_to_list[4]", output, n);
5922 n = o_save_ptr(output, n);
5924 } else { /* quoted $* (or v="$@" case): add as one word */
5926 o_addQstr(output, G.global_argv[i]);
5927 if (!G.global_argv[++i])
5930 o_addchr(output, G.ifs[0]);
5932 output->has_quoted_part = 1;
5936 case SPECIAL_VAR_SYMBOL: /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_SYMBOL> */
5937 /* "Empty variable", used to make "" etc to not disappear */
5938 output->has_quoted_part = 1;
5940 cant_be_null = 0x80;
5942 #if ENABLE_HUSH_TICK
5943 case '`': /* <SPECIAL_VAR_SYMBOL>`cmd<SPECIAL_VAR_SYMBOL> */
5944 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
5946 /* Can't just stuff it into output o_string,
5947 * expanded result may need to be globbed
5949 debug_printf_subst("SUBST '%s' first_ch %x\n", arg, first_ch);
5950 G.last_exitcode = process_command_subs(&subst_result, arg);
5951 debug_printf_subst("SUBST RES:%d '%s'\n", G.last_exitcode, subst_result.data);
5952 val = subst_result.data;
5955 #if ENABLE_FEATURE_SH_MATH
5956 case '+': { /* <SPECIAL_VAR_SYMBOL>+cmd<SPECIAL_VAR_SYMBOL> */
5959 arg++; /* skip '+' */
5960 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
5961 debug_printf_subst("ARITH '%s' first_ch %x\n", arg, first_ch);
5962 res = expand_and_evaluate_arith(arg, NULL);
5963 debug_printf_subst("ARITH RES '"ARITH_FMT"'\n", res);
5964 sprintf(arith_buf, ARITH_FMT, res);
5970 val = expand_one_var(&to_be_freed, arg, &p);
5971 IF_HUSH_TICK(store_val:)
5972 if (!(first_ch & 0x80)) { /* unquoted $VAR */
5973 debug_printf_expand("unquoted '%s', output->o_escape:%d\n", val,
5974 !!(output->o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
5975 if (val && val[0]) {
5976 n = expand_on_ifs(&ended_in_ifs, output, n, val);
5979 } else { /* quoted $VAR, val will be appended below */
5980 output->has_quoted_part = 1;
5981 debug_printf_expand("quoted '%s', output->o_escape:%d\n", val,
5982 !!(output->o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
5985 } /* switch (char after <SPECIAL_VAR_SYMBOL>) */
5987 if (val && val[0]) {
5988 o_addQstr(output, val);
5992 /* Restore NULL'ed SPECIAL_VAR_SYMBOL.
5993 * Do the check to avoid writing to a const string. */
5994 if (*p != SPECIAL_VAR_SYMBOL)
5995 *p = SPECIAL_VAR_SYMBOL;
5997 #if ENABLE_HUSH_TICK
5998 o_free(&subst_result);
6001 } /* end of "while (SPECIAL_VAR_SYMBOL is found) ..." */
6005 o_addchr(output, '\0');
6006 n = o_save_ptr(output, n);
6008 debug_print_list("expand_vars_to_list[a]", output, n);
6009 /* this part is literal, and it was already pre-quoted
6010 * if needed (much earlier), do not use o_addQstr here! */
6011 o_addstr_with_NUL(output, arg);
6012 debug_print_list("expand_vars_to_list[b]", output, n);
6013 } else if (output->length == o_get_last_ptr(output, n) /* expansion is empty */
6014 && !(cant_be_null & 0x80) /* and all vars were not quoted. */
6017 /* allow to reuse list[n] later without re-growth */
6018 output->has_empty_slot = 1;
6020 o_addchr(output, '\0');
6026 static char **expand_variables(char **argv, unsigned expflags)
6030 o_string output = NULL_O_STRING;
6032 output.o_expflags = expflags;
6036 n = expand_vars_to_list(&output, n, *argv);
6039 debug_print_list("expand_variables", &output, n);
6041 /* output.data (malloced in one block) gets returned in "list" */
6042 list = o_finalize_list(&output, n);
6043 debug_print_strings("expand_variables[1]", list);
6047 static char **expand_strvec_to_strvec(char **argv)
6049 return expand_variables(argv, EXP_FLAG_GLOB | EXP_FLAG_ESC_GLOB_CHARS);
6053 static char **expand_strvec_to_strvec_singleword_noglob(char **argv)
6055 return expand_variables(argv, EXP_FLAG_SINGLEWORD);
6059 /* Used for expansion of right hand of assignments,
6060 * $((...)), heredocs, variable espansion parts.
6062 * NB: should NOT do globbing!
6063 * "export v=/bin/c*; env | grep ^v=" outputs "v=/bin/c*"
6065 static char *expand_string_to_string(const char *str, int do_unbackslash)
6067 #if !BASH_PATTERN_SUBST && !ENABLE_HUSH_CASE
6068 const int do_unbackslash = 1;
6070 char *argv[2], **list;
6072 debug_printf_expand("string_to_string<='%s'\n", str);
6073 /* This is generally an optimization, but it also
6074 * handles "", which otherwise trips over !list[0] check below.
6075 * (is this ever happens that we actually get str="" here?)
6077 if (!strchr(str, SPECIAL_VAR_SYMBOL) && !strchr(str, '\\')) {
6078 //TODO: Can use on strings with \ too, just unbackslash() them?
6079 debug_printf_expand("string_to_string(fast)=>'%s'\n", str);
6080 return xstrdup(str);
6083 argv[0] = (char*)str;
6085 list = expand_variables(argv, do_unbackslash
6086 ? EXP_FLAG_ESC_GLOB_CHARS | EXP_FLAG_SINGLEWORD
6087 : EXP_FLAG_SINGLEWORD
6090 if (!list[0] || list[1])
6091 bb_error_msg_and_die("BUG in varexp2");
6092 /* actually, just move string 2*sizeof(char*) bytes back */
6093 overlapping_strcpy((char*)list, list[0]);
6095 unbackslash((char*)list);
6096 debug_printf_expand("string_to_string=>'%s'\n", (char*)list);
6100 /* Used for "eval" builtin and case string */
6101 static char* expand_strvec_to_string(char **argv)
6105 list = expand_variables(argv, EXP_FLAG_SINGLEWORD);
6106 /* Convert all NULs to spaces */
6111 if (list[n-1] + strlen(list[n-1]) + 1 != list[n])
6112 bb_error_msg_and_die("BUG in varexp3");
6113 /* bash uses ' ' regardless of $IFS contents */
6118 overlapping_strcpy((char*)list, list[0] ? list[0] : "");
6119 debug_printf_expand("strvec_to_string='%s'\n", (char*)list);
6123 static char **expand_assignments(char **argv, int count)
6128 G.expanded_assignments = p = NULL;
6129 /* Expand assignments into one string each */
6130 for (i = 0; i < count; i++) {
6131 G.expanded_assignments = p = add_string_to_strings(p, expand_string_to_string(argv[i], /*unbackslash:*/ 1));
6133 G.expanded_assignments = NULL;
6138 static void switch_off_special_sigs(unsigned mask)
6141 while ((mask >>= 1) != 0) {
6145 #if ENABLE_HUSH_TRAP
6147 if (G_traps[sig] && !G_traps[sig][0])
6148 /* trap is '', has to remain SIG_IGN */
6151 G_traps[sig] = NULL;
6154 /* We are here only if no trap or trap was not '' */
6155 install_sighandler(sig, SIG_DFL);
6161 void re_execute_shell(char ***to_free, const char *s,
6162 char *g_argv0, char **g_argv,
6163 char **builtin_argv) NORETURN;
6165 static void reset_traps_to_defaults(void)
6167 /* This function is always called in a child shell
6168 * after fork (not vfork, NOMMU doesn't use this function).
6170 IF_HUSH_TRAP(unsigned sig;)
6173 /* Child shells are not interactive.
6174 * SIGTTIN/SIGTTOU/SIGTSTP should not have special handling.
6175 * Testcase: (while :; do :; done) + ^Z should background.
6176 * Same goes for SIGTERM, SIGHUP, SIGINT.
6178 mask = (G.special_sig_mask & SPECIAL_INTERACTIVE_SIGS) | G_fatal_sig_mask;
6179 if (!G_traps && !mask)
6180 return; /* already no traps and no special sigs */
6182 /* Switch off special sigs */
6183 switch_off_special_sigs(mask);
6184 # if ENABLE_HUSH_JOB
6185 G_fatal_sig_mask = 0;
6187 G.special_sig_mask &= ~SPECIAL_INTERACTIVE_SIGS;
6188 /* SIGQUIT,SIGCHLD and maybe SPECIAL_JOBSTOP_SIGS
6189 * remain set in G.special_sig_mask */
6191 # if ENABLE_HUSH_TRAP
6195 /* Reset all sigs to default except ones with empty traps */
6196 for (sig = 0; sig < NSIG; sig++) {
6198 continue; /* no trap: nothing to do */
6199 if (!G_traps[sig][0])
6200 continue; /* empty trap: has to remain SIG_IGN */
6201 /* sig has non-empty trap, reset it: */
6203 G_traps[sig] = NULL;
6204 /* There is no signal for trap 0 (EXIT) */
6207 install_sighandler(sig, pick_sighandler(sig));
6214 static void re_execute_shell(char ***to_free, const char *s,
6215 char *g_argv0, char **g_argv,
6216 char **builtin_argv) NORETURN;
6217 static void re_execute_shell(char ***to_free, const char *s,
6218 char *g_argv0, char **g_argv,
6219 char **builtin_argv)
6221 # define NOMMU_HACK_FMT ("-$%x:%x:%x:%x:%x:%llx" IF_HUSH_LOOPS(":%x"))
6222 /* delims + 2 * (number of bytes in printed hex numbers) */
6223 char param_buf[sizeof(NOMMU_HACK_FMT) + 2 * (sizeof(int)*6 + sizeof(long long)*1)];
6224 char *heredoc_argv[4];
6225 struct variable *cur;
6226 # if ENABLE_HUSH_FUNCTIONS
6227 struct function *funcp;
6231 unsigned long long empty_trap_mask;
6233 if (!g_argv0) { /* heredoc */
6234 argv = heredoc_argv;
6235 argv[0] = (char *) G.argv0_for_re_execing;
6236 argv[1] = (char *) "-<";
6237 argv[2] = (char *) s;
6239 pp = &argv[3]; /* used as pointer to empty environment */
6245 if (pp) while (*pp++)
6248 empty_trap_mask = 0;
6251 for (sig = 1; sig < NSIG; sig++) {
6252 if (G_traps[sig] && !G_traps[sig][0])
6253 empty_trap_mask |= 1LL << sig;
6257 sprintf(param_buf, NOMMU_HACK_FMT
6258 , (unsigned) G.root_pid
6259 , (unsigned) G.root_ppid
6260 , (unsigned) G.last_bg_pid
6261 , (unsigned) G.last_exitcode
6264 IF_HUSH_LOOPS(, G.depth_of_loop)
6266 # undef NOMMU_HACK_FMT
6267 /* 1:hush 2:-$<pid>:<pid>:<exitcode>:<etc...> <vars...> <funcs...>
6268 * 3:-c 4:<cmd> 5:<arg0> <argN...> 6:NULL
6271 for (cur = G.top_var; cur; cur = cur->next) {
6272 if (!cur->flg_export || cur->flg_read_only)
6275 # if ENABLE_HUSH_FUNCTIONS
6276 for (funcp = G.top_func; funcp; funcp = funcp->next)
6282 *to_free = argv = pp = xzalloc(sizeof(argv[0]) * cnt);
6283 *pp++ = (char *) G.argv0_for_re_execing;
6285 for (cur = G.top_var; cur; cur = cur->next) {
6286 if (strcmp(cur->varstr, hush_version_str) == 0)
6288 if (cur->flg_read_only) {
6289 *pp++ = (char *) "-R";
6290 *pp++ = cur->varstr;
6291 } else if (!cur->flg_export) {
6292 *pp++ = (char *) "-V";
6293 *pp++ = cur->varstr;
6296 # if ENABLE_HUSH_FUNCTIONS
6297 for (funcp = G.top_func; funcp; funcp = funcp->next) {
6298 *pp++ = (char *) "-F";
6299 *pp++ = funcp->name;
6300 *pp++ = funcp->body_as_string;
6303 /* We can pass activated traps here. Say, -Tnn:trap_string
6305 * However, POSIX says that subshells reset signals with traps
6307 * I tested bash-3.2 and it not only does that with true subshells
6308 * of the form ( list ), but with any forked children shells.
6309 * I set trap "echo W" WINCH; and then tried:
6311 * { echo 1; sleep 20; echo 2; } &
6312 * while true; do echo 1; sleep 20; echo 2; break; done &
6313 * true | { echo 1; sleep 20; echo 2; } | cat
6315 * In all these cases sending SIGWINCH to the child shell
6316 * did not run the trap. If I add trap "echo V" WINCH;
6317 * _inside_ group (just before echo 1), it works.
6319 * I conclude it means we don't need to pass active traps here.
6321 *pp++ = (char *) "-c";
6324 while (*++builtin_argv)
6325 *pp++ = *builtin_argv;
6326 *pp++ = (char *) "";
6331 /* *pp = NULL; - is already there */
6335 debug_printf_exec("re_execute_shell pid:%d cmd:'%s'\n", getpid(), s);
6336 /* Don't propagate SIG_IGN to the child */
6337 if (SPECIAL_JOBSTOP_SIGS != 0)
6338 switch_off_special_sigs(G.special_sig_mask & SPECIAL_JOBSTOP_SIGS);
6339 execve(bb_busybox_exec_path, argv, pp);
6340 /* Fallback. Useful for init=/bin/hush usage etc */
6341 if (argv[0][0] == '/')
6342 execve(argv[0], argv, pp);
6343 xfunc_error_retval = 127;
6344 bb_error_msg_and_die("can't re-execute the shell");
6346 #endif /* !BB_MMU */
6349 static int run_and_free_list(struct pipe *pi);
6351 /* Executing from string: eval, sh -c '...'
6352 * or from file: /etc/profile, . file, sh <script>, sh (intereactive)
6353 * end_trigger controls how often we stop parsing
6354 * NUL: parse all, execute, return
6355 * ';': parse till ';' or newline, execute, repeat till EOF
6357 static void parse_and_run_stream(struct in_str *inp, int end_trigger)
6359 /* Why we need empty flag?
6360 * An obscure corner case "false; ``; echo $?":
6361 * empty command in `` should still set $? to 0.
6362 * But we can't just set $? to 0 at the start,
6363 * this breaks "false; echo `echo $?`" case.
6367 struct pipe *pipe_list;
6369 #if ENABLE_HUSH_INTERACTIVE
6370 if (end_trigger == ';')
6371 inp->promptmode = 0; /* PS1 */
6373 pipe_list = parse_stream(NULL, inp, end_trigger);
6374 if (!pipe_list || pipe_list == ERR_PTR) { /* EOF/error */
6375 /* If we are in "big" script
6376 * (not in `cmd` or something similar)...
6378 if (pipe_list == ERR_PTR && end_trigger == ';') {
6379 /* Discard cached input (rest of line) */
6380 int ch = inp->last_char;
6381 while (ch != EOF && ch != '\n') {
6382 //bb_error_msg("Discarded:'%c'", ch);
6387 /* This stream isn't empty */
6391 if (!pipe_list && empty)
6392 G.last_exitcode = 0;
6395 debug_print_tree(pipe_list, 0);
6396 debug_printf_exec("parse_and_run_stream: run_and_free_list\n");
6397 run_and_free_list(pipe_list);
6399 if (G_flag_return_in_progress == 1)
6404 static void parse_and_run_string(const char *s)
6406 struct in_str input;
6407 setup_string_in_str(&input, s);
6408 parse_and_run_stream(&input, '\0');
6411 static void parse_and_run_file(FILE *f)
6413 struct in_str input;
6414 setup_file_in_str(&input, f);
6415 parse_and_run_stream(&input, ';');
6418 #if ENABLE_HUSH_TICK
6419 static FILE *generate_stream_from_string(const char *s, pid_t *pid_p)
6424 char **to_free = NULL;
6428 pid = BB_MMU ? xfork() : xvfork();
6429 if (pid == 0) { /* child */
6430 disable_restore_tty_pgrp_on_exit();
6431 /* Process substitution is not considered to be usual
6432 * 'command execution'.
6433 * SUSv3 says ctrl-Z should be ignored, ctrl-C should not.
6440 CLEAR_RANDOM_T(&G.random_gen); /* or else $RANDOM repeats in child */
6441 close(channel[0]); /* NB: close _first_, then move fd! */
6442 xmove_fd(channel[1], 1);
6443 /* Prevent it from trying to handle ctrl-z etc */
6444 IF_HUSH_JOB(G.run_list_level = 1;)
6445 # if ENABLE_HUSH_TRAP
6446 /* Awful hack for `trap` or $(trap).
6448 * http://www.opengroup.org/onlinepubs/009695399/utilities/trap.html
6449 * contains an example where "trap" is executed in a subshell:
6451 * save_traps=$(trap)
6453 * eval "$save_traps"
6455 * Standard does not say that "trap" in subshell shall print
6456 * parent shell's traps. It only says that its output
6457 * must have suitable form, but then, in the above example
6458 * (which is not supposed to be normative), it implies that.
6460 * bash (and probably other shell) does implement it
6461 * (traps are reset to defaults, but "trap" still shows them),
6462 * but as a result, "trap" logic is hopelessly messed up:
6465 * trap -- 'echo Ho' SIGWINCH <--- we have a handler
6466 * # (trap) <--- trap is in subshell - no output (correct, traps are reset)
6467 * # true | trap <--- trap is in subshell - no output (ditto)
6468 * # echo `true | trap` <--- in subshell - output (but traps are reset!)
6469 * trap -- 'echo Ho' SIGWINCH
6470 * # echo `(trap)` <--- in subshell in subshell - output
6471 * trap -- 'echo Ho' SIGWINCH
6472 * # echo `true | (trap)` <--- in subshell in subshell in subshell - output!
6473 * trap -- 'echo Ho' SIGWINCH
6475 * The rules when to forget and when to not forget traps
6476 * get really complex and nonsensical.
6478 * Our solution: ONLY bare $(trap) or `trap` is special.
6480 s = skip_whitespace(s);
6481 if (is_prefixed_with(s, "trap")
6482 && skip_whitespace(s + 4)[0] == '\0'
6484 static const char *const argv[] = { NULL, NULL };
6485 builtin_trap((char**)argv);
6486 fflush_all(); /* important */
6491 reset_traps_to_defaults();
6492 parse_and_run_string(s);
6493 _exit(G.last_exitcode);
6495 /* We re-execute after vfork on NOMMU. This makes this script safe:
6496 * yes "0123456789012345678901234567890" | dd bs=32 count=64k >BIG
6497 * huge=`cat BIG` # was blocking here forever
6500 re_execute_shell(&to_free,
6510 # if ENABLE_HUSH_FAST
6512 //bb_error_msg("[%d] fork in generate_stream_from_string:"
6513 // " G.count_SIGCHLD:%d G.handled_SIGCHLD:%d",
6514 // getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
6516 enable_restore_tty_pgrp_on_exit();
6521 return remember_FILE(xfdopen_for_read(channel[0]));
6524 /* Return code is exit status of the process that is run. */
6525 static int process_command_subs(o_string *dest, const char *s)
6528 struct in_str pipe_str;
6530 int status, ch, eol_cnt;
6532 fp = generate_stream_from_string(s, &pid);
6534 /* Now send results of command back into original context */
6535 setup_file_in_str(&pipe_str, fp);
6537 while ((ch = i_getch(&pipe_str)) != EOF) {
6543 o_addchr(dest, '\n');
6546 o_addQchr(dest, ch);
6549 debug_printf("done reading from `cmd` pipe, closing it\n");
6550 fclose_and_forget(fp);
6551 /* We need to extract exitcode. Test case
6552 * "true; echo `sleep 1; false` $?"
6554 safe_waitpid(pid, &status, 0);
6555 debug_printf("child exited. returning its exitcode:%d\n", WEXITSTATUS(status));
6556 return WEXITSTATUS(status);
6558 #endif /* ENABLE_HUSH_TICK */
6561 static void setup_heredoc(struct redir_struct *redir)
6563 struct fd_pair pair;
6566 /* the _body_ of heredoc (misleading field name) */
6567 const char *heredoc = redir->rd_filename;
6574 if (!(redir->rd_dup & HEREDOC_QUOTED)) {
6575 expanded = encode_then_expand_string(heredoc, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
6579 len = strlen(heredoc);
6581 close(redir->rd_fd); /* often saves dup2+close in xmove_fd */
6583 xmove_fd(pair.rd, redir->rd_fd);
6585 /* Try writing without forking. Newer kernels have
6586 * dynamically growing pipes. Must use non-blocking write! */
6589 written = write(pair.wr, heredoc, len);
6600 ndelay_off(pair.wr);
6602 /* Okay, pipe buffer was not big enough */
6603 /* Note: we must not create a stray child (bastard? :)
6604 * for the unsuspecting parent process. Child creates a grandchild
6605 * and exits before parent execs the process which consumes heredoc
6606 * (that exec happens after we return from this function) */
6613 disable_restore_tty_pgrp_on_exit();
6614 pid = BB_MMU ? xfork() : xvfork();
6618 close(redir->rd_fd); /* read side of the pipe */
6620 full_write(pair.wr, heredoc, len); /* may loop or block */
6623 /* Delegate blocking writes to another process */
6624 xmove_fd(pair.wr, STDOUT_FILENO);
6625 re_execute_shell(&to_free, heredoc, NULL, NULL, NULL);
6629 #if ENABLE_HUSH_FAST
6631 //bb_error_msg("[%d] fork in setup_heredoc: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
6633 enable_restore_tty_pgrp_on_exit();
6639 wait(NULL); /* wait till child has died */
6645 /* moved_to = n: fd was moved to n; restore back to orig_fd after redir */
6646 /* moved_to = -1: fd was opened by redirect; close orig_fd after redir */
6649 static struct squirrel *add_squirrel(struct squirrel *sq, int fd, int avoid_fd)
6653 if (sq) while (sq[i].orig_fd >= 0) {
6654 /* If we collide with an already moved fd... */
6655 if (fd == sq[i].moved_to) {
6656 sq[i].moved_to = fcntl_F_DUPFD(sq[i].moved_to, avoid_fd);
6657 debug_printf_redir("redirect_fd %d: already busy, moving to %d\n", fd, sq[i].moved_to);
6658 if (sq[i].moved_to < 0) /* what? */
6662 if (fd == sq[i].orig_fd) {
6663 /* Example: echo Hello >/dev/null 1>&2 */
6664 debug_printf_redir("redirect_fd %d: already moved\n", fd);
6670 sq = xrealloc(sq, (i + 2) * sizeof(sq[0]));
6672 /* If this fd is open, we move and remember it; if it's closed, moved_to = -1 */
6673 sq[i].moved_to = fcntl_F_DUPFD(fd, avoid_fd);
6674 debug_printf_redir("redirect_fd %d: previous fd is moved to %d (-1 if it was closed)\n", fd, sq[i].moved_to);
6675 if (sq[i].moved_to < 0 && errno != EBADF)
6677 sq[i+1].orig_fd = -1; /* end marker */
6681 /* fd: redirect wants this fd to be used (e.g. 3>file).
6682 * Move all conflicting internally used fds,
6683 * and remember them so that we can restore them later.
6685 static int save_fds_on_redirect(int fd, int avoid_fd, struct squirrel **sqp)
6687 if (avoid_fd < 9) /* the important case here is that it can be -1 */
6690 #if ENABLE_HUSH_INTERACTIVE
6691 if (fd != 0 && fd == G.interactive_fd) {
6692 G.interactive_fd = xdup_and_close(G.interactive_fd, F_DUPFD_CLOEXEC, avoid_fd);
6693 debug_printf_redir("redirect_fd %d: matches interactive_fd, moving it to %d\n", fd, G.interactive_fd);
6694 return 1; /* "we closed fd" */
6697 /* Are we called from setup_redirects(squirrel==NULL)? Two cases:
6698 * (1) Redirect in a forked child. No need to save FILEs' fds,
6699 * we aren't going to use them anymore, ok to trash.
6700 * (2) "exec 3>FILE". Bummer. We can save script FILEs' fds,
6701 * but how are we doing to restore them?
6702 * "fileno(fd) = new_fd" can't be done.
6707 /* If this one of script's fds? */
6708 if (save_FILEs_on_redirect(fd, avoid_fd))
6709 return 1; /* yes. "we closed fd" */
6711 /* Check whether it collides with any open fds (e.g. stdio), save fds as needed */
6712 *sqp = add_squirrel(*sqp, fd, avoid_fd);
6713 return 0; /* "we did not close fd" */
6716 static void restore_redirects(struct squirrel *sq)
6721 while (sq[i].orig_fd >= 0) {
6722 if (sq[i].moved_to >= 0) {
6723 /* We simply die on error */
6724 debug_printf_redir("restoring redirected fd from %d to %d\n", sq[i].moved_to, sq[i].orig_fd);
6725 xmove_fd(sq[i].moved_to, sq[i].orig_fd);
6727 /* cmd1 9>FILE; cmd2_should_see_fd9_closed */
6728 debug_printf_redir("restoring redirected fd %d: closing it\n", sq[i].orig_fd);
6729 close(sq[i].orig_fd);
6736 /* If moved, G.interactive_fd stays on new fd, not restoring it */
6738 restore_redirected_FILEs();
6741 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
6742 * and stderr if they are redirected. */
6743 static int setup_redirects(struct command *prog, struct squirrel **sqp)
6746 struct redir_struct *redir;
6748 for (redir = prog->redirects; redir; redir = redir->next) {
6749 if (redir->rd_type == REDIRECT_HEREDOC2) {
6750 /* "rd_fd<<HERE" case */
6751 save_fds_on_redirect(redir->rd_fd, /*avoid:*/ 0, sqp);
6752 /* for REDIRECT_HEREDOC2, rd_filename holds _contents_
6754 debug_printf_parse("set heredoc '%s'\n",
6755 redir->rd_filename);
6756 setup_heredoc(redir);
6760 if (redir->rd_dup == REDIRFD_TO_FILE) {
6761 /* "rd_fd<*>file" case (<*> is <,>,>>,<>) */
6763 if (redir->rd_filename == NULL) {
6766 * "cmd >" (no filename)
6767 * "cmd > <file" (2nd redirect starts too early)
6769 die_if_script("syntax error: %s", "invalid redirect");
6772 mode = redir_table[redir->rd_type].mode;
6773 p = expand_string_to_string(redir->rd_filename, /*unbackslash:*/ 1);
6774 openfd = open_or_warn(p, mode);
6777 /* Error message from open_or_warn can be lost
6778 * if stderr has been redirected, but bash
6779 * and ash both lose it as well
6780 * (though zsh doesn't!)
6785 /* "rd_fd<*>rd_dup" or "rd_fd<*>-" cases */
6786 openfd = redir->rd_dup;
6789 if (openfd != redir->rd_fd) {
6790 int closed = save_fds_on_redirect(redir->rd_fd, /*avoid:*/ openfd, sqp);
6791 if (openfd == REDIRFD_CLOSE) {
6792 /* "rd_fd >&-" means "close me" */
6794 /* ^^^ optimization: saving may already
6795 * have closed it. If not... */
6796 close(redir->rd_fd);
6799 xdup2(openfd, redir->rd_fd);
6800 if (redir->rd_dup == REDIRFD_TO_FILE)
6801 /* "rd_fd > FILE" */
6803 /* else: "rd_fd > rd_dup" */
6810 static char *find_in_path(const char *arg)
6813 const char *PATH = get_local_var_value("PATH");
6819 const char *end = strchrnul(PATH, ':');
6820 int sz = end - PATH; /* must be int! */
6824 ret = xasprintf("%.*s/%s", sz, PATH, arg);
6826 /* We have xxx::yyyy in $PATH,
6827 * it means "use current dir" */
6830 if (access(ret, F_OK) == 0)
6843 static const struct built_in_command *find_builtin_helper(const char *name,
6844 const struct built_in_command *x,
6845 const struct built_in_command *end)
6848 if (strcmp(name, x->b_cmd) != 0) {
6852 debug_printf_exec("found builtin '%s'\n", name);
6857 static const struct built_in_command *find_builtin1(const char *name)
6859 return find_builtin_helper(name, bltins1, &bltins1[ARRAY_SIZE(bltins1)]);
6861 static const struct built_in_command *find_builtin(const char *name)
6863 const struct built_in_command *x = find_builtin1(name);
6866 return find_builtin_helper(name, bltins2, &bltins2[ARRAY_SIZE(bltins2)]);
6869 #if ENABLE_HUSH_FUNCTIONS
6870 static struct function **find_function_slot(const char *name)
6872 struct function **funcpp = &G.top_func;
6874 if (strcmp(name, (*funcpp)->name) == 0) {
6877 funcpp = &(*funcpp)->next;
6882 static const struct function *find_function(const char *name)
6884 const struct function *funcp = *find_function_slot(name);
6886 debug_printf_exec("found function '%s'\n", name);
6890 /* Note: takes ownership on name ptr */
6891 static struct function *new_function(char *name)
6893 struct function **funcpp = find_function_slot(name);
6894 struct function *funcp = *funcpp;
6896 if (funcp != NULL) {
6897 struct command *cmd = funcp->parent_cmd;
6898 debug_printf_exec("func %p parent_cmd %p\n", funcp, cmd);
6900 debug_printf_exec("freeing & replacing function '%s'\n", funcp->name);
6902 /* Note: if !funcp->body, do not free body_as_string!
6903 * This is a special case of "-F name body" function:
6904 * body_as_string was not malloced! */
6906 free_pipe_list(funcp->body);
6908 free(funcp->body_as_string);
6912 debug_printf_exec("reinserting in tree & replacing function '%s'\n", funcp->name);
6913 cmd->argv[0] = funcp->name;
6914 cmd->group = funcp->body;
6916 cmd->group_as_string = funcp->body_as_string;
6920 debug_printf_exec("remembering new function '%s'\n", name);
6921 funcp = *funcpp = xzalloc(sizeof(*funcp));
6922 /*funcp->next = NULL;*/
6929 # if ENABLE_HUSH_UNSET
6930 static void unset_func(const char *name)
6932 struct function **funcpp = find_function_slot(name);
6933 struct function *funcp = *funcpp;
6935 if (funcp != NULL) {
6936 debug_printf_exec("freeing function '%s'\n", funcp->name);
6937 *funcpp = funcp->next;
6938 /* funcp is unlinked now, deleting it.
6939 * Note: if !funcp->body, the function was created by
6940 * "-F name body", do not free ->body_as_string
6941 * and ->name as they were not malloced. */
6943 free_pipe_list(funcp->body);
6946 free(funcp->body_as_string);
6955 #define exec_function(to_free, funcp, argv) \
6956 exec_function(funcp, argv)
6958 static void exec_function(char ***to_free,
6959 const struct function *funcp,
6960 char **argv) NORETURN;
6961 static void exec_function(char ***to_free,
6962 const struct function *funcp,
6968 argv[0] = G.global_argv[0];
6969 G.global_argv = argv;
6970 G.global_argc = n = 1 + string_array_len(argv + 1);
6971 /* On MMU, funcp->body is always non-NULL */
6972 n = run_list(funcp->body);
6976 re_execute_shell(to_free,
6977 funcp->body_as_string,
6984 static int run_function(const struct function *funcp, char **argv)
6990 save_and_replace_G_args(&sv, argv);
6992 /* "we are in function, ok to use return" */
6993 sv_flg = G_flag_return_in_progress;
6994 G_flag_return_in_progress = -1;
6995 # if ENABLE_HUSH_LOCAL
6996 G.func_nest_level++;
6999 /* On MMU, funcp->body is always non-NULL */
7002 /* Function defined by -F */
7003 parse_and_run_string(funcp->body_as_string);
7004 rc = G.last_exitcode;
7008 rc = run_list(funcp->body);
7011 # if ENABLE_HUSH_LOCAL
7013 struct variable *var;
7014 struct variable **var_pp;
7016 var_pp = &G.top_var;
7017 while ((var = *var_pp) != NULL) {
7018 if (var->func_nest_level < G.func_nest_level) {
7019 var_pp = &var->next;
7023 if (var->flg_export)
7024 bb_unsetenv(var->varstr);
7025 /* Remove from global list */
7026 *var_pp = var->next;
7032 G.func_nest_level--;
7035 G_flag_return_in_progress = sv_flg;
7037 restore_G_args(&sv, argv);
7041 #endif /* ENABLE_HUSH_FUNCTIONS */
7045 #define exec_builtin(to_free, x, argv) \
7046 exec_builtin(x, argv)
7048 #define exec_builtin(to_free, x, argv) \
7049 exec_builtin(to_free, argv)
7051 static void exec_builtin(char ***to_free,
7052 const struct built_in_command *x,
7053 char **argv) NORETURN;
7054 static void exec_builtin(char ***to_free,
7055 const struct built_in_command *x,
7061 rcode = x->b_function(argv);
7066 /* On NOMMU, we must never block!
7067 * Example: { sleep 99 | read line; } & echo Ok
7069 re_execute_shell(to_free,
7078 static void execvp_or_die(char **argv) NORETURN;
7079 static void execvp_or_die(char **argv)
7082 debug_printf_exec("execing '%s'\n", argv[0]);
7083 /* Don't propagate SIG_IGN to the child */
7084 if (SPECIAL_JOBSTOP_SIGS != 0)
7085 switch_off_special_sigs(G.special_sig_mask & SPECIAL_JOBSTOP_SIGS);
7086 execvp(argv[0], argv);
7088 if (errno == EACCES) e = 126;
7089 if (errno == ENOENT) e = 127;
7090 bb_perror_msg("can't execute '%s'", argv[0]);
7094 #if ENABLE_HUSH_MODE_X
7095 static void dump_cmd_in_x_mode(char **argv)
7097 if (G_x_mode && argv) {
7098 /* We want to output the line in one write op */
7106 len += strlen(argv[n++]) + 1;
7112 p += sprintf(p, " %s", argv[n++]);
7120 # define dump_cmd_in_x_mode(argv) ((void)0)
7124 #define pseudo_exec_argv(nommu_save, argv, assignment_cnt, argv_expanded) \
7125 pseudo_exec_argv(argv, assignment_cnt, argv_expanded)
7126 #define pseudo_exec(nommu_save, command, argv_expanded) \
7127 pseudo_exec(command, argv_expanded)
7130 /* Called after [v]fork() in run_pipe, or from builtin_exec.
7132 * Don't exit() here. If you don't exec, use _exit instead.
7133 * The at_exit handlers apparently confuse the calling process,
7134 * in particular stdin handling. Not sure why? -- because of vfork! (vda)
7136 static void pseudo_exec_argv(nommu_save_t *nommu_save,
7137 char **argv, int assignment_cnt,
7138 char **argv_expanded) NORETURN;
7139 static NOINLINE void pseudo_exec_argv(nommu_save_t *nommu_save,
7140 char **argv, int assignment_cnt,
7141 char **argv_expanded)
7145 new_env = expand_assignments(argv, assignment_cnt);
7146 dump_cmd_in_x_mode(new_env);
7148 if (!argv[assignment_cnt]) {
7149 /* Case when we are here: ... | var=val | ...
7150 * (note that we do not exit early, i.e., do not optimize out
7151 * expand_assignments(): think about ... | var=`sleep 1` | ...
7153 free_strings(new_env);
7154 _exit(EXIT_SUCCESS);
7158 set_vars_and_save_old(new_env);
7159 free(new_env); /* optional */
7160 /* we can also destroy set_vars_and_save_old's return value,
7163 nommu_save->new_env = new_env;
7164 nommu_save->old_vars = set_vars_and_save_old(new_env);
7167 if (argv_expanded) {
7168 argv = argv_expanded;
7170 argv = expand_strvec_to_strvec(argv + assignment_cnt);
7172 nommu_save->argv = argv;
7175 dump_cmd_in_x_mode(argv);
7177 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
7178 if (strchr(argv[0], '/') != NULL)
7182 /* Check if the command matches any of the builtins.
7183 * Depending on context, this might be redundant. But it's
7184 * easier to waste a few CPU cycles than it is to figure out
7185 * if this is one of those cases.
7188 /* On NOMMU, it is more expensive to re-execute shell
7189 * just in order to run echo or test builtin.
7190 * It's better to skip it here and run corresponding
7191 * non-builtin later. */
7192 const struct built_in_command *x;
7193 x = BB_MMU ? find_builtin(argv[0]) : find_builtin1(argv[0]);
7195 exec_builtin(&nommu_save->argv_from_re_execing, x, argv);
7198 #if ENABLE_HUSH_FUNCTIONS
7199 /* Check if the command matches any functions */
7201 const struct function *funcp = find_function(argv[0]);
7203 exec_function(&nommu_save->argv_from_re_execing, funcp, argv);
7208 #if ENABLE_FEATURE_SH_STANDALONE
7209 /* Check if the command matches any busybox applets */
7211 int a = find_applet_by_name(argv[0]);
7213 # if BB_MMU /* see above why on NOMMU it is not allowed */
7214 if (APPLET_IS_NOEXEC(a)) {
7215 /* Do not leak open fds from opened script files etc */
7216 close_all_FILE_list();
7217 debug_printf_exec("running applet '%s'\n", argv[0]);
7218 run_applet_no_and_exit(a, argv[0], argv);
7221 /* Re-exec ourselves */
7222 debug_printf_exec("re-execing applet '%s'\n", argv[0]);
7223 /* Don't propagate SIG_IGN to the child */
7224 if (SPECIAL_JOBSTOP_SIGS != 0)
7225 switch_off_special_sigs(G.special_sig_mask & SPECIAL_JOBSTOP_SIGS);
7226 execv(bb_busybox_exec_path, argv);
7227 /* If they called chroot or otherwise made the binary no longer
7228 * executable, fall through */
7233 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
7236 execvp_or_die(argv);
7239 /* Called after [v]fork() in run_pipe
7241 static void pseudo_exec(nommu_save_t *nommu_save,
7242 struct command *command,
7243 char **argv_expanded) NORETURN;
7244 static void pseudo_exec(nommu_save_t *nommu_save,
7245 struct command *command,
7246 char **argv_expanded)
7248 if (command->argv) {
7249 pseudo_exec_argv(nommu_save, command->argv,
7250 command->assignment_cnt, argv_expanded);
7253 if (command->group) {
7254 /* Cases when we are here:
7257 * ... | ( list ) | ...
7258 * ... | { list } | ...
7262 debug_printf_exec("pseudo_exec: run_list\n");
7263 reset_traps_to_defaults();
7264 rcode = run_list(command->group);
7265 /* OK to leak memory by not calling free_pipe_list,
7266 * since this process is about to exit */
7269 re_execute_shell(&nommu_save->argv_from_re_execing,
7270 command->group_as_string,
7277 /* Case when we are here: ... | >file */
7278 debug_printf_exec("pseudo_exec'ed null command\n");
7279 _exit(EXIT_SUCCESS);
7283 static const char *get_cmdtext(struct pipe *pi)
7289 /* This is subtle. ->cmdtext is created only on first backgrounding.
7290 * (Think "cat, <ctrl-z>, fg, <ctrl-z>, fg, <ctrl-z>...." here...)
7291 * On subsequent bg argv is trashed, but we won't use it */
7295 argv = pi->cmds[0].argv;
7297 pi->cmdtext = xzalloc(1);
7302 len += strlen(*argv) + 1;
7306 argv = pi->cmds[0].argv;
7308 p = stpcpy(p, *argv);
7315 static void remove_job_from_table(struct pipe *pi)
7317 struct pipe *prev_pipe;
7319 if (pi == G.job_list) {
7320 G.job_list = pi->next;
7322 prev_pipe = G.job_list;
7323 while (prev_pipe->next != pi)
7324 prev_pipe = prev_pipe->next;
7325 prev_pipe->next = pi->next;
7329 G.last_jobid = G.job_list->jobid;
7332 static void delete_finished_job(struct pipe *pi)
7334 remove_job_from_table(pi);
7338 static void clean_up_last_dead_job(void)
7340 if (G.job_list && !G.job_list->alive_cmds)
7341 delete_finished_job(G.job_list);
7344 static void insert_job_into_table(struct pipe *pi)
7346 struct pipe *job, **jobp;
7349 clean_up_last_dead_job();
7351 /* Find the end of the list, and find next job ID to use */
7354 while ((job = *jobp) != NULL) {
7361 /* Create a new job struct at the end */
7362 job = *jobp = xmemdup(pi, sizeof(*pi));
7364 job->cmds = xzalloc(sizeof(pi->cmds[0]) * pi->num_cmds);
7365 /* Cannot copy entire pi->cmds[] vector! This causes double frees */
7366 for (i = 0; i < pi->num_cmds; i++) {
7367 job->cmds[i].pid = pi->cmds[i].pid;
7368 /* all other fields are not used and stay zero */
7370 job->cmdtext = xstrdup(get_cmdtext(pi));
7372 if (G_interactive_fd)
7373 printf("[%u] %u %s\n", job->jobid, (unsigned)job->cmds[0].pid, job->cmdtext);
7374 G.last_jobid = job->jobid;
7378 static int job_exited_or_stopped(struct pipe *pi)
7382 if (pi->alive_cmds != pi->stopped_cmds)
7385 /* All processes in fg pipe have exited or stopped */
7389 rcode = pi->cmds[i].cmd_exitcode;
7390 /* usually last process gives overall exitstatus,
7391 * but with "set -o pipefail", last *failed* process does */
7392 if (G.o_opt[OPT_O_PIPEFAIL] == 0 || rcode != 0)
7395 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
7399 static int process_wait_result(struct pipe *fg_pipe, pid_t childpid, int status)
7406 dead = WIFEXITED(status) || WIFSIGNALED(status);
7409 if (WIFSTOPPED(status))
7410 debug_printf_jobs("pid %d stopped by sig %d (exitcode %d)\n",
7411 childpid, WSTOPSIG(status), WEXITSTATUS(status));
7412 if (WIFSIGNALED(status))
7413 debug_printf_jobs("pid %d killed by sig %d (exitcode %d)\n",
7414 childpid, WTERMSIG(status), WEXITSTATUS(status));
7415 if (WIFEXITED(status))
7416 debug_printf_jobs("pid %d exited, exitcode %d\n",
7417 childpid, WEXITSTATUS(status));
7419 /* Were we asked to wait for a fg pipe? */
7421 i = fg_pipe->num_cmds;
7426 debug_printf_jobs("check pid %d\n", fg_pipe->cmds[i].pid);
7427 if (fg_pipe->cmds[i].pid != childpid)
7431 fg_pipe->cmds[i].pid = 0;
7432 fg_pipe->alive_cmds--;
7433 ex = WEXITSTATUS(status);
7434 /* bash prints killer signal's name for *last*
7435 * process in pipe (prints just newline for SIGINT/SIGPIPE).
7436 * Mimic this. Example: "sleep 5" + (^\ or kill -QUIT)
7438 if (WIFSIGNALED(status)) {
7439 int sig = WTERMSIG(status);
7440 if (i == fg_pipe->num_cmds-1)
7441 /* TODO: use strsignal() instead for bash compat? but that's bloat... */
7442 puts(sig == SIGINT || sig == SIGPIPE ? "" : get_signame(sig));
7443 /* TODO: if (WCOREDUMP(status)) + " (core dumped)"; */
7444 /* TODO: MIPS has 128 sigs (1..128), what if sig==128 here?
7445 * Maybe we need to use sig | 128? */
7448 fg_pipe->cmds[i].cmd_exitcode = ex;
7450 fg_pipe->stopped_cmds++;
7452 debug_printf_jobs("fg_pipe: alive_cmds %d stopped_cmds %d\n",
7453 fg_pipe->alive_cmds, fg_pipe->stopped_cmds);
7454 rcode = job_exited_or_stopped(fg_pipe);
7456 /* Note: *non-interactive* bash does not continue if all processes in fg pipe
7457 * are stopped. Testcase: "cat | cat" in a script (not on command line!)
7458 * and "killall -STOP cat" */
7459 if (G_interactive_fd) {
7461 if (fg_pipe->alive_cmds != 0)
7462 insert_job_into_table(fg_pipe);
7466 if (fg_pipe->alive_cmds == 0)
7469 /* There are still running processes in the fg_pipe */
7472 /* It wasn't in fg_pipe, look for process in bg pipes */
7476 /* We were asked to wait for bg or orphaned children */
7477 /* No need to remember exitcode in this case */
7478 for (pi = G.job_list; pi; pi = pi->next) {
7479 for (i = 0; i < pi->num_cmds; i++) {
7480 if (pi->cmds[i].pid == childpid)
7481 goto found_pi_and_prognum;
7484 /* Happens when shell is used as init process (init=/bin/sh) */
7485 debug_printf("checkjobs: pid %d was not in our list!\n", childpid);
7486 return -1; /* this wasn't a process from fg_pipe */
7488 found_pi_and_prognum:
7491 int rcode = WEXITSTATUS(status);
7492 if (WIFSIGNALED(status))
7493 rcode = 128 + WTERMSIG(status);
7494 pi->cmds[i].cmd_exitcode = rcode;
7495 if (G.last_bg_pid == pi->cmds[i].pid)
7496 G.last_bg_pid_exitcode = rcode;
7497 pi->cmds[i].pid = 0;
7499 if (!pi->alive_cmds) {
7500 if (G_interactive_fd) {
7501 printf(JOB_STATUS_FORMAT, pi->jobid,
7502 "Done", pi->cmdtext);
7503 delete_finished_job(pi);
7506 * bash deletes finished jobs from job table only in interactive mode,
7507 * after "jobs" cmd, or if pid of a new process matches one of the old ones
7508 * (see cleanup_dead_jobs(), delete_old_job(), J_NOTIFIED in bash source).
7509 * Testcase script: "(exit 3) & sleep 1; wait %1; echo $?" prints 3 in bash.
7510 * We only retain one "dead" job, if it's the single job on the list.
7511 * This covers most of real-world scenarios where this is useful.
7513 if (pi != G.job_list)
7514 delete_finished_job(pi);
7522 return -1; /* this wasn't a process from fg_pipe */
7525 /* Check to see if any processes have exited -- if they have,
7526 * figure out why and see if a job has completed.
7528 * If non-NULL fg_pipe: wait for its completion or stop.
7529 * Return its exitcode or zero if stopped.
7531 * Alternatively (fg_pipe == NULL, waitfor_pid != 0):
7532 * waitpid(WNOHANG), if waitfor_pid exits or stops, return exitcode+1,
7533 * else return <0 if waitpid errors out (e.g. ECHILD: nothing to wait for)
7534 * or 0 if no children changed status.
7536 * Alternatively (fg_pipe == NULL, waitfor_pid == 0),
7537 * return <0 if waitpid errors out (e.g. ECHILD: nothing to wait for)
7538 * or 0 if no children changed status.
7540 static int checkjobs(struct pipe *fg_pipe, pid_t waitfor_pid)
7546 debug_printf_jobs("checkjobs %p\n", fg_pipe);
7548 attributes = WUNTRACED;
7549 if (fg_pipe == NULL)
7550 attributes |= WNOHANG;
7553 #if ENABLE_HUSH_FAST
7554 if (G.handled_SIGCHLD == G.count_SIGCHLD) {
7555 //bb_error_msg("[%d] checkjobs: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d children?:%d fg_pipe:%p",
7556 //getpid(), G.count_SIGCHLD, G.handled_SIGCHLD, G.we_have_children, fg_pipe);
7557 /* There was neither fork nor SIGCHLD since last waitpid */
7558 /* Avoid doing waitpid syscall if possible */
7559 if (!G.we_have_children) {
7563 if (fg_pipe == NULL) { /* is WNOHANG set? */
7564 /* We have children, but they did not exit
7565 * or stop yet (we saw no SIGCHLD) */
7568 /* else: !WNOHANG, waitpid will block, can't short-circuit */
7572 /* Do we do this right?
7573 * bash-3.00# sleep 20 | false
7575 * [3]+ Stopped sleep 20 | false
7576 * bash-3.00# echo $?
7577 * 1 <========== bg pipe is not fully done, but exitcode is already known!
7578 * [hush 1.14.0: yes we do it right]
7582 #if ENABLE_HUSH_FAST
7584 i = G.count_SIGCHLD;
7586 childpid = waitpid(-1, &status, attributes);
7587 if (childpid <= 0) {
7588 if (childpid && errno != ECHILD)
7589 bb_perror_msg("waitpid");
7590 #if ENABLE_HUSH_FAST
7591 else { /* Until next SIGCHLD, waitpid's are useless */
7592 G.we_have_children = (childpid == 0);
7593 G.handled_SIGCHLD = i;
7594 //bb_error_msg("[%d] checkjobs: waitpid returned <= 0, G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
7597 /* ECHILD (no children), or 0 (no change in children status) */
7601 rcode = process_wait_result(fg_pipe, childpid, status);
7603 /* fg_pipe exited or stopped */
7606 if (childpid == waitfor_pid) {
7607 debug_printf_exec("childpid==waitfor_pid:%d status:0x%08x\n", childpid, status);
7608 rcode = WEXITSTATUS(status);
7609 if (WIFSIGNALED(status))
7610 rcode = 128 + WTERMSIG(status);
7611 if (WIFSTOPPED(status))
7612 /* bash: "cmd & wait $!" and cmd stops: $? = 128 + stopsig */
7613 rcode = 128 + WSTOPSIG(status);
7615 break; /* "wait PID" called us, give it exitcode+1 */
7617 /* This wasn't one of our processes, or */
7618 /* fg_pipe still has running processes, do waitpid again */
7619 } /* while (waitpid succeeds)... */
7625 static int checkjobs_and_fg_shell(struct pipe *fg_pipe)
7628 int rcode = checkjobs(fg_pipe, 0 /*(no pid to wait for)*/);
7629 if (G_saved_tty_pgrp) {
7630 /* Job finished, move the shell to the foreground */
7631 p = getpgrp(); /* our process group id */
7632 debug_printf_jobs("fg'ing ourself: getpgrp()=%d\n", (int)p);
7633 tcsetpgrp(G_interactive_fd, p);
7639 /* Start all the jobs, but don't wait for anything to finish.
7642 * Return code is normally -1, when the caller has to wait for children
7643 * to finish to determine the exit status of the pipe. If the pipe
7644 * is a simple builtin command, however, the action is done by the
7645 * time run_pipe returns, and the exit code is provided as the
7648 * Returns -1 only if started some children. IOW: we have to
7649 * mask out retvals of builtins etc with 0xff!
7651 * The only case when we do not need to [v]fork is when the pipe
7652 * is single, non-backgrounded, non-subshell command. Examples:
7653 * cmd ; ... { list } ; ...
7654 * cmd && ... { list } && ...
7655 * cmd || ... { list } || ...
7656 * If it is, then we can run cmd as a builtin, NOFORK,
7657 * or (if SH_STANDALONE) an applet, and we can run the { list }
7658 * with run_list. If it isn't one of these, we fork and exec cmd.
7660 * Cases when we must fork:
7661 * non-single: cmd | cmd
7662 * backgrounded: cmd & { list } &
7663 * subshell: ( list ) [&]
7665 #if !ENABLE_HUSH_MODE_X
7666 #define redirect_and_varexp_helper(new_env_p, old_vars_p, command, squirrel, argv_expanded) \
7667 redirect_and_varexp_helper(new_env_p, old_vars_p, command, squirrel)
7669 static int redirect_and_varexp_helper(char ***new_env_p,
7670 struct variable **old_vars_p,
7671 struct command *command,
7672 struct squirrel **sqp,
7673 char **argv_expanded)
7675 /* setup_redirects acts on file descriptors, not FILEs.
7676 * This is perfect for work that comes after exec().
7677 * Is it really safe for inline use? Experimentally,
7678 * things seem to work. */
7679 int rcode = setup_redirects(command, sqp);
7681 char **new_env = expand_assignments(command->argv, command->assignment_cnt);
7682 *new_env_p = new_env;
7683 dump_cmd_in_x_mode(new_env);
7684 dump_cmd_in_x_mode(argv_expanded);
7686 *old_vars_p = set_vars_and_save_old(new_env);
7690 static NOINLINE int run_pipe(struct pipe *pi)
7692 static const char *const null_ptr = NULL;
7696 struct command *command;
7697 char **argv_expanded;
7699 struct squirrel *squirrel = NULL;
7702 debug_printf_exec("run_pipe start: members:%d\n", pi->num_cmds);
7705 /* Testcase: set -- q w e; (IFS='' echo "$*"; IFS=''; echo "$*"); echo "$*"
7706 * Result should be 3 lines: q w e, qwe, q w e
7708 G.ifs = get_local_var_value("IFS");
7712 IF_HUSH_JOB(pi->pgrp = -1;)
7713 pi->stopped_cmds = 0;
7714 command = &pi->cmds[0];
7715 argv_expanded = NULL;
7717 if (pi->num_cmds != 1
7718 || pi->followup == PIPE_BG
7719 || command->cmd_type == CMD_SUBSHELL
7726 debug_printf_exec(": group:%p argv:'%s'\n",
7727 command->group, command->argv ? command->argv[0] : "NONE");
7729 if (command->group) {
7730 #if ENABLE_HUSH_FUNCTIONS
7731 if (command->cmd_type == CMD_FUNCDEF) {
7732 /* "executing" func () { list } */
7733 struct function *funcp;
7735 funcp = new_function(command->argv[0]);
7736 /* funcp->name is already set to argv[0] */
7737 funcp->body = command->group;
7739 funcp->body_as_string = command->group_as_string;
7740 command->group_as_string = NULL;
7742 command->group = NULL;
7743 command->argv[0] = NULL;
7744 debug_printf_exec("cmd %p has child func at %p\n", command, funcp);
7745 funcp->parent_cmd = command;
7746 command->child_func = funcp;
7748 debug_printf_exec("run_pipe: return EXIT_SUCCESS\n");
7750 return EXIT_SUCCESS;
7754 debug_printf("non-subshell group\n");
7755 rcode = 1; /* exitcode if redir failed */
7756 if (setup_redirects(command, &squirrel) == 0) {
7757 debug_printf_exec(": run_list\n");
7758 rcode = run_list(command->group) & 0xff;
7760 restore_redirects(squirrel);
7761 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
7763 debug_printf_exec("run_pipe: return %d\n", rcode);
7767 argv = command->argv ? command->argv : (char **) &null_ptr;
7769 const struct built_in_command *x;
7770 #if ENABLE_HUSH_FUNCTIONS
7771 const struct function *funcp;
7775 char **new_env = NULL;
7776 struct variable *old_vars = NULL;
7778 if (argv[command->assignment_cnt] == NULL) {
7779 /* Assignments, but no command */
7780 /* Ensure redirects take effect (that is, create files).
7781 * Try "a=t >file" */
7782 #if 0 /* A few cases in testsuite fail with this code. FIXME */
7783 rcode = redirect_and_varexp_helper(&new_env, /*old_vars:*/ NULL, command, &squirrel, /*argv_expanded:*/ NULL);
7784 /* Set shell variables */
7788 if (set_local_var(*argv, /*flag:*/ 0)) {
7789 /* assignment to readonly var / putenv error? */
7795 /* Redirect error sets $? to 1. Otherwise,
7796 * if evaluating assignment value set $?, retain it.
7797 * Try "false; q=`exit 2`; echo $?" - should print 2: */
7799 rcode = G.last_exitcode;
7800 /* Exit, _skipping_ variable restoring code: */
7801 goto clean_up_and_ret0;
7803 #else /* Older, bigger, but more correct code */
7805 rcode = setup_redirects(command, &squirrel);
7806 restore_redirects(squirrel);
7807 /* Set shell variables */
7809 bb_putchar_stderr('+');
7811 char *p = expand_string_to_string(*argv, /*unbackslash:*/ 1);
7813 fprintf(stderr, " %s", p);
7814 debug_printf_exec("set shell var:'%s'->'%s'\n",
7816 if (set_local_var(p, /*flag:*/ 0)) {
7817 /* assignment to readonly var / putenv error? */
7823 bb_putchar_stderr('\n');
7824 /* Redirect error sets $? to 1. Otherwise,
7825 * if evaluating assignment value set $?, retain it.
7826 * Try "false; q=`exit 2`; echo $?" - should print 2: */
7828 rcode = G.last_exitcode;
7829 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
7831 debug_printf_exec("run_pipe: return %d\n", rcode);
7836 /* Expand the rest into (possibly) many strings each */
7838 if (command->cmd_type == CMD_SINGLEWORD_NOGLOB) {
7839 argv_expanded = expand_strvec_to_strvec_singleword_noglob(argv + command->assignment_cnt);
7843 argv_expanded = expand_strvec_to_strvec(argv + command->assignment_cnt);
7846 /* if someone gives us an empty string: `cmd with empty output` */
7847 if (!argv_expanded[0]) {
7848 free(argv_expanded);
7850 return G.last_exitcode;
7853 x = find_builtin(argv_expanded[0]);
7854 #if ENABLE_HUSH_FUNCTIONS
7857 funcp = find_function(argv_expanded[0]);
7861 if (x->b_function == builtin_exec && argv_expanded[1] == NULL) {
7862 debug_printf("exec with redirects only\n");
7863 rcode = setup_redirects(command, NULL);
7864 /* rcode=1 can be if redir file can't be opened */
7865 goto clean_up_and_ret1;
7868 rcode = redirect_and_varexp_helper(&new_env, &old_vars, command, &squirrel, argv_expanded);
7871 debug_printf_exec(": builtin '%s' '%s'...\n",
7872 x->b_cmd, argv_expanded[1]);
7874 rcode = x->b_function(argv_expanded) & 0xff;
7877 #if ENABLE_HUSH_FUNCTIONS
7879 # if ENABLE_HUSH_LOCAL
7880 struct variable **sv;
7881 sv = G.shadowed_vars_pp;
7882 G.shadowed_vars_pp = &old_vars;
7884 debug_printf_exec(": function '%s' '%s'...\n",
7885 funcp->name, argv_expanded[1]);
7886 rcode = run_function(funcp, argv_expanded) & 0xff;
7887 # if ENABLE_HUSH_LOCAL
7888 G.shadowed_vars_pp = sv;
7894 unset_vars(new_env);
7896 /* clean_up_and_ret0: */
7897 restore_redirects(squirrel);
7899 free(argv_expanded);
7900 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
7902 debug_printf_exec("run_pipe return %d\n", rcode);
7906 if (ENABLE_FEATURE_SH_NOFORK) {
7907 int n = find_applet_by_name(argv_expanded[0]);
7908 if (n >= 0 && APPLET_IS_NOFORK(n)) {
7909 rcode = redirect_and_varexp_helper(&new_env, &old_vars, command, &squirrel, argv_expanded);
7911 debug_printf_exec(": run_nofork_applet '%s' '%s'...\n",
7912 argv_expanded[0], argv_expanded[1]);
7913 rcode = run_nofork_applet(n, argv_expanded);
7915 goto clean_up_and_ret;
7918 /* It is neither builtin nor applet. We must fork. */
7922 /* NB: argv_expanded may already be created, and that
7923 * might include `cmd` runs! Do not rerun it! We *must*
7924 * use argv_expanded if it's non-NULL */
7926 /* Going to fork a child per each pipe member */
7931 while (cmd_no < pi->num_cmds) {
7932 struct fd_pair pipefds;
7934 volatile nommu_save_t nommu_save;
7935 nommu_save.new_env = NULL;
7936 nommu_save.old_vars = NULL;
7937 nommu_save.argv = NULL;
7938 nommu_save.argv_from_re_execing = NULL;
7940 command = &pi->cmds[cmd_no];
7942 if (command->argv) {
7943 debug_printf_exec(": pipe member '%s' '%s'...\n",
7944 command->argv[0], command->argv[1]);
7946 debug_printf_exec(": pipe member with no argv\n");
7949 /* pipes are inserted between pairs of commands */
7952 if (cmd_no < pi->num_cmds)
7953 xpiped_pair(pipefds);
7955 command->pid = BB_MMU ? fork() : vfork();
7956 if (!command->pid) { /* child */
7958 disable_restore_tty_pgrp_on_exit();
7959 CLEAR_RANDOM_T(&G.random_gen); /* or else $RANDOM repeats in child */
7961 /* Every child adds itself to new process group
7962 * with pgid == pid_of_first_child_in_pipe */
7963 if (G.run_list_level == 1 && G_interactive_fd) {
7966 if (pgrp < 0) /* true for 1st process only */
7968 if (setpgid(0, pgrp) == 0
7969 && pi->followup != PIPE_BG
7970 && G_saved_tty_pgrp /* we have ctty */
7972 /* We do it in *every* child, not just first,
7974 tcsetpgrp(G_interactive_fd, pgrp);
7978 if (pi->alive_cmds == 0 && pi->followup == PIPE_BG) {
7979 /* 1st cmd in backgrounded pipe
7980 * should have its stdin /dev/null'ed */
7982 if (open(bb_dev_null, O_RDONLY))
7983 xopen("/", O_RDONLY);
7985 xmove_fd(next_infd, 0);
7987 xmove_fd(pipefds.wr, 1);
7990 /* Like bash, explicit redirects override pipes,
7991 * and the pipe fd (fd#1) is available for dup'ing:
7992 * "cmd1 2>&1 | cmd2": fd#1 is duped to fd#2, thus stderr
7993 * of cmd1 goes into pipe.
7995 if (setup_redirects(command, NULL)) {
7996 /* Happens when redir file can't be opened:
7997 * $ hush -c 'echo FOO >&2 | echo BAR 3>/qwe/rty; echo BAZ'
7999 * hush: can't open '/qwe/rty': No such file or directory
8001 * (echo BAR is not executed, it hits _exit(1) below)
8006 /* Stores to nommu_save list of env vars putenv'ed
8007 * (NOMMU, on MMU we don't need that) */
8008 /* cast away volatility... */
8009 pseudo_exec((nommu_save_t*) &nommu_save, command, argv_expanded);
8010 /* pseudo_exec() does not return */
8013 /* parent or error */
8014 #if ENABLE_HUSH_FAST
8016 //bb_error_msg("[%d] fork in run_pipe: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
8018 enable_restore_tty_pgrp_on_exit();
8020 /* Clean up after vforked child */
8021 free(nommu_save.argv);
8022 free(nommu_save.argv_from_re_execing);
8023 unset_vars(nommu_save.new_env);
8024 add_vars(nommu_save.old_vars);
8026 free(argv_expanded);
8027 argv_expanded = NULL;
8028 if (command->pid < 0) { /* [v]fork failed */
8029 /* Clearly indicate, was it fork or vfork */
8030 bb_perror_msg(BB_MMU ? "vfork"+1 : "vfork");
8034 /* Second and next children need to know pid of first one */
8036 pi->pgrp = command->pid;
8042 if (cmd_no < pi->num_cmds)
8044 /* Pass read (output) pipe end to next iteration */
8045 next_infd = pipefds.rd;
8048 if (!pi->alive_cmds) {
8050 debug_printf_exec("run_pipe return 1 (all forks failed, no children)\n");
8055 debug_printf_exec("run_pipe return -1 (%u children started)\n", pi->alive_cmds);
8059 /* NB: called by pseudo_exec, and therefore must not modify any
8060 * global data until exec/_exit (we can be a child after vfork!) */
8061 static int run_list(struct pipe *pi)
8063 #if ENABLE_HUSH_CASE
8064 char *case_word = NULL;
8066 #if ENABLE_HUSH_LOOPS
8067 struct pipe *loop_top = NULL;
8068 char **for_lcur = NULL;
8069 char **for_list = NULL;
8071 smallint last_followup;
8073 #if ENABLE_HUSH_IF || ENABLE_HUSH_CASE
8074 smalluint cond_code = 0;
8076 enum { cond_code = 0 };
8079 smallint rword; /* RES_foo */
8080 smallint last_rword; /* ditto */
8083 debug_printf_exec("run_list start lvl %d\n", G.run_list_level);
8086 #if ENABLE_HUSH_LOOPS
8087 /* Check syntax for "for" */
8090 for (cpipe = pi; cpipe; cpipe = cpipe->next) {
8091 if (cpipe->res_word != RES_FOR && cpipe->res_word != RES_IN)
8093 /* current word is FOR or IN (BOLD in comments below) */
8094 if (cpipe->next == NULL) {
8095 syntax_error("malformed for");
8097 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
8100 /* "FOR v; do ..." and "for v IN a b; do..." are ok */
8101 if (cpipe->next->res_word == RES_DO)
8103 /* next word is not "do". It must be "in" then ("FOR v in ...") */
8104 if (cpipe->res_word == RES_IN /* "for v IN a b; not_do..."? */
8105 || cpipe->next->res_word != RES_IN /* FOR v not_do_and_not_in..."? */
8107 syntax_error("malformed for");
8109 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
8116 /* Past this point, all code paths should jump to ret: label
8117 * in order to return, no direct "return" statements please.
8118 * This helps to ensure that no memory is leaked. */
8126 last_rword = RES_XXXX;
8128 last_followup = PIPE_SEQ;
8129 rcode = G.last_exitcode;
8131 /* Go through list of pipes, (maybe) executing them. */
8132 for (; pi; pi = IF_HUSH_LOOPS(rword == RES_DONE ? loop_top : ) pi->next) {
8134 int sv_errexit_depth;
8138 if (G_flag_return_in_progress == 1)
8141 IF_HAS_KEYWORDS(rword = pi->res_word;)
8142 debug_printf_exec(": rword=%d cond_code=%d last_rword=%d\n",
8143 rword, cond_code, last_rword);
8145 sv_errexit_depth = G.errexit_depth;
8146 if (IF_HAS_KEYWORDS(rword == RES_IF || rword == RES_ELIF ||)
8147 pi->followup != PIPE_SEQ
8151 #if ENABLE_HUSH_LOOPS
8152 if ((rword == RES_WHILE || rword == RES_UNTIL || rword == RES_FOR)
8153 && loop_top == NULL /* avoid bumping G.depth_of_loop twice */
8155 /* start of a loop: remember where loop starts */
8160 /* Still in the same "if...", "then..." or "do..." branch? */
8161 if (IF_HAS_KEYWORDS(rword == last_rword &&) 1) {
8162 if ((rcode == 0 && last_followup == PIPE_OR)
8163 || (rcode != 0 && last_followup == PIPE_AND)
8165 /* It is "<true> || CMD" or "<false> && CMD"
8166 * and we should not execute CMD */
8167 debug_printf_exec("skipped cmd because of || or &&\n");
8168 last_followup = pi->followup;
8169 goto dont_check_jobs_but_continue;
8172 last_followup = pi->followup;
8173 IF_HAS_KEYWORDS(last_rword = rword;)
8176 if (rword == RES_THEN) {
8177 /* if false; then ... fi has exitcode 0! */
8178 G.last_exitcode = rcode = EXIT_SUCCESS;
8179 /* "if <false> THEN cmd": skip cmd */
8183 if (rword == RES_ELSE || rword == RES_ELIF) {
8184 /* "if <true> then ... ELSE/ELIF cmd":
8185 * skip cmd and all following ones */
8190 #if ENABLE_HUSH_LOOPS
8191 if (rword == RES_FOR) { /* && pi->num_cmds - always == 1 */
8193 /* first loop through for */
8195 static const char encoded_dollar_at[] ALIGN1 = {
8196 SPECIAL_VAR_SYMBOL, '@' | 0x80, SPECIAL_VAR_SYMBOL, '\0'
8197 }; /* encoded representation of "$@" */
8198 static const char *const encoded_dollar_at_argv[] = {
8199 encoded_dollar_at, NULL
8200 }; /* argv list with one element: "$@" */
8203 vals = (char**)encoded_dollar_at_argv;
8204 if (pi->next->res_word == RES_IN) {
8205 /* if no variable values after "in" we skip "for" */
8206 if (!pi->next->cmds[0].argv) {
8207 G.last_exitcode = rcode = EXIT_SUCCESS;
8208 debug_printf_exec(": null FOR: exitcode EXIT_SUCCESS\n");
8211 vals = pi->next->cmds[0].argv;
8212 } /* else: "for var; do..." -> assume "$@" list */
8213 /* create list of variable values */
8214 debug_print_strings("for_list made from", vals);
8215 for_list = expand_strvec_to_strvec(vals);
8216 for_lcur = for_list;
8217 debug_print_strings("for_list", for_list);
8220 /* "for" loop is over, clean up */
8226 /* Insert next value from for_lcur */
8227 /* note: *for_lcur already has quotes removed, $var expanded, etc */
8228 set_local_var(xasprintf("%s=%s", pi->cmds[0].argv[0], *for_lcur++), /*flag:*/ 0);
8231 if (rword == RES_IN) {
8232 continue; /* "for v IN list;..." - "in" has no cmds anyway */
8234 if (rword == RES_DONE) {
8235 continue; /* "done" has no cmds too */
8238 #if ENABLE_HUSH_CASE
8239 if (rword == RES_CASE) {
8240 debug_printf_exec("CASE cond_code:%d\n", cond_code);
8241 case_word = expand_strvec_to_string(pi->cmds->argv);
8242 unbackslash(case_word);
8245 if (rword == RES_MATCH) {
8248 debug_printf_exec("MATCH cond_code:%d\n", cond_code);
8249 if (!case_word) /* "case ... matched_word) ... WORD)": we executed selected branch, stop */
8251 /* all prev words didn't match, does this one match? */
8252 argv = pi->cmds->argv;
8254 char *pattern = expand_string_to_string(*argv, /*unbackslash:*/ 0);
8255 /* TODO: which FNM_xxx flags to use? */
8256 cond_code = (fnmatch(pattern, case_word, /*flags:*/ 0) != 0);
8257 debug_printf_exec("fnmatch(pattern:'%s',str:'%s'):%d\n", pattern, case_word, cond_code);
8259 if (cond_code == 0) { /* match! we will execute this branch */
8261 case_word = NULL; /* make future "word)" stop */
8268 if (rword == RES_CASE_BODY) { /* inside of a case branch */
8269 debug_printf_exec("CASE_BODY cond_code:%d\n", cond_code);
8271 continue; /* not matched yet, skip this pipe */
8273 if (rword == RES_ESAC) {
8274 debug_printf_exec("ESAC cond_code:%d\n", cond_code);
8276 /* "case" did not match anything: still set $? (to 0) */
8277 G.last_exitcode = rcode = EXIT_SUCCESS;
8281 /* Just pressing <enter> in shell should check for jobs.
8282 * OTOH, in non-interactive shell this is useless
8283 * and only leads to extra job checks */
8284 if (pi->num_cmds == 0) {
8285 if (G_interactive_fd)
8286 goto check_jobs_and_continue;
8290 /* After analyzing all keywords and conditions, we decided
8291 * to execute this pipe. NB: have to do checkjobs(NULL)
8292 * after run_pipe to collect any background children,
8293 * even if list execution is to be stopped. */
8294 debug_printf_exec(": run_pipe with %d members\n", pi->num_cmds);
8295 #if ENABLE_HUSH_LOOPS
8296 G.flag_break_continue = 0;
8298 rcode = r = run_pipe(pi); /* NB: rcode is a smalluint, r is int */
8300 /* We ran a builtin, function, or group.
8301 * rcode is already known
8302 * and we don't need to wait for anything. */
8303 debug_printf_exec(": builtin/func exitcode %d\n", rcode);
8304 G.last_exitcode = rcode;
8305 check_and_run_traps();
8306 #if ENABLE_HUSH_LOOPS
8307 /* Was it "break" or "continue"? */
8308 if (G.flag_break_continue) {
8309 smallint fbc = G.flag_break_continue;
8310 /* We might fall into outer *loop*,
8311 * don't want to break it too */
8313 G.depth_break_continue--;
8314 if (G.depth_break_continue == 0)
8315 G.flag_break_continue = 0;
8316 /* else: e.g. "continue 2" should *break* once, *then* continue */
8317 } /* else: "while... do... { we are here (innermost list is not a loop!) };...done" */
8318 if (G.depth_break_continue != 0 || fbc == BC_BREAK) {
8319 checkjobs(NULL, 0 /*(no pid to wait for)*/);
8322 /* "continue": simulate end of loop */
8327 if (G_flag_return_in_progress == 1) {
8328 checkjobs(NULL, 0 /*(no pid to wait for)*/);
8331 } else if (pi->followup == PIPE_BG) {
8332 /* What does bash do with attempts to background builtins? */
8333 /* even bash 3.2 doesn't do that well with nested bg:
8334 * try "{ { sleep 10; echo DEEP; } & echo HERE; } &".
8335 * I'm NOT treating inner &'s as jobs */
8337 if (G.run_list_level == 1)
8338 insert_job_into_table(pi);
8340 /* Last command's pid goes to $! */
8341 G.last_bg_pid = pi->cmds[pi->num_cmds - 1].pid;
8342 G.last_bg_pid_exitcode = 0;
8343 debug_printf_exec(": cmd&: exitcode EXIT_SUCCESS\n");
8344 /* Check pi->pi_inverted? "! sleep 1 & echo $?": bash says 1. dash and ash says 0 */
8345 rcode = EXIT_SUCCESS;
8349 if (G.run_list_level == 1 && G_interactive_fd) {
8350 /* Waits for completion, then fg's main shell */
8351 rcode = checkjobs_and_fg_shell(pi);
8352 debug_printf_exec(": checkjobs_and_fg_shell exitcode %d\n", rcode);
8356 /* This one just waits for completion */
8357 rcode = checkjobs(pi, 0 /*(no pid to wait for)*/);
8358 debug_printf_exec(": checkjobs exitcode %d\n", rcode);
8360 G.last_exitcode = rcode;
8361 check_and_run_traps();
8364 /* Handle "set -e" */
8365 if (rcode != 0 && G.o_opt[OPT_O_ERREXIT]) {
8366 debug_printf_exec("ERREXIT:1 errexit_depth:%d\n", G.errexit_depth);
8367 if (G.errexit_depth == 0)
8370 G.errexit_depth = sv_errexit_depth;
8372 /* Analyze how result affects subsequent commands */
8374 if (rword == RES_IF || rword == RES_ELIF)
8377 check_jobs_and_continue:
8378 checkjobs(NULL, 0 /*(no pid to wait for)*/);
8379 dont_check_jobs_but_continue: ;
8380 #if ENABLE_HUSH_LOOPS
8381 /* Beware of "while false; true; do ..."! */
8383 && (pi->next->res_word == RES_DO || pi->next->res_word == RES_DONE)
8384 /* check for RES_DONE is needed for "while ...; do \n done" case */
8386 if (rword == RES_WHILE) {
8388 /* "while false; do...done" - exitcode 0 */
8389 G.last_exitcode = rcode = EXIT_SUCCESS;
8390 debug_printf_exec(": while expr is false: breaking (exitcode:EXIT_SUCCESS)\n");
8394 if (rword == RES_UNTIL) {
8396 debug_printf_exec(": until expr is true: breaking\n");
8407 #if ENABLE_HUSH_LOOPS
8412 #if ENABLE_HUSH_CASE
8416 debug_printf_exec("run_list lvl %d return %d\n", G.run_list_level + 1, rcode);
8420 /* Select which version we will use */
8421 static int run_and_free_list(struct pipe *pi)
8424 debug_printf_exec("run_and_free_list entered\n");
8425 if (!G.o_opt[OPT_O_NOEXEC]) {
8426 debug_printf_exec(": run_list: 1st pipe with %d cmds\n", pi->num_cmds);
8427 rcode = run_list(pi);
8429 /* free_pipe_list has the side effect of clearing memory.
8430 * In the long run that function can be merged with run_list,
8431 * but doing that now would hobble the debugging effort. */
8433 debug_printf_exec("run_and_free_list return %d\n", rcode);
8438 static void install_sighandlers(unsigned mask)
8440 sighandler_t old_handler;
8442 while ((mask >>= 1) != 0) {
8446 old_handler = install_sighandler(sig, pick_sighandler(sig));
8447 /* POSIX allows shell to re-enable SIGCHLD
8448 * even if it was SIG_IGN on entry.
8449 * Therefore we skip IGN check for it:
8453 if (old_handler == SIG_IGN) {
8454 /* oops... restore back to IGN, and record this fact */
8455 install_sighandler(sig, old_handler);
8456 #if ENABLE_HUSH_TRAP
8458 G_traps = xzalloc(sizeof(G_traps[0]) * NSIG);
8460 G_traps[sig] = xzalloc(1); /* == xstrdup(""); */
8466 /* Called a few times only (or even once if "sh -c") */
8467 static void install_special_sighandlers(void)
8471 /* Which signals are shell-special? */
8472 mask = (1 << SIGQUIT) | (1 << SIGCHLD);
8473 if (G_interactive_fd) {
8474 mask |= SPECIAL_INTERACTIVE_SIGS;
8475 if (G_saved_tty_pgrp) /* we have ctty, job control sigs work */
8476 mask |= SPECIAL_JOBSTOP_SIGS;
8478 /* Careful, do not re-install handlers we already installed */
8479 if (G.special_sig_mask != mask) {
8480 unsigned diff = mask & ~G.special_sig_mask;
8481 G.special_sig_mask = mask;
8482 install_sighandlers(diff);
8488 /* Set handlers to restore tty pgrp and exit */
8489 static void install_fatal_sighandlers(void)
8493 /* We will restore tty pgrp on these signals */
8495 /*+ (1 << SIGILL ) * HUSH_DEBUG*/
8496 /*+ (1 << SIGFPE ) * HUSH_DEBUG*/
8497 + (1 << SIGBUS ) * HUSH_DEBUG
8498 + (1 << SIGSEGV) * HUSH_DEBUG
8499 /*+ (1 << SIGTRAP) * HUSH_DEBUG*/
8501 /* bash 3.2 seems to handle these just like 'fatal' ones */
8504 /* if we are interactive, SIGHUP, SIGTERM and SIGINT are special sigs.
8505 * if we aren't interactive... but in this case
8506 * we never want to restore pgrp on exit, and this fn is not called
8508 /*+ (1 << SIGHUP )*/
8509 /*+ (1 << SIGTERM)*/
8510 /*+ (1 << SIGINT )*/
8512 G_fatal_sig_mask = mask;
8514 install_sighandlers(mask);
8518 static int set_mode(int state, char mode, const char *o_opt)
8523 G.o_opt[OPT_O_NOEXEC] = state;
8526 IF_HUSH_MODE_X(G_x_mode = state;)
8530 /* "set -+o" without parameter.
8531 * in bash, set -o produces this output:
8535 * We always use the second form.
8537 const char *p = o_opt_strings;
8540 printf("set %co %s\n", (G.o_opt[idx] ? '-' : '+'), p);
8546 idx = index_in_strings(o_opt_strings, o_opt);
8548 G.o_opt[idx] = state;
8552 G.o_opt[OPT_O_ERREXIT] = state;
8555 return EXIT_FAILURE;
8557 return EXIT_SUCCESS;
8560 int hush_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
8561 int hush_main(int argc, char **argv)
8564 OPT_login = (1 << 0),
8568 unsigned builtin_argc;
8570 struct variable *cur_var;
8571 struct variable *shell_ver;
8574 if (EXIT_SUCCESS != 0) /* if EXIT_SUCCESS == 0, it is already done */
8575 G.last_exitcode = EXIT_SUCCESS;
8577 #if ENABLE_HUSH_FAST
8578 G.count_SIGCHLD++; /* ensure it is != G.handled_SIGCHLD */
8581 G.argv0_for_re_execing = argv[0];
8583 /* Deal with HUSH_VERSION */
8584 shell_ver = xzalloc(sizeof(*shell_ver));
8585 shell_ver->flg_export = 1;
8586 shell_ver->flg_read_only = 1;
8587 /* Code which handles ${var<op>...} needs writable values for all variables,
8588 * therefore we xstrdup: */
8589 shell_ver->varstr = xstrdup(hush_version_str);
8590 /* Create shell local variables from the values
8591 * currently living in the environment */
8592 debug_printf_env("unsetenv '%s'\n", "HUSH_VERSION");
8593 unsetenv("HUSH_VERSION"); /* in case it exists in initial env */
8594 G.top_var = shell_ver;
8595 cur_var = G.top_var;
8598 char *value = strchr(*e, '=');
8599 if (value) { /* paranoia */
8600 cur_var->next = xzalloc(sizeof(*cur_var));
8601 cur_var = cur_var->next;
8602 cur_var->varstr = *e;
8603 cur_var->max_len = strlen(*e);
8604 cur_var->flg_export = 1;
8608 /* (Re)insert HUSH_VERSION into env (AFTER we scanned the env!) */
8609 debug_printf_env("putenv '%s'\n", shell_ver->varstr);
8610 putenv(shell_ver->varstr);
8613 set_pwd_var(SETFLAG_EXPORT);
8615 #if BASH_HOSTNAME_VAR
8616 /* Set (but not export) HOSTNAME unless already set */
8617 if (!get_local_var_value("HOSTNAME")) {
8620 set_local_var_from_halves("HOSTNAME", uts.nodename);
8622 /* bash also exports SHLVL and _,
8623 * and sets (but doesn't export) the following variables:
8625 * BASH_VERSINFO=([0]="3" [1]="2" [2]="0" [3]="1" [4]="release" [5]="i386-pc-linux-gnu")
8626 * BASH_VERSION='3.2.0(1)-release'
8628 * MACHTYPE=i386-pc-linux-gnu
8630 * PPID=<NNNNN> - we also do it elsewhere
8641 * PIPESTATUS=([0]="0")
8642 * HISTFILE=/<xxx>/.bash_history
8646 * PATH=/usr/gnu/bin:/usr/local/bin:/bin:/usr/bin:.
8648 * SHELLOPTS=braceexpand:emacs:hashall:histexpand:history:interactive-comments:monitor
8659 #if ENABLE_FEATURE_EDITING
8660 G.line_input_state = new_line_input_t(FOR_SHELL);
8663 /* Initialize some more globals to non-zero values */
8664 cmdedit_update_prompt();
8666 die_func = restore_ttypgrp_and__exit;
8668 /* Shell is non-interactive at first. We need to call
8669 * install_special_sighandlers() if we are going to execute "sh <script>",
8670 * "sh -c <cmds>" or login shell's /etc/profile and friends.
8671 * If we later decide that we are interactive, we run install_special_sighandlers()
8672 * in order to intercept (more) signals.
8676 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/sh.html */
8677 flags = (argv[0] && argv[0][0] == '-') ? OPT_login : 0;
8680 opt = getopt(argc, argv, "+c:exinsl"
8683 # if ENABLE_HUSH_FUNCTIONS
8693 * sh ... -c 'script'
8694 * sh ... -c 'script' ARG0 [ARG1...]
8695 * On NOMMU, if builtin_argc != 0,
8696 * sh ... -c 'builtin' BARGV... "" ARG0 [ARG1...]
8697 * "" needs to be replaced with NULL
8698 * and BARGV vector fed to builtin function.
8699 * Note: the form without ARG0 never happens:
8700 * sh ... -c 'builtin' BARGV... ""
8703 G.root_pid = getpid();
8704 G.root_ppid = getppid();
8706 G.global_argv = argv + optind;
8707 G.global_argc = argc - optind;
8709 /* -c 'builtin' [BARGV...] "" ARG0 [ARG1...] */
8710 const struct built_in_command *x;
8712 install_special_sighandlers();
8713 x = find_builtin(optarg);
8714 if (x) { /* paranoia */
8715 G.global_argc -= builtin_argc; /* skip [BARGV...] "" */
8716 G.global_argv += builtin_argc;
8717 G.global_argv[-1] = NULL; /* replace "" */
8719 G.last_exitcode = x->b_function(argv + optind - 1);
8723 if (!G.global_argv[0]) {
8724 /* -c 'script' (no params): prevent empty $0 */
8725 G.global_argv--; /* points to argv[i] of 'script' */
8726 G.global_argv[0] = argv[0];
8728 } /* else -c 'script' ARG0 [ARG1...]: $0 is ARG0 */
8729 install_special_sighandlers();
8730 parse_and_run_string(optarg);
8733 /* Well, we cannot just declare interactiveness,
8734 * we have to have some stuff (ctty, etc) */
8735 /* G_interactive_fd++; */
8738 /* "-s" means "read from stdin", but this is how we always
8739 * operate, so simply do nothing here. */
8745 case '<': /* "big heredoc" support */
8746 full_write1_str(optarg);
8749 unsigned long long empty_trap_mask;
8751 G.root_pid = bb_strtou(optarg, &optarg, 16);
8753 G.root_ppid = bb_strtou(optarg, &optarg, 16);
8755 G.last_bg_pid = bb_strtou(optarg, &optarg, 16);
8757 G.last_exitcode = bb_strtou(optarg, &optarg, 16);
8759 builtin_argc = bb_strtou(optarg, &optarg, 16);
8761 empty_trap_mask = bb_strtoull(optarg, &optarg, 16);
8762 if (empty_trap_mask != 0) {
8763 IF_HUSH_TRAP(int sig;)
8764 install_special_sighandlers();
8765 # if ENABLE_HUSH_TRAP
8766 G_traps = xzalloc(sizeof(G_traps[0]) * NSIG);
8767 for (sig = 1; sig < NSIG; sig++) {
8768 if (empty_trap_mask & (1LL << sig)) {
8769 G_traps[sig] = xzalloc(1); /* == xstrdup(""); */
8770 install_sighandler(sig, SIG_IGN);
8775 # if ENABLE_HUSH_LOOPS
8777 G.depth_of_loop = bb_strtou(optarg, &optarg, 16);
8783 set_local_var(xstrdup(optarg), opt == 'R' ? SETFLAG_MAKE_RO : 0);
8785 # if ENABLE_HUSH_FUNCTIONS
8787 struct function *funcp = new_function(optarg);
8788 /* funcp->name is already set to optarg */
8789 /* funcp->body is set to NULL. It's a special case. */
8790 funcp->body_as_string = argv[optind];
8799 if (set_mode(1, opt, NULL) == 0) /* no error */
8803 fprintf(stderr, "Usage: sh [FILE]...\n"
8804 " or: sh -c command [args]...\n\n");
8810 } /* option parsing loop */
8812 /* Skip options. Try "hush -l": $1 should not be "-l"! */
8813 G.global_argc = argc - (optind - 1);
8814 G.global_argv = argv + (optind - 1);
8815 G.global_argv[0] = argv[0];
8818 G.root_pid = getpid();
8819 G.root_ppid = getppid();
8822 /* If we are login shell... */
8823 if (flags & OPT_login) {
8825 debug_printf("sourcing /etc/profile\n");
8826 input = fopen_for_read("/etc/profile");
8827 if (input != NULL) {
8828 remember_FILE(input);
8829 install_special_sighandlers();
8830 parse_and_run_file(input);
8831 fclose_and_forget(input);
8833 /* bash: after sourcing /etc/profile,
8834 * tries to source (in the given order):
8835 * ~/.bash_profile, ~/.bash_login, ~/.profile,
8836 * stopping on first found. --noprofile turns this off.
8837 * bash also sources ~/.bash_logout on exit.
8838 * If called as sh, skips .bash_XXX files.
8842 if (G.global_argv[1]) {
8845 * "bash <script>" (which is never interactive (unless -i?))
8846 * sources $BASH_ENV here (without scanning $PATH).
8847 * If called as sh, does the same but with $ENV.
8848 * Also NB, per POSIX, $ENV should undergo parameter expansion.
8852 debug_printf("running script '%s'\n", G.global_argv[0]);
8853 xfunc_error_retval = 127; /* for "hush /does/not/exist" case */
8854 input = xfopen_for_read(G.global_argv[0]);
8855 xfunc_error_retval = 1;
8856 remember_FILE(input);
8857 install_special_sighandlers();
8858 parse_and_run_file(input);
8859 #if ENABLE_FEATURE_CLEAN_UP
8860 fclose_and_forget(input);
8865 /* Up to here, shell was non-interactive. Now it may become one.
8866 * NB: don't forget to (re)run install_special_sighandlers() as needed.
8869 /* A shell is interactive if the '-i' flag was given,
8870 * or if all of the following conditions are met:
8872 * no arguments remaining or the -s flag given
8873 * standard input is a terminal
8874 * standard output is a terminal
8875 * Refer to Posix.2, the description of the 'sh' utility.
8878 if (isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)) {
8879 G_saved_tty_pgrp = tcgetpgrp(STDIN_FILENO);
8880 debug_printf("saved_tty_pgrp:%d\n", G_saved_tty_pgrp);
8881 if (G_saved_tty_pgrp < 0)
8882 G_saved_tty_pgrp = 0;
8884 /* try to dup stdin to high fd#, >= 255 */
8885 G_interactive_fd = fcntl_F_DUPFD(STDIN_FILENO, 254);
8886 if (G_interactive_fd < 0) {
8887 /* try to dup to any fd */
8888 G_interactive_fd = dup(STDIN_FILENO);
8889 if (G_interactive_fd < 0) {
8891 G_interactive_fd = 0;
8892 G_saved_tty_pgrp = 0;
8895 // TODO: track & disallow any attempts of user
8896 // to (inadvertently) close/redirect G_interactive_fd
8898 debug_printf("interactive_fd:%d\n", G_interactive_fd);
8899 if (G_interactive_fd) {
8900 close_on_exec_on(G_interactive_fd);
8902 if (G_saved_tty_pgrp) {
8903 /* If we were run as 'hush &', sleep until we are
8904 * in the foreground (tty pgrp == our pgrp).
8905 * If we get started under a job aware app (like bash),
8906 * make sure we are now in charge so we don't fight over
8907 * who gets the foreground */
8909 pid_t shell_pgrp = getpgrp();
8910 G_saved_tty_pgrp = tcgetpgrp(G_interactive_fd);
8911 if (G_saved_tty_pgrp == shell_pgrp)
8913 /* send TTIN to ourself (should stop us) */
8914 kill(- shell_pgrp, SIGTTIN);
8918 /* Install more signal handlers */
8919 install_special_sighandlers();
8921 if (G_saved_tty_pgrp) {
8922 /* Set other signals to restore saved_tty_pgrp */
8923 install_fatal_sighandlers();
8924 /* Put ourselves in our own process group
8925 * (bash, too, does this only if ctty is available) */
8926 bb_setpgrp(); /* is the same as setpgid(our_pid, our_pid); */
8927 /* Grab control of the terminal */
8928 tcsetpgrp(G_interactive_fd, getpid());
8930 enable_restore_tty_pgrp_on_exit();
8932 # if ENABLE_HUSH_SAVEHISTORY && MAX_HISTORY > 0
8934 const char *hp = get_local_var_value("HISTFILE");
8936 hp = get_local_var_value("HOME");
8938 hp = concat_path_file(hp, ".hush_history");
8943 G.line_input_state->hist_file = hp;
8944 //set_local_var(xasprintf("HISTFILE=%s", ...));
8946 # if ENABLE_FEATURE_SH_HISTFILESIZE
8947 hp = get_local_var_value("HISTFILESIZE");
8948 G.line_input_state->max_history = size_from_HISTFILESIZE(hp);
8953 install_special_sighandlers();
8955 #elif ENABLE_HUSH_INTERACTIVE
8956 /* No job control compiled in, only prompt/line editing */
8957 if (isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)) {
8958 G_interactive_fd = fcntl_F_DUPFD(STDIN_FILENO, 254);
8959 if (G_interactive_fd < 0) {
8960 /* try to dup to any fd */
8961 G_interactive_fd = dup(STDIN_FILENO);
8962 if (G_interactive_fd < 0)
8964 G_interactive_fd = 0;
8967 if (G_interactive_fd) {
8968 close_on_exec_on(G_interactive_fd);
8970 install_special_sighandlers();
8972 /* We have interactiveness code disabled */
8973 install_special_sighandlers();
8976 * if interactive but not a login shell, sources ~/.bashrc
8977 * (--norc turns this off, --rcfile <file> overrides)
8980 if (!ENABLE_FEATURE_SH_EXTRA_QUIET && G_interactive_fd) {
8981 /* note: ash and hush share this string */
8982 printf("\n\n%s %s\n"
8983 IF_HUSH_HELP("Enter 'help' for a list of built-in commands.\n")
8986 "hush - the humble shell"
8990 parse_and_run_file(stdin);
8993 hush_exit(G.last_exitcode);
9000 static int FAST_FUNC builtin_true(char **argv UNUSED_PARAM)
9005 #if ENABLE_HUSH_TEST || ENABLE_HUSH_ECHO || ENABLE_HUSH_PRINTF || ENABLE_HUSH_KILL
9006 static int run_applet_main(char **argv, int (*applet_main_func)(int argc, char **argv))
9008 int argc = string_array_len(argv);
9009 return applet_main_func(argc, argv);
9012 #if ENABLE_HUSH_TEST || BASH_TEST2
9013 static int FAST_FUNC builtin_test(char **argv)
9015 return run_applet_main(argv, test_main);
9018 #if ENABLE_HUSH_ECHO
9019 static int FAST_FUNC builtin_echo(char **argv)
9021 return run_applet_main(argv, echo_main);
9024 #if ENABLE_HUSH_PRINTF
9025 static int FAST_FUNC builtin_printf(char **argv)
9027 return run_applet_main(argv, printf_main);
9031 #if ENABLE_HUSH_HELP
9032 static int FAST_FUNC builtin_help(char **argv UNUSED_PARAM)
9034 const struct built_in_command *x;
9037 "Built-in commands:\n"
9038 "------------------\n");
9039 for (x = bltins1; x != &bltins1[ARRAY_SIZE(bltins1)]; x++) {
9041 printf("%-10s%s\n", x->b_cmd, x->b_descr);
9043 return EXIT_SUCCESS;
9047 #if MAX_HISTORY && ENABLE_FEATURE_EDITING
9048 static int FAST_FUNC builtin_history(char **argv UNUSED_PARAM)
9050 show_history(G.line_input_state);
9051 return EXIT_SUCCESS;
9055 static char **skip_dash_dash(char **argv)
9058 if (argv[0] && argv[0][0] == '-' && argv[0][1] == '-' && argv[0][2] == '\0')
9063 static int FAST_FUNC builtin_cd(char **argv)
9067 argv = skip_dash_dash(argv);
9069 if (newdir == NULL) {
9070 /* bash does nothing (exitcode 0) if HOME is ""; if it's unset,
9071 * bash says "bash: cd: HOME not set" and does nothing
9074 const char *home = get_local_var_value("HOME");
9075 newdir = home ? home : "/";
9077 if (chdir(newdir)) {
9078 /* Mimic bash message exactly */
9079 bb_perror_msg("cd: %s", newdir);
9080 return EXIT_FAILURE;
9082 /* Read current dir (get_cwd(1) is inside) and set PWD.
9083 * Note: do not enforce exporting. If PWD was unset or unexported,
9084 * set it again, but do not export. bash does the same.
9086 set_pwd_var(/*flag:*/ 0);
9087 return EXIT_SUCCESS;
9090 static int FAST_FUNC builtin_pwd(char **argv UNUSED_PARAM)
9093 return EXIT_SUCCESS;
9096 static int FAST_FUNC builtin_eval(char **argv)
9098 int rcode = EXIT_SUCCESS;
9100 argv = skip_dash_dash(argv);
9102 char *str = expand_strvec_to_string(argv);
9104 * eval "echo Hi; done" ("done" is syntax error):
9105 * "echo Hi" will not execute too.
9107 parse_and_run_string(str);
9109 rcode = G.last_exitcode;
9114 static int FAST_FUNC builtin_exec(char **argv)
9116 argv = skip_dash_dash(argv);
9117 if (argv[0] == NULL)
9118 return EXIT_SUCCESS; /* bash does this */
9120 /* Careful: we can end up here after [v]fork. Do not restore
9121 * tty pgrp then, only top-level shell process does that */
9122 if (G_saved_tty_pgrp && getpid() == G.root_pid)
9123 tcsetpgrp(G_interactive_fd, G_saved_tty_pgrp);
9125 /* TODO: if exec fails, bash does NOT exit! We do.
9126 * We'll need to undo trap cleanup (it's inside execvp_or_die)
9127 * and tcsetpgrp, and this is inherently racy.
9129 execvp_or_die(argv);
9132 static int FAST_FUNC builtin_exit(char **argv)
9134 debug_printf_exec("%s()\n", __func__);
9136 /* interactive bash:
9137 * # trap "echo EEE" EXIT
9140 * There are stopped jobs.
9141 * (if there are _stopped_ jobs, running ones don't count)
9144 * EEE (then bash exits)
9146 * TODO: we can use G.exiting = -1 as indicator "last cmd was exit"
9149 /* note: EXIT trap is run by hush_exit */
9150 argv = skip_dash_dash(argv);
9151 if (argv[0] == NULL)
9152 hush_exit(G.last_exitcode);
9153 /* mimic bash: exit 123abc == exit 255 + error msg */
9154 xfunc_error_retval = 255;
9155 /* bash: exit -2 == exit 254, no error msg */
9156 hush_exit(xatoi(argv[0]) & 0xff);
9159 #if ENABLE_HUSH_TYPE
9160 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/type.html */
9161 static int FAST_FUNC builtin_type(char **argv)
9163 int ret = EXIT_SUCCESS;
9169 if (0) {} /* make conditional compile easier below */
9170 /*else if (find_alias(*argv))
9171 type = "an alias";*/
9172 #if ENABLE_HUSH_FUNCTIONS
9173 else if (find_function(*argv))
9174 type = "a function";
9176 else if (find_builtin(*argv))
9177 type = "a shell builtin";
9178 else if ((path = find_in_path(*argv)) != NULL)
9181 bb_error_msg("type: %s: not found", *argv);
9186 printf("%s is %s\n", *argv, type);
9194 #if ENABLE_HUSH_READ
9195 /* Interruptibility of read builtin in bash
9196 * (tested on bash-4.2.8 by sending signals (not by ^C)):
9198 * Empty trap makes read ignore corresponding signal, for any signal.
9201 * - terminates non-interactive shell;
9202 * - interrupts read in interactive shell;
9203 * if it has non-empty trap:
9204 * - executes trap and returns to command prompt in interactive shell;
9205 * - executes trap and returns to read in non-interactive shell;
9207 * - is ignored (does not interrupt) read in interactive shell;
9208 * - terminates non-interactive shell;
9209 * if it has non-empty trap:
9210 * - executes trap and returns to read;
9212 * - terminates shell (regardless of interactivity);
9213 * if it has non-empty trap:
9214 * - executes trap and returns to read;
9215 * SIGCHLD from children:
9216 * - does not interrupt read regardless of interactivity:
9217 * try: sleep 1 & read x; echo $x
9219 static int FAST_FUNC builtin_read(char **argv)
9229 /* "!": do not abort on errors.
9230 * Option string must start with "sr" to match BUILTIN_READ_xxx
9232 read_flags = getopt32(argv, "!srn:p:t:u:", &opt_n, &opt_p, &opt_t, &opt_u);
9233 if (read_flags == (uint32_t)-1)
9234 return EXIT_FAILURE;
9236 ifs = get_local_var_value("IFS"); /* can be NULL */
9239 r = shell_builtin_read(set_local_var_from_halves,
9249 if ((uintptr_t)r == 1 && errno == EINTR) {
9250 unsigned sig = check_and_run_traps();
9255 if ((uintptr_t)r > 1) {
9256 bb_error_msg("%s", r);
9257 r = (char*)(uintptr_t)1;
9260 return (uintptr_t)r;
9264 #if ENABLE_HUSH_UMASK
9265 static int FAST_FUNC builtin_umask(char **argv)
9272 argv = skip_dash_dash(argv);
9274 mode_t old_mask = mask;
9276 /* numeric umasks are taken as-is */
9277 /* symbolic umasks are inverted: "umask a=rx" calls umask(222) */
9278 if (!isdigit(argv[0][0]))
9280 mask = bb_parse_mode(argv[0], mask);
9281 if (!isdigit(argv[0][0]))
9283 if ((unsigned)mask > 0777) {
9286 * bash: umask: 'q': invalid symbolic mode operator
9287 * bash: umask: 999: octal number out of range
9289 bb_error_msg("%s: invalid mode '%s'", "umask", argv[0]);
9294 printf("%04o\n", (unsigned) mask);
9295 /* fall through and restore mask which we set to 0 */
9299 return !rc; /* rc != 0 - success */
9303 #if ENABLE_HUSH_EXPORT || ENABLE_HUSH_TRAP
9304 static void print_escaped(const char *s)
9309 const char *p = strchrnul(s, '\'');
9310 /* print 'xxxx', possibly just '' */
9311 printf("'%.*s'", (int)(p - s), s);
9316 /* s points to '; print "'''...'''" */
9318 do putchar('\''); while (*++s == '\'');
9324 #if ENABLE_HUSH_EXPORT || ENABLE_HUSH_LOCAL || ENABLE_HUSH_READONLY
9325 static int helper_export_local(char **argv, unsigned flags)
9329 char *name_end = strchrnul(name, '=');
9331 /* So far we do not check that name is valid (TODO?) */
9333 if (*name_end == '\0') {
9334 struct variable *var, **vpp;
9336 vpp = get_ptr_to_local_var(name, name_end - name);
9337 var = vpp ? *vpp : NULL;
9339 if (flags & SETFLAG_UNEXPORT) {
9340 /* export -n NAME (without =VALUE) */
9342 var->flg_export = 0;
9343 debug_printf_env("%s: unsetenv '%s'\n", __func__, name);
9345 } /* else: export -n NOT_EXISTING_VAR: no-op */
9348 if (flags & SETFLAG_EXPORT) {
9349 /* export NAME (without =VALUE) */
9351 var->flg_export = 1;
9352 debug_printf_env("%s: putenv '%s'\n", __func__, var->varstr);
9353 putenv(var->varstr);
9357 if (flags & SETFLAG_MAKE_RO) {
9358 /* readonly NAME (without =VALUE) */
9360 var->flg_read_only = 1;
9364 # if ENABLE_HUSH_LOCAL
9365 /* Is this "local" bltin? */
9366 if (!(flags & (SETFLAG_EXPORT|SETFLAG_UNEXPORT|SETFLAG_MAKE_RO))) {
9367 unsigned lvl = flags >> SETFLAG_LOCAL_SHIFT;
9368 if (var && var->func_nest_level == lvl) {
9369 /* "local x=abc; ...; local x" - ignore second local decl */
9374 /* Exporting non-existing variable.
9375 * bash does not put it in environment,
9376 * but remembers that it is exported,
9377 * and does put it in env when it is set later.
9378 * We just set it to "" and export.
9380 /* Or, it's "local NAME" (without =VALUE).
9381 * bash sets the value to "".
9383 /* Or, it's "readonly NAME" (without =VALUE).
9384 * bash remembers NAME and disallows its creation
9387 name = xasprintf("%s=", name);
9389 /* (Un)exporting/making local NAME=VALUE */
9390 name = xstrdup(name);
9392 if (set_local_var(name, flags))
9393 return EXIT_FAILURE;
9395 return EXIT_SUCCESS;
9399 #if ENABLE_HUSH_EXPORT
9400 static int FAST_FUNC builtin_export(char **argv)
9402 unsigned opt_unexport;
9404 #if ENABLE_HUSH_EXPORT_N
9405 /* "!": do not abort on errors */
9406 opt_unexport = getopt32(argv, "!n");
9407 if (opt_unexport == (uint32_t)-1)
9408 return EXIT_FAILURE;
9415 if (argv[0] == NULL) {
9422 /* ash emits: export VAR='VAL'
9423 * bash: declare -x VAR="VAL"
9424 * we follow ash example */
9425 const char *s = *e++;
9426 const char *p = strchr(s, '=');
9428 if (!p) /* wtf? take next variable */
9431 printf("export %.*s", (int)(p - s) + 1, s);
9432 print_escaped(p + 1);
9436 /*fflush_all(); - done after each builtin anyway */
9438 return EXIT_SUCCESS;
9441 return helper_export_local(argv, opt_unexport ? SETFLAG_UNEXPORT : SETFLAG_EXPORT);
9445 #if ENABLE_HUSH_LOCAL
9446 static int FAST_FUNC builtin_local(char **argv)
9448 if (G.func_nest_level == 0) {
9449 bb_error_msg("%s: not in a function", argv[0]);
9450 return EXIT_FAILURE; /* bash compat */
9453 return helper_export_local(argv, G.func_nest_level << SETFLAG_LOCAL_SHIFT);
9457 #if ENABLE_HUSH_READONLY
9458 static int FAST_FUNC builtin_readonly(char **argv)
9461 if (*argv == NULL) {
9462 /* bash: readonly [-p]: list all readonly VARs
9463 * (-p has no effect in bash)
9466 for (e = G.top_var; e; e = e->next) {
9467 if (e->flg_read_only) {
9468 //TODO: quote value: readonly VAR='VAL'
9469 printf("readonly %s\n", e->varstr);
9472 return EXIT_SUCCESS;
9474 return helper_export_local(argv, SETFLAG_MAKE_RO);
9478 #if ENABLE_HUSH_UNSET
9479 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#unset */
9480 static int FAST_FUNC builtin_unset(char **argv)
9485 /* "!": do not abort on errors */
9486 /* "+": stop at 1st non-option */
9487 opts = getopt32(argv, "!+vf");
9488 if (opts == (unsigned)-1)
9489 return EXIT_FAILURE;
9491 bb_error_msg("unset: -v and -f are exclusive");
9492 return EXIT_FAILURE;
9498 if (!(opts & 2)) { /* not -f */
9499 if (unset_local_var(*argv)) {
9500 /* unset <nonexistent_var> doesn't fail.
9501 * Error is when one tries to unset RO var.
9502 * Message was printed by unset_local_var. */
9506 # if ENABLE_HUSH_FUNCTIONS
9518 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set
9519 * built-in 'set' handler
9521 * set [-abCefhmnuvx] [-o option] [argument...]
9522 * set [+abCefhmnuvx] [+o option] [argument...]
9523 * set -- [argument...]
9526 * Implementations shall support the options in both their hyphen and
9527 * plus-sign forms. These options can also be specified as options to sh.
9529 * Write out all variables and their values: set
9530 * Set $1, $2, and $3 and set "$#" to 3: set c a b
9531 * Turn on the -x and -v options: set -xv
9532 * Unset all positional parameters: set --
9533 * Set $1 to the value of x, even if it begins with '-' or '+': set -- "$x"
9534 * Set the positional parameters to the expansion of x, even if x expands
9535 * with a leading '-' or '+': set -- $x
9537 * So far, we only support "set -- [argument...]" and some of the short names.
9539 static int FAST_FUNC builtin_set(char **argv)
9542 char **pp, **g_argv;
9543 char *arg = *++argv;
9547 for (e = G.top_var; e; e = e->next)
9549 return EXIT_SUCCESS;
9553 if (strcmp(arg, "--") == 0) {
9557 if (arg[0] != '+' && arg[0] != '-')
9559 for (n = 1; arg[n]; ++n) {
9560 if (set_mode((arg[0] == '-'), arg[n], argv[1]))
9562 if (arg[n] == 'o' && argv[1])
9565 } while ((arg = *++argv) != NULL);
9566 /* Now argv[0] is 1st argument */
9569 return EXIT_SUCCESS;
9572 /* NB: G.global_argv[0] ($0) is never freed/changed */
9573 g_argv = G.global_argv;
9574 if (G.global_args_malloced) {
9580 G.global_args_malloced = 1;
9581 pp = xzalloc(sizeof(pp[0]) * 2);
9582 pp[0] = g_argv[0]; /* retain $0 */
9585 /* This realloc's G.global_argv */
9586 G.global_argv = pp = add_strings_to_strings(g_argv, argv, /*dup:*/ 1);
9588 G.global_argc = 1 + string_array_len(pp + 1);
9590 return EXIT_SUCCESS;
9592 /* Nothing known, so abort */
9594 bb_error_msg("set: %s: invalid option", arg);
9595 return EXIT_FAILURE;
9599 static int FAST_FUNC builtin_shift(char **argv)
9602 argv = skip_dash_dash(argv);
9604 n = bb_strtou(argv[0], NULL, 10);
9605 if (errno || n < 0) {
9606 /* shared string with ash.c */
9607 bb_error_msg("Illegal number: %s", argv[0]);
9609 * ash aborts in this case.
9610 * bash prints error message and set $? to 1.
9611 * Interestingly, for "shift 99999" bash does not
9612 * print error message, but does set $? to 1
9613 * (and does no shifting at all).
9617 if (n >= 0 && n < G.global_argc) {
9618 if (G_global_args_malloced) {
9621 free(G.global_argv[m++]);
9624 memmove(&G.global_argv[1], &G.global_argv[n+1],
9625 G.global_argc * sizeof(G.global_argv[0]));
9626 return EXIT_SUCCESS;
9628 return EXIT_FAILURE;
9631 static int FAST_FUNC builtin_source(char **argv)
9633 char *arg_path, *filename;
9636 char *args_need_save;
9637 #if ENABLE_HUSH_FUNCTIONS
9641 argv = skip_dash_dash(argv);
9644 /* bash says: "bash: .: filename argument required" */
9645 return 2; /* bash compat */
9648 if (!strchr(filename, '/')) {
9649 arg_path = find_in_path(filename);
9651 filename = arg_path;
9653 input = remember_FILE(fopen_or_warn(filename, "r"));
9656 /* bb_perror_msg("%s", *argv); - done by fopen_or_warn */
9657 /* POSIX: non-interactive shell should abort here,
9658 * not merely fail. So far no one complained :)
9660 return EXIT_FAILURE;
9663 #if ENABLE_HUSH_FUNCTIONS
9664 sv_flg = G_flag_return_in_progress;
9665 /* "we are inside sourced file, ok to use return" */
9666 G_flag_return_in_progress = -1;
9668 args_need_save = argv[1]; /* used as a boolean variable */
9670 save_and_replace_G_args(&sv, argv);
9672 /* "false; . ./empty_line; echo Zero:$?" should print 0 */
9673 G.last_exitcode = 0;
9674 parse_and_run_file(input);
9675 fclose_and_forget(input);
9677 if (args_need_save) /* can't use argv[1] instead: "shift" can mangle it */
9678 restore_G_args(&sv, argv);
9679 #if ENABLE_HUSH_FUNCTIONS
9680 G_flag_return_in_progress = sv_flg;
9683 return G.last_exitcode;
9686 #if ENABLE_HUSH_TRAP
9687 static int FAST_FUNC builtin_trap(char **argv)
9693 G_traps = xzalloc(sizeof(G_traps[0]) * NSIG);
9698 /* No args: print all trapped */
9699 for (i = 0; i < NSIG; ++i) {
9702 print_escaped(G_traps[i]);
9703 /* note: bash adds "SIG", but only if invoked
9704 * as "bash". If called as "sh", or if set -o posix,
9705 * then it prints short signal names.
9706 * We are printing short names: */
9707 printf(" %s\n", get_signame(i));
9710 /*fflush_all(); - done after each builtin anyway */
9711 return EXIT_SUCCESS;
9715 /* If first arg is a number: reset all specified signals */
9716 sig = bb_strtou(*argv, NULL, 10);
9722 sighandler_t handler;
9724 sig = get_signum(*argv++);
9725 if (sig < 0 || sig >= NSIG) {
9727 /* Mimic bash message exactly */
9728 bb_error_msg("trap: %s: invalid signal specification", argv[-1]);
9733 G_traps[sig] = xstrdup(new_cmd);
9735 debug_printf("trap: setting SIG%s (%i) to '%s'\n",
9736 get_signame(sig), sig, G_traps[sig]);
9738 /* There is no signal for 0 (EXIT) */
9743 handler = (new_cmd[0] ? record_pending_signo : SIG_IGN);
9745 /* We are removing trap handler */
9746 handler = pick_sighandler(sig);
9747 install_sighandler(sig, handler);
9752 if (!argv[1]) { /* no second arg */
9753 bb_error_msg("trap: invalid arguments");
9754 return EXIT_FAILURE;
9757 /* First arg is "-": reset all specified to default */
9758 /* First arg is "--": skip it, the rest is "handler SIGs..." */
9759 /* Everything else: set arg as signal handler
9760 * (includes "" case, which ignores signal) */
9761 if (argv[0][0] == '-') {
9762 if (argv[0][1] == '\0') { /* "-" */
9763 /* new_cmd remains NULL: "reset these sigs" */
9766 if (argv[0][1] == '-' && argv[0][2] == '\0') { /* "--" */
9769 /* else: "-something", no special meaning */
9774 goto process_sig_list;
9779 static struct pipe *parse_jobspec(const char *str)
9784 if (sscanf(str, "%%%u", &jobnum) != 1) {
9786 || (str[1] != '%' && str[1] != '+' && str[1] != '\0')
9788 bb_error_msg("bad argument '%s'", str);
9791 /* It is "%%", "%+" or "%" - current job */
9792 jobnum = G.last_jobid;
9794 bb_error_msg("no current job");
9798 for (pi = G.job_list; pi; pi = pi->next) {
9799 if (pi->jobid == jobnum) {
9803 bb_error_msg("%u: no such job", jobnum);
9807 static int FAST_FUNC builtin_jobs(char **argv UNUSED_PARAM)
9810 const char *status_string;
9812 checkjobs(NULL, 0 /*(no pid to wait for)*/);
9813 for (job = G.job_list; job; job = job->next) {
9814 if (job->alive_cmds == job->stopped_cmds)
9815 status_string = "Stopped";
9817 status_string = "Running";
9819 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->cmdtext);
9822 clean_up_last_dead_job();
9824 return EXIT_SUCCESS;
9827 /* built-in 'fg' and 'bg' handler */
9828 static int FAST_FUNC builtin_fg_bg(char **argv)
9833 if (!G_interactive_fd)
9834 return EXIT_FAILURE;
9836 /* If they gave us no args, assume they want the last backgrounded task */
9838 for (pi = G.job_list; pi; pi = pi->next) {
9839 if (pi->jobid == G.last_jobid) {
9843 bb_error_msg("%s: no current job", argv[0]);
9844 return EXIT_FAILURE;
9847 pi = parse_jobspec(argv[1]);
9849 return EXIT_FAILURE;
9851 /* TODO: bash prints a string representation
9852 * of job being foregrounded (like "sleep 1 | cat") */
9853 if (argv[0][0] == 'f' && G_saved_tty_pgrp) {
9854 /* Put the job into the foreground. */
9855 tcsetpgrp(G_interactive_fd, pi->pgrp);
9858 /* Restart the processes in the job */
9859 debug_printf_jobs("reviving %d procs, pgrp %d\n", pi->num_cmds, pi->pgrp);
9860 for (i = 0; i < pi->num_cmds; i++) {
9861 debug_printf_jobs("reviving pid %d\n", pi->cmds[i].pid);
9863 pi->stopped_cmds = 0;
9865 i = kill(- pi->pgrp, SIGCONT);
9867 if (errno == ESRCH) {
9868 delete_finished_job(pi);
9869 return EXIT_SUCCESS;
9871 bb_perror_msg("kill (SIGCONT)");
9874 if (argv[0][0] == 'f') {
9875 remove_job_from_table(pi); /* FG job shouldn't be in job table */
9876 return checkjobs_and_fg_shell(pi);
9878 return EXIT_SUCCESS;
9882 #if ENABLE_HUSH_KILL
9883 static int FAST_FUNC builtin_kill(char **argv)
9887 # if ENABLE_HUSH_JOB
9888 if (argv[1] && strcmp(argv[1], "-l") != 0) {
9896 if (argv[i][0] != '%')
9899 * "kill %N" - job kill
9900 * Converting to pgrp / pid kill
9902 pi = parse_jobspec(argv[i]);
9904 /* Eat bad jobspec */
9908 argv[j - 1] = argv[j];
9915 * In jobs started under job control, we signal
9916 * entire process group by kill -PGRP_ID.
9917 * This happens, f.e., in interactive shell.
9919 * Otherwise, we signal each child via
9920 * kill PID1 PID2 PID3.
9922 * sh -c 'sleep 1|sleep 1 & kill %1'
9923 * sh -c 'true|sleep 2 & sleep 1; kill %1'
9924 * sh -c 'true|sleep 1 & sleep 2; kill %1'
9926 n = G_interactive_fd ? 1 : pi->num_cmds;
9927 dst = alloca(n * sizeof(int)*4);
9929 if (G_interactive_fd)
9930 dst += sprintf(dst, " -%u", (int)pi->pgrp);
9931 else for (j = 0; j < n; j++) {
9932 struct command *cmd = &pi->cmds[j];
9933 /* Skip exited members of the job */
9937 * kill_main has matching code to expect
9938 * leading space. Needed to not confuse
9939 * negative pids with "kill -SIGNAL_NO" syntax
9941 dst += sprintf(dst, " %u", (int)cmd->pid);
9944 } while (argv[++i]);
9948 if (argv[1] || ret == 0) {
9949 ret = run_applet_main(argv, kill_main);
9951 /* else: ret = 1, "kill %bad_jobspec" case */
9956 #if ENABLE_HUSH_WAIT
9957 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/wait.html */
9958 #if !ENABLE_HUSH_JOB
9959 # define wait_for_child_or_signal(pipe,pid) wait_for_child_or_signal(pid)
9961 static int wait_for_child_or_signal(struct pipe *waitfor_pipe, pid_t waitfor_pid)
9968 if (!sigisemptyset(&G.pending_set))
9971 /* waitpid is not interruptible by SA_RESTARTed
9972 * signals which we use. Thus, this ugly dance:
9975 /* Make sure possible SIGCHLD is stored in kernel's
9976 * pending signal mask before we call waitpid.
9977 * Or else we may race with SIGCHLD, lose it,
9978 * and get stuck in sigsuspend...
9980 sigfillset(&oldset); /* block all signals, remember old set */
9981 sigprocmask(SIG_SETMASK, &oldset, &oldset);
9983 if (!sigisemptyset(&G.pending_set)) {
9984 /* Crap! we raced with some signal! */
9988 /*errno = 0; - checkjobs does this */
9989 /* Can't pass waitfor_pipe into checkjobs(): it won't be interruptible */
9990 ret = checkjobs(NULL, waitfor_pid); /* waitpid(WNOHANG) inside */
9991 debug_printf_exec("checkjobs:%d\n", ret);
9994 int rcode = job_exited_or_stopped(waitfor_pipe);
9995 debug_printf_exec("job_exited_or_stopped:%d\n", rcode);
9998 sigprocmask(SIG_SETMASK, &oldset, NULL);
10003 /* if ECHILD, there are no children (ret is -1 or 0) */
10004 /* if ret == 0, no children changed state */
10005 /* if ret != 0, it's exitcode+1 of exited waitfor_pid child */
10006 if (errno == ECHILD || ret) {
10008 if (ret < 0) /* if ECHILD, may need to fix "ret" */
10010 sigprocmask(SIG_SETMASK, &oldset, NULL);
10013 /* Wait for SIGCHLD or any other signal */
10014 /* It is vitally important for sigsuspend that SIGCHLD has non-DFL handler! */
10015 /* Note: sigsuspend invokes signal handler */
10016 sigsuspend(&oldset);
10018 sigprocmask(SIG_SETMASK, &oldset, NULL);
10020 /* So, did we get a signal? */
10021 sig = check_and_run_traps();
10022 if (sig /*&& sig != SIGCHLD - always true */) {
10026 /* SIGCHLD, or no signal, or ignored one, such as SIGQUIT. Repeat */
10031 static int FAST_FUNC builtin_wait(char **argv)
10036 argv = skip_dash_dash(argv);
10037 if (argv[0] == NULL) {
10038 /* Don't care about wait results */
10039 /* Note 1: must wait until there are no more children */
10040 /* Note 2: must be interruptible */
10042 * $ sleep 3 & sleep 6 & wait
10043 * [1] 30934 sleep 3
10044 * [2] 30935 sleep 6
10047 * $ sleep 3 & sleep 6 & wait
10048 * [1] 30936 sleep 3
10049 * [2] 30937 sleep 6
10051 * ^C <-- after ~4 sec from keyboard
10054 return wait_for_child_or_signal(NULL, 0 /*(no job and no pid to wait for)*/);
10058 pid_t pid = bb_strtou(*argv, NULL, 10);
10059 if (errno || pid <= 0) {
10060 #if ENABLE_HUSH_JOB
10061 if (argv[0][0] == '%') {
10062 struct pipe *wait_pipe;
10063 ret = 127; /* bash compat for bad jobspecs */
10064 wait_pipe = parse_jobspec(*argv);
10066 ret = job_exited_or_stopped(wait_pipe);
10068 ret = wait_for_child_or_signal(wait_pipe, 0);
10070 /* waiting on "last dead job" removes it */
10071 clean_up_last_dead_job();
10074 /* else: parse_jobspec() already emitted error msg */
10078 /* mimic bash message */
10079 bb_error_msg("wait: '%s': not a pid or valid job spec", *argv);
10080 ret = EXIT_FAILURE;
10081 continue; /* bash checks all argv[] */
10084 /* Do we have such child? */
10085 ret = waitpid(pid, &status, WNOHANG);
10089 if (errno == ECHILD) {
10090 if (pid == G.last_bg_pid) {
10091 /* "wait $!" but last bg task has already exited. Try:
10092 * (sleep 1; exit 3) & sleep 2; echo $?; wait $!; echo $?
10093 * In bash it prints exitcode 0, then 3.
10094 * In dash, it is 127.
10096 ret = G.last_bg_pid_exitcode;
10098 /* Example: "wait 1". mimic bash message */
10099 bb_error_msg("wait: pid %d is not a child of this shell", (int)pid);
10103 bb_perror_msg("wait %s", *argv);
10105 continue; /* bash checks all argv[] */
10108 /* Yes, and it still runs */
10109 ret = wait_for_child_or_signal(NULL, pid);
10111 /* Yes, and it just exited */
10112 process_wait_result(NULL, pid, status);
10113 ret = WEXITSTATUS(status);
10114 if (WIFSIGNALED(status))
10115 ret = 128 + WTERMSIG(status);
10123 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_FUNCTIONS
10124 static unsigned parse_numeric_argv1(char **argv, unsigned def, unsigned def_min)
10127 def = bb_strtou(argv[1], NULL, 10);
10128 if (errno || def < def_min || argv[2]) {
10129 bb_error_msg("%s: bad arguments", argv[0]);
10137 #if ENABLE_HUSH_LOOPS
10138 static int FAST_FUNC builtin_break(char **argv)
10141 if (G.depth_of_loop == 0) {
10142 bb_error_msg("%s: only meaningful in a loop", argv[0]);
10143 /* if we came from builtin_continue(), need to undo "= 1" */
10144 G.flag_break_continue = 0;
10145 return EXIT_SUCCESS; /* bash compat */
10147 G.flag_break_continue++; /* BC_BREAK = 1, or BC_CONTINUE = 2 */
10149 G.depth_break_continue = depth = parse_numeric_argv1(argv, 1, 1);
10150 if (depth == UINT_MAX)
10151 G.flag_break_continue = BC_BREAK;
10152 if (G.depth_of_loop < depth)
10153 G.depth_break_continue = G.depth_of_loop;
10155 return EXIT_SUCCESS;
10158 static int FAST_FUNC builtin_continue(char **argv)
10160 G.flag_break_continue = 1; /* BC_CONTINUE = 2 = 1+1 */
10161 return builtin_break(argv);
10165 #if ENABLE_HUSH_FUNCTIONS
10166 static int FAST_FUNC builtin_return(char **argv)
10170 if (G_flag_return_in_progress != -1) {
10171 bb_error_msg("%s: not in a function or sourced script", argv[0]);
10172 return EXIT_FAILURE; /* bash compat */
10175 G_flag_return_in_progress = 1;
10178 * out of range: wraps around at 256, does not error out
10179 * non-numeric param:
10180 * f() { false; return qwe; }; f; echo $?
10181 * bash: return: qwe: numeric argument required <== we do this
10182 * 255 <== we also do this
10184 rc = parse_numeric_argv1(argv, G.last_exitcode, 0);
10189 #if ENABLE_HUSH_MEMLEAK
10190 static int FAST_FUNC builtin_memleak(char **argv UNUSED_PARAM)
10195 # ifdef M_TRIM_THRESHOLD
10196 /* Optional. Reduces probability of false positives */
10199 /* Crude attempt to find where "free memory" starts,
10200 * sans fragmentation. */
10202 l = (unsigned long)p;
10205 if (l < (unsigned long)p) l = (unsigned long)p;
10211 struct mallinfo mi = mallinfo();
10212 printf("top alloc:0x%lx malloced:%d+%d=%d\n", l,
10213 mi.arena, mi.hblkhd, mi.arena + mi.hblkhd);
10217 if (!G.memleak_value)
10218 G.memleak_value = l;
10220 l -= G.memleak_value;
10227 /* Exitcode is "how many kilobytes we leaked since 1st call" */