mirror of
https://github.com/klzgrad/naiveproxy.git
synced 2024-11-24 14:26:09 +03:00
113 lines
3.6 KiB
C++
113 lines
3.6 KiB
C++
// 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_NATIVE_STACK_SAMPLER_H_
|
|
#define BASE_PROFILER_NATIVE_STACK_SAMPLER_H_
|
|
|
|
#include <memory>
|
|
|
|
#include "base/base_export.h"
|
|
#include "base/macros.h"
|
|
#include "base/profiler/stack_sampling_profiler.h"
|
|
#include "base/threading/platform_thread.h"
|
|
|
|
namespace base {
|
|
|
|
class NativeStackSamplerTestDelegate;
|
|
|
|
// NativeStackSampler is an implementation detail of StackSamplingProfiler. It
|
|
// abstracts the native implementation required to record a stack sample for a
|
|
// given thread.
|
|
class NativeStackSampler {
|
|
public:
|
|
// This class contains a buffer for stack copies that can be shared across
|
|
// multiple instances of NativeStackSampler.
|
|
class StackBuffer {
|
|
public:
|
|
StackBuffer(size_t buffer_size);
|
|
~StackBuffer();
|
|
|
|
void* buffer() const { return buffer_.get(); }
|
|
size_t size() const { return size_; }
|
|
|
|
private:
|
|
// The word-aligned buffer.
|
|
const std::unique_ptr<uintptr_t[]> buffer_;
|
|
|
|
// The size of the buffer.
|
|
const size_t size_;
|
|
|
|
DISALLOW_COPY_AND_ASSIGN(StackBuffer);
|
|
};
|
|
|
|
// The callback type used to add annotations to a sample during collection.
|
|
// This is passed to the native sampler to be applied at the most appropriate
|
|
// time. It is a simple function-pointer because the generated code must be
|
|
// completely predictable and do nothing that could acquire a mutex; a
|
|
// Callback object is code outside the control of this object and could,
|
|
// for example, acquire a mutex as part of allocating memory for a LOG
|
|
// message.
|
|
using AnnotateCallback = void (*)(StackSamplingProfiler::Sample*);
|
|
|
|
virtual ~NativeStackSampler();
|
|
|
|
// Creates a stack sampler that records samples for |thread_handle|. Returns
|
|
// null if this platform does not support stack sampling.
|
|
static std::unique_ptr<NativeStackSampler> Create(
|
|
PlatformThreadId thread_id,
|
|
AnnotateCallback annotator,
|
|
NativeStackSamplerTestDelegate* 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 NativeStackSampler object.
|
|
static std::unique_ptr<StackBuffer> CreateStackBuffer();
|
|
|
|
// The following functions are all called on the SamplingThread (not the
|
|
// thread being sampled).
|
|
|
|
// Notifies the sampler that we're starting to record a new profile. Modules
|
|
// shared across samples in the profile should be recorded in |modules|.
|
|
virtual void ProfileRecordingStarting(
|
|
std::vector<StackSamplingProfiler::Module>* modules) = 0;
|
|
|
|
// Records a stack sample to |sample|.
|
|
virtual void RecordStackSample(StackBuffer* stackbuffer,
|
|
StackSamplingProfiler::Sample* sample) = 0;
|
|
|
|
// Notifies the sampler that we've stopped recording the current
|
|
// profile.
|
|
virtual void ProfileRecordingStopped(StackBuffer* stackbuffer) = 0;
|
|
|
|
protected:
|
|
NativeStackSampler();
|
|
|
|
private:
|
|
DISALLOW_COPY_AND_ASSIGN(NativeStackSampler);
|
|
};
|
|
|
|
// NativeStackSamplerTestDelegate provides seams for test code to execute during
|
|
// stack collection.
|
|
class BASE_EXPORT NativeStackSamplerTestDelegate {
|
|
public:
|
|
virtual ~NativeStackSamplerTestDelegate();
|
|
|
|
// 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:
|
|
NativeStackSamplerTestDelegate();
|
|
|
|
private:
|
|
DISALLOW_COPY_AND_ASSIGN(NativeStackSamplerTestDelegate);
|
|
};
|
|
|
|
} // namespace base
|
|
|
|
#endif // BASE_PROFILER_NATIVE_STACK_SAMPLER_H_
|
|
|