origen_sim 0.12.0 → 0.13.0

data/lib/origen_sim/simulation.rb

@@ -91,15 +91,46 @@ module OrigenSim
     # heartbeats.
     def start_heartbeat
       @heartbeat = @server_heartbeat.accept
-      @heartbeat_thread = Heartbeat.new(@heartbeat)
+      if Heartbeat::THREADSAFE
+        @heartbeat_thread = Heartbeat.new(@heartbeat)
+      else
+        @heartbeat_pid = fork do
+          loop do
+            begin
+              @heartbeat.write("OK\n")
+            rescue Errno::EPIPE => e
+              if monitor_running?
+                Origen.log.error 'Communication with the simulation monitor has been lost (though it seems to still be running)!'
+              else
+                Origen.log.error 'The simulation monitor has stopped unexpectedly!'
+              end
+              sleep 2 # To make sure that any log output from the simulator is captured before we pull the plug
+              exit 1
+            end
+            sleep 5
+          end
+        end
+      end
     end
 
     def stop_heartbeat
-      @heartbeat_thread.stop
+      if Heartbeat::THREADSAFE
+        @heartbeat_thread.stop
+      else
+        Process.kill('SIGHUP', @heartbeat_pid)
+
+        # Ensure that the process has stopped before closing the IO pipes
+        begin
+          Process.waitpid(@heartbeat_pid)
+        rescue Errno::ECHILD
+          # Heartbeat process has already stopped, so ignore this.
+        end
+      end
     end
 
     # Open the communication channels with the simulator
-    def open(timeout)
+    def open(monitor_pid, timeout)
+      @monitor_pid = monitor_pid
       timeout_connection(timeout) do
         start_heartbeat
         @stdout = @server_stdout.accept
@@ -169,10 +200,12 @@ module OrigenSim
       @socket.close
       @stderr.close
       @stdout.close
+      @status.close
       File.unlink(socket_id(:heartbeat)) if File.exist?(socket_id(:heartbeat))
       File.unlink(socket_id) if File.exist?(socket_id)
       File.unlink(socket_id(:stderr)) if File.exist?(socket_id(:stderr))
       File.unlink(socket_id(:stdout)) if File.exist?(socket_id(:stdout))
+      File.unlink(socket_id(:status)) if File.exist?(socket_id(:status))
     end
 
     # Returns true if the simulation is running
@@ -186,8 +219,20 @@ module OrigenSim
       end
     end
 
+    # Returns true if the simulation monitor process (the one that receives the heartbeat
+    # and kills the simulation if it stops) is running
+    def monitor_running?
+      return false unless @monitor_pid
+      begin
+        Process.getpgid(@monitor_pid)
+        true
+      rescue Errno::ESRCH
+        false
+      end
+    end
+
     def socket_id(type = nil)
-      @socket_ids[type] ||= "/tmp/#{socket_number}#{type}.sock"
+      @socket_ids[type] ||= "#{OrigenSim.socket_dir || '/tmp'}/#{socket_number}#{type}.sock"
     end
 
     private

data/lib/origen_sim/simulator.rb

@@ -1,10 +1,13 @@
 require 'origen_sim/simulation'
+require 'origen_sim/artifacts'
+
 module OrigenSim
   # Responsible for managing and communicating with the simulator
   # process, a single instance of this class is instantiated as
   # OrigenSim.simulator
   class Simulator
     include Origen::PersistentCallbacks
+    include Artifacts
 
     VENDORS = [:icarus, :cadence, :synopsys, :generic]
 
@@ -116,6 +119,78 @@ module OrigenSim
       end
       @configuration = options
       @tmp_dir = nil
