ticker test improvement #6935

maciejbocianski · 2018-05-17T07:48:56Z

Description

Make multiticker test more reliable when scheduling very early interrupts.

When very early interrupt is scheduled (e.g now + 2[ticks]) then it's likely that it won't be fired in some circumstances and as a result there is overdue event in queue. That overdue event can be mistakenly scheduled again by Ticker::detach (detach calls schedule if head was removed). That's why we should check interrupts counter immediately after wait period and before detach loop

Pull request type

[X] Fix
[ ] Refactor
[ ] New target
[ ] Feature
[ ] Breaking change

maciejbocianski · 2018-05-17T07:49:28Z

@mprse @c1728p9 could you review

cmonr · 2018-05-17T15:16:53Z

/morph build

bulislaw · 2018-05-17T15:58:22Z

How does that fit the ticker feature branch? It's going to be merged soon so if it's not applicable to the new branch should we skip it to avoid conflicts?

mbed-ci · 2018-05-17T16:26:15Z

Build : SUCCESS

Build number : 2052
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6935/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

mbed-ci · 2018-05-17T20:49:28Z

Test : FAILURE

Build number : 1862
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/6935/1862

mbed-ci · 2018-05-17T21:09:24Z

Exporter Build : SUCCESS

Build number : 1695
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/6935/

cmonr · 2018-05-18T02:46:19Z

@maciejbocianski Could you answer @bulislaw's question?

cmonr · 2018-05-18T02:46:26Z

/morph test

mbed-ci · 2018-05-18T04:08:09Z

Test : SUCCESS

Build number : 1867
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/6935/1867

maciejbocianski · 2018-05-18T05:26:52Z

@bulislaw it's not critical, could be postponed.

0xc0170 · 2018-05-18T09:25:30Z

How does that fit the ticker feature branch? It's going to be merged soon so if it's not applicable to the new branch should we skip it to avoid conflicts?

Setting this as needs preceding PR.

cmonr · 2018-05-29T16:25:06Z

@bulislaw Since HAL has landed, I take it this is clear to continue?

0xc0170 · 2018-05-30T09:55:09Z

TESTS/mbed_drivers/lp_ticker/main.cpp

@@ -91,9 +95,12 @@ void test_multi_ticker(void)
    }

    Thread::wait(MULTI_TICKER_TIME_MS + TICKER_COUNT + extra_wait);
+    multi_counter_snapshot = multi_counter;


When very early interrupt is scheduled (e.g now + 2[ticks]) then it's likely that it won't be fired in some circumstances and as a result there is overdue event in queue. That overdue event can be mistakenly scheduled again by Ticker::detach (detach calls schedule if head was removed). That's why we should check interrupts counter immediately after wait period and before detach loop

I don't follow the description and these changes here. can you elaborate how multicounter snapshot fixes it?

Assume the following scenario (time is mesured in ticks)
Running test_multi_ticker with TICKER_COUNT == 3 (tickers t1, t2, t3) and ticker period 100
Then we get following events scheduled at time 0

event_queue: e1(100), e2(105), e3(105)
now == 0

