basechip 0.0.1

data/lib/base_chip/tool.rb

@@ -0,0 +1,51 @@
+# 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/tool_version'
+
+module BaseChip
+  class Tool
+    include Dsl
+    include Base
+    define_settings({:select_version  => [ String    ],
+                     :default_version => [ String    ]})
+    define_children({:tool_version    =>   ToolVersion})
+
+    def configure
+      return if @configured
+      super
+      @select_version ||= @default_version
+      if selected_version
+        selected_version.configure
+      else
+        fault "Selected version '#{@select_version}' for tool '#{@name}' in '#{parent.full_name}' doesn't exist"
+      end
+    end
+    def selected_version
+      @selected_version ||= @versions[@select_version] if @versions
+    end
+    def path(str=:crazy_default_value)
+      if str == :crazy_default_value
+        @path ||= (selected_version && selected_version.path)
+      else
+        @path = str
+      end
+    end
+    def available_versions
+      versions.keys if versions
+    end
+  end
+end

data/lib/base_chip/tool_version.rb

@@ -0,0 +1,34 @@
+# 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/test_list'
+
+module BaseChip
+  class ToolVersion
+    include Dsl
+    include Base
+    define_settings({:install  => [ Array , String ],
+                     :packages => [ Hash           ],
+                     :path     => [ Hash           ]})
+   #define_children({:action   =>   Action          })
+
+    def configure
+      return if @configured
+      @path = "#{@project.shared_directory}/tools/#{tool.name}/#{@name}"
+      super
+    end
+  end
+end

data/lib/base_chip/top_menu.rb

