Skip to content

Commit

Permalink
Add spy_disabled annotation to subroutines.
Browse files Browse the repository at this point in the history 
This allows us to have subroutines that are not sensible
in the spy, but should still run in the server.

The starting example for this is an expensive loop through
all levels/layers of an image to do a read, which is
disabled in the interceptor anyway.
  • Loading branch information
@AWoloszyn
AWoloszyn committed Sep 10, 2018
1 parent 56c4314 commit 0aa7f41
Show file tree
Hide file tree
Showing 9 changed files with 115 additions and 55 deletions.
8 changes: 6 additions & 2 deletions gapis/api/templates/api_spy.cpp.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -316,8 +316,12 @@
{{$args := Strings "CallObserver* observer" "const std::function<void()>& call" (Macro "C++.CallParameters" $) | JoinWith ", "}}

{{Template "C++.SubReturnType" $}} {{$spyname}}::{{$name}}({{$args}}) {
{{Global "CurrentCommand" $}}
{{Template "C++.Block" $.Block}}
{{if (GetAnnotation ($) "spy_disabled")}}
// @spy_disabled
{{else}}
{{Global "CurrentCommand" $}}
{{Template "C++.Block" $.Block}}
{{end}}
}
{{end}}

Expand Down
93 changes: 48 additions & 45 deletions gapis/api/vulkan/api/coherent_memory.api
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,37 +100,40 @@ sub void readMemoryInImageBindings(map!(u32, ref!VkDescriptorImageInfo) imageBin
imageViewObj := ImageViews[v.ImageView]
imageObj := imageViewObj.Image
rng := imageViewObj.SubresourceRange
updateImageQueue(imageObj, rng)
readImageSubresource(imageObj, rng)
}
}
}
}

sub void readMemoryInDescriptorSet(ref!DescriptorSetObject descriptor_set, map!(u32, map!(u32, VkDeviceSize)) bufferBindingOffsets) {
for i in (0 .. len(descriptor_set.Bindings)) {
binding := descriptor_set.Bindings[as!u32(i)]
switch binding.BindingType {
case
VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER,
VK_DESCRIPTOR_TYPE_STORAGE_BUFFER,
VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC,
VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
if as!u32(i) in bufferBindingOffsets {
readMemoryInBufferBindings(binding.BufferBinding, bufferBindingOffsets[as!u32(i)])
} else {
readMemoryInBufferBindings(binding.BufferBinding, null)
}
case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER,
VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
readMemoryInBufferViewBindings(binding.BufferViewBindings)
case
VK_DESCRIPTOR_TYPE_SAMPLER,
VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER,
VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE,
VK_DESCRIPTOR_TYPE_STORAGE_IMAGE,
VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
readMemoryInImageBindings(binding.ImageBinding)
default: {}
if descriptor_set != null {
for i in (0 .. len(descriptor_set.Bindings)) {
binding := descriptor_set.Bindings[as!u32(i)]
switch binding.BindingType {
case
VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER,
VK_DESCRIPTOR_TYPE_STORAGE_BUFFER,
VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC,
VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
if as!u32(i) in bufferBindingOffsets {
readMemoryInBufferBindings(binding.BufferBinding, bufferBindingOffsets[as!u32(i)])
} else {
readMemoryInBufferBindings(binding.BufferBinding, null)
}
case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER,
VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
readMemoryInBufferViewBindings(binding.BufferViewBindings)
case
VK_DESCRIPTOR_TYPE_SAMPLER,
VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER,
VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE,
VK_DESCRIPTOR_TYPE_STORAGE_IMAGE,
VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
readMemoryInImageBindings(binding.ImageBinding)
default: {}
}
}
}
}
Expand Down Expand Up @@ -188,27 +191,30 @@ sub void writeMemoryInImageBindings(map!(u32, ref!VkDescriptorImageInfo) imageBi
imageObj := imageViewObj.Image
rng := imageViewObj.SubresourceRange
writeImageSubresource(imageObj, rng)
updateImageQueue(imageObj, rng)
}
}
}

