Add the Tracy Profiler library to monitor performance #335

illidanstormrange · 2024-11-21T06:42:43Z

接入 TracyProfile

…ons.

wq :

domchen · 2024-11-22T07:42:01Z

CMakeLists.txt

+    if (TGFX_ENABLE_PROFILING)
+        list(APPEND TGFX_TEST_INCLUDES third_party/tracy)
+    endif ()


这个不需要加，前面已经加到了tgfx这个target里了，链接的时候我们指定了tgfx这个taget就会包含它相关的头文件。

前面加的时候标记时privite，没法在单测中引用到。

domchen · 2024-11-22T08:12:58Z

CMakeLists.txt

+    if (TGFX_ENABLE_PROFILING)
+        list(APPEND TGFX_TEST_INCLUDES third_party/tracy)
+    endif ()


domchen · 2024-11-22T08:21:39Z

src/core/utils/Profiling.h

+#include "public/tracy/Tracy.hpp"
+
+#define TRACY_ZONE_SCOPED ZoneScopedN
+#define TRACY_ZONE_SCOPED_N(name) ZoneScopedN(name)


这里参考Skia的命名，改成:
TRACE_EVENT(name) ZoneScopedN(name)
TRACE_EVENT_COLOR(name, color) ZoneScopedNC(name, color)
只需要这两个就足够了吧？

domchen · 2024-11-22T08:21:57Z

src/core/utils/Profiling.h

+#include "public/common/TracySystem.hpp"
+#include "public/tracy/Tracy.hpp"
+
+#define TRACY_ZONE_SCOPED ZoneScopedN


这个define的作用是什么？

写错了，这里后面不应该是ZoneScopedN而是ZoneScoped，可以和其他宏组合，不过我们前期可以不用这么复杂的，我删掉吧

domchen · 2024-11-22T08:22:28Z

src/core/utils/Profiling.h

+#define FRAME_MARK FrameMark
+#define FRAME_MARK_NAME(name) FrameMarkNamed(name)
+#define FRAME_MARK_START(name) FrameMarkStart(name)
+#define FRAME_MARK_START_END(name) FrameMarkEnd(name)


这里是FRAME_MARK_END

…s on GitHub

domchen · 2024-11-22T11:35:30Z

CMakeLists.txt

+    list(APPEND TGFX_STATIC_VENDORS tracy)
+    list(APPEND TGFX_INCLUDES third_party/tracy)
+    list(APPEND TGFX_DEFINES TGFX_ENABLE_PROFILING)
+    set(TRACY_ENABLE ON)


之前看漏了，这句是做什么用的？set()增加的是只有Cmake里可见的变量。你后续也没有访问过它。

这句确实没用，忘记之前为啥加的了，漏删了

domchen · 2024-11-22T11:37:27Z

src/core/utils/Profiling.h

+  }
+};
+
+static TracyENV tracyENV;


这个不能声明在头文件里，会每个引用的地方都实例化一次。

另外如果setenv存在和其他方法调用的先后依赖，不能直接声明一个静态变量就行，因为还有其他静态变量也会初始化，到时候无法确认先后执行顺序。所以应该是定义一些自己的函数，在函数里里做一次性的判断，第一次执行到这个函数的时候就去执行某个方法。也就是你的那些宏不要直接映射到Tracy库的方法，自己写个函数转发一下。

domchen · 2024-11-22T11:42:45Z

src/core/utils/Profiling.h

+#define TRACE_EVENT(name) ZoneScopedN(name)
+#define TRACE_EVENT_COLOR(name, color) ZoneScopedNC(name, color)
+
+#define FRAME_MARK FrameMark


这个define也没有作用吧？

这个主要是统一使用大写的宏，在flush中使用到标记一帧的结束

domchen · 2024-11-22T11:43:54Z

src/core/utils/TaskGroup.cpp

