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         @Global_define:
  82                 typedef struct tag_elem {
  83                         Tag id;
  84                         unsigned int data;
  85
  86                         tag_elem(Tag _id, unsigned int _data) {
  87                                 id = _id;
  88                                 data = _data;
  89                         }
  90                 } tag_elem_t;
  91
  92                 spec_queue<tag_elem_t> __queue;
  93                 Tag __tag;
  94         @Happens_before:
  95                 # Only check the happens-before relationship according to the id of the
  96                 # commit_point_set. For commit_point_set that has same ID, A -> B means
  97                 # B happens after the previous A.
  98                 Enqueue -> Dequeue
  99         @End
 100 */
 101
 102 /**
 103         @Begin
 104         @Interface_define: Enqueue
 105         @End
 106 */
 107 void enqueue(queue_t *q, unsigned int val)
 108 {
 109         int success = 0;
 110         unsigned int node;
 111         pointer tail;
 112         pointer next;
 113         pointer tmp;
 114
 115         node = new_node();
 116         store_32(&q->nodes[node].value, val);
 117         tmp = atomic_load_explicit(&q->nodes[node].next, relaxed);
 118         set_ptr(&tmp, 0); // NULL
 119         atomic_store_explicit(&q->nodes[node].next, tmp, relaxed);
 120
 121         while (!success) {
 122                 tail = atomic_load_explicit(&q->tail, acquire);
 123                 next = atomic_load_explicit(&q->nodes[get_ptr(tail)].next, acquire);
 124                 if (tail == atomic_load_explicit(&q->tail, relaxed)) {
 125
 126                         /* Check for uninitialized 'next' */
 127                         MODEL_ASSERT(get_ptr(next) != POISON_IDX);
 128
 129                         if (get_ptr(next) == 0) { // == NULL
 130                                 pointer value = MAKE_POINTER(node, get_count(next) + 1);
 131                                 success = atomic_compare_exchange_strong_explicit(&q->nodes[get_ptr(tail)].next,
 132                                                 &next, value, release, release);
 133                         }
 134                         if (!success) {
 135                                 unsigned int ptr = get_ptr(atomic_load_explicit(&q->nodes[get_ptr(tail)].next, acquire));
 136                                 pointer value = MAKE_POINTER(ptr,
 137                                                 get_count(tail) + 1);
 138                                 int commit_success = 0;
 139                                 commit_success = atomic_compare_exchange_strong_explicit(&q->tail,
 140                                                 &tail, value, release, release);
 141                                 /**
 142                                         @Begin
 143                                         @Commit_point_define_check: commit_success == true
 144                                         @Label: Enqueue_Success_Point
 145                                         @End
 146                                 */
 147                                 thrd_yield();
 148                         }
 149                 }
 150         }
 151         atomic_compare_exchange_strong_explicit(&q->tail,
 152                         &tail,
 153                         MAKE_POINTER(node, get_count(tail) + 1),
 154                         release, release);
 155 }
 156
 157 /**
 158         @Begin
 159         @Interface_define: Dequeue
 160         @End
 161 */
 162 unsigned int dequeue(queue_t *q)
 163 {
 164         unsigned int value;
 165         int success = 0;
 166         pointer head;
 167         pointer tail;
 168         pointer next;
 169
 170         while (!success) {
 171                 head = atomic_load_explicit(&q->head, acquire);
 172                 tail = atomic_load_explicit(&q->tail, relaxed);
 173                 next = atomic_load_explicit(&q->nodes[get_ptr(head)].next, acquire);
 174                 if (atomic_load_explicit(&q->head, relaxed) == head) {
 175                         if (get_ptr(head) == get_ptr(tail)) {
 176
 177                                 /* Check for uninitialized 'next' */
 178                                 MODEL_ASSERT(get_ptr(next) != POISON_IDX);
 179
 180                                 if (get_ptr(next) == 0) { // NULL
 181                                         return 0; // NULL
 182                                 }
 183                                 atomic_compare_exchange_strong_explicit(&q->tail,
 184                                                 &tail,
 185                                                 MAKE_POINTER(get_ptr(next), get_count(tail) + 1),
 186                                                 release, release);
 187                                 thrd_yield();
 188                         } else {
 189                                 value = load_32(&q->nodes[get_ptr(next)].value);
 190                                 success = atomic_compare_exchange_strong_explicit(&q->head,
 191                                                 &head,
 192                                                 MAKE_POINTER(get_ptr(next), get_count(head) + 1),
 193                                                 release, release);
 194                                 /**
 195                                         @Begin
 196                                         @Commit_point_define_check: success == true
 197                                         @Label: Dequeue_Success_Point
 198                                         @End
 199                                 */
 200                                 if (!success)
 201                                         thrd_yield();
 202                         }
 203                 }
 204         }
 205         reclaim(get_ptr(head));
 206         return value;
 207 }