]>
Commit | Line | Data |
---|---|---|
83d290c5 | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
a6826fbc WD |
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. | |
a6826fbc WD |
6 | */ |
7 | ||
8 | /* | |
9 | * Based on code from uClibc-0.9.30.3 | |
10 | * Extensions for use within U-Boot | |
ea009d47 | 11 | * Copyright (C) 2010-2013 Wolfgang Denk <wd@denx.de> |
a6826fbc WD |
12 | */ |
13 | ||
36266435 RD |
14 | #ifndef _SEARCH_H_ |
15 | #define _SEARCH_H_ | |
a6826fbc | 16 | |
9fb625ce | 17 | #include <env.h> |
a6826fbc WD |
18 | #include <stddef.h> |
19 | ||
cb2ba9db | 20 | #define set_errno(val) do { errno = val; } while (0) |
a6826fbc | 21 | |
3f0d6807 SG |
22 | /* enum env_action: action which shall be performed in the call to hsearch */ |
23 | enum env_action { | |
24 | ENV_FIND, | |
25 | ENV_ENTER, | |
26 | }; | |
a6826fbc | 27 | |
dd2408ca SG |
28 | /** struct env_entry - An entry in the environment hashtable */ |
29 | struct env_entry { | |
84b5e802 | 30 | const char *key; |
a6826fbc | 31 | char *data; |
170ab110 JH |
32 | int (*callback)(const char *name, const char *value, enum env_op op, |
33 | int flags); | |
2598090b | 34 | int flags; |
dd2408ca | 35 | }; |
a6826fbc | 36 | |
a6826fbc WD |
37 | /* |
38 | * Family of hash table handling functions. The functions also | |
39 | * have reentrant counterparts ending with _r. The non-reentrant | |
36266435 | 40 | * functions all work on a single internal hash table. |
a6826fbc WD |
41 | */ |
42 | ||
43 | /* Data type for reentrant functions. */ | |
44 | struct hsearch_data { | |
25e51e90 | 45 | struct env_entry_node *table; |
a6826fbc WD |
46 | unsigned int size; |
47 | unsigned int filled; | |
c5983592 GF |
48 | /* |
49 | * Callback function which will check whether the given change for variable | |
cb2ba9db | 50 | * "item" to "newval" may be applied or not, and possibly apply such change. |
c5983592 GF |
51 | * When (flag & H_FORCE) is set, it shall not print out any error message and |
52 | * shall force overwriting of write-once variables. | |
36266435 | 53 | * Must return 0 for approval, 1 for denial. |
c5983592 | 54 | */ |
cb2ba9db | 55 | int (*change_ok)(const struct env_entry *item, const char *newval, |
dd2408ca | 56 | enum env_op, int flag); |
a6826fbc WD |
57 | }; |
58 | ||
cb2ba9db SG |
59 | /* Create a new hash table which will contain at most "nel" elements. */ |
60 | int hcreate_r(size_t nel, struct hsearch_data *htab); | |
a6826fbc | 61 | |
36266435 | 62 | /* Destroy current internal hash table. */ |
cb2ba9db | 63 | void hdestroy_r(struct hsearch_data *htab); |
a6826fbc WD |
64 | |
65 | /* | |
cb2ba9db SG |
66 | * Search for entry matching item.key in internal hash table. If |
67 | * action is `ENV_FIND' return found entry or signal error by returning | |
68 | * NULL. If action is `ENV_ENTER' replace existing data (if any) with | |
69 | * item.data. | |
a6826fbc | 70 | * */ |
cb2ba9db SG |
71 | int hsearch_r(struct env_entry item, enum env_action action, |
72 | struct env_entry **retval, struct hsearch_data *htab, int flag); | |
a6826fbc | 73 | |
560d424b | 74 | /* |
cb2ba9db | 75 | * Search for an entry matching "match". Otherwise, Same semantics |
560d424b MF |
76 | * as hsearch_r(). |
77 | */ | |
cb2ba9db SG |
78 | int hmatch_r(const char *match, int last_idx, struct env_entry **retval, |
79 | struct hsearch_data *htab); | |
560d424b | 80 | |
cb2ba9db SG |
81 | /* Search and delete entry matching "key" in internal hash table. */ |
82 | int hdelete_r(const char *key, struct hsearch_data *htab, int flag); | |
a6826fbc | 83 | |
cb2ba9db SG |
84 | ssize_t hexport_r(struct hsearch_data *htab, const char sep, int flag, |
85 | char **resp, size_t size, int argc, char * const argv[]); | |
a6826fbc | 86 | |
348b1f1c GF |
87 | /* |
88 | * nvars: length of vars array | |
89 | * vars: array of strings (variable names) to import (nvars == 0 means all) | |
90 | */ | |
cb2ba9db SG |
91 | int himport_r(struct hsearch_data *htab, const char *env, size_t size, |
92 | const char sep, int flag, int crlf_is_lf, int nvars, | |
93 | char * const vars[]); | |
a6826fbc | 94 | |
170ab110 | 95 | /* Walk the whole table calling the callback on each element */ |
cb2ba9db SG |
96 | int hwalk_r(struct hsearch_data *htab, |
97 | int (*callback)(struct env_entry *entry)); | |
170ab110 | 98 | |
be11235a | 99 | /* Flags for himport_r(), hexport_r(), hdelete_r(), and hsearch_r() */ |
c4e0057f JH |
100 | #define H_NOCLEAR (1 << 0) /* do not clear hash table before importing */ |
101 | #define H_FORCE (1 << 1) /* overwrite read-only/write-once variables */ | |
102 | #define H_INTERACTIVE (1 << 2) /* indicate that an import is user directed */ | |
be11235a | 103 | #define H_HIDE_DOT (1 << 3) /* don't print env vars that begin with '.' */ |
ea009d47 WD |
104 | #define H_MATCH_KEY (1 << 4) /* search/grep key = variable names */ |
105 | #define H_MATCH_DATA (1 << 5) /* search/grep data = variable values */ | |
106 | #define H_MATCH_BOTH (H_MATCH_KEY | H_MATCH_DATA) /* search/grep both */ | |
107 | #define H_MATCH_IDENT (1 << 6) /* search for indentical strings */ | |
be29df6a WD |
108 | #define H_MATCH_SUBSTR (1 << 7) /* search for substring matches */ |
109 | #define H_MATCH_REGEX (1 << 8) /* search for regular expression matches */ | |
110 | #define H_MATCH_METHOD (H_MATCH_IDENT | H_MATCH_SUBSTR | H_MATCH_REGEX) | |
382bee57 | 111 | #define H_PROGRAMMATIC (1 << 9) /* indicate that an import is from env_set() */ |
94b467b1 | 112 | #define H_ORIGIN_FLAGS (H_INTERACTIVE | H_PROGRAMMATIC) |
a6826fbc | 113 | |
36266435 | 114 | #endif /* _SEARCH_H_ */ |