BOAST 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fab0f4b52a0cd282c1abfc5778a690c5c90baae
-  data.tar.gz: 7e8adb0b43d8913a825a2349a8806af4097dd494
+  metadata.gz: ca2740cb851da646fa30581de14043280bd95ffe
+  data.tar.gz: edafed822810e02453fc6418cea1da470ad47c8c
 SHA512:
-  metadata.gz: 4fc23c211872b5bd42ae68cd18be4dacdcdc8a235c14bd5c40e80359bbff25a8c0433bdc52cf9d4b5a605ad0342f025384cf2c32cb94d3ed9241d4b058932d70
-  data.tar.gz: 29db1a68750851b3ce5a1f4e1b8e8495a8f553d0b979628ab132cf7cc3c4e96bc8672ffed74b7a938bead7e0e6a5c212b89041f73be8b7647d68c188a603452c
+  metadata.gz: 8ae1bcaf2964999e45ba8ca1aab3642425f8c24dba9aff508106cf65d5b4baadd0709b3ef12349388dc6e8ea89ca6281de32df3a15bb29ebc87a1780291114da
+  data.tar.gz: b0b4d95e68c5395a9d9740f7f59c900babfa419b261cd000add8d5238899c3178d2953ea073d4721ba397e6cb6678e17e040e1e8e90c82bef02fb7716c941ab9

data/BOAST.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'BOAST'
-  s.version = "1.2.2"
+  s.version = "1.3.0"
   s.author = "Brice Videau"
   s.email = "brice.videau@imag.fr"
   s.homepage = "https://github.com/Nanosim-LIG/boast"
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.3'
   s.add_dependency 'narray', '~> 0.6.0', '>=0.6.0.8'
   s.add_dependency 'narray_ffi', '~> 1.2', '>=1.2.0'
-  s.add_dependency 'opencl_ruby_ffi', '~> 1.2', '>=1.2.1'
+  s.add_dependency 'opencl_ruby_ffi', '~> 1.3', '>=1.3.2'
   s.add_dependency 'systemu', '~> 2', '>=2.2.0'
   s.add_dependency 'os', '~> 0.9', '>=0.9.6'
   s.add_dependency 'PAPI', '~> 0', '>=0.101'

data/lib/BOAST.rb

@@ -29,6 +29,7 @@ require 'BOAST/Language/While.rb'
 require 'BOAST/Language/Pragma.rb'
 require 'BOAST/Runtime/Config.rb'
 require 'BOAST/Runtime/Probe.rb'
+require 'BOAST/Runtime/AffinityProbe.rb'
 require 'BOAST/Runtime/Compilers.rb'
 require 'BOAST/Runtime/OpenCLRuntime.rb'
 require 'BOAST/Runtime/CompiledRuntime.rb'

data/lib/BOAST/Language/Algorithm.rb

@@ -1,46 +1,57 @@
 module BOAST
 
   extend TypeTransition
+
+  EXTENDED.push TypeTransition
   
   module PrivateStateAccessor
 
     private
-    def push_env(*args)
-      BOAST::push_env(*args)
+    # (see BOAST#push_env)
+    def push_env(vars, &block)
+      BOAST::push_env(vars, &block)
     end
 
-    def pop_env(*args)
-      BOAST::pop_env(*args)
+    # (see BOAST#pop_env)
+    def pop_env(*vars)
+      BOAST::pop_env(*vars)
     end
 
-    def increment_indent_level(*args)
-      BOAST::increment_indent_level(*args)
+    # (see BOAST#increment_indent_level)
+    def increment_indent_level(increment = get_indent_increment)
+      BOAST::increment_indent_level(increment)
     end
 
-    def decrement_indent_level(*args)
-      BOAST::decrement_indent_level(*args)
+    # (see BOAST#decrement_indent_level)
+    def decrement_indent_level(increment = get_indent_increment)
+      BOAST::decrement_indent_level(increment)
     end
 
