Add Tracy Profiler Support #757

tomadamatkinson · 2023-07-17T18:16:06Z

Description

Adds Tracy Profiler support. This will allow samples to show the stats and usage that they want to show to users without needing to clutter the Sample GUI

This can be extended in the future to instrument up core parts of the framework and samples that we want to draw the users attention too. It can also be used to show how multi-threading can be used with Vulkan

For now I have hooked this into our stats system so that we can show more stat information to users without worrying about cluttering the main GUI. We can still use the main sample GUI to show stats aswell!! I also added support for VMA Memory Budgets to show heap usage

We can use this to track other useful information such as the amount of vertices we expect to render for a given frame or the amount of geometry in the scene graph

Tracy also has Vulkan support however I have not played around with this yet

String names for VkMemoryTypeFlags are taking from vulkan.hpp instead of adding to the existing vkb::to_string() set

General Checklist:

Please ensure the following points are checked:

Note: The Samples CI runs a number of checks including:

I have updated the header Copyright to reflect the current year (CI build will fail if Copyright is out of date)
My changes build on Windows, Linux, macOS and Android. Otherwise I have documented any exceptions

Sample Checklist

If your PR contains a new or modified sample, these further checks must be carried out in addition to the General Checklist:

I have tested the sample on at least one compliant Vulkan implementation
If the sample is vendor-specific, I have tagged it appropriately
I have stated on what implementation the sample has been tested so that others can test on different implementations and platforms
Any dependent assets have been merged and published in downstream modules
For new samples, I have added a paragraph with a summary to the appropriate chapter in the samples readme
For new samples, I have added a tutorial README.md file to guide users through what they need to know to implement code using this feature. For example, see conditional_rendering

asuessenbach

Is the concurrency stuff in the *.yml files related to adding tracy?

Besides that, I'm not familiar with tracy. How would I get that nice little tracy window?

asuessenbach · 2023-07-19T15:00:05Z

framework/stats/stats.cpp

+		{
+			average += v;
+		}
+		average /= c.second.size();


Maybe: float average = std::accumulate( c.second.begin(), c.second.end(), 0.0f ) / c.second.size();

Nice, yeah a bit more concise

tomadamatkinson · 2023-07-20T07:51:58Z

Is the concurrency stuff in the *.yml files related to adding tracy?

Besides that, I'm not familiar with tracy. How would I get that nice little tracy window?

The concurrency stuff isn't related, I can make a small PR for these changes if needed. Just threw it in here as I had lots of jobs running and not automatically cancelling outdated ones.

To use Tracy you should be able to run './scripts/tracy.py' and it will build and run the window. I have only tested this on Linux and you do need to install system libraries.

I can give it a go on windows at some point this week and make sure it works. It is likely that it won't work first time

asuessenbach · 2023-07-24T14:07:20Z

It is likely that it won't work first time

And you're right, tracy on windows is not supported.

The concurrency stuff isn't related,

You can keep it in, if you like. I just wanted to make that I didn't miss something here.

SaschaWillems · 2023-07-24T14:41:20Z

It is likely that it won't work first time

And you're right, tracy on windows is not supported.

I'm pretty sure tracy works on Windows. I'm using it in one of my projects and I mainly develop on windows ;)

tomadamatkinson · 2023-07-24T14:47:57Z

Tracy is supported. It is likely my script doesn't work on windows - Yet!

The script was meant as a build helper as you need the same Tracy version as TracyClient version used in the app.

I've only had chance to get this helper working on Linux but i should have some free time tonight to test it out on windows.

The latest Tracy download from GitHub should also work (again not tested this as I was focused on the script)

gary-sweet · 2023-07-25T09:51:22Z

The build script for Tracy doesn't work for me in Linux sadly:

../../../server/TracySourceView.cpp: In member function ‘bool tracy::SourceView::Disassemble(uint64_t, const tracy::Worker&)’:
../../../server/TracySourceView.cpp:736:46: error: ‘CS_GRP_BRANCH_RELATIVE’ was not declared in this scope
  736 |                 else if( detail.groups[j] == CS_GRP_BRANCH_RELATIVE && opType < OpType::Branch ) opType = OpType::Branch;
      |                                              ^~~~~~~~~~~~~~~~~~~~~~
../../../server/TracySourceView.cpp:739:46: error: ‘CS_GRP_PRIVILEGE’ was not declared in this scope
  739 |                 else if( detail.groups[j] == CS_GRP_PRIVILEGE && opType < OpType::Privileged )
      |                                              ^~~~~~~~~~~~~~~~

asuessenbach · 2023-07-25T12:43:09Z

The latest Tracy download from GitHub should also work (again not tested this as I was focused on the script)

Not exactly. I get this error:

tomadamatkinson · 2023-07-25T20:28:17Z

@asuessenbach sorry for the delay on this. Each time I have thought I would have time I've had a distraction

