joshualitt | 27a48dc | 2016-01-08 07:19:47 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 Google Inc. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
| 6 | */ |
| 7 | |
| 8 | #ifndef GrAuditTrail_DEFINED |
| 9 | #define GrAuditTrail_DEFINED |
| 10 | |
joshualitt | 5651ee6 | 2016-01-11 10:39:11 -0800 | [diff] [blame] | 11 | #include "GrConfig.h" |
Robert Phillips | 294870f | 2016-11-11 12:38:40 -0500 | [diff] [blame] | 12 | #include "GrGpuResource.h" |
joshualitt | 086cee1 | 2016-01-12 06:45:24 -0800 | [diff] [blame] | 13 | #include "SkRect.h" |
joshualitt | 27a48dc | 2016-01-08 07:19:47 -0800 | [diff] [blame] | 14 | #include "SkString.h" |
| 15 | #include "SkTArray.h" |
joshualitt | 18d6b75 | 2016-02-26 08:07:50 -0800 | [diff] [blame] | 16 | #include "SkTHash.h" |
| 17 | |
Brian Salomon | 25a8809 | 2016-12-01 09:36:50 -0500 | [diff] [blame] | 18 | class GrOp; |
joshualitt | 27a48dc | 2016-01-08 07:19:47 -0800 | [diff] [blame] | 19 | |
| 20 | /* |
| 21 | * GrAuditTrail collects a list of draw ops, detailed information about those ops, and can dump them |
| 22 | * to json. |
ethannicholas | c85d9fb | 2016-02-18 13:45:39 -0800 | [diff] [blame] | 23 | * |
| 24 | * Capturing this information is expensive and consumes a lot of memory, therefore it is important |
| 25 | * to enable auditing only when required and disable it promptly. The AutoEnable class helps to |
| 26 | * ensure that the audit trail is disabled in a timely fashion. Once the information has been dealt |
| 27 | * with, be sure to call reset(), or the log will simply keep growing. |
joshualitt | 27a48dc | 2016-01-08 07:19:47 -0800 | [diff] [blame] | 28 | */ |
| 29 | class GrAuditTrail { |
| 30 | public: |
ethannicholas | c85d9fb | 2016-02-18 13:45:39 -0800 | [diff] [blame] | 31 | GrAuditTrail() |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 32 | : fClientID(kGrAuditTrailInvalidID) |
| 33 | , fEnabled(false) {} |
joshualitt | 87a721b | 2016-01-12 12:59:28 -0800 | [diff] [blame] | 34 | |
ethannicholas | c85d9fb | 2016-02-18 13:45:39 -0800 | [diff] [blame] | 35 | class AutoEnable { |
| 36 | public: |
| 37 | AutoEnable(GrAuditTrail* auditTrail) |
| 38 | : fAuditTrail(auditTrail) { |
| 39 | SkASSERT(!fAuditTrail->isEnabled()); |
| 40 | fAuditTrail->setEnabled(true); |
| 41 | } |
| 42 | |
| 43 | ~AutoEnable() { |
| 44 | SkASSERT(fAuditTrail->isEnabled()); |
| 45 | fAuditTrail->setEnabled(false); |
| 46 | } |
| 47 | |
| 48 | private: |
| 49 | GrAuditTrail* fAuditTrail; |
| 50 | }; |
| 51 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 52 | class AutoManageOpList { |
joshualitt | 18d6b75 | 2016-02-26 08:07:50 -0800 | [diff] [blame] | 53 | public: |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 54 | AutoManageOpList(GrAuditTrail* auditTrail) |
| 55 | : fAutoEnable(auditTrail), fAuditTrail(auditTrail) {} |
joshualitt | 18d6b75 | 2016-02-26 08:07:50 -0800 | [diff] [blame] | 56 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 57 | ~AutoManageOpList() { fAuditTrail->fullReset(); } |
joshualitt | 18d6b75 | 2016-02-26 08:07:50 -0800 | [diff] [blame] | 58 | |
| 59 | private: |
| 60 | AutoEnable fAutoEnable; |
| 61 | GrAuditTrail* fAuditTrail; |
| 62 | }; |
| 63 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 64 | class AutoCollectOps { |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 65 | public: |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 66 | AutoCollectOps(GrAuditTrail* auditTrail, int clientID) |
| 67 | : fAutoEnable(auditTrail), fAuditTrail(auditTrail) { |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 68 | fAuditTrail->setClientID(clientID); |
joshualitt | 87a721b | 2016-01-12 12:59:28 -0800 | [diff] [blame] | 69 | } |
| 70 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 71 | ~AutoCollectOps() { fAuditTrail->setClientID(kGrAuditTrailInvalidID); } |
joshualitt | 27a48dc | 2016-01-08 07:19:47 -0800 | [diff] [blame] | 72 | |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 73 | private: |
| 74 | AutoEnable fAutoEnable; |
| 75 | GrAuditTrail* fAuditTrail; |
| 76 | }; |
joshualitt | 87a721b | 2016-01-12 12:59:28 -0800 | [diff] [blame] | 77 | |
joshualitt | f55c364 | 2016-03-02 08:11:34 -0800 | [diff] [blame] | 78 | void pushFrame(const char* framename) { |
| 79 | SkASSERT(fEnabled); |
| 80 | fCurrentStackTrace.push_back(SkString(framename)); |
| 81 | } |
| 82 | |
Brian Salomon | 69868af | 2016-12-22 15:42:51 -0500 | [diff] [blame] | 83 | void addOp(const GrOp*, GrGpuResource::UniqueID renderTargetID); |
joshualitt | 086cee1 | 2016-01-12 06:45:24 -0800 | [diff] [blame] | 84 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 85 | void opsCombined(const GrOp* consumer, const GrOp* consumed); |
joshualitt | 18d6b75 | 2016-02-26 08:07:50 -0800 | [diff] [blame] | 86 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 87 | // Because op combining is heavily dependent on sequence of draw calls, these calls will only |
| 88 | // produce valid information for the given draw sequence which preceeded them. Specifically, ops |
| 89 | // of future draw calls may combine with previous ops and thus would invalidate the json. What |
| 90 | // this means is that for some sequence of draw calls N, the below toJson calls will only |
| 91 | // produce JSON which reflects N draw calls. This JSON may or may not be accurate for N + 1 or |
| 92 | // N - 1 draws depending on the actual combining algorithm used. |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 93 | SkString toJson(bool prettyPrint = false) const; |
| 94 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 95 | // returns a json string of all of the ops associated with a given client id |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 96 | SkString toJson(int clientID, bool prettyPrint = false) const; |
joshualitt | 27a48dc | 2016-01-08 07:19:47 -0800 | [diff] [blame] | 97 | |
ethannicholas | c85d9fb | 2016-02-18 13:45:39 -0800 | [diff] [blame] | 98 | bool isEnabled() { return fEnabled; } |
| 99 | void setEnabled(bool enabled) { fEnabled = enabled; } |
| 100 | |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 101 | void setClientID(int clientID) { fClientID = clientID; } |
joshualitt | 18d6b75 | 2016-02-26 08:07:50 -0800 | [diff] [blame] | 102 | |
joshualitt | 10d8fc2 | 2016-02-29 11:15:06 -0800 | [diff] [blame] | 103 | // We could just return our internal bookkeeping struct if copying the data out becomes |
| 104 | // a performance issue, but until then its nice to decouple |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 105 | struct OpInfo { |
| 106 | SkRect fBounds; |
Robert Phillips | 294870f | 2016-11-11 12:38:40 -0500 | [diff] [blame] | 107 | // TODO: switch over to GrSurfaceProxy::UniqueID |
| 108 | GrGpuResource::UniqueID fRenderTargetUniqueID; |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 109 | struct Op { |
joshualitt | 10d8fc2 | 2016-02-29 11:15:06 -0800 | [diff] [blame] | 110 | int fClientID; |
| 111 | SkRect fBounds; |
| 112 | }; |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 113 | SkTArray<Op> fOps; |
joshualitt | 10d8fc2 | 2016-02-29 11:15:06 -0800 | [diff] [blame] | 114 | }; |
| 115 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 116 | void getBoundsByClientID(SkTArray<OpInfo>* outInfo, int clientID); |
| 117 | void getBoundsByOpListID(OpInfo* outInfo, int opListID); |
joshualitt | 10d8fc2 | 2016-02-29 11:15:06 -0800 | [diff] [blame] | 118 | |
joshualitt | df3f2b0 | 2016-03-01 07:47:56 -0800 | [diff] [blame] | 119 | void fullReset(); |
joshualitt | 27a48dc | 2016-01-08 07:19:47 -0800 | [diff] [blame] | 120 | |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 121 | static const int kGrAuditTrailInvalidID; |
| 122 | |
joshualitt | 27a48dc | 2016-01-08 07:19:47 -0800 | [diff] [blame] | 123 | private: |
joshualitt | 11fae87 | 2016-01-14 10:58:07 -0800 | [diff] [blame] | 124 | // TODO if performance becomes an issue, we can move to using SkVarAlloc |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 125 | struct Op { |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 126 | SkString toJson() const; |
| 127 | SkString fName; |
joshualitt | f55c364 | 2016-03-02 08:11:34 -0800 | [diff] [blame] | 128 | SkTArray<SkString> fStackTrace; |
joshualitt | 08fc807 | 2016-02-29 06:32:24 -0800 | [diff] [blame] | 129 | SkRect fBounds; |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 130 | int fClientID; |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 131 | int fOpListID; |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 132 | int fChildID; |
joshualitt | 08fc807 | 2016-02-29 06:32:24 -0800 | [diff] [blame] | 133 | }; |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 134 | typedef SkTArray<std::unique_ptr<Op>, true> OpPool; |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 135 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 136 | typedef SkTArray<Op*> Ops; |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 137 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 138 | struct OpNode { |
| 139 | OpNode(const GrGpuResource::UniqueID& id) : fRenderTargetUniqueID(id) {} |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 140 | SkString toJson() const; |
Robert Phillips | 294870f | 2016-11-11 12:38:40 -0500 | [diff] [blame] | 141 | SkRect fBounds; |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 142 | Ops fChildren; |
Robert Phillips | 294870f | 2016-11-11 12:38:40 -0500 | [diff] [blame] | 143 | const GrGpuResource::UniqueID fRenderTargetUniqueID; |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 144 | }; |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 145 | typedef SkTArray<std::unique_ptr<OpNode>, true> OpList; |
joshualitt | 11fae87 | 2016-01-14 10:58:07 -0800 | [diff] [blame] | 146 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 147 | void copyOutFromOpList(OpInfo* outOpInfo, int opListID); |
joshualitt | 46b301d | 2016-03-02 08:32:37 -0800 | [diff] [blame] | 148 | |
joshualitt | 18d6b75 | 2016-02-26 08:07:50 -0800 | [diff] [blame] | 149 | template <typename T> |
| 150 | static void JsonifyTArray(SkString* json, const char* name, const T& array, |
joshualitt | adab5a2 | 2016-02-18 05:04:39 -0800 | [diff] [blame] | 151 | bool addComma); |
bungeman | 6bd5284 | 2016-10-27 09:30:08 -0700 | [diff] [blame] | 152 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 153 | OpPool fOpPool; |
joshualitt | b0666ad | 2016-03-08 10:43:41 -0800 | [diff] [blame] | 154 | SkTHashMap<uint32_t, int> fIDLookup; |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 155 | SkTHashMap<int, Ops*> fClientIDLookup; |
| 156 | OpList fOpList; |
joshualitt | f55c364 | 2016-03-02 08:11:34 -0800 | [diff] [blame] | 157 | SkTArray<SkString> fCurrentStackTrace; |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 158 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 159 | // The client can pass in an optional client ID which we will use to mark the ops |
joshualitt | b95c772 | 2016-02-29 07:44:02 -0800 | [diff] [blame] | 160 | int fClientID; |
| 161 | bool fEnabled; |
joshualitt | 27a48dc | 2016-01-08 07:19:47 -0800 | [diff] [blame] | 162 | }; |
| 163 | |
ethannicholas | c85d9fb | 2016-02-18 13:45:39 -0800 | [diff] [blame] | 164 | #define GR_AUDIT_TRAIL_INVOKE_GUARD(audit_trail, invoke, ...) \ |
| 165 | if (audit_trail->isEnabled()) { \ |
| 166 | audit_trail->invoke(__VA_ARGS__); \ |
joshualitt | 5651ee6 | 2016-01-11 10:39:11 -0800 | [diff] [blame] | 167 | } |
| 168 | |
joshualitt | 87a721b | 2016-01-12 12:59:28 -0800 | [diff] [blame] | 169 | #define GR_AUDIT_TRAIL_AUTO_FRAME(audit_trail, framename) \ |
joshualitt | f55c364 | 2016-03-02 08:11:34 -0800 | [diff] [blame] | 170 | GR_AUDIT_TRAIL_INVOKE_GUARD((audit_trail), pushFrame, framename); |
joshualitt | 5651ee6 | 2016-01-11 10:39:11 -0800 | [diff] [blame] | 171 | |
| 172 | #define GR_AUDIT_TRAIL_RESET(audit_trail) \ |
joshualitt | f55c364 | 2016-03-02 08:11:34 -0800 | [diff] [blame] | 173 | //GR_AUDIT_TRAIL_INVOKE_GUARD(audit_trail, fullReset); |
joshualitt | 5651ee6 | 2016-01-11 10:39:11 -0800 | [diff] [blame] | 174 | |
Brian Salomon | 69868af | 2016-12-22 15:42:51 -0500 | [diff] [blame] | 175 | #define GR_AUDIT_TRAIL_ADD_OP(audit_trail, op, rt_id) \ |
| 176 | GR_AUDIT_TRAIL_INVOKE_GUARD(audit_trail, addOp, op, rt_id); |
joshualitt | 086cee1 | 2016-01-12 06:45:24 -0800 | [diff] [blame] | 177 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 178 | #define GR_AUDIT_TRAIL_OPS_RESULT_COMBINED(audit_trail, combineWith, op) \ |
| 179 | GR_AUDIT_TRAIL_INVOKE_GUARD(audit_trail, opsCombined, combineWith, op); |
joshualitt | 18d6b75 | 2016-02-26 08:07:50 -0800 | [diff] [blame] | 180 | |
Brian Salomon | 42ad83a | 2016-12-20 16:14:45 -0500 | [diff] [blame] | 181 | #define GR_AUDIT_TRAIL_OP_RESULT_NEW(audit_trail, op) // Doesn't do anything now, one day... |
joshualitt | 18d6b75 | 2016-02-26 08:07:50 -0800 | [diff] [blame] | 182 | |
joshualitt | 27a48dc | 2016-01-08 07:19:47 -0800 | [diff] [blame] | 183 | #endif |