Update sleep manager tests #7582

fkjagodzinski · 2018-07-23T15:29:04Z

Description

Extended tests-mbed_hal-sleep_manager with:

deep sleep lock/unlock,
deep sleep locked USHRT_MAX times,
deep sleep locked more than USHRT_MAX times,
deep sleep unbalanced unlock,
sleep_auto calls sleep/deep sleep based on lock,
deep sleep lock/unlock test_check.

Updated tests-mbed_hal-sleep_manager and tests-mbed_hal-sleep_manager_racecondition test case docs and moved them to test header files.

Pull request type

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

CC @c1728p9 @mprse @jamesbeyond @0xc0170

fkjagodzinski · 2018-07-23T15:37:52Z

TESTS/mbed_hal/sleep_manager/main.cpp

+{
+    GREENTEA_SETUP(10, "default_auto");
+    // Suspend the RTOS kernel scheduler to prevent any OS interference.
+    osKernelSuspend();


NOTE:
As @mprse pointed out, when #7524 is merged, this wait should be added here.

#if DEVICE_LPTICKER && (LPTICKER_DELAY_TICKS > 0) // After the OS is disabled wait until the microsecond timer // is no longer in use by the lp ticker wrapper code. // This prevents the low power ticker wrapper code from // getting stuck in a state where it is waiting for // the microsecond Timeout to run. while (lp_ticker_get_timeout_pending()); #endif

fkjagodzinski · 2018-07-23T16:11:53Z

platform/mbed_power_mgmt.h

 * This function is IRQ and thread safe
+ * Verified by ::sleep_manager_multithread_test and ::sleep_manager_irq_test


@0xc0170 Is this way of referring tests acceptable? Or should I rather insert a separate defined/undefined behaviour section, e.g. as seen in the ticker API?

mbed-os/hal/us_ticker_api.h

Lines 60 to 87 in 5d5ca62

* Low level interface to the ticker of a target

*

* # Defined behavior

* * The function ticker_init is safe to call repeatedly - Verified by test ::ticker_init_test

* * The function ticker_init allows the ticker to keep counting and disables the ticker interrupt - Verified by test ::ticker_init_test

* * Ticker frequency is non-zero and counter is at least 8 bits - Verified by ::ticker_info_test

* * The ticker rolls over at (1 << bits) and continues counting starting from 0 - Verified by ::ticker_overflow_test

* * The ticker counts at the specified frequency +- 10% - Verified by ::ticker_frequency_test

* * The ticker increments by 1 each tick - Verified by ::ticker_increment_test

* * The ticker interrupt fires only when the ticker times increments to or past the value set by ticker_set_interrupt.

* Verified by ::ticker_interrupt_test and ::ticker_past_test

* * It is safe to call ticker_set_interrupt repeatedly before the handler is called - Verified by ::ticker_repeat_reschedule_test

* * The function ticker_fire_interrupt causes ticker_irq_handler to be called immediately from interrupt context -

* Verified by ::ticker_fire_now_test

* * The ticker operations ticker_read, ticker_clear_interrupt, ticker_set_interrupt and ticker_fire_interrupt

* take less than 20us to complete - Verified by ::ticker_speed_test

*

* # Undefined behavior

* * Calling any function other than ticker_init before the initialization of the ticker

* * Whether ticker_irq_handler is called a second time if the time wraps and matches the value set by ticker_set_interrupt again

* * Calling ticker_set_interrupt with a value that has more than the supported number of bits

* * Calling any function other than us_ticker_init after calling us_ticker_free

*

* # Potential bugs

* * Drift due to reschedule - Verified by ::ticker_repeat_reschedule_test

* * Incorrect overflow handling of timers - Verified by ::ticker_overflow_test

* * Interrupting at a time of 0 - Verified by ::ticker_overflow_test

* * Interrupt triggered more than once - Verified by ::ticker_interrupt_test

I assume as its in ticker (defined behavior + how it is verified)

I created a new doxygen section for defined behavior.

0xc0170 · 2018-07-24T09:35:19Z

hal/mbed_sleep_manager.c

@@ -162,6 +162,7 @@ void sleep_manager_lock_deep_sleep_internal(void)
    if (deep_sleep_lock == USHRT_MAX) {
        core_util_critical_section_exit();
        MBED_ERROR1(MBED_MAKE_ERROR(MBED_MODULE_HAL, MBED_ERROR_CODE_OVERFLOW), "DeepSleepLock overflow (> USHRT_MAX)", deep_sleep_lock);
+        return; // Handle overridden mbed_error(), i.e. when running sleep_manager tests.


This return was added so while running tests, it would immediately return instead of continue (does not trap)?

Yes, since I overridden mbed_error() for test purposes and now it does not halt, I had to add this return to prevent execution of following lines -- changing the value of deep_sleep_lock var.

0xc0170 · 2018-07-24T09:39:51Z

TESTS/mbed_hal/sleep_manager/main.cpp

+    us_diff2 = ticker_read_us(us_ticker) - us_ts;
+    lp_diff2 = ticker_read_us(lp_ticker) - lp_ts;
+
+    TEST_ASSERT_MESSAGE(us_diff2 < lp_diff2 / 4, "Deep sleep mode not used when unlocked");


where does 4 come from? what are these 2 lines testing ?

Now I can see, I didn't provide much explanation here; will add more verbose comments.
This test relies on the fact that us tickers are powered off during deep sleep, and lp tickers stay on for both sleep and deepsleep. The type of sleep that was actually used can be checked by comparing time measured by us and lp tickers.

4 is an arbitrary value. Test checks if us ticker incremented at most 25% of lp ticker time.

Please update with comments

Comments added.

0xc0170 · 2018-07-24T09:43:57Z

Please review travis docs failure

fkjagodzinski · 2018-07-25T16:36:50Z

Doxygen generates fine locally, so travis should also be happy with updated code.

cmonr · 2018-07-30T16:07:55Z

@0xc0170 @bulislaw @ARMmbed/mbed-os-test Mind re-reviewing?

jamesbeyond

LGTM

fkjagodzinski · 2018-08-10T09:18:15Z

@0xc0170 @bulislaw @c1728p9 could you take a look at this PR?

fkjagodzinski · 2018-08-10T10:06:06Z

I noticed there was a conflict due to recent astyle update on TESTS dir, so I rebased changes onto current master and update the files using astyle locally.

Although there are no conflicts at the moment, I think this PR could wait for #7524. Both update sleep_manager test files but #7524 looks to be further in the pipeline.

0xc0170 · 2018-08-22T12:25:49Z

Although there are no conflicts at the moment, I think this PR could wait for #7524. Both update sleep_manager test files but #7524 looks to be further in the pipeline.

Already integrated.

Please rebase to resolve the conflict

mbed-ci · 2018-09-28T19:38:58Z

Exporter Build : SUCCESS

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

mbed-ci · 2018-09-28T21:12:33Z

Test : FAILURE

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

fkjagodzinski · 2018-10-01T09:23:57Z

Waiting for PR #8279 which will fix the last issue.

New test cases: * "deep sleep lock/unlock" * "deep sleep unbalanced unlock" * "deep sleep locked USHRT_MAX times" * "deep sleep locked more than USHRT_MAX times" * "sleep_auto calls sleep/deep sleep based on lock"

Move sleep manager API into its own doxygen group. Add defined behavior section and links to tests.

sleep_manager_can_deep_sleep_test_check() is intended to be used in test code.

Use ticker init functions from upper HAL layer to allow proper handling of ticker overflows.

Increase delta to 500 us. This value is still short enough to detect incorrect behavior of the sleep_manager_can_deep_sleep_test_check() fun, but allows the targets with low LP timer accuracy to pass, i.e. NUCLEO_F429ZI.

Move a few of utility functions so other tests can use them.

Use us & lp tickers directly, without the common ticker layer.

fkjagodzinski · 2018-10-09T16:03:51Z

Update:

rebased to master,
updated sleep_auto calls sleep/deep sleep based on lock test case to use lp and us tickers directly, with upper ticker layer and LowPowerTickerWrapper suspended -- no need to wait for the outcome of Low power ticker wrapper layer still used when suspended #8278

PR is ready for morph tests again.

0xc0170 · 2018-10-09T23:37:19Z

/morph build

mbed-ci · 2018-10-10T01:22:22Z

Build : SUCCESS

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

Triggering tests

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

mbed-ci · 2018-10-10T02:57:09Z

Exporter Build : SUCCESS

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

mbed-ci · 2018-10-10T10:44:29Z

Test : SUCCESS

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

fkjagodzinski commented Jul 23, 2018

View reviewed changes

cmonr requested review from bulislaw and 0xc0170 July 24, 2018 04:14

cmonr added the needs: review label Jul 24, 2018

0xc0170 reviewed Jul 24, 2018

View reviewed changes

0xc0170 added needs: work and removed needs: review labels Jul 25, 2018

0xc0170 requested a review from a team July 25, 2018 11:37

fkjagodzinski force-pushed the test_update-sleep_manager branch from 568daed to 10d687d Compare July 25, 2018 16:31

cmonr added the needs: preceding PR label Jul 26, 2018

fkjagodzinski mentioned this pull request Jul 30, 2018

Fixes for tickless and LPTICKER_DELAY_TICKS #7524

Merged

cmonr removed the needs: preceding PR label Jul 30, 2018

cmonr requested a review from c1728p9 July 30, 2018 16:08

cmonr added needs: review and removed needs: work labels Jul 30, 2018

jamesbeyond approved these changes Jul 31, 2018

View reviewed changes

cmonr added the release-version: 5.9.5 label Jul 31, 2018

cmonr removed the release-version: 5.9.5 label Aug 9, 2018

fkjagodzinski force-pushed the test_update-sleep_manager branch from 10d687d to b59ef18 Compare August 10, 2018 09:50

cmonr added needs: work needs: preceding PR and removed needs: review labels Aug 14, 2018

c1728p9 approved these changes Aug 15, 2018

View reviewed changes

cmonr added needs: work and removed needs: CI labels Sep 28, 2018

This was referenced Oct 2, 2018

All STM should have tickless mode enabled #7153

Closed

unstable test - tests-mbedmicro-rtos-mbed-queue on NUCLEO_F746ZG #8320

Closed

Filip Jagodzinski added 8 commits October 9, 2018 17:52

Tests: SleepManager: extend test suite

f2c222b

New test cases: * "deep sleep lock/unlock" * "deep sleep unbalanced unlock" * "deep sleep locked USHRT_MAX times" * "deep sleep locked more than USHRT_MAX times" * "sleep_auto calls sleep/deep sleep based on lock"

Tests: SleepManager: update concurrent test docs

43c22e4

HAL: SleepManager: Update header file

9dce8b3

Move sleep manager API into its own doxygen group. Add defined behavior section and links to tests.

Tests: SleepManager: Add test for new check() fun

83745b9

sleep_manager_can_deep_sleep_test_check() is intended to be used in test code.

Tests: SleepManager: Fix test suite setup

17e2961

Use ticker init functions from upper HAL layer to allow proper handling of ticker overflows.

Tests: SleepManager: Update test_check() test

f415af8

Increase delta to 500 us. This value is still short enough to detect incorrect behavior of the sleep_manager_can_deep_sleep_test_check() fun, but allows the targets with low LP timer accuracy to pass, i.e. NUCLEO_F429ZI.

Tests: Sleep: Extract test utility functions

9e34f76

Move a few of utility functions so other tests can use them.

Tests: SleepManager: Fix sleep_auto test

3fcd8c4

Use us & lp tickers directly, without the common ticker layer.

fkjagodzinski force-pushed the test_update-sleep_manager branch from 77f9f25 to 3fcd8c4 Compare October 9, 2018 15:55

cmonr added needs: CI and removed needs: work labels Oct 9, 2018

0xc0170 added the release-version: 5.10.2 label Oct 9, 2018

cmonr added ready for merge and removed needs: CI labels Oct 10, 2018

cmonr merged commit 9deefe5 into ARMmbed:master Oct 10, 2018

cmonr removed the ready for merge label Oct 10, 2018

fkjagodzinski deleted the test_update-sleep_manager branch October 11, 2018 06:44

amq mentioned this pull request Feb 5, 2020

EFM32: sleep manager test fails #12373

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update sleep manager tests #7582

Update sleep manager tests #7582

fkjagodzinski commented Jul 23, 2018 •

edited

Loading

fkjagodzinski Jul 23, 2018 •

edited

Loading

fkjagodzinski Jul 23, 2018

0xc0170 Jul 24, 2018

fkjagodzinski Jul 25, 2018

0xc0170 Jul 24, 2018

fkjagodzinski Jul 24, 2018

0xc0170 Jul 24, 2018

fkjagodzinski Jul 24, 2018

0xc0170 Jul 25, 2018

fkjagodzinski Jul 25, 2018

0xc0170 commented Jul 24, 2018

fkjagodzinski commented Jul 25, 2018

cmonr commented Jul 30, 2018

jamesbeyond left a comment

fkjagodzinski commented Aug 10, 2018

fkjagodzinski commented Aug 10, 2018

0xc0170 commented Aug 22, 2018

mbed-ci commented Sep 28, 2018

mbed-ci commented Sep 28, 2018

fkjagodzinski commented Oct 1, 2018

fkjagodzinski commented Oct 9, 2018

0xc0170 commented Oct 9, 2018

mbed-ci commented Oct 10, 2018

mbed-ci commented Oct 10, 2018

mbed-ci commented Oct 10, 2018

		* This function is IRQ and thread safe
		* Verified by ::sleep_manager_multithread_test and ::sleep_manager_irq_test

	* Low level interface to the ticker of a target
	*
	* # Defined behavior
	* * The function ticker_init is safe to call repeatedly - Verified by test ::ticker_init_test
	* * The function ticker_init allows the ticker to keep counting and disables the ticker interrupt - Verified by test ::ticker_init_test
	* * Ticker frequency is non-zero and counter is at least 8 bits - Verified by ::ticker_info_test
	* * The ticker rolls over at (1 << bits) and continues counting starting from 0 - Verified by ::ticker_overflow_test
	* * The ticker counts at the specified frequency +- 10% - Verified by ::ticker_frequency_test
	* * The ticker increments by 1 each tick - Verified by ::ticker_increment_test
	* * The ticker interrupt fires only when the ticker times increments to or past the value set by ticker_set_interrupt.
	* Verified by ::ticker_interrupt_test and ::ticker_past_test
	* * It is safe to call ticker_set_interrupt repeatedly before the handler is called - Verified by ::ticker_repeat_reschedule_test
	* * The function ticker_fire_interrupt causes ticker_irq_handler to be called immediately from interrupt context -
	* Verified by ::ticker_fire_now_test
	* * The ticker operations ticker_read, ticker_clear_interrupt, ticker_set_interrupt and ticker_fire_interrupt
	* take less than 20us to complete - Verified by ::ticker_speed_test
	*
	* # Undefined behavior
	* * Calling any function other than ticker_init before the initialization of the ticker
	* * Whether ticker_irq_handler is called a second time if the time wraps and matches the value set by ticker_set_interrupt again
	* * Calling ticker_set_interrupt with a value that has more than the supported number of bits
	* * Calling any function other than us_ticker_init after calling us_ticker_free
	*
	* # Potential bugs
	* * Drift due to reschedule - Verified by ::ticker_repeat_reschedule_test
	* * Incorrect overflow handling of timers - Verified by ::ticker_overflow_test
	* * Interrupting at a time of 0 - Verified by ::ticker_overflow_test
	* * Interrupt triggered more than once - Verified by ::ticker_interrupt_test

Update sleep manager tests #7582

Update sleep manager tests #7582

Conversation

fkjagodzinski commented Jul 23, 2018 • edited Loading

Description

Pull request type

fkjagodzinski Jul 23, 2018 • edited Loading

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xc0170 commented Jul 24, 2018

fkjagodzinski commented Jul 25, 2018

cmonr commented Jul 30, 2018

jamesbeyond left a comment

Choose a reason for hiding this comment

fkjagodzinski commented Aug 10, 2018

fkjagodzinski commented Aug 10, 2018

0xc0170 commented Aug 22, 2018

mbed-ci commented Sep 28, 2018

mbed-ci commented Sep 28, 2018

fkjagodzinski commented Oct 1, 2018

fkjagodzinski commented Oct 9, 2018

0xc0170 commented Oct 9, 2018

mbed-ci commented Oct 10, 2018

Triggering tests

mbed-ci commented Oct 10, 2018

mbed-ci commented Oct 10, 2018

fkjagodzinski commented Jul 23, 2018 •

edited

Loading

fkjagodzinski Jul 23, 2018 •

edited

Loading