queue.h 21.4 KB
Newer Older
Cedric Roux's avatar
Cedric Roux committed
1 2
/*
 * Copyright (c) 1991, 1993
3
 *  The Regents of the University of California.  All rights reserved.
Cedric Roux's avatar
Cedric Roux committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
 *
 * 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.
 *
29
 *  @(#)queue.h 8.5 (Berkeley) 8/20/94
Cedric Roux's avatar
Cedric Roux committed
30 31
 */

32 33
#ifndef _SYS_QUEUE_H_
#define _SYS_QUEUE_H_
Cedric Roux's avatar
Cedric Roux committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101

/*
 * This file defines five types of data structures: singly-linked lists,
 * lists, simple queues, tail queues, and circular queues.
 *
 * A singly-linked list is headed by a single forward pointer. The
 * elements are singly linked for minimum space and pointer manipulation
 * overhead at the expense of O(n) removal for arbitrary elements. New
 * elements can be added to the list after an existing element or at the
 * head of the list.  Elements being removed from the head of the list
 * should use the explicit macro for this purpose for optimum
 * efficiency. A singly-linked list may only be traversed in the forward
 * direction.  Singly-linked lists are ideal for applications with large
 * datasets and few or no removals or for implementing a LIFO queue.
 *
 * A list is headed by a single forward pointer (or an array of forward
 * pointers for a hash table header). The elements are doubly linked
 * so that an arbitrary element can be removed without a need to
 * traverse the list. New elements can be added to the list before
 * or after an existing element or at the head of the list. A list
 * may only be traversed in the forward direction.
 *
 * A simple queue is headed by a pair of pointers, one the head of the
 * list and the other to the tail of the list. The elements are singly
 * linked to save space, so elements can only be removed from the
 * head of the list. New elements can be added to the list after
 * an existing element, at the head of the list, or at the end of the
 * list. A simple queue may only be traversed in the forward direction.
 *
 * A tail queue is headed by a pair of pointers, one to the head of the
 * list and the other to the tail of the list. The elements are doubly
 * linked so that an arbitrary element can be removed without a need to
 * traverse the list. New elements can be added to the list before or
 * after an existing element, at the head of the list, or at the end of
 * the list. A tail queue may be traversed in either direction.
 *
 * A circle queue is headed by a pair of pointers, one to the head of the
 * list and the other to the tail of the list. The elements are doubly
 * linked so that an arbitrary element can be removed without a need to
 * traverse the list. New elements can be added to the list before or after
 * an existing element, at the head of the list, or at the end of the list.
 * A circle queue may be traversed in either direction, but has a more
 * complex end of list detection.
 *
 * For details on the use of these macros, see the queue(3) manual page.
 *                      SLIST   LIST    STAILQ  TAILQ   CIRCLEQ
 * _HEAD                +       +       +       +       +
 * _HEAD_INITIALIZER    +       +       +       +       +
 * _ENTRY               +       +       +       +       +
 * _INIT                +       +       +       +       +
 * _EMPTY               +       +       +       +       +
 * _FIRST               +       +       +       +       +
 * _NEXT                +       +       +       +       +
 * _PREV                -       -       -       +       +
 * _LAST                -       -       +       +       +
 * _FOREACH             +       +       +       +       +
 * _FOREACH_REVERSE     -       -       -       +       +
 * _INSERT_HEAD         +       +       +       +       +
 * _INSERT_BEFORE       -       +       -       +       +
 * _INSERT_AFTER        +       +       +       +       +
 * _INSERT_TAIL         -       -       +       +       +
 * _REMOVE_HEAD         +       -       +       -       -
 * _REMOVE              +       +       +       +       +
 */

/*
 * List definitions.
 */
102 103 104
#define LIST_HEAD(name, type)           \
struct name {               \
  struct type *lh_first;  /* first element */     \
Cedric Roux's avatar
Cedric Roux committed
105 106
}

107 108
#define LIST_HEAD_INITIALIZER(head)         \
  { NULL }
Cedric Roux's avatar
Cedric Roux committed
109

