basechip 0.0.1

data/lib/base_chip/git.rb

@@ -0,0 +1,32 @@
+# Copyright 2011 Tommy Poulter
+#
+# This file is part of basechip.
+#
+# basechip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+# 
+# basechip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with basechip.  If not, see <http://www.gnu.org/licenses/>.
+
+module BaseChip
+  class Git
+    def initialize(root)
+      @root = root
+    end
+    def changed
+      files = `cd #{@root} && git status`.split(/\n/)
+      files.delete_if do |f|
+        f !~ /#\t/
+      end
+      files.map! do |f|
+        f.gsub(/#\s+(modified|new file):\s+/,'')
+      end
+    end
+  end
+end

data/lib/base_chip/hierarchy.rb

@@ -0,0 +1,84 @@
+# Copyright 2011 Tommy Poulter
+#
+# This file is part of basechip.
+#
+# basechip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+# 
+# basechip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with basechip.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'reporting'
+module BaseChip
+  module Hierarchy
+    def self.included mod
+      mod.extend Hierarchy::ClassMethods
+      mod.class_eval do
+        include Reporting
+        include Hierarchy::InstanceMethods
+      end
+    end
+    module ClassMethods
+    end
+    module InstanceMethods
+      def configure
+        return if @configured
+        @directory ||= "#{parent.directory}/#{name}"
+        super
+      end
+
+      def discover_tools          ; file_glob("#{@directory}/base_chip/tools/*.rb"         , /base_chip\/tools\/(\w+)\.rb$/      , :tool      ) end
+      def discover_actions        ; file_glob("#{@directory}/base_chip/actions/*.rb"       , /base_chip\/actions\/(\w+)\.rb$/    , :action    ) end
+      def discover_test_lists     ; file_glob("#{@directory}/base_chip/test_lists/*.rb"    , /base_chip\/test_lists\/(\w+)\.rb$/ , :test_list ) end
+      def discover_recipes        ; file_glob("#{@directory}/base_chip/recipes/*.rb"                                                          ) end
+
+      def     rtl(       &blk) ; source_type(    :rtl       , &blk) ; end
+      def top_rtl(       &blk) ; source_type(:top_rtl       , &blk) ; end
+      def     gates(     &blk) ; source_type(    :gates     , &blk) ; end
+      def top_gates(     &blk) ; source_type(:top_gates     , &blk) ; end
+      def     testbench( &blk) ; source_type(    :testbench , &blk) ; end
+      def top_testbench( &blk) ; source_type(:top_testbench , &blk) ; end
+      def     stimulus(  &blk) ; source_type(    :stimulus  , &blk) ; end
+      def top_stimulus(  &blk) ; source_type(:top_stimulus  , &blk) ; end
+
+      def verilog(       &blk) ; source_language(:verilog   , &blk) ; end
+      def classes(       &blk) ; source_language(:classes   , &blk) ; end
+      def vhdl(          &blk) ; source_language(:vhdl      , &blk) ; end
+      def systemc(       &blk) ; source_language(:systemc   , &blk) ; end
+      def headers(       &blk) ; source_language(:headers   , &blk) ; end
+
+      def default_directory_structure_called
+        return true if                 @default_directory_structure_called
+        return true if parent && parent.default_directory_structure_called
+        false
+      end
+      def default_directory_structure
+        return if default_directory_structure_called
+                 @default_directory_structure_called = true
+
+            rtl       { |source| source.directories [ "#{source.block.name    }/rtl"       , "#{source.block.name}/#{source.configuration.name    }/rtl"       ] }
+        top_rtl       { |source| source.directories [ "#{source.block.name}/top_rtl"       , "#{source.block.name}/#{source.configuration.name}/top_rtl"       ] }
+            gates     { |source| source.directories [ "#{source.block.name    }/gates"     , "#{source.block.name}/#{source.configuration.name    }/gates"     ] }
+        top_gates     { |source| source.directories [ "#{source.block.name}/top_gates"     , "#{source.block.name}/#{source.configuration.name}/top_gates"     ] }
+            testbench { |source| source.directories [ "#{source.block.name    }/testbench" , "#{source.block.name}/#{source.configuration.name    }/testbench" ] }
+        top_testbench { |source| source.directories [ "#{source.block.name}/top_testbench" , "#{source.block.name}/#{source.configuration.name}/top_testbench" ] }
+            stimulus  { |source| source.directories [ "#{source.block.name    }/stimulus"  , "#{source.block.name}/#{source.configuration.name    }/stimulus"  ] }
+        top_stimulus  { |source| source.directories [ "#{source.block.name}/top_stimulus"  , "#{source.block.name}/#{source.configuration.name}/top_stimulus"  ] }
+
+        # FIXME include directory
+        verilog { |language| language.append_directories(language.directories.map {|d| "#{d}/#{language.name}"}); language.globs  %w{*.def *.v *.vbh *.sv  } }
+        classes { |language| language.       directories(language.directories.map {|d| "#{d}/#{language.name}"}); language.globs  %w{                *.sv  } }
+        vhdl    { |language| language.       directories(language.directories.map {|d| "#{d}/#{language.name}"}); language.globs  %w{      *.v *.vhd *.vhdl} }
+        systemc { |language| language.       directories(language.directories.map {|d| "#{d}/#{language.name}"}); language.globs  %w{*.c                   } }
+        headers { |language| language.       directories(language.directories.map {|d| "#{d}/#{language.name}"}); language.globs  ['']                       }
+      end
+
+    end
+  end
+end

data/lib/base_chip/install_menu.rb

@@ -0,0 +1,89 @@
+# Copyright 2011 Tommy Poulter
+#
+# This file is part of basechip.
+#
+# basechip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+# 
+# basechip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with basechip.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'base_chip/menu'
+module BaseChip
+  class InstallMenu < Menu
+    include Cli
+    def before(name)
+      BaseChip.load_environment
+      # \@table = []
+      # case pattern
+      # when /^\/(.*)\/$/ ; @pattern = /#\{$1}/
+      # else              ; @pattern = pattern
+      # end
+      # # exit unless BaseChip.project.blocks
+    end
+    def after
+      if @table.size > 0
+        print_table(@table,'=>')
+      end
+    end
+
+    desc "Install recipe by name"
+    def recipe(name)
+      fault "This feature is soon forthcoming"
+    end
+
+    desc "Install plugin by name"
+    def plugin(name)
+      fault "This feature is soon forthcoming"
+    end
+
+    desc "Install tool by name"
+    def tool(name, version=nil)
+      before(name)
+      tools = []
+      n = name.to_sym
+      BaseChip.tools.each do |tool|
+        next unless tool.name == n
+        tools << tool
+      end
+      unless tools[0]
+        puts "Available tools are:"
+        ListMenu.new.run_cli(%w{tools --show select_version})
+        fault "No tool found named '#{name}'.  Consider installing a recipe to teach basechip how to install '#{name}'"
+      end
+
+      versions = []
+      tools.each do |tool|
+        tool.configure
+        if version
+          if v = tool.versions[version]
+            versions << v
+          end
+        else
+          versions << tool.selected_version
+        end
+      end
+      unless versions[0]
+        puts "Available versions for tool '#{name}' are:"
+        ListMenu.new.run_cli(['tools', name, '--show', 'available_versions'])
+        fault "No version found named '#{version}' for tool '#{name}'."
+      end
+      puts "Installing version(s) #{versions.map{|v|v.name}.uniq} for tool '#{name}'"
+      installed = []
+      versions.each do |version|
+        next if installed.include? version.name
+        installed << version.name
+        version.configure
+        fault "shared_directory must be specified in project for install locations" unless version.project.shared_directory
+        puts   "cd #{version.project.shared_directory}\n#{version.install}"
+        system "cd #{version.project.shared_directory}\n#{version.install}"
+      end
+    end
+  end
+end

data/lib/base_chip/ipc.rb

@@ -0,0 +1,50 @@
+# Copyright 2011 Tommy Poulter
+#
+# This file is part of basechip.
+#
+# basechip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+# 
+# basechip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with basechip.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'drb'
+
+# require 'zmq'
+# require 'ffi'
+Thread.abort_on_exception = true
+
+module BaseChip
+  module Ipc
+    def self.included mod
+      mod.extend Ipc::ClassMethods
+      mod.class_eval do
+        include Ipc::InstanceMethods
+      end
+    end
+    module ClassMethods
+      # class instance variables
+    end
+    module InstanceMethods
+      def init_test_sockets(type = :client) # or :server
+        DRb.start_service nil, self
+        if @client_of
+          @server = DRbObject.new nil, @client_of
+          @server.register_client(DRb.uri)
+        else
+          @clients_ready = []
+          @clients_all   = []
+        end
+      end
+      def register_client(address)
+        @clients_all << DRbObject.new(nil, address)
+      end
+    end
+  end
+end

data/lib/base_chip/list_menu.rb

@@ -0,0 +1,134 @@
+# Copyright 2011 Tommy Poulter
+#
+# This file is part of basechip.
+#
+# basechip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+# 
+# basechip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with basechip.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'base_chip/menu'
+module BaseChip
+  class ListMenu < Menu
+    include Cli
+    def before(pattern)
+      BaseChip.load_environment
+      @table = []
+      case pattern
+      when /^\/(.*)\/$/ ; @pattern = /#{$1}/
+      else              ; @pattern = pattern
+      end
+      exit unless BaseChip.project.blocks
+    end
+    def after
+      if @table.size > 0
+        print_table(@table,'=>')
+      end
+    end
+
+    option :show, :description=>"Show a data element for each listed item", :type=>:string, :alias=>[:s]
+
+    desc "List available blocks matching pattern"
+    def blocks(pattern=nil)
+      before(pattern)
+      BaseChip.blocks.each do |block|
+        smart_print block.name.to_s, block
+      end
+      after
+    end
+
+    desc "List available configurations matching pattern"
+    def configurations(pattern=nil)
+      before(pattern)
+      BaseChip.configurations.each do |configuration|
+        name   = configuration.name
+        b_name = configuration.block.name
+        smart_print "#{b_name}:#{name}", configuration, b_name.to_s, name.to_s
+      end
+      after
+    end
+
+    desc "List available actions matching pattern"
+    def actions(pattern=nil)
+      before(pattern)
+      BaseChip.actions.each do |action|
+        name = action.name
+        c = action.configuration
+        b = c.block
+        smart_print "#{b.name}:#{c.name}:#{name}", action, b.name.to_s, c.name.to_s, name.to_s
+      end
+      after
+    end
+
+    desc "List available test lists matching pattern"
+    def test_lists(pattern=nil)
+      before(pattern)
+      BaseChip.test_lists.each do |list|
+        name = list.name
+        c = list.configuration
+        b = c.block
+        smart_print "#{b.name}:#{c.name}:#{name}", list, b.name.to_s, c.name.to_s, name.to_s
+      end
+      after
+    end
+
+    desc "List available tests matching pattern"
+    def tests(pattern=nil)
+      before(pattern)
+      BaseChip.tests.each do |test|
+        name = test.name
+        l = test.test_list
+        c = l.configuration
+        b = c.block
+        smart_print "#{b.name}:#{c.name}:#{l.name}:#{name}", test, b.name.to_s, c.name.to_s, l.name.to_s, name.to_s
+      end
+      after
+    end
+
+    desc "List available tools matching pattern"
+    def tools(pattern=nil)
+      before(pattern)
+      BaseChip.tools.each do |tool|
+        name = tool.name
+        smart_print [name,"used by #{tool.configuration.full_name}"], tool, name.to_s
+      end
+      after
+    end
+
+    desc "List available plugins matching pattern"
+    option :remote , :description=>"list downloadable plugins", :type=>:string , :alias=>[:r]
+    def plugins(pattern=nil)
+      fault "This feature is soon forthcoming"
+    end
+
+    desc "List available recipes matching pattern"
+    option :remote , :description=>"list downloadable recipes", :type=>:string , :alias=>[:r]
+    def recipes(pattern=nil)
+      fault "This feature is soon forthcoming"
+    end
+
+    desc "List the workload that would run if the listed targets were supplied on the command line"
+    full_usage "<targets+> [options]"
+    default
+    def workload(*targets)
+      if targets.empty?
+        help
+        fault "please specify targets"
+      end
+      BaseChip.load_environment
+      @table = []
+      BaseChip.project.dereference_workload(targets).each do |item|
+        list_line item.full_name, item
+      end
+      after
+    end
+
+  end
+end

data/lib/base_chip/menu.rb

@@ -0,0 +1,70 @@
+# Copyright 2011 Tommy Poulter
+#
+# This file is part of basechip.
+#
+# basechip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+# 
+# basechip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with basechip.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'thor'
+require 'reporting'
+module BaseChip
+  class Menu # < Thor
+    include Reporting
+    def smart_print(string, object, *array)
+      if @pattern == nil
+        list_line(string,object)
+        return
+      end
+      if @pattern.is_a? Regexp
+        if string.is_a? Array
+          array += string
+        else
+          array << string
+        end
+        array.each do |str|
+          if str =~ @pattern
+            list_line(string,object)
+            return
+          end
+        end
+      else
+        if array.include? @pattern
+          list_line(string,object)
+          return
+        end
+        if string == @pattern
+          list_line(string,object)
+          return
+        end
+      end
+    end
+    def list_line(string,object)
+      array = (string.is_a? Array) ? string : [string]
+
+      if self.options.show
+        object.configure
+        tmp = object
+        self.options.show.split(/\./).each do |fun|
+          fault("Object of type #{tmp.respond_to?(:class_string) ? tmp.class_string : tmp.class} does not have a data element #{fun.inspect}") unless tmp.respond_to?(fun)
+          tmp = tmp.send(fun)
+        end
+        array << tmp
+      end
+
+      if array.size == 1
+        puts string
+      else
+        @table << array
+      end
+    end
+  end
+end

data/lib/base_chip/out_file.rb

@@ -0,0 +1,68 @@
+# Copyright 2011 Tommy Poulter
+#
+# This file is part of basechip.
+#
+# basechip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+# 
+# basechip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with basechip.  If not, see <http://www.gnu.org/licenses/>.
+
+module BaseChip
+  class OutFile
+    include Dsl
+    include Base
+    include TrackState
+    define_children({:statistic     =>   Statistic        })
+    define_settings({:warning_regex => [ Regexp  , Array ],
+                     :error_regex   => [ Regexp  , Array ],
+                     :pass_regex    => [ Regexp  , Array ],
+                     :optional      => [ Boolean         ],
+                     :min_ratio     => [ Array           ],
+                     :max_ratio     => [ Array           ],
+                     :file_delay    => [ Integer         ]})
+
+    attr_accessor :totals
+
+    def initialize
+      super
+      @totals = {}
+    end
+    # def find_parent_values
+    #   super 
+    #   @warning_regex = to_regex(@warning_regex) if @warning_regex
+    #   @error_regex   = to_regex(@error_regex  ) if @error_regex  
+    #   @pass_regex    = to_regex(@pass_regex   ) if @pass_regex   
+    # end
+    def go(name)
+      sleep(@file_delay || 0)
+      files = Dir.glob(@name.to_s)
+      error!(@name,"Could not find any files matching #{@name}") unless files[0] || @optional
+
+      # FIXME fault if file doesn't exist
+      files.each do |fname|
+        f = File.open(fname,'r')
+        f.each do |l| 
+          if @warning_regex && (match = @warning_regex.match(l)); warning!(fname,match.to_s) end 
+          if @error_regex   && (match = @error_regex  .match(l)); error!(  fname,match.to_s) end 
+          if @pass_regex    && (match = @pass_regex   .match(l)); pass!                      end 
+          if @statistics
+            @statistics.each_value do |s|
+              fault("statistic '#{s.full_name}' has no regex defined") unless s.regex
+              if match = s.regex.match(l); @totals[s.name] = (match[1] && match[1].to_i) || 1 end
+            end
+          end
+        end
+        if @pass_regex && @state.nil?
+          error!(fname,"passing banner /#{@pass_regex}/ could not be found")
+        end
+      end
+    end
+  end
+end

data/lib/base_chip/permutation.rb

@@ -0,0 +1,26 @@
+# Copyright 2011 Tommy Poulter
+#
+# This file is part of basechip.
+#
+# basechip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+# 
+# basechip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with basechip.  If not, see <http://www.gnu.org/licenses/>.
+
+module BaseChip
+  class Permutation
+    include Dsl
+    include Base
+
+    def configure
+      @configure = true
+    end
+  end
+end

data/lib/base_chip/permute.rb

@@ -0,0 +1,25 @@
+# Copyright 2011 Tommy Poulter
+#
+# This file is part of basechip.
+#
+# basechip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+# 
+# basechip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with basechip.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'base_chip/permutation'
+
+module BaseChip
+  class Permute
+    include Dsl
+    include Base
+    define_children({:permutation => Permutation})
+  end
+end

data/lib/base_chip/post.rb

@@ -0,0 +1,26 @@
+# Copyright 2011 Tommy Poulter
+#
+# This file is part of basechip.
+#
+# basechip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+# 
+# basechip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with basechip.  If not, see <http://www.gnu.org/licenses/>.
+
+module BaseChip
+  class Post
+    include Dsl
+    include Base
+
+    def configure
+      @configure = true
+    end
+  end
+end

data/lib/base_chip/problem.rb

@@ -0,0 +1,33 @@
+# Copyright 2011 Tommy Poulter
+#
+# This file is part of basechip.
+#
+# basechip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+# 
+# basechip is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with basechip.  If not, see <http://www.gnu.org/licenses/>.
+
+module BaseChip
+  class Problem
+    attr_accessor :bundle
+    attr_accessor :file
+    attr_accessor :signature 
+    def to_s
+      if @bundle 
+        "#{File.absolute_path(@bundle).gsub(/#{Regexp.escape($project_root)}\/?/,'$PROJECT_ROOT/')} #{@file} #{@signature}"
+      else
+                                                                                                   "#{@file} #{@signature}"
+      end
+    end
+    def file_and_signature
+                                                                                                   "#{@file} #{@signature}"
+    end
+  end
+end