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>
11 * The parser routines proper are all original material, first
12 * written Dec 2000 and Jan 2001 by Larry Doolittle. The
13 * execution engine, the builtins, and much of the underlying
14 * support has been adapted from busybox-0.49pre's lash, which is
15 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
16 * written by Erik Andersen <andersen@codepoet.org>. That, in turn,
17 * is based in part on ladsh.c, by Michael K. Johnson and Erik W.
18 * Troan, which they placed in the public domain. I don't know
19 * how much of the Johnson/Troan code has survived the repeated
23 * o_addchr() derived from similar w_addchar function in glibc-2.2.
24 * setup_redirect(), redirect_opt_num(), and big chunks of main()
25 * and many builtins derived from contributions by Erik Andersen.
26 * Miscellaneous bugfixes from Matt Kraai.
28 * There are two big (and related) architecture differences between
29 * this parser and the lash parser. One is that this version is
30 * actually designed from the ground up to understand nearly all
31 * of the Bourne grammar. The second, consequential change is that
32 * the parser and input reader have been turned inside out. Now,
33 * the parser is in control, and asks for input as needed. The old
34 * way had the input reader in control, and it asked for parsing to
35 * take place as needed. The new way makes it much easier to properly
36 * handle the recursion implicit in the various substitutions, especially
37 * across continuation lines.
39 * POSIX syntax not implemented:
41 * <(list) and >(list) Process Substitution
42 * Here Documents ( << word )
45 * Parameter Expansion for substring processing ${var#word} ${var%word}
47 * Bash stuff maybe optional enable:
48 * &> and >& redirection of stdout+stderr
50 * reserved words: [[ ]] function select
51 * substrings ${var:1:5}
54 * job handling woefully incomplete and buggy (improved --vda)
56 * port selected bugfixes from post-0.49 busybox lash - done?
57 * change { and } from special chars to reserved words
58 * builtins: return, trap, ulimit
59 * test magic exec with redirection only
60 * follow IFS rules more precisely, including update semantics
61 * figure out what to do with backslash-newline
62 * propagate syntax errors, die on resource errors?
63 * continuation lines, both explicit and implicit - done?
65 * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
68 #include "busybox.h" /* for APPLET_IS_NOFORK/NOEXEC */
69 //TODO: pull in some .h and find out whether we have SINGLE_APPLET_MAIN?
70 //#include "applet_tables.h" doesn't work
72 /* #include <dmalloc.h> */
78 #ifdef WANT_TO_TEST_NOMMU
83 # define USE_FOR_NOMMU(...) __VA_ARGS__
84 # define USE_FOR_MMU(...)
87 #define HUSH_VER_STR "0.93"
89 #if defined SINGLE_APPLET_MAIN
90 /* STANDALONE does not make sense, and won't compile */
91 #undef CONFIG_FEATURE_SH_STANDALONE
92 #undef ENABLE_FEATURE_SH_STANDALONE
93 #undef USE_FEATURE_SH_STANDALONE
94 #define SKIP_FEATURE_SH_STANDALONE(...) __VA_ARGS__
95 #define ENABLE_FEATURE_SH_STANDALONE 0
96 #define USE_FEATURE_SH_STANDALONE(...)
97 #define SKIP_FEATURE_SH_STANDALONE(...) __VA_ARGS__
100 #if !ENABLE_HUSH_INTERACTIVE
101 #undef ENABLE_FEATURE_EDITING
102 #define ENABLE_FEATURE_EDITING 0
103 #undef ENABLE_FEATURE_EDITING_FANCY_PROMPT
104 #define ENABLE_FEATURE_EDITING_FANCY_PROMPT 0
107 /* Do we support ANY keywords? */
108 #if ENABLE_HUSH_IF || ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
109 #define HAS_KEYWORDS 1
110 #define IF_HAS_KEYWORDS(...) __VA_ARGS__
111 #define IF_HAS_NO_KEYWORDS(...)
113 #define HAS_KEYWORDS 0
114 #define IF_HAS_KEYWORDS(...)
115 #define IF_HAS_NO_KEYWORDS(...) __VA_ARGS__
118 /* Keep unconditionally on for now */
121 #define ENABLE_HUSH_FUNCTIONS 0
124 /* If you comment out one of these below, it will be #defined later
125 * to perform debug printfs to stderr: */
126 #define debug_printf(...) do {} while (0)
127 /* Finer-grained debug switches */
128 #define debug_printf_parse(...) do {} while (0)
129 #define debug_print_tree(a, b) do {} while (0)
130 #define debug_printf_exec(...) do {} while (0)
131 #define debug_printf_env(...) do {} while (0)
132 #define debug_printf_jobs(...) do {} while (0)
133 #define debug_printf_expand(...) do {} while (0)
134 #define debug_printf_glob(...) do {} while (0)
135 #define debug_printf_list(...) do {} while (0)
136 #define debug_printf_subst(...) do {} while (0)
137 #define debug_printf_clean(...) do {} while (0)
140 #define debug_printf(...) fprintf(stderr, __VA_ARGS__)
143 #ifndef debug_printf_parse
144 #define debug_printf_parse(...) fprintf(stderr, __VA_ARGS__)
147 #ifndef debug_printf_exec
148 #define debug_printf_exec(...) fprintf(stderr, __VA_ARGS__)
151 #ifndef debug_printf_env
152 #define debug_printf_env(...) fprintf(stderr, __VA_ARGS__)
155 #ifndef debug_printf_jobs
156 #define debug_printf_jobs(...) fprintf(stderr, __VA_ARGS__)
162 #ifndef debug_printf_expand
163 #define debug_printf_expand(...) fprintf(stderr, __VA_ARGS__)
164 #define DEBUG_EXPAND 1
166 #define DEBUG_EXPAND 0
169 #ifndef debug_printf_glob
170 #define debug_printf_glob(...) fprintf(stderr, __VA_ARGS__)
176 #ifndef debug_printf_list
177 #define debug_printf_list(...) fprintf(stderr, __VA_ARGS__)
180 #ifndef debug_printf_subst
181 #define debug_printf_subst(...) fprintf(stderr, __VA_ARGS__)
184 #ifndef debug_printf_clean
185 /* broken, of course, but OK for testing */
186 static const char *indenter(int i)
188 static const char blanks[] ALIGN1 =
190 return &blanks[sizeof(blanks) - i - 1];
192 #define debug_printf_clean(...) fprintf(stderr, __VA_ARGS__)
193 #define DEBUG_CLEAN 1
197 static void debug_print_strings(const char *prefix, char **vv)
199 fprintf(stderr, "%s:\n", prefix);
201 fprintf(stderr, " '%s'\n", *vv++);
204 #define debug_print_strings(prefix, vv) ((void)0)
208 * Leak hunting. Use hush_leaktool.sh for post-processing.
210 #ifdef FOR_HUSH_LEAKTOOL
211 static void *xxmalloc(int lineno, size_t size)
213 void *ptr = xmalloc((size + 0xff) & ~0xff);
214 fdprintf(2, "line %d: malloc %p\n", lineno, ptr);
217 static void *xxrealloc(int lineno, void *ptr, size_t size)
219 ptr = xrealloc(ptr, (size + 0xff) & ~0xff);
220 fdprintf(2, "line %d: realloc %p\n", lineno, ptr);
223 static char *xxstrdup(int lineno, const char *str)
225 char *ptr = xstrdup(str);
226 fdprintf(2, "line %d: strdup %p\n", lineno, ptr);
229 static void xxfree(void *ptr)
231 fdprintf(2, "free %p\n", ptr);
234 #define xmalloc(s) xxmalloc(__LINE__, s)
235 #define xrealloc(p, s) xxrealloc(__LINE__, p, s)
236 #define xstrdup(s) xxstrdup(__LINE__, s)
237 #define free(p) xxfree(p)
241 #define ERR_PTR ((void*)(long)1)
243 static const char hush_version_str[] ALIGN1 = "HUSH_VERSION="HUSH_VER_STR;
245 #define JOB_STATUS_FORMAT "[%d] %-22s %.40s\n"
247 #define SPECIAL_VAR_SYMBOL 3
249 typedef enum redir_type {
251 REDIRECT_OVERWRITE = 2,
257 /* The descrip member of this structure is only used to make
258 * debugging output pretty */
259 static const struct {
261 signed char default_fd;
265 { O_RDONLY, 0, "<" },
266 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
267 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
268 { O_RDONLY, -1, "<<" },
272 typedef enum pipe_style {
279 typedef enum reserved_style {
288 #if ENABLE_HUSH_LOOPS
295 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
300 /* two pseudo-keywords support contrived "case" syntax: */
301 RES_MATCH , /* "word)" */
302 RES_CASEI , /* "this command is inside CASE" */
309 typedef struct o_string {
311 int length; /* position where data is appended */
313 /* Protect newly added chars against globbing
314 * (by prepending \ to *, ?, [, \) */
318 smallint has_empty_slot;
319 smallint o_assignment; /* 0:maybe, 1:yes, 2:no */
322 MAYBE_ASSIGNMENT = 0,
323 DEFINITELY_ASSIGNMENT = 1,
325 WORD_IS_KEYWORD = 3, /* not assigment, but next word may be: "if v=xyz cmd;" */
327 /* Used for initialization: o_string foo = NULL_O_STRING; */
328 #define NULL_O_STRING { NULL }
330 /* I can almost use ordinary FILE*. Is open_memstream() universally
331 * available? Where is it documented? */
332 typedef struct in_str {
334 /* eof_flag=1: last char in ->p is really an EOF */
335 char eof_flag; /* meaningless if ->p == NULL */
337 #if ENABLE_HUSH_INTERACTIVE
339 smallint promptmode; /* 0: PS1, 1: PS2 */
342 int (*get) (struct in_str *);
343 int (*peek) (struct in_str *);
345 #define i_getch(input) ((input)->get(input))
346 #define i_peek(input) ((input)->peek(input))
348 struct redir_struct {
349 struct redir_struct *next;
350 char *rd_filename; /* filename */
351 int fd; /* file descriptor being redirected */
352 int dup; /* -1, or file descriptor being duplicated */
353 smallint /*enum redir_type*/ rd_type;
357 pid_t pid; /* 0 if exited */
358 int assignment_cnt; /* how many argv[i] are assignments? */
359 smallint is_stopped; /* is the command currently running? */
360 smallint grp_type; /* GRP_xxx */
361 struct pipe *group; /* if non-NULL, this "command" is { list },
362 * ( list ), or a compound statement */
364 char *group_as_string;
366 char **argv; /* command name and arguments */
367 struct redir_struct *redirects; /* I/O redirections */
369 /* argv vector may contain variable references (^Cvar^C, ^C0^C etc)
370 * and on execution these are substituted with their values.
371 * Substitution can make _several_ words out of one argv[n]!
372 * Example: argv[0]=='.^C*^C.' here: echo .$*.
373 * References of the form ^C`cmd arg^C are `cmd arg` substitutions.
376 #define GRP_SUBSHELL 1
377 #if ENABLE_HUSH_FUNCTIONS
378 #define GRP_FUNCTION 2
383 int num_cmds; /* total number of commands in job */
384 int alive_cmds; /* number of commands running (not exited) */
385 int stopped_cmds; /* number of commands alive, but stopped */
387 int jobid; /* job number */
388 pid_t pgrp; /* process group ID for the job */
389 char *cmdtext; /* name of job */
391 struct command *cmds; /* array of commands in pipe */
392 smallint followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
393 IF_HAS_KEYWORDS(smallint pi_inverted;) /* "! cmd | cmd" */
394 IF_HAS_KEYWORDS(smallint res_word;) /* needed for if, for, while, until... */
397 /* This holds pointers to the various results of parsing */
398 struct parse_context {
399 /* linked list of pipes */
400 struct pipe *list_head;
401 /* last pipe (being constructed right now) */
403 /* last command in pipe (being constructed right now) */
404 struct command *command;
405 /* last redirect in command->redirects list */
406 struct redir_struct *pending_redirect;
412 smallint ctx_inverted; /* "! cmd | cmd" */
414 smallint ctx_dsemicolon; /* ";;" seen */
416 /* bitmask of FLAG_xxx, for figuring out valid reserved words */
418 /* group we are enclosed in:
419 * example: "if pipe1; pipe2; then pipe3; fi"
420 * when we see "if" or "then", we malloc and copy current context,
421 * and make ->stack point to it. then we parse pipeN.
422 * when closing "then" / fi" / whatever is found,
423 * we move list_head into ->stack->command->group,
424 * copy ->stack into current context, and delete ->stack.
425 * (parsing of { list } and ( list ) doesn't use this method)
427 struct parse_context *stack;
431 /* On program start, environ points to initial environment.
432 * putenv adds new pointers into it, unsetenv removes them.
433 * Neither of these (de)allocates the strings.
434 * setenv allocates new strings in malloc space and does putenv,
435 * and thus setenv is unusable (leaky) for shell's purposes */
436 #define setenv(...) setenv_is_leaky_dont_use()
438 struct variable *next;
439 char *varstr; /* points to "name=" portion */
440 int max_len; /* if > 0, name is part of initial env; else name is malloced */
441 smallint flg_export; /* putenv should be done on this var */
442 smallint flg_read_only;
451 /* "Globals" within this file */
452 /* Sorted roughly by size (smaller offsets == smaller code) */
454 #if ENABLE_HUSH_INTERACTIVE
455 /* 'interactive_fd' is a fd# open to ctty, if we have one
456 * _AND_ if we decided to act interactively */
460 #define G_interactive_fd (G.interactive_fd)
462 #define G_interactive_fd 0
464 #if ENABLE_FEATURE_EDITING
465 line_input_t *line_input_state;
471 pid_t saved_tty_pgrp;
473 struct pipe *job_list;
474 struct pipe *toplevel_list;
475 //// smallint ctrl_z_flag;
477 smallint flag_SIGINT;
478 #if ENABLE_HUSH_LOOPS
479 smallint flag_break_continue;
482 /* These four support $?, $#, and $1 */
483 smalluint last_return_code;
484 /* is global_argv and global_argv[1..n] malloced? (note: not [0]) */
485 smalluint global_args_malloced;
486 /* how many non-NULL argv's we have. NB: $# + 1 */
489 #if ENABLE_HUSH_LOOPS
490 unsigned depth_break_continue;
491 unsigned depth_of_loop;
495 struct variable *top_var; /* = &G.shell_ver (set in main()) */
496 struct variable shell_ver;
497 /* Signal and trap handling */
498 // unsigned count_SIGCHLD;
499 // unsigned handled_SIGCHLD;
500 /* which signals have non-DFL handler (even with no traps set)? */
501 unsigned non_DFL_mask;
502 char **traps; /* char *traps[NSIG] */
503 sigset_t blocked_set;
504 sigset_t inherited_set;
505 char user_input_buf[ENABLE_FEATURE_EDITING ? BUFSIZ : 2];
506 #if ENABLE_FEATURE_SH_STANDALONE
507 struct nofork_save_area nofork_save;
510 sigjmp_buf toplevel_jb;
513 #define G (*ptr_to_globals)
514 /* Not #defining name to G.name - this quickly gets unwieldy
515 * (too many defines). Also, I actually prefer to see when a variable
516 * is global, thus "G." prefix is a useful hint */
517 #define INIT_G() do { \
518 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
522 /* Function prototypes for builtins */
523 static int builtin_cd(char **argv);
524 static int builtin_echo(char **argv);
525 static int builtin_eval(char **argv);
526 static int builtin_exec(char **argv);
527 static int builtin_exit(char **argv);
528 static int builtin_export(char **argv);
530 static int builtin_fg_bg(char **argv);
531 static int builtin_jobs(char **argv);
534 static int builtin_help(char **argv);
536 static int builtin_pwd(char **argv);
537 static int builtin_read(char **argv);
538 static int builtin_test(char **argv);
539 static int builtin_trap(char **argv);
540 static int builtin_true(char **argv);
541 static int builtin_set(char **argv);
542 static int builtin_shift(char **argv);
543 static int builtin_source(char **argv);
544 static int builtin_umask(char **argv);
545 static int builtin_unset(char **argv);
546 static int builtin_wait(char **argv);
547 #if ENABLE_HUSH_LOOPS
548 static int builtin_break(char **argv);
549 static int builtin_continue(char **argv);
552 /* Table of built-in functions. They can be forked or not, depending on
553 * context: within pipes, they fork. As simple commands, they do not.
554 * When used in non-forking context, they can change global variables
555 * in the parent shell process. If forked, of course they cannot.
556 * For example, 'unset foo | whatever' will parse and run, but foo will
557 * still be set at the end. */
558 struct built_in_command {
560 int (*function)(char **argv);
563 #define BLTIN(cmd, func, help) { cmd, func, help }
565 #define BLTIN(cmd, func, help) { cmd, func }
569 /* For now, echo and test are unconditionally enabled.
570 * Maybe make it configurable? */
571 static const struct built_in_command bltins[] = {
572 BLTIN("." , builtin_source , "Run commands in a file"),
573 BLTIN(":" , builtin_true , "No-op"),
574 BLTIN("[" , builtin_test , "Test condition"),
576 BLTIN("bg" , builtin_fg_bg , "Resume a job in the background"),
578 #if ENABLE_HUSH_LOOPS
579 BLTIN("break" , builtin_break , "Exit from a loop"),
581 BLTIN("cd" , builtin_cd , "Change directory"),
582 #if ENABLE_HUSH_LOOPS
583 BLTIN("continue", builtin_continue, "Start new loop iteration"),
585 BLTIN("echo" , builtin_echo , "Write to stdout"),
586 BLTIN("eval" , builtin_eval , "Construct and run shell command"),
587 BLTIN("exec" , builtin_exec , "Execute command, don't return to shell"),
588 BLTIN("exit" , builtin_exit , "Exit"),
589 BLTIN("export" , builtin_export , "Set environment variable"),
591 BLTIN("fg" , builtin_fg_bg , "Bring job into the foreground"),
594 BLTIN("help" , builtin_help , "List shell built-in commands"),
597 BLTIN("jobs" , builtin_jobs , "List active jobs"),
599 BLTIN("pwd" , builtin_pwd , "Print current directory"),
600 BLTIN("read" , builtin_read , "Input environment variable"),
601 // BLTIN("return" , builtin_return , "Return from a function"),
602 BLTIN("set" , builtin_set , "Set/unset shell local variables"),
603 BLTIN("shift" , builtin_shift , "Shift positional parameters"),
604 BLTIN("test" , builtin_test , "Test condition"),
605 BLTIN("trap" , builtin_trap , "Trap signals"),
606 // BLTIN("ulimit" , builtin_return , "Control resource limits"),
607 BLTIN("umask" , builtin_umask , "Set file creation mask"),
608 BLTIN("unset" , builtin_unset , "Unset environment variable"),
609 BLTIN("wait" , builtin_wait , "Wait for process"),
613 static void maybe_die(const char *notice, const char *msg)
615 /* Was using fancy stuff:
616 * (G_interactive_fd ? bb_error_msg : bb_error_msg_and_die)(...params...)
617 * but it SEGVs. ?! Oh well... explicit temp ptr works around that */
618 void FAST_FUNC (*fp)(const char *s, ...) = bb_error_msg_and_die;
619 #if ENABLE_HUSH_INTERACTIVE
620 if (G_interactive_fd)
623 fp(msg ? "%s: %s" : notice, notice, msg);
626 #define syntax(msg) maybe_die("syntax error", msg);
628 /* Debug -- trick gcc to expand __LINE__ and convert to string */
629 #define __syntax(msg, line) maybe_die("syntax error hush.c:" # line, msg)
630 #define _syntax(msg, line) __syntax(msg, line)
631 #define syntax(msg) _syntax(msg, __LINE__)
635 static int glob_needed(const char *s)
640 if (*s == '*' || *s == '[' || *s == '?')
647 static int is_assignment(const char *s)
649 if (!s || !(isalpha(*s) || *s == '_'))
652 while (isalnum(*s) || *s == '_')
657 /* Replace each \x with x in place, return ptr past NUL. */
658 static char *unbackslash(char *src)
664 if ((*dst++ = *src++) == '\0')
670 static char **add_strings_to_strings(char **strings, char **add, int need_to_dup)
691 v = xrealloc(strings, (count1 + count2 + 1) * sizeof(char*));
692 v[count1 + count2] = NULL;
695 v[count1 + i] = (need_to_dup ? xstrdup(add[i]) : add[i]);
699 static char **add_string_to_strings(char **strings, char *add)
704 return add_strings_to_strings(strings, v, /*dup:*/ 0);
707 static void putenv_all(char **strings)
712 debug_printf_env("putenv '%s'\n", *strings);
717 static char **putenv_all_and_save_old(char **strings)
727 eq = strchr(*strings, '=');
730 v = getenv(*strings);
733 /* v points to VAL in VAR=VAL, go back to VAR */
734 v -= (eq - *strings) + 1;
735 old = add_string_to_strings(old, v);
744 static void free_strings_and_unsetenv(char **strings, int unset)
754 debug_printf_env("unsetenv '%s'\n", *v);
762 static void free_strings(char **strings)
764 free_strings_and_unsetenv(strings, 0);
768 /* Basic theory of signal handling in shell
769 * ========================================
770 * This does not describe what hush does, rather, it is current understanding
771 * what it _should_ do. If it doesn't, it's a bug.
772 * http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
774 * Signals are handled only after each pipe ("cmd | cmd | cmd" thing)
775 * is finished or backgrounded. It is the same in interactive and
776 * non-interactive shells, and is the same regardless of whether
777 * a user trap handler is installed or a shell special one is in effect.
778 * ^C or ^Z from keyboard seem to execute "at once" because it usually
779 * backgrounds (i.e. stops) or kills all members of currently running
782 * Wait builtin in interruptible by signals for which user trap is set
783 * or by SIGINT in interactive shell.
785 * Trap handlers will execute even within trap handlers. (right?)
787 * User trap handlers are forgotten when subshell ("(cmd)") is entered. [TODO]
789 * If job control is off, backgrounded commands ("cmd &")
790 * have SIGINT, SIGQUIT set to SIG_IGN.
792 * Commands run in command substitution ("`cmd`")
793 * have SIGTTIN, SIGTTOU, SIGTSTP set to SIG_IGN.
795 * Ordinary commands have signals set to SIG_IGN/DFL set as inherited
796 * by the shell from its parent.
798 * Siganls which differ from SIG_DFL action
799 * (note: child (i.e., [v]forked) shell is not an interactive shell):
802 * SIGTERM (interactive): ignore
803 * SIGHUP (interactive):
804 * send SIGCONT to stopped jobs, send SIGHUP to all jobs and exit
805 * SIGTTIN, SIGTTOU, SIGTSTP (if job control is on): ignore
806 * (note that ^Z is handled not by trapping SIGTSTP, but by seeing
807 * that all pipe members are stopped) (right?)
808 * SIGINT (interactive): wait for last pipe, ignore the rest
809 * of the command line, show prompt. NB: ^C does not send SIGINT
810 * to interactive shell while shell is waiting for a pipe,
811 * since shell is bg'ed (is not in foreground process group).
812 * (check/expand this)
813 * Example 1: this waits 5 sec, but does not execute ls:
814 * "echo $$; sleep 5; ls -l" + "kill -INT <pid>"
815 * Example 2: this does not wait and does not execute ls:
816 * "echo $$; sleep 5 & wait; ls -l" + "kill -INT <pid>"
817 * Example 3: this does not wait 5 sec, but executes ls:
818 * "sleep 5; ls -l" + press ^C
820 * (What happens to signals which are IGN on shell start?)
821 * (What happens with signal mask on shell start?)
823 * Implementation in hush
824 * ======================
825 * We use in-kernel pending signal mask to determine which signals were sent.
826 * We block all signals which we don't want to take action immediately,
827 * i.e. we block all signals which need to have special handling as described
828 * above, and all signals which have traps set.
829 * After each pipe execution, we extract any pending signals via sigtimedwait()
832 * unsigned non_DFL_mask: a mask of such "special" signals
833 * sigset_t blocked_set: current blocked signal set
836 * clear bit in blocked_set unless it is also in non_DFL_mask
837 * "trap 'cmd' SIGxxx":
838 * set bit in blocked_set (even if 'cmd' is '')
839 * after [v]fork, if we plan to be a shell:
840 * nothing for {} child shell (say, "true | { true; true; } | true")
841 * unset all traps if () shell. [TODO]
842 * after [v]fork, if we plan to exec:
843 * POSIX says pending signal mask is cleared in child - no need to clear it.
844 * Restore blocked signal set to one inherited by shell just prior to exec.
846 * Note: as a result, we do not use signal handlers much. The only uses
847 * are to count SIGCHLDs [disabled - bug somewhere, + bloat]
848 * and to restore tty pgrp on signal-induced exit.
850 * TODO: check/fix wait builtin to be interruptible.
853 //static void SIGCHLD_handler(int sig UNUSED_PARAM)
855 // G.count_SIGCHLD++;
858 /* called once at shell init */
859 static void init_signal_mask(void)
862 unsigned mask = (1 << SIGQUIT);
863 if (G_interactive_fd) {
869 | (1 << SIGTTIN) | (1 << SIGTTOU) | (1 << SIGTSTP)
874 G.non_DFL_mask = mask;
876 sigprocmask(SIG_SETMASK, NULL, &G.blocked_set);
880 sigaddset(&G.blocked_set, sig);
884 sigdelset(&G.blocked_set, SIGCHLD);
885 sigprocmask(SIG_SETMASK, &G.blocked_set, &G.inherited_set);
888 static int check_and_run_traps(int sig)
890 static const struct timespec zero_timespec = { 0, 0 };
891 smalluint save_rcode;
897 sig = sigtimedwait(&G.blocked_set, NULL, &zero_timespec);
902 if (G.traps && G.traps[sig]) {
903 if (G.traps[sig][0]) {
904 /* We have user-defined handler */
905 char *argv[] = { NULL, xstrdup(G.traps[sig]), NULL };
906 save_rcode = G.last_return_code;
909 G.last_return_code = save_rcode;
910 } /* else: "" trap, ignoring signal */
913 /* not a trap: special action */
916 // G.count_SIGCHLD++;
925 default: /* SIGTERM, SIGQUIT, SIGTTIN, SIGTTOU, SIGTSTP */
934 /* Restores tty foreground process group, and exits.
935 * May be called as signal handler for fatal signal
936 * (will faithfully resend signal to itself, producing correct exit state)
937 * or called directly with -EXITCODE.
938 * We also call it if xfunc is exiting. */
939 static void sigexit(int sig) NORETURN;
940 static void sigexit(int sig)
942 /* Disable all signals: job control, SIGPIPE, etc. */
943 sigprocmask_allsigs(SIG_BLOCK);
945 /* Careful: we can end up here after [v]fork. Do not restore
946 * tty pgrp then, only top-level shell process does that */
947 if (G_interactive_fd && getpid() == G.root_pid)
948 tcsetpgrp(G_interactive_fd, G.saved_tty_pgrp);
950 /* Not a signal, just exit */
954 kill_myself_with_sig(sig); /* does not return */
958 static void maybe_set_sighandler(int sig)
960 void (*handler)(int);
961 /* non_DFL_mask'ed signals are, well, masked,
962 * no need to set handler for them.
964 if (!((G.non_DFL_mask >> sig) & 1)) {
965 handler = signal(sig, sigexit);
966 if (handler == SIG_IGN) /* oops... restore back to IGN! */
967 signal(sig, handler);
970 /* Used only to set handler to restore pgrp on exit */
971 static void set_fatal_signals_to_sigexit(void)
974 maybe_set_sighandler(SIGILL );
975 maybe_set_sighandler(SIGFPE );
976 maybe_set_sighandler(SIGBUS );
977 maybe_set_sighandler(SIGSEGV);
978 maybe_set_sighandler(SIGTRAP);
979 } /* else: hush is perfect. what SEGV? */
981 maybe_set_sighandler(SIGABRT);
983 /* bash 3.2 seems to handle these just like 'fatal' ones */
984 maybe_set_sighandler(SIGPIPE);
985 maybe_set_sighandler(SIGALRM);
986 maybe_set_sighandler(SIGHUP );
988 /* if we aren't interactive... but in this case
989 * we never want to restore pgrp on exit, and this fn is not called */
990 /*maybe_set_sighandler(SIGTERM);*/
991 /*maybe_set_sighandler(SIGINT );*/
996 #define set_fatal_signals_to_sigexit(handler) ((void)0)
1000 /* Restores tty foreground process group, and exits. */
1001 static void hush_exit(int exitcode) NORETURN;
1002 static void hush_exit(int exitcode)
1004 if (G.traps && G.traps[0] && G.traps[0][0]) {
1005 char *argv[] = { NULL, xstrdup(G.traps[0]), NULL };
1011 fflush(NULL); /* flush all streams */
1012 sigexit(- (exitcode & 0xff));
1019 static const char *set_cwd(void)
1021 /* xrealloc_getcwd_or_warn(arg) calls free(arg),
1022 * we must not try to free(bb_msg_unknown) */
1023 if (G.cwd == bb_msg_unknown)
1025 G.cwd = xrealloc_getcwd_or_warn((char *)G.cwd);
1027 G.cwd = bb_msg_unknown;
1032 /* Get/check local shell variables */
1033 static struct variable *get_local_var(const char *name)
1035 struct variable *cur;
1041 for (cur = G.top_var; cur; cur = cur->next) {
1042 if (strncmp(cur->varstr, name, len) == 0 && cur->varstr[len] == '=')
1048 static const char *get_local_var_value(const char *src)
1050 struct variable *var = get_local_var(src);
1052 return strchr(var->varstr, '=') + 1;
1056 /* str holds "NAME=VAL" and is expected to be malloced.
1057 * We take ownership of it.
1061 * -1: if NAME is set, leave export status alone
1062 * if NAME is not set, do not export
1063 * flg_read_only is set only when we handle -R var=val
1066 #define set_local_var(str, flg_export, flg_read_only) \
1067 set_local_var(str, flg_export)
1069 static int set_local_var(char *str, int flg_export, int flg_read_only)
1071 struct variable *cur;
1075 value = strchr(str, '=');
1076 if (!value) { /* not expected to ever happen? */
1081 name_len = value - str + 1; /* including '=' */
1082 cur = G.top_var; /* cannot be NULL (we have HUSH_VERSION and it's RO) */
1084 if (strncmp(cur->varstr, str, name_len) != 0) {
1086 /* Bail out. Note that now cur points
1087 * to last var in linked list */
1093 /* We found an existing var with this name */
1095 if (cur->flg_read_only) {
1099 bb_error_msg("%s: readonly variable", str);
1103 debug_printf_env("%s: unsetenv '%s'\n", __func__, str);
1104 unsetenv(str); /* just in case */
1106 if (strcmp(cur->varstr, str) == 0) {
1111 if (cur->max_len >= strlen(str)) {
1112 /* This one is from startup env, reuse space */
1113 strcpy(cur->varstr, str);
1116 /* max_len == 0 signifies "malloced" var, which we can
1117 * (and has to) free */
1121 goto set_str_and_exp;
1124 /* Not found - create next variable struct */
1125 cur->next = xzalloc(sizeof(*cur));
1130 cur->flg_read_only = flg_read_only;
1132 if (flg_export == 1)
1133 cur->flg_export = 1;
1134 if (cur->flg_export) {
1135 debug_printf_env("%s: putenv '%s'\n", __func__, cur->varstr);
1136 return putenv(cur->varstr);
1141 static int unset_local_var(const char *name)
1143 struct variable *cur;
1144 struct variable *prev = prev; /* for gcc */
1148 return EXIT_SUCCESS;
1149 name_len = strlen(name);
1152 if (strncmp(cur->varstr, name, name_len) == 0 && cur->varstr[name_len] == '=') {
1153 if (cur->flg_read_only) {
1154 bb_error_msg("%s: readonly variable", name);
1155 return EXIT_FAILURE;
1157 /* prev is ok to use here because 1st variable, HUSH_VERSION,
1158 * is ro, and we cannot reach this code on the 1st pass */
1159 prev->next = cur->next;
1160 debug_printf_env("%s: unsetenv '%s'\n", __func__, cur->varstr);
1161 bb_unsetenv(cur->varstr);
1165 return EXIT_SUCCESS;
1170 return EXIT_SUCCESS;
1173 #if ENABLE_SH_MATH_SUPPORT
1174 #define is_name(c) ((c) == '_' || isalpha((unsigned char)(c)))
1175 #define is_in_name(c) ((c) == '_' || isalnum((unsigned char)(c)))
1176 static char *endofname(const char *name)
1184 if (!is_in_name(*p))
1190 static void arith_set_local_var(const char *name, const char *val, int flags)
1192 /* arith code doesnt malloc space, so do it for it */
1193 char *var = xasprintf("%s=%s", name, val);
1194 set_local_var(var, flags, 0);
1202 static int static_get(struct in_str *i)
1211 static int static_peek(struct in_str *i)
1216 #if ENABLE_HUSH_INTERACTIVE
1218 static void cmdedit_set_initial_prompt(void)
1220 if (ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1221 G.PS1 = getenv("PS1");
1228 static const char* setup_prompt_string(int promptmode)
1230 const char *prompt_str;
1231 debug_printf("setup_prompt_string %d ", promptmode);
1232 if (!ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1233 /* Set up the prompt */
1234 if (promptmode == 0) { /* PS1 */
1236 G.PS1 = xasprintf("%s %c ", G.cwd, (geteuid() != 0) ? '$' : '#');
1241 prompt_str = (promptmode == 0) ? G.PS1 : G.PS2;
1242 debug_printf("result '%s'\n", prompt_str);
1246 static void get_user_input(struct in_str *i)
1249 const char *prompt_str;
1251 prompt_str = setup_prompt_string(i->promptmode);
1252 #if ENABLE_FEATURE_EDITING
1253 /* Enable command line editing only while a command line
1254 * is actually being read */
1257 /* buglet: SIGINT will not make new prompt to appear _at once_,
1258 * only after <Enter>. (^C will work) */
1259 r = read_line_input(prompt_str, G.user_input_buf, BUFSIZ-1, G.line_input_state);
1260 /* catch *SIGINT* etc (^C is handled by read_line_input) */
1261 check_and_run_traps(0);
1262 } while (r == 0 || G.flag_SIGINT); /* repeat if ^C or SIGINT */
1263 i->eof_flag = (r < 0);
1264 if (i->eof_flag) { /* EOF/error detected */
1265 G.user_input_buf[0] = EOF; /* yes, it will be truncated, it's ok */
1266 G.user_input_buf[1] = '\0';
1271 fputs(prompt_str, stdout);
1273 G.user_input_buf[0] = r = fgetc(i->file);
1274 /*G.user_input_buf[1] = '\0'; - already is and never changed */
1275 //do we need check_and_run_traps(0)? (maybe only if stdin)
1276 } while (G.flag_SIGINT);
1277 i->eof_flag = (r == EOF);
1279 i->p = G.user_input_buf;
1282 #endif /* INTERACTIVE */
1284 /* This is the magic location that prints prompts
1285 * and gets data back from the user */
1286 static int file_get(struct in_str *i)
1290 /* If there is data waiting, eat it up */
1291 if (i->p && *i->p) {
1292 #if ENABLE_HUSH_INTERACTIVE
1296 if (i->eof_flag && !*i->p)
1299 /* need to double check i->file because we might be doing something
1300 * more complicated by now, like sourcing or substituting. */
1301 #if ENABLE_HUSH_INTERACTIVE
1302 if (G_interactive_fd && i->promptme && i->file == stdin) {
1305 } while (!*i->p); /* need non-empty line */
1306 i->promptmode = 1; /* PS2 */
1311 ch = fgetc(i->file);
1313 debug_printf("file_get: got a '%c' %d\n", ch, ch);
1314 #if ENABLE_HUSH_INTERACTIVE
1321 /* All the callers guarantee this routine will never be
1322 * used right after a newline, so prompting is not needed.
1324 static int file_peek(struct in_str *i)
1327 if (i->p && *i->p) {
1328 if (i->eof_flag && !i->p[1])
1332 ch = fgetc(i->file);
1333 i->eof_flag = (ch == EOF);
1334 i->peek_buf[0] = ch;
1335 i->peek_buf[1] = '\0';
1337 debug_printf("file_peek: got a '%c' %d\n", *i->p, *i->p);
1341 static void setup_file_in_str(struct in_str *i, FILE *f)
1343 i->peek = file_peek;
1345 #if ENABLE_HUSH_INTERACTIVE
1347 i->promptmode = 0; /* PS1 */
1353 static void setup_string_in_str(struct in_str *i, const char *s)
1355 i->peek = static_peek;
1356 i->get = static_get;
1357 #if ENABLE_HUSH_INTERACTIVE
1359 i->promptmode = 0; /* PS1 */
1369 #define B_CHUNK (32 * sizeof(char*))
1371 static void o_reset(o_string *o)
1379 static void o_free(o_string *o)
1382 memset(o, 0, sizeof(*o));
1385 static ALWAYS_INLINE void o_free_unsafe(o_string *o)
1390 static void o_grow_by(o_string *o, int len)
1392 if (o->length + len > o->maxlen) {
1393 o->maxlen += (2*len > B_CHUNK ? 2*len : B_CHUNK);
1394 o->data = xrealloc(o->data, 1 + o->maxlen);
1398 static void o_addchr(o_string *o, int ch)
1400 debug_printf("o_addchr: '%c' o->length=%d o=%p\n", ch, o->length, o);
1402 o->data[o->length] = ch;
1404 o->data[o->length] = '\0';
1407 static void o_addblock(o_string *o, const char *str, int len)
1410 memcpy(&o->data[o->length], str, len);
1412 o->data[o->length] = '\0';
1416 static void o_addstr(o_string *o, const char *str)
1418 o_addblock(o, str, strlen(str));
1422 static void o_addstr_with_NUL(o_string *o, const char *str)
1424 o_addblock(o, str, strlen(str) + 1);
1427 static void o_addblock_duplicate_backslash(o_string *o, const char *str, int len)
1432 && (*str != '*' && *str != '?' && *str != '[')
1440 /* My analysis of quoting semantics tells me that state information
1441 * is associated with a destination, not a source.
1443 static void o_addqchr(o_string *o, int ch)
1446 char *found = strchr("*?[\\", ch);
1451 o->data[o->length] = '\\';
1454 o->data[o->length] = ch;
1456 o->data[o->length] = '\0';
1459 static void o_addQchr(o_string *o, int ch)
1462 if (o->o_escape && strchr("*?[\\", ch)) {
1464 o->data[o->length] = '\\';
1468 o->data[o->length] = ch;
1470 o->data[o->length] = '\0';
1473 static void o_addQstr(o_string *o, const char *str, int len)
1476 o_addblock(o, str, len);
1482 int ordinary_cnt = strcspn(str, "*?[\\");
1483 if (ordinary_cnt > len) /* paranoia */
1485 o_addblock(o, str, ordinary_cnt);
1486 if (ordinary_cnt == len)
1488 str += ordinary_cnt;
1489 len -= ordinary_cnt + 1; /* we are processing + 1 char below */
1493 if (ch) { /* it is necessarily one of "*?[\\" */
1495 o->data[o->length] = '\\';
1499 o->data[o->length] = ch;
1501 o->data[o->length] = '\0';
1505 /* A special kind of o_string for $VAR and `cmd` expansion.
1506 * It contains char* list[] at the beginning, which is grown in 16 element
1507 * increments. Actual string data starts at the next multiple of 16 * (char*).
1508 * list[i] contains an INDEX (int!) into this string data.
1509 * It means that if list[] needs to grow, data needs to be moved higher up
1510 * but list[i]'s need not be modified.
1511 * NB: remembering how many list[i]'s you have there is crucial.
1512 * o_finalize_list() operation post-processes this structure - calculates
1513 * and stores actual char* ptrs in list[]. Oh, it NULL terminates it as well.
1515 #if DEBUG_EXPAND || DEBUG_GLOB
1516 static void debug_print_list(const char *prefix, o_string *o, int n)
1518 char **list = (char**)o->data;
1519 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1521 fprintf(stderr, "%s: list:%p n:%d string_start:%d length:%d maxlen:%d\n",
1522 prefix, list, n, string_start, o->length, o->maxlen);
1524 fprintf(stderr, " list[%d]=%d '%s' %p\n", i, (int)list[i],
1525 o->data + (int)list[i] + string_start,
1526 o->data + (int)list[i] + string_start);
1530 const char *p = o->data + (int)list[n - 1] + string_start;
1531 fprintf(stderr, " total_sz:%ld\n", (long)((p + strlen(p) + 1) - o->data));
1535 #define debug_print_list(prefix, o, n) ((void)0)
1538 /* n = o_save_ptr_helper(str, n) "starts new string" by storing an index value
1539 * in list[n] so that it points past last stored byte so far.
1540 * It returns n+1. */
1541 static int o_save_ptr_helper(o_string *o, int n)
1543 char **list = (char**)o->data;
1547 if (!o->has_empty_slot) {
1548 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1549 string_len = o->length - string_start;
1550 if (!(n & 0xf)) { /* 0, 0x10, 0x20...? */
1551 debug_printf_list("list[%d]=%d string_start=%d (growing)\n", n, string_len, string_start);
1552 /* list[n] points to string_start, make space for 16 more pointers */
1553 o->maxlen += 0x10 * sizeof(list[0]);
1554 o->data = xrealloc(o->data, o->maxlen + 1);
1555 list = (char**)o->data;
1556 memmove(list + n + 0x10, list + n, string_len);
1557 o->length += 0x10 * sizeof(list[0]);
1559 debug_printf_list("list[%d]=%d string_start=%d\n",
1560 n, string_len, string_start);
1563 /* We have empty slot at list[n], reuse without growth */
1564 string_start = ((n+1 + 0xf) & ~0xf) * sizeof(list[0]); /* NB: n+1! */
1565 string_len = o->length - string_start;
1566 debug_printf_list("list[%d]=%d string_start=%d (empty slot)\n",
1567 n, string_len, string_start);
1568 o->has_empty_slot = 0;
1570 list[n] = (char*)(ptrdiff_t)string_len;
1574 /* "What was our last o_save_ptr'ed position (byte offset relative o->data)?" */
1575 static int o_get_last_ptr(o_string *o, int n)
1577 char **list = (char**)o->data;
1578 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1580 return ((int)(ptrdiff_t)list[n-1]) + string_start;
1583 /* o_glob performs globbing on last list[], saving each result
1584 * as a new list[]. */
1585 static int o_glob(o_string *o, int n)
1591 debug_printf_glob("start o_glob: n:%d o->data:%p\n", n, o->data);
1593 return o_save_ptr_helper(o, n);
1594 pattern = o->data + o_get_last_ptr(o, n);
1595 debug_printf_glob("glob pattern '%s'\n", pattern);
1596 if (!glob_needed(pattern)) {
1598 o->length = unbackslash(pattern) - o->data;
1599 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
1600 return o_save_ptr_helper(o, n);
1603 memset(&globdata, 0, sizeof(globdata));
1604 gr = glob(pattern, 0, NULL, &globdata);
1605 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
1606 if (gr == GLOB_NOSPACE)
1607 bb_error_msg_and_die("out of memory during glob");
1608 if (gr == GLOB_NOMATCH) {
1609 globfree(&globdata);
1612 if (gr != 0) { /* GLOB_ABORTED ? */
1613 //TODO: testcase for bad glob pattern behavior
1614 bb_error_msg("glob(3) error %d on '%s'", gr, pattern);
1616 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
1617 char **argv = globdata.gl_pathv;
1618 o->length = pattern - o->data; /* "forget" pattern */
1620 o_addstr_with_NUL(o, *argv);
1621 n = o_save_ptr_helper(o, n);
1627 globfree(&globdata);
1629 debug_print_list("o_glob returning", o, n);
1633 /* If o->o_glob == 1, glob the string so far remembered.
1634 * Otherwise, just finish current list[] and start new */
1635 static int o_save_ptr(o_string *o, int n)
1637 if (o->o_glob) { /* if globbing is requested */
1638 /* If o->has_empty_slot, list[n] was already globbed
1639 * (if it was requested back then when it was filled)
1640 * so don't do that again! */
1641 if (!o->has_empty_slot)
1642 return o_glob(o, n); /* o_save_ptr_helper is inside */
1644 return o_save_ptr_helper(o, n);
1647 /* "Please convert list[n] to real char* ptrs, and NULL terminate it." */
1648 static char **o_finalize_list(o_string *o, int n)
1653 n = o_save_ptr(o, n); /* force growth for list[n] if necessary */
1655 debug_print_list("finalized", o, n);
1656 debug_printf_expand("finalized n:%d\n", n);
1657 list = (char**)o->data;
1658 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1662 list[n] = o->data + (int)(ptrdiff_t)list[n] + string_start;
1668 /* Expansion can recurse */
1669 #if ENABLE_HUSH_TICK
1670 static int process_command_subs(o_string *dest, const char *s);
1672 static char *expand_string_to_string(const char *str);
1674 #define parse_stream_dquoted(ctx, dest, input, dquote_end) \
1675 parse_stream_dquoted(dest, input, dquote_end)
1677 static int parse_stream_dquoted(struct parse_context *ctx,
1679 struct in_str *input,
1682 /* expand_strvec_to_strvec() takes a list of strings, expands
1683 * all variable references within and returns a pointer to
1684 * a list of expanded strings, possibly with larger number
1685 * of strings. (Think VAR="a b"; echo $VAR).
1686 * This new list is allocated as a single malloc block.
1687 * NULL-terminated list of char* pointers is at the beginning of it,
1688 * followed by strings themself.
1689 * Caller can deallocate entire list by single free(list). */
1691 /* Store given string, finalizing the word and starting new one whenever
1692 * we encounter IFS char(s). This is used for expanding variable values.
1693 * End-of-string does NOT finalize word: think about 'echo -$VAR-' */
1694 static int expand_on_ifs(o_string *output, int n, const char *str)
1697 int word_len = strcspn(str, G.ifs);
1699 if (output->o_escape || !output->o_glob)
1700 o_addQstr(output, str, word_len);
1701 else /* protect backslashes against globbing up :) */
1702 o_addblock_duplicate_backslash(output, str, word_len);
1705 if (!*str) /* EOL - do not finalize word */
1707 o_addchr(output, '\0');
1708 debug_print_list("expand_on_ifs", output, n);
1709 n = o_save_ptr(output, n);
1710 str += strspn(str, G.ifs); /* skip ifs chars */
1712 debug_print_list("expand_on_ifs[1]", output, n);
1716 /* Expand all variable references in given string, adding words to list[]
1717 * at n, n+1,... positions. Return updated n (so that list[n] is next one
1718 * to be filled). This routine is extremely tricky: has to deal with
1719 * variables/parameters with whitespace, $* and $@, and constructs like
1720 * 'echo -$*-'. If you play here, you must run testsuite afterwards! */
1721 static int expand_vars_to_list(o_string *output, int n, char *arg, char or_mask)
1723 /* or_mask is either 0 (normal case) or 0x80
1724 * (expansion of right-hand side of assignment == 1-element expand.
1725 * It will also do no globbing, and thus we must not backslash-quote!) */
1727 char first_ch, ored_ch;
1734 debug_printf_expand("expand_vars_to_list: arg '%s'\n", arg);
1735 debug_print_list("expand_vars_to_list", output, n);
1736 n = o_save_ptr(output, n);
1737 debug_print_list("expand_vars_to_list[0]", output, n);
1739 while ((p = strchr(arg, SPECIAL_VAR_SYMBOL)) != NULL) {
1740 #if ENABLE_HUSH_TICK
1741 o_string subst_result = NULL_O_STRING;
1743 #if ENABLE_SH_MATH_SUPPORT
1744 char arith_buf[sizeof(arith_t)*3 + 2];
1746 o_addblock(output, arg, p - arg);
1747 debug_print_list("expand_vars_to_list[1]", output, n);
1749 p = strchr(p, SPECIAL_VAR_SYMBOL);
1751 first_ch = arg[0] | or_mask; /* forced to "quoted" if or_mask = 0x80 */
1752 /* "$@" is special. Even if quoted, it can still
1753 * expand to nothing (not even an empty string) */
1754 if ((first_ch & 0x7f) != '@')
1755 ored_ch |= first_ch;
1758 switch (first_ch & 0x7f) {
1759 /* Highest bit in first_ch indicates that var is double-quoted */
1761 val = utoa(G.root_pid);
1763 case '!': /* bg pid */
1764 val = G.last_bg_pid ? utoa(G.last_bg_pid) : (char*)"";
1766 case '?': /* exitcode */
1767 val = utoa(G.last_return_code);
1769 case '#': /* argc */
1770 if (arg[1] != SPECIAL_VAR_SYMBOL)
1771 /* actually, it's a ${#var} */
1773 val = utoa(G.global_argc ? G.global_argc-1 : 0);
1778 if (!G.global_argv[i])
1780 ored_ch |= first_ch; /* do it for "$@" _now_, when we know it's not empty */
1781 if (!(first_ch & 0x80)) { /* unquoted $* or $@ */
1782 smallint sv = output->o_escape;
1783 /* unquoted var's contents should be globbed, so don't escape */
1784 output->o_escape = 0;
1785 while (G.global_argv[i]) {
1786 n = expand_on_ifs(output, n, G.global_argv[i]);
1787 debug_printf_expand("expand_vars_to_list: argv %d (last %d)\n", i, G.global_argc - 1);
1788 if (G.global_argv[i++][0] && G.global_argv[i]) {
1789 /* this argv[] is not empty and not last:
1790 * put terminating NUL, start new word */
1791 o_addchr(output, '\0');
1792 debug_print_list("expand_vars_to_list[2]", output, n);
1793 n = o_save_ptr(output, n);
1794 debug_print_list("expand_vars_to_list[3]", output, n);
1797 output->o_escape = sv;
1799 /* If or_mask is nonzero, we handle assignment 'a=....$@.....'
1800 * and in this case should treat it like '$*' - see 'else...' below */
1801 if (first_ch == ('@'|0x80) && !or_mask) { /* quoted $@ */
1803 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
1804 if (++i >= G.global_argc)
1806 o_addchr(output, '\0');
1807 debug_print_list("expand_vars_to_list[4]", output, n);
1808 n = o_save_ptr(output, n);
1810 } else { /* quoted $*: add as one word */
1812 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
1813 if (!G.global_argv[++i])
1816 o_addchr(output, G.ifs[0]);
1820 case SPECIAL_VAR_SYMBOL: /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_SYMBOL> */
1821 /* "Empty variable", used to make "" etc to not disappear */
1825 #if ENABLE_HUSH_TICK
1826 case '`': /* <SPECIAL_VAR_SYMBOL>`cmd<SPECIAL_VAR_SYMBOL> */
1829 //TODO: can we just stuff it into "output" directly?
1830 debug_printf_subst("SUBST '%s' first_ch %x\n", arg, first_ch);
1831 process_command_subs(&subst_result, arg);
1832 debug_printf_subst("SUBST RES '%s'\n", subst_result.data);
1833 val = subst_result.data;
1836 #if ENABLE_SH_MATH_SUPPORT
1837 case '+': { /* <SPECIAL_VAR_SYMBOL>+cmd<SPECIAL_VAR_SYMBOL> */
1838 arith_eval_hooks_t hooks;
1843 arg++; /* skip '+' */
1844 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
1845 debug_printf_subst("ARITH '%s' first_ch %x\n", arg, first_ch);
1847 /* Optional: skip expansion if expr is simple ("a + 3", "i++" etc) */
1850 unsigned char c = *exp_str++;
1857 if (strchr(" \t+-*/%_", c) != NULL)
1859 c |= 0x20; /* tolower */
1860 if (c >= 'a' && c <= 'z')
1864 /* We need to expand. Example: "echo $(($a + 1)) $((1 + $((2)) ))" */
1866 struct in_str input;
1867 o_string dest = NULL_O_STRING;
1869 setup_string_in_str(&input, arg);
1870 parse_stream_dquoted(NULL, &dest, &input, EOF);
1871 //bb_error_msg("'%s' -> '%s'", arg, dest.data);
1872 exp_str = expand_string_to_string(dest.data);
1873 //bb_error_msg("'%s' -> '%s'", dest.data, exp_str);
1877 hooks.lookupvar = get_local_var_value;
1878 hooks.setvar = arith_set_local_var;
1879 hooks.endofname = endofname;
1880 res = arith(exp_str ? exp_str : arg, &errcode, &hooks);
1885 case -3: maybe_die("arith", "exponent less than 0"); break;
1886 case -2: maybe_die("arith", "divide by zero"); break;
1887 case -5: maybe_die("arith", "expression recursion loop detected"); break;
1888 default: maybe_die("arith", "syntax error"); break;
1891 debug_printf_subst("ARITH RES '"arith_t_fmt"'\n", res);
1892 sprintf(arith_buf, arith_t_fmt, res);
1897 default: /* <SPECIAL_VAR_SYMBOL>varname<SPECIAL_VAR_SYMBOL> */
1899 bool exp_len = false, exp_null = false;
1900 char *var = arg, exp_save, exp_op, *exp_word;
1903 arg[0] = first_ch & 0x7f;
1905 /* prepare for expansions */
1906 if (var[0] == '#') {
1907 /* handle length expansion ${#var} */
1911 /* maybe handle parameter expansion */
1912 exp_off = strcspn(var, ":-=+?");
1916 exp_save = var[exp_off];
1917 exp_null = exp_save == ':';
1918 exp_word = var + exp_off;
1919 if (exp_null) ++exp_word;
1920 exp_op = *exp_word++;
1921 var[exp_off] = '\0';
1925 /* lookup the variable in question */
1926 if (isdigit(var[0])) {
1927 /* handle_dollar() should have vetted var for us */
1929 if (i < G.global_argc)
1930 val = G.global_argv[i];
1931 /* else val remains NULL: $N with too big N */
1933 val = get_local_var_value(var);
1935 /* handle any expansions */
1937 debug_printf_expand("expand: length of '%s' = ", val);
1938 val = utoa(val ? strlen(val) : 0);
1939 debug_printf_expand("%s\n", val);
1940 } else if (exp_off) {
1941 /* we need to do an expansion */
1942 int exp_test = (!val || (exp_null && !val[0]));
1944 exp_test = !exp_test;
1945 debug_printf_expand("expand: op:%c (null:%s) test:%i\n", exp_op,
1946 exp_null ? "true" : "false", exp_test);
1949 maybe_die(var, *exp_word ? exp_word : "parameter null or not set");
1953 if (exp_op == '=') {
1954 if (isdigit(var[0]) || var[0] == '#') {
1955 maybe_die(var, "special vars cannot assign in this way");
1958 char *new_var = xmalloc(strlen(var) + strlen(val) + 2);
1959 sprintf(new_var, "%s=%s", var, val);
1960 set_local_var(new_var, -1, 0);
1964 var[exp_off] = exp_save;
1968 #if ENABLE_HUSH_TICK
1971 if (!(first_ch & 0x80)) { /* unquoted $VAR */
1972 debug_printf_expand("unquoted '%s', output->o_escape:%d\n", val, output->o_escape);
1974 /* unquoted var's contents should be globbed, so don't escape */
1975 smallint sv = output->o_escape;
1976 output->o_escape = 0;
1977 n = expand_on_ifs(output, n, val);
1979 output->o_escape = sv;
1981 } else { /* quoted $VAR, val will be appended below */
1982 debug_printf_expand("quoted '%s', output->o_escape:%d\n", val, output->o_escape);
1985 } /* switch (char after <SPECIAL_VAR_SYMBOL>) */
1987 o_addQstr(output, val, strlen(val));
1989 /* Do the check to avoid writing to a const string */
1990 if (*p != SPECIAL_VAR_SYMBOL)
1991 *p = SPECIAL_VAR_SYMBOL;
1993 #if ENABLE_HUSH_TICK
1994 o_free(&subst_result);
1997 } /* end of "while (SPECIAL_VAR_SYMBOL is found) ..." */
2000 debug_print_list("expand_vars_to_list[a]", output, n);
2001 /* this part is literal, and it was already pre-quoted
2002 * if needed (much earlier), do not use o_addQstr here! */
2003 o_addstr_with_NUL(output, arg);
2004 debug_print_list("expand_vars_to_list[b]", output, n);
2005 } else if (output->length == o_get_last_ptr(output, n) /* expansion is empty */
2006 && !(ored_ch & 0x80) /* and all vars were not quoted. */
2009 /* allow to reuse list[n] later without re-growth */
2010 output->has_empty_slot = 1;
2012 o_addchr(output, '\0');
2017 static char **expand_variables(char **argv, int or_mask)
2022 o_string output = NULL_O_STRING;
2024 if (or_mask & 0x100) {
2025 output.o_escape = 1; /* protect against globbing for "$var" */
2026 /* (unquoted $var will temporarily switch it off) */
2033 n = expand_vars_to_list(&output, n, *v, (char)or_mask);
2036 debug_print_list("expand_variables", &output, n);
2038 /* output.data (malloced in one block) gets returned in "list" */
2039 list = o_finalize_list(&output, n);
2040 debug_print_strings("expand_variables[1]", list);
2044 static char **expand_strvec_to_strvec(char **argv)
2046 return expand_variables(argv, 0x100);
2049 /* Used for expansion of right hand of assignments */
2050 /* NB: should NOT do globbing! "export v=/bin/c*; env | grep ^v=" outputs
2052 static char *expand_string_to_string(const char *str)
2054 char *argv[2], **list;
2056 argv[0] = (char*)str;
2058 list = expand_variables(argv, 0x80); /* 0x80: make one-element expansion */
2060 if (!list[0] || list[1])
2061 bb_error_msg_and_die("BUG in varexp2");
2062 /* actually, just move string 2*sizeof(char*) bytes back */
2063 overlapping_strcpy((char*)list, list[0]);
2064 debug_printf_expand("string_to_string='%s'\n", (char*)list);
2068 /* Used for "eval" builtin */
2069 static char* expand_strvec_to_string(char **argv)
2073 list = expand_variables(argv, 0x80);
2074 /* Convert all NULs to spaces */
2079 if (list[n-1] + strlen(list[n-1]) + 1 != list[n])
2080 bb_error_msg_and_die("BUG in varexp3");
2081 list[n][-1] = ' '; /* TODO: or to G.ifs[0]? */
2085 overlapping_strcpy((char*)list, list[0]);
2086 debug_printf_expand("strvec_to_string='%s'\n", (char*)list);
2090 static char **expand_assignments(char **argv, int count)
2094 /* Expand assignments into one string each */
2095 for (i = 0; i < count; i++) {
2096 p = add_string_to_strings(p, expand_string_to_string(argv[i]));
2102 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
2103 * and stderr if they are redirected. */
2104 static int setup_redirects(struct command *prog, int squirrel[])
2107 struct redir_struct *redir;
2109 for (redir = prog->redirects; redir; redir = redir->next) {
2110 if (redir->dup == -1 && redir->rd_filename == NULL) {
2111 /* something went wrong in the parse. Pretend it didn't happen */
2114 if (redir->dup == -1) {
2116 mode = redir_table[redir->rd_type].mode;
2117 //TODO: check redir for names like '\\'
2118 p = expand_string_to_string(redir->rd_filename);
2119 openfd = open_or_warn(p, mode);
2122 /* this could get lost if stderr has been redirected, but
2123 bash and ash both lose it as well (though zsh doesn't!) */
2127 openfd = redir->dup;
2130 if (openfd != redir->fd) {
2131 if (squirrel && redir->fd < 3) {
2132 squirrel[redir->fd] = dup(redir->fd);
2135 //close(openfd); // close(-3) ??!
2137 dup2(openfd, redir->fd);
2138 if (redir->dup == -1)
2146 static void restore_redirects(int squirrel[])
2149 for (i = 0; i < 3; i++) {
2152 /* We simply die on error */
2159 #if !defined(DEBUG_CLEAN)
2160 #define free_pipe_list(head, indent) free_pipe_list(head)
2161 #define free_pipe(pi, indent) free_pipe(pi)
2163 static void free_pipe_list(struct pipe *head, int indent);
2165 /* Return code is the exit status of the pipe */
2166 static void free_pipe(struct pipe *pi, int indent)
2169 struct command *command;
2170 struct redir_struct *r, *rnext;
2173 if (pi->stopped_cmds > 0) /* why? */
2175 debug_printf_clean("%s run pipe: (pid %d)\n", indenter(indent), getpid());
2176 for (i = 0; i < pi->num_cmds; i++) {
2177 command = &pi->cmds[i];
2178 debug_printf_clean("%s command %d:\n", indenter(indent), i);
2179 if (command->argv) {
2180 for (a = 0, p = command->argv; *p; a++, p++) {
2181 debug_printf_clean("%s argv[%d] = %s\n", indenter(indent), a, *p);
2183 free_strings(command->argv);
2184 command->argv = NULL;
2186 /* not "else if": on syntax error, we may have both! */
2187 if (command->group) {
2188 debug_printf_clean("%s begin group (grp_type:%d)\n", indenter(indent), command->grp_type);
2189 free_pipe_list(command->group, indent+3);
2190 debug_printf_clean("%s end group\n", indenter(indent));
2191 command->group = NULL;
2194 free(command->group_as_string);
2195 command->group_as_string = NULL;
2197 for (r = command->redirects; r; r = rnext) {
2198 debug_printf_clean("%s redirect %d%s", indenter(indent), r->fd, redir_table[r->rd_type].descrip);
2200 /* guard against the case >$FOO, where foo is unset or blank */
2201 if (r->rd_filename) {
2202 debug_printf_clean(" %s\n", r->rd_filename);
2203 free(r->rd_filename);
2204 r->rd_filename = NULL;
2207 debug_printf_clean("&%d\n", r->dup);
2212 command->redirects = NULL;
2214 free(pi->cmds); /* children are an array, they get freed all at once */
2222 static void free_pipe_list(struct pipe *head, int indent)
2224 struct pipe *pi, *next;
2226 for (pi = head; pi; pi = next) {
2228 debug_printf_clean("%s pipe reserved mode %d\n", indenter(indent), pi->res_word);
2230 free_pipe(pi, indent);
2231 debug_printf_clean("%s pipe followup code %d\n", indenter(indent), pi->followup);
2233 /*pi->next = NULL;*/
2240 typedef struct nommu_save_t {
2246 #define pseudo_exec_argv(nommu_save, argv, assignment_cnt, argv_expanded) \
2247 pseudo_exec_argv(argv, assignment_cnt, argv_expanded)
2248 #define pseudo_exec(nommu_save, command, argv_expanded) \
2249 pseudo_exec(command, argv_expanded)
2252 /* Called after [v]fork() in run_pipe(), or from builtin_exec().
2254 * XXX no exit() here. If you don't exec, use _exit instead.
2255 * The at_exit handlers apparently confuse the calling process,
2256 * in particular stdin handling. Not sure why? -- because of vfork! (vda) */
2257 static void pseudo_exec_argv(nommu_save_t *nommu_save,
2258 char **argv, int assignment_cnt,
2259 char **argv_expanded) NORETURN;
2260 static void pseudo_exec_argv(nommu_save_t *nommu_save,
2261 char **argv, int assignment_cnt,
2262 char **argv_expanded)
2266 /* Case when we are here: ... | var=val | ... */
2267 if (!argv[assignment_cnt])
2268 _exit(EXIT_SUCCESS);
2270 new_env = expand_assignments(argv, assignment_cnt);
2272 putenv_all(new_env);
2273 free(new_env); /* optional */
2275 nommu_save->new_env = new_env;
2276 nommu_save->old_env = putenv_all_and_save_old(new_env);
2278 if (argv_expanded) {
2279 argv = argv_expanded;
2281 argv = expand_strvec_to_strvec(argv + assignment_cnt);
2283 nommu_save->argv = argv;
2287 /* On NOMMU, we must never block!
2288 * Example: { sleep 99999 | read line } & echo Ok
2289 * read builtin will block on read syscall, leaving parent blocked
2290 * in vfork. Therefore we can't do this:
2293 /* Check if the command matches any of the builtins.
2294 * Depending on context, this might be redundant. But it's
2295 * easier to waste a few CPU cycles than it is to figure out
2296 * if this is one of those cases.
2300 const struct built_in_command *x;
2301 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
2302 if (strcmp(argv[0], x->cmd) == 0) {
2303 debug_printf_exec("running builtin '%s'\n",
2305 rcode = x->function(argv);
2313 #if ENABLE_FEATURE_SH_STANDALONE
2314 /* Check if the command matches any busybox applets */
2315 if (strchr(argv[0], '/') == NULL) {
2316 int a = find_applet_by_name(argv[0]);
2318 #if BB_MMU /* see above why on NOMMU it is not allowed */
2319 if (APPLET_IS_NOEXEC(a)) {
2320 debug_printf_exec("running applet '%s'\n", argv[0]);
2321 run_applet_no_and_exit(a, argv);
2324 /* Re-exec ourselves */
2325 debug_printf_exec("re-execing applet '%s'\n", argv[0]);
2326 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
2327 execv(bb_busybox_exec_path, argv);
2328 /* If they called chroot or otherwise made the binary no longer
2329 * executable, fall through */
2334 debug_printf_exec("execing '%s'\n", argv[0]);
2335 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
2336 execvp(argv[0], argv);
2337 bb_perror_msg("can't exec '%s'", argv[0]);
2338 _exit(EXIT_FAILURE);
2341 static void re_execute_shell(const char *s) NORETURN;
2342 static void re_execute_shell(const char *s)
2344 struct variable *cur;
2348 /* hush -$<pid> -?<exitcode> -D<depth> ... -c <cmd> NULL */
2350 for (cur = G.top_var; cur; cur = cur->next) {
2351 if (!cur->flg_export || cur->flg_read_only)
2354 //TODO: need to free these strings in parent!
2355 argv = pp = xmalloc(sizeof(argv[0]) * cnt);
2356 *pp++ = (char *) applet_name;
2357 *pp++ = xasprintf("-$%u", G.root_pid);
2358 *pp++ = xasprintf("-?%u", G.last_return_code);
2359 *pp++ = xasprintf("-D%u", G.depth_of_loop);
2360 for (cur = G.top_var; cur; cur = cur->next) {
2361 if (cur->varstr == hush_version_str)
2363 if (cur->flg_read_only) {
2364 *pp++ = (char *) "-R";
2365 *pp++ = cur->varstr;
2366 } else if (!cur->flg_export) {
2367 *pp++ = (char *) "-V";
2368 *pp++ = cur->varstr;
2371 *pp++ = (char *) "-c";
2375 //TODO: pass traps and functions
2377 debug_printf_exec("re_execute_shell pid:%d cmd:'%s'\n", getpid(), s);
2378 execv(bb_busybox_exec_path, argv);
2379 //TODO: fallback for init=/bin/hush?
2383 static int run_list(struct pipe *pi);
2385 /* Called after [v]fork() in run_pipe()
2387 static void pseudo_exec(nommu_save_t *nommu_save,
2388 struct command *command,
2389 char **argv_expanded) NORETURN;
2390 static void pseudo_exec(nommu_save_t *nommu_save,
2391 struct command *command,
2392 char **argv_expanded)
2394 if (command->argv) {
2395 pseudo_exec_argv(nommu_save, command->argv,
2396 command->assignment_cnt, argv_expanded);
2399 if (command->group) {
2400 /* Cases when we are here:
2403 * ... | ( list ) | ...
2404 * ... | { list } | ...
2408 debug_printf_exec("pseudo_exec: run_list\n");
2409 rcode = run_list(command->group);
2410 /* OK to leak memory by not calling free_pipe_list,
2411 * since this process is about to exit */
2414 re_execute_shell(command->group_as_string);
2418 /* Case when we are here: ... | >file */
2419 debug_printf_exec("pseudo_exec'ed null command\n");
2420 _exit(EXIT_SUCCESS);
2424 static const char *get_cmdtext(struct pipe *pi)
2430 /* This is subtle. ->cmdtext is created only on first backgrounding.
2431 * (Think "cat, <ctrl-z>, fg, <ctrl-z>, fg, <ctrl-z>...." here...)
2432 * On subsequent bg argv is trashed, but we won't use it */
2435 argv = pi->cmds[0].argv;
2436 if (!argv || !argv[0]) {
2437 pi->cmdtext = xzalloc(1);
2442 do len += strlen(*argv) + 1; while (*++argv);
2443 pi->cmdtext = p = xmalloc(len);
2444 argv = pi->cmds[0].argv;
2446 len = strlen(*argv);
2447 memcpy(p, *argv, len);
2455 static void insert_bg_job(struct pipe *pi)
2457 struct pipe *thejob;
2460 /* Linear search for the ID of the job to use */
2462 for (thejob = G.job_list; thejob; thejob = thejob->next)
2463 if (thejob->jobid >= pi->jobid)
2464 pi->jobid = thejob->jobid + 1;
2466 /* Add thejob to the list of running jobs */
2468 thejob = G.job_list = xmalloc(sizeof(*thejob));
2470 for (thejob = G.job_list; thejob->next; thejob = thejob->next)
2472 thejob->next = xmalloc(sizeof(*thejob));
2473 thejob = thejob->next;
2476 /* Physically copy the struct job */
2477 memcpy(thejob, pi, sizeof(struct pipe));
2478 thejob->cmds = xzalloc(sizeof(pi->cmds[0]) * pi->num_cmds);
2479 /* We cannot copy entire pi->cmds[] vector! Double free()s will happen */
2480 for (i = 0; i < pi->num_cmds; i++) {
2481 // TODO: do we really need to have so many fields which are just dead weight
2482 // at execution stage?
2483 thejob->cmds[i].pid = pi->cmds[i].pid;
2484 /* all other fields are not used and stay zero */
2486 thejob->next = NULL;
2487 thejob->cmdtext = xstrdup(get_cmdtext(pi));
2489 /* We don't wait for background thejobs to return -- append it
2490 to the list of backgrounded thejobs and leave it alone */
2491 if (G_interactive_fd)
2492 printf("[%d] %d %s\n", thejob->jobid, thejob->cmds[0].pid, thejob->cmdtext);
2493 G.last_bg_pid = thejob->cmds[0].pid;
2494 G.last_jobid = thejob->jobid;
2497 static void remove_bg_job(struct pipe *pi)
2499 struct pipe *prev_pipe;
2501 if (pi == G.job_list) {
2502 G.job_list = pi->next;
2504 prev_pipe = G.job_list;
2505 while (prev_pipe->next != pi)
2506 prev_pipe = prev_pipe->next;
2507 prev_pipe->next = pi->next;
2510 G.last_jobid = G.job_list->jobid;
2515 /* Remove a backgrounded job */
2516 static void delete_finished_bg_job(struct pipe *pi)
2519 pi->stopped_cmds = 0;
2525 /* Check to see if any processes have exited -- if they
2526 * have, figure out why and see if a job has completed */
2527 static int checkjobs(struct pipe* fg_pipe)
2537 debug_printf_jobs("checkjobs %p\n", fg_pipe);
2540 // if (G.handled_SIGCHLD == G.count_SIGCHLD)
2541 // /* avoid doing syscall, nothing there anyway */
2544 attributes = WUNTRACED;
2545 if (fg_pipe == NULL)
2546 attributes |= WNOHANG;
2548 /* Do we do this right?
2549 * bash-3.00# sleep 20 | false
2551 * [3]+ Stopped sleep 20 | false
2552 * bash-3.00# echo $?
2553 * 1 <========== bg pipe is not fully done, but exitcode is already known!
2556 //FIXME: non-interactive bash does not continue even if all processes in fg pipe
2557 //are stopped. Testcase: "cat | cat" in a script (not on command line)
2558 // + killall -STOP cat
2565 // i = G.count_SIGCHLD;
2566 childpid = waitpid(-1, &status, attributes);
2567 if (childpid <= 0) {
2568 if (childpid && errno != ECHILD)
2569 bb_perror_msg("waitpid");
2570 // else /* Until next SIGCHLD, waitpid's are useless */
2571 // G.handled_SIGCHLD = i;
2574 dead = WIFEXITED(status) || WIFSIGNALED(status);
2577 if (WIFSTOPPED(status))
2578 debug_printf_jobs("pid %d stopped by sig %d (exitcode %d)\n",
2579 childpid, WSTOPSIG(status), WEXITSTATUS(status));
2580 if (WIFSIGNALED(status))
2581 debug_printf_jobs("pid %d killed by sig %d (exitcode %d)\n",
2582 childpid, WTERMSIG(status), WEXITSTATUS(status));
2583 if (WIFEXITED(status))
2584 debug_printf_jobs("pid %d exited, exitcode %d\n",
2585 childpid, WEXITSTATUS(status));
2587 /* Were we asked to wait for fg pipe? */
2589 for (i = 0; i < fg_pipe->num_cmds; i++) {
2590 debug_printf_jobs("check pid %d\n", fg_pipe->cmds[i].pid);
2591 if (fg_pipe->cmds[i].pid != childpid)
2593 /* printf("process %d exit %d\n", i, WEXITSTATUS(status)); */
2595 fg_pipe->cmds[i].pid = 0;
2596 fg_pipe->alive_cmds--;
2597 if (i == fg_pipe->num_cmds - 1) {
2598 /* last process gives overall exitstatus */
2599 rcode = WEXITSTATUS(status);
2600 IF_HAS_KEYWORDS(if (fg_pipe->pi_inverted) rcode = !rcode;)
2603 fg_pipe->cmds[i].is_stopped = 1;
2604 fg_pipe->stopped_cmds++;
2606 debug_printf_jobs("fg_pipe: alive_cmds %d stopped_cmds %d\n",
2607 fg_pipe->alive_cmds, fg_pipe->stopped_cmds);
2608 if (fg_pipe->alive_cmds - fg_pipe->stopped_cmds <= 0) {
2609 /* All processes in fg pipe have exited/stopped */
2611 if (fg_pipe->alive_cmds)
2612 insert_bg_job(fg_pipe);
2616 /* There are still running processes in the fg pipe */
2617 goto wait_more; /* do waitpid again */
2619 /* it wasnt fg_pipe, look for process in bg pipes */
2623 /* We asked to wait for bg or orphaned children */
2624 /* No need to remember exitcode in this case */
2625 for (pi = G.job_list; pi; pi = pi->next) {
2626 for (i = 0; i < pi->num_cmds; i++) {
2627 if (pi->cmds[i].pid == childpid)
2628 goto found_pi_and_prognum;
2631 /* Happens when shell is used as init process (init=/bin/sh) */
2632 debug_printf("checkjobs: pid %d was not in our list!\n", childpid);
2633 continue; /* do waitpid again */
2635 found_pi_and_prognum:
2638 pi->cmds[i].pid = 0;
2640 if (!pi->alive_cmds) {
2641 if (G_interactive_fd)
2642 printf(JOB_STATUS_FORMAT, pi->jobid,
2643 "Done", pi->cmdtext);
2644 delete_finished_bg_job(pi);
2648 pi->cmds[i].is_stopped = 1;
2652 } /* while (waitpid succeeds)... */
2658 static int checkjobs_and_fg_shell(struct pipe* fg_pipe)
2661 int rcode = checkjobs(fg_pipe);
2662 /* Job finished, move the shell to the foreground */
2663 p = getpgid(0); /* pgid of our process */
2664 debug_printf_jobs("fg'ing ourself: getpgid(0)=%d\n", (int)p);
2665 tcsetpgrp(G_interactive_fd, p);
2670 /* Start all the jobs, but don't wait for anything to finish.
2673 * Return code is normally -1, when the caller has to wait for children
2674 * to finish to determine the exit status of the pipe. If the pipe
2675 * is a simple builtin command, however, the action is done by the
2676 * time run_pipe returns, and the exit code is provided as the
2679 * Returns -1 only if started some children. IOW: we have to
2680 * mask out retvals of builtins etc with 0xff!
2682 * The only case when we do not need to [v]fork is when the pipe
2683 * is single, non-backgrounded, non-subshell command. Examples:
2684 * cmd ; ... { list } ; ...
2685 * cmd && ... { list } && ...
2686 * cmd || ... { list } || ...
2687 * If it is, then we can run cmd as a builtin, NOFORK [do we do this?],
2688 * or (if SH_STANDALONE) an applet, and we can run the { list }
2689 * with run_list(). If it isn't one of these, we fork and exec cmd.
2691 * Cases when we must fork:
2692 * non-single: cmd | cmd
2693 * backgrounded: cmd & { list } &
2694 * subshell: ( list ) [&]
2696 static int run_pipe(struct pipe *pi)
2698 static const char *const null_ptr = NULL;
2701 int pipefds[2]; /* pipefds[0] is for reading */
2702 struct command *command;
2703 char **argv_expanded;
2706 /* it is not always needed, but we aim to smaller code */
2707 int squirrel[] = { -1, -1, -1 };
2710 debug_printf_exec("run_pipe start: members:%d\n", pi->num_cmds);
2712 USE_HUSH_JOB(pi->pgrp = -1;)
2713 pi->stopped_cmds = 0;
2714 command = &(pi->cmds[0]);
2715 argv_expanded = NULL;
2717 if (pi->num_cmds != 1
2718 || pi->followup == PIPE_BG
2719 || command->grp_type == GRP_SUBSHELL
2726 debug_printf_exec(": group:%p argv:'%s'\n",
2727 command->group, command->argv ? command->argv[0] : "NONE");
2729 if (command->group) {
2730 #if ENABLE_HUSH_FUNCTIONS
2731 if (command->grp_type == GRP_FUNCTION) {
2732 /* func () { list } */
2733 bb_error_msg("here we ought to remember function definition, and go on");
2734 return EXIT_SUCCESS;
2738 debug_printf("non-subshell group\n");
2739 setup_redirects(command, squirrel);
2740 debug_printf_exec(": run_list\n");
2741 rcode = run_list(command->group) & 0xff;
2742 restore_redirects(squirrel);
2743 debug_printf_exec("run_pipe return %d\n", rcode);
2744 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
2748 argv = command->argv ? command->argv : (char **) &null_ptr;
2750 const struct built_in_command *x;
2751 char **new_env = NULL;
2752 char **old_env = NULL;
2754 if (argv[command->assignment_cnt] == NULL) {
2755 /* Assignments, but no command */
2756 /* Ensure redirects take effect. Try "a=t >file" */
2757 setup_redirects(command, squirrel);
2758 restore_redirects(squirrel);
2759 /* Set shell variables */
2761 p = expand_string_to_string(*argv);
2762 debug_printf_exec("set shell var:'%s'->'%s'\n",
2764 set_local_var(p, 0, 0);
2767 /* Do we need to flag set_local_var() errors?
2768 * "assignment to readonly var" and "putenv error"
2770 return EXIT_SUCCESS;
2773 /* Expand the rest into (possibly) many strings each */
2774 argv_expanded = expand_strvec_to_strvec(argv + command->assignment_cnt);
2776 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
2777 if (strcmp(argv_expanded[0], x->cmd) != 0)
2779 if (x->function == builtin_exec && argv_expanded[1] == NULL) {
2780 debug_printf("exec with redirects only\n");
2781 setup_redirects(command, NULL);
2782 rcode = EXIT_SUCCESS;
2783 goto clean_up_and_ret1;
2785 debug_printf("builtin inline %s\n", argv_expanded[0]);
2786 /* XXX setup_redirects acts on file descriptors, not FILEs.
2787 * This is perfect for work that comes after exec().
2788 * Is it really safe for inline use? Experimentally,
2789 * things seem to work with glibc. */
2790 setup_redirects(command, squirrel);
2791 new_env = expand_assignments(argv, command->assignment_cnt);
2792 old_env = putenv_all_and_save_old(new_env);
2793 debug_printf_exec(": builtin '%s' '%s'...\n",
2794 x->cmd, argv_expanded[1]);
2795 rcode = x->function(argv_expanded) & 0xff;
2796 #if ENABLE_FEATURE_SH_STANDALONE
2799 restore_redirects(squirrel);
2800 free_strings_and_unsetenv(new_env, 1);
2801 putenv_all(old_env);
2802 free(old_env); /* not free_strings()! */
2804 free(argv_expanded);
2805 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
2806 debug_printf_exec("run_pipe return %d\n", rcode);
2809 #if ENABLE_FEATURE_SH_STANDALONE
2810 i = find_applet_by_name(argv_expanded[0]);
2811 if (i >= 0 && APPLET_IS_NOFORK(i)) {
2812 setup_redirects(command, squirrel);
2813 save_nofork_data(&G.nofork_save);
2814 new_env = expand_assignments(argv, command->assignment_cnt);
2815 old_env = putenv_all_and_save_old(new_env);
2816 debug_printf_exec(": run_nofork_applet '%s' '%s'...\n",
2817 argv_expanded[0], argv_expanded[1]);
2818 rcode = run_nofork_applet_prime(&G.nofork_save, i, argv_expanded);
2819 goto clean_up_and_ret;
2822 /* It is neither builtin nor applet. We must fork. */
2826 /* NB: argv_expanded may already be created, and that
2827 * might include `cmd` runs! Do not rerun it! We *must*
2828 * use argv_expanded if it's non-NULL */
2830 /* Going to fork a child per each pipe member */
2834 for (i = 0; i < pi->num_cmds; i++) {
2836 volatile nommu_save_t nommu_save;
2837 nommu_save.new_env = NULL;
2838 nommu_save.old_env = NULL;
2839 nommu_save.argv = NULL;
2841 command = &(pi->cmds[i]);
2842 if (command->argv) {
2843 debug_printf_exec(": pipe member '%s' '%s'...\n",
2844 command->argv[0], command->argv[1]);
2846 debug_printf_exec(": pipe member with no argv\n");
2849 /* pipes are inserted between pairs of commands */
2852 if ((i + 1) < pi->num_cmds)
2855 command->pid = BB_MMU ? fork() : vfork();
2856 if (!command->pid) { /* child */
2858 die_sleep = 0; /* let nofork's xfuncs die */
2860 /* Every child adds itself to new process group
2861 * with pgid == pid_of_first_child_in_pipe */
2862 if (G.run_list_level == 1 && G_interactive_fd) {
2865 if (pgrp < 0) /* true for 1st process only */
2867 if (setpgid(0, pgrp) == 0 && pi->followup != PIPE_BG) {
2868 /* We do it in *every* child, not just first,
2870 tcsetpgrp(G_interactive_fd, pgrp);
2874 xmove_fd(nextin, 0);
2875 xmove_fd(pipefds[1], 1); /* write end */
2877 close(pipefds[0]); /* read end */
2878 /* Like bash, explicit redirects override pipes,
2879 * and the pipe fd is available for dup'ing. */
2880 setup_redirects(command, NULL);
2882 /* Restore default handlers just prior to exec */
2883 /*signal(SIGCHLD, SIG_DFL); - so far we don't have any handlers */
2885 /* Stores to nommu_save list of env vars putenv'ed
2886 * (NOMMU, on MMU we don't need that) */
2887 /* cast away volatility... */
2888 pseudo_exec((nommu_save_t*) &nommu_save, command, argv_expanded);
2889 /* pseudo_exec() does not return */
2893 /* Clean up after vforked child */
2894 free(nommu_save.argv);
2895 free_strings_and_unsetenv(nommu_save.new_env, 1);
2896 putenv_all(nommu_save.old_env);
2898 free(argv_expanded);
2899 argv_expanded = NULL;
2900 if (command->pid < 0) { /* [v]fork failed */
2901 /* Clearly indicate, was it fork or vfork */
2902 bb_perror_msg(BB_MMU ? "fork" : "vfork");
2906 /* Second and next children need to know pid of first one */
2908 pi->pgrp = command->pid;
2914 if ((i + 1) < pi->num_cmds)
2915 close(pipefds[1]); /* write end */
2916 /* Pass read (output) pipe end to next iteration */
2917 nextin = pipefds[0];
2920 if (!pi->alive_cmds) {
2921 debug_printf_exec("run_pipe return 1 (all forks failed, no children)\n");
2925 debug_printf_exec("run_pipe return -1 (%u children started)\n", pi->alive_cmds);
2929 #ifndef debug_print_tree
2930 static void debug_print_tree(struct pipe *pi, int lvl)
2932 static const char *const PIPE[] = {
2938 static const char *RES[] = {
2939 [RES_NONE ] = "NONE" ,
2942 [RES_THEN ] = "THEN" ,
2943 [RES_ELIF ] = "ELIF" ,
2944 [RES_ELSE ] = "ELSE" ,
2947 #if ENABLE_HUSH_LOOPS
2948 [RES_FOR ] = "FOR" ,
2949 [RES_WHILE] = "WHILE",
2950 [RES_UNTIL] = "UNTIL",
2952 [RES_DONE ] = "DONE" ,
2954 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
2957 #if ENABLE_HUSH_CASE
2958 [RES_CASE ] = "CASE" ,
2959 [RES_MATCH] = "MATCH",
2960 [RES_CASEI] = "CASEI",
2961 [RES_ESAC ] = "ESAC" ,
2963 [RES_XXXX ] = "XXXX" ,
2964 [RES_SNTX ] = "SNTX" ,
2966 static const char *const GRPTYPE[] = {
2969 #if ENABLE_HUSH_FUNCTIONS
2978 fprintf(stderr, "%*spipe %d res_word=%s followup=%d %s\n", lvl*2, "",
2979 pin, RES[pi->res_word], pi->followup, PIPE[pi->followup]);
2981 while (prn < pi->num_cmds) {
2982 struct command *command = &pi->cmds[prn];
2983 char **argv = command->argv;
2985 fprintf(stderr, "%*s prog %d assignment_cnt:%d",
2987 command->assignment_cnt);
2988 if (command->group) {
2989 fprintf(stderr, " group %s: (argv=%p)\n",
2990 GRPTYPE[command->grp_type],
2992 debug_print_tree(command->group, lvl+1);
2996 if (argv) while (*argv) {
2997 fprintf(stderr, " '%s'", *argv);
3000 fprintf(stderr, "\n");
3009 /* NB: called by pseudo_exec, and therefore must not modify any
3010 * global data until exec/_exit (we can be a child after vfork!) */
3011 static int run_list(struct pipe *pi)
3013 #if ENABLE_HUSH_CASE
3014 char *case_word = NULL;
3016 #if ENABLE_HUSH_LOOPS
3017 struct pipe *loop_top = NULL;
3018 char *for_varname = NULL;
3019 char **for_lcur = NULL;
3020 char **for_list = NULL;
3022 smallint flag_skip = 1;
3023 smalluint rcode = 0; /* probably just for compiler */
3024 #if ENABLE_HUSH_IF || ENABLE_HUSH_CASE
3025 smalluint cond_code = 0;
3027 enum { cond_code = 0, };
3029 /*enum reserved_style*/ smallint rword = RES_NONE;
3030 /*enum reserved_style*/ smallint skip_more_for_this_rword = RES_XXXX;
3032 debug_printf_exec("run_list start lvl %d\n", G.run_list_level + 1);
3034 #if ENABLE_HUSH_LOOPS
3035 /* Check syntax for "for" */
3036 for (struct pipe *cpipe = pi; cpipe; cpipe = cpipe->next) {
3037 if (cpipe->res_word != RES_FOR && cpipe->res_word != RES_IN)
3039 /* current word is FOR or IN (BOLD in comments below) */
3040 if (cpipe->next == NULL) {
3041 syntax("malformed for");
3042 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
3045 /* "FOR v; do ..." and "for v IN a b; do..." are ok */
3046 if (cpipe->next->res_word == RES_DO)
3048 /* next word is not "do". It must be "in" then ("FOR v in ...") */
3049 if (cpipe->res_word == RES_IN /* "for v IN a b; not_do..."? */
3050 || cpipe->next->res_word != RES_IN /* FOR v not_do_and_not_in..."? */
3052 syntax("malformed for");
3053 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
3059 /* Past this point, all code paths should jump to ret: label
3060 * in order to return, no direct "return" statements please.
3061 * This helps to ensure that no memory is leaked. */
3063 ////TODO: ctrl-Z handling needs re-thinking and re-testing
3066 /* Example of nested list: "while true; do { sleep 1 | exit 2; } done".
3067 * We are saving state before entering outermost list ("while...done")
3068 * so that ctrl-Z will correctly background _entire_ outermost list,
3069 * not just a part of it (like "sleep 1 | exit 2") */
3070 if (++G.run_list_level == 1 && G_interactive_fd) {
3071 if (sigsetjmp(G.toplevel_jb, 1)) {
3072 /* ctrl-Z forked and we are parent; or ctrl-C.
3073 * Sighandler has longjmped us here */
3074 signal(SIGINT, SIG_IGN);
3075 signal(SIGTSTP, SIG_IGN);
3076 /* Restore level (we can be coming from deep inside
3078 G.run_list_level = 1;
3079 #if ENABLE_FEATURE_SH_STANDALONE
3080 if (G.nofork_save.saved) { /* if save area is valid */
3081 debug_printf_jobs("exiting nofork early\n");
3082 restore_nofork_data(&G.nofork_save);
3085 //// if (G.ctrl_z_flag) {
3086 //// /* ctrl-Z has forked and stored pid of the child in pi->pid.
3087 //// * Remember this child as background job */
3088 //// insert_bg_job(pi);
3090 /* ctrl-C. We just stop doing whatever we were doing */
3093 USE_HUSH_LOOPS(loop_top = NULL;)
3094 USE_HUSH_LOOPS(G.depth_of_loop = 0;)
3098 //// /* ctrl-Z handler will store pid etc in pi */
3099 //// G.toplevel_list = pi;
3100 //// G.ctrl_z_flag = 0;
3101 ////#if ENABLE_FEATURE_SH_STANDALONE
3102 //// G.nofork_save.saved = 0; /* in case we will run a nofork later */
3104 //// signal_SA_RESTART_empty_mask(SIGTSTP, handler_ctrl_z);
3105 //// signal(SIGINT, handler_ctrl_c);
3109 /* Go through list of pipes, (maybe) executing them. */
3110 for (; pi; pi = USE_HUSH_LOOPS(rword == RES_DONE ? loop_top : ) pi->next) {
3114 IF_HAS_KEYWORDS(rword = pi->res_word;)
3115 IF_HAS_NO_KEYWORDS(rword = RES_NONE;)
3116 debug_printf_exec(": rword=%d cond_code=%d skip_more=%d\n",
3117 rword, cond_code, skip_more_for_this_rword);
3118 #if ENABLE_HUSH_LOOPS
3119 if ((rword == RES_WHILE || rword == RES_UNTIL || rword == RES_FOR)
3120 && loop_top == NULL /* avoid bumping G.depth_of_loop twice */
3122 /* start of a loop: remember where loop starts */
3127 if (rword == skip_more_for_this_rword && flag_skip) {
3128 if (pi->followup == PIPE_SEQ)
3130 /* it is "<false> && CMD" or "<true> || CMD"
3131 * and we should not execute CMD */
3135 skip_more_for_this_rword = RES_XXXX;
3138 if (rword == RES_THEN) {
3139 /* "if <false> THEN cmd": skip cmd */
3143 if (rword == RES_ELSE || rword == RES_ELIF) {
3144 /* "if <true> then ... ELSE/ELIF cmd":
3145 * skip cmd and all following ones */
3150 #if ENABLE_HUSH_LOOPS
3151 if (rword == RES_FOR) { /* && pi->num_cmds - always == 1 */
3153 /* first loop through for */
3155 static const char encoded_dollar_at[] ALIGN1 = {
3156 SPECIAL_VAR_SYMBOL, '@' | 0x80, SPECIAL_VAR_SYMBOL, '\0'
3157 }; /* encoded representation of "$@" */
3158 static const char *const encoded_dollar_at_argv[] = {
3159 encoded_dollar_at, NULL
3160 }; /* argv list with one element: "$@" */
3163 vals = (char**)encoded_dollar_at_argv;
3164 if (pi->next->res_word == RES_IN) {
3165 /* if no variable values after "in" we skip "for" */
3166 if (!pi->next->cmds[0].argv)
3168 vals = pi->next->cmds[0].argv;
3169 } /* else: "for var; do..." -> assume "$@" list */
3170 /* create list of variable values */
3171 debug_print_strings("for_list made from", vals);
3172 for_list = expand_strvec_to_strvec(vals);
3173 for_lcur = for_list;
3174 debug_print_strings("for_list", for_list);
3175 for_varname = pi->cmds[0].argv[0];
3176 pi->cmds[0].argv[0] = NULL;
3178 free(pi->cmds[0].argv[0]);
3180 /* "for" loop is over, clean up */
3184 pi->cmds[0].argv[0] = for_varname;
3187 /* insert next value from for_lcur */
3188 //TODO: does it need escaping?
3189 pi->cmds[0].argv[0] = xasprintf("%s=%s", for_varname, *for_lcur++);
3190 pi->cmds[0].assignment_cnt = 1;
3192 if (rword == RES_IN) {
3193 continue; /* "for v IN list;..." - "in" has no cmds anyway */
3195 if (rword == RES_DONE) {
3196 continue; /* "done" has no cmds too */
3199 #if ENABLE_HUSH_CASE
3200 if (rword == RES_CASE) {
3201 case_word = expand_strvec_to_string(pi->cmds->argv);
3204 if (rword == RES_MATCH) {
3207 if (!case_word) /* "case ... matched_word) ... WORD)": we executed selected branch, stop */
3209 /* all prev words didn't match, does this one match? */
3210 argv = pi->cmds->argv;
3212 char *pattern = expand_string_to_string(*argv);
3213 /* TODO: which FNM_xxx flags to use? */
3214 cond_code = (fnmatch(pattern, case_word, /*flags:*/ 0) != 0);
3216 if (cond_code == 0) { /* match! we will execute this branch */
3217 free(case_word); /* make future "word)" stop */
3225 if (rword == RES_CASEI) { /* inside of a case branch */
3227 continue; /* not matched yet, skip this pipe */
3230 /* Just pressing <enter> in shell should check for jobs.
3231 * OTOH, in non-interactive shell this is useless
3232 * and only leads to extra job checks */
3233 if (pi->num_cmds == 0) {
3234 if (G_interactive_fd)
3235 goto check_jobs_and_continue;
3239 /* After analyzing all keywords and conditions, we decided
3240 * to execute this pipe. NB: have to do checkjobs(NULL)
3241 * after run_pipe() to collect any background children,
3242 * even if list execution is to be stopped. */
3243 debug_printf_exec(": run_pipe with %d members\n", pi->num_cmds);
3246 #if ENABLE_HUSH_LOOPS
3247 G.flag_break_continue = 0;
3249 rcode = r = run_pipe(pi); /* NB: rcode is a smallint */
3251 /* we only ran a builtin: rcode is already known
3252 * and we don't need to wait for anything. */
3253 check_and_run_traps(0);
3254 #if ENABLE_HUSH_LOOPS
3255 /* was it "break" or "continue"? */
3256 if (G.flag_break_continue) {
3257 smallint fbc = G.flag_break_continue;
3258 /* we might fall into outer *loop*,
3259 * don't want to break it too */
3261 G.depth_break_continue--;
3262 if (G.depth_break_continue == 0)
3263 G.flag_break_continue = 0;
3264 /* else: e.g. "continue 2" should *break* once, *then* continue */
3265 } /* else: "while... do... { we are here (innermost list is not a loop!) };...done" */
3266 if (G.depth_break_continue != 0 || fbc == BC_BREAK)
3267 goto check_jobs_and_break;
3268 /* "continue": simulate end of loop */
3273 } else if (pi->followup == PIPE_BG) {
3274 /* what does bash do with attempts to background builtins? */
3275 /* even bash 3.2 doesn't do that well with nested bg:
3276 * try "{ { sleep 10; echo DEEP; } & echo HERE; } &".
3277 * I'm NOT treating inner &'s as jobs */
3278 check_and_run_traps(0);
3280 if (G.run_list_level == 1)
3283 rcode = 0; /* EXIT_SUCCESS */
3286 if (G.run_list_level == 1 && G_interactive_fd) {
3287 /* waits for completion, then fg's main shell */
3288 rcode = checkjobs_and_fg_shell(pi);
3289 check_and_run_traps(0);
3290 debug_printf_exec(": checkjobs_and_fg_shell returned %d\n", rcode);
3293 { /* this one just waits for completion */
3294 rcode = checkjobs(pi);
3295 check_and_run_traps(0);
3296 debug_printf_exec(": checkjobs returned %d\n", rcode);
3300 debug_printf_exec(": setting last_return_code=%d\n", rcode);
3301 G.last_return_code = rcode;
3303 /* Analyze how result affects subsequent commands */
3305 if (rword == RES_IF || rword == RES_ELIF)
3308 #if ENABLE_HUSH_LOOPS
3309 if (rword == RES_WHILE) {
3311 rcode = 0; /* "while false; do...done" - exitcode 0 */
3312 goto check_jobs_and_break;
3315 if (rword == RES_UNTIL) {
3317 check_jobs_and_break:
3323 if ((rcode == 0 && pi->followup == PIPE_OR)
3324 || (rcode != 0 && pi->followup == PIPE_AND)
3326 skip_more_for_this_rword = rword;
3329 check_jobs_and_continue:
3334 //// if (G.ctrl_z_flag) {
3335 //// /* ctrl-Z forked somewhere in the past, we are the child,
3336 //// * and now we completed running the list. Exit. */
3342 //// if (!G.run_list_level && G_interactive_fd) {
3343 //// signal(SIGTSTP, SIG_IGN);
3344 //// signal(SIGINT, SIG_IGN);
3347 debug_printf_exec("run_list lvl %d return %d\n", G.run_list_level + 1, rcode);
3348 #if ENABLE_HUSH_LOOPS
3353 #if ENABLE_HUSH_CASE
3359 /* Select which version we will use */
3360 static int run_and_free_list(struct pipe *pi)
3363 debug_printf_exec("run_and_free_list entered\n");
3365 debug_printf_exec(": run_list with %d members\n", pi->num_cmds);
3366 rcode = run_list(pi);
3368 /* free_pipe_list has the side effect of clearing memory.
3369 * In the long run that function can be merged with run_list,
3370 * but doing that now would hobble the debugging effort. */
3371 free_pipe_list(pi, /* indent: */ 0);
3372 debug_printf_exec("run_and_free_list return %d\n", rcode);
3377 /* Peek ahead in the in_str to find out if we have a "&n" construct,
3378 * as in "2>&1", that represents duplicating a file descriptor.
3379 * Return either -2 (syntax error), -1 (no &), or the number found.
3381 static int redirect_dup_num(struct in_str *input)
3383 int ch, d = 0, ok = 0;
3385 if (ch != '&') return -1;
3387 i_getch(input); /* get the & */
3391 return -3; /* "-" represents "close me" */
3393 while (isdigit(ch)) {
3394 d = d*10 + (ch-'0');
3401 bb_error_msg("ambiguous redirect");
3405 /* The src parameter allows us to peek forward to a possible &n syntax
3406 * for file descriptor duplication, e.g., "2>&1".
3407 * Return code is 0 normally, 1 if a syntax error is detected in src.
3408 * Resource errors (in xmalloc) cause the process to exit */
3409 static int setup_redirect(struct parse_context *ctx,
3412 struct in_str *input)
3414 struct command *command = ctx->command;
3415 struct redir_struct *redir;
3416 struct redir_struct **redirp;
3419 /* Check for a '2>&1' type redirect */
3420 dup_num = redirect_dup_num(input);
3422 return 1; /* syntax error */
3424 /* Create a new redir_struct and drop it onto the end of the linked list */
3425 redirp = &command->redirects;
3426 while ((redir = *redirp) != NULL) {
3427 redirp = &(redir->next);
3429 *redirp = redir = xzalloc(sizeof(*redir));
3430 /* redir->next = NULL; */
3431 /* redir->rd_filename = NULL; */
3432 redir->rd_type = style;
3433 redir->fd = (fd == -1) ? redir_table[style].default_fd : fd;
3435 debug_printf("Redirect type %d%s\n", redir->fd, redir_table[style].descrip);
3437 redir->dup = dup_num;
3438 if (dup_num != -1) {
3439 /* Erik had a check here that the file descriptor in question
3440 * is legit; I postpone that to "run time"
3441 * A "-" representation of "close me" shows up as a -3 here */
3442 debug_printf("Duplicating redirect '%d>&%d'\n", redir->fd, redir->dup);
3444 /* We do _not_ try to open the file that src points to,
3445 * since we need to return and let src be expanded first.
3446 * Set ctx->pending_redirect, so we know what to do at the
3447 * end of the next parsed word. */
3448 ctx->pending_redirect = redir;
3454 static struct pipe *new_pipe(void)
3457 pi = xzalloc(sizeof(struct pipe));
3458 /*pi->followup = 0; - deliberately invalid value */
3459 /*pi->res_word = RES_NONE; - RES_NONE is 0 anyway */
3463 /* Command (member of a pipe) is complete. The only possible error here
3464 * is out of memory, in which case xmalloc exits. */
3465 static int done_command(struct parse_context *ctx)
3467 /* The command is really already in the pipe structure, so
3468 * advance the pipe counter and make a new, null command. */
3469 struct pipe *pi = ctx->pipe;
3470 struct command *command = ctx->command;
3473 if (command->group == NULL
3474 && command->argv == NULL
3475 && command->redirects == NULL
3477 debug_printf_parse("done_command: skipping null cmd, num_cmds=%d\n", pi->num_cmds);
3478 return pi->num_cmds;
3481 debug_printf_parse("done_command: ++num_cmds=%d\n", pi->num_cmds);
3483 debug_printf_parse("done_command: initializing, num_cmds=%d\n", pi->num_cmds);
3486 /* Only real trickiness here is that the uncommitted
3487 * command structure is not counted in pi->num_cmds. */
3488 pi->cmds = xrealloc(pi->cmds, sizeof(*pi->cmds) * (pi->num_cmds+1));
3489 command = &pi->cmds[pi->num_cmds];
3490 memset(command, 0, sizeof(*command));
3492 ctx->command = command;
3493 /* but ctx->pipe and ctx->list_head remain unchanged */
3495 return pi->num_cmds; /* used only for 0/nonzero check */
3498 static void done_pipe(struct parse_context *ctx, pipe_style type)
3502 debug_printf_parse("done_pipe entered, followup %d\n", type);
3503 /* Close previous command */
3504 not_null = done_command(ctx);
3505 ctx->pipe->followup = type;
3506 IF_HAS_KEYWORDS(ctx->pipe->pi_inverted = ctx->ctx_inverted;)
3507 IF_HAS_KEYWORDS(ctx->ctx_inverted = 0;)
3508 IF_HAS_KEYWORDS(ctx->pipe->res_word = ctx->ctx_res_w;)
3510 /* Without this check, even just <enter> on command line generates
3511 * tree of three NOPs (!). Which is harmless but annoying.
3512 * IOW: it is safe to do it unconditionally.
3513 * RES_NONE case is for "for a in; do ..." (empty IN set)
3514 * to work, possibly other cases too. */
3515 if (not_null IF_HAS_KEYWORDS(|| ctx->ctx_res_w != RES_NONE)) {
3517 debug_printf_parse("done_pipe: adding new pipe: "
3518 "not_null:%d ctx->ctx_res_w:%d\n",
3519 not_null, ctx->ctx_res_w);
3521 ctx->pipe->next = new_p;
3523 /* RES_THEN, RES_DO etc are "sticky" -
3524 * they remain set for commands inside if/while.
3525 * This is used to control execution.
3526 * RES_FOR and RES_IN are NOT sticky (needed to support
3527 * cases where variable or value happens to match a keyword):
3529 #if ENABLE_HUSH_LOOPS
3530 if (ctx->ctx_res_w == RES_FOR
3531 || ctx->ctx_res_w == RES_IN)
3532 ctx->ctx_res_w = RES_NONE;
3534 #if ENABLE_HUSH_CASE
3535 if (ctx->ctx_res_w == RES_MATCH)
3536 ctx->ctx_res_w = RES_CASEI;
3538 ctx->command = NULL; /* trick done_command below */
3539 /* Create the memory for command, roughly:
3540 * ctx->pipe->cmds = new struct command;
3541 * ctx->command = &ctx->pipe->cmds[0];
3545 debug_printf_parse("done_pipe return\n");
3548 static void initialize_context(struct parse_context *ctx)
3550 memset(ctx, 0, sizeof(*ctx));
3551 ctx->pipe = ctx->list_head = new_pipe();
3552 /* Create the memory for command, roughly:
3553 * ctx->pipe->cmds = new struct command;
3554 * ctx->command = &ctx->pipe->cmds[0];
3560 /* If a reserved word is found and processed, parse context is modified
3561 * and 1 is returned.
3564 struct reserved_combo {
3567 unsigned char assignment_flag;
3571 FLAG_END = (1 << RES_NONE ),
3573 FLAG_IF = (1 << RES_IF ),
3574 FLAG_THEN = (1 << RES_THEN ),
3575 FLAG_ELIF = (1 << RES_ELIF ),
3576 FLAG_ELSE = (1 << RES_ELSE ),
3577 FLAG_FI = (1 << RES_FI ),
3579 #if ENABLE_HUSH_LOOPS
3580 FLAG_FOR = (1 << RES_FOR ),
3581 FLAG_WHILE = (1 << RES_WHILE),
3582 FLAG_UNTIL = (1 << RES_UNTIL),
3583 FLAG_DO = (1 << RES_DO ),
3584 FLAG_DONE = (1 << RES_DONE ),
3585 FLAG_IN = (1 << RES_IN ),
3587 #if ENABLE_HUSH_CASE
3588 FLAG_MATCH = (1 << RES_MATCH),
3589 FLAG_ESAC = (1 << RES_ESAC ),
3591 FLAG_START = (1 << RES_XXXX ),
3594 static const struct reserved_combo* match_reserved_word(o_string *word)
3596 /* Mostly a list of accepted follow-up reserved words.
3597 * FLAG_END means we are done with the sequence, and are ready
3598 * to turn the compound list into a command.
3599 * FLAG_START means the word must start a new compound list.
3601 static const struct reserved_combo reserved_list[] = {
3603 { "!", RES_NONE, NOT_ASSIGNMENT , 0 },
3604 { "if", RES_IF, WORD_IS_KEYWORD, FLAG_THEN | FLAG_START },
3605 { "then", RES_THEN, WORD_IS_KEYWORD, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
3606 { "elif", RES_ELIF, WORD_IS_KEYWORD, FLAG_THEN },
3607 { "else", RES_ELSE, WORD_IS_KEYWORD, FLAG_FI },
3608 { "fi", RES_FI, NOT_ASSIGNMENT , FLAG_END },
3610 #if ENABLE_HUSH_LOOPS
3611 { "for", RES_FOR, NOT_ASSIGNMENT , FLAG_IN | FLAG_DO | FLAG_START },
3612 { "while", RES_WHILE, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
3613 { "until", RES_UNTIL, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
3614 { "in", RES_IN, NOT_ASSIGNMENT , FLAG_DO },
3615 { "do", RES_DO, WORD_IS_KEYWORD, FLAG_DONE },
3616 { "done", RES_DONE, NOT_ASSIGNMENT , FLAG_END },
3618 #if ENABLE_HUSH_CASE
3619 { "case", RES_CASE, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_START },
3620 { "esac", RES_ESAC, NOT_ASSIGNMENT , FLAG_END },
3623 const struct reserved_combo *r;
3625 for (r = reserved_list; r < reserved_list + ARRAY_SIZE(reserved_list); r++) {
3626 if (strcmp(word->data, r->literal) == 0)
3631 static int reserved_word(o_string *word, struct parse_context *ctx)
3633 #if ENABLE_HUSH_CASE
3634 static const struct reserved_combo reserved_match = {
3635 "", RES_MATCH, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_ESAC
3638 const struct reserved_combo *r;
3640 r = match_reserved_word(word);
3644 debug_printf("found reserved word %s, res %d\n", r->literal, r->res);
3645 #if ENABLE_HUSH_CASE
3646 if (r->res == RES_IN && ctx->ctx_res_w == RES_CASE)
3647 /* "case word IN ..." - IN part starts first match part */
3648 r = &reserved_match;
3651 if (r->flag == 0) { /* '!' */
3652 if (ctx->ctx_inverted) { /* bash doesn't accept '! ! true' */
3653 syntax("! ! command");
3654 IF_HAS_KEYWORDS(ctx->ctx_res_w = RES_SNTX;)
3656 ctx->ctx_inverted = 1;
3659 if (r->flag & FLAG_START) {
3660 struct parse_context *old;
3661 old = xmalloc(sizeof(*old));
3662 debug_printf_parse("push stack %p\n", old);
3663 *old = *ctx; /* physical copy */
3664 initialize_context(ctx);
3666 } else if (/*ctx->ctx_res_w == RES_NONE ||*/ !(ctx->old_flag & (1 << r->res))) {
3668 ctx->ctx_res_w = RES_SNTX;
3671 ctx->ctx_res_w = r->res;
3672 ctx->old_flag = r->flag;
3673 if (ctx->old_flag & FLAG_END) {
3674 struct parse_context *old;
3675 done_pipe(ctx, PIPE_SEQ);
3676 debug_printf_parse("pop stack %p\n", ctx->stack);
3678 old->command->group = ctx->list_head;
3679 old->command->grp_type = GRP_NORMAL;
3681 o_addstr(&old->as_string, ctx->as_string.data);
3682 o_free_unsafe(&ctx->as_string);
3683 old->command->group_as_string = xstrdup(old->as_string.data);
3684 debug_printf_parse("pop, remembering as:'%s'\n",
3685 old->command->group_as_string);
3687 *ctx = *old; /* physical copy */
3690 word->o_assignment = r->assignment_flag;
3695 /* Word is complete, look at it and update parsing context.
3696 * Normal return is 0. Syntax errors return 1.
3697 * Note: on return, word is reset, but not o_free'd!
3699 static int done_word(o_string *word, struct parse_context *ctx)
3701 struct command *command = ctx->command;
3703 debug_printf_parse("done_word entered: '%s' %p\n", word->data, command);
3704 if (word->length == 0 && word->nonnull == 0) {
3705 debug_printf_parse("done_word return 0: true null, ignored\n");
3708 /* If this word wasn't an assignment, next ones definitely
3709 * can't be assignments. Even if they look like ones. */
3710 if (word->o_assignment != DEFINITELY_ASSIGNMENT
3711 && word->o_assignment != WORD_IS_KEYWORD
3713 word->o_assignment = NOT_ASSIGNMENT;
3715 if (word->o_assignment == DEFINITELY_ASSIGNMENT)
3716 command->assignment_cnt++;
3717 word->o_assignment = MAYBE_ASSIGNMENT;
3720 if (ctx->pending_redirect) {
3721 /* We do not glob in e.g. >*.tmp case. bash seems to glob here
3722 * only if run as "bash", not "sh" */
3723 ctx->pending_redirect->rd_filename = xstrdup(word->data);
3724 word->o_assignment = NOT_ASSIGNMENT;
3725 debug_printf("word stored in rd_filename: '%s'\n", word->data);
3727 /* "{ echo foo; } echo bar" - bad */
3728 /* NB: bash allows e.g.:
3729 * if true; then { echo foo; } fi
3730 * while if false; then false; fi do break; done
3732 if (command->group) {
3734 debug_printf_parse("done_word return 1: syntax error, "
3735 "groups and arglists don't mix\n");
3739 #if ENABLE_HUSH_CASE
3740 if (ctx->ctx_dsemicolon
3741 && strcmp(word->data, "esac") != 0 /* not "... pattern) cmd;; esac" */
3743 /* already done when ctx_dsemicolon was set to 1: */
3744 /* ctx->ctx_res_w = RES_MATCH; */
3745 ctx->ctx_dsemicolon = 0;
3748 if (!command->argv /* if it's the first word... */
3749 #if ENABLE_HUSH_LOOPS
3750 && ctx->ctx_res_w != RES_FOR /* ...not after FOR or IN */
3751 && ctx->ctx_res_w != RES_IN
3754 debug_printf_parse(": checking '%s' for reserved-ness\n", word->data);
3755 if (reserved_word(word, ctx)) {
3757 debug_printf_parse("done_word return %d\n",
3758 (ctx->ctx_res_w == RES_SNTX));
3759 return (ctx->ctx_res_w == RES_SNTX);
3763 if (word->nonnull /* word had "xx" or 'xx' at least as part of it. */
3764 /* optimization: and if it's ("" or '') or ($v... or `cmd`...): */
3765 && (word->data[0] == '\0' || word->data[0] == SPECIAL_VAR_SYMBOL)
3766 /* (otherwise it's known to be not empty and is already safe) */
3768 /* exclude "$@" - it can expand to no word despite "" */
3769 char *p = word->data;
3770 while (p[0] == SPECIAL_VAR_SYMBOL
3771 && (p[1] & 0x7f) == '@'
3772 && p[2] == SPECIAL_VAR_SYMBOL
3776 if (p == word->data || p[0] != '\0') {
3777 /* saw no "$@", or not only "$@" but some
3778 * real text is there too */
3779 /* insert "empty variable" reference, this makes
3780 * e.g. "", $empty"" etc to not disappear */
3781 o_addchr(word, SPECIAL_VAR_SYMBOL);
3782 o_addchr(word, SPECIAL_VAR_SYMBOL);
3785 command->argv = add_string_to_strings(command->argv, xstrdup(word->data));
3786 debug_print_strings("word appended to argv", command->argv);
3790 ctx->pending_redirect = NULL;
3792 #if ENABLE_HUSH_LOOPS
3793 /* Force FOR to have just one word (variable name) */
3794 /* NB: basically, this makes hush see "for v in ..." syntax as if
3795 * as it is "for v; in ...". FOR and IN become two pipe structs
3797 if (ctx->ctx_res_w == RES_FOR) {
3798 //TODO: check that command->argv[0] is a valid variable name!
3799 done_pipe(ctx, PIPE_SEQ);
3802 #if ENABLE_HUSH_CASE
3803 /* Force CASE to have just one word */
3804 if (ctx->ctx_res_w == RES_CASE) {
3805 done_pipe(ctx, PIPE_SEQ);
3808 debug_printf_parse("done_word return 0\n");
3812 /* If a redirect is immediately preceded by a number, that number is
3813 * supposed to tell which file descriptor to redirect. This routine
3814 * looks for such preceding numbers. In an ideal world this routine
3815 * needs to handle all the following classes of redirects...
3816 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
3817 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
3818 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
3819 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
3820 * A -1 output from this program means no valid number was found, so the
3821 * caller should use the appropriate default for this redirection.
3823 static int redirect_opt_num(o_string *o)
3829 for (num = 0; num < o->length; num++) {
3830 if (!isdigit(o->data[num])) {
3834 num = atoi(o->data);
3840 #define parse_stream(pstring, input, end_trigger) \
3841 parse_stream(input, end_trigger)
3843 static struct pipe *parse_stream(char **pstring,
3844 struct in_str *input,
3846 static void parse_and_run_string(const char *s);
3848 #if ENABLE_HUSH_TICK
3849 static FILE *generate_stream_from_string(const char *s)
3852 int pid, channel[2];
3855 pid = BB_MMU ? fork() : vfork();
3857 bb_perror_msg_and_die(BB_MMU ? "fork" : "vfork");
3859 if (pid == 0) { /* child */
3860 /* Process substitution is not considered to be usual
3861 * 'command execution'.
3862 * SUSv3 says ctrl-Z should be ignored, ctrl-C should not.
3869 if (ENABLE_HUSH_JOB)
3870 die_sleep = 0; /* let nofork's xfuncs die */
3871 close(channel[0]); /* NB: close _first_, then move fd! */
3872 xmove_fd(channel[1], 1);
3873 /* Prevent it from trying to handle ctrl-z etc */
3874 USE_HUSH_JOB(G.run_list_level = 1;)
3876 parse_and_run_string(s);
3877 _exit(G.last_return_code);
3879 /* We re-execute after vfork on NOMMU. This makes this script safe:
3880 * yes "0123456789012345678901234567890" | dd bs=32 count=64k >TESTFILE
3881 * huge=`cat TESTFILE` # was blocking here forever
3884 re_execute_shell(s);
3890 pf = fdopen(channel[0], "r");
3894 /* Return code is exit status of the process that is run. */
3895 static int process_command_subs(o_string *dest, const char *s)
3898 struct in_str pipe_str;
3901 pf = generate_stream_from_string(s);
3904 close_on_exec_on(fileno(pf));
3906 /* Now send results of command back into original context */
3907 setup_file_in_str(&pipe_str, pf);
3909 while ((ch = i_getch(&pipe_str)) != EOF) {
3915 o_addchr(dest, '\n');
3918 o_addQchr(dest, ch);
3921 debug_printf("done reading from pipe, pclose()ing\n");
3922 /* Note: we got EOF, and we just close the read end of the pipe.
3923 * We do not wait for the `cmd` child to terminate. bash and ash do.
3925 * echo `echo Hi; exec 1>&-; sleep 2` - bash waits 2 sec
3926 * `false`; echo $? - bash outputs "1"
3929 debug_printf("closed FILE from child. return 0\n");
3934 static int parse_group(o_string *dest, struct parse_context *ctx,
3935 struct in_str *input, int ch)
3937 /* dest contains characters seen prior to ( or {.
3938 * Typically it's empty, but for function defs,
3939 * it contains function name (without '()'). */
3940 struct pipe *pipe_list;
3942 struct command *command = ctx->command;
3944 debug_printf_parse("parse_group entered\n");
3945 #if ENABLE_HUSH_FUNCTIONS
3946 if (ch == 'F') { /* function definition? */
3947 bb_error_msg("aha '%s' is a function, parsing it...", dest->data);
3948 //command->fname = dest->data;
3949 command->grp_type = GRP_FUNCTION;
3950 //TODO: review every o_reset() location... do they handle all o_string fields correctly?
3951 memset(dest, 0, sizeof(*dest));
3954 if (command->argv /* word [word](... */
3955 || dest->length /* word(... */
3956 || dest->nonnull /* ""(... */
3959 debug_printf_parse("parse_group return 1: "
3960 "syntax error, groups and arglists don't mix\n");
3966 command->grp_type = GRP_SUBSHELL;
3970 char *as_string = NULL;
3972 pipe_list = parse_stream(&as_string, input, endch);
3975 o_addstr(&ctx->as_string, as_string);
3977 /* empty ()/{} or parse error? */
3978 if (!pipe_list || pipe_list == ERR_PTR) {
3983 debug_printf_parse("parse_group return 1: "
3984 "parse_stream returned %p\n", pipe_list);
3987 command->group = pipe_list;
3989 as_string[strlen(as_string) - 1] = '\0'; /* plink ')' or '}' */
3990 command->group_as_string = as_string;
3991 debug_printf_parse("end of group, remembering as:'%s'\n",
3992 command->group_as_string);
3995 debug_printf_parse("parse_group return 0\n");
3997 /* command remains "open", available for possible redirects */
4000 #if ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT
4001 /* Subroutines for copying $(...) and `...` things */
4002 static void add_till_backquote(o_string *dest, struct in_str *input);
4004 static void add_till_single_quote(o_string *dest, struct in_str *input)
4007 int ch = i_getch(input);
4015 /* "...\"...`..`...." - do we need to handle "...$(..)..." too? */
4016 static void add_till_double_quote(o_string *dest, struct in_str *input)
4019 int ch = i_getch(input);
4022 if (ch == '\\') { /* \x. Copy both chars. */
4024 ch = i_getch(input);
4030 add_till_backquote(dest, input);
4034 //if (ch == '$') ...
4037 /* Process `cmd` - copy contents until "`" is seen. Complicated by
4039 * "Within the backquoted style of command substitution, backslash
4040 * shall retain its literal meaning, except when followed by: '$', '`', or '\'.
4041 * The search for the matching backquote shall be satisfied by the first
4042 * backquote found without a preceding backslash; during this search,
4043 * if a non-escaped backquote is encountered within a shell comment,
4044 * a here-document, an embedded command substitution of the $(command)
4045 * form, or a quoted string, undefined results occur. A single-quoted
4046 * or double-quoted string that begins, but does not end, within the
4047 * "`...`" sequence produces undefined results."
4049 * echo `echo '\'TEST\`echo ZZ\`BEST` \TESTZZBEST
4051 static void add_till_backquote(o_string *dest, struct in_str *input)
4054 int ch = i_getch(input);
4057 if (ch == '\\') { /* \x. Copy both chars unless it is \` */
4058 int ch2 = i_getch(input);
4059 if (ch2 != '`' && ch2 != '$' && ch2 != '\\')
4068 /* Process $(cmd) - copy contents until ")" is seen. Complicated by
4069 * quoting and nested ()s.
4070 * "With the $(command) style of command substitution, all characters
4071 * following the open parenthesis to the matching closing parenthesis
4072 * constitute the command. Any valid shell script can be used for command,
4073 * except a script consisting solely of redirections which produces
4074 * unspecified results."
4076 * echo $(echo '(TEST)' BEST) (TEST) BEST
4077 * echo $(echo 'TEST)' BEST) TEST) BEST
4078 * echo $(echo \(\(TEST\) BEST) ((TEST) BEST
4080 static void add_till_closing_paren(o_string *dest, struct in_str *input, bool dbl)
4084 int ch = i_getch(input);
4093 if (i_peek(input) == ')') {
4101 add_till_single_quote(dest, input);
4106 add_till_double_quote(dest, input);
4110 if (ch == '\\') { /* \x. Copy verbatim. Important for \(, \) */
4111 ch = i_getch(input);
4119 #endif /* ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT */
4121 /* Return code: 0 for OK, 1 for syntax error */
4123 #define handle_dollar(ctx, dest, input) \
4124 handle_dollar(dest, input)
4126 static int handle_dollar(struct parse_context *ctx,
4128 struct in_str *input)
4131 int ch = i_peek(input); /* first character after the $ */
4132 unsigned char quote_mask = dest->o_escape ? 0x80 : 0;
4134 debug_printf_parse("handle_dollar entered: ch='%c'\n", ch);
4136 ch = i_getch(input);
4138 if (ctx) o_addchr(&ctx->as_string, ch);
4141 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4143 debug_printf_parse(": '%c'\n", ch);
4144 o_addchr(dest, ch | quote_mask);
4147 if (!isalnum(ch) && ch != '_')
4149 ch = i_getch(input);
4151 if (ctx) o_addchr(&ctx->as_string, ch);
4154 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4155 } else if (isdigit(ch)) {
4157 ch = i_getch(input);
4159 if (ctx) o_addchr(&ctx->as_string, ch);
4161 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4162 debug_printf_parse(": '%c'\n", ch);
4163 o_addchr(dest, ch | quote_mask);
4164 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4165 } else switch (ch) {
4167 case '!': /* last bg pid */
4168 case '?': /* last exit code */
4169 case '#': /* number of args */
4170 case '*': /* args */
4171 case '@': /* args */
4172 goto make_one_char_var;
4174 bool first_char, all_digits;
4176 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4177 ch = i_getch(input);
4179 if (ctx) o_addchr(&ctx->as_string, ch);
4181 /* XXX maybe someone will try to escape the '}' */
4186 ch = i_getch(input);
4188 if (ctx) o_addchr(&ctx->as_string, ch);
4195 /* ${#var}: length of var contents */
4197 else if (isdigit(ch)) {
4204 && ( (all_digits && !isdigit(ch))
4205 || (!all_digits && !isalnum(ch) && ch != '_')
4208 /* handle parameter expansions
4209 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_02
4214 case ':': /* null modifier */
4215 if (expansion == 0) {
4216 debug_printf_parse(": null modifier\n");
4221 #if 0 /* not implemented yet :( */
4222 case '#': /* remove prefix */
4223 case '%': /* remove suffix */
4224 if (expansion == 0) {
4225 debug_printf_parse(": remove suffix/prefix\n");
4231 case '-': /* default value */
4232 case '=': /* assign default */
4233 case '+': /* alternative */
4234 case '?': /* error indicate */
4235 debug_printf_parse(": parameter expansion\n");
4240 syntax("unterminated ${name}");
4241 debug_printf_parse("handle_dollar return 1: unterminated ${name}\n");
4246 debug_printf_parse(": '%c'\n", ch);
4247 o_addchr(dest, ch | quote_mask);
4251 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4258 ch = i_getch(input);
4260 if (ctx) o_addchr(&ctx->as_string, ch);
4262 #if ENABLE_SH_MATH_SUPPORT
4263 if (i_peek(input) == '(') {
4264 ch = i_getch(input);
4266 if (ctx) o_addchr(&ctx->as_string, ch);
4268 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4269 o_addchr(dest, /*quote_mask |*/ '+');
4273 add_till_closing_paren(dest, input, true);
4276 o_addstr(&ctx->as_string, dest->data + pos);
4277 o_addchr(&ctx->as_string, ')');
4278 o_addchr(&ctx->as_string, ')');
4281 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4285 #if ENABLE_HUSH_TICK
4286 //int pos = dest->length;
4287 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4288 o_addchr(dest, quote_mask | '`');
4292 add_till_closing_paren(dest, input, false);
4295 o_addstr(&ctx->as_string, dest->data + pos);
4296 o_addchr(&ctx->as_string, '`');
4299 //debug_printf_subst("SUBST RES2 '%s'\n", dest->data + pos);
4300 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4305 ch = i_getch(input);
4307 if (ctx) o_addchr(&ctx->as_string, ch);
4310 if (isalnum(ch)) { /* it's $_name or $_123 */
4316 /* $_ Shell or shell script name; or last cmd name */
4317 /* $- Option flags set by set builtin or shell options (-i etc) */
4319 o_addQchr(dest, '$');
4321 debug_printf_parse("handle_dollar return 0\n");
4326 #define parse_stream_dquoted(ctx, dest, input, dquote_end) \
4327 parse_stream_dquoted(dest, input, dquote_end)
4329 static int parse_stream_dquoted(struct parse_context *ctx,
4331 struct in_str *input,
4338 ch = i_getch(input);
4340 if (ctx && ch != EOF)
4341 o_addchr(&ctx->as_string, ch);
4343 if (ch == dquote_end) { /* may be only '"' or EOF */
4345 if (dest->o_assignment == NOT_ASSIGNMENT)
4346 dest->o_escape ^= 1;
4347 debug_printf_parse("parse_stream_dquoted return 0\n");
4351 syntax("unterminated \"");
4352 debug_printf_parse("parse_stream_dquoted return 1: unterminated \"\n");
4357 next = i_peek(input);
4359 debug_printf_parse(": ch=%c (%d) escape=%d\n",
4360 ch, ch, dest->o_escape);
4364 debug_printf_parse("parse_stream_dquoted return 1: \\<eof>\n");
4368 * "The backslash retains its special meaning [in "..."]
4369 * only when followed by one of the following characters:
4370 * $, `, ", \, or <newline>. A double quote may be quoted
4371 * within double quotes by preceding it with a backslash.
4372 * If enabled, history expansion will be performed unless
4373 * an ! appearing in double quotes is escaped using
4374 * a backslash. The backslash preceding the ! is not removed."
4376 if (strchr("$`\"\\", next) != NULL) {
4377 o_addqchr(dest, i_getch(input));
4379 o_addqchr(dest, '\\');
4384 if (handle_dollar(ctx, dest, input) != 0) {
4385 debug_printf_parse("parse_stream_dquoted return 1: "
4386 "handle_dollar returned non-0\n");
4391 #if ENABLE_HUSH_TICK
4393 //int pos = dest->length;
4394 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4395 o_addchr(dest, 0x80 | '`');
4396 add_till_backquote(dest, input);
4397 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4398 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
4402 o_addQchr(dest, ch);
4404 && (dest->o_assignment == MAYBE_ASSIGNMENT
4405 || dest->o_assignment == WORD_IS_KEYWORD)
4406 && is_assignment(dest->data)
4408 dest->o_assignment = DEFINITELY_ASSIGNMENT;
4414 * Scan input until EOF or end_trigger char.
4415 * Return a list of pipes to execute, or NULL on EOF
4416 * or if end_trigger character is met.
4417 * On syntax error, exit is shell is not interactive,
4418 * reset parsing machinery and start parsing anew,
4419 * or return ERR_PTR.
4421 static struct pipe *parse_stream(char **pstring,
4422 struct in_str *input,
4425 struct parse_context ctx;
4426 o_string dest = NULL_O_STRING;
4429 /* Double-quote state is handled in the state variable is_in_dquote.
4430 * A single-quote triggers a bypass of the main loop until its mate is
4431 * found. When recursing, quote state is passed in via dest->o_escape.
4433 debug_printf_parse("parse_stream entered, end_trigger='%c'\n",
4434 end_trigger ? : 'X');
4436 G.ifs = get_local_var_value("IFS");
4441 #if ENABLE_HUSH_INTERACTIVE
4442 input->promptmode = 0; /* PS1 */
4444 /* dest.o_assignment = MAYBE_ASSIGNMENT; - already is */
4445 initialize_context(&ctx);
4449 const char *is_special;
4453 redir_type redir_style;
4456 if (parse_stream_dquoted(&ctx, &dest, input, '"')) {
4459 /* We reached closing '"' */
4462 ch = i_getch(input);
4463 debug_printf_parse(": ch=%c (%d) escape=%d\n",
4464 ch, ch, dest.o_escape);
4467 if (done_word(&dest, &ctx)) {
4471 done_pipe(&ctx, PIPE_SEQ);
4473 /* If we got nothing... */
4474 // TODO: test script consisting of just "&"
4475 if (pi->num_cmds == 0
4476 IF_HAS_KEYWORDS( && pi->res_word == RES_NONE)
4478 free_pipe_list(pi, 0);
4481 debug_printf_parse("parse_stream return %p\n", pi);
4483 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
4485 *pstring = ctx.as_string.data;
4487 o_free_unsafe(&ctx.as_string);
4492 o_addchr(&ctx.as_string, ch);
4494 is_ifs = strchr(G.ifs, ch);
4495 is_special = strchr("<>;&|(){}#'" /* special outside of "str" */
4496 "\\$\"" USE_HUSH_TICK("`") /* always special */
4499 if (!is_special && !is_ifs) { /* ordinary char */
4500 o_addQchr(&dest, ch);
4501 if ((dest.o_assignment == MAYBE_ASSIGNMENT
4502 || dest.o_assignment == WORD_IS_KEYWORD)
4504 && is_assignment(dest.data)
4506 dest.o_assignment = DEFINITELY_ASSIGNMENT;
4512 if (done_word(&dest, &ctx)) {
4516 #if ENABLE_HUSH_CASE
4517 /* "case ... in <newline> word) ..." -
4518 * newlines are ignored (but ';' wouldn't be) */
4519 if (ctx.command->argv == NULL
4520 && ctx.ctx_res_w == RES_MATCH
4525 /* Treat newline as a command separator. */
4526 done_pipe(&ctx, PIPE_SEQ);
4527 dest.o_assignment = MAYBE_ASSIGNMENT;
4529 /* note: if (is_ifs) continue;
4530 * will still trigger for us */
4533 if (end_trigger && end_trigger == ch) {
4534 //TODO: disallow "{ cmd }" without semicolon
4535 if (done_word(&dest, &ctx)) {
4538 done_pipe(&ctx, PIPE_SEQ);
4539 dest.o_assignment = MAYBE_ASSIGNMENT;
4540 /* Do we sit outside of any if's, loops or case's? */
4542 IF_HAS_KEYWORDS(|| (ctx.ctx_res_w == RES_NONE && ctx.old_flag == 0))
4544 debug_printf_parse("parse_stream return %p: "
4545 "end_trigger char found\n",
4549 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
4551 *pstring = ctx.as_string.data;
4553 o_free_unsafe(&ctx.as_string);
4555 return ctx.list_head;
4561 if (dest.o_assignment == MAYBE_ASSIGNMENT) {
4562 /* ch is a special char and thus this word
4563 * cannot be an assignment */
4564 dest.o_assignment = NOT_ASSIGNMENT;
4569 next = i_peek(input);
4574 if (dest.length == 0) {
4577 if (ch == EOF || ch == '\n')
4580 /* note: we do not add it to &ctx.as_string */
4583 //TODO: go back one char?
4584 o_addchr(&ctx.as_string, '\n');
4587 o_addQchr(&dest, ch);
4595 o_addchr(&dest, '\\');
4596 ch = i_getch(input);
4597 o_addchr(&dest, ch);
4599 o_addchr(&ctx.as_string, ch);
4604 if (handle_dollar(&ctx, &dest, input) != 0) {
4605 debug_printf_parse("parse_stream parse error: "
4606 "handle_dollar returned non-0\n");
4613 ch = i_getch(input);
4615 syntax("unterminated '");
4619 o_addchr(&ctx.as_string, ch);
4623 if (dest.o_assignment == NOT_ASSIGNMENT)
4624 o_addqchr(&dest, ch);
4626 o_addchr(&dest, ch);
4631 is_in_dquote ^= 1; /* invert */
4632 if (dest.o_assignment == NOT_ASSIGNMENT)
4635 #if ENABLE_HUSH_TICK
4637 //int pos = dest.length;
4638 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
4639 o_addchr(&dest, '`');
4640 add_till_backquote(&dest, input);
4641 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
4642 //debug_printf_subst("SUBST RES3 '%s'\n", dest.data + pos);
4647 redir_fd = redirect_opt_num(&dest);
4648 if (done_word(&dest, &ctx)) {
4651 redir_style = REDIRECT_OVERWRITE;
4653 redir_style = REDIRECT_APPEND;
4654 ch = i_getch(input);
4656 o_addchr(&ctx.as_string, ch);
4660 else if (next == '(') {
4661 syntax(">(process) not supported");
4665 setup_redirect(&ctx, redir_fd, redir_style, input);
4668 redir_fd = redirect_opt_num(&dest);
4669 if (done_word(&dest, &ctx)) {
4672 redir_style = REDIRECT_INPUT;
4674 redir_style = REDIRECT_HEREIS;
4675 ch = i_getch(input);
4677 o_addchr(&ctx.as_string, ch);
4679 } else if (next == '>') {
4680 redir_style = REDIRECT_IO;
4681 ch = i_getch(input);
4683 o_addchr(&ctx.as_string, ch);
4687 else if (next == '(') {
4688 syntax("<(process) not supported");
4692 setup_redirect(&ctx, redir_fd, redir_style, input);
4695 #if ENABLE_HUSH_CASE
4698 if (done_word(&dest, &ctx)) {
4701 done_pipe(&ctx, PIPE_SEQ);
4702 #if ENABLE_HUSH_CASE
4703 /* Eat multiple semicolons, detect
4704 * whether it means something special */
4709 ch = i_getch(input);
4711 o_addchr(&ctx.as_string, ch);
4713 if (ctx.ctx_res_w == RES_CASEI) {
4714 ctx.ctx_dsemicolon = 1;
4715 ctx.ctx_res_w = RES_MATCH;
4721 /* We just finished a cmd. New one may start
4722 * with an assignment */
4723 dest.o_assignment = MAYBE_ASSIGNMENT;
4726 if (done_word(&dest, &ctx)) {
4730 ch = i_getch(input);
4732 o_addchr(&ctx.as_string, ch);
4734 done_pipe(&ctx, PIPE_AND);
4736 done_pipe(&ctx, PIPE_BG);
4740 if (done_word(&dest, &ctx)) {
4743 #if ENABLE_HUSH_CASE
4744 if (ctx.ctx_res_w == RES_MATCH)
4745 break; /* we are in case's "word | word)" */
4747 if (next == '|') { /* || */
4748 ch = i_getch(input);
4750 o_addchr(&ctx.as_string, ch);
4752 done_pipe(&ctx, PIPE_OR);
4754 /* we could pick up a file descriptor choice here
4755 * with redirect_opt_num(), but bash doesn't do it.
4756 * "echo foo 2| cat" yields "foo 2". */
4761 #if ENABLE_HUSH_CASE
4762 /* "case... in [(]word)..." - skip '(' */
4763 if (ctx.ctx_res_w == RES_MATCH
4764 && ctx.command->argv == NULL /* not (word|(... */
4765 && dest.length == 0 /* not word(... */
4766 && dest.nonnull == 0 /* not ""(... */
4771 #if ENABLE_HUSH_FUNCTIONS
4772 if (dest.length != 0 /* not just () but word() */
4773 && dest.nonnull == 0 /* not a"b"c() */
4774 && ctx.command->argv == NULL /* it's the first word */
4775 //TODO: "func ( ) {...}" - note spaces - is valid format too in bash
4776 && i_peek(input) == ')'
4777 && !match_reserved_word(&dest)
4779 bb_error_msg("seems like a function definition");
4781 //if !BB_MMU o_addchr(&ctx.as_string...
4783 //TODO: do it properly.
4784 ch = i_getch(input);
4785 } while (ch == ' ' || ch == '\n');
4787 syntax("was expecting {");
4790 ch = 'F'; /* magic value */
4794 if (parse_group(&dest, &ctx, input, ch) != 0) {
4799 #if ENABLE_HUSH_CASE
4800 if (ctx.ctx_res_w == RES_MATCH)
4804 /* proper use of this character is caught by end_trigger:
4805 * if we see {, we call parse_group(..., end_trigger='}')
4806 * and it will match } earlier (not here). */
4807 syntax("unexpected } or )");
4811 bb_error_msg_and_die("BUG: unexpected %c\n", ch);
4817 struct parse_context *pctx;
4818 IF_HAS_KEYWORDS(struct parse_context *p2;)
4820 /* Clean up allocated tree.
4821 * Samples for finding leaks on syntax error recovery path.
4822 * Run them from interactive shell, watch pmap `pidof hush`.
4823 * while if false; then false; fi do break; done
4825 * while if false; then false; fi; do break; fi
4829 /* Update pipe/command counts,
4830 * otherwise freeing may miss some */
4831 done_pipe(pctx, PIPE_SEQ);
4832 debug_printf_clean("freeing list %p from ctx %p\n",
4833 pctx->list_head, pctx);
4834 debug_print_tree(pctx->list_head, 0);
4835 free_pipe_list(pctx->list_head, 0);
4836 debug_printf_clean("freed list %p\n", pctx->list_head);
4838 o_free_unsafe(&pctx->as_string);
4840 IF_HAS_KEYWORDS(p2 = pctx->stack;)
4844 IF_HAS_KEYWORDS(pctx = p2;)
4845 } while (HAS_KEYWORDS && pctx);
4846 /* Free text, clear all dest fields */
4848 /* If we are not in top-level parse, we return,
4849 * our caller will propagate error.
4851 if (end_trigger != ';') {
4858 /* Discard cached input, force prompt */
4860 USE_HUSH_INTERACTIVE(input->promptme = 1;)
4865 /* Executing from string: eval, sh -c '...'
4866 * or from file: /etc/profile, . file, sh <script>, sh (intereactive)
4867 * end_trigger controls how often we stop parsing
4868 * NUL: parse all, execute, return
4869 * ';': parse till ';' or newline, execute, repeat till EOF
4871 static void parse_and_run_stream(struct in_str *inp, int end_trigger)
4874 struct pipe *pipe_list;
4876 pipe_list = parse_stream(NULL, inp, end_trigger);
4877 if (!pipe_list) /* EOF */
4879 debug_print_tree(pipe_list, 0);
4880 debug_printf_exec("parse_and_run_stream: run_and_free_list\n");
4881 run_and_free_list(pipe_list);
4885 static void parse_and_run_string(const char *s)
4887 struct in_str input;
4888 setup_string_in_str(&input, s);
4889 parse_and_run_stream(&input, '\0');
4892 static void parse_and_run_file(FILE *f)
4894 struct in_str input;
4895 setup_file_in_str(&input, f);
4896 parse_and_run_stream(&input, ';');
4900 /* Make sure we have a controlling tty. If we get started under a job
4901 * aware app (like bash for example), make sure we are now in charge so
4902 * we don't fight over who gets the foreground */
4903 static void setup_job_control(void)
4907 shell_pgrp = getpgrp();
4909 /* If we were ran as 'hush &',
4910 * sleep until we are in the foreground. */
4911 while (tcgetpgrp(G_interactive_fd) != shell_pgrp) {
4912 /* Send TTIN to ourself (should stop us) */
4913 kill(- shell_pgrp, SIGTTIN);
4914 shell_pgrp = getpgrp();
4917 /* We _must_ restore tty pgrp on fatal signals */
4918 set_fatal_signals_to_sigexit();
4920 /* Put ourselves in our own process group. */
4921 bb_setpgrp(); /* is the same as setpgid(our_pid, our_pid); */
4922 /* Grab control of the terminal. */
4923 tcsetpgrp(G_interactive_fd, getpid());
4927 static int set_mode(const char cstate, const char mode)
4929 int state = (cstate == '-' ? 1 : 0);
4931 case 'n': G.fake_mode = state; break;
4932 case 'x': /*G.debug_mode = state;*/ break;
4933 default: return EXIT_FAILURE;
4935 return EXIT_SUCCESS;
4938 int hush_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
4939 int hush_main(int argc, char **argv)
4941 static const struct variable const_shell_ver = {
4943 .varstr = (char*)hush_version_str,
4944 .max_len = 1, /* 0 can provoke free(name) */
4952 struct variable *cur_var;
4956 G.root_pid = getpid();
4958 /* Deal with HUSH_VERSION */
4959 G.shell_ver = const_shell_ver; /* copying struct here */
4960 G.top_var = &G.shell_ver;
4961 debug_printf_env("unsetenv '%s'\n", "HUSH_VERSION");
4962 unsetenv("HUSH_VERSION"); /* in case it exists in initial env */
4963 /* Initialize our shell local variables with the values
4964 * currently living in the environment */
4965 cur_var = G.top_var;
4968 char *value = strchr(*e, '=');
4969 if (value) { /* paranoia */
4970 cur_var->next = xzalloc(sizeof(*cur_var));
4971 cur_var = cur_var->next;
4972 cur_var->varstr = *e;
4973 cur_var->max_len = strlen(*e);
4974 cur_var->flg_export = 1;
4978 debug_printf_env("putenv '%s'\n", hush_version_str);
4979 putenv((char *)hush_version_str); /* reinstate HUSH_VERSION */
4981 #if ENABLE_FEATURE_EDITING
4982 G.line_input_state = new_line_input_t(FOR_SHELL);
4984 /* XXX what should these be while sourcing /etc/profile? */
4985 G.global_argc = argc;
4986 G.global_argv = argv;
4987 /* Initialize some more globals to non-zero values */
4989 #if ENABLE_HUSH_INTERACTIVE
4990 if (ENABLE_FEATURE_EDITING)
4991 cmdedit_set_initial_prompt();
4995 if (EXIT_SUCCESS) /* otherwise is already done */
4996 G.last_return_code = EXIT_SUCCESS;
4998 if (argv[0] && argv[0][0] == '-') {
4999 debug_printf("sourcing /etc/profile\n");
5000 input = fopen_for_read("/etc/profile");
5001 if (input != NULL) {
5002 close_on_exec_on(fileno(input));
5003 parse_and_run_file(input);
5009 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/sh.html */
5011 opt = getopt(argc, argv, "c:xins"
5020 G.global_argv = argv + optind;
5021 if (!argv[optind]) {
5022 /* -c 'script' (no params): prevent empty $0 */
5023 *--G.global_argv = argv[0];
5025 } /* else -c 'script' PAR0 PAR1: $0 is PAR0 */
5026 G.global_argc = argc - optind;
5027 parse_and_run_string(optarg);
5030 /* Well, we cannot just declare interactiveness,
5031 * we have to have some stuff (ctty, etc) */
5032 /* G_interactive_fd++; */
5035 /* "-s" means "read from stdin", but this is how we always
5036 * operate, so simply do nothing here. */
5040 G.root_pid = xatoi_u(optarg);
5043 G.last_return_code = xatoi_u(optarg);
5046 G.depth_of_loop = xatoi_u(optarg);
5050 set_local_var(xstrdup(optarg), 0, opt == 'R');
5055 if (!set_mode('-', opt))
5059 fprintf(stderr, "Usage: sh [FILE]...\n"
5060 " or: sh -c command [args]...\n\n");
5068 /* A shell is interactive if the '-i' flag was given, or if all of
5069 * the following conditions are met:
5071 * no arguments remaining or the -s flag given
5072 * standard input is a terminal
5073 * standard output is a terminal
5074 * Refer to Posix.2, the description of the 'sh' utility. */
5075 if (argv[optind] == NULL && input == stdin
5076 && isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)
5078 G.saved_tty_pgrp = tcgetpgrp(STDIN_FILENO);
5079 debug_printf("saved_tty_pgrp=%d\n", G.saved_tty_pgrp);
5080 if (G.saved_tty_pgrp >= 0) {
5081 /* try to dup to high fd#, >= 255 */
5082 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
5083 if (G_interactive_fd < 0) {
5084 /* try to dup to any fd */
5085 G_interactive_fd = dup(STDIN_FILENO);
5086 if (G_interactive_fd < 0)
5088 G_interactive_fd = 0;
5090 // TODO: track & disallow any attempts of user
5091 // to (inadvertently) close/redirect it
5094 init_signal_mask(); /* note: ensures SIGCHLD is not masked */
5095 debug_printf("interactive_fd=%d\n", G_interactive_fd);
5096 if (G_interactive_fd) {
5097 fcntl(G_interactive_fd, F_SETFD, FD_CLOEXEC);
5098 /* Looks like they want an interactive shell */
5099 setup_job_control();
5100 /* -1 is special - makes xfuncs longjmp, not exit
5101 * (we reset die_sleep = 0 whereever we [v]fork) */
5103 if (setjmp(die_jmp)) {
5104 /* xfunc has failed! die die die */
5105 hush_exit(xfunc_error_retval);
5108 #elif ENABLE_HUSH_INTERACTIVE
5109 /* no job control compiled, only prompt/line editing */
5110 if (argv[optind] == NULL && input == stdin
5111 && isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)
5113 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
5114 if (G_interactive_fd < 0) {
5115 /* try to dup to any fd */
5116 G_interactive_fd = dup(STDIN_FILENO);
5117 if (G_interactive_fd < 0)
5119 G_interactive_fd = 0;
5121 if (G_interactive_fd) {
5122 fcntl(G_interactive_fd, F_SETFD, FD_CLOEXEC);
5125 init_signal_mask(); /* note: ensures SIGCHLD is not masked */
5129 /* POSIX allows shell to re-enable SIGCHLD
5130 * even if it was SIG_IGN on entry */
5131 // G.count_SIGCHLD++; /* ensure it is != G.handled_SIGCHLD */
5132 signal(SIGCHLD, SIG_DFL); // SIGCHLD_handler);
5134 #if ENABLE_HUSH_INTERACTIVE && !ENABLE_FEATURE_SH_EXTRA_QUIET
5135 if (G_interactive_fd) {
5136 printf("\n\n%s hush - the humble shell v"HUSH_VER_STR"\n", bb_banner);
5137 printf("Enter 'help' for a list of built-in commands.\n\n");
5141 if (argv[optind] == NULL) {
5142 parse_and_run_file(stdin);
5144 debug_printf("\nrunning script '%s'\n", argv[optind]);
5145 G.global_argv = argv + optind;
5146 G.global_argc = argc - optind;
5147 input = xfopen_for_read(argv[optind]);
5148 fcntl(fileno(input), F_SETFD, FD_CLOEXEC);
5149 parse_and_run_file(input);
5154 #if ENABLE_FEATURE_CLEAN_UP
5156 if (G.cwd != bb_msg_unknown)
5158 cur_var = G.top_var->next;
5160 struct variable *tmp = cur_var;
5161 if (!cur_var->max_len)
5162 free(cur_var->varstr);
5163 cur_var = cur_var->next;
5167 hush_exit(G.last_return_code);
5172 int lash_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
5173 int lash_main(int argc, char **argv)
5175 //bb_error_msg("lash is deprecated, please use hush instead");
5176 return hush_main(argc, argv);
5184 static int builtin_trap(char **argv)
5191 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
5194 /* No args: print all trapped. This isn't 100% correct as we should
5195 * be escaping the cmd so that it can be pasted back in ...
5197 for (i = 0; i < NSIG; ++i)
5199 printf("trap -- '%s' %s\n", G.traps[i], get_signame(i));
5200 return EXIT_SUCCESS;
5205 /* if first arg is decimal: reset all specified */
5206 sig = bb_strtou(*++argv, NULL, 10);
5212 sig = get_signum(*argv++);
5213 if (sig < 0 || sig >= NSIG) {
5215 /* mimic bash message exactly */
5216 bb_perror_msg("trap: %s: invalid signal specification", argv[i]);
5221 G.traps[sig] = xstrdup(new_cmd);
5223 debug_printf("trap: setting SIG%s (%i) to '%s'",
5224 get_signame(sig), sig, G.traps[sig]);
5226 /* There is no signal for 0 (EXIT) */
5231 sigaddset(&G.blocked_set, sig);
5233 /* there was a trap handler, we are removing it
5234 * (if sig has non-DFL handling,
5235 * we don't need to do anything) */
5236 if (sig < 32 && (G.non_DFL_mask & (1 << sig)))
5238 sigdelset(&G.blocked_set, sig);
5240 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5245 /* first arg is "-": reset all specified to default */
5246 /* first arg is "": ignore all specified */
5247 /* everything else: execute first arg upon signal */
5249 bb_error_msg("trap: invalid arguments");
5250 return EXIT_FAILURE;
5252 if (LONE_DASH(*argv))
5260 static int builtin_true(char **argv UNUSED_PARAM)
5265 static int builtin_test(char **argv)
5272 return test_main(argc, argv - argc);
5275 static int builtin_echo(char **argv)
5282 return echo_main(argc, argv - argc);
5285 static int builtin_eval(char **argv)
5287 int rcode = EXIT_SUCCESS;
5290 char *str = expand_strvec_to_string(argv + 1);
5292 * eval "echo Hi; done" ("done" is syntax error):
5293 * "echo Hi" will not execute too.
5295 parse_and_run_string(str);
5297 rcode = G.last_return_code;
5302 static int builtin_cd(char **argv)
5305 if (argv[1] == NULL) {
5306 /* bash does nothing (exitcode 0) if HOME is ""; if it's unset,
5307 * bash says "bash: cd: HOME not set" and does nothing (exitcode 1)
5309 newdir = getenv("HOME") ? : "/";
5312 if (chdir(newdir)) {
5313 printf("cd: %s: %s\n", newdir, strerror(errno));
5314 return EXIT_FAILURE;
5317 return EXIT_SUCCESS;
5320 static int builtin_exec(char **argv)
5322 if (argv[1] == NULL)
5323 return EXIT_SUCCESS; /* bash does this */
5328 // FIXME: if exec fails, bash does NOT exit! We do...
5329 pseudo_exec_argv(&dummy, argv + 1, 0, NULL);
5334 static int builtin_exit(char **argv)
5336 // TODO: bash does it ONLY on top-level sh exit (+interacive only?)
5337 //puts("exit"); /* bash does it */
5338 // TODO: warn if we have background jobs: "There are stopped jobs"
5339 // On second consecutive 'exit', exit anyway.
5340 if (argv[1] == NULL)
5341 hush_exit(G.last_return_code);
5342 /* mimic bash: exit 123abc == exit 255 + error msg */
5343 xfunc_error_retval = 255;
5344 /* bash: exit -2 == exit 254, no error msg */
5345 hush_exit(xatoi(argv[1]) & 0xff);
5348 static int builtin_export(char **argv)
5351 char *name = argv[1];
5355 // ash emits: export VAR='VAL'
5356 // bash: declare -x VAR="VAL"
5357 // (both also escape as needed (quotes, $, etc))
5362 return EXIT_SUCCESS;
5365 value = strchr(name, '=');
5367 /* They are exporting something without a =VALUE */
5368 struct variable *var;
5370 var = get_local_var(name);
5372 var->flg_export = 1;
5373 debug_printf_env("%s: putenv '%s'\n", __func__, var->varstr);
5374 putenv(var->varstr);
5376 /* bash does not return an error when trying to export
5377 * an undefined variable. Do likewise. */
5378 return EXIT_SUCCESS;
5381 set_local_var(xstrdup(name), 1, 0);
5382 return EXIT_SUCCESS;
5386 /* built-in 'fg' and 'bg' handler */
5387 static int builtin_fg_bg(char **argv)
5392 if (!G_interactive_fd)
5393 return EXIT_FAILURE;
5394 /* If they gave us no args, assume they want the last backgrounded task */
5396 for (pi = G.job_list; pi; pi = pi->next) {
5397 if (pi->jobid == G.last_jobid) {
5401 bb_error_msg("%s: no current job", argv[0]);
5402 return EXIT_FAILURE;
5404 if (sscanf(argv[1], "%%%d", &jobnum) != 1) {
5405 bb_error_msg("%s: bad argument '%s'", argv[0], argv[1]);
5406 return EXIT_FAILURE;
5408 for (pi = G.job_list; pi; pi = pi->next) {
5409 if (pi->jobid == jobnum) {
5413 bb_error_msg("%s: %d: no such job", argv[0], jobnum);
5414 return EXIT_FAILURE;
5416 // TODO: bash prints a string representation
5417 // of job being foregrounded (like "sleep 1 | cat")
5418 if (argv[0][0] == 'f') {
5419 /* Put the job into the foreground. */
5420 tcsetpgrp(G_interactive_fd, pi->pgrp);
5423 /* Restart the processes in the job */
5424 debug_printf_jobs("reviving %d procs, pgrp %d\n", pi->num_cmds, pi->pgrp);
5425 for (i = 0; i < pi->num_cmds; i++) {
5426 debug_printf_jobs("reviving pid %d\n", pi->cmds[i].pid);
5427 pi->cmds[i].is_stopped = 0;
5429 pi->stopped_cmds = 0;
5431 i = kill(- pi->pgrp, SIGCONT);
5433 if (errno == ESRCH) {
5434 delete_finished_bg_job(pi);
5435 return EXIT_SUCCESS;
5437 bb_perror_msg("kill (SIGCONT)");
5440 if (argv[0][0] == 'f') {
5442 return checkjobs_and_fg_shell(pi);
5444 return EXIT_SUCCESS;
5448 #if ENABLE_HUSH_HELP
5449 static int builtin_help(char **argv UNUSED_PARAM)
5451 const struct built_in_command *x;
5454 "Built-in commands:\n"
5455 "------------------\n");
5456 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
5457 printf("%s\t%s\n", x->cmd, x->descr);
5460 return EXIT_SUCCESS;
5465 static int builtin_jobs(char **argv UNUSED_PARAM)
5468 const char *status_string;
5470 for (job = G.job_list; job; job = job->next) {
5471 if (job->alive_cmds == job->stopped_cmds)
5472 status_string = "Stopped";
5474 status_string = "Running";
5476 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->cmdtext);
5478 return EXIT_SUCCESS;
5482 static int builtin_pwd(char **argv UNUSED_PARAM)
5485 return EXIT_SUCCESS;
5488 static int builtin_read(char **argv)
5491 const char *name = argv[1] ? argv[1] : "REPLY";
5493 string = xmalloc_reads(STDIN_FILENO, xasprintf("%s=", name), NULL);
5494 return set_local_var(string, 0, 0);
5497 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set
5498 * built-in 'set' handler
5500 * set [-abCefhmnuvx] [-o option] [argument...]
5501 * set [+abCefhmnuvx] [+o option] [argument...]
5502 * set -- [argument...]
5505 * Implementations shall support the options in both their hyphen and
5506 * plus-sign forms. These options can also be specified as options to sh.
5508 * Write out all variables and their values: set
5509 * Set $1, $2, and $3 and set "$#" to 3: set c a b
5510 * Turn on the -x and -v options: set -xv
5511 * Unset all positional parameters: set --
5512 * Set $1 to the value of x, even if it begins with '-' or '+': set -- "$x"
5513 * Set the positional parameters to the expansion of x, even if x expands
5514 * with a leading '-' or '+': set -- $x
5516 * So far, we only support "set -- [argument...]" and some of the short names.
5518 static int builtin_set(char **argv)
5521 char **pp, **g_argv;
5522 char *arg = *++argv;
5526 for (e = G.top_var; e; e = e->next)
5528 return EXIT_SUCCESS;
5532 if (!strcmp(arg, "--")) {
5537 if (arg[0] == '+' || arg[0] == '-') {
5538 for (n = 1; arg[n]; ++n)
5539 if (set_mode(arg[0], arg[n]))
5545 } while ((arg = *++argv) != NULL);
5546 /* Now argv[0] is 1st argument */
5548 /* Only reset global_argv if we didn't process anything */
5550 return EXIT_SUCCESS;
5553 /* NB: G.global_argv[0] ($0) is never freed/changed */
5554 g_argv = G.global_argv;
5555 if (G.global_args_malloced) {
5561 G.global_args_malloced = 1;
5562 pp = xzalloc(sizeof(pp[0]) * 2);
5563 pp[0] = g_argv[0]; /* retain $0 */
5566 /* This realloc's G.global_argv */
5567 G.global_argv = pp = add_strings_to_strings(g_argv, argv, /*dup:*/ 1);
5574 return EXIT_SUCCESS;
5576 /* Nothing known, so abort */
5578 bb_error_msg("set: %s: invalid option", arg);
5579 return EXIT_FAILURE;
5582 static int builtin_shift(char **argv)
5588 if (n >= 0 && n < G.global_argc) {
5589 if (G.global_args_malloced) {
5592 free(G.global_argv[m++]);
5595 memmove(&G.global_argv[1], &G.global_argv[n+1],
5596 G.global_argc * sizeof(G.global_argv[0]));
5597 return EXIT_SUCCESS;
5599 return EXIT_FAILURE;
5602 static int builtin_source(char **argv)
5606 if (argv[1] == NULL)
5607 return EXIT_FAILURE;
5609 /* XXX search through $PATH is missing */
5610 input = fopen_for_read(argv[1]);
5612 bb_error_msg("can't open '%s'", argv[1]);
5613 return EXIT_FAILURE;
5615 close_on_exec_on(fileno(input));
5617 /* Now run the file */
5618 /* XXX argv and argc are broken; need to save old G.global_argv
5619 * (pointer only is OK!) on this stack frame,
5620 * set G.global_argv=argv+1, recurse, and restore. */
5621 parse_and_run_file(input);
5623 return G.last_return_code;
5626 static int builtin_umask(char **argv)
5629 const char *arg = argv[1];
5631 new_umask = bb_strtou(arg, NULL, 8);
5633 return EXIT_FAILURE;
5635 new_umask = umask(0);
5636 printf("%.3o\n", (unsigned) new_umask);
5639 return EXIT_SUCCESS;
5642 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#unset */
5643 static int builtin_unset(char **argv)
5650 return EXIT_SUCCESS;
5653 if (argv[1][0] == '-') {
5654 switch (argv[1][1]) {
5656 case 'f': if (ENABLE_HUSH_FUNCTIONS) { var = false; break; }
5658 bb_error_msg("unset: %s: invalid option", argv[1]);
5659 return EXIT_FAILURE;
5667 if (unset_local_var(argv[i]))
5670 #if ENABLE_HUSH_FUNCTIONS
5672 unset_local_func(argv[i]);
5678 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/wait.html */
5679 static int builtin_wait(char **argv)
5681 int ret = EXIT_SUCCESS;
5684 if (*++argv == NULL) {
5685 /* Don't care about wait results */
5686 /* Note 1: must wait until there are no more children */
5687 /* Note 2: must be interruptible */
5689 * $ sleep 3 & sleep 6 & wait
5694 * $ sleep 3 & sleep 6 & wait
5698 * ^C <-- after ~4 sec from keyboard
5701 sigaddset(&G.blocked_set, SIGCHLD);
5702 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5705 if (errno == ECHILD)
5707 /* Wait for SIGCHLD or any other signal of interest */
5708 /* sigtimedwait with infinite timeout: */
5709 sig = sigwaitinfo(&G.blocked_set, NULL);
5711 sig = check_and_run_traps(sig);
5712 if (sig && sig != SIGCHLD) { /* see note 2 */
5718 sigdelset(&G.blocked_set, SIGCHLD);
5719 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5723 /* This is probably buggy wrt interruptible-ness */
5725 pid_t pid = bb_strtou(*argv, NULL, 10);
5727 /* mimic bash message */
5728 bb_error_msg("wait: '%s': not a pid or valid job spec", *argv);
5729 return EXIT_FAILURE;
5731 if (waitpid(pid, &status, 0) == pid) {
5732 if (WIFSIGNALED(status))
5733 ret = 128 + WTERMSIG(status);
5734 else if (WIFEXITED(status))
5735 ret = WEXITSTATUS(status);
5739 bb_perror_msg("wait %s", *argv);
5748 #if ENABLE_HUSH_LOOPS
5749 static int builtin_break(char **argv)
5751 if (G.depth_of_loop == 0) {
5752 bb_error_msg("%s: only meaningful in a loop", argv[0]);
5753 return EXIT_SUCCESS; /* bash compat */
5755 G.flag_break_continue++; /* BC_BREAK = 1 */
5756 G.depth_break_continue = 1;
5758 G.depth_break_continue = bb_strtou(argv[1], NULL, 10);
5759 if (errno || !G.depth_break_continue || argv[2]) {
5760 bb_error_msg("%s: bad arguments", argv[0]);
5761 G.flag_break_continue = BC_BREAK;
5762 G.depth_break_continue = UINT_MAX;
5765 if (G.depth_of_loop < G.depth_break_continue)
5766 G.depth_break_continue = G.depth_of_loop;
5767 return EXIT_SUCCESS;
5770 static int builtin_continue(char **argv)
5772 G.flag_break_continue = 1; /* BC_CONTINUE = 2 = 1+1 */
5773 return builtin_break(argv);