]>
Commit | Line | Data |
---|---|---|
4b393c50 | 1 | /* |
716154c5 BB |
2 | * Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC. |
3 | * Copyright (C) 2007 The Regents of the University of California. | |
4 | * Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). | |
5 | * Written by Brian Behlendorf <behlendorf1@llnl.gov>. | |
6 | * UCRL-CODE-235197 | |
7 | * | |
8 | * This file is part of the SPL, Solaris Porting Layer. | |
716154c5 BB |
9 | * |
10 | * The SPL is free software; you can redistribute it and/or modify it | |
11 | * under the terms of the GNU General Public License as published by the | |
12 | * Free Software Foundation; either version 2 of the License, or (at your | |
13 | * option) any later version. | |
14 | * | |
15 | * The SPL is distributed in the hope that it will be useful, but WITHOUT | |
16 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
17 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
18 | * for more details. | |
19 | * | |
20 | * You should have received a copy of the GNU General Public License along | |
21 | * with the SPL. If not, see <http://www.gnu.org/licenses/>. | |
4b393c50 | 22 | */ |
716154c5 | 23 | |
f5b92a66 | 24 | #ifndef _SPL_LIST_H |
5461eefe | 25 | #define _SPL_LIST_H |
f5b92a66 | 26 | |
dc0f9207 | 27 | #include <sys/types.h> |
e4d3d776 | 28 | #include <sys/debug.h> |
d702c04f | 29 | #include <linux/list.h> |
dc0f9207 | 30 | |
716154c5 BB |
31 | /* |
32 | * NOTE: I have implemented the Solaris list API in terms of the native | |
d702c04f BB |
33 | * linux API. This has certain advantages in terms of leveraging the linux |
34 | * list debugging infrastructure, but it also means that the internals of a | |
35 | * list differ slightly than on Solaris. This is not a problem as long as | |
36 | * all callers stick to the published API. The two major differences are: | |
37 | * | |
38 | * 1) A list_node_t is mapped to a linux list_head struct which changes | |
39 | * the name of the list_next/list_prev pointers to next/prev respectively. | |
40 | * | |
41 | * 2) A list_node_t which is not attached to a list on Solaris is denoted | |
42 | * by having its list_next/list_prev pointers set to NULL. Under linux | |
43 | * the next/prev pointers are set to LIST_POISON1 and LIST_POISON2 | |
44 | * respectively. At this moment this only impacts the implementation | |
45 | * of the list_link_init() and list_link_active() functions. | |
46 | */ | |
47 | ||
48 | typedef struct list_head list_node_t; | |
dc0f9207 BB |
49 | |
50 | typedef struct list { | |
d702c04f BB |
51 | size_t list_offset; |
52 | list_node_t list_head; | |
dc0f9207 BB |
53 | } list_t; |
54 | ||
5461eefe BB |
55 | #define list_d2l(a, obj) ((list_node_t *)(((char *)obj) + (a)->list_offset)) |
56 | #define list_object(a, node) ((void *)(((char *)node) - (a)->list_offset)) | |
d702c04f BB |
57 | |
58 | static inline int | |
59 | list_is_empty(list_t *list) | |
60 | { | |
5461eefe | 61 | return (list_empty(&list->list_head)); |
d702c04f BB |
62 | } |
63 | ||
64 | static inline void | |
65 | list_link_init(list_node_t *node) | |
66 | { | |
67 | node->next = LIST_POISON1; | |
68 | node->prev = LIST_POISON2; | |
69 | } | |
70 | ||
71 | static inline void | |
72 | list_create(list_t *list, size_t size, size_t offset) | |
73 | { | |
78e8c1f8 M |
74 | (void) size; |
75 | ||
d702c04f BB |
76 | list->list_offset = offset; |
77 | INIT_LIST_HEAD(&list->list_head); | |
78 | } | |
79 | ||
80 | static inline void | |
81 | list_destroy(list_t *list) | |
82 | { | |
d702c04f BB |
83 | list_del(&list->list_head); |
84 | } | |
85 | ||
86 | static inline void | |
87 | list_insert_head(list_t *list, void *object) | |
88 | { | |
89 | list_add(list_d2l(list, object), &list->list_head); | |
90 | } | |
91 | ||
92 | static inline void | |
93 | list_insert_tail(list_t *list, void *object) | |
94 | { | |
95 | list_add_tail(list_d2l(list, object), &list->list_head); | |
96 | } | |
97 | ||
98 | static inline void | |
99 | list_insert_after(list_t *list, void *object, void *nobject) | |
100 | { | |
101 | if (object == NULL) | |
102 | list_insert_head(list, nobject); | |
103 | else | |
104 | list_add(list_d2l(list, nobject), list_d2l(list, object)); | |
105 | } | |
106 | ||
107 | static inline void | |
108 | list_insert_before(list_t *list, void *object, void *nobject) | |
109 | { | |
110 | if (object == NULL) | |
111 | list_insert_tail(list, nobject); | |
112 | else | |
113 | list_add_tail(list_d2l(list, nobject), list_d2l(list, object)); | |
114 | } | |
115 | ||
116 | static inline void | |
117 | list_remove(list_t *list, void *object) | |
118 | { | |
d702c04f BB |
119 | list_del(list_d2l(list, object)); |
120 | } | |
121 | ||
122 | static inline void * | |
123 | list_remove_head(list_t *list) | |
124 | { | |
125 | list_node_t *head = list->list_head.next; | |
126 | if (head == &list->list_head) | |
5461eefe | 127 | return (NULL); |
d702c04f BB |
128 | |
129 | list_del(head); | |
5461eefe | 130 | return (list_object(list, head)); |
d702c04f BB |
131 | } |
132 | ||
133 | static inline void * | |
134 | list_remove_tail(list_t *list) | |
135 | { | |
136 | list_node_t *tail = list->list_head.prev; | |
137 | if (tail == &list->list_head) | |
5461eefe | 138 | return (NULL); |
d702c04f BB |
139 | |
140 | list_del(tail); | |
5461eefe | 141 | return (list_object(list, tail)); |
d702c04f BB |
142 | } |
143 | ||
144 | static inline void * | |
145 | list_head(list_t *list) | |
146 | { | |
147 | if (list_is_empty(list)) | |
5461eefe | 148 | return (NULL); |
d702c04f | 149 | |
5461eefe | 150 | return (list_object(list, list->list_head.next)); |
d702c04f BB |
151 | } |
152 | ||
153 | static inline void * | |
154 | list_tail(list_t *list) | |
155 | { | |
156 | if (list_is_empty(list)) | |
5461eefe | 157 | return (NULL); |
d702c04f | 158 | |
5461eefe | 159 | return (list_object(list, list->list_head.prev)); |
d702c04f BB |
160 | } |
161 | ||
162 | static inline void * | |
163 | list_next(list_t *list, void *object) | |
164 | { | |
165 | list_node_t *node = list_d2l(list, object); | |
166 | ||
167 | if (node->next != &list->list_head) | |
5461eefe | 168 | return (list_object(list, node->next)); |
d702c04f | 169 | |
5461eefe | 170 | return (NULL); |
d702c04f | 171 | } |
dc0f9207 | 172 | |
d702c04f BB |
173 | static inline void * |
174 | list_prev(list_t *list, void *object) | |
175 | { | |
176 | list_node_t *node = list_d2l(list, object); | |
dc0f9207 | 177 | |
d702c04f | 178 | if (node->prev != &list->list_head) |
5461eefe | 179 | return (list_object(list, node->prev)); |
dc0f9207 | 180 | |
5461eefe | 181 | return (NULL); |
d702c04f | 182 | } |
dc0f9207 | 183 | |
d702c04f BB |
184 | static inline int |
185 | list_link_active(list_node_t *node) | |
186 | { | |
e4d3d776 BA |
187 | EQUIV(node->next == LIST_POISON1, node->prev == LIST_POISON2); |
188 | return (node->next != LIST_POISON1); | |
d702c04f | 189 | } |
dc0f9207 | 190 | |
759dfe7d BB |
191 | static inline void |
192 | spl_list_move_tail(list_t *dst, list_t *src) | |
193 | { | |
194 | list_splice_init(&src->list_head, dst->list_head.prev); | |
195 | } | |
196 | ||
5461eefe | 197 | #define list_move_tail(dst, src) spl_list_move_tail(dst, src) |
759dfe7d | 198 | |
8371f981 BB |
199 | static inline void |
200 | list_link_replace(list_node_t *old_node, list_node_t *new_node) | |
201 | { | |
8371f981 BB |
202 | new_node->next = old_node->next; |
203 | new_node->prev = old_node->prev; | |
204 | old_node->prev->next = new_node; | |
205 | old_node->next->prev = new_node; | |
206 | list_link_init(old_node); | |
207 | } | |
208 | ||
f5b92a66 | 209 | #endif /* SPL_LIST_H */ |