Skip to main content

CallSite

Struct CallSite 

Source
pub struct CallSite<'a> { /* private fields */ }
Expand description

What a call instruction records besides its operands: the stack slots that hold its GC roots while it runs (its stack map), and the landing pad control reaches if the callee unwinds.

§Examples

use backend_lang::mir::{Function, SlotKind};
use backend_lang::x86_64::{op, SYSV};

let mut f = Function::new("f", &SYSV);
let b = f.block()?;
let root = f.stack_slot(SlotKind::Local { size: 8, align: 8 })?;
let g = f.symbol("g")?;
let call = f.push(b, op::CALL, &[g.into()])?;
f.push(b, op::RET, &[])?;
f.set_call_site(call, &[root], None)?;
let site = f.call_site(call).unwrap();
assert_eq!(site.gc_slots(), [root]);
assert_eq!(site.landing_pad(), None);

Implementations§

Source§

impl<'a> CallSite<'a>

Source

pub const fn inst(&self) -> Inst

The call instruction.

§Examples
use backend_lang::mir::Function;
use backend_lang::x86_64::{op, SYSV};

let mut f = Function::new("f", &SYSV);
let b = f.block()?;
let g = f.symbol("g")?;
let call = f.push(b, op::CALL, &[g.into()])?;
f.set_call_site(call, &[], None)?;
assert_eq!(f.call_site(call).unwrap().inst(), call);
Source

pub const fn gc_slots(&self) -> &'a [StackSlot]

The slots holding the GC references live across the call, which a collector reads and may rewrite while the callee runs.

§Examples
use backend_lang::mir::{Function, SlotKind};
use backend_lang::x86_64::{op, SYSV};

let mut f = Function::new("f", &SYSV);
let b = f.block()?;
let s = f.stack_slot(SlotKind::Local { size: 8, align: 8 })?;
let g = f.symbol("g")?;
let call = f.push(b, op::CALL, &[g.into()])?;
f.set_call_site(call, &[s], None)?;
assert_eq!(f.call_site(call).unwrap().gc_slots().len(), 1);
Source

pub const fn landing_pad(&self) -> Option<Block>

The block control reaches when the callee unwinds, if any.

§Examples
use backend_lang::mir::Function;
use backend_lang::x86_64::{op, SYSV};

let mut f = Function::new("f", &SYSV);
let b = f.block()?;
let pad = f.block()?;
let g = f.symbol("g")?;
let call = f.push(b, op::CALL, &[g.into()])?;
f.set_call_site(call, &[], Some(pad))?;
assert_eq!(f.call_site(call).unwrap().landing_pad(), Some(pad));

Trait Implementations§

Source§

impl<'a> Clone for CallSite<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for CallSite<'a>

Source§

impl<'a> Debug for CallSite<'a>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for CallSite<'a>

Source§

impl<'a> PartialEq for CallSite<'a>

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for CallSite<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for CallSite<'a>

§

impl<'a> RefUnwindSafe for CallSite<'a>

§

impl<'a> Send for CallSite<'a>

§

impl<'a> Sync for CallSite<'a>

§

impl<'a> Unpin for CallSite<'a>

§

impl<'a> UnsafeUnpin for CallSite<'a>

§

impl<'a> UnwindSafe for CallSite<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.