Revert to Fedora kernel-2.6.17-1.2187_FC5 patched with vs2.0.2.1; there are too many...
[linux-2.6.git] / include / linux / list.h
index a9c9028..e43989c 100644 (file)
@@ -4,9 +4,18 @@
 #ifdef __KERNEL__
 
 #include <linux/stddef.h>
-#include <linux/poison.h>
 #include <linux/prefetch.h>
+#include <linux/kernel.h>
 #include <asm/system.h>
+#include <asm/bug.h>
+
+/*
+ * These are non-NULL pointers that will result in page faults
+ * under normal circumstances, used to verify that nobody uses
+ * non-initialized list entries.
+ */
+#define LIST_POISON1  ((void *) 0x00100100)
+#define LIST_POISON2  ((void *) 0x00200200)
 
 /*
  * Simple doubly linked list implementation.
@@ -39,21 +48,25 @@ static inline void INIT_LIST_HEAD(struct list_head *list)
  * This is only for internal list manipulation where we know
  * the prev/next entries already!
  */
-#ifndef CONFIG_DEBUG_LIST
 static inline void __list_add(struct list_head *new,
                              struct list_head *prev,
                              struct list_head *next)
 {
+       if (next->prev != prev) {
+               printk("List corruption. next->prev should be %p, but was %p\n",
+                               prev, next->prev);
+               BUG();
+       }
+       if (prev->next != next) {
+               printk("List corruption. prev->next should be %p, but was %p\n",
+                               next, prev->next);
+               BUG();
+       }
        next->prev = new;
        new->next = next;
        new->prev = prev;
        prev->next = new;
 }
-#else
-extern void __list_add(struct list_head *new,
-                             struct list_head *prev,
-                             struct list_head *next);
-#endif
 
 /**
  * list_add - add a new entry
@@ -63,15 +76,10 @@ extern void __list_add(struct list_head *new,
  * Insert a new entry after the specified head.
  * This is good for implementing stacks.
  */
-#ifndef CONFIG_DEBUG_LIST
 static inline void list_add(struct list_head *new, struct list_head *head)
 {
        __list_add(new, head, head->next);
 }
-#else
-extern void list_add(struct list_head *new, struct list_head *head);
-#endif
-
 
 /**
  * list_add_tail - add a new entry
@@ -164,16 +172,22 @@ static inline void __list_del(struct list_head * prev, struct list_head * next)
  * Note: list_empty on entry does not return true after this, the entry is
  * in an undefined state.
  */
-#ifndef CONFIG_DEBUG_LIST
 static inline void list_del(struct list_head *entry)
 {
+       if (entry->prev->next != entry) {
+               printk("List corruption. prev->next should be %p, but was %p\n",
+                               entry, entry->prev->next);
+               BUG();
+       }
+       if (entry->next->prev != entry) {
+               printk("List corruption. next->prev should be %p, but was %p\n",
+                               entry, entry->next->prev);
+               BUG();
+       }
        __list_del(entry->prev, entry->next);
        entry->next = LIST_POISON1;
        entry->prev = LIST_POISON2;
 }
-#else
-extern void list_del(struct list_head *entry);
-#endif
 
 /**
  * list_del_rcu - deletes entry from list without re-initialization
@@ -205,35 +219,12 @@ static inline void list_del_rcu(struct list_head *entry)
        entry->prev = LIST_POISON2;
 }
 
-/**
- * list_replace - replace old entry by new one
- * @old : the element to be replaced
- * @new : the new element to insert
- * Note: if 'old' was empty, it will be overwritten.
- */
-static inline void list_replace(struct list_head *old,
-                               struct list_head *new)
-{
-       new->next = old->next;
-       new->next->prev = new;
-       new->prev = old->prev;
-       new->prev->next = new;
-}
-
-static inline void list_replace_init(struct list_head *old,
-                                       struct list_head *new)
-{
-       list_replace(old, new);
-       INIT_LIST_HEAD(old);
-}
-
 /*
  * list_replace_rcu - replace old entry by new one
  * @old : the element to be replaced
  * @new : the new element to insert
  *
  * The old entry will be replaced with the new entry atomically.
- * Note: 'old' should not be empty.
  */
 static inline void list_replace_rcu(struct list_head *old,
                                struct list_head *new)
@@ -279,17 +270,6 @@ static inline void list_move_tail(struct list_head *list,
         list_add_tail(list, head);
 }
 
