[docs] Add LICENSE.txt to the root of the mono-repo
[llvm-project.git] / clang / test / Profile / README
blob3b66765711f214a04cdb9d17a7c6935af03420af
1 These are tests for instrumentation based profiling.  This specifically means
2 the -fprofile-instr-generate and -fprofile-instr-use driver flags.
4 Tests in this directory should usually test both:
6   - the generation of instrumentation (-fprofile-instr-generate), and
7   - the use of profile data from instrumented runs (-fprofile-instr-use).
9 In order to test -fprofile-instr-use without actually running an instrumented
10 program, .profdata files are checked into Inputs/.
12 The input source files must include a main function such that building with
13 -fprofile-instr-generate and running the resulting program generates the same
14 .profdata file that is consumed by the tests for -fprofile-instr-use.  Even
15 tests that only check -fprofile-instr-use should include such a main function,
16 so that profile data can be regenerated as the .profdata file format evolves.