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>
12 * The parser routines proper are all original material, first
13 * written Dec 2000 and Jan 2001 by Larry Doolittle. The
14 * execution engine, the builtins, and much of the underlying
15 * support has been adapted from busybox-0.49pre's lash, which is
16 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
17 * written by Erik Andersen <andersen@codepoet.org>. That, in turn,
18 * is based in part on ladsh.c, by Michael K. Johnson and Erik W.
19 * Troan, which they placed in the public domain. I don't know
20 * how much of the Johnson/Troan code has survived the repeated
24 * o_addchr derived from similar w_addchar function in glibc-2.2.
25 * parse_redirect, redirect_opt_num, and big chunks of main
26 * and many builtins derived from contributions by Erik Andersen.
27 * Miscellaneous bugfixes from Matt Kraai.
29 * There are two big (and related) architecture differences between
30 * this parser and the lash parser. One is that this version is
31 * actually designed from the ground up to understand nearly all
32 * of the Bourne grammar. The second, consequential change is that
33 * the parser and input reader have been turned inside out. Now,
34 * the parser is in control, and asks for input as needed. The old
35 * way had the input reader in control, and it asked for parsing to
36 * take place as needed. The new way makes it much easier to properly
37 * handle the recursion implicit in the various substitutions, especially
38 * across continuation lines.
40 * POSIX syntax not implemented:
42 * <(list) and >(list) Process Substitution
45 * Bash stuff (optionally enabled):
46 * &> and >& redirection of stdout+stderr
48 * reserved words: [[ ]] function select
49 * substrings ${var:1:5}
51 * Each EXPR is an arithmetic expression (ARITHMETIC EVALUATION)
52 * If the last arg evaluates to 0, let returns 1; 0 otherwise.
53 * NB: let `echo 'a=a + 1'` - error (IOW: multi-word expansion is used)
55 * The EXPR is evaluated according to ARITHMETIC EVALUATION.
56 * This is exactly equivalent to let "expression".
59 * grep for "TODO" and fix (some of them are easy)
61 * special variables (done: PWD)
62 * follow IFS rules more precisely, including update semantics
63 * export builtin should be special, its arguments are assignments
64 * and therefore expansion of them should be "one-word" expansion:
65 * $ export i=`echo 'a b'` # export has one arg: "i=a b"
67 * $ ls i=`echo 'a b'` # ls has two args: "i=a" and "b"
68 * ls: cannot access i=a: No such file or directory
69 * ls: cannot access b: No such file or directory
70 * Note1: same applies to local builtin.
71 * Note2: bash 3.2.33(1) does this only if export word itself
73 * $ export i=`echo 'aaa bbb'`; echo "$i"
75 * $ "export" i=`echo 'aaa bbb'`; echo "$i"
78 * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
80 #include "busybox.h" /* for APPLET_IS_NOFORK/NOEXEC */
81 #include <malloc.h> /* for malloc_trim */
83 /* #include <dmalloc.h> */
89 #if ENABLE_HUSH_RANDOM_SUPPORT
92 # define CLEAR_RANDOM_T(rnd) ((void)0)
95 # define PIPE_BUF 4096 /* amount of buffering in a pipe */
100 #define LEAK_HUNTING 0
101 #define BUILD_AS_NOMMU 0
102 /* Enable/disable sanity checks. Ok to enable in production,
103 * only adds a bit of bloat. Set to >1 to get non-production level verbosity.
104 * Keeping 1 for now even in released versions.
107 /* Slightly bigger (+200 bytes), but faster hush.
108 * So far it only enables a trick with counting SIGCHLDs and forks,
109 * which allows us to do fewer waitpid's.
110 * (we can detect a case where neither forks were done nor SIGCHLDs happened
111 * and therefore waitpid will return the same result as last time)
113 #define ENABLE_HUSH_FAST 0
118 # undef USE_FOR_NOMMU
121 # define USE_FOR_NOMMU(...) __VA_ARGS__
122 # define USE_FOR_MMU(...)
125 #if defined SINGLE_APPLET_MAIN
126 /* STANDALONE does not make sense, and won't compile */
127 # undef CONFIG_FEATURE_SH_STANDALONE
128 # undef ENABLE_FEATURE_SH_STANDALONE
129 # undef IF_FEATURE_SH_STANDALONE
130 # define IF_FEATURE_SH_STANDALONE(...)
131 # define IF_NOT_FEATURE_SH_STANDALONE(...) __VA_ARGS__
132 # define ENABLE_FEATURE_SH_STANDALONE 0
135 #if !ENABLE_HUSH_INTERACTIVE
136 # undef ENABLE_FEATURE_EDITING
137 # define ENABLE_FEATURE_EDITING 0
138 # undef ENABLE_FEATURE_EDITING_FANCY_PROMPT
139 # define ENABLE_FEATURE_EDITING_FANCY_PROMPT 0
142 /* Do we support ANY keywords? */
143 #if ENABLE_HUSH_IF || ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
144 # define HAS_KEYWORDS 1
145 # define IF_HAS_KEYWORDS(...) __VA_ARGS__
146 # define IF_HAS_NO_KEYWORDS(...)
148 # define HAS_KEYWORDS 0
149 # define IF_HAS_KEYWORDS(...)
150 # define IF_HAS_NO_KEYWORDS(...) __VA_ARGS__
153 /* If you comment out one of these below, it will be #defined later
154 * to perform debug printfs to stderr: */
155 #define debug_printf(...) do {} while (0)
156 /* Finer-grained debug switches */
157 #define debug_printf_parse(...) do {} while (0)
158 #define debug_print_tree(a, b) do {} while (0)
159 #define debug_printf_exec(...) do {} while (0)
160 #define debug_printf_env(...) do {} while (0)
161 #define debug_printf_jobs(...) do {} while (0)
162 #define debug_printf_expand(...) do {} while (0)
163 #define debug_printf_glob(...) do {} while (0)
164 #define debug_printf_list(...) do {} while (0)
165 #define debug_printf_subst(...) do {} while (0)
166 #define debug_printf_clean(...) do {} while (0)
168 #define ERR_PTR ((void*)(long)1)
170 #define JOB_STATUS_FORMAT "[%d] %-22s %.40s\n"
172 #define SPECIAL_VAR_SYMBOL 3
176 static const char hush_version_str[] ALIGN1 = "HUSH_VERSION="BB_VER;
178 /* This supports saving pointers malloced in vfork child,
179 * to be freed in the parent.
182 typedef struct nommu_save_t {
184 struct variable *old_vars;
186 char **argv_from_re_execing;
190 typedef enum reserved_style {
199 #if ENABLE_HUSH_LOOPS
206 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
211 /* three pseudo-keywords support contrived "case" syntax: */
212 RES_CASE_IN, /* "case ... IN", turns into RES_MATCH when IN is observed */
213 RES_MATCH , /* "word)" */
214 RES_CASE_BODY, /* "this command is inside CASE" */
221 typedef struct o_string {
223 int length; /* position where data is appended */
225 /* Protect newly added chars against globbing
226 * (by prepending \ to *, ?, [, \) */
229 /* At least some part of the string was inside '' or "",
230 * possibly empty one: word"", wo''rd etc. */
232 smallint has_empty_slot;
233 smallint o_assignment; /* 0:maybe, 1:yes, 2:no */
236 MAYBE_ASSIGNMENT = 0,
237 DEFINITELY_ASSIGNMENT = 1,
239 WORD_IS_KEYWORD = 3, /* not assigment, but next word may be: "if v=xyz cmd;" */
241 /* Used for initialization: o_string foo = NULL_O_STRING; */
242 #define NULL_O_STRING { NULL }
244 /* I can almost use ordinary FILE*. Is open_memstream() universally
245 * available? Where is it documented? */
246 typedef struct in_str {
248 /* eof_flag=1: last char in ->p is really an EOF */
249 char eof_flag; /* meaningless if ->p == NULL */
251 #if ENABLE_HUSH_INTERACTIVE
253 smallint promptmode; /* 0: PS1, 1: PS2 */
256 int (*get) (struct in_str *) FAST_FUNC;
257 int (*peek) (struct in_str *) FAST_FUNC;
259 #define i_getch(input) ((input)->get(input))
260 #define i_peek(input) ((input)->peek(input))
262 /* The descrip member of this structure is only used to make
263 * debugging output pretty */
264 static const struct {
266 signed char default_fd;
269 { O_RDONLY, 0, "<" },
270 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
271 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
272 { O_CREAT|O_RDWR, 1, "<>" },
273 { O_RDONLY, 0, "<<" },
274 /* Should not be needed. Bogus default_fd helps in debugging */
275 /* { O_RDONLY, 77, "<<" }, */
278 struct redir_struct {
279 struct redir_struct *next;
280 char *rd_filename; /* filename */
281 int rd_fd; /* fd to redirect */
282 /* fd to redirect to, or -3 if rd_fd is to be closed (n>&-) */
284 smallint rd_type; /* (enum redir_type) */
285 /* note: for heredocs, rd_filename contains heredoc delimiter,
286 * and subsequently heredoc itself; and rd_dup is a bitmask:
287 * bit 0: do we need to trim leading tabs?
288 * bit 1: is heredoc quoted (<<'delim' syntax) ?
291 typedef enum redir_type {
293 REDIRECT_OVERWRITE = 1,
296 REDIRECT_HEREDOC = 4,
297 REDIRECT_HEREDOC2 = 5, /* REDIRECT_HEREDOC after heredoc is loaded */
300 REDIRFD_SYNTAX_ERR = -2,
301 REDIRFD_TO_FILE = -1,
302 /* otherwise, rd_fd is redirected to rd_dup */
304 HEREDOC_SKIPTABS = 1,
310 pid_t pid; /* 0 if exited */
311 int assignment_cnt; /* how many argv[i] are assignments? */
312 smallint is_stopped; /* is the command currently running? */
313 smallint cmd_type; /* CMD_xxx */
315 #define CMD_SUBSHELL 1
317 /* used for "[[ EXPR ]]" */
318 #if ENABLE_HUSH_BASH_COMPAT
319 # define CMD_SINGLEWORD_NOGLOB 2
322 /* used for "export noglob=* glob* a=`echo a b`" */
323 //#define CMD_SINGLEWORD_NOGLOB_COND 3
324 // It is hard to implement correctly, it adds significant amounts of tricky code,
325 // and all this is only useful for really obscure export statements
326 // almost nobody would use anyway. #ifdef CMD_SINGLEWORD_NOGLOB_COND
327 // guards the code which implements it, but I have doubts it works
328 // in all cases (especially with mixed globbed/non-globbed arguments)
330 #if ENABLE_HUSH_FUNCTIONS
331 # define CMD_FUNCDEF 3
334 /* if non-NULL, this "command" is { list }, ( list ), or a compound statement */
337 char *group_as_string;
339 #if ENABLE_HUSH_FUNCTIONS
340 struct function *child_func;
341 /* This field is used to prevent a bug here:
342 * while...do f1() {a;}; f1; f1() {b;}; f1; done
343 * When we execute "f1() {a;}" cmd, we create new function and clear
344 * cmd->group, cmd->group_as_string, cmd->argv[0].
345 * When we execute "f1() {b;}", we notice that f1 exists,
346 * and that its "parent cmd" struct is still "alive",
347 * we put those fields back into cmd->xxx
348 * (struct function has ->parent_cmd ptr to facilitate that).
349 * When we loop back, we can execute "f1() {a;}" again and set f1 correctly.
350 * Without this trick, loop would execute a;b;b;b;...
351 * instead of correct sequence a;b;a;b;...
352 * When command is freed, it severs the link
353 * (sets ->child_func->parent_cmd to NULL).
356 char **argv; /* command name and arguments */
357 /* argv vector may contain variable references (^Cvar^C, ^C0^C etc)
358 * and on execution these are substituted with their values.
359 * Substitution can make _several_ words out of one argv[n]!
360 * Example: argv[0]=='.^C*^C.' here: echo .$*.
361 * References of the form ^C`cmd arg^C are `cmd arg` substitutions.
363 struct redir_struct *redirects; /* I/O redirections */
365 /* Is there anything in this command at all? */
366 #define IS_NULL_CMD(cmd) \
367 (!(cmd)->group && !(cmd)->argv && !(cmd)->redirects)
372 int num_cmds; /* total number of commands in pipe */
373 int alive_cmds; /* number of commands running (not exited) */
374 int stopped_cmds; /* number of commands alive, but stopped */
376 int jobid; /* job number */
377 pid_t pgrp; /* process group ID for the job */
378 char *cmdtext; /* name of job */
380 struct command *cmds; /* array of commands in pipe */
381 smallint followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
382 IF_HAS_KEYWORDS(smallint pi_inverted;) /* "! cmd | cmd" */
383 IF_HAS_KEYWORDS(smallint res_word;) /* needed for if, for, while, until... */
385 typedef enum pipe_style {
391 /* Is there anything in this pipe at all? */
392 #define IS_NULL_PIPE(pi) \
393 ((pi)->num_cmds == 0 IF_HAS_KEYWORDS( && (pi)->res_word == RES_NONE))
395 /* This holds pointers to the various results of parsing */
396 struct parse_context {
397 /* linked list of pipes */
398 struct pipe *list_head;
399 /* last pipe (being constructed right now) */
401 /* last command in pipe (being constructed right now) */
402 struct command *command;
403 /* last redirect in command->redirects list */
404 struct redir_struct *pending_redirect;
410 smallint ctx_inverted; /* "! cmd | cmd" */
412 smallint ctx_dsemicolon; /* ";;" seen */
414 /* bitmask of FLAG_xxx, for figuring out valid reserved words */
416 /* group we are enclosed in:
417 * example: "if pipe1; pipe2; then pipe3; fi"
418 * when we see "if" or "then", we malloc and copy current context,
419 * and make ->stack point to it. then we parse pipeN.
420 * when closing "then" / fi" / whatever is found,
421 * we move list_head into ->stack->command->group,
422 * copy ->stack into current context, and delete ->stack.
423 * (parsing of { list } and ( list ) doesn't use this method)
425 struct parse_context *stack;
429 /* On program start, environ points to initial environment.
430 * putenv adds new pointers into it, unsetenv removes them.
431 * Neither of these (de)allocates the strings.
432 * setenv allocates new strings in malloc space and does putenv,
433 * and thus setenv is unusable (leaky) for shell's purposes */
434 #define setenv(...) setenv_is_leaky_dont_use()
436 struct variable *next;
437 char *varstr; /* points to "name=" portion */
438 #if ENABLE_HUSH_LOCAL
439 unsigned func_nest_level;
441 int max_len; /* if > 0, name is part of initial env; else name is malloced */
442 smallint flg_export; /* putenv should be done on this var */
443 smallint flg_read_only;
451 #if ENABLE_HUSH_FUNCTIONS
453 struct function *next;
455 struct command *parent_cmd;
458 char *body_as_string;
464 /* "Globals" within this file */
465 /* Sorted roughly by size (smaller offsets == smaller code) */
467 /* interactive_fd != 0 means we are an interactive shell.
468 * If we are, then saved_tty_pgrp can also be != 0, meaning
469 * that controlling tty is available. With saved_tty_pgrp == 0,
470 * job control still works, but terminal signals
471 * (^C, ^Z, ^Y, ^\) won't work at all, and background
472 * process groups can only be created with "cmd &".
473 * With saved_tty_pgrp != 0, hush will use tcsetpgrp()
474 * to give tty to the foreground process group,
475 * and will take it back when the group is stopped (^Z)
478 #if ENABLE_HUSH_INTERACTIVE
479 /* 'interactive_fd' is a fd# open to ctty, if we have one
480 * _AND_ if we decided to act interactively */
484 # define G_interactive_fd (G.interactive_fd)
486 # define G_interactive_fd 0
488 #if ENABLE_FEATURE_EDITING
489 line_input_t *line_input_state;
494 #if ENABLE_HUSH_RANDOM_SUPPORT
500 pid_t saved_tty_pgrp;
501 struct pipe *job_list;
502 # define G_saved_tty_pgrp (G.saved_tty_pgrp)
504 # define G_saved_tty_pgrp 0
506 smallint flag_SIGINT;
507 #if ENABLE_HUSH_LOOPS
508 smallint flag_break_continue;
510 #if ENABLE_HUSH_FUNCTIONS
511 /* 0: outside of a function (or sourced file)
512 * -1: inside of a function, ok to use return builtin
513 * 1: return is invoked, skip all till end of func
515 smallint flag_return_in_progress;
518 smallint exiting; /* used to prevent EXIT trap recursion */
519 /* These four support $?, $#, and $1 */
520 smalluint last_exitcode;
521 /* are global_argv and global_argv[1..n] malloced? (note: not [0]) */
522 smalluint global_args_malloced;
523 smalluint inherited_set_is_saved;
524 /* how many non-NULL argv's we have. NB: $# + 1 */
528 char *argv0_for_re_execing;
530 #if ENABLE_HUSH_LOOPS
531 unsigned depth_break_continue;
532 unsigned depth_of_loop;
536 struct variable *top_var; /* = &G.shell_ver (set in main()) */
537 struct variable shell_ver;
538 #if ENABLE_HUSH_FUNCTIONS
539 struct function *top_func;
540 # if ENABLE_HUSH_LOCAL
541 struct variable **shadowed_vars_pp;
542 unsigned func_nest_level;
545 /* Signal and trap handling */
547 unsigned count_SIGCHLD;
548 unsigned handled_SIGCHLD;
549 smallint we_have_children;
551 /* which signals have non-DFL handler (even with no traps set)? */
552 unsigned non_DFL_mask;
553 char **traps; /* char *traps[NSIG] */
554 sigset_t blocked_set;
555 sigset_t inherited_set;
557 unsigned long memleak_value;
560 char user_input_buf[ENABLE_FEATURE_EDITING ? CONFIG_FEATURE_EDITING_MAX_LEN : 2];
562 #define G (*ptr_to_globals)
563 /* Not #defining name to G.name - this quickly gets unwieldy
564 * (too many defines). Also, I actually prefer to see when a variable
565 * is global, thus "G." prefix is a useful hint */
566 #define INIT_G() do { \
567 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
571 /* Function prototypes for builtins */
572 static int builtin_cd(char **argv) FAST_FUNC;
573 static int builtin_echo(char **argv) FAST_FUNC;
574 static int builtin_eval(char **argv) FAST_FUNC;
575 static int builtin_exec(char **argv) FAST_FUNC;
576 static int builtin_exit(char **argv) FAST_FUNC;
577 static int builtin_export(char **argv) FAST_FUNC;
579 static int builtin_fg_bg(char **argv) FAST_FUNC;
580 static int builtin_jobs(char **argv) FAST_FUNC;
583 static int builtin_help(char **argv) FAST_FUNC;
585 #if ENABLE_HUSH_LOCAL
586 static int builtin_local(char **argv) FAST_FUNC;
589 static int builtin_memleak(char **argv) FAST_FUNC;
592 static int builtin_printf(char **argv) FAST_FUNC;
594 static int builtin_pwd(char **argv) FAST_FUNC;
595 static int builtin_read(char **argv) FAST_FUNC;
596 static int builtin_set(char **argv) FAST_FUNC;
597 static int builtin_shift(char **argv) FAST_FUNC;
598 static int builtin_source(char **argv) FAST_FUNC;
599 static int builtin_test(char **argv) FAST_FUNC;
600 static int builtin_trap(char **argv) FAST_FUNC;
601 static int builtin_type(char **argv) FAST_FUNC;
602 static int builtin_true(char **argv) FAST_FUNC;
603 static int builtin_umask(char **argv) FAST_FUNC;
604 static int builtin_unset(char **argv) FAST_FUNC;
605 static int builtin_wait(char **argv) FAST_FUNC;
606 #if ENABLE_HUSH_LOOPS
607 static int builtin_break(char **argv) FAST_FUNC;
608 static int builtin_continue(char **argv) FAST_FUNC;
610 #if ENABLE_HUSH_FUNCTIONS
611 static int builtin_return(char **argv) FAST_FUNC;
614 /* Table of built-in functions. They can be forked or not, depending on
615 * context: within pipes, they fork. As simple commands, they do not.
616 * When used in non-forking context, they can change global variables
617 * in the parent shell process. If forked, of course they cannot.
618 * For example, 'unset foo | whatever' will parse and run, but foo will
619 * still be set at the end. */
620 struct built_in_command {
622 int (*function)(char **argv) FAST_FUNC;
625 # define BLTIN(cmd, func, help) { cmd, func, help }
627 # define BLTIN(cmd, func, help) { cmd, func }
631 static const struct built_in_command bltins1[] = {
632 BLTIN("." , builtin_source , "Run commands in a file"),
633 BLTIN(":" , builtin_true , NULL),
635 BLTIN("bg" , builtin_fg_bg , "Resume a job in the background"),
637 #if ENABLE_HUSH_LOOPS
638 BLTIN("break" , builtin_break , "Exit from a loop"),
640 BLTIN("cd" , builtin_cd , "Change directory"),
641 #if ENABLE_HUSH_LOOPS
642 BLTIN("continue" , builtin_continue, "Start new loop iteration"),
644 BLTIN("eval" , builtin_eval , "Construct and run shell command"),
645 BLTIN("exec" , builtin_exec , "Execute command, don't return to shell"),
646 BLTIN("exit" , builtin_exit , "Exit"),
647 BLTIN("export" , builtin_export , "Set environment variables"),
649 BLTIN("fg" , builtin_fg_bg , "Bring job into the foreground"),
652 BLTIN("help" , builtin_help , NULL),
655 BLTIN("jobs" , builtin_jobs , "List jobs"),
657 #if ENABLE_HUSH_LOCAL
658 BLTIN("local" , builtin_local , "Set local variables"),
661 BLTIN("memleak" , builtin_memleak , NULL),
663 BLTIN("read" , builtin_read , "Input into variable"),
664 #if ENABLE_HUSH_FUNCTIONS
665 BLTIN("return" , builtin_return , "Return from a function"),
667 BLTIN("set" , builtin_set , "Set/unset positional parameters"),
668 BLTIN("shift" , builtin_shift , "Shift positional parameters"),
669 BLTIN("trap" , builtin_trap , "Trap signals"),
670 BLTIN("type" , builtin_type , "Write a description of command type"),
671 // BLTIN("ulimit" , builtin_ulimit , "Control resource limits"),
672 BLTIN("umask" , builtin_umask , "Set file creation mask"),
673 BLTIN("unset" , builtin_unset , "Unset variables"),
674 BLTIN("wait" , builtin_wait , "Wait for process"),
676 /* For now, echo and test are unconditionally enabled.
677 * Maybe make it configurable? */
678 static const struct built_in_command bltins2[] = {
679 BLTIN("[" , builtin_test , NULL),
680 BLTIN("echo" , builtin_echo , NULL),
682 BLTIN("printf" , builtin_printf , NULL),
684 BLTIN("pwd" , builtin_pwd , NULL),
685 BLTIN("test" , builtin_test , NULL),
692 /* prevent disasters with G.debug_indent < 0 */
693 # define indent() fprintf(stderr, "%*s", (G.debug_indent * 2) & 0xff, "")
694 # define debug_enter() (G.debug_indent++)
695 # define debug_leave() (G.debug_indent--)
697 # define indent() ((void)0)
698 # define debug_enter() ((void)0)
699 # define debug_leave() ((void)0)
703 # define debug_printf(...) (indent(), fprintf(stderr, __VA_ARGS__))
706 #ifndef debug_printf_parse
707 # define debug_printf_parse(...) (indent(), fprintf(stderr, __VA_ARGS__))
710 #ifndef debug_printf_exec
711 #define debug_printf_exec(...) (indent(), fprintf(stderr, __VA_ARGS__))
714 #ifndef debug_printf_env
715 # define debug_printf_env(...) (indent(), fprintf(stderr, __VA_ARGS__))
718 #ifndef debug_printf_jobs
719 # define debug_printf_jobs(...) (indent(), fprintf(stderr, __VA_ARGS__))
720 # define DEBUG_JOBS 1
722 # define DEBUG_JOBS 0
725 #ifndef debug_printf_expand
726 # define debug_printf_expand(...) (indent(), fprintf(stderr, __VA_ARGS__))
727 # define DEBUG_EXPAND 1
729 # define DEBUG_EXPAND 0
732 #ifndef debug_printf_glob
733 # define debug_printf_glob(...) (indent(), fprintf(stderr, __VA_ARGS__))
734 # define DEBUG_GLOB 1
736 # define DEBUG_GLOB 0
739 #ifndef debug_printf_list
740 # define debug_printf_list(...) (indent(), fprintf(stderr, __VA_ARGS__))
743 #ifndef debug_printf_subst
744 # define debug_printf_subst(...) (indent(), fprintf(stderr, __VA_ARGS__))
747 #ifndef debug_printf_clean
748 # define debug_printf_clean(...) (indent(), fprintf(stderr, __VA_ARGS__))
749 # define DEBUG_CLEAN 1
751 # define DEBUG_CLEAN 0
755 static void debug_print_strings(const char *prefix, char **vv)
758 fprintf(stderr, "%s:\n", prefix);
760 fprintf(stderr, " '%s'\n", *vv++);
763 # define debug_print_strings(prefix, vv) ((void)0)
767 /* Leak hunting. Use hush_leaktool.sh for post-processing.
770 static void *xxmalloc(int lineno, size_t size)
772 void *ptr = xmalloc((size + 0xff) & ~0xff);
773 fdprintf(2, "line %d: malloc %p\n", lineno, ptr);
776 static void *xxrealloc(int lineno, void *ptr, size_t size)
778 ptr = xrealloc(ptr, (size + 0xff) & ~0xff);
779 fdprintf(2, "line %d: realloc %p\n", lineno, ptr);
782 static char *xxstrdup(int lineno, const char *str)
784 char *ptr = xstrdup(str);
785 fdprintf(2, "line %d: strdup %p\n", lineno, ptr);
788 static void xxfree(void *ptr)
790 fdprintf(2, "free %p\n", ptr);
793 #define xmalloc(s) xxmalloc(__LINE__, s)
794 #define xrealloc(p, s) xxrealloc(__LINE__, p, s)
795 #define xstrdup(s) xxstrdup(__LINE__, s)
796 #define free(p) xxfree(p)
800 /* Syntax and runtime errors. They always abort scripts.
801 * In interactive use they usually discard unparsed and/or unexecuted commands
802 * and return to the prompt.
803 * HUSH_DEBUG >= 2 prints line number in this file where it was detected.
806 # define die_if_script(lineno, ...) die_if_script(__VA_ARGS__)
807 # define syntax_error(lineno, msg) syntax_error(msg)
808 # define syntax_error_at(lineno, msg) syntax_error_at(msg)
809 # define syntax_error_unterm_ch(lineno, ch) syntax_error_unterm_ch(ch)
810 # define syntax_error_unterm_str(lineno, s) syntax_error_unterm_str(s)
811 # define syntax_error_unexpected_ch(lineno, ch) syntax_error_unexpected_ch(ch)
814 static void die_if_script(unsigned lineno, const char *fmt, ...)
819 bb_error_msg("hush.c:%u", lineno);
822 bb_verror_msg(fmt, p, NULL);
824 if (!G_interactive_fd)
828 static void syntax_error(unsigned lineno, const char *msg)
831 die_if_script(lineno, "syntax error: %s", msg);
833 die_if_script(lineno, "syntax error", NULL);
836 static void syntax_error_at(unsigned lineno, const char *msg)
838 die_if_script(lineno, "syntax error at '%s'", msg);
841 static void syntax_error_unterm_str(unsigned lineno, const char *s)
843 die_if_script(lineno, "syntax error: unterminated %s", s);
846 /* It so happens that all such cases are totally fatal
847 * even if shell is interactive: EOF while looking for closing
848 * delimiter. There is nowhere to read stuff from after that,
849 * it's EOF! The only choice is to terminate.
851 static void syntax_error_unterm_ch(unsigned lineno, char ch) NORETURN;
852 static void syntax_error_unterm_ch(unsigned lineno, char ch)
854 char msg[2] = { ch, '\0' };
855 syntax_error_unterm_str(lineno, msg);
859 static void syntax_error_unexpected_ch(unsigned lineno, int ch)
864 die_if_script(lineno, "syntax error: unexpected %s", ch == EOF ? "EOF" : msg);
868 # undef die_if_script
870 # undef syntax_error_at
871 # undef syntax_error_unterm_ch
872 # undef syntax_error_unterm_str
873 # undef syntax_error_unexpected_ch
875 # define die_if_script(...) die_if_script(__LINE__, __VA_ARGS__)
876 # define syntax_error(msg) syntax_error(__LINE__, msg)
877 # define syntax_error_at(msg) syntax_error_at(__LINE__, msg)
878 # define syntax_error_unterm_ch(ch) syntax_error_unterm_ch(__LINE__, ch)
879 # define syntax_error_unterm_str(s) syntax_error_unterm_str(__LINE__, s)
880 # define syntax_error_unexpected_ch(ch) syntax_error_unexpected_ch(__LINE__, ch)
884 #if ENABLE_HUSH_INTERACTIVE
885 static void cmdedit_update_prompt(void);
887 # define cmdedit_update_prompt() ((void)0)
893 static int is_well_formed_var_name(const char *s, char terminator)
895 if (!s || !(isalpha(*s) || *s == '_'))
898 while (isalnum(*s) || *s == '_')
900 return *s == terminator;
903 /* Replace each \x with x in place, return ptr past NUL. */
904 static char *unbackslash(char *src)
906 char *dst = src = strchrnul(src, '\\');
910 if ((*dst++ = *src++) == '\0')
916 static char **add_strings_to_strings(char **strings, char **add, int need_to_dup)
937 v = xrealloc(strings, (count1 + count2 + 1) * sizeof(char*));
938 v[count1 + count2] = NULL;
941 v[count1 + i] = (need_to_dup ? xstrdup(add[i]) : add[i]);
945 static char **xx_add_strings_to_strings(int lineno, char **strings, char **add, int need_to_dup)
947 char **ptr = add_strings_to_strings(strings, add, need_to_dup);
948 fdprintf(2, "line %d: add_strings_to_strings %p\n", lineno, ptr);
951 #define add_strings_to_strings(strings, add, need_to_dup) \
952 xx_add_strings_to_strings(__LINE__, strings, add, need_to_dup)
955 /* Note: takes ownership of "add" ptr (it is not strdup'ed) */
956 static char **add_string_to_strings(char **strings, char *add)
961 return add_strings_to_strings(strings, v, /*dup:*/ 0);
964 static char **xx_add_string_to_strings(int lineno, char **strings, char *add)
966 char **ptr = add_string_to_strings(strings, add);
967 fdprintf(2, "line %d: add_string_to_strings %p\n", lineno, ptr);
970 #define add_string_to_strings(strings, add) \
971 xx_add_string_to_strings(__LINE__, strings, add)
974 static void free_strings(char **strings)
989 /* Helpers for setting new $n and restoring them back
991 typedef struct save_arg_t {
995 smallint sv_g_malloced;
998 static void save_and_replace_G_args(save_arg_t *sv, char **argv)
1002 sv->sv_argv0 = argv[0];
1003 sv->sv_g_argv = G.global_argv;
1004 sv->sv_g_argc = G.global_argc;
1005 sv->sv_g_malloced = G.global_args_malloced;
1007 argv[0] = G.global_argv[0]; /* retain $0 */
1008 G.global_argv = argv;
1009 G.global_args_malloced = 0;
1017 static void restore_G_args(save_arg_t *sv, char **argv)
1021 if (G.global_args_malloced) {
1022 /* someone ran "set -- arg1 arg2 ...", undo */
1024 while (*++pp) /* note: does not free $0 */
1026 free(G.global_argv);
1028 argv[0] = sv->sv_argv0;
1029 G.global_argv = sv->sv_g_argv;
1030 G.global_argc = sv->sv_g_argc;
1031 G.global_args_malloced = sv->sv_g_malloced;
1035 /* Basic theory of signal handling in shell
1036 * ========================================
1037 * This does not describe what hush does, rather, it is current understanding
1038 * what it _should_ do. If it doesn't, it's a bug.
1039 * http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
1041 * Signals are handled only after each pipe ("cmd | cmd | cmd" thing)
1042 * is finished or backgrounded. It is the same in interactive and
1043 * non-interactive shells, and is the same regardless of whether
1044 * a user trap handler is installed or a shell special one is in effect.
1045 * ^C or ^Z from keyboard seems to execute "at once" because it usually
1046 * backgrounds (i.e. stops) or kills all members of currently running
1049 * Wait builtin in interruptible by signals for which user trap is set
1050 * or by SIGINT in interactive shell.
1052 * Trap handlers will execute even within trap handlers. (right?)
1054 * User trap handlers are forgotten when subshell ("(cmd)") is entered,
1055 * except for handlers set to '' (empty string).
1057 * If job control is off, backgrounded commands ("cmd &")
1058 * have SIGINT, SIGQUIT set to SIG_IGN.
1060 * Commands which are run in command substitution ("`cmd`")
1061 * have SIGTTIN, SIGTTOU, SIGTSTP set to SIG_IGN.
1063 * Ordinary commands have signals set to SIG_IGN/DFL as inherited
1064 * by the shell from its parent.
1066 * Signals which differ from SIG_DFL action
1067 * (note: child (i.e., [v]forked) shell is not an interactive shell):
1070 * SIGTERM (interactive): ignore
1071 * SIGHUP (interactive):
1072 * send SIGCONT to stopped jobs, send SIGHUP to all jobs and exit
1073 * SIGTTIN, SIGTTOU, SIGTSTP (if job control is on): ignore
1074 * Note that ^Z is handled not by trapping SIGTSTP, but by seeing
1075 * that all pipe members are stopped. Try this in bash:
1076 * while :; do :; done - ^Z does not background it
1077 * (while :; do :; done) - ^Z backgrounds it
1078 * SIGINT (interactive): wait for last pipe, ignore the rest
1079 * of the command line, show prompt. NB: ^C does not send SIGINT
1080 * to interactive shell while shell is waiting for a pipe,
1081 * since shell is bg'ed (is not in foreground process group).
1082 * Example 1: this waits 5 sec, but does not execute ls:
1083 * "echo $$; sleep 5; ls -l" + "kill -INT <pid>"
1084 * Example 2: this does not wait and does not execute ls:
1085 * "echo $$; sleep 5 & wait; ls -l" + "kill -INT <pid>"
1086 * Example 3: this does not wait 5 sec, but executes ls:
1087 * "sleep 5; ls -l" + press ^C
1089 * (What happens to signals which are IGN on shell start?)
1090 * (What happens with signal mask on shell start?)
1092 * Implementation in hush
1093 * ======================
1094 * We use in-kernel pending signal mask to determine which signals were sent.
1095 * We block all signals which we don't want to take action immediately,
1096 * i.e. we block all signals which need to have special handling as described
1097 * above, and all signals which have traps set.
1098 * After each pipe execution, we extract any pending signals via sigtimedwait()
1101 * unsigned non_DFL_mask: a mask of such "special" signals
1102 * sigset_t blocked_set: current blocked signal set
1105 * clear bit in blocked_set unless it is also in non_DFL_mask
1106 * "trap 'cmd' SIGxxx":
1107 * set bit in blocked_set (even if 'cmd' is '')
1108 * after [v]fork, if we plan to be a shell:
1109 * unblock signals with special interactive handling
1110 * (child shell is not interactive),
1111 * unset all traps except '' (note: regardless of child shell's type - {}, (), etc)
1112 * after [v]fork, if we plan to exec:
1113 * POSIX says fork clears pending signal mask in child - no need to clear it.
1114 * Restore blocked signal set to one inherited by shell just prior to exec.
1116 * Note: as a result, we do not use signal handlers much. The only uses
1117 * are to count SIGCHLDs
1118 * and to restore tty pgrp on signal-induced exit.
1121 * Standard says "When a subshell is entered, traps that are not being ignored
1122 * are set to the default actions". bash interprets it so that traps which
1123 * are set to '' (ignore) are NOT reset to defaults. We do the same.
1126 SPECIAL_INTERACTIVE_SIGS = 0
1131 SPECIAL_JOB_SIGS = 0
1139 #if ENABLE_HUSH_FAST
1140 static void SIGCHLD_handler(int sig UNUSED_PARAM)
1143 //bb_error_msg("[%d] SIGCHLD_handler: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1149 /* After [v]fork, in child: do not restore tty pgrp on xfunc death */
1150 #define disable_restore_tty_pgrp_on_exit() (die_sleep = 0)
1151 /* After [v]fork, in parent: restore tty pgrp on xfunc death */
1152 #define enable_restore_tty_pgrp_on_exit() (die_sleep = -1)
1154 /* Restores tty foreground process group, and exits.
1155 * May be called as signal handler for fatal signal
1156 * (will resend signal to itself, producing correct exit state)
1157 * or called directly with -EXITCODE.
1158 * We also call it if xfunc is exiting. */
1159 static void sigexit(int sig) NORETURN;
1160 static void sigexit(int sig)
1162 /* Disable all signals: job control, SIGPIPE, etc. */
1163 sigprocmask_allsigs(SIG_BLOCK);
1165 /* Careful: we can end up here after [v]fork. Do not restore
1166 * tty pgrp then, only top-level shell process does that */
1167 if (G_saved_tty_pgrp && getpid() == G.root_pid)
1168 tcsetpgrp(G_interactive_fd, G_saved_tty_pgrp);
1170 /* Not a signal, just exit */
1174 kill_myself_with_sig(sig); /* does not return */
1178 #define disable_restore_tty_pgrp_on_exit() ((void)0)
1179 #define enable_restore_tty_pgrp_on_exit() ((void)0)
1183 /* Restores tty foreground process group, and exits. */
1184 static void hush_exit(int exitcode) NORETURN;
1185 static void hush_exit(int exitcode)
1187 if (G.exiting <= 0 && G.traps && G.traps[0] && G.traps[0][0]) {
1188 /* Prevent recursion:
1189 * trap "echo Hi; exit" EXIT; exit
1191 char *argv[] = { NULL, G.traps[0], NULL };
1200 sigexit(- (exitcode & 0xff));
1206 static int check_and_run_traps(int sig)
1208 static const struct timespec zero_timespec = { 0, 0 };
1209 smalluint save_rcode;
1215 sig = sigtimedwait(&G.blocked_set, NULL, &zero_timespec);
1220 if (G.traps && G.traps[sig]) {
1221 if (G.traps[sig][0]) {
1222 /* We have user-defined handler */
1223 char *argv[] = { NULL, xstrdup(G.traps[sig]), NULL };
1224 save_rcode = G.last_exitcode;
1227 G.last_exitcode = save_rcode;
1228 } /* else: "" trap, ignoring signal */
1231 /* not a trap: special action */
1233 #if ENABLE_HUSH_FAST
1236 //bb_error_msg("[%d] check_and_run_traps: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1240 /* Builtin was ^C'ed, make it look prettier: */
1247 /* bash is observed to signal whole process groups,
1248 * not individual processes */
1249 for (job = G.job_list; job; job = job->next) {
1252 debug_printf_exec("HUPing pgrp %d\n", job->pgrp);
1253 if (kill(- job->pgrp, SIGHUP) == 0)
1254 kill(- job->pgrp, SIGCONT);
1259 default: /* ignored: */
1260 /* SIGTERM, SIGQUIT, SIGTTIN, SIGTTOU, SIGTSTP */
1268 static const char *get_cwd(int force)
1270 if (force || G.cwd == NULL) {
1271 /* xrealloc_getcwd_or_warn(arg) calls free(arg),
1272 * we must not try to free(bb_msg_unknown) */
1273 if (G.cwd == bb_msg_unknown)
1275 G.cwd = xrealloc_getcwd_or_warn((char *)G.cwd);
1277 G.cwd = bb_msg_unknown;
1284 * Shell and environment variable support
1286 static struct variable **get_ptr_to_local_var(const char *name)
1288 struct variable **pp;
1289 struct variable *cur;
1294 while ((cur = *pp) != NULL) {
1295 if (strncmp(cur->varstr, name, len) == 0 && cur->varstr[len] == '=')
1302 static struct variable *get_local_var(const char *name)
1304 struct variable **pp = get_ptr_to_local_var(name);
1310 static const char *get_local_var_value(const char *name)
1312 struct variable **pp = get_ptr_to_local_var(name);
1314 return strchr((*pp)->varstr, '=') + 1;
1315 if (strcmp(name, "PPID") == 0)
1316 return utoa(G.root_ppid);
1317 // bash compat: UID? EUID?
1318 #if ENABLE_HUSH_RANDOM_SUPPORT
1319 if (strcmp(name, "RANDOM") == 0) {
1320 return utoa(next_random(&G.random_gen));
1326 /* str holds "NAME=VAL" and is expected to be malloced.
1327 * We take ownership of it.
1329 * 0: do not change export flag
1330 * (if creating new variable, flag will be 0)
1331 * 1: set export flag and putenv the variable
1332 * -1: clear export flag and unsetenv the variable
1333 * flg_read_only is set only when we handle -R var=val
1335 #if !BB_MMU && ENABLE_HUSH_LOCAL
1336 /* all params are used */
1337 #elif BB_MMU && ENABLE_HUSH_LOCAL
1338 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1339 set_local_var(str, flg_export, local_lvl)
1340 #elif BB_MMU && !ENABLE_HUSH_LOCAL
1341 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1342 set_local_var(str, flg_export)
1343 #elif !BB_MMU && !ENABLE_HUSH_LOCAL
1344 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1345 set_local_var(str, flg_export, flg_read_only)
1347 static int set_local_var(char *str, int flg_export, int local_lvl, int flg_read_only)
1349 struct variable **var_pp;
1350 struct variable *cur;
1354 eq_sign = strchr(str, '=');
1355 if (!eq_sign) { /* not expected to ever happen? */
1360 name_len = eq_sign - str + 1; /* including '=' */
1361 var_pp = &G.top_var;
1362 while ((cur = *var_pp) != NULL) {
1363 if (strncmp(cur->varstr, str, name_len) != 0) {
1364 var_pp = &cur->next;
1367 /* We found an existing var with this name */
1368 if (cur->flg_read_only) {
1372 bb_error_msg("%s: readonly variable", str);
1376 if (flg_export == -1) { // "&& cur->flg_export" ?
1377 debug_printf_env("%s: unsetenv '%s'\n", __func__, str);
1382 #if ENABLE_HUSH_LOCAL
1383 if (cur->func_nest_level < local_lvl) {
1384 /* New variable is declared as local,
1385 * and existing one is global, or local
1386 * from enclosing function.
1387 * Remove and save old one: */
1388 *var_pp = cur->next;
1389 cur->next = *G.shadowed_vars_pp;
1390 *G.shadowed_vars_pp = cur;
1391 /* bash 3.2.33(1) and exported vars:
1393 * # f() { local z=a; env | grep ^z; }
1399 if (cur->flg_export)
1404 if (strcmp(cur->varstr + name_len, eq_sign + 1) == 0) {
1409 if (cur->max_len != 0) {
1410 if (cur->max_len >= strlen(str)) {
1411 /* This one is from startup env, reuse space */
1412 strcpy(cur->varstr, str);
1416 /* max_len == 0 signifies "malloced" var, which we can
1417 * (and has to) free */
1421 goto set_str_and_exp;
1424 /* Not found - create new variable struct */
1425 cur = xzalloc(sizeof(*cur));
1426 #if ENABLE_HUSH_LOCAL
1427 cur->func_nest_level = local_lvl;
1429 cur->next = *var_pp;
1435 cur->flg_read_only = flg_read_only;
1438 if (flg_export == 1)
1439 cur->flg_export = 1;
1440 if (name_len == 4 && cur->varstr[0] == 'P' && cur->varstr[1] == 'S')
1441 cmdedit_update_prompt();
1442 if (cur->flg_export) {
1443 if (flg_export == -1) {
1444 cur->flg_export = 0;
1445 /* unsetenv was already done */
1447 debug_printf_env("%s: putenv '%s'\n", __func__, cur->varstr);
1448 return putenv(cur->varstr);
1454 /* Used at startup and after each cd */
1455 static void set_pwd_var(int exp)
1457 set_local_var(xasprintf("PWD=%s", get_cwd(/*force:*/ 1)),
1458 /*exp:*/ exp, /*lvl:*/ 0, /*ro:*/ 0);
1461 static int unset_local_var_len(const char *name, int name_len)
1463 struct variable *cur;
1464 struct variable **var_pp;
1467 return EXIT_SUCCESS;
1468 var_pp = &G.top_var;
1469 while ((cur = *var_pp) != NULL) {
1470 if (strncmp(cur->varstr, name, name_len) == 0 && cur->varstr[name_len] == '=') {
1471 if (cur->flg_read_only) {
1472 bb_error_msg("%s: readonly variable", name);
1473 return EXIT_FAILURE;
1475 *var_pp = cur->next;
1476 debug_printf_env("%s: unsetenv '%s'\n", __func__, cur->varstr);
1477 bb_unsetenv(cur->varstr);
1478 if (name_len == 3 && cur->varstr[0] == 'P' && cur->varstr[1] == 'S')
1479 cmdedit_update_prompt();
1483 return EXIT_SUCCESS;
1485 var_pp = &cur->next;
1487 return EXIT_SUCCESS;
1490 static int unset_local_var(const char *name)
1492 return unset_local_var_len(name, strlen(name));
1495 static void unset_vars(char **strings)
1503 const char *eq = strchrnul(*v, '=');
1504 unset_local_var_len(*v, (int)(eq - *v));
1510 #if ENABLE_SH_MATH_SUPPORT
1511 #define is_name(c) ((c) == '_' || isalpha((unsigned char)(c)))
1512 #define is_in_name(c) ((c) == '_' || isalnum((unsigned char)(c)))
1513 static char *endofname(const char *name)
1521 if (!is_in_name(*p))
1527 static void arith_set_local_var(const char *name, const char *val, int flags)
1529 /* arith code doesnt malloc space, so do it for it */
1530 char *var = xasprintf("%s=%s", name, val);
1531 set_local_var(var, flags, /*lvl:*/ 0, /*ro:*/ 0);
1537 * Helpers for "var1=val1 var2=val2 cmd" feature
1539 static void add_vars(struct variable *var)
1541 struct variable *next;
1545 var->next = G.top_var;
1547 if (var->flg_export) {
1548 debug_printf_env("%s: restoring exported '%s'\n", __func__, var->varstr);
1549 putenv(var->varstr);
1551 debug_printf_env("%s: restoring variable '%s'\n", __func__, var->varstr);
1557 static struct variable *set_vars_and_save_old(char **strings)
1560 struct variable *old = NULL;
1566 struct variable *var_p;
1567 struct variable **var_pp;
1570 eq = strchr(*s, '=');
1573 var_pp = get_ptr_to_local_var(*s);
1576 /* Remove variable from global linked list */
1578 debug_printf_env("%s: removing '%s'\n", __func__, var_p->varstr);
1579 *var_pp = var_p->next;
1580 /* Add it to returned list */
1584 set_local_var(*s, /*exp:*/ 1, /*lvl:*/ 0, /*ro:*/ 0);
1595 static int FAST_FUNC static_get(struct in_str *i)
1604 static int FAST_FUNC static_peek(struct in_str *i)
1609 #if ENABLE_HUSH_INTERACTIVE
1611 static void cmdedit_update_prompt(void)
1613 if (ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1614 G.PS1 = get_local_var_value("PS1");
1617 G.PS2 = get_local_var_value("PS2");
1625 static const char* setup_prompt_string(int promptmode)
1627 const char *prompt_str;
1628 debug_printf("setup_prompt_string %d ", promptmode);
1629 if (!ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1630 /* Set up the prompt */
1631 if (promptmode == 0) { /* PS1 */
1633 /* bash uses $PWD value, even if it is set by user.
1634 * It uses current dir only if PWD is unset.
1635 * We always use current dir. */
1636 G.PS1 = xasprintf("%s %c ", get_cwd(0), (geteuid() != 0) ? '$' : '#');
1641 prompt_str = (promptmode == 0) ? G.PS1 : G.PS2;
1642 debug_printf("result '%s'\n", prompt_str);
1646 static void get_user_input(struct in_str *i)
1649 const char *prompt_str;
1651 prompt_str = setup_prompt_string(i->promptmode);
1652 #if ENABLE_FEATURE_EDITING
1653 /* Enable command line editing only while a command line
1654 * is actually being read */
1657 /* buglet: SIGINT will not make new prompt to appear _at once_,
1658 * only after <Enter>. (^C will work) */
1659 r = read_line_input(prompt_str, G.user_input_buf, CONFIG_FEATURE_EDITING_MAX_LEN-1, G.line_input_state);
1660 /* catch *SIGINT* etc (^C is handled by read_line_input) */
1661 check_and_run_traps(0);
1662 } while (r == 0 || G.flag_SIGINT); /* repeat if ^C or SIGINT */
1663 i->eof_flag = (r < 0);
1664 if (i->eof_flag) { /* EOF/error detected */
1665 G.user_input_buf[0] = EOF; /* yes, it will be truncated, it's ok */
1666 G.user_input_buf[1] = '\0';
1671 fputs(prompt_str, stdout);
1673 G.user_input_buf[0] = r = fgetc(i->file);
1674 /*G.user_input_buf[1] = '\0'; - already is and never changed */
1675 //do we need check_and_run_traps(0)? (maybe only if stdin)
1676 } while (G.flag_SIGINT);
1677 i->eof_flag = (r == EOF);
1679 i->p = G.user_input_buf;
1682 #endif /* INTERACTIVE */
1684 /* This is the magic location that prints prompts
1685 * and gets data back from the user */
1686 static int FAST_FUNC file_get(struct in_str *i)
1690 /* If there is data waiting, eat it up */
1691 if (i->p && *i->p) {
1692 #if ENABLE_HUSH_INTERACTIVE
1696 if (i->eof_flag && !*i->p)
1698 /* note: ch is never NUL */
1700 /* need to double check i->file because we might be doing something
1701 * more complicated by now, like sourcing or substituting. */
1702 #if ENABLE_HUSH_INTERACTIVE
1703 if (G_interactive_fd && i->promptme && i->file == stdin) {
1706 } while (!*i->p); /* need non-empty line */
1707 i->promptmode = 1; /* PS2 */
1712 do ch = fgetc(i->file); while (ch == '\0');
1714 debug_printf("file_get: got '%c' %d\n", ch, ch);
1715 #if ENABLE_HUSH_INTERACTIVE
1722 /* All callers guarantee this routine will never
1723 * be used right after a newline, so prompting is not needed.
1725 static int FAST_FUNC file_peek(struct in_str *i)
1728 if (i->p && *i->p) {
1729 if (i->eof_flag && !i->p[1])
1732 /* note: ch is never NUL */
1734 do ch = fgetc(i->file); while (ch == '\0');
1735 i->eof_flag = (ch == EOF);
1736 i->peek_buf[0] = ch;
1737 i->peek_buf[1] = '\0';
1739 debug_printf("file_peek: got '%c' %d\n", ch, ch);
1743 static void setup_file_in_str(struct in_str *i, FILE *f)
1745 i->peek = file_peek;
1747 #if ENABLE_HUSH_INTERACTIVE
1749 i->promptmode = 0; /* PS1 */
1755 static void setup_string_in_str(struct in_str *i, const char *s)
1757 i->peek = static_peek;
1758 i->get = static_get;
1759 #if ENABLE_HUSH_INTERACTIVE
1761 i->promptmode = 0; /* PS1 */
1771 #define B_CHUNK (32 * sizeof(char*))
1773 static void o_reset_to_empty_unquoted(o_string *o)
1781 static void o_free(o_string *o)
1784 memset(o, 0, sizeof(*o));
1787 static ALWAYS_INLINE void o_free_unsafe(o_string *o)
1792 static void o_grow_by(o_string *o, int len)
1794 if (o->length + len > o->maxlen) {
1795 o->maxlen += (2*len > B_CHUNK ? 2*len : B_CHUNK);
1796 o->data = xrealloc(o->data, 1 + o->maxlen);
1800 static void o_addchr(o_string *o, int ch)
1802 debug_printf("o_addchr: '%c' o->length=%d o=%p\n", ch, o->length, o);
1804 o->data[o->length] = ch;
1806 o->data[o->length] = '\0';
1809 static void o_addblock(o_string *o, const char *str, int len)
1812 memcpy(&o->data[o->length], str, len);
1814 o->data[o->length] = '\0';
1818 static void o_addstr(o_string *o, const char *str)
1820 o_addblock(o, str, strlen(str));
1822 static void nommu_addchr(o_string *o, int ch)
1828 # define nommu_addchr(o, str) ((void)0)
1831 static void o_addstr_with_NUL(o_string *o, const char *str)
1833 o_addblock(o, str, strlen(str) + 1);
1836 static void o_addblock_duplicate_backslash(o_string *o, const char *str, int len)
1841 && (*str != '*' && *str != '?' && *str != '[')
1849 #undef HUSH_BRACE_EXP
1851 * HUSH_BRACE_EXP code needs corresponding quoting on variable expansion side.
1852 * Currently, "v='{q,w}'; echo $v" erroneously expands braces in $v.
1853 * Apparently, on unquoted $v bash still does globbing
1854 * ("v='*.txt'; echo $v" prints all .txt files),
1855 * but NOT brace expansion! Thus, there should be TWO independent
1856 * quoting mechanisms on $v expansion side: one protects
1857 * $v from brace expansion, and other additionally protects "$v" against globbing.
1858 * We have only second one.
1861 #ifdef HUSH_BRACE_EXP
1862 # define MAYBE_BRACES "{}"
1864 # define MAYBE_BRACES ""
1867 /* My analysis of quoting semantics tells me that state information
1868 * is associated with a destination, not a source.
1870 static void o_addqchr(o_string *o, int ch)
1873 char *found = strchr("*?[\\" MAYBE_BRACES, ch);
1878 o->data[o->length] = '\\';
1881 o->data[o->length] = ch;
1883 o->data[o->length] = '\0';
1886 static void o_addQchr(o_string *o, int ch)
1889 if (o->o_escape && strchr("*?[\\" MAYBE_BRACES, ch)) {
1891 o->data[o->length] = '\\';
1895 o->data[o->length] = ch;
1897 o->data[o->length] = '\0';
1900 static void o_addQstr(o_string *o, const char *str, int len)
1903 o_addblock(o, str, len);
1909 int ordinary_cnt = strcspn(str, "*?[\\" MAYBE_BRACES);
1910 if (ordinary_cnt > len) /* paranoia */
1912 o_addblock(o, str, ordinary_cnt);
1913 if (ordinary_cnt == len)
1915 str += ordinary_cnt;
1916 len -= ordinary_cnt + 1; /* we are processing + 1 char below */
1920 if (ch) { /* it is necessarily one of "*?[\\" MAYBE_BRACES */
1922 o->data[o->length] = '\\';
1926 o->data[o->length] = ch;
1928 o->data[o->length] = '\0';
1932 /* A special kind of o_string for $VAR and `cmd` expansion.
1933 * It contains char* list[] at the beginning, which is grown in 16 element
1934 * increments. Actual string data starts at the next multiple of 16 * (char*).
1935 * list[i] contains an INDEX (int!) into this string data.
1936 * It means that if list[] needs to grow, data needs to be moved higher up
1937 * but list[i]'s need not be modified.
1938 * NB: remembering how many list[i]'s you have there is crucial.
1939 * o_finalize_list() operation post-processes this structure - calculates
1940 * and stores actual char* ptrs in list[]. Oh, it NULL terminates it as well.
1942 #if DEBUG_EXPAND || DEBUG_GLOB
1943 static void debug_print_list(const char *prefix, o_string *o, int n)
1945 char **list = (char**)o->data;
1946 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1950 fprintf(stderr, "%s: list:%p n:%d string_start:%d length:%d maxlen:%d\n",
1951 prefix, list, n, string_start, o->length, o->maxlen);
1954 fprintf(stderr, " list[%d]=%d '%s' %p\n", i, (int)list[i],
1955 o->data + (int)list[i] + string_start,
1956 o->data + (int)list[i] + string_start);
1960 const char *p = o->data + (int)list[n - 1] + string_start;
1962 fprintf(stderr, " total_sz:%ld\n", (long)((p + strlen(p) + 1) - o->data));
1966 # define debug_print_list(prefix, o, n) ((void)0)
1969 /* n = o_save_ptr_helper(str, n) "starts new string" by storing an index value
1970 * in list[n] so that it points past last stored byte so far.
1971 * It returns n+1. */
1972 static int o_save_ptr_helper(o_string *o, int n)
1974 char **list = (char**)o->data;
1978 if (!o->has_empty_slot) {
1979 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1980 string_len = o->length - string_start;
1981 if (!(n & 0xf)) { /* 0, 0x10, 0x20...? */
1982 debug_printf_list("list[%d]=%d string_start=%d (growing)\n", n, string_len, string_start);
1983 /* list[n] points to string_start, make space for 16 more pointers */
1984 o->maxlen += 0x10 * sizeof(list[0]);
1985 o->data = xrealloc(o->data, o->maxlen + 1);
1986 list = (char**)o->data;
1987 memmove(list + n + 0x10, list + n, string_len);
1988 o->length += 0x10 * sizeof(list[0]);
1990 debug_printf_list("list[%d]=%d string_start=%d\n",
1991 n, string_len, string_start);
1994 /* We have empty slot at list[n], reuse without growth */
1995 string_start = ((n+1 + 0xf) & ~0xf) * sizeof(list[0]); /* NB: n+1! */
1996 string_len = o->length - string_start;
1997 debug_printf_list("list[%d]=%d string_start=%d (empty slot)\n",
1998 n, string_len, string_start);
1999 o->has_empty_slot = 0;
2001 list[n] = (char*)(ptrdiff_t)string_len;
2005 /* "What was our last o_save_ptr'ed position (byte offset relative o->data)?" */
2006 static int o_get_last_ptr(o_string *o, int n)
2008 char **list = (char**)o->data;
2009 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2011 return ((int)(ptrdiff_t)list[n-1]) + string_start;
2014 #ifdef HUSH_BRACE_EXP
2015 /* There in a GNU extension, GLOB_BRACE, but it is not usable:
2016 * first, it processes even {a} (no commas), second,
2017 * I didn't manage to make it return strings when they don't match
2018 * existing files. Need to re-implement it.
2022 static int glob_needed(const char *s)
2031 if (*s == '*' || *s == '[' || *s == '?' || *s == '{')
2037 /* Return pointer to next closing brace or to comma */
2038 static const char *next_brace_sub(const char *cp)
2042 while (*cp != '\0') {
2049 /*{*/ if ((*cp == '}' && depth-- == 0) || (*cp == ',' && depth == 0))
2051 if (*cp++ == '{') /*}*/
2055 return *cp != '\0' ? cp : NULL;
2057 /* Recursive brace globber. Note: may garble pattern[]. */
2058 static int glob_brace(char *pattern, o_string *o, int n)
2060 char *new_pattern_buf;
2067 debug_printf_glob("glob_brace('%s')\n", pattern);
2073 if (*begin == '{') /*}*/ {
2074 /* Find the first sub-pattern and at the same time
2075 * find the rest after the closing brace */
2076 next = next_brace_sub(begin);
2078 /* An illegal expression */
2081 /*{*/ if (*next == '}') {
2082 /* "{abc}" with no commas - illegal
2083 * brace expr, disregard and skip it */
2089 if (*begin == '\\' && begin[1] != '\0')
2093 debug_printf_glob("begin:%s\n", begin);
2094 debug_printf_glob("next:%s\n", next);
2096 /* Now find the end of the whole brace expression */
2098 /*{*/ while (*rest != '}') {
2099 rest = next_brace_sub(rest);
2101 /* An illegal expression */
2104 debug_printf_glob("rest:%s\n", rest);
2106 rest_len = strlen(++rest) + 1;
2108 /* We are sure the brace expression is well-formed */
2110 /* Allocate working buffer large enough for our work */
2111 new_pattern_buf = xmalloc(strlen(pattern));
2113 /* We have a brace expression. BEGIN points to the opening {,
2114 * NEXT points past the terminator of the first element, and REST
2115 * points past the final }. We will accumulate result names from
2116 * recursive runs for each brace alternative in the buffer using
2121 /* Construct the new glob expression */
2124 mempcpy(new_pattern_buf,
2125 /* We know the prefix for all sub-patterns */
2126 pattern, begin - pattern),
2130 /* Note: glob_brace() may garble new_pattern_buf[].
2131 * That's why we re-copy prefix every time (1st memcpy above).
2133 n = glob_brace(new_pattern_buf, o, n);
2134 /*{*/ if (*next == '}') {
2135 /* We saw the last entry */
2139 next = next_brace_sub(next);
2141 free(new_pattern_buf);
2149 memset(&globdata, 0, sizeof(globdata));
2150 gr = glob(pattern, 0, NULL, &globdata);
2151 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
2153 if (gr == GLOB_NOMATCH) {
2154 globfree(&globdata);
2155 /* NB: garbles parameter */
2156 unbackslash(pattern);
2157 o_addstr_with_NUL(o, pattern);
2158 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
2159 return o_save_ptr_helper(o, n);
2161 if (gr == GLOB_NOSPACE)
2162 bb_error_msg_and_die(bb_msg_memory_exhausted);
2163 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
2164 * but we didn't specify it. Paranoia again. */
2165 bb_error_msg_and_die("glob error %d on '%s'", gr, pattern);
2167 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
2168 char **argv = globdata.gl_pathv;
2170 o_addstr_with_NUL(o, *argv);
2171 n = o_save_ptr_helper(o, n);
2177 globfree(&globdata);
2181 /* Performs globbing on last list[],
2182 * saving each result as a new list[].
2184 static int o_glob(o_string *o, int n)
2186 char *pattern, *copy;
2188 debug_printf_glob("start o_glob: n:%d o->data:%p\n", n, o->data);
2190 return o_save_ptr_helper(o, n);
2191 pattern = o->data + o_get_last_ptr(o, n);
2192 debug_printf_glob("glob pattern '%s'\n", pattern);
2193 if (!glob_needed(pattern)) {
2194 /* unbackslash last string in o in place, fix length */
2195 o->length = unbackslash(pattern) - o->data;
2196 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
2197 return o_save_ptr_helper(o, n);
2200 copy = xstrdup(pattern);
2201 /* "forget" pattern in o */
2202 o->length = pattern - o->data;
2203 n = glob_brace(copy, o, n);
2206 debug_print_list("o_glob returning", o, n);
2213 static int glob_needed(const char *s)
2222 if (*s == '*' || *s == '[' || *s == '?')
2228 /* Performs globbing on last list[],
2229 * saving each result as a new list[].
2231 static int o_glob(o_string *o, int n)
2237 debug_printf_glob("start o_glob: n:%d o->data:%p\n", n, o->data);
2239 return o_save_ptr_helper(o, n);
2240 pattern = o->data + o_get_last_ptr(o, n);
2241 debug_printf_glob("glob pattern '%s'\n", pattern);
2242 if (!glob_needed(pattern)) {
2244 /* unbackslash last string in o in place, fix length */
2245 o->length = unbackslash(pattern) - o->data;
2246 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
2247 return o_save_ptr_helper(o, n);
2250 memset(&globdata, 0, sizeof(globdata));
2251 /* Can't use GLOB_NOCHECK: it does not unescape the string.
2252 * If we glob "*.\*" and don't find anything, we need
2253 * to fall back to using literal "*.*", but GLOB_NOCHECK
2254 * will return "*.\*"!
2256 gr = glob(pattern, 0, NULL, &globdata);
2257 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
2259 if (gr == GLOB_NOMATCH) {
2260 globfree(&globdata);
2263 if (gr == GLOB_NOSPACE)
2264 bb_error_msg_and_die(bb_msg_memory_exhausted);
2265 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
2266 * but we didn't specify it. Paranoia again. */
2267 bb_error_msg_and_die("glob error %d on '%s'", gr, pattern);
2269 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
2270 char **argv = globdata.gl_pathv;
2271 /* "forget" pattern in o */
2272 o->length = pattern - o->data;
2274 o_addstr_with_NUL(o, *argv);
2275 n = o_save_ptr_helper(o, n);
2281 globfree(&globdata);
2283 debug_print_list("o_glob returning", o, n);
2289 /* If o->o_glob == 1, glob the string so far remembered.
2290 * Otherwise, just finish current list[] and start new */
2291 static int o_save_ptr(o_string *o, int n)
2293 if (o->o_glob) { /* if globbing is requested */
2294 /* If o->has_empty_slot, list[n] was already globbed
2295 * (if it was requested back then when it was filled)
2296 * so don't do that again! */
2297 if (!o->has_empty_slot)
2298 return o_glob(o, n); /* o_save_ptr_helper is inside */
2300 return o_save_ptr_helper(o, n);
2303 /* "Please convert list[n] to real char* ptrs, and NULL terminate it." */
2304 static char **o_finalize_list(o_string *o, int n)
2309 n = o_save_ptr(o, n); /* force growth for list[n] if necessary */
2311 debug_print_list("finalized", o, n);
2312 debug_printf_expand("finalized n:%d\n", n);
2313 list = (char**)o->data;
2314 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2318 list[n] = o->data + (int)(ptrdiff_t)list[n] + string_start;
2324 /* Expansion can recurse */
2325 #if ENABLE_HUSH_TICK
2326 static int process_command_subs(o_string *dest, const char *s);
2328 static char *expand_string_to_string(const char *str);
2330 #define parse_stream_dquoted(as_string, dest, input, dquote_end) \
2331 parse_stream_dquoted(dest, input, dquote_end)
2333 static int parse_stream_dquoted(o_string *as_string,
2335 struct in_str *input,
2338 /* expand_strvec_to_strvec() takes a list of strings, expands
2339 * all variable references within and returns a pointer to
2340 * a list of expanded strings, possibly with larger number
2341 * of strings. (Think VAR="a b"; echo $VAR).
2342 * This new list is allocated as a single malloc block.
2343 * NULL-terminated list of char* pointers is at the beginning of it,
2344 * followed by strings themself.
2345 * Caller can deallocate entire list by single free(list). */
2347 /* Store given string, finalizing the word and starting new one whenever
2348 * we encounter IFS char(s). This is used for expanding variable values.
2349 * End-of-string does NOT finalize word: think about 'echo -$VAR-' */
2350 static int expand_on_ifs(o_string *output, int n, const char *str)
2353 int word_len = strcspn(str, G.ifs);
2355 if (output->o_escape || !output->o_glob)
2356 o_addQstr(output, str, word_len);
2357 else /* protect backslashes against globbing up :) */
2358 o_addblock_duplicate_backslash(output, str, word_len);
2361 if (!*str) /* EOL - do not finalize word */
2363 o_addchr(output, '\0');
2364 debug_print_list("expand_on_ifs", output, n);
2365 n = o_save_ptr(output, n);
2366 str += strspn(str, G.ifs); /* skip ifs chars */
2368 debug_print_list("expand_on_ifs[1]", output, n);
2372 /* Helper to expand $((...)) and heredoc body. These act as if
2373 * they are in double quotes, with the exception that they are not :).
2374 * Just the rules are similar: "expand only $var and `cmd`"
2376 * Returns malloced string.
2377 * As an optimization, we return NULL if expansion is not needed.
2379 static char *expand_pseudo_dquoted(const char *str)
2382 struct in_str input;
2383 o_string dest = NULL_O_STRING;
2385 if (strchr(str, '$') == NULL
2386 #if ENABLE_HUSH_TICK
2387 && strchr(str, '`') == NULL
2393 /* We need to expand. Example:
2394 * echo $(($a + `echo 1`)) $((1 + $((2)) ))
2396 setup_string_in_str(&input, str);
2397 parse_stream_dquoted(NULL, &dest, &input, EOF);
2398 //bb_error_msg("'%s' -> '%s'", str, dest.data);
2399 exp_str = expand_string_to_string(dest.data);
2400 //bb_error_msg("'%s' -> '%s'", dest.data, exp_str);
2401 o_free_unsafe(&dest);
2405 /* Expand all variable references in given string, adding words to list[]
2406 * at n, n+1,... positions. Return updated n (so that list[n] is next one
2407 * to be filled). This routine is extremely tricky: has to deal with
2408 * variables/parameters with whitespace, $* and $@, and constructs like
2409 * 'echo -$*-'. If you play here, you must run testsuite afterwards! */
2410 static NOINLINE int expand_vars_to_list(o_string *output, int n, char *arg, char or_mask)
2412 /* or_mask is either 0 (normal case) or 0x80 -
2413 * expansion of right-hand side of assignment == 1-element expand.
2414 * It will also do no globbing, and thus we must not backslash-quote!
2421 debug_printf_expand("expand_vars_to_list: arg:'%s' or_mask:%x\n", arg, or_mask);
2422 debug_print_list("expand_vars_to_list", output, n);
2423 n = o_save_ptr(output, n);
2424 debug_print_list("expand_vars_to_list[0]", output, n);
2426 while ((p = strchr(arg, SPECIAL_VAR_SYMBOL)) != NULL) {
2429 char *dyn_val = NULL;
2430 const char *val = NULL;
2431 #if ENABLE_HUSH_TICK
2432 o_string subst_result = NULL_O_STRING;
2434 #if ENABLE_SH_MATH_SUPPORT
2435 char arith_buf[sizeof(arith_t)*3 + 2];
2437 o_addblock(output, arg, p - arg);
2438 debug_print_list("expand_vars_to_list[1]", output, n);
2440 p = strchr(p, SPECIAL_VAR_SYMBOL);
2442 first_ch = arg[0] | or_mask; /* forced to "quoted" if or_mask = 0x80 */
2443 /* "$@" is special. Even if quoted, it can still
2444 * expand to nothing (not even an empty string) */
2445 if ((first_ch & 0x7f) != '@')
2446 ored_ch |= first_ch;
2448 switch (first_ch & 0x7f) {
2449 /* Highest bit in first_ch indicates that var is double-quoted */
2451 val = utoa(G.root_pid);
2453 case '!': /* bg pid */
2454 val = G.last_bg_pid ? utoa(G.last_bg_pid) : (char*)"";
2456 case '?': /* exitcode */
2457 val = utoa(G.last_exitcode);
2459 case '#': /* argc */
2460 if (arg[1] != SPECIAL_VAR_SYMBOL)
2461 /* actually, it's a ${#var} */
2463 val = utoa(G.global_argc ? G.global_argc-1 : 0);
2468 if (!G.global_argv[i])
2470 ored_ch |= first_ch; /* do it for "$@" _now_, when we know it's not empty */
2471 if (!(first_ch & 0x80)) { /* unquoted $* or $@ */
2472 smallint sv = output->o_escape;
2473 /* unquoted var's contents should be globbed, so don't escape */
2474 output->o_escape = 0;
2475 while (G.global_argv[i]) {
2476 n = expand_on_ifs(output, n, G.global_argv[i]);
2477 debug_printf_expand("expand_vars_to_list: argv %d (last %d)\n", i, G.global_argc - 1);
2478 if (G.global_argv[i++][0] && G.global_argv[i]) {
2479 /* this argv[] is not empty and not last:
2480 * put terminating NUL, start new word */
2481 o_addchr(output, '\0');
2482 debug_print_list("expand_vars_to_list[2]", output, n);
2483 n = o_save_ptr(output, n);
2484 debug_print_list("expand_vars_to_list[3]", output, n);
2487 output->o_escape = sv;
2489 /* If or_mask is nonzero, we handle assignment 'a=....$@.....'
2490 * and in this case should treat it like '$*' - see 'else...' below */
2491 if (first_ch == ('@'|0x80) && !or_mask) { /* quoted $@ */
2493 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
2494 if (++i >= G.global_argc)
2496 o_addchr(output, '\0');
2497 debug_print_list("expand_vars_to_list[4]", output, n);
2498 n = o_save_ptr(output, n);
2500 } else { /* quoted $*: add as one word */
2502 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
2503 if (!G.global_argv[++i])
2506 o_addchr(output, G.ifs[0]);
2510 case SPECIAL_VAR_SYMBOL: /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_SYMBOL> */
2511 /* "Empty variable", used to make "" etc to not disappear */
2515 #if ENABLE_HUSH_TICK
2516 case '`': /* <SPECIAL_VAR_SYMBOL>`cmd<SPECIAL_VAR_SYMBOL> */
2519 /* Can't just stuff it into output o_string,
2520 * expanded result may need to be globbed
2521 * and $IFS-splitted */
2522 debug_printf_subst("SUBST '%s' first_ch %x\n", arg, first_ch);
2523 G.last_exitcode = process_command_subs(&subst_result, arg);
2524 debug_printf_subst("SUBST RES '%s'\n", subst_result.data);
2525 val = subst_result.data;
2528 #if ENABLE_SH_MATH_SUPPORT
2529 case '+': { /* <SPECIAL_VAR_SYMBOL>+cmd<SPECIAL_VAR_SYMBOL> */
2530 arith_eval_hooks_t hooks;
2535 arg++; /* skip '+' */
2536 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
2537 debug_printf_subst("ARITH '%s' first_ch %x\n", arg, first_ch);
2539 exp_str = expand_pseudo_dquoted(arg);
2540 hooks.lookupvar = get_local_var_value;
2541 hooks.setvar = arith_set_local_var;
2542 hooks.endofname = endofname;
2543 res = arith(exp_str ? exp_str : arg, &errcode, &hooks);
2547 const char *msg = "error in arithmetic";
2550 msg = "exponent less than 0";
2553 msg = "divide by 0";
2556 msg = "expression recursion loop detected";
2561 debug_printf_subst("ARITH RES '"arith_t_fmt"'\n", res);
2562 sprintf(arith_buf, arith_t_fmt, res);
2567 default: /* <SPECIAL_VAR_SYMBOL>varname<SPECIAL_VAR_SYMBOL> */
2569 bool exp_len = false;
2570 bool exp_null = false;
2572 char exp_save = exp_save; /* for compiler */
2573 char exp_op = exp_op; /* for compiler */
2574 char *exp_word = exp_word; /* for compiler */
2578 arg[0] = first_ch & 0x7f;
2580 /* prepare for expansions */
2581 if (var[0] == '#') {
2582 /* handle length expansion ${#var} */
2586 /* maybe handle parameter expansion */
2587 exp_off = strcspn(var, ":-=+?%#");
2591 exp_save = var[exp_off];
2592 exp_null = exp_save == ':';
2593 exp_word = var + exp_off;
2596 exp_op = *exp_word++;
2597 var[exp_off] = '\0';
2601 /* lookup the variable in question */
2602 if (isdigit(var[0])) {
2603 /* handle_dollar() should have vetted var for us */
2605 if (i < G.global_argc)
2606 val = G.global_argv[i];
2607 /* else val remains NULL: $N with too big N */
2609 val = get_local_var_value(var);
2611 /* handle any expansions */
2613 debug_printf_expand("expand: length of '%s' = ", val);
2614 val = utoa(val ? strlen(val) : 0);
2615 debug_printf_expand("%s\n", val);
2616 } else if (exp_off) {
2617 if (exp_op == '%' || exp_op == '#') {
2619 /* we need to do a pattern match */
2622 scan_t scan = pick_scan(exp_op, *exp_word, &match_at_left);
2623 if (exp_op == *exp_word) /* ## or %% */
2625 val = dyn_val = xstrdup(val);
2626 loc = scan(dyn_val, exp_word, match_at_left);
2627 if (match_at_left) /* # or ## */
2629 else if (loc) /* % or %% and match was found */
2633 /* we need to do an expansion */
2634 int exp_test = (!val || (exp_null && !val[0]));
2636 exp_test = !exp_test;
2637 debug_printf_expand("expand: op:%c (null:%s) test:%i\n", exp_op,
2638 exp_null ? "true" : "false", exp_test);
2640 if (exp_op == '?') {
2641 //TODO: how interactive bash aborts expansion mid-command?
2642 /* ${var?[error_msg_if_unset]} */
2643 /* ${var:?[error_msg_if_unset_or_null]} */
2644 /* mimic bash message */
2645 die_if_script("%s: %s",
2647 exp_word[0] ? exp_word : "parameter null or not set"
2653 if (exp_op == '=') {
2654 /* ${var=[word]} or ${var:=[word]} */
2655 if (isdigit(var[0]) || var[0] == '#') {
2656 /* mimic bash message */
2657 die_if_script("$%s: cannot assign in this way", var);
2660 char *new_var = xasprintf("%s=%s", var, val);
2661 set_local_var(new_var, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
2667 var[exp_off] = exp_save;
2671 #if ENABLE_HUSH_TICK
2674 if (!(first_ch & 0x80)) { /* unquoted $VAR */
2675 debug_printf_expand("unquoted '%s', output->o_escape:%d\n", val, output->o_escape);
2677 /* unquoted var's contents should be globbed, so don't escape */
2678 smallint sv = output->o_escape;
2679 output->o_escape = 0;
2680 n = expand_on_ifs(output, n, val);
2682 output->o_escape = sv;
2684 } else { /* quoted $VAR, val will be appended below */
2685 debug_printf_expand("quoted '%s', output->o_escape:%d\n", val, output->o_escape);
2688 } /* switch (char after <SPECIAL_VAR_SYMBOL>) */
2691 o_addQstr(output, val, strlen(val));
2694 /* Do the check to avoid writing to a const string */
2695 if (*p != SPECIAL_VAR_SYMBOL)
2696 *p = SPECIAL_VAR_SYMBOL;
2698 #if ENABLE_HUSH_TICK
2699 o_free(&subst_result);
2702 } /* end of "while (SPECIAL_VAR_SYMBOL is found) ..." */
2705 debug_print_list("expand_vars_to_list[a]", output, n);
2706 /* this part is literal, and it was already pre-quoted
2707 * if needed (much earlier), do not use o_addQstr here! */
2708 o_addstr_with_NUL(output, arg);
2709 debug_print_list("expand_vars_to_list[b]", output, n);
2710 } else if (output->length == o_get_last_ptr(output, n) /* expansion is empty */
2711 && !(ored_ch & 0x80) /* and all vars were not quoted. */
2714 /* allow to reuse list[n] later without re-growth */
2715 output->has_empty_slot = 1;
2717 o_addchr(output, '\0');
2722 static char **expand_variables(char **argv, int or_mask)
2727 o_string output = NULL_O_STRING;
2729 if (or_mask & 0x100) {
2730 output.o_escape = 1; /* protect against globbing for "$var" */
2731 /* (unquoted $var will temporarily switch it off) */
2738 n = expand_vars_to_list(&output, n, *v, (unsigned char)or_mask);
2741 debug_print_list("expand_variables", &output, n);
2743 /* output.data (malloced in one block) gets returned in "list" */
2744 list = o_finalize_list(&output, n);
2745 debug_print_strings("expand_variables[1]", list);
2749 static char **expand_strvec_to_strvec(char **argv)
2751 return expand_variables(argv, 0x100);
2754 #if ENABLE_HUSH_BASH_COMPAT
2755 static char **expand_strvec_to_strvec_singleword_noglob(char **argv)
2757 return expand_variables(argv, 0x80);
2761 #ifdef CMD_SINGLEWORD_NOGLOB_COND
2762 static char **expand_strvec_to_strvec_singleword_noglob_cond(char **argv)
2767 o_string output = NULL_O_STRING;
2772 int is_var = is_well_formed_var_name(*v, '=');
2773 /* is_var * 0x80: singleword expansion for vars */
2774 n = expand_vars_to_list(&output, n, *v, is_var * 0x80);
2776 /* Subtle! expand_vars_to_list did not glob last word yet.
2777 * It does this only when fed with further data.
2778 * Therefore we set globbing flags AFTER it, not before:
2781 /* if it is not recognizably abc=...; then: */
2782 output.o_escape = !is_var; /* protect against globbing for "$var" */
2783 /* (unquoted $var will temporarily switch it off) */
2784 output.o_glob = !is_var; /* and indeed do globbing */
2787 debug_print_list("expand_cond", &output, n);
2789 /* output.data (malloced in one block) gets returned in "list" */
2790 list = o_finalize_list(&output, n);
2791 debug_print_strings("expand_cond[1]", list);
2796 /* Used for expansion of right hand of assignments */
2797 /* NB: should NOT do globbing! "export v=/bin/c*; env | grep ^v=" outputs
2799 static char *expand_string_to_string(const char *str)
2801 char *argv[2], **list;
2803 argv[0] = (char*)str;
2805 list = expand_variables(argv, 0x80); /* 0x80: singleword expansion */
2807 if (!list[0] || list[1])
2808 bb_error_msg_and_die("BUG in varexp2");
2809 /* actually, just move string 2*sizeof(char*) bytes back */
2810 overlapping_strcpy((char*)list, list[0]);
2811 unbackslash((char*)list);
2812 debug_printf_expand("string_to_string='%s'\n", (char*)list);
2816 /* Used for "eval" builtin */
2817 static char* expand_strvec_to_string(char **argv)
2821 list = expand_variables(argv, 0x80);
2822 /* Convert all NULs to spaces */
2827 if (list[n-1] + strlen(list[n-1]) + 1 != list[n])
2828 bb_error_msg_and_die("BUG in varexp3");
2829 /* bash uses ' ' regardless of $IFS contents */
2834 overlapping_strcpy((char*)list, list[0]);
2835 debug_printf_expand("strvec_to_string='%s'\n", (char*)list);
2839 static char **expand_assignments(char **argv, int count)
2843 /* Expand assignments into one string each */
2844 for (i = 0; i < count; i++) {
2845 p = add_string_to_strings(p, expand_string_to_string(argv[i]));
2853 void re_execute_shell(char ***to_free, const char *s,
2854 char *g_argv0, char **g_argv,
2855 char **builtin_argv) NORETURN;
2857 static void reset_traps_to_defaults(void)
2859 /* This function is always called in a child shell
2860 * after fork (not vfork, NOMMU doesn't use this function).
2865 /* Child shells are not interactive.
2866 * SIGTTIN/SIGTTOU/SIGTSTP should not have special handling.
2867 * Testcase: (while :; do :; done) + ^Z should background.
2868 * Same goes for SIGTERM, SIGHUP, SIGINT.
2870 if (!G.traps && !(G.non_DFL_mask & SPECIAL_INTERACTIVE_SIGS))
2871 return; /* already no traps and no SPECIAL_INTERACTIVE_SIGS */
2873 /* Switching off SPECIAL_INTERACTIVE_SIGS.
2874 * Stupid. It can be done with *single* &= op, but we can't use
2875 * the fact that G.blocked_set is implemented as a bitmask
2877 mask = (SPECIAL_INTERACTIVE_SIGS >> 1);
2881 /* Careful. Only if no trap or trap is not "" */
2882 if (!G.traps || !G.traps[sig] || G.traps[sig][0])
2883 sigdelset(&G.blocked_set, sig);
2890 /* Our homegrown sig mask is saner to work with :) */
2891 G.non_DFL_mask &= ~SPECIAL_INTERACTIVE_SIGS;
2893 /* Resetting all traps to default except empty ones */
2894 mask = G.non_DFL_mask;
2895 if (G.traps) for (sig = 0; sig < NSIG; sig++, mask >>= 1) {
2896 if (!G.traps[sig] || !G.traps[sig][0])
2899 G.traps[sig] = NULL;
2900 /* There is no signal for 0 (EXIT) */
2903 /* There was a trap handler, we just removed it.
2904 * But if sig still has non-DFL handling,
2905 * we should not unblock the sig. */
2908 sigdelset(&G.blocked_set, sig);
2910 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
2915 static void re_execute_shell(char ***to_free, const char *s,
2916 char *g_argv0, char **g_argv,
2917 char **builtin_argv) NORETURN;
2918 static void re_execute_shell(char ***to_free, const char *s,
2919 char *g_argv0, char **g_argv,
2920 char **builtin_argv)
2922 char param_buf[sizeof("-$%x:%x:%x:%x:%x") + sizeof(unsigned) * 2];
2923 char *heredoc_argv[4];
2924 struct variable *cur;
2925 # if ENABLE_HUSH_FUNCTIONS
2926 struct function *funcp;
2930 unsigned long long empty_trap_mask;
2932 if (!g_argv0) { /* heredoc */
2933 argv = heredoc_argv;
2934 argv[0] = (char *) G.argv0_for_re_execing;
2935 argv[1] = (char *) "-<";
2936 argv[2] = (char *) s;
2938 pp = &argv[3]; /* used as pointer to empty environment */
2944 if (pp) while (*pp++)
2947 empty_trap_mask = 0;
2950 for (sig = 1; sig < NSIG; sig++) {
2951 if (G.traps[sig] && !G.traps[sig][0])
2952 empty_trap_mask |= 1LL << sig;
2956 sprintf(param_buf, "-$%x:%x:%x:%x:%x:%llx" IF_HUSH_LOOPS(":%x")
2957 , (unsigned) G.root_pid
2958 , (unsigned) G.root_ppid
2959 , (unsigned) G.last_bg_pid
2960 , (unsigned) G.last_exitcode
2963 IF_HUSH_LOOPS(, G.depth_of_loop)
2965 /* 1:hush 2:-$<pid>:<pid>:<exitcode>:<depth> <vars...> <funcs...>
2966 * 3:-c 4:<cmd> 5:<arg0> <argN...> 6:NULL
2969 for (cur = G.top_var; cur; cur = cur->next) {
2970 if (!cur->flg_export || cur->flg_read_only)
2973 # if ENABLE_HUSH_FUNCTIONS
2974 for (funcp = G.top_func; funcp; funcp = funcp->next)
2980 *to_free = argv = pp = xzalloc(sizeof(argv[0]) * cnt);
2981 *pp++ = (char *) G.argv0_for_re_execing;
2983 for (cur = G.top_var; cur; cur = cur->next) {
2984 if (cur->varstr == hush_version_str)
2986 if (cur->flg_read_only) {
2987 *pp++ = (char *) "-R";
2988 *pp++ = cur->varstr;
2989 } else if (!cur->flg_export) {
2990 *pp++ = (char *) "-V";
2991 *pp++ = cur->varstr;
2994 # if ENABLE_HUSH_FUNCTIONS
2995 for (funcp = G.top_func; funcp; funcp = funcp->next) {
2996 *pp++ = (char *) "-F";
2997 *pp++ = funcp->name;
2998 *pp++ = funcp->body_as_string;
3001 /* We can pass activated traps here. Say, -Tnn:trap_string
3003 * However, POSIX says that subshells reset signals with traps
3005 * I tested bash-3.2 and it not only does that with true subshells
3006 * of the form ( list ), but with any forked children shells.
3007 * I set trap "echo W" WINCH; and then tried:
3009 * { echo 1; sleep 20; echo 2; } &
3010 * while true; do echo 1; sleep 20; echo 2; break; done &
3011 * true | { echo 1; sleep 20; echo 2; } | cat
3013 * In all these cases sending SIGWINCH to the child shell
3014 * did not run the trap. If I add trap "echo V" WINCH;
3015 * _inside_ group (just before echo 1), it works.
3017 * I conclude it means we don't need to pass active traps here.
3018 * Even if we would use signal handlers instead of signal masking
3019 * in order to implement trap handling,
3020 * exec syscall below resets signals to SIG_DFL for us.
3022 *pp++ = (char *) "-c";
3025 while (*++builtin_argv)
3026 *pp++ = *builtin_argv;
3027 *pp++ = (char *) "";
3032 /* *pp = NULL; - is already there */
3036 debug_printf_exec("re_execute_shell pid:%d cmd:'%s'\n", getpid(), s);
3037 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
3038 execve(bb_busybox_exec_path, argv, pp);
3039 /* Fallback. Useful for init=/bin/hush usage etc */
3040 if (argv[0][0] == '/')
3041 execve(argv[0], argv, pp);
3042 xfunc_error_retval = 127;
3043 bb_error_msg_and_die("can't re-execute the shell");
3045 #endif /* !BB_MMU */
3048 static void setup_heredoc(struct redir_struct *redir)
3050 struct fd_pair pair;
3053 /* the _body_ of heredoc (misleading field name) */
3054 const char *heredoc = redir->rd_filename;
3061 if (!(redir->rd_dup & HEREDOC_QUOTED)) {
3062 expanded = expand_pseudo_dquoted(heredoc);
3066 len = strlen(heredoc);
3068 close(redir->rd_fd); /* often saves dup2+close in xmove_fd */
3070 xmove_fd(pair.rd, redir->rd_fd);
3072 /* Try writing without forking. Newer kernels have
3073 * dynamically growing pipes. Must use non-blocking write! */
3076 written = write(pair.wr, heredoc, len);
3087 ndelay_off(pair.wr);
3089 /* Okay, pipe buffer was not big enough */
3090 /* Note: we must not create a stray child (bastard? :)
3091 * for the unsuspecting parent process. Child creates a grandchild
3092 * and exits before parent execs the process which consumes heredoc
3093 * (that exec happens after we return from this function) */
3099 bb_perror_msg_and_die("vfork");
3102 disable_restore_tty_pgrp_on_exit();
3103 pid = BB_MMU ? fork() : vfork();
3105 bb_perror_msg_and_die(BB_MMU ? "fork" : "vfork");
3109 close(redir->rd_fd); /* read side of the pipe */
3111 full_write(pair.wr, heredoc, len); /* may loop or block */
3114 /* Delegate blocking writes to another process */
3115 xmove_fd(pair.wr, STDOUT_FILENO);
3116 re_execute_shell(&to_free, heredoc, NULL, NULL, NULL);
3120 #if ENABLE_HUSH_FAST
3122 //bb_error_msg("[%d] fork in setup_heredoc: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
3124 enable_restore_tty_pgrp_on_exit();
3130 wait(NULL); /* wait till child has died */
3133 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
3134 * and stderr if they are redirected. */
3135 static int setup_redirects(struct command *prog, int squirrel[])
3138 struct redir_struct *redir;
3140 for (redir = prog->redirects; redir; redir = redir->next) {
3141 if (redir->rd_type == REDIRECT_HEREDOC2) {
3142 /* rd_fd<<HERE case */
3143 if (squirrel && redir->rd_fd < 3
3144 && squirrel[redir->rd_fd] < 0
3146 squirrel[redir->rd_fd] = dup(redir->rd_fd);
3148 /* for REDIRECT_HEREDOC2, rd_filename holds _contents_
3150 debug_printf_parse("set heredoc '%s'\n",
3151 redir->rd_filename);
3152 setup_heredoc(redir);
3156 if (redir->rd_dup == REDIRFD_TO_FILE) {
3157 /* rd_fd<*>file case (<*> is <,>,>>,<>) */
3159 if (redir->rd_filename == NULL) {
3160 /* Something went wrong in the parse.
3161 * Pretend it didn't happen */
3162 bb_error_msg("bug in redirect parse");
3165 mode = redir_table[redir->rd_type].mode;
3166 p = expand_string_to_string(redir->rd_filename);
3167 openfd = open_or_warn(p, mode);
3170 /* this could get lost if stderr has been redirected, but
3171 * bash and ash both lose it as well (though zsh doesn't!) */
3172 //what the above comment tries to say?
3176 /* rd_fd<*>rd_dup or rd_fd<*>- cases */
3177 openfd = redir->rd_dup;
3180 if (openfd != redir->rd_fd) {
3181 if (squirrel && redir->rd_fd < 3
3182 && squirrel[redir->rd_fd] < 0
3184 squirrel[redir->rd_fd] = dup(redir->rd_fd);
3186 if (openfd == REDIRFD_CLOSE) {
3187 /* "n>-" means "close me" */
3188 close(redir->rd_fd);
3190 xdup2(openfd, redir->rd_fd);
3191 if (redir->rd_dup == REDIRFD_TO_FILE)
3199 static void restore_redirects(int squirrel[])
3202 for (i = 0; i < 3; i++) {
3205 /* We simply die on error */
3212 static void free_pipe_list(struct pipe *head);
3214 /* Return code is the exit status of the pipe */
3215 static void free_pipe(struct pipe *pi)
3218 struct command *command;
3219 struct redir_struct *r, *rnext;
3222 if (pi->stopped_cmds > 0) /* why? */
3224 debug_printf_clean("run pipe: (pid %d)\n", getpid());
3225 for (i = 0; i < pi->num_cmds; i++) {
3226 command = &pi->cmds[i];
3227 debug_printf_clean(" command %d:\n", i);
3228 if (command->argv) {
3229 for (a = 0, p = command->argv; *p; a++, p++) {
3230 debug_printf_clean(" argv[%d] = %s\n", a, *p);
3232 free_strings(command->argv);
3233 command->argv = NULL;
3235 /* not "else if": on syntax error, we may have both! */
3236 if (command->group) {
3237 debug_printf_clean(" begin group (cmd_type:%d)\n",
3239 free_pipe_list(command->group);
3240 debug_printf_clean(" end group\n");
3241 command->group = NULL;
3243 /* else is crucial here.
3244 * If group != NULL, child_func is meaningless */
3245 #if ENABLE_HUSH_FUNCTIONS
3246 else if (command->child_func) {
3247 debug_printf_exec("cmd %p releases child func at %p\n", command, command->child_func);
3248 command->child_func->parent_cmd = NULL;
3252 free(command->group_as_string);
3253 command->group_as_string = NULL;
3255 for (r = command->redirects; r; r = rnext) {
3256 debug_printf_clean(" redirect %d%s",
3257 r->rd_fd, redir_table[r->rd_type].descrip);
3258 /* guard against the case >$FOO, where foo is unset or blank */
3259 if (r->rd_filename) {
3260 debug_printf_clean(" fname:'%s'\n", r->rd_filename);
3261 free(r->rd_filename);
3262 r->rd_filename = NULL;
3264 debug_printf_clean(" rd_dup:%d\n", r->rd_dup);
3268 command->redirects = NULL;
3270 free(pi->cmds); /* children are an array, they get freed all at once */
3278 static void free_pipe_list(struct pipe *head)
3280 struct pipe *pi, *next;
3282 for (pi = head; pi; pi = next) {
3284 debug_printf_clean(" pipe reserved word %d\n", pi->res_word);
3287 debug_printf_clean("pipe followup code %d\n", pi->followup);
3289 /*pi->next = NULL;*/
3295 static int run_list(struct pipe *pi);
3297 #define parse_stream(pstring, input, end_trigger) \
3298 parse_stream(input, end_trigger)
3300 static struct pipe *parse_stream(char **pstring,
3301 struct in_str *input,
3303 static void parse_and_run_string(const char *s);
3306 static char *find_in_path(const char *arg)
3309 const char *PATH = get_local_var_value("PATH");
3315 const char *end = strchrnul(PATH, ':');
3316 int sz = end - PATH; /* must be int! */
3320 ret = xasprintf("%.*s/%s", sz, PATH, arg);
3322 /* We have xxx::yyyy in $PATH,
3323 * it means "use current dir" */
3326 if (access(ret, F_OK) == 0)
3339 static const struct built_in_command* find_builtin_helper(const char *name,
3340 const struct built_in_command *x,
3341 const struct built_in_command *end)
3344 if (strcmp(name, x->cmd) != 0) {
3348 debug_printf_exec("found builtin '%s'\n", name);
3353 static const struct built_in_command* find_builtin1(const char *name)
3355 return find_builtin_helper(name, bltins1, &bltins1[ARRAY_SIZE(bltins1)]);
3357 static const struct built_in_command* find_builtin(const char *name)
3359 const struct built_in_command *x = find_builtin1(name);
3362 return find_builtin_helper(name, bltins2, &bltins2[ARRAY_SIZE(bltins2)]);
3365 #if ENABLE_HUSH_FUNCTIONS
3366 static struct function **find_function_slot(const char *name)
3368 struct function **funcpp = &G.top_func;
3370 if (strcmp(name, (*funcpp)->name) == 0) {
3373 funcpp = &(*funcpp)->next;
3378 static const struct function *find_function(const char *name)
3380 const struct function *funcp = *find_function_slot(name);
3382 debug_printf_exec("found function '%s'\n", name);
3386 /* Note: takes ownership on name ptr */
3387 static struct function *new_function(char *name)
3389 struct function **funcpp = find_function_slot(name);
3390 struct function *funcp = *funcpp;
3392 if (funcp != NULL) {
3393 struct command *cmd = funcp->parent_cmd;
3394 debug_printf_exec("func %p parent_cmd %p\n", funcp, cmd);
3396 debug_printf_exec("freeing & replacing function '%s'\n", funcp->name);
3398 /* Note: if !funcp->body, do not free body_as_string!
3399 * This is a special case of "-F name body" function:
3400 * body_as_string was not malloced! */
3402 free_pipe_list(funcp->body);
3404 free(funcp->body_as_string);
3408 debug_printf_exec("reinserting in tree & replacing function '%s'\n", funcp->name);
3409 cmd->argv[0] = funcp->name;
3410 cmd->group = funcp->body;
3412 cmd->group_as_string = funcp->body_as_string;
3416 debug_printf_exec("remembering new function '%s'\n", name);
3417 funcp = *funcpp = xzalloc(sizeof(*funcp));
3418 /*funcp->next = NULL;*/
3425 static void unset_func(const char *name)
3427 struct function **funcpp = find_function_slot(name);
3428 struct function *funcp = *funcpp;
3430 if (funcp != NULL) {
3431 debug_printf_exec("freeing function '%s'\n", funcp->name);
3432 *funcpp = funcp->next;
3433 /* funcp is unlinked now, deleting it.
3434 * Note: if !funcp->body, the function was created by
3435 * "-F name body", do not free ->body_as_string
3436 * and ->name as they were not malloced. */
3438 free_pipe_list(funcp->body);
3441 free(funcp->body_as_string);
3449 #define exec_function(to_free, funcp, argv) \
3450 exec_function(funcp, argv)
3452 static void exec_function(char ***to_free,
3453 const struct function *funcp,
3454 char **argv) NORETURN;
3455 static void exec_function(char ***to_free,
3456 const struct function *funcp,
3462 argv[0] = G.global_argv[0];
3463 G.global_argv = argv;
3467 /* On MMU, funcp->body is always non-NULL */
3468 n = run_list(funcp->body);
3472 re_execute_shell(to_free,
3473 funcp->body_as_string,
3480 static int run_function(const struct function *funcp, char **argv)
3486 save_and_replace_G_args(&sv, argv);
3488 /* "we are in function, ok to use return" */
3489 sv_flg = G.flag_return_in_progress;
3490 G.flag_return_in_progress = -1;
3491 # if ENABLE_HUSH_LOCAL
3492 G.func_nest_level++;
3495 /* On MMU, funcp->body is always non-NULL */
3498 /* Function defined by -F */
3499 parse_and_run_string(funcp->body_as_string);
3500 rc = G.last_exitcode;
3504 rc = run_list(funcp->body);
3507 # if ENABLE_HUSH_LOCAL
3509 struct variable *var;
3510 struct variable **var_pp;
3512 var_pp = &G.top_var;
3513 while ((var = *var_pp) != NULL) {
3514 if (var->func_nest_level < G.func_nest_level) {
3515 var_pp = &var->next;
3519 if (var->flg_export)
3520 bb_unsetenv(var->varstr);
3521 /* Remove from global list */
3522 *var_pp = var->next;
3528 G.func_nest_level--;
3531 G.flag_return_in_progress = sv_flg;
3533 restore_G_args(&sv, argv);
3537 #endif /* ENABLE_HUSH_FUNCTIONS */
3541 #define exec_builtin(to_free, x, argv) \
3542 exec_builtin(x, argv)
3544 #define exec_builtin(to_free, x, argv) \
3545 exec_builtin(to_free, argv)
3547 static void exec_builtin(char ***to_free,
3548 const struct built_in_command *x,
3549 char **argv) NORETURN;
3550 static void exec_builtin(char ***to_free,
3551 const struct built_in_command *x,
3555 int rcode = x->function(argv);
3559 /* On NOMMU, we must never block!
3560 * Example: { sleep 99 | read line; } & echo Ok
3562 re_execute_shell(to_free,
3571 static void execvp_or_die(char **argv) NORETURN;
3572 static void execvp_or_die(char **argv)
3574 debug_printf_exec("execing '%s'\n", argv[0]);
3575 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
3576 execvp(argv[0], argv);
3577 bb_perror_msg("can't execute '%s'", argv[0]);
3578 _exit(127); /* bash compat */
3582 #define pseudo_exec_argv(nommu_save, argv, assignment_cnt, argv_expanded) \
3583 pseudo_exec_argv(argv, assignment_cnt, argv_expanded)
3584 #define pseudo_exec(nommu_save, command, argv_expanded) \
3585 pseudo_exec(command, argv_expanded)
3588 /* Called after [v]fork() in run_pipe, or from builtin_exec.
3590 * Don't exit() here. If you don't exec, use _exit instead.
3591 * The at_exit handlers apparently confuse the calling process,
3592 * in particular stdin handling. Not sure why? -- because of vfork! (vda) */
3593 static void pseudo_exec_argv(nommu_save_t *nommu_save,
3594 char **argv, int assignment_cnt,
3595 char **argv_expanded) NORETURN;
3596 static NOINLINE void pseudo_exec_argv(nommu_save_t *nommu_save,
3597 char **argv, int assignment_cnt,
3598 char **argv_expanded)
3602 /* Case when we are here: ... | var=val | ... */
3603 if (!argv[assignment_cnt])
3604 _exit(EXIT_SUCCESS);
3606 new_env = expand_assignments(argv, assignment_cnt);
3608 set_vars_and_save_old(new_env);
3609 free(new_env); /* optional */
3610 /* we can also destroy set_vars_and_save_old's return value,
3613 nommu_save->new_env = new_env;
3614 nommu_save->old_vars = set_vars_and_save_old(new_env);
3616 if (argv_expanded) {
3617 argv = argv_expanded;
3619 argv = expand_strvec_to_strvec(argv + assignment_cnt);
3621 nommu_save->argv = argv;
3625 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
3626 if (strchr(argv[0], '/') != NULL)
3630 /* Check if the command matches any of the builtins.
3631 * Depending on context, this might be redundant. But it's
3632 * easier to waste a few CPU cycles than it is to figure out
3633 * if this is one of those cases.
3636 /* On NOMMU, it is more expensive to re-execute shell
3637 * just in order to run echo or test builtin.
3638 * It's better to skip it here and run corresponding
3639 * non-builtin later. */
3640 const struct built_in_command *x;
3641 x = BB_MMU ? find_builtin(argv[0]) : find_builtin1(argv[0]);
3643 exec_builtin(&nommu_save->argv_from_re_execing, x, argv);
3646 #if ENABLE_HUSH_FUNCTIONS
3647 /* Check if the command matches any functions */
3649 const struct function *funcp = find_function(argv[0]);
3651 exec_function(&nommu_save->argv_from_re_execing, funcp, argv);
3656 #if ENABLE_FEATURE_SH_STANDALONE
3657 /* Check if the command matches any busybox applets */
3659 int a = find_applet_by_name(argv[0]);
3661 # if BB_MMU /* see above why on NOMMU it is not allowed */
3662 if (APPLET_IS_NOEXEC(a)) {
3663 debug_printf_exec("running applet '%s'\n", argv[0]);
3664 run_applet_no_and_exit(a, argv);
3667 /* Re-exec ourselves */
3668 debug_printf_exec("re-execing applet '%s'\n", argv[0]);
3669 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
3670 execv(bb_busybox_exec_path, argv);
3671 /* If they called chroot or otherwise made the binary no longer
3672 * executable, fall through */
3677 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
3680 execvp_or_die(argv);
3683 /* Called after [v]fork() in run_pipe
3685 static void pseudo_exec(nommu_save_t *nommu_save,
3686 struct command *command,
3687 char **argv_expanded) NORETURN;
3688 static void pseudo_exec(nommu_save_t *nommu_save,
3689 struct command *command,
3690 char **argv_expanded)
3692 if (command->argv) {
3693 pseudo_exec_argv(nommu_save, command->argv,
3694 command->assignment_cnt, argv_expanded);
3697 if (command->group) {
3698 /* Cases when we are here:
3701 * ... | ( list ) | ...
3702 * ... | { list } | ...
3706 debug_printf_exec("pseudo_exec: run_list\n");
3707 reset_traps_to_defaults();
3708 rcode = run_list(command->group);
3709 /* OK to leak memory by not calling free_pipe_list,
3710 * since this process is about to exit */
3713 re_execute_shell(&nommu_save->argv_from_re_execing,
3714 command->group_as_string,
3721 /* Case when we are here: ... | >file */
3722 debug_printf_exec("pseudo_exec'ed null command\n");
3723 _exit(EXIT_SUCCESS);
3727 static const char *get_cmdtext(struct pipe *pi)
3733 /* This is subtle. ->cmdtext is created only on first backgrounding.
3734 * (Think "cat, <ctrl-z>, fg, <ctrl-z>, fg, <ctrl-z>...." here...)
3735 * On subsequent bg argv is trashed, but we won't use it */
3738 argv = pi->cmds[0].argv;
3739 if (!argv || !argv[0]) {
3740 pi->cmdtext = xzalloc(1);
3746 len += strlen(*argv) + 1;
3750 argv = pi->cmds[0].argv;
3752 len = strlen(*argv);
3753 memcpy(p, *argv, len);
3761 static void insert_bg_job(struct pipe *pi)
3763 struct pipe *job, **jobp;
3766 /* Linear search for the ID of the job to use */
3768 for (job = G.job_list; job; job = job->next)
3769 if (job->jobid >= pi->jobid)
3770 pi->jobid = job->jobid + 1;
3772 /* Add job to the list of running jobs */
3774 while ((job = *jobp) != NULL)
3776 job = *jobp = xmalloc(sizeof(*job));
3778 *job = *pi; /* physical copy */
3780 job->cmds = xzalloc(sizeof(pi->cmds[0]) * pi->num_cmds);
3781 /* Cannot copy entire pi->cmds[] vector! This causes double frees */
3782 for (i = 0; i < pi->num_cmds; i++) {
3783 job->cmds[i].pid = pi->cmds[i].pid;
3784 /* all other fields are not used and stay zero */
3786 job->cmdtext = xstrdup(get_cmdtext(pi));
3788 if (G_interactive_fd)
3789 printf("[%d] %d %s\n", job->jobid, job->cmds[0].pid, job->cmdtext);
3790 /* Last command's pid goes to $! */
3791 G.last_bg_pid = job->cmds[job->num_cmds - 1].pid;
3792 G.last_jobid = job->jobid;
3795 static void remove_bg_job(struct pipe *pi)
3797 struct pipe *prev_pipe;
3799 if (pi == G.job_list) {
3800 G.job_list = pi->next;
3802 prev_pipe = G.job_list;
3803 while (prev_pipe->next != pi)
3804 prev_pipe = prev_pipe->next;
3805 prev_pipe->next = pi->next;
3808 G.last_jobid = G.job_list->jobid;
3813 /* Remove a backgrounded job */
3814 static void delete_finished_bg_job(struct pipe *pi)
3817 pi->stopped_cmds = 0;
3823 /* Check to see if any processes have exited -- if they
3824 * have, figure out why and see if a job has completed */
3825 static int checkjobs(struct pipe* fg_pipe)
3835 debug_printf_jobs("checkjobs %p\n", fg_pipe);
3837 attributes = WUNTRACED;
3838 if (fg_pipe == NULL)
3839 attributes |= WNOHANG;
3842 #if ENABLE_HUSH_FAST
3843 if (G.handled_SIGCHLD == G.count_SIGCHLD) {
3844 //bb_error_msg("[%d] checkjobs: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d children?:%d fg_pipe:%p",
3845 //getpid(), G.count_SIGCHLD, G.handled_SIGCHLD, G.we_have_children, fg_pipe);
3846 /* There was neither fork nor SIGCHLD since last waitpid */
3847 /* Avoid doing waitpid syscall if possible */
3848 if (!G.we_have_children) {
3852 if (fg_pipe == NULL) { /* is WNOHANG set? */
3853 /* We have children, but they did not exit
3854 * or stop yet (we saw no SIGCHLD) */
3857 /* else: !WNOHANG, waitpid will block, can't short-circuit */
3861 /* Do we do this right?
3862 * bash-3.00# sleep 20 | false
3864 * [3]+ Stopped sleep 20 | false
3865 * bash-3.00# echo $?
3866 * 1 <========== bg pipe is not fully done, but exitcode is already known!
3867 * [hush 1.14.0: yes we do it right]
3874 #if ENABLE_HUSH_FAST
3875 i = G.count_SIGCHLD;
3877 childpid = waitpid(-1, &status, attributes);
3878 if (childpid <= 0) {
3879 if (childpid && errno != ECHILD)
3880 bb_perror_msg("waitpid");
3881 #if ENABLE_HUSH_FAST
3882 else { /* Until next SIGCHLD, waitpid's are useless */
3883 G.we_have_children = (childpid == 0);
3884 G.handled_SIGCHLD = i;
3885 //bb_error_msg("[%d] checkjobs: waitpid returned <= 0, G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
3890 dead = WIFEXITED(status) || WIFSIGNALED(status);
3893 if (WIFSTOPPED(status))
3894 debug_printf_jobs("pid %d stopped by sig %d (exitcode %d)\n",
3895 childpid, WSTOPSIG(status), WEXITSTATUS(status));
3896 if (WIFSIGNALED(status))
3897 debug_printf_jobs("pid %d killed by sig %d (exitcode %d)\n",
3898 childpid, WTERMSIG(status), WEXITSTATUS(status));
3899 if (WIFEXITED(status))
3900 debug_printf_jobs("pid %d exited, exitcode %d\n",
3901 childpid, WEXITSTATUS(status));
3903 /* Were we asked to wait for fg pipe? */
3905 for (i = 0; i < fg_pipe->num_cmds; i++) {
3906 debug_printf_jobs("check pid %d\n", fg_pipe->cmds[i].pid);
3907 if (fg_pipe->cmds[i].pid != childpid)
3910 fg_pipe->cmds[i].pid = 0;
3911 fg_pipe->alive_cmds--;
3912 if (i == fg_pipe->num_cmds - 1) {
3913 /* last process gives overall exitstatus */
3914 rcode = WEXITSTATUS(status);
3915 /* bash prints killer signal's name for *last*
3916 * process in pipe (prints just newline for SIGINT).
3917 * Mimic this. Example: "sleep 5" + (^\ or kill -QUIT)
3919 if (WIFSIGNALED(status)) {
3920 int sig = WTERMSIG(status);
3921 printf("%s\n", sig == SIGINT ? "" : get_signame(sig));
3922 /* TODO: MIPS has 128 sigs (1..128), what if sig==128 here?
3923 * Maybe we need to use sig | 128? */
3926 IF_HAS_KEYWORDS(if (fg_pipe->pi_inverted) rcode = !rcode;)
3929 fg_pipe->cmds[i].is_stopped = 1;
3930 fg_pipe->stopped_cmds++;
3932 debug_printf_jobs("fg_pipe: alive_cmds %d stopped_cmds %d\n",
3933 fg_pipe->alive_cmds, fg_pipe->stopped_cmds);
3934 if (fg_pipe->alive_cmds - fg_pipe->stopped_cmds <= 0) {
3935 /* All processes in fg pipe have exited or stopped */
3936 /* Note: *non-interactive* bash does not continue if all processes in fg pipe
3937 * are stopped. Testcase: "cat | cat" in a script (not on command line!)
3938 * and "killall -STOP cat" */
3939 if (G_interactive_fd) {
3941 if (fg_pipe->alive_cmds)
3942 insert_bg_job(fg_pipe);
3946 if (!fg_pipe->alive_cmds)
3949 /* There are still running processes in the fg pipe */
3950 goto wait_more; /* do waitpid again */
3952 /* it wasnt fg_pipe, look for process in bg pipes */
3956 /* We asked to wait for bg or orphaned children */
3957 /* No need to remember exitcode in this case */
3958 for (pi = G.job_list; pi; pi = pi->next) {
3959 for (i = 0; i < pi->num_cmds; i++) {
3960 if (pi->cmds[i].pid == childpid)
3961 goto found_pi_and_prognum;
3964 /* Happens when shell is used as init process (init=/bin/sh) */
3965 debug_printf("checkjobs: pid %d was not in our list!\n", childpid);
3966 continue; /* do waitpid again */
3968 found_pi_and_prognum:
3971 pi->cmds[i].pid = 0;
3973 if (!pi->alive_cmds) {
3974 if (G_interactive_fd)
3975 printf(JOB_STATUS_FORMAT, pi->jobid,
3976 "Done", pi->cmdtext);
3977 delete_finished_bg_job(pi);
3981 pi->cmds[i].is_stopped = 1;
3985 } /* while (waitpid succeeds)... */
3991 static int checkjobs_and_fg_shell(struct pipe* fg_pipe)
3994 int rcode = checkjobs(fg_pipe);
3995 if (G_saved_tty_pgrp) {
3996 /* Job finished, move the shell to the foreground */
3997 p = getpgrp(); /* our process group id */
3998 debug_printf_jobs("fg'ing ourself: getpgrp()=%d\n", (int)p);
3999 tcsetpgrp(G_interactive_fd, p);
4005 /* Start all the jobs, but don't wait for anything to finish.
4008 * Return code is normally -1, when the caller has to wait for children
4009 * to finish to determine the exit status of the pipe. If the pipe
4010 * is a simple builtin command, however, the action is done by the
4011 * time run_pipe returns, and the exit code is provided as the
4014 * Returns -1 only if started some children. IOW: we have to
4015 * mask out retvals of builtins etc with 0xff!
4017 * The only case when we do not need to [v]fork is when the pipe
4018 * is single, non-backgrounded, non-subshell command. Examples:
4019 * cmd ; ... { list } ; ...
4020 * cmd && ... { list } && ...
4021 * cmd || ... { list } || ...
4022 * If it is, then we can run cmd as a builtin, NOFORK [do we do this?],
4023 * or (if SH_STANDALONE) an applet, and we can run the { list }
4024 * with run_list. If it isn't one of these, we fork and exec cmd.
4026 * Cases when we must fork:
4027 * non-single: cmd | cmd
4028 * backgrounded: cmd & { list } &
4029 * subshell: ( list ) [&]
4031 static NOINLINE int run_pipe(struct pipe *pi)
4033 static const char *const null_ptr = NULL;
4036 struct command *command;
4037 char **argv_expanded;
4040 /* it is not always needed, but we aim to smaller code */
4041 int squirrel[] = { -1, -1, -1 };
4044 debug_printf_exec("run_pipe start: members:%d\n", pi->num_cmds);
4047 IF_HUSH_JOB(pi->pgrp = -1;)
4048 pi->stopped_cmds = 0;
4049 command = &(pi->cmds[0]);
4050 argv_expanded = NULL;
4052 if (pi->num_cmds != 1
4053 || pi->followup == PIPE_BG
4054 || command->cmd_type == CMD_SUBSHELL
4061 debug_printf_exec(": group:%p argv:'%s'\n",
4062 command->group, command->argv ? command->argv[0] : "NONE");
4064 if (command->group) {
4065 #if ENABLE_HUSH_FUNCTIONS
4066 if (command->cmd_type == CMD_FUNCDEF) {
4067 /* "executing" func () { list } */
4068 struct function *funcp;
4070 funcp = new_function(command->argv[0]);
4071 /* funcp->name is already set to argv[0] */
4072 funcp->body = command->group;
4074 funcp->body_as_string = command->group_as_string;
4075 command->group_as_string = NULL;
4077 command->group = NULL;
4078 command->argv[0] = NULL;
4079 debug_printf_exec("cmd %p has child func at %p\n", command, funcp);
4080 funcp->parent_cmd = command;
4081 command->child_func = funcp;
4083 debug_printf_exec("run_pipe: return EXIT_SUCCESS\n");
4085 return EXIT_SUCCESS;
4089 debug_printf("non-subshell group\n");
4090 rcode = 1; /* exitcode if redir failed */
4091 if (setup_redirects(command, squirrel) == 0) {
4092 debug_printf_exec(": run_list\n");
4093 rcode = run_list(command->group) & 0xff;
4095 restore_redirects(squirrel);
4096 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
4098 debug_printf_exec("run_pipe: return %d\n", rcode);
4102 argv = command->argv ? command->argv : (char **) &null_ptr;
4104 const struct built_in_command *x;
4105 #if ENABLE_HUSH_FUNCTIONS
4106 const struct function *funcp;
4110 char **new_env = NULL;
4111 struct variable *old_vars = NULL;
4113 if (argv[command->assignment_cnt] == NULL) {
4114 /* Assignments, but no command */
4115 /* Ensure redirects take effect. Try "a=t >file" */
4116 rcode = setup_redirects(command, squirrel);
4117 restore_redirects(squirrel);
4118 /* Set shell variables */
4120 p = expand_string_to_string(*argv);
4121 debug_printf_exec("set shell var:'%s'->'%s'\n",
4123 set_local_var(p, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
4126 /* Do we need to flag set_local_var() errors?
4127 * "assignment to readonly var" and "putenv error"
4129 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
4131 debug_printf_exec("run_pipe: return %d\n", rcode);
4135 /* Expand the rest into (possibly) many strings each */
4137 #if ENABLE_HUSH_BASH_COMPAT
4138 else if (command->cmd_type == CMD_SINGLEWORD_NOGLOB) {
4139 argv_expanded = expand_strvec_to_strvec_singleword_noglob(argv + command->assignment_cnt);
4142 #ifdef CMD_SINGLEWORD_NOGLOB_COND
4143 else if (command->cmd_type == CMD_SINGLEWORD_NOGLOB_COND) {
4144 argv_expanded = expand_strvec_to_strvec_singleword_noglob_cond(argv + command->assignment_cnt);
4149 argv_expanded = expand_strvec_to_strvec(argv + command->assignment_cnt);
4152 /* if someone gives us an empty string: `cmd with empty output` */
4153 if (!argv_expanded[0]) {
4154 free(argv_expanded);
4156 return G.last_exitcode;
4159 x = find_builtin(argv_expanded[0]);
4160 #if ENABLE_HUSH_FUNCTIONS
4163 funcp = find_function(argv_expanded[0]);
4167 if (x->function == builtin_exec && argv_expanded[1] == NULL) {
4168 debug_printf("exec with redirects only\n");
4169 rcode = setup_redirects(command, NULL);
4170 goto clean_up_and_ret1;
4173 /* setup_redirects acts on file descriptors, not FILEs.
4174 * This is perfect for work that comes after exec().
4175 * Is it really safe for inline use? Experimentally,
4176 * things seem to work. */
4177 rcode = setup_redirects(command, squirrel);
4179 new_env = expand_assignments(argv, command->assignment_cnt);
4180 old_vars = set_vars_and_save_old(new_env);
4182 debug_printf_exec(": builtin '%s' '%s'...\n",
4183 x->cmd, argv_expanded[1]);
4184 rcode = x->function(argv_expanded) & 0xff;
4187 #if ENABLE_HUSH_FUNCTIONS
4189 # if ENABLE_HUSH_LOCAL
4190 struct variable **sv;
4191 sv = G.shadowed_vars_pp;
4192 G.shadowed_vars_pp = &old_vars;
4194 debug_printf_exec(": function '%s' '%s'...\n",
4195 funcp->name, argv_expanded[1]);
4196 rcode = run_function(funcp, argv_expanded) & 0xff;
4197 # if ENABLE_HUSH_LOCAL
4198 G.shadowed_vars_pp = sv;
4203 #if ENABLE_FEATURE_SH_STANDALONE
4206 restore_redirects(squirrel);
4207 unset_vars(new_env);
4210 free(argv_expanded);
4211 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
4213 debug_printf_exec("run_pipe return %d\n", rcode);
4217 #if ENABLE_FEATURE_SH_STANDALONE
4218 i = find_applet_by_name(argv_expanded[0]);
4219 if (i >= 0 && APPLET_IS_NOFORK(i)) {
4220 rcode = setup_redirects(command, squirrel);
4222 new_env = expand_assignments(argv, command->assignment_cnt);
4223 old_vars = set_vars_and_save_old(new_env);
4224 debug_printf_exec(": run_nofork_applet '%s' '%s'...\n",
4225 argv_expanded[0], argv_expanded[1]);
4226 rcode = run_nofork_applet(i, argv_expanded);
4228 goto clean_up_and_ret;
4231 /* It is neither builtin nor applet. We must fork. */
4235 /* NB: argv_expanded may already be created, and that
4236 * might include `cmd` runs! Do not rerun it! We *must*
4237 * use argv_expanded if it's non-NULL */
4239 /* Going to fork a child per each pipe member */
4243 for (i = 0; i < pi->num_cmds; i++) {
4244 struct fd_pair pipefds;
4246 volatile nommu_save_t nommu_save;
4247 nommu_save.new_env = NULL;
4248 nommu_save.old_vars = NULL;
4249 nommu_save.argv = NULL;
4250 nommu_save.argv_from_re_execing = NULL;
4252 command = &(pi->cmds[i]);
4253 if (command->argv) {
4254 debug_printf_exec(": pipe member '%s' '%s'...\n",
4255 command->argv[0], command->argv[1]);
4257 debug_printf_exec(": pipe member with no argv\n");
4260 /* pipes are inserted between pairs of commands */
4263 if ((i + 1) < pi->num_cmds)
4264 xpiped_pair(pipefds);
4266 command->pid = BB_MMU ? fork() : vfork();
4267 if (!command->pid) { /* child */
4269 disable_restore_tty_pgrp_on_exit();
4270 CLEAR_RANDOM_T(&G.random_gen); /* or else $RANDOM repeats in child */
4272 /* Every child adds itself to new process group
4273 * with pgid == pid_of_first_child_in_pipe */
4274 if (G.run_list_level == 1 && G_interactive_fd) {
4277 if (pgrp < 0) /* true for 1st process only */
4279 if (setpgid(0, pgrp) == 0
4280 && pi->followup != PIPE_BG
4281 && G_saved_tty_pgrp /* we have ctty */
4283 /* We do it in *every* child, not just first,
4285 tcsetpgrp(G_interactive_fd, pgrp);
4289 if (pi->alive_cmds == 0 && pi->followup == PIPE_BG) {
4290 /* 1st cmd in backgrounded pipe
4291 * should have its stdin /dev/null'ed */
4293 if (open(bb_dev_null, O_RDONLY))
4294 xopen("/", O_RDONLY);
4296 xmove_fd(nextin, 0);
4298 xmove_fd(pipefds.wr, 1);
4301 /* Like bash, explicit redirects override pipes,
4302 * and the pipe fd is available for dup'ing. */
4303 if (setup_redirects(command, NULL))
4306 /* Restore default handlers just prior to exec */
4307 /*signal(SIGCHLD, SIG_DFL); - so far we don't have any handlers */
4309 /* Stores to nommu_save list of env vars putenv'ed
4310 * (NOMMU, on MMU we don't need that) */
4311 /* cast away volatility... */
4312 pseudo_exec((nommu_save_t*) &nommu_save, command, argv_expanded);
4313 /* pseudo_exec() does not return */
4316 /* parent or error */
4317 #if ENABLE_HUSH_FAST
4319 //bb_error_msg("[%d] fork in run_pipe: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
4321 enable_restore_tty_pgrp_on_exit();
4323 /* Clean up after vforked child */
4324 free(nommu_save.argv);
4325 free(nommu_save.argv_from_re_execing);
4326 unset_vars(nommu_save.new_env);
4327 add_vars(nommu_save.old_vars);
4329 free(argv_expanded);
4330 argv_expanded = NULL;
4331 if (command->pid < 0) { /* [v]fork failed */
4332 /* Clearly indicate, was it fork or vfork */
4333 bb_perror_msg(BB_MMU ? "fork" : "vfork");
4337 /* Second and next children need to know pid of first one */
4339 pi->pgrp = command->pid;
4345 if ((i + 1) < pi->num_cmds)
4347 /* Pass read (output) pipe end to next iteration */
4348 nextin = pipefds.rd;
4351 if (!pi->alive_cmds) {
4353 debug_printf_exec("run_pipe return 1 (all forks failed, no children)\n");
4358 debug_printf_exec("run_pipe return -1 (%u children started)\n", pi->alive_cmds);
4362 #ifndef debug_print_tree
4363 static void debug_print_tree(struct pipe *pi, int lvl)
4365 static const char *const PIPE[] = {
4371 static const char *RES[] = {
4372 [RES_NONE ] = "NONE" ,
4375 [RES_THEN ] = "THEN" ,
4376 [RES_ELIF ] = "ELIF" ,
4377 [RES_ELSE ] = "ELSE" ,
4380 # if ENABLE_HUSH_LOOPS
4381 [RES_FOR ] = "FOR" ,
4382 [RES_WHILE] = "WHILE",
4383 [RES_UNTIL] = "UNTIL",
4385 [RES_DONE ] = "DONE" ,
4387 # if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
4390 # if ENABLE_HUSH_CASE
4391 [RES_CASE ] = "CASE" ,
4392 [RES_CASE_IN ] = "CASE_IN" ,
4393 [RES_MATCH] = "MATCH",
4394 [RES_CASE_BODY] = "CASE_BODY",
4395 [RES_ESAC ] = "ESAC" ,
4397 [RES_XXXX ] = "XXXX" ,
4398 [RES_SNTX ] = "SNTX" ,
4400 static const char *const CMDTYPE[] = {
4404 # if ENABLE_HUSH_FUNCTIONS
4413 fprintf(stderr, "%*spipe %d res_word=%s followup=%d %s\n", lvl*2, "",
4414 pin, RES[pi->res_word], pi->followup, PIPE[pi->followup]);
4416 while (prn < pi->num_cmds) {
4417 struct command *command = &pi->cmds[prn];
4418 char **argv = command->argv;
4420 fprintf(stderr, "%*s cmd %d assignment_cnt:%d",
4422 command->assignment_cnt);
4423 if (command->group) {
4424 fprintf(stderr, " group %s: (argv=%p)%s%s\n",
4425 CMDTYPE[command->cmd_type],
4428 , " group_as_string:", command->group_as_string
4433 debug_print_tree(command->group, lvl+1);
4437 if (argv) while (*argv) {
4438 fprintf(stderr, " '%s'", *argv);
4441 fprintf(stderr, "\n");
4448 #endif /* debug_print_tree */
4450 /* NB: called by pseudo_exec, and therefore must not modify any
4451 * global data until exec/_exit (we can be a child after vfork!) */
4452 static int run_list(struct pipe *pi)
4454 #if ENABLE_HUSH_CASE
4455 char *case_word = NULL;
4457 #if ENABLE_HUSH_LOOPS
4458 struct pipe *loop_top = NULL;
4459 char **for_lcur = NULL;
4460 char **for_list = NULL;
4462 smallint last_followup;
4464 #if ENABLE_HUSH_IF || ENABLE_HUSH_CASE
4465 smalluint cond_code = 0;
4467 enum { cond_code = 0 };
4470 smallint rword; /* enum reserved_style */
4471 smallint last_rword; /* ditto */
4474 debug_printf_exec("run_list start lvl %d\n", G.run_list_level);
4477 #if ENABLE_HUSH_LOOPS
4478 /* Check syntax for "for" */
4479 for (struct pipe *cpipe = pi; cpipe; cpipe = cpipe->next) {
4480 if (cpipe->res_word != RES_FOR && cpipe->res_word != RES_IN)
4482 /* current word is FOR or IN (BOLD in comments below) */
4483 if (cpipe->next == NULL) {
4484 syntax_error("malformed for");
4486 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
4489 /* "FOR v; do ..." and "for v IN a b; do..." are ok */
4490 if (cpipe->next->res_word == RES_DO)
4492 /* next word is not "do". It must be "in" then ("FOR v in ...") */
4493 if (cpipe->res_word == RES_IN /* "for v IN a b; not_do..."? */
4494 || cpipe->next->res_word != RES_IN /* FOR v not_do_and_not_in..."? */
4496 syntax_error("malformed for");
4498 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
4504 /* Past this point, all code paths should jump to ret: label
4505 * in order to return, no direct "return" statements please.
4506 * This helps to ensure that no memory is leaked. */
4514 last_rword = RES_XXXX;
4516 last_followup = PIPE_SEQ;
4517 rcode = G.last_exitcode;
4519 /* Go through list of pipes, (maybe) executing them. */
4520 for (; pi; pi = IF_HUSH_LOOPS(rword == RES_DONE ? loop_top : ) pi->next) {
4524 IF_HAS_KEYWORDS(rword = pi->res_word;)
4525 debug_printf_exec(": rword=%d cond_code=%d last_rword=%d\n",
4526 rword, cond_code, last_rword);
4527 #if ENABLE_HUSH_LOOPS
4528 if ((rword == RES_WHILE || rword == RES_UNTIL || rword == RES_FOR)
4529 && loop_top == NULL /* avoid bumping G.depth_of_loop twice */
4531 /* start of a loop: remember where loop starts */
4536 /* Still in the same "if...", "then..." or "do..." branch? */
4537 if (IF_HAS_KEYWORDS(rword == last_rword &&) 1) {
4538 if ((rcode == 0 && last_followup == PIPE_OR)
4539 || (rcode != 0 && last_followup == PIPE_AND)
4541 /* It is "<true> || CMD" or "<false> && CMD"
4542 * and we should not execute CMD */
4543 debug_printf_exec("skipped cmd because of || or &&\n");
4544 last_followup = pi->followup;
4548 last_followup = pi->followup;
4549 IF_HAS_KEYWORDS(last_rword = rword;)
4552 if (rword == RES_THEN) {
4553 /* if false; then ... fi has exitcode 0! */
4554 G.last_exitcode = rcode = EXIT_SUCCESS;
4555 /* "if <false> THEN cmd": skip cmd */
4559 if (rword == RES_ELSE || rword == RES_ELIF) {
4560 /* "if <true> then ... ELSE/ELIF cmd":
4561 * skip cmd and all following ones */
4566 #if ENABLE_HUSH_LOOPS
4567 if (rword == RES_FOR) { /* && pi->num_cmds - always == 1 */
4569 /* first loop through for */
4571 static const char encoded_dollar_at[] ALIGN1 = {
4572 SPECIAL_VAR_SYMBOL, '@' | 0x80, SPECIAL_VAR_SYMBOL, '\0'
4573 }; /* encoded representation of "$@" */
4574 static const char *const encoded_dollar_at_argv[] = {
4575 encoded_dollar_at, NULL
4576 }; /* argv list with one element: "$@" */
4579 vals = (char**)encoded_dollar_at_argv;
4580 if (pi->next->res_word == RES_IN) {
4581 /* if no variable values after "in" we skip "for" */
4582 if (!pi->next->cmds[0].argv) {
4583 G.last_exitcode = rcode = EXIT_SUCCESS;
4584 debug_printf_exec(": null FOR: exitcode EXIT_SUCCESS\n");
4587 vals = pi->next->cmds[0].argv;
4588 } /* else: "for var; do..." -> assume "$@" list */
4589 /* create list of variable values */
4590 debug_print_strings("for_list made from", vals);
4591 for_list = expand_strvec_to_strvec(vals);
4592 for_lcur = for_list;
4593 debug_print_strings("for_list", for_list);
4596 /* "for" loop is over, clean up */
4602 /* Insert next value from for_lcur */
4603 /* note: *for_lcur already has quotes removed, $var expanded, etc */
4604 set_local_var(xasprintf("%s=%s", pi->cmds[0].argv[0], *for_lcur++), /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
4607 if (rword == RES_IN) {
4608 continue; /* "for v IN list;..." - "in" has no cmds anyway */
4610 if (rword == RES_DONE) {
4611 continue; /* "done" has no cmds too */
4614 #if ENABLE_HUSH_CASE
4615 if (rword == RES_CASE) {
4616 case_word = expand_strvec_to_string(pi->cmds->argv);
4619 if (rword == RES_MATCH) {
4622 if (!case_word) /* "case ... matched_word) ... WORD)": we executed selected branch, stop */
4624 /* all prev words didn't match, does this one match? */
4625 argv = pi->cmds->argv;
4627 char *pattern = expand_string_to_string(*argv);
4628 /* TODO: which FNM_xxx flags to use? */
4629 cond_code = (fnmatch(pattern, case_word, /*flags:*/ 0) != 0);
4631 if (cond_code == 0) { /* match! we will execute this branch */
4632 free(case_word); /* make future "word)" stop */
4640 if (rword == RES_CASE_BODY) { /* inside of a case branch */
4642 continue; /* not matched yet, skip this pipe */
4645 /* Just pressing <enter> in shell should check for jobs.
4646 * OTOH, in non-interactive shell this is useless
4647 * and only leads to extra job checks */
4648 if (pi->num_cmds == 0) {
4649 if (G_interactive_fd)
4650 goto check_jobs_and_continue;
4654 /* After analyzing all keywords and conditions, we decided
4655 * to execute this pipe. NB: have to do checkjobs(NULL)
4656 * after run_pipe to collect any background children,
4657 * even if list execution is to be stopped. */
4658 debug_printf_exec(": run_pipe with %d members\n", pi->num_cmds);
4661 #if ENABLE_HUSH_LOOPS
4662 G.flag_break_continue = 0;
4664 rcode = r = run_pipe(pi); /* NB: rcode is a smallint */
4666 /* We ran a builtin, function, or group.
4667 * rcode is already known
4668 * and we don't need to wait for anything. */
4669 G.last_exitcode = rcode;
4670 debug_printf_exec(": builtin/func exitcode %d\n", rcode);
4671 check_and_run_traps(0);
4672 #if ENABLE_HUSH_LOOPS
4673 /* Was it "break" or "continue"? */
4674 if (G.flag_break_continue) {
4675 smallint fbc = G.flag_break_continue;
4676 /* We might fall into outer *loop*,
4677 * don't want to break it too */
4679 G.depth_break_continue--;
4680 if (G.depth_break_continue == 0)
4681 G.flag_break_continue = 0;
4682 /* else: e.g. "continue 2" should *break* once, *then* continue */
4683 } /* else: "while... do... { we are here (innermost list is not a loop!) };...done" */
4684 if (G.depth_break_continue != 0 || fbc == BC_BREAK)
4685 goto check_jobs_and_break;
4686 /* "continue": simulate end of loop */
4691 #if ENABLE_HUSH_FUNCTIONS
4692 if (G.flag_return_in_progress == 1) {
4693 /* same as "goto check_jobs_and_break" */
4698 } else if (pi->followup == PIPE_BG) {
4699 /* What does bash do with attempts to background builtins? */
4700 /* even bash 3.2 doesn't do that well with nested bg:
4701 * try "{ { sleep 10; echo DEEP; } & echo HERE; } &".
4702 * I'm NOT treating inner &'s as jobs */
4703 check_and_run_traps(0);
4705 if (G.run_list_level == 1)
4708 G.last_exitcode = rcode = EXIT_SUCCESS;
4709 debug_printf_exec(": cmd&: exitcode EXIT_SUCCESS\n");
4712 if (G.run_list_level == 1 && G_interactive_fd) {
4713 /* Waits for completion, then fg's main shell */
4714 rcode = checkjobs_and_fg_shell(pi);
4715 debug_printf_exec(": checkjobs_and_fg_shell exitcode %d\n", rcode);
4716 check_and_run_traps(0);
4719 { /* This one just waits for completion */
4720 rcode = checkjobs(pi);
4721 debug_printf_exec(": checkjobs exitcode %d\n", rcode);
4722 check_and_run_traps(0);
4724 G.last_exitcode = rcode;
4728 /* Analyze how result affects subsequent commands */
4730 if (rword == RES_IF || rword == RES_ELIF)
4733 #if ENABLE_HUSH_LOOPS
4734 /* Beware of "while false; true; do ..."! */
4735 if (pi->next && pi->next->res_word == RES_DO) {
4736 if (rword == RES_WHILE) {
4738 /* "while false; do...done" - exitcode 0 */
4739 G.last_exitcode = rcode = EXIT_SUCCESS;
4740 debug_printf_exec(": while expr is false: breaking (exitcode:EXIT_SUCCESS)\n");
4741 goto check_jobs_and_break;
4744 if (rword == RES_UNTIL) {
4746 debug_printf_exec(": until expr is true: breaking\n");
4747 check_jobs_and_break:
4755 check_jobs_and_continue:
4762 #if ENABLE_HUSH_LOOPS
4767 #if ENABLE_HUSH_CASE
4771 debug_printf_exec("run_list lvl %d return %d\n", G.run_list_level + 1, rcode);
4775 /* Select which version we will use */
4776 static int run_and_free_list(struct pipe *pi)
4779 debug_printf_exec("run_and_free_list entered\n");
4781 debug_printf_exec(": run_list: 1st pipe with %d cmds\n", pi->num_cmds);
4782 rcode = run_list(pi);
4784 /* free_pipe_list has the side effect of clearing memory.
4785 * In the long run that function can be merged with run_list,
4786 * but doing that now would hobble the debugging effort. */
4788 debug_printf_exec("run_and_free_list return %d\n", rcode);
4793 static struct pipe *new_pipe(void)
4796 pi = xzalloc(sizeof(struct pipe));
4797 /*pi->followup = 0; - deliberately invalid value */
4798 /*pi->res_word = RES_NONE; - RES_NONE is 0 anyway */
4802 /* Command (member of a pipe) is complete, or we start a new pipe
4803 * if ctx->command is NULL.
4804 * No errors possible here.
4806 static int done_command(struct parse_context *ctx)
4808 /* The command is really already in the pipe structure, so
4809 * advance the pipe counter and make a new, null command. */
4810 struct pipe *pi = ctx->pipe;
4811 struct command *command = ctx->command;
4814 if (IS_NULL_CMD(command)) {
4815 debug_printf_parse("done_command: skipping null cmd, num_cmds=%d\n", pi->num_cmds);
4819 debug_printf_parse("done_command: ++num_cmds=%d\n", pi->num_cmds);
4820 //debug_print_tree(ctx->list_head, 20);
4822 debug_printf_parse("done_command: initializing, num_cmds=%d\n", pi->num_cmds);
4825 /* Only real trickiness here is that the uncommitted
4826 * command structure is not counted in pi->num_cmds. */
4827 pi->cmds = xrealloc(pi->cmds, sizeof(*pi->cmds) * (pi->num_cmds+1));
4828 ctx->command = command = &pi->cmds[pi->num_cmds];
4830 memset(command, 0, sizeof(*command));
4831 return pi->num_cmds; /* used only for 0/nonzero check */
4834 static void done_pipe(struct parse_context *ctx, pipe_style type)
4838 debug_printf_parse("done_pipe entered, followup %d\n", type);
4839 /* Close previous command */
4840 not_null = done_command(ctx);
4841 ctx->pipe->followup = type;
4843 ctx->pipe->pi_inverted = ctx->ctx_inverted;
4844 ctx->ctx_inverted = 0;
4845 ctx->pipe->res_word = ctx->ctx_res_w;
4848 /* Without this check, even just <enter> on command line generates
4849 * tree of three NOPs (!). Which is harmless but annoying.
4850 * IOW: it is safe to do it unconditionally. */
4853 || ctx->ctx_res_w == RES_FI
4855 #if ENABLE_HUSH_LOOPS
4856 || ctx->ctx_res_w == RES_DONE
4857 || ctx->ctx_res_w == RES_FOR
4858 || ctx->ctx_res_w == RES_IN
4860 #if ENABLE_HUSH_CASE
4861 || ctx->ctx_res_w == RES_ESAC
4865 debug_printf_parse("done_pipe: adding new pipe: "
4866 "not_null:%d ctx->ctx_res_w:%d\n",
4867 not_null, ctx->ctx_res_w);
4869 ctx->pipe->next = new_p;
4871 /* RES_THEN, RES_DO etc are "sticky" -
4872 * they remain set for pipes inside if/while.
4873 * This is used to control execution.
4874 * RES_FOR and RES_IN are NOT sticky (needed to support
4875 * cases where variable or value happens to match a keyword):
4877 #if ENABLE_HUSH_LOOPS
4878 if (ctx->ctx_res_w == RES_FOR
4879 || ctx->ctx_res_w == RES_IN)
4880 ctx->ctx_res_w = RES_NONE;
4882 #if ENABLE_HUSH_CASE
4883 if (ctx->ctx_res_w == RES_MATCH)
4884 ctx->ctx_res_w = RES_CASE_BODY;
4885 if (ctx->ctx_res_w == RES_CASE)
4886 ctx->ctx_res_w = RES_CASE_IN;
4888 ctx->command = NULL; /* trick done_command below */
4889 /* Create the memory for command, roughly:
4890 * ctx->pipe->cmds = new struct command;
4891 * ctx->command = &ctx->pipe->cmds[0];
4894 //debug_print_tree(ctx->list_head, 10);
4896 debug_printf_parse("done_pipe return\n");
4899 static void initialize_context(struct parse_context *ctx)
4901 memset(ctx, 0, sizeof(*ctx));
4902 ctx->pipe = ctx->list_head = new_pipe();
4903 /* Create the memory for command, roughly:
4904 * ctx->pipe->cmds = new struct command;
4905 * ctx->command = &ctx->pipe->cmds[0];
4910 /* If a reserved word is found and processed, parse context is modified
4911 * and 1 is returned.
4914 struct reserved_combo {
4917 unsigned char assignment_flag;
4921 FLAG_END = (1 << RES_NONE ),
4923 FLAG_IF = (1 << RES_IF ),
4924 FLAG_THEN = (1 << RES_THEN ),
4925 FLAG_ELIF = (1 << RES_ELIF ),
4926 FLAG_ELSE = (1 << RES_ELSE ),
4927 FLAG_FI = (1 << RES_FI ),
4929 # if ENABLE_HUSH_LOOPS
4930 FLAG_FOR = (1 << RES_FOR ),
4931 FLAG_WHILE = (1 << RES_WHILE),
4932 FLAG_UNTIL = (1 << RES_UNTIL),
4933 FLAG_DO = (1 << RES_DO ),
4934 FLAG_DONE = (1 << RES_DONE ),
4935 FLAG_IN = (1 << RES_IN ),
4937 # if ENABLE_HUSH_CASE
4938 FLAG_MATCH = (1 << RES_MATCH),
4939 FLAG_ESAC = (1 << RES_ESAC ),
4941 FLAG_START = (1 << RES_XXXX ),
4944 static const struct reserved_combo* match_reserved_word(o_string *word)
4946 /* Mostly a list of accepted follow-up reserved words.
4947 * FLAG_END means we are done with the sequence, and are ready
4948 * to turn the compound list into a command.
4949 * FLAG_START means the word must start a new compound list.
4951 static const struct reserved_combo reserved_list[] = {
4953 { "!", RES_NONE, NOT_ASSIGNMENT , 0 },
4954 { "if", RES_IF, WORD_IS_KEYWORD, FLAG_THEN | FLAG_START },
4955 { "then", RES_THEN, WORD_IS_KEYWORD, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
4956 { "elif", RES_ELIF, WORD_IS_KEYWORD, FLAG_THEN },
4957 { "else", RES_ELSE, WORD_IS_KEYWORD, FLAG_FI },
4958 { "fi", RES_FI, NOT_ASSIGNMENT , FLAG_END },
4960 # if ENABLE_HUSH_LOOPS
4961 { "for", RES_FOR, NOT_ASSIGNMENT , FLAG_IN | FLAG_DO | FLAG_START },
4962 { "while", RES_WHILE, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
4963 { "until", RES_UNTIL, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
4964 { "in", RES_IN, NOT_ASSIGNMENT , FLAG_DO },
4965 { "do", RES_DO, WORD_IS_KEYWORD, FLAG_DONE },
4966 { "done", RES_DONE, NOT_ASSIGNMENT , FLAG_END },
4968 # if ENABLE_HUSH_CASE
4969 { "case", RES_CASE, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_START },
4970 { "esac", RES_ESAC, NOT_ASSIGNMENT , FLAG_END },
4973 const struct reserved_combo *r;
4975 for (r = reserved_list; r < reserved_list + ARRAY_SIZE(reserved_list); r++) {
4976 if (strcmp(word->data, r->literal) == 0)
4981 /* Return 0: not a keyword, 1: keyword
4983 static int reserved_word(o_string *word, struct parse_context *ctx)
4985 # if ENABLE_HUSH_CASE
4986 static const struct reserved_combo reserved_match = {
4987 "", RES_MATCH, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_ESAC
4990 const struct reserved_combo *r;
4994 r = match_reserved_word(word);
4998 debug_printf("found reserved word %s, res %d\n", r->literal, r->res);
4999 # if ENABLE_HUSH_CASE
5000 if (r->res == RES_IN && ctx->ctx_res_w == RES_CASE_IN) {
5001 /* "case word IN ..." - IN part starts first MATCH part */
5002 r = &reserved_match;
5005 if (r->flag == 0) { /* '!' */
5006 if (ctx->ctx_inverted) { /* bash doesn't accept '! ! true' */
5007 syntax_error("! ! command");
5008 ctx->ctx_res_w = RES_SNTX;
5010 ctx->ctx_inverted = 1;
5013 if (r->flag & FLAG_START) {
5014 struct parse_context *old;
5016 old = xmalloc(sizeof(*old));
5017 debug_printf_parse("push stack %p\n", old);
5018 *old = *ctx; /* physical copy */
5019 initialize_context(ctx);
5021 } else if (/*ctx->ctx_res_w == RES_NONE ||*/ !(ctx->old_flag & (1 << r->res))) {
5022 syntax_error_at(word->data);
5023 ctx->ctx_res_w = RES_SNTX;
5026 /* "{...} fi" is ok. "{...} if" is not
5028 * if { echo foo; } then { echo bar; } fi */
5029 if (ctx->command->group)
5030 done_pipe(ctx, PIPE_SEQ);
5033 ctx->ctx_res_w = r->res;
5034 ctx->old_flag = r->flag;
5035 word->o_assignment = r->assignment_flag;
5037 if (ctx->old_flag & FLAG_END) {
5038 struct parse_context *old;
5040 done_pipe(ctx, PIPE_SEQ);
5041 debug_printf_parse("pop stack %p\n", ctx->stack);
5043 old->command->group = ctx->list_head;
5044 old->command->cmd_type = CMD_NORMAL;
5046 o_addstr(&old->as_string, ctx->as_string.data);
5047 o_free_unsafe(&ctx->as_string);
5048 old->command->group_as_string = xstrdup(old->as_string.data);
5049 debug_printf_parse("pop, remembering as:'%s'\n",
5050 old->command->group_as_string);
5052 *ctx = *old; /* physical copy */
5057 #endif /* HAS_KEYWORDS */
5059 /* Word is complete, look at it and update parsing context.
5060 * Normal return is 0. Syntax errors return 1.
5061 * Note: on return, word is reset, but not o_free'd!
5063 static int done_word(o_string *word, struct parse_context *ctx)
5065 struct command *command = ctx->command;
5067 debug_printf_parse("done_word entered: '%s' %p\n", word->data, command);
5068 if (word->length == 0 && word->o_quoted == 0) {
5069 debug_printf_parse("done_word return 0: true null, ignored\n");
5073 if (ctx->pending_redirect) {
5074 /* We do not glob in e.g. >*.tmp case. bash seems to glob here
5075 * only if run as "bash", not "sh" */
5076 /* http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
5078 * ...the word that follows the redirection operator
5079 * shall be subjected to tilde expansion, parameter expansion,
5080 * command substitution, arithmetic expansion, and quote
5081 * removal. Pathname expansion shall not be performed
5082 * on the word by a non-interactive shell; an interactive
5083 * shell may perform it, but shall do so only when
5084 * the expansion would result in one word."
5086 ctx->pending_redirect->rd_filename = xstrdup(word->data);
5087 /* Cater for >\file case:
5088 * >\a creates file a; >\\a, >"\a", >"\\a" create file \a
5089 * Same with heredocs:
5090 * for <<\H delim is H; <<\\H, <<"\H", <<"\\H" - \H
5092 if (ctx->pending_redirect->rd_type == REDIRECT_HEREDOC) {
5093 unbackslash(ctx->pending_redirect->rd_filename);
5094 /* Is it <<"HEREDOC"? */
5095 if (word->o_quoted) {
5096 ctx->pending_redirect->rd_dup |= HEREDOC_QUOTED;
5099 debug_printf_parse("word stored in rd_filename: '%s'\n", word->data);
5100 ctx->pending_redirect = NULL;
5102 /* If this word wasn't an assignment, next ones definitely
5103 * can't be assignments. Even if they look like ones. */
5104 if (word->o_assignment != DEFINITELY_ASSIGNMENT
5105 && word->o_assignment != WORD_IS_KEYWORD
5107 word->o_assignment = NOT_ASSIGNMENT;
5109 if (word->o_assignment == DEFINITELY_ASSIGNMENT)
5110 command->assignment_cnt++;
5111 word->o_assignment = MAYBE_ASSIGNMENT;
5115 # if ENABLE_HUSH_CASE
5116 if (ctx->ctx_dsemicolon
5117 && strcmp(word->data, "esac") != 0 /* not "... pattern) cmd;; esac" */
5119 /* already done when ctx_dsemicolon was set to 1: */
5120 /* ctx->ctx_res_w = RES_MATCH; */
5121 ctx->ctx_dsemicolon = 0;
5124 if (!command->argv /* if it's the first word... */
5125 # if ENABLE_HUSH_LOOPS
5126 && ctx->ctx_res_w != RES_FOR /* ...not after FOR or IN */
5127 && ctx->ctx_res_w != RES_IN
5129 # if ENABLE_HUSH_CASE
5130 && ctx->ctx_res_w != RES_CASE
5133 debug_printf_parse("checking '%s' for reserved-ness\n", word->data);
5134 if (reserved_word(word, ctx)) {
5135 o_reset_to_empty_unquoted(word);
5136 debug_printf_parse("done_word return %d\n",
5137 (ctx->ctx_res_w == RES_SNTX));
5138 return (ctx->ctx_res_w == RES_SNTX);
5140 # ifdef CMD_SINGLEWORD_NOGLOB_COND
5141 if (strcmp(word->data, "export") == 0
5142 # if ENABLE_HUSH_LOCAL
5143 || strcmp(word->data, "local") == 0
5146 command->cmd_type = CMD_SINGLEWORD_NOGLOB_COND;
5149 # if ENABLE_HUSH_BASH_COMPAT
5150 if (strcmp(word->data, "[[") == 0) {
5151 command->cmd_type = CMD_SINGLEWORD_NOGLOB;
5157 if (command->group) {
5158 /* "{ echo foo; } echo bar" - bad */
5159 syntax_error_at(word->data);
5160 debug_printf_parse("done_word return 1: syntax error, "
5161 "groups and arglists don't mix\n");
5164 if (word->o_quoted /* word had "xx" or 'xx' at least as part of it. */
5165 /* optimization: and if it's ("" or '') or ($v... or `cmd`...): */
5166 && (word->data[0] == '\0' || word->data[0] == SPECIAL_VAR_SYMBOL)
5167 /* (otherwise it's known to be not empty and is already safe) */
5169 /* exclude "$@" - it can expand to no word despite "" */
5170 char *p = word->data;
5171 while (p[0] == SPECIAL_VAR_SYMBOL
5172 && (p[1] & 0x7f) == '@'
5173 && p[2] == SPECIAL_VAR_SYMBOL
5177 if (p == word->data || p[0] != '\0') {
5178 /* saw no "$@", or not only "$@" but some
5179 * real text is there too */
5180 /* insert "empty variable" reference, this makes
5181 * e.g. "", $empty"" etc to not disappear */
5182 o_addchr(word, SPECIAL_VAR_SYMBOL);
5183 o_addchr(word, SPECIAL_VAR_SYMBOL);
5186 command->argv = add_string_to_strings(command->argv, xstrdup(word->data));
5187 debug_print_strings("word appended to argv", command->argv);
5190 #if ENABLE_HUSH_LOOPS
5191 if (ctx->ctx_res_w == RES_FOR) {
5193 || !is_well_formed_var_name(command->argv[0], '\0')
5195 /* bash says just "not a valid identifier" */
5196 syntax_error("not a valid identifier in for");
5199 /* Force FOR to have just one word (variable name) */
5200 /* NB: basically, this makes hush see "for v in ..."
5201 * syntax as if it is "for v; in ...". FOR and IN become
5202 * two pipe structs in parse tree. */
5203 done_pipe(ctx, PIPE_SEQ);
5206 #if ENABLE_HUSH_CASE
5207 /* Force CASE to have just one word */
5208 if (ctx->ctx_res_w == RES_CASE) {
5209 done_pipe(ctx, PIPE_SEQ);
5213 o_reset_to_empty_unquoted(word);
5215 debug_printf_parse("done_word return 0\n");
5220 /* Peek ahead in the input to find out if we have a "&n" construct,
5221 * as in "2>&1", that represents duplicating a file descriptor.
5223 * REDIRFD_CLOSE if >&- "close fd" construct is seen,
5224 * REDIRFD_SYNTAX_ERR if syntax error,
5225 * REDIRFD_TO_FILE if no & was seen,
5226 * or the number found.
5229 #define parse_redir_right_fd(as_string, input) \
5230 parse_redir_right_fd(input)
5232 static int parse_redir_right_fd(o_string *as_string, struct in_str *input)
5238 return REDIRFD_TO_FILE;
5240 ch = i_getch(input); /* get the & */
5241 nommu_addchr(as_string, ch);
5244 ch = i_getch(input);
5245 nommu_addchr(as_string, ch);
5246 return REDIRFD_CLOSE;
5250 while (ch != EOF && isdigit(ch)) {
5251 d = d*10 + (ch-'0');
5253 ch = i_getch(input);
5254 nommu_addchr(as_string, ch);
5259 //TODO: this is the place to catch ">&file" bashism (redirect both fd 1 and 2)
5261 bb_error_msg("ambiguous redirect");
5262 return REDIRFD_SYNTAX_ERR;
5265 /* Return code is 0 normal, 1 if a syntax error is detected
5267 static int parse_redirect(struct parse_context *ctx,
5270 struct in_str *input)
5272 struct command *command = ctx->command;
5273 struct redir_struct *redir;
5274 struct redir_struct **redirp;
5277 dup_num = REDIRFD_TO_FILE;
5278 if (style != REDIRECT_HEREDOC) {
5279 /* Check for a '>&1' type redirect */
5280 dup_num = parse_redir_right_fd(&ctx->as_string, input);
5281 if (dup_num == REDIRFD_SYNTAX_ERR)
5284 int ch = i_peek(input);
5285 dup_num = (ch == '-'); /* HEREDOC_SKIPTABS bit is 1 */
5286 if (dup_num) { /* <<-... */
5287 ch = i_getch(input);
5288 nommu_addchr(&ctx->as_string, ch);
5293 if (style == REDIRECT_OVERWRITE && dup_num == REDIRFD_TO_FILE) {
5294 int ch = i_peek(input);
5296 /* >|FILE redirect ("clobbering" >).
5297 * Since we do not support "set -o noclobber" yet,
5298 * >| and > are the same for now. Just eat |.
5300 ch = i_getch(input);
5301 nommu_addchr(&ctx->as_string, ch);
5305 /* Create a new redir_struct and append it to the linked list */
5306 redirp = &command->redirects;
5307 while ((redir = *redirp) != NULL) {
5308 redirp = &(redir->next);
5310 *redirp = redir = xzalloc(sizeof(*redir));
5311 /* redir->next = NULL; */
5312 /* redir->rd_filename = NULL; */
5313 redir->rd_type = style;
5314 redir->rd_fd = (fd == -1) ? redir_table[style].default_fd : fd;
5316 debug_printf_parse("redirect type %d %s\n", redir->rd_fd,
5317 redir_table[style].descrip);
5319 redir->rd_dup = dup_num;
5320 if (style != REDIRECT_HEREDOC && dup_num != REDIRFD_TO_FILE) {
5321 /* Erik had a check here that the file descriptor in question
5322 * is legit; I postpone that to "run time"
5323 * A "-" representation of "close me" shows up as a -3 here */
5324 debug_printf_parse("duplicating redirect '%d>&%d'\n",
5325 redir->rd_fd, redir->rd_dup);
5327 /* Set ctx->pending_redirect, so we know what to do at the
5328 * end of the next parsed word. */
5329 ctx->pending_redirect = redir;
5334 /* If a redirect is immediately preceded by a number, that number is
5335 * supposed to tell which file descriptor to redirect. This routine
5336 * looks for such preceding numbers. In an ideal world this routine
5337 * needs to handle all the following classes of redirects...
5338 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
5339 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
5340 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
5341 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
5343 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
5345 * ... If n is quoted, the number shall not be recognized as part of
5346 * the redirection expression. For example:
5348 * writes the character 2 into file a"
5349 * We are getting it right by setting ->o_quoted on any \<char>
5351 * A -1 return means no valid number was found,
5352 * the caller should use the appropriate default for this redirection.
5354 static int redirect_opt_num(o_string *o)
5358 if (o->data == NULL)
5360 num = bb_strtou(o->data, NULL, 10);
5361 if (errno || num < 0)
5363 o_reset_to_empty_unquoted(o);
5368 #define fetch_till_str(as_string, input, word, skip_tabs) \
5369 fetch_till_str(input, word, skip_tabs)
5371 static char *fetch_till_str(o_string *as_string,
5372 struct in_str *input,
5376 o_string heredoc = NULL_O_STRING;
5382 ch = i_getch(input);
5383 nommu_addchr(as_string, ch);
5385 if (strcmp(heredoc.data + past_EOL, word) == 0) {
5386 heredoc.data[past_EOL] = '\0';
5387 debug_printf_parse("parsed heredoc '%s'\n", heredoc.data);
5388 return heredoc.data;
5391 o_addchr(&heredoc, ch);
5392 past_EOL = heredoc.length;
5395 ch = i_getch(input);
5396 nommu_addchr(as_string, ch);
5397 } while (skip_tabs && ch == '\t');
5398 } while (ch == '\n');
5401 o_free_unsafe(&heredoc);
5404 o_addchr(&heredoc, ch);
5405 nommu_addchr(as_string, ch);
5409 /* Look at entire parse tree for not-yet-loaded REDIRECT_HEREDOCs
5410 * and load them all. There should be exactly heredoc_cnt of them.
5412 static int fetch_heredocs(int heredoc_cnt, struct parse_context *ctx, struct in_str *input)
5414 struct pipe *pi = ctx->list_head;
5416 while (pi && heredoc_cnt) {
5418 struct command *cmd = pi->cmds;
5420 debug_printf_parse("fetch_heredocs: num_cmds:%d cmd argv0:'%s'\n",
5422 cmd->argv ? cmd->argv[0] : "NONE");
5423 for (i = 0; i < pi->num_cmds; i++) {
5424 struct redir_struct *redir = cmd->redirects;
5426 debug_printf_parse("fetch_heredocs: %d cmd argv0:'%s'\n",
5427 i, cmd->argv ? cmd->argv[0] : "NONE");
5429 if (redir->rd_type == REDIRECT_HEREDOC) {
5432 redir->rd_type = REDIRECT_HEREDOC2;
5433 /* redir->rd_dup is (ab)used to indicate <<- */
5434 p = fetch_till_str(&ctx->as_string, input,
5435 redir->rd_filename, redir->rd_dup & HEREDOC_SKIPTABS);
5437 syntax_error("unexpected EOF in here document");
5440 free(redir->rd_filename);
5441 redir->rd_filename = p;
5444 redir = redir->next;
5451 /* Should be 0. If it isn't, it's a parse error */
5453 bb_error_msg_and_die("heredoc BUG 2");
5459 #if ENABLE_HUSH_TICK
5460 static FILE *generate_stream_from_string(const char *s, pid_t *pid_p)
5465 char **to_free = NULL;
5469 pid = BB_MMU ? fork() : vfork();
5471 bb_perror_msg_and_die(BB_MMU ? "fork" : "vfork");
5473 if (pid == 0) { /* child */
5474 disable_restore_tty_pgrp_on_exit();
5475 /* Process substitution is not considered to be usual
5476 * 'command execution'.
5477 * SUSv3 says ctrl-Z should be ignored, ctrl-C should not.
5484 CLEAR_RANDOM_T(&G.random_gen); /* or else $RANDOM repeats in child */
5485 close(channel[0]); /* NB: close _first_, then move fd! */
5486 xmove_fd(channel[1], 1);
5487 /* Prevent it from trying to handle ctrl-z etc */
5488 IF_HUSH_JOB(G.run_list_level = 1;)
5489 /* Awful hack for `trap` or $(trap).
5491 * http://www.opengroup.org/onlinepubs/009695399/utilities/trap.html
5492 * contains an example where "trap" is executed in a subshell:
5494 * save_traps=$(trap)
5496 * eval "$save_traps"
5498 * Standard does not say that "trap" in subshell shall print
5499 * parent shell's traps. It only says that its output
5500 * must have suitable form, but then, in the above example
5501 * (which is not supposed to be normative), it implies that.
5503 * bash (and probably other shell) does implement it
5504 * (traps are reset to defaults, but "trap" still shows them),
5505 * but as a result, "trap" logic is hopelessly messed up:
5508 * trap -- 'echo Ho' SIGWINCH <--- we have a handler
5509 * # (trap) <--- trap is in subshell - no output (correct, traps are reset)
5510 * # true | trap <--- trap is in subshell - no output (ditto)
5511 * # echo `true | trap` <--- in subshell - output (but traps are reset!)
5512 * trap -- 'echo Ho' SIGWINCH
5513 * # echo `(trap)` <--- in subshell in subshell - output
5514 * trap -- 'echo Ho' SIGWINCH
5515 * # echo `true | (trap)` <--- in subshell in subshell in subshell - output!
5516 * trap -- 'echo Ho' SIGWINCH
5518 * The rules when to forget and when to not forget traps
5519 * get really complex and nonsensical.
5521 * Our solution: ONLY bare $(trap) or `trap` is special.
5523 s = skip_whitespace(s);
5524 if (strncmp(s, "trap", 4) == 0 && (*skip_whitespace(s + 4) == '\0'))
5526 static const char *const argv[] = { NULL, NULL };
5527 builtin_trap((char**)argv);
5528 exit(0); /* not _exit() - we need to fflush */
5531 reset_traps_to_defaults();
5532 parse_and_run_string(s);
5533 _exit(G.last_exitcode);
5535 /* We re-execute after vfork on NOMMU. This makes this script safe:
5536 * yes "0123456789012345678901234567890" | dd bs=32 count=64k >BIG
5537 * huge=`cat BIG` # was blocking here forever
5540 re_execute_shell(&to_free,
5550 # if ENABLE_HUSH_FAST
5552 //bb_error_msg("[%d] fork in generate_stream_from_string: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
5554 enable_restore_tty_pgrp_on_exit();
5559 close_on_exec_on(channel[0]);
5560 return xfdopen_for_read(channel[0]);
5563 /* Return code is exit status of the process that is run. */
5564 static int process_command_subs(o_string *dest, const char *s)
5567 struct in_str pipe_str;
5569 int status, ch, eol_cnt;
5571 fp = generate_stream_from_string(s, &pid);
5573 /* Now send results of command back into original context */
5574 setup_file_in_str(&pipe_str, fp);
5576 while ((ch = i_getch(&pipe_str)) != EOF) {
5582 o_addchr(dest, '\n');
5585 o_addQchr(dest, ch);
5588 debug_printf("done reading from `cmd` pipe, closing it\n");
5590 /* We need to extract exitcode. Test case
5591 * "true; echo `sleep 1; false` $?"
5593 safe_waitpid(pid, &status, 0);
5594 debug_printf("child exited. returning its exitcode:%d\n", WEXITSTATUS(status));
5595 return WEXITSTATUS(status);
5597 #endif /* ENABLE_HUSH_TICK */
5599 #if !ENABLE_HUSH_FUNCTIONS
5600 #define parse_group(dest, ctx, input, ch) \
5601 parse_group(ctx, input, ch)
5603 static int parse_group(o_string *dest, struct parse_context *ctx,
5604 struct in_str *input, int ch)
5606 /* dest contains characters seen prior to ( or {.
5607 * Typically it's empty, but for function defs,
5608 * it contains function name (without '()'). */
5609 struct pipe *pipe_list;
5611 struct command *command = ctx->command;
5613 debug_printf_parse("parse_group entered\n");
5614 #if ENABLE_HUSH_FUNCTIONS
5615 if (ch == '(' && !dest->o_quoted) {
5617 if (done_word(dest, ctx))
5620 goto skip; /* (... */
5621 if (command->argv[1]) { /* word word ... (... */
5622 syntax_error_unexpected_ch('(');
5625 /* it is "word(..." or "word (..." */
5627 ch = i_getch(input);
5628 while (ch == ' ' || ch == '\t');
5630 syntax_error_unexpected_ch(ch);
5633 nommu_addchr(&ctx->as_string, ch);
5635 ch = i_getch(input);
5636 while (ch == ' ' || ch == '\t' || ch == '\n');
5638 syntax_error_unexpected_ch(ch);
5641 nommu_addchr(&ctx->as_string, ch);
5642 command->cmd_type = CMD_FUNCDEF;
5647 #if 0 /* Prevented by caller */
5648 if (command->argv /* word [word]{... */
5649 || dest->length /* word{... */
5650 || dest->o_quoted /* ""{... */
5653 debug_printf_parse("parse_group return 1: "
5654 "syntax error, groups and arglists don't mix\n");
5659 #if ENABLE_HUSH_FUNCTIONS
5665 command->cmd_type = CMD_SUBSHELL;
5667 /* bash does not allow "{echo...", requires whitespace */
5668 ch = i_getch(input);
5669 if (ch != ' ' && ch != '\t' && ch != '\n') {
5670 syntax_error_unexpected_ch(ch);
5673 nommu_addchr(&ctx->as_string, ch);
5678 char *as_string = NULL;
5680 pipe_list = parse_stream(&as_string, input, endch);
5683 o_addstr(&ctx->as_string, as_string);
5685 /* empty ()/{} or parse error? */
5686 if (!pipe_list || pipe_list == ERR_PTR) {
5687 /* parse_stream already emitted error msg */
5691 debug_printf_parse("parse_group return 1: "
5692 "parse_stream returned %p\n", pipe_list);
5695 command->group = pipe_list;
5697 as_string[strlen(as_string) - 1] = '\0'; /* plink ')' or '}' */
5698 command->group_as_string = as_string;
5699 debug_printf_parse("end of group, remembering as:'%s'\n",
5700 command->group_as_string);
5703 debug_printf_parse("parse_group return 0\n");
5705 /* command remains "open", available for possible redirects */
5708 #if ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT
5709 /* Subroutines for copying $(...) and `...` things */
5710 static void add_till_backquote(o_string *dest, struct in_str *input);
5712 static void add_till_single_quote(o_string *dest, struct in_str *input)
5715 int ch = i_getch(input);
5717 syntax_error_unterm_ch('\'');
5718 /*xfunc_die(); - redundant */
5725 /* "...\"...`..`...." - do we need to handle "...$(..)..." too? */
5726 static void add_till_double_quote(o_string *dest, struct in_str *input)
5729 int ch = i_getch(input);
5731 syntax_error_unterm_ch('"');
5732 /*xfunc_die(); - redundant */
5736 if (ch == '\\') { /* \x. Copy both chars. */
5738 ch = i_getch(input);
5742 add_till_backquote(dest, input);
5746 //if (ch == '$') ...
5749 /* Process `cmd` - copy contents until "`" is seen. Complicated by
5751 * "Within the backquoted style of command substitution, backslash
5752 * shall retain its literal meaning, except when followed by: '$', '`', or '\'.
5753 * The search for the matching backquote shall be satisfied by the first
5754 * backquote found without a preceding backslash; during this search,
5755 * if a non-escaped backquote is encountered within a shell comment,
5756 * a here-document, an embedded command substitution of the $(command)
5757 * form, or a quoted string, undefined results occur. A single-quoted
5758 * or double-quoted string that begins, but does not end, within the
5759 * "`...`" sequence produces undefined results."
5761 * echo `echo '\'TEST\`echo ZZ\`BEST` \TESTZZBEST
5763 static void add_till_backquote(o_string *dest, struct in_str *input)
5766 int ch = i_getch(input);
5768 syntax_error_unterm_ch('`');
5769 /*xfunc_die(); - redundant */
5774 /* \x. Copy both chars unless it is \` */
5775 int ch2 = i_getch(input);
5777 syntax_error_unterm_ch('`');
5778 /*xfunc_die(); - redundant */
5780 if (ch2 != '`' && ch2 != '$' && ch2 != '\\')
5787 /* Process $(cmd) - copy contents until ")" is seen. Complicated by
5788 * quoting and nested ()s.
5789 * "With the $(command) style of command substitution, all characters
5790 * following the open parenthesis to the matching closing parenthesis
5791 * constitute the command. Any valid shell script can be used for command,
5792 * except a script consisting solely of redirections which produces
5793 * unspecified results."
5795 * echo $(echo '(TEST)' BEST) (TEST) BEST
5796 * echo $(echo 'TEST)' BEST) TEST) BEST
5797 * echo $(echo \(\(TEST\) BEST) ((TEST) BEST
5799 static void add_till_closing_paren(o_string *dest, struct in_str *input, bool dbl)
5803 int ch = i_getch(input);
5805 syntax_error_unterm_ch(')');
5806 /*xfunc_die(); - redundant */
5814 if (i_peek(input) == ')') {
5822 add_till_single_quote(dest, input);
5827 add_till_double_quote(dest, input);
5832 /* \x. Copy verbatim. Important for \(, \) */
5833 ch = i_getch(input);
5835 syntax_error_unterm_ch(')');
5836 /*xfunc_die(); - redundant */
5843 #endif /* ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT */
5845 /* Return code: 0 for OK, 1 for syntax error */
5847 #define handle_dollar(as_string, dest, input) \
5848 handle_dollar(dest, input)
5850 static int handle_dollar(o_string *as_string,
5852 struct in_str *input)
5854 int ch = i_peek(input); /* first character after the $ */
5855 unsigned char quote_mask = dest->o_escape ? 0x80 : 0;
5857 debug_printf_parse("handle_dollar entered: ch='%c'\n", ch);
5859 ch = i_getch(input);
5860 nommu_addchr(as_string, ch);
5862 o_addchr(dest, SPECIAL_VAR_SYMBOL);
5864 debug_printf_parse(": '%c'\n", ch);
5865 o_addchr(dest, ch | quote_mask);
5868 if (!isalnum(ch) && ch != '_')
5870 ch = i_getch(input);
5871 nommu_addchr(as_string, ch);
5873 o_addchr(dest, SPECIAL_VAR_SYMBOL);
5874 } else if (isdigit(ch)) {
5876 ch = i_getch(input);
5877 nommu_addchr(as_string, ch);
5878 o_addchr(dest, SPECIAL_VAR_SYMBOL);
5879 debug_printf_parse(": '%c'\n", ch);
5880 o_addchr(dest, ch | quote_mask);
5881 o_addchr(dest, SPECIAL_VAR_SYMBOL);
5882 } else switch (ch) {
5884 case '!': /* last bg pid */
5885 case '?': /* last exit code */
5886 case '#': /* number of args */
5887 case '*': /* args */
5888 case '@': /* args */
5889 goto make_one_char_var;
5891 bool first_char, all_digits;
5894 ch = i_getch(input);
5895 nommu_addchr(as_string, ch);
5896 o_addchr(dest, SPECIAL_VAR_SYMBOL);
5898 /* TODO: maybe someone will try to escape the '}' */
5903 ch = i_getch(input);
5904 nommu_addchr(as_string, ch);
5911 /* ${#var}: length of var contents */
5918 /* They're being verbose and doing ${?} */
5919 if (i_peek(input) == '}' && strchr("$!?#*@_", ch))
5924 && ( (all_digits && !isdigit(ch))
5925 || (!all_digits && !isalnum(ch) && ch != '_')
5928 /* handle parameter expansions
5929 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_02
5934 case ':': /* null modifier */
5935 if (expansion == 0) {
5936 debug_printf_parse(": null modifier\n");
5941 case '#': /* remove prefix */
5942 case '%': /* remove suffix */
5943 if (expansion == 0) {
5944 debug_printf_parse(": remove suffix/prefix\n");
5949 case '-': /* default value */
5950 case '=': /* assign default */
5951 case '+': /* alternative */
5952 case '?': /* error indicate */
5953 debug_printf_parse(": parameter expansion\n");
5958 syntax_error_unterm_str("${name}");
5959 debug_printf_parse("handle_dollar return 1: unterminated ${name}\n");
5964 debug_printf_parse(": '%c'\n", ch);
5965 o_addchr(dest, ch | quote_mask);
5969 o_addchr(dest, SPECIAL_VAR_SYMBOL);
5972 #if ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_TICK
5977 ch = i_getch(input);
5978 nommu_addchr(as_string, ch);
5979 # if ENABLE_SH_MATH_SUPPORT
5980 if (i_peek(input) == '(') {
5981 ch = i_getch(input);
5982 nommu_addchr(as_string, ch);
5983 o_addchr(dest, SPECIAL_VAR_SYMBOL);
5984 o_addchr(dest, /*quote_mask |*/ '+');
5988 add_till_closing_paren(dest, input, true);
5991 o_addstr(as_string, dest->data + pos);
5992 o_addchr(as_string, ')');
5993 o_addchr(as_string, ')');
5996 o_addchr(dest, SPECIAL_VAR_SYMBOL);
6000 # if ENABLE_HUSH_TICK
6001 o_addchr(dest, SPECIAL_VAR_SYMBOL);
6002 o_addchr(dest, quote_mask | '`');
6006 add_till_closing_paren(dest, input, false);
6009 o_addstr(as_string, dest->data + pos);
6010 o_addchr(as_string, ')');
6013 o_addchr(dest, SPECIAL_VAR_SYMBOL);
6019 ch = i_getch(input);
6020 nommu_addchr(as_string, ch);
6022 if (isalnum(ch)) { /* it's $_name or $_123 */
6027 /* TODO: $_ and $-: */
6028 /* $_ Shell or shell script name; or last argument of last command
6029 * (if last command wasn't a pipe; if it was, bash sets $_ to "");
6030 * but in command's env, set to full pathname used to invoke it */
6031 /* $- Option flags set by set builtin or shell options (-i etc) */
6033 o_addQchr(dest, '$');
6035 debug_printf_parse("handle_dollar return 0\n");
6040 #define parse_stream_dquoted(as_string, dest, input, dquote_end) \
6041 parse_stream_dquoted(dest, input, dquote_end)
6043 static int parse_stream_dquoted(o_string *as_string,
6045 struct in_str *input,
6052 ch = i_getch(input);
6054 nommu_addchr(as_string, ch);
6055 if (ch == dquote_end) { /* may be only '"' or EOF */
6056 if (dest->o_assignment == NOT_ASSIGNMENT)
6057 dest->o_escape ^= 1;
6058 debug_printf_parse("parse_stream_dquoted return 0\n");
6061 /* note: can't move it above ch == dquote_end check! */
6063 syntax_error_unterm_ch('"');
6064 /*xfunc_die(); - redundant */
6068 next = i_peek(input);
6070 debug_printf_parse("\" ch=%c (%d) escape=%d\n",
6071 ch, ch, dest->o_escape);
6074 syntax_error("\\<eof>");
6078 * "The backslash retains its special meaning [in "..."]
6079 * only when followed by one of the following characters:
6080 * $, `, ", \, or <newline>. A double quote may be quoted
6081 * within double quotes by preceding it with a backslash."
6083 if (strchr("$`\"\\\n", next) != NULL) {
6084 ch = i_getch(input);
6086 o_addqchr(dest, ch);
6087 nommu_addchr(as_string, ch);
6090 o_addqchr(dest, '\\');
6091 nommu_addchr(as_string, '\\');
6096 if (handle_dollar(as_string, dest, input) != 0) {
6097 debug_printf_parse("parse_stream_dquoted return 1: "
6098 "handle_dollar returned non-0\n");
6103 #if ENABLE_HUSH_TICK
6105 //int pos = dest->length;
6106 o_addchr(dest, SPECIAL_VAR_SYMBOL);
6107 o_addchr(dest, 0x80 | '`');
6108 add_till_backquote(dest, input);
6109 o_addchr(dest, SPECIAL_VAR_SYMBOL);
6110 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
6114 o_addQchr(dest, ch);
6116 && (dest->o_assignment == MAYBE_ASSIGNMENT
6117 || dest->o_assignment == WORD_IS_KEYWORD)
6118 && is_well_formed_var_name(dest->data, '=')
6120 dest->o_assignment = DEFINITELY_ASSIGNMENT;
6126 * Scan input until EOF or end_trigger char.
6127 * Return a list of pipes to execute, or NULL on EOF
6128 * or if end_trigger character is met.
6129 * On syntax error, exit is shell is not interactive,
6130 * reset parsing machinery and start parsing anew,
6131 * or return ERR_PTR.
6133 static struct pipe *parse_stream(char **pstring,
6134 struct in_str *input,
6137 struct parse_context ctx;
6138 o_string dest = NULL_O_STRING;
6142 /* Double-quote state is handled in the state variable is_in_dquote.
6143 * A single-quote triggers a bypass of the main loop until its mate is
6144 * found. When recursing, quote state is passed in via dest->o_escape.
6146 debug_printf_parse("parse_stream entered, end_trigger='%c'\n",
6147 end_trigger ? end_trigger : 'X');
6150 /* If very first arg is "" or '', dest.data may end up NULL.
6151 * Preventing this: */
6152 o_addchr(&dest, '\0');
6155 G.ifs = get_local_var_value("IFS");
6160 #if ENABLE_HUSH_INTERACTIVE
6161 input->promptmode = 0; /* PS1 */
6163 /* dest.o_assignment = MAYBE_ASSIGNMENT; - already is */
6164 initialize_context(&ctx);
6169 const char *is_special;
6173 redir_type redir_style;
6176 /* dest.o_quoted = 1; - already is (see below) */
6177 if (parse_stream_dquoted(&ctx.as_string, &dest, input, '"')) {
6180 /* We reached closing '"' */
6183 ch = i_getch(input);
6184 debug_printf_parse(": ch=%c (%d) escape=%d\n",
6185 ch, ch, dest.o_escape);
6190 syntax_error_unterm_str("here document");
6193 /* end_trigger == '}' case errors out earlier,
6194 * checking only ')' */
6195 if (end_trigger == ')') {
6196 syntax_error_unterm_ch('('); /* exits */
6197 /* goto parse_error; */
6200 if (done_word(&dest, &ctx)) {
6204 done_pipe(&ctx, PIPE_SEQ);
6206 /* If we got nothing... */
6207 /* (this makes bare "&" cmd a no-op.
6208 * bash says: "syntax error near unexpected token '&'") */
6209 if (pi->num_cmds == 0
6210 IF_HAS_KEYWORDS( && pi->res_word == RES_NONE)
6216 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
6218 *pstring = ctx.as_string.data;
6220 o_free_unsafe(&ctx.as_string);
6223 debug_printf_parse("parse_stream return %p\n", pi);
6226 nommu_addchr(&ctx.as_string, ch);
6230 next = i_peek(input);
6232 is_special = "{}<>;&|()#'" /* special outside of "str" */
6233 "\\$\"" IF_HUSH_TICK("`"); /* always special */
6234 /* Are { and } special here? */
6235 if (ctx.command->argv /* word [word]{... */
6236 || dest.length /* word{... */
6237 || dest.o_quoted /* ""{... */
6238 || (next != ';' && next != ')' && !strchr(G.ifs, next)) /* {word */
6240 /* They are not special, skip "{}" */
6243 is_special = strchr(is_special, ch);
6244 is_ifs = strchr(G.ifs, ch);
6246 if (!is_special && !is_ifs) { /* ordinary char */
6248 o_addQchr(&dest, ch);
6249 if ((dest.o_assignment == MAYBE_ASSIGNMENT
6250 || dest.o_assignment == WORD_IS_KEYWORD)
6252 && is_well_formed_var_name(dest.data, '=')
6254 dest.o_assignment = DEFINITELY_ASSIGNMENT;
6260 if (done_word(&dest, &ctx)) {
6264 #if ENABLE_HUSH_CASE
6265 /* "case ... in <newline> word) ..." -
6266 * newlines are ignored (but ';' wouldn't be) */
6267 if (ctx.command->argv == NULL
6268 && ctx.ctx_res_w == RES_MATCH
6273 /* Treat newline as a command separator. */
6274 done_pipe(&ctx, PIPE_SEQ);
6275 debug_printf_parse("heredoc_cnt:%d\n", heredoc_cnt);
6277 if (fetch_heredocs(heredoc_cnt, &ctx, input)) {
6282 dest.o_assignment = MAYBE_ASSIGNMENT;
6284 /* note: if (is_ifs) continue;
6285 * will still trigger for us */
6289 /* "cmd}" or "cmd }..." without semicolon or &:
6290 * } is an ordinary char in this case, even inside { cmd; }
6291 * Pathological example: { ""}; } should exec "}" cmd
6294 if (!IS_NULL_CMD(ctx.command) /* cmd } */
6295 || dest.length != 0 /* word} */
6296 || dest.o_quoted /* ""} */
6300 if (!IS_NULL_PIPE(ctx.pipe)) /* cmd | } */
6301 goto skip_end_trigger;
6302 /* else: } does terminate a group */
6305 if (end_trigger && end_trigger == ch
6306 && (ch != ';' || heredoc_cnt == 0)
6307 #if ENABLE_HUSH_CASE
6309 || ctx.ctx_res_w != RES_MATCH
6310 || (!dest.o_quoted && strcmp(dest.data, "esac") == 0)
6315 /* This is technically valid:
6316 * { cat <<HERE; }; echo Ok
6320 * but we don't support this.
6321 * We require heredoc to be in enclosing {}/(),
6324 syntax_error_unterm_str("here document");
6327 if (done_word(&dest, &ctx)) {
6330 done_pipe(&ctx, PIPE_SEQ);
6331 dest.o_assignment = MAYBE_ASSIGNMENT;
6332 /* Do we sit outside of any if's, loops or case's? */
6334 IF_HAS_KEYWORDS(|| (ctx.ctx_res_w == RES_NONE && ctx.old_flag == 0))
6338 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
6340 *pstring = ctx.as_string.data;
6342 o_free_unsafe(&ctx.as_string);
6345 debug_printf_parse("parse_stream return %p: "
6346 "end_trigger char found\n",
6348 return ctx.list_head;
6355 /* Catch <, > before deciding whether this word is
6356 * an assignment. a=1 2>z b=2: b=2 is still assignment */
6359 redir_fd = redirect_opt_num(&dest);
6360 if (done_word(&dest, &ctx)) {
6363 redir_style = REDIRECT_OVERWRITE;
6365 redir_style = REDIRECT_APPEND;
6366 ch = i_getch(input);
6367 nommu_addchr(&ctx.as_string, ch);
6370 else if (next == '(') {
6371 syntax_error(">(process) not supported");
6375 if (parse_redirect(&ctx, redir_fd, redir_style, input))
6377 continue; /* back to top of while (1) */
6379 redir_fd = redirect_opt_num(&dest);
6380 if (done_word(&dest, &ctx)) {
6383 redir_style = REDIRECT_INPUT;
6385 redir_style = REDIRECT_HEREDOC;
6387 debug_printf_parse("++heredoc_cnt=%d\n", heredoc_cnt);
6388 ch = i_getch(input);
6389 nommu_addchr(&ctx.as_string, ch);
6390 } else if (next == '>') {
6391 redir_style = REDIRECT_IO;
6392 ch = i_getch(input);
6393 nommu_addchr(&ctx.as_string, ch);
6396 else if (next == '(') {
6397 syntax_error("<(process) not supported");
6401 if (parse_redirect(&ctx, redir_fd, redir_style, input))
6403 continue; /* back to top of while (1) */
6406 if (dest.o_assignment == MAYBE_ASSIGNMENT
6407 /* check that we are not in word in "a=1 2>word b=1": */
6408 && !ctx.pending_redirect
6410 /* ch is a special char and thus this word
6411 * cannot be an assignment */
6412 dest.o_assignment = NOT_ASSIGNMENT;
6415 /* Note: nommu_addchr(&ctx.as_string, ch) is already done */
6419 if (dest.length == 0) {
6422 if (ch == EOF || ch == '\n')
6425 /* note: we do not add it to &ctx.as_string */
6427 nommu_addchr(&ctx.as_string, '\n');
6429 o_addQchr(&dest, ch);
6434 syntax_error("\\<eof>");
6437 ch = i_getch(input);
6439 o_addchr(&dest, '\\');
6440 /*nommu_addchr(&ctx.as_string, '\\'); - already done */
6441 o_addchr(&dest, ch);
6442 nommu_addchr(&ctx.as_string, ch);
6443 /* Example: echo Hello \2>file
6444 * we need to know that word 2 is quoted */
6449 /* It's "\<newline>". Remove trailing '\' from ctx.as_string */
6450 ctx.as_string.data[--ctx.as_string.length] = '\0';
6455 if (handle_dollar(&ctx.as_string, &dest, input) != 0) {
6456 debug_printf_parse("parse_stream parse error: "
6457 "handle_dollar returned non-0\n");
6464 ch = i_getch(input);
6466 syntax_error_unterm_ch('\'');
6467 /*xfunc_die(); - redundant */
6469 nommu_addchr(&ctx.as_string, ch);
6472 o_addqchr(&dest, ch);
6477 is_in_dquote ^= 1; /* invert */
6478 if (dest.o_assignment == NOT_ASSIGNMENT)
6481 #if ENABLE_HUSH_TICK
6486 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
6487 o_addchr(&dest, '`');
6491 add_till_backquote(&dest, input);
6493 o_addstr(&ctx.as_string, dest.data + pos);
6494 o_addchr(&ctx.as_string, '`');
6496 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
6497 //debug_printf_subst("SUBST RES3 '%s'\n", dest.data + pos);
6502 #if ENABLE_HUSH_CASE
6505 if (done_word(&dest, &ctx)) {
6508 done_pipe(&ctx, PIPE_SEQ);
6509 #if ENABLE_HUSH_CASE
6510 /* Eat multiple semicolons, detect
6511 * whether it means something special */
6516 ch = i_getch(input);
6517 nommu_addchr(&ctx.as_string, ch);
6518 if (ctx.ctx_res_w == RES_CASE_BODY) {
6519 ctx.ctx_dsemicolon = 1;
6520 ctx.ctx_res_w = RES_MATCH;
6526 /* We just finished a cmd. New one may start
6527 * with an assignment */
6528 dest.o_assignment = MAYBE_ASSIGNMENT;
6531 if (done_word(&dest, &ctx)) {
6535 ch = i_getch(input);
6536 nommu_addchr(&ctx.as_string, ch);
6537 done_pipe(&ctx, PIPE_AND);
6539 done_pipe(&ctx, PIPE_BG);
6543 if (done_word(&dest, &ctx)) {
6546 #if ENABLE_HUSH_CASE
6547 if (ctx.ctx_res_w == RES_MATCH)
6548 break; /* we are in case's "word | word)" */
6550 if (next == '|') { /* || */
6551 ch = i_getch(input);
6552 nommu_addchr(&ctx.as_string, ch);
6553 done_pipe(&ctx, PIPE_OR);
6555 /* we could pick up a file descriptor choice here
6556 * with redirect_opt_num(), but bash doesn't do it.
6557 * "echo foo 2| cat" yields "foo 2". */
6560 o_reset_to_empty_unquoted(&ctx.as_string);
6565 #if ENABLE_HUSH_CASE
6566 /* "case... in [(]word)..." - skip '(' */
6567 if (ctx.ctx_res_w == RES_MATCH
6568 && ctx.command->argv == NULL /* not (word|(... */
6569 && dest.length == 0 /* not word(... */
6570 && dest.o_quoted == 0 /* not ""(... */
6576 if (parse_group(&dest, &ctx, input, ch) != 0) {
6581 #if ENABLE_HUSH_CASE
6582 if (ctx.ctx_res_w == RES_MATCH)
6586 /* proper use of this character is caught by end_trigger:
6587 * if we see {, we call parse_group(..., end_trigger='}')
6588 * and it will match } earlier (not here). */
6589 syntax_error_unexpected_ch(ch);
6593 bb_error_msg_and_die("BUG: unexpected %c\n", ch);
6599 struct parse_context *pctx;
6600 IF_HAS_KEYWORDS(struct parse_context *p2;)
6602 /* Clean up allocated tree.
6603 * Sample for finding leaks on syntax error recovery path.
6604 * Run it from interactive shell, watch pmap `pidof hush`.
6605 * while if false; then false; fi; do break; fi
6606 * Samples to catch leaks at execution:
6607 * while if (true | {true;}); then echo ok; fi; do break; done
6608 * while if (true | {true;}); then echo ok; fi; do (if echo ok; break; then :; fi) | cat; break; done
6612 /* Update pipe/command counts,
6613 * otherwise freeing may miss some */
6614 done_pipe(pctx, PIPE_SEQ);
6615 debug_printf_clean("freeing list %p from ctx %p\n",
6616 pctx->list_head, pctx);
6617 debug_print_tree(pctx->list_head, 0);
6618 free_pipe_list(pctx->list_head);
6619 debug_printf_clean("freed list %p\n", pctx->list_head);
6621 o_free_unsafe(&pctx->as_string);
6623 IF_HAS_KEYWORDS(p2 = pctx->stack;)
6627 IF_HAS_KEYWORDS(pctx = p2;)
6628 } while (HAS_KEYWORDS && pctx);
6629 /* Free text, clear all dest fields */
6631 /* If we are not in top-level parse, we return,
6632 * our caller will propagate error.
6634 if (end_trigger != ';') {
6642 /* Discard cached input, force prompt */
6644 IF_HUSH_INTERACTIVE(input->promptme = 1;)
6649 /* Executing from string: eval, sh -c '...'
6650 * or from file: /etc/profile, . file, sh <script>, sh (intereactive)
6651 * end_trigger controls how often we stop parsing
6652 * NUL: parse all, execute, return
6653 * ';': parse till ';' or newline, execute, repeat till EOF
6655 static void parse_and_run_stream(struct in_str *inp, int end_trigger)
6657 /* Why we need empty flag?
6658 * An obscure corner case "false; ``; echo $?":
6659 * empty command in `` should still set $? to 0.
6660 * But we can't just set $? to 0 at the start,
6661 * this breaks "false; echo `echo $?`" case.
6665 struct pipe *pipe_list;
6667 pipe_list = parse_stream(NULL, inp, end_trigger);
6668 if (!pipe_list) { /* EOF */
6670 G.last_exitcode = 0;
6673 debug_print_tree(pipe_list, 0);
6674 debug_printf_exec("parse_and_run_stream: run_and_free_list\n");
6675 run_and_free_list(pipe_list);
6680 static void parse_and_run_string(const char *s)
6682 struct in_str input;
6683 setup_string_in_str(&input, s);
6684 parse_and_run_stream(&input, '\0');
6687 static void parse_and_run_file(FILE *f)
6689 struct in_str input;
6690 setup_file_in_str(&input, f);
6691 parse_and_run_stream(&input, ';');
6694 /* Called a few times only (or even once if "sh -c") */
6695 static void init_sigmasks(void)
6699 sigset_t old_blocked_set;
6701 if (!G.inherited_set_is_saved) {
6702 sigprocmask(SIG_SETMASK, NULL, &G.blocked_set);
6703 G.inherited_set = G.blocked_set;
6705 old_blocked_set = G.blocked_set;
6707 mask = (1 << SIGQUIT);
6708 if (G_interactive_fd) {
6709 mask = (1 << SIGQUIT) | SPECIAL_INTERACTIVE_SIGS;
6710 if (G_saved_tty_pgrp) /* we have ctty, job control sigs work */
6711 mask |= SPECIAL_JOB_SIGS;
6713 G.non_DFL_mask = mask;
6718 sigaddset(&G.blocked_set, sig);
6722 sigdelset(&G.blocked_set, SIGCHLD);
6724 if (memcmp(&old_blocked_set, &G.blocked_set, sizeof(old_blocked_set)) != 0)
6725 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
6727 /* POSIX allows shell to re-enable SIGCHLD
6728 * even if it was SIG_IGN on entry */
6729 #if ENABLE_HUSH_FAST
6730 G.count_SIGCHLD++; /* ensure it is != G.handled_SIGCHLD */
6731 if (!G.inherited_set_is_saved)
6732 signal(SIGCHLD, SIGCHLD_handler);
6734 if (!G.inherited_set_is_saved)
6735 signal(SIGCHLD, SIG_DFL);
6738 G.inherited_set_is_saved = 1;
6743 static void maybe_set_to_sigexit(int sig)
6745 void (*handler)(int);
6746 /* non_DFL_mask'ed signals are, well, masked,
6747 * no need to set handler for them.
6749 if (!((G.non_DFL_mask >> sig) & 1)) {
6750 handler = signal(sig, sigexit);
6751 if (handler == SIG_IGN) /* oops... restore back to IGN! */
6752 signal(sig, handler);
6755 /* Set handlers to restore tty pgrp and exit */
6756 static void set_fatal_handlers(void)
6758 /* We _must_ restore tty pgrp on fatal signals */
6760 maybe_set_to_sigexit(SIGILL );
6761 maybe_set_to_sigexit(SIGFPE );
6762 maybe_set_to_sigexit(SIGBUS );
6763 maybe_set_to_sigexit(SIGSEGV);
6764 maybe_set_to_sigexit(SIGTRAP);
6765 } /* else: hush is perfect. what SEGV? */
6766 maybe_set_to_sigexit(SIGABRT);
6767 /* bash 3.2 seems to handle these just like 'fatal' ones */
6768 maybe_set_to_sigexit(SIGPIPE);
6769 maybe_set_to_sigexit(SIGALRM);
6770 /* if we are interactive, SIGHUP, SIGTERM and SIGINT are masked.
6771 * if we aren't interactive... but in this case
6772 * we never want to restore pgrp on exit, and this fn is not called */
6773 /*maybe_set_to_sigexit(SIGHUP );*/
6774 /*maybe_set_to_sigexit(SIGTERM);*/
6775 /*maybe_set_to_sigexit(SIGINT );*/
6779 static int set_mode(const char cstate, const char mode)
6781 int state = (cstate == '-' ? 1 : 0);
6783 case 'n': G.fake_mode = state; break;
6784 case 'x': /*G.debug_mode = state;*/ break;
6785 default: return EXIT_FAILURE;
6787 return EXIT_SUCCESS;
6790 int hush_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
6791 int hush_main(int argc, char **argv)
6793 static const struct variable const_shell_ver = {
6795 .varstr = (char*)hush_version_str,
6796 .max_len = 1, /* 0 can provoke free(name) */
6801 unsigned builtin_argc;
6803 struct variable *cur_var;
6806 if (EXIT_SUCCESS) /* if EXIT_SUCCESS == 0, is already done */
6807 G.last_exitcode = EXIT_SUCCESS;
6809 G.argv0_for_re_execing = argv[0];
6811 /* Deal with HUSH_VERSION */
6812 G.shell_ver = const_shell_ver; /* copying struct here */
6813 G.top_var = &G.shell_ver;
6814 debug_printf_env("unsetenv '%s'\n", "HUSH_VERSION");
6815 unsetenv("HUSH_VERSION"); /* in case it exists in initial env */
6816 /* Initialize our shell local variables with the values
6817 * currently living in the environment */
6818 cur_var = G.top_var;
6821 char *value = strchr(*e, '=');
6822 if (value) { /* paranoia */
6823 cur_var->next = xzalloc(sizeof(*cur_var));
6824 cur_var = cur_var->next;
6825 cur_var->varstr = *e;
6826 cur_var->max_len = strlen(*e);
6827 cur_var->flg_export = 1;
6831 /* reinstate HUSH_VERSION */
6832 debug_printf_env("putenv '%s'\n", hush_version_str);
6833 putenv((char *)hush_version_str);
6836 set_pwd_var(/*exp:*/ 1);
6837 /* bash also exports SHLVL and _,
6838 * and sets (but doesn't export) the following variables:
6840 * BASH_VERSINFO=([0]="3" [1]="2" [2]="0" [3]="1" [4]="release" [5]="i386-pc-linux-gnu")
6841 * BASH_VERSION='3.2.0(1)-release'
6843 * MACHTYPE=i386-pc-linux-gnu
6845 * HOSTNAME=<xxxxxxxxxx>
6846 * PPID=<NNNNN> - we also do it elsewhere
6857 * PIPESTATUS=([0]="0")
6858 * HISTFILE=/<xxx>/.bash_history
6862 * PATH=/usr/gnu/bin:/usr/local/bin:/bin:/usr/bin:.
6864 * SHELLOPTS=braceexpand:emacs:hashall:histexpand:history:interactive-comments:monitor
6874 #if ENABLE_FEATURE_EDITING
6875 G.line_input_state = new_line_input_t(FOR_SHELL);
6877 G.global_argc = argc;
6878 G.global_argv = argv;
6879 /* Initialize some more globals to non-zero values */
6880 cmdedit_update_prompt();
6882 if (setjmp(die_jmp)) {
6883 /* xfunc has failed! die die die */
6884 /* no EXIT traps, this is an escape hatch! */
6886 hush_exit(xfunc_error_retval);
6889 /* Shell is non-interactive at first. We need to call
6890 * init_sigmasks() if we are going to execute "sh <script>",
6891 * "sh -c <cmds>" or login shell's /etc/profile and friends.
6892 * If we later decide that we are interactive, we run init_sigmasks()
6893 * in order to intercept (more) signals.
6897 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/sh.html */
6900 opt = getopt(argc, argv, "+c:xins"
6903 # if ENABLE_HUSH_FUNCTIONS
6913 * sh ... -c 'script'
6914 * sh ... -c 'script' ARG0 [ARG1...]
6915 * On NOMMU, if builtin_argc != 0,
6916 * sh ... -c 'builtin' [BARGV...] "" ARG0 [ARG1...]
6917 * "" needs to be replaced with NULL
6918 * and BARGV vector fed to builtin function.
6919 * Note: this form never happens:
6920 * sh ... -c 'builtin' [BARGV...] ""
6923 G.root_pid = getpid();
6924 G.root_ppid = getppid();
6926 G.global_argv = argv + optind;
6927 G.global_argc = argc - optind;
6929 /* -c 'builtin' [BARGV...] "" ARG0 [ARG1...] */
6930 const struct built_in_command *x;
6933 x = find_builtin(optarg);
6934 if (x) { /* paranoia */
6935 G.global_argc -= builtin_argc; /* skip [BARGV...] "" */
6936 G.global_argv += builtin_argc;
6937 G.global_argv[-1] = NULL; /* replace "" */
6938 G.last_exitcode = x->function(argv + optind - 1);
6942 if (!G.global_argv[0]) {
6943 /* -c 'script' (no params): prevent empty $0 */
6944 G.global_argv--; /* points to argv[i] of 'script' */
6945 G.global_argv[0] = argv[0];
6947 } /* else -c 'script' ARG0 [ARG1...]: $0 is ARG0 */
6949 parse_and_run_string(optarg);
6952 /* Well, we cannot just declare interactiveness,
6953 * we have to have some stuff (ctty, etc) */
6954 /* G_interactive_fd++; */
6957 /* "-s" means "read from stdin", but this is how we always
6958 * operate, so simply do nothing here. */
6961 case '<': /* "big heredoc" support */
6962 full_write(STDOUT_FILENO, optarg, strlen(optarg));
6965 unsigned long long empty_trap_mask;
6967 G.root_pid = bb_strtou(optarg, &optarg, 16);
6969 G.root_ppid = bb_strtou(optarg, &optarg, 16);
6971 G.last_bg_pid = bb_strtou(optarg, &optarg, 16);
6973 G.last_exitcode = bb_strtou(optarg, &optarg, 16);
6975 builtin_argc = bb_strtou(optarg, &optarg, 16);
6977 empty_trap_mask = bb_strtoull(optarg, &optarg, 16);
6978 if (empty_trap_mask != 0) {
6981 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
6982 for (sig = 1; sig < NSIG; sig++) {
6983 if (empty_trap_mask & (1LL << sig)) {
6984 G.traps[sig] = xzalloc(1); /* == xstrdup(""); */
6985 sigaddset(&G.blocked_set, sig);
6988 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
6990 # if ENABLE_HUSH_LOOPS
6992 G.depth_of_loop = bb_strtou(optarg, &optarg, 16);
6998 set_local_var(xstrdup(optarg), /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ opt == 'R');
7000 # if ENABLE_HUSH_FUNCTIONS
7002 struct function *funcp = new_function(optarg);
7003 /* funcp->name is already set to optarg */
7004 /* funcp->body is set to NULL. It's a special case. */
7005 funcp->body_as_string = argv[optind];
7013 if (!set_mode('-', opt))
7017 fprintf(stderr, "Usage: sh [FILE]...\n"
7018 " or: sh -c command [args]...\n\n");
7024 } /* option parsing loop */
7027 G.root_pid = getpid();
7028 G.root_ppid = getppid();
7031 /* If we are login shell... */
7032 if (argv[0] && argv[0][0] == '-') {
7034 debug_printf("sourcing /etc/profile\n");
7035 input = fopen_for_read("/etc/profile");
7036 if (input != NULL) {
7037 close_on_exec_on(fileno(input));
7039 parse_and_run_file(input);
7042 /* bash: after sourcing /etc/profile,
7043 * tries to source (in the given order):
7044 * ~/.bash_profile, ~/.bash_login, ~/.profile,
7045 * stopping on first found. --noprofile turns this off.
7046 * bash also sources ~/.bash_logout on exit.
7047 * If called as sh, skips .bash_XXX files.
7054 * "bash <script>" (which is never interactive (unless -i?))
7055 * sources $BASH_ENV here (without scanning $PATH).
7056 * If called as sh, does the same but with $ENV.
7058 debug_printf("running script '%s'\n", argv[optind]);
7059 G.global_argv = argv + optind;
7060 G.global_argc = argc - optind;
7061 input = xfopen_for_read(argv[optind]);
7062 close_on_exec_on(fileno(input));
7064 parse_and_run_file(input);
7065 #if ENABLE_FEATURE_CLEAN_UP
7071 /* Up to here, shell was non-interactive. Now it may become one.
7072 * NB: don't forget to (re)run init_sigmasks() as needed.
7075 /* A shell is interactive if the '-i' flag was given,
7076 * or if all of the following conditions are met:
7078 * no arguments remaining or the -s flag given
7079 * standard input is a terminal
7080 * standard output is a terminal
7081 * Refer to Posix.2, the description of the 'sh' utility.
7084 if (isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)) {
7085 G_saved_tty_pgrp = tcgetpgrp(STDIN_FILENO);
7086 debug_printf("saved_tty_pgrp:%d\n", G_saved_tty_pgrp);
7087 if (G_saved_tty_pgrp < 0)
7088 G_saved_tty_pgrp = 0;
7090 /* try to dup stdin to high fd#, >= 255 */
7091 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
7092 if (G_interactive_fd < 0) {
7093 /* try to dup to any fd */
7094 G_interactive_fd = dup(STDIN_FILENO);
7095 if (G_interactive_fd < 0) {
7097 G_interactive_fd = 0;
7098 G_saved_tty_pgrp = 0;
7101 // TODO: track & disallow any attempts of user
7102 // to (inadvertently) close/redirect G_interactive_fd
7104 debug_printf("interactive_fd:%d\n", G_interactive_fd);
7105 if (G_interactive_fd) {
7106 close_on_exec_on(G_interactive_fd);
7108 if (G_saved_tty_pgrp) {
7109 /* If we were run as 'hush &', sleep until we are
7110 * in the foreground (tty pgrp == our pgrp).
7111 * If we get started under a job aware app (like bash),
7112 * make sure we are now in charge so we don't fight over
7113 * who gets the foreground */
7115 pid_t shell_pgrp = getpgrp();
7116 G_saved_tty_pgrp = tcgetpgrp(G_interactive_fd);
7117 if (G_saved_tty_pgrp == shell_pgrp)
7119 /* send TTIN to ourself (should stop us) */
7120 kill(- shell_pgrp, SIGTTIN);
7124 /* Block some signals */
7127 if (G_saved_tty_pgrp) {
7128 /* Set other signals to restore saved_tty_pgrp */
7129 set_fatal_handlers();
7130 /* Put ourselves in our own process group
7131 * (bash, too, does this only if ctty is available) */
7132 bb_setpgrp(); /* is the same as setpgid(our_pid, our_pid); */
7133 /* Grab control of the terminal */
7134 tcsetpgrp(G_interactive_fd, getpid());
7136 /* -1 is special - makes xfuncs longjmp, not exit
7137 * (we reset die_sleep = 0 whereever we [v]fork) */
7138 enable_restore_tty_pgrp_on_exit(); /* sets die_sleep = -1 */
7142 #elif ENABLE_HUSH_INTERACTIVE
7143 /* No job control compiled in, only prompt/line editing */
7144 if (isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)) {
7145 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
7146 if (G_interactive_fd < 0) {
7147 /* try to dup to any fd */
7148 G_interactive_fd = dup(STDIN_FILENO);
7149 if (G_interactive_fd < 0)
7151 G_interactive_fd = 0;
7154 if (G_interactive_fd) {
7155 close_on_exec_on(G_interactive_fd);
7159 /* We have interactiveness code disabled */
7163 * if interactive but not a login shell, sources ~/.bashrc
7164 * (--norc turns this off, --rcfile <file> overrides)
7167 if (!ENABLE_FEATURE_SH_EXTRA_QUIET && G_interactive_fd) {
7168 /* note: ash and hush share this string */
7169 printf("\n\n%s %s\n"
7170 IF_HUSH_HELP("Enter 'help' for a list of built-in commands.\n")
7173 "hush - the humble shell"
7177 parse_and_run_file(stdin);
7180 #if ENABLE_FEATURE_CLEAN_UP
7181 if (G.cwd != bb_msg_unknown)
7183 cur_var = G.top_var->next;
7185 struct variable *tmp = cur_var;
7186 if (!cur_var->max_len)
7187 free(cur_var->varstr);
7188 cur_var = cur_var->next;
7192 hush_exit(G.last_exitcode);
7197 int lash_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
7198 int lash_main(int argc, char **argv)
7200 bb_error_msg("lash is deprecated, please use hush instead");
7201 return hush_main(argc, argv);
7206 int msh_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
7207 int msh_main(int argc, char **argv)
7209 //bb_error_msg("msh is deprecated, please use hush instead");
7210 return hush_main(argc, argv);
7218 static int FAST_FUNC builtin_true(char **argv UNUSED_PARAM)
7223 static int run_applet_main(char **argv, int (*applet_main_func)(int argc, char **argv))
7230 return applet_main_func(argc, argv - argc);
7233 static int FAST_FUNC builtin_test(char **argv)
7235 return run_applet_main(argv, test_main);
7238 static int FAST_FUNC builtin_echo(char **argv)
7240 return run_applet_main(argv, echo_main);
7244 static int FAST_FUNC builtin_printf(char **argv)
7246 return run_applet_main(argv, printf_main);
7250 static int FAST_FUNC builtin_eval(char **argv)
7252 int rcode = EXIT_SUCCESS;
7255 char *str = expand_strvec_to_string(argv);
7257 * eval "echo Hi; done" ("done" is syntax error):
7258 * "echo Hi" will not execute too.
7260 parse_and_run_string(str);
7262 rcode = G.last_exitcode;
7267 static int FAST_FUNC builtin_cd(char **argv)
7269 const char *newdir = argv[1];
7270 if (newdir == NULL) {
7271 /* bash does nothing (exitcode 0) if HOME is ""; if it's unset,
7272 * bash says "bash: cd: HOME not set" and does nothing
7275 const char *home = get_local_var_value("HOME");
7276 newdir = home ? home : "/";
7278 if (chdir(newdir)) {
7279 /* Mimic bash message exactly */
7280 bb_perror_msg("cd: %s", newdir);
7281 return EXIT_FAILURE;
7283 /* Read current dir (get_cwd(1) is inside) and set PWD.
7284 * Note: do not enforce exporting. If PWD was unset or unexported,
7285 * set it again, but do not export. bash does the same.
7287 set_pwd_var(/*exp:*/ 0);
7288 return EXIT_SUCCESS;
7291 static int FAST_FUNC builtin_exec(char **argv)
7293 if (*++argv == NULL)
7294 return EXIT_SUCCESS; /* bash does this */
7296 /* Careful: we can end up here after [v]fork. Do not restore
7297 * tty pgrp then, only top-level shell process does that */
7298 if (G_saved_tty_pgrp && getpid() == G.root_pid)
7299 tcsetpgrp(G_interactive_fd, G_saved_tty_pgrp);
7301 /* TODO: if exec fails, bash does NOT exit! We do.
7302 * We'll need to undo sigprocmask (it's inside execvp_or_die)
7303 * and tcsetpgrp, and this is inherently racy.
7305 execvp_or_die(argv);
7308 static int FAST_FUNC builtin_exit(char **argv)
7310 debug_printf_exec("%s()\n", __func__);
7312 /* interactive bash:
7313 * # trap "echo EEE" EXIT
7316 * There are stopped jobs.
7317 * (if there are _stopped_ jobs, running ones don't count)
7320 # EEE (then bash exits)
7322 * we can use G.exiting = -1 as indicator "last cmd was exit"
7325 /* note: EXIT trap is run by hush_exit */
7326 if (*++argv == NULL)
7327 hush_exit(G.last_exitcode);
7328 /* mimic bash: exit 123abc == exit 255 + error msg */
7329 xfunc_error_retval = 255;
7330 /* bash: exit -2 == exit 254, no error msg */
7331 hush_exit(xatoi(*argv) & 0xff);
7334 static void print_escaped(const char *s)
7339 const char *p = strchrnul(s, '\'');
7340 /* print 'xxxx', possibly just '' */
7341 printf("'%.*s'", (int)(p - s), s);
7346 /* s points to '; print "'''...'''" */
7348 do putchar('\''); while (*++s == '\'');
7353 #if !ENABLE_HUSH_LOCAL
7354 #define helper_export_local(argv, exp, lvl) \
7355 helper_export_local(argv, exp)
7357 static void helper_export_local(char **argv, int exp, int lvl)
7362 /* So far we do not check that name is valid (TODO?) */
7364 if (strchr(name, '=') == NULL) {
7365 struct variable *var;
7367 var = get_local_var(name);
7368 if (exp == -1) { /* unexporting? */
7369 /* export -n NAME (without =VALUE) */
7371 var->flg_export = 0;
7372 debug_printf_env("%s: unsetenv '%s'\n", __func__, name);
7374 } /* else: export -n NOT_EXISTING_VAR: no-op */
7377 if (exp == 1) { /* exporting? */
7378 /* export NAME (without =VALUE) */
7380 var->flg_export = 1;
7381 debug_printf_env("%s: putenv '%s'\n", __func__, var->varstr);
7382 putenv(var->varstr);
7386 /* Exporting non-existing variable.
7387 * bash does not put it in environment,
7388 * but remembers that it is exported,
7389 * and does put it in env when it is set later.
7390 * We just set it to "" and export. */
7391 /* Or, it's "local NAME" (without =VALUE).
7392 * bash sets the value to "". */
7393 name = xasprintf("%s=", name);
7395 /* (Un)exporting/making local NAME=VALUE */
7396 name = xstrdup(name);
7398 set_local_var(name, /*exp:*/ exp, /*lvl:*/ lvl, /*ro:*/ 0);
7402 static int FAST_FUNC builtin_export(char **argv)
7404 unsigned opt_unexport;
7406 #if ENABLE_HUSH_EXPORT_N
7407 /* "!": do not abort on errors */
7408 opt_unexport = getopt32(argv, "!n");
7409 if (opt_unexport == (uint32_t)-1)
7410 return EXIT_FAILURE;
7417 if (argv[0] == NULL) {
7424 /* ash emits: export VAR='VAL'
7425 * bash: declare -x VAR="VAL"
7426 * we follow ash example */
7427 const char *s = *e++;
7428 const char *p = strchr(s, '=');
7430 if (!p) /* wtf? take next variable */
7433 printf("export %.*s", (int)(p - s) + 1, s);
7434 print_escaped(p + 1);
7438 /*fflush_all(); - done after each builtin anyway */
7440 return EXIT_SUCCESS;
7443 helper_export_local(argv, (opt_unexport ? -1 : 1), 0);
7445 return EXIT_SUCCESS;
7448 #if ENABLE_HUSH_LOCAL
7449 static int FAST_FUNC builtin_local(char **argv)
7451 if (G.func_nest_level == 0) {
7452 bb_error_msg("%s: not in a function", argv[0]);
7453 return EXIT_FAILURE; /* bash compat */
7455 helper_export_local(argv, 0, G.func_nest_level);
7456 return EXIT_SUCCESS;
7460 static int FAST_FUNC builtin_trap(char **argv)
7466 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
7471 /* No args: print all trapped */
7472 for (i = 0; i < NSIG; ++i) {
7475 print_escaped(G.traps[i]);
7476 /* note: bash adds "SIG", but only if invoked
7477 * as "bash". If called as "sh", or if set -o posix,
7478 * then it prints short signal names.
7479 * We are printing short names: */
7480 printf(" %s\n", get_signame(i));
7483 /*fflush_all(); - done after each builtin anyway */
7484 return EXIT_SUCCESS;
7488 /* If first arg is a number: reset all specified signals */
7489 sig = bb_strtou(*argv, NULL, 10);
7495 sig = get_signum(*argv++);
7496 if (sig < 0 || sig >= NSIG) {
7498 /* Mimic bash message exactly */
7499 bb_perror_msg("trap: %s: invalid signal specification", argv[-1]);
7504 G.traps[sig] = xstrdup(new_cmd);
7506 debug_printf("trap: setting SIG%s (%i) to '%s'\n",
7507 get_signame(sig), sig, G.traps[sig]);
7509 /* There is no signal for 0 (EXIT) */
7514 sigaddset(&G.blocked_set, sig);
7516 /* There was a trap handler, we are removing it
7517 * (if sig has non-DFL handling,
7518 * we don't need to do anything) */
7519 if (sig < 32 && (G.non_DFL_mask & (1 << sig)))
7521 sigdelset(&G.blocked_set, sig);
7524 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
7528 if (!argv[1]) { /* no second arg */
7529 bb_error_msg("trap: invalid arguments");
7530 return EXIT_FAILURE;
7533 /* First arg is "-": reset all specified to default */
7534 /* First arg is "--": skip it, the rest is "handler SIGs..." */
7535 /* Everything else: set arg as signal handler
7536 * (includes "" case, which ignores signal) */
7537 if (argv[0][0] == '-') {
7538 if (argv[0][1] == '\0') { /* "-" */
7539 /* new_cmd remains NULL: "reset these sigs" */
7542 if (argv[0][1] == '-' && argv[0][2] == '\0') { /* "--" */
7545 /* else: "-something", no special meaning */
7550 goto process_sig_list;
7553 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/type.html */
7554 static int FAST_FUNC builtin_type(char **argv)
7556 int ret = EXIT_SUCCESS;
7562 if (0) {} /* make conditional compile easier below */
7563 /*else if (find_alias(*argv))
7564 type = "an alias";*/
7565 #if ENABLE_HUSH_FUNCTIONS
7566 else if (find_function(*argv))
7567 type = "a function";
7569 else if (find_builtin(*argv))
7570 type = "a shell builtin";
7571 else if ((path = find_in_path(*argv)) != NULL)
7574 bb_error_msg("type: %s: not found", *argv);
7579 printf("%s is %s\n", *argv, type);
7587 /* built-in 'fg' and 'bg' handler */
7588 static int FAST_FUNC builtin_fg_bg(char **argv)
7593 if (!G_interactive_fd)
7594 return EXIT_FAILURE;
7596 /* If they gave us no args, assume they want the last backgrounded task */
7598 for (pi = G.job_list; pi; pi = pi->next) {
7599 if (pi->jobid == G.last_jobid) {
7603 bb_error_msg("%s: no current job", argv[0]);
7604 return EXIT_FAILURE;
7606 if (sscanf(argv[1], "%%%d", &jobnum) != 1) {
7607 bb_error_msg("%s: bad argument '%s'", argv[0], argv[1]);
7608 return EXIT_FAILURE;
7610 for (pi = G.job_list; pi; pi = pi->next) {
7611 if (pi->jobid == jobnum) {
7615 bb_error_msg("%s: %d: no such job", argv[0], jobnum);
7616 return EXIT_FAILURE;
7618 /* TODO: bash prints a string representation
7619 * of job being foregrounded (like "sleep 1 | cat") */
7620 if (argv[0][0] == 'f' && G_saved_tty_pgrp) {
7621 /* Put the job into the foreground. */
7622 tcsetpgrp(G_interactive_fd, pi->pgrp);
7625 /* Restart the processes in the job */
7626 debug_printf_jobs("reviving %d procs, pgrp %d\n", pi->num_cmds, pi->pgrp);
7627 for (i = 0; i < pi->num_cmds; i++) {
7628 debug_printf_jobs("reviving pid %d\n", pi->cmds[i].pid);
7629 pi->cmds[i].is_stopped = 0;
7631 pi->stopped_cmds = 0;
7633 i = kill(- pi->pgrp, SIGCONT);
7635 if (errno == ESRCH) {
7636 delete_finished_bg_job(pi);
7637 return EXIT_SUCCESS;
7639 bb_perror_msg("kill (SIGCONT)");
7642 if (argv[0][0] == 'f') {
7644 return checkjobs_and_fg_shell(pi);
7646 return EXIT_SUCCESS;
7650 #if ENABLE_HUSH_HELP
7651 static int FAST_FUNC builtin_help(char **argv UNUSED_PARAM)
7653 const struct built_in_command *x;
7656 "Built-in commands:\n"
7657 "------------------\n");
7658 for (x = bltins1; x != &bltins1[ARRAY_SIZE(bltins1)]; x++) {
7660 printf("%s\t%s\n", x->cmd, x->descr);
7663 return EXIT_SUCCESS;
7668 static int FAST_FUNC builtin_jobs(char **argv UNUSED_PARAM)
7671 const char *status_string;
7673 for (job = G.job_list; job; job = job->next) {
7674 if (job->alive_cmds == job->stopped_cmds)
7675 status_string = "Stopped";
7677 status_string = "Running";
7679 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->cmdtext);
7681 return EXIT_SUCCESS;
7686 static int FAST_FUNC builtin_memleak(char **argv UNUSED_PARAM)
7691 # ifdef M_TRIM_THRESHOLD
7692 /* Optional. Reduces probability of false positives */
7695 /* Crude attempt to find where "free memory" starts,
7696 * sans fragmentation. */
7698 l = (unsigned long)p;
7701 if (l < (unsigned long)p) l = (unsigned long)p;
7704 if (!G.memleak_value)
7705 G.memleak_value = l;
7707 l -= G.memleak_value;
7714 /* Exitcode is "how many kilobytes we leaked since 1st call" */
7719 static int FAST_FUNC builtin_pwd(char **argv UNUSED_PARAM)
7722 return EXIT_SUCCESS;
7725 static int FAST_FUNC builtin_read(char **argv)
7728 const char *name = "REPLY";
7732 /* bash (3.2.33(1)) bug: "read 0abcd" will execute,
7733 * and _after_ that_ it will complain */
7734 if (!is_well_formed_var_name(name, '\0')) {
7735 /* Mimic bash message */
7736 bb_error_msg("read: '%s': not a valid identifier", name);
7741 //TODO: bash unbackslashes input, splits words and puts them in argv[i]
7743 string = xmalloc_reads(STDIN_FILENO, xasprintf("%s=", name), NULL);
7744 return set_local_var(string, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
7747 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set
7748 * built-in 'set' handler
7750 * set [-abCefhmnuvx] [-o option] [argument...]
7751 * set [+abCefhmnuvx] [+o option] [argument...]
7752 * set -- [argument...]
7755 * Implementations shall support the options in both their hyphen and
7756 * plus-sign forms. These options can also be specified as options to sh.
7758 * Write out all variables and their values: set
7759 * Set $1, $2, and $3 and set "$#" to 3: set c a b
7760 * Turn on the -x and -v options: set -xv
7761 * Unset all positional parameters: set --
7762 * Set $1 to the value of x, even if it begins with '-' or '+': set -- "$x"
7763 * Set the positional parameters to the expansion of x, even if x expands
7764 * with a leading '-' or '+': set -- $x
7766 * So far, we only support "set -- [argument...]" and some of the short names.
7768 static int FAST_FUNC builtin_set(char **argv)
7771 char **pp, **g_argv;
7772 char *arg = *++argv;
7776 for (e = G.top_var; e; e = e->next)
7778 return EXIT_SUCCESS;
7782 if (!strcmp(arg, "--")) {
7786 if (arg[0] != '+' && arg[0] != '-')
7788 for (n = 1; arg[n]; ++n)
7789 if (set_mode(arg[0], arg[n]))
7791 } while ((arg = *++argv) != NULL);
7792 /* Now argv[0] is 1st argument */
7795 return EXIT_SUCCESS;
7798 /* NB: G.global_argv[0] ($0) is never freed/changed */
7799 g_argv = G.global_argv;
7800 if (G.global_args_malloced) {
7806 G.global_args_malloced = 1;
7807 pp = xzalloc(sizeof(pp[0]) * 2);
7808 pp[0] = g_argv[0]; /* retain $0 */
7811 /* This realloc's G.global_argv */
7812 G.global_argv = pp = add_strings_to_strings(g_argv, argv, /*dup:*/ 1);
7819 return EXIT_SUCCESS;
7821 /* Nothing known, so abort */
7823 bb_error_msg("set: %s: invalid option", arg);
7824 return EXIT_FAILURE;
7827 static int FAST_FUNC builtin_shift(char **argv)
7833 if (n >= 0 && n < G.global_argc) {
7834 if (G.global_args_malloced) {
7837 free(G.global_argv[m++]);
7840 memmove(&G.global_argv[1], &G.global_argv[n+1],
7841 G.global_argc * sizeof(G.global_argv[0]));
7842 return EXIT_SUCCESS;
7844 return EXIT_FAILURE;
7847 static int FAST_FUNC builtin_source(char **argv)
7852 #if ENABLE_HUSH_FUNCTIONS
7856 if (*++argv == NULL)
7857 return EXIT_FAILURE;
7859 if (strchr(*argv, '/') == NULL && (arg_path = find_in_path(*argv)) != NULL) {
7860 input = fopen_for_read(arg_path);
7863 input = fopen_or_warn(*argv, "r");
7865 /* bb_perror_msg("%s", *argv); - done by fopen_or_warn */
7866 return EXIT_FAILURE;
7868 close_on_exec_on(fileno(input));
7870 #if ENABLE_HUSH_FUNCTIONS
7871 sv_flg = G.flag_return_in_progress;
7872 /* "we are inside sourced file, ok to use return" */
7873 G.flag_return_in_progress = -1;
7875 save_and_replace_G_args(&sv, argv);
7877 parse_and_run_file(input);
7880 restore_G_args(&sv, argv);
7881 #if ENABLE_HUSH_FUNCTIONS
7882 G.flag_return_in_progress = sv_flg;
7885 return G.last_exitcode;
7888 static int FAST_FUNC builtin_umask(char **argv)
7895 mode_t old_mask = mask;
7898 rc = bb_parse_mode(argv[1], &mask);
7903 * bash: umask: 'q': invalid symbolic mode operator
7904 * bash: umask: 999: octal number out of range
7906 bb_error_msg("%s: '%s' invalid mode", argv[0], argv[1]);
7911 printf("%04o\n", (unsigned) mask);
7912 /* fall through and restore mask which we set to 0 */
7916 return !rc; /* rc != 0 - success */
7919 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#unset */
7920 static int FAST_FUNC builtin_unset(char **argv)
7925 /* "!": do not abort on errors */
7926 /* "+": stop at 1st non-option */
7927 opts = getopt32(argv, "!+vf");
7928 if (opts == (unsigned)-1)
7929 return EXIT_FAILURE;
7931 bb_error_msg("unset: -v and -f are exclusive");
7932 return EXIT_FAILURE;
7938 if (!(opts & 2)) { /* not -f */
7939 if (unset_local_var(*argv)) {
7940 /* unset <nonexistent_var> doesn't fail.
7941 * Error is when one tries to unset RO var.
7942 * Message was printed by unset_local_var. */
7946 #if ENABLE_HUSH_FUNCTIONS
7956 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/wait.html */
7957 static int FAST_FUNC builtin_wait(char **argv)
7959 int ret = EXIT_SUCCESS;
7962 if (*++argv == NULL) {
7963 /* Don't care about wait results */
7964 /* Note 1: must wait until there are no more children */
7965 /* Note 2: must be interruptible */
7967 * $ sleep 3 & sleep 6 & wait
7972 * $ sleep 3 & sleep 6 & wait
7976 * ^C <-- after ~4 sec from keyboard
7979 sigaddset(&G.blocked_set, SIGCHLD);
7980 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
7983 if (errno == ECHILD)
7985 /* Wait for SIGCHLD or any other signal of interest */
7986 /* sigtimedwait with infinite timeout: */
7987 sig = sigwaitinfo(&G.blocked_set, NULL);
7989 sig = check_and_run_traps(sig);
7990 if (sig && sig != SIGCHLD) { /* see note 2 */
7996 sigdelset(&G.blocked_set, SIGCHLD);
7997 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
8001 /* This is probably buggy wrt interruptible-ness */
8003 pid_t pid = bb_strtou(*argv, NULL, 10);
8005 /* mimic bash message */
8006 bb_error_msg("wait: '%s': not a pid or valid job spec", *argv);
8007 return EXIT_FAILURE;
8009 if (waitpid(pid, &status, 0) == pid) {
8010 if (WIFSIGNALED(status))
8011 ret = 128 + WTERMSIG(status);
8012 else if (WIFEXITED(status))
8013 ret = WEXITSTATUS(status);
8017 bb_perror_msg("wait %s", *argv);
8026 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_FUNCTIONS
8027 static unsigned parse_numeric_argv1(char **argv, unsigned def, unsigned def_min)
8030 def = bb_strtou(argv[1], NULL, 10);
8031 if (errno || def < def_min || argv[2]) {
8032 bb_error_msg("%s: bad arguments", argv[0]);
8040 #if ENABLE_HUSH_LOOPS
8041 static int FAST_FUNC builtin_break(char **argv)
8044 if (G.depth_of_loop == 0) {
8045 bb_error_msg("%s: only meaningful in a loop", argv[0]);
8046 return EXIT_SUCCESS; /* bash compat */
8048 G.flag_break_continue++; /* BC_BREAK = 1 */
8050 G.depth_break_continue = depth = parse_numeric_argv1(argv, 1, 1);
8051 if (depth == UINT_MAX)
8052 G.flag_break_continue = BC_BREAK;
8053 if (G.depth_of_loop < depth)
8054 G.depth_break_continue = G.depth_of_loop;
8056 return EXIT_SUCCESS;
8059 static int FAST_FUNC builtin_continue(char **argv)
8061 G.flag_break_continue = 1; /* BC_CONTINUE = 2 = 1+1 */
8062 return builtin_break(argv);
8066 #if ENABLE_HUSH_FUNCTIONS
8067 static int FAST_FUNC builtin_return(char **argv)
8071 if (G.flag_return_in_progress != -1) {
8072 bb_error_msg("%s: not in a function or sourced script", argv[0]);
8073 return EXIT_FAILURE; /* bash compat */
8076 G.flag_return_in_progress = 1;
8079 * out of range: wraps around at 256, does not error out
8080 * non-numeric param:
8081 * f() { false; return qwe; }; f; echo $?
8082 * bash: return: qwe: numeric argument required <== we do this
8083 * 255 <== we also do this
8085 rc = parse_numeric_argv1(argv, G.last_exitcode, 0);