1 // Copyright 2020 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 #pragma once 15 16 #include <mutex> 17 18 namespace pw::sync::backend { 19 20 // The NativeMutex class adds a flag that tracks whether the std::timed_mutex is 21 // locked. The C++ standard states that misusing a mutex is undefined behavior, 22 // so library implementations may simply ignore misuse. This ensures misuse hits 23 // a PW_CHECK. 24 struct NativeMutex { 25 // The locked state is tracked in a variable. This function asserts if the 26 // state is inconsistent (e.g. unlocking an unlocked mutex). 27 void SetLockedState(bool new_state); 28 29 std::timed_mutex mutex; 30 bool locked = false; 31 }; 32 33 using NativeMutexHandle = std::timed_mutex&; 34 35 } // namespace pw::sync::backend 36