FNA3D Trace Suite

[thatcosmonaut]

The categories below are mostly suggestions, getting long traces is good but getting all of a game's graphical features will be most helpful. Traces should be sent privately to flibit.

To enable tracing, simply set -DTRACING_SUPPORT=ON when configuring, then traces will be dumped to FNA3D_Trace.bin. Traces technically have proprietary data in them, so only send them privately!

TODO:

• A Virus Named TOM, First world including cutscenes
• The Adventures of Shuggy, Any%
• Apotheon, Any%
• Axiom Verge (randomizer branch), Any%
• Before the Echo, Any%
• Bleed, Any difficulty
• Bleed 2, Any difficulty
• Blueberry Garden, Beat the game
• Capsized, Any difficulty
• Celeste, All chapters
• Charlie Murder, Any% (maybe less...)
• Chasm, 30 minutes
• CometStriker DX, 5 straight days of the stress tester (seriously)
• Cryptark, Arcade
• The Dishwasher: Vampire Smile, Any difficulty
• Dust: An Elysian Tail, Any%
• Escape Goat 1, Any%
• Escape Goat 2, Any% + A stained glass level
• FEZ, 209.4%
• Fist Puncher, Any difficulty
• Flinthook, Finish a run
• Flotilla, Complete a skirmish
• Full Metal Furies, First chapter
• Gateways, Any%
• Gnomoria, 15 minutes
• Growing Pains, Any%
• Hacknet, Any%
• Hidden in Plain Sight, All games
• Little Racers STREET, Daily challenge
• Mercenary Kings, Complete a mission
• Murder Miners, Full multiplayer match
• Owlboy, Any%
• Planetfriend, 15 minutes
• QuadCow Art Book, All exhibits
• Reus, All tutorials + First sim
• Rex Rocket, Any%
• River City Ransom: Underground, Any%
• Rogue Legacy, Any% with as many visual attributes as possible
• Salt and Sanctuary, Any%
• Skulls of the Shogun, World 1
• Solaroids, Any%
• Soulcaster 1/2, Beat either game
• SpeedRunners, Complete a run
• Star-Twine, Play a game
• Steel Assault, Beat the game
• Streets of Rage 4, Any difficulty
• SUMICO, Complete first section
• Super Hexagon, complete a stage
• TMNT, Any%
• TowerFall Ascension, Co-op through first boss
• Unexplored, Complete a dungeon
• Wizorb, Complete Chapter 1
• Wyv and Keep, Any%

Optional, ignore these unless you know what you're doing:

• Bastion (Bloom/Color violation), All levels
• Simply Chess (Bad attribs), Complete a match

[TheSpydog]

A few non-FNA3D-related things I've encountered while going through the catalog:

Axiom Verge: Throws an exception when starting. This appears to have been introduced back in FNA 20.02. (Maybe in this commit?)

Super Bernie World: The engine calls FNAPlatform.SetPresentationInterval via reflection, which is no longer present since we moved it to FNA3D.

Flinthook: Won't boot unless you comment out the inner contents of the NLog.Retail.config file. And even then, it crashes (without an error log) after going through the first tunnel on a new profile.

Bastion:

• Requires an additional Color constructor to be added to FNA: public Color(Color color, float alpha)
• When loading into the gameplay scene it throws an exception:

System.InvalidOperationException: The render target must not be set on the device when it is used as a texture.
  at Microsoft.Xna.Framework.Graphics.TextureCollection.set_Item (System.Int32 index, Microsoft.Xna.Framework.Graphics.Texture value) [0x0004a] in <c6c6c3a876c6444eaffb184c105ebfc1>:0

As a result of this exception, it destroys the GraphicsDevice (which internally destroys the Vulkan device). However, it apparently tries to recover from this exception by recreating the GraphicsDevice. At which point we get a validation error and a native crash with MoltenVK:

