xref: /minix3/external/bsd/llvm/dist/clang/test/Profile/README (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1*0a6a1f1dSLionel SambucThese are tests for instrumentation based profiling.  This specifically means
2*0a6a1f1dSLionel Sambucthe -fprofile-instr-generate and -fprofile-instr-use driver flags.
3*0a6a1f1dSLionel Sambuc
4*0a6a1f1dSLionel SambucTests in this directory should usually test both:
5*0a6a1f1dSLionel Sambuc
6*0a6a1f1dSLionel Sambuc  - the generation of instrumentation (-fprofile-instr-generate), and
7*0a6a1f1dSLionel Sambuc  - the use of profile data from instrumented runs (-fprofile-instr-use).
8*0a6a1f1dSLionel Sambuc
9*0a6a1f1dSLionel SambucIn order to test -fprofile-instr-use without actually running an instrumented
10*0a6a1f1dSLionel Sambucprogram, .profdata files are checked into Inputs/.
11*0a6a1f1dSLionel Sambuc
12*0a6a1f1dSLionel SambucThe input source files must include a main function such that building with
13*0a6a1f1dSLionel Sambuc-fprofile-instr-generate and running the resulting program generates the same
14*0a6a1f1dSLionel Sambuc.profdata file that is consumed by the tests for -fprofile-instr-use.  Even
15*0a6a1f1dSLionel Sambuctests that only check -fprofile-instr-use should include such a main function,
16*0a6a1f1dSLionel Sambucso that profile data can be regenerated as the .profdata file format evolves.
17