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_ARGS_H_
   6 #define BASE_TRACE_EVENT_MEMORY_DUMP_REQUEST_ARGS_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 #include "base/trace_event/memory_dump_provider.h"
  14
  15 namespace base {
  16 namespace trace_event {
  17
  18 // Captures the reason why a memory dump is being requested. This is to allow
  19 // selective enabling of dumps, filtering and post-processing.
  20 enum class MemoryDumpType {
  21   TASK_BEGIN,         // Dumping memory at the beginning of a message-loop task.
  22   TASK_END,           // Dumping memory at the ending of a message-loop task.
  23   PERIODIC_INTERVAL,  // Dumping memory at periodic intervals.
  24   EXPLICITLY_TRIGGERED,  // Non maskable dump request.
  25   LAST = EXPLICITLY_TRIGGERED // For IPC macros.
  26 };
  27
  28 // Returns the name in string for the dump type given.
  29 BASE_EXPORT const char* MemoryDumpTypeToString(const MemoryDumpType& dump_type);
  30
  31 using MemoryDumpCallback = Callback<void(uint64 dump_guid, bool success)>;
  32
  33 struct BASE_EXPORT MemoryDumpRequestArgs {
  34   // Globally unique identifier. In multi-process dumps, all processes issue a
  35   // local dump with the same guid. This allows the trace importers to
  36   // reconstruct the global dump.
  37   uint64 dump_guid;
  38
  39   MemoryDumpType dump_type;
  40
  41   MemoryDumpArgs dump_args;
  42 };
  43
  44 }  // namespace trace_event
  45 }  // namespace base
  46
  47 #endif  // BASE_TRACE_EVENT_MEMORY_DUMP_REQUEST_ARGS_H_