Changes in kernel/generic/include/adt/list.h [9d58539:e98f1c3e] in mainline

File:

• kernel/generic/include/adt/list.h (modified) (9 diffs)

kernel/generic/include/adt/list.h

@@ -1 +1 @@
 /*
  * Copyright (c) 2001-2004 Jakub Jermar
- * Copyright (c) 2011 Jiri Svoboda
+ * Copyright (c) 2013 Jiri Svoboda
  * All rights reserved.
  *
@@ -37 +37 @@
 #define KERN_LIST_H_
 
+#include <debug.h>
 #include <typedefs.h>
 #include <trace.h>
@@ -50 +51 @@
         link_t head;  /**< List head. Does not have any data. */
 } list_t;
+
+
+extern bool list_member(const link_t *, const list_t *);
+extern void list_splice(list_t *, link_t *);
+extern unsigned long list_count(const list_t *);
+
 
 /** Declare and initialize statically allocated list.
@@ -65 +72 @@
 
 #define list_get_instance(link, type, member) \
-        ((type *) (((void *)(link)) - ((void *) &(((type *) NULL)->member))))
-
-#define list_foreach(list, iterator) \
-        for (link_t *iterator = (list).head.next; \
-            iterator != &(list).head; iterator = iterator->next)
-
+        ((type *) (((void *)(link)) - list_link_to_void(&(((type *) NULL)->member))))
+
+#define list_foreach(list, member, itype, iterator) \
+        for (itype *iterator = NULL; iterator == NULL; iterator = (itype *) 1) \
+                for (link_t *_link = (list).head.next; \
+                    iterator = list_get_instance(_link, itype, member), \
+                    _link != &(list).head; _link = _link->next)
+
+#define list_foreach_rev(list, member, itype, iterator) \
+        for (itype *iterator = NULL; iterator == NULL; iterator = (itype *) 1) \
+                for (link_t *_link = (list).head.prev; \
+                    iterator = list_get_instance(_link, itype, member), \
+                    _link != &(list).head; _link = _link->prev)
+
+/** Unlike list_foreach(), allows removing items while traversing a list.
+ * 
+ * @code
+ * list_t mylist;
+ * typedef struct item {
+ *     int value;
+ *     link_t item_link;
+ * } item_t;
+ * 
+ * //..
+ * 
+ * // Print each list element's value and remove the element from the list.
+ * list_foreach_safe(mylist, cur_link, next_link) {
+ *     item_t *cur_item = list_get_instance(cur_link, item_t, item_link);
+ *     printf("%d\n", cur_item->value);
+ *     list_remove(cur_link);
+ * }
+ * @endcode
+ * 
+ * @param list List to traverse.
+ * @param iterator Iterator to the current element of the list.
+ *             The item this iterator points may be safely removed
+ *             from the list.
+ * @param next_iter Iterator to the next element of the list.
+ */
+#define list_foreach_safe(list, iterator, next_iter) \
+        for (link_t *iterator = (list).head.next, \
+            *next_iter = iterator->next; \
+            iterator != &(list).head; \
+            iterator = next_iter, next_iter = iterator->next)
+
+        
 #define assert_link_not_used(link) \
-        ASSERT(((link)->prev == NULL) && ((link)->next == NULL))
+        ASSERT(!link_used(link))
 
 /** Initialize doubly-linked circular list link
@@ -173 +220 @@
  *
  */
-NO_TRACE static inline int list_empty(const list_t *list)
+NO_TRACE static inline bool list_empty(const list_t *list)
 {
         return (list->head.next == &list->head);
@@ -202 +249 @@
 {
         return ((list->head.prev == &list->head) ? NULL : list->head.prev);
+}
+
+/** Get next item in list.
+ *
+ * @param link Current item link
+ * @param list List containing @a link
+ *
+ * @return Next item or NULL if @a link is the last item.
+ */
+static inline link_t *list_next(link_t *link, const list_t *list)
+{
+        return (link->next == &list->head) ? NULL : link->next;
+}
+
+/** Get previous item in list.
+ *
+ * @param link Current item link
+ * @param list List containing @a link
+ *
+ * @return Previous item or NULL if @a link is the first item.
+ */
+static inline link_t *list_prev(link_t *link, const list_t *list)
+{
+        return (link->prev == &list->head) ? NULL : link->prev;
 }
 
@@ -258 +329 @@
 }
 
+/** Concatenate two lists
+ *
+ * Concatenate lists @a list1 and @a list2, producing a single
+ * list @a list1 containing items from both (in @a list1, @a list2
+ * order) and empty list @a list2.
+ *
+ * @param list1         First list and concatenated output
+ * @param list2         Second list and empty output.
+ *
+ */
+NO_TRACE static inline void list_concat(list_t *list1, list_t *list2)
+{
+        list_splice(list2, list1->head.prev);
+}
+
 /** Get n-th item in a list.
  *
@@ -267 +353 @@
  *
  */
-static inline link_t *list_nth(list_t *list, unsigned int n)
-{
-        unsigned int cnt = 0;
-        
-        list_foreach(*list, link) {
+static inline link_t *list_nth(list_t *list, unsigned long n)
+{
+        unsigned long cnt = 0;
+        link_t *link;
+        
+        link = list_first(list);
+        while (link != NULL) {
                 if (cnt == n)
                         return link;
                 
                 cnt++;
+                link = list_next(link, list);
         }
         
@@ -281 +370 @@
 }
 
-extern int list_member(const link_t *, const list_t *);
-extern void list_concat(list_t *, list_t *);
-extern unsigned int list_count(const list_t *);
+/** Verify that argument type is a pointer to link_t (at compile time).
+ *
+ * This can be used to check argument type in a macro.
+ */
+static inline const void *list_link_to_void(const link_t *link)
+{
+        return link;
+}
+
+/** Determine if link is used.
+ *
+ * @param link Link
+ * @return @c true if link is used, @c false if not.
+ */
+static inline bool link_used(link_t *link)
+{
+        if (link->prev == NULL && link->next == NULL)
+                return false;
+
+        ASSERT(link->prev != NULL && link->next != NULL);
+        return true;
+}
 
 #endif