110 111 112 113
#define LIST_ENTRY(type)            \
struct {                \
  struct type *le_next; /* next element */      \
  struct type **le_prev;  /* address of previous next element */  \
Cedric Roux's avatar
Cedric Roux committed
114 115 116 117 118
}

/*
 * List functions.
 */
119 120
#define LIST_INIT(head) do {            \
  (head)->lh_first = NULL;          \
Cedric Roux's avatar
Cedric Roux committed
121 122
} while (/*CONSTCOND*/0)

123 124 125 126 127 128
#define LIST_INSERT_AFTER(listelm, elm, field) do {     \
  if (((elm)->field.le_next = (listelm)->field.le_next) != NULL)  \
    (listelm)->field.le_next->field.le_prev =   \
        &(elm)->field.le_next;        \
  (listelm)->field.le_next = (elm);       \
  (elm)->field.le_prev = &(listelm)->field.le_next;   \
Cedric Roux's avatar
Cedric Roux committed
129 130
} while (/*CONSTCOND*/0)

131 132 133 134 135
#define LIST_INSERT_BEFORE(listelm, elm, field) do {      \
  (elm)->field.le_prev = (listelm)->field.le_prev;    \
  (elm)->field.le_next = (listelm);       \
  *(listelm)->field.le_prev = (elm);        \
  (listelm)->field.le_prev = &(elm)->field.le_next;   \
Cedric Roux's avatar
Cedric Roux committed
136 137
} while (/*CONSTCOND*/0)

138 139 140 141 142
#define LIST_INSERT_HEAD(head, elm, field) do {       \
  if (((elm)->field.le_next = (head)->lh_first) != NULL)    \
    (head)->lh_first->field.le_prev = &(elm)->field.le_next;\
  (head)->lh_first = (elm);         \
  (elm)->field.le_prev = &(head)->lh_first;     \
Cedric Roux's avatar
Cedric Roux committed
143 144
} while (/*CONSTCOND*/0)

145 146 147 148 149
#define LIST_REMOVE(elm, field) do {          \
  if ((elm)->field.le_next != NULL)       \
    (elm)->field.le_next->field.le_prev =       \
        (elm)->field.le_prev;       \
  *(elm)->field.le_prev = (elm)->field.le_next;     \
Cedric Roux's avatar
Cedric Roux committed
150 151
} while (/*CONSTCOND*/0)

152 153 154 155
#define LIST_FOREACH(var, head, field)          \
  for ((var) = ((head)->lh_first);        \
    (var);              \
    (var) = ((var)->field.le_next))
Cedric Roux's avatar
Cedric Roux committed
156 157 158 159

/*
 * List access methods.
 */
160 161 162
#define LIST_EMPTY(head)    ((head)->lh_first == NULL)
#define LIST_FIRST(head)    ((head)->lh_first)
#define LIST_NEXT(elm, field)   ((elm)->field.le_next)
Cedric Roux's avatar
Cedric Roux committed
163 164 165 166 167


/*
 * Singly-linked List definitions.
 */
168 169 170
#define SLIST_HEAD(name, type)            \
struct name {               \
  struct type *slh_first; /* first element */     \
Cedric Roux's avatar
Cedric Roux committed
171 172
}

173 174
#define SLIST_HEAD_INITIALIZER(head)          \
  { NULL }
Cedric Roux's avatar
Cedric Roux committed
175

176 177 178
#define SLIST_ENTRY(type)           \
struct {                \
  struct type *sle_next;  /* next element */      \
Cedric Roux's avatar
Cedric Roux committed
179 180 181 182 183
}

/*
 * Singly-linked List functions.
 */
184 185
#define SLIST_INIT(head) do {           \
  (head)->slh_first = NULL;         \
Cedric Roux's avatar
Cedric Roux committed
186 187
} while (/*CONSTCOND*/0)

188 189 190
#define SLIST_INSERT_AFTER(slistelm, elm, field) do {     \
  (elm)->field.sle_next = (slistelm)->field.sle_next;   \
  (slistelm)->field.sle_next = (elm);       \
Cedric Roux's avatar
Cedric Roux committed
191 192
} while (/*CONSTCOND*/0)

