changes to ms-queue spec
[cdsspec-compiler.git] / benchmark / ms-queue / my_queue.c
index 6a2737f91825a9bdcee355027f6baad9135ea826..1d9e924538d16bd9dc192846b1785b38d7811907 100644 (file)
@@ -10,7 +10,7 @@
 #define acquire memory_order_acquire
 
 #define MAX_FREELIST 4 /* Each thread can own up to MAX_FREELIST free nodes */
-#define INITIAL_FREE 2 /* Each thread starts with INITIAL_FREE free nodes */
+#define INITIAL_FREE 3 /* Each thread starts with INITIAL_FREE free nodes */
 
 #define POISON_IDX 0x666
 
@@ -23,13 +23,15 @@ static unsigned int new_node()
        int t = get_thread_num();
        for (i = 0; i < MAX_FREELIST; i++) {
                unsigned int node = load_32(&free_lists[t][i]);
+               //unsigned int node = free_lists[t][i];
                if (node) {
                        store_32(&free_lists[t][i], 0);
+                       //free_lists[t][i] = 0;
                        return node;
                }
        }
        /* free_list is empty? */
-       MODEL_ASSERT(0);
+       //MODEL_ASSERT(0);
        return 0;
 }
 
@@ -40,20 +42,22 @@ static void reclaim(unsigned int node)
        int t = get_thread_num();
 
        /* Don't reclaim NULL node */
-       MODEL_ASSERT(node);
+       //MODEL_ASSERT(node);
 
        for (i = 0; i < MAX_FREELIST; i++) {
                /* Should never race with our own thread here */
                unsigned int idx = load_32(&free_lists[t][i]);
+               //unsigned int idx = free_lists[t][i];
 
                /* Found empty spot in free list */
                if (idx == 0) {
                        store_32(&free_lists[t][i], node);
+                       //free_lists[t][i] = node;
                        return;
                }
        }
        /* free list is full? */
-       MODEL_ASSERT(0);
+       //MODEL_ASSERT(0);
 }
 
 void init_queue(queue_t *q, int num_threads)
@@ -78,41 +82,7 @@ void init_queue(queue_t *q, int num_threads)
 
 /**
        @Begin
-       @Global_define:
-               @DeclareVar:
-               typedef struct tag_elem {
-                       Tag id;
-                       unsigned int data;
-                       
-                       tag_elem(Tag _id, unsigned int _data) {
-                               id = _id;
-                               data = _data;
-                       }
-               } tag_elem_t;
-
-               spec_queue<tag_elem_t> queue;
-               Tag tag;
-               @InitVar:
-                       queue = spec_queue<tag_elem_t>();
-                       tag = Tag();
-       @Happens_before:
-               # Only check the happens-before relationship according to the id of the
-               # commit_point_set. For commit_point_set that has same ID, A -> B means
-               # B happens after the previous A.
-               Enqueue -> Dequeue
-       @End
-*/
-
-/**
-       @Begin
-       @Interface: Enqueue
-       @Commit_point_set: Enqueue_Success_Point
-       @ID: __sequential.tag.getCurAndInc()
-       @Action:
-               # __ID__ is an internal macro that refers to the id of the current
-               # interface call
-               @Code:
-               __sequential.queue.enqueue(tag_elem_t(__ID__, val));
+       @Interface_define: Enqueue
        @End
 */
 void enqueue(queue_t *q, unsigned int val)
@@ -125,59 +95,86 @@ void enqueue(queue_t *q, unsigned int val)
 
        node = new_node();
        store_32(&q->nodes[node].value, val);
+       //q->nodes[node].value = val;
        tmp = atomic_load_explicit(&q->nodes[node].next, relaxed);
        set_ptr(&tmp, 0); // NULL
        atomic_store_explicit(&q->nodes[node].next, tmp, relaxed);
 
        while (!success) {
+               /**
+                       @Begin
+                       @Commit_point_clear: true
+                       @Label: Enqueue_Clear
+                       @End
+               */
+               /**** detected UL ****/
                tail = atomic_load_explicit(&q->tail, acquire);
+               /**
+                       @Begin
+                       @Commit_point_define_check: true
+                       @Label: Enqueue_Read_Tail
+                       @End
+               */
+               /****FIXME: miss ****/
                next = atomic_load_explicit(&q->nodes[get_ptr(tail)].next, acquire);
+               //printf("miss1_enqueue\n");
                if (tail == atomic_load_explicit(&q->tail, relaxed)) {
 
                        /* Check for uninitialized 'next' */
-                       MODEL_ASSERT(get_ptr(next) != POISON_IDX);
+                       //MODEL_ASSERT(get_ptr(next) != POISON_IDX);
 
                        if (get_ptr(next) == 0) { // == NULL
                                pointer value = MAKE_POINTER(node, get_count(next) + 1);
+                               /**** detected UL ****/
+                               // Second release can be just relaxed
                                success = atomic_compare_exchange_strong_explicit(&q->nodes[get_ptr(tail)].next,
-                                               &next, value, release, release);
+                                               &next, value, release, relaxed);
+                               /**
+                                       @Begin
+                                       @Commit_point_define_check: success
+                                       @Label: Enqueue_UpdateNext
+                                       @End
+                               */
                        }
                        if (!success) {
+                               // This routine helps the other enqueue to update the tail
+                               /**** detected UL ****/
                                unsigned int ptr = get_ptr(atomic_load_explicit(&q->nodes[get_ptr(tail)].next, acquire));
                                pointer value = MAKE_POINTER(ptr,
                                                get_count(tail) + 1);
-                               int commit_success = 0;
-                               commit_success = atomic_compare_exchange_strong_explicit(&q->tail,
-                                               &tail, value, release, release);
-                               /**
-                                       @Begin
-                                       @Commit_point_define_check: __ATOMIC_RET__ == true
-                                       @Label: Enqueue_Success_Point
-                                       @End
-                               */
+                               /****FIXME: miss ****/
+                               // Second release can be just relaxed
+                               bool succ = false;
+                               succ = atomic_compare_exchange_strong_explicit(&q->tail,
+                                               &tail, value, release, relaxed);
+                               if (succ) {
+                                       //printf("miss2_enqueue CAS succ\n");
+                               }
+                               //printf("miss2_enqueue\n");
                                thrd_yield();
                        }
                }
        }
