ruby-llvm-next 10.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d62975c1e0b9ec9fba55e600e40e84f08263cc70e1e0dc8f395f9b03935d06e3
+  data.tar.gz: af890548a7e0ea7dffc559cb46efef77de62adb69fe1a1e7eb42ceb3015f6c0f
+SHA512:
+  metadata.gz: a8a7acaa310753969acfd44ef0b7db5b5b9900d95eb83f1845fe655cb274bcc222cf872a747c431d3a90508804a2733e637044cad35c76efc370f9fb1224953c
+  data.tar.gz: 99a09ea3aa71123379bd26a29f58696479ab5c892b35bffab133e84b2c56d70f937da248e752fdeddd9f98d12502a0981c3dbd3bef04f7e5c38cac19c29c87b1

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2010-2011 Jeremy Voorhis
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the author nor the names of his contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,67 @@
+[![Known Vulnerabilities](https://snyk.io/test/github/ruby-llvm/ruby-llvm/badge.svg)](https://snyk.io/test/github/ruby-llvm/ruby-llvm)
+
+Ruby-LLVM
+=========
+
+Ruby-LLVM is a Ruby language binding to the LLVM compiler infrastructure
+library. LLVM allows users to create just-in-time (JIT) compilers, ahead-of-time
+(AOT) compilers for multiple architectures, code analyzers and more. LLVM
+bindings can also be used to speed up Ruby code by compiling and loading
+computationally intensive algorithms on the fly.
+
+Current version
+---------------
+
+This library currently binds to LLVM-10 (specifically llvm-c 10).
+
+About version numbers
+---------------------
+
+The first two digits of ruby-llvm's version number refer to the required
+major and minor version of LLVM. The third digit refers to the ruby-llvm
+release itself. Because LLVM's api changes often, this coupling between
+LLVM and ruby-llvm versions is useful.
+
+Debian/Ubuntu
+-------------
+
+[LLVM Debian/Ubuntu Packages](https://apt.llvm.org/)
+
+Homebrew
+--------
+
+LLVM can be installed with Homebrew by executing `brew install llvm --shared`
+
+Source and other binaries
+-------------------------
+
+* [LLVM Download Page](https://releases.llvm.org/download.html)
+* If compiling from source the --enable-shared and --enable-jit flags may be needed.
+
+See Also
+--------
+* [The LLVM project](http://llvm.org)
+* [Mirror of llvm-c on github](https://github.com/llvm-mirror/llvm/tree/master/include/llvm-c)
+* [ffi-gen](https://github.com/neelance/ffi-gen) – Generate
+  [FFI](https://github.com/ffi/ffi) bindings with LLVM and Clang
+
+License
+-------
+Ruby-LLVM is available under the BSD 3-clause (see LICENSE), Copyright (c) 2010-2013 Jeremy Voorhis
+
+Ruby-LLVM is possible because of its contributors:
+
+* Evan Phoenix
+* David Holroyd
+* Takanori Ishikawa
+* Ronaldo M. Ferraz
+* Mac Malone
+* Chris Wailes
+* Ary Borenszweig
+* Richard Musiol
+* Juan Wajnerman
+* Steven Farlie
+* Peter Zotov
+* Austin Seipp
+* Torsten Rüger
+* Nathaniel Barnes

data/ext/ruby-llvm-support/Rakefile

@@ -0,0 +1,110 @@
+require 'rubygems'
+require 'rake/clean'
+require 'ffi'
+
+require File.expand_path('../../lib/llvm/version', File.dirname(__FILE__))
+include LLVM
+
+def check_for(what, variants, env_var)
+  variants = [ ENV[env_var], *variants ] if ENV.include?(env_var)
+
+  $stdout.print("checking for #{what}... ")
+  $stdout.flush
+
+  result = variants.find do |variant|
+    if yield(variant)
+      $stdout.puts(variant)
+      true
+    end
+  end
+
+  if result
+    result
+  else
+    raise "Cannot find #{what}: tried #{variants}"
+  end
+end
+
+def find_llvm_config
+  check_for('llvm-config',
+            %W(llvm-config-#{LLVM_VERSION} llvm-config),
+            'LLVM_CONFIG') do |llvm_config|
+
+    begin
+      actual_version = `#{llvm_config} --version`.strip
+      actual_maj, actual_min, _ = actual_version.split('.')
+
+      required_maj, required_min = LLVM_REQUIRED_VERSION.split('.')
+
+      actual_maj == required_maj && actual_min == required_min
+    rescue Errno::ENOENT
+      false
+    end
+  end
+end
+
+def find_cxx
+  check_for('C++ compiler', %W(g++ clang++), 'CXX') do |cxx|
+    system(cxx, "--version", out: File::NULL, err: File::NULL)
+    $?.success?
+  end
+end
+
+LLVM_CONFIG = find_llvm_config
+CXX         = find_cxx
+
+def invoke_llvm_config(options)
+  `#{LLVM_CONFIG} #{options}`.tr("\n", " ")
+end
+
+def llvm_lib_name
+  lib_dir = invoke_llvm_config('--libdir').strip
+  lib_name = 'LLVM'
+  versioned_lib_name = "#{lib_name}-#{LLVM_VERSION}"
+  versioned_lib_pattern = "lib#{versioned_lib_name}.*"
+  versioned_lib_found = Dir.glob(File.join(lib_dir, versioned_lib_pattern)) != []
+  versioned_lib_found ? versioned_lib_name : lib_name
+end
+
+SUPPORT_LIB = FFI.map_library_name("RubyLLVMSupport-#{LLVM_VERSION}")
+CONFIG_MOD  = File.expand_path('../../lib/llvm/config.rb', File.dirname(__FILE__))
+
+CLEAN.include(SUPPORT_LIB, CONFIG_MOD)
+
+desc "Build the shared library and config module"
+task :default => [SUPPORT_LIB, CONFIG_MOD]
+
+file SUPPORT_LIB => %w(support.cpp) do |task|
+  sh "#{CXX} -shared #{task.prerequisites.join(' ')} -l#{llvm_lib_name} " \
+     "#{invoke_llvm_config('--cxxflags --ldflags')} -fPIC -o #{SUPPORT_LIB}"
+end
+
+LLVM_CONFIG_OPTS = [
+  ['COMPONENTS',    :array,  '--components'],
+  ['TARGETS_BUILT', :array,  '--targets-built'],
+  ['HOST_TARGET',   :string, '--host-target'],
+  ['BUILD_MODE',    :string, '--build-mode'],
+  ['CFLAGS',        :string, '--cflags'],
+].freeze
+
+file CONFIG_MOD do
+  open(CONFIG_MOD, 'w') do |f|
+    f.puts '# Generated by ruby-llvm. Please do not change this file by hand.'
+    f.puts 'module LLVM'
+    f.puts '  module CONFIG'
+
+    LLVM_CONFIG_OPTS.each do |(const, fmt, flag)|
+      case fmt
+      when :string
+        value = invoke_llvm_config(flag)
+      when :array
+        value = invoke_llvm_config(flag).split
+      end
+
+      f.puts "    #{const} = #{value.inspect}"
+    end
+
+    f.puts '  end'
+    f.puts 'end'
+  end
+end

data/ext/ruby-llvm-support/support.cpp

@@ -0,0 +1,32 @@
+/*
+ * Extended bindings for LLVM.
+ */
+
+#include <llvm/Support/TargetSelect.h>
+
+extern "C" {
+  void LLVMInitializeAllTargetInfos() {
+    llvm::InitializeAllTargetInfos();
+  }
+
+  void LLVMInitializeAllTargets() {
+    llvm::InitializeAllTargets();
+  }
+
+  void LLVMInitializeAllTargetMCs() {
+    llvm::InitializeAllTargetMCs();
+  }
+
+  void LLVMInitializeAllAsmPrinters() {
+    llvm::InitializeAllAsmPrinters();
+  }
+
+  void LLVMInitializeNativeTarget() {
+    llvm::InitializeNativeTarget();
+  }
+
+  void LLVMInitializeNativeAsmPrinter() {
+    llvm::InitializeNativeTargetAsmPrinter();
+  }
+}
+

data/lib/llvm.rb

@@ -0,0 +1,29 @@
+require 'ffi'
+
+module LLVM
+  require 'llvm/version'
+  require 'llvm/support'
+
+  module PointerIdentity
+    # @private
+    def to_ptr
+      @ptr
+    end
+
+    # Checks if the value is equal to other.
+    def ==(other)
+      other.respond_to?(:to_ptr) &&
+          @ptr == other.to_ptr
+    end
+
+    # Computes hash.
+    def hash
+      @ptr.address.hash
+    end
+
+    # Checks if the value is equivalent to other.
+    def eql?(other)
+      self == other
+    end
+  end
+end

data/lib/llvm/analysis.rb

@@ -0,0 +1,49 @@
+require 'llvm'
+require 'llvm/core'
+require 'llvm/target'
+require 'llvm/analysis_ffi'
+
+module LLVM
+  class Module
+    # Verify that the module is valid.
+    # @return [nil, String] human-readable description of any invalid
+    #   constructs if invalid.
+    def verify
+      do_verification(:return_status)
+    end
+
+    # Verify that a module is valid, and abort the process if not.
+    # @return [nil]
+    def verify!
+      do_verification(:abort_process)
+    end
+
+    private
+
+    def do_verification(action)
+      LLVM.with_message_output do |str|
+        C.verify_module(self, action, str)
+      end
+    end
+  end
+
+  class Function
+    # Verify that a function is valid.
+    # @return [true, false]
+    def verify
+      do_verification(:return_status)
+    end
+
+    # Verify that a function is valid, and abort the process if not.
+    # @return [true, false]
+    def verify!
+      do_verification(:abort_process)
+    end
+
+    private
+
+    def do_verification(action)
+      C.verify_function(self, action) != 0
+    end
+  end
+end

data/lib/llvm/analysis_ffi.rb

@@ -0,0 +1,77 @@
+# Generated by ffi_gen. Please do not change this file by hand.
+
+require 'ffi'
+
+module LLVM::C
+  extend FFI::Library
+  ffi_lib ["libLLVM-10.so.1", "LLVM-10"]
+
+  def self.attach_function(name, *_)
+    begin; super; rescue FFI::NotFoundError => e
+      (class << self; self; end).class_eval { define_method(name) { |*_| raise e } }
+    end
+  end
+
+  # @defgroup LLVMCAnalysis Analysis
+  # @ingroup LLVMC
+  #
+  # @{
+  #
+  # <em>This entry is only for documentation and no real method. The FFI::Enum can be accessed via #enum_type(:verifier_failure_action).</em>
+  #
+  # === Options:
+  # :abort_process ::
+  #
+  # :print_message ::
+  #   verifier will print to stderr and abort()
+  # :return_status ::
+  #   verifier will print to stderr and return 1
+  #
+  # @method _enum_verifier_failure_action_
+  # @return [Symbol]
+  # @scope class
+  enum :verifier_failure_action, [
+    :abort_process, 0,
+    :print_message, 1,
+    :return_status, 2
+  ]
+
+  # Verifies that a module is valid, taking the specified action if not.
+  #    Optionally returns a human-readable description of any invalid constructs.
+  #    OutMessage must be disposed with LLVMDisposeMessage.
+  #
+  # @method verify_module(m, action, out_message)
+  # @param [FFI::Pointer(ModuleRef)] m
+  # @param [Symbol from _enum_verifier_failure_action_] action
+  # @param [FFI::Pointer(**CharS)] out_message
+  # @return [Integer]
+  # @scope class
+  attach_function :verify_module, :LLVMVerifyModule, [:pointer, :verifier_failure_action, :pointer], :int
+
+  # Verifies that a single function is valid, taking the specified action. Useful
+  #    for debugging.
+  #
+  # @method verify_function(fn, action)
+  # @param [FFI::Pointer(ValueRef)] fn
+  # @param [Symbol from _enum_verifier_failure_action_] action
+  # @return [Integer]
+  # @scope class
+  attach_function :verify_function, :LLVMVerifyFunction, [:pointer, :verifier_failure_action], :int
+
+  # Open up a ghostview window that displays the CFG of the current function.
+  #    Useful for debugging.
+  #
+  # @method view_function_cfg(fn)
+  # @param [FFI::Pointer(ValueRef)] fn
+  # @return [nil]
+  # @scope class
+  attach_function :view_function_cfg, :LLVMViewFunctionCFG, [:pointer], :void
+
+  # (Not documented)
+  #
+  # @method view_function_cfg_only(fn)
+  # @param [FFI::Pointer(ValueRef)] fn
+  # @return [nil]
+  # @scope class
+  attach_function :view_function_cfg_only, :LLVMViewFunctionCFGOnly, [:pointer], :void
+end

data/lib/llvm/config.rb

@@ -0,0 +1,10 @@
+# Generated by ruby-llvm. Please do not change this file by hand.
+module LLVM
+  module CONFIG
+    COMPONENTS = ["aarch64", "aarch64asmparser", "aarch64codegen", "aarch64desc", "aarch64disassembler", "aarch64info", "aarch64utils", "aggressiveinstcombine", "all", "all-targets", "amdgpu", "amdgpuasmparser", "amdgpucodegen", "amdgpudesc", "amdgpudisassembler", "amdgpuinfo", "amdgpuutils", "analysis", "arm", "armasmparser", "armcodegen", "armdesc", "armdisassembler", "arminfo", "armutils", "asmparser", "asmprinter", "avr", "avrasmparser", "avrcodegen", "avrdesc", "avrdisassembler", "avrinfo", "binaryformat", "bitreader", "bitstreamreader", "bitwriter", "bpf", "bpfasmparser", "bpfcodegen", "bpfdesc", "bpfdisassembler", "bpfinfo", "cfguard", "codegen", "core", "coroutines", "coverage", "debuginfocodeview", "debuginfodwarf", "debuginfogsym", "debuginfomsf", "debuginfopdb", "demangle", "dlltooldriver", "dwarflinker", "engine", "executionengine", "frontendopenmp", "fuzzmutate", "globalisel", "hexagon", "hexagonasmparser", "hexagoncodegen", "hexagondesc", "hexagondisassembler", "hexagoninfo", "instcombine", "instrumentation", "interpreter", "ipo", "irreader", "jitlink", "lanai", "lanaiasmparser", "lanaicodegen", "lanaidesc", "lanaidisassembler", "lanaiinfo", "libdriver", "lineeditor", "linker", "lto", "mc", "mca", "mcdisassembler", "mcjit", "mcparser", "mips", "mipsasmparser", "mipscodegen", "mipsdesc", "mipsdisassembler", "mipsinfo", "mirparser", "msp430", "msp430asmparser", "msp430codegen", "msp430desc", "msp430disassembler", "msp430info", "native", "nativecodegen", "nvptx", "nvptxcodegen", "nvptxdesc", "nvptxinfo", "objcarcopts", "object", "objectyaml", "option", "orcerror", "orcjit", "passes", "perfjitevents", "powerpc", "powerpcasmparser", "powerpccodegen", "powerpcdesc", "powerpcdisassembler", "powerpcinfo", "profiledata", "remarks", "riscv", "riscvasmparser", "riscvcodegen", "riscvdesc", "riscvdisassembler", "riscvinfo", "riscvutils", "runtimedyld", "scalaropts", "selectiondag", "sparc", "sparcasmparser", "sparccodegen", "sparcdesc", "sparcdisassembler", "sparcinfo", "support", "symbolize", "systemz", "systemzasmparser", "systemzcodegen", "systemzdesc", "systemzdisassembler", "systemzinfo", "tablegen", "target", "textapi", "transformutils", "vectorize", "webassembly", "webassemblyasmparser", "webassemblycodegen", "webassemblydesc", "webassemblydisassembler", "webassemblyinfo", "windowsmanifest", "x86", "x86asmparser", "x86codegen", "x86desc", "x86disassembler", "x86info", "x86utils", "xcore", "xcorecodegen", "xcoredesc", "xcoredisassembler", "xcoreinfo", "xray"]
+    TARGETS_BUILT = ["AArch64", "AMDGPU", "ARM", "BPF", "Hexagon", "Lanai", "Mips", "MSP430", "NVPTX", "PowerPC", "RISCV", "Sparc", "SystemZ", "WebAssembly", "X86", "XCore", "AVR"]
+    HOST_TARGET = "x86_64-pc-linux-gnu "
+    BUILD_MODE = "RelWithDebInfo "
+    CFLAGS = "-I/usr/lib/llvm-10/include  -D_GNU_SOURCE -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS "
+  end
+end

data/lib/llvm/core.rb

@@ -0,0 +1,97 @@
+require 'llvm'
+require 'llvm/core_ffi'
+require 'llvm/support'
+
+module LLVM
+  # @private
+  module C
+    attach_function :dispose_message, :LLVMDisposeMessage, [:pointer], :void
+
+    # typedef unsigned LLVMAttributeIndex;
+    typedef(:uint, :llvmattributeindex)
+
+    # void LLVMAddAttributeAtIndex
+    # (LLVMValueRef F, LLVMAttributeIndex Idx, LLVMAttributeRef A);
+    attach_function :add_attribute_at_index, :LLVMAddAttributeAtIndex, [:pointer, :llvmattributeindex, :pointer], :void
+
+    # void LLVMRemoveEnumAttributeAtIndex
+    # (LLVMValueRef F, LLVMAttributeIndex Idx, unsigned KindID);
+    attach_function :remove_enum_attribute_at_index, :LLVMRemoveEnumAttributeAtIndex, [:pointer, :llvmattributeindex, :uint], :void
+
+    # LLVMAttributeRef LLVMCreateEnumAttribute
+    # (LLVMContextRef C, unsigned KindID, uint64_t Val);
+    attach_function :create_enum_attribute, :LLVMCreateEnumAttribute, [:pointer, :uint, :uint64], :pointer
+
+    # unsigned LLVMGetEnumAttributeKindForName
+    # (const char *Name, size_t SLen);
+    attach_function :get_enum_attribute_kind_for_name, :LLVMGetEnumAttributeKindForName, [:pointer, :size_t], :uint
+
+    # unsigned LLVMGetAttributeCountAtIndex
+    # (LLVMValueRef F, LLVMAttributeIndex Idx);
+    attach_function :get_attribute_count_at_index, :LLVMGetAttributeCountAtIndex, [:pointer, :llvmattributeindex], :uint
+
+    # void LLVMGetAttributesAtIndex
+    # (LLVMValueRef F, LLVMAttributeIndex Idx, LLVMAttributeRef *Attrs);
+    attach_function :get_attributes_at_index, :LLVMGetAttributesAtIndex, [:pointer, :llvmattributeindex, :pointer], :void
+
+    # unsigned LLVMGetEnumAttributeKind
+    # (LLVMAttributeRef A);
+    attach_function :get_enum_attribute_kind, :LLVMGetEnumAttributeKind, [:pointer], :uint
+
+    # uint64_t LLVMGetEnumAttributeValue
+    # (LLVMAttributeRef A);
+    attach_function :get_enum_attribute_value, :LLVMGetEnumAttributeKind, [:pointer], :uint64
+
+    # const char *LLVMGetStringAttributeKind
+    # (LLVMAttributeRef A, unsigned *Length);
+    attach_function :get_string_attribute_kind, :LLVMGetStringAttributeKind, [:pointer, :pointer], :pointer
+
+    # const char *LLVMGetStringAttributeValue
+    # (LLVMAttributeRef A, unsigned *Length);
+    attach_function :get_string_attribute_value, :LLVMGetStringAttributeValue, [:pointer, :pointer], :pointer
+  end
+
+  # Yields a pointer suitable for storing an LLVM output message.
+  # If the message pointer is non-NULL (an error has happened), converts
+  # the result to a string and returns it. Otherwise, returns +nil+.
+  #
+  # @yield  [FFI::MemoryPointer]
+  # @return [String, nil]
+  def self.with_message_output
+    message = nil
+
+    FFI::MemoryPointer.new(FFI.type_size(:pointer)) do |str|
+      result = yield str
+
+      msg_ptr = str.read_pointer
+
+      if result != 0
+        raise "Error is signalled, but msg_ptr is null" if msg_ptr.null?
+
+        message = msg_ptr.read_string
+        C.dispose_message msg_ptr
+      end
+    end
+
+    message
+  end
+
+  # Same as #with_message_output, but raises a RuntimeError with the
+  # resulting message.
+  #
+  # @yield  [FFI::MemoryPointer]
+  # @return [nil]
+  def self.with_error_output(&block)
+    error = with_message_output(&block)
+
+    raise error unless error.nil?
+  end
+
+  require 'llvm/core/context'
+  require 'llvm/core/module'
+  require 'llvm/core/type'
+  require 'llvm/core/value'
+  require 'llvm/core/builder'
+  require 'llvm/core/pass_manager'
+  require 'llvm/core/bitcode'
+end