rculist.h and list.h style cleanup

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/urcu/list.h b/urcu/list.h
index 1d1c7b5ce2882b6bd0e13b53b096c081dbcb1b44..b4962b445dfbc766ee229923b0af97f0f16beadf 100644 (file)
--- a/urcu/list.h
+++ b/urcu/list.h
@@ -25,86 +25,81 @@
 #ifndef _CDS_LIST_H
 #define _CDS_LIST_H    1
 
-/* The definitions of this file are adopted from those which can be
-   found in the Linux kernel headers to enable people familiar with
-   the latter find their way in these sources as well.  */
-
+/*
+ * The definitions of this file are adopted from those which can be
+ * found in the Linux kernel headers to enable people familiar with the
+ * latter find their way in these sources as well.
+ */
 
-/* Basic type for the double-link list.  */
-struct cds_list_head
-{
-  struct cds_list_head *next;
-  struct cds_list_head *prev;
+/* Basic type for the double-link list. */
+struct cds_list_head {
+       struct cds_list_head *next, *prev;
 };
 
-
-/* Define a variable with the head and tail of the list.  */
+/* Define a variable with the head and tail of the list. */
 #define CDS_LIST_HEAD(name) \
-  struct cds_list_head name = { &(name), &(name) }
+       struct cds_list_head name = { &(name), &(name) }
 
-/* Initialize a new list head.  */
+/* Initialize a new list head. */
 #define CDS_INIT_LIST_HEAD(ptr) \
-  (ptr)->next = (ptr)->prev = (ptr)
+       (ptr)->next = (ptr)->prev = (ptr)
 
 #define CDS_LIST_HEAD_INIT(name) { .prev = &(name), .next = &(name) }
 
-/* Add new element at the head of the list.  */
-static inline void
-cds_list_add (struct cds_list_head *newp, struct cds_list_head *head)
+/* Add new element at the head of the list. */
+static inline
+void cds_list_add(struct cds_list_head *newp, struct cds_list_head *head)
 {
-  head->next->prev = newp;
-  newp->next = head->next;
-  newp->prev = head;
-  head->next = newp;
+       head->next->prev = newp;
+       newp->next = head->next;
+       newp->prev = head;
+       head->next = newp;
 }
 
-
-/* Add new element at the tail of the list.  */
-static inline void
-cds_list_add_tail (struct cds_list_head *newp, struct cds_list_head *head)
+/* Add new element at the tail of the list. */
+static inline
+void cds_list_add_tail(struct cds_list_head *newp, struct cds_list_head *head)
 {
-  head->prev->next = newp;
-  newp->next = head;
-  newp->prev = head->prev;
-  head->prev = newp;
+       head->prev->next = newp;
+       newp->next = head;
+       newp->prev = head->prev;
+       head->prev = newp;
 }
 
-
-/* Remove element from list.  */
-static inline void
-__cds_list_del (struct cds_list_head *prev, struct cds_list_head *next)
+/* Remove element from list. */
+static inline
+void __cds_list_del(struct cds_list_head *prev, struct cds_list_head *next)
 {
-  next->prev = prev;
-  prev->next = next;
+       next->prev = prev;
+       prev->next = next;
 }
 
-/* Remove element from list.  */
-static inline void
-cds_list_del (struct cds_list_head *elem)
+/* Remove element from list. */
+static inline
+void cds_list_del(struct cds_list_head *elem)
 {
-  __cds_list_del (elem->prev, elem->next);
+       __cds_list_del(elem->prev, elem->next);
 }
 
 /* Remove element from list, initializing the element's list pointers. */
-static inline void
-cds_list_del_init (struct cds_list_head *elem)
+static inline
+void cds_list_del_init(struct cds_list_head *elem)
 {
        cds_list_del(elem);
        CDS_INIT_LIST_HEAD(elem);
 }
 
-/* delete from list, add to another list as head */
-static inline void
-cds_list_move (struct cds_list_head *elem, struct cds_list_head *head)
+/* Delete from list, add to another list as head. */
+static inline
+void cds_list_move(struct cds_list_head *elem, struct cds_list_head *head)
 {
-  __cds_list_del (elem->prev, elem->next);
-  cds_list_add (elem, head);
+       __cds_list_del(elem->prev, elem->next);
+       cds_list_add(elem, head);
 }
 
-/* replace an old entry.
- */
-static inline void
-cds_list_replace(struct cds_list_head *old, struct cds_list_head *_new)
+/* Replace an old entry. */
+static inline
+void cds_list_replace(struct cds_list_head *old, struct cds_list_head *_new)
 {
        _new->next = old->next;
        _new->prev = old->prev;
@@ -112,77 +107,82 @@ cds_list_replace(struct cds_list_head *old, struct cds_list_head *_new)
        _new->next->prev = _new;
 }
 
-/* Join two lists.  */
-static inline void
-cds_list_splice (struct cds_list_head *add, struct cds_list_head *head)
+/* Join two lists. */
+static inline
+void cds_list_splice(struct cds_list_head *add, struct cds_list_head *head)
 {
-  /* Do nothing if the list which gets added is empty.  */
-  if (add != add->next)
-    {
-      add->next->prev = head;
-      add->prev->next = head->next;
-      head->next->prev = add->prev;
-      head->next = add->next;
-    }
+       /* Do nothing if the list which gets added is empty. */
+       if (add != add->next) {
+               add->next->prev = head;
+               add->prev->next = head->next;
+               head->next->prev = add->prev;
+               head->next = add->next;
+       }
 }
 
-/* Get typed element from list at a given position.  */
+/* Get typed element from list at a given position. */
 #define cds_list_entry(ptr, type, member) \
-  ((type *) ((char *) (ptr) - (unsigned long) (&((type *) 0)->member)))
+       ((type *) ((char *) (ptr) - (unsigned long) (&((type *) 0)->member)))
 
 
 /* Get first entry from a list. */
 #define cds_list_first_entry(ptr, type, member) \
        cds_list_entry((ptr)->next, type, member)
 
-
-/* Iterate forward over the elements of the list.  */
+/* Iterate forward over the elements of the list. */
 #define cds_list_for_each(pos, head) \
-  for (pos = (head)->next; pos != (head); pos = pos->next)
+       for (pos = (head)->next; pos != (head); pos = pos->next)
 
-/* Iterate forward over the elements list. The list elements can be
-   removed from the list while doing this.  */
+/*
+ * Iterate forward over the elements list. The list elements can be
+ * removed from the list while doing this.
+ */
 #define cds_list_for_each_safe(pos, p, head) \
-  for (pos = (head)->next, p = pos->next; \
-       pos != (head); \
-       pos = p, p = pos->next)
+       for (pos = (head)->next, p = pos->next; \
+               pos != (head); \
+               pos = p, p = pos->next)
 
-/* Iterate backward over the elements of the list.  */
+/* Iterate backward over the elements of the list. */
 #define cds_list_for_each_prev(pos, head) \
-  for (pos = (head)->prev; pos != (head); pos = pos->prev)
+       for (pos = (head)->prev; pos != (head); pos = pos->prev)
 
-/* Iterate backwards over the elements list.  The list elements can be
-   removed from the list while doing this.  */
+/*
+ * Iterate backwards over the elements list. The list elements can be
+ * removed from the list while doing this.
+ */
 #define cds_list_for_each_prev_safe(pos, p, head) \
-  for (pos = (head)->prev, p = pos->prev; \
-       pos != (head); \
-       pos = p, p = pos->prev)
+       for (pos = (head)->prev, p = pos->prev; \
+               pos != (head); \
+               pos = p, p = pos->prev)
 
-#define cds_list_for_each_entry(pos, head, member)                             \
+#define cds_list_for_each_entry(pos, head, member) \
        for (pos = cds_list_entry((head)->next, __typeof__(*pos), member); \
-            &pos->member != (head);                                    \
-            pos = cds_list_entry(pos->member.next, __typeof__(*pos), member))
+               &pos->member != (head); \
+               pos = cds_list_entry(pos->member.next, __typeof__(*pos), member))
 