@@ -0,0 +1,203 @@
+# 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 TopMenu < Menu
+    include Cli
+    def ready_workload(*args)
+      @targets = args
+      BaseChip.load_environment
+      @project = BaseChip.project
+      @project.ready(@targets) if @targets.size > 0
+    end
+
+    option :yes  , :description=>"Accept defaults on any posed questions", :type=>:boolean, :alias=>[:y]
+    option :modes, :description=>"Enable predefined modes"               , :type=>:string , :alias=>[:m]
+
+    desc "Create a new project"
+    option :git, :description=>"Set up as a git repository", :type=>:boolean, :alias=>[:g,:r,:repo]
+    def init(project_name)
+      BaseChip.project = project_name
+      BaseChip.root    = "./#{project_name}"
+      FileUtils.mkdir_p BaseChip.root
+      BaseChip.build_directory_structure(BaseChip.root, BaseChip.project_directories)
+      BaseChip.erb_template "#{BaseChip::GEM_DIR}/collateral/project/settings.rb.erb", "#{BaseChip.root}/base_chip/settings.rb"
+      FileUtils.cp          "#{BaseChip::GEM_DIR}/collateral/project/gitignore"      , "#{BaseChip.root}/.gitignore"
+      FileUtils.cd          BaseChip.root
+
+      if options.git
+        system "git init ."
+        system "git add ./base_chip ./.gitignore"
+        system "git commit -m 'Initial automated project build by BaseChip.' ."
+
+        normal "Your project has been created.\n" +
+               "Your next step is probably to generate a block.\n" +
+               "You can learn more by entering your newly created directory, and typing:\n" +
+               "  basechip help generate block"
+      end
+    end
+
+    desc "Generate a block, tool, testbench, etc"
+    sub_command :generate, GeneratorMenu
+
+    desc  'Install a recipe, plugin, or tool'
+    sub_command :install, InstallMenu
+
+    desc "List blocks, actions, tools, tests, etc"
+    long "If 'pattern' is given as a string, it must completely match the name of the block/action/test/test_list\n" +
+         "    or one of it's parents.  If surrounded by '/', the pattern will be considered a regular expression\n"  +
+         "    and will be compared to the full name of the item including it's parents' names separated by colons."
+    sub_command :list, ListMenu
+
+    desc  'Execute targets'
+    full_usage 'basechip <targets+> [options]'
+    default
+    option :work_dir       , :description=>"Working directory other than cwd"     , :type=>:string , :alias=>[:w]
+    option :max_fails      , :description=>"Working directory other than cwd"     , :type=>:string , :alias=>[:f]
+    option :max_passes     , :description=>"Working directory other than cwd"     , :type=>:string , :alias=>[:p]
+    option :repeat         , :description=>"Repeat each test 'r' times"           , :type=>:integer, :alias=>[:r]
+    option :jobs           , :description=>"Number of jobs, and for which cluster", :type=>:string , :alias=>[:j]
+    option :seed           , :description=>"Root seed for all actions"            , :type=>:integer, :alias=>[:s]
+    option :client_of      , :description=>"Internal use only"                    , :type=>:string
+    option :client_id      , :description=>"Internal use only"                    , :type=>:integer 
+    option :opc            , :description=>"Internal use only"                    , :type=>:string
+    option :opi            , :description=>"Internal use only"                    , :type=>:string
+    def exec(*args)
+      begin
+        fault "Repeat is a planned feature" if BaseChip.options.repeat
+
+        args << 'all' if options.client_of && args.size == 0
+        ready_workload(*args)
+
+        @project.enable_tracking(options.opc,options.opi) if options.opc
+        @project.tasker.clusters = @project.dereference_clusters
+        @project.tasker.client_of = options.client_of
+        @project.tasker.client_id = options.client_id || 0
+
+        if options.client_of
+          @project.tasker.run
+        else
+          if @targets.size > 0
+            begin
+              @project.run_all_readied
+              # @project.track_complete 'pass'
+            rescue Reporting::Fault => e
+              # @project.track_complete 'fail', e.message
+              exit 1
+            rescue RuntimeError => e
+              # @project.track_complete 'fail', e.message
+              p e
+              raise e
+            end
+          end
+        end
+      rescue Interrupt # quetly handle the interrupt of clients
+        raise unless options.client_of 
+      end
+    end
+
+    desc  'rerun targets.  Some output remains'
+    def rerun(bundle_path)
+      fault "#{bundle_path} does not exist" unless File.exist?(bundle_path)
+      case bundle_path
+      when /(.*)\.tgz$/ 
+        puts "Unzipping #{bundle_path}"
+        system "tar -zxvf #{bundle_path}"
+        bundle_path = $1
+      end
+      fault "#{bundle_path}/rerun.yaml does not exist" unless File.exist?("#{bundle_path}/rerun.yaml")
+      rerun_hash = YAML.load(File.read("#{bundle_path}/rerun.yaml"))
+      BaseChip.options.seed            ||= rerun_hash['seed' ]
+      BaseChip.options.modes           ||= rerun_hash['modes']
+      BaseChip.options. append_arguments = (BaseChip.options. append_arguments || []) + (rerun_hash[' append_arguments'] || [])
+      BaseChip.options.replace_arguments = (BaseChip.options.replace_arguments || []) + (rerun_hash['replace_arguments'] || [])
+      BaseChip.options. append_arguments = nil if BaseChip.options. append_arguments.empty?
+      BaseChip.options.replace_arguments = nil if BaseChip.options.replace_arguments.empty?
+      ready_workload(rerun_hash['full_name'])
+      @project.workload.first.directory "#{@project.workload.first.directory}.rerun"
+      @project.run_all_readied
+    end
+
+    desc  'Clean targets.  Some output remains'
+    usage '<targets+> [options]'
+    def clean(*args)
+      ready_workload(*args)
+      @project.workload.each do |w|
+        w.clean
+      end
+    end
+
+    desc  'Destroy all output relate to targets'
+    usage '<targets+> [options]'
+    def clobber(*args)
+      ready_workload(*args)
+      @project.workload.each do |w|
+        w.clobber
+      end
+    end
+
+    # desc  'Return completion options for a command'
+    # def complete
+    #   args    = BaseChip.options. append_arguments
+    #   current = BaseChip.options.replace_arguments[0]
+    #   args.shift
+
+    #   out = []
+    #   tasks = TopMenu.cli.tasks.keys.map{|s|s.to_s}
+
+    #   # if args.empty?
+    #   #   if current
+    #   #     tasks = TopMenu.cli.tasks.keys.map{|s|s.to_s}
+    #   #     if tasks.include? current
+    #   #       puts current
+    #   #       return
+    #   #     end
+    #   #   else
+    #   #     if tasks.include? current
+    #   #       puts current
+    #   #       return
+    #   #     end
+    #   #   end
+    #   # end
+    #   # case args[0]
+    #   # when (*%w{clean clobber})
+    #   #   out += BaseChip.blocks.map{|b|b.name}
+    #   # else
+    #   #   ready_workload('all')
+    #   #   out += TopMenu.cli.tasks.keys
+    #   #   out += BaseChip.blocks.map{|b|b.name}
+    #   # end
+
+    #   if self.class.workload_commands.include? argv[0]
+    #     ready_workload('all')
+    #     if current
+    #     else
+    #       out += BaseChip.blocks.map{|b|b.name.to_s}.keep_if{|b| b=~ /^#{current}/}
+    #     end
+    #   end
+    #   puts out.join(" ")
+    # end
+    # def self.workload_commands
+    #   return @@workload_commands if @@workload_commands
+    #   @@workload_commands = [nil]
+    #   self.cli.tasks.each do |k,v|
+    #     @@workload_commands << k.to_s if v.usage =~ /targets/
+    #   end
+    #   @@workload_commands
+    # end
+  end
+end