-/**
- * list_is_last - tests whether @list is the last entry in list @head
- * @list: the entry to test
- * @head: the head of the list
- */
-static inline int list_is_last(const struct list_head *list,
-                               const struct list_head *head)
-{
-       return list->next == head;
-}
-
 /**
  * list_empty - tests whether a list is empty
  * @head: the list to test.
@@ -300,17 +280,16 @@ static inline int list_empty(const struct list_head *head)
 }
 
 /**
- * list_empty_careful - tests whether a list is empty and not being modified
- * @head: the list to test
- *
- * Description:
- * tests whether a list is empty _and_ checks that no other CPU might be
- * in the process of modifying either member (next or prev)
+ * list_empty_careful - tests whether a list is
+ * empty _and_ checks that no other CPU might be
+ * in the process of still modifying either member
  *
  * NOTE: using list_empty_careful() without synchronization
  * can only be safe if the only activity that can happen
  * to the list entry is list_del_init(). Eg. it cannot be used
  * if another CPU could re-list_add() it.
+ *
+ * @head: the list to test.
  */
 static inline int list_empty_careful(const struct list_head *head)
 {
@@ -370,7 +349,7 @@ static inline void list_splice_init(struct list_head *list,
 
 /**
  * list_for_each       -       iterate over a list
- * @pos:       the &struct list_head to use as a loop cursor.
+ * @pos:       the &struct list_head to use as a loop counter.
  * @head:      the head for your list.
  */
 #define list_for_each(pos, head) \
@@ -379,7 +358,7 @@ static inline void list_splice_init(struct list_head *list,
 
 /**
  * __list_for_each     -       iterate over a list
- * @pos:       the &struct list_head to use as a loop cursor.
+ * @pos:       the &struct list_head to use as a loop counter.
  * @head:      the head for your list.
  *
  * This variant differs from list_for_each() in that it's the
@@ -392,7 +371,7 @@ static inline void list_splice_init(struct list_head *list,
 
 /**
  * list_for_each_prev  -       iterate over a list backwards
- * @pos:       the &struct list_head to use as a loop cursor.
+ * @pos:       the &struct list_head to use as a loop counter.
  * @head:      the head for your list.
  */
 #define list_for_each_prev(pos, head) \
@@ -400,8 +379,8 @@ static inline void list_splice_init(struct list_head *list,
                pos = pos->prev)
 
 /**
- * list_for_each_safe - iterate over a list safe against removal of list entry
- * @pos:       the &struct list_head to use as a loop cursor.
+ * list_for_each_safe  -       iterate over a list safe against removal of list entry
+ * @pos:       the &struct list_head to use as a loop counter.
  * @n:         another &struct list_head to use as temporary storage
  * @head:      the head for your list.
  */
@@ -411,7 +390,7 @@ static inline void list_splice_init(struct list_head *list,
 
 /**
  * list_for_each_entry -       iterate over list of given type
- * @pos:       the type * to use as a loop cursor.
+ * @pos:       the type * to use as a loop counter.
  * @head:      the head for your list.
  * @member:    the name of the list_struct within the struct.
  */
@@ -422,7 +401,7 @@ static inline void list_splice_init(struct list_head *list,
 
 /**
  * list_for_each_entry_reverse - iterate backwards over list of given type.
- * @pos:       the type * to use as a loop cursor.
+ * @pos:       the type * to use as a loop counter.
  * @head:      the head for your list.
  * @member:    the name of the list_struct within the struct.
  */
@@ -432,24 +411,21 @@ static inline void list_splice_init(struct list_head *list,
             pos = list_entry(pos->member.prev, typeof(*pos), member))
 
 /**
- * list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue
+ * list_prepare_entry - prepare a pos entry for use as a start point in
+ *                     list_for_each_entry_continue
  * @pos:       the type * to use as a start point
  * @head:      the head of the list
  * @member:    the name of the list_struct within the struct.
- *
- * Prepares a pos entry for use as a start point in list_for_each_entry_continue.
  */
 #define list_prepare_entry(pos, head, member) \
        ((pos) ? : list_entry(head, typeof(*pos), member))
 
 /**
- * list_for_each_entry_continue - continue iteration over list of given type
- * @pos:       the type * to use as a loop cursor.
+ * list_for_each_entry_continue -      iterate over list of given type
+ *                     continuing after existing point
+ * @pos:       the type * to use as a loop counter.
  * @head:      the head for your list.
  * @member:    the name of the list_struct within the struct.
- *
- * Continue to iterate over list of given type, continuing after
- * the current position.
  */
 #define list_for_each_entry_continue(pos, head, member)                \
        for (pos = list_entry(pos->member.next, typeof(*pos), member);  \
@@ -457,12 +433,11 @@ static inline void list_splice_init(struct list_head *list,
             pos = list_entry(pos->member.next, typeof(*pos), member))
 
 /**
- * list_for_each_entry_from - iterate over list of given type from the current point
- * @pos:       the type * to use as a loop cursor.
+ * list_for_each_entry_from -  iterate over list of given type
+ *                     continuing from existing point
+ * @pos:       the type * to use as a loop counter.
  * @head:      the head for your list.
  * @member:    the name of the list_struct within the struct.
- *
- * Iterate over list of given type, continuing from current position.
  */
 #define list_for_each_entry_from(pos, head, member)                    \
        for (; prefetch(pos->member.next), &pos->member != (head);      \
@@ -470,7 +445,7 @@ static inline void list_splice_init(struct list_head *list,
 
 /**
  * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
- * @pos:       the type * to use as a loop cursor.
+ * @pos:       the type * to use as a loop counter.
  * @n:         another type * to use as temporary storage
  * @head:      the head for your list.
  * @member:    the name of the list_struct within the struct.
@@ -482,14 +457,12 @@ static inline void list_splice_init(struct list_head *list,
             pos = n, n = list_entry(n->member.next, typeof(*n), member))
 
 /**
- * list_for_each_entry_safe_continue
- * @pos:       the type * to use as a loop cursor.
+ * list_for_each_entry_safe_continue - iterate over list of given type
+ *                     continuing after existing point safe against removal of list entry
+ * @pos:       the type * to use as a loop counter.
  * @n:         another type * to use as temporary storage
  * @head:      the head for your list.
  * @member:    the name of the list_struct within the struct.
- *
- * Iterate over list of given type, continuing after current point,
- * safe against removal of list entry.
  */
 #define list_for_each_entry_safe_continue(pos, n, head, member)                \
        for (pos = list_entry(pos->member.next, typeof(*pos), member),          \
@@ -498,14 +471,12 @@ static inline void list_splice_init(struct list_head *list,
             pos = n, n = list_entry(n->member.next, typeof(*n), member))
 
 /**
- * list_for_each_entry_safe_from
- * @pos:       the type * to use as a loop cursor.
+ * list_for_each_entry_safe_from - iterate over list of given type
+ *                     from existing point safe against removal of list entry
+ * @pos:       the type * to use as a loop counter.
  * @n:         another type * to use as temporary storage
  * @head:      the head for your list.
  * @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);            \
@@ -513,14 +484,12 @@ static inline void list_splice_init(struct list_head *list,
             pos = n, n = list_entry(n->member.next, typeof(*n), member))
 
 /**
- * list_for_each_entry_safe_reverse
- * @pos:       the type * to use as a loop cursor.
+ * list_for_each_entry_safe_reverse - iterate backwards over list of given type safe against
+ *                                   removal of list entry
+ * @pos:       the type * to use as a loop counter.
  * @n:         another type * to use as temporary storage
  * @head:      the head for your list.
  * @member:    the name of the list_struct within the struct.
- *
- * Iterate backwards over list of given type, safe against removal
- * of list entry.
  */
 #define list_for_each_entry_safe_reverse(pos, n, head, member)         \
        for (pos = list_entry((head)->prev, typeof(*pos), member),      \
@@ -530,7 +499,7 @@ static inline void list_splice_init(struct list_head *list,
 
 /**
  * list_for_each_rcu   -       iterate over an rcu-protected list
- * @pos:       the &struct list_head to use as a loop cursor.
+ * @pos:       the &struct list_head to use as a loop counter.
  * @head:      the head for your list.
  *
  * This list-traversal primitive may safely run concurrently with
@@ -548,13 +517,12 @@ static inline void list_splice_init(struct list_head *list,
                pos = pos->next)
 
 /**
- * list_for_each_safe_rcu
- * @pos:       the &struct list_head to use as a loop cursor.
+ * list_for_each_safe_rcu      -       iterate over an rcu-protected list safe
+ *                                     against removal of list entry
+ * @pos:       the &struct list_head to use as a loop counter.
  * @n:         another &struct list_head to use as temporary storage
  * @head:      the head for your list.
  *
- * Iterate over an rcu-protected list, safe against removal of list entry.
- *
  * This list-traversal primitive may safely run concurrently with
  * the _rcu list-mutation primitives such as list_add_rcu()
  * as long as the traversal is guarded by rcu_read_lock().
@@ -566,7 +534,7 @@ static inline void list_splice_init(struct list_head *list,
 
 /**
  * list_for_each_entry_rcu     -       iterate over rcu list of given type
- * @pos:       the type * to use as a loop cursor.
+ * @pos:       the type * to use as a loop counter.
  * @head:      the head for your list.
  * @member:    the name of the list_struct within the struct.
  *
@@ -582,12 +550,11 @@ static inline void list_splice_init(struct list_head *list,
 
 
 /**
- * list_for_each_continue_rcu
- * @pos:       the &struct list_head to use as a loop cursor.
+ * list_for_each_continue_rcu  -       iterate over an rcu-protected list
+ *                     continuing after existing point.
+ * @pos:       the &struct list_head to use as a loop counter.
  * @head:      the head for your list.
  *
- * Iterate over an rcu-protected list, continuing after current point.
- *
  * This list-traversal primitive may safely run concurrently with
  * the _rcu list-mutation primitives such as list_add_rcu()
  * as long as the traversal is guarded by rcu_read_lock().
@@ -713,14 +680,11 @@ static inline void hlist_add_head(struct hlist_node *n, struct hlist_head *h)
 
 
 /**
- * hlist_add_head_rcu
+ * hlist_add_head_rcu - adds the specified element to the specified hlist,
+ * while permitting racing traversals.
  * @n: the element to add to the hash list.
  * @h: the list to add to.
  *
- * Description:
- * Adds the specified element to the specified hlist,
- * while permitting racing traversals.
- *
  * The caller must take whatever precautions are necessary
  * (such as holding appropriate locks) to avoid racing
  * with another list-mutation primitive, such as hlist_add_head_rcu()
@@ -765,14 +729,11 @@ static inline void hlist_add_after(struct hlist_node *n,
 }
 
 /**
- * hlist_add_before_rcu
+ * hlist_add_before_rcu - adds the specified element to the specified hlist
+ * before the specified node while permitting racing traversals.
  * @n: the new element to add to the hash list.
  * @next: the existing element to add the new element before.
  *
- * Description:
- * Adds the specified element to the specified hlist
- * before the specified node while permitting racing traversals.
- *
  * The caller must take whatever precautions are necessary
  * (such as holding appropriate locks) to avoid racing
  * with another list-mutation primitive, such as hlist_add_head_rcu()
@@ -793,14 +754,11 @@ static inline void hlist_add_before_rcu(struct hlist_node *n,
 }
 
 /**
- * hlist_add_after_rcu
+ * hlist_add_after_rcu - adds the specified element to the specified hlist
+ * after the specified node while permitting racing traversals.
  * @prev: the existing element to add the new element after.
  * @n: the new element to add to the hash list.
  *
- * Description:
- * Adds the specified element to the specified hlist
- * after the specified node while permitting racing traversals.
- *
  * The caller must take whatever precautions are necessary
  * (such as holding appropriate locks) to avoid racing
  * with another list-mutation primitive, such as hlist_add_head_rcu()
@@ -833,8 +791,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,
 
 /**
  * hlist_for_each_entry        - iterate over list of given type
- * @tpos:      the type * to use as a loop cursor.
- * @pos:       the &struct hlist_node to use as a loop cursor.
+ * @tpos:      the type * to use as a loop counter.
+ * @pos:       the &struct hlist_node to use as a loop counter.
  * @head:      the head for your list.
  * @member:    the name of the hlist_node within the struct.
  */
@@ -845,9 +803,9 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,
             pos = pos->next)
 
 /**
- * hlist_for_each_entry_continue - iterate over a hlist continuing after current point
- * @tpos:      the type * to use as a loop cursor.
- * @pos:       the &struct hlist_node to use as a loop cursor.
+ * hlist_for_each_entry_continue - iterate over a hlist continuing after existing point
+ * @tpos:      the type * to use as a loop counter.
+ * @pos:       the &struct hlist_node to use as a loop counter.
  * @member:    the name of the hlist_node within the struct.
  */
 #define hlist_for_each_entry_continue(tpos, pos, member)                \
@@ -857,9 +815,9 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,
             pos = pos->next)
 
 /**
- * hlist_for_each_entry_from - iterate over a hlist continuing from current point
- * @tpos:      the type * to use as a loop cursor.
- * @pos:       the &struct hlist_node to use as a loop cursor.
+ * hlist_for_each_entry_from - iterate over a hlist continuing from existing point
+ * @tpos:      the type * to use as a loop counter.
+ * @pos:       the &struct hlist_node to use as a loop counter.
  * @member:    the name of the hlist_node within the struct.
  */
 #define hlist_for_each_entry_from(tpos, pos, member)                    \
@@ -869,8 +827,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,
 
 /**
  * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry
- * @tpos:      the type * to use as a loop cursor.
- * @pos:       the &struct hlist_node to use as a loop cursor.
+ * @tpos:      the type * to use as a loop counter.
+ * @pos:       the &struct hlist_node to use as a loop counter.
  * @n:         another &struct hlist_node to use as temporary storage
  * @head:      the head for your list.
  * @member:    the name of the hlist_node within the struct.
@@ -883,8 +841,8 @@ static inline void hlist_add_after_rcu(struct hlist_node *prev,
 
 /**
  * hlist_for_each_entry_rcu - iterate over rcu list of given type
- * @tpos:      the type * to use as a loop cursor.
- * @pos:       the &struct hlist_node to use as a loop cursor.
+ * @tpos:      the type * to use as a loop counter.
+ * @pos:       the &struct hlist_node to use as a loop counter.
  * @head:      the head for your list.
  * @member:    the name of the hlist_node within the struct.
  *