-#define cds_list_for_each_entry_reverse(pos, head, member)                     \
+#define cds_list_for_each_entry_reverse(pos, head, member) \
        for (pos = cds_list_entry((head)->prev, __typeof__(*pos), member); \
-            &pos->member != (head);                                    \
-            pos = cds_list_entry(pos->member.prev, __typeof__(*pos), member))
+               &pos->member != (head); \
+               pos = cds_list_entry(pos->member.prev, __typeof__(*pos), member))
 
-#define cds_list_for_each_entry_safe(pos, p, head, member)                     \
+#define cds_list_for_each_entry_safe(pos, p, head, member) \
        for (pos = cds_list_entry((head)->next, __typeof__(*pos), member), \
-                    p = cds_list_entry(pos->member.next, __typeof__(*pos), member); \
-            &pos->member != (head);                                    \
-            pos = p, p = cds_list_entry(pos->member.next, __typeof__(*pos), member))
+                       p = cds_list_entry(pos->member.next, __typeof__(*pos), member); \
+               &pos->member != (head); \
+               pos = p, p = cds_list_entry(pos->member.next, __typeof__(*pos), member))
 
-static inline int cds_list_empty(struct cds_list_head *head)
+static inline
+int cds_list_empty(struct cds_list_head *head)
 {
        return head == head->next;
 }
 
