[u-boot.git] / common / env_flags.c

/*
 * (C) Copyright 2012
 * Joe Hershberger, National Instruments, [email protected]
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include <linux/string.h>
#include <linux/ctype.h>

#ifdef USE_HOSTCC /* Eliminate "ANSI does not permit..." warnings */
#include <stdint.h>
#include <stdio.h>
#include "fw_env.h"
#include <env_attr.h>
#include <env_flags.h>
#define getenv fw_getenv
#else
#include <common.h>
#include <environment.h>
#endif

#ifdef CONFIG_CMD_NET
#define ENV_FLAGS_NET_VARTYPE_REPS "im"
#else
#define ENV_FLAGS_NET_VARTYPE_REPS ""
#endif

static const char env_flags_vartype_rep[] = "sdxb" ENV_FLAGS_NET_VARTYPE_REPS;
static const char env_flags_varaccess_rep[] = "aroc";
static const int env_flags_varaccess_mask[] = {
	0,
	ENV_FLAGS_VARACCESS_PREVENT_DELETE |
		ENV_FLAGS_VARACCESS_PREVENT_CREATE |
		ENV_FLAGS_VARACCESS_PREVENT_OVERWR,
	ENV_FLAGS_VARACCESS_PREVENT_DELETE |
		ENV_FLAGS_VARACCESS_PREVENT_OVERWR,
	ENV_FLAGS_VARACCESS_PREVENT_DELETE |
		ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR};

#ifdef CONFIG_CMD_ENV_FLAGS
static const char * const env_flags_vartype_names[] = {
	"string",
	"decimal",
	"hexadecimal",
	"boolean",
#ifdef CONFIG_CMD_NET
	"IP address",
	"MAC address",
#endif
};
static const char * const env_flags_varaccess_names[] = {
	"any",
	"read-only",
	"write-once",
	"change-default",
};

/*
 * Print the whole list of available type flags.
 */
void env_flags_print_vartypes(void)
{
	enum env_flags_vartype curtype = (enum env_flags_vartype)0;

	while (curtype != env_flags_vartype_end) {
		printf("\t%c   -\t%s\n", env_flags_vartype_rep[curtype],
			env_flags_vartype_names[curtype]);
		curtype++;
	}
}

/*
 * Print the whole list of available access flags.
 */
void env_flags_print_varaccess(void)
{
	enum env_flags_varaccess curaccess = (enum env_flags_varaccess)0;

	while (curaccess != env_flags_varaccess_end) {
		printf("\t%c   -\t%s\n", env_flags_varaccess_rep[curaccess],
			env_flags_varaccess_names[curaccess]);
		curaccess++;
	}
}

/*
 * Return the name of the type.
 */
const char *env_flags_get_vartype_name(enum env_flags_vartype type)
{
	return env_flags_vartype_names[type];
}

/*
 * Return the name of the access.
 */
const char *env_flags_get_varaccess_name(enum env_flags_varaccess access)
{
	return env_flags_varaccess_names[access];
}
#endif /* CONFIG_CMD_ENV_FLAGS */

/*
 * Parse the flags string from a .flags attribute list into the vartype enum.
 */
enum env_flags_vartype env_flags_parse_vartype(const char *flags)
{
	char *type;

	if (strlen(flags) <= ENV_FLAGS_VARTYPE_LOC)
		return env_flags_vartype_string;

	type = strchr(env_flags_vartype_rep,
		flags[ENV_FLAGS_VARTYPE_LOC]);

	if (type != NULL)
		return (enum env_flags_vartype)
			(type - &env_flags_vartype_rep[0]);

	printf("## Warning: Unknown environment variable type '%c'\n",
		flags[ENV_FLAGS_VARTYPE_LOC]);
	return env_flags_vartype_string;
}

/*
 * Parse the flags string from a .flags attribute list into the varaccess enum.
 */
enum env_flags_varaccess env_flags_parse_varaccess(const char *flags)
{
	char *access;

	if (strlen(flags) <= ENV_FLAGS_VARACCESS_LOC)
		return env_flags_varaccess_any;

	access = strchr(env_flags_varaccess_rep,
		flags[ENV_FLAGS_VARACCESS_LOC]);

	if (access != NULL)
		return (enum env_flags_varaccess)
			(access - &env_flags_varaccess_rep[0]);

	printf("## Warning: Unknown environment variable access method '%c'\n",
		flags[ENV_FLAGS_VARACCESS_LOC]);
	return env_flags_varaccess_any;
}

/*
 * Parse the binary flags from a hash table entry into the varaccess enum.
 */
