xref: /aosp_15_r20/external/google-breakpad/src/client/windows/common/auto_critical_section.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 // Copyright 2008 Google LLC
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are
5 // met:
6 //
7 //     * Redistributions of source code must retain the above copyright
8 // notice, this list of conditions and the following disclaimer.
9 //     * Redistributions in binary form must reproduce the above
10 // copyright notice, this list of conditions and the following disclaimer
11 // in the documentation and/or other materials provided with the
12 // distribution.
13 //     * Neither the name of Google LLC nor the names of its
14 // contributors may be used to endorse or promote products derived from
15 // this software without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 #ifndef CLIENT_WINDOWS_COMMON_AUTO_CRITICAL_SECTION_H__
30 #define CLIENT_WINDOWS_COMMON_AUTO_CRITICAL_SECTION_H__
31 
32 #include <windows.h>
33 
34 namespace google_breakpad {
35 
36 // Automatically enters the critical section in the constructor and leaves
37 // the critical section in the destructor.
38 class AutoCriticalSection {
39  public:
40   // Creates a new instance with the given critical section object
41   // and enters the critical section immediately.
AutoCriticalSection(CRITICAL_SECTION * cs)42   explicit AutoCriticalSection(CRITICAL_SECTION* cs) : cs_(cs), taken_(false) {
43     assert(cs_);
44     Acquire();
45   }
46 
47   // Destructor: leaves the critical section.
~AutoCriticalSection()48   ~AutoCriticalSection() {
49     if (taken_) {
50       Release();
51     }
52   }
53 
54   // Enters the critical section. Recursive Acquire() calls are not allowed.
Acquire()55   void Acquire() {
56     assert(!taken_);
57     EnterCriticalSection(cs_);
58     taken_ = true;
59   }
60 
61   // Leaves the critical section. The caller should not call Release() unless
62   // the critical seciton has been entered already.
Release()63   void Release() {
64     assert(taken_);
65     taken_ = false;
66     LeaveCriticalSection(cs_);
67   }
68 
69  private:
70   // Disable copy ctor and operator=.
71   AutoCriticalSection(const AutoCriticalSection&);
72   AutoCriticalSection& operator=(const AutoCriticalSection&);
73 
74   CRITICAL_SECTION* cs_;
75   bool taken_;
76 };
77 
78 }  // namespace google_breakpad
79 
80 #endif  // CLIENT_WINDOWS_COMMON_AUTO_CRITICAL_SECTION_H__
81