mutex.h

// 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.
#pragma once
 
#include <stdbool.h>
 
#include "pw_preprocessor/util.h"
#include "pw_sync/lock_annotations.h"
 
#ifdef __cplusplus
 
#include "pw_sync/virtual_basic_lockable.h"
#include "pw_sync_backend/mutex_native.h"
 
namespace pw::sync {
 
class PW_LOCKABLE("pw::sync::Mutex") Mutex {
 public:
  using native_handle_type = backend::NativeMutexHandle;
 
  Mutex();
  ~Mutex();
  Mutex(const Mutex&) = delete;
  Mutex(Mutex&&) = delete;
  Mutex& operator=(const Mutex&) = delete;
  Mutex& operator=(Mutex&&) = delete;
 
  void lock() PW_EXCLUSIVE_LOCK_FUNCTION();
 
  [[nodiscard]] bool try_lock() PW_EXCLUSIVE_TRYLOCK_FUNCTION(true);
 
  void unlock() PW_UNLOCK_FUNCTION();
 
  [[nodiscard]] native_handle_type native_handle();
 
 protected:
  backend::NativeMutex& native_type() { return native_type_; }
  const backend::NativeMutex& native_type() const { return native_type_; }
 
 private:
  backend::NativeMutex native_type_;
};
 
class PW_LOCKABLE("pw::sync::VirtualMutex") VirtualMutex final
    : public GenericLockable<Mutex> {
 public:
  Mutex& mutex() { return impl(); }
};
 
}  // namespace pw::sync
 
#include "pw_sync_backend/mutex_inline.h"
 
using pw_sync_Mutex = pw::sync::Mutex;
 
#else  // !defined(__cplusplus)
 
typedef struct pw_sync_Mutex pw_sync_Mutex;
 
#endif  // __cplusplus
 
PW_EXTERN_C_START
 
void pw_sync_Mutex_Lock(pw_sync_Mutex* mutex) PW_NO_LOCK_SAFETY_ANALYSIS;
 
bool pw_sync_Mutex_TryLock(pw_sync_Mutex* mutex) PW_NO_LOCK_SAFETY_ANALYSIS;
 
void pw_sync_Mutex_Unlock(pw_sync_Mutex* mutex) PW_NO_LOCK_SAFETY_ANALYSIS;
 
PW_EXTERN_C_END