list: Inline all functions.
authorJarno Rajahalme <jrajahalme@nicira.com>
Wed, 29 Oct 2014 17:15:42 +0000 (10:15 -0700)
committerJarno Rajahalme <jrajahalme@nicira.com>
Thu, 30 Oct 2014 16:13:54 +0000 (09:13 -0700)
All of the list functions are really small, so inlining them should be
beneficial.

Requested-by: Ben Pfaff <blp@nicira.com>
Signed-off-by: Jarno Rajahalme <jrajahalme@nicira.com>
Acked-by: Ben Pfaff <blp@nicira.com>
lib/automake.mk
lib/list.c [deleted file]
lib/list.h

index 7572e95..42424aa 100644 (file)
@@ -97,7 +97,6 @@ lib_libopenvswitch_la_SOURCES = \
        lib/learn.h \
        lib/learning-switch.c \
        lib/learning-switch.h \
-       lib/list.c \
        lib/list.h \
        lib/lockfile.c \
        lib/lockfile.h \
diff --git a/lib/list.c b/lib/list.c
deleted file mode 100644 (file)
index e341d45..0000000
+++ /dev/null
@@ -1,203 +0,0 @@
-/*
- * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
- *
- * 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.
- */
-#include <config.h>
-#include "list.h"
-
-/* Initializes 'list' as an empty list. */
-void
-list_init(struct list *list)
-{
-    list->next = list->prev = list;
-}
-
-/* Initializes 'list' with pointers that will (probably) cause segfaults if
- * dereferenced and, better yet, show up clearly in a debugger. */
-void
-list_poison(struct list *list)
-{
-    memset(list, 0xcc, sizeof *list);
-}
-
-/* Inserts 'elem' just before 'before'. */
-void
-list_insert(struct list *before, struct list *elem)
-{
-    elem->prev = before->prev;
-    elem->next = before;
-    before->prev->next = elem;
-    before->prev = elem;
-}
-
-/* Removes elements 'first' though 'last' (exclusive) from their current list,
-   then inserts them just before 'before'. */
-void
-list_splice(struct list *before, struct list *first, struct list *last)
-{
-    if (first == last) {
-        return;
-    }
-    last = last->prev;
-
-    /* Cleanly remove 'first'...'last' from its current list. */
-    first->prev->next = last->next;
-    last->next->prev = first->prev;
-
-    /* Splice 'first'...'last' into new list. */
-    first->prev = before->prev;
-    last->next = before;
-    before->prev->next = first;
-    before->prev = last;
-}
-
-/* Inserts 'elem' at the beginning of 'list', so that it becomes the front in
-   'list'. */
-void
-list_push_front(struct list *list, struct list *elem)
-{
-    list_insert(list->next, elem);
-}
-
-/* Inserts 'elem' at the end of 'list', so that it becomes the back in
- * 'list'. */
-void
-list_push_back(struct list *list, struct list *elem)
-{
-    list_insert(list, elem);
-}
-
-/* Puts 'elem' in the position currently occupied by 'position'.
- * Afterward, 'position' is not part of a list. */
-void
-list_replace(struct list *element, const struct list *position)
-{
-    element->next = position->next;
-    element->next->prev = element;
-    element->prev = position->prev;
-    element->prev->next = element;
-}
-
-/* Adjusts pointers around 'list' to compensate for 'list' having been moved
- * around in memory (e.g. as a consequence of realloc()).
- *
- * This always works if 'list' is a member of a list, or if 'list' is the head
- * of a non-empty list.  It fails badly, however, if 'list' is the head of an
- * empty list; just use list_init() in that case. */
-void
-list_moved(struct list *list)
-{
-    list->prev->next = list->next->prev = list;
-}
-
-/* Initializes 'dst' with the contents of 'src', compensating for moving it
- * around in memory.  The effect is that, if 'src' was the head of a list, now
- * 'dst' is the head of a list containing the same elements. */
-void
-list_move(struct list *dst, struct list *src)
-{
-    if (!list_is_empty(src)) {
-        *dst = *src;
-        list_moved(dst);
-    } else {
-        list_init(dst);
-    }
-}
-
-/* Removes 'elem' from its list and returns the element that followed it.
-   Undefined behavior if 'elem' is not in a list. */
-struct list *
-list_remove(struct list *elem)
-{
-    elem->prev->next = elem->next;
-    elem->next->prev = elem->prev;
-    return elem->next;
-}
-
-/* Removes the front element from 'list' and returns it.  Undefined behavior if
-   'list' is empty before removal. */
-struct list *
-list_pop_front(struct list *list)
-{
-    struct list *front = list->next;
-    list_remove(front);
-    return front;
-}
-
-/* Removes the back element from 'list' and returns it.
-   Undefined behavior if 'list' is empty before removal. */
-struct list *
-list_pop_back(struct list *list)
-{
-    struct list *back = list->prev;
-    list_remove(back);
-    return back;
-}
-
-/* Returns the front element in 'list_'.
-   Undefined behavior if 'list_' is empty. */
-struct list *
-list_front(const struct list *list_)
-{
-    struct list *list = CONST_CAST(struct list *, list_);
-
-    ovs_assert(!list_is_empty(list));
-    return list->next;
-}
-
-/* Returns the back element in 'list_'.
-   Undefined behavior if 'list_' is empty. */
-struct list *
-list_back(const struct list *list_)
-{
-    struct list *list = CONST_CAST(struct list *, list_);
-
-    ovs_assert(!list_is_empty(list));
-    return list->prev;
-}
-
-/* Returns the number of elements in 'list'.
-   Runs in O(n) in the number of elements. */
-size_t
-list_size(const struct list *list)
-{
-    const struct list *e;
-    size_t cnt = 0;
-
-    for (e = list->next; e != list; e = e->next) {
-        cnt++;
-    }
-    return cnt;
-}
-
-/* Returns true if 'list' is empty, false otherwise. */
-bool
-list_is_empty(const struct list *list)
-{
-    return list->next == list;
-}
-
-/* Returns true if 'list' has exactly 1 element, false otherwise. */
-bool
-list_is_singleton(const struct list *list)
-{
-    return list_is_short(list) && !list_is_empty(list);
-}
-
-/* Returns true if 'list' has 0 or 1 elements, false otherwise. */
-bool
-list_is_short(const struct list *list)
-{
-    return list->next == list->prev;
-}
index ef6a9db..53582ee 100644 (file)
@@ -30,32 +30,33 @@ struct list {
 
 #define LIST_INITIALIZER(LIST) { LIST, LIST }
 
-void list_init(struct list *);
-void list_poison(struct list *);
+static inline void list_init(struct list *);
+static inline void list_poison(struct list *);
 
 /* List insertion. */
-void list_insert(struct list *, struct list *);
-void list_splice(struct list *before, struct list *first, struct list *last);
-void list_push_front(struct list *, struct list *);
-void list_push_back(struct list *, struct list *);
-void list_replace(struct list *, const struct list *);
-void list_moved(struct list *);
-void list_move(struct list *dst, struct list *src);
+static inline void list_insert(struct list *, struct list *);
+static inline void list_splice(struct list *before, struct list *first,
+                               struct list *last);
+static inline void list_push_front(struct list *, struct list *);
+static inline void list_push_back(struct list *, struct list *);
+static inline void list_replace(struct list *, const struct list *);
+static inline void list_moved(struct list *);
+static inline void list_move(struct list *dst, struct list *src);
 
 /* List removal. */
-struct list *list_remove(struct list *);
-struct list *list_pop_front(struct list *);
-struct list *list_pop_back(struct list *);
+static inline struct list *list_remove(struct list *);
+static inline struct list *list_pop_front(struct list *);
+static inline struct list *list_pop_back(struct list *);
 
 /* List elements. */
-struct list *list_front(const struct list *);
-struct list *list_back(const struct list *);
+static inline struct list *list_front(const struct list *);
+static inline struct list *list_back(const struct list *);
 
 /* List properties. */
-size_t list_size(const struct list *);
-bool list_is_empty(const struct list *);
-bool list_is_singleton(const struct list *);
-bool list_is_short(const struct list *);
+static inline size_t list_size(const struct list *);
+static inline bool list_is_empty(const struct list *);
+static inline bool list_is_singleton(const struct list *);
+static inline bool list_is_short(const struct list *);
 
 #define LIST_FOR_EACH(ITER, MEMBER, LIST)                               \
     for (INIT_CONTAINER(ITER, (LIST)->next, MEMBER);                    \
@@ -79,5 +80,197 @@ bool list_is_short(const struct list *);
           ? INIT_CONTAINER(NEXT, (ITER)->MEMBER.next, MEMBER), 1   \
           : 0);                                                    \
          (ITER) = (NEXT))
