SANCOV(1)

πŸ“¦ version 12.0.1, in ubuntu jammy

🌸 NAME 🌸

sancov β€” manual page for sancov 12. yeah bestie, that's the whole name section, it's giving minimal. this is the man page for the Sanitizer Coverage Processing Tool, and it's sancov(1) if you're being formal about it πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

✨ OVERVIEW: Sanitizer Coverage Processing Tool (sancov) ✨

okay so picture this: sancov is your little coverage goblin 🧚 and what it does is extract various coverage-related information from a whole bunch of places:

  • coverage-instrumented binary files
  • raw .sancov files
  • and their symbolized .symcov version

and here's the tea β€” depending on which action you pick, the tool expects different input files, so pls don't just throw everything at it and hope πŸ™ˆ

  • -print-coverage-pcs β€” this one wants coverage-instrumented binary files
  • -print-coverage β€” this one wants .sancov files
  • <other actions> β€” these want .sancov files & corresponding binary files, plus .symcov files

⭐ USAGE ⭐

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

πŸŽ€ OPTIONS πŸŽ€

🌈 Color Options 🌈

  • --color β€” use colors in the output (default=autodetect). she's automatic about it, she just knows πŸ’…

πŸ’– General options πŸ’–

okay this next part is LONG, like, scroll-for-days long, but every single one of these is real and we're going through all of them, no skipping, we're not cowards:

  • --aarch64-neon-syntax=<value> β€” choose which style of NEON code to emit from the AArch64 backend:
    • =generic β€” emit generic NEON assembly
    • =apple β€” emit Apple-style NEON assembly
  • --abort-on-max-devirt-iterations-reached β€” abort when the max iterations for the devirtualization CGSCC repeat pass is reached
  • --amdgpu-bypass-slow-div β€” skip the 64-bit divide for dynamic 32-bit values
  • --amdgpu-disable-loop-alignment β€” do not align and prefetch loops
  • --amdgpu-disable-power-sched β€” disable scheduling to minimize mAI power bursts
  • --amdgpu-dpp-combine β€” enable DPP combiner
  • --amdgpu-dump-hsa-metadata β€” dump AMDGPU HSA Metadata
  • --amdgpu-enable-flat-scratch β€” use flat scratch instructions
  • --amdgpu-enable-merge-m0 β€” merge and hoist M0 initializations
  • --amdgpu-promote-alloca-to-vector-limit=<uint> β€” maximum byte size to consider promote alloca to vector
  • --amdgpu-reserve-vgpr-for-sgpr-spill β€” allocates one VGPR for future SGPR Spill
  • --amdgpu-sdwa-peephole β€” enable SDWA peepholer
  • --amdgpu-use-aa-in-codegen β€” enable the use of AA during codegen.
  • --amdgpu-verify-hsa-metadata β€” verify AMDGPU HSA Metadata
  • --amdgpu-vgpr-index-mode β€” use GPR indexing mode instead of movrel for vector indexing
  • --arm-add-build-attributes β€” (no description, she's mysterious, she contains multitudes 🫢)
  • --arm-implicit-it=<value> β€” allow conditional instructions outdside of an IT block (yes, that typo is canon, we keep it exactly as it is):
    • =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
  • --atomic-first-counter β€” use atomic fetch add for the first counter in a function (usually the entry counter)
  • --blacklist=<string> β€” blacklist file (sanitizer blacklist format).
  • --bounds-checking-single-trap β€” use one trap block per function
  • --cfg-hide-deoptimize-paths β€” (again, no description, we respect her privacy 😌)
  • --cfg-hide-unreachable-paths β€” (same, no description given)
  • --cost-kind=<value> β€” target cost kind:
    • =throughput β€” reciprocal throughput
    • =latency β€” instruction latency
    • =code-size β€” code size
    • =size-latency β€” code size and latency

πŸ‘‘ Action (required) πŸ‘‘

bestie this bit is required, like, do not skip it, the vibe check will fail:

  • --print β€” print coverage addresses
  • --print-coverage-pcs β€” print coverage instrumentation points addresses.
  • --covered-functions β€” print all covered funcions. (spelling preserved, iconic, no notes)
  • --not-covered-functions β€” print all not covered funcions.
  • --print-coverage-stats β€” print coverage statistics.
  • --html-report β€” REMOVED. use -symbolize & coverage-report-server.py. she's gone girl, she left the chat πŸ’€
  • --symbolize β€” produces a symbolized JSON report from binary report.
  • --merge β€” merges reports.
  • --cvp-dont-add-nowrap-flags β€” (no description listed, lowkey a mystery πŸ•΅οΈ)
  • --debugify-level=<value> β€” kind of debug info to add:
    • =locations β€” locations only
    • =location+variables β€” locations and variables
  • --debugify-quiet β€” suppress verbose debugify output
  • --demangle β€” print demangled function name.
  • --disable-promote-alloca-to-lds β€” disable promote alloca to LDS
  • --disable-promote-alloca-to-vector β€” disable promote alloca to vector
  • --do-counter-promotion β€” do counter register promotion
  • --dot-cfg-mssa=<file name for generated dot file> β€” file name for generated dot file
  • --emscripten-cxx-exceptions-allowed=<string> β€” the list of function names in which Emscripten-style exception handling is enabled (see emscripten EMSCRIPTEN_CATCHING_ALLOWED options)
  • --enable-cse-in-irtranslator β€” should enable CSE in irtranslator
  • --enable-cse-in-legalizer β€” should enable CSE in Legalizer
  • --enable-emscripten-cxx-exceptions β€” WebAssembly Emscripten-style exception handling
  • --enable-emscripten-sjlj β€” WebAssembly Emscripten-style setjmp/longjmp handling
  • --enable-gvn-hoist β€” enable the GVN hoisting pass (default = off)
  • --enable-gvn-memdep β€” (no description given, we simply don't know her like that πŸ™ˆ)
  • --enable-gvn-sink β€” enable the GVN sinking pass (default = off)
  • --enable-load-in-loop-pre β€” (no description)
  • --enable-load-pre β€” (no description)
  • --enable-loop-simplifycfg-term-folding β€” (no description)
  • --enable-name-compression β€” enable name/filename string compression
  • --enable-split-backedge-in-load-pre β€” (no description)
  • --gpsize=<uint> β€” Global Pointer Addressing Size. the default size is 8.
  • --hash-based-counter-split β€” rename counter variable of a comdat function based on cfg hash
  • --hot-cold-split β€” enable hot-cold splitting pass
  • --import-all-index β€” import all external functions in index.
  • --instcombine-code-sinking β€” enable code sinking
  • --instcombine-guard-widening-window=<uint> β€” how wide an instruction window to bypass looking for another guard
  • --instcombine-max-iterations=<uint> β€” limit the maximum number of instruction combining iterations
  • --instcombine-max-num-phis=<uint> β€” maximum number phis to handle in intptr/ptrint folding
  • --instcombine-maxarray-size=<uint> β€” maximum array size considered when doing a combine
  • --instcombine-negator-enabled β€” should we attempt to sink negations?
  • --instcombine-negator-max-depth=<uint> β€” what is the maximal lookup depth when trying to check for viability of negation sinking.
  • --instcombine-unsafe-select-transform β€” enable poison-unsafe select to and/or transform
  • --instrprof-atomic-counter-update-all β€” make all profile counter updates atomic (for testing only)
  • --internalize-public-api-file=<filename> β€” a file containing list of symbol names to preserve
  • --internalize-public-api-list=<list> β€” a list of symbol names to preserve
  • --iterative-counter-promotion β€” allow counter promotion across the whole loop nest.
  • --lto-embed-bitcode=<value> β€” embed LLVM bitcode in object files produced by LTO:
    • =none β€” do not embed
    • =optimized β€” embed after all optimization passes
    • =post-merge-pre-opt β€” embed post merge, but before optimizations
  • --lto-pass-remarks-filter=<regex> β€” only record optimization remarks from passes whose names match the given regular expression
  • --lto-pass-remarks-format=<format> β€” the format used for serializing remarks (default: YAML)
  • --lto-pass-remarks-output=<filename> β€” output filename for pass remarks
  • --matrix-default-layout=<value> β€” sets the default matrix layout:
    • =column-major β€” use column-major layout
    • =row-major β€” use row-major layout
  • --max-counter-promotions=<int> β€” max number of allowed counter promotions
  • --max-counter-promotions-per-loop=<uint> β€” max number counter promotions per loop to avoid increasing register pressure too much
  • --merror-missing-parenthesis β€” error for missing parenthesis around predicate registers
  • --merror-noncontigious-register β€” error for register names that aren't contigious (again, spelling is canon, hands off βœ‹)
  • --mhvx β€” enable Hexagon Vector eXtensions
  • --mhvx=<value> β€” enable Hexagon Vector eXtensions:
    • =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.
    • =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.
  • --mips16-hard-float β€” enable mips16 hard float.
  • --mir-strip-debugify-only β€” tells mir-strip-debug to only strip debug info from modules that got debugified, by default. iykyk πŸ’…
  • --mno-compound β€” Hexagon stans, this one says stop looking for compound instructions.
  • --mno-fixup β€” also Hexagon: turn off the fixing-up of resolved relocations.
  • --mno-ldc1-sdc1 β€” expand double-precision loads and stores into their single-precision counterparts. glow-down but do it 🫢
  • --mno-pairing β€” Hexagon again bestie: don't go looking for duplex instructions.
  • --mwarn-missing-parenthesis β€” yell at you (a warning, not a crash) when parenthesis is missing around predicate registers.
  • --mwarn-noncontigious-register β€” warn when register names aren't contigious (yes the spelling is giving what it's giving, we don't fix it πŸ’€).
  • --mwarn-sign-mismatch β€” warn when a signed and an unsigned value don't match up.
  • --no-discriminators β€” turn off generation of discriminator information.
  • --nvptx-sched4reg β€” NVPTX Specific: schedule for register pressue. yes, pressue. iconic typo, no notes 🌸
  • --poison-checking-function-local β€” check that returns are non-poison (for testing, bestie, not for production).
  • --r600-ir-structurize β€” use the StructurizeCFG IR pass.
  • --rdf-dump β€” no description given. the manpage is gatekeeping πŸ™ˆ
  • --rdf-limit=<uint> β€” also no description. mysterious behavior, we respect it.
  • --runtime-counter-relocation β€” enable relocating counters at runtime.
  • --safepoint-ir-verifier-print-only β€” no description. it's giving mystery ✨
  • --sample-profile-check-record-coverage=<N> β€” emit a warning if less than N% of records in the input profile actually matched up with the IR.
  • --sample-profile-check-sample-coverage=<N> β€” emit a warning if less than N% of samples in the input profile matched up with 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. they're dead, let them rest πŸͺ¦
  • --skip-ret-exit-block β€” suppress counter promotion if exit blocks contain ret.
  • --speculative-counter-promotion-max-exiting=<uint> β€” the max number of exiting blocks of a loop you'll allow speculative counter promotion for.
  • --speculative-counter-promotion-to-loop β€” when this option is false, if the target block is in a loop, the promotion gets disallowed unless the promoted counter update can be further/iteratively promoted into an acyclic region.
  • --strip_path_prefix=<string> β€” strip this prefix from file paths in reports.
  • --summary-file=<string> β€” the summary file to use for function importing.
  • --tail-predication=<value> β€” MVE tail-predication pass options:
    • =disabled β€” don't tail-predicate loops at all.
    • =enabled-no-reductions β€” enable tail-predication, but not for reduction loops.
    • =enabled β€” enable tail-predication, reduction loops included.
    • =force-enabled-no-reductions β€” enable tail-predication but not for reduction loops, and force it, which might be unsafe.
    • =force-enabled β€” enable tail-predication including reduction loops, and force it, which might be unsafe.
bestie those force- ones literally say "might be unsafe" in the source. they are not playing. proceed with the awareness πŸ’…
  • --thinlto-assume-merged β€” assume the input already went through ThinLTO function importing and the other pre-optimization pipeline changes.
  • --threads=<int> β€” no description. you know what it does, bestie.
  • --verify-region-info β€” verify region info. it is time consuming, so maybe grab a snack πŸ“
  • --vp-counters-per-site=<number> β€” the average number of profile counters allocated per value profiling site.
  • --vp-static-alloc β€” do static counter allocation for the value profiler.
  • --x86-align-branch=<string> β€” specify which types of branches to align (it's a 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> β€” control how the assembler should align branches with NOP. if the boundary's size isn't 0, it has to be a power of 2 and no less than 32. branches get aligned so they don't end up across or against the boundary of the specified size. the default value 0 means no branch alignment.
  • --x86-branches-within-32B-boundaries β€” align selected instructions to soften the negative performance impact of Intel's micro code update for errata skx102. heads up: this may break assumptions about labels corresponding to particular instructions, and should be used with caution.
  • --x86-pad-max-prefix-size=<uint> β€” maximum number of prefixes to use for padding.

✨ Generic Options ✨

  • --help β€” display available options (--help-hidden for more). the moment you need it fr fr 🫢
  • --help-list β€” display a list of available options (--help-list-hidden for more).
  • --version β€” display the version of this program.

πŸ¦‹ Polly Options πŸ¦‹

Configure the polly loop optimizer πŸ’…

  • --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 extra 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 in lifetime analysis; 0 = no limit.
  • --polly-detect-full-functions β€” allow the detection of full functions.
  • --polly-dump-after β€” dump the module after Polly transformations into a file suffixed with "-after".
  • --polly-dump-after-file=<string> β€” dump the module after Polly transformations to the given file.
  • --polly-dump-before β€” dump the module before Polly transformations into a file suffixed with "-before".
  • --polly-dump-before-file=<string> β€” dump the 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 you provide.
  • --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 you provide.
  • --polly-only-region=<identifier> β€” only run on certain regions (the identifier you provide must appear in the name of the region's entry block).
  • --polly-only-scop-detection β€” only run scop detection, no other optimizations.
  • --polly-optimized-scops β€” Polly β€” dump the 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

and that's the whole thing, bestie πŸŽ€ you made it to the end of sancov and honestly? main character energy πŸ‘‘

this was sancov version 12, dated February 2022, filed under SANCOV(1) β€” go forth and slay your coverage reports fr fr πŸ’–βœ¨πŸŒˆ

πŸ“¦ where this page comes from