generic_sys_queue.h   [plain text]

/*
 * Copyright (c) 2018 Apple Inc. All rights reserved.
 *
 * @APPLE_APACHE_LICENSE_HEADER_START@
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * @APPLE_APACHE_LICENSE_HEADER_END@
 */

/*
 * NOTE: This header files defines a trimmed down version of the BSD sys/queue.h
 * macros for use on platforms which do not come with a sys/queue.h file.
 */

#ifndef __DISPATCH_SHIMS_SYS_QUEUE__
#define __DISPATCH_SHIMS_SYS_QUEUE__

#ifndef TRASHIT
#define TRASHIT(elem) (elem) = NULL;
#endif

#define TAILQ_HEAD(list_name, elem_type) \
	struct list_name { \
		struct elem_type *tq_first; \
		struct elem_type *tq_last; \
	}

#define TAILQ_ENTRY(elem_type) \
	struct { \
		struct elem_type *te_next; \
		struct elem_type *te_prev; \
	}

#define TAILQ_INIT(list) do { \
		(list)->tq_first = NULL; \
		(list)->tq_last = NULL; \
	} while (0)

#define TAILQ_EMPTY(list) ((list)->tq_first == NULL)

#define TAILQ_FIRST(list) ((list)->tq_first)

#define TAILQ_LAST(list) ((list)->tq_last)

#define TAILQ_NEXT(elem, field) ((elem)->field.te_next)

#define TAILQ_PREV(elem, list, field) ((elem)->field.te_prev)

#define TAILQ_FOREACH(var, list, field) \
	for ((var) = TAILQ_FIRST(list); \
	(var) != NULL; \
	(var) = TAILQ_NEXT(var, field))

#define TAILQ_REMOVE(list, elem, field) do { \
		if (TAILQ_NEXT(elem, field) != NULL) { \
			TAILQ_NEXT(elem, field)->field.te_prev = (elem)->field.te_prev; \
		} else { \
			(list)->tq_last = (elem)->field.te_prev; \
		} \
		if (TAILQ_PREV(elem, list, field) != NULL) { \
			TAILQ_PREV(elem, list, field)->field.te_next = (elem)->field.te_next; \
		} else { \
			(list)->tq_first = (elem)->field.te_next; \
		} \
		TRASHIT((elem)->field.te_next); \
		TRASHIT((elem)->field.te_prev); \
	} while(0)

#define TAILQ_INSERT_TAIL(list, elem, field) do { \
		if (TAILQ_EMPTY(list)) { \
			(list)->tq_first = (list)->tq_last = (elem); \
			(elem)->field.te_prev = (elem)->field.te_next = NULL; \
		} else { \
			(elem)->field.te_next = NULL; \
			(elem)->field.te_prev = (list)->tq_last; \
			TAILQ_LAST(list)->field.te_next = (elem); \
			(list)->tq_last = (elem); \
		} \
	} while(0)

#define TAILQ_HEAD_INITIALIZER(head) \
	{ NULL, (head).tq_first }

#define TAILQ_CONCAT(head1, head2, field) do { \
		if (!TAILQ_EMPTY(head2)) { \
			if ((head1)->tq_last) { \
				(head1)->tq_last->field.te_next = (head2)->tq_first; \
			} else { \
				(head1)->tq_first = (head2)->tq_first; \
			} \
			(head2)->tq_first->field.te_prev = (head1)->tq_last; \
			(head1)->tq_last = (head2)->tq_last; \
			TAILQ_INIT((head2)); \
		} \
	} while (0)

#define LIST_HEAD(name, type) struct name { \
		struct type *lh_first; \
	}

#define LIST_ENTRY(type) struct { \
		struct type *le_next; \
		struct type **le_prev; \
	}

#define	LIST_EMPTY(head) ((head)->lh_first == NULL)

#define LIST_FIRST(head) ((head)->lh_first)

#define LIST_FOREACH(var, head, field) \
	for ((var) = LIST_FIRST((head)); \
		(var); \
		(var) = LIST_NEXT((var), field))

#define	LIST_FOREACH_SAFE(var, head, field, tvar) \
	for ((var) = LIST_FIRST((head)); \
		(var) && ((tvar) = LIST_NEXT((var), field), 1); \
		(var) = (tvar))

#define	LIST_INIT(head) do { \
	LIST_FIRST((head)) = NULL; \
} while (0)

#define LIST_NEXT(elm, field) ((elm)->field.le_next)

#define LIST_REMOVE(elm, field) do { \
		if (LIST_NEXT((elm), field) != NULL) \
			LIST_NEXT((elm), field)->field.le_prev = (elm)->field.le_prev; \
		*(elm)->field.le_prev = LIST_NEXT((elm), field); \
	} while (0)

#define LIST_INSERT_HEAD(head, elm, field) do { \
		if ((LIST_NEXT((elm), field) = LIST_FIRST((head))) != NULL) \
			LIST_FIRST((head))->field.le_prev = &LIST_NEXT((elm), field); \
		LIST_FIRST((head)) = (elm); \
		(elm)->field.le_prev = &LIST_FIRST((head)); \
	} while (0)

#endif // __DISPATCH_SHIMS_SYS_QUEUE__