blob: 9b4dfd971db44cd53432e09b37ec4bec50d74afe (
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
|
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef BASE_PROFILER_STACK_SAMPLER_H_
#define BASE_PROFILER_STACK_SAMPLER_H_
#include <memory>
#include <vector>
#include "base/base_export.h"
#include "base/macros.h"
#include "base/profiler/sampling_profiler_thread_token.h"
#include "base/threading/platform_thread.h"
namespace base {
class Unwinder;
class ModuleCache;
class ProfileBuilder;
class StackBuffer;
class StackSamplerTestDelegate;
// StackSampler is an implementation detail of StackSamplingProfiler. It
// abstracts the native implementation required to record a set of stack frames
// for a given thread.
class BASE_EXPORT StackSampler {
public:
virtual ~StackSampler();
// Creates a stack sampler that records samples for thread with
// |thread_token|. Unwinders in |unwinders| must be stored in increasing
// priority to guide unwind attempts. Only the unwinder with the lowest
// priority is allowed to return with UnwindResult::COMPLETED. Returns null if
// this platform does not support stack sampling.
static std::unique_ptr<StackSampler> Create(
SamplingProfilerThreadToken thread_token,
ModuleCache* module_cache,
std::vector<std::unique_ptr<Unwinder>> core_unwinders,
StackSamplerTestDelegate* test_delegate);
// Gets the required size of the stack buffer.
static size_t GetStackBufferSize();
// Creates an instance of the a stack buffer that can be used for calls to
// any StackSampler object.
static std::unique_ptr<StackBuffer> CreateStackBuffer();
// The following functions are all called on the SamplingThread (not the
// thread being sampled).
// Adds an auxiliary unwinder to handle additional, non-native-code unwind
// scenarios. Unwinders must be inserted in increasing priority, following
// |unwinders| provided in Create(), to guide unwind attempts.
virtual void AddAuxUnwinder(std::unique_ptr<Unwinder> unwinder) = 0;
// Records a set of frames and returns them.
virtual void RecordStackFrames(StackBuffer* stackbuffer,
ProfileBuilder* profile_builder) = 0;
protected:
StackSampler();
private:
DISALLOW_COPY_AND_ASSIGN(StackSampler);
};
// StackSamplerTestDelegate provides seams for test code to execute during stack
// collection.
class BASE_EXPORT StackSamplerTestDelegate {
public:
virtual ~StackSamplerTestDelegate();
// Called after copying the stack and resuming the target thread, but prior to
// walking the stack. Invoked on the SamplingThread.
virtual void OnPreStackWalk() = 0;
protected:
StackSamplerTestDelegate();
private:
DISALLOW_COPY_AND_ASSIGN(StackSamplerTestDelegate);
};
} // namespace base
#endif // BASE_PROFILER_STACK_SAMPLER_H_
|
