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 * Arithmetic Expansion
42 * <(list) and >(list) Process Substitution
43 * Here Documents ( << word )
46 * Parameter Expansion for substring processing ${var#word} ${var%word}
48 * Bash stuff maybe optional enable:
49 * &> and >& redirection of stdout+stderr
51 * reserved words: [[ ]] function select
52 * substrings ${var:1:5}
55 * job handling woefully incomplete and buggy (improved --vda)
57 * port selected bugfixes from post-0.49 busybox lash - done?
58 * change { and } from special chars to reserved words
59 * builtins: return, trap, ulimit
60 * test magic exec with redirection only
61 * follow IFS rules more precisely, including update semantics
62 * figure out what to do with backslash-newline
63 * propagate syntax errors, die on resource errors?
64 * continuation lines, both explicit and implicit - done?
65 * maybe change charmap[] to use 2-bit entries
67 * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
70 #include "busybox.h" /* for APPLET_IS_NOFORK/NOEXEC */
71 //TODO: pull in some .h and find out whether we have SINGLE_APPLET_MAIN?
72 //#include "applet_tables.h" doesn't work
74 /* #include <dmalloc.h> */
81 #define HUSH_VER_STR "0.92"
83 #if defined SINGLE_APPLET_MAIN
84 /* STANDALONE does not make sense, and won't compile */
85 #undef CONFIG_FEATURE_SH_STANDALONE
86 #undef ENABLE_FEATURE_SH_STANDALONE
87 #undef USE_FEATURE_SH_STANDALONE
88 #define SKIP_FEATURE_SH_STANDALONE(...) __VA_ARGS__
89 #define ENABLE_FEATURE_SH_STANDALONE 0
90 #define USE_FEATURE_SH_STANDALONE(...)
91 #define SKIP_FEATURE_SH_STANDALONE(...) __VA_ARGS__
94 #if !BB_MMU && ENABLE_HUSH_TICK
95 //#undef ENABLE_HUSH_TICK
96 //#define ENABLE_HUSH_TICK 0
97 #warning On NOMMU, hush command substitution is dangerous.
98 #warning Dont use it for commands which produce lots of output.
99 #warning For more info see shell/hush.c, generate_stream_from_list().
102 #if !ENABLE_HUSH_INTERACTIVE
103 #undef ENABLE_FEATURE_EDITING
104 #define ENABLE_FEATURE_EDITING 0
105 #undef ENABLE_FEATURE_EDITING_FANCY_PROMPT
106 #define ENABLE_FEATURE_EDITING_FANCY_PROMPT 0
109 /* Do we support ANY keywords? */
110 #if ENABLE_HUSH_IF || ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
111 #define HAS_KEYWORDS 1
112 #define IF_HAS_KEYWORDS(...) __VA_ARGS__
113 #define IF_HAS_NO_KEYWORDS(...)
115 #define HAS_KEYWORDS 0
116 #define IF_HAS_KEYWORDS(...)
117 #define IF_HAS_NO_KEYWORDS(...) __VA_ARGS__
120 /* Keep unconditionally on for now */
123 #define ENABLE_HUSH_FUNCTIONS 0
126 /* If you comment out one of these below, it will be #defined later
127 * to perform debug printfs to stderr: */
128 #define debug_printf(...) do {} while (0)
129 /* Finer-grained debug switches */
130 #define debug_printf_parse(...) do {} while (0)
131 #define debug_print_tree(a, b) do {} while (0)
132 #define debug_printf_exec(...) do {} while (0)
133 #define debug_printf_env(...) do {} while (0)
134 #define debug_printf_jobs(...) do {} while (0)
135 #define debug_printf_expand(...) do {} while (0)
136 #define debug_printf_glob(...) do {} while (0)
137 #define debug_printf_list(...) do {} while (0)
138 #define debug_printf_subst(...) do {} while (0)
139 #define debug_printf_clean(...) do {} while (0)
142 #define debug_printf(...) fprintf(stderr, __VA_ARGS__)
145 #ifndef debug_printf_parse
146 #define debug_printf_parse(...) fprintf(stderr, __VA_ARGS__)
149 #ifndef debug_printf_exec
150 #define debug_printf_exec(...) fprintf(stderr, __VA_ARGS__)
153 #ifndef debug_printf_env
154 #define debug_printf_env(...) fprintf(stderr, __VA_ARGS__)
157 #ifndef debug_printf_jobs
158 #define debug_printf_jobs(...) fprintf(stderr, __VA_ARGS__)
164 #ifndef debug_printf_expand
165 #define debug_printf_expand(...) fprintf(stderr, __VA_ARGS__)
166 #define DEBUG_EXPAND 1
168 #define DEBUG_EXPAND 0
171 #ifndef debug_printf_glob
172 #define debug_printf_glob(...) fprintf(stderr, __VA_ARGS__)
178 #ifndef debug_printf_list
179 #define debug_printf_list(...) fprintf(stderr, __VA_ARGS__)
182 #ifndef debug_printf_subst
183 #define debug_printf_subst(...) fprintf(stderr, __VA_ARGS__)
186 #ifndef debug_printf_clean
187 /* broken, of course, but OK for testing */
188 static const char *indenter(int i)
190 static const char blanks[] ALIGN1 =
192 return &blanks[sizeof(blanks) - i - 1];
194 #define debug_printf_clean(...) fprintf(stderr, __VA_ARGS__)
195 #define DEBUG_CLEAN 1
199 static void debug_print_strings(const char *prefix, char **vv)
201 fprintf(stderr, "%s:\n", prefix);
203 fprintf(stderr, " '%s'\n", *vv++);
206 #define debug_print_strings(prefix, vv) ((void)0)
210 * Leak hunting. Use hush_leaktool.sh for post-processing.
212 #ifdef FOR_HUSH_LEAKTOOL
213 /* suppress "warning: no previous prototype..." */
214 void *xxmalloc(int lineno, size_t size);
215 void *xxrealloc(int lineno, void *ptr, size_t size);
216 char *xxstrdup(int lineno, const char *str);
217 void xxfree(void *ptr);
218 void *xxmalloc(int lineno, size_t size)
220 void *ptr = xmalloc((size + 0xff) & ~0xff);
221 fprintf(stderr, "line %d: malloc %p\n", lineno, ptr);
224 void *xxrealloc(int lineno, void *ptr, size_t size)
226 ptr = xrealloc(ptr, (size + 0xff) & ~0xff);
227 fprintf(stderr, "line %d: realloc %p\n", lineno, ptr);
230 char *xxstrdup(int lineno, const char *str)
232 char *ptr = xstrdup(str);
233 fprintf(stderr, "line %d: strdup %p\n", lineno, ptr);
236 void xxfree(void *ptr)
238 fprintf(stderr, "free %p\n", ptr);
241 #define xmalloc(s) xxmalloc(__LINE__, s)
242 #define xrealloc(p, s) xxrealloc(__LINE__, p, s)
243 #define xstrdup(s) xxstrdup(__LINE__, s)
244 #define free(p) xxfree(p)
248 static const char hush_version_str[] ALIGN1 = "HUSH_VERSION="HUSH_VER_STR;
250 #define JOB_STATUS_FORMAT "[%d] %-22s %.40s\n"
252 #define SPECIAL_VAR_SYMBOL 3
253 #define PARSEFLAG_EXIT_FROM_LOOP 1
255 typedef enum redir_type {
257 REDIRECT_OVERWRITE = 2,
263 /* The descrip member of this structure is only used to make
264 * debugging output pretty */
265 static const struct {
267 signed char default_fd;
271 { O_RDONLY, 0, "<" },
272 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
273 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
274 { O_RDONLY, -1, "<<" },
278 typedef enum pipe_style {
285 typedef enum reserved_style {
294 #if ENABLE_HUSH_LOOPS
301 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
306 /* two pseudo-keywords support contrived "case" syntax: */
307 RES_MATCH , /* "word)" */
308 RES_CASEI , /* "this command is inside CASE" */
315 struct redir_struct {
316 struct redir_struct *next;
317 char *rd_filename; /* filename */
318 int fd; /* file descriptor being redirected */
319 int dup; /* -1, or file descriptor being duplicated */
320 smallint /*enum redir_type*/ rd_type;
324 pid_t pid; /* 0 if exited */
325 int assignment_cnt; /* how many argv[i] are assignments? */
326 smallint is_stopped; /* is the command currently running? */
327 smallint grp_type; /* GRP_xxx */
328 struct pipe *group; /* if non-NULL, this "prog" is {} group,
329 * subshell, or a compound statement */
330 char **argv; /* command name and arguments */
331 struct redir_struct *redirects; /* I/O redirections */
333 /* argv vector may contain variable references (^Cvar^C, ^C0^C etc)
334 * and on execution these are substituted with their values.
335 * Substitution can make _several_ words out of one argv[n]!
336 * Example: argv[0]=='.^C*^C.' here: echo .$*.
337 * References of the form ^C`cmd arg^C are `cmd arg` substitutions.
340 #define GRP_SUBSHELL 1
341 #if ENABLE_HUSH_FUNCTIONS
342 #define GRP_FUNCTION 2
347 int num_cmds; /* total number of commands in job */
348 int alive_cmds; /* number of commands running (not exited) */
349 int stopped_cmds; /* number of commands alive, but stopped */
351 int jobid; /* job number */
352 pid_t pgrp; /* process group ID for the job */
353 char *cmdtext; /* name of job */
355 struct command *cmds; /* array of commands in pipe */
356 smallint followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
357 IF_HAS_KEYWORDS(smallint pi_inverted;) /* "! cmd | cmd" */
358 IF_HAS_KEYWORDS(smallint res_word;) /* needed for if, for, while, until... */
361 /* This holds pointers to the various results of parsing */
362 struct parse_context {
363 struct command *command;
364 struct pipe *list_head;
366 struct redir_struct *pending_redirect;
369 smallint ctx_inverted; /* "! cmd | cmd" */
371 smallint ctx_dsemicolon; /* ";;" seen */
373 int old_flag; /* bitmask of FLAG_xxx, for figuring out valid reserved words */
374 struct parse_context *stack;
378 /* On program start, environ points to initial environment.
379 * putenv adds new pointers into it, unsetenv removes them.
380 * Neither of these (de)allocates the strings.
381 * setenv allocates new strings in malloc space and does putenv,
382 * and thus setenv is unusable (leaky) for shell's purposes */
383 #define setenv(...) setenv_is_leaky_dont_use()
385 struct variable *next;
386 char *varstr; /* points to "name=" portion */
387 int max_len; /* if > 0, name is part of initial env; else name is malloced */
388 smallint flg_export; /* putenv should be done on this var */
389 smallint flg_read_only;
392 typedef struct o_string {
394 int length; /* position where data is appended */
396 /* Misnomer! it's not "quoting", it's "protection against globbing"!
397 * (by prepending \ to *, ?, [ and to \ too) */
401 smallint has_empty_slot;
402 smallint o_assignment; /* 0:maybe, 1:yes, 2:no */
405 MAYBE_ASSIGNMENT = 0,
406 DEFINITELY_ASSIGNMENT = 1,
408 WORD_IS_KEYWORD = 3, /* not assigment, but next word may be: "if v=xyz cmd;" */
410 /* Used for initialization: o_string foo = NULL_O_STRING; */
411 #define NULL_O_STRING { NULL }
413 /* I can almost use ordinary FILE*. Is open_memstream() universally
414 * available? Where is it documented? */
415 typedef struct in_str {
417 /* eof_flag=1: last char in ->p is really an EOF */
418 char eof_flag; /* meaningless if ->p == NULL */
420 #if ENABLE_HUSH_INTERACTIVE
422 smallint promptmode; /* 0: PS1, 1: PS2 */
425 int (*get) (struct in_str *);
426 int (*peek) (struct in_str *);
428 #define i_getch(input) ((input)->get(input))
429 #define i_peek(input) ((input)->peek(input))
433 CHAR_ORDINARY_IF_QUOTED = 1, /* example: *, # */
434 CHAR_IFS = 2, /* treated as ordinary if quoted */
435 CHAR_SPECIAL = 3, /* example: $ */
444 /* "Globals" within this file */
445 /* Sorted roughly by size (smaller offsets == smaller code) */
447 #if ENABLE_HUSH_INTERACTIVE
448 /* 'interactive_fd' is a fd# open to ctty, if we have one
449 * _AND_ if we decided to act interactively */
454 #if ENABLE_FEATURE_EDITING
455 line_input_t *line_input_state;
461 pid_t saved_tty_pgrp;
463 struct pipe *job_list;
464 struct pipe *toplevel_list;
465 //// smallint ctrl_z_flag;
467 smallint flag_SIGINT;
468 #if ENABLE_HUSH_LOOPS
469 smallint flag_break_continue;
472 /* These four support $?, $#, and $1 */
473 smalluint last_return_code;
474 /* is global_argv and global_argv[1..n] malloced? (note: not [0]) */
475 smalluint global_args_malloced;
476 /* how many non-NULL argv's we have. NB: $# + 1 */
479 #if ENABLE_HUSH_LOOPS
480 unsigned depth_break_continue;
481 unsigned depth_of_loop;
485 struct variable *top_var; /* = &G.shell_ver (set in main()) */
486 struct variable shell_ver;
487 #if ENABLE_FEATURE_SH_STANDALONE
488 struct nofork_save_area nofork_save;
491 sigjmp_buf toplevel_jb;
493 unsigned char charmap[256];
494 char user_input_buf[ENABLE_FEATURE_EDITING ? BUFSIZ : 2];
495 /* Signal and trap handling */
496 // unsigned count_SIGCHLD;
497 // unsigned handled_SIGCHLD;
498 /* which signals have non-DFL handler (even with no traps set)? */
499 unsigned non_DFL_mask;
500 char **traps; /* char *traps[NSIG] */
501 sigset_t blocked_set;
502 sigset_t inherited_set;
504 #define G (*ptr_to_globals)
505 /* Not #defining name to G.name - this quickly gets unwieldy
506 * (too many defines). Also, I actually prefer to see when a variable
507 * is global, thus "G." prefix is a useful hint */
508 #define INIT_G() do { \
509 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
513 /* Function prototypes for builtins */
514 static int builtin_cd(char **argv);
515 static int builtin_echo(char **argv);
516 static int builtin_eval(char **argv);
517 static int builtin_exec(char **argv);
518 static int builtin_exit(char **argv);
519 static int builtin_export(char **argv);
521 static int builtin_fg_bg(char **argv);
522 static int builtin_jobs(char **argv);
525 static int builtin_help(char **argv);
527 static int builtin_pwd(char **argv);
528 static int builtin_read(char **argv);
529 static int builtin_test(char **argv);
530 static int builtin_trap(char **argv);
531 static int builtin_true(char **argv);
532 static int builtin_set(char **argv);
533 static int builtin_shift(char **argv);
534 static int builtin_source(char **argv);
535 static int builtin_umask(char **argv);
536 static int builtin_unset(char **argv);
537 static int builtin_wait(char **argv);
538 #if ENABLE_HUSH_LOOPS
539 static int builtin_break(char **argv);
540 static int builtin_continue(char **argv);
542 //static int builtin_not_written(char **argv);
544 /* Table of built-in functions. They can be forked or not, depending on
545 * context: within pipes, they fork. As simple commands, they do not.
546 * When used in non-forking context, they can change global variables
547 * in the parent shell process. If forked, of course they cannot.
548 * For example, 'unset foo | whatever' will parse and run, but foo will
549 * still be set at the end. */
550 struct built_in_command {
552 int (*function)(char **argv);
555 #define BLTIN(cmd, func, help) { cmd, func, help }
557 #define BLTIN(cmd, func, help) { cmd, func }
561 /* For now, echo and test are unconditionally enabled.
562 * Maybe make it configurable? */
563 static const struct built_in_command bltins[] = {
564 BLTIN("." , builtin_source, "Run commands in a file"),
565 BLTIN(":" , builtin_true, "No-op"),
566 BLTIN("[" , builtin_test, "Test condition"),
568 BLTIN("bg" , builtin_fg_bg, "Resume a job in the background"),
570 #if ENABLE_HUSH_LOOPS
571 BLTIN("break" , builtin_break, "Exit from a loop"),
573 BLTIN("cd" , builtin_cd, "Change directory"),
574 #if ENABLE_HUSH_LOOPS
575 BLTIN("continue", builtin_continue, "Start new loop iteration"),
577 BLTIN("echo" , builtin_echo, "Write to stdout"),
578 BLTIN("eval" , builtin_eval, "Construct and run shell command"),
579 BLTIN("exec" , builtin_exec, "Execute command, don't return to shell"),
580 BLTIN("exit" , builtin_exit, "Exit"),
581 BLTIN("export", builtin_export, "Set environment variable"),
583 BLTIN("fg" , builtin_fg_bg, "Bring job into the foreground"),
584 BLTIN("jobs" , builtin_jobs, "List active jobs"),
586 BLTIN("pwd" , builtin_pwd, "Print current directory"),
587 BLTIN("read" , builtin_read, "Input environment variable"),
588 // BLTIN("return", builtin_not_written, "Return from a function"),
589 BLTIN("set" , builtin_set, "Set/unset shell local variables"),
590 BLTIN("shift" , builtin_shift, "Shift positional parameters"),
591 BLTIN("test" , builtin_test, "Test condition"),
592 BLTIN("trap" , builtin_trap, "Trap signals"),
593 // BLTIN("ulimit", builtin_not_written, "Control resource limits"),
594 BLTIN("umask" , builtin_umask, "Set file creation mask"),
595 BLTIN("unset" , builtin_unset, "Unset environment variable"),
596 BLTIN("wait" , builtin_wait, "Wait for process"),
598 BLTIN("help" , builtin_help, "List shell built-in commands"),
604 static void maybe_die(const char *notice, const char *msg)
606 /* Was using fancy stuff:
607 * (G.interactive_fd ? bb_error_msg : bb_error_msg_and_die)(...params...)
608 * but it SEGVs. ?! Oh well... explicit temp ptr works around that */
609 void FAST_FUNC (*fp)(const char *s, ...) = bb_error_msg_and_die;
610 #if ENABLE_HUSH_INTERACTIVE
611 fp = (G.interactive_fd ? bb_error_msg : bb_error_msg_and_die);
613 fp(msg ? "%s: %s" : notice, notice, msg);
616 #define syntax(msg) maybe_die("syntax error", msg);
618 /* Debug -- trick gcc to expand __LINE__ and convert to string */
619 #define __syntax(msg, line) maybe_die("syntax error hush.c:" # line, msg)
620 #define _syntax(msg, line) __syntax(msg, line)
621 #define syntax(msg) _syntax(msg, __LINE__)
624 static int glob_needed(const char *s)
629 if (*s == '*' || *s == '[' || *s == '?')
636 static int is_assignment(const char *s)
638 if (!s || !(isalpha(*s) || *s == '_'))
641 while (isalnum(*s) || *s == '_')
646 /* Replace each \x with x in place, return ptr past NUL. */
647 static char *unbackslash(char *src)
653 if ((*dst++ = *src++) == '\0')
659 static char **add_strings_to_strings(char **strings, char **add, int need_to_dup)
680 v = xrealloc(strings, (count1 + count2 + 1) * sizeof(char*));
681 v[count1 + count2] = NULL;
684 v[count1 + i] = (need_to_dup ? xstrdup(add[i]) : add[i]);
688 static char **add_string_to_strings(char **strings, char *add)
693 return add_strings_to_strings(strings, v, /*dup:*/ 0);
696 static void putenv_all(char **strings)
701 debug_printf_env("putenv '%s'\n", *strings);
706 static char **putenv_all_and_save_old(char **strings)
716 eq = strchr(*strings, '=');
719 v = getenv(*strings);
722 /* v points to VAL in VAR=VAL, go back to VAR */
723 v -= (eq - *strings) + 1;
724 old = add_string_to_strings(old, v);
733 static void free_strings_and_unsetenv(char **strings, int unset)
743 debug_printf_env("unsetenv '%s'\n", *v);
751 static void free_strings(char **strings)
753 free_strings_and_unsetenv(strings, 0);
757 /* Basic theory of signal handling in shell
758 * ========================================
759 * This does not describe what hush does, rather, it is current understanding
760 * what it _should_ do. If it doesn't, it's a bug.
761 * http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
763 * Signals are handled only after each pipe ("cmd | cmd | cmd" thing)
764 * is finished or backgrounded. It is the same in interactive and
765 * non-interactive shells, and is the same regardless of whether
766 * a user trap handler is installed or a shell special one is in effect.
767 * ^C or ^Z from keyboard seem to execute "at once" because it usually
768 * backgrounds (i.e. stops) or kills all members of currently running
771 * Wait builtin in interruptible by signals for which user trap is set
772 * or by SIGINT in interactive shell.
774 * Trap handlers will execute even within trap handlers. (right?)
776 * User trap handlers are forgotten when subshell ("(cmd)") is entered. [TODO]
778 * If job control is off, backgrounded commands ("cmd &")
779 * have SIGINT, SIGQUIT set to SIG_IGN.
781 * Commands run in command substitution ("`cmd`")
782 * have SIGTTIN, SIGTTOU, SIGTSTP set to SIG_IGN.
784 * Ordinary commands have signals set to SIG_IGN/DFL set as inherited
785 * by the shell from its parent.
787 * Siganls which differ from SIG_DFL action
788 * (note: child (i.e., [v]forked) shell is not an interactive shell):
791 * SIGTERM (interactive): ignore
792 * SIGHUP (interactive):
793 * send SIGCONT to stopped jobs, send SIGHUP to all jobs and exit
794 * SIGTTIN, SIGTTOU, SIGTSTP (if job control is on): ignore
795 * (note that ^Z is handled not by trapping SIGTSTP, but by seeing
796 * that all pipe members are stopped) (right?)
797 * SIGINT (interactive): wait for last pipe, ignore the rest
798 * of the command line, show prompt. NB: ^C does not send SIGINT
799 * to interactive shell while shell is waiting for a pipe,
800 * since shell is bg'ed (is not in foreground process group).
801 * (check/expand this)
802 * Example 1: this waits 5 sec, but does not execute ls:
803 * "echo $$; sleep 5; ls -l" + "kill -INT <pid>"
804 * Example 2: this does not wait and does not execute ls:
805 * "echo $$; sleep 5 & wait; ls -l" + "kill -INT <pid>"
806 * Example 3: this does not wait 5 sec, but executes ls:
807 * "sleep 5; ls -l" + press ^C
809 * (What happens to signals which are IGN on shell start?)
810 * (What happens with signal mask on shell start?)
812 * Implementation in hush
813 * ======================
814 * We use in-kernel pending signal mask to determine which signals were sent.
815 * We block all signals which we don't want to take action immediately,
816 * i.e. we block all signals which need to have special handling as described
817 * above, and all signals which have traps set.
818 * After each pipe execution, we extract any pending signals via sigtimedwait()
821 * unsigned non_DFL_mask: a mask of such "special" signals
822 * sigset_t blocked_set: current blocked signal set
825 * clear bit in blocked_set unless it is also in non_DFL
826 * "trap 'cmd' SIGxxx":
827 * set bit in blocked_set (even if 'cmd' is '')
828 * after [v]fork, if we plan to be a shell:
829 * nothing for {} child shell (say, "true | { true; true; } | true")
830 * unset all traps if () shell. [TODO]
831 * after [v]fork, if we plan to exec:
832 * POSIX says pending signal mask is cleared in child - no need to clear it.
833 * Restore blocked signal set to one inherited by shell just prior to exec.
835 * Note: as a result, we do not use signal handlers much. The only uses
836 * are to count SIGCHLDs [disabled - bug somewhere, + bloat]
837 * and to restore tty pgrp on signal-induced exit.
839 * TODO: check/fix wait builtin to be interruptible.
842 //static void SIGCHLD_handler(int sig UNUSED_PARAM)
844 // G.count_SIGCHLD++;
847 /* called once at shell init */
848 static void init_signal_mask(void)
851 unsigned mask = (1 << SIGQUIT);
852 #if ENABLE_HUSH_INTERACTIVE
853 if (G.interactive_fd) {
859 | (1 << SIGTTIN) | (1 << SIGTTOU) | (1 << SIGTSTP)
865 G.non_DFL_mask = mask;
867 sigprocmask(SIG_SETMASK, NULL, &G.blocked_set);
871 sigaddset(&G.blocked_set, sig);
875 sigdelset(&G.blocked_set, SIGCHLD);
876 sigprocmask(SIG_SETMASK, &G.blocked_set, &G.inherited_set);
879 static int check_and_run_traps(int sig)
881 static const struct timespec zero_timespec = { 0, 0 };
882 smalluint save_rcode;
888 sig = sigtimedwait(&G.blocked_set, NULL, &zero_timespec);
893 if (G.traps && G.traps[sig]) {
894 if (G.traps[sig][0]) {
895 /* We have user-defined handler */
896 char *argv[] = { NULL, xstrdup(G.traps[sig]), NULL };
897 save_rcode = G.last_return_code;
900 G.last_return_code = save_rcode;
901 } /* else: "" trap, ignoring signal */
904 /* not a trap: special action */
907 // G.count_SIGCHLD++;
916 default: /* SIGTERM, SIGQUIT, SIGTTIN, SIGTTOU, SIGTSTP */
925 /* Restores tty foreground process group, and exits.
926 * May be called as signal handler for fatal signal
927 * (will faithfully resend signal to itself, producing correct exit state)
928 * or called directly with -EXITCODE.
929 * We also call it if xfunc is exiting. */
930 static void sigexit(int sig) NORETURN;
931 static void sigexit(int sig)
933 /* Disable all signals: job control, SIGPIPE, etc. */
934 sigprocmask_allsigs(SIG_BLOCK);
936 #if ENABLE_HUSH_INTERACTIVE
937 /* Careful: we can end up here after [v]fork. Do not restore
938 * tty pgrp then, only top-level shell process does that */
939 if (G.interactive_fd && getpid() == G.root_pid)
940 tcsetpgrp(G.interactive_fd, G.saved_tty_pgrp);
943 /* Not a signal, just exit */
947 kill_myself_with_sig(sig); /* does not return */
951 static void maybe_set_sighandler(int sig)
953 void (*handler)(int);
954 /* non_DFL_mask'ed signals are, well, masked,
955 * no need to set handler for them.
957 if (!((G.non_DFL_mask >> sig) & 1)) {
958 handler = signal(sig, sigexit);
959 if (handler == SIG_IGN) /* oops... restore back to IGN! */
960 signal(sig, handler);
963 /* Used only to set handler to restore pgrp on exit */
964 static void set_fatal_signals_to_sigexit(void)
967 maybe_set_sighandler(SIGILL );
968 maybe_set_sighandler(SIGFPE );
969 maybe_set_sighandler(SIGBUS );
970 maybe_set_sighandler(SIGSEGV);
971 maybe_set_sighandler(SIGTRAP);
972 } /* else: hush is perfect. what SEGV? */
974 maybe_set_sighandler(SIGABRT);
976 /* bash 3.2 seems to handle these just like 'fatal' ones */
977 maybe_set_sighandler(SIGPIPE);
978 maybe_set_sighandler(SIGALRM);
979 maybe_set_sighandler(SIGHUP );
981 /* if we aren't interactive... but in this case
982 * we never want to restore pgrp on exit, and this fn is not called */
983 /*maybe_set_sighandler(SIGTERM);*/
984 /*maybe_set_sighandler(SIGINT );*/
986 /* Used only to suppress ^Z in `cmd` */
987 static void set_jobctrl_signals_to_IGN(void)
998 #define set_fatal_signals_to_sigexit(handler) ((void)0)
999 #define set_jobctrl_signals_to_IGN(handler) ((void)0)
1003 /* Restores tty foreground process group, and exits. */
1004 static void hush_exit(int exitcode) NORETURN;
1005 static void hush_exit(int exitcode)
1007 if (G.traps && G.traps[0] && G.traps[0][0]) {
1008 char *argv[] = { NULL, xstrdup(G.traps[0]), NULL };
1014 fflush(NULL); /* flush all streams */
1015 sigexit(- (exitcode & 0xff));
1022 static const char *set_cwd(void)
1024 /* xrealloc_getcwd_or_warn(arg) calls free(arg),
1025 * we must not try to free(bb_msg_unknown) */
1026 if (G.cwd == bb_msg_unknown)
1028 G.cwd = xrealloc_getcwd_or_warn((char *)G.cwd);
1030 G.cwd = bb_msg_unknown;
1035 /* Get/check local shell variables */
1036 static struct variable *get_local_var(const char *name)
1038 struct variable *cur;
1044 for (cur = G.top_var; cur; cur = cur->next) {
1045 if (strncmp(cur->varstr, name, len) == 0 && cur->varstr[len] == '=')
1051 /* Basically useful version until someone wants to get fancier,
1052 * see the bash man page under "Parameter Expansion" */
1053 static const char *lookup_param(const char *src)
1055 struct variable *var = get_local_var(src);
1057 return strchr(var->varstr, '=') + 1;
1061 /* str holds "NAME=VAL" and is expected to be malloced.
1062 * We take ownership of it.
1063 * flg_export is used by:
1066 * -1: if NAME is set, leave export status alone
1067 * if NAME is not set, do not export
1069 static int set_local_var(char *str, int flg_export)
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) {
1096 bb_error_msg("%s: readonly variable", str);
1100 debug_printf_env("%s: unsetenv '%s'\n", __func__, str);
1101 unsetenv(str); /* just in case */
1103 if (strcmp(cur->varstr, str) == 0) {
1108 if (cur->max_len >= strlen(str)) {
1109 /* This one is from startup env, reuse space */
1110 strcpy(cur->varstr, str);
1113 /* max_len == 0 signifies "malloced" var, which we can
1114 * (and has to) free */
1118 goto set_str_and_exp;
1121 /* Not found - create next variable struct */
1122 cur->next = xzalloc(sizeof(*cur));
1128 if (flg_export == 1)
1129 cur->flg_export = 1;
1130 if (cur->flg_export) {
1131 debug_printf_env("%s: putenv '%s'\n", __func__, cur->varstr);
1132 return putenv(cur->varstr);
1137 static int unset_local_var(const char *name)
1139 struct variable *cur;
1140 struct variable *prev = prev; /* for gcc */
1144 return EXIT_SUCCESS;
1145 name_len = strlen(name);
1148 if (strncmp(cur->varstr, name, name_len) == 0 && cur->varstr[name_len] == '=') {
1149 if (cur->flg_read_only) {
1150 bb_error_msg("%s: readonly variable", name);
1151 return EXIT_FAILURE;
1153 /* prev is ok to use here because 1st variable, HUSH_VERSION,
1154 * is ro, and we cannot reach this code on the 1st pass */
1155 prev->next = cur->next;
1156 debug_printf_env("%s: unsetenv '%s'\n", __func__, cur->varstr);
1157 bb_unsetenv(cur->varstr);
1161 return EXIT_SUCCESS;
1166 return EXIT_SUCCESS;
1169 #if ENABLE_SH_MATH_SUPPORT
1170 #define is_name(c) ((c) == '_' || isalpha((unsigned char)(c)))
1171 #define is_in_name(c) ((c) == '_' || isalnum((unsigned char)(c)))
1172 static char *endofname(const char *name)
1180 if (!is_in_name(*p))
1186 static void arith_set_local_var(const char *name, const char *val, int flags)
1188 /* arith code doesnt malloc space, so do it for it */
1189 char *var = xasprintf("%s=%s", name, val);
1190 set_local_var(var, flags);
1198 static int static_get(struct in_str *i)
1201 if (ch == '\0') return EOF;
1205 static int static_peek(struct in_str *i)
1210 #if ENABLE_HUSH_INTERACTIVE
1212 static void cmdedit_set_initial_prompt(void)
1214 if (ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1215 G.PS1 = getenv("PS1");
1222 static const char* setup_prompt_string(int promptmode)
1224 const char *prompt_str;
1225 debug_printf("setup_prompt_string %d ", promptmode);
1226 if (!ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1227 /* Set up the prompt */
1228 if (promptmode == 0) { /* PS1 */
1230 G.PS1 = xasprintf("%s %c ", G.cwd, (geteuid() != 0) ? '$' : '#');
1235 prompt_str = (promptmode == 0) ? G.PS1 : G.PS2;
1236 debug_printf("result '%s'\n", prompt_str);
1240 static void get_user_input(struct in_str *i)
1243 const char *prompt_str;
1245 prompt_str = setup_prompt_string(i->promptmode);
1246 #if ENABLE_FEATURE_EDITING
1247 /* Enable command line editing only while a command line
1248 * is actually being read */
1251 /* buglet: SIGINT will not make new prompt to appear _at once_,
1252 * only after <Enter>. (^C will work) */
1253 r = read_line_input(prompt_str, G.user_input_buf, BUFSIZ-1, G.line_input_state);
1254 /* catch *SIGINT* etc (^C is handled by read_line_input) */
1255 check_and_run_traps(0);
1256 } while (r == 0 || G.flag_SIGINT); /* repeat if ^C or SIGINT */
1257 i->eof_flag = (r < 0);
1258 if (i->eof_flag) { /* EOF/error detected */
1259 G.user_input_buf[0] = EOF; /* yes, it will be truncated, it's ok */
1260 G.user_input_buf[1] = '\0';
1265 fputs(prompt_str, stdout);
1267 G.user_input_buf[0] = r = fgetc(i->file);
1268 /*G.user_input_buf[1] = '\0'; - already is and never changed */
1269 //do we need check_and_run_traps(0)? (maybe only if stdin)
1270 } while (G.flag_SIGINT);
1271 i->eof_flag = (r == EOF);
1273 i->p = G.user_input_buf;
1276 #endif /* INTERACTIVE */
1278 /* This is the magic location that prints prompts
1279 * and gets data back from the user */
1280 static int file_get(struct in_str *i)
1284 /* If there is data waiting, eat it up */
1285 if (i->p && *i->p) {
1286 #if ENABLE_HUSH_INTERACTIVE
1290 if (i->eof_flag && !*i->p)
1293 /* need to double check i->file because we might be doing something
1294 * more complicated by now, like sourcing or substituting. */
1295 #if ENABLE_HUSH_INTERACTIVE
1296 if (G.interactive_fd && i->promptme && i->file == stdin) {
1299 } while (!*i->p); /* need non-empty line */
1300 i->promptmode = 1; /* PS2 */
1305 ch = fgetc(i->file);
1307 debug_printf("file_get: got a '%c' %d\n", ch, ch);
1308 #if ENABLE_HUSH_INTERACTIVE
1315 /* All the callers guarantee this routine will never be
1316 * used right after a newline, so prompting is not needed.
1318 static int file_peek(struct in_str *i)
1321 if (i->p && *i->p) {
1322 if (i->eof_flag && !i->p[1])
1326 ch = fgetc(i->file);
1327 i->eof_flag = (ch == EOF);
1328 i->peek_buf[0] = ch;
1329 i->peek_buf[1] = '\0';
1331 debug_printf("file_peek: got a '%c' %d\n", *i->p, *i->p);
1335 static void setup_file_in_str(struct in_str *i, FILE *f)
1337 i->peek = file_peek;
1339 #if ENABLE_HUSH_INTERACTIVE
1341 i->promptmode = 0; /* PS1 */
1347 static void setup_string_in_str(struct in_str *i, const char *s)
1349 i->peek = static_peek;
1350 i->get = static_get;
1351 #if ENABLE_HUSH_INTERACTIVE
1353 i->promptmode = 0; /* PS1 */
1363 #define B_CHUNK (32 * sizeof(char*))
1365 static void o_reset(o_string *o)
1373 static void o_free(o_string *o)
1376 memset(o, 0, sizeof(*o));
1379 static void o_grow_by(o_string *o, int len)
1381 if (o->length + len > o->maxlen) {
1382 o->maxlen += (2*len > B_CHUNK ? 2*len : B_CHUNK);
1383 o->data = xrealloc(o->data, 1 + o->maxlen);
1387 static void o_addchr(o_string *o, int ch)
1389 debug_printf("o_addchr: '%c' o->length=%d o=%p\n", ch, o->length, o);
1391 o->data[o->length] = ch;
1393 o->data[o->length] = '\0';
1396 static void o_addstr(o_string *o, const char *str, int len)
1399 memcpy(&o->data[o->length], str, len);
1401 o->data[o->length] = '\0';
1404 static void o_addstrauto(o_string *o, const char *str)
1406 o_addstr(o, str, strlen(str) + 1);
1409 static void o_addstr_duplicate_backslash(o_string *o, const char *str, int len)
1414 && (*str != '*' && *str != '?' && *str != '[')
1422 /* My analysis of quoting semantics tells me that state information
1423 * is associated with a destination, not a source.
1425 static void o_addqchr(o_string *o, int ch)
1428 char *found = strchr("*?[\\", ch);
1433 o->data[o->length] = '\\';
1436 o->data[o->length] = ch;
1438 o->data[o->length] = '\0';
1441 static void o_addQchr(o_string *o, int ch)
1444 if (o->o_quote && strchr("*?[\\", ch)) {
1446 o->data[o->length] = '\\';
1450 o->data[o->length] = ch;
1452 o->data[o->length] = '\0';
1455 static void o_addQstr(o_string *o, const char *str, int len)
1458 o_addstr(o, str, len);
1464 int ordinary_cnt = strcspn(str, "*?[\\");
1465 if (ordinary_cnt > len) /* paranoia */
1467 o_addstr(o, str, ordinary_cnt);
1468 if (ordinary_cnt == len)
1470 str += ordinary_cnt;
1471 len -= ordinary_cnt + 1; /* we are processing + 1 char below */
1475 if (ch) { /* it is necessarily one of "*?[\\" */
1477 o->data[o->length] = '\\';
1481 o->data[o->length] = ch;
1483 o->data[o->length] = '\0';
1487 /* A special kind of o_string for $VAR and `cmd` expansion.
1488 * It contains char* list[] at the beginning, which is grown in 16 element
1489 * increments. Actual string data starts at the next multiple of 16 * (char*).
1490 * list[i] contains an INDEX (int!) into this string data.
1491 * It means that if list[] needs to grow, data needs to be moved higher up
1492 * but list[i]'s need not be modified.
1493 * NB: remembering how many list[i]'s you have there is crucial.
1494 * o_finalize_list() operation post-processes this structure - calculates
1495 * and stores actual char* ptrs in list[]. Oh, it NULL terminates it as well.
1497 #if DEBUG_EXPAND || DEBUG_GLOB
1498 static void debug_print_list(const char *prefix, o_string *o, int n)
1500 char **list = (char**)o->data;
1501 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1503 fprintf(stderr, "%s: list:%p n:%d string_start:%d length:%d maxlen:%d\n",
1504 prefix, list, n, string_start, o->length, o->maxlen);
1506 fprintf(stderr, " list[%d]=%d '%s' %p\n", i, (int)list[i],
1507 o->data + (int)list[i] + string_start,
1508 o->data + (int)list[i] + string_start);
1512 const char *p = o->data + (int)list[n - 1] + string_start;
1513 fprintf(stderr, " total_sz:%ld\n", (long)((p + strlen(p) + 1) - o->data));
1517 #define debug_print_list(prefix, o, n) ((void)0)
1520 /* n = o_save_ptr_helper(str, n) "starts new string" by storing an index value
1521 * in list[n] so that it points past last stored byte so far.
1522 * It returns n+1. */
1523 static int o_save_ptr_helper(o_string *o, int n)
1525 char **list = (char**)o->data;
1529 if (!o->has_empty_slot) {
1530 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1531 string_len = o->length - string_start;
1532 if (!(n & 0xf)) { /* 0, 0x10, 0x20...? */
1533 debug_printf_list("list[%d]=%d string_start=%d (growing)\n", n, string_len, string_start);
1534 /* list[n] points to string_start, make space for 16 more pointers */
1535 o->maxlen += 0x10 * sizeof(list[0]);
1536 o->data = xrealloc(o->data, o->maxlen + 1);
1537 list = (char**)o->data;
1538 memmove(list + n + 0x10, list + n, string_len);
1539 o->length += 0x10 * sizeof(list[0]);
1541 debug_printf_list("list[%d]=%d string_start=%d\n", n, string_len, string_start);
1543 /* We have empty slot at list[n], reuse without growth */
1544 string_start = ((n+1 + 0xf) & ~0xf) * sizeof(list[0]); /* NB: n+1! */
1545 string_len = o->length - string_start;
1546 debug_printf_list("list[%d]=%d string_start=%d (empty slot)\n", n, string_len, string_start);
1547 o->has_empty_slot = 0;
1549 list[n] = (char*)(ptrdiff_t)string_len;
1553 /* "What was our last o_save_ptr'ed position (byte offset relative o->data)?" */
1554 static int o_get_last_ptr(o_string *o, int n)
1556 char **list = (char**)o->data;
1557 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1559 return ((int)(ptrdiff_t)list[n-1]) + string_start;
1562 /* o_glob performs globbing on last list[], saving each result
1563 * as a new list[]. */
1564 static int o_glob(o_string *o, int n)
1570 debug_printf_glob("start o_glob: n:%d o->data:%p\n", n, o->data);
1572 return o_save_ptr_helper(o, n);
1573 pattern = o->data + o_get_last_ptr(o, n);
1574 debug_printf_glob("glob pattern '%s'\n", pattern);
1575 if (!glob_needed(pattern)) {
1577 o->length = unbackslash(pattern) - o->data;
1578 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
1579 return o_save_ptr_helper(o, n);
1582 memset(&globdata, 0, sizeof(globdata));
1583 gr = glob(pattern, 0, NULL, &globdata);
1584 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
1585 if (gr == GLOB_NOSPACE)
1586 bb_error_msg_and_die("out of memory during glob");
1587 if (gr == GLOB_NOMATCH) {
1588 globfree(&globdata);
1591 if (gr != 0) { /* GLOB_ABORTED ? */
1592 //TODO: testcase for bad glob pattern behavior
1593 bb_error_msg("glob(3) error %d on '%s'", gr, pattern);
1595 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
1596 char **argv = globdata.gl_pathv;
1597 o->length = pattern - o->data; /* "forget" pattern */
1599 o_addstrauto(o, *argv);
1600 n = o_save_ptr_helper(o, n);
1606 globfree(&globdata);
1608 debug_print_list("o_glob returning", o, n);
1612 /* If o->o_glob == 1, glob the string so far remembered.
1613 * Otherwise, just finish current list[] and start new */
1614 static int o_save_ptr(o_string *o, int n)
1616 if (o->o_glob) { /* if globbing is requested */
1617 /* If o->has_empty_slot, list[n] was already globbed
1618 * (if it was requested back then when it was filled)
1619 * so don't do that again! */
1620 if (!o->has_empty_slot)
1621 return o_glob(o, n); /* o_save_ptr_helper is inside */
1623 return o_save_ptr_helper(o, n);
1626 /* "Please convert list[n] to real char* ptrs, and NULL terminate it." */
1627 static char **o_finalize_list(o_string *o, int n)
1632 n = o_save_ptr(o, n); /* force growth for list[n] if necessary */
1634 debug_print_list("finalized", o, n);
1635 debug_printf_expand("finalized n:%d\n", n);
1636 list = (char**)o->data;
1637 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1641 list[n] = o->data + (int)(ptrdiff_t)list[n] + string_start;
1647 /* Expansion can recurse */
1648 #if ENABLE_HUSH_TICK
1649 static int process_command_subs(o_string *dest,
1650 struct in_str *input, const char *subst_end);
1652 static char *expand_string_to_string(const char *str);
1653 static int parse_stream_dquoted(o_string *dest, struct in_str *input, int dquote_end);
1655 /* expand_strvec_to_strvec() takes a list of strings, expands
1656 * all variable references within and returns a pointer to
1657 * a list of expanded strings, possibly with larger number
1658 * of strings. (Think VAR="a b"; echo $VAR).
1659 * This new list is allocated as a single malloc block.
1660 * NULL-terminated list of char* pointers is at the beginning of it,
1661 * followed by strings themself.
1662 * Caller can deallocate entire list by single free(list). */
1664 /* Store given string, finalizing the word and starting new one whenever
1665 * we encounter IFS char(s). This is used for expanding variable values.
1666 * End-of-string does NOT finalize word: think about 'echo -$VAR-' */
1667 static int expand_on_ifs(o_string *output, int n, const char *str)
1670 int word_len = strcspn(str, G.ifs);
1672 if (output->o_quote || !output->o_glob)
1673 o_addQstr(output, str, word_len);
1674 else /* protect backslashes against globbing up :) */
1675 o_addstr_duplicate_backslash(output, str, word_len);
1678 if (!*str) /* EOL - do not finalize word */
1680 o_addchr(output, '\0');
1681 debug_print_list("expand_on_ifs", output, n);
1682 n = o_save_ptr(output, n);
1683 str += strspn(str, G.ifs); /* skip ifs chars */
1685 debug_print_list("expand_on_ifs[1]", output, n);
1689 /* Expand all variable references in given string, adding words to list[]
1690 * at n, n+1,... positions. Return updated n (so that list[n] is next one
1691 * to be filled). This routine is extremely tricky: has to deal with
1692 * variables/parameters with whitespace, $* and $@, and constructs like
1693 * 'echo -$*-'. If you play here, you must run testsuite afterwards! */
1694 static int expand_vars_to_list(o_string *output, int n, char *arg, char or_mask)
1696 /* or_mask is either 0 (normal case) or 0x80
1697 * (expansion of right-hand side of assignment == 1-element expand.
1698 * It will also do no globbing, and thus we must not backslash-quote!) */
1700 char first_ch, ored_ch;
1707 debug_printf_expand("expand_vars_to_list: arg '%s'\n", arg);
1708 debug_print_list("expand_vars_to_list", output, n);
1709 n = o_save_ptr(output, n);
1710 debug_print_list("expand_vars_to_list[0]", output, n);
1712 while ((p = strchr(arg, SPECIAL_VAR_SYMBOL)) != NULL) {
1713 #if ENABLE_HUSH_TICK
1714 o_string subst_result = NULL_O_STRING;
1716 #if ENABLE_SH_MATH_SUPPORT
1717 char arith_buf[sizeof(arith_t)*3 + 2];
1719 o_addstr(output, arg, p - arg);
1720 debug_print_list("expand_vars_to_list[1]", output, n);
1722 p = strchr(p, SPECIAL_VAR_SYMBOL);
1724 first_ch = arg[0] | or_mask; /* forced to "quoted" if or_mask = 0x80 */
1725 /* "$@" is special. Even if quoted, it can still
1726 * expand to nothing (not even an empty string) */
1727 if ((first_ch & 0x7f) != '@')
1728 ored_ch |= first_ch;
1731 switch (first_ch & 0x7f) {
1732 /* Highest bit in first_ch indicates that var is double-quoted */
1734 val = utoa(G.root_pid);
1736 case '!': /* bg pid */
1737 val = G.last_bg_pid ? utoa(G.last_bg_pid) : (char*)"";
1739 case '?': /* exitcode */
1740 val = utoa(G.last_return_code);
1742 case '#': /* argc */
1743 if (arg[1] != SPECIAL_VAR_SYMBOL)
1744 /* actually, it's a ${#var} */
1746 val = utoa(G.global_argc ? G.global_argc-1 : 0);
1751 if (!G.global_argv[i])
1753 ored_ch |= first_ch; /* do it for "$@" _now_, when we know it's not empty */
1754 if (!(first_ch & 0x80)) { /* unquoted $* or $@ */
1755 smallint sv = output->o_quote;
1756 /* unquoted var's contents should be globbed, so don't quote */
1757 output->o_quote = 0;
1758 while (G.global_argv[i]) {
1759 n = expand_on_ifs(output, n, G.global_argv[i]);
1760 debug_printf_expand("expand_vars_to_list: argv %d (last %d)\n", i, G.global_argc - 1);
1761 if (G.global_argv[i++][0] && G.global_argv[i]) {
1762 /* this argv[] is not empty and not last:
1763 * put terminating NUL, start new word */
1764 o_addchr(output, '\0');
1765 debug_print_list("expand_vars_to_list[2]", output, n);
1766 n = o_save_ptr(output, n);
1767 debug_print_list("expand_vars_to_list[3]", output, n);
1770 output->o_quote = sv;
1772 /* If or_mask is nonzero, we handle assignment 'a=....$@.....'
1773 * and in this case should treat it like '$*' - see 'else...' below */
1774 if (first_ch == ('@'|0x80) && !or_mask) { /* quoted $@ */
1776 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
1777 if (++i >= G.global_argc)
1779 o_addchr(output, '\0');
1780 debug_print_list("expand_vars_to_list[4]", output, n);
1781 n = o_save_ptr(output, n);
1783 } else { /* quoted $*: add as one word */
1785 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
1786 if (!G.global_argv[++i])
1789 o_addchr(output, G.ifs[0]);
1793 case SPECIAL_VAR_SYMBOL: /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_SYMBOL> */
1794 /* "Empty variable", used to make "" etc to not disappear */
1798 #if ENABLE_HUSH_TICK
1799 case '`': { /* <SPECIAL_VAR_SYMBOL>`cmd<SPECIAL_VAR_SYMBOL> */
1800 struct in_str input;
1803 //TODO: can we just stuff it into "output" directly?
1804 debug_printf_subst("SUBST '%s' first_ch %x\n", arg, first_ch);
1805 setup_string_in_str(&input, arg);
1806 process_command_subs(&subst_result, &input, NULL);
1807 debug_printf_subst("SUBST RES '%s'\n", subst_result.data);
1808 val = subst_result.data;
1812 #if ENABLE_SH_MATH_SUPPORT
1813 case '+': { /* <SPECIAL_VAR_SYMBOL>+cmd<SPECIAL_VAR_SYMBOL> */
1814 arith_eval_hooks_t hooks;
1819 arg++; /* skip '+' */
1820 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
1821 debug_printf_subst("ARITH '%s' first_ch %x\n", arg, first_ch);
1823 /* Optional: skip expansion if expr is simple ("a + 3", "i++" etc) */
1826 unsigned char c = *exp_str++;
1833 if (strchr(" \t+-*/%_", c) != NULL)
1835 c |= 0x20; /* tolower */
1836 if (c >= 'a' && c <= 'z')
1840 /* We need to expand. Example: "echo $(($a + 1)) $((1 + $((2)) ))" */
1842 struct in_str input;
1843 o_string dest = NULL_O_STRING;
1845 setup_string_in_str(&input, arg);
1846 parse_stream_dquoted(&dest, &input, EOF);
1847 //bb_error_msg("'%s' -> '%s'", arg, dest.data);
1848 exp_str = expand_string_to_string(dest.data);
1849 //bb_error_msg("'%s' -> '%s'", dest.data, exp_str);
1853 hooks.lookupvar = lookup_param;
1854 hooks.setvar = arith_set_local_var;
1855 hooks.endofname = endofname;
1856 res = arith(exp_str ? exp_str : arg, &errcode, &hooks);
1861 case -3: maybe_die("arith", "exponent less than 0"); break;
1862 case -2: maybe_die("arith", "divide by zero"); break;
1863 case -5: maybe_die("arith", "expression recursion loop detected"); break;
1864 default: maybe_die("arith", "syntax error"); break;
1867 debug_printf_subst("ARITH RES '"arith_t_fmt"'\n", res);
1868 sprintf(arith_buf, arith_t_fmt, res);
1873 default: /* <SPECIAL_VAR_SYMBOL>varname<SPECIAL_VAR_SYMBOL> */
1875 bool exp_len = false, exp_null = false;
1876 char *var = arg, exp_save, exp_op, *exp_word;
1879 arg[0] = first_ch & 0x7f;
1881 /* prepare for expansions */
1882 if (var[0] == '#') {
1883 /* handle length expansion ${#var} */
1887 /* maybe handle parameter expansion */
1888 exp_off = strcspn(var, ":-=+?");
1892 exp_save = var[exp_off];
1893 exp_null = exp_save == ':';
1894 exp_word = var + exp_off;
1895 if (exp_null) ++exp_word;
1896 exp_op = *exp_word++;
1897 var[exp_off] = '\0';
1901 /* lookup the variable in question */
1902 if (isdigit(var[0])) {
1903 /* handle_dollar() should have vetted var for us */
1905 if (i < G.global_argc)
1906 val = G.global_argv[i];
1907 /* else val remains NULL: $N with too big N */
1909 val = lookup_param(var);
1911 /* handle any expansions */
1913 debug_printf_expand("expand: length of '%s' = ", val);
1914 val = utoa(val ? strlen(val) : 0);
1915 debug_printf_expand("%s\n", val);
1916 } else if (exp_off) {
1917 /* we need to do an expansion */
1918 int exp_test = (!val || (exp_null && !val[0]));
1920 exp_test = !exp_test;
1921 debug_printf_expand("expand: op:%c (null:%s) test:%i\n", exp_op,
1922 exp_null ? "true" : "false", exp_test);
1925 maybe_die(var, *exp_word ? exp_word : "parameter null or not set");
1929 if (exp_op == '=') {
1930 if (isdigit(var[0]) || var[0] == '#') {
1931 maybe_die(var, "special vars cannot assign in this way");
1934 char *new_var = xmalloc(strlen(var) + strlen(val) + 2);
1935 sprintf(new_var, "%s=%s", var, val);
1936 set_local_var(new_var, -1);
1940 var[exp_off] = exp_save;
1945 #if ENABLE_HUSH_TICK
1948 if (!(first_ch & 0x80)) { /* unquoted $VAR */
1949 debug_printf_expand("unquoted '%s', output->o_quote:%d\n", val, output->o_quote);
1951 /* unquoted var's contents should be globbed, so don't quote */
1952 smallint sv = output->o_quote;
1953 output->o_quote = 0;
1954 n = expand_on_ifs(output, n, val);
1956 output->o_quote = sv;
1958 } else { /* quoted $VAR, val will be appended below */
1959 debug_printf_expand("quoted '%s', output->o_quote:%d\n", val, output->o_quote);
1962 } /* switch (char after <SPECIAL_VAR_SYMBOL>) */
1965 o_addQstr(output, val, strlen(val));
1967 /* Do the check to avoid writing to a const string */
1968 if (*p != SPECIAL_VAR_SYMBOL)
1969 *p = SPECIAL_VAR_SYMBOL;
1971 #if ENABLE_HUSH_TICK
1972 o_free(&subst_result);
1975 } /* end of "while (SPECIAL_VAR_SYMBOL is found) ..." */
1978 debug_print_list("expand_vars_to_list[a]", output, n);
1979 /* this part is literal, and it was already pre-quoted
1980 * if needed (much earlier), do not use o_addQstr here! */
1981 o_addstrauto(output, arg);
1982 debug_print_list("expand_vars_to_list[b]", output, n);
1983 } else if (output->length == o_get_last_ptr(output, n) /* expansion is empty */
1984 && !(ored_ch & 0x80) /* and all vars were not quoted. */
1987 /* allow to reuse list[n] later without re-growth */
1988 output->has_empty_slot = 1;
1990 o_addchr(output, '\0');
1995 static char **expand_variables(char **argv, int or_mask)
2000 o_string output = NULL_O_STRING;
2002 if (or_mask & 0x100) {
2003 output.o_quote = 1; /* protect against globbing for "$var" */
2004 /* (unquoted $var will temporarily switch it off) */
2011 n = expand_vars_to_list(&output, n, *v, (char)or_mask);
2014 debug_print_list("expand_variables", &output, n);
2016 /* output.data (malloced in one block) gets returned in "list" */
2017 list = o_finalize_list(&output, n);
2018 debug_print_strings("expand_variables[1]", list);
2022 static char **expand_strvec_to_strvec(char **argv)
2024 return expand_variables(argv, 0x100);
2027 /* Used for expansion of right hand of assignments */
2028 /* NB: should NOT do globbing! "export v=/bin/c*; env | grep ^v=" outputs
2030 static char *expand_string_to_string(const char *str)
2032 char *argv[2], **list;
2034 argv[0] = (char*)str;
2036 list = expand_variables(argv, 0x80); /* 0x80: make one-element expansion */
2038 if (!list[0] || list[1])
2039 bb_error_msg_and_die("BUG in varexp2");
2040 /* actually, just move string 2*sizeof(char*) bytes back */
2041 overlapping_strcpy((char*)list, list[0]);
2042 debug_printf_expand("string_to_string='%s'\n", (char*)list);
2046 /* Used for "eval" builtin */
2047 static char* expand_strvec_to_string(char **argv)
2051 list = expand_variables(argv, 0x80);
2052 /* Convert all NULs to spaces */
2057 if (list[n-1] + strlen(list[n-1]) + 1 != list[n])
2058 bb_error_msg_and_die("BUG in varexp3");
2059 list[n][-1] = ' '; /* TODO: or to G.ifs[0]? */
2063 overlapping_strcpy((char*)list, list[0]);
2064 debug_printf_expand("strvec_to_string='%s'\n", (char*)list);
2068 static char **expand_assignments(char **argv, int count)
2072 /* Expand assignments into one string each */
2073 for (i = 0; i < count; i++) {
2074 p = add_string_to_strings(p, expand_string_to_string(argv[i]));
2080 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
2081 * and stderr if they are redirected. */
2082 static int setup_redirects(struct command *prog, int squirrel[])
2085 struct redir_struct *redir;
2087 for (redir = prog->redirects; redir; redir = redir->next) {
2088 if (redir->dup == -1 && redir->rd_filename == NULL) {
2089 /* something went wrong in the parse. Pretend it didn't happen */
2092 if (redir->dup == -1) {
2094 mode = redir_table[redir->rd_type].mode;
2095 //TODO: check redir for names like '\\'
2096 p = expand_string_to_string(redir->rd_filename);
2097 openfd = open_or_warn(p, mode);
2100 /* this could get lost if stderr has been redirected, but
2101 bash and ash both lose it as well (though zsh doesn't!) */
2105 openfd = redir->dup;
2108 if (openfd != redir->fd) {
2109 if (squirrel && redir->fd < 3) {
2110 squirrel[redir->fd] = dup(redir->fd);
2113 //close(openfd); // close(-3) ??!
2115 dup2(openfd, redir->fd);
2116 if (redir->dup == -1)
2124 static void restore_redirects(int squirrel[])
2127 for (i = 0; i < 3; i++) {
2130 /* We simply die on error */
2137 #if !defined(DEBUG_CLEAN)
2138 #define free_pipe_list(head, indent) free_pipe_list(head)
2139 #define free_pipe(pi, indent) free_pipe(pi)
2141 static int free_pipe_list(struct pipe *head, int indent);
2143 /* return code is the exit status of the pipe */
2144 static int free_pipe(struct pipe *pi, int indent)
2147 struct command *command;
2148 struct redir_struct *r, *rnext;
2149 int a, i, ret_code = 0;
2151 if (pi->stopped_cmds > 0)
2153 debug_printf_clean("%s run pipe: (pid %d)\n", indenter(indent), getpid());
2154 for (i = 0; i < pi->num_cmds; i++) {
2155 command = &pi->cmds[i];
2156 debug_printf_clean("%s command %d:\n", indenter(indent), i);
2157 if (command->argv) {
2158 for (a = 0, p = command->argv; *p; a++, p++) {
2159 debug_printf_clean("%s argv[%d] = %s\n", indenter(indent), a, *p);
2161 free_strings(command->argv);
2162 command->argv = NULL;
2163 } else if (command->group) {
2164 debug_printf_clean("%s begin group (grp_type:%d)\n", indenter(indent), command->grp_type);
2165 ret_code = free_pipe_list(command->group, indent+3);
2166 debug_printf_clean("%s end group\n", indenter(indent));
2168 debug_printf_clean("%s (nil)\n", indenter(indent));
2170 for (r = command->redirects; r; r = rnext) {
2171 debug_printf_clean("%s redirect %d%s", indenter(indent), r->fd, redir_table[r->rd_type].descrip);
2173 /* guard against the case >$FOO, where foo is unset or blank */
2174 if (r->rd_filename) {
2175 debug_printf_clean(" %s\n", r->rd_filename);
2176 free(r->rd_filename);
2177 r->rd_filename = NULL;
2180 debug_printf_clean("&%d\n", r->dup);
2185 command->redirects = NULL;
2187 free(pi->cmds); /* children are an array, they get freed all at once */
2196 static int free_pipe_list(struct pipe *head, int indent)
2198 int rcode = 0; /* if list has no members */
2199 struct pipe *pi, *next;
2201 for (pi = head; pi; pi = next) {
2203 debug_printf_clean("%s pipe reserved mode %d\n", indenter(indent), pi->res_word);
2205 rcode = free_pipe(pi, indent);
2206 debug_printf_clean("%s pipe followup code %d\n", indenter(indent), pi->followup);
2208 /*pi->next = NULL;*/
2216 typedef struct nommu_save_t {
2222 #define pseudo_exec_argv(nommu_save, argv, assignment_cnt, argv_expanded) \
2223 pseudo_exec_argv(argv, assignment_cnt, argv_expanded)
2224 #define pseudo_exec(nommu_save, command, argv_expanded) \
2225 pseudo_exec(command, argv_expanded)
2228 /* Called after [v]fork() in run_pipe(), or from builtin_exec().
2230 * XXX no exit() here. If you don't exec, use _exit instead.
2231 * The at_exit handlers apparently confuse the calling process,
2232 * in particular stdin handling. Not sure why? -- because of vfork! (vda) */
2233 static void pseudo_exec_argv(nommu_save_t *nommu_save, char **argv, int assignment_cnt, char **argv_expanded) NORETURN;
2234 static void pseudo_exec_argv(nommu_save_t *nommu_save, char **argv, int assignment_cnt, char **argv_expanded)
2238 const struct built_in_command *x;
2240 /* If a variable is assigned in a forest, and nobody listens,
2241 * was it ever really set?
2243 if (!argv[assignment_cnt])
2244 _exit(EXIT_SUCCESS);
2246 new_env = expand_assignments(argv, assignment_cnt);
2248 putenv_all(new_env);
2249 free(new_env); /* optional */
2251 nommu_save->new_env = new_env;
2252 nommu_save->old_env = putenv_all_and_save_old(new_env);
2254 if (argv_expanded) {
2255 argv = argv_expanded;
2257 argv = expand_strvec_to_strvec(argv);
2259 nommu_save->argv = argv;
2264 * Check if the command matches any of the builtins.
2265 * Depending on context, this might be redundant. But it's
2266 * easier to waste a few CPU cycles than it is to figure out
2267 * if this is one of those cases.
2269 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
2270 if (strcmp(argv[0], x->cmd) == 0) {
2271 debug_printf_exec("running builtin '%s'\n", argv[0]);
2272 rcode = x->function(argv);
2278 /* Check if the command matches any busybox applets */
2279 #if ENABLE_FEATURE_SH_STANDALONE
2280 if (strchr(argv[0], '/') == NULL) {
2281 int a = find_applet_by_name(argv[0]);
2283 if (APPLET_IS_NOEXEC(a)) {
2284 debug_printf_exec("running applet '%s'\n", argv[0]);
2285 // is it ok that run_applet_no_and_exit() does exit(), not _exit()?
2286 run_applet_no_and_exit(a, argv);
2288 /* re-exec ourselves with the new arguments */
2289 debug_printf_exec("re-execing applet '%s'\n", argv[0]);
2290 execvp(bb_busybox_exec_path, argv);
2291 /* If they called chroot or otherwise made the binary no longer
2292 * executable, fall through */
2297 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
2299 debug_printf_exec("execing '%s'\n", argv[0]);
2300 execvp(argv[0], argv);
2301 bb_perror_msg("can't exec '%s'", argv[0]);
2302 _exit(EXIT_FAILURE);
2305 static int run_list(struct pipe *pi);
2307 /* Called after [v]fork() in run_pipe()
2309 static void pseudo_exec(nommu_save_t *nommu_save, struct command *command, char **argv_expanded) NORETURN;
2310 static void pseudo_exec(nommu_save_t *nommu_save, struct command *command, char **argv_expanded)
2313 pseudo_exec_argv(nommu_save, command->argv, command->assignment_cnt, argv_expanded);
2315 if (command->group) {
2317 bb_error_msg_and_die("nested lists are not supported on NOMMU");
2320 debug_printf_exec("pseudo_exec: run_list\n");
2321 rcode = run_list(command->group);
2322 /* OK to leak memory by not calling free_pipe_list,
2323 * since this process is about to exit */
2328 /* Can happen. See what bash does with ">foo" by itself. */
2329 debug_printf("trying to pseudo_exec null command\n");
2330 _exit(EXIT_SUCCESS);
2334 static const char *get_cmdtext(struct pipe *pi)
2340 /* This is subtle. ->cmdtext is created only on first backgrounding.
2341 * (Think "cat, <ctrl-z>, fg, <ctrl-z>, fg, <ctrl-z>...." here...)
2342 * On subsequent bg argv is trashed, but we won't use it */
2345 argv = pi->cmds[0].argv;
2346 if (!argv || !argv[0]) {
2347 pi->cmdtext = xzalloc(1);
2352 do len += strlen(*argv) + 1; while (*++argv);
2353 pi->cmdtext = p = xmalloc(len);
2354 argv = pi->cmds[0].argv;
2356 len = strlen(*argv);
2357 memcpy(p, *argv, len);
2365 static void insert_bg_job(struct pipe *pi)
2367 struct pipe *thejob;
2370 /* Linear search for the ID of the job to use */
2372 for (thejob = G.job_list; thejob; thejob = thejob->next)
2373 if (thejob->jobid >= pi->jobid)
2374 pi->jobid = thejob->jobid + 1;
2376 /* Add thejob to the list of running jobs */
2378 thejob = G.job_list = xmalloc(sizeof(*thejob));
2380 for (thejob = G.job_list; thejob->next; thejob = thejob->next)
2382 thejob->next = xmalloc(sizeof(*thejob));
2383 thejob = thejob->next;
2386 /* Physically copy the struct job */
2387 memcpy(thejob, pi, sizeof(struct pipe));
2388 thejob->cmds = xzalloc(sizeof(pi->cmds[0]) * pi->num_cmds);
2389 /* We cannot copy entire pi->cmds[] vector! Double free()s will happen */
2390 for (i = 0; i < pi->num_cmds; i++) {
2391 // TODO: do we really need to have so many fields which are just dead weight
2392 // at execution stage?
2393 thejob->cmds[i].pid = pi->cmds[i].pid;
2394 /* all other fields are not used and stay zero */
2396 thejob->next = NULL;
2397 thejob->cmdtext = xstrdup(get_cmdtext(pi));
2399 /* We don't wait for background thejobs to return -- append it
2400 to the list of backgrounded thejobs and leave it alone */
2401 if (G.interactive_fd)
2402 printf("[%d] %d %s\n", thejob->jobid, thejob->cmds[0].pid, thejob->cmdtext);
2403 G.last_bg_pid = thejob->cmds[0].pid;
2404 G.last_jobid = thejob->jobid;
2407 static void remove_bg_job(struct pipe *pi)
2409 struct pipe *prev_pipe;
2411 if (pi == G.job_list) {
2412 G.job_list = pi->next;
2414 prev_pipe = G.job_list;
2415 while (prev_pipe->next != pi)
2416 prev_pipe = prev_pipe->next;
2417 prev_pipe->next = pi->next;
2420 G.last_jobid = G.job_list->jobid;
2425 /* Remove a backgrounded job */
2426 static void delete_finished_bg_job(struct pipe *pi)
2429 pi->stopped_cmds = 0;
2435 /* Check to see if any processes have exited -- if they
2436 * have, figure out why and see if a job has completed */
2437 static int checkjobs(struct pipe* fg_pipe)
2447 debug_printf_jobs("checkjobs %p\n", fg_pipe);
2450 // if (G.handled_SIGCHLD == G.count_SIGCHLD)
2451 // /* avoid doing syscall, nothing there anyway */
2454 attributes = WUNTRACED;
2455 if (fg_pipe == NULL)
2456 attributes |= WNOHANG;
2458 /* Do we do this right?
2459 * bash-3.00# sleep 20 | false
2461 * [3]+ Stopped sleep 20 | false
2462 * bash-3.00# echo $?
2463 * 1 <========== bg pipe is not fully done, but exitcode is already known!
2466 //FIXME: non-interactive bash does not continue even if all processes in fg pipe
2467 //are stopped. Testcase: "cat | cat" in a script (not on command line)
2468 // + killall -STOP cat
2475 // i = G.count_SIGCHLD;
2476 childpid = waitpid(-1, &status, attributes);
2477 if (childpid <= 0) {
2478 if (childpid && errno != ECHILD)
2479 bb_perror_msg("waitpid");
2480 // else /* Until next SIGCHLD, waitpid's are useless */
2481 // G.handled_SIGCHLD = i;
2484 dead = WIFEXITED(status) || WIFSIGNALED(status);
2487 if (WIFSTOPPED(status))
2488 debug_printf_jobs("pid %d stopped by sig %d (exitcode %d)\n",
2489 childpid, WSTOPSIG(status), WEXITSTATUS(status));
2490 if (WIFSIGNALED(status))
2491 debug_printf_jobs("pid %d killed by sig %d (exitcode %d)\n",
2492 childpid, WTERMSIG(status), WEXITSTATUS(status));
2493 if (WIFEXITED(status))
2494 debug_printf_jobs("pid %d exited, exitcode %d\n",
2495 childpid, WEXITSTATUS(status));
2497 /* Were we asked to wait for fg pipe? */
2499 for (i = 0; i < fg_pipe->num_cmds; i++) {
2500 debug_printf_jobs("check pid %d\n", fg_pipe->cmds[i].pid);
2501 if (fg_pipe->cmds[i].pid != childpid)
2503 /* printf("process %d exit %d\n", i, WEXITSTATUS(status)); */
2505 fg_pipe->cmds[i].pid = 0;
2506 fg_pipe->alive_cmds--;
2507 if (i == fg_pipe->num_cmds - 1) {
2508 /* last process gives overall exitstatus */
2509 rcode = WEXITSTATUS(status);
2510 IF_HAS_KEYWORDS(if (fg_pipe->pi_inverted) rcode = !rcode;)
2513 fg_pipe->cmds[i].is_stopped = 1;
2514 fg_pipe->stopped_cmds++;
2516 debug_printf_jobs("fg_pipe: alive_cmds %d stopped_cmds %d\n",
2517 fg_pipe->alive_cmds, fg_pipe->stopped_cmds);
2518 if (fg_pipe->alive_cmds - fg_pipe->stopped_cmds <= 0) {
2519 /* All processes in fg pipe have exited/stopped */
2521 if (fg_pipe->alive_cmds)
2522 insert_bg_job(fg_pipe);
2526 /* There are still running processes in the fg pipe */
2527 goto wait_more; /* do waitpid again */
2529 /* it wasnt fg_pipe, look for process in bg pipes */
2533 /* We asked to wait for bg or orphaned children */
2534 /* No need to remember exitcode in this case */
2535 for (pi = G.job_list; pi; pi = pi->next) {
2536 for (i = 0; i < pi->num_cmds; i++) {
2537 if (pi->cmds[i].pid == childpid)
2538 goto found_pi_and_prognum;
2541 /* Happens when shell is used as init process (init=/bin/sh) */
2542 debug_printf("checkjobs: pid %d was not in our list!\n", childpid);
2543 continue; /* do waitpid again */
2545 found_pi_and_prognum:
2548 pi->cmds[i].pid = 0;
2550 if (!pi->alive_cmds) {
2551 if (G.interactive_fd)
2552 printf(JOB_STATUS_FORMAT, pi->jobid,
2553 "Done", pi->cmdtext);
2554 delete_finished_bg_job(pi);
2558 pi->cmds[i].is_stopped = 1;
2562 } /* while (waitpid succeeds)... */
2568 static int checkjobs_and_fg_shell(struct pipe* fg_pipe)
2571 int rcode = checkjobs(fg_pipe);
2572 /* Job finished, move the shell to the foreground */
2573 p = getpgid(0); /* pgid of our process */
2574 debug_printf_jobs("fg'ing ourself: getpgid(0)=%d\n", (int)p);
2575 tcsetpgrp(G.interactive_fd, p);
2580 /* run_pipe() starts all the jobs, but doesn't wait for anything
2581 * to finish. See checkjobs().
2583 * return code is normally -1, when the caller has to wait for children
2584 * to finish to determine the exit status of the pipe. If the pipe
2585 * is a simple builtin command, however, the action is done by the
2586 * time run_pipe returns, and the exit code is provided as the
2589 * The input of the pipe is always stdin, the output is always
2590 * stdout. The outpipe[] mechanism in BusyBox-0.48 lash is bogus,
2591 * because it tries to avoid running the command substitution in
2592 * subshell, when that is in fact necessary. The subshell process
2593 * now has its stdout directed to the input of the appropriate pipe,
2594 * so this routine is noticeably simpler.
2596 * Returns -1 only if started some children. IOW: we have to
2597 * mask out retvals of builtins etc with 0xff!
2599 static int run_pipe(struct pipe *pi)
2603 int pipefds[2]; /* pipefds[0] is for reading */
2604 struct command *command;
2605 char **argv_expanded;
2607 const struct built_in_command *x;
2609 /* it is not always needed, but we aim to smaller code */
2610 int squirrel[] = { -1, -1, -1 };
2612 const int single_and_fg = (pi->num_cmds == 1 && pi->followup != PIPE_BG);
2614 debug_printf_exec("run_pipe start: single_and_fg=%d\n", single_and_fg);
2620 pi->stopped_cmds = 0;
2622 /* Check if this is a simple builtin (not part of a pipe).
2623 * Builtins within pipes have to fork anyway, and are handled in
2624 * pseudo_exec. "echo foo | read bar" doesn't work on bash, either.
2626 command = &(pi->cmds[0]);
2628 #if ENABLE_HUSH_FUNCTIONS
2629 if (single_and_fg && command->group && command->grp_type == GRP_FUNCTION) {
2630 /* We "execute" function definition */
2631 bb_error_msg("here we ought to remember function definition, and go on");
2632 return EXIT_SUCCESS;
2636 if (single_and_fg && command->group && command->grp_type == GRP_NORMAL) {
2637 debug_printf("non-subshell grouping\n");
2638 setup_redirects(command, squirrel);
2639 debug_printf_exec(": run_list\n");
2640 rcode = run_list(command->group) & 0xff;
2641 restore_redirects(squirrel);
2642 debug_printf_exec("run_pipe return %d\n", rcode);
2643 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
2647 argv = command->argv;
2648 argv_expanded = NULL;
2650 if (single_and_fg && argv != NULL) {
2651 char **new_env = NULL;
2652 char **old_env = NULL;
2654 i = command->assignment_cnt;
2655 if (i != 0 && argv[i] == NULL) {
2656 /* assignments, but no command: set local environment */
2657 for (i = 0; argv[i] != NULL; i++) {
2658 debug_printf("local environment set: %s\n", argv[i]);
2659 p = expand_string_to_string(argv[i]);
2660 set_local_var(p, 0);
2662 return EXIT_SUCCESS; /* don't worry about errors in set_local_var() yet */
2665 /* Expand the rest into (possibly) many strings each */
2666 argv_expanded = expand_strvec_to_strvec(argv + i);
2668 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
2669 if (strcmp(argv_expanded[0], x->cmd) != 0)
2671 if (x->function == builtin_exec && argv_expanded[1] == NULL) {
2672 debug_printf("exec with redirects only\n");
2673 setup_redirects(command, NULL);
2674 rcode = EXIT_SUCCESS;
2675 goto clean_up_and_ret1;
2677 debug_printf("builtin inline %s\n", argv_expanded[0]);
2678 /* XXX setup_redirects acts on file descriptors, not FILEs.
2679 * This is perfect for work that comes after exec().
2680 * Is it really safe for inline use? Experimentally,
2681 * things seem to work with glibc. */
2682 setup_redirects(command, squirrel);
2683 new_env = expand_assignments(argv, command->assignment_cnt);
2684 old_env = putenv_all_and_save_old(new_env);
2685 debug_printf_exec(": builtin '%s' '%s'...\n", x->cmd, argv_expanded[1]);
2686 rcode = x->function(argv_expanded) & 0xff;
2687 #if ENABLE_FEATURE_SH_STANDALONE
2690 restore_redirects(squirrel);
2691 free_strings_and_unsetenv(new_env, 1);
2692 putenv_all(old_env);
2693 free(old_env); /* not free_strings()! */
2695 free(argv_expanded);
2696 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
2697 debug_printf_exec("run_pipe return %d\n", rcode);
2700 #if ENABLE_FEATURE_SH_STANDALONE
2701 i = find_applet_by_name(argv_expanded[0]);
2702 if (i >= 0 && APPLET_IS_NOFORK(i)) {
2703 setup_redirects(command, squirrel);
2704 save_nofork_data(&G.nofork_save);
2705 new_env = expand_assignments(argv, command->assignment_cnt);
2706 old_env = putenv_all_and_save_old(new_env);
2707 debug_printf_exec(": run_nofork_applet '%s' '%s'...\n", argv_expanded[0], argv_expanded[1]);
2708 rcode = run_nofork_applet_prime(&G.nofork_save, i, argv_expanded);
2709 goto clean_up_and_ret;
2714 /* NB: argv_expanded may already be created, and that
2715 * might include `cmd` runs! Do not rerun it! We *must*
2716 * use argv_expanded if it's non-NULL */
2718 /* Going to fork a child per each pipe member */
2722 for (i = 0; i < pi->num_cmds; i++) {
2724 volatile nommu_save_t nommu_save;
2725 nommu_save.new_env = NULL;
2726 nommu_save.old_env = NULL;
2727 nommu_save.argv = NULL;
2729 command = &(pi->cmds[i]);
2730 if (command->argv) {
2731 debug_printf_exec(": pipe member '%s' '%s'...\n", command->argv[0], command->argv[1]);
2733 debug_printf_exec(": pipe member with no argv\n");
2735 /* pipes are inserted between pairs of commands */
2738 if ((i + 1) < pi->num_cmds)
2741 command->pid = BB_MMU ? fork() : vfork();
2742 if (!command->pid) { /* child */
2744 die_sleep = 0; /* let nofork's xfuncs die */
2746 /* Every child adds itself to new process group
2747 * with pgid == pid_of_first_child_in_pipe */
2748 if (G.run_list_level == 1 && G.interactive_fd) {
2751 if (pgrp < 0) /* true for 1st process only */
2753 if (setpgid(0, pgrp) == 0 && pi->followup != PIPE_BG) {
2754 /* We do it in *every* child, not just first,
2756 tcsetpgrp(G.interactive_fd, pgrp);
2760 xmove_fd(nextin, 0);
2761 xmove_fd(pipefds[1], 1); /* write end */
2763 close(pipefds[0]); /* read end */
2764 /* Like bash, explicit redirects override pipes,
2765 * and the pipe fd is available for dup'ing. */
2766 setup_redirects(command, NULL);
2768 /* Restore default handlers just prior to exec */
2769 /*signal(SIGCHLD, SIG_DFL); - so far we don't have any handlers */
2771 /* Stores to nommu_save list of env vars putenv'ed
2772 * (NOMMU, on MMU we don't need that) */
2773 /* cast away volatility... */
2774 pseudo_exec((nommu_save_t*) &nommu_save, command, argv_expanded);
2775 /* pseudo_exec() does not return */
2779 /* Clean up after vforked child */
2780 free(nommu_save.argv);
2781 free_strings_and_unsetenv(nommu_save.new_env, 1);
2782 putenv_all(nommu_save.old_env);
2784 free(argv_expanded);
2785 argv_expanded = NULL;
2786 if (command->pid < 0) { /* [v]fork failed */
2787 /* Clearly indicate, was it fork or vfork */
2788 bb_perror_msg(BB_MMU ? "fork" : "vfork");
2792 /* Second and next children need to know pid of first one */
2794 pi->pgrp = command->pid;
2800 if ((i + 1) < pi->num_cmds)
2801 close(pipefds[1]); /* write end */
2802 /* Pass read (output) pipe end to next iteration */
2803 nextin = pipefds[0];
2806 if (!pi->alive_cmds) {
2807 debug_printf_exec("run_pipe return 1 (all forks failed, no children)\n");
2811 debug_printf_exec("run_pipe return -1 (%u children started)\n", pi->alive_cmds);
2815 #ifndef debug_print_tree
2816 static void debug_print_tree(struct pipe *pi, int lvl)
2818 static const char *const PIPE[] = {
2824 static const char *RES[] = {
2825 [RES_NONE ] = "NONE" ,
2828 [RES_THEN ] = "THEN" ,
2829 [RES_ELIF ] = "ELIF" ,
2830 [RES_ELSE ] = "ELSE" ,
2833 #if ENABLE_HUSH_LOOPS
2834 [RES_FOR ] = "FOR" ,
2835 [RES_WHILE] = "WHILE",
2836 [RES_UNTIL] = "UNTIL",
2838 [RES_DONE ] = "DONE" ,
2840 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
2843 #if ENABLE_HUSH_CASE
2844 [RES_CASE ] = "CASE" ,
2845 [RES_MATCH] = "MATCH",
2846 [RES_CASEI] = "CASEI",
2847 [RES_ESAC ] = "ESAC" ,
2849 [RES_XXXX ] = "XXXX" ,
2850 [RES_SNTX ] = "SNTX" ,
2852 static const char *const GRPTYPE[] = {
2855 #if ENABLE_HUSH_FUNCTIONS
2864 fprintf(stderr, "%*spipe %d res_word=%s followup=%d %s\n", lvl*2, "",
2865 pin, RES[pi->res_word], pi->followup, PIPE[pi->followup]);
2867 while (prn < pi->num_cmds) {
2868 struct command *command = &pi->cmds[prn];
2869 char **argv = command->argv;
2871 fprintf(stderr, "%*s prog %d assignment_cnt:%d", lvl*2, "", prn, command->assignment_cnt);
2872 if (command->group) {
2873 fprintf(stderr, " group %s: (argv=%p)\n",
2874 GRPTYPE[command->grp_type],
2876 debug_print_tree(command->group, lvl+1);
2880 if (argv) while (*argv) {
2881 fprintf(stderr, " '%s'", *argv);
2884 fprintf(stderr, "\n");
2893 /* NB: called by pseudo_exec, and therefore must not modify any
2894 * global data until exec/_exit (we can be a child after vfork!) */
2895 static int run_list(struct pipe *pi)
2897 #if ENABLE_HUSH_CASE
2898 char *case_word = NULL;
2900 #if ENABLE_HUSH_LOOPS
2901 struct pipe *loop_top = NULL;
2902 char *for_varname = NULL;
2903 char **for_lcur = NULL;
2904 char **for_list = NULL;
2906 smallint flag_skip = 1;
2907 smalluint rcode = 0; /* probably just for compiler */
2908 #if ENABLE_HUSH_IF || ENABLE_HUSH_CASE
2909 smalluint cond_code = 0;
2911 enum { cond_code = 0, };
2913 /*enum reserved_style*/ smallint rword = RES_NONE;
2914 /*enum reserved_style*/ smallint skip_more_for_this_rword = RES_XXXX;
2916 debug_printf_exec("run_list start lvl %d\n", G.run_list_level + 1);
2918 #if ENABLE_HUSH_LOOPS
2919 /* Check syntax for "for" */
2920 for (struct pipe *cpipe = pi; cpipe; cpipe = cpipe->next) {
2921 if (cpipe->res_word != RES_FOR && cpipe->res_word != RES_IN)
2923 /* current word is FOR or IN (BOLD in comments below) */
2924 if (cpipe->next == NULL) {
2925 syntax("malformed for");
2926 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
2929 /* "FOR v; do ..." and "for v IN a b; do..." are ok */
2930 if (cpipe->next->res_word == RES_DO)
2932 /* next word is not "do". It must be "in" then ("FOR v in ...") */
2933 if (cpipe->res_word == RES_IN /* "for v IN a b; not_do..."? */
2934 || cpipe->next->res_word != RES_IN /* FOR v not_do_and_not_in..."? */
2936 syntax("malformed for");
2937 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
2943 /* Past this point, all code paths should jump to ret: label
2944 * in order to return, no direct "return" statements please.
2945 * This helps to ensure that no memory is leaked. */
2947 ////TODO: ctrl-Z handling needs re-thinking and re-testing
2950 /* Example of nested list: "while true; do { sleep 1 | exit 2; } done".
2951 * We are saving state before entering outermost list ("while...done")
2952 * so that ctrl-Z will correctly background _entire_ outermost list,
2953 * not just a part of it (like "sleep 1 | exit 2") */
2954 if (++G.run_list_level == 1 && G.interactive_fd) {
2955 if (sigsetjmp(G.toplevel_jb, 1)) {
2956 /* ctrl-Z forked and we are parent; or ctrl-C.
2957 * Sighandler has longjmped us here */
2958 signal(SIGINT, SIG_IGN);
2959 signal(SIGTSTP, SIG_IGN);
2960 /* Restore level (we can be coming from deep inside
2962 G.run_list_level = 1;
2963 #if ENABLE_FEATURE_SH_STANDALONE
2964 if (G.nofork_save.saved) { /* if save area is valid */
2965 debug_printf_jobs("exiting nofork early\n");
2966 restore_nofork_data(&G.nofork_save);
2969 //// if (G.ctrl_z_flag) {
2970 //// /* ctrl-Z has forked and stored pid of the child in pi->pid.
2971 //// * Remember this child as background job */
2972 //// insert_bg_job(pi);
2974 /* ctrl-C. We just stop doing whatever we were doing */
2977 USE_HUSH_LOOPS(loop_top = NULL;)
2978 USE_HUSH_LOOPS(G.depth_of_loop = 0;)
2982 //// /* ctrl-Z handler will store pid etc in pi */
2983 //// G.toplevel_list = pi;
2984 //// G.ctrl_z_flag = 0;
2985 ////#if ENABLE_FEATURE_SH_STANDALONE
2986 //// G.nofork_save.saved = 0; /* in case we will run a nofork later */
2988 //// signal_SA_RESTART_empty_mask(SIGTSTP, handler_ctrl_z);
2989 //// signal(SIGINT, handler_ctrl_c);
2993 /* Go through list of pipes, (maybe) executing them. */
2994 for (; pi; pi = USE_HUSH_LOOPS(rword == RES_DONE ? loop_top : ) pi->next) {
2998 IF_HAS_KEYWORDS(rword = pi->res_word;)
2999 IF_HAS_NO_KEYWORDS(rword = RES_NONE;)
3000 debug_printf_exec(": rword=%d cond_code=%d skip_more=%d\n",
3001 rword, cond_code, skip_more_for_this_rword);
3002 #if ENABLE_HUSH_LOOPS
3003 if ((rword == RES_WHILE || rword == RES_UNTIL || rword == RES_FOR)
3004 && loop_top == NULL /* avoid bumping G.depth_of_loop twice */
3006 /* start of a loop: remember where loop starts */
3011 if (rword == skip_more_for_this_rword && flag_skip) {
3012 if (pi->followup == PIPE_SEQ)
3014 /* it is "<false> && CMD" or "<true> || CMD"
3015 * and we should not execute CMD */
3019 skip_more_for_this_rword = RES_XXXX;
3022 if (rword == RES_THEN) {
3023 /* "if <false> THEN cmd": skip cmd */
3027 if (rword == RES_ELSE || rword == RES_ELIF) {
3028 /* "if <true> then ... ELSE/ELIF cmd":
3029 * skip cmd and all following ones */
3034 #if ENABLE_HUSH_LOOPS
3035 if (rword == RES_FOR) { /* && pi->num_cmds - always == 1 */
3037 /* first loop through for */
3039 static const char encoded_dollar_at[] ALIGN1 = {
3040 SPECIAL_VAR_SYMBOL, '@' | 0x80, SPECIAL_VAR_SYMBOL, '\0'
3041 }; /* encoded representation of "$@" */
3042 static const char *const encoded_dollar_at_argv[] = {
3043 encoded_dollar_at, NULL
3044 }; /* argv list with one element: "$@" */
3047 vals = (char**)encoded_dollar_at_argv;
3048 if (pi->next->res_word == RES_IN) {
3049 /* if no variable values after "in" we skip "for" */
3050 if (!pi->next->cmds[0].argv)
3052 vals = pi->next->cmds[0].argv;
3053 } /* else: "for var; do..." -> assume "$@" list */
3054 /* create list of variable values */
3055 debug_print_strings("for_list made from", vals);
3056 for_list = expand_strvec_to_strvec(vals);
3057 for_lcur = for_list;
3058 debug_print_strings("for_list", for_list);
3059 for_varname = pi->cmds[0].argv[0];
3060 pi->cmds[0].argv[0] = NULL;
3062 free(pi->cmds[0].argv[0]);
3064 /* "for" loop is over, clean up */
3068 pi->cmds[0].argv[0] = for_varname;
3071 /* insert next value from for_lcur */
3072 //TODO: does it need escaping?
3073 pi->cmds[0].argv[0] = xasprintf("%s=%s", for_varname, *for_lcur++);
3074 pi->cmds[0].assignment_cnt = 1;
3076 if (rword == RES_IN) /* "for v IN list;..." - "in" has no cmds anyway */
3078 if (rword == RES_DONE) {
3079 continue; /* "done" has no cmds too */
3082 #if ENABLE_HUSH_CASE
3083 if (rword == RES_CASE) {
3084 case_word = expand_strvec_to_string(pi->cmds->argv);
3087 if (rword == RES_MATCH) {
3090 if (!case_word) /* "case ... matched_word) ... WORD)": we executed selected branch, stop */
3092 /* all prev words didn't match, does this one match? */
3093 argv = pi->cmds->argv;
3095 char *pattern = expand_string_to_string(*argv);
3096 /* TODO: which FNM_xxx flags to use? */
3097 cond_code = (fnmatch(pattern, case_word, /*flags:*/ 0) != 0);
3099 if (cond_code == 0) { /* match! we will execute this branch */
3100 free(case_word); /* make future "word)" stop */
3108 if (rword == RES_CASEI) { /* inside of a case branch */
3110 continue; /* not matched yet, skip this pipe */
3113 /* Just pressing <enter> in shell should check for jobs.
3114 * OTOH, in non-interactive shell this is useless
3115 * and only leads to extra job checks */
3116 if (pi->num_cmds == 0) {
3117 if (G.interactive_fd)
3118 goto check_jobs_and_continue;
3122 /* After analyzing all keywords and conditions, we decided
3123 * to execute this pipe. NB: have to do checkjobs(NULL)
3124 * after run_pipe() to collect any background children,
3125 * even if list execution is to be stopped. */
3126 debug_printf_exec(": run_pipe with %d members\n", pi->num_cmds);
3129 #if ENABLE_HUSH_LOOPS
3130 G.flag_break_continue = 0;
3132 rcode = r = run_pipe(pi); /* NB: rcode is a smallint */
3134 /* we only ran a builtin: rcode is already known
3135 * and we don't need to wait for anything. */
3136 check_and_run_traps(0);
3137 #if ENABLE_HUSH_LOOPS
3138 /* was it "break" or "continue"? */
3139 if (G.flag_break_continue) {
3140 smallint fbc = G.flag_break_continue;
3141 /* we might fall into outer *loop*,
3142 * don't want to break it too */
3144 G.depth_break_continue--;
3145 if (G.depth_break_continue == 0)
3146 G.flag_break_continue = 0;
3147 /* else: e.g. "continue 2" should *break* once, *then* continue */
3148 } /* else: "while... do... { we are here (innermost list is not a loop!) };...done" */
3149 if (G.depth_break_continue != 0 || fbc == BC_BREAK)
3150 goto check_jobs_and_break;
3151 /* "continue": simulate end of loop */
3156 } else if (pi->followup == PIPE_BG) {
3157 /* what does bash do with attempts to background builtins? */
3158 /* even bash 3.2 doesn't do that well with nested bg:
3159 * try "{ { sleep 10; echo DEEP; } & echo HERE; } &".
3160 * I'm NOT treating inner &'s as jobs */
3161 check_and_run_traps(0);
3163 if (G.run_list_level == 1)
3166 rcode = 0; /* EXIT_SUCCESS */
3169 if (G.run_list_level == 1 && G.interactive_fd) {
3170 /* waits for completion, then fg's main shell */
3171 rcode = checkjobs_and_fg_shell(pi);
3172 check_and_run_traps(0);
3173 debug_printf_exec(": checkjobs_and_fg_shell returned %d\n", rcode);
3176 { /* this one just waits for completion */
3177 rcode = checkjobs(pi);
3178 check_and_run_traps(0);
3179 debug_printf_exec(": checkjobs returned %d\n", rcode);
3183 debug_printf_exec(": setting last_return_code=%d\n", rcode);
3184 G.last_return_code = rcode;
3186 /* Analyze how result affects subsequent commands */
3188 if (rword == RES_IF || rword == RES_ELIF)
3191 #if ENABLE_HUSH_LOOPS
3192 if (rword == RES_WHILE) {
3194 rcode = 0; /* "while false; do...done" - exitcode 0 */
3195 goto check_jobs_and_break;
3198 if (rword == RES_UNTIL) {
3200 check_jobs_and_break:
3206 if ((rcode == 0 && pi->followup == PIPE_OR)
3207 || (rcode != 0 && pi->followup == PIPE_AND)
3209 skip_more_for_this_rword = rword;
3212 check_jobs_and_continue:
3217 //// if (G.ctrl_z_flag) {
3218 //// /* ctrl-Z forked somewhere in the past, we are the child,
3219 //// * and now we completed running the list. Exit. */
3225 //// if (!G.run_list_level && G.interactive_fd) {
3226 //// signal(SIGTSTP, SIG_IGN);
3227 //// signal(SIGINT, SIG_IGN);
3230 debug_printf_exec("run_list lvl %d return %d\n", G.run_list_level + 1, rcode);
3231 #if ENABLE_HUSH_LOOPS
3236 #if ENABLE_HUSH_CASE
3242 /* Select which version we will use */
3243 static int run_and_free_list(struct pipe *pi)
3246 debug_printf_exec("run_and_free_list entered\n");
3248 debug_printf_exec(": run_list with %d members\n", pi->num_cmds);
3249 rcode = run_list(pi);
3251 /* free_pipe_list has the side effect of clearing memory.
3252 * In the long run that function can be merged with run_list,
3253 * but doing that now would hobble the debugging effort. */
3254 free_pipe_list(pi, /* indent: */ 0);
3255 debug_printf_exec("run_and_free_list return %d\n", rcode);
3260 /* Peek ahead in the in_str to find out if we have a "&n" construct,
3261 * as in "2>&1", that represents duplicating a file descriptor.
3262 * Return either -2 (syntax error), -1 (no &), or the number found.
3264 static int redirect_dup_num(struct in_str *input)
3266 int ch, d = 0, ok = 0;
3268 if (ch != '&') return -1;
3270 i_getch(input); /* get the & */
3274 return -3; /* "-" represents "close me" */
3276 while (isdigit(ch)) {
3277 d = d*10 + (ch-'0');
3284 bb_error_msg("ambiguous redirect");
3288 /* The src parameter allows us to peek forward to a possible &n syntax
3289 * for file descriptor duplication, e.g., "2>&1".
3290 * Return code is 0 normally, 1 if a syntax error is detected in src.
3291 * Resource errors (in xmalloc) cause the process to exit */
3292 static int setup_redirect(struct parse_context *ctx, int fd, redir_type style,
3293 struct in_str *input)
3295 struct command *command = ctx->command;
3296 struct redir_struct *redir = command->redirects;
3297 struct redir_struct *last_redir = NULL;
3299 /* Create a new redir_struct and drop it onto the end of the linked list */
3302 redir = redir->next;
3304 redir = xzalloc(sizeof(struct redir_struct));
3305 /* redir->next = NULL; */
3306 /* redir->rd_filename = NULL; */
3308 last_redir->next = redir;
3310 command->redirects = redir;
3313 redir->rd_type = style;
3314 redir->fd = (fd == -1) ? redir_table[style].default_fd : fd;
3316 debug_printf("Redirect type %d%s\n", redir->fd, redir_table[style].descrip);
3318 /* Check for a '2>&1' type redirect */
3319 redir->dup = redirect_dup_num(input);
3320 if (redir->dup == -2)
3321 return 1; /* syntax error */
3322 if (redir->dup != -1) {
3323 /* Erik had a check here that the file descriptor in question
3324 * is legit; I postpone that to "run time"
3325 * A "-" representation of "close me" shows up as a -3 here */
3326 debug_printf("Duplicating redirect '%d>&%d'\n", redir->fd, redir->dup);
3328 /* We do _not_ try to open the file that src points to,
3329 * since we need to return and let src be expanded first.
3330 * Set ctx->pending_redirect, so we know what to do at the
3331 * end of the next parsed word. */
3332 ctx->pending_redirect = redir;
3338 static struct pipe *new_pipe(void)
3341 pi = xzalloc(sizeof(struct pipe));
3342 /*pi->followup = 0; - deliberately invalid value */
3343 /*pi->res_word = RES_NONE; - RES_NONE is 0 anyway */
3347 /* Command (member of a pipe) is complete. The only possible error here
3348 * is out of memory, in which case xmalloc exits. */
3349 static int done_command(struct parse_context *ctx)
3351 /* The command is really already in the pipe structure, so
3352 * advance the pipe counter and make a new, null command. */
3353 struct pipe *pi = ctx->pipe;
3354 struct command *command = ctx->command;
3357 if (command->group == NULL
3358 && command->argv == NULL
3359 && command->redirects == NULL
3361 debug_printf_parse("done_command: skipping null cmd, num_cmds=%d\n", pi->num_cmds);
3362 return pi->num_cmds;
3365 debug_printf_parse("done_command: ++num_cmds=%d\n", pi->num_cmds);
3367 debug_printf_parse("done_command: initializing, num_cmds=%d\n", pi->num_cmds);
3370 /* Only real trickiness here is that the uncommitted
3371 * command structure is not counted in pi->num_cmds. */
3372 pi->cmds = xrealloc(pi->cmds, sizeof(*pi->cmds) * (pi->num_cmds+1));
3373 command = &pi->cmds[pi->num_cmds];
3374 memset(command, 0, sizeof(*command));
3376 ctx->command = command;
3377 /* but ctx->pipe and ctx->list_head remain unchanged */
3379 return pi->num_cmds; /* used only for 0/nonzero check */
3382 static void done_pipe(struct parse_context *ctx, pipe_style type)
3386 debug_printf_parse("done_pipe entered, followup %d\n", type);
3387 /* Close previous command */
3388 not_null = done_command(ctx);
3389 ctx->pipe->followup = type;
3390 IF_HAS_KEYWORDS(ctx->pipe->pi_inverted = ctx->ctx_inverted;)
3391 IF_HAS_KEYWORDS(ctx->ctx_inverted = 0;)
3392 IF_HAS_KEYWORDS(ctx->pipe->res_word = ctx->ctx_res_w;)
3394 /* Without this check, even just <enter> on command line generates
3395 * tree of three NOPs (!). Which is harmless but annoying.
3396 * IOW: it is safe to do it unconditionally.
3397 * RES_NONE case is for "for a in; do ..." (empty IN set)
3398 * to work, possibly other cases too. */
3399 if (not_null IF_HAS_KEYWORDS(|| ctx->ctx_res_w != RES_NONE)) {
3401 debug_printf_parse("done_pipe: adding new pipe: "
3402 "not_null:%d ctx->ctx_res_w:%d\n",
3403 not_null, ctx->ctx_res_w);
3405 ctx->pipe->next = new_p;
3407 ctx->command = NULL; /* needed! */
3408 /* RES_THEN, RES_DO etc are "sticky" -
3409 * they remain set for commands inside if/while.
3410 * This is used to control execution.
3411 * RES_FOR and RES_IN are NOT sticky (needed to support
3412 * cases where variable or value happens to match a keyword):
3414 #if ENABLE_HUSH_LOOPS
3415 if (ctx->ctx_res_w == RES_FOR
3416 || ctx->ctx_res_w == RES_IN)
3417 ctx->ctx_res_w = RES_NONE;
3419 #if ENABLE_HUSH_CASE
3420 if (ctx->ctx_res_w == RES_MATCH)
3421 ctx->ctx_res_w = RES_CASEI;
3423 /* Create the memory for command, roughly:
3424 * ctx->pipe->cmds = new struct command;
3425 * ctx->command = &ctx->pipe->cmds[0];
3429 debug_printf_parse("done_pipe return\n");
3432 static void initialize_context(struct parse_context *ctx)
3434 memset(ctx, 0, sizeof(*ctx));
3435 ctx->pipe = ctx->list_head = new_pipe();
3436 /* Create the memory for command, roughly:
3437 * ctx->pipe->cmds = new struct command;
3438 * ctx->command = &ctx->pipe->cmds[0];
3444 /* If a reserved word is found and processed, parse context is modified
3445 * and 1 is returned.
3448 struct reserved_combo {
3451 unsigned char assignment_flag;
3455 FLAG_END = (1 << RES_NONE ),
3457 FLAG_IF = (1 << RES_IF ),
3458 FLAG_THEN = (1 << RES_THEN ),
3459 FLAG_ELIF = (1 << RES_ELIF ),
3460 FLAG_ELSE = (1 << RES_ELSE ),
3461 FLAG_FI = (1 << RES_FI ),
3463 #if ENABLE_HUSH_LOOPS
3464 FLAG_FOR = (1 << RES_FOR ),
3465 FLAG_WHILE = (1 << RES_WHILE),
3466 FLAG_UNTIL = (1 << RES_UNTIL),
3467 FLAG_DO = (1 << RES_DO ),
3468 FLAG_DONE = (1 << RES_DONE ),
3469 FLAG_IN = (1 << RES_IN ),
3471 #if ENABLE_HUSH_CASE
3472 FLAG_MATCH = (1 << RES_MATCH),
3473 FLAG_ESAC = (1 << RES_ESAC ),
3475 FLAG_START = (1 << RES_XXXX ),
3478 static const struct reserved_combo* match_reserved_word(o_string *word)
3480 /* Mostly a list of accepted follow-up reserved words.
3481 * FLAG_END means we are done with the sequence, and are ready
3482 * to turn the compound list into a command.
3483 * FLAG_START means the word must start a new compound list.
3485 static const struct reserved_combo reserved_list[] = {
3487 { "!", RES_NONE, NOT_ASSIGNMENT , 0 },
3488 { "if", RES_IF, WORD_IS_KEYWORD, FLAG_THEN | FLAG_START },
3489 { "then", RES_THEN, WORD_IS_KEYWORD, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
3490 { "elif", RES_ELIF, WORD_IS_KEYWORD, FLAG_THEN },
3491 { "else", RES_ELSE, WORD_IS_KEYWORD, FLAG_FI },
3492 { "fi", RES_FI, NOT_ASSIGNMENT , FLAG_END },
3494 #if ENABLE_HUSH_LOOPS
3495 { "for", RES_FOR, NOT_ASSIGNMENT , FLAG_IN | FLAG_DO | FLAG_START },
3496 { "while", RES_WHILE, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
3497 { "until", RES_UNTIL, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
3498 { "in", RES_IN, NOT_ASSIGNMENT , FLAG_DO },
3499 { "do", RES_DO, WORD_IS_KEYWORD, FLAG_DONE },
3500 { "done", RES_DONE, NOT_ASSIGNMENT , FLAG_END },
3502 #if ENABLE_HUSH_CASE
3503 { "case", RES_CASE, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_START },
3504 { "esac", RES_ESAC, NOT_ASSIGNMENT , FLAG_END },
3507 const struct reserved_combo *r;
3509 for (r = reserved_list; r < reserved_list + ARRAY_SIZE(reserved_list); r++) {
3510 if (strcmp(word->data, r->literal) == 0)
3515 static int reserved_word(o_string *word, struct parse_context *ctx)
3517 #if ENABLE_HUSH_CASE
3518 static const struct reserved_combo reserved_match = {
3519 "", RES_MATCH, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_ESAC
3522 const struct reserved_combo *r;
3524 r = match_reserved_word(word);
3528 debug_printf("found reserved word %s, res %d\n", r->literal, r->res);
3529 #if ENABLE_HUSH_CASE
3530 if (r->res == RES_IN && ctx->ctx_res_w == RES_CASE)
3531 /* "case word IN ..." - IN part starts first match part */
3532 r = &reserved_match;
3535 if (r->flag == 0) { /* '!' */
3536 if (ctx->ctx_inverted) { /* bash doesn't accept '! ! true' */
3538 IF_HAS_KEYWORDS(ctx->ctx_res_w = RES_SNTX;)
3540 ctx->ctx_inverted = 1;
3543 if (r->flag & FLAG_START) {
3544 struct parse_context *new;
3545 debug_printf("push stack\n");
3546 new = xmalloc(sizeof(*new));
3547 *new = *ctx; /* physical copy */
3548 initialize_context(ctx);
3550 } else if (/*ctx->ctx_res_w == RES_NONE ||*/ !(ctx->old_flag & (1 << r->res))) {
3552 ctx->ctx_res_w = RES_SNTX;
3555 ctx->ctx_res_w = r->res;
3556 ctx->old_flag = r->flag;
3557 if (ctx->old_flag & FLAG_END) {
3558 struct parse_context *old;
3559 debug_printf("pop stack\n");
3560 done_pipe(ctx, PIPE_SEQ);
3562 old->command->group = ctx->list_head;
3563 old->command->grp_type = GRP_NORMAL;
3564 *ctx = *old; /* physical copy */
3567 word->o_assignment = r->assignment_flag;
3572 //TODO: many, many callers don't check error from done_word()
3574 /* Word is complete, look at it and update parsing context.
3575 * Normal return is 0. Syntax errors return 1. */
3576 static int done_word(o_string *word, struct parse_context *ctx)
3578 struct command *command = ctx->command;
3580 debug_printf_parse("done_word entered: '%s' %p\n", word->data, command);
3581 if (word->length == 0 && word->nonnull == 0) {
3582 debug_printf_parse("done_word return 0: true null, ignored\n");
3585 /* If this word wasn't an assignment, next ones definitely
3586 * can't be assignments. Even if they look like ones. */
3587 if (word->o_assignment != DEFINITELY_ASSIGNMENT
3588 && word->o_assignment != WORD_IS_KEYWORD
3590 word->o_assignment = NOT_ASSIGNMENT;
3592 if (word->o_assignment == DEFINITELY_ASSIGNMENT)
3593 command->assignment_cnt++;
3594 word->o_assignment = MAYBE_ASSIGNMENT;
3597 if (ctx->pending_redirect) {
3598 /* We do not glob in e.g. >*.tmp case. bash seems to glob here
3599 * only if run as "bash", not "sh" */
3600 ctx->pending_redirect->rd_filename = xstrdup(word->data);
3601 word->o_assignment = NOT_ASSIGNMENT;
3602 debug_printf("word stored in rd_filename: '%s'\n", word->data);
3604 /* "{ echo foo; } echo bar" - bad */
3605 /* NB: bash allows e.g. "if true; then { echo foo; } fi". TODO? */
3606 if (command->group) {
3608 debug_printf_parse("done_word return 1: syntax error, groups and arglists don't mix\n");
3612 #if ENABLE_HUSH_CASE
3613 if (ctx->ctx_dsemicolon
3614 && strcmp(word->data, "esac") != 0 /* not "... pattern) cmd;; esac" */
3616 /* already done when ctx_dsemicolon was set to 1: */
3617 /* ctx->ctx_res_w = RES_MATCH; */
3618 ctx->ctx_dsemicolon = 0;
3622 if (!command->argv /* if it's the first word... */
3623 #if ENABLE_HUSH_LOOPS
3624 && ctx->ctx_res_w != RES_FOR /* ...not after FOR or IN */
3625 && ctx->ctx_res_w != RES_IN
3628 debug_printf_parse(": checking '%s' for reserved-ness\n", word->data);
3629 if (reserved_word(word, ctx)) {
3631 debug_printf_parse("done_word return %d\n", (ctx->ctx_res_w == RES_SNTX));
3632 return (ctx->ctx_res_w == RES_SNTX);
3636 if (word->nonnull /* word had "xx" or 'xx' at least as part of it. */
3637 /* optimization: and if it's ("" or '') or ($v... or `cmd`...): */
3638 && (word->data[0] == '\0' || word->data[0] == SPECIAL_VAR_SYMBOL)
3639 /* (otherwise it's known to be not empty and is already safe) */
3641 /* exclude "$@" - it can expand to no word despite "" */
3642 char *p = word->data;
3643 while (p[0] == SPECIAL_VAR_SYMBOL
3644 && (p[1] & 0x7f) == '@'
3645 && p[2] == SPECIAL_VAR_SYMBOL
3649 if (p == word->data || p[0] != '\0') {
3650 /* saw no "$@", or not only "$@" but some
3651 * real text is there too */
3652 /* insert "empty variable" reference, this makes
3653 * e.g. "", $empty"" etc to not disappear */
3654 o_addchr(word, SPECIAL_VAR_SYMBOL);
3655 o_addchr(word, SPECIAL_VAR_SYMBOL);
3658 command->argv = add_string_to_strings(command->argv, xstrdup(word->data));
3659 debug_print_strings("word appended to argv", command->argv);
3663 ctx->pending_redirect = NULL;
3665 #if ENABLE_HUSH_LOOPS
3666 /* Force FOR to have just one word (variable name) */
3667 /* NB: basically, this makes hush see "for v in ..." syntax as if
3668 * as it is "for v; in ...". FOR and IN become two pipe structs
3670 if (ctx->ctx_res_w == RES_FOR) {
3671 //TODO: check that command->argv[0] is a valid variable name!
3672 done_pipe(ctx, PIPE_SEQ);
3675 #if ENABLE_HUSH_CASE
3676 /* Force CASE to have just one word */
3677 if (ctx->ctx_res_w == RES_CASE) {
3678 done_pipe(ctx, PIPE_SEQ);
3681 debug_printf_parse("done_word return 0\n");
3685 /* If a redirect is immediately preceded by a number, that number is
3686 * supposed to tell which file descriptor to redirect. This routine
3687 * looks for such preceding numbers. In an ideal world this routine
3688 * needs to handle all the following classes of redirects...
3689 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
3690 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
3691 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
3692 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
3693 * A -1 output from this program means no valid number was found, so the
3694 * caller should use the appropriate default for this redirection.
3696 static int redirect_opt_num(o_string *o)
3702 for (num = 0; num < o->length; num++) {
3703 if (!isdigit(o->data[num])) {
3707 num = atoi(o->data);
3712 static int parse_stream(o_string *dest, struct parse_context *ctx,
3713 struct in_str *input0, const char *end_trigger);
3715 #if ENABLE_HUSH_TICK
3716 static FILE *generate_stream_from_list(struct pipe *head)
3719 int pid, channel[2];
3722 /* *** NOMMU WARNING *** */
3723 /* By using vfork here, we suspend parent till child exits or execs.
3724 * If child will not do it before it fills the pipe, it can block forever
3725 * in write(STDOUT_FILENO), and parent (shell) will be also stuck.
3727 * yes "0123456789012345678901234567890" | dd bs=32 count=64k >TESTFILE
3728 * huge=`cat TESTFILE` # will block here forever
3731 pid = BB_MMU ? fork() : vfork();
3733 bb_perror_msg_and_die(BB_MMU ? "fork" : "vfork");
3734 if (pid == 0) { /* child */
3735 if (ENABLE_HUSH_JOB)
3736 die_sleep = 0; /* let nofork's xfuncs die */
3737 close(channel[0]); /* NB: close _first_, then move fd! */
3738 xmove_fd(channel[1], 1);
3739 /* Prevent it from trying to handle ctrl-z etc */
3741 G.run_list_level = 1;
3743 /* Process substitution is not considered to be usual
3744 * 'command execution'.
3745 * SUSv3 says ctrl-Z should be ignored, ctrl-C should not.
3747 set_jobctrl_signals_to_IGN();
3749 /* Note: freeing 'head' here would break NOMMU. */
3750 _exit(run_list(head));
3753 pf = fdopen(channel[0], "r");
3755 /* 'head' is freed by the caller */
3758 /* Return code is exit status of the process that is run. */
3759 static int process_command_subs(o_string *dest,
3760 struct in_str *input,
3761 const char *subst_end)
3763 int retcode, ch, eol_cnt;
3764 o_string result = NULL_O_STRING;
3765 struct parse_context inner;
3767 struct in_str pipe_str;
3769 initialize_context(&inner);
3771 /* Recursion to generate command */
3772 retcode = parse_stream(&result, &inner, input, subst_end);
3774 return retcode; /* syntax error or EOF */
3775 done_word(&result, &inner);
3776 done_pipe(&inner, PIPE_SEQ);
3779 p = generate_stream_from_list(inner.list_head);
3782 close_on_exec_on(fileno(p));
3783 setup_file_in_str(&pipe_str, p);
3785 /* Now send results of command back into original context */
3787 while ((ch = i_getch(&pipe_str)) != EOF) {
3793 o_addchr(dest, '\n');
3796 o_addQchr(dest, ch);
3799 debug_printf("done reading from pipe, pclose()ing\n");
3800 /* Note: we got EOF, and we just close the read end of the pipe.
3801 * We do not wait for the `cmd` child to terminate. bash and ash do.
3803 * echo `echo Hi; exec 1>&-; sleep 2`
3805 retcode = fclose(p);
3806 free_pipe_list(inner.list_head, /* indent: */ 0);
3807 debug_printf("closed FILE from child, retcode=%d\n", retcode);
3812 static int parse_group(o_string *dest, struct parse_context *ctx,
3813 struct in_str *input, int ch)
3815 /* dest contains characters seen prior to ( or {.
3816 * Typically it's empty, but for functions defs,
3817 * it contains function name (without '()'). */
3819 const char *endch = NULL;
3820 struct parse_context sub;
3821 struct command *command = ctx->command;
3823 debug_printf_parse("parse_group entered\n");
3824 #if ENABLE_HUSH_FUNCTIONS
3825 if (ch == 'F') { /* function definition? */
3826 bb_error_msg("aha '%s' is a function, parsing it...", dest->data);
3827 //command->fname = dest->data;
3828 command->grp_type = GRP_FUNCTION;
3829 //TODO: review every o_reset() location... do they handle all o_string fields correctly?
3830 memset(dest, 0, sizeof(*dest));
3833 if (command->argv /* word [word](... */
3834 || dest->length /* word(... */
3835 || dest->nonnull /* ""(... */
3838 debug_printf_parse("parse_group return 1: syntax error, groups and arglists don't mix\n");
3841 initialize_context(&sub);
3845 command->grp_type = GRP_SUBSHELL;
3847 rcode = parse_stream(dest, &sub, input, endch);
3849 done_word(dest, &sub); /* finish off the final word in the subcontext */
3850 done_pipe(&sub, PIPE_SEQ); /* and the final command there, too */
3851 command->group = sub.list_head;
3853 debug_printf_parse("parse_group return %d\n", rcode);
3855 /* command remains "open", available for possible redirects */
3858 #if ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT
3859 /* Subroutines for copying $(...) and `...` things */
3860 static void add_till_backquote(o_string *dest, struct in_str *input);
3862 static void add_till_single_quote(o_string *dest, struct in_str *input)
3865 int ch = i_getch(input);
3873 /* "...\"...`..`...." - do we need to handle "...$(..)..." too? */
3874 static void add_till_double_quote(o_string *dest, struct in_str *input)
3877 int ch = i_getch(input);
3880 if (ch == '\\') { /* \x. Copy both chars. */
3882 ch = i_getch(input);
3888 add_till_backquote(dest, input);
3892 //if (ch == '$') ...
3895 /* Process `cmd` - copy contents until "`" is seen. Complicated by
3897 * "Within the backquoted style of command substitution, backslash
3898 * shall retain its literal meaning, except when followed by: '$', '`', or '\'.
3899 * The search for the matching backquote shall be satisfied by the first
3900 * backquote found without a preceding backslash; during this search,
3901 * if a non-escaped backquote is encountered within a shell comment,
3902 * a here-document, an embedded command substitution of the $(command)
3903 * form, or a quoted string, undefined results occur. A single-quoted
3904 * or double-quoted string that begins, but does not end, within the
3905 * "`...`" sequence produces undefined results."
3907 * echo `echo '\'TEST\`echo ZZ\`BEST` \TESTZZBEST
3909 static void add_till_backquote(o_string *dest, struct in_str *input)
3912 int ch = i_getch(input);
3915 if (ch == '\\') { /* \x. Copy both chars unless it is \` */
3916 int ch2 = i_getch(input);
3917 if (ch2 != '`' && ch2 != '$' && ch2 != '\\')
3926 /* Process $(cmd) - copy contents until ")" is seen. Complicated by
3927 * quoting and nested ()s.
3928 * "With the $(command) style of command substitution, all characters
3929 * following the open parenthesis to the matching closing parenthesis
3930 * constitute the command. Any valid shell script can be used for command,
3931 * except a script consisting solely of redirections which produces
3932 * unspecified results."
3934 * echo $(echo '(TEST)' BEST) (TEST) BEST
3935 * echo $(echo 'TEST)' BEST) TEST) BEST
3936 * echo $(echo \(\(TEST\) BEST) ((TEST) BEST
3938 static void add_till_closing_paren(o_string *dest, struct in_str *input, bool dbl)
3942 int ch = i_getch(input);
3951 if (i_peek(input) == ')') {
3958 add_till_single_quote(dest, input);
3963 add_till_double_quote(dest, input);
3967 if (ch == '\\') { /* \x. Copy verbatim. Important for \(, \) */
3968 ch = i_getch(input);
3976 #endif /* ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT */
3978 /* Return code: 0 for OK, 1 for syntax error */
3979 static int handle_dollar(o_string *dest, struct in_str *input)
3982 int ch = i_peek(input); /* first character after the $ */
3983 unsigned char quote_mask = dest->o_quote ? 0x80 : 0;
3985 debug_printf_parse("handle_dollar entered: ch='%c'\n", ch);
3989 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3991 debug_printf_parse(": '%c'\n", ch);
3992 o_addchr(dest, ch | quote_mask);
3995 if (!isalnum(ch) && ch != '_')
3999 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4000 } else if (isdigit(ch)) {
4003 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4004 debug_printf_parse(": '%c'\n", ch);
4005 o_addchr(dest, ch | quote_mask);
4006 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4007 } else switch (ch) {
4009 case '!': /* last bg pid */
4010 case '?': /* last exit code */
4011 case '#': /* number of args */
4012 case '*': /* args */
4013 case '@': /* args */
4014 goto make_one_char_var;
4016 bool first_char, all_digits;
4018 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4020 /* XXX maybe someone will try to escape the '}' */
4025 ch = i_getch(input);
4031 /* ${#var}: length of var contents */
4033 else if (isdigit(ch)) {
4039 if (expansion < 2 &&
4040 ((all_digits && !isdigit(ch)) ||
4041 (!all_digits && !isalnum(ch) && ch != '_')))
4043 /* handle parameter expansions
4044 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_02
4049 case ':': /* null modifier */
4050 if (expansion == 0) {
4051 debug_printf_parse(": null modifier\n");
4057 #if 0 /* not implemented yet :( */
4058 case '#': /* remove prefix */
4059 case '%': /* remove suffix */
4060 if (expansion == 0) {
4061 debug_printf_parse(": remove suffix/prefix\n");
4068 case '-': /* default value */
4069 case '=': /* assign default */
4070 case '+': /* alternative */
4071 case '?': /* error indicate */
4072 debug_printf_parse(": parameter expansion\n");
4078 syntax("unterminated ${name}");
4079 debug_printf_parse("handle_dollar return 1: unterminated ${name}\n");
4085 debug_printf_parse(": '%c'\n", ch);
4086 o_addchr(dest, ch | quote_mask);
4090 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4096 #if ENABLE_SH_MATH_SUPPORT
4097 if (i_peek(input) == '(') {
4099 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4100 o_addchr(dest, /*quote_mask |*/ '+');
4101 add_till_closing_paren(dest, input, true);
4102 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4107 #if ENABLE_HUSH_TICK
4108 //int pos = dest->length;
4109 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4110 o_addchr(dest, quote_mask | '`');
4111 add_till_closing_paren(dest, input, false);
4112 //debug_printf_subst("SUBST RES2 '%s'\n", dest->data + pos);
4113 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4120 if (isalnum(ch)) { /* it's $_name or $_123 */
4126 /* still unhandled, but should be eventually */
4127 bb_error_msg("unhandled syntax: $%c", ch);
4131 o_addQchr(dest, '$');
4133 debug_printf_parse("handle_dollar return 0\n");
4137 static int parse_stream_dquoted(o_string *dest, struct in_str *input, int dquote_end)
4143 ch = i_getch(input);
4144 if (ch == dquote_end) { /* may be only '"' or EOF */
4146 if (dest->o_assignment == NOT_ASSIGNMENT)
4148 debug_printf_parse("parse_stream_dquoted return 0\n");
4152 syntax("unterminated \"");
4153 debug_printf_parse("parse_stream_dquoted return 1: unterminated \"\n");
4159 next = i_peek(input);
4161 debug_printf_parse(": ch=%c (%d) m=%d quote=%d\n",
4162 ch, ch, m, dest->o_quote);
4163 if (m != CHAR_SPECIAL) {
4164 o_addQchr(dest, ch);
4165 if ((dest->o_assignment == MAYBE_ASSIGNMENT
4166 || dest->o_assignment == WORD_IS_KEYWORD)
4168 && is_assignment(dest->data)
4170 dest->o_assignment = DEFINITELY_ASSIGNMENT;
4177 debug_printf_parse("parse_stream_dquoted return 1: \\<eof>\n");
4181 * "The backslash retains its special meaning [in "..."]
4182 * only when followed by one of the following characters:
4183 * $, `, ", \, or <newline>. A double quote may be quoted
4184 * within double quotes by preceding it with a backslash.
4185 * If enabled, history expansion will be performed unless
4186 * an ! appearing in double quotes is escaped using
4187 * a backslash. The backslash preceding the ! is not removed."
4189 if (strchr("$`\"\\", next) != NULL) {
4190 o_addqchr(dest, i_getch(input));
4192 o_addqchr(dest, '\\');
4197 if (handle_dollar(dest, input) != 0) {
4198 debug_printf_parse("parse_stream_dquoted return 1: handle_dollar returned non-0\n");
4203 #if ENABLE_HUSH_TICK
4205 //int pos = dest->length;
4206 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4207 o_addchr(dest, 0x80 | '`');
4208 add_till_backquote(dest, input);
4209 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4210 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
4217 /* Scan input, call done_word() whenever full IFS delimited word was seen.
4218 * Call done_pipe if '\n' was seen (and end_trigger != NULL).
4219 * Return code is 0 if end_trigger char is met,
4220 * -1 on EOF (but if end_trigger == NULL then return 0),
4221 * 1 for syntax error */
4222 static int parse_stream(o_string *dest, struct parse_context *ctx,
4223 struct in_str *input, const char *end_trigger)
4227 redir_type redir_style;
4231 /* Only double-quote state is handled in the state variable dest->o_quote.
4232 * A single-quote triggers a bypass of the main loop until its mate is
4233 * found. When recursing, quote state is passed in via dest->o_quote. */
4235 debug_printf_parse("parse_stream entered, end_trigger='%s' dest->o_assignment:%d\n", end_trigger, dest->o_assignment);
4237 is_in_dquote = dest->o_quote;
4240 if (parse_stream_dquoted(dest, input, '"'))
4241 return 1; /* propagate parse error */
4242 /* If we're here, we reached closing '"' */
4247 ch = i_getch(input);
4251 next = i_peek(input);
4254 debug_printf_parse(": ch=%c (%d) m=%d quote=%d\n",
4255 ch, ch, m, dest->o_quote);
4256 if (m == CHAR_ORDINARY) {
4257 o_addQchr(dest, ch);
4258 if ((dest->o_assignment == MAYBE_ASSIGNMENT
4259 || dest->o_assignment == WORD_IS_KEYWORD)
4261 && is_assignment(dest->data)
4263 dest->o_assignment = DEFINITELY_ASSIGNMENT;
4267 /* m is SPECIAL ($,`), IFS, or ORDINARY_IF_QUOTED (*,#)
4269 if (m == CHAR_IFS) {
4270 if (done_word(dest, ctx)) {
4271 debug_printf_parse("parse_stream return 1: done_word!=0\n");
4276 /* If we aren't performing a substitution, treat
4277 * a newline as a command separator.
4278 * [why don't we handle it exactly like ';'? --vda] */
4279 if (end_trigger && ch == '\n') {
4280 #if ENABLE_HUSH_CASE
4281 /* "case ... in <newline> word) ..." -
4282 * newlines are ignored (but ';' wouldn't be) */
4283 if (dest->length == 0 // && argv[0] == NULL
4284 && ctx->ctx_res_w == RES_MATCH
4289 done_pipe(ctx, PIPE_SEQ);
4290 dest->o_assignment = MAYBE_ASSIGNMENT;
4294 if (strchr(end_trigger, ch)) {
4295 /* Special case: (...word) makes last word terminate,
4296 * as if ';' is seen */
4298 done_word(dest, ctx);
4300 done_pipe(ctx, PIPE_SEQ);
4301 dest->o_assignment = MAYBE_ASSIGNMENT;
4304 IF_HAS_KEYWORDS(|| (ctx->ctx_res_w == RES_NONE && ctx->old_flag == 0))
4306 debug_printf_parse("parse_stream return 0: end_trigger char found\n");
4314 /* m is SPECIAL (e.g. $,`) or ORDINARY_IF_QUOTED (*,#) */
4316 if (dest->o_assignment == MAYBE_ASSIGNMENT) {
4317 /* ch is a special char and thus this word
4318 * cannot be an assignment */
4319 dest->o_assignment = NOT_ASSIGNMENT;
4324 if (dest->length == 0) {
4327 if (ch == EOF || ch == '\n')
4332 o_addQchr(dest, ch);
4338 debug_printf_parse("parse_stream return 1: \\<eof>\n");
4341 o_addchr(dest, '\\');
4342 o_addchr(dest, i_getch(input));
4345 if (handle_dollar(dest, input) != 0) {
4346 debug_printf_parse("parse_stream return 1: handle_dollar returned non-0\n");
4353 ch = i_getch(input);
4355 syntax("unterminated '");
4356 debug_printf_parse("parse_stream return 1: unterminated '\n");
4361 if (dest->o_assignment == NOT_ASSIGNMENT)
4362 o_addqchr(dest, ch);
4369 is_in_dquote ^= 1; /* invert */
4370 if (dest->o_assignment == NOT_ASSIGNMENT)
4373 #if ENABLE_HUSH_TICK
4375 //int pos = dest->length;
4376 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4377 o_addchr(dest, '`');
4378 add_till_backquote(dest, input);
4379 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4380 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
4385 redir_fd = redirect_opt_num(dest);
4386 done_word(dest, ctx);
4387 redir_style = REDIRECT_OVERWRITE;
4389 redir_style = REDIRECT_APPEND;
4393 else if (next == '(') {
4394 syntax(">(process) not supported");
4395 debug_printf_parse("parse_stream return 1: >(process) not supported\n");
4399 setup_redirect(ctx, redir_fd, redir_style, input);
4402 redir_fd = redirect_opt_num(dest);
4403 done_word(dest, ctx);
4404 redir_style = REDIRECT_INPUT;
4406 redir_style = REDIRECT_HEREIS;
4408 } else if (next == '>') {
4409 redir_style = REDIRECT_IO;
4413 else if (next == '(') {
4414 syntax("<(process) not supported");
4415 debug_printf_parse("parse_stream return 1: <(process) not supported\n");
4419 setup_redirect(ctx, redir_fd, redir_style, input);
4422 #if ENABLE_HUSH_CASE
4425 done_word(dest, ctx);
4426 done_pipe(ctx, PIPE_SEQ);
4427 #if ENABLE_HUSH_CASE
4428 /* Eat multiple semicolons, detect
4429 * whether it means something special */
4435 if (ctx->ctx_res_w == RES_CASEI) {
4436 ctx->ctx_dsemicolon = 1;
4437 ctx->ctx_res_w = RES_MATCH;
4443 /* We just finished a cmd. New one may start
4444 * with an assignment */
4445 dest->o_assignment = MAYBE_ASSIGNMENT;
4448 done_word(dest, ctx);
4451 done_pipe(ctx, PIPE_AND);
4453 done_pipe(ctx, PIPE_BG);
4457 done_word(dest, ctx);
4458 #if ENABLE_HUSH_CASE
4459 if (ctx->ctx_res_w == RES_MATCH)
4460 break; /* we are in case's "word | word)" */
4462 if (next == '|') { /* || */
4464 done_pipe(ctx, PIPE_OR);
4466 /* we could pick up a file descriptor choice here
4467 * with redirect_opt_num(), but bash doesn't do it.
4468 * "echo foo 2| cat" yields "foo 2". */
4473 #if ENABLE_HUSH_CASE
4474 /* "case... in [(]word)..." - skip '(' */
4475 if (ctx->ctx_res_w == RES_MATCH
4476 && ctx->command->argv == NULL /* not (word|(... */
4477 && dest->length == 0 /* not word(... */
4478 && dest->nonnull == 0 /* not ""(... */
4483 #if ENABLE_HUSH_FUNCTIONS
4484 if (dest->length != 0 /* not just () but word() */
4485 && dest->nonnull == 0 /* not a"b"c() */
4486 && ctx->command->argv == NULL /* it's the first word */
4487 //TODO: "func ( ) {...}" - note spaces - is valid format too in bash
4488 && i_peek(input) == ')'
4489 && !match_reserved_word(dest)
4491 bb_error_msg("seems like a function definition");
4494 //TODO: do it properly.
4495 ch = i_getch(input);
4496 } while (ch == ' ' || ch == '\n');
4498 syntax("was expecting {");
4499 debug_printf_parse("parse_stream return 1\n");
4502 ch = 'F'; /* magic value */
4506 if (parse_group(dest, ctx, input, ch) != 0) {
4507 debug_printf_parse("parse_stream return 1: parse_group returned non-0\n");
4512 #if ENABLE_HUSH_CASE
4513 if (ctx->ctx_res_w == RES_MATCH)
4517 /* proper use of this character is caught by end_trigger:
4518 * if we see {, we call parse_group(..., end_trigger='}')
4519 * and it will match } earlier (not here). */
4520 syntax("unexpected } or )");
4521 debug_printf_parse("parse_stream return 1: unexpected '}'\n");
4525 bb_error_msg_and_die("BUG: unexpected %c\n", ch);
4528 debug_printf_parse("parse_stream return %d\n", -(end_trigger != NULL));
4534 static void set_in_charmap(const char *set, int code)
4537 G.charmap[(unsigned char)*set++] = code;
4540 static void update_charmap(void)
4542 G.ifs = getenv("IFS");
4545 /* Precompute a list of 'flow through' behavior so it can be treated
4546 * quickly up front. Computation is necessary because of IFS.
4547 * Special case handling of IFS == " \t\n" is not implemented.
4548 * The charmap[] array only really needs two bits each,
4549 * and on most machines that would be faster (reduced L1 cache use).
4551 memset(G.charmap, CHAR_ORDINARY, sizeof(G.charmap));
4552 #if ENABLE_HUSH_TICK
4553 set_in_charmap("\\$\"`", CHAR_SPECIAL);
4555 set_in_charmap("\\$\"", CHAR_SPECIAL);
4557 set_in_charmap("<>;&|(){}#'", CHAR_ORDINARY_IF_QUOTED);
4558 set_in_charmap(G.ifs, CHAR_IFS); /* are ordinary if quoted */
4561 /* Most recursion does not come through here, the exception is
4562 * from builtin_source() and builtin_eval() */
4563 static int parse_and_run_stream(struct in_str *inp, int parse_flag)
4565 struct parse_context ctx;
4566 o_string temp = NULL_O_STRING;
4570 initialize_context(&ctx);
4572 #if ENABLE_HUSH_INTERACTIVE
4573 inp->promptmode = 0; /* PS1 */
4575 /* We will stop & execute after each ';' or '\n'.
4576 * Example: "sleep 9999; echo TEST" + ctrl-C:
4577 * TEST should be printed */
4578 temp.o_assignment = MAYBE_ASSIGNMENT;
4579 rcode = parse_stream(&temp, &ctx, inp, ";\n");
4581 if (rcode != 1 && ctx.old_flag != 0) {
4585 if (rcode != 1 IF_HAS_KEYWORDS(&& ctx.old_flag == 0)) {
4586 done_word(&temp, &ctx);
4587 done_pipe(&ctx, PIPE_SEQ);
4588 debug_print_tree(ctx.list_head, 0);
4589 debug_printf_exec("parse_stream_outer: run_and_free_list\n");
4590 run_and_free_list(ctx.list_head);
4592 /* We arrive here also if rcode == 1 (error in parse_stream) */
4594 if (ctx.old_flag != 0) {
4599 /*temp.nonnull = 0; - o_free does it below */
4600 /*temp.o_quote = 0; - o_free does it below */
4601 free_pipe_list(ctx.list_head, /* indent: */ 0);
4602 /* Discard all unprocessed line input, force prompt on */
4604 #if ENABLE_HUSH_INTERACTIVE
4609 /* loop on syntax errors, return on EOF: */
4610 } while (rcode != -1 && !(parse_flag & PARSEFLAG_EXIT_FROM_LOOP));
4614 static int parse_and_run_string(const char *s, int parse_flag)
4616 struct in_str input;
4617 setup_string_in_str(&input, s);
4618 return parse_and_run_stream(&input, parse_flag);
4621 static int parse_and_run_file(FILE *f)
4624 struct in_str input;
4625 setup_file_in_str(&input, f);
4626 rcode = parse_and_run_stream(&input, 0 /* parse_flag */);
4631 /* Make sure we have a controlling tty. If we get started under a job
4632 * aware app (like bash for example), make sure we are now in charge so
4633 * we don't fight over who gets the foreground */
4634 static void setup_job_control(void)
4638 shell_pgrp = getpgrp();
4640 /* If we were ran as 'hush &',
4641 * sleep until we are in the foreground. */
4642 while (tcgetpgrp(G.interactive_fd) != shell_pgrp) {
4643 /* Send TTIN to ourself (should stop us) */
4644 kill(- shell_pgrp, SIGTTIN);
4645 shell_pgrp = getpgrp();
4648 /* We _must_ restore tty pgrp on fatal signals */
4649 set_fatal_signals_to_sigexit();
4651 /* Put ourselves in our own process group. */
4652 bb_setpgrp(); /* is the same as setpgid(our_pid, our_pid); */
4653 /* Grab control of the terminal. */
4654 tcsetpgrp(G.interactive_fd, getpid());
4658 static int set_mode(const char cstate, const char mode)
4660 int state = (cstate == '-' ? 1 : 0);
4662 case 'n': G.fake_mode = state; break;
4663 case 'x': /*G.debug_mode = state;*/ break;
4664 default: return EXIT_FAILURE;
4666 return EXIT_SUCCESS;
4669 int hush_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
4670 int hush_main(int argc, char **argv)
4672 static const struct variable const_shell_ver = {
4674 .varstr = (char*)hush_version_str,
4675 .max_len = 1, /* 0 can provoke free(name) */
4683 struct variable *cur_var;
4687 G.root_pid = getpid();
4689 /* Deal with HUSH_VERSION */
4690 G.shell_ver = const_shell_ver; /* copying struct here */
4691 G.top_var = &G.shell_ver;
4692 debug_printf_env("unsetenv '%s'\n", "HUSH_VERSION");
4693 unsetenv("HUSH_VERSION"); /* in case it exists in initial env */
4694 /* Initialize our shell local variables with the values
4695 * currently living in the environment */
4696 cur_var = G.top_var;
4699 char *value = strchr(*e, '=');
4700 if (value) { /* paranoia */
4701 cur_var->next = xzalloc(sizeof(*cur_var));
4702 cur_var = cur_var->next;
4703 cur_var->varstr = *e;
4704 cur_var->max_len = strlen(*e);
4705 cur_var->flg_export = 1;
4709 debug_printf_env("putenv '%s'\n", hush_version_str);
4710 putenv((char *)hush_version_str); /* reinstate HUSH_VERSION */
4712 #if ENABLE_FEATURE_EDITING
4713 G.line_input_state = new_line_input_t(FOR_SHELL);
4715 /* XXX what should these be while sourcing /etc/profile? */
4716 G.global_argc = argc;
4717 G.global_argv = argv;
4718 /* Initialize some more globals to non-zero values */
4720 #if ENABLE_HUSH_INTERACTIVE
4721 if (ENABLE_FEATURE_EDITING)
4722 cmdedit_set_initial_prompt();
4726 if (EXIT_SUCCESS) /* otherwise is already done */
4727 G.last_return_code = EXIT_SUCCESS;
4729 if (argv[0] && argv[0][0] == '-') {
4730 debug_printf("sourcing /etc/profile\n");
4731 input = fopen_for_read("/etc/profile");
4732 if (input != NULL) {
4733 close_on_exec_on(fileno(input));
4734 parse_and_run_file(input);
4740 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/sh.html */
4741 while ((opt = getopt(argc, argv, "c:xins")) > 0) {
4744 G.global_argv = argv + optind;
4745 if (!argv[optind]) {
4746 /* -c 'script' (no params): prevent empty $0 */
4747 *--G.global_argv = argv[0];
4749 } /* else -c 'script' PAR0 PAR1: $0 is PAR0 */
4750 G.global_argc = argc - optind;
4751 opt = parse_and_run_string(optarg, 0 /* parse_flag */);
4754 /* Well, we cannot just declare interactiveness,
4755 * we have to have some stuff (ctty, etc) */
4756 /* G.interactive_fd++; */
4759 /* "-s" means "read from stdin", but this is how we always
4760 * operate, so simply do nothing here. */
4764 if (!set_mode('-', opt))
4768 fprintf(stderr, "Usage: sh [FILE]...\n"
4769 " or: sh -c command [args]...\n\n");
4777 /* A shell is interactive if the '-i' flag was given, or if all of
4778 * the following conditions are met:
4780 * no arguments remaining or the -s flag given
4781 * standard input is a terminal
4782 * standard output is a terminal
4783 * Refer to Posix.2, the description of the 'sh' utility. */
4784 if (argv[optind] == NULL && input == stdin
4785 && isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)
4787 G.saved_tty_pgrp = tcgetpgrp(STDIN_FILENO);
4788 debug_printf("saved_tty_pgrp=%d\n", G.saved_tty_pgrp);
4789 if (G.saved_tty_pgrp >= 0) {
4790 /* try to dup to high fd#, >= 255 */
4791 G.interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
4792 if (G.interactive_fd < 0) {
4793 /* try to dup to any fd */
4794 G.interactive_fd = dup(STDIN_FILENO);
4795 if (G.interactive_fd < 0)
4797 G.interactive_fd = 0;
4799 // TODO: track & disallow any attempts of user
4800 // to (inadvertently) close/redirect it
4803 init_signal_mask(); /* note: ensures SIGCHLD is not masked */
4804 debug_printf("G.interactive_fd=%d\n", G.interactive_fd);
4805 if (G.interactive_fd) {
4806 fcntl(G.interactive_fd, F_SETFD, FD_CLOEXEC);
4807 /* Looks like they want an interactive shell */
4808 setup_job_control();
4809 /* -1 is special - makes xfuncs longjmp, not exit
4810 * (we reset die_sleep = 0 whereever we [v]fork) */
4812 if (setjmp(die_jmp)) {
4813 /* xfunc has failed! die die die */
4814 hush_exit(xfunc_error_retval);
4817 #elif ENABLE_HUSH_INTERACTIVE
4818 /* no job control compiled, only prompt/line editing */
4819 if (argv[optind] == NULL && input == stdin
4820 && isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)
4822 G.interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
4823 if (G.interactive_fd < 0) {
4824 /* try to dup to any fd */
4825 G.interactive_fd = dup(STDIN_FILENO);
4826 if (G.interactive_fd < 0)
4828 G.interactive_fd = 0;
4830 if (G.interactive_fd) {
4831 fcntl(G.interactive_fd, F_SETFD, FD_CLOEXEC);
4834 init_signal_mask(); /* note: ensures SIGCHLD is not masked */
4836 /* POSIX allows shell to re-enable SIGCHLD
4837 * even if it was SIG_IGN on entry */
4838 // G.count_SIGCHLD++; /* ensure it is != G.handled_SIGCHLD */
4839 signal(SIGCHLD, SIG_DFL); // SIGCHLD_handler);
4841 #if ENABLE_HUSH_INTERACTIVE && !ENABLE_FEATURE_SH_EXTRA_QUIET
4842 if (G.interactive_fd) {
4843 printf("\n\n%s hush - the humble shell v"HUSH_VER_STR"\n", bb_banner);
4844 printf("Enter 'help' for a list of built-in commands.\n\n");
4848 if (argv[optind] == NULL) {
4849 opt = parse_and_run_file(stdin);
4851 debug_printf("\nrunning script '%s'\n", argv[optind]);
4852 G.global_argv = argv + optind;
4853 G.global_argc = argc - optind;
4854 input = xfopen_for_read(argv[optind]);
4855 fcntl(fileno(input), F_SETFD, FD_CLOEXEC);
4856 opt = parse_and_run_file(input);
4861 #if ENABLE_FEATURE_CLEAN_UP
4863 if (G.cwd != bb_msg_unknown)
4865 cur_var = G.top_var->next;
4867 struct variable *tmp = cur_var;
4868 if (!cur_var->max_len)
4869 free(cur_var->varstr);
4870 cur_var = cur_var->next;
4874 hush_exit(opt ? opt : G.last_return_code);
4879 int lash_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
4880 int lash_main(int argc, char **argv)
4882 //bb_error_msg("lash is deprecated, please use hush instead");
4883 return hush_main(argc, argv);
4891 static int builtin_trap(char **argv)
4898 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
4901 /* No args: print all trapped. This isn't 100% correct as we should
4902 * be escaping the cmd so that it can be pasted back in ...
4904 for (i = 0; i < NSIG; ++i)
4906 printf("trap -- '%s' %s\n", G.traps[i], get_signame(i));
4907 return EXIT_SUCCESS;
4912 /* if first arg is decimal: reset all specified */
4913 sig = bb_strtou(*++argv, NULL, 10);
4919 sig = get_signum(*argv++);
4920 if (sig < 0 || sig >= NSIG) {
4922 /* mimic bash message exactly */
4923 bb_perror_msg("trap: %s: invalid signal specification", argv[i]);
4928 G.traps[sig] = xstrdup(new_cmd);
4930 debug_printf("trap: setting SIG%s (%i) to '%s'",
4931 get_signame(sig), sig, G.traps[sig]);
4933 /* There is no signal for 0 (EXIT) */
4938 sigaddset(&G.blocked_set, sig);
4940 /* there was a trap handler, we are removing it
4941 * (if sig has non-DFL handling,
4942 * we don't need to do anything) */
4943 if (sig < 32 && (G.non_DFL_mask & (1 << sig)))
4945 sigdelset(&G.blocked_set, sig);
4947 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
4952 /* first arg is "-": reset all specified to default */
4953 /* first arg is "": ignore all specified */
4954 /* everything else: execute first arg upon signal */
4956 bb_error_msg("trap: invalid arguments");
4957 return EXIT_FAILURE;
4959 if (LONE_DASH(*argv))
4967 static int builtin_true(char **argv UNUSED_PARAM)
4972 static int builtin_test(char **argv)
4979 return test_main(argc, argv - argc);
4982 static int builtin_echo(char **argv)
4989 return echo_main(argc, argv - argc);
4992 static int builtin_eval(char **argv)
4994 int rcode = EXIT_SUCCESS;
4997 char *str = expand_strvec_to_string(argv + 1);
4998 parse_and_run_string(str, PARSEFLAG_EXIT_FROM_LOOP);
5000 rcode = G.last_return_code;
5005 static int builtin_cd(char **argv)
5008 if (argv[1] == NULL) {
5009 // bash does nothing (exitcode 0) if HOME is ""; if it's unset,
5010 // bash says "bash: cd: HOME not set" and does nothing (exitcode 1)
5011 newdir = getenv("HOME") ? : "/";
5014 if (chdir(newdir)) {
5015 printf("cd: %s: %s\n", newdir, strerror(errno));
5016 return EXIT_FAILURE;
5019 return EXIT_SUCCESS;
5022 static int builtin_exec(char **argv)
5024 if (argv[1] == NULL)
5025 return EXIT_SUCCESS; /* bash does this */
5030 // FIXME: if exec fails, bash does NOT exit! We do...
5031 pseudo_exec_argv(&dummy, argv + 1, 0, NULL);
5036 static int builtin_exit(char **argv)
5038 // TODO: bash does it ONLY on top-level sh exit (+interacive only?)
5039 //puts("exit"); /* bash does it */
5040 // TODO: warn if we have background jobs: "There are stopped jobs"
5041 // On second consecutive 'exit', exit anyway.
5042 if (argv[1] == NULL)
5043 hush_exit(G.last_return_code);
5044 /* mimic bash: exit 123abc == exit 255 + error msg */
5045 xfunc_error_retval = 255;
5046 /* bash: exit -2 == exit 254, no error msg */
5047 hush_exit(xatoi(argv[1]) & 0xff);
5050 static int builtin_export(char **argv)
5053 char *name = argv[1];
5057 // ash emits: export VAR='VAL'
5058 // bash: declare -x VAR="VAL"
5059 // (both also escape as needed (quotes, $, etc))
5064 return EXIT_SUCCESS;
5067 value = strchr(name, '=');
5069 /* They are exporting something without a =VALUE */
5070 struct variable *var;
5072 var = get_local_var(name);
5074 var->flg_export = 1;
5075 debug_printf_env("%s: putenv '%s'\n", __func__, var->varstr);
5076 putenv(var->varstr);
5078 /* bash does not return an error when trying to export
5079 * an undefined variable. Do likewise. */
5080 return EXIT_SUCCESS;
5083 set_local_var(xstrdup(name), 1);
5084 return EXIT_SUCCESS;
5088 /* built-in 'fg' and 'bg' handler */
5089 static int builtin_fg_bg(char **argv)
5094 if (!G.interactive_fd)
5095 return EXIT_FAILURE;
5096 /* If they gave us no args, assume they want the last backgrounded task */
5098 for (pi = G.job_list; pi; pi = pi->next) {
5099 if (pi->jobid == G.last_jobid) {
5103 bb_error_msg("%s: no current job", argv[0]);
5104 return EXIT_FAILURE;
5106 if (sscanf(argv[1], "%%%d", &jobnum) != 1) {
5107 bb_error_msg("%s: bad argument '%s'", argv[0], argv[1]);
5108 return EXIT_FAILURE;
5110 for (pi = G.job_list; pi; pi = pi->next) {
5111 if (pi->jobid == jobnum) {
5115 bb_error_msg("%s: %d: no such job", argv[0], jobnum);
5116 return EXIT_FAILURE;
5118 // TODO: bash prints a string representation
5119 // of job being foregrounded (like "sleep 1 | cat")
5120 if (*argv[0] == 'f') {
5121 /* Put the job into the foreground. */
5122 tcsetpgrp(G.interactive_fd, pi->pgrp);
5125 /* Restart the processes in the job */
5126 debug_printf_jobs("reviving %d procs, pgrp %d\n", pi->num_cmds, pi->pgrp);
5127 for (i = 0; i < pi->num_cmds; i++) {
5128 debug_printf_jobs("reviving pid %d\n", pi->cmds[i].pid);
5129 pi->cmds[i].is_stopped = 0;
5131 pi->stopped_cmds = 0;
5133 i = kill(- pi->pgrp, SIGCONT);
5135 if (errno == ESRCH) {
5136 delete_finished_bg_job(pi);
5137 return EXIT_SUCCESS;
5139 bb_perror_msg("kill (SIGCONT)");
5143 if (*argv[0] == 'f') {
5145 return checkjobs_and_fg_shell(pi);
5147 return EXIT_SUCCESS;
5151 #if ENABLE_HUSH_HELP
5152 static int builtin_help(char **argv UNUSED_PARAM)
5154 const struct built_in_command *x;
5156 printf("\nBuilt-in commands:\n");
5157 printf("-------------------\n");
5158 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
5159 printf("%s\t%s\n", x->cmd, x->descr);
5162 return EXIT_SUCCESS;
5167 static int builtin_jobs(char **argv UNUSED_PARAM)
5170 const char *status_string;
5172 for (job = G.job_list; job; job = job->next) {
5173 if (job->alive_cmds == job->stopped_cmds)
5174 status_string = "Stopped";
5176 status_string = "Running";
5178 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->cmdtext);
5180 return EXIT_SUCCESS;
5184 static int builtin_pwd(char **argv UNUSED_PARAM)
5187 return EXIT_SUCCESS;
5190 static int builtin_read(char **argv)
5193 const char *name = argv[1] ? argv[1] : "REPLY";
5195 string = xmalloc_reads(STDIN_FILENO, xasprintf("%s=", name), NULL);
5196 return set_local_var(string, 0);
5199 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set
5200 * built-in 'set' handler
5202 * set [-abCefhmnuvx] [-o option] [argument...]
5203 * set [+abCefhmnuvx] [+o option] [argument...]
5204 * set -- [argument...]
5207 * Implementations shall support the options in both their hyphen and
5208 * plus-sign forms. These options can also be specified as options to sh.
5210 * Write out all variables and their values: set
5211 * Set $1, $2, and $3 and set "$#" to 3: set c a b
5212 * Turn on the -x and -v options: set -xv
5213 * Unset all positional parameters: set --
5214 * Set $1 to the value of x, even if it begins with '-' or '+': set -- "$x"
5215 * Set the positional parameters to the expansion of x, even if x expands
5216 * with a leading '-' or '+': set -- $x
5218 * So far, we only support "set -- [argument...]" and some of the short names.
5220 static int builtin_set(char **argv)
5223 char **pp, **g_argv;
5224 char *arg = *++argv;
5228 for (e = G.top_var; e; e = e->next)
5230 return EXIT_SUCCESS;
5234 if (!strcmp(arg, "--")) {
5239 if (arg[0] == '+' || arg[0] == '-') {
5240 for (n = 1; arg[n]; ++n)
5241 if (set_mode(arg[0], arg[n]))
5247 } while ((arg = *++argv) != NULL);
5248 /* Now argv[0] is 1st argument */
5250 /* Only reset global_argv if we didn't process anything */
5252 return EXIT_SUCCESS;
5255 /* NB: G.global_argv[0] ($0) is never freed/changed */
5256 g_argv = G.global_argv;
5257 if (G.global_args_malloced) {
5263 G.global_args_malloced = 1;
5264 pp = xzalloc(sizeof(pp[0]) * 2);
5265 pp[0] = g_argv[0]; /* retain $0 */
5268 /* This realloc's G.global_argv */
5269 G.global_argv = pp = add_strings_to_strings(g_argv, argv, /*dup:*/ 1);
5276 return EXIT_SUCCESS;
5278 /* Nothing known, so abort */
5280 bb_error_msg("set: %s: invalid option", arg);
5281 return EXIT_FAILURE;
5284 static int builtin_shift(char **argv)
5290 if (n >= 0 && n < G.global_argc) {
5291 if (G.global_args_malloced) {
5294 free(G.global_argv[m++]);
5297 memmove(&G.global_argv[1], &G.global_argv[n+1],
5298 G.global_argc * sizeof(G.global_argv[0]));
5299 return EXIT_SUCCESS;
5301 return EXIT_FAILURE;
5304 static int builtin_source(char **argv)
5309 if (argv[1] == NULL)
5310 return EXIT_FAILURE;
5312 /* XXX search through $PATH is missing */
5313 input = fopen_for_read(argv[1]);
5315 bb_error_msg("can't open '%s'", argv[1]);
5316 return EXIT_FAILURE;
5318 close_on_exec_on(fileno(input));
5320 /* Now run the file */
5321 /* XXX argv and argc are broken; need to save old G.global_argv
5322 * (pointer only is OK!) on this stack frame,
5323 * set G.global_argv=argv+1, recurse, and restore. */
5324 status = parse_and_run_file(input);
5329 static int builtin_umask(char **argv)
5332 const char *arg = argv[1];
5334 new_umask = bb_strtou(arg, NULL, 8);
5336 return EXIT_FAILURE;
5338 new_umask = umask(0);
5339 printf("%.3o\n", (unsigned) new_umask);
5342 return EXIT_SUCCESS;
5345 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#unset */
5346 static int builtin_unset(char **argv)
5353 return EXIT_SUCCESS;
5356 if (argv[1][0] == '-') {
5357 switch (argv[1][1]) {
5359 case 'f': if (ENABLE_HUSH_FUNCTIONS) { var = false; break; }
5361 bb_error_msg("unset: %s: invalid option", argv[1]);
5362 return EXIT_FAILURE;
5370 if (unset_local_var(argv[i]))
5373 #if ENABLE_HUSH_FUNCTIONS
5375 unset_local_func(argv[i]);
5381 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/wait.html */
5382 static int builtin_wait(char **argv)
5384 int ret = EXIT_SUCCESS;
5387 if (*++argv == NULL) {
5388 /* Don't care about wait results */
5389 /* Note 1: must wait until there are no more children */
5390 /* Note 2: must be interruptible */
5392 * $ sleep 3 & sleep 6 & wait
5397 * $ sleep 3 & sleep 6 & wait
5401 * ^C <-- after ~4 sec from keyboard
5404 sigaddset(&G.blocked_set, SIGCHLD);
5405 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5408 if (errno == ECHILD)
5410 /* Wait for SIGCHLD or any other signal of interest */
5411 /* sigtimedwait with infinite timeout: */
5412 sig = sigwaitinfo(&G.blocked_set, NULL);
5414 sig = check_and_run_traps(sig);
5415 if (sig && sig != SIGCHLD) { /* see note 2 */
5421 sigdelset(&G.blocked_set, SIGCHLD);
5422 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5426 /* This is probably buggy wrt interruptible-ness */
5428 pid_t pid = bb_strtou(*argv, NULL, 10);
5430 /* mimic bash message */
5431 bb_error_msg("wait: '%s': not a pid or valid job spec", *argv);
5432 return EXIT_FAILURE;
5434 if (waitpid(pid, &status, 0) == pid) {
5435 if (WIFSIGNALED(status))
5436 ret = 128 + WTERMSIG(status);
5437 else if (WIFEXITED(status))
5438 ret = WEXITSTATUS(status);
5442 bb_perror_msg("wait %s", *argv);
5451 #if ENABLE_HUSH_LOOPS
5452 static int builtin_break(char **argv)
5454 if (G.depth_of_loop == 0) {
5455 bb_error_msg("%s: only meaningful in a loop", argv[0]);
5456 return EXIT_SUCCESS; /* bash compat */
5458 G.flag_break_continue++; /* BC_BREAK = 1 */
5459 G.depth_break_continue = 1;
5461 G.depth_break_continue = bb_strtou(argv[1], NULL, 10);
5462 if (errno || !G.depth_break_continue || argv[2]) {
5463 bb_error_msg("%s: bad arguments", argv[0]);
5464 G.flag_break_continue = BC_BREAK;
5465 G.depth_break_continue = UINT_MAX;
5468 if (G.depth_of_loop < G.depth_break_continue)
5469 G.depth_break_continue = G.depth_of_loop;
5470 return EXIT_SUCCESS;
5473 static int builtin_continue(char **argv)
5475 G.flag_break_continue = 1; /* BC_CONTINUE = 2 = 1+1 */
5476 return builtin_break(argv);