1 /* vi: set sw=4 ts=4: */
3 * A prototype Bourne shell grammar parser.
4 * Intended to follow the original Thompson and Ritchie
5 * "small and simple is beautiful" philosophy, which
6 * incidentally is a good match to today's BusyBox.
8 * Copyright (C) 2000,2001 Larry Doolittle <larry@doolittle.boa.org>
9 * Copyright (C) 2008,2009 Denys Vlasenko <vda.linux@googlemail.com>
11 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
14 * The parser routines proper are all original material, first
15 * written Dec 2000 and Jan 2001 by Larry Doolittle. The
16 * execution engine, the builtins, and much of the underlying
17 * support has been adapted from busybox-0.49pre's lash, which is
18 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
19 * written by Erik Andersen <andersen@codepoet.org>. That, in turn,
20 * is based in part on ladsh.c, by Michael K. Johnson and Erik W.
21 * Troan, which they placed in the public domain. I don't know
22 * how much of the Johnson/Troan code has survived the repeated
26 * o_addchr derived from similar w_addchar function in glibc-2.2.
27 * parse_redirect, redirect_opt_num, and big chunks of main
28 * and many builtins derived from contributions by Erik Andersen.
29 * Miscellaneous bugfixes from Matt Kraai.
31 * There are two big (and related) architecture differences between
32 * this parser and the lash parser. One is that this version is
33 * actually designed from the ground up to understand nearly all
34 * of the Bourne grammar. The second, consequential change is that
35 * the parser and input reader have been turned inside out. Now,
36 * the parser is in control, and asks for input as needed. The old
37 * way had the input reader in control, and it asked for parsing to
38 * take place as needed. The new way makes it much easier to properly
39 * handle the recursion implicit in the various substitutions, especially
40 * across continuation lines.
43 * grep for "TODO" and fix (some of them are easy)
44 * special variables (done: PWD, PPID, RANDOM)
47 * follow IFS rules more precisely, including update semantics
48 * builtins mandated by standards we don't support:
49 * [un]alias, command, fc, getopts, newgrp, readonly, times
50 * make complex ${var%...} constructs support optional
51 * make here documents optional
54 * redirection of stdout+stderr: &> and >&
55 * reserved words: function select
56 * advanced test: [[ ]]
57 * process substitution: <(list) and >(list)
60 * Each EXPR is an arithmetic expression (ARITHMETIC EVALUATION)
61 * If the last arg evaluates to 0, let returns 1; 0 otherwise.
62 * NB: let `echo 'a=a + 1'` - error (IOW: multi-word expansion is used)
64 * The EXPR is evaluated according to ARITHMETIC EVALUATION.
65 * This is exactly equivalent to let "EXPR".
66 * $[EXPR]: synonym for $((EXPR))
69 * In bash, export builtin is special, its arguments are assignments
70 * and therefore expansion of them should be "one-word" expansion:
71 * $ export i=`echo 'a b'` # export has one arg: "i=a b"
73 * $ ls i=`echo 'a b'` # ls has two args: "i=a" and "b"
74 * ls: cannot access i=a: No such file or directory
75 * ls: cannot access b: No such file or directory
76 * Note1: same applies to local builtin.
77 * Note2: bash 3.2.33(1) does this only if export word itself
79 * $ export i=`echo 'aaa bbb'`; echo "$i"
81 * $ "export" i=`echo 'aaa bbb'`; echo "$i"
84 #if !(defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
85 || defined(__APPLE__) \
87 # include <malloc.h> /* for malloc_trim */
90 /* #include <dmalloc.h> */
95 #include "busybox.h" /* for APPLET_IS_NOFORK/NOEXEC */
97 #include "shell_common.h"
100 #if ENABLE_HUSH_RANDOM_SUPPORT
103 # define CLEAR_RANDOM_T(rnd) ((void)0)
106 # define PIPE_BUF 4096 /* amount of buffering in a pipe */
110 //config: bool "hush"
113 //config: hush is a small shell (25k). It handles the normal flow control
114 //config: constructs such as if/then/elif/else/fi, for/in/do/done, while loops,
115 //config: case/esac. Redirections, here documents, $((arithmetic))
116 //config: and functions are supported.
118 //config: It will compile and work on no-mmu systems.
120 //config: It does not handle select, aliases, tilde expansion,
121 //config: &>file and >&file redirection of stdout+stderr.
123 //config:config HUSH_BASH_COMPAT
124 //config: bool "bash-compatible extensions"
126 //config: depends on HUSH
128 //config: Enable bash-compatible extensions.
130 //config:config HUSH_BRACE_EXPANSION
131 //config: bool "Brace expansion"
133 //config: depends on HUSH_BASH_COMPAT
135 //config: Enable {abc,def} extension.
137 //config:config HUSH_HELP
138 //config: bool "help builtin"
140 //config: depends on HUSH
142 //config: Enable help builtin in hush. Code size + ~1 kbyte.
144 //config:config HUSH_INTERACTIVE
145 //config: bool "Interactive mode"
147 //config: depends on HUSH
149 //config: Enable interactive mode (prompt and command editing).
150 //config: Without this, hush simply reads and executes commands
151 //config: from stdin just like a shell script from a file.
152 //config: No prompt, no PS1/PS2 magic shell variables.
154 //config:config HUSH_SAVEHISTORY
155 //config: bool "Save command history to .hush_history"
157 //config: depends on HUSH_INTERACTIVE && FEATURE_EDITING_SAVEHISTORY
159 //config: Enable history saving in hush.
161 //config:config HUSH_JOB
162 //config: bool "Job control"
164 //config: depends on HUSH_INTERACTIVE
166 //config: Enable job control: Ctrl-Z backgrounds, Ctrl-C interrupts current
167 //config: command (not entire shell), fg/bg builtins work. Without this option,
168 //config: "cmd &" still works by simply spawning a process and immediately
169 //config: prompting for next command (or executing next command in a script),
170 //config: but no separate process group is formed.
172 //config:config HUSH_TICK
173 //config: bool "Process substitution"
175 //config: depends on HUSH
177 //config: Enable process substitution `command` and $(command) in hush.
179 //config:config HUSH_IF
180 //config: bool "Support if/then/elif/else/fi"
182 //config: depends on HUSH
184 //config: Enable if/then/elif/else/fi in hush.
186 //config:config HUSH_LOOPS
187 //config: bool "Support for, while and until loops"
189 //config: depends on HUSH
191 //config: Enable for, while and until loops in hush.
193 //config:config HUSH_CASE
194 //config: bool "Support case ... esac statement"
196 //config: depends on HUSH
198 //config: Enable case ... esac statement in hush. +400 bytes.
200 //config:config HUSH_FUNCTIONS
201 //config: bool "Support funcname() { commands; } syntax"
203 //config: depends on HUSH
205 //config: Enable support for shell functions in hush. +800 bytes.
207 //config:config HUSH_LOCAL
208 //config: bool "Support local builtin"
210 //config: depends on HUSH_FUNCTIONS
212 //config: Enable support for local variables in functions.
214 //config:config HUSH_RANDOM_SUPPORT
215 //config: bool "Pseudorandom generator and $RANDOM variable"
217 //config: depends on HUSH
219 //config: Enable pseudorandom generator and dynamic variable "$RANDOM".
220 //config: Each read of "$RANDOM" will generate a new pseudorandom value.
222 //config:config HUSH_EXPORT_N
223 //config: bool "Support 'export -n' option"
225 //config: depends on HUSH
227 //config: export -n unexports variables. It is a bash extension.
229 //config:config HUSH_MODE_X
230 //config: bool "Support 'hush -x' option and 'set -x' command"
232 //config: depends on HUSH
234 //config: This instructs hush to print commands before execution.
235 //config: Adds ~300 bytes.
238 //config: bool "msh (deprecated: aliased to hush)"
240 //config: select HUSH
242 //config: msh is deprecated and will be removed, please migrate to hush.
245 //applet:IF_HUSH(APPLET(hush, BB_DIR_BIN, BB_SUID_DROP))
246 //applet:IF_MSH(APPLET(msh, BB_DIR_BIN, BB_SUID_DROP))
247 //applet:IF_FEATURE_SH_IS_HUSH(APPLET_ODDNAME(sh, hush, BB_DIR_BIN, BB_SUID_DROP, sh))
248 //applet:IF_FEATURE_BASH_IS_HUSH(APPLET_ODDNAME(bash, hush, BB_DIR_BIN, BB_SUID_DROP, bash))
250 //kbuild:lib-$(CONFIG_HUSH) += hush.o match.o shell_common.o
251 //kbuild:lib-$(CONFIG_HUSH_RANDOM_SUPPORT) += random.o
253 /* -i (interactive) and -s (read stdin) are also accepted,
254 * but currently do nothing, therefore aren't shown in help.
255 * NOMMU-specific options are not meant to be used by users,
256 * therefore we don't show them either.
258 //usage:#define hush_trivial_usage
259 //usage: "[-nxl] [-c 'SCRIPT' [ARG0 [ARGS]] / FILE [ARGS]]"
260 //usage:#define hush_full_usage "\n\n"
261 //usage: "Unix shell interpreter"
263 //usage:#define msh_trivial_usage hush_trivial_usage
264 //usage:#define msh_full_usage hush_full_usage
266 //usage:#if ENABLE_FEATURE_SH_IS_HUSH
267 //usage:# define sh_trivial_usage hush_trivial_usage
268 //usage:# define sh_full_usage hush_full_usage
270 //usage:#if ENABLE_FEATURE_BASH_IS_HUSH
271 //usage:# define bash_trivial_usage hush_trivial_usage
272 //usage:# define bash_full_usage hush_full_usage
277 #define LEAK_HUNTING 0
278 #define BUILD_AS_NOMMU 0
279 /* Enable/disable sanity checks. Ok to enable in production,
280 * only adds a bit of bloat. Set to >1 to get non-production level verbosity.
281 * Keeping 1 for now even in released versions.
284 /* Slightly bigger (+200 bytes), but faster hush.
285 * So far it only enables a trick with counting SIGCHLDs and forks,
286 * which allows us to do fewer waitpid's.
287 * (we can detect a case where neither forks were done nor SIGCHLDs happened
288 * and therefore waitpid will return the same result as last time)
290 #define ENABLE_HUSH_FAST 0
291 /* TODO: implement simplified code for users which do not need ${var%...} ops
292 * So far ${var%...} ops are always enabled:
294 #define ENABLE_HUSH_DOLLAR_OPS 1
299 # undef USE_FOR_NOMMU
302 # define USE_FOR_NOMMU(...) __VA_ARGS__
303 # define USE_FOR_MMU(...)
306 #include "NUM_APPLETS.h"
308 /* STANDALONE does not make sense, and won't compile */
309 # undef CONFIG_FEATURE_SH_STANDALONE
310 # undef ENABLE_FEATURE_SH_STANDALONE
311 # undef IF_FEATURE_SH_STANDALONE
312 # undef IF_NOT_FEATURE_SH_STANDALONE
313 # define ENABLE_FEATURE_SH_STANDALONE 0
314 # define IF_FEATURE_SH_STANDALONE(...)
315 # define IF_NOT_FEATURE_SH_STANDALONE(...) __VA_ARGS__
318 #if !ENABLE_HUSH_INTERACTIVE
319 # undef ENABLE_FEATURE_EDITING
320 # define ENABLE_FEATURE_EDITING 0
321 # undef ENABLE_FEATURE_EDITING_FANCY_PROMPT
322 # define ENABLE_FEATURE_EDITING_FANCY_PROMPT 0
323 # undef ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
324 # define ENABLE_FEATURE_EDITING_SAVE_ON_EXIT 0
327 /* Do we support ANY keywords? */
328 #if ENABLE_HUSH_IF || ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
329 # define HAS_KEYWORDS 1
330 # define IF_HAS_KEYWORDS(...) __VA_ARGS__
331 # define IF_HAS_NO_KEYWORDS(...)
333 # define HAS_KEYWORDS 0
334 # define IF_HAS_KEYWORDS(...)
335 # define IF_HAS_NO_KEYWORDS(...) __VA_ARGS__
338 /* If you comment out one of these below, it will be #defined later
339 * to perform debug printfs to stderr: */
340 #define debug_printf(...) do {} while (0)
341 /* Finer-grained debug switches */
342 #define debug_printf_parse(...) do {} while (0)
343 #define debug_print_tree(a, b) do {} while (0)
344 #define debug_printf_exec(...) do {} while (0)
345 #define debug_printf_env(...) do {} while (0)
346 #define debug_printf_jobs(...) do {} while (0)
347 #define debug_printf_expand(...) do {} while (0)
348 #define debug_printf_varexp(...) do {} while (0)
349 #define debug_printf_glob(...) do {} while (0)
350 #define debug_printf_list(...) do {} while (0)
351 #define debug_printf_subst(...) do {} while (0)
352 #define debug_printf_clean(...) do {} while (0)
354 #define ERR_PTR ((void*)(long)1)
356 #define JOB_STATUS_FORMAT "[%d] %-22s %.40s\n"
358 #define _SPECIAL_VARS_STR "_*@$!?#"
359 #define SPECIAL_VARS_STR ("_*@$!?#" + 1)
360 #define NUMERIC_SPECVARS_STR ("_*@$!?#" + 3)
361 #if ENABLE_HUSH_BASH_COMPAT
362 /* Support / and // replace ops */
363 /* Note that // is stored as \ in "encoded" string representation */
364 # define VAR_ENCODED_SUBST_OPS "\\/%#:-=+?"
365 # define VAR_SUBST_OPS ("\\/%#:-=+?" + 1)
366 # define MINUS_PLUS_EQUAL_QUESTION ("\\/%#:-=+?" + 5)
368 # define VAR_ENCODED_SUBST_OPS "%#:-=+?"
369 # define VAR_SUBST_OPS "%#:-=+?"
370 # define MINUS_PLUS_EQUAL_QUESTION ("%#:-=+?" + 3)
373 #define SPECIAL_VAR_SYMBOL 3
377 static const char hush_version_str
[] ALIGN1
= "HUSH_VERSION="BB_VER
;
379 /* This supports saving pointers malloced in vfork child,
380 * to be freed in the parent.
383 typedef struct nommu_save_t
{
385 struct variable
*old_vars
;
387 char **argv_from_re_execing
;
400 #if ENABLE_HUSH_LOOPS
407 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
412 /* three pseudo-keywords support contrived "case" syntax: */
413 RES_CASE_IN
, /* "case ... IN", turns into RES_MATCH when IN is observed */
414 RES_MATCH
, /* "word)" */
415 RES_CASE_BODY
, /* "this command is inside CASE" */
422 typedef struct o_string
{
424 int length
; /* position where data is appended */
427 /* At least some part of the string was inside '' or "",
428 * possibly empty one: word"", wo''rd etc. */
429 smallint has_quoted_part
;
430 smallint has_empty_slot
;
431 smallint o_assignment
; /* 0:maybe, 1:yes, 2:no */
434 EXP_FLAG_SINGLEWORD
= 0x80, /* must be 0x80 */
436 /* Protect newly added chars against globbing
437 * by prepending \ to *, ?, [, \ */
438 EXP_FLAG_ESC_GLOB_CHARS
= 0x1,
441 MAYBE_ASSIGNMENT
= 0,
442 DEFINITELY_ASSIGNMENT
= 1,
444 /* Not an assigment, but next word may be: "if v=xyz cmd;" */
447 /* Used for initialization: o_string foo = NULL_O_STRING; */
448 #define NULL_O_STRING { NULL }
450 #ifndef debug_printf_parse
451 static const char *const assignment_flag
[] = {
453 "DEFINITELY_ASSIGNMENT",
459 typedef struct in_str
{
461 /* eof_flag=1: last char in ->p is really an EOF */
462 char eof_flag
; /* meaningless if ->p == NULL */
464 #if ENABLE_HUSH_INTERACTIVE
465 smallint promptmode
; /* 0: PS1, 1: PS2 */
469 int (*get
) (struct in_str
*) FAST_FUNC
;
470 int (*peek
) (struct in_str
*) FAST_FUNC
;
472 #define i_getch(input) ((input)->get(input))
473 #define i_peek(input) ((input)->peek(input))
475 /* The descrip member of this structure is only used to make
476 * debugging output pretty */
477 static const struct {
479 signed char default_fd
;
482 { O_RDONLY
, 0, "<" },
483 { O_CREAT
|O_TRUNC
|O_WRONLY
, 1, ">" },
484 { O_CREAT
|O_APPEND
|O_WRONLY
, 1, ">>" },
485 { O_CREAT
|O_RDWR
, 1, "<>" },
486 { O_RDONLY
, 0, "<<" },
487 /* Should not be needed. Bogus default_fd helps in debugging */
488 /* { O_RDONLY, 77, "<<" }, */
491 struct redir_struct
{
492 struct redir_struct
*next
;
493 char *rd_filename
; /* filename */
494 int rd_fd
; /* fd to redirect */
495 /* fd to redirect to, or -3 if rd_fd is to be closed (n>&-) */
497 smallint rd_type
; /* (enum redir_type) */
498 /* note: for heredocs, rd_filename contains heredoc delimiter,
499 * and subsequently heredoc itself; and rd_dup is a bitmask:
500 * bit 0: do we need to trim leading tabs?
501 * bit 1: is heredoc quoted (<<'delim' syntax) ?
504 typedef enum redir_type
{
506 REDIRECT_OVERWRITE
= 1,
509 REDIRECT_HEREDOC
= 4,
510 REDIRECT_HEREDOC2
= 5, /* REDIRECT_HEREDOC after heredoc is loaded */
513 REDIRFD_SYNTAX_ERR
= -2,
514 REDIRFD_TO_FILE
= -1,
515 /* otherwise, rd_fd is redirected to rd_dup */
517 HEREDOC_SKIPTABS
= 1,
523 pid_t pid
; /* 0 if exited */
524 int assignment_cnt
; /* how many argv[i] are assignments? */
525 smallint cmd_type
; /* CMD_xxx */
527 #define CMD_SUBSHELL 1
528 #if ENABLE_HUSH_BASH_COMPAT
529 /* used for "[[ EXPR ]]" */
530 # define CMD_SINGLEWORD_NOGLOB 2
532 #if ENABLE_HUSH_FUNCTIONS
533 # define CMD_FUNCDEF 3
536 smalluint cmd_exitcode
;
537 /* if non-NULL, this "command" is { list }, ( list ), or a compound statement */
540 char *group_as_string
;
542 #if ENABLE_HUSH_FUNCTIONS
543 struct function
*child_func
;
544 /* This field is used to prevent a bug here:
545 * while...do f1() {a;}; f1; f1() {b;}; f1; done
546 * When we execute "f1() {a;}" cmd, we create new function and clear
547 * cmd->group, cmd->group_as_string, cmd->argv[0].
548 * When we execute "f1() {b;}", we notice that f1 exists,
549 * and that its "parent cmd" struct is still "alive",
550 * we put those fields back into cmd->xxx
551 * (struct function has ->parent_cmd ptr to facilitate that).
552 * When we loop back, we can execute "f1() {a;}" again and set f1 correctly.
553 * Without this trick, loop would execute a;b;b;b;...
554 * instead of correct sequence a;b;a;b;...
555 * When command is freed, it severs the link
556 * (sets ->child_func->parent_cmd to NULL).
559 char **argv
; /* command name and arguments */
560 /* argv vector may contain variable references (^Cvar^C, ^C0^C etc)
561 * and on execution these are substituted with their values.
562 * Substitution can make _several_ words out of one argv[n]!
563 * Example: argv[0]=='.^C*^C.' here: echo .$*.
564 * References of the form ^C`cmd arg^C are `cmd arg` substitutions.
566 struct redir_struct
*redirects
; /* I/O redirections */
568 /* Is there anything in this command at all? */
569 #define IS_NULL_CMD(cmd) \
570 (!(cmd)->group && !(cmd)->argv && !(cmd)->redirects)
574 int num_cmds
; /* total number of commands in pipe */
575 int alive_cmds
; /* number of commands running (not exited) */
576 int stopped_cmds
; /* number of commands alive, but stopped */
578 int jobid
; /* job number */
579 pid_t pgrp
; /* process group ID for the job */
580 char *cmdtext
; /* name of job */
582 struct command
*cmds
; /* array of commands in pipe */
583 smallint followup
; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
584 IF_HAS_KEYWORDS(smallint pi_inverted
;) /* "! cmd | cmd" */
585 IF_HAS_KEYWORDS(smallint res_word
;) /* needed for if, for, while, until... */
587 typedef enum pipe_style
{
593 /* Is there anything in this pipe at all? */
594 #define IS_NULL_PIPE(pi) \
595 ((pi)->num_cmds == 0 IF_HAS_KEYWORDS( && (pi)->res_word == RES_NONE))
597 /* This holds pointers to the various results of parsing */
598 struct parse_context
{
599 /* linked list of pipes */
600 struct pipe
*list_head
;
601 /* last pipe (being constructed right now) */
603 /* last command in pipe (being constructed right now) */
604 struct command
*command
;
605 /* last redirect in command->redirects list */
606 struct redir_struct
*pending_redirect
;
612 smallint ctx_inverted
; /* "! cmd | cmd" */
614 smallint ctx_dsemicolon
; /* ";;" seen */
616 /* bitmask of FLAG_xxx, for figuring out valid reserved words */
618 /* group we are enclosed in:
619 * example: "if pipe1; pipe2; then pipe3; fi"
620 * when we see "if" or "then", we malloc and copy current context,
621 * and make ->stack point to it. then we parse pipeN.
622 * when closing "then" / fi" / whatever is found,
623 * we move list_head into ->stack->command->group,
624 * copy ->stack into current context, and delete ->stack.
625 * (parsing of { list } and ( list ) doesn't use this method)
627 struct parse_context
*stack
;
631 /* On program start, environ points to initial environment.
632 * putenv adds new pointers into it, unsetenv removes them.
633 * Neither of these (de)allocates the strings.
634 * setenv allocates new strings in malloc space and does putenv,
635 * and thus setenv is unusable (leaky) for shell's purposes */
636 #define setenv(...) setenv_is_leaky_dont_use()
638 struct variable
*next
;
639 char *varstr
; /* points to "name=" portion */
640 #if ENABLE_HUSH_LOCAL
641 unsigned func_nest_level
;
643 int max_len
; /* if > 0, name is part of initial env; else name is malloced */
644 smallint flg_export
; /* putenv should be done on this var */
645 smallint flg_read_only
;
653 #if ENABLE_HUSH_FUNCTIONS
655 struct function
*next
;
657 struct command
*parent_cmd
;
660 char *body_as_string
;
666 /* set -/+o OPT support. (TODO: make it optional)
667 * bash supports the following opts:
678 * interactive-comments on
696 static const char o_opt_strings
[] ALIGN1
=
699 #if ENABLE_HUSH_MODE_X
706 #if ENABLE_HUSH_MODE_X
713 /* "Globals" within this file */
714 /* Sorted roughly by size (smaller offsets == smaller code) */
716 /* interactive_fd != 0 means we are an interactive shell.
717 * If we are, then saved_tty_pgrp can also be != 0, meaning
718 * that controlling tty is available. With saved_tty_pgrp == 0,
719 * job control still works, but terminal signals
720 * (^C, ^Z, ^Y, ^\) won't work at all, and background
721 * process groups can only be created with "cmd &".
722 * With saved_tty_pgrp != 0, hush will use tcsetpgrp()
723 * to give tty to the foreground process group,
724 * and will take it back when the group is stopped (^Z)
727 #if ENABLE_HUSH_INTERACTIVE
728 /* 'interactive_fd' is a fd# open to ctty, if we have one
729 * _AND_ if we decided to act interactively */
733 # define G_interactive_fd (G.interactive_fd)
735 # define G_interactive_fd 0
737 #if ENABLE_FEATURE_EDITING
738 line_input_t
*line_input_state
;
743 #if ENABLE_HUSH_RANDOM_SUPPORT
749 pid_t saved_tty_pgrp
;
750 struct pipe
*job_list
;
751 # define G_saved_tty_pgrp (G.saved_tty_pgrp)
753 # define G_saved_tty_pgrp 0
755 char o_opt
[NUM_OPT_O
];
756 #if ENABLE_HUSH_MODE_X
757 # define G_x_mode (G.o_opt[OPT_O_XTRACE])
761 smallint flag_SIGINT
;
762 #if ENABLE_HUSH_LOOPS
763 smallint flag_break_continue
;
765 #if ENABLE_HUSH_FUNCTIONS
766 /* 0: outside of a function (or sourced file)
767 * -1: inside of a function, ok to use return builtin
768 * 1: return is invoked, skip all till end of func
770 smallint flag_return_in_progress
;
772 smallint exiting
; /* used to prevent EXIT trap recursion */
773 /* These four support $?, $#, and $1 */
774 smalluint last_exitcode
;
775 /* are global_argv and global_argv[1..n] malloced? (note: not [0]) */
776 smalluint global_args_malloced
;
777 /* how many non-NULL argv's we have. NB: $# + 1 */
781 char *argv0_for_re_execing
;
783 #if ENABLE_HUSH_LOOPS
784 unsigned depth_break_continue
;
785 unsigned depth_of_loop
;
789 struct variable
*top_var
;
790 char **expanded_assignments
;
791 #if ENABLE_HUSH_FUNCTIONS
792 struct function
*top_func
;
793 # if ENABLE_HUSH_LOCAL
794 struct variable
**shadowed_vars_pp
;
795 unsigned func_nest_level
;
798 /* Signal and trap handling */
800 unsigned count_SIGCHLD
;
801 unsigned handled_SIGCHLD
;
802 smallint we_have_children
;
804 /* Which signals have non-DFL handler (even with no traps set)?
805 * Set at the start to:
806 * (SIGQUIT + maybe SPECIAL_INTERACTIVE_SIGS + maybe SPECIAL_JOBSTOP_SIGS)
807 * SPECIAL_INTERACTIVE_SIGS are cleared after fork.
808 * The rest is cleared right before execv syscalls.
809 * Other than these two times, never modified.
811 unsigned special_sig_mask
;
813 unsigned fatal_sig_mask
;
814 # define G_fatal_sig_mask G.fatal_sig_mask
816 # define G_fatal_sig_mask 0
818 char **traps
; /* char *traps[NSIG] */
819 sigset_t pending_set
;
821 unsigned long memleak_value
;
825 char user_input_buf
[ENABLE_FEATURE_EDITING
? CONFIG_FEATURE_EDITING_MAX_LEN
: 2];
827 #define G (*ptr_to_globals)
828 /* Not #defining name to G.name - this quickly gets unwieldy
829 * (too many defines). Also, I actually prefer to see when a variable
830 * is global, thus "G." prefix is a useful hint */
831 #define INIT_G() do { \
832 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
833 /* memset(&G.sa, 0, sizeof(G.sa)); */ \
834 sigfillset(&G.sa.sa_mask); \
835 G.sa.sa_flags = SA_RESTART; \
839 /* Function prototypes for builtins */
840 static int builtin_cd(char **argv
) FAST_FUNC
;
841 static int builtin_echo(char **argv
) FAST_FUNC
;
842 static int builtin_eval(char **argv
) FAST_FUNC
;
843 static int builtin_exec(char **argv
) FAST_FUNC
;
844 static int builtin_exit(char **argv
) FAST_FUNC
;
845 static int builtin_export(char **argv
) FAST_FUNC
;
847 static int builtin_fg_bg(char **argv
) FAST_FUNC
;
848 static int builtin_jobs(char **argv
) FAST_FUNC
;
851 static int builtin_help(char **argv
) FAST_FUNC
;
853 #if ENABLE_HUSH_LOCAL
854 static int builtin_local(char **argv
) FAST_FUNC
;
857 static int builtin_memleak(char **argv
) FAST_FUNC
;
860 static int builtin_printf(char **argv
) FAST_FUNC
;
862 static int builtin_pwd(char **argv
) FAST_FUNC
;
863 static int builtin_read(char **argv
) FAST_FUNC
;
864 static int builtin_set(char **argv
) FAST_FUNC
;
865 static int builtin_shift(char **argv
) FAST_FUNC
;
866 static int builtin_source(char **argv
) FAST_FUNC
;
867 static int builtin_test(char **argv
) FAST_FUNC
;
868 static int builtin_trap(char **argv
) FAST_FUNC
;
869 static int builtin_type(char **argv
) FAST_FUNC
;
870 static int builtin_true(char **argv
) FAST_FUNC
;
871 static int builtin_umask(char **argv
) FAST_FUNC
;
872 static int builtin_unset(char **argv
) FAST_FUNC
;
873 static int builtin_wait(char **argv
) FAST_FUNC
;
874 #if ENABLE_HUSH_LOOPS
875 static int builtin_break(char **argv
) FAST_FUNC
;
876 static int builtin_continue(char **argv
) FAST_FUNC
;
878 #if ENABLE_HUSH_FUNCTIONS
879 static int builtin_return(char **argv
) FAST_FUNC
;
882 /* Table of built-in functions. They can be forked or not, depending on
883 * context: within pipes, they fork. As simple commands, they do not.
884 * When used in non-forking context, they can change global variables
885 * in the parent shell process. If forked, of course they cannot.
886 * For example, 'unset foo | whatever' will parse and run, but foo will
887 * still be set at the end. */
888 struct built_in_command
{
890 int (*b_function
)(char **argv
) FAST_FUNC
;
893 # define BLTIN(cmd, func, help) { cmd, func, help }
895 # define BLTIN(cmd, func, help) { cmd, func }
899 static const struct built_in_command bltins1
[] = {
900 BLTIN("." , builtin_source
, "Run commands in a file"),
901 BLTIN(":" , builtin_true
, NULL
),
903 BLTIN("bg" , builtin_fg_bg
, "Resume a job in the background"),
905 #if ENABLE_HUSH_LOOPS
906 BLTIN("break" , builtin_break
, "Exit from a loop"),
908 BLTIN("cd" , builtin_cd
, "Change directory"),
909 #if ENABLE_HUSH_LOOPS
910 BLTIN("continue" , builtin_continue
, "Start new loop iteration"),
912 BLTIN("eval" , builtin_eval
, "Construct and run shell command"),
913 BLTIN("exec" , builtin_exec
, "Execute command, don't return to shell"),
914 BLTIN("exit" , builtin_exit
, "Exit"),
915 BLTIN("export" , builtin_export
, "Set environment variables"),
917 BLTIN("fg" , builtin_fg_bg
, "Bring job into the foreground"),
920 BLTIN("help" , builtin_help
, NULL
),
923 BLTIN("jobs" , builtin_jobs
, "List jobs"),
925 #if ENABLE_HUSH_LOCAL
926 BLTIN("local" , builtin_local
, "Set local variables"),
929 BLTIN("memleak" , builtin_memleak
, NULL
),
931 BLTIN("read" , builtin_read
, "Input into variable"),
932 #if ENABLE_HUSH_FUNCTIONS
933 BLTIN("return" , builtin_return
, "Return from a function"),
935 BLTIN("set" , builtin_set
, "Set/unset positional parameters"),
936 BLTIN("shift" , builtin_shift
, "Shift positional parameters"),
937 #if ENABLE_HUSH_BASH_COMPAT
938 BLTIN("source" , builtin_source
, "Run commands in a file"),
940 BLTIN("trap" , builtin_trap
, "Trap signals"),
941 BLTIN("type" , builtin_type
, "Show command type"),
942 BLTIN("ulimit" , shell_builtin_ulimit
, "Control resource limits"),
943 BLTIN("umask" , builtin_umask
, "Set file creation mask"),
944 BLTIN("unset" , builtin_unset
, "Unset variables"),
945 BLTIN("wait" , builtin_wait
, "Wait for process"),
947 /* For now, echo and test are unconditionally enabled.
948 * Maybe make it configurable? */
949 static const struct built_in_command bltins2
[] = {
950 BLTIN("[" , builtin_test
, NULL
),
951 BLTIN("echo" , builtin_echo
, NULL
),
953 BLTIN("printf" , builtin_printf
, NULL
),
955 BLTIN("pwd" , builtin_pwd
, NULL
),
956 BLTIN("test" , builtin_test
, NULL
),
963 /* prevent disasters with G.debug_indent < 0 */
964 # define indent() fdprintf(2, "%*s", (G.debug_indent * 2) & 0xff, "")
965 # define debug_enter() (G.debug_indent++)
966 # define debug_leave() (G.debug_indent--)
968 # define indent() ((void)0)
969 # define debug_enter() ((void)0)
970 # define debug_leave() ((void)0)
974 # define debug_printf(...) (indent(), fdprintf(2, __VA_ARGS__))
977 #ifndef debug_printf_parse
978 # define debug_printf_parse(...) (indent(), fdprintf(2, __VA_ARGS__))
981 #ifndef debug_printf_exec
982 #define debug_printf_exec(...) (indent(), fdprintf(2, __VA_ARGS__))
985 #ifndef debug_printf_env
986 # define debug_printf_env(...) (indent(), fdprintf(2, __VA_ARGS__))
989 #ifndef debug_printf_jobs
990 # define debug_printf_jobs(...) (indent(), fdprintf(2, __VA_ARGS__))
991 # define DEBUG_JOBS 1
993 # define DEBUG_JOBS 0
996 #ifndef debug_printf_expand
997 # define debug_printf_expand(...) (indent(), fdprintf(2, __VA_ARGS__))
998 # define DEBUG_EXPAND 1
1000 # define DEBUG_EXPAND 0
1003 #ifndef debug_printf_varexp
1004 # define debug_printf_varexp(...) (indent(), fdprintf(2, __VA_ARGS__))
1007 #ifndef debug_printf_glob
1008 # define debug_printf_glob(...) (indent(), fdprintf(2, __VA_ARGS__))
1009 # define DEBUG_GLOB 1
1011 # define DEBUG_GLOB 0
1014 #ifndef debug_printf_list
1015 # define debug_printf_list(...) (indent(), fdprintf(2, __VA_ARGS__))
1018 #ifndef debug_printf_subst
1019 # define debug_printf_subst(...) (indent(), fdprintf(2, __VA_ARGS__))
1022 #ifndef debug_printf_clean
1023 # define debug_printf_clean(...) (indent(), fdprintf(2, __VA_ARGS__))
1024 # define DEBUG_CLEAN 1
1026 # define DEBUG_CLEAN 0
1030 static void debug_print_strings(const char *prefix
, char **vv
)
1033 fdprintf(2, "%s:\n", prefix
);
1035 fdprintf(2, " '%s'\n", *vv
++);
1038 # define debug_print_strings(prefix, vv) ((void)0)
1042 /* Leak hunting. Use hush_leaktool.sh for post-processing.
1045 static void *xxmalloc(int lineno
, size_t size
)
1047 void *ptr
= xmalloc((size
+ 0xff) & ~0xff);
1048 fdprintf(2, "line %d: malloc %p\n", lineno
, ptr
);
1051 static void *xxrealloc(int lineno
, void *ptr
, size_t size
)
1053 ptr
= xrealloc(ptr
, (size
+ 0xff) & ~0xff);
1054 fdprintf(2, "line %d: realloc %p\n", lineno
, ptr
);
1057 static char *xxstrdup(int lineno
, const char *str
)
1059 char *ptr
= xstrdup(str
);
1060 fdprintf(2, "line %d: strdup %p\n", lineno
, ptr
);
1063 static void xxfree(void *ptr
)
1065 fdprintf(2, "free %p\n", ptr
);
1068 # define xmalloc(s) xxmalloc(__LINE__, s)
1069 # define xrealloc(p, s) xxrealloc(__LINE__, p, s)
1070 # define xstrdup(s) xxstrdup(__LINE__, s)
1071 # define free(p) xxfree(p)
1075 /* Syntax and runtime errors. They always abort scripts.
1076 * In interactive use they usually discard unparsed and/or unexecuted commands
1077 * and return to the prompt.
1078 * HUSH_DEBUG >= 2 prints line number in this file where it was detected.
1081 # define die_if_script(lineno, ...) die_if_script(__VA_ARGS__)
1082 # define syntax_error(lineno, msg) syntax_error(msg)
1083 # define syntax_error_at(lineno, msg) syntax_error_at(msg)
1084 # define syntax_error_unterm_ch(lineno, ch) syntax_error_unterm_ch(ch)
1085 # define syntax_error_unterm_str(lineno, s) syntax_error_unterm_str(s)
1086 # define syntax_error_unexpected_ch(lineno, ch) syntax_error_unexpected_ch(ch)
1089 static void die_if_script(unsigned lineno
, const char *fmt
, ...)
1094 bb_error_msg("hush.c:%u", lineno
);
1097 bb_verror_msg(fmt
, p
, NULL
);
1099 if (!G_interactive_fd
)
1103 static void syntax_error(unsigned lineno UNUSED_PARAM
, const char *msg
)
1106 bb_error_msg("syntax error: %s", msg
);
1108 bb_error_msg("syntax error");
1111 static void syntax_error_at(unsigned lineno UNUSED_PARAM
, const char *msg
)
1113 bb_error_msg("syntax error at '%s'", msg
);
1116 static void syntax_error_unterm_str(unsigned lineno UNUSED_PARAM
, const char *s
)
1118 bb_error_msg("syntax error: unterminated %s", s
);
1121 static void syntax_error_unterm_ch(unsigned lineno
, char ch
)
1123 char msg
[2] = { ch
, '\0' };
1124 syntax_error_unterm_str(lineno
, msg
);
1127 static void syntax_error_unexpected_ch(unsigned lineno UNUSED_PARAM
, int ch
)
1132 bb_error_msg("syntax error: unexpected %s", ch
== EOF
? "EOF" : msg
);
1136 # undef die_if_script
1137 # undef syntax_error
1138 # undef syntax_error_at
1139 # undef syntax_error_unterm_ch
1140 # undef syntax_error_unterm_str
1141 # undef syntax_error_unexpected_ch
1143 # define die_if_script(...) die_if_script(__LINE__, __VA_ARGS__)
1144 # define syntax_error(msg) syntax_error(__LINE__, msg)
1145 # define syntax_error_at(msg) syntax_error_at(__LINE__, msg)
1146 # define syntax_error_unterm_ch(ch) syntax_error_unterm_ch(__LINE__, ch)
1147 # define syntax_error_unterm_str(s) syntax_error_unterm_str(__LINE__, s)
1148 # define syntax_error_unexpected_ch(ch) syntax_error_unexpected_ch(__LINE__, ch)
1152 #if ENABLE_HUSH_INTERACTIVE
1153 static void cmdedit_update_prompt(void);
1155 # define cmdedit_update_prompt() ((void)0)
1159 /* Utility functions
1161 /* Replace each \x with x in place, return ptr past NUL. */
1162 static char *unbackslash(char *src
)
1164 char *dst
= src
= strchrnul(src
, '\\');
1168 if ((*dst
++ = *src
++) == '\0')
1174 static char **add_strings_to_strings(char **strings
, char **add
, int need_to_dup
)
1195 v
= xrealloc(strings
, (count1
+ count2
+ 1) * sizeof(char*));
1196 v
[count1
+ count2
] = NULL
;
1199 v
[count1
+ i
] = (need_to_dup
? xstrdup(add
[i
]) : add
[i
]);
1203 static char **xx_add_strings_to_strings(int lineno
, char **strings
, char **add
, int need_to_dup
)
1205 char **ptr
= add_strings_to_strings(strings
, add
, need_to_dup
);
1206 fdprintf(2, "line %d: add_strings_to_strings %p\n", lineno
, ptr
);
1209 #define add_strings_to_strings(strings, add, need_to_dup) \
1210 xx_add_strings_to_strings(__LINE__, strings, add, need_to_dup)
1213 /* Note: takes ownership of "add" ptr (it is not strdup'ed) */
1214 static char **add_string_to_strings(char **strings
, char *add
)
1219 return add_strings_to_strings(strings
, v
, /*dup:*/ 0);
1222 static char **xx_add_string_to_strings(int lineno
, char **strings
, char *add
)
1224 char **ptr
= add_string_to_strings(strings
, add
);
1225 fdprintf(2, "line %d: add_string_to_strings %p\n", lineno
, ptr
);
1228 #define add_string_to_strings(strings, add) \
1229 xx_add_string_to_strings(__LINE__, strings, add)
1232 static void free_strings(char **strings
)
1247 /* Helpers for setting new $n and restoring them back
1249 typedef struct save_arg_t
{
1253 smallint sv_g_malloced
;
1256 static void save_and_replace_G_args(save_arg_t
*sv
, char **argv
)
1260 sv
->sv_argv0
= argv
[0];
1261 sv
->sv_g_argv
= G
.global_argv
;
1262 sv
->sv_g_argc
= G
.global_argc
;
1263 sv
->sv_g_malloced
= G
.global_args_malloced
;
1265 argv
[0] = G
.global_argv
[0]; /* retain $0 */
1266 G
.global_argv
= argv
;
1267 G
.global_args_malloced
= 0;
1275 static void restore_G_args(save_arg_t
*sv
, char **argv
)
1279 if (G
.global_args_malloced
) {
1280 /* someone ran "set -- arg1 arg2 ...", undo */
1282 while (*++pp
) /* note: does not free $0 */
1284 free(G
.global_argv
);
1286 argv
[0] = sv
->sv_argv0
;
1287 G
.global_argv
= sv
->sv_g_argv
;
1288 G
.global_argc
= sv
->sv_g_argc
;
1289 G
.global_args_malloced
= sv
->sv_g_malloced
;
1293 /* Basic theory of signal handling in shell
1294 * ========================================
1295 * This does not describe what hush does, rather, it is current understanding
1296 * what it _should_ do. If it doesn't, it's a bug.
1297 * http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
1299 * Signals are handled only after each pipe ("cmd | cmd | cmd" thing)
1300 * is finished or backgrounded. It is the same in interactive and
1301 * non-interactive shells, and is the same regardless of whether
1302 * a user trap handler is installed or a shell special one is in effect.
1303 * ^C or ^Z from keyboard seems to execute "at once" because it usually
1304 * backgrounds (i.e. stops) or kills all members of currently running
1307 * Wait builtin in interruptible by signals for which user trap is set
1308 * or by SIGINT in interactive shell.
1310 * Trap handlers will execute even within trap handlers. (right?)
1312 * User trap handlers are forgotten when subshell ("(cmd)") is entered,
1313 * except for handlers set to '' (empty string).
1315 * If job control is off, backgrounded commands ("cmd &")
1316 * have SIGINT, SIGQUIT set to SIG_IGN.
1318 * Commands which are run in command substitution ("`cmd`")
1319 * have SIGTTIN, SIGTTOU, SIGTSTP set to SIG_IGN.
1321 * Ordinary commands have signals set to SIG_IGN/DFL as inherited
1322 * by the shell from its parent.
1324 * Signals which differ from SIG_DFL action
1325 * (note: child (i.e., [v]forked) shell is not an interactive shell):
1328 * SIGTERM (interactive): ignore
1329 * SIGHUP (interactive):
1330 * send SIGCONT to stopped jobs, send SIGHUP to all jobs and exit
1331 * SIGTTIN, SIGTTOU, SIGTSTP (if job control is on): ignore
1332 * Note that ^Z is handled not by trapping SIGTSTP, but by seeing
1333 * that all pipe members are stopped. Try this in bash:
1334 * while :; do :; done - ^Z does not background it
1335 * (while :; do :; done) - ^Z backgrounds it
1336 * SIGINT (interactive): wait for last pipe, ignore the rest
1337 * of the command line, show prompt. NB: ^C does not send SIGINT
1338 * to interactive shell while shell is waiting for a pipe,
1339 * since shell is bg'ed (is not in foreground process group).
1340 * Example 1: this waits 5 sec, but does not execute ls:
1341 * "echo $$; sleep 5; ls -l" + "kill -INT <pid>"
1342 * Example 2: this does not wait and does not execute ls:
1343 * "echo $$; sleep 5 & wait; ls -l" + "kill -INT <pid>"
1344 * Example 3: this does not wait 5 sec, but executes ls:
1345 * "sleep 5; ls -l" + press ^C
1346 * Example 4: this does not wait and does not execute ls:
1347 * "sleep 5 & wait; ls -l" + press ^C
1349 * (What happens to signals which are IGN on shell start?)
1350 * (What happens with signal mask on shell start?)
1352 * Old implementation
1353 * ==================
1354 * We use in-kernel pending signal mask to determine which signals were sent.
1355 * We block all signals which we don't want to take action immediately,
1356 * i.e. we block all signals which need to have special handling as described
1357 * above, and all signals which have traps set.
1358 * After each pipe execution, we extract any pending signals via sigtimedwait()
1361 * unsigned special_sig_mask: a mask of such "special" signals
1362 * sigset_t blocked_set: current blocked signal set
1365 * clear bit in blocked_set unless it is also in special_sig_mask
1366 * "trap 'cmd' SIGxxx":
1367 * set bit in blocked_set (even if 'cmd' is '')
1368 * after [v]fork, if we plan to be a shell:
1369 * unblock signals with special interactive handling
1370 * (child shell is not interactive),
1371 * unset all traps except '' (note: regardless of child shell's type - {}, (), etc)
1372 * after [v]fork, if we plan to exec:
1373 * POSIX says fork clears pending signal mask in child - no need to clear it.
1374 * Restore blocked signal set to one inherited by shell just prior to exec.
1376 * Note: as a result, we do not use signal handlers much. The only uses
1377 * are to count SIGCHLDs
1378 * and to restore tty pgrp on signal-induced exit.
1381 * Standard says "When a subshell is entered, traps that are not being ignored
1382 * are set to the default actions". bash interprets it so that traps which
1383 * are set to '' (ignore) are NOT reset to defaults. We do the same.
1385 * Problem: the above approach makes it unwieldy to catch signals while
1386 * we are in read builtin, of while we read commands from stdin:
1387 * masked signals are not visible!
1389 * New implementation
1390 * ==================
1391 * We record each signal we are interested in by installing signal handler
1392 * for them - a bit like emulating kernel pending signal mask in userspace.
1393 * We are interested in: signals which need to have special handling
1394 * as described above, and all signals which have traps set.
1395 * Signals are rocorded in pending_set.
1396 * After each pipe execution, we extract any pending signals
1399 * unsigned special_sig_mask: a mask of shell-special signals.
1400 * unsigned fatal_sig_mask: a mask of signals on which we restore tty pgrp.
1401 * char *traps[sig] if trap for sig is set (even if it's '').
1402 * sigset_t pending_set: set of sigs we received.
1405 * if sig is in special_sig_mask, set handler back to:
1406 * record_pending_signo, or to IGN if it's a tty stop signal
1407 * if sig is in fatal_sig_mask, set handler back to sigexit.
1408 * else: set handler back to SIG_DFL
1409 * "trap 'cmd' SIGxxx":
1410 * set handler to record_pending_signo.
1412 * set handler to SIG_IGN.
1413 * after [v]fork, if we plan to be a shell:
1414 * set signals with special interactive handling to SIG_DFL
1415 * (because child shell is not interactive),
1416 * unset all traps except '' (note: regardless of child shell's type - {}, (), etc)
1417 * after [v]fork, if we plan to exec:
1418 * POSIX says fork clears pending signal mask in child - no need to clear it.
1420 * To make wait builtin interruptible, we handle SIGCHLD as special signal,
1421 * otherwise (if we leave it SIG_DFL) sigsuspend in wait builtin will not wake up on it.
1424 * Standard says "When a subshell is entered, traps that are not being ignored
1425 * are set to the default actions". bash interprets it so that traps which
1426 * are set to '' (ignore) are NOT reset to defaults. We do the same.
1429 SPECIAL_INTERACTIVE_SIGS
= 0
1434 SPECIAL_JOBSTOP_SIGS
= 0
1443 static void record_pending_signo(int sig
)
1445 sigaddset(&G
.pending_set
, sig
);
1446 #if ENABLE_HUSH_FAST
1447 if (sig
== SIGCHLD
) {
1449 //bb_error_msg("[%d] SIGCHLD_handler: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1454 static sighandler_t
install_sighandler(int sig
, sighandler_t handler
)
1456 struct sigaction old_sa
;
1458 /* We could use signal() to install handlers... almost:
1459 * except that we need to mask ALL signals while handlers run.
1460 * I saw signal nesting in strace, race window isn't small.
1461 * SA_RESTART is also needed, but in Linux, signal()
1462 * sets SA_RESTART too.
1464 /* memset(&G.sa, 0, sizeof(G.sa)); - already done */
1465 /* sigfillset(&G.sa.sa_mask); - already done */
1466 /* G.sa.sa_flags = SA_RESTART; - already done */
1467 G
.sa
.sa_handler
= handler
;
1468 sigaction(sig
, &G
.sa
, &old_sa
);
1469 return old_sa
.sa_handler
;
1474 /* After [v]fork, in child: do not restore tty pgrp on xfunc death */
1475 # define disable_restore_tty_pgrp_on_exit() (die_sleep = 0)
1476 /* After [v]fork, in parent: restore tty pgrp on xfunc death */
1477 # define enable_restore_tty_pgrp_on_exit() (die_sleep = -1)
1479 /* Restores tty foreground process group, and exits.
1480 * May be called as signal handler for fatal signal
1481 * (will resend signal to itself, producing correct exit state)
1482 * or called directly with -EXITCODE.
1483 * We also call it if xfunc is exiting. */
1484 static void sigexit(int sig
) NORETURN
;
1485 static void sigexit(int sig
)
1487 /* Careful: we can end up here after [v]fork. Do not restore
1488 * tty pgrp then, only top-level shell process does that */
1489 if (G_saved_tty_pgrp
&& getpid() == G
.root_pid
) {
1490 /* Disable all signals: job control, SIGPIPE, etc.
1491 * Mostly paranoid measure, to prevent infinite SIGTTOU.
1493 sigprocmask_allsigs(SIG_BLOCK
);
1494 tcsetpgrp(G_interactive_fd
, G_saved_tty_pgrp
);
1497 /* Not a signal, just exit */
1501 kill_myself_with_sig(sig
); /* does not return */
1505 # define disable_restore_tty_pgrp_on_exit() ((void)0)
1506 # define enable_restore_tty_pgrp_on_exit() ((void)0)
1510 static sighandler_t
pick_sighandler(unsigned sig
)
1512 sighandler_t handler
= SIG_DFL
;
1513 if (sig
< sizeof(unsigned)*8) {
1514 unsigned sigmask
= (1 << sig
);
1518 if (G_fatal_sig_mask
& sigmask
)
1522 /* sig has special handling? */
1523 if (G
.special_sig_mask
& sigmask
) {
1524 handler
= record_pending_signo
;
1525 /* TTIN/TTOU/TSTP can't be set to record_pending_signo
1526 * in order to ignore them: they will be raised
1527 * in an endless loop when we try to do some
1528 * terminal ioctls! We do have to _ignore_ these.
1530 if (SPECIAL_JOBSTOP_SIGS
& sigmask
)
1537 /* Restores tty foreground process group, and exits. */
1538 static void hush_exit(int exitcode
) NORETURN
;
1539 static void hush_exit(int exitcode
)
1541 #if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1542 save_history(G
.line_input_state
);
1546 if (G
.exiting
<= 0 && G
.traps
&& G
.traps
[0] && G
.traps
[0][0]) {
1548 /* argv[0] is unused */
1549 argv
[1] = G
.traps
[0];
1551 G
.exiting
= 1; /* prevent EXIT trap recursion */
1552 /* Note: G.traps[0] is not cleared!
1553 * "trap" will still show it, if executed
1558 #if ENABLE_FEATURE_CLEAN_UP
1560 struct variable
*cur_var
;
1561 if (G
.cwd
!= bb_msg_unknown
)
1563 cur_var
= G
.top_var
;
1565 struct variable
*tmp
= cur_var
;
1566 if (!cur_var
->max_len
)
1567 free(cur_var
->varstr
);
1568 cur_var
= cur_var
->next
;
1576 sigexit(- (exitcode
& 0xff));
1583 //TODO: return a mask of ALL handled sigs?
1584 static int check_and_run_traps(void)
1591 if (sigisemptyset(&G
.pending_set
))
1596 if (sigismember(&G
.pending_set
, sig
)) {
1597 sigdelset(&G
.pending_set
, sig
);
1600 } while (sig
< NSIG
);
1603 if (G
.traps
&& G
.traps
[sig
]) {
1604 if (G
.traps
[sig
][0]) {
1605 /* We have user-defined handler */
1606 smalluint save_rcode
;
1608 /* argv[0] is unused */
1609 argv
[1] = G
.traps
[sig
];
1611 save_rcode
= G
.last_exitcode
;
1613 G
.last_exitcode
= save_rcode
;
1615 } /* else: "" trap, ignoring signal */
1618 /* not a trap: special action */
1621 /* Builtin was ^C'ed, make it look prettier: */
1629 /* bash is observed to signal whole process groups,
1630 * not individual processes */
1631 for (job
= G
.job_list
; job
; job
= job
->next
) {
1634 debug_printf_exec("HUPing pgrp %d\n", job
->pgrp
);
1635 if (kill(- job
->pgrp
, SIGHUP
) == 0)
1636 kill(- job
->pgrp
, SIGCONT
);
1641 #if ENABLE_HUSH_FAST
1644 //bb_error_msg("[%d] check_and_run_traps: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1646 * We dont do 'last_sig = sig' here -> NOT returning this sig.
1647 * This simplifies wait builtin a bit.
1651 default: /* ignored: */
1652 /* SIGTERM, SIGQUIT, SIGTTIN, SIGTTOU, SIGTSTP */
1654 * We dont do 'last_sig = sig' here -> NOT returning this sig.
1655 * Example: wait is not interrupted by TERM
1656 * in interactive shell, because TERM is ignored.
1665 static const char *get_cwd(int force
)
1667 if (force
|| G
.cwd
== NULL
) {
1668 /* xrealloc_getcwd_or_warn(arg) calls free(arg),
1669 * we must not try to free(bb_msg_unknown) */
1670 if (G
.cwd
== bb_msg_unknown
)
1672 G
.cwd
= xrealloc_getcwd_or_warn((char *)G
.cwd
);
1674 G
.cwd
= bb_msg_unknown
;
1681 * Shell and environment variable support
1683 static struct variable
**get_ptr_to_local_var(const char *name
, unsigned len
)
1685 struct variable
**pp
;
1686 struct variable
*cur
;
1689 while ((cur
= *pp
) != NULL
) {
1690 if (strncmp(cur
->varstr
, name
, len
) == 0 && cur
->varstr
[len
] == '=')
1697 static const char* FAST_FUNC
get_local_var_value(const char *name
)
1699 struct variable
**vpp
;
1700 unsigned len
= strlen(name
);
1702 if (G
.expanded_assignments
) {
1703 char **cpp
= G
.expanded_assignments
;
1706 if (strncmp(cp
, name
, len
) == 0 && cp
[len
] == '=')
1707 return cp
+ len
+ 1;
1712 vpp
= get_ptr_to_local_var(name
, len
);
1714 return (*vpp
)->varstr
+ len
+ 1;
1716 if (strcmp(name
, "PPID") == 0)
1717 return utoa(G
.root_ppid
);
1718 // bash compat: UID? EUID?
1719 #if ENABLE_HUSH_RANDOM_SUPPORT
1720 if (strcmp(name
, "RANDOM") == 0)
1721 return utoa(next_random(&G
.random_gen
));
1726 /* str holds "NAME=VAL" and is expected to be malloced.
1727 * We take ownership of it.
1729 * 0: do not change export flag
1730 * (if creating new variable, flag will be 0)
1731 * 1: set export flag and putenv the variable
1732 * -1: clear export flag and unsetenv the variable
1733 * flg_read_only is set only when we handle -R var=val
1735 #if !BB_MMU && ENABLE_HUSH_LOCAL
1736 /* all params are used */
1737 #elif BB_MMU && ENABLE_HUSH_LOCAL
1738 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1739 set_local_var(str, flg_export, local_lvl)
1740 #elif BB_MMU && !ENABLE_HUSH_LOCAL
1741 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1742 set_local_var(str, flg_export)
1743 #elif !BB_MMU && !ENABLE_HUSH_LOCAL
1744 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1745 set_local_var(str, flg_export, flg_read_only)
1747 static int set_local_var(char *str
, int flg_export
, int local_lvl
, int flg_read_only
)
1749 struct variable
**var_pp
;
1750 struct variable
*cur
;
1754 eq_sign
= strchr(str
, '=');
1755 if (!eq_sign
) { /* not expected to ever happen? */
1760 name_len
= eq_sign
- str
+ 1; /* including '=' */
1761 var_pp
= &G
.top_var
;
1762 while ((cur
= *var_pp
) != NULL
) {
1763 if (strncmp(cur
->varstr
, str
, name_len
) != 0) {
1764 var_pp
= &cur
->next
;
1767 /* We found an existing var with this name */
1768 if (cur
->flg_read_only
) {
1772 bb_error_msg("%s: readonly variable", str
);
1776 if (flg_export
== -1) { // "&& cur->flg_export" ?
1777 debug_printf_env("%s: unsetenv '%s'\n", __func__
, str
);
1782 #if ENABLE_HUSH_LOCAL
1783 if (cur
->func_nest_level
< local_lvl
) {
1784 /* New variable is declared as local,
1785 * and existing one is global, or local
1786 * from enclosing function.
1787 * Remove and save old one: */
1788 *var_pp
= cur
->next
;
1789 cur
->next
= *G
.shadowed_vars_pp
;
1790 *G
.shadowed_vars_pp
= cur
;
1791 /* bash 3.2.33(1) and exported vars:
1793 * # f() { local z=a; env | grep ^z; }
1799 if (cur
->flg_export
)
1804 if (strcmp(cur
->varstr
+ name_len
, eq_sign
+ 1) == 0) {
1809 if (cur
->max_len
!= 0) {
1810 if (cur
->max_len
>= strlen(str
)) {
1811 /* This one is from startup env, reuse space */
1812 strcpy(cur
->varstr
, str
);
1816 /* max_len == 0 signifies "malloced" var, which we can
1817 * (and has to) free */
1821 goto set_str_and_exp
;
1824 /* Not found - create new variable struct */
1825 cur
= xzalloc(sizeof(*cur
));
1826 #if ENABLE_HUSH_LOCAL
1827 cur
->func_nest_level
= local_lvl
;
1829 cur
->next
= *var_pp
;
1835 cur
->flg_read_only
= flg_read_only
;
1838 if (flg_export
== 1)
1839 cur
->flg_export
= 1;
1840 if (name_len
== 4 && cur
->varstr
[0] == 'P' && cur
->varstr
[1] == 'S')
1841 cmdedit_update_prompt();
1842 if (cur
->flg_export
) {
1843 if (flg_export
== -1) {
1844 cur
->flg_export
= 0;
1845 /* unsetenv was already done */
1847 debug_printf_env("%s: putenv '%s'\n", __func__
, cur
->varstr
);
1848 return putenv(cur
->varstr
);
1854 /* Used at startup and after each cd */
1855 static void set_pwd_var(int exp
)
1857 set_local_var(xasprintf("PWD=%s", get_cwd(/*force:*/ 1)),
1858 /*exp:*/ exp
, /*lvl:*/ 0, /*ro:*/ 0);
1861 static int unset_local_var_len(const char *name
, int name_len
)
1863 struct variable
*cur
;
1864 struct variable
**var_pp
;
1867 return EXIT_SUCCESS
;
1868 var_pp
= &G
.top_var
;
1869 while ((cur
= *var_pp
) != NULL
) {
1870 if (strncmp(cur
->varstr
, name
, name_len
) == 0 && cur
->varstr
[name_len
] == '=') {
1871 if (cur
->flg_read_only
) {
1872 bb_error_msg("%s: readonly variable", name
);
1873 return EXIT_FAILURE
;
1875 *var_pp
= cur
->next
;
1876 debug_printf_env("%s: unsetenv '%s'\n", __func__
, cur
->varstr
);
1877 bb_unsetenv(cur
->varstr
);
1878 if (name_len
== 3 && cur
->varstr
[0] == 'P' && cur
->varstr
[1] == 'S')
1879 cmdedit_update_prompt();
1883 return EXIT_SUCCESS
;
1885 var_pp
= &cur
->next
;
1887 return EXIT_SUCCESS
;
1890 static int unset_local_var(const char *name
)
1892 return unset_local_var_len(name
, strlen(name
));
1895 static void unset_vars(char **strings
)
1903 const char *eq
= strchrnul(*v
, '=');
1904 unset_local_var_len(*v
, (int)(eq
- *v
));
1910 static void FAST_FUNC
set_local_var_from_halves(const char *name
, const char *val
)
1912 char *var
= xasprintf("%s=%s", name
, val
);
1913 set_local_var(var
, /*flags:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
1918 * Helpers for "var1=val1 var2=val2 cmd" feature
1920 static void add_vars(struct variable
*var
)
1922 struct variable
*next
;
1926 var
->next
= G
.top_var
;
1928 if (var
->flg_export
) {
1929 debug_printf_env("%s: restoring exported '%s'\n", __func__
, var
->varstr
);
1930 putenv(var
->varstr
);
1932 debug_printf_env("%s: restoring variable '%s'\n", __func__
, var
->varstr
);
1938 static struct variable
*set_vars_and_save_old(char **strings
)
1941 struct variable
*old
= NULL
;
1947 struct variable
*var_p
;
1948 struct variable
**var_pp
;
1951 eq
= strchr(*s
, '=');
1953 var_pp
= get_ptr_to_local_var(*s
, eq
- *s
);
1955 /* Remove variable from global linked list */
1957 debug_printf_env("%s: removing '%s'\n", __func__
, var_p
->varstr
);
1958 *var_pp
= var_p
->next
;
1959 /* Add it to returned list */
1963 set_local_var(*s
, /*exp:*/ 1, /*lvl:*/ 0, /*ro:*/ 0);
1974 static int FAST_FUNC
static_get(struct in_str
*i
)
1985 static int FAST_FUNC
static_peek(struct in_str
*i
)
1990 #if ENABLE_HUSH_INTERACTIVE
1992 static void cmdedit_update_prompt(void)
1994 if (ENABLE_FEATURE_EDITING_FANCY_PROMPT
) {
1995 G
.PS1
= get_local_var_value("PS1");
1998 G
.PS2
= get_local_var_value("PS2");
2006 static const char *setup_prompt_string(int promptmode
)
2008 const char *prompt_str
;
2009 debug_printf("setup_prompt_string %d ", promptmode
);
2010 if (!ENABLE_FEATURE_EDITING_FANCY_PROMPT
) {
2011 /* Set up the prompt */
2012 if (promptmode
== 0) { /* PS1 */
2014 /* bash uses $PWD value, even if it is set by user.
2015 * It uses current dir only if PWD is unset.
2016 * We always use current dir. */
2017 G
.PS1
= xasprintf("%s %c ", get_cwd(0), (geteuid() != 0) ? '$' : '#');
2022 prompt_str
= (promptmode
== 0) ? G
.PS1
: G
.PS2
;
2023 debug_printf("result '%s'\n", prompt_str
);
2027 static void get_user_input(struct in_str
*i
)
2030 const char *prompt_str
;
2032 prompt_str
= setup_prompt_string(i
->promptmode
);
2033 # if ENABLE_FEATURE_EDITING
2034 /* Enable command line editing only while a command line
2035 * is actually being read */
2037 /* Unicode support should be activated even if LANG is set
2038 * _during_ shell execution, not only if it was set when
2039 * shell was started. Therefore, re-check LANG every time:
2041 reinit_unicode(get_local_var_value("LANG"));
2044 /* buglet: SIGINT will not make new prompt to appear _at once_,
2045 * only after <Enter>. (^C will work) */
2046 r
= read_line_input(G
.line_input_state
, prompt_str
, G
.user_input_buf
, CONFIG_FEATURE_EDITING_MAX_LEN
-1, /*timeout*/ -1);
2047 /* catch *SIGINT* etc (^C is handled by read_line_input) */
2048 check_and_run_traps();
2049 } while (r
== 0 || G
.flag_SIGINT
); /* repeat if ^C or SIGINT */
2050 i
->eof_flag
= (r
< 0);
2051 if (i
->eof_flag
) { /* EOF/error detected */
2052 G
.user_input_buf
[0] = EOF
; /* yes, it will be truncated, it's ok */
2053 G
.user_input_buf
[1] = '\0';
2058 if (i
->last_char
== '\0' || i
->last_char
== '\n') {
2059 /* Why check_and_run_traps here? Try this interactively:
2060 * $ trap 'echo INT' INT; (sleep 2; kill -INT $$) &
2061 * $ <[enter], repeatedly...>
2062 * Without check_and_run_traps, handler never runs.
2064 check_and_run_traps();
2065 fputs(prompt_str
, stdout
);
2068 G
.user_input_buf
[0] = r
= fgetc(i
->file
);
2069 /*G.user_input_buf[1] = '\0'; - already is and never changed */
2070 } while (G
.flag_SIGINT
);
2071 i
->eof_flag
= (r
== EOF
);
2073 i
->p
= G
.user_input_buf
;
2076 #endif /* INTERACTIVE */
2078 /* This is the magic location that prints prompts
2079 * and gets data back from the user */
2080 static int FAST_FUNC
file_get(struct in_str
*i
)
2084 /* If there is data waiting, eat it up */
2085 if (i
->p
&& *i
->p
) {
2086 #if ENABLE_HUSH_INTERACTIVE
2090 if (i
->eof_flag
&& !*i
->p
)
2092 /* note: ch is never NUL */
2094 /* need to double check i->file because we might be doing something
2095 * more complicated by now, like sourcing or substituting. */
2096 #if ENABLE_HUSH_INTERACTIVE
2097 if (G_interactive_fd
&& i
->file
== stdin
) {
2100 } while (!*i
->p
); /* need non-empty line */
2101 i
->promptmode
= 1; /* PS2 */
2105 do ch
= fgetc(i
->file
); while (ch
== '\0');
2107 debug_printf("file_get: got '%c' %d\n", ch
, ch
);
2112 /* All callers guarantee this routine will never
2113 * be used right after a newline, so prompting is not needed.
2115 static int FAST_FUNC
file_peek(struct in_str
*i
)
2118 if (i
->p
&& *i
->p
) {
2119 if (i
->eof_flag
&& !i
->p
[1])
2122 /* note: ch is never NUL */
2124 do ch
= fgetc(i
->file
); while (ch
== '\0');
2125 i
->eof_flag
= (ch
== EOF
);
2126 i
->peek_buf
[0] = ch
;
2127 i
->peek_buf
[1] = '\0';
2129 debug_printf("file_peek: got '%c' %d\n", ch
, ch
);
2133 static void setup_file_in_str(struct in_str
*i
, FILE *f
)
2135 memset(i
, 0, sizeof(*i
));
2136 i
->peek
= file_peek
;
2138 /* i->promptmode = 0; - PS1 (memset did it) */
2143 static void setup_string_in_str(struct in_str
*i
, const char *s
)
2145 memset(i
, 0, sizeof(*i
));
2146 i
->peek
= static_peek
;
2147 i
->get
= static_get
;
2148 /* i->promptmode = 0; - PS1 (memset did it) */
2150 /* i->eof_flag = 0; */
2157 #define B_CHUNK (32 * sizeof(char*))
2159 static void o_reset_to_empty_unquoted(o_string
*o
)
2162 o
->has_quoted_part
= 0;
2167 static void o_free(o_string
*o
)
2170 memset(o
, 0, sizeof(*o
));
2173 static ALWAYS_INLINE
void o_free_unsafe(o_string
*o
)
2178 static void o_grow_by(o_string
*o
, int len
)
2180 if (o
->length
+ len
> o
->maxlen
) {
2181 o
->maxlen
+= (2*len
> B_CHUNK
? 2*len
: B_CHUNK
);
2182 o
->data
= xrealloc(o
->data
, 1 + o
->maxlen
);
2186 static void o_addchr(o_string
*o
, int ch
)
2188 debug_printf("o_addchr: '%c' o->length=%d o=%p\n", ch
, o
->length
, o
);
2190 o
->data
[o
->length
] = ch
;
2192 o
->data
[o
->length
] = '\0';
2195 static void o_addblock(o_string
*o
, const char *str
, int len
)
2198 memcpy(&o
->data
[o
->length
], str
, len
);
2200 o
->data
[o
->length
] = '\0';
2203 static void o_addstr(o_string
*o
, const char *str
)
2205 o_addblock(o
, str
, strlen(str
));
2209 static void nommu_addchr(o_string
*o
, int ch
)
2215 # define nommu_addchr(o, str) ((void)0)
2218 static void o_addstr_with_NUL(o_string
*o
, const char *str
)
2220 o_addblock(o
, str
, strlen(str
) + 1);
2224 * HUSH_BRACE_EXPANSION code needs corresponding quoting on variable expansion side.
2225 * Currently, "v='{q,w}'; echo $v" erroneously expands braces in $v.
2226 * Apparently, on unquoted $v bash still does globbing
2227 * ("v='*.txt'; echo $v" prints all .txt files),
2228 * but NOT brace expansion! Thus, there should be TWO independent
2229 * quoting mechanisms on $v expansion side: one protects
2230 * $v from brace expansion, and other additionally protects "$v" against globbing.
2231 * We have only second one.
2234 #if ENABLE_HUSH_BRACE_EXPANSION
2235 # define MAYBE_BRACES "{}"
2237 # define MAYBE_BRACES ""
2240 /* My analysis of quoting semantics tells me that state information
2241 * is associated with a destination, not a source.
2243 static void o_addqchr(o_string
*o
, int ch
)
2246 char *found
= strchr("*?[\\" MAYBE_BRACES
, ch
);
2251 o
->data
[o
->length
] = '\\';
2254 o
->data
[o
->length
] = ch
;
2256 o
->data
[o
->length
] = '\0';
2259 static void o_addQchr(o_string
*o
, int ch
)
2262 if ((o
->o_expflags
& EXP_FLAG_ESC_GLOB_CHARS
)
2263 && strchr("*?[\\" MAYBE_BRACES
, ch
)
2266 o
->data
[o
->length
] = '\\';
2270 o
->data
[o
->length
] = ch
;
2272 o
->data
[o
->length
] = '\0';
2275 static void o_addqblock(o_string
*o
, const char *str
, int len
)
2280 int ordinary_cnt
= strcspn(str
, "*?[\\" MAYBE_BRACES
);
2281 if (ordinary_cnt
> len
) /* paranoia */
2283 o_addblock(o
, str
, ordinary_cnt
);
2284 if (ordinary_cnt
== len
)
2285 return; /* NUL is already added by o_addblock */
2286 str
+= ordinary_cnt
;
2287 len
-= ordinary_cnt
+ 1; /* we are processing + 1 char below */
2291 if (ch
) { /* it is necessarily one of "*?[\\" MAYBE_BRACES */
2293 o
->data
[o
->length
] = '\\';
2297 o
->data
[o
->length
] = ch
;
2300 o
->data
[o
->length
] = '\0';
2303 static void o_addQblock(o_string
*o
, const char *str
, int len
)
2305 if (!(o
->o_expflags
& EXP_FLAG_ESC_GLOB_CHARS
)) {
2306 o_addblock(o
, str
, len
);
2309 o_addqblock(o
, str
, len
);
2312 static void o_addQstr(o_string
*o
, const char *str
)
2314 o_addQblock(o
, str
, strlen(str
));
2317 /* A special kind of o_string for $VAR and `cmd` expansion.
2318 * It contains char* list[] at the beginning, which is grown in 16 element
2319 * increments. Actual string data starts at the next multiple of 16 * (char*).
2320 * list[i] contains an INDEX (int!) into this string data.
2321 * It means that if list[] needs to grow, data needs to be moved higher up
2322 * but list[i]'s need not be modified.
2323 * NB: remembering how many list[i]'s you have there is crucial.
2324 * o_finalize_list() operation post-processes this structure - calculates
2325 * and stores actual char* ptrs in list[]. Oh, it NULL terminates it as well.
2327 #if DEBUG_EXPAND || DEBUG_GLOB
2328 static void debug_print_list(const char *prefix
, o_string
*o
, int n
)
2330 char **list
= (char**)o
->data
;
2331 int string_start
= ((n
+ 0xf) & ~0xf) * sizeof(list
[0]);
2335 fdprintf(2, "%s: list:%p n:%d string_start:%d length:%d maxlen:%d glob:%d quoted:%d escape:%d\n",
2336 prefix
, list
, n
, string_start
, o
->length
, o
->maxlen
,
2337 !!(o
->o_expflags
& EXP_FLAG_GLOB
),
2339 !!(o
->o_expflags
& EXP_FLAG_ESC_GLOB_CHARS
));
2342 fdprintf(2, " list[%d]=%d '%s' %p\n", i
, (int)(uintptr_t)list
[i
],
2343 o
->data
+ (int)(uintptr_t)list
[i
] + string_start
,
2344 o
->data
+ (int)(uintptr_t)list
[i
] + string_start
);
2348 const char *p
= o
->data
+ (int)(uintptr_t)list
[n
- 1] + string_start
;
2350 fdprintf(2, " total_sz:%ld\n", (long)((p
+ strlen(p
) + 1) - o
->data
));
2354 # define debug_print_list(prefix, o, n) ((void)0)
2357 /* n = o_save_ptr_helper(str, n) "starts new string" by storing an index value
2358 * in list[n] so that it points past last stored byte so far.
2359 * It returns n+1. */
2360 static int o_save_ptr_helper(o_string
*o
, int n
)
2362 char **list
= (char**)o
->data
;
2366 if (!o
->has_empty_slot
) {
2367 string_start
= ((n
+ 0xf) & ~0xf) * sizeof(list
[0]);
2368 string_len
= o
->length
- string_start
;
2369 if (!(n
& 0xf)) { /* 0, 0x10, 0x20...? */
2370 debug_printf_list("list[%d]=%d string_start=%d (growing)\n", n
, string_len
, string_start
);
2371 /* list[n] points to string_start, make space for 16 more pointers */
2372 o
->maxlen
+= 0x10 * sizeof(list
[0]);
2373 o
->data
= xrealloc(o
->data
, o
->maxlen
+ 1);
2374 list
= (char**)o
->data
;
2375 memmove(list
+ n
+ 0x10, list
+ n
, string_len
);
2376 o
->length
+= 0x10 * sizeof(list
[0]);
2378 debug_printf_list("list[%d]=%d string_start=%d\n",
2379 n
, string_len
, string_start
);
2382 /* We have empty slot at list[n], reuse without growth */
2383 string_start
= ((n
+1 + 0xf) & ~0xf) * sizeof(list
[0]); /* NB: n+1! */
2384 string_len
= o
->length
- string_start
;
2385 debug_printf_list("list[%d]=%d string_start=%d (empty slot)\n",
2386 n
, string_len
, string_start
);
2387 o
->has_empty_slot
= 0;
2389 o
->has_quoted_part
= 0;
2390 list
[n
] = (char*)(uintptr_t)string_len
;
2394 /* "What was our last o_save_ptr'ed position (byte offset relative o->data)?" */
2395 static int o_get_last_ptr(o_string
*o
, int n
)
2397 char **list
= (char**)o
->data
;
2398 int string_start
= ((n
+ 0xf) & ~0xf) * sizeof(list
[0]);
2400 return ((int)(uintptr_t)list
[n
-1]) + string_start
;
2403 #if ENABLE_HUSH_BRACE_EXPANSION
2404 /* There in a GNU extension, GLOB_BRACE, but it is not usable:
2405 * first, it processes even {a} (no commas), second,
2406 * I didn't manage to make it return strings when they don't match
2407 * existing files. Need to re-implement it.
2411 static int glob_needed(const char *s
)
2420 if (*s
== '*' || *s
== '[' || *s
== '?' || *s
== '{')
2426 /* Return pointer to next closing brace or to comma */
2427 static const char *next_brace_sub(const char *cp
)
2431 while (*cp
!= '\0') {
2438 if ((*cp
== '}' && depth
-- == 0) || (*cp
== ',' && depth
== 0))
2444 return *cp
!= '\0' ? cp
: NULL
;
2446 /* Recursive brace globber. Note: may garble pattern[]. */
2447 static int glob_brace(char *pattern
, o_string
*o
, int n
)
2449 char *new_pattern_buf
;
2456 debug_printf_glob("glob_brace('%s')\n", pattern
);
2462 if (*begin
== '{') {
2463 /* Find the first sub-pattern and at the same time
2464 * find the rest after the closing brace */
2465 next
= next_brace_sub(begin
);
2467 /* An illegal expression */
2471 /* "{abc}" with no commas - illegal
2472 * brace expr, disregard and skip it */
2478 if (*begin
== '\\' && begin
[1] != '\0')
2482 debug_printf_glob("begin:%s\n", begin
);
2483 debug_printf_glob("next:%s\n", next
);
2485 /* Now find the end of the whole brace expression */
2487 while (*rest
!= '}') {
2488 rest
= next_brace_sub(rest
);
2490 /* An illegal expression */
2493 debug_printf_glob("rest:%s\n", rest
);
2495 rest_len
= strlen(++rest
) + 1;
2497 /* We are sure the brace expression is well-formed */
2499 /* Allocate working buffer large enough for our work */
2500 new_pattern_buf
= xmalloc(strlen(pattern
));
2502 /* We have a brace expression. BEGIN points to the opening {,
2503 * NEXT points past the terminator of the first element, and REST
2504 * points past the final }. We will accumulate result names from
2505 * recursive runs for each brace alternative in the buffer using
2510 /* Construct the new glob expression */
2513 mempcpy(new_pattern_buf
,
2514 /* We know the prefix for all sub-patterns */
2515 pattern
, begin
- pattern
),
2519 /* Note: glob_brace() may garble new_pattern_buf[].
2520 * That's why we re-copy prefix every time (1st memcpy above).
2522 n
= glob_brace(new_pattern_buf
, o
, n
);
2524 /* We saw the last entry */
2528 next
= next_brace_sub(next
);
2530 free(new_pattern_buf
);
2538 memset(&globdata
, 0, sizeof(globdata
));
2539 gr
= glob(pattern
, 0, NULL
, &globdata
);
2540 debug_printf_glob("glob('%s'):%d\n", pattern
, gr
);
2542 if (gr
== GLOB_NOMATCH
) {
2543 globfree(&globdata
);
2544 /* NB: garbles parameter */
2545 unbackslash(pattern
);
2546 o_addstr_with_NUL(o
, pattern
);
2547 debug_printf_glob("glob pattern '%s' is literal\n", pattern
);
2548 return o_save_ptr_helper(o
, n
);
2550 if (gr
== GLOB_NOSPACE
)
2551 bb_error_msg_and_die(bb_msg_memory_exhausted
);
2552 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
2553 * but we didn't specify it. Paranoia again. */
2554 bb_error_msg_and_die("glob error %d on '%s'", gr
, pattern
);
2556 if (globdata
.gl_pathv
&& globdata
.gl_pathv
[0]) {
2557 char **argv
= globdata
.gl_pathv
;
2559 o_addstr_with_NUL(o
, *argv
);
2560 n
= o_save_ptr_helper(o
, n
);
2566 globfree(&globdata
);
2570 /* Performs globbing on last list[],
2571 * saving each result as a new list[].
2573 static int perform_glob(o_string
*o
, int n
)
2575 char *pattern
, *copy
;
2577 debug_printf_glob("start perform_glob: n:%d o->data:%p\n", n
, o
->data
);
2579 return o_save_ptr_helper(o
, n
);
2580 pattern
= o
->data
+ o_get_last_ptr(o
, n
);
2581 debug_printf_glob("glob pattern '%s'\n", pattern
);
2582 if (!glob_needed(pattern
)) {
2583 /* unbackslash last string in o in place, fix length */
2584 o
->length
= unbackslash(pattern
) - o
->data
;
2585 debug_printf_glob("glob pattern '%s' is literal\n", pattern
);
2586 return o_save_ptr_helper(o
, n
);
2589 copy
= xstrdup(pattern
);
2590 /* "forget" pattern in o */
2591 o
->length
= pattern
- o
->data
;
2592 n
= glob_brace(copy
, o
, n
);
2595 debug_print_list("perform_glob returning", o
, n
);
2599 #else /* !HUSH_BRACE_EXPANSION */
2602 static int glob_needed(const char *s
)
2611 if (*s
== '*' || *s
== '[' || *s
== '?')
2617 /* Performs globbing on last list[],
2618 * saving each result as a new list[].
2620 static int perform_glob(o_string
*o
, int n
)
2626 debug_printf_glob("start perform_glob: n:%d o->data:%p\n", n
, o
->data
);
2628 return o_save_ptr_helper(o
, n
);
2629 pattern
= o
->data
+ o_get_last_ptr(o
, n
);
2630 debug_printf_glob("glob pattern '%s'\n", pattern
);
2631 if (!glob_needed(pattern
)) {
2633 /* unbackslash last string in o in place, fix length */
2634 o
->length
= unbackslash(pattern
) - o
->data
;
2635 debug_printf_glob("glob pattern '%s' is literal\n", pattern
);
2636 return o_save_ptr_helper(o
, n
);
2639 memset(&globdata
, 0, sizeof(globdata
));
2640 /* Can't use GLOB_NOCHECK: it does not unescape the string.
2641 * If we glob "*.\*" and don't find anything, we need
2642 * to fall back to using literal "*.*", but GLOB_NOCHECK
2643 * will return "*.\*"!
2645 gr
= glob(pattern
, 0, NULL
, &globdata
);
2646 debug_printf_glob("glob('%s'):%d\n", pattern
, gr
);
2648 if (gr
== GLOB_NOMATCH
) {
2649 globfree(&globdata
);
2652 if (gr
== GLOB_NOSPACE
)
2653 bb_error_msg_and_die(bb_msg_memory_exhausted
);
2654 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
2655 * but we didn't specify it. Paranoia again. */
2656 bb_error_msg_and_die("glob error %d on '%s'", gr
, pattern
);
2658 if (globdata
.gl_pathv
&& globdata
.gl_pathv
[0]) {
2659 char **argv
= globdata
.gl_pathv
;
2660 /* "forget" pattern in o */
2661 o
->length
= pattern
- o
->data
;
2663 o_addstr_with_NUL(o
, *argv
);
2664 n
= o_save_ptr_helper(o
, n
);
2670 globfree(&globdata
);
2672 debug_print_list("perform_glob returning", o
, n
);
2676 #endif /* !HUSH_BRACE_EXPANSION */
2678 /* If o->o_expflags & EXP_FLAG_GLOB, glob the string so far remembered.
2679 * Otherwise, just finish current list[] and start new */
2680 static int o_save_ptr(o_string
*o
, int n
)
2682 if (o
->o_expflags
& EXP_FLAG_GLOB
) {
2683 /* If o->has_empty_slot, list[n] was already globbed
2684 * (if it was requested back then when it was filled)
2685 * so don't do that again! */
2686 if (!o
->has_empty_slot
)
2687 return perform_glob(o
, n
); /* o_save_ptr_helper is inside */
2689 return o_save_ptr_helper(o
, n
);
2692 /* "Please convert list[n] to real char* ptrs, and NULL terminate it." */
2693 static char **o_finalize_list(o_string
*o
, int n
)
2698 n
= o_save_ptr(o
, n
); /* force growth for list[n] if necessary */
2700 debug_print_list("finalized", o
, n
);
2701 debug_printf_expand("finalized n:%d\n", n
);
2702 list
= (char**)o
->data
;
2703 string_start
= ((n
+ 0xf) & ~0xf) * sizeof(list
[0]);
2707 list
[n
] = o
->data
+ (int)(uintptr_t)list
[n
] + string_start
;
2712 static void free_pipe_list(struct pipe
*pi
);
2714 /* Returns pi->next - next pipe in the list */
2715 static struct pipe
*free_pipe(struct pipe
*pi
)
2720 debug_printf_clean("free_pipe (pid %d)\n", getpid());
2721 for (i
= 0; i
< pi
->num_cmds
; i
++) {
2722 struct command
*command
;
2723 struct redir_struct
*r
, *rnext
;
2725 command
= &pi
->cmds
[i
];
2726 debug_printf_clean(" command %d:\n", i
);
2727 if (command
->argv
) {
2731 for (a
= 0, p
= command
->argv
; *p
; a
++, p
++) {
2732 debug_printf_clean(" argv[%d] = %s\n", a
, *p
);
2735 free_strings(command
->argv
);
2736 //command->argv = NULL;
2738 /* not "else if": on syntax error, we may have both! */
2739 if (command
->group
) {
2740 debug_printf_clean(" begin group (cmd_type:%d)\n",
2742 free_pipe_list(command
->group
);
2743 debug_printf_clean(" end group\n");
2744 //command->group = NULL;
2746 /* else is crucial here.
2747 * If group != NULL, child_func is meaningless */
2748 #if ENABLE_HUSH_FUNCTIONS
2749 else if (command
->child_func
) {
2750 debug_printf_exec("cmd %p releases child func at %p\n", command
, command
->child_func
);
2751 command
->child_func
->parent_cmd
= NULL
;
2755 free(command
->group_as_string
);
2756 //command->group_as_string = NULL;
2758 for (r
= command
->redirects
; r
; r
= rnext
) {
2759 debug_printf_clean(" redirect %d%s",
2760 r
->rd_fd
, redir_table
[r
->rd_type
].descrip
);
2761 /* guard against the case >$FOO, where foo is unset or blank */
2762 if (r
->rd_filename
) {
2763 debug_printf_clean(" fname:'%s'\n", r
->rd_filename
);
2764 free(r
->rd_filename
);
2765 //r->rd_filename = NULL;
2767 debug_printf_clean(" rd_dup:%d\n", r
->rd_dup
);
2771 //command->redirects = NULL;
2773 free(pi
->cmds
); /* children are an array, they get freed all at once */
2777 //pi->cmdtext = NULL;
2785 static void free_pipe_list(struct pipe
*pi
)
2789 debug_printf_clean("pipe reserved word %d\n", pi
->res_word
);
2791 debug_printf_clean("pipe followup code %d\n", pi
->followup
);
2797 /*** Parsing routines ***/
2799 #ifndef debug_print_tree
2800 static void debug_print_tree(struct pipe
*pi
, int lvl
)
2802 static const char *const PIPE
[] = {
2808 static const char *RES
[] = {
2809 [RES_NONE
] = "NONE" ,
2812 [RES_THEN
] = "THEN" ,
2813 [RES_ELIF
] = "ELIF" ,
2814 [RES_ELSE
] = "ELSE" ,
2817 # if ENABLE_HUSH_LOOPS
2818 [RES_FOR
] = "FOR" ,
2819 [RES_WHILE
] = "WHILE",
2820 [RES_UNTIL
] = "UNTIL",
2822 [RES_DONE
] = "DONE" ,
2824 # if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
2827 # if ENABLE_HUSH_CASE
2828 [RES_CASE
] = "CASE" ,
2829 [RES_CASE_IN
] = "CASE_IN" ,
2830 [RES_MATCH
] = "MATCH",
2831 [RES_CASE_BODY
] = "CASE_BODY",
2832 [RES_ESAC
] = "ESAC" ,
2834 [RES_XXXX
] = "XXXX" ,
2835 [RES_SNTX
] = "SNTX" ,
2837 static const char *const CMDTYPE
[] = {
2841 # if ENABLE_HUSH_FUNCTIONS
2850 fdprintf(2, "%*spipe %d res_word=%s followup=%d %s\n", lvl
*2, "",
2851 pin
, RES
[pi
->res_word
], pi
->followup
, PIPE
[pi
->followup
]);
2853 while (prn
< pi
->num_cmds
) {
2854 struct command
*command
= &pi
->cmds
[prn
];
2855 char **argv
= command
->argv
;
2857 fdprintf(2, "%*s cmd %d assignment_cnt:%d",
2859 command
->assignment_cnt
);
2860 if (command
->group
) {
2861 fdprintf(2, " group %s: (argv=%p)%s%s\n",
2862 CMDTYPE
[command
->cmd_type
],
2865 , " group_as_string:", command
->group_as_string
2870 debug_print_tree(command
->group
, lvl
+1);
2874 if (argv
) while (*argv
) {
2875 fdprintf(2, " '%s'", *argv
);
2885 #endif /* debug_print_tree */
2887 static struct pipe
*new_pipe(void)
2890 pi
= xzalloc(sizeof(struct pipe
));
2891 /*pi->followup = 0; - deliberately invalid value */
2892 /*pi->res_word = RES_NONE; - RES_NONE is 0 anyway */
2896 /* Command (member of a pipe) is complete, or we start a new pipe
2897 * if ctx->command is NULL.
2898 * No errors possible here.
2900 static int done_command(struct parse_context
*ctx
)
2902 /* The command is really already in the pipe structure, so
2903 * advance the pipe counter and make a new, null command. */
2904 struct pipe
*pi
= ctx
->pipe
;
2905 struct command
*command
= ctx
->command
;
2908 if (IS_NULL_CMD(command
)) {
2909 debug_printf_parse("done_command: skipping null cmd, num_cmds=%d\n", pi
->num_cmds
);
2913 debug_printf_parse("done_command: ++num_cmds=%d\n", pi
->num_cmds
);
2914 //debug_print_tree(ctx->list_head, 20);
2916 debug_printf_parse("done_command: initializing, num_cmds=%d\n", pi
->num_cmds
);
2919 /* Only real trickiness here is that the uncommitted
2920 * command structure is not counted in pi->num_cmds. */
2921 pi
->cmds
= xrealloc(pi
->cmds
, sizeof(*pi
->cmds
) * (pi
->num_cmds
+1));
2922 ctx
->command
= command
= &pi
->cmds
[pi
->num_cmds
];
2924 memset(command
, 0, sizeof(*command
));
2925 return pi
->num_cmds
; /* used only for 0/nonzero check */
2928 static void done_pipe(struct parse_context
*ctx
, pipe_style type
)
2932 debug_printf_parse("done_pipe entered, followup %d\n", type
);
2933 /* Close previous command */
2934 not_null
= done_command(ctx
);
2935 ctx
->pipe
->followup
= type
;
2937 ctx
->pipe
->pi_inverted
= ctx
->ctx_inverted
;
2938 ctx
->ctx_inverted
= 0;
2939 ctx
->pipe
->res_word
= ctx
->ctx_res_w
;
2942 /* Without this check, even just <enter> on command line generates
2943 * tree of three NOPs (!). Which is harmless but annoying.
2944 * IOW: it is safe to do it unconditionally. */
2947 || ctx
->ctx_res_w
== RES_FI
2949 #if ENABLE_HUSH_LOOPS
2950 || ctx
->ctx_res_w
== RES_DONE
2951 || ctx
->ctx_res_w
== RES_FOR
2952 || ctx
->ctx_res_w
== RES_IN
2954 #if ENABLE_HUSH_CASE
2955 || ctx
->ctx_res_w
== RES_ESAC
2959 debug_printf_parse("done_pipe: adding new pipe: "
2960 "not_null:%d ctx->ctx_res_w:%d\n",
2961 not_null
, ctx
->ctx_res_w
);
2963 ctx
->pipe
->next
= new_p
;
2965 /* RES_THEN, RES_DO etc are "sticky" -
2966 * they remain set for pipes inside if/while.
2967 * This is used to control execution.
2968 * RES_FOR and RES_IN are NOT sticky (needed to support
2969 * cases where variable or value happens to match a keyword):
2971 #if ENABLE_HUSH_LOOPS
2972 if (ctx
->ctx_res_w
== RES_FOR
2973 || ctx
->ctx_res_w
== RES_IN
)
2974 ctx
->ctx_res_w
= RES_NONE
;
2976 #if ENABLE_HUSH_CASE
2977 if (ctx
->ctx_res_w
== RES_MATCH
)
2978 ctx
->ctx_res_w
= RES_CASE_BODY
;
2979 if (ctx
->ctx_res_w
== RES_CASE
)
2980 ctx
->ctx_res_w
= RES_CASE_IN
;
2982 ctx
->command
= NULL
; /* trick done_command below */
2983 /* Create the memory for command, roughly:
2984 * ctx->pipe->cmds = new struct command;
2985 * ctx->command = &ctx->pipe->cmds[0];
2988 //debug_print_tree(ctx->list_head, 10);
2990 debug_printf_parse("done_pipe return\n");
2993 static void initialize_context(struct parse_context
*ctx
)
2995 memset(ctx
, 0, sizeof(*ctx
));
2996 ctx
->pipe
= ctx
->list_head
= new_pipe();
2997 /* Create the memory for command, roughly:
2998 * ctx->pipe->cmds = new struct command;
2999 * ctx->command = &ctx->pipe->cmds[0];
3004 /* If a reserved word is found and processed, parse context is modified
3005 * and 1 is returned.
3008 struct reserved_combo
{
3011 unsigned char assignment_flag
;
3015 FLAG_END
= (1 << RES_NONE
),
3017 FLAG_IF
= (1 << RES_IF
),
3018 FLAG_THEN
= (1 << RES_THEN
),
3019 FLAG_ELIF
= (1 << RES_ELIF
),
3020 FLAG_ELSE
= (1 << RES_ELSE
),
3021 FLAG_FI
= (1 << RES_FI
),
3023 # if ENABLE_HUSH_LOOPS
3024 FLAG_FOR
= (1 << RES_FOR
),
3025 FLAG_WHILE
= (1 << RES_WHILE
),
3026 FLAG_UNTIL
= (1 << RES_UNTIL
),
3027 FLAG_DO
= (1 << RES_DO
),
3028 FLAG_DONE
= (1 << RES_DONE
),
3029 FLAG_IN
= (1 << RES_IN
),
3031 # if ENABLE_HUSH_CASE
3032 FLAG_MATCH
= (1 << RES_MATCH
),
3033 FLAG_ESAC
= (1 << RES_ESAC
),
3035 FLAG_START
= (1 << RES_XXXX
),
3038 static const struct reserved_combo
* match_reserved_word(o_string
*word
)
3040 /* Mostly a list of accepted follow-up reserved words.
3041 * FLAG_END means we are done with the sequence, and are ready
3042 * to turn the compound list into a command.
3043 * FLAG_START means the word must start a new compound list.
3045 static const struct reserved_combo reserved_list
[] = {
3047 { "!", RES_NONE
, NOT_ASSIGNMENT
, 0 },
3048 { "if", RES_IF
, MAYBE_ASSIGNMENT
, FLAG_THEN
| FLAG_START
},
3049 { "then", RES_THEN
, MAYBE_ASSIGNMENT
, FLAG_ELIF
| FLAG_ELSE
| FLAG_FI
},
3050 { "elif", RES_ELIF
, MAYBE_ASSIGNMENT
, FLAG_THEN
},
3051 { "else", RES_ELSE
, MAYBE_ASSIGNMENT
, FLAG_FI
},
3052 { "fi", RES_FI
, NOT_ASSIGNMENT
, FLAG_END
},
3054 # if ENABLE_HUSH_LOOPS
3055 { "for", RES_FOR
, NOT_ASSIGNMENT
, FLAG_IN
| FLAG_DO
| FLAG_START
},
3056 { "while", RES_WHILE
, MAYBE_ASSIGNMENT
, FLAG_DO
| FLAG_START
},
3057 { "until", RES_UNTIL
, MAYBE_ASSIGNMENT
, FLAG_DO
| FLAG_START
},
3058 { "in", RES_IN
, NOT_ASSIGNMENT
, FLAG_DO
},
3059 { "do", RES_DO
, MAYBE_ASSIGNMENT
, FLAG_DONE
},
3060 { "done", RES_DONE
, NOT_ASSIGNMENT
, FLAG_END
},
3062 # if ENABLE_HUSH_CASE
3063 { "case", RES_CASE
, NOT_ASSIGNMENT
, FLAG_MATCH
| FLAG_START
},
3064 { "esac", RES_ESAC
, NOT_ASSIGNMENT
, FLAG_END
},
3067 const struct reserved_combo
*r
;
3069 for (r
= reserved_list
; r
< reserved_list
+ ARRAY_SIZE(reserved_list
); r
++) {
3070 if (strcmp(word
->data
, r
->literal
) == 0)
3075 /* Return 0: not a keyword, 1: keyword
3077 static int reserved_word(o_string
*word
, struct parse_context
*ctx
)
3079 # if ENABLE_HUSH_CASE
3080 static const struct reserved_combo reserved_match
= {
3081 "", RES_MATCH
, NOT_ASSIGNMENT
, FLAG_MATCH
| FLAG_ESAC
3084 const struct reserved_combo
*r
;
3086 if (word
->has_quoted_part
)
3088 r
= match_reserved_word(word
);
3092 debug_printf("found reserved word %s, res %d\n", r
->literal
, r
->res
);
3093 # if ENABLE_HUSH_CASE
3094 if (r
->res
== RES_IN
&& ctx
->ctx_res_w
== RES_CASE_IN
) {
3095 /* "case word IN ..." - IN part starts first MATCH part */
3096 r
= &reserved_match
;
3099 if (r
->flag
== 0) { /* '!' */
3100 if (ctx
->ctx_inverted
) { /* bash doesn't accept '! ! true' */
3101 syntax_error("! ! command");
3102 ctx
->ctx_res_w
= RES_SNTX
;
3104 ctx
->ctx_inverted
= 1;
3107 if (r
->flag
& FLAG_START
) {
3108 struct parse_context
*old
;
3110 old
= xmalloc(sizeof(*old
));
3111 debug_printf_parse("push stack %p\n", old
);
3112 *old
= *ctx
; /* physical copy */
3113 initialize_context(ctx
);
3115 } else if (/*ctx->ctx_res_w == RES_NONE ||*/ !(ctx
->old_flag
& (1 << r
->res
))) {
3116 syntax_error_at(word
->data
);
3117 ctx
->ctx_res_w
= RES_SNTX
;
3120 /* "{...} fi" is ok. "{...} if" is not
3122 * if { echo foo; } then { echo bar; } fi */
3123 if (ctx
->command
->group
)
3124 done_pipe(ctx
, PIPE_SEQ
);
3127 ctx
->ctx_res_w
= r
->res
;
3128 ctx
->old_flag
= r
->flag
;
3129 word
->o_assignment
= r
->assignment_flag
;
3130 debug_printf_parse("word->o_assignment='%s'\n", assignment_flag
[word
->o_assignment
]);
3132 if (ctx
->old_flag
& FLAG_END
) {
3133 struct parse_context
*old
;
3135 done_pipe(ctx
, PIPE_SEQ
);
3136 debug_printf_parse("pop stack %p\n", ctx
->stack
);
3138 old
->command
->group
= ctx
->list_head
;
3139 old
->command
->cmd_type
= CMD_NORMAL
;
3141 o_addstr(&old
->as_string
, ctx
->as_string
.data
);
3142 o_free_unsafe(&ctx
->as_string
);
3143 old
->command
->group_as_string
= xstrdup(old
->as_string
.data
);
3144 debug_printf_parse("pop, remembering as:'%s'\n",
3145 old
->command
->group_as_string
);
3147 *ctx
= *old
; /* physical copy */
3152 #endif /* HAS_KEYWORDS */
3154 /* Word is complete, look at it and update parsing context.
3155 * Normal return is 0. Syntax errors return 1.
3156 * Note: on return, word is reset, but not o_free'd!
3158 static int done_word(o_string
*word
, struct parse_context
*ctx
)
3160 struct command
*command
= ctx
->command
;
3162 debug_printf_parse("done_word entered: '%s' %p\n", word
->data
, command
);
3163 if (word
->length
== 0 && !word
->has_quoted_part
) {
3164 debug_printf_parse("done_word return 0: true null, ignored\n");
3168 if (ctx
->pending_redirect
) {
3169 /* We do not glob in e.g. >*.tmp case. bash seems to glob here
3170 * only if run as "bash", not "sh" */
3171 /* http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
3173 * ...the word that follows the redirection operator
3174 * shall be subjected to tilde expansion, parameter expansion,
3175 * command substitution, arithmetic expansion, and quote
3176 * removal. Pathname expansion shall not be performed
3177 * on the word by a non-interactive shell; an interactive
3178 * shell may perform it, but shall do so only when
3179 * the expansion would result in one word."
3181 ctx
->pending_redirect
->rd_filename
= xstrdup(word
->data
);
3182 /* Cater for >\file case:
3183 * >\a creates file a; >\\a, >"\a", >"\\a" create file \a
3184 * Same with heredocs:
3185 * for <<\H delim is H; <<\\H, <<"\H", <<"\\H" - \H
3187 if (ctx
->pending_redirect
->rd_type
== REDIRECT_HEREDOC
) {
3188 unbackslash(ctx
->pending_redirect
->rd_filename
);
3189 /* Is it <<"HEREDOC"? */
3190 if (word
->has_quoted_part
) {
3191 ctx
->pending_redirect
->rd_dup
|= HEREDOC_QUOTED
;
3194 debug_printf_parse("word stored in rd_filename: '%s'\n", word
->data
);
3195 ctx
->pending_redirect
= NULL
;
3198 # if ENABLE_HUSH_CASE
3199 if (ctx
->ctx_dsemicolon
3200 && strcmp(word
->data
, "esac") != 0 /* not "... pattern) cmd;; esac" */
3202 /* already done when ctx_dsemicolon was set to 1: */
3203 /* ctx->ctx_res_w = RES_MATCH; */
3204 ctx
->ctx_dsemicolon
= 0;
3207 if (!command
->argv
/* if it's the first word... */
3208 # if ENABLE_HUSH_LOOPS
3209 && ctx
->ctx_res_w
!= RES_FOR
/* ...not after FOR or IN */
3210 && ctx
->ctx_res_w
!= RES_IN
3212 # if ENABLE_HUSH_CASE
3213 && ctx
->ctx_res_w
!= RES_CASE
3216 int reserved
= reserved_word(word
, ctx
);
3217 debug_printf_parse("checking for reserved-ness: %d\n", reserved
);
3219 o_reset_to_empty_unquoted(word
);
3220 debug_printf_parse("done_word return %d\n",
3221 (ctx
->ctx_res_w
== RES_SNTX
));
3222 return (ctx
->ctx_res_w
== RES_SNTX
);
3224 # if ENABLE_HUSH_BASH_COMPAT
3225 if (strcmp(word
->data
, "[[") == 0) {
3226 command
->cmd_type
= CMD_SINGLEWORD_NOGLOB
;
3232 if (command
->group
) {
3233 /* "{ echo foo; } echo bar" - bad */
3234 syntax_error_at(word
->data
);
3235 debug_printf_parse("done_word return 1: syntax error, "
3236 "groups and arglists don't mix\n");
3240 /* If this word wasn't an assignment, next ones definitely
3241 * can't be assignments. Even if they look like ones. */
3242 if (word
->o_assignment
!= DEFINITELY_ASSIGNMENT
3243 && word
->o_assignment
!= WORD_IS_KEYWORD
3245 word
->o_assignment
= NOT_ASSIGNMENT
;
3247 if (word
->o_assignment
== DEFINITELY_ASSIGNMENT
) {
3248 command
->assignment_cnt
++;
3249 debug_printf_parse("++assignment_cnt=%d\n", command
->assignment_cnt
);
3251 debug_printf_parse("word->o_assignment was:'%s'\n", assignment_flag
[word
->o_assignment
]);
3252 word
->o_assignment
= MAYBE_ASSIGNMENT
;
3254 debug_printf_parse("word->o_assignment='%s'\n", assignment_flag
[word
->o_assignment
]);
3256 if (word
->has_quoted_part
3257 /* optimization: and if it's ("" or '') or ($v... or `cmd`...): */
3258 && (word
->data
[0] == '\0' || word
->data
[0] == SPECIAL_VAR_SYMBOL
)
3259 /* (otherwise it's known to be not empty and is already safe) */
3261 /* exclude "$@" - it can expand to no word despite "" */
3262 char *p
= word
->data
;
3263 while (p
[0] == SPECIAL_VAR_SYMBOL
3264 && (p
[1] & 0x7f) == '@'
3265 && p
[2] == SPECIAL_VAR_SYMBOL
3270 command
->argv
= add_string_to_strings(command
->argv
, xstrdup(word
->data
));
3271 debug_print_strings("word appended to argv", command
->argv
);
3274 #if ENABLE_HUSH_LOOPS
3275 if (ctx
->ctx_res_w
== RES_FOR
) {
3276 if (word
->has_quoted_part
3277 || !is_well_formed_var_name(command
->argv
[0], '\0')
3279 /* bash says just "not a valid identifier" */
3280 syntax_error("not a valid identifier in for");
3283 /* Force FOR to have just one word (variable name) */
3284 /* NB: basically, this makes hush see "for v in ..."
3285 * syntax as if it is "for v; in ...". FOR and IN become
3286 * two pipe structs in parse tree. */
3287 done_pipe(ctx
, PIPE_SEQ
);
3290 #if ENABLE_HUSH_CASE
3291 /* Force CASE to have just one word */
3292 if (ctx
->ctx_res_w
== RES_CASE
) {
3293 done_pipe(ctx
, PIPE_SEQ
);
3297 o_reset_to_empty_unquoted(word
);
3299 debug_printf_parse("done_word return 0\n");
3304 /* Peek ahead in the input to find out if we have a "&n" construct,
3305 * as in "2>&1", that represents duplicating a file descriptor.
3307 * REDIRFD_CLOSE if >&- "close fd" construct is seen,
3308 * REDIRFD_SYNTAX_ERR if syntax error,
3309 * REDIRFD_TO_FILE if no & was seen,
3310 * or the number found.
3313 #define parse_redir_right_fd(as_string, input) \
3314 parse_redir_right_fd(input)
3316 static int parse_redir_right_fd(o_string
*as_string
, struct in_str
*input
)
3322 return REDIRFD_TO_FILE
;
3324 ch
= i_getch(input
); /* get the & */
3325 nommu_addchr(as_string
, ch
);
3328 ch
= i_getch(input
);
3329 nommu_addchr(as_string
, ch
);
3330 return REDIRFD_CLOSE
;
3334 while (ch
!= EOF
&& isdigit(ch
)) {
3335 d
= d
*10 + (ch
-'0');
3337 ch
= i_getch(input
);
3338 nommu_addchr(as_string
, ch
);
3343 //TODO: this is the place to catch ">&file" bashism (redirect both fd 1 and 2)
3345 bb_error_msg("ambiguous redirect");
3346 return REDIRFD_SYNTAX_ERR
;
3349 /* Return code is 0 normal, 1 if a syntax error is detected
3351 static int parse_redirect(struct parse_context
*ctx
,
3354 struct in_str
*input
)
3356 struct command
*command
= ctx
->command
;
3357 struct redir_struct
*redir
;
3358 struct redir_struct
**redirp
;
3361 dup_num
= REDIRFD_TO_FILE
;
3362 if (style
!= REDIRECT_HEREDOC
) {
3363 /* Check for a '>&1' type redirect */
3364 dup_num
= parse_redir_right_fd(&ctx
->as_string
, input
);
3365 if (dup_num
== REDIRFD_SYNTAX_ERR
)
3368 int ch
= i_peek(input
);
3369 dup_num
= (ch
== '-'); /* HEREDOC_SKIPTABS bit is 1 */
3370 if (dup_num
) { /* <<-... */
3371 ch
= i_getch(input
);
3372 nommu_addchr(&ctx
->as_string
, ch
);
3377 if (style
== REDIRECT_OVERWRITE
&& dup_num
== REDIRFD_TO_FILE
) {
3378 int ch
= i_peek(input
);
3380 /* >|FILE redirect ("clobbering" >).
3381 * Since we do not support "set -o noclobber" yet,
3382 * >| and > are the same for now. Just eat |.
3384 ch
= i_getch(input
);
3385 nommu_addchr(&ctx
->as_string
, ch
);
3389 /* Create a new redir_struct and append it to the linked list */
3390 redirp
= &command
->redirects
;
3391 while ((redir
= *redirp
) != NULL
) {
3392 redirp
= &(redir
->next
);
3394 *redirp
= redir
= xzalloc(sizeof(*redir
));
3395 /* redir->next = NULL; */
3396 /* redir->rd_filename = NULL; */
3397 redir
->rd_type
= style
;
3398 redir
->rd_fd
= (fd
== -1) ? redir_table
[style
].default_fd
: fd
;
3400 debug_printf_parse("redirect type %d %s\n", redir
->rd_fd
,
3401 redir_table
[style
].descrip
);
3403 redir
->rd_dup
= dup_num
;
3404 if (style
!= REDIRECT_HEREDOC
&& dup_num
!= REDIRFD_TO_FILE
) {
3405 /* Erik had a check here that the file descriptor in question
3406 * is legit; I postpone that to "run time"
3407 * A "-" representation of "close me" shows up as a -3 here */
3408 debug_printf_parse("duplicating redirect '%d>&%d'\n",
3409 redir
->rd_fd
, redir
->rd_dup
);
3411 /* Set ctx->pending_redirect, so we know what to do at the
3412 * end of the next parsed word. */
3413 ctx
->pending_redirect
= redir
;
3418 /* If a redirect is immediately preceded by a number, that number is
3419 * supposed to tell which file descriptor to redirect. This routine
3420 * looks for such preceding numbers. In an ideal world this routine
3421 * needs to handle all the following classes of redirects...
3422 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
3423 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
3424 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
3425 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
3427 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
3429 * ... If n is quoted, the number shall not be recognized as part of
3430 * the redirection expression. For example:
3432 * writes the character 2 into file a"
3433 * We are getting it right by setting ->has_quoted_part on any \<char>
3435 * A -1 return means no valid number was found,
3436 * the caller should use the appropriate default for this redirection.
3438 static int redirect_opt_num(o_string
*o
)
3442 if (o
->data
== NULL
)
3444 num
= bb_strtou(o
->data
, NULL
, 10);
3445 if (errno
|| num
< 0)
3447 o_reset_to_empty_unquoted(o
);
3452 #define fetch_till_str(as_string, input, word, skip_tabs) \
3453 fetch_till_str(input, word, skip_tabs)
3455 static char *fetch_till_str(o_string
*as_string
,
3456 struct in_str
*input
,
3460 o_string heredoc
= NULL_O_STRING
;
3462 int prev
= 0; /* not \ */
3468 ch
= i_getch(input
);
3470 nommu_addchr(as_string
, ch
);
3471 if ((ch
== '\n' || ch
== EOF
)
3472 && ((heredoc_flags
& HEREDOC_QUOTED
) || prev
!= '\\')
3474 if (strcmp(heredoc
.data
+ past_EOL
, word
) == 0) {
3475 heredoc
.data
[past_EOL
] = '\0';
3476 debug_printf_parse("parsed heredoc '%s'\n", heredoc
.data
);
3477 return heredoc
.data
;
3479 while (ch
== '\n') {
3480 o_addchr(&heredoc
, ch
);
3483 past_EOL
= heredoc
.length
;
3485 ch
= i_getch(input
);
3487 nommu_addchr(as_string
, ch
);
3488 } while ((heredoc_flags
& HEREDOC_SKIPTABS
) && ch
== '\t');
3492 o_free_unsafe(&heredoc
);
3495 o_addchr(&heredoc
, ch
);
3496 nommu_addchr(as_string
, ch
);
3497 if (prev
== '\\' && ch
== '\\')
3498 /* Correctly handle foo\\<eol> (not a line cont.) */
3499 prev
= 0; /* not \ */
3505 /* Look at entire parse tree for not-yet-loaded REDIRECT_HEREDOCs
3506 * and load them all. There should be exactly heredoc_cnt of them.
3508 static int fetch_heredocs(int heredoc_cnt
, struct parse_context
*ctx
, struct in_str
*input
)
3510 struct pipe
*pi
= ctx
->list_head
;
3512 while (pi
&& heredoc_cnt
) {
3514 struct command
*cmd
= pi
->cmds
;
3516 debug_printf_parse("fetch_heredocs: num_cmds:%d cmd argv0:'%s'\n",
3518 cmd
->argv
? cmd
->argv
[0] : "NONE");
3519 for (i
= 0; i
< pi
->num_cmds
; i
++) {
3520 struct redir_struct
*redir
= cmd
->redirects
;
3522 debug_printf_parse("fetch_heredocs: %d cmd argv0:'%s'\n",
3523 i
, cmd
->argv
? cmd
->argv
[0] : "NONE");
3525 if (redir
->rd_type
== REDIRECT_HEREDOC
) {
3528 redir
->rd_type
= REDIRECT_HEREDOC2
;
3529 /* redir->rd_dup is (ab)used to indicate <<- */
3530 p
= fetch_till_str(&ctx
->as_string
, input
,
3531 redir
->rd_filename
, redir
->rd_dup
);
3533 syntax_error("unexpected EOF in here document");
3536 free(redir
->rd_filename
);
3537 redir
->rd_filename
= p
;
3540 redir
= redir
->next
;
3547 /* Should be 0. If it isn't, it's a parse error */
3549 bb_error_msg_and_die("heredoc BUG 2");
3555 static int run_list(struct pipe
*pi
);
3557 #define parse_stream(pstring, input, end_trigger) \
3558 parse_stream(input, end_trigger)
3560 static struct pipe
*parse_stream(char **pstring
,
3561 struct in_str
*input
,
3565 #if !ENABLE_HUSH_FUNCTIONS
3566 #define parse_group(dest, ctx, input, ch) \
3567 parse_group(ctx, input, ch)
3569 static int parse_group(o_string
*dest
, struct parse_context
*ctx
,
3570 struct in_str
*input
, int ch
)
3572 /* dest contains characters seen prior to ( or {.
3573 * Typically it's empty, but for function defs,
3574 * it contains function name (without '()'). */
3575 struct pipe
*pipe_list
;
3577 struct command
*command
= ctx
->command
;
3579 debug_printf_parse("parse_group entered\n");
3580 #if ENABLE_HUSH_FUNCTIONS
3581 if (ch
== '(' && !dest
->has_quoted_part
) {
3583 if (done_word(dest
, ctx
))
3586 goto skip
; /* (... */
3587 if (command
->argv
[1]) { /* word word ... (... */
3588 syntax_error_unexpected_ch('(');
3591 /* it is "word(..." or "word (..." */
3593 ch
= i_getch(input
);
3594 while (ch
== ' ' || ch
== '\t');
3596 syntax_error_unexpected_ch(ch
);
3599 nommu_addchr(&ctx
->as_string
, ch
);
3601 ch
= i_getch(input
);
3602 while (ch
== ' ' || ch
== '\t' || ch
== '\n');
3604 syntax_error_unexpected_ch(ch
);
3607 nommu_addchr(&ctx
->as_string
, ch
);
3608 command
->cmd_type
= CMD_FUNCDEF
;
3613 #if 0 /* Prevented by caller */
3614 if (command
->argv
/* word [word]{... */
3615 || dest
->length
/* word{... */
3616 || dest
->has_quoted_part
/* ""{... */
3619 debug_printf_parse("parse_group return 1: "
3620 "syntax error, groups and arglists don't mix\n");
3625 #if ENABLE_HUSH_FUNCTIONS
3631 command
->cmd_type
= CMD_SUBSHELL
;
3633 /* bash does not allow "{echo...", requires whitespace */
3634 ch
= i_getch(input
);
3635 if (ch
!= ' ' && ch
!= '\t' && ch
!= '\n') {
3636 syntax_error_unexpected_ch(ch
);
3639 nommu_addchr(&ctx
->as_string
, ch
);
3644 # define as_string NULL
3646 char *as_string
= NULL
;
3648 pipe_list
= parse_stream(&as_string
, input
, endch
);
3651 o_addstr(&ctx
->as_string
, as_string
);
3653 /* empty ()/{} or parse error? */
3654 if (!pipe_list
|| pipe_list
== ERR_PTR
) {
3655 /* parse_stream already emitted error msg */
3658 debug_printf_parse("parse_group return 1: "
3659 "parse_stream returned %p\n", pipe_list
);
3662 command
->group
= pipe_list
;
3664 as_string
[strlen(as_string
) - 1] = '\0'; /* plink ')' or '}' */
3665 command
->group_as_string
= as_string
;
3666 debug_printf_parse("end of group, remembering as:'%s'\n",
3667 command
->group_as_string
);
3671 debug_printf_parse("parse_group return 0\n");
3673 /* command remains "open", available for possible redirects */
3676 #if ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_DOLLAR_OPS
3677 /* Subroutines for copying $(...) and `...` things */
3678 static int add_till_backquote(o_string
*dest
, struct in_str
*input
, int in_dquote
);
3680 static int add_till_single_quote(o_string
*dest
, struct in_str
*input
)
3683 int ch
= i_getch(input
);
3685 syntax_error_unterm_ch('\'');
3693 /* "...\"...`..`...." - do we need to handle "...$(..)..." too? */
3694 static int add_till_double_quote(o_string
*dest
, struct in_str
*input
)
3697 int ch
= i_getch(input
);
3699 syntax_error_unterm_ch('"');
3704 if (ch
== '\\') { /* \x. Copy both chars. */
3706 ch
= i_getch(input
);
3710 if (!add_till_backquote(dest
, input
, /*in_dquote:*/ 1))
3715 //if (ch == '$') ...
3718 /* Process `cmd` - copy contents until "`" is seen. Complicated by
3720 * "Within the backquoted style of command substitution, backslash
3721 * shall retain its literal meaning, except when followed by: '$', '`', or '\'.
3722 * The search for the matching backquote shall be satisfied by the first
3723 * backquote found without a preceding backslash; during this search,
3724 * if a non-escaped backquote is encountered within a shell comment,
3725 * a here-document, an embedded command substitution of the $(command)
3726 * form, or a quoted string, undefined results occur. A single-quoted
3727 * or double-quoted string that begins, but does not end, within the
3728 * "`...`" sequence produces undefined results."
3730 * echo `echo '\'TEST\`echo ZZ\`BEST` \TESTZZBEST
3732 static int add_till_backquote(o_string
*dest
, struct in_str
*input
, int in_dquote
)
3735 int ch
= i_getch(input
);
3739 /* \x. Copy both unless it is \`, \$, \\ and maybe \" */
3740 ch
= i_getch(input
);
3744 && (!in_dquote
|| ch
!= '"')
3746 o_addchr(dest
, '\\');
3750 syntax_error_unterm_ch('`');
3756 /* Process $(cmd) - copy contents until ")" is seen. Complicated by
3757 * quoting and nested ()s.
3758 * "With the $(command) style of command substitution, all characters
3759 * following the open parenthesis to the matching closing parenthesis
3760 * constitute the command. Any valid shell script can be used for command,
3761 * except a script consisting solely of redirections which produces
3762 * unspecified results."
3764 * echo $(echo '(TEST)' BEST) (TEST) BEST
3765 * echo $(echo 'TEST)' BEST) TEST) BEST
3766 * echo $(echo \(\(TEST\) BEST) ((TEST) BEST
3768 * Also adapted to eat ${var%...} and $((...)) constructs, since ... part
3769 * can contain arbitrary constructs, just like $(cmd).
3770 * In bash compat mode, it needs to also be able to stop on ':' or '/'
3771 * for ${var:N[:M]} and ${var/P[/R]} parsing.
3773 #define DOUBLE_CLOSE_CHAR_FLAG 0x80
3774 static int add_till_closing_bracket(o_string
*dest
, struct in_str
*input
, unsigned end_ch
)
3777 char dbl
= end_ch
& DOUBLE_CLOSE_CHAR_FLAG
;
3778 # if ENABLE_HUSH_BASH_COMPAT
3779 char end_char2
= end_ch
>> 8;
3781 end_ch
&= (DOUBLE_CLOSE_CHAR_FLAG
- 1);
3784 ch
= i_getch(input
);
3786 syntax_error_unterm_ch(end_ch
);
3789 if (ch
== end_ch
IF_HUSH_BASH_COMPAT( || ch
== end_char2
)) {
3792 /* we look for closing )) of $((EXPR)) */
3793 if (i_peek(input
) == end_ch
) {
3794 i_getch(input
); /* eat second ')' */
3799 if (ch
== '(' || ch
== '{') {
3800 ch
= (ch
== '(' ? ')' : '}');
3801 if (!add_till_closing_bracket(dest
, input
, ch
))
3807 if (!add_till_single_quote(dest
, input
))
3813 if (!add_till_double_quote(dest
, input
))
3819 if (!add_till_backquote(dest
, input
, /*in_dquote:*/ 0))
3825 /* \x. Copy verbatim. Important for \(, \) */
3826 ch
= i_getch(input
);
3828 syntax_error_unterm_ch(')');
3837 #endif /* ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_DOLLAR_OPS */
3839 /* Return code: 0 for OK, 1 for syntax error */
3841 #define parse_dollar(as_string, dest, input, quote_mask) \
3842 parse_dollar(dest, input, quote_mask)
3843 #define as_string NULL
3845 static int parse_dollar(o_string
*as_string
,
3847 struct in_str
*input
, unsigned char quote_mask
)
3849 int ch
= i_peek(input
); /* first character after the $ */
3851 debug_printf_parse("parse_dollar entered: ch='%c'\n", ch
);
3853 ch
= i_getch(input
);
3854 nommu_addchr(as_string
, ch
);
3856 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
3858 debug_printf_parse(": '%c'\n", ch
);
3859 o_addchr(dest
, ch
| quote_mask
);
3862 if (!isalnum(ch
) && ch
!= '_')
3864 ch
= i_getch(input
);
3865 nommu_addchr(as_string
, ch
);
3867 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
3868 } else if (isdigit(ch
)) {
3870 ch
= i_getch(input
);
3871 nommu_addchr(as_string
, ch
);
3872 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
3873 debug_printf_parse(": '%c'\n", ch
);
3874 o_addchr(dest
, ch
| quote_mask
);
3875 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
3876 } else switch (ch
) {
3878 case '!': /* last bg pid */
3879 case '?': /* last exit code */
3880 case '#': /* number of args */
3881 case '*': /* args */
3882 case '@': /* args */
3883 goto make_one_char_var
;
3885 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
3887 ch
= i_getch(input
); /* eat '{' */
3888 nommu_addchr(as_string
, ch
);
3890 ch
= i_getch(input
); /* first char after '{' */
3891 /* It should be ${?}, or ${#var},
3892 * or even ${?+subst} - operator acting on a special variable,
3893 * or the beginning of variable name.
3896 || (!strchr(_SPECIAL_VARS_STR
, ch
) && !isalnum(ch
)) /* not one of those */
3899 syntax_error_unterm_str("${name}");
3900 debug_printf_parse("parse_dollar return 0: unterminated ${name}\n");
3903 nommu_addchr(as_string
, ch
);
3906 /* It's possible to just call add_till_closing_bracket() at this point.
3907 * However, this regresses some of our testsuite cases
3908 * which check invalid constructs like ${%}.
3909 * Oh well... let's check that the var name part is fine... */
3915 debug_printf_parse(": '%c'\n", ch
);
3917 ch
= i_getch(input
);
3918 nommu_addchr(as_string
, ch
);
3922 if (!isalnum(ch
) && ch
!= '_') {
3924 unsigned char last_ch
;
3925 /* handle parameter expansions
3926 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_02
3928 if (!strchr(VAR_SUBST_OPS
, ch
)) /* ${var<bad_char>... */
3929 goto bad_dollar_syntax
;
3931 /* Eat everything until closing '}' (or ':') */
3933 if (ENABLE_HUSH_BASH_COMPAT
3935 && !strchr(MINUS_PLUS_EQUAL_QUESTION
, i_peek(input
))
3937 /* It's ${var:N[:M]} thing */
3938 end_ch
= '}' * 0x100 + ':';
3940 if (ENABLE_HUSH_BASH_COMPAT
3943 /* It's ${var/[/]pattern[/repl]} thing */
3944 if (i_peek(input
) == '/') { /* ${var//pattern[/repl]}? */
3946 nommu_addchr(as_string
, '/');
3949 end_ch
= '}' * 0x100 + '/';
3955 #if ENABLE_HUSH_DOLLAR_OPS
3956 last_ch
= add_till_closing_bracket(dest
, input
, end_ch
);
3957 if (last_ch
== 0) /* error? */
3960 #error Simple code to only allow ${var} is not implemented
3963 o_addstr(as_string
, dest
->data
+ pos
);
3964 o_addchr(as_string
, last_ch
);
3967 if (ENABLE_HUSH_BASH_COMPAT
&& (end_ch
& 0xff00)) {
3968 /* close the first block: */
3969 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
3970 /* while parsing N from ${var:N[:M]}
3971 * or pattern from ${var/[/]pattern[/repl]} */
3972 if ((end_ch
& 0xff) == last_ch
) {
3973 /* got ':' or '/'- parse the rest */
3978 if (end_ch
== '}' * 0x100 + ':') {
3979 /* it's ${var:N} - emulate :999999999 */
3980 o_addstr(dest
, "999999999");
3981 } /* else: it's ${var/[/]pattern} */
3986 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
3989 #if ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_TICK
3993 ch
= i_getch(input
);
3994 nommu_addchr(as_string
, ch
);
3995 # if ENABLE_SH_MATH_SUPPORT
3996 if (i_peek(input
) == '(') {
3997 ch
= i_getch(input
);
3998 nommu_addchr(as_string
, ch
);
3999 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
4000 o_addchr(dest
, /*quote_mask |*/ '+');
4003 if (!add_till_closing_bracket(dest
, input
, ')' | DOUBLE_CLOSE_CHAR_FLAG
))
4004 return 0; /* error */
4006 o_addstr(as_string
, dest
->data
+ pos
);
4007 o_addchr(as_string
, ')');
4008 o_addchr(as_string
, ')');
4010 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
4014 # if ENABLE_HUSH_TICK
4015 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
4016 o_addchr(dest
, quote_mask
| '`');
4019 if (!add_till_closing_bracket(dest
, input
, ')'))
4020 return 0; /* error */
4022 o_addstr(as_string
, dest
->data
+ pos
);
4023 o_addchr(as_string
, ')');
4025 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
4031 ch
= i_getch(input
);
4032 nommu_addchr(as_string
, ch
);
4034 if (isalnum(ch
)) { /* it's $_name or $_123 */
4039 /* TODO: $_ and $-: */
4040 /* $_ Shell or shell script name; or last argument of last command
4041 * (if last command wasn't a pipe; if it was, bash sets $_ to "");
4042 * but in command's env, set to full pathname used to invoke it */
4043 /* $- Option flags set by set builtin or shell options (-i etc) */
4045 o_addQchr(dest
, '$');
4047 debug_printf_parse("parse_dollar return 1 (ok)\n");
4053 # if ENABLE_HUSH_BASH_COMPAT
4054 #define encode_string(as_string, dest, input, dquote_end, process_bkslash) \
4055 encode_string(dest, input, dquote_end, process_bkslash)
4057 /* only ${var/pattern/repl} (its pattern part) needs additional mode */
4058 #define encode_string(as_string, dest, input, dquote_end, process_bkslash) \
4059 encode_string(dest, input, dquote_end)
4061 #define as_string NULL
4065 # if ENABLE_HUSH_BASH_COMPAT
4066 /* all parameters are needed, no macro tricks */
4068 #define encode_string(as_string, dest, input, dquote_end, process_bkslash) \
4069 encode_string(as_string, dest, input, dquote_end)
4072 static int encode_string(o_string
*as_string
,
4074 struct in_str
*input
,
4076 int process_bkslash
)
4078 #if !ENABLE_HUSH_BASH_COMPAT
4079 const int process_bkslash
= 1;
4085 ch
= i_getch(input
);
4087 nommu_addchr(as_string
, ch
);
4088 if (ch
== dquote_end
) { /* may be only '"' or EOF */
4089 debug_printf_parse("encode_string return 1 (ok)\n");
4092 /* note: can't move it above ch == dquote_end check! */
4094 syntax_error_unterm_ch('"');
4095 return 0; /* error */
4099 next
= i_peek(input
);
4101 debug_printf_parse("\" ch=%c (%d) escape=%d\n",
4102 ch
, ch
, !!(dest
->o_expflags
& EXP_FLAG_ESC_GLOB_CHARS
));
4103 if (process_bkslash
&& ch
== '\\') {
4105 syntax_error("\\<eof>");
4109 * "The backslash retains its special meaning [in "..."]
4110 * only when followed by one of the following characters:
4111 * $, `, ", \, or <newline>. A double quote may be quoted
4112 * within double quotes by preceding it with a backslash."
4113 * NB: in (unquoted) heredoc, above does not apply to ",
4114 * therefore we check for it by "next == dquote_end" cond.
4116 if (next
== dquote_end
|| strchr("$`\\\n", next
)) {
4117 ch
= i_getch(input
); /* eat next */
4119 goto again
; /* skip \<newline> */
4120 } /* else: ch remains == '\\', and we double it below: */
4121 o_addqchr(dest
, ch
); /* \c if c is a glob char, else just c */
4122 nommu_addchr(as_string
, ch
);
4126 if (!parse_dollar(as_string
, dest
, input
, /*quote_mask:*/ 0x80)) {
4127 debug_printf_parse("encode_string return 0: "
4128 "parse_dollar returned 0 (error)\n");
4133 #if ENABLE_HUSH_TICK
4135 //unsigned pos = dest->length;
4136 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
4137 o_addchr(dest
, 0x80 | '`');
4138 if (!add_till_backquote(dest
, input
, /*in_dquote:*/ dquote_end
== '"'))
4139 return 0; /* error */
4140 o_addchr(dest
, SPECIAL_VAR_SYMBOL
);
4141 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
4145 o_addQchr(dest
, ch
);
4151 * Scan input until EOF or end_trigger char.
4152 * Return a list of pipes to execute, or NULL on EOF
4153 * or if end_trigger character is met.
4154 * On syntax error, exit if shell is not interactive,
4155 * reset parsing machinery and start parsing anew,
4156 * or return ERR_PTR.
4158 static struct pipe
*parse_stream(char **pstring
,
4159 struct in_str
*input
,
4162 struct parse_context ctx
;
4163 o_string dest
= NULL_O_STRING
;
4166 /* Single-quote triggers a bypass of the main loop until its mate is
4167 * found. When recursing, quote state is passed in via dest->o_expflags.
4169 debug_printf_parse("parse_stream entered, end_trigger='%c'\n",
4170 end_trigger
? end_trigger
: 'X');
4173 /* If very first arg is "" or '', dest.data may end up NULL.
4174 * Preventing this: */
4175 o_addchr(&dest
, '\0');
4178 /* We used to separate words on $IFS here. This was wrong.
4179 * $IFS is used only for word splitting when $var is expanded,
4180 * here we should use blank chars as separators, not $IFS
4183 if (MAYBE_ASSIGNMENT
!= 0)
4184 dest
.o_assignment
= MAYBE_ASSIGNMENT
;
4185 initialize_context(&ctx
);
4188 const char *is_blank
;
4189 const char *is_special
;
4193 redir_type redir_style
;
4195 ch
= i_getch(input
);
4196 debug_printf_parse(": ch=%c (%d) escape=%d\n",
4197 ch
, ch
, !!(dest
.o_expflags
& EXP_FLAG_ESC_GLOB_CHARS
));
4202 syntax_error_unterm_str("here document");
4205 /* end_trigger == '}' case errors out earlier,
4206 * checking only ')' */
4207 if (end_trigger
== ')') {
4208 syntax_error_unterm_ch('(');
4212 if (done_word(&dest
, &ctx
)) {
4216 done_pipe(&ctx
, PIPE_SEQ
);
4218 /* If we got nothing... */
4219 /* (this makes bare "&" cmd a no-op.
4220 * bash says: "syntax error near unexpected token '&'") */
4221 if (pi
->num_cmds
== 0
4222 IF_HAS_KEYWORDS(&& pi
->res_word
== RES_NONE
)
4228 debug_printf_parse("as_string '%s'\n", ctx
.as_string
.data
);
4230 *pstring
= ctx
.as_string
.data
;
4232 o_free_unsafe(&ctx
.as_string
);
4235 debug_printf_parse("parse_stream return %p\n", pi
);
4238 nommu_addchr(&ctx
.as_string
, ch
);
4242 next
= i_peek(input
);
4244 is_special
= "{}<>;&|()#'" /* special outside of "str" */
4245 "\\$\"" IF_HUSH_TICK("`"); /* always special */
4246 /* Are { and } special here? */
4247 if (ctx
.command
->argv
/* word [word]{... - non-special */
4248 || dest
.length
/* word{... - non-special */
4249 || dest
.has_quoted_part
/* ""{... - non-special */
4250 || (next
!= ';' /* }; - special */
4251 && next
!= ')' /* }) - special */
4252 && next
!= '&' /* }& and }&& ... - special */
4253 && next
!= '|' /* }|| ... - special */
4254 && !strchr(defifs
, next
) /* {word - non-special */
4257 /* They are not special, skip "{}" */
4260 is_special
= strchr(is_special
, ch
);
4261 is_blank
= strchr(defifs
, ch
);
4263 if (!is_special
&& !is_blank
) { /* ordinary char */
4265 o_addQchr(&dest
, ch
);
4266 if ((dest
.o_assignment
== MAYBE_ASSIGNMENT
4267 || dest
.o_assignment
== WORD_IS_KEYWORD
)
4269 && is_well_formed_var_name(dest
.data
, '=')
4271 dest
.o_assignment
= DEFINITELY_ASSIGNMENT
;
4272 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag
[dest
.o_assignment
]);
4278 if (done_word(&dest
, &ctx
)) {
4282 /* Is this a case when newline is simply ignored?
4284 * "cmd | <newline> cmd ..."
4285 * "case ... in <newline> word) ..."
4287 if (IS_NULL_CMD(ctx
.command
)
4288 && dest
.length
== 0 && !dest
.has_quoted_part
4290 /* This newline can be ignored. But...
4291 * Without check #1, interactive shell
4292 * ignores even bare <newline>,
4293 * and shows the continuation prompt:
4294 * ps1_prompt$ <enter>
4295 * ps2> _ <=== wrong, should be ps1
4296 * Without check #2, "cmd & <newline>"
4297 * is similarly mistreated.
4298 * (BTW, this makes "cmd & cmd"
4299 * and "cmd && cmd" non-orthogonal.
4300 * Really, ask yourself, why
4301 * "cmd && <newline>" doesn't start
4302 * cmd but waits for more input?
4305 struct pipe
*pi
= ctx
.list_head
;
4306 if (pi
->num_cmds
!= 0 /* check #1 */
4307 && pi
->followup
!= PIPE_BG
/* check #2 */
4312 /* Treat newline as a command separator. */
4313 done_pipe(&ctx
, PIPE_SEQ
);
4314 debug_printf_parse("heredoc_cnt:%d\n", heredoc_cnt
);
4316 if (fetch_heredocs(heredoc_cnt
, &ctx
, input
)) {
4321 dest
.o_assignment
= MAYBE_ASSIGNMENT
;
4322 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag
[dest
.o_assignment
]);
4324 /* note: if (is_blank) continue;
4325 * will still trigger for us */
4329 /* "cmd}" or "cmd }..." without semicolon or &:
4330 * } is an ordinary char in this case, even inside { cmd; }
4331 * Pathological example: { ""}; } should exec "}" cmd
4334 if (!IS_NULL_CMD(ctx
.command
) /* cmd } */
4335 || dest
.length
!= 0 /* word} */
4336 || dest
.has_quoted_part
/* ""} */
4340 if (!IS_NULL_PIPE(ctx
.pipe
)) /* cmd | } */
4341 goto skip_end_trigger
;
4342 /* else: } does terminate a group */
4345 if (end_trigger
&& end_trigger
== ch
4346 && (ch
!= ';' || heredoc_cnt
== 0)
4347 #if ENABLE_HUSH_CASE
4349 || ctx
.ctx_res_w
!= RES_MATCH
4350 || (!dest
.has_quoted_part
&& strcmp(dest
.data
, "esac") == 0)
4355 /* This is technically valid:
4356 * { cat <<HERE; }; echo Ok
4360 * but we don't support this.
4361 * We require heredoc to be in enclosing {}/(),
4364 syntax_error_unterm_str("here document");
4367 if (done_word(&dest
, &ctx
)) {
4370 done_pipe(&ctx
, PIPE_SEQ
);
4371 dest
.o_assignment
= MAYBE_ASSIGNMENT
;
4372 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag
[dest
.o_assignment
]);
4373 /* Do we sit outside of any if's, loops or case's? */
4375 IF_HAS_KEYWORDS(|| (ctx
.ctx_res_w
== RES_NONE
&& ctx
.old_flag
== 0))
4379 debug_printf_parse("as_string '%s'\n", ctx
.as_string
.data
);
4381 *pstring
= ctx
.as_string
.data
;
4383 o_free_unsafe(&ctx
.as_string
);
4386 debug_printf_parse("parse_stream return %p: "
4387 "end_trigger char found\n",
4389 return ctx
.list_head
;
4396 /* Catch <, > before deciding whether this word is
4397 * an assignment. a=1 2>z b=2: b=2 is still assignment */
4400 redir_fd
= redirect_opt_num(&dest
);
4401 if (done_word(&dest
, &ctx
)) {
4404 redir_style
= REDIRECT_OVERWRITE
;
4406 redir_style
= REDIRECT_APPEND
;
4407 ch
= i_getch(input
);
4408 nommu_addchr(&ctx
.as_string
, ch
);
4411 else if (next
== '(') {
4412 syntax_error(">(process) not supported");
4416 if (parse_redirect(&ctx
, redir_fd
, redir_style
, input
))
4418 continue; /* back to top of while (1) */
4420 redir_fd
= redirect_opt_num(&dest
);
4421 if (done_word(&dest
, &ctx
)) {
4424 redir_style
= REDIRECT_INPUT
;
4426 redir_style
= REDIRECT_HEREDOC
;
4428 debug_printf_parse("++heredoc_cnt=%d\n", heredoc_cnt
);
4429 ch
= i_getch(input
);
4430 nommu_addchr(&ctx
.as_string
, ch
);
4431 } else if (next
== '>') {
4432 redir_style
= REDIRECT_IO
;
4433 ch
= i_getch(input
);
4434 nommu_addchr(&ctx
.as_string
, ch
);
4437 else if (next
== '(') {
4438 syntax_error("<(process) not supported");
4442 if (parse_redirect(&ctx
, redir_fd
, redir_style
, input
))
4444 continue; /* back to top of while (1) */
4446 if (dest
.length
== 0 && !dest
.has_quoted_part
) {
4447 /* skip "#comment" */
4450 if (ch
== EOF
|| ch
== '\n')
4453 /* note: we do not add it to &ctx.as_string */
4455 nommu_addchr(&ctx
.as_string
, '\n');
4456 continue; /* back to top of while (1) */
4461 /* It's "\<newline>" */
4463 /* Remove trailing '\' from ctx.as_string */
4464 ctx
.as_string
.data
[--ctx
.as_string
.length
] = '\0';
4466 ch
= i_getch(input
); /* eat it */
4467 continue; /* back to top of while (1) */
4472 if (dest
.o_assignment
== MAYBE_ASSIGNMENT
4473 /* check that we are not in word in "a=1 2>word b=1": */
4474 && !ctx
.pending_redirect
4476 /* ch is a special char and thus this word
4477 * cannot be an assignment */
4478 dest
.o_assignment
= NOT_ASSIGNMENT
;
4479 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag
[dest
.o_assignment
]);
4482 /* Note: nommu_addchr(&ctx.as_string, ch) is already done */
4485 case '#': /* non-comment #: "echo a#b" etc */
4486 o_addQchr(&dest
, ch
);
4490 syntax_error("\\<eof>");
4493 ch
= i_getch(input
);
4494 /* note: ch != '\n' (that case does not reach this place) */
4495 o_addchr(&dest
, '\\');
4496 /*nommu_addchr(&ctx.as_string, '\\'); - already done */
4497 o_addchr(&dest
, ch
);
4498 nommu_addchr(&ctx
.as_string
, ch
);
4499 /* Example: echo Hello \2>file
4500 * we need to know that word 2 is quoted */
4501 dest
.has_quoted_part
= 1;
4504 if (!parse_dollar(&ctx
.as_string
, &dest
, input
, /*quote_mask:*/ 0)) {
4505 debug_printf_parse("parse_stream parse error: "
4506 "parse_dollar returned 0 (error)\n");
4511 dest
.has_quoted_part
= 1;
4512 if (next
== '\'' && !ctx
.pending_redirect
) {
4513 insert_empty_quoted_str_marker
:
4514 nommu_addchr(&ctx
.as_string
, next
);
4515 i_getch(input
); /* eat second ' */
4516 o_addchr(&dest
, SPECIAL_VAR_SYMBOL
);
4517 o_addchr(&dest
, SPECIAL_VAR_SYMBOL
);
4520 ch
= i_getch(input
);
4522 syntax_error_unterm_ch('\'');
4525 nommu_addchr(&ctx
.as_string
, ch
);
4528 o_addqchr(&dest
, ch
);
4533 dest
.has_quoted_part
= 1;
4534 if (next
== '"' && !ctx
.pending_redirect
)
4535 goto insert_empty_quoted_str_marker
;
4536 if (dest
.o_assignment
== NOT_ASSIGNMENT
)
4537 dest
.o_expflags
|= EXP_FLAG_ESC_GLOB_CHARS
;
4538 if (!encode_string(&ctx
.as_string
, &dest
, input
, '"', /*process_bkslash:*/ 1))
4540 dest
.o_expflags
&= ~EXP_FLAG_ESC_GLOB_CHARS
;
4542 #if ENABLE_HUSH_TICK
4544 USE_FOR_NOMMU(unsigned pos
;)
4546 o_addchr(&dest
, SPECIAL_VAR_SYMBOL
);
4547 o_addchr(&dest
, '`');
4548 USE_FOR_NOMMU(pos
= dest
.length
;)
4549 if (!add_till_backquote(&dest
, input
, /*in_dquote:*/ 0))
4552 o_addstr(&ctx
.as_string
, dest
.data
+ pos
);
4553 o_addchr(&ctx
.as_string
, '`');
4555 o_addchr(&dest
, SPECIAL_VAR_SYMBOL
);
4556 //debug_printf_subst("SUBST RES3 '%s'\n", dest.data + pos);
4561 #if ENABLE_HUSH_CASE
4564 if (done_word(&dest
, &ctx
)) {
4567 done_pipe(&ctx
, PIPE_SEQ
);
4568 #if ENABLE_HUSH_CASE
4569 /* Eat multiple semicolons, detect
4570 * whether it means something special */
4575 ch
= i_getch(input
);
4576 nommu_addchr(&ctx
.as_string
, ch
);
4577 if (ctx
.ctx_res_w
== RES_CASE_BODY
) {
4578 ctx
.ctx_dsemicolon
= 1;
4579 ctx
.ctx_res_w
= RES_MATCH
;
4585 /* We just finished a cmd. New one may start
4586 * with an assignment */
4587 dest
.o_assignment
= MAYBE_ASSIGNMENT
;
4588 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag
[dest
.o_assignment
]);
4591 if (done_word(&dest
, &ctx
)) {
4595 ch
= i_getch(input
);
4596 nommu_addchr(&ctx
.as_string
, ch
);
4597 done_pipe(&ctx
, PIPE_AND
);
4599 done_pipe(&ctx
, PIPE_BG
);
4603 if (done_word(&dest
, &ctx
)) {
4606 #if ENABLE_HUSH_CASE
4607 if (ctx
.ctx_res_w
== RES_MATCH
)
4608 break; /* we are in case's "word | word)" */
4610 if (next
== '|') { /* || */
4611 ch
= i_getch(input
);
4612 nommu_addchr(&ctx
.as_string
, ch
);
4613 done_pipe(&ctx
, PIPE_OR
);
4615 /* we could pick up a file descriptor choice here
4616 * with redirect_opt_num(), but bash doesn't do it.
4617 * "echo foo 2| cat" yields "foo 2". */
4620 o_reset_to_empty_unquoted(&ctx
.as_string
);
4625 #if ENABLE_HUSH_CASE
4626 /* "case... in [(]word)..." - skip '(' */
4627 if (ctx
.ctx_res_w
== RES_MATCH
4628 && ctx
.command
->argv
== NULL
/* not (word|(... */
4629 && dest
.length
== 0 /* not word(... */
4630 && dest
.has_quoted_part
== 0 /* not ""(... */
4636 if (parse_group(&dest
, &ctx
, input
, ch
) != 0) {
4641 #if ENABLE_HUSH_CASE
4642 if (ctx
.ctx_res_w
== RES_MATCH
)
4646 /* proper use of this character is caught by end_trigger:
4647 * if we see {, we call parse_group(..., end_trigger='}')
4648 * and it will match } earlier (not here). */
4649 syntax_error_unexpected_ch(ch
);
4653 bb_error_msg_and_die("BUG: unexpected %c\n", ch
);
4659 struct parse_context
*pctx
;
4660 IF_HAS_KEYWORDS(struct parse_context
*p2
;)
4662 /* Clean up allocated tree.
4663 * Sample for finding leaks on syntax error recovery path.
4664 * Run it from interactive shell, watch pmap `pidof hush`.
4665 * while if false; then false; fi; do break; fi
4666 * Samples to catch leaks at execution:
4667 * while if (true | {true;}); then echo ok; fi; do break; done
4668 * while if (true | {true;}); then echo ok; fi; do (if echo ok; break; then :; fi) | cat; break; done
4672 /* Update pipe/command counts,
4673 * otherwise freeing may miss some */
4674 done_pipe(pctx
, PIPE_SEQ
);
4675 debug_printf_clean("freeing list %p from ctx %p\n",
4676 pctx
->list_head
, pctx
);
4677 debug_print_tree(pctx
->list_head
, 0);
4678 free_pipe_list(pctx
->list_head
);
4679 debug_printf_clean("freed list %p\n", pctx
->list_head
);
4681 o_free_unsafe(&pctx
->as_string
);
4683 IF_HAS_KEYWORDS(p2
= pctx
->stack
;)
4687 IF_HAS_KEYWORDS(pctx
= p2
;)
4688 } while (HAS_KEYWORDS
&& pctx
);
4691 G
.last_exitcode
= 1;
4702 /*** Execution routines ***/
4704 /* Expansion can recurse, need forward decls: */
4705 #if !ENABLE_HUSH_BASH_COMPAT
4706 /* only ${var/pattern/repl} (its pattern part) needs additional mode */
4707 #define expand_string_to_string(str, do_unbackslash) \
4708 expand_string_to_string(str)
4710 static char *expand_string_to_string(const char *str
, int do_unbackslash
);
4711 #if ENABLE_HUSH_TICK
4712 static int process_command_subs(o_string
*dest
, const char *s
);
4715 /* expand_strvec_to_strvec() takes a list of strings, expands
4716 * all variable references within and returns a pointer to
4717 * a list of expanded strings, possibly with larger number
4718 * of strings. (Think VAR="a b"; echo $VAR).
4719 * This new list is allocated as a single malloc block.
4720 * NULL-terminated list of char* pointers is at the beginning of it,
4721 * followed by strings themselves.
4722 * Caller can deallocate entire list by single free(list). */
4724 /* A horde of its helpers come first: */
4726 static void o_addblock_duplicate_backslash(o_string
*o
, const char *str
, int len
)
4728 while (--len
>= 0) {
4731 #if ENABLE_HUSH_BRACE_EXPANSION
4732 if (c
== '{' || c
== '}') {
4733 /* { -> \{, } -> \} */
4735 /* And now we want to add { or } and continue:
4738 * luckily, just falling throught achieves this.
4744 /* \z -> \\\z; \<eol> -> \\<eol> */
4749 o_addchr(o
, *str
++);
4755 /* Store given string, finalizing the word and starting new one whenever
4756 * we encounter IFS char(s). This is used for expanding variable values.
4757 * End-of-string does NOT finalize word: think about 'echo -$VAR-'.
4758 * Return in *ended_with_ifs:
4759 * 1 - ended with IFS char, else 0 (this includes case of empty str).
4761 static int expand_on_ifs(int *ended_with_ifs
, o_string
*output
, int n
, const char *str
)
4763 int last_is_ifs
= 0;
4768 if (!*str
) /* EOL - do not finalize word */
4770 word_len
= strcspn(str
, G
.ifs
);
4772 /* We have WORD_LEN leading non-IFS chars */
4773 if (!(output
->o_expflags
& EXP_FLAG_GLOB
)) {
4774 o_addblock(output
, str
, word_len
);
4776 /* Protect backslashes against globbing up :)
4777 * Example: "v='\*'; echo b$v" prints "b\*"
4778 * (and does not try to glob on "*")
4780 o_addblock_duplicate_backslash(output
, str
, word_len
);
4781 /*/ Why can't we do it easier? */
4782 /*o_addblock(output, str, word_len); - WRONG: "v='\*'; echo Z$v" prints "Z*" instead of "Z\*" */
4783 /*o_addqblock(output, str, word_len); - WRONG: "v='*'; echo Z$v" prints "Z*" instead of Z* files */
4787 if (!*str
) /* EOL - do not finalize word */
4791 /* We know str here points to at least one IFS char */
4793 str
+= strspn(str
, G
.ifs
); /* skip IFS chars */
4794 if (!*str
) /* EOL - do not finalize word */
4797 /* Start new word... but not always! */
4798 /* Case "v=' a'; echo ''$v": we do need to finalize empty word: */
4799 if (output
->has_quoted_part
4800 /* Case "v=' a'; echo $v":
4801 * here nothing precedes the space in $v expansion,
4802 * therefore we should not finish the word
4803 * (IOW: if there *is* word to finalize, only then do it):
4805 || (n
> 0 && output
->data
[output
->length
- 1])
4807 o_addchr(output
, '\0');
4808 debug_print_list("expand_on_ifs", output
, n
);
4809 n
= o_save_ptr(output
, n
);
4814 *ended_with_ifs
= last_is_ifs
;
4815 debug_print_list("expand_on_ifs[1]", output
, n
);
4819 /* Helper to expand $((...)) and heredoc body. These act as if
4820 * they are in double quotes, with the exception that they are not :).
4821 * Just the rules are similar: "expand only $var and `cmd`"
4823 * Returns malloced string.
4824 * As an optimization, we return NULL if expansion is not needed.
4826 #if !ENABLE_HUSH_BASH_COMPAT
4827 /* only ${var/pattern/repl} (its pattern part) needs additional mode */
4828 #define encode_then_expand_string(str, process_bkslash, do_unbackslash) \
4829 encode_then_expand_string(str)
4831 static char *encode_then_expand_string(const char *str
, int process_bkslash
, int do_unbackslash
)
4834 struct in_str input
;
4835 o_string dest
= NULL_O_STRING
;
4837 if (!strchr(str
, '$')
4838 && !strchr(str
, '\\')
4839 #if ENABLE_HUSH_TICK
4840 && !strchr(str
, '`')
4846 /* We need to expand. Example:
4847 * echo $(($a + `echo 1`)) $((1 + $((2)) ))
4849 setup_string_in_str(&input
, str
);
4850 encode_string(NULL
, &dest
, &input
, EOF
, process_bkslash
);
4851 //TODO: error check (encode_string returns 0 on error)?
4852 //bb_error_msg("'%s' -> '%s'", str, dest.data);
4853 exp_str
= expand_string_to_string(dest
.data
, /*unbackslash:*/ do_unbackslash
);
4854 //bb_error_msg("'%s' -> '%s'", dest.data, exp_str);
4855 o_free_unsafe(&dest
);
4859 #if ENABLE_SH_MATH_SUPPORT
4860 static arith_t
expand_and_evaluate_arith(const char *arg
, const char **errmsg_p
)
4862 arith_state_t math_state
;
4866 math_state
.lookupvar
= get_local_var_value
;
4867 math_state
.setvar
= set_local_var_from_halves
;
4868 //math_state.endofname = endofname;
4869 exp_str
= encode_then_expand_string(arg
, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
4870 res
= arith(&math_state
, exp_str
? exp_str
: arg
);
4873 *errmsg_p
= math_state
.errmsg
;
4874 if (math_state
.errmsg
)
4875 die_if_script(math_state
.errmsg
);
4880 #if ENABLE_HUSH_BASH_COMPAT
4881 /* ${var/[/]pattern[/repl]} helpers */
4882 static char *strstr_pattern(char *val
, const char *pattern
, int *size
)
4885 char *end
= scan_and_match(val
, pattern
, SCAN_MOVE_FROM_RIGHT
+ SCAN_MATCH_LEFT_HALF
);
4886 debug_printf_varexp("val:'%s' pattern:'%s' end:'%s'\n", val
, pattern
, end
);
4893 /* Optimization: if "*pat" did not match the start of "string",
4894 * we know that "tring", "ring" etc will not match too:
4896 if (pattern
[0] == '*')
4901 static char *replace_pattern(char *val
, const char *pattern
, const char *repl
, char exp_op
)
4903 char *result
= NULL
;
4904 unsigned res_len
= 0;
4905 unsigned repl_len
= strlen(repl
);
4909 char *s
= strstr_pattern(val
, pattern
, &size
);
4913 result
= xrealloc(result
, res_len
+ (s
- val
) + repl_len
+ 1);
4914 memcpy(result
+ res_len
, val
, s
- val
);
4916 strcpy(result
+ res_len
, repl
);
4917 res_len
+= repl_len
;
4918 debug_printf_varexp("val:'%s' s:'%s' result:'%s'\n", val
, s
, result
);
4924 if (val
[0] && result
) {
4925 result
= xrealloc(result
, res_len
+ strlen(val
) + 1);
4926 strcpy(result
+ res_len
, val
);
4927 debug_printf_varexp("val:'%s' result:'%s'\n", val
, result
);
4929 debug_printf_varexp("result:'%s'\n", result
);
4935 * Handles <SPECIAL_VAR_SYMBOL>varname...<SPECIAL_VAR_SYMBOL> construct.
4937 static NOINLINE
const char *expand_one_var(char **to_be_freed_pp
, char *arg
, char **pp
)
4939 const char *val
= NULL
;
4940 char *to_be_freed
= NULL
;
4945 char exp_save
= exp_save
; /* for compiler */
4946 char *exp_saveptr
; /* points to expansion operator */
4947 char *exp_word
= exp_word
; /* for compiler */
4950 *p
= '\0'; /* replace trailing SPECIAL_VAR_SYMBOL */
4952 exp_saveptr
= arg
[1] ? strchr(VAR_ENCODED_SUBST_OPS
, arg
[1]) : NULL
;
4954 first_char
= arg
[0] = arg0
& 0x7f;
4957 if (first_char
== '#' /* ${#... */
4958 && arg
[1] && !exp_saveptr
/* not ${#} and not ${#<op_char>...} */
4960 /* It must be length operator: ${#var} */
4964 /* Maybe handle parameter expansion */
4965 if (exp_saveptr
/* if 2nd char is one of expansion operators */
4966 && strchr(NUMERIC_SPECVARS_STR
, first_char
) /* 1st char is special variable */
4968 /* ${?:0}, ${#[:]%0} etc */
4969 exp_saveptr
= var
+ 1;
4971 /* ${?}, ${var}, ${var:0}, ${var[:]%0} etc */
4972 exp_saveptr
= var
+1 + strcspn(var
+1, VAR_ENCODED_SUBST_OPS
);
4974 exp_op
= exp_save
= *exp_saveptr
;
4976 exp_word
= exp_saveptr
+ 1;
4977 if (exp_op
== ':') {
4978 exp_op
= *exp_word
++;
4979 //TODO: try ${var:} and ${var:bogus} in non-bash config
4980 if (ENABLE_HUSH_BASH_COMPAT
4981 && (!exp_op
|| !strchr(MINUS_PLUS_EQUAL_QUESTION
, exp_op
))
4983 /* oops... it's ${var:N[:M]}, not ${var:?xxx} or some such */
4988 *exp_saveptr
= '\0';
4989 } /* else: it's not an expansion op, but bare ${var} */
4992 /* Look up the variable in question */
4993 if (isdigit(var
[0])) {
4994 /* parse_dollar should have vetted var for us */
4995 int n
= xatoi_positive(var
);
4996 if (n
< G
.global_argc
)
4997 val
= G
.global_argv
[n
];
4998 /* else val remains NULL: $N with too big N */
5002 val
= utoa(G
.root_pid
);
5004 case '!': /* bg pid */
5005 val
= G
.last_bg_pid
? utoa(G
.last_bg_pid
) : "";
5007 case '?': /* exitcode */
5008 val
= utoa(G
.last_exitcode
);
5010 case '#': /* argc */
5011 val
= utoa(G
.global_argc
? G
.global_argc
-1 : 0);
5014 val
= get_local_var_value(var
);
5018 /* Handle any expansions */
5019 if (exp_op
== 'L') {
5020 debug_printf_expand("expand: length(%s)=", val
);
5021 val
= utoa(val
? strlen(val
) : 0);
5022 debug_printf_expand("%s\n", val
);
5023 } else if (exp_op
) {
5024 if (exp_op
== '%' || exp_op
== '#') {
5025 /* Standard-mandated substring removal ops:
5026 * ${parameter%word} - remove smallest suffix pattern
5027 * ${parameter%%word} - remove largest suffix pattern
5028 * ${parameter#word} - remove smallest prefix pattern
5029 * ${parameter##word} - remove largest prefix pattern
5031 * Word is expanded to produce a glob pattern.
5032 * Then var's value is matched to it and matching part removed.
5034 if (val
&& val
[0]) {
5038 unsigned scan_flags
= pick_scan(exp_op
, *exp_word
);
5039 if (exp_op
== *exp_word
) /* ## or %% */
5041 exp_exp_word
= encode_then_expand_string(exp_word
, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
5043 exp_word
= exp_exp_word
;
5044 /* HACK ALERT. We depend here on the fact that
5045 * G.global_argv and results of utoa and get_local_var_value
5046 * are actually in writable memory:
5047 * scan_and_match momentarily stores NULs there. */
5049 loc
= scan_and_match(t
, exp_word
, scan_flags
);
5050 //bb_error_msg("op:%c str:'%s' pat:'%s' res:'%s'",
5051 // exp_op, t, exp_word, loc);
5053 if (loc
) { /* match was found */
5054 if (scan_flags
& SCAN_MATCH_LEFT_HALF
) /* #[#] */
5055 val
= loc
; /* take right part */
5057 val
= to_be_freed
= xstrndup(val
, loc
- val
); /* left */
5061 #if ENABLE_HUSH_BASH_COMPAT
5062 else if (exp_op
== '/' || exp_op
== '\\') {
5063 /* It's ${var/[/]pattern[/repl]} thing.
5064 * Note that in encoded form it has TWO parts:
5065 * var/pattern<SPECIAL_VAR_SYMBOL>repl<SPECIAL_VAR_SYMBOL>
5066 * and if // is used, it is encoded as \:
5067 * var\pattern<SPECIAL_VAR_SYMBOL>repl<SPECIAL_VAR_SYMBOL>
5069 /* Empty variable always gives nothing: */
5070 // "v=''; echo ${v/*/w}" prints "", not "w"
5071 if (val
&& val
[0]) {
5072 /* pattern uses non-standard expansion.
5073 * repl should be unbackslashed and globbed
5074 * by the usual expansion rules:
5076 * v='a bz'; echo "${v/a*z/a*z}" prints "a*z"
5077 * v='a bz'; echo "${v/a*z/\z}" prints "\z"
5078 * v='a bz'; echo ${v/a*z/a*z} prints "az"
5079 * v='a bz'; echo ${v/a*z/\z} prints "z"
5080 * (note that a*z _pattern_ is never globbed!)
5082 char *pattern
, *repl
, *t
;
5083 pattern
= encode_then_expand_string(exp_word
, /*process_bkslash:*/ 0, /*unbackslash:*/ 0);
5085 pattern
= xstrdup(exp_word
);
5086 debug_printf_varexp("pattern:'%s'->'%s'\n", exp_word
, pattern
);
5087 *p
++ = SPECIAL_VAR_SYMBOL
;
5089 p
= strchr(p
, SPECIAL_VAR_SYMBOL
);
5091 repl
= encode_then_expand_string(exp_word
, /*process_bkslash:*/ arg0
& 0x80, /*unbackslash:*/ 1);
5092 debug_printf_varexp("repl:'%s'->'%s'\n", exp_word
, repl
);
5093 /* HACK ALERT. We depend here on the fact that
5094 * G.global_argv and results of utoa and get_local_var_value
5095 * are actually in writable memory:
5096 * replace_pattern momentarily stores NULs there. */
5098 to_be_freed
= replace_pattern(t
,
5100 (repl
? repl
: exp_word
),
5102 if (to_be_freed
) /* at least one replace happened */
5109 else if (exp_op
== ':') {
5110 #if ENABLE_HUSH_BASH_COMPAT && ENABLE_SH_MATH_SUPPORT
5111 /* It's ${var:N[:M]} bashism.
5112 * Note that in encoded form it has TWO parts:
5113 * var:N<SPECIAL_VAR_SYMBOL>M<SPECIAL_VAR_SYMBOL>
5118 beg
= expand_and_evaluate_arith(exp_word
, &errmsg
);
5121 debug_printf_varexp("beg:'%s'=%lld\n", exp_word
, (long long)beg
);
5122 *p
++ = SPECIAL_VAR_SYMBOL
;
5124 p
= strchr(p
, SPECIAL_VAR_SYMBOL
);
5126 len
= expand_and_evaluate_arith(exp_word
, &errmsg
);
5129 debug_printf_varexp("len:'%s'=%lld\n", exp_word
, (long long)len
);
5130 if (len
>= 0) { /* bash compat: len < 0 is illegal */
5131 if (beg
< 0) /* bash compat */
5133 debug_printf_varexp("from val:'%s'\n", val
);
5134 if (len
== 0 || !val
|| beg
>= strlen(val
)) {
5138 /* Paranoia. What if user entered 9999999999999
5139 * which fits in arith_t but not int? */
5142 val
= to_be_freed
= xstrndup(val
+ beg
, len
);
5144 debug_printf_varexp("val:'%s'\n", val
);
5148 die_if_script("malformed ${%s:...}", var
);
5151 } else { /* one of "-=+?" */
5152 /* Standard-mandated substitution ops:
5153 * ${var?word} - indicate error if unset
5154 * If var is unset, word (or a message indicating it is unset
5155 * if word is null) is written to standard error
5156 * and the shell exits with a non-zero exit status.
5157 * Otherwise, the value of var is substituted.
5158 * ${var-word} - use default value
5159 * If var is unset, word is substituted.
5160 * ${var=word} - assign and use default value
5161 * If var is unset, word is assigned to var.
5162 * In all cases, final value of var is substituted.
5163 * ${var+word} - use alternative value
5164 * If var is unset, null is substituted.
5165 * Otherwise, word is substituted.
5167 * Word is subjected to tilde expansion, parameter expansion,
5168 * command substitution, and arithmetic expansion.
5169 * If word is not needed, it is not expanded.
5171 * Colon forms (${var:-word}, ${var:=word} etc) do the same,
5172 * but also treat null var as if it is unset.
5174 int use_word
= (!val
|| ((exp_save
== ':') && !val
[0]));
5176 use_word
= !use_word
;
5177 debug_printf_expand("expand: op:%c (null:%s) test:%i\n", exp_op
,
5178 (exp_save
== ':') ? "true" : "false", use_word
);
5180 to_be_freed
= encode_then_expand_string(exp_word
, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
5182 exp_word
= to_be_freed
;
5183 if (exp_op
== '?') {
5184 /* mimic bash message */
5185 die_if_script("%s: %s",
5187 exp_word
[0] ? exp_word
: "parameter null or not set"
5189 //TODO: how interactive bash aborts expansion mid-command?
5194 if (exp_op
== '=') {
5195 /* ${var=[word]} or ${var:=[word]} */
5196 if (isdigit(var
[0]) || var
[0] == '#') {
5197 /* mimic bash message */
5198 die_if_script("$%s: cannot assign in this way", var
);
5201 char *new_var
= xasprintf("%s=%s", var
, val
);
5202 set_local_var(new_var
, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
5206 } /* one of "-=+?" */
5208 *exp_saveptr
= exp_save
;
5214 *to_be_freed_pp
= to_be_freed
;
5218 /* Expand all variable references in given string, adding words to list[]
5219 * at n, n+1,... positions. Return updated n (so that list[n] is next one
5220 * to be filled). This routine is extremely tricky: has to deal with
5221 * variables/parameters with whitespace, $* and $@, and constructs like
5222 * 'echo -$*-'. If you play here, you must run testsuite afterwards! */
5223 static NOINLINE
int expand_vars_to_list(o_string
*output
, int n
, char *arg
)
5225 /* output->o_expflags & EXP_FLAG_SINGLEWORD (0x80) if we are in
5226 * expansion of right-hand side of assignment == 1-element expand.
5228 char cant_be_null
= 0; /* only bit 0x80 matters */
5229 int ended_in_ifs
= 0; /* did last unquoted expansion end with IFS chars? */
5232 debug_printf_expand("expand_vars_to_list: arg:'%s' singleword:%x\n", arg
,
5233 !!(output
->o_expflags
& EXP_FLAG_SINGLEWORD
));
5234 debug_print_list("expand_vars_to_list", output
, n
);
5235 n
= o_save_ptr(output
, n
);
5236 debug_print_list("expand_vars_to_list[0]", output
, n
);
5238 while ((p
= strchr(arg
, SPECIAL_VAR_SYMBOL
)) != NULL
) {
5240 char *to_be_freed
= NULL
;
5241 const char *val
= NULL
;
5242 #if ENABLE_HUSH_TICK
5243 o_string subst_result
= NULL_O_STRING
;
5245 #if ENABLE_SH_MATH_SUPPORT
5246 char arith_buf
[sizeof(arith_t
)*3 + 2];
5250 o_addchr(output
, '\0');
5251 n
= o_save_ptr(output
, n
);
5255 o_addblock(output
, arg
, p
- arg
);
5256 debug_print_list("expand_vars_to_list[1]", output
, n
);
5258 p
= strchr(p
, SPECIAL_VAR_SYMBOL
);
5260 /* Fetch special var name (if it is indeed one of them)
5261 * and quote bit, force the bit on if singleword expansion -
5262 * important for not getting v=$@ expand to many words. */
5263 first_ch
= arg
[0] | (output
->o_expflags
& EXP_FLAG_SINGLEWORD
);
5265 /* Is this variable quoted and thus expansion can't be null?
5266 * "$@" is special. Even if quoted, it can still
5267 * expand to nothing (not even an empty string),
5268 * thus it is excluded. */
5269 if ((first_ch
& 0x7f) != '@')
5270 cant_be_null
|= first_ch
;
5272 switch (first_ch
& 0x7f) {
5273 /* Highest bit in first_ch indicates that var is double-quoted */
5277 if (!G
.global_argv
[1])
5280 cant_be_null
|= first_ch
; /* do it for "$@" _now_, when we know it's not empty */
5281 if (!(first_ch
& 0x80)) { /* unquoted $* or $@ */
5282 while (G
.global_argv
[i
]) {
5283 n
= expand_on_ifs(NULL
, output
, n
, G
.global_argv
[i
]);
5284 debug_printf_expand("expand_vars_to_list: argv %d (last %d)\n", i
, G
.global_argc
- 1);
5285 if (G
.global_argv
[i
++][0] && G
.global_argv
[i
]) {
5286 /* this argv[] is not empty and not last:
5287 * put terminating NUL, start new word */
5288 o_addchr(output
, '\0');
5289 debug_print_list("expand_vars_to_list[2]", output
, n
);
5290 n
= o_save_ptr(output
, n
);
5291 debug_print_list("expand_vars_to_list[3]", output
, n
);
5295 /* If EXP_FLAG_SINGLEWORD, we handle assignment 'a=....$@.....'
5296 * and in this case should treat it like '$*' - see 'else...' below */
5297 if (first_ch
== ('@'|0x80) /* quoted $@ */
5298 && !(output
->o_expflags
& EXP_FLAG_SINGLEWORD
) /* not v="$@" case */
5301 o_addQstr(output
, G
.global_argv
[i
]);
5302 if (++i
>= G
.global_argc
)
5304 o_addchr(output
, '\0');
5305 debug_print_list("expand_vars_to_list[4]", output
, n
);
5306 n
= o_save_ptr(output
, n
);
5308 } else { /* quoted $* (or v="$@" case): add as one word */
5310 o_addQstr(output
, G
.global_argv
[i
]);
5311 if (!G
.global_argv
[++i
])
5314 o_addchr(output
, G
.ifs
[0]);
5316 output
->has_quoted_part
= 1;
5320 case SPECIAL_VAR_SYMBOL
: /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_SYMBOL> */
5321 /* "Empty variable", used to make "" etc to not disappear */
5322 output
->has_quoted_part
= 1;
5324 cant_be_null
= 0x80;
5326 #if ENABLE_HUSH_TICK
5327 case '`': /* <SPECIAL_VAR_SYMBOL>`cmd<SPECIAL_VAR_SYMBOL> */
5328 *p
= '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
5330 /* Can't just stuff it into output o_string,
5331 * expanded result may need to be globbed
5332 * and $IFS-splitted */
5333 debug_printf_subst("SUBST '%s' first_ch %x\n", arg
, first_ch
);
5334 G
.last_exitcode
= process_command_subs(&subst_result
, arg
);
5335 debug_printf_subst("SUBST RES:%d '%s'\n", G
.last_exitcode
, subst_result
.data
);
5336 val
= subst_result
.data
;
5339 #if ENABLE_SH_MATH_SUPPORT
5340 case '+': { /* <SPECIAL_VAR_SYMBOL>+cmd<SPECIAL_VAR_SYMBOL> */
5343 arg
++; /* skip '+' */
5344 *p
= '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
5345 debug_printf_subst("ARITH '%s' first_ch %x\n", arg
, first_ch
);
5346 res
= expand_and_evaluate_arith(arg
, NULL
);
5347 debug_printf_subst("ARITH RES '"ARITH_FMT
"'\n", res
);
5348 sprintf(arith_buf
, ARITH_FMT
, res
);
5354 val
= expand_one_var(&to_be_freed
, arg
, &p
);
5355 IF_HUSH_TICK(store_val
:)
5356 if (!(first_ch
& 0x80)) { /* unquoted $VAR */
5357 debug_printf_expand("unquoted '%s', output->o_escape:%d\n", val
,
5358 !!(output
->o_expflags
& EXP_FLAG_ESC_GLOB_CHARS
));
5359 if (val
&& val
[0]) {
5360 n
= expand_on_ifs(&ended_in_ifs
, output
, n
, val
);
5363 } else { /* quoted $VAR, val will be appended below */
5364 output
->has_quoted_part
= 1;
5365 debug_printf_expand("quoted '%s', output->o_escape:%d\n", val
,
5366 !!(output
->o_expflags
& EXP_FLAG_ESC_GLOB_CHARS
));
5370 } /* switch (char after <SPECIAL_VAR_SYMBOL>) */
5372 if (val
&& val
[0]) {
5373 o_addQstr(output
, val
);
5377 /* Restore NULL'ed SPECIAL_VAR_SYMBOL.
5378 * Do the check to avoid writing to a const string. */
5379 if (*p
!= SPECIAL_VAR_SYMBOL
)
5380 *p
= SPECIAL_VAR_SYMBOL
;
5382 #if ENABLE_HUSH_TICK
5383 o_free(&subst_result
);
5386 } /* end of "while (SPECIAL_VAR_SYMBOL is found) ..." */
5390 o_addchr(output
, '\0');
5391 n
= o_save_ptr(output
, n
);
5393 debug_print_list("expand_vars_to_list[a]", output
, n
);
5394 /* this part is literal, and it was already pre-quoted
5395 * if needed (much earlier), do not use o_addQstr here! */
5396 o_addstr_with_NUL(output
, arg
);
5397 debug_print_list("expand_vars_to_list[b]", output
, n
);
5398 } else if (output
->length
== o_get_last_ptr(output
, n
) /* expansion is empty */
5399 && !(cant_be_null
& 0x80) /* and all vars were not quoted. */
5402 /* allow to reuse list[n] later without re-growth */
5403 output
->has_empty_slot
= 1;
5405 o_addchr(output
, '\0');
5411 static char **expand_variables(char **argv
, unsigned expflags
)
5415 o_string output
= NULL_O_STRING
;
5417 output
.o_expflags
= expflags
;
5421 n
= expand_vars_to_list(&output
, n
, *argv
);
5424 debug_print_list("expand_variables", &output
, n
);
5426 /* output.data (malloced in one block) gets returned in "list" */
5427 list
= o_finalize_list(&output
, n
);
5428 debug_print_strings("expand_variables[1]", list
);
5432 static char **expand_strvec_to_strvec(char **argv
)
5434 return expand_variables(argv
, EXP_FLAG_GLOB
| EXP_FLAG_ESC_GLOB_CHARS
);
5437 #if ENABLE_HUSH_BASH_COMPAT
5438 static char **expand_strvec_to_strvec_singleword_noglob(char **argv
)
5440 return expand_variables(argv
, EXP_FLAG_SINGLEWORD
);
5444 /* Used for expansion of right hand of assignments,
5445 * $((...)), heredocs, variable espansion parts.
5447 * NB: should NOT do globbing!
5448 * "export v=/bin/c*; env | grep ^v=" outputs "v=/bin/c*"
5450 static char *expand_string_to_string(const char *str
, int do_unbackslash
)
5452 #if !ENABLE_HUSH_BASH_COMPAT
5453 const int do_unbackslash
= 1;
5455 char *argv
[2], **list
;
5457 debug_printf_expand("string_to_string<='%s'\n", str
);
5458 /* This is generally an optimization, but it also
5459 * handles "", which otherwise trips over !list[0] check below.
5460 * (is this ever happens that we actually get str="" here?)
5462 if (!strchr(str
, SPECIAL_VAR_SYMBOL
) && !strchr(str
, '\\')) {
5463 //TODO: Can use on strings with \ too, just unbackslash() them?
5464 debug_printf_expand("string_to_string(fast)=>'%s'\n", str
);
5465 return xstrdup(str
);
5468 argv
[0] = (char*)str
;
5470 list
= expand_variables(argv
, do_unbackslash
5471 ? EXP_FLAG_ESC_GLOB_CHARS
| EXP_FLAG_SINGLEWORD
5472 : EXP_FLAG_SINGLEWORD
5475 if (!list
[0] || list
[1])
5476 bb_error_msg_and_die("BUG in varexp2");
5477 /* actually, just move string 2*sizeof(char*) bytes back */
5478 overlapping_strcpy((char*)list
, list
[0]);
5480 unbackslash((char*)list
);
5481 debug_printf_expand("string_to_string=>'%s'\n", (char*)list
);
5485 /* Used for "eval" builtin */
5486 static char* expand_strvec_to_string(char **argv
)
5490 list
= expand_variables(argv
, EXP_FLAG_SINGLEWORD
);
5491 /* Convert all NULs to spaces */
5496 if (list
[n
-1] + strlen(list
[n
-1]) + 1 != list
[n
])
5497 bb_error_msg_and_die("BUG in varexp3");
5498 /* bash uses ' ' regardless of $IFS contents */
5503 overlapping_strcpy((char*)list
, list
[0]);
5504 debug_printf_expand("strvec_to_string='%s'\n", (char*)list
);
5508 static char **expand_assignments(char **argv
, int count
)
5513 G
.expanded_assignments
= p
= NULL
;
5514 /* Expand assignments into one string each */
5515 for (i
= 0; i
< count
; i
++) {
5516 G
.expanded_assignments
= p
= add_string_to_strings(p
, expand_string_to_string(argv
[i
], /*unbackslash:*/ 1));
5518 G
.expanded_assignments
= NULL
;
5523 static void switch_off_special_sigs(unsigned mask
)
5526 while ((mask
>>= 1) != 0) {
5531 if (G
.traps
[sig
] && !G
.traps
[sig
][0])
5532 /* trap is '', has to remain SIG_IGN */
5535 G
.traps
[sig
] = NULL
;
5537 /* We are here only if no trap or trap was not '' */
5538 install_sighandler(sig
, SIG_DFL
);
5544 void re_execute_shell(char ***to_free
, const char *s
,
5545 char *g_argv0
, char **g_argv
,
5546 char **builtin_argv
) NORETURN
;
5548 static void reset_traps_to_defaults(void)
5550 /* This function is always called in a child shell
5551 * after fork (not vfork, NOMMU doesn't use this function).
5556 /* Child shells are not interactive.
5557 * SIGTTIN/SIGTTOU/SIGTSTP should not have special handling.
5558 * Testcase: (while :; do :; done) + ^Z should background.
5559 * Same goes for SIGTERM, SIGHUP, SIGINT.
5561 mask
= (G
.special_sig_mask
& SPECIAL_INTERACTIVE_SIGS
) | G_fatal_sig_mask
;
5562 if (!G
.traps
&& !mask
)
5563 return; /* already no traps and no special sigs */
5565 /* Switch off special sigs */
5566 switch_off_special_sigs(mask
);
5568 G_fatal_sig_mask
= 0;
5570 G
.special_sig_mask
&= ~SPECIAL_INTERACTIVE_SIGS
;
5571 /* SIGQUIT,SIGCHLD and maybe SPECIAL_JOBSTOP_SIGS
5572 * remain set in G.special_sig_mask */
5577 /* Reset all sigs to default except ones with empty traps */
5578 for (sig
= 0; sig
< NSIG
; sig
++) {
5580 continue; /* no trap: nothing to do */
5581 if (!G
.traps
[sig
][0])
5582 continue; /* empty trap: has to remain SIG_IGN */
5583 /* sig has non-empty trap, reset it: */
5585 G
.traps
[sig
] = NULL
;
5586 /* There is no signal for trap 0 (EXIT) */
5589 install_sighandler(sig
, pick_sighandler(sig
));
5595 static void re_execute_shell(char ***to_free
, const char *s
,
5596 char *g_argv0
, char **g_argv
,
5597 char **builtin_argv
) NORETURN
;
5598 static void re_execute_shell(char ***to_free
, const char *s
,
5599 char *g_argv0
, char **g_argv
,
5600 char **builtin_argv
)
5602 # define NOMMU_HACK_FMT ("-$%x:%x:%x:%x:%x:%llx" IF_HUSH_LOOPS(":%x"))
5603 /* delims + 2 * (number of bytes in printed hex numbers) */
5604 char param_buf
[sizeof(NOMMU_HACK_FMT
) + 2 * (sizeof(int)*6 + sizeof(long long)*1)];
5605 char *heredoc_argv
[4];
5606 struct variable
*cur
;
5607 # if ENABLE_HUSH_FUNCTIONS
5608 struct function
*funcp
;
5612 unsigned long long empty_trap_mask
;
5614 if (!g_argv0
) { /* heredoc */
5615 argv
= heredoc_argv
;
5616 argv
[0] = (char *) G
.argv0_for_re_execing
;
5617 argv
[1] = (char *) "-<";
5618 argv
[2] = (char *) s
;
5620 pp
= &argv
[3]; /* used as pointer to empty environment */
5626 if (pp
) while (*pp
++)
5629 empty_trap_mask
= 0;
5632 for (sig
= 1; sig
< NSIG
; sig
++) {
5633 if (G
.traps
[sig
] && !G
.traps
[sig
][0])
5634 empty_trap_mask
|= 1LL << sig
;
5638 sprintf(param_buf
, NOMMU_HACK_FMT
5639 , (unsigned) G
.root_pid
5640 , (unsigned) G
.root_ppid
5641 , (unsigned) G
.last_bg_pid
5642 , (unsigned) G
.last_exitcode
5645 IF_HUSH_LOOPS(, G
.depth_of_loop
)
5647 # undef NOMMU_HACK_FMT
5648 /* 1:hush 2:-$<pid>:<pid>:<exitcode>:<etc...> <vars...> <funcs...>
5649 * 3:-c 4:<cmd> 5:<arg0> <argN...> 6:NULL
5652 for (cur
= G
.top_var
; cur
; cur
= cur
->next
) {
5653 if (!cur
->flg_export
|| cur
->flg_read_only
)
5656 # if ENABLE_HUSH_FUNCTIONS
5657 for (funcp
= G
.top_func
; funcp
; funcp
= funcp
->next
)
5663 *to_free
= argv
= pp
= xzalloc(sizeof(argv
[0]) * cnt
);
5664 *pp
++ = (char *) G
.argv0_for_re_execing
;
5666 for (cur
= G
.top_var
; cur
; cur
= cur
->next
) {
5667 if (strcmp(cur
->varstr
, hush_version_str
) == 0)
5669 if (cur
->flg_read_only
) {
5670 *pp
++ = (char *) "-R";
5671 *pp
++ = cur
->varstr
;
5672 } else if (!cur
->flg_export
) {
5673 *pp
++ = (char *) "-V";
5674 *pp
++ = cur
->varstr
;
5677 # if ENABLE_HUSH_FUNCTIONS
5678 for (funcp
= G
.top_func
; funcp
; funcp
= funcp
->next
) {
5679 *pp
++ = (char *) "-F";
5680 *pp
++ = funcp
->name
;
5681 *pp
++ = funcp
->body_as_string
;
5684 /* We can pass activated traps here. Say, -Tnn:trap_string
5686 * However, POSIX says that subshells reset signals with traps
5688 * I tested bash-3.2 and it not only does that with true subshells
5689 * of the form ( list ), but with any forked children shells.
5690 * I set trap "echo W" WINCH; and then tried:
5692 * { echo 1; sleep 20; echo 2; } &
5693 * while true; do echo 1; sleep 20; echo 2; break; done &
5694 * true | { echo 1; sleep 20; echo 2; } | cat
5696 * In all these cases sending SIGWINCH to the child shell
5697 * did not run the trap. If I add trap "echo V" WINCH;
5698 * _inside_ group (just before echo 1), it works.
5700 * I conclude it means we don't need to pass active traps here.
5702 *pp
++ = (char *) "-c";
5705 while (*++builtin_argv
)
5706 *pp
++ = *builtin_argv
;
5707 *pp
++ = (char *) "";
5712 /* *pp = NULL; - is already there */
5716 debug_printf_exec("re_execute_shell pid:%d cmd:'%s'\n", getpid(), s
);
5717 /* Don't propagate SIG_IGN to the child */
5718 if (SPECIAL_JOBSTOP_SIGS
!= 0)
5719 switch_off_special_sigs(G
.special_sig_mask
& SPECIAL_JOBSTOP_SIGS
);
5720 execve(bb_busybox_exec_path
, argv
, pp
);
5721 /* Fallback. Useful for init=/bin/hush usage etc */
5722 if (argv
[0][0] == '/')
5723 execve(argv
[0], argv
, pp
);
5724 xfunc_error_retval
= 127;
5725 bb_error_msg_and_die("can't re-execute the shell");
5727 #endif /* !BB_MMU */
5730 static int run_and_free_list(struct pipe
*pi
);
5732 /* Executing from string: eval, sh -c '...'
5733 * or from file: /etc/profile, . file, sh <script>, sh (intereactive)
5734 * end_trigger controls how often we stop parsing
5735 * NUL: parse all, execute, return
5736 * ';': parse till ';' or newline, execute, repeat till EOF
5738 static void parse_and_run_stream(struct in_str
*inp
, int end_trigger
)
5740 /* Why we need empty flag?
5741 * An obscure corner case "false; ``; echo $?":
5742 * empty command in `` should still set $? to 0.
5743 * But we can't just set $? to 0 at the start,
5744 * this breaks "false; echo `echo $?`" case.
5748 struct pipe
*pipe_list
;
5750 #if ENABLE_HUSH_INTERACTIVE
5751 if (end_trigger
== ';')
5752 inp
->promptmode
= 0; /* PS1 */
5754 pipe_list
= parse_stream(NULL
, inp
, end_trigger
);
5755 if (!pipe_list
|| pipe_list
== ERR_PTR
) { /* EOF/error */
5756 /* If we are in "big" script
5757 * (not in `cmd` or something similar)...
5759 if (pipe_list
== ERR_PTR
&& end_trigger
== ';') {
5760 /* Discard cached input (rest of line) */
5761 int ch
= inp
->last_char
;
5762 while (ch
!= EOF
&& ch
!= '\n') {
5763 //bb_error_msg("Discarded:'%c'", ch);
5768 /* This stream isn't empty */
5772 if (!pipe_list
&& empty
)
5773 G
.last_exitcode
= 0;
5776 debug_print_tree(pipe_list
, 0);
5777 debug_printf_exec("parse_and_run_stream: run_and_free_list\n");
5778 run_and_free_list(pipe_list
);
5780 #if ENABLE_HUSH_FUNCTIONS
5781 if (G
.flag_return_in_progress
== 1)
5787 static void parse_and_run_string(const char *s
)
5789 struct in_str input
;
5790 setup_string_in_str(&input
, s
);
5791 parse_and_run_stream(&input
, '\0');
5794 static void parse_and_run_file(FILE *f
)
5796 struct in_str input
;
5797 setup_file_in_str(&input
, f
);
5798 parse_and_run_stream(&input
, ';');
5801 #if ENABLE_HUSH_TICK
5802 static FILE *generate_stream_from_string(const char *s
, pid_t
*pid_p
)
5807 char **to_free
= NULL
;
5811 pid
= BB_MMU
? xfork() : xvfork();
5812 if (pid
== 0) { /* child */
5813 disable_restore_tty_pgrp_on_exit();
5814 /* Process substitution is not considered to be usual
5815 * 'command execution'.
5816 * SUSv3 says ctrl-Z should be ignored, ctrl-C should not.
5823 CLEAR_RANDOM_T(&G
.random_gen
); /* or else $RANDOM repeats in child */
5824 close(channel
[0]); /* NB: close _first_, then move fd! */
5825 xmove_fd(channel
[1], 1);
5826 /* Prevent it from trying to handle ctrl-z etc */
5827 IF_HUSH_JOB(G
.run_list_level
= 1;)
5828 /* Awful hack for `trap` or $(trap).
5830 * http://www.opengroup.org/onlinepubs/009695399/utilities/trap.html
5831 * contains an example where "trap" is executed in a subshell:
5833 * save_traps=$(trap)
5835 * eval "$save_traps"
5837 * Standard does not say that "trap" in subshell shall print
5838 * parent shell's traps. It only says that its output
5839 * must have suitable form, but then, in the above example
5840 * (which is not supposed to be normative), it implies that.
5842 * bash (and probably other shell) does implement it
5843 * (traps are reset to defaults, but "trap" still shows them),
5844 * but as a result, "trap" logic is hopelessly messed up:
5847 * trap -- 'echo Ho' SIGWINCH <--- we have a handler
5848 * # (trap) <--- trap is in subshell - no output (correct, traps are reset)
5849 * # true | trap <--- trap is in subshell - no output (ditto)
5850 * # echo `true | trap` <--- in subshell - output (but traps are reset!)
5851 * trap -- 'echo Ho' SIGWINCH
5852 * # echo `(trap)` <--- in subshell in subshell - output
5853 * trap -- 'echo Ho' SIGWINCH
5854 * # echo `true | (trap)` <--- in subshell in subshell in subshell - output!
5855 * trap -- 'echo Ho' SIGWINCH
5857 * The rules when to forget and when to not forget traps
5858 * get really complex and nonsensical.
5860 * Our solution: ONLY bare $(trap) or `trap` is special.
5862 s
= skip_whitespace(s
);
5863 if (strncmp(s
, "trap", 4) == 0
5864 && skip_whitespace(s
+ 4)[0] == '\0'
5866 static const char *const argv
[] = { NULL
, NULL
};
5867 builtin_trap((char**)argv
);
5868 exit(0); /* not _exit() - we need to fflush */
5871 reset_traps_to_defaults();
5872 parse_and_run_string(s
);
5873 _exit(G
.last_exitcode
);
5875 /* We re-execute after vfork on NOMMU. This makes this script safe:
5876 * yes "0123456789012345678901234567890" | dd bs=32 count=64k >BIG
5877 * huge=`cat BIG` # was blocking here forever
5880 re_execute_shell(&to_free
,
5890 # if ENABLE_HUSH_FAST
5892 //bb_error_msg("[%d] fork in generate_stream_from_string:"
5893 // " G.count_SIGCHLD:%d G.handled_SIGCHLD:%d",
5894 // getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
5896 enable_restore_tty_pgrp_on_exit();
5901 close_on_exec_on(channel
[0]);
5902 return xfdopen_for_read(channel
[0]);
5905 /* Return code is exit status of the process that is run. */
5906 static int process_command_subs(o_string
*dest
, const char *s
)
5909 struct in_str pipe_str
;
5911 int status
, ch
, eol_cnt
;
5913 fp
= generate_stream_from_string(s
, &pid
);
5915 /* Now send results of command back into original context */
5916 setup_file_in_str(&pipe_str
, fp
);
5918 while ((ch
= i_getch(&pipe_str
)) != EOF
) {
5924 o_addchr(dest
, '\n');
5927 o_addQchr(dest
, ch
);
5930 debug_printf("done reading from `cmd` pipe, closing it\n");
5932 /* We need to extract exitcode. Test case
5933 * "true; echo `sleep 1; false` $?"
5935 safe_waitpid(pid
, &status
, 0);
5936 debug_printf("child exited. returning its exitcode:%d\n", WEXITSTATUS(status
));
5937 return WEXITSTATUS(status
);
5939 #endif /* ENABLE_HUSH_TICK */
5942 static void setup_heredoc(struct redir_struct
*redir
)
5944 struct fd_pair pair
;
5947 /* the _body_ of heredoc (misleading field name) */
5948 const char *heredoc
= redir
->rd_filename
;
5955 if (!(redir
->rd_dup
& HEREDOC_QUOTED
)) {
5956 expanded
= encode_then_expand_string(heredoc
, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
5960 len
= strlen(heredoc
);
5962 close(redir
->rd_fd
); /* often saves dup2+close in xmove_fd */
5964 xmove_fd(pair
.rd
, redir
->rd_fd
);
5966 /* Try writing without forking. Newer kernels have
5967 * dynamically growing pipes. Must use non-blocking write! */
5970 written
= write(pair
.wr
, heredoc
, len
);
5981 ndelay_off(pair
.wr
);
5983 /* Okay, pipe buffer was not big enough */
5984 /* Note: we must not create a stray child (bastard? :)
5985 * for the unsuspecting parent process. Child creates a grandchild
5986 * and exits before parent execs the process which consumes heredoc
5987 * (that exec happens after we return from this function) */
5994 disable_restore_tty_pgrp_on_exit();
5995 pid
= BB_MMU
? xfork() : xvfork();
5999 close(redir
->rd_fd
); /* read side of the pipe */
6001 full_write(pair
.wr
, heredoc
, len
); /* may loop or block */
6004 /* Delegate blocking writes to another process */
6005 xmove_fd(pair
.wr
, STDOUT_FILENO
);
6006 re_execute_shell(&to_free
, heredoc
, NULL
, NULL
, NULL
);
6010 #if ENABLE_HUSH_FAST
6012 //bb_error_msg("[%d] fork in setup_heredoc: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
6014 enable_restore_tty_pgrp_on_exit();
6020 wait(NULL
); /* wait till child has died */
6023 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
6024 * and stderr if they are redirected. */
6025 static int setup_redirects(struct command
*prog
, int squirrel
[])
6028 struct redir_struct
*redir
;
6030 for (redir
= prog
->redirects
; redir
; redir
= redir
->next
) {
6031 if (redir
->rd_type
== REDIRECT_HEREDOC2
) {
6032 /* rd_fd<<HERE case */
6033 if (squirrel
&& redir
->rd_fd
< 3
6034 && squirrel
[redir
->rd_fd
] < 0
6036 squirrel
[redir
->rd_fd
] = dup(redir
->rd_fd
);
6038 /* for REDIRECT_HEREDOC2, rd_filename holds _contents_
6040 debug_printf_parse("set heredoc '%s'\n",
6041 redir
->rd_filename
);
6042 setup_heredoc(redir
);
6046 if (redir
->rd_dup
== REDIRFD_TO_FILE
) {
6047 /* rd_fd<*>file case (<*> is <,>,>>,<>) */
6049 if (redir
->rd_filename
== NULL
) {
6050 /* Something went wrong in the parse.
6051 * Pretend it didn't happen */
6052 bb_error_msg("bug in redirect parse");
6055 mode
= redir_table
[redir
->rd_type
].mode
;
6056 p
= expand_string_to_string(redir
->rd_filename
, /*unbackslash:*/ 1);
6057 openfd
= open_or_warn(p
, mode
);
6060 /* this could get lost if stderr has been redirected, but
6061 * bash and ash both lose it as well (though zsh doesn't!) */
6062 //what the above comment tries to say?
6066 /* rd_fd<*>rd_dup or rd_fd<*>- cases */
6067 openfd
= redir
->rd_dup
;
6070 if (openfd
!= redir
->rd_fd
) {
6071 if (squirrel
&& redir
->rd_fd
< 3
6072 && squirrel
[redir
->rd_fd
] < 0
6074 squirrel
[redir
->rd_fd
] = dup(redir
->rd_fd
);
6076 if (openfd
== REDIRFD_CLOSE
) {
6077 /* "n>-" means "close me" */
6078 close(redir
->rd_fd
);
6080 xdup2(openfd
, redir
->rd_fd
);
6081 if (redir
->rd_dup
== REDIRFD_TO_FILE
)
6089 static void restore_redirects(int squirrel
[])
6092 for (i
= 0; i
< 3; i
++) {
6095 /* We simply die on error */
6101 static char *find_in_path(const char *arg
)
6104 const char *PATH
= get_local_var_value("PATH");
6110 const char *end
= strchrnul(PATH
, ':');
6111 int sz
= end
- PATH
; /* must be int! */
6115 ret
= xasprintf("%.*s/%s", sz
, PATH
, arg
);
6117 /* We have xxx::yyyy in $PATH,
6118 * it means "use current dir" */
6121 if (access(ret
, F_OK
) == 0)
6134 static const struct built_in_command
*find_builtin_helper(const char *name
,
6135 const struct built_in_command
*x
,
6136 const struct built_in_command
*end
)
6139 if (strcmp(name
, x
->b_cmd
) != 0) {
6143 debug_printf_exec("found builtin '%s'\n", name
);
6148 static const struct built_in_command
*find_builtin1(const char *name
)
6150 return find_builtin_helper(name
, bltins1
, &bltins1
[ARRAY_SIZE(bltins1
)]);
6152 static const struct built_in_command
*find_builtin(const char *name
)
6154 const struct built_in_command
*x
= find_builtin1(name
);
6157 return find_builtin_helper(name
, bltins2
, &bltins2
[ARRAY_SIZE(bltins2
)]);
6160 #if ENABLE_HUSH_FUNCTIONS
6161 static struct function
**find_function_slot(const char *name
)
6163 struct function
**funcpp
= &G
.top_func
;
6165 if (strcmp(name
, (*funcpp
)->name
) == 0) {
6168 funcpp
= &(*funcpp
)->next
;
6173 static const struct function
*find_function(const char *name
)
6175 const struct function
*funcp
= *find_function_slot(name
);
6177 debug_printf_exec("found function '%s'\n", name
);
6181 /* Note: takes ownership on name ptr */
6182 static struct function
*new_function(char *name
)
6184 struct function
**funcpp
= find_function_slot(name
);
6185 struct function
*funcp
= *funcpp
;
6187 if (funcp
!= NULL
) {
6188 struct command
*cmd
= funcp
->parent_cmd
;
6189 debug_printf_exec("func %p parent_cmd %p\n", funcp
, cmd
);
6191 debug_printf_exec("freeing & replacing function '%s'\n", funcp
->name
);
6193 /* Note: if !funcp->body, do not free body_as_string!
6194 * This is a special case of "-F name body" function:
6195 * body_as_string was not malloced! */
6197 free_pipe_list(funcp
->body
);
6199 free(funcp
->body_as_string
);
6203 debug_printf_exec("reinserting in tree & replacing function '%s'\n", funcp
->name
);
6204 cmd
->argv
[0] = funcp
->name
;
6205 cmd
->group
= funcp
->body
;
6207 cmd
->group_as_string
= funcp
->body_as_string
;
6211 debug_printf_exec("remembering new function '%s'\n", name
);
6212 funcp
= *funcpp
= xzalloc(sizeof(*funcp
));
6213 /*funcp->next = NULL;*/
6220 static void unset_func(const char *name
)
6222 struct function
**funcpp
= find_function_slot(name
);
6223 struct function
*funcp
= *funcpp
;
6225 if (funcp
!= NULL
) {
6226 debug_printf_exec("freeing function '%s'\n", funcp
->name
);
6227 *funcpp
= funcp
->next
;
6228 /* funcp is unlinked now, deleting it.
6229 * Note: if !funcp->body, the function was created by
6230 * "-F name body", do not free ->body_as_string
6231 * and ->name as they were not malloced. */
6233 free_pipe_list(funcp
->body
);
6236 free(funcp
->body_as_string
);
6244 #define exec_function(to_free, funcp, argv) \
6245 exec_function(funcp, argv)
6247 static void exec_function(char ***to_free
,
6248 const struct function
*funcp
,
6249 char **argv
) NORETURN
;
6250 static void exec_function(char ***to_free
,
6251 const struct function
*funcp
,
6257 argv
[0] = G
.global_argv
[0];
6258 G
.global_argv
= argv
;
6262 /* On MMU, funcp->body is always non-NULL */
6263 n
= run_list(funcp
->body
);
6267 re_execute_shell(to_free
,
6268 funcp
->body_as_string
,
6275 static int run_function(const struct function
*funcp
, char **argv
)
6281 save_and_replace_G_args(&sv
, argv
);
6283 /* "we are in function, ok to use return" */
6284 sv_flg
= G
.flag_return_in_progress
;
6285 G
.flag_return_in_progress
= -1;
6286 # if ENABLE_HUSH_LOCAL
6287 G
.func_nest_level
++;
6290 /* On MMU, funcp->body is always non-NULL */
6293 /* Function defined by -F */
6294 parse_and_run_string(funcp
->body_as_string
);
6295 rc
= G
.last_exitcode
;
6299 rc
= run_list(funcp
->body
);
6302 # if ENABLE_HUSH_LOCAL
6304 struct variable
*var
;
6305 struct variable
**var_pp
;
6307 var_pp
= &G
.top_var
;
6308 while ((var
= *var_pp
) != NULL
) {
6309 if (var
->func_nest_level
< G
.func_nest_level
) {
6310 var_pp
= &var
->next
;
6314 if (var
->flg_export
)
6315 bb_unsetenv(var
->varstr
);
6316 /* Remove from global list */
6317 *var_pp
= var
->next
;
6323 G
.func_nest_level
--;
6326 G
.flag_return_in_progress
= sv_flg
;
6328 restore_G_args(&sv
, argv
);
6332 #endif /* ENABLE_HUSH_FUNCTIONS */
6336 #define exec_builtin(to_free, x, argv) \
6337 exec_builtin(x, argv)
6339 #define exec_builtin(to_free, x, argv) \
6340 exec_builtin(to_free, argv)
6342 static void exec_builtin(char ***to_free
,
6343 const struct built_in_command
*x
,
6344 char **argv
) NORETURN
;
6345 static void exec_builtin(char ***to_free
,
6346 const struct built_in_command
*x
,
6352 rcode
= x
->b_function(argv
);
6357 /* On NOMMU, we must never block!
6358 * Example: { sleep 99 | read line; } & echo Ok
6360 re_execute_shell(to_free
,
6369 static void execvp_or_die(char **argv
) NORETURN
;
6370 static void execvp_or_die(char **argv
)
6372 debug_printf_exec("execing '%s'\n", argv
[0]);
6373 /* Don't propagate SIG_IGN to the child */
6374 if (SPECIAL_JOBSTOP_SIGS
!= 0)
6375 switch_off_special_sigs(G
.special_sig_mask
& SPECIAL_JOBSTOP_SIGS
);
6376 execvp(argv
[0], argv
);
6377 bb_perror_msg("can't execute '%s'", argv
[0]);
6378 _exit(127); /* bash compat */
6381 #if ENABLE_HUSH_MODE_X
6382 static void dump_cmd_in_x_mode(char **argv
)
6384 if (G_x_mode
&& argv
) {
6385 /* We want to output the line in one write op */
6393 len
+= strlen(argv
[n
++]) + 1;
6399 p
+= sprintf(p
, " %s", argv
[n
++]);
6407 # define dump_cmd_in_x_mode(argv) ((void)0)
6411 #define pseudo_exec_argv(nommu_save, argv, assignment_cnt, argv_expanded) \
6412 pseudo_exec_argv(argv, assignment_cnt, argv_expanded)
6413 #define pseudo_exec(nommu_save, command, argv_expanded) \
6414 pseudo_exec(command, argv_expanded)
6417 /* Called after [v]fork() in run_pipe, or from builtin_exec.
6419 * Don't exit() here. If you don't exec, use _exit instead.
6420 * The at_exit handlers apparently confuse the calling process,
6421 * in particular stdin handling. Not sure why? -- because of vfork! (vda) */
6422 static void pseudo_exec_argv(nommu_save_t
*nommu_save
,
6423 char **argv
, int assignment_cnt
,
6424 char **argv_expanded
) NORETURN
;
6425 static NOINLINE
void pseudo_exec_argv(nommu_save_t
*nommu_save
,
6426 char **argv
, int assignment_cnt
,
6427 char **argv_expanded
)
6431 new_env
= expand_assignments(argv
, assignment_cnt
);
6432 dump_cmd_in_x_mode(new_env
);
6434 if (!argv
[assignment_cnt
]) {
6435 /* Case when we are here: ... | var=val | ...
6436 * (note that we do not exit early, i.e., do not optimize out
6437 * expand_assignments(): think about ... | var=`sleep 1` | ...
6439 free_strings(new_env
);
6440 _exit(EXIT_SUCCESS
);
6444 set_vars_and_save_old(new_env
);
6445 free(new_env
); /* optional */
6446 /* we can also destroy set_vars_and_save_old's return value,
6449 nommu_save
->new_env
= new_env
;
6450 nommu_save
->old_vars
= set_vars_and_save_old(new_env
);
6453 if (argv_expanded
) {
6454 argv
= argv_expanded
;
6456 argv
= expand_strvec_to_strvec(argv
+ assignment_cnt
);
6458 nommu_save
->argv
= argv
;
6461 dump_cmd_in_x_mode(argv
);
6463 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
6464 if (strchr(argv
[0], '/') != NULL
)
6468 /* Check if the command matches any of the builtins.
6469 * Depending on context, this might be redundant. But it's
6470 * easier to waste a few CPU cycles than it is to figure out
6471 * if this is one of those cases.
6474 /* On NOMMU, it is more expensive to re-execute shell
6475 * just in order to run echo or test builtin.
6476 * It's better to skip it here and run corresponding
6477 * non-builtin later. */
6478 const struct built_in_command
*x
;
6479 x
= BB_MMU
? find_builtin(argv
[0]) : find_builtin1(argv
[0]);
6481 exec_builtin(&nommu_save
->argv_from_re_execing
, x
, argv
);
6484 #if ENABLE_HUSH_FUNCTIONS
6485 /* Check if the command matches any functions */
6487 const struct function
*funcp
= find_function(argv
[0]);
6489 exec_function(&nommu_save
->argv_from_re_execing
, funcp
, argv
);
6494 #if ENABLE_FEATURE_SH_STANDALONE
6495 /* Check if the command matches any busybox applets */
6497 int a
= find_applet_by_name(argv
[0]);
6499 # if BB_MMU /* see above why on NOMMU it is not allowed */
6500 if (APPLET_IS_NOEXEC(a
)) {
6501 debug_printf_exec("running applet '%s'\n", argv
[0]);
6502 run_applet_no_and_exit(a
, argv
);
6505 /* Re-exec ourselves */
6506 debug_printf_exec("re-execing applet '%s'\n", argv
[0]);
6507 /* Don't propagate SIG_IGN to the child */
6508 if (SPECIAL_JOBSTOP_SIGS
!= 0)
6509 switch_off_special_sigs(G
.special_sig_mask
& SPECIAL_JOBSTOP_SIGS
);
6510 execv(bb_busybox_exec_path
, argv
);
6511 /* If they called chroot or otherwise made the binary no longer
6512 * executable, fall through */
6517 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
6520 execvp_or_die(argv
);
6523 /* Called after [v]fork() in run_pipe
6525 static void pseudo_exec(nommu_save_t
*nommu_save
,
6526 struct command
*command
,
6527 char **argv_expanded
) NORETURN
;
6528 static void pseudo_exec(nommu_save_t
*nommu_save
,
6529 struct command
*command
,
6530 char **argv_expanded
)
6532 if (command
->argv
) {
6533 pseudo_exec_argv(nommu_save
, command
->argv
,
6534 command
->assignment_cnt
, argv_expanded
);
6537 if (command
->group
) {
6538 /* Cases when we are here:
6541 * ... | ( list ) | ...
6542 * ... | { list } | ...
6546 debug_printf_exec("pseudo_exec: run_list\n");
6547 reset_traps_to_defaults();
6548 rcode
= run_list(command
->group
);
6549 /* OK to leak memory by not calling free_pipe_list,
6550 * since this process is about to exit */
6553 re_execute_shell(&nommu_save
->argv_from_re_execing
,
6554 command
->group_as_string
,
6561 /* Case when we are here: ... | >file */
6562 debug_printf_exec("pseudo_exec'ed null command\n");
6563 _exit(EXIT_SUCCESS
);
6567 static const char *get_cmdtext(struct pipe
*pi
)
6573 /* This is subtle. ->cmdtext is created only on first backgrounding.
6574 * (Think "cat, <ctrl-z>, fg, <ctrl-z>, fg, <ctrl-z>...." here...)
6575 * On subsequent bg argv is trashed, but we won't use it */
6578 argv
= pi
->cmds
[0].argv
;
6579 if (!argv
|| !argv
[0]) {
6580 pi
->cmdtext
= xzalloc(1);
6586 len
+= strlen(*argv
) + 1;
6590 argv
= pi
->cmds
[0].argv
;
6592 len
= strlen(*argv
);
6593 memcpy(p
, *argv
, len
);
6601 static void insert_bg_job(struct pipe
*pi
)
6603 struct pipe
*job
, **jobp
;
6606 /* Linear search for the ID of the job to use */
6608 for (job
= G
.job_list
; job
; job
= job
->next
)
6609 if (job
->jobid
>= pi
->jobid
)
6610 pi
->jobid
= job
->jobid
+ 1;
6612 /* Add job to the list of running jobs */
6614 while ((job
= *jobp
) != NULL
)
6616 job
= *jobp
= xmalloc(sizeof(*job
));
6618 *job
= *pi
; /* physical copy */
6620 job
->cmds
= xzalloc(sizeof(pi
->cmds
[0]) * pi
->num_cmds
);
6621 /* Cannot copy entire pi->cmds[] vector! This causes double frees */
6622 for (i
= 0; i
< pi
->num_cmds
; i
++) {
6623 job
->cmds
[i
].pid
= pi
->cmds
[i
].pid
;
6624 /* all other fields are not used and stay zero */
6626 job
->cmdtext
= xstrdup(get_cmdtext(pi
));
6628 if (G_interactive_fd
)
6629 printf("[%d] %d %s\n", job
->jobid
, job
->cmds
[0].pid
, job
->cmdtext
);
6630 G
.last_jobid
= job
->jobid
;
6633 static void remove_bg_job(struct pipe
*pi
)
6635 struct pipe
*prev_pipe
;
6637 if (pi
== G
.job_list
) {
6638 G
.job_list
= pi
->next
;
6640 prev_pipe
= G
.job_list
;
6641 while (prev_pipe
->next
!= pi
)
6642 prev_pipe
= prev_pipe
->next
;
6643 prev_pipe
->next
= pi
->next
;
6646 G
.last_jobid
= G
.job_list
->jobid
;
6651 /* Remove a backgrounded job */
6652 static void delete_finished_bg_job(struct pipe
*pi
)
6659 /* Check to see if any processes have exited -- if they
6660 * have, figure out why and see if a job has completed */
6661 static int checkjobs(struct pipe
*fg_pipe
)
6671 debug_printf_jobs("checkjobs %p\n", fg_pipe
);
6673 attributes
= WUNTRACED
;
6674 if (fg_pipe
== NULL
)
6675 attributes
|= WNOHANG
;
6678 #if ENABLE_HUSH_FAST
6679 if (G
.handled_SIGCHLD
== G
.count_SIGCHLD
) {
6680 //bb_error_msg("[%d] checkjobs: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d children?:%d fg_pipe:%p",
6681 //getpid(), G.count_SIGCHLD, G.handled_SIGCHLD, G.we_have_children, fg_pipe);
6682 /* There was neither fork nor SIGCHLD since last waitpid */
6683 /* Avoid doing waitpid syscall if possible */
6684 if (!G
.we_have_children
) {
6688 if (fg_pipe
== NULL
) { /* is WNOHANG set? */
6689 /* We have children, but they did not exit
6690 * or stop yet (we saw no SIGCHLD) */
6693 /* else: !WNOHANG, waitpid will block, can't short-circuit */
6697 /* Do we do this right?
6698 * bash-3.00# sleep 20 | false
6700 * [3]+ Stopped sleep 20 | false
6701 * bash-3.00# echo $?
6702 * 1 <========== bg pipe is not fully done, but exitcode is already known!
6703 * [hush 1.14.0: yes we do it right]
6710 #if ENABLE_HUSH_FAST
6711 i
= G
.count_SIGCHLD
;
6713 childpid
= waitpid(-1, &status
, attributes
);
6714 if (childpid
<= 0) {
6715 if (childpid
&& errno
!= ECHILD
)
6716 bb_perror_msg("waitpid");
6717 #if ENABLE_HUSH_FAST
6718 else { /* Until next SIGCHLD, waitpid's are useless */
6719 G
.we_have_children
= (childpid
== 0);
6720 G
.handled_SIGCHLD
= i
;
6721 //bb_error_msg("[%d] checkjobs: waitpid returned <= 0, G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
6726 dead
= WIFEXITED(status
) || WIFSIGNALED(status
);
6729 if (WIFSTOPPED(status
))
6730 debug_printf_jobs("pid %d stopped by sig %d (exitcode %d)\n",
6731 childpid
, WSTOPSIG(status
), WEXITSTATUS(status
));
6732 if (WIFSIGNALED(status
))
6733 debug_printf_jobs("pid %d killed by sig %d (exitcode %d)\n",
6734 childpid
, WTERMSIG(status
), WEXITSTATUS(status
));
6735 if (WIFEXITED(status
))
6736 debug_printf_jobs("pid %d exited, exitcode %d\n",
6737 childpid
, WEXITSTATUS(status
));
6739 /* Were we asked to wait for fg pipe? */
6741 i
= fg_pipe
->num_cmds
;
6743 debug_printf_jobs("check pid %d\n", fg_pipe
->cmds
[i
].pid
);
6744 if (fg_pipe
->cmds
[i
].pid
!= childpid
)
6748 fg_pipe
->cmds
[i
].pid
= 0;
6749 fg_pipe
->alive_cmds
--;
6750 ex
= WEXITSTATUS(status
);
6751 /* bash prints killer signal's name for *last*
6752 * process in pipe (prints just newline for SIGINT/SIGPIPE).
6753 * Mimic this. Example: "sleep 5" + (^\ or kill -QUIT)
6755 if (WIFSIGNALED(status
)) {
6756 int sig
= WTERMSIG(status
);
6757 if (i
== fg_pipe
->num_cmds
-1)
6758 /* TODO: use strsignal() instead for bash compat? but that's bloat... */
6759 printf("%s\n", sig
== SIGINT
|| sig
== SIGPIPE
? "" : get_signame(sig
));
6760 /* TODO: if (WCOREDUMP(status)) + " (core dumped)"; */
6761 /* TODO: MIPS has 128 sigs (1..128), what if sig==128 here?
6762 * Maybe we need to use sig | 128? */
6765 fg_pipe
->cmds
[i
].cmd_exitcode
= ex
;
6767 fg_pipe
->stopped_cmds
++;
6769 debug_printf_jobs("fg_pipe: alive_cmds %d stopped_cmds %d\n",
6770 fg_pipe
->alive_cmds
, fg_pipe
->stopped_cmds
);
6771 if (fg_pipe
->alive_cmds
== fg_pipe
->stopped_cmds
) {
6772 /* All processes in fg pipe have exited or stopped */
6773 i
= fg_pipe
->num_cmds
;
6775 rcode
= fg_pipe
->cmds
[i
].cmd_exitcode
;
6776 /* usually last process gives overall exitstatus,
6777 * but with "set -o pipefail", last *failed* process does */
6778 if (G
.o_opt
[OPT_O_PIPEFAIL
] == 0 || rcode
!= 0)
6781 IF_HAS_KEYWORDS(if (fg_pipe
->pi_inverted
) rcode
= !rcode
;)
6782 /* Note: *non-interactive* bash does not continue if all processes in fg pipe
6783 * are stopped. Testcase: "cat | cat" in a script (not on command line!)
6784 * and "killall -STOP cat" */
6785 if (G_interactive_fd
) {
6787 if (fg_pipe
->alive_cmds
!= 0)
6788 insert_bg_job(fg_pipe
);
6792 if (fg_pipe
->alive_cmds
== 0)
6795 /* There are still running processes in the fg pipe */
6796 goto wait_more
; /* do waitpid again */
6798 /* it wasnt fg_pipe, look for process in bg pipes */
6802 /* We asked to wait for bg or orphaned children */
6803 /* No need to remember exitcode in this case */
6804 for (pi
= G
.job_list
; pi
; pi
= pi
->next
) {
6805 for (i
= 0; i
< pi
->num_cmds
; i
++) {
6806 if (pi
->cmds
[i
].pid
== childpid
)
6807 goto found_pi_and_prognum
;
6810 /* Happens when shell is used as init process (init=/bin/sh) */
6811 debug_printf("checkjobs: pid %d was not in our list!\n", childpid
);
6812 continue; /* do waitpid again */
6814 found_pi_and_prognum
:
6817 pi
->cmds
[i
].pid
= 0;
6819 if (!pi
->alive_cmds
) {
6820 if (G_interactive_fd
)
6821 printf(JOB_STATUS_FORMAT
, pi
->jobid
,
6822 "Done", pi
->cmdtext
);
6823 delete_finished_bg_job(pi
);
6830 } /* while (waitpid succeeds)... */
6836 static int checkjobs_and_fg_shell(struct pipe
*fg_pipe
)
6839 int rcode
= checkjobs(fg_pipe
);
6840 if (G_saved_tty_pgrp
) {
6841 /* Job finished, move the shell to the foreground */
6842 p
= getpgrp(); /* our process group id */
6843 debug_printf_jobs("fg'ing ourself: getpgrp()=%d\n", (int)p
);
6844 tcsetpgrp(G_interactive_fd
, p
);
6850 /* Start all the jobs, but don't wait for anything to finish.
6853 * Return code is normally -1, when the caller has to wait for children
6854 * to finish to determine the exit status of the pipe. If the pipe
6855 * is a simple builtin command, however, the action is done by the
6856 * time run_pipe returns, and the exit code is provided as the
6859 * Returns -1 only if started some children. IOW: we have to
6860 * mask out retvals of builtins etc with 0xff!
6862 * The only case when we do not need to [v]fork is when the pipe
6863 * is single, non-backgrounded, non-subshell command. Examples:
6864 * cmd ; ... { list } ; ...
6865 * cmd && ... { list } && ...
6866 * cmd || ... { list } || ...
6867 * If it is, then we can run cmd as a builtin, NOFORK,
6868 * or (if SH_STANDALONE) an applet, and we can run the { list }
6869 * with run_list. If it isn't one of these, we fork and exec cmd.
6871 * Cases when we must fork:
6872 * non-single: cmd | cmd
6873 * backgrounded: cmd & { list } &
6874 * subshell: ( list ) [&]
6876 #if !ENABLE_HUSH_MODE_X
6877 #define redirect_and_varexp_helper(new_env_p, old_vars_p, command, squirrel, argv_expanded) \
6878 redirect_and_varexp_helper(new_env_p, old_vars_p, command, squirrel)
6880 static int redirect_and_varexp_helper(char ***new_env_p
,
6881 struct variable
**old_vars_p
,
6882 struct command
*command
,
6884 char **argv_expanded
)
6886 /* setup_redirects acts on file descriptors, not FILEs.
6887 * This is perfect for work that comes after exec().
6888 * Is it really safe for inline use? Experimentally,
6889 * things seem to work. */
6890 int rcode
= setup_redirects(command
, squirrel
);
6892 char **new_env
= expand_assignments(command
->argv
, command
->assignment_cnt
);
6893 *new_env_p
= new_env
;
6894 dump_cmd_in_x_mode(new_env
);
6895 dump_cmd_in_x_mode(argv_expanded
);
6897 *old_vars_p
= set_vars_and_save_old(new_env
);
6901 static NOINLINE
int run_pipe(struct pipe
*pi
)
6903 static const char *const null_ptr
= NULL
;
6907 struct command
*command
;
6908 char **argv_expanded
;
6910 /* it is not always needed, but we aim to smaller code */
6911 int squirrel
[] = { -1, -1, -1 };
6914 debug_printf_exec("run_pipe start: members:%d\n", pi
->num_cmds
);
6917 /* Testcase: set -- q w e; (IFS='' echo "$*"; IFS=''; echo "$*"); echo "$*"
6918 * Result should be 3 lines: q w e, qwe, q w e
6920 G
.ifs
= get_local_var_value("IFS");
6924 IF_HUSH_JOB(pi
->pgrp
= -1;)
6925 pi
->stopped_cmds
= 0;
6926 command
= &pi
->cmds
[0];
6927 argv_expanded
= NULL
;
6929 if (pi
->num_cmds
!= 1
6930 || pi
->followup
== PIPE_BG
6931 || command
->cmd_type
== CMD_SUBSHELL
6938 debug_printf_exec(": group:%p argv:'%s'\n",
6939 command
->group
, command
->argv
? command
->argv
[0] : "NONE");
6941 if (command
->group
) {
6942 #if ENABLE_HUSH_FUNCTIONS
6943 if (command
->cmd_type
== CMD_FUNCDEF
) {
6944 /* "executing" func () { list } */
6945 struct function
*funcp
;
6947 funcp
= new_function(command
->argv
[0]);
6948 /* funcp->name is already set to argv[0] */
6949 funcp
->body
= command
->group
;
6951 funcp
->body_as_string
= command
->group_as_string
;
6952 command
->group_as_string
= NULL
;
6954 command
->group
= NULL
;
6955 command
->argv
[0] = NULL
;
6956 debug_printf_exec("cmd %p has child func at %p\n", command
, funcp
);
6957 funcp
->parent_cmd
= command
;
6958 command
->child_func
= funcp
;
6960 debug_printf_exec("run_pipe: return EXIT_SUCCESS\n");
6962 return EXIT_SUCCESS
;
6966 debug_printf("non-subshell group\n");
6967 rcode
= 1; /* exitcode if redir failed */
6968 if (setup_redirects(command
, squirrel
) == 0) {
6969 debug_printf_exec(": run_list\n");
6970 rcode
= run_list(command
->group
) & 0xff;
6972 restore_redirects(squirrel
);
6973 IF_HAS_KEYWORDS(if (pi
->pi_inverted
) rcode
= !rcode
;)
6975 debug_printf_exec("run_pipe: return %d\n", rcode
);
6979 argv
= command
->argv
? command
->argv
: (char **) &null_ptr
;
6981 const struct built_in_command
*x
;
6982 #if ENABLE_HUSH_FUNCTIONS
6983 const struct function
*funcp
;
6987 char **new_env
= NULL
;
6988 struct variable
*old_vars
= NULL
;
6990 if (argv
[command
->assignment_cnt
] == NULL
) {
6991 /* Assignments, but no command */
6992 /* Ensure redirects take effect (that is, create files).
6993 * Try "a=t >file" */
6994 #if 0 /* A few cases in testsuite fail with this code. FIXME */
6995 rcode
= redirect_and_varexp_helper(&new_env
, /*old_vars:*/ NULL
, command
, squirrel
, /*argv_expanded:*/ NULL
);
6996 /* Set shell variables */
7000 set_local_var(*argv
, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
7001 /* Do we need to flag set_local_var() errors?
7002 * "assignment to readonly var" and "putenv error"
7007 /* Redirect error sets $? to 1. Otherwise,
7008 * if evaluating assignment value set $?, retain it.
7009 * Try "false; q=`exit 2`; echo $?" - should print 2: */
7011 rcode
= G
.last_exitcode
;
7012 /* Exit, _skipping_ variable restoring code: */
7013 goto clean_up_and_ret0
;
7015 #else /* Older, bigger, but more correct code */
7017 rcode
= setup_redirects(command
, squirrel
);
7018 restore_redirects(squirrel
);
7019 /* Set shell variables */
7021 bb_putchar_stderr('+');
7023 char *p
= expand_string_to_string(*argv
, /*unbackslash:*/ 1);
7025 fprintf(stderr
, " %s", p
);
7026 debug_printf_exec("set shell var:'%s'->'%s'\n",
7028 set_local_var(p
, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
7029 /* Do we need to flag set_local_var() errors?
7030 * "assignment to readonly var" and "putenv error"
7035 bb_putchar_stderr('\n');
7036 /* Redirect error sets $? to 1. Otherwise,
7037 * if evaluating assignment value set $?, retain it.
7038 * Try "false; q=`exit 2`; echo $?" - should print 2: */
7040 rcode
= G
.last_exitcode
;
7041 IF_HAS_KEYWORDS(if (pi
->pi_inverted
) rcode
= !rcode
;)
7043 debug_printf_exec("run_pipe: return %d\n", rcode
);
7048 /* Expand the rest into (possibly) many strings each */
7049 #if ENABLE_HUSH_BASH_COMPAT
7050 if (command
->cmd_type
== CMD_SINGLEWORD_NOGLOB
) {
7051 argv_expanded
= expand_strvec_to_strvec_singleword_noglob(argv
+ command
->assignment_cnt
);
7055 argv_expanded
= expand_strvec_to_strvec(argv
+ command
->assignment_cnt
);
7058 /* if someone gives us an empty string: `cmd with empty output` */
7059 if (!argv_expanded
[0]) {
7060 free(argv_expanded
);
7062 return G
.last_exitcode
;
7065 x
= find_builtin(argv_expanded
[0]);
7066 #if ENABLE_HUSH_FUNCTIONS
7069 funcp
= find_function(argv_expanded
[0]);
7073 if (x
->b_function
== builtin_exec
&& argv_expanded
[1] == NULL
) {
7074 debug_printf("exec with redirects only\n");
7075 rcode
= setup_redirects(command
, NULL
);
7076 goto clean_up_and_ret1
;
7079 rcode
= redirect_and_varexp_helper(&new_env
, &old_vars
, command
, squirrel
, argv_expanded
);
7082 debug_printf_exec(": builtin '%s' '%s'...\n",
7083 x
->b_cmd
, argv_expanded
[1]);
7085 rcode
= x
->b_function(argv_expanded
) & 0xff;
7088 #if ENABLE_HUSH_FUNCTIONS
7090 # if ENABLE_HUSH_LOCAL
7091 struct variable
**sv
;
7092 sv
= G
.shadowed_vars_pp
;
7093 G
.shadowed_vars_pp
= &old_vars
;
7095 debug_printf_exec(": function '%s' '%s'...\n",
7096 funcp
->name
, argv_expanded
[1]);
7097 rcode
= run_function(funcp
, argv_expanded
) & 0xff;
7098 # if ENABLE_HUSH_LOCAL
7099 G
.shadowed_vars_pp
= sv
;
7105 unset_vars(new_env
);
7107 /* clean_up_and_ret0: */
7108 restore_redirects(squirrel
);
7110 free(argv_expanded
);
7111 IF_HAS_KEYWORDS(if (pi
->pi_inverted
) rcode
= !rcode
;)
7113 debug_printf_exec("run_pipe return %d\n", rcode
);
7117 if (ENABLE_FEATURE_SH_NOFORK
) {
7118 int n
= find_applet_by_name(argv_expanded
[0]);
7119 if (n
>= 0 && APPLET_IS_NOFORK(n
)) {
7120 rcode
= redirect_and_varexp_helper(&new_env
, &old_vars
, command
, squirrel
, argv_expanded
);
7122 debug_printf_exec(": run_nofork_applet '%s' '%s'...\n",
7123 argv_expanded
[0], argv_expanded
[1]);
7124 rcode
= run_nofork_applet(n
, argv_expanded
);
7126 goto clean_up_and_ret
;
7129 /* It is neither builtin nor applet. We must fork. */
7133 /* NB: argv_expanded may already be created, and that
7134 * might include `cmd` runs! Do not rerun it! We *must*
7135 * use argv_expanded if it's non-NULL */
7137 /* Going to fork a child per each pipe member */
7142 while (cmd_no
< pi
->num_cmds
) {
7143 struct fd_pair pipefds
;
7145 volatile nommu_save_t nommu_save
;
7146 nommu_save
.new_env
= NULL
;
7147 nommu_save
.old_vars
= NULL
;
7148 nommu_save
.argv
= NULL
;
7149 nommu_save
.argv_from_re_execing
= NULL
;
7151 command
= &pi
->cmds
[cmd_no
];
7153 if (command
->argv
) {
7154 debug_printf_exec(": pipe member '%s' '%s'...\n",
7155 command
->argv
[0], command
->argv
[1]);
7157 debug_printf_exec(": pipe member with no argv\n");
7160 /* pipes are inserted between pairs of commands */
7163 if (cmd_no
< pi
->num_cmds
)
7164 xpiped_pair(pipefds
);
7166 command
->pid
= BB_MMU
? fork() : vfork();
7167 if (!command
->pid
) { /* child */
7169 disable_restore_tty_pgrp_on_exit();
7170 CLEAR_RANDOM_T(&G
.random_gen
); /* or else $RANDOM repeats in child */
7172 /* Every child adds itself to new process group
7173 * with pgid == pid_of_first_child_in_pipe */
7174 if (G
.run_list_level
== 1 && G_interactive_fd
) {
7177 if (pgrp
< 0) /* true for 1st process only */
7179 if (setpgid(0, pgrp
) == 0
7180 && pi
->followup
!= PIPE_BG
7181 && G_saved_tty_pgrp
/* we have ctty */
7183 /* We do it in *every* child, not just first,
7185 tcsetpgrp(G_interactive_fd
, pgrp
);
7189 if (pi
->alive_cmds
== 0 && pi
->followup
== PIPE_BG
) {
7190 /* 1st cmd in backgrounded pipe
7191 * should have its stdin /dev/null'ed */
7193 if (open(bb_dev_null
, O_RDONLY
))
7194 xopen("/", O_RDONLY
);
7196 xmove_fd(next_infd
, 0);
7198 xmove_fd(pipefds
.wr
, 1);
7201 /* Like bash, explicit redirects override pipes,
7202 * and the pipe fd is available for dup'ing. */
7203 if (setup_redirects(command
, NULL
))
7206 /* Stores to nommu_save list of env vars putenv'ed
7207 * (NOMMU, on MMU we don't need that) */
7208 /* cast away volatility... */
7209 pseudo_exec((nommu_save_t
*) &nommu_save
, command
, argv_expanded
);
7210 /* pseudo_exec() does not return */
7213 /* parent or error */
7214 #if ENABLE_HUSH_FAST
7216 //bb_error_msg("[%d] fork in run_pipe: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
7218 enable_restore_tty_pgrp_on_exit();
7220 /* Clean up after vforked child */
7221 free(nommu_save
.argv
);
7222 free(nommu_save
.argv_from_re_execing
);
7223 unset_vars(nommu_save
.new_env
);
7224 add_vars(nommu_save
.old_vars
);
7226 free(argv_expanded
);
7227 argv_expanded
= NULL
;
7228 if (command
->pid
< 0) { /* [v]fork failed */
7229 /* Clearly indicate, was it fork or vfork */
7230 bb_perror_msg(BB_MMU
? "vfork"+1 : "vfork");
7234 /* Second and next children need to know pid of first one */
7236 pi
->pgrp
= command
->pid
;
7242 if (cmd_no
< pi
->num_cmds
)
7244 /* Pass read (output) pipe end to next iteration */
7245 next_infd
= pipefds
.rd
;
7248 if (!pi
->alive_cmds
) {
7250 debug_printf_exec("run_pipe return 1 (all forks failed, no children)\n");
7255 debug_printf_exec("run_pipe return -1 (%u children started)\n", pi
->alive_cmds
);
7259 /* NB: called by pseudo_exec, and therefore must not modify any
7260 * global data until exec/_exit (we can be a child after vfork!) */
7261 static int run_list(struct pipe
*pi
)
7263 #if ENABLE_HUSH_CASE
7264 char *case_word
= NULL
;
7266 #if ENABLE_HUSH_LOOPS
7267 struct pipe
*loop_top
= NULL
;
7268 char **for_lcur
= NULL
;
7269 char **for_list
= NULL
;
7271 smallint last_followup
;
7273 #if ENABLE_HUSH_IF || ENABLE_HUSH_CASE
7274 smalluint cond_code
= 0;
7276 enum { cond_code
= 0 };
7279 smallint rword
; /* RES_foo */
7280 smallint last_rword
; /* ditto */
7283 debug_printf_exec("run_list start lvl %d\n", G
.run_list_level
);
7286 #if ENABLE_HUSH_LOOPS
7287 /* Check syntax for "for" */
7290 for (cpipe
= pi
; cpipe
; cpipe
= cpipe
->next
) {
7291 if (cpipe
->res_word
!= RES_FOR
&& cpipe
->res_word
!= RES_IN
)
7293 /* current word is FOR or IN (BOLD in comments below) */
7294 if (cpipe
->next
== NULL
) {
7295 syntax_error("malformed for");
7297 debug_printf_exec("run_list lvl %d return 1\n", G
.run_list_level
);
7300 /* "FOR v; do ..." and "for v IN a b; do..." are ok */
7301 if (cpipe
->next
->res_word
== RES_DO
)
7303 /* next word is not "do". It must be "in" then ("FOR v in ...") */
7304 if (cpipe
->res_word
== RES_IN
/* "for v IN a b; not_do..."? */
7305 || cpipe
->next
->res_word
!= RES_IN
/* FOR v not_do_and_not_in..."? */
7307 syntax_error("malformed for");
7309 debug_printf_exec("run_list lvl %d return 1\n", G
.run_list_level
);
7316 /* Past this point, all code paths should jump to ret: label
7317 * in order to return, no direct "return" statements please.
7318 * This helps to ensure that no memory is leaked. */
7326 last_rword
= RES_XXXX
;
7328 last_followup
= PIPE_SEQ
;
7329 rcode
= G
.last_exitcode
;
7331 /* Go through list of pipes, (maybe) executing them. */
7332 for (; pi
; pi
= IF_HUSH_LOOPS(rword
== RES_DONE
? loop_top
: ) pi
->next
) {
7336 IF_HAS_KEYWORDS(rword
= pi
->res_word
;)
7337 debug_printf_exec(": rword=%d cond_code=%d last_rword=%d\n",
7338 rword
, cond_code
, last_rword
);
7339 #if ENABLE_HUSH_LOOPS
7340 if ((rword
== RES_WHILE
|| rword
== RES_UNTIL
|| rword
== RES_FOR
)
7341 && loop_top
== NULL
/* avoid bumping G.depth_of_loop twice */
7343 /* start of a loop: remember where loop starts */
7348 /* Still in the same "if...", "then..." or "do..." branch? */
7349 if (IF_HAS_KEYWORDS(rword
== last_rword
&&) 1) {
7350 if ((rcode
== 0 && last_followup
== PIPE_OR
)
7351 || (rcode
!= 0 && last_followup
== PIPE_AND
)
7353 /* It is "<true> || CMD" or "<false> && CMD"
7354 * and we should not execute CMD */
7355 debug_printf_exec("skipped cmd because of || or &&\n");
7356 last_followup
= pi
->followup
;
7360 last_followup
= pi
->followup
;
7361 IF_HAS_KEYWORDS(last_rword
= rword
;)
7364 if (rword
== RES_THEN
) {
7365 /* if false; then ... fi has exitcode 0! */
7366 G
.last_exitcode
= rcode
= EXIT_SUCCESS
;
7367 /* "if <false> THEN cmd": skip cmd */
7371 if (rword
== RES_ELSE
|| rword
== RES_ELIF
) {
7372 /* "if <true> then ... ELSE/ELIF cmd":
7373 * skip cmd and all following ones */
7378 #if ENABLE_HUSH_LOOPS
7379 if (rword
== RES_FOR
) { /* && pi->num_cmds - always == 1 */
7381 /* first loop through for */
7383 static const char encoded_dollar_at
[] ALIGN1
= {
7384 SPECIAL_VAR_SYMBOL
, '@' | 0x80, SPECIAL_VAR_SYMBOL
, '\0'
7385 }; /* encoded representation of "$@" */
7386 static const char *const encoded_dollar_at_argv
[] = {
7387 encoded_dollar_at
, NULL
7388 }; /* argv list with one element: "$@" */
7391 vals
= (char**)encoded_dollar_at_argv
;
7392 if (pi
->next
->res_word
== RES_IN
) {
7393 /* if no variable values after "in" we skip "for" */
7394 if (!pi
->next
->cmds
[0].argv
) {
7395 G
.last_exitcode
= rcode
= EXIT_SUCCESS
;
7396 debug_printf_exec(": null FOR: exitcode EXIT_SUCCESS\n");
7399 vals
= pi
->next
->cmds
[0].argv
;
7400 } /* else: "for var; do..." -> assume "$@" list */
7401 /* create list of variable values */
7402 debug_print_strings("for_list made from", vals
);
7403 for_list
= expand_strvec_to_strvec(vals
);
7404 for_lcur
= for_list
;
7405 debug_print_strings("for_list", for_list
);
7408 /* "for" loop is over, clean up */
7414 /* Insert next value from for_lcur */
7415 /* note: *for_lcur already has quotes removed, $var expanded, etc */
7416 set_local_var(xasprintf("%s=%s", pi
->cmds
[0].argv
[0], *for_lcur
++), /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
7419 if (rword
== RES_IN
) {
7420 continue; /* "for v IN list;..." - "in" has no cmds anyway */
7422 if (rword
== RES_DONE
) {
7423 continue; /* "done" has no cmds too */
7426 #if ENABLE_HUSH_CASE
7427 if (rword
== RES_CASE
) {
7428 case_word
= expand_strvec_to_string(pi
->cmds
->argv
);
7431 if (rword
== RES_MATCH
) {
7434 if (!case_word
) /* "case ... matched_word) ... WORD)": we executed selected branch, stop */
7436 /* all prev words didn't match, does this one match? */
7437 argv
= pi
->cmds
->argv
;
7439 char *pattern
= expand_string_to_string(*argv
, /*unbackslash:*/ 1);
7440 /* TODO: which FNM_xxx flags to use? */
7441 cond_code
= (fnmatch(pattern
, case_word
, /*flags:*/ 0) != 0);
7443 if (cond_code
== 0) { /* match! we will execute this branch */
7444 free(case_word
); /* make future "word)" stop */
7452 if (rword
== RES_CASE_BODY
) { /* inside of a case branch */
7454 continue; /* not matched yet, skip this pipe */
7457 /* Just pressing <enter> in shell should check for jobs.
7458 * OTOH, in non-interactive shell this is useless
7459 * and only leads to extra job checks */
7460 if (pi
->num_cmds
== 0) {
7461 if (G_interactive_fd
)
7462 goto check_jobs_and_continue
;
7466 /* After analyzing all keywords and conditions, we decided
7467 * to execute this pipe. NB: have to do checkjobs(NULL)
7468 * after run_pipe to collect any background children,
7469 * even if list execution is to be stopped. */
7470 debug_printf_exec(": run_pipe with %d members\n", pi
->num_cmds
);
7473 #if ENABLE_HUSH_LOOPS
7474 G
.flag_break_continue
= 0;
7476 rcode
= r
= run_pipe(pi
); /* NB: rcode is a smallint */
7478 /* We ran a builtin, function, or group.
7479 * rcode is already known
7480 * and we don't need to wait for anything. */
7481 G
.last_exitcode
= rcode
;
7482 debug_printf_exec(": builtin/func exitcode %d\n", rcode
);
7483 check_and_run_traps();
7484 #if ENABLE_HUSH_LOOPS
7485 /* Was it "break" or "continue"? */
7486 if (G
.flag_break_continue
) {
7487 smallint fbc
= G
.flag_break_continue
;
7488 /* We might fall into outer *loop*,
7489 * don't want to break it too */
7491 G
.depth_break_continue
--;
7492 if (G
.depth_break_continue
== 0)
7493 G
.flag_break_continue
= 0;
7494 /* else: e.g. "continue 2" should *break* once, *then* continue */
7495 } /* else: "while... do... { we are here (innermost list is not a loop!) };...done" */
7496 if (G
.depth_break_continue
!= 0 || fbc
== BC_BREAK
)
7497 goto check_jobs_and_break
;
7498 /* "continue": simulate end of loop */
7503 #if ENABLE_HUSH_FUNCTIONS
7504 if (G
.flag_return_in_progress
== 1) {
7505 /* same as "goto check_jobs_and_break" */
7510 } else if (pi
->followup
== PIPE_BG
) {
7511 /* What does bash do with attempts to background builtins? */
7512 /* even bash 3.2 doesn't do that well with nested bg:
7513 * try "{ { sleep 10; echo DEEP; } & echo HERE; } &".
7514 * I'm NOT treating inner &'s as jobs */
7515 check_and_run_traps();
7517 if (G
.run_list_level
== 1)
7520 /* Last command's pid goes to $! */
7521 G
.last_bg_pid
= pi
->cmds
[pi
->num_cmds
- 1].pid
;
7522 G
.last_exitcode
= rcode
= EXIT_SUCCESS
;
7523 debug_printf_exec(": cmd&: exitcode EXIT_SUCCESS\n");
7526 if (G
.run_list_level
== 1 && G_interactive_fd
) {
7527 /* Waits for completion, then fg's main shell */
7528 rcode
= checkjobs_and_fg_shell(pi
);
7529 debug_printf_exec(": checkjobs_and_fg_shell exitcode %d\n", rcode
);
7530 check_and_run_traps();
7533 { /* This one just waits for completion */
7534 rcode
= checkjobs(pi
);
7535 debug_printf_exec(": checkjobs exitcode %d\n", rcode
);
7536 check_and_run_traps();
7538 G
.last_exitcode
= rcode
;
7542 /* Analyze how result affects subsequent commands */
7544 if (rword
== RES_IF
|| rword
== RES_ELIF
)
7547 #if ENABLE_HUSH_LOOPS
7548 /* Beware of "while false; true; do ..."! */
7550 && (pi
->next
->res_word
== RES_DO
|| pi
->next
->res_word
== RES_DONE
)
7551 /* check for RES_DONE is needed for "while ...; do \n done" case */
7553 if (rword
== RES_WHILE
) {
7555 /* "while false; do...done" - exitcode 0 */
7556 G
.last_exitcode
= rcode
= EXIT_SUCCESS
;
7557 debug_printf_exec(": while expr is false: breaking (exitcode:EXIT_SUCCESS)\n");
7558 goto check_jobs_and_break
;
7561 if (rword
== RES_UNTIL
) {
7563 debug_printf_exec(": until expr is true: breaking\n");
7564 check_jobs_and_break
:
7572 check_jobs_and_continue
:
7579 #if ENABLE_HUSH_LOOPS
7584 #if ENABLE_HUSH_CASE
7588 debug_printf_exec("run_list lvl %d return %d\n", G
.run_list_level
+ 1, rcode
);
7592 /* Select which version we will use */
7593 static int run_and_free_list(struct pipe
*pi
)
7596 debug_printf_exec("run_and_free_list entered\n");
7597 if (!G
.o_opt
[OPT_O_NOEXEC
]) {
7598 debug_printf_exec(": run_list: 1st pipe with %d cmds\n", pi
->num_cmds
);
7599 rcode
= run_list(pi
);
7601 /* free_pipe_list has the side effect of clearing memory.
7602 * In the long run that function can be merged with run_list,
7603 * but doing that now would hobble the debugging effort. */
7605 debug_printf_exec("run_and_free_list return %d\n", rcode
);
7610 static void install_sighandlers(unsigned mask
)
7612 sighandler_t old_handler
;
7614 while ((mask
>>= 1) != 0) {
7618 old_handler
= install_sighandler(sig
, pick_sighandler(sig
));
7619 /* POSIX allows shell to re-enable SIGCHLD
7620 * even if it was SIG_IGN on entry.
7621 * Therefore we skip IGN check for it:
7625 if (old_handler
== SIG_IGN
) {
7626 /* oops... restore back to IGN, and record this fact */
7627 install_sighandler(sig
, old_handler
);
7629 G
.traps
= xzalloc(sizeof(G
.traps
[0]) * NSIG
);
7631 G
.traps
[sig
] = xzalloc(1); /* == xstrdup(""); */
7636 /* Called a few times only (or even once if "sh -c") */
7637 static void install_special_sighandlers(void)
7641 /* Which signals are shell-special? */
7642 mask
= (1 << SIGQUIT
) | (1 << SIGCHLD
);
7643 if (G_interactive_fd
) {
7644 mask
|= SPECIAL_INTERACTIVE_SIGS
;
7645 if (G_saved_tty_pgrp
) /* we have ctty, job control sigs work */
7646 mask
|= SPECIAL_JOBSTOP_SIGS
;
7648 /* Careful, do not re-install handlers we already installed */
7649 if (G
.special_sig_mask
!= mask
) {
7650 unsigned diff
= mask
& ~G
.special_sig_mask
;
7651 G
.special_sig_mask
= mask
;
7652 install_sighandlers(diff
);
7658 /* Set handlers to restore tty pgrp and exit */
7659 static void install_fatal_sighandlers(void)
7663 /* We will restore tty pgrp on these signals */
7665 + (1 << SIGILL
) * HUSH_DEBUG
7666 + (1 << SIGFPE
) * HUSH_DEBUG
7667 + (1 << SIGBUS
) * HUSH_DEBUG
7668 + (1 << SIGSEGV
) * HUSH_DEBUG
7669 + (1 << SIGTRAP
) * HUSH_DEBUG
7671 /* bash 3.2 seems to handle these just like 'fatal' ones */
7674 /* if we are interactive, SIGHUP, SIGTERM and SIGINT are special sigs.
7675 * if we aren't interactive... but in this case
7676 * we never want to restore pgrp on exit, and this fn is not called
7678 /*+ (1 << SIGHUP )*/
7679 /*+ (1 << SIGTERM)*/
7680 /*+ (1 << SIGINT )*/
7682 G_fatal_sig_mask
= mask
;
7684 install_sighandlers(mask
);
7688 static int set_mode(int state
, char mode
, const char *o_opt
)
7693 G
.o_opt
[OPT_O_NOEXEC
] = state
;
7696 IF_HUSH_MODE_X(G_x_mode
= state
;)
7700 /* "set -+o" without parameter.
7701 * in bash, set -o produces this output:
7705 * We always use the second form.
7707 const char *p
= o_opt_strings
;
7710 printf("set %co %s\n", (G
.o_opt
[idx
] ? '-' : '+'), p
);
7716 idx
= index_in_strings(o_opt_strings
, o_opt
);
7718 G
.o_opt
[idx
] = state
;
7722 return EXIT_FAILURE
;
7724 return EXIT_SUCCESS
;
7727 int hush_main(int argc
, char **argv
) MAIN_EXTERNALLY_VISIBLE
;
7728 int hush_main(int argc
, char **argv
)
7731 OPT_login
= (1 << 0),
7735 unsigned builtin_argc
;
7737 struct variable
*cur_var
;
7738 struct variable
*shell_ver
;
7741 if (EXIT_SUCCESS
!= 0) /* if EXIT_SUCCESS == 0, it is already done */
7742 G
.last_exitcode
= EXIT_SUCCESS
;
7743 #if ENABLE_HUSH_FAST
7744 G
.count_SIGCHLD
++; /* ensure it is != G.handled_SIGCHLD */
7747 G
.argv0_for_re_execing
= argv
[0];
7749 /* Deal with HUSH_VERSION */
7750 shell_ver
= xzalloc(sizeof(*shell_ver
));
7751 shell_ver
->flg_export
= 1;
7752 shell_ver
->flg_read_only
= 1;
7753 /* Code which handles ${var<op>...} needs writable values for all variables,
7754 * therefore we xstrdup: */
7755 shell_ver
->varstr
= xstrdup(hush_version_str
);
7756 /* Create shell local variables from the values
7757 * currently living in the environment */
7758 debug_printf_env("unsetenv '%s'\n", "HUSH_VERSION");
7759 unsetenv("HUSH_VERSION"); /* in case it exists in initial env */
7760 G
.top_var
= shell_ver
;
7761 cur_var
= G
.top_var
;
7764 char *value
= strchr(*e
, '=');
7765 if (value
) { /* paranoia */
7766 cur_var
->next
= xzalloc(sizeof(*cur_var
));
7767 cur_var
= cur_var
->next
;
7768 cur_var
->varstr
= *e
;
7769 cur_var
->max_len
= strlen(*e
);
7770 cur_var
->flg_export
= 1;
7774 /* (Re)insert HUSH_VERSION into env (AFTER we scanned the env!) */
7775 debug_printf_env("putenv '%s'\n", shell_ver
->varstr
);
7776 putenv(shell_ver
->varstr
);
7779 set_pwd_var(/*exp:*/ 1);
7780 /* bash also exports SHLVL and _,
7781 * and sets (but doesn't export) the following variables:
7783 * BASH_VERSINFO=([0]="3" [1]="2" [2]="0" [3]="1" [4]="release" [5]="i386-pc-linux-gnu")
7784 * BASH_VERSION='3.2.0(1)-release'
7786 * MACHTYPE=i386-pc-linux-gnu
7788 * HOSTNAME=<xxxxxxxxxx>
7789 * PPID=<NNNNN> - we also do it elsewhere
7800 * PIPESTATUS=([0]="0")
7801 * HISTFILE=/<xxx>/.bash_history
7805 * PATH=/usr/gnu/bin:/usr/local/bin:/bin:/usr/bin:.
7807 * SHELLOPTS=braceexpand:emacs:hashall:histexpand:history:interactive-comments:monitor
7817 #if ENABLE_FEATURE_EDITING
7818 G
.line_input_state
= new_line_input_t(FOR_SHELL
);
7821 /* Initialize some more globals to non-zero values */
7822 cmdedit_update_prompt();
7824 if (setjmp(die_jmp
)) {
7825 /* xfunc has failed! die die die */
7826 /* no EXIT traps, this is an escape hatch! */
7828 hush_exit(xfunc_error_retval
);
7831 /* Shell is non-interactive at first. We need to call
7832 * install_special_sighandlers() if we are going to execute "sh <script>",
7833 * "sh -c <cmds>" or login shell's /etc/profile and friends.
7834 * If we later decide that we are interactive, we run install_special_sighandlers()
7835 * in order to intercept (more) signals.
7839 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/sh.html */
7840 flags
= (argv
[0] && argv
[0][0] == '-') ? OPT_login
: 0;
7843 opt
= getopt(argc
, argv
, "+c:xinsl"
7846 # if ENABLE_HUSH_FUNCTIONS
7856 * sh ... -c 'script'
7857 * sh ... -c 'script' ARG0 [ARG1...]
7858 * On NOMMU, if builtin_argc != 0,
7859 * sh ... -c 'builtin' BARGV... "" ARG0 [ARG1...]
7860 * "" needs to be replaced with NULL
7861 * and BARGV vector fed to builtin function.
7862 * Note: the form without ARG0 never happens:
7863 * sh ... -c 'builtin' BARGV... ""
7866 G
.root_pid
= getpid();
7867 G
.root_ppid
= getppid();
7869 G
.global_argv
= argv
+ optind
;
7870 G
.global_argc
= argc
- optind
;
7872 /* -c 'builtin' [BARGV...] "" ARG0 [ARG1...] */
7873 const struct built_in_command
*x
;
7875 install_special_sighandlers();
7876 x
= find_builtin(optarg
);
7877 if (x
) { /* paranoia */
7878 G
.global_argc
-= builtin_argc
; /* skip [BARGV...] "" */
7879 G
.global_argv
+= builtin_argc
;
7880 G
.global_argv
[-1] = NULL
; /* replace "" */
7882 G
.last_exitcode
= x
->b_function(argv
+ optind
- 1);
7886 if (!G
.global_argv
[0]) {
7887 /* -c 'script' (no params): prevent empty $0 */
7888 G
.global_argv
--; /* points to argv[i] of 'script' */
7889 G
.global_argv
[0] = argv
[0];
7891 } /* else -c 'script' ARG0 [ARG1...]: $0 is ARG0 */
7892 install_special_sighandlers();
7893 parse_and_run_string(optarg
);
7896 /* Well, we cannot just declare interactiveness,
7897 * we have to have some stuff (ctty, etc) */
7898 /* G_interactive_fd++; */
7901 /* "-s" means "read from stdin", but this is how we always
7902 * operate, so simply do nothing here. */
7908 case '<': /* "big heredoc" support */
7909 full_write1_str(optarg
);
7912 unsigned long long empty_trap_mask
;
7914 G
.root_pid
= bb_strtou(optarg
, &optarg
, 16);
7916 G
.root_ppid
= bb_strtou(optarg
, &optarg
, 16);
7918 G
.last_bg_pid
= bb_strtou(optarg
, &optarg
, 16);
7920 G
.last_exitcode
= bb_strtou(optarg
, &optarg
, 16);
7922 builtin_argc
= bb_strtou(optarg
, &optarg
, 16);
7924 empty_trap_mask
= bb_strtoull(optarg
, &optarg
, 16);
7925 if (empty_trap_mask
!= 0) {
7927 install_special_sighandlers();
7928 G
.traps
= xzalloc(sizeof(G
.traps
[0]) * NSIG
);
7929 for (sig
= 1; sig
< NSIG
; sig
++) {
7930 if (empty_trap_mask
& (1LL << sig
)) {
7931 G
.traps
[sig
] = xzalloc(1); /* == xstrdup(""); */
7932 install_sighandler(sig
, SIG_IGN
);
7936 # if ENABLE_HUSH_LOOPS
7938 G
.depth_of_loop
= bb_strtou(optarg
, &optarg
, 16);
7944 set_local_var(xstrdup(optarg
), /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ opt
== 'R');
7946 # if ENABLE_HUSH_FUNCTIONS
7948 struct function
*funcp
= new_function(optarg
);
7949 /* funcp->name is already set to optarg */
7950 /* funcp->body is set to NULL. It's a special case. */
7951 funcp
->body_as_string
= argv
[optind
];
7959 if (set_mode(1, opt
, NULL
) == 0) /* no error */
7963 fprintf(stderr
, "Usage: sh [FILE]...\n"
7964 " or: sh -c command [args]...\n\n");
7970 } /* option parsing loop */
7972 /* Skip options. Try "hush -l": $1 should not be "-l"! */
7973 G
.global_argc
= argc
- (optind
- 1);
7974 G
.global_argv
= argv
+ (optind
- 1);
7975 G
.global_argv
[0] = argv
[0];
7978 G
.root_pid
= getpid();
7979 G
.root_ppid
= getppid();
7982 /* If we are login shell... */
7983 if (flags
& OPT_login
) {
7985 debug_printf("sourcing /etc/profile\n");
7986 input
= fopen_for_read("/etc/profile");
7987 if (input
!= NULL
) {
7988 close_on_exec_on(fileno(input
));
7989 install_special_sighandlers();
7990 parse_and_run_file(input
);
7993 /* bash: after sourcing /etc/profile,
7994 * tries to source (in the given order):
7995 * ~/.bash_profile, ~/.bash_login, ~/.profile,
7996 * stopping on first found. --noprofile turns this off.
7997 * bash also sources ~/.bash_logout on exit.
7998 * If called as sh, skips .bash_XXX files.
8002 if (G
.global_argv
[1]) {
8005 * "bash <script>" (which is never interactive (unless -i?))
8006 * sources $BASH_ENV here (without scanning $PATH).
8007 * If called as sh, does the same but with $ENV.
8011 debug_printf("running script '%s'\n", G
.global_argv
[0]);
8012 input
= xfopen_for_read(G
.global_argv
[0]);
8013 close_on_exec_on(fileno(input
));
8014 install_special_sighandlers();
8015 parse_and_run_file(input
);
8016 #if ENABLE_FEATURE_CLEAN_UP
8022 /* Up to here, shell was non-interactive. Now it may become one.
8023 * NB: don't forget to (re)run install_special_sighandlers() as needed.
8026 /* A shell is interactive if the '-i' flag was given,
8027 * or if all of the following conditions are met:
8029 * no arguments remaining or the -s flag given
8030 * standard input is a terminal
8031 * standard output is a terminal
8032 * Refer to Posix.2, the description of the 'sh' utility.
8035 if (isatty(STDIN_FILENO
) && isatty(STDOUT_FILENO
)) {
8036 G_saved_tty_pgrp
= tcgetpgrp(STDIN_FILENO
);
8037 debug_printf("saved_tty_pgrp:%d\n", G_saved_tty_pgrp
);
8038 if (G_saved_tty_pgrp
< 0)
8039 G_saved_tty_pgrp
= 0;
8041 /* try to dup stdin to high fd#, >= 255 */
8042 G_interactive_fd
= fcntl(STDIN_FILENO
, F_DUPFD
, 255);
8043 if (G_interactive_fd
< 0) {
8044 /* try to dup to any fd */
8045 G_interactive_fd
= dup(STDIN_FILENO
);
8046 if (G_interactive_fd
< 0) {
8048 G_interactive_fd
= 0;
8049 G_saved_tty_pgrp
= 0;
8052 // TODO: track & disallow any attempts of user
8053 // to (inadvertently) close/redirect G_interactive_fd
8055 debug_printf("interactive_fd:%d\n", G_interactive_fd
);
8056 if (G_interactive_fd
) {
8057 close_on_exec_on(G_interactive_fd
);
8059 if (G_saved_tty_pgrp
) {
8060 /* If we were run as 'hush &', sleep until we are
8061 * in the foreground (tty pgrp == our pgrp).
8062 * If we get started under a job aware app (like bash),
8063 * make sure we are now in charge so we don't fight over
8064 * who gets the foreground */
8066 pid_t shell_pgrp
= getpgrp();
8067 G_saved_tty_pgrp
= tcgetpgrp(G_interactive_fd
);
8068 if (G_saved_tty_pgrp
== shell_pgrp
)
8070 /* send TTIN to ourself (should stop us) */
8071 kill(- shell_pgrp
, SIGTTIN
);
8075 /* Install more signal handlers */
8076 install_special_sighandlers();
8078 if (G_saved_tty_pgrp
) {
8079 /* Set other signals to restore saved_tty_pgrp */
8080 install_fatal_sighandlers();
8081 /* Put ourselves in our own process group
8082 * (bash, too, does this only if ctty is available) */
8083 bb_setpgrp(); /* is the same as setpgid(our_pid, our_pid); */
8084 /* Grab control of the terminal */
8085 tcsetpgrp(G_interactive_fd
, getpid());
8087 /* -1 is special - makes xfuncs longjmp, not exit
8088 * (we reset die_sleep = 0 whereever we [v]fork) */
8089 enable_restore_tty_pgrp_on_exit(); /* sets die_sleep = -1 */
8091 # if ENABLE_HUSH_SAVEHISTORY && MAX_HISTORY > 0
8093 const char *hp
= get_local_var_value("HISTFILE");
8095 hp
= get_local_var_value("HOME");
8097 hp
= concat_path_file(hp
, ".hush_history");
8102 G
.line_input_state
->hist_file
= hp
;
8103 //set_local_var(xasprintf("HISTFILE=%s", ...));
8105 # if ENABLE_FEATURE_SH_HISTFILESIZE
8106 hp
= get_local_var_value("HISTFILESIZE");
8107 G
.line_input_state
->max_history
= size_from_HISTFILESIZE(hp
);
8112 install_special_sighandlers();
8114 #elif ENABLE_HUSH_INTERACTIVE
8115 /* No job control compiled in, only prompt/line editing */
8116 if (isatty(STDIN_FILENO
) && isatty(STDOUT_FILENO
)) {
8117 G_interactive_fd
= fcntl(STDIN_FILENO
, F_DUPFD
, 255);
8118 if (G_interactive_fd
< 0) {
8119 /* try to dup to any fd */
8120 G_interactive_fd
= dup(STDIN_FILENO
);
8121 if (G_interactive_fd
< 0)
8123 G_interactive_fd
= 0;
8126 if (G_interactive_fd
) {
8127 close_on_exec_on(G_interactive_fd
);
8129 install_special_sighandlers();
8131 /* We have interactiveness code disabled */
8132 install_special_sighandlers();
8135 * if interactive but not a login shell, sources ~/.bashrc
8136 * (--norc turns this off, --rcfile <file> overrides)
8139 if (!ENABLE_FEATURE_SH_EXTRA_QUIET
&& G_interactive_fd
) {
8140 /* note: ash and hush share this string */
8141 printf("\n\n%s %s\n"
8142 IF_HUSH_HELP("Enter 'help' for a list of built-in commands.\n")
8145 "hush - the humble shell"
8149 parse_and_run_file(stdin
);
8152 hush_exit(G
.last_exitcode
);
8157 int msh_main(int argc
, char **argv
) MAIN_EXTERNALLY_VISIBLE
;
8158 int msh_main(int argc
, char **argv
)
8160 //bb_error_msg("msh is deprecated, please use hush instead");
8161 return hush_main(argc
, argv
);
8169 static int FAST_FUNC
builtin_true(char **argv UNUSED_PARAM
)
8174 static int run_applet_main(char **argv
, int (*applet_main_func
)(int argc
, char **argv
))
8181 return applet_main_func(argc
, argv
- argc
);
8184 static int FAST_FUNC
builtin_test(char **argv
)
8186 return run_applet_main(argv
, test_main
);
8189 static int FAST_FUNC
builtin_echo(char **argv
)
8191 return run_applet_main(argv
, echo_main
);
8195 static int FAST_FUNC
builtin_printf(char **argv
)
8197 return run_applet_main(argv
, printf_main
);
8201 static char **skip_dash_dash(char **argv
)
8204 if (argv
[0] && argv
[0][0] == '-' && argv
[0][1] == '-' && argv
[0][2] == '\0')
8209 static int FAST_FUNC
builtin_eval(char **argv
)
8211 int rcode
= EXIT_SUCCESS
;
8213 argv
= skip_dash_dash(argv
);
8215 char *str
= expand_strvec_to_string(argv
);
8217 * eval "echo Hi; done" ("done" is syntax error):
8218 * "echo Hi" will not execute too.
8220 parse_and_run_string(str
);
8222 rcode
= G
.last_exitcode
;
8227 static int FAST_FUNC
builtin_cd(char **argv
)
8231 argv
= skip_dash_dash(argv
);
8233 if (newdir
== NULL
) {
8234 /* bash does nothing (exitcode 0) if HOME is ""; if it's unset,
8235 * bash says "bash: cd: HOME not set" and does nothing
8238 const char *home
= get_local_var_value("HOME");
8239 newdir
= home
? home
: "/";
8241 if (chdir(newdir
)) {
8242 /* Mimic bash message exactly */
8243 bb_perror_msg("cd: %s", newdir
);
8244 return EXIT_FAILURE
;
8246 /* Read current dir (get_cwd(1) is inside) and set PWD.
8247 * Note: do not enforce exporting. If PWD was unset or unexported,
8248 * set it again, but do not export. bash does the same.
8250 set_pwd_var(/*exp:*/ 0);
8251 return EXIT_SUCCESS
;
8254 static int FAST_FUNC
builtin_exec(char **argv
)
8256 argv
= skip_dash_dash(argv
);
8257 if (argv
[0] == NULL
)
8258 return EXIT_SUCCESS
; /* bash does this */
8260 /* Careful: we can end up here after [v]fork. Do not restore
8261 * tty pgrp then, only top-level shell process does that */
8262 if (G_saved_tty_pgrp
&& getpid() == G
.root_pid
)
8263 tcsetpgrp(G_interactive_fd
, G_saved_tty_pgrp
);
8265 /* TODO: if exec fails, bash does NOT exit! We do.
8266 * We'll need to undo trap cleanup (it's inside execvp_or_die)
8267 * and tcsetpgrp, and this is inherently racy.
8269 execvp_or_die(argv
);
8272 static int FAST_FUNC
builtin_exit(char **argv
)
8274 debug_printf_exec("%s()\n", __func__
);
8276 /* interactive bash:
8277 * # trap "echo EEE" EXIT
8280 * There are stopped jobs.
8281 * (if there are _stopped_ jobs, running ones don't count)
8284 * EEE (then bash exits)
8286 * TODO: we can use G.exiting = -1 as indicator "last cmd was exit"
8289 /* note: EXIT trap is run by hush_exit */
8290 argv
= skip_dash_dash(argv
);
8291 if (argv
[0] == NULL
)
8292 hush_exit(G
.last_exitcode
);
8293 /* mimic bash: exit 123abc == exit 255 + error msg */
8294 xfunc_error_retval
= 255;
8295 /* bash: exit -2 == exit 254, no error msg */
8296 hush_exit(xatoi(argv
[0]) & 0xff);
8299 static void print_escaped(const char *s
)
8304 const char *p
= strchrnul(s
, '\'');
8305 /* print 'xxxx', possibly just '' */
8306 printf("'%.*s'", (int)(p
- s
), s
);
8311 /* s points to '; print "'''...'''" */
8313 do putchar('\''); while (*++s
== '\'');
8318 #if !ENABLE_HUSH_LOCAL
8319 #define helper_export_local(argv, exp, lvl) \
8320 helper_export_local(argv, exp)
8322 static void helper_export_local(char **argv
, int exp
, int lvl
)
8326 char *name_end
= strchrnul(name
, '=');
8328 /* So far we do not check that name is valid (TODO?) */
8330 if (*name_end
== '\0') {
8331 struct variable
*var
, **vpp
;
8333 vpp
= get_ptr_to_local_var(name
, name_end
- name
);
8334 var
= vpp
? *vpp
: NULL
;
8336 if (exp
== -1) { /* unexporting? */
8337 /* export -n NAME (without =VALUE) */
8339 var
->flg_export
= 0;
8340 debug_printf_env("%s: unsetenv '%s'\n", __func__
, name
);
8342 } /* else: export -n NOT_EXISTING_VAR: no-op */
8345 if (exp
== 1) { /* exporting? */
8346 /* export NAME (without =VALUE) */
8348 var
->flg_export
= 1;
8349 debug_printf_env("%s: putenv '%s'\n", __func__
, var
->varstr
);
8350 putenv(var
->varstr
);
8354 /* Exporting non-existing variable.
8355 * bash does not put it in environment,
8356 * but remembers that it is exported,
8357 * and does put it in env when it is set later.
8358 * We just set it to "" and export. */
8359 /* Or, it's "local NAME" (without =VALUE).
8360 * bash sets the value to "". */
8361 name
= xasprintf("%s=", name
);
8363 /* (Un)exporting/making local NAME=VALUE */
8364 name
= xstrdup(name
);
8366 set_local_var(name
, /*exp:*/ exp
, /*lvl:*/ lvl
, /*ro:*/ 0);
8370 static int FAST_FUNC
builtin_export(char **argv
)
8372 unsigned opt_unexport
;
8374 #if ENABLE_HUSH_EXPORT_N
8375 /* "!": do not abort on errors */
8376 opt_unexport
= getopt32(argv
, "!n");
8377 if (opt_unexport
== (uint32_t)-1)
8378 return EXIT_FAILURE
;
8385 if (argv
[0] == NULL
) {
8392 /* ash emits: export VAR='VAL'
8393 * bash: declare -x VAR="VAL"
8394 * we follow ash example */
8395 const char *s
= *e
++;
8396 const char *p
= strchr(s
, '=');
8398 if (!p
) /* wtf? take next variable */
8401 printf("export %.*s", (int)(p
- s
) + 1, s
);
8402 print_escaped(p
+ 1);
8406 /*fflush_all(); - done after each builtin anyway */
8408 return EXIT_SUCCESS
;
8411 helper_export_local(argv
, (opt_unexport
? -1 : 1), 0);
8413 return EXIT_SUCCESS
;
8416 #if ENABLE_HUSH_LOCAL
8417 static int FAST_FUNC
builtin_local(char **argv
)
8419 if (G
.func_nest_level
== 0) {
8420 bb_error_msg("%s: not in a function", argv
[0]);
8421 return EXIT_FAILURE
; /* bash compat */
8423 helper_export_local(argv
, 0, G
.func_nest_level
);
8424 return EXIT_SUCCESS
;
8428 static int FAST_FUNC
builtin_trap(char **argv
)
8434 G
.traps
= xzalloc(sizeof(G
.traps
[0]) * NSIG
);
8439 /* No args: print all trapped */
8440 for (i
= 0; i
< NSIG
; ++i
) {
8443 print_escaped(G
.traps
[i
]);
8444 /* note: bash adds "SIG", but only if invoked
8445 * as "bash". If called as "sh", or if set -o posix,
8446 * then it prints short signal names.
8447 * We are printing short names: */
8448 printf(" %s\n", get_signame(i
));
8451 /*fflush_all(); - done after each builtin anyway */
8452 return EXIT_SUCCESS
;
8456 /* If first arg is a number: reset all specified signals */
8457 sig
= bb_strtou(*argv
, NULL
, 10);
8463 sighandler_t handler
;
8465 sig
= get_signum(*argv
++);
8466 if (sig
< 0 || sig
>= NSIG
) {
8468 /* Mimic bash message exactly */
8469 bb_perror_msg("trap: %s: invalid signal specification", argv
[-1]);
8474 G
.traps
[sig
] = xstrdup(new_cmd
);
8476 debug_printf("trap: setting SIG%s (%i) to '%s'\n",
8477 get_signame(sig
), sig
, G
.traps
[sig
]);
8479 /* There is no signal for 0 (EXIT) */
8484 handler
= (new_cmd
[0] ? record_pending_signo
: SIG_IGN
);
8486 /* We are removing trap handler */
8487 handler
= pick_sighandler(sig
);
8488 install_sighandler(sig
, handler
);
8493 if (!argv
[1]) { /* no second arg */
8494 bb_error_msg("trap: invalid arguments");
8495 return EXIT_FAILURE
;
8498 /* First arg is "-": reset all specified to default */
8499 /* First arg is "--": skip it, the rest is "handler SIGs..." */
8500 /* Everything else: set arg as signal handler
8501 * (includes "" case, which ignores signal) */
8502 if (argv
[0][0] == '-') {
8503 if (argv
[0][1] == '\0') { /* "-" */
8504 /* new_cmd remains NULL: "reset these sigs" */
8507 if (argv
[0][1] == '-' && argv
[0][2] == '\0') { /* "--" */
8510 /* else: "-something", no special meaning */
8515 goto process_sig_list
;
8518 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/type.html */
8519 static int FAST_FUNC
builtin_type(char **argv
)
8521 int ret
= EXIT_SUCCESS
;
8527 if (0) {} /* make conditional compile easier below */
8528 /*else if (find_alias(*argv))
8529 type = "an alias";*/
8530 #if ENABLE_HUSH_FUNCTIONS
8531 else if (find_function(*argv
))
8532 type
= "a function";
8534 else if (find_builtin(*argv
))
8535 type
= "a shell builtin";
8536 else if ((path
= find_in_path(*argv
)) != NULL
)
8539 bb_error_msg("type: %s: not found", *argv
);
8544 printf("%s is %s\n", *argv
, type
);
8552 /* built-in 'fg' and 'bg' handler */
8553 static int FAST_FUNC
builtin_fg_bg(char **argv
)
8558 if (!G_interactive_fd
)
8559 return EXIT_FAILURE
;
8561 /* If they gave us no args, assume they want the last backgrounded task */
8563 for (pi
= G
.job_list
; pi
; pi
= pi
->next
) {
8564 if (pi
->jobid
== G
.last_jobid
) {
8568 bb_error_msg("%s: no current job", argv
[0]);
8569 return EXIT_FAILURE
;
8571 if (sscanf(argv
[1], "%%%d", &jobnum
) != 1) {
8572 bb_error_msg("%s: bad argument '%s'", argv
[0], argv
[1]);
8573 return EXIT_FAILURE
;
8575 for (pi
= G
.job_list
; pi
; pi
= pi
->next
) {
8576 if (pi
->jobid
== jobnum
) {
8580 bb_error_msg("%s: %d: no such job", argv
[0], jobnum
);
8581 return EXIT_FAILURE
;
8583 /* TODO: bash prints a string representation
8584 * of job being foregrounded (like "sleep 1 | cat") */
8585 if (argv
[0][0] == 'f' && G_saved_tty_pgrp
) {
8586 /* Put the job into the foreground. */
8587 tcsetpgrp(G_interactive_fd
, pi
->pgrp
);
8590 /* Restart the processes in the job */
8591 debug_printf_jobs("reviving %d procs, pgrp %d\n", pi
->num_cmds
, pi
->pgrp
);
8592 for (i
= 0; i
< pi
->num_cmds
; i
++) {
8593 debug_printf_jobs("reviving pid %d\n", pi
->cmds
[i
].pid
);
8595 pi
->stopped_cmds
= 0;
8597 i
= kill(- pi
->pgrp
, SIGCONT
);
8599 if (errno
== ESRCH
) {
8600 delete_finished_bg_job(pi
);
8601 return EXIT_SUCCESS
;
8603 bb_perror_msg("kill (SIGCONT)");
8606 if (argv
[0][0] == 'f') {
8608 return checkjobs_and_fg_shell(pi
);
8610 return EXIT_SUCCESS
;
8614 #if ENABLE_HUSH_HELP
8615 static int FAST_FUNC
builtin_help(char **argv UNUSED_PARAM
)
8617 const struct built_in_command
*x
;
8620 "Built-in commands:\n"
8621 "------------------\n");
8622 for (x
= bltins1
; x
!= &bltins1
[ARRAY_SIZE(bltins1
)]; x
++) {
8624 printf("%-10s%s\n", x
->b_cmd
, x
->b_descr
);
8627 return EXIT_SUCCESS
;
8632 static int FAST_FUNC
builtin_jobs(char **argv UNUSED_PARAM
)
8635 const char *status_string
;
8637 for (job
= G
.job_list
; job
; job
= job
->next
) {
8638 if (job
->alive_cmds
== job
->stopped_cmds
)
8639 status_string
= "Stopped";
8641 status_string
= "Running";
8643 printf(JOB_STATUS_FORMAT
, job
->jobid
, status_string
, job
->cmdtext
);
8645 return EXIT_SUCCESS
;
8650 static int FAST_FUNC
builtin_memleak(char **argv UNUSED_PARAM
)
8655 # ifdef M_TRIM_THRESHOLD
8656 /* Optional. Reduces probability of false positives */
8659 /* Crude attempt to find where "free memory" starts,
8660 * sans fragmentation. */
8662 l
= (unsigned long)p
;
8665 if (l
< (unsigned long)p
) l
= (unsigned long)p
;
8668 if (!G
.memleak_value
)
8669 G
.memleak_value
= l
;
8671 l
-= G
.memleak_value
;
8678 /* Exitcode is "how many kilobytes we leaked since 1st call" */
8683 static int FAST_FUNC
builtin_pwd(char **argv UNUSED_PARAM
)
8686 return EXIT_SUCCESS
;
8689 /* Interruptibility of read builtin in bash
8690 * (tested on bash-4.2.8 by sending signals (not by ^C)):
8692 * Empty trap makes read ignore corresponding signal, for any signal.
8695 * - terminates non-interactive shell;
8696 * - interrupts read in interactive shell;
8697 * if it has non-empty trap:
8698 * - executes trap and returns to command prompt in interactive shell;
8699 * - executes trap and returns to read in non-interactive shell;
8701 * - is ignored (does not interrupt) read in interactive shell;
8702 * - terminates non-interactive shell;
8703 * if it has non-empty trap:
8704 * - executes trap and returns to read;
8706 * - terminates shell (regardless of interactivity);
8707 * if it has non-empty trap:
8708 * - executes trap and returns to read;
8710 static int FAST_FUNC
builtin_read(char **argv
)
8720 /* "!": do not abort on errors.
8721 * Option string must start with "sr" to match BUILTIN_READ_xxx
8723 read_flags
= getopt32(argv
, "!srn:p:t:u:", &opt_n
, &opt_p
, &opt_t
, &opt_u
);
8724 if (read_flags
== (uint32_t)-1)
8725 return EXIT_FAILURE
;
8727 ifs
= get_local_var_value("IFS"); /* can be NULL */
8730 r
= shell_builtin_read(set_local_var_from_halves
,
8740 if ((uintptr_t)r
== 1 && errno
== EINTR
) {
8741 unsigned sig
= check_and_run_traps();
8742 if (sig
&& sig
!= SIGINT
)
8746 if ((uintptr_t)r
> 1) {
8747 bb_error_msg("%s", r
);
8748 r
= (char*)(uintptr_t)1;
8751 return (uintptr_t)r
;
8754 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set
8755 * built-in 'set' handler
8757 * set [-abCefhmnuvx] [-o option] [argument...]
8758 * set [+abCefhmnuvx] [+o option] [argument...]
8759 * set -- [argument...]
8762 * Implementations shall support the options in both their hyphen and
8763 * plus-sign forms. These options can also be specified as options to sh.
8765 * Write out all variables and their values: set
8766 * Set $1, $2, and $3 and set "$#" to 3: set c a b
8767 * Turn on the -x and -v options: set -xv
8768 * Unset all positional parameters: set --
8769 * Set $1 to the value of x, even if it begins with '-' or '+': set -- "$x"
8770 * Set the positional parameters to the expansion of x, even if x expands
8771 * with a leading '-' or '+': set -- $x
8773 * So far, we only support "set -- [argument...]" and some of the short names.
8775 static int FAST_FUNC
builtin_set(char **argv
)
8778 char **pp
, **g_argv
;
8779 char *arg
= *++argv
;
8783 for (e
= G
.top_var
; e
; e
= e
->next
)
8785 return EXIT_SUCCESS
;
8789 if (strcmp(arg
, "--") == 0) {
8793 if (arg
[0] != '+' && arg
[0] != '-')
8795 for (n
= 1; arg
[n
]; ++n
) {
8796 if (set_mode((arg
[0] == '-'), arg
[n
], argv
[1]))
8798 if (arg
[n
] == 'o' && argv
[1])
8801 } while ((arg
= *++argv
) != NULL
);
8802 /* Now argv[0] is 1st argument */
8805 return EXIT_SUCCESS
;
8808 /* NB: G.global_argv[0] ($0) is never freed/changed */
8809 g_argv
= G
.global_argv
;
8810 if (G
.global_args_malloced
) {
8816 G
.global_args_malloced
= 1;
8817 pp
= xzalloc(sizeof(pp
[0]) * 2);
8818 pp
[0] = g_argv
[0]; /* retain $0 */
8821 /* This realloc's G.global_argv */
8822 G
.global_argv
= pp
= add_strings_to_strings(g_argv
, argv
, /*dup:*/ 1);
8829 return EXIT_SUCCESS
;
8831 /* Nothing known, so abort */
8833 bb_error_msg("set: %s: invalid option", arg
);
8834 return EXIT_FAILURE
;
8837 static int FAST_FUNC
builtin_shift(char **argv
)
8840 argv
= skip_dash_dash(argv
);
8844 if (n
>= 0 && n
< G
.global_argc
) {
8845 if (G
.global_args_malloced
) {
8848 free(G
.global_argv
[m
++]);
8851 memmove(&G
.global_argv
[1], &G
.global_argv
[n
+1],
8852 G
.global_argc
* sizeof(G
.global_argv
[0]));
8853 return EXIT_SUCCESS
;
8855 return EXIT_FAILURE
;
8858 static int FAST_FUNC
builtin_source(char **argv
)
8860 char *arg_path
, *filename
;
8863 #if ENABLE_HUSH_FUNCTIONS
8867 argv
= skip_dash_dash(argv
);
8870 /* bash says: "bash: .: filename argument required" */
8871 return 2; /* bash compat */
8874 if (!strchr(filename
, '/')) {
8875 arg_path
= find_in_path(filename
);
8877 filename
= arg_path
;
8879 input
= fopen_or_warn(filename
, "r");
8882 /* bb_perror_msg("%s", *argv); - done by fopen_or_warn */
8883 return EXIT_FAILURE
;
8885 close_on_exec_on(fileno(input
));
8887 #if ENABLE_HUSH_FUNCTIONS
8888 sv_flg
= G
.flag_return_in_progress
;
8889 /* "we are inside sourced file, ok to use return" */
8890 G
.flag_return_in_progress
= -1;
8892 save_and_replace_G_args(&sv
, argv
);
8894 parse_and_run_file(input
);
8897 restore_G_args(&sv
, argv
);
8898 #if ENABLE_HUSH_FUNCTIONS
8899 G
.flag_return_in_progress
= sv_flg
;
8902 return G
.last_exitcode
;
8905 static int FAST_FUNC
builtin_umask(char **argv
)
8911 argv
= skip_dash_dash(argv
);
8913 mode_t old_mask
= mask
;
8916 rc
= bb_parse_mode(argv
[0], &mask
);
8921 * bash: umask: 'q': invalid symbolic mode operator
8922 * bash: umask: 999: octal number out of range
8924 bb_error_msg("%s: invalid mode '%s'", "umask", argv
[0]);
8929 printf("%04o\n", (unsigned) mask
);
8930 /* fall through and restore mask which we set to 0 */
8934 return !rc
; /* rc != 0 - success */
8937 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#unset */
8938 static int FAST_FUNC
builtin_unset(char **argv
)
8943 /* "!": do not abort on errors */
8944 /* "+": stop at 1st non-option */
8945 opts
= getopt32(argv
, "!+vf");
8946 if (opts
== (unsigned)-1)
8947 return EXIT_FAILURE
;
8949 bb_error_msg("unset: -v and -f are exclusive");
8950 return EXIT_FAILURE
;
8956 if (!(opts
& 2)) { /* not -f */
8957 if (unset_local_var(*argv
)) {
8958 /* unset <nonexistent_var> doesn't fail.
8959 * Error is when one tries to unset RO var.
8960 * Message was printed by unset_local_var. */
8964 #if ENABLE_HUSH_FUNCTIONS
8974 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/wait.html */
8975 static int FAST_FUNC
builtin_wait(char **argv
)
8977 int ret
= EXIT_SUCCESS
;
8980 argv
= skip_dash_dash(argv
);
8981 if (argv
[0] == NULL
) {
8982 /* Don't care about wait results */
8983 /* Note 1: must wait until there are no more children */
8984 /* Note 2: must be interruptible */
8986 * $ sleep 3 & sleep 6 & wait
8991 * $ sleep 3 & sleep 6 & wait
8995 * ^C <-- after ~4 sec from keyboard
9000 sigset_t oldset
, allsigs
;
9002 /* waitpid is not interruptible by SA_RESTARTed
9003 * signals which we use. Thus, this ugly dance:
9006 /* Make sure possible SIGCHLD is stored in kernel's
9007 * pending signal mask before we call waitpid.
9008 * Or else we may race with SIGCHLD, lose it,
9009 * and get stuck in sigwaitinfo...
9011 sigfillset(&allsigs
);
9012 sigprocmask(SIG_SETMASK
, &allsigs
, &oldset
);
9014 if (!sigisemptyset(&G
.pending_set
)) {
9015 /* Crap! we raced with some signal! */
9020 checkjobs(NULL
); /* waitpid(WNOHANG) inside */
9021 if (errno
== ECHILD
) {
9022 sigprocmask(SIG_SETMASK
, &oldset
, NULL
);
9026 /* Wait for SIGCHLD or any other signal */
9027 //sig = sigwaitinfo(&allsigs, NULL);
9028 /* It is vitally important for sigsuspend that SIGCHLD has non-DFL handler! */
9029 /* Note: sigsuspend invokes signal handler */
9030 sigsuspend(&oldset
);
9032 sigprocmask(SIG_SETMASK
, &oldset
, NULL
);
9034 /* So, did we get a signal? */
9036 // raise(sig); /* run handler */
9037 sig
= check_and_run_traps();
9038 if (sig
/*&& sig != SIGCHLD - always true */) {
9043 /* SIGCHLD, or no signal, or ignored one, such as SIGQUIT. Repeat */
9048 /* This is probably buggy wrt interruptible-ness */
9050 pid_t pid
= bb_strtou(*argv
, NULL
, 10);
9052 /* mimic bash message */
9053 bb_error_msg("wait: '%s': not a pid or valid job spec", *argv
);
9054 return EXIT_FAILURE
;
9056 if (waitpid(pid
, &status
, 0) == pid
) {
9057 if (WIFSIGNALED(status
))
9058 ret
= 128 + WTERMSIG(status
);
9059 else if (WIFEXITED(status
))
9060 ret
= WEXITSTATUS(status
);
9064 bb_perror_msg("wait %s", *argv
);
9073 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_FUNCTIONS
9074 static unsigned parse_numeric_argv1(char **argv
, unsigned def
, unsigned def_min
)
9077 def
= bb_strtou(argv
[1], NULL
, 10);
9078 if (errno
|| def
< def_min
|| argv
[2]) {
9079 bb_error_msg("%s: bad arguments", argv
[0]);
9087 #if ENABLE_HUSH_LOOPS
9088 static int FAST_FUNC
builtin_break(char **argv
)
9091 if (G
.depth_of_loop
== 0) {
9092 bb_error_msg("%s: only meaningful in a loop", argv
[0]);
9093 return EXIT_SUCCESS
; /* bash compat */
9095 G
.flag_break_continue
++; /* BC_BREAK = 1 */
9097 G
.depth_break_continue
= depth
= parse_numeric_argv1(argv
, 1, 1);
9098 if (depth
== UINT_MAX
)
9099 G
.flag_break_continue
= BC_BREAK
;
9100 if (G
.depth_of_loop
< depth
)
9101 G
.depth_break_continue
= G
.depth_of_loop
;
9103 return EXIT_SUCCESS
;
9106 static int FAST_FUNC
builtin_continue(char **argv
)
9108 G
.flag_break_continue
= 1; /* BC_CONTINUE = 2 = 1+1 */
9109 return builtin_break(argv
);
9113 #if ENABLE_HUSH_FUNCTIONS
9114 static int FAST_FUNC
builtin_return(char **argv
)
9118 if (G
.flag_return_in_progress
!= -1) {
9119 bb_error_msg("%s: not in a function or sourced script", argv
[0]);
9120 return EXIT_FAILURE
; /* bash compat */
9123 G
.flag_return_in_progress
= 1;
9126 * out of range: wraps around at 256, does not error out
9127 * non-numeric param:
9128 * f() { false; return qwe; }; f; echo $?
9129 * bash: return: qwe: numeric argument required <== we do this
9130 * 255 <== we also do this
9132 rc
= parse_numeric_argv1(argv
, G
.last_exitcode
, 0);