0
0
mirror of https://github.com/netwide-assembler/nasm.git synced 2025-07-24 10:25:42 -04:00
nasm/include/rbtree.h
H. Peter Anvin (Intel) 367350319b rbtree: implement a "threaded LLRB tree"
Change the left-leaning red-black (LLRB) trees into left-leaning
threaded red-black trees. Instead of NULL pointers at leaf nodes, use
the otherwise unused field as a pointer to the lexical predecessor
(left) or successor (right). This allows fast previous/next
interator operation without needing to keep track of the root of the
tree at all times.

The additional metadata that needs to be kept can be done for "free"
simply by changing "bool red" into a flag field.

Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-06-29 23:23:51 -07:00

83 lines
3.0 KiB
C

/* ----------------------------------------------------------------------- *
*
* Copyright 1996-2020 The NASM Authors - All Rights Reserved
* See the file AUTHORS included with the NASM distribution for
* the specific copyright holders.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following
* conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* ----------------------------------------------------------------------- */
#ifndef NASM_RBTREE_H
#define NASM_RBTREE_H
#include "compiler.h"
/*
* This structure should be embedded in a larger data structure;
* the final output from rb_search() can then be converted back
* to the larger data structure via container_of().
*
* An empty tree is simply represented by a NULL pointer.
*/
/* Note: the values of these flags is significant */
enum rbtree_node_flags {
RBTREE_NODE_BLACK = 1, /* Node color is black */
RBTREE_NODE_PRED = 2, /* Left pointer is an uplink */
RBTREE_NODE_SUCC = 4 /* Right pointer is an uplink */
};
struct rbtree {
uint64_t key;
struct rbtree_metadata {
struct rbtree *left, *right;
enum rbtree_node_flags flags;
} m;
};
/*
* Add a node to a tree. Returns the new root pointer.
* The key value in the structure needs to be preinitialized;
* the rest of the structure should be zero.
*/
struct rbtree *rb_insert(struct rbtree *, struct rbtree *);
/*
* Find a node in the tree corresponding to the key immediately
* <= the passed-in key value.
*/
struct rbtree *rb_search(const struct rbtree *, uint64_t);
/*
* Return the immediately previous or next node in key order.
* Returns NULL if this node is the end of the
*/
struct rbtree *rb_prev(const struct rbtree *);
struct rbtree *rb_next(const struct rbtree *);
#endif /* NASM_RBTREE_H */