rltk 2.2.1 → 3.0.0

data/lib/rltk/cg/basic_block.rb

@@ -16,7 +16,7 @@ require 'rltk/cg/value'
 # Classes and Modules #
 #######################
 
-module RLTK::CG # :nodoc:
+module RLTK::CG
 
 	# A BasicBlock is what instructions are inserted into and what functions
 	# are made of.  BasicBlock objects may be created either using

data/lib/rltk/cg/bindings.rb

@@ -3,16 +3,22 @@
 # Date:		2012/03/08
 # Description:	This file holds bindings to LLVM.
 
+#########
+# Notes #
+#########
+
+# 1) initialize_all_target_m_cs -> initialize_all_target_mcs
+# 2) initialize_obj_carc_opts   -> initialize_objc_arc_opts
+
 ############
 # Requires #
 ############
 
 # Gems
-require 'rubygems'
 require 'ffi'
+require 'filigree/boolean'
 
 # Ruby Language Toolkit
-require 'rltk/util/monkeys'
 require 'rltk/version'
 require 'rltk/cg'
 
@@ -20,7 +26,7 @@ require 'rltk/cg'
 # Classes and Modules #
 #######################
 
-module RLTK::CG # :nodoc:
+module RLTK::CG
 	
 	# This module provides access to stored FFI::Pointer objects and allows a
 	# class to be passed directly into FFI methods.  It also provides a
@@ -52,22 +58,6 @@ module RLTK::CG # :nodoc:
 		# Require the generated bindings files while handling errors.
 		require 'rltk/cg/generated_bindings'
 	
-		begin
-			require 'rltk/cg/generated_extended_bindings'
-		
-			# Check to make sure that we have the same target version as the ECB.
-			if target_version() != RLTK::LLVM_TARGET_VERSION
-				raise LibraryMismatch,
-					"Extended bindings expected LLVM version #{target_version()}, " +
-					"RLTK expects LLVM version #{RLTK::LLVM_TARGET_VERSION}"
-			end
-		
-			@ecb = true
-		
-		rescue LoadError
-			@ecb = false
-		end
-	
 		#############
 		# Constants #
 		#############
@@ -119,11 +109,6 @@ module RLTK::CG # :nodoc:
 		# Methods #
 		###########
 		
-		# @return [Boolean] If the Extended C  Bindings for LLVM are present.
-		def self.ecb?
-			@ecb
-		end
-		
 		# Converts a CamelCase string into an underscored string.
 		#
 		# @param [#to_s] name CamelCase string.
@@ -162,7 +147,5 @@ module RLTK::CG # :nodoc:
 		ASM_PRINTERS.each do |asm|
 			add_binding("LLVMInitialize#{asm}AsmPrinter", [], :void)
 		end
-		
-		add_binding(:LLVMDisposeMessage, [:pointer], :void)
 	end
 end

data/lib/rltk/cg/builder.rb

@@ -15,7 +15,7 @@ require 'rltk/cg/instruction'
 # Classes and Modules #
 #######################
 
-module RLTK::CG # :nodoc:
+module RLTK::CG
 	
 	# This class is responsible for adding {Instruction Instructions} to {BasicBlock BasicBlocks}.
 	class Builder
@@ -67,7 +67,7 @@ module RLTK::CG # :nodoc:
 		#
 		# @return [Instruction] Build instruction.
 		def build_inst(inst, *args)
-			self.send(inst.to_sym, *args)
+			self.send(inst, *args)
 		end
 		alias :'<<' :build_inst
 		
@@ -91,6 +91,8 @@ module RLTK::CG # :nodoc:
 			Bindings.position_builder_at_end(@ptr, bb) if check_type(bb, BasicBlock, 'bb')
 			self
 		end
+		alias :pae :position_at_end
+		alias :target :position_at_end
 		
 		# Position the Builder before the given Instruction.
 		#
@@ -261,7 +263,7 @@ module RLTK::CG # :nodoc:
 		#
 		# @return [PhiInst] The phi node.
 		def phi(type, incoming, name = '')
-			returning PhiInst.new(Bindings.build_phi(@ptr, check_cg_type(type), name)) do |phi|
+			PhiInst.new(Bindings.build_phi(@ptr, check_cg_type(type), name)).tap do |phi|
 				phi.incoming.add(incoming)
 			end
 		end
@@ -302,7 +304,7 @@ module RLTK::CG # :nodoc:
 		#
 		# @return [SwitchInst]
 		def switch(val, default, cases)
