[mirror_frr.git] / lib / skiplist.h

/*
 * Copyright 1990 William Pugh
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
 *
 * Permission to include in quagga provide on March 31, 2016
 */

/*
 * Skip List impementation based on code from William Pugh.
 * ftp://ftp.cs.umd.edu/pub/skipLists/
 */

/* skiplist.h */


#ifndef _ZEBRA_SKIPLIST_H
#define _ZEBRA_SKIPLIST_H

#define SKIPLIST_0TIMER_DEBUG 1

/*
 * skiplistnodes must always contain data to be valid. Adding an
 * empty node to a list is invalid
 */
struct skiplistnode {
	void *key;
	void *value;
#if SKIPLIST_0TIMER_DEBUG
	int flags;
#define SKIPLIST_NODE_FLAG_INSERTED 0x00000001
#endif

	struct skiplistnode *forward[1]; /* variable sized */
};

struct skiplist {
	int flags;

#define SKIPLIST_FLAG_ALLOW_DUPLICATES	0x00000001

	int level; /* max lvl (1 + current # of levels in list) */
	unsigned int count;
	struct skiplistnode *header;
	struct skiplistnode *stats;
	struct skiplistnode
		*last; /* last real list item (NULL if empty list) */

	/*
	 * Returns -1 if val1 < val2, 0 if equal?, 1 if val1 > val2.
	 * Used as definition of sorted for listnode_add_sort
	 */
	int (*cmp)(void *val1, void *val2);

	/* callback to free user-owned data when listnode is deleted. supplying
	 * this callback is very much encouraged!
	 */
	void (*del)(void *val);
};


/* Prototypes. */
extern struct skiplist *
skiplist_new(/* encouraged: set list.del callback on new lists */
	     int flags,
	     int (*cmp)(void *key1, void *key2), /* NULL => default cmp */
	     void (*del)(void *val));		 /* NULL => no auto val free */

extern void skiplist_free(struct skiplist *);

extern int skiplist_insert(register struct skiplist *l, register void *key,
			   register void *value);

extern int skiplist_delete(register struct skiplist *l, register void *key,
			   register void *value);

extern int skiplist_search(register struct skiplist *l, register void *key,
			   void **valuePointer);

extern int skiplist_first_value(register struct skiplist *l, /* in */
				register void *key,	  /* in */
				void **valuePointer,	 /* in/out */
				void **cursor);		     /* out */

extern int skiplist_next_value(register struct skiplist *l, /* in */
			       register void *key,	  /* in */
			       void **valuePointer,	 /* in/out */
			       void **cursor);		    /* in/out */

extern int skiplist_first(register struct skiplist *l, void **keyPointer,
			  void **valuePointer);

extern int skiplist_last(register struct skiplist *l, void **keyPointer,
			 void **valuePointer);

extern int skiplist_delete_first(register struct skiplist *l);

extern int skiplist_next(register struct skiplist *l, /* in */
			 void **keyPointer,	   /* out */
			 void **valuePointer,	 /* out */
			 void **cursor);	      /* in/out */

extern int skiplist_empty(register struct skiplist *l); /* in */

extern unsigned int skiplist_count(register struct skiplist *l); /* in */

extern void skiplist_debug(struct vty *vty, struct skiplist *l);

extern void skiplist_test(struct vty *vty);

#endif /* _ZEBRA_SKIPLIST_H */
Commit	Line	Data
520d2512	1	/*
d62a17ae	2	* Copyright 1990 William Pugh
520d2512 LB	3	*
	4	* Redistribution and use in source and binary forms, with or without
	5	* modification, are permitted.
	6	*
	7	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS''
	8	* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
	9	* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
	10	* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR
	11	* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	12	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	13	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
	14	* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	15	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	16	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
	17	* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	18	* SUCH DAMAGE.
	19	*
	20	* Permission to include in quagga provide on March 31, 2016
	21	*/
	22
	23	/*
	24	* Skip List impementation based on code from William Pugh.
	25	* ftp://ftp.cs.umd.edu/pub/skipLists/
	26	*/
	27
	28	/* skiplist.h */
	29
	30
	31	#ifndef _ZEBRA_SKIPLIST_H
	32	#define _ZEBRA_SKIPLIST_H
	33
	34	#define SKIPLIST_0TIMER_DEBUG 1
	35
