aboutsummaryrefslogtreecommitdiff
path: root/pw_rpc/public/pw_rpc/internal/lock.h
blob: 3961eeee6456fc21033164ed47649718156ff826 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
// Copyright 2021 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 "pw_rpc/internal/config.h"
#include "pw_sync/lock_annotations.h"
#include "pw_toolchain/no_destructor.h"

#if PW_RPC_USE_GLOBAL_MUTEX

#include "pw_sync/mutex.h"  // nogncheck

#endif  // PW_RPC_USE_GLOBAL_MUTEX

namespace pw::rpc::internal {

#if PW_RPC_USE_GLOBAL_MUTEX

using RpcLock = sync::Mutex;

#else

class PW_LOCKABLE("pw::rpc::internal::RpcLock") RpcLock {
 public:
  constexpr void lock() PW_EXCLUSIVE_LOCK_FUNCTION() {}
  constexpr void unlock() PW_UNLOCK_FUNCTION() {}
};

#endif  // PW_RPC_USE_GLOBAL_MUTEX

inline RpcLock& rpc_lock() {
  static NoDestructor<RpcLock> lock;
  return *lock;
}

class PW_SCOPED_LOCKABLE RpcLockGuard {
 public:
  RpcLockGuard() PW_EXCLUSIVE_LOCK_FUNCTION(rpc_lock()) { rpc_lock().lock(); }

  ~RpcLockGuard() PW_UNLOCK_FUNCTION(rpc_lock()) { rpc_lock().unlock(); }
};

// Releases the RPC lock, yields, and reacquires it.
void YieldRpcLock() PW_EXCLUSIVE_LOCKS_REQUIRED(rpc_lock());

}  // namespace pw::rpc::internal