[BOLT][TEST] Replace cache+ option with ext-tsp

[nhuhuan]

Summary

Replace "cache+" with "ext-tsp" in all BOLT tests

Test Plan:

ninja check-bolt
grep -rnw . -e "cache+"

no more tests containing "cache+"
"cache+" and "ext-tsp" are aliases

[Amir]

@spupyrev: we're getting rid of cache+ option in tests and documentation.
The plan is to gradually deprecate the option: emit a warning when cache+ is passed, but not to remove the option from BOLT for now. The warning will be added in a follow-up diff. Hope it makes sense to you.

CC @maksfb @rafaelauler

[rafauler]

Okay, looks good to me

[Amir]

The follow-up with a warning: D126722

bolt/README.md

 the command line above.
 
 ### Step 3: Optimize with BOLT
 
 Once you have `perf.fdata` ready, you can use it for optimizations with
 BOLT. Assuming your environment is setup to include the right path, execute
 `llvm-bolt`:
 ```
-$ llvm-bolt <executable> -o <executable>.bolt -data=perf.fdata -reorder-blocks=cache+ -reorder-functions=hfsort -split-functions=2 -split-all-cold -split-eh -dyno-stats
+$ llvm-bolt <executable> -o <executable>.bolt -data=perf.fdata -reorder-blocks=ext-tsp -reorder-functions=hfsort -split-functions=2 -split-all-cold -split-eh -dyno-stats
 ```
 
 If you do need an updated debug info, then add `-update-debug-sections` option
 to the command above. The processing time will be slightly longer.
 
 For a full list of options see `-help`/`-help-hidden` output.
 
 The input binary for this step does not have to 100% match the binary used for

