ExternalVendorCode/onefuzz
1
0
Fork 0
mirror of https://github.com/microsoft/onefuzz.git synced 2025-06-13 10:38:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Factor out Sancov analysis (#855)

Browse Source
This commit is contained in:
Joe Ranweiler
2021-05-06 06:08:28 -07:00
committed by GitHub
parent 99c258f356
commit 00210199c9
3 changed files with 469 additions and 421 deletions
Download Patch File Download Diff File Expand all files Collapse all files

445
src/agent/coverage/src/block/pe_provider.rs
View File

@ -6,11 +6,12 @@ use std::convert::TryInto;
use anyhow::{format_err, Result}; use anyhow::{format_err, Result};
use goblin::pe::PE; use goblin::pe::PE;
use iced_x86::{Decoder, DecoderOptions, Instruction, Mnemonic, OpKind};
use pdb::{ use pdb::{
AddressMap, DataSymbol, FallibleIterator, ProcedureSymbol, Rva, Source, SymbolData, PDB, AddressMap, DataSymbol, FallibleIterator, ProcedureSymbol, Rva, Source, SymbolData, PDB,
}; };
use crate::sancov::{SancovDelimiters, SancovInlineAccessScanner, SancovTable};
/// Basic block offset provider for uninstrumented PE modules. /// Basic block offset provider for uninstrumented PE modules.
pub struct PeBasicBlockProvider {} pub struct PeBasicBlockProvider {}
@ -48,7 +49,7 @@ where
} }
// If we found a non-empty PC table, try to parse it. // If we found a non-empty PC table, try to parse it.
if let Some(pcs_table) = visitor.sancov_pcs_table() { if let Some(pcs_table) = visitor.delimiters.pcs_table() {
// Discovering and parsing the PC table can be error-prone, if we even have it. Mine it // Discovering and parsing the PC table can be error-prone, if we even have it. Mine it
// for PCs if we can, with some strict assumptions. If we can't, fall back on reversing // for PCs if we can, with some strict assumptions. If we can't, fall back on reversing
// the inline table accesses. // the inline table accesses.
@ -61,7 +62,7 @@ where
// //
// If we found any inline table, then we should still be able to reverse the instrumentation // If we found any inline table, then we should still be able to reverse the instrumentation
// sites by disassembling instructions that access the inline table region in expected ways. // sites by disassembling instructions that access the inline table region in expected ways.
if let Some(inline_table) = visitor.sancov_inline_table() { if let Some(inline_table) = visitor.delimiters.inline_table() {
return self.provide_from_inline_table(inline_table); return self.provide_from_inline_table(inline_table);
} }
@ -97,7 +98,7 @@ where
} }
} }
Ok(visitor.access_offsets) Ok(visitor.scanner.offsets)
} }
// Try to parse instrumented VAs directly from the PC table. // Try to parse instrumented VAs directly from the PC table.
@ -160,234 +161,16 @@ where
#[derive(Default)] #[derive(Default)]
pub struct SancovDelimiterVisitor<'am> { pub struct SancovDelimiterVisitor<'am> {
address_map: AddressMap<'am>, address_map: AddressMap<'am>,
delimiters: SancovDelimiters,
llvm_bools_start: Option<u32>,
llvm_bools_stop: Option<u32>,
llvm_counters_start: Option<u32>,
llvm_counters_stop: Option<u32>,
llvm_pcs_start: Option<u32>,
llvm_pcs_stop: Option<u32>,
msvc_bools_start: Option<u32>,
msvc_bools_stop: Option<u32>,
msvc_counters_start: Option<u32>,
msvc_counters_stop: Option<u32>,
msvc_pcs_start: Option<u32>,
msvc_pcs_stop: Option<u32>,
msvc_preview_counters_start: Option<u32>,
msvc_preview_counters_stop: Option<u32>,
}
// Define a partial accessor method that returns the named Sancov table region when
//
// 1. Both the `$start` and `$stop` delimiter symbols are present
// 2. The delimited region is non-empty
//
// Sancov `$start` delimiters are usually declared as 8 byte values to ensure that they predictably
// anchor the delimited table during linking. If `$pad` is true, adjust for this so that the `start`
// offset in the returned `SancovTable` denotes the actual offset of the first table entry.
macro_rules! define_table_getter {
(
name = $name: ident,
start = $start: ident,
stop = $stop: ident,
ty = $ty: expr,
pad = $pad: expr
) => {
pub fn $name(&self) -> Option<SancovTable> {
let offset = if $pad {
self.$start?.checked_add(DELIMITER_START_PADDING)?
} else {
self.$start?
};
let size = self.$stop?.checked_sub(offset)?.try_into().ok()?;
// The delimiters may be present even when the table is unused. We can detect this case
// by an empty delimited region.
if size == 0 {
return None;
}
let ty = $ty;
Some(SancovTable { ty, offset, size })
}
};
// Accept trailing comma.
(
name = $name: ident,
start = $start: ident,
stop = $stop: ident,
ty = $ty: expr,
pad = $pad: expr,
) => {
define_table_getter!(
name = $name,
start = $start,
stop = $stop,
ty = $ty,
pad = $pad
);
};
} }
impl<'am> SancovDelimiterVisitor<'am> { impl<'am> SancovDelimiterVisitor<'am> {
pub fn new(address_map: AddressMap<'am>) -> Self { pub fn new(address_map: AddressMap<'am>) -> Self {
let delimiters = SancovDelimiters::default();
Self { Self {
address_map, address_map,
..Self::default() delimiters,
}
}
/// Return the most compiler-specific Sancov inline counter or bool flag table, if any.
pub fn sancov_inline_table(&self) -> Option<SancovTable> {
// With MSVC, the LLVM delimiters are typically linked in alongside the
// MSVC-specific symbols. Check for MSVC-delimited tables first, though
// our validation of table size _should_ make this unnecessary.
if let Some(table) = self.msvc_bools_table() {
return Some(table);
}
if let Some(table) = self.msvc_counters_table() {
return Some(table);
}
if let Some(table) = self.msvc_preview_counters_table() {
return Some(table);
}
// No MSVC tables found. Check for LLVM-emitted tables.
if let Some(table) = self.llvm_bools_table() {
return Some(table);
}
if let Some(table) = self.llvm_counters_table() {
return Some(table);
}
None
}
/// Return the most compiler-specific PC table, if any.
pub fn sancov_pcs_table(&self) -> Option<SancovTable> {
// Check for MSVC tables first.
if let Some(table) = self.msvc_pcs_table() {
return Some(table);
}
if let Some(table) = self.llvm_pcs_table() {
return Some(table);
}
None
}
define_table_getter!(
name = llvm_bools_table,
start = llvm_bools_start,
stop = llvm_bools_stop,
ty = SancovTableTy::Bools,
pad = true,
);
define_table_getter!(
name = llvm_counters_table,
start = llvm_counters_start,
stop = llvm_counters_stop,
ty = SancovTableTy::Counters,
pad = true,
);
define_table_getter!(
name = llvm_pcs_table,
start = llvm_pcs_start,
stop = llvm_pcs_stop,
ty = SancovTableTy::Pcs,
pad = true,
);
define_table_getter!(
name = msvc_bools_table,
start = msvc_bools_start,
stop = msvc_bools_stop,
ty = SancovTableTy::Bools,
pad = true,
);
define_table_getter!(
name = msvc_counters_table,
start = msvc_counters_start,
stop = msvc_counters_stop,
ty = SancovTableTy::Counters,
pad = true,
);
define_table_getter!(
name = msvc_pcs_table,
start = msvc_pcs_start,
stop = msvc_pcs_stop,
ty = SancovTableTy::Pcs,
pad = true,
);
define_table_getter!(
name = msvc_preview_counters_table,
start = msvc_preview_counters_start,
stop = msvc_preview_counters_stop,
ty = SancovTableTy::Counters,
pad = true,
);
fn insert_delimiter(&mut self, delimiter: Delimiter, offset: u32) {
use Delimiter::*;
let offset = Some(offset);
match delimiter {
LlvmBoolsStart => {
self.llvm_bools_start = offset;
}
LlvmBoolsStop => {
self.llvm_bools_stop = offset;
}
LlvmCountersStart => {
self.llvm_counters_start = offset;
}
LlvmCountersStop => {
self.llvm_counters_stop = offset;
}
LlvmPcsStart => {
self.llvm_pcs_start = offset;
}
LlvmPcsStop => {
self.llvm_pcs_stop = offset;
}
MsvcBoolsStart => {
self.msvc_bools_start = offset;
}
MsvcBoolsStop => {
self.msvc_bools_stop = offset;
}
MsvcCountersStart => {
self.msvc_counters_start = offset;
}
MsvcCountersStop => {
self.msvc_counters_stop = offset;
}
MsvcPcsStart => {
self.msvc_pcs_start = offset;
}
MsvcPcsStop => {
self.msvc_pcs_stop = offset;
}
MsvcPreviewCountersStart => {
self.msvc_preview_counters_start = offset;
}
MsvcPreviewCountersStop => {
self.msvc_preview_counters_stop = offset;
}
} }
} }
@ -400,7 +183,7 @@ impl<'am> SancovDelimiterVisitor<'am> {
if let Ok(delimiter) = name.parse() { if let Ok(delimiter) = name.parse() {
if let Some(Rva(offset)) = data.offset.to_rva(&self.address_map) { if let Some(Rva(offset)) = data.offset.to_rva(&self.address_map) {
self.insert_delimiter(delimiter, offset); self.delimiters.insert(delimiter, offset);
} else { } else {
log::error!("unable to map internal offset to RVA"); log::error!("unable to map internal offset to RVA");
} }
@ -410,109 +193,11 @@ impl<'am> SancovDelimiterVisitor<'am> {
} }
} }
/// A table of Sancov instrumentation data.
///
/// It is an array of either bytes or (packed pairs of) pointer-sized integers.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct SancovTable {
pub ty: SancovTableTy,
/// Module-relative offset of the first array element.
pub offset: u32,
/// Size of the array region (in bytes).
///
/// For `u8`-sized elements, this is also the length, but for PC tables,
/// this will be the product of the length and entry count, where each
/// entry is defined in LLVM as:
///
/// ```c
/// struct PCTableEntry {
/// uintptr_t PC, PCFlags;
/// };
/// ```
pub size: usize,
}
impl SancovTable {
pub fn range(&self) -> std::ops::Range<u32> {
self.offset..(self.offset + (self.size as u32))
}
}
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum SancovTableTy {
Bools,
Counters,
Pcs,
}
/// Note: on Windows, the LLVM `__start_` delimiter symbols do not denote the
/// first entry of a Sancov table array, but an anchor offset that precedes it
/// by 8 bytes.
///
/// See: -
/// `compiler-rt/lib/sanitizer_common/sanitizer_coverage_win_sections.cpp` -
/// `ModuleSanitizerCoverage::CreateSecStartEnd()` in
/// `llvm/lib/Transforms/Instrumentation/SanitizerCoverage.cpp:350-351`
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum Delimiter {
LlvmBoolsStart,
LlvmBoolsStop,
LlvmCountersStart,
LlvmCountersStop,
LlvmPcsStart,
LlvmPcsStop,
MsvcBoolsStart,
MsvcBoolsStop,
MsvcCountersStart,
MsvcCountersStop,
MsvcPcsStart,
MsvcPcsStop,
MsvcPreviewCountersStart,
MsvcPreviewCountersStop,
}
/// Size of padding inserted (on Window) between `__start_` delimiter symbols
/// and the first entry of the delimited table's array.
///
/// To find the true start offset of the table, add this to the symbol value.
const DELIMITER_START_PADDING: u32 = 8;
impl std::str::FromStr for Delimiter {
type Err = anyhow::Error;
fn from_str(s: &str) -> Result<Self> {
let delimiter = match s {
"__start___sancov_cntrs" => Self::LlvmBoolsStart,
"__stop___sancov_cntrs" => Self::LlvmBoolsStop,
"__start___sancov_bools" => Self::LlvmCountersStart,
"__stop___sancov_bools" => Self::LlvmCountersStop,
"__start___sancov_pcs" => Self::LlvmPcsStart,
"__stop___sancov_pcs" => Self::LlvmPcsStop,
"__sancov$BoolFlagStart" => Self::MsvcBoolsStart,
"__sancov$BoolFlagEnd" => Self::MsvcBoolsStop,
"__sancov$8bitCountersStart" => Self::MsvcCountersStart,
"__sancov$8bitCountersEnd" => Self::MsvcCountersStop,
"__sancov$PCTableStart" => Self::MsvcPcsStart,
"__sancov$PCTableEnd" => Self::MsvcPcsStop,
"SancovBitmapStart" => Self::MsvcPreviewCountersStart,
"SancovBitmapEnd" => Self::MsvcPreviewCountersStop,
_ => {
anyhow::bail!("string does not match any Sancov delimiter symbol");
}
};
Ok(delimiter)
}
}
pub struct SancovInlineAccessVisitor<'d, 'p> { pub struct SancovInlineAccessVisitor<'d, 'p> {
access_offsets: BTreeSet<u32>,
address_map: AddressMap<'d>, address_map: AddressMap<'d>,
data: &'p [u8], data: &'p [u8],
pe: &'p PE<'p>, pe: &'p PE<'p>,
table: SancovTable, scanner: SancovInlineAccessScanner,
} }
impl<'d, 'p> SancovInlineAccessVisitor<'d, 'p> { impl<'d, 'p> SancovInlineAccessVisitor<'d, 'p> {
@ -525,108 +210,19 @@ impl<'d, 'p> SancovInlineAccessVisitor<'d, 'p> {
where where
D: Source<'d> + 'd, D: Source<'d> + 'd,
{ {
let access_offsets = BTreeSet::default();
let address_map = pdb.address_map()?; let address_map = pdb.address_map()?;
let base: u64 = pe.image_base.try_into()?;
let scanner = SancovInlineAccessScanner::new(base, table);
Ok(Self { Ok(Self {
access_offsets,
address_map, address_map,
data, data,
pe, pe,
table, scanner,
}) })
} }
pub fn visit_procedure_symbol(&mut self, proc: &ProcedureSymbol) -> Result<()> { pub fn visit_procedure_symbol(&mut self, proc: &ProcedureSymbol) -> Result<()> {
let data = self.procedure_data(proc)?;
let mut decoder = Decoder::new(64, data, DecoderOptions::NONE);
// Set decoder IP to be an RVA.
let proc_rip: u64 = proc.offset.to_rva(&self.address_map).unwrap().0.into();
decoder.set_ip(proc_rip);
let mut inst = Instruction::default();
while decoder.can_decode() {
decoder.decode_out(&mut inst);
match inst.op_code().mnemonic() {
Mnemonic::Add | Mnemonic::Inc => {
// These may be 8-bit counter updates, check further.
}
Mnemonic::Mov => {
// This may be a bool flag set or the start of an unoptimized
// 8-bit counter update sequence.
//
// mov al, [rel <table>]
//
// or:
//
// mov [rel <table>], 1
match (inst.op0_kind(), inst.op1_kind()) {
(OpKind::Register, OpKind::Memory) => {
// Possible start of an unoptimized 8-bit counter update sequence, like:
//
// mov al, [rel <table>]
// add al, 1
// mov [rel <table>], al
//
// Check the operand sizes.
if inst.memory_size().size() != 1 {
// Load would span multiple table entries, skip.
continue;
}
if inst.op0_register().size() != 1 {
// Should be unreachable after a 1-byte load.
continue;
}
}
(OpKind::Memory, OpKind::Immediate8) => {
// Possible bool flag set, like:
//
// mov [rel <table>], 1
//
// Check store size and immediate value.
if inst.memory_size().size() != 1 {
// Store would span multiple table entries, skip.
continue;
}
if inst.immediate8() != 1 {
// Not a bool flag set, skip.
continue;
}
}
_ => {
// Not a known update pattern, skip.
continue;
}
}
}
_ => {
// Does not correspond to any known counter update, so skip.
continue;
}
}
if inst.is_ip_rel_memory_operand() {
// When relative, `memory_displacement64()` returns a VA. The
// decoder RIP is already set to be module image-relative, so
// our "VA" is already an RVA.
let accessed = inst.memory_displacement64() as u32;
if self.table.range().contains(&accessed) {
self.access_offsets.insert(inst.ip() as u32);
}
}
}
Ok(())
}
fn procedure_data(&self, proc: &ProcedureSymbol) -> Result<&'p [u8]> {
let alignment = self let alignment = self
.pe .pe
.header .header
@ -647,8 +243,15 @@ impl<'d, 'p> SancovInlineAccessVisitor<'d, 'p> {
let range = file_offset..(file_offset + proc.len as usize); let range = file_offset..(file_offset + proc.len as usize);
self.data let data = self
.data
.get(range) .get(range)
.ok_or_else(|| format_err!("invalid PE file range for procedure data")) .ok_or_else(|| format_err!("invalid PE file range for procedure data"))?;
let offset: u64 = rva.try_into()?;
let va: u64 = self.scanner.base + offset;
self.scanner.scan(data, va)?;
Ok(())
} }
} }

1
src/agent/coverage/src/lib.rs
View File

@ -17,6 +17,7 @@ pub mod cache;
pub mod code; pub mod code;
pub mod demangle; pub mod demangle;
pub mod report; pub mod report;
pub mod sancov;
#[cfg(target_os = "linux")] #[cfg(target_os = "linux")]
pub mod disasm; pub mod disasm;

444
src/agent/coverage/src/sancov.rs Normal file
View File

@ -0,0 +1,444 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
use std::collections::BTreeSet;
use std::convert::TryInto;
use anyhow::{format_err, Result};
use iced_x86::{Decoder, DecoderOptions, Instruction, Mnemonic, OpKind};
#[derive(Default)]
pub struct SancovDelimiters {
llvm_bools_start: Option<u32>,
llvm_bools_stop: Option<u32>,
llvm_counters_start: Option<u32>,
llvm_counters_stop: Option<u32>,
llvm_pcs_start: Option<u32>,
llvm_pcs_stop: Option<u32>,
msvc_bools_start: Option<u32>,
msvc_bools_stop: Option<u32>,
msvc_counters_start: Option<u32>,
msvc_counters_stop: Option<u32>,
msvc_pcs_start: Option<u32>,
msvc_pcs_stop: Option<u32>,
msvc_preview_counters_start: Option<u32>,
msvc_preview_counters_stop: Option<u32>,
}
// Define a partial accessor method that returns the named Sancov table region when
//
// 1. Both the `$start` and `$stop` delimiter symbols are present
// 2. The delimited region is non-empty
//
// Sancov `$start` delimiters are usually declared as 8 byte values to ensure that they predictably
// anchor the delimited table during linking. If `$pad` is true, adjust for this so that the `start`
// offset in the returned `SancovTable` denotes the actual offset of the first table entry.
macro_rules! define_table_getter {
(
name = $name: ident,
start = $start: ident,
stop = $stop: ident,
ty = $ty: expr,
pad = $pad: expr
) => {
pub fn $name(&self) -> Option<SancovTable> {
let offset = if $pad {
self.$start?.checked_add(DELIMITER_START_PADDING)?
} else {
self.$start?
};
let size = self.$stop?.checked_sub(offset)?.try_into().ok()?;
// The delimiters may be present even when the table is unused. We can detect this case
// by an empty delimited region.
if size == 0 {
return None;
}
let ty = $ty;
Some(SancovTable { ty, offset, size })
}
};
// Accept trailing comma.
(
name = $name: ident,
start = $start: ident,
stop = $stop: ident,
ty = $ty: expr,
pad = $pad: expr,
) => {
define_table_getter!(
name = $name,
start = $start,
stop = $stop,
ty = $ty,
pad = $pad
);
};
}
impl SancovDelimiters {
/// Return the most compiler-specific Sancov inline counter or bool flag table, if any.
pub fn inline_table(&self) -> Option<SancovTable> {
// With MSVC, the LLVM delimiters are typically linked in alongside the
// MSVC-specific symbols. Check for MSVC-delimited tables first, though
// our validation of table size _should_ make this unnecessary.
if let Some(table) = self.msvc_bools_table() {
return Some(table);
}
if let Some(table) = self.msvc_counters_table() {
return Some(table);
}
if let Some(table) = self.msvc_preview_counters_table() {
return Some(table);
}
// No MSVC tables found. Check for LLVM-emitted tables.
if let Some(table) = self.llvm_bools_table() {
return Some(table);
}
if let Some(table) = self.llvm_counters_table() {
return Some(table);
}
None
}
/// Return the most compiler-specific PC table, if any.
pub fn pcs_table(&self) -> Option<SancovTable> {
// Check for MSVC tables first.
if let Some(table) = self.msvc_pcs_table() {
return Some(table);
}
if let Some(table) = self.llvm_pcs_table() {
return Some(table);
}
None
}
define_table_getter!(
name = llvm_bools_table,
start = llvm_bools_start,
stop = llvm_bools_stop,
ty = SancovTableTy::Bools,
pad = true,
);
define_table_getter!(
name = llvm_counters_table,
start = llvm_counters_start,
stop = llvm_counters_stop,
ty = SancovTableTy::Counters,
pad = true,
);
define_table_getter!(
name = llvm_pcs_table,
start = llvm_pcs_start,
stop = llvm_pcs_stop,
ty = SancovTableTy::Pcs,
pad = true,
);
define_table_getter!(
name = msvc_bools_table,
start = msvc_bools_start,
stop = msvc_bools_stop,
ty = SancovTableTy::Bools,
pad = true,
);
define_table_getter!(
name = msvc_counters_table,
start = msvc_counters_start,
stop = msvc_counters_stop,
ty = SancovTableTy::Counters,
pad = true,
);
define_table_getter!(
name = msvc_pcs_table,
start = msvc_pcs_start,
stop = msvc_pcs_stop,
ty = SancovTableTy::Pcs,
pad = true,
);
define_table_getter!(
name = msvc_preview_counters_table,
start = msvc_preview_counters_start,
stop = msvc_preview_counters_stop,
ty = SancovTableTy::Counters,
pad = true,
);
pub fn insert(&mut self, delimiter: Delimiter, offset: u32) {
use Delimiter::*;
let offset = Some(offset);
match delimiter {
LlvmBoolsStart => {
self.llvm_bools_start = offset;
}
LlvmBoolsStop => {
self.llvm_bools_stop = offset;
}
LlvmCountersStart => {
self.llvm_counters_start = offset;
}
LlvmCountersStop => {
self.llvm_counters_stop = offset;
}
LlvmPcsStart => {
self.llvm_pcs_start = offset;
}
LlvmPcsStop => {
self.llvm_pcs_stop = offset;
}
MsvcBoolsStart => {
self.msvc_bools_start = offset;
}
MsvcBoolsStop => {
self.msvc_bools_stop = offset;
}
MsvcCountersStart => {
self.msvc_counters_start = offset;
}
MsvcCountersStop => {
self.msvc_counters_stop = offset;
}
MsvcPcsStart => {
self.msvc_pcs_start = offset;
}
MsvcPcsStop => {
self.msvc_pcs_stop = offset;
}
MsvcPreviewCountersStart => {
self.msvc_preview_counters_start = offset;
}
MsvcPreviewCountersStop => {
self.msvc_preview_counters_stop = offset;
}
}
}
}
/// A table of Sancov instrumentation data.
///
/// It is an array of either bytes or (packed pairs of) pointer-sized integers.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct SancovTable {
pub ty: SancovTableTy,
/// Module-relative offset of the first array element.
pub offset: u32,
/// Size of the array region (in bytes).
///
/// For `u8`-sized elements, this is also the length, but for PC tables,
/// this will be the product of the length and entry count, where each
/// entry is defined in LLVM as:
///
/// ```c
/// struct PCTableEntry {
/// uintptr_t PC, PCFlags;
/// };
/// ```
pub size: usize,
}
impl SancovTable {
pub fn range(&self) -> std::ops::Range<u32> {
self.offset..(self.offset + (self.size as u32))
}
}
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum SancovTableTy {
Bools,
Counters,
Pcs,
}
/// Note: on Windows, the LLVM `__start_` delimiter symbols do not denote the
/// first entry of a Sancov table array, but an anchor offset that precedes it
/// by 8 bytes.
///
/// See:
/// - `compiler-rt/lib/sanitizer_common/sanitizer_coverage_win_sections.cpp`
/// - `ModuleSanitizerCoverage::CreateSecStartEnd()` in
/// `llvm/lib/Transforms/Instrumentation/SanitizerCoverage.cpp:350-351`
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Delimiter {
LlvmBoolsStart,
LlvmBoolsStop,
LlvmCountersStart,
LlvmCountersStop,
LlvmPcsStart,
LlvmPcsStop,
MsvcBoolsStart,
MsvcBoolsStop,
MsvcCountersStart,
MsvcCountersStop,
MsvcPcsStart,
MsvcPcsStop,
MsvcPreviewCountersStart,
MsvcPreviewCountersStop,
}
/// Size of padding inserted (on Window) between `__start_` delimiter symbols
/// and the first entry of the delimited table's array.
///
/// To find the true start offset of the table, add this to the symbol value.
const DELIMITER_START_PADDING: u32 = 8;
impl std::str::FromStr for Delimiter {
type Err = anyhow::Error;
fn from_str(s: &str) -> Result<Self> {
let delimiter = match s {
"__start___sancov_cntrs" => Self::LlvmBoolsStart,
"__stop___sancov_cntrs" => Self::LlvmBoolsStop,
"__start___sancov_bools" => Self::LlvmCountersStart,
"__stop___sancov_bools" => Self::LlvmCountersStop,
"__start___sancov_pcs" => Self::LlvmPcsStart,
"__stop___sancov_pcs" => Self::LlvmPcsStop,
"__sancov$BoolFlagStart" => Self::MsvcBoolsStart,
"__sancov$BoolFlagEnd" => Self::MsvcBoolsStop,
"__sancov$8bitCountersStart" => Self::MsvcCountersStart,
"__sancov$8bitCountersEnd" => Self::MsvcCountersStop,
"__sancov$PCTableStart" => Self::MsvcPcsStart,
"__sancov$PCTableEnd" => Self::MsvcPcsStop,
"SancovBitmapStart" => Self::MsvcPreviewCountersStart,
"SancovBitmapEnd" => Self::MsvcPreviewCountersStop,
_ => {
anyhow::bail!("string does not match any Sancov delimiter symbol");
}
};
Ok(delimiter)
}
}
#[derive(Clone, Debug)]
pub struct SancovInlineAccessScanner {
pub base: u64,
pub offsets: BTreeSet<u32>,
table: SancovTable,
}
impl SancovInlineAccessScanner {
pub fn new(base: u64, table: SancovTable) -> Self {
let offsets = BTreeSet::default();
Self {
base,
offsets,
table,
}
}
pub fn scan(&mut self, data: &[u8], va: u64) -> Result<()> {
let mut decoder = Decoder::new(64, data, DecoderOptions::NONE);
decoder.set_ip(va);
let mut inst = Instruction::default();
while decoder.can_decode() {
decoder.decode_out(&mut inst);
match inst.op_code().mnemonic() {
Mnemonic::Add | Mnemonic::Inc => {
// These may be 8-bit counter updates, check further.
}
Mnemonic::Mov => {
// This may be a bool flag set or the start of an unoptimized
// 8-bit counter update sequence.
//
// mov al, [rel <table>]
//
// or:
//
// mov [rel <table>], 1
match (inst.op0_kind(), inst.op1_kind()) {
(OpKind::Register, OpKind::Memory) => {
// Possible start of an unoptimized 8-bit counter update sequence, like:
//
// mov al, [rel <table>]
// add al, 1
// mov [rel <table>], al
//
// Check the operand sizes.
if inst.memory_size().size() != 1 {
// Load would span multiple table entries, skip.
continue;
}
if inst.op0_register().size() != 1 {
// Should be unreachable after a 1-byte load.
continue;
}
}
(OpKind::Memory, OpKind::Immediate8) => {
// Possible bool flag set, like:
//
// mov [rel <table>], 1
//
// Check store size and immediate value.
if inst.memory_size().size() != 1 {
// Store would span multiple table entries, skip.
continue;
}
if inst.immediate8() != 1 {
// Not a bool flag set, skip.
continue;
}
}
_ => {
// Not a known update pattern, skip.
continue;
}
}
}
_ => {
// Does not correspond to any known counter update, so skip.
continue;
}
}
if inst.is_ip_rel_memory_operand() {
// When relative, `memory_displacement64()` returns a VA.
let accessed = inst
.memory_displacement64()
.checked_sub(self.base)
.ok_or_else(|| format_err!("underflow converting access VA to offset"))?
.try_into()?;
if self.table.range().contains(&accessed) {
let offset = inst
.ip()
.checked_sub(self.base)
.ok_or_else(|| format_err!("underflow computing module offset"))?
.try_into()?;
self.offsets.insert(offset);
}
}
}
Ok(())
}
}