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