-       atomic_compare_exchange_strong_explicit(&q->tail,
+       /**** dectected UL ****/
+       // Second release can be just relaxed
+       bool succ = atomic_compare_exchange_strong_explicit(&q->tail,
                        &tail,
                        MAKE_POINTER(node, get_count(tail) + 1),
-                       release, release);
+                       release, relaxed);
+       /**
+               @Begin
+               @Commit_point_define_check: succ 
+               @Label: Enqueue_UpdateOrLoad_Tail
+               @End
+       */
 }
 
 /**
        @Begin
-       @Interface: Dequeue
-       @Commit_point_set: Dequeue_Success_Point
-       @ID: __sequential.queue.peak().tag
-       @Action:
-               @Code:
-               unsigned int _Old_Val = __sequential.queue.dequeue().data;
-       @Post_check:
-               _Old_Val == __RET__
+       @Interface_define: Dequeue
        @End
 */
-unsigned int dequeue(queue_t *q)
+bool dequeue(queue_t *q, int *output)
 {
        unsigned int value;
        int success = 0;
@@ -186,40 +183,86 @@ unsigned int dequeue(queue_t *q)
        pointer next;
 
        while (!success) {
+               /**
+                       @Begin
+                       @Commit_point_clear: true
+                       @Label: Dequeue_Clear
+                       @End
+               */
+               /**** detected correctness error ****/
                head = atomic_load_explicit(&q->head, acquire);
+               /**
+                       @Begin
+                       @Commit_point_define_check: true
+                       @Label: Dequeue_Read_Head
+                       @End
+               */
                tail = atomic_load_explicit(&q->tail, relaxed);
+               /**
+                       @Begin
+                       @Potential_commit_point_define: true
+                       @Label: Dequeue_Potential_Read_Tail
+                       @End
+               */
+
+               /****FIXME: miss ****/
                next = atomic_load_explicit(&q->nodes[get_ptr(head)].next, acquire);
+               /**
+                       @Begin
+                       @Potential_commit_point_define: true 
+                       @Label: Dequeue_Potential_LoadNext
+                       @End
+               */
+               
                if (atomic_load_explicit(&q->head, relaxed) == head) {
                        if (get_ptr(head) == get_ptr(tail)) {
 
                                /* Check for uninitialized 'next' */
-                               MODEL_ASSERT(get_ptr(next) != POISON_IDX);
+                               //MODEL_ASSERT(get_ptr(next) != POISON_IDX);
 
                                if (get_ptr(next) == 0) { // NULL
-                                       return 0; // NULL
+                                       /**
+                                               @Begin
+                                               @Commit_point_define: true
+                                               @Potential_commit_point_label: Dequeue_Potential_Read_Tail
+                                               @Label: Dequeue_Read_Tail
+                                               @End
+                                       */
+                                       return false; // NULL
                                }
-                               atomic_compare_exchange_strong_explicit(&q->tail,
+                               /****FIXME: miss (not reached) ****/
+                               // Second release can be just relaxed
+                               bool succ = false;
+                               succ = atomic_compare_exchange_strong_explicit(&q->tail,
                                                &tail,
                                                MAKE_POINTER(get_ptr(next), get_count(tail) + 1),
-                                               release, release);
+                                               release, relaxed);
+                               if (succ) {
+                                       //printf("miss4_dequeue CAS succ\n");
+                               }
+                               //printf("miss4_dequeue\n");
                                thrd_yield();
                        } else {
-                               value = load_32(&q->nodes[get_ptr(next)].value);
-                               success = atomic_compare_exchange_strong_explicit(&q->head,
-                                               &head,
-                                               MAKE_POINTER(get_ptr(next), get_count(head) + 1),
-                                               release, release);
                                /**
                                        @Begin
-                                       @Commit_point_define_check: __ATOMIC_RET__ == true
-                                       @Label: Dequeue_Success_Point
+                                       @Commit_point_define: true
+                                       @Potential_commit_point_label: Dequeue_Potential_LoadNext
+                                       @Label: Dequeue_LoadNext
                                        @End
                                */
+                               value = load_32(&q->nodes[get_ptr(next)].value);
+                               //value = q->nodes[get_ptr(next)].value;
+                               /****FIXME: correctness error ****/
+                               success = atomic_compare_exchange_strong_explicit(&q->head,
+                                               &head,
+                                               MAKE_POINTER(get_ptr(next), get_count(head) + 1),
+                                               release, relaxed);
                                if (!success)
                                        thrd_yield();
                        }
                }
        }
        reclaim(get_ptr(head));
-       return value;
+       *output = value;
+       return true;
 }