Rev 2446 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 2446 | Rev 2729 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (c) 2001-2004 Jakub Jermar |
2 | * Copyright (c) 2001-2004 Jakub Jermar |
3 | * All rights reserved. |
3 | * All rights reserved. |
4 | * |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions |
6 | * modification, are permitted provided that the following conditions |
7 | * are met: |
7 | * are met: |
8 | * |
8 | * |
9 | * - Redistributions of source code must retain the above copyright |
9 | * - Redistributions of source code must retain the above copyright |
10 | * notice, this list of conditions and the following disclaimer. |
10 | * notice, this list of conditions and the following disclaimer. |
11 | * - Redistributions in binary form must reproduce the above copyright |
11 | * - Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
13 | * documentation and/or other materials provided with the distribution. |
14 | * - The name of the author may not be used to endorse or promote products |
14 | * - The name of the author may not be used to endorse or promote products |
15 | * derived from this software without specific prior written permission. |
15 | * derived from this software without specific prior written permission. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
27 | */ |
27 | */ |
28 | 28 | ||
29 | /** @addtogroup genericadt |
29 | /** @addtogroup genericadt |
30 | * @{ |
30 | * @{ |
31 | */ |
31 | */ |
32 | /** @file |
32 | /** @file |
33 | */ |
33 | */ |
34 | 34 | ||
35 | #ifndef KERN_LIST_H_ |
35 | #ifndef KERN_LIST_H_ |
36 | #define KERN_LIST_H_ |
36 | #define KERN_LIST_H_ |
37 | 37 | ||
38 | #include <arch/types.h> |
38 | #include <arch/types.h> |
39 | 39 | ||
40 | /** Doubly linked list head and link type. */ |
40 | /** Doubly linked list head and link type. */ |
41 | typedef struct link { |
41 | typedef struct link { |
42 | struct link *prev; /**< Pointer to the previous item in the list. */ |
42 | struct link *prev; /**< Pointer to the previous item in the list. */ |
43 | struct link *next; /**< Pointer to the next item in the list. */ |
43 | struct link *next; /**< Pointer to the next item in the list. */ |
44 | } link_t; |
44 | } link_t; |
45 | 45 | ||
46 | /** Declare and initialize statically allocated list. |
46 | /** Declare and initialize statically allocated list. |
47 | * |
47 | * |
48 | * @param name Name of the new statically allocated list. |
48 | * @param name Name of the new statically allocated list. |
49 | */ |
49 | */ |
50 | #define LIST_INITIALIZE(name) \ |
50 | #define LIST_INITIALIZE(name) \ |
51 | link_t name = { .prev = &name, .next = &name } |
51 | link_t name = { .prev = &name, .next = &name } |
52 | 52 | ||
53 | /** Initialize doubly-linked circular list link |
53 | /** Initialize doubly-linked circular list link |
54 | * |
54 | * |
55 | * Initialize doubly-linked list link. |
55 | * Initialize doubly-linked list link. |
56 | * |
56 | * |
57 | * @param link Pointer to link_t structure to be initialized. |
57 | * @param link Pointer to link_t structure to be initialized. |
58 | */ |
58 | */ |
59 | static inline void link_initialize(link_t *link) |
59 | static inline void link_initialize(link_t *link) |
60 | { |
60 | { |
61 | link->prev = NULL; |
61 | link->prev = NULL; |
62 | link->next = NULL; |
62 | link->next = NULL; |
63 | } |
63 | } |
64 | 64 | ||
65 | /** Initialize doubly-linked circular list |
65 | /** Initialize doubly-linked circular list |
66 | * |
66 | * |
67 | * Initialize doubly-linked circular list. |
67 | * Initialize doubly-linked circular list. |
68 | * |
68 | * |
69 | * @param head Pointer to link_t structure representing head of the list. |
69 | * @param head Pointer to link_t structure representing head of the list. |
70 | */ |
70 | */ |
71 | static inline void list_initialize(link_t *head) |
71 | static inline void list_initialize(link_t *head) |
72 | { |
72 | { |
73 | head->prev = head; |
73 | head->prev = head; |
74 | head->next = head; |
74 | head->next = head; |
75 | } |
75 | } |
76 | 76 | ||
77 | /** Add item to the beginning of doubly-linked circular list |
77 | /** Add item to the beginning of doubly-linked circular list |
78 | * |
78 | * |
79 | * Add item to the beginning of doubly-linked circular list. |
79 | * Add item to the beginning of doubly-linked circular list. |
80 | * |
80 | * |
81 | * @param link Pointer to link_t structure to be added. |
81 | * @param link Pointer to link_t structure to be added. |
82 | * @param head Pointer to link_t structure representing head of the list. |
82 | * @param head Pointer to link_t structure representing head of the list. |
83 | */ |
83 | */ |
84 | static inline void list_prepend(link_t *link, link_t *head) |
84 | static inline void list_prepend(link_t *link, link_t *head) |
85 | { |
85 | { |
86 | link->next = head->next; |
86 | link->next = head->next; |
87 | link->prev = head; |
87 | link->prev = head; |
88 | head->next->prev = link; |
88 | head->next->prev = link; |
89 | head->next = link; |
89 | head->next = link; |
90 | } |
90 | } |
91 | 91 | ||
92 | /** Add item to the end of doubly-linked circular list |
92 | /** Add item to the end of doubly-linked circular list |
93 | * |
93 | * |
94 | * Add item to the end of doubly-linked circular list. |
94 | * Add item to the end of doubly-linked circular list. |
95 | * |
95 | * |
96 | * @param link Pointer to link_t structure to be added. |
96 | * @param link Pointer to link_t structure to be added. |
97 | * @param head Pointer to link_t structure representing head of the list. |
97 | * @param head Pointer to link_t structure representing head of the list. |
98 | */ |
98 | */ |
99 | static inline void list_append(link_t *link, link_t *head) |
99 | static inline void list_append(link_t *link, link_t *head) |
100 | { |
100 | { |
101 | link->prev = head->prev; |
101 | link->prev = head->prev; |
102 | link->next = head; |
102 | link->next = head; |
103 | head->prev->next = link; |
103 | head->prev->next = link; |
104 | head->prev = link; |
104 | head->prev = link; |
105 | } |
105 | } |
106 | 106 | ||
107 | /** Remove item from doubly-linked circular list |
107 | /** Remove item from doubly-linked circular list |
108 | * |
108 | * |
109 | * Remove item from doubly-linked circular list. |
109 | * Remove item from doubly-linked circular list. |
110 | * |
110 | * |
111 | * @param link Pointer to link_t structure to be removed from the list it is |
111 | * @param link Pointer to link_t structure to be removed from the list it is |
112 | * contained in. |
112 | * contained in. |
113 | */ |
113 | */ |
114 | static inline void list_remove(link_t *link) |
114 | static inline void list_remove(link_t *link) |
115 | { |
115 | { |
116 | link->next->prev = link->prev; |
116 | link->next->prev = link->prev; |
117 | link->prev->next = link->next; |
117 | link->prev->next = link->next; |
118 | link_initialize(link); |
118 | link_initialize(link); |
119 | } |
119 | } |
120 | 120 | ||
121 | /** Query emptiness of doubly-linked circular list |
121 | /** Query emptiness of doubly-linked circular list |
122 | * |
122 | * |
123 | * Query emptiness of doubly-linked circular list. |
123 | * Query emptiness of doubly-linked circular list. |
124 | * |
124 | * |
125 | * @param head Pointer to link_t structure representing head of the list. |
125 | * @param head Pointer to link_t structure representing head of the list. |
126 | */ |
126 | */ |
127 | static inline bool list_empty(link_t *head) |
127 | static inline bool list_empty(link_t *head) |
128 | { |
128 | { |
129 | return head->next == head ? true : false; |
129 | return head->next == head ? true : false; |
130 | } |
130 | } |
131 | 131 | ||
132 | 132 | ||
133 | /** Split or concatenate headless doubly-linked circular list |
133 | /** Split or concatenate headless doubly-linked circular list |
134 | * |
134 | * |
135 | * Split or concatenate headless doubly-linked circular list. |
135 | * Split or concatenate headless doubly-linked circular list. |
136 | * |
136 | * |
137 | * Note that the algorithm works both directions: |
137 | * Note that the algorithm works both directions: |
138 | * concatenates splitted lists and splits concatenated lists. |
138 | * concatenates splitted lists and splits concatenated lists. |
139 | * |
139 | * |
140 | * @param part1 Pointer to link_t structure leading the first (half of the |
140 | * @param part1 Pointer to link_t structure leading the first (half of the |
141 | * headless) list. |
141 | * headless) list. |
142 | * @param part2 Pointer to link_t structure leading the second (half of the |
142 | * @param part2 Pointer to link_t structure leading the second (half of the |
143 | * headless) list. |
143 | * headless) list. |
144 | */ |
144 | */ |
145 | static inline void headless_list_split_or_concat(link_t *part1, link_t *part2) |
145 | static inline void headless_list_split_or_concat(link_t *part1, link_t *part2) |
146 | { |
146 | { |
147 | link_t *hlp; |
147 | link_t *hlp; |
148 | 148 | ||
149 | part1->prev->next = part2; |
149 | part1->prev->next = part2; |
150 | part2->prev->next = part1; |
150 | part2->prev->next = part1; |
151 | hlp = part1->prev; |
151 | hlp = part1->prev; |
152 | part1->prev = part2->prev; |
152 | part1->prev = part2->prev; |
153 | part2->prev = hlp; |
153 | part2->prev = hlp; |
154 | } |
154 | } |
155 | 155 | ||
156 | 156 | ||
157 | /** Split headless doubly-linked circular list |
157 | /** Split headless doubly-linked circular list |
158 | * |
158 | * |
159 | * Split headless doubly-linked circular list. |
159 | * Split headless doubly-linked circular list. |
160 | * |
160 | * |
161 | * @param part1 Pointer to link_t structure leading the first half of the |
161 | * @param part1 Pointer to link_t structure leading the first half of the |
162 | * headless list. |
162 | * headless list. |
163 | * @param part2 Pointer to link_t structure leading the second half of the |
163 | * @param part2 Pointer to link_t structure leading the second half of the |
164 | * headless list. |
164 | * headless list. |
165 | */ |
165 | */ |
166 | static inline void headless_list_split(link_t *part1, link_t *part2) |
166 | static inline void headless_list_split(link_t *part1, link_t *part2) |
167 | { |
167 | { |
168 | headless_list_split_or_concat(part1, part2); |
168 | headless_list_split_or_concat(part1, part2); |
169 | } |
169 | } |
170 | 170 | ||
171 | /** Concatenate two headless doubly-linked circular lists |
171 | /** Concatenate two headless doubly-linked circular lists |
172 | * |
172 | * |
173 | * Concatenate two headless doubly-linked circular lists. |
173 | * Concatenate two headless doubly-linked circular lists. |
174 | * |
174 | * |
175 | * @param part1 Pointer to link_t structure leading the first headless list. |
175 | * @param part1 Pointer to link_t structure leading the first headless list. |
176 | * @param part2 Pointer to link_t structure leading the second headless list. |
176 | * @param part2 Pointer to link_t structure leading the second headless list. |
177 | */ |
177 | */ |
178 | static inline void headless_list_concat(link_t *part1, link_t *part2) |
178 | static inline void headless_list_concat(link_t *part1, link_t *part2) |
179 | { |
179 | { |
180 | headless_list_split_or_concat(part1, part2); |
180 | headless_list_split_or_concat(part1, part2); |
181 | } |
181 | } |
182 | 182 | ||
183 | #define list_get_instance(link, type, member) \ |
183 | #define list_get_instance(link, type, member) \ |
184 | ((type *)(((uint8_t *)(link)) - ((uint8_t *)&(((type *)NULL)->member)))) |
184 | ((type *)(((uint8_t *)(link)) - ((uint8_t *)&(((type *)NULL)->member)))) |
185 | 185 | ||
186 | extern bool list_member(const link_t *link, const link_t *head); |
186 | extern bool list_member(const link_t *link, const link_t *head); |
187 | extern void list_concat(link_t *head1, link_t *head2); |
187 | extern void list_concat(link_t *head1, link_t *head2); |
188 | 188 | ||
189 | #endif |
189 | #endif |
190 | 190 | ||
191 | /** @} |
191 | /** @} |
192 | */ |
192 | */ |
193 | 193 |