include/search.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 /*
   3  * Declarations for System V style searching functions.
   4  * Copyright (C) 1995-1999, 2000 Free Software Foundation, Inc.
   5  * This file is part of the GNU C Library.
   6  */
   7
   8 /*
   9  * Based on code from uClibc-0.9.30.3
  10  * Extensions for use within U-Boot
  11  * Copyright (C) 2010-2013 Wolfgang Denk <wd@denx.de>
  12  */
  13
  14 #ifndef _SEARCH_H_
  15 #define _SEARCH_H_
  16
  17 #include <env.h>
  18 #include <stddef.h>
  19
  20 #define __set_errno(val) do { errno = val; } while (0)
  21
  22 /* Action which shall be performed in the call to hsearch.  */
  23 typedef enum {
  24         FIND,
  25         ENTER
  26 } ACTION;
  27
  28 /** struct env_entry - An entry in the environment hashtable */
  29 struct env_entry {
  30         const char *key;
  31         char *data;
  32         int (*callback)(const char *name, const char *value, enum env_op op,
  33                 int flags);
  34         int flags;
  35 };
  36
  37 /* Opaque type for internal use.  */
  38 struct _ENTRY;
  39
  40 /*
  41  * Family of hash table handling functions.  The functions also
  42  * have reentrant counterparts ending with _r.  The non-reentrant
  43  * functions all work on a single internal hash table.
  44  */
  45
  46 /* Data type for reentrant functions.  */
  47 struct hsearch_data {
  48         struct _ENTRY *table;
  49         unsigned int size;
  50         unsigned int filled;
  51 /*
  52  * Callback function which will check whether the given change for variable
  53  * "__item" to "newval" may be applied or not, and possibly apply such change.
  54  * When (flag & H_FORCE) is set, it shall not print out any error message and
  55  * shall force overwriting of write-once variables.
  56  * Must return 0 for approval, 1 for denial.
  57  */
  58         int (*change_ok)(const struct env_entry *__item, const char *newval,
  59                          enum env_op, int flag);
  60 };
  61
  62 /* Create a new hash table which will contain at most "__nel" elements.  */
  63 extern int hcreate_r(size_t __nel, struct hsearch_data *__htab);
  64
  65 /* Destroy current internal hash table.  */
  66 extern void hdestroy_r(struct hsearch_data *__htab);
  67
  68 /*
  69  * Search for entry matching __item.key in internal hash table.  If
  70  * ACTION is `FIND' return found entry or signal error by returning
  71  * NULL.  If ACTION is `ENTER' replace existing data (if any) with
  72  * __item.data.
  73  * */
  74 extern int hsearch_r(struct env_entry __item, ACTION __action,
  75                      struct env_entry **__retval, struct hsearch_data *__htab,
  76                      int __flag);
  77
  78 /*
  79  * Search for an entry matching "__match".  Otherwise, Same semantics
  80  * as hsearch_r().
  81  */
  82 extern int hmatch_r(const char *__match, int __last_idx,
  83                     struct env_entry **__retval, struct hsearch_data *__htab);
  84
  85 /* Search and delete entry matching "__key" in internal hash table. */
  86 extern int hdelete_r(const char *__key, struct hsearch_data *__htab,
  87                      int __flag);
  88
  89 extern ssize_t hexport_r(struct hsearch_data *__htab,
  90                      const char __sep, int __flag, char **__resp, size_t __size,
  91                      int argc, char * const argv[]);
  92
  93 /*
  94  * nvars: length of vars array
  95  * vars: array of strings (variable names) to import (nvars == 0 means all)
  96  */
  97 extern int himport_r(struct hsearch_data *__htab,
  98                      const char *__env, size_t __size, const char __sep,
  99                      int __flag, int __crlf_is_lf, int nvars,
 100                      char * const vars[]);
 101
 102 /* Walk the whole table calling the callback on each element */
 103 extern int hwalk_r(struct hsearch_data *__htab,
 104                    int (*callback)(struct env_entry *entry));
 105
 106 /* Flags for himport_r(), hexport_r(), hdelete_r(), and hsearch_r() */
 107 #define H_NOCLEAR       (1 << 0) /* do not clear hash table before importing */
 108 #define H_FORCE         (1 << 1) /* overwrite read-only/write-once variables */
 109 #define H_INTERACTIVE   (1 << 2) /* indicate that an import is user directed */
 110 #define H_HIDE_DOT      (1 << 3) /* don't print env vars that begin with '.' */
 111 #define H_MATCH_KEY     (1 << 4) /* search/grep key  = variable names        */
 112 #define H_MATCH_DATA    (1 << 5) /* search/grep data = variable values       */
 113 #define H_MATCH_BOTH    (H_MATCH_KEY | H_MATCH_DATA) /* search/grep both     */
 114 #define H_MATCH_IDENT   (1 << 6) /* search for indentical strings            */
 115 #define H_MATCH_SUBSTR  (1 << 7) /* search for substring matches             */
 116 #define H_MATCH_REGEX   (1 << 8) /* search for regular expression matches    */
 117 #define H_MATCH_METHOD  (H_MATCH_IDENT | H_MATCH_SUBSTR | H_MATCH_REGEX)
 118 #define H_PROGRAMMATIC  (1 << 9) /* indicate that an import is from env_set() */
 119 #define H_ORIGIN_FLAGS  (H_INTERACTIVE | H_PROGRAMMATIC)
 120
 121 #endif /* _SEARCH_H_ */