1/* drm_linux_list.h -- linux list functions for the BSDs.
2 * Created: Mon Apr 7 14:30:16 1999 by anholt@FreeBSD.org
3 */
4/*-
5 * Copyright 2003 Eric Anholt
6 * All Rights Reserved.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice (including the next
16 * paragraph) shall be included in all copies or substantial portions of the
17 * Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
22 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
26 *
27 * Authors:
28 *    Eric Anholt <anholt@FreeBSD.org>
29 *
30 */
31
32#include <sys/cdefs.h>
33__FBSDID("$FreeBSD$");
34
35#ifndef _DRM_LINUX_LIST_H_
36#define _DRM_LINUX_LIST_H_
37
38struct list_head {
39	struct list_head *next, *prev;
40};
41
42#define list_entry(ptr, type, member) container_of(ptr,type,member)
43#define hlist_entry(ptr, type, member) container_of(ptr,type,member)
44
45static __inline__ void
46INIT_LIST_HEAD(struct list_head *head) {
47	(head)->next = head;
48	(head)->prev = head;
49}
50
51#define LIST_HEAD_INIT(name) { &(name), &(name) }
52
53#define DRM_LIST_HEAD(name) \
54	struct list_head name = LIST_HEAD_INIT(name)
55
56static __inline__ int
57list_empty(const struct list_head *head) {
58	return (head)->next == head;
59}
60
61static __inline__ void
62list_add(struct list_head *new, struct list_head *head) {
63        (head)->next->prev = new;
64        (new)->next = (head)->next;
65        (new)->prev = head;
66        (head)->next = new;
67}
68
69static __inline__ void
70list_add_tail(struct list_head *entry, struct list_head *head) {
71	(entry)->prev = (head)->prev;
72	(entry)->next = head;
73	(head)->prev->next = entry;
74	(head)->prev = entry;
75}
76
77static __inline__ void
78list_del(struct list_head *entry) {
79	(entry)->next->prev = (entry)->prev;
80	(entry)->prev->next = (entry)->next;
81}
82
83static inline void list_replace(struct list_head *old,
84				struct list_head *new)
85{
86	new->next = old->next;
87	new->next->prev = new;
88	new->prev = old->prev;
89	new->prev->next = new;
90}
91
92static inline void list_move(struct list_head *list, struct list_head *head)
93{
94	list_del(list);
95	list_add(list, head);
96}
97
98static inline void list_move_tail(struct list_head *list,
99    struct list_head *head)
100{
101	list_del(list);
102	list_add_tail(list, head);
103}
104
105static __inline__ void
106list_del_init(struct list_head *entry) {
107	(entry)->next->prev = (entry)->prev;
108	(entry)->prev->next = (entry)->next;
109	INIT_LIST_HEAD(entry);
110}
111
112#define list_for_each(entry, head)				\
113    for (entry = (head)->next; entry != head; entry = (entry)->next)
114
115#define list_for_each_prev(entry, head) \
116        for (entry = (head)->prev; entry != (head); \
117                entry = entry->prev)
118
119#define list_for_each_safe(entry, temp, head)			\
120    for (entry = (head)->next, temp = (entry)->next;		\
121	entry != head; 						\
122	entry = temp, temp = entry->next)
123
124#define list_for_each_entry(pos, head, member)				\
125    for (pos = list_entry((head)->next, __typeof(*pos), member);	\
126	&pos->member != (head);					 	\
127	pos = list_entry(pos->member.next, __typeof(*pos), member))
128
129#define list_for_each_entry_continue_reverse(pos, head, member)         \
130        for (pos = list_entry(pos->member.prev, __typeof(*pos), member);  \
131             &pos->member != (head);    				\
132             pos = list_entry(pos->member.prev, __typeof(*pos), member))
133
134/**
135 * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
136 * @pos:        the type * to use as a loop cursor.
137 * @n:          another type * to use as temporary storage
138 * @head:       the head for your list.
139 * @member:     the name of the list_struct within the struct.
140 */
141#define list_for_each_entry_safe(pos, n, head, member)			\
142	for (pos = list_entry((head)->next, __typeof(*pos), member),	\
143	    n = list_entry(pos->member.next, __typeof(*pos), member);	\
144	    &pos->member != (head);					\
145	    pos = n, n = list_entry(n->member.next, __typeof(*n), member))
146
147#define list_for_each_entry_safe_from(pos, n, head, member) 			\
148	for (n = list_entry(pos->member.next, __typeof(*pos), member);		\
149	     &pos->member != (head);						\
150	     pos = n, n = list_entry(n->member.next, __typeof(*n), member))
151
152#define list_first_entry(ptr, type, member) \
153	list_entry((ptr)->next, type, member)
154
155
156static inline void
157__list_splice(const struct list_head *list, struct list_head *prev,
158    struct list_head *next)
159{
160	struct list_head *first = list->next;
161	struct list_head *last = list->prev;
162
163	first->prev = prev;
164	prev->next = first;
165
166	last->next = next;
167	next->prev = last;
168}
169
170static inline void
171list_splice(const struct list_head *list, struct list_head *head)
172{
173	if (list_empty(list))
174		return;
175
176	__list_splice(list, head, head->next);
177}
178
179void drm_list_sort(void *priv, struct list_head *head, int (*cmp)(void *priv,
180    struct list_head *a, struct list_head *b));
181
182#endif /* _DRM_LINUX_LIST_H_ */
183