mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-12 13:55:32 +00:00
![Michel Lespinasse](/assets/img/avatar_default.png)
I recently started looking at the rbtree code (with an eye towards improving the augmented rbtree support, but I haven't gotten there yet). I noticed a lot of possible speed improvements, which I am now proposing in this patch set. Patches 1-4 are preparatory: remove internal functions from rbtree.h so that users won't be tempted to use them instead of the documented APIs, clean up some incorrect usages I've noticed (in particular, with the recently added fs/proc/proc_sysctl.c rbtree usage), reference the documentation so that people have one less excuse to miss it, etc. Patch 5 is a small module I wrote to check the rbtree performance. It creates 100 nodes with random keys and repeatedly inserts and erases them from an rbtree. Additionally, it has code to check for rbtree invariants after each insert or erase operation. Patches 6-12 is where the rbtree optimizations are done, and they touch only that one file, lib/rbtree.c . I am getting good results out of these - in my small benchmark doing rbtree insertion (including search) and erase, I'm seeing a 30% runtime reduction on Sandybridge E5, which is more than I initially thought would be possible. (the results aren't as impressive on my two other test hosts though, AMD barcelona and Intel Westmere, where I am seeing 14% runtime reduction only). The code size - both source (ommiting comments) and compiled - is also shorter after these changes. However, I do admit that the updated code is more arduous to read - one big reason for that is the removal of the tree rotation helpers, which added some overhead but also made it easier to reason about things locally. Overall, I believe this is an acceptable compromise, given that this code doesn't get modified very often, and that I have good tests for it. Upon Peter's suggestion, I added comments showing the rtree configuration before every rotation. I think they help; however it's still best to have a copy of the cormen/leiserson/rivest book when digging into this code. This patch: reference Documentation/rbtree.txt for usage instructions include/linux/rbtree.h included some basic usage instructions, while Documentation/rbtree.txt had some more complete and easier to follow instructions. Replacing the former with a reference to the latter. Signed-off-by: Michel Lespinasse <walken@google.com> Cc: Andrea Arcangeli <aarcange@redhat.com> Acked-by: David Woodhouse <David.Woodhouse@intel.com> Cc: Rik van Riel <riel@redhat.com> Cc: Peter Zijlstra <a.p.zijlstra@chello.nl> Cc: Daniel Santos <daniel.santos@pobox.com> Cc: Jens Axboe <axboe@kernel.dk> Cc: "Eric W. Biederman" <ebiederm@xmission.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
112 lines
3.6 KiB
C
112 lines
3.6 KiB
C
/*
|
|
Red Black Trees
|
|
(C) 1999 Andrea Arcangeli <andrea@suse.de>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
linux/include/linux/rbtree.h
|
|
|
|
To use rbtrees you'll have to implement your own insert and search cores.
|
|
This will avoid us to use callbacks and to drop drammatically performances.
|
|
I know it's not the cleaner way, but in C (not in C++) to get
|
|
performances and genericity...
|
|
|
|
See Documentation/rbtree.txt for documentation and samples.
|
|
*/
|
|
|
|
#ifndef _LINUX_RBTREE_H
|
|
#define _LINUX_RBTREE_H
|
|
|
|
#include <linux/kernel.h>
|
|
#include <linux/stddef.h>
|
|
|
|
struct rb_node
|
|
{
|
|
unsigned long rb_parent_color;
|
|
#define RB_RED 0
|
|
#define RB_BLACK 1
|
|
struct rb_node *rb_right;
|
|
struct rb_node *rb_left;
|
|
} __attribute__((aligned(sizeof(long))));
|
|
/* The alignment might seem pointless, but allegedly CRIS needs it */
|
|
|
|
struct rb_root
|
|
{
|
|
struct rb_node *rb_node;
|
|
};
|
|
|
|
|
|
#define rb_parent(r) ((struct rb_node *)((r)->rb_parent_color & ~3))
|
|
#define rb_color(r) ((r)->rb_parent_color & 1)
|
|
#define rb_is_red(r) (!rb_color(r))
|
|
#define rb_is_black(r) rb_color(r)
|
|
#define rb_set_red(r) do { (r)->rb_parent_color &= ~1; } while (0)
|
|
#define rb_set_black(r) do { (r)->rb_parent_color |= 1; } while (0)
|
|
|
|
static inline void rb_set_parent(struct rb_node *rb, struct rb_node *p)
|
|
{
|
|
rb->rb_parent_color = (rb->rb_parent_color & 3) | (unsigned long)p;
|
|
}
|
|
static inline void rb_set_color(struct rb_node *rb, int color)
|
|
{
|
|
rb->rb_parent_color = (rb->rb_parent_color & ~1) | color;
|
|
}
|
|
|
|
#define RB_ROOT (struct rb_root) { NULL, }
|
|
#define rb_entry(ptr, type, member) container_of(ptr, type, member)
|
|
|
|
#define RB_EMPTY_ROOT(root) ((root)->rb_node == NULL)
|
|
#define RB_EMPTY_NODE(node) (rb_parent(node) == node)
|
|
#define RB_CLEAR_NODE(node) (rb_set_parent(node, node))
|
|
|
|
static inline void rb_init_node(struct rb_node *rb)
|
|
{
|
|
rb->rb_parent_color = 0;
|
|
rb->rb_right = NULL;
|
|
rb->rb_left = NULL;
|
|
RB_CLEAR_NODE(rb);
|
|
}
|
|
|
|
extern void rb_insert_color(struct rb_node *, struct rb_root *);
|
|
extern void rb_erase(struct rb_node *, struct rb_root *);
|
|
|
|
typedef void (*rb_augment_f)(struct rb_node *node, void *data);
|
|
|
|
extern void rb_augment_insert(struct rb_node *node,
|
|
rb_augment_f func, void *data);
|
|
extern struct rb_node *rb_augment_erase_begin(struct rb_node *node);
|
|
extern void rb_augment_erase_end(struct rb_node *node,
|
|
rb_augment_f func, void *data);
|
|
|
|
/* Find logical next and previous nodes in a tree */
|
|
extern struct rb_node *rb_next(const struct rb_node *);
|
|
extern struct rb_node *rb_prev(const struct rb_node *);
|
|
extern struct rb_node *rb_first(const struct rb_root *);
|
|
extern struct rb_node *rb_last(const struct rb_root *);
|
|
|
|
/* Fast replacement of a single node without remove/rebalance/add/rebalance */
|
|
extern void rb_replace_node(struct rb_node *victim, struct rb_node *new,
|
|
struct rb_root *root);
|
|
|
|
static inline void rb_link_node(struct rb_node * node, struct rb_node * parent,
|
|
struct rb_node ** rb_link)
|
|
{
|
|
node->rb_parent_color = (unsigned long )parent;
|
|
node->rb_left = node->rb_right = NULL;
|
|
|
|
*rb_link = node;
|
|
}
|
|
|
|
#endif /* _LINUX_RBTREE_H */
|