ruby-llvm 13.0.1 → 13.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4728b4463e1ffaea0e8b00c976923fe77404b01c55ff3c25b015aa2fef5decf
-  data.tar.gz: 35e6017a7035f29b9a39cfd6cbf18116a181f9e2706b12c0318a251525250bc7
+  metadata.gz: 84318238934c7be3357466dfcda5fdf52b587164a4756f1663a749edd3754964
+  data.tar.gz: 2fee5d96b91ebe3edf7d835c4cbe5111e1d9ce8fa63042a32123b506cb65085d
 SHA512:
-  metadata.gz: 5353f3dfc22fcaa701ffa5bc70d5987e03a678881ad03a530ed99f4baada579396c9d8720a999cb9fff9fb93d4efad13fb2cd4ed6486b9a0658f54ad5676f663
-  data.tar.gz: 95cbae2bfda937b9d8eb1a821083bc04858a3e19942ffbf8c195671f51f817d17be2829c51015e3bcd9b699eb467e9dca127e0ff0bb743a2f76288180014846d
+  metadata.gz: 5e03ffebe80a650098d8974ea5b218a727b3f165400cd797bc1d3e652d10cb06f4a621310917e6ee9011b31f4b3ab2dfe215165373c666e78b5d68c8e15703e6
+  data.tar.gz: bd40aa282aeac16fe3e189c05ab26db1230af73f7b536803e218f1d78a86087fe6f4389e3dfe4ae66eab4fdc7a4417dd712bd2449c6c12b77efd1d99bfffc7a3

data/lib/llvm/core/builder.rb

@@ -24,7 +24,10 @@ module LLVM
     # @param  [LLVM::Instruction] instruction
     # @return [LLVM::Builder]
     def position(block, instruction)
-      raise "Block must not be nil" if block.nil?
+      raise ArgumentError, "Block must be LLVM::BasicBlock" if !block.is_a?(LLVM::BasicBlock)
+
+      raise ArgumentError, "Instruction must be LLVM::Instruction" if !instruction.is_a?(LLVM::Instruction)
+
       C.position_builder(self, block, instruction)
       self
     end
@@ -34,7 +37,8 @@ module LLVM
     # @param  [LLVM::Instruction] instruction
     # @return [LLVM::Builder]
     def position_before(instruction)
-      raise "Instruction must not be nil" if instruction.nil?
+      raise ArgumentError, "Instruction must be LLVM::Instruction" if !instruction.is_a?(LLVM::Instruction)
+
       C.position_builder_before(self, instruction)
       self
     end
@@ -44,7 +48,8 @@ module LLVM
     # @param  [LLVM::BasicBlock] block
     # @return [LLVM::Builder]
     def position_at_end(block)
-      raise "Block must not be nil" if block.nil?
+      raise ArgumentError, "Block must be LLVM::BasicBlock" if !block.is_a?(LLVM::BasicBlock)
+
       C.position_builder_at_end(self, block)
       self
     end
@@ -65,7 +70,11 @@ module LLVM
     # @param [LLVM::Value] val The value to return
     # @return [LLVM::Instruction]
     # @LLVMinst ret
-    def ret(val)
+    def ret(val = nil)
+      unless [LLVM::Value, NilClass].any? { |c| val.is_a?(c) }
+        raise ArgumentError, "Trying to build LLVM ret with non-value: #{val.inspect}"
+      end
+
       Instruction.from_ptr(C.build_ret(self, val))
     end
 
@@ -85,7 +94,8 @@ module LLVM
     # @return [LLVM::Instruction]
     # @LLVMinst br
     def br(block)
-      raise "Block must not be nil" if block.nil?
+      raise ArgumentError, "Trying to build LLVM br with non-block: #{block.inspect}" if !block.is_a?(LLVM::BasicBlock)
+
       Instruction.from_ptr(
         C.build_br(self, block))
     end
@@ -107,8 +117,31 @@ module LLVM
     # @return [LLVM::Instruction]
     # @LLVMinst br
     def cond(cond, iftrue, iffalse)
