Class: LLVM::Builder

Inherits:
Object
  • Object
show all
Defined in:
lib/llvm/core/builder.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Builder

Important: Call #dispose to free backend memory after use.



4
5
6
 
# File 'lib/llvm/core/builder.rb', line 4

def initialize
  @ptr = C.create_builder()
end

Instance Method Details

#add(lhs, rhs, name = "") ⇒ LLVM::Instruction

Integer addition.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



166
167
168
 
# File 'lib/llvm/core/builder.rb', line 166

def add(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_add(self, lhs, rhs, name))
end

#aggregate_ret(*vals) ⇒ LLVM::Instruction

Builds a ret instruction returning multiple values.

Parameters:

Returns:



74
75
76
77
78
79
 
# File 'lib/llvm/core/builder.rb', line 74

def aggregate_ret(*vals)
  FFI::MemoryPointer.new(FFI.type_size(:pointer) * vals.size) do |vals_ptr|
    vals_ptr.write_array_of_pointer(vals)
    Instruction.from_ptr(C.build_aggregate_ret(self, vals_ptr, vals.size))
  end
end

#alloca(ty, name = "") ⇒ LLVM::Instruction

Stack allocation.

Parameters:

  • ty (LLVM::Type, #type) —

    The type or value whose type should be allocad

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



464
465
466
 
# File 'lib/llvm/core/builder.rb', line 464

def alloca(ty, name = "")
  Instruction.from_ptr(C.build_alloca(self, LLVM::Type(ty), name))
end

#and(lhs, rhs, name = "") ⇒ LLVM::Instruction

Returns An integer instruction.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



383
384
385
 
# File 'lib/llvm/core/builder.rb', line 383

def and(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_and(self, lhs, rhs, name))
end

#array_alloca(ty, sz, name = "") ⇒ LLVM::Instruction

Array stack allocation

Parameters:

  • ty (LLVM::Type, #type) —

    The type or value whose type will be the element type of the allocad array

  • sz (LLVM::Value) —

    Unsigned integer representing size of the array

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



475
476
477
 
# File 'lib/llvm/core/builder.rb', line 475

def array_alloca(ty, sz, name = "")
  Instruction.from_ptr(C.build_array_alloca(self, LLVM::Type(ty), sz, name))
end

#array_malloc(ty, sz, name = "") ⇒ LLVM::Instruction

Returns A pointer to the malloced array.

Parameters:

  • ty (LLVM::Type, #type) —

    The type or value whose type will be the element type of the malloced array

  • sz (LLVM::Value) —

    Unsigned integer representing size of the array

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



454
455
456
 
# File 'lib/llvm/core/builder.rb', line 454

def array_malloc(ty, sz, name = "")
  Instruction.from_ptr(C.build_array_malloc(self, LLVM::Type(ty), sz, name))
end

#ashr(lhs, rhs, name = "") ⇒ LLVM::Instruction

Arithmatic shift right.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



374
375
376
 
# File 'lib/llvm/core/builder.rb', line 374

def ashr(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_a_shr(self, lhs, rhs, name))
end

#bit_cast(val, ty, name = "") ⇒ LLVM::Instruction

Cast a value to the given type without changing any bits

Parameters:

  • val (LLVM::Value) —

    The value to cast

  • ty (LLVM::Type, #ty) —

    The target type

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



701
702
703
 
# File 'lib/llvm/core/builder.rb', line 701

def bit_cast(val, ty, name = "")
  Instruction.from_ptr(C.build_bit_cast(self, val, LLVM::Type(ty), name))
end

#br(block) ⇒ LLVM::Instruction

Unconditional branching (i.e. goto)

Parameters:

Returns:



85
86
87
88
89
 
# File 'lib/llvm/core/builder.rb', line 85

def br(block)
  raise "Block must not be nil" if block.nil?
  Instruction.from_ptr(
    C.build_br(self, block))
end

#call(fun, *args) ⇒ Object

Builds a call Instruction. Calls the given Function with the given args (Instructions).

Parameters:



835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/llvm/core/builder.rb', line 835

def call(fun, *args)
  raise "No fun" if fun.nil?
  if args.last.kind_of? String
    name = args.pop
  else
    name = ""
  end

  args_ptr = FFI::MemoryPointer.new(FFI.type_size(:pointer) * args.size)
  args_ptr.write_array_of_pointer(args)
  CallInst.from_ptr(C.build_call(self, fun, args_ptr, args.size, name))
end

#cond(cond, iftrue, iffalse) ⇒ LLVM::Instruction

Conditional branching (i.e. if)

Parameters:

Returns:



107
108
109
110
 
# File 'lib/llvm/core/builder.rb', line 107

def cond(cond, iftrue, iffalse)
  Instruction.from_ptr(
    C.build_cond_br(self, cond, iftrue, iffalse))
end

#dispose ⇒ Object 



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

def dispose
  return if @ptr.nil?
  C.dispose_builder(@ptr)
  @ptr = nil
end

#exact_sdiv(lhs, rhs, name = "") ⇒ LLVM::Instruction

Signed exact division

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



306
307
308
 
# File 'lib/llvm/core/builder.rb', line 306

def exact_sdiv(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_exact_s_div(self, lhs, rhs, name))
end

#extract_element(vector, idx, name = "") ⇒ LLVM::Instruction

Extract an element from a vector

Parameters:

  • vector (LLVM::Value) —

    The vector from which to extract a value

  • idx (LLVM::Value) —

    The index of the element to extract, an unsigned integer

  • name (String) (defaults to: "") —

    The value of the result in LLVM IR

Returns:



870
871
872
 
# File 'lib/llvm/core/builder.rb', line 870

def extract_element(vector, idx, name = "")
  Instruction.from_ptr(C.build_extract_element(self, vector, idx, name))
end

#extract_value(aggregate, idx, name = "") ⇒ LLVM::Instruction

Extract the value of a member field from an aggregate value

Parameters:

  • aggregate (LLVM::Value) —

    An aggregate value

  • idx (LLVM::Value) —

    The index of the member to extract

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



903
904
905
 
# File 'lib/llvm/core/builder.rb', line 903

def extract_value(aggregate, idx, name = "")
  Instruction.from_ptr(C.build_extract_value(self, aggregate, idx, name))
end

#fadd(lhs, rhs, name = "") ⇒ LLVM::Instruction

Returns The floating point sum of the two operands.

Parameters:

  • lhs (LLVM::Value) —

    Floating point or vector of floating points

  • rhs (LLVM::Value) —

    Floating point or vector of floating points

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



195
196
197
 
# File 'lib/llvm/core/builder.rb', line 195

def fadd(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_f_add(self, lhs, rhs, name))
end

#fcmp(pred, lhs, rhs, name = "") ⇒ LLVM::Instruction

Builds an fcmp Instruction. Compares lhs to rhs (Instructions) as Reals using the given symbol predicate (pred):

:ord   - ordered
:uno   - unordered: isnan(X) | isnan(Y)
:oeq   - ordered and equal to
:oeq   - unordered and equal to
:one   - ordered and not equal to
:one   - unordered and not equal to
:ogt   - ordered and greater than
:uge   - unordered and greater than or equal to
:olt   - ordered and less than
:ule   - unordered and less than or equal to
:oge   - ordered and greater than or equal to
:sge   - unordered and greater than or equal to
:ole   - ordered and less than or equal to
:sle   - unordered and less than or equal to
:true  - always true and folded
:false - always false and folded

Parameters:

  • pred (Symbol) —

    A predicate

  • lhs (LLVM::Value) —

    The left hand side of the comparison, of floating point type

  • rhs (LLVM::Value) —

    The right hand side of the comparison, of the same type as lhs

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



809
810
811
 
# File 'lib/llvm/core/builder.rb', line 809

def fcmp(pred, lhs, rhs, name = "")
  Instruction.from_ptr(C.build_f_cmp(self, pred, lhs, rhs, name))
end

#fdiv(lhs, rhs, name = "") ⇒ LLVM::Instruction

Returns The floating point quotient of the two operands.

Parameters:

  • lhs (LLVM::Value) —

    Floating point or vector of floating points

  • rhs (LLVM::Value) —

    Floating point or vector of floating points

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



316
317
318
 
# File 'lib/llvm/core/builder.rb', line 316

def fdiv(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_f_div(self, lhs, rhs, name))
end

#fmul(lhs, rhs, name = "") ⇒ LLVM::Instruction

Floating point multiplication

Parameters:

  • lhs (LLVM::Value) —

    Floating point or vector of floating points

  • rhs (LLVM::Value) —

    Floating point or vector of floating points

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



276
277
278
 
# File 'lib/llvm/core/builder.rb', line 276

def fmul(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_f_mul(self, lhs, rhs, name))
end

#fp2si(val, ty, name = "") ⇒ LLVM::Instruction

Convert a floating point to a signed integer

Parameters:

  • val (LLVM::Value) —

    Floating point or vector of floating points to convert

  • ty (LLVM::Type, #type) —

    Integer or vector of integer target type

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



623
624
625
 
# File 'lib/llvm/core/builder.rb', line 623

def fp2si(val, ty, name = "")
  Instruction.from_ptr(C.build_fp_to_si(self, val, LLVM::Type(ty), name))
end

#fp2ui(val, ty, name = "") ⇒ LLVM::Instruction

Convert a floating point to an unsigned integer

Parameters:

  • val (LLVM::Value) —

    Floating point or vector of floating points to convert

  • ty (LLVM::Type, #type) —

    Integer or vector of integer target type

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



612
613
614
 
# File 'lib/llvm/core/builder.rb', line 612

def fp2ui(val, ty, name = "")
  Instruction.from_ptr(C.build_fp_to_ui(self, val, LLVM::Type(ty), name))
end

#fp_cast(val, ty, name = "") ⇒ LLVM::Instruction

Parameters:

  • val (LLVM::Value)
  • ty (LLVM::Type, #ty)
  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



755
756
757
 
# File 'lib/llvm/core/builder.rb', line 755

def fp_cast(val, ty, name = "")
  Instruction.from_ptr(C.build_fp_cast(self, val, LLVM::Type(ty), name))
end

#fp_ext(val, ty, name = "") ⇒ LLVM::Instruction

Extend a floating point value

Parameters:

  • val (LLVM::Value) —

    Floating point or vector of floating point

  • ty (LLVM::Type, #type) —

    Floating point or vector of floating point type of greater size than val’s type

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



669
670
671
 
# File 'lib/llvm/core/builder.rb', line 669

def fp_ext(val, ty, name = "")
  Instruction.from_ptr(C.build_fp_ext(self, val, LLVM::Type(ty), name))
end

#fp_trunc(val, ty, name = "") ⇒ LLVM::Instruction

Truncate a floating point value

Parameters:

  • val (LLVM::Value) —

    Floating point or vector of floating point

  • ty (LLVM::Type, #type) —

    Floating point or vector of floating point type of lesser size than val’s type

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



658
659
660
 
# File 'lib/llvm/core/builder.rb', line 658

def fp_trunc(val, ty, name = "")
  Instruction.from_ptr(C.build_fp_trunc(self, val, LLVM::Type(ty), name))
end

#free(ptr) ⇒ LLVM::Instruction

Returns The result of the free instruction.

Parameters:

Returns:



481
482
483
 
# File 'lib/llvm/core/builder.rb', line 481

def free(ptr)
  Instruction.from_ptr(C.build_free(self, ptr))
end

#frem(lhs, rhs, name = "") ⇒ LLVM::Instruction

Returns The floating point remainder.

Parameters:

  • lhs (LLVM::Value) —

    Floating point or vector of floating points

  • rhs (LLVM::Value) —

    Floating point or vector of floating points

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



345
346
347
 
# File 'lib/llvm/core/builder.rb', line 345

def frem(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_f_rem(self, lhs, rhs, name))
end

#fsub(lhs, rhs, name = "") ⇒ LLVM::Instruction

Returns The floating point difference of the two operands.

Parameters:

  • lhs (LLVM::Value) —

    Floating point or vector of floating points

  • rhs (LLVM::Value) —

    Floating point or vector of floating points

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



235
236
237
 
# File 'lib/llvm/core/builder.rb', line 235

def fsub(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_f_sub(self, lhs, rhs, name))
end

#gep(ptr, indices, name = "") ⇒ LLVM::Instruction

Obtain a pointer to the element at the given indices

Parameters:

  • ptr (LLVM::Value) —

    A pointer to an aggregate value

  • indices (Array<LLVM::Value>) —

    Ruby array of LLVM::Value representing indices into the aggregate

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:

See Also:



513
514
515
516
517
518
519
520
 
# File 'lib/llvm/core/builder.rb', line 513

def gep(ptr, indices, name = "")
  indices = Array(indices)
  FFI::MemoryPointer.new(FFI.type_size(:pointer) * indices.size) do |indices_ptr|
    indices_ptr.write_array_of_pointer(indices)
    return Instruction.from_ptr(
      C.build_gep(self, ptr, indices_ptr, indices.size, name))
  end
end

#global_string(string, name = "") ⇒ LLVM::Instruction

Creates a global string initialized to a given value.

Parameters:

  • string (String) —

    The string used by the initialize

  • name (Name) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



557
558
559
 
# File 'lib/llvm/core/builder.rb', line 557

def global_string(string, name = "")
  Instruction.from_ptr(C.build_global_string(self, string, name))
end

#global_string_pointer(string, name = "") ⇒ LLVM::Instruction

Creates a pointer to a global string initialized to a given value.

Parameters:

  • string (String) —

    The string used by the initializer

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



565
566
567
 
# File 'lib/llvm/core/builder.rb', line 565

def global_string_pointer(string, name = "")
  Instruction.from_ptr(C.build_global_string_ptr(self, string, name))
end

#ibr(addr, num_dests) ⇒ LLVM::Instruction

Indirect branching (i.e. computed goto)

Parameters:

  • addr (LLVM::BasicBlock) —

    Where to jump

  • num_dests (Integer) —

    Number of possible destinations to be added

Returns:



96
97
98
99
 
# File 'lib/llvm/core/builder.rb', line 96

def ibr(addr, num_dests)
  IndirectBr.from_ptr(
    C.build_indirect_br(self, addr, num_dests))
end

#icmp(pred, lhs, rhs, name = "") ⇒ LLVM::Instruction

Builds an icmp Instruction. Compares lhs to rhs (Instructions) using the given symbol predicate (pred):

:eq  - equal to
:ne  - not equal to
:ugt - unsigned greater than
:uge - unsigned greater than or equal to
:ult - unsigned less than
:ule - unsigned less than or equal to
:sgt - signed greater than
:sge - signed greater than or equal to
:slt - signed less than
:sle - signed less than or equal to

Parameters:

  • pred (Symbol) —

    A predicate

  • lhs (LLVM::Value) —

    The left hand side of the comparison, of integer or pointer type

  • rhs (LLVM::Value) —

    The right hand side of the comparison, of the same type as lhs

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



779
780
781
 
# File 'lib/llvm/core/builder.rb', line 779

def icmp(pred, lhs, rhs, name = "")
  Instruction.from_ptr(C.build_i_cmp(self, pred, lhs, rhs, name))
end

#inbounds_gep(ptr, indices, name = "") ⇒ LLVM::Instruction

Builds a inbounds getelementptr instruction. If the indices are outside the allocated pointer the value is undefined.

Parameters:

  • ptr (LLVM::Value) —

    A pointer to an aggregate value

  • indices (Array<LLVM::Value>) —

    Ruby array of LLVM::Value representing indices into the aggregate

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:

See Also:



531
532
533
534
535
536
537
538
 
# File 'lib/llvm/core/builder.rb', line 531

def inbounds_gep(ptr, indices, name = "")
  indices = Array(indices)
  FFI::MemoryPointer.new(FFI.type_size(:pointer) * indices.size) do |indices_ptr|
    indices_ptr.write_array_of_pointer(indices)
    return Instruction.from_ptr(
      C.build_in_bounds_gep(self, ptr, indices_ptr, indices.size, name))
  end
end

#insert_block ⇒ LLVM::BasicBlock

The BasicBlock at which the Builder is currently positioned.

Returns:



53
54
55
 
# File 'lib/llvm/core/builder.rb', line 53

def insert_block
  BasicBlock.from_ptr(C.get_insert_block(self))
end

#insert_element(vector, elem, idx, name = "") ⇒ LLVM::Instruction

Insert an element into a vector

Parameters:

  • vector (LLVM::Value) —

    The vector into which to insert the element

  • elem (LLVM::Value) —

    The element to be inserted into the vector

  • idx (LLVM::Value) —

    The index at which to insert the element

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



881
882
883
 
# File 'lib/llvm/core/builder.rb', line 881

def insert_element(vector, elem, idx, name = "")
  Instruction.from_ptr(C.build_insert_element(self, vector, elem, idx, name))
end

#insert_value(aggregate, elem, idx, name = "") ⇒ LLVM::Instruction

Insert a value into an aggregate value’s member field

Parameters:

  • aggregate (LLVM::Value) —

    An aggregate value

  • elem (LLVM::Value) —

    The value to insert into ‘aggregate’

  • idx (LLVM::Value) —

    The index at which to insert the value

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



914
915
916
 
# File 'lib/llvm/core/builder.rb', line 914

def insert_value(aggregate, elem, idx, name = "")
  Instruction.from_ptr(C.build_insert_value(self, aggregate, elem, idx, name))
end

#int2ptr(val, ty, name = "") ⇒ LLVM::Instruction

Cast an int to a pointer

Parameters:

  • val (LLVM::Value) —

    An integer value

  • ty (LLVM::Type, #ty) —

    A pointer type

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



691
692
693
 
# File 'lib/llvm/core/builder.rb', line 691

def int2ptr(val, ty, name = "")
  Instruction.from_ptr(C.build_int_to_ptr(self, val, LLVM::Type(ty), name))
end

#int_cast(val, ty, name = "") ⇒ LLVM::Instruction

Parameters:

  • val (LLVM::Value)
  • ty (LLVM::Type, #ty)
  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



747
748
749
 
# File 'lib/llvm/core/builder.rb', line 747

def int_cast(val, ty, name = "")
  Instruction.from_ptr(C.build_int_cast(self, val, LLVM::Type(ty), name))
end

#invoke(fun, args, normal, exception, name = "") ⇒ LLVM::Instruction

Invoke a function which may potentially unwind

Parameters:

Returns:

  • (LLVM::Instruction) —

    The value returned by ‘fun’, unless an unwind instruction occurs



136
137
138
139
140
141
142
143
144
 
# File 'lib/llvm/core/builder.rb', line 136

def invoke(fun, args, normal, exception, name = "")
  s = args.size
  FFI::MemoryPointer.new(FFI.type_size(:pointer) * s) do |args_ptr|
    args_ptr.write_array_of_pointer(args)
    return Instruction.from_ptr(
      C.build_invoke(self,
        fun, args_ptr, s, normal, exception, name))
  end
end

#is_not_null(val, name = "") ⇒ LLVM::Instruction

Check if a value is not null

Parameters:

  • val (LLVM::Value) —

    The value to check

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



930
931
932
 
# File 'lib/llvm/core/builder.rb', line 930

def is_not_null(val, name = "")
  Instruction.from_ptr(C.build_is_not_null(self, val, name))
end

#is_null(val, name = "") ⇒ LLVM::Instruction

Check if a value is null

Parameters:

  • val (LLVM::Value) —

    The value to check

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



922
923
924
 
# File 'lib/llvm/core/builder.rb', line 922

def is_null(val, name = "")
  Instruction.from_ptr(C.build_is_null(self, val, name))
end

#load(ptr, name = "") ⇒ LLVM::Instruction

Load the value of a given pointer

Parameters:

  • ptr (LLVM::Value) —

    The pointer to be loaded

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:

  • (LLVM::Instruction) —

    The result of the load operation. Represents a value of the pointer’s type.



491
492
493
 
# File 'lib/llvm/core/builder.rb', line 491

def load(ptr, name = "")
  Instruction.from_ptr(C.build_load(self, ptr, name))
end

#lshr(lhs, rhs, name = "") ⇒ LLVM::Instruction

Shifts right with zero fill.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



364
365
366
 
# File 'lib/llvm/core/builder.rb', line 364

def lshr(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_l_shr(self, lhs, rhs, name))
end

#malloc(ty, name = "") ⇒ LLVM::Instruction

Returns A pointer to the malloced bytes.

Parameters:

  • ty (LLVM::Type, #type) —

    The type or value whose type should be malloced

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



445
446
447
 
# File 'lib/llvm/core/builder.rb', line 445

def malloc(ty, name = "")
  Instruction.from_ptr(C.build_malloc(self, LLVM::Type(ty), name))
end

#mul(lhs, rhs, name = "") ⇒ LLVM::Instruction

Integer multiplication.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



245
246
247
 
# File 'lib/llvm/core/builder.rb', line 245

def mul(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_mul(self, lhs, rhs, name))
end

#neg(arg, name = "") ⇒ LLVM::Instruction

Integer negation. Implemented as a shortcut to the equivalent sub

instruction.

Parameters:

  • arg (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



411
412
413
 
# File 'lib/llvm/core/builder.rb', line 411

def neg(arg, name = "")
  Instruction.from_ptr(C.build_neg(self, arg, name))
end

#not(arg, name = "") ⇒ LLVM::Instruction

Boolean negation.

Parameters:

  • arg (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



437
438
439
 
# File 'lib/llvm/core/builder.rb', line 437

def not(arg, name = "")
  Instruction.from_ptr(C.build_not(self, arg, name))
end

#nsw_add(lhs, rhs, name = "") ⇒ LLVM::Instruction

“No signed wrap” integer addition.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



176
177
178
 
# File 'lib/llvm/core/builder.rb', line 176

def nsw_add(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_nsw_add(self, lhs, rhs, name))
end

#nsw_mul(lhs, rhs, name = "") ⇒ LLVM::Instruction

“No signed wrap” integer multiplication.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



255
256
257
 
# File 'lib/llvm/core/builder.rb', line 255

def nsw_mul(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_nsw_mul(self, lhs, rhs, name))
end

#nsw_neg(arg, name = "") ⇒ LLVM::Instruction

“No signed wrap” integer negation.

Parameters:

  • arg (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



420
421
422
 
# File 'lib/llvm/core/builder.rb', line 420

def nsw_neg(arg, name = "")
  Instruction.from_ptr(C.build_nsw_neg(self, arg, name))
end

#nsw_sub(lhs, rhs, name = "") ⇒ LLVM::Instruction

No signed wrap integer subtraction.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



215
216
217
 
# File 'lib/llvm/core/builder.rb', line 215

def nsw_sub(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_nsw_sub(self, lhs, rhs, name))
end

#nuw_add(lhs, rhs, name = "") ⇒ LLVM::Instruction

“No unsigned wrap” integer addition.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



186
187
188
 
# File 'lib/llvm/core/builder.rb', line 186

def nuw_add(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_nuw_add(self, lhs, rhs, name))
end

#nuw_mul(lhs, rhs, name = "") ⇒ LLVM::Instruction

“No unsigned wrap” integer multiplication.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



265
266
267
 
# File 'lib/llvm/core/builder.rb', line 265

def nuw_mul(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_nuw_mul(self, lhs, rhs, name))
end

#nuw_neg(arg, name = "") ⇒ LLVM::Instruction

“No unsigned wrap” integer negation.

Parameters:

  • arg (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



429
430
431
 
# File 'lib/llvm/core/builder.rb', line 429

def nuw_neg(arg, name = "")
  Instruction.from_ptr(C.build_nuw_neg(self, arg, name))
end

#nuw_sub(lhs, rhs, name = "") ⇒ LLVM::Instruction

No unsigned wrap integer subtraction.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



225
226
227
 
# File 'lib/llvm/core/builder.rb', line 225

def nuw_sub(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_nuw_sub(self, lhs, rhs, name))
end

#or(lhs, rhs, name = "") ⇒ LLVM::Instruction

Returns An integer instruction.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



392
393
394
 
# File 'lib/llvm/core/builder.rb', line 392

def or(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_or(self, lhs, rhs, name))
end

#phi(ty, incoming, name = "") ⇒ LLVM::Instruction

Build a Phi node of the given type with the given incoming branches

Parameters:

  • ty (LLVM::Type) —

    Specifies the result type

  • incoming (Hash{LLVM::BasicBlock => LLVM::Value}) —

    A hash mapping basic blocks to a corresponding value. If the phi node is jumped to from a given basic block, the phi instruction takes on its corresponding value.

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



822
823
824
825
826
 
# File 'lib/llvm/core/builder.rb', line 822

def phi(ty, incoming, name = "")
  phi = Phi.from_ptr(C.build_phi(self, LLVM::Type(ty), name))
  phi.add_incoming(incoming)
  phi
end

#pointer_cast(val, ty, name = "") ⇒ LLVM::Instruction

Parameters:

  • val (LLVM::Value)
  • ty (LLVM::Type, #ty)
  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



739
740
741
 
# File 'lib/llvm/core/builder.rb', line 739

def pointer_cast(val, ty, name = "")
  Instruction.from_ptr(C.build_pointer_cast(self, val, LLVM::Type(ty), name))
end

#position(block, instruction) ⇒ LLVM::Builder

Position the builder at the given Instruction within the given BasicBlock.

Parameters:

Returns:



24
25
26
27
28
 
# File 'lib/llvm/core/builder.rb', line 24

def position(block, instruction)
  raise "Block must not be nil" if block.nil?
  C.position_builder(self, block, instruction)
  self
end

#position_at_end(block) ⇒ LLVM::Builder

Positions the builder at the end of the given BasicBlock.

Parameters:

Returns:



44
45
46
47
48
 
# File 'lib/llvm/core/builder.rb', line 44

def position_at_end(block)
  raise "Block must not be nil" if block.nil?
  C.position_builder_at_end(self, block)
  self
end

#position_before(instruction) ⇒ LLVM::Builder

Positions the builder before the given Instruction.

Parameters:

Returns:



34
35
36
37
38
 
# File 'lib/llvm/core/builder.rb', line 34

def position_before(instruction)
  raise "Instruction must not be nil" if instruction.nil?
  C.position_builder_before(self, instruction)
  self
end

#ptr2int(val, ty, name = "") ⇒ LLVM::Instruction

Cast a pointer to an int. Useful for pointer arithmetic.

Parameters:

  • val (LLVM::Value) —

    A pointer

  • ty (LLVM::Type, #type) —

    An integer type

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:

  • (LLVM::Instruction) —

    An integer of the given type representing the pointer’s address



680
681
682
 
# File 'lib/llvm/core/builder.rb', line 680

def ptr2int(val, ty, name = "")
  Instruction.from_ptr(C.build_ptr_to_int(self, val, LLVM::Type(ty), name))
end

#ptr_diff(lhs, rhs, name = "") ⇒ LLVM::Instruction

Calculate the difference between two pointers

Parameters:

  • lhs (LLVM::Value) —

    A pointer

  • rhs (LLVM::Value) —

    A pointer

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



940
941
942
 
# File 'lib/llvm/core/builder.rb', line 940

def ptr_diff(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_ptr_diff(lhs, rhs, name))
end

#ret(val) ⇒ LLVM::Instruction

Parameters:

Returns:



66
67
68
 
# File 'lib/llvm/core/builder.rb', line 66

def ret(val)
  Instruction.from_ptr(C.build_ret(self, val))
end

#ret_void ⇒ LLVM::Instruction

Returns:



59
60
61
 
# File 'lib/llvm/core/builder.rb', line 59

def ret_void
  Instruction.from_ptr(C.build_ret_void(self))
end

#sdiv(lhs, rhs, name = "") ⇒ LLVM::Instruction

Signed division

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



296
297
298
 
# File 'lib/llvm/core/builder.rb', line 296

def sdiv(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_s_div(self, lhs, rhs, name))
end

#select(_if, _then, _else, name = "") ⇒ LLVM::Instruction

Return a value based on a condition. This differs from ‘cond’ in that its operands are values rather than basic blocks. As a consequence, both arguments must be evaluated.

Parameters:

  • _if (LLVM::Value) —

    An i1 or a vector of i1

  • _then (LLVM::Value) —

    A value or vector of the same arity as _if

  • _else (LLVM::Value) —

    A value or vector of values of the same arity as _if, and of the same type as _then

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



859
860
861
 
# File 'lib/llvm/core/builder.rb', line 859

def select(_if, _then, _else, name = "")
  Instruction.from_ptr(C.build_select(self, _if, _then, _else, name))
end

#sext(val, ty, name = "") ⇒ LLVM::Instruction

Sign extension by copying the sign bit (highest order bit) of the value until it reaches the bit size of the given type.

Parameters:

  • val (LLVM::Value) —

    Integer or vector of integers to be extended

  • ty (LLVM::Type) —

    Integer or vector of integer type of greater size than the size of val

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



601
602
603
 
# File 'lib/llvm/core/builder.rb', line 601

def sext(val, ty, name = "")
  Instruction.from_ptr(C.build_s_ext(self, val, LLVM::Type(ty), name))
end

#sext_or_bit_cast(val, ty, name = "") ⇒ LLVM::Instruction

Parameters:

  • val (LLVM::Value)
  • ty (LLVM::Type, #ty)
  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



721
722
723
 
# File 'lib/llvm/core/builder.rb', line 721

def sext_or_bit_cast(val, ty, name = "")
  Instruction.from_ptr(C.build_s_ext_or_bit_cast(self, val, LLVM::Type(ty), name))
end

#shl(lhs, rhs, name = "") ⇒ LLVM::Instruction

Returns An integer instruction.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



354
355
356
 
# File 'lib/llvm/core/builder.rb', line 354

def shl(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_shl(self, lhs, rhs, name))
end

#shuffle_vector(vec1, vec2, mask, name = "") ⇒ LLVM::Instruction

Shuffle two vectors according to a given mask

Parameters:

  • vec1 (LLVM::Value) —

    A vector

  • vec2 (LLVM::Value) —

    A vector of the same type and arity as vec1

  • mask (LLVM::Value) —

    A vector of i1 of the same arity as vec1 and vec2

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



893
894
895
 
# File 'lib/llvm/core/builder.rb', line 893

def shuffle_vector(vec1, vec2, mask, name = "")
  Instruction.from_ptr(C.build_shuffle_vector(self, vec1, vec2, mask, name))
end

#si2fp(val, ty, name = "") ⇒ LLVM::Instruction

Convert a signed integer to a floating point

Parameters:

  • val (LLVM::Value) —

    Signed integer or vector of signed integer to convert

  • ty (LLVM::Type, #type) —

    Floating point or vector of floating point target type

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



647
648
649
 
# File 'lib/llvm/core/builder.rb', line 647

def si2fp(val, ty, name = "")
  Instruction.from_ptr(C.build_si_to_fp(self, val, LLVM::Type(ty), name))
end

#srem(lhs, rhs, name = "") ⇒ LLVM::Instruction

Signed remainder

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



336
337
338
 
# File 'lib/llvm/core/builder.rb', line 336

def srem(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_s_rem(self, lhs, rhs, name))
end

#store(val, ptr) ⇒ LLVM::Instruction

Store a value at a given pointer

Parameters:

Returns:



500
501
502
503
 
# File 'lib/llvm/core/builder.rb', line 500

def store(val, ptr)
  raise "val must be a Value, got #{val.class.name}" unless Value === val
  Instruction.from_ptr(C.build_store(self, val, ptr))
end

#struct_gep(pointer, idx, name = "") ⇒ LLVM::Instruction

Builds a struct getelementptr Instruction.

Parameters:

  • pointer (LLVM::Value) —

    A pointer to a structure

  • idx (LLVM::Value) —

    Unsigned integer representing the index of a structure member

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:

See Also:



549
550
551
 
# File 'lib/llvm/core/builder.rb', line 549

def struct_gep(pointer, idx, name = "")
  Instruction.from_ptr(C.build_struct_gep(self, pointer, idx, name))
end

#sub(lhs, rhs, name = "") ⇒ LLVM::Instruction

Integer subtraction.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



205
206
207
 
# File 'lib/llvm/core/builder.rb', line 205

def sub(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_sub(self, lhs, rhs, name))
end

#switch(val, default, cases) ⇒ LLVM::Instruction

Parameters:

Returns:



119
120
121
122
123
124
125
 
# File 'lib/llvm/core/builder.rb', line 119

def switch(val, default, cases)
  inst = SwitchInst.from_ptr(C.build_switch(self, val, default, cases.size))
  cases.each do |(c, block)|
    inst.add_case(c, block)
  end
  inst
end

#to_ptr ⇒ Object 



15
16
17
 
# File 'lib/llvm/core/builder.rb', line 15

def to_ptr
  @ptr
end

#trunc(val, ty, name = "") ⇒ LLVM::Instruction

Truncates its operand to the given type. The size of the value type must be greater than the size of the target type.

Parameters:

  • val (LLVM::Value) —

    Integer or vector of integers to be truncated

  • ty (LLVM::Type, #type) —

    Integer or vector of integers of equal size to val

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



577
578
579
 
# File 'lib/llvm/core/builder.rb', line 577

def trunc(val, ty, name = "")
  Instruction.from_ptr(C.build_trunc(self, val, LLVM::Type(ty), name))
end

#trunc_or_bit_cast(val, ty, name = "") ⇒ LLVM::Instruction

Parameters:

  • val (LLVM::Value)
  • ty (LLVM::Type, #ty)
  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



731
732
733
 
# File 'lib/llvm/core/builder.rb', line 731

def trunc_or_bit_cast(val, ty, name = "")
  Instruction.from_ptr(C.build_trunc_or_bit_cast(self, val, LLVM::Type(ty), name))
end

#udiv(lhs, rhs, name = "") ⇒ LLVM::Instruction

Unsigned integer division

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



286
287
288
 
# File 'lib/llvm/core/builder.rb', line 286

def udiv(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_u_div(self, lhs, rhs, name))
end

#ui2fp(val, ty, name = "") ⇒ LLVM::Instruction

Convert an unsigned integer to a floating point

Parameters:

  • val (LLVM::Value) —

    Unsigned integer or vector of unsigned integer to convert

  • ty (LLVM::Type, #type) —

    Floating point or vector of floating point target type

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



635
636
637
 
# File 'lib/llvm/core/builder.rb', line 635

def ui2fp(val, ty, name = "")
  Instruction.from_ptr(C.build_ui_to_fp(self, val, LLVM::Type(ty), name))
end

#unreachable ⇒ LLVM::Instruction

Generates an instruction with no defined semantics. Can be used to provide hints to the optimizer.

Returns:



156
157
158
 
# File 'lib/llvm/core/builder.rb', line 156

def unreachable
  Instruction.from_ptr(C.build_unreachable(self))
end

#unwind ⇒ Object

Builds an unwind Instruction.



148
149
150
 
# File 'lib/llvm/core/builder.rb', line 148

def unwind
  Instruction.from_ptr(C.build_unwind(self))
end

#urem(lhs, rhs, name = "") ⇒ LLVM::Instruction

Unsigned remainder

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



326
327
328
 
# File 'lib/llvm/core/builder.rb', line 326

def urem(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_u_rem(self, lhs, rhs, name))
end

#xor(lhs, rhs, name = "") ⇒ LLVM::Instruction

Returns An integer instruction.

Parameters:

  • lhs (LLVM::Value) —

    Integer or vector of integers

  • rhs (LLVM::Value) —

    Integer or vector of integers

  • name (String) (defaults to: "") —

    Name of the result in LLVM IR

Returns:



401
402
403
 
# File 'lib/llvm/core/builder.rb', line 401

def xor(lhs, rhs, name = "")
  Instruction.from_ptr(C.build_xor(self, lhs, rhs, name))
end

#zext(val, ty, name = "") ⇒ LLVM::Instruction

Zero extends its operand to the given type. The size of the value type must be greater than the size of the target type.

Parameters:

  • val (LLVM::Value) —

    Integer or vector of integers to be extended

  • ty (LLVM::Type, #type) —

    Integer or vector of integer type of greater size than val

  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



589
590
591
 
# File 'lib/llvm/core/builder.rb', line 589

def zext(val, ty, name = "")
  Instruction.from_ptr(C.build_z_ext(self, val, LLVM::Type(ty), name))
end

#zext_or_bit_cast(val, ty, name = "") ⇒ LLVM::Instruction

Parameters:

  • val (LLVM::Value)
  • ty (LLVM::Type, #ty)
  • name (String) (defaults to: "") —

    The name of the result in LLVM IR

Returns:



711
712
713
 
# File 'lib/llvm/core/builder.rb', line 711

def zext_or_bit_cast(val, ty, name = "")
  Instruction.from_ptr(C.build_z_ext_or_bit_cast(self, val, LLVM::Type(ty), name))
end