SANCOV(1)

๐Ÿ“ฆ version 11.1.0, in ubuntu jammy

๐Ÿ’– NAME ๐Ÿ’–

sancov โ€” manual page for sancov 11


๐Ÿฆ‹ DESCRIPTION ๐Ÿฆ‹

OVERVIEW: Sanitizer Coverage Processing Tool (sancov)

okay so bestie, this tool is literally the main character for extracting coverage-related info from: coverage-instrumented binary files, raw .sancov files and their symbolized .symcov version. Depending on chosen action the tool expects different input files:

  • -print-coverage-pcs โ€” coverage-instrumented binary files
  • -print-coverage โ€” .sancov files
  • <other actions> โ€” .sancov files & corresponding binary files, .symcov files

USAGE:

sancov [options] <action> <binary files...> <.sancov files...> <.symcov files...>

๐Ÿ’… OPTIONS ๐Ÿ’…

๐ŸŽจ Color Options ๐ŸŽจ

  • --color โ€” Use colors in output (default=autodetect). yes bestie, make it pop ๐Ÿ’–

๐ŸŒˆ General options ๐ŸŒˆ

  • --aarch64-neon-syntax=<value> โ€” Choose style of NEON code to emit from AArch64 backend:
    • =generic โ€” Emit generic NEON assembly
    • =apple โ€” Emit Apple-style NEON assembly
  • --amdgpu-bypass-slow-div โ€” skip the 64-bit divide for dynamic 32-bit values, bestie, it's giving speed ๐Ÿ’…
  • --amdgpu-disable-loop-alignment โ€” do not align and prefetch loops, periodt
  • --amdgpu-disable-power-sched โ€” disable scheduling to minimize mAI power bursts, no cap
  • --amdgpu-dpp-combine โ€” enable DPP combiner, slay โœจ
  • --amdgpu-dump-hsa-metadata โ€” dump AMDGPU HSA Metadata, iconic
  • --amdgpu-enable-global-sgpr-addr โ€” enable use of SGPR regs for GLOBAL LOAD/STORE instructions, fr fr
  • --amdgpu-enable-merge-m0 โ€” merge and hoist M0 initializations, lowkey useful
  • --amdgpu-promote-alloca-to-vector-limit=<uint> โ€” maximum byte size to consider promote alloca to vector, iykyk
  • --amdgpu-reserve-vgpr-for-sgpr-spill โ€” allocates one VGPR for future SGPR Spill, bestie
  • --amdgpu-sdwa-peephole โ€” enable SDWA peepholer, periodt
  • --amdgpu-verify-hsa-metadata โ€” verify AMDGPU HSA Metadata, no cap
  • --amdgpu-vgpr-index-mode โ€” use GPR indexing mode instead of movrel for vector indexing, it's giving efficiency
  • --arm-add-build-attributes โ€” (no description, just vibes ๐Ÿ’…)
  • --arm-implicit-it=<value> โ€” allow conditional instructions outdside of an IT block, bestie
    • =always โ€” accept in both ISAs, emit implicit ITs in Thumb
    • =never โ€” warn in ARM, reject in Thumb
    • =arm โ€” accept in ARM, reject in Thumb
    • =thumb โ€” warn in ARM, emit implicit ITs in Thumb
  • --atomic-counter-update-promoted โ€” do counter update using atomic fetch add for promoted counters only, fr fr
  • --atomic-first-counter โ€” use atomic fetch add for first counter in a function (usually the entry counter), slay
  • --blacklist=<string> โ€” blacklist file (sanitizer blacklist format). periodt
  • --bounds-checking-single-trap โ€” use one trap block per function, no cap
  • --cfg-hide-deoptimize-paths โ€” (no description, bestie, it's giving mystery โœจ)
  • --cfg-hide-unreachable-paths โ€” (no description, just vibes ๐Ÿ’…)
  • --cost-kind=<value> โ€” target cost kind, iykyk
    • =throughput โ€” reciprocal throughput
    • =latency โ€” instruction latency
    • =code-size โ€” code size

๐ŸŽฌ Action (required) ๐ŸŽฌ

bestie, you literally have to pick one action, no cap.
  • --print โ€” print coverage addresses, bestie
  • --print-coverage-pcs โ€” print coverage instrumentation points addresses. periodt
  • --covered-functions โ€” print all covered funcions. (yes, funcions, we said what we said) ๐Ÿ˜ญ
  • --not-covered-functions โ€” print all not covered funcions. same energy ๐Ÿ’€
  • --print-coverage-stats โ€” print coverage statistics. iconic
  • --html-report โ€” REMOVED. Use -symbolize & coverage-report-server.py. it's gone, bestie ๐Ÿซถ
  • --symbolize โ€” produces a symbolized JSON report from binary report. slay
  • --merge โ€” merges reports. no cap
  • --cvp-dont-add-nowrap-flags โ€” (no description, it's giving enigma ๐Ÿซถ)
  • --debugify-level=<value> โ€” kind of debug info to add, bestie
    • =locations โ€” locations only
    • =location+variables โ€” locations and Variables
  • --debugify-quiet โ€” suppress verbose debugify output, periodt
  • --demangle โ€” print demangled function name. fr fr
  • --disable-promote-alloca-to-lds โ€” disable promote alloca to LDS, no cap
  • --disable-promote-alloca-to-vector โ€” disable promote alloca to vector, slay
  • --do-counter-promotion โ€” do counter register promotion, iconic
  • --emscripten-cxx-exceptions-allowed=<string> โ€” the list of function names in which Emscripten-style exception handling is enabled (see emscripten EMSCRIPTEN_CATCHING_ALLOWED options), iykyk
  • --enable-cse-in-irtranslator โ€” should enable CSE in irtranslator, bestie
  • --enable-cse-in-legalizer โ€” should enable CSE in Legalizer, periodt
  • --enable-emscripten-cxx-exceptions โ€” WebAssembly Emscripten-style exception handling, no cap
  • --enable-emscripten-sjlj โ€” WebAssembly Emscripten-style setjmp/longjmp handling, slay
  • --enable-gvn-hoist โ€” enable the GVN hoisting pass (default = off), iconic
  • --enable-gvn-memdep โ€” (no description, just vibes ๐Ÿ’…)
  • --enable-gvn-sink โ€” enable the GVN sinking pass (default = off), fr fr
  • --enable-load-in-loop-pre โ€” (no description, bestie, it's giving mystery โœจ)
  • --enable-load-pre โ€” (no description, just vibes ๐Ÿ’…)
  • --enable-loop-simplifycfg-term-folding โ€” (no description, it's giving enigma ๐Ÿซถ)
  • --enable-name-compression โ€” enable name/filename string compression, periodt
  • --gpsize=<uint> โ€” Global Pointer Addressing Size. The default size is 8. no cap
  • --hash-based-counter-split โ€” rename counter variable of a comdat function based on cfg hash, bestie
  • --hot-cold-split โ€” enable hot-cold splitting pass, slay
  • --import-all-index โ€” import all external functions in index. iconic
  • --instcombine-code-sinking โ€” enable code sinking, fr fr
  • --instcombine-guard-widening-window=<uint> โ€” how wide an instruction window to bypass looking for another guard, iykyk
  • --instcombine-max-iterations=<uint> โ€” limit the maximum number of instruction combining iterations, no cap
  • --instcombine-max-num-phis=<uint> โ€” maximum number phis to handle in intptr/ptrint folding, periodt
  • --instcombine-maxarray-size=<uint> โ€” maximum array size considered when doing a combine, bestie
  • --instcombine-negator-enabled โ€” should we attempt to sink negations? slay
  • --instcombine-negator-max-depth=<uint> โ€” what is the maximal lookup depth when trying to check for viability of negation sinking. iconic
  • --instrprof-atomic-counter-update-all โ€” make all profile counter updates atomic (for testing only), fr fr
  • --internalize-public-api-file=<filename> โ€” a file containing list of symbol names to preserve, no cap
  • --internalize-public-api-list=<list> โ€” a list of symbol names to preserve, periodt
  • --iterative-counter-promotion โ€” allow counter promotion across the whole loop nest. bestie
  • --lto-embed-bitcode โ€” embed LLVM bitcode in object files produced by LTO, slay
  • --lto-pass-remarks-filter=<regex> โ€” only record optimization remarks from passes whose names match the given regular expression, iconic
  • --lto-pass-remarks-format=<format> โ€” the format used for serializing remarks (default: YAML), fr fr
  • --lto-pass-remarks-output=<filename> โ€” output filename for pass remarks, no cap
  • --matrix-default-layout=<value> โ€” sets the default matrix layout, periodt
    • =column-major โ€” use column-major layout
    • =row-major โ€” use row-major layout
  • --max-counter-promotions=<int> โ€” max number of allowed counter promotions, bestie
  • --max-counter-promotions-per-loop=<uint> โ€” max number counter promotions per loop to avoid increasing register pressure too much, slay
  • --memop-size-large=<uint> โ€” set large value thresthold in memory intrinsic size profiling. Value of 0 disables the large value profiling. iconic
  • --memop-size-range=<string> โ€” set the range of size in memory intrinsic calls to be profiled precisely, in a format of <start_val>:<end_val>, fr fr
  • --merror-missing-parenthesis โ€” error for missing parenthesis around predicate registers, no cap
  • --merror-noncontigious-register โ€” error for register names that aren't contigious, periodt
  • --mhvx โ€” enable Hexagon Vector eXtensions, bestie
  • --mhvx=<value> โ€” enable Hexagon Vector eXtensions, slay
    • =v60 โ€” build for HVX v60
    • =v62 โ€” build for HVX v62
    • =v65 โ€” build for HVX v65
    • =v66 โ€” build for HVX v66
    • =v67 โ€” build for HVX v67
  • --mips-compact-branches=<value> โ€” MIPS Specific: Compact branch policy. iconic
    • =never โ€” do not use compact branches if possible.
    • =optimal โ€” use compact branches where appropriate (default).
    • =always โ€” always use compact branches if possible.
  • --mips16-constant-islands โ€” enable mips16 constant islands. fr fr
  • --mips16-hard-float โ€” enable mips16 hard float. no cap
  • --mir-strip-debugify-only โ€” should mir-strip-debug only strip debug info from debugified modules by default, periodt
  • --mno-compound โ€” disable looking for compound instructions for Hexagon, bestie
  • --mno-fixup โ€” disable fixing up resolved relocations for Hexagon, slay
  • --mno-ldc1-sdc1 โ€” bestie it EXPANDS those double precision loads and stores into their single precision counterparts ๐Ÿ’… no more double, we go small
  • --mno-pairing โ€” turns OFF the search for duplex instructions, Hexagon edition ๐Ÿฆ‹
  • --mwarn-missing-parenthesis โ€” yells at you when parenthesis is missing around predicate registers ๐Ÿ˜ญ
  • --mwarn-noncontigious-register โ€” warns when register names aren't contigious (yes, spelled exactly like that, iconic behavior, we keep it) โœจ
  • --mwarn-sign-mismatch โ€” warns when a signed and unsigned value are mismatched, lowkey a vibe check for your types ๐Ÿ’€
  • --no-discriminators โ€” disables generation of discriminator information, periodt ๐ŸŽ€
  • --nvptx-sched4reg โ€” NVPTX Specific: schedules for register pressue (again, the typo is the original, we do not fix, we respect) ๐Ÿ‘‘
  • --poison-checking-function-local โ€” checks that returns are non-poison, and it's literally for testing ๐Ÿงช
  • --r600-ir-structurize โ€” uses the StructurizeCFG IR pass ๐ŸŒˆ
  • --rdf-dump โ€” no description given, she's mysterious, she's giving main character with no lore ๐Ÿ™ˆ
  • --rdf-limit=<uint> โ€” also no description, equally cryptic, we love an enigma ๐Ÿ’œ
  • --runtime-counter-relocation โ€” enables relocating counters at runtime ๐Ÿ”ฅ
  • --safepoint-ir-verifier-print-only โ€” no description, just vibes ๐ŸŒธ
  • --sample-profile-check-record-coverage=<N> โ€” emits a warning if less than N% of records in the input profile are matched to the IR ๐Ÿ“Š
  • --sample-profile-check-sample-coverage=<N> โ€” emits a warning if less than N% of samples in the input profile are matched to the IR ๐Ÿ“Š
  • --sample-profile-max-propagate-iterations=<uint> โ€” the maximum number of iterations to go through when propagating sample block/edge weights through the CFG ๐Ÿ”
  • --skip-dead-files โ€” do NOT list dead source files in reports, she's ghosting them fr fr ๐Ÿ‘ป
  • --speculative-counter-promotion-max-exiting=<uint> โ€” the max number of exiting blocks of a loop to allow speculative counter promotion ๐Ÿšช
  • --speculative-counter-promotion-to-loop โ€” when this option is false, if the target block is in a loop, the promotion will be disallowed unless the promoted counter update can be further/iteratively promoted into an acyclic region ๐Ÿ”„
  • --strip_path_prefix=<string> โ€” strips this prefix from file paths in reports โœ‚๏ธ
  • --summary-file=<string> โ€” the summary file to use for function importing ๐Ÿ“
  • --tail-predication=<value> โ€” MVE tail-predication options, and she has LAYERS bestie:
    • =disabled โ€” Don't tail-predicate loops
    • =enabled-no-reductions โ€” Enable tail-predication, but not for reduction loops
    • =enabled โ€” Enable tail-predication, including reduction loops
    • =force-enabled-no-reductions โ€” Enable tail-predication, but not for reduction loops, and force this which might be unsafe
    • =force-enabled โ€” Enable tail-predication, including reduction loops, and force this which might be unsafe
the force-enabled ones say might be unsafe right in the name, so likeโ€ฆ she's telling you. read the label bestie ๐Ÿšจ
  • --threads=<int> โ€” no description, another mystery girl ๐Ÿ’…
  • --verify-region-info โ€” verifies region info, and it is time consuming, so budget accordingly โณ
  • --vp-counters-per-site=<number> โ€” the average number of profile counters allocated per value profiling site ๐Ÿ”ข
  • --vp-static-alloc โ€” does static counter allocation for value profiler ๐Ÿงฎ
  • --x86-align-branch=<string> โ€” specifies types of branches to align (plus separated list of types) โœจ:
    • jcc โ€” indicates conditional jumps
    • fused โ€” indicates fused conditional jumps
    • jmp โ€” indicates direct unconditional jumps
    • call โ€” indicates direct and indirect calls
    • ret โ€” indicates rets
    • indirect โ€” indicates indirect unconditional jumps
  • --x86-align-branch-boundary=<uint> โ€” controls how the assembler should align branches with NOP. If the boundary's size is not 0, it should be a power of 2 and no less than 32. Branches will be aligned to prevent from being across or against the boundary of specified size. The default value 0 does not align branches ๐Ÿ“
  • --x86-branches-within-32B-boundaries โ€” aligns selected instructions to mitigate negative performance impact of Intel's micro code update for errata skx102 ๐Ÿ’€
May break assumptions about labels corresponding to particular instructions, and should be used with caution. so like, respectfully, be careful ๐Ÿซถ
  • --x86-pad-max-prefix-size=<uint> โ€” maximum number of prefixes to use for padding ๐Ÿงท

๐Ÿซถ Generic Options: ๐Ÿซถ

the universal girlies, every program has them, and honestly? we're obsessed

  • --help โ€” display available options (--help-hidden for more) ๐ŸŒŸ
  • --help-list โ€” display list of available options (--help-list-hidden for more) ๐Ÿ“œ
  • --version โ€” display the version of this program ๐Ÿท๏ธ

๐ŸŽ€ Polly Options: Configure the polly loop optimizer ๐ŸŽ€

she's the loop optimizer and she is SO iconic for it

  • --polly โ€” enable the polly optimizer (only at -O3) ๐Ÿ”ฅ
  • --polly-2nd-level-tiling โ€” enable a 2nd level loop of loop tiling ๐Ÿงฑ
  • --polly-ast-print-accesses โ€” print memory access functions ๐Ÿ‘€
  • --polly-context=<isl parameter set> โ€” provide additional constraints on the context parameters ๐ŸŽฏ
  • --polly-dce-precise-steps=<int> โ€” the number of precise steps between two approximating iterations. (A value of -1 schedules another approximation stage before the actual dead code elimination. ๐Ÿ’€
  • --polly-delicm-max-ops=<int> โ€” maximum number of isl operations to invest for lifetime analysis; 0=no limit โ™พ๏ธ
  • --polly-detect-full-functions โ€” allow the detection of full functions ๐Ÿ•ต๏ธ
  • --polly-dump-after โ€” dump module after Polly transformations into a file suffixed with "-after" ๐Ÿ“ค
  • --polly-dump-after-file=<string> โ€” dump module after Polly transformations to the given file ๐Ÿ“
  • --polly-dump-before โ€” dump module before Polly transformations into a file suffixed with "-before" ๐Ÿ“ฅ
  • --polly-dump-before-file=<string> โ€” dump module before Polly transformations to the given file ๐Ÿ“
  • --polly-enable-simplify โ€” simplify SCoP after optimizations โœจ
  • --polly-ignore-func=<string> โ€” ignore functions that match a regex. Multiple regexes can be comma separated. Scop detection will ignore all functions that match ANY of the regexes provided. ๐Ÿšซ
  • --polly-isl-arg=<argument> โ€” option passed to ISL ๐ŸŽ
  • --polly-on-isl-error-abort โ€” abort if an isl error is encountered ๐Ÿ›‘
  • --polly-only-func=<string> โ€” only run on functions that match a regex. Multiple regexes can be comma separated. Scop detection will run on all functions that match ANY of the regexes provided. ๐ŸŽฏ
  • --polly-only-region=<identifier> โ€” only run on certain regions (The provided identifier must appear in the name of the region's entry block ๐Ÿ“
  • --polly-only-scop-detection โ€” only run scop detection, but no other optimizations ๐Ÿ”
  • --polly-optimized-scops โ€” Polly - Dump polyhedral description of Scops optimized with the isl scheduling optimizer and the set of post-scheduling transformations is applied on the schedule tree ๐ŸŒณ
  • --polly-parallel โ€” generate thread parallel code (isl codegen only) ๐Ÿงต
  • --polly-parallel-force โ€” force generation of thread parallel code ignoring any cost model ๐Ÿ’ช
  • --polly-pattern-matching-based-opts โ€” perform optimizations based on pattern matching ๐Ÿงฉ
  • --polly-process-unprofitable โ€” process scops that are unlikely to benefit from Polly optimizations. ๐Ÿคท
  • --polly-register-tiling โ€” enable register tiling ๐Ÿงฑ
  • --polly-report โ€” print information about the activities of Polly ๐Ÿ“‹
  • --polly-show โ€” highlight the code regions that will be optimized in a (CFG BBs and LLVM-IR instructions) ๐ŸŒˆ
  • --polly-show-only โ€” highlight the code regions that will be optimized in a (CFG only BBs) ๐ŸŽจ
  • --polly-stmt-granularity=<value> โ€” algorithm to use for splitting basic blocks into multiple statements โœ‚๏ธ
    • =bb โ€” One statement per basic block
    • =scalar-indep โ€” Scalar independence heuristic
    • =store โ€” Store-level granularity
  • --polly-target=<value> โ€” the hardware to target ๐Ÿ–ฅ๏ธ
    • =cpu โ€” generate CPU code
  • --polly-tiling โ€” enable loop tiling ๐Ÿงฑ
  • --polly-vectorizer=<value> โ€” select the vectorization strategy ๐ŸŽ›๏ธ
    • =none โ€” No Vectorization
    • =polly โ€” Polly internal vectorizer
    • =stripmine โ€” Strip-mine outer loops for the loop-vectorizer to trigger

okay bestie that's the whole page ๐Ÿ’– you read the entire thing, that's genuinely so impressive, i'm proud of you fr. this was sancov version 11, dated January 2022 โ€” and if you ever need her again she's right there in the SANCOV(1) manual. go forth and slay ๐Ÿซถโœจ

๐Ÿ“ฆ where this page comes from