profiler.h 3.8 KB
Newer Older
1
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved.
D
dangqingqing 已提交
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. */

#pragma once
#include <forward_list>
#include <list>
18
#include <string>
D
dangqingqing 已提交
19
#include <vector>
Y
Yi Wang 已提交
20
#include "paddle/fluid/platform/device_context.h"
D
dangqingqing 已提交
21 22 23 24

namespace paddle {
namespace platform {

25
enum EventType { kMark, kPushRange, kPopRange };
D
dangqingqing 已提交
26 27 28

class Event {
 public:
D
dangqingqing 已提交
29 30
  // The DeviceContext is used to get the cuda stream.
  // If CPU profiling mode, can pass nullptr.
31
  Event(EventType type, std::string name, uint32_t thread_id,
D
dangqingqing 已提交
32
        const DeviceContext* dev_ctx);
D
dangqingqing 已提交
33

34
  const EventType& type() const;
D
dangqingqing 已提交
35
  std::string name() const { return name_; }
36
  uint32_t thread_id() const { return thread_id_; }
D
dangqingqing 已提交
37 38 39 40 41 42 43
  bool has_cuda() const { return has_cuda_; }

#ifdef PADDLE_WITH_CUDA
  cudaEvent_t event() const { return event_; }
  int device() const { return device_; }
#endif

44 45
  double CpuElapsedMs(const Event& e) const;
  double CudaElapsedMs(const Event& e) const;
D
dangqingqing 已提交
46 47

 private:
48
  EventType type_;
D
dangqingqing 已提交
49 50 51 52 53 54 55 56 57 58 59
  std::string name_;
  uint32_t thread_id_;
  int64_t cpu_ns_;
  bool has_cuda_;
#ifdef PADDLE_WITH_CUDA
  cudaEvent_t event_ = nullptr;
  int device_ = -1;
#endif
};

enum ProfilerState {
D
dangqingqing 已提交
60 61 62
  kDisabled,  // disabled state
  kCPU,       // CPU profiling state
  kCUDA,      // GPU profiling state
63
  kAll,       // Profile both CPU and GPU. (Currently experimental).
D
dangqingqing 已提交
64 65
};

D
dangqingqing 已提交
66
void Mark(const std::string& name, const DeviceContext* dev_ctx);
D
dangqingqing 已提交
67

D
dangqingqing 已提交
68
void PushEvent(const std::string& name, const DeviceContext* dev_ctx);
69

D
dangqingqing 已提交
70
void PopEvent(const std::string& name, const DeviceContext* dev_ctx);
71

D
dzhwinter 已提交
72
#if !defined(_WIN32)
D
dangqingqing 已提交
73
struct RecordEvent {
G
gongweibao 已提交
74
  // dev_ctx can be set to nullptr if device is cpu.
Y
Yibing Liu 已提交
75
  RecordEvent(const std::string& name, const DeviceContext* dev_ctx);
D
dangqingqing 已提交
76

D
dangqingqing 已提交
77 78
  ~RecordEvent();

X
Xin Pan 已提交
79
  bool is_enabled_;
X
Xin Pan 已提交
80
  uint64_t start_ns_;
D
dangqingqing 已提交
81
  // The device context is used by Event to get the current cuda stream.
D
dangqingqing 已提交
82
  const DeviceContext* dev_ctx_;
Y
Yibing Liu 已提交
83
  // Event name
84
  std::string name_;
85 86 87
  // Need to distinguish name by op type, block_id, program_id and perhaps
  // different kernel invocations within an op.
  std::string full_name_;
D
dangqingqing 已提交
88 89
};

X
Xin Pan 已提交
90 91 92 93 94
struct RecordBlock {
  explicit RecordBlock(int block_id);
  ~RecordBlock();

 private:
X
Xin Pan 已提交
95
  bool is_enabled_;
X
Xin Pan 已提交
96 97 98
  std::string name_;
  uint64_t start_ns_;
};
D
dzhwinter 已提交
99 100 101 102 103 104 105 106 107
#else
// windows do not support profiler temporarily.
struct RecordEvent {
  RecordEvent(const std::string& name, const DeviceContext* dev_ctx) {}
};
struct RecordBlock {
  explicit RecordBlock(int block_id) {}
};
#endif
X
Xin Pan 已提交
108

109
// Return the event list of all threads. Assumed the returned value calls
D
dangqingqing 已提交
110
// event_lists, event_lists[i][j] represents the j-th Event of i-th thread.
111
std::vector<std::vector<Event>> GetAllEvents();
D
dangqingqing 已提交
112

113 114 115
// Candidate keys to sort the profiling report
enum EventSortingKey { kDefault, kCalls, kTotal, kMin, kMax, kAve };

116 117 118 119 120 121
// Enable the profiling function.
void EnableProfiler(ProfilerState state);

// Clear the g_all_event_lists, which is total event lists of all threads.
void ResetProfiler();

X
Xin Pan 已提交
122 123
void DisableProfiler(EventSortingKey sorted_key,
                     const std::string& profile_path);
124

X
Xin Pan 已提交
125 126
const int kEnableProfiler = 1;
const int kDisableProfiler = 2;
127 128 129 130 131
// Test if the profiler is currently enabled.
bool IsProfileEnabled();
// Whether the trainer should send profiling state to PS.
bool ShouldSendProfileState();
// Mark current process as PS by assigning a lister id.
X
Xin Pan 已提交
132
void SetProfileListener();
133 134
int64_t ListenerId();

D
dangqingqing 已提交
135 136
}  // namespace platform
}  // namespace paddle