1 // Copyright 2022 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 // https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14
15 #include "pw_sync/timed_thread_notification.h"
16
17 #include <chrono>
18 #include <optional>
19
20 #include "FreeRTOS.h"
21 #include "pw_chrono/system_clock.h"
22 #include "pw_thread/non_portable_test_thread_options.h"
23 #include "pw_thread/sleep.h"
24 #include "pw_thread/thread.h"
25 #include "pw_unit_test/framework.h"
26 #include "task.h"
27
28 namespace pw::sync::freertos {
29 namespace {
30
31 using pw::chrono::SystemClock;
32
33 } // namespace
34
35 // These tests are targeted specifically to verify interactions between suspend
36 // and being blocked on direct task notifications and how they impact usage of
37 // the FreeRTOS optimized TimedThreadNotification backend.
38 #if INCLUDE_vTaskSuspend == 1
39
40 class TimedNotificationAcquirer {
41 public:
WaitUntilRunning()42 void WaitUntilRunning() { started_notification_.acquire(); }
Release()43 void Release() { unblock_notification_.release(); }
WaitUntilFinished()44 void WaitUntilFinished() { finished_notification_.acquire(); }
notified_time() const45 std::optional<SystemClock::time_point> notified_time() const {
46 return notified_time_;
47 }
task_handle() const48 TaskHandle_t task_handle() const { return task_handle_; }
49
Run()50 void Run() {
51 task_handle_ = xTaskGetCurrentTaskHandle();
52 started_notification_.release();
53 if (unblock_notification_.try_acquire_until(
54 SystemClock::TimePointAfterAtLeast(std::chrono::hours(42)))) {
55 notified_time_ = SystemClock::now();
56 }
57 finished_notification_.release();
58 }
59
60 TaskHandle_t task_handle_;
61 TimedThreadNotification started_notification_;
62 TimedThreadNotification unblock_notification_;
63 ThreadNotification finished_notification_;
64 std::optional<SystemClock::time_point> notified_time_;
65 };
66
TEST(TimedThreadNotification,AcquireWithoutSuspend)67 TEST(TimedThreadNotification, AcquireWithoutSuspend) {
68 TimedNotificationAcquirer notification_acquirer;
69 // TODO: b/290860904 - Replace TestOptionsThread0 with TestThreadContext.
70 pw::Thread thread =
71 pw::Thread(thread::test::TestOptionsThread0(),
72 [¬ification_acquirer] { notification_acquirer.Run(); });
73
74 notification_acquirer.WaitUntilRunning();
75 // At this point the thread is blocked and waiting on the notification.
76 const SystemClock::time_point release_time = SystemClock::now();
77 notification_acquirer.Release();
78 notification_acquirer.WaitUntilFinished();
79 ASSERT_TRUE(notification_acquirer.notified_time().has_value());
80 EXPECT_GE(notification_acquirer.notified_time().value(), release_time);
81
82 // Clean up the test thread context.
83 #if PW_THREAD_JOINING_ENABLED
84 thread.join();
85 #else
86 thread.detach();
87 thread::test::WaitUntilDetachedThreadsCleanedUp();
88 #endif // PW_THREAD_JOINING_ENABLED
89 }
90
TEST(TimedThreadNotification,AcquireWithSuspend)91 TEST(TimedThreadNotification, AcquireWithSuspend) {
92 TimedNotificationAcquirer notification_acquirer;
93 pw::Thread thread =
94 pw::Thread(thread::test::TestOptionsThread0(),
95 [¬ification_acquirer] { notification_acquirer.Run(); });
96
97 notification_acquirer.WaitUntilRunning();
98
99 // Suspend and resume the task before notifying it, which should cause the
100 // internal xTaskNotifyWait to stop blocking and return pdFALSE upon resume.
101 vTaskSuspend(notification_acquirer.task_handle());
102 vTaskResume(notification_acquirer.task_handle());
103
104 // Sleep for at least one tick to ensure the time moved forward to let us
105 // observe the unblock time is in fact after resumed it.
106 this_thread::sleep_for(SystemClock::duration(1));
107
108 // At this point the thread is blocked and waiting on the notification.
109 const SystemClock::time_point release_time = SystemClock::now();
110 notification_acquirer.Release();
111 notification_acquirer.WaitUntilFinished();
112 ASSERT_TRUE(notification_acquirer.notified_time().has_value());
113 EXPECT_GE(notification_acquirer.notified_time().value(), release_time);
114
115 // Clean up the test thread context.
116 #if PW_THREAD_JOINING_ENABLED
117 thread.join();
118 #else
119 thread.detach();
120 thread::test::WaitUntilDetachedThreadsCleanedUp();
121 #endif // PW_THREAD_JOINING_ENABLED
122 }
123
124 #endif // INCLUDE_vTaskSuspend == 1
125
126 } // namespace pw::sync::freertos
127