mirror of https://github.com/OISF/suricata
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
336 lines
11 KiB
C
336 lines
11 KiB
C
/* $OpenBSD: queue.h,v 1.32 2007/04/30 18:42:34 pedro Exp $ */
|
|
/* $NetBSD: queue.h,v 1.11 1996/05/16 05:17:14 mycroft Exp $ */
|
|
|
|
/*
|
|
* Copyright (c) 1991, 1993
|
|
* The Regents of the University of California. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the University nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*
|
|
* @(#)queue.h 8.5 (Berkeley) 8/20/94
|
|
*/
|
|
|
|
// Disable clang-formatting as these implementations are copied from other
|
|
// sources.
|
|
//
|
|
// clang-format off
|
|
|
|
#ifndef SURICATA_QUEUE_H
|
|
#define SURICATA_QUEUE_H
|
|
|
|
/**
|
|
* This file started as a copy of sys/queue.h from OpenBSD and then had
|
|
* various changes made over time. Now we include the system sys/queue.h
|
|
* and then add missing behavior. On Windows this means we basically add
|
|
* everything. This allows for Suricata builds that integrate with other
|
|
* libraries that make use of sys/queue.h to use the exact same definitions
|
|
* from queue.h instead the Suricata copy.
|
|
*/
|
|
|
|
|
|
#if defined(HAVE_SYS_QUEUE_H) && !defined(__clang_analyzer__)
|
|
#include <sys/queue.h>
|
|
#endif
|
|
|
|
#if defined(__clang_analyzer__)
|
|
#define _Q_ASSERT(a) assert((a))
|
|
#else
|
|
#define _Q_ASSERT(a)
|
|
#endif
|
|
|
|
/* The BSDs have removed CIRCLEQ but it still exists in Linux.
|
|
*
|
|
* This implementation from OpenBSD sys/queue.h v1.40 as it still has
|
|
* CIRCLEQ and includes the safe variations.
|
|
* - _Q_INVALIDATE for some extra debugging has been removed as its
|
|
* not available on the Linux version of CIRCLEQ.
|
|
*/
|
|
|
|
#ifndef CIRCLEQ_HEAD
|
|
|
|
/*
|
|
* Circular queue definitions.
|
|
*/
|
|
#define CIRCLEQ_HEAD(name, type) \
|
|
struct name { \
|
|
struct type *cqh_first; /* first element */ \
|
|
struct type *cqh_last; /* last element */ \
|
|
}
|
|
|
|
#define CIRCLEQ_HEAD_INITIALIZER(head) \
|
|
{ CIRCLEQ_END(&head), CIRCLEQ_END(&head) }
|
|
|
|
#define CIRCLEQ_ENTRY(type) \
|
|
struct { \
|
|
struct type *cqe_next; /* next element */ \
|
|
struct type *cqe_prev; /* previous element */ \
|
|
}
|
|
|
|
/*
|
|
* Circular queue access methods
|
|
*/
|
|
#define CIRCLEQ_FIRST(head) ((head)->cqh_first)
|
|
#define CIRCLEQ_LAST(head) ((head)->cqh_last)
|
|
#define CIRCLEQ_NEXT(elm, field) ((elm)->field.cqe_next)
|
|
#define CIRCLEQ_PREV(elm, field) ((elm)->field.cqe_prev)
|
|
#define CIRCLEQ_EMPTY(head) \
|
|
(CIRCLEQ_FIRST(head) == CIRCLEQ_END(head))
|
|
|
|
#define CIRCLEQ_FOREACH(var, head, field) \
|
|
for((var) = CIRCLEQ_FIRST(head); \
|
|
(var) != CIRCLEQ_END(head); \
|
|
(var) = CIRCLEQ_NEXT(var, field))
|
|
|
|
#define CIRCLEQ_FOREACH_SAFE(var, head, field, tvar) \
|
|
for ((var) = CIRCLEQ_FIRST(head); \
|
|
(var) != CIRCLEQ_END(head) && \
|
|
((tvar) = CIRCLEQ_NEXT(var, field), 1); \
|
|
(var) = (tvar))
|
|
|
|
#define CIRCLEQ_FOREACH_REVERSE(var, head, field) \
|
|
for((var) = CIRCLEQ_LAST(head); \
|
|
(var) != CIRCLEQ_END(head); \
|
|
(var) = CIRCLEQ_PREV(var, field))
|
|
|
|
#define CIRCLEQ_FOREACH_REVERSE_SAFE(var, head, headname, field, tvar) \
|
|
for ((var) = CIRCLEQ_LAST(head, headname); \
|
|
(var) != CIRCLEQ_END(head) && \
|
|
((tvar) = CIRCLEQ_PREV(var, headname, field), 1); \
|
|
(var) = (tvar))
|
|
|
|
/*
|
|
* Circular queue functions.
|
|
*/
|
|
#define CIRCLEQ_INIT(head) do { \
|
|
(head)->cqh_first = CIRCLEQ_END(head); \
|
|
(head)->cqh_last = CIRCLEQ_END(head); \
|
|
} while (0)
|
|
|
|
#define CIRCLEQ_INSERT_AFTER(head, listelm, elm, field) do { \
|
|
(elm)->field.cqe_next = (listelm)->field.cqe_next; \
|
|
(elm)->field.cqe_prev = (listelm); \
|
|
if ((listelm)->field.cqe_next == CIRCLEQ_END(head)) \
|
|
(head)->cqh_last = (elm); \
|
|
else \
|
|
(listelm)->field.cqe_next->field.cqe_prev = (elm); \
|
|
(listelm)->field.cqe_next = (elm); \
|
|
} while (0)
|
|
|
|
#define CIRCLEQ_INSERT_BEFORE(head, listelm, elm, field) do { \
|
|
(elm)->field.cqe_next = (listelm); \
|
|
(elm)->field.cqe_prev = (listelm)->field.cqe_prev; \
|
|
if ((listelm)->field.cqe_prev == CIRCLEQ_END(head)) \
|
|
(head)->cqh_first = (elm); \
|
|
else \
|
|
(listelm)->field.cqe_prev->field.cqe_next = (elm); \
|
|
(listelm)->field.cqe_prev = (elm); \
|
|
} while (0)
|
|
|
|
#define CIRCLEQ_INSERT_HEAD(head, elm, field) do { \
|
|
(elm)->field.cqe_next = (head)->cqh_first; \
|
|
(elm)->field.cqe_prev = CIRCLEQ_END(head); \
|
|
if ((head)->cqh_last == CIRCLEQ_END(head)) \
|
|
(head)->cqh_last = (elm); \
|
|
else \
|
|
(head)->cqh_first->field.cqe_prev = (elm); \
|
|
(head)->cqh_first = (elm); \
|
|
} while (0)
|
|
|
|
#define CIRCLEQ_INSERT_TAIL(head, elm, field) do { \
|
|
(elm)->field.cqe_next = CIRCLEQ_END(head); \
|
|
(elm)->field.cqe_prev = (head)->cqh_last; \
|
|
if ((head)->cqh_first == CIRCLEQ_END(head)) \
|
|
(head)->cqh_first = (elm); \
|
|
else \
|
|
(head)->cqh_last->field.cqe_next = (elm); \
|
|
(head)->cqh_last = (elm); \
|
|
} while (0)
|
|
|
|
#define CIRCLEQ_REMOVE(head, elm, field) do { \
|
|
if ((elm)->field.cqe_next == CIRCLEQ_END(head)) \
|
|
(head)->cqh_last = (elm)->field.cqe_prev; \
|
|
else \
|
|
(elm)->field.cqe_next->field.cqe_prev = \
|
|
(elm)->field.cqe_prev; \
|
|
if ((elm)->field.cqe_prev == CIRCLEQ_END(head)) \
|
|
(head)->cqh_first = (elm)->field.cqe_next; \
|
|
else \
|
|
(elm)->field.cqe_prev->field.cqe_next = \
|
|
(elm)->field.cqe_next; \
|
|
} while (0)
|
|
|
|
#define CIRCLEQ_REPLACE(head, elm, elm2, field) do { \
|
|
if (((elm2)->field.cqe_next = (elm)->field.cqe_next) == \
|
|
CIRCLEQ_END(head)) \
|
|
(head)->cqh_last = (elm2); \
|
|
else \
|
|
(elm2)->field.cqe_next->field.cqe_prev = (elm2); \
|
|
if (((elm2)->field.cqe_prev = (elm)->field.cqe_prev) == \
|
|
CIRCLEQ_END(head)) \
|
|
(head)->cqh_first = (elm2); \
|
|
else \
|
|
(elm2)->field.cqe_prev->field.cqe_next = (elm2); \
|
|
} while (0)
|
|
|
|
#endif /* !CIRCLEQ_HEAD */
|
|
|
|
/* Required by local implementation as well as _SAFE variations. */
|
|
#ifndef CIRCLEQ_END
|
|
#define CIRCLEQ_END(head) ((void *)(head))
|
|
#endif /* !CIRCLEQ_END */
|
|
|
|
#ifndef CIRCLEQ_FOREACH_SAFE
|
|
#define CIRCLEQ_FOREACH_SAFE(var, head, field, tvar) \
|
|
for ((var) = CIRCLEQ_FIRST(head); \
|
|
(var) != CIRCLEQ_END(head) && \
|
|
((tvar) = CIRCLEQ_NEXT(var, field), 1); \
|
|
(var) = (tvar))
|
|
|
|
#define CIRCLEQ_FOREACH_REVERSE_SAFE(var, head, headname, field, tvar) \
|
|
for ((var) = CIRCLEQ_LAST(head, headname); \
|
|
(var) != CIRCLEQ_END(head) && \
|
|
((tvar) = CIRCLEQ_PREV(var, headname, field), 1); \
|
|
(var) = (tvar))
|
|
#endif /* !CIRCLEQ_FOREACH_SAFE */
|
|
|
|
/*
|
|
* Complete TAILQ implementation as sys/queue.h is not available on Windows
|
|
* and used by Suricata.
|
|
*
|
|
* This implementation copied from FreeBSD sys/queue.h with the addition
|
|
* of our _Q_ASSERT macros to satisy scan-build.
|
|
*/
|
|
#ifndef TAILQ_HEAD
|
|
|
|
/*
|
|
* Tail queue declarations.
|
|
*/
|
|
#define TAILQ_HEAD(name, type) \
|
|
struct name { \
|
|
struct type *tqh_first; /* first element */ \
|
|
struct type **tqh_last; /* addr of last next element */ \
|
|
}
|
|
|
|
#define TAILQ_HEAD_INITIALIZER(head) \
|
|
{ NULL, &(head).tqh_first }
|
|
|
|
#define TAILQ_ENTRY(type) \
|
|
struct { \
|
|
struct type *tqe_next; /* next element */ \
|
|
struct type **tqe_prev; /* address of previous next element */ \
|
|
}
|
|
|
|
/*
|
|
* Tail queue functions.
|
|
*/
|
|
#define TAILQ_EMPTY(head) ((head)->tqh_first == NULL)
|
|
|
|
#define TAILQ_FIRST(head) ((head)->tqh_first)
|
|
|
|
#define TAILQ_FOREACH(var, head, field) \
|
|
for ((var) = TAILQ_FIRST((head)); \
|
|
(var); \
|
|
(var) = TAILQ_NEXT((var), field))
|
|
|
|
#define TAILQ_FOREACH_REVERSE(var, head, headname, field) \
|
|
for ((var) = TAILQ_LAST((head), headname); \
|
|
(var); \
|
|
(var) = TAILQ_PREV((var), headname, field))
|
|
|
|
#define TAILQ_INIT(head) do { \
|
|
TAILQ_FIRST((head)) = NULL; \
|
|
(head)->tqh_last = &TAILQ_FIRST((head)); \
|
|
} while (0)
|
|
|
|
#define TAILQ_INSERT_AFTER(head, listelm, elm, field) do { \
|
|
if ((TAILQ_NEXT((elm), field) = TAILQ_NEXT((listelm), field)) != NULL)\
|
|
TAILQ_NEXT((elm), field)->field.tqe_prev = \
|
|
&TAILQ_NEXT((elm), field); \
|
|
else \
|
|
(head)->tqh_last = &TAILQ_NEXT((elm), field); \
|
|
TAILQ_NEXT((listelm), field) = (elm); \
|
|
(elm)->field.tqe_prev = &TAILQ_NEXT((listelm), field); \
|
|
} while (0)
|
|
|
|
#define TAILQ_INSERT_BEFORE(listelm, elm, field) do { \
|
|
(elm)->field.tqe_prev = (listelm)->field.tqe_prev; \
|
|
TAILQ_NEXT((elm), field) = (listelm); \
|
|
*(listelm)->field.tqe_prev = (elm); \
|
|
(listelm)->field.tqe_prev = &TAILQ_NEXT((elm), field); \
|
|
} while (0)
|
|
|
|
#define TAILQ_INSERT_HEAD(head, elm, field) do { \
|
|
if ((TAILQ_NEXT((elm), field) = TAILQ_FIRST((head))) != NULL) \
|
|
TAILQ_FIRST((head))->field.tqe_prev = \
|
|
&TAILQ_NEXT((elm), field); \
|
|
else \
|
|
(head)->tqh_last = &TAILQ_NEXT((elm), field); \
|
|
TAILQ_FIRST((head)) = (elm); \
|
|
(elm)->field.tqe_prev = &TAILQ_FIRST((head)); \
|
|
} while (0)
|
|
|
|
#define TAILQ_INSERT_TAIL(head, elm, field) do { \
|
|
_Q_ASSERT((elm)); \
|
|
_Q_ASSERT((head)); \
|
|
TAILQ_NEXT((elm), field) = NULL; \
|
|
(elm)->field.tqe_prev = (head)->tqh_last; \
|
|
*(head)->tqh_last = (elm); \
|
|
_Q_ASSERT(*(head)->tqh_last); \
|
|
(head)->tqh_last = &TAILQ_NEXT((elm), field); \
|
|
} while (0)
|
|
|
|
#define TAILQ_LAST(head, headname) \
|
|
(*(((struct headname *)((head)->tqh_last))->tqh_last))
|
|
|
|
#define TAILQ_NEXT(elm, field) ((elm)->field.tqe_next)
|
|
|
|
#define TAILQ_PREV(elm, headname, field) \
|
|
(*(((struct headname *)((elm)->field.tqe_prev))->tqh_last))
|
|
|
|
#define TAILQ_REMOVE(head, elm, field) do { \
|
|
if ((TAILQ_NEXT((elm), field)) != NULL) \
|
|
TAILQ_NEXT((elm), field)->field.tqe_prev = \
|
|
(elm)->field.tqe_prev; \
|
|
else \
|
|
(head)->tqh_last = (elm)->field.tqe_prev; \
|
|
_Q_ASSERT((head)->tqh_first != (elm)); \
|
|
*(elm)->field.tqe_prev = TAILQ_NEXT((elm), field); \
|
|
} while (0)
|
|
|
|
#endif /* !TAILQ_HEAD */
|
|
|
|
/* Not included in Linux, but are in FreeBSD and friends.
|
|
*
|
|
* This implementation from FreeBSD's sys/queue.h.
|
|
*/
|
|
#ifndef TAILQ_FOREACH_SAFE
|
|
#define TAILQ_FOREACH_SAFE(var, head, field, tvar) \
|
|
for ((var) = TAILQ_FIRST((head)); \
|
|
(var) && ((tvar) = TAILQ_NEXT((var), field), 1); \
|
|
(var) = (tvar))
|
|
#endif
|
|
|
|
#endif /* !SURICATA_QUEUE_H */
|