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. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * @(#)var.c 8.3 (Berkeley) 5/4/95
37 * $FreeBSD: head/bin/sh/var.c 245689 2013-01-20 12:44:50Z jilles $
54 #include "nodes.h" /* for other headers */
55 #include "eval.h" /* defines cmdenviron */
67 #include "myhistedit.h"
78 void (*func)(const char *);
95 static struct var voptind;
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,
113 { &vppid, VUNSET, "PPID=",
116 * vps1 depends on uid
118 { &vps2, 0, "PS2=> ",
120 { &vps4, 0, "PS4=+ ",
123 { &vterm, VUNSET, "TERM=",
126 { &voptind, 0, "OPTIND=1",
128 { &vdisvfork, VUNSET, "SH_DISABLE_VFORK=",
134 static struct var *vartab[VTABSIZE];
136 static const char *const locale_names[7] = {
137 "LC_COLLATE", "LC_CTYPE", "LC_MONETARY",
138 "LC_NUMERIC", "LC_TIME", "LC_MESSAGES", NULL
140 static const int locale_categories[7] = {
141 LC_COLLATE, LC_CTYPE, LC_MONETARY, LC_NUMERIC, LC_TIME, LC_MESSAGES, 0
144 static int varequal(const char *, const char *);
145 static struct var *find_var(const char *, struct var ***, int *);
146 static int localevar(const char *);
148 extern char **environ;
151 * This routine initializes the builtin variables and imports the environment.
152 * It is called when the shell is initialized.
159 const struct varinit *ip;
164 for (ip = varinit ; (vp = ip->var) != NULL ; ip++) {
165 if (find_var(ip->text, &vpp, &vp->name_len) != NULL)
169 vp->text = __DECONST(char *, ip->text);
170 vp->flags = ip->flags | VSTRFIXED | VTEXTFIXED;
176 if (find_var("PS1", &vpp, &vps1.name_len) == NULL) {
179 vps1.text = __DECONST(char *, geteuid() ? "PS1=$ " : "PS1=# ");
180 vps1.flags = VSTRFIXED|VTEXTFIXED;
182 if ((vppid.flags & VEXPORT) == 0) {
183 fmtstr(ppid, sizeof(ppid), "%d", (int)getppid());
184 setvarsafe("PPID", ppid, 0);
186 for (envp = environ ; *envp ; envp++) {
187 if (strchr(*envp, '=')) {
188 setvareq(*envp, VEXPORT|VTEXTFIXED);
194 * Safe version of setvar, returns 1 on success 0 on failure.
198 setvarsafe(const char *name, const char *val, int flags)
200 struct jmploc jmploc;
201 struct jmploc *const savehandler = handler;
206 if (setjmp(jmploc.loc))
210 setvar(name, val, flags);
212 handler = savehandler;
218 * Set the value of a variable. The flags argument is stored with the
219 * flags of the variable. If val is NULL, the variable is unset.
223 setvar(const char *name, const char *val, int flags)
237 if (!is_in_name(*p)) {
238 if (*p == '\0' || *p == '=')
246 error("%.*s: bad variable name", namelen, name);
247 len = namelen + 2; /* 2 is space for '=' and '\0' */
253 nameeq = ckmalloc(len);
254 memcpy(nameeq, name, namelen);
255 nameeq[namelen] = '=';
257 scopy(val, nameeq + namelen + 1);
259 nameeq[namelen + 1] = '\0';
260 setvareq(nameeq, flags);
264 localevar(const char *s)
266 const char *const *ss;
270 if (varequal(s + 1, "ANG"))
272 if (strncmp(s + 1, "C_", 2) != 0)
274 if (varequal(s + 3, "ALL"))
276 for (ss = locale_names; *ss ; ss++)
277 if (varequal(s + 3, *ss + 3))
283 * Sets/unsets an environment variable from a pointer that may actually be a
284 * pointer into environ where the string should not be manipulated.
287 change_env(const char *s, int set)
293 if ((eqp = strchr(ss, '=')) != NULL)
295 if (set && eqp != NULL) {
296 if (setenv(ss, eqp + 1, 1) != 0)
297 error("setenv: cannot set %s=%s", ss, eqp + 1);
305 * Same as setvar except that the variable and value are passed in
306 * the first argument as name=value. Since the first argument will
307 * be actually stored in the table, it should not be a string that
312 setvareq(char *s, int flags)
314 struct var *vp, **vpp;
319 if (forcelocal && !(flags & (VNOSET | VNOLOCAL)))
321 vp = find_var(s, &vpp, &nlen);
323 if (vp->flags & VREADONLY)
324 error("%.*s: is read only", vp->name_len, s);
329 if (vp->func && (flags & VNOFUNC) == 0)
330 (*vp->func)(s + vp->name_len + 1);
332 if ((vp->flags & (VTEXTFIXED|VSTACK)) == 0)
335 vp->flags &= ~(VTEXTFIXED|VSTACK|VUNSET);
340 * We could roll this to a function, to handle it as
341 * a regular variable function callback, but why bother?
343 * Note: this assumes iflag is not set to 1 initially.
344 * As part of initvar(), this is called before arguments
347 if ((vp == &vmpath || (vp == &vmail && ! mpathset())) &&
350 if ((vp->flags & VEXPORT) && localevar(s)) {
352 setlocale(LC_ALL, "");
361 vp = ckmalloc(sizeof (*vp));
369 if ((vp->flags & VEXPORT) && localevar(s)) {
371 setlocale(LC_ALL, "");
380 * Process a linked list of variable assignments.
384 listsetvar(struct strlist *list, int flags)
389 for (lp = list ; lp ; lp = lp->next) {
390 setvareq(savestr(lp->text), flags);
398 * Find the value of a variable. Returns NULL if not set.
402 lookupvar(const char *name)
406 v = find_var(name, NULL, NULL);
407 if (v == NULL || v->flags & VUNSET)
409 return v->text + v->name_len + 1;
415 * Search the environment of a builtin command. If the second argument
416 * is nonzero, return the value of a variable even if it hasn't been
421 bltinlookup(const char *name, int doall)
428 for (sp = cmdenviron ; sp ; sp = sp->next) {
429 if (varequal(sp->text, name))
430 result = strchr(sp->text, '=') + 1;
435 v = find_var(name, NULL, NULL);
436 if (v == NULL || v->flags & VUNSET ||
437 (!doall && (v->flags & VEXPORT) == 0))
439 return v->text + v->name_len + 1;
444 * Set up locale for a builtin (LANG/LC_* assignments).
454 for (lp = cmdenviron ; lp ; lp = lp->next) {
455 if (localevar(lp->text)) {
462 loc = bltinlookup("LC_ALL", 0);
465 setlocale(LC_ALL, loc);
470 locdef = bltinlookup("LANG", 0);
471 for (i = 0; locale_names[i] != NULL; i++) {
472 loc = bltinlookup(locale_names[i], 0);
476 setlocale(locale_categories[i], loc);
483 * Undo the effect of bltinlocaleset().
486 bltinunsetlocale(void)
491 for (lp = cmdenviron ; lp ; lp = lp->next) {
492 if (localevar(lp->text)) {
493 setlocale(LC_ALL, "");
502 * Update the localeisutf8 flag.
509 charset = nl_langinfo(CODESET);
510 localeisutf8 = !strcmp(charset, "UTF-8");
517 initial_localeisutf8 = localeisutf8;
521 * Generate a list of exported variables. This routine is used to construct
522 * the third argument to execve when executing a program.
534 for (vpp = vartab ; vpp < vartab + VTABSIZE ; vpp++) {
535 for (vp = *vpp ; vp ; vp = vp->next)
536 if (vp->flags & VEXPORT)
539 ep = env = stalloc((nenv + 1) * sizeof *env);
540 for (vpp = vartab ; vpp < vartab + VTABSIZE ; vpp++) {
541 for (vp = *vpp ; vp ; vp = vp->next)
542 if (vp->flags & VEXPORT)
551 var_compare(const void *a, const void *b)
553 const char *const *sa, *const *sb;
558 * This compares two var=value strings which creates a different
559 * order from what you would probably expect. POSIX is somewhat
560 * ambiguous on what should be sorted exactly.
562 return strcoll(*sa, *sb);
567 * Command to list all variables which are set. This is invoked from the
568 * set command when it is called without any options or operands.
572 showvarscmd(int argc __unused, char **argv __unused)
581 * POSIX requires us to sort the variables.
584 for (vpp = vartab; vpp < vartab + VTABSIZE; vpp++) {
585 for (vp = *vpp; vp; vp = vp->next) {
586 if (!(vp->flags & VUNSET))
592 vars = ckmalloc(n * sizeof(*vars));
594 for (vpp = vartab; vpp < vartab + VTABSIZE; vpp++) {
595 for (vp = *vpp; vp; vp = vp->next) {
596 if (!(vp->flags & VUNSET))
597 vars[i++] = vp->text;
601 qsort(vars, n, sizeof(*vars), var_compare);
602 for (i = 0; i < n; i++) {
604 * Skip improper variable names so the output remains usable as
607 if (!isassignment(vars[i]))
609 s = strchr(vars[i], '=');
611 outbin(vars[i], s - vars[i], out1);
624 * The export and readonly commands.
628 exportcmd(int argc __unused, char **argv)
637 int flag = argv[0][0] == 'r'? VREADONLY : VEXPORT;
641 while ((ch = nextopt("p")) != '\0') {
649 if (values && *argptr != NULL)
650 error("-p requires no arguments");
651 if (*argptr != NULL) {
652 for (ap = argptr; (name = *ap) != NULL; ap++) {
653 if ((p = strchr(name, '=')) != NULL) {
656 vp = find_var(name, NULL, NULL);
659 if ((vp->flags & VEXPORT) && localevar(vp->text)) {
660 change_env(vp->text, 1);
661 setlocale(LC_ALL, "");
667 setvar(name, p, flag);
670 for (vpp = vartab ; vpp < vartab + VTABSIZE ; vpp++) {
671 for (vp = *vpp ; vp ; vp = vp->next) {
672 if (vp->flags & flag) {
675 * Skip improper variable names
676 * so the output remains usable
679 if (!isassignment(vp->text))
684 if (values && !(vp->flags & VUNSET)) {
686 vp->name_len + 1, out1);
690 outbin(vp->text, vp->name_len,
702 * The "local" command.
706 localcmd(int argc __unused, char **argv __unused)
711 error("Not in a function");
712 while ((name = *argptr++) != NULL) {
720 * Make a variable a local variable. When a variable is made local, it's
721 * value and flags are saved in a localvar structure. The saved values
722 * will be restored when the shell function returns. We handle the name
723 * "-" as a special case.
729 struct localvar *lvp;
734 lvp = ckmalloc(sizeof (struct localvar));
735 if (name[0] == '-' && name[1] == '\0') {
736 lvp->text = ckmalloc(sizeof optlist);
737 memcpy(lvp->text, optlist, sizeof optlist);
740 vp = find_var(name, &vpp, NULL);
742 if (strchr(name, '='))
743 setvareq(savestr(name), VSTRFIXED | VNOLOCAL);
745 setvar(name, NULL, VSTRFIXED | VNOLOCAL);
746 vp = *vpp; /* the new variable */
750 lvp->text = vp->text;
751 lvp->flags = vp->flags;
752 vp->flags |= VSTRFIXED|VTEXTFIXED;
753 if (name[vp->name_len] == '=')
754 setvareq(savestr(name), VNOLOCAL);
758 lvp->next = localvars;
765 * Called after a function returns.
771 struct localvar *lvp;
774 while ((lvp = localvars) != NULL) {
775 localvars = lvp->next;
777 if (vp == NULL) { /* $- saved */
778 memcpy(optlist, lvp->text, sizeof optlist);
781 } else if ((lvp->flags & (VUNSET|VSTRFIXED)) == VUNSET) {
784 if ((vp->flags & VTEXTFIXED) == 0)
786 vp->flags = lvp->flags;
787 vp->text = lvp->text;
795 setvarcmd(int argc, char **argv)
798 return unsetcmd(argc, argv);
800 setvar(argv[1], argv[2], 0);
802 error("too many arguments");
808 * The unset builtin command.
812 unsetcmd(int argc __unused, char **argv __unused)
820 while ((i = nextopt("vf")) != '\0') {
826 if (flg_func == 0 && flg_var == 0)
829 for (ap = argptr; *ap ; ap++) {
831 ret |= unsetfunc(*ap);
833 ret |= unsetvar(*ap);
840 * Unset the specified variable.
844 unsetvar(const char *s)
849 vp = find_var(s, &vpp, NULL);
852 if (vp->flags & VREADONLY)
855 if (vp->text[vp->name_len + 1] != '\0')
856 setvar(s, nullstr, 0);
857 if ((vp->flags & VEXPORT) && localevar(vp->text)) {
858 change_env(__DECONST(char *, s), 0);
859 setlocale(LC_ALL, "");
862 vp->flags &= ~VEXPORT;
864 if ((vp->flags & VSTRFIXED) == 0) {
865 if ((vp->flags & VTEXTFIXED) == 0)
877 * Returns true if the two strings specify the same variable. The first
878 * variable name is terminated by '='; the second may be terminated by
879 * either '=' or '\0'.
883 varequal(const char *p, const char *q)
889 if (*p == '=' && *(q - 1) == '\0')
895 * Search for a variable.
896 * 'name' may be terminated by '=' or a NUL.
897 * vppp is set to the pointer to vp, or the list head if vp isn't found
898 * lenp is set to the number of characters in 'name'
902 find_var(const char *name, struct var ***vppp, int *lenp)
904 unsigned int hashval;
906 struct var *vp, **vpp;
907 const char *p = name;
910 while (*p && *p != '=')
911 hashval = 2 * hashval + (unsigned char)*p++;
916 vpp = &vartab[hashval % VTABSIZE];
920 for (vp = *vpp ; vp ; vpp = &vp->next, vp = *vpp) {
921 if (vp->name_len != len)
923 if (memcmp(vp->text, name, len) != 0)