src/list.h

   1 /*
   2  *
   3  * Copyright 2006 Tungsten Graphics, Inc., Bismarck, ND. USA.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  17  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  18  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  19  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  20  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * The above copyright notice and this permission notice (including the
  23  * next paragraph) shall be included in all copies or substantial portions
  24  * of the Software.
  25  *
  26  */
  27
  28 /**
  29  * \file
  30  * List macros heavily inspired by the Linux kernel
  31  * list handling. No list looping yet.
  32  *
  33  * Is not threadsafe, so common operations need to
  34  * be protected using an external mutex.
  35  */
  36 #ifndef _U_DOUBLE_LIST_H_
  37 #define _U_DOUBLE_LIST_H_
  38
  39 #include <stddef.h>
  40
  41 /* LCOV_EXCL_START */
  42 static void list_inithead(struct list_head *item)
  43 {
  44         item->prev = item;
  45         item->next = item;
  46 }
  47
  48 static inline void list_add(struct list_head *item, struct list_head *list)
  49 {
  50         item->prev = list;
  51         item->next = list->next;
  52         list->next->prev = item;
  53         list->next = item;
  54 }
  55
  56 static inline void list_addtail(struct list_head *item, struct list_head *list)
  57 {
  58         item->next = list;
  59         item->prev = list->prev;
  60         list->prev->next = item;
  61         list->prev = item;
  62 }
  63
  64 static inline void list_replace(struct list_head *from, struct list_head *to)
  65 {
  66         to->prev = from->prev;
  67         to->next = from->next;
  68         from->next->prev = to;
  69         from->prev->next = to;
  70 }
  71
  72 static inline void list_del(struct list_head *item)
  73 {
  74         item->prev->next = item->next;
  75         item->next->prev = item->prev;
  76 }
  77
  78 static inline void list_delinit(struct list_head *item)
  79 {
  80         item->prev->next = item->next;
  81         item->next->prev = item->prev;
  82         item->next = item;
  83         item->prev = item;
  84 }
  85
  86 #define LIST_INITHEAD(__item) list_inithead(__item)
  87 #define LIST_ADD(__item, __list) list_add(__item, __list)
  88 #define LIST_ADDTAIL(__item, __list) list_addtail(__item, __list)
  89 #define LIST_REPLACE(__from, __to) list_replace(__from, __to)
  90 #define LIST_DEL(__item) list_del(__item)
  91 #define LIST_DELINIT(__item) list_delinit(__item)
  92
  93 #define LIST_ENTRY(__type, __item, __field)   \
  94         ((__type *)(((char *)(__item)) - offsetof(__type, __field)))
  95
  96 #define LIST_IS_EMPTY(__list)                   \
  97         ((__list)->next == (__list))
  98
  99 #ifndef container_of
 100 #define container_of(ptr, sample, member)                               \
 101         (void *)((char *)(ptr)                                          \
 102                 - ((char *)&(sample)->member - (char *)(sample)))
 103 #endif
 104
 105 #define LIST_FOR_EACH_ENTRY(pos, head, member)                          \
 106         for (pos = container_of((head)->next, pos, member);                     \
 107                 &pos->member != (head);                                         \
 108                 pos = container_of(pos->member.next, pos, member))
 109
 110 #define LIST_FOR_EACH_ENTRY_SAFE(pos, storage, head, member)    \
 111         for (pos = container_of((head)->next, pos, member),                     \
 112                 storage = container_of(pos->member.next, pos, member);  \
 113                 &pos->member != (head);                                         \
 114                 pos = storage, storage = container_of(storage->member.next, storage, member))
 115
 116 #define LIST_FOR_EACH_ENTRY_SAFE_REV(pos, storage, head, member)        \
 117         for (pos = container_of((head)->prev, pos, member),                     \
 118         storage = container_of(pos->member.prev, pos, member);          \
 119                 &pos->member != (head);                                         \
 120                 pos = storage, storage = container_of(storage->member.prev, storage, member))
 121
 122 #define LIST_FOR_EACH_ENTRY_FROM(pos, start, head, member)              \
 123         for (pos = container_of((start), pos, member);                  \
 124         &pos->member != (head);                                         \
 125                 pos = container_of(pos->member.next, pos, member))
 126
 127 #define LIST_FOR_EACH_ENTRY_FROM_REV(pos, start, head, member)          \
 128         for (pos = container_of((start), pos, member);                  \
 129                 &pos->member != (head);                                         \
 130                 pos = container_of(pos->member.prev, pos, member))
 131
 132 #endif /*_U_DOUBLE_LIST_H_*/
 133 /* LCOV_EXCL_STOP */