blob: df5d61c2eb884b1f49f35a60cc546bce435efc55 [file] [log] [blame]
Wolfgang Denka6826fb2010-06-20 13:17:12 +02001/*
2 * Declarations for System V style searching functions.
3 * Copyright (C) 1995-1999, 2000 Free Software Foundation, Inc.
4 * This file is part of the GNU C Library.
5 *
Wolfgang Denkeee479c2013-07-08 11:48:07 +02006 * SPDX-License-Identifier: LGPL-2.1+
Wolfgang Denka6826fb2010-06-20 13:17:12 +02007 */
8
9/*
10 * Based on code from uClibc-0.9.30.3
11 * Extensions for use within U-Boot
Wolfgang Denkea009d42013-03-23 23:50:28 +000012 * Copyright (C) 2010-2013 Wolfgang Denk <wd@denx.de>
Wolfgang Denka6826fb2010-06-20 13:17:12 +020013 */
14
Robert P. J. Day36266432016-09-09 06:22:10 -040015#ifndef _SEARCH_H_
16#define _SEARCH_H_
Wolfgang Denka6826fb2010-06-20 13:17:12 +020017
18#include <stddef.h>
19
20#define __set_errno(val) do { errno = val; } while (0)
21
Joe Hershberger7afcf3a2012-12-11 22:16:21 -060022enum env_op {
23 env_op_create,
24 env_op_delete,
25 env_op_overwrite,
26};
27
Robert P. J. Day36266432016-09-09 06:22:10 -040028/* Action which shall be performed in the call to hsearch. */
Wolfgang Denka6826fb2010-06-20 13:17:12 +020029typedef enum {
30 FIND,
31 ENTER
32} ACTION;
33
34typedef struct entry {
Wolfgang Denk84b5e802011-07-29 14:42:18 +020035 const char *key;
Wolfgang Denka6826fb2010-06-20 13:17:12 +020036 char *data;
Joe Hershberger170ab112012-12-11 22:16:24 -060037 int (*callback)(const char *name, const char *value, enum env_op op,
38 int flags);
Joe Hershberger25980902012-12-11 22:16:31 -060039 int flags;
Wolfgang Denka6826fb2010-06-20 13:17:12 +020040} ENTRY;
41
42/* Opaque type for internal use. */
43struct _ENTRY;
44
45/*
46 * Family of hash table handling functions. The functions also
47 * have reentrant counterparts ending with _r. The non-reentrant
Robert P. J. Day36266432016-09-09 06:22:10 -040048 * functions all work on a single internal hash table.
Wolfgang Denka6826fb2010-06-20 13:17:12 +020049 */
50
51/* Data type for reentrant functions. */
52struct hsearch_data {
53 struct _ENTRY *table;
54 unsigned int size;
55 unsigned int filled;
Gerlando Falautoc5983592012-08-24 00:11:39 +000056/*
57 * Callback function which will check whether the given change for variable
Robert P. J. Day36266432016-09-09 06:22:10 -040058 * "__item" to "newval" may be applied or not, and possibly apply such change.
Gerlando Falautoc5983592012-08-24 00:11:39 +000059 * When (flag & H_FORCE) is set, it shall not print out any error message and
60 * shall force overwriting of write-once variables.
Robert P. J. Day36266432016-09-09 06:22:10 -040061 * Must return 0 for approval, 1 for denial.
Gerlando Falautoc5983592012-08-24 00:11:39 +000062 */
Joe Hershberger7afcf3a2012-12-11 22:16:21 -060063 int (*change_ok)(const ENTRY *__item, const char *newval, enum env_op,
64 int flag);
Wolfgang Denka6826fb2010-06-20 13:17:12 +020065};
66
Robert P. J. Day36266432016-09-09 06:22:10 -040067/* Create a new hash table which will contain at most "__nel" elements. */
Wolfgang Denka6826fb2010-06-20 13:17:12 +020068extern int hcreate_r(size_t __nel, struct hsearch_data *__htab);
69
Robert P. J. Day36266432016-09-09 06:22:10 -040070/* Destroy current internal hash table. */
Joe Hershbergerc4e00572012-12-11 22:16:19 -060071extern void hdestroy_r(struct hsearch_data *__htab);
Wolfgang Denka6826fb2010-06-20 13:17:12 +020072
73/*
Robert P. J. Day36266432016-09-09 06:22:10 -040074 * Search for entry matching __item.key in internal hash table. If
Wolfgang Denka6826fb2010-06-20 13:17:12 +020075 * ACTION is `FIND' return found entry or signal error by returning
76 * NULL. If ACTION is `ENTER' replace existing data (if any) with
Robert P. J. Day36266432016-09-09 06:22:10 -040077 * __item.data.
Wolfgang Denka6826fb2010-06-20 13:17:12 +020078 * */
Wolfgang Denka6826fb2010-06-20 13:17:12 +020079extern int hsearch_r(ENTRY __item, ACTION __action, ENTRY ** __retval,
Joe Hershbergerc4e00572012-12-11 22:16:19 -060080 struct hsearch_data *__htab, int __flag);
Wolfgang Denka6826fb2010-06-20 13:17:12 +020081
Mike Frysinger560d4242010-12-17 16:51:59 -050082/*
Robert P. J. Day36266432016-09-09 06:22:10 -040083 * Search for an entry matching "__match". Otherwise, Same semantics
Mike Frysinger560d4242010-12-17 16:51:59 -050084 * as hsearch_r().
85 */
86extern int hmatch_r(const char *__match, int __last_idx, ENTRY ** __retval,
87 struct hsearch_data *__htab);
88
Robert P. J. Day36266432016-09-09 06:22:10 -040089/* Search and delete entry matching "__key" in internal hash table. */
Gerlando Falauto152874b2012-08-24 00:11:40 +000090extern int hdelete_r(const char *__key, struct hsearch_data *__htab,
Joe Hershbergerc4e00572012-12-11 22:16:19 -060091 int __flag);
Wolfgang Denka6826fb2010-06-20 13:17:12 +020092
Wolfgang Denka6826fb2010-06-20 13:17:12 +020093extern ssize_t hexport_r(struct hsearch_data *__htab,
Joe Hershbergerbe112352012-12-11 22:16:23 -060094 const char __sep, int __flag, char **__resp, size_t __size,
Wolfgang Denk37f2fe72011-11-06 22:49:44 +010095 int argc, char * const argv[]);
Wolfgang Denka6826fb2010-06-20 13:17:12 +020096
Gerlando Falauto348b1f12012-08-24 00:11:38 +000097/*
98 * nvars: length of vars array
99 * vars: array of strings (variable names) to import (nvars == 0 means all)
100 */
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200101extern int himport_r(struct hsearch_data *__htab,
102 const char *__env, size_t __size, const char __sep,
Alexander Hollerecd14462014-07-14 17:49:55 +0200103 int __flag, int __crlf_is_lf, int nvars,
104 char * const vars[]);
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200105
Joe Hershberger170ab112012-12-11 22:16:24 -0600106/* Walk the whole table calling the callback on each element */
107extern int hwalk_r(struct hsearch_data *__htab, int (*callback)(ENTRY *));
108
Joe Hershbergerbe112352012-12-11 22:16:23 -0600109/* Flags for himport_r(), hexport_r(), hdelete_r(), and hsearch_r() */
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600110#define H_NOCLEAR (1 << 0) /* do not clear hash table before importing */
111#define H_FORCE (1 << 1) /* overwrite read-only/write-once variables */
112#define H_INTERACTIVE (1 << 2) /* indicate that an import is user directed */
Joe Hershbergerbe112352012-12-11 22:16:23 -0600113#define H_HIDE_DOT (1 << 3) /* don't print env vars that begin with '.' */
Wolfgang Denkea009d42013-03-23 23:50:28 +0000114#define H_MATCH_KEY (1 << 4) /* search/grep key = variable names */
115#define H_MATCH_DATA (1 << 5) /* search/grep data = variable values */
116#define H_MATCH_BOTH (H_MATCH_KEY | H_MATCH_DATA) /* search/grep both */
117#define H_MATCH_IDENT (1 << 6) /* search for indentical strings */
Wolfgang Denkbe29df62013-03-23 23:50:32 +0000118#define H_MATCH_SUBSTR (1 << 7) /* search for substring matches */
119#define H_MATCH_REGEX (1 << 8) /* search for regular expression matches */
120#define H_MATCH_METHOD (H_MATCH_IDENT | H_MATCH_SUBSTR | H_MATCH_REGEX)
Simon Glass382bee52017-08-03 12:22:09 -0600121#define H_PROGRAMMATIC (1 << 9) /* indicate that an import is from env_set() */
Joe Hershberger94b467b2015-05-20 14:27:21 -0500122#define H_ORIGIN_FLAGS (H_INTERACTIVE | H_PROGRAMMATIC)
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200123
Robert P. J. Day36266432016-09-09 06:22:10 -0400124#endif /* _SEARCH_H_ */