xref: /src/sys/external/bsd/drm2/linux/linux_idr.c

/*	$NetBSD: linux_idr.c,v 1.1.2.12 2014/01/15 13:51:58 riastradh Exp $	*/

/*-
 * Copyright (c) 2013 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Taylor R. Campbell.
 *
 * 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.
 *
 * 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.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: linux_idr.c,v 1.1.2.12 2014/01/15 13:51:58 riastradh Exp $");

#include <sys/param.h>
#include <sys/atomic.h>
#include <sys/kmem.h>
#include <sys/rbtree.h>

#include <linux/err.h>
#include <linux/idr.h>

struct idr_node {
	rb_node_t in_rb_node;
	int in_index;
	void *in_data;
};

static signed int idr_tree_compare_nodes(void *, const void *, const void *);
static signed int idr_tree_compare_key(void *, const void *, const void *);

static const rb_tree_ops_t idr_rb_ops = {
	.rbto_compare_nodes = &idr_tree_compare_nodes,
	.rbto_compare_key = &idr_tree_compare_key,
	.rbto_node_offset = offsetof(struct idr_node, in_rb_node),
	.rbto_context = NULL,
};

static signed int
idr_tree_compare_nodes(void *ctx __unused, const void *na, const void *nb)
{
	const int a = ((const struct idr_node *)na)->in_index;
	const int b = ((const struct idr_node *)nb)->in_index;

	if (a < b)
		return -1;
	else if (b < a)
		 return +1;
	else
		return 0;
}

static signed int
idr_tree_compare_key(void *ctx __unused, const void *n, const void *key)
{
	const int a = ((const struct idr_node *)n)->in_index;
	const int b = *(const int *)key;

	if (a < b)
		return -1;
	else if (b < a)
		return +1;
	else
		return 0;
}

void
idr_init(struct idr *idr)
{

	mutex_init(&idr->idr_lock, MUTEX_DEFAULT, IPL_VM);
	rb_tree_init(&idr->idr_tree, &idr_rb_ops);
	idr->idr_temp = NULL;
}

void
idr_destroy(struct idr *idr)
{

	if (idr->idr_temp != NULL) {
		/* XXX Probably shouldn't happen.  */
		kmem_free(idr->idr_temp, sizeof(*idr->idr_temp));
		idr->idr_temp = NULL;
	}
#if 0				/* XXX No rb_tree_destroy?  */
	rb_tree_destroy(&idr->idr_tree);
#endif
	mutex_destroy(&idr->idr_lock);
}

void *
idr_find(struct idr *idr, int id)
{
	const struct idr_node *node;
	void *data;

	mutex_spin_enter(&idr->idr_lock);
	node = rb_tree_find_node(&idr->idr_tree, &id);
	data = (node == NULL? NULL : node->in_data);
	mutex_spin_exit(&idr->idr_lock);

	return data;
}

void *
idr_replace(struct idr *idr, void *replacement, int id)
{
	struct idr_node *node;
	void *result;

	mutex_spin_enter(&idr->idr_lock);
	node = rb_tree_find_node(&idr->idr_tree, &id);
	if (node == NULL) {
		result = ERR_PTR(-ENOENT);
	} else {
		result = node->in_data;
		node->in_data = replacement;
	}
	mutex_spin_exit(&idr->idr_lock);

	return result;
}

void
idr_remove(struct idr *idr, int id)
{
	struct idr_node *node;

	mutex_spin_enter(&idr->idr_lock);
	node = rb_tree_find_node(&idr->idr_tree, &id);
	KASSERT(node != NULL);
	rb_tree_remove_node(&idr->idr_tree, node);
	mutex_spin_exit(&idr->idr_lock);
	kmem_free(node, sizeof(*node));
}

void
idr_remove_all(struct idr *idr)
{
	struct idr_node *node;

	mutex_spin_enter(&idr->idr_lock);
	while ((node = RB_TREE_MIN(&idr->idr_tree)) != NULL) {
		rb_tree_remove_node(&idr->idr_tree, node);
		mutex_spin_exit(&idr->idr_lock);
		kmem_free(node, sizeof(*node));
		mutex_spin_enter(&idr->idr_lock);
	}
	mutex_spin_exit(&idr->idr_lock);
}

int
idr_pre_get(struct idr *idr, int flags __unused /* XXX */)
{
	struct idr_node *temp = kmem_alloc(sizeof(*temp), KM_SLEEP);

	mutex_spin_enter(&idr->idr_lock);
	if (idr->idr_temp == NULL) {
		idr->idr_temp = temp;
		temp = NULL;
	}
	mutex_spin_exit(&idr->idr_lock);

	if (temp != NULL)
		kmem_free(temp, sizeof(*temp));

	return 1;
}

int
idr_get_new_above(struct idr *idr, void *data, int min_id, int *id)
{
	struct idr_node *node, *search, *collision __unused;
	int want_id = min_id;
	int error;

	mutex_spin_enter(&idr->idr_lock);

	node = idr->idr_temp;
	if (node == NULL) {
		error = -EAGAIN;
		goto out;
	}
	idr->idr_temp = NULL;

	search = rb_tree_find_node_geq(&idr->idr_tree, &min_id);
	while ((search != NULL) && (search->in_index == want_id)) {
		if (want_id == INT_MAX) {
			error = -ENOSPC;
			goto out;
		}
		search = rb_tree_iterate(&idr->idr_tree, search, RB_DIR_RIGHT);
		want_id++;
	}

	node->in_index = want_id;
	node->in_data = data;

	collision = rb_tree_insert_node(&idr->idr_tree, node);
	KASSERT(collision == node);

	*id = want_id;
	error = 0;

out:	mutex_spin_exit(&idr->idr_lock);
	return error;
}

int
idr_for_each(struct idr *idr, int (*proc)(int, void *, void *), void *arg)
{
	struct idr_node *node;
	int error = 0;

	/* XXX Caller must exclude modifications.  */
	membar_consumer();
	RB_TREE_FOREACH(node, &idr->idr_tree) {
		error = (*proc)(node->in_index, node->in_data, arg);
		if (error)
			break;
	}

	return error;
}