1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*
* Copyright 2015 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef SkTraceMemoryDump_DEFINED
#define SkTraceMemoryDump_DEFINED
#include "include/core/SkTypes.h"
class SkDiscardableMemory;
/**
* Interface for memory tracing.
* This interface is meant to be passed as argument to the memory dump methods of Skia objects.
* The implementation of this interface is provided by the embedder.
*/
class SK_API SkTraceMemoryDump {
public:
/**
* Enum to specify the level of the requested details for the dump from the Skia objects.
*/
enum LevelOfDetail {
// Dump only the minimal details to get the total memory usage (Usually just the totals).
kLight_LevelOfDetail,
// Dump the detailed breakdown of the objects in the caches.
kObjectsBreakdowns_LevelOfDetail
};
/**
* Appends a new memory dump (i.e. a row) to the trace memory infrastructure.
* If dumpName does not exist yet, a new one is created. Otherwise, a new column is appended to
* the previously created dump.
* Arguments:
* dumpName: an absolute, slash-separated, name for the item being dumped
* e.g., "skia/CacheX/EntryY".
* valueName: a string indicating the name of the column.
* e.g., "size", "active_size", "number_of_objects".
* This string is supposed to be long lived and is NOT copied.
* units: a string indicating the units for the value.
* e.g., "bytes", "objects".
* This string is supposed to be long lived and is NOT copied.
* value: the actual value being dumped.
*/
virtual void dumpNumericValue(const char* dumpName,
const char* valueName,
const char* units,
uint64_t value) = 0;
virtual void dumpStringValue(const char* /*dumpName*/,
const char* /*valueName*/,
const char* /*value*/) { }
/**
* Sets the memory backing for an existing dump.
* backingType and backingObjectId are used by the embedder to associate the memory dumped via
* dumpNumericValue with the corresponding dump that backs the memory.
*/
virtual void setMemoryBacking(const char* dumpName,
const char* backingType,
const char* backingObjectId) = 0;
/**
* Specialization for memory backed by discardable memory.
*/
virtual void setDiscardableMemoryBacking(
const char* dumpName,
const SkDiscardableMemory& discardableMemoryObject) = 0;
/**
* Returns the type of details requested in the dump. The granularity of the dump is supposed to
* match the LevelOfDetail argument. The level of detail must not affect the total size
* reported, but only granularity of the child entries.
*/
virtual LevelOfDetail getRequestedDetails() const = 0;
/**
* Returns true if we should dump wrapped objects. Wrapped objects come from outside Skia, and
* may be independently tracked there.
*/
virtual bool shouldDumpWrappedObjects() const { return true; }
/**
* If shouldDumpWrappedObjects() returns true then this function will be called to populate
* the output with information on whether the item being dumped is a wrapped object.
*/
virtual void dumpWrappedState(const char* /*dumpName*/, bool /*isWrappedObject*/) {}
/**
* Returns true if we should dump unbudgeted objects. Unbudgeted objects can either come from
* wrapped objects passed into Skia from the client or from Skia created objects currently held
* by the client in a public Skia object (e.g. SkSurface or SkImage). This call is only used
* when dumping Graphite memory statistics.
*/
virtual bool shouldDumpUnbudgetedObjects() const { return true; }
/**
* If shouldDumpUnbudgetedObjects() returns true then this function will be called to populate
* the output with information on whether the item being dumped is budgeted. This call is only
* used when dumping Graphite memory statistics.
*/
virtual void dumpBudgetedState(const char* /*dumpName*/, bool /*isBudgeted*/) {}
protected:
virtual ~SkTraceMemoryDump() = default;
SkTraceMemoryDump() = default;
SkTraceMemoryDump(const SkTraceMemoryDump&) = delete;
SkTraceMemoryDump& operator=(const SkTraceMemoryDump&) = delete;
};
#endif
|