193 194 195
#define SLIST_INSERT_HEAD(head, elm, field) do {      \
  (elm)->field.sle_next = (head)->slh_first;      \
  (head)->slh_first = (elm);          \
Cedric Roux's avatar
Cedric Roux committed
196 197
} while (/*CONSTCOND*/0)

198 199
#define SLIST_REMOVE_HEAD(head, field) do {       \
  (head)->slh_first = (head)->slh_first->field.sle_next;    \
Cedric Roux's avatar
Cedric Roux committed
200 201
} while (/*CONSTCOND*/0)

202 203 204 205 206 207 208 209 210 211 212
#define SLIST_REMOVE(head, elm, type, field) do {     \
  if ((head)->slh_first == (elm)) {       \
    SLIST_REMOVE_HEAD((head), field);     \
  }               \
  else {                \
    struct type *curelm = (head)->slh_first;    \
    while(curelm->field.sle_next != (elm))      \
      curelm = curelm->field.sle_next;    \
    curelm->field.sle_next =        \
        curelm->field.sle_next->field.sle_next;   \
  }               \
Cedric Roux's avatar
Cedric Roux committed
213 214
} while (/*CONSTCOND*/0)

215 216
#define SLIST_FOREACH(var, head, field)         \
  for((var) = (head)->slh_first; (var); (var) = (var)->field.sle_next)
Cedric Roux's avatar
Cedric Roux committed
217 218 219 220

/*
 * Singly-linked List access methods.
 */
221 222 223
#define SLIST_EMPTY(head) ((head)->slh_first == NULL)
#define SLIST_FIRST(head) ((head)->slh_first)
#define SLIST_NEXT(elm, field)  ((elm)->field.sle_next)
Cedric Roux's avatar
Cedric Roux committed
224 225 226 227 228


/*
 * Singly-linked Tail queue declarations.
 */
229 230 231 232
#define STAILQ_HEAD(name, type)         \
struct name {               \
  struct type *stqh_first;  /* first element */     \
  struct type **stqh_last;  /* addr of last next element */   \
Cedric Roux's avatar
Cedric Roux committed
233 234
}

235 236
#define STAILQ_HEAD_INITIALIZER(head)         \
  { NULL, &(head).stqh_first }
Cedric Roux's avatar
Cedric Roux committed
237

238 239 240
#define STAILQ_ENTRY(type)            \
struct {                \
  struct type *stqe_next; /* next element */      \
Cedric Roux's avatar
Cedric Roux committed
241 242 243 244 245
}

/*
 * Singly-linked Tail queue functions.
 */
246 247 248
#define STAILQ_INIT(head) do {            \
  (head)->stqh_first = NULL;          \
  (head)->stqh_last = &(head)->stqh_first;        \
Cedric Roux's avatar
Cedric Roux committed
249 250
} while (/*CONSTCOND*/0)

251 252 253 254
#define STAILQ_INSERT_HEAD(head, elm, field) do {     \
  if (((elm)->field.stqe_next = (head)->stqh_first) == NULL)  \
    (head)->stqh_last = &(elm)->field.stqe_next;    \
  (head)->stqh_first = (elm);         \
Cedric Roux's avatar
Cedric Roux committed
255 256
} while (/*CONSTCOND*/0)

257 258 259 260
#define STAILQ_INSERT_TAIL(head, elm, field) do {     \
  (elm)->field.stqe_next = NULL;          \
  *(head)->stqh_last = (elm);         \
  (head)->stqh_last = &(elm)->field.stqe_next;      \
Cedric Roux's avatar
Cedric Roux committed
261 262
} while (/*CONSTCOND*/0)

263 264 265 266
#define STAILQ_INSERT_AFTER(head, listelm, elm, field) do {   \
  if (((elm)->field.stqe_next = (listelm)->field.stqe_next) == NULL)\
    (head)->stqh_last = &(elm)->field.stqe_next;    \
  (listelm)->field.stqe_next = (elm);       \
Cedric Roux's avatar
Cedric Roux committed
267 268
} while (/*CONSTCOND*/0)