enum env_flags_varaccess env_flags_parse_varaccess_from_binflags(int binflags)
{
	int i;

	for (i = 0; i < ARRAY_SIZE(env_flags_varaccess_mask); i++)
		if (env_flags_varaccess_mask[i] ==
		    (binflags & ENV_FLAGS_VARACCESS_BIN_MASK))
			return (enum env_flags_varaccess)i;

	printf("Warning: Non-standard access flags. (0x%x)\n",
		binflags & ENV_FLAGS_VARACCESS_BIN_MASK);

	return env_flags_varaccess_any;
}

static inline int is_hex_prefix(const char *value)
{
	return value[0] == '0' && (value[1] == 'x' || value[1] == 'X');
}

static void skip_num(int hex, const char *value, const char **end,
	int max_digits)
{
	int i;

	if (hex && is_hex_prefix(value))
		value += 2;

	for (i = max_digits; i != 0; i--) {
		if (hex && !isxdigit(*value))
			break;
		if (!hex && !isdigit(*value))
			break;
		value++;
	}
	if (end != NULL)
		*end = value;
}

#ifdef CONFIG_CMD_NET
int eth_validate_ethaddr_str(const char *addr)
{
	const char *end;
	const char *cur;
	int i;

	cur = addr;
	for (i = 0; i < 6; i++) {
		skip_num(1, cur, &end, 2);
		if (cur == end)
			return -1;
		if (cur + 2 == end && is_hex_prefix(cur))
			return -1;
		if (i != 5 && *end != ':')
			return -1;
		if (i == 5 && *end != '\0')
			return -1;
		cur = end + 1;
	}

	return 0;
}
#endif

/*
 * Based on the declared type enum, validate that the value string complies
 * with that format
 */
static int _env_flags_validate_type(const char *value,
	enum env_flags_vartype type)
{
	const char *end;
#ifdef CONFIG_CMD_NET
	const char *cur;
	int i;
#endif

	switch (type) {
	case env_flags_vartype_string:
		break;
	case env_flags_vartype_decimal:
		skip_num(0, value, &end, -1);
		if (*end != '\0')
			return -1;
		break;
	case env_flags_vartype_hex:
		skip_num(1, value, &end, -1);
		if (*end != '\0')
			return -1;
		if (value + 2 == end && is_hex_prefix(value))
			return -1;
		break;
	case env_flags_vartype_bool:
		if (value[0] != '1' && value[0] != 'y' && value[0] != 't' &&
		    value[0] != 'Y' && value[0] != 'T' &&
		    value[0] != '0' && value[0] != 'n' && value[0] != 'f' &&
		    value[0] != 'N' && value[0] != 'F')
			return -1;
		if (value[1] != '\0')
			return -1;
		break;
#ifdef CONFIG_CMD_NET
	case env_flags_vartype_ipaddr:
		cur = value;
		for (i = 0; i < 4; i++) {
			skip_num(0, cur, &end, 3);
			if (cur == end)
				return -1;
			if (i != 3 && *end != '.')
				return -1;
			if (i == 3 && *end != '\0')
				return -1;
			cur = end + 1;
		}
		break;
	case env_flags_vartype_macaddr:
		if (eth_validate_ethaddr_str(value))
			return -1;
		break;
#endif
	case env_flags_vartype_end:
		return -1;
	}

	/* OK */
	return 0;
}

/*
 * Look for flags in a provided list and failing that the static list
 */
static inline int env_flags_lookup(const char *flags_list, const char *name,
	char *flags)
{
	int ret = 1;

	if (!flags)
		/* bad parameter */
		return -1;

	/* try the env first */
	if (flags_list)
		ret = env_attr_lookup(flags_list, name, flags);

	if (ret != 0)
		/* if not found in the env, look in the static list */
		ret = env_attr_lookup(ENV_FLAGS_LIST_STATIC, name, flags);

	return ret;
}

#ifdef USE_HOSTCC /* Functions only used from tools/env */
/*
 * Look up any flags directly from the .flags variable and the static list
 * and convert them to the vartype enum.
 */
enum env_flags_vartype env_flags_get_type(const char *name)
{
	const char *flags_list = getenv(ENV_FLAGS_VAR);
	char flags[ENV_FLAGS_ATTR_MAX_LEN + 1];

	if (env_flags_lookup(flags_list, name, flags))
		return env_flags_vartype_string;

	if (strlen(flags) <= ENV_FLAGS_VARTYPE_LOC)
		return env_flags_vartype_string;

	return env_flags_parse_vartype(flags);
}

/*
 * Look up the access of a variable directly from the .flags var.
 */
