2006-04-12 17:15:57 +00:00
|
|
|
/*
|
2014-12-23 12:58:43 +00:00
|
|
|
* include/common/mini-clist.h
|
|
|
|
* Circular list manipulation macros and structures.
|
2006-04-12 17:15:57 +00:00
|
|
|
*
|
2014-12-23 12:58:43 +00:00
|
|
|
* Copyright (C) 2002-2014 Willy Tarreau - w@1wt.eu
|
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
* License as published by the Free Software Foundation, version 2.1
|
|
|
|
* exclusively.
|
|
|
|
*
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
* License along with this library; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
2006-04-12 17:15:57 +00:00
|
|
|
*/
|
|
|
|
|
2006-06-29 15:53:05 +00:00
|
|
|
#ifndef _COMMON_MINI_CLIST_H
|
|
|
|
#define _COMMON_MINI_CLIST_H
|
2006-04-12 17:15:57 +00:00
|
|
|
|
2006-06-29 16:54:54 +00:00
|
|
|
#include <common/config.h>
|
|
|
|
|
2006-04-12 17:15:57 +00:00
|
|
|
/* these are circular or bidirectionnal lists only. Each list pointer points to
|
|
|
|
* another list pointer in a structure, and not the structure itself. The
|
|
|
|
* pointer to the next element MUST be the first one so that the list is easily
|
|
|
|
* cast as a single linked list or pointer.
|
|
|
|
*/
|
|
|
|
struct list {
|
|
|
|
struct list *n; /* next */
|
|
|
|
struct list *p; /* prev */
|
|
|
|
};
|
|
|
|
|
2008-12-07 19:00:15 +00:00
|
|
|
/* a back-ref is a pointer to a target list entry. It is used to detect when an
|
|
|
|
* element being deleted is currently being tracked by another user. The best
|
|
|
|
* example is a user dumping the session table. The table does not fit in the
|
|
|
|
* output buffer so we have to set a mark on a session and go on later. But if
|
|
|
|
* that marked session gets deleted, we don't want the user's pointer to go in
|
|
|
|
* the wild. So we can simply link this user's request to the list of this
|
|
|
|
* session's users, and put a pointer to the list element in ref, that will be
|
|
|
|
* used as the mark for next iteration.
|
|
|
|
*/
|
|
|
|
struct bref {
|
|
|
|
struct list users;
|
|
|
|
struct list *ref; /* pointer to the target's list entry */
|
|
|
|
};
|
|
|
|
|
2010-01-03 20:03:22 +00:00
|
|
|
/* a word list is a generic list with a pointer to a string in each element. */
|
|
|
|
struct wordlist {
|
|
|
|
struct list list;
|
|
|
|
char *s;
|
|
|
|
};
|
|
|
|
|
2010-01-28 17:10:50 +00:00
|
|
|
/* this is the same as above with an additional pointer to a condition. */
|
|
|
|
struct cond_wordlist {
|
|
|
|
struct list list;
|
|
|
|
void *cond;
|
|
|
|
char *s;
|
|
|
|
};
|
|
|
|
|
2007-10-28 10:41:06 +00:00
|
|
|
/* First undefine some macros which happen to also be defined on OpenBSD,
|
|
|
|
* in sys/queue.h, used by sys/event.h
|
|
|
|
*/
|
|
|
|
#undef LIST_HEAD
|
|
|
|
#undef LIST_INIT
|
|
|
|
#undef LIST_NEXT
|
|
|
|
|
2013-06-21 21:16:39 +00:00
|
|
|
/* ILH = Initialized List Head : used to prevent gcc from moving an empty
|
|
|
|
* list to BSS. Some older version tend to trim all the array and cause
|
|
|
|
* corruption.
|
|
|
|
*/
|
|
|
|
#define ILH { .n = (struct list *)1, .p = (struct list *)2 }
|
|
|
|
|
2006-06-26 00:48:02 +00:00
|
|
|
#define LIST_HEAD(a) ((void *)(&(a)))
|
|
|
|
|
2006-04-12 17:15:57 +00:00
|
|
|
#define LIST_INIT(l) ((l)->n = (l)->p = (l))
|
|
|
|
|
2007-05-06 22:18:32 +00:00
|
|
|
#define LIST_HEAD_INIT(l) { &l, &l }
|
|
|
|
|
2006-04-12 17:15:57 +00:00
|
|
|
/* adds an element at the beginning of a list ; returns the element */
|
|
|
|
#define LIST_ADD(lh, el) ({ (el)->n = (lh)->n; (el)->n->p = (lh)->n = (el); (el)->p = (lh); (el); })
|
|
|
|
|
|
|
|
/* adds an element at the end of a list ; returns the element */
|
|
|
|
#define LIST_ADDQ(lh, el) ({ (el)->p = (lh)->p; (el)->p->n = (lh)->p = (el); (el)->n = (lh); (el); })
|
|
|
|
|
|
|
|
/* removes an element from a list and returns it */
|
|
|
|
#define LIST_DEL(el) ({ typeof(el) __ret = (el); (el)->n->p = (el)->p; (el)->p->n = (el)->n; (__ret); })
|
|
|
|
|
|
|
|
/* returns a pointer of type <pt> to a structure containing a list head called
|
|
|
|
* <el> at address <lh>. Note that <lh> can be the result of a function or macro
|
|
|
|
* since it's used only once.
|
|
|
|
* Example: LIST_ELEM(cur_node->args.next, struct node *, args)
|
|
|
|
*/
|
|
|
|
#define LIST_ELEM(lh, pt, el) ((pt)(((void *)(lh)) - ((void *)&((pt)NULL)->el)))
|
|
|
|
|
|
|
|
/* checks if the list head <lh> is empty or not */
|
|
|
|
#define LIST_ISEMPTY(lh) ((lh)->n == (lh))
|
|
|
|
|
|
|
|
/* returns a pointer of type <pt> to a structure following the element
|
|
|
|
* which contains list head <lh>, which is known as element <el> in
|
|
|
|
* struct pt.
|
|
|
|
* Example: LIST_NEXT(args, struct node *, list)
|
|
|
|
*/
|
|
|
|
#define LIST_NEXT(lh, pt, el) (LIST_ELEM((lh)->n, pt, el))
|
|
|
|
|
|
|
|
|
|
|
|
/* returns a pointer of type <pt> to a structure preceeding the element
|
|
|
|
* which contains list head <lh>, which is known as element <el> in
|
|
|
|
* struct pt.
|
|
|
|
*/
|
2015-11-03 18:17:37 +00:00
|
|
|
#undef LIST_PREV
|
2006-04-12 17:15:57 +00:00
|
|
|
#define LIST_PREV(lh, pt, el) (LIST_ELEM((lh)->p, pt, el))
|
|
|
|
|
2007-05-02 18:46:49 +00:00
|
|
|
/*
|
|
|
|
* Simpler FOREACH_ITEM macro inspired from Linux sources.
|
|
|
|
* Iterates <item> through a list of items of type "typeof(*item)" which are
|
|
|
|
* linked via a "struct list" member named <member>. A pointer to the head of
|
|
|
|
* the list is passed in <list_head>. No temporary variable is needed. Note
|
|
|
|
* that <item> must not be modified during the loop.
|
|
|
|
* Example: list_for_each_entry(cur_acl, known_acl, list) { ... };
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry(item, list_head, member) \
|
|
|
|
for (item = LIST_ELEM((list_head)->n, typeof(item), member); \
|
|
|
|
&item->member != (list_head); \
|
|
|
|
item = LIST_ELEM(item->member.n, typeof(item), member))
|
|
|
|
|
2017-09-24 09:26:02 +00:00
|
|
|
/*
|
|
|
|
* Same as list_for_each_entry but starting from current point
|
|
|
|
* Iterates <item> through the list starting from <item>
|
|
|
|
* It's basically the same macro but without initializing item to the head of
|
|
|
|
* the list.
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry_from(item, list_head, member) \
|
|
|
|
for ( ; &item->member != (list_head); \
|
|
|
|
item = LIST_ELEM(item->member.n, typeof(item), member))
|
|
|
|
|
2007-05-02 18:46:49 +00:00
|
|
|
/*
|
|
|
|
* Simpler FOREACH_ITEM_SAFE macro inspired from Linux sources.
|
|
|
|
* Iterates <item> through a list of items of type "typeof(*item)" which are
|
|
|
|
* linked via a "struct list" member named <member>. A pointer to the head of
|
|
|
|
* the list is passed in <list_head>. A temporary variable <back> of same type
|
|
|
|
* as <item> is needed so that <item> may safely be deleted if needed.
|
|
|
|
* Example: list_for_each_entry_safe(cur_acl, tmp, known_acl, list) { ... };
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry_safe(item, back, list_head, member) \
|
|
|
|
for (item = LIST_ELEM((list_head)->n, typeof(item), member), \
|
|
|
|
back = LIST_ELEM(item->member.n, typeof(item), member); \
|
|
|
|
&item->member != (list_head); \
|
|
|
|
item = back, back = LIST_ELEM(back->member.n, typeof(back), member))
|
|
|
|
|
|
|
|
|
2017-09-24 09:26:02 +00:00
|
|
|
/*
|
|
|
|
* Same as list_for_each_entry_safe but starting from current point
|
|
|
|
* Iterates <item> through the list starting from <item>
|
|
|
|
* It's basically the same macro but without initializing item to the head of
|
|
|
|
* the list.
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry_safe_from(item, back, list_head, member) \
|
|
|
|
for (back = LIST_ELEM(item->member.n, typeof(item), member); \
|
|
|
|
&item->member != (list_head); \
|
|
|
|
item = back, back = LIST_ELEM(back->member.n, typeof(back), member))
|
|
|
|
|
|
|
|
|
2006-06-29 15:53:05 +00:00
|
|
|
#endif /* _COMMON_MINI_CLIST_H */
|