269 270 271
#define STAILQ_REMOVE_HEAD(head, field) do {        \
  if (((head)->stqh_first = (head)->stqh_first->field.stqe_next) == NULL) \
    (head)->stqh_last = &(head)->stqh_first;      \
Cedric Roux's avatar
Cedric Roux committed
272 273
} while (/*CONSTCOND*/0)

274 275 276 277 278 279 280 281 282 283 284
#define STAILQ_REMOVE(head, elm, type, field) do {      \
  if ((head)->stqh_first == (elm)) {        \
    STAILQ_REMOVE_HEAD((head), field);      \
  } else {              \
    struct type *curelm = (head)->stqh_first;   \
    while (curelm->field.stqe_next != (elm))      \
      curelm = curelm->field.stqe_next;   \
    if ((curelm->field.stqe_next =        \
      curelm->field.stqe_next->field.stqe_next) == NULL) \
          (head)->stqh_last = &(curelm)->field.stqe_next; \
  }               \
Cedric Roux's avatar
Cedric Roux committed
285 286
} while (/*CONSTCOND*/0)

287 288 289 290
#define STAILQ_FOREACH(var, head, field)        \
  for ((var) = ((head)->stqh_first);        \
    (var);              \
    (var) = ((var)->field.stqe_next))
Cedric Roux's avatar
Cedric Roux committed
291

292 293 294 295 296 297
#define STAILQ_CONCAT(head1, head2) do {        \
  if (!STAILQ_EMPTY((head2))) {         \
    *(head1)->stqh_last = (head2)->stqh_first;    \
    (head1)->stqh_last = (head2)->stqh_last;    \
    STAILQ_INIT((head2));         \
  }               \
Cedric Roux's avatar
Cedric Roux committed
298 299 300 301 302
} while (/*CONSTCOND*/0)

/*
 * Singly-linked Tail queue access methods.
 */
303 304 305
#define STAILQ_EMPTY(head)  ((head)->stqh_first == NULL)
#define STAILQ_FIRST(head)  ((head)->stqh_first)
#define STAILQ_NEXT(elm, field) ((elm)->field.stqe_next)
Cedric Roux's avatar
Cedric Roux committed
306 307 308 309 310


/*
 * Simple queue definitions.
 */
311 312 313 314
#define SIMPLEQ_HEAD(name, type)          \
struct name {               \
  struct type *sqh_first; /* first element */     \
  struct type **sqh_last; /* addr of last next element */   \
Cedric Roux's avatar
Cedric Roux committed
315 316
}

317 318
#define SIMPLEQ_HEAD_INITIALIZER(head)          \
  { NULL, &(head).sqh_first }
Cedric Roux's avatar
Cedric Roux committed
319

320 321 322
#define SIMPLEQ_ENTRY(type)           \
struct {                \
  struct type *sqe_next;  /* next element */      \
Cedric Roux's avatar
Cedric Roux committed
323 324 325 326 327
}

/*
 * Simple queue functions.
 */
328 329 330
#define SIMPLEQ_INIT(head) do {           \
  (head)->sqh_first = NULL;         \
  (head)->sqh_last = &(head)->sqh_first;        \
Cedric Roux's avatar
Cedric Roux committed
331 332
} while (/*CONSTCOND*/0)

333 334 335 336
#define SIMPLEQ_INSERT_HEAD(head, elm, field) do {      \
  if (((elm)->field.sqe_next = (head)->sqh_first) == NULL)  \
    (head)->sqh_last = &(elm)->field.sqe_next;    \
  (head)->sqh_first = (elm);          \
Cedric Roux's avatar
Cedric Roux committed
337 338
} while (/*CONSTCOND*/0)

339 340 341 342
#define SIMPLEQ_INSERT_TAIL(head, elm, field) do {      \
  (elm)->field.sqe_next = NULL;         \
  *(head)->sqh_last = (elm);          \
  (head)->sqh_last = &(elm)->field.sqe_next;      \
Cedric Roux's avatar
Cedric Roux committed
343 344
} while (/*CONSTCOND*/0)

