/*      $NetBSD: prop_rb_impl.h,v 1.4 2006/09/09 15:19:18 thorpej Exp $ */

/*-
* Copyright (c) 2001 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Matt Thomas <[email protected]>.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
* 2. 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.
* 3. All advertising materials mentioning features or use of this software
*    must display the following acknowledgement:
*        This product includes software developed by the NetBSD
*        Foundation, Inc. and its contributors.
* 4. Neither the name of The NetBSD Foundation nor the names of its
*    contributors may be used to endorse or promote products derived
*    from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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 _PROP_RB_IMPL_H_
#define _PROP_RB_IMPL_H_

#include <sys/types.h>
#include <sys/queue.h>
#include <machine/endian.h>

struct rb_node {
       struct rb_node *rb_nodes[3];
#define RB_NODE_LEFT            0
#define RB_NODE_RIGHT           1
#define RB_NODE_OTHER           1
#define RB_NODE_PARENT          2
#define rb_left         rb_nodes[RB_NODE_LEFT]
#define rb_right        rb_nodes[RB_NODE_RIGHT]
#define rb_parent       rb_nodes[RB_NODE_PARENT]
       union {
               struct {
#if BYTE_ORDER == LITTLE_ENDIAN
                       unsigned int : 28;
                       unsigned int s_root : 1;
                       unsigned int s_position : 1;
                       unsigned int s_color : 1;
                       unsigned int s_sentinel : 1;
#endif
#if BYTE_ORDER == BIG_ENDIAN
                       unsigned int s_sentinel : 1;
                       unsigned int s_color : 1;
                       unsigned int s_position : 1;
                       unsigned int s_root : 1;
                       unsigned int : 28;
#endif
               } u_s;
               unsigned int u_i;
       } rb_u;
#define rb_root                         rb_u.u_s.s_root
#define rb_position                     rb_u.u_s.s_position
#define rb_color                        rb_u.u_s.s_color
#define rb_sentinel                     rb_u.u_s.s_sentinel
#define rb_properties                   rb_u.u_i
#define RB_SENTINEL_P(rb)               ((rb)->rb_sentinel + 0)
#define RB_LEFT_SENTINEL_P(rb)          ((rb)->rb_left->rb_sentinel + 0)
#define RB_RIGHT_SENTINEL_P(rb)         ((rb)->rb_right->rb_sentinel + 0)
#define RB_PARENT_SENTINEL_P(rb)        ((rb)->rb_parent->rb_sentinel + 0)
#define RB_CHILDLESS_P(rb)              (RB_LEFT_SENTINEL_P(rb) \
                                        && RB_RIGHT_SENTINEL_P(rb))
#define RB_TWOCHILDREN_P(rb)            (!RB_LEFT_SENTINEL_P(rb) \
                                        && !RB_RIGHT_SENTINEL_P(rb))
#define RB_ROOT_P(rb)                   ((rb)->rb_root != false)
#define RB_RED_P(rb)                    ((rb)->rb_color + 0)
#define RB_BLACK_P(rb)                  (!(rb)->rb_color)
#define RB_MARK_RED(rb)                 ((void)((rb)->rb_color = 1))
#define RB_MARK_BLACK(rb)               ((void)((rb)->rb_color = 0))
#define RB_MARK_ROOT(rb)                ((void)((rb)->rb_root = 1))
#ifdef RBDEBUG
       TAILQ_ENTRY(rb_node) rb_link;
#endif
};

#ifdef RBDEBUG
TAILQ_HEAD(rb_node_qh, rb_node);

#define RB_TAILQ_REMOVE                         TAILQ_REMOVE
#define RB_TAILQ_INIT                           TAILQ_INIT
#define RB_TAILQ_INSERT_HEAD(a, b, c)           TAILQ_INSERT_HEAD
#define RB_TAILQ_INSERT_BEFORE(a, b, c)         TAILQ_INSERT_BEFORE
#define RB_TAILQ_INSERT_AFTER(a, b, c, d)       TAILQ_INSERT_AFTER
#else
#define RB_TAILQ_REMOVE(a, b, c)                do { } while (/*CONSTCOND*/0)
#define RB_TAILQ_INIT(a)                        do { } while (/*CONSTCOND*/0)
#define RB_TAILQ_INSERT_HEAD(a, b, c)           do { } while (/*CONSTCOND*/0)
#define RB_TAILQ_INSERT_BEFORE(a, b, c)         do { } while (/*CONSTCOND*/0)
#define RB_TAILQ_INSERT_AFTER(a, b, c, d)       do { } while (/*CONSTCOND*/0)
#endif

typedef int (*rb_compare_nodes_fn)(const struct rb_node *,
   const struct rb_node *);
typedef int (*rb_compare_key_fn)(const struct rb_node *, const void *);

struct rb_tree_ops {
       rb_compare_nodes_fn     rbto_compare_nodes;
       rb_compare_key_fn       rbto_compare_key;
};

struct rb_tree {
       struct rb_node *rbt_root;
#ifdef RBDEBUG
       struct rb_node_qh rbt_nodes;
#endif
       const struct rb_tree_ops *rbt_ops;
#ifdef RBDEBUG
       unsigned int rbt_count;
#endif
};

void    _prop_rb_tree_init(struct rb_tree *, const struct rb_tree_ops *);
void    _prop_rb_tree_insert_node(struct rb_tree *, struct rb_node *);
struct rb_node  *
       _prop_rb_tree_find(struct rb_tree *, const void *);
void    _prop_rb_tree_remove_node(struct rb_tree *, struct rb_node *);
#ifdef RBDEBUG
void    _prop_rb_tree_check(const struct rb_tree *, bool);
#endif
struct rb_node *
       _prop_rb_tree_iterate(struct rb_tree *, struct rb_node *, unsigned int);

#endif  /* _PROP_RB_IMPL_H_*/