use rustc_hir::{Safety, def_id::DefId};
use rustc_middle::{
mir::{
BasicBlock, Body, Local, Operand, Place, ProjectionElem, Rvalue, StatementKind,
TerminatorKind,
},
ty::{self, Ty, TyCtxt, TyKind},
};
use std::collections::{HashMap, HashSet};
use super::mir_utils::{dep_callee_def_id, pointee_ty};
use super::name::get_cleaned_def_path_name;
#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
pub struct CheckpointLocation {
pub caller: DefId,
pub block: BasicBlock,
}
#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
pub enum CheckpointKind {
UnsafeCall,
RawPtrDeref,
StaticMutAccess,
}
#[derive(Clone, Debug)]
pub struct Checkpoint<'tcx> {
pub caller: DefId,
pub callee: Option<DefId>,
pub block: BasicBlock,
pub args: Vec<Operand<'tcx>>,
pub kind: CheckpointKind,
pub destination: Option<Local>,
}
impl<'tcx> Checkpoint<'tcx> {
pub fn location(&self) -> CheckpointLocation {
CheckpointLocation {
caller: self.caller,
block: self.block,
}
}
pub fn callee_name(&self, tcx: TyCtxt<'tcx>) -> String {
match self.callee {
Some(def_id) => get_cleaned_def_path_name(tcx, def_id),
None => match self.kind {
CheckpointKind::RawPtrDeref => "raw-ptr-deref".to_string(),
CheckpointKind::StaticMutAccess => "static-mut-access".to_string(),
CheckpointKind::UnsafeCall => "unknown-callee".to_string(),
},
}
}
}
pub fn check_safety(tcx: TyCtxt<'_>, def_id: DefId) -> Safety {
let poly_fn_sig = tcx.fn_sig(def_id);
let fn_sig = poly_fn_sig.skip_binder();
fn_sig.safety()
}
pub fn place_has_raw_deref<'tcx>(body: &Body<'tcx>, place: &Place<'tcx>) -> bool {
let local = place.local;
for proj in place.projection.iter() {
if let ProjectionElem::Deref = proj.kind() {
let ty = body.local_decls[local].ty;
if let TyKind::RawPtr(_, _) = ty.kind() {
return true;
}
}
}
false
}
pub fn has_raw_ptr_write(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
if !tcx.is_mir_available(def_id) {
return false;
}
let body = tcx.optimized_mir(def_id);
body.basic_blocks.iter().any(|bb| {
bb.statements.iter().any(|stmt| {
if let StatementKind::Assign(assign) = &stmt.kind {
let (lhs, _) = &**assign;
place_has_raw_deref(&body, lhs)
} else {
false
}
})
})
}
pub fn has_atomic_call(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
if !tcx.is_mir_available(def_id) {
return false;
}
let body = tcx.optimized_mir(def_id);
body.basic_blocks.iter().any(|bb| {
if let TerminatorKind::Call { func, .. } = &bb.terminator().kind {
let Some(callee) = dep_callee_def_id(func) else {
return false;
};
if tcx
.intrinsic(callee)
.is_some_and(|i| i.name.as_str().starts_with("atomic_"))
{
return true;
}
tcx.def_path_str(callee).contains("Atomic")
} else {
false
}
})
}
pub fn get_rawptr_deref(tcx: TyCtxt<'_>, def_id: DefId) -> HashSet<Local> {
let mut raw_ptrs = HashSet::new();
if tcx.is_mir_available(def_id) {
let body = tcx.optimized_mir(def_id);
for bb in body.basic_blocks.iter() {
for stmt in &bb.statements {
if let StatementKind::Assign(assign) = &stmt.kind {
let (lhs, rhs) = &**assign;
if place_has_raw_deref(&body, lhs) {
raw_ptrs.insert(lhs.local);
}
if let Rvalue::Use(op, ..) = rhs {
match op {
Operand::Copy(place) | Operand::Move(place) => {
if place_has_raw_deref(&body, place) {
raw_ptrs.insert(place.local);
}
}
_ => {}
}
}
if let Rvalue::Ref(_, _, place) = rhs {
if place_has_raw_deref(&body, place) {
raw_ptrs.insert(place.local);
}
}
}
}
if let Some(terminator) = &bb.terminator {
match &terminator.kind {
rustc_middle::mir::TerminatorKind::Call { args, .. } => {
for arg in args {
match arg.node {
Operand::Copy(place) | Operand::Move(place) => {
if place_has_raw_deref(&body, &place) {
raw_ptrs.insert(place.local);
}
}
_ => {}
}
}
}
_ => {}
}
}
}
}
raw_ptrs
}
pub fn collect_global_local_pairs(tcx: TyCtxt<'_>, def_id: DefId) -> HashMap<DefId, Vec<Local>> {
let mut globals: HashMap<DefId, Vec<Local>> = HashMap::new();
if !tcx.is_mir_available(def_id) {
return globals;
}
let body = tcx.optimized_mir(def_id);
for bb in body.basic_blocks.iter() {
for stmt in &bb.statements {
if let StatementKind::Assign(assign) = &stmt.kind {
let (lhs, rhs) = &**assign;
if let Rvalue::Use(Operand::Constant(c), ..) = rhs {
if let Some(static_def_id) = c.check_static_ptr(tcx) {
globals.entry(static_def_id).or_default().push(lhs.local);
}
}
}
}
}
globals
}
pub fn get_unsafe_callees(tcx: TyCtxt<'_>, def_id: DefId) -> HashSet<DefId> {
let mut unsafe_callees = HashSet::new();
if tcx.is_mir_available(def_id) {
let body = tcx.optimized_mir(def_id);
for bb in body.basic_blocks.iter() {
if let TerminatorKind::Call { func, .. } = &bb.terminator().kind {
if let Some(callee_def_id) = dep_callee_def_id(func) {
if check_safety(tcx, callee_def_id) == Safety::Unsafe {
unsafe_callees.insert(callee_def_id);
}
}
}
}
}
unsafe_callees
}
pub fn collect_unsafe_callsites<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId) -> Vec<Checkpoint<'tcx>> {
let mut checkpoints = Vec::new();
if !tcx.is_mir_available(def_id) {
return checkpoints;
}
let body = tcx.optimized_mir(def_id);
for (bb, data) in body.basic_blocks.iter_enumerated() {
let TerminatorKind::Call { func, args, .. } = &data.terminator().kind else {
continue;
};
let Operand::Constant(func_constant) = func else {
continue;
};
let ty::FnDef(callee_def_id, callee_args) = func_constant.const_.ty().kind() else {
continue;
};
#[cfg(rapx_ge_99)]
let callee_args = callee_args.skip_binder();
if check_safety(tcx, *callee_def_id) != Safety::Unsafe {
continue;
}
let resolved_callee = crate::helpers::mir_utils::resolve_callee_impl(
tcx,
def_id,
*callee_def_id,
callee_args,
)
.unwrap_or(*callee_def_id);
checkpoints.push(Checkpoint {
caller: def_id,
callee: Some(resolved_callee),
block: bb,
args: args.iter().map(|arg| arg.node.clone()).collect(),
kind: CheckpointKind::UnsafeCall,
destination: None,
});
}
checkpoints
}
#[derive(Clone, Debug)]
pub struct RawPtrDerefInfo<'tcx> {
pub block: BasicBlock,
pub ptr_operand: Operand<'tcx>,
pub pointee_ty: Ty<'tcx>,
pub is_read: bool,
pub is_ptr2ref: bool,
pub destination: Local,
}
pub fn collect_raw_ptr_deref_info<'tcx>(
tcx: TyCtxt<'tcx>,
def_id: DefId,
) -> Vec<RawPtrDerefInfo<'tcx>> {
let mut infos = Vec::new();
if !tcx.is_mir_available(def_id) {
return infos;
}
let body = tcx.optimized_mir(def_id);
let fn_span = tcx.def_span(def_id);
let local_file = tcx.sess.source_map().lookup_char_pos(fn_span.lo()).file;
for (bb, data) in body.basic_blocks.iter_enumerated() {
for stmt in &data.statements {
let stmt_file = tcx
.sess
.source_map()
.lookup_char_pos(stmt.source_info.span.lo())
.file;
if !std::ptr::addr_eq(
std::sync::Arc::as_ptr(&stmt_file),
std::sync::Arc::as_ptr(&local_file),
) {
continue;
}
let StatementKind::Assign(assign) = &stmt.kind else {
continue;
};
let (lhs, rhs) = &**assign;
let is_write = place_has_raw_deref(&body, lhs);
let (is_read, is_ptr2ref) = match rhs {
Rvalue::Use(Operand::Copy(place) | Operand::Move(place), ..) => {
(place_has_raw_deref(&body, place), false)
}
Rvalue::Ref(_, _borrow_kind, place) => (place_has_raw_deref(&body, place), true),
_ => (false, false),
};
if !is_write && !is_read {
continue;
}
let deref_place = if is_write {
lhs
} else {
match rhs {
Rvalue::Use(Operand::Copy(place) | Operand::Move(place), ..)
| Rvalue::Ref(_, _, place) => place,
_ => continue,
}
};
let Some(ptr_operand) = ptr_operand_for_deref_place(deref_place) else {
continue;
};
let Some(pointee) = pointee_ty(body.local_decls[deref_place.local].ty) else {
continue;
};
infos.push(RawPtrDerefInfo {
block: bb,
ptr_operand,
pointee_ty: pointee,
is_read,
is_ptr2ref,
destination: lhs.local,
});
}
}
infos
}
fn ptr_operand_for_deref_place<'tcx>(place: &Place<'tcx>) -> Option<Operand<'tcx>> {
use rustc_middle::ty::List;
let first_deref_idx = place
.projection
.iter()
.position(|p| matches!(p.kind(), ProjectionElem::Deref));
if let Some(idx) = first_deref_idx
&& idx > 0
{
return None;
}
Some(Operand::Copy(Place {
local: place.local,
projection: List::empty(),
}))
}
#[derive(Clone, Debug)]
pub struct StaticMutAccessInfo<'tcx> {
pub block: BasicBlock,
pub ty: Ty<'tcx>,
pub ptr_operand: Operand<'tcx>,
}
pub fn collect_static_mut_access_info<'tcx>(
tcx: TyCtxt<'tcx>,
def_id: DefId,
) -> Vec<StaticMutAccessInfo<'tcx>> {
let mut infos = Vec::new();
if !tcx.is_mir_available(def_id) {
return infos;
}
let body = tcx.optimized_mir(def_id);
for (bb, data) in body.basic_blocks.iter_enumerated() {
for stmt in &data.statements {
if let StatementKind::Assign(assign) = &stmt.kind {
let (_lhs, rhs) = &**assign;
if let Rvalue::Use(op @ Operand::Constant(c), ..) = rhs {
if let Some(static_id) = c.check_static_ptr(tcx) {
if matches!(tcx.static_mutability(static_id), Some(m) if m.is_mut()) {
let ty = tcx.type_of(static_id).skip_binder();
infos.push(StaticMutAccessInfo {
block: bb,
ty,
ptr_operand: op.clone(),
});
}
}
}
}
}
if let Some(terminator) = &data.terminator {
if let TerminatorKind::Call { args, .. } = &terminator.kind {
for arg in args {
match &arg.node {
op @ Operand::Constant(c) => {
if let Some(static_id) = c.check_static_ptr(tcx) {
if matches!(tcx.static_mutability(static_id), Some(m) if m.is_mut())
{
let ty = tcx.type_of(static_id).skip_binder();
infos.push(StaticMutAccessInfo {
block: bb,
ty,
ptr_operand: op.clone(),
});
}
}
}
_ => {}
}
}
}
}
}
infos
}