1 /* vi: set sw=4 ts=4: */
3 * sh.c -- a prototype Bourne shell grammar parser
4 * Intended to follow the original Thompson and Ritchie
5 * "small and simple is beautiful" philosophy, which
6 * incidentally is a good match to today's BusyBox.
8 * Copyright (C) 2000,2001 Larry Doolittle <larry@doolittle.boa.org>
11 * The parser routines proper are all original material, first
12 * written Dec 2000 and Jan 2001 by Larry Doolittle.
13 * The execution engine, the builtins, and much of the underlying
14 * support has been adapted from busybox-0.49pre's lash,
15 * which is Copyright (C) 2000 by Lineo, Inc., and
16 * written by Erik Andersen <andersen@lineo.com>, <andersee@debian.org>.
17 * That, in turn, is based in part on ladsh.c, by Michael K. Johnson and
18 * Erik W. Troan, which they placed in the public domain. I don't know
19 * how much of the Johnson/Troan code has survived the repeated rewrites.
21 * simple_itoa() was lifted from boa-0.93.15
22 * b_addchr() derived from similar w_addchar function in glibc-2.2
23 * setup_redirect(), redirect_opt_num(), and big chunks of main()
24 * and many builtins derived from contributions by Erik Andersen
25 * miscellaneous bugfixes from Matt Kraai
27 * There are two big (and related) architecture differences between
28 * this parser and the lash parser. One is that this version is
29 * actually designed from the ground up to understand nearly all
30 * of the Bourne grammar. The second, consequential change is that
31 * the parser and input reader have been turned inside out. Now,
32 * the parser is in control, and asks for input as needed. The old
33 * way had the input reader in control, and it asked for parsing to
34 * take place as needed. The new way makes it much easier to properly
35 * handle the recursion implicit in the various substitutions, especially
36 * across continuation lines.
38 * Bash grammar not implemented: (how many of these were in original sh?)
39 * $@ (those sure look like weird quoting rules)
41 * ! negation operator for pipes
42 * &> and >& redirection of stdout+stderr
45 * fancy forms of Parameter Expansion
47 * Arithmetic Expansion
48 * <(list) and >(list) Process Substitution
49 * reserved words: case, esac, select, function
50 * Here Documents ( << word )
53 * job handling woefully incomplete and buggy
54 * reserved word execution woefully incomplete and buggy
56 * port selected bugfixes from post-0.49 busybox lash - done?
57 * finish implementing reserved words: for, while, until, do, done
58 * change { and } from special chars to reserved words
59 * builtins: break, continue, eval, return, set, trap, ulimit
61 * handle children going into background
62 * clean up recognition of null pipes
63 * check setting of global_argc and global_argv
64 * control-C handling, probably with longjmp
65 * follow IFS rules more precisely, including update semantics
66 * figure out what to do with backslash-newline
67 * explain why we use signal instead of sigaction
68 * propagate syntax errors, die on resource errors?
69 * continuation lines, both explicit and implicit - done?
70 * memory leak finding and plugging - done?
71 * more testing, especially quoting rules and redirection
72 * document how quoting rules not precisely followed for variable assignments
73 * maybe change map[] to use 2-bit entries
74 * (eventually) remove all the printf's
76 * This program is free software; you can redistribute it and/or modify
77 * it under the terms of the GNU General Public License as published by
78 * the Free Software Foundation; either version 2 of the License, or
79 * (at your option) any later version.
81 * This program is distributed in the hope that it will be useful,
82 * but WITHOUT ANY WARRANTY; without even the implied warranty of
83 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
84 * General Public License for more details.
86 * You should have received a copy of the GNU General Public License
87 * along with this program; if not, write to the Free Software
88 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
90 #include <ctype.h> /* isalpha, isdigit */
91 #include <unistd.h> /* getpid */
92 #include <stdlib.h> /* getenv, atoi */
93 #include <string.h> /* strchr */
94 #include <stdio.h> /* popen etc. */
95 #include <glob.h> /* glob, of course */
96 #include <stdarg.h> /* va_list */
99 #include <getopt.h> /* should be pretty obvious */
101 #include <sys/stat.h> /* ulimit */
102 #include <sys/types.h>
103 #include <sys/wait.h>
106 /* #include <dmalloc.h> */
107 /* #define DEBUG_SHELL */
113 #define applet_name "hush"
114 #include "standalone.h"
115 #define shell_main main
116 #define BB_FEATURE_SH_SIMPLE_PROMPT
121 REDIRECT_OVERWRITE = 2,
127 /* The descrip member of this structure is only used to make debugging
129 struct {int mode; int default_fd; char *descrip;} redir_table[] = {
131 { O_RDONLY, 0, "<" },
132 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
133 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
134 { O_RDONLY, -1, "<<" },
145 /* might eventually control execution */
161 #define FLAG_END (1<<RES_NONE)
162 #define FLAG_IF (1<<RES_IF)
163 #define FLAG_THEN (1<<RES_THEN)
164 #define FLAG_ELIF (1<<RES_ELIF)
165 #define FLAG_ELSE (1<<RES_ELSE)
166 #define FLAG_FI (1<<RES_FI)
167 #define FLAG_FOR (1<<RES_FOR)
168 #define FLAG_WHILE (1<<RES_WHILE)
169 #define FLAG_UNTIL (1<<RES_UNTIL)
170 #define FLAG_DO (1<<RES_DO)
171 #define FLAG_DONE (1<<RES_DONE)
172 #define FLAG_START (1<<RES_XXXX)
174 /* This holds pointers to the various results of parsing */
176 struct child_prog *child;
177 struct pipe *list_head;
179 struct redir_struct *pending_redirect;
181 int old_flag; /* for figuring out valid reserved words */
182 struct p_context *stack;
183 /* How about quoting status? */
186 struct redir_struct {
187 redir_type type; /* type of redirection */
188 int fd; /* file descriptor being redirected */
189 int dup; /* -1, or file descriptor being duplicated */
190 struct redir_struct *next; /* pointer to the next redirect in the list */
191 glob_t word; /* *word.gl_pathv is the filename */
195 pid_t pid; /* 0 if exited */
196 char **argv; /* program name and arguments */
197 struct pipe *group; /* if non-NULL, first in group or subshell */
198 int subshell; /* flag, non-zero if group must be forked */
199 struct redir_struct *redirects; /* I/O redirections */
200 glob_t glob_result; /* result of parameter globbing */
201 int is_stopped; /* is the program currently running? */
202 struct pipe *family; /* pointer back to the child's parent pipe */
206 int jobid; /* job number */
207 int num_progs; /* total number of programs in job */
208 int running_progs; /* number of programs running */
209 char *text; /* name of job */
210 char *cmdbuf; /* buffer various argv's point into */
211 pid_t pgrp; /* process group ID for the job */
212 struct child_prog *progs; /* array of commands in pipe */
213 struct pipe *next; /* to track background commands */
214 int stopped_progs; /* number of programs alive, but stopped */
215 int job_context; /* bitmask defining current context */
216 pipe_style followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
217 reserved_style r_mode; /* supports if, for, while, until */
221 struct pipe *head; /* head of list of running jobs */
222 struct pipe *fg; /* current foreground job */
227 struct close_me *next;
230 /* globals, connect us to the outside world
231 * the first three support $?, $#, and $1 */
233 unsigned int global_argc;
234 unsigned int last_return_code;
235 extern char **environ; /* This is in <unistd.h>, but protected with __USE_GNU */
237 /* Variables we export */
238 unsigned int shell_context; /* Used in cmdedit.c to reset the
239 * context when someone hits ^C */
241 /* "globals" within this file */
242 static char *ifs=NULL;
243 static char map[256];
244 static int fake_mode=0;
245 static int interactive=0;
246 static struct close_me *close_me_head = NULL;
247 static const char *cwd;
248 static struct jobset *job_list;
249 static unsigned int last_bg_pid=0;
251 static char *PS2 = "> ";
252 static char **__shell_local_env = 0;
254 #define B_CHUNK (100)
256 #define MAX_LINE 256 /* for cwd */
257 #define MAX_READ 256 /* for builtin_read */
266 #define NULL_O_STRING {NULL,0,0,0,0}
267 /* used for initialization:
268 o_string foo = NULL_O_STRING; */
270 /* I can almost use ordinary FILE *. Is open_memstream() universally
271 * available? Where is it documented? */
277 int (*get) (struct in_str *);
278 int (*peek) (struct in_str *);
280 #define b_getch(input) ((input)->get(input))
281 #define b_peek(input) ((input)->peek(input))
283 #define JOB_STATUS_FORMAT "[%d] %-22s %.40s\n"
285 struct built_in_command {
286 char *cmd; /* name */
287 char *descr; /* description */
288 int (*function) (struct child_prog *); /* function ptr */
291 /* belongs in busybox.h */
292 static inline int max(int a, int b) {
296 /* This should be in utility.c */
298 static void debug_printf(const char *format, ...)
301 va_start(args, format);
302 vfprintf(stderr, format, args);
306 static void debug_printf(const char *format, ...) { }
308 #define final_printf debug_printf
310 void __syntax(char *file, int line) {
311 fprintf(stderr,"syntax error %s:%d\n",file,line);
313 #define syntax() __syntax(__FILE__, __LINE__)
315 /* Index of subroutines: */
316 /* function prototypes for builtins */
317 static int builtin_cd(struct child_prog *child);
318 static int builtin_env(struct child_prog *child);
319 static int builtin_exec(struct child_prog *child);
320 static int builtin_exit(struct child_prog *child);
321 static int builtin_export(struct child_prog *child);
322 static int builtin_fg_bg(struct child_prog *child);
323 static int builtin_help(struct child_prog *child);
324 static int builtin_jobs(struct child_prog *child);
325 static int builtin_pwd(struct child_prog *child);
326 static int builtin_read(struct child_prog *child);
327 static int builtin_set(struct child_prog *child);
328 static int builtin_shift(struct child_prog *child);
329 static int builtin_source(struct child_prog *child);
330 static int builtin_umask(struct child_prog *child);
331 static int builtin_unset(struct child_prog *child);
332 static int builtin_not_written(struct child_prog *child);
333 /* o_string manipulation: */
334 static int b_check_space(o_string *o, int len);
335 static int b_addchr(o_string *o, int ch);
336 static void b_reset(o_string *o);
337 static int b_addqchr(o_string *o, int ch, int quote);
338 static int b_adduint(o_string *o, unsigned int i);
339 /* in_str manipulations: */
340 static int static_get(struct in_str *i);
341 static int static_peek(struct in_str *i);
342 static int file_get(struct in_str *i);
343 static int file_peek(struct in_str *i);
344 static void setup_file_in_str(struct in_str *i, FILE *f);
345 static void setup_string_in_str(struct in_str *i, const char *s);
346 /* close_me manipulations: */
347 static void mark_open(int fd);
348 static void mark_closed(int fd);
349 static void close_all();
350 /* "run" the final data structures: */
351 static char *indenter(int i);
352 static int run_list_test(struct pipe *head, int indent);
353 static int run_pipe_test(struct pipe *pi, int indent);
354 /* really run the final data structures: */
355 static int setup_redirects(struct child_prog *prog, int squirrel[]);
356 static int pipe_wait(struct pipe *pi);
357 static int run_list_real(struct pipe *pi);
358 static void pseudo_exec(struct child_prog *child) __attribute__ ((noreturn));
359 static int run_pipe_real(struct pipe *pi);
360 /* extended glob support: */
361 static int globhack(const char *src, int flags, glob_t *pglob);
362 static int glob_needed(const char *s);
363 static int xglob(o_string *dest, int flags, glob_t *pglob);
364 /* variable assignment: */
365 static int set_local_var(const char *s);
366 static int is_assignment(const char *s);
367 /* data structure manipulation: */
368 static int setup_redirect(struct p_context *ctx, int fd, redir_type style, struct in_str *input);
369 static void initialize_context(struct p_context *ctx);
370 static int done_word(o_string *dest, struct p_context *ctx);
371 static int done_command(struct p_context *ctx);
372 static int done_pipe(struct p_context *ctx, pipe_style type);
373 /* primary string parsing: */
374 static int redirect_dup_num(struct in_str *input);
375 static int redirect_opt_num(o_string *o);
376 static int process_command_subs(o_string *dest, struct p_context *ctx, struct in_str *input, int subst_end);
377 static int parse_group(o_string *dest, struct p_context *ctx, struct in_str *input, int ch);
378 static void lookup_param(o_string *dest, struct p_context *ctx, o_string *src);
379 static int handle_dollar(o_string *dest, struct p_context *ctx, struct in_str *input);
380 static int parse_string(o_string *dest, struct p_context *ctx, const char *src);
381 static int parse_stream(o_string *dest, struct p_context *ctx, struct in_str *input0, int end_trigger);
383 static int parse_stream_outer(struct in_str *inp);
384 static int parse_string_outer(const char *s);
385 static int parse_file_outer(FILE *f);
386 /* job management: */
387 static void checkjobs();
388 static void insert_bg_job(struct pipe *pi);
389 static void remove_bg_job(struct pipe *pi);
390 static void free_pipe(struct pipe *pi);
391 /* local variable support */
392 static char *get_local_var(const char *var);
393 static int set_local_var(const char *s);
394 static void unset_local_var(const char *name);
397 /* Table of built-in functions. They can be forked or not, depending on
398 * context: within pipes, they fork. As simple commands, they do not.
399 * When used in non-forking context, they can change global variables
400 * in the parent shell process. If forked, of course they can not.
401 * For example, 'unset foo | whatever' will parse and run, but foo will
402 * still be set at the end. */
403 static struct built_in_command bltins[] = {
404 {"bg", "Resume a job in the background", builtin_fg_bg},
405 {"break", "Exit for, while or until loop", builtin_not_written},
406 {"cd", "Change working directory", builtin_cd},
407 {"continue", "Continue for, while or until loop", builtin_not_written},
408 {"env", "Print all environment variables", builtin_env},
409 {"eval", "Construct and run shell command", builtin_not_written},
410 {"exec", "Exec command, replacing this shell with the exec'd process",
412 {"exit", "Exit from shell()", builtin_exit},
413 {"export", "Set environment variable", builtin_export},
414 {"fg", "Bring job into the foreground", builtin_fg_bg},
415 {"jobs", "Lists the active jobs", builtin_jobs},
416 {"pwd", "Print current directory", builtin_pwd},
417 {"read", "Input environment variable", builtin_read},
418 {"return", "Return from a function", builtin_not_written},
419 {"set", "Set/unset shell local variables", builtin_set},
420 {"shift", "Shift positional parameters", builtin_shift},
421 {"trap", "Trap signals", builtin_not_written},
422 {"ulimit","Controls resource limits", builtin_not_written},
423 {"umask","Sets file creation mask", builtin_umask},
424 {"unset", "Unset environment variable", builtin_unset},
425 {".", "Source-in and run commands in a file", builtin_source},
426 {"help", "List shell built-in commands", builtin_help},
430 /* built-in 'cd <path>' handler */
431 static int builtin_cd(struct child_prog *child)
434 if (child->argv[1] == NULL)
435 newdir = getenv("HOME");
437 newdir = child->argv[1];
439 printf("cd: %s: %s\n", newdir, strerror(errno));
442 cwd = xgetcwd((char *)cwd);
448 /* built-in 'env' handler */
449 static int builtin_env(struct child_prog *dummy)
452 if (e == NULL) return EXIT_FAILURE;
459 /* built-in 'exec' handler */
460 static int builtin_exec(struct child_prog *child)
462 if (child->argv[1] == NULL)
463 return EXIT_SUCCESS; /* Really? */
469 /* built-in 'exit' handler */
470 static int builtin_exit(struct child_prog *child)
472 if (child->argv[1] == NULL)
473 exit(last_return_code);
474 exit (atoi(child->argv[1]));
477 /* built-in 'export VAR=value' handler */
478 static int builtin_export(struct child_prog *child)
481 char *value, *name = child->argv[1];
484 return (builtin_env(child));
487 value = strchr(name, '=');
489 /* They are exporting something without an =VALUE.
490 * Assume this is a local shell variable they are exporting */
491 name = get_local_var(name);
493 error_msg("export failed");
494 return (EXIT_FAILURE);
496 /* FIXME -- I leak memory!!!!! */
497 value = malloc(strlen(child->argv[1]) + strlen(name) + 2);
498 sprintf(value, "%s=%s", child->argv[1], name);
500 /* Bourne shells always put exported variables into the
501 * local shell variable list. Do that first... */
503 /* FIXME -- I leak memory!!!!! */
504 value = strdup(name);
507 /* FIXME -- I leak memory!!!!!
508 * It seems most putenv implementations place the very char* pointer
509 * we pass in directly into the environ array, so the memory holding
510 * this string has to be persistant. We can't even use the memory for
511 * the local shell variable list, since where that memory is keeps
512 * changing due to reallocs... */
515 perror_msg("export");
519 /* built-in 'fg' and 'bg' handler */
520 static int builtin_fg_bg(struct child_prog *child)
523 struct pipe *pi=NULL;
525 /* If they gave us no args, assume they want the last backgrounded task */
526 if (!child->argv[1]) {
527 for (pi = job_list->head; pi; pi = pi->next) {
528 if (pi->progs && pi->progs->pid == last_bg_pid) {
533 error_msg("%s: no current job", child->argv[0]);
537 if (sscanf(child->argv[1], "%%%d", &jobnum) != 1) {
538 error_msg("%s: bad argument '%s'", child->argv[0], child->argv[1]);
542 for (pi = job_list->head; pi; pi = pi->next) {
543 if (pi->jobid == jobnum) {
548 error_msg("%s: %d: no such job", child->argv[0], jobnum);
552 if (*child->argv[0] == 'f') {
553 /* Make this job the foreground job */
554 signal(SIGTTOU, SIG_IGN);
555 /* suppress messages when run from /linuxrc mag@sysgo.de */
556 if (tcsetpgrp(0, pi->pgrp) && errno != ENOTTY)
557 perror_msg("tcsetpgrp");
558 signal(SIGTTOU, SIG_DFL);
562 /* Restart the processes in the job */
563 for (i = 0; i < pi->num_progs; i++)
564 pi->progs[i].is_stopped = 0;
566 kill(-pi->pgrp, SIGCONT);
568 pi->stopped_progs = 0;
572 /* built-in 'help' handler */
573 static int builtin_help(struct child_prog *dummy)
575 struct built_in_command *x;
577 printf("\nBuilt-in commands:\n");
578 printf("-------------------\n");
579 for (x = bltins; x->cmd; x++) {
582 printf("%s\t%s\n", x->cmd, x->descr);
588 /* built-in 'jobs' handler */
589 static int builtin_jobs(struct child_prog *child)
594 for (job = job_list->head; job; job = job->next) {
595 if (job->running_progs == job->stopped_progs)
596 status_string = "Stopped";
598 status_string = "Running";
599 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->text);
605 /* built-in 'pwd' handler */
606 static int builtin_pwd(struct child_prog *dummy)
608 cwd = xgetcwd((char *)cwd);
615 /* built-in 'read VAR' handler */
616 static int builtin_read(struct child_prog *child)
618 int res = 0, len, newlen;
620 char string[MAX_READ];
622 if (child->argv[1]) {
623 /* argument (VAR) given: put "VAR=" into buffer */
624 strcpy(string, child->argv[1]);
625 len = strlen(string);
628 /* XXX would it be better to go through in_str? */
629 fgets(&string[len], sizeof(string) - len, stdin); /* read string */
630 newlen = strlen(string);
632 string[--newlen] = '\0'; /* chomp trailing newline */
634 ** string should now contain "VAR=<value>"
635 ** copy it (putenv() won't do that, so we must make sure
636 ** the string resides in a static buffer!)
639 if((s = strdup(string)))
642 fprintf(stderr, "read: %s\n", strerror(errno));
645 fgets(string, sizeof(string), stdin);
650 /* built-in 'set VAR=value' handler */
651 static int builtin_set(struct child_prog *child)
654 char *temp = child->argv[1];
656 if (child->argv[1] == NULL) {
657 char **e = __shell_local_env;
658 if (e == NULL) return EXIT_FAILURE;
664 res = set_local_var(temp);
666 fprintf(stderr, "set: %s\n", strerror(errno));
671 /* Built-in 'shift' handler */
672 static int builtin_shift(struct child_prog *child)
675 if (child->argv[1]) {
676 n=atoi(child->argv[1]);
678 if (n>=0 && n<global_argc) {
679 /* XXX This probably breaks $0 */
688 /* Built-in '.' handler (read-in and execute commands from file) */
689 static int builtin_source(struct child_prog *child)
694 if (child->argv[1] == NULL)
697 /* XXX search through $PATH is missing */
698 input = fopen(child->argv[1], "r");
700 fprintf(stderr, "Couldn't open file '%s'\n", child->argv[1]);
704 /* Now run the file */
705 /* XXX argv and argc are broken; need to save old global_argv
706 * (pointer only is OK!) on this stack frame,
707 * set global_argv=child->argv+1, recurse, and restore. */
708 mark_open(fileno(input));
709 status = parse_file_outer(input);
710 mark_closed(fileno(input));
715 static int builtin_umask(struct child_prog *child)
718 const char *arg = child->argv[1];
721 new_umask=strtoul(arg, &end, 8);
722 if (*end!='\0' || end == arg) {
726 printf("%.3o\n", (unsigned int) (new_umask=umask(0)));
732 /* built-in 'unset VAR' handler */
733 static int builtin_unset(struct child_prog *child)
735 if (child->argv[1] == NULL) {
736 fprintf(stderr, "unset: parameter required.\n");
739 unsetenv(child->argv[1]);
740 unset_local_var(child->argv[1]);
744 static int builtin_not_written(struct child_prog *child)
746 printf("builtin_%s not written\n",child->argv[0]);
750 static int b_check_space(o_string *o, int len)
752 /* It would be easy to drop a more restrictive policy
753 * in here, such as setting a maximum string length */
754 if (o->length + len > o->maxlen) {
755 char *old_data = o->data;
756 /* assert (data == NULL || o->maxlen != 0); */
757 o->maxlen += max(2*len, B_CHUNK);
758 o->data = realloc(o->data, 1 + o->maxlen);
759 if (o->data == NULL) {
763 return o->data == NULL;
766 static int b_addchr(o_string *o, int ch)
768 debug_printf("b_addchr: %c %d %p\n", ch, o->length, o);
769 if (b_check_space(o, 1)) return B_NOSPAC;
770 o->data[o->length] = ch;
772 o->data[o->length] = '\0';
776 static void b_reset(o_string *o)
780 if (o->data != NULL) *o->data = '\0';
783 static void b_free(o_string *o)
786 if (o->data != NULL) free(o->data);
791 /* My analysis of quoting semantics tells me that state information
792 * is associated with a destination, not a source.
794 static int b_addqchr(o_string *o, int ch, int quote)
796 if (quote && strchr("*?[\\",ch)) {
798 rc = b_addchr(o, '\\');
801 return b_addchr(o, ch);
804 /* belongs in utility.c */
805 char *simple_itoa(unsigned int i)
807 /* 21 digits plus null terminator, good for 64-bit or smaller ints */
808 static char local[22];
809 char *p = &local[21];
818 static int b_adduint(o_string *o, unsigned int i)
821 char *p = simple_itoa(i);
822 /* no escape checking necessary */
823 do r=b_addchr(o, *p++); while (r==0 && *p);
827 static int static_get(struct in_str *i)
830 if (ch=='\0') return EOF;
834 static int static_peek(struct in_str *i)
839 static inline void cmdedit_set_initial_prompt(void)
841 #ifdef BB_FEATURE_SH_SIMPLE_PROMPT
850 static inline void setup_prompt_string(int promptmode, char **prompt_str)
852 debug_printf("setup_prompt_string %d ",promptmode);
853 #ifdef BB_FEATURE_SH_SIMPLE_PROMPT
854 /* Set up the prompt */
855 if (promptmode == 1) {
858 PS1=xmalloc(strlen(cwd)+4);
859 sprintf(PS1, "%s %s", cwd, ( geteuid() != 0 ) ? "$ ":"# ");
865 *prompt_str = (promptmode==0)? PS1 : PS2;
867 debug_printf("result %s\n",*prompt_str);
870 static void get_user_input(struct in_str *i)
873 static char the_command[BUFSIZ];
875 setup_prompt_string(i->promptmode, &prompt_str);
876 #ifdef BB_FEATURE_COMMAND_EDITING
878 ** enable command line editing only while a command line
879 ** is actually being read; otherwise, we'll end up bequeathing
880 ** atexit() handlers and other unwanted stuff to our
881 ** child processes (rob@sysgo.de)
883 cmdedit_read_input(prompt_str, the_command);
886 fputs(prompt_str, stdout);
888 the_command[0]=fgetc(i->file);
894 /* This is the magic location that prints prompts
895 * and gets data back from the user */
896 static int file_get(struct in_str *i)
901 /* If there is data waiting, eat it up */
905 /* need to double check i->file because we might be doing something
906 * more complicated by now, like sourcing or substituting. */
907 if (i->__promptme && interactive && i->file == stdin) {
918 debug_printf("b_getch: got a %d\n", ch);
920 if (ch == '\n') i->__promptme=1;
924 /* All the callers guarantee this routine will never be
925 * used right after a newline, so prompting is not needed.
927 static int file_peek(struct in_str *i)
932 static char buffer[2];
933 buffer[0] = fgetc(i->file);
936 debug_printf("b_peek: got a %d\n", *i->p);
941 static void setup_file_in_str(struct in_str *i, FILE *f)
951 static void setup_string_in_str(struct in_str *i, const char *s)
953 i->peek = static_peek;
960 static void mark_open(int fd)
962 struct close_me *new = xmalloc(sizeof(struct close_me));
964 new->next = close_me_head;
968 static void mark_closed(int fd)
970 struct close_me *tmp;
971 if (close_me_head == NULL || close_me_head->fd != fd)
972 error_msg_and_die("corrupt close_me");
974 close_me_head = close_me_head->next;
978 static void close_all()
981 for (c=close_me_head; c; c=c->next) {
984 close_me_head = NULL;
987 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
988 * and stderr if they are redirected. */
989 static int setup_redirects(struct child_prog *prog, int squirrel[])
992 struct redir_struct *redir;
994 for (redir=prog->redirects; redir; redir=redir->next) {
995 if (redir->dup == -1) {
996 mode=redir_table[redir->type].mode;
997 openfd = open(redir->word.gl_pathv[0], mode, 0666);
999 /* this could get lost if stderr has been redirected, but
1000 bash and ash both lose it as well (though zsh doesn't!) */
1001 fprintf(stderr,"error opening %s: %s\n", redir->word.gl_pathv[0],
1006 openfd = redir->dup;
1009 if (openfd != redir->fd) {
1010 if (squirrel && redir->fd < 3) {
1011 squirrel[redir->fd] = dup(redir->fd);
1016 dup2(openfd, redir->fd);
1024 static void restore_redirects(int squirrel[])
1027 for (i=0; i<3; i++) {
1030 /* No error checking. I sure wouldn't know what
1031 * to do with an error if I found one! */
1038 /* XXX this definitely needs some more thought, work, and
1039 * cribbing from other shells */
1040 static int pipe_wait(struct pipe *pi)
1042 int rcode=0, i, pid, running, status;
1043 running = pi->num_progs;
1045 pid=waitpid(-1, &status, 0);
1046 if (pid < 0) perror_msg_and_die("waitpid");
1047 for (i=0; i < pi->num_progs; i++) {
1048 if (pi->progs[i].pid == pid) {
1049 if (i==pi->num_progs-1) rcode=WEXITSTATUS(status);
1050 pi->progs[i].pid = 0;
1059 /* very simple version for testing */
1060 static void pseudo_exec(struct child_prog *child)
1063 struct built_in_command *x;
1065 for (i=0; is_assignment(child->argv[i]); i++) {
1066 putenv(strdup(child->argv[i]));
1068 child->argv+=i; /* XXX this hack isn't so horrible, since we are about
1069 to exit, and therefore don't need to keep data
1070 structures consistent for free() use. */
1071 /* If a variable is assigned in a forest, and nobody listens,
1072 * was it ever really set?
1074 if (child->argv[0] == NULL) exit(EXIT_SUCCESS);
1077 * Check if the command matches any of the builtins.
1078 * Depending on context, this might be redundant. But it's
1079 * easier to waste a few CPU cycles than it is to figure out
1080 * if this is one of those cases.
1082 for (x = bltins; x->cmd; x++) {
1083 if (strcmp(child->argv[0], x->cmd) == 0 ) {
1084 debug_printf("builtin exec %s\n", child->argv[0]);
1085 exit(x->function(child));
1089 /* Check if the command matches any busybox internal commands
1091 * FIXME: This feature is not 100% safe, since
1092 * BusyBox is not fully reentrant, so we have no guarantee the things
1093 * from the .bss are still zeroed, or that things from .data are still
1094 * at their defaults. We could exec ourself from /proc/self/exe, but I
1095 * really dislike relying on /proc for things. We could exec ourself
1096 * from global_argv[0], but if we are in a chroot, we may not be able
1097 * to find ourself... */
1098 #ifdef BB_FEATURE_SH_STANDALONE_SHELL
1101 char** argv_l=child->argv;
1102 char *name = child->argv[0];
1104 #ifdef BB_FEATURE_SH_APPLETS_ALWAYS_WIN
1105 /* Following discussions from November 2000 on the busybox mailing
1106 * list, the default configuration, (without
1107 * get_last_path_component()) lets the user force use of an
1108 * external command by specifying the full (with slashes) filename.
1109 * If you enable BB_FEATURE_SH_APPLETS_ALWAYS_WIN, then applets
1110 * _aways_ override external commands, so if you want to run
1111 * /bin/cat, it will use BusyBox cat even if /bin/cat exists on the
1112 * filesystem and is _not_ busybox. Some systems may want this,
1114 name = get_last_path_component(name);
1116 /* Count argc for use in a second... */
1117 for(argc_l=0;*argv_l!=NULL; argv_l++, argc_l++);
1119 debug_printf("running applet %s\n", name);
1120 run_applet_by_name(name, argc_l, child->argv);
1123 debug_printf("exec of %s\n",child->argv[0]);
1124 execvp(child->argv[0],child->argv);
1127 } else if (child->group) {
1128 debug_printf("runtime nesting to group\n");
1129 interactive=0; /* crucial!!!! */
1130 rcode = run_list_real(child->group);
1131 /* OK to leak memory by not calling run_list_test,
1132 * since this process is about to exit */
1135 /* Can happen. See what bash does with ">foo" by itself. */
1136 debug_printf("trying to pseudo_exec null command\n");
1141 static void insert_bg_job(struct pipe *pi)
1143 struct pipe *thejob;
1145 /* Linear search for the ID of the job to use */
1147 for (thejob = job_list->head; thejob; thejob = thejob->next)
1148 if (thejob->jobid >= pi->jobid)
1149 pi->jobid = thejob->jobid + 1;
1151 /* add thejob to the list of running jobs */
1152 if (!job_list->head) {
1153 thejob = job_list->head = xmalloc(sizeof(*thejob));
1155 for (thejob = job_list->head; thejob->next; thejob = thejob->next) /* nothing */;
1156 thejob->next = xmalloc(sizeof(*thejob));
1157 thejob = thejob->next;
1160 /* physically copy the struct job */
1161 memcpy(thejob, pi, sizeof(struct pipe));
1162 thejob->next = NULL;
1163 thejob->running_progs = thejob->num_progs;
1164 thejob->stopped_progs = 0;
1165 thejob->text = xmalloc(MAX_LINE);
1167 //if (pi->progs[0] && pi->progs[0].argv && pi->progs[0].argv[0])
1169 char *bar=thejob->text;
1170 char **foo=pi->progs[0].argv;
1171 while(foo && *foo) {
1172 bar += sprintf(bar, "%s ", *foo++);
1176 /* we don't wait for background thejobs to return -- append it
1177 to the list of backgrounded thejobs and leave it alone */
1178 printf("[%d] %d\n", thejob->jobid, thejob->progs[0].pid);
1179 last_bg_pid = thejob->progs[0].pid;
1182 /* remove a backgrounded job from a jobset */
1183 static void remove_bg_job(struct pipe *pi)
1185 struct pipe *prev_pipe;
1188 if (pi == job_list->head) {
1189 job_list->head = pi->next;
1191 prev_pipe = job_list->head;
1192 while (prev_pipe->next != pi)
1193 prev_pipe = prev_pipe->next;
1194 prev_pipe->next = pi->next;
1200 /* free up all memory from a pipe */
1201 static void free_pipe(struct pipe *pi)
1205 for (i = 0; i < pi->num_progs; i++) {
1206 free(pi->progs[i].argv);
1207 if (pi->progs[i].redirects)
1208 free(pi->progs[i].redirects);
1216 memset(pi, 0, sizeof(struct pipe));
1220 /* Checks to see if any background processes have exited -- if they
1221 have, figure out why and see if a job has completed */
1222 static void checkjobs()
1229 while ((childpid = waitpid(-1, &status, WNOHANG | WUNTRACED)) > 0) {
1230 for (pi = job_list->head; pi; pi = pi->next) {
1232 while (prognum < pi->num_progs &&
1233 pi->progs[prognum].pid != childpid) prognum++;
1234 if (prognum < pi->num_progs)
1238 if (WIFEXITED(status) || WIFSIGNALED(status)) {
1240 pi->running_progs--;
1241 pi->progs[prognum].pid = 0;
1243 if (!pi->running_progs) {
1244 printf(JOB_STATUS_FORMAT, pi->jobid, "Done", pi->text);
1251 pi->stopped_progs++;
1252 pi->progs[prognum].is_stopped = 1;
1254 if (pi->stopped_progs == pi->num_progs) {
1255 printf(JOB_STATUS_FORMAT, pi->jobid, "Stopped", pi->text);
1260 if (childpid == -1 && errno != ECHILD)
1261 perror_msg("waitpid");
1263 /* move the shell to the foreground */
1264 if (tcsetpgrp(0, getpgrp()) && errno != ENOTTY)
1265 perror_msg("tcsetpgrp");
1268 /* run_pipe_real() starts all the jobs, but doesn't wait for anything
1269 * to finish. See pipe_wait().
1271 * return code is normally -1, when the caller has to wait for children
1272 * to finish to determine the exit status of the pipe. If the pipe
1273 * is a simple builtin command, however, the action is done by the
1274 * time run_pipe_real returns, and the exit code is provided as the
1277 * The input of the pipe is always stdin, the output is always
1278 * stdout. The outpipe[] mechanism in BusyBox-0.48 lash is bogus,
1279 * because it tries to avoid running the command substitution in
1280 * subshell, when that is in fact necessary. The subshell process
1281 * now has its stdout directed to the input of the appropriate pipe,
1282 * so this routine is noticeably simpler.
1284 static int run_pipe_real(struct pipe *pi)
1288 int nextin, nextout;
1289 int pipefds[2]; /* pipefds[0] is for reading */
1290 struct child_prog *child;
1291 struct built_in_command *x;
1297 /* Check if we are supposed to run in the foreground */
1298 if (interactive && pi->followup!=PIPE_BG) {
1299 if ((pi->pgrp = tcgetpgrp(ctty = 2)) < 0
1300 && (pi->pgrp = tcgetpgrp(ctty = 0)) < 0
1301 && (pi->pgrp = tcgetpgrp(ctty = 1)) < 0)
1302 return errno = ENOTTY, -1;
1304 if (pi->pgrp < 0 && pi->pgrp != getpgrp())
1305 return errno = EPERM, -1;
1308 /* Check if this is a simple builtin (not part of a pipe).
1309 * Builtins within pipes have to fork anyway, and are handled in
1310 * pseudo_exec. "echo foo | read bar" doesn't work on bash, either.
1312 if (pi->num_progs == 1 && pi->progs[0].argv != NULL) {
1313 child = & (pi->progs[0]);
1314 if (child->group && ! child->subshell) {
1315 int squirrel[] = {-1, -1, -1};
1317 debug_printf("non-subshell grouping\n");
1318 setup_redirects(child, squirrel);
1319 /* XXX could we merge code with following builtin case,
1320 * by creating a pseudo builtin that calls run_list_real? */
1321 rcode = run_list_real(child->group);
1322 restore_redirects(squirrel);
1325 for (i=0; is_assignment(child->argv[i]); i++) { /* nothing */ }
1326 if (i!=0 && child->argv[i]==NULL) {
1327 /* assignments, but no command: set the local environment */
1328 for (i=0; child->argv[i]!=NULL; i++) {
1329 set_local_var(child->argv[i]);
1331 return EXIT_SUCCESS; /* don't worry about errors in set_local_var() yet */
1333 for (x = bltins; x->cmd; x++) {
1334 if (strcmp(child->argv[i], x->cmd) == 0 ) {
1335 int squirrel[] = {-1, -1, -1};
1337 if (x->function == builtin_exec && child->argv[i+1]==NULL) {
1338 debug_printf("magic exec\n");
1339 setup_redirects(child,NULL);
1340 return EXIT_SUCCESS;
1342 debug_printf("builtin inline %s\n", child->argv[0]);
1343 /* XXX setup_redirects acts on file descriptors, not FILEs.
1344 * This is perfect for work that comes after exec().
1345 * Is it really safe for inline use? Experimentally,
1346 * things seem to work with glibc. */
1347 setup_redirects(child, squirrel);
1348 for (i=0; is_assignment(child->argv[i]); i++) {
1349 putenv(strdup(child->argv[i]));
1351 child->argv+=i; /* XXX horrible hack */
1352 rcode = x->function(child);
1353 child->argv-=i; /* XXX restore hack so free() can work right */
1354 restore_redirects(squirrel);
1360 for (i = 0; i < pi->num_progs; i++) {
1361 child = & (pi->progs[i]);
1363 /* pipes are inserted between pairs of commands */
1364 if ((i + 1) < pi->num_progs) {
1365 if (pipe(pipefds)<0) perror_msg_and_die("pipe");
1366 nextout = pipefds[1];
1372 /* XXX test for failed fork()? */
1373 if (!(child->pid = fork())) {
1375 signal(SIGTTOU, SIG_DFL);
1387 if (pipefds[0]!=-1) {
1388 close(pipefds[0]); /* opposite end of our output pipe */
1391 /* Like bash, explicit redirects override pipes,
1392 * and the pipe fd is available for dup'ing. */
1393 setup_redirects(child,NULL);
1395 if (pi->followup!=PIPE_BG) {
1396 /* Put our child in the process group whose leader is the
1397 * first process in this pipe. */
1399 pi->pgrp = child->pid;
1401 /* Don't check for errors. The child may be dead already,
1402 * in which case setpgid returns error code EACCES. */
1403 if (setpgid(0, pi->pgrp) == 0) {
1404 signal(SIGTTOU, SIG_IGN);
1405 tcsetpgrp(ctty, pi->pgrp);
1406 signal(SIGTTOU, SIG_DFL);
1412 /* Put our child in the process group whose leader is the
1413 * first process in this pipe. */
1415 pi->pgrp = child->pid;
1417 /* Don't check for errors. The child may be dead already,
1418 * in which case setpgid returns error code EACCES. */
1419 setpgid(child->pid, pi->pgrp);
1426 /* If there isn't another process, nextin is garbage
1427 but it doesn't matter */
1428 nextin = pipefds[0];
1433 static int run_list_real(struct pipe *pi)
1436 int if_code=0, next_if_code=0; /* need double-buffer to handle elif */
1437 reserved_style rmode, skip_more_in_this_rmode=RES_XXXX;
1438 for (;pi;pi=pi->next) {
1440 debug_printf("rmode=%d if_code=%d next_if_code=%d skip_more=%d\n", rmode, if_code, next_if_code, skip_more_in_this_rmode);
1441 if (rmode == skip_more_in_this_rmode) continue;
1442 skip_more_in_this_rmode = RES_XXXX;
1443 if (rmode == RES_THEN || rmode == RES_ELSE) if_code = next_if_code;
1444 if (rmode == RES_THEN && if_code) continue;
1445 if (rmode == RES_ELSE && !if_code) continue;
1446 if (rmode == RES_ELIF && !if_code) continue;
1447 if (pi->num_progs == 0) continue;
1448 rcode = run_pipe_real(pi);
1450 /* We only ran a builtin: rcode was set by the return value
1451 * of run_pipe_real(), and we don't need to wait for anything. */
1452 } else if (pi->followup==PIPE_BG) {
1453 /* XXX check bash's behavior with nontrivial pipes */
1454 /* XXX compute jobid */
1455 /* XXX what does bash do with attempts to background builtins? */
1457 rcode = EXIT_SUCCESS;
1461 /* move the new process group into the foreground */
1462 /* suppress messages when run from /linuxrc mag@sysgo.de */
1463 //signal(SIGTTIN, SIG_IGN);
1464 //signal(SIGTTOU, SIG_IGN);
1465 if (tcsetpgrp(0, pi->pgrp) && errno != ENOTTY)
1466 perror_msg("tcsetpgrp");
1467 rcode = pipe_wait(pi);
1468 if (tcsetpgrp(0, getpgrp()) && errno != ENOTTY)
1469 perror_msg("tcsetpgrp");
1470 //signal(SIGTTIN, SIG_DFL);
1471 //signal(SIGTTOU, SIG_DFL);
1473 rcode = pipe_wait(pi);
1476 last_return_code=rcode;
1477 if ( rmode == RES_IF || rmode == RES_ELIF )
1478 next_if_code=rcode; /* can be overwritten a number of times */
1479 if ( (rcode==EXIT_SUCCESS && pi->followup==PIPE_OR) ||
1480 (rcode!=EXIT_SUCCESS && pi->followup==PIPE_AND) )
1481 skip_more_in_this_rmode=rmode;
1482 /* return rcode; */ /* XXX broken if list is part of if/then/else */
1488 /* broken, of course, but OK for testing */
1489 static char *indenter(int i)
1491 static char blanks[]=" ";
1492 return &blanks[sizeof(blanks)-i-1];
1495 /* return code is the exit status of the pipe */
1496 static int run_pipe_test(struct pipe *pi, int indent)
1499 struct child_prog *child;
1500 struct redir_struct *r, *rnext;
1501 int a, i, ret_code=0;
1502 char *ind = indenter(indent);
1503 final_printf("%s run pipe: (pid %d)\n",ind,getpid());
1504 for (i=0; i<pi->num_progs; i++) {
1505 child = &pi->progs[i];
1506 final_printf("%s command %d:\n",ind,i);
1508 for (a=0,p=child->argv; *p; a++,p++) {
1509 final_printf("%s argv[%d] = %s\n",ind,a,*p);
1511 globfree(&child->glob_result);
1513 } else if (child->group) {
1514 final_printf("%s begin group (subshell:%d)\n",ind, child->subshell);
1515 ret_code = run_list_test(child->group,indent+3);
1516 final_printf("%s end group\n",ind);
1518 final_printf("%s (nil)\n",ind);
1520 for (r=child->redirects; r; r=rnext) {
1521 final_printf("%s redirect %d%s", ind, r->fd, redir_table[r->type].descrip);
1523 final_printf(" %s\n", *r->word.gl_pathv);
1526 final_printf("&%d\n", r->dup);
1531 child->redirects=NULL;
1533 free(pi->progs); /* children are an array, they get freed all at once */
1538 static int run_list_test(struct pipe *head, int indent)
1540 int rcode=0; /* if list has no members */
1541 struct pipe *pi, *next;
1542 char *ind = indenter(indent);
1543 for (pi=head; pi; pi=next) {
1544 if (pi->num_progs == 0) break;
1545 final_printf("%s pipe reserved mode %d\n", ind, pi->r_mode);
1546 rcode = run_pipe_test(pi, indent);
1547 final_printf("%s pipe followup code %d\n", ind, pi->followup);
1555 /* Select which version we will use */
1556 static int run_list(struct pipe *pi)
1560 rcode = run_list_real(pi);
1562 /* run_list_test has the side effect of clearing memory
1563 * In the long run that function can be merged with run_list_real,
1564 * but doing that now would hobble the debugging effort. */
1565 run_list_test(pi,0);
1569 /* The API for glob is arguably broken. This routine pushes a non-matching
1570 * string into the output structure, removing non-backslashed backslashes.
1571 * If someone can prove me wrong, by performing this function within the
1572 * original glob(3) api, feel free to rewrite this routine into oblivion.
1573 * Return code (0 vs. GLOB_NOSPACE) matches glob(3).
1574 * XXX broken if the last character is '\\', check that before calling.
1576 static int globhack(const char *src, int flags, glob_t *pglob)
1581 for (cnt=1, s=src; *s; s++) {
1582 if (*s == '\\') s++;
1586 if (!dest) return GLOB_NOSPACE;
1587 if (!(flags & GLOB_APPEND)) {
1588 pglob->gl_pathv=NULL;
1593 pathc = ++pglob->gl_pathc;
1594 pglob->gl_pathv = realloc(pglob->gl_pathv, (pathc+1)*sizeof(*pglob->gl_pathv));
1595 if (pglob->gl_pathv == NULL) return GLOB_NOSPACE;
1596 pglob->gl_pathv[pathc-1]=dest;
1597 pglob->gl_pathv[pathc]=NULL;
1598 for (s=src; *s; s++, dest++) {
1599 if (*s == '\\') s++;
1606 /* XXX broken if the last character is '\\', check that before calling */
1607 static int glob_needed(const char *s)
1610 if (*s == '\\') s++;
1611 if (strchr("*[?",*s)) return 1;
1617 static void globprint(glob_t *pglob)
1620 debug_printf("glob_t at %p:\n", pglob);
1621 debug_printf(" gl_pathc=%d gl_pathv=%p gl_offs=%d gl_flags=%d\n",
1622 pglob->gl_pathc, pglob->gl_pathv, pglob->gl_offs, pglob->gl_flags);
1623 for (i=0; i<pglob->gl_pathc; i++)
1624 debug_printf("pglob->gl_pathv[%d] = %p = %s\n", i,
1625 pglob->gl_pathv[i], pglob->gl_pathv[i]);
1629 static int xglob(o_string *dest, int flags, glob_t *pglob)
1633 /* short-circuit for null word */
1634 /* we can code this better when the debug_printf's are gone */
1635 if (dest->length == 0) {
1636 if (dest->nonnull) {
1637 /* bash man page calls this an "explicit" null */
1638 gr = globhack(dest->data, flags, pglob);
1639 debug_printf("globhack returned %d\n",gr);
1643 } else if (glob_needed(dest->data)) {
1644 gr = glob(dest->data, flags, NULL, pglob);
1645 debug_printf("glob returned %d\n",gr);
1646 if (gr == GLOB_NOMATCH) {
1647 /* quote removal, or more accurately, backslash removal */
1648 gr = globhack(dest->data, flags, pglob);
1649 debug_printf("globhack returned %d\n",gr);
1652 gr = globhack(dest->data, flags, pglob);
1653 debug_printf("globhack returned %d\n",gr);
1655 if (gr == GLOB_NOSPACE) {
1656 fprintf(stderr,"out of memory during glob\n");
1659 if (gr != 0) { /* GLOB_ABORTED ? */
1660 fprintf(stderr,"glob(3) error %d\n",gr);
1662 /* globprint(glob_target); */
1666 /* This is used to get/check local shell variables */
1667 static char *get_local_var(const char *s)
1674 if (!__shell_local_env)
1678 for (p = __shell_local_env; *p; p++) {
1679 if (memcmp(s, *p, len) == 0 && (*p)[len] == '=') {
1680 return *p + len + 1;
1686 /* This is used to set local shell variables */
1687 static int set_local_var(const char *s)
1690 char *tmp,*name, *value;
1698 /* Assume when we enter this function that we are already in
1699 * NAME=VALUE format. So the first order of business is to
1700 * split 's' on the '=' into 'name' and 'value' */
1701 value = strchr(name, '=');
1709 namelen = strlen (name);
1710 vallen = strlen (value);
1712 /* Now see how many local environment entries we have, and check
1713 * if we match an existing environment entry (so we can overwrite it) */
1715 for (ep = __shell_local_env; ep && *ep != NULL; ++ep) {
1716 if (!memcmp (*ep, name, namelen) && (*ep)[namelen] == '=')
1722 if (ep == NULL || *ep == NULL) {
1723 static char **last_environ = NULL;
1724 char **new_environ = (char **) malloc((size + 2) * sizeof(char *));
1725 if (new_environ == NULL) {
1729 memcpy((__ptr_t) new_environ, (__ptr_t) __shell_local_env,
1730 size * sizeof(char *));
1732 new_environ[size] = malloc (namelen + 1 + vallen + 1);
1733 if (new_environ[size] == NULL) {
1739 memcpy (new_environ[size], name, namelen);
1740 new_environ[size][namelen] = '=';
1741 memcpy (&new_environ[size][namelen + 1], value, vallen + 1);
1743 new_environ[size + 1] = NULL;
1745 if (last_environ != NULL)
1746 free ((__ptr_t) last_environ);
1747 last_environ = new_environ;
1748 __shell_local_env = new_environ;
1751 size_t len = strlen (*ep);
1752 if (len < namelen + 1 + vallen) {
1753 char *new = malloc (namelen + 1 + vallen + 1);
1759 memcpy (*ep, name, namelen);
1760 (*ep)[namelen] = '=';
1762 memcpy (&(*ep)[namelen + 1], value, vallen + 1);
1765 /* One last little detail... If this variable is already
1766 * in the environment we must set it there as well... */
1769 /* FIXME -- I leak memory!!!!! */
1778 static void unset_local_var(const char *name)
1785 namelen = strlen(name);
1786 for (dp = ep = __shell_local_env; ep && *ep != NULL; ++ep) {
1787 if (memcmp (*ep, name, namelen)==0 && (*ep)[namelen] == '=') {
1796 static int is_assignment(const char *s)
1798 if (s==NULL || !isalpha(*s)) return 0;
1800 while(isalnum(*s) || *s=='_') ++s;
1804 /* the src parameter allows us to peek forward to a possible &n syntax
1805 * for file descriptor duplication, e.g., "2>&1".
1806 * Return code is 0 normally, 1 if a syntax error is detected in src.
1807 * Resource errors (in xmalloc) cause the process to exit */
1808 static int setup_redirect(struct p_context *ctx, int fd, redir_type style,
1809 struct in_str *input)
1811 struct child_prog *child=ctx->child;
1812 struct redir_struct *redir = child->redirects;
1813 struct redir_struct *last_redir=NULL;
1815 /* Create a new redir_struct and drop it onto the end of the linked list */
1820 redir = xmalloc(sizeof(struct redir_struct));
1823 last_redir->next=redir;
1825 child->redirects=redir;
1829 redir->fd= (fd==-1) ? redir_table[style].default_fd : fd ;
1831 debug_printf("Redirect type %d%s\n", redir->fd, redir_table[style].descrip);
1833 /* Check for a '2>&1' type redirect */
1834 redir->dup = redirect_dup_num(input);
1835 if (redir->dup == -2) return 1; /* syntax error */
1836 if (redir->dup != -1) {
1837 /* Erik had a check here that the file descriptor in question
1838 * is legit; I postpone that to "run time"
1839 * A "-" representation of "close me" shows up as a -3 here */
1840 debug_printf("Duplicating redirect '%d>&%d'\n", redir->fd, redir->dup);
1842 /* We do _not_ try to open the file that src points to,
1843 * since we need to return and let src be expanded first.
1844 * Set ctx->pending_redirect, so we know what to do at the
1845 * end of the next parsed word.
1847 ctx->pending_redirect = redir;
1852 struct pipe *new_pipe(void) {
1854 pi = xmalloc(sizeof(struct pipe));
1858 pi->followup = 0; /* invalid */
1862 static void initialize_context(struct p_context *ctx)
1865 ctx->pending_redirect=NULL;
1867 ctx->list_head=new_pipe();
1868 ctx->pipe=ctx->list_head;
1871 done_command(ctx); /* creates the memory for working child */
1874 /* normal return is 0
1875 * if a reserved word is found, and processed, return 1
1876 * should handle if, then, elif, else, fi, for, while, until, do, done.
1877 * case, function, and select are obnoxious, save those for later.
1879 int reserved_word(o_string *dest, struct p_context *ctx)
1881 struct reserved_combo {
1886 /* Mostly a list of accepted follow-up reserved words.
1887 * FLAG_END means we are done with the sequence, and are ready
1888 * to turn the compound list into a command.
1889 * FLAG_START means the word must start a new compound list.
1891 static struct reserved_combo reserved_list[] = {
1892 { "if", RES_IF, FLAG_THEN | FLAG_START },
1893 { "then", RES_THEN, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
1894 { "elif", RES_ELIF, FLAG_THEN },
1895 { "else", RES_ELSE, FLAG_FI },
1896 { "fi", RES_FI, FLAG_END },
1897 { "for", RES_FOR, FLAG_DO | FLAG_START },
1898 { "while", RES_WHILE, FLAG_DO | FLAG_START },
1899 { "until", RES_UNTIL, FLAG_DO | FLAG_START },
1900 { "do", RES_DO, FLAG_DONE },
1901 { "done", RES_DONE, FLAG_END }
1903 struct reserved_combo *r;
1904 for (r=reserved_list;
1905 #define NRES sizeof(reserved_list)/sizeof(struct reserved_combo)
1906 r<reserved_list+NRES; r++) {
1907 if (strcmp(dest->data, r->literal) == 0) {
1908 debug_printf("found reserved word %s, code %d\n",r->literal,r->code);
1909 if (r->flag & FLAG_START) {
1910 struct p_context *new = xmalloc(sizeof(struct p_context));
1911 debug_printf("push stack\n");
1912 *new = *ctx; /* physical copy */
1913 initialize_context(ctx);
1915 } else if ( ctx->w == RES_NONE || ! (ctx->old_flag & (1<<r->code))) {
1922 ctx->old_flag = r->flag;
1923 if (ctx->old_flag & FLAG_END) {
1924 struct p_context *old;
1925 debug_printf("pop stack\n");
1927 old->child->group = ctx->list_head;
1928 *ctx = *old; /* physical copy */
1938 /* normal return is 0.
1939 * Syntax or xglob errors return 1. */
1940 static int done_word(o_string *dest, struct p_context *ctx)
1942 struct child_prog *child=ctx->child;
1943 glob_t *glob_target;
1946 debug_printf("done_word: %s %p\n", dest->data, child);
1947 if (dest->length == 0 && !dest->nonnull) {
1948 debug_printf(" true null, ignored\n");
1951 if (ctx->pending_redirect) {
1952 glob_target = &ctx->pending_redirect->word;
1956 return 1; /* syntax error, groups and arglists don't mix */
1959 debug_printf("checking %s for reserved-ness\n",dest->data);
1960 if (reserved_word(dest,ctx)) return ctx->w==RES_SNTX;
1962 glob_target = &child->glob_result;
1963 if (child->argv) flags |= GLOB_APPEND;
1965 gr = xglob(dest, flags, glob_target);
1966 if (gr != 0) return 1;
1969 if (ctx->pending_redirect) {
1970 ctx->pending_redirect=NULL;
1971 if (glob_target->gl_pathc != 1) {
1972 fprintf(stderr, "ambiguous redirect\n");
1976 child->argv = glob_target->gl_pathv;
1981 /* The only possible error here is out of memory, in which case
1983 static int done_command(struct p_context *ctx)
1985 /* The child is really already in the pipe structure, so
1986 * advance the pipe counter and make a new, null child.
1987 * Only real trickiness here is that the uncommitted
1988 * child structure, to which ctx->child points, is not
1989 * counted in pi->num_progs. */
1990 struct pipe *pi=ctx->pipe;
1991 struct child_prog *prog=ctx->child;
1993 if (prog && prog->group == NULL
1994 && prog->argv == NULL
1995 && prog->redirects == NULL) {
1996 debug_printf("done_command: skipping null command\n");
2000 debug_printf("done_command: num_progs incremented to %d\n",pi->num_progs);
2002 debug_printf("done_command: initializing\n");
2004 pi->progs = xrealloc(pi->progs, sizeof(*pi->progs) * (pi->num_progs+1));
2006 prog = pi->progs + pi->num_progs;
2007 prog->redirects = NULL;
2009 prog->is_stopped = 0;
2011 prog->glob_result.gl_pathv = NULL;
2015 /* but ctx->pipe and ctx->list_head remain unchanged */
2019 static int done_pipe(struct p_context *ctx, pipe_style type)
2022 done_command(ctx); /* implicit closure of previous command */
2023 debug_printf("done_pipe, type %d\n", type);
2024 ctx->pipe->followup = type;
2025 ctx->pipe->r_mode = ctx->w;
2027 ctx->pipe->next = new_p;
2030 done_command(ctx); /* set up new pipe to accept commands */
2034 /* peek ahead in the in_str to find out if we have a "&n" construct,
2035 * as in "2>&1", that represents duplicating a file descriptor.
2036 * returns either -2 (syntax error), -1 (no &), or the number found.
2038 static int redirect_dup_num(struct in_str *input)
2042 if (ch != '&') return -1;
2044 b_getch(input); /* get the & */
2048 return -3; /* "-" represents "close me" */
2050 while (isdigit(ch)) {
2058 fprintf(stderr, "ambiguous redirect\n");
2062 /* If a redirect is immediately preceded by a number, that number is
2063 * supposed to tell which file descriptor to redirect. This routine
2064 * looks for such preceding numbers. In an ideal world this routine
2065 * needs to handle all the following classes of redirects...
2066 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
2067 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
2068 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
2069 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
2070 * A -1 output from this program means no valid number was found, so the
2071 * caller should use the appropriate default for this redirection.
2073 static int redirect_opt_num(o_string *o)
2077 if (o->length==0) return -1;
2078 for(num=0; num<o->length; num++) {
2079 if (!isdigit(*(o->data+num))) {
2083 /* reuse num (and save an int) */
2089 FILE *generate_stream_from_list(struct pipe *head)
2093 int pid, channel[2];
2094 if (pipe(channel)<0) perror_msg_and_die("pipe");
2097 perror_msg_and_die("fork");
2098 } else if (pid==0) {
2100 if (channel[1] != 1) {
2105 #define SURROGATE "surrogate response"
2106 write(1,SURROGATE,sizeof(SURROGATE));
2107 exit(run_list(head));
2109 exit(run_list_real(head)); /* leaks memory */
2112 debug_printf("forked child %d\n",pid);
2114 pf = fdopen(channel[0],"r");
2115 debug_printf("pipe on FILE *%p\n",pf);
2117 run_list_test(head,0);
2118 pf=popen("echo surrogate response","r");
2119 debug_printf("started fake pipe on FILE *%p\n",pf);
2124 /* this version hacked for testing purposes */
2125 /* return code is exit status of the process that is run. */
2126 static int process_command_subs(o_string *dest, struct p_context *ctx, struct in_str *input, int subst_end)
2129 o_string result=NULL_O_STRING;
2130 struct p_context inner;
2132 struct in_str pipe_str;
2133 initialize_context(&inner);
2135 /* recursion to generate command */
2136 retcode = parse_stream(&result, &inner, input, subst_end);
2137 if (retcode != 0) return retcode; /* syntax error or EOF */
2138 done_word(&result, &inner);
2139 done_pipe(&inner, PIPE_SEQ);
2142 p=generate_stream_from_list(inner.list_head);
2143 if (p==NULL) return 1;
2144 mark_open(fileno(p));
2145 setup_file_in_str(&pipe_str, p);
2147 /* now send results of command back into original context */
2148 retcode = parse_stream(dest, ctx, &pipe_str, '\0');
2149 /* XXX In case of a syntax error, should we try to kill the child?
2150 * That would be tough to do right, so just read until EOF. */
2152 while (b_getch(&pipe_str)!=EOF) { /* discard */ };
2155 debug_printf("done reading from pipe, pclose()ing\n");
2156 /* This is the step that wait()s for the child. Should be pretty
2157 * safe, since we just read an EOF from its stdout. We could try
2158 * to better, by using wait(), and keeping track of background jobs
2159 * at the same time. That would be a lot of work, and contrary
2160 * to the KISS philosophy of this program. */
2161 mark_closed(fileno(p));
2163 debug_printf("pclosed, retcode=%d\n",retcode);
2164 /* XXX this process fails to trim a single trailing newline */
2168 static int parse_group(o_string *dest, struct p_context *ctx,
2169 struct in_str *input, int ch)
2172 struct p_context sub;
2173 struct child_prog *child = ctx->child;
2176 return 1; /* syntax error, groups and arglists don't mix */
2178 initialize_context(&sub);
2180 case '(': endch=')'; child->subshell=1; break;
2181 case '{': endch='}'; break;
2182 default: syntax(); /* really logic error */
2184 rcode=parse_stream(dest,&sub,input,endch);
2185 done_word(dest,&sub); /* finish off the final word in the subcontext */
2186 done_pipe(&sub, PIPE_SEQ); /* and the final command there, too */
2187 child->group = sub.list_head;
2189 /* child remains "open", available for possible redirects */
2192 /* basically useful version until someone wants to get fancier,
2193 * see the bash man page under "Parameter Expansion" */
2194 static void lookup_param(o_string *dest, struct p_context *ctx, o_string *src)
2198 p = getenv(src->data);
2200 p = get_local_var(src->data);
2202 if (p) parse_string(dest, ctx, p); /* recursion */
2206 /* return code: 0 for OK, 1 for syntax error */
2207 static int handle_dollar(o_string *dest, struct p_context *ctx, struct in_str *input)
2210 o_string alt=NULL_O_STRING;
2212 int ch = input->peek(input); /* first character after the $ */
2213 debug_printf("handle_dollar: ch=%c\n",ch);
2215 while(ch=b_peek(input),isalnum(ch) || ch=='_') {
2219 lookup_param(dest, ctx, &alt);
2220 } else if (isdigit(ch)) {
2221 i = ch-'0'; /* XXX is $0 special? */
2222 if (i<global_argc) {
2223 parse_string(dest, ctx, global_argv[i]); /* recursion */
2226 } else switch (ch) {
2228 b_adduint(dest,getpid());
2232 if (last_bg_pid > 0) b_adduint(dest, last_bg_pid);
2236 b_adduint(dest,last_return_code);
2240 b_adduint(dest,global_argc ? global_argc-1 : 0);
2245 /* XXX maybe someone will try to escape the '}' */
2246 while(ch=b_getch(input),ch!=EOF && ch!='}') {
2253 lookup_param(dest, ctx, &alt);
2257 process_command_subs(dest, ctx, input, ')');
2261 for (i=1; i<global_argc; i++) {
2262 parse_string(dest, ctx, global_argv[i]);
2263 if (i+1 < global_argc) parse_string(dest, ctx, sep);
2269 /* still unhandled, but should be eventually */
2270 fprintf(stderr,"unhandled syntax: $%c\n",ch);
2274 b_addqchr(dest,'$',dest->quote);
2276 /* Eat the character if the flag was set. If the compiler
2277 * is smart enough, we could substitute "b_getch(input);"
2278 * for all the "advance = 1;" above, and also end up with
2279 * a nice size-optimized program. Hah! That'll be the day.
2281 if (advance) b_getch(input);
2285 int parse_string(o_string *dest, struct p_context *ctx, const char *src)
2288 setup_string_in_str(&foo, src);
2289 return parse_stream(dest, ctx, &foo, '\0');
2292 /* return code is 0 for normal exit, 1 for syntax error */
2293 int parse_stream(o_string *dest, struct p_context *ctx,
2294 struct in_str *input, int end_trigger)
2298 redir_type redir_style;
2301 /* Only double-quote state is handled in the state variable dest->quote.
2302 * A single-quote triggers a bypass of the main loop until its mate is
2303 * found. When recursing, quote state is passed in via dest->quote. */
2305 debug_printf("parse_stream, end_trigger=%d\n",end_trigger);
2306 while ((ch=b_getch(input))!=EOF) {
2308 next = (ch == '\n') ? 0 : b_peek(input);
2309 debug_printf("parse_stream: ch=%c (%d) m=%d quote=%d\n",
2310 ch,ch,m,dest->quote);
2311 if (m==0 || ((m==1 || m==2) && dest->quote)) {
2312 b_addqchr(dest, ch, dest->quote);
2314 if (m==2) { /* unquoted IFS */
2315 done_word(dest, ctx);
2316 /* If we aren't performing a substitution, treat a newline as a
2317 * command separator. */
2318 if (end_trigger != '\0' && ch=='\n')
2319 done_pipe(ctx,PIPE_SEQ);
2321 if (ch == end_trigger && !dest->quote && ctx->w==RES_NONE) {
2322 debug_printf("leaving parse_stream\n");
2327 /* Yahoo! Time to run with it! */
2328 done_pipe(ctx,PIPE_SEQ);
2329 run_list(ctx->list_head);
2330 initialize_context(ctx);
2333 if (m!=2) switch (ch) {
2335 if (dest->length == 0 && !dest->quote) {
2336 while(ch=b_peek(input),ch!=EOF && ch!='\n') { b_getch(input); }
2338 b_addqchr(dest, ch, dest->quote);
2346 b_addqchr(dest, '\\', dest->quote);
2347 b_addqchr(dest, b_getch(input), dest->quote);
2350 if (handle_dollar(dest, ctx, input)!=0) return 1;
2354 while(ch=b_getch(input),ch!=EOF && ch!='\'') {
2364 dest->quote = !dest->quote;
2367 process_command_subs(dest, ctx, input, '`');
2370 redir_fd = redirect_opt_num(dest);
2371 done_word(dest, ctx);
2372 redir_style=REDIRECT_OVERWRITE;
2374 redir_style=REDIRECT_APPEND;
2376 } else if (next == '(') {
2377 syntax(); /* until we support >(list) Process Substitution */
2380 setup_redirect(ctx, redir_fd, redir_style, input);
2383 redir_fd = redirect_opt_num(dest);
2384 done_word(dest, ctx);
2385 redir_style=REDIRECT_INPUT;
2387 redir_style=REDIRECT_HEREIS;
2389 } else if (next == '>') {
2390 redir_style=REDIRECT_IO;
2392 } else if (next == '(') {
2393 syntax(); /* until we support <(list) Process Substitution */
2396 setup_redirect(ctx, redir_fd, redir_style, input);
2399 done_word(dest, ctx);
2400 done_pipe(ctx,PIPE_SEQ);
2403 done_word(dest, ctx);
2406 done_pipe(ctx,PIPE_AND);
2408 done_pipe(ctx,PIPE_BG);
2412 done_word(dest, ctx);
2415 done_pipe(ctx,PIPE_OR);
2417 /* we could pick up a file descriptor choice here
2418 * with redirect_opt_num(), but bash doesn't do it.
2419 * "echo foo 2| cat" yields "foo 2". */
2425 if (parse_group(dest, ctx, input, ch)!=0) return 1;
2429 syntax(); /* Proper use of this character caught by end_trigger */
2433 syntax(); /* this is really an internal logic error */
2438 /* complain if quote? No, maybe we just finished a command substitution
2439 * that was quoted. Example:
2440 * $ echo "`cat foo` plus more"
2441 * and we just got the EOF generated by the subshell that ran "cat foo"
2442 * The only real complaint is if we got an EOF when end_trigger != '\0',
2443 * that is, we were really supposed to get end_trigger, and never got
2444 * one before the EOF. Can't use the standard "syntax error" return code,
2445 * so that parse_stream_outer can distinguish the EOF and exit smoothly. */
2446 if (end_trigger != '\0') return -1;
2450 void mapset(const unsigned char *set, int code)
2452 const unsigned char *s;
2453 for (s=set; *s; s++) map[*s] = code;
2456 void update_ifs_map(void)
2458 /* char *ifs and char map[256] are both globals. */
2459 ifs = getenv("IFS");
2460 if (ifs == NULL) ifs=" \t\n";
2461 /* Precompute a list of 'flow through' behavior so it can be treated
2462 * quickly up front. Computation is necessary because of IFS.
2463 * Special case handling of IFS == " \t\n" is not implemented.
2464 * The map[] array only really needs two bits each, and on most machines
2465 * that would be faster because of the reduced L1 cache footprint.
2467 memset(map,0,256); /* most characters flow through always */
2468 mapset("\\$'\"`", 3); /* never flow through */
2469 mapset("<>;&|(){}#", 1); /* flow through if quoted */
2470 mapset(ifs, 2); /* also flow through if quoted */
2473 /* most recursion does not come through here, the exeception is
2474 * from builtin_source() */
2475 int parse_stream_outer(struct in_str *inp)
2478 struct p_context ctx;
2479 o_string temp=NULL_O_STRING;
2482 initialize_context(&ctx);
2485 rcode = parse_stream(&temp, &ctx, inp, '\n');
2486 done_word(&temp, &ctx);
2487 done_pipe(&ctx,PIPE_SEQ);
2488 run_list(ctx.list_head);
2489 } while (rcode != -1); /* loop on syntax errors, return on EOF */
2493 static int parse_string_outer(const char *s)
2495 struct in_str input;
2496 setup_string_in_str(&input, s);
2497 return parse_stream_outer(&input);
2500 static int parse_file_outer(FILE *f)
2503 struct in_str input;
2504 setup_file_in_str(&input, f);
2505 rcode = parse_stream_outer(&input);
2509 int shell_main(int argc, char **argv)
2513 struct jobset joblist_end = { NULL, NULL };
2514 job_list = &joblist_end;
2516 last_return_code=EXIT_SUCCESS;
2518 /* XXX what should these be while sourcing /etc/profile? */
2522 /* don't pay any attention to this signal; it just confuses
2523 things and isn't really meant for shells anyway */
2524 signal(SIGTTOU, SIG_IGN);
2526 if (argv[0] && argv[0][0] == '-') {
2527 debug_printf("\nsourcing /etc/profile\n");
2528 input = xfopen("/etc/profile", "r");
2529 mark_open(fileno(input));
2530 parse_file_outer(input);
2531 mark_closed(fileno(input));
2536 /* initialize the cwd -- this is never freed...*/
2540 #ifdef BB_FEATURE_COMMAND_EDITING
2541 cmdedit_set_initial_prompt();
2546 while ((opt = getopt(argc, argv, "c:xif")) > 0) {
2550 global_argv = argv+optind;
2551 global_argc = argc-optind;
2552 opt = parse_string_outer(optarg);
2563 fprintf(stderr, "Usage: sh [FILE]...\n"
2564 " or: sh -c command [args]...\n\n");
2568 /* A shell is interactive if the `-i' flag was given, or if all of
2569 * the following conditions are met:
2571 * no arguments remaining or the -s flag given
2572 * standard input is a terminal
2573 * standard output is a terminal
2574 * Refer to Posix.2, the description of the `sh' utility. */
2575 if (argv[optind]==NULL && input==stdin &&
2576 isatty(fileno(stdin)) && isatty(fileno(stdout))) {
2580 debug_printf("\ninteractive=%d\n", interactive);
2582 /* Looks like they want an interactive shell */
2583 fprintf(stdout, "\nhush -- the humble shell v0.01 (testing)\n\n");
2584 opt=parse_file_outer(stdin);
2588 debug_printf("\nrunning script '%s'\n", argv[optind]);
2589 global_argv = argv+optind;
2590 global_argc = argc-optind;
2591 input = xfopen(argv[optind], "r");
2592 opt = parse_file_outer(input);
2594 #ifdef BB_FEATURE_CLEAN_UP
2599 return(opt?opt:last_return_code);