benchmark/ms-queue/my_queue.c

   1 #include <threads.h>
   2 #include <stdlib.h>
   3 #include "librace.h"
   4 #include "model-assert.h"
   5
   6 #include "my_queue.h"
   7
   8 #define relaxed memory_order_relaxed
   9 #define release memory_order_release
  10 #define acquire memory_order_acquire
  11
  12 #define MAX_FREELIST 4 /* Each thread can own up to MAX_FREELIST free nodes */
  13 #define INITIAL_FREE 2 /* Each thread starts with INITIAL_FREE free nodes */
  14
  15 #define POISON_IDX 0x666
  16
  17 static unsigned int (*free_lists)[MAX_FREELIST];
  18
  19 /* Search this thread's free list for a "new" node */
  20 static unsigned int new_node()
  21 {
  22         int i;
  23         int t = get_thread_num();
  24         for (i = 0; i < MAX_FREELIST; i++) {
  25                 unsigned int node = load_32(&free_lists[t][i]);
  26                 if (node) {
  27                         store_32(&free_lists[t][i], 0);
  28                         return node;
  29                 }
  30         }
  31         /* free_list is empty? */
  32         MODEL_ASSERT(0);
  33         return 0;
  34 }
  35
  36 /* Place this node index back on this thread's free list */
  37 static void reclaim(unsigned int node)
  38 {
  39         int i;
  40         int t = get_thread_num();
  41
  42         /* Don't reclaim NULL node */
  43         MODEL_ASSERT(node);
  44
  45         for (i = 0; i < MAX_FREELIST; i++) {
  46                 /* Should never race with our own thread here */
  47                 unsigned int idx = load_32(&free_lists[t][i]);
  48
  49                 /* Found empty spot in free list */
  50                 if (idx == 0) {
  51                         store_32(&free_lists[t][i], node);
  52                         return;
  53                 }
  54         }
  55         /* free list is full? */
  56         MODEL_ASSERT(0);
  57 }
  58
  59 void init_queue(queue_t *q, int num_threads)
  60 {
  61         int i, j;
  62
  63         /* Initialize each thread's free list with INITIAL_FREE pointers */
  64         /* The actual nodes are initialized with poison indexes */
  65         free_lists = malloc(num_threads * sizeof(*free_lists));
  66         for (i = 0; i < num_threads; i++) {
  67                 for (j = 0; j < INITIAL_FREE; j++) {
  68                         free_lists[i][j] = 2 + i * MAX_FREELIST + j;
  69                         atomic_init(&q->nodes[free_lists[i][j]].next, MAKE_POINTER(POISON_IDX, 0));
  70                 }
  71         }
  72
  73         /* initialize queue */
  74         atomic_init(&q->head, MAKE_POINTER(1, 0));
  75         atomic_init(&q->tail, MAKE_POINTER(1, 0));
  76         atomic_init(&q->nodes[1].next, MAKE_POINTER(0, 0));
  77 }
  78
  79 /**
  80         @Begin
  81         @Interface_define: Enqueue
  82         @End
  83 */
  84 void enqueue(queue_t *q, unsigned int val)
  85 {
  86         int success = 0;
  87         unsigned int node;
  88         pointer tail;
  89         pointer next;
  90         pointer tmp;
  91
  92         node = new_node();
  93         store_32(&q->nodes[node].value, val);
  94         tmp = atomic_load_explicit(&q->nodes[node].next, relaxed);
  95         set_ptr(&tmp, 0); // NULL
  96         atomic_store_explicit(&q->nodes[node].next, tmp, relaxed);
  97
  98         while (!success) {
  99                 tail = atomic_load_explicit(&q->tail, acquire);
 100                 next = atomic_load_explicit(&q->nodes[get_ptr(tail)].next, acquire);
 101                 if (tail == atomic_load_explicit(&q->tail, relaxed)) {
 102
 103                         /* Check for uninitialized 'next' */
 104                         MODEL_ASSERT(get_ptr(next) != POISON_IDX);
 105
 106                         if (get_ptr(next) == 0) { // == NULL
 107                                 pointer value = MAKE_POINTER(node, get_count(next) + 1);
 108                                 success = atomic_compare_exchange_strong_explicit(&q->nodes[get_ptr(tail)].next,
 109                                                 &next, value, release, release);
 110                                 /**
 111                                         @Begin
 112                                         @Commit_point_define_check: success = true
 113                                         @Label: Enqueue_Success_Point
 114                                         @End
 115                                 */
 116                         }
 117                         if (!success) {
 118                                 unsigned int ptr = get_ptr(atomic_load_explicit(&q->nodes[get_ptr(tail)].next, acquire));
 119                                 pointer value = MAKE_POINTER(ptr,
 120                                                 get_count(tail) + 1);
 121                                 atomic_compare_exchange_strong_explicit(&q->tail,
 122                                                 &tail, value, release, release);
 123                                 thrd_yield();
 124                         }
 125                 }
 126         }
 127         atomic_compare_exchange_strong_explicit(&q->tail,
 128                         &tail,
 129                         MAKE_POINTER(node, get_count(tail) + 1),
 130                         release, release);
 131 }
 132
 133 /**
 134         @Begin
 135         @Interface_define: Dequeue
 136         @End
 137 */
 138 unsigned int dequeue(queue_t *q)
 139 {
 140         unsigned int value;
 141         int success = 0;
 142         pointer head;
 143         pointer tail;
 144         pointer next;
 145
 146         while (!success) {
 147                 head = atomic_load_explicit(&q->head, acquire);
 148                 tail = atomic_load_explicit(&q->tail, relaxed);
 149                 next = atomic_load_explicit(&q->nodes[get_ptr(head)].next, acquire);
 150                 if (atomic_load_explicit(&q->head, relaxed) == head) {
 151                         if (get_ptr(head) == get_ptr(tail)) {
 152
 153                                 /* Check for uninitialized 'next' */
 154                                 MODEL_ASSERT(get_ptr(next) != POISON_IDX);
 155
 156                                 if (get_ptr(next) == 0) { // NULL
 157                                         /**
 158                                                 @Begin
 159                                                 @Commit_point_define_check: true
 160                                                 @Label: Dequeue_Empty_Point
 161                                                 @End
 162                                         */
 163                                         return 0; // NULL
 164                                 }
 165                                 atomic_compare_exchange_strong_explicit(&q->tail,
 166                                                 &tail,
 167                                                 MAKE_POINTER(get_ptr(next), get_count(tail) + 1),
 168                                                 release, release);
 169                                 thrd_yield();
 170                         } else {
 171                                 value = load_32(&q->nodes[get_ptr(next)].value);
 172                                 success = atomic_compare_exchange_strong_explicit(&q->head,
 173                                                 &head,
 174                                                 MAKE_POINTER(get_ptr(next), get_count(head) + 1),
 175                                                 release, release);
 176                                 /**
 177                                         @Begin
 178                                         @Commit_point_define_check: success == true
 179                                         @Label: Dequeue_Success_Point
 180                                         @End
 181                                 */
 182                                 if (!success)
 183                                         thrd_yield();
 184                         }
 185                 }
 186         }
 187         reclaim(get_ptr(head));
 188         return value;
 189 }