VUID-vkCreateDevice-ppEnabledExtensionNames-01387(ERROR / SPEC): msgNum: 307460652 - Validation Error: [ VUID-vkCreateDevice-ppEnabledExtensionNames-01387 ] Object 0: VK_NULL_HANDLE, type = VK_OBJECT_TYPE_INSTANCE; | MessageID = 0x12537a2c | Missing extension required by the device extension VK_KHR_dedicated_allocation: VK_KHR_get_memory_requirements2. The Vulkan spec states: All required extensions for each extension in the VkDeviceCreateInfo::ppEnabledExtensionNames list must also be present in that list (https://vulkan.lunarg.com/doc/view/1.2.154.0/mac/1.2-extensions/vkspec.html#VUID-vkCreateDevice-ppEnabledExtensionNames-01387)

Simply Chess: The game's vertex layouts are incorrectly specified. This is purely an application issue, and it just happens to work by chance with OpenGL. When attempting to enter the gameplay scene with Vulkan, we get an assert and a handful of validation errors, which are summed up as: Vertex attribute vs_v3(3) is missing from the vertex descriptor.

[TheSpydog]

MoltenVK Bugs:

Chasm:

• The game window appears 2x the width/height that it does with GL and Metal. Maybe Vulkan isn't handling high-dpi correctly? This is an SDL2 bug. See: https://bugzilla.libsdl.org/show_bug.cgi?id=5431 Fixed in SDL HG.

Murder Miners:

• The skybox appears distorted when you look directly up at it. Maybe an issue with cubemap rendering? EDIT: Can't repro on AMDVLK. Might be a MoltenVK-specific bug.

Reus:

• During gameplay there's a constant spew of this validation error:
  VUID-VkRenderPassBeginInfo-clearValueCount-00902(ERROR / SPEC): msgNum: 1306546659 - Validation Error: [ VUID-VkRenderPassBeginInfo-clearValueCount-00902 ] Object 0: handle = 0x4d500000004d5, type = VK_OBJECT_TYPE_RENDER_PASS; | MessageID = 0x4de051e3 | In vkCmdBeginRenderPass() the VkRenderPassBeginInfo struct has a clearValueCount of 1 but there must be at least 2 entries in pClearValues array to account for the highest index attachment in VkRenderPass 0x4d500000004d5[] that uses VK_ATTACHMENT_LOAD_OP_CLEAR is 2. Note that the pClearValues array is indexed by attachment number so even if some pClearValues entries between 0 and 1 correspond to attachments that aren't cleared they will be ignored. The Vulkan spec states: clearValueCount must be greater than the largest attachment index in renderPass that specifies a loadOp (or stencilLoadOp, if the attachment has a depth/stencil format) of VK_ATTACHMENT_LOAD_OP_CLEAR (https://vulkan.lunarg.com/doc/view/1.2.154.0/mac/1.2-extensions/vkspec.html#VUID-VkRenderPassBeginInfo-clearValueCount-00902) Objects: 1 [0] 0x4d500000004d5, type: 18, name: NULL

• This appears once, when first entering the gameplay scene:
  VUID-vkCmdCopyBufferToImage-renderpass(ERROR / SPEC): msgNum: 70620365 - Validation Error: [ VUID-vkCmdCopyBufferToImage-renderpass ] Object 0: handle = 0x7fdca5c291e8, type = VK_OBJECT_TYPE_COMMAND_BUFFER; | MessageID = 0x43594cd | vkCmdCopyBufferToImage(): It is invalid to issue this call inside an active VkRenderPass 0x65b000000065b[]. The Vulkan spec states: This command must only be called outside of a render pass instance (https://vulkan.lunarg.com/doc/view/1.2.154.0/mac/1.2-extensions/vkspec.html#VUID-vkCmdCopyBufferToImage-renderpass) Objects: 1 [0] 0x7fdca5c291e8, type: 6, name: NULL

Simply Chess:

• This could just be invalid application behavior, so take this with a grain of salt, but entering the main menu trips a pipeline barrier validation error: VUID-VkImageMemoryBarrier-newLayout-01198(ERROR / SPEC): msgNum: 947939354 - Validation Error: [ VUID-VkImageMemoryBarrier-newLayout-01198 ] Object 0: handle = 0x7fa4c26335c8, type = VK_OBJECT_TYPE_COMMAND_BUFFER; | MessageID = 0x3880681a | vkCmdPipelineBarrier(): Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED. The Vulkan spec states: If srcQueueFamilyIndex and dstQueueFamilyIndex define a queue family ownership transfer or oldLayout and newLayout define a image layout transition, newLayout must not be VK_IMAGE_LAYOUT_UNDEFINED or VK_IMAGE_LAYOUT_PREINITIALIZED (https://vulkan.lunarg.com/doc/view/1.2.154.0/mac/1.2-extensions/vkspec.html#VUID-VkImageMemoryBarrier-newLayout-01198)

[flibitijibibo]

Axiom Verge, Bastion, and all the Tribute games are all spec violations but they're also SpriteBatch+Shader games, so nothing to see there. Flotilla is also a spec violation but only regarding BloomComponent, that one just needs bloom disabled. Simply Chess has bad shaders and can also be skipped. Kitsune's games can be tested once they update FNA.

The only weird one is Owlboy, but that should be fixed with an FNA+FAudio sync. Will need debug symbols if this is not the case.

[flibitijibibo]

Alphabetized the list and split off the spec violations into an optional list. If you know how to work around the spec violation in your local copy, great, if not don't worry about it. Flotilla's the only scary one in the list so far but bloom is easy to disable in that game. EDIT: Patch submitted, sent spec fixes for Bastion as well. Flinthook/MercKings both have working versions in revision control but they're currently unpublished because of NLog issues (read: it sucks and it breaks things, especially Mono).

[flibitijibibo]

Flotilla upstream is now compliant, not sure when it will get pushed in binary form to customers but building master should work with the public content.

[TheSpydog]

The only weird one is Owlboy, but that should be fixed with an FNA+FAudio sync. Will need debug symbols if this is not the case.

Agh, yeah, it turns out I was just using an outdated version of FAudio. It works fine with 20.12.

[flibitijibibo]

fnalibs update for latest MoltenVK and FNA3D Git revision.

[flibitijibibo]

Looks like the latest MoltenVK is not a fan of FEZ:

[mvk-error] VK_ERROR_DEVICE_LOST: Command buffer 0x7fdb87a685c0 "" execution failed (code 1): Internal Error (IOAF code -536870211)

[TheSpydog]

Looks like the latest MoltenVK is not a fan of FEZ:

[mvk-error] VK_ERROR_DEVICE_LOST: Command buffer 0x7fdb87a685c0 "" execution failed (code 1): Internal Error (IOAF code -536870211)

I'm not seeing this on my machine (MBP 2016, Intel Iris Graphics 540) with the latest LunarG SDK. Is this on NVIDIA?

Also, since updating to the latest MVK I'm now seeing this at the start of every game:

VUID-VkDeviceCreateInfo-pProperties-04451(ERROR / SPEC): msgNum: 976972960 - Validation Error: [ VUID-VkDeviceCreateInfo-pProperties-04451 ] Object 0: handle = 0x7fd38344dd70, type = VK_OBJECT_TYPE_PHYSICAL_DEVICE; | MessageID = 0x3a3b6ca0 |
vkCreateDevice: VK_KHR_portability_subset must be enabled because physical device VkPhysicalDevice 0x7fd38344dd70[] supports it
The Vulkan spec states: If the [VK_KHR_portability_subset] extension is included in pProperties of vkEnumerateDeviceExtensionProperties, ppEnabledExtensions must include "VK_KHR_portability_subset". (https://vulkan.lunarg.com/doc/view/1.2.162.0/mac/1.2-extensions/vkspec.html#VUID-VkDeviceCreateInfo-pProperties-04451)

Apparently this extension must be enabled if it's supported by the physical device, even if it's unused by the application? What a strange requirement...

[thatcosmonaut]

Looks like this is an open issue on the Vulkan-Portability repo so we should probably wait for clarification from Khronos before patching this in.

KhronosGroup/Vulkan-Portability#14

[flibitijibibo]

Yeah, I've been running on NVIDIA. Maybe the spec violation is the problem for me... I wouldn't object to including it, we don't have any reason not to as far as I know.

[thatcosmonaut]

I suppose it's basically a no-op on conformant implementations.

[flibitijibibo]

As of now, Flotilla on Steam is compliant, as are the Linux/macOS builds of Mercenary Kings and Flinthook.