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
28 * The unified bootloader passes us a pointer to a preserved copy of
29 * bootstrap/kernel environment variables. We convert them to a
30 * dynamic array of strings later when the VM subsystem is up.
32 * We make these available through the kenv(2) syscall for userland
33 * and through kern_getenv()/freeenv() kern_setenv() kern_unsetenv() testenv() for
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
40 #include <sys/types.h>
41 #include <sys/param.h>
43 #include <sys/queue.h>
45 #include <sys/malloc.h>
46 #include <sys/mutex.h>
48 #include <sys/kernel.h>
49 #include <sys/systm.h>
50 #include <sys/sysent.h>
51 #include <sys/sysproto.h>
52 #include <sys/libkern.h>
55 #include <security/mac/mac_framework.h>
57 static MALLOC_DEFINE(M_KENV, "kenv", "kernel environment");
59 #define KENV_SIZE 512 /* Maximum number of environment strings */
61 /* pointer to the static environment */
65 static char *kernenv_next(char *);
67 /* dynamic environment variables */
72 * No need to protect this with a mutex since SYSINITS are single threaded.
76 #define KENV_CHECK if (!dynamic_kenv) \
77 panic("%s: called before SI_SUB_KMEM", __func__)
89 char *name, *value, *buffer = NULL;
90 size_t len, done, needed, buflen;
93 KASSERT(dynamic_kenv, ("kenv: dynamic_kenv = 0"));
96 if (uap->what == KENV_DUMP) {
98 error = mac_kenv_check_dump(td->td_ucred);
104 if (buflen > KENV_SIZE * (KENV_MNAMELEN + KENV_MVALLEN + 2))
105 buflen = KENV_SIZE * (KENV_MNAMELEN +
107 if (uap->len > 0 && uap->value != NULL)
108 buffer = malloc(buflen, M_TEMP, M_WAITOK|M_ZERO);
109 mtx_lock(&kenv_lock);
110 for (i = 0; kenvp[i] != NULL; i++) {
111 len = strlen(kenvp[i]) + 1;
113 len = min(len, buflen - done);
115 * If called with a NULL or insufficiently large
116 * buffer, just keep computing the required size.
118 if (uap->value != NULL && buffer != NULL && len > 0) {
119 bcopy(kenvp[i], buffer + done, len);
123 mtx_unlock(&kenv_lock);
124 if (buffer != NULL) {
125 error = copyout(buffer, uap->value, done);
126 free(buffer, M_TEMP);
128 td->td_retval[0] = ((done == needed) ? 0 : needed);
134 error = priv_check(td, PRIV_KENV_SET);
140 error = priv_check(td, PRIV_KENV_UNSET);
146 name = malloc(KENV_MNAMELEN + 1, M_TEMP, M_WAITOK);
148 error = copyinstr(uap->name, name, KENV_MNAMELEN + 1, NULL);
155 error = mac_kenv_check_get(td->td_ucred, name);
159 value = kern_getenv(name);
164 len = strlen(value) + 1;
167 error = copyout(value, uap->value, len);
171 td->td_retval[0] = len;
179 if (len > KENV_MVALLEN + 1)
180 len = KENV_MVALLEN + 1;
181 value = malloc(len, M_TEMP, M_WAITOK);
182 error = copyinstr(uap->value, value, len, NULL);
188 error = mac_kenv_check_set(td->td_ucred, name, value);
191 kern_setenv(name, value);
196 error = mac_kenv_check_unset(td->td_ucred, name);
200 error = kern_unsetenv(name);
214 * Populate the initial kernel environment.
216 * This is called very early in MD startup, either to provide a copy of the
217 * environment obtained from a boot loader, or to provide an empty buffer into
218 * which MD code can store an initial environment using kern_setenv() calls.
220 * When a copy of an initial environment is passed in, we start by scanning that
221 * env for overrides to the compiled-in envmode and hintmode variables.
223 * If the global envmode is 1, the environment is initialized from the global
224 * static_env[], regardless of the arguments passed. This implements the env
225 * keyword described in config(5). In this case env_pos is set to env_len,
226 * causing kern_setenv() to return -1 (if len > 0) or panic (if len == 0) until
227 * the dynamic environment is available. The envmode and static_env variables
228 * are defined in env.c which is generated by config(8).
230 * If len is non-zero, the caller is providing an empty buffer. The caller will
231 * subsequently use kern_setenv() to add up to len bytes of initial environment
232 * before the dynamic environment is available.
234 * If len is zero, the caller is providing a pre-loaded buffer containing
235 * environment strings. Additional strings cannot be added until the dynamic
236 * environment is available. The memory pointed to must remain stable at least
237 * until sysinit runs init_dynamic_kenv(). If no initial environment is
238 * available from the boot loader, passing a NULL pointer allows the static_env
239 * to be installed if it is configured.
242 init_static_kenv(char *buf, size_t len)
246 for (cp = buf; cp != NULL && cp[0] != '\0'; cp += strlen(cp) + 1) {
247 if (strcmp(cp, "static_env.disabled=1") == 0)
249 if (strcmp(cp, "static_hints.disabled=1") == 0)
254 kern_envp = static_env;
265 * Setup the dynamic kernel environment.
268 init_dynamic_kenv(void *data __unused)
274 kenvp = malloc((KENV_SIZE + 1) * sizeof(char *), M_KENV,
277 if (kern_envp && *kern_envp != '\0') {
278 for (cp = kern_envp; cp != NULL; cp = cpnext) {
279 cpnext = kernenv_next(cp);
280 len = strlen(cp) + 1;
281 if (len > KENV_MNAMELEN + 1 + KENV_MVALLEN + 1) {
283 "WARNING: too long kenv string, ignoring %s\n",
288 kenvp[i] = malloc(len, M_KENV, M_WAITOK);
289 strcpy(kenvp[i++], cp);
290 memset(cp, 0, strlen(cp));
293 "WARNING: too many kenv strings, ignoring %s\n",
299 mtx_init(&kenv_lock, "kernel environment", NULL, MTX_DEF);
302 SYSINIT(kenv, SI_SUB_KMEM, SI_ORDER_ANY, init_dynamic_kenv, NULL);
308 if (dynamic_kenv && env != NULL) {
309 memset(env, 0, strlen(env));
315 * Internal functions for string lookup.
318 _getenv_dynamic(const char *name, int *idx)
323 mtx_assert(&kenv_lock, MA_OWNED);
325 for (cp = kenvp[0], i = 0; cp != NULL; cp = kenvp[++i]) {
326 if ((strncmp(cp, name, len) == 0) &&
330 return (cp + len + 1);
337 _getenv_static(const char *name)
342 for (cp = kern_envp; cp != NULL; cp = kernenv_next(cp)) {
343 for (ep = cp; (*ep != '=') && (*ep != 0); ep++)
349 if (!strncmp(name, cp, len) && name[len] == 0)
356 * Look up an environment variable by name.
357 * Return a pointer to the string if found.
358 * The pointer has to be freed with freeenv()
362 kern_getenv(const char *name)
364 char buf[KENV_MNAMELEN + 1 + KENV_MVALLEN + 1];
368 if (getenv_string(name, buf, sizeof(buf))) {
369 ret = strdup(buf, M_KENV);
372 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,
376 ret = _getenv_static(name);
381 * Test if an environment variable is defined.
384 testenv(const char *name)
389 mtx_lock(&kenv_lock);
390 cp = _getenv_dynamic(name, NULL);
391 mtx_unlock(&kenv_lock);
393 cp = _getenv_static(name);
400 setenv_static(const char *name, const char *value)
404 if (env_pos >= env_len)
407 /* Check space for x=y and two nuls */
408 len = strlen(name) + strlen(value);
409 if (len + 3 < env_len - env_pos) {
410 len = sprintf(&kern_envp[env_pos], "%s=%s", name, value);
412 kern_envp[env_pos] = '\0';
420 * Set an environment variable by name.
423 kern_setenv(const char *name, const char *value)
425 char *buf, *cp, *oldenv;
426 int namelen, vallen, i;
428 if (dynamic_kenv == 0 && env_len > 0)
429 return (setenv_static(name, value));
433 namelen = strlen(name) + 1;
434 if (namelen > KENV_MNAMELEN + 1)
436 vallen = strlen(value) + 1;
437 if (vallen > KENV_MVALLEN + 1)
439 buf = malloc(namelen + vallen, M_KENV, M_WAITOK);
440 sprintf(buf, "%s=%s", name, value);
442 mtx_lock(&kenv_lock);
443 cp = _getenv_dynamic(name, &i);
447 mtx_unlock(&kenv_lock);
448 free(oldenv, M_KENV);
450 /* We add the option if it wasn't found */
451 for (i = 0; (cp = kenvp[i]) != NULL; i++)
454 /* Bounds checking */
455 if (i < 0 || i >= KENV_SIZE) {
457 mtx_unlock(&kenv_lock);
463 mtx_unlock(&kenv_lock);
469 * Unset an environment variable string.
472 kern_unsetenv(const char *name)
479 mtx_lock(&kenv_lock);
480 cp = _getenv_dynamic(name, &i);
483 for (j = i + 1; kenvp[j] != NULL; j++)
484 kenvp[i++] = kenvp[j];
486 mtx_unlock(&kenv_lock);
487 memset(oldenv, 0, strlen(oldenv));
488 free(oldenv, M_KENV);
491 mtx_unlock(&kenv_lock);
496 * Return a string value from an environment variable.
499 getenv_string(const char *name, char *data, int size)
504 mtx_lock(&kenv_lock);
505 cp = _getenv_dynamic(name, NULL);
507 strlcpy(data, cp, size);
508 mtx_unlock(&kenv_lock);
510 cp = _getenv_static(name);
512 strlcpy(data, cp, size);
518 * Return an integer value from an environment variable.
521 getenv_int(const char *name, int *data)
526 rval = getenv_quad(name, &tmp);
533 * Return an unsigned integer value from an environment variable.
536 getenv_uint(const char *name, unsigned int *data)
541 rval = getenv_quad(name, &tmp);
543 *data = (unsigned int) tmp;
548 * Return an int64_t value from an environment variable.
551 getenv_int64(const char *name, int64_t *data)
556 rval = getenv_quad(name, &tmp);
558 *data = (int64_t) tmp;
563 * Return an uint64_t value from an environment variable.
566 getenv_uint64(const char *name, uint64_t *data)
571 rval = getenv_quad(name, &tmp);
573 *data = (uint64_t) tmp;
578 * Return a long value from an environment variable.
581 getenv_long(const char *name, long *data)
586 rval = getenv_quad(name, &tmp);
593 * Return an unsigned long value from an environment variable.
596 getenv_ulong(const char *name, unsigned long *data)
601 rval = getenv_quad(name, &tmp);
603 *data = (unsigned long) tmp;
608 * Return a quad_t value from an environment variable.
611 getenv_quad(const char *name, quad_t *data)
613 char value[KENV_MNAMELEN + 1 + KENV_MVALLEN + 1];
617 if (!getenv_string(name, value, sizeof(value)))
619 iv = strtoq(value, &vtp, 0);
620 if (vtp == value || (vtp[0] != '\0' && vtp[1] != '\0'))
641 * Find the next entry after the one which (cp) falls within, return a
642 * pointer to its start or NULL if there are no more.
645 kernenv_next(char *cp)
659 tunable_int_init(void *data)
661 struct tunable_int *d = (struct tunable_int *)data;
663 TUNABLE_INT_FETCH(d->path, d->var);
667 tunable_long_init(void *data)
669 struct tunable_long *d = (struct tunable_long *)data;
671 TUNABLE_LONG_FETCH(d->path, d->var);
675 tunable_ulong_init(void *data)
677 struct tunable_ulong *d = (struct tunable_ulong *)data;
679 TUNABLE_ULONG_FETCH(d->path, d->var);
683 tunable_int64_init(void *data)
685 struct tunable_int64 *d = (struct tunable_int64 *)data;
687 TUNABLE_INT64_FETCH(d->path, d->var);
691 tunable_uint64_init(void *data)
693 struct tunable_uint64 *d = (struct tunable_uint64 *)data;
695 TUNABLE_UINT64_FETCH(d->path, d->var);
699 tunable_quad_init(void *data)
701 struct tunable_quad *d = (struct tunable_quad *)data;
703 TUNABLE_QUAD_FETCH(d->path, d->var);
707 tunable_str_init(void *data)
709 struct tunable_str *d = (struct tunable_str *)data;
711 TUNABLE_STR_FETCH(d->path, d->var, d->size);