xref: /aosp_15_r20/external/pigweed/pw_thread/yield_facade_test.cc (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker // Copyright 2020 The Pigweed Authors
2*61c4878aSAndroid Build Coastguard Worker //
3*61c4878aSAndroid Build Coastguard Worker // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4*61c4878aSAndroid Build Coastguard Worker // use this file except in compliance with the License. You may obtain a copy of
5*61c4878aSAndroid Build Coastguard Worker // the License at
6*61c4878aSAndroid Build Coastguard Worker //
7*61c4878aSAndroid Build Coastguard Worker //     https://www.apache.org/licenses/LICENSE-2.0
8*61c4878aSAndroid Build Coastguard Worker //
9*61c4878aSAndroid Build Coastguard Worker // Unless required by applicable law or agreed to in writing, software
10*61c4878aSAndroid Build Coastguard Worker // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11*61c4878aSAndroid Build Coastguard Worker // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12*61c4878aSAndroid Build Coastguard Worker // License for the specific language governing permissions and limitations under
13*61c4878aSAndroid Build Coastguard Worker // the License.
14*61c4878aSAndroid Build Coastguard Worker 
15*61c4878aSAndroid Build Coastguard Worker #include "pw_thread/thread.h"
16*61c4878aSAndroid Build Coastguard Worker #include "pw_thread/yield.h"
17*61c4878aSAndroid Build Coastguard Worker #include "pw_unit_test/framework.h"
18*61c4878aSAndroid Build Coastguard Worker 
19*61c4878aSAndroid Build Coastguard Worker namespace pw::this_thread {
20*61c4878aSAndroid Build Coastguard Worker namespace {
21*61c4878aSAndroid Build Coastguard Worker 
22*61c4878aSAndroid Build Coastguard Worker extern "C" {
23*61c4878aSAndroid Build Coastguard Worker 
24*61c4878aSAndroid Build Coastguard Worker // Function defined in yield_facade_test_c.c which call the API from C.
25*61c4878aSAndroid Build Coastguard Worker void pw_this_thread_CallYield();
26*61c4878aSAndroid Build Coastguard Worker 
27*61c4878aSAndroid Build Coastguard Worker }  // extern "C"
28*61c4878aSAndroid Build Coastguard Worker 
TEST(Yield,CompilesAndRuns)29*61c4878aSAndroid Build Coastguard Worker TEST(Yield, CompilesAndRuns) {
30*61c4878aSAndroid Build Coastguard Worker   // Ensure we are in a thread context, meaning we are permitted to sleep.
31*61c4878aSAndroid Build Coastguard Worker   ASSERT_NE(get_id(), Thread::id());
32*61c4878aSAndroid Build Coastguard Worker 
33*61c4878aSAndroid Build Coastguard Worker   // Unfortunately we have not thought of a useful way to test yield without
34*61c4878aSAndroid Build Coastguard Worker   // knowing the backend implementation as things like round robin scheduling
35*61c4878aSAndroid Build Coastguard Worker   // may be enabled meaning it may appear like yield is working when it isn't.
36*61c4878aSAndroid Build Coastguard Worker   // For now we just ensure it compiles and we can execute it without a crash.
37*61c4878aSAndroid Build Coastguard Worker   yield();
38*61c4878aSAndroid Build Coastguard Worker }
39*61c4878aSAndroid Build Coastguard Worker 
TEST(Yield,CompilesAndRunsInC)40*61c4878aSAndroid Build Coastguard Worker TEST(Yield, CompilesAndRunsInC) {
41*61c4878aSAndroid Build Coastguard Worker   // Ensure we are in a thread context, meaning we are permitted to sleep.
42*61c4878aSAndroid Build Coastguard Worker   ASSERT_NE(get_id(), Thread::id());
43*61c4878aSAndroid Build Coastguard Worker 
44*61c4878aSAndroid Build Coastguard Worker   // Unfortunately we have not thought of a useful way to test yield without
45*61c4878aSAndroid Build Coastguard Worker   // knowing the backend implementation as things like round robin scheduling
46*61c4878aSAndroid Build Coastguard Worker   // may be enabled meaning it may appear like yield is working when it isn't.
47*61c4878aSAndroid Build Coastguard Worker   // For now we just ensure it compiles and we can execute it without a crash.
48*61c4878aSAndroid Build Coastguard Worker   pw_this_thread_CallYield();
49*61c4878aSAndroid Build Coastguard Worker }
50*61c4878aSAndroid Build Coastguard Worker 
51*61c4878aSAndroid Build Coastguard Worker }  // namespace
52*61c4878aSAndroid Build Coastguard Worker }  // namespace pw::this_thread
53