345 346 347 348
#define SIMPLEQ_INSERT_AFTER(head, listelm, elm, field) do {    \
  if (((elm)->field.sqe_next = (listelm)->field.sqe_next) == NULL)\
    (head)->sqh_last = &(elm)->field.sqe_next;    \
  (listelm)->field.sqe_next = (elm);        \
Cedric Roux's avatar
Cedric Roux committed
349 350
} while (/*CONSTCOND*/0)

351 352 353
#define SIMPLEQ_REMOVE_HEAD(head, field) do {       \
  if (((head)->sqh_first = (head)->sqh_first->field.sqe_next) == NULL) \
    (head)->sqh_last = &(head)->sqh_first;      \
Cedric Roux's avatar
Cedric Roux committed
354 355
} while (/*CONSTCOND*/0)

356 357 358 359 360 361 362 363 364 365 366
#define SIMPLEQ_REMOVE(head, elm, type, field) do {     \
  if ((head)->sqh_first == (elm)) {       \
    SIMPLEQ_REMOVE_HEAD((head), field);     \
  } else {              \
    struct type *curelm = (head)->sqh_first;    \
    while (curelm->field.sqe_next != (elm))     \
      curelm = curelm->field.sqe_next;    \
    if ((curelm->field.sqe_next =       \
      curelm->field.sqe_next->field.sqe_next) == NULL) \
          (head)->sqh_last = &(curelm)->field.sqe_next; \
  }               \
Cedric Roux's avatar
Cedric Roux committed
367 368
} while (/*CONSTCOND*/0)

369 370 371 372
#define SIMPLEQ_FOREACH(var, head, field)       \
  for ((var) = ((head)->sqh_first);       \
    (var);              \
    (var) = ((var)->field.sqe_next))
Cedric Roux's avatar
Cedric Roux committed
373 374 375 376

/*
 * Simple queue access methods.
 */
377 378 379
#define SIMPLEQ_EMPTY(head)   ((head)->sqh_first == NULL)
#define SIMPLEQ_FIRST(head)   ((head)->sqh_first)
#define SIMPLEQ_NEXT(elm, field)  ((elm)->field.sqe_next)
Cedric Roux's avatar
Cedric Roux committed
380 381 382 383 384


/*
 * Tail queue definitions.
 */
385 386 387 388
#define _TAILQ_HEAD(name, type, qual)         \
struct name {               \
  qual type *tqh_first;   /* first element */   \
  qual type *qual *tqh_last;  /* addr of last next element */ \
Cedric Roux's avatar
Cedric Roux committed
389
}
390
#define TAILQ_HEAD(name, type)  _TAILQ_HEAD(name, struct type,)
Cedric Roux's avatar
Cedric Roux committed
391

392 393
#define TAILQ_HEAD_INITIALIZER(head)          \
  { NULL, &(head).tqh_first }
Cedric Roux's avatar
Cedric Roux committed
394

395 396 397 398
#define _TAILQ_ENTRY(type, qual)          \
struct {                \
  qual type *tqe_next;    /* next element */    \
  qual type *qual *tqe_prev;  /* address of previous next element */\
Cedric Roux's avatar
Cedric Roux committed
399
}
400
#define TAILQ_ENTRY(type) _TAILQ_ENTRY(struct type,)
Cedric Roux's avatar
Cedric Roux committed
401 402 403 404

/*
 * Tail queue functions.
 */
405 406 407
#define TAILQ_INIT(head) do {           \
  (head)->tqh_first = NULL;         \
  (head)->tqh_last = &(head)->tqh_first;        \
Cedric Roux's avatar
Cedric Roux committed
408 409
} while (/*CONSTCOND*/0)

410 411 412 413 414 415 416 417
#define TAILQ_INSERT_HEAD(head, elm, field) do {      \
  if (((elm)->field.tqe_next = (head)->tqh_first) != NULL)  \
    (head)->tqh_first->field.tqe_prev =     \
        &(elm)->field.tqe_next;       \
  else                \
    (head)->tqh_last = &(elm)->field.tqe_next;    \
  (head)->tqh_first = (elm);          \
  (elm)->field.tqe_prev = &(head)->tqh_first;     \
