-
Notifications
You must be signed in to change notification settings - Fork 0
/
transform_external_memory.go
349 lines (305 loc) · 11.2 KB
/
transform_external_memory.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
// Copyright (C) 2021 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package vulkan
import (
"bytes"
"context"
"errors"
"github.com/google/gapid/core/data/endian"
"github.com/google/gapid/gapis/api"
"github.com/google/gapid/gapis/api/transform"
"github.com/google/gapid/gapis/database"
"github.com/google/gapid/gapis/memory"
)
// externalMemory is a transform that will transform commands using external
// memory to internal memory, so that they can be replayed correctly.
type externalMemory struct {
allocations *allocationTracker
externalImages map[VkImage]struct{}
}
func newExternalMemory() *externalMemory {
return &externalMemory{
externalImages: map[VkImage]struct{}{},
}
}
func (e *externalMemory) RequiresAccurateState() bool {
return false
}
func (e *externalMemory) RequiresInnerStateMutation() bool {
return false
}
func (e *externalMemory) SetInnerStateMutationFunction(sm transform.StateMutator) {
// This transform does not require inner state mutation.
}
func (e *externalMemory) BeginTransform(ctx context.Context, g *api.GlobalState) error {
e.allocations = NewAllocationTracker(g)
return nil
}
func (e *externalMemory) EndTransform(ctx context.Context, g *api.GlobalState) ([]api.Cmd, error) {
return nil, nil
}
func (e *externalMemory) ClearTransformResources(ctx context.Context) {
e.allocations.FreeAllocations()
}
func (e *externalMemory) TransformCommand(ctx context.Context, id transform.CommandID, cmds []api.Cmd, g *api.GlobalState) ([]api.Cmd, error) {
var err error
var out []api.Cmd
for _, cmd := range cmds {
switch c := cmd.(type) {
case *VkCreateImage:
cmd.Extras().Observations().ApplyReads(g.Memory.ApplicationPool())
cmd, err = e.vkCreateImage(ctx, g, c)
case *VkCreateImageView:
cmd.Extras().Observations().ApplyReads(g.Memory.ApplicationPool())
cmd, err = e.vkCreateImageView(ctx, g, c)
case *VkAllocateMemory:
cmd.Extras().Observations().ApplyReads(g.Memory.ApplicationPool())
cmd, err = e.vkAllocateMemory(ctx, g, c)
case *VkGetPhysicalDeviceImageFormatProperties2:
// TODO: figure out why this crashes the replay.
cmd = nil
case *VkCmdPipelineBarrier:
cmd.Extras().Observations().ApplyReads(g.Memory.ApplicationPool())
cmd, err = e.vkCmdPipelineBarrier(ctx, g, c)
}
if err != nil {
return nil, err
} else if cmd != nil {
out = append(out, cmd)
}
}
return out, nil
}
func (e *externalMemory) vkCreateImage(ctx context.Context, g *api.GlobalState, cmd *VkCreateImage) (api.Cmd, error) {
newCmd, updated, err := filterPNext(ctx, g, cmd, NewVulkanStructHeaderᵖ(cmd.PCreateInfo()), func(h VulkanStructHeader) bool {
s := h.SType()
return s == VkStructureType_VK_STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO ||
s == VkStructureType_VK_STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID
})
if err != nil || !updated {
return cmd, err
}
cmd = newCmd.(*VkCreateImage)
// Apply our override, so we don't undo it.
cmd.Extras().Observations().ApplyReads(g.Memory.ApplicationPool())
info, err := cmd.PCreateInfo().Read(ctx, cmd, g, nil)
if err != nil {
return cmd, err
}
if info.Fmt() == VkFormat_VK_FORMAT_UNDEFINED {
// The spec allows undefined "external" formats. Change it to RGBA.
info.SetFmt(VkFormat_VK_FORMAT_R8G8B8A8_UNORM)
addOverrideObservation(ctx, g, cmd, cmd.PCreateInfo(), info)
cmd.Extras().Observations().ApplyWrites(g.Memory.ApplicationPool())
image, err := cmd.PImage().Read(ctx, cmd, g, nil)
if err != nil {
return cmd, err
}
e.externalImages[image] = struct{}{}
}
return cmd, nil
}
func (e *externalMemory) vkCreateImageView(ctx context.Context, g *api.GlobalState, cmd *VkCreateImageView) (api.Cmd, error) {
info, err := cmd.PCreateInfo().Read(ctx, cmd, g, nil)
if err != nil {
return cmd, err
}
if _, ok := e.externalImages[info.Image()]; ok {
// This is an image that was created with an external format, that we turned
// into an RGBA image. Remove the conversion sampler info from the image view.
newCmd, _, err := filterPNext(ctx, g, cmd, NewVulkanStructHeaderᵖ(cmd.PCreateInfo()), func(h VulkanStructHeader) bool {
return h.SType() == VkStructureType_VK_STRUCTURE_TYPE_SAMPLER_YCBCR_CONVERSION_INFO
})
if err != nil {
return cmd, err
}
cmd = newCmd.(*VkCreateImageView)
// Apply our override, so we don't undo it and re-read the info.
cmd.Extras().Observations().ApplyReads(g.Memory.ApplicationPool())
if info, err = cmd.PCreateInfo().Read(ctx, cmd, g, nil); err != nil {
return cmd, err
}
info.SetFmt(VkFormat_VK_FORMAT_R8G8B8A8_UNORM)
addOverrideObservation(ctx, g, cmd, cmd.PCreateInfo(), info)
}
return cmd, nil
}
func (e *externalMemory) vkAllocateMemory(ctx context.Context, g *api.GlobalState, cmd *VkAllocateMemory) (api.Cmd, error) {
found := false
var buffer VkBuffer
var image VkImage
err := forEachPNext(ctx, g, cmd, NewVulkanStructHeaderᵖ(cmd.PAllocateInfo()), func(ptr VulkanStructHeaderᵖ, h VulkanStructHeader) error {
switch h.SType() {
case VkStructureType_VK_STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID:
found = true
case VkStructureType_VK_STRUCTURE_TYPE_MEMORY_DEDICATED_ALLOCATE_INFO_KHR:
ext, err := VkMemoryDedicatedAllocationInfoKHRᵖ(ptr).Read(ctx, cmd, g, nil)
if err != nil {
return err
}
buffer = ext.Buffer()
image = ext.Image()
}
return nil
})
if err != nil || !found {
return cmd, err
}
if buffer != 0 {
// TODO confirm that buffer size is ok here.
newCmd, _, err := filterPNext(ctx, g, cmd, NewVulkanStructHeaderᵖ(cmd.PAllocateInfo()), func(h VulkanStructHeader) bool {
return h.SType() == VkStructureType_VK_STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
})
return newCmd, err
} else if image != 0 {
// Replace the VkAllocateMemory command with the synthetic replayAllocateImageMemory command.
s := GetState(g)
device := s.Devices().Get(cmd.Device())
physDevice := s.PhysicalDevices().Get(device.PhysicalDevice())
memProps := e.allocations.AllocDataOrPanic(ctx, physDevice.MemoryProperties())
cb := CommandBuilder{Thread: cmd.Thread()}
newCmd := cb.ReplayAllocateImageMemory(
cmd.Device(),
memProps.Ptr(),
image,
cmd.PMemory(),
VkResult_VK_SUCCESS,
).AddRead(
memProps.Data(),
)
// Copy the write observations over.
oldObs := cmd.Extras().Observations()
newObs := newCmd.Extras().Observations()
newObs.Writes = append(newObs.Writes, oldObs.Writes...)
return newCmd, nil
} else {
// This is against the spec, AHB allocations have to be dedicated.
return cmd, errors.New("Non dedicated AHB backed allocation")
}
}
func (e *externalMemory) vkCmdPipelineBarrier(ctx context.Context, g *api.GlobalState, cmd *VkCmdPipelineBarrier) (api.Cmd, error) {
buffersToFix := map[memory.Pointer]VkBufferMemoryBarrier{}
if numBuffers := cmd.BufferMemoryBarrierCount(); numBuffers > 0 {
base := cmd.PBufferMemoryBarriers()
buffers, err := base.Slice(0, uint64(numBuffers), g.MemoryLayout).Read(ctx, cmd, g, nil)
if err != nil {
return cmd, err
}
for i, buffer := range buffers {
if isExternalQueue(buffer.SrcQueueFamilyIndex()) || isExternalQueue(buffer.DstQueueFamilyIndex()) {
buffersToFix[base.Offset(uint64(i)*base.ElementSize(g.MemoryLayout))] = buffer
}
}
}
imagesToFix := map[memory.Pointer]VkImageMemoryBarrier{}
if numImages := cmd.ImageMemoryBarrierCount(); numImages > 0 {
base := cmd.PImageMemoryBarriers()
images, err := base.Slice(0, uint64(numImages), g.MemoryLayout).Read(ctx, cmd, g, nil)
if err != nil {
return cmd, err
}
for i, image := range images {
if isExternalQueue(image.SrcQueueFamilyIndex()) || isExternalQueue(image.DstQueueFamilyIndex()) {
imagesToFix[base.Offset(uint64(i)*base.ElementSize(g.MemoryLayout))] = image
}
}
}
if len(buffersToFix) == 0 && len(imagesToFix) == 0 {
return cmd, nil
}
newCmd := cmd.Clone()
newCmd.Extras().CloneObservations()
for ptr, buffer := range buffersToFix {
if isExternalQueue(buffer.SrcQueueFamilyIndex()) {
buffer.SetSrcQueueFamilyIndex(buffer.DstQueueFamilyIndex())
} else {
buffer.SetDstQueueFamilyIndex(buffer.SrcQueueFamilyIndex())
}
if err := addOverrideObservation(ctx, g, newCmd, ptr, buffer); err != nil {
return cmd, err
}
}
for ptr, image := range imagesToFix {
if isExternalQueue(image.SrcQueueFamilyIndex()) {
image.SetSrcQueueFamilyIndex(image.DstQueueFamilyIndex())
} else {
image.SetDstQueueFamilyIndex(image.SrcQueueFamilyIndex())
}
if err := addOverrideObservation(ctx, g, newCmd, ptr, image); err != nil {
return cmd, err
}
}
return newCmd, nil
}
// forEachPNext loops over the pNext chain starting at root and calls the given callback for each node.
func forEachPNext(ctx context.Context, g *api.GlobalState, cmd api.Cmd, root VulkanStructHeaderᵖ, cb func(ptr VulkanStructHeaderᵖ, h VulkanStructHeader) error) error {
for node := root; !node.IsNullptr(); {
header, err := node.Read(ctx, cmd, g, nil)
if err != nil {
return err
}
if err = cb(node, header); err != nil {
return err
}
node = VulkanStructHeaderᵖ(header.PNext())
}
return nil
}
// filterPNext removes any node from the pNext chain where the filter callback returned true.
// Returns a cloned command and true, if a change was made, otherwhise the original command and false.
func filterPNext(ctx context.Context, g *api.GlobalState, cmd api.Cmd, root VulkanStructHeaderᵖ, filter func(h VulkanStructHeader) bool) (api.Cmd, bool, error) {
prev := VulkanStructHeaderᵖ(0)
prevHeader := VulkanStructHeader{}
newNext := map[VulkanStructHeaderᵖ]VulkanStructHeader{}
err := forEachPNext(ctx, g, cmd, root, func(ptr VulkanStructHeaderᵖ, header VulkanStructHeader) error {
if ptr != root && filter(header) {
prevHeader.SetPNext(header.PNext())
newNext[prev] = prevHeader
} else {
prev = ptr
prevHeader = header
}
return nil
})
if err != nil {
return cmd, false, err
}
if len(newNext) == 0 {
return cmd, false, nil
}
newCmd := cmd.Clone()
newCmd.Extras().CloneObservations()
for ptr, header := range newNext {
// Create a new memory blob that will override the previous struct header.
if err := addOverrideObservation(ctx, g, newCmd, ptr, header); err != nil {
return cmd, false, err
}
}
return newCmd, true, nil
}
func addOverrideObservation(ctx context.Context, g *api.GlobalState, cmd api.Cmd, ptr memory.Pointer, v interface{}) error {
buf := &bytes.Buffer{}
enc := memory.NewEncoder(endian.Writer(buf, g.MemoryLayout.GetEndian()), g.MemoryLayout)
memory.Write(enc, v)
id, err := database.Store(ctx, buf.Bytes())
if err != nil {
return err
}
cmd.Extras().GetOrAppendObservations().AddRead(
memory.Range{Base: ptr.Address(), Size: uint64(len(buf.Bytes()))}, id)
return nil
}
func isExternalQueue(qf uint32) bool {
return qf == VK_QUEUE_FAMILY_EXTERNAL || qf == VK_QUEUE_FAMILY_FOREIGN_EXT
}