lib/hashtable.c

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