Don't increment caller/callee cost multiple times for recursive stacks

When we encounter a call stack with a recursive function call, we must
not increment the caller/callee cost more than once per stack. This
fixes the cost calculation for such stacks, which used to produce
costs that where sometimes beyond the actual peak cost.

Remove extra ';'

Fixes compiler warnings in pedantic mode.

Include cinttypes where required.

This change is required to fix compilation errors under DevToolset4 on
CentOS with gcc 5.2.1, cf.:

https://www.softwarecollections.org/en/scls/rhscl/devtoolset-4/

Update copyright year

Restructure source code directory layout

Everything that's not 3rdparty or tests is now moved into the src
subfolder. That one in turn contains the following folders:

- util: shared helper functionality
- track: core functionality of heaptrack, i.e. the stuff that
  gets injected into the client code
- interpret: does the first-level aggregation and DWARF translations
  on the raw instruction pointers returned by tracking code
- analyze: high-level analyzers, i.e.:
  print: the ASCII dumper
  gui: the Qt/KDE GUI

Merge remote-tracking branch 'paulmenzel/improve-readme.md'

Fix flamegraph tooltip for top-level item

Use the item's "function" directly, as that one is actually a
tooltip-like label already for the top-level item.

Add screenshots to README.md file

Use the internal `__libc_dlopen_mode` symbol instead of `dlmopen`

Both, `dlmopen` and `dlopen` are only available when the debugeee
application links against libdl. When that is not the case, one
could not inject heaptrack at runtime.

By instead using the libc.so internal `__libc_dlopen_mode` function,
we get rid of this limitation and we can also inject into applications
that only link against libc.so but not libdl.

This trick was found in the linux-inject project:
https://github.com/gaffe23/linux-inject

Document that you need gdb for runtime-attaching.

Make dependency on KChart optional

The heaptrack_gui is pretty useable without KChart. So for those
who don't have access to KChart, simply skip charting and only
display the table views of raw data. Still better than using
heaptrack_print.

Add basic documentation on how to build heaptrack

Most notably, tell the world about the various dependencies that
heaptrack has, both the core data collector as well as the analyzer
GUI.

Link against libunwind directly, we don't need to link against the backtrace library here.

Fix use-after-free in usage of libbacktrace.

We passed the c_str of a temporary std::string to libbacktrace,
which stored that in internal data structures. Later on, that dangling
pointer was accessed leading to subtle bugs which for odd reasons
did not became apparent until recently. Running the interpreter
through valgrind easily showed the problem though.

This fixes the 'failed to read executable information' error messages
emitted by heaptrack, and also ensures the profile data attributes
costs to the correct modules.

CCMAIL: apol@kde.org

README: Remove trailing whitespace

README: Add newline to end of file

Text files should end with a newline. So add one.

Extend error message.

If dwarf.h is not found, then either elfutils-dev or libdwarf-dev need to be installed

Add pool-allocator API for heaptrack.

This is a header-only API that you can use to add support for
pool-allocators or other custom allocators to heaptrack. Simply
include the header and call the `heaptrack_report_*` macros in
your custom allocator. When you trace your code under heaptrack,
the allocations will then be tracked. If you don't run under
heaptrack, nothing will happen.

    #include <heaptrack.h>

    void* MyPool::allocate(size_t s)
    {
        void* ptr = /* allocate s */;
        heaptrack_report_malloc(ptr, s);
        return ptr;
    }

    void MyPool::free(void* ptr)
    {
        heaptrack_report_free(ptr);
        /* actually free */
    }

Make libheaptrack.h C-compliant.

Skip top rows without cost.

This can happen when diffing files.

Remove rows without cost from caller/callee data.

This reduces clutter for diffs.

Merge branch 'wip/diffing'

Also disable flame graphs in diff mode.

In the future, we may want to implement differential flame graphs,
but for now this is too much work.

Disable charts in diff mode.

This could be implemented eventually, but is a lot of work.

Load diff base data in parallel to primary data file.

Slightly improves performance when diffing.

Reword --diff CLI help text, add -d, for heaptrack_gui.

Make it possible to easily diff between files from the heaptrack_gui.

Add some more code comments for the diffing method.

Convert more data types to signed integers.

We now also calculate the difference between time, peakRSS and
system info when diffing heaptrack data files.

Add diff support between files to heaptrack_{print,gui}.

Both executables get a new `--diff <file>` argument. The file
that is passed gets parsed in addition to the primary data file.
The allocation data therein will then be subtracted from the data
found in the primary data file.

The algorithm is somewhat complicated, because we have to ignore
instruction pointer addresses, as these will vary between runs
due to address space randomization. Paired with (partial) lack of
debug symbols, we end up with non-trivial situation to map allocations
from one run to that of another.

Essentially, we need to find the correct allocation that shares the
same backtrace while ignoring instruction pointer addresses.

Don't crash when switching the call-stack direction.

Add basic README.md

Refactor code to use signed data types.

This is required to handle diffing between files or between
individual timestamps. Since we use 64bit data types, we
can still handle a lot of allocations this way (a bit more than
9 exabytes).

Add minus operator to AllocationData

Make it possible to skip building of heaptrack_gui.

For embedded, we never want to build the gui, and having the
find scripts spit out their errors there is just noisy.

Now, the recommended way to build heaptrack for embedded Linux is:

cmake -DCMAKE_TOOLCHAIN_FILE=... -DHEAPTRACK_BUILD_GUI=OFF

Refactor code to remove reliance on undefined behavior.

Previously, the code got away with a c-style reinterpret_cast
in a constexpr function, which is not allowed according to the
standard. I think I was just lucky that the compiler didn't saw
through that yet.

Also, the code assumed (and enforced) that all function pointers
are sizeof(void*), which worked, but was a bit clunky.

