datapath: Use ether_addr_copy
[sliver-openvswitch.git] / lib / list.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #include <config.h>
17 #include "list.h"
18
19 /* Initializes 'list' as an empty list. */
20 void
21 list_init(struct list *list)
22 {
23     list->next = list->prev = list;
24 }
25
26 /* Initializes 'list' with pointers that will (probably) cause segfaults if
27  * dereferenced and, better yet, show up clearly in a debugger. */
28 void
29 list_poison(struct list *list)
30 {
31     memset(list, 0xcc, sizeof *list);
32 }
33
34 /* Inserts 'elem' just before 'before'. */
35 void
36 list_insert(struct list *before, struct list *elem)
37 {
38     elem->prev = before->prev;
39     elem->next = before;
40     before->prev->next = elem;
41     before->prev = elem;
42 }
43
44 /* Removes elements 'first' though 'last' (exclusive) from their current list,
45    then inserts them just before 'before'. */
46 void
47 list_splice(struct list *before, struct list *first, struct list *last)
48 {
49     if (first == last) {
50         return;
51     }
52     last = last->prev;
53
54     /* Cleanly remove 'first'...'last' from its current list. */
55     first->prev->next = last->next;
56     last->next->prev = first->prev;
57
58     /* Splice 'first'...'last' into new list. */
59     first->prev = before->prev;
60     last->next = before;
61     before->prev->next = first;
62     before->prev = last;
63 }
64
65 /* Inserts 'elem' at the beginning of 'list', so that it becomes the front in
66    'list'. */
67 void
68 list_push_front(struct list *list, struct list *elem)
69 {
70     list_insert(list->next, elem);
71 }
72
73 /* Inserts 'elem' at the end of 'list', so that it becomes the back in
74  * 'list'. */
75 void
76 list_push_back(struct list *list, struct list *elem)
77 {
78     list_insert(list, elem);
79 }
80
81 /* Puts 'elem' in the position currently occupied by 'position'.
82  * Afterward, 'position' is not part of a list. */
83 void
84 list_replace(struct list *element, const struct list *position)
85 {
86     element->next = position->next;
87     element->next->prev = element;
88     element->prev = position->prev;
89     element->prev->next = element;
90 }
91
92 /* Adjusts pointers around 'list' to compensate for 'list' having been moved
93  * around in memory (e.g. as a consequence of realloc()).
94  *
95  * This always works if 'list' is a member of a list, or if 'list' is the head
96  * of a non-empty list.  It fails badly, however, if 'list' is the head of an
97  * empty list; just use list_init() in that case. */
98 void
99 list_moved(struct list *list)
100 {
101     list->prev->next = list->next->prev = list;
102 }
103
104 /* Initializes 'dst' with the contents of 'src', compensating for moving it
105  * around in memory.  The effect is that, if 'src' was the head of a list, now
106  * 'dst' is the head of a list containing the same elements. */
107 void
108 list_move(struct list *dst, struct list *src)
109 {
110     if (!list_is_empty(src)) {
111         *dst = *src;
112         list_moved(dst);
113     } else {
114         list_init(dst);
115     }
116 }
117
118 /* Removes 'elem' from its list and returns the element that followed it.
119    Undefined behavior if 'elem' is not in a list. */
120 struct list *
121 list_remove(struct list *elem)
122 {
123     elem->prev->next = elem->next;
124     elem->next->prev = elem->prev;
125     return elem->next;
126 }
127
128 /* Removes the front element from 'list' and returns it.  Undefined behavior if
129    'list' is empty before removal. */
130 struct list *
131 list_pop_front(struct list *list)
132 {
133     struct list *front = list->next;
134     list_remove(front);
135     return front;
136 }
137
138 /* Removes the back element from 'list' and returns it.
139    Undefined behavior if 'list' is empty before removal. */
140 struct list *
141 list_pop_back(struct list *list)
142 {
143     struct list *back = list->prev;
144     list_remove(back);
145     return back;
146 }
147
148 /* Returns the front element in 'list_'.
149    Undefined behavior if 'list_' is empty. */
150 struct list *
151 list_front(const struct list *list_)
152 {
153     struct list *list = CONST_CAST(struct list *, list_);
154
155     ovs_assert(!list_is_empty(list));
156     return list->next;
157 }
158
159 /* Returns the back element in 'list_'.
160    Undefined behavior if 'list_' is empty. */
161 struct list *
162 list_back(const struct list *list_)
163 {
164     struct list *list = CONST_CAST(struct list *, list_);
165
166     ovs_assert(!list_is_empty(list));
167     return list->prev;
168 }
169
170 /* Returns the number of elements in 'list'.
171    Runs in O(n) in the number of elements. */
172 size_t
173 list_size(const struct list *list)
174 {
175     const struct list *e;
176     size_t cnt = 0;
177
178     for (e = list->next; e != list; e = e->next) {
179         cnt++;
180     }
181     return cnt;
182 }
183
184 /* Returns true if 'list' is empty, false otherwise. */
185 bool
186 list_is_empty(const struct list *list)
187 {
188     return list->next == list;
189 }
190
191 /* Returns true if 'list' has exactly 1 element, false otherwise. */
192 bool
193 list_is_singleton(const struct list *list)
194 {
195     return list_is_short(list) && !list_is_empty(list);
196 }
197
198 /* Returns true if 'list' has 0 or 1 elements, false otherwise. */
199 bool
200 list_is_short(const struct list *list)
201 {
202     return list->next == list->prev;
203 }