Commit 444b8a83 authored by Michel Lespinasse's avatar Michel Lespinasse Committed by Linus Torvalds
Browse files

augmented rbtree: add comments for RB_DECLARE_CALLBACKS macro 

Patch series "make RB_DECLARE_CALLBACKS more generic", v3.

These changes are intended to make the RB_DECLARE_CALLBACKS macro more
generic (allowing the aubmented subtree information to be a struct instead
of a scalar).

I have verified the compiled lib/interval_tree.o and mm/mmap.o files to
check that they didn't change.  This held as expected for interval_tree.o;
mmap.o did have some changes which could be reverted by marking
__vma_link_rb as noinline.  I did not add such a change to the patchset; I
felt it was reasonable enough to leave the inlining decision up to the
compiler.

This patch (of 3):

Add a short comment summarizing the arguments to RB_DECLARE_CALLBACKS.
The arguments are also now capitalized.  This copies the style of the
INTERVAL_TREE_DEFINE macro.

No functional changes in this commit, only comments and capitalization.

Link: http://lkml.kernel.org/r/20190703040156.56953-2-walken@google.com


Signed-off-by: default avatarMichel Lespinasse <walken@google.com>
Acked-by: default avatarDavidlohr Bueso <dbueso@suse.de>
Acked-by: default avatarPeter Zijlstra (Intel) <peterz@infradead.org>
Cc: David Howells <dhowells@redhat.com>
Cc: Uladzislau Rezki <urezki@gmail.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent c7d4f7ee

include/linux/rbtree_augmented.h

+33 −21
Original line number Diff line number Diff line
@@ -60,39 +60,51 @@ rb_insert_augmented_cached(struct rb_node *node, 
	rb_insert_augmented(node, &root->rb_root, augment);

}



#define RB_DECLARE_CALLBACKS(rbstatic, rbname, rbstruct, rbfield,	\

			     rbtype, rbaugmented, rbcompute)		\

/*

 * Template for declaring augmented rbtree callbacks

 *

 * RBSTATIC:    'static' or empty

 * RBNAME:      name of the rb_augment_callbacks structure

 * RBSTRUCT:    struct type of the tree nodes

 * RBFIELD:     name of struct rb_node field within RBSTRUCT

 * RBTYPE:      type of the RBAUGMENTED field

 * RBAUGMENTED: name of RBTYPE field within RBSTRUCT holding data for subtree

 * RBCOMPUTE:   name of function that recomputes the RBAUGMENTED data

 */



#define RB_DECLARE_CALLBACKS(RBSTATIC, RBNAME, RBSTRUCT, RBFIELD,	\

			     RBTYPE, RBAUGMENTED, RBCOMPUTE)		\

static inline void							\

rbname ## _propagate(struct rb_node *rb, struct rb_node *stop)		\

RBNAME ## _propagate(struct rb_node *rb, struct rb_node *stop)		\

{									\

	while (rb != stop) {						\

		rbstruct *node = rb_entry(rb, rbstruct, rbfield);	\

		rbtype augmented = rbcompute(node);			\

		if (node->rbaugmented == augmented)			\

		RBSTRUCT *node = rb_entry(rb, RBSTRUCT, RBFIELD);	\

		RBTYPE augmented = RBCOMPUTE(node);			\

		if (node->RBAUGMENTED == augmented)			\

			break;						\

		node->rbaugmented = augmented;				\

		rb = rb_parent(&node->rbfield);				\

		node->RBAUGMENTED = augmented;				\

		rb = rb_parent(&node->RBFIELD);				\

	}								\

}									\

static inline void							\

rbname ## _copy(struct rb_node *rb_old, struct rb_node *rb_new)		\

RBNAME ## _copy(struct rb_node *rb_old, struct rb_node *rb_new)		\

{									\

	rbstruct *old = rb_entry(rb_old, rbstruct, rbfield);		\

	rbstruct *new = rb_entry(rb_new, rbstruct, rbfield);		\

	new->rbaugmented = old->rbaugmented;				\

	RBSTRUCT *old = rb_entry(rb_old, RBSTRUCT, RBFIELD);		\

	RBSTRUCT *new = rb_entry(rb_new, RBSTRUCT, RBFIELD);		\

	new->RBAUGMENTED = old->RBAUGMENTED;				\

}									\

static void								\

rbname ## _rotate(struct rb_node *rb_old, struct rb_node *rb_new)	\

RBNAME ## _rotate(struct rb_node *rb_old, struct rb_node *rb_new)	\

{									\

	rbstruct *old = rb_entry(rb_old, rbstruct, rbfield);		\

	rbstruct *new = rb_entry(rb_new, rbstruct, rbfield);		\

	new->rbaugmented = old->rbaugmented;				\

	old->rbaugmented = rbcompute(old);				\

	RBSTRUCT *old = rb_entry(rb_old, RBSTRUCT, RBFIELD);		\

	RBSTRUCT *new = rb_entry(rb_new, RBSTRUCT, RBFIELD);		\

	new->RBAUGMENTED = old->RBAUGMENTED;				\

	old->RBAUGMENTED = RBCOMPUTE(old);				\

}									\

rbstatic const struct rb_augment_callbacks rbname = {			\

	.propagate = rbname ## _propagate,				\

	.copy = rbname ## _copy,					\

	.rotate = rbname ## _rotate					\

RBSTATIC const struct rb_augment_callbacks RBNAME = {			\

	.propagate = RBNAME ## _propagate,				\

	.copy = RBNAME ## _copy,					\

	.rotate = RBNAME ## _rotate					\

};

tools/include/linux/rbtree_augmented.h

+33 −21
Original line number Diff line number Diff line
@@ -62,39 +62,51 @@ rb_insert_augmented_cached(struct rb_node *node, 
	rb_insert_augmented(node, &root->rb_root, augment);

}



#define RB_DECLARE_CALLBACKS(rbstatic, rbname, rbstruct, rbfield,	\

			     rbtype, rbaugmented, rbcompute)		\

/*

 * Template for declaring augmented rbtree callbacks

 *

 * RBSTATIC:    'static' or empty

 * RBNAME:      name of the rb_augment_callbacks structure

 * RBSTRUCT:    struct type of the tree nodes

 * RBFIELD:     name of struct rb_node field within RBSTRUCT

 * RBTYPE:      type of the RBAUGMENTED field

 * RBAUGMENTED: name of RBTYPE field within RBSTRUCT holding data for subtree

 * RBCOMPUTE:   name of function that recomputes the RBAUGMENTED data

 */



#define RB_DECLARE_CALLBACKS(RBSTATIC, RBNAME, RBSTRUCT, RBFIELD,	\

			     RBTYPE, RBAUGMENTED, RBCOMPUTE)		\

static inline void							\

rbname ## _propagate(struct rb_node *rb, struct rb_node *stop)		\

RBNAME ## _propagate(struct rb_node *rb, struct rb_node *stop)		\

{									\

	while (rb != stop) {						\

		rbstruct *node = rb_entry(rb, rbstruct, rbfield);	\

		rbtype augmented = rbcompute(node);			\

		if (node->rbaugmented == augmented)			\

		RBSTRUCT *node = rb_entry(rb, RBSTRUCT, RBFIELD);	\

		RBTYPE augmented = RBCOMPUTE(node);			\

		if (node->RBAUGMENTED == augmented)			\

			break;						\

		node->rbaugmented = augmented;				\

		rb = rb_parent(&node->rbfield);				\

		node->RBAUGMENTED = augmented;				\

		rb = rb_parent(&node->RBFIELD);				\

	}								\

}									\

static inline void							\

rbname ## _copy(struct rb_node *rb_old, struct rb_node *rb_new)		\

RBNAME ## _copy(struct rb_node *rb_old, struct rb_node *rb_new)		\

{									\

	rbstruct *old = rb_entry(rb_old, rbstruct, rbfield);		\

	rbstruct *new = rb_entry(rb_new, rbstruct, rbfield);		\

	new->rbaugmented = old->rbaugmented;				\

	RBSTRUCT *old = rb_entry(rb_old, RBSTRUCT, RBFIELD);		\

	RBSTRUCT *new = rb_entry(rb_new, RBSTRUCT, RBFIELD);		\

	new->RBAUGMENTED = old->RBAUGMENTED;				\

}									\

static void								\

rbname ## _rotate(struct rb_node *rb_old, struct rb_node *rb_new)	\

RBNAME ## _rotate(struct rb_node *rb_old, struct rb_node *rb_new)	\

{									\

	rbstruct *old = rb_entry(rb_old, rbstruct, rbfield);		\

	rbstruct *new = rb_entry(rb_new, rbstruct, rbfield);		\

	new->rbaugmented = old->rbaugmented;				\

	old->rbaugmented = rbcompute(old);				\

	RBSTRUCT *old = rb_entry(rb_old, RBSTRUCT, RBFIELD);		\

	RBSTRUCT *new = rb_entry(rb_new, RBSTRUCT, RBFIELD);		\

	new->RBAUGMENTED = old->RBAUGMENTED;				\

	old->RBAUGMENTED = RBCOMPUTE(old);				\

}									\

rbstatic const struct rb_augment_callbacks rbname = {			\

	.propagate = rbname ## _propagate,				\

	.copy = rbname ## _copy,					\

	.rotate = rbname ## _rotate					\

RBSTATIC const struct rb_augment_callbacks RBNAME = {			\

	.propagate = RBNAME ## _propagate,				\

	.copy = RBNAME ## _copy,					\

	.rotate = RBNAME ## _rotate					\

};

CRA Git | Maintained and supported by SUSTech CRA and CCSE