Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | // SPDX-License-Identifier: LGPL-2.1+ |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 2 | /* |
| 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 Denk | 565af27 | 2013-03-23 23:50:28 +0000 | [diff] [blame] | 6 | * Copyright (C) 2010-2013 Wolfgang Denk <wd@denx.de> |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 7 | * |
| 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 Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 13 | */ |
| 14 | |
| 15 | #include <errno.h> |
Simon Glass | 0f2af88 | 2020-05-10 11:40:05 -0600 | [diff] [blame] | 16 | #include <log.h> |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 17 | #include <malloc.h> |
Simon Glass | 16ff570 | 2019-11-14 12:57:19 -0700 | [diff] [blame] | 18 | #include <sort.h> |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 19 | |
| 20 | #ifdef USE_HOSTCC /* HOST build */ |
| 21 | # include <string.h> |
| 22 | # include <assert.h> |
Jason Hobbs | cafa1aa | 2011-08-23 11:06:54 +0000 | [diff] [blame] | 23 | # include <ctype.h> |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 24 | |
| 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 */ |
| 33 | # include <common.h> |
| 34 | # include <linux/string.h> |
Jason Hobbs | cafa1aa | 2011-08-23 11:06:54 +0000 | [diff] [blame] | 35 | # include <linux/ctype.h> |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 36 | #endif |
| 37 | |
Roman Kapl | 07cb4e1 | 2019-01-30 11:39:54 +0100 | [diff] [blame] | 38 | #define USED_FREE 0 |
| 39 | #define USED_DELETED -1 |
| 40 | |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 41 | #include <env_callback.h> |
Joe Hershberger | 71497d0 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 42 | #include <env_flags.h> |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 43 | #include <search.h> |
Wolfgang Denk | ac9c301 | 2013-03-23 23:50:32 +0000 | [diff] [blame] | 44 | #include <slre.h> |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 45 | |
| 46 | /* |
| 47 | * [Aho,Sethi,Ullman] Compilers: Principles, Techniques and Tools, 1986 |
Wolfgang Denk | 1136f69 | 2010-10-27 22:48:30 +0200 | [diff] [blame] | 48 | * [Knuth] The Art of Computer Programming, part 3 (6.4) |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 49 | */ |
| 50 | |
| 51 | /* |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 52 | * The reentrant version has no static variables to maintain the state. |
| 53 | * Instead the interface of all functions is extended to take an argument |
| 54 | * which describes the current status. |
| 55 | */ |
Joe Hershberger | 638e659 | 2012-12-11 22:16:21 -0600 | [diff] [blame] | 56 | |
Simon Glass | d2c1ca8 | 2019-08-02 09:44:19 -0600 | [diff] [blame] | 57 | struct env_entry_node { |
Peter Barada | 305775b | 2011-03-21 19:05:20 -0400 | [diff] [blame] | 58 | int used; |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 59 | struct env_entry entry; |
Simon Glass | d2c1ca8 | 2019-08-02 09:44:19 -0600 | [diff] [blame] | 60 | }; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 61 | |
| 62 | |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 63 | static void _hdelete(const char *key, struct hsearch_data *htab, |
| 64 | struct env_entry *ep, int idx); |
Joe Hershberger | 638e659 | 2012-12-11 22:16:21 -0600 | [diff] [blame] | 65 | |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 66 | /* |
| 67 | * hcreate() |
| 68 | */ |
| 69 | |
| 70 | /* |
| 71 | * For the used double hash method the table size has to be a prime. To |
| 72 | * correct the user given table size we need a prime test. This trivial |
| 73 | * algorithm is adequate because |
| 74 | * a) the code is (most probably) called a few times per program run and |
| 75 | * b) the number is small because the table must fit in the core |
| 76 | * */ |
| 77 | static int isprime(unsigned int number) |
| 78 | { |
| 79 | /* no even number will be passed */ |
| 80 | unsigned int div = 3; |
| 81 | |
| 82 | while (div * div < number && number % div != 0) |
| 83 | div += 2; |
| 84 | |
| 85 | return number % div != 0; |
| 86 | } |
| 87 | |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 88 | /* |
| 89 | * Before using the hash table we must allocate memory for it. |
| 90 | * Test for an existing table are done. We allocate one element |
| 91 | * more as the found prime number says. This is done for more effective |
| 92 | * indexing as explained in the comment for the hsearch function. |
| 93 | * The contents of the table is zeroed, especially the field used |
| 94 | * becomes zero. |
| 95 | */ |
Mike Frysinger | 92d7a99 | 2010-12-08 06:26:04 -0500 | [diff] [blame] | 96 | |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 97 | int hcreate_r(size_t nel, struct hsearch_data *htab) |
| 98 | { |
| 99 | /* Test for correct arguments. */ |
| 100 | if (htab == NULL) { |
| 101 | __set_errno(EINVAL); |
| 102 | return 0; |
| 103 | } |
| 104 | |
| 105 | /* There is still another table active. Return with error. */ |
Sean Anderson | b02f055 | 2020-06-24 06:41:15 -0400 | [diff] [blame] | 106 | if (htab->table != NULL) { |
| 107 | __set_errno(EINVAL); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 108 | return 0; |
Sean Anderson | b02f055 | 2020-06-24 06:41:15 -0400 | [diff] [blame] | 109 | } |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 110 | |
| 111 | /* Change nel to the first prime number not smaller as nel. */ |
| 112 | nel |= 1; /* make odd */ |
| 113 | while (!isprime(nel)) |
| 114 | nel += 2; |
| 115 | |
| 116 | htab->size = nel; |
| 117 | htab->filled = 0; |
| 118 | |
| 119 | /* allocate memory and zero out */ |
Simon Glass | d2c1ca8 | 2019-08-02 09:44:19 -0600 | [diff] [blame] | 120 | htab->table = (struct env_entry_node *)calloc(htab->size + 1, |
| 121 | sizeof(struct env_entry_node)); |
Sean Anderson | b02f055 | 2020-06-24 06:41:15 -0400 | [diff] [blame] | 122 | if (htab->table == NULL) { |
| 123 | __set_errno(ENOMEM); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 124 | return 0; |
Sean Anderson | b02f055 | 2020-06-24 06:41:15 -0400 | [diff] [blame] | 125 | } |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 126 | |
| 127 | /* everything went alright */ |
| 128 | return 1; |
| 129 | } |
| 130 | |
| 131 | |
| 132 | /* |
| 133 | * hdestroy() |
| 134 | */ |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 135 | |
| 136 | /* |
| 137 | * After using the hash table it has to be destroyed. The used memory can |
| 138 | * be freed and the local static variable can be marked as not used. |
| 139 | */ |
Mike Frysinger | 92d7a99 | 2010-12-08 06:26:04 -0500 | [diff] [blame] | 140 | |
Joe Hershberger | a46f770 | 2012-12-11 22:16:19 -0600 | [diff] [blame] | 141 | void hdestroy_r(struct hsearch_data *htab) |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 142 | { |
| 143 | int i; |
| 144 | |
| 145 | /* Test for correct arguments. */ |
| 146 | if (htab == NULL) { |
| 147 | __set_errno(EINVAL); |
| 148 | return; |
| 149 | } |
| 150 | |
| 151 | /* free used memory */ |
| 152 | for (i = 1; i <= htab->size; ++i) { |
Peter Barada | 305775b | 2011-03-21 19:05:20 -0400 | [diff] [blame] | 153 | if (htab->table[i].used > 0) { |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 154 | struct env_entry *ep = &htab->table[i].entry; |
Joe Hershberger | a46f770 | 2012-12-11 22:16:19 -0600 | [diff] [blame] | 155 | |
Wolfgang Denk | d67abff | 2011-07-29 14:42:18 +0200 | [diff] [blame] | 156 | free((void *)ep->key); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 157 | free(ep->data); |
| 158 | } |
| 159 | } |
| 160 | free(htab->table); |
| 161 | |
| 162 | /* the sign for an existing table is an value != NULL in htable */ |
| 163 | htab->table = NULL; |
| 164 | } |
| 165 | |
| 166 | /* |
| 167 | * hsearch() |
| 168 | */ |
| 169 | |
| 170 | /* |
| 171 | * This is the search function. It uses double hashing with open addressing. |
| 172 | * The argument item.key has to be a pointer to an zero terminated, most |
| 173 | * probably strings of chars. The function for generating a number of the |
| 174 | * strings is simple but fast. It can be replaced by a more complex function |
| 175 | * like ajw (see [Aho,Sethi,Ullman]) if the needs are shown. |
| 176 | * |
| 177 | * We use an trick to speed up the lookup. The table is created by hcreate |
| 178 | * with one more element available. This enables us to use the index zero |
| 179 | * special. This index will never be used because we store the first hash |
| 180 | * index in the field used where zero means not used. Every other value |
| 181 | * means used. The used field can be used as a first fast comparison for |
| 182 | * equality of the stored and the parameter value. This helps to prevent |
| 183 | * unnecessary expensive calls of strcmp. |
| 184 | * |
| 185 | * This implementation differs from the standard library version of |
| 186 | * this function in a number of ways: |
| 187 | * |
| 188 | * - While the standard version does not make any assumptions about |
| 189 | * the type of the stored data objects at all, this implementation |
| 190 | * works with NUL terminated strings only. |
| 191 | * - Instead of storing just pointers to the original objects, we |
| 192 | * create local copies so the caller does not need to care about the |
| 193 | * data any more. |
| 194 | * - The standard implementation does not provide a way to update an |
| 195 | * existing entry. This version will create a new entry or update an |
Simon Glass | 63a2f57 | 2019-08-01 09:47:09 -0600 | [diff] [blame] | 196 | * existing one when both "action == ENV_ENTER" and "item.data != NULL". |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 197 | * - Instead of returning 1 on success, we return the index into the |
| 198 | * internal hash table, which is also guaranteed to be positive. |
| 199 | * This allows us direct access to the found hash table slot for |
| 200 | * example for functions like hdelete(). |
| 201 | */ |
| 202 | |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 203 | int hmatch_r(const char *match, int last_idx, struct env_entry **retval, |
Mike Frysinger | 8d88232 | 2010-12-17 16:51:59 -0500 | [diff] [blame] | 204 | struct hsearch_data *htab) |
| 205 | { |
| 206 | unsigned int idx; |
| 207 | size_t key_len = strlen(match); |
| 208 | |
| 209 | for (idx = last_idx + 1; idx < htab->size; ++idx) { |
Kim Phillips | f73d935 | 2011-04-04 15:17:45 +0000 | [diff] [blame] | 210 | if (htab->table[idx].used <= 0) |
Mike Frysinger | 8d88232 | 2010-12-17 16:51:59 -0500 | [diff] [blame] | 211 | continue; |
| 212 | if (!strncmp(match, htab->table[idx].entry.key, key_len)) { |
| 213 | *retval = &htab->table[idx].entry; |
| 214 | return idx; |
| 215 | } |
| 216 | } |
| 217 | |
| 218 | __set_errno(ESRCH); |
| 219 | *retval = NULL; |
| 220 | return 0; |
| 221 | } |
| 222 | |
Rasmus Villemoes | 2bd84a7 | 2020-02-27 13:56:11 +0000 | [diff] [blame] | 223 | static int |
| 224 | do_callback(const struct env_entry *e, const char *name, const char *value, |
| 225 | enum env_op op, int flags) |
| 226 | { |
Rasmus Villemoes | 3a76d2a | 2020-02-27 13:56:11 +0000 | [diff] [blame] | 227 | #ifndef CONFIG_SPL_BUILD |
Rasmus Villemoes | 2bd84a7 | 2020-02-27 13:56:11 +0000 | [diff] [blame] | 228 | if (e->callback) |
| 229 | return e->callback(name, value, op, flags); |
Rasmus Villemoes | 3a76d2a | 2020-02-27 13:56:11 +0000 | [diff] [blame] | 230 | #endif |
Rasmus Villemoes | 2bd84a7 | 2020-02-27 13:56:11 +0000 | [diff] [blame] | 231 | return 0; |
| 232 | } |
| 233 | |
Joe Hershberger | e5611c3 | 2012-12-11 22:16:20 -0600 | [diff] [blame] | 234 | /* |
| 235 | * Compare an existing entry with the desired key, and overwrite if the action |
Simon Glass | 63a2f57 | 2019-08-01 09:47:09 -0600 | [diff] [blame] | 236 | * is ENV_ENTER. This is simply a helper function for hsearch_r(). |
Joe Hershberger | e5611c3 | 2012-12-11 22:16:20 -0600 | [diff] [blame] | 237 | */ |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 238 | static inline int _compare_and_overwrite_entry(struct env_entry item, |
Simon Glass | 63a2f57 | 2019-08-01 09:47:09 -0600 | [diff] [blame] | 239 | enum env_action action, struct env_entry **retval, |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 240 | struct hsearch_data *htab, int flag, unsigned int hval, |
| 241 | unsigned int idx) |
Joe Hershberger | e5611c3 | 2012-12-11 22:16:20 -0600 | [diff] [blame] | 242 | { |
| 243 | if (htab->table[idx].used == hval |
| 244 | && strcmp(item.key, htab->table[idx].entry.key) == 0) { |
| 245 | /* Overwrite existing value? */ |
Simon Glass | 63a2f57 | 2019-08-01 09:47:09 -0600 | [diff] [blame] | 246 | if (action == ENV_ENTER && item.data) { |
Joe Hershberger | 638e659 | 2012-12-11 22:16:21 -0600 | [diff] [blame] | 247 | /* check for permission */ |
| 248 | if (htab->change_ok != NULL && htab->change_ok( |
| 249 | &htab->table[idx].entry, item.data, |
| 250 | env_op_overwrite, flag)) { |
| 251 | debug("change_ok() rejected setting variable " |
| 252 | "%s, skipping it!\n", item.key); |
| 253 | __set_errno(EPERM); |
| 254 | *retval = NULL; |
| 255 | return 0; |
| 256 | } |
| 257 | |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 258 | /* If there is a callback, call it */ |
Rasmus Villemoes | 2bd84a7 | 2020-02-27 13:56:11 +0000 | [diff] [blame] | 259 | if (do_callback(&htab->table[idx].entry, item.key, |
| 260 | item.data, env_op_overwrite, flag)) { |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 261 | debug("callback() rejected setting variable " |
| 262 | "%s, skipping it!\n", item.key); |
| 263 | __set_errno(EINVAL); |
| 264 | *retval = NULL; |
| 265 | return 0; |
| 266 | } |
| 267 | |
Joe Hershberger | e5611c3 | 2012-12-11 22:16:20 -0600 | [diff] [blame] | 268 | free(htab->table[idx].entry.data); |
| 269 | htab->table[idx].entry.data = strdup(item.data); |
| 270 | if (!htab->table[idx].entry.data) { |
| 271 | __set_errno(ENOMEM); |
| 272 | *retval = NULL; |
| 273 | return 0; |
| 274 | } |
| 275 | } |
| 276 | /* return found entry */ |
| 277 | *retval = &htab->table[idx].entry; |
| 278 | return idx; |
| 279 | } |
| 280 | /* keep searching */ |
| 281 | return -1; |
| 282 | } |
| 283 | |
Simon Glass | 63a2f57 | 2019-08-01 09:47:09 -0600 | [diff] [blame] | 284 | int hsearch_r(struct env_entry item, enum env_action action, |
| 285 | struct env_entry **retval, struct hsearch_data *htab, int flag) |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 286 | { |
| 287 | unsigned int hval; |
| 288 | unsigned int count; |
| 289 | unsigned int len = strlen(item.key); |
| 290 | unsigned int idx; |
Peter Barada | 305775b | 2011-03-21 19:05:20 -0400 | [diff] [blame] | 291 | unsigned int first_deleted = 0; |
Joe Hershberger | e5611c3 | 2012-12-11 22:16:20 -0600 | [diff] [blame] | 292 | int ret; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 293 | |
| 294 | /* Compute an value for the given string. Perhaps use a better method. */ |
| 295 | hval = len; |
| 296 | count = len; |
| 297 | while (count-- > 0) { |
| 298 | hval <<= 4; |
| 299 | hval += item.key[count]; |
| 300 | } |
| 301 | |
| 302 | /* |
| 303 | * First hash function: |
| 304 | * simply take the modul but prevent zero. |
| 305 | */ |
| 306 | hval %= htab->size; |
| 307 | if (hval == 0) |
| 308 | ++hval; |
| 309 | |
| 310 | /* The first index tried. */ |
| 311 | idx = hval; |
| 312 | |
| 313 | if (htab->table[idx].used) { |
| 314 | /* |
Wolfgang Denk | 1136f69 | 2010-10-27 22:48:30 +0200 | [diff] [blame] | 315 | * Further action might be required according to the |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 316 | * action value. |
| 317 | */ |
| 318 | unsigned hval2; |
| 319 | |
Heinrich Schuchardt | 468da57 | 2020-08-20 19:57:45 +0200 | [diff] [blame] | 320 | if (htab->table[idx].used == USED_DELETED) |
Peter Barada | 305775b | 2011-03-21 19:05:20 -0400 | [diff] [blame] | 321 | first_deleted = idx; |
| 322 | |
Joe Hershberger | e5611c3 | 2012-12-11 22:16:20 -0600 | [diff] [blame] | 323 | ret = _compare_and_overwrite_entry(item, action, retval, htab, |
| 324 | flag, hval, idx); |
| 325 | if (ret != -1) |
| 326 | return ret; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 327 | |
| 328 | /* |
| 329 | * Second hash function: |
| 330 | * as suggested in [Knuth] |
| 331 | */ |
| 332 | hval2 = 1 + hval % (htab->size - 2); |
| 333 | |
| 334 | do { |
| 335 | /* |
Wolfgang Denk | 1136f69 | 2010-10-27 22:48:30 +0200 | [diff] [blame] | 336 | * Because SIZE is prime this guarantees to |
| 337 | * step through all available indices. |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 338 | */ |
| 339 | if (idx <= hval2) |
| 340 | idx = htab->size + idx - hval2; |
| 341 | else |
| 342 | idx -= hval2; |
| 343 | |
| 344 | /* |
| 345 | * If we visited all entries leave the loop |
| 346 | * unsuccessfully. |
| 347 | */ |
| 348 | if (idx == hval) |
| 349 | break; |
| 350 | |
Roman Kapl | 07cb4e1 | 2019-01-30 11:39:54 +0100 | [diff] [blame] | 351 | if (htab->table[idx].used == USED_DELETED |
| 352 | && !first_deleted) |
| 353 | first_deleted = idx; |
| 354 | |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 355 | /* If entry is found use it. */ |
Joe Hershberger | e5611c3 | 2012-12-11 22:16:20 -0600 | [diff] [blame] | 356 | ret = _compare_and_overwrite_entry(item, action, retval, |
| 357 | htab, flag, hval, idx); |
| 358 | if (ret != -1) |
| 359 | return ret; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 360 | } |
Roman Kapl | 07cb4e1 | 2019-01-30 11:39:54 +0100 | [diff] [blame] | 361 | while (htab->table[idx].used != USED_FREE); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 362 | } |
| 363 | |
| 364 | /* An empty bucket has been found. */ |
Simon Glass | 63a2f57 | 2019-08-01 09:47:09 -0600 | [diff] [blame] | 365 | if (action == ENV_ENTER) { |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 366 | /* |
Wolfgang Denk | 1136f69 | 2010-10-27 22:48:30 +0200 | [diff] [blame] | 367 | * If table is full and another entry should be |
| 368 | * entered return with error. |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 369 | */ |
| 370 | if (htab->filled == htab->size) { |
| 371 | __set_errno(ENOMEM); |
| 372 | *retval = NULL; |
| 373 | return 0; |
| 374 | } |
| 375 | |
| 376 | /* |
| 377 | * Create new entry; |
| 378 | * create copies of item.key and item.data |
| 379 | */ |
Peter Barada | 305775b | 2011-03-21 19:05:20 -0400 | [diff] [blame] | 380 | if (first_deleted) |
| 381 | idx = first_deleted; |
| 382 | |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 383 | htab->table[idx].used = hval; |
| 384 | htab->table[idx].entry.key = strdup(item.key); |
| 385 | htab->table[idx].entry.data = strdup(item.data); |
| 386 | if (!htab->table[idx].entry.key || |
| 387 | !htab->table[idx].entry.data) { |
| 388 | __set_errno(ENOMEM); |
| 389 | *retval = NULL; |
| 390 | return 0; |
| 391 | } |
| 392 | |
| 393 | ++htab->filled; |
| 394 | |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 395 | /* This is a new entry, so look up a possible callback */ |
| 396 | env_callback_init(&htab->table[idx].entry); |
Joe Hershberger | 71497d0 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 397 | /* Also look for flags */ |
| 398 | env_flags_init(&htab->table[idx].entry); |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 399 | |
Joe Hershberger | 638e659 | 2012-12-11 22:16:21 -0600 | [diff] [blame] | 400 | /* check for permission */ |
| 401 | if (htab->change_ok != NULL && htab->change_ok( |
| 402 | &htab->table[idx].entry, item.data, env_op_create, flag)) { |
| 403 | debug("change_ok() rejected setting variable " |
| 404 | "%s, skipping it!\n", item.key); |
| 405 | _hdelete(item.key, htab, &htab->table[idx].entry, idx); |
| 406 | __set_errno(EPERM); |
| 407 | *retval = NULL; |
| 408 | return 0; |
| 409 | } |
| 410 | |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 411 | /* If there is a callback, call it */ |
Rasmus Villemoes | 2bd84a7 | 2020-02-27 13:56:11 +0000 | [diff] [blame] | 412 | if (do_callback(&htab->table[idx].entry, item.key, item.data, |
| 413 | env_op_create, flag)) { |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 414 | debug("callback() rejected setting variable " |
| 415 | "%s, skipping it!\n", item.key); |
| 416 | _hdelete(item.key, htab, &htab->table[idx].entry, idx); |
| 417 | __set_errno(EINVAL); |
| 418 | *retval = NULL; |
| 419 | return 0; |
| 420 | } |
| 421 | |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 422 | /* return new entry */ |
| 423 | *retval = &htab->table[idx].entry; |
| 424 | return 1; |
| 425 | } |
| 426 | |
| 427 | __set_errno(ESRCH); |
| 428 | *retval = NULL; |
| 429 | return 0; |
| 430 | } |
| 431 | |
| 432 | |
| 433 | /* |
| 434 | * hdelete() |
| 435 | */ |
| 436 | |
| 437 | /* |
| 438 | * The standard implementation of hsearch(3) does not provide any way |
| 439 | * to delete any entries from the hash table. We extend the code to |
| 440 | * do that. |
| 441 | */ |
| 442 | |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 443 | static void _hdelete(const char *key, struct hsearch_data *htab, |
| 444 | struct env_entry *ep, int idx) |
Joe Hershberger | 638e659 | 2012-12-11 22:16:21 -0600 | [diff] [blame] | 445 | { |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 446 | /* free used entry */ |
Joe Hershberger | 638e659 | 2012-12-11 22:16:21 -0600 | [diff] [blame] | 447 | debug("hdelete: DELETING key \"%s\"\n", key); |
| 448 | free((void *)ep->key); |
| 449 | free(ep->data); |
Joe Hershberger | 71497d0 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 450 | ep->flags = 0; |
Roman Kapl | 07cb4e1 | 2019-01-30 11:39:54 +0100 | [diff] [blame] | 451 | htab->table[idx].used = USED_DELETED; |
Joe Hershberger | 638e659 | 2012-12-11 22:16:21 -0600 | [diff] [blame] | 452 | |
| 453 | --htab->filled; |
| 454 | } |
| 455 | |
Joe Hershberger | a46f770 | 2012-12-11 22:16:19 -0600 | [diff] [blame] | 456 | int hdelete_r(const char *key, struct hsearch_data *htab, int flag) |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 457 | { |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 458 | struct env_entry e, *ep; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 459 | int idx; |
| 460 | |
| 461 | debug("hdelete: DELETE key \"%s\"\n", key); |
| 462 | |
| 463 | e.key = (char *)key; |
| 464 | |
Simon Glass | 63a2f57 | 2019-08-01 09:47:09 -0600 | [diff] [blame] | 465 | idx = hsearch_r(e, ENV_FIND, &ep, htab, 0); |
Joe Hershberger | a46f770 | 2012-12-11 22:16:19 -0600 | [diff] [blame] | 466 | if (idx == 0) { |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 467 | __set_errno(ESRCH); |
Simon Glass | 783ef3f | 2020-11-05 10:33:37 -0700 | [diff] [blame] | 468 | return -ENOENT; /* not found */ |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 469 | } |
| 470 | |
Joe Hershberger | a46f770 | 2012-12-11 22:16:19 -0600 | [diff] [blame] | 471 | /* Check for permission */ |
Joe Hershberger | 638e659 | 2012-12-11 22:16:21 -0600 | [diff] [blame] | 472 | if (htab->change_ok != NULL && |
| 473 | htab->change_ok(ep, NULL, env_op_delete, flag)) { |
| 474 | debug("change_ok() rejected deleting variable " |
| 475 | "%s, skipping it!\n", key); |
Joe Hershberger | a46f770 | 2012-12-11 22:16:19 -0600 | [diff] [blame] | 476 | __set_errno(EPERM); |
Simon Glass | 783ef3f | 2020-11-05 10:33:37 -0700 | [diff] [blame] | 477 | return -EPERM; |
Joe Hershberger | a46f770 | 2012-12-11 22:16:19 -0600 | [diff] [blame] | 478 | } |
| 479 | |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 480 | /* If there is a callback, call it */ |
Rasmus Villemoes | 2bd84a7 | 2020-02-27 13:56:11 +0000 | [diff] [blame] | 481 | if (do_callback(&htab->table[idx].entry, key, NULL, |
| 482 | env_op_delete, flag)) { |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 483 | debug("callback() rejected deleting variable " |
| 484 | "%s, skipping it!\n", key); |
| 485 | __set_errno(EINVAL); |
Simon Glass | 783ef3f | 2020-11-05 10:33:37 -0700 | [diff] [blame] | 486 | return -EINVAL; |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 487 | } |
| 488 | |
Joe Hershberger | 638e659 | 2012-12-11 22:16:21 -0600 | [diff] [blame] | 489 | _hdelete(key, htab, ep, idx); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 490 | |
Simon Glass | 783ef3f | 2020-11-05 10:33:37 -0700 | [diff] [blame] | 491 | return 0; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 492 | } |
| 493 | |
B, Ravi | e94b024 | 2016-09-28 14:46:18 +0530 | [diff] [blame] | 494 | #if !(defined(CONFIG_SPL_BUILD) && !defined(CONFIG_SPL_SAVEENV)) |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 495 | /* |
| 496 | * hexport() |
| 497 | */ |
| 498 | |
| 499 | /* |
| 500 | * Export the data stored in the hash table in linearized form. |
| 501 | * |
| 502 | * Entries are exported as "name=value" strings, separated by an |
| 503 | * arbitrary (non-NUL, of course) separator character. This allows to |
| 504 | * use this function both when formatting the U-Boot environment for |
| 505 | * external storage (using '\0' as separator), but also when using it |
| 506 | * for the "printenv" command to print all variables, simply by using |
| 507 | * as '\n" as separator. This can also be used for new features like |
| 508 | * exporting the environment data as text file, including the option |
| 509 | * for later re-import. |
| 510 | * |
| 511 | * The entries in the result list will be sorted by ascending key |
| 512 | * values. |
| 513 | * |
| 514 | * If the separator character is different from NUL, then any |
| 515 | * separator characters and backslash characters in the values will |
Robert P. J. Day | c5b1e5d | 2016-09-07 14:27:59 -0400 | [diff] [blame] | 516 | * be escaped by a preceding backslash in output. This is needed for |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 517 | * example to enable multi-line values, especially when the output |
| 518 | * shall later be parsed (for example, for re-import). |
| 519 | * |
| 520 | * There are several options how the result buffer is handled: |
| 521 | * |
| 522 | * *resp size |
| 523 | * ----------- |
| 524 | * NULL 0 A string of sufficient length will be allocated. |
| 525 | * NULL >0 A string of the size given will be |
| 526 | * allocated. An error will be returned if the size is |
| 527 | * not sufficient. Any unused bytes in the string will |
| 528 | * be '\0'-padded. |
| 529 | * !NULL 0 The user-supplied buffer will be used. No length |
| 530 | * checking will be performed, i. e. it is assumed that |
| 531 | * the buffer size will always be big enough. DANGEROUS. |
| 532 | * !NULL >0 The user-supplied buffer will be used. An error will |
| 533 | * be returned if the size is not sufficient. Any unused |
| 534 | * bytes in the string will be '\0'-padded. |
| 535 | */ |
| 536 | |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 537 | static int cmpkey(const void *p1, const void *p2) |
| 538 | { |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 539 | struct env_entry *e1 = *(struct env_entry **)p1; |
| 540 | struct env_entry *e2 = *(struct env_entry **)p2; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 541 | |
| 542 | return (strcmp(e1->key, e2->key)); |
| 543 | } |
| 544 | |
Wolfgang Denk | ac9c301 | 2013-03-23 23:50:32 +0000 | [diff] [blame] | 545 | static int match_string(int flag, const char *str, const char *pat, void *priv) |
Wolfgang Denk | e27fc12 | 2013-03-23 23:50:29 +0000 | [diff] [blame] | 546 | { |
| 547 | switch (flag & H_MATCH_METHOD) { |
| 548 | case H_MATCH_IDENT: |
| 549 | if (strcmp(str, pat) == 0) |
| 550 | return 1; |
| 551 | break; |
| 552 | case H_MATCH_SUBSTR: |
| 553 | if (strstr(str, pat)) |
| 554 | return 1; |
| 555 | break; |
Wolfgang Denk | ac9c301 | 2013-03-23 23:50:32 +0000 | [diff] [blame] | 556 | #ifdef CONFIG_REGEX |
| 557 | case H_MATCH_REGEX: |
| 558 | { |
| 559 | struct slre *slrep = (struct slre *)priv; |
Wolfgang Denk | ac9c301 | 2013-03-23 23:50:32 +0000 | [diff] [blame] | 560 | |
Heinrich Schuchardt | ac23970 | 2019-01-23 08:17:02 +0100 | [diff] [blame] | 561 | if (slre_match(slrep, str, strlen(str), NULL)) |
Wolfgang Denk | ac9c301 | 2013-03-23 23:50:32 +0000 | [diff] [blame] | 562 | return 1; |
| 563 | } |
| 564 | break; |
| 565 | #endif |
Wolfgang Denk | e27fc12 | 2013-03-23 23:50:29 +0000 | [diff] [blame] | 566 | default: |
| 567 | printf("## ERROR: unsupported match method: 0x%02x\n", |
| 568 | flag & H_MATCH_METHOD); |
| 569 | break; |
| 570 | } |
| 571 | return 0; |
| 572 | } |
| 573 | |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 574 | static int match_entry(struct env_entry *ep, int flag, int argc, |
| 575 | char *const argv[]) |
Wolfgang Denk | 565af27 | 2013-03-23 23:50:28 +0000 | [diff] [blame] | 576 | { |
| 577 | int arg; |
Wolfgang Denk | ac9c301 | 2013-03-23 23:50:32 +0000 | [diff] [blame] | 578 | void *priv = NULL; |
Wolfgang Denk | 565af27 | 2013-03-23 23:50:28 +0000 | [diff] [blame] | 579 | |
Pierre Aubert | d8d51f8 | 2013-10-08 14:20:27 +0200 | [diff] [blame] | 580 | for (arg = 0; arg < argc; ++arg) { |
Wolfgang Denk | ac9c301 | 2013-03-23 23:50:32 +0000 | [diff] [blame] | 581 | #ifdef CONFIG_REGEX |
| 582 | struct slre slre; |
| 583 | |
| 584 | if (slre_compile(&slre, argv[arg]) == 0) { |
| 585 | printf("Error compiling regex: %s\n", slre.err_str); |
| 586 | return 0; |
| 587 | } |
| 588 | |
| 589 | priv = (void *)&slre; |
| 590 | #endif |
Wolfgang Denk | 565af27 | 2013-03-23 23:50:28 +0000 | [diff] [blame] | 591 | if (flag & H_MATCH_KEY) { |
Wolfgang Denk | ac9c301 | 2013-03-23 23:50:32 +0000 | [diff] [blame] | 592 | if (match_string(flag, ep->key, argv[arg], priv)) |
Wolfgang Denk | e27fc12 | 2013-03-23 23:50:29 +0000 | [diff] [blame] | 593 | return 1; |
| 594 | } |
| 595 | if (flag & H_MATCH_DATA) { |
Wolfgang Denk | ac9c301 | 2013-03-23 23:50:32 +0000 | [diff] [blame] | 596 | if (match_string(flag, ep->data, argv[arg], priv)) |
Wolfgang Denk | e27fc12 | 2013-03-23 23:50:29 +0000 | [diff] [blame] | 597 | return 1; |
Wolfgang Denk | 565af27 | 2013-03-23 23:50:28 +0000 | [diff] [blame] | 598 | } |
| 599 | } |
| 600 | return 0; |
| 601 | } |
| 602 | |
Joe Hershberger | 79a905e | 2012-12-11 22:16:23 -0600 | [diff] [blame] | 603 | ssize_t hexport_r(struct hsearch_data *htab, const char sep, int flag, |
Wolfgang Denk | 1e3cdf3 | 2011-11-06 22:49:44 +0100 | [diff] [blame] | 604 | char **resp, size_t size, |
Simon Glass | ed38aef | 2020-05-10 11:40:03 -0600 | [diff] [blame] | 605 | int argc, char *const argv[]) |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 606 | { |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 607 | struct env_entry *list[htab->size]; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 608 | char *res, *p; |
| 609 | size_t totlen; |
| 610 | int i, n; |
| 611 | |
| 612 | /* Test for correct arguments. */ |
| 613 | if ((resp == NULL) || (htab == NULL)) { |
| 614 | __set_errno(EINVAL); |
| 615 | return (-1); |
| 616 | } |
| 617 | |
Simon Glass | f970ccb | 2016-07-22 09:22:48 -0600 | [diff] [blame] | 618 | debug("EXPORT table = %p, htab.size = %d, htab.filled = %d, size = %lu\n", |
| 619 | htab, htab->size, htab->filled, (ulong)size); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 620 | /* |
| 621 | * Pass 1: |
| 622 | * search used entries, |
| 623 | * save addresses and compute total length |
| 624 | */ |
| 625 | for (i = 1, n = 0, totlen = 0; i <= htab->size; ++i) { |
| 626 | |
Peter Barada | 305775b | 2011-03-21 19:05:20 -0400 | [diff] [blame] | 627 | if (htab->table[i].used > 0) { |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 628 | struct env_entry *ep = &htab->table[i].entry; |
Wolfgang Denk | e27fc12 | 2013-03-23 23:50:29 +0000 | [diff] [blame] | 629 | int found = match_entry(ep, flag, argc, argv); |
Wolfgang Denk | 1e3cdf3 | 2011-11-06 22:49:44 +0100 | [diff] [blame] | 630 | |
Wolfgang Denk | 1e3cdf3 | 2011-11-06 22:49:44 +0100 | [diff] [blame] | 631 | if ((argc > 0) && (found == 0)) |
| 632 | continue; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 633 | |
Joe Hershberger | 79a905e | 2012-12-11 22:16:23 -0600 | [diff] [blame] | 634 | if ((flag & H_HIDE_DOT) && ep->key[0] == '.') |
| 635 | continue; |
| 636 | |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 637 | list[n++] = ep; |
| 638 | |
Zubair Lutfullah Kakakhel | 305ad7a | 2018-07-17 19:25:38 +0100 | [diff] [blame] | 639 | totlen += strlen(ep->key); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 640 | |
| 641 | if (sep == '\0') { |
| 642 | totlen += strlen(ep->data); |
| 643 | } else { /* check if escapes are needed */ |
| 644 | char *s = ep->data; |
| 645 | |
| 646 | while (*s) { |
| 647 | ++totlen; |
| 648 | /* add room for needed escape chars */ |
| 649 | if ((*s == sep) || (*s == '\\')) |
| 650 | ++totlen; |
| 651 | ++s; |
| 652 | } |
| 653 | } |
| 654 | totlen += 2; /* for '=' and 'sep' char */ |
| 655 | } |
| 656 | } |
| 657 | |
| 658 | #ifdef DEBUG |
| 659 | /* Pass 1a: print unsorted list */ |
| 660 | printf("Unsorted: n=%d\n", n); |
| 661 | for (i = 0; i < n; ++i) { |
| 662 | printf("\t%3d: %p ==> %-10s => %s\n", |
| 663 | i, list[i], list[i]->key, list[i]->data); |
| 664 | } |
| 665 | #endif |
| 666 | |
| 667 | /* Sort list by keys */ |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 668 | qsort(list, n, sizeof(struct env_entry *), cmpkey); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 669 | |
| 670 | /* Check if the user supplied buffer size is sufficient */ |
| 671 | if (size) { |
| 672 | if (size < totlen + 1) { /* provided buffer too small */ |
Simon Glass | f970ccb | 2016-07-22 09:22:48 -0600 | [diff] [blame] | 673 | printf("Env export buffer too small: %lu, but need %lu\n", |
| 674 | (ulong)size, (ulong)totlen + 1); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 675 | __set_errno(ENOMEM); |
| 676 | return (-1); |
| 677 | } |
| 678 | } else { |
AKASHI Takahiro | 1f0f1bd | 2018-12-14 18:42:51 +0900 | [diff] [blame] | 679 | size = totlen + 1; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 680 | } |
| 681 | |
| 682 | /* Check if the user provided a buffer */ |
| 683 | if (*resp) { |
| 684 | /* yes; clear it */ |
| 685 | res = *resp; |
| 686 | memset(res, '\0', size); |
| 687 | } else { |
| 688 | /* no, allocate and clear one */ |
| 689 | *resp = res = calloc(1, size); |
| 690 | if (res == NULL) { |
| 691 | __set_errno(ENOMEM); |
| 692 | return (-1); |
| 693 | } |
| 694 | } |
| 695 | /* |
| 696 | * Pass 2: |
| 697 | * export sorted list of result data |
| 698 | */ |
| 699 | for (i = 0, p = res; i < n; ++i) { |
Wolfgang Denk | d67abff | 2011-07-29 14:42:18 +0200 | [diff] [blame] | 700 | const char *s; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 701 | |
| 702 | s = list[i]->key; |
| 703 | while (*s) |
| 704 | *p++ = *s++; |
| 705 | *p++ = '='; |
| 706 | |
| 707 | s = list[i]->data; |
| 708 | |
| 709 | while (*s) { |
| 710 | if ((*s == sep) || (*s == '\\')) |
| 711 | *p++ = '\\'; /* escape */ |
| 712 | *p++ = *s++; |
| 713 | } |
| 714 | *p++ = sep; |
| 715 | } |
| 716 | *p = '\0'; /* terminate result */ |
| 717 | |
| 718 | return size; |
| 719 | } |
Ilya Yanok | f7a2c55 | 2012-09-18 00:22:50 +0000 | [diff] [blame] | 720 | #endif |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 721 | |
| 722 | |
| 723 | /* |
| 724 | * himport() |
| 725 | */ |
| 726 | |
Gerlando Falauto | 6765eb1 | 2012-08-26 21:53:00 +0000 | [diff] [blame] | 727 | /* |
| 728 | * Check whether variable 'name' is amongst vars[], |
| 729 | * and remove all instances by setting the pointer to NULL |
| 730 | */ |
| 731 | static int drop_var_from_set(const char *name, int nvars, char * vars[]) |
Gerlando Falauto | 9b0e1ff | 2012-08-24 00:11:38 +0000 | [diff] [blame] | 732 | { |
| 733 | int i = 0; |
Gerlando Falauto | 6765eb1 | 2012-08-26 21:53:00 +0000 | [diff] [blame] | 734 | int res = 0; |
Gerlando Falauto | 9b0e1ff | 2012-08-24 00:11:38 +0000 | [diff] [blame] | 735 | |
| 736 | /* No variables specified means process all of them */ |
| 737 | if (nvars == 0) |
| 738 | return 1; |
| 739 | |
| 740 | for (i = 0; i < nvars; i++) { |
Gerlando Falauto | 6765eb1 | 2012-08-26 21:53:00 +0000 | [diff] [blame] | 741 | if (vars[i] == NULL) |
| 742 | continue; |
| 743 | /* If we found it, delete all of them */ |
| 744 | if (!strcmp(name, vars[i])) { |
| 745 | vars[i] = NULL; |
| 746 | res = 1; |
| 747 | } |
Gerlando Falauto | 9b0e1ff | 2012-08-24 00:11:38 +0000 | [diff] [blame] | 748 | } |
Gerlando Falauto | 6765eb1 | 2012-08-26 21:53:00 +0000 | [diff] [blame] | 749 | if (!res) |
| 750 | debug("Skipping non-listed variable %s\n", name); |
Gerlando Falauto | 9b0e1ff | 2012-08-24 00:11:38 +0000 | [diff] [blame] | 751 | |
Gerlando Falauto | 6765eb1 | 2012-08-26 21:53:00 +0000 | [diff] [blame] | 752 | return res; |
Gerlando Falauto | 9b0e1ff | 2012-08-24 00:11:38 +0000 | [diff] [blame] | 753 | } |
| 754 | |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 755 | /* |
| 756 | * Import linearized data into hash table. |
| 757 | * |
| 758 | * This is the inverse function to hexport(): it takes a linear list |
| 759 | * of "name=value" pairs and creates hash table entries from it. |
| 760 | * |
| 761 | * Entries without "value", i. e. consisting of only "name" or |
| 762 | * "name=", will cause this entry to be deleted from the hash table. |
| 763 | * |
| 764 | * The "flag" argument can be used to control the behaviour: when the |
| 765 | * H_NOCLEAR bit is set, then an existing hash table will kept, i. e. |
Quentin Schulz | dceecac | 2018-07-09 19:16:28 +0200 | [diff] [blame] | 766 | * new data will be added to an existing hash table; otherwise, if no |
| 767 | * vars are passed, old data will be discarded and a new hash table |
| 768 | * will be created. If vars are passed, passed vars that are not in |
| 769 | * the linear list of "name=value" pairs will be removed from the |
| 770 | * current hash table. |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 771 | * |
| 772 | * The separator character for the "name=value" pairs can be selected, |
| 773 | * so we both support importing from externally stored environment |
| 774 | * data (separated by NUL characters) and from plain text files |
| 775 | * (entries separated by newline characters). |
| 776 | * |
| 777 | * To allow for nicely formatted text input, leading white space |
| 778 | * (sequences of SPACE and TAB chars) is ignored, and entries starting |
| 779 | * (after removal of any leading white space) with a '#' character are |
| 780 | * considered comments and ignored. |
| 781 | * |
| 782 | * [NOTE: this means that a variable name cannot start with a '#' |
| 783 | * character.] |
| 784 | * |
| 785 | * When using a non-NUL separator character, backslash is used as |
| 786 | * escape character in the value part, allowing for example for |
| 787 | * multi-line values. |
| 788 | * |
| 789 | * In theory, arbitrary separator characters can be used, but only |
| 790 | * '\0' and '\n' have really been tested. |
| 791 | */ |
| 792 | |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 793 | int himport_r(struct hsearch_data *htab, |
Gerlando Falauto | 9b0e1ff | 2012-08-24 00:11:38 +0000 | [diff] [blame] | 794 | const char *env, size_t size, const char sep, int flag, |
Alexander Holler | 3e12be7 | 2014-07-14 17:49:55 +0200 | [diff] [blame] | 795 | int crlf_is_lf, int nvars, char * const vars[]) |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 796 | { |
| 797 | char *data, *sp, *dp, *name, *value; |
Gerlando Falauto | 6765eb1 | 2012-08-26 21:53:00 +0000 | [diff] [blame] | 798 | char *localvars[nvars]; |
| 799 | int i; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 800 | |
| 801 | /* Test for correct arguments. */ |
| 802 | if (htab == NULL) { |
| 803 | __set_errno(EINVAL); |
| 804 | return 0; |
| 805 | } |
| 806 | |
| 807 | /* we allocate new space to make sure we can write to the array */ |
Lukasz Majewski | 63b2654 | 2015-09-14 00:57:03 +0200 | [diff] [blame] | 808 | if ((data = malloc(size + 1)) == NULL) { |
Simon Glass | f970ccb | 2016-07-22 09:22:48 -0600 | [diff] [blame] | 809 | debug("himport_r: can't malloc %lu bytes\n", (ulong)size + 1); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 810 | __set_errno(ENOMEM); |
| 811 | return 0; |
| 812 | } |
| 813 | memcpy(data, env, size); |
Lukasz Majewski | 63b2654 | 2015-09-14 00:57:03 +0200 | [diff] [blame] | 814 | data[size] = '\0'; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 815 | dp = data; |
| 816 | |
Gerlando Falauto | 6765eb1 | 2012-08-26 21:53:00 +0000 | [diff] [blame] | 817 | /* make a local copy of the list of variables */ |
| 818 | if (nvars) |
| 819 | memcpy(localvars, vars, sizeof(vars[0]) * nvars); |
| 820 | |
Marek Vasut | a7b8267 | 2020-07-07 20:51:38 +0200 | [diff] [blame] | 821 | #if CONFIG_IS_ENABLED(ENV_APPEND) |
| 822 | flag |= H_NOCLEAR; |
| 823 | #endif |
| 824 | |
Quentin Schulz | dceecac | 2018-07-09 19:16:28 +0200 | [diff] [blame] | 825 | if ((flag & H_NOCLEAR) == 0 && !nvars) { |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 826 | /* Destroy old hash table if one exists */ |
| 827 | debug("Destroy Hash Table: %p table = %p\n", htab, |
| 828 | htab->table); |
| 829 | if (htab->table) |
Joe Hershberger | a46f770 | 2012-12-11 22:16:19 -0600 | [diff] [blame] | 830 | hdestroy_r(htab); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 831 | } |
| 832 | |
| 833 | /* |
| 834 | * Create new hash table (if needed). The computation of the hash |
| 835 | * table size is based on heuristics: in a sample of some 70+ |
| 836 | * existing systems we found an average size of 39+ bytes per entry |
| 837 | * in the environment (for the whole key=value pair). Assuming a |
Wolfgang Denk | 460a9ff | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 838 | * size of 8 per entry (= safety factor of ~5) should provide enough |
| 839 | * safety margin for any existing environment definitions and still |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 840 | * allow for more than enough dynamic additions. Note that the |
Robert P. J. Day | 832d36e | 2013-09-16 07:15:45 -0400 | [diff] [blame] | 841 | * "size" argument is supposed to give the maximum environment size |
Wolfgang Denk | 460a9ff | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 842 | * (CONFIG_ENV_SIZE). This heuristics will result in |
| 843 | * unreasonably large numbers (and thus memory footprint) for |
| 844 | * big flash environments (>8,000 entries for 64 KB |
Robert P. J. Day | 8d56db9 | 2016-07-15 13:44:45 -0400 | [diff] [blame] | 845 | * environment size), so we clip it to a reasonable value. |
Andreas Bießmann | 2638b2b | 2010-10-01 22:51:02 +0200 | [diff] [blame] | 846 | * On the other hand we need to add some more entries for free |
| 847 | * space when importing very small buffers. Both boundaries can |
| 848 | * be overwritten in the board config file if needed. |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 849 | */ |
| 850 | |
| 851 | if (!htab->table) { |
Andreas Bießmann | 2638b2b | 2010-10-01 22:51:02 +0200 | [diff] [blame] | 852 | int nent = CONFIG_ENV_MIN_ENTRIES + size / 8; |
Wolfgang Denk | 460a9ff | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 853 | |
| 854 | if (nent > CONFIG_ENV_MAX_ENTRIES) |
| 855 | nent = CONFIG_ENV_MAX_ENTRIES; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 856 | |
| 857 | debug("Create Hash Table: N=%d\n", nent); |
| 858 | |
| 859 | if (hcreate_r(nent, htab) == 0) { |
| 860 | free(data); |
| 861 | return 0; |
| 862 | } |
| 863 | } |
| 864 | |
Lukasz Majewski | 105426b | 2015-09-14 00:57:04 +0200 | [diff] [blame] | 865 | if (!size) { |
| 866 | free(data); |
Alexander Holler | 3e12be7 | 2014-07-14 17:49:55 +0200 | [diff] [blame] | 867 | return 1; /* everything OK */ |
Lukasz Majewski | 105426b | 2015-09-14 00:57:04 +0200 | [diff] [blame] | 868 | } |
Alexander Holler | 3e12be7 | 2014-07-14 17:49:55 +0200 | [diff] [blame] | 869 | if(crlf_is_lf) { |
| 870 | /* Remove Carriage Returns in front of Line Feeds */ |
| 871 | unsigned ignored_crs = 0; |
| 872 | for(;dp < data + size && *dp; ++dp) { |
| 873 | if(*dp == '\r' && |
| 874 | dp < data + size - 1 && *(dp+1) == '\n') |
| 875 | ++ignored_crs; |
| 876 | else |
| 877 | *(dp-ignored_crs) = *dp; |
| 878 | } |
| 879 | size -= ignored_crs; |
| 880 | dp = data; |
| 881 | } |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 882 | /* Parse environment; allow for '\0' and 'sep' as separators */ |
| 883 | do { |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 884 | struct env_entry e, *rv; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 885 | |
| 886 | /* skip leading white space */ |
Jason Hobbs | cafa1aa | 2011-08-23 11:06:54 +0000 | [diff] [blame] | 887 | while (isblank(*dp)) |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 888 | ++dp; |
| 889 | |
| 890 | /* skip comment lines */ |
| 891 | if (*dp == '#') { |
| 892 | while (*dp && (*dp != sep)) |
| 893 | ++dp; |
| 894 | ++dp; |
| 895 | continue; |
| 896 | } |
| 897 | |
| 898 | /* parse name */ |
| 899 | for (name = dp; *dp != '=' && *dp && *dp != sep; ++dp) |
| 900 | ; |
| 901 | |
| 902 | /* deal with "name" and "name=" entries (delete var) */ |
| 903 | if (*dp == '\0' || *(dp + 1) == '\0' || |
| 904 | *dp == sep || *(dp + 1) == sep) { |
| 905 | if (*dp == '=') |
| 906 | *dp++ = '\0'; |
| 907 | *dp++ = '\0'; /* terminate name */ |
| 908 | |
| 909 | debug("DELETE CANDIDATE: \"%s\"\n", name); |
Gerlando Falauto | 6765eb1 | 2012-08-26 21:53:00 +0000 | [diff] [blame] | 910 | if (!drop_var_from_set(name, nvars, localvars)) |
Gerlando Falauto | 9b0e1ff | 2012-08-24 00:11:38 +0000 | [diff] [blame] | 911 | continue; |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 912 | |
Simon Glass | 783ef3f | 2020-11-05 10:33:37 -0700 | [diff] [blame] | 913 | if (hdelete_r(name, htab, flag)) |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 914 | debug("DELETE ERROR ##############################\n"); |
| 915 | |
| 916 | continue; |
| 917 | } |
| 918 | *dp++ = '\0'; /* terminate name */ |
| 919 | |
| 920 | /* parse value; deal with escapes */ |
| 921 | for (value = sp = dp; *dp && (*dp != sep); ++dp) { |
| 922 | if ((*dp == '\\') && *(dp + 1)) |
| 923 | ++dp; |
| 924 | *sp++ = *dp; |
| 925 | } |
| 926 | *sp++ = '\0'; /* terminate value */ |
| 927 | ++dp; |
| 928 | |
Lucian Cojocar | 5270bde | 2013-04-28 11:31:57 +0000 | [diff] [blame] | 929 | if (*name == 0) { |
| 930 | debug("INSERT: unable to use an empty key\n"); |
| 931 | __set_errno(EINVAL); |
Lukasz Majewski | 105426b | 2015-09-14 00:57:04 +0200 | [diff] [blame] | 932 | free(data); |
Lucian Cojocar | 5270bde | 2013-04-28 11:31:57 +0000 | [diff] [blame] | 933 | return 0; |
| 934 | } |
| 935 | |
Gerlando Falauto | 9b0e1ff | 2012-08-24 00:11:38 +0000 | [diff] [blame] | 936 | /* Skip variables which are not supposed to be processed */ |
Gerlando Falauto | 6765eb1 | 2012-08-26 21:53:00 +0000 | [diff] [blame] | 937 | if (!drop_var_from_set(name, nvars, localvars)) |
Gerlando Falauto | 9b0e1ff | 2012-08-24 00:11:38 +0000 | [diff] [blame] | 938 | continue; |
| 939 | |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 940 | /* enter into hash table */ |
| 941 | e.key = name; |
| 942 | e.data = value; |
| 943 | |
Simon Glass | 63a2f57 | 2019-08-01 09:47:09 -0600 | [diff] [blame] | 944 | hsearch_r(e, ENV_ENTER, &rv, htab, flag); |
Marek Vasut | 803549f | 2020-07-07 20:51:39 +0200 | [diff] [blame] | 945 | #if !CONFIG_IS_ENABLED(ENV_WRITEABLE_LIST) |
| 946 | if (rv == NULL) { |
Wolfgang Denk | 460a9ff | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 947 | printf("himport_r: can't insert \"%s=%s\" into hash table\n", |
| 948 | name, value); |
Marek Vasut | 803549f | 2020-07-07 20:51:39 +0200 | [diff] [blame] | 949 | } |
| 950 | #endif |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 951 | |
Wolfgang Denk | 460a9ff | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 952 | debug("INSERT: table %p, filled %d/%d rv %p ==> name=\"%s\" value=\"%s\"\n", |
| 953 | htab, htab->filled, htab->size, |
| 954 | rv, name, value); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 955 | } while ((dp < data + size) && *dp); /* size check needed for text */ |
| 956 | /* without '\0' termination */ |
Wolfgang Denk | 460a9ff | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 957 | debug("INSERT: free(data = %p)\n", data); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 958 | free(data); |
| 959 | |
Quentin Schulz | dceecac | 2018-07-09 19:16:28 +0200 | [diff] [blame] | 960 | if (flag & H_NOCLEAR) |
| 961 | goto end; |
| 962 | |
Gerlando Falauto | 6765eb1 | 2012-08-26 21:53:00 +0000 | [diff] [blame] | 963 | /* process variables which were not considered */ |
| 964 | for (i = 0; i < nvars; i++) { |
| 965 | if (localvars[i] == NULL) |
| 966 | continue; |
| 967 | /* |
| 968 | * All variables which were not deleted from the variable list |
| 969 | * were not present in the imported env |
| 970 | * This could mean two things: |
| 971 | * a) if the variable was present in current env, we delete it |
| 972 | * b) if the variable was not present in current env, we notify |
| 973 | * it might be a typo |
| 974 | */ |
Simon Glass | 783ef3f | 2020-11-05 10:33:37 -0700 | [diff] [blame] | 975 | if (hdelete_r(localvars[i], htab, flag)) |
Gerlando Falauto | 6765eb1 | 2012-08-26 21:53:00 +0000 | [diff] [blame] | 976 | printf("WARNING: '%s' neither in running nor in imported env!\n", localvars[i]); |
| 977 | else |
| 978 | printf("WARNING: '%s' not in imported env, deleting it!\n", localvars[i]); |
| 979 | } |
| 980 | |
Quentin Schulz | dceecac | 2018-07-09 19:16:28 +0200 | [diff] [blame] | 981 | end: |
Wolfgang Denk | 460a9ff | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 982 | debug("INSERT: done\n"); |
Wolfgang Denk | c9ae986 | 2010-06-20 13:17:12 +0200 | [diff] [blame] | 983 | return 1; /* everything OK */ |
| 984 | } |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 985 | |
| 986 | /* |
| 987 | * hwalk_r() |
| 988 | */ |
| 989 | |
| 990 | /* |
| 991 | * Walk all of the entries in the hash, calling the callback for each one. |
| 992 | * this allows some generic operation to be performed on each element. |
| 993 | */ |
Simon Glass | 1a23686 | 2019-08-02 09:44:18 -0600 | [diff] [blame] | 994 | int hwalk_r(struct hsearch_data *htab, int (*callback)(struct env_entry *entry)) |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 995 | { |
| 996 | int i; |
| 997 | int retval; |
| 998 | |
| 999 | for (i = 1; i <= htab->size; ++i) { |
| 1000 | if (htab->table[i].used > 0) { |
| 1001 | retval = callback(&htab->table[i].entry); |
| 1002 | if (retval) |
| 1003 | return retval; |
| 1004 | } |
| 1005 | } |
| 1006 | |
| 1007 | return 0; |
| 1008 | } |