+
+      # Temporary workaround for bug in componentable, which is making the container a class object, instead of an
+      # instance object.
+      clear_artifacts
+
+      # Add any artifacts in the given artifact path
+      if Dir.exist?(default_artifact_dir)
+        default_artifact_dir.children.each { |a| artifact(a.basename.to_s, target: a) }
+      end
+
+      # Add any artifacts from the target-specific path (simulation/<target>/artifacts). Files of the same name
+      # will override artifacts residing in the default directory.
+      if Dir.exist?(target_artifact_dir)
+        target_artifact_dir.children.each do |a|
+          remove_artifact(a.basename.to_s) if has_artifact?(a.basename.to_s)
+          add_artifact(a.basename.to_s, target: a)
+        end
+      end
+
+      # If a user artifact path was given, add those artifacts as well, overriding any of the default and target artifacts
+      if user_artifact_dirs?
+        user_artifact_dirs.each do |d|
+          if Dir.exist?(d)
+            # Add any artifacts from any user-given paths. Files of the same name will override artifacts residing in the default directory.
+            d.children.each do |a|
+              remove_artifact(a.basename.to_s) if has_artifact?(a.basename.to_s)
+              add_artifact(a.basename.to_s, target: a)
+            end
+          else
+            Origen.app.fail! message: "Simulator configuration specified a user artifact dir at #{d} but this directory could not be found!"
+          end
+        end
+      end
+
+      self
+    end
+
+    def default_artifact_dir
+      # Removed this from a constant at the top of the file since it gave boot errors when the file was
+      # being required while Origen.app was still loading
+      Pathname("#{Origen.app.root}/simulation/application/artifacts")
+    end
+
+    def user_artifact_dirs?
+      @configuration.key?(:user_artifact_dirs)
+    end
+
+    def user_artifact_dirs
+      @configuration.key?(:user_artifact_dirs) ? @configuration[:user_artifact_dirs].map { |d| Pathname(d) } : nil
+    end
+
+    def target_artifact_dir
+      Pathname(@configuration[:target_artifact_dir] || "#{Origen.app.root}/simulation/#{Origen.target.name}/artifacts")
+    end
+
+    def artifact_run_dir
+      p = Pathname(@configuration[:artifact_run_dir] || './application/artifacts')
+      if p.absolute?
+        p
+      else
+        Pathname(run_dir).join(p)
+      end
+    end
+
+    def artifact_populate_method
+      @configuration[:artifact_populate_method] || begin
+        if Origen.running_on_windows?
+          :copy
+        else
+          :symlink
+        end
+      end
     end
 
     # The ID assigned to the current simulation target, falls back to to the
@@ -160,7 +235,7 @@ module OrigenSim
     end
 
     def wave_config_file
-      @wave_config_file ||= begin
+      @wave_config_file ||= configuration[:wave_config_file] || begin
         f = "#{wave_config_dir}/#{User.current.id}.#{wave_config_ext}"
         unless File.exist?(f)
           # Take a default wave if one has been set up
@@ -190,7 +265,11 @@ module OrigenSim
       when :cadence
         'svcf'
       when :synopsys
-        'tcl'
+        if configuration[:verdi]
+          'rc'
+        else
+          'tcl'
+        end
       end
     end
 
@@ -231,7 +310,11 @@ module OrigenSim
         cmd += " -nclibdirpath #{compiled_dir}"
 
       when :synopsys
-        cmd = "#{compiled_dir}/simv +socket+#{socket_id} -vpd_file #{wave_file_basename}.vpd"
+        if configuration[:verdi]
+          cmd = "#{compiled_dir}/simv +socket+#{socket_id} +FSDB_ON +fsdbfile+#{Origen.root}/waves/#{Origen.target.name}/#{wave_file_basename}.fsdb +memcbk +vcsd"
+        else
+          cmd = "#{compiled_dir}/simv +socket+#{socket_id} -vpd_file #{wave_file_basename}.vpd"
+        end
 
       when :generic
         # Generic tester requires that a generic_run_command option/block be provided.
@@ -269,6 +352,10 @@ module OrigenSim
       cmd = post_process_run_cmd.call(cmd, self) if post_process_run_cmd
       fail "OrigenSim: :post_process_run_cmd returned object of class #{cmd.class}. Must return a String." unless cmd.is_a?(String)
 
+      # Print the command if debug is enabled
+      Origen.log.debug 'OrigenSim Run Command:'
+      Origen.log.debug cmd
+
       cmd
     end
 
@@ -279,7 +366,11 @@ module OrigenSim
         if Origen.app.current_job
           @last_wafe_file_basename = Pathname.new(Origen.app.current_job.output_file).basename('.*').to_s
         else
-          @last_wafe_file_basename
+          if Origen.interactive?
+            'interactive'
+          else
+            @last_wafe_file_basename
+          end
         end
       end
     end
@@ -308,12 +399,26 @@ module OrigenSim
       when :synopsys
         edir = Pathname.new(wave_config_dir).relative_path_from(Pathname.pwd)
         cmd = "cd #{edir} && "
