Merge pull request #9144 from deepikabhavnani/equeue_cancel_issue

EventQueue: Old pointers of sibling were not cleared

Author: Cruz Monrreal

events/equeue/equeue.c

@@ -108,13 +108,15 @@ void equeue_destroy(equeue_t *q)
 {
     // call destructors on pending events
     for (struct equeue_event *es = q->queue; es; es = es->next) {
-        for (struct equeue_event *e = q->queue; e; e = e->sibling) {
+        for (struct equeue_event *e = es->sibling; e; e = e->sibling) {
             if (e->dtor) {
                 e->dtor(e + 1);
             }
         }
+        if (es->dtor) {
+            es->dtor(es + 1);
+        }
     }
-
     // notify background timer
     if (q->background.update) {
         q->background.update(q->background.timer, -1);
@@ -239,8 +241,8 @@ static int equeue_enqueue(equeue_t *q, struct equeue_event *e, unsigned tick)
         if (e->next) {
             e->next->ref = &e->next;
         }
-
         e->sibling = *p;
+        e->sibling->next = 0;
         e->sibling->ref = &e->sibling;
     } else {
         e->next = *p;

events/equeue/tests/tests.c

@@ -779,6 +779,29 @@ void break_request_cleared_on_timeout(void)
     equeue_destroy(&q);
 }
 
+void sibling_test(void)
+{
+    equeue_t q;
+    int err = equeue_create(&q, 1024);
+    test_assert(!err);
+
+    int id0 = equeue_call_in(&q, 1, pass_func, 0);
+    int id1 = equeue_call_in(&q, 1, pass_func, 0);
+    int id2 = equeue_call_in(&q, 1, pass_func, 0);
+
+    struct equeue_event *e = q.queue;
+
+    for (; e; e = e->next) {
+        for (struct equeue_event *s = e->sibling; s; s = s->sibling) {
+            test_assert(!s->next);
+        }
+    }
+    equeue_cancel(&q, id0);
+    equeue_cancel(&q, id1);
+    equeue_cancel(&q, id2);
+    equeue_destroy(&q);
+}
+
 int main()
 {
     printf("beginning tests...\n");
@@ -806,7 +829,7 @@ int main()
     test_run(fragmenting_barrage_test, 20);
     test_run(multithreaded_barrage_test, 20);
     test_run(break_request_cleared_on_timeout);
-
+    test_run(sibling_test);
     printf("done!\n");
     return test_failure;
 }