build: tracy integration #3253

scarf005 · 2023-09-24T11:27:45Z

Summary

SUMMARY: Build "CMake integration for tracy"

Purpose of change

add an easy way to sample and profile BN executable by using tracy

Describe the solution

updated cmakefiles to integrate tracy client.
copy-pasted no-op macros as most build methods lack tracy
documented how to enable tracy and use it to profile.

Describe alternatives you've considered

using other profilers, but they all seem to be either

slow (callgrind) and needs tweaking
closed source and not free
~~must have to alter source code to insert symbols~~

Additional context

write docs on how to build tracy frontend

olanti-p

I tried to follow the instructions, and it didn't work

git clone https://github.com/wolfpld/tracy.git
cd tracy
make -j 10 -C profiler/build/unix LEGACY=1 release
<...> Some arcane errors related to freetype

After some digging through tracy docs, it turned out I needed to install additional libraries first, and freetype had nothing to do with the issue.

Now that it compiled, I run tracy executable, click "connect", run the game and... nothing happens? Or am i supposed to do something else?

Also, doesn't it need source code modifications to work, or is there some way to collect samples without it (maybe at the cost of precision)?

doc/src/content/docs/en/dev/guides/tracy.md

see: https://cmake.org/cmake/help/latest/policy/CMP0135.html

src/CMakeLists.txt

tools/clang-tidy-plugin/CMakeLists.txt

CMakeLists.txt

olanti-p · 2024-03-30T10:23:07Z

CMakeLists.txt