-			returning SwitchInst.new(Bindings.build_switch(@ptr, val, default, cases.size)) do |inst|
+			SwitchInst.new(Bindings.build_switch(@ptr, val, default, cases.size)).tap do |inst|
 				cases.each { |val, block| inst.add_case(val, block) }
 			end
 		end
@@ -804,18 +806,48 @@ module RLTK::CG # :nodoc:
 		#
 		# @return [GlobalStringPtrInst] Reference to the global string pointer.
 		def gloabl_string_pointer(string, name = '')
-			GlobalStringPtrInst(Bindings.build_global_string_ptr(@ptr, string, name))
+			GlobalStringPtrInst.new(Bindings.build_global_string_ptr(@ptr, string, name))
+		end
+		
+		#######################
+		# Atomic Instructions #
+		#######################
+		
+		# Create an atomic read/modify/write instruction.
+		#
+		# @see http://llvm.org/docs/LangRef.html#atomic-memory-ordering-constraints
+		#
+		# @param [Symbol from _enum_atomic_rmw_bin_op_]  op             Operation to perform
+		# @param [OpaqueValue]                           addr           Address to modify
+		# @param [OpaqueValue]                           val            Value to test
+		# @param [Symbol from _enum_atomic_ordering_]    ordering       Memory ordering constraints
+		# @param [Boolean]                               single_thread  Synchronize with single thread or all threads
+		#
+		# @return [AtomicRMWInst]
+		def atomic_rmw(op, addr, val, ordering, single_thread)
+			AtomicRMWInst.new(Bindings.build_atomic_rmw(@ptr, op, addr, val, ordering, single_thread.to_i))
 		end
 		
 		###############################
 		# Type and Value Manipulation #
 		###############################
 		
+		# Cast a value to a given address space.
+		#
+		# @param [Value]  val   Value to cast
+		# @param [Type]   type  Target type
+		# @param [String] name  Name of the result in LLVM IR
+		#
+		# @return [AddrSpaceCastInst]
+		def addr_space_cast(val, type, name = '')
+			AddrSpaceCast.new(Bindings.addr_space_cast(@ptr, val, check_cg_type(type), name))
+		end
+		
 		# Cast a value to the given type without changing any bits.
 		#
-		# @param [Value]	val	Value to cast.
-		# @param [Type]	type	Target type.
-		# @param [String]	name	Name of the result in LLVM IR.
+		# @param [Value]   val   Value to cast
+		# @param [Type]    type  Target type
+		# @param [String]  name  Name of the result in LLVM IR
 		#
 		# @return [BitCastInst] A value of the target type.
 		def bitcast(val, type, name = '')

data/lib/rltk/cg/context.rb

@@ -14,7 +14,7 @@ require 'rltk/cg/bindings'
 # Classes and Modules #
 #######################
 
-module RLTK::CG # :nodoc:
+module RLTK::CG
 	
 	# Bindings for LLVM contexts.
 	class Context

data/lib/rltk/cg/contractor.rb

@@ -0,0 +1,51 @@
+# Author:		Chris Wailes <chris.wailes@gmail.com>
+# Project: 	Ruby Language Toolkit
+# Date:		2012/09/21
+# Description:	This file contains a combination of the Visitor and Builder
+#			classes called a Contractor.
+
+############
+# Requires #
+############
+
+# Gems
+require 'filigree/visitor'
+
+# Ruby Language Toolkit
+require 'rltk/cg/builder'
+
+#######################
+# Classes and Modules #
+#######################
+
+module RLTK::CG
+	
+	class Contractor < Builder
+		
+		include Filigree::Visitor
+		
+		####################
+		# Instance Methods #
+		####################
+		
+		# Alias out the RLTK::Visitor.visit method.
+		alias :wrapped_visit :visit
+		
+		# Visit an object in the context of this builder.  See the
+		# Filigree::Visitor's visit method for more details about the basic
+		# behaviour of this method.  The special options for this method are:
+		#
+		# @param [Object]      object  The object to visit.
+		# @param [BasicBlock]  at      Where to position the contractor before visiting the object.
+		# @param [Boolean]     rcb     If specified the method will also return the block where the contractor is currently positioned.
+		#
+		# @return [Object]
+		def visit(object, at: nil, rcb: false)
+			target at if at
+			
+			result = wrapped_visit(object)
+			
+			if rcb then [result, current_block] else result end
+		end
+	end
+end

data/lib/rltk/cg/execution_engine.rb

@@ -8,8 +8,10 @@
 # Requires #
 ############
 
+# Gems
+require 'filigree/abstract_class'
+
 # Ruby Language Toolkit
-require 'rltk/util/abstract_class'
 require 'rltk/cg/bindings'
 require 'rltk/cg/pass_manager'
 require 'rltk/cg/target'
