blob: d0bb44388e19041b5d20f0398a4630a937743b9a [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: LGPL-2.1+ */
Wolfgang Denka6826fb2010-06-20 13:17:12 +02002/*
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.
Wolfgang Denka6826fb2010-06-20 13:17:12 +02006 */
7
8/*
9 * Based on code from uClibc-0.9.30.3
10 * Extensions for use within U-Boot
Wolfgang Denkea009d42013-03-23 23:50:28 +000011 * Copyright (C) 2010-2013 Wolfgang Denk <wd@denx.de>
Wolfgang Denka6826fb2010-06-20 13:17:12 +020012 */
13
Robert P. J. Day36266432016-09-09 06:22:10 -040014#ifndef _SEARCH_H_
15#define _SEARCH_H_
Wolfgang Denka6826fb2010-06-20 13:17:12 +020016
Simon Glass9fb625c2019-08-01 09:46:51 -060017#include <env.h>
Wolfgang Denka6826fb2010-06-20 13:17:12 +020018#include <stddef.h>
19
Simon Glasscb2ba9d2019-08-01 09:47:10 -060020#define set_errno(val) do { errno = val; } while (0)
Wolfgang Denka6826fb2010-06-20 13:17:12 +020021
Simon Glass3f0d6802019-08-01 09:47:09 -060022/* enum env_action: action which shall be performed in the call to hsearch */
23enum env_action {
24 ENV_FIND,
25 ENV_ENTER,
26};
Wolfgang Denka6826fb2010-06-20 13:17:12 +020027
Simon Glassdd2408c2019-08-02 09:44:18 -060028/** struct env_entry - An entry in the environment hashtable */
29struct env_entry {
Wolfgang Denk84b5e802011-07-29 14:42:18 +020030 const char *key;
Wolfgang Denka6826fb2010-06-20 13:17:12 +020031 char *data;
Rasmus Villemoes080019b2020-02-27 13:56:12 +000032#ifndef CONFIG_SPL_BUILD
Joe Hershberger170ab112012-12-11 22:16:24 -060033 int (*callback)(const char *name, const char *value, enum env_op op,
34 int flags);
Rasmus Villemoes080019b2020-02-27 13:56:12 +000035#endif
Joe Hershberger25980902012-12-11 22:16:31 -060036 int flags;
Simon Glassdd2408c2019-08-02 09:44:18 -060037};
Wolfgang Denka6826fb2010-06-20 13:17:12 +020038
Wolfgang Denka6826fb2010-06-20 13:17:12 +020039/*
40 * Family of hash table handling functions. The functions also
41 * have reentrant counterparts ending with _r. The non-reentrant
Robert P. J. Day36266432016-09-09 06:22:10 -040042 * functions all work on a single internal hash table.
Wolfgang Denka6826fb2010-06-20 13:17:12 +020043 */
44
45/* Data type for reentrant functions. */
46struct hsearch_data {
Simon Glass25e51e92019-08-02 09:44:19 -060047 struct env_entry_node *table;
Wolfgang Denka6826fb2010-06-20 13:17:12 +020048 unsigned int size;
49 unsigned int filled;
Gerlando Falautoc5983592012-08-24 00:11:39 +000050/*
51 * Callback function which will check whether the given change for variable
Simon Glasscb2ba9d2019-08-01 09:47:10 -060052 * "item" to "newval" may be applied or not, and possibly apply such change.
Gerlando Falautoc5983592012-08-24 00:11:39 +000053 * When (flag & H_FORCE) is set, it shall not print out any error message and
54 * shall force overwriting of write-once variables.
Robert P. J. Day36266432016-09-09 06:22:10 -040055 * Must return 0 for approval, 1 for denial.
Gerlando Falautoc5983592012-08-24 00:11:39 +000056 */
Simon Glasscb2ba9d2019-08-01 09:47:10 -060057 int (*change_ok)(const struct env_entry *item, const char *newval,
Simon Glassdd2408c2019-08-02 09:44:18 -060058 enum env_op, int flag);
Wolfgang Denka6826fb2010-06-20 13:17:12 +020059};
60
Simon Glasscb2ba9d2019-08-01 09:47:10 -060061/* Create a new hash table which will contain at most "nel" elements. */
62int hcreate_r(size_t nel, struct hsearch_data *htab);
Wolfgang Denka6826fb2010-06-20 13:17:12 +020063
Robert P. J. Day36266432016-09-09 06:22:10 -040064/* Destroy current internal hash table. */
Simon Glasscb2ba9d2019-08-01 09:47:10 -060065void hdestroy_r(struct hsearch_data *htab);
Wolfgang Denka6826fb2010-06-20 13:17:12 +020066
67/*
Simon Glasscb2ba9d2019-08-01 09:47:10 -060068 * Search for entry matching item.key in internal hash table. If
69 * action is `ENV_FIND' return found entry or signal error by returning
70 * NULL. If action is `ENV_ENTER' replace existing data (if any) with
71 * item.data.
Wolfgang Denka6826fb2010-06-20 13:17:12 +020072 * */
Simon Glasscb2ba9d2019-08-01 09:47:10 -060073int hsearch_r(struct env_entry item, enum env_action action,
74 struct env_entry **retval, struct hsearch_data *htab, int flag);
Wolfgang Denka6826fb2010-06-20 13:17:12 +020075
Mike Frysinger560d4242010-12-17 16:51:59 -050076/*
Simon Glasscb2ba9d2019-08-01 09:47:10 -060077 * Search for an entry matching "match". Otherwise, Same semantics
Mike Frysinger560d4242010-12-17 16:51:59 -050078 * as hsearch_r().
79 */
Simon Glasscb2ba9d2019-08-01 09:47:10 -060080int hmatch_r(const char *match, int last_idx, struct env_entry **retval,
81 struct hsearch_data *htab);
Mike Frysinger560d4242010-12-17 16:51:59 -050082
Simon Glass96434a72020-11-05 10:33:37 -070083/**
84 * hdelete_r() - Search and delete entry in internal hash table
85 *
86 * @key: Name of entry to delete
87 * @htab: Hash table
88 * @flag: Flags to use (H_...)
89 * @return 0 on success, -ENOENT if not found, -EPERM if the hash table callback
90 * rejected changing the variable, -EINVAL if the hash table refused to
91 * delete the variable
92 */
Simon Glasscb2ba9d2019-08-01 09:47:10 -060093int hdelete_r(const char *key, struct hsearch_data *htab, int flag);
Wolfgang Denka6826fb2010-06-20 13:17:12 +020094
Simon Glasscb2ba9d2019-08-01 09:47:10 -060095ssize_t hexport_r(struct hsearch_data *htab, const char sep, int flag,
Simon Glass09140112020-05-10 11:40:03 -060096 char **resp, size_t size, int argc, char *const argv[]);
Wolfgang Denka6826fb2010-06-20 13:17:12 +020097
Gerlando Falauto348b1f12012-08-24 00:11:38 +000098/*
99 * nvars: length of vars array
100 * vars: array of strings (variable names) to import (nvars == 0 means all)
101 */
Simon Glasscb2ba9d2019-08-01 09:47:10 -0600102int himport_r(struct hsearch_data *htab, const char *env, size_t size,
103 const char sep, 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 */
Simon Glasscb2ba9d2019-08-01 09:47:10 -0600107int hwalk_r(struct hsearch_data *htab,
108 int (*callback)(struct env_entry *entry));
Joe Hershberger170ab112012-12-11 22:16:24 -0600109
Joe Hershbergerbe112352012-12-11 22:16:23 -0600110/* Flags for himport_r(), hexport_r(), hdelete_r(), and hsearch_r() */
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600111#define H_NOCLEAR (1 << 0) /* do not clear hash table before importing */
112#define H_FORCE (1 << 1) /* overwrite read-only/write-once variables */
113#define H_INTERACTIVE (1 << 2) /* indicate that an import is user directed */
Joe Hershbergerbe112352012-12-11 22:16:23 -0600114#define H_HIDE_DOT (1 << 3) /* don't print env vars that begin with '.' */
Wolfgang Denkea009d42013-03-23 23:50:28 +0000115#define H_MATCH_KEY (1 << 4) /* search/grep key = variable names */
116#define H_MATCH_DATA (1 << 5) /* search/grep data = variable values */
117#define H_MATCH_BOTH (H_MATCH_KEY | H_MATCH_DATA) /* search/grep both */
118#define H_MATCH_IDENT (1 << 6) /* search for indentical strings */
Wolfgang Denkbe29df62013-03-23 23:50:32 +0000119#define H_MATCH_SUBSTR (1 << 7) /* search for substring matches */
120#define H_MATCH_REGEX (1 << 8) /* search for regular expression matches */
121#define H_MATCH_METHOD (H_MATCH_IDENT | H_MATCH_SUBSTR | H_MATCH_REGEX)
Simon Glass382bee52017-08-03 12:22:09 -0600122#define H_PROGRAMMATIC (1 << 9) /* indicate that an import is from env_set() */
Joe Hershberger94b467b2015-05-20 14:27:21 -0500123#define H_ORIGIN_FLAGS (H_INTERACTIVE | H_PROGRAMMATIC)
Marek Vasutef9bef22020-07-07 20:51:34 +0200124#define H_DEFAULT (1 << 10) /* indicate that an import is default env */
Marek Vasut890feec2020-07-07 20:51:35 +0200125#define H_EXTERNAL (1 << 11) /* indicate that an import is external env */
Wolfgang Denka6826fb2010-06-20 13:17:12 +0200126
Robert P. J. Day36266432016-09-09 06:22:10 -0400127#endif /* _SEARCH_H_ */