New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add CPU Profiling Tool To ACTS #1273

Closed

Scott-James-Hurley opened this issue May 26, 2022 · 0 comments · Fixed by #1274

Contributor

Scott-James-Hurley commented May 26, 2022

Adding a tool to profile CPU usage for the ACTS project will allow developers to identify parts of the code that are not as performant as expected, making it easier to find and resolve performance bottlenecks.

After an investigation gperftools seems to be the most promising solution. It offers a sampling-based CPU profiler which means less effort on the developers' part to start measuring CPU performance.

As a bonus it also includes a memory profiler and heap checker for measuring memory allocations and testing for memory leaks respectively.

This issue would involve:

adding build options for enabling profiling
adding documentation on how to install any dependencies, details on basic usage and resources for further reading on relevant topics
anything else to make it easier for developers to profile the code.

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          feat: Add build options for enabling profiling (acts-project#1273)

a003fb6

Separate build options for enabling CPU and memory profiling are enabled
They link the libraries used by the tools as this is the simplest way
and follows established style

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          Adds doc for installing and using profiling (acts-project#1273)

Adds markdown file in docs/howto explaining how to install, enable, turn
on and use gperftools and related software.

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          Fixes typos in profiling.md (acts-project#1273)

4d6bb09

Scott-James-Hurley mentioned this issue

feat: Add Profiling Support with gperftools #1274

Merged

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          feat: Add build option for specifying gperf path (acts-project#1273)

ed888cc

The location for a gperf install can be sepcified at buiild time to
allow for greater flexibility and lowest privilleges when installing the
tool

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          feat: Add build options for enabling profiling (acts-project#1273)

22800e0

Separate build options for enabling CPU and memory profiling are enabled
They link the libraries used by the tools as this is the simplest way
and follows established style

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          Adds doc for installing and using profiling (acts-project#1273)

b2c32ac

Adds markdown file in docs/howto explaining how to install, enable, turn
on and use gperftools and related software.

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          Fixes typos in profiling.md (acts-project#1273)

a40ee58

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          feat: Add build option for specifying gperf path (acts-project#1273)

6abcb25

The location for a gperf install can be sepcified at buiild time to
allow for greater flexibility and lowest privilleges when installing the
tool

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          feat: Add build options for enabling profiling (acts-project#1273)

a9a6d1f

Separate build options for enabling CPU and memory profiling are enabled
They link the libraries used by the tools as this is the simplest way
and follows established style

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          Adds doc for installing and using profiling (acts-project#1273)

bf12097

Adds markdown file in docs/howto explaining how to install, enable, turn
on and use gperftools and related software.

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          Fixes typos in profiling.md (acts-project#1273)

de657df

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          feat: Add build option for specifying gperf path (acts-project#1273)

86580c4

The location for a gperf install can be sepcified at buiild time to
allow for greater flexibility and lowest privilleges when installing the
tool

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          feat: Add build options for enabling profiling (acts-project#1273)

b60cff5

Separate build options for enabling CPU and memory profiling are enabled
They link the libraries used by the tools as this is the simplest way
and follows established style

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          Adds doc for installing and using profiling (acts-project#1273)

904ba27

Adds markdown file in docs/howto explaining how to install, enable, turn
on and use gperftools and related software.

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          Fixes typos in profiling.md (acts-project#1273)

8bf9284

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          feat: Add build option for specifying gperf path (acts-project#1273)

98b38f2

The location for a gperf install can be sepcified at buiild time to
allow for greater flexibility and lowest privilleges when installing the
tool

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          feat: Add build options for enabling profiling (acts-project#1273)

1fab6fe

Separate build options for enabling CPU and memory profiling are enabled
They link the libraries used by the tools as this is the simplest way
and follows established style

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          Adds doc for installing and using profiling (acts-project#1273)

ccedf6a

Adds markdown file in docs/howto explaining how to install, enable, turn
on and use gperftools and related software.

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          Fixes typos in profiling.md (acts-project#1273)

32816d9

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          feat: Add build option for specifying gperf path (acts-project#1273)

95b07ed

The location for a gperf install can be sepcified at buiild time to
allow for greater flexibility and lowest privilleges when installing the
tool

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          feat: Remove -g option when profiling (acts-project#1273)

772748c

It's not needed to enable profiling

Scott-James-Hurley added a commit to Scott-James-Hurley/acts_profiling that referenced this issue


          feat: Added -g back in in ActsCompilerOptions (acts-project#1273)

53e5a34

kodiakhq bot closed this as completed in #1274

kodiakhq bot pushed a commit that referenced this issue


          feat: Add Profiling Support with gperftools (#1274)

7bf3981

Closes: #1273

This PR adds two new build options: `ACTS_ENABLE_CPU_PROFILING` and `ACTS_ENABLE_MEMORY_PROFILING` that will link libraries and add compile options to enable the use of gperftools' CPU profiler and memory profiler/heap checker respectively. The libraries are linked in the `Core` package as the code here is always built and is the main point of interest for performance profiling.

This PR also adds documentation to `docs/howto` for installing, enabling and using gperftools with ACTS, including some information about basic commands that I found useful when profiling ACTS as well as relevant links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment