blob: e29451148cad94bea8d5e2591802313fe00d079d [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 Houchard74715da2019-10-11 16:55:11 +0200228#define MT_LIST_ADD(_lh, _el) \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200229 ({ \
230 int _ret = 0; \
Olivier Houchard74715da2019-10-11 16:55:11 +0200231 struct mt_list *lh = (_lh), *el = (_el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100232 do { \
233 while (1) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200234 struct mt_list *n; \
235 struct mt_list *p; \
Olivier Houchard804ef242019-10-11 16:57:43 +0200236 n = _HA_ATOMIC_XCHG(&(lh)->next, MT_LIST_BUSY); \
237 if (n == MT_LIST_BUSY) \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100238 continue; \
Olivier Houchard804ef242019-10-11 16:57:43 +0200239 p = _HA_ATOMIC_XCHG(&n->prev, MT_LIST_BUSY); \
240 if (p == MT_LIST_BUSY) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200241 (lh)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100242 __ha_barrier_store(); \
243 continue; \
244 } \
Olivier Houchardcb22ad42019-09-20 14:44:22 +0200245 if ((el)->next != (el) || (el)->prev != (el)) { \
246 (n)->prev = p; \
247 (lh)->next = n; \
248 break; \
249 } \
Olivier Houchard859dc802019-08-08 15:47:21 +0200250 (el)->next = n; \
251 (el)->prev = p; \
Willy Tarreau690d2ad2019-02-28 11:14:22 +0100252 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200253 n->prev = (el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100254 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200255 p->next = (el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100256 __ha_barrier_store(); \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200257 _ret = 1; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100258 break; \
259 } \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200260 } while (0); \
261 (_ret); \
262 })
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100263
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200264/*
265 * Add an item at the end of a list.
266 * Returns 1 if we added the item, 0 otherwise (because it was already in a
267 * list).
268 */
Olivier Houchard74715da2019-10-11 16:55:11 +0200269#define MT_LIST_ADDQ(_lh, _el) \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200270 ({ \
Olivier Houchard804ef242019-10-11 16:57:43 +0200271 int _ret = 0; \
Olivier Houchard74715da2019-10-11 16:55:11 +0200272 struct mt_list *lh = (_lh), *el = (_el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100273 do { \
274 while (1) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200275 struct mt_list *n; \
276 struct mt_list *p; \
Olivier Houchard804ef242019-10-11 16:57:43 +0200277 p = _HA_ATOMIC_XCHG(&(lh)->prev, MT_LIST_BUSY); \
278 if (p == MT_LIST_BUSY) \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100279 continue; \
Olivier Houchard804ef242019-10-11 16:57:43 +0200280 n = _HA_ATOMIC_XCHG(&p->next, MT_LIST_BUSY); \
281 if (n == MT_LIST_BUSY) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200282 (lh)->prev = p; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100283 __ha_barrier_store(); \
284 continue; \
285 } \
Olivier Houchardcb22ad42019-09-20 14:44:22 +0200286 if ((el)->next != (el) || (el)->prev != (el)) { \
287 p->next = n; \
288 (lh)->prev = p; \
289 break; \
290 } \
Olivier Houchard859dc802019-08-08 15:47:21 +0200291 (el)->next = n; \
292 (el)->prev = p; \
Willy Tarreau690d2ad2019-02-28 11:14:22 +0100293 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200294 p->next = (el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100295 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200296 n->prev = (el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100297 __ha_barrier_store(); \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200298 _ret = 1; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100299 break; \
300 } \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200301 } while (0); \
302 (_ret); \
303 })
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100304
Willy Tarreaud7f2bbc2019-10-04 18:02:40 +0200305/*
306 * Detach a list from its head. A pointer to the first element is returned
307 * and the list is closed. If the list was empty, NULL is returned. This may
308 * exclusively be used with lists modified by MT_LIST_ADD/MT_LIST_ADDQ. This
309 * is incompatible with MT_LIST_DEL run concurrently.
Olivier Houchard2068ec42019-10-17 17:46:01 +0200310 * If there's at least one element, the next of the last element will always
311 * be NULL.
Willy Tarreaud7f2bbc2019-10-04 18:02:40 +0200312 */
Olivier Houchard74715da2019-10-11 16:55:11 +0200313#define MT_LIST_BEHEAD(_lh) ({ \
314 struct mt_list *lh = (_lh); \
Willy Tarreaud7f2bbc2019-10-04 18:02:40 +0200315 struct mt_list *_n; \
316 struct mt_list *_p; \
317 while (1) { \
318 _p = _HA_ATOMIC_XCHG(&(lh)->prev, MT_LIST_BUSY); \
319 if (_p == MT_LIST_BUSY) \
320 continue; \
321 if (_p == (lh)) { \
322 (lh)->prev = _p; \
323 _n = NULL; \
324 break; \
325 } \
326 _n = _HA_ATOMIC_XCHG(&(lh)->next, MT_LIST_BUSY); \
327 if (_n == MT_LIST_BUSY) { \
328 (lh)->prev = _p; \
329 __ha_barrier_store(); \
330 continue; \
331 } \
332 if (_n == (lh)) { \
333 (lh)->next = _n; \
334 (lh)->prev = _p; \
335 _n = NULL; \
336 break; \
337 } \
338 (lh)->next = (lh); \
339 (lh)->prev = (lh); \
340 _n->prev = _p; \
Olivier Houchard2068ec42019-10-17 17:46:01 +0200341 _p->next = NULL; \
Willy Tarreaud7f2bbc2019-10-04 18:02:40 +0200342 __ha_barrier_store(); \
343 break; \
344 } \
345 (_n); \
346})
347
348
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200349/* Remove an item from a list.
350 * Returns 1 if we removed the item, 0 otherwise (because it was in no list).
351 */
Olivier Houchard74715da2019-10-11 16:55:11 +0200352#define MT_LIST_DEL(_el) \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200353 ({ \
354 int _ret = 0; \
Olivier Houchard74715da2019-10-11 16:55:11 +0200355 struct mt_list *el = (_el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100356 do { \
357 while (1) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200358 struct mt_list *n, *n2; \
359 struct mt_list *p, *p2 = NULL; \
Olivier Houchard804ef242019-10-11 16:57:43 +0200360 n = _HA_ATOMIC_XCHG(&(el)->next, MT_LIST_BUSY); \
361 if (n == MT_LIST_BUSY) \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100362 continue; \
Olivier Houchard804ef242019-10-11 16:57:43 +0200363 p = _HA_ATOMIC_XCHG(&(el)->prev, MT_LIST_BUSY); \
364 if (p == MT_LIST_BUSY) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200365 (el)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100366 __ha_barrier_store(); \
367 continue; \
368 } \
369 if (p != (el)) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200370 p2 = _HA_ATOMIC_XCHG(&p->next, MT_LIST_BUSY);\
Olivier Houchard804ef242019-10-11 16:57:43 +0200371 if (p2 == MT_LIST_BUSY) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200372 (el)->prev = p; \
373 (el)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100374 __ha_barrier_store(); \
375 continue; \
376 } \
377 } \
378 if (n != (el)) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200379 n2 = _HA_ATOMIC_XCHG(&n->prev, MT_LIST_BUSY);\
Olivier Houchard804ef242019-10-11 16:57:43 +0200380 if (n2 == MT_LIST_BUSY) { \
Olivier Houcharddb644892019-02-26 18:46:07 +0100381 if (p2 != NULL) \
Olivier Houchard859dc802019-08-08 15:47:21 +0200382 p->next = p2; \
383 (el)->prev = p; \
384 (el)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100385 __ha_barrier_store(); \
386 continue; \
387 } \
388 } \
Olivier Houchard859dc802019-08-08 15:47:21 +0200389 n->prev = p; \
390 p->next = n; \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200391 if (p != (el) && n != (el)) \
392 _ret = 1; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100393 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200394 (el)->prev = (el); \
395 (el)->next = (el); \
Willy Tarreau4c747e82019-02-28 15:05:53 +0100396 __ha_barrier_store(); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100397 break; \
398 } \
Olivier Houchard0cd6a972019-09-20 17:32:47 +0200399 } while (0); \
400 (_ret); \
401 })
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100402
403
404/* Remove the first element from the list, and return it */
Olivier Houchard74715da2019-10-11 16:55:11 +0200405#define MT_LIST_POP(_lh, pt, el) \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100406 ({ \
407 void *_ret; \
Olivier Houchard74715da2019-10-11 16:55:11 +0200408 struct mt_list *lh = (_lh); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100409 while (1) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200410 struct mt_list *n, *n2; \
411 struct mt_list *p, *p2; \
Olivier Houchard804ef242019-10-11 16:57:43 +0200412 n = _HA_ATOMIC_XCHG(&(lh)->next, MT_LIST_BUSY); \
413 if (n == MT_LIST_BUSY) \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100414 continue; \
415 if (n == (lh)) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200416 (lh)->next = lh; \
Willy Tarreau690d2ad2019-02-28 11:14:22 +0100417 __ha_barrier_store(); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100418 _ret = NULL; \
419 break; \
420 } \
Olivier Houchard804ef242019-10-11 16:57:43 +0200421 p = _HA_ATOMIC_XCHG(&n->prev, MT_LIST_BUSY); \
422 if (p == MT_LIST_BUSY) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200423 (lh)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100424 __ha_barrier_store(); \
425 continue; \
426 } \
Olivier Houchard804ef242019-10-11 16:57:43 +0200427 n2 = _HA_ATOMIC_XCHG(&n->next, MT_LIST_BUSY); \
428 if (n2 == MT_LIST_BUSY) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200429 n->prev = p; \
Willy Tarreau690d2ad2019-02-28 11:14:22 +0100430 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200431 (lh)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100432 __ha_barrier_store(); \
433 continue; \
434 } \
Olivier Houchard804ef242019-10-11 16:57:43 +0200435 p2 = _HA_ATOMIC_XCHG(&n2->prev, MT_LIST_BUSY); \
436 if (p2 == MT_LIST_BUSY) { \
Olivier Houchard859dc802019-08-08 15:47:21 +0200437 n->next = n2; \
438 n->prev = p; \
Willy Tarreau690d2ad2019-02-28 11:14:22 +0100439 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200440 (lh)->next = n; \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100441 __ha_barrier_store(); \
442 continue; \
443 } \
Olivier Houchard859dc802019-08-08 15:47:21 +0200444 (lh)->next = n2; \
445 (n2)->prev = (lh); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100446 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200447 (n)->prev = (n); \
448 (n)->next = (n); \
Willy Tarreau4c747e82019-02-28 15:05:53 +0100449 __ha_barrier_store(); \
Olivier Houchard859dc802019-08-08 15:47:21 +0200450 _ret = MT_LIST_ELEM(n, pt, el); \
Olivier Houcharda8434ec2019-01-18 17:26:26 +0100451 break; \
452 } \
453 (_ret); \
454 })
William Lallemand83215a42017-09-24 11:26:02 +0200455
Olivier Houchard859dc802019-08-08 15:47:21 +0200456#define MT_LIST_HEAD(a) ((void *)(&(a)))
457
458#define MT_LIST_INIT(l) ((l)->next = (l)->prev = (l))
459
460#define MT_LIST_HEAD_INIT(l) { &l, &l }
461/* returns a pointer of type <pt> to a structure containing a list head called
462 * <el> at address <lh>. Note that <lh> can be the result of a function or macro
463 * since it's used only once.
464 * Example: MT_LIST_ELEM(cur_node->args.next, struct node *, args)
465 */
466#define MT_LIST_ELEM(lh, pt, el) ((pt)(((void *)(lh)) - ((void *)&((pt)NULL)->el)))
467
468/* checks if the list head <lh> is empty or not */
469#define MT_LIST_ISEMPTY(lh) ((lh)->next == (lh))
470
471/* returns a pointer of type <pt> to a structure following the element
472 * which contains list head <lh>, which is known as element <el> in
473 * struct pt.
474 * Example: MT_LIST_NEXT(args, struct node *, list)
475 */
476#define MT_LIST_NEXT(lh, pt, el) (MT_LIST_ELEM((lh)->next, pt, el))
477
478
479/* returns a pointer of type <pt> to a structure preceding the element
480 * which contains list head <lh>, which is known as element <el> in
481 * struct pt.
482 */
483#undef MT_LIST_PREV
484#define MT_LIST_PREV(lh, pt, el) (MT_LIST_ELEM((lh)->prev, pt, el))
485
486/* checks if the list element <el> was added to a list or not. This only
487 * works when detached elements are reinitialized (using LIST_DEL_INIT)
488 */
489#define MT_LIST_ADDED(el) ((el)->next != (el))
490
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200491/* Lock an element in the list, to be sure it won't be removed.
492 * It needs to be synchronized somehow to be sure it's not removed
493 * from the list in the meanwhile.
494 * This returns a struct mt_list, that will be needed at unlock time.
495 */
Olivier Houchard74715da2019-10-11 16:55:11 +0200496#define MT_LIST_LOCK_ELT(_el) \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200497 ({ \
498 struct mt_list ret; \
Olivier Houchard74715da2019-10-11 16:55:11 +0200499 struct mt_liet *el = (_el); \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200500 while (1) { \
501 struct mt_list *n, *n2; \
502 struct mt_list *p, *p2 = NULL; \
Olivier Houchard804ef242019-10-11 16:57:43 +0200503 n = _HA_ATOMIC_XCHG(&(el)->next, MT_LIST_BUSY); \
504 if (n == MT_LIST_BUSY) \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200505 continue; \
Olivier Houchard804ef242019-10-11 16:57:43 +0200506 p = _HA_ATOMIC_XCHG(&(el)->prev, MT_LIST_BUSY); \
507 if (p == MT_LIST_BUSY) { \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200508 (el)->next = n; \
509 __ha_barrier_store(); \
510 continue; \
511 } \
512 if (p != (el)) { \
513 p2 = _HA_ATOMIC_XCHG(&p->next, MT_LIST_BUSY);\
Olivier Houchard804ef242019-10-11 16:57:43 +0200514 if (p2 == MT_LIST_BUSY) { \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200515 (el)->prev = p; \
516 (el)->next = n; \
517 __ha_barrier_store(); \
518 continue; \
519 } \
520 } \
521 if (n != (el)) { \
522 n2 = _HA_ATOMIC_XCHG(&n->prev, MT_LIST_BUSY);\
Olivier Houchard804ef242019-10-11 16:57:43 +0200523 if (n2 == MT_LIST_BUSY) { \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200524 if (p2 != NULL) \
525 p->next = p2; \
526 (el)->prev = p; \
527 (el)->next = n; \
528 __ha_barrier_store(); \
529 continue; \
530 } \
531 } \
532 ret.next = n; \
533 ret.prev = p; \
534 break; \
535 } \
536 ret; \
537 })
538
539/* Unlock an element previously locked by MT_LIST_LOCK_ELT. "np" is the
540 * struct mt_list returned by MT_LIST_LOCK_ELT().
541 */
Olivier Houchard74715da2019-10-11 16:55:11 +0200542#define MT_LIST_UNLOCK_ELT(_el, np) \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200543 do { \
544 struct mt_list *n = (np).next, *p = (np).prev; \
Olivier Houchard74715da2019-10-11 16:55:11 +0200545 struct mt_list *el = (_el); \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200546 (el)->next = n; \
547 (el)->prev = p; \
548 if (n != (el)) \
549 n->prev = (el); \
550 if (p != (el)) \
551 p->next = (el); \
552 } while (0)
553
554/* Internal macroes for the foreach macroes */
555#define _MT_LIST_UNLOCK_NEXT(el, np) \
556 do { \
557 struct mt_list *n = (np); \
558 (el)->next = n; \
559 if (n != (el)) \
560 n->prev = (el); \
561 } while (0)
562
563/* Internal macroes for the foreach macroes */
564#define _MT_LIST_UNLOCK_PREV(el, np) \
565 do { \
566 struct mt_list *p = (np); \
567 (el)->prev = p; \
568 if (p != (el)) \
569 p->next = (el); \
570 } while (0)
571
572#define _MT_LIST_LOCK_NEXT(el) \
573 ({ \
574 struct mt_list *n = NULL; \
575 while (1) { \
576 struct mt_list *n2; \
Olivier Houchard804ef242019-10-11 16:57:43 +0200577 n = _HA_ATOMIC_XCHG(&((el)->next), MT_LIST_BUSY); \
578 if (n == MT_LIST_BUSY) \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200579 continue; \
580 if (n != (el)) { \
581 n2 = _HA_ATOMIC_XCHG(&n->prev, MT_LIST_BUSY);\
Olivier Houchard804ef242019-10-11 16:57:43 +0200582 if (n2 == MT_LIST_BUSY) { \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200583 (el)->next = n; \
584 __ha_barrier_store(); \
585 continue; \
586 } \
587 } \
588 break; \
589 } \
590 n; \
591 })
592
593#define _MT_LIST_LOCK_PREV(el) \
594 ({ \
595 struct mt_list *p = NULL; \
596 while (1) { \
597 struct mt_list *p2; \
Olivier Houchard804ef242019-10-11 16:57:43 +0200598 p = _HA_ATOMIC_XCHG(&((el)->prev), MT_LIST_BUSY); \
599 if (p == MT_LIST_BUSY) \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200600 continue; \
601 if (p != (el)) { \
602 p2 = _HA_ATOMIC_XCHG(&p->next, MT_LIST_BUSY);\
Olivier Houchard804ef242019-10-11 16:57:43 +0200603 if (p2 == MT_LIST_BUSY) { \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200604 (el)->prev = p; \
605 __ha_barrier_store(); \
606 continue; \
607 } \
608 } \
609 break; \
610 } \
611 p; \
612 })
613
614#define _MT_LIST_RELINK_DELETED(elt2) \
615 do { \
616 struct mt_list *n = elt2.next, *p = elt2.prev; \
617 n->prev = p; \
618 p->next = n; \
619 } while (0);
620
621/* Equivalent of MT_LIST_DEL(), to be used when parsing the list with mt_list_entry_for_each_safe().
622 * It should be the element currently parsed (tmpelt1)
623 */
Olivier Houchard74715da2019-10-11 16:55:11 +0200624#define MT_LIST_DEL_SAFE(_el) \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200625 do { \
Olivier Houchard74715da2019-10-11 16:55:11 +0200626 struct mt_list *el = (_el); \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200627 (el)->prev = (el); \
628 (el)->next = (el); \
629 (el) = NULL; \
630 } while (0)
631
632/* Simpler FOREACH_ITEM_SAFE macro inspired from Linux sources.
633 * Iterates <item> through a list of items of type "typeof(*item)" which are
634 * linked via a "struct list" member named <member>. A pointer to the head of
635 * the list is passed in <list_head>. A temporary variable <back> of same type
636 * as <item> is needed so that <item> may safely be deleted if needed.
637 * tmpelt1 is a temporary struct mt_list *, and tmpelt2 is a temporary
638 * struct mt_list, used internally, both are needed for MT_LIST_DEL_SAFE.
639 * Example: list_for_each_entry_safe(cur_acl, tmp, known_acl, list, elt1, elt2)
640 * { ... };
641 * If you want to remove the current element, please use MT_LIST_DEL_SAFE.
642 */
643#define mt_list_for_each_entry_safe(item, list_head, member, tmpelt, tmpelt2) \
644 for ((tmpelt) = NULL; (tmpelt) != MT_LIST_BUSY; ({ \
645 if (tmpelt) { \
646 if (tmpelt2.prev) \
647 MT_LIST_UNLOCK_ELT(tmpelt, tmpelt2); \
648 else \
649 _MT_LIST_UNLOCK_NEXT(tmpelt, tmpelt2.next); \
650 } else \
651 _MT_LIST_RELINK_DELETED(tmpelt2); \
652 (tmpelt) = MT_LIST_BUSY; \
Olivier Houchard804ef242019-10-11 16:57:43 +0200653 })) \
Olivier Houchard74715da2019-10-11 16:55:11 +0200654 for ((tmpelt) = (list_head), (tmpelt2).prev = NULL, (tmpelt2).next = _MT_LIST_LOCK_NEXT(tmpelt); ({ \
Olivier Houchard5e9b92c2019-08-12 14:10:12 +0200655 (item) = MT_LIST_ELEM((tmpelt2.next), typeof(item), member); \
656 if (&item->member != (list_head)) { \
657 if (tmpelt2.prev != &item->member) \
658 tmpelt2.next = _MT_LIST_LOCK_NEXT(&item->member); \
659 else \
660 tmpelt2.next = tmpelt; \
661 if (tmpelt != NULL) { \
662 if (tmpelt2.prev) \
663 _MT_LIST_UNLOCK_PREV(tmpelt, tmpelt2.prev); \
664 tmpelt2.prev = tmpelt; \
665 } \
666 (tmpelt) = &item->member; \
667 } \
668 }), \
669 &item->member != (list_head);)
Willy Tarreau2dd0d472006-06-29 17:53:05 +0200670#endif /* _COMMON_MINI_CLIST_H */