2020-11-09 20:46:52 +00:00
|
|
|
// 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_sync/binary_semaphore.h"
|
|
|
|
|
|
|
|
using pw::chrono::SystemClock;
|
pw_chrono: Improve SystemClock C API
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>
2021-01-29 02:58:03 +00:00
|
|
|
using namespace std::chrono_literals;
|
2020-11-09 20:46:52 +00:00
|
|
|
|
|
|
|
namespace pw::sync {
|
|
|
|
namespace {
|
|
|
|
|
|
|
|
extern "C" {
|
|
|
|
|
|
|
|
// Functions defined in binary_semaphore_facade_test_c.c which call the API
|
|
|
|
// from C.
|
|
|
|
void pw_sync_BinarySemaphore_CallRelease(pw_sync_BinarySemaphore* semaphore);
|
|
|
|
void pw_sync_BinarySemaphore_CallAcquire(pw_sync_BinarySemaphore* semaphore);
|
|
|
|
bool pw_sync_BinarySemaphore_CallTryAcquire(pw_sync_BinarySemaphore* semaphore);
|
|
|
|
bool pw_sync_BinarySemaphore_CallTryAcquireFor(
|
2021-09-07 22:46:36 +00:00
|
|
|
pw_sync_BinarySemaphore* semaphore, pw_chrono_SystemClock_Duration timeout);
|
2020-11-09 20:46:52 +00:00
|
|
|
bool pw_sync_BinarySemaphore_CallTryAcquireUntil(
|
|
|
|
pw_sync_BinarySemaphore* semaphore,
|
2021-09-07 22:46:36 +00:00
|
|
|
pw_chrono_SystemClock_TimePoint deadline);
|
2020-11-09 20:46:52 +00:00
|
|
|
ptrdiff_t pw_sync_BinarySemaphore_CallMax(void);
|
|
|
|
|
|
|
|
} // 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
|
2021-03-11 16:55:01 +00:00
|
|
|
// duration up.
|
|
|
|
constexpr SystemClock::duration kRoundedArbitraryDuration =
|
|
|
|
SystemClock::for_at_least(42ms);
|
pw_chrono: Improve SystemClock C API
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>
2021-01-29 02:58:03 +00:00
|
|
|
constexpr pw_chrono_SystemClock_Duration kRoundedArbitraryDurationInC =
|
|
|
|
PW_SYSTEM_CLOCK_MS(42);
|
2020-11-09 20:46:52 +00:00
|
|
|
|
|
|
|
TEST(BinarySemaphore, EmptyInitialState) {
|
|
|
|
BinarySemaphore semaphore;
|
|
|
|
EXPECT_FALSE(semaphore.try_acquire());
|
|
|
|
}
|
|
|
|
|
|
|
|
// TODO(pwbug/291): Add real concurrency tests once we have pw::thread.
|
|
|
|
|
|
|
|
TEST(BinarySemaphore, Release) {
|
|
|
|
BinarySemaphore semaphore;
|
|
|
|
semaphore.release();
|
|
|
|
semaphore.release();
|
|
|
|
semaphore.acquire();
|
|
|
|
// Ensure it fails when empty.
|
|
|
|
EXPECT_FALSE(semaphore.try_acquire());
|
|
|
|
}
|
|
|
|
|
|
|
|
BinarySemaphore empty_initial_semaphore;
|
|
|
|
TEST(BinarySemaphore, EmptyInitialStateStatic) {
|
|
|
|
EXPECT_FALSE(empty_initial_semaphore.try_acquire());
|
|
|
|
}
|
|
|
|
|
|
|
|
BinarySemaphore release_semaphore;
|
|
|
|
TEST(BinarySemaphore, ReleaseStatic) {
|
|
|
|
release_semaphore.release();
|
|
|
|
release_semaphore.release();
|
|
|
|
release_semaphore.acquire();
|
|
|
|
// Ensure it fails when empty.
|
|
|
|
EXPECT_FALSE(release_semaphore.try_acquire());
|
|
|
|
}
|
|
|
|
|
|
|
|
TEST(BinarySemaphore, TryAcquireFor) {
|
|
|
|
BinarySemaphore semaphore;
|
|
|
|
semaphore.release();
|
|
|
|
|
|
|
|
SystemClock::time_point before = SystemClock::now();
|
|
|
|
EXPECT_TRUE(semaphore.try_acquire_for(kRoundedArbitraryDuration));
|
|
|
|
SystemClock::duration time_elapsed = SystemClock::now() - before;
|
|
|
|
EXPECT_LT(time_elapsed, kRoundedArbitraryDuration);
|
|
|
|
|
|
|
|
// Ensure it blocks and fails when empty.
|
|
|
|
before = SystemClock::now();
|
|
|
|
EXPECT_FALSE(semaphore.try_acquire_for(kRoundedArbitraryDuration));
|
|
|
|
time_elapsed = SystemClock::now() - before;
|
|
|
|
EXPECT_GE(time_elapsed, kRoundedArbitraryDuration);
|
|
|
|
}
|
|
|
|
|
|
|
|
TEST(BinarySemaphore, TryAcquireUntil) {
|
|
|
|
BinarySemaphore semaphore;
|
|
|
|
semaphore.release();
|
|
|
|
|
|
|
|
const SystemClock::time_point deadline =
|
|
|
|
SystemClock::now() + kRoundedArbitraryDuration;
|
|
|
|
EXPECT_TRUE(semaphore.try_acquire_until(deadline));
|
|
|
|
EXPECT_LT(SystemClock::now(), deadline);
|
|
|
|
|
|
|
|
// Ensure it blocks and fails when empty.
|
|
|
|
EXPECT_FALSE(semaphore.try_acquire_until(deadline));
|
|
|
|
EXPECT_GE(SystemClock::now(), deadline);
|
|
|
|
}
|
|
|
|
|
|
|
|
TEST(BinarySemaphore, EmptyInitialStateInC) {
|
|
|
|
BinarySemaphore semaphore;
|
|
|
|
EXPECT_FALSE(pw_sync_BinarySemaphore_CallTryAcquire(&semaphore));
|
|
|
|
}
|
|
|
|
|
|
|
|
TEST(BinarySemaphore, ReleaseInC) {
|
|
|
|
BinarySemaphore semaphore;
|
|
|
|
pw_sync_BinarySemaphore_CallRelease(&semaphore);
|
|
|
|
pw_sync_BinarySemaphore_CallRelease(&semaphore);
|
|
|
|
pw_sync_BinarySemaphore_CallAcquire(&semaphore);
|
|
|
|
// Ensure it fails when empty.
|
|
|
|
EXPECT_FALSE(pw_sync_BinarySemaphore_CallTryAcquire(&semaphore));
|
|
|
|
}
|
|
|
|
|
|
|
|
TEST(BinarySemaphore, TryAcquireForInC) {
|
|
|
|
BinarySemaphore semaphore;
|
|
|
|
pw_sync_BinarySemaphore_CallRelease(&semaphore);
|
|
|
|
|
|
|
|
pw_chrono_SystemClock_TimePoint before = pw_chrono_SystemClock_Now();
|
|
|
|
ASSERT_TRUE(pw_sync_BinarySemaphore_CallTryAcquireFor(
|
|
|
|
&semaphore, kRoundedArbitraryDurationInC));
|
pw_chrono: Improve SystemClock C API
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>
2021-01-29 02:58:03 +00:00
|
|
|
pw_chrono_SystemClock_Duration time_elapsed =
|
|
|
|
pw_chrono_SystemClock_TimeElapsed(before, pw_chrono_SystemClock_Now());
|
|
|
|
EXPECT_LT(time_elapsed.ticks, kRoundedArbitraryDurationInC.ticks);
|
2020-11-09 20:46:52 +00:00
|
|
|
|
|
|
|
// Ensure it blocks and fails when empty.
|
|
|
|
before = pw_chrono_SystemClock_Now();
|
|
|
|
EXPECT_FALSE(pw_sync_BinarySemaphore_CallTryAcquireFor(
|
|
|
|
&semaphore, kRoundedArbitraryDurationInC));
|
|
|
|
time_elapsed =
|
pw_chrono: Improve SystemClock C API
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>
2021-01-29 02:58:03 +00:00
|
|
|
pw_chrono_SystemClock_TimeElapsed(before, pw_chrono_SystemClock_Now());
|
|
|
|
EXPECT_GE(time_elapsed.ticks, kRoundedArbitraryDurationInC.ticks);
|
2020-11-09 20:46:52 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
TEST(BinarySemaphore, TryAcquireUntilInC) {
|
|
|
|
BinarySemaphore semaphore;
|
|
|
|
pw_sync_BinarySemaphore_CallRelease(&semaphore);
|
|
|
|
|
|
|
|
pw_chrono_SystemClock_TimePoint deadline;
|
pw_chrono: Improve SystemClock C API
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>
2021-01-29 02:58:03 +00:00
|
|
|
deadline.duration_since_epoch = {
|
|
|
|
.ticks = pw_chrono_SystemClock_Now().duration_since_epoch.ticks +
|
|
|
|
kRoundedArbitraryDurationInC.ticks,
|
|
|
|
};
|
2020-11-09 20:46:52 +00:00
|
|
|
ASSERT_TRUE(
|
|
|
|
pw_sync_BinarySemaphore_CallTryAcquireUntil(&semaphore, deadline));
|
pw_chrono: Improve SystemClock C API
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>
2021-01-29 02:58:03 +00:00
|
|
|
EXPECT_LT(pw_chrono_SystemClock_Now().duration_since_epoch.ticks,
|
|
|
|
deadline.duration_since_epoch.ticks);
|
2020-11-09 20:46:52 +00:00
|
|
|
|
|
|
|
// Ensure it blocks and fails when empty.
|
|
|
|
EXPECT_FALSE(
|
|
|
|
pw_sync_BinarySemaphore_CallTryAcquireUntil(&semaphore, deadline));
|
pw_chrono: Improve SystemClock C API
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>
2021-01-29 02:58:03 +00:00
|
|
|
EXPECT_GE(pw_chrono_SystemClock_Now().duration_since_epoch.ticks,
|
|
|
|
deadline.duration_since_epoch.ticks);
|
2020-11-09 20:46:52 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
TEST(BinarySemaphore, MaxInC) {
|
|
|
|
EXPECT_EQ(BinarySemaphore::max(), pw_sync_BinarySemaphore_Max());
|
|
|
|
}
|
|
|
|
|
|
|
|
} // namespace
|
|
|
|
} // namespace pw::sync
|