xref: /rk3399_rockchip-uboot/lib/hashtable.c (revision 2598090b7e17f8bdca95b22e7f27217054730e02)
1a6826fbcSWolfgang Denk /*
2a6826fbcSWolfgang Denk  * This implementation is based on code from uClibc-0.9.30.3 but was
3a6826fbcSWolfgang Denk  * modified and extended for use within U-Boot.
4a6826fbcSWolfgang Denk  *
5a6826fbcSWolfgang Denk  * Copyright (C) 2010 Wolfgang Denk <wd@denx.de>
6a6826fbcSWolfgang Denk  *
7a6826fbcSWolfgang Denk  * Original license header:
8a6826fbcSWolfgang Denk  *
9a6826fbcSWolfgang Denk  * Copyright (C) 1993, 1995, 1996, 1997, 2002 Free Software Foundation, Inc.
10a6826fbcSWolfgang Denk  * This file is part of the GNU C Library.
11a6826fbcSWolfgang Denk  * Contributed by Ulrich Drepper <drepper@gnu.ai.mit.edu>, 1993.
12a6826fbcSWolfgang Denk  *
13a6826fbcSWolfgang Denk  * The GNU C Library is free software; you can redistribute it and/or
14a6826fbcSWolfgang Denk  * modify it under the terms of the GNU Lesser General Public
15a6826fbcSWolfgang Denk  * License as published by the Free Software Foundation; either
16a6826fbcSWolfgang Denk  * version 2.1 of the License, or (at your option) any later version.
17a6826fbcSWolfgang Denk  *
18a6826fbcSWolfgang Denk  * The GNU C Library is distributed in the hope that it will be useful,
19a6826fbcSWolfgang Denk  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20a6826fbcSWolfgang Denk  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21a6826fbcSWolfgang Denk  * Lesser General Public License for more details.
22a6826fbcSWolfgang Denk  *
23a6826fbcSWolfgang Denk  * You should have received a copy of the GNU Lesser General Public
24a6826fbcSWolfgang Denk  * License along with the GNU C Library; if not, write to the Free
25a6826fbcSWolfgang Denk  * Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
26a6826fbcSWolfgang Denk  * 02111-1307 USA.
27a6826fbcSWolfgang Denk  */
28a6826fbcSWolfgang Denk 
29a6826fbcSWolfgang Denk #include <errno.h>
30a6826fbcSWolfgang Denk #include <malloc.h>
31a6826fbcSWolfgang Denk 
32a6826fbcSWolfgang Denk #ifdef USE_HOSTCC		/* HOST build */
33a6826fbcSWolfgang Denk # include <string.h>
34a6826fbcSWolfgang Denk # include <assert.h>
354d91a6ecSJason Hobbs # include <ctype.h>
36a6826fbcSWolfgang Denk 
37a6826fbcSWolfgang Denk # ifndef debug
38a6826fbcSWolfgang Denk #  ifdef DEBUG
39a6826fbcSWolfgang Denk #   define debug(fmt,args...)	printf(fmt ,##args)
40a6826fbcSWolfgang Denk #  else
41a6826fbcSWolfgang Denk #   define debug(fmt,args...)
42a6826fbcSWolfgang Denk #  endif
43a6826fbcSWolfgang Denk # endif
44a6826fbcSWolfgang Denk #else				/* U-Boot build */
45a6826fbcSWolfgang Denk # include <common.h>
46a6826fbcSWolfgang Denk # include <linux/string.h>
474d91a6ecSJason Hobbs # include <linux/ctype.h>
48a6826fbcSWolfgang Denk #endif
49a6826fbcSWolfgang Denk 
50fc5fc76bSAndreas Bießmann #ifndef	CONFIG_ENV_MIN_ENTRIES	/* minimum number of entries */
51fc5fc76bSAndreas Bießmann #define	CONFIG_ENV_MIN_ENTRIES 64
52fc5fc76bSAndreas Bießmann #endif
53ea882bafSWolfgang Denk #ifndef	CONFIG_ENV_MAX_ENTRIES	/* maximum number of entries */
54ea882bafSWolfgang Denk #define	CONFIG_ENV_MAX_ENTRIES 512
55ea882bafSWolfgang Denk #endif
56ea882bafSWolfgang Denk 
57170ab110SJoe Hershberger #include <env_callback.h>
58*2598090bSJoe Hershberger #include <env_flags.h>
59170ab110SJoe Hershberger #include <search.h>
60a6826fbcSWolfgang Denk 
61a6826fbcSWolfgang Denk /*
62a6826fbcSWolfgang Denk  * [Aho,Sethi,Ullman] Compilers: Principles, Techniques and Tools, 1986
63a6826fbcSWolfgang Denk  * [Knuth]	      The Art of Computer Programming, part 3 (6.4)
64a6826fbcSWolfgang Denk  */
65a6826fbcSWolfgang Denk 
66a6826fbcSWolfgang Denk /*
67a6826fbcSWolfgang Denk  * The reentrant version has no static variables to maintain the state.
68a6826fbcSWolfgang Denk  * Instead the interface of all functions is extended to take an argument
69a6826fbcSWolfgang Denk  * which describes the current status.
70a6826fbcSWolfgang Denk  */
717afcf3a5SJoe Hershberger 
72a6826fbcSWolfgang Denk typedef struct _ENTRY {
73c81c1222SPeter Barada 	int used;
74a6826fbcSWolfgang Denk 	ENTRY entry;
75a6826fbcSWolfgang Denk } _ENTRY;
76a6826fbcSWolfgang Denk 
77a6826fbcSWolfgang Denk 
787afcf3a5SJoe Hershberger static void _hdelete(const char *key, struct hsearch_data *htab, ENTRY *ep,
797afcf3a5SJoe Hershberger 	int idx);
807afcf3a5SJoe Hershberger 
81a6826fbcSWolfgang Denk /*
82a6826fbcSWolfgang Denk  * hcreate()
83a6826fbcSWolfgang Denk  */
84a6826fbcSWolfgang Denk 
85a6826fbcSWolfgang Denk /*
86a6826fbcSWolfgang Denk  * For the used double hash method the table size has to be a prime. To
87a6826fbcSWolfgang Denk  * correct the user given table size we need a prime test.  This trivial
88a6826fbcSWolfgang Denk  * algorithm is adequate because
89a6826fbcSWolfgang Denk  * a)  the code is (most probably) called a few times per program run and
90a6826fbcSWolfgang Denk  * b)  the number is small because the table must fit in the core
91a6826fbcSWolfgang Denk  * */
92a6826fbcSWolfgang Denk static int isprime(unsigned int number)
93a6826fbcSWolfgang Denk {
94a6826fbcSWolfgang Denk 	/* no even number will be passed */
95a6826fbcSWolfgang Denk 	unsigned int div = 3;
96a6826fbcSWolfgang Denk 
97a6826fbcSWolfgang Denk 	while (div * div < number && number % div != 0)
98a6826fbcSWolfgang Denk 		div += 2;
99a6826fbcSWolfgang Denk 
100a6826fbcSWolfgang Denk 	return number % div != 0;
101a6826fbcSWolfgang Denk }
102a6826fbcSWolfgang Denk 
103a6826fbcSWolfgang Denk /*
104a6826fbcSWolfgang Denk  * Before using the hash table we must allocate memory for it.
105a6826fbcSWolfgang Denk  * Test for an existing table are done. We allocate one element
106a6826fbcSWolfgang Denk  * more as the found prime number says. This is done for more effective
107a6826fbcSWolfgang Denk  * indexing as explained in the comment for the hsearch function.
108a6826fbcSWolfgang Denk  * The contents of the table is zeroed, especially the field used
109a6826fbcSWolfgang Denk  * becomes zero.
110a6826fbcSWolfgang Denk  */
1112eb1573fSMike Frysinger 
112a6826fbcSWolfgang Denk int hcreate_r(size_t nel, struct hsearch_data *htab)
113a6826fbcSWolfgang Denk {
114a6826fbcSWolfgang Denk 	/* Test for correct arguments.  */
115a6826fbcSWolfgang Denk 	if (htab == NULL) {
116a6826fbcSWolfgang Denk 		__set_errno(EINVAL);
117a6826fbcSWolfgang Denk 		return 0;
118a6826fbcSWolfgang Denk 	}
119a6826fbcSWolfgang Denk 
120a6826fbcSWolfgang Denk 	/* There is still another table active. Return with error. */
121a6826fbcSWolfgang Denk 	if (htab->table != NULL)
122a6826fbcSWolfgang Denk 		return 0;
123a6826fbcSWolfgang Denk 
124a6826fbcSWolfgang Denk 	/* Change nel to the first prime number not smaller as nel. */
125a6826fbcSWolfgang Denk 	nel |= 1;		/* make odd */
126a6826fbcSWolfgang Denk 	while (!isprime(nel))
127a6826fbcSWolfgang Denk 		nel += 2;
128a6826fbcSWolfgang Denk 
129a6826fbcSWolfgang Denk 	htab->size = nel;
130a6826fbcSWolfgang Denk 	htab->filled = 0;
131a6826fbcSWolfgang Denk 
132a6826fbcSWolfgang Denk 	/* allocate memory and zero out */
133a6826fbcSWolfgang Denk 	htab->table = (_ENTRY *) calloc(htab->size + 1, sizeof(_ENTRY));
134a6826fbcSWolfgang Denk 	if (htab->table == NULL)
135a6826fbcSWolfgang Denk 		return 0;
136a6826fbcSWolfgang Denk 
137a6826fbcSWolfgang Denk 	/* everything went alright */
138a6826fbcSWolfgang Denk 	return 1;
139a6826fbcSWolfgang Denk }
140a6826fbcSWolfgang Denk 
141a6826fbcSWolfgang Denk 
142a6826fbcSWolfgang Denk /*
143a6826fbcSWolfgang Denk  * hdestroy()
144a6826fbcSWolfgang Denk  */
145a6826fbcSWolfgang Denk 
146a6826fbcSWolfgang Denk /*
147a6826fbcSWolfgang Denk  * After using the hash table it has to be destroyed. The used memory can
148a6826fbcSWolfgang Denk  * be freed and the local static variable can be marked as not used.
149a6826fbcSWolfgang Denk  */
1502eb1573fSMike Frysinger 
151c4e0057fSJoe Hershberger void hdestroy_r(struct hsearch_data *htab)
152a6826fbcSWolfgang Denk {
153a6826fbcSWolfgang Denk 	int i;
154a6826fbcSWolfgang Denk 
155a6826fbcSWolfgang Denk 	/* Test for correct arguments.  */
156a6826fbcSWolfgang Denk 	if (htab == NULL) {
157a6826fbcSWolfgang Denk 		__set_errno(EINVAL);
158a6826fbcSWolfgang Denk 		return;
159a6826fbcSWolfgang Denk 	}
160a6826fbcSWolfgang Denk 
161a6826fbcSWolfgang Denk 	/* free used memory */
162a6826fbcSWolfgang Denk 	for (i = 1; i <= htab->size; ++i) {
163c81c1222SPeter Barada 		if (htab->table[i].used > 0) {
164a6826fbcSWolfgang Denk 			ENTRY *ep = &htab->table[i].entry;
165c4e0057fSJoe Hershberger 
16684b5e802SWolfgang Denk 			free((void *)ep->key);
167a6826fbcSWolfgang Denk 			free(ep->data);
168a6826fbcSWolfgang Denk 		}
169a6826fbcSWolfgang Denk 	}
170a6826fbcSWolfgang Denk 	free(htab->table);
171a6826fbcSWolfgang Denk 
172a6826fbcSWolfgang Denk 	/* the sign for an existing table is an value != NULL in htable */
173a6826fbcSWolfgang Denk 	htab->table = NULL;
174a6826fbcSWolfgang Denk }
175a6826fbcSWolfgang Denk 
176a6826fbcSWolfgang Denk /*
177a6826fbcSWolfgang Denk  * hsearch()
178a6826fbcSWolfgang Denk  */
179a6826fbcSWolfgang Denk 
180a6826fbcSWolfgang Denk /*
181a6826fbcSWolfgang Denk  * This is the search function. It uses double hashing with open addressing.
182a6826fbcSWolfgang Denk  * The argument item.key has to be a pointer to an zero terminated, most
183a6826fbcSWolfgang Denk  * probably strings of chars. The function for generating a number of the
184a6826fbcSWolfgang Denk  * strings is simple but fast. It can be replaced by a more complex function
185a6826fbcSWolfgang Denk  * like ajw (see [Aho,Sethi,Ullman]) if the needs are shown.
186a6826fbcSWolfgang Denk  *
187a6826fbcSWolfgang Denk  * We use an trick to speed up the lookup. The table is created by hcreate
188a6826fbcSWolfgang Denk  * with one more element available. This enables us to use the index zero
189a6826fbcSWolfgang Denk  * special. This index will never be used because we store the first hash
190a6826fbcSWolfgang Denk  * index in the field used where zero means not used. Every other value
191a6826fbcSWolfgang Denk  * means used. The used field can be used as a first fast comparison for
192a6826fbcSWolfgang Denk  * equality of the stored and the parameter value. This helps to prevent
193a6826fbcSWolfgang Denk  * unnecessary expensive calls of strcmp.
194a6826fbcSWolfgang Denk  *
195a6826fbcSWolfgang Denk  * This implementation differs from the standard library version of
196a6826fbcSWolfgang Denk  * this function in a number of ways:
197a6826fbcSWolfgang Denk  *
198a6826fbcSWolfgang Denk  * - While the standard version does not make any assumptions about
199a6826fbcSWolfgang Denk  *   the type of the stored data objects at all, this implementation
200a6826fbcSWolfgang Denk  *   works with NUL terminated strings only.
201a6826fbcSWolfgang Denk  * - Instead of storing just pointers to the original objects, we
202a6826fbcSWolfgang Denk  *   create local copies so the caller does not need to care about the
203a6826fbcSWolfgang Denk  *   data any more.
204a6826fbcSWolfgang Denk  * - The standard implementation does not provide a way to update an
205a6826fbcSWolfgang Denk  *   existing entry.  This version will create a new entry or update an
206a6826fbcSWolfgang Denk  *   existing one when both "action == ENTER" and "item.data != NULL".
207a6826fbcSWolfgang Denk  * - Instead of returning 1 on success, we return the index into the
208a6826fbcSWolfgang Denk  *   internal hash table, which is also guaranteed to be positive.
209a6826fbcSWolfgang Denk  *   This allows us direct access to the found hash table slot for
210a6826fbcSWolfgang Denk  *   example for functions like hdelete().
211a6826fbcSWolfgang Denk  */
212a6826fbcSWolfgang Denk 
213a000b795SKim Phillips /*
214a000b795SKim Phillips  * hstrstr_r - return index to entry whose key and/or data contains match
215a000b795SKim Phillips  */
216a000b795SKim Phillips int hstrstr_r(const char *match, int last_idx, ENTRY ** retval,
217a000b795SKim Phillips 	      struct hsearch_data *htab)
218a000b795SKim Phillips {
219a000b795SKim Phillips 	unsigned int idx;
220a000b795SKim Phillips 
221a000b795SKim Phillips 	for (idx = last_idx + 1; idx < htab->size; ++idx) {
222a000b795SKim Phillips 		if (htab->table[idx].used <= 0)
223a000b795SKim Phillips 			continue;
224a000b795SKim Phillips 		if (strstr(htab->table[idx].entry.key, match) ||
225a000b795SKim Phillips 		    strstr(htab->table[idx].entry.data, match)) {
226a000b795SKim Phillips 			*retval = &htab->table[idx].entry;
227a000b795SKim Phillips 			return idx;
228a000b795SKim Phillips 		}
229a000b795SKim Phillips 	}
230a000b795SKim Phillips 
231a000b795SKim Phillips 	__set_errno(ESRCH);
232a000b795SKim Phillips 	*retval = NULL;
233a000b795SKim Phillips 	return 0;
234a000b795SKim Phillips }
235a000b795SKim Phillips 
236560d424bSMike Frysinger int hmatch_r(const char *match, int last_idx, ENTRY ** retval,
237560d424bSMike Frysinger 	     struct hsearch_data *htab)
238560d424bSMike Frysinger {
239560d424bSMike Frysinger 	unsigned int idx;
240560d424bSMike Frysinger 	size_t key_len = strlen(match);
241560d424bSMike Frysinger 
242560d424bSMike Frysinger 	for (idx = last_idx + 1; idx < htab->size; ++idx) {
243af4d9074SKim Phillips 		if (htab->table[idx].used <= 0)
244560d424bSMike Frysinger 			continue;
245560d424bSMike Frysinger 		if (!strncmp(match, htab->table[idx].entry.key, key_len)) {
246560d424bSMike Frysinger 			*retval = &htab->table[idx].entry;
247560d424bSMike Frysinger 			return idx;
248560d424bSMike Frysinger 		}
249560d424bSMike Frysinger 	}
250560d424bSMike Frysinger 
251560d424bSMike Frysinger 	__set_errno(ESRCH);
252560d424bSMike Frysinger 	*retval = NULL;
253560d424bSMike Frysinger 	return 0;
254560d424bSMike Frysinger }
255560d424bSMike Frysinger 
2563d3b52f2SJoe Hershberger /*
2573d3b52f2SJoe Hershberger  * Compare an existing entry with the desired key, and overwrite if the action
2583d3b52f2SJoe Hershberger  * is ENTER.  This is simply a helper function for hsearch_r().
2593d3b52f2SJoe Hershberger  */
2603d3b52f2SJoe Hershberger static inline int _compare_and_overwrite_entry(ENTRY item, ACTION action,
2613d3b52f2SJoe Hershberger 	ENTRY **retval, struct hsearch_data *htab, int flag,
2623d3b52f2SJoe Hershberger 	unsigned int hval, unsigned int idx)
2633d3b52f2SJoe Hershberger {
2643d3b52f2SJoe Hershberger 	if (htab->table[idx].used == hval
2653d3b52f2SJoe Hershberger 	    && strcmp(item.key, htab->table[idx].entry.key) == 0) {
2663d3b52f2SJoe Hershberger 		/* Overwrite existing value? */
2673d3b52f2SJoe Hershberger 		if ((action == ENTER) && (item.data != NULL)) {
2687afcf3a5SJoe Hershberger 			/* check for permission */
2697afcf3a5SJoe Hershberger 			if (htab->change_ok != NULL && htab->change_ok(
2707afcf3a5SJoe Hershberger 			    &htab->table[idx].entry, item.data,
2717afcf3a5SJoe Hershberger 			    env_op_overwrite, flag)) {
2727afcf3a5SJoe Hershberger 				debug("change_ok() rejected setting variable "
2737afcf3a5SJoe Hershberger 					"%s, skipping it!\n", item.key);
2747afcf3a5SJoe Hershberger 				__set_errno(EPERM);
2757afcf3a5SJoe Hershberger 				*retval = NULL;
2767afcf3a5SJoe Hershberger 				return 0;
2777afcf3a5SJoe Hershberger 			}
2787afcf3a5SJoe Hershberger 
279170ab110SJoe Hershberger 			/* If there is a callback, call it */
280170ab110SJoe Hershberger 			if (htab->table[idx].entry.callback &&
281170ab110SJoe Hershberger 			    htab->table[idx].entry.callback(item.key,
282170ab110SJoe Hershberger 			    item.data, env_op_overwrite, flag)) {
283170ab110SJoe Hershberger 				debug("callback() rejected setting variable "
284170ab110SJoe Hershberger 					"%s, skipping it!\n", item.key);
285170ab110SJoe Hershberger 				__set_errno(EINVAL);
286170ab110SJoe Hershberger 				*retval = NULL;
287170ab110SJoe Hershberger 				return 0;
288170ab110SJoe Hershberger 			}
289170ab110SJoe Hershberger 
2903d3b52f2SJoe Hershberger 			free(htab->table[idx].entry.data);
2913d3b52f2SJoe Hershberger 			htab->table[idx].entry.data = strdup(item.data);
2923d3b52f2SJoe Hershberger 			if (!htab->table[idx].entry.data) {
2933d3b52f2SJoe Hershberger 				__set_errno(ENOMEM);
2943d3b52f2SJoe Hershberger 				*retval = NULL;
2953d3b52f2SJoe Hershberger 				return 0;
2963d3b52f2SJoe Hershberger 			}
2973d3b52f2SJoe Hershberger 		}
2983d3b52f2SJoe Hershberger 		/* return found entry */
2993d3b52f2SJoe Hershberger 		*retval = &htab->table[idx].entry;
3003d3b52f2SJoe Hershberger 		return idx;
3013d3b52f2SJoe Hershberger 	}
3023d3b52f2SJoe Hershberger 	/* keep searching */
3033d3b52f2SJoe Hershberger 	return -1;
3043d3b52f2SJoe Hershberger }
3053d3b52f2SJoe Hershberger 
306a6826fbcSWolfgang Denk int hsearch_r(ENTRY item, ACTION action, ENTRY ** retval,
307c4e0057fSJoe Hershberger 	      struct hsearch_data *htab, int flag)
308a6826fbcSWolfgang Denk {
309a6826fbcSWolfgang Denk 	unsigned int hval;
310a6826fbcSWolfgang Denk 	unsigned int count;
311a6826fbcSWolfgang Denk 	unsigned int len = strlen(item.key);
312a6826fbcSWolfgang Denk 	unsigned int idx;
313c81c1222SPeter Barada 	unsigned int first_deleted = 0;
3143d3b52f2SJoe Hershberger 	int ret;
315a6826fbcSWolfgang Denk 
316a6826fbcSWolfgang Denk 	/* Compute an value for the given string. Perhaps use a better method. */
317a6826fbcSWolfgang Denk 	hval = len;
318a6826fbcSWolfgang Denk 	count = len;
319a6826fbcSWolfgang Denk 	while (count-- > 0) {
320a6826fbcSWolfgang Denk 		hval <<= 4;
321a6826fbcSWolfgang Denk 		hval += item.key[count];
322a6826fbcSWolfgang Denk 	}
323a6826fbcSWolfgang Denk 
324a6826fbcSWolfgang Denk 	/*
325a6826fbcSWolfgang Denk 	 * First hash function:
326a6826fbcSWolfgang Denk 	 * simply take the modul but prevent zero.
327a6826fbcSWolfgang Denk 	 */
328a6826fbcSWolfgang Denk 	hval %= htab->size;
329a6826fbcSWolfgang Denk 	if (hval == 0)
330a6826fbcSWolfgang Denk 		++hval;
331a6826fbcSWolfgang Denk 
332a6826fbcSWolfgang Denk 	/* The first index tried. */
333a6826fbcSWolfgang Denk 	idx = hval;
334a6826fbcSWolfgang Denk 
335a6826fbcSWolfgang Denk 	if (htab->table[idx].used) {
336a6826fbcSWolfgang Denk 		/*
337a6826fbcSWolfgang Denk 		 * Further action might be required according to the
338a6826fbcSWolfgang Denk 		 * action value.
339a6826fbcSWolfgang Denk 		 */
340a6826fbcSWolfgang Denk 		unsigned hval2;
341a6826fbcSWolfgang Denk 
342c81c1222SPeter Barada 		if (htab->table[idx].used == -1
343c81c1222SPeter Barada 		    && !first_deleted)
344c81c1222SPeter Barada 			first_deleted = idx;
345c81c1222SPeter Barada 
3463d3b52f2SJoe Hershberger 		ret = _compare_and_overwrite_entry(item, action, retval, htab,
3473d3b52f2SJoe Hershberger 			flag, hval, idx);
3483d3b52f2SJoe Hershberger 		if (ret != -1)
3493d3b52f2SJoe Hershberger 			return ret;
350a6826fbcSWolfgang Denk 
351a6826fbcSWolfgang Denk 		/*
352a6826fbcSWolfgang Denk 		 * Second hash function:
353a6826fbcSWolfgang Denk 		 * as suggested in [Knuth]
354a6826fbcSWolfgang Denk 		 */
355a6826fbcSWolfgang Denk 		hval2 = 1 + hval % (htab->size - 2);
356a6826fbcSWolfgang Denk 
357a6826fbcSWolfgang Denk 		do {
358a6826fbcSWolfgang Denk 			/*
359a6826fbcSWolfgang Denk 			 * Because SIZE is prime this guarantees to
360a6826fbcSWolfgang Denk 			 * step through all available indices.
361a6826fbcSWolfgang Denk 			 */
362a6826fbcSWolfgang Denk 			if (idx <= hval2)
363a6826fbcSWolfgang Denk 				idx = htab->size + idx - hval2;
364a6826fbcSWolfgang Denk 			else
365a6826fbcSWolfgang Denk 				idx -= hval2;
366a6826fbcSWolfgang Denk 
367a6826fbcSWolfgang Denk 			/*
368a6826fbcSWolfgang Denk 			 * If we visited all entries leave the loop
369a6826fbcSWolfgang Denk 			 * unsuccessfully.
370a6826fbcSWolfgang Denk 			 */
371a6826fbcSWolfgang Denk 			if (idx == hval)
372a6826fbcSWolfgang Denk 				break;
373a6826fbcSWolfgang Denk 
374a6826fbcSWolfgang Denk 			/* If entry is found use it. */
3753d3b52f2SJoe Hershberger 			ret = _compare_and_overwrite_entry(item, action, retval,
3763d3b52f2SJoe Hershberger 				htab, flag, hval, idx);
3773d3b52f2SJoe Hershberger 			if (ret != -1)
3783d3b52f2SJoe Hershberger 				return ret;
379a6826fbcSWolfgang Denk 		}
380a6826fbcSWolfgang Denk 		while (htab->table[idx].used);
381a6826fbcSWolfgang Denk 	}
382a6826fbcSWolfgang Denk 
383a6826fbcSWolfgang Denk 	/* An empty bucket has been found. */
384a6826fbcSWolfgang Denk 	if (action == ENTER) {
385a6826fbcSWolfgang Denk 		/*
386a6826fbcSWolfgang Denk 		 * If table is full and another entry should be
387a6826fbcSWolfgang Denk 		 * entered return with error.
388a6826fbcSWolfgang Denk 		 */
389a6826fbcSWolfgang Denk 		if (htab->filled == htab->size) {
390a6826fbcSWolfgang Denk 			__set_errno(ENOMEM);
391a6826fbcSWolfgang Denk 			*retval = NULL;
392a6826fbcSWolfgang Denk 			return 0;
393a6826fbcSWolfgang Denk 		}
394a6826fbcSWolfgang Denk 
395a6826fbcSWolfgang Denk 		/*
396a6826fbcSWolfgang Denk 		 * Create new entry;
397a6826fbcSWolfgang Denk 		 * create copies of item.key and item.data
398a6826fbcSWolfgang Denk 		 */
399c81c1222SPeter Barada 		if (first_deleted)
400c81c1222SPeter Barada 			idx = first_deleted;
401c81c1222SPeter Barada 
402a6826fbcSWolfgang Denk 		htab->table[idx].used = hval;
403a6826fbcSWolfgang Denk 		htab->table[idx].entry.key = strdup(item.key);
404a6826fbcSWolfgang Denk 		htab->table[idx].entry.data = strdup(item.data);
405a6826fbcSWolfgang Denk 		if (!htab->table[idx].entry.key ||
406a6826fbcSWolfgang Denk 		    !htab->table[idx].entry.data) {
407a6826fbcSWolfgang Denk 			__set_errno(ENOMEM);
408a6826fbcSWolfgang Denk 			*retval = NULL;
409a6826fbcSWolfgang Denk 			return 0;
410a6826fbcSWolfgang Denk 		}
411a6826fbcSWolfgang Denk 
412a6826fbcSWolfgang Denk 		++htab->filled;
413a6826fbcSWolfgang Denk 
414170ab110SJoe Hershberger 		/* This is a new entry, so look up a possible callback */
415170ab110SJoe Hershberger 		env_callback_init(&htab->table[idx].entry);
416*2598090bSJoe Hershberger 		/* Also look for flags */
417*2598090bSJoe Hershberger 		env_flags_init(&htab->table[idx].entry);
418170ab110SJoe Hershberger 
4197afcf3a5SJoe Hershberger 		/* check for permission */
4207afcf3a5SJoe Hershberger 		if (htab->change_ok != NULL && htab->change_ok(
4217afcf3a5SJoe Hershberger 		    &htab->table[idx].entry, item.data, env_op_create, flag)) {
4227afcf3a5SJoe Hershberger 			debug("change_ok() rejected setting variable "
4237afcf3a5SJoe Hershberger 				"%s, skipping it!\n", item.key);
4247afcf3a5SJoe Hershberger 			_hdelete(item.key, htab, &htab->table[idx].entry, idx);
4257afcf3a5SJoe Hershberger 			__set_errno(EPERM);
4267afcf3a5SJoe Hershberger 			*retval = NULL;
4277afcf3a5SJoe Hershberger 			return 0;
4287afcf3a5SJoe Hershberger 		}
4297afcf3a5SJoe Hershberger 
430170ab110SJoe Hershberger 		/* If there is a callback, call it */
431170ab110SJoe Hershberger 		if (htab->table[idx].entry.callback &&
432170ab110SJoe Hershberger 		    htab->table[idx].entry.callback(item.key, item.data,
433170ab110SJoe Hershberger 		    env_op_create, flag)) {
434170ab110SJoe Hershberger 			debug("callback() rejected setting variable "
435170ab110SJoe Hershberger 				"%s, skipping it!\n", item.key);
436170ab110SJoe Hershberger 			_hdelete(item.key, htab, &htab->table[idx].entry, idx);
437170ab110SJoe Hershberger 			__set_errno(EINVAL);
438170ab110SJoe Hershberger 			*retval = NULL;
439170ab110SJoe Hershberger 			return 0;
440170ab110SJoe Hershberger 		}
441170ab110SJoe Hershberger 
442a6826fbcSWolfgang Denk 		/* return new entry */
443a6826fbcSWolfgang Denk 		*retval = &htab->table[idx].entry;
444a6826fbcSWolfgang Denk 		return 1;
445a6826fbcSWolfgang Denk 	}
446a6826fbcSWolfgang Denk 
447a6826fbcSWolfgang Denk 	__set_errno(ESRCH);
448a6826fbcSWolfgang Denk 	*retval = NULL;
449a6826fbcSWolfgang Denk 	return 0;
450a6826fbcSWolfgang Denk }
451a6826fbcSWolfgang Denk 
452a6826fbcSWolfgang Denk 
453a6826fbcSWolfgang Denk /*
454a6826fbcSWolfgang Denk  * hdelete()
455a6826fbcSWolfgang Denk  */
456a6826fbcSWolfgang Denk 
457a6826fbcSWolfgang Denk /*
458a6826fbcSWolfgang Denk  * The standard implementation of hsearch(3) does not provide any way
459a6826fbcSWolfgang Denk  * to delete any entries from the hash table.  We extend the code to
460a6826fbcSWolfgang Denk  * do that.
461a6826fbcSWolfgang Denk  */
462a6826fbcSWolfgang Denk 
4637afcf3a5SJoe Hershberger static void _hdelete(const char *key, struct hsearch_data *htab, ENTRY *ep,
4647afcf3a5SJoe Hershberger 	int idx)
4657afcf3a5SJoe Hershberger {
4667afcf3a5SJoe Hershberger 	/* free used ENTRY */
4677afcf3a5SJoe Hershberger 	debug("hdelete: DELETING key \"%s\"\n", key);
4687afcf3a5SJoe Hershberger 	free((void *)ep->key);
4697afcf3a5SJoe Hershberger 	free(ep->data);
470170ab110SJoe Hershberger 	ep->callback = NULL;
471*2598090bSJoe Hershberger 	ep->flags = 0;
4727afcf3a5SJoe Hershberger 	htab->table[idx].used = -1;
4737afcf3a5SJoe Hershberger 
4747afcf3a5SJoe Hershberger 	--htab->filled;
4757afcf3a5SJoe Hershberger }
4767afcf3a5SJoe Hershberger 
477c4e0057fSJoe Hershberger int hdelete_r(const char *key, struct hsearch_data *htab, int flag)
478a6826fbcSWolfgang Denk {
479a6826fbcSWolfgang Denk 	ENTRY e, *ep;
480a6826fbcSWolfgang Denk 	int idx;
481a6826fbcSWolfgang Denk 
482a6826fbcSWolfgang Denk 	debug("hdelete: DELETE key \"%s\"\n", key);
483a6826fbcSWolfgang Denk 
484a6826fbcSWolfgang Denk 	e.key = (char *)key;
485a6826fbcSWolfgang Denk 
486c4e0057fSJoe Hershberger 	idx = hsearch_r(e, FIND, &ep, htab, 0);
487c4e0057fSJoe Hershberger 	if (idx == 0) {
488a6826fbcSWolfgang Denk 		__set_errno(ESRCH);
489a6826fbcSWolfgang Denk 		return 0;	/* not found */
490a6826fbcSWolfgang Denk 	}
491a6826fbcSWolfgang Denk 
492c4e0057fSJoe Hershberger 	/* Check for permission */
4937afcf3a5SJoe Hershberger 	if (htab->change_ok != NULL &&
4947afcf3a5SJoe Hershberger 	    htab->change_ok(ep, NULL, env_op_delete, flag)) {
4957afcf3a5SJoe Hershberger 		debug("change_ok() rejected deleting variable "
4967afcf3a5SJoe Hershberger 			"%s, skipping it!\n", key);
497c4e0057fSJoe Hershberger 		__set_errno(EPERM);
498c4e0057fSJoe Hershberger 		return 0;
499c4e0057fSJoe Hershberger 	}
500c4e0057fSJoe Hershberger 
501170ab110SJoe Hershberger 	/* If there is a callback, call it */
502170ab110SJoe Hershberger 	if (htab->table[idx].entry.callback &&
503170ab110SJoe Hershberger 	    htab->table[idx].entry.callback(key, NULL, env_op_delete, flag)) {
504170ab110SJoe Hershberger 		debug("callback() rejected deleting variable "
505170ab110SJoe Hershberger 			"%s, skipping it!\n", key);
506170ab110SJoe Hershberger 		__set_errno(EINVAL);
507170ab110SJoe Hershberger 		return 0;
508170ab110SJoe Hershberger 	}
509170ab110SJoe Hershberger 
5107afcf3a5SJoe Hershberger 	_hdelete(key, htab, ep, idx);
511a6826fbcSWolfgang Denk 
512a6826fbcSWolfgang Denk 	return 1;
513a6826fbcSWolfgang Denk }
514a6826fbcSWolfgang Denk 
515a6826fbcSWolfgang Denk /*
516a6826fbcSWolfgang Denk  * hexport()
517a6826fbcSWolfgang Denk  */
518a6826fbcSWolfgang Denk 
5197ac2fe2dSIlya Yanok #ifndef CONFIG_SPL_BUILD
520a6826fbcSWolfgang Denk /*
521a6826fbcSWolfgang Denk  * Export the data stored in the hash table in linearized form.
522a6826fbcSWolfgang Denk  *
523a6826fbcSWolfgang Denk  * Entries are exported as "name=value" strings, separated by an
524a6826fbcSWolfgang Denk  * arbitrary (non-NUL, of course) separator character. This allows to
525a6826fbcSWolfgang Denk  * use this function both when formatting the U-Boot environment for
526a6826fbcSWolfgang Denk  * external storage (using '\0' as separator), but also when using it
527a6826fbcSWolfgang Denk  * for the "printenv" command to print all variables, simply by using
528a6826fbcSWolfgang Denk  * as '\n" as separator. This can also be used for new features like
529a6826fbcSWolfgang Denk  * exporting the environment data as text file, including the option
530a6826fbcSWolfgang Denk  * for later re-import.
531a6826fbcSWolfgang Denk  *
532a6826fbcSWolfgang Denk  * The entries in the result list will be sorted by ascending key
533a6826fbcSWolfgang Denk  * values.
534a6826fbcSWolfgang Denk  *
535a6826fbcSWolfgang Denk  * If the separator character is different from NUL, then any
536a6826fbcSWolfgang Denk  * separator characters and backslash characters in the values will
537a6826fbcSWolfgang Denk  * be escaped by a preceeding backslash in output. This is needed for
538a6826fbcSWolfgang Denk  * example to enable multi-line values, especially when the output
539a6826fbcSWolfgang Denk  * shall later be parsed (for example, for re-import).
540a6826fbcSWolfgang Denk  *
541a6826fbcSWolfgang Denk  * There are several options how the result buffer is handled:
542a6826fbcSWolfgang Denk  *
543a6826fbcSWolfgang Denk  * *resp  size
544a6826fbcSWolfgang Denk  * -----------
545a6826fbcSWolfgang Denk  *  NULL    0	A string of sufficient length will be allocated.
546a6826fbcSWolfgang Denk  *  NULL   >0	A string of the size given will be
547a6826fbcSWolfgang Denk  *		allocated. An error will be returned if the size is
548a6826fbcSWolfgang Denk  *		not sufficient.  Any unused bytes in the string will
549a6826fbcSWolfgang Denk  *		be '\0'-padded.
550a6826fbcSWolfgang Denk  * !NULL    0	The user-supplied buffer will be used. No length
551a6826fbcSWolfgang Denk  *		checking will be performed, i. e. it is assumed that
552a6826fbcSWolfgang Denk  *		the buffer size will always be big enough. DANGEROUS.
553a6826fbcSWolfgang Denk  * !NULL   >0	The user-supplied buffer will be used. An error will
554a6826fbcSWolfgang Denk  *		be returned if the size is not sufficient.  Any unused
555a6826fbcSWolfgang Denk  *		bytes in the string will be '\0'-padded.
556a6826fbcSWolfgang Denk  */
557a6826fbcSWolfgang Denk 
558a6826fbcSWolfgang Denk static int cmpkey(const void *p1, const void *p2)
559a6826fbcSWolfgang Denk {
560a6826fbcSWolfgang Denk 	ENTRY *e1 = *(ENTRY **) p1;
561a6826fbcSWolfgang Denk 	ENTRY *e2 = *(ENTRY **) p2;
562a6826fbcSWolfgang Denk 
563a6826fbcSWolfgang Denk 	return (strcmp(e1->key, e2->key));
564a6826fbcSWolfgang Denk }
565a6826fbcSWolfgang Denk 
566be11235aSJoe Hershberger ssize_t hexport_r(struct hsearch_data *htab, const char sep, int flag,
56737f2fe74SWolfgang Denk 		 char **resp, size_t size,
56837f2fe74SWolfgang Denk 		 int argc, char * const argv[])
569a6826fbcSWolfgang Denk {
570a6826fbcSWolfgang Denk 	ENTRY *list[htab->size];
571a6826fbcSWolfgang Denk 	char *res, *p;
572a6826fbcSWolfgang Denk 	size_t totlen;
573a6826fbcSWolfgang Denk 	int i, n;
574a6826fbcSWolfgang Denk 
575a6826fbcSWolfgang Denk 	/* Test for correct arguments.  */
576a6826fbcSWolfgang Denk 	if ((resp == NULL) || (htab == NULL)) {
577a6826fbcSWolfgang Denk 		__set_errno(EINVAL);
578a6826fbcSWolfgang Denk 		return (-1);
579a6826fbcSWolfgang Denk 	}
580a6826fbcSWolfgang Denk 
581ff856286SSimon Glass 	debug("EXPORT  table = %p, htab.size = %d, htab.filled = %d, "
582ff856286SSimon Glass 		"size = %zu\n", htab, htab->size, htab->filled, size);
583a6826fbcSWolfgang Denk 	/*
584a6826fbcSWolfgang Denk 	 * Pass 1:
585a6826fbcSWolfgang Denk 	 * search used entries,
586a6826fbcSWolfgang Denk 	 * save addresses and compute total length
587a6826fbcSWolfgang Denk 	 */
588a6826fbcSWolfgang Denk 	for (i = 1, n = 0, totlen = 0; i <= htab->size; ++i) {
589a6826fbcSWolfgang Denk 
590c81c1222SPeter Barada 		if (htab->table[i].used > 0) {
591a6826fbcSWolfgang Denk 			ENTRY *ep = &htab->table[i].entry;
59237f2fe74SWolfgang Denk 			int arg, found = 0;
59337f2fe74SWolfgang Denk 
59437f2fe74SWolfgang Denk 			for (arg = 0; arg < argc; ++arg) {
59537f2fe74SWolfgang Denk 				if (strcmp(argv[arg], ep->key) == 0) {
59637f2fe74SWolfgang Denk 					found = 1;
59737f2fe74SWolfgang Denk 					break;
59837f2fe74SWolfgang Denk 				}
59937f2fe74SWolfgang Denk 			}
60037f2fe74SWolfgang Denk 			if ((argc > 0) && (found == 0))
60137f2fe74SWolfgang Denk 				continue;
602a6826fbcSWolfgang Denk 
603be11235aSJoe Hershberger 			if ((flag & H_HIDE_DOT) && ep->key[0] == '.')
604be11235aSJoe Hershberger 				continue;
605be11235aSJoe Hershberger 
606a6826fbcSWolfgang Denk 			list[n++] = ep;
607a6826fbcSWolfgang Denk 
608a6826fbcSWolfgang Denk 			totlen += strlen(ep->key) + 2;
609a6826fbcSWolfgang Denk 
610a6826fbcSWolfgang Denk 			if (sep == '\0') {
611a6826fbcSWolfgang Denk 				totlen += strlen(ep->data);
612a6826fbcSWolfgang Denk 			} else {	/* check if escapes are needed */
613a6826fbcSWolfgang Denk 				char *s = ep->data;
614a6826fbcSWolfgang Denk 
615a6826fbcSWolfgang Denk 				while (*s) {
616a6826fbcSWolfgang Denk 					++totlen;
617a6826fbcSWolfgang Denk 					/* add room for needed escape chars */
618a6826fbcSWolfgang Denk 					if ((*s == sep) || (*s == '\\'))
619a6826fbcSWolfgang Denk 						++totlen;
620a6826fbcSWolfgang Denk 					++s;
621a6826fbcSWolfgang Denk 				}
622a6826fbcSWolfgang Denk 			}
623a6826fbcSWolfgang Denk 			totlen += 2;	/* for '=' and 'sep' char */
624a6826fbcSWolfgang Denk 		}
625a6826fbcSWolfgang Denk 	}
626a6826fbcSWolfgang Denk 
627a6826fbcSWolfgang Denk #ifdef DEBUG
628a6826fbcSWolfgang Denk 	/* Pass 1a: print unsorted list */
629a6826fbcSWolfgang Denk 	printf("Unsorted: n=%d\n", n);
630a6826fbcSWolfgang Denk 	for (i = 0; i < n; ++i) {
631a6826fbcSWolfgang Denk 		printf("\t%3d: %p ==> %-10s => %s\n",
632a6826fbcSWolfgang Denk 		       i, list[i], list[i]->key, list[i]->data);
633a6826fbcSWolfgang Denk 	}
634a6826fbcSWolfgang Denk #endif
635a6826fbcSWolfgang Denk 
636a6826fbcSWolfgang Denk 	/* Sort list by keys */
637a6826fbcSWolfgang Denk 	qsort(list, n, sizeof(ENTRY *), cmpkey);
638a6826fbcSWolfgang Denk 
639a6826fbcSWolfgang Denk 	/* Check if the user supplied buffer size is sufficient */
640a6826fbcSWolfgang Denk 	if (size) {
641a6826fbcSWolfgang Denk 		if (size < totlen + 1) {	/* provided buffer too small */
642ff856286SSimon Glass 			printf("Env export buffer too small: %zu, "
643ff856286SSimon Glass 				"but need %zu\n", size, totlen + 1);
644a6826fbcSWolfgang Denk 			__set_errno(ENOMEM);
645a6826fbcSWolfgang Denk 			return (-1);
646a6826fbcSWolfgang Denk 		}
647a6826fbcSWolfgang Denk 	} else {
648a6826fbcSWolfgang Denk 		size = totlen + 1;
649a6826fbcSWolfgang Denk 	}
650a6826fbcSWolfgang Denk 
651a6826fbcSWolfgang Denk 	/* Check if the user provided a buffer */
652a6826fbcSWolfgang Denk 	if (*resp) {
653a6826fbcSWolfgang Denk 		/* yes; clear it */
654a6826fbcSWolfgang Denk 		res = *resp;
655a6826fbcSWolfgang Denk 		memset(res, '\0', size);
656a6826fbcSWolfgang Denk 	} else {
657a6826fbcSWolfgang Denk 		/* no, allocate and clear one */
658a6826fbcSWolfgang Denk 		*resp = res = calloc(1, size);
659a6826fbcSWolfgang Denk 		if (res == NULL) {
660a6826fbcSWolfgang Denk 			__set_errno(ENOMEM);
661a6826fbcSWolfgang Denk 			return (-1);
662a6826fbcSWolfgang Denk 		}
663a6826fbcSWolfgang Denk 	}
664a6826fbcSWolfgang Denk 	/*
665a6826fbcSWolfgang Denk 	 * Pass 2:
666a6826fbcSWolfgang Denk 	 * export sorted list of result data
667a6826fbcSWolfgang Denk 	 */
668a6826fbcSWolfgang Denk 	for (i = 0, p = res; i < n; ++i) {
66984b5e802SWolfgang Denk 		const char *s;
670a6826fbcSWolfgang Denk 
671a6826fbcSWolfgang Denk 		s = list[i]->key;
672a6826fbcSWolfgang Denk 		while (*s)
673a6826fbcSWolfgang Denk 			*p++ = *s++;
674a6826fbcSWolfgang Denk 		*p++ = '=';
675a6826fbcSWolfgang Denk 
676a6826fbcSWolfgang Denk 		s = list[i]->data;
677a6826fbcSWolfgang Denk 
678a6826fbcSWolfgang Denk 		while (*s) {
679a6826fbcSWolfgang Denk 			if ((*s == sep) || (*s == '\\'))
680a6826fbcSWolfgang Denk 				*p++ = '\\';	/* escape */
681a6826fbcSWolfgang Denk 			*p++ = *s++;
682a6826fbcSWolfgang Denk 		}
683a6826fbcSWolfgang Denk 		*p++ = sep;
684a6826fbcSWolfgang Denk 	}
685a6826fbcSWolfgang Denk 	*p = '\0';		/* terminate result */
686a6826fbcSWolfgang Denk 
687a6826fbcSWolfgang Denk 	return size;
688a6826fbcSWolfgang Denk }
6897ac2fe2dSIlya Yanok #endif
690a6826fbcSWolfgang Denk 
691a6826fbcSWolfgang Denk 
692a6826fbcSWolfgang Denk /*
693a6826fbcSWolfgang Denk  * himport()
694a6826fbcSWolfgang Denk  */
695a6826fbcSWolfgang Denk 
696d5370febSGerlando Falauto /*
697d5370febSGerlando Falauto  * Check whether variable 'name' is amongst vars[],
698d5370febSGerlando Falauto  * and remove all instances by setting the pointer to NULL
699d5370febSGerlando Falauto  */
700d5370febSGerlando Falauto static int drop_var_from_set(const char *name, int nvars, char * vars[])
701348b1f1cSGerlando Falauto {
702348b1f1cSGerlando Falauto 	int i = 0;
703d5370febSGerlando Falauto 	int res = 0;
704348b1f1cSGerlando Falauto 
705348b1f1cSGerlando Falauto 	/* No variables specified means process all of them */
706348b1f1cSGerlando Falauto 	if (nvars == 0)
707348b1f1cSGerlando Falauto 		return 1;
708348b1f1cSGerlando Falauto 
709348b1f1cSGerlando Falauto 	for (i = 0; i < nvars; i++) {
710d5370febSGerlando Falauto 		if (vars[i] == NULL)
711d5370febSGerlando Falauto 			continue;
712d5370febSGerlando Falauto 		/* If we found it, delete all of them */
713d5370febSGerlando Falauto 		if (!strcmp(name, vars[i])) {
714d5370febSGerlando Falauto 			vars[i] = NULL;
715d5370febSGerlando Falauto 			res = 1;
716348b1f1cSGerlando Falauto 		}
717d5370febSGerlando Falauto 	}
718d5370febSGerlando Falauto 	if (!res)
719348b1f1cSGerlando Falauto 		debug("Skipping non-listed variable %s\n", name);
720348b1f1cSGerlando Falauto 
721d5370febSGerlando Falauto 	return res;
722348b1f1cSGerlando Falauto }
723348b1f1cSGerlando Falauto 
724a6826fbcSWolfgang Denk /*
725a6826fbcSWolfgang Denk  * Import linearized data into hash table.
726a6826fbcSWolfgang Denk  *
727a6826fbcSWolfgang Denk  * This is the inverse function to hexport(): it takes a linear list
728a6826fbcSWolfgang Denk  * of "name=value" pairs and creates hash table entries from it.
729a6826fbcSWolfgang Denk  *
730a6826fbcSWolfgang Denk  * Entries without "value", i. e. consisting of only "name" or
731a6826fbcSWolfgang Denk  * "name=", will cause this entry to be deleted from the hash table.
732a6826fbcSWolfgang Denk  *
733a6826fbcSWolfgang Denk  * The "flag" argument can be used to control the behaviour: when the
734a6826fbcSWolfgang Denk  * H_NOCLEAR bit is set, then an existing hash table will kept, i. e.
735a6826fbcSWolfgang Denk  * new data will be added to an existing hash table; otherwise, old
736a6826fbcSWolfgang Denk  * data will be discarded and a new hash table will be created.
737a6826fbcSWolfgang Denk  *
738a6826fbcSWolfgang Denk  * The separator character for the "name=value" pairs can be selected,
739a6826fbcSWolfgang Denk  * so we both support importing from externally stored environment
740a6826fbcSWolfgang Denk  * data (separated by NUL characters) and from plain text files
741a6826fbcSWolfgang Denk  * (entries separated by newline characters).
742a6826fbcSWolfgang Denk  *
743a6826fbcSWolfgang Denk  * To allow for nicely formatted text input, leading white space
744a6826fbcSWolfgang Denk  * (sequences of SPACE and TAB chars) is ignored, and entries starting
745a6826fbcSWolfgang Denk  * (after removal of any leading white space) with a '#' character are
746a6826fbcSWolfgang Denk  * considered comments and ignored.
747a6826fbcSWolfgang Denk  *
748a6826fbcSWolfgang Denk  * [NOTE: this means that a variable name cannot start with a '#'
749a6826fbcSWolfgang Denk  * character.]
750a6826fbcSWolfgang Denk  *
751a6826fbcSWolfgang Denk  * When using a non-NUL separator character, backslash is used as
752a6826fbcSWolfgang Denk  * escape character in the value part, allowing for example for
753a6826fbcSWolfgang Denk  * multi-line values.
754a6826fbcSWolfgang Denk  *
755a6826fbcSWolfgang Denk  * In theory, arbitrary separator characters can be used, but only
756a6826fbcSWolfgang Denk  * '\0' and '\n' have really been tested.
757a6826fbcSWolfgang Denk  */
758a6826fbcSWolfgang Denk 
759a6826fbcSWolfgang Denk int himport_r(struct hsearch_data *htab,
760348b1f1cSGerlando Falauto 		const char *env, size_t size, const char sep, int flag,
761c4e0057fSJoe Hershberger 		int nvars, char * const vars[])
762a6826fbcSWolfgang Denk {
763a6826fbcSWolfgang Denk 	char *data, *sp, *dp, *name, *value;
764d5370febSGerlando Falauto 	char *localvars[nvars];
765d5370febSGerlando Falauto 	int i;
766a6826fbcSWolfgang Denk 
767a6826fbcSWolfgang Denk 	/* Test for correct arguments.  */
768a6826fbcSWolfgang Denk 	if (htab == NULL) {
769a6826fbcSWolfgang Denk 		__set_errno(EINVAL);
770a6826fbcSWolfgang Denk 		return 0;
771a6826fbcSWolfgang Denk 	}
772a6826fbcSWolfgang Denk 
773a6826fbcSWolfgang Denk 	/* we allocate new space to make sure we can write to the array */
774a6826fbcSWolfgang Denk 	if ((data = malloc(size)) == NULL) {
775ff856286SSimon Glass 		debug("himport_r: can't malloc %zu bytes\n", size);
776a6826fbcSWolfgang Denk 		__set_errno(ENOMEM);
777a6826fbcSWolfgang Denk 		return 0;
778a6826fbcSWolfgang Denk 	}
779a6826fbcSWolfgang Denk 	memcpy(data, env, size);
780a6826fbcSWolfgang Denk 	dp = data;
781a6826fbcSWolfgang Denk 
782d5370febSGerlando Falauto 	/* make a local copy of the list of variables */
783d5370febSGerlando Falauto 	if (nvars)
784d5370febSGerlando Falauto 		memcpy(localvars, vars, sizeof(vars[0]) * nvars);
785d5370febSGerlando Falauto 
786a6826fbcSWolfgang Denk 	if ((flag & H_NOCLEAR) == 0) {
787a6826fbcSWolfgang Denk 		/* Destroy old hash table if one exists */
788a6826fbcSWolfgang Denk 		debug("Destroy Hash Table: %p table = %p\n", htab,
789a6826fbcSWolfgang Denk 		       htab->table);
790a6826fbcSWolfgang Denk 		if (htab->table)
791c4e0057fSJoe Hershberger 			hdestroy_r(htab);
792a6826fbcSWolfgang Denk 	}
793a6826fbcSWolfgang Denk 
794a6826fbcSWolfgang Denk 	/*
795a6826fbcSWolfgang Denk 	 * Create new hash table (if needed).  The computation of the hash
796a6826fbcSWolfgang Denk 	 * table size is based on heuristics: in a sample of some 70+
797a6826fbcSWolfgang Denk 	 * existing systems we found an average size of 39+ bytes per entry
798a6826fbcSWolfgang Denk 	 * in the environment (for the whole key=value pair). Assuming a
799ea882bafSWolfgang Denk 	 * size of 8 per entry (= safety factor of ~5) should provide enough
800ea882bafSWolfgang Denk 	 * safety margin for any existing environment definitions and still
801a6826fbcSWolfgang Denk 	 * allow for more than enough dynamic additions. Note that the
802a6826fbcSWolfgang Denk 	 * "size" argument is supposed to give the maximum enviroment size
803ea882bafSWolfgang Denk 	 * (CONFIG_ENV_SIZE).  This heuristics will result in
804ea882bafSWolfgang Denk 	 * unreasonably large numbers (and thus memory footprint) for
805ea882bafSWolfgang Denk 	 * big flash environments (>8,000 entries for 64 KB
806fc5fc76bSAndreas Bießmann 	 * envrionment size), so we clip it to a reasonable value.
807fc5fc76bSAndreas Bießmann 	 * On the other hand we need to add some more entries for free
808fc5fc76bSAndreas Bießmann 	 * space when importing very small buffers. Both boundaries can
809fc5fc76bSAndreas Bießmann 	 * be overwritten in the board config file if needed.
810a6826fbcSWolfgang Denk 	 */
811a6826fbcSWolfgang Denk 
812a6826fbcSWolfgang Denk 	if (!htab->table) {
813fc5fc76bSAndreas Bießmann 		int nent = CONFIG_ENV_MIN_ENTRIES + size / 8;
814ea882bafSWolfgang Denk 
815ea882bafSWolfgang Denk 		if (nent > CONFIG_ENV_MAX_ENTRIES)
816ea882bafSWolfgang Denk 			nent = CONFIG_ENV_MAX_ENTRIES;
817a6826fbcSWolfgang Denk 
818a6826fbcSWolfgang Denk 		debug("Create Hash Table: N=%d\n", nent);
819a6826fbcSWolfgang Denk 
820a6826fbcSWolfgang Denk 		if (hcreate_r(nent, htab) == 0) {
821a6826fbcSWolfgang Denk 			free(data);
822a6826fbcSWolfgang Denk 			return 0;
823a6826fbcSWolfgang Denk 		}
824a6826fbcSWolfgang Denk 	}
825a6826fbcSWolfgang Denk 
826a6826fbcSWolfgang Denk 	/* Parse environment; allow for '\0' and 'sep' as separators */
827a6826fbcSWolfgang Denk 	do {
828a6826fbcSWolfgang Denk 		ENTRY e, *rv;
829a6826fbcSWolfgang Denk 
830a6826fbcSWolfgang Denk 		/* skip leading white space */
8314d91a6ecSJason Hobbs 		while (isblank(*dp))
832a6826fbcSWolfgang Denk 			++dp;
833a6826fbcSWolfgang Denk 
834a6826fbcSWolfgang Denk 		/* skip comment lines */
835a6826fbcSWolfgang Denk 		if (*dp == '#') {
836a6826fbcSWolfgang Denk 			while (*dp && (*dp != sep))
837a6826fbcSWolfgang Denk 				++dp;
838a6826fbcSWolfgang Denk 			++dp;
839a6826fbcSWolfgang Denk 			continue;
840a6826fbcSWolfgang Denk 		}
841a6826fbcSWolfgang Denk 
842a6826fbcSWolfgang Denk 		/* parse name */
843a6826fbcSWolfgang Denk 		for (name = dp; *dp != '=' && *dp && *dp != sep; ++dp)
844a6826fbcSWolfgang Denk 			;
845a6826fbcSWolfgang Denk 
846a6826fbcSWolfgang Denk 		/* deal with "name" and "name=" entries (delete var) */
847a6826fbcSWolfgang Denk 		if (*dp == '\0' || *(dp + 1) == '\0' ||
848a6826fbcSWolfgang Denk 		    *dp == sep || *(dp + 1) == sep) {
849a6826fbcSWolfgang Denk 			if (*dp == '=')
850a6826fbcSWolfgang Denk 				*dp++ = '\0';
851a6826fbcSWolfgang Denk 			*dp++ = '\0';	/* terminate name */
852a6826fbcSWolfgang Denk 
853a6826fbcSWolfgang Denk 			debug("DELETE CANDIDATE: \"%s\"\n", name);
854d5370febSGerlando Falauto 			if (!drop_var_from_set(name, nvars, localvars))
855348b1f1cSGerlando Falauto 				continue;
856a6826fbcSWolfgang Denk 
857c4e0057fSJoe Hershberger 			if (hdelete_r(name, htab, flag) == 0)
858a6826fbcSWolfgang Denk 				debug("DELETE ERROR ##############################\n");
859a6826fbcSWolfgang Denk 
860a6826fbcSWolfgang Denk 			continue;
861a6826fbcSWolfgang Denk 		}
862a6826fbcSWolfgang Denk 		*dp++ = '\0';	/* terminate name */
863a6826fbcSWolfgang Denk 
864a6826fbcSWolfgang Denk 		/* parse value; deal with escapes */
865a6826fbcSWolfgang Denk 		for (value = sp = dp; *dp && (*dp != sep); ++dp) {
866a6826fbcSWolfgang Denk 			if ((*dp == '\\') && *(dp + 1))
867a6826fbcSWolfgang Denk 				++dp;
868a6826fbcSWolfgang Denk 			*sp++ = *dp;
869a6826fbcSWolfgang Denk 		}
870a6826fbcSWolfgang Denk 		*sp++ = '\0';	/* terminate value */
871a6826fbcSWolfgang Denk 		++dp;
872a6826fbcSWolfgang Denk 
873348b1f1cSGerlando Falauto 		/* Skip variables which are not supposed to be processed */
874d5370febSGerlando Falauto 		if (!drop_var_from_set(name, nvars, localvars))
875348b1f1cSGerlando Falauto 			continue;
876348b1f1cSGerlando Falauto 
877a6826fbcSWolfgang Denk 		/* enter into hash table */
878a6826fbcSWolfgang Denk 		e.key = name;
879a6826fbcSWolfgang Denk 		e.data = value;
880a6826fbcSWolfgang Denk 
881c4e0057fSJoe Hershberger 		hsearch_r(e, ENTER, &rv, htab, flag);
882170ab110SJoe Hershberger 		if (rv == NULL)
883ea882bafSWolfgang Denk 			printf("himport_r: can't insert \"%s=%s\" into hash table\n",
884ea882bafSWolfgang Denk 				name, value);
885a6826fbcSWolfgang Denk 
886ea882bafSWolfgang Denk 		debug("INSERT: table %p, filled %d/%d rv %p ==> name=\"%s\" value=\"%s\"\n",
887ea882bafSWolfgang Denk 			htab, htab->filled, htab->size,
888ea882bafSWolfgang Denk 			rv, name, value);
889a6826fbcSWolfgang Denk 	} while ((dp < data + size) && *dp);	/* size check needed for text */
890a6826fbcSWolfgang Denk 						/* without '\0' termination */
891ea882bafSWolfgang Denk 	debug("INSERT: free(data = %p)\n", data);
892a6826fbcSWolfgang Denk 	free(data);
893a6826fbcSWolfgang Denk 
894d5370febSGerlando Falauto 	/* process variables which were not considered */
895d5370febSGerlando Falauto 	for (i = 0; i < nvars; i++) {
896d5370febSGerlando Falauto 		if (localvars[i] == NULL)
897d5370febSGerlando Falauto 			continue;
898d5370febSGerlando Falauto 		/*
899d5370febSGerlando Falauto 		 * All variables which were not deleted from the variable list
900d5370febSGerlando Falauto 		 * were not present in the imported env
901d5370febSGerlando Falauto 		 * This could mean two things:
902d5370febSGerlando Falauto 		 * a) if the variable was present in current env, we delete it
903d5370febSGerlando Falauto 		 * b) if the variable was not present in current env, we notify
904d5370febSGerlando Falauto 		 *    it might be a typo
905d5370febSGerlando Falauto 		 */
906c4e0057fSJoe Hershberger 		if (hdelete_r(localvars[i], htab, flag) == 0)
907d5370febSGerlando Falauto 			printf("WARNING: '%s' neither in running nor in imported env!\n", localvars[i]);
908d5370febSGerlando Falauto 		else
909d5370febSGerlando Falauto 			printf("WARNING: '%s' not in imported env, deleting it!\n", localvars[i]);
910d5370febSGerlando Falauto 	}
911d5370febSGerlando Falauto 
912ea882bafSWolfgang Denk 	debug("INSERT: done\n");
913a6826fbcSWolfgang Denk 	return 1;		/* everything OK */
914a6826fbcSWolfgang Denk }
915170ab110SJoe Hershberger 
916170ab110SJoe Hershberger /*
917170ab110SJoe Hershberger  * hwalk_r()
918170ab110SJoe Hershberger  */
919170ab110SJoe Hershberger 
920170ab110SJoe Hershberger /*
921170ab110SJoe Hershberger  * Walk all of the entries in the hash, calling the callback for each one.
922170ab110SJoe Hershberger  * this allows some generic operation to be performed on each element.
923170ab110SJoe Hershberger  */
924170ab110SJoe Hershberger int hwalk_r(struct hsearch_data *htab, int (*callback)(ENTRY *))
925170ab110SJoe Hershberger {
926170ab110SJoe Hershberger 	int i;
927170ab110SJoe Hershberger 	int retval;
928170ab110SJoe Hershberger 
929170ab110SJoe Hershberger 	for (i = 1; i <= htab->size; ++i) {
930170ab110SJoe Hershberger 		if (htab->table[i].used > 0) {
931170ab110SJoe Hershberger 			retval = callback(&htab->table[i].entry);
932170ab110SJoe Hershberger 			if (retval)
933170ab110SJoe Hershberger 				return retval;
934170ab110SJoe Hershberger 		}
935170ab110SJoe Hershberger 	}
936170ab110SJoe Hershberger 
937170ab110SJoe Hershberger 	return 0;
938170ab110SJoe Hershberger }
939