Whamcloud - gitweb
LU-5577 libcfs: fix warnings in libcfs/curproc.h
[fs/lustre-release.git] / libcfs / include / libcfs / list.h
index 1060dcb..f73ce98 100644 (file)
@@ -1,22 +1,31 @@
+/*
+ * GPL HEADER START
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 only,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License version 2 for more details.  A copy is
+ * included in the COPYING file that accompanied this code.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ * GPL HEADER END
+ */
+
 #ifndef __LIBCFS_LIST_H__
 #define __LIBCFS_LIST_H__
 
-#if defined (__linux__) && defined(__KERNEL__)
-
-#include <linux/list.h>
-
-#define CFS_LIST_HEAD_INIT(n)          LIST_HEAD_INIT(n)
-#define CFS_LIST_HEAD(n)               LIST_HEAD(n)
-#define CFS_INIT_LIST_HEAD(p)          INIT_LIST_HEAD(p)
-
-#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,0)
-#define CFS_HLIST_HEAD_INIT            HLIST_HEAD_INIT
-#define CFS_HLIST_HEAD(n)              HLIST_HEAD(n)
-#define CFS_INIT_HLIST_HEAD(p)         INIT_HLIST_HEAD(p)
-#define CFS_INIT_HLIST_NODE(p)         INIT_HLIST_NODE(p)
-#endif
-
-#else /* !defined (__linux__) || !defined(__KERNEL__) */
+#ifdef __KERNEL__
+# include <linux/list.h>
+#else /* __KERNEL__ */
 
 /*
  * Simple doubly linked list implementation.
@@ -34,14 +43,9 @@ struct list_head {
        struct list_head *next, *prev;
 };
 
-typedef struct list_head list_t;
+#define LIST_HEAD_INIT(name) { &(name), &(name) }
 
-#define CFS_LIST_HEAD_INIT(name) { &(name), &(name) }
-
-#define CFS_LIST_HEAD(name) \
-       struct list_head name = CFS_LIST_HEAD_INIT(name)
-
-#define CFS_INIT_LIST_HEAD(ptr) do { \
+#define INIT_LIST_HEAD(ptr) do { \
        (ptr)->next = (ptr); (ptr)->prev = (ptr); \
 } while (0)
 
@@ -52,8 +56,8 @@ typedef struct list_head list_t;
  * the prev/next entries already!
  */
 static inline void __list_add(struct list_head * new,
-                             struct list_head * prev,
-                             struct list_head * next)
+                                 struct list_head * prev,
+                                 struct list_head * next)
 {
        next->prev = new;
        new->next = next;
@@ -69,7 +73,8 @@ static inline void __list_add(struct list_head * new,
  * Insert a new entry after the specified head.
  * This is good for implementing stacks.
  */
-static inline void list_add(struct list_head *new, struct list_head *head)
+static inline void list_add(struct list_head *new,
+                               struct list_head *head)
 {
        __list_add(new, head, head->next);
 }
@@ -82,7 +87,8 @@ static inline void list_add(struct list_head *new, struct list_head *head)
  * Insert a new entry before the specified head.
  * This is useful for implementing queues.
  */
-static inline void list_add_tail(struct list_head *new, struct list_head *head)
+static inline void list_add_tail(struct list_head *new,
+                                    struct list_head *head)
 {
        __list_add(new, head->prev, head);
 }
@@ -94,7 +100,8 @@ static inline void list_add_tail(struct list_head *new, struct list_head *head)
  * This is only for internal list manipulation where we know
  * the prev/next entries already!
  */
-static inline void __list_del(struct list_head * prev, struct list_head * next)
+static inline void __list_del(struct list_head *prev,
+                                 struct list_head *next)
 {
        next->prev = prev;
        prev->next = next;
@@ -103,7 +110,8 @@ static inline void __list_del(struct list_head * prev, struct list_head * next)
 /**
  * Remove an entry from the list it is currently in.
  * \param entry the entry to remove
- * Note: list_empty(entry) does not return true after this, the entry is in an undefined state.
+ * Note: list_empty(entry) does not return true after this, the entry is in an
+ * undefined state.
  */
 static inline void list_del(struct list_head *entry)
 {
@@ -117,27 +125,30 @@ static inline void list_del(struct list_head *entry)
 static inline void list_del_init(struct list_head *entry)
 {
        __list_del(entry->prev, entry->next);
-       CFS_INIT_LIST_HEAD(entry);
+       INIT_LIST_HEAD(entry);
 }
 
 /**
- * Remove an entry from the list it is currently in and insert it at the start of another list.
+ * Remove an entry from the list it is currently in and insert it at the start
+ * of another list.
  * \param list the entry to move
  * \param head the list to move it to
  */
-static inline void list_move(struct list_head *list, struct list_head *head)
+static inline void list_move(struct list_head *list,
+                                struct list_head *head)
 {
        __list_del(list->prev, list->next);
        list_add(list, head);
 }
 
 /**
- * Remove an entry from the list it is currently in and insert it at the end of another list.
+ * Remove an entry from the list it is currently in and insert it at the end of
+ * another list.
  * \param list the entry to move
  * \param head the list to move it to
  */
 static inline void list_move_tail(struct list_head *list,
-                                 struct list_head *head)
+                                     struct list_head *head)
 {
        __list_del(list->prev, list->next);
        list_add_tail(list, head);
@@ -166,12 +177,12 @@ static inline int list_empty(struct list_head *head)
  */
 static inline int list_empty_careful(const struct list_head *head)
 {
-        struct list_head *next = head->next;
-        return (next == head) && (next == head->prev);
+       struct list_head *next = head->next;
+       return (next == head) && (next == head->prev);
 }
 
 static inline void __list_splice(struct list_head *list,
-                                struct list_head *head)
+                                    struct list_head *head)
 {
        struct list_head *first = list->next;
        struct list_head *last = list->prev;
@@ -192,12 +203,19 @@ static inline void __list_splice(struct list_head *list,
  * The contents of \a list are added at the start of \a head.  \a list is in an
  * undefined state on return.
  */
-static inline void list_splice(struct list_head *list, struct list_head *head)
+static inline void list_splice(struct list_head *list,
+                                  struct list_head *head)
 {
        if (!list_empty(list))
                __list_splice(list, head);
 }
 
+static inline void list_splice_tail(struct list_head *list, struct list_head *head)
+{
+       if (!list_empty(list))
+               __list_splice(list, head->prev);
+}
+
 /**
  * Join two lists and reinitialise the emptied list.
  * \param list the new list to add.
@@ -207,16 +225,16 @@ static inline void list_splice(struct list_head *list, struct list_head *head)
  * on return.
  */
 static inline void list_splice_init(struct list_head *list,
-                                   struct list_head *head)
+                                       struct list_head *head)
 {
        if (!list_empty(list)) {
                __list_splice(list, head);
-               CFS_INIT_LIST_HEAD(list);
+               INIT_LIST_HEAD(list);
        }
 }
 
 /**
- * Get the container of a list 
+ * Get the container of a list
  * \param ptr   the embedded list.
  * \param type  the type of the struct this is embedded in.
  * \param member the member name of the list within the struct.
@@ -228,7 +246,7 @@ static inline void list_splice_init(struct list_head *list,
  * Iterate over a list
  * \param pos  the iterator
  * \param head the list to iterate over
- * 
+ *
  * Behaviour is undefined if \a pos is removed from the list in the body of the
  * loop.
  */
@@ -237,7 +255,7 @@ static inline void list_splice_init(struct list_head *list,
                pos = pos->next, prefetch(pos->next))
 
 /**
- * iterate over a list safely
+ * Iterate over a list safely
  * \param pos  the iterator
  * \param n     temporary storage
  * \param head the list to iterate over
@@ -250,6 +268,17 @@ static inline void list_splice_init(struct list_head *list,
                pos = n, n = pos->next)
 
 /**
+ * Iterate over a list continuing after existing point
+ * \param pos    the type * to use as a loop counter
+ * \param head   the list head
+ * \param member the name of the list_struct within the struct
+ */
+#define list_for_each_entry_continue(pos, head, member)                 \
+       for (pos = list_entry(pos->member.next, typeof(*pos), member);  \
+            prefetch(pos->member.next), &pos->member != (head);        \
+            pos = list_entry(pos->member.next, typeof(*pos), member))
+
+/**
  * \defgroup hlist Hash List
  * Double linked lists with a single pointer list head.
  * Mostly useful for hash tables where the two pointer list head is too
@@ -257,14 +286,14 @@ static inline void list_splice_init(struct list_head *list,
  * @{
  */
 
-struct hlist_head {
-       struct hlist_node *first;
-};
-
 struct hlist_node {
        struct hlist_node *next, **pprev;
 };
 
+struct hlist_head {
+       struct hlist_node *first;
+};
+
 /* @} */
 
 /*
@@ -281,15 +310,10 @@ struct hlist_node {
  * @{
  */
 
-#define CFS_HLIST_HEAD_INIT { NULL_P }
-#define CFS_HLIST_HEAD(name) struct hlist_head name = { NULL_P }
-#define CFS_INIT_HLIST_HEAD(ptr) ((ptr)->first = NULL_P)
-#define CFS_INIT_HLIST_NODE(ptr) ((ptr)->next = NULL_P, (ptr)->pprev = NULL_P)
-
-#define HLIST_HEAD_INIT                CFS_HLIST_HEAD_INIT
-#define HLIST_HEAD(n)          CFS_HLIST_HEAD(n)
-#define INIT_HLIST_HEAD(p)     CFS_INIT_HLIST_HEAD(p)
-#define INIT_HLIST_NODE(p)     CFS_INIT_HLIST_NODE(p)
+#define HLIST_HEAD_INIT { NULL_P }
+#define HLIST_HEAD(name) struct hlist_head name = { NULL_P }
+#define INIT_HLIST_HEAD(ptr) ((ptr)->first = NULL_P)
+#define INIT_HLIST_NODE(ptr) ((ptr)->next = NULL_P, (ptr)->pprev = NULL_P)
 
 static inline int hlist_unhashed(const struct hlist_node *h)
 {
@@ -323,7 +347,8 @@ static inline void hlist_del_init(struct hlist_node *n)
        }
 }
 
-static inline void hlist_add_head(struct hlist_node *n, struct hlist_head *h)
+static inline void hlist_add_head(struct hlist_node *n,
+                                     struct hlist_head *h)
 {
        struct hlist_node *first = h->first;
        n->next = first;
@@ -344,7 +369,7 @@ static inline void hlist_add_before(struct hlist_node *n,
 }
 
 static inline void hlist_add_after(struct hlist_node *n,
-                                       struct hlist_node *next)
+                                      struct hlist_node *next)
 {
        next->next = n->next;
        n->next = next;
@@ -371,9 +396,9 @@ static inline void hlist_add_after(struct hlist_node *n,
  * \param head  the head for your list.
  * \param member the name of the hlist_node within the struct.
  */
-#define hlist_for_each_entry(tpos, pos, head, member)                   \
-       for (pos = (head)->first;                                        \
-            pos && ({ prefetch(pos->next); 1;}) &&                      \
+#define hlist_for_each_entry(tpos, pos, head, member)                    \
+       for (pos = (head)->first;                                            \
+            pos && ({ prefetch(pos->next); 1;}) &&                          \
                ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
             pos = pos->next)
 
@@ -383,9 +408,9 @@ static inline void hlist_add_after(struct hlist_node *n,
  * \param pos   the &struct hlist_node to use as a loop counter.
  * \param member the name of the hlist_node within the struct.
  */
-#define hlist_for_each_entry_continue(tpos, pos, member)                \
-       for (pos = (pos)->next;                                          \
-            pos && ({ prefetch(pos->next); 1;}) &&                      \
+#define hlist_for_each_entry_continue(tpos, pos, member)                 \
+       for (pos = (pos)->next;                                              \
+            pos && ({ prefetch(pos->next); 1;}) &&                          \
                ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
             pos = pos->next)
 
@@ -396,7 +421,7 @@ static inline void hlist_add_after(struct hlist_node *n,
  * \param member the name of the hlist_node within the struct.
  */
 #define hlist_for_each_entry_from(tpos, pos, member)                    \
-       for (; pos && ({ prefetch(pos->next); 1;}) &&                    \
+       for (; pos && ({ prefetch(pos->next); 1;}) &&                        \
                ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
             pos = pos->next)
 
@@ -408,17 +433,14 @@ static inline void hlist_add_after(struct hlist_node *n,
  * \param head  the head for your list.
  * \param member the name of the hlist_node within the struct.
  */
-#define hlist_for_each_entry_safe(tpos, pos, n, head, member)           \
-       for (pos = (head)->first;                                        \
-            pos && ({ n = pos->next; 1; }) &&                           \
+#define hlist_for_each_entry_safe(tpos, pos, n, head, member)            \
+       for (pos = (head)->first;                                            \
+            pos && ({ n = pos->next; 1; }) &&                               \
                ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
             pos = n)
 
 /* @} */
 
-#endif /* __linux__ && __KERNEL__ */
-
-#ifndef list_for_each_prev
 /**
  * Iterate over a list in reverse order
  * \param pos  the &struct list_head to use as a loop counter.
@@ -428,24 +450,19 @@ static inline void hlist_add_after(struct hlist_node *n,
        for (pos = (head)->prev, prefetch(pos->prev); pos != (head);     \
                pos = pos->prev, prefetch(pos->prev))
 
-#endif /* list_for_each_prev */
-
-#ifndef list_for_each_entry
 /**
  * Iterate over a list of given type
  * \param pos        the type * to use as a loop counter.
  * \param head       the head for your list.
  * \param member     the name of the list_struct within the struct.
  */
-#define list_for_each_entry(pos, head, member)                         \
-        for (pos = list_entry((head)->next, typeof(*pos), member),     \
-                    prefetch(pos->member.next);                        \
-            &pos->member != (head);                                    \
-            pos = list_entry(pos->member.next, typeof(*pos), member),  \
+#define list_for_each_entry(pos, head, member)                          \
+       for (pos = list_entry((head)->next, typeof(*pos), member),      \
+                    prefetch(pos->member.next);                            \
+            &pos->member != (head);                                        \
+            pos = list_entry(pos->member.next, typeof(*pos), member),  \
             prefetch(pos->member.next))
-#endif /* list_for_each_entry */
 
-#ifndef list_for_each_entry_reverse
 /**
  * Iterate backwards over a list of given type.
  * \param pos        the type * to use as a loop counter.
@@ -454,11 +471,9 @@ static inline void hlist_add_after(struct hlist_node *n,
  */
 #define list_for_each_entry_reverse(pos, head, member)                  \
        for (pos = list_entry((head)->prev, typeof(*pos), member);      \
-            prefetch(pos->member.prev), &pos->member != (head);        \
+            prefetch(pos->member.prev), &pos->member != (head);            \
             pos = list_entry(pos->member.prev, typeof(*pos), member))
-#endif /* list_for_each_entry_reverse */
 
-#ifndef list_for_each_entry_safe
 /**
  * Iterate over a list of given type safe against removal of list entry
  * \param pos        the type * to use as a loop counter.
@@ -466,63 +481,32 @@ static inline void hlist_add_after(struct hlist_node *n,
  * \param head       the head for your list.
  * \param member     the name of the list_struct within the struct.
  */
-#define list_for_each_entry_safe(pos, n, head, member)                 \
-        for (pos = list_entry((head)->next, typeof(*pos), member),     \
-               n = list_entry(pos->member.next, typeof(*pos), member); \
-            &pos->member != (head);                                    \
+#define list_for_each_entry_safe(pos, n, head, member)                   \
+       for (pos = list_entry((head)->next, typeof(*pos), member),       \
+               n = list_entry(pos->member.next, typeof(*pos), member);  \
+            &pos->member != (head);                                         \
             pos = n, n = list_entry(n->member.next, typeof(*n), member))
 
-#endif /* list_for_each_entry_safe */
-
-#ifndef list_for_each_entry_safe_from
-/**
- * Iterate over a list continuing from an existing point
- * \param pos        the type * to use as a loop cursor.
- * \param n          another type * to use as temporary storage
- * \param head       the head for your list.
- * \param member     the name of the list_struct within the struct.
- *
- * Iterate over list of given type from current point, safe against
- * removal of list entry.
- */
-#define list_for_each_entry_safe_from(pos, n, head, member)             \
-        for (n = list_entry(pos->member.next, typeof(*pos), member);    \
-             &pos->member != (head);                                    \
-             pos = n, n = list_entry(n->member.next, typeof(*n), member))
-#endif /* list_for_each_entry_safe_from */
-
-#define cfs_list_for_each_entry_typed(pos, head, type, member)         \
-        for (pos = list_entry((head)->next, type, member),             \
-                    prefetch(pos->member.next);                        \
-            &pos->member != (head);                                    \
-            pos = list_entry(pos->member.next, type, member),          \
-            prefetch(pos->member.next))
-
-#define cfs_list_for_each_entry_reverse_typed(pos, head, type, member) \
-       for (pos = list_entry((head)->prev, type, member);              \
-            prefetch(pos->member.prev), &pos->member != (head);        \
-            pos = list_entry(pos->member.prev, type, member))
-
-#define cfs_list_for_each_entry_safe_typed(pos, n, head, type, member) \
-    for (pos = list_entry((head)->next, type, member),                 \
-               n = list_entry(pos->member.next, type, member);         \
-            &pos->member != (head);                                    \
-            pos = n, n = list_entry(n->member.next, type, member))
-
-#define cfs_list_for_each_entry_safe_from_typed(pos, n, head, type, member)   \
-        for (n = list_entry(pos->member.next, type, member);            \
-             &pos->member != (head);                                    \
-             pos = n, n = list_entry(n->member.next, type, member))
-#define cfs_hlist_for_each_entry_typed(tpos, pos, head, type, member)   \
-       for (pos = (head)->first;                                       \
-            pos && (prefetch(pos->next), 1) &&                         \
-               (tpos = hlist_entry(pos, type, member), 1);             \
-            pos = pos->next)
-
-#define cfs_hlist_for_each_entry_safe_typed(tpos, pos, n, head, type, member)\
-       for (pos = (head)->first;                                       \
-            pos && (n = pos->next, 1) &&                               \
-               (tpos = hlist_entry(pos, type, member), 1);             \
-            pos = n)
+#endif /* __KERNEL__ */
+
+#ifdef HAVE_HLIST_FOR_EACH_3ARG
+#define cfs_hlist_for_each_entry(tpos, pos, head, member) \
+       hlist_for_each_entry(tpos, head, member)
+#define cfs_hlist_for_each_entry_safe(tpos, pos, n, head, member) \
+       hlist_for_each_entry_safe(tpos, n, head, member)
+#define cfs_hlist_for_each_entry_continue(tpos, pos, member) \
+       hlist_for_each_entry_continue(tpos, member)
+#define cfs_hlist_for_each_entry_from(tpos, pos, member) \
+       hlist_for_each_entry_from(tpos, member)
+#else
+#define cfs_hlist_for_each_entry(tpos, pos, head, member) \
+       hlist_for_each_entry(tpos, pos, head, member)
+#define cfs_hlist_for_each_entry_safe(tpos, pos, n, head, member) \
+       hlist_for_each_entry_safe(tpos, pos, n, head, member)
+#define cfs_hlist_for_each_entry_continue(tpos, pos, member) \
+       hlist_for_each_entry_continue(tpos, pos, member)
+#define cfs_hlist_for_each_entry_from(tpos, pos, member) \
+       hlist_for_each_entry_from(tpos, pos, member)
+#endif
 
 #endif /* __LIBCFS_LUSTRE_LIST_H__ */