2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 static char sccsid[] = "@(#)exec.c 8.4 (Berkeley) 6/8/95";
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
41 #include <sys/types.h>
50 * When commands are first encountered, they are entered in a hash table.
51 * This ensures that a full path search will not have to be done for them
54 * We should investigate converting to a linear search, even though that
55 * would make the command name "hash" a misnomer.
79 #define CMDTABLESIZE 31 /* should be prime */
84 struct tblentry *next; /* next entry in hash chain */
85 union param param; /* definition of builtin function */
86 int special; /* flag for special builtin commands */
87 signed char cmdtype; /* index identifying command */
88 char cmdname[]; /* name of command */
92 static struct tblentry *cmdtable[CMDTABLESIZE];
93 static int cmdtable_cd = 0; /* cmdtable contains cd-dependent entries */
94 int exerrno = 0; /* Last exec error */
97 static void tryexec(char *, char **, char **);
98 static void printentry(struct tblentry *, int);
99 static struct tblentry *cmdlookup(const char *, int);
100 static void delete_cmd_entry(void);
101 static void addcmdentry(const char *, struct cmdentry *);
106 * Exec a program. Never returns. If you change this routine, you may
107 * have to change the find_command routine as well.
109 * The argv array may be changed and element argv[-1] should be writable.
113 shellexec(char **argv, char **envp, const char *path, int idx)
118 if (strchr(argv[0], '/') != NULL) {
119 tryexec(argv[0], argv, envp);
123 while ((cmdname = padvance(&path, argv[0])) != NULL) {
124 if (--idx < 0 && pathopt == NULL) {
125 tryexec(cmdname, argv, envp);
126 if (errno != ENOENT && errno != ENOTDIR)
135 /* Map to POSIX errors */
136 if (e == ENOENT || e == ENOTDIR) {
138 exerror(EXEXEC, "%s: not found", argv[0]);
141 exerror(EXEXEC, "%s: %s", argv[0], strerror(e));
147 tryexec(char *cmd, char **argv, char **envp)
153 execve(cmd, argv, envp);
157 in = open(cmd, O_RDONLY | O_NONBLOCK);
159 n = pread(in, buf, sizeof buf, 0);
161 if (n > 0 && memchr(buf, '\0', n) != NULL) {
167 *--argv = __DECONST(char *, _PATH_BSHELL);
168 execve(_PATH_BSHELL, argv, envp);
174 * Do a path search. The variable path (passed by reference) should be
175 * set to the start of the path before the first call; padvance will update
176 * this value as it proceeds. Successive calls to padvance will return
177 * the possible path expansions in sequence. If an option (indicated by
178 * a percent sign) appears in the path entry then the global variable
179 * pathopt will be set to point to it; otherwise pathopt will be set to
186 padvance(const char **path, const char *name)
188 const char *p, *start;
195 for (p = start; *p && *p != ':' && *p != '%'; p++)
197 namelen = strlen(name);
198 len = p - start + namelen + 2; /* "2" is for '/' and '\0' */
200 CHECKSTRSPACE(len, q);
202 memcpy(q, start, p - start);
206 memcpy(q, name, namelen + 1);
210 while (*p && *p != ':') p++;
221 /*** Command hashing code ***/
225 hashcmd(int argc __unused, char **argv __unused)
227 struct tblentry **pp;
228 struct tblentry *cmdp;
231 struct cmdentry entry;
237 while ((c = nextopt("rv")) != '\0') {
240 } else if (c == 'v') {
244 if (*argptr == NULL) {
245 for (pp = cmdtable ; pp < &cmdtable[CMDTABLESIZE] ; pp++) {
246 for (cmdp = *pp ; cmdp ; cmdp = cmdp->next) {
247 if (cmdp->cmdtype == CMDNORMAL)
248 printentry(cmdp, verbose);
253 while ((name = *argptr) != NULL) {
254 if ((cmdp = cmdlookup(name, 0)) != NULL
255 && cmdp->cmdtype == CMDNORMAL)
257 find_command(name, &entry, DO_ERR, pathval());
258 if (entry.cmdtype == CMDUNKNOWN)
261 cmdp = cmdlookup(name, 0);
263 printentry(cmdp, verbose);
265 outfmt(out2, "%s: not found\n", name);
277 printentry(struct tblentry *cmdp, int verbose)
283 if (cmdp->cmdtype == CMDNORMAL) {
284 idx = cmdp->param.index;
287 name = padvance(&path, cmdp->cmdname);
289 } while (--idx >= 0);
291 } else if (cmdp->cmdtype == CMDBUILTIN) {
292 out1fmt("builtin %s", cmdp->cmdname);
293 } else if (cmdp->cmdtype == CMDFUNCTION) {
294 out1fmt("function %s", cmdp->cmdname);
297 name = commandtext(getfuncnode(cmdp->param.func));
305 error("internal error: cmdtype %d", cmdp->cmdtype);
314 * Resolve a command name. If you change this routine, you may have to
315 * change the shellexec routine as well.
319 find_command(const char *name, struct cmdentry *entry, int act,
322 struct tblentry *cmdp, loc_cmd;
331 /* If name contains a slash, don't use the hash table */
332 if (strchr(name, '/') != NULL) {
333 entry->cmdtype = CMDNORMAL;
340 /* If name is in the table, and not invalidated by cd, we're done */
341 if ((cmdp = cmdlookup(name, 0)) != NULL) {
342 if (cmdp->cmdtype == CMDFUNCTION && act & DO_NOFUNC)
348 /* Check for builtin next */
349 if ((i = find_builtin(name, &spec)) >= 0) {
351 cmdp = cmdlookup(name, 1);
352 if (cmdp->cmdtype == CMDFUNCTION)
354 cmdp->cmdtype = CMDBUILTIN;
355 cmdp->param.index = i;
356 cmdp->special = spec;
361 /* We have to search path. */
365 for (;(fullname = padvance(&path, name)) != NULL; stunalloc(fullname)) {
368 if (strncmp(pathopt, "func", 4) == 0) {
371 continue; /* ignore unimplemented options */
374 if (fullname[0] != '/')
376 if (stat(fullname, &statb) < 0) {
377 if (errno != ENOENT && errno != ENOTDIR)
381 e = EACCES; /* if we fail, this will be the error */
382 if (!S_ISREG(statb.st_mode))
384 if (pathopt) { /* this is a %func directory */
385 readcmdfile(fullname);
386 if ((cmdp = cmdlookup(name, 0)) == NULL || cmdp->cmdtype != CMDFUNCTION)
387 error("%s not defined in %s", name, fullname);
392 if (statb.st_uid == geteuid()) {
393 if ((statb.st_mode & 0100) == 0)
395 } else if (statb.st_gid == getegid()) {
396 if ((statb.st_mode & 010) == 0)
399 if ((statb.st_mode & 01) == 0)
403 TRACE(("searchexec \"%s\" returns \"%s\"\n", name, fullname));
406 cmdp = cmdlookup(name, 1);
407 if (cmdp->cmdtype == CMDFUNCTION)
409 cmdp->cmdtype = CMDNORMAL;
410 cmdp->param.index = idx;
416 if (e == ENOENT || e == ENOTDIR)
417 outfmt(out2, "%s: not found\n", name);
419 outfmt(out2, "%s: %s\n", name, strerror(e));
421 entry->cmdtype = CMDUNKNOWN;
428 entry->cmdtype = cmdp->cmdtype;
429 entry->u = cmdp->param;
430 entry->special = cmdp->special;
436 * Search the table of builtin commands.
440 find_builtin(const char *name, int *special)
442 const struct builtincmd *bp;
444 for (bp = builtincmd ; bp->name ; bp++) {
445 if (*bp->name == *name && equal(bp->name, name)) {
446 *special = bp->special;
456 * Called when a cd is done. If any entry in cmdtable depends on the current
457 * directory, simply clear cmdtable completely.
470 * Called before PATH is changed. The argument is the new value of PATH;
471 * pathval() still returns the old value at this point. Called with
476 changepath(const char *newval __unused)
483 * Clear out command entries. The argument specifies the first entry in
484 * PATH which has changed.
490 struct tblentry **tblp;
491 struct tblentry **pp;
492 struct tblentry *cmdp;
495 for (tblp = cmdtable ; tblp < &cmdtable[CMDTABLESIZE] ; tblp++) {
497 while ((cmdp = *pp) != NULL) {
498 if (cmdp->cmdtype == CMDNORMAL) {
512 * Locate a command in the command hash table. If "add" is nonzero,
513 * add the command to the table if it is not already present. The
514 * variable "lastcmdentry" is set to point to the address of the link
515 * pointing to the entry, so that delete_cmd_entry can delete the
519 static struct tblentry **lastcmdentry;
522 static struct tblentry *
523 cmdlookup(const char *name, int add)
527 struct tblentry *cmdp;
528 struct tblentry **pp;
536 pp = &cmdtable[hashval % CMDTABLESIZE];
537 for (cmdp = *pp ; cmdp ; cmdp = cmdp->next) {
538 if (equal(cmdp->cmdname, name))
542 if (add && cmdp == NULL) {
545 cmdp = *pp = ckmalloc(sizeof (struct tblentry) + len + 1);
547 cmdp->cmdtype = CMDUNKNOWN;
548 memcpy(cmdp->cmdname, name, len + 1);
556 * Delete the command entry returned on the last lookup.
560 delete_cmd_entry(void)
562 struct tblentry *cmdp;
565 cmdp = *lastcmdentry;
566 *lastcmdentry = cmdp->next;
574 * Add a new command entry, replacing any existing command entry for
579 addcmdentry(const char *name, struct cmdentry *entry)
581 struct tblentry *cmdp;
584 cmdp = cmdlookup(name, 1);
585 if (cmdp->cmdtype == CMDFUNCTION) {
586 unreffunc(cmdp->param.func);
588 cmdp->cmdtype = entry->cmdtype;
589 cmdp->param = entry->u;
595 * Define a shell function.
599 defun(const char *name, union node *func)
601 struct cmdentry entry;
604 entry.cmdtype = CMDFUNCTION;
605 entry.u.func = copyfunc(func);
606 addcmdentry(name, &entry);
612 * Delete a function if it exists.
613 * Called with interrupts off.
617 unsetfunc(const char *name)
619 struct tblentry *cmdp;
621 if ((cmdp = cmdlookup(name, 0)) != NULL && cmdp->cmdtype == CMDFUNCTION) {
622 unreffunc(cmdp->param.func);
631 * Check if a function by a certain name exists.
634 isfunc(const char *name)
636 struct tblentry *cmdp;
637 cmdp = cmdlookup(name, 0);
638 return (cmdp != NULL && cmdp->cmdtype == CMDFUNCTION);
643 * Shared code for the following builtin commands:
644 * type, command -v, command -V
648 typecmd_impl(int argc, char **argv, int cmd, const char *path)
650 struct cmdentry entry;
651 struct tblentry *cmdp;
652 const char * const *pp;
657 if (path != pathval())
660 for (i = 1; i < argc; i++) {
661 /* First look at the keywords */
662 for (pp = parsekwd; *pp; pp++)
663 if (**pp == *argv[i] && equal(*pp, argv[i]))
667 if (cmd == TYPECMD_SMALLV)
668 out1fmt("%s\n", argv[i]);
670 out1fmt("%s is a shell keyword\n", argv[i]);
674 /* Then look at the aliases */
675 if ((ap = lookupalias(argv[i], 1)) != NULL) {
676 if (cmd == TYPECMD_SMALLV) {
677 out1fmt("alias %s=", argv[i]);
679 outcslow('\n', out1);
681 out1fmt("%s is an alias for %s\n", argv[i],
686 /* Then check if it is a tracked alias */
687 if ((cmdp = cmdlookup(argv[i], 0)) != NULL) {
688 entry.cmdtype = cmdp->cmdtype;
689 entry.u = cmdp->param;
690 entry.special = cmdp->special;
693 /* Finally use brute force */
694 find_command(argv[i], &entry, 0, path);
697 switch (entry.cmdtype) {
699 if (strchr(argv[i], '/') == NULL) {
700 const char *path2 = path;
702 int j = entry.u.index;
704 name = padvance(&path2, argv[i]);
707 if (cmd == TYPECMD_SMALLV)
708 out1fmt("%s\n", name);
710 out1fmt("%s is%s %s\n", argv[i],
711 (cmdp && cmd == TYPECMD_TYPE) ?
712 " a tracked alias for" : "",
715 if (eaccess(argv[i], X_OK) == 0) {
716 if (cmd == TYPECMD_SMALLV)
717 out1fmt("%s\n", argv[i]);
719 out1fmt("%s is %s\n", argv[i],
722 if (cmd != TYPECMD_SMALLV)
723 outfmt(out2, "%s: %s\n",
724 argv[i], strerror(errno));
731 if (cmd == TYPECMD_SMALLV)
732 out1fmt("%s\n", argv[i]);
734 out1fmt("%s is a shell function\n", argv[i]);
738 if (cmd == TYPECMD_SMALLV)
739 out1fmt("%s\n", argv[i]);
740 else if (entry.special)
741 out1fmt("%s is a special shell builtin\n",
744 out1fmt("%s is a shell builtin\n", argv[i]);
748 if (cmd != TYPECMD_SMALLV)
749 outfmt(out2, "%s: not found\n", argv[i]);
755 if (path != pathval())
762 * Locate and print what a word is...
766 typecmd(int argc, char **argv)
768 if (argc > 2 && strcmp(argv[1], "--") == 0)
770 return typecmd_impl(argc, argv, TYPECMD_TYPE, bltinlookup("PATH", 1));