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 #ifndef CONFIG_SPL_BUILD
 230         if (e->callback)
 231                 return e->callback(name, value, op, flags);
 232 #endif
 233         return 0;
 234 }
 235
 236 /*
 237  * Compare an existing entry with the desired key, and overwrite if the action
 238  * is ENV_ENTER.  This is simply a helper function for hsearch_r().
 239  */
 240 static inline int _compare_and_overwrite_entry(struct env_entry item,
 241                 enum env_action action, struct env_entry **retval,
 242                 struct hsearch_data *htab, int flag, unsigned int hval,
 243                 unsigned int idx)
 244 {
 245         if (htab->table[idx].used == hval
 246             && strcmp(item.key, htab->table[idx].entry.key) == 0) {
 247                 /* Overwrite existing value? */
 248                 if (action == ENV_ENTER && item.data) {
 249                         /* check for permission */
 250                         if (htab->change_ok != NULL && htab->change_ok(
 251                             &htab->table[idx].entry, item.data,
 252                             env_op_overwrite, flag)) {
 253                                 debug("change_ok() rejected setting variable "
 254                                         "%s, skipping it!\n", item.key);
 255                                 __set_errno(EPERM);
 256                                 *retval = NULL;
 257                                 return 0;
 258                         }
 259
 260                         /* If there is a callback, call it */
 261                         if (do_callback(&htab->table[idx].entry, item.key,
 262                                         item.data, env_op_overwrite, flag)) {
 263                                 debug("callback() rejected setting variable "
 264                                         "%s, skipping it!\n", item.key);
 265                                 __set_errno(EINVAL);
 266                                 *retval = NULL;
 267                                 return 0;
 268                         }
 269
 270                         free(htab->table[idx].entry.data);
 271                         htab->table[idx].entry.data = strdup(item.data);
 272                         if (!htab->table[idx].entry.data) {
 273                                 __set_errno(ENOMEM);
 274                                 *retval = NULL;
 275                                 return 0;
 276                         }
 277                 }
 278                 /* return found entry */
 279                 *retval = &htab->table[idx].entry;
 280                 return idx;
 281         }
 282         /* keep searching */
 283         return -1;
 284 }
 285
 286 int hsearch_r(struct env_entry item, enum env_action action,
 287               struct env_entry **retval, struct hsearch_data *htab, int flag)
 288 {
 289         unsigned int hval;
 290         unsigned int count;
 291         unsigned int len = strlen(item.key);
 292         unsigned int idx;
 293         unsigned int first_deleted = 0;
 294         int ret;
 295
 296         /* Compute an value for the given string. Perhaps use a better method. */
 297         hval = len;
 298         count = len;
 299         while (count-- > 0) {
 300                 hval <<= 4;
 301                 hval += item.key[count];
 302         }
 303
 304         /*
 305          * First hash function:
 306          * simply take the modul but prevent zero.
 307          */
 308         hval %= htab->size;
 309         if (hval == 0)
 310                 ++hval;
 311
 312         /* The first index tried. */
 313         idx = hval;
 314
 315         if (htab->table[idx].used) {
 316                 /*
 317                  * Further action might be required according to the
 318                  * action value.
 319                  */
 320                 unsigned hval2;
 321
 322                 if (htab->table[idx].used == USED_DELETED
 323                     && !first_deleted)
 324                         first_deleted = idx;
 325
 326                 ret = _compare_and_overwrite_entry(item, action, retval, htab,
 327                         flag, hval, idx);
 328                 if (ret != -1)
 329                         return ret;
 330
 331                 /*
 332                  * Second hash function:
 333                  * as suggested in [Knuth]
 334                  */
 335                 hval2 = 1 + hval % (htab->size - 2);
 336
 337                 do {
 338                         /*
 339                          * Because SIZE is prime this guarantees to
 340                          * step through all available indices.
 341                          */
 342                         if (idx <= hval2)
 343                                 idx = htab->size + idx - hval2;
 344                         else
 345                                 idx -= hval2;
 346
 347                         /*
 348                          * If we visited all entries leave the loop
 349                          * unsuccessfully.
 350                          */
 351                         if (idx == hval)
 352                                 break;
 353
 354                         if (htab->table[idx].used == USED_DELETED
 355                             && !first_deleted)
 356                                 first_deleted = idx;
 357
 358                         /* If entry is found use it. */
 359                         ret = _compare_and_overwrite_entry(item, action, retval,
 360                                 htab, flag, hval, idx);
 361                         if (ret != -1)
 362                                 return ret;
 363                 }
 364                 while (htab->table[idx].used != USED_FREE);
 365         }
 366
 367         /* An empty bucket has been found. */
 368         if (action == ENV_ENTER) {
 369                 /*
 370                  * If table is full and another entry should be
 371                  * entered return with error.
 372                  */
 373                 if (htab->filled == htab->size) {
 374                         __set_errno(ENOMEM);
 375                         *retval = NULL;
 376                         return 0;
 377                 }
 378
 379                 /*
 380                  * Create new entry;
 381                  * create copies of item.key and item.data
 382                  */
 383                 if (first_deleted)
 384                         idx = first_deleted;
 385
 386                 htab->table[idx].used = hval;
 387                 htab->table[idx].entry.key = strdup(item.key);
 388                 htab->table[idx].entry.data = strdup(item.data);
 389                 if (!htab->table[idx].entry.key ||
 390                     !htab->table[idx].entry.data) {
 391                         __set_errno(ENOMEM);
 392                         *retval = NULL;
 393                         return 0;
 394                 }
 395
 396                 ++htab->filled;
 397
 398                 /* This is a new entry, so look up a possible callback */
 399                 env_callback_init(&htab->table[idx].entry);
 400                 /* Also look for flags */
 401                 env_flags_init(&htab->table[idx].entry);
 402
 403                 /* check for permission */
 404                 if (htab->change_ok != NULL && htab->change_ok(
 405                     &htab->table[idx].entry, item.data, env_op_create, flag)) {
 406                         debug("change_ok() rejected setting variable "
 407                                 "%s, skipping it!\n", item.key);
 408                         _hdelete(item.key, htab, &htab->table[idx].entry, idx);
 409                         __set_errno(EPERM);
 410                         *retval = NULL;
 411                         return 0;
 412                 }
 413
 414                 /* If there is a callback, call it */
 415                 if (do_callback(&htab->table[idx].entry, item.key, item.data,
 416                                 env_op_create, flag)) {
 417                         debug("callback() rejected setting variable "
 418                                 "%s, skipping it!\n", item.key);
 419                         _hdelete(item.key, htab, &htab->table[idx].entry, idx);
 420                         __set_errno(EINVAL);
 421                         *retval = NULL;
 422                         return 0;
 423                 }
 424
 425                 /* return new entry */
 426                 *retval = &htab->table[idx].entry;
 427                 return 1;
 428         }
 429
 430         __set_errno(ESRCH);
 431         *retval = NULL;
 432         return 0;
 433 }
 434
 435
 436 /*
 437  * hdelete()
 438  */
 439
 440 /*
 441  * The standard implementation of hsearch(3) does not provide any way
 442  * to delete any entries from the hash table.  We extend the code to
 443  * do that.
 444  */
 445
 446 static void _hdelete(const char *key, struct hsearch_data *htab,
 447                      struct env_entry *ep, int idx)
 448 {
 449         /* free used entry */
 450         debug("hdelete: DELETING key \"%s\"\n", key);
 451         free((void *)ep->key);
 452         free(ep->data);
 453         ep->flags = 0;
 454         htab->table[idx].used = USED_DELETED;
 455
 456         --htab->filled;
 457 }
 458
 459 int hdelete_r(const char *key, struct hsearch_data *htab, int flag)
 460 {
 461         struct env_entry e, *ep;
 462         int idx;
 463
 464         debug("hdelete: DELETE key \"%s\"\n", key);
 465
 466         e.key = (char *)key;
 467
 468         idx = hsearch_r(e, ENV_FIND, &ep, htab, 0);
 469         if (idx == 0) {
 470                 __set_errno(ESRCH);
 471                 return 0;       /* not found */
 472         }
 473
 474         /* Check for permission */
 475         if (htab->change_ok != NULL &&
 476             htab->change_ok(ep, NULL, env_op_delete, flag)) {
 477                 debug("change_ok() rejected deleting variable "
 478                         "%s, skipping it!\n", key);
 479                 __set_errno(EPERM);
 480                 return 0;
 481         }
 482
 483         /* If there is a callback, call it */
 484         if (do_callback(&htab->table[idx].entry, key, NULL,
 485                         env_op_delete, flag)) {
 486                 debug("callback() rejected deleting variable "
 487                         "%s, skipping it!\n", key);
 488                 __set_errno(EINVAL);
 489                 return 0;
 490         }
 491
 492         _hdelete(key, htab, ep, idx);
 493
 494         return 1;
 495 }
 496
 497 #if !(defined(CONFIG_SPL_BUILD) && !defined(CONFIG_SPL_SAVEENV))
 498 /*
 499  * hexport()
 500  */
 501
 502 /*
 503  * Export the data stored in the hash table in linearized form.
 504  *
 505  * Entries are exported as "name=value" strings, separated by an
 506  * arbitrary (non-NUL, of course) separator character. This allows to
 507  * use this function both when formatting the U-Boot environment for
 508  * external storage (using '\0' as separator), but also when using it
 509  * for the "printenv" command to print all variables, simply by using
 510  * as '\n" as separator. This can also be used for new features like
 511  * exporting the environment data as text file, including the option
 512  * for later re-import.
 513  *
 514  * The entries in the result list will be sorted by ascending key
 515  * values.
 516  *
 517  * If the separator character is different from NUL, then any
 518  * separator characters and backslash characters in the values will
 519  * be escaped by a preceding backslash in output. This is needed for
 520  * example to enable multi-line values, especially when the output
 521  * shall later be parsed (for example, for re-import).
 522  *
 523  * There are several options how the result buffer is handled:
 524  *
 525  * *resp  size
 526  * -----------
 527  *  NULL    0   A string of sufficient length will be allocated.
 528  *  NULL   >0   A string of the size given will be
 529  *              allocated. An error will be returned if the size is
 530  *              not sufficient.  Any unused bytes in the string will
 531  *              be '\0'-padded.
 532  * !NULL    0   The user-supplied buffer will be used. No length
 533  *              checking will be performed, i. e. it is assumed that
 534  *              the buffer size will always be big enough. DANGEROUS.
 535  * !NULL   >0   The user-supplied buffer will be used. An error will
 536  *              be returned if the size is not sufficient.  Any unused
 537  *              bytes in the string will be '\0'-padded.
 538  */
 539
 540 static int cmpkey(const void *p1, const void *p2)
 541 {
 542         struct env_entry *e1 = *(struct env_entry **)p1;
 543         struct env_entry *e2 = *(struct env_entry **)p2;
 544
 545         return (strcmp(e1->key, e2->key));
 546 }
 547
 548 static int match_string(int flag, const char *str, const char *pat, void *priv)
 549 {
 550         switch (flag & H_MATCH_METHOD) {
 551         case H_MATCH_IDENT:
 552                 if (strcmp(str, pat) == 0)
 553                         return 1;
 554                 break;
 555         case H_MATCH_SUBSTR:
 556                 if (strstr(str, pat))
 557                         return 1;
 558                 break;
 559 #ifdef CONFIG_REGEX
 560         case H_MATCH_REGEX:
 561                 {
 562                         struct slre *slrep = (struct slre *)priv;
 563
 564                         if (slre_match(slrep, str, strlen(str), NULL))
 565                                 return 1;
 566                 }
 567                 break;
 568 #endif
 569         default:
 570                 printf("## ERROR: unsupported match method: 0x%02x\n",
 571                         flag & H_MATCH_METHOD);
 572                 break;
 573         }
 574         return 0;
 575 }
 576
 577 static int match_entry(struct env_entry *ep, int flag, int argc,
 578                        char *const argv[])
 579 {
 580         int arg;
 581         void *priv = NULL;
 582
 583         for (arg = 0; arg < argc; ++arg) {
 584 #ifdef CONFIG_REGEX
 585                 struct slre slre;
 586
 587                 if (slre_compile(&slre, argv[arg]) == 0) {
 588                         printf("Error compiling regex: %s\n", slre.err_str);
 589                         return 0;
 590                 }
 591
 592                 priv = (void *)&slre;
 593 #endif
 594                 if (flag & H_MATCH_KEY) {
 595                         if (match_string(flag, ep->key, argv[arg], priv))
 596                                 return 1;
 597                 }
 598                 if (flag & H_MATCH_DATA) {
 599                         if (match_string(flag, ep->data, argv[arg], priv))
 600                                 return 1;
 601                 }
 602         }
 603         return 0;
 604 }
 605
 606 ssize_t hexport_r(struct hsearch_data *htab, const char sep, int flag,
 607                  char **resp, size_t size,
 608                  int argc, char * const argv[])
 609 {
 610         struct env_entry *list[htab->size];
 611         char *res, *p;
 612         size_t totlen;
 613         int i, n;
 614
 615         /* Test for correct arguments.  */
 616         if ((resp == NULL) || (htab == NULL)) {
 617                 __set_errno(EINVAL);
 618                 return (-1);
 619         }
 620
 621         debug("EXPORT  table = %p, htab.size = %d, htab.filled = %d, size = %lu\n",
 622               htab, htab->size, htab->filled, (ulong)size);
 623         /*
 624          * Pass 1:
 625          * search used entries,
 626          * save addresses and compute total length
 627          */
 628         for (i = 1, n = 0, totlen = 0; i <= htab->size; ++i) {
 629
 630                 if (htab->table[i].used > 0) {
 631                         struct env_entry *ep = &htab->table[i].entry;
 632                         int found = match_entry(ep, flag, argc, argv);
 633
 634                         if ((argc > 0) && (found == 0))
 635                                 continue;
 636
 637                         if ((flag & H_HIDE_DOT) && ep->key[0] == '.')
 638                                 continue;
 639
 640                         list[n++] = ep;
 641
 642                         totlen += strlen(ep->key);
 643
 644                         if (sep == '\0') {
 645                                 totlen += strlen(ep->data);
 646                         } else {        /* check if escapes are needed */
 647                                 char *s = ep->data;
 648
 649                                 while (*s) {
 650                                         ++totlen;
 651                                         /* add room for needed escape chars */
 652                                         if ((*s == sep) || (*s == '\\'))
 653                                                 ++totlen;
 654                                         ++s;
 655                                 }
 656                         }
 657                         totlen += 2;    /* for '=' and 'sep' char */
 658                 }
 659         }
 660
 661 #ifdef DEBUG
 662         /* Pass 1a: print unsorted list */
 663         printf("Unsorted: n=%d\n", n);
 664         for (i = 0; i < n; ++i) {
 665                 printf("\t%3d: %p ==> %-10s => %s\n",
 666                        i, list[i], list[i]->key, list[i]->data);
 667         }
 668 #endif
 669
 670         /* Sort list by keys */
 671         qsort(list, n, sizeof(struct env_entry *), cmpkey);
 672
 673         /* Check if the user supplied buffer size is sufficient */
 674         if (size) {
 675                 if (size < totlen + 1) {        /* provided buffer too small */
 676                         printf("Env export buffer too small: %lu, but need %lu\n",
 677                                (ulong)size, (ulong)totlen + 1);
 678                         __set_errno(ENOMEM);
 679                         return (-1);
 680                 }
 681         } else {
 682                 size = totlen + 1;
 683         }
 684
 685         /* Check if the user provided a buffer */
 686         if (*resp) {
 687                 /* yes; clear it */
 688                 res = *resp;
 689                 memset(res, '\0', size);
 690         } else {
 691                 /* no, allocate and clear one */
 692                 *resp = res = calloc(1, size);
 693                 if (res == NULL) {
 694                         __set_errno(ENOMEM);
 695                         return (-1);
 696                 }
 697         }
 698         /*
 699          * Pass 2:
 700          * export sorted list of result data
 701          */
 702         for (i = 0, p = res; i < n; ++i) {
 703                 const char *s;
 704
 705                 s = list[i]->key;
 706                 while (*s)
 707                         *p++ = *s++;
 708                 *p++ = '=';
 709
 710                 s = list[i]->data;
 711
 712                 while (*s) {
 713                         if ((*s == sep) || (*s == '\\'))
 714                                 *p++ = '\\';    /* escape */
 715                         *p++ = *s++;
 716                 }
 717                 *p++ = sep;
 718         }
 719         *p = '\0';              /* terminate result */
 720
 721         return size;
 722 }
 723 #endif
 724
 725
 726 /*
 727  * himport()
 728  */
 729
 730 /*
 731  * Check whether variable 'name' is amongst vars[],
 732  * and remove all instances by setting the pointer to NULL
 733  */
 734 static int drop_var_from_set(const char *name, int nvars, char * vars[])
 735 {
 736         int i = 0;
 737         int res = 0;
 738
 739         /* No variables specified means process all of them */
 740         if (nvars == 0)
 741                 return 1;
 742
 743         for (i = 0; i < nvars; i++) {
 744                 if (vars[i] == NULL)
 745                         continue;
 746                 /* If we found it, delete all of them */
 747                 if (!strcmp(name, vars[i])) {
 748                         vars[i] = NULL;
 749                         res = 1;
 750                 }
 751         }
 752         if (!res)
 753                 debug("Skipping non-listed variable %s\n", name);
 754
 755         return res;
 756 }
 757
 758 /*
 759  * Import linearized data into hash table.
 760  *
 761  * This is the inverse function to hexport(): it takes a linear list
 762  * of "name=value" pairs and creates hash table entries from it.
 763  *
 764  * Entries without "value", i. e. consisting of only "name" or
 765  * "name=", will cause this entry to be deleted from the hash table.
 766  *
 767  * The "flag" argument can be used to control the behaviour: when the
 768  * H_NOCLEAR bit is set, then an existing hash table will kept, i. e.
 769  * new data will be added to an existing hash table; otherwise, if no
 770  * vars are passed, old data will be discarded and a new hash table
 771  * will be created. If vars are passed, passed vars that are not in
 772  * the linear list of "name=value" pairs will be removed from the
 773  * current hash table.
 774  *
 775  * The separator character for the "name=value" pairs can be selected,
 776  * so we both support importing from externally stored environment
 777  * data (separated by NUL characters) and from plain text files
 778  * (entries separated by newline characters).
 779  *
 780  * To allow for nicely formatted text input, leading white space
 781  * (sequences of SPACE and TAB chars) is ignored, and entries starting
 782  * (after removal of any leading white space) with a '#' character are
 783  * considered comments and ignored.
 784  *
 785  * [NOTE: this means that a variable name cannot start with a '#'
 786  * character.]
 787  *
 788  * When using a non-NUL separator character, backslash is used as
 789  * escape character in the value part, allowing for example for
 790  * multi-line values.
 791  *
 792  * In theory, arbitrary separator characters can be used, but only
 793  * '\0' and '\n' have really been tested.
 794  */
 795
 796 int himport_r(struct hsearch_data *htab,
 797                 const char *env, size_t size, const char sep, int flag,
 798                 int crlf_is_lf, int nvars, char * const vars[])
 799 {
 800         char *data, *sp, *dp, *name, *value;
 801         char *localvars[nvars];
 802         int i;
 803
 804         /* Test for correct arguments.  */
 805         if (htab == NULL) {
 806                 __set_errno(EINVAL);
 807                 return 0;
 808         }
 809
 810         /* we allocate new space to make sure we can write to the array */
 811         if ((data = malloc(size + 1)) == NULL) {
 812                 debug("himport_r: can't malloc %lu bytes\n", (ulong)size + 1);
 813                 __set_errno(ENOMEM);
 814                 return 0;
 815         }
 816         memcpy(data, env, size);
 817         data[size] = '\0';
 818         dp = data;
 819
 820         /* make a local copy of the list of variables */
 821         if (nvars)
 822                 memcpy(localvars, vars, sizeof(vars[0]) * nvars);
 823
 824         if ((flag & H_NOCLEAR) == 0 && !nvars) {
 825                 /* Destroy old hash table if one exists */
 826                 debug("Destroy Hash Table: %p table = %p\n", htab,
 827                        htab->table);
 828                 if (htab->table)
 829                         hdestroy_r(htab);
 830         }
 831
 832         /*
 833          * Create new hash table (if needed).  The computation of the hash
 834          * table size is based on heuristics: in a sample of some 70+
 835          * existing systems we found an average size of 39+ bytes per entry
 836          * in the environment (for the whole key=value pair). Assuming a
 837          * size of 8 per entry (= safety factor of ~5) should provide enough
 838          * safety margin for any existing environment definitions and still
 839          * allow for more than enough dynamic additions. Note that the
 840          * "size" argument is supposed to give the maximum environment size
 841          * (CONFIG_ENV_SIZE).  This heuristics will result in
 842          * unreasonably large numbers (and thus memory footprint) for
 843          * big flash environments (>8,000 entries for 64 KB
 844          * environment size), so we clip it to a reasonable value.
 845          * On the other hand we need to add some more entries for free
 846          * space when importing very small buffers. Both boundaries can
 847          * be overwritten in the board config file if needed.
 848          */
 849
 850         if (!htab->table) {
 851                 int nent = CONFIG_ENV_MIN_ENTRIES + size / 8;
 852
 853                 if (nent > CONFIG_ENV_MAX_ENTRIES)
 854                         nent = CONFIG_ENV_MAX_ENTRIES;
 855
 856                 debug("Create Hash Table: N=%d\n", nent);
 857
 858                 if (hcreate_r(nent, htab) == 0) {
 859                         free(data);
 860                         return 0;
 861                 }
 862         }
 863
 864         if (!size) {
 865                 free(data);
 866                 return 1;               /* everything OK */
 867         }
 868         if(crlf_is_lf) {
 869                 /* Remove Carriage Returns in front of Line Feeds */
 870                 unsigned ignored_crs = 0;
 871                 for(;dp < data + size && *dp; ++dp) {
 872                         if(*dp == '\r' &&
 873                            dp < data + size - 1 && *(dp+1) == '\n')
 874                                 ++ignored_crs;
 875                         else
 876                                 *(dp-ignored_crs) = *dp;
 877                 }
 878                 size -= ignored_crs;
 879                 dp = data;
 880         }
 881         /* Parse environment; allow for '\0' and 'sep' as separators */
 882         do {
 883                 struct env_entry e, *rv;
 884
 885                 /* skip leading white space */
 886                 while (isblank(*dp))
 887                         ++dp;
 888
 889                 /* skip comment lines */
 890                 if (*dp == '#') {
 891                         while (*dp && (*dp != sep))
 892                                 ++dp;
 893                         ++dp;
 894                         continue;
 895                 }
 896
 897                 /* parse name */
 898                 for (name = dp; *dp != '=' && *dp && *dp != sep; ++dp)
 899                         ;
 900
 901                 /* deal with "name" and "name=" entries (delete var) */
 902                 if (*dp == '\0' || *(dp + 1) == '\0' ||
 903                     *dp == sep || *(dp + 1) == sep) {
 904                         if (*dp == '=')
 905                                 *dp++ = '\0';
 906                         *dp++ = '\0';   /* terminate name */
 907
 908                         debug("DELETE CANDIDATE: \"%s\"\n", name);
 909                         if (!drop_var_from_set(name, nvars, localvars))
 910                                 continue;
 911
 912                         if (hdelete_r(name, htab, flag) == 0)
 913                                 debug("DELETE ERROR ##############################\n");
 914
 915                         continue;
 916                 }
 917                 *dp++ = '\0';   /* terminate name */
 918
 919                 /* parse value; deal with escapes */
 920                 for (value = sp = dp; *dp && (*dp != sep); ++dp) {
 921                         if ((*dp == '\\') && *(dp + 1))
 922                                 ++dp;
 923                         *sp++ = *dp;
 924                 }
 925                 *sp++ = '\0';   /* terminate value */
 926                 ++dp;
 927
 928                 if (*name == 0) {
 929                         debug("INSERT: unable to use an empty key\n");
 930                         __set_errno(EINVAL);
 931                         free(data);
 932                         return 0;
 933                 }
 934
 935                 /* Skip variables which are not supposed to be processed */
 936                 if (!drop_var_from_set(name, nvars, localvars))
 937                         continue;
 938
 939                 /* enter into hash table */
 940                 e.key = name;
 941                 e.data = value;
 942
 943                 hsearch_r(e, ENV_ENTER, &rv, htab, flag);
 944                 if (rv == NULL)
 945                         printf("himport_r: can't insert \"%s=%s\" into hash table\n",
 946                                 name, value);
 947
 948                 debug("INSERT: table %p, filled %d/%d rv %p ==> name=\"%s\" value=\"%s\"\n",
 949                         htab, htab->filled, htab->size,
 950                         rv, name, value);
 951         } while ((dp < data + size) && *dp);    /* size check needed for text */
 952                                                 /* without '\0' termination */
 953         debug("INSERT: free(data = %p)\n", data);
 954         free(data);
 955
 956         if (flag & H_NOCLEAR)
 957                 goto end;
 958
 959         /* process variables which were not considered */
 960         for (i = 0; i < nvars; i++) {
 961                 if (localvars[i] == NULL)
 962                         continue;
 963                 /*
 964                  * All variables which were not deleted from the variable list
 965                  * were not present in the imported env
 966                  * This could mean two things:
 967                  * a) if the variable was present in current env, we delete it
 968                  * b) if the variable was not present in current env, we notify
 969                  *    it might be a typo
 970                  */
 971                 if (hdelete_r(localvars[i], htab, flag) == 0)
 972                         printf("WARNING: '%s' neither in running nor in imported env!\n", localvars[i]);
 973                 else
 974                         printf("WARNING: '%s' not in imported env, deleting it!\n", localvars[i]);
 975         }
 976
 977 end:
 978         debug("INSERT: done\n");
 979         return 1;               /* everything OK */
 980 }
 981
 982 /*
 983  * hwalk_r()
 984  */
 985
 986 /*
 987  * Walk all of the entries in the hash, calling the callback for each one.
 988  * this allows some generic operation to be performed on each element.
 989  */
 990 int hwalk_r(struct hsearch_data *htab, int (*callback)(struct env_entry *entry))
 991 {
 992         int i;
 993         int retval;
 994
 995         for (i = 1; i <= htab->size; ++i) {
 996                 if (htab->table[i].used > 0) {
 997                         retval = callback(&htab->table[i].entry);
 998                         if (retval)
 999                                 return retval;
1000                 }
1001         }
1002
1003         return 0;
1004 }