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/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_thread/thread_core.h"
26 #include "pw_unit_test/framework.h"
27 #include "task.h"
28
29 namespace pw::sync::freertos {
30 namespace {
31
32 using pw::chrono::SystemClock;
33
34 } // namespace
35
36 // These tests are targeted specifically to verify interactions between suspend
37 // and being blocked on direct task notifications and how they impact usage of
38 // the FreeRTOS optimized ThreadNotification backend.
39 #if INCLUDE_vTaskSuspend == 1
40
41 class NotificationAcquirer : public thread::ThreadCore {
42 public:
WaitUntilRunning()43 void WaitUntilRunning() { started_notification_.acquire(); }
Release()44 void Release() { unblock_notification_.release(); }
WaitUntilFinished()45 void WaitUntilFinished() { finished_notification_.acquire(); }
notified_time() const46 std::optional<SystemClock::time_point> notified_time() const {
47 return notified_time_;
48 }
task_handle() const49 TaskHandle_t task_handle() const { return task_handle_; }
50
51 private:
Run()52 void Run() final {
53 task_handle_ = xTaskGetCurrentTaskHandle();
54 started_notification_.release();
55 unblock_notification_.acquire();
56 notified_time_ = SystemClock::now();
57 finished_notification_.release();
58 }
59
60 TaskHandle_t task_handle_;
61 ThreadNotification started_notification_;
62 ThreadNotification unblock_notification_;
63 ThreadNotification finished_notification_;
64 std::optional<SystemClock::time_point> notified_time_;
65 };
66
TEST(ThreadNotification,AcquireWithoutSuspend)67 TEST(ThreadNotification, AcquireWithoutSuspend) {
68 NotificationAcquirer notification_acquirer;
69 // TODO: b/290860904 - Replace TestOptionsThread0 with TestThreadContext.
70 pw::Thread thread =
71 pw::Thread(thread::test::TestOptionsThread0(), notification_acquirer);
72
73 notification_acquirer.WaitUntilRunning();
74 // At this point the thread is blocked and waiting on the notification.
75 const SystemClock::time_point release_time = SystemClock::now();
76 notification_acquirer.Release();
77 notification_acquirer.WaitUntilFinished();
78 ASSERT_TRUE(notification_acquirer.notified_time().has_value());
79 EXPECT_GE(notification_acquirer.notified_time().value(), release_time);
80
81 // Clean up the test thread context.
82 #if PW_THREAD_JOINING_ENABLED
83 thread.join();
84 #else
85 thread.detach();
86 thread::test::WaitUntilDetachedThreadsCleanedUp();
87 #endif // PW_THREAD_JOINING_ENABLED
88 }
89
TEST(ThreadNotification,AcquireWithSuspend)90 TEST(ThreadNotification, AcquireWithSuspend) {
91 NotificationAcquirer notification_acquirer;
92 pw::Thread thread =
93 pw::Thread(thread::test::TestOptionsThread0(), notification_acquirer);
94
95 notification_acquirer.WaitUntilRunning();
96
97 // Suspend and resume the task before notifying it, which should cause the
98 // internal xTaskNotifyWait to stop blocking and return pdFALSE upon resume.
99 vTaskSuspend(notification_acquirer.task_handle());
100 vTaskResume(notification_acquirer.task_handle());
101
102 // Sleep for at least one tick to ensure the time moved forward to let us
103 // observe the unblock time is in fact after resumed it.
104 this_thread::sleep_for(SystemClock::duration(1));
105
106 // At this point the thread is blocked and waiting on the notification.
107 const SystemClock::time_point release_time = SystemClock::now();
108 notification_acquirer.Release();
109 notification_acquirer.WaitUntilFinished();
110 ASSERT_TRUE(notification_acquirer.notified_time().has_value());
111 EXPECT_GE(notification_acquirer.notified_time().value(), release_time);
112
113 // Clean up the test thread context.
114 #if PW_THREAD_JOINING_ENABLED
115 thread.join();
116 #else
117 thread.detach();
118 thread::test::WaitUntilDetachedThreadsCleanedUp();
119 #endif // PW_THREAD_JOINING_ENABLED
120 }
121
122 #endif // INCLUDE_vTaskSuspend == 1
123
124 } // namespace pw::sync::freertos
125