-        cmd += configuration[:dve] || 'dve'
-        dir = Pathname.new(wave_dir).relative_path_from(edir.expand_path)
-        cmd += " -vpd #{dir}/#{wave_file_basename}.vpd"
-        f = Pathname.new(wave_config_file).relative_path_from(edir.expand_path)
-        cmd += " -session #{f}"
-        cmd += ' &'
+        if configuration[:verdi]
+          unless ENV['VCS_HOME'] && ENV['LD_LIBRARY_PATH']
+            puts 'Please make sure the VCS_HOME and LD_LIBRARY PATH are setup correctly before using Verdi'
+          end
+          edir = Pathname.new(wave_config_dir).relative_path_from(Pathname.pwd)
+          cmd = "cd #{edir} && "
+          cmd += configuration[:verdi] || 'verdi'
+          dir = Pathname.new(wave_dir).relative_path_from(edir.expand_path)
+          cmd += " -ssz -dbdir #{Origen.root}/simulation/#{Origen.target.name}/synopsys/simv.daidir/ -ssf #{dir}/#{wave_file_basename}.fsdb"
+          f = Pathname.new(wave_config_file).relative_path_from(edir.expand_path)
+          cmd += " -sswr #{f}"
+          cmd += ' &'
+        else
+          cmd += configuration[:dve] || 'dve'
+          dir = Pathname.new(wave_dir).relative_path_from(edir.expand_path)
+          cmd += " -vpd #{dir}/#{wave_file_basename}.vpd"
+          f = Pathname.new(wave_config_file).relative_path_from(edir.expand_path)
+          cmd += " -session #{f}"
+          cmd += ' &'
+        end
 
       when :generic
         # Since this could be anything, the simulator will need to set this up. But, once it is, we can print it here.
@@ -359,6 +464,9 @@ module OrigenSim
 
       fetch_simulation_objects
 