I'm going to pin the submodule version to v9.1.0 https://github.com/wolfpld/tracy/tree/v0.9.1

This would make the versions compatible. I think I am currently on v.9.2.0 (using main)

Will also try the Windows build now with the script

@gary-sweet what is the version of your capstone library? I believe that build issue is coming from a missing dependency. The first printout at the top of the script is some install dependencies. It may work after building those

tomadamatkinson · 2023-07-25T21:08:13Z

Wow, the Windows build is much more involved. Pinning the Tracy version to v0.9.1 makes our client compatible with the profiler

Added some download instructions to the script

I would download automatically but as the release page packages Tracy in a 7zip archive I feel like it is best to let the user do this

After rebuilding samples I get this

tomadamatkinson · 2023-07-25T21:22:44Z

Moved concurrency changes to another PR

tomadamatkinson · 2024-03-11T21:26:41Z

Picked this branch back up as the Tracy support does work. This branch got stalled on that fact that Tracy is hard to build for different platforms - this is a known limitation of the project.

I have created this pr in an attempt to help improve Tracy in this area. Unfortunately you will not be able to use this branch to build Tracy due to the strict protocol constraints. If you would like to test this PR you will need to install Tracy from the release page or by following the Tracy.pdf guide.

If you are using version of ubuntu that does not include capstone 4+ you will need to manually build and install capstone 4+ in your distro for Tracy to build.

VKB_PROFILING was added to make Tracy's usage opt in. By default this option is OFF

For now I have only instrumented up the GLTF Loader. We do not need to instrument all functions with Tracy. It is useful to track the performance of high level systems such as scene iterations or multi threaded scenarios.

I have tested on Ubuntu 23.04, Windows 11 and Android. Tracy is disabled for Android for now as there are some networking considerations

(I will be addressing any CI issues over the next few days, There are likely going to be some nuances between actual machines and github runners)

asuessenbach · 2024-03-12T13:33:47Z

Unfortunately, I get an "Incompatible protocol" error, again:

I just downloaded the release v0.10 from https://github.com/wolfpld/tracy/tags, started the Tracy.exe and got this.

asuessenbach · 2024-03-12T13:46:52Z

framework/common/error.h

@@ -21,39 +21,12 @@
 #include <stdexcept>
 #include <string>

+#include "core/util/error.hpp"


Why do you separate error.hpp for the other headers?

asuessenbach · 2024-03-12T13:49:04Z

framework/gltf_loader.cpp

@@ -29,6 +29,8 @@ VKBP_DISABLE_WARNINGS()
 #include <glm/gtc/type_ptr.hpp>
 VKBP_ENABLE_WARNINGS()

+#include <core/util/profiling.hpp>


Why do you separate profiling.hpp from the other headers below?

tomadamatkinson · 2024-03-12T18:20:48Z

Hey @asuessenbach, this branch is pinned to v0.10 can you confirm that you updated your submodules before building?

Before this branch was v0.9.1 so it may be that you still have that version checked out

SaschaWillems · 2024-03-13T20:31:40Z

Works fine for me 👍🏻. Will try to do a proper review this weekend.

asuessenbach · 2024-03-18T09:44:39Z

@tomadamatkinson You're right, I somehow missed to get the check out the right version. Works now!

SaschaWillems · 2024-06-17T15:09:46Z

@tomadamatkinson: Could you fix the the merge conflicts? Would' love to see this merged, so we can add additional functionality based on your work. If you can't find the time, I'll happily try to help :)

tomadamatkinson · 2024-06-19T18:44:14Z

@SaschaWillems ill take a look!

Android fixes document tracy

tomadamatkinson · 2024-06-24T16:04:24Z

Rebased and tested on linux. To work with android devices i believe we need to port forward with adb and also give the application local network permissions. I have not tested this in this PR. On desktop this should work fine out of the box.

Works with Tracy version 0.10. When Tracy has a new official release with the CMake build system i helped with we can bump the submodule and point to that allowing users to seamlessly build the profiler.

I cannot test on Windows or Mac today but may be able too in the near future

@SaschaWillems let me know if there are any tweaks you want adding to this

SaschaWillems

Thank you very much. Worked out of the box for me on Windows with the Tracy 0.10 binary release 👍🏻

gpx1000

Awesome, works here.

gary-sweet

Doesn't break anything for me

marty-johnson59 · 2024-08-09T14:37:15Z

Merging - 3 approvals

tomadamatkinson added framework This is relevant to the framework v2.0 Work relating to the framework v2.0 project labels Jul 17, 2023

tomadamatkinson self-assigned this Jul 17, 2023

tomadamatkinson requested review from SaschaWillems, gpx1000 and asuessenbach and removed request for SaschaWillems July 17, 2023 20:26

tomadamatkinson force-pushed the v2.0/profiling branch 10 times, most recently from f7f2080 to 3e2b3be Compare July 17, 2023 23:14

asuessenbach reviewed Jul 19, 2023

