aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/restricted/abseil-cpp-tstring/y_absl/synchronization/internal/per_thread_sem.h
blob: 0140b9b7d0de70773b8a7d91a9779f28d87cb903 (plain) (blame)
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
// Copyright 2017 The Abseil 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. 
// 
 
// PerThreadSem is a low-level synchronization primitive controlling the 
// runnability of a single thread, used internally by Mutex and CondVar. 
// 
// This is NOT a general-purpose synchronization mechanism, and should not be 
// used directly by applications.  Applications should use Mutex and CondVar. 
// 
// The semantics of PerThreadSem are the same as that of a counting semaphore. 
// Each thread maintains an abstract "count" value associated with its identity. 
 
#ifndef ABSL_SYNCHRONIZATION_INTERNAL_PER_THREAD_SEM_H_ 
#define ABSL_SYNCHRONIZATION_INTERNAL_PER_THREAD_SEM_H_ 
 
#include <atomic> 
 
#include "y_absl/base/internal/thread_identity.h"
#include "y_absl/synchronization/internal/create_thread_identity.h"
#include "y_absl/synchronization/internal/kernel_timeout.h"
 
namespace y_absl {
ABSL_NAMESPACE_BEGIN
 
class Mutex; 
 
namespace synchronization_internal { 
 
class PerThreadSem { 
 public: 
  PerThreadSem() = delete; 
  PerThreadSem(const PerThreadSem&) = delete; 
  PerThreadSem& operator=(const PerThreadSem&) = delete; 
 
  // Routine invoked periodically (once a second) by a background thread. 
  // Has no effect on user-visible state. 
  static void Tick(base_internal::ThreadIdentity* identity); 
 
  // --------------------------------------------------------------------------- 
  // Routines used by autosizing threadpools to detect when threads are 
  // blocked.  Each thread has a counter pointer, initially zero.  If non-zero, 
  // the implementation atomically increments the counter when it blocks on a 
  // semaphore, a decrements it again when it wakes.  This allows a threadpool 
  // to keep track of how many of its threads are blocked. 
  // SetThreadBlockedCounter() should be used only by threadpool 
  // implementations.  GetThreadBlockedCounter() should be used by modules that 
  // block threads; if the pointer returned is non-zero, the location should be 
  // incremented before the thread blocks, and decremented after it wakes. 
  static void SetThreadBlockedCounter(std::atomic<int> *counter); 
  static std::atomic<int> *GetThreadBlockedCounter(); 
 
 private: 
  // Create the PerThreadSem associated with "identity".  Initializes count=0. 
  // REQUIRES: May only be called by ThreadIdentity. 
  static void Init(base_internal::ThreadIdentity* identity); 
 
  // Destroy the PerThreadSem associated with "identity". 
  // REQUIRES: May only be called by ThreadIdentity. 
  static void Destroy(base_internal::ThreadIdentity* identity); 
 
  // Increments "identity"'s count. 
  static inline void Post(base_internal::ThreadIdentity* identity); 
 
  // Waits until either our count > 0 or t has expired. 
  // If count > 0, decrements count and returns true.  Otherwise returns false. 
  // !t.has_timeout() => Wait(t) will return true. 
  static inline bool Wait(KernelTimeout t); 
 
  // Permitted callers.
  friend class PerThreadSemTest; 
  friend class y_absl::Mutex;
  friend y_absl::base_internal::ThreadIdentity* CreateThreadIdentity();
  friend void ReclaimThreadIdentity(void* v); 
}; 
 
}  // namespace synchronization_internal 
ABSL_NAMESPACE_END
}  // namespace y_absl
 
// In some build configurations we pass --detect-odr-violations to the 
// gold linker.  This causes it to flag weak symbol overrides as ODR 
// violations.  Because ODR only applies to C++ and not C, 
// --detect-odr-violations ignores symbols not mangled with C++ names. 
// By changing our extension points to be extern "C", we dodge this 
// check. 
extern "C" { 
void ABSL_INTERNAL_C_SYMBOL(AbslInternalPerThreadSemPost)(
    y_absl::base_internal::ThreadIdentity* identity);
bool ABSL_INTERNAL_C_SYMBOL(AbslInternalPerThreadSemWait)(
    y_absl::synchronization_internal::KernelTimeout t);
}  // extern "C" 
 
void y_absl::synchronization_internal::PerThreadSem::Post(
    y_absl::base_internal::ThreadIdentity* identity) {
  ABSL_INTERNAL_C_SYMBOL(AbslInternalPerThreadSemPost)(identity);
} 
 
bool y_absl::synchronization_internal::PerThreadSem::Wait(
    y_absl::synchronization_internal::KernelTimeout t) {
  return ABSL_INTERNAL_C_SYMBOL(AbslInternalPerThreadSemWait)(t);
} 
 
#endif  // ABSL_SYNCHRONIZATION_INTERNAL_PER_THREAD_SEM_H_