+      raise ArgumentError, "Trying to build LLVM cond br with non-block (true branch): #{iftrue.inspect}" if !iftrue.is_a?(LLVM::BasicBlock)
+
+      raise ArgumentError, "Trying to build LLVM cond br with non-block (false branch): #{iffalse.inspect}" if !iffalse.is_a?(LLVM::BasicBlock)
+
+      cond2 = cond_condition(cond)
+
       Instruction.from_ptr(
-        C.build_cond_br(self, cond, iftrue, iffalse))
+        C.build_cond_br(self, cond2, iftrue, iffalse))
+    end
+
+    private def cond_condition(cond) # rubocop:disable Style/AccessModifierDeclarations
+      case cond
+      when LLVM::Value
+        cond_type = cond.type
+        if (cond_type.kind != :integer) || (cond_type.width != 1)
+          raise ArgumentError, "Trying to build LLVM cond br with non-i1 condition: #{cond_type}"
+        end
+        cond
+      when true
+        LLVM::Int1.from_i(1)
+      when false
+        LLVM::Int1.from_i(0)
+      else
+        raise ArgumentError, "Trying to build LLVM cond br with non-value condition: #{cond.inspect}"
+      end
     end
 
     # @LLVMinst switch
@@ -835,7 +868,8 @@ module LLVM
     # @param [LLVM::Instruction]
     # @LLVMinst call
     def call(fun, *args)
-      raise "No fun" if fun.nil?
+      raise ArgumentError, "Trying to build LLVM call with non-function: #{fun.inspect}" if !fun.is_a?(LLVM::Function)
+
       if args.last.kind_of? String
         name = args.pop
       else
@@ -870,6 +904,10 @@ module LLVM
     # @return [LLVM::Instruction] The extracted element
     # @LLVMinst extractelement
     def extract_element(vector, idx, name = "")
+      error = element_error(vector, idx)
+
+      raise ArgumentError, "Error building extract_element with #{error}" if error
+
       Instruction.from_ptr(C.build_extract_element(self, vector, idx, name))
     end
 
@@ -881,9 +919,27 @@ module LLVM
     # @return [LLVM::Instruction] A vector the same type as 'vector'
     # @LLVMinst insertelement
     def insert_element(vector, elem, idx, name = "")
+      error = element_error(vector, idx)
+
+      error ||= if !elem.is_a?(LLVM::Value)
+        "elem: #{elem.inspect}"
+      end
+
+      raise ArgumentError, "Error building insert_element with #{error}" if error
+
       Instruction.from_ptr(C.build_insert_element(self, vector, elem, idx, name))
     end
 
+    private def element_error(vector, idx) # rubocop:disable Style/AccessModifierDeclarations
+      if !vector.is_a?(LLVM::Value)
+        "non-value: #{vector.inspect}"
+      elsif vector.type.kind != :vector
+        "non-vector: #{vector.type.kind}"
+      elsif !idx.is_a?(LLVM::Value)
+        "index: #{idx}"
+      end
+    end
+
     # Shuffle two vectors according to a given mask
     # @param [LLVM::Value] vec1 A vector
     # @param [LLVM::Value] vec2 A vector of the same type and arity as vec1
@@ -898,25 +954,47 @@ module LLVM
 
     # Extract the value of a member field from an aggregate value
     # @param [LLVM::Value] aggregate An aggregate value
-    # @param [LLVM::Value] idx The index of the member to extract
+    # @param [Integer] idx The index of the member to extract
     # @param [String] name The name of the result in LLVM IR
     # @return [LLVM::Instruction] The extracted value
     # @LLVMinst extractvalue
     def extract_value(aggregate, idx, name = "")
+      error = value_error(aggregate, idx)
+
+      raise ArgumentError, "Error building extract_value with #{error}" if error
+
       Instruction.from_ptr(C.build_extract_value(self, aggregate, idx, name))
     end
 
     # Insert a value into an aggregate value's member field
     # @param [LLVM::Value] aggregate An aggregate value
     # @param [LLVM::Value] elem The value to insert into 'aggregate'
-    # @param [LLVM::Value] idx The index at which to insert the value
+    # @param [Integer] idx The index at which to insert the value
     # @param [String] name The name of the result in LLVM IR
     # @return [LLVM::Instruction] An aggregate value of the same type as 'aggregate'
     # @LLVMinst insertvalue
     def insert_value(aggregate, elem, idx, name = "")
+      error = value_error(aggregate, idx)
+
+      error ||= if !elem.is_a?(LLVM::Value)
+        "elem: #{elem.inspect}"
+      end
+
+      raise ArgumentError, "Error building insert_value with #{error}" if error
+
       Instruction.from_ptr(C.build_insert_value(self, aggregate, elem, idx, name))
     end
 