View reviewed changes

tomadamatkinson force-pushed the v2.0/profiling branch from 3e2b3be to 1b27c10 Compare July 25, 2023 21:07

tomadamatkinson force-pushed the v2.0/profiling branch from 1b27c10 to 771633f Compare July 25, 2023 21:10

tomadamatkinson force-pushed the v2.0/profiling branch from f3f89fc to 54e953a Compare November 6, 2023 19:53

tomadamatkinson mentioned this pull request Nov 7, 2023

Use CMake to compile the profiler wolfpld/tracy#655

Closed

tomadamatkinson force-pushed the v2.0/profiling branch from 3c28a94 to 64faa4e Compare March 11, 2024 20:36

gpx1000 previously approved these changes Mar 11, 2024

View reviewed changes

asuessenbach reviewed Mar 12, 2024

View reviewed changes

SaschaWillems self-requested a review June 1, 2024 16:02

SaschaWillems previously approved these changes Jun 1, 2024

View reviewed changes

tomadamatkinson added 5 commits June 24, 2024 16:27

Add Tracy Profiler Support

1d20af2

Android fixes document tracy

add VKB_PROFILING

f16e9c0

do not enable on android

10123f2

remove implementation when VKB_PROFILING is off

7afbca4

qa

1e16cb9

tomadamatkinson dismissed stale reviews from SaschaWillems and gpx1000 via 1e16cb9 June 24, 2024 16:01

tomadamatkinson force-pushed the v2.0/profiling branch from 45b687d to 1e16cb9 Compare June 24, 2024 16:01

SaschaWillems self-requested a review July 2, 2024 15:21

SaschaWillems approved these changes Jul 2, 2024

View reviewed changes

gpx1000 approved these changes Jul 29, 2024

View reviewed changes

marty-johnson59 requested a review from gary-sweet July 29, 2024 18:39

gary-sweet approved these changes Jul 30, 2024

View reviewed changes

marty-johnson59 merged commit 6d2ecf5 into KhronosGroup:main Aug 9, 2024
23 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Tracy Profiler Support #757

Add Tracy Profiler Support #757

tomadamatkinson commented Jul 17, 2023

asuessenbach left a comment

asuessenbach Jul 19, 2023

tomadamatkinson Jul 25, 2023

tomadamatkinson commented Jul 20, 2023

asuessenbach commented Jul 24, 2023

SaschaWillems commented Jul 24, 2023

tomadamatkinson commented Jul 24, 2023

gary-sweet commented Jul 25, 2023

asuessenbach commented Jul 25, 2023

tomadamatkinson commented Jul 25, 2023

tomadamatkinson commented Jul 25, 2023

tomadamatkinson commented Jul 25, 2023

tomadamatkinson commented Mar 11, 2024

asuessenbach commented Mar 12, 2024

asuessenbach Mar 12, 2024

asuessenbach Mar 12, 2024

tomadamatkinson commented Mar 12, 2024

SaschaWillems commented Mar 13, 2024

asuessenbach commented Mar 18, 2024

SaschaWillems commented Jun 17, 2024

tomadamatkinson commented Jun 19, 2024

tomadamatkinson commented Jun 24, 2024

SaschaWillems left a comment

gpx1000 left a comment

gary-sweet left a comment

marty-johnson59 commented Aug 9, 2024

Add Tracy Profiler Support #757

Add Tracy Profiler Support #757

Conversation

tomadamatkinson commented Jul 17, 2023

Description

General Checklist:

Sample Checklist

asuessenbach left a comment

Choose a reason for hiding this comment

asuessenbach Jul 19, 2023

Choose a reason for hiding this comment

tomadamatkinson Jul 25, 2023

Choose a reason for hiding this comment

tomadamatkinson commented Jul 20, 2023

asuessenbach commented Jul 24, 2023

SaschaWillems commented Jul 24, 2023

tomadamatkinson commented Jul 24, 2023

gary-sweet commented Jul 25, 2023

asuessenbach commented Jul 25, 2023

tomadamatkinson commented Jul 25, 2023

tomadamatkinson commented Jul 25, 2023

tomadamatkinson commented Jul 25, 2023

tomadamatkinson commented Mar 11, 2024

asuessenbach commented Mar 12, 2024

asuessenbach Mar 12, 2024

Choose a reason for hiding this comment

asuessenbach Mar 12, 2024

Choose a reason for hiding this comment

tomadamatkinson commented Mar 12, 2024

SaschaWillems commented Mar 13, 2024

asuessenbach commented Mar 18, 2024

SaschaWillems commented Jun 17, 2024

tomadamatkinson commented Jun 19, 2024

tomadamatkinson commented Jun 24, 2024

SaschaWillems left a comment

Choose a reason for hiding this comment

gpx1000 left a comment

Choose a reason for hiding this comment

gary-sweet left a comment

Choose a reason for hiding this comment

marty-johnson59 commented Aug 9, 2024