Now, we simply get rid of the list of addresses, and iterate
manually over all hooks. With C++17's apply, this could be implemented
even nicer with a tuple and std::apply. That doesn't exist yet, so
we manually call the functions.

Slightly cleanup code of preload hooks.

We instantiate directly with the decltype of a function
pointer now, so thereis no need to construct the pointer
via a secondary type anymore.

Increase portability to systems that don't have cfree available.

cfree should not be used, according to its man page, but if it's
being used then we need to overload it. On systems where it is not
available, simply skip this step to keep heaptrack compiling.

Track temporary allocations by their AllocationInfo index.

There is no need to output a boolean '1' for temporary allocations,
as we have the same information when looking at the AllocationInfo
index that corresponds to a unique size and location. I.e. we used
to output

+ 12
- 12 1
+ 42
- 43

But the same information is held by

+ 12
- 12
+ 42
- 43

Move MergedAllocation struct to heaptrack_print.

It's only being used there.

Make heaptrack.sh shell script work with dash.

Improve bash compatibility of heaptrack shell script.

- don't use case fall-through via ;;&
- access /proc/$pid/comm directly

Update display text when navigation through history.

Make text in labels selectable by mouse.

Make it possible to go back/forward in flamegraph via keyboard.

We keep a simple list of items around that got selected and use
that when the user presses the standard back/forward keys to
reset the view state accordingly.

Fix compile: include cmath and use std::round.

Add a dock widget with the important graphs.

This allows the data to be visible when looking at other data
and that makes it easier to correlate then.

Improve tooltips on total data of charts.

Remove wrong unit. formatByteSize() returns the right one.

Add tooltips for more UI elements in the flame graph view.

Set cursors to show that you can interact with the flame graph.

Use monospace font for function labels in description.

Note: <tt> uses the wrong font, afaik that got fixed for 5.6.1 or 5.7.

Enable wordwrap to prevent layout issues on wide function labels.

Move the frame description to the bottom of the ui

Otherwise the tooltip fades away too quickly, and often the mouse cursor covers
and hides the number at the start of it.

Replace rigid layout with a QSplitter

HTML-escape strings in tooltips, esp. required for C++ templates.

Fix wrong conditional that lead to excessive i18n calls.

Cache QPen and QBrush used by ChartModel.

This removes quite a few allocations that would otherwise happen
when the data is queried by KDiagram.

Add relative cost numbers to the tree model tooltips.

Show cost fractions in flamegraph tooltips.

Introduce cost threshold for flamegraph to minimize memory overhead.

For larger data files, the flamegraph can easily consume hundreds
of megabytes of ram and take multiple seconds to be build up. This
is mostly due to the dozens of small leaf items, all of which only
have tiny cost and will not be shown most of the time.

The new default cut-off of 0.1% drastically reduces the memory
overhead and the flamegraph will be build nearly instantly even for
larger data sets.

In the future, one could even refine the data on-demand.

Add an experimental perf->heaptrack data converter.

The resulting data file is much smaller than a perf.data file, and
can be visualized with heaptrack_gui. Of course, the labels will be
all off, but this is a good first step towards visualizing perf data
files with the heaptrack code infrastructure.

Prevent off-by-one data access in chart models.

Make code more error resilient when parsing data files.

Check validity of allocation index when parsing data file.

Never divide by zero.

Intern caller/callee data by location data.

Add caller/callee table view of data.

Reuse common AllocationData class, with operator+=, operator+.

Simplifies the code in some areas.

Make it possible to select different cost sources for the flame graph.

Also put the bottom-down action into the new control toolbar.

Don't print unknown file/line location in tooltip.

Colorize model cost cells background based on relative cost to total.

Maniphest Task: https://phabricator.kde.org/T1709

Properly skip 32bit versions of operator new.

Fix compile warnings on 32bit machines

Update libbacktrace from GCC trunk@234085.

Don't show functions that triggered no temporary allocations in top list.

Add executable to measure malloc overhead.

Filter rows that did not leak anything in TopProxy.

Include total system memory and peak RSS usage in output.

We now track the RSS by parsing /proc/self/statm on every timestamp.
The total system memory is taken from sysconf.

The RSS may potentially miss its true peaks, which can be handled in
the future via getrusage(). Still, this is a nice and useful addition
I think.

Show minimal statistics directly after heaptrack finished.

Pass correct data to dl_iterate_phdr.

I wonder why this didn't crash before...

Don't access invalid memory for tiny or broken input files.

Put summary text into three columns to save vertical space.

Display the time when the memory peak was encountered.

Remove resize-to-contents call.

Add summary tab and display all top functions there.

Show error when we failed to parse an input file.

Use monospace font family in tooltips.

Bug got fixed upstream in Qt but for older Qt this improves
readability significantly.

Don't show 'backtrace: ' without a backtrace in the tooltip.

Add stacks model to display full backtrace for selection.

Display shorter basename for files in tables by default.

Don't descend into children of invisible flamegraph items.

Optimize TreeModel: cache KFormat to prevent repeated allocations.

Let KDE*CompilerSettings change the policies in the project

As suggested in ECM documentation.

Decrease indentation which allows us to show deeper backtraces with less space to the left.

There is still work left to be done to have a nice GUI for
deep backtraces, potentially by not increasing the indentation
depth when the merged backtrace has no forks.

Make chart tooltips better readable.

Use std::tie instead of std::make_tuple for lexicographical ordering.

std::tie takes the arguments by reference, whereas make_tuple copies
them. We want the former.

See also: http://www.cppsamples.com/common-tasks/lexicographic-ordering.html

Show data as soon as it is available.

This way one can investigate the data table while waiting for the
charts to be built up, which can take some time for large data
files.

Sort cost columns initially in descending order.

Add some indication on the file load process.