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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/*
* Copyright 2016 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef GrAuditTrail_DEFINED
#define GrAuditTrail_DEFINED
#include "GrConfig.h"
#include "SkRect.h"
#include "SkString.h"
#include "SkTArray.h"
#include "SkTHash.h"
class GrBatch;
/*
* GrAuditTrail collects a list of draw ops, detailed information about those ops, and can dump them
* to json.
*
* Capturing this information is expensive and consumes a lot of memory, therefore it is important
* to enable auditing only when required and disable it promptly. The AutoEnable class helps to
* ensure that the audit trail is disabled in a timely fashion. Once the information has been dealt
* with, be sure to call reset(), or the log will simply keep growing.
*/
class GrAuditTrail {
public:
GrAuditTrail()
: fEnabled(false)
, fUniqueID(0) {}
class AutoFrame {
public:
AutoFrame(GrAuditTrail* auditTrail, const char* name)
: fAuditTrail(auditTrail) {
if (fAuditTrail->fEnabled) {
fAuditTrail->pushFrame(name);
}
}
~AutoFrame() {
if (fAuditTrail->fEnabled) {
fAuditTrail->popFrame();
}
}
private:
GrAuditTrail* fAuditTrail;
};
class AutoEnable {
public:
AutoEnable(GrAuditTrail* auditTrail)
: fAuditTrail(auditTrail) {
SkASSERT(!fAuditTrail->isEnabled());
fAuditTrail->setEnabled(true);
}
~AutoEnable() {
SkASSERT(fAuditTrail->isEnabled());
fAuditTrail->setEnabled(false);
}
private:
GrAuditTrail* fAuditTrail;
};
class AutoManageBatchList {
public:
AutoManageBatchList(GrAuditTrail* auditTrail)
: fAutoEnable(auditTrail)
, fAuditTrail(auditTrail) {
}
~AutoManageBatchList() {
fAuditTrail->fullReset();
}
private:
AutoEnable fAutoEnable;
GrAuditTrail* fAuditTrail;
};
void pushFrame(const char* name) {
SkASSERT(fEnabled);
Frame* frame = new Frame;
fEvents.emplace_back(frame);
if (fStack.empty()) {
fFrames.push_back(frame);
} else {
fStack.back()->fChildren.push_back(frame);
}
frame->fUniqueID = fUniqueID++;
frame->fName = name;
fStack.push_back(frame);
}
void popFrame() {
SkASSERT(fEnabled);
fStack.pop_back();
}
void addBatch(const char* name, const SkRect& bounds) {
SkASSERT(fEnabled && !fStack.empty());
Batch* batch = new Batch;
fEvents.emplace_back(batch);
fStack.back()->fChildren.push_back(batch);
batch->fName = name;
batch->fBounds = bounds;
fCurrentBatch = batch;
}
void batchingResultCombined(GrBatch* combiner);
void batchingResultNew(GrBatch* batch);
SkString toJson(bool batchList = false, bool prettyPrint = false) const;
bool isEnabled() { return fEnabled; }
void setEnabled(bool enabled) { fEnabled = enabled; }
void reset() {
SkASSERT(fEnabled && fStack.empty());
fFrames.reset();
}
void resetBatchList() {
SkASSERT(fEnabled);
fBatches.reset();
fIDLookup.reset();
}
void fullReset() {
SkASSERT(fEnabled);
this->reset();
this->resetBatchList();
fEvents.reset(); // must be last, frees all of the memory
}
private:
// TODO if performance becomes an issue, we can move to using SkVarAlloc
struct Event {
virtual ~Event() {}
virtual SkString toJson() const=0;
const char* fName;
uint64_t fUniqueID;
};
struct Frame : public Event {
SkString toJson() const override;
SkTArray<Event*> fChildren;
};
struct Batch : public Event {
SkString toJson() const override;
SkRect fBounds;
SkTArray<Batch*> fChildren;
};
typedef SkTArray<SkAutoTDelete<Event>, true> EventArrayPool;
template <typename T>
static void JsonifyTArray(SkString* json, const char* name, const T& array,
bool addComma);
// We store both an array of frames, and also a flatter array just of the batches
bool fEnabled;
EventArrayPool fEvents; // manages the lifetimes of the events
SkTArray<Event*> fFrames;
SkTArray<Frame*> fStack;
uint64_t fUniqueID;
Batch* fCurrentBatch;
SkTHashMap<GrBatch*, int> fIDLookup;
SkTArray<Batch*> fBatches;
};
#define GR_AUDIT_TRAIL_INVOKE_GUARD(audit_trail, invoke, ...) \
if (audit_trail->isEnabled()) { \
audit_trail->invoke(__VA_ARGS__); \
}
#define GR_AUDIT_TRAIL_AUTO_FRAME(audit_trail, framename) \
GrAuditTrail::AutoFrame SK_MACRO_APPEND_LINE(auto_frame)(audit_trail, framename);
#define GR_AUDIT_TRAIL_RESET(audit_trail) \
GR_AUDIT_TRAIL_INVOKE_GUARD(audit_trail, reset);
#define GR_AUDIT_TRAIL_ADDBATCH(audit_trail, batchname, bounds) \
GR_AUDIT_TRAIL_INVOKE_GUARD(audit_trail, addBatch, batchname, bounds);
#define GR_AUDIT_TRAIL_BATCHING_RESULT_COMBINED(audit_trail, combiner) \
GR_AUDIT_TRAIL_INVOKE_GUARD(audit_trail, batchingResultCombined, combiner);
#define GR_AUDIT_TRAIL_BATCHING_RESULT_NEW(audit_trail, batch) \
GR_AUDIT_TRAIL_INVOKE_GUARD(audit_trail, batchingResultNew, batch);
#endif
|
