2 Copyright (c) 2012 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef included_slist_h
18 #define included_slist_h
21 #include <vppinfra/clib.h>
22 #include <vppinfra/vec.h>
23 #include <vppinfra/pool.h>
24 #include <vppinfra/error.h>
25 #include <vppinfra/format.h>
26 #include <vppinfra/cache.h>
28 typedef word (clib_slist_key_compare_function_t)
29 (void *key, u32 elt_pool_index);
34 } clib_slist_search_result_t;
37 /* Vector of next elements. Every valid instance has at least one */
43 /* Index of item in user's pool */
45 /* $$$ pad to even divisor of cache line */
48 static inline u32 clib_slist_get_next_at_level (clib_slist_elt_t * elt,
51 if (elt->n.next0[0] & 1)
55 return elt->n.next0[1];
56 /* preserve ~0 (end of list) */
57 return (elt->n.next0[0] == (u32)~0) ? elt->n.next0[0] :
62 ASSERT(level < vec_len (elt->n.nexts));
63 return elt->n.nexts[level];
67 static inline void clib_slist_set_next_at_level (clib_slist_elt_t * elt,
70 u32 old_level0_value[2];
71 /* level0 and not a vector */
72 if (level < 2 && (elt->n.next0[0] == 0 || elt->n.next0[0] & 1))
76 elt->n.next0[0] = (index<<1) | 1;
79 elt->n.next0[1] = index;
82 /* have to save old level0 values? */
83 if (elt->n.next0[0] & 1)
85 old_level0_value[0] = (elt->n.next0[0] == (u32)~0) ?
86 elt->n.next0[0] : elt->n.next0[0]>>1;
87 old_level0_value[1] = elt->n.next0[1];
89 vec_add1 (elt->n.nexts, old_level0_value[0]);
90 vec_add1 (elt->n.nexts, old_level0_value[1]);
92 vec_validate (elt->n.nexts, level);
93 elt->n.nexts[level] = index;
98 /* pool of skip-list elements */
99 clib_slist_elt_t *elts;
101 /* last search path */
104 /* last search number of compares */
107 /* occupancy stats */
110 /* Comparison function */
111 clib_slist_key_compare_function_t *compare;
113 /* Format function */
114 format_function_t *format_user_element;
116 /* items appear in successive plies with Pr (1 / branching_factor) */
117 f64 branching_factor;
124 clib_slist_init (clib_slist_t *sp, f64 branching_factor,
125 clib_slist_key_compare_function_t compare,
126 format_function_t format_user_element);
128 format_function_t format_slist;
130 void clib_slist_add (clib_slist_t *sp, void *key, u32 user_pool_index);
131 clib_slist_search_result_t
132 clib_slist_del (clib_slist_t *sp, void *key);
133 u32 clib_slist_search (clib_slist_t *sp, void *key, u32 *ncompares);
135 #endif /* included_slist_h */