Cedric Roux's avatar
Cedric Roux committed
418 419
} while (/*CONSTCOND*/0)

420 421 422 423 424
#define TAILQ_INSERT_TAIL(head, elm, field) do {      \
  (elm)->field.tqe_next = NULL;         \
  (elm)->field.tqe_prev = (head)->tqh_last;     \
  *(head)->tqh_last = (elm);          \
  (head)->tqh_last = &(elm)->field.tqe_next;      \
Cedric Roux's avatar
Cedric Roux committed
425 426
} while (/*CONSTCOND*/0)

427 428 429 430 431 432 433 434
#define TAILQ_INSERT_AFTER(head, listelm, elm, field) do {    \
  if (((elm)->field.tqe_next = (listelm)->field.tqe_next) != NULL)\
    (elm)->field.tqe_next->field.tqe_prev =     \
        &(elm)->field.tqe_next;       \
  else                \
    (head)->tqh_last = &(elm)->field.tqe_next;    \
  (listelm)->field.tqe_next = (elm);        \
  (elm)->field.tqe_prev = &(listelm)->field.tqe_next;   \
Cedric Roux's avatar
Cedric Roux committed
435 436
} while (/*CONSTCOND*/0)

437 438 439 440 441
#define TAILQ_INSERT_BEFORE(listelm, elm, field) do {     \
  (elm)->field.tqe_prev = (listelm)->field.tqe_prev;    \
  (elm)->field.tqe_next = (listelm);        \
  *(listelm)->field.tqe_prev = (elm);       \
  (listelm)->field.tqe_prev = &(elm)->field.tqe_next;   \
Cedric Roux's avatar
Cedric Roux committed
442 443
} while (/*CONSTCOND*/0)

444 445 446 447 448 449 450
#define TAILQ_REMOVE(head, elm, field) do {       \
  if (((elm)->field.tqe_next) != NULL)        \
    (elm)->field.tqe_next->field.tqe_prev =     \
        (elm)->field.tqe_prev;        \
  else                \
    (head)->tqh_last = (elm)->field.tqe_prev;   \
  *(elm)->field.tqe_prev = (elm)->field.tqe_next;     \
Cedric Roux's avatar
Cedric Roux committed
451 452
} while (/*CONSTCOND*/0)

453 454 455 456
#define TAILQ_FOREACH(var, head, field)         \
  for ((var) = ((head)->tqh_first);       \
    (var);              \
    (var) = ((var)->field.tqe_next))
Cedric Roux's avatar
Cedric Roux committed
457

458 459 460 461
#define TAILQ_FOREACH_REVERSE(var, head, headname, field)   \
  for ((var) = (*(((struct headname *)((head)->tqh_last))->tqh_last));  \
    (var);              \
    (var) = (*(((struct headname *)((var)->field.tqe_prev))->tqh_last)))
Cedric Roux's avatar
Cedric Roux committed
462

463 464 465 466 467 468 469
#define TAILQ_CONCAT(head1, head2, field) do {        \
  if (!TAILQ_EMPTY(head2)) {          \
    *(head1)->tqh_last = (head2)->tqh_first;    \
    (head2)->tqh_first->field.tqe_prev = (head1)->tqh_last; \
    (head1)->tqh_last = (head2)->tqh_last;      \
    TAILQ_INIT((head2));          \
  }               \
Cedric Roux's avatar
Cedric Roux committed
470 471 472 473 474
} while (/*CONSTCOND*/0)

/*
 * Tail queue access methods.
 */
475 476 477
#define TAILQ_EMPTY(head)   ((head)->tqh_first == NULL)
#define TAILQ_FIRST(head)   ((head)->tqh_first)
#define TAILQ_NEXT(elm, field)    ((elm)->field.tqe_next)
Cedric Roux's avatar
Cedric Roux committed
478

479 480 481 482
#define TAILQ_LAST(head, headname) \
  (*(((struct headname *)((head)->tqh_last))->tqh_last))
#define TAILQ_PREV(elm, headname, field) \
  (*(((struct headname *)((elm)->field.tqe_prev))->tqh_last))
