2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 1998 Michael Smith
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * The unified bootloader passes us a pointer to a preserved copy of
31 * bootstrap/kernel environment variables. We convert them to a
32 * dynamic array of strings later when the VM subsystem is up.
34 * We make these available through the kenv(2) syscall for userland
35 * and through kern_getenv()/freeenv() kern_setenv() kern_unsetenv() testenv() for
39 #include <sys/param.h>
40 #include <sys/eventhandler.h>
41 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/libkern.h>
45 #include <sys/limits.h>
47 #include <sys/malloc.h>
48 #include <sys/mutex.h>
51 #include <sys/queue.h>
52 #include <sys/sysent.h>
53 #include <sys/sysproto.h>
55 #include <security/mac/mac_framework.h>
59 static char *_getenv_dynamic_locked(const char *name, int *idx);
60 static char *_getenv_dynamic(const char *name, int *idx);
62 static char *kenv_acquire(const char *name);
63 static void kenv_release(const char *buf);
65 static MALLOC_DEFINE(M_KENV, "kenv", "kernel environment");
67 #define KENV_SIZE 512 /* Maximum number of environment strings */
69 static uma_zone_t kenv_zone;
70 static int kenv_mvallen = KENV_MVALLEN;
72 /* pointer to the config-generated static environment */
75 /* pointer to the md-static environment */
77 static int md_env_len;
78 static int md_env_pos;
80 static char *kernenv_next(char *);
82 /* dynamic environment variables */
87 * No need to protect this with a mutex since SYSINITS are single threaded.
91 #define KENV_CHECK if (!dynamic_kenv) \
92 panic("%s: called before SI_SUB_KMEM", __func__)
95 kenv_dump(struct thread *td, char **envp, int what, char *value, int len)
98 size_t done, needed, buflen;
105 MPASS(what == KENV_DUMP || what == KENV_DUMP_LOADER ||
106 what == KENV_DUMP_STATIC);
109 * For non-dynamic kernel environment, we pass in either md_envp or
110 * kern_envp and we must traverse with kernenv_next(). This shuffling
111 * of pointers simplifies the below loop by only differing in how envp
114 if (what != KENV_DUMP) {
120 if (buflen > KENV_SIZE * (KENV_MNAMELEN + kenv_mvallen + 2))
121 buflen = KENV_SIZE * (KENV_MNAMELEN +
123 if (len > 0 && value != NULL)
124 buffer = malloc(buflen, M_TEMP, M_WAITOK|M_ZERO);
126 /* Only take the lock for the dynamic kenv. */
127 if (what == KENV_DUMP)
128 mtx_lock(&kenv_lock);
129 while (*envp != NULL) {
130 len = strlen(*envp) + 1;
132 len = min(len, buflen - done);
134 * If called with a NULL or insufficiently large
135 * buffer, just keep computing the required size.
137 if (value != NULL && buffer != NULL && len > 0) {
138 bcopy(*envp, buffer + done, len);
142 /* Advance the pointer depending on the kenv format. */
143 if (what == KENV_DUMP)
146 senv = kernenv_next(senv);
148 if (what == KENV_DUMP)
149 mtx_unlock(&kenv_lock);
150 if (buffer != NULL) {
151 error = copyout(buffer, value, done);
152 free(buffer, M_TEMP);
154 td->td_retval[0] = ((done == needed) ? 0 : needed);
159 sys_kenv(struct thread *td, struct kenv_args *uap)
165 KASSERT(dynamic_kenv, ("kenv: dynamic_kenv = false"));
172 error = mac_kenv_check_dump(td->td_ucred);
176 return (kenv_dump(td, kenvp, uap->what, uap->value, uap->len));
177 case KENV_DUMP_LOADER:
178 case KENV_DUMP_STATIC:
180 error = mac_kenv_check_dump(td->td_ucred);
184 #ifdef PRESERVE_EARLY_KENV
185 return (kenv_dump(td,
186 uap->what == KENV_DUMP_LOADER ? (char **)md_envp :
187 (char **)kern_envp, uap->what, uap->value, uap->len));
192 error = priv_check(td, PRIV_KENV_SET);
198 error = priv_check(td, PRIV_KENV_UNSET);
204 name = malloc(KENV_MNAMELEN + 1, M_TEMP, M_WAITOK);
206 error = copyinstr(uap->name, name, KENV_MNAMELEN + 1, NULL);
213 error = mac_kenv_check_get(td->td_ucred, name);
217 value = kern_getenv(name);
222 len = strlen(value) + 1;
225 error = copyout(value, uap->value, len);
229 td->td_retval[0] = len;
237 if (len > kenv_mvallen + 1)
238 len = kenv_mvallen + 1;
239 value = malloc(len, M_TEMP, M_WAITOK);
240 error = copyinstr(uap->value, value, len, NULL);
246 error = mac_kenv_check_set(td->td_ucred, name, value);
249 kern_setenv(name, value);
254 error = mac_kenv_check_unset(td->td_ucred, name);
258 error = kern_unsetenv(name);
272 * Populate the initial kernel environment.
274 * This is called very early in MD startup, either to provide a copy of the
275 * environment obtained from a boot loader, or to provide an empty buffer into
276 * which MD code can store an initial environment using kern_setenv() calls.
278 * kern_envp is set to the static_env generated by config(8). This implements
279 * the env keyword described in config(5).
281 * If len is non-zero, the caller is providing an empty buffer. The caller will
282 * subsequently use kern_setenv() to add up to len bytes of initial environment
283 * before the dynamic environment is available.
285 * If len is zero, the caller is providing a pre-loaded buffer containing
286 * environment strings. Additional strings cannot be added until the dynamic
287 * environment is available. The memory pointed to must remain stable at least
288 * until sysinit runs init_dynamic_kenv() and preferably until after SI_SUB_KMEM
289 * is finished so that subr_hints routines may continue to use it until the
290 * environments have been fully merged at the end of the pass. If no initial
291 * environment is available from the boot loader, passing a NULL pointer allows
292 * the static_env to be installed if it is configured. In this case, any call
293 * to kern_setenv() prior to the setup of the dynamic environment will result in
297 init_static_kenv(char *buf, size_t len)
300 KASSERT(!dynamic_kenv, ("kenv: dynamic_kenv already initialized"));
302 * Suitably sized means it must be able to hold at least one empty
303 * variable, otherwise things go belly up if a kern_getenv call is
304 * made without a prior call to kern_setenv as we have a malformed
307 KASSERT(len == 0 || len >= 2,
308 ("kenv: static env must be initialized or suitably sized"));
309 KASSERT(len == 0 || (*buf == '\0' && *(buf + 1) == '\0'),
310 ("kenv: sized buffer must be initially empty"));
313 * We may be called twice, with the second call needed to relocate
314 * md_envp after enabling paging. md_envp is then garbage if it is
315 * not null and the relocation will move it. Discard it so as to
316 * not crash using its old value in our first call to kern_getenv().
318 * The second call gives the same environment as the first except
319 * in silly configurations where the static env disables itself.
321 * Other env calls don't handle possibly-garbage pointers, so must
322 * not be made between enabling paging and calling here.
329 * Give the static environment a chance to disable the loader(8)
330 * environment first. This is done with loader_env.disabled=1.
332 * static_env and static_hints may both be disabled, but in slightly
333 * different ways. For static_env, we just don't setup kern_envp and
334 * it's as if a static env wasn't even provided. For static_hints,
335 * we effectively zero out the buffer to stop the rest of the kernel
336 * from being able to use it.
338 * We're intentionally setting this up so that static_hints.disabled may
339 * be specified in either the MD env or the static env. This keeps us
340 * consistent in our new world view.
342 * As a warning, the static environment may not be disabled in any way
343 * if the static environment has disabled the loader environment.
345 kern_envp = static_env;
346 if (!getenv_is_true("loader_env.disabled")) {
351 if (getenv_is_true("static_env.disabled")) {
356 if (getenv_is_true("static_hints.disabled")) {
357 static_hints[0] = '\0';
358 static_hints[1] = '\0';
362 /* Maximum suffix number appended for duplicate environment variable names. */
363 #define MAXSUFFIX 9999
364 #define SUFFIXLEN strlen("_" __XSTRING(MAXSUFFIX))
367 getfreesuffix(char *cp, size_t *n)
369 size_t len = strlen(cp);
372 ncp = malloc(len + SUFFIXLEN + 1, M_KENV, M_WAITOK);
373 memcpy(ncp, cp, len);
374 for (*n = 1; *n <= MAXSUFFIX; (*n)++) {
375 sprintf(&ncp[len], "_%zu", *n);
376 if (!_getenv_dynamic_locked(ncp, NULL))
381 panic("Too many duplicate kernel environment values: %s", cp);
385 init_dynamic_kenv_from(char *init_env, int *curpos)
387 char *cp, *cpnext, *eqpos, *found;
391 if (init_env && *init_env != '\0') {
394 for (cp = init_env; cp != NULL; cp = cpnext) {
395 cpnext = kernenv_next(cp);
396 len = strlen(cp) + 1;
399 "WARNING: too many kenv strings, ignoring %s\n",
403 if (len > KENV_MNAMELEN + 1 + kenv_mvallen + 1) {
405 "WARNING: too long kenv string, ignoring %s\n",
409 eqpos = strchr(cp, '=');
412 "WARNING: malformed static env value, ignoring %s\n",
418 * Handle duplicates in the environment as we go; we
419 * add the duplicated assignments with _N suffixes.
420 * This ensures that (a) if a variable is set in the
421 * static environment and in the "loader" environment
422 * provided by MD code, the value from the loader will
423 * have the expected variable name and the value from
424 * the static environment will have the suffix; and (b)
425 * if the "loader" environment has the same variable
426 * set multiple times (as is possible with values being
427 * passed via the kernel "command line") the extra
428 * values are visible to code which knows where to look
431 found = _getenv_dynamic_locked(cp, NULL);
433 getfreesuffix(cp, &n);
434 kenvp[i] = malloc(len + SUFFIXLEN,
436 sprintf(kenvp[i++], "%s_%zu=%s", cp, n,
439 kenvp[i] = malloc(len, M_KENV, M_WAITOK);
441 strcpy(kenvp[i++], cp);
444 #ifdef PRESERVE_EARLY_KENV
447 explicit_bzero(cp, len - 1);
455 * Setup the dynamic kernel environment.
458 init_dynamic_kenv(void *data __unused)
463 TUNABLE_INT_FETCH("kenv_mvallen", &kenv_mvallen);
464 size = KENV_MNAMELEN + 1 + kenv_mvallen + 1;
466 kenv_zone = uma_zcreate("kenv", size, NULL, NULL, NULL, NULL,
469 kenvp = malloc((KENV_SIZE + 1) * sizeof(char *), M_KENV,
473 init_dynamic_kenv_from(md_envp, &dynamic_envpos);
474 init_dynamic_kenv_from(kern_envp, &dynamic_envpos);
475 kenvp[dynamic_envpos] = NULL;
477 mtx_init(&kenv_lock, "kernel environment", NULL, MTX_DEF);
480 SYSINIT(kenv, SI_SUB_KMEM + 1, SI_ORDER_FIRST, init_dynamic_kenv, NULL);
486 if (dynamic_kenv && env != NULL) {
487 explicit_bzero(env, strlen(env));
488 uma_zfree(kenv_zone, env);
493 * Internal functions for string lookup.
496 _getenv_dynamic_locked(const char *name, int *idx)
502 for (cp = kenvp[0], i = 0; cp != NULL; cp = kenvp[++i]) {
503 if ((strncmp(cp, name, len) == 0) &&
507 return (cp + len + 1);
514 _getenv_dynamic(const char *name, int *idx)
517 mtx_assert(&kenv_lock, MA_OWNED);
518 return (_getenv_dynamic_locked(name, idx));
522 _getenv_static_from(char *chkenv, const char *name)
527 for (cp = chkenv; cp != NULL; cp = kernenv_next(cp)) {
528 for (ep = cp; (*ep != '=') && (*ep != 0); ep++)
534 if (!strncmp(name, cp, len) && name[len] == 0)
541 _getenv_static(const char *name)
545 val = _getenv_static_from(md_envp, name);
548 val = _getenv_static_from(kern_envp, name);
555 * Look up an environment variable by name.
556 * Return a pointer to the string if found.
557 * The pointer has to be freed with freeenv()
561 kern_getenv(const char *name)
567 len = KENV_MNAMELEN + 1 + kenv_mvallen + 1;
568 ret = uma_zalloc(kenv_zone, M_WAITOK | M_ZERO);
569 mtx_lock(&kenv_lock);
570 cp = _getenv_dynamic(name, NULL);
572 strlcpy(ret, cp, len);
573 mtx_unlock(&kenv_lock);
575 uma_zfree(kenv_zone, ret);
579 ret = _getenv_static(name);
585 * Test if an environment variable is defined.
588 testenv(const char *name)
592 cp = kenv_acquire(name);
601 * Set an environment variable in the MD-static environment. This cannot
602 * feasibly be done on config(8)-generated static environments as they don't
603 * generally include space for extra variables.
606 setenv_static(const char *name, const char *value)
610 if (md_env_pos >= md_env_len)
613 /* Check space for x=y and two nuls */
614 len = strlen(name) + strlen(value);
615 if (len + 3 < md_env_len - md_env_pos) {
616 len = sprintf(&md_envp[md_env_pos], "%s=%s", name, value);
618 md_envp[md_env_pos] = '\0';
626 * Set an environment variable by name.
629 kern_setenv(const char *name, const char *value)
631 char *buf, *cp, *oldenv;
632 int namelen, vallen, i;
634 if (!dynamic_kenv && md_env_len > 0)
635 return (setenv_static(name, value));
639 namelen = strlen(name) + 1;
640 if (namelen > KENV_MNAMELEN + 1)
642 vallen = strlen(value) + 1;
643 if (vallen > kenv_mvallen + 1)
645 buf = malloc(namelen + vallen, M_KENV, M_WAITOK);
646 sprintf(buf, "%s=%s", name, value);
648 mtx_lock(&kenv_lock);
649 cp = _getenv_dynamic(name, &i);
653 mtx_unlock(&kenv_lock);
654 free(oldenv, M_KENV);
656 /* We add the option if it wasn't found */
657 for (i = 0; (cp = kenvp[i]) != NULL; i++)
660 /* Bounds checking */
661 if (i < 0 || i >= KENV_SIZE) {
663 mtx_unlock(&kenv_lock);
669 mtx_unlock(&kenv_lock);
671 EVENTHANDLER_INVOKE(setenv, name);
676 * Unset an environment variable string.
679 kern_unsetenv(const char *name)
686 mtx_lock(&kenv_lock);
687 cp = _getenv_dynamic(name, &i);
690 for (j = i + 1; kenvp[j] != NULL; j++)
691 kenvp[i++] = kenvp[j];
693 mtx_unlock(&kenv_lock);
694 zfree(oldenv, M_KENV);
695 EVENTHANDLER_INVOKE(unsetenv, name);
698 mtx_unlock(&kenv_lock);
703 * Return the internal kenv buffer for the variable name, if it exists.
704 * If the dynamic kenv is initialized and the name is present, return
705 * with kenv_lock held.
708 kenv_acquire(const char *name)
713 mtx_lock(&kenv_lock);
714 value = _getenv_dynamic(name, NULL);
716 mtx_unlock(&kenv_lock);
719 return (_getenv_static(name));
723 * Undo a previous kenv_acquire() operation
726 kenv_release(const char *buf)
728 if ((buf != NULL) && dynamic_kenv)
729 mtx_unlock(&kenv_lock);
733 * Return a string value from an environment variable.
736 getenv_string(const char *name, char *data, int size)
740 cp = kenv_acquire(name);
743 strlcpy(data, cp, size);
751 * Return an array of integers at the given type size and signedness.
754 getenv_array(const char *name, void *pdata, int size, int *psize,
755 int type_size, bool allow_signed)
766 rc = 0; /* assume failure */
768 buf = kenv_acquire(name);
772 /* get maximum number of elements */
777 for (ptr = buf; *ptr != 0; ) {
778 value = strtoq(ptr, &end, 0);
780 /* check if signed numbers are allowed */
781 if (value < 0 && !allow_signed)
784 /* check for invalid value */
788 /* check for valid suffix */
817 /* garbage after numeric value */
821 /* skip till next value, if any */
822 while (*end == '\t' || *end == ',' || *end == ' ')
833 if ((value >> shift) != old)
836 /* check for buffer overflow */
840 /* store value according to type size */
844 if (value < SCHAR_MIN || value > SCHAR_MAX)
847 if (value < 0 || value > UCHAR_MAX)
850 ((uint8_t *)pdata)[n] = (uint8_t)value;
854 if (value < SHRT_MIN || value > SHRT_MAX)
857 if (value < 0 || value > USHRT_MAX)
860 ((uint16_t *)pdata)[n] = (uint16_t)value;
864 if (value < INT_MIN || value > INT_MAX)
867 if (value > UINT_MAX)
870 ((uint32_t *)pdata)[n] = (uint32_t)value;
873 ((uint64_t *)pdata)[n] = (uint64_t)value;
880 *psize = n * type_size;
883 rc = 1; /* success */
890 * Return an integer value from an environment variable.
893 getenv_int(const char *name, int *data)
898 rval = getenv_quad(name, &tmp);
905 * Return an unsigned integer value from an environment variable.
908 getenv_uint(const char *name, unsigned int *data)
913 rval = getenv_quad(name, &tmp);
915 *data = (unsigned int) tmp;
920 * Return an int64_t value from an environment variable.
923 getenv_int64(const char *name, int64_t *data)
928 rval = getenv_quad(name, &tmp);
930 *data = (int64_t) tmp;
935 * Return an uint64_t value from an environment variable.
938 getenv_uint64(const char *name, uint64_t *data)
943 rval = getenv_quad(name, &tmp);
945 *data = (uint64_t) tmp;
950 * Return a long value from an environment variable.
953 getenv_long(const char *name, long *data)
958 rval = getenv_quad(name, &tmp);
965 * Return an unsigned long value from an environment variable.
968 getenv_ulong(const char *name, unsigned long *data)
973 rval = getenv_quad(name, &tmp);
975 *data = (unsigned long) tmp;
980 * Return a quad_t value from an environment variable.
983 getenv_quad(const char *name, quad_t *data)
989 value = kenv_acquire(name);
993 iv = strtoq(value, &vtp, 0);
994 if (vtp == value || (vtp[0] != '\0' && vtp[1] != '\0')) {
1019 kenv_release(value);
1024 * Return a boolean value from an environment variable. This can be in
1025 * numerical or string form, i.e. "1" or "true".
1028 getenv_bool(const char *name, bool *data)
1036 val = kern_getenv(name);
1040 if ((strcmp(val, "1") == 0) || (strcasecmp(val, "true") == 0)) {
1043 } else if ((strcmp(val, "0") == 0) || (strcasecmp(val, "false") == 0)) {
1047 /* Spit out a warning for malformed boolean variables. */
1048 printf("Environment variable %s has non-boolean value \"%s\"\n",
1057 * Wrapper around getenv_bool to easily check for true.
1060 getenv_is_true(const char *name)
1064 if (getenv_bool(name, &val) != 0)
1070 * Wrapper around getenv_bool to easily check for false.
1073 getenv_is_false(const char *name)
1077 if (getenv_bool(name, &val) != 0)
1083 * Find the next entry after the one which (cp) falls within, return a
1084 * pointer to its start or NULL if there are no more.
1087 kernenv_next(char *cp)
1101 tunable_int_init(void *data)
1103 struct tunable_int *d = (struct tunable_int *)data;
1105 TUNABLE_INT_FETCH(d->path, d->var);
1109 tunable_long_init(void *data)
1111 struct tunable_long *d = (struct tunable_long *)data;
1113 TUNABLE_LONG_FETCH(d->path, d->var);
1117 tunable_ulong_init(void *data)
1119 struct tunable_ulong *d = (struct tunable_ulong *)data;
1121 TUNABLE_ULONG_FETCH(d->path, d->var);
1125 tunable_int64_init(void *data)
1127 struct tunable_int64 *d = (struct tunable_int64 *)data;
1129 TUNABLE_INT64_FETCH(d->path, d->var);
1133 tunable_uint64_init(void *data)
1135 struct tunable_uint64 *d = (struct tunable_uint64 *)data;
1137 TUNABLE_UINT64_FETCH(d->path, d->var);
1141 tunable_quad_init(void *data)
1143 struct tunable_quad *d = (struct tunable_quad *)data;
1145 TUNABLE_QUAD_FETCH(d->path, d->var);
1149 tunable_bool_init(void *data)
1151 struct tunable_bool *d = (struct tunable_bool *)data;
1153 TUNABLE_BOOL_FETCH(d->path, d->var);
1157 tunable_str_init(void *data)
1159 struct tunable_str *d = (struct tunable_str *)data;
1161 TUNABLE_STR_FETCH(d->path, d->var, d->size);