@@ -49,6 +50,7 @@ TaskGroup* TaskGroup::GetInstance() {
 }

 void TaskGroup::RunLoop(TaskGroup* taskGroup) {
+  TRACE_THREAD_NAME("Thread");


这个名字就都起一样的吗？怎么区分是不同的线程。起码要获取一个线程ID吧？

在服务端UI中不同的线程会展示在不同行，获取线程id也行，或者写个静态int变量递增也行，都是为了区分不同线程，从UI层仅依赖不同行也可以区分，所以暂时就没加别的信息区分了。

加个ID区分吧

domchen · 2024-11-22T11:50:32Z

src/gpu/Surface.cpp

 #include "gpu/RenderContext.h"

 namespace tgfx {
 std::shared_ptr<Surface> Surface::Make(Context* context, int width, int height, bool alphaOnly,
                                       int sampleCount, bool mipmapped, uint32_t renderFlags) {
+  TRACE_EVENT_COLOR("Surface::Make", tracy::Color::ColorType::Yellow);


给tracy::Color::ColorType::Yellow 这些颜色定一个对应的宏吧，例如TRACE_COLOR_YELLOW。如果TRACE_EVENT和TRACE_EVENT(color)可以识别为不一样的，那么TRACE_EVENT_COLOR也可以都命名为TRACE_EVENT，避免和颜色枚举产生歧义。

domchen · 2024-11-22T11:57:59Z

src/core/DataProvider.cpp

@@ -25,6 +26,7 @@ class DataWrapper : public DataProvider {
  }

  std::shared_ptr<Data> getData() const override {
+    TRACE_EVENT("DataWrapper::getData");


这个就是个Wrapper，没有任何计算。就不要统计性能了。

domchen · 2024-11-22T11:58:29Z

src/core/ImageDecoder.cpp

@@ -40,6 +41,7 @@ class ImageBufferWrapper : public ImageDecoder {
  }

  std::shared_ptr<ImageBuffer> decode() const override {
+    TRACE_EVENT("ImageBufferWrapper::decode");


同上，移除这个埋点。

domchen · 2024-11-22T12:06:53Z

src/core/images/Image.cpp

@@ -102,26 +107,31 @@ std::shared_ptr<Image> Image::MakeFrom(const ImageInfo& info, std::shared_ptr<Da
 }

 std::shared_ptr<Image> Image::MakeFrom(const Bitmap& bitmap) {
+  TRACE_EVENT("Image::MakeFromBitmap");


不要一个个这样手动写函数名称，有系统的宏可以用。参考：https://github.com/google/skia/blob/main/src/core/SkTraceEvent.h#L27

Add an id to the thread name of TracyProfile

…_NO_INVARIANT_CHECK=1 to avoid errors; Use macros instead of color defined by tracy

…_NO_INVARIANT_CHECK=1 to avoid errors;

domchen · 2024-11-25T11:18:25Z

CMakeLists.txt

@@ -538,3 +552,7 @@ if (TGFX_BUILD_TESTS)
    target_link_options(TGFXFullTest PUBLIC ${TGFX_TEST_LINK_OPTIONS})
    target_link_libraries(TGFXFullTest ${TGFX_TEST_LIBS})
 endif ()
+
+if (TGFX_ENABLE_PROFILING)
+    add_subdirectory(third_party/tracy/profiler)


为啥要用子工程引用？之前不是在vendor.json里配置过吗，用标准的vendor编译方式吧，那样可以缓存。

这个是构建tracyProfile服务端UI，配置的路径下有服务端的cmake，直接设置为子工程构建了

illidanstormrange added 25 commits November 5, 2024 10:18

Add unit tests for YUVData and web PNG format as vp8l

bf43919

Fix code format error

42c93e0

Merge three yuv.txt into one data.yuv; Add some ASSERT and EXPECT

c37ab75

Use Data::MakeFromfile replace Stream::MakeFormFile to Optimize code

514ae4c

Fix code format error

b1cfcd4

Add canvas.atlas and PixelBuffer unit test

69f732d

Change ASSERT condition

d844ad4

Refine code and change the md5

0407b14

Merge main

eae0a13

Add some unit test about layer, and optimize DataView uint test

612c09e

merge main

1cb4810

Update version.json

a88eb51

Restore LayerTest.textLayer's surface width

52e0f39

Update unit test version

fff9f16

Add ShaderSimulationMipmap unit test

4a61379

Update version.txt, fix code format error

c7cca48

Restore npotTextureTileSupport to true

6f652d2

Rename ShaderSimulationMipmap to TileModeFallback

c488ced

Merge branch 'main' into feature/ljj_new_unit_test

98d0a76

Merge branch 'main' into feature/ljj_new_unit_test

4ac2f75

Add TracyProfile module, measure the execution time of several functi…

1fb20a3

…ons.

Enable profile when build type is Debug

5f90df0

Add statistics for function execution time

7b2f334

Merge branch 'main'into feature/ljj_new_unit_test

f9f790a

wq :

Modify code format

e598166

illidanstormrange requested review from kevingpqi123, domchen, Hparty, lvpengwei and shlzxjp as code owners November 21, 2024 06:42

illidanstormrange added 2 commits November 22, 2024 11:27

Simplify the profiling macro defined in CMAKE， ensure uniqueness.

a02582c

CMake adds the configuration to compile trace profiler

9fd2932

domchen reviewed Nov 22, 2024

View reviewed changes

illidanstormrange added 2 commits November 22, 2024 15:53

Merge branch 'main' into feature/ljj_new_unit_test

35c3773

Fix code format error

d827264

domchen reviewed Nov 22, 2024

View reviewed changes

illidanstormrange added 5 commits November 22, 2024 16:42

Simplify Profiling related macro definitions

8026879

Merge branch 'main' into feature/ljj_new_unit_test

67101f2

Add macro TRACY_NO_INVARIANT_CHECK=1 to avoid errors when running job…

e1f09e6

…s on GitHub

Add compile option -DTRACY_NO_INVARIANT_CHECK=1

b86de17

Add env TRACY_NO_INVARIANT_CHECK=1

af8f586

domchen reviewed Nov 22, 2024

View reviewed changes

illidanstormrange added 6 commits November 25, 2024 16:38

Replace the function name of TRACE_EVENT with __PRETTY_FUNCTION__;

4dabb73

Add an id to the thread name of TracyProfile

During the execution of GitHub CI, set the environment variable TRACY…

91d203a

…_NO_INVARIANT_CHECK=1 to avoid errors; Use macros instead of color defined by tracy

During the execution of GitHub CI, set the environment variable TRACY…

5090986

…_NO_INVARIANT_CHECK=1 to avoid errors;

Merge branch 'main' into feature/ljj_new_unit_test

2d4fcdf

Fix initializer error

fcfad72

Add missing atomic header files

435ff25

domchen reviewed Nov 25, 2024

View reviewed changes

Remove the TracyProfiler server UI build in cmake

8fefbe5

domchen approved these changes Nov 25, 2024

View reviewed changes

domchen merged commit cb9edd7 into main Nov 25, 2024
8 checks passed

domchen deleted the feature/ljj_new_unit_test branch November 25, 2024 11:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add the Tracy Profiler library to monitor performance #335

Add the Tracy Profiler library to monitor performance #335

illidanstormrange commented Nov 21, 2024

domchen Nov 22, 2024

illidanstormrange Nov 22, 2024

domchen Nov 22, 2024

domchen Nov 22, 2024

domchen Nov 22, 2024

domchen Nov 22, 2024

illidanstormrange Nov 22, 2024

domchen Nov 22, 2024

domchen Nov 22, 2024

illidanstormrange Nov 25, 2024

domchen Nov 22, 2024

domchen Nov 22, 2024 •

edited

Loading

domchen Nov 22, 2024 •

edited

Loading

illidanstormrange Nov 25, 2024

domchen Nov 22, 2024

illidanstormrange Nov 25, 2024

domchen Nov 25, 2024

domchen Nov 22, 2024 •

edited

Loading

domchen Nov 22, 2024

domchen Nov 22, 2024

domchen Nov 22, 2024

domchen Nov 25, 2024

illidanstormrange Nov 25, 2024

Add the Tracy Profiler library to monitor performance #335

Add the Tracy Profiler library to monitor performance #335

Conversation

illidanstormrange commented Nov 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domchen Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

domchen Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domchen Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domchen Nov 22, 2024 •

edited

Loading

domchen Nov 22, 2024 •

edited

Loading

domchen Nov 22, 2024 •

edited

Loading