data/lib/base_chip/track_state.rb

@@ -0,0 +1,61 @@
+# 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/problem'
+module BaseChip
+  module TrackState
+    def self.included mod
+      mod.extend TrackState::ClassMethods
+      mod.class_eval do
+        include TrackState::InstanceMethods
+        attr_accessor :state
+        attr_accessor :problem
+        attr_accessor :problems
+      end
+    end
+    module ClassMethods
+    end
+    module InstanceMethods
+      def pass!        ;          @state ||= 'pass'                                            end
+      def warning!(f,s); np(f,s); @state   = 'warning' if @state.nil? or @state.pass?          end
+      def error!(  f,s); np(f,s); @state   = (@state =~ /fault/) ? 'error && fault' : 'error'  end
+      def fault!(  f,s); np(f,s); @state   = (@state =~ /error/) ? 'error && fault' : 'fault'  end
+
+      def pass?    ; @state == 'pass'    end
+      def warning? ; @state == 'warning' end
+      def error?   ; @state =~ /fault/   end
+      def fault?   ; @state =~ /error/   end
+
+      def np(file,signature)
+        return if @problem
+        @problem = Problem.new
+        @problem.file      = file
+        @problem.signature = signature
+        @problem
+      end
+
+      def take_state(thing)
+        return if @problem
+        @state   = thing.state
+        @problem = thing.problem
+      end
+
+      def first_error        ; @problem && @problem.to_s      end
+      def first_signature    ; @problem && @problem.signature end
+      def first_problem_file ; @problem && @problem.file      end
+    end
+  end
+end

data/lib/base_chip.rb

