profiler.cc 28.0 KB
Newer Older
1
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved.
D
dangqingqing 已提交
2 3 4 5

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
6

D
dangqingqing 已提交
7 8 9 10 11 12 13 14
    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. */

15
#include "paddle/fluid/platform/profiler.h"
16
#include <algorithm>
17
#include <iomanip>
18
#include <limits>
19
#include <map>
20
#include <mutex>  // NOLINT
21
#include <random>
22
#include <stack>
23
#include <string>
C
chengduo 已提交
24 25
#include <vector>

26 27 28
#ifdef PADDLE_WITH_CUDA
#include <cuda.h>
#endif  // PADDLE_WITH_CUDA
Y
Yancey1989 已提交
29

30
#include "glog/logging.h"
31 32
#include "paddle/fluid/framework/block_desc.h"
#include "paddle/fluid/platform/device_tracer.h"
Y
Yancey1989 已提交
33
#include "paddle/fluid/platform/port.h"
34
#include "paddle/fluid/string/printf.h"
D
dangqingqing 已提交
35

G
gongweibao 已提交
36 37
DEFINE_bool(enable_rpc_profiler, false, "Enable rpc profiler or not.");

D
dangqingqing 已提交
38 39 40
namespace paddle {
namespace platform {

41 42
static int64_t profiler_lister_id = 0;
static bool should_send_profile_state = false;
X
Xin Pan 已提交
43
std::mutex profiler_mu;
44

45
static TracerOption g_tracer_option = TracerOption::kDefault;
D
dangqingqing 已提交
46 47 48 49 50 51 52 53 54 55 56
// The profiler state, the initial value is ProfilerState::kDisabled
static ProfilerState g_state = ProfilerState::kDisabled;
// The thread local event list only can be accessed by the specific thread
// The thread index of each thread
static thread_local int32_t g_thread_id;
// The g_next_thread_id is a global counter for threads, by the g_thread_id and
// g_next_thread_id, we can know how many threads have created EventList.
static uint32_t g_next_thread_id = 0;
// The global mutex
static std::mutex g_all_event_lists_mutex;
// The total event lists of all threads
C
chengduo 已提交
57
static std::list<std::shared_ptr<EventList<Event>>> g_all_event_lists;
D
dangqingqing 已提交
58
// The thread local event list only can be accessed by the specific thread
C
chengduo 已提交
59
static thread_local std::shared_ptr<EventList<Event>> g_event_list;
60

C
chengduo 已提交
61 62 63 64 65
static std::list<std::shared_ptr<EventList<MemEvent>>> g_all_mem_event_lists;
static thread_local std::shared_ptr<EventList<MemEvent>> g_mem_event_list;
static std::mutex g_all_mem_event_lists_mutex;
static thread_local int32_t g_mem_thread_id;
static uint32_t g_mem_next_thread_id = 0;
66

D
dangqingqing 已提交
67 68 69 70 71 72 73 74 75
inline uint64_t GetTimeInNsec() {
  using clock = std::conditional<std::chrono::high_resolution_clock::is_steady,
                                 std::chrono::high_resolution_clock,
                                 std::chrono::steady_clock>::type;
  return std::chrono::duration_cast<std::chrono::nanoseconds>(
             clock::now().time_since_epoch())
      .count();
}

76 77
Event::Event(EventType type, std::string name, uint32_t thread_id)
    : type_(type), name_(name), thread_id_(thread_id) {
D
dangqingqing 已提交
78 79 80
  cpu_ns_ = GetTimeInNsec();
}

C
chengduo 已提交
81
const EventType &Event::type() const { return type_; }
D
dangqingqing 已提交
82

C
chengduo 已提交
83
double Event::CpuElapsedMs(const Event &e) const {
84
  return (e.cpu_ns_ - cpu_ns_) / (1000000.0);
D
dangqingqing 已提交
85 86
}

C
chengduo 已提交
87
double Event::CudaElapsedMs(const Event &e) const {
88 89
#ifdef PADDLE_WITH_CUPTI
  return gpu_ns_ / 1000000.0;
D
Dun Liang 已提交
90
#else
D
Dun Liang 已提交
91 92
  LOG_FIRST_N(WARNING, 1) << "CUDA CUPTI is not enabled";
  return 0;
D
dangqingqing 已提交
93 94 95
#endif
}

C
chengduo 已提交
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
inline EventList<MemEvent> &GetMemEventList() {
  if (!g_mem_event_list) {
    g_mem_event_list = std::make_shared<EventList<MemEvent>>();
    std::lock_guard<std::mutex> guard(g_all_mem_event_lists_mutex);
    g_mem_thread_id = g_mem_next_thread_id++;
    g_all_mem_event_lists.emplace_front(g_mem_event_list);
  }
  return *g_mem_event_list;
}

void PushMemEvent(uint64_t start_ns, uint64_t end_ns, size_t bytes,
                  const Place &place, const std::string &annotation) {
  GetMemEventList().Record(EventType::kPushRange, start_ns, end_ns, bytes,
                           place, g_mem_thread_id, annotation);
}

void PopMemEvent(uint64_t start_ns, uint64_t end_ns, size_t bytes,
                 const Place &place, const std::string &annotation) {
  GetMemEventList().Record(EventType::kPopRange, start_ns, end_ns, bytes, place,
                           g_mem_thread_id, annotation);
}

inline EventList<Event> &GetEventList() {
D
dangqingqing 已提交
119 120
  if (!g_event_list) {
    std::lock_guard<std::mutex> guard(g_all_event_lists_mutex);
C
chengduo 已提交
121
    g_event_list = std::make_shared<EventList<Event>>();
D
dangqingqing 已提交
122 123
    g_thread_id = g_next_thread_id++;
    g_all_event_lists.emplace_front(g_event_list);
124
    RecoreCurThreadId(g_thread_id);
D
dangqingqing 已提交
125 126 127 128
  }
  return *g_event_list;
}

C
chengduo 已提交
129
void Mark(const std::string &name) {
130
  GetEventList().Record(EventType::kMark, name, g_thread_id);
131 132
}

C
chengduo 已提交
133
Event *PushEvent(const std::string &name) {
134
  return GetEventList().Record(EventType::kPushRange, name, g_thread_id);
135 136
}

C
chengduo 已提交
137
void PopEvent(const std::string &name) {
138
  GetEventList().Record(EventType::kPopRange, name, g_thread_id);
D
dangqingqing 已提交
139 140
}

141 142
RecordEvent::RecordEvent(const std::string &name, const RecordRole role)
    : is_enabled_(false), start_ns_(PosixInNsec()), role_(role) {
143
  if (g_state == ProfilerState::kDisabled || name.empty()) return;
144 145 146 147 148
  if ((g_tracer_option == TracerOption::kOpDetail &&
       role_ != RecordRole::kInnerOp) ||
      (g_tracer_option == TracerOption::kDefault &&
       role != RecordRole::kOrdinary))
    return;
149
  // lock is not needed, the code below is thread-safe
X
Xin Pan 已提交
150
  is_enabled_ = true;
151
  Event *e = PushEvent(name);
152
  // Maybe need the same push/pop behavior.
153
  SetCurAnnotation(e);
154
  name_ = e->name();
D
dangqingqing 已提交
155 156 157
}

RecordEvent::~RecordEvent() {
X
Xin Pan 已提交
158
  if (g_state == ProfilerState::kDisabled || !is_enabled_) return;
159
  // lock is not needed, the code below is thread-safe
C
chengduo 已提交
160
  DeviceTracer *tracer = GetDeviceTracer();
X
Xin Pan 已提交
161
  if (tracer) {
162
    tracer->AddCPURecords(CurAnnotationName(), start_ns_, PosixInNsec(),
163
                          BlockDepth(), g_thread_id);
X
Xin Pan 已提交
164
  }
Y
Yibing Liu 已提交
165
  ClearCurAnnotation();
166
  PopEvent(name_);
D
dangqingqing 已提交
167
}
D
dangqingqing 已提交
168

C
chengduo 已提交
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
MemEvenRecorder MemEvenRecorder::recorder;

void MemEvenRecorder::PushMemRecord(const void *ptr, const Place &place,
                                    size_t size) {
  if (g_state == ProfilerState::kDisabled) return;
  std::lock_guard<std::mutex> guard(mtx_);
  auto &events = address_memevent_[place];
  PADDLE_ENFORCE(events.count(ptr) == 0, "");
  events.emplace(ptr, std::unique_ptr<RecordMemEvent>(
                          new MemEvenRecorder::RecordMemEvent(place, size)));
}

void MemEvenRecorder::PopMemRecord(const void *ptr, const Place &place) {
  if (g_state == ProfilerState::kDisabled) return;
  std::lock_guard<std::mutex> guard(mtx_);
  auto &events = address_memevent_[place];
  auto iter = events.find(ptr);
  // The ptr maybe not in address_memevent
  if (iter != events.end()) {
    events.erase(iter);
  }
}

void MemEvenRecorder::Flush() {
  std::lock_guard<std::mutex> guard(mtx_);
  address_memevent_.clear();
}

MemEvenRecorder::RecordMemEvent::RecordMemEvent(const Place &place,
                                                size_t bytes)
    : place_(place),
      bytes_(bytes),
      start_ns_(PosixInNsec()),
      alloc_in_(CurAnnotationName()) {
  PushMemEvent(start_ns_, end_ns_, bytes_, place_, alloc_in_);
}

MemEvenRecorder::RecordMemEvent::~RecordMemEvent() {
  DeviceTracer *tracer = GetDeviceTracer();
  end_ns_ = PosixInNsec();

  auto annotation_free = CurAnnotationName();
  if (tracer) {
    tracer->AddMemInfoRecord(start_ns_, end_ns_, bytes_, place_, alloc_in_,
                             annotation_free, g_mem_thread_id);
  }
  PopMemEvent(start_ns_, end_ns_, bytes_, place_, annotation_free);
}

RecordRPCEvent::RecordRPCEvent(const std::string &name) {
G
gongweibao 已提交
219
  if (FLAGS_enable_rpc_profiler) {
220
    event_.reset(new platform::RecordEvent(name));
G
gongweibao 已提交
221 222 223
  }
}

X
Xin Pan 已提交
224 225
RecordBlock::RecordBlock(int block_id)
    : is_enabled_(false), start_ns_(PosixInNsec()) {
226
  // lock is not needed, the code below is thread-safe
X
Xin Pan 已提交
227
  if (g_state == ProfilerState::kDisabled) return;
X
Xin Pan 已提交
228
  is_enabled_ = true;
X
Xin Pan 已提交
229 230 231 232 233
  SetCurBlock(block_id);
  name_ = string::Sprintf("block_%d", block_id);
}

RecordBlock::~RecordBlock() {
234
  // lock is not needed, the code below is thread-safe
X
Xin Pan 已提交
235
  if (g_state == ProfilerState::kDisabled || !is_enabled_) return;
C
chengduo 已提交
236
  DeviceTracer *tracer = GetDeviceTracer();
X
Xin Pan 已提交
237 238 239 240
  if (tracer) {
    // We try to put all blocks at the same nested depth in the
    // same timeline lane. and distinguish the using thread_id.
    tracer->AddCPURecords(name_, start_ns_, PosixInNsec(), BlockDepth(),
241
                          g_thread_id);
X
Xin Pan 已提交
242 243 244 245
  }
  ClearCurBlock();
}

246 247 248 249 250 251 252 253 254 255
void SynchronizeAllDevice() {
#ifdef PADDLE_WITH_CUDA
  int count = GetCUDADeviceCount();
  for (int i = 0; i < count; i++) {
    SetDeviceId(i);
    PADDLE_ENFORCE(cudaDeviceSynchronize());
  }
#endif
}

D
dangqingqing 已提交
256 257
void EnableProfiler(ProfilerState state) {
  PADDLE_ENFORCE(state != ProfilerState::kDisabled,
Q
Qiao Longfei 已提交
258
                 "Can't enable profiling, since the input state is ",
D
dangqingqing 已提交
259
                 "ProfilerState::kDisabled");
260
  SynchronizeAllDevice();
X
Xin Pan 已提交
261
  std::lock_guard<std::mutex> l(profiler_mu);
262 263
  if (state == g_state) {
    return;
264
  }
265
  g_state = state;
X
Xin Pan 已提交
266
  should_send_profile_state = true;
267
  GetDeviceTracer()->Enable();
D
dangqingqing 已提交
268
#ifdef PADDLE_WITH_CUDA
269 270
  if (g_state == ProfilerState::kCUDA || g_state == ProfilerState::kAll ||
      g_state == ProfilerState::kCPU) {
271
    // Generate some dummy events first to reduce the startup overhead.
272 273
    DummyKernelAndEvent();
    GetDeviceTracer()->Reset();
D
dangqingqing 已提交
274 275 276
  }
#endif
  // Mark the profiling start.
277
  Mark("_start_profiler_");
D
dangqingqing 已提交
278 279
}

280
void ResetProfiler() {
281 282
  SynchronizeAllDevice();
  GetDeviceTracer()->Reset();
C
chengduo 已提交
283
  MemEvenRecorder::Instance().Flush();
D
dangqingqing 已提交
284
  std::lock_guard<std::mutex> guard(g_all_event_lists_mutex);
285 286 287 288
  for (auto it = g_all_event_lists.begin(); it != g_all_event_lists.end();
       ++it) {
    (*it)->Clear();
  }
C
chengduo 已提交
289 290 291 292
  for (auto it = g_all_mem_event_lists.begin();
       it != g_all_mem_event_lists.end(); ++it) {
    (*it)->Clear();
  }
293 294 295 296 297
}

std::vector<std::vector<Event>> GetAllEvents() {
  std::lock_guard<std::mutex> guard(g_all_event_lists_mutex);
  std::vector<std::vector<Event>> result;
D
dangqingqing 已提交
298 299 300
  for (auto it = g_all_event_lists.begin(); it != g_all_event_lists.end();
       ++it) {
    result.emplace_back((*it)->Reduce());
D
dangqingqing 已提交
301 302 303 304
  }
  return result;
}

C
chengduo 已提交
305 306 307 308 309 310 311 312 313
std::vector<std::vector<MemEvent>> GetMemEvents() {
  std::lock_guard<std::mutex> guard(g_all_mem_event_lists_mutex);
  std::vector<std::vector<MemEvent>> result;
  for (auto &it : g_all_mem_event_lists) {
    result.emplace_back((*it).Reduce());
  }
  return result;
}

314 315 316 317 318 319 320
// The information of each event given in the profiling report
struct EventItem {
  std::string name;
  int calls;
  double total_time;
  double max_time;
  double ave_time;
C
chengduo 已提交
321 322 323
  double min_time;
  double cpu_time;
  double gpu_time;
Y
Yan Chunwei 已提交
324
  float ratio;
325 326 327
};

// Print results
C
chengduo 已提交
328
void PrintProfiler(const std::vector<std::vector<EventItem>> &events_table,
329
                   const std::multimap<std::string, EventItem> &child_map,
C
chengduo 已提交
330
                   const std::string &sorted_domain, const size_t name_width,
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
                   const size_t data_width, bool merge_thread, int print_depth,
                   int remove_len) {
  if (print_depth == 0) {
    // Output header information
    std::cout << "\n------------------------->"
              << "     Profiling Report     "
              << "<-------------------------\n\n";
    std::string place;
    if (g_state == ProfilerState::kCPU) {
      place = "CPU";
    } else if (g_state == ProfilerState::kCUDA) {
      place = "CUDA";
    } else if (g_state == ProfilerState::kAll) {
      place = "All";
    } else {
      PADDLE_THROW(platform::errors::InvalidArgument(
          "Except profiler state must to be one of ['CPU', 'GPU' 'ALL'], but "
348
          "received Invalid profiler state"));
349
    }
350

351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
    if (merge_thread) {
      std::cout << "Note! This Report merge all thread info into one."
                << std::endl;
    }
    std::cout << "Place: " << place << std::endl;
    std::cout << "Time unit: ms" << std::endl;
    std::cout << "Sorted by " << sorted_domain
              << " in descending order in the same thread\n\n";
    // Output events table
    std::cout.setf(std::ios::left);
    std::cout << std::setw(name_width) << "Event" << std::setw(data_width)
              << "Calls" << std::setw(data_width) << "Total";
    if (g_state == ProfilerState::kAll) {
      std::cout << std::setw(data_width * 2) << "CPU Time (Ratio)"
                << std::setw(data_width * 2) << "GPU Time (Ratio)";
    }
    std::cout << std::setw(data_width) << "Min." << std::setw(data_width)
              << "Max." << std::setw(data_width) << "Ave."
              << std::setw(data_width) << "Ratio." << std::endl;
C
chengduo 已提交
370
  }
371 372 373

  if (events_table.size() <= 0) return;

374 375
  for (size_t i = 0; i < events_table.size(); ++i) {
    for (size_t j = 0; j < events_table[i].size(); ++j) {
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
      auto event_item = events_table[i][j];
      std::vector<std::vector<EventItem>> child_table;
      std::vector<EventItem> table;
      for (auto it = child_map.begin(); it != child_map.end(); it++) {
        if (it->first == event_item.name) {
          table.push_back(it->second);
        }
      }
      child_table.push_back(table);

      auto name_len = event_item.name.length();
      std::string print_name = event_item.name.substr(remove_len, name_len);
      std::string delimiter;
      for (int i = 0; i < print_depth; i++) {
        delimiter = "  " + delimiter;
      }
      print_name = delimiter + print_name;
393

394 395 396
      std::cout << std::setw(name_width) << print_name << std::setw(data_width)
                << event_item.calls << std::setw(data_width)
                << event_item.total_time;
C
chengduo 已提交
397 398 399 400 401 402 403 404 405 406 407
      if (g_state == ProfilerState::kAll) {
        std::cout << std::setw(data_width * 2)
                  << string::Sprintf(
                         "%f (%f)", event_item.cpu_time,
                         (event_item.cpu_time / event_item.total_time))
                  << std::setw(data_width * 2)
                  << string::Sprintf(
                         "%f (%f)", event_item.gpu_time,
                         (event_item.gpu_time / event_item.total_time));
      }
      std::cout << std::setw(data_width) << event_item.min_time
408
                << std::setw(data_width) << event_item.max_time
Y
Yan Chunwei 已提交
409
                << std::setw(data_width) << event_item.ave_time
410
                << std::setw(data_width) << event_item.ratio << std::endl;
411
      PrintProfiler(child_table, child_map, sorted_domain, name_width,
412
                    data_width, merge_thread, print_depth + 1, 0);
413
    }
414
  }
415 416
}

417 418
std::function<bool(const EventItem &, const EventItem &)> SetSortedFunc(
    EventSortingKey sorted_by, std::string *domain) {
419
  std::string sorted_domain;
C
chengduo 已提交
420
  std::function<bool(const EventItem &, const EventItem &)> sorted_func;
421 422 423
  switch (sorted_by) {
    case EventSortingKey::kCalls:
      sorted_domain = "number of calls";
C
chengduo 已提交
424
      sorted_func = [](const EventItem &a, const EventItem &b) {
425 426 427 428 429
        return a.calls > b.calls;
      };
      break;
    case EventSortingKey::kTotal:
      sorted_domain = "total time";
C
chengduo 已提交
430
      sorted_func = [](const EventItem &a, const EventItem &b) {
431 432 433 434 435
        return a.total_time > b.total_time;
      };
      break;
    case EventSortingKey::kMin:
      sorted_domain = "minimum time";
C
chengduo 已提交
436
      sorted_func = [](const EventItem &a, const EventItem &b) {
437 438 439 440 441
        return a.min_time > b.min_time;
      };
      break;
    case EventSortingKey::kMax:
      sorted_domain = "maximum time";
C
chengduo 已提交
442
      sorted_func = [](const EventItem &a, const EventItem &b) {
443 444 445 446 447
        return a.max_time > b.max_time;
      };
      break;
    case EventSortingKey::kAve:
      sorted_domain = "average time";
C
chengduo 已提交
448
      sorted_func = [](const EventItem &a, const EventItem &b) {
449 450 451
        return a.ave_time > b.ave_time;
      };
      break;
C
chengduo 已提交
452 453
    case EventSortingKey::kGPUTime:
      sorted_domain = "average time";
C
chengduo 已提交
454
      sorted_func = [](const EventItem &a, const EventItem &b) {
C
chengduo 已提交
455 456 457 458 459
        return a.gpu_time > b.gpu_time;
      };
      break;
    case EventSortingKey::kCPUTime:
      sorted_domain = "average time";
C
chengduo 已提交
460
      sorted_func = [](const EventItem &a, const EventItem &b) {
C
chengduo 已提交
461 462 463
        return a.cpu_time > b.cpu_time;
      };
      break;
464
    default:
465
      sorted_domain = "event first end time";
466
  }
467
  *domain = sorted_domain;
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
  return sorted_func;
}

void SetEvent(bool merge_thread, Event analyze_event, size_t *max_name_width,
              std::list<Event> *pushed_events,
              std::vector<EventItem> *event_items,
              std::unordered_map<std::string, int> *event_idx) {
  if (analyze_event.type() == EventType::kPushRange) {
    pushed_events->push_back(analyze_event);
  } else if (analyze_event.type() == EventType::kPopRange) {
    std::list<Event>::reverse_iterator rit = pushed_events->rbegin();
    while (rit != pushed_events->rend() &&
           rit->name() != analyze_event.name()) {
      ++rit;
    }
    // to find the father name event name

    if (rit != pushed_events->rend()) {
      double event_time = 0;
      double gpu_time = 0.0f;
#ifdef PADDLE_WITH_CUDA
      gpu_time = rit->CudaElapsedMs(analyze_event);
#endif
      double cpu_time = rit->CpuElapsedMs(analyze_event);
      if (g_state == ProfilerState::kCUDA) {
        event_time = gpu_time;
      } else if (g_state == ProfilerState::kCPU) {
        event_time = cpu_time;
      } else {
        event_time = gpu_time + cpu_time;
      }

      std::string event_name;
      if (merge_thread) {
        event_name = rit->name();
        *max_name_width = std::max(*max_name_width, event_name.size());
      } else {
        event_name =
            "thread" + std::to_string(rit->thread_id()) + "::" + rit->name();
        *max_name_width = std::max(*max_name_width, event_name.size());
      }

      if (event_idx->find(event_name) == event_idx->end()) {
        event_idx->insert({event_name, event_items->size()});
        EventItem event_item = {event_name, 1,          event_time,
                                event_time, event_time, event_time,
                                cpu_time,   gpu_time,   0.};
        event_items->push_back(event_item);
      } else {
        int index = event_idx->at(event_name);
        event_items->at(index).calls += 1;
        // total time
        event_items->at(index).total_time += event_time;
        // min time
        event_items->at(index).min_time =
            std::min(event_time, event_items->at(index).min_time);
        // max time
        event_items->at(index).max_time =
            std::max(event_time, event_items->at(index).max_time);
        event_items->at(index).gpu_time += gpu_time;
        event_items->at(index).cpu_time += cpu_time;
      }

      // remove the push marker from the list
      pushed_events->erase((++rit).base());
    } else {
      LOG(WARNING) << "Cannot find the push marker of event \'"
                   << analyze_event.name()
                   << "\', which will be ignored in profiling report.";
    }
  }
}
// Parse the event list and output the profiling report
void ParseEvents(const std::vector<std::vector<Event>> &events,
                 bool merge_thread,
                 EventSortingKey sorted_by = EventSortingKey::kDefault) {
  if (g_state == ProfilerState::kDisabled) return;
  if (merge_thread && events.size() < 2) return;

  std::string sorted_domain;
  std::function<bool(const EventItem &, const EventItem &)> sorted_func;
  sorted_func = SetSortedFunc(sorted_by, &sorted_domain);
550

C
chengduo 已提交
551
  const std::vector<std::vector<Event>> *analyze_events;
552 553 554
  std::vector<std::vector<Event>> merged_events_list;
  if (merge_thread) {
    std::vector<Event> merged_events;
Y
Yibing Liu 已提交
555 556
    for (size_t i = 0; i < events.size(); ++i) {
      for (size_t j = 0; j < events[i].size(); ++j) {
557 558 559 560 561 562 563 564 565
        merged_events.push_back(events[i][j]);
      }
    }
    merged_events_list.push_back(merged_events);
    analyze_events = &merged_events_list;
  } else {
    analyze_events = &events;
  }

566
  std::vector<std::vector<EventItem>> events_table;
567
  std::multimap<std::string, EventItem> child_map;
Y
Yibing Liu 已提交
568
  size_t max_name_width = 0;
569

570 571
  for (size_t i = 0; i < (*analyze_events).size(); i++) {
    double total = 0.;  // the total time in one thread
572
    std::list<Event> pushed_events;
573
    std::vector<EventItem> event_items;
574
    std::vector<EventItem> main_event_items;
575
    std::unordered_map<std::string, int> event_idx;
576
    std::multimap<std::string, EventItem> sub_child_map;
577

578
    for (size_t j = 0; j < (*analyze_events)[i].size(); j++) {
579 580 581 582
      Event analyze_event = (*analyze_events)[i][j];
      SetEvent(merge_thread, analyze_event, &max_name_width, &pushed_events,
               &event_items, &event_idx);
    }
583

584 585 586 587 588 589 590 591 592 593 594 595 596
    auto table_size = event_items.size();
    std::vector<int> child_index(table_size, 0);
    for (size_t j = 0; j < table_size; ++j) {
      std::string fname = event_items[j].name;
      std::string grad_name = event_items[j].name + "_grad";
      for (size_t k = 0; k < table_size; ++k) {
        std::string cname = event_items[k].name;
        bool condition = cname.length() > fname.length() &&
                         cname.rfind(fname, 0) == 0 &&
                         !cname.rfind(grad_name, 0) == 0 &&
                         (cname[fname.length()] == '/' &&
                          cname.rfind('/') == fname.length());
        if (condition) {
597
          sub_child_map.insert(
598 599
              std::pair<std::string, EventItem>(fname, event_items[k]));
          child_index[k] = 1;
600 601 602
        }
      }
    }
603 604 605 606 607 608 609 610

    for (size_t j = 0; j < table_size; ++j) {
      if (child_index[j] == 0) {
        main_event_items.push_back(event_items[j]);
        total += event_items[j].total_time;
      }
    }

611
    // average time
612
    for (auto &item : main_event_items) {
613
      item.ave_time = item.total_time / item.calls;
614
      item.ratio = item.total_time / total;
615
    }
616
    for (auto it = sub_child_map.begin(); it != sub_child_map.end(); it++) {
617
      it->second.ratio = it->second.total_time / total;
618
      it->second.ave_time = it->second.total_time / it->second.calls;
619 620
    }

621 622
    // sort
    if (sorted_by != EventSortingKey::kDefault) {
623
      std::sort(main_event_items.begin(), main_event_items.end(), sorted_func);
624
    }
625

626
    events_table.push_back(main_event_items);
Y
Yibing Liu 已提交
627
    // log warning if there are events with `push` but without `pop`
628 629
    std::list<Event>::reverse_iterator rit = pushed_events.rbegin();
    while (rit != pushed_events.rend()) {
Y
Yibing Liu 已提交
630 631
      LOG(WARNING) << "Cannot find the pop marker of event \'" << rit->name()
                   << "\', which will be ignored in profiling report.";
632 633
      ++rit;
    }
634 635 636 637 638

    for (auto it = sub_child_map.begin(); it != sub_child_map.end(); it++) {
      child_map.insert(
          std::pair<std::string, EventItem>(it->first, it->second));
    }
639
  }
640 641

  // Print report
642 643
  PrintProfiler(events_table, child_map, sorted_domain, max_name_width + 8, 12,
                merge_thread, 0, 0);
644 645
}

C
chengduo 已提交
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
struct MemoryProfierReport {
  size_t alloc_times{0};
  size_t alloc_size{0};
  size_t free_times{0};
  size_t free_size{0};
};

// Print results
void PrintMemProfiler(
    const std::map<Place, std::unordered_map<std::string, MemoryProfierReport>>
        &annotation_report,
    const size_t name_width, const size_t data_width) {
  // Output header information
  std::cout << "\n------------------------->"
            << "    Memory Profiling Report     "
            << "<-------------------------\n\n";

  // Output events table
  std::cout.setf(std::ios::left);
  std::cout << std::setw(name_width) << "Event" << std::setw(data_width)
            << "Alloc Calls" << std::setw(data_width) << "Size(MB)"
            << std::setw(data_width) << "Free Calls" << std::setw(data_width)
            << "Size(MB)" << std::endl;

  for (auto &tmp : annotation_report) {
    for (auto &e : tmp.second) {
      auto event_name = string::Sprintf("%s:%s", tmp.first, e.first);
      std::cout << std::setw(name_width) << event_name;
      std::cout << std::setw(data_width) << e.second.alloc_times;
      std::cout << std::setw(data_width)
                << e.second.alloc_size / (1024.0 * 1024.0);
      std::cout << std::setw(data_width) << e.second.free_times;
      std::cout << std::setw(data_width)
                << e.second.free_size / (1024.0 * 1024.0) << std::endl;
    }
  }
  std::cout << std::endl;
}

// parse memory events
void ParseMemEvents(const std::vector<std::vector<MemEvent>> &events) {
  if (g_state == ProfilerState::kDisabled) return;
  // place, annotation, alloc times,  alloc size
  std::map<Place, std::unordered_map<std::string, MemoryProfierReport>>
      annotation_report;

  for (auto &tmp : events) {
    for (auto &e : tmp) {
      if (e.type() == EventType::kPushRange) {
        annotation_report[e.place()][e.annotation()].alloc_times += 1;
        annotation_report[e.place()][e.annotation()].alloc_size += e.bytes();
      } else if (e.type() == EventType::kPopRange) {
        annotation_report[e.place()][e.annotation()].free_times += 1;
        annotation_report[e.place()][e.annotation()].free_size += e.bytes();
      }
    }
  }
  PrintMemProfiler(annotation_report, 55, 18);
}

706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
void DealWithShowName() {
  std::unordered_map<std::string, int> prefix_name;
  std::vector<std::string> op_out_name;
  for (auto it = g_all_event_lists.begin(); it != g_all_event_lists.end();
       ++it) {
    for (auto &block : (*it)->event_blocks) {
      for (auto &r : block) {
        auto event_name = r.name();
        size_t start = event_name.find('%', 0);
        size_t end = event_name.find('%', start + 1);
        std::string prefix_str = event_name.substr(0, start);
        while (start != std::string::npos && end != std::string::npos) {
          auto search_str = event_name.substr(start, end - start + 1);
          auto it = find(op_out_name.begin(), op_out_name.end(), search_str);
          std::string replace_str;
          bool prefix_find = true;
          if (prefix_name.find(prefix_str) == prefix_name.end()) {
            prefix_find = false;
            prefix_name[prefix_str] = 0;
          }

          if (it == op_out_name.end()) {
            if (prefix_find)
              prefix_name[prefix_str] = prefix_name[prefix_str] + 1;
            op_out_name.push_back(search_str);
          }
          replace_str = std::to_string(prefix_name[prefix_str]);
          event_name.replace(start, end - start + 1, replace_str);
          start = start + 1;
          start = event_name.find('%', start);
          end = event_name.find('%', start + 1);
          prefix_str = event_name.substr(0, start);
        }
        r.set_name(event_name);
      }
    }
  }
}

745
void DisableProfiler(EventSortingKey sorted_key,
C
chengduo 已提交
746
                     const std::string &profile_path) {
747
  SynchronizeAllDevice();
C
chengduo 已提交
748 749
  MemEvenRecorder::Instance().Flush();

X
Xin Pan 已提交
750
  std::lock_guard<std::mutex> l(profiler_mu);
751
  if (g_state == ProfilerState::kDisabled) return;
752
  // Mark the profiling stop.
753
  Mark("_stop_profiler_");
754
  DealWithShowName();
755

C
chengduo 已提交
756
  DeviceTracer *tracer = GetDeviceTracer();
757
  if (tracer->IsEnabled()) {
758
    tracer->Disable();
759
    tracer->GenEventKernelCudaElapsedTime();
760
    tracer->GenProfile(profile_path);
761
  }
762 763

  std::vector<std::vector<Event>> all_events = GetAllEvents();
764

765 766
  ParseEvents(all_events, true, sorted_key);
  ParseEvents(all_events, false, sorted_key);
C
chengduo 已提交
767 768 769 770 771
  if (VLOG_IS_ON(5)) {
    std::vector<std::vector<MemEvent>> all_mem_events = GetMemEvents();
    ParseMemEvents(all_mem_events);
  }

772
  ResetProfiler();
773
  g_state = ProfilerState::kDisabled;
X
Xin Pan 已提交
774
  should_send_profile_state = true;
775 776 777 778 779
}

bool IsProfileEnabled() { return g_state != ProfilerState::kDisabled; }
bool ShouldSendProfileState() { return should_send_profile_state; }

X
Xin Pan 已提交
780
void SetProfileListener() {
781 782 783
  std::mt19937 rng;
  rng.seed(std::random_device()());
  std::uniform_int_distribution<std::mt19937::result_type> dist6(
X
Xin Pan 已提交
784
      1, std::numeric_limits<int>::max());
785
  profiler_lister_id = dist6(rng);
786
}
787
int64_t ListenerId() { return profiler_lister_id; }
788

789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
std::string OpName(const framework::VariableNameMap &name_map,
                   const std::string &type_name) {
  if (platform::GetTracerOption() != platform::TracerOption::kAllOpDetail)
    return "";

  std::string ret = type_name + "%";
  for (auto it = name_map.begin(); it != name_map.end(); it++) {
    auto name_outputs = it->second;
    if (!name_outputs.empty() &&
        type_name.length() < name_outputs[0].length()) {
      ret = ret + name_outputs[0];
      break;
    }
  }
  ret = ret + "%";

  return ret;
}

void SetTracerOption(TracerOption option) {
  std::lock_guard<std::mutex> l(profiler_mu);
  g_tracer_option = option;
}

platform::TracerOption GetTracerOption() { return g_tracer_option; }
D
dangqingqing 已提交
814 815
}  // namespace platform
}  // namespace paddle