Cedric Roux's avatar
Cedric Roux committed
483 484 485 486 487


/*
 * Circular queue definitions.
 */
488 489 490 491
#define CIRCLEQ_HEAD(name, type)          \
struct name {               \
  struct type *cqh_first;   /* first element */   \
  struct type *cqh_last;    /* last element */    \
Cedric Roux's avatar
Cedric Roux committed
492 493
}

494 495
#define CIRCLEQ_HEAD_INITIALIZER(head)          \
  { (void *)&head, (void *)&head }
Cedric Roux's avatar
Cedric Roux committed
496

497 498 499 500
#define CIRCLEQ_ENTRY(type)           \
struct {                \
  struct type *cqe_next;    /* next element */    \
  struct type *cqe_prev;    /* previous element */    \
Cedric Roux's avatar
Cedric Roux committed
501 502 503 504 505
}

/*
 * Circular queue functions.
 */
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
#define CIRCLEQ_INIT(head) do {           \
  (head)->cqh_first = (void *)(head);       \
  (head)->cqh_last = (void *)(head);        \
} while (/*CONSTCOND*/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 == (void *)(head))    \
    (head)->cqh_last = (elm);       \
  else                \
    (listelm)->field.cqe_next->field.cqe_prev = (elm);  \
  (listelm)->field.cqe_next = (elm);        \
} while (/*CONSTCOND*/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 == (void *)(head))    \
    (head)->cqh_first = (elm);        \
  else                \
    (listelm)->field.cqe_prev->field.cqe_next = (elm);  \
  (listelm)->field.cqe_prev = (elm);        \
} while (/*CONSTCOND*/0)

#define CIRCLEQ_INSERT_HEAD(head, elm, field) do {      \
  (elm)->field.cqe_next = (head)->cqh_first;      \
  (elm)->field.cqe_prev = (void *)(head);       \
  if ((head)->cqh_last == (void *)(head))       \
    (head)->cqh_last = (elm);       \
  else                \
    (head)->cqh_first->field.cqe_prev = (elm);    \
  (head)->cqh_first = (elm);          \
} while (/*CONSTCOND*/0)

#define CIRCLEQ_INSERT_TAIL(head, elm, field) do {      \
  (elm)->field.cqe_next = (void *)(head);       \
  (elm)->field.cqe_prev = (head)->cqh_last;     \
  if ((head)->cqh_first == (void *)(head))      \
    (head)->cqh_first = (elm);        \
  else                \
    (head)->cqh_last->field.cqe_next = (elm);   \
  (head)->cqh_last = (elm);         \
} while (/*CONSTCOND*/0)

#define CIRCLEQ_REMOVE(head, elm, field) do {       \
  if ((elm)->field.cqe_next == (void *)(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 == (void *)(head))      \
    (head)->cqh_first = (elm)->field.cqe_next;    \
  else                \
    (elm)->field.cqe_prev->field.cqe_next =     \
        (elm)->field.cqe_next;        \
} while (/*CONSTCOND*/0)

#define CIRCLEQ_FOREACH(var, head, field)       \
  for ((var) = ((head)->cqh_first);       \
    (var) != (const void *)(head);        \
    (var) = ((var)->field.cqe_next))

#define CIRCLEQ_FOREACH_REVERSE(var, head, field)     \
  for ((var) = ((head)->cqh_last);        \
    (var) != (const void *)(head);        \
    (var) = ((var)->field.cqe_prev))
Cedric Roux's avatar
Cedric Roux committed
573 574 575 576

/*
 * Circular queue access methods.
 */
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
#define CIRCLEQ_EMPTY(head)   ((head)->cqh_first == (void *)(head))
#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_LOOP_NEXT(head, elm, field)       \
  (((elm)->field.cqe_next == (void *)(head))      \
      ? ((head)->cqh_first)         \
      : (elm->field.cqe_next))
#define CIRCLEQ_LOOP_PREV(head, elm, field)       \
  (((elm)->field.cqe_prev == (void *)(head))      \
      ? ((head)->cqh_last)          \
      : (elm->field.cqe_prev))

#endif  /* sys/queue.h */