at time 100 e1 is triggered (and next event for t1 is scheduled e11(200))
at time 103 e2 interrupt is set(scheduled) (now == 103)
for e2 interrupt will not be trigerred (trying to set (now + 2) what is less then (now + 3))
(on some targets to be sure that interrupt will be triggered we can't set interrupt earlier than (now + 3 ticks))

After wait instruction we have following state:

event_queue: e2(105), e3(105), e11(200)
multi_counter == 1 (e1 triggered)
now == 110
multi_counter_snapshot = multi_counter

In detach loop:
detach t1 events then e11 will be removed
detach t2 events then e2 will be removed
at this point since head was removed,
schedule_interrupt is called and since e3
is overdue fire_interrupt is called for e3
(and next event for t3 is scheduled e31(205))
detach t3 events then e31(205) will be removed

After detach loop we have following state:

event_queue: empty
multi_counter == 2 (e1 and e3 triggered)
now == 115

result when checking multi_counter: expected 3 is 2
result when checking multi_counter_snapshot: expected 3 is 1

So using multi_counter_snapshot we catch real test status, just after test end

jamesbeyond · 2018-06-07T09:51:22Z

TESTS/mbed_drivers/lp_ticker/main.cpp

    for (int i = 0; i < TICKER_COUNT; i++) {
        ticker[i].detach();
    }
+    TEST_ASSERT_EQUAL(TICKER_COUNT, multi_counter_snapshot);
    TEST_ASSERT_EQUAL(TICKER_COUNT, multi_counter);


So if multi_counter_snapshot catches real test status, why we still check multi_counter against TICKER_COUNT?

Because detach calls schedule_interrupt in some circumstances (e.g. when head event is removed), so it's good to check if no more callbacks is raised during detaching.

BTW, now I see that the first ASSERT can be moved up, where the snapshot is taken
And will add some comment to second check

cmonr · 2018-06-08T05:48:39Z

/morph build

mbed-ci · 2018-06-08T09:27:15Z

Build : SUCCESS

Build number : 2282
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6935/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

Make multiticker test more reliable when scheduling very early interrupts. When very early interrupt is scheduled (e.g now + 2[ticks]) then it's likely that it won't be fired in some circumstances and as a result there is overdue event in queue. That overdue event can be mistakenly scheduled again by `Ticker::detach` (detach calls schedule if head was removed). That's why we should check interrupts counter immediately after wait period and before detach loop

cmonr · 2018-06-08T15:53:59Z

Pausing CI until 5.9 RC3 completes CI. Will restart jobs when able.

mbed-ci · 2018-06-08T16:28:50Z

Exporter Build : SUCCESS

Build number : 1904
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/6935/

cmonr · 2018-06-12T03:24:49Z

/morph build

mbed-ci · 2018-06-12T07:58:14Z

Build : SUCCESS

Build number : 2330
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6935/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

mbed-ci · 2018-06-12T10:47:27Z

Exporter Build : SUCCESS

Build number : 1952
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/6935/

mbed-ci · 2018-06-13T12:30:06Z

Test : SUCCESS

Build number : 2110
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/6935/2110

mprse previously approved these changes May 17, 2018

View reviewed changes

0xc0170 previously approved these changes May 17, 2018

View reviewed changes

0xc0170 added the needs: CI label May 17, 2018

cmonr added the release-version: 5.8.5 label May 17, 2018

0xc0170 added ready for merge and removed needs: CI release-version: 5.8.5 labels May 18, 2018

0xc0170 added needs: preceding PR and removed ready for merge labels May 18, 2018

cmonr added the needs: work label May 29, 2018

maciejbocianski dismissed stale reviews from 0xc0170 and mprse via 7a0a01c May 29, 2018 20:08

maciejbocianski force-pushed the ticker_test_fix branch from 42dea31 to 7a0a01c Compare May 29, 2018 20:08

cmonr added the release-version: 5.9.1 label May 29, 2018

0xc0170 removed the needs: preceding PR label May 30, 2018

maciejbocianski force-pushed the ticker_test_fix branch from 7a0a01c to 45d295d Compare May 30, 2018 09:49

0xc0170 reviewed May 30, 2018

View reviewed changes

0xc0170 previously approved these changes May 30, 2018

View reviewed changes

0xc0170 added needs: review and removed needs: work labels May 30, 2018

0xc0170 requested a review from a team June 6, 2018 13:22

0xc0170 mentioned this pull request Jun 7, 2018

NRF52_DK: SLEEP enable #7073

Merged

jamesbeyond reviewed Jun 7, 2018

View reviewed changes

c1728p9 previously approved these changes Jun 7, 2018

View reviewed changes

maciejbocianski dismissed stale reviews from c1728p9 and 0xc0170 via 27bf6cf June 8, 2018 13:38

maciejbocianski force-pushed the ticker_test_fix branch from 45d295d to 27bf6cf Compare June 8, 2018 13:38

cmonr approved these changes Jun 12, 2018

View reviewed changes

cmonr added needs: CI and removed needs: review labels Jun 12, 2018

0xc0170 added ready for merge and removed needs: CI labels Jun 13, 2018

cmonr merged commit 6999d25 into ARMmbed:master Jun 13, 2018

NirSonnenschein removed the ready for merge label Jun 13, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ticker test improvement #6935

ticker test improvement #6935

maciejbocianski commented May 17, 2018

maciejbocianski commented May 17, 2018

cmonr commented May 17, 2018

bulislaw commented May 17, 2018

mbed-ci commented May 17, 2018

mbed-ci commented May 17, 2018

mbed-ci commented May 17, 2018

cmonr commented May 18, 2018

cmonr commented May 18, 2018

mbed-ci commented May 18, 2018

maciejbocianski commented May 18, 2018

0xc0170 commented May 18, 2018

cmonr commented May 29, 2018

0xc0170 May 30, 2018

maciejbocianski May 30, 2018

jamesbeyond Jun 7, 2018

maciejbocianski Jun 7, 2018

cmonr commented Jun 8, 2018

mbed-ci commented Jun 8, 2018

cmonr commented Jun 8, 2018

mbed-ci commented Jun 8, 2018

cmonr commented Jun 12, 2018

mbed-ci commented Jun 12, 2018

mbed-ci commented Jun 12, 2018

mbed-ci commented Jun 13, 2018

ticker test improvement #6935

ticker test improvement #6935

Conversation

maciejbocianski commented May 17, 2018

Description

Pull request type

maciejbocianski commented May 17, 2018

cmonr commented May 17, 2018

bulislaw commented May 17, 2018

mbed-ci commented May 17, 2018

Triggering tests

mbed-ci commented May 17, 2018

mbed-ci commented May 17, 2018

cmonr commented May 18, 2018

cmonr commented May 18, 2018

mbed-ci commented May 18, 2018

maciejbocianski commented May 18, 2018

0xc0170 commented May 18, 2018

cmonr commented May 29, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cmonr commented Jun 8, 2018

mbed-ci commented Jun 8, 2018

Triggering tests

cmonr commented Jun 8, 2018

mbed-ci commented Jun 8, 2018

cmonr commented Jun 12, 2018

mbed-ci commented Jun 12, 2018

Triggering tests

mbed-ci commented Jun 12, 2018

mbed-ci commented Jun 13, 2018