blob: f94ef814d3c5436dafe68f69ac632c2e5109f935 (
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
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
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_StaticMutex_h
#define mozilla_StaticMutex_h
#include "mozilla/Atomics.h"
#include "mozilla/Mutex.h"
namespace mozilla {
/**
* StaticMutex is a Mutex that can (and in fact, must) be used as a
* global/static variable.
*
* The main reason to use StaticMutex as opposed to
* StaticAutoPtr<OffTheBooksMutex> is that we instantiate the StaticMutex in a
* thread-safe manner the first time it's used.
*
* The same caveats that apply to StaticAutoPtr apply to StaticMutex. In
* particular, do not use StaticMutex as a stack variable or a class instance
* variable, because this class relies on the fact that global variablies are
* initialized to 0 in order to initialize mMutex. It is only safe to use
* StaticMutex as a global or static variable.
*/
class MOZ_ONLY_USED_TO_AVOID_STATIC_CONSTRUCTORS StaticMutex
{
public:
// In debug builds, check that mMutex is initialized for us as we expect by
// the compiler. In non-debug builds, don't declare a constructor so that
// the compiler can see that the constructor is trivial.
#ifdef DEBUG
StaticMutex()
{
MOZ_ASSERT(!mMutex);
}
#endif
void Lock()
{
Mutex()->Lock();
}
void Unlock()
{
Mutex()->Unlock();
}
void AssertCurrentThreadOwns()
{
#ifdef DEBUG
Mutex()->AssertCurrentThreadOwns();
#endif
}
private:
OffTheBooksMutex* Mutex()
{
if (mMutex) {
return mMutex;
}
OffTheBooksMutex* mutex = new OffTheBooksMutex("StaticMutex");
if (!mMutex.compareExchange(nullptr, mutex)) {
delete mutex;
}
return mMutex;
}
Atomic<OffTheBooksMutex*> mMutex;
// Disallow copy constructor, but only in debug mode. We only define
// a default constructor in debug mode (see above); if we declared
// this constructor always, the compiler wouldn't generate a trivial
// default constructor for us in non-debug mode.
#ifdef DEBUG
StaticMutex(StaticMutex& aOther);
#endif
// Disallow these operators.
StaticMutex& operator=(StaticMutex* aRhs);
static void* operator new(size_t) CPP_THROW_NEW;
static void operator delete(void*);
};
typedef BaseAutoLock<StaticMutex> StaticMutexAutoLock;
typedef BaseAutoUnlock<StaticMutex> StaticMutexAutoUnlock;
} // namespace mozilla
#endif
|