enum env_flags_varaccess env_flags_get_varaccess(const char *name)
{
	const char *flags_list = getenv(ENV_FLAGS_VAR);
	char flags[ENV_FLAGS_ATTR_MAX_LEN + 1];

	if (env_flags_lookup(flags_list, name, flags))
		return env_flags_varaccess_any;

	if (strlen(flags) <= ENV_FLAGS_VARACCESS_LOC)
		return env_flags_varaccess_any;

	return env_flags_parse_varaccess(flags);
}

/*
 * Validate that the proposed new value for "name" is valid according to the
 * defined flags for that variable, if any.
 */
int env_flags_validate_type(const char *name, const char *value)
{
	enum env_flags_vartype type;

	if (value == NULL)
		return 0;
	type = env_flags_get_type(name);
	if (_env_flags_validate_type(value, type) < 0) {
		printf("## Error: flags type check failure for "
			"\"%s\" <= \"%s\" (type: %c)\n",
			name, value, env_flags_vartype_rep[type]);
		return -1;
	}
	return 0;
}

/*
 * Validate that the proposed access to variable "name" is valid according to
 * the defined flags for that variable, if any.
 */
int env_flags_validate_varaccess(const char *name, int check_mask)
{
	enum env_flags_varaccess access;
	int access_mask;

	access = env_flags_get_varaccess(name);
	access_mask = env_flags_varaccess_mask[access];

	return (check_mask & access_mask) != 0;
}

/*
 * Validate the parameters to "env set" directly
 */
int env_flags_validate_env_set_params(int argc, char * const argv[])
{
	if ((argc >= 3) && argv[2] != NULL) {
		enum env_flags_vartype type = env_flags_get_type(argv[1]);

		/*
		 * we don't currently check types that need more than
		 * one argument
		 */
		if (type != env_flags_vartype_string && argc > 3) {
			printf("## Error: too many parameters for setting "
				"\"%s\"\n", argv[1]);
			return -1;
		}
		return env_flags_validate_type(argv[1], argv[2]);
	}
	/* ok */
	return 0;
}

#else /* !USE_HOSTCC - Functions only used from lib/hashtable.c */

/*
 * Parse the flag charachters from the .flags attribute list into the binary
 * form to be stored in the environment entry->flags field.
 */
static int env_parse_flags_to_bin(const char *flags)
{
	int binflags;

	binflags = env_flags_parse_vartype(flags) & ENV_FLAGS_VARTYPE_BIN_MASK;
	binflags |= env_flags_varaccess_mask[env_flags_parse_varaccess(flags)];

	return binflags;
}

static int first_call = 1;
static const char *flags_list;

/*
 * Look for possible flags for a newly added variable
 * This is called specifically when the variable did not exist in the hash
 * previously, so the blanket update did not find this variable.
 */
void env_flags_init(ENTRY *var_entry)
{
	const char *var_name = var_entry->key;
	char flags[ENV_FLAGS_ATTR_MAX_LEN + 1] = "";
	int ret = 1;

	if (first_call) {
		flags_list = getenv(ENV_FLAGS_VAR);
		first_call = 0;
	}
	/* look in the ".flags" and static for a reference to this variable */
	ret = env_flags_lookup(flags_list, var_name, flags);

	/* if any flags were found, set the binary form to the entry */
	if (!ret && strlen(flags))
		var_entry->flags = env_parse_flags_to_bin(flags);
}

/*
 * Called on each existing env var prior to the blanket update since removing
 * a flag in the flag list should remove its flags.
 */
static int clear_flags(ENTRY *entry)
{
	entry->flags = 0;

	return 0;
}

/*
 * Call for each element in the list that defines flags for a variable
 */
static int set_flags(const char *name, const char *value, void *priv)
{
	ENTRY e, *ep;

	e.key	= name;
	e.data	= NULL;
	e.callback = NULL;
	hsearch_r(e, FIND, &ep, &env_htab, 0);

	/* does the env variable actually exist? */
	if (ep != NULL) {
		/* the flag list is empty, so clear the flags */
		if (value == NULL || strlen(value) == 0)
			ep->flags = 0;
		else
			/* assign the requested flags */
			ep->flags = env_parse_flags_to_bin(value);
	}

	return 0;
}

static int on_flags(const char *name, const char *value, enum env_op op,
	int flags)
{
	/* remove all flags */
	hwalk_r(&env_htab, clear_flags);

	/* configure any static flags */
	env_attr_walk(ENV_FLAGS_LIST_STATIC, set_flags, NULL);
	/* configure any dynamic flags */
	env_attr_walk(value, set_flags, NULL);

	return 0;
}
U_BOOT_ENV_CALLBACK(flags, on_flags);