bolt/docs/OptimizingClang.md

 ```bash
   $ perf2bolt $CPATH/clang-7 -p perf.data -o clang-7.fdata -w clang-7.yaml
 ```
 Notice that we are passing `clang-7` to `perf2bolt` which is the real binary that
 `clang` and `clang++` are symlinking to. The next step will optimize Clang using
 the generated profile:
 ```bash
 $ llvm-bolt $CPATH/clang-7 -o $CPATH/clang-7.bolt -b clang-7.yaml \
-    -reorder-blocks=cache+ -reorder-functions=hfsort+ -split-functions=3 \
+    -reorder-blocks=ext-tsp -reorder-functions=hfsort+ -split-functions=3 \
     -split-all-cold -dyno-stats -icf=1 -use-gnu-stack
 ```
 The output will look similar to the one below:
 ```t
 ...
 BOLT-INFO: enabling relocation mode
 BOLT-INFO: 11415 functions out of 104526 simple functions (10.9%) have non-empty execution profile.
 ...

bolt/test/X86/bug-reorder-bb-jrcxz.s

 # REQUIRES: system-linux
 
 # RUN: llvm-mc -filetype=obj -triple x86_64-unknown-unknown \
 # RUN:   %s -o %t.o
 # RUN: link_fdata %s %t.o %t.fdata
 # RUN: %clang %cflags %t.o -falign-labels -march=native -o %t.exe -Wl,-q
 
 # RUN:  llvm-bolt %t.exe -o %t.bolted -data %t.fdata \
-# RUN:    -reorder-blocks=cache+ -reorder-functions=hfsort \
+# RUN:    -reorder-blocks=ext-tsp -reorder-functions=hfsort \
 # RUN:    -split-functions=2 -split-all-cold -split-eh -dyno-stats \
 # RUN:    -print-finalized 2>&1 | FileCheck %s
 
 # CHECK-NOT: value of -2105 is too large for field of 1 byte.
 
   .text
   .section .text.startup,"ax",@progbits
   .p2align 5,,31

bolt/test/X86/loop-inversion-pass.s

 # REQUIRES: system-linux
 
 # RUN: llvm-mc -filetype=obj -triple x86_64-unknown-unknown \
 # RUN:   %s -o %t.o
 # RUN: link_fdata %s %t.o %t.fdata
 # RUN: link_fdata %s %t.o %t.fdata2 "FDATA2"
 # RUN: link_fdata %s %t.o %t.fdata3 "FDATA3"
 # RUN: %clang %cflags %t.o -o %t.exe -Wl,-q
-# RUN: llvm-bolt %t.exe -data %t.fdata -reorder-blocks=cache+ -print-finalized \
+# RUN: llvm-bolt %t.exe -data %t.fdata -reorder-blocks=ext-tsp -print-finalized \
 # RUN:    -loop-inversion-opt -o %t.out | FileCheck %s
-# RUN: llvm-bolt %t.exe -data %t.fdata2 -reorder-blocks=cache+ -print-finalized \
+# RUN: llvm-bolt %t.exe -data %t.fdata2 -reorder-blocks=ext-tsp -print-finalized \
 # RUN:    -loop-inversion-opt -o %t.out2 | FileCheck --check-prefix="CHECK2" %s
 # RUN: llvm-bolt %t.exe -data %t.fdata3 -reorder-blocks=none -print-finalized \
 # RUN:    -loop-inversion-opt -o %t.out3 | FileCheck --check-prefix="CHECK3" %s
 
 # The case where the loop is used:
 # FDATA: 1 main 2 1 main #.J1# 0 420
 # FDATA: 1 main b 1 main #.Jloop# 0 420
 # FDATA: 1 main b 1 main d 0 1

bolt/test/X86/tail-duplication-pass.s

 # REQUIRES: system-linux
 
 # RUN: llvm-mc -filetype=obj -triple x86_64-unknown-unknown \
 # RUN:   %s -o %t.o
 # RUN: link_fdata %s %t.o %t.fdata
 # RUN: %clang %cflags %t.o -o %t.exe -Wl,-q
-# RUN: llvm-bolt %t.exe -data %t.fdata -reorder-blocks=cache+ -print-finalized \
+# RUN: llvm-bolt %t.exe -data %t.fdata -reorder-blocks=ext-tsp -print-finalized \
 # RUN:    -tail-duplication -tail-duplication-minimum-offset 1 -o %t.out | FileCheck %s
 
 # FDATA: 1 main 2 1 main #.BB2# 0 10
 # FDATA: 1 main 4 1 main #.BB2# 0 20
 # CHECK: tail duplication possible duplications: 1
 # CHECK: BB Layout   : .LBB00, .Ltail-dup0, .Ltmp0, .Ltmp1
 
     .text

bolt/test/runtime/X86/exceptions-instrumentation.test

 # Check instrumentation of C++ code with exceptions
 
 REQUIRES: system-linux
 
 RUN: %clangxx %cxxflags -no-pie %p/Inputs/exceptions_split.cpp -Wl,-q -g -o %t_exc_split
 RUN: llvm-bolt %t_exc_split -o %t.exc -instrument -instrumentation-file=%t.fdata
 
 RUN: %t.exc arg1 arg2 arg3
 
 RUN: llvm-bolt %t_exc_split -o %t.exc.bolted -data %t.fdata \
-RUN:   -reorder-blocks=cache+ -reorder-functions=hfsort+ -split-functions=3 \
+RUN:   -reorder-blocks=ext-tsp -reorder-functions=hfsort+ -split-functions=3 \
 RUN:   -split-eh=1 | FileCheck --check-prefix=EXCEPTIONS %s
 EXCEPTIONS-NOT: invalid (possibly stale) profile
 
 # Check that cold symbols are emitted with local binding.
 RUN: llvm-readelf -Ws %t.exc.bolted | FileCheck %s --check-prefix=CHECK-READELF
 CHECK-READELF: FUNC    LOCAL  DEFAULT   {{.*}} main.cold.{{.*}}
 
 RUN: cat %t.fdata | FileCheck --check-prefix=EXCEPTIONS-FDATA %s
 # Check that the printf "catch" ran exactly 10 times
 EXCEPTIONS-FDATA: 1 main {{.*}} 1 _Znwm@PLT 0 0 10

bolt/test/runtime/X86/fix-branches-jrcxz.s

 # Test BOLT does not crash by trying to change the direction of a JRCXZ
 
 # REQUIRES: system-linux
 
 # RUN: llvm-mc -filetype=obj -triple x86_64-unknown-unknown \
 # RUN:   %s -o %t.o
 # RUN: link_fdata %s %t.o %t.fdata
 # RUN: llvm-strip --strip-unneeded %t.o
 # RUN: %clang %cflags -no-pie %t.o -o %t.exe -Wl,-q
-# RUN: llvm-bolt %t.exe -relocs=1 -reorder-blocks=cache+ -print-finalized \
+# RUN: llvm-bolt %t.exe -relocs=1 -reorder-blocks=ext-tsp -print-finalized \
 # RUN:    -o %t.out -data %t.fdata | FileCheck %s
 # RUN: %t.out 1 2 3
 
 # CHECK: BOLT-INFO
 
   .text
   .section .text.startup,"ax",@progbits
   .p2align 5,,31

bolt/test/runtime/X86/instrumentation-dup-jts.s

 # RUN: llvm-bolt %t.exe -instrument -instrumentation-file=%t.fdata \
 # RUN:   -o %t.instrumented
 
 # Instrumented program needs to finish returning zero
 # RUN: %t.instrumented 120
 
 # Test that the instrumented data makes sense
 # RUN:  llvm-bolt %t.exe -o %t.bolted -data %t.fdata \
-# RUN:    -reorder-blocks=cache+ -reorder-functions=hfsort+ \
+# RUN:    -reorder-blocks=ext-tsp -reorder-functions=hfsort+ \
 # RUN:    -print-only=interp -print-finalized | FileCheck %s
 
 # RUN: %t.bolted 120
 
 # Check that our two indirect jumps are recorded in the fdata file and that
 # each has its own independent profile
 # CHECK:  Successors: .Ltmp1 (mispreds: 0, count: 1), .Ltmp0 (mispreds: 0, count: 0), .Ltmp2 (mispreds: 0, count: 0)
 # CHECK:  Successors: .Ltmp0 (mispreds: 0, count: 1), .Ltmp2 (mispreds: 0, count: 1), .Ltmp1 (mispreds: 0, count: 0)

bolt/test/runtime/X86/instrumentation-ind-calls.s

 # RUN: llvm-bolt %t.exe -instrument -instrumentation-file=%t.fdata \
 # RUN:   -o %t.instrumented
 
 # Instrumented program needs to finish returning zero
 # RUN: %t.instrumented arg1 arg2
 
 # Test that the instrumented data makes sense
 # RUN:  llvm-bolt %t.exe -o %t.bolted -data %t.fdata \
-# RUN:    -reorder-blocks=cache+ -reorder-functions=hfsort+ \
+# RUN:    -reorder-blocks=ext-tsp -reorder-functions=hfsort+ \
 # RUN:    -print-only=main -print-finalized | FileCheck %s
 
 # RUN: %t.bolted arg1 arg2
 
 # Check that our indirect call has 1 hit recorded in the fdata file and that
 # this was processed correctly by BOLT
 # CHECK:         callq   *0x18(%rsp) # CallProfile: 1 (0 misses) :
 # CHECK-NEXT:        { targetFunc: 1 (0 misses) }

bolt/test/runtime/X86/instrumentation-indirect.c

 RUN:   -instrumentation-wait-forks=1 \
 RUN:   -o %t.instrumented
 
 # Instrumented program needs to finish returning zero
 RUN: %t.instrumented | FileCheck %s -check-prefix=CHECK-OUTPUT
 
 # Test that the instrumented data makes sense
 RUN:  llvm-bolt %t.exe -o %t.bolted -data %t.fdata \
-RUN:    -reorder-blocks=cache+ -reorder-functions=hfsort+ \
+RUN:    -reorder-blocks=ext-tsp -reorder-functions=hfsort+ \
 RUN:    -print-only=interp -print-finalized
 
 RUN: %t.bolted | FileCheck %s -check-prefix=CHECK-OUTPUT
 
 CHECK-OUTPUT: [child]
 CHECK-OUTPUT: [parent]
 */

bolt/test/runtime/X86/instrumentation-pie.c

 RUN: llvm-bolt %t.exe -instrument -instrumentation-file=%t.fdata \
 RUN:   -o %t.instrumented
 
 # Instrumented program needs to finish returning zero
 RUN: %t.instrumented 1 2 3 | FileCheck %s -check-prefix=CHECK-OUTPUT
 
 # Test that the instrumented data makes sense
 RUN:  llvm-bolt %t.exe -o %t.bolted -data %t.fdata \
-RUN:    -reorder-blocks=cache+ -reorder-functions=hfsort+
+RUN:    -reorder-blocks=ext-tsp -reorder-functions=hfsort+
 
 RUN: %t.bolted 1 2 3  | FileCheck %s -check-prefix=CHECK-OUTPUT
 
 CHECK-OUTPUT: fib(4) = 3
 */

bolt/test/runtime/X86/instrumentation-shlib.c

 RUN:   -o %t.so.instrumented
 
 # Program with instrumented shared library needs to finish returning zero
 RUN: %t.exe %t.so.instrumented 1 2 | FileCheck %s -check-prefix=CHECK-OUTPUT
 RUN: test -f %t.so.fdata
 
 # Test that the instrumented data makes sense
 RUN: llvm-bolt %t.so -o %t.so.bolted -data %t.so.fdata \
-RUN:    -reorder-blocks=cache+ -reorder-functions=hfsort+
+RUN:    -reorder-blocks=ext-tsp -reorder-functions=hfsort+
 
 RUN: %t.exe %t.so.bolted 1 2 | FileCheck %s -check-prefix=CHECK-OUTPUT
 
 CHECK-OUTPUT: fib(4) = 3
 */

bolt/test/runtime/X86/tail-duplication-constant-prop.s

 # REQUIRES: system-linux
 
 # RUN: llvm-mc -filetype=obj -triple x86_64-unknown-unknown \
 # RUN:   %s -o %t.o
 # RUN: link_fdata %s %t.o %t.fdata
 # RUN: %clang %cflags %t.o -o %t.exe -Wl,-q
-# RUN: llvm-bolt %t.exe -data %t.fdata -reorder-blocks=cache+ -print-finalized \
+# RUN: llvm-bolt %t.exe -data %t.fdata -reorder-blocks=ext-tsp -print-finalized \
 # RUN:    -tail-duplication -tail-duplication-minimum-offset 1 -o %t.out | FileCheck %s
 # RUN: %t.exe; echo $?
 # RUN: %t.out; echo $?
 
 # FDATA: 1 main 14 1 main #.BB2# 0 10
 # FDATA: 1 main 16 1 main #.BB2# 0 20
 # CHECK: tail duplication possible duplications: 1
 # CHECK: BB Layout   : .LBB00, .Ltail-dup0, .Ltmp0, .Ltmp1

bolt/test/runtime/meta-merge-fdata.test

 
 # Check unmapped calls coverage - libc should be calling _start via
 # uninstrumented code
 RUN: cat %t.fdata1 | FileCheck %s --check-prefix=CHECK-FDATA
 CHECK-FDATA: 0 [unknown] 0 1 _start 0 0 1
 
 # Check that BOLT works with this profile
 RUN: llvm-bolt merge-fdata -o %t.bolt -data %t.fdata1 \
-RUN:   -reorder-blocks=cache+ -reorder-functions=hfsort+ -split-functions=3 | \
+RUN:   -reorder-blocks=ext-tsp -reorder-functions=hfsort+ -split-functions=3 | \
 RUN:   FileCheck %s --check-prefix=CHECK-BOLT1
 CHECK-BOLT1-NOT: invalid (possibly stale) profile
 
 # Execute again
 RUN: %t.inst --help
 RUN: mv %t.fdata %t.fdata2
 
 # Check profile coverage
 RUN: llvm-boltdiff merge-fdata merge-fdata \
 RUN:   -data %t.fdata1 -data2 %t.fdata2 -display-count=20 | \
 RUN:   FileCheck %s --check-prefix=CHECK-BOLTDIFF
 CHECK-BOLTDIFF: Inputs share [[#]] functions
 
 # Check that instrumented binary produces the same result
 RUN: merge-fdata %t.fdata1 %t.fdata2 > %t.fdata.base
 RUN: %t.inst %t.fdata1 %t.fdata2 > %t.fdata.inst
 RUN: cmp %t.fdata.base %t.fdata.inst
 
 # Optimize using merged fdata
 RUN: llvm-bolt merge-fdata -o %t.opt -data %t.fdata.base \
-RUN:   -reorder-blocks=cache+ -reorder-functions=hfsort+ -split-functions=3 | \
+RUN:   -reorder-blocks=ext-tsp -reorder-functions=hfsort+ -split-functions=3 | \
 RUN:   FileCheck %s --check-prefix=CHECK-BOLT2
 CHECK-BOLT2-NOT: invalid (possibly stale) profile
 
 # Check that optimized binary produces the same result
 RUN: %t.opt %t.fdata1 %t.fdata2 > %t.fdata.opt
 RUN: cmp %t.fdata.base %t.fdata.opt