d62a17ae	36	/*
520d2512 LB	37	* skiplistnodes must always contain data to be valid. Adding an
	38	* empty node to a list is invalid
	39	*/
d62a17ae	40	struct skiplistnode {
	41	void *key;
	42	void *value;
520d2512	43	#if SKIPLIST_0TIMER_DEBUG
d62a17ae	44	int flags;
520d2512 LB	45	#define SKIPLIST_NODE_FLAG_INSERTED 0x00000001
	46	#endif
	47
d62a17ae	48	struct skiplistnode forward[1]; / variable sized */
520d2512 LB	49	};
520d2512 LB	50
d62a17ae	51	struct skiplist {
d62a17ae	52	int flags;
520d2512 LB	53
	54	#define SKIPLIST_FLAG_ALLOW_DUPLICATES 0x00000001
	55
d62a17ae	56	int level; /* max lvl (1 + current # of levels in list) */
	57	unsigned int count;
	58	struct skiplistnode *header;
	59	struct skiplistnode *stats;
	60	struct skiplistnode
	61	last; / last real list item (NULL if empty list) */
	62
	63	/*
	64	* Returns -1 if val1 < val2, 0 if equal?, 1 if val1 > val2.
	65	* Used as definition of sorted for listnode_add_sort
	66	*/
	67	int (cmp)(void val1, void *val2);
	68
	69	/* callback to free user-owned data when listnode is deleted. supplying
	70	* this callback is very much encouraged!
	71	*/
	72	void (del)(void val);
520d2512 LB	73	};
	74
	75
	76	/* Prototypes. */
	77	extern struct skiplist *
d62a17ae	78	skiplist_new(/* encouraged: set list.del callback on new lists */
	79	int flags,
	80	int (cmp)(void key1, void key2), / NULL => default cmp */
	81	void (del)(void val)); /* NULL => no auto val free */
	82
	83	extern void skiplist_free(struct skiplist *);
	84
	85	extern int skiplist_insert(register struct skiplist l, register void key,
	86	register void *value);
	87
	88	extern int skiplist_delete(register struct skiplist l, register void key,
	89	register void *value);
	90
	91	extern int skiplist_search(register struct skiplist l, register void key,
	92	void **valuePointer);
	93
	94	extern int skiplist_first_value(register struct skiplist l, / in */
	95	register void key, / in */
	96	void *valuePointer, / in/out */
	97	void *cursor); / out */
	98
	99	extern int skiplist_next_value(register struct skiplist l, / in */
	100	register void key, / in */
	101	void *valuePointer, / in/out */
	102	void *cursor); / in/out */
	103
	104	extern int skiplist_first(register struct skiplist l, void *keyPointer,
	105	void **valuePointer);
	106
	107	extern int skiplist_last(register struct skiplist l, void *keyPointer,
	108	void **valuePointer);
	109
	110	extern int skiplist_delete_first(register struct skiplist *l);
	111
	112	extern int skiplist_next(register struct skiplist l, / in */
	113	void *keyPointer, / out */
	114	void *valuePointer, / out */
	115	void *cursor); / in/out */
	116
	117	extern int skiplist_empty(register struct skiplist l); / in */
	118
	119	extern unsigned int skiplist_count(register struct skiplist l); / in */
	120
	121	extern void skiplist_debug(struct vty vty, struct skiplist l);
	122
	123	extern void skiplist_test(struct vty *vty);
520d2512 LB	124
520d2512 LB	125	#endif /* _ZEBRA_SKIPLIST_H */