/*
 * Perform consistency checking before creating, overwriting, or deleting an
 * environment variable. Called as a callback function by hsearch_r() and
 * hdelete_r(). Returns 0 in case of success, 1 in case of failure.
 * When (flag & H_FORCE) is set, do not print out any error message and force
 * overwriting of write-once variables.
 */

int env_flags_validate(const ENTRY *item, const char *newval, enum env_op op,
	int flag)
{
	const char *name;
	const char *oldval = NULL;

	if (op != env_op_create)
		oldval = item->data;

	name = item->key;

	/* Default value for NULL to protect string-manipulating functions */
	newval = newval ? : "";

	/* validate the value to match the variable type */
	if (op != env_op_delete) {
		enum env_flags_vartype type = (enum env_flags_vartype)
			(ENV_FLAGS_VARTYPE_BIN_MASK & item->flags);

		if (_env_flags_validate_type(newval, type) < 0) {
			printf("## Error: flags type check failure for "
				"\"%s\" <= \"%s\" (type: %c)\n",
				name, newval, env_flags_vartype_rep[type]);
			return -1;
		}
	}

	/* check for access permission */
#ifndef CONFIG_ENV_ACCESS_IGNORE_FORCE
	if (flag & H_FORCE)
		return 0;
#endif
	switch (op) {
	case env_op_delete:
		if (item->flags & ENV_FLAGS_VARACCESS_PREVENT_DELETE) {
			printf("## Error: Can't delete \"%s\"\n", name);
			return 1;
		}
		break;
	case env_op_overwrite:
		if (item->flags & ENV_FLAGS_VARACCESS_PREVENT_OVERWR) {
			printf("## Error: Can't overwrite \"%s\"\n", name);
			return 1;
		} else if (item->flags &
		    ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR) {
			const char *defval = getenv_default(name);

			if (defval == NULL)
				defval = "";
			printf("oldval: %s  defval: %s\n", oldval, defval);
			if (strcmp(oldval, defval) != 0) {
				printf("## Error: Can't overwrite \"%s\"\n",
					name);
				return 1;
			}
		}
		break;
	case env_op_create:
		if (item->flags & ENV_FLAGS_VARACCESS_PREVENT_CREATE) {
			printf("## Error: Can't create \"%s\"\n", name);
			return 1;
		}
		break;
	}

	return 0;
}

#endif
Commit	Line	Data
2598090b JH	1	/*
	2	* (C) Copyright 2012
	3	* Joe Hershberger, National Instruments, [email protected]
	4	*
1a459660	5	* SPDX-License-Identifier: GPL-2.0+
2598090b JH	6	*/
	7
	8	#include <linux/string.h>
	9	#include <linux/ctype.h>
	10
30fd4fad JH	11	#ifdef USE_HOSTCC /* Eliminate "ANSI does not permit..." warnings */
	12	#include <stdint.h>
	13	#include <stdio.h>
	14	#include "fw_env.h"
	15	#include <env_attr.h>
	16	#include <env_flags.h>
	17	#define getenv fw_getenv
	18	#else
2598090b JH	19	#include <common.h>
2598090b JH	20	#include <environment.h>
30fd4fad	21	#endif
2598090b JH	22
	23	#ifdef CONFIG_CMD_NET
	24	#define ENV_FLAGS_NET_VARTYPE_REPS "im"
	25	#else
	26	#define ENV_FLAGS_NET_VARTYPE_REPS ""
	27	#endif
	28
	29	static const char env_flags_vartype_rep[] = "sdxb" ENV_FLAGS_NET_VARTYPE_REPS;
267541f7 JH	30	static const char env_flags_varaccess_rep[] = "aroc";
	31	static const int env_flags_varaccess_mask[] = {
	32	0,
	33	ENV_FLAGS_VARACCESS_PREVENT_DELETE \|
	34	ENV_FLAGS_VARACCESS_PREVENT_CREATE \|
	35	ENV_FLAGS_VARACCESS_PREVENT_OVERWR,
	36	ENV_FLAGS_VARACCESS_PREVENT_DELETE \|
	37	ENV_FLAGS_VARACCESS_PREVENT_OVERWR,
	38	ENV_FLAGS_VARACCESS_PREVENT_DELETE \|
	39	ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR};
	40
fffad71b JH	41	#ifdef CONFIG_CMD_ENV_FLAGS
	42	static const char * const env_flags_vartype_names[] = {
	43	"string",
	44	"decimal",
	45	"hexadecimal",
	46	"boolean",
	47	#ifdef CONFIG_CMD_NET
	48	"IP address",
	49	"MAC address",
	50	#endif
	51	};
267541f7 JH	52	static const char * const env_flags_varaccess_names[] = {
	53	"any",
	54	"read-only",
	55	"write-once",
	56	"change-default",
	57	};
fffad71b JH	58
	59	/*
	60	* Print the whole list of available type flags.
	61	*/
	62	void env_flags_print_vartypes(void)
	63	{
	64	enum env_flags_vartype curtype = (enum env_flags_vartype)0;
	65
	66	while (curtype != env_flags_vartype_end) {
	67	printf("\t%c -\t%s\n", env_flags_vartype_rep[curtype],
	68	env_flags_vartype_names[curtype]);
	69	curtype++;
	70	}
	71	}
	72
267541f7 JH	73	/*
	74	* Print the whole list of available access flags.
	75	*/
	76	void env_flags_print_varaccess(void)
	77	{
	78	enum env_flags_varaccess curaccess = (enum env_flags_varaccess)0;
	79
	80	while (curaccess != env_flags_varaccess_end) {
	81	printf("\t%c -\t%s\n", env_flags_varaccess_rep[curaccess],
	82	env_flags_varaccess_names[curaccess]);
	83	curaccess++;
	84	}
	85	}
	86
fffad71b JH	87	/*
	88	* Return the name of the type.
	89	*/
	90	const char *env_flags_get_vartype_name(enum env_flags_vartype type)
	91	{
	92	return env_flags_vartype_names[type];
	93	}
267541f7 JH	94
	95	/*
	96	* Return the name of the access.
	97	*/
	98	const char *env_flags_get_varaccess_name(enum env_flags_varaccess access)
	99	{
	100	return env_flags_varaccess_names[access];
	101	}
fffad71b	102	#endif /* CONFIG_CMD_ENV_FLAGS */
2598090b JH	103
	104	/*
	105	* Parse the flags string from a .flags attribute list into the vartype enum.
	106	*/
	107	enum env_flags_vartype env_flags_parse_vartype(const char *flags)
	108	{
	109	char *type;
	110
	111	if (strlen(flags) <= ENV_FLAGS_VARTYPE_LOC)
	112	return env_flags_vartype_string;
	113
	114	type = strchr(env_flags_vartype_rep,
	115	flags[ENV_FLAGS_VARTYPE_LOC]);
	116
	117	if (type != NULL)
	118	return (enum env_flags_vartype)
	119	(type - &env_flags_vartype_rep[0]);
	120
	121	printf("## Warning: Unknown environment variable type '%c'\n",
	122	flags[ENV_FLAGS_VARTYPE_LOC]);
	123	return env_flags_vartype_string;
	124	}
	125
267541f7 JH	126	/*
	127	* Parse the flags string from a .flags attribute list into the varaccess enum.
	128	*/
	129	enum env_flags_varaccess env_flags_parse_varaccess(const char *flags)
	130	{
	131	char *access;
	132
	133	if (strlen(flags) <= ENV_FLAGS_VARACCESS_LOC)
	134	return env_flags_varaccess_any;
	135
	136	access = strchr(env_flags_varaccess_rep,
	137	flags[ENV_FLAGS_VARACCESS_LOC]);
	138
	139	if (access != NULL)
	140	return (enum env_flags_varaccess)
	141	(access - &env_flags_varaccess_rep[0]);
	142
	143	printf("## Warning: Unknown environment variable access method '%c'\n",
	144	flags[ENV_FLAGS_VARACCESS_LOC]);
	145	return env_flags_varaccess_any;
	146	}
	147
	148	/*
	149	* Parse the binary flags from a hash table entry into the varaccess enum.
	150	*/
	151	enum env_flags_varaccess env_flags_parse_varaccess_from_binflags(int binflags)
	152	{
	153	int i;
	154
db18f548	155	for (i = 0; i < ARRAY_SIZE(env_flags_varaccess_mask); i++)
267541f7 JH	156	if (env_flags_varaccess_mask[i] ==
	157	(binflags & ENV_FLAGS_VARACCESS_BIN_MASK))
	158	return (enum env_flags_varaccess)i;
	159
	160	printf("Warning: Non-standard access flags. (0x%x)\n",
	161	binflags & ENV_FLAGS_VARACCESS_BIN_MASK);
	162
	163	return env_flags_varaccess_any;
	164	}
	165