@@ -18,7 +20,7 @@ require 'rltk/cg/target'
 # Classes and Modules #
 #######################
 
-module RLTK::CG # :nodoc:
+module RLTK::CG
 	
 	# The ExecutionEngine class and its subclasses execute code from the
 	# provided module, as well as providing a {PassManager} and
@@ -26,7 +28,7 @@ module RLTK::CG # :nodoc:
 	#
 	# @abstract Implemented by {Interpreter} and {JITCompiler}.
 	class ExecutionEngine
-		include AbstractClass
+		include Filigree::AbstractClass
 		include BindingClass
 		
 		# The Proc object called by the garbage collector to free resources used by LLVM.
@@ -46,13 +48,13 @@ module RLTK::CG # :nodoc:
 			
 			block = Proc.new { |ptr, error| Bindings.create_execution_engine_for_module(ptr, mod, error) } if block == nil
 			
-			ptr		= FFI::MemoryPointer.new(:pointer)
-			error	= FFI::MemoryPointer.new(:pointer)
-			status	= block.call(ptr, error)
+			ptr    = FFI::MemoryPointer.new(:pointer)
+			error  = FFI::MemoryPointer.new(:pointer)
+			status = block.call(ptr, error)
 			
 			if status.zero?
-				@ptr		= ptr.read_pointer
-				@module	= mod
+				@ptr    = ptr.read_pointer
+				@module = mod
 				
 				# Associate this engine with the provided module.
 				@module.engine = self
@@ -154,4 +156,39 @@ module RLTK::CG # :nodoc:
 			end
 		end
 	end
+	
+	# Options for initializing a {MCJITCompiler}.
+	class MCJITCompilerOptions < RLTK::CG::Bindings::MCJITCompilerOptions
+		
+		# Create an object representing MCJIT compiler options.
+		#
+		# @param [Integer]                        opt_level              Optimization level
+		# @param [Symbol from _enum_code_model_]  code_model             JIT compilation code model
+		# @param [Boolean]                        no_frame_pointer_elim  Disable frame pointer elimination
+		# @param [Boolean]                        enable_fast_i_sel      Turn on fast instruction selection
+		def initialize(opt_level = 0, code_model = :jit_default, no_frame_pointer_elim = false,
+		               enable_fast_i_sel = true)
+		     
+			Bindings.initialize_mcjit_compiler_options(self.to_ptr, self.class.size)
+			
+			super(opt_level, code_model, no_frame_pointer_elim.to_i, enable_fast_i_sel.to_i, nil)
+		end
+	end
+	
+	# The new LLVM JIT execution engine.
+	class MCJITCompiler < ExecutionEngine
+		
+		# Create a new MC just-in-time-compiler.
+		#
+		# @see http://llvm.org/docs/MCJITDesignAndImplementation.html
+		# @see http://blog.llvm.org/2013/07/using-mcjit-with-kaleidoscope-tutorial.html
+		#
+		# @param [Module]                mod      Module to be executed
+		# @param [MCJITCompilerOptions]  options  Options used to create the MCJIT
+		def initialize(mod, options = MCJITCompilerOptions.new)
+			super(mod) do |ptr, error|
+				Bindings.create_mcjit_compiler_for_module(ptr, mod, options, MCJITCompilerOptions.size, error)
+			end
+		end
+	end
 end

data/lib/rltk/cg/function.rb

@@ -16,7 +16,7 @@ require 'rltk/cg/value'
 # Classes and Modules #
 #######################
 
-module RLTK::CG # :nodoc:
+module RLTK::CG
 	
 	# An LLVM IR function.
 	class Function < GlobalValue
@@ -131,7 +131,7 @@ module RLTK::CG # :nodoc:
 			#
 			# @return [BasicBlock] New BasicBlock.
 			def append(name = '', builder = nil, context = nil, *block_args, &block)
-				BasicBlock.new(@fun, name, builder, context, @fun, *block_args, &block)
+				BasicBlock.new(@fun, name, builder, context, *block_args, &block)
 			end
 			
 			# An iterator for each block inside this collection.
@@ -175,6 +175,16 @@ module RLTK::CG # :nodoc:
 		class FunctionAttrCollection < AttrCollection
 			@@add_method = :add_function_attr
 			@@del_method = :remove_function_attr
+			
+			# Set a target-dependent function attribute.
+			#
+			# @param [String]  attribute  Attribute name
+			# @param [String]  value      Attribute value
+			#
+			# @return [void]
+			def add_td_attr(attribute, value)
+				Bindings.add_target_dependent_function_attr(@value, attribute, value)
+			end
 		end