mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 22:00:58 +00:00
830d5d1ac0
Changes the SystemClock C Api to:
1) Use a pw_chrono_SystemClock_Duration struct instead of aliasing
an int64_t under pw_chrono_SystemClock_TickCount which could
accidentally permit direct tick usage.
2) Add PW_SYSTEM_CLOCK_{MS,S,MIN,H} and
PW_SYSTEM_CLOCK_{MS,S,MIN,H}_CEIL to permit C API users to
create durations which round up to the nearest tick for deadlines
and timeouts, mirroring std::chrono::ceil.
3) Add PW_SYSTEM_CLOCK_{MS,S,MIN,H}_FLOOR to permit C API users to
create durations which round down to the nearest tick for oddball
corner cases, mirroring std::chrono::floor.
4) In order to enable said macros, the system_clock_config.h backend
config was changed to require the clock period as a preprocessor
defines instead of a std::ratio<>.
5) Renames pw_chrono_SystemClock_TimeDelta to
pw_chrono_SystemClock_TimeElapsed to make the argument ordering
make more sense.
6) Changes existing std::chrono::duration_cast usage to
std::chrono::ceil and std::chrono:floor to set a good example
to be explicit on rounding.
7) Renames pw_chrono_SystemClock_TickCountsToNsTruncate accordingly to
pw_chrono_SystemClock_DurationToNsFloor.
Requires: pigweed-internal:9340
Change-Id: Ia628dceac53f964eda7c4aacd3d790b8b0e92207
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/31280
Commit-Queue: Ewout van Bekkum <ewout@google.com>
Reviewed-by: Wyatt Hepler <hepler@google.com>
91 lines
3.1 KiB
C++
91 lines
3.1 KiB
C++
// Copyright 2020 The Pigweed Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|
// use this file except in compliance with the License. You may obtain a copy of
|
|
// the License at
|
|
//
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
// License for the specific language governing permissions and limitations under
|
|
// the License.
|
|
|
|
#include <chrono>
|
|
|
|
#include "gtest/gtest.h"
|
|
#include "pw_chrono/system_clock.h"
|
|
#include "pw_thread/id.h"
|
|
#include "pw_thread/sleep.h"
|
|
|
|
using pw::chrono::SystemClock;
|
|
using namespace std::chrono_literals;
|
|
|
|
namespace pw::this_thread {
|
|
namespace {
|
|
|
|
extern "C" {
|
|
|
|
// Functions defined in sleep_facade_test_c.c which call the API from C.
|
|
void pw_this_thread_CallSleepFor(pw_chrono_SystemClock_Duration for_at_least);
|
|
void pw_this_thread_CallSleepUntil(
|
|
pw_chrono_SystemClock_TimePoint until_at_least);
|
|
|
|
} // extern "C"
|
|
|
|
// We can't control the SystemClock's period configuration, so just in case
|
|
// duration cannot be accurately expressed in integer ticks, round the
|
|
// duration w/ ceil.
|
|
constexpr auto kRoundedArbitraryDuration =
|
|
std::chrono::ceil<SystemClock::duration>(42ms);
|
|
constexpr pw_chrono_SystemClock_Duration kRoundedArbitraryDurationInC =
|
|
PW_SYSTEM_CLOCK_MS(42);
|
|
|
|
TEST(Sleep, SleepFor) {
|
|
// Ensure we are in a thread context, meaning we are permitted to sleep.
|
|
ASSERT_NE(get_id(), thread::Id());
|
|
|
|
const SystemClock::time_point before = SystemClock::now();
|
|
sleep_for(kRoundedArbitraryDuration);
|
|
const SystemClock::duration time_elapsed = SystemClock::now() - before;
|
|
EXPECT_GE(time_elapsed, kRoundedArbitraryDuration);
|
|
}
|
|
|
|
TEST(Sleep, SleepUntil) {
|
|
// Ensure we are in a thread context, meaning we are permitted to sleep.
|
|
ASSERT_NE(get_id(), thread::Id());
|
|
|
|
const SystemClock::time_point deadline =
|
|
SystemClock::now() + kRoundedArbitraryDuration;
|
|
sleep_until(deadline);
|
|
EXPECT_GE(SystemClock::now(), deadline);
|
|
}
|
|
|
|
TEST(Sleep, SleepForInC) {
|
|
// Ensure we are in a thread context, meaning we are permitted to sleep.
|
|
ASSERT_NE(get_id(), thread::Id());
|
|
|
|
pw_chrono_SystemClock_TimePoint before = pw_chrono_SystemClock_Now();
|
|
pw_this_thread_SleepFor(kRoundedArbitraryDurationInC);
|
|
pw_chrono_SystemClock_Duration time_elapsed =
|
|
pw_chrono_SystemClock_TimeElapsed(before, pw_chrono_SystemClock_Now());
|
|
EXPECT_GE(time_elapsed.ticks, kRoundedArbitraryDurationInC.ticks);
|
|
}
|
|
|
|
TEST(Sleep, SleepUntilInC) {
|
|
// Ensure we are in a thread context, meaning we are permitted to sleep.
|
|
ASSERT_NE(get_id(), thread::Id());
|
|
|
|
pw_chrono_SystemClock_TimePoint deadline;
|
|
deadline.duration_since_epoch.ticks =
|
|
pw_chrono_SystemClock_Now().duration_since_epoch.ticks +
|
|
kRoundedArbitraryDurationInC.ticks;
|
|
pw_this_thread_CallSleepUntil(deadline);
|
|
EXPECT_GE(pw_chrono_SystemClock_Now().duration_since_epoch.ticks,
|
|
deadline.duration_since_epoch.ticks);
|
|
}
|
|
|
|
} // namespace
|
|
} // namespace pw::this_thread
|