+    FetchContent_Declare(
+        tracy
+        GIT_REPOSITORY https://github.com/wolfpld/tracy.git
+        GIT_TAG master


This needs to be a fixed release, e.g. https://github.com/wolfpld/tracy/releases/tag/v0.10

According to their docs, it's best to use same version on both client and server, and you wouldn't want to recompile the server each time CMake re-fetches the dependencies

There are no precompiled Windows binaries for master branch, and master is incompatible with latest 0.10 release

there's an issue in linux; release build on v0.10 tend to fail with weird LTO errors and debug build is very slow. while it can be patched it's not ergonomic.

lto-wrapper: warning: using serial compilation of 79 LTRANS jobs lto-wrapper: note: see the ‘-flto’ option documentation for more information mold: error: undefined symbol: tracy::IsaList >>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans9.ltrans.o:(tracy::SourceView::RenderAsmLine(tracy::SourceView::AsmLine&, tracy::SourceView::AddrStat const&, tracy::SourceView::AddrStatData const&, tracy::Worker&, unsigned long&, int, int, tracy::View&)) mold: error: undefined symbol: tracy::MicroArchitectureNum >>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans16.ltrans.o:(tracy::View::DrawImpl())>>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans16.ltrans.o:(tracy::View::DrawImpl())>>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans8.ltrans.o:(tracy::SourceView::RenderSymbolAsmView(tracy::SourceView::AddrStatData const&, tracy::Worker&, tracy::View&))>>> referenced 1 more times mold: error: undefined symbol: tracy::MicroArchitectureData >>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans9.ltrans.o:(tracy::SourceView::RenderAsmLine(tracy::SourceView::AsmLine&, tracy::SourceView::AddrStat const&, tracy::SourceView::AddrStatData const&, tracy::Worker&, unsigned long&, int, int, tracy::View&)) mold: error: undefined symbol: tracy::PortList >>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans9.ltrans.o:(tracy::SourceView::RenderAsmLine(tracy::SourceView::AsmLine&, tracy::SourceView::AddrStat const&, tracy::SourceView::AddrStatData const&, tracy::Worker&, unsigned long&, int, int, tracy::View&)) mold: error: undefined symbol: tracy::MicroArchitectureList >>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans16.ltrans.o:(tracy::View::DrawImpl())>>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans16.ltrans.o:(tracy::View::DrawImpl())>>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans8.ltrans.o:(tracy::SourceView::RenderSymbolAsmView(tracy::SourceView::AddrStatData const&, tracy::Worker&, tracy::View&))>>> referenced 1 more times mold: error: undefined symbol: tracy::OpsList >>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans7.ltrans.o:(tracy::SourceView::SourceView()) mold: error: undefined symbol: tracy::OpDescList >>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans9.ltrans.o:(tracy::SourceView::RenderAsmLine(tracy::SourceView::AsmLine&, tracy::SourceView::AddrStat const&, tracy::SourceView::AddrStatData const&, tracy::Worker&, unsigned long&, int, int, tracy::View&)) mold: error: undefined symbol: tracy::OpsNum >>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans7.ltrans.o:(tracy::SourceView::SourceView())>>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans7.ltrans.o:(tracy::SourceView::SourceView())>>> referenced by <artificial> >>> /tmp/ccc7pN6R.ltrans7.ltrans.o:(tracy::SourceView::SourceView()) collect2: error: ld returned 1 exit status make[1]: *** [../../../common/unix.mk:74: Tracy-release] 오류 1 make[1]: 디렉터리 '/home/scarf/opt/tracy/profiler/build/unix' 나감make: *** [Makefile:11: release] 오류 2 make: 디렉터리 '/home/scarf/opt/tracy/profiler/build/unix' 나감

also this error wolfpld/tracy#765 is only fixed in very recent master. maybe we should conditionally link against v0.10 for windows and recent master commit for linux?

workaround applied in 97517da (#3253).

Oof.

maybe we should conditionally link against v0.10 for windows and recent master commit for linux?

Yeah, sounds reasonable. Maybe note it in documentation somewhere, in case people would like to check out exact same version when they build tracy server from source on linux.

updated docs with relevant info in ac291f1 (#3253).

CMakeLists.txt

Co-authored-by: Olanti <olanti-p@yandex.ru>

CMakeLists.txt

Co-authored-by: Olanti <olanti-p@yandex.ru>

see: https://github.com/cataclysmbnteam/Cataclysm-BN/pull/3253/files?w=1#r1545267113 Co-authored-by: olanti-p <olanti-p@yandex.ru>

see: cataclysmbnteam#3253 (comment)

github-actions bot added the src changes related to source code. label Sep 24, 2023

scarf005 marked this pull request as ready for review September 27, 2023 01:26

scarf005 requested a review from olanti-p September 27, 2023 01:26

scarf005 force-pushed the tracy branch from 4079c6d to 65894d4 Compare September 27, 2023 01:41

olanti-p suggested changes Sep 29, 2023

View reviewed changes

doc/src/content/docs/en/dev/guides/tracy.md Outdated Show resolved Hide resolved

doc/src/content/docs/en/dev/guides/tracy.md Outdated Show resolved Hide resolved

scarf005 marked this pull request as draft October 7, 2023 12:52

scarf005 force-pushed the tracy branch from 8a8d15e to 615cb65 Compare February 14, 2024 15:47

github-actions bot added the docs PRs releated to docs page label Feb 14, 2024

scarf005 added 11 commits March 29, 2024 11:42

build: tracy integration

d7133a4

docs: tracy guide

6166038

build: fix policy CMP0135 error

e77e57d

see: https://cmake.org/cmake/help/latest/policy/CMP0135.html

build: add framemark

dab9d83

docs: installation guide

7a7acbd

docs: desktop entry

2687316

build: add TRACY_ON_DEMAND

b781c46

test: profile do_turn

a8c8602

feat: profile monmove

2f50bc7

fix: ignore tracy macros when disabled

1d66229

docs: explain how to use tracy

44e9bd1

scarf005 force-pushed the tracy branch from 615cb65 to 44e9bd1 Compare March 29, 2024 10:06

scarf005 marked this pull request as ready for review March 29, 2024 10:07

docs: guide on dependencies

6cf8d55

scarf005 requested a review from olanti-p March 29, 2024 11:14

olanti-p reviewed Mar 30, 2024

View reviewed changes

scarf005 and others added 2 commits March 30, 2024 19:50

ci: exclude -Wno-everything on MSVC

f1890a1

Co-authored-by: Olanti <olanti-p@yandex.ru>

ci: Apply suggestions from code review

2f92331

Co-authored-by: Olanti <olanti-p@yandex.ru>

olanti-p reviewed Mar 30, 2024

View reviewed changes

CMakeLists.txt Outdated Show resolved Hide resolved

scarf005 and others added 3 commits March 30, 2024 20:07

ci: take account of static linking

5f334dc

Co-authored-by: Olanti <olanti-p@yandex.ru>

ci: bump minimum required cmake version

2c1d2a0

ci: pin tracy version to v0.10

eca2740

see: https://github.com/cataclysmbnteam/Cataclysm-BN/pull/3253/files?w=1#r1545267113 Co-authored-by: olanti-p <olanti-p@yandex.ru>

scarf005 added 2 commits March 30, 2024 20:49

ci: use latest commit on linux

97517da

see: cataclysmbnteam#3253 (comment)

docs: fileselector workaround

627830e

scarf005 requested a review from olanti-p March 30, 2024 11:57

docs: explain version

ac291f1

scarf005 force-pushed the tracy branch from 6cf4ca5 to ac291f1 Compare March 30, 2024 14:56

olanti-p approved these changes Mar 30, 2024

View reviewed changes

scarf005 merged commit d603949 into cataclysmbnteam:main Mar 30, 2024
13 checks passed

scarf005 deleted the tracy branch March 30, 2024 23:18

scarf005 mentioned this pull request Mar 31, 2024

perf: disable vsync by default #4414

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build: tracy integration #3253

build: tracy integration #3253

scarf005 commented Sep 24, 2023 •

edited

Loading

olanti-p left a comment

olanti-p Mar 30, 2024

scarf005 Mar 30, 2024 •

edited

Loading

scarf005 Mar 30, 2024 •

edited

Loading

olanti-p Mar 30, 2024 •

edited

Loading

scarf005 Mar 30, 2024 •

edited

Loading

build: tracy integration #3253

build: tracy integration #3253

Conversation

scarf005 commented Sep 24, 2023 • edited Loading

Summary

Purpose of change

Describe the solution

Describe alternatives you've considered

Additional context

olanti-p left a comment

Choose a reason for hiding this comment

olanti-p Mar 30, 2024

Choose a reason for hiding this comment

scarf005 Mar 30, 2024 • edited Loading

Choose a reason for hiding this comment

scarf005 Mar 30, 2024 • edited Loading

Choose a reason for hiding this comment

olanti-p Mar 30, 2024 • edited Loading

Choose a reason for hiding this comment

scarf005 Mar 30, 2024 • edited Loading

Choose a reason for hiding this comment

scarf005 commented Sep 24, 2023 •

edited

Loading

scarf005 Mar 30, 2024 •

edited

Loading

scarf005 Mar 30, 2024 •

edited

Loading

olanti-p Mar 30, 2024 •

edited

Loading

scarf005 Mar 30, 2024 •

edited

Loading