Draft: PIN-based Tracer engine with visualizations

[PeterMocary]

Introduces a new Tracer engine implemented using the Intel's PIN framework
and new visualizations. The PIN based tracer supports three modes of
execution: time, memory and instructions.

• time mode - allows collection of function (and basic block)
  run-times as well as collection of simple function arguments. The time
  mode is collects only information about functions by default and
  collection of basic blocks needs to be explicitly enabled. It also
  provides option to collect information only about basic blocks
  and infer the function run-times based on them instead.

• memory mode - allows collection of information about memory
  manipulation functions (malloc, calloc, realloc, new, free and delete
  are supported). This includes collection of their arguments and location
  as well as the return values.

• instruction mode - allows collection of number of executed
  instructions in basic blocks (and functions). This mode collects basic
  blocks only.

Execution examples:

perun collect -c <cmd> trace -e pin --mode <mode-name>
perun collect -c <cmd> trace -e pin --mode time --collect-basic-blocks
perun collect -c <cmd> trace -e pin --mode time --collect-arguments
perun collect -c <cmd> trace -e pin --mode time --collect-basic-blocks-only

The three new visualizations introduced are: basicblocks,
funcargs, and treemap.

• basicblocks visualization - a sunburst graph that contains
  run-times (or number of executions) of functions with their basic
  blocks. It supports basic mapping of the basic blocks to the source
  code. The mapping is, however bit tricky to incorporate into the graph,
  thus treemap visualization utilizing different library was created.
  This visualization uses old version of bokehlibrary and might be retired
  in the future.

• funcargs visualization - a scatter graph that shows dependency
  between function run-time and values of collected arguments.

• treemap visualization - has multiple forms of representation as a
  graph: tree-map, sunburst, and flame graph. Each visualizes
  the call graph as a tree in a slightly different way. It supports
  mapping of basic blocks to source code.

Execution examples:

perun show <profile> <visualization-name>
perun show 0@p funcargs --function-name <function-name>
perun show <path-to-profile-or-profile-name>funcargs --function-name <function-name>
perun show 0@p basicblocks --top-functions 5 --top-basic-blocks 5 --sort-by execs
perun show 0@p treemap --graph-type sunburst
perun show 0@p treemap --basic-blocks

How to setup pin:

wget https://software.intel.com/sites/landingpage/pintool/downloads/pin-external-3.31-98861-g71afcc22f-gcc-linux.tar.gz
tar -xvzf ./pin-external-3.31-98861-g71afcc22f-gcc-linux.tar.gz
export PIN_ROOT="$(pwd)/pin-external-3.31-98861-g71afcc22f-gcc-linux"

TODO:

• refactoring and fixes
  • fix the instructions mode parser
  • fix the basic blocks only parser
• rebase
• add tests for pin based tracer engine
• add tests for visualizations
• fix typing
• how to setup guide
• create issues that need to be addressed in future
  • pick better names for visualizations
  • address todos for exceptions
  • merging the time and instructions parsers into duration parser?

[PeterMocary]

There is currently a problem with using hash tables with PIN kit and g++ 12 and newer. The standard library within the kit triggers an uninitialized variable warning that is treated as error by default. Therefore I added a pragma to ignore this warning until the problem is resolved by the PIN kit developers.

[codecov]

Codecov Report

Attention: Patch coverage is 19.72789% with 354 lines in your changes missing coverage. Please review.

Project coverage is 95.87%. Comparing base (02b625f) to head (e96c17d).

Files with missing lines	Patch %	Lines
perun/view/basicblocks/run.py	13.36%	188 Missing ⚠️
perun/view/treemap/run.py	16.96%	93 Missing ⚠️
perun/view/funcargs/run.py	16.66%	70 Missing ⚠️
perun/utils/exceptions.py	83.33%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##            devel     #157      +/-   ##
==========================================
- Coverage   99.07%   95.87%   -3.20%     
==========================================
  Files         150      156       +6     
  Lines       10470    10910     +440     
==========================================
+ Hits        10373    10460      +87     
- Misses         97      450     +353     

Flag	Coverage Δ
coverage-3.10	95.87% <19.72%> (-3.20%)	⬇️
coverage-3.11	95.87% <19.72%> (-3.20%)	⬇️
coverage-3.12	95.86% <19.72%> (-3.21%)	⬇️
coverage-3.9	95.86% <19.72%> (-3.21%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.