2598090b JH	166	static inline int is_hex_prefix(const char *value)
	167	{
	168	return value[0] == '0' && (value[1] == 'x' \|\| value[1] == 'X');
	169	}
	170
	171	static void skip_num(int hex, const char value, const char *end,
	172	int max_digits)
	173	{
	174	int i;
	175
	176	if (hex && is_hex_prefix(value))
	177	value += 2;
	178
	179	for (i = max_digits; i != 0; i--) {
	180	if (hex && !isxdigit(*value))
	181	break;
	182	if (!hex && !isdigit(*value))
	183	break;
	184	value++;
	185	}
	186	if (end != NULL)
	187	*end = value;
	188	}
	189
0118e83b CC	190	#ifdef CONFIG_CMD_NET
	191	int eth_validate_ethaddr_str(const char *addr)
	192	{
	193	const char *end;
	194	const char *cur;
	195	int i;
	196
	197	cur = addr;
	198	for (i = 0; i < 6; i++) {
	199	skip_num(1, cur, &end, 2);
	200	if (cur == end)
	201	return -1;
	202	if (cur + 2 == end && is_hex_prefix(cur))
	203	return -1;
	204	if (i != 5 && *end != ':')
	205	return -1;
	206	if (i == 5 && *end != '\0')
	207	return -1;
	208	cur = end + 1;
	209	}
	210
	211	return 0;
	212	}
	213	#endif
	214
2598090b JH	215	/*
	216	* Based on the declared type enum, validate that the value string complies
	217	* with that format
	218	*/
	219	static int _env_flags_validate_type(const char *value,
	220	enum env_flags_vartype type)
	221	{
	222	const char *end;
	223	#ifdef CONFIG_CMD_NET
	224	const char *cur;
	225	int i;
	226	#endif
	227
	228	switch (type) {
	229	case env_flags_vartype_string:
	230	break;
	231	case env_flags_vartype_decimal:
	232	skip_num(0, value, &end, -1);
	233	if (*end != '\0')
	234	return -1;
	235	break;
	236	case env_flags_vartype_hex:
	237	skip_num(1, value, &end, -1);
	238	if (*end != '\0')
	239	return -1;
	240	if (value + 2 == end && is_hex_prefix(value))
	241	return -1;
	242	break;
	243	case env_flags_vartype_bool:
	244	if (value[0] != '1' && value[0] != 'y' && value[0] != 't' &&
	245	value[0] != 'Y' && value[0] != 'T' &&
	246	value[0] != '0' && value[0] != 'n' && value[0] != 'f' &&
	247	value[0] != 'N' && value[0] != 'F')
	248	return -1;
	249	if (value[1] != '\0')
	250	return -1;
	251	break;
	252	#ifdef CONFIG_CMD_NET
	253	case env_flags_vartype_ipaddr:
	254	cur = value;
	255	for (i = 0; i < 4; i++) {
	256	skip_num(0, cur, &end, 3);
	257	if (cur == end)
	258	return -1;
	259	if (i != 3 && *end != '.')
	260	return -1;
	261	if (i == 3 && *end != '\0')
	262	return -1;
	263	cur = end + 1;
	264	}
	265	break;
	266	case env_flags_vartype_macaddr:
0118e83b CC	267	if (eth_validate_ethaddr_str(value))
0118e83b CC	268	return -1;
2598090b JH	269	break;
	270	#endif
	271	case env_flags_vartype_end:
	272	return -1;
	273	}
	274
	275	/* OK */
	276	return 0;
	277	}
	278
	279	/*
	280	* Look for flags in a provided list and failing that the static list
	281	*/
	282	static inline int env_flags_lookup(const char flags_list, const char name,
	283	char *flags)
	284	{
	285	int ret = 1;
	286
	287	if (!flags)
	288	/* bad parameter */
	289	return -1;
	290
	291	/* try the env first */
	292	if (flags_list)
	293	ret = env_attr_lookup(flags_list, name, flags);
	294
	295	if (ret != 0)
	296	/* if not found in the env, look in the static list */
	297	ret = env_attr_lookup(ENV_FLAGS_LIST_STATIC, name, flags);
	298
	299	return ret;
	300	}
	301
30fd4fad JH	302	#ifdef USE_HOSTCC /* Functions only used from tools/env */
	303	/*
	304	* Look up any flags directly from the .flags variable and the static list
	305	* and convert them to the vartype enum.
	306	*/
	307	enum env_flags_vartype env_flags_get_type(const char *name)
	308	{
	309	const char *flags_list = getenv(ENV_FLAGS_VAR);
	310	char flags[ENV_FLAGS_ATTR_MAX_LEN + 1];
	311
	312	if (env_flags_lookup(flags_list, name, flags))
	313	return env_flags_vartype_string;
	314
	315	if (strlen(flags) <= ENV_FLAGS_VARTYPE_LOC)
	316	return env_flags_vartype_string;
	317
	318	return env_flags_parse_vartype(flags);
	319	}
	320