+      artifact.clean
+      artifact.populate
+
       cmd = run_cmd + ' & echo \$!'
 
       launch_simulator = %(
@@ -448,10 +556,10 @@ module OrigenSim
 
       Origen.log.debug 'Starting the simulation monitor...'
 
-      simulator_parent_process = spawn("ruby -e \"#{launch_simulator}\"")
-      Process.detach(simulator_parent_process)
+      monitor_pid = spawn("ruby -e \"#{launch_simulator}\"")
+      Process.detach(monitor_pid)
 
-      simulation.open(config[:startup_timeout] || 60) # This will block until the simulation process has started
+      simulation.open(monitor_pid, config[:startup_timeout] || 60) # This will block until the simulation process has started
 
       # The VPI extension will send 'READY!' when it starts, make sure we get it before proceeding
       data = get
@@ -460,6 +568,8 @@ module OrigenSim
         simulation.log_results
         exit  # Assume it is not worth trying another pattern in this case, some kind of environment/config issue
       end
+      Origen.log.info "OrigenSim version #{Origen.app!.version}"
+      Origen.log.info "OrigenSim DUT version #{dut_version}"
       # Tick the simulation on, this seems to be required since any VPI puts operations before
       # the simulation has started are not applied.
       # Note that this is not setting a tester timeset, so the application will still have to
@@ -472,6 +582,14 @@ module OrigenSim
     # Send the given message string to the simulator
     def put(msg)
       simulation.socket.write(msg + "\n")
+    rescue Errno::EPIPE => e
+      if simulation.running?
+        Origen.log.error 'Communication with the simulator has been lost (though it seems to still be running)!'
+      else
+        Origen.log.error 'The simulator has stopped unexpectedly!'
+      end
+      sleep 2 # To make sure that any log output from the simulator is captured before we pull the plug
+      exit 1
     end
 
     # Get a message from the simulator, will block until one
@@ -536,11 +654,16 @@ module OrigenSim
       end
     end
 
-    def write_comment(comment)
+    def write_comment(line, comment)
+      return if line >= OrigenSim::NUMBER_OF_COMMENT_LINES
       # Not sure what the limiting factor here is, the comment memory in the test bench should
       # be able to handle 1024 / 8 length strings, but any bigger than this hangs the simulation
-      comment = comment[0..96]
-      put("c^#{comment}")
+      comment = comment ? comment[0..96] : ''
+      if dut_version > '0.12.1'
+        put("c^#{line}^#{comment} ")  # Space at the end is important so that an empty comment is communicated properly
+      else
+        put("c^#{comment} ")
+      end
     end
 
     # Applies the current state of all pins to the simulation
@@ -624,6 +747,17 @@ module OrigenSim
       end
     end
 
+    # Flush any buffered simulation output, this should cause live wave viewers to
+    # reflect the latest state
+    def flush
+      if dut_version > '0.12.0'
+        put('j^')
+        sync_up
+      else
+        OrigenSim.error "Use of flush requires a DUT model compiled with OrigenSim version > 0.12.0, the current dut was compiled with #{dut_version}"
+      end
+    end
+
     def error(message)
       simulation.logged_errors = true
       Origen.log.error message
@@ -816,11 +950,29 @@ module OrigenSim
     # Returns the version of Origen Sim that the current DUT object was compiled with
     def dut_version
       @dut_version ||= begin
-        put('i^')
-        Origen::VersionString.new(get.strip)
+        # Allow configs to force a dut version, this is to allow backwards compatibility with very early
+        # compiled duts which do not support the command to get it from the compiled object
+        config[:dut_version] || begin
+          put('i^')
+          Origen::VersionString.new(get.strip)
+        end
       end
     end
 
+    # Any vectors executed within the given block will increment the match_errors counter
+    # rather than the errors counter.
+    # The match_errors counter will be returned to 0 at the end.
+    def match_loop
+      poke("#{testbench_top}.pins.match_loop", 1)
+      yield
+      poke("#{testbench_top}.pins.match_loop", 0)
+      poke("#{testbench_top}.pins.match_errors", 0)
+    end
+
+    def match_errors
+      peek("#{testbench_top}.pins.match_errors").to_i
+    end
+
     private
 
     # Pre 0.8.0 the simulator represented the time in ns instead of ps
@@ -830,7 +982,7 @@ module OrigenSim
 
     def clean(net)
       if net =~ /^dut\./
-        "origen.#{net}"
+        "#{testbench_top}.#{net}"
       else
         net
       end

data/lib/origen_sim/stderr_reader.rb

@@ -1,5 +1,4 @@
 require 'thread'
-require 'io/wait'
 module OrigenSim
   class StderrReader < Thread
     attr_reader :socket, :logged_errors
@@ -9,20 +8,27 @@ module OrigenSim
       @continue = true
       @logged_errors = false
       super do
-        while @continue
-          while @socket.ready?
-            line = @socket.gets.chomp
-            if OrigenSim.fail_on_stderr && !line.empty? &&
-               !OrigenSim.stderr_string_exceptions.any? { |s| line =~ /#{s}/ }
-              # We're failing on stderr, so print its results and log as errors if its not an exception.
-              @logged_errors = true
-              Origen.log.error "(STDERR): #{line}"
-            elsif OrigenSim.verbose?
-              Origen.log.info line
-            else
-              Origen.log.debug line
+        begin
+          while @continue
+            line = @socket.gets
+            if line
+              line = line.chomp
+              if OrigenSim.fail_on_stderr && !line.empty? &&
+                 !OrigenSim.stderr_string_exceptions.any? { |s| s.is_a?(Regexp) ? s.match?(line) : line =~ /#{s}/i }
+                # We're failing on stderr, so print its results and log as errors if its not an exception.
+                @logged_errors = true
+                Origen.log.error "(STDERR): #{line}"
+              elsif OrigenSim.verbose?
+                Origen.log.info line
+              else
+                Origen.log.debug line
+              end
             end
           end
+        rescue IOError => e
+          unless e.message =~ /stream closed/
+            raise e
+          end
         end
       end
     end

data/lib/origen_sim/stdout_reader.rb

@@ -1,5 +1,4 @@
 require 'thread'
-require 'io/wait'
 module OrigenSim
   class StdoutReader < Thread
     attr_reader :socket, :logged_errors
@@ -9,25 +8,32 @@ module OrigenSim
       @continue = true
       @logged_errors = false
       super do
-        while @continue
-          while @socket.ready?
-            line = @socket.gets.chomp
-            if OrigenSim.error_strings.any? { |s| line =~ /#{s}/ } &&
-               !OrigenSim.error_string_exceptions.any? { |s| line =~ /#{s}/ }
-              @logged_errors = true
-              Origen.log.error "(STDOUT): #{line}"
-            elsif OrigenSim.warning_strings.any? { |s| line =~ /#{s}/ } &&
-                  !OrigenSim.warning_string_exceptions.any? { |s| line =~ /#{s}/ }
-              Origen.log.warn line
-            else
-              if OrigenSim.verbose? ||
-                 OrigenSim.log_strings.any? { |s| line =~ /#{s}/ }
-                Origen.log.info line
+        begin
+          while @continue
+            line = @socket.gets
+            if line
+              line = line.chomp
+              if OrigenSim.error_strings.any? { |s| s.is_a?(Regexp) ? s.match?(line) : line =~ /#{s}/i } &&
+                 !OrigenSim.error_string_exceptions.any? { |s| s.is_a?(Regexp) ? s.match?(line) : line =~ /#{s}/i }
+                @logged_errors = true
+                Origen.log.error "(STDOUT): #{line}"
+              elsif OrigenSim.warning_strings.any? { |s| s.is_a?(Regexp) ? s.match?(line) : line =~ /#{s}/i } &&
+                    !OrigenSim.warning_string_exceptions.any? { |s| s.is_a?(Regexp) ? s.match?(line) : line =~ /#{s}/i }
+                Origen.log.warn line
               else
-                Origen.log.debug line
+                if OrigenSim.verbose? ||
+                   OrigenSim.log_strings.any? { |s| s.is_a?(Regexp) ? s.match?(line) : line =~ /#{s}/i }
+                  Origen.log.info line
+                else
+                  Origen.log.debug line
+                end
               end
             end
           end
+        rescue IOError => e
+          unless e.message =~ /stream closed/
+            raise e
+          end
         end
       end
     end