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: src/bin/sh/var.c,v 1.15.2.2 2002/08/27 01:36:28 tjr Exp $
38 * $DragonFly: src/bin/sh/var.c,v 1.15 2007/01/14 18:29:58 pavalos Exp $
53 #include "nodes.h" /* for other headers */
54 #include "eval.h" /* defines cmdenviron */
65 #include "myhistedit.h"
76 void (*func
)(const char *);
92 STATIC
struct var voptind
;
94 STATIC
const struct varinit varinit
[] = {
96 { &vhistsize
, VSTRFIXED
|VTEXTFIXED
|VUNSET
, "HISTSIZE=",
99 { &vifs
, VSTRFIXED
|VTEXTFIXED
, "IFS= \t\n",
101 { &vmail
, VSTRFIXED
|VTEXTFIXED
|VUNSET
, "MAIL=",
103 { &vmpath
, VSTRFIXED
|VTEXTFIXED
|VUNSET
, "MAILPATH=",
105 { &vpath
, VSTRFIXED
|VTEXTFIXED
, "PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/pkg/bin:/usr/pkg/sbin",
107 { &vppid
, VSTRFIXED
|VTEXTFIXED
|VUNSET
, "PPID=",
110 * vps1 depends on uid
112 { &vps2
, VSTRFIXED
|VTEXTFIXED
, "PS2=> ",
114 { &vps4
, VSTRFIXED
|VTEXTFIXED
, "PS4=+ ",
116 { &voptind
, VSTRFIXED
|VTEXTFIXED
, "OPTIND=1",
122 STATIC
struct var
*vartab
[VTABSIZE
];
124 STATIC
struct var
**hashvar(const char *);
125 STATIC
int varequal(const char *, const char *);
126 STATIC
int localevar(const char *);
129 * Initialize the variable symbol tables and import the environment.
134 MKINIT
char **environ
;
139 for (envp
= environ
; *envp
; envp
++) {
140 if (strchr(*envp
, '=')) {
141 setvareq(*envp
, VEXPORT
|VTEXTFIXED
);
149 * This routine initializes the builtin variables. It is called when the
150 * shell is initialized and again when a shell procedure is spawned.
157 const struct varinit
*ip
;
161 for (ip
= varinit
; (vp
= ip
->var
) != NULL
; ip
++) {
162 if ((vp
->flags
& VEXPORT
) == 0) {
163 vpp
= hashvar(ip
->text
);
166 vp
->text
= strdup(ip
->text
);
167 vp
->flags
= ip
->flags
;
174 if ((vps1
.flags
& VEXPORT
) == 0) {
175 vpp
= hashvar("PS1=");
178 vps1
.text
= strdup(geteuid() ? "PS1=$ " : "PS1=# ");
179 vps1
.flags
= VSTRFIXED
|VTEXTFIXED
;
181 if ((vppid
.flags
& VEXPORT
) == 0) {
182 fmtstr(ppid
, sizeof(ppid
), "%d", (int)getppid());
183 setvarsafe("PPID", ppid
, 0);
188 * Safe version of setvar, returns 1 on success 0 on failure.
192 setvarsafe(const char *name
, const char *val
, int flags
)
194 struct jmploc jmploc
;
195 struct jmploc
*volatile savehandler
= handler
;
198 if (setjmp(jmploc
.loc
))
202 setvar(name
, val
, flags
);
204 handler
= savehandler
;
209 * Set the value of a variable. The flags argument is stored with the
210 * flags of the variable. If val is NULL, the variable is unset.
214 setvar(const char *name
, const char *val
, int flags
)
229 if (!is_in_name(*cp
)) {
230 if (*cp
== '\0' || *cp
== '=')
238 error("%.*s: bad variable name", namelen
, name
);
239 len
= namelen
+ 2; /* 2 is space for '=' and '\0' */
245 p
= nameeq
= ckmalloc(len
);
247 while (--namelen
>= 0)
253 setvareq(nameeq
, flags
);
257 localevar(const char *s
)
259 static const char * const lnames
[7] = {
260 "ALL", "COLLATE", "CTYPE", "MONETARY",
261 "NUMERIC", "TIME", NULL
263 const char * const *ss
;
267 if (varequal(s
+ 1, "ANG"))
269 if (strncmp(s
+ 1, "C_", 2) != 0)
271 for (ss
= lnames
; *ss
; ss
++)
272 if (varequal(s
+ 3, *ss
))
278 * Same as setvar except that the variable and value are passed in
279 * the first argument as name=value. Since the first argument will
280 * be actually stored in the table, it should not be a string that
285 setvareq(char *s
, int flags
)
287 struct var
*vp
, **vpp
;
293 for (vp
= *vpp
; vp
; vp
= vp
->next
) {
294 if (varequal(s
, vp
->text
)) {
295 if (vp
->flags
& VREADONLY
) {
296 len
= strchr(s
, '=') - s
;
297 error("%.*s: is read only", len
, s
);
301 if (vp
->func
&& (flags
& VNOFUNC
) == 0)
302 (*vp
->func
)(strchr(s
, '=') + 1);
304 if ((vp
->flags
& (VTEXTFIXED
|VSTACK
)) == 0)
307 vp
->flags
&= ~(VTEXTFIXED
|VSTACK
|VUNSET
);
312 * We could roll this to a function, to handle it as
313 * a regular variable function callback, but why bother?
315 if (vp
== &vmpath
|| (vp
== &vmail
&& ! mpathset()))
317 if ((vp
->flags
& VEXPORT
) && localevar(s
)) {
319 error("putenv: cannot set %s", s
);
320 setlocale(LC_ALL
, "");
327 vp
= ckmalloc(sizeof (*vp
));
334 if ((vp
->flags
& VEXPORT
) && localevar(s
)) {
336 error("putenv: cannot set %s", s
);
337 setlocale(LC_ALL
, "");
345 * Process a linked list of variable assignments.
349 listsetvar(struct strlist
*list
)
354 for (lp
= list
; lp
; lp
= lp
->next
) {
355 setvareq(savestr(lp
->text
), 0);
363 * Find the value of a variable. Returns NULL if not set.
367 lookupvar(const char *name
)
371 for (v
= *hashvar(name
) ; v
; v
= v
->next
) {
372 if (varequal(v
->text
, name
)) {
373 if (v
->flags
& VUNSET
)
375 return strchr(v
->text
, '=') + 1;
384 * Search the environment of a builtin command. If the second argument
385 * is nonzero, return the value of a variable even if it hasn't been
390 bltinlookup(const char *name
, int doall
)
395 for (sp
= cmdenviron
; sp
; sp
= sp
->next
) {
396 if (varequal(sp
->text
, name
))
397 return strchr(sp
->text
, '=') + 1;
399 for (v
= *hashvar(name
) ; v
; v
= v
->next
) {
400 if (varequal(v
->text
, name
)) {
401 if ((v
->flags
& VUNSET
)
402 || (!doall
&& (v
->flags
& VEXPORT
) == 0))
404 return strchr(v
->text
, '=') + 1;
413 * Generate a list of exported variables. This routine is used to construct
414 * the third argument to execve when executing a program.
426 for (vpp
= vartab
; vpp
< vartab
+ VTABSIZE
; vpp
++) {
427 for (vp
= *vpp
; vp
; vp
= vp
->next
)
428 if (vp
->flags
& VEXPORT
)
431 ep
= env
= stalloc((nenv
+ 1) * sizeof *env
);
432 for (vpp
= vartab
; vpp
< vartab
+ VTABSIZE
; vpp
++) {
433 for (vp
= *vpp
; vp
; vp
= vp
->next
)
434 if (vp
->flags
& VEXPORT
)
443 * Called when a shell procedure is invoked to clear out nonexported
444 * variables. It is also necessary to reallocate variables of with
445 * VSTACK set since these are currently allocated on the stack.
449 void shprocvar(void);
460 struct var
*vp
, **prev
;
462 for (vpp
= vartab
; vpp
< vartab
+ VTABSIZE
; vpp
++) {
463 for (prev
= vpp
; (vp
= *prev
) != NULL
; ) {
464 if ((vp
->flags
& VEXPORT
) == 0) {
466 if ((vp
->flags
& VTEXTFIXED
) == 0)
468 if ((vp
->flags
& VSTRFIXED
) == 0)
471 if (vp
->flags
& VSTACK
) {
472 vp
->text
= savestr(vp
->text
);
473 vp
->flags
&=~ VSTACK
;
484 var_compare(const void *a
, const void *b
)
486 const char *const *sa
, *const *sb
;
491 * This compares two var=value strings which creates a different
492 * order from what you would probably expect. POSIX is somewhat
493 * ambiguous on what should be sorted exactly.
495 return strcoll(*sa
, *sb
);
500 * Command to list all variables which are set. Currently this command
501 * is invoked from the set command when the set command is called without
506 showvarscmd(int argc __unused
, char **argv __unused
)
515 * POSIX requires us to sort the variables.
518 for (vpp
= vartab
; vpp
< vartab
+ VTABSIZE
; vpp
++) {
519 for (vp
= *vpp
; vp
; vp
= vp
->next
) {
520 if (!(vp
->flags
& VUNSET
))
526 vars
= ckmalloc(n
* sizeof(*vars
));
528 for (vpp
= vartab
; vpp
< vartab
+ VTABSIZE
; vpp
++) {
529 for (vp
= *vpp
; vp
; vp
= vp
->next
) {
530 if (!(vp
->flags
& VUNSET
))
531 vars
[i
++] = vp
->text
;
535 qsort(vars
, n
, sizeof(*vars
), var_compare
);
536 for (i
= 0; i
< n
; i
++) {
537 for (s
= vars
[i
]; *s
!= '='; s
++)
552 * The export and readonly commands.
556 exportcmd(int argc
, char **argv
)
564 int flag
= argv
[0][0] == 'r'? VREADONLY
: VEXPORT
;
567 optreset
= optind
= 1;
570 while ((ch
= getopt(argc
, argv
, "p")) != -1) {
577 error("unknown option: -%c", optopt
);
583 if (values
&& argc
!= 0)
584 error("-p requires no arguments");
585 listsetvar(cmdenviron
);
587 while ((name
= *argv
++) != NULL
) {
588 if ((p
= strchr(name
, '=')) != NULL
) {
592 for (vp
= *vpp
; vp
; vp
= vp
->next
) {
593 if (varequal(vp
->text
, name
)) {
596 if ((vp
->flags
& VEXPORT
) && localevar(vp
->text
)) {
597 if (putenv(vp
->text
) != 0)
598 error("putenv: cannot set %s", vp
->text
);
599 setlocale(LC_ALL
, "");
605 setvar(name
, p
, flag
);
609 for (vpp
= vartab
; vpp
< vartab
+ VTABSIZE
; vpp
++) {
610 for (vp
= *vpp
; vp
; vp
= vp
->next
) {
611 if (vp
->flags
& flag
) {
616 for (p
= vp
->text
; *p
!= '=' ; p
++)
618 if (values
&& !(vp
->flags
& VUNSET
)) {
632 * The "local" command.
636 localcmd(int argc __unused
, char **argv __unused
)
641 error("Not in a function");
642 while ((name
= *argptr
++) != NULL
) {
650 * Make a variable a local variable. When a variable is made local, it's
651 * value and flags are saved in a localvar structure. The saved values
652 * will be restored when the shell function returns. We handle the name
653 * "-" as a special case.
659 struct localvar
*lvp
;
664 lvp
= ckmalloc(sizeof (struct localvar
));
665 if (name
[0] == '-' && name
[1] == '\0') {
666 lvp
->text
= ckmalloc(sizeof optlist
);
667 memcpy(lvp
->text
, optlist
, sizeof optlist
);
671 for (vp
= *vpp
; vp
&& ! varequal(vp
->text
, name
) ; vp
= vp
->next
);
673 if (strchr(name
, '='))
674 setvareq(savestr(name
), VSTRFIXED
);
676 setvar(name
, NULL
, VSTRFIXED
);
677 vp
= *vpp
; /* the new variable */
681 lvp
->text
= vp
->text
;
682 lvp
->flags
= vp
->flags
;
683 vp
->flags
|= VSTRFIXED
|VTEXTFIXED
;
684 if (strchr(name
, '='))
685 setvareq(savestr(name
), 0);
689 lvp
->next
= localvars
;
696 * Called after a function returns.
702 struct localvar
*lvp
;
705 while ((lvp
= localvars
) != NULL
) {
706 localvars
= lvp
->next
;
708 if (vp
== NULL
) { /* $- saved */
709 memcpy(optlist
, lvp
->text
, sizeof optlist
);
711 } else if ((lvp
->flags
& (VUNSET
|VSTRFIXED
)) == VUNSET
) {
714 if ((vp
->flags
& VTEXTFIXED
) == 0)
716 vp
->flags
= lvp
->flags
;
717 vp
->text
= lvp
->text
;
725 setvarcmd(int argc
, char **argv
)
728 return unsetcmd(argc
, argv
);
730 setvar(argv
[1], argv
[2], 0);
732 error("List assignment not implemented");
738 * The unset builtin command. We unset the function before we unset the
739 * variable to allow a function to be unset when there is a readonly variable
740 * with the same name.
744 unsetcmd(int argc __unused
, char **argv __unused
)
752 while ((i
= nextopt("vf")) != '\0') {
758 if (flg_func
== 0 && flg_var
== 0)
761 for (ap
= argptr
; *ap
; ap
++) {
763 ret
|= unsetfunc(*ap
);
765 ret
|= unsetvar(*ap
);
772 * Unset the specified variable.
776 unsetvar(const char *s
)
782 for (vp
= *vpp
; vp
; vpp
= &vp
->next
, vp
= *vpp
) {
783 if (varequal(vp
->text
, s
)) {
784 if (vp
->flags
& VREADONLY
)
787 if (*(strchr(vp
->text
, '=') + 1) != '\0')
788 setvar(s
, nullstr
, 0);
789 if ((vp
->flags
& VEXPORT
) && localevar(vp
->text
)) {
791 setlocale(LC_ALL
, "");
793 vp
->flags
&= ~VEXPORT
;
795 if ((vp
->flags
& VSTRFIXED
) == 0) {
796 if ((vp
->flags
& VTEXTFIXED
) == 0)
811 * Find the appropriate entry in the hash table from the name.
815 hashvar(const char *p
)
817 unsigned int hashval
;
819 hashval
= ((unsigned char) *p
) << 4;
820 while (*p
&& *p
!= '=')
821 hashval
+= (unsigned char) *p
++;
822 return &vartab
[hashval
% VTABSIZE
];
828 * Returns true if the two strings specify the same varable. The first
829 * variable name is terminated by '='; the second may be terminated by
830 * either '=' or '\0'.
834 varequal(const char *p
, const char *q
)
840 if (*p
== '=' && *(q
- 1) == '\0')