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