Deleted Added
full compact
kern_environment.c (85493) kern_environment.c (94936)
1/*-
2 * Copyright (c) 1998 Michael Smith
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright

--- 9 unchanged lines hidden (view full) ---

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
24 * SUCH DAMAGE.
25 *
1/*-
2 * Copyright (c) 1998 Michael Smith
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright

--- 9 unchanged lines hidden (view full) ---

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
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/kern/kern_environment.c 85493 2001-10-25 17:22:31Z jhb $
26 * $FreeBSD: head/sys/kern/kern_environment.c 94936 2002-04-17 13:06:36Z mux $
27 */
28
29/*
30 * The unified bootloader passes us a pointer to a preserved copy of
27 */
28
29/*
30 * The unified bootloader passes us a pointer to a preserved copy of
31 * bootstrap/kernel environment variables.
32 * We make these available using sysctl for both in-kernel and
33 * out-of-kernel consumers.
31 * bootstrap/kernel environment variables. We convert them to a
32 * dynamic array of strings later when the VM subsystem is up.
34 *
33 *
35 * Note that the current sysctl infrastructure doesn't allow
36 * dynamic insertion or traversal through handled spaces. Grr.
34 * We make these available through the kenv(2) syscall for userland
35 * and through getenv()/freeenv() setenv() unsetenv() testenv() for
36 * the kernel.
37 */
38
37 */
38
39#include <sys/types.h>
39#include <sys/param.h>
40#include <sys/param.h>
41#include <sys/proc.h>
42#include <sys/queue.h>
43#include <sys/lock.h>
44#include <sys/malloc.h>
45#include <sys/mutex.h>
40#include <sys/kernel.h>
46#include <sys/kernel.h>
47#include <sys/sx.h>
41#include <sys/systm.h>
48#include <sys/systm.h>
42#include <sys/sysctl.h>
49#include <sys/sysent.h>
50#include <sys/sysproto.h>
43#include <sys/libkern.h>
51#include <sys/libkern.h>
52#include <sys/kenv.h>
44
53
45char *kern_envp;
54MALLOC_DEFINE(M_KENV, "kenv", "kernel environment");
46
55
47static char *kernenv_next(char *cp);
56#define KENV_SIZE 512 /* Maximum number of environment strings */
48
57
58/* pointer to the static environment */
59char *kern_envp;
60static char *kernenv_next(char *);
61
62/* dynamic environment variables */
63char **kenvp;
64struct sx kenv_lock;
65
49/*
66/*
67 * No need to protect this with a mutex
68 * since SYSINITS are single threaded.
69 */
70int dynamic_kenv = 0;
71
72#define KENV_CHECK if (!dynamic_kenv) \
73 panic("%s: called before SI_SUB_KMEM", __func__)
74
75int
76kenv(td, uap)
77 struct thread *td;
78 struct kenv_args /* {
79 syscallarg(int) what;
80 syscallarg(const char *) name;
81 syscallarg(char *) value;
82 syscallarg(int) len;
83 } */ *uap;
84{
85 char *name, *value;
86 size_t len, done;
87 int error, i;
88
89 KASSERT(dynamic_kenv, ("kenv: dynamic_kenv = 0"));
90
91 error = 0;
92 if (SCARG(uap, what) == KENV_DUMP) {
93 len = 0;
94 /* Return the size if called with a NULL buffer */
95 if (SCARG(uap, value) == NULL) {
96 sx_slock(&kenv_lock);
97 for (i = 0; kenvp[i] != NULL; i++)
98 len += strlen(kenvp[i]) + 1;
99 sx_sunlock(&kenv_lock);
100 td->td_retval[0] = len;
101 return (0);
102 }
103 done = 0;
104 sx_slock(&kenv_lock);
105 for (i = 0; kenvp[i] != NULL && done < SCARG(uap, len); i++) {
106 len = min(strlen(kenvp[i]) + 1, SCARG(uap, len) - done);
107 error = copyout(kenvp[i], SCARG(uap, value) + done,
108 len);
109 if (error) {
110 sx_sunlock(&kenv_lock);
111 return (error);
112 }
113 done += len;
114 }
115 sx_sunlock(&kenv_lock);
116 return (0);
117 }
118
119 if ((SCARG(uap, what) == KENV_SET) ||
120 (SCARG(uap, what) == KENV_UNSET)) {
121 error = suser(td);
122 if (error)
123 return (error);
124 }
125
126 name = malloc(KENV_MNAMELEN, M_TEMP, M_WAITOK);
127
128 error = copyinstr(SCARG(uap, name), name, KENV_MNAMELEN, NULL);
129 if (error)
130 goto done;
131
132 switch (SCARG(uap, what)) {
133 case KENV_GET:
134 value = getenv(name);
135 if (value == NULL) {
136 error = ENOENT;
137 goto done;
138 }
139 len = strlen(value) + 1;
140 if (len > SCARG(uap, len))
141 len = SCARG(uap, len);
142 error = copyout(value, SCARG(uap, value), len);
143 freeenv(value);
144 if (error)
145 goto done;
146 td->td_retval[0] = len;
147 break;
148 case KENV_SET:
149 len = SCARG(uap, len);
150 if (len < 1) {
151 error = EINVAL;
152 goto done;
153 }
154 if (len > KENV_MVALLEN)
155 len = KENV_MVALLEN;
156 value = malloc(len, M_TEMP, M_WAITOK);
157 error = copyinstr(SCARG(uap, value), value, len, NULL);
158 if (error) {
159 free(value, M_TEMP);
160 goto done;
161 }
162 setenv(name, value);
163 free(value, M_TEMP);
164 break;
165 case KENV_UNSET:
166 error = unsetenv(name);
167 if (error)
168 error = ENOENT;
169 break;
170 default:
171 error = EINVAL;
172 break;
173 }
174done:
175 free(name, M_TEMP);
176 return (error);
177}
178
179/*
180 * Setup the dynamic kernel environment.
181 */
182static void
183init_dynamic_kenv(void *data __unused)
184{
185 char *cp;
186 int len, i;
187
188 kenvp = malloc(KENV_SIZE * sizeof(char *), M_KENV, M_WAITOK | M_ZERO);
189 i = 0;
190 for (cp = kern_envp; cp != NULL; cp = kernenv_next(cp)) {
191 len = strlen(cp) + 1;
192 kenvp[i] = malloc(len, M_KENV, M_WAITOK);
193 strcpy(kenvp[i++], cp);
194 }
195 kenvp[i] = NULL;
196
197 sx_init(&kenv_lock, "kernel environment");
198 dynamic_kenv = 1;
199}
200SYSINIT(kenv, SI_SUB_KMEM, SI_ORDER_ANY, init_dynamic_kenv, NULL);
201
202void
203freeenv(char *env)
204{
205
206 if (dynamic_kenv)
207 free(env, M_KENV);
208}
209
210/*
211 * Internal functions for string lookup.
212 */
213static char *
214_getenv_dynamic(const char *name, int *idx)
215{
216 char *cp;
217 int len, i;
218
219 sx_assert(&kenv_lock, SX_LOCKED);
220 len = strlen(name);
221 for (cp = kenvp[0], i = 0; cp != NULL; cp = kenvp[++i]) {
222 if ((cp[len] == '=') &&
223 (strncmp(cp, name, len) == 0)) {
224 if (idx != NULL)
225 *idx = i;
226 return (cp + len + 1);
227 }
228 }
229 return (NULL);
230}
231
232static char *
233_getenv_static(const char *name)
234{
235 char *cp, *ep;
236 int len;
237
238 for (cp = kern_envp; cp != NULL; cp = kernenv_next(cp)) {
239 for (ep = cp; (*ep != '=') && (*ep != 0); ep++)
240 ;
241 len = ep - cp;
242 if (*ep == '=')
243 ep++;
244 if (!strncmp(name, cp, len))
245 return (ep);
246 }
247 return (NULL);
248}
249
250/*
50 * Look up an environment variable by name.
251 * Look up an environment variable by name.
252 * Return a pointer to the string if found.
253 * The pointer has to be freed with freeenv()
254 * after use.
51 */
52char *
53getenv(const char *name)
54{
255 */
256char *
257getenv(const char *name)
258{
55 char *cp, *ep;
56 int len;
57
58 for (cp = kern_envp; cp != NULL; cp = kernenv_next(cp)) {
59 for (ep = cp; (*ep != '=') && (*ep != 0); ep++)
60 ;
61 len = ep - cp;
62 if (*ep == '=')
63 ep++;
64 if (!strncmp(name, cp, len))
65 return(ep);
66 }
67 return(NULL);
259 char *ret, *cp;
260 int len;
261
262 if (dynamic_kenv) {
263 sx_slock(&kenv_lock);
264 cp = _getenv_dynamic(name, NULL);
265 if (cp != NULL) {
266 len = strlen(cp) + 1;
267 ret = malloc(len, M_KENV, M_WAITOK);
268 strcpy(ret, cp);
269 } else
270 ret = NULL;
271 sx_sunlock(&kenv_lock);
272 } else
273 ret = _getenv_static(name);
274 return (ret);
68}
69
70/*
275}
276
277/*
278 * Test if an environment variable is defined.
279 */
280int
281testenv(const char *name)
282{
283 char *cp;
284
285 if (dynamic_kenv) {
286 sx_slock(&kenv_lock);
287 cp = _getenv_dynamic(name, NULL);
288 sx_sunlock(&kenv_lock);
289 } else
290 cp = _getenv_static(name);
291 if (cp != NULL)
292 return (1);
293 return (0);
294}
295
296/*
297 * Set an environment variable by name.
298 */
299void
300setenv(const char *name, const char *value)
301{
302 char *buf, *cp;
303 int len, i;
304
305 KENV_CHECK;
306
307 len = strlen(name) + 1 + strlen(value) + 1;
308 buf = malloc(len, M_KENV, M_WAITOK);
309 sprintf(buf, "%s=%s", name, value);
310
311 sx_xlock(&kenv_lock);
312 cp = _getenv_dynamic(name, &i);
313 if (cp != NULL) {
314 free(kenvp[i], M_KENV);
315 kenvp[i] = buf;
316 } else {
317 /* We add the option if it wasn't found */
318 for (i = 0; (cp = kenvp[i]) != NULL; i++)
319 ;
320 kenvp[i] = buf;
321 kenvp[i + 1] = NULL;
322 }
323 sx_xunlock(&kenv_lock);
324}
325
326/*
327 * Unset an environment variable string.
328 */
329int
330unsetenv(const char *name)
331{
332 char *cp;
333 int i, j;
334
335 KENV_CHECK;
336
337 sx_xlock(&kenv_lock);
338 cp = _getenv_dynamic(name, &i);
339 if (cp != NULL) {
340 free(kenvp[i], M_KENV);
341 for (j = i + 1; kenvp[j] != NULL; j++)
342 kenvp[i++] = kenvp[j];
343 kenvp[i] = NULL;
344 sx_xunlock(&kenv_lock);
345 return (0);
346 }
347 sx_xunlock(&kenv_lock);
348 return (-1);
349}
350
351/*
71 * Return a string value from an environment variable.
72 */
73int
74getenv_string(const char *name, char *data, int size)
75{
76 char *tmp;
77
78 tmp = getenv(name);
79 if (tmp != NULL) {
80 strncpy(data, tmp, size);
352 * Return a string value from an environment variable.
353 */
354int
355getenv_string(const char *name, char *data, int size)
356{
357 char *tmp;
358
359 tmp = getenv(name);
360 if (tmp != NULL) {
361 strncpy(data, tmp, size);
362 freeenv(tmp);
81 data[size - 1] = 0;
82 return (1);
83 } else
84 return (0);
85}
86
87/*
88 * Return an integer value from an environment variable.

--- 12 unchanged lines hidden (view full) ---

101}
102
103/*
104 * Return a quad_t value from an environment variable.
105 */
106int
107getenv_quad(const char *name, quad_t *data)
108{
363 data[size - 1] = 0;
364 return (1);
365 } else
366 return (0);
367}
368
369/*
370 * Return an integer value from an environment variable.

--- 12 unchanged lines hidden (view full) ---

383}
384
385/*
386 * Return a quad_t value from an environment variable.
387 */
388int
389getenv_quad(const char *name, quad_t *data)
390{
109 const char *value;
391 char *value;
110 char *vtp;
111 quad_t iv;
112
113 if ((value = getenv(name)) == NULL)
114 return(0);
115
116 iv = strtoq(value, &vtp, 0);
392 char *vtp;
393 quad_t iv;
394
395 if ((value = getenv(name)) == NULL)
396 return(0);
397
398 iv = strtoq(value, &vtp, 0);
117 if ((vtp == value) || (*vtp != '\0'))
399 if ((vtp == value) || (*vtp != '\0')) {
400 freeenv(value);
118 return(0);
401 return(0);
402 }
119
403
404 freeenv(value);
120 *data = iv;
121 return(1);
122}
123
124/*
405 *data = iv;
406 return(1);
407}
408
409/*
125 * Export for userland. See kenv(1) specifically.
126 */
127static int
128sysctl_kernenv(SYSCTL_HANDLER_ARGS)
129{
130 int *name = (int *)arg1;
131 u_int namelen = arg2;
132 char *cp;
133 int i, error;
134
135 if (kern_envp == NULL)
136 return(ENOENT);
137
138 name++;
139 namelen--;
140
141 if (namelen != 1)
142 return(EINVAL);
143
144 cp = kern_envp;
145 for (i = 0; i < name[0]; i++) {
146 cp = kernenv_next(cp);
147 if (cp == NULL)
148 break;
149 }
150
151 if (cp == NULL)
152 return(ENOENT);
153
154 error = SYSCTL_OUT(req, cp, strlen(cp) + 1);
155 return (error);
156}
157
158SYSCTL_NODE(_kern, OID_AUTO, environment, CTLFLAG_RD, sysctl_kernenv, "kernel environment space");
159
160/*
161 * Find the next entry after the one which (cp) falls within, return a
162 * pointer to its start or NULL if there are no more.
163 */
164static char *
165kernenv_next(char *cp)
166{
167 if (cp != NULL) {
168 while (*cp != 0)

--- 31 unchanged lines hidden ---
410 * Find the next entry after the one which (cp) falls within, return a
411 * pointer to its start or NULL if there are no more.
412 */
413static char *
414kernenv_next(char *cp)
415{
416 if (cp != NULL) {
417 while (*cp != 0)

--- 31 unchanged lines hidden ---