2 * Copyright (c) 1998 Michael Smith
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/sys/kern/kern_environment.c,v 1.10.2.7 2002/05/07 09:57:16 bde Exp $
30 * The unified bootloader passes us a pointer to a preserved copy of
31 * bootstrap/kernel environment variables. We convert them to a dynamic array
32 * of strings later when the VM subsystem is up.
33 * We make these available using sysctl for both in-kernel and
34 * out-of-kernel consumers, as well as the k{get,set,unset,free,test}env()
35 * functions for in-kernel consumers.
37 * Note that the current sysctl infrastructure doesn't allow
38 * dynamic insertion or traversal through handled spaces. Grr.
40 * TODO: implement a sysctl handler to provide the functionality mentioned
44 #include <sys/param.h>
45 #include <sys/kernel.h>
46 #include <sys/libkern.h>
47 #include <sys/malloc.h>
48 #include <sys/spinlock.h>
49 #include <sys/spinlock2.h>
50 #include <sys/systm.h>
51 #include <sys/sysctl.h>
53 /* exported variables */
54 char *kern_envp
; /* <sys/systm.h> */
59 struct spinlock kenv_dynlock
;
62 MALLOC_DEFINE(M_KENV
, "kenv", "kernel environment dynamic storage");
63 #define KENV_DYNMAXNUM 512
64 #define KENV_MAXNAMELEN 128
65 #define KENV_MAXVALLEN 128
67 /* local prototypes */
68 static char *kenv_getstring_dynamic(const char *name
, int *idx
);
69 static char *kenv_getstring_static(const char *name
);
70 static char *kernenv_next(char *cp
);
73 * Look up a string in the dynamic environment array. Must be called with
77 kenv_getstring_dynamic(const char *name
, int *idx
)
83 /* note: kunsetenv() never leaves NULL holes in the array */
84 for (i
= 0; (cp
= kenv_dynp
[i
]) != NULL
; i
++) {
85 if ((strncmp(cp
, name
, len
) == 0) && (cp
[len
] == '=')) {
95 * Look up a string in the static environment array.
98 kenv_getstring_static(const char *name
)
103 for (cp
= kern_envp
; cp
!= NULL
; cp
= kernenv_next(cp
)) {
104 for (ep
= cp
; (*ep
!= '=') && (*ep
!= 0); ep
++)
110 if (!strncmp(name
, cp
, len
) && name
[len
] == 0)
117 * Look up an environment variable by name.
120 kgetenv(const char *name
)
122 char buf
[KENV_MAXNAMELEN
+ 1 + KENV_MAXVALLEN
+ 1];
126 if (kenv_isdynamic
) {
127 spin_lock(&kenv_dynlock
);
128 cp
= kenv_getstring_dynamic(name
, NULL
);
131 spin_unlock(&kenv_dynlock
);
132 len
= strlen(buf
) + 1;
133 ret
= kmalloc(len
, M_KENV
, M_WAITOK
);
136 spin_unlock(&kenv_dynlock
);
140 ret
= kenv_getstring_static(name
);
145 * Set an environment variable by name.
148 ksetenv(const char *name
, const char *value
)
150 char *cp
, *buf
, *oldenv
;
151 int namelen
, vallen
, i
;
153 if (kenv_isdynamic
) {
154 namelen
= strlen(name
) + 1;
155 vallen
= strlen(value
) + 1;
156 if ((namelen
> KENV_MAXNAMELEN
) || (vallen
> KENV_MAXVALLEN
))
158 buf
= kmalloc(namelen
+ vallen
, M_KENV
, M_WAITOK
);
159 ksprintf(buf
, "%s=%s", name
, value
);
160 spin_lock(&kenv_dynlock
);
161 cp
= kenv_getstring_dynamic(name
, &i
);
163 /* replace existing environment variable */
164 oldenv
= kenv_dynp
[i
];
166 spin_unlock(&kenv_dynlock
);
167 kfree(oldenv
, M_KENV
);
169 /* append new environment variable */
170 for (i
= 0; (cp
= kenv_dynp
[i
]) != NULL
; i
++)
172 /* bounds checking */
173 if (i
< 0 || i
>= (KENV_DYNMAXNUM
- 1)) {
175 spin_unlock(&kenv_dynlock
);
179 kenv_dynp
[i
+ 1] = NULL
;
180 spin_unlock(&kenv_dynlock
);
184 kprintf("WARNING: ksetenv: dynamic array not created yet\n");
190 * Unset an environment variable by name.
193 kunsetenv(const char *name
)
198 if (kenv_isdynamic
) {
199 spin_lock(&kenv_dynlock
);
200 cp
= kenv_getstring_dynamic(name
, &i
);
202 oldenv
= kenv_dynp
[i
];
203 /* move all pointers beyond the unset one down 1 step */
204 for (j
= i
+ 1; kenv_dynp
[j
] != NULL
; j
++)
205 kenv_dynp
[i
++] = kenv_dynp
[j
];
207 spin_unlock(&kenv_dynlock
);
208 kfree(oldenv
, M_KENV
);
211 spin_unlock(&kenv_dynlock
);
214 kprintf("WARNING: kunsetenv: dynamic array not created yet\n");
220 * Free an environment variable that has been copied for a consumer.
230 * Test if an environment variable is defined.
233 ktestenv(const char *name
)
237 if (kenv_isdynamic
) {
238 spin_lock(&kenv_dynlock
);
239 cp
= kenv_getstring_dynamic(name
, NULL
);
240 spin_unlock(&kenv_dynlock
);
242 cp
= kenv_getstring_static(name
);
249 * Return a string value from an environment variable.
252 kgetenv_string(const char *name
, char *data
, int size
)
258 strncpy(data
, tmp
, size
);
267 * Return an integer value from an environment variable.
270 kgetenv_int(const char *name
, int *data
)
275 rval
= kgetenv_quad(name
, &tmp
);
282 * Return a long value from an environment variable.
285 kgetenv_long(const char *name
, long *data
)
290 rval
= kgetenv_quad(name
, &tmp
);
297 * Return an unsigned long value from an environment variable.
300 kgetenv_ulong(const char *name
, unsigned long *data
)
305 rval
= kgetenv_quad(name
, &tmp
);
307 *data
= (unsigned long) tmp
;
312 * Return a quad_t value from an environment variable.
314 * A single character kmgtKMGT extension multiplies the value
315 * by 1024, 1024*1024, etc.
318 kgetenv_quad(const char *name
, quad_t
*data
)
324 if ((value
= kgetenv(name
)) == NULL
)
327 iv
= strtoq(value
, &vtp
, 0);
350 if ((vtp
== value
) || (*vtp
!= '\0')) {
361 * Boottime (static) kernel environment sysctl handler.
364 sysctl_kenv_boot(SYSCTL_HANDLER_ARGS
)
366 int *name
= (int *)arg1
;
367 u_int namelen
= arg2
;
371 if (kern_envp
== NULL
)
381 for (i
= 0; i
< name
[0]; i
++) {
382 cp
= kernenv_next(cp
);
390 error
= SYSCTL_OUT(req
, cp
, strlen(cp
) + 1);
394 SYSCTL_NODE(_kern
, OID_AUTO
, environment
, CTLFLAG_RD
, sysctl_kenv_boot
,
395 "boottime (static) kernel environment space");
398 * Find the next entry after the one which (cp) falls within, return a
399 * pointer to its start or NULL if there are no more.
402 kernenv_next(char *cp
)
415 * TUNABLE_INT init functions.
418 tunable_int_init(void *data
)
420 struct tunable_int
*d
= (struct tunable_int
*)data
;
422 TUNABLE_INT_FETCH(d
->path
, d
->var
);
426 tunable_long_init(void *data
)
428 struct tunable_long
*d
= (struct tunable_long
*)data
;
430 TUNABLE_LONG_FETCH(d
->path
, d
->var
);
434 tunable_ulong_init(void *data
)
436 struct tunable_ulong
*d
= (struct tunable_ulong
*)data
;
438 TUNABLE_ULONG_FETCH(d
->path
, d
->var
);
442 tunable_quad_init(void *data
)
444 struct tunable_quad
*d
= (struct tunable_quad
*)data
;
446 TUNABLE_QUAD_FETCH(d
->path
, d
->var
);
450 tunable_str_init(void *data
)
452 struct tunable_str
*d
= (struct tunable_str
*)data
;
454 TUNABLE_STR_FETCH(d
->path
, d
->var
, d
->size
);
458 * Create the dynamic environment array, and copy in the values from the static
459 * environment as passed by the bootloader.
462 kenv_init(void *dummy
)
467 kenv_dynp
= kmalloc(KENV_DYNMAXNUM
* sizeof(char *), M_KENV
,
470 /* copy the static environment to our dynamic environment */
471 for (i
= 0, cp
= kern_envp
; cp
!= NULL
; cp
= kernenv_next(cp
)) {
472 len
= strlen(cp
) + 1;
473 if (i
< (KENV_DYNMAXNUM
- 1)) {
474 kenv_dynp
[i
] = kmalloc(len
, M_KENV
, M_WAITOK
);
475 strcpy(kenv_dynp
[i
++], cp
);
477 kprintf("WARNING: kenv: exhausted dynamic storage, "
478 "ignoring string %s\n", cp
);
482 spin_init(&kenv_dynlock
);
485 SYSINIT(kenv
, SI_BOOT1_POST
, SI_ORDER_ANY
, kenv_init
, NULL
);