+    # (see BOAST#indent)
     def indent
       BOAST::indent
     end
 
+    # (see BOAST#get_architecture_name)
     def get_architecture_name
       BOAST::get_architecture_name
     end
 
+    # (see BOAST#get_lang_name)
     def get_lang_name
       BOAST::get_lang_name
     end
 
-    def annotate_number(*args)
-      BOAST::annotate_number(*args)
+    # (see BOAST#annotate_number)
+    def annotate_number(name)
+      BOAST::annotate_number(name)
     end
 
   end
 
   module_function
 
+  # Returns the symbol corresponding to the active architecture
   def get_architecture_name
     case architecture
     when X86
@@ -54,6 +65,7 @@ module BOAST
     end
   end
 
+  # Returns the symbol corresponding to the active language
   def get_lang_name
     case lang
     when C
@@ -76,7 +88,12 @@ module BOAST
 
   @@env = Hash::new{|h, k| h[k] = []}
 
-  def push_env(vars = {}, &block)
+  # Updates states and stores their value in a stack for later retrieval
+  # @overload push_env( vars )
+  # @overload push_env( vars, &block )
+  # @param [Hash] vars contains state symbols and values pairs
+  # @yield states will be popped after the given block is called
+  def push_env(vars, &block)
     keys = []
     vars.each { |key, value|
       var = nil
@@ -99,6 +116,8 @@ module BOAST
     end
   end
 
+  # Pops the specified states values
+  # @param vars a list of state symbols
   def pop_env(*vars)
     vars.each { |key|
       raise "Unknown module variable #{key}!" unless @@env.has_key?(key)
@@ -108,24 +127,35 @@ module BOAST
     }
   end
 
+  # Increments the indent level
+  # @param [Integer] increment number of space to add
   def increment_indent_level(increment = get_indent_increment)
     set_indent_level( get_indent_level + increment )
   end
-  
+
+  # Decrements the indent level
+  # @param [Integer] increment number of space to remove 
   def decrement_indent_level(increment = get_indent_increment)
     set_indent_level( get_indent_level - increment )
   end
 
+  # Returns a string with as many space as the indent level.
+  def indent
+     return " "*get_indent_level
+  end
+
+  # Returns an annotation number for the given name. The number
+  # is incremented for a given name is incremented each time this name is called
   def annotate_number(name)
     num = @@annotate_numbers[name]
     @@annotate_numbers[name] = num + 1
     return num
   end
 
-  def indent
-     return " "*get_indent_level
-  end
-
+  # Annotates an Object by inlining a YAML structure in a comment.
+  # If object's class is part of the annotate list an indepth version of the annotation
+  # will be generated.
+  # @param [Object] a object to annotate
   def pr_annotate(a)
     name = a.class.name.gsub("BOAST::","")
     if annotate_list.include?(name) then
@@ -138,33 +168,38 @@ module BOAST
     end
   end
 
+
+  # One of BOAST keywords: prints BOAST objects.
+  # Annotates the given object.
+  # Calls the given object pr method with the optional arguments.
+  # @param a a BOAST Expression, ControlStructure or Procedure
+  # @param args an optional list of parameters
   def pr(a, *args)
     pr_annotate(a) if annotate?
     a.pr(*args)
   end
 
-  def decl(*a)
-    a.each { |d|
+  # One of BOAST keywords: declares BOAST Variables and Procedures.
+  # Calls the decl method of each given objects.
+  # @param list a list of parameters do declare
+  def decl(*list)
+    list.each { |d|
       d.decl
     }
   end
 
-  def close(a)
-    a.close
-  end
-
+  # One of BOAST keywords: opens a BOAST ControlStructure or Procedure.
+  # Calls the open method of the given object.
+  # @param a the BOAST object to open
   def opn(a)
     a.open
   end
 
-  alias :Var :Variable
-  alias :Dim :Dimension
-  alias :Call :FuncCall
-
-  class << self
-    alias :Var :Variable
-    alias :Dim :Dimension
-    alias :Call :FuncCall
+  # One of BOAST keywords: closes a BOAST ControlStructure or Procedure.
+  # Calls the close method of the given object.
+  # @param a the BOAST object to close
+  def close(a)
+    a.close
   end
 
   Var = Variable
@@ -184,6 +219,8 @@ end
 ConvolutionGenerator = BOAST
 
 class Integer
+  # Creates a constant BOAST Int Variable with a name corresponding to its value.
+  # The variable is signed only when negative.
   def to_var
     if self < 0 then
        v = BOAST::Variable::new("#{self}", BOAST::Int, :signed => true, :constant => self )
@@ -196,6 +233,7 @@ class Integer
 end
 
 class Float
+  # Creates a constant BOAST Real Variable with a name corresponding to its value.
   def to_var
     v = BOAST::Variable::new("#{self}", BOAST::Real, :constant => self )
     v.force_replace_constant = true

data/lib/BOAST/Language/Annotation.rb

@@ -1,5 +1,6 @@
 module BOAST
 
+  # @private
   module Annotation
     include PrivateStateAccessor
 

data/lib/BOAST/Language/Architectures.rb

@@ -234,4 +234,5 @@ X86architectures ={"pentium2"=>["MMX"],
    "SSE2",
    "SSE",
    "MMX"]}
+  private_constant :X86architectures
 end

data/lib/BOAST/Language/Arithmetic.rb

@@ -1,19 +1,25 @@
 module BOAST
 
-  module_function
+  module TopLevelExpressions
 
-  def Return(value)
-    return Expression::new("return",nil, value)
-  end
+    def Return(value)
+      return Expression::new("return",nil, value)
+    end
 
-  def And(a, b)
-    return Expression::new(And, a, b)
-  end
+    def And(a, b)
+      return Expression::new(And, a, b)
+    end
+
+    def Or(a, b)
+      return Expression::new(Or, a, b)
+    end
 
-  def Or(a, b)
-    return Expression::new(Or, a, b)
   end
 
+  extend TopLevelExpressions
+
+  EXTENDED.push TopLevelExpressions
+
   module Arithmetic
 
     def **(x)

data/lib/BOAST/Language/BOAST_OpenCL.rb

@@ -1,112 +1,119 @@
 module BOAST
 
-  OCL_CUDA_DIM_ASSOC = { 0 => "x", 1 => "y", 2 => "z" }
+  module OpenCLHelper
 
-  CUDA_THREADIDX = CStruct("threadIdx",:type_name => "cuda_trheadIdx", :members => [Int("x", :signed => false),Int("y", :signed => false),Int("z", :signed => false)])
-  CUDA_BLOCKIDX = CStruct("blockIdx",:type_name => "cuda_blockIdx", :members => [Int("x", :signed => false),Int("y", :signed => false),Int("z", :signed => false)])
-  CUDA_BLOCKDIM = CStruct("blockDim",:type_name => "cuda_blockDim", :members => [Int("x", :signed => false),Int("y", :signed => false),Int("z", :signed => false)])
-  CUDA_GRIDDIM = CStruct("gridDim",:type_name => "cuda_gridDim", :members => [Int("x", :signed => false),Int("y", :signed => false),Int("z", :signed => false)])
+    OCL_CUDA_DIM_ASSOC = { 0 => "x", 1 => "y", 2 => "z" }
 
-  module_function
+    CUDA_THREADIDX = BOAST::CStruct("threadIdx",:type_name => "cuda_trheadIdx", :members => [BOAST::Int("x", :signed => false),BOAST::Int("y", :signed => false),BOAST::Int("z", :signed => false)])
+    CUDA_BLOCKIDX = BOAST::CStruct("blockIdx",:type_name => "cuda_blockIdx", :members => [BOAST::Int("x", :signed => false),BOAST::Int("y", :signed => false),BOAST::Int("z", :signed => false)])
+    CUDA_BLOCKDIM = BOAST::CStruct("blockDim",:type_name => "cuda_blockDim", :members => [BOAST::Int("x", :signed => false),BOAST::Int("y", :signed => false),BOAST::Int("z", :signed => false)])
+    CUDA_GRIDDIM = BOAST::CStruct("gridDim",:type_name => "cuda_gridDim", :members => [BOAST::Int("x", :signed => false),BOAST::Int("y", :signed => false),BOAST::Int("z", :signed => false)])
 
-  def barrier(*locality)
-    if lang == CL then
-      loc=""
-      if locality.include?(:local) and locality.include?(:global) then
-        return FuncCall::new("barrier","CLK_LOCAL_MEM_FENCE | CLK_GLOBAL_MEM_FENCE")
-      elsif locality.include?(:local) then
-        return FuncCall::new("barrier","CLK_LOCAL_MEM_FENCE")
-      elsif locality.include?(:global) then
-        return FuncCall::new("barrier","CLK_GLOBAL_MEM_FENCE")
+    private_constant :OCL_CUDA_DIM_ASSOC, :CUDA_THREADIDX, :CUDA_BLOCKIDX, :CUDA_BLOCKDIM, :CUDA_GRIDDIM
+
+    def barrier(*locality)
+      if lang == CL then
+        loc=""
+        if locality.include?(:local) and locality.include?(:global) then
+          return FuncCall::new("barrier","CLK_LOCAL_MEM_FENCE | CLK_GLOBAL_MEM_FENCE")
+        elsif locality.include?(:local) then
+          return FuncCall::new("barrier","CLK_LOCAL_MEM_FENCE")
+        elsif locality.include?(:global) then
+          return FuncCall::new("barrier","CLK_GLOBAL_MEM_FENCE")
+        else
+          raise "Unsupported locality"
+        end
+      elsif lang == CUDA then
+        return FuncCall::new("__syncthreads")
       else
-        raise "Unsupported locality"
+        raise "Unsupported language!"
       end
-    elsif lang == CUDA then
-      return FuncCall::new("__syncthreads")
-    else
-      raise "Unsupported language!"
     end
-  end
 
-
-  def get_work_dim
-    if lang == CL then
-      return FuncCall::new("get_work_dim", :returns => Int("wd", :signed => false))
-    else
-      raise "Unsupported language!"
+    def get_work_dim
+      if lang == CL then
+        return FuncCall::new("get_work_dim", :returns => Int("wd", :signed => false))
+      else
+        raise "Unsupported language!"
+      end
     end
-  end
   
-  def get_global_size(dim)
-    if lang == CL then
-      return FuncCall::new("get_global_size", dim, :returns => Sizet)
-    elsif lang == CUDA then
-      d = OCL_CUDA_DIM_ASSOC[dim]
-      raise "Unsupported dimension!" if not d
-      return eval "CUDA_GRIDDIM.#{d}*CUDA_BLOCKDIM.#{d}"
-    else
-      raise "Unsupported language!"
+    def get_global_size(dim)
+      if lang == CL then
+        return FuncCall::new("get_global_size", dim, :returns => Sizet)
+      elsif lang == CUDA then
+        d = OCL_CUDA_DIM_ASSOC[dim]
+        raise "Unsupported dimension!" if not d
+        return eval "CUDA_GRIDDIM.#{d}*CUDA_BLOCKDIM.#{d}"
+      else
+        raise "Unsupported language!"
+      end
     end
-  end
 
-  def get_global_id(dim)
-    if lang == CL then
-      return FuncCall::new("get_global_id",dim, :returns => Sizet)
-    elsif lang == CUDA then
-      d = OCL_CUDA_DIM_ASSOC[dim]
-      raise "Unsupported dimension!" if not d
-      return eval "CUDA_THREADIDX.#{d}+CUDA_BLOCKIDX.#{d}*CUDA_BLOCKDIM.#{d}"
-    else
-      raise "Unsupported language!"
+    def get_global_id(dim)
+      if lang == CL then
+        return FuncCall::new("get_global_id",dim, :returns => Sizet)
+      elsif lang == CUDA then
+        d = OCL_CUDA_DIM_ASSOC[dim]
+        raise "Unsupported dimension!" if not d
+        return eval "CUDA_THREADIDX.#{d}+CUDA_BLOCKIDX.#{d}*CUDA_BLOCKDIM.#{d}"
+      else
+        raise "Unsupported language!"
+      end
     end
-  end
 
-  def get_local_size(dim)
-    if lang == CL then
-      return FuncCall::new("get_local_size",dim, :returns => Sizet)
-    elsif lang == CUDA then
-      d = OCL_CUDA_DIM_ASSOC[dim]
-      raise "Unsupported dimension!" if not d
-      return eval "CUDA_BLOCKDIM.#{d}"
-    else
-      raise "Unsupported language!"
+    def get_local_size(dim)
+      if lang == CL then
+        return FuncCall::new("get_local_size",dim, :returns => Sizet)
+      elsif lang == CUDA then
+        d = OCL_CUDA_DIM_ASSOC[dim]
+        raise "Unsupported dimension!" if not d
+        return eval "CUDA_BLOCKDIM.#{d}"
+      else
+        raise "Unsupported language!"
+      end
     end
-  end
 
-  def get_local_id(dim)
-    if lang == CL then
-      return FuncCall::new("get_local_id",dim, :returns => Sizet)
-    elsif lang == CUDA then
-      d = OCL_CUDA_DIM_ASSOC[dim]
-      raise "Unsupported dimension!" if not d
-      return eval "CUDA_THREADIDX.#{d}"
-    else
-      raise "Unsupported language!"
+    def get_local_id(dim)
+      if lang == CL then
+        return FuncCall::new("get_local_id",dim, :returns => Sizet)
+      elsif lang == CUDA then
+        d = OCL_CUDA_DIM_ASSOC[dim]
+        raise "Unsupported dimension!" if not d
+        return eval "CUDA_THREADIDX.#{d}"
+      else
+        raise "Unsupported language!"
+      end
     end
-  end
   
-  def get_num_groups(dim)
-    if lang == CL then
-      return FuncCall::new("get_num_groups",dim, :returns => Sizet)
-    elsif lang == CUDA then
-      d = OCL_CUDA_DIM_ASSOC[dim]
-      raise "Unsupported dimension!" if not d
-      return eval "CUDA_GRIDDIM.#{d}"
-    else
-      raise "Unsupported language!"
+    def get_num_groups(dim)
+      if lang == CL then
+        return FuncCall::new("get_num_groups",dim, :returns => Sizet)
+      elsif lang == CUDA then
+        d = OCL_CUDA_DIM_ASSOC[dim]
+        raise "Unsupported dimension!" if not d
+        return eval "CUDA_GRIDDIM.#{d}"
+      else
+        raise "Unsupported language!"
+      end
     end
-  end
 
-  def get_group_id(dim)
-    if lang == CL then
-      return FuncCall::new("get_group_id",dim, :returns => Sizet)
-    elsif lang == CUDA then
-      d = OCL_CUDA_DIM_ASSOC[dim]
-      raise "Unsupported dimension!" if not d
-      return eval "CUDA_BLOCKIDX.#{d}"
-    else
-      raise "Unsupported language!"
+    def get_group_id(dim)
+      if lang == CL then
+        return FuncCall::new("get_group_id",dim, :returns => Sizet)
+      elsif lang == CUDA then
+        d = OCL_CUDA_DIM_ASSOC[dim]
+        raise "Unsupported dimension!" if not d
+        return eval "CUDA_BLOCKIDX.#{d}"
+      else
+        raise "Unsupported language!"
+      end
     end
+
   end
 
+  extend OpenCLHelper
+
+  EXTENDED.push OpenCLHelper
+
 end