+    private def value_error(aggregate, idx) # rubocop:disable Style/AccessModifierDeclarations
+      if !aggregate.is_a?(LLVM::Value)
+        "non-value: #{aggregate.inspect}"
+      elsif !aggregate.type.aggregate?
+        "non-aggregate: #{aggregate.type.kind}"
+      elsif !idx.is_a?(Integer) || idx.negative?
+        "index: #{idx}"
+      end
+    end
+
     # Check if a value is null
     # @param [LLVM::Value] val The value to check
     # @param [String] name The name of the result in LLVM IR

data/lib/llvm/core/type.rb

@@ -66,6 +66,10 @@ module LLVM
       C.print_type_to_string(self)
     end
 
+    def aggregate?
+      [:struct, :array].include?(kind)
+    end
+
     # Creates an array type of Type with the given size.
     def self.array(ty, sz = 0)
       from_ptr(C.array_type(LLVM::Type(ty), sz), :array)

data/lib/llvm/version.rb

@@ -3,5 +3,5 @@
 module LLVM
   LLVM_VERSION = "13"
   LLVM_REQUIRED_VERSION = "13.0"
-  RUBY_LLVM_VERSION = "13.0.1"
+  RUBY_LLVM_VERSION = "13.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-llvm
 version: !ruby/object:Gem::Version
-  version: 13.0.1
+  version: 13.0.2
 platform: ruby
 authors:
 - Jesse Johnson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -65,42 +65,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.14.1
+        version: 5.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.14.1
+        version: 5.15.0
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.1
+        version: 1.30.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.1
+        version: 1.30.0
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -203,44 +203,17 @@ files:
 - lib/llvm/transforms/vectorize.rb
 - lib/llvm/transforms/vectorize_ffi.rb
 - lib/llvm/version.rb
-- test/array_test.rb
-- test/basic_block_test.rb
-- test/binary_operations_test.rb
-- test/bitcode_test.rb
-- test/branch_test.rb
-- test/call_test.rb
-- test/comparisons_test.rb
-- test/conversions_test.rb
-- test/double_test.rb
-- test/equality_test.rb
-- test/function_test.rb
-- test/generic_value_test.rb
-- test/instruction_test.rb
-- test/integer_test.rb
-- test/ipo_test.rb
-- test/linker_test.rb
-- test/mcjit_test.rb
-- test/memory_access_test.rb
-- test/module_test.rb
-- test/parameter_collection_test.rb
-- test/pass_manager_builder_test.rb
-- test/phi_test.rb
-- test/select_test.rb
-- test/struct_test.rb
-- test/target_test.rb
-- test/test_helper.rb
-- test/type_test.rb
-- test/vector_test.rb
 homepage: http://github.com/ruby-llvm/ruby-llvm
 licenses: []
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -249,36 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: LLVM bindings for Ruby
-test_files:
-- test/double_test.rb
-- test/type_test.rb
-- test/basic_block_test.rb
-- test/struct_test.rb
-- test/array_test.rb
-- test/vector_test.rb
-- test/instruction_test.rb
-- test/ipo_test.rb
-- test/branch_test.rb
-- test/binary_operations_test.rb
-- test/bitcode_test.rb
-- test/pass_manager_builder_test.rb
-- test/equality_test.rb
-- test/function_test.rb
-- test/parameter_collection_test.rb
-- test/memory_access_test.rb
-- test/select_test.rb
-- test/module_test.rb
-- test/test_helper.rb
-- test/comparisons_test.rb
-- test/target_test.rb
-- test/call_test.rb
-- test/conversions_test.rb
-- test/linker_test.rb
-- test/generic_value_test.rb
-- test/phi_test.rb
-- test/integer_test.rb
-- test/mcjit_test.rb
+test_files: []

data/test/array_test.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-class ArrayTestCase < Minitest::Test
-
-  def setup
-    LLVM.init_jit
-  end
-
-  def test_constant_array_from_size
-    array = LLVM::ConstantArray.const(LLVM::Int, 2) { |i| LLVM::Int(i) }
-    assert_instance_of LLVM::ConstantArray, array
-    assert_equal 2, array.size
-  end
-
-  def test_constant_array_from_array
-    array = LLVM::ConstantArray.const(LLVM::Int, [LLVM::Int(0), LLVM::Int(1)])
-    assert_instance_of LLVM::ConstantArray, array
-    assert_equal 2, array.size
-  end
-
-  def test_array_values
-    assert_equal 2 + 3, run_array_values(2, 3).to_i
-  end
-
-  def run_array_values(value1, value2)
-    run_function([LLVM::Int, LLVM::Int], [value1, value2], LLVM::Int) do |builder, function, *arguments|
-      entry = function.basic_blocks.append
-      builder.position_at_end(entry)
-      pointer = builder.alloca(LLVM::Array(LLVM::Int, 2))
-      array = builder.load(pointer)
-      array = builder.insert_value(array, arguments.first, 0)
-      array = builder.insert_value(array, arguments.last, 1)
-      builder.ret(builder.add(builder.extract_value(array, 0),
-                              builder.extract_value(array, 1)))
-    end
-  end
-
-end

