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 * 4. 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.
80 #define CMDTABLESIZE 31 /* should be prime */
81 #define ARB 1 /* actual size determined at run time */
86 struct tblentry *next; /* next entry in hash chain */
87 union param param; /* definition of builtin function */
88 int special; /* flag for special builtin commands */
89 short cmdtype; /* index identifying command */
90 char rehash; /* if set, cd done since entry created */
91 char cmdname[ARB]; /* name of command */
95 static struct tblentry *cmdtable[CMDTABLESIZE];
96 int exerrno = 0; /* Last exec error */
99 static void tryexec(char *, char **, char **);
100 static void printentry(struct tblentry *, int);
101 static struct tblentry *cmdlookup(const char *, int);
102 static void delete_cmd_entry(void);
103 static void addcmdentry(const char *, struct cmdentry *);
108 * Exec a program. Never returns. If you change this routine, you may
109 * have to change the find_command routine as well.
111 * The argv array may be changed and element argv[-1] should be writable.
115 shellexec(char **argv, char **envp, const char *path, int idx)
120 if (strchr(argv[0], '/') != NULL) {
121 tryexec(argv[0], argv, envp);
125 while ((cmdname = padvance(&path, argv[0])) != NULL) {
126 if (--idx < 0 && pathopt == NULL) {
127 tryexec(cmdname, argv, envp);
128 if (errno != ENOENT && errno != ENOTDIR)
137 /* Map to POSIX errors */
138 if (e == ENOENT || e == ENOTDIR) {
140 exerror(EXEXEC, "%s: not found", argv[0]);
143 exerror(EXEXEC, "%s: %s", argv[0], strerror(e));
149 tryexec(char *cmd, char **argv, char **envp)
155 execve(cmd, argv, envp);
159 in = open(cmd, O_RDONLY | O_NONBLOCK);
161 n = pread(in, buf, sizeof buf, 0);
163 if (n > 0 && memchr(buf, '\0', n) != NULL) {
169 *--argv = _PATH_BSHELL;
170 execve(_PATH_BSHELL, argv, envp);
176 * Do a path search. The variable path (passed by reference) should be
177 * set to the start of the path before the first call; padvance will update
178 * this value as it proceeds. Successive calls to padvance will return
179 * the possible path expansions in sequence. If an option (indicated by
180 * a percent sign) appears in the path entry then the global variable
181 * pathopt will be set to point to it; otherwise pathopt will be set to
188 padvance(const char **path, const char *name)
190 const char *p, *start;
197 for (p = start; *p && *p != ':' && *p != '%'; p++)
199 len = p - start + strlen(name) + 2; /* "2" is for '/' and '\0' */
201 CHECKSTRSPACE(len, q);
203 memcpy(q, start, p - start);
211 while (*p && *p != ':') p++;
222 /*** Command hashing code ***/
226 hashcmd(int argc __unused, char **argv __unused)
228 struct tblentry **pp;
229 struct tblentry *cmdp;
232 struct cmdentry entry;
236 while ((c = nextopt("rv")) != '\0') {
239 } else if (c == 'v') {
243 if (*argptr == NULL) {
244 for (pp = cmdtable ; pp < &cmdtable[CMDTABLESIZE] ; pp++) {
245 for (cmdp = *pp ; cmdp ; cmdp = cmdp->next) {
246 if (cmdp->cmdtype == CMDNORMAL)
247 printentry(cmdp, verbose);
252 while ((name = *argptr) != NULL) {
253 if ((cmdp = cmdlookup(name, 0)) != NULL
254 && cmdp->cmdtype == CMDNORMAL)
256 find_command(name, &entry, DO_ERR, pathval());
258 if (entry.cmdtype != CMDUNKNOWN) { /* if no error msg */
259 cmdp = cmdlookup(name, 0);
261 printentry(cmdp, verbose);
263 outfmt(out2, "%s: not found\n", name);
274 printentry(struct tblentry *cmdp, int verbose)
280 if (cmdp->cmdtype == CMDNORMAL) {
281 idx = cmdp->param.index;
284 name = padvance(&path, cmdp->cmdname);
286 } while (--idx >= 0);
288 } else if (cmdp->cmdtype == CMDBUILTIN) {
289 out1fmt("builtin %s", cmdp->cmdname);
290 } else if (cmdp->cmdtype == CMDFUNCTION) {
291 out1fmt("function %s", cmdp->cmdname);
294 name = commandtext(getfuncnode(cmdp->param.func));
302 error("internal error: cmdtype %d", cmdp->cmdtype);
313 * Resolve a command name. If you change this routine, you may have to
314 * change the shellexec routine as well.
318 find_command(const char *name, struct cmdentry *entry, int act,
321 struct tblentry *cmdp, loc_cmd;
330 /* If name contains a slash, don't use the hash table */
331 if (strchr(name, '/') != NULL) {
332 entry->cmdtype = CMDNORMAL;
337 /* If name is in the table, and not invalidated by cd, we're done */
338 if ((cmdp = cmdlookup(name, 0)) != NULL && cmdp->rehash == 0) {
339 if (cmdp->cmdtype == CMDFUNCTION && act & DO_NOFUNC)
345 /* Check for builtin next */
346 if ((i = find_builtin(name, &spec)) >= 0) {
348 cmdp = cmdlookup(name, 1);
349 if (cmdp->cmdtype == CMDFUNCTION)
351 cmdp->cmdtype = CMDBUILTIN;
352 cmdp->param.index = i;
353 cmdp->special = spec;
358 /* We have to search path. */
359 prev = -1; /* where to start */
360 if (cmdp) { /* doing a rehash */
361 if (cmdp->cmdtype == CMDBUILTIN)
364 prev = cmdp->param.index;
370 while ((fullname = padvance(&path, name)) != NULL) {
374 if (prefix("func", pathopt)) {
377 goto loop; /* ignore unimplemented options */
380 /* if rehash, don't redo absolute path names */
381 if (fullname[0] == '/' && idx <= prev) {
384 TRACE(("searchexec \"%s\": no change\n", name));
387 if (stat(fullname, &statb) < 0) {
388 if (errno != ENOENT && errno != ENOTDIR)
392 e = EACCES; /* if we fail, this will be the error */
393 if (!S_ISREG(statb.st_mode))
395 if (pathopt) { /* this is a %func directory */
396 stalloc(strlen(fullname) + 1);
397 readcmdfile(fullname);
398 if ((cmdp = cmdlookup(name, 0)) == NULL || cmdp->cmdtype != CMDFUNCTION)
399 error("%s not defined in %s", name, fullname);
404 if (statb.st_uid == geteuid()) {
405 if ((statb.st_mode & 0100) == 0)
407 } else if (statb.st_gid == getegid()) {
408 if ((statb.st_mode & 010) == 0)
411 if ((statb.st_mode & 01) == 0)
415 TRACE(("searchexec \"%s\" returns \"%s\"\n", name, fullname));
417 cmdp = cmdlookup(name, 1);
418 if (cmdp->cmdtype == CMDFUNCTION)
420 cmdp->cmdtype = CMDNORMAL;
421 cmdp->param.index = idx;
426 /* We failed. If there was an entry for this command, delete it */
427 if (cmdp && cmdp->cmdtype != CMDFUNCTION)
430 if (e == ENOENT || e == ENOTDIR)
431 outfmt(out2, "%s: not found\n", name);
433 outfmt(out2, "%s: %s\n", name, strerror(e));
435 entry->cmdtype = CMDUNKNOWN;
441 entry->cmdtype = cmdp->cmdtype;
442 entry->u = cmdp->param;
443 entry->special = cmdp->special;
449 * Search the table of builtin commands.
453 find_builtin(const char *name, int *special)
455 const struct builtincmd *bp;
457 for (bp = builtincmd ; bp->name ; bp++) {
458 if (*bp->name == *name && equal(bp->name, name)) {
459 *special = bp->special;
469 * Called when a cd is done. Marks all commands so the next time they
470 * are executed they will be rehashed.
476 struct tblentry **pp;
477 struct tblentry *cmdp;
479 for (pp = cmdtable ; pp < &cmdtable[CMDTABLESIZE] ; pp++) {
480 for (cmdp = *pp ; cmdp ; cmdp = cmdp->next) {
481 if (cmdp->cmdtype == CMDNORMAL)
490 * Called before PATH is changed. The argument is the new value of PATH;
491 * pathval() still returns the old value at this point. Called with
496 changepath(const char *newval)
503 * Clear out command entries. The argument specifies the first entry in
504 * PATH which has changed.
510 struct tblentry **tblp;
511 struct tblentry **pp;
512 struct tblentry *cmdp;
515 for (tblp = cmdtable ; tblp < &cmdtable[CMDTABLESIZE] ; tblp++) {
517 while ((cmdp = *pp) != NULL) {
518 if (cmdp->cmdtype == CMDNORMAL) {
531 * Locate a command in the command hash table. If "add" is nonzero,
532 * add the command to the table if it is not already present. The
533 * variable "lastcmdentry" is set to point to the address of the link
534 * pointing to the entry, so that delete_cmd_entry can delete the
538 static struct tblentry **lastcmdentry;
541 static struct tblentry *
542 cmdlookup(const char *name, int add)
546 struct tblentry *cmdp;
547 struct tblentry **pp;
554 pp = &cmdtable[hashval % CMDTABLESIZE];
555 for (cmdp = *pp ; cmdp ; cmdp = cmdp->next) {
556 if (equal(cmdp->cmdname, name))
560 if (add && cmdp == NULL) {
562 cmdp = *pp = ckmalloc(sizeof (struct tblentry) - ARB
565 cmdp->cmdtype = CMDUNKNOWN;
567 strcpy(cmdp->cmdname, name);
575 * Delete the command entry returned on the last lookup.
579 delete_cmd_entry(void)
581 struct tblentry *cmdp;
584 cmdp = *lastcmdentry;
585 *lastcmdentry = cmdp->next;
593 * Add a new command entry, replacing any existing command entry for
598 addcmdentry(const char *name, struct cmdentry *entry)
600 struct tblentry *cmdp;
603 cmdp = cmdlookup(name, 1);
604 if (cmdp->cmdtype == CMDFUNCTION) {
605 unreffunc(cmdp->param.func);
607 cmdp->cmdtype = entry->cmdtype;
608 cmdp->param = entry->u;
614 * Define a shell function.
618 defun(const char *name, union node *func)
620 struct cmdentry entry;
623 entry.cmdtype = CMDFUNCTION;
624 entry.u.func = copyfunc(func);
625 addcmdentry(name, &entry);
631 * Delete a function if it exists.
632 * Called with interrupts off.
636 unsetfunc(const char *name)
638 struct tblentry *cmdp;
640 if ((cmdp = cmdlookup(name, 0)) != NULL && cmdp->cmdtype == CMDFUNCTION) {
641 unreffunc(cmdp->param.func);
650 * Check if a function by a certain name exists.
653 isfunc(const char *name)
655 struct tblentry *cmdp;
656 cmdp = cmdlookup(name, 0);
657 return (cmdp != NULL && cmdp->cmdtype == CMDFUNCTION);
662 * Shared code for the following builtin commands:
663 * type, command -v, command -V
667 typecmd_impl(int argc, char **argv, int cmd, const char *path)
669 struct cmdentry entry;
670 struct tblentry *cmdp;
671 const char *const *pp;
676 if (path != pathval())
679 for (i = 1; i < argc; i++) {
680 /* First look at the keywords */
681 for (pp = parsekwd; *pp; pp++)
682 if (**pp == *argv[i] && equal(*pp, argv[i]))
686 if (cmd == TYPECMD_SMALLV)
687 out1fmt("%s\n", argv[i]);
689 out1fmt("%s is a shell keyword\n", argv[i]);
693 /* Then look at the aliases */
694 if ((ap = lookupalias(argv[i], 1)) != NULL) {
695 if (cmd == TYPECMD_SMALLV)
696 out1fmt("alias %s='%s'\n", argv[i], ap->val);
698 out1fmt("%s is an alias for %s\n", argv[i],
703 /* Then check if it is a tracked alias */
704 if ((cmdp = cmdlookup(argv[i], 0)) != NULL) {
705 entry.cmdtype = cmdp->cmdtype;
706 entry.u = cmdp->param;
707 entry.special = cmdp->special;
710 /* Finally use brute force */
711 find_command(argv[i], &entry, 0, path);
714 switch (entry.cmdtype) {
716 if (strchr(argv[i], '/') == NULL) {
717 const char *path2 = path;
719 int j = entry.u.index;
721 name = padvance(&path2, argv[i]);
724 if (cmd == TYPECMD_SMALLV)
725 out1fmt("%s\n", name);
727 out1fmt("%s is%s %s\n", argv[i],
728 (cmdp && cmd == TYPECMD_TYPE) ?
729 " a tracked alias for" : "",
732 if (eaccess(argv[i], X_OK) == 0) {
733 if (cmd == TYPECMD_SMALLV)
734 out1fmt("%s\n", argv[i]);
736 out1fmt("%s is %s\n", argv[i],
739 if (cmd != TYPECMD_SMALLV)
740 outfmt(out2, "%s: %s\n",
741 argv[i], strerror(errno));
748 if (cmd == TYPECMD_SMALLV)
749 out1fmt("%s\n", argv[i]);
751 out1fmt("%s is a shell function\n", argv[i]);
755 if (cmd == TYPECMD_SMALLV)
756 out1fmt("%s\n", argv[i]);
757 else if (entry.special)
758 out1fmt("%s is a special shell builtin\n",
761 out1fmt("%s is a shell builtin\n", argv[i]);
765 if (cmd != TYPECMD_SMALLV)
766 outfmt(out2, "%s: not found\n", argv[i]);
772 if (path != pathval())
779 * Locate and print what a word is...
783 typecmd(int argc, char **argv)
785 return typecmd_impl(argc, argv, TYPECMD_TYPE, bltinlookup("PATH", 1));