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[] = "@(#)var.c 8.3 (Berkeley) 5/4/95";
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
55 #include "nodes.h" /* for other headers */
56 #include "eval.h" /* defines cmdenviron */
68 #include "myhistedit.h"
79 void (*func)(const char *);
94 static struct var voptind;
97 struct localvar *localvars;
100 static const struct varinit varinit[] = {
102 { &vhistsize, VUNSET, "HISTSIZE=",
105 { &vifs, 0, "IFS= \t\n",
107 { &vmail, VUNSET, "MAIL=",
109 { &vmpath, VUNSET, "MAILPATH=",
111 { &vpath, 0, "PATH=" _PATH_DEFPATH,
114 * vps1 depends on uid
116 { &vps2, 0, "PS2=> ",
118 { &vps4, 0, "PS4=+ ",
121 { &vterm, VUNSET, "TERM=",
124 { &voptind, 0, "OPTIND=1",
126 { &vdisvfork, VUNSET, "SH_DISABLE_VFORK=",
132 static struct var *vartab[VTABSIZE];
134 static const char *const locale_names[7] = {
135 "LC_COLLATE", "LC_CTYPE", "LC_MONETARY",
136 "LC_NUMERIC", "LC_TIME", "LC_MESSAGES", NULL
138 static const int locale_categories[7] = {
139 LC_COLLATE, LC_CTYPE, LC_MONETARY, LC_NUMERIC, LC_TIME, LC_MESSAGES, 0
142 static int varequal(const char *, const char *);
143 static struct var *find_var(const char *, struct var ***, int *);
144 static int localevar(const char *);
145 static void setvareq_const(const char *s, int flags);
147 extern char **environ;
150 * This routine initializes the builtin variables and imports the environment.
151 * It is called when the shell is initialized.
158 const struct varinit *ip;
163 for (ip = varinit ; (vp = ip->var) != NULL ; ip++) {
164 if (find_var(ip->text, &vpp, &vp->name_len) != NULL)
168 vp->text = __DECONST(char *, ip->text);
169 vp->flags = ip->flags | VSTRFIXED | VTEXTFIXED;
175 if (find_var("PS1", &vpp, &vps1.name_len) == NULL) {
178 vps1.text = __DECONST(char *, geteuid() ? "PS1=$ " : "PS1=# ");
179 vps1.flags = VSTRFIXED|VTEXTFIXED;
181 fmtstr(ppid, sizeof(ppid), "%d", (int)getppid());
182 setvarsafe("PPID", ppid, 0);
183 for (envp = environ ; *envp ; envp++) {
184 if (strchr(*envp, '=')) {
185 setvareq(*envp, VEXPORT|VTEXTFIXED);
188 setvareq_const("OPTIND=1", 0);
192 * Safe version of setvar, returns 1 on success 0 on failure.
196 setvarsafe(const char *name, const char *val, int flags)
198 struct jmploc jmploc;
199 struct jmploc *const savehandler = handler;
204 if (setjmp(jmploc.loc))
208 setvar(name, val, flags);
210 handler = savehandler;
216 * Set the value of a variable. The flags argument is stored with the
217 * flags of the variable. If val is NULL, the variable is unset.
221 setvar(const char *name, const char *val, int flags)
236 if (!is_in_name(*p)) {
237 if (*p == '\0' || *p == '=')
245 error("%.*s: bad variable name", (int)namelen, name);
246 len = namelen + 2; /* 2 is space for '=' and '\0' */
251 vallen = strlen(val);
255 nameeq = ckmalloc(len);
256 memcpy(nameeq, name, namelen);
257 nameeq[namelen] = '=';
259 memcpy(nameeq + namelen + 1, val, vallen + 1);
261 nameeq[namelen + 1] = '\0';
262 setvareq(nameeq, flags);
267 localevar(const char *s)
269 const char *const *ss;
273 if (varequal(s + 1, "ANG"))
275 if (strncmp(s + 1, "C_", 2) != 0)
277 if (varequal(s + 3, "ALL"))
279 for (ss = locale_names; *ss ; ss++)
280 if (varequal(s + 3, *ss + 3))
287 * Sets/unsets an environment variable from a pointer that may actually be a
288 * pointer into environ where the string should not be manipulated.
291 change_env(const char *s, int set)
298 if ((eqp = strchr(ss, '=')) != NULL)
300 if (set && eqp != NULL)
301 (void) setenv(ss, eqp + 1, 1);
312 * Same as setvar except that the variable and value are passed in
313 * the first argument as name=value. Since the first argument will
314 * be actually stored in the table, it should not be a string that
319 setvareq(char *s, int flags)
321 struct var *vp, **vpp;
326 if (forcelocal && !(flags & (VNOSET | VNOLOCAL)))
328 vp = find_var(s, &vpp, &nlen);
330 if (vp->flags & VREADONLY) {
331 if ((flags & (VTEXTFIXED|VSTACK)) == 0)
333 error("%.*s: is read only", vp->name_len, s);
335 if (flags & VNOSET) {
336 if ((flags & (VTEXTFIXED|VSTACK)) == 0)
342 if (vp->func && (flags & VNOFUNC) == 0)
343 (*vp->func)(s + vp->name_len + 1);
345 if ((vp->flags & (VTEXTFIXED|VSTACK)) == 0)
348 vp->flags &= ~(VTEXTFIXED|VSTACK|VUNSET);
353 * We could roll this to a function, to handle it as
354 * a regular variable function callback, but why bother?
356 * Note: this assumes iflag is not set to 1 initially.
357 * As part of initvar(), this is called before arguments
360 if ((vp == &vmpath || (vp == &vmail && ! mpathset())) &&
363 if ((vp->flags & VEXPORT) && localevar(s)) {
365 (void) setlocale(LC_ALL, "");
372 if (flags & VNOSET) {
373 if ((flags & (VTEXTFIXED|VSTACK)) == 0)
378 vp = ckmalloc(sizeof (*vp));
385 if ((vp->flags & VEXPORT) && localevar(s)) {
387 (void) setlocale(LC_ALL, "");
395 setvareq_const(const char *s, int flags)
397 setvareq(__DECONST(char *, s), flags | VTEXTFIXED);
402 * Process a linked list of variable assignments.
406 listsetvar(struct strlist *list, int flags)
411 for (lp = list ; lp ; lp = lp->next) {
412 setvareq(savestr(lp->text), flags);
420 * Find the value of a variable. Returns NULL if not set.
424 lookupvar(const char *name)
428 v = find_var(name, NULL, NULL);
429 if (v == NULL || v->flags & VUNSET)
431 return v->text + v->name_len + 1;
437 * Search the environment of a builtin command. If the second argument
438 * is nonzero, return the value of a variable even if it hasn't been
443 bltinlookup(const char *name, int doall)
450 for (sp = cmdenviron ; sp ; sp = sp->next) {
451 if (varequal(sp->text, name))
452 result = strchr(sp->text, '=') + 1;
457 v = find_var(name, NULL, NULL);
458 if (v == NULL || v->flags & VUNSET ||
459 (!doall && (v->flags & VEXPORT) == 0))
461 return v->text + v->name_len + 1;
466 * Set up locale for a builtin (LANG/LC_* assignments).
476 for (lp = cmdenviron ; lp ; lp = lp->next) {
477 if (localevar(lp->text)) {
484 loc = bltinlookup("LC_ALL", 0);
487 setlocale(LC_ALL, loc);
492 locdef = bltinlookup("LANG", 0);
493 for (i = 0; locale_names[i] != NULL; i++) {
494 loc = bltinlookup(locale_names[i], 0);
498 setlocale(locale_categories[i], loc);
505 * Undo the effect of bltinlocaleset().
508 bltinunsetlocale(void)
513 for (lp = cmdenviron ; lp ; lp = lp->next) {
514 if (localevar(lp->text)) {
515 setlocale(LC_ALL, "");
524 * Update the localeisutf8 flag.
531 charset = nl_langinfo(CODESET);
532 localeisutf8 = !strcmp(charset, "UTF-8");
539 initial_localeisutf8 = localeisutf8;
543 * Generate a list of exported variables. This routine is used to construct
544 * the third argument to execve when executing a program.
556 for (vpp = vartab ; vpp < vartab + VTABSIZE ; vpp++) {
557 for (vp = *vpp ; vp ; vp = vp->next)
558 if (vp->flags & VEXPORT)
561 ep = env = stalloc((nenv + 1) * sizeof *env);
562 for (vpp = vartab ; vpp < vartab + VTABSIZE ; vpp++) {
563 for (vp = *vpp ; vp ; vp = vp->next)
564 if (vp->flags & VEXPORT)
573 var_compare(const void *a, const void *b)
575 const char *const *sa, *const *sb;
580 * This compares two var=value strings which creates a different
581 * order from what you would probably expect. POSIX is somewhat
582 * ambiguous on what should be sorted exactly.
584 return strcoll(*sa, *sb);
589 * Command to list all variables which are set. This is invoked from the
590 * set command when it is called without any options or operands.
594 showvarscmd(int argc __unused, char **argv __unused)
603 * POSIX requires us to sort the variables.
606 for (vpp = vartab; vpp < vartab + VTABSIZE; vpp++) {
607 for (vp = *vpp; vp; vp = vp->next) {
608 if (!(vp->flags & VUNSET))
614 vars = ckmalloc(n * sizeof(*vars));
616 for (vpp = vartab; vpp < vartab + VTABSIZE; vpp++) {
617 for (vp = *vpp; vp; vp = vp->next) {
618 if (!(vp->flags & VUNSET))
619 vars[i++] = vp->text;
623 qsort(vars, n, sizeof(*vars), var_compare);
624 for (i = 0; i < n; i++) {
626 * Skip improper variable names so the output remains usable as
629 if (!isassignment(vars[i]))
631 s = strchr(vars[i], '=');
633 outbin(vars[i], s - vars[i], out1);
646 * The export and readonly commands.
650 exportcmd(int argc __unused, char **argv)
659 int flag = argv[0][0] == 'r'? VREADONLY : VEXPORT;
663 while ((ch = nextopt("p")) != '\0') {
671 if (values && *argptr != NULL)
672 error("-p requires no arguments");
673 if (*argptr != NULL) {
674 for (ap = argptr; (name = *ap) != NULL; ap++) {
675 if ((p = strchr(name, '=')) != NULL) {
678 vp = find_var(name, NULL, NULL);
681 if ((vp->flags & VEXPORT) && localevar(vp->text)) {
682 change_env(vp->text, 1);
683 (void) setlocale(LC_ALL, "");
689 setvar(name, p, flag);
692 for (vpp = vartab ; vpp < vartab + VTABSIZE ; vpp++) {
693 for (vp = *vpp ; vp ; vp = vp->next) {
694 if (vp->flags & flag) {
697 * Skip improper variable names
698 * so the output remains usable
701 if (!isassignment(vp->text))
706 if (values && !(vp->flags & VUNSET)) {
708 vp->name_len + 1, out1);
712 outbin(vp->text, vp->name_len,
724 * The "local" command.
728 localcmd(int argc __unused, char **argv __unused)
734 error("Not in a function");
735 while ((name = *argptr++) != NULL) {
743 * Make a variable a local variable. When a variable is made local, it's
744 * value and flags are saved in a localvar structure. The saved values
745 * will be restored when the shell function returns. We handle the name
746 * "-" as a special case.
752 struct localvar *lvp;
757 lvp = ckmalloc(sizeof (struct localvar));
758 if (name[0] == '-' && name[1] == '\0') {
759 lvp->text = ckmalloc(sizeof optlist);
760 memcpy(lvp->text, optlist, sizeof optlist);
763 vp = find_var(name, &vpp, NULL);
765 if (strchr(name, '='))
766 setvareq(savestr(name), VSTRFIXED | VNOLOCAL);
768 setvar(name, NULL, VSTRFIXED | VNOLOCAL);
769 vp = *vpp; /* the new variable */
773 lvp->text = vp->text;
774 lvp->flags = vp->flags;
775 vp->flags |= VSTRFIXED|VTEXTFIXED;
776 if (name[vp->name_len] == '=')
777 setvareq(savestr(name), VNOLOCAL);
781 lvp->next = localvars;
788 * Called after a function returns.
794 struct localvar *lvp;
798 while ((lvp = localvars) != NULL) {
799 localvars = lvp->next;
801 if (vp == NULL) { /* $- saved */
802 memcpy(optlist, lvp->text, sizeof optlist);
805 } else if ((lvp->flags & (VUNSET|VSTRFIXED)) == VUNSET) {
806 (void)unsetvar(vp->text);
808 if ((vp->flags & VTEXTFIXED) == 0)
810 vp->flags = lvp->flags;
811 vp->text = lvp->text;
820 setvarcmd(int argc, char **argv)
823 return unsetcmd(argc, argv);
825 setvar(argv[1], argv[2], 0);
827 error("too many arguments");
833 * The unset builtin command.
837 unsetcmd(int argc __unused, char **argv __unused)
845 while ((i = nextopt("vf")) != '\0') {
851 if (flg_func == 0 && flg_var == 0)
855 for (ap = argptr; *ap ; ap++) {
857 ret |= unsetfunc(*ap);
859 ret |= unsetvar(*ap);
867 * Unset the specified variable.
868 * Called with interrupts off.
872 unsetvar(const char *s)
877 vp = find_var(s, &vpp, NULL);
880 if (vp->flags & VREADONLY)
882 if (vp->text[vp->name_len + 1] != '\0')
884 if ((vp->flags & VEXPORT) && localevar(vp->text)) {
886 setlocale(LC_ALL, "");
889 vp->flags &= ~VEXPORT;
891 if ((vp->flags & VSTRFIXED) == 0) {
892 if ((vp->flags & VTEXTFIXED) == 0)
903 * Returns true if the two strings specify the same variable. The first
904 * variable name is terminated by '='; the second may be terminated by
905 * either '=' or '\0'.
909 varequal(const char *p, const char *q)
915 if (*p == '=' && *(q - 1) == '\0')
921 * Search for a variable.
922 * 'name' may be terminated by '=' or a NUL.
923 * vppp is set to the pointer to vp, or the list head if vp isn't found
924 * lenp is set to the number of characters in 'name'
928 find_var(const char *name, struct var ***vppp, int *lenp)
930 unsigned int hashval;
932 struct var *vp, **vpp;
933 const char *p = name;
936 while (*p && *p != '=')
937 hashval = 2 * hashval + (unsigned char)*p++;
942 vpp = &vartab[hashval % VTABSIZE];
946 for (vp = *vpp ; vp ; vpp = &vp->next, vp = *vpp) {
947 if (vp->name_len != len)
949 if (memcmp(vp->text, name, len) != 0)