sub void writeMemoryInDescriptorSet(ref!DescriptorSetObject descriptor_set, map!(u32, map!(u32, VkDeviceSize)) bufferBindingOffsets) {
for i in (0 .. len(descriptor_set.Bindings)) {
binding := descriptor_set.Bindings[as!u32(i)]
switch binding.BindingType {
case
VK_DESCRIPTOR_TYPE_STORAGE_BUFFER,
VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
if as!u32(i) in bufferBindingOffsets {
writeMemoryInBufferBindings(binding.BufferBinding, bufferBindingOffsets[as!u32(i)])
} else {
writeMemoryInBufferBindings(binding.BufferBinding, null)
}
case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
writeMemoryInBufferViewBindings(binding.BufferViewBindings)
case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
writeMemoryInImageBindings(binding.ImageBinding)
default: {}
if descriptor_set != null {
for i in (0 .. len(descriptor_set.Bindings)) {
binding := descriptor_set.Bindings[as!u32(i)]
switch binding.BindingType {
case
VK_DESCRIPTOR_TYPE_STORAGE_BUFFER,
VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
if as!u32(i) in bufferBindingOffsets {
writeMemoryInBufferBindings(binding.BufferBinding, bufferBindingOffsets[as!u32(i)])
} else {
writeMemoryInBufferBindings(binding.BufferBinding, null)
}
case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
writeMemoryInBufferViewBindings(binding.BufferViewBindings)
case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
writeMemoryInImageBindings(binding.ImageBinding)
default: {}
}
}
}
}
Expand All @@ -220,11 +226,8 @@ sub void readWriteMemoryInBoundDescriptorSets(
map!(u32, map!(u32, map!(u32, VkDeviceSize))) bufferBindingOffsets) {
layerCount := len(pipelineLayout.SetLayouts)
for i in (0 .. layerCount) {
descriptorSet := descriptorSets[as!u32(i)]
if descriptorSet != null {
readMemoryInDescriptorSet(descriptorSet, bufferBindingOffsets[as!u32(i)])
writeMemoryInDescriptorSet(descriptorSet, bufferBindingOffsets[as!u32(i)])
}
readMemoryInDescriptorSet(descriptorSets[as!u32(i)], bufferBindingOffsets[as!u32(i)])
writeMemoryInDescriptorSet(descriptorSets[as!u32(i)], bufferBindingOffsets[as!u32(i)])
}
}

Expand Down
3 changes: 3 additions & 0 deletions gapis/api/vulkan/api/copy_clear_commands.api
View file
Original file line number Diff line number Diff line change
Expand Up @@ -784,7 +784,10 @@ sub void dovkCmdResolveImage(ref!vkCmdResolveImageArgs args) {
1,
r.dstSubresource.baseArrayLayer,
r.dstSubresource.layerCount)

updateImageQueue(Images[args.SrcImage], srcRange)
readImageSubresource(Images[args.SrcImage], srcRange)
updateImageQueue(Images[args.DstImage], dstRange)
writeImageSubresource(Images[args.DstImage], dstRange)
}
}
Expand Down
1 change: 1 addition & 0 deletions gapis/api/vulkan/api/descriptor.api
View file
Original file line number Diff line number Diff line change
Expand Up @@ -740,6 +740,7 @@ sub void dovkCmdBindDescriptorSets(ref!vkCmdBindDescriptorSetsArgs args) {
imageObj := imageViewObj.Image
rng := imageViewObj.SubresourceRange
readImageSubresource(imageObj, rng)
updateImageQueue(imageObj, rng)
}
}
}
Expand Down
44 changes: 42 additions & 2 deletions gapis/api/vulkan/api/image.api
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@
VkMemoryRequirements MemoryRequirements
map!(u32, VkSparseImageMemoryRequirements) SparseMemoryRequirements
ref!DedicatedRequirementsKHR DedicatedRequirementsKHR
// If ever layer/level is set to the same queue, then set it here instead.
// This can save expensive looping through Aspects/Layers/Levels
@unused ref!QueueObject LastBoundQueue
}

@internal class ImageAspect {
Expand Down Expand Up @@ -578,6 +581,44 @@ cmd void vkDestroySampler(
}
}

sub bool isEntireSubresource(ref!ImageObject image, VkImageSubresourceRange rng) {
layerCount := imageSubresourceLayerCount(image, rng)
levelCount := imageSubresourceLevelCount(image, rng)
return ((as!u32(image.ImageAspect) & as!u32(rng.aspectMask)) == as!u32(image.ImageAspect)) &&
(rng.baseArrayLayer == 0) && (rng.baseMipLevel == 0) &&
(layerCount == image.Info.ArrayLayers) && (levelCount == image.Info.MipLevels)
}

sub void updateImageQueue(ref!ImageObject image, VkImageSubresourceRange rng) {
if (image.LastBoundQueue != LastBoundQueue) {
if (isEntireSubresource(image, rng)) {
image.LastBoundQueue = LastBoundQueue
setQueueInRange(image, rng, LastBoundQueue)
} else {
setQueueInRange(image, rng, LastBoundQueue)
image.LastBoundQueue = null
}
}
}

sub void setQueueInRange(ref!ImageObject image, VkImageSubresourceRange rng,
ref!QueueObject queue) {
layerCount := imageSubresourceLayerCount(image, rng)
levelCount := imageSubresourceLevelCount(image, rng)
for _ , _ , aspectBit in unpackImageAspectFlags(rng.aspectMask) {
for _, i, layer in image.Aspects[aspectBit].Layers {
if (i >= rng.baseArrayLayer) && (i < rng.baseArrayLayer + layerCount) {
for _, k, level in layer.Levels {
if (k >= rng.baseMipLevel) && (k < rng.baseMipLevel + levelCount) {
level.LastBoundQueue = queue
}
}
}
}
}
}

