2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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/cdefs.h>
40 __FBSDID("$FreeBSD$");
42 #include <sys/param.h>
44 #include <sys/queue.h>
46 #include <sys/malloc.h>
47 #include <sys/mutex.h>
49 #include <sys/kernel.h>
50 #include <sys/systm.h>
51 #include <sys/sysent.h>
52 #include <sys/sysproto.h>
53 #include <sys/libkern.h>
55 #include <sys/limits.h>
57 #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__)
104 char *name, *value, *buffer = NULL;
105 size_t len, done, needed, buflen;
108 KASSERT(dynamic_kenv, ("kenv: dynamic_kenv = false"));
111 if (uap->what == KENV_DUMP) {
113 error = mac_kenv_check_dump(td->td_ucred);
119 if (buflen > KENV_SIZE * (KENV_MNAMELEN + kenv_mvallen + 2))
120 buflen = KENV_SIZE * (KENV_MNAMELEN +
122 if (uap->len > 0 && uap->value != NULL)
123 buffer = malloc(buflen, M_TEMP, M_WAITOK|M_ZERO);
124 mtx_lock(&kenv_lock);
125 for (i = 0; kenvp[i] != NULL; i++) {
126 len = strlen(kenvp[i]) + 1;
128 len = min(len, buflen - done);
130 * If called with a NULL or insufficiently large
131 * buffer, just keep computing the required size.
133 if (uap->value != NULL && buffer != NULL && len > 0) {
134 bcopy(kenvp[i], buffer + done, len);
138 mtx_unlock(&kenv_lock);
139 if (buffer != NULL) {
140 error = copyout(buffer, uap->value, done);
141 free(buffer, M_TEMP);
143 td->td_retval[0] = ((done == needed) ? 0 : needed);
149 error = priv_check(td, PRIV_KENV_SET);
155 error = priv_check(td, PRIV_KENV_UNSET);
161 name = malloc(KENV_MNAMELEN + 1, M_TEMP, M_WAITOK);
163 error = copyinstr(uap->name, name, KENV_MNAMELEN + 1, NULL);
170 error = mac_kenv_check_get(td->td_ucred, name);
174 value = kern_getenv(name);
179 len = strlen(value) + 1;
182 error = copyout(value, uap->value, len);
186 td->td_retval[0] = len;
194 if (len > kenv_mvallen + 1)
195 len = kenv_mvallen + 1;
196 value = malloc(len, M_TEMP, M_WAITOK);
197 error = copyinstr(uap->value, value, len, NULL);
203 error = mac_kenv_check_set(td->td_ucred, name, value);
206 kern_setenv(name, value);
211 error = mac_kenv_check_unset(td->td_ucred, name);
215 error = kern_unsetenv(name);
229 * Populate the initial kernel environment.
231 * This is called very early in MD startup, either to provide a copy of the
232 * environment obtained from a boot loader, or to provide an empty buffer into
233 * which MD code can store an initial environment using kern_setenv() calls.
235 * kern_envp is set to the static_env generated by config(8). This implements
236 * the env keyword described in config(5).
238 * If len is non-zero, the caller is providing an empty buffer. The caller will
239 * subsequently use kern_setenv() to add up to len bytes of initial environment
240 * before the dynamic environment is available.
242 * If len is zero, the caller is providing a pre-loaded buffer containing
243 * environment strings. Additional strings cannot be added until the dynamic
244 * environment is available. The memory pointed to must remain stable at least
245 * until sysinit runs init_dynamic_kenv() and preferably until after SI_SUB_KMEM
246 * is finished so that subr_hints routines may continue to use it until the
247 * environments have been fully merged at the end of the pass. If no initial
248 * environment is available from the boot loader, passing a NULL pointer allows
249 * the static_env to be installed if it is configured. In this case, any call
250 * to kern_setenv() prior to the setup of the dynamic environment will result in
254 init_static_kenv(char *buf, size_t len)
258 KASSERT(!dynamic_kenv, ("kenv: dynamic_kenv already initialized"));
260 * Suitably sized means it must be able to hold at least one empty
261 * variable, otherwise things go belly up if a kern_getenv call is
262 * made without a prior call to kern_setenv as we have a malformed
265 KASSERT(len == 0 || len >= 2,
266 ("kenv: static env must be initialized or suitably sized"));
267 KASSERT(len == 0 || (*buf == '\0' && *(buf + 1) == '\0'),
268 ("kenv: sized buffer must be initially empty"));
271 * We may be called twice, with the second call needed to relocate
272 * md_envp after enabling paging. md_envp is then garbage if it is
273 * not null and the relocation will move it. Discard it so as to
274 * not crash using its old value in our first call to kern_getenv().
276 * The second call gives the same environment as the first except
277 * in silly configurations where the static env disables itself.
279 * Other env calls don't handle possibly-garbage pointers, so must
280 * not be made between enabling paging and calling here.
287 * Give the static environment a chance to disable the loader(8)
288 * environment first. This is done with loader_env.disabled=1.
290 * static_env and static_hints may both be disabled, but in slightly
291 * different ways. For static_env, we just don't setup kern_envp and
292 * it's as if a static env wasn't even provided. For static_hints,
293 * we effectively zero out the buffer to stop the rest of the kernel
294 * from being able to use it.
296 * We're intentionally setting this up so that static_hints.disabled may
297 * be specified in either the MD env or the static env. This keeps us
298 * consistent in our new world view.
300 * As a warning, the static environment may not be disabled in any way
301 * if the static environment has disabled the loader environment.
303 kern_envp = static_env;
304 eval = kern_getenv("loader_env.disabled");
305 if (eval == NULL || strcmp(eval, "1") != 0) {
310 eval = kern_getenv("static_env.disabled");
311 if (eval != NULL && strcmp(eval, "1") == 0) {
316 eval = kern_getenv("static_hints.disabled");
317 if (eval != NULL && strcmp(eval, "1") == 0) {
318 static_hints[0] = '\0';
319 static_hints[1] = '\0';
324 init_dynamic_kenv_from(char *init_env, int *curpos)
326 char *cp, *cpnext, *eqpos, *found;
330 if (init_env && *init_env != '\0') {
333 for (cp = init_env; cp != NULL; cp = cpnext) {
334 cpnext = kernenv_next(cp);
335 len = strlen(cp) + 1;
336 if (len > KENV_MNAMELEN + 1 + kenv_mvallen + 1) {
338 "WARNING: too long kenv string, ignoring %s\n",
342 eqpos = strchr(cp, '=');
345 "WARNING: malformed static env value, ignoring %s\n",
351 * De-dupe the environment as we go. We don't add the
352 * duplicated assignments because config(8) will flip
353 * the order of the static environment around to make
354 * kernel processing match the order of specification
355 * in the kernel config.
357 found = _getenv_dynamic_locked(cp, NULL);
363 "WARNING: too many kenv strings, ignoring %s\n",
368 kenvp[i] = malloc(len, M_KENV, M_WAITOK);
369 strcpy(kenvp[i++], cp);
371 explicit_bzero(cp, len - 1);
378 * Setup the dynamic kernel environment.
381 init_dynamic_kenv(void *data __unused)
386 TUNABLE_INT_FETCH("kenv_mvallen", &kenv_mvallen);
387 size = KENV_MNAMELEN + 1 + kenv_mvallen + 1;
389 kenv_zone = uma_zcreate("kenv", size, NULL, NULL, NULL, NULL,
392 kenvp = malloc((KENV_SIZE + 1) * sizeof(char *), M_KENV,
396 init_dynamic_kenv_from(md_envp, &dynamic_envpos);
397 init_dynamic_kenv_from(kern_envp, &dynamic_envpos);
398 kenvp[dynamic_envpos] = NULL;
400 mtx_init(&kenv_lock, "kernel environment", NULL, MTX_DEF);
403 SYSINIT(kenv, SI_SUB_KMEM + 1, SI_ORDER_FIRST, init_dynamic_kenv, NULL);
409 if (dynamic_kenv && env != NULL) {
410 explicit_bzero(env, strlen(env));
411 uma_zfree(kenv_zone, env);
416 * Internal functions for string lookup.
419 _getenv_dynamic_locked(const char *name, int *idx)
425 for (cp = kenvp[0], i = 0; cp != NULL; cp = kenvp[++i]) {
426 if ((strncmp(cp, name, len) == 0) &&
430 return (cp + len + 1);
437 _getenv_dynamic(const char *name, int *idx)
440 mtx_assert(&kenv_lock, MA_OWNED);
441 return (_getenv_dynamic_locked(name, idx));
445 _getenv_static_from(char *chkenv, const char *name)
450 for (cp = chkenv; cp != NULL; cp = kernenv_next(cp)) {
451 for (ep = cp; (*ep != '=') && (*ep != 0); ep++)
457 if (!strncmp(name, cp, len) && name[len] == 0)
464 _getenv_static(const char *name)
468 val = _getenv_static_from(md_envp, name);
471 val = _getenv_static_from(kern_envp, name);
478 * Look up an environment variable by name.
479 * Return a pointer to the string if found.
480 * The pointer has to be freed with freeenv()
484 kern_getenv(const char *name)
490 len = KENV_MNAMELEN + 1 + kenv_mvallen + 1;
491 ret = uma_zalloc(kenv_zone, M_WAITOK | M_ZERO);
492 mtx_lock(&kenv_lock);
493 cp = _getenv_dynamic(name, NULL);
495 strlcpy(ret, cp, len);
496 mtx_unlock(&kenv_lock);
498 uma_zfree(kenv_zone, ret);
502 ret = _getenv_static(name);
508 * Test if an environment variable is defined.
511 testenv(const char *name)
515 cp = kenv_acquire(name);
524 * Set an environment variable in the MD-static environment. This cannot
525 * feasibly be done on config(8)-generated static environments as they don't
526 * generally include space for extra variables.
529 setenv_static(const char *name, const char *value)
533 if (md_env_pos >= md_env_len)
536 /* Check space for x=y and two nuls */
537 len = strlen(name) + strlen(value);
538 if (len + 3 < md_env_len - md_env_pos) {
539 len = sprintf(&md_envp[md_env_pos], "%s=%s", name, value);
541 md_envp[md_env_pos] = '\0';
549 * Set an environment variable by name.
552 kern_setenv(const char *name, const char *value)
554 char *buf, *cp, *oldenv;
555 int namelen, vallen, i;
557 if (!dynamic_kenv && md_env_len > 0)
558 return (setenv_static(name, value));
562 namelen = strlen(name) + 1;
563 if (namelen > KENV_MNAMELEN + 1)
565 vallen = strlen(value) + 1;
566 if (vallen > kenv_mvallen + 1)
568 buf = malloc(namelen + vallen, M_KENV, M_WAITOK);
569 sprintf(buf, "%s=%s", name, value);
571 mtx_lock(&kenv_lock);
572 cp = _getenv_dynamic(name, &i);
576 mtx_unlock(&kenv_lock);
577 free(oldenv, M_KENV);
579 /* We add the option if it wasn't found */
580 for (i = 0; (cp = kenvp[i]) != NULL; i++)
583 /* Bounds checking */
584 if (i < 0 || i >= KENV_SIZE) {
586 mtx_unlock(&kenv_lock);
592 mtx_unlock(&kenv_lock);
598 * Unset an environment variable string.
601 kern_unsetenv(const char *name)
608 mtx_lock(&kenv_lock);
609 cp = _getenv_dynamic(name, &i);
612 for (j = i + 1; kenvp[j] != NULL; j++)
613 kenvp[i++] = kenvp[j];
615 mtx_unlock(&kenv_lock);
616 zfree(oldenv, M_KENV);
619 mtx_unlock(&kenv_lock);
624 * Return the internal kenv buffer for the variable name, if it exists.
625 * If the dynamic kenv is initialized and the name is present, return
626 * with kenv_lock held.
629 kenv_acquire(const char *name)
634 mtx_lock(&kenv_lock);
635 value = _getenv_dynamic(name, NULL);
637 mtx_unlock(&kenv_lock);
640 return (_getenv_static(name));
644 * Undo a previous kenv_acquire() operation
647 kenv_release(const char *buf)
649 if ((buf != NULL) && dynamic_kenv)
650 mtx_unlock(&kenv_lock);
654 * Return a string value from an environment variable.
657 getenv_string(const char *name, char *data, int size)
661 cp = kenv_acquire(name);
664 strlcpy(data, cp, size);
672 * Return an array of integers at the given type size and signedness.
675 getenv_array(const char *name, void *pdata, int size, int *psize,
676 int type_size, bool allow_signed)
687 rc = 0; /* assume failure */
689 buf = kenv_acquire(name);
693 /* get maximum number of elements */
698 for (ptr = buf; *ptr != 0; ) {
699 value = strtoq(ptr, &end, 0);
701 /* check if signed numbers are allowed */
702 if (value < 0 && !allow_signed)
705 /* check for invalid value */
709 /* check for valid suffix */
738 /* garbage after numeric value */
742 /* skip till next value, if any */
743 while (*end == '\t' || *end == ',' || *end == ' ')
754 if ((value >> shift) != old)
757 /* check for buffer overflow */
761 /* store value according to type size */
765 if (value < SCHAR_MIN || value > SCHAR_MAX)
768 if (value < 0 || value > UCHAR_MAX)
771 ((uint8_t *)pdata)[n] = (uint8_t)value;
775 if (value < SHRT_MIN || value > SHRT_MAX)
778 if (value < 0 || value > USHRT_MAX)
781 ((uint16_t *)pdata)[n] = (uint16_t)value;
785 if (value < INT_MIN || value > INT_MAX)
788 if (value > UINT_MAX)
791 ((uint32_t *)pdata)[n] = (uint32_t)value;
794 ((uint64_t *)pdata)[n] = (uint64_t)value;
801 *psize = n * type_size;
804 rc = 1; /* success */
811 * Return an integer value from an environment variable.
814 getenv_int(const char *name, int *data)
819 rval = getenv_quad(name, &tmp);
826 * Return an unsigned integer value from an environment variable.
829 getenv_uint(const char *name, unsigned int *data)
834 rval = getenv_quad(name, &tmp);
836 *data = (unsigned int) tmp;
841 * Return an int64_t value from an environment variable.
844 getenv_int64(const char *name, int64_t *data)
849 rval = getenv_quad(name, &tmp);
851 *data = (int64_t) tmp;
856 * Return an uint64_t value from an environment variable.
859 getenv_uint64(const char *name, uint64_t *data)
864 rval = getenv_quad(name, &tmp);
866 *data = (uint64_t) tmp;
871 * Return a long value from an environment variable.
874 getenv_long(const char *name, long *data)
879 rval = getenv_quad(name, &tmp);
886 * Return an unsigned long value from an environment variable.
889 getenv_ulong(const char *name, unsigned long *data)
894 rval = getenv_quad(name, &tmp);
896 *data = (unsigned long) tmp;
901 * Return a quad_t value from an environment variable.
904 getenv_quad(const char *name, quad_t *data)
910 value = kenv_acquire(name);
914 iv = strtoq(value, &vtp, 0);
915 if (vtp == value || (vtp[0] != '\0' && vtp[1] != '\0')) {
945 * Find the next entry after the one which (cp) falls within, return a
946 * pointer to its start or NULL if there are no more.
949 kernenv_next(char *cp)
963 tunable_int_init(void *data)
965 struct tunable_int *d = (struct tunable_int *)data;
967 TUNABLE_INT_FETCH(d->path, d->var);
971 tunable_long_init(void *data)
973 struct tunable_long *d = (struct tunable_long *)data;
975 TUNABLE_LONG_FETCH(d->path, d->var);
979 tunable_ulong_init(void *data)
981 struct tunable_ulong *d = (struct tunable_ulong *)data;
983 TUNABLE_ULONG_FETCH(d->path, d->var);
987 tunable_int64_init(void *data)
989 struct tunable_int64 *d = (struct tunable_int64 *)data;
991 TUNABLE_INT64_FETCH(d->path, d->var);
995 tunable_uint64_init(void *data)
997 struct tunable_uint64 *d = (struct tunable_uint64 *)data;
999 TUNABLE_UINT64_FETCH(d->path, d->var);
1003 tunable_quad_init(void *data)
1005 struct tunable_quad *d = (struct tunable_quad *)data;
1007 TUNABLE_QUAD_FETCH(d->path, d->var);
1011 tunable_str_init(void *data)
1013 struct tunable_str *d = (struct tunable_str *)data;
1015 TUNABLE_STR_FETCH(d->path, d->var, d->size);