base/trace_event/memory_dump_request_args.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef BASE_TRACE_EVENT_MEMORY_DUMP_REQUEST_H_
   6 #define BASE_TRACE_EVENT_MEMORY_DUMP_REQUEST_H_
   7
   8 // This file defines the types and structs used to issue memory dump requests.
   9 // These are also used in the IPCs for coordinating inter-process memory dumps.
  10
  11 #include "base/base_export.h"
  12 #include "base/callback.h"
  13
  14 namespace base {
  15 namespace trace_event {
  16
  17 // Captures the reason why a memory dump is being requested. This is to allow
  18 // selective enabling of dumps, filtering and post-processing.
  19 enum class MemoryDumpType {
  20   TASK_BEGIN,         // Dumping memory at the beginning of a message-loop task.
  21   TASK_END,           // Dumping memory at the ending of a message-loop task.
  22   PERIODIC_INTERVAL,  // Dumping memory at periodic intervals.
  23   EXPLICITLY_TRIGGERED,  // Non maskable dump request.
  24   LAST = EXPLICITLY_TRIGGERED // For IPC macros.
  25 };
  26
  27 using MemoryDumpCallback = Callback<void(uint64 dump_guid, bool success)>;
  28
  29 struct BASE_EXPORT MemoryDumpRequestArgs {
  30   // Globally unique identifier. In multi-process dumps, all processes issue a
  31   // local dump with the same guid. This allows the trace importers to
  32   // reconstruct the global dump.
  33   uint64 dump_guid;
  34
  35   MemoryDumpType dump_type;
  36 };
  37
  38 }  // namespace trace_event
  39 }  // namespace base
  40
  41 #endif  // BASE_TRACE_EVENT_MEMORY_DUMP_REQUEST_H_