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.13 2007/01/07 01:14:53 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 /* Avoid longjmp clobbering */
202 if (setjmp(jmploc
.loc
))
206 setvar(name
, val
, flags
);
208 handler
= savehandler
;
213 * Set the value of a variable. The flags argument is tored with the
214 * flags of the variable. If val is NULL, the variable is unset.
218 setvar(const char *name
, const char *val
, int flags
)
233 if (!is_in_name(*cp
)) {
234 if (*cp
== '\0' || *cp
== '=')
242 error("%.*s: bad variable name", namelen
, name
);
243 len
= namelen
+ 2; /* 2 is space for '=' and '\0' */
249 p
= nameeq
= ckmalloc(len
);
251 while (--namelen
>= 0)
257 setvareq(nameeq
, flags
);
261 localevar(const char *s
)
263 static const char * const lnames
[7] = {
264 "ALL", "COLLATE", "CTYPE", "MONETARY",
265 "NUMERIC", "TIME", NULL
267 const char * const *ss
;
271 if (varequal(s
+ 1, "ANG"))
273 if (strncmp(s
+ 1, "C_", 2) != 0)
275 for (ss
= lnames
; *ss
; ss
++)
276 if (varequal(s
+ 3, *ss
))
282 * Same as setvar except that the variable and value are passed in
283 * the first argument as name=value. Since the first argument will
284 * be actually stored in the table, it should not be a string that
289 setvareq(char *s
, int flags
)
291 struct var
*vp
, **vpp
;
297 for (vp
= *vpp
; vp
; vp
= vp
->next
) {
298 if (varequal(s
, vp
->text
)) {
299 if (vp
->flags
& VREADONLY
) {
300 len
= strchr(s
, '=') - s
;
301 error("%.*s: is read only", len
, s
);
305 if (vp
->func
&& (flags
& VNOFUNC
) == 0)
306 (*vp
->func
)(strchr(s
, '=') + 1);
308 if ((vp
->flags
& (VTEXTFIXED
|VSTACK
)) == 0)
311 vp
->flags
&= ~(VTEXTFIXED
|VSTACK
|VUNSET
);
316 * We could roll this to a function, to handle it as
317 * a regular variable function callback, but why bother?
319 if (vp
== &vmpath
|| (vp
== &vmail
&& ! mpathset()))
321 if ((vp
->flags
& VEXPORT
) && localevar(s
)) {
323 error("putenv: cannot set %s", s
);
324 setlocale(LC_ALL
, "");
331 vp
= ckmalloc(sizeof (*vp
));
338 if ((vp
->flags
& VEXPORT
) && localevar(s
)) {
340 error("putenv: cannot set %s", s
);
341 setlocale(LC_ALL
, "");
349 * Process a linked list of variable assignments.
353 listsetvar(struct strlist
*list
)
358 for (lp
= list
; lp
; lp
= lp
->next
) {
359 setvareq(savestr(lp
->text
), 0);
367 * Find the value of a variable. Returns NULL if not set.
371 lookupvar(const char *name
)
375 for (v
= *hashvar(name
) ; v
; v
= v
->next
) {
376 if (varequal(v
->text
, name
)) {
377 if (v
->flags
& VUNSET
)
379 return strchr(v
->text
, '=') + 1;
388 * Search the environment of a builtin command. If the second argument
389 * is nonzero, return the value of a variable even if it hasn't been
394 bltinlookup(const char *name
, int doall
)
399 for (sp
= cmdenviron
; sp
; sp
= sp
->next
) {
400 if (varequal(sp
->text
, name
))
401 return strchr(sp
->text
, '=') + 1;
403 for (v
= *hashvar(name
) ; v
; v
= v
->next
) {
404 if (varequal(v
->text
, name
)) {
405 if ((v
->flags
& VUNSET
)
406 || (!doall
&& (v
->flags
& VEXPORT
) == 0))
408 return strchr(v
->text
, '=') + 1;
417 * Generate a list of exported variables. This routine is used to construct
418 * the third argument to execve when executing a program.
430 for (vpp
= vartab
; vpp
< vartab
+ VTABSIZE
; vpp
++) {
431 for (vp
= *vpp
; vp
; vp
= vp
->next
)
432 if (vp
->flags
& VEXPORT
)
435 ep
= env
= stalloc((nenv
+ 1) * sizeof *env
);
436 for (vpp
= vartab
; vpp
< vartab
+ VTABSIZE
; vpp
++) {
437 for (vp
= *vpp
; vp
; vp
= vp
->next
)
438 if (vp
->flags
& VEXPORT
)
447 * Called when a shell procedure is invoked to clear out nonexported
448 * variables. It is also necessary to reallocate variables of with
449 * VSTACK set since these are currently allocated on the stack.
453 void shprocvar(void);
464 struct var
*vp
, **prev
;
466 for (vpp
= vartab
; vpp
< vartab
+ VTABSIZE
; vpp
++) {
467 for (prev
= vpp
; (vp
= *prev
) != NULL
; ) {
468 if ((vp
->flags
& VEXPORT
) == 0) {
470 if ((vp
->flags
& VTEXTFIXED
) == 0)
472 if ((vp
->flags
& VSTRFIXED
) == 0)
475 if (vp
->flags
& VSTACK
) {
476 vp
->text
= savestr(vp
->text
);
477 vp
->flags
&=~ VSTACK
;
489 * Command to list all variables which are set. Currently this command
490 * is invoked from the set command when the set command is called without
495 showvarscmd(int argc __unused
, char **argv __unused
)
501 for (vpp
= vartab
; vpp
< vartab
+ VTABSIZE
; vpp
++) {
502 for (vp
= *vpp
; vp
; vp
= vp
->next
) {
503 if (vp
->flags
& VUNSET
)
505 for (s
= vp
->text
; *s
!= '='; s
++)
518 * The export and readonly commands.
522 exportcmd(int argc
, char **argv
)
530 int flag
= argv
[0][0] == 'r'? VREADONLY
: VEXPORT
;
533 optreset
= optind
= 1;
536 while ((ch
= getopt(argc
, argv
, "p")) != -1) {
543 error("unknown option: -%c", optopt
);
549 listsetvar(cmdenviron
);
551 while ((name
= *argptr
++) != NULL
) {
552 if ((p
= strchr(name
, '=')) != NULL
) {
556 for (vp
= *vpp
; vp
; vp
= vp
->next
) {
557 if (varequal(vp
->text
, name
)) {
560 if ((vp
->flags
& VEXPORT
) && localevar(vp
->text
)) {
561 if (putenv(vp
->text
) != 0)
562 error("putenv: cannot set %s", vp
->text
);
563 setlocale(LC_ALL
, "");
569 setvar(name
, p
, flag
);
573 for (vpp
= vartab
; vpp
< vartab
+ VTABSIZE
; vpp
++) {
574 for (vp
= *vpp
; vp
; vp
= vp
->next
) {
575 if (vp
->flags
& flag
) {
580 for (p
= vp
->text
; *p
!= '=' ; p
++)
582 if (values
&& !(vp
->flags
& VUNSET
)) {
596 * The "local" command.
600 localcmd(int argc __unused
, char **argv __unused
)
605 error("Not in a function");
606 while ((name
= *argptr
++) != NULL
) {
614 * Make a variable a local variable. When a variable is made local, it's
615 * value and flags are saved in a localvar structure. The saved values
616 * will be restored when the shell function returns. We handle the name
617 * "-" as a special case.
623 struct localvar
*lvp
;
628 lvp
= ckmalloc(sizeof (struct localvar
));
629 if (name
[0] == '-' && name
[1] == '\0') {
630 lvp
->text
= ckmalloc(sizeof optlist
);
631 memcpy(lvp
->text
, optlist
, sizeof optlist
);
635 for (vp
= *vpp
; vp
&& ! varequal(vp
->text
, name
) ; vp
= vp
->next
);
637 if (strchr(name
, '='))
638 setvareq(savestr(name
), VSTRFIXED
);
640 setvar(name
, NULL
, VSTRFIXED
);
641 vp
= *vpp
; /* the new variable */
645 lvp
->text
= vp
->text
;
646 lvp
->flags
= vp
->flags
;
647 vp
->flags
|= VSTRFIXED
|VTEXTFIXED
;
648 if (strchr(name
, '='))
649 setvareq(savestr(name
), 0);
653 lvp
->next
= localvars
;
660 * Called after a function returns.
666 struct localvar
*lvp
;
669 while ((lvp
= localvars
) != NULL
) {
670 localvars
= lvp
->next
;
672 if (vp
== NULL
) { /* $- saved */
673 memcpy(optlist
, lvp
->text
, sizeof optlist
);
675 } else if ((lvp
->flags
& (VUNSET
|VSTRFIXED
)) == VUNSET
) {
678 if ((vp
->flags
& VTEXTFIXED
) == 0)
680 vp
->flags
= lvp
->flags
;
681 vp
->text
= lvp
->text
;
689 setvarcmd(int argc
, char **argv
)
692 return unsetcmd(argc
, argv
);
694 setvar(argv
[1], argv
[2], 0);
696 error("List assignment not implemented");
702 * The unset builtin command. We unset the function before we unset the
703 * variable to allow a function to be unset when there is a readonly variable
704 * with the same name.
708 unsetcmd(int argc __unused
, char **argv __unused
)
716 while ((i
= nextopt("vf")) != '\0') {
722 if (flg_func
== 0 && flg_var
== 0)
725 for (ap
= argptr
; *ap
; ap
++) {
727 ret
|= unsetfunc(*ap
);
729 ret
|= unsetvar(*ap
);
736 * Unset the specified variable.
740 unsetvar(const char *s
)
746 for (vp
= *vpp
; vp
; vpp
= &vp
->next
, vp
= *vpp
) {
747 if (varequal(vp
->text
, s
)) {
748 if (vp
->flags
& VREADONLY
)
751 if (*(strchr(vp
->text
, '=') + 1) != '\0')
752 setvar(s
, nullstr
, 0);
753 if ((vp
->flags
& VEXPORT
) && localevar(vp
->text
)) {
755 setlocale(LC_ALL
, "");
757 vp
->flags
&= ~VEXPORT
;
759 if ((vp
->flags
& VSTRFIXED
) == 0) {
760 if ((vp
->flags
& VTEXTFIXED
) == 0)
775 * Find the appropriate entry in the hash table from the name.
779 hashvar(const char *p
)
781 unsigned int hashval
;
783 hashval
= ((unsigned char) *p
) << 4;
784 while (*p
&& *p
!= '=')
785 hashval
+= (unsigned char) *p
++;
786 return &vartab
[hashval
% VTABSIZE
];
792 * Returns true if the two strings specify the same varable. The first
793 * variable name is terminated by '='; the second may be terminated by
794 * either '=' or '\0'.
798 varequal(const char *p
, const char *q
)
804 if (*p
== '=' && *(q
- 1) == '\0')