[tarantool-patches] Re: [PATCH v5 2/9] lib: implement JSON tree class for json library

[Vladimir Davydov]

On Tue, Dec 04, 2018 at 06:47:27PM +0300, Kirill Shcherbatov wrote:
> >> +	uint32_t rolling_hash;
> > 
> > Let's call it simply 'hash', short and clear. The rolling nature of the
> > hash should be explained in the comment.
> Ok, done
> 
> > typo: indexe -> index
> > 
> > BTW, json array start indexing from 0, not 1 AFAIK. Starting indexing
> > from 1 looks weird to me.

You left this comment from my previous review unattended.

> > 
> >> +	 * and are allocated sequently for JSON_TOKEN_NUM child
> > 
> > typo: sequently -> sequentially
> Ok, done.

See below for my comments to the new version of the patch.

> From c4e0001ecfd0987fffa2ef5f747ef6f3c016dae7 Mon Sep 17 00:00:00 2001
> From: Kirill Shcherbatov <kshcherbatov at tarantool.org>
> Date: Mon, 1 Oct 2018 15:10:19 +0300
> Subject: [PATCH] lib: implement JSON tree class for json library
> 
> New JSON tree class would store JSON paths for tuple fields
> for registered non-plain indexes. It is a hierarchical data
> structure that organize JSON nodes produced by parser.
> Class provides API to lookup node by path and iterate over the
> tree.
> JSON Indexes patch require such functionality to make lookup
> for tuple_fields by path, make initialization of field map and
> build vynyl_stmt msgpack for secondary index via JSON tree
> iteration.
> 
> Need for #1012

As I've already told you, should be

Needed for #1012

> diff --git a/src/lib/json/json.c b/src/lib/json/json.c
> index eb80e4bb..58a842ef 100644
> --- a/src/lib/json/json.c
> +++ b/src/lib/json/json.c
> +static void
> +json_token_destroy(struct json_token *token)
> +{
> +	/* Token mustn't have JSON subtree. */
> +	#ifndef NDEBUG

#ifndef/endif shouldn't be indented.

> +	struct json_token *iter;
> +	uint32_t nodes = 0;
> +	json_tree_foreach_preorder(token, iter)
> +		nodes++;
> +	assert(nodes == 0);
> +	#endif /* NDEBUG */

I'd prefer to change this to something simpler, like

	assert(token->child_count == 0);

but now I realize that child_count isn't actually the number of
children, as I thought, but the max id of ever existed child.
This is confusing. We need to do something about it.

What about?

	/**
	 * Allocation size of the children array.
	 */
	int children_capacity;
	/**
	 * Max occupied index in the children array.
	 */
	int max_child_idx;

and update max_child_idx on json_tree_del() as well

> +
> +	free(token->children);
> +}
> +
> +void
> +json_tree_destroy(struct json_tree *tree)
> +{
> +	/* Tree must be empty. */
> +	#ifndef NDEBUG
> +	struct json_token *iter;
> +	uint32_t nodes = 0;
> +	json_tree_foreach_preorder(&tree->root, iter)
> +		nodes++;
> +	assert(nodes == 0);
> +	#endif /* NDEBUG */

This check is pointless as the same check is done by json_token_destroy
called right below.

> +
> +	json_token_destroy(&tree->root);
> +	mh_json_delete(tree->hash);
> +}
> +
> +struct json_token *
> +json_tree_lookup_slowpath(struct json_tree *tree, struct json_token *parent,
> +			  const struct json_token *token)
> +{
> +	assert(parent != NULL);

This particular assertion is pointless. You could as well add

	assert(tree != NULL);
	assert(token != NULL);

but why? Such assertions wouldn't enlighten the reader while the program
would crash anyway while trying to dereference NULL. An assertion should
either ensure some non-trivial condition, to prevent the program from
running any further and increasing the mess, or tip the reader what's
going on here.

> +	if (likely(token->type == JSON_TOKEN_STR)) {
> +		struct json_token key, *key_ptr;
> +		key.type = token->type;
> +		key.str = token->str;
> +		key.len = token->len;
> +		key.parent = parent;
> +		key.hash = json_token_hash(&key);
> +		key_ptr = &key;
> +		mh_int_t id = mh_json_find(tree->hash, &key_ptr, NULL);

You pass token** to mh_json_find instead of token*. I haven't noticed
that before, but turns out that

> +#define mh_key_t struct json_token **

This looks weird. Why not

 #define mh_key_t struct json_token *

?

> +		if (id == mh_end(tree->hash))
> +			return NULL;
> +		struct json_token **entry = mh_json_node(tree->hash, id);
> +		assert(entry == NULL || (*entry)->parent == parent);
> +		return entry != NULL ? *entry : NULL;

AFAIU entry can't be NULL here.

> +	} else if (token->type == JSON_TOKEN_NUM) {
> +		uint32_t idx =  token->num - 1;
> +		return likely(idx < parent->child_count) ?
> +		       parent->children[idx] : NULL;
> +	}

What's the point to handle JSON_TOKEN_NUM here? Nobody is supposed to
call json_tree_lookup_slowpath() directly. Everyone should use
json_tree_lookup() instead.

Please change to an assertion ensuring that token->type is NUM and add
a comment to json_tree_lookup_slowpath() saying that it's an internal
function that shouldn't be used directly.

> diff --git a/src/lib/json/json.h b/src/lib/json/json.h
> index ead44687..948fcdb7 100644
> --- a/src/lib/json/json.h
> +++ b/src/lib/json/json.h

> +/**
> + * Make child lookup in JSON tree by token at position specified
> + * with parent.
> + */
> +struct json_token *
> +json_tree_lookup_slowpath(struct json_tree *tree, struct json_token *parent,
> +			  const struct json_token *token);

The comment to this function could be as short as:

/**
 * Internal function, use json_tree_lookup instead.
 */

> +
> +/**
> + * Make child lookup in JSON tree by token at position specified

They don't usually say "make lookup". It's "do lookup" or, even better,
simply "look up a token in a tree". "Make" is more like "build" or
"construct".

> + * with parent without function call in the best-case. */

Comment style.

> +static inline struct json_token *
> +json_tree_lookup(struct json_tree *tree, struct json_token *parent,
> +		 const struct json_token *token)
> +{
> +	struct json_token *ret = NULL;
> +	if (token->type == JSON_TOKEN_NUM) {
> +		uint32_t idx =  token->num - 1;
> +		ret = likely(idx < parent->child_count_max) ?
> +		      parent->children[idx] : NULL;
> +	} else {
> +		ret = json_tree_lookup_slowpath(tree, parent, token);
> +	}
> +	return ret;
> +}

> +/**
> + * Make secure post-order traversal in JSON tree and return entry.
> + * This cycle doesn't visit root node.
> + */
> +#define json_tree_foreach_entry_safe(root, node, type, member, tmp)	     \
> +	for ((node) = json_tree_postorder_next_entry((root), NULL,	     \
> +						     type, member);	     \
> +	     &(node)->member != (root) &&				     \
> +	     ((tmp) =  json_tree_postorder_next_entry((root),		     \

Extra space.

> +	     					      &(node)->member,	     \
> +	     					      type, member));	     \

Mixed tabs and spaces. There are more things like that in this patch.
Please carefully self-review your patch next time to make sure it's
neatly formatted.

> +	     (node) = (tmp))
> +
>  #ifdef __cplusplus
>  }
>  #endif