-static inline void cds_list_replace_init(struct cds_list_head *old,
-                                    struct cds_list_head *_new)
+static inline
+void cds_list_replace_init(struct cds_list_head *old,
+               struct cds_list_head *_new)
 {
        struct cds_list_head *head = old->next;
+
        cds_list_del(old);
        cds_list_add_tail(_new, head);
        CDS_INIT_LIST_HEAD(old);

diff --git a/urcu/rculist.h b/urcu/rculist.h
index 3604a96d0619d082ef7c3c2d46a4cff421c04c2e..a177f20dbf67edab2e666051b7682700def6d7db 100644 (file)
--- a/urcu/rculist.h
+++ b/urcu/rculist.h
@@ -29,9 +29,9 @@
 #include <urcu/arch.h>
 #include <urcu-pointer.h>
 
-/* Add new element at the head of the list.
- */
-static inline void cds_list_add_rcu(struct cds_list_head *newp, struct cds_list_head *head)
+/* Add new element at the head of the list. */
+static inline
+void cds_list_add_rcu(struct cds_list_head *newp, struct cds_list_head *head)
 {
        newp->next = head->next;
        newp->prev = head;
@@ -40,9 +40,13 @@ static inline void cds_list_add_rcu(struct cds_list_head *newp, struct cds_list_
        head->next = newp;
 }
 
-/* replace an old entry atomically.
+/*
+ * Replace an old entry atomically with respect to concurrent RCU
+ * traversal. Mutual exclusion against concurrent updates is required
+ * though.
  */
-static inline void cds_list_replace_rcu(struct cds_list_head *old, struct cds_list_head *_new)
+static inline
+void cds_list_replace_rcu(struct cds_list_head *old, struct cds_list_head *_new)
 {
        _new->next = old->next;
        _new->prev = old->prev;
@@ -51,7 +55,8 @@ static inline void cds_list_replace_rcu(struct cds_list_head *old, struct cds_li
 }
 
 /* Remove element from list. */
-static inline void cds_list_del_rcu(struct cds_list_head *elem)
+static inline
+void cds_list_del_rcu(struct cds_list_head *elem)
 {
        elem->next->prev = elem->prev;
        elem->prev->next = elem->next;
@@ -64,15 +69,14 @@ static inline void cds_list_del_rcu(struct cds_list_head *elem)
 
 /* Iterate forward over the elements of the list.  */
 #define cds_list_for_each_rcu(pos, head) \
-  for (pos = rcu_dereference((head)->next); pos != (head); \
-       pos = rcu_dereference(pos->next))
+       for (pos = rcu_dereference((head)->next); pos != (head); \
+               pos = rcu_dereference(pos->next))
 
 
-/* Iterate through elements of the list.
- */
-#define cds_list_for_each_entry_rcu(pos, head, member)                         \
-       for (pos = cds_list_entry(rcu_dereference((head)->next), __typeof__(*pos), member);     \
-            &pos->member != (head);                                    \
-            pos = cds_list_entry(rcu_dereference(pos->member.next), __typeof__(*pos), member))
+/* Iterate through elements of the list. */
+#define cds_list_for_each_entry_rcu(pos, head, member) \
+       for (pos = cds_list_entry(rcu_dereference((head)->next), __typeof__(*pos), member); \
+               &pos->member != (head); \
+               pos = cds_list_entry(rcu_dereference(pos->member.next), __typeof__(*pos), member))
 
 #endif /* _URCU_RCULIST_H */