@spy_disabled
sub void readImageSubresource(ref!ImageObject image, VkImageSubresourceRange rng) {
layerCount := imageSubresourceLayerCount(image, rng)
levelCount := imageSubresourceLevelCount(image, rng)
Expand All @@ -587,14 +628,14 @@ sub void readImageSubresource(ref!ImageObject image, VkImageSubresourceRange rng
for _, k, level in layer.Levels {
if (k >= rng.baseMipLevel) && (k < rng.baseMipLevel + levelCount) {
read(level.Data)
level.LastBoundQueue = LastBoundQueue
}
}
}
}
}
}

@spy_disabled
sub void writeImageSubresource(ref!ImageObject image, VkImageSubresourceRange rng) {
layerCount := imageSubresourceLayerCount(image, rng)
levelCount := imageSubresourceLevelCount(image, rng)
Expand All @@ -605,7 +646,6 @@ sub void writeImageSubresource(ref!ImageObject image, VkImageSubresourceRange rn
for mipLevel in (rng.baseMipLevel .. rng.baseMipLevel + levelCount) {
level := layer.Levels[mipLevel]
write(level.Data)
level.LastBoundQueue = LastBoundQueue
}
}
}
Expand Down
12 changes: 9 additions & 3 deletions gapis/api/vulkan/api/renderpass_framebuffer.api
View file
Original file line number Diff line number Diff line change
Expand Up @@ -339,11 +339,15 @@ sub void loadImageAttachment(u32 attachmentID) {
desc := lastDrawInfo().RenderPass.AttachmentDescriptions[attachmentID]
if attachment.Image != null {
switch desc.loadOp {
case VK_ATTACHMENT_LOAD_OP_LOAD:
case VK_ATTACHMENT_LOAD_OP_LOAD: {
readImageSubresource(attachment.Image, attachment.SubresourceRange)
default:
updateImageQueue(attachment.Image, attachment.SubresourceRange)
}
default: {
// write to the attachment image, to prevent any dependencies on previous writes
updateImageQueue(attachment.Image, attachment.SubresourceRange)
writeImageSubresource(attachment.Image, attachment.SubresourceRange)
}
}
}
}
Expand All @@ -359,8 +363,10 @@ sub void storeImageAttachment(u32 attachmentID) {
transitionImageLayout(attachment.Image, attachment.SubresourceRange, VK_IMAGE_LAYOUT_UNDEFINED, desc.finalLayout)
}
switch desc.storeOp {
case VK_ATTACHMENT_STORE_OP_STORE:
case VK_ATTACHMENT_STORE_OP_STORE: {
writeImageSubresource(attachment.Image, attachment.SubresourceRange)
updateImageQueue(attachment.Image, attachment.SubresourceRange)
}
default: {
// do nothing
}
Expand Down
1 change: 1 addition & 0 deletions gapis/api/vulkan/api/synchronization.api
View file
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,7 @@ sub void dovkCmdPipelineBarrier(ref!vkCmdPipelineBarrierArgs args) {
transitionImageLayout(image, v.subresourceRange, v.oldLayout, v.newLayout)
if v.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED {
writeImageSubresource(image, v.subresourceRange)
updateImageQueue(image, v.subresourceRange)
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion gapis/api/vulkan/api/util.api
View file
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ sub u32 getDepthElementSize(VkFormat format, bool inBuffer) {
map!(VkImageAspectFlags, dense_map!(u32, VkImageAspectFlagBits)) allBits
}

@serialize
@hidden @serialize
AllBits allBits

@internal class unpackedImageAspectFlagBits {
Expand Down
6 changes: 4 additions & 2 deletions gapis/api/vulkan/extensions/khr_swapchain.api
View file
Original file line number Diff line number Diff line change
Expand Up @@ -281,12 +281,14 @@ cmd VkResult vkQueuePresentKHR(
if !(swapchains[i] in Swapchains) { vkErrorInvalidSwapchain(swapchains[i]) }
swapchain := Swapchains[swapchains[i]]
image := swapchain.SwapchainImages[imageIndices[i]]
readImageSubresource(image, VkImageSubresourceRange(
rng := VkImageSubresourceRange(
aspectMask: image.ImageAspect,
baseMipLevel: 0,
levelCount: image.Info.MipLevels,
baseArrayLayer: 0,
layerCount: image.Info.ArrayLayers))
layerCount: image.Info.ArrayLayers)
readImageSubresource(image, rng)
updateImageQueue(image, rng)
LastPresentInfo.PresentImages[LastPresentInfo.PresentImageCount] =
image
LastPresentInfo.PresentImageCount = LastPresentInfo.PresentImageCount + 1
Expand Down

0 comments on commit 0aa7f41

Please sign in to comment.