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
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef BASE_SEQUENCE_CHECKER_IMPL_H_
#define BASE_SEQUENCE_CHECKER_IMPL_H_
#include <memory>
#include "base/base_export.h"
#include "base/synchronization/lock.h"
#include "base/thread_annotations.h"
#include "base/threading/thread_checker_impl.h"
namespace base {
namespace debug {
class StackTrace;
}
// Real implementation of SequenceChecker for use in debug mode or for temporary
// use in release mode (e.g. to CHECK on a threading issue seen only in the
// wild).
//
// Note: You should almost always use the SequenceChecker class to get the right
// version for your build configuration.
// Note: This is marked with "context" capability in order to support
// thread_annotations.h.
class THREAD_ANNOTATION_ATTRIBUTE__(capability("context"))
BASE_EXPORT SequenceCheckerImpl {
public:
static void EnableStackLogging();
SequenceCheckerImpl();
// Allow move construct/assign. This must be called on |other|'s associated
// sequence and assignment can only be made into a SequenceCheckerImpl which
// is detached or already associated with the current sequence. This isn't
// thread-safe (|this| and |other| shouldn't be in use while this move is
// performed). If the assignment was legal, the resulting SequenceCheckerImpl
// will be bound to the current sequence and |other| will be detached.
SequenceCheckerImpl(SequenceCheckerImpl&& other);
SequenceCheckerImpl& operator=(SequenceCheckerImpl&& other);
SequenceCheckerImpl(const SequenceCheckerImpl&) = delete;
SequenceCheckerImpl& operator=(const SequenceCheckerImpl&) = delete;
~SequenceCheckerImpl();
// Returns true if called in sequence with previous calls to this method and
// the constructor.
// On returning false, if logging is enabled with EnableStackLogging() and
// `out_bound_at` is not null, this method allocates a StackTrace and returns
// it in the out-parameter, storing inside it the stack from where the failing
// SequenceChecker was bound to its sequence. Otherwise, out_bound_at is left
// untouched.
[[nodiscard]] bool CalledOnValidSequence(
std::unique_ptr<debug::StackTrace>* out_bound_at = nullptr) const;
// Unbinds the checker from the currently associated sequence. The checker
// will be re-bound on the next call to CalledOnValidSequence().
void DetachFromSequence();
private:
// SequenceCheckerImpl uses ThreadCheckerImpl for shared storage.
ThreadCheckerImpl thread_checker_;
};
} // namespace base
#endif // BASE_SEQUENCE_CHECKER_IMPL_H_
|
