forked from rust-lang/rust
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rollup merge of rust-lang#132452 - Zalathar:llvm-cov-wrappers, r=jiey…
…ouxu coverage: Extract safe FFI wrapper functions to `llvm_cov` This PR takes all of the inline `unsafe` calls in coverage codegen, and all the safe wrapper functions in `coverageinfo/mod.rs`, and moves them to a new `llvm_cov` submodule that is dedicated to safe FFI wrapper functions. This reduces the mixing of abstraction levels in the rest of coverage codegen. As a follow-up, this PR also tidies up the names and signatures of several of the coverage FFI functions.
- Loading branch information
Showing
5 changed files
with
170 additions
and
164 deletions.
There are no files selected for viewing
100 changes: 100 additions & 0 deletions
100
compiler/rustc_codegen_llvm/src/coverageinfo/llvm_cov.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| //! Safe wrappers for coverage-specific FFI functions. | ||
| use std::ffi::CString; | ||
|
|
||
| use crate::common::AsCCharPtr; | ||
| use crate::coverageinfo::ffi; | ||
| use crate::llvm; | ||
|
|
||
| pub(crate) fn covmap_var_name() -> CString { | ||
| CString::new(llvm::build_byte_buffer(|s| unsafe { | ||
| llvm::LLVMRustCoverageWriteCovmapVarNameToString(s); | ||
| })) | ||
| .expect("covmap variable name should not contain NUL") | ||
| } | ||
|
|
||
| pub(crate) fn covmap_section_name(llmod: &llvm::Module) -> CString { | ||
| CString::new(llvm::build_byte_buffer(|s| unsafe { | ||
| llvm::LLVMRustCoverageWriteCovmapSectionNameToString(llmod, s); | ||
| })) | ||
| .expect("covmap section name should not contain NUL") | ||
| } | ||
|
|
||
| pub(crate) fn covfun_section_name(llmod: &llvm::Module) -> CString { | ||
| CString::new(llvm::build_byte_buffer(|s| unsafe { | ||
| llvm::LLVMRustCoverageWriteCovfunSectionNameToString(llmod, s); | ||
| })) | ||
| .expect("covfun section name should not contain NUL") | ||
| } | ||
|
|
||
| pub(crate) fn create_pgo_func_name_var<'ll>( | ||
| llfn: &'ll llvm::Value, | ||
| mangled_fn_name: &str, | ||
| ) -> &'ll llvm::Value { | ||
| unsafe { | ||
| llvm::LLVMRustCoverageCreatePGOFuncNameVar( | ||
| llfn, | ||
| mangled_fn_name.as_c_char_ptr(), | ||
| mangled_fn_name.len(), | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| pub(crate) fn write_filenames_to_buffer<'a>( | ||
| filenames: impl IntoIterator<Item = &'a str>, | ||
| ) -> Vec<u8> { | ||
| let (pointers, lengths) = filenames | ||
| .into_iter() | ||
| .map(|s: &str| (s.as_c_char_ptr(), s.len())) | ||
| .unzip::<_, _, Vec<_>, Vec<_>>(); | ||
|
|
||
| llvm::build_byte_buffer(|buffer| unsafe { | ||
| llvm::LLVMRustCoverageWriteFilenamesToBuffer( | ||
| pointers.as_ptr(), | ||
| pointers.len(), | ||
| lengths.as_ptr(), | ||
| lengths.len(), | ||
| buffer, | ||
| ); | ||
| }) | ||
| } | ||
|
|
||
| pub(crate) fn write_function_mappings_to_buffer( | ||
| virtual_file_mapping: &[u32], | ||
| expressions: &[ffi::CounterExpression], | ||
| code_regions: &[ffi::CodeRegion], | ||
| branch_regions: &[ffi::BranchRegion], | ||
| mcdc_branch_regions: &[ffi::MCDCBranchRegion], | ||
| mcdc_decision_regions: &[ffi::MCDCDecisionRegion], | ||
| ) -> Vec<u8> { | ||
| llvm::build_byte_buffer(|buffer| unsafe { | ||
| llvm::LLVMRustCoverageWriteFunctionMappingsToBuffer( | ||
| virtual_file_mapping.as_ptr(), | ||
| virtual_file_mapping.len(), | ||
| expressions.as_ptr(), | ||
| expressions.len(), | ||
| code_regions.as_ptr(), | ||
| code_regions.len(), | ||
| branch_regions.as_ptr(), | ||
| branch_regions.len(), | ||
| mcdc_branch_regions.as_ptr(), | ||
| mcdc_branch_regions.len(), | ||
| mcdc_decision_regions.as_ptr(), | ||
| mcdc_decision_regions.len(), | ||
| buffer, | ||
| ) | ||
| }) | ||
| } | ||
|
|
||
| /// Hashes some bytes into a 64-bit hash, via LLVM's `IndexedInstrProf::ComputeHash`, | ||
| /// as required for parts of the LLVM coverage mapping format. | ||
| pub(crate) fn hash_bytes(bytes: &[u8]) -> u64 { | ||
| unsafe { llvm::LLVMRustCoverageHashBytes(bytes.as_c_char_ptr(), bytes.len()) } | ||
| } | ||
|
|
||
| /// Returns LLVM's `coverage::CovMapVersion::CurrentVersion` (CoverageMapping.h) | ||
| /// as a raw numeric value. For historical reasons, the numeric value is 1 less | ||
| /// than the number in the version's name, so `Version7` is actually `6u32`. | ||
| pub(crate) fn mapping_version() -> u32 { | ||
| unsafe { llvm::LLVMRustCoverageMappingVersion() } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.