0
0
mirror of https://github.com/netwide-assembler/nasm.git synced 2025-10-10 00:25:06 -04:00
Files
nasm/include/rbtree.h
H. Peter Anvin 23ce05f906 treewide: replace verbose copyright headers with SPDX tags
SPDX is an international standard for documenting software license
requirements. Remove the existing headers and replace with a brief
SPDX preamble.

See: https://spdx.dev/use/specifications/

The script used to convert the files is added to "tools", and the
file header templates in headers/ are updated.

Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2025-10-01 11:45:31 -07:00

79 lines
2.3 KiB
C

/* SPDX-License-Identifier: BSD-2-Clause */
/* Copyright 1996-2020 The NASM Authors - All Rights Reserved */
#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 * pure_func rb_search(const struct rbtree *, uint64_t);
/*
* Find a node in the tree exactly matching the key value.
*/
struct rbtree * pure_func rb_search_exact(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 tree.
* These operations are safe for complete (but not partial!)
* tree walk-with-destruction in key order.
*/
struct rbtree * pure_func rb_prev(const struct rbtree *);
struct rbtree * pure_func rb_next(const struct rbtree *);
/*
* Return the very first or very last node in key order.
*/
struct rbtree * pure_func rb_first(const struct rbtree *);
struct rbtree * pure_func rb_last(const struct rbtree *);
/*
* Left and right nodes, if real. These operations are
* safe for tree destruction, but not for splitting a tree.
*/
static inline struct rbtree *rb_left(const struct rbtree *rb)
{
return (rb->m.flags & RBTREE_NODE_PRED) ? NULL : rb->m.left;
}
static inline struct rbtree *rb_right(const struct rbtree *rb)
{
return (rb->m.flags & RBTREE_NODE_SUCC) ? NULL : rb->m.right;
}
#endif /* NASM_RBTREE_H */