1 // Copyright 2015 The Chromium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include "base/trace_event/trace_event_memory_overhead.h"
6
7 #include <algorithm>
8
9 #include "base/bits.h"
10 #include "base/memory/ref_counted_memory.h"
11 #include "base/notreached.h"
12 #include "base/strings/stringprintf.h"
13 #include "base/trace_event/memory_allocator_dump.h"
14 #include "base/trace_event/memory_usage_estimator.h"
15 #include "base/trace_event/process_memory_dump.h"
16 #include "base/values.h"
17
18 namespace base::trace_event {
19
20 namespace {
21
ObjectTypeToString(TraceEventMemoryOverhead::ObjectType type)22 const char* ObjectTypeToString(TraceEventMemoryOverhead::ObjectType type) {
23 switch (type) {
24 case TraceEventMemoryOverhead::kOther:
25 return "(Other)";
26 case TraceEventMemoryOverhead::kTraceBuffer:
27 return "TraceBuffer";
28 case TraceEventMemoryOverhead::kTraceBufferChunk:
29 return "TraceBufferChunk";
30 case TraceEventMemoryOverhead::kTraceEvent:
31 return "TraceEvent";
32 case TraceEventMemoryOverhead::kUnusedTraceEvent:
33 return "TraceEvent(Unused)";
34 case TraceEventMemoryOverhead::kTracedValue:
35 return "TracedValue";
36 case TraceEventMemoryOverhead::kConvertableToTraceFormat:
37 return "ConvertableToTraceFormat";
38 case TraceEventMemoryOverhead::kHeapProfilerAllocationRegister:
39 return "AllocationRegister";
40 case TraceEventMemoryOverhead::kHeapProfilerTypeNameDeduplicator:
41 return "TypeNameDeduplicator";
42 case TraceEventMemoryOverhead::kHeapProfilerStackFrameDeduplicator:
43 return "StackFrameDeduplicator";
44 case TraceEventMemoryOverhead::kStdString:
45 return "std::string";
46 case TraceEventMemoryOverhead::kBaseValue:
47 return "base::Value";
48 case TraceEventMemoryOverhead::kTraceEventMemoryOverhead:
49 return "TraceEventMemoryOverhead";
50 case TraceEventMemoryOverhead::kFrameMetrics:
51 return "FrameMetrics";
52 case TraceEventMemoryOverhead::kLast:
53 NOTREACHED();
54 }
55 NOTREACHED();
56 }
57
58 } // namespace
59
TraceEventMemoryOverhead()60 TraceEventMemoryOverhead::TraceEventMemoryOverhead() : allocated_objects_() {}
61
62 TraceEventMemoryOverhead::~TraceEventMemoryOverhead() = default;
63
AddInternal(ObjectType object_type,size_t count,size_t allocated_size_in_bytes,size_t resident_size_in_bytes)64 void TraceEventMemoryOverhead::AddInternal(ObjectType object_type,
65 size_t count,
66 size_t allocated_size_in_bytes,
67 size_t resident_size_in_bytes) {
68 ObjectCountAndSize& count_and_size =
69 allocated_objects_[static_cast<uint32_t>(object_type)];
70 count_and_size.count += count;
71 count_and_size.allocated_size_in_bytes += allocated_size_in_bytes;
72 count_and_size.resident_size_in_bytes += resident_size_in_bytes;
73 }
74
Add(ObjectType object_type,size_t allocated_size_in_bytes)75 void TraceEventMemoryOverhead::Add(ObjectType object_type,
76 size_t allocated_size_in_bytes) {
77 Add(object_type, allocated_size_in_bytes, allocated_size_in_bytes);
78 }
79
Add(ObjectType object_type,size_t allocated_size_in_bytes,size_t resident_size_in_bytes)80 void TraceEventMemoryOverhead::Add(ObjectType object_type,
81 size_t allocated_size_in_bytes,
82 size_t resident_size_in_bytes) {
83 AddInternal(object_type, 1, allocated_size_in_bytes, resident_size_in_bytes);
84 }
85
AddString(const std::string & str)86 void TraceEventMemoryOverhead::AddString(const std::string& str) {
87 Add(kStdString, EstimateMemoryUsage(str));
88 }
89
AddRefCountedString(const RefCountedString & str)90 void TraceEventMemoryOverhead::AddRefCountedString(
91 const RefCountedString& str) {
92 Add(kOther, sizeof(RefCountedString));
93 AddString(str.as_string());
94 }
95
AddValue(const Value & value)96 void TraceEventMemoryOverhead::AddValue(const Value& value) {
97 switch (value.type()) {
98 case Value::Type::NONE:
99 case Value::Type::BOOLEAN:
100 case Value::Type::INTEGER:
101 case Value::Type::DOUBLE:
102 Add(kBaseValue, sizeof(Value));
103 break;
104
105 case Value::Type::STRING:
106 Add(kBaseValue, sizeof(Value));
107 AddString(value.GetString());
108 break;
109
110 case Value::Type::BINARY:
111 Add(kBaseValue, sizeof(Value) + value.GetBlob().size());
112 break;
113
114 case Value::Type::DICT:
115 Add(kBaseValue, sizeof(Value));
116 for (const auto pair : value.GetDict()) {
117 AddString(pair.first);
118 AddValue(pair.second);
119 }
120 break;
121
122 case Value::Type::LIST:
123 Add(kBaseValue, sizeof(Value));
124 for (const auto& v : value.GetList())
125 AddValue(v);
126 break;
127 }
128 }
129
AddSelf()130 void TraceEventMemoryOverhead::AddSelf() {
131 Add(kTraceEventMemoryOverhead, sizeof(*this));
132 }
133
GetCount(ObjectType object_type) const134 size_t TraceEventMemoryOverhead::GetCount(ObjectType object_type) const {
135 CHECK(object_type < kLast);
136 return allocated_objects_[static_cast<uint32_t>(object_type)].count;
137 }
138
Update(const TraceEventMemoryOverhead & other)139 void TraceEventMemoryOverhead::Update(const TraceEventMemoryOverhead& other) {
140 for (uint32_t i = 0; i < kLast; i++) {
141 const ObjectCountAndSize& other_entry = other.allocated_objects_[i];
142 AddInternal(static_cast<ObjectType>(i), other_entry.count,
143 other_entry.allocated_size_in_bytes,
144 other_entry.resident_size_in_bytes);
145 }
146 }
147
DumpInto(const char * base_name,ProcessMemoryDump * pmd) const148 void TraceEventMemoryOverhead::DumpInto(const char* base_name,
149 ProcessMemoryDump* pmd) const {
150 for (uint32_t i = 0; i < kLast; i++) {
151 const ObjectCountAndSize& count_and_size = allocated_objects_[i];
152 if (count_and_size.allocated_size_in_bytes == 0)
153 continue;
154 std::string dump_name = StringPrintf(
155 "%s/%s", base_name, ObjectTypeToString(static_cast<ObjectType>(i)));
156 MemoryAllocatorDump* mad = pmd->CreateAllocatorDump(dump_name);
157 mad->AddScalar(MemoryAllocatorDump::kNameSize,
158 MemoryAllocatorDump::kUnitsBytes,
159 count_and_size.allocated_size_in_bytes);
160 mad->AddScalar("resident_size", MemoryAllocatorDump::kUnitsBytes,
161 count_and_size.resident_size_in_bytes);
162 mad->AddScalar(MemoryAllocatorDump::kNameObjectCount,
163 MemoryAllocatorDump::kUnitsObjects, count_and_size.count);
164 }
165 }
166
167 } // namespace base::trace_event
168