lib/list.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 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 #ifndef LIST_H
  17 #define LIST_H 1
  18
  19 /* Doubly linked list. */
  20
  21 #include <stdbool.h>
  22 #include <stddef.h>
  23 #include "util.h"
  24 #include "openvswitch/list.h"
  25
  26 static inline void list_init(struct ovs_list *);
  27 static inline void list_poison(struct ovs_list *);
  28
  29 /* List insertion. */
  30 static inline void list_insert(struct ovs_list *, struct ovs_list *);
  31 static inline void list_splice(struct ovs_list *before, struct ovs_list *first,
  32                                struct ovs_list *last);
  33 static inline void list_push_front(struct ovs_list *, struct ovs_list *);
  34 static inline void list_push_back(struct ovs_list *, struct ovs_list *);
  35 static inline void list_replace(struct ovs_list *, const struct ovs_list *);
  36 static inline void list_moved(struct ovs_list *);
  37 static inline void list_move(struct ovs_list *dst, struct ovs_list *src);
  38
  39 /* List removal. */
  40 static inline struct ovs_list *list_remove(struct ovs_list *);
  41 static inline struct ovs_list *list_pop_front(struct ovs_list *);
  42 static inline struct ovs_list *list_pop_back(struct ovs_list *);
  43
  44 /* List elements. */
  45 static inline struct ovs_list *list_front(const struct ovs_list *);
  46 static inline struct ovs_list *list_back(const struct ovs_list *);
  47
  48 /* List properties. */
  49 static inline size_t list_size(const struct ovs_list *);
  50 static inline bool list_is_empty(const struct ovs_list *);
  51 static inline bool list_is_singleton(const struct ovs_list *);
  52 static inline bool list_is_short(const struct ovs_list *);
  53
  54 #define LIST_FOR_EACH(ITER, MEMBER, LIST)                               \
  55     for (INIT_CONTAINER(ITER, (LIST)->next, MEMBER);                    \
  56          &(ITER)->MEMBER != (LIST);                                     \
  57          ASSIGN_CONTAINER(ITER, (ITER)->MEMBER.next, MEMBER))
  58 #define LIST_FOR_EACH_CONTINUE(ITER, MEMBER, LIST)                      \
  59     for (INIT_CONTAINER(ITER, (ITER)->MEMBER.next, MEMBER);             \
  60          &(ITER)->MEMBER != (LIST);                                     \
  61          ASSIGN_CONTAINER(ITER, (ITER)->MEMBER.next, MEMBER))
  62 #define LIST_FOR_EACH_REVERSE(ITER, MEMBER, LIST)                       \
  63     for (INIT_CONTAINER(ITER, (LIST)->prev, MEMBER);                    \
  64          &(ITER)->MEMBER != (LIST);                                     \
  65          ASSIGN_CONTAINER(ITER, (ITER)->MEMBER.prev, MEMBER))
  66 #define LIST_FOR_EACH_REVERSE_CONTINUE(ITER, MEMBER, LIST)              \
  67     for (ASSIGN_CONTAINER(ITER, (ITER)->MEMBER.prev, MEMBER);           \
  68          &(ITER)->MEMBER != (LIST);                                     \
  69          ASSIGN_CONTAINER(ITER, (ITER)->MEMBER.prev, MEMBER))
  70 #define LIST_FOR_EACH_SAFE(ITER, NEXT, MEMBER, LIST)               \
  71     for (INIT_CONTAINER(ITER, (LIST)->next, MEMBER);               \
  72          (&(ITER)->MEMBER != (LIST)                                \
  73           ? INIT_CONTAINER(NEXT, (ITER)->MEMBER.next, MEMBER), 1   \
  74           : 0);                                                    \
  75          (ITER) = (NEXT))
  76 \f
  77 /* Inline implementations. */
  78
  79 /* Initializes 'list' as an empty list. */
  80 static inline void
  81 list_init(struct ovs_list *list)
  82 {
  83     list->next = list->prev = list;
  84 }
  85
  86 /* Initializes 'list' with pointers that will (probably) cause segfaults if
  87  * dereferenced and, better yet, show up clearly in a debugger. */
  88 static inline void
  89 list_poison(struct ovs_list *list)
  90 {
  91     memset(list, 0xcc, sizeof *list);
  92 }
  93
  94 /* Inserts 'elem' just before 'before'. */
  95 static inline void
  96 list_insert(struct ovs_list *before, struct ovs_list *elem)
  97 {
  98     elem->prev = before->prev;
  99     elem->next = before;
 100     before->prev->next = elem;
 101     before->prev = elem;
 102 }
 103
 104 /* Removes elements 'first' though 'last' (exclusive) from their current list,
 105    then inserts them just before 'before'. */
 106 static inline void
 107 list_splice(struct ovs_list *before, struct ovs_list *first, struct ovs_list *last)
 108 {
 109     if (first == last) {
 110         return;
 111     }
 112     last = last->prev;
 113
 114     /* Cleanly remove 'first'...'last' from its current list. */
 115     first->prev->next = last->next;
 116     last->next->prev = first->prev;
 117
 118     /* Splice 'first'...'last' into new list. */
 119     first->prev = before->prev;
 120     last->next = before;
 121     before->prev->next = first;
 122     before->prev = last;
 123 }
 124
 125 /* Inserts 'elem' at the beginning of 'list', so that it becomes the front in
 126    'list'. */
 127 static inline void
 128 list_push_front(struct ovs_list *list, struct ovs_list *elem)
 129 {
 130     list_insert(list->next, elem);
 131 }
 132
 133 /* Inserts 'elem' at the end of 'list', so that it becomes the back in
 134  * 'list'. */
 135 static inline void
 136 list_push_back(struct ovs_list *list, struct ovs_list *elem)
 137 {
 138     list_insert(list, elem);
 139 }
 140
 141 /* Puts 'elem' in the position currently occupied by 'position'.
 142  * Afterward, 'position' is not part of a list. */
 143 static inline void
 144 list_replace(struct ovs_list *element, const struct ovs_list *position)
 145 {
 146     element->next = position->next;
 147     element->next->prev = element;
 148     element->prev = position->prev;
 149     element->prev->next = element;
 150 }
 151
 152 /* Adjusts pointers around 'list' to compensate for 'list' having been moved
 153  * around in memory (e.g. as a consequence of realloc()).
 154  *
 155  * This always works if 'list' is a member of a list, or if 'list' is the head
 156  * of a non-empty list.  It fails badly, however, if 'list' is the head of an
 157  * empty list; just use list_init() in that case. */
 158 static inline void
 159 list_moved(struct ovs_list *list)
 160 {
 161     list->prev->next = list->next->prev = list;
 162 }
 163
 164 /* Initializes 'dst' with the contents of 'src', compensating for moving it
 165  * around in memory.  The effect is that, if 'src' was the head of a list, now
 166  * 'dst' is the head of a list containing the same elements. */
 167 static inline void
 168 list_move(struct ovs_list *dst, struct ovs_list *src)
 169 {
 170     if (!list_is_empty(src)) {
 171         *dst = *src;
 172         list_moved(dst);
 173     } else {
 174         list_init(dst);
 175     }
 176 }
 177
 178 /* Removes 'elem' from its list and returns the element that followed it.
 179    Undefined behavior if 'elem' is not in a list. */
 180 static inline struct ovs_list *
 181 list_remove(struct ovs_list *elem)
 182 {
 183     elem->prev->next = elem->next;
 184     elem->next->prev = elem->prev;
 185     return elem->next;
 186 }
 187
 188 /* Removes the front element from 'list' and returns it.  Undefined behavior if
 189    'list' is empty before removal. */
 190 static inline struct ovs_list *
 191 list_pop_front(struct ovs_list *list)
 192 {
 193     struct ovs_list *front = list->next;
 194
 195     list_remove(front);
 196     return front;
 197 }
 198
 199 /* Removes the back element from 'list' and returns it.
 200    Undefined behavior if 'list' is empty before removal. */
 201 static inline struct ovs_list *
 202 list_pop_back(struct ovs_list *list)
 203 {
 204     struct ovs_list *back = list->prev;
 205
 206     list_remove(back);
 207     return back;
 208 }
 209
 210 /* Returns the front element in 'list_'.
 211    Undefined behavior if 'list_' is empty. */
 212 static inline struct ovs_list *
 213 list_front(const struct ovs_list *list_)
 214 {
 215     struct ovs_list *list = CONST_CAST(struct ovs_list *, list_);
 216
 217     ovs_assert(!list_is_empty(list));
 218
 219     return list->next;
 220 }
 221
 222 /* Returns the back element in 'list_'.
 223    Undefined behavior if 'list_' is empty. */
 224 static inline struct ovs_list *
 225 list_back(const struct ovs_list *list_)
 226 {
 227     struct ovs_list *list = CONST_CAST(struct ovs_list *, list_);
 228
 229     ovs_assert(!list_is_empty(list));
 230
 231     return list->prev;
 232 }
 233
 234 /* Returns the number of elements in 'list'.
 235    Runs in O(n) in the number of elements. */
 236 static inline size_t
 237 list_size(const struct ovs_list *list)
 238 {
 239     const struct ovs_list *e;
 240     size_t cnt = 0;
 241
 242     for (e = list->next; e != list; e = e->next) {
 243         cnt++;
 244     }
 245     return cnt;
 246 }
 247
 248 /* Returns true if 'list' is empty, false otherwise. */
 249 static inline bool
 250 list_is_empty(const struct ovs_list *list)
 251 {
 252     return list->next == list;
 253 }
 254
 255 /* Returns true if 'list' has exactly 1 element, false otherwise. */
 256 static inline bool
 257 list_is_singleton(const struct ovs_list *list)
 258 {
 259     return list_is_short(list) && !list_is_empty(list);
 260 }
 261
 262 /* Returns true if 'list' has 0 or 1 elements, false otherwise. */
 263 static inline bool
 264 list_is_short(const struct ovs_list *list)
 265 {
 266     return list->next == list->prev;
 267 }
 268
 269 #endif /* list.h */