+\f
+/* Inline implementations. */
+
+/* Initializes 'list' as an empty list. */
+static inline void
+list_init(struct list *list)
+{
+    list->next = list->prev = list;
+}
+
+/* Initializes 'list' with pointers that will (probably) cause segfaults if
+ * dereferenced and, better yet, show up clearly in a debugger. */
+static inline void
+list_poison(struct list *list)
+{
+    memset(list, 0xcc, sizeof *list);
+}
+
+/* Inserts 'elem' just before 'before'. */
+static inline void
+list_insert(struct list *before, struct list *elem)
+{
+    elem->prev = before->prev;
+    elem->next = before;
+    before->prev->next = elem;
+    before->prev = elem;
+}
+
+/* Removes elements 'first' though 'last' (exclusive) from their current list,
+   then inserts them just before 'before'. */
+static inline void
+list_splice(struct list *before, struct list *first, struct list *last)
+{
+    if (first == last) {
+        return;
+    }
+    last = last->prev;
+
+    /* Cleanly remove 'first'...'last' from its current list. */
+    first->prev->next = last->next;
+    last->next->prev = first->prev;
+
+    /* Splice 'first'...'last' into new list. */
+    first->prev = before->prev;
+    last->next = before;
+    before->prev->next = first;
+    before->prev = last;
+}
+
+/* Inserts 'elem' at the beginning of 'list', so that it becomes the front in
+   'list'. */
+static inline void
+list_push_front(struct list *list, struct list *elem)
+{
+    list_insert(list->next, elem);
+}
+
+/* Inserts 'elem' at the end of 'list', so that it becomes the back in
+ * 'list'. */
+static inline void
+list_push_back(struct list *list, struct list *elem)
+{
+    list_insert(list, elem);
+}
+
+/* Puts 'elem' in the position currently occupied by 'position'.
+ * Afterward, 'position' is not part of a list. */
+static inline void
+list_replace(struct list *element, const struct list *position)
+{
+    element->next = position->next;
+    element->next->prev = element;
+    element->prev = position->prev;
+    element->prev->next = element;
+}
+
+/* Adjusts pointers around 'list' to compensate for 'list' having been moved
+ * around in memory (e.g. as a consequence of realloc()).
+ *
+ * This always works if 'list' is a member of a list, or if 'list' is the head
+ * of a non-empty list.  It fails badly, however, if 'list' is the head of an
+ * empty list; just use list_init() in that case. */
+static inline void
+list_moved(struct list *list)
+{
+    list->prev->next = list->next->prev = list;
+}
+
+/* Initializes 'dst' with the contents of 'src', compensating for moving it
+ * around in memory.  The effect is that, if 'src' was the head of a list, now
+ * 'dst' is the head of a list containing the same elements. */
+static inline void
+list_move(struct list *dst, struct list *src)
+{
+    if (!list_is_empty(src)) {
+        *dst = *src;
+        list_moved(dst);
+    } else {
+        list_init(dst);
+    }
+}
+
+/* Removes 'elem' from its list and returns the element that followed it.
+   Undefined behavior if 'elem' is not in a list. */
+static inline struct list *
+list_remove(struct list *elem)
+{
+    elem->prev->next = elem->next;
+    elem->next->prev = elem->prev;
+    return elem->next;
+}
+
+/* Removes the front element from 'list' and returns it.  Undefined behavior if
+   'list' is empty before removal. */
+static inline struct list *
+list_pop_front(struct list *list)
+{
+    struct list *front = list->next;
+
+    list_remove(front);
+    return front;
+}
+
+/* Removes the back element from 'list' and returns it.
+   Undefined behavior if 'list' is empty before removal. */
+static inline struct list *
+list_pop_back(struct list *list)
+{
+    struct list *back = list->prev;
+
+    list_remove(back);
+    return back;
+}
+
+/* Returns the front element in 'list_'.
+   Undefined behavior if 'list_' is empty. */
+static inline struct list *
+list_front(const struct list *list_)
+{
+    struct list *list = CONST_CAST(struct list *, list_);
+
+    ovs_assert(!list_is_empty(list));
+
+    return list->next;
+}
+
+/* Returns the back element in 'list_'.
+   Undefined behavior if 'list_' is empty. */
+static inline struct list *
+list_back(const struct list *list_)
+{
+    struct list *list = CONST_CAST(struct list *, list_);
+
+    ovs_assert(!list_is_empty(list));
+
+    return list->prev;
+}
+
+/* Returns the number of elements in 'list'.
+   Runs in O(n) in the number of elements. */
+static inline size_t
+list_size(const struct list *list)
+{
+    const struct list *e;
+    size_t cnt = 0;
+
+    for (e = list->next; e != list; e = e->next) {
+        cnt++;
+    }
+    return cnt;
+}
+
+/* Returns true if 'list' is empty, false otherwise. */
+static inline bool
+list_is_empty(const struct list *list)
+{
+    return list->next == list;
+}
+
+/* Returns true if 'list' has exactly 1 element, false otherwise. */
+static inline bool
+list_is_singleton(const struct list *list)
+{
+    return list_is_short(list) && !list_is_empty(list);
+}
+
+/* Returns true if 'list' has 0 or 1 elements, false otherwise. */
+static inline bool
+list_is_short(const struct list *list)
+{
+    return list->next == list->prev;
+}
 
 #endif /* list.h */