Context Navigation

source: trunk/daemon/bsdqueue.h @ 3175

Visit:

Last change on this file since 3175 was 3175, checked in by charles, 15 years ago
add bsdqueue.h to daemon dir
File size: 17.7 KB

Line
1	/* $Id: bsdqueue.h 1580 2007-03-23 08:41:15Z joshe $ */
2	/* $OpenBSD: queue.h,v 1.31 2005/11/25 08:06:25 otto Exp $ */
3	/* $NetBSD: queue.h,v 1.11 1996/05/16 05:17:14 mycroft Exp $ */
4
5	/*
6	* Copyright (c) 1991, 1993
7	* The Regents of the University of California. All rights reserved.
8	*
9	* Redistribution and use in source and binary forms, with or without
10	* modification, are permitted provided that the following conditions
11	* are met:
12	* 1. Redistributions of source code must retain the above copyright
13	* notice, this list of conditions and the following disclaimer.
14	* 2. Redistributions in binary form must reproduce the above copyright
15	* notice, this list of conditions and the following disclaimer in the
16	* documentation and/or other materials provided with the distribution.
17	* 3. Neither the name of the University nor the names of its contributors
18	* may be used to endorse or promote products derived from this software
19	* without specific prior written permission.
20	*
21	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31	* SUCH DAMAGE.
32	*
33	* @(#)queue.h 8.5 (Berkeley) 8/20/94
34	*/
35
36	#ifndef _SYS_QUEUE_H_
37	#define _SYS_QUEUE_H_
38
39	/*
40	* This file defines five types of data structures: singly-linked lists,
41	* lists, simple queues, tail queues, and circular queues.
42	*
43	*
44	* A singly-linked list is headed by a single forward pointer. The elements
45	* are singly linked for minimum space and pointer manipulation overhead at
46	* the expense of O(n) removal for arbitrary elements. New elements can be
47	* added to the list after an existing element or at the head of the list.
48	* Elements being removed from the head of the list should use the explicit
49	* macro for this purpose for optimum efficiency. A singly-linked list may
50	* only be traversed in the forward direction. Singly-linked lists are ideal
51	* for applications with large datasets and few or no removals or for
52	* implementing a LIFO queue.
53	*
54	* A list is headed by a single forward pointer (or an array of forward
55	* pointers for a hash table header). The elements are doubly linked
56	* so that an arbitrary element can be removed without a need to
57	* traverse the list. New elements can be added to the list before
58	* or after an existing element or at the head of the list. A list
59	* may only be traversed in the forward direction.
60	*
61	* A simple queue is headed by a pair of pointers, one the head of the
62	* list and the other to the tail of the list. The elements are singly
63	* linked to save space, so elements can only be removed from the
64	* head of the list. New elements can be added to the list before or after
65	* an existing element, at the head of the list, or at the end of the
66	* list. A simple queue may only be traversed in the forward direction.
67	*
68	* A tail queue is headed by a pair of pointers, one to the head of the
69	* list and the other to the tail of the list. The elements are doubly
70	* linked so that an arbitrary element can be removed without a need to
71	* traverse the list. New elements can be added to the list before or
72	* after an existing element, at the head of the list, or at the end of
73	* the list. A tail queue may be traversed in either direction.
74	*
75	* A circle queue is headed by a pair of pointers, one to the head of the
76	* list and the other to the tail of the list. The elements are doubly
77	* linked so that an arbitrary element can be removed without a need to
78	* traverse the list. New elements can be added to the list before or after
79	* an existing element, at the head of the list, or at the end of the list.
80	* A circle queue may be traversed in either direction, but has a more
81	* complex end of list detection.
82	*
83	* For details on the use of these macros, see the queue(3) manual page.
84	*/
85
86	#ifdef QUEUE_MACRO_DEBUG
87	#define _Q_INVALIDATE(a) (a) = ((void *)-1)
88	#else
89	#define _Q_INVALIDATE(a)
90	#endif
91
92	/*
93	* Singly-linked List definitions.
94	*/
95	#define SLIST_HEAD(name, type) \
96	struct name { \
97	struct type slh_first; / first element */ \
98	}
99
100	#define SLIST_HEAD_INITIALIZER(head) \
101	{ NULL }
102
103	#define SLIST_ENTRY(type) \
104	struct { \
105	struct type sle_next; / next element */ \
106	}
107
108	/*
109	* Singly-linked List access methods.
110	*/
111	#define SLIST_FIRST(head) ((head)->slh_first)
112	#define SLIST_END(head) NULL
113	#define SLIST_EMPTY(head) (SLIST_FIRST(head) == SLIST_END(head))
114	#define SLIST_NEXT(elm, field) ((elm)->field.sle_next)
115
116	#define SLIST_FOREACH(var, head, field) \
117	for((var) = SLIST_FIRST(head); \
118	(var) != SLIST_END(head); \
119	(var) = SLIST_NEXT(var, field))
120
121	#define SLIST_FOREACH_PREVPTR(var, varp, head, field) \
122	for ((varp) = &SLIST_FIRST((head)); \
123	((var) = *(varp)) != SLIST_END(head); \
124	(varp) = &SLIST_NEXT((var), field))
125
126	/*
127	* Singly-linked List functions.
128	*/
129	#define SLIST_INIT(head) { \
130	SLIST_FIRST(head) = SLIST_END(head); \
131	}
132
133	#define SLIST_INSERT_AFTER(slistelm, elm, field) do { \
134	(elm)->field.sle_next = (slistelm)->field.sle_next; \
135	(slistelm)->field.sle_next = (elm); \
136	} while (0)
137
138	#define SLIST_INSERT_HEAD(head, elm, field) do { \
139	(elm)->field.sle_next = (head)->slh_first; \
140	(head)->slh_first = (elm); \
141	} while (0)
142
143	#define SLIST_REMOVE_NEXT(head, elm, field) do { \
144	(elm)->field.sle_next = (elm)->field.sle_next->field.sle_next; \
145	} while (0)
146
147	#define SLIST_REMOVE_HEAD(head, field) do { \
148	(head)->slh_first = (head)->slh_first->field.sle_next; \
149	} while (0)
150
151	#define SLIST_REMOVE(head, elm, type, field) do { \
152	if ((head)->slh_first == (elm)) { \
153	SLIST_REMOVE_HEAD((head), field); \
154	} else { \
155	struct type *curelm = (head)->slh_first; \
156	\
157	while (curelm->field.sle_next != (elm)) \
158	curelm = curelm->field.sle_next; \
159	curelm->field.sle_next = \
160	curelm->field.sle_next->field.sle_next; \
161	_Q_INVALIDATE((elm)->field.sle_next); \
162	} \
163	} while (0)
164
165	/*
166	* List definitions.
167	*/
168	#define LIST_HEAD(name, type) \
169	struct name { \
170	struct type lh_first; / first element */ \
171	}
172
173	#define LIST_HEAD_INITIALIZER(head) \
174	{ NULL }
175
176	#define LIST_ENTRY(type) \
177	struct { \
178	struct type le_next; / next element */ \
179	struct type *le_prev; / address of previous next element */ \
180	}
181
182	/*
183	* List access methods
184	*/
185	#define LIST_FIRST(head) ((head)->lh_first)
186	#define LIST_END(head) NULL
187	#define LIST_EMPTY(head) (LIST_FIRST(head) == LIST_END(head))
188	#define LIST_NEXT(elm, field) ((elm)->field.le_next)
189
190	#define LIST_FOREACH(var, head, field) \
191	for((var) = LIST_FIRST(head); \
192	(var)!= LIST_END(head); \
193	(var) = LIST_NEXT(var, field))
194
195	/*
196	* List functions.
197	*/
198	#define LIST_INIT(head) do { \
199	LIST_FIRST(head) = LIST_END(head); \
200	} while (0)
201
202	#define LIST_INSERT_AFTER(listelm, elm, field) do { \
203	if (((elm)->field.le_next = (listelm)->field.le_next) != NULL) \
204	(listelm)->field.le_next->field.le_prev = \
205	&(elm)->field.le_next; \
206	(listelm)->field.le_next = (elm); \
207	(elm)->field.le_prev = &(listelm)->field.le_next; \
208	} while (0)
209
210	#define LIST_INSERT_BEFORE(listelm, elm, field) do { \
211	(elm)->field.le_prev = (listelm)->field.le_prev; \
212	(elm)->field.le_next = (listelm); \
213	*(listelm)->field.le_prev = (elm); \
214	(listelm)->field.le_prev = &(elm)->field.le_next; \
215	} while (0)
216
217	#define LIST_INSERT_HEAD(head, elm, field) do { \
218	if (((elm)->field.le_next = (head)->lh_first) != NULL) \
219	(head)->lh_first->field.le_prev = &(elm)->field.le_next;\
220	(head)->lh_first = (elm); \
221	(elm)->field.le_prev = &(head)->lh_first; \
222	} while (0)
223
224	#define LIST_REMOVE(elm, field) do { \
225	if ((elm)->field.le_next != NULL) \
226	(elm)->field.le_next->field.le_prev = \
227	(elm)->field.le_prev; \
228	*(elm)->field.le_prev = (elm)->field.le_next; \
229	_Q_INVALIDATE((elm)->field.le_prev); \
230	_Q_INVALIDATE((elm)->field.le_next); \
231	} while (0)
232
233	#define LIST_REPLACE(elm, elm2, field) do { \
234	if (((elm2)->field.le_next = (elm)->field.le_next) != NULL) \
235	(elm2)->field.le_next->field.le_prev = \
236	&(elm2)->field.le_next; \
237	(elm2)->field.le_prev = (elm)->field.le_prev; \
238	*(elm2)->field.le_prev = (elm2); \
239	_Q_INVALIDATE((elm)->field.le_prev); \
240	_Q_INVALIDATE((elm)->field.le_next); \
241	} while (0)
242
243	/*
244	* Simple queue definitions.
245	*/
246	#define SIMPLEQ_HEAD(name, type) \
247	struct name { \
248	struct type sqh_first; / first element */ \
249	struct type *sqh_last; / addr of last next element */ \
250	}
251
252	#define SIMPLEQ_HEAD_INITIALIZER(head) \
253	{ NULL, &(head).sqh_first }
254
255	#define SIMPLEQ_ENTRY(type) \
256	struct { \
257	struct type sqe_next; / next element */ \
258	}
259
260	/*
261	* Simple queue access methods.
262	*/
263	#define SIMPLEQ_FIRST(head) ((head)->sqh_first)
264	#define SIMPLEQ_END(head) NULL
265	#define SIMPLEQ_EMPTY(head) (SIMPLEQ_FIRST(head) == SIMPLEQ_END(head))
266	#define SIMPLEQ_NEXT(elm, field) ((elm)->field.sqe_next)
267
268	#define SIMPLEQ_FOREACH(var, head, field) \
269	for((var) = SIMPLEQ_FIRST(head); \
270	(var) != SIMPLEQ_END(head); \
271	(var) = SIMPLEQ_NEXT(var, field))
272
273	/*
274	* Simple queue functions.
275	*/
276	#define SIMPLEQ_INIT(head) do { \
277	(head)->sqh_first = NULL; \
278	(head)->sqh_last = &(head)->sqh_first; \
279	} while (0)
280
281	#define SIMPLEQ_INSERT_HEAD(head, elm, field) do { \
282	if (((elm)->field.sqe_next = (head)->sqh_first) == NULL) \
283	(head)->sqh_last = &(elm)->field.sqe_next; \
284	(head)->sqh_first = (elm); \
285	} while (0)
286
287	#define SIMPLEQ_INSERT_TAIL(head, elm, field) do { \
288	(elm)->field.sqe_next = NULL; \
289	*(head)->sqh_last = (elm); \
290	(head)->sqh_last = &(elm)->field.sqe_next; \
291	} while (0)
292
293	#define SIMPLEQ_INSERT_AFTER(head, listelm, elm, field) do { \
294	if (((elm)->field.sqe_next = (listelm)->field.sqe_next) == NULL)\
295	(head)->sqh_last = &(elm)->field.sqe_next; \
296	(listelm)->field.sqe_next = (elm); \
297	} while (0)
298
299	#define SIMPLEQ_REMOVE_HEAD(head, field) do { \
300	if (((head)->sqh_first = (head)->sqh_first->field.sqe_next) == NULL) \
301	(head)->sqh_last = &(head)->sqh_first; \
302	} while (0)
303
304	/*
305	* Tail queue definitions.
306	*/
307	#define TAILQ_HEAD(name, type) \
308	struct name { \
309	struct type tqh_first; / first element */ \
310	struct type *tqh_last; / addr of last next element */ \
311	}
312
313	#define TAILQ_HEAD_INITIALIZER(head) \
314	{ NULL, &(head).tqh_first }
315
316	#define TAILQ_ENTRY(type) \
317	struct { \
318	struct type tqe_next; / next element */ \
319	struct type *tqe_prev; / address of previous next element */ \
320	}
321
322	/*
323	* tail queue access methods
324	*/
325	#define TAILQ_FIRST(head) ((head)->tqh_first)
326	#define TAILQ_END(head) NULL
327	#define TAILQ_NEXT(elm, field) ((elm)->field.tqe_next)
328	#define TAILQ_LAST(head, headname) \
329	((((struct headname )((head)->tqh_last))->tqh_last))
330	/* XXX */
331	#define TAILQ_PREV(elm, headname, field) \
332	((((struct headname )((elm)->field.tqe_prev))->tqh_last))
333	#define TAILQ_EMPTY(head) \
334	(TAILQ_FIRST(head) == TAILQ_END(head))
335
336	#define TAILQ_FOREACH(var, head, field) \
337	for((var) = TAILQ_FIRST(head); \
338	(var) != TAILQ_END(head); \
339	(var) = TAILQ_NEXT(var, field))
340
341	#define TAILQ_FOREACH_REVERSE(var, head, headname, field) \
342	for((var) = TAILQ_LAST(head, headname); \
343	(var) != TAILQ_END(head); \
344	(var) = TAILQ_PREV(var, headname, field))
345
346	/*
347	* Tail queue functions.
348	*/
349	#define TAILQ_INIT(head) do { \
350	(head)->tqh_first = NULL; \
351	(head)->tqh_last = &(head)->tqh_first; \
352	} while (0)
353
354	#define TAILQ_INSERT_HEAD(head, elm, field) do { \
355	if (((elm)->field.tqe_next = (head)->tqh_first) != NULL) \
356	(head)->tqh_first->field.tqe_prev = \
357	&(elm)->field.tqe_next; \
358	else \
359	(head)->tqh_last = &(elm)->field.tqe_next; \
360	(head)->tqh_first = (elm); \
361	(elm)->field.tqe_prev = &(head)->tqh_first; \
362	} while (0)
363
364	#define TAILQ_INSERT_TAIL(head, elm, field) do { \
365	(elm)->field.tqe_next = NULL; \
366	(elm)->field.tqe_prev = (head)->tqh_last; \
367	*(head)->tqh_last = (elm); \
368	(head)->tqh_last = &(elm)->field.tqe_next; \
369	} while (0)
370
371	#define TAILQ_INSERT_AFTER(head, listelm, elm, field) do { \
372	if (((elm)->field.tqe_next = (listelm)->field.tqe_next) != NULL)\
373	(elm)->field.tqe_next->field.tqe_prev = \
374	&(elm)->field.tqe_next; \
375	else \
376	(head)->tqh_last = &(elm)->field.tqe_next; \
377	(listelm)->field.tqe_next = (elm); \
378	(elm)->field.tqe_prev = &(listelm)->field.tqe_next; \
379	} while (0)
380
381	#define TAILQ_INSERT_BEFORE(listelm, elm, field) do { \
382	(elm)->field.tqe_prev = (listelm)->field.tqe_prev; \
383	(elm)->field.tqe_next = (listelm); \
384	*(listelm)->field.tqe_prev = (elm); \
385	(listelm)->field.tqe_prev = &(elm)->field.tqe_next; \
386	} while (0)
387
388	#define TAILQ_REMOVE(head, elm, field) do { \
389	if (((elm)->field.tqe_next) != NULL) \
390	(elm)->field.tqe_next->field.tqe_prev = \
391	(elm)->field.tqe_prev; \
392	else \
393	(head)->tqh_last = (elm)->field.tqe_prev; \
394	*(elm)->field.tqe_prev = (elm)->field.tqe_next; \
395	_Q_INVALIDATE((elm)->field.tqe_prev); \
396	_Q_INVALIDATE((elm)->field.tqe_next); \
397	} while (0)
398
399	#define TAILQ_REPLACE(head, elm, elm2, field) do { \
400	if (((elm2)->field.tqe_next = (elm)->field.tqe_next) != NULL) \
401	(elm2)->field.tqe_next->field.tqe_prev = \
402	&(elm2)->field.tqe_next; \
403	else \
404	(head)->tqh_last = &(elm2)->field.tqe_next; \
405	(elm2)->field.tqe_prev = (elm)->field.tqe_prev; \
406	*(elm2)->field.tqe_prev = (elm2); \
407	_Q_INVALIDATE((elm)->field.tqe_prev); \
408	_Q_INVALIDATE((elm)->field.tqe_next); \
409	} while (0)
410
411	/*
412	* Circular queue definitions.
413	*/
414	#define CIRCLEQ_HEAD(name, type) \
415	struct name { \
416	struct type cqh_first; / first element */ \
417	struct type cqh_last; / last element */ \
418	}
419
420	#define CIRCLEQ_HEAD_INITIALIZER(head) \
421	{ CIRCLEQ_END(&head), CIRCLEQ_END(&head) }
422
423	#define CIRCLEQ_ENTRY(type) \
424	struct { \
425	struct type cqe_next; / next element */ \
426	struct type cqe_prev; / previous element */ \
427	}
428
429	/*
430	* Circular queue access methods
431	*/
432	#define CIRCLEQ_FIRST(head) ((head)->cqh_first)
433	#define CIRCLEQ_LAST(head) ((head)->cqh_last)
434	#define CIRCLEQ_END(head) ((void *)(head))
435	#define CIRCLEQ_NEXT(elm, field) ((elm)->field.cqe_next)
436	#define CIRCLEQ_PREV(elm, field) ((elm)->field.cqe_prev)
437	#define CIRCLEQ_EMPTY(head) \
438	(CIRCLEQ_FIRST(head) == CIRCLEQ_END(head))
439
440	#define CIRCLEQ_FOREACH(var, head, field) \
441	for((var) = CIRCLEQ_FIRST(head); \
442	(var) != CIRCLEQ_END(head); \
443	(var) = CIRCLEQ_NEXT(var, field))
444
445	#define CIRCLEQ_FOREACH_REVERSE(var, head, field) \
446	for((var) = CIRCLEQ_LAST(head); \
447	(var) != CIRCLEQ_END(head); \
448	(var) = CIRCLEQ_PREV(var, field))
449
450	/*
451	* Circular queue functions.
452	*/
453	#define CIRCLEQ_INIT(head) do { \
454	(head)->cqh_first = CIRCLEQ_END(head); \
455	(head)->cqh_last = CIRCLEQ_END(head); \
456	} while (0)
457
458	#define CIRCLEQ_INSERT_AFTER(head, listelm, elm, field) do { \
459	(elm)->field.cqe_next = (listelm)->field.cqe_next; \
460	(elm)->field.cqe_prev = (listelm); \
461	if ((listelm)->field.cqe_next == CIRCLEQ_END(head)) \
462	(head)->cqh_last = (elm); \
463	else \
464	(listelm)->field.cqe_next->field.cqe_prev = (elm); \
465	(listelm)->field.cqe_next = (elm); \
466	} while (0)
467
468	#define CIRCLEQ_INSERT_BEFORE(head, listelm, elm, field) do { \
469	(elm)->field.cqe_next = (listelm); \
470	(elm)->field.cqe_prev = (listelm)->field.cqe_prev; \
471	if ((listelm)->field.cqe_prev == CIRCLEQ_END(head)) \
472	(head)->cqh_first = (elm); \
473	else \
474	(listelm)->field.cqe_prev->field.cqe_next = (elm); \
475	(listelm)->field.cqe_prev = (elm); \
476	} while (0)
477
478	#define CIRCLEQ_INSERT_HEAD(head, elm, field) do { \
479	(elm)->field.cqe_next = (head)->cqh_first; \
480	(elm)->field.cqe_prev = CIRCLEQ_END(head); \
481	if ((head)->cqh_last == CIRCLEQ_END(head)) \
482	(head)->cqh_last = (elm); \
483	else \
484	(head)->cqh_first->field.cqe_prev = (elm); \
485	(head)->cqh_first = (elm); \
486	} while (0)
487
488	#define CIRCLEQ_INSERT_TAIL(head, elm, field) do { \
489	(elm)->field.cqe_next = CIRCLEQ_END(head); \
490	(elm)->field.cqe_prev = (head)->cqh_last; \
491	if ((head)->cqh_first == CIRCLEQ_END(head)) \
492	(head)->cqh_first = (elm); \
493	else \
494	(head)->cqh_last->field.cqe_next = (elm); \
495	(head)->cqh_last = (elm); \
496	} while (0)
497
498	#define CIRCLEQ_REMOVE(head, elm, field) do { \
499	if ((elm)->field.cqe_next == CIRCLEQ_END(head)) \
500	(head)->cqh_last = (elm)->field.cqe_prev; \
501	else \
502	(elm)->field.cqe_next->field.cqe_prev = \
503	(elm)->field.cqe_prev; \
504	if ((elm)->field.cqe_prev == CIRCLEQ_END(head)) \
505	(head)->cqh_first = (elm)->field.cqe_next; \
506	else \
507	(elm)->field.cqe_prev->field.cqe_next = \
508	(elm)->field.cqe_next; \
509	_Q_INVALIDATE((elm)->field.cqe_prev); \
510	_Q_INVALIDATE((elm)->field.cqe_next); \
511	} while (0)
512
513	#define CIRCLEQ_REPLACE(head, elm, elm2, field) do { \
514	if (((elm2)->field.cqe_next = (elm)->field.cqe_next) == \
515	CIRCLEQ_END(head)) \
516	(head).cqh_last = (elm2); \
517	else \
518	(elm2)->field.cqe_next->field.cqe_prev = (elm2); \
519	if (((elm2)->field.cqe_prev = (elm)->field.cqe_prev) == \
520	CIRCLEQ_END(head)) \
521	(head).cqh_first = (elm2); \
522	else \
523	(elm2)->field.cqe_prev->field.cqe_next = (elm2); \
524	_Q_INVALIDATE((elm)->field.cqe_prev); \
525	_Q_INVALIDATE((elm)->field.cqe_next); \
526	} while (0)
527
528	#endif /* !_SYS_QUEUE_H_ */

Note: See TracBrowser for help on using the repository browser.

Download in other formats: