--- name: "circleq" section: "3" platform: "linux" package: "man-pages" version: "6.19-1" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/circleq" --- # circleq(3) implementation of a doubly linked circular queue ## NAME CIRCLEQ\_EMPTY, CIRCLEQ\_ENTRY, CIRCLEQ\_FIRST, CIRCLEQ\_FOREACH, CIRCLEQ\_FOREACH\_REVERSE, CIRCLEQ\_HEAD, CIRCLEQ\_HEAD\_INITIALIZER, CIRCLEQ\_INIT, CIRCLEQ\_INSERT\_AFTER, CIRCLEQ\_INSERT\_BEFORE, CIRCLEQ\_INSERT\_HEAD, CIRCLEQ\_INSERT\_TAIL, CIRCLEQ\_LAST, CIRCLEQ\_LOOP\_NEXT, CIRCLEQ\_LOOP\_PREV, CIRCLEQ\_NEXT, CIRCLEQ\_PREV, CIRCLEQ\_REMOVE - implementation of a doubly linked circular queue ## LIBRARY Standard C library (*libc*, *-lc*) ## SYNOPSIS ``` #include ``` **CIRCLEQ\_ENTRY(TYPE);** **CIRCLEQ\_HEAD(HEADNAME, TYPE);** **CIRCLEQ\_HEAD CIRCLEQ\_HEAD\_INITIALIZER(CIRCLEQ\_HEAD** *head***);** **void CIRCLEQ\_INIT(CIRCLEQ\_HEAD \****head***);** **int CIRCLEQ\_EMPTY(CIRCLEQ\_HEAD \****head***);** **void CIRCLEQ\_INSERT\_HEAD(CIRCLEQ\_HEAD \****head***,** **struct TYPE \****elm***, CIRCLEQ\_ENTRY** *NAME***);** **void CIRCLEQ\_INSERT\_TAIL(CIRCLEQ\_HEAD \****head***,** **struct TYPE \****elm***, CIRCLEQ\_ENTRY** *NAME***);** **void CIRCLEQ\_INSERT\_BEFORE(CIRCLEQ\_HEAD \****head***, struct TYPE \****listelm***,** **struct TYPE \****elm***, CIRCLEQ\_ENTRY** *NAME***);** **void CIRCLEQ\_INSERT\_AFTER(CIRCLEQ\_HEAD \****head***, struct TYPE \****listelm***,** **struct TYPE \****elm***, CIRCLEQ\_ENTRY** *NAME***);** **struct TYPE \*CIRCLEQ\_FIRST(CIRCLEQ\_HEAD \****head***);** **struct TYPE \*CIRCLEQ\_LAST(CIRCLEQ\_HEAD \****head***);** **struct TYPE \*CIRCLEQ\_PREV(struct TYPE \****elm***, CIRCLEQ\_ENTRY** *NAME***);** **struct TYPE \*CIRCLEQ\_NEXT(struct TYPE \****elm***, CIRCLEQ\_ENTRY** *NAME***);** **struct TYPE \*CIRCLEQ\_LOOP\_PREV(CIRCLEQ\_HEAD \****head***,** **struct TYPE \****elm***, CIRCLEQ\_ENTRY** *NAME***);** **struct TYPE \*CIRCLEQ\_LOOP\_NEXT(CIRCLEQ\_HEAD \****head***,** **struct TYPE \****elm***, CIRCLEQ\_ENTRY** *NAME***);** **CIRCLEQ\_FOREACH(struct TYPE \****var***, CIRCLEQ\_HEAD \****head***,** **CIRCLEQ\_ENTRY** *NAME***);** **CIRCLEQ\_FOREACH\_REVERSE(struct TYPE \****var***, CIRCLEQ\_HEAD \****head***,** **CIRCLEQ\_ENTRY** *NAME***);** **void CIRCLEQ\_REMOVE(CIRCLEQ\_HEAD \****head***, struct TYPE \****elm***,** **CIRCLEQ\_ENTRY** *NAME***);** ## DESCRIPTION These macros define and operate on doubly linked circular queues. In the macro definitions, *TYPE* is the name of a user-defined structure, that must contain a field of type *CIRCLEQ\_ENTRY*, named *NAME*. The argument *HEADNAME* is the name of a user-defined structure that must be declared using the macro **CIRCLEQ\_HEAD**(). ### Creation A circular queue is headed by a structure defined by the **CIRCLEQ\_HEAD**() macro. This structure contains a pair of pointers, one to the first element in the queue and the other to the last element in the queue. The elements are doubly linked so that an arbitrary element can be removed without traversing the queue. New elements can be added to the queue after an existing element, before an existing element, at the head of the queue, or at the end of the queue. A *CIRCLEQ\_HEAD* structure is declared as follows: ``` CIRCLEQ_HEAD(HEADNAME, TYPE) head; ``` where *struct HEADNAME* is the structure to be defined, and *struct TYPE* is the type of the elements to be linked into the queue. A pointer to the head of the queue can later be declared as: ``` struct HEADNAME *headp; ``` (The names *head* and *headp* are user selectable.) **CIRCLEQ\_ENTRY**() declares a structure that connects the elements in the queue. **CIRCLEQ\_HEAD\_INITIALIZER**() evaluates to an initializer for the queue *head*. **CIRCLEQ\_INIT**() initializes the queue referenced by *head*. **CIRCLEQ\_EMPTY**() evaluates to true if there are no items on the queue. ### Insertion **CIRCLEQ\_INSERT\_HEAD**() inserts the new element *elm* at the head of the queue. **CIRCLEQ\_INSERT\_TAIL**() inserts the new element *elm* at the end of the queue. **CIRCLEQ\_INSERT\_BEFORE**() inserts the new element *elm* before the element *listelm*. **CIRCLEQ\_INSERT\_AFTER**() inserts the new element *elm* after the element *listelm*. ### Traversal **CIRCLEQ\_FIRST**() returns the first item on the queue. **CIRCLEQ\_LAST**() returns the last item on the queue. **CIRCLEQ\_PREV**() returns the previous item on the queue, or *&head* if this item is the first one. **CIRCLEQ\_NEXT**() returns the next item on the queue, or *&head* if this item is the last one. **CIRCLEQ\_LOOP\_PREV**() returns the previous item on the queue. If *elm* is the first element on the queue, the last element is returned. **CIRCLEQ\_LOOP\_NEXT**() returns the next item on the queue. If *elm* is the last element on the queue, the first element is returned. **CIRCLEQ\_FOREACH**() traverses the queue referenced by *head* in the forward direction, assigning each element in turn to *var*. *var* is set to *&head* if the loop completes normally, or if there were no elements. **CIRCLEQ\_FOREACH\_REVERSE**() traverses the queue referenced by *head* in the reverse direction, assigning each element in turn to *var*. ### Removal **CIRCLEQ\_REMOVE**() removes the element *elm* from the queue. ## RETURN VALUE **CIRCLEQ\_EMPTY**() returns nonzero if the queue is empty, and zero if the queue contains at least one entry. **CIRCLEQ\_FIRST**(), **CIRCLEQ\_LAST**(), **CIRCLEQ\_LOOP\_PREV**(), and **CIRCLEQ\_LOOP\_NEXT**() return a pointer to the first, last, previous, or next *TYPE* structure, respectively. **CIRCLEQ\_PREV**(), and **CIRCLEQ\_NEXT**() are similar to their **CIRCLEQ\_LOOP\_\***() counterparts, except that if the argument is the first or last element, respectively, they return *&head*. **CIRCLEQ\_HEAD\_INITIALIZER**() returns an initializer that can be assigned to the queue *head*. ## STANDARDS BSD. ## BUGS **CIRCLEQ\_FOREACH**() and **CIRCLEQ\_FOREACH\_REVERSE**() don't allow *var* to be removed or freed within the loop, as it would interfere with the traversal. **CIRCLEQ\_FOREACH\_SAFE**() and **CIRCLEQ\_FOREACH\_REVERSE\_SAFE**(), which are present on the BSDs but are not present in glibc, fix this limitation by allowing *var* to safely be removed from the list and freed from within the loop without interfering with the traversal. ## EXAMPLES ``` #include #include #include #include struct entry { int data; CIRCLEQ_ENTRY(entry) entries; /* Queue */ }; CIRCLEQ_HEAD(circlehead, entry); int main(void) { struct entry *n1, *n2, *n3, *np; struct circlehead head; /* Queue head */ int i; CIRCLEQ_INIT(&head); /* Initialize the queue */ n1 = malloc(sizeof(struct entry)); /* Insert at the head */ CIRCLEQ_INSERT_HEAD(&head, n1, entries); n1 = malloc(sizeof(struct entry)); /* Insert at the tail */ CIRCLEQ_INSERT_TAIL(&head, n1, entries); n2 = malloc(sizeof(struct entry)); /* Insert after */ CIRCLEQ_INSERT_AFTER(&head, n1, n2, entries); n3 = malloc(sizeof(struct entry)); /* Insert before */ CIRCLEQ_INSERT_BEFORE(&head, n2, n3, entries); CIRCLEQ_REMOVE(&head, n2, entries); /* Deletion */ free(n2); /* Forward traversal */ i = 0; CIRCLEQ_FOREACH(np, &head, entries) np->data = i++; /* Reverse traversal */ CIRCLEQ_FOREACH_REVERSE(np, &head, entries) printf("%i\n", np->data); /* Queue deletion */ n1 = CIRCLEQ_FIRST(&head); while (n1 != (void *)&head) { n2 = CIRCLEQ_NEXT(n1, entries); free(n1); n1 = n2; } CIRCLEQ_INIT(&head); exit(EXIT_SUCCESS); } ``` ## SEE ALSO [**insque**(3)](/insque/3.md), [**queue**(7)](/queue/7.md)