@@ -0,0 +1,215 @@
+# 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 'fileutils'
+require 'open3'
+require 'erb'
+# require "bundler/setup"
+
+require 'archive/tar/minitar'
+require 'active_support/inflector'
+require 'dir'
+
+require 'base_chip/ipc.rb'
+require 'base_chip/taskable'
+require 'base_chip/task'
+require 'base_chip/tasker'
+require 'base_chip/task_master'
+
+require 'base_chip/cli'
+require 'base_chip/base'
+require 'base_chip/dsl'
+require 'base_chip/tool'
+require 'base_chip/project'
+require 'base_chip/generator_menu'
+require 'base_chip/list_menu'
+require 'base_chip/install_menu'
+require 'base_chip/top_menu'
+require 'base_chip/git'
+module BaseChip
+  include Reporting
+
+  RANDOM_NAME_PIECES = ('0'..'9').to_a + ('a'..'z').to_a +  ('A'..'Z').to_a
+  RANDOM_NAME_PIECES_SIZE = RANDOM_NAME_PIECES.size
+  def self.random_string(size=10)
+    str = ''
+    size.times do
+      str += RANDOM_NAME_PIECES[rand(RANDOM_NAME_PIECES_SIZE)]
+    end
+    str
+  end
+
+  GEM_DIR = File.expand_path('../..',  File.realpath(__FILE__))
+  def self.root=(root)           ; @root    = root      ; end
+  def self.root                  ; @root                ; end
+  def self.project=(project)     ; @project = project   ; end
+
+  @@options = OpenStruct.new
+  def self.options
+    @@options
+  end
+
+  def self.find_root(dir = nil, passive=false)
+    dir ||= @work_dir ||= Dir.pwd
+    @dirs_to_top = []
+    loop do
+      @dirs_to_top << dir
+      break if File.exist? dir + '/base_chip/settings.rb'
+
+      if dir == '/'
+        return nil if passive
+        fault "Couldn't find file 'base_chip/settings.rb' in any directory above #{Dir.pwd}.\n" +
+              "'base_chip/settings.rb' is expected to reside at the top of the checked " +
+              "out project, and is generated using the command 'base_chip init'."
+      end
+      dir = File.expand_path(dir + '/../')
+    end
+    $project_root = @root = dir
+  end
+
+  def self.build_directory_structure(dir, array)
+    array.each do |subdir|
+      FileUtils.mkdir_p dir + "/" + subdir
+    end
+  end
+  def self.erb_template(in_file, out_file)
+    erb = ERB.new(File.read in_file)
+    erb.filename = in_file
+    File.open(out_file,'w') do |f|
+      f.print(erb.result)
+    end
+  end
+
+  def self.      project_directories ;       @@project_directories end 
+  def self.        block_directories ;         @@block_directories end
+  def self.configuration_directories ; @@configuration_directories end
+  @@common_directories = %w{
+      base_chip/tools
+      base_chip/recipes
+      base_chip/actions
+      base_chip/test_lists
+      documentation
+  } # base_chip/configurations questionable FIXME
+  @@configuration_directories = 
+    @@common_directories +
+    %w{
+      rtl/verilog
+      rtl/headers
+      rtl/vhdl
+      rtl/systemc
+      gates
+      testbench/verilog
+      testbench/headers
+      testbench/classes
+      testbench/vhdl
+      testbench/systemc
+      synthesis
+      timing
+      sw
+    }
+  @@block_directories = 
+    @@configuration_directories +
+    %w{
+      base_chip/configurations
+    }
+  @@project_directories = 
+    @@common_directories +
+    %w{
+      base_chip/plugins
+      base_chip/subprojects
+      base_chip/blocks
+      base_chip/configurations
+      base_chip/cluster_types
+    }
+
+  def self.project(name = nil, &blk)
+    if name
+      @project = Project.new
+      @project.name = name
+      @project.blks << blk
+    else
+      @project
+    end
+  end
+  # SAFE TO DELETE? def self.action(name, &b)
+  # SAFE TO DELETE?   @action_builders       ||= {}
+  # SAFE TO DELETE?   @action_builders[name] ||= []
+  # SAFE TO DELETE?   @action_builders[name] <<  b
+  # SAFE TO DELETE? end
+  def self.load_environment
+    find_root
+    file = "#{BaseChip.root}/base_chip/settings.rb"
+    instance_eval(File.read(file),file)
+    file = '~/.basechip'
+    instance_eval(File.read(file),file) if File.exist? file
+    @project.configure
+  end
+
+  def self.blocks
+    @project.blocks.values
+  end
+  def self.get_children(parents, child_name)
+    a = []
+    parents.each do |item|
+      item.configure
+      tmp = item.send(child_name)
+      next unless tmp
+      a += tmp.values
+    end
+    a.uniq!
+    a
+  end
+  def self.configurations ; @configurations ||= get_children(self.blocks         , :configurations) end
+  def self.actions        ; @actions        ||= get_children(self.configurations , :actions       ) end
+  def self.test_lists     ; @test_lists     ||= get_children(self.configurations , :test_lists    ) end
+  def self.tests          ; @tests          ||= get_children(self.test_lists     , :tests         ) end
+  def self.tools          ; @tools          ||= get_children(self.configurations , :tools         ) end
+
+  def self.version_control
+    @version_control ||= (Git.new(root) if File.exist?("#{root}/.git"))
+  end
+
+  @@random_generator = nil
+  def self.random_generator
+    @@random_generator ||= if @@options.seed
+                             Random.new(@@options.seed    )
+                           else
+                             Random.new(rand(0x1_0000_0000))
+                           end
+  end
+  def self.new_random_generator
+    if @@options.seed
+      random_generator
+    else
+      Random.new(random_generator.rand(0x1_0000_0000))
+    end
+  end
+end
+
+unless $BASE_CHIP_INCLUDE_MODE
+  if BaseChip.find_root(nil,true)
+    Dir.glob("#{BaseChip.root}/base_chip/plugins/*").each do |dir|
+      file = "#{dir}/lib/#{File.basename(dir)}.rb"
+      if File.exist?(file)
+        require file
+      else
+        raise "#{file} doesn't exist within plugin folder #{dir}"
+      end
+    end
+  end
+  BaseChip::TopMenu.new.run_cli
+end
+