data/test/basic_block_test.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-class BasicBlockTestCase < Minitest::Test
-
-  def setup
-    LLVM.init_jit
-    @module = LLVM::Module.new("BasicBlockTestCase")
-  end
-
-  def test_basic_block_collection
-    @module.functions.add("test_basic_block_collection", [], LLVM.Void) do |fn|
-      coll = fn.basic_blocks
-
-      block1 = coll.append
-      assert_instance_of LLVM::BasicBlock, block1
-
-      assert_equal 1, coll.size
-      assert_equal coll.first, coll.last,
-                   'Only one block exists in the function'
-      assert_equal coll.first, coll.entry,
-                   'The entry block for the function is always the first block'
-
-      block2 = coll.append
-      assert_equal 2, coll.size
-      assert_equal block1, coll.first
-      assert_equal block2, coll.last
-
-      [ coll.each.to_a, coll.to_a ].each do |blocks|
-        assert_equal 2, blocks.size
-        assert_equal block1, blocks[0]
-        assert_equal block2, blocks[1]
-      end
-    end
-  end
-
-  def test_basic_block
-    @module.functions.add("test_basic_block", [], LLVM.Void) do |fn|
-      coll = fn.basic_blocks
-
-      block1 = coll.append
-      block2 = coll.append
-
-      assert_equal fn, block1.parent
-      assert_equal fn, block2.parent
-
-      assert_equal block2, block1.next
-      assert_equal block1, block2.previous
-
-      block1.build do |builder|
-        builder.br(block2)
-      end
-
-      block2.build do |builder|
-        builder.ret_void
-      end
-
-      assert_equal block1.first_instruction,
-                   block1.last_instruction
-      assert_equal block2.first_instruction,
-                   block2.last_instruction
-    end
-  end
-
-  def test_basic_block_enumerable
-    @module.functions.add("test_basic_block_enumerable", [LLVM::Double], LLVM::Double) do |fn, arg|
-      block1 = fn.basic_blocks.append
-
-      [ block1.instructions.to_a, block1.instructions.each.to_a ].each do |insts|
-        assert_equal 0, insts.size, 'Empty basic block'
-      end
-
-      block1.build do |builder|
-        builder.ret(builder.fadd(arg, LLVM.Double(1.0)))
-      end
-
-      [ block1.instructions.to_a, block1.instructions.each.to_a ].each do |insts|
-        assert_equal 2, insts.size
-        assert_equal block1.first_instruction, insts[0]  # deprecated
-        assert_equal block1.last_instruction,  insts[1]  # deprecated
-        assert_equal block1.instructions.first, insts[0]
-        assert_equal block1.instructions.last,  insts[1]
-      end
-
-    end
-  end
-
-end

