blob: 0dd45c8b0491a8d8fc8f4e1ad071eb7028a582f4 [file] [log] [blame]
John Zulauf3d84f1b2020-03-09 13:33:25 -06001/*
2 * Copyright (c) 2019-2020 Valve Corporation
3 * Copyright (c) 2019-2020 LunarG, Inc.
John Zulauf9cb530d2019-09-30 14:14:10 -06004 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 * Author: John Zulauf <jzulauf@lunarg.com>
18 */
19
20#pragma once
21
John Zulauf7635de32020-05-29 17:14:15 -060022#include <limits>
John Zulauf9cb530d2019-09-30 14:14:10 -060023#include <map>
24#include <memory>
25#include <unordered_map>
26#include <vulkan/vulkan.h>
27
28#include "synchronization_validation_types.h"
29#include "state_tracker.h"
30
John Zulauf355e49b2020-04-24 15:11:15 -060031class SyncValidator;
John Zulauf59e25072020-07-17 10:55:21 -060032class ResourceAccessState;
John Zulauf355e49b2020-04-24 15:11:15 -060033
John Zulauf2f952d22020-02-10 11:34:51 -070034enum SyncHazard {
35 NONE = 0,
36 READ_AFTER_WRITE,
37 WRITE_AFTER_READ,
38 WRITE_AFTER_WRITE,
39 READ_RACING_WRITE,
40 WRITE_RACING_WRITE,
41 WRITE_RACING_READ,
42};
John Zulauf9cb530d2019-09-30 14:14:10 -060043
44// Useful Utilites for manipulating StageAccess parameters, suitable as base class to save typing
45struct SyncStageAccess {
Jeremy Gebbend0de1f82020-11-09 08:21:07 -070046 static inline SyncStageAccessFlags FlagBit(SyncStageAccessIndex stage_access) {
John Zulauf9cb530d2019-09-30 14:14:10 -060047 return syncStageAccessInfoByStageAccessIndex[stage_access].stage_access_bit;
48 }
John Zulauf1507ee42020-05-18 11:33:09 -060049 static inline SyncStageAccessFlags Flags(SyncStageAccessIndex stage_access) {
50 return static_cast<SyncStageAccessFlags>(FlagBit(stage_access));
51 }
John Zulauf9cb530d2019-09-30 14:14:10 -060052
Jeremy Gebbend0de1f82020-11-09 08:21:07 -070053 static bool IsRead(const SyncStageAccessFlags &stage_access_bit) { return (stage_access_bit & syncStageAccessReadMask).any(); }
John Zulauf9cb530d2019-09-30 14:14:10 -060054 static bool IsRead(SyncStageAccessIndex stage_access_index) { return IsRead(FlagBit(stage_access_index)); }
55
Jeremy Gebbend0de1f82020-11-09 08:21:07 -070056 static bool IsWrite(const SyncStageAccessFlags &stage_access_bit) {
57 return (stage_access_bit & syncStageAccessWriteMask).any();
58 }
59 static bool HasWrite(const SyncStageAccessFlags &stage_access_mask) {
60 return (stage_access_mask & syncStageAccessWriteMask).any();
61 }
John Zulauf9cb530d2019-09-30 14:14:10 -060062 static bool IsWrite(SyncStageAccessIndex stage_access_index) { return IsWrite(FlagBit(stage_access_index)); }
63 static VkPipelineStageFlagBits PipelineStageBit(SyncStageAccessIndex stage_access_index) {
64 return syncStageAccessInfoByStageAccessIndex[stage_access_index].stage_mask;
65 }
66 static SyncStageAccessFlags AccessScopeByStage(VkPipelineStageFlags stages);
67 static SyncStageAccessFlags AccessScopeByAccess(VkAccessFlags access);
68 static SyncStageAccessFlags AccessScope(VkPipelineStageFlags stages, VkAccessFlags access);
Jeremy Gebbend0de1f82020-11-09 08:21:07 -070069 static SyncStageAccessFlags AccessScope(const SyncStageAccessFlags &stage_scope, VkAccessFlags accesses) {
John Zulauf9cb530d2019-09-30 14:14:10 -060070 return stage_scope & AccessScopeByAccess(accesses);
71 }
72};
73
John Zulauf5f13a792020-03-10 07:31:21 -060074struct ResourceUsageTag {
75 uint64_t index;
John Zulaufcc6fecb2020-06-17 15:24:54 -060076 CMD_TYPE command;
John Zulauf7635de32020-05-29 17:14:15 -060077 const static uint64_t kMaxIndex = std::numeric_limits<uint64_t>::max();
John Zulauf5f13a792020-03-10 07:31:21 -060078 ResourceUsageTag &operator++() {
79 index++;
80 return *this;
81 }
82 bool IsBefore(const ResourceUsageTag &rhs) const { return index < rhs.index; }
John Zulaufe5da6e52020-03-18 15:32:18 -060083 bool operator==(const ResourceUsageTag &rhs) const { return (index == rhs.index); }
84 bool operator!=(const ResourceUsageTag &rhs) const { return !(*this == rhs); }
John Zulaufcc6fecb2020-06-17 15:24:54 -060085 ResourceUsageTag() : index(0), command(CMD_NONE) {}
86 ResourceUsageTag(uint64_t index_, CMD_TYPE command_) : index(index_), command(command_) {}
John Zulauf5f13a792020-03-10 07:31:21 -060087};
88
John Zulauf9cb530d2019-09-30 14:14:10 -060089struct HazardResult {
John Zulauf59e25072020-07-17 10:55:21 -060090 std::unique_ptr<const ResourceAccessState> access_state;
91 SyncStageAccessIndex usage_index = std::numeric_limits<SyncStageAccessIndex>::max();
John Zulauf9cb530d2019-09-30 14:14:10 -060092 SyncHazard hazard = NONE;
John Zulauf37ceaed2020-07-03 16:18:15 -060093 SyncStageAccessFlags prior_access = 0U; // TODO -- change to a NONE enum in ...Bits
John Zulauf9cb530d2019-09-30 14:14:10 -060094 ResourceUsageTag tag = ResourceUsageTag();
John Zulauf59e25072020-07-17 10:55:21 -060095 void Set(const ResourceAccessState *access_state_, SyncStageAccessIndex usage_index_, SyncHazard hazard_,
Jeremy Gebbend0de1f82020-11-09 08:21:07 -070096 const SyncStageAccessFlags &prior_, const ResourceUsageTag &tag_);
John Zulauf9cb530d2019-09-30 14:14:10 -060097};
98
John Zulauf3d84f1b2020-03-09 13:33:25 -060099struct SyncBarrier {
100 VkPipelineStageFlags src_exec_scope;
101 SyncStageAccessFlags src_access_scope;
102 VkPipelineStageFlags dst_exec_scope;
103 SyncStageAccessFlags dst_access_scope;
104 SyncBarrier() = default;
105 SyncBarrier &operator=(const SyncBarrier &) = default;
106 SyncBarrier(VkQueueFlags gueue_flags, const VkSubpassDependency2 &sub_pass_barrier);
John Zulaufa0a98292020-09-18 09:30:10 -0600107 void Merge(const SyncBarrier &other) {
108 src_exec_scope |= other.src_exec_scope;
109 src_access_scope |= other.src_access_scope;
110 dst_exec_scope |= other.dst_exec_scope;
111 dst_access_scope |= other.dst_access_scope;
112 }
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700113 SyncBarrier(VkPipelineStageFlags src_exec_scope_, const SyncStageAccessFlags &src_access_scope_,
114 VkPipelineStageFlags dst_exec_scope_, const SyncStageAccessFlags &dst_access_scope_)
John Zulaufa0a98292020-09-18 09:30:10 -0600115 : src_exec_scope(src_exec_scope_),
116 src_access_scope(src_access_scope_),
117 dst_exec_scope(dst_exec_scope_),
118 dst_access_scope(dst_access_scope_) {}
John Zulauf89311b42020-09-29 16:28:47 -0600119 SyncBarrier(const SyncBarrier &other) = default;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600120};
John Zulauf69133422020-05-20 14:55:53 -0600121
John Zulauf43cc7462020-12-03 12:33:12 -0700122enum class AccessAddressType : uint32_t { kLinear = 0, kIdealized = 1, kMaxType = 1, kTypeCount = kMaxType + 1 };
123
John Zulauf4a6105a2020-11-17 15:11:05 -0700124struct SyncEventState {
125 enum IgnoreReason { NotIgnored = 0, ResetWaitRace, SetRace, MissingStageBits };
126 using EventPointer = std::shared_ptr<EVENT_STATE>;
127 using ScopeMap = sparse_container::range_map<VkDeviceSize, bool>;
128 EventPointer event;
129 CMD_TYPE last_command; // Only Event commands are valid here.
130 CMD_TYPE unsynchronized_set;
131 VkPipelineStageFlags barriers;
132 VkPipelineStageFlags stage_mask_param;
133 VkPipelineStageFlags stage_mask;
134 VkPipelineStageFlags exec_scope;
135 SyncStageAccessFlags stage_accesses;
136 ResourceUsageTag first_scope_tag;
137 std::array<ScopeMap, static_cast<size_t>(AccessAddressType::kTypeCount)> first_scope;
138 SyncEventState(const EventPointer &event_state)
139 : event(event_state),
140 last_command(CMD_NONE),
141 unsynchronized_set(CMD_NONE),
142 barriers(0U),
143 stage_mask_param(0U),
144 stage_mask(0U),
145 exec_scope(0U),
146 stage_accesses() {}
147 SyncEventState() : SyncEventState(EventPointer()) {}
148 void ResetFirstScope();
149 const ScopeMap &FirstScope(AccessAddressType address_type) const { return first_scope[static_cast<size_t>(address_type)]; }
150 IgnoreReason IsIgnoredByWait(VkPipelineStageFlags srcStageMask) const;
151 bool HasBarrier(VkPipelineStageFlags stageMask, VkPipelineStageFlags exec_scope) const;
152};
153
John Zulauf69133422020-05-20 14:55:53 -0600154// To represent ordering guarantees such as rasterization and store
155struct SyncOrderingBarrier {
156 VkPipelineStageFlags exec_scope;
157 SyncStageAccessFlags access_scope;
158 SyncOrderingBarrier() = default;
159 SyncOrderingBarrier &operator=(const SyncOrderingBarrier &) = default;
160};
John Zulauf3d84f1b2020-03-09 13:33:25 -0600161
John Zulauf9cb530d2019-09-30 14:14:10 -0600162class ResourceAccessState : public SyncStageAccess {
163 protected:
164 // Mutliple read operations can be simlutaneously (and independently) synchronized,
165 // given the only the second execution scope creates a dependency chain, we have to track each,
166 // but only up to one per pipeline stage (as another read from the *same* stage become more recent,
167 // and applicable one for hazard detection
168 struct ReadState {
169 VkPipelineStageFlagBits stage; // The stage of this read
John Zulauf37ceaed2020-07-03 16:18:15 -0600170 SyncStageAccessFlags access; // TODO: Change to FlagBits when we have a None bit enum
John Zulauff51fbb62020-10-02 14:43:24 -0600171 // TODO: Revisit whether this needs to support multiple reads per stage
John Zulauf9cb530d2019-09-30 14:14:10 -0600172 VkPipelineStageFlags barriers; // all applicable barriered stages
173 ResourceUsageTag tag;
John Zulauf89311b42020-09-29 16:28:47 -0600174 VkPipelineStageFlags pending_dep_chain; // Should be zero except during barrier application
175 // Excluded from comparison
176 ReadState() = default;
John Zulaufe5da6e52020-03-18 15:32:18 -0600177 bool operator==(const ReadState &rhs) const {
John Zulauf37ceaed2020-07-03 16:18:15 -0600178 bool same = (stage == rhs.stage) && (access == rhs.access) && (barriers == rhs.barriers) && (tag == rhs.tag);
John Zulaufe5da6e52020-03-18 15:32:18 -0600179 return same;
180 }
John Zulauf4a6105a2020-11-17 15:11:05 -0700181 bool IsReadBarrierHazard(VkPipelineStageFlags src_exec_scope) const {
182 // If the read stage is not in the src sync scope
183 // *AND* not execution chained with an existing sync barrier (that's the or)
184 // then the barrier access is unsafe (R/W after R)
185 return (src_exec_scope & (stage | barriers)) == 0;
186 }
187
John Zulaufe5da6e52020-03-18 15:32:18 -0600188 bool operator!=(const ReadState &rhs) const { return !(*this == rhs); }
John Zulauf4285ee92020-09-23 10:20:52 -0600189 inline void Set(VkPipelineStageFlagBits stage_, SyncStageAccessFlags access_, VkPipelineStageFlags barriers_,
190 const ResourceUsageTag &tag_) {
191 stage = stage_;
192 access = access_;
193 barriers = barriers_;
194 tag = tag_;
John Zulauf89311b42020-09-29 16:28:47 -0600195 pending_dep_chain = 0; // If this is a new read, we aren't applying a barrier set.
John Zulauf4285ee92020-09-23 10:20:52 -0600196 }
John Zulauf9cb530d2019-09-30 14:14:10 -0600197 };
198
199 public:
200 HazardResult DetectHazard(SyncStageAccessIndex usage_index) const;
John Zulauf69133422020-05-20 14:55:53 -0600201 HazardResult DetectHazard(SyncStageAccessIndex usage_index, const SyncOrderingBarrier &ordering) const;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600202
John Zulaufc9201222020-05-13 15:13:03 -0600203 HazardResult DetectBarrierHazard(SyncStageAccessIndex usage_index, VkPipelineStageFlags source_exec_scope,
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700204 const SyncStageAccessFlags &source_access_scope) const;
Jeremy Gebbenc4b78c52020-12-11 09:39:47 -0700205 HazardResult DetectAsyncHazard(SyncStageAccessIndex usage_index, const ResourceUsageTag &start_tag) const;
John Zulauf4a6105a2020-11-17 15:11:05 -0700206 HazardResult DetectBarrierHazard(SyncStageAccessIndex usage_index, VkPipelineStageFlags source_exec_scope,
207 const SyncStageAccessFlags &source_access_scope, const ResourceUsageTag &event_tag) const;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600208
John Zulauf9cb530d2019-09-30 14:14:10 -0600209 void Update(SyncStageAccessIndex usage_index, const ResourceUsageTag &tag);
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700210 void SetWrite(const SyncStageAccessFlags &usage_bit, const ResourceUsageTag &tag);
John Zulauf5f13a792020-03-10 07:31:21 -0600211 void Resolve(const ResourceAccessState &other);
John Zulaufb02c1eb2020-10-06 16:33:36 -0600212 void ApplyBarriers(const std::vector<SyncBarrier> &barriers, bool layout_transition);
213 void ApplyBarriers(const std::vector<SyncBarrier> &barriers, const ResourceUsageTag &tag);
John Zulauf89311b42020-09-29 16:28:47 -0600214 void ApplyBarrier(const SyncBarrier &barrier, bool layout_transition);
John Zulauf4a6105a2020-11-17 15:11:05 -0700215 void ApplyBarrier(const ResourceUsageTag &scope_tag, const SyncBarrier &barrier, bool layout_transition);
John Zulauf89311b42020-09-29 16:28:47 -0600216 void ApplyPendingBarriers(const ResourceUsageTag &tag);
John Zulauf9cb530d2019-09-30 14:14:10 -0600217
218 ResourceAccessState()
John Zulauf355e49b2020-04-24 15:11:15 -0600219 : write_barriers(~SyncStageAccessFlags(0)),
220 write_dependency_chain(0),
John Zulauf355e49b2020-04-24 15:11:15 -0600221 write_tag(),
John Zulaufd14743a2020-07-03 09:42:39 -0600222 last_write(0),
John Zulauff51fbb62020-10-02 14:43:24 -0600223 input_attachment_read(false),
John Zulaufd14743a2020-07-03 09:42:39 -0600224 last_read_count(0),
John Zulauf361fb532020-07-22 10:45:39 -0600225 last_read_stages(0),
John Zulauf89311b42020-09-29 16:28:47 -0600226 read_execution_barriers(0),
227 pending_write_dep_chain(0),
228 pending_layout_transition(false),
229 pending_write_barriers(0) {}
John Zulauf9cb530d2019-09-30 14:14:10 -0600230
John Zulaufb02c1eb2020-10-06 16:33:36 -0600231 bool HasPendingState() const {
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700232 return (0 != pending_layout_transition) || pending_write_barriers.any() || (0 != pending_write_dep_chain);
John Zulaufb02c1eb2020-10-06 16:33:36 -0600233 }
John Zulauf3d84f1b2020-03-09 13:33:25 -0600234 bool HasWriteOp() const { return last_write != 0; }
John Zulaufe5da6e52020-03-18 15:32:18 -0600235 bool operator==(const ResourceAccessState &rhs) const {
236 bool same = (write_barriers == rhs.write_barriers) && (write_dependency_chain == rhs.write_dependency_chain) &&
237 (last_read_count == rhs.last_read_count) && (last_read_stages == rhs.last_read_stages) &&
John Zulauff51fbb62020-10-02 14:43:24 -0600238 (write_tag == rhs.write_tag) && (input_attachment_read == rhs.input_attachment_read) &&
John Zulauf361fb532020-07-22 10:45:39 -0600239 (read_execution_barriers == rhs.read_execution_barriers);
John Zulaufe5da6e52020-03-18 15:32:18 -0600240 for (uint32_t i = 0; same && i < last_read_count; i++) {
John Zulauf4285ee92020-09-23 10:20:52 -0600241 same &= last_reads[i] == rhs.last_reads[i];
John Zulaufe5da6e52020-03-18 15:32:18 -0600242 }
243 return same;
244 }
245 bool operator!=(const ResourceAccessState &rhs) const { return !(*this == rhs); }
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700246 VkPipelineStageFlags GetReadBarriers(const SyncStageAccessFlags &usage) const;
John Zulauf59e25072020-07-17 10:55:21 -0600247 SyncStageAccessFlags GetWriteBarriers() const { return write_barriers; }
John Zulauf4a6105a2020-11-17 15:11:05 -0700248 bool InSourceScopeOrChain(VkPipelineStageFlags src_exec_scope, SyncStageAccessFlags src_access_scope) const {
249 return ReadInSourceScopeOrChain(src_exec_scope) || WriteInSourceScopeOrChain(src_exec_scope, src_access_scope);
250 }
John Zulauf3d84f1b2020-03-09 13:33:25 -0600251
John Zulauf9cb530d2019-09-30 14:14:10 -0600252 private:
John Zulauf4285ee92020-09-23 10:20:52 -0600253 static constexpr VkPipelineStageFlags kInvalidAttachmentStage = ~VkPipelineStageFlags(0);
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700254 bool IsWriteHazard(SyncStageAccessFlags usage) const { return (usage & ~write_barriers).any(); }
255 bool IsRAWHazard(VkPipelineStageFlagBits usage_stage, const SyncStageAccessFlags &usage) const;
John Zulauf4a6105a2020-11-17 15:11:05 -0700256 bool IsWriteBarrierHazard(VkPipelineStageFlags src_exec_scope, const SyncStageAccessFlags &src_access_scope) const {
257 // If the previous write is *not* in the 1st access scope
258 // *AND* the current barrier is not in the dependency chain
259 // *AND* the there is no prior memory barrier for the previous write in the dependency chain
260 // then the barrier access is unsafe (R/W after W)
261 return ((last_write & src_access_scope) == 0) && ((src_exec_scope & write_dependency_chain) == 0) && (write_barriers == 0);
262 }
263 bool ReadInSourceScopeOrChain(VkPipelineStageFlags src_exec_scope) const {
264 return (0 != (src_exec_scope & (last_read_stages | read_execution_barriers)));
265 }
266 bool WriteInSourceScopeOrChain(VkPipelineStageFlags src_exec_scope, SyncStageAccessFlags src_access_scope) const {
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700267 return (src_access_scope & last_write).any() || (write_dependency_chain & src_exec_scope);
John Zulaufa0a98292020-09-18 09:30:10 -0600268 }
John Zulaufd14743a2020-07-03 09:42:39 -0600269
270 static bool IsReadHazard(VkPipelineStageFlagBits stage, const VkPipelineStageFlags barriers) {
271 return 0 != (stage & ~barriers);
272 }
273 static bool IsReadHazard(VkPipelineStageFlags stage_mask, const VkPipelineStageFlags barriers) {
274 return stage_mask != (stage_mask & barriers);
275 }
276
John Zulauf9cb530d2019-09-30 14:14:10 -0600277 bool IsReadHazard(VkPipelineStageFlagBits stage, const ReadState &read_access) const {
John Zulaufd14743a2020-07-03 09:42:39 -0600278 return IsReadHazard(stage, read_access.barriers);
John Zulauf9cb530d2019-09-30 14:14:10 -0600279 }
John Zulauf0cb5be22020-01-23 12:18:22 -0700280 bool IsReadHazard(VkPipelineStageFlags stage_mask, const ReadState &read_access) const {
John Zulaufd14743a2020-07-03 09:42:39 -0600281 return IsReadHazard(stage_mask, read_access.barriers);
John Zulauf0cb5be22020-01-23 12:18:22 -0700282 }
John Zulauf4285ee92020-09-23 10:20:52 -0600283 VkPipelineStageFlags GetOrderedStages(const SyncOrderingBarrier &ordering) const;
284 ReadState *GetReadStateForStage(VkPipelineStageFlagBits stage, uint32_t search_limit = kStageCount);
John Zulaufd14743a2020-07-03 09:42:39 -0600285
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700286 // TODO: Add a NONE (zero) enum to SyncStageAccessFlags for input_attachment_read and last_write
John Zulaufd14743a2020-07-03 09:42:39 -0600287
John Zulauf9cb530d2019-09-30 14:14:10 -0600288 // With reads, each must be "safe" relative to it's prior write, so we need only
289 // save the most recent write operation (as anything *transitively* unsafe would arleady
290 // be included
291 SyncStageAccessFlags write_barriers; // union of applicable barrier masks since last write
292 VkPipelineStageFlags write_dependency_chain; // intiially zero, but accumulating the dstStages of barriers if they chain.
John Zulauf9cb530d2019-09-30 14:14:10 -0600293 ResourceUsageTag write_tag;
John Zulauf355e49b2020-04-24 15:11:15 -0600294 SyncStageAccessFlags last_write; // only the most recent write
John Zulauf9cb530d2019-09-30 14:14:10 -0600295
John Zulauff51fbb62020-10-02 14:43:24 -0600296 // TODO Input Attachment cleanup for multiple reads in a given stage
297 // Tracks whether the fragment shader read is input attachment read
298 bool input_attachment_read;
John Zulaufd14743a2020-07-03 09:42:39 -0600299
300 uint32_t last_read_count;
301 VkPipelineStageFlags last_read_stages;
John Zulauf361fb532020-07-22 10:45:39 -0600302 VkPipelineStageFlags read_execution_barriers;
John Zulaufd14743a2020-07-03 09:42:39 -0600303 static constexpr size_t kStageCount = 32; // TODO: The manual count was 28 real stages. Add stage count to codegen
304 std::array<ReadState, kStageCount> last_reads;
John Zulauf89311b42020-09-29 16:28:47 -0600305
306 // Pending execution state to support independent parallel barriers
307 VkPipelineStageFlags pending_write_dep_chain;
308 bool pending_layout_transition;
309 SyncStageAccessFlags pending_write_barriers;
John Zulauf9cb530d2019-09-30 14:14:10 -0600310};
311
John Zulauf16adfc92020-04-08 10:28:33 -0600312using ResourceAccessRangeMap = sparse_container::range_map<VkDeviceSize, ResourceAccessState>;
John Zulauf5c5e88d2019-12-26 11:22:02 -0700313using ResourceAccessRange = typename ResourceAccessRangeMap::key_type;
John Zulauf355e49b2020-04-24 15:11:15 -0600314using ResourceRangeMergeIterator = sparse_container::parallel_iterator<ResourceAccessRangeMap, const ResourceAccessRangeMap>;
John Zulauf9cb530d2019-09-30 14:14:10 -0600315
John Zulauf540266b2020-04-06 18:54:53 -0600316class AccessContext {
John Zulauf5c5e88d2019-12-26 11:22:02 -0700317 public:
John Zulauf69133422020-05-20 14:55:53 -0600318 enum DetectOptions : uint32_t {
John Zulauf355e49b2020-04-24 15:11:15 -0600319 kDetectPrevious = 1U << 0,
320 kDetectAsync = 1U << 1,
321 kDetectAll = (kDetectPrevious | kDetectAsync)
John Zulauf16adfc92020-04-08 10:28:33 -0600322 };
John Zulauf43cc7462020-12-03 12:33:12 -0700323 using MapArray = std::array<ResourceAccessRangeMap, static_cast<size_t>(AccessAddressType::kTypeCount)>;
John Zulauf16adfc92020-04-08 10:28:33 -0600324
John Zulaufbaea94f2020-09-15 17:55:16 -0600325 // WIP TODO WIP Multi-dep -- change track back to support barrier vector, not just last.
John Zulauf3d84f1b2020-03-09 13:33:25 -0600326 struct TrackBack {
John Zulaufa0a98292020-09-18 09:30:10 -0600327 std::vector<SyncBarrier> barriers;
John Zulauf1a224292020-06-30 14:52:13 -0600328 const AccessContext *context;
John Zulaufbaea94f2020-09-15 17:55:16 -0600329 TrackBack(const AccessContext *context_, VkQueueFlags queue_flags_,
John Zulaufa0a98292020-09-18 09:30:10 -0600330 const std::vector<const VkSubpassDependency2 *> &subpass_dependencies_)
331 : barriers(), context(context_) {
332 barriers.reserve(subpass_dependencies_.size());
333 for (const VkSubpassDependency2 *dependency : subpass_dependencies_) {
334 assert(dependency);
335 barriers.emplace_back(queue_flags_, *dependency);
336 }
337 }
338
John Zulauf3d84f1b2020-03-09 13:33:25 -0600339 TrackBack &operator=(const TrackBack &) = default;
340 TrackBack() = default;
341 };
John Zulauf5c5e88d2019-12-26 11:22:02 -0700342
John Zulauf355e49b2020-04-24 15:11:15 -0600343 HazardResult DetectHazard(const BUFFER_STATE &buffer, SyncStageAccessIndex usage_index, const ResourceAccessRange &range) const;
John Zulauf540266b2020-04-06 18:54:53 -0600344 HazardResult DetectHazard(const IMAGE_STATE &image, SyncStageAccessIndex current_usage,
John Zulauf3d84f1b2020-03-09 13:33:25 -0600345 const VkImageSubresourceLayers &subresource, const VkOffset3D &offset,
346 const VkExtent3D &extent) const;
John Zulauf69133422020-05-20 14:55:53 -0600347 template <typename Detector>
348 HazardResult DetectHazard(Detector &detector, const IMAGE_STATE &image, const VkImageSubresourceRange &subresource_range,
349 const VkOffset3D &offset, const VkExtent3D &extent, DetectOptions options) const;
John Zulauf1507ee42020-05-18 11:33:09 -0600350 HazardResult DetectHazard(const IMAGE_STATE &image, SyncStageAccessIndex current_usage,
351 const VkImageSubresourceRange &subresource_range, const VkOffset3D &offset,
352 const VkExtent3D &extent) const;
John Zulauf69133422020-05-20 14:55:53 -0600353 HazardResult DetectHazard(const IMAGE_STATE &image, SyncStageAccessIndex current_usage,
354 const VkImageSubresourceRange &subresource_range, const SyncOrderingBarrier &ordering,
355 const VkOffset3D &offset, const VkExtent3D &extent) const;
John Zulaufb027cdb2020-05-21 14:25:22 -0600356 HazardResult DetectHazard(const IMAGE_VIEW_STATE *view, SyncStageAccessIndex current_usage, const SyncOrderingBarrier &ordering,
357 const VkOffset3D &offset, const VkExtent3D &extent, VkImageAspectFlags aspect_mask = 0U) const;
John Zulauf355e49b2020-04-24 15:11:15 -0600358 HazardResult DetectImageBarrierHazard(const IMAGE_STATE &image, VkPipelineStageFlags src_exec_scope,
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700359 const SyncStageAccessFlags &src_access_scope,
John Zulauf4a6105a2020-11-17 15:11:05 -0700360 const VkImageSubresourceRange &subresource_range, const SyncEventState &sync_event,
361 DetectOptions options) const;
362 HazardResult DetectImageBarrierHazard(const IMAGE_STATE &image, VkPipelineStageFlags src_exec_scope,
363 const SyncStageAccessFlags &src_access_scope,
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700364 const VkImageSubresourceRange &subresource_range, DetectOptions options) const;
John Zulauf355e49b2020-04-24 15:11:15 -0600365 HazardResult DetectImageBarrierHazard(const IMAGE_STATE &image, VkPipelineStageFlags src_exec_scope,
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700366 const SyncStageAccessFlags &src_stage_accesses,
367 const VkImageMemoryBarrier &barrier) const;
John Zulauf7635de32020-05-29 17:14:15 -0600368 HazardResult DetectSubpassTransitionHazard(const TrackBack &track_back, const IMAGE_VIEW_STATE *attach_view) const;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600369
John Zulaufb02c1eb2020-10-06 16:33:36 -0600370 void RecordLayoutTransitions(const RENDER_PASS_STATE &rp_state, uint32_t subpass,
371 const std::vector<const IMAGE_VIEW_STATE *> &attachment_views, const ResourceUsageTag &tag);
372
John Zulaufe5da6e52020-03-18 15:32:18 -0600373 const TrackBack &GetDstExternalTrackBack() const { return dst_external_; }
John Zulauf3d84f1b2020-03-09 13:33:25 -0600374 void Reset() {
John Zulauf3d84f1b2020-03-09 13:33:25 -0600375 prev_.clear();
John Zulauf355e49b2020-04-24 15:11:15 -0600376 prev_by_subpass_.clear();
John Zulauf3d84f1b2020-03-09 13:33:25 -0600377 async_.clear();
John Zulaufe5da6e52020-03-18 15:32:18 -0600378 src_external_ = TrackBack();
John Zulaufa0a98292020-09-18 09:30:10 -0600379 dst_external_ = TrackBack();
Jeremy Gebbenc4b78c52020-12-11 09:39:47 -0700380 start_tag_ = ResourceUsageTag();
John Zulauf16adfc92020-04-08 10:28:33 -0600381 for (auto &map : access_state_maps_) {
382 map.clear();
383 }
John Zulauf3d84f1b2020-03-09 13:33:25 -0600384 }
John Zulaufb02c1eb2020-10-06 16:33:36 -0600385
386 // Follow the context previous to access the access state, supporting "lazy" import into the context. Not intended for
387 // subpass layout transition, as the pending state handling is more complex
John Zulauf5f13a792020-03-10 07:31:21 -0600388 // TODO: See if returning the lower_bound would be useful from a performance POV -- look at the lower_bound overhead
389 // Would need to add a "hint" overload to parallel_iterator::invalidate_[AB] call, if so.
John Zulauf43cc7462020-12-03 12:33:12 -0700390 void ResolvePreviousAccess(AccessAddressType type, const ResourceAccessRange &range, ResourceAccessRangeMap *descent_map,
John Zulauf355e49b2020-04-24 15:11:15 -0600391 const ResourceAccessState *infill_state) const;
John Zulauf4a6105a2020-11-17 15:11:05 -0700392 void ResolvePreviousAccesses();
John Zulaufb02c1eb2020-10-06 16:33:36 -0600393 template <typename BarrierAction>
394 void ResolveAccessRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &subresource_range,
John Zulauf43cc7462020-12-03 12:33:12 -0700395 BarrierAction &barrier_action, AccessAddressType address_type, ResourceAccessRangeMap *descent_map,
John Zulaufb02c1eb2020-10-06 16:33:36 -0600396 const ResourceAccessState *infill_state) const;
397 template <typename BarrierAction>
John Zulauf43cc7462020-12-03 12:33:12 -0700398 void ResolveAccessRange(AccessAddressType type, const ResourceAccessRange &range, BarrierAction &barrier_action,
John Zulauf355e49b2020-04-24 15:11:15 -0600399 ResourceAccessRangeMap *resolve_map, const ResourceAccessState *infill_state,
400 bool recur_to_infill = true) const;
John Zulaufb02c1eb2020-10-06 16:33:36 -0600401
John Zulauf355e49b2020-04-24 15:11:15 -0600402 void UpdateAccessState(const BUFFER_STATE &buffer, SyncStageAccessIndex current_usage, const ResourceAccessRange &range,
403 const ResourceUsageTag &tag);
404 void UpdateAccessState(const IMAGE_STATE &image, SyncStageAccessIndex current_usage,
405 const VkImageSubresourceRange &subresource_range, const VkOffset3D &offset, const VkExtent3D &extent,
406 const ResourceUsageTag &tag);
John Zulauf7635de32020-05-29 17:14:15 -0600407 void UpdateAccessState(const IMAGE_VIEW_STATE *view, SyncStageAccessIndex current_usage, const VkOffset3D &offset,
408 const VkExtent3D &extent, VkImageAspectFlags aspect_mask, const ResourceUsageTag &tag);
John Zulauf540266b2020-04-06 18:54:53 -0600409 void UpdateAccessState(const IMAGE_STATE &image, SyncStageAccessIndex current_usage,
John Zulauf3d84f1b2020-03-09 13:33:25 -0600410 const VkImageSubresourceLayers &subresource, const VkOffset3D &offset, const VkExtent3D &extent,
411 const ResourceUsageTag &tag);
John Zulauf7635de32020-05-29 17:14:15 -0600412 void UpdateAttachmentResolveAccess(const RENDER_PASS_STATE &rp_state, const VkRect2D &render_area,
413 const std::vector<const IMAGE_VIEW_STATE *> &attachment_views, uint32_t subpass,
414 const ResourceUsageTag &tag);
John Zulaufaff20662020-06-01 14:07:58 -0600415 void UpdateAttachmentStoreAccess(const RENDER_PASS_STATE &rp_state, const VkRect2D &render_area,
416 const std::vector<const IMAGE_VIEW_STATE *> &attachment_views, uint32_t subpass,
417 const ResourceUsageTag &tag);
John Zulauf3d84f1b2020-03-09 13:33:25 -0600418
John Zulauf540266b2020-04-06 18:54:53 -0600419 void ResolveChildContexts(const std::vector<AccessContext> &contexts);
John Zulauf3d84f1b2020-03-09 13:33:25 -0600420
John Zulauf540266b2020-04-06 18:54:53 -0600421 template <typename Action>
John Zulauf89311b42020-09-29 16:28:47 -0600422 void UpdateResourceAccess(const BUFFER_STATE &buffer, const ResourceAccessRange &range, const Action action);
John Zulauf540266b2020-04-06 18:54:53 -0600423 template <typename Action>
John Zulauf89311b42020-09-29 16:28:47 -0600424 void UpdateResourceAccess(const IMAGE_STATE &image, const VkImageSubresourceRange &subresource_range, const Action action);
John Zulauf540266b2020-04-06 18:54:53 -0600425
426 template <typename Action>
427 void ApplyGlobalBarriers(const Action &barrier_action);
John Zulauf43cc7462020-12-03 12:33:12 -0700428 static AccessAddressType ImageAddressType(const IMAGE_STATE &image);
John Zulauf16adfc92020-04-08 10:28:33 -0600429
John Zulauf540266b2020-04-06 18:54:53 -0600430 AccessContext(uint32_t subpass, VkQueueFlags queue_flags, const std::vector<SubpassDependencyGraphNode> &dependencies,
John Zulauf1a224292020-06-30 14:52:13 -0600431 const std::vector<AccessContext> &contexts, const AccessContext *external_context);
John Zulauf540266b2020-04-06 18:54:53 -0600432
433 AccessContext() { Reset(); }
John Zulauf7635de32020-05-29 17:14:15 -0600434 AccessContext(const AccessContext &copy_from) = default;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600435
John Zulauf43cc7462020-12-03 12:33:12 -0700436 ResourceAccessRangeMap &GetAccessStateMap(AccessAddressType type) { return access_state_maps_[static_cast<size_t>(type)]; }
437 const ResourceAccessRangeMap &GetAccessStateMap(AccessAddressType type) const {
438 return access_state_maps_[static_cast<size_t>(type)];
439 }
440 ResourceAccessRangeMap &GetLinearMap() { return GetAccessStateMap(AccessAddressType::kLinear); }
441 const ResourceAccessRangeMap &GetLinearMap() const { return GetAccessStateMap(AccessAddressType::kLinear); }
442 ResourceAccessRangeMap &GetIdealizedMap() { return GetAccessStateMap(AccessAddressType::kIdealized); }
443 const ResourceAccessRangeMap &GetIdealizedMap() const { return GetAccessStateMap(AccessAddressType::kIdealized); }
John Zulauf355e49b2020-04-24 15:11:15 -0600444 const TrackBack *GetTrackBackFromSubpass(uint32_t subpass) const {
445 if (subpass == VK_SUBPASS_EXTERNAL) {
446 return &src_external_;
447 } else {
448 assert(subpass < prev_by_subpass_.size());
449 return prev_by_subpass_[subpass];
450 }
451 }
John Zulauf16adfc92020-04-08 10:28:33 -0600452
John Zulauf7635de32020-05-29 17:14:15 -0600453 bool ValidateLayoutTransitions(const SyncValidator &sync_state,
454
455 const RENDER_PASS_STATE &rp_state,
456
457 const VkRect2D &render_area,
458
459 uint32_t subpass, const std::vector<const IMAGE_VIEW_STATE *> &attachment_views,
460 const char *func_name) const;
John Zulauf1507ee42020-05-18 11:33:09 -0600461 bool ValidateLoadOperation(const SyncValidator &sync_state, const RENDER_PASS_STATE &rp_state, const VkRect2D &render_area,
John Zulauf7635de32020-05-29 17:14:15 -0600462 uint32_t subpass, const std::vector<const IMAGE_VIEW_STATE *> &attachment_views,
463 const char *func_name) const;
John Zulaufaff20662020-06-01 14:07:58 -0600464 bool ValidateStoreOperation(const SyncValidator &sync_state, const RENDER_PASS_STATE &rp_state, const VkRect2D &render_area,
465 uint32_t subpass, const std::vector<const IMAGE_VIEW_STATE *> &attachment_views,
466 const char *func_name) const;
John Zulaufb027cdb2020-05-21 14:25:22 -0600467 bool ValidateResolveOperations(const SyncValidator &sync_state, const RENDER_PASS_STATE &rp_state, const VkRect2D &render_area,
468 const std::vector<const IMAGE_VIEW_STATE *> &attachment_views, const char *func_name,
469 uint32_t subpass) const;
John Zulauf1507ee42020-05-18 11:33:09 -0600470
Jeremy Gebbenc4b78c52020-12-11 09:39:47 -0700471 void SetStartTag(const ResourceUsageTag &tag) { start_tag_ = tag; }
John Zulauf4a6105a2020-11-17 15:11:05 -0700472 template <typename Action>
473 void ForAll(Action &&action);
Jeremy Gebbenc4b78c52020-12-11 09:39:47 -0700474
John Zulauf3d84f1b2020-03-09 13:33:25 -0600475 private:
476 template <typename Detector>
John Zulauf43cc7462020-12-03 12:33:12 -0700477 HazardResult DetectHazard(AccessAddressType type, const Detector &detector, const ResourceAccessRange &range,
John Zulauf355e49b2020-04-24 15:11:15 -0600478 DetectOptions options) const;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600479 template <typename Detector>
John Zulauf43cc7462020-12-03 12:33:12 -0700480 HazardResult DetectAsyncHazard(AccessAddressType type, const Detector &detector, const ResourceAccessRange &range) const;
John Zulauf5f13a792020-03-10 07:31:21 -0600481 template <typename Detector>
John Zulauf43cc7462020-12-03 12:33:12 -0700482 HazardResult DetectPreviousHazard(AccessAddressType type, const Detector &detector, const ResourceAccessRange &range) const;
483 void UpdateAccessState(AccessAddressType type, SyncStageAccessIndex current_usage, const ResourceAccessRange &range,
John Zulauf16adfc92020-04-08 10:28:33 -0600484 const ResourceUsageTag &tag);
John Zulaufb02c1eb2020-10-06 16:33:36 -0600485
486 MapArray access_state_maps_;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600487 std::vector<TrackBack> prev_;
John Zulauf355e49b2020-04-24 15:11:15 -0600488 std::vector<TrackBack *> prev_by_subpass_;
Jeremy Gebbenc4b78c52020-12-11 09:39:47 -0700489 std::vector<const AccessContext *> async_;
John Zulaufe5da6e52020-03-18 15:32:18 -0600490 TrackBack src_external_;
491 TrackBack dst_external_;
Jeremy Gebbenc4b78c52020-12-11 09:39:47 -0700492 ResourceUsageTag start_tag_;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600493};
494
John Zulauf355e49b2020-04-24 15:11:15 -0600495class RenderPassAccessContext {
496 public:
John Zulauf1a224292020-06-30 14:52:13 -0600497 RenderPassAccessContext() : rp_state_(nullptr), current_subpass_(0) {}
John Zulauf355e49b2020-04-24 15:11:15 -0600498
locke-lunarg61870c22020-06-09 14:51:50 -0600499 bool ValidateDrawSubpassAttachment(const SyncValidator &sync_state, const CMD_BUFFER_STATE &cmd, const VkRect2D &render_area,
500 const char *func_name) const;
locke-lunarg96dc9632020-06-10 17:22:18 -0600501 void RecordDrawSubpassAttachment(const CMD_BUFFER_STATE &cmd, const VkRect2D &render_area, const ResourceUsageTag &tag);
John Zulauf1507ee42020-05-18 11:33:09 -0600502 bool ValidateNextSubpass(const SyncValidator &sync_state, const VkRect2D &render_area, const char *command_name) const;
John Zulauf7635de32020-05-29 17:14:15 -0600503 bool ValidateEndRenderPass(const SyncValidator &sync_state, const VkRect2D &render_area, const char *func_name) const;
504 bool ValidateFinalSubpassLayoutTransitions(const SyncValidator &sync_state, const VkRect2D &render_area,
505 const char *func_name) const;
John Zulauf355e49b2020-04-24 15:11:15 -0600506
507 void RecordLayoutTransitions(const ResourceUsageTag &tag);
John Zulauf1507ee42020-05-18 11:33:09 -0600508 void RecordLoadOperations(const VkRect2D &render_area, const ResourceUsageTag &tag);
John Zulauf1a224292020-06-30 14:52:13 -0600509 void RecordBeginRenderPass(const SyncValidator &state, const CMD_BUFFER_STATE &cb_state, const AccessContext *external_context,
510 VkQueueFlags queue_flags, const ResourceUsageTag &tag);
John Zulauf1507ee42020-05-18 11:33:09 -0600511 void RecordNextSubpass(const VkRect2D &render_area, const ResourceUsageTag &tag);
John Zulauf1a224292020-06-30 14:52:13 -0600512 void RecordEndRenderPass(AccessContext *external_context, const VkRect2D &render_area, const ResourceUsageTag &tag);
John Zulauf355e49b2020-04-24 15:11:15 -0600513
John Zulauf540266b2020-04-06 18:54:53 -0600514 AccessContext &CurrentContext() { return subpass_contexts_[current_subpass_]; }
515 const AccessContext &CurrentContext() const { return subpass_contexts_[current_subpass_]; }
John Zulauf355e49b2020-04-24 15:11:15 -0600516 const std::vector<AccessContext> &GetContexts() const { return subpass_contexts_; }
517 uint32_t GetCurrentSubpass() const { return current_subpass_; }
518 const RENDER_PASS_STATE *GetRenderPassState() const { return rp_state_; }
John Zulauf7635de32020-05-29 17:14:15 -0600519 AccessContext *CreateStoreResolveProxy(const VkRect2D &render_area) const;
John Zulauf355e49b2020-04-24 15:11:15 -0600520
521 private:
John Zulauf355e49b2020-04-24 15:11:15 -0600522 const RENDER_PASS_STATE *rp_state_;
523 uint32_t current_subpass_;
524 std::vector<AccessContext> subpass_contexts_;
525 std::vector<const IMAGE_VIEW_STATE *> attachment_views_;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600526};
527
528class CommandBufferAccessContext {
529 public:
530 CommandBufferAccessContext()
John Zulauf355e49b2020-04-24 15:11:15 -0600531 : command_number_(0),
532 reset_count_(0),
533 render_pass_contexts_(),
534 cb_access_context_(),
535 current_context_(&cb_access_context_),
John Zulauf3d84f1b2020-03-09 13:33:25 -0600536 current_renderpass_context_(),
537 cb_state_(),
538 queue_flags_() {}
John Zulauf355e49b2020-04-24 15:11:15 -0600539 CommandBufferAccessContext(SyncValidator &sync_validator, std::shared_ptr<CMD_BUFFER_STATE> &cb_state, VkQueueFlags queue_flags)
John Zulauf3d84f1b2020-03-09 13:33:25 -0600540 : CommandBufferAccessContext() {
541 cb_state_ = cb_state;
John Zulauf355e49b2020-04-24 15:11:15 -0600542 sync_state_ = &sync_validator;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600543 queue_flags_ = queue_flags;
544 }
John Zulauf5c5e88d2019-12-26 11:22:02 -0700545
546 void Reset() {
John Zulauf355e49b2020-04-24 15:11:15 -0600547 command_number_ = 0;
548 reset_count_++;
549 cb_access_context_.Reset();
John Zulauf3d84f1b2020-03-09 13:33:25 -0600550 render_pass_contexts_.clear();
John Zulauf355e49b2020-04-24 15:11:15 -0600551 current_context_ = &cb_access_context_;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600552 current_renderpass_context_ = nullptr;
John Zulauf4a6105a2020-11-17 15:11:05 -0700553 event_state_.clear();
John Zulauf5c5e88d2019-12-26 11:22:02 -0700554 }
555
John Zulauf540266b2020-04-06 18:54:53 -0600556 AccessContext *GetCurrentAccessContext() { return current_context_; }
557 const AccessContext *GetCurrentAccessContext() const { return current_context_; }
John Zulauf355e49b2020-04-24 15:11:15 -0600558 void RecordBeginRenderPass(const ResourceUsageTag &tag);
John Zulauf4a6105a2020-11-17 15:11:05 -0700559 void ApplyBufferBarriers(const SyncEventState &sync_event, VkPipelineStageFlags dst_exec_scope,
560 const SyncStageAccessFlags &dst_stage_accesses, uint32_t barrier_count,
561 const VkBufferMemoryBarrier *barriers);
562 void ApplyGlobalBarriers(SyncEventState &sync_event, VkPipelineStageFlags dstStageMask, VkPipelineStageFlags dst_exec_scope,
563 const SyncStageAccessFlags &dst_stage_accesses, uint32_t memory_barrier_count,
564 const VkMemoryBarrier *pMemoryBarriers, const ResourceUsageTag &tag);
565 void ApplyGlobalBarriersToEvents(VkPipelineStageFlags srcStageMask, VkPipelineStageFlags src_exec_scope,
566 VkPipelineStageFlags dstStageMask, VkPipelineStageFlags dst_exec_scope);
567 void ApplyImageBarriers(const SyncEventState &sync_event, VkPipelineStageFlags dst_exec_scope,
568 const SyncStageAccessFlags &dst_stage_accesses, uint32_t barrier_count,
569 const VkImageMemoryBarrier *barriers, const ResourceUsageTag &tag);
John Zulauf355e49b2020-04-24 15:11:15 -0600570 bool ValidateBeginRenderPass(const RENDER_PASS_STATE &render_pass, const VkRenderPassBeginInfo *pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -0800571 const VkSubpassBeginInfo *pSubpassBeginInfo, const char *func_name) const;
locke-lunarg61870c22020-06-09 14:51:50 -0600572 bool ValidateDispatchDrawDescriptorSet(VkPipelineBindPoint pipelineBindPoint, const char *func_name) const;
573 void RecordDispatchDrawDescriptorSet(VkPipelineBindPoint pipelineBindPoint, const ResourceUsageTag &tag);
574 bool ValidateDrawVertex(uint32_t vertexCount, uint32_t firstVertex, const char *func_name) const;
575 void RecordDrawVertex(uint32_t vertexCount, uint32_t firstVertex, const ResourceUsageTag &tag);
576 bool ValidateDrawVertexIndex(uint32_t indexCount, uint32_t firstIndex, const char *func_name) const;
577 void RecordDrawVertexIndex(uint32_t indexCount, uint32_t firstIndex, const ResourceUsageTag &tag);
578 bool ValidateDrawSubpassAttachment(const char *func_name) const;
579 void RecordDrawSubpassAttachment(const ResourceUsageTag &tag);
John Zulauf355e49b2020-04-24 15:11:15 -0600580 bool ValidateNextSubpass(const char *func_name) const;
581 bool ValidateEndRenderpass(const char *func_name) const;
582 void RecordNextSubpass(const RENDER_PASS_STATE &render_pass, const ResourceUsageTag &tag);
583 void RecordEndRenderPass(const RENDER_PASS_STATE &render_pass, const ResourceUsageTag &tag);
John Zulauf49beb112020-11-04 16:06:31 -0700584
585 bool ValidateSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const;
John Zulauf4a6105a2020-11-17 15:11:05 -0700586 void RecordSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask, const ResourceUsageTag &tag);
John Zulauf49beb112020-11-04 16:06:31 -0700587 bool ValidateResetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const;
588 void RecordResetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask);
John Zulauf4a6105a2020-11-17 15:11:05 -0700589 bool ValidateWaitEvents(uint32_t eventCount, const VkEvent *pEvents, VkPipelineStageFlags srcStageMask,
590 VkPipelineStageFlags dstStageMask, uint32_t memoryBarrierCount, const VkMemoryBarrier *pMemoryBarriers,
591 uint32_t bufferMemoryBarrierCount, const VkBufferMemoryBarrier *pBufferMemoryBarriers,
592 uint32_t imageMemoryBarrierCount, const VkImageMemoryBarrier *pImageMemoryBarriers) const;
John Zulauf49beb112020-11-04 16:06:31 -0700593 void RecordWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent *pEvents,
594 VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask, uint32_t memoryBarrierCount,
595 const VkMemoryBarrier *pMemoryBarriers, uint32_t bufferMemoryBarrierCount,
596 const VkBufferMemoryBarrier *pBufferMemoryBarriers, uint32_t imageMemoryBarrierCount,
John Zulauf4a6105a2020-11-17 15:11:05 -0700597 const VkImageMemoryBarrier *pImageMemoryBarriers, const ResourceUsageTag &tag);
598 void RecordDestroyEvent(VkEvent event);
John Zulauf49beb112020-11-04 16:06:31 -0700599
John Zulauf3d84f1b2020-03-09 13:33:25 -0600600 CMD_BUFFER_STATE *GetCommandBufferState() { return cb_state_.get(); }
601 const CMD_BUFFER_STATE *GetCommandBufferState() const { return cb_state_.get(); }
602 VkQueueFlags GetQueueFlags() const { return queue_flags_; }
John Zulauf355e49b2020-04-24 15:11:15 -0600603 inline ResourceUsageTag NextCommandTag(CMD_TYPE command) {
604 // TODO: add command encoding to ResourceUsageTag.
605 // What else we what to include. Do we want some sort of "parent" or global sequence number
606 command_number_++;
Jeremy Gebben6ea9d9e2020-12-11 09:41:01 -0700607 // The lowest bit is a sub-command number used to separate operations at the end of the previous renderpass
608 // from the start of the new one in VkCmdNextRenderpass().
609 const auto index = (static_cast<uint64_t>(reset_count_) << 33) | (command_number_ << 1) | 0;
John Zulaufcc6fecb2020-06-17 15:24:54 -0600610 ResourceUsageTag next(index, command);
John Zulauf355e49b2020-04-24 15:11:15 -0600611 return next;
612 }
John Zulauf3d84f1b2020-03-09 13:33:25 -0600613
614 private:
John Zulauf4a6105a2020-11-17 15:11:05 -0700615 SyncEventState *GetEventState(VkEvent);
616 const SyncEventState *GetEventState(VkEvent) const;
John Zulauf355e49b2020-04-24 15:11:15 -0600617 uint32_t command_number_;
618 uint32_t reset_count_;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600619 std::vector<RenderPassAccessContext> render_pass_contexts_;
John Zulauf355e49b2020-04-24 15:11:15 -0600620 AccessContext cb_access_context_;
John Zulauf540266b2020-04-06 18:54:53 -0600621 AccessContext *current_context_;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600622 RenderPassAccessContext *current_renderpass_context_;
623 std::shared_ptr<CMD_BUFFER_STATE> cb_state_;
John Zulauf355e49b2020-04-24 15:11:15 -0600624 SyncValidator *sync_state_;
625
John Zulauf3d84f1b2020-03-09 13:33:25 -0600626 VkQueueFlags queue_flags_;
John Zulauf4a6105a2020-11-17 15:11:05 -0700627 std::unordered_map<VkEvent, std::unique_ptr<SyncEventState>> event_state_;
John Zulauf9cb530d2019-09-30 14:14:10 -0600628};
629
630class SyncValidator : public ValidationStateTracker, public SyncStageAccess {
631 public:
632 SyncValidator() { container_type = LayerObjectTypeSyncValidation; }
633 using StateTracker = ValidationStateTracker;
634
635 using StateTracker::AccessorTraitsTypes;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600636 std::unordered_map<VkCommandBuffer, std::unique_ptr<CommandBufferAccessContext>> cb_access_state;
637 CommandBufferAccessContext *GetAccessContextImpl(VkCommandBuffer command_buffer, bool do_insert) {
John Zulauf9cb530d2019-09-30 14:14:10 -0600638 auto found_it = cb_access_state.find(command_buffer);
639 if (found_it == cb_access_state.end()) {
640 if (!do_insert) return nullptr;
641 // If we don't have one, make it.
John Zulauf3d84f1b2020-03-09 13:33:25 -0600642 auto cb_state = GetShared<CMD_BUFFER_STATE>(command_buffer);
643 assert(cb_state.get());
644 auto queue_flags = GetQueueFlags(*cb_state);
John Zulauf355e49b2020-04-24 15:11:15 -0600645 std::unique_ptr<CommandBufferAccessContext> context(new CommandBufferAccessContext(*this, cb_state, queue_flags));
John Zulauf3d84f1b2020-03-09 13:33:25 -0600646 auto insert_pair = cb_access_state.insert(std::make_pair(command_buffer, std::move(context)));
John Zulauf9cb530d2019-09-30 14:14:10 -0600647 found_it = insert_pair.first;
648 }
649 return found_it->second.get();
650 }
John Zulauf3d84f1b2020-03-09 13:33:25 -0600651 CommandBufferAccessContext *GetAccessContext(VkCommandBuffer command_buffer) {
652 return GetAccessContextImpl(command_buffer, true); // true -> do_insert on not found
John Zulauf9cb530d2019-09-30 14:14:10 -0600653 }
John Zulauf3d84f1b2020-03-09 13:33:25 -0600654 CommandBufferAccessContext *GetAccessContextNoInsert(VkCommandBuffer command_buffer) {
655 return GetAccessContextImpl(command_buffer, false); // false -> don't do_insert on not found
John Zulauf9cb530d2019-09-30 14:14:10 -0600656 }
John Zulauf3d84f1b2020-03-09 13:33:25 -0600657
658 const CommandBufferAccessContext *GetAccessContext(VkCommandBuffer command_buffer) const {
John Zulauf9cb530d2019-09-30 14:14:10 -0600659 const auto found_it = cb_access_state.find(command_buffer);
660 if (found_it == cb_access_state.end()) {
661 return nullptr;
662 }
663 return found_it->second.get();
664 }
665
John Zulauf540266b2020-04-06 18:54:53 -0600666 void ApplyGlobalBarriers(AccessContext *context, VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
John Zulauf9cb530d2019-09-30 14:14:10 -0600667 SyncStageAccessFlags src_stage_scope, SyncStageAccessFlags dst_stage_scope,
John Zulauf89311b42020-09-29 16:28:47 -0600668 uint32_t memoryBarrierCount, const VkMemoryBarrier *pMemoryBarriers, const ResourceUsageTag &tag);
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700669 void ApplyBufferBarriers(AccessContext *context, VkPipelineStageFlags src_stage_mask,
670 const SyncStageAccessFlags &src_stage_scope, VkPipelineStageFlags dst_stage_mask,
671 const SyncStageAccessFlags &dst_stage_scope, uint32_t barrier_count,
John Zulauf540266b2020-04-06 18:54:53 -0600672 const VkBufferMemoryBarrier *barriers);
Jeremy Gebbend0de1f82020-11-09 08:21:07 -0700673 void ApplyImageBarriers(AccessContext *context, VkPipelineStageFlags src_stage_mask,
674 const SyncStageAccessFlags &src_stage_scope, VkPipelineStageFlags dst_stage_mask,
675 const SyncStageAccessFlags &dst_stage_scope, uint32_t barrier_count,
John Zulauf355e49b2020-04-24 15:11:15 -0600676 const VkImageMemoryBarrier *barriers, const ResourceUsageTag &tag);
John Zulauf9cb530d2019-09-30 14:14:10 -0600677
John Zulaufd1f85d42020-04-15 12:23:15 -0600678 void ResetCommandBufferCallback(VkCommandBuffer command_buffer);
679 void FreeCommandBufferCallback(VkCommandBuffer command_buffer);
John Zulauf3d84f1b2020-03-09 13:33:25 -0600680 void RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf355e49b2020-04-24 15:11:15 -0600681 const VkSubpassBeginInfo *pSubpassBeginInfo, CMD_TYPE command);
682 void RecordCmdNextSubpass(VkCommandBuffer commandBuffer,
683
684 const VkSubpassBeginInfo *pSubpassBeginInfo, const VkSubpassEndInfo *pSubpassEndInfo,
685 CMD_TYPE command);
686 void RecordCmdEndRenderPass(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassEndInfo, CMD_TYPE command);
John Zulauf33fc1d52020-07-17 11:01:10 -0600687 bool SupressedBoundDescriptorWAW(const HazardResult &hazard) const;
John Zulauf9cb530d2019-09-30 14:14:10 -0600688
689 void PostCallRecordCreateDevice(VkPhysicalDevice gpu, const VkDeviceCreateInfo *pCreateInfo,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600690 const VkAllocationCallbacks *pAllocator, VkDevice *pDevice, VkResult result) override;
John Zulauf9cb530d2019-09-30 14:14:10 -0600691
John Zulauf355e49b2020-04-24 15:11:15 -0600692 bool ValidateBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo *pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -0800693 const VkSubpassBeginInfo *pSubpassBeginInfo, const char *func_name) const;
John Zulauf355e49b2020-04-24 15:11:15 -0600694
695 bool PreCallValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo *pRenderPassBegin,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600696 VkSubpassContents contents) const override;
John Zulauf355e49b2020-04-24 15:11:15 -0600697
698 bool PreCallValidateCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo *pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -0800699 const VkSubpassBeginInfo *pSubpassBeginInfo) const override;
John Zulauf355e49b2020-04-24 15:11:15 -0600700
701 bool PreCallValidateCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo *pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -0800702 const VkSubpassBeginInfo *pSubpassBeginInfo) const override;
John Zulauf355e49b2020-04-24 15:11:15 -0600703
John Zulauf9cb530d2019-09-30 14:14:10 -0600704 bool PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600705 const VkBufferCopy *pRegions) const override;
John Zulauf9cb530d2019-09-30 14:14:10 -0600706
707 void PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600708 const VkBufferCopy *pRegions) override;
John Zulauf9cb530d2019-09-30 14:14:10 -0600709
John Zulauf4a6105a2020-11-17 15:11:05 -0700710 void PreCallRecordDestroyEvent(VkDevice device, VkEvent event, const VkAllocationCallbacks *pAllocator) override;
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600711 bool PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2KHR *pCopyBufferInfos) const override;
Jeff Leger178b1e52020-10-05 12:22:23 -0400712
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600713 void PreCallRecordCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2KHR *pCopyBufferInfos) override;
Jeff Leger178b1e52020-10-05 12:22:23 -0400714
John Zulauf5c5e88d2019-12-26 11:22:02 -0700715 bool PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
716 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600717 const VkImageCopy *pRegions) const override;
John Zulauf5c5e88d2019-12-26 11:22:02 -0700718
719 void PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600720 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageCopy *pRegions) override;
John Zulauf5c5e88d2019-12-26 11:22:02 -0700721
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600722 bool PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const override;
Jeff Leger178b1e52020-10-05 12:22:23 -0400723
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600724 void PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) override;
Jeff Leger178b1e52020-10-05 12:22:23 -0400725
John Zulauf9cb530d2019-09-30 14:14:10 -0600726 bool PreCallValidateCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
727 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
728 uint32_t memoryBarrierCount, const VkMemoryBarrier *pMemoryBarriers,
729 uint32_t bufferMemoryBarrierCount, const VkBufferMemoryBarrier *pBufferMemoryBarriers,
730 uint32_t imageMemoryBarrierCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600731 const VkImageMemoryBarrier *pImageMemoryBarriers) const override;
John Zulauf9cb530d2019-09-30 14:14:10 -0600732
733 void PreCallRecordCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
734 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
735 uint32_t memoryBarrierCount, const VkMemoryBarrier *pMemoryBarriers,
736 uint32_t bufferMemoryBarrierCount, const VkBufferMemoryBarrier *pBufferMemoryBarriers,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600737 uint32_t imageMemoryBarrierCount, const VkImageMemoryBarrier *pImageMemoryBarriers) override;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600738
739 void PostCallRecordBeginCommandBuffer(VkCommandBuffer commandBuffer, const VkCommandBufferBeginInfo *pBeginInfo,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600740 VkResult result) override;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600741
742 void PostCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo *pRenderPassBegin,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600743 VkSubpassContents contents) override;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600744 void PostCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo *pRenderPassBegin,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600745 const VkSubpassBeginInfo *pSubpassBeginInfo) override;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600746 void PostCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo *pRenderPassBegin,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600747 const VkSubpassBeginInfo *pSubpassBeginInfo) override;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600748
Mike Schuchardt2df08912020-12-15 16:28:09 -0800749 bool ValidateCmdNextSubpass(VkCommandBuffer commandBuffer, const VkSubpassBeginInfo *pSubpassBeginInfo,
750 const VkSubpassEndInfo *pSubpassEndInfo, const char *func_name) const;
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600751 bool PreCallValidateCmdNextSubpass(VkCommandBuffer commandBuffer, VkSubpassContents contents) const override;
Mike Schuchardt2df08912020-12-15 16:28:09 -0800752 bool PreCallValidateCmdNextSubpass2(VkCommandBuffer commandBuffer, const VkSubpassBeginInfo *pSubpassBeginInfo,
753 const VkSubpassEndInfo *pSubpassEndInfo) const override;
754 bool PreCallValidateCmdNextSubpass2KHR(VkCommandBuffer commandBuffer, const VkSubpassBeginInfo *pSubpassBeginInfo,
755 const VkSubpassEndInfo *pSubpassEndInfo) const override;
John Zulauf355e49b2020-04-24 15:11:15 -0600756
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600757 void PostCallRecordCmdNextSubpass(VkCommandBuffer commandBuffer, VkSubpassContents contents) override;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600758 void PostCallRecordCmdNextSubpass2(VkCommandBuffer commandBuffer, const VkSubpassBeginInfo *pSubpassBeginInfo,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600759 const VkSubpassEndInfo *pSubpassEndInfo) override;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600760 void PostCallRecordCmdNextSubpass2KHR(VkCommandBuffer commandBuffer, const VkSubpassBeginInfo *pSubpassBeginInfo,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600761 const VkSubpassEndInfo *pSubpassEndInfo) override;
John Zulauf3d84f1b2020-03-09 13:33:25 -0600762
Mike Schuchardt2df08912020-12-15 16:28:09 -0800763 bool ValidateCmdEndRenderPass(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassEndInfo,
John Zulauf355e49b2020-04-24 15:11:15 -0600764 const char *func_name) const;
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600765 bool PreCallValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const override;
Mike Schuchardt2df08912020-12-15 16:28:09 -0800766 bool PreCallValidateCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassEndInfo) const override;
767 bool PreCallValidateCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassEndInfo) const override;
John Zulauf355e49b2020-04-24 15:11:15 -0600768
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600769 void PostCallRecordCmdEndRenderPass(VkCommandBuffer commandBuffer) override;
770 void PostCallRecordCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassEndInfo) override;
771 void PostCallRecordCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassEndInfo) override;
Jeff Leger178b1e52020-10-05 12:22:23 -0400772
773 template <typename BufferImageCopyRegionType>
774 bool ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
775 VkImageLayout dstImageLayout, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
776 CopyCommandVersion version) const;
locke-lunarga19c71d2020-03-02 18:17:04 -0700777 bool PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
778 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600779 const VkBufferImageCopy *pRegions) const override;
Jeff Leger178b1e52020-10-05 12:22:23 -0400780 bool PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600781 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const override;
locke-lunarga19c71d2020-03-02 18:17:04 -0700782
Jeff Leger178b1e52020-10-05 12:22:23 -0400783 template <typename BufferImageCopyRegionType>
784 void RecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
785 VkImageLayout dstImageLayout, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
786 CopyCommandVersion version);
locke-lunarga19c71d2020-03-02 18:17:04 -0700787 void PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600788 VkImageLayout dstImageLayout, uint32_t regionCount, const VkBufferImageCopy *pRegions) override;
Jeff Leger178b1e52020-10-05 12:22:23 -0400789 void PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600790 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) override;
locke-lunarga19c71d2020-03-02 18:17:04 -0700791
Jeff Leger178b1e52020-10-05 12:22:23 -0400792 template <typename BufferImageCopyRegionType>
793 bool ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
794 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
795 CopyCommandVersion version) const;
locke-lunarga19c71d2020-03-02 18:17:04 -0700796 bool PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600797 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) const override;
Jeff Leger178b1e52020-10-05 12:22:23 -0400798 bool PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600799 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const override;
locke-lunarga19c71d2020-03-02 18:17:04 -0700800
Jeff Leger178b1e52020-10-05 12:22:23 -0400801 template <typename BufferImageCopyRegionType>
802 void RecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
803 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
804 CopyCommandVersion version);
locke-lunarga19c71d2020-03-02 18:17:04 -0700805 void PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600806 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) override;
Jeff Leger178b1e52020-10-05 12:22:23 -0400807 void PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600808 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) override;
Jeff Leger178b1e52020-10-05 12:22:23 -0400809
810 template <typename RegionType>
811 bool ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
812 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions, VkFilter filter,
813 const char *apiName) const;
locke-lunarga19c71d2020-03-02 18:17:04 -0700814
815 bool PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
816 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600817 const VkImageBlit *pRegions, VkFilter filter) const override;
818 bool PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const override;
locke-lunarga19c71d2020-03-02 18:17:04 -0700819
Jeff Leger178b1e52020-10-05 12:22:23 -0400820 template <typename RegionType>
821 void RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
822 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions, VkFilter filter,
823 ResourceUsageTag tag);
locke-lunarga19c71d2020-03-02 18:17:04 -0700824 void PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
825 VkImageLayout dstImageLayout, uint32_t regionCount, const VkImageBlit *pRegions,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600826 VkFilter filter) override;
827 void PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) override;
locke-lunarg36ba2592020-04-03 09:42:04 -0600828
locke-lunarg61870c22020-06-09 14:51:50 -0600829 bool ValidateIndirectBuffer(const AccessContext &context, VkCommandBuffer commandBuffer, const VkDeviceSize struct_size,
830 const VkBuffer buffer, const VkDeviceSize offset, const uint32_t drawCount, const uint32_t stride,
831 const char *function) const;
832 void RecordIndirectBuffer(AccessContext &context, const ResourceUsageTag &tag, const VkDeviceSize struct_size,
833 const VkBuffer buffer, const VkDeviceSize offset, const uint32_t drawCount, uint32_t stride);
locke-lunarg36ba2592020-04-03 09:42:04 -0600834
locke-lunarg61870c22020-06-09 14:51:50 -0600835 bool ValidateCountBuffer(const AccessContext &context, VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
836 const char *function) const;
837 void RecordCountBuffer(AccessContext &context, const ResourceUsageTag &tag, VkBuffer buffer, VkDeviceSize offset);
locke-lunarg93d68af2020-05-12 17:18:03 -0600838
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600839 bool PreCallValidateCmdDispatch(VkCommandBuffer commandBuffer, uint32_t x, uint32_t y, uint32_t z) const override;
840 void PreCallRecordCmdDispatch(VkCommandBuffer commandBuffer, uint32_t x, uint32_t y, uint32_t z) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600841
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600842 bool PreCallValidateCmdDispatchIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset) const override;
843 void PreCallRecordCmdDispatchIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600844
845 bool PreCallValidateCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount, uint32_t firstVertex,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600846 uint32_t firstInstance) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600847 void PreCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount, uint32_t firstVertex,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600848 uint32_t firstInstance) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600849
850 bool PreCallValidateCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600851 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600852 void PreCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600853 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600854
855 bool PreCallValidateCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset, uint32_t drawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600856 uint32_t stride) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600857 void PreCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset, uint32_t drawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600858 uint32_t stride) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600859
860 bool PreCallValidateCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600861 uint32_t drawCount, uint32_t stride) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600862 void PreCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600863 uint32_t drawCount, uint32_t stride) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600864
locke-lunargff255f92020-05-13 18:53:52 -0600865 bool ValidateCmdDrawIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset, VkBuffer countBuffer,
866 VkDeviceSize countBufferOffset, uint32_t maxDrawCount, uint32_t stride,
867 const char *function) const;
locke-lunarge1a67022020-04-29 00:15:36 -0600868 bool PreCallValidateCmdDrawIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
869 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600870 uint32_t stride) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600871 void PreCallRecordCmdDrawIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
872 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600873 uint32_t stride) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600874 bool PreCallValidateCmdDrawIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
875 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600876 uint32_t stride) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600877 void PreCallRecordCmdDrawIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
878 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600879 uint32_t stride) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600880 bool PreCallValidateCmdDrawIndirectCountAMD(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
881 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600882 uint32_t stride) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600883 void PreCallRecordCmdDrawIndirectCountAMD(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
884 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600885 uint32_t stride) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600886
locke-lunargff255f92020-05-13 18:53:52 -0600887 bool ValidateCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
888 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
889 uint32_t stride, const char *function) const;
locke-lunarge1a67022020-04-29 00:15:36 -0600890 bool PreCallValidateCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
891 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600892 uint32_t stride) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600893 void PreCallRecordCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
894 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600895 uint32_t stride) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600896 bool PreCallValidateCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
897 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600898 uint32_t stride) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600899 void PreCallRecordCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
900 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600901 uint32_t stride) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600902 bool PreCallValidateCmdDrawIndexedIndirectCountAMD(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
903 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600904 uint32_t stride) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600905 void PreCallRecordCmdDrawIndexedIndirectCountAMD(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
906 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600907 uint32_t stride) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600908
909 bool PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
910 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600911 const VkImageSubresourceRange *pRanges) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600912 void PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
913 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600914 const VkImageSubresourceRange *pRanges) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600915
916 bool PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
917 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600918 const VkImageSubresourceRange *pRanges) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600919 void PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
920 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600921 const VkImageSubresourceRange *pRanges) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600922
923 bool PreCallValidateCmdCopyQueryPoolResults(VkCommandBuffer commandBuffer, VkQueryPool queryPool, uint32_t firstQuery,
924 uint32_t queryCount, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600925 VkDeviceSize stride, VkQueryResultFlags flags) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600926 void PreCallRecordCmdCopyQueryPoolResults(VkCommandBuffer commandBuffer, VkQueryPool queryPool, uint32_t firstQuery,
927 uint32_t queryCount, VkBuffer dstBuffer, VkDeviceSize dstOffset, VkDeviceSize stride,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600928 VkQueryResultFlags flags) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600929
930 bool PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset, VkDeviceSize size,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600931 uint32_t data) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600932 void PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset, VkDeviceSize size,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600933 uint32_t data) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600934
935 bool PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
936 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600937 const VkImageResolve *pRegions) const override;
Jeff Leger178b1e52020-10-05 12:22:23 -0400938
locke-lunarge1a67022020-04-29 00:15:36 -0600939 void PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
940 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600941 const VkImageResolve *pRegions) override;
locke-lunarge1a67022020-04-29 00:15:36 -0600942
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600943 bool PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer, const VkResolveImageInfo2KHR *pResolveImageInfo) const override;
944 void PreCallRecordCmdResolveImage2KHR(VkCommandBuffer commandBuffer, const VkResolveImageInfo2KHR *pResolveImageInfo) override;
Jeff Leger178b1e52020-10-05 12:22:23 -0400945
locke-lunarge1a67022020-04-29 00:15:36 -0600946 bool PreCallValidateCmdUpdateBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600947 VkDeviceSize dataSize, const void *pData) const override;
locke-lunarge1a67022020-04-29 00:15:36 -0600948 void PreCallRecordCmdUpdateBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600949 VkDeviceSize dataSize, const void *pData) override;
locke-lunargff255f92020-05-13 18:53:52 -0600950
951 bool PreCallValidateCmdWriteBufferMarkerAMD(VkCommandBuffer commandBuffer, VkPipelineStageFlagBits pipelineStage,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600952 VkBuffer dstBuffer, VkDeviceSize dstOffset, uint32_t marker) const override;
locke-lunargff255f92020-05-13 18:53:52 -0600953 void PreCallRecordCmdWriteBufferMarkerAMD(VkCommandBuffer commandBuffer, VkPipelineStageFlagBits pipelineStage,
Jeremy Gebbenf8924692020-10-28 16:27:14 -0600954 VkBuffer dstBuffer, VkDeviceSize dstOffset, uint32_t marker) override;
John Zulauf49beb112020-11-04 16:06:31 -0700955
956 bool PreCallValidateCmdSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const override;
957 void PostCallRecordCmdSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) override;
958
959 bool PreCallValidateCmdResetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const override;
960 void PostCallRecordCmdResetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) override;
961
962 bool PreCallValidateCmdWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent *pEvents,
963 VkPipelineStageFlags sourceStageMask, VkPipelineStageFlags dstStageMask,
964 uint32_t memoryBarrierCount, const VkMemoryBarrier *pMemoryBarriers,
965 uint32_t bufferMemoryBarrierCount, const VkBufferMemoryBarrier *pBufferMemoryBarriers,
966 uint32_t imageMemoryBarrierCount,
967 const VkImageMemoryBarrier *pImageMemoryBarriers) const override;
968 void PostCallRecordCmdWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent *pEvents,
969 VkPipelineStageFlags sourceStageMask, VkPipelineStageFlags dstStageMask,
970 uint32_t memoryBarrierCount, const VkMemoryBarrier *pMemoryBarriers,
971 uint32_t bufferMemoryBarrierCount, const VkBufferMemoryBarrier *pBufferMemoryBarriers,
972 uint32_t imageMemoryBarrierCount, const VkImageMemoryBarrier *pImageMemoryBarriers) override;
John Zulauf9cb530d2019-09-30 14:14:10 -0600973};