xref: /openbmc/linux/lib/bootconfig.c (revision 7b7fd0ac7dc1ffcaf24d9bca0f051b0168e43cd4)
176db5a27SMasami Hiramatsu // SPDX-License-Identifier: GPL-2.0
276db5a27SMasami Hiramatsu /*
376db5a27SMasami Hiramatsu  * Extra Boot Config
476db5a27SMasami Hiramatsu  * Masami Hiramatsu <mhiramat@kernel.org>
576db5a27SMasami Hiramatsu  */
676db5a27SMasami Hiramatsu 
74ee1b4caSMasami Hiramatsu #ifdef __KERNEL__
8a91e4f12SMasami Hiramatsu #include <linux/bootconfig.h>
976db5a27SMasami Hiramatsu #include <linux/bug.h>
1076db5a27SMasami Hiramatsu #include <linux/ctype.h>
1176db5a27SMasami Hiramatsu #include <linux/errno.h>
1276db5a27SMasami Hiramatsu #include <linux/kernel.h>
13a91e4f12SMasami Hiramatsu #include <linux/memblock.h>
1476db5a27SMasami Hiramatsu #include <linux/string.h>
15a2a9d67aSMasami Hiramatsu 
16a2a9d67aSMasami Hiramatsu #ifdef CONFIG_BOOT_CONFIG_EMBED
17a2a9d67aSMasami Hiramatsu /* embedded_bootconfig_data is defined in bootconfig-data.S */
18a2a9d67aSMasami Hiramatsu extern __visible const char embedded_bootconfig_data[];
19a2a9d67aSMasami Hiramatsu extern __visible const char embedded_bootconfig_data_end[];
20a2a9d67aSMasami Hiramatsu 
xbc_get_embedded_bootconfig(size_t * size)21a2a9d67aSMasami Hiramatsu const char * __init xbc_get_embedded_bootconfig(size_t *size)
22a2a9d67aSMasami Hiramatsu {
23a2a9d67aSMasami Hiramatsu 	*size = embedded_bootconfig_data_end - embedded_bootconfig_data;
24a2a9d67aSMasami Hiramatsu 	return (*size) ? embedded_bootconfig_data : NULL;
25a2a9d67aSMasami Hiramatsu }
26a2a9d67aSMasami Hiramatsu #endif
27a2a9d67aSMasami Hiramatsu 
284ee1b4caSMasami Hiramatsu #else /* !__KERNEL__ */
294ee1b4caSMasami Hiramatsu /*
304ee1b4caSMasami Hiramatsu  * NOTE: This is only for tools/bootconfig, because tools/bootconfig will
314ee1b4caSMasami Hiramatsu  * run the parser sanity test.
324ee1b4caSMasami Hiramatsu  * This does NOT mean lib/bootconfig.c is available in the user space.
334ee1b4caSMasami Hiramatsu  * However, if you change this file, please make sure the tools/bootconfig
344ee1b4caSMasami Hiramatsu  * has no issue on building and running.
354ee1b4caSMasami Hiramatsu  */
364ee1b4caSMasami Hiramatsu #include <linux/bootconfig.h>
374ee1b4caSMasami Hiramatsu #endif
3876db5a27SMasami Hiramatsu 
3976db5a27SMasami Hiramatsu /*
4076db5a27SMasami Hiramatsu  * Extra Boot Config (XBC) is given as tree-structured ascii text of
4176db5a27SMasami Hiramatsu  * key-value pairs on memory.
4276db5a27SMasami Hiramatsu  * xbc_parse() parses the text to build a simple tree. Each tree node is
4376db5a27SMasami Hiramatsu  * simply a key word or a value. A key node may have a next key node or/and
4476db5a27SMasami Hiramatsu  * a child node (both key and value). A value node may have a next value
4576db5a27SMasami Hiramatsu  * node (for array).
4676db5a27SMasami Hiramatsu  */
4776db5a27SMasami Hiramatsu 
48a91e4f12SMasami Hiramatsu static struct xbc_node *xbc_nodes __initdata;
4976db5a27SMasami Hiramatsu static int xbc_node_num __initdata;
5076db5a27SMasami Hiramatsu static char *xbc_data __initdata;
5176db5a27SMasami Hiramatsu static size_t xbc_data_size __initdata;
5276db5a27SMasami Hiramatsu static struct xbc_node *last_parent __initdata;
5389b74cacSMasami Hiramatsu static const char *xbc_err_msg __initdata;
5489b74cacSMasami Hiramatsu static int xbc_err_pos __initdata;
55ead1e19aSMasami Hiramatsu static int open_brace[XBC_DEPTH_MAX] __initdata;
56ead1e19aSMasami Hiramatsu static int brace_index __initdata;
5776db5a27SMasami Hiramatsu 
584ee1b4caSMasami Hiramatsu #ifdef __KERNEL__
xbc_alloc_mem(size_t size)594d1c92a4SMasami Hiramatsu static inline void * __init xbc_alloc_mem(size_t size)
604ee1b4caSMasami Hiramatsu {
614ee1b4caSMasami Hiramatsu 	return memblock_alloc(size, SMP_CACHE_BYTES);
624ee1b4caSMasami Hiramatsu }
634ee1b4caSMasami Hiramatsu 
xbc_free_mem(void * addr,size_t size,bool early)64e46d3be7SQiang Zhang static inline void __init xbc_free_mem(void *addr, size_t size, bool early)
654ee1b4caSMasami Hiramatsu {
66e46d3be7SQiang Zhang 	if (early)
67512b7931SLinus Torvalds 		memblock_free(addr, size);
68e46d3be7SQiang Zhang 	else if (addr)
69e46d3be7SQiang Zhang 		memblock_free_late(__pa(addr), size);
704ee1b4caSMasami Hiramatsu }
714ee1b4caSMasami Hiramatsu 
724ee1b4caSMasami Hiramatsu #else /* !__KERNEL__ */
734ee1b4caSMasami Hiramatsu 
xbc_alloc_mem(size_t size)744ee1b4caSMasami Hiramatsu static inline void *xbc_alloc_mem(size_t size)
754ee1b4caSMasami Hiramatsu {
764ee1b4caSMasami Hiramatsu 	return malloc(size);
774ee1b4caSMasami Hiramatsu }
784ee1b4caSMasami Hiramatsu 
xbc_free_mem(void * addr,size_t size,bool early)79e46d3be7SQiang Zhang static inline void xbc_free_mem(void *addr, size_t size, bool early)
804ee1b4caSMasami Hiramatsu {
814ee1b4caSMasami Hiramatsu 	free(addr);
824ee1b4caSMasami Hiramatsu }
834ee1b4caSMasami Hiramatsu #endif
84e306220cSMasami Hiramatsu /**
85e306220cSMasami Hiramatsu  * xbc_get_info() - Get the information of loaded boot config
86010db091SMasami Hiramatsu  * @node_size: A pointer to store the number of nodes.
87010db091SMasami Hiramatsu  * @data_size: A pointer to store the size of bootconfig data.
88e306220cSMasami Hiramatsu  *
89e306220cSMasami Hiramatsu  * Get the number of used nodes in @node_size if it is not NULL,
90e306220cSMasami Hiramatsu  * and the size of bootconfig data in @data_size if it is not NULL.
91e306220cSMasami Hiramatsu  * Return 0 if the boot config is initialized, or return -ENODEV.
92e306220cSMasami Hiramatsu  */
xbc_get_info(int * node_size,size_t * data_size)93e306220cSMasami Hiramatsu int __init xbc_get_info(int *node_size, size_t *data_size)
94e306220cSMasami Hiramatsu {
95e306220cSMasami Hiramatsu 	if (!xbc_data)
96e306220cSMasami Hiramatsu 		return -ENODEV;
97e306220cSMasami Hiramatsu 
98e306220cSMasami Hiramatsu 	if (node_size)
99e306220cSMasami Hiramatsu 		*node_size = xbc_node_num;
100e306220cSMasami Hiramatsu 	if (data_size)
101e306220cSMasami Hiramatsu 		*data_size = xbc_data_size;
102e306220cSMasami Hiramatsu 	return 0;
103e306220cSMasami Hiramatsu }
104e306220cSMasami Hiramatsu 
xbc_parse_error(const char * msg,const char * p)10576db5a27SMasami Hiramatsu static int __init xbc_parse_error(const char *msg, const char *p)
10676db5a27SMasami Hiramatsu {
10789b74cacSMasami Hiramatsu 	xbc_err_msg = msg;
10889b74cacSMasami Hiramatsu 	xbc_err_pos = (int)(p - xbc_data);
10976db5a27SMasami Hiramatsu 
11076db5a27SMasami Hiramatsu 	return -EINVAL;
11176db5a27SMasami Hiramatsu }
11276db5a27SMasami Hiramatsu 
11376db5a27SMasami Hiramatsu /**
11476db5a27SMasami Hiramatsu  * xbc_root_node() - Get the root node of extended boot config
11576db5a27SMasami Hiramatsu  *
11676db5a27SMasami Hiramatsu  * Return the address of root node of extended boot config. If the
11776db5a27SMasami Hiramatsu  * extended boot config is not initiized, return NULL.
11876db5a27SMasami Hiramatsu  */
xbc_root_node(void)11976db5a27SMasami Hiramatsu struct xbc_node * __init xbc_root_node(void)
12076db5a27SMasami Hiramatsu {
12176db5a27SMasami Hiramatsu 	if (unlikely(!xbc_data))
12276db5a27SMasami Hiramatsu 		return NULL;
12376db5a27SMasami Hiramatsu 
12476db5a27SMasami Hiramatsu 	return xbc_nodes;
12576db5a27SMasami Hiramatsu }
12676db5a27SMasami Hiramatsu 
12776db5a27SMasami Hiramatsu /**
12876db5a27SMasami Hiramatsu  * xbc_node_index() - Get the index of XBC node
12976db5a27SMasami Hiramatsu  * @node: A target node of getting index.
13076db5a27SMasami Hiramatsu  *
13176db5a27SMasami Hiramatsu  * Return the index number of @node in XBC node list.
13276db5a27SMasami Hiramatsu  */
xbc_node_index(struct xbc_node * node)13376db5a27SMasami Hiramatsu int __init xbc_node_index(struct xbc_node *node)
13476db5a27SMasami Hiramatsu {
13576db5a27SMasami Hiramatsu 	return node - &xbc_nodes[0];
13676db5a27SMasami Hiramatsu }
13776db5a27SMasami Hiramatsu 
13876db5a27SMasami Hiramatsu /**
13976db5a27SMasami Hiramatsu  * xbc_node_get_parent() - Get the parent XBC node
14076db5a27SMasami Hiramatsu  * @node: An XBC node.
14176db5a27SMasami Hiramatsu  *
14276db5a27SMasami Hiramatsu  * Return the parent node of @node. If the node is top node of the tree,
14376db5a27SMasami Hiramatsu  * return NULL.
14476db5a27SMasami Hiramatsu  */
xbc_node_get_parent(struct xbc_node * node)14576db5a27SMasami Hiramatsu struct xbc_node * __init xbc_node_get_parent(struct xbc_node *node)
14676db5a27SMasami Hiramatsu {
14776db5a27SMasami Hiramatsu 	return node->parent == XBC_NODE_MAX ? NULL : &xbc_nodes[node->parent];
14876db5a27SMasami Hiramatsu }
14976db5a27SMasami Hiramatsu 
15076db5a27SMasami Hiramatsu /**
15176db5a27SMasami Hiramatsu  * xbc_node_get_child() - Get the child XBC node
15276db5a27SMasami Hiramatsu  * @node: An XBC node.
15376db5a27SMasami Hiramatsu  *
15476db5a27SMasami Hiramatsu  * Return the first child node of @node. If the node has no child, return
15576db5a27SMasami Hiramatsu  * NULL.
15676db5a27SMasami Hiramatsu  */
xbc_node_get_child(struct xbc_node * node)15776db5a27SMasami Hiramatsu struct xbc_node * __init xbc_node_get_child(struct xbc_node *node)
15876db5a27SMasami Hiramatsu {
15976db5a27SMasami Hiramatsu 	return node->child ? &xbc_nodes[node->child] : NULL;
16076db5a27SMasami Hiramatsu }
16176db5a27SMasami Hiramatsu 
16276db5a27SMasami Hiramatsu /**
16376db5a27SMasami Hiramatsu  * xbc_node_get_next() - Get the next sibling XBC node
16476db5a27SMasami Hiramatsu  * @node: An XBC node.
16576db5a27SMasami Hiramatsu  *
16676db5a27SMasami Hiramatsu  * Return the NEXT sibling node of @node. If the node has no next sibling,
16776db5a27SMasami Hiramatsu  * return NULL. Note that even if this returns NULL, it doesn't mean @node
16876db5a27SMasami Hiramatsu  * has no siblings. (You also has to check whether the parent's child node
16976db5a27SMasami Hiramatsu  * is @node or not.)
17076db5a27SMasami Hiramatsu  */
xbc_node_get_next(struct xbc_node * node)17176db5a27SMasami Hiramatsu struct xbc_node * __init xbc_node_get_next(struct xbc_node *node)
17276db5a27SMasami Hiramatsu {
17376db5a27SMasami Hiramatsu 	return node->next ? &xbc_nodes[node->next] : NULL;
17476db5a27SMasami Hiramatsu }
17576db5a27SMasami Hiramatsu 
17676db5a27SMasami Hiramatsu /**
17776db5a27SMasami Hiramatsu  * xbc_node_get_data() - Get the data of XBC node
17876db5a27SMasami Hiramatsu  * @node: An XBC node.
17976db5a27SMasami Hiramatsu  *
18076db5a27SMasami Hiramatsu  * Return the data (which is always a null terminated string) of @node.
18176db5a27SMasami Hiramatsu  * If the node has invalid data, warn and return NULL.
18276db5a27SMasami Hiramatsu  */
xbc_node_get_data(struct xbc_node * node)18376db5a27SMasami Hiramatsu const char * __init xbc_node_get_data(struct xbc_node *node)
18476db5a27SMasami Hiramatsu {
18576db5a27SMasami Hiramatsu 	int offset = node->data & ~XBC_VALUE;
18676db5a27SMasami Hiramatsu 
18776db5a27SMasami Hiramatsu 	if (WARN_ON(offset >= xbc_data_size))
18876db5a27SMasami Hiramatsu 		return NULL;
18976db5a27SMasami Hiramatsu 
19076db5a27SMasami Hiramatsu 	return xbc_data + offset;
19176db5a27SMasami Hiramatsu }
19276db5a27SMasami Hiramatsu 
19376db5a27SMasami Hiramatsu static bool __init
xbc_node_match_prefix(struct xbc_node * node,const char ** prefix)19476db5a27SMasami Hiramatsu xbc_node_match_prefix(struct xbc_node *node, const char **prefix)
19576db5a27SMasami Hiramatsu {
19676db5a27SMasami Hiramatsu 	const char *p = xbc_node_get_data(node);
19776db5a27SMasami Hiramatsu 	int len = strlen(p);
19876db5a27SMasami Hiramatsu 
19976db5a27SMasami Hiramatsu 	if (strncmp(*prefix, p, len))
20076db5a27SMasami Hiramatsu 		return false;
20176db5a27SMasami Hiramatsu 
20276db5a27SMasami Hiramatsu 	p = *prefix + len;
20376db5a27SMasami Hiramatsu 	if (*p == '.')
20476db5a27SMasami Hiramatsu 		p++;
20576db5a27SMasami Hiramatsu 	else if (*p != '\0')
20676db5a27SMasami Hiramatsu 		return false;
20776db5a27SMasami Hiramatsu 	*prefix = p;
20876db5a27SMasami Hiramatsu 
20976db5a27SMasami Hiramatsu 	return true;
21076db5a27SMasami Hiramatsu }
21176db5a27SMasami Hiramatsu 
21276db5a27SMasami Hiramatsu /**
2135dfe50b0SMasami Hiramatsu  * xbc_node_find_subkey() - Find a subkey node which matches given key
21476db5a27SMasami Hiramatsu  * @parent: An XBC node.
21576db5a27SMasami Hiramatsu  * @key: A key string.
21676db5a27SMasami Hiramatsu  *
2175dfe50b0SMasami Hiramatsu  * Search a key node under @parent which matches @key. The @key can contain
21876db5a27SMasami Hiramatsu  * several words jointed with '.'. If @parent is NULL, this searches the
21976db5a27SMasami Hiramatsu  * node from whole tree. Return NULL if no node is matched.
22076db5a27SMasami Hiramatsu  */
22176db5a27SMasami Hiramatsu struct xbc_node * __init
xbc_node_find_subkey(struct xbc_node * parent,const char * key)2225dfe50b0SMasami Hiramatsu xbc_node_find_subkey(struct xbc_node *parent, const char *key)
22376db5a27SMasami Hiramatsu {
22476db5a27SMasami Hiramatsu 	struct xbc_node *node;
22576db5a27SMasami Hiramatsu 
22676db5a27SMasami Hiramatsu 	if (parent)
227e5efaeb8SMasami Hiramatsu 		node = xbc_node_get_subkey(parent);
22876db5a27SMasami Hiramatsu 	else
22976db5a27SMasami Hiramatsu 		node = xbc_root_node();
23076db5a27SMasami Hiramatsu 
23176db5a27SMasami Hiramatsu 	while (node && xbc_node_is_key(node)) {
23276db5a27SMasami Hiramatsu 		if (!xbc_node_match_prefix(node, &key))
23376db5a27SMasami Hiramatsu 			node = xbc_node_get_next(node);
23476db5a27SMasami Hiramatsu 		else if (*key != '\0')
235e5efaeb8SMasami Hiramatsu 			node = xbc_node_get_subkey(node);
23676db5a27SMasami Hiramatsu 		else
23776db5a27SMasami Hiramatsu 			break;
23876db5a27SMasami Hiramatsu 	}
23976db5a27SMasami Hiramatsu 
24076db5a27SMasami Hiramatsu 	return node;
24176db5a27SMasami Hiramatsu }
24276db5a27SMasami Hiramatsu 
24376db5a27SMasami Hiramatsu /**
24476db5a27SMasami Hiramatsu  * xbc_node_find_value() - Find a value node which matches given key
24576db5a27SMasami Hiramatsu  * @parent: An XBC node.
24676db5a27SMasami Hiramatsu  * @key: A key string.
24776db5a27SMasami Hiramatsu  * @vnode: A container pointer of found XBC node.
24876db5a27SMasami Hiramatsu  *
24976db5a27SMasami Hiramatsu  * Search a value node under @parent whose (parent) key node matches @key,
25076db5a27SMasami Hiramatsu  * store it in *@vnode, and returns the value string.
25176db5a27SMasami Hiramatsu  * The @key can contain several words jointed with '.'. If @parent is NULL,
25276db5a27SMasami Hiramatsu  * this searches the node from whole tree. Return the value string if a
25376db5a27SMasami Hiramatsu  * matched key found, return NULL if no node is matched.
25476db5a27SMasami Hiramatsu  * Note that this returns 0-length string and stores NULL in *@vnode if the
25576db5a27SMasami Hiramatsu  * key has no value. And also it will return the value of the first entry if
25676db5a27SMasami Hiramatsu  * the value is an array.
25776db5a27SMasami Hiramatsu  */
25876db5a27SMasami Hiramatsu const char * __init
xbc_node_find_value(struct xbc_node * parent,const char * key,struct xbc_node ** vnode)25976db5a27SMasami Hiramatsu xbc_node_find_value(struct xbc_node *parent, const char *key,
26076db5a27SMasami Hiramatsu 		    struct xbc_node **vnode)
26176db5a27SMasami Hiramatsu {
2625dfe50b0SMasami Hiramatsu 	struct xbc_node *node = xbc_node_find_subkey(parent, key);
26376db5a27SMasami Hiramatsu 
26476db5a27SMasami Hiramatsu 	if (!node || !xbc_node_is_key(node))
26576db5a27SMasami Hiramatsu 		return NULL;
26676db5a27SMasami Hiramatsu 
26776db5a27SMasami Hiramatsu 	node = xbc_node_get_child(node);
26876db5a27SMasami Hiramatsu 	if (node && !xbc_node_is_value(node))
26976db5a27SMasami Hiramatsu 		return NULL;
27076db5a27SMasami Hiramatsu 
27176db5a27SMasami Hiramatsu 	if (vnode)
27276db5a27SMasami Hiramatsu 		*vnode = node;
27376db5a27SMasami Hiramatsu 
27476db5a27SMasami Hiramatsu 	return node ? xbc_node_get_data(node) : "";
27576db5a27SMasami Hiramatsu }
27676db5a27SMasami Hiramatsu 
27776db5a27SMasami Hiramatsu /**
27876db5a27SMasami Hiramatsu  * xbc_node_compose_key_after() - Compose partial key string of the XBC node
27976db5a27SMasami Hiramatsu  * @root: Root XBC node
28076db5a27SMasami Hiramatsu  * @node: Target XBC node.
28176db5a27SMasami Hiramatsu  * @buf: A buffer to store the key.
28276db5a27SMasami Hiramatsu  * @size: The size of the @buf.
28376db5a27SMasami Hiramatsu  *
28476db5a27SMasami Hiramatsu  * Compose the partial key of the @node into @buf, which is starting right
28576db5a27SMasami Hiramatsu  * after @root (@root is not included.) If @root is NULL, this returns full
28676db5a27SMasami Hiramatsu  * key words of @node.
28776db5a27SMasami Hiramatsu  * Returns the total length of the key stored in @buf. Returns -EINVAL
28876db5a27SMasami Hiramatsu  * if @node is NULL or @root is not the ancestor of @node or @root is @node,
28976db5a27SMasami Hiramatsu  * or returns -ERANGE if the key depth is deeper than max depth.
29076db5a27SMasami Hiramatsu  * This is expected to be used with xbc_find_node() to list up all (child)
29176db5a27SMasami Hiramatsu  * keys under given key.
29276db5a27SMasami Hiramatsu  */
xbc_node_compose_key_after(struct xbc_node * root,struct xbc_node * node,char * buf,size_t size)29376db5a27SMasami Hiramatsu int __init xbc_node_compose_key_after(struct xbc_node *root,
29476db5a27SMasami Hiramatsu 				      struct xbc_node *node,
29576db5a27SMasami Hiramatsu 				      char *buf, size_t size)
29676db5a27SMasami Hiramatsu {
2974f292c48SMasami Hiramatsu 	uint16_t keys[XBC_DEPTH_MAX];
29876db5a27SMasami Hiramatsu 	int depth = 0, ret = 0, total = 0;
29976db5a27SMasami Hiramatsu 
30076db5a27SMasami Hiramatsu 	if (!node || node == root)
30176db5a27SMasami Hiramatsu 		return -EINVAL;
30276db5a27SMasami Hiramatsu 
30376db5a27SMasami Hiramatsu 	if (xbc_node_is_value(node))
30476db5a27SMasami Hiramatsu 		node = xbc_node_get_parent(node);
30576db5a27SMasami Hiramatsu 
30676db5a27SMasami Hiramatsu 	while (node && node != root) {
30776db5a27SMasami Hiramatsu 		keys[depth++] = xbc_node_index(node);
30876db5a27SMasami Hiramatsu 		if (depth == XBC_DEPTH_MAX)
30976db5a27SMasami Hiramatsu 			return -ERANGE;
31076db5a27SMasami Hiramatsu 		node = xbc_node_get_parent(node);
31176db5a27SMasami Hiramatsu 	}
31276db5a27SMasami Hiramatsu 	if (!node && root)
31376db5a27SMasami Hiramatsu 		return -EINVAL;
31476db5a27SMasami Hiramatsu 
31576db5a27SMasami Hiramatsu 	while (--depth >= 0) {
31676db5a27SMasami Hiramatsu 		node = xbc_nodes + keys[depth];
31776db5a27SMasami Hiramatsu 		ret = snprintf(buf, size, "%s%s", xbc_node_get_data(node),
31876db5a27SMasami Hiramatsu 			       depth ? "." : "");
31976db5a27SMasami Hiramatsu 		if (ret < 0)
32076db5a27SMasami Hiramatsu 			return ret;
32176db5a27SMasami Hiramatsu 		if (ret > size) {
32276db5a27SMasami Hiramatsu 			size = 0;
32376db5a27SMasami Hiramatsu 		} else {
32476db5a27SMasami Hiramatsu 			size -= ret;
32576db5a27SMasami Hiramatsu 			buf += ret;
32676db5a27SMasami Hiramatsu 		}
32776db5a27SMasami Hiramatsu 		total += ret;
32876db5a27SMasami Hiramatsu 	}
32976db5a27SMasami Hiramatsu 
33076db5a27SMasami Hiramatsu 	return total;
33176db5a27SMasami Hiramatsu }
33276db5a27SMasami Hiramatsu 
33376db5a27SMasami Hiramatsu /**
33476db5a27SMasami Hiramatsu  * xbc_node_find_next_leaf() - Find the next leaf node under given node
33576db5a27SMasami Hiramatsu  * @root: An XBC root node
33676db5a27SMasami Hiramatsu  * @node: An XBC node which starts from.
33776db5a27SMasami Hiramatsu  *
33876db5a27SMasami Hiramatsu  * Search the next leaf node (which means the terminal key node) of @node
33976db5a27SMasami Hiramatsu  * under @root node (including @root node itself).
34076db5a27SMasami Hiramatsu  * Return the next node or NULL if next leaf node is not found.
34176db5a27SMasami Hiramatsu  */
xbc_node_find_next_leaf(struct xbc_node * root,struct xbc_node * node)34276db5a27SMasami Hiramatsu struct xbc_node * __init xbc_node_find_next_leaf(struct xbc_node *root,
34376db5a27SMasami Hiramatsu 						 struct xbc_node *node)
34476db5a27SMasami Hiramatsu {
345e5efaeb8SMasami Hiramatsu 	struct xbc_node *next;
346e5efaeb8SMasami Hiramatsu 
34776db5a27SMasami Hiramatsu 	if (unlikely(!xbc_data))
34876db5a27SMasami Hiramatsu 		return NULL;
34976db5a27SMasami Hiramatsu 
35076db5a27SMasami Hiramatsu 	if (!node) {	/* First try */
35176db5a27SMasami Hiramatsu 		node = root;
35276db5a27SMasami Hiramatsu 		if (!node)
35376db5a27SMasami Hiramatsu 			node = xbc_nodes;
35476db5a27SMasami Hiramatsu 	} else {
355e5efaeb8SMasami Hiramatsu 		/* Leaf node may have a subkey */
356e5efaeb8SMasami Hiramatsu 		next = xbc_node_get_subkey(node);
357e5efaeb8SMasami Hiramatsu 		if (next) {
358e5efaeb8SMasami Hiramatsu 			node = next;
359e5efaeb8SMasami Hiramatsu 			goto found;
360e5efaeb8SMasami Hiramatsu 		}
361e5efaeb8SMasami Hiramatsu 
36276db5a27SMasami Hiramatsu 		if (node == root)	/* @root was a leaf, no child node. */
36376db5a27SMasami Hiramatsu 			return NULL;
36476db5a27SMasami Hiramatsu 
36576db5a27SMasami Hiramatsu 		while (!node->next) {
36676db5a27SMasami Hiramatsu 			node = xbc_node_get_parent(node);
36776db5a27SMasami Hiramatsu 			if (node == root)
36876db5a27SMasami Hiramatsu 				return NULL;
36976db5a27SMasami Hiramatsu 			/* User passed a node which is not uder parent */
37076db5a27SMasami Hiramatsu 			if (WARN_ON(!node))
37176db5a27SMasami Hiramatsu 				return NULL;
37276db5a27SMasami Hiramatsu 		}
37376db5a27SMasami Hiramatsu 		node = xbc_node_get_next(node);
37476db5a27SMasami Hiramatsu 	}
37576db5a27SMasami Hiramatsu 
376e5efaeb8SMasami Hiramatsu found:
37776db5a27SMasami Hiramatsu 	while (node && !xbc_node_is_leaf(node))
37876db5a27SMasami Hiramatsu 		node = xbc_node_get_child(node);
37976db5a27SMasami Hiramatsu 
38076db5a27SMasami Hiramatsu 	return node;
38176db5a27SMasami Hiramatsu }
38276db5a27SMasami Hiramatsu 
38376db5a27SMasami Hiramatsu /**
38476db5a27SMasami Hiramatsu  * xbc_node_find_next_key_value() - Find the next key-value pair nodes
38576db5a27SMasami Hiramatsu  * @root: An XBC root node
38676db5a27SMasami Hiramatsu  * @leaf: A container pointer of XBC node which starts from.
38776db5a27SMasami Hiramatsu  *
38876db5a27SMasami Hiramatsu  * Search the next leaf node (which means the terminal key node) of *@leaf
38976db5a27SMasami Hiramatsu  * under @root node. Returns the value and update *@leaf if next leaf node
39076db5a27SMasami Hiramatsu  * is found, or NULL if no next leaf node is found.
39176db5a27SMasami Hiramatsu  * Note that this returns 0-length string if the key has no value, or
39276db5a27SMasami Hiramatsu  * the value of the first entry if the value is an array.
39376db5a27SMasami Hiramatsu  */
xbc_node_find_next_key_value(struct xbc_node * root,struct xbc_node ** leaf)39476db5a27SMasami Hiramatsu const char * __init xbc_node_find_next_key_value(struct xbc_node *root,
39576db5a27SMasami Hiramatsu 						 struct xbc_node **leaf)
39676db5a27SMasami Hiramatsu {
39776db5a27SMasami Hiramatsu 	/* tip must be passed */
39876db5a27SMasami Hiramatsu 	if (WARN_ON(!leaf))
39976db5a27SMasami Hiramatsu 		return NULL;
40076db5a27SMasami Hiramatsu 
40176db5a27SMasami Hiramatsu 	*leaf = xbc_node_find_next_leaf(root, *leaf);
40276db5a27SMasami Hiramatsu 	if (!*leaf)
40376db5a27SMasami Hiramatsu 		return NULL;
40476db5a27SMasami Hiramatsu 	if ((*leaf)->child)
40576db5a27SMasami Hiramatsu 		return xbc_node_get_data(xbc_node_get_child(*leaf));
40676db5a27SMasami Hiramatsu 	else
40776db5a27SMasami Hiramatsu 		return "";	/* No value key */
40876db5a27SMasami Hiramatsu }
40976db5a27SMasami Hiramatsu 
41076db5a27SMasami Hiramatsu /* XBC parse and tree build */
41176db5a27SMasami Hiramatsu 
xbc_init_node(struct xbc_node * node,char * data,uint32_t flag)4124f292c48SMasami Hiramatsu static int __init xbc_init_node(struct xbc_node *node, char *data, uint32_t flag)
413a2de2f86SMasami Hiramatsu {
414a2de2f86SMasami Hiramatsu 	unsigned long offset = data - xbc_data;
415a2de2f86SMasami Hiramatsu 
416a2de2f86SMasami Hiramatsu 	if (WARN_ON(offset >= XBC_DATA_MAX))
417a2de2f86SMasami Hiramatsu 		return -EINVAL;
418a2de2f86SMasami Hiramatsu 
4194f292c48SMasami Hiramatsu 	node->data = (uint16_t)offset | flag;
420a2de2f86SMasami Hiramatsu 	node->child = 0;
421a2de2f86SMasami Hiramatsu 	node->next = 0;
422a2de2f86SMasami Hiramatsu 
423a2de2f86SMasami Hiramatsu 	return 0;
424a2de2f86SMasami Hiramatsu }
425a2de2f86SMasami Hiramatsu 
xbc_add_node(char * data,uint32_t flag)4264f292c48SMasami Hiramatsu static struct xbc_node * __init xbc_add_node(char *data, uint32_t flag)
42776db5a27SMasami Hiramatsu {
42876db5a27SMasami Hiramatsu 	struct xbc_node *node;
42976db5a27SMasami Hiramatsu 
43076db5a27SMasami Hiramatsu 	if (xbc_node_num == XBC_NODE_MAX)
43176db5a27SMasami Hiramatsu 		return NULL;
43276db5a27SMasami Hiramatsu 
43376db5a27SMasami Hiramatsu 	node = &xbc_nodes[xbc_node_num++];
434a2de2f86SMasami Hiramatsu 	if (xbc_init_node(node, data, flag) < 0)
43576db5a27SMasami Hiramatsu 		return NULL;
43676db5a27SMasami Hiramatsu 
43776db5a27SMasami Hiramatsu 	return node;
43876db5a27SMasami Hiramatsu }
43976db5a27SMasami Hiramatsu 
xbc_last_sibling(struct xbc_node * node)44076db5a27SMasami Hiramatsu static inline __init struct xbc_node *xbc_last_sibling(struct xbc_node *node)
44176db5a27SMasami Hiramatsu {
44276db5a27SMasami Hiramatsu 	while (node->next)
44376db5a27SMasami Hiramatsu 		node = xbc_node_get_next(node);
44476db5a27SMasami Hiramatsu 
44576db5a27SMasami Hiramatsu 	return node;
44676db5a27SMasami Hiramatsu }
44776db5a27SMasami Hiramatsu 
xbc_last_child(struct xbc_node * node)448ca24306dSMasami Hiramatsu static inline __init struct xbc_node *xbc_last_child(struct xbc_node *node)
449ca24306dSMasami Hiramatsu {
450ca24306dSMasami Hiramatsu 	while (node->child)
451ca24306dSMasami Hiramatsu 		node = xbc_node_get_child(node);
452ca24306dSMasami Hiramatsu 
453ca24306dSMasami Hiramatsu 	return node;
454ca24306dSMasami Hiramatsu }
455ca24306dSMasami Hiramatsu 
__xbc_add_sibling(char * data,uint32_t flag,bool head)4564f292c48SMasami Hiramatsu static struct xbc_node * __init __xbc_add_sibling(char *data, uint32_t flag, bool head)
45776db5a27SMasami Hiramatsu {
45876db5a27SMasami Hiramatsu 	struct xbc_node *sib, *node = xbc_add_node(data, flag);
45976db5a27SMasami Hiramatsu 
46076db5a27SMasami Hiramatsu 	if (node) {
46176db5a27SMasami Hiramatsu 		if (!last_parent) {
462e5efaeb8SMasami Hiramatsu 			/* Ignore @head in this case */
46376db5a27SMasami Hiramatsu 			node->parent = XBC_NODE_MAX;
46476db5a27SMasami Hiramatsu 			sib = xbc_last_sibling(xbc_nodes);
46576db5a27SMasami Hiramatsu 			sib->next = xbc_node_index(node);
46676db5a27SMasami Hiramatsu 		} else {
46776db5a27SMasami Hiramatsu 			node->parent = xbc_node_index(last_parent);
468e5efaeb8SMasami Hiramatsu 			if (!last_parent->child || head) {
469e5efaeb8SMasami Hiramatsu 				node->next = last_parent->child;
47076db5a27SMasami Hiramatsu 				last_parent->child = xbc_node_index(node);
47176db5a27SMasami Hiramatsu 			} else {
47276db5a27SMasami Hiramatsu 				sib = xbc_node_get_child(last_parent);
47376db5a27SMasami Hiramatsu 				sib = xbc_last_sibling(sib);
47476db5a27SMasami Hiramatsu 				sib->next = xbc_node_index(node);
47576db5a27SMasami Hiramatsu 			}
47676db5a27SMasami Hiramatsu 		}
477597c0e3bSMasami Hiramatsu 	} else
478597c0e3bSMasami Hiramatsu 		xbc_parse_error("Too many nodes", data);
47976db5a27SMasami Hiramatsu 
48076db5a27SMasami Hiramatsu 	return node;
48176db5a27SMasami Hiramatsu }
48276db5a27SMasami Hiramatsu 
xbc_add_sibling(char * data,uint32_t flag)4834f292c48SMasami Hiramatsu static inline struct xbc_node * __init xbc_add_sibling(char *data, uint32_t flag)
484e5efaeb8SMasami Hiramatsu {
485e5efaeb8SMasami Hiramatsu 	return __xbc_add_sibling(data, flag, false);
486e5efaeb8SMasami Hiramatsu }
487e5efaeb8SMasami Hiramatsu 
xbc_add_head_sibling(char * data,uint32_t flag)4884f292c48SMasami Hiramatsu static inline struct xbc_node * __init xbc_add_head_sibling(char *data, uint32_t flag)
489e5efaeb8SMasami Hiramatsu {
490e5efaeb8SMasami Hiramatsu 	return __xbc_add_sibling(data, flag, true);
491e5efaeb8SMasami Hiramatsu }
492e5efaeb8SMasami Hiramatsu 
xbc_add_child(char * data,uint32_t flag)4934f292c48SMasami Hiramatsu static inline __init struct xbc_node *xbc_add_child(char *data, uint32_t flag)
49476db5a27SMasami Hiramatsu {
49576db5a27SMasami Hiramatsu 	struct xbc_node *node = xbc_add_sibling(data, flag);
49676db5a27SMasami Hiramatsu 
49776db5a27SMasami Hiramatsu 	if (node)
49876db5a27SMasami Hiramatsu 		last_parent = node;
49976db5a27SMasami Hiramatsu 
50076db5a27SMasami Hiramatsu 	return node;
50176db5a27SMasami Hiramatsu }
50276db5a27SMasami Hiramatsu 
xbc_valid_keyword(char * key)50376db5a27SMasami Hiramatsu static inline __init bool xbc_valid_keyword(char *key)
50476db5a27SMasami Hiramatsu {
50576db5a27SMasami Hiramatsu 	if (key[0] == '\0')
50676db5a27SMasami Hiramatsu 		return false;
50776db5a27SMasami Hiramatsu 
50876db5a27SMasami Hiramatsu 	while (isalnum(*key) || *key == '-' || *key == '_')
50976db5a27SMasami Hiramatsu 		key++;
51076db5a27SMasami Hiramatsu 
51176db5a27SMasami Hiramatsu 	return *key == '\0';
51276db5a27SMasami Hiramatsu }
51376db5a27SMasami Hiramatsu 
skip_comment(char * p)51476db5a27SMasami Hiramatsu static char *skip_comment(char *p)
51576db5a27SMasami Hiramatsu {
51676db5a27SMasami Hiramatsu 	char *ret;
51776db5a27SMasami Hiramatsu 
51876db5a27SMasami Hiramatsu 	ret = strchr(p, '\n');
51976db5a27SMasami Hiramatsu 	if (!ret)
52076db5a27SMasami Hiramatsu 		ret = p + strlen(p);
52176db5a27SMasami Hiramatsu 	else
52276db5a27SMasami Hiramatsu 		ret++;
52376db5a27SMasami Hiramatsu 
52476db5a27SMasami Hiramatsu 	return ret;
52576db5a27SMasami Hiramatsu }
52676db5a27SMasami Hiramatsu 
skip_spaces_until_newline(char * p)52776db5a27SMasami Hiramatsu static char *skip_spaces_until_newline(char *p)
52876db5a27SMasami Hiramatsu {
52976db5a27SMasami Hiramatsu 	while (isspace(*p) && *p != '\n')
53076db5a27SMasami Hiramatsu 		p++;
53176db5a27SMasami Hiramatsu 	return p;
53276db5a27SMasami Hiramatsu }
53376db5a27SMasami Hiramatsu 
__xbc_open_brace(char * p)534ead1e19aSMasami Hiramatsu static int __init __xbc_open_brace(char *p)
53576db5a27SMasami Hiramatsu {
536ead1e19aSMasami Hiramatsu 	/* Push the last key as open brace */
537ead1e19aSMasami Hiramatsu 	open_brace[brace_index++] = xbc_node_index(last_parent);
538ead1e19aSMasami Hiramatsu 	if (brace_index >= XBC_DEPTH_MAX)
539ead1e19aSMasami Hiramatsu 		return xbc_parse_error("Exceed max depth of braces", p);
54076db5a27SMasami Hiramatsu 
54176db5a27SMasami Hiramatsu 	return 0;
54276db5a27SMasami Hiramatsu }
54376db5a27SMasami Hiramatsu 
__xbc_close_brace(char * p)54476db5a27SMasami Hiramatsu static int __init __xbc_close_brace(char *p)
54576db5a27SMasami Hiramatsu {
546ead1e19aSMasami Hiramatsu 	brace_index--;
547ead1e19aSMasami Hiramatsu 	if (!last_parent || brace_index < 0 ||
548ead1e19aSMasami Hiramatsu 	    (open_brace[brace_index] != xbc_node_index(last_parent)))
54976db5a27SMasami Hiramatsu 		return xbc_parse_error("Unexpected closing brace", p);
55076db5a27SMasami Hiramatsu 
551ead1e19aSMasami Hiramatsu 	if (brace_index == 0)
552ead1e19aSMasami Hiramatsu 		last_parent = NULL;
553ead1e19aSMasami Hiramatsu 	else
554ead1e19aSMasami Hiramatsu 		last_parent = &xbc_nodes[open_brace[brace_index - 1]];
55576db5a27SMasami Hiramatsu 
55676db5a27SMasami Hiramatsu 	return 0;
55776db5a27SMasami Hiramatsu }
55876db5a27SMasami Hiramatsu 
55976db5a27SMasami Hiramatsu /*
56076db5a27SMasami Hiramatsu  * Return delimiter or error, no node added. As same as lib/cmdline.c,
56176db5a27SMasami Hiramatsu  * you can use " around spaces, but can't escape " for value.
56276db5a27SMasami Hiramatsu  */
__xbc_parse_value(char ** __v,char ** __n)56376db5a27SMasami Hiramatsu static int __init __xbc_parse_value(char **__v, char **__n)
56476db5a27SMasami Hiramatsu {
56576db5a27SMasami Hiramatsu 	char *p, *v = *__v;
56676db5a27SMasami Hiramatsu 	int c, quotes = 0;
56776db5a27SMasami Hiramatsu 
56876db5a27SMasami Hiramatsu 	v = skip_spaces(v);
56976db5a27SMasami Hiramatsu 	while (*v == '#') {
57076db5a27SMasami Hiramatsu 		v = skip_comment(v);
57176db5a27SMasami Hiramatsu 		v = skip_spaces(v);
57276db5a27SMasami Hiramatsu 	}
57376db5a27SMasami Hiramatsu 	if (*v == '"' || *v == '\'') {
57476db5a27SMasami Hiramatsu 		quotes = *v;
57576db5a27SMasami Hiramatsu 		v++;
57676db5a27SMasami Hiramatsu 	}
57776db5a27SMasami Hiramatsu 	p = v - 1;
57876db5a27SMasami Hiramatsu 	while ((c = *++p)) {
57976db5a27SMasami Hiramatsu 		if (!isprint(c) && !isspace(c))
58076db5a27SMasami Hiramatsu 			return xbc_parse_error("Non printable value", p);
58176db5a27SMasami Hiramatsu 		if (quotes) {
58276db5a27SMasami Hiramatsu 			if (c != quotes)
58376db5a27SMasami Hiramatsu 				continue;
58476db5a27SMasami Hiramatsu 			quotes = 0;
58576db5a27SMasami Hiramatsu 			*p++ = '\0';
58676db5a27SMasami Hiramatsu 			p = skip_spaces_until_newline(p);
58776db5a27SMasami Hiramatsu 			c = *p;
58876db5a27SMasami Hiramatsu 			if (c && !strchr(",;\n#}", c))
58976db5a27SMasami Hiramatsu 				return xbc_parse_error("No value delimiter", p);
59076db5a27SMasami Hiramatsu 			if (*p)
59176db5a27SMasami Hiramatsu 				p++;
59276db5a27SMasami Hiramatsu 			break;
59376db5a27SMasami Hiramatsu 		}
59476db5a27SMasami Hiramatsu 		if (strchr(",;\n#}", c)) {
59576db5a27SMasami Hiramatsu 			*p++ = '\0';
596c7af4ecdSMasami Hiramatsu 			v = strim(v);
59776db5a27SMasami Hiramatsu 			break;
59876db5a27SMasami Hiramatsu 		}
59976db5a27SMasami Hiramatsu 	}
60076db5a27SMasami Hiramatsu 	if (quotes)
60176db5a27SMasami Hiramatsu 		return xbc_parse_error("No closing quotes", p);
60276db5a27SMasami Hiramatsu 	if (c == '#') {
60376db5a27SMasami Hiramatsu 		p = skip_comment(p);
60476db5a27SMasami Hiramatsu 		c = '\n';	/* A comment must be treated as a newline */
60576db5a27SMasami Hiramatsu 	}
60676db5a27SMasami Hiramatsu 	*__n = p;
60776db5a27SMasami Hiramatsu 	*__v = v;
60876db5a27SMasami Hiramatsu 
60976db5a27SMasami Hiramatsu 	return c;
61076db5a27SMasami Hiramatsu }
61176db5a27SMasami Hiramatsu 
xbc_parse_array(char ** __v)61276db5a27SMasami Hiramatsu static int __init xbc_parse_array(char **__v)
61376db5a27SMasami Hiramatsu {
61476db5a27SMasami Hiramatsu 	struct xbc_node *node;
61576db5a27SMasami Hiramatsu 	char *next;
61676db5a27SMasami Hiramatsu 	int c = 0;
61776db5a27SMasami Hiramatsu 
618ca24306dSMasami Hiramatsu 	if (last_parent->child)
619ca24306dSMasami Hiramatsu 		last_parent = xbc_node_get_child(last_parent);
620ca24306dSMasami Hiramatsu 
62176db5a27SMasami Hiramatsu 	do {
62276db5a27SMasami Hiramatsu 		c = __xbc_parse_value(__v, &next);
62376db5a27SMasami Hiramatsu 		if (c < 0)
62476db5a27SMasami Hiramatsu 			return c;
62576db5a27SMasami Hiramatsu 
626ca24306dSMasami Hiramatsu 		node = xbc_add_child(*__v, XBC_VALUE);
62776db5a27SMasami Hiramatsu 		if (!node)
62876db5a27SMasami Hiramatsu 			return -ENOMEM;
62976db5a27SMasami Hiramatsu 		*__v = next;
63076db5a27SMasami Hiramatsu 	} while (c == ',');
631ca24306dSMasami Hiramatsu 	node->child = 0;
63276db5a27SMasami Hiramatsu 
63376db5a27SMasami Hiramatsu 	return c;
63476db5a27SMasami Hiramatsu }
63576db5a27SMasami Hiramatsu 
63676db5a27SMasami Hiramatsu static inline __init
find_match_node(struct xbc_node * node,char * k)63776db5a27SMasami Hiramatsu struct xbc_node *find_match_node(struct xbc_node *node, char *k)
63876db5a27SMasami Hiramatsu {
63976db5a27SMasami Hiramatsu 	while (node) {
64076db5a27SMasami Hiramatsu 		if (!strcmp(xbc_node_get_data(node), k))
64176db5a27SMasami Hiramatsu 			break;
64276db5a27SMasami Hiramatsu 		node = xbc_node_get_next(node);
64376db5a27SMasami Hiramatsu 	}
64476db5a27SMasami Hiramatsu 	return node;
64576db5a27SMasami Hiramatsu }
64676db5a27SMasami Hiramatsu 
__xbc_add_key(char * k)64776db5a27SMasami Hiramatsu static int __init __xbc_add_key(char *k)
64876db5a27SMasami Hiramatsu {
649a24d286fSMasami Hiramatsu 	struct xbc_node *node, *child;
65076db5a27SMasami Hiramatsu 
65176db5a27SMasami Hiramatsu 	if (!xbc_valid_keyword(k))
65276db5a27SMasami Hiramatsu 		return xbc_parse_error("Invalid keyword", k);
65376db5a27SMasami Hiramatsu 
65476db5a27SMasami Hiramatsu 	if (unlikely(xbc_node_num == 0))
65576db5a27SMasami Hiramatsu 		goto add_node;
65676db5a27SMasami Hiramatsu 
65776db5a27SMasami Hiramatsu 	if (!last_parent)	/* the first level */
65876db5a27SMasami Hiramatsu 		node = find_match_node(xbc_nodes, k);
659a24d286fSMasami Hiramatsu 	else {
660a24d286fSMasami Hiramatsu 		child = xbc_node_get_child(last_parent);
661e5efaeb8SMasami Hiramatsu 		/* Since the value node is the first child, skip it. */
662a24d286fSMasami Hiramatsu 		if (child && xbc_node_is_value(child))
663e5efaeb8SMasami Hiramatsu 			child = xbc_node_get_next(child);
664a24d286fSMasami Hiramatsu 		node = find_match_node(child, k);
665a24d286fSMasami Hiramatsu 	}
66676db5a27SMasami Hiramatsu 
66776db5a27SMasami Hiramatsu 	if (node)
66876db5a27SMasami Hiramatsu 		last_parent = node;
66976db5a27SMasami Hiramatsu 	else {
67076db5a27SMasami Hiramatsu add_node:
67176db5a27SMasami Hiramatsu 		node = xbc_add_child(k, XBC_KEY);
67276db5a27SMasami Hiramatsu 		if (!node)
67376db5a27SMasami Hiramatsu 			return -ENOMEM;
67476db5a27SMasami Hiramatsu 	}
67576db5a27SMasami Hiramatsu 	return 0;
67676db5a27SMasami Hiramatsu }
67776db5a27SMasami Hiramatsu 
__xbc_parse_keys(char * k)67876db5a27SMasami Hiramatsu static int __init __xbc_parse_keys(char *k)
67976db5a27SMasami Hiramatsu {
68076db5a27SMasami Hiramatsu 	char *p;
68176db5a27SMasami Hiramatsu 	int ret;
68276db5a27SMasami Hiramatsu 
68376db5a27SMasami Hiramatsu 	k = strim(k);
68476db5a27SMasami Hiramatsu 	while ((p = strchr(k, '.'))) {
68576db5a27SMasami Hiramatsu 		*p++ = '\0';
68676db5a27SMasami Hiramatsu 		ret = __xbc_add_key(k);
68776db5a27SMasami Hiramatsu 		if (ret)
68876db5a27SMasami Hiramatsu 			return ret;
68976db5a27SMasami Hiramatsu 		k = p;
69076db5a27SMasami Hiramatsu 	}
69176db5a27SMasami Hiramatsu 
69276db5a27SMasami Hiramatsu 	return __xbc_add_key(k);
69376db5a27SMasami Hiramatsu }
69476db5a27SMasami Hiramatsu 
xbc_parse_kv(char ** k,char * v,int op)6955f811c57SMasami Hiramatsu static int __init xbc_parse_kv(char **k, char *v, int op)
69676db5a27SMasami Hiramatsu {
69776db5a27SMasami Hiramatsu 	struct xbc_node *prev_parent = last_parent;
6984e4694d8SMasami Hiramatsu 	struct xbc_node *child;
69976db5a27SMasami Hiramatsu 	char *next;
70076db5a27SMasami Hiramatsu 	int c, ret;
70176db5a27SMasami Hiramatsu 
70276db5a27SMasami Hiramatsu 	ret = __xbc_parse_keys(*k);
70376db5a27SMasami Hiramatsu 	if (ret)
70476db5a27SMasami Hiramatsu 		return ret;
70576db5a27SMasami Hiramatsu 
70676db5a27SMasami Hiramatsu 	c = __xbc_parse_value(&v, &next);
70776db5a27SMasami Hiramatsu 	if (c < 0)
70876db5a27SMasami Hiramatsu 		return c;
70976db5a27SMasami Hiramatsu 
710e5efaeb8SMasami Hiramatsu 	child = xbc_node_get_child(last_parent);
711e5efaeb8SMasami Hiramatsu 	if (child && xbc_node_is_value(child)) {
712e5efaeb8SMasami Hiramatsu 		if (op == '=')
713e5efaeb8SMasami Hiramatsu 			return xbc_parse_error("Value is redefined", v);
714e5efaeb8SMasami Hiramatsu 		if (op == ':') {
715e5efaeb8SMasami Hiramatsu 			unsigned short nidx = child->next;
71676db5a27SMasami Hiramatsu 
717e5efaeb8SMasami Hiramatsu 			xbc_init_node(child, v, XBC_VALUE);
718e5efaeb8SMasami Hiramatsu 			child->next = nidx;	/* keep subkeys */
719e5efaeb8SMasami Hiramatsu 			goto array;
720e5efaeb8SMasami Hiramatsu 		}
721e5efaeb8SMasami Hiramatsu 		/* op must be '+' */
722e5efaeb8SMasami Hiramatsu 		last_parent = xbc_last_child(child);
723e5efaeb8SMasami Hiramatsu 	}
724e5efaeb8SMasami Hiramatsu 	/* The value node should always be the first child */
725e5efaeb8SMasami Hiramatsu 	if (!xbc_add_head_sibling(v, XBC_VALUE))
726e5efaeb8SMasami Hiramatsu 		return -ENOMEM;
727e5efaeb8SMasami Hiramatsu 
728e5efaeb8SMasami Hiramatsu array:
72976db5a27SMasami Hiramatsu 	if (c == ',') {	/* Array */
73076db5a27SMasami Hiramatsu 		c = xbc_parse_array(&next);
73176db5a27SMasami Hiramatsu 		if (c < 0)
73276db5a27SMasami Hiramatsu 			return c;
73376db5a27SMasami Hiramatsu 	}
73476db5a27SMasami Hiramatsu 
73576db5a27SMasami Hiramatsu 	last_parent = prev_parent;
73676db5a27SMasami Hiramatsu 
73776db5a27SMasami Hiramatsu 	if (c == '}') {
73876db5a27SMasami Hiramatsu 		ret = __xbc_close_brace(next - 1);
73976db5a27SMasami Hiramatsu 		if (ret < 0)
74076db5a27SMasami Hiramatsu 			return ret;
74176db5a27SMasami Hiramatsu 	}
74276db5a27SMasami Hiramatsu 
74376db5a27SMasami Hiramatsu 	*k = next;
74476db5a27SMasami Hiramatsu 
74576db5a27SMasami Hiramatsu 	return 0;
74676db5a27SMasami Hiramatsu }
74776db5a27SMasami Hiramatsu 
xbc_parse_key(char ** k,char * n)74876db5a27SMasami Hiramatsu static int __init xbc_parse_key(char **k, char *n)
74976db5a27SMasami Hiramatsu {
75076db5a27SMasami Hiramatsu 	struct xbc_node *prev_parent = last_parent;
75176db5a27SMasami Hiramatsu 	int ret;
75276db5a27SMasami Hiramatsu 
75376db5a27SMasami Hiramatsu 	*k = strim(*k);
75476db5a27SMasami Hiramatsu 	if (**k != '\0') {
75576db5a27SMasami Hiramatsu 		ret = __xbc_parse_keys(*k);
75676db5a27SMasami Hiramatsu 		if (ret)
75776db5a27SMasami Hiramatsu 			return ret;
75876db5a27SMasami Hiramatsu 		last_parent = prev_parent;
75976db5a27SMasami Hiramatsu 	}
76076db5a27SMasami Hiramatsu 	*k = n;
76176db5a27SMasami Hiramatsu 
76276db5a27SMasami Hiramatsu 	return 0;
76376db5a27SMasami Hiramatsu }
76476db5a27SMasami Hiramatsu 
xbc_open_brace(char ** k,char * n)76576db5a27SMasami Hiramatsu static int __init xbc_open_brace(char **k, char *n)
76676db5a27SMasami Hiramatsu {
76776db5a27SMasami Hiramatsu 	int ret;
76876db5a27SMasami Hiramatsu 
76976db5a27SMasami Hiramatsu 	ret = __xbc_parse_keys(*k);
77076db5a27SMasami Hiramatsu 	if (ret)
77176db5a27SMasami Hiramatsu 		return ret;
77276db5a27SMasami Hiramatsu 	*k = n;
77376db5a27SMasami Hiramatsu 
774ead1e19aSMasami Hiramatsu 	return __xbc_open_brace(n - 1);
77576db5a27SMasami Hiramatsu }
77676db5a27SMasami Hiramatsu 
xbc_close_brace(char ** k,char * n)77776db5a27SMasami Hiramatsu static int __init xbc_close_brace(char **k, char *n)
77876db5a27SMasami Hiramatsu {
77976db5a27SMasami Hiramatsu 	int ret;
78076db5a27SMasami Hiramatsu 
78176db5a27SMasami Hiramatsu 	ret = xbc_parse_key(k, n);
78276db5a27SMasami Hiramatsu 	if (ret)
78376db5a27SMasami Hiramatsu 		return ret;
78476db5a27SMasami Hiramatsu 	/* k is updated in xbc_parse_key() */
78576db5a27SMasami Hiramatsu 
78676db5a27SMasami Hiramatsu 	return __xbc_close_brace(n - 1);
78776db5a27SMasami Hiramatsu }
78876db5a27SMasami Hiramatsu 
xbc_verify_tree(void)78976db5a27SMasami Hiramatsu static int __init xbc_verify_tree(void)
79076db5a27SMasami Hiramatsu {
79176db5a27SMasami Hiramatsu 	int i, depth, len, wlen;
79276db5a27SMasami Hiramatsu 	struct xbc_node *n, *m;
79376db5a27SMasami Hiramatsu 
794ead1e19aSMasami Hiramatsu 	/* Brace closing */
795ead1e19aSMasami Hiramatsu 	if (brace_index) {
796ead1e19aSMasami Hiramatsu 		n = &xbc_nodes[open_brace[brace_index]];
797ead1e19aSMasami Hiramatsu 		return xbc_parse_error("Brace is not closed",
798ead1e19aSMasami Hiramatsu 					xbc_node_get_data(n));
799ead1e19aSMasami Hiramatsu 	}
800ead1e19aSMasami Hiramatsu 
80176db5a27SMasami Hiramatsu 	/* Empty tree */
802597c0e3bSMasami Hiramatsu 	if (xbc_node_num == 0) {
803597c0e3bSMasami Hiramatsu 		xbc_parse_error("Empty config", xbc_data);
80476db5a27SMasami Hiramatsu 		return -ENOENT;
805597c0e3bSMasami Hiramatsu 	}
80676db5a27SMasami Hiramatsu 
80776db5a27SMasami Hiramatsu 	for (i = 0; i < xbc_node_num; i++) {
80876db5a27SMasami Hiramatsu 		if (xbc_nodes[i].next > xbc_node_num) {
80976db5a27SMasami Hiramatsu 			return xbc_parse_error("No closing brace",
81076db5a27SMasami Hiramatsu 				xbc_node_get_data(xbc_nodes + i));
81176db5a27SMasami Hiramatsu 		}
81276db5a27SMasami Hiramatsu 	}
81376db5a27SMasami Hiramatsu 
81476db5a27SMasami Hiramatsu 	/* Key tree limitation check */
81576db5a27SMasami Hiramatsu 	n = &xbc_nodes[0];
81676db5a27SMasami Hiramatsu 	depth = 1;
81776db5a27SMasami Hiramatsu 	len = 0;
81876db5a27SMasami Hiramatsu 
81976db5a27SMasami Hiramatsu 	while (n) {
82076db5a27SMasami Hiramatsu 		wlen = strlen(xbc_node_get_data(n)) + 1;
82176db5a27SMasami Hiramatsu 		len += wlen;
82276db5a27SMasami Hiramatsu 		if (len > XBC_KEYLEN_MAX)
82376db5a27SMasami Hiramatsu 			return xbc_parse_error("Too long key length",
82476db5a27SMasami Hiramatsu 				xbc_node_get_data(n));
82576db5a27SMasami Hiramatsu 
82676db5a27SMasami Hiramatsu 		m = xbc_node_get_child(n);
82776db5a27SMasami Hiramatsu 		if (m && xbc_node_is_key(m)) {
82876db5a27SMasami Hiramatsu 			n = m;
82976db5a27SMasami Hiramatsu 			depth++;
83076db5a27SMasami Hiramatsu 			if (depth > XBC_DEPTH_MAX)
83176db5a27SMasami Hiramatsu 				return xbc_parse_error("Too many key words",
83276db5a27SMasami Hiramatsu 						xbc_node_get_data(n));
83376db5a27SMasami Hiramatsu 			continue;
83476db5a27SMasami Hiramatsu 		}
83576db5a27SMasami Hiramatsu 		len -= wlen;
83676db5a27SMasami Hiramatsu 		m = xbc_node_get_next(n);
83776db5a27SMasami Hiramatsu 		while (!m) {
83876db5a27SMasami Hiramatsu 			n = xbc_node_get_parent(n);
83976db5a27SMasami Hiramatsu 			if (!n)
84076db5a27SMasami Hiramatsu 				break;
84176db5a27SMasami Hiramatsu 			len -= strlen(xbc_node_get_data(n)) + 1;
84276db5a27SMasami Hiramatsu 			depth--;
84376db5a27SMasami Hiramatsu 			m = xbc_node_get_next(n);
84476db5a27SMasami Hiramatsu 		}
84576db5a27SMasami Hiramatsu 		n = m;
84676db5a27SMasami Hiramatsu 	}
84776db5a27SMasami Hiramatsu 
84876db5a27SMasami Hiramatsu 	return 0;
84976db5a27SMasami Hiramatsu }
85076db5a27SMasami Hiramatsu 
851f3668cdeSMasami Hiramatsu /* Need to setup xbc_data and xbc_nodes before call this. */
xbc_parse_tree(void)852f3668cdeSMasami Hiramatsu static int __init xbc_parse_tree(void)
85376db5a27SMasami Hiramatsu {
85476db5a27SMasami Hiramatsu 	char *p, *q;
85539d9c1c1SSteven Rostedt (VMware) 	int ret = 0, c;
85676db5a27SMasami Hiramatsu 
857bdac5c2bSMasami Hiramatsu 	last_parent = NULL;
858bdac5c2bSMasami Hiramatsu 	p = xbc_data;
85976db5a27SMasami Hiramatsu 	do {
860a2de2f86SMasami Hiramatsu 		q = strpbrk(p, "{}=+;:\n#");
86176db5a27SMasami Hiramatsu 		if (!q) {
86276db5a27SMasami Hiramatsu 			p = skip_spaces(p);
86376db5a27SMasami Hiramatsu 			if (*p != '\0')
86476db5a27SMasami Hiramatsu 				ret = xbc_parse_error("No delimiter", p);
86576db5a27SMasami Hiramatsu 			break;
86676db5a27SMasami Hiramatsu 		}
86776db5a27SMasami Hiramatsu 
86876db5a27SMasami Hiramatsu 		c = *q;
86976db5a27SMasami Hiramatsu 		*q++ = '\0';
87076db5a27SMasami Hiramatsu 		switch (c) {
871a2de2f86SMasami Hiramatsu 		case ':':
8725f811c57SMasami Hiramatsu 		case '+':
8735f811c57SMasami Hiramatsu 			if (*q++ != '=') {
874a2de2f86SMasami Hiramatsu 				ret = xbc_parse_error(c == '+' ?
875a2de2f86SMasami Hiramatsu 						"Wrong '+' operator" :
876a2de2f86SMasami Hiramatsu 						"Wrong ':' operator",
8775f811c57SMasami Hiramatsu 							q - 2);
8785f811c57SMasami Hiramatsu 				break;
8795f811c57SMasami Hiramatsu 			}
8804c1ca831SNick Desaulniers 			fallthrough;
88176db5a27SMasami Hiramatsu 		case '=':
8825f811c57SMasami Hiramatsu 			ret = xbc_parse_kv(&p, q, c);
88376db5a27SMasami Hiramatsu 			break;
88476db5a27SMasami Hiramatsu 		case '{':
88576db5a27SMasami Hiramatsu 			ret = xbc_open_brace(&p, q);
88676db5a27SMasami Hiramatsu 			break;
88776db5a27SMasami Hiramatsu 		case '#':
88876db5a27SMasami Hiramatsu 			q = skip_comment(q);
8894c1ca831SNick Desaulniers 			fallthrough;
89076db5a27SMasami Hiramatsu 		case ';':
89176db5a27SMasami Hiramatsu 		case '\n':
89276db5a27SMasami Hiramatsu 			ret = xbc_parse_key(&p, q);
89376db5a27SMasami Hiramatsu 			break;
89476db5a27SMasami Hiramatsu 		case '}':
89576db5a27SMasami Hiramatsu 			ret = xbc_close_brace(&p, q);
89676db5a27SMasami Hiramatsu 			break;
89776db5a27SMasami Hiramatsu 		}
89876db5a27SMasami Hiramatsu 	} while (!ret);
89976db5a27SMasami Hiramatsu 
900f3668cdeSMasami Hiramatsu 	return ret;
901f3668cdeSMasami Hiramatsu }
902f3668cdeSMasami Hiramatsu 
903f3668cdeSMasami Hiramatsu /**
904*86052433SMasami Hiramatsu (Google)  * _xbc_exit() - Clean up all parsed bootconfig
905*86052433SMasami Hiramatsu (Google)  * @early: Set true if this is called before budy system is initialized.
906f3668cdeSMasami Hiramatsu  *
907f3668cdeSMasami Hiramatsu  * This clears all data structures of parsed bootconfig on memory.
908f3668cdeSMasami Hiramatsu  * If you need to reuse xbc_init() with new boot config, you can
909f3668cdeSMasami Hiramatsu  * use this.
910f3668cdeSMasami Hiramatsu  */
_xbc_exit(bool early)911e46d3be7SQiang Zhang void __init _xbc_exit(bool early)
912f3668cdeSMasami Hiramatsu {
913e46d3be7SQiang Zhang 	xbc_free_mem(xbc_data, xbc_data_size, early);
914f3668cdeSMasami Hiramatsu 	xbc_data = NULL;
915f3668cdeSMasami Hiramatsu 	xbc_data_size = 0;
916f3668cdeSMasami Hiramatsu 	xbc_node_num = 0;
917e46d3be7SQiang Zhang 	xbc_free_mem(xbc_nodes, sizeof(struct xbc_node) * XBC_NODE_MAX, early);
918f3668cdeSMasami Hiramatsu 	xbc_nodes = NULL;
919f3668cdeSMasami Hiramatsu 	brace_index = 0;
920f3668cdeSMasami Hiramatsu }
921f3668cdeSMasami Hiramatsu 
922f3668cdeSMasami Hiramatsu /**
923f3668cdeSMasami Hiramatsu  * xbc_init() - Parse given XBC file and build XBC internal tree
924f3668cdeSMasami Hiramatsu  * @data: The boot config text original data
925f3668cdeSMasami Hiramatsu  * @size: The size of @data
926f3668cdeSMasami Hiramatsu  * @emsg: A pointer of const char * to store the error message
927f3668cdeSMasami Hiramatsu  * @epos: A pointer of int to store the error position
928f3668cdeSMasami Hiramatsu  *
929f3668cdeSMasami Hiramatsu  * This parses the boot config text in @data. @size must be smaller
930f3668cdeSMasami Hiramatsu  * than XBC_DATA_MAX.
931f3668cdeSMasami Hiramatsu  * Return the number of stored nodes (>0) if succeeded, or -errno
932f3668cdeSMasami Hiramatsu  * if there is any error.
933f3668cdeSMasami Hiramatsu  * In error cases, @emsg will be updated with an error message and
934f3668cdeSMasami Hiramatsu  * @epos will be updated with the error position which is the byte offset
935f3668cdeSMasami Hiramatsu  * of @buf. If the error is not a parser error, @epos will be -1.
936f3668cdeSMasami Hiramatsu  */
xbc_init(const char * data,size_t size,const char ** emsg,int * epos)937f3668cdeSMasami Hiramatsu int __init xbc_init(const char *data, size_t size, const char **emsg, int *epos)
938f3668cdeSMasami Hiramatsu {
939f3668cdeSMasami Hiramatsu 	int ret;
940f3668cdeSMasami Hiramatsu 
941f3668cdeSMasami Hiramatsu 	if (epos)
942f3668cdeSMasami Hiramatsu 		*epos = -1;
943f3668cdeSMasami Hiramatsu 
944f3668cdeSMasami Hiramatsu 	if (xbc_data) {
945f3668cdeSMasami Hiramatsu 		if (emsg)
946f3668cdeSMasami Hiramatsu 			*emsg = "Bootconfig is already initialized";
947f3668cdeSMasami Hiramatsu 		return -EBUSY;
948f3668cdeSMasami Hiramatsu 	}
949f3668cdeSMasami Hiramatsu 	if (size > XBC_DATA_MAX || size == 0) {
950f3668cdeSMasami Hiramatsu 		if (emsg)
951f3668cdeSMasami Hiramatsu 			*emsg = size ? "Config data is too big" :
952f3668cdeSMasami Hiramatsu 				"Config data is empty";
953f3668cdeSMasami Hiramatsu 		return -ERANGE;
954f3668cdeSMasami Hiramatsu 	}
955f3668cdeSMasami Hiramatsu 
9564ee1b4caSMasami Hiramatsu 	xbc_data = xbc_alloc_mem(size + 1);
957f3668cdeSMasami Hiramatsu 	if (!xbc_data) {
958f3668cdeSMasami Hiramatsu 		if (emsg)
959f3668cdeSMasami Hiramatsu 			*emsg = "Failed to allocate bootconfig data";
960f3668cdeSMasami Hiramatsu 		return -ENOMEM;
961f3668cdeSMasami Hiramatsu 	}
962f3668cdeSMasami Hiramatsu 	memcpy(xbc_data, data, size);
963f3668cdeSMasami Hiramatsu 	xbc_data[size] = '\0';
964f3668cdeSMasami Hiramatsu 	xbc_data_size = size + 1;
965f3668cdeSMasami Hiramatsu 
9664ee1b4caSMasami Hiramatsu 	xbc_nodes = xbc_alloc_mem(sizeof(struct xbc_node) * XBC_NODE_MAX);
967f3668cdeSMasami Hiramatsu 	if (!xbc_nodes) {
968f3668cdeSMasami Hiramatsu 		if (emsg)
969f3668cdeSMasami Hiramatsu 			*emsg = "Failed to allocate bootconfig nodes";
970e46d3be7SQiang Zhang 		_xbc_exit(true);
971f3668cdeSMasami Hiramatsu 		return -ENOMEM;
972f3668cdeSMasami Hiramatsu 	}
973f3668cdeSMasami Hiramatsu 	memset(xbc_nodes, 0, sizeof(struct xbc_node) * XBC_NODE_MAX);
974f3668cdeSMasami Hiramatsu 
975f3668cdeSMasami Hiramatsu 	ret = xbc_parse_tree();
97676db5a27SMasami Hiramatsu 	if (!ret)
97776db5a27SMasami Hiramatsu 		ret = xbc_verify_tree();
97876db5a27SMasami Hiramatsu 
97989b74cacSMasami Hiramatsu 	if (ret < 0) {
98089b74cacSMasami Hiramatsu 		if (epos)
98189b74cacSMasami Hiramatsu 			*epos = xbc_err_pos;
98289b74cacSMasami Hiramatsu 		if (emsg)
98389b74cacSMasami Hiramatsu 			*emsg = xbc_err_msg;
984e46d3be7SQiang Zhang 		_xbc_exit(true);
98589b74cacSMasami Hiramatsu 	} else
9860f0d0a77SMasami Hiramatsu 		ret = xbc_node_num;
98776db5a27SMasami Hiramatsu 
98876db5a27SMasami Hiramatsu 	return ret;
98976db5a27SMasami Hiramatsu }
990