-
Notifications
You must be signed in to change notification settings - Fork 13.3k
[Breaking] New polledtimeout #7960
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
devyte
wants to merge
6
commits into
esp8266:master
Choose a base branch
from
devyte:polledtimeout2
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5bc0f45
Restructure polledtimeout, simplify namespaces
devyte 213aad9
Rename to uppercase
devyte e73c0d9
Fix test
devyte 30de8aa
new methods, change expired to not execute the yield policy when expi…
devyte 4317abe
Merge branch 'master' into polledtimeout2
devyte 6269185
Fix polledtimeout declaration
devyte File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,309 +1,85 @@ | ||
| #ifndef __POLLEDTIMING_H__ | ||
| #define __POLLEDTIMING_H__ | ||
| #ifndef __POLLEDTIMEOUT_H__ | ||
| #define __POLLEDTIMEOUT_H__ | ||
|
|
||
|
|
||
| /* | ||
| PolledTimeout.h - Encapsulation of a polled Timeout | ||
|
|
||
| Copyright (c) 2018 Daniel Salazar. All rights reserved. | ||
| This file is part of the esp8266 core for Arduino environment. | ||
| #include <PolledTimeoutPolicies.h> | ||
|
|
||
| This library is free software; you can redistribute it and/or | ||
| modify it under the terms of the GNU Lesser General Public | ||
| License as published by the Free Software Foundation; either | ||
| version 2.1 of the License, or (at your option) any later version. | ||
| namespace TimePolicy | ||
| { | ||
|
|
||
| This library is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| Lesser General Public License for more details. | ||
| using TimeMillis = TimeUnit< TimeSourcePolicy::TimeSourceMillis, 1000 >; | ||
|
|
||
| } //TimePolicy | ||
|
|
||
| You should have received a copy of the GNU Lesser General Public | ||
| License along with this library; if not, write to the Free Software | ||
| Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | ||
| */ | ||
|
|
||
| #include <c_types.h> // IRAM_ATTR | ||
| #include <limits> // std::numeric_limits | ||
| #include <type_traits> // std::is_unsigned | ||
| #include <core_esp8266_features.h> | ||
|
|
||
| namespace esp8266 | ||
| namespace PolledTimeout | ||
| { | ||
| //Construction of types using the policies | ||
|
|
||
| // legacy type names, deprecated (unit is milliseconds) | ||
| using oneShot = TimeoutTemplate<false, YieldPolicy::DoNothing, TimePolicy::TimeMillis>; | ||
| using periodic = TimeoutTemplate<true, YieldPolicy::DoNothing, TimePolicy::TimeMillis>; | ||
|
|
||
| namespace polledTimeout | ||
| { | ||
| // standard versions (based on millis()) | ||
| // timeMax() is 49.7 days ((2^32)-2 ms) | ||
| using oneShotMs = TimeoutTemplate<false, YieldPolicy::DoNothing, TimePolicy::TimeMillis>; | ||
| using periodicMs = TimeoutTemplate<true, YieldPolicy::DoNothing, TimePolicy::TimeMillis>; | ||
|
|
||
| } //PolledTimeout | ||
|
|
||
| namespace YieldPolicy | ||
| { | ||
|
|
||
| struct DoNothing | ||
| { | ||
| static void execute() {} | ||
| }; | ||
|
|
||
| struct YieldOrSkip | ||
| { | ||
| static void execute() {delay(0);} | ||
| }; | ||
|
|
||
| template <unsigned long delayMs> | ||
| struct YieldAndDelayMs | ||
| { | ||
| static void execute() {delay(delayMs);} | ||
| }; | ||
|
|
||
| } //YieldPolicy | ||
| #include <PolledTimeoutPolicies_esp8266.h> | ||
|
|
||
| namespace TimePolicy | ||
| { | ||
|
|
||
| using TimeFastMillis = TimeUnit< TimeSourcePolicy::TimeSourceCycles, 1000 >; | ||
| using TimeFastMicros = TimeUnit< TimeSourcePolicy::TimeSourceCycles, 1000000 >; | ||
| using TimeFastNanos = TimeUnit< TimeSourcePolicy::TimeSourceCycles, 1000000000 >; | ||
|
|
||
| struct TimeSourceMillis | ||
| { | ||
| // time policy in milli-seconds based on millis() | ||
| } //TimePolicy | ||
|
|
||
| using timeType = decltype(millis()); | ||
| static timeType time() {return millis();} | ||
| static constexpr timeType ticksPerSecond = 1000; | ||
| static constexpr timeType ticksPerSecondMax = 1000; | ||
| }; | ||
|
|
||
| struct TimeSourceCycles | ||
| { | ||
| // time policy based on esp_get_cycle_count() | ||
| // this particular time measurement is intended to be called very often | ||
| // (every loop, every yield) | ||
|
|
||
| using timeType = decltype(esp_get_cycle_count()); | ||
| static timeType time() {return esp_get_cycle_count();} | ||
| static constexpr timeType ticksPerSecond = esp_get_cpu_freq_mhz() * 1000000UL; // 80'000'000 or 160'000'000 Hz | ||
| static constexpr timeType ticksPerSecondMax = 160000000; // 160MHz | ||
| }; | ||
|
|
||
| template <typename TimeSourceType, unsigned long long second_th> | ||
| // "second_th" units of timeType for one second | ||
| struct TimeUnit | ||
|
|
||
|
|
||
| namespace PolledTimeout | ||
| { | ||
| using timeType = typename TimeSourceType::timeType; | ||
|
|
||
| #if __GNUC__ < 5 | ||
| // gcc-4.8 cannot compile the constexpr-only version of this function | ||
| // using #defines instead luckily works | ||
| static constexpr timeType computeRangeCompensation () | ||
| { | ||
| #define number_of_secondTh_in_one_tick ((1.0 * second_th) / ticksPerSecond) | ||
| #define fractional (number_of_secondTh_in_one_tick - (long)number_of_secondTh_in_one_tick) | ||
|
|
||
| return ({ | ||
| fractional == 0? | ||
| 1: // no need for compensation | ||
| (number_of_secondTh_in_one_tick / fractional) + 0.5; // scalar multiplier allowing exact division | ||
| }); | ||
|
|
||
| #undef number_of_secondTh_in_one_tick | ||
| #undef fractional | ||
| } | ||
| #else | ||
| static constexpr timeType computeRangeCompensation () | ||
| { | ||
| return ({ | ||
| constexpr double number_of_secondTh_in_one_tick = (1.0 * second_th) / ticksPerSecond; | ||
| constexpr double fractional = number_of_secondTh_in_one_tick - (long)number_of_secondTh_in_one_tick; | ||
| fractional == 0? | ||
| 1: // no need for compensation | ||
| (number_of_secondTh_in_one_tick / fractional) + 0.5; // scalar multiplier allowing exact division | ||
| }); | ||
| } | ||
| #endif | ||
| //Construction of types using the policies | ||
|
|
||
| static constexpr timeType ticksPerSecond = TimeSourceType::ticksPerSecond; | ||
| static constexpr timeType ticksPerSecondMax = TimeSourceType::ticksPerSecondMax; | ||
| static constexpr timeType rangeCompensate = computeRangeCompensation(); | ||
| static constexpr timeType user2UnitMultiplierMax = (ticksPerSecondMax * rangeCompensate) / second_th; | ||
| static constexpr timeType user2UnitMultiplier = (ticksPerSecond * rangeCompensate) / second_th; | ||
| static constexpr timeType user2UnitDivider = rangeCompensate; | ||
| // std::numeric_limits<timeType>::max() is reserved | ||
| static constexpr timeType timeMax = (std::numeric_limits<timeType>::max() - 1) / user2UnitMultiplierMax; | ||
|
|
||
| static timeType toTimeTypeUnit (const timeType userUnit) {return (userUnit * user2UnitMultiplier) / user2UnitDivider;} | ||
| static timeType toUserUnit (const timeType internalUnit) {return (internalUnit * user2UnitDivider) / user2UnitMultiplier;} | ||
| static timeType time () {return TimeSourceType::time();} | ||
| }; | ||
|
|
||
| using TimeMillis = TimeUnit< TimeSourceMillis, 1000 >; | ||
| using TimeFastMillis = TimeUnit< TimeSourceCycles, 1000 >; | ||
| using TimeFastMicros = TimeUnit< TimeSourceCycles, 1000000 >; | ||
| using TimeFastNanos = TimeUnit< TimeSourceCycles, 1000000000 >; | ||
|
|
||
| } //TimePolicy | ||
| // Time policy based on esp_get_cycle_count(), and intended to be called very often: | ||
| // "Fast" versions sacrifices time range for improved precision and reduced execution time (by 86%) | ||
| // (cpu cycles for ::expired(): 372 (millis()) vs 52 (esp_get_cycle_count())) | ||
| // timeMax() values: | ||
| // Ms: max is 26843 ms (26.8 s) | ||
| // Us: max is 26843545 us (26.8 s) | ||
| // Ns: max is 1073741823 ns ( 1.07 s) | ||
| // (time policy based on esp_get_cycle_count() is intended to be called very often) | ||
|
|
||
| template <bool PeriodicT, typename YieldPolicyT = YieldPolicy::DoNothing, typename TimePolicyT = TimePolicy::TimeMillis> | ||
| class timeoutTemplate | ||
| { | ||
| public: | ||
| using timeType = typename TimePolicyT::timeType; | ||
| static_assert(std::is_unsigned<timeType>::value == true, "timeType must be unsigned"); | ||
|
|
||
| static constexpr timeType alwaysExpired = 0; | ||
| static constexpr timeType neverExpires = std::numeric_limits<timeType>::max(); | ||
| static constexpr timeType rangeCompensate = TimePolicyT::rangeCompensate; //debug | ||
|
|
||
| timeoutTemplate(const timeType userTimeout) | ||
| { | ||
| reset(userTimeout); | ||
| } | ||
|
|
||
| IRAM_ATTR // fast | ||
| bool expired() | ||
| { | ||
| YieldPolicyT::execute(); //in case of DoNothing: gets optimized away | ||
| if(PeriodicT) //in case of false: gets optimized away | ||
| return expiredRetrigger(); | ||
| return expiredOneShot(); | ||
| } | ||
|
|
||
| IRAM_ATTR // fast | ||
| operator bool() | ||
| { | ||
| return expired(); | ||
| } | ||
|
|
||
| bool canExpire () const | ||
| { | ||
| return !_neverExpires; | ||
| } | ||
|
|
||
| bool canWait () const | ||
| { | ||
| return _timeout != alwaysExpired; | ||
| } | ||
|
|
||
| // Resets, will trigger after this new timeout. | ||
| IRAM_ATTR // called from ISR | ||
| void reset(const timeType newUserTimeout) | ||
| { | ||
| reset(); | ||
| _timeout = TimePolicyT::toTimeTypeUnit(newUserTimeout); | ||
| _neverExpires = (newUserTimeout < 0) || (newUserTimeout > timeMax()); | ||
| } | ||
|
|
||
| // Resets, will trigger after the timeout previously set. | ||
| IRAM_ATTR // called from ISR | ||
| void reset() | ||
| { | ||
| _start = TimePolicyT::time(); | ||
| } | ||
|
|
||
| // Resets to just expired so that on next poll the check will immediately trigger for the user, | ||
| // also change timeout (after next immediate trigger). | ||
| IRAM_ATTR // called from ISR | ||
| void resetAndSetExpired (const timeType newUserTimeout) | ||
| { | ||
| reset(newUserTimeout); | ||
| _start -= _timeout; | ||
| } | ||
|
|
||
| // Resets to just expired so that on next poll the check will immediately trigger for the user. | ||
| IRAM_ATTR // called from ISR | ||
| void resetAndSetExpired () | ||
| { | ||
| reset(); | ||
| _start -= _timeout; | ||
| } | ||
|
|
||
| void resetToNeverExpires () | ||
| { | ||
| _timeout = alwaysExpired + 1; // because canWait() has precedence | ||
| _neverExpires = true; | ||
| } | ||
|
|
||
| timeType getTimeout() const | ||
| { | ||
| return TimePolicyT::toUserUnit(_timeout); | ||
| } | ||
|
|
||
| static constexpr timeType timeMax() | ||
| { | ||
| return TimePolicyT::timeMax; | ||
| } | ||
|
|
||
| private: | ||
|
|
||
| IRAM_ATTR // fast | ||
| bool checkExpired(const timeType internalUnit) const | ||
| { | ||
| // canWait() is not checked here | ||
| // returns "can expire" and "time expired" | ||
| return (!_neverExpires) && ((internalUnit - _start) >= _timeout); | ||
| } | ||
|
|
||
| protected: | ||
|
|
||
| IRAM_ATTR // fast | ||
| bool expiredRetrigger() | ||
| { | ||
| if (!canWait()) | ||
| return true; | ||
|
|
||
| timeType current = TimePolicyT::time(); | ||
| if(checkExpired(current)) | ||
| { | ||
| unsigned long n = (current - _start) / _timeout; //how many _timeouts periods have elapsed, will usually be 1 (current - _start >= _timeout) | ||
| _start += n * _timeout; | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| IRAM_ATTR // fast | ||
| bool expiredOneShot() const | ||
| { | ||
| // returns "always expired" or "has expired" | ||
| return !canWait() || checkExpired(TimePolicyT::time()); | ||
| } | ||
|
|
||
| timeType _timeout; | ||
| timeType _start; | ||
| bool _neverExpires; | ||
| }; | ||
|
|
||
| // legacy type names, deprecated (unit is milliseconds) | ||
|
|
||
| using oneShot = polledTimeout::timeoutTemplate<false> /*__attribute__((deprecated("use oneShotMs")))*/; | ||
| using periodic = polledTimeout::timeoutTemplate<true> /*__attribute__((deprecated("use periodicMs")))*/; | ||
|
|
||
| // standard versions (based on millis()) | ||
| // timeMax() is 49.7 days ((2^32)-2 ms) | ||
|
|
||
| using oneShotMs = polledTimeout::timeoutTemplate<false>; | ||
| using periodicMs = polledTimeout::timeoutTemplate<true>; | ||
|
|
||
| // Time policy based on esp_get_cycle_count(), and intended to be called very often: | ||
| // "Fast" versions sacrifices time range for improved precision and reduced execution time (by 86%) | ||
| // (cpu cycles for ::expired(): 372 (millis()) vs 52 (esp_get_cycle_count())) | ||
| // timeMax() values: | ||
| // Ms: max is 26843 ms (26.8 s) | ||
| // Us: max is 26843545 us (26.8 s) | ||
| // Ns: max is 1073741823 ns ( 1.07 s) | ||
| // (time policy based on esp_get_cycle_count() is intended to be called very often) | ||
|
|
||
| using oneShotFastMs = polledTimeout::timeoutTemplate<false, YieldPolicy::DoNothing, TimePolicy::TimeFastMillis>; | ||
| using periodicFastMs = polledTimeout::timeoutTemplate<true, YieldPolicy::DoNothing, TimePolicy::TimeFastMillis>; | ||
| using oneShotFastUs = polledTimeout::timeoutTemplate<false, YieldPolicy::DoNothing, TimePolicy::TimeFastMicros>; | ||
| using periodicFastUs = polledTimeout::timeoutTemplate<true, YieldPolicy::DoNothing, TimePolicy::TimeFastMicros>; | ||
| using oneShotFastNs = polledTimeout::timeoutTemplate<false, YieldPolicy::DoNothing, TimePolicy::TimeFastNanos>; | ||
| using periodicFastNs = polledTimeout::timeoutTemplate<true, YieldPolicy::DoNothing, TimePolicy::TimeFastNanos>; | ||
| using oneShotFastMs = TimeoutTemplate<false, YieldPolicy::DoNothing, TimePolicy::TimeFastMillis>; | ||
| using periodicFastMs = TimeoutTemplate<true, YieldPolicy::DoNothing, TimePolicy::TimeFastMillis>; | ||
|
|
||
| using oneShotFastUs = TimeoutTemplate<false, YieldPolicy::DoNothing, TimePolicy::TimeFastMicros>; | ||
| using periodicFastUs = TimeoutTemplate<true, YieldPolicy::DoNothing, TimePolicy::TimeFastMicros>; | ||
|
|
||
| using oneShotFastNs = TimeoutTemplate<false, YieldPolicy::DoNothing, TimePolicy::TimeFastNanos>; | ||
| using periodicFastNs = TimeoutTemplate<true, YieldPolicy::DoNothing, TimePolicy::TimeFastNanos>; | ||
|
|
||
| } //polledTimeout | ||
|
|
||
|
|
||
| /* A 1-shot timeout that auto-yields when in CONT can be built as follows: | ||
| * using oneShotYieldMs = esp8266::polledTimeout::timeoutTemplate<false, esp8266::polledTimeout::YieldPolicy::YieldOrSkip>; | ||
| * using oneShotYieldMs = PolledTimeout::TimeoutTemplate<false, PolledTimeout::YieldPolicy::YieldOrSkip>; | ||
| * | ||
| * Other policies can be implemented by the user, e.g.: simple yield that panics in SYS, and the polledTimeout types built as needed as shown above, without modifying this file. | ||
| */ | ||
|
|
||
| }//esp8266 | ||
|
|
||
|
|
||
|
|
||
| #endif | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are these kept in this breaking change commit ?