Updated links to LLVM 11 docs and types
This commit is contained in:
parent
1d8c381c01
commit
5d5dc4c9d8
@ -15,9 +15,9 @@ use tracing::debug;
|
|||||||
|
|
||||||
/// Generates and exports the Coverage Map.
|
/// Generates and exports the Coverage Map.
|
||||||
///
|
///
|
||||||
/// This Coverage Map complies with Coverage Mapping Format version 3 (zero-based encoded as 2),
|
/// This Coverage Map complies with Coverage Mapping Format version 4 (zero-based encoded as 3),
|
||||||
/// as defined at [LLVM Code Coverage Mapping Format](https://github.com/rust-lang/llvm-project/blob/llvmorg-8.0.0/llvm/docs/CoverageMappingFormat.rst#llvm-code-coverage-mapping-format)
|
/// as defined at [LLVM Code Coverage Mapping Format](https://github.com/rust-lang/llvm-project/blob/rustc/11.0-2020-10-12/llvm/docs/CoverageMappingFormat.rst#llvm-code-coverage-mapping-format)
|
||||||
/// and published in Rust's current (July 2020) fork of LLVM. This version is supported by the
|
/// and published in Rust's current (November 2020) fork of LLVM. This version is supported by the
|
||||||
/// LLVM coverage tools (`llvm-profdata` and `llvm-cov`) bundled with Rust's fork of LLVM.
|
/// LLVM coverage tools (`llvm-profdata` and `llvm-cov`) bundled with Rust's fork of LLVM.
|
||||||
///
|
///
|
||||||
/// Consequently, Rust's bundled version of Clang also generates Coverage Maps compliant with
|
/// Consequently, Rust's bundled version of Clang also generates Coverage Maps compliant with
|
||||||
|
@ -642,7 +642,7 @@ pub type InlineAsmDiagHandler = unsafe extern "C" fn(&SMDiagnostic, *const c_voi
|
|||||||
pub mod coverageinfo {
|
pub mod coverageinfo {
|
||||||
use super::coverage_map;
|
use super::coverage_map;
|
||||||
|
|
||||||
/// Aligns with [llvm::coverage::CounterMappingRegion::RegionKind](https://github.com/rust-lang/llvm-project/blob/rustc/10.0-2020-05-05/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h#L205-L221)
|
/// Aligns with [llvm::coverage::CounterMappingRegion::RegionKind](https://github.com/rust-lang/llvm-project/blob/rustc/11.0-2020-10-12/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h#L206-L222)
|
||||||
#[derive(Copy, Clone, Debug)]
|
#[derive(Copy, Clone, Debug)]
|
||||||
#[repr(C)]
|
#[repr(C)]
|
||||||
pub enum RegionKind {
|
pub enum RegionKind {
|
||||||
@ -665,13 +665,13 @@ pub mod coverageinfo {
|
|||||||
|
|
||||||
/// This struct provides LLVM's representation of a "CoverageMappingRegion", encoded into the
|
/// This struct provides LLVM's representation of a "CoverageMappingRegion", encoded into the
|
||||||
/// coverage map, in accordance with the
|
/// coverage map, in accordance with the
|
||||||
/// [LLVM Code Coverage Mapping Format](https://github.com/rust-lang/llvm-project/blob/llvmorg-8.0.0/llvm/docs/CoverageMappingFormat.rst#llvm-code-coverage-mapping-format).
|
/// [LLVM Code Coverage Mapping Format](https://github.com/rust-lang/llvm-project/blob/rustc/11.0-2020-10-12/llvm/docs/CoverageMappingFormat.rst#llvm-code-coverage-mapping-format).
|
||||||
/// The struct composes fields representing the `Counter` type and value(s) (injected counter
|
/// The struct composes fields representing the `Counter` type and value(s) (injected counter
|
||||||
/// ID, or expression type and operands), the source file (an indirect index into a "filenames
|
/// ID, or expression type and operands), the source file (an indirect index into a "filenames
|
||||||
/// array", encoded separately), and source location (start and end positions of the represented
|
/// array", encoded separately), and source location (start and end positions of the represented
|
||||||
/// code region).
|
/// code region).
|
||||||
///
|
///
|
||||||
/// Aligns with [llvm::coverage::CounterMappingRegion](https://github.com/rust-lang/llvm-project/blob/rustc/10.0-2020-05-05/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h#L223-L226)
|
/// Aligns with [llvm::coverage::CounterMappingRegion](https://github.com/rust-lang/llvm-project/blob/rustc/11.0-2020-10-12/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h#L224-L227)
|
||||||
/// Important: The Rust struct layout (order and types of fields) must match its C++
|
/// Important: The Rust struct layout (order and types of fields) must match its C++
|
||||||
/// counterpart.
|
/// counterpart.
|
||||||
#[derive(Copy, Clone, Debug)]
|
#[derive(Copy, Clone, Debug)]
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
use rustc_middle::mir::coverage::{CounterValueReference, MappedExpressionIndex};
|
use rustc_middle::mir::coverage::{CounterValueReference, MappedExpressionIndex};
|
||||||
|
|
||||||
/// Aligns with [llvm::coverage::Counter::CounterKind](https://github.com/rust-lang/llvm-project/blob/rustc/10.0-2020-05-05/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h#L91)
|
/// Aligns with [llvm::coverage::Counter::CounterKind](https://github.com/rust-lang/llvm-project/blob/rustc/11.0-2020-10-12/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h#L206-L222)
|
||||||
#[derive(Copy, Clone, Debug)]
|
#[derive(Copy, Clone, Debug)]
|
||||||
#[repr(C)]
|
#[repr(C)]
|
||||||
pub enum CounterKind {
|
pub enum CounterKind {
|
||||||
@ -17,7 +17,7 @@ pub enum CounterKind {
|
|||||||
/// `instrprof.increment()`)
|
/// `instrprof.increment()`)
|
||||||
/// * For `CounterKind::Expression`, `id` is the index into the coverage map's array of
|
/// * For `CounterKind::Expression`, `id` is the index into the coverage map's array of
|
||||||
/// counter expressions.
|
/// counter expressions.
|
||||||
/// Aligns with [llvm::coverage::Counter](https://github.com/rust-lang/llvm-project/blob/rustc/10.0-2020-05-05/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h#L98-L99)
|
/// Aligns with [llvm::coverage::Counter](https://github.com/rust-lang/llvm-project/blob/rustc/11.0-2020-10-12/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h#L99-L100)
|
||||||
/// Important: The Rust struct layout (order and types of fields) must match its C++ counterpart.
|
/// Important: The Rust struct layout (order and types of fields) must match its C++ counterpart.
|
||||||
#[derive(Copy, Clone, Debug)]
|
#[derive(Copy, Clone, Debug)]
|
||||||
#[repr(C)]
|
#[repr(C)]
|
||||||
@ -41,7 +41,7 @@ impl Counter {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Aligns with [llvm::coverage::CounterExpression::ExprKind](https://github.com/rust-lang/llvm-project/blob/rustc/10.0-2020-05-05/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h#L146)
|
/// Aligns with [llvm::coverage::CounterExpression::ExprKind](https://github.com/rust-lang/llvm-project/blob/rustc/11.0-2020-10-12/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h#L147)
|
||||||
#[derive(Copy, Clone, Debug)]
|
#[derive(Copy, Clone, Debug)]
|
||||||
#[repr(C)]
|
#[repr(C)]
|
||||||
pub enum ExprKind {
|
pub enum ExprKind {
|
||||||
@ -49,7 +49,7 @@ pub enum ExprKind {
|
|||||||
Add = 1,
|
Add = 1,
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Aligns with [llvm::coverage::CounterExpression](https://github.com/rust-lang/llvm-project/blob/rustc/10.0-2020-05-05/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h#L147-L148)
|
/// Aligns with [llvm::coverage::CounterExpression](https://github.com/rust-lang/llvm-project/blob/rustc/11.0-2020-10-12/llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h#L148-L149)
|
||||||
/// Important: The Rust struct layout (order and types of fields) must match its C++
|
/// Important: The Rust struct layout (order and types of fields) must match its C++
|
||||||
/// counterpart.
|
/// counterpart.
|
||||||
#[derive(Copy, Clone, Debug)]
|
#[derive(Copy, Clone, Debug)]
|
||||||
|
@ -21,9 +21,9 @@ rustc_index::newtype_index! {
|
|||||||
impl ExpressionOperandId {
|
impl ExpressionOperandId {
|
||||||
/// An expression operand for a "zero counter", as described in the following references:
|
/// An expression operand for a "zero counter", as described in the following references:
|
||||||
///
|
///
|
||||||
/// * <https://github.com/rust-lang/llvm-project/blob/llvmorg-8.0.0/llvm/docs/CoverageMappingFormat.rst#counter>
|
/// * https://github.com/rust-lang/llvm-project/blob/rustc/11.0-2020-10-12/llvm/docs/CoverageMappingFormat.rst#counter
|
||||||
/// * <https://github.com/rust-lang/llvm-project/blob/llvmorg-8.0.0/llvm/docs/CoverageMappingFormat.rst#tag>
|
/// * https://github.com/rust-lang/llvm-project/blob/rustc/11.0-2020-10-12/llvm/docs/CoverageMappingFormat.rst#tag
|
||||||
/// * <https://github.com/rust-lang/llvm-project/blob/llvmorg-8.0.0/llvm/docs/CoverageMappingFormat.rst#counter-expressions>
|
/// * https://github.com/rust-lang/llvm-project/blob/rustc/11.0-2020-10-12/llvm/docs/CoverageMappingFormat.rst#counter-expressions
|
||||||
///
|
///
|
||||||
/// This operand can be used to count two or more separate code regions with a single counter,
|
/// This operand can be used to count two or more separate code regions with a single counter,
|
||||||
/// if they run sequentially with no branches, by injecting the `Counter` in a `BasicBlock` for
|
/// if they run sequentially with no branches, by injecting the `Counter` in a `BasicBlock` for
|
||||||
|
Loading…
Reference in New Issue
Block a user