[profile] Add a mode to continuously sync counter updates to a file
authorVedant Kumar <vsk@apple.com>
Thu, 19 Sep 2019 18:56:43 +0000 (11:56 -0700)
committerVedant Kumar <vsk@apple.com>
Thu, 31 Oct 2019 23:04:09 +0000 (16:04 -0700)
commitd889d1efefe9f97507e3eafa85a2e3939df9750f
tree3b0b092d7b64e5f1620b7eef3b0282d214663e95
parentade776b5845384bb45fcd2f7919d80f4101971a7
[profile] Add a mode to continuously sync counter updates to a file

Add support for continuously syncing profile counter updates to a file.

The motivation for this is that programs do not always exit cleanly. On
iOS, for example, programs are usually killed via a signal from the OS.
Running atexit() handlers after catching a signal is unreliable, so some
method for progressively writing out profile data is necessary.

The approach taken here is to mmap() the `__llvm_prf_cnts` section onto
a raw profile. To do this, the linker must page-align the counter and
data sections, and the runtime must ensure that counters are mapped to a
page-aligned offset within a raw profile.

Continuous mode is (for the moment) incompatible with the online merging
mode. This limitation is lifted in https://reviews.llvm.org/D69586.

Continuous mode is also (for the moment) incompatible with value
profiling, as I'm not sure whether there is interest in this and the
implementation may be tricky.

As I have not been able to test extensively on non-Darwin platforms,
only Darwin support is included for the moment. However, continuous mode
may "just work" without modification on Linux and some UNIX-likes. AIUI
the default value for the GNU linker's `--section-alignment` flag is set
to the page size on many systems. This appears to be true for LLD as
well, as its `no_nmagic` option is on by default. Continuous mode will
not "just work" on Fuchsia or Windows, as it's not possible to mmap() a
section on these platforms. There is a proposal to add a layer of
indirection to the profile instrumentation to support these platforms.

rdar://54210980

Differential Revision: https://reviews.llvm.org/D68351
27 files changed:
clang/docs/SourceBasedCodeCoverage.rst
clang/lib/Driver/ToolChains/Darwin.cpp
clang/test/Driver/darwin-ld.c
compiler-rt/lib/profile/InstrProfData.inc
compiler-rt/lib/profile/InstrProfiling.h
compiler-rt/lib/profile/InstrProfilingBuffer.c
compiler-rt/lib/profile/InstrProfilingFile.c
compiler-rt/lib/profile/InstrProfilingPort.h
compiler-rt/lib/profile/InstrProfilingRuntime.cpp
compiler-rt/lib/profile/InstrProfilingWriter.c
compiler-rt/test/profile/ContinuousSyncMode/basic.c [new file with mode: 0644]
compiler-rt/test/profile/ContinuousSyncMode/darwin-proof-of-concept.c [new file with mode: 0644]
compiler-rt/test/profile/ContinuousSyncMode/lit.local.cfg.py [new file with mode: 0644]
compiler-rt/test/profile/ContinuousSyncMode/multiple-DSOs.c [new file with mode: 0644]
compiler-rt/test/profile/ContinuousSyncMode/pid-substitution.c [new file with mode: 0644]
compiler-rt/test/profile/ContinuousSyncMode/set-file-object.c [new file with mode: 0644]
compiler-rt/test/profile/ContinuousSyncMode/set-filename.c [new file with mode: 0644]
llvm/include/llvm/ProfileData/InstrProfData.inc
llvm/lib/ProfileData/InstrProfReader.cpp
llvm/test/tools/llvm-profdata/Inputs/c-general.profraw
llvm/test/tools/llvm-profdata/c-general.test
llvm/test/tools/llvm-profdata/malformed-ptr-to-counter-array.test
llvm/test/tools/llvm-profdata/raw-32-bits-be.test
llvm/test/tools/llvm-profdata/raw-32-bits-le.test
llvm/test/tools/llvm-profdata/raw-64-bits-be.test
llvm/test/tools/llvm-profdata/raw-64-bits-le.test
llvm/test/tools/llvm-profdata/raw-two-profiles.test