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 <stdint.h> 12 #include <map> 13 #include <string> 14 15 #include "base/base_export.h" 16 #include "base/callback.h" 17 #include "base/process/process_handle.h" 18 19 namespace base { 20 namespace trace_event { 21 22 // Captures the reason why a memory dump is being requested. This is to allow 23 // selective enabling of dumps, filtering and post-processing. Important: this 24 // must be kept consistent with 25 // services/resource_coordinator/public/cpp/memory/memory_infra_traits.cc. 26 enum class MemoryDumpType { 27 PERIODIC_INTERVAL, // Dumping memory at periodic intervals. 28 EXPLICITLY_TRIGGERED, // Non maskable dump request. 29 PEAK_MEMORY_USAGE, // Dumping memory at detected peak total memory usage. 30 LAST = PEAK_MEMORY_USAGE // For IPC macros. 31 }; 32 33 // Tells the MemoryDumpProvider(s) how much detailed their dumps should be. 34 // Important: this must be kept consistent with 35 // services/resource_Coordinator/public/cpp/memory/memory_infra_traits.cc. 36 enum class MemoryDumpLevelOfDetail : uint32_t { 37 FIRST, 38 39 // For background tracing mode. The dump time is quick, and typically just the 40 // totals are expected. Suballocations need not be specified. Dump name must 41 // contain only pre-defined strings and string arguments cannot be added. 42 BACKGROUND = FIRST, 43 44 // For the levels below, MemoryDumpProvider instances must guarantee that the 45 // total size reported in the root node is consistent. Only the granularity of 46 // the child MemoryAllocatorDump(s) differs with the levels. 47 48 // Few entries, typically a fixed number, per dump. 49 LIGHT, 50 51 // Unrestricted amount of entries per dump. 52 DETAILED, 53 54 LAST = DETAILED 55 }; 56 57 // Initial request arguments for a global memory dump. (see 58 // MemoryDumpManager::RequestGlobalMemoryDump()). Important: this must be kept 59 // consistent with services/memory_infra/public/cpp/memory_infra_traits.cc. 60 struct BASE_EXPORT MemoryDumpRequestArgs { 61 // Globally unique identifier. In multi-process dumps, all processes issue a 62 // local dump with the same guid. This allows the trace importers to 63 // reconstruct the global dump. 64 uint64_t dump_guid; 65 66 MemoryDumpType dump_type; 67 MemoryDumpLevelOfDetail level_of_detail; 68 }; 69 70 // Args for ProcessMemoryDump and passed to OnMemoryDump calls for memory dump 71 // providers. Dump providers are expected to read the args for creating dumps. 72 struct MemoryDumpArgs { 73 // Specifies how detailed the dumps should be. 74 MemoryDumpLevelOfDetail level_of_detail; 75 }; 76 77 // TODO(hjd): Not used yet, see crbug.com/703184 78 // Summarises information about memory use as seen by a single process. 79 // This information will eventually be passed to a service to be colated 80 // and reported. 81 struct MemoryDumpCallbackResult { 82 struct OSMemDump { 83 uint32_t resident_set_kb = 0; 84 }; 85 struct ChromeMemDump { 86 uint32_t malloc_total_kb = 0; 87 uint32_t partition_alloc_total_kb = 0; 88 uint32_t blink_gc_total_kb = 0; 89 uint32_t v8_total_kb = 0; 90 }; 91 92 // These are for the current process. 93 OSMemDump os_dump; 94 ChromeMemDump chrome_dump; 95 96 // In some cases, OS stats can only be dumped from a privileged process to 97 // get around to sandboxing/selinux restrictions (see crbug.com/461788). 98 std::map<ProcessId, OSMemDump> extra_processes_dump; 99 100 MemoryDumpCallbackResult(); 101 ~MemoryDumpCallbackResult(); 102 }; 103 104 using MemoryDumpCallback = Callback<void(uint64_t dump_guid, bool success)>; 105 106 BASE_EXPORT const char* MemoryDumpTypeToString(const MemoryDumpType& dump_type); 107 108 BASE_EXPORT MemoryDumpType StringToMemoryDumpType(const std::string& str); 109 110 BASE_EXPORT const char* MemoryDumpLevelOfDetailToString( 111 const MemoryDumpLevelOfDetail& level_of_detail); 112 113 BASE_EXPORT MemoryDumpLevelOfDetail 114 StringToMemoryDumpLevelOfDetail(const std::string& str); 115 116 } // namespace trace_event 117 } // namespace base 118 119 #endif // BASE_TRACE_EVENT_MEMORY_DUMP_REQUEST_ARGS_H_ 120