blob: fdcc5c7553a1df68beb8fc5fe440354ba9de69f5 [file] [log] [blame]
willy tarreau80862a32006-04-12 19:15:57 +02001/*
Willy Tarreau3dd717c2014-12-23 13:58:43 +01002 * include/common/mini-clist.h
3 * Circular list manipulation macros and structures.
willy tarreau80862a32006-04-12 19:15:57 +02004 *
Willy Tarreau3dd717c2014-12-23 13:58:43 +01005 * Copyright (C) 2002-2014 Willy Tarreau - w@1wt.eu
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
willy tarreau80862a32006-04-12 19:15:57 +020020 */
21
Willy Tarreau2dd0d472006-06-29 17:53:05 +020022#ifndef _COMMON_MINI_CLIST_H
23#define _COMMON_MINI_CLIST_H
willy tarreau80862a32006-04-12 19:15:57 +020024
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020025#include <common/config.h>
26
willy tarreau80862a32006-04-12 19:15:57 +020027/* these are circular or bidirectionnal lists only. Each list pointer points to
28 * another list pointer in a structure, and not the structure itself. The
29 * pointer to the next element MUST be the first one so that the list is easily
30 * cast as a single linked list or pointer.
31 */
32struct list {
33 struct list *n; /* next */
34 struct list *p; /* prev */
35};
36
Olivier Houchard859dc802019-08-08 15:47:21 +020037/* This is similar to struct list, but we want to be sure the compiler will
38 * yell at you if you use macroes for one when you're using the other. You have
39 * to expicitely cast if that's really what you want to do.
40 */
41struct mt_list {
42 struct mt_list *next;
43 struct mt_list *prev;
44};
45
46
Willy Tarreaubc04ce72008-12-07 20:00:15 +010047/* a back-ref is a pointer to a target list entry. It is used to detect when an
48 * element being deleted is currently being tracked by another user. The best
49 * example is a user dumping the session table. The table does not fit in the
50 * output buffer so we have to set a mark on a session and go on later. But if
51 * that marked session gets deleted, we don't want the user's pointer to go in
52 * the wild. So we can simply link this user's request to the list of this
53 * session's users, and put a pointer to the list element in ref, that will be
54 * used as the mark for next iteration.
55 */
56struct bref {
57 struct list users;
58 struct list *ref; /* pointer to the target's list entry */
59};
60
Willy Tarreaudeb9ed82010-01-03 21:03:22 +010061/* a word list is a generic list with a pointer to a string in each element. */
62struct wordlist {
63 struct list list;
64 char *s;
65};
66
Willy Tarreauf4f04122010-01-28 18:10:50 +010067/* this is the same as above with an additional pointer to a condition. */
68struct cond_wordlist {
69 struct list list;
70 void *cond;
71 char *s;
72};
73
Willy Tarreaubd578bb2007-10-28 11:41:06 +010074/* First undefine some macros which happen to also be defined on OpenBSD,
75 * in sys/queue.h, used by sys/event.h
76 */
77#undef LIST_HEAD
78#undef LIST_INIT
79#undef LIST_NEXT
80
Willy Tarreaudc13c112013-06-21 23:16:39 +020081/* ILH = Initialized List Head : used to prevent gcc from moving an empty
82 * list to BSS. Some older version tend to trim all the array and cause
83 * corruption.
84 */
85#define ILH { .n = (struct list *)1, .p = (struct list *)2 }
86
Willy Tarreaubaaee002006-06-26 02:48:02 +020087#define LIST_HEAD(a) ((void *)(&(a)))
88
willy tarreau80862a32006-04-12 19:15:57 +020089#define LIST_INIT(l) ((l)->n = (l)->p = (l))
90
Willy Tarreau2b1dccd2007-05-07 00:18:32 +020091#define LIST_HEAD_INIT(l) { &l, &l }
92
willy tarreau80862a32006-04-12 19:15:57 +020093/* adds an element at the beginning of a list ; returns the element */
94#define LIST_ADD(lh, el) ({ (el)->n = (lh)->n; (el)->n->p = (lh)->n = (el); (el)->p = (lh); (el); })
95
96/* adds an element at the end of a list ; returns the element */
97#define LIST_ADDQ(lh, el) ({ (el)->p = (lh)->p; (el)->p->n = (lh)->p = (el); (el)->n = (lh); (el); })
98
Willy Tarreau9bead8c2019-08-16 11:27:50 +020099/* adds the contents of a list <old> at the beginning of another list <new>. The old list head remains untouched. */
100#define LIST_SPLICE(new, old) do { \
101 if (!LIST_ISEMPTY(old)) { \
102 (old)->p->n = (new)->n; (old)->n->p = (new); \
103 (new)->n->p = (old)->p; (new)->n = (old)->n; \
104 } \
105 } while (0)
106
Willy Tarreauc32a0e52019-10-04 18:01:39 +0200107/* adds the contents of a list whose first element is <old> and last one is
108 * <old->prev> at the end of another list <new>. The old list DOES NOT have
109 * any head here.
110 */
111#define LIST_SPLICE_END_DETACHED(new, old) do { \
112 typeof(new) __t; \
113 (new)->p->n = (old); \
114 (old)->p->n = (new); \
115 __t = (old)->p; \
116 (old)->p = (new)->p; \
117 (new)->p = __t; \
118 } while (0)
119
willy tarreau80862a32006-04-12 19:15:57 +0200120/* removes an element from a list and returns it */
121#define LIST_DEL(el) ({ typeof(el) __ret = (el); (el)->n->p = (el)->p; (el)->p->n = (el)->n; (__ret); })
122
Willy Tarreauc5bd3112019-03-06 19:32:11 +0100123/* removes an element from a list, initializes it and returns it.
124 * This is faster than LIST_DEL+LIST_INIT as we avoid reloading the pointers.
125 */
126#define LIST_DEL_INIT(el) ({ \
127 typeof(el) __ret = (el); \
128 typeof(__ret->n) __n = __ret->n; \
129 typeof(__ret->p) __p = __ret->p; \
130 __n->p = __p; __p->n = __n; \
131 __ret->n = __ret->p = __ret; \
132 __ret; \
133})
134
willy tarreau80862a32006-04-12 19:15:57 +0200135/* returns a pointer of type <pt> to a structure containing a list head called
136 * <el> at address <lh>. Note that <lh> can be the result of a function or macro
137 * since it's used only once.
138 * Example: LIST_ELEM(cur_node->args.next, struct node *, args)
139 */
140#define LIST_ELEM(lh, pt, el) ((pt)(((void *)(lh)) - ((void *)&((pt)NULL)->el)))
141
142/* checks if the list head <lh> is empty or not */
143#define LIST_ISEMPTY(lh) ((lh)->n == (lh))
144
Willy Tarreau42ccb5a2019-05-13 17:48:46 +0200145/* checks if the list element <el> was added to a list or not. This only
146 * works when detached elements are reinitialized (using LIST_DEL_INIT)
147 */
148#define LIST_ADDED(el) ((el)->n != (el))
149
willy tarreau80862a32006-04-12 19:15:57 +0200150/* returns a pointer of type <pt> to a structure following the element
151 * which contains list head <lh>, which is known as element <el> in
152 * struct pt.
153 * Example: LIST_NEXT(args, struct node *, list)
154 */
155#define LIST_NEXT(lh, pt, el) (LIST_ELEM((lh)->n, pt, el))
156
157
Joseph Herlant41abef72018-11-25 10:57:13 -0800158/* returns a pointer of type <pt> to a structure preceding the element
willy tarreau80862a32006-04-12 19:15:57 +0200159 * which contains list head <lh>, which is known as element <el> in
160 * struct pt.
161 */
Thierry FOURNIER1db96672015-11-03 19:17:37 +0100162#undef LIST_PREV
willy tarreau80862a32006-04-12 19:15:57 +0200163#define LIST_PREV(lh, pt, el) (LIST_ELEM((lh)->p, pt, el))
164
165/*
Willy Tarreaub9c62b92007-05-02 20:46:49 +0200166 * Simpler FOREACH_ITEM macro inspired from Linux sources.
167 * Iterates <item> through a list of items of type "typeof(*item)" which are
168 * linked via a "struct list" member named <member>. A pointer to the head of
169 * the list is passed in <list_head>. No temporary variable is needed. Note
170 * that <item> must not be modified during the loop.
171 * Example: list_for_each_entry(cur_acl, known_acl, list) { ... };
172 */
173#define list_for_each_entry(item, list_head, member) \
174 for (item = LIST_ELEM((list_head)->n, typeof(item), member); \
175 &item->member != (list_head); \
176 item = LIST_ELEM(item->member.n, typeof(item), member))
177
178/*
William Lallemand83215a42017-09-24 11:26:02 +0200179 * Same as list_for_each_entry but starting from current point
180 * Iterates <item> through the list starting from <item>
181 * It's basically the same macro but without initializing item to the head of
182 * the list.
183 */
184#define list_for_each_entry_from(item, list_head, member) \
185 for ( ; &item->member != (list_head); \
186 item = LIST_ELEM(item->member.n, typeof(item), member))
187
188/*
Willy Tarreaub9c62b92007-05-02 20:46:49 +0200189 * Simpler FOREACH_ITEM_SAFE macro inspired from Linux sources.
190 * Iterates <item> through a list of items of type "typeof(*item)" which are
191 * linked via a "struct list" member named <member>. A pointer to the head of
192 * the list is passed in <list_head>. A temporary variable <back> of same type
193 * as <item> is needed so that <item> may safely be deleted if needed.
194 * Example: list_for_each_entry_safe(cur_acl, tmp, known_acl, list) { ... };
195 */
196#define list_for_each_entry_safe(item, back, list_head, member) \
197 for (item = LIST_ELEM((list_head)->n, typeof(item), member), \
198 back = LIST_ELEM(item->member.n, typeof(item), member); \
199 &item->member != (list_head); \
200 item = back, back = LIST_ELEM(back->member.n, typeof(back), member))
201
202
William Lallemand83215a42017-09-24 11:26:02 +0200203/*
204 * Same as list_for_each_entry_safe but starting from current point
205 * Iterates <item> through the list starting from <item>
206 * It's basically the same macro but without initializing item to the head of
207 * the list.
208 */
209#define list_for_each_entry_safe_from(item, back, list_head, member) \
210 for (back = LIST_ELEM(item->member.n, typeof(item), member); \
211 &item->member != (list_head); \
212 item = back, back = LIST_ELEM(back->member.n, typeof(back), member))
213
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100214#include <common/hathreads.h>
Olivier Houchard859dc802019-08-08 15:47:21 +0200215#define MT_LIST_BUSY ((struct mt_list *)1)
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100216
217/*
218 * Locked version of list manipulation macros.
219 * It is OK to use those concurrently from multiple threads, as long as the
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200220 * list is only used with the locked variants.
221 */
222
223/*
224 * Add an item at the beginning of a list.
225 * Returns 1 if we added the item, 0 otherwise (because it was already in a
226 * list).
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100227 */
Olivier Houchard859dc802019-08-08 15:47:21 +0200228#define MT_LIST_ADD(lh, el) \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200229 ({ \
230 int _ret = 0; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100231 do { \
232 while (1) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200233 struct mt_list *n; \
234 struct mt_list *p; \
235 n = _HA_ATOMIC_XCHG(&(lh)->next, MT_LIST_BUSY); \
236 if (n == MT_LIST_BUSY) \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100237 continue; \
Olivier Houchard859dc802019-08-08 15:47:21 +0200238 p = _HA_ATOMIC_XCHG(&n->prev, MT_LIST_BUSY); \
239 if (p == MT_LIST_BUSY) { \
240 (lh)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100241 __ha_barrier_store(); \
242 continue; \
243 } \
Olivier Houchardcb22ad42019-09-20 14:44:22 +0200244 if ((el)->next != (el) || (el)->prev != (el)) { \
245 (n)->prev = p; \
246 (lh)->next = n; \
247 break; \
248 } \
Olivier Houchard859dc802019-08-08 15:47:21 +0200249 (el)->next = n; \
250 (el)->prev = p; \
Willy Tarreau690d2ad2019-02-28 11:14:22 +0100251 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200252 n->prev = (el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100253 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200254 p->next = (el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100255 __ha_barrier_store(); \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200256 _ret = 1; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100257 break; \
258 } \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200259 } while (0); \
260 (_ret); \
261 })
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100262
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200263/*
264 * Add an item at the end of a list.
265 * Returns 1 if we added the item, 0 otherwise (because it was already in a
266 * list).
267 */
Olivier Houchard859dc802019-08-08 15:47:21 +0200268#define MT_LIST_ADDQ(lh, el) \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200269 ({ \
270 int _ret = 0; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100271 do { \
272 while (1) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200273 struct mt_list *n; \
274 struct mt_list *p; \
275 p = _HA_ATOMIC_XCHG(&(lh)->prev, MT_LIST_BUSY); \
276 if (p == MT_LIST_BUSY) \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100277 continue; \
Olivier Houchard859dc802019-08-08 15:47:21 +0200278 n = _HA_ATOMIC_XCHG(&p->next, MT_LIST_BUSY); \
279 if (n == MT_LIST_BUSY) { \
280 (lh)->prev = p; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100281 __ha_barrier_store(); \
282 continue; \
283 } \
Olivier Houchardcb22ad42019-09-20 14:44:22 +0200284 if ((el)->next != (el) || (el)->prev != (el)) { \
285 p->next = n; \
286 (lh)->prev = p; \
287 break; \
288 } \
Olivier Houchard859dc802019-08-08 15:47:21 +0200289 (el)->next = n; \
290 (el)->prev = p; \
Willy Tarreau690d2ad2019-02-28 11:14:22 +0100291 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200292 p->next = (el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100293 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200294 n->prev = (el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100295 __ha_barrier_store(); \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200296 _ret = 1; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100297 break; \
298 } \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200299 } while (0); \
300 (_ret); \
301 })
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100302
Willy Tarreaud7f2bbc2019-10-04 18:02:40 +0200303/*
304 * Detach a list from its head. A pointer to the first element is returned
305 * and the list is closed. If the list was empty, NULL is returned. This may
306 * exclusively be used with lists modified by MT_LIST_ADD/MT_LIST_ADDQ. This
307 * is incompatible with MT_LIST_DEL run concurrently.
308 */
309#define MT_LIST_BEHEAD(lh) ({ \
310 struct mt_list *_n; \
311 struct mt_list *_p; \
312 while (1) { \
313 _p = _HA_ATOMIC_XCHG(&(lh)->prev, MT_LIST_BUSY); \
314 if (_p == MT_LIST_BUSY) \
315 continue; \
316 if (_p == (lh)) { \
317 (lh)->prev = _p; \
318 _n = NULL; \
319 break; \
320 } \
321 _n = _HA_ATOMIC_XCHG(&(lh)->next, MT_LIST_BUSY); \
322 if (_n == MT_LIST_BUSY) { \
323 (lh)->prev = _p; \
324 __ha_barrier_store(); \
325 continue; \
326 } \
327 if (_n == (lh)) { \
328 (lh)->next = _n; \
329 (lh)->prev = _p; \
330 _n = NULL; \
331 break; \
332 } \
333 (lh)->next = (lh); \
334 (lh)->prev = (lh); \
335 _n->prev = _p; \
336 _p->next = _n; \
337 __ha_barrier_store(); \
338 break; \
339 } \
340 (_n); \
341})
342
343
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200344/* Remove an item from a list.
345 * Returns 1 if we removed the item, 0 otherwise (because it was in no list).
346 */
Olivier Houchard859dc802019-08-08 15:47:21 +0200347#define MT_LIST_DEL(el) \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200348 ({ \
349 int _ret = 0; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100350 do { \
351 while (1) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200352 struct mt_list *n, *n2; \
353 struct mt_list *p, *p2 = NULL; \
354 n = _HA_ATOMIC_XCHG(&(el)->next, MT_LIST_BUSY); \
355 if (n == MT_LIST_BUSY) \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100356 continue; \
Olivier Houchard859dc802019-08-08 15:47:21 +0200357 p = _HA_ATOMIC_XCHG(&(el)->prev, MT_LIST_BUSY); \
358 if (p == MT_LIST_BUSY) { \
359 (el)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100360 __ha_barrier_store(); \
361 continue; \
362 } \
363 if (p != (el)) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200364 p2 = _HA_ATOMIC_XCHG(&p->next, MT_LIST_BUSY);\
365 if (p2 == MT_LIST_BUSY) { \
366 (el)->prev = p; \
367 (el)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100368 __ha_barrier_store(); \
369 continue; \
370 } \
371 } \
372 if (n != (el)) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200373 n2 = _HA_ATOMIC_XCHG(&n->prev, MT_LIST_BUSY);\
374 if (n2 == MT_LIST_BUSY) { \
Olivier Houcharddb644892019-02-26 18:46:07 +0100375 if (p2 != NULL) \
Olivier Houchard859dc802019-08-08 15:47:21 +0200376 p->next = p2; \
377 (el)->prev = p; \
378 (el)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100379 __ha_barrier_store(); \
380 continue; \
381 } \
382 } \
Olivier Houchard859dc802019-08-08 15:47:21 +0200383 n->prev = p; \
384 p->next = n; \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200385 if (p != (el) && n != (el)) \
386 _ret = 1; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100387 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200388 (el)->prev = (el); \
389 (el)->next = (el); \
Willy Tarreau4c747e82019-02-28 15:05:53 +0100390 __ha_barrier_store(); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100391 break; \
392 } \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200393 } while (0); \
394 (_ret); \
395 })
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100396
397
398/* Remove the first element from the list, and return it */
Olivier Houchard859dc802019-08-08 15:47:21 +0200399#define MT_LIST_POP(lh, pt, el) \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100400 ({ \
401 void *_ret; \
402 while (1) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200403 struct mt_list *n, *n2; \
404 struct mt_list *p, *p2; \
405 n = _HA_ATOMIC_XCHG(&(lh)->next, MT_LIST_BUSY); \
406 if (n == MT_LIST_BUSY) \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100407 continue; \
408 if (n == (lh)) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200409 (lh)->next = lh; \
Willy Tarreau690d2ad2019-02-28 11:14:22 +0100410 __ha_barrier_store(); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100411 _ret = NULL; \
412 break; \
413 } \
Olivier Houchard859dc802019-08-08 15:47:21 +0200414 p = _HA_ATOMIC_XCHG(&n->prev, MT_LIST_BUSY); \
415 if (p == MT_LIST_BUSY) { \
416 (lh)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100417 __ha_barrier_store(); \
418 continue; \
419 } \
Olivier Houchard859dc802019-08-08 15:47:21 +0200420 n2 = _HA_ATOMIC_XCHG(&n->next, MT_LIST_BUSY); \
421 if (n2 == MT_LIST_BUSY) { \
422 n->prev = p; \
Willy Tarreau690d2ad2019-02-28 11:14:22 +0100423 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200424 (lh)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100425 __ha_barrier_store(); \
426 continue; \
427 } \
Olivier Houchard859dc802019-08-08 15:47:21 +0200428 p2 = _HA_ATOMIC_XCHG(&n2->prev, MT_LIST_BUSY); \
429 if (p2 == MT_LIST_BUSY) { \
430 n->next = n2; \
431 n->prev = p; \
Willy Tarreau690d2ad2019-02-28 11:14:22 +0100432 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200433 (lh)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100434 __ha_barrier_store(); \
435 continue; \
436 } \
Olivier Houchard859dc802019-08-08 15:47:21 +0200437 (lh)->next = n2; \
438 (n2)->prev = (lh); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100439 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200440 (n)->prev = (n); \
441 (n)->next = (n); \
Willy Tarreau4c747e82019-02-28 15:05:53 +0100442 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200443 _ret = MT_LIST_ELEM(n, pt, el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100444 break; \
445 } \
446 (_ret); \
447 })
William Lallemand83215a42017-09-24 11:26:02 +0200448
Olivier Houchard859dc802019-08-08 15:47:21 +0200449#define MT_LIST_HEAD(a) ((void *)(&(a)))
450
451#define MT_LIST_INIT(l) ((l)->next = (l)->prev = (l))
452
453#define MT_LIST_HEAD_INIT(l) { &l, &l }
454/* returns a pointer of type <pt> to a structure containing a list head called
455 * <el> at address <lh>. Note that <lh> can be the result of a function or macro
456 * since it's used only once.
457 * Example: MT_LIST_ELEM(cur_node->args.next, struct node *, args)
458 */
459#define MT_LIST_ELEM(lh, pt, el) ((pt)(((void *)(lh)) - ((void *)&((pt)NULL)->el)))
460
461/* checks if the list head <lh> is empty or not */
462#define MT_LIST_ISEMPTY(lh) ((lh)->next == (lh))
463
464/* returns a pointer of type <pt> to a structure following the element
465 * which contains list head <lh>, which is known as element <el> in
466 * struct pt.
467 * Example: MT_LIST_NEXT(args, struct node *, list)
468 */
469#define MT_LIST_NEXT(lh, pt, el) (MT_LIST_ELEM((lh)->next, pt, el))
470
471
472/* returns a pointer of type <pt> to a structure preceding the element
473 * which contains list head <lh>, which is known as element <el> in
474 * struct pt.
475 */
476#undef MT_LIST_PREV
477#define MT_LIST_PREV(lh, pt, el) (MT_LIST_ELEM((lh)->prev, pt, el))
478
479/* checks if the list element <el> was added to a list or not. This only
480 * works when detached elements are reinitialized (using LIST_DEL_INIT)
481 */
482#define MT_LIST_ADDED(el) ((el)->next != (el))
483
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200484/* Lock an element in the list, to be sure it won't be removed.
485 * It needs to be synchronized somehow to be sure it's not removed
486 * from the list in the meanwhile.
487 * This returns a struct mt_list, that will be needed at unlock time.
488 */
489#define MT_LIST_LOCK_ELT(el) \
490 ({ \
491 struct mt_list ret; \
492 while (1) { \
493 struct mt_list *n, *n2; \
494 struct mt_list *p, *p2 = NULL; \
495 n = _HA_ATOMIC_XCHG(&(el)->next, MT_LIST_BUSY); \
496 if (n == MT_LIST_BUSY) \
497 continue; \
498 p = _HA_ATOMIC_XCHG(&(el)->prev, MT_LIST_BUSY); \
499 if (p == MT_LIST_BUSY) { \
500 (el)->next = n; \
501 __ha_barrier_store(); \
502 continue; \
503 } \
504 if (p != (el)) { \
505 p2 = _HA_ATOMIC_XCHG(&p->next, MT_LIST_BUSY);\
506 if (p2 == MT_LIST_BUSY) { \
507 (el)->prev = p; \
508 (el)->next = n; \
509 __ha_barrier_store(); \
510 continue; \
511 } \
512 } \
513 if (n != (el)) { \
514 n2 = _HA_ATOMIC_XCHG(&n->prev, MT_LIST_BUSY);\
515 if (n2 == MT_LIST_BUSY) { \
516 if (p2 != NULL) \
517 p->next = p2; \
518 (el)->prev = p; \
519 (el)->next = n; \
520 __ha_barrier_store(); \
521 continue; \
522 } \
523 } \
524 ret.next = n; \
525 ret.prev = p; \
526 break; \
527 } \
528 ret; \
529 })
530
531/* Unlock an element previously locked by MT_LIST_LOCK_ELT. "np" is the
532 * struct mt_list returned by MT_LIST_LOCK_ELT().
533 */
534#define MT_LIST_UNLOCK_ELT(el, np) \
535 do { \
536 struct mt_list *n = (np).next, *p = (np).prev; \
537 (el)->next = n; \
538 (el)->prev = p; \
539 if (n != (el)) \
540 n->prev = (el); \
541 if (p != (el)) \
542 p->next = (el); \
543 } while (0)
544
545/* Internal macroes for the foreach macroes */
546#define _MT_LIST_UNLOCK_NEXT(el, np) \
547 do { \
548 struct mt_list *n = (np); \
549 (el)->next = n; \
550 if (n != (el)) \
551 n->prev = (el); \
552 } while (0)
553
554/* Internal macroes for the foreach macroes */
555#define _MT_LIST_UNLOCK_PREV(el, np) \
556 do { \
557 struct mt_list *p = (np); \
558 (el)->prev = p; \
559 if (p != (el)) \
560 p->next = (el); \
561 } while (0)
562
563#define _MT_LIST_LOCK_NEXT(el) \
564 ({ \
565 struct mt_list *n = NULL; \
566 while (1) { \
567 struct mt_list *n2; \
568 n = _HA_ATOMIC_XCHG(&((el)->next), MT_LIST_BUSY); \
569 if (n == MT_LIST_BUSY) \
570 continue; \
571 if (n != (el)) { \
572 n2 = _HA_ATOMIC_XCHG(&n->prev, MT_LIST_BUSY);\
573 if (n2 == MT_LIST_BUSY) { \
574 (el)->next = n; \
575 __ha_barrier_store(); \
576 continue; \
577 } \
578 } \
579 break; \
580 } \
581 n; \
582 })
583
584#define _MT_LIST_LOCK_PREV(el) \
585 ({ \
586 struct mt_list *p = NULL; \
587 while (1) { \
588 struct mt_list *p2; \
589 p = _HA_ATOMIC_XCHG(&((el)->prev), MT_LIST_BUSY); \
590 if (p == MT_LIST_BUSY) \
591 continue; \
592 if (p != (el)) { \
593 p2 = _HA_ATOMIC_XCHG(&p->next, MT_LIST_BUSY);\
594 if (p2 == MT_LIST_BUSY) { \
595 (el)->prev = p; \
596 __ha_barrier_store(); \
597 continue; \
598 } \
599 } \
600 break; \
601 } \
602 p; \
603 })
604
605#define _MT_LIST_RELINK_DELETED(elt2) \
606 do { \
607 struct mt_list *n = elt2.next, *p = elt2.prev; \
608 n->prev = p; \
609 p->next = n; \
610 } while (0);
611
612/* Equivalent of MT_LIST_DEL(), to be used when parsing the list with mt_list_entry_for_each_safe().
613 * It should be the element currently parsed (tmpelt1)
614 */
615#define MT_LIST_DEL_SAFE(el) \
616 do { \
617 (el)->prev = (el); \
618 (el)->next = (el); \
619 (el) = NULL; \
620 } while (0)
621
622/* Simpler FOREACH_ITEM_SAFE macro inspired from Linux sources.
623 * Iterates <item> through a list of items of type "typeof(*item)" which are
624 * linked via a "struct list" member named <member>. A pointer to the head of
625 * the list is passed in <list_head>. A temporary variable <back> of same type
626 * as <item> is needed so that <item> may safely be deleted if needed.
627 * tmpelt1 is a temporary struct mt_list *, and tmpelt2 is a temporary
628 * struct mt_list, used internally, both are needed for MT_LIST_DEL_SAFE.
629 * Example: list_for_each_entry_safe(cur_acl, tmp, known_acl, list, elt1, elt2)
630 * { ... };
631 * If you want to remove the current element, please use MT_LIST_DEL_SAFE.
632 */
633#define mt_list_for_each_entry_safe(item, list_head, member, tmpelt, tmpelt2) \
634 for ((tmpelt) = NULL; (tmpelt) != MT_LIST_BUSY; ({ \
635 if (tmpelt) { \
636 if (tmpelt2.prev) \
637 MT_LIST_UNLOCK_ELT(tmpelt, tmpelt2); \
638 else \
639 _MT_LIST_UNLOCK_NEXT(tmpelt, tmpelt2.next); \
640 } else \
641 _MT_LIST_RELINK_DELETED(tmpelt2); \
642 (tmpelt) = MT_LIST_BUSY; \
643 })) \
644 for ((tmpelt) = (list_head), (tmpelt2).prev = NULL, (tmpelt2).next = _MT_LIST_LOCK_NEXT(list_head); ({ \
645 (item) = MT_LIST_ELEM((tmpelt2.next), typeof(item), member); \
646 if (&item->member != (list_head)) { \
647 if (tmpelt2.prev != &item->member) \
648 tmpelt2.next = _MT_LIST_LOCK_NEXT(&item->member); \
649 else \
650 tmpelt2.next = tmpelt; \
651 if (tmpelt != NULL) { \
652 if (tmpelt2.prev) \
653 _MT_LIST_UNLOCK_PREV(tmpelt, tmpelt2.prev); \
654 tmpelt2.prev = tmpelt; \
655 } \
656 (tmpelt) = &item->member; \
657 } \
658 }), \
659 &item->member != (list_head);)
Willy Tarreau2dd0d472006-06-29 17:53:05 +0200660#endif /* _COMMON_MINI_CLIST_H */