pintos-os.org Git - pintos-anon/blob - src/lib/list.h

   1 #ifndef HEADER_LIST_H
   2 #define HEADER_LIST_H 1
   3
   4 /* Doubly linked list.
   5
   6    This implementation of a doubly linked list does not require
   7    use of dynamically allocated memory.  Instead, each structure
   8    that is a potential list element must embed a list_elem
   9    member.  All of the list functions operate on these
  10    `list_elem's.  The list_entry macro allows conversion from a
  11    list_elem back to a structure object that contains it.
  12
  13    For example, suppose there is a needed for a list of `struct
  14    foo'.  `struct foo' should contain a `list_elem' member, like
  15    so:
  16
  17       struct foo
  18         {
  19           list_elem elem;
  20           int bar;
  21           ...other members...
  22         };
  23
  24    Then a list of `struct foo' can be be declared and initialized
  25    like so:
  26
  27       struct list foo_list;
  28
  29       list_init (&foo_list);
  30
  31    Iteration is a typical situation where it is necessary to
  32    convert from a list_elem back to its enclosing structure.
  33    Here's an example using foo_list:
  34
  35       list_elem *e;
  36
  37       for (e = list_begin (&foo_list); e != list_end (&foo_list);
  38            e = list_next (e))
  39         {
  40           struct foo *f = list_entry (e, struct foo, elem);
  41           ...do something with f...
  42         }
  43
  44    You can find real examples of list usage throughout the
  45    source; for example, malloc.c, palloc.c, and thread.c in the
  46    threads directory all use lists.
  47
  48    The interface for this list is inspired by the list<> template
  49    in the C++ STL.  If you're familiar with list<>, you should
  50    find this easy to use.  However, it should be emphasized that
  51    these lists do *no* type checking and can't do much other
  52    correctness checking.  If you screw up, it will bite you.
  53
  54    Glossary of list terms:
  55
  56      - "front": The first element in a list.  Undefined in an
  57        empty list.  Returned by list_front().
  58
  59      - "back": The last element in a list.  Undefined in an empty
  60        list.  Returned by list_back().
  61
  62      - "tail": The element figuratively just after the last
  63        element of a list.  Well defined even in an empty list.
  64        Returned by list_end().  Used as the end sentinel for an
  65        iteration from front to back.
  66
  67      - "beginning": In a non-empty list, the front.  In an empty
  68        list, the tail.  Returned by list_begin().  Used as the
  69        starting point for an iteration from front to back.
  70
  71      - "head": The element figuratively just before the first
  72        element of a list.  Well defined even in an empty list.
  73        Returned by list_rend().  Used as the end sentinel for an
  74        iteration from back to front.
  75
  76      - "reverse beginning": In a non-empty list, the back.  In an
  77        empty list, the head.  Returned by list_rbegin().  Used as
  78        the starting point for an iteration from back to front.
  79
  80      - "interior element": An element that is not the head or
  81        tail, that is, a real list element.  An empty list does
  82        not have any interior elements.
  83 */
  84
  85 #include <stdbool.h>
  86 #include <stddef.h>
  87 #include <stdint.h>
  88
  89 /* List element. */
  90 typedef struct list_elem
  91   {
  92     struct list_elem *prev; /* Previous node in list. */
  93     struct list_elem *next; /* Next node in list. */
  94   }
  95 list_elem;
  96
  97 /* List. */
  98 struct list
  99   {
 100     list_elem head; /* Start-of-list header node. */
 101     list_elem tail; /* End-of-list header node. */
 102   };
 103
 104 /* Converts pointer to list element LIST_ELEM into a pointer to
 105    the structure that LIST_ELEM is embedded inside.  Supply the
 106    name of the outer structure STRUCT and the member name MEMBER
 107    of the list element.  See the big comment at the top of the
 108    file for an example. */
 109 #define list_entry(LIST_ELEM, STRUCT, MEMBER)                              \
 110         ((STRUCT *) ((uint8_t *) (LIST_ELEM) - offsetof (STRUCT, MEMBER)))
 111
 112 void list_init (struct list *);
 113
 114 /* List traversal. */
 115 list_elem *list_begin (struct list *);
 116 list_elem *list_next (list_elem *);
 117 list_elem *list_end (struct list *);
 118
 119 list_elem *list_rbegin (struct list *);
 120 list_elem *list_prev (list_elem *);
 121 list_elem *list_rend (struct list *);
 122
 123 /* List insertion. */
 124 void list_insert (list_elem *, list_elem *);
 125 void list_splice (list_elem *before,
 126                   list_elem *first, list_elem *last);
 127 void list_push_front (struct list *, list_elem *);
 128 void list_push_back (struct list *, list_elem *);
 129
 130 /* List removal. */
 131 list_elem *list_remove (list_elem *);
 132 list_elem *list_pop_front (struct list *);
 133 list_elem *list_pop_back (struct list *);
 134
 135 /* List elements. */
 136 list_elem *list_front (struct list *);
 137 list_elem *list_back (struct list *);
 138
 139 /* List properties. */
 140 size_t list_size (struct list *);
 141 bool list_empty (struct list *);
 142
 143 /* Weirdness. */
 144 void list_reverse (struct list *);
 145 \f
 146 /* Operations on lists with ordered elements. */
 147
 148 /* Compares the value of two list elements A and B, given
 149    auxiliary data AUX.  Returns true if A is less than B, or
 150    false if A is greater than or equal to B. */
 151 typedef bool list_less_func (const list_elem *a, const list_elem *b,
 152                              void *aux);
 153 void list_merge (struct list *, struct list *,
 154                  list_less_func *, void *aux);
 155 void list_sort (struct list *,
 156                 list_less_func *, void *aux);
 157 void list_insert_ordered (struct list *, list_elem *,
 158                           list_less_func *, void *aux);
 159 void list_unique (struct list *, struct list *duplicates,
 160                   list_less_func *, void *aux);
 161
 162 #endif /* list.h */