267541f7 JH	321	/*
	322	* Look up the access of a variable directly from the .flags var.
	323	*/
	324	enum env_flags_varaccess env_flags_get_varaccess(const char *name)
	325	{
	326	const char *flags_list = getenv(ENV_FLAGS_VAR);
	327	char flags[ENV_FLAGS_ATTR_MAX_LEN + 1];
	328
	329	if (env_flags_lookup(flags_list, name, flags))
	330	return env_flags_varaccess_any;
	331
	332	if (strlen(flags) <= ENV_FLAGS_VARACCESS_LOC)
	333	return env_flags_varaccess_any;
	334
	335	return env_flags_parse_varaccess(flags);
	336	}
	337
30fd4fad JH	338	/*
	339	* Validate that the proposed new value for "name" is valid according to the
	340	* defined flags for that variable, if any.
	341	*/
	342	int env_flags_validate_type(const char name, const char value)
	343	{
	344	enum env_flags_vartype type;
	345
	346	if (value == NULL)
	347	return 0;
	348	type = env_flags_get_type(name);
	349	if (_env_flags_validate_type(value, type) < 0) {
	350	printf("## Error: flags type check failure for "
	351	"\"%s\" <= \"%s\" (type: %c)\n",
	352	name, value, env_flags_vartype_rep[type]);
	353	return -1;
	354	}
	355	return 0;
	356	}
	357
267541f7 JH	358	/*
	359	* Validate that the proposed access to variable "name" is valid according to
	360	* the defined flags for that variable, if any.
	361	*/
	362	int env_flags_validate_varaccess(const char *name, int check_mask)
	363	{
	364	enum env_flags_varaccess access;
	365	int access_mask;
	366
	367	access = env_flags_get_varaccess(name);
	368	access_mask = env_flags_varaccess_mask[access];
	369
	370	return (check_mask & access_mask) != 0;
	371	}
	372
30fd4fad JH	373	/*
	374	* Validate the parameters to "env set" directly
	375	*/
	376	int env_flags_validate_env_set_params(int argc, char * const argv[])
	377	{
	378	if ((argc >= 3) && argv[2] != NULL) {
	379	enum env_flags_vartype type = env_flags_get_type(argv[1]);
	380
	381	/*
	382	* we don't currently check types that need more than
	383	* one argument
	384	*/
	385	if (type != env_flags_vartype_string && argc > 3) {
	386	printf("## Error: too many parameters for setting "
	387	"\"%s\"\n", argv[1]);
	388	return -1;
	389	}
	390	return env_flags_validate_type(argv[1], argv[2]);
	391	}
	392	/* ok */
	393	return 0;
	394	}
	395
	396	#else /* !USE_HOSTCC - Functions only used from lib/hashtable.c */
	397
2598090b JH	398	/*
	399	* Parse the flag charachters from the .flags attribute list into the binary
	400	* form to be stored in the environment entry->flags field.
	401	*/
	402	static int env_parse_flags_to_bin(const char *flags)
	403	{
267541f7 JH	404	int binflags;
	405
	406	binflags = env_flags_parse_vartype(flags) & ENV_FLAGS_VARTYPE_BIN_MASK;
	407	binflags \|= env_flags_varaccess_mask[env_flags_parse_varaccess(flags)];
	408
	409	return binflags;
2598090b JH	410	}
2598090b JH	411
1b610271 HS	412	static int first_call = 1;
	413	static const char *flags_list;
	414
2598090b JH	415	/*
	416	* Look for possible flags for a newly added variable
	417	* This is called specifically when the variable did not exist in the hash
	418	* previously, so the blanket update did not find this variable.
	419	*/
	420	void env_flags_init(ENTRY *var_entry)
	421	{
	422	const char *var_name = var_entry->key;
2598090b JH	423	char flags[ENV_FLAGS_ATTR_MAX_LEN + 1] = "";
	424	int ret = 1;
	425
1b610271 HS	426	if (first_call) {
	427	flags_list = getenv(ENV_FLAGS_VAR);
	428	first_call = 0;
	429	}
2598090b JH	430	/* look in the ".flags" and static for a reference to this variable */
	431	ret = env_flags_lookup(flags_list, var_name, flags);
	432
	433	/* if any flags were found, set the binary form to the entry */
	434	if (!ret && strlen(flags))
	435	var_entry->flags = env_parse_flags_to_bin(flags);
	436	}
	437
	438	/*
	439	* Called on each existing env var prior to the blanket update since removing
	440	* a flag in the flag list should remove its flags.
	441	*/
	442	static int clear_flags(ENTRY *entry)
	443	{
	444	entry->flags = 0;
	445
	446	return 0;
	447	}
	448
	449	/*
	450	* Call for each element in the list that defines flags for a variable
	451	*/