data/lib/dir.rb

@@ -0,0 +1,30 @@
+# 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/>.
+
+class Dir
+  @@pushd_stack = []
+  def self.pushd(d)
+    @@pushd_stack << Dir.pwd
+    Dir.chdir d
+  end
+  def self.popd
+    if d = @@pushd_stack.pop
+      Dir.chdir d
+    else
+      raise "directory stack empty, pwd = #{Dir.pwd}"
+    end
+  end
+end

data/lib/reporting.rb

@@ -0,0 +1,97 @@
+# 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 'base_chip/problem'
+
+module BaseChip
+  class ReportingError < RuntimeError
+    attr :message
+    attr :file
+    attr :bundle
+    def initialize(message,file=nil,bundle=nil)
+      if message.is_a? Problem
+        @message = message.signature
+        @file    = message.file
+        @bundle  = message.bundle
+      else
+        @message = message
+        @file    = file
+        @bundle  = bundle
+      end
+    end
+  end
+  module Reporting
+    class Fault < RuntimeError;
+      # attr_accessor :msg
+      # def initialize(msg)
+      #   @msg = msg
+      # end
+    end
+    def self.included mod
+      mod.extend Reporting::Methods
+      mod.class_eval do
+        include Reporting::Methods
+      end
+    end
+    module Methods
+      def error(msg)
+        re = ReportingError.new(msg)
+        message "error", re.message, :red
+        raise re
+      end
+      def fault(msg,exception_msg=nil)
+        message "fault", msg, :red # = "#{Process.pid} #{$0} #{ARGV.join( ' ' )} #{msg}"
+        DRb.stop_service
+        # raise Fault, (exception_msg || msg) # FIXME -- when to raise?
+        exit 0
+      end
+      def normal(msg)
+        puts msg unless $quiet
+      end
+      def verbose(msg)
+        puts msg if $verbose
+      end
+      def debug(msg)
+        message "Debug", msg if $debug
+      end
+      def message(type,msg,color = nil)
+        clear_line if self.respond_to? :clear_line
+        ostring = case color
+                  when :red   ; ""
+                  when :green ; ""
+                  when nil    ; ''
+                  else raise
+                  end
+        msg.chomp!
+        if msg =~ /\n/
+          ostring += "+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n"
+          ostring += "+++++ #{type}: (Multi-line) +++++++++++++++++++++++++++++++++++++++\n"
+          ostring += "#{msg}\n"
+          ostring += "+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n"
+        else
+          ostring += "#{type}: #{msg}"
+        end
+        ostring += "" if color
+        puts ostring
+        ostring
+      end
+      def class_string
+        self.class.to_s.gsub(/BaseChip::/,'')
+      end
+    end
+  end
+end