blob: a0060f6a0d63138ac524d3900db3d30582117e4a [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: LGPL-2.1+
Wolfgang Denka6826fb2010-06-20 13:17:12 +02002/*
3 * This implementation is based on code from uClibc-0.9.30.3 but was
4 * modified and extended for use within U-Boot.
5 *
Wolfgang Denkea009d42013-03-23 23:50:28 +00006 * Copyright (C) 2010-2013 Wolfgang Denk <wd@denx.de>
Wolfgang Denka6826fb2010-06-20 13:17:12 +02007 *
8 * Original license header:
9 *
10 * Copyright (C) 1993, 1995, 1996, 1997, 2002 Free Software Foundation, Inc.
11 * This file is part of the GNU C Library.
12 * Contributed by Ulrich Drepper <drepper@gnu.ai.mit.edu>, 1993.
Wolfgang Denka6826fb2010-06-20 13:17:12 +020013 */
14
15#include <errno.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060016#include <log.h>
Wolfgang Denka6826fb2010-06-20 13:17:12 +020017#include <malloc.h>
Simon Glass8bef79b2019-11-14 12:57:19 -070018#include <sort.h>
Wolfgang Denka6826fb2010-06-20 13:17:12 +020019
20#ifdef USE_HOSTCC /* HOST build */
21# include <string.h>
22# include <assert.h>
Jason Hobbs4d91a6e2011-08-23 11:06:54 +000023# include <ctype.h>
Wolfgang Denka6826fb2010-06-20 13:17:12 +020024
25# ifndef debug
26# ifdef DEBUG
27# define debug(fmt,args...) printf(fmt ,##args)
28# else
29# define debug(fmt,args...)
30# endif
31# endif
32#else /* U-Boot build */
Wolfgang Denka6826fb2010-06-20 13:17:12 +020033# include <linux/string.h>
Jason Hobbs4d91a6e2011-08-23 11:06:54 +000034# include <linux/ctype.h>
Wolfgang Denka6826fb2010-06-20 13:17:12 +020035#endif
36
Roman Kapl9dfdbd92019-01-30 11:39:54 +010037#define USED_FREE 0
38#define USED_DELETED -1
39
Joe Hershberger170ab112012-12-11 22:16:24 -060040#include <env_callback.h>
Joe Hershberger25980902012-12-11 22:16:31 -060041#include <env_flags.h>
Joe Hershberger170ab112012-12-11 22:16:24 -060042#include <search.h>
Wolfgang Denkbe29df62013-03-23 23:50:32 +000043#include <slre.h>
Wolfgang Denka6826fb2010-06-20 13:17:12 +020044
45/*
46 * [Aho,Sethi,Ullman] Compilers: Principles, Techniques and Tools, 1986
Wolfgang Denk071bc922010-10-27 22:48:30 +020047 * [Knuth] The Art of Computer Programming, part 3 (6.4)
Wolfgang Denka6826fb2010-06-20 13:17:12 +020048 */
49
50/*
Wolfgang Denka6826fb2010-06-20 13:17:12 +020051 * The reentrant version has no static variables to maintain the state.
52 * Instead the interface of all functions is extended to take an argument
53 * which describes the current status.
54 */
Joe Hershberger7afcf3a2012-12-11 22:16:21 -060055
Simon Glass25e51e92019-08-02 09:44:19 -060056struct env_entry_node {
Peter Baradac81c1222011-03-21 19:05:20 -040057 int used;
Simon Glassdd2408c2019-08-02 09:44:18 -060058 struct env_entry entry;
Simon Glass25e51e92019-08-02 09:44:19 -060059};
Wolfgang Denka6826fb2010-06-20 13:17:12 +020060
61
Simon Glassdd2408c2019-08-02 09:44:18 -060062static void _hdelete(const char *key, struct hsearch_data *htab,
63 struct env_entry *ep, int idx);
Joe Hershberger7afcf3a2012-12-11 22:16:21 -060064
Wolfgang Denka6826fb2010-06-20 13:17:12 +020065/*
66 * hcreate()
67 */
68
69/*
70 * For the used double hash method the table size has to be a prime. To
71 * correct the user given table size we need a prime test. This trivial
72 * algorithm is adequate because
73 * a) the code is (most probably) called a few times per program run and
74 * b) the number is small because the table must fit in the core
75 * */
76static int isprime(unsigned int number)
77{
78 /* no even number will be passed */
79 unsigned int div = 3;
80
81 while (div * div < number && number % div != 0)
82 div += 2;
83
84 return number % div != 0;
85}
86
Wolfgang Denka6826fb2010-06-20 13:17:12 +020087/*
88 * Before using the hash table we must allocate memory for it.
89 * Test for an existing table are done. We allocate one element
90 * more as the found prime number says. This is done for more effective
91 * indexing as explained in the comment for the hsearch function.
92 * The contents of the table is zeroed, especially the field used
93 * becomes zero.
94 */
Mike Frysinger2eb15732010-12-08 06:26:04 -050095
Wolfgang Denka6826fb2010-06-20 13:17:12 +020096int hcreate_r(size_t nel, struct hsearch_data *htab)
97{
98 /* Test for correct arguments. */
99 if (htab == NULL) {
100 __set_errno(EINVAL);
101 return 0;
102 }
103
104 /* There is still another table active. Return with error. */
Sean Anderson60ffcf22020-06-24 06:41:15 -0400105 if (htab->table != NULL) {
106 __set_errno(EINVAL);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200107 return 0;
Sean Anderson60ffcf22020-06-24 06:41:15 -0400108 }
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200109
110 /* Change nel to the first prime number not smaller as nel. */
111 nel |= 1; /* make odd */
112 while (!isprime(nel))
113 nel += 2;
114
115 htab->size = nel;
116 htab->filled = 0;
117
118 /* allocate memory and zero out */
Simon Glass25e51e92019-08-02 09:44:19 -0600119 htab->table = (struct env_entry_node *)calloc(htab->size + 1,
120 sizeof(struct env_entry_node));
Sean Anderson60ffcf22020-06-24 06:41:15 -0400121 if (htab->table == NULL) {
122 __set_errno(ENOMEM);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200123 return 0;
Sean Anderson60ffcf22020-06-24 06:41:15 -0400124 }
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200125
126 /* everything went alright */
127 return 1;
128}
129
130
131/*
132 * hdestroy()
133 */
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200134
135/*
136 * After using the hash table it has to be destroyed. The used memory can
137 * be freed and the local static variable can be marked as not used.
138 */
Mike Frysinger2eb15732010-12-08 06:26:04 -0500139
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600140void hdestroy_r(struct hsearch_data *htab)
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200141{
142 int i;
143
144 /* Test for correct arguments. */
145 if (htab == NULL) {
146 __set_errno(EINVAL);
147 return;
148 }
149
150 /* free used memory */
151 for (i = 1; i <= htab->size; ++i) {
Peter Baradac81c1222011-03-21 19:05:20 -0400152 if (htab->table[i].used > 0) {
Simon Glassdd2408c2019-08-02 09:44:18 -0600153 struct env_entry *ep = &htab->table[i].entry;
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600154
Wolfgang Denk84b5e802011-07-29 14:42:18 +0200155 free((void *)ep->key);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200156 free(ep->data);
157 }
158 }
159 free(htab->table);
160
161 /* the sign for an existing table is an value != NULL in htable */
162 htab->table = NULL;
163}
164
165/*
166 * hsearch()
167 */
168
169/*
170 * This is the search function. It uses double hashing with open addressing.
171 * The argument item.key has to be a pointer to an zero terminated, most
172 * probably strings of chars. The function for generating a number of the
173 * strings is simple but fast. It can be replaced by a more complex function
174 * like ajw (see [Aho,Sethi,Ullman]) if the needs are shown.
175 *
176 * We use an trick to speed up the lookup. The table is created by hcreate
177 * with one more element available. This enables us to use the index zero
178 * special. This index will never be used because we store the first hash
179 * index in the field used where zero means not used. Every other value
180 * means used. The used field can be used as a first fast comparison for
181 * equality of the stored and the parameter value. This helps to prevent
182 * unnecessary expensive calls of strcmp.
183 *
184 * This implementation differs from the standard library version of
185 * this function in a number of ways:
186 *
187 * - While the standard version does not make any assumptions about
188 * the type of the stored data objects at all, this implementation
189 * works with NUL terminated strings only.
190 * - Instead of storing just pointers to the original objects, we
191 * create local copies so the caller does not need to care about the
192 * data any more.
193 * - The standard implementation does not provide a way to update an
194 * existing entry. This version will create a new entry or update an
Simon Glass3f0d6802019-08-01 09:47:09 -0600195 * existing one when both "action == ENV_ENTER" and "item.data != NULL".
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200196 * - Instead of returning 1 on success, we return the index into the
197 * internal hash table, which is also guaranteed to be positive.
198 * This allows us direct access to the found hash table slot for
199 * example for functions like hdelete().
200 */
201
Simon Glassdd2408c2019-08-02 09:44:18 -0600202int hmatch_r(const char *match, int last_idx, struct env_entry **retval,
Mike Frysinger560d4242010-12-17 16:51:59 -0500203 struct hsearch_data *htab)
204{
205 unsigned int idx;
206 size_t key_len = strlen(match);
207
208 for (idx = last_idx + 1; idx < htab->size; ++idx) {
Kim Phillipsaf4d9072011-04-04 15:17:45 +0000209 if (htab->table[idx].used <= 0)
Mike Frysinger560d4242010-12-17 16:51:59 -0500210 continue;
211 if (!strncmp(match, htab->table[idx].entry.key, key_len)) {
212 *retval = &htab->table[idx].entry;
213 return idx;
214 }
215 }
216
217 __set_errno(ESRCH);
218 *retval = NULL;
219 return 0;
220}
221
Rasmus Villemoes7f529f62020-02-27 13:56:11 +0000222static int
223do_callback(const struct env_entry *e, const char *name, const char *value,
224 enum env_op op, int flags)
225{
Rasmus Villemoes34284972020-02-27 13:56:11 +0000226#ifndef CONFIG_SPL_BUILD
Rasmus Villemoes7f529f62020-02-27 13:56:11 +0000227 if (e->callback)
228 return e->callback(name, value, op, flags);
Rasmus Villemoes34284972020-02-27 13:56:11 +0000229#endif
Rasmus Villemoes7f529f62020-02-27 13:56:11 +0000230 return 0;
231}
232
Joe Hershberger3d3b52f2012-12-11 22:16:20 -0600233/*
234 * Compare an existing entry with the desired key, and overwrite if the action
Simon Glass3f0d6802019-08-01 09:47:09 -0600235 * is ENV_ENTER. This is simply a helper function for hsearch_r().
Joe Hershberger3d3b52f2012-12-11 22:16:20 -0600236 */
Simon Glassdd2408c2019-08-02 09:44:18 -0600237static inline int _compare_and_overwrite_entry(struct env_entry item,
Simon Glass3f0d6802019-08-01 09:47:09 -0600238 enum env_action action, struct env_entry **retval,
Simon Glassdd2408c2019-08-02 09:44:18 -0600239 struct hsearch_data *htab, int flag, unsigned int hval,
240 unsigned int idx)
Joe Hershberger3d3b52f2012-12-11 22:16:20 -0600241{
242 if (htab->table[idx].used == hval
243 && strcmp(item.key, htab->table[idx].entry.key) == 0) {
244 /* Overwrite existing value? */
Simon Glass3f0d6802019-08-01 09:47:09 -0600245 if (action == ENV_ENTER && item.data) {
Joe Hershberger7afcf3a2012-12-11 22:16:21 -0600246 /* check for permission */
247 if (htab->change_ok != NULL && htab->change_ok(
248 &htab->table[idx].entry, item.data,
249 env_op_overwrite, flag)) {
250 debug("change_ok() rejected setting variable "
251 "%s, skipping it!\n", item.key);
252 __set_errno(EPERM);
253 *retval = NULL;
254 return 0;
255 }
256
Joe Hershberger170ab112012-12-11 22:16:24 -0600257 /* If there is a callback, call it */
Rasmus Villemoes7f529f62020-02-27 13:56:11 +0000258 if (do_callback(&htab->table[idx].entry, item.key,
259 item.data, env_op_overwrite, flag)) {
Joe Hershberger170ab112012-12-11 22:16:24 -0600260 debug("callback() rejected setting variable "
261 "%s, skipping it!\n", item.key);
262 __set_errno(EINVAL);
263 *retval = NULL;
264 return 0;
265 }
266
Joe Hershberger3d3b52f2012-12-11 22:16:20 -0600267 free(htab->table[idx].entry.data);
268 htab->table[idx].entry.data = strdup(item.data);
269 if (!htab->table[idx].entry.data) {
270 __set_errno(ENOMEM);
271 *retval = NULL;
272 return 0;
273 }
274 }
275 /* return found entry */
276 *retval = &htab->table[idx].entry;
277 return idx;
278 }
279 /* keep searching */
280 return -1;
281}
282
Simon Glass3f0d6802019-08-01 09:47:09 -0600283int hsearch_r(struct env_entry item, enum env_action action,
284 struct env_entry **retval, struct hsearch_data *htab, int flag)
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200285{
286 unsigned int hval;
287 unsigned int count;
288 unsigned int len = strlen(item.key);
289 unsigned int idx;
Peter Baradac81c1222011-03-21 19:05:20 -0400290 unsigned int first_deleted = 0;
Joe Hershberger3d3b52f2012-12-11 22:16:20 -0600291 int ret;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200292
293 /* Compute an value for the given string. Perhaps use a better method. */
294 hval = len;
295 count = len;
296 while (count-- > 0) {
297 hval <<= 4;
298 hval += item.key[count];
299 }
300
301 /*
302 * First hash function:
303 * simply take the modul but prevent zero.
304 */
305 hval %= htab->size;
306 if (hval == 0)
307 ++hval;
308
309 /* The first index tried. */
310 idx = hval;
311
312 if (htab->table[idx].used) {
313 /*
Wolfgang Denk071bc922010-10-27 22:48:30 +0200314 * Further action might be required according to the
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200315 * action value.
316 */
317 unsigned hval2;
318
Heinrich Schuchardt34ca77c2020-08-20 19:57:45 +0200319 if (htab->table[idx].used == USED_DELETED)
Peter Baradac81c1222011-03-21 19:05:20 -0400320 first_deleted = idx;
321
Joe Hershberger3d3b52f2012-12-11 22:16:20 -0600322 ret = _compare_and_overwrite_entry(item, action, retval, htab,
323 flag, hval, idx);
324 if (ret != -1)
325 return ret;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200326
327 /*
328 * Second hash function:
329 * as suggested in [Knuth]
330 */
331 hval2 = 1 + hval % (htab->size - 2);
332
333 do {
334 /*
Wolfgang Denk071bc922010-10-27 22:48:30 +0200335 * Because SIZE is prime this guarantees to
336 * step through all available indices.
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200337 */
338 if (idx <= hval2)
339 idx = htab->size + idx - hval2;
340 else
341 idx -= hval2;
342
343 /*
344 * If we visited all entries leave the loop
345 * unsuccessfully.
346 */
347 if (idx == hval)
348 break;
349
Roman Kapl9dfdbd92019-01-30 11:39:54 +0100350 if (htab->table[idx].used == USED_DELETED
351 && !first_deleted)
352 first_deleted = idx;
353
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200354 /* If entry is found use it. */
Joe Hershberger3d3b52f2012-12-11 22:16:20 -0600355 ret = _compare_and_overwrite_entry(item, action, retval,
356 htab, flag, hval, idx);
357 if (ret != -1)
358 return ret;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200359 }
Roman Kapl9dfdbd92019-01-30 11:39:54 +0100360 while (htab->table[idx].used != USED_FREE);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200361 }
362
363 /* An empty bucket has been found. */
Simon Glass3f0d6802019-08-01 09:47:09 -0600364 if (action == ENV_ENTER) {
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200365 /*
Wolfgang Denk071bc922010-10-27 22:48:30 +0200366 * If table is full and another entry should be
367 * entered return with error.
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200368 */
369 if (htab->filled == htab->size) {
370 __set_errno(ENOMEM);
371 *retval = NULL;
372 return 0;
373 }
374
375 /*
376 * Create new entry;
377 * create copies of item.key and item.data
378 */
Peter Baradac81c1222011-03-21 19:05:20 -0400379 if (first_deleted)
380 idx = first_deleted;
381
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200382 htab->table[idx].used = hval;
383 htab->table[idx].entry.key = strdup(item.key);
384 htab->table[idx].entry.data = strdup(item.data);
385 if (!htab->table[idx].entry.key ||
386 !htab->table[idx].entry.data) {
387 __set_errno(ENOMEM);
388 *retval = NULL;
389 return 0;
390 }
391
392 ++htab->filled;
393
Joe Hershberger170ab112012-12-11 22:16:24 -0600394 /* This is a new entry, so look up a possible callback */
395 env_callback_init(&htab->table[idx].entry);
Joe Hershberger25980902012-12-11 22:16:31 -0600396 /* Also look for flags */
397 env_flags_init(&htab->table[idx].entry);
Joe Hershberger170ab112012-12-11 22:16:24 -0600398
Joe Hershberger7afcf3a2012-12-11 22:16:21 -0600399 /* check for permission */
400 if (htab->change_ok != NULL && htab->change_ok(
401 &htab->table[idx].entry, item.data, env_op_create, flag)) {
402 debug("change_ok() rejected setting variable "
403 "%s, skipping it!\n", item.key);
404 _hdelete(item.key, htab, &htab->table[idx].entry, idx);
405 __set_errno(EPERM);
406 *retval = NULL;
407 return 0;
408 }
409
Joe Hershberger170ab112012-12-11 22:16:24 -0600410 /* If there is a callback, call it */
Rasmus Villemoes7f529f62020-02-27 13:56:11 +0000411 if (do_callback(&htab->table[idx].entry, item.key, item.data,
412 env_op_create, flag)) {
Joe Hershberger170ab112012-12-11 22:16:24 -0600413 debug("callback() rejected setting variable "
414 "%s, skipping it!\n", item.key);
415 _hdelete(item.key, htab, &htab->table[idx].entry, idx);
416 __set_errno(EINVAL);
417 *retval = NULL;
418 return 0;
419 }
420
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200421 /* return new entry */
422 *retval = &htab->table[idx].entry;
423 return 1;
424 }
425
426 __set_errno(ESRCH);
427 *retval = NULL;
428 return 0;
429}
430
431
432/*
433 * hdelete()
434 */
435
436/*
437 * The standard implementation of hsearch(3) does not provide any way
438 * to delete any entries from the hash table. We extend the code to
439 * do that.
440 */
441
Simon Glassdd2408c2019-08-02 09:44:18 -0600442static void _hdelete(const char *key, struct hsearch_data *htab,
443 struct env_entry *ep, int idx)
Joe Hershberger7afcf3a2012-12-11 22:16:21 -0600444{
Simon Glassdd2408c2019-08-02 09:44:18 -0600445 /* free used entry */
Joe Hershberger7afcf3a2012-12-11 22:16:21 -0600446 debug("hdelete: DELETING key \"%s\"\n", key);
447 free((void *)ep->key);
448 free(ep->data);
Joe Hershberger25980902012-12-11 22:16:31 -0600449 ep->flags = 0;
Roman Kapl9dfdbd92019-01-30 11:39:54 +0100450 htab->table[idx].used = USED_DELETED;
Joe Hershberger7afcf3a2012-12-11 22:16:21 -0600451
452 --htab->filled;
453}
454
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600455int hdelete_r(const char *key, struct hsearch_data *htab, int flag)
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200456{
Simon Glassdd2408c2019-08-02 09:44:18 -0600457 struct env_entry e, *ep;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200458 int idx;
459
460 debug("hdelete: DELETE key \"%s\"\n", key);
461
462 e.key = (char *)key;
463
Simon Glass3f0d6802019-08-01 09:47:09 -0600464 idx = hsearch_r(e, ENV_FIND, &ep, htab, 0);
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600465 if (idx == 0) {
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200466 __set_errno(ESRCH);
Simon Glass96434a72020-11-05 10:33:37 -0700467 return -ENOENT; /* not found */
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200468 }
469
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600470 /* Check for permission */
Joe Hershberger7afcf3a2012-12-11 22:16:21 -0600471 if (htab->change_ok != NULL &&
472 htab->change_ok(ep, NULL, env_op_delete, flag)) {
473 debug("change_ok() rejected deleting variable "
474 "%s, skipping it!\n", key);
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600475 __set_errno(EPERM);
Simon Glass96434a72020-11-05 10:33:37 -0700476 return -EPERM;
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600477 }
478
Joe Hershberger170ab112012-12-11 22:16:24 -0600479 /* If there is a callback, call it */
Rasmus Villemoes7f529f62020-02-27 13:56:11 +0000480 if (do_callback(&htab->table[idx].entry, key, NULL,
481 env_op_delete, flag)) {
Joe Hershberger170ab112012-12-11 22:16:24 -0600482 debug("callback() rejected deleting variable "
483 "%s, skipping it!\n", key);
484 __set_errno(EINVAL);
Simon Glass96434a72020-11-05 10:33:37 -0700485 return -EINVAL;
Joe Hershberger170ab112012-12-11 22:16:24 -0600486 }
487
Joe Hershberger7afcf3a2012-12-11 22:16:21 -0600488 _hdelete(key, htab, ep, idx);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200489
Simon Glass96434a72020-11-05 10:33:37 -0700490 return 0;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200491}
492
B, Ravid2d9bdf2016-09-28 14:46:18 +0530493#if !(defined(CONFIG_SPL_BUILD) && !defined(CONFIG_SPL_SAVEENV))
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200494/*
495 * hexport()
496 */
497
498/*
499 * Export the data stored in the hash table in linearized form.
500 *
501 * Entries are exported as "name=value" strings, separated by an
502 * arbitrary (non-NUL, of course) separator character. This allows to
503 * use this function both when formatting the U-Boot environment for
504 * external storage (using '\0' as separator), but also when using it
505 * for the "printenv" command to print all variables, simply by using
506 * as '\n" as separator. This can also be used for new features like
507 * exporting the environment data as text file, including the option
508 * for later re-import.
509 *
510 * The entries in the result list will be sorted by ascending key
511 * values.
512 *
513 * If the separator character is different from NUL, then any
514 * separator characters and backslash characters in the values will
Robert P. J. Dayfc0b5942016-09-07 14:27:59 -0400515 * be escaped by a preceding backslash in output. This is needed for
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200516 * example to enable multi-line values, especially when the output
517 * shall later be parsed (for example, for re-import).
518 *
519 * There are several options how the result buffer is handled:
520 *
521 * *resp size
522 * -----------
523 * NULL 0 A string of sufficient length will be allocated.
524 * NULL >0 A string of the size given will be
525 * allocated. An error will be returned if the size is
526 * not sufficient. Any unused bytes in the string will
527 * be '\0'-padded.
528 * !NULL 0 The user-supplied buffer will be used. No length
529 * checking will be performed, i. e. it is assumed that
530 * the buffer size will always be big enough. DANGEROUS.
531 * !NULL >0 The user-supplied buffer will be used. An error will
532 * be returned if the size is not sufficient. Any unused
533 * bytes in the string will be '\0'-padded.
534 */
535
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200536static int cmpkey(const void *p1, const void *p2)
537{
Simon Glassdd2408c2019-08-02 09:44:18 -0600538 struct env_entry *e1 = *(struct env_entry **)p1;
539 struct env_entry *e2 = *(struct env_entry **)p2;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200540
541 return (strcmp(e1->key, e2->key));
542}
543
Wolfgang Denkbe29df62013-03-23 23:50:32 +0000544static int match_string(int flag, const char *str, const char *pat, void *priv)
Wolfgang Denk5a31ea02013-03-23 23:50:29 +0000545{
546 switch (flag & H_MATCH_METHOD) {
547 case H_MATCH_IDENT:
548 if (strcmp(str, pat) == 0)
549 return 1;
550 break;
551 case H_MATCH_SUBSTR:
552 if (strstr(str, pat))
553 return 1;
554 break;
Wolfgang Denkbe29df62013-03-23 23:50:32 +0000555#ifdef CONFIG_REGEX
556 case H_MATCH_REGEX:
557 {
558 struct slre *slrep = (struct slre *)priv;
Wolfgang Denkbe29df62013-03-23 23:50:32 +0000559
Heinrich Schuchardt320194a2019-01-23 08:17:02 +0100560 if (slre_match(slrep, str, strlen(str), NULL))
Wolfgang Denkbe29df62013-03-23 23:50:32 +0000561 return 1;
562 }
563 break;
564#endif
Wolfgang Denk5a31ea02013-03-23 23:50:29 +0000565 default:
566 printf("## ERROR: unsupported match method: 0x%02x\n",
567 flag & H_MATCH_METHOD);
568 break;
569 }
570 return 0;
571}
572
Simon Glassdd2408c2019-08-02 09:44:18 -0600573static int match_entry(struct env_entry *ep, int flag, int argc,
574 char *const argv[])
Wolfgang Denkea009d42013-03-23 23:50:28 +0000575{
576 int arg;
Wolfgang Denkbe29df62013-03-23 23:50:32 +0000577 void *priv = NULL;
Wolfgang Denkea009d42013-03-23 23:50:28 +0000578
Pierre Aubert9a832332013-10-08 14:20:27 +0200579 for (arg = 0; arg < argc; ++arg) {
Wolfgang Denkbe29df62013-03-23 23:50:32 +0000580#ifdef CONFIG_REGEX
581 struct slre slre;
582
583 if (slre_compile(&slre, argv[arg]) == 0) {
584 printf("Error compiling regex: %s\n", slre.err_str);
585 return 0;
586 }
587
588 priv = (void *)&slre;
589#endif
Wolfgang Denkea009d42013-03-23 23:50:28 +0000590 if (flag & H_MATCH_KEY) {
Wolfgang Denkbe29df62013-03-23 23:50:32 +0000591 if (match_string(flag, ep->key, argv[arg], priv))
Wolfgang Denk5a31ea02013-03-23 23:50:29 +0000592 return 1;
593 }
594 if (flag & H_MATCH_DATA) {
Wolfgang Denkbe29df62013-03-23 23:50:32 +0000595 if (match_string(flag, ep->data, argv[arg], priv))
Wolfgang Denk5a31ea02013-03-23 23:50:29 +0000596 return 1;
Wolfgang Denkea009d42013-03-23 23:50:28 +0000597 }
598 }
599 return 0;
600}
601
Joe Hershbergerbe112352012-12-11 22:16:23 -0600602ssize_t hexport_r(struct hsearch_data *htab, const char sep, int flag,
Wolfgang Denk37f2fe72011-11-06 22:49:44 +0100603 char **resp, size_t size,
Simon Glass09140112020-05-10 11:40:03 -0600604 int argc, char *const argv[])
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200605{
Simon Glassdd2408c2019-08-02 09:44:18 -0600606 struct env_entry *list[htab->size];
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200607 char *res, *p;
608 size_t totlen;
609 int i, n;
610
611 /* Test for correct arguments. */
612 if ((resp == NULL) || (htab == NULL)) {
613 __set_errno(EINVAL);
614 return (-1);
615 }
616
Simon Glassc55d02b2016-07-22 09:22:48 -0600617 debug("EXPORT table = %p, htab.size = %d, htab.filled = %d, size = %lu\n",
618 htab, htab->size, htab->filled, (ulong)size);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200619 /*
620 * Pass 1:
621 * search used entries,
622 * save addresses and compute total length
623 */
624 for (i = 1, n = 0, totlen = 0; i <= htab->size; ++i) {
625
Peter Baradac81c1222011-03-21 19:05:20 -0400626 if (htab->table[i].used > 0) {
Simon Glassdd2408c2019-08-02 09:44:18 -0600627 struct env_entry *ep = &htab->table[i].entry;
Wolfgang Denk5a31ea02013-03-23 23:50:29 +0000628 int found = match_entry(ep, flag, argc, argv);
Wolfgang Denk37f2fe72011-11-06 22:49:44 +0100629
Wolfgang Denk37f2fe72011-11-06 22:49:44 +0100630 if ((argc > 0) && (found == 0))
631 continue;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200632
Joe Hershbergerbe112352012-12-11 22:16:23 -0600633 if ((flag & H_HIDE_DOT) && ep->key[0] == '.')
634 continue;
635
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200636 list[n++] = ep;
637
Zubair Lutfullah Kakakhelf1b20ac2018-07-17 19:25:38 +0100638 totlen += strlen(ep->key);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200639
640 if (sep == '\0') {
641 totlen += strlen(ep->data);
642 } else { /* check if escapes are needed */
643 char *s = ep->data;
644
645 while (*s) {
646 ++totlen;
647 /* add room for needed escape chars */
648 if ((*s == sep) || (*s == '\\'))
649 ++totlen;
650 ++s;
651 }
652 }
653 totlen += 2; /* for '=' and 'sep' char */
654 }
655 }
656
657#ifdef DEBUG
658 /* Pass 1a: print unsorted list */
659 printf("Unsorted: n=%d\n", n);
660 for (i = 0; i < n; ++i) {
661 printf("\t%3d: %p ==> %-10s => %s\n",
662 i, list[i], list[i]->key, list[i]->data);
663 }
664#endif
665
666 /* Sort list by keys */
Simon Glassdd2408c2019-08-02 09:44:18 -0600667 qsort(list, n, sizeof(struct env_entry *), cmpkey);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200668
669 /* Check if the user supplied buffer size is sufficient */
670 if (size) {
671 if (size < totlen + 1) { /* provided buffer too small */
Simon Glassc55d02b2016-07-22 09:22:48 -0600672 printf("Env export buffer too small: %lu, but need %lu\n",
673 (ulong)size, (ulong)totlen + 1);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200674 __set_errno(ENOMEM);
675 return (-1);
676 }
677 } else {
AKASHI Takahiro4bca3242018-12-14 18:42:51 +0900678 size = totlen + 1;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200679 }
680
681 /* Check if the user provided a buffer */
682 if (*resp) {
683 /* yes; clear it */
684 res = *resp;
685 memset(res, '\0', size);
686 } else {
687 /* no, allocate and clear one */
688 *resp = res = calloc(1, size);
689 if (res == NULL) {
690 __set_errno(ENOMEM);
691 return (-1);
692 }
693 }
694 /*
695 * Pass 2:
696 * export sorted list of result data
697 */
698 for (i = 0, p = res; i < n; ++i) {
Wolfgang Denk84b5e802011-07-29 14:42:18 +0200699 const char *s;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200700
701 s = list[i]->key;
702 while (*s)
703 *p++ = *s++;
704 *p++ = '=';
705
706 s = list[i]->data;
707
708 while (*s) {
709 if ((*s == sep) || (*s == '\\'))
710 *p++ = '\\'; /* escape */
711 *p++ = *s++;
712 }
713 *p++ = sep;
714 }
715 *p = '\0'; /* terminate result */
716
717 return size;
718}
Ilya Yanok7ac2fe22012-09-18 00:22:50 +0000719#endif
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200720
721
722/*
723 * himport()
724 */
725
Gerlando Falautod5370fe2012-08-26 21:53:00 +0000726/*
727 * Check whether variable 'name' is amongst vars[],
728 * and remove all instances by setting the pointer to NULL
729 */
730static int drop_var_from_set(const char *name, int nvars, char * vars[])
Gerlando Falauto348b1f12012-08-24 00:11:38 +0000731{
732 int i = 0;
Gerlando Falautod5370fe2012-08-26 21:53:00 +0000733 int res = 0;
Gerlando Falauto348b1f12012-08-24 00:11:38 +0000734
735 /* No variables specified means process all of them */
736 if (nvars == 0)
737 return 1;
738
739 for (i = 0; i < nvars; i++) {
Gerlando Falautod5370fe2012-08-26 21:53:00 +0000740 if (vars[i] == NULL)
741 continue;
742 /* If we found it, delete all of them */
743 if (!strcmp(name, vars[i])) {
744 vars[i] = NULL;
745 res = 1;
746 }
Gerlando Falauto348b1f12012-08-24 00:11:38 +0000747 }
Gerlando Falautod5370fe2012-08-26 21:53:00 +0000748 if (!res)
749 debug("Skipping non-listed variable %s\n", name);
Gerlando Falauto348b1f12012-08-24 00:11:38 +0000750
Gerlando Falautod5370fe2012-08-26 21:53:00 +0000751 return res;
Gerlando Falauto348b1f12012-08-24 00:11:38 +0000752}
753
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200754/*
755 * Import linearized data into hash table.
756 *
757 * This is the inverse function to hexport(): it takes a linear list
758 * of "name=value" pairs and creates hash table entries from it.
759 *
760 * Entries without "value", i. e. consisting of only "name" or
761 * "name=", will cause this entry to be deleted from the hash table.
762 *
763 * The "flag" argument can be used to control the behaviour: when the
764 * H_NOCLEAR bit is set, then an existing hash table will kept, i. e.
Quentin Schulzd9fc9072018-07-09 19:16:28 +0200765 * new data will be added to an existing hash table; otherwise, if no
766 * vars are passed, old data will be discarded and a new hash table
767 * will be created. If vars are passed, passed vars that are not in
768 * the linear list of "name=value" pairs will be removed from the
769 * current hash table.
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200770 *
771 * The separator character for the "name=value" pairs can be selected,
772 * so we both support importing from externally stored environment
773 * data (separated by NUL characters) and from plain text files
774 * (entries separated by newline characters).
775 *
776 * To allow for nicely formatted text input, leading white space
777 * (sequences of SPACE and TAB chars) is ignored, and entries starting
778 * (after removal of any leading white space) with a '#' character are
779 * considered comments and ignored.
780 *
781 * [NOTE: this means that a variable name cannot start with a '#'
782 * character.]
783 *
784 * When using a non-NUL separator character, backslash is used as
785 * escape character in the value part, allowing for example for
786 * multi-line values.
787 *
788 * In theory, arbitrary separator characters can be used, but only
789 * '\0' and '\n' have really been tested.
790 */
791
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200792int himport_r(struct hsearch_data *htab,
Gerlando Falauto348b1f12012-08-24 00:11:38 +0000793 const char *env, size_t size, const char sep, int flag,
Alexander Hollerecd14462014-07-14 17:49:55 +0200794 int crlf_is_lf, int nvars, char * const vars[])
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200795{
796 char *data, *sp, *dp, *name, *value;
Gerlando Falautod5370fe2012-08-26 21:53:00 +0000797 char *localvars[nvars];
798 int i;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200799
800 /* Test for correct arguments. */
801 if (htab == NULL) {
802 __set_errno(EINVAL);
803 return 0;
804 }
805
806 /* we allocate new space to make sure we can write to the array */
Lukasz Majewski817e48d2015-09-14 00:57:03 +0200807 if ((data = malloc(size + 1)) == NULL) {
Simon Glassc55d02b2016-07-22 09:22:48 -0600808 debug("himport_r: can't malloc %lu bytes\n", (ulong)size + 1);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200809 __set_errno(ENOMEM);
810 return 0;
811 }
812 memcpy(data, env, size);
Lukasz Majewski817e48d2015-09-14 00:57:03 +0200813 data[size] = '\0';
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200814 dp = data;
815
Gerlando Falautod5370fe2012-08-26 21:53:00 +0000816 /* make a local copy of the list of variables */
817 if (nvars)
818 memcpy(localvars, vars, sizeof(vars[0]) * nvars);
819
Marek Vasut47f3b1f2020-07-07 20:51:38 +0200820#if CONFIG_IS_ENABLED(ENV_APPEND)
821 flag |= H_NOCLEAR;
822#endif
823
Quentin Schulzd9fc9072018-07-09 19:16:28 +0200824 if ((flag & H_NOCLEAR) == 0 && !nvars) {
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200825 /* Destroy old hash table if one exists */
826 debug("Destroy Hash Table: %p table = %p\n", htab,
827 htab->table);
828 if (htab->table)
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600829 hdestroy_r(htab);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200830 }
831
832 /*
833 * Create new hash table (if needed). The computation of the hash
834 * table size is based on heuristics: in a sample of some 70+
835 * existing systems we found an average size of 39+ bytes per entry
836 * in the environment (for the whole key=value pair). Assuming a
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200837 * size of 8 per entry (= safety factor of ~5) should provide enough
838 * safety margin for any existing environment definitions and still
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200839 * allow for more than enough dynamic additions. Note that the
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -0400840 * "size" argument is supposed to give the maximum environment size
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200841 * (CONFIG_ENV_SIZE). This heuristics will result in
842 * unreasonably large numbers (and thus memory footprint) for
843 * big flash environments (>8,000 entries for 64 KB
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400844 * environment size), so we clip it to a reasonable value.
Andreas Bießmannfc5fc762010-10-01 22:51:02 +0200845 * On the other hand we need to add some more entries for free
846 * space when importing very small buffers. Both boundaries can
847 * be overwritten in the board config file if needed.
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200848 */
849
850 if (!htab->table) {
Andreas Bießmannfc5fc762010-10-01 22:51:02 +0200851 int nent = CONFIG_ENV_MIN_ENTRIES + size / 8;
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200852
853 if (nent > CONFIG_ENV_MAX_ENTRIES)
854 nent = CONFIG_ENV_MAX_ENTRIES;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200855
856 debug("Create Hash Table: N=%d\n", nent);
857
858 if (hcreate_r(nent, htab) == 0) {
859 free(data);
860 return 0;
861 }
862 }
863
Lukasz Majewski0226d872015-09-14 00:57:04 +0200864 if (!size) {
865 free(data);
Alexander Hollerecd14462014-07-14 17:49:55 +0200866 return 1; /* everything OK */
Lukasz Majewski0226d872015-09-14 00:57:04 +0200867 }
Alexander Hollerecd14462014-07-14 17:49:55 +0200868 if(crlf_is_lf) {
869 /* Remove Carriage Returns in front of Line Feeds */
870 unsigned ignored_crs = 0;
871 for(;dp < data + size && *dp; ++dp) {
872 if(*dp == '\r' &&
873 dp < data + size - 1 && *(dp+1) == '\n')
874 ++ignored_crs;
875 else
876 *(dp-ignored_crs) = *dp;
877 }
878 size -= ignored_crs;
879 dp = data;
880 }
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200881 /* Parse environment; allow for '\0' and 'sep' as separators */
882 do {
Simon Glassdd2408c2019-08-02 09:44:18 -0600883 struct env_entry e, *rv;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200884
885 /* skip leading white space */
Jason Hobbs4d91a6e2011-08-23 11:06:54 +0000886 while (isblank(*dp))
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200887 ++dp;
888
889 /* skip comment lines */
890 if (*dp == '#') {
891 while (*dp && (*dp != sep))
892 ++dp;
893 ++dp;
894 continue;
895 }
896
897 /* parse name */
898 for (name = dp; *dp != '=' && *dp && *dp != sep; ++dp)
899 ;
900
901 /* deal with "name" and "name=" entries (delete var) */
902 if (*dp == '\0' || *(dp + 1) == '\0' ||
903 *dp == sep || *(dp + 1) == sep) {
904 if (*dp == '=')
905 *dp++ = '\0';
906 *dp++ = '\0'; /* terminate name */
907
908 debug("DELETE CANDIDATE: \"%s\"\n", name);
Gerlando Falautod5370fe2012-08-26 21:53:00 +0000909 if (!drop_var_from_set(name, nvars, localvars))
Gerlando Falauto348b1f12012-08-24 00:11:38 +0000910 continue;
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200911
Simon Glass96434a72020-11-05 10:33:37 -0700912 if (hdelete_r(name, htab, flag))
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200913 debug("DELETE ERROR ##############################\n");
914
915 continue;
916 }
917 *dp++ = '\0'; /* terminate name */
918
919 /* parse value; deal with escapes */
920 for (value = sp = dp; *dp && (*dp != sep); ++dp) {
921 if ((*dp == '\\') && *(dp + 1))
922 ++dp;
923 *sp++ = *dp;
924 }
925 *sp++ = '\0'; /* terminate value */
926 ++dp;
927
Lucian Cojocare4fdcad2013-04-28 11:31:57 +0000928 if (*name == 0) {
929 debug("INSERT: unable to use an empty key\n");
930 __set_errno(EINVAL);
Lukasz Majewski0226d872015-09-14 00:57:04 +0200931 free(data);
Lucian Cojocare4fdcad2013-04-28 11:31:57 +0000932 return 0;
933 }
934
Gerlando Falauto348b1f12012-08-24 00:11:38 +0000935 /* Skip variables which are not supposed to be processed */
Gerlando Falautod5370fe2012-08-26 21:53:00 +0000936 if (!drop_var_from_set(name, nvars, localvars))
Gerlando Falauto348b1f12012-08-24 00:11:38 +0000937 continue;
938
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200939 /* enter into hash table */
940 e.key = name;
941 e.data = value;
942
Simon Glass3f0d6802019-08-01 09:47:09 -0600943 hsearch_r(e, ENV_ENTER, &rv, htab, flag);
Simon Glass28de1e02023-02-05 15:39:50 -0700944#if !IS_ENABLED(CONFIG_ENV_WRITEABLE_LIST)
Marek Vasutd045cba2020-07-07 20:51:39 +0200945 if (rv == NULL) {
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200946 printf("himport_r: can't insert \"%s=%s\" into hash table\n",
947 name, value);
Marek Vasutd045cba2020-07-07 20:51:39 +0200948 }
949#endif
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200950
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200951 debug("INSERT: table %p, filled %d/%d rv %p ==> name=\"%s\" value=\"%s\"\n",
952 htab, htab->filled, htab->size,
953 rv, name, value);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200954 } while ((dp < data + size) && *dp); /* size check needed for text */
955 /* without '\0' termination */
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200956 debug("INSERT: free(data = %p)\n", data);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200957 free(data);
958
Quentin Schulzd9fc9072018-07-09 19:16:28 +0200959 if (flag & H_NOCLEAR)
960 goto end;
961
Gerlando Falautod5370fe2012-08-26 21:53:00 +0000962 /* process variables which were not considered */
963 for (i = 0; i < nvars; i++) {
964 if (localvars[i] == NULL)
965 continue;
966 /*
967 * All variables which were not deleted from the variable list
968 * were not present in the imported env
969 * This could mean two things:
970 * a) if the variable was present in current env, we delete it
971 * b) if the variable was not present in current env, we notify
972 * it might be a typo
973 */
Simon Glass96434a72020-11-05 10:33:37 -0700974 if (hdelete_r(localvars[i], htab, flag))
Gerlando Falautod5370fe2012-08-26 21:53:00 +0000975 printf("WARNING: '%s' neither in running nor in imported env!\n", localvars[i]);
976 else
977 printf("WARNING: '%s' not in imported env, deleting it!\n", localvars[i]);
978 }
979
Quentin Schulzd9fc9072018-07-09 19:16:28 +0200980end:
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200981 debug("INSERT: done\n");
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200982 return 1; /* everything OK */
983}
Joe Hershberger170ab112012-12-11 22:16:24 -0600984
985/*
986 * hwalk_r()
987 */
988
989/*
990 * Walk all of the entries in the hash, calling the callback for each one.
991 * this allows some generic operation to be performed on each element.
992 */
Simon Glassdd2408c2019-08-02 09:44:18 -0600993int hwalk_r(struct hsearch_data *htab, int (*callback)(struct env_entry *entry))
Joe Hershberger170ab112012-12-11 22:16:24 -0600994{
995 int i;
996 int retval;
997
998 for (i = 1; i <= htab->size; ++i) {
999 if (htab->table[i].used > 0) {
1000 retval = callback(&htab->table[i].entry);
1001 if (retval)
1002 return retval;
1003 }
1004 }
1005
1006 return 0;
1007}