llir 0.2.2

LLVM IR Binding
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use llvm_sys::core::*;
use llvm_sys::prelude::LLVMValueRef;
use std::marker::PhantomData;

use crate::types::*;
use crate::values::*;
use crate::*;

/// [Call instruction](https://llvm.org/docs/LangRef.html#call-instruction)
#[derive(Copy, Clone, PartialEq, Eq, Hash)]
pub struct CallInstruction<'ctx>(LLVMValueRef, PhantomData<&'ctx ()>);

impl_instr_debug!(CallInstruction);

impl_as_operand_for_instr!(CallInstruction);

impl_send_sync!(CallInstruction);

impl<'ctx> GetType<'ctx> for CallInstruction<'ctx> {}

impl<'ctx> GetDebugMetadata<'ctx> for CallInstruction<'ctx> {}

impl<'ctx> InstructionDebugLoc for CallInstruction<'ctx> {}

impl<'ctx> InstructionTrait<'ctx> for CallInstruction<'ctx> {}

impl<'ctx> CallInstruction<'ctx> {
  /// Get the callee function if the callee is an LLVM function
  pub fn callee_function(&self) -> Option<Function<'ctx>> {
    match self.callee() {
      Operand::Constant(Constant::Function(f)) => Some(f),
      _ => None,
    }
  }

  /// Get the callee as inline assembly value if the callee is an InlineAsm
  pub fn callee_inline_asm(&self) -> Option<InlineAsm<'ctx>> {
    match self.callee() {
      Operand::InlineAsm(ia) => Some(ia),
      _ => None,
    }
  }

  /// Get the callee function type
  pub fn callee_function_type(&self) -> FunctionType<'ctx> {
    FunctionType::from_llvm(unsafe { LLVMGetElementType(self.callee().get_type().type_ref()) })
  }

  /// Get the callee value in operand
  pub fn callee(&self) -> Operand<'ctx> {
    let operand_id = self.num_arguments();
    Operand::from_llvm(unsafe { LLVMGetOperand(self.0, operand_id as u32) })
  }

  /// Get the number of arguments passed to the callee function
  pub fn num_arguments(&self) -> usize {
    let num_operands = unsafe { LLVMGetNumOperands(self.0) };
    num_operands as usize - 1
  }

  /// Get the arguments being passed to the callee function
  pub fn arguments(&self) -> Vec<Operand<'ctx>> {
    (0..self.num_arguments())
      .map(|i| Operand::from_llvm(unsafe { LLVMGetOperand(self.0, i as u32) }))
      .collect()
  }

  /// Get the argument at a given index
  pub fn argument(&self, index: usize) -> Option<Operand<'ctx>> {
    if index < self.num_arguments() {
      Some(Operand::from_llvm(unsafe { LLVMGetOperand(self.0, index as u32) }))
    } else {
      None
    }
  }

  /// Check if this function call is a tail call
  pub fn is_tail_call(&self) -> bool {
    unsafe { LLVMIsTailCall(self.0) == 1 }
  }

  /// Check if this call is to an inline assembly
  pub fn is_inline_asm_call(&self) -> bool {
    match self.callee() {
      Operand::InlineAsm(_) => true,
      _ => false,
    }
  }

  /// Check if this call is to llvm intrinsic function
  pub fn is_intrinsic_call(&self) -> bool {
    unsafe { !LLVMIsAIntrinsicInst(self.0).is_null() }
  }
}

impl<'ctx> ValueOpcode for CallInstruction<'ctx> {
  fn opcode(&self) -> Opcode {
    Opcode::Call
  }
}

impl<'ctx> AsInstruction<'ctx> for CallInstruction<'ctx> {
  fn as_instruction(&self) -> Instruction<'ctx> {
    Instruction::Call(*self)
  }
}

impl_positional_value_ref!(CallInstruction, 0);

impl_positional_from_llvm_value!(CallInstruction);