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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

use llvm_sys::core::{LLVMGetInstructionOpcode, LLVMGetOperand};
use llvm_sys::prelude::LLVMValueRef;
use llvm_sys::LLVMOpcode;
use std::marker::PhantomData;

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

/// Binary Opcode
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum BinaryOpcode {
  // Arithmatics
  Add,
  Sub,
  Mul,
  UDiv,
  SDiv,
  URem,
  SRem,
  // Floating point
  FAdd,
  FSub,
  FMul,
  FDiv,
  FRem,
  // Bitwise operation
  Shl,
  LShr,
  AShr,
  And,
  Or,
  Xor,
}

impl BinaryOpcode {
  pub fn from_llvm(llvm_opcode: LLVMOpcode) -> Option<Self> {
    match llvm_opcode {
      LLVMOpcode::LLVMAdd => Some(Self::Add),
      LLVMOpcode::LLVMSub => Some(Self::Sub),
      LLVMOpcode::LLVMMul => Some(Self::Mul),
      LLVMOpcode::LLVMUDiv => Some(Self::UDiv),
      LLVMOpcode::LLVMSDiv => Some(Self::SDiv),
      LLVMOpcode::LLVMURem => Some(Self::URem),
      LLVMOpcode::LLVMSRem => Some(Self::SRem),
      LLVMOpcode::LLVMFAdd => Some(Self::FAdd),
      LLVMOpcode::LLVMFSub => Some(Self::FSub),
      LLVMOpcode::LLVMFMul => Some(Self::FMul),
      LLVMOpcode::LLVMFDiv => Some(Self::FDiv),
      LLVMOpcode::LLVMFRem => Some(Self::FRem),
      LLVMOpcode::LLVMShl => Some(Self::Shl),
      LLVMOpcode::LLVMLShr => Some(Self::LShr),
      LLVMOpcode::LLVMAShr => Some(Self::AShr),
      LLVMOpcode::LLVMAnd => Some(Self::And),
      LLVMOpcode::LLVMOr => Some(Self::Or),
      LLVMOpcode::LLVMXor => Some(Self::Xor),
      _ => None,
    }
  }

  pub fn to_string(&self) -> &str {
    match self {
      Self::Add => "add",
      Self::Sub => "sub",
      Self::Mul => "mul",
      Self::UDiv => "udiv",
      Self::SDiv => "sdiv",
      Self::URem => "urem",
      Self::SRem => "srem",
      Self::FAdd => "fadd",
      Self::FSub => "fsub",
      Self::FMul => "fmul",
      Self::FDiv => "fdiv",
      Self::FRem => "frem",
      Self::Shl => "shl",
      Self::LShr => "lshr",
      Self::AShr => "ashr",
      Self::And => "and",
      Self::Or => "or",
      Self::Xor => "xor",
    }
  }
}

/// [Binary instruction](https://llvm.org/docs/LangRef.html#binary-operations)
///
/// Covers the following instruction opcodes:
/// - Integer Arithmetics
///   - Add
///   - Sub
///   - Mul
///   - UDiv
///   - SDiv
///   - URem
///   - SRem
/// - Floating Point Arithmetics
///   - FAdd
///   - FSub
///   - FMul
///   - FDiv
/// - Bitwise
///   - Shl
///   - LShr
///   - AShr
///   - And
///   - Or
///   - Xor
#[derive(Copy, Clone, PartialEq, Eq, Hash)]
pub struct BinaryInstruction<'ctx>(BinaryOpcode, LLVMValueRef, PhantomData<&'ctx ()>);

impl_instr_debug!(BinaryInstruction);

impl_as_operand_for_instr!(BinaryInstruction);

impl_send_sync!(BinaryInstruction);

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

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

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

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

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

impl<'ctx> ValueOpcode for BinaryInstruction<'ctx> {
  fn opcode(&self) -> Opcode {
    Opcode::Binary(self.binary_opcode())
  }
}

impl<'ctx> BinaryInstruction<'ctx> {
  /// Get the opcode of this binary instruction
  pub fn binary_opcode(&self) -> BinaryOpcode {
    self.0
  }

  /// Get the lhs operand
  pub fn op0(&self) -> Operand<'ctx> {
    Operand::from_llvm(unsafe { LLVMGetOperand(self.1, 0) })
  }

  /// Get the rhs operand
  pub fn op1(&self) -> Operand<'ctx> {
    Operand::from_llvm(unsafe { LLVMGetOperand(self.1, 1) })
  }
}

impl_op_from_llvm_value!(BinaryInstruction, BinaryOpcode, LLVMGetInstructionOpcode);

impl_positional_value_ref!(BinaryInstruction, 1);