]> git.ipfire.org Git - people/ms/u-boot.git/blame - lib/hashtable.c
env: Add a silent env handler
[people/ms/u-boot.git] / lib / hashtable.c
CommitLineData
a6826fbc
WD
1/*
2 * This implementation is based on code from uClibc-0.9.30.3 but was
3 * modified and extended for use within U-Boot.
4 *
5 * Copyright (C) 2010 Wolfgang Denk <wd@denx.de>
6 *
7 * Original license header:
8 *
9 * Copyright (C) 1993, 1995, 1996, 1997, 2002 Free Software Foundation, Inc.
10 * This file is part of the GNU C Library.
11 * Contributed by Ulrich Drepper <drepper@gnu.ai.mit.edu>, 1993.
12 *
13 * The GNU C Library is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU Lesser General Public
15 * License as published by the Free Software Foundation; either
16 * version 2.1 of the License, or (at your option) any later version.
17 *
18 * The GNU C Library is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 * Lesser General Public License for more details.
22 *
23 * You should have received a copy of the GNU Lesser General Public
24 * License along with the GNU C Library; if not, write to the Free
25 * Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
26 * 02111-1307 USA.
27 */
28
29#include <errno.h>
30#include <malloc.h>
31
32#ifdef USE_HOSTCC /* HOST build */
33# include <string.h>
34# include <assert.h>
4d91a6ec 35# include <ctype.h>
a6826fbc
WD
36
37# ifndef debug
38# ifdef DEBUG
39# define debug(fmt,args...) printf(fmt ,##args)
40# else
41# define debug(fmt,args...)
42# endif
43# endif
44#else /* U-Boot build */
45# include <common.h>
46# include <linux/string.h>
4d91a6ec 47# include <linux/ctype.h>
a6826fbc
WD
48#endif
49
fc5fc76b
AB
50#ifndef CONFIG_ENV_MIN_ENTRIES /* minimum number of entries */
51#define CONFIG_ENV_MIN_ENTRIES 64
52#endif
ea882baf
WD
53#ifndef CONFIG_ENV_MAX_ENTRIES /* maximum number of entries */
54#define CONFIG_ENV_MAX_ENTRIES 512
55#endif
56
170ab110
JH
57#include <env_callback.h>
58#include <search.h>
a6826fbc
WD
59
60/*
61 * [Aho,Sethi,Ullman] Compilers: Principles, Techniques and Tools, 1986
071bc923 62 * [Knuth] The Art of Computer Programming, part 3 (6.4)
a6826fbc
WD
63 */
64
a6826fbc
WD
65/*
66 * The reentrant version has no static variables to maintain the state.
67 * Instead the interface of all functions is extended to take an argument
68 * which describes the current status.
69 */
7afcf3a5 70
a6826fbc 71typedef struct _ENTRY {
c81c1222 72 int used;
a6826fbc
WD
73 ENTRY entry;
74} _ENTRY;
75
76
7afcf3a5
JH
77static void _hdelete(const char *key, struct hsearch_data *htab, ENTRY *ep,
78 int idx);
79
a6826fbc
WD
80/*
81 * hcreate()
82 */
83
84/*
85 * For the used double hash method the table size has to be a prime. To
86 * correct the user given table size we need a prime test. This trivial
87 * algorithm is adequate because
88 * a) the code is (most probably) called a few times per program run and
89 * b) the number is small because the table must fit in the core
90 * */
91static int isprime(unsigned int number)
92{
93 /* no even number will be passed */
94 unsigned int div = 3;
95
96 while (div * div < number && number % div != 0)
97 div += 2;
98
99 return number % div != 0;
100}
101
a6826fbc
WD
102/*
103 * Before using the hash table we must allocate memory for it.
104 * Test for an existing table are done. We allocate one element
105 * more as the found prime number says. This is done for more effective
106 * indexing as explained in the comment for the hsearch function.
107 * The contents of the table is zeroed, especially the field used
108 * becomes zero.
109 */
2eb1573f 110
a6826fbc
WD
111int hcreate_r(size_t nel, struct hsearch_data *htab)
112{
113 /* Test for correct arguments. */
114 if (htab == NULL) {
115 __set_errno(EINVAL);
116 return 0;
117 }
118
119 /* There is still another table active. Return with error. */
120 if (htab->table != NULL)
121 return 0;
122
123 /* Change nel to the first prime number not smaller as nel. */
124 nel |= 1; /* make odd */
125 while (!isprime(nel))
126 nel += 2;
127
128 htab->size = nel;
129 htab->filled = 0;
130
131 /* allocate memory and zero out */
132 htab->table = (_ENTRY *) calloc(htab->size + 1, sizeof(_ENTRY));
133 if (htab->table == NULL)
134 return 0;
135
136 /* everything went alright */
137 return 1;
138}
139
140
141/*
142 * hdestroy()
143 */
a6826fbc
WD
144
145/*
146 * After using the hash table it has to be destroyed. The used memory can
147 * be freed and the local static variable can be marked as not used.
148 */
2eb1573f 149
c4e0057f 150void hdestroy_r(struct hsearch_data *htab)
a6826fbc
WD
151{
152 int i;
153
154 /* Test for correct arguments. */
155 if (htab == NULL) {
156 __set_errno(EINVAL);
157 return;
158 }
159
160 /* free used memory */
161 for (i = 1; i <= htab->size; ++i) {
c81c1222 162 if (htab->table[i].used > 0) {
a6826fbc 163 ENTRY *ep = &htab->table[i].entry;
c4e0057f 164
84b5e802 165 free((void *)ep->key);
a6826fbc
WD
166 free(ep->data);
167 }
168 }
169 free(htab->table);
170
171 /* the sign for an existing table is an value != NULL in htable */
172 htab->table = NULL;
173}
174
175/*
176 * hsearch()
177 */
178
179/*
180 * This is the search function. It uses double hashing with open addressing.
181 * The argument item.key has to be a pointer to an zero terminated, most
182 * probably strings of chars. The function for generating a number of the
183 * strings is simple but fast. It can be replaced by a more complex function
184 * like ajw (see [Aho,Sethi,Ullman]) if the needs are shown.
185 *
186 * We use an trick to speed up the lookup. The table is created by hcreate
187 * with one more element available. This enables us to use the index zero
188 * special. This index will never be used because we store the first hash
189 * index in the field used where zero means not used. Every other value
190 * means used. The used field can be used as a first fast comparison for
191 * equality of the stored and the parameter value. This helps to prevent
192 * unnecessary expensive calls of strcmp.
193 *
194 * This implementation differs from the standard library version of
195 * this function in a number of ways:
196 *
197 * - While the standard version does not make any assumptions about
198 * the type of the stored data objects at all, this implementation
199 * works with NUL terminated strings only.
200 * - Instead of storing just pointers to the original objects, we
201 * create local copies so the caller does not need to care about the
202 * data any more.
203 * - The standard implementation does not provide a way to update an
204 * existing entry. This version will create a new entry or update an
205 * existing one when both "action == ENTER" and "item.data != NULL".
206 * - Instead of returning 1 on success, we return the index into the
207 * internal hash table, which is also guaranteed to be positive.
208 * This allows us direct access to the found hash table slot for
209 * example for functions like hdelete().
210 */
211
a000b795
KP
212/*
213 * hstrstr_r - return index to entry whose key and/or data contains match
214 */
215int hstrstr_r(const char *match, int last_idx, ENTRY ** retval,
216 struct hsearch_data *htab)
217{
218 unsigned int idx;
219
220 for (idx = last_idx + 1; idx < htab->size; ++idx) {
221 if (htab->table[idx].used <= 0)
222 continue;
223 if (strstr(htab->table[idx].entry.key, match) ||
224 strstr(htab->table[idx].entry.data, match)) {
225 *retval = &htab->table[idx].entry;
226 return idx;
227 }
228 }
229
230 __set_errno(ESRCH);
231 *retval = NULL;
232 return 0;
233}
234
560d424b
MF
235int hmatch_r(const char *match, int last_idx, ENTRY ** retval,
236 struct hsearch_data *htab)
237{
238 unsigned int idx;
239 size_t key_len = strlen(match);
240
241 for (idx = last_idx + 1; idx < htab->size; ++idx) {
af4d9074 242 if (htab->table[idx].used <= 0)
560d424b
MF
243 continue;
244 if (!strncmp(match, htab->table[idx].entry.key, key_len)) {
245 *retval = &htab->table[idx].entry;
246 return idx;
247 }
248 }
249
250 __set_errno(ESRCH);
251 *retval = NULL;
252 return 0;
253}
254
3d3b52f2
JH
255/*
256 * Compare an existing entry with the desired key, and overwrite if the action
257 * is ENTER. This is simply a helper function for hsearch_r().
258 */
259static inline int _compare_and_overwrite_entry(ENTRY item, ACTION action,
260 ENTRY **retval, struct hsearch_data *htab, int flag,
261 unsigned int hval, unsigned int idx)
262{
263 if (htab->table[idx].used == hval
264 && strcmp(item.key, htab->table[idx].entry.key) == 0) {
265 /* Overwrite existing value? */
266 if ((action == ENTER) && (item.data != NULL)) {
7afcf3a5
JH
267 /* check for permission */
268 if (htab->change_ok != NULL && htab->change_ok(
269 &htab->table[idx].entry, item.data,
270 env_op_overwrite, flag)) {
271 debug("change_ok() rejected setting variable "
272 "%s, skipping it!\n", item.key);
273 __set_errno(EPERM);
274 *retval = NULL;
275 return 0;
276 }
277
170ab110
JH
278 /* If there is a callback, call it */
279 if (htab->table[idx].entry.callback &&
280 htab->table[idx].entry.callback(item.key,
281 item.data, env_op_overwrite, flag)) {
282 debug("callback() rejected setting variable "
283 "%s, skipping it!\n", item.key);
284 __set_errno(EINVAL);
285 *retval = NULL;
286 return 0;
287 }
288
3d3b52f2
JH
289 free(htab->table[idx].entry.data);
290 htab->table[idx].entry.data = strdup(item.data);
291 if (!htab->table[idx].entry.data) {
292 __set_errno(ENOMEM);
293 *retval = NULL;
294 return 0;
295 }
296 }
297 /* return found entry */
298 *retval = &htab->table[idx].entry;
299 return idx;
300 }
301 /* keep searching */
302 return -1;
303}
304
a6826fbc 305int hsearch_r(ENTRY item, ACTION action, ENTRY ** retval,
c4e0057f 306 struct hsearch_data *htab, int flag)
a6826fbc
WD
307{
308 unsigned int hval;
309 unsigned int count;
310 unsigned int len = strlen(item.key);
311 unsigned int idx;
c81c1222 312 unsigned int first_deleted = 0;
3d3b52f2 313 int ret;
a6826fbc
WD
314
315 /* Compute an value for the given string. Perhaps use a better method. */
316 hval = len;
317 count = len;
318 while (count-- > 0) {
319 hval <<= 4;
320 hval += item.key[count];
321 }
322
323 /*
324 * First hash function:
325 * simply take the modul but prevent zero.
326 */
327 hval %= htab->size;
328 if (hval == 0)
329 ++hval;
330
331 /* The first index tried. */
332 idx = hval;
333
334 if (htab->table[idx].used) {
335 /*
071bc923 336 * Further action might be required according to the
a6826fbc
WD
337 * action value.
338 */
339 unsigned hval2;
340
c81c1222
PB
341 if (htab->table[idx].used == -1
342 && !first_deleted)
343 first_deleted = idx;
344
3d3b52f2
JH
345 ret = _compare_and_overwrite_entry(item, action, retval, htab,
346 flag, hval, idx);
347 if (ret != -1)
348 return ret;
a6826fbc
WD
349
350 /*
351 * Second hash function:
352 * as suggested in [Knuth]
353 */
354 hval2 = 1 + hval % (htab->size - 2);
355
356 do {
357 /*
071bc923
WD
358 * Because SIZE is prime this guarantees to
359 * step through all available indices.
a6826fbc
WD
360 */
361 if (idx <= hval2)
362 idx = htab->size + idx - hval2;
363 else
364 idx -= hval2;
365
366 /*
367 * If we visited all entries leave the loop
368 * unsuccessfully.
369 */
370 if (idx == hval)
371 break;
372
373 /* If entry is found use it. */
3d3b52f2
JH
374 ret = _compare_and_overwrite_entry(item, action, retval,
375 htab, flag, hval, idx);
376 if (ret != -1)
377 return ret;
a6826fbc
WD
378 }
379 while (htab->table[idx].used);
380 }
381
382 /* An empty bucket has been found. */
383 if (action == ENTER) {
384 /*
071bc923
WD
385 * If table is full and another entry should be
386 * entered return with error.
a6826fbc
WD
387 */
388 if (htab->filled == htab->size) {
389 __set_errno(ENOMEM);
390 *retval = NULL;
391 return 0;
392 }
393
394 /*
395 * Create new entry;
396 * create copies of item.key and item.data
397 */
c81c1222
PB
398 if (first_deleted)
399 idx = first_deleted;
400
a6826fbc
WD
401 htab->table[idx].used = hval;
402 htab->table[idx].entry.key = strdup(item.key);
403 htab->table[idx].entry.data = strdup(item.data);
404 if (!htab->table[idx].entry.key ||
405 !htab->table[idx].entry.data) {
406 __set_errno(ENOMEM);
407 *retval = NULL;
408 return 0;
409 }
410
411 ++htab->filled;
412
170ab110
JH
413 /* This is a new entry, so look up a possible callback */
414 env_callback_init(&htab->table[idx].entry);
415
7afcf3a5
JH
416 /* check for permission */
417 if (htab->change_ok != NULL && htab->change_ok(
418 &htab->table[idx].entry, item.data, env_op_create, flag)) {
419 debug("change_ok() rejected setting variable "
420 "%s, skipping it!\n", item.key);
421 _hdelete(item.key, htab, &htab->table[idx].entry, idx);
422 __set_errno(EPERM);
423 *retval = NULL;
424 return 0;
425 }
426
170ab110
JH
427 /* If there is a callback, call it */
428 if (htab->table[idx].entry.callback &&
429 htab->table[idx].entry.callback(item.key, item.data,
430 env_op_create, flag)) {
431 debug("callback() rejected setting variable "
432 "%s, skipping it!\n", item.key);
433 _hdelete(item.key, htab, &htab->table[idx].entry, idx);
434 __set_errno(EINVAL);
435 *retval = NULL;
436 return 0;
437 }
438
a6826fbc
WD
439 /* return new entry */
440 *retval = &htab->table[idx].entry;
441 return 1;
442 }
443
444 __set_errno(ESRCH);
445 *retval = NULL;
446 return 0;
447}
448
449
450/*
451 * hdelete()
452 */
453
454/*
455 * The standard implementation of hsearch(3) does not provide any way
456 * to delete any entries from the hash table. We extend the code to
457 * do that.
458 */
459
7afcf3a5
JH
460static void _hdelete(const char *key, struct hsearch_data *htab, ENTRY *ep,
461 int idx)
462{
463 /* free used ENTRY */
464 debug("hdelete: DELETING key \"%s\"\n", key);
465 free((void *)ep->key);
466 free(ep->data);
170ab110 467 ep->callback = NULL;
7afcf3a5
JH
468 htab->table[idx].used = -1;
469
470 --htab->filled;
471}
472
c4e0057f 473int hdelete_r(const char *key, struct hsearch_data *htab, int flag)
a6826fbc
WD
474{
475 ENTRY e, *ep;
476 int idx;
477
478 debug("hdelete: DELETE key \"%s\"\n", key);
479
480 e.key = (char *)key;
481
c4e0057f
JH
482 idx = hsearch_r(e, FIND, &ep, htab, 0);
483 if (idx == 0) {
a6826fbc
WD
484 __set_errno(ESRCH);
485 return 0; /* not found */
486 }
487
c4e0057f 488 /* Check for permission */
7afcf3a5
JH
489 if (htab->change_ok != NULL &&
490 htab->change_ok(ep, NULL, env_op_delete, flag)) {
491 debug("change_ok() rejected deleting variable "
492 "%s, skipping it!\n", key);
c4e0057f
JH
493 __set_errno(EPERM);
494 return 0;
495 }
496
170ab110
JH
497 /* If there is a callback, call it */
498 if (htab->table[idx].entry.callback &&
499 htab->table[idx].entry.callback(key, NULL, env_op_delete, flag)) {
500 debug("callback() rejected deleting variable "
501 "%s, skipping it!\n", key);
502 __set_errno(EINVAL);
503 return 0;
504 }
505
7afcf3a5 506 _hdelete(key, htab, ep, idx);
a6826fbc
WD
507
508 return 1;
509}
510
511/*
512 * hexport()
513 */
514
7ac2fe2d 515#ifndef CONFIG_SPL_BUILD
a6826fbc
WD
516/*
517 * Export the data stored in the hash table in linearized form.
518 *
519 * Entries are exported as "name=value" strings, separated by an
520 * arbitrary (non-NUL, of course) separator character. This allows to
521 * use this function both when formatting the U-Boot environment for
522 * external storage (using '\0' as separator), but also when using it
523 * for the "printenv" command to print all variables, simply by using
524 * as '\n" as separator. This can also be used for new features like
525 * exporting the environment data as text file, including the option
526 * for later re-import.
527 *
528 * The entries in the result list will be sorted by ascending key
529 * values.
530 *
531 * If the separator character is different from NUL, then any
532 * separator characters and backslash characters in the values will
533 * be escaped by a preceeding backslash in output. This is needed for
534 * example to enable multi-line values, especially when the output
535 * shall later be parsed (for example, for re-import).
536 *
537 * There are several options how the result buffer is handled:
538 *
539 * *resp size
540 * -----------
541 * NULL 0 A string of sufficient length will be allocated.
542 * NULL >0 A string of the size given will be
543 * allocated. An error will be returned if the size is
544 * not sufficient. Any unused bytes in the string will
545 * be '\0'-padded.
546 * !NULL 0 The user-supplied buffer will be used. No length
547 * checking will be performed, i. e. it is assumed that
548 * the buffer size will always be big enough. DANGEROUS.
549 * !NULL >0 The user-supplied buffer will be used. An error will
550 * be returned if the size is not sufficient. Any unused
551 * bytes in the string will be '\0'-padded.
552 */
553
a6826fbc
WD
554static int cmpkey(const void *p1, const void *p2)
555{
556 ENTRY *e1 = *(ENTRY **) p1;
557 ENTRY *e2 = *(ENTRY **) p2;
558
559 return (strcmp(e1->key, e2->key));
560}
561
be11235a 562ssize_t hexport_r(struct hsearch_data *htab, const char sep, int flag,
37f2fe74
WD
563 char **resp, size_t size,
564 int argc, char * const argv[])
a6826fbc
WD
565{
566 ENTRY *list[htab->size];
567 char *res, *p;
568 size_t totlen;
569 int i, n;
570
571 /* Test for correct arguments. */
572 if ((resp == NULL) || (htab == NULL)) {
573 __set_errno(EINVAL);
574 return (-1);
575 }
576
ff856286
SG
577 debug("EXPORT table = %p, htab.size = %d, htab.filled = %d, "
578 "size = %zu\n", htab, htab->size, htab->filled, size);
a6826fbc
WD
579 /*
580 * Pass 1:
581 * search used entries,
582 * save addresses and compute total length
583 */
584 for (i = 1, n = 0, totlen = 0; i <= htab->size; ++i) {
585
c81c1222 586 if (htab->table[i].used > 0) {
a6826fbc 587 ENTRY *ep = &htab->table[i].entry;
37f2fe74
WD
588 int arg, found = 0;
589
590 for (arg = 0; arg < argc; ++arg) {
591 if (strcmp(argv[arg], ep->key) == 0) {
592 found = 1;
593 break;
594 }
595 }
596 if ((argc > 0) && (found == 0))
597 continue;
a6826fbc 598
be11235a
JH
599 if ((flag & H_HIDE_DOT) && ep->key[0] == '.')
600 continue;
601
a6826fbc
WD
602 list[n++] = ep;
603
604 totlen += strlen(ep->key) + 2;
605
606 if (sep == '\0') {
607 totlen += strlen(ep->data);
608 } else { /* check if escapes are needed */
609 char *s = ep->data;
610
611 while (*s) {
612 ++totlen;
613 /* add room for needed escape chars */
614 if ((*s == sep) || (*s == '\\'))
615 ++totlen;
616 ++s;
617 }
618 }
619 totlen += 2; /* for '=' and 'sep' char */
620 }
621 }
622
623#ifdef DEBUG
624 /* Pass 1a: print unsorted list */
625 printf("Unsorted: n=%d\n", n);
626 for (i = 0; i < n; ++i) {
627 printf("\t%3d: %p ==> %-10s => %s\n",
628 i, list[i], list[i]->key, list[i]->data);
629 }
630#endif
631
632 /* Sort list by keys */
633 qsort(list, n, sizeof(ENTRY *), cmpkey);
634
635 /* Check if the user supplied buffer size is sufficient */
636 if (size) {
637 if (size < totlen + 1) { /* provided buffer too small */
ff856286
SG
638 printf("Env export buffer too small: %zu, "
639 "but need %zu\n", size, totlen + 1);
a6826fbc
WD
640 __set_errno(ENOMEM);
641 return (-1);
642 }
643 } else {
644 size = totlen + 1;
645 }
646
647 /* Check if the user provided a buffer */
648 if (*resp) {
649 /* yes; clear it */
650 res = *resp;
651 memset(res, '\0', size);
652 } else {
653 /* no, allocate and clear one */
654 *resp = res = calloc(1, size);
655 if (res == NULL) {
656 __set_errno(ENOMEM);
657 return (-1);
658 }
659 }
660 /*
661 * Pass 2:
662 * export sorted list of result data
663 */
664 for (i = 0, p = res; i < n; ++i) {
84b5e802 665 const char *s;
a6826fbc
WD
666
667 s = list[i]->key;
668 while (*s)
669 *p++ = *s++;
670 *p++ = '=';
671
672 s = list[i]->data;
673
674 while (*s) {
675 if ((*s == sep) || (*s == '\\'))
676 *p++ = '\\'; /* escape */
677 *p++ = *s++;
678 }
679 *p++ = sep;
680 }
681 *p = '\0'; /* terminate result */
682
683 return size;
684}
7ac2fe2d 685#endif
a6826fbc
WD
686
687
688/*
689 * himport()
690 */
691
d5370feb
GF
692/*
693 * Check whether variable 'name' is amongst vars[],
694 * and remove all instances by setting the pointer to NULL
695 */
696static int drop_var_from_set(const char *name, int nvars, char * vars[])
348b1f1c
GF
697{
698 int i = 0;
d5370feb 699 int res = 0;
348b1f1c
GF
700
701 /* No variables specified means process all of them */
702 if (nvars == 0)
703 return 1;
704
705 for (i = 0; i < nvars; i++) {
d5370feb
GF
706 if (vars[i] == NULL)
707 continue;
708 /* If we found it, delete all of them */
709 if (!strcmp(name, vars[i])) {
710 vars[i] = NULL;
711 res = 1;
712 }
348b1f1c 713 }
d5370feb
GF
714 if (!res)
715 debug("Skipping non-listed variable %s\n", name);
348b1f1c 716
d5370feb 717 return res;
348b1f1c
GF
718}
719
a6826fbc
WD
720/*
721 * Import linearized data into hash table.
722 *
723 * This is the inverse function to hexport(): it takes a linear list
724 * of "name=value" pairs and creates hash table entries from it.
725 *
726 * Entries without "value", i. e. consisting of only "name" or
727 * "name=", will cause this entry to be deleted from the hash table.
728 *
729 * The "flag" argument can be used to control the behaviour: when the
730 * H_NOCLEAR bit is set, then an existing hash table will kept, i. e.
731 * new data will be added to an existing hash table; otherwise, old
732 * data will be discarded and a new hash table will be created.
733 *
734 * The separator character for the "name=value" pairs can be selected,
735 * so we both support importing from externally stored environment
736 * data (separated by NUL characters) and from plain text files
737 * (entries separated by newline characters).
738 *
739 * To allow for nicely formatted text input, leading white space
740 * (sequences of SPACE and TAB chars) is ignored, and entries starting
741 * (after removal of any leading white space) with a '#' character are
742 * considered comments and ignored.
743 *
744 * [NOTE: this means that a variable name cannot start with a '#'
745 * character.]
746 *
747 * When using a non-NUL separator character, backslash is used as
748 * escape character in the value part, allowing for example for
749 * multi-line values.
750 *
751 * In theory, arbitrary separator characters can be used, but only
752 * '\0' and '\n' have really been tested.
753 */
754
a6826fbc 755int himport_r(struct hsearch_data *htab,
348b1f1c 756 const char *env, size_t size, const char sep, int flag,
c4e0057f 757 int nvars, char * const vars[])
a6826fbc
WD
758{
759 char *data, *sp, *dp, *name, *value;
d5370feb
GF
760 char *localvars[nvars];
761 int i;
a6826fbc
WD
762
763 /* Test for correct arguments. */
764 if (htab == NULL) {
765 __set_errno(EINVAL);
766 return 0;
767 }
768
769 /* we allocate new space to make sure we can write to the array */
770 if ((data = malloc(size)) == NULL) {
ff856286 771 debug("himport_r: can't malloc %zu bytes\n", size);
a6826fbc
WD
772 __set_errno(ENOMEM);
773 return 0;
774 }
775 memcpy(data, env, size);
776 dp = data;
777
d5370feb
GF
778 /* make a local copy of the list of variables */
779 if (nvars)
780 memcpy(localvars, vars, sizeof(vars[0]) * nvars);
781
a6826fbc
WD
782 if ((flag & H_NOCLEAR) == 0) {
783 /* Destroy old hash table if one exists */
784 debug("Destroy Hash Table: %p table = %p\n", htab,
785 htab->table);
786 if (htab->table)
c4e0057f 787 hdestroy_r(htab);
a6826fbc
WD
788 }
789
790 /*
791 * Create new hash table (if needed). The computation of the hash
792 * table size is based on heuristics: in a sample of some 70+
793 * existing systems we found an average size of 39+ bytes per entry
794 * in the environment (for the whole key=value pair). Assuming a
ea882baf
WD
795 * size of 8 per entry (= safety factor of ~5) should provide enough
796 * safety margin for any existing environment definitions and still
a6826fbc
WD
797 * allow for more than enough dynamic additions. Note that the
798 * "size" argument is supposed to give the maximum enviroment size
ea882baf
WD
799 * (CONFIG_ENV_SIZE). This heuristics will result in
800 * unreasonably large numbers (and thus memory footprint) for
801 * big flash environments (>8,000 entries for 64 KB
fc5fc76b
AB
802 * envrionment size), so we clip it to a reasonable value.
803 * On the other hand we need to add some more entries for free
804 * space when importing very small buffers. Both boundaries can
805 * be overwritten in the board config file if needed.
a6826fbc
WD
806 */
807
808 if (!htab->table) {
fc5fc76b 809 int nent = CONFIG_ENV_MIN_ENTRIES + size / 8;
ea882baf
WD
810
811 if (nent > CONFIG_ENV_MAX_ENTRIES)
812 nent = CONFIG_ENV_MAX_ENTRIES;
a6826fbc
WD
813
814 debug("Create Hash Table: N=%d\n", nent);
815
816 if (hcreate_r(nent, htab) == 0) {
817 free(data);
818 return 0;
819 }
820 }
821
822 /* Parse environment; allow for '\0' and 'sep' as separators */
823 do {
824 ENTRY e, *rv;
825
826 /* skip leading white space */
4d91a6ec 827 while (isblank(*dp))
a6826fbc
WD
828 ++dp;
829
830 /* skip comment lines */
831 if (*dp == '#') {
832 while (*dp && (*dp != sep))
833 ++dp;
834 ++dp;
835 continue;
836 }
837
838 /* parse name */
839 for (name = dp; *dp != '=' && *dp && *dp != sep; ++dp)
840 ;
841
842 /* deal with "name" and "name=" entries (delete var) */
843 if (*dp == '\0' || *(dp + 1) == '\0' ||
844 *dp == sep || *(dp + 1) == sep) {
845 if (*dp == '=')
846 *dp++ = '\0';
847 *dp++ = '\0'; /* terminate name */
848
849 debug("DELETE CANDIDATE: \"%s\"\n", name);
d5370feb 850 if (!drop_var_from_set(name, nvars, localvars))
348b1f1c 851 continue;
a6826fbc 852
c4e0057f 853 if (hdelete_r(name, htab, flag) == 0)
a6826fbc
WD
854 debug("DELETE ERROR ##############################\n");
855
856 continue;
857 }
858 *dp++ = '\0'; /* terminate name */
859
860 /* parse value; deal with escapes */
861 for (value = sp = dp; *dp && (*dp != sep); ++dp) {
862 if ((*dp == '\\') && *(dp + 1))
863 ++dp;
864 *sp++ = *dp;
865 }
866 *sp++ = '\0'; /* terminate value */
867 ++dp;
868
348b1f1c 869 /* Skip variables which are not supposed to be processed */
d5370feb 870 if (!drop_var_from_set(name, nvars, localvars))
348b1f1c
GF
871 continue;
872
a6826fbc
WD
873 /* enter into hash table */
874 e.key = name;
875 e.data = value;
876
c4e0057f 877 hsearch_r(e, ENTER, &rv, htab, flag);
170ab110 878 if (rv == NULL)
ea882baf
WD
879 printf("himport_r: can't insert \"%s=%s\" into hash table\n",
880 name, value);
a6826fbc 881
ea882baf
WD
882 debug("INSERT: table %p, filled %d/%d rv %p ==> name=\"%s\" value=\"%s\"\n",
883 htab, htab->filled, htab->size,
884 rv, name, value);
a6826fbc
WD
885 } while ((dp < data + size) && *dp); /* size check needed for text */
886 /* without '\0' termination */
ea882baf 887 debug("INSERT: free(data = %p)\n", data);
a6826fbc
WD
888 free(data);
889
d5370feb
GF
890 /* process variables which were not considered */
891 for (i = 0; i < nvars; i++) {
892 if (localvars[i] == NULL)
893 continue;
894 /*
895 * All variables which were not deleted from the variable list
896 * were not present in the imported env
897 * This could mean two things:
898 * a) if the variable was present in current env, we delete it
899 * b) if the variable was not present in current env, we notify
900 * it might be a typo
901 */
c4e0057f 902 if (hdelete_r(localvars[i], htab, flag) == 0)
d5370feb
GF
903 printf("WARNING: '%s' neither in running nor in imported env!\n", localvars[i]);
904 else
905 printf("WARNING: '%s' not in imported env, deleting it!\n", localvars[i]);
906 }
907
ea882baf 908 debug("INSERT: done\n");
a6826fbc
WD
909 return 1; /* everything OK */
910}
170ab110
JH
911
912/*
913 * hwalk_r()
914 */
915
916/*
917 * Walk all of the entries in the hash, calling the callback for each one.
918 * this allows some generic operation to be performed on each element.
919 */
920int hwalk_r(struct hsearch_data *htab, int (*callback)(ENTRY *))
921{
922 int i;
923 int retval;
924
925 for (i = 1; i <= htab->size; ++i) {
926 if (htab->table[i].used > 0) {
927 retval = callback(&htab->table[i].entry);
928 if (retval)
929 return retval;
930 }
931 }
932
933 return 0;
934}