2N/A/*
2N/A * CDDL HEADER START
2N/A *
2N/A * The contents of this file are subject to the terms of the
2N/A * Common Development and Distribution License (the "License").
2N/A * You may not use this file except in compliance with the License.
2N/A *
2N/A * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
2N/A * or http://www.opensolaris.org/os/licensing.
2N/A * See the License for the specific language governing permissions
2N/A * and limitations under the License.
2N/A *
2N/A * When distributing Covered Code, include this CDDL HEADER in each
2N/A * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
2N/A * If applicable, add the following below this CDDL HEADER, with the
2N/A * fields enclosed by brackets "[]" replaced with your own identifying
2N/A * information: Portions Copyright [yyyy] [name of copyright owner]
2N/A *
2N/A * CDDL HEADER END
2N/A */
2N/A/*
2N/A * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
2N/A * Use is subject to license terms.
2N/A */
2N/A
2N/A#pragma ident "%Z%%M% %I% %E% SMI"
2N/A
2N/A#include "libuutil_common.h"
2N/A
2N/A#include <stdlib.h>
2N/A#include <string.h>
2N/A#include <unistd.h>
2N/A#include <sys/avl.h>
2N/A
2N/Astatic uu_avl_pool_t uu_null_apool = { &uu_null_apool, &uu_null_apool };
2N/Astatic pthread_mutex_t uu_apool_list_lock = PTHREAD_MUTEX_INITIALIZER;
2N/A
2N/A/*
2N/A * The index mark change on every insert and delete, to catch stale
2N/A * references.
2N/A *
2N/A * We leave the low bit alone, since the avl code uses it.
2N/A */
2N/A#define INDEX_MAX (sizeof (uintptr_t) - 2)
2N/A#define INDEX_NEXT(m) (((m) == INDEX_MAX)? 2 : ((m) + 2) & INDEX_MAX)
2N/A
2N/A#define INDEX_DECODE(i) ((i) & ~INDEX_MAX)
2N/A#define INDEX_ENCODE(p, n) (((n) & ~INDEX_MAX) | (p)->ua_index)
2N/A#define INDEX_VALID(p, i) (((i) & INDEX_MAX) == (p)->ua_index)
2N/A#define INDEX_CHECK(i) (((i) & INDEX_MAX) != 0)
2N/A
2N/A/*
2N/A * When an element is inactive (not in a tree), we keep a marked pointer to
2N/A * its containing pool in its first word, and a NULL pointer in its second.
2N/A *
2N/A * On insert, we use these to verify that it comes from the correct pool.
2N/A */
2N/A#define NODE_ARRAY(p, n) ((uintptr_t *)((uintptr_t)(n) + \
2N/A (pp)->uap_nodeoffset))
2N/A
2N/A#define POOL_TO_MARKER(pp) (((uintptr_t)(pp) | 1))
2N/A
2N/A#define DEAD_MARKER 0xc4
2N/A
2N/Auu_avl_pool_t *
2N/Auu_avl_pool_create(const char *name, size_t objsize, size_t nodeoffset,
2N/A uu_compare_fn_t *compare_func, uint32_t flags)
2N/A{
2N/A uu_avl_pool_t *pp, *next, *prev;
2N/A
2N/A if (name == NULL ||
2N/A uu_check_name(name, UU_NAME_DOMAIN) == -1 ||
2N/A nodeoffset + sizeof (uu_avl_node_t) > objsize ||
2N/A compare_func == NULL) {
2N/A uu_set_error(UU_ERROR_INVALID_ARGUMENT);
2N/A return (NULL);
2N/A }
2N/A
2N/A if (flags & ~UU_AVL_POOL_DEBUG) {
2N/A uu_set_error(UU_ERROR_UNKNOWN_FLAG);
2N/A return (NULL);
2N/A }
2N/A
2N/A pp = uu_zalloc(sizeof (uu_avl_pool_t));
2N/A if (pp == NULL) {
2N/A uu_set_error(UU_ERROR_NO_MEMORY);
2N/A return (NULL);
2N/A }
2N/A
2N/A (void) strlcpy(pp->uap_name, name, sizeof (pp->uap_name));
2N/A pp->uap_nodeoffset = nodeoffset;
2N/A pp->uap_objsize = objsize;
2N/A pp->uap_cmp = compare_func;
2N/A if (flags & UU_AVL_POOL_DEBUG)
2N/A pp->uap_debug = 1;
2N/A pp->uap_last_index = 0;
2N/A
2N/A (void) pthread_mutex_init(&pp->uap_lock, NULL);
2N/A
2N/A pp->uap_null_avl.ua_next_enc = UU_PTR_ENCODE(&pp->uap_null_avl);
2N/A pp->uap_null_avl.ua_prev_enc = UU_PTR_ENCODE(&pp->uap_null_avl);
2N/A
2N/A (void) pthread_mutex_lock(&uu_apool_list_lock);
2N/A pp->uap_next = next = &uu_null_apool;
2N/A pp->uap_prev = prev = next->uap_prev;
2N/A next->uap_prev = pp;
2N/A prev->uap_next = pp;
2N/A (void) pthread_mutex_unlock(&uu_apool_list_lock);
2N/A
2N/A return (pp);
2N/A}
2N/A
2N/Avoid
2N/Auu_avl_pool_destroy(uu_avl_pool_t *pp)
2N/A{
2N/A if (pp->uap_debug) {
2N/A if (pp->uap_null_avl.ua_next_enc !=
2N/A UU_PTR_ENCODE(&pp->uap_null_avl) ||
2N/A pp->uap_null_avl.ua_prev_enc !=
2N/A UU_PTR_ENCODE(&pp->uap_null_avl)) {
2N/A uu_panic("uu_avl_pool_destroy: Pool \"%.*s\" (%p) has "
2N/A "outstanding avls, or is corrupt.\n",
2N/A (int)sizeof (pp->uap_name), pp->uap_name,
2N/A (void *)pp);
2N/A }
2N/A }
2N/A (void) pthread_mutex_lock(&uu_apool_list_lock);
2N/A pp->uap_next->uap_prev = pp->uap_prev;
2N/A pp->uap_prev->uap_next = pp->uap_next;
2N/A (void) pthread_mutex_unlock(&uu_apool_list_lock);
2N/A pp->uap_prev = NULL;
2N/A pp->uap_next = NULL;
2N/A uu_free(pp);
2N/A}
2N/A
2N/Avoid
2N/Auu_avl_node_init(void *base, uu_avl_node_t *np, uu_avl_pool_t *pp)
2N/A{
2N/A uintptr_t *na = (uintptr_t *)np;
2N/A
2N/A if (pp->uap_debug) {
2N/A uintptr_t offset = (uintptr_t)np - (uintptr_t)base;
2N/A if (offset + sizeof (*np) > pp->uap_objsize) {
2N/A uu_panic("uu_avl_node_init(%p, %p, %p (\"%s\")): "
2N/A "offset %ld doesn't fit in object (size %ld)\n",
2N/A base, (void *)np, (void *)pp, pp->uap_name,
2N/A (long)offset, (long)pp->uap_objsize);
2N/A }
2N/A if (offset != pp->uap_nodeoffset) {
2N/A uu_panic("uu_avl_node_init(%p, %p, %p (\"%s\")): "
2N/A "offset %ld doesn't match pool's offset (%ld)\n",
2N/A base, (void *)np, (void *)pp, pp->uap_name,
2N/A (long)offset, (long)pp->uap_objsize);
2N/A }
2N/A }
2N/A
2N/A na[0] = POOL_TO_MARKER(pp);
2N/A na[1] = 0;
2N/A}
2N/A
2N/Avoid
2N/Auu_avl_node_fini(void *base, uu_avl_node_t *np, uu_avl_pool_t *pp)
2N/A{
2N/A uintptr_t *na = (uintptr_t *)np;
2N/A
2N/A if (pp->uap_debug) {
2N/A if (na[0] == DEAD_MARKER && na[1] == DEAD_MARKER) {
2N/A uu_panic("uu_avl_node_fini(%p, %p, %p (\"%s\")): "
2N/A "node already finied\n",
2N/A base, (void *)np, (void *)pp, pp->uap_name);
2N/A }
2N/A if (na[0] != POOL_TO_MARKER(pp) || na[1] != 0) {
2N/A uu_panic("uu_avl_node_fini(%p, %p, %p (\"%s\")): "
2N/A "node corrupt, in tree, or in different pool\n",
2N/A base, (void *)np, (void *)pp, pp->uap_name);
2N/A }
2N/A }
2N/A
2N/A na[0] = DEAD_MARKER;
2N/A na[1] = DEAD_MARKER;
2N/A na[2] = DEAD_MARKER;
2N/A}
2N/A
2N/Astruct uu_avl_node_compare_info {
2N/A uu_compare_fn_t *ac_compare;
2N/A void *ac_private;
2N/A void *ac_right;
2N/A void *ac_found;
2N/A};
2N/A
2N/Astatic int
2N/Auu_avl_node_compare(const void *l, const void *r)
2N/A{
2N/A struct uu_avl_node_compare_info *info =
2N/A (struct uu_avl_node_compare_info *)l;
2N/A
2N/A int res = info->ac_compare(r, info->ac_right, info->ac_private);
2N/A
2N/A if (res == 0) {
2N/A if (info->ac_found == NULL)
2N/A info->ac_found = (void *)r;
2N/A return (-1);
2N/A }
2N/A if (res < 0)
2N/A return (1);
2N/A return (-1);
2N/A}
2N/A
2N/Auu_avl_t *
2N/Auu_avl_create(uu_avl_pool_t *pp, void *parent, uint32_t flags)
2N/A{
2N/A uu_avl_t *ap, *next, *prev;
2N/A
2N/A if (flags & ~UU_AVL_DEBUG) {
2N/A uu_set_error(UU_ERROR_UNKNOWN_FLAG);
2N/A return (NULL);
2N/A }
2N/A
2N/A ap = uu_zalloc(sizeof (*ap));
2N/A if (ap == NULL) {
2N/A uu_set_error(UU_ERROR_NO_MEMORY);
2N/A return (NULL);
2N/A }
2N/A
2N/A ap->ua_pool = pp;
2N/A ap->ua_parent_enc = UU_PTR_ENCODE(parent);
2N/A ap->ua_debug = pp->uap_debug || (flags & UU_AVL_DEBUG);
2N/A ap->ua_index = (pp->uap_last_index = INDEX_NEXT(pp->uap_last_index));
2N/A
2N/A avl_create(&ap->ua_tree, &uu_avl_node_compare, pp->uap_objsize,
2N/A pp->uap_nodeoffset);
2N/A
2N/A ap->ua_null_walk.uaw_next = &ap->ua_null_walk;
2N/A ap->ua_null_walk.uaw_prev = &ap->ua_null_walk;
2N/A
2N/A (void) pthread_mutex_lock(&pp->uap_lock);
2N/A next = &pp->uap_null_avl;
2N/A prev = UU_PTR_DECODE(next->ua_prev_enc);
2N/A ap->ua_next_enc = UU_PTR_ENCODE(next);
2N/A ap->ua_prev_enc = UU_PTR_ENCODE(prev);
2N/A next->ua_prev_enc = UU_PTR_ENCODE(ap);
2N/A prev->ua_next_enc = UU_PTR_ENCODE(ap);
2N/A (void) pthread_mutex_unlock(&pp->uap_lock);
2N/A
2N/A return (ap);
2N/A}
2N/A
2N/Avoid
2N/Auu_avl_destroy(uu_avl_t *ap)
2N/A{
2N/A uu_avl_pool_t *pp = ap->ua_pool;
2N/A
2N/A if (ap->ua_debug) {
2N/A if (avl_numnodes(&ap->ua_tree) != 0) {
2N/A uu_panic("uu_avl_destroy(%p): tree not empty\n",
2N/A (void *)ap);
2N/A }
2N/A if (ap->ua_null_walk.uaw_next != &ap->ua_null_walk ||
2N/A ap->ua_null_walk.uaw_prev != &ap->ua_null_walk) {
2N/A uu_panic("uu_avl_destroy(%p): outstanding walkers\n",
2N/A (void *)ap);
2N/A }
2N/A }
2N/A (void) pthread_mutex_lock(&pp->uap_lock);
2N/A UU_AVL_PTR(ap->ua_next_enc)->ua_prev_enc = ap->ua_prev_enc;
2N/A UU_AVL_PTR(ap->ua_prev_enc)->ua_next_enc = ap->ua_next_enc;
2N/A (void) pthread_mutex_unlock(&pp->uap_lock);
2N/A ap->ua_prev_enc = UU_PTR_ENCODE(NULL);
2N/A ap->ua_next_enc = UU_PTR_ENCODE(NULL);
2N/A
2N/A ap->ua_pool = NULL;
2N/A avl_destroy(&ap->ua_tree);
2N/A
2N/A uu_free(ap);
2N/A}
2N/A
2N/Asize_t
2N/Auu_avl_numnodes(uu_avl_t *ap)
2N/A{
2N/A return (avl_numnodes(&ap->ua_tree));
2N/A}
2N/A
2N/Avoid *
2N/Auu_avl_first(uu_avl_t *ap)
2N/A{
2N/A return (avl_first(&ap->ua_tree));
2N/A}
2N/A
2N/Avoid *
2N/Auu_avl_last(uu_avl_t *ap)
2N/A{
2N/A return (avl_last(&ap->ua_tree));
2N/A}
2N/A
2N/Avoid *
2N/Auu_avl_next(uu_avl_t *ap, void *node)
2N/A{
2N/A return (AVL_NEXT(&ap->ua_tree, node));
2N/A}
2N/A
2N/Avoid *
2N/Auu_avl_prev(uu_avl_t *ap, void *node)
2N/A{
2N/A return (AVL_PREV(&ap->ua_tree, node));
2N/A}
2N/A
2N/Astatic void
2N/A_avl_walk_init(uu_avl_walk_t *wp, uu_avl_t *ap, uint32_t flags)
2N/A{
2N/A uu_avl_walk_t *next, *prev;
2N/A
2N/A int robust = (flags & UU_WALK_ROBUST);
2N/A int direction = (flags & UU_WALK_REVERSE)? -1 : 1;
2N/A
2N/A (void) memset(wp, 0, sizeof (*wp));
2N/A wp->uaw_avl = ap;
2N/A wp->uaw_robust = robust;
2N/A wp->uaw_dir = direction;
2N/A
2N/A if (direction > 0)
2N/A wp->uaw_next_result = avl_first(&ap->ua_tree);
2N/A else
2N/A wp->uaw_next_result = avl_last(&ap->ua_tree);
2N/A
2N/A if (ap->ua_debug || robust) {
2N/A wp->uaw_next = next = &ap->ua_null_walk;
2N/A wp->uaw_prev = prev = next->uaw_prev;
2N/A next->uaw_prev = wp;
2N/A prev->uaw_next = wp;
2N/A }
2N/A}
2N/A
2N/Astatic void *
2N/A_avl_walk_advance(uu_avl_walk_t *wp, uu_avl_t *ap)
2N/A{
2N/A void *np = wp->uaw_next_result;
2N/A
2N/A avl_tree_t *t = &ap->ua_tree;
2N/A
2N/A if (np == NULL)
2N/A return (NULL);
2N/A
2N/A wp->uaw_next_result = (wp->uaw_dir > 0)? AVL_NEXT(t, np) :
2N/A AVL_PREV(t, np);
2N/A
2N/A return (np);
2N/A}
2N/A
2N/Astatic void
2N/A_avl_walk_fini(uu_avl_walk_t *wp)
2N/A{
2N/A if (wp->uaw_next != NULL) {
2N/A wp->uaw_next->uaw_prev = wp->uaw_prev;
2N/A wp->uaw_prev->uaw_next = wp->uaw_next;
2N/A wp->uaw_next = NULL;
2N/A wp->uaw_prev = NULL;
2N/A }
2N/A wp->uaw_avl = NULL;
2N/A wp->uaw_next_result = NULL;
2N/A}
2N/A
2N/Auu_avl_walk_t *
2N/Auu_avl_walk_start(uu_avl_t *ap, uint32_t flags)
2N/A{
2N/A uu_avl_walk_t *wp;
2N/A
2N/A if (flags & ~(UU_WALK_ROBUST | UU_WALK_REVERSE)) {
2N/A uu_set_error(UU_ERROR_UNKNOWN_FLAG);
2N/A return (NULL);
2N/A }
2N/A
2N/A wp = uu_zalloc(sizeof (*wp));
2N/A if (wp == NULL) {
2N/A uu_set_error(UU_ERROR_NO_MEMORY);
2N/A return (NULL);
2N/A }
2N/A
2N/A _avl_walk_init(wp, ap, flags);
2N/A return (wp);
2N/A}
2N/A
2N/Avoid *
2N/Auu_avl_walk_next(uu_avl_walk_t *wp)
2N/A{
2N/A return (_avl_walk_advance(wp, wp->uaw_avl));
2N/A}
2N/A
2N/Avoid
2N/Auu_avl_walk_end(uu_avl_walk_t *wp)
2N/A{
2N/A _avl_walk_fini(wp);
2N/A uu_free(wp);
2N/A}
2N/A
2N/Aint
2N/Auu_avl_walk(uu_avl_t *ap, uu_walk_fn_t *func, void *private, uint32_t flags)
2N/A{
2N/A void *e;
2N/A uu_avl_walk_t my_walk;
2N/A
2N/A int status = UU_WALK_NEXT;
2N/A
2N/A if (flags & ~(UU_WALK_ROBUST | UU_WALK_REVERSE)) {
2N/A uu_set_error(UU_ERROR_UNKNOWN_FLAG);
2N/A return (-1);
2N/A }
2N/A
2N/A _avl_walk_init(&my_walk, ap, flags);
2N/A while (status == UU_WALK_NEXT &&
2N/A (e = _avl_walk_advance(&my_walk, ap)) != NULL)
2N/A status = (*func)(e, private);
2N/A _avl_walk_fini(&my_walk);
2N/A
2N/A if (status >= 0)
2N/A return (0);
2N/A uu_set_error(UU_ERROR_CALLBACK_FAILED);
2N/A return (-1);
2N/A}
2N/A
2N/Avoid
2N/Auu_avl_remove(uu_avl_t *ap, void *elem)
2N/A{
2N/A uu_avl_walk_t *wp;
2N/A uu_avl_pool_t *pp = ap->ua_pool;
2N/A uintptr_t *na = NODE_ARRAY(pp, elem);
2N/A
2N/A if (ap->ua_debug) {
2N/A /*
2N/A * invalidate outstanding uu_avl_index_ts.
2N/A */
2N/A ap->ua_index = INDEX_NEXT(ap->ua_index);
2N/A }
2N/A
2N/A /*
2N/A * Robust walkers most be advanced, if we are removing the node
2N/A * they are currently using. In debug mode, non-robust walkers
2N/A * are also on the walker list.
2N/A */
2N/A for (wp = ap->ua_null_walk.uaw_next; wp != &ap->ua_null_walk;
2N/A wp = wp->uaw_next) {
2N/A if (wp->uaw_robust) {
2N/A if (elem == wp->uaw_next_result)
2N/A (void) _avl_walk_advance(wp, ap);
2N/A } else if (wp->uaw_next_result != NULL) {
2N/A uu_panic("uu_avl_remove(%p, %p): active non-robust "
2N/A "walker\n", (void *)ap, elem);
2N/A }
2N/A }
2N/A
2N/A avl_remove(&ap->ua_tree, elem);
2N/A
2N/A na[0] = POOL_TO_MARKER(pp);
2N/A na[1] = 0;
2N/A}
2N/A
2N/Avoid *
2N/Auu_avl_teardown(uu_avl_t *ap, void **cookie)
2N/A{
2N/A void *elem = avl_destroy_nodes(&ap->ua_tree, cookie);
2N/A
2N/A if (elem != NULL) {
2N/A uu_avl_pool_t *pp = ap->ua_pool;
2N/A uintptr_t *na = NODE_ARRAY(pp, elem);
2N/A
2N/A na[0] = POOL_TO_MARKER(pp);
2N/A na[1] = 0;
2N/A }
2N/A return (elem);
2N/A}
2N/A
2N/Avoid *
2N/Auu_avl_find(uu_avl_t *ap, void *elem, void *private, uu_avl_index_t *out)
2N/A{
2N/A struct uu_avl_node_compare_info info;
2N/A void *result;
2N/A
2N/A info.ac_compare = ap->ua_pool->uap_cmp;
2N/A info.ac_private = private;
2N/A info.ac_right = elem;
2N/A info.ac_found = NULL;
2N/A
2N/A result = avl_find(&ap->ua_tree, &info, out);
2N/A if (out != NULL)
2N/A *out = INDEX_ENCODE(ap, *out);
2N/A
2N/A if (ap->ua_debug && result != NULL)
2N/A uu_panic("uu_avl_find: internal error: avl_find succeeded\n");
2N/A
2N/A return (info.ac_found);
2N/A}
2N/A
2N/Avoid
2N/Auu_avl_insert(uu_avl_t *ap, void *elem, uu_avl_index_t idx)
2N/A{
2N/A if (ap->ua_debug) {
2N/A uu_avl_pool_t *pp = ap->ua_pool;
2N/A uintptr_t *na = NODE_ARRAY(pp, elem);
2N/A
2N/A if (na[1] != 0)
2N/A uu_panic("uu_avl_insert(%p, %p, %p): node already "
2N/A "in tree, or corrupt\n",
2N/A (void *)ap, elem, (void *)idx);
2N/A if (na[0] == 0)
2N/A uu_panic("uu_avl_insert(%p, %p, %p): node not "
2N/A "initialized\n",
2N/A (void *)ap, elem, (void *)idx);
2N/A if (na[0] != POOL_TO_MARKER(pp))
2N/A uu_panic("uu_avl_insert(%p, %p, %p): node from "
2N/A "other pool, or corrupt\n",
2N/A (void *)ap, elem, (void *)idx);
2N/A
2N/A if (!INDEX_VALID(ap, idx))
2N/A uu_panic("uu_avl_insert(%p, %p, %p): %s\n",
2N/A (void *)ap, elem, (void *)idx,
2N/A INDEX_CHECK(idx)? "outdated index" :
2N/A "invalid index");
2N/A
2N/A /*
2N/A * invalidate outstanding uu_avl_index_ts.
2N/A */
2N/A ap->ua_index = INDEX_NEXT(ap->ua_index);
2N/A }
2N/A avl_insert(&ap->ua_tree, elem, INDEX_DECODE(idx));
2N/A}
2N/A
2N/Avoid *
2N/Auu_avl_nearest_next(uu_avl_t *ap, uu_avl_index_t idx)
2N/A{
2N/A if (ap->ua_debug && !INDEX_VALID(ap, idx))
2N/A uu_panic("uu_avl_nearest_next(%p, %p): %s\n",
2N/A (void *)ap, (void *)idx, INDEX_CHECK(idx)?
2N/A "outdated index" : "invalid index");
2N/A return (avl_nearest(&ap->ua_tree, INDEX_DECODE(idx), AVL_AFTER));
2N/A}
2N/A
2N/Avoid *
2N/Auu_avl_nearest_prev(uu_avl_t *ap, uu_avl_index_t idx)
2N/A{
2N/A if (ap->ua_debug && !INDEX_VALID(ap, idx))
2N/A uu_panic("uu_avl_nearest_prev(%p, %p): %s\n",
2N/A (void *)ap, (void *)idx, INDEX_CHECK(idx)?
2N/A "outdated index" : "invalid index");
2N/A return (avl_nearest(&ap->ua_tree, INDEX_DECODE(idx), AVL_BEFORE));
2N/A}
2N/A
2N/A/*
2N/A * called from uu_lockup() and uu_release(), as part of our fork1()-safety.
2N/A */
2N/Avoid
2N/Auu_avl_lockup(void)
2N/A{
2N/A uu_avl_pool_t *pp;
2N/A
2N/A (void) pthread_mutex_lock(&uu_apool_list_lock);
2N/A for (pp = uu_null_apool.uap_next; pp != &uu_null_apool;
2N/A pp = pp->uap_next)
2N/A (void) pthread_mutex_lock(&pp->uap_lock);
2N/A}
2N/A
2N/Avoid
2N/Auu_avl_release(void)
2N/A{
2N/A uu_avl_pool_t *pp;
2N/A
2N/A for (pp = uu_null_apool.uap_next; pp != &uu_null_apool;
2N/A pp = pp->uap_next)
2N/A (void) pthread_mutex_unlock(&pp->uap_lock);
2N/A (void) pthread_mutex_unlock(&uu_apool_list_lock);
2N/A}