data/test/binary_operations_test.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-class BasicOperationsTestCase < Minitest::Test
-
-  def setup
-    LLVM.init_jit
-  end
-
-  def test_integer_binary_operations
-    integer_binary_operation_assertion(:add, 3, 2, 3 + 2)
-    integer_binary_operation_assertion(:sub, 3, 2, 3 - 2)
-    integer_binary_operation_assertion(:mul, 3, 2, 3 * 2)
-    integer_binary_operation_assertion(:udiv, 10, 2, 10 / 2)
-    integer_binary_operation_assertion(:sdiv, 10, 2, 10 / 2)
-    integer_binary_operation_assertion(:urem, 10, 3, 10 % 3)
-    integer_binary_operation_assertion(:srem, 10, 3, 10 % 3)
-  end
-
-  def test_integer_bitwise_binary_operations
-    integer_binary_operation_assertion(:shl, 2, 3, 2 << 3)
-    integer_binary_operation_assertion(:lshr, 16, 3, 16 >> 3)
-    integer_binary_operation_assertion(:ashr, 16, 3, 16 >> 3)
-    integer_binary_operation_assertion(:and, 2, 1, 2 & 1)
-    integer_binary_operation_assertion(:or, 2, 1, 2 | 1)
-    integer_binary_operation_assertion(:xor, 3, 2, 3 ^ 2)
-  end
-
-  def test_float_binary_operations
-    float_binary_operation_assertion(:fadd, 3.1, 2.2, 3.1 + 2.2)
-    float_binary_operation_assertion(:fsub, 3.1, 2.2, 3.1 - 2.2)
-    float_binary_operation_assertion(:fmul, 3.1, 2.2, 3.1 * 2.2)
-    float_binary_operation_assertion(:fdiv, 3.1, 2.2, 3.1 / 2.2)
-    float_binary_operation_assertion(:frem, 3.1, 2.2, 3.1 % 2.2)
-  end
-
-  def integer_binary_operation_assertion(operation, operand1, operand2, expected_result)
-    result = run_binary_operation(operation,
-                                  LLVM::Int(operand1), LLVM::Int(operand2),
-                                  LLVM::Int).to_i
-    assert_equal expected_result, result
-  end
-
-  def float_binary_operation_assertion(operation, operand1, operand2, expected_result)
-    result = run_binary_operation(operation,
-                                  LLVM::Float(operand1), LLVM::Float(operand2),
-                                  LLVM::Float).to_f
-    assert_in_delta expected_result, result, 0.001
-  end
-
-  def run_binary_operation(operation, operand1, operand2, return_type)
-    run_function([], [], return_type) do |builder, function, *arguments|
-      entry = function.basic_blocks.append
-      builder.position_at_end(entry)
-      builder.ret(builder.send(operation, operand1, operand2))
-    end
-  end
-
-end

data/test/bitcode_test.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-require "tempfile"
-
-class BitcodeTestCase < Minitest::Test
-  def setup
-    LLVM.init_jit
-  end
-
-  def test_bitcode
-    test_module = define_module("test_module") do |mod|
-      define_function(mod, "test_function", [], LLVM::Int) do |builder, function, *arguments|
-        entry = function.basic_blocks.append
-        builder.position_at_end(entry)
-        builder.ret(LLVM::Int(1))
-      end
-    end
-    Tempfile.open("bitcode") do |tmp|
-      assert test_module.write_bitcode(tmp)
-      new_module = LLVM::Module.parse_bitcode(tmp.path)
-      result = run_function_on_module(new_module, "test_function").to_i
-      assert_equal 1, result
-    end
-  end
-end

data/test/branch_test.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-class BranchTestCase < Minitest::Test
-
-  def setup
-    LLVM.init_jit
-  end
-
-  def test_branching
-    assert_equal 0, direct_jump_function().to_i
-    assert_equal 0, conditional_jump_function().to_i
-    assert_equal 0, switched_jump_function().to_i
-  end
-
-  def direct_jump_function
-    run_function([], [], LLVM::Int) do |builder, function, *arguments|
-      entry = function.basic_blocks.append
-      branch_1 = function.basic_blocks.append
-      branch_2 = function.basic_blocks.append
-      builder.position_at_end(entry)
-      builder.br(branch_2)
-      builder.position_at_end(branch_1)
-      builder.ret(LLVM::Int(1))
-      builder.position_at_end(branch_2)
-      builder.ret(LLVM::Int(0))
-    end
-  end
-
-  def conditional_jump_function
-    run_function([], [], LLVM::Int) do |builder, function, *arguments|
-      entry = function.basic_blocks.append
-      branch_1 = function.basic_blocks.append
-      branch_2 = function.basic_blocks.append
-      builder.position_at_end(entry)
-      builder.cond(builder.icmp(:eq, LLVM::Int(1), LLVM::Int(2)), branch_1, branch_2)
-      builder.position_at_end(branch_1)
-      builder.ret(LLVM::Int(1))
-      builder.position_at_end(branch_2)
-      builder.ret(LLVM::Int(0))
-    end
-  end
-
-  def switched_jump_function
-    run_function([], [], LLVM::Int) do |builder, function, *arguments|
-      entry = function.basic_blocks.append
-      branch_1 = function.basic_blocks.append
-      branch_2 = function.basic_blocks.append
-      builder.position_at_end(entry)
-      switch = builder.switch(LLVM::Int(1), branch_1, LLVM::Int(1) => branch_2)
-      builder.position_at_end(branch_1)
-      builder.ret(LLVM::Int(1))
-      builder.position_at_end(branch_2)
-      builder.ret(LLVM::Int(0))
-    end
-  end
-
-end