Class: LLVM::Value

Inherits:
Object
  • Object
show all
Includes:
PointerIdentity
Defined in:
lib/llvm/core/value.rb

Direct Known Subclasses

Argument, BasicBlock, Poison, User

Class Method Summary collapse

Instance Method Summary collapse

Methods included from PointerIdentity

#==, #eql?, #hash, #to_ptr

Class Method Details

.from_ptr(ptr) ⇒ Object 



8
9
10
11
12
13
 
# File 'lib/llvm/core/value.rb', line 8

def self.from_ptr(ptr)
  return if ptr.null?
  val = allocate
  val.instance_variable_set(:@ptr, ptr)
  val
end

.from_ptr_kind(ptr) ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/llvm/core/value.rb', line 15

def self.from_ptr_kind(ptr) # rubocop:disable Metrics/CyclomaticComplexity
  return if ptr.null?

  kind = C.get_value_kind(ptr)
  case kind
  when :instruction
    Instruction.from_ptr(ptr)
  when :const_int
    ConstantInt.from_ptr(ptr)
  when :const_fp
    ConstantReal.from_ptr(ptr)
  when :poison
    Poison.from_ptr(ptr)
  when :global_variable
    GlobalVariable.from_ptr(ptr)
  when :const_expr
    ConstantExpr.from_ptr(ptr)
  when :const_null
    ConstantNull.from_ptr(ptr)
  else
    raise "from_ptr_kind cannot handle: #{kind}"
  end
end

.to_ptr ⇒ Object 



44
45
46
 
# File 'lib/llvm/core/value.rb', line 44

def self.to_ptr
  type.to_ptr
end

.type ⇒ Object

Returns the Value type. This is abstract and is overidden by its subclasses.

Raises:

  • (NotImplementedError) 


40
41
42
 
# File 'lib/llvm/core/value.rb', line 40

def self.type
  raise NotImplementedError, "#{name}.type() is abstract."
end

Instance Method Details

#add_attribute(attr) ⇒ Object

Adds attr to this value’s attributes.



131
132
133
134
135
136
137
138
139
 
# File 'lib/llvm/core/value.rb', line 131

def add_attribute(attr)
  fun = param_parent
  return unless fun

  index = param_index(fun)
  return unless index

  fun.add_attribute(attr, index)
end

#allocated_type ⇒ Object

allocated type of alloca also works on geps of allocas



69
70
71
72
73
74
75
76
 
# File 'lib/llvm/core/value.rb', line 69

def allocated_type
  return if !allocated_type?

  alloc_type = C.get_allocated_type(self)
  return nil if alloc_type.nil?

  Type.from_ptr(alloc_type, nil)
end

#allocated_type? ⇒ Boolean

Returns:

  • (Boolean) 


58
59
60
61
62
63
64
65
 
# File 'lib/llvm/core/value.rb', line 58

def allocated_type?
  case self
  when Instruction
    true
  else
    false
  end
end

#constant? ⇒ Boolean

Returns whether the value is constant.

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/llvm/core/value.rb', line 111

def constant?
  C.is_constant(self)
end

#dump ⇒ Object

Print the value’s IR to stdout.



100
101
102
103
104
 
# File 'lib/llvm/core/value.rb', line 100

def dump
  # :nocov:
  C.dump_value(self)
  # :nocov:
end

#gep_source_element_type ⇒ Object

element type of gep



83
84
85
86
87
 
# File 'lib/llvm/core/value.rb', line 83

def gep_source_element_type
  return if !gep_source_element_type?

  Type.from_ptr(C.get_gep_source_element_type(self))
end

#gep_source_element_type? ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/llvm/core/value.rb', line 78

def gep_source_element_type?
  is_a?(Instruction)
end

#global_parent ⇒ Object

Get the parent module of a global variable, including functions



153
154
155
 
# File 'lib/llvm/core/value.rb', line 153

def global_parent
  LLVM::Module.from_ptr(C.get_global_parent(self))
end

#kind ⇒ Object

Returns the value’s kind.



54
55
56
 
# File 'lib/llvm/core/value.rb', line 54

def kind
  C.get_value_kind(self)
end

#name ⇒ Object

Returns the value’s name.



90
91
92
 
# File 'lib/llvm/core/value.rb', line 90

def name
  C.get_value_name(self)
end

#name=(str) ⇒ Object

Sets the value’s name to str.



95
96
97
 
# File 'lib/llvm/core/value.rb', line 95

def name=(str)
  C.set_value_name(self, str)
end

#null? ⇒ Boolean

Returns whether the value is null.

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/llvm/core/value.rb', line 116

def null?
  C.is_null(self)
end

#poison? ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
 
# File 'lib/llvm/core/value.rb', line 126

def poison?
  C.is_poison(self)
end

#remove_attribute(attr) ⇒ Object

Removes the given attribute from the function.



142
143
144
145
146
147
148
149
150
 
# File 'lib/llvm/core/value.rb', line 142

def remove_attribute(attr)
  fun = param_parent
  return unless fun

  index = param_index(fun)
  return unless index

  fun.remove_attribute(attr, index)
end

#to_s ⇒ Object 



106
107
108
 
# File 'lib/llvm/core/value.rb', line 106

def to_s
  C.print_value_to_string(self)
end

#type ⇒ Object

Returns the value’s type.



49
50
51
 
# File 'lib/llvm/core/value.rb', line 49

def type
  Type.from_ptr(C.type_of(self), nil)
end

#undef? ⇒ Boolean Also known as: undefined?

Returns whether the value is undefined.

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/llvm/core/value.rb', line 121

def undef?
  C.is_undef(self)
end