cca98fd6	452	static int set_flags(const char name, const char value, void *priv)
2598090b JH	453	{
	454	ENTRY e, *ep;
	455
	456	e.key = name;
	457	e.data = NULL;
5a689439	458	e.callback = NULL;
2598090b JH	459	hsearch_r(e, FIND, &ep, &env_htab, 0);
	460
	461	/* does the env variable actually exist? */
	462	if (ep != NULL) {
	463	/* the flag list is empty, so clear the flags */
	464	if (value == NULL \|\| strlen(value) == 0)
	465	ep->flags = 0;
	466	else
	467	/* assign the requested flags */
	468	ep->flags = env_parse_flags_to_bin(value);
	469	}
	470
	471	return 0;
	472	}
	473
	474	static int on_flags(const char name, const char value, enum env_op op,
	475	int flags)
	476	{
	477	/* remove all flags */
	478	hwalk_r(&env_htab, clear_flags);
	479
	480	/* configure any static flags */
cca98fd6	481	env_attr_walk(ENV_FLAGS_LIST_STATIC, set_flags, NULL);
2598090b	482	/* configure any dynamic flags */
cca98fd6	483	env_attr_walk(value, set_flags, NULL);
2598090b JH	484
	485	return 0;
	486	}
	487	U_BOOT_ENV_CALLBACK(flags, on_flags);
	488
	489	/*
	490	* Perform consistency checking before creating, overwriting, or deleting an
	491	* environment variable. Called as a callback function by hsearch_r() and
	492	* hdelete_r(). Returns 0 in case of success, 1 in case of failure.
	493	* When (flag & H_FORCE) is set, do not print out any error message and force
	494	* overwriting of write-once variables.
	495	*/
	496
	497	int env_flags_validate(const ENTRY item, const char newval, enum env_op op,
	498	int flag)
	499	{
	500	const char *name;
2598090b JH	501	const char *oldval = NULL;
	502
	503	if (op != env_op_create)
	504	oldval = item->data;
2598090b JH	505
	506	name = item->key;
	507
	508	/* Default value for NULL to protect string-manipulating functions */
	509	newval = newval ? : "";
	510
2598090b JH	511	/* validate the value to match the variable type */
	512	if (op != env_op_delete) {
	513	enum env_flags_vartype type = (enum env_flags_vartype)
	514	(ENV_FLAGS_VARTYPE_BIN_MASK & item->flags);
	515
	516	if (_env_flags_validate_type(newval, type) < 0) {
	517	printf("## Error: flags type check failure for "
	518	"\"%s\" <= \"%s\" (type: %c)\n",
	519	name, newval, env_flags_vartype_rep[type]);
	520	return -1;
	521	}
	522	}
	523
267541f7 JH	524	/* check for access permission */
	525	#ifndef CONFIG_ENV_ACCESS_IGNORE_FORCE
	526	if (flag & H_FORCE)
	527	return 0;
	528	#endif
	529	switch (op) {
	530	case env_op_delete:
	531	if (item->flags & ENV_FLAGS_VARACCESS_PREVENT_DELETE) {
	532	printf("## Error: Can't delete \"%s\"\n", name);
	533	return 1;
	534	}
	535	break;
	536	case env_op_overwrite:
	537	if (item->flags & ENV_FLAGS_VARACCESS_PREVENT_OVERWR) {
	538	printf("## Error: Can't overwrite \"%s\"\n", name);
	539	return 1;
	540	} else if (item->flags &
	541	ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR) {
	542	const char *defval = getenv_default(name);
	543
	544	if (defval == NULL)
	545	defval = "";
	546	printf("oldval: %s defval: %s\n", oldval, defval);
	547	if (strcmp(oldval, defval) != 0) {
	548	printf("## Error: Can't overwrite \"%s\"\n",
	549	name);
	550	return 1;
	551	}
	552	}
	553	break;
	554	case env_op_create:
	555	if (item->flags & ENV_FLAGS_VARACCESS_PREVENT_CREATE) {
	556	printf("## Error: Can't create \"%s\"\n", name);
	557	return 1;
	558	}
	559	break;
	560	}
	561
2598090b JH	562	return 0;
2598090b JH	563	}
30fd4fad JH	564
30fd4fad JH	565	#endif