origen_sim 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c34ffd12e0b7df9632e5bad4dcb933cb46f88460
-  data.tar.gz: 6690aac5bb4335ac2de29b1757249eba1be026c0
+SHA256:
+  metadata.gz: 6b34633d6530aedd5b581ff1bda44c6e727d72b76a3288dbde6f17c272c9b4a9
+  data.tar.gz: 82a82bdc494d1f39e6a3e8a46361d2a21352543e0839fb96dcb4488615de5a1d
 SHA512:
-  metadata.gz: 71a090ebaa9f1440d3052773b0823187ada5fc10aab7786081b0c8274e079c78b6aab0866d85c90e7f6193c5a243d3c98012cf99e9d13b7078a4924510e3dda2
-  data.tar.gz: a617b1e824ef7b9c36583df618440115f35aac94462b1d9a9601f917444360729d81a26235d72bc5dd2aa91f90e398d1d240233feec2ec0d07e568ae38219d47
+  metadata.gz: 6af3ed9ca21d9ed459ba26e0d4f7e1c3cbb491a26563376b8151bb51dce20f8d4ec21ff0cf058f5aa349e52d058aab09ee5b81e5203b08cdda1cb1a350eaefd3
+  data.tar.gz: 2282439c82a90b725d3191d5ed7c61d1b1c1ade3db935f16beae43a60c202b62e78fa099d3614da5a68cfc1c5c8454e62dc05ee5aeb3fef0c9cf75e2c15f6626

data/config/application.rb

@@ -28,8 +28,23 @@ class OrigenSimApplication < Origen::Application
     #:patterns => "pattern",
     #:templates => "templates",
     #:programs => "program",
-    :command_launcher => "config/shared_commands.rb",
-    :global_launcher => "config/global_commands.rb"
+    command_launcher: "config/shared_commands.rb",
+    global_launcher: "config/global_commands.rb",
+    origen_guides: "templates/origen_guides",
+    origen_guides_index: -> (index) do
+      index.section :simulation, heading: "Simulation", after: :program do |section|
+        section.page :introduction, heading: "Introduction"
+        section.page :howitworks, heading: "How It Works"
+        section.page :compiling, heading: "Compiling the DUT"
+        section.page :environment, heading: "Environment Setup"
+        section.page :app, heading: "Application Setup"
+        section.page :patterns, heading: "Simulating Patterns"
+        section.page :flows, heading: "Simulating Flows"
+        section.page :log, heading: "Simulator Log Output"
+        section.page :artifacts, heading: "Artifacts"
+        section.page :debugging, heading: "Interactive Debugging"
+      end
+    end
   }
 
   config.remotes = [

data/config/shared_commands.rb

@@ -11,6 +11,13 @@ when 'generate'
 
   @application_options << ["--flow NAME", "Simulate multiple patterns back-back within a single simulation with the given name", ->(options, name) { OrigenSim.flow = name }]
 
+  @application_options << ["--socket_dir PATH", "Specify the directory to be used for creating the Origen -> simulator communication socket (/tmp by default) ", ->(options, path) {
+    FileUtils.mkdir_p(path) unless File.exist?(path)
+    path = Pathname.new(path)
+    path = path.realpath.to_s
+    OrigenSim.socket_dir = path
+  }]
+
 when "sim:ci", "origen_sim:ci"
   require "#{Origen.root!}/lib/origen_sim/commands/ci"
   exit 0

data/config/version.rb

@@ -1,6 +1,6 @@
 module OrigenSim
   MAJOR = 0
-  MINOR = 12
+  MINOR = 13
   BUGFIX = 0
   DEV = nil
 

data/ext/bridge.c

@@ -538,6 +538,7 @@ PLI_INT32 bridge_wait_for_msg(p_cb_data data) {
   UNUSED(data);
   int max_msg_len = 1024;
   char msg[max_msg_len];
+  char comment[128];
   int err;
   char *opcode, *arg1, *arg2, *arg3, *arg4;
   vpiHandle handle;
@@ -706,13 +707,18 @@ PLI_INT32 bridge_wait_for_msg(p_cb_data data) {
         }
         break;
       // Set Comment
-      //   c^Some comment about the pattern
+      //   c^0^Some comment about the pattern
       case 'c' :
-        handle = vpi_handle_by_name(ORIGEN_SIM_TESTBENCH_CAT("debug.comments"), NULL);
         arg1 = strtok(NULL, "^");
+        arg2 = strtok(NULL, "^");
+
+        strcpy(comment, ORIGEN_SIM_TESTBENCH_CAT("debug.comments"));
+        strcat(comment, arg1);
+
+        handle = vpi_handle_by_name(comment, NULL);
 
         v.format = vpiStringVal;
-        v.value.str = arg1;
+        v.value.str = arg2;
         vpi_put_value(handle, &v, NULL, vpiNoDelay);
         break;
       // Log all messages
@@ -757,6 +763,10 @@ PLI_INT32 bridge_wait_for_msg(p_cb_data data) {
       case 'i' :
         client_put(ORIGEN_SIM_VERSION"\n");
         break;
+      // Flush
+      case 'j' :
+        vpi_flush();
+        break;
       default :
         vpi_printf("ERROR: Illegal message received from Origen: %s\n", orig_msg);
         runtime_errors += 1;

data/lib/origen_sim.rb

@@ -6,6 +6,8 @@ require 'origen_sim/origen/pins/pin'
 require 'origen_sim/origen/top_level'
 require 'origen_sim/origen/application/runner'
 module OrigenSim
+  NUMBER_OF_COMMENT_LINES = 10
+
   # THIS FILE SHOULD ONLY BE USED TO LOAD RUNTIME DEPENDENCIES
   # If this plugin has any development dependencies (e.g. dummy DUT or other models that are only used
   # for testing), then these should be loaded from config/boot.rb
@@ -58,6 +60,14 @@ module OrigenSim
     @flow
   end
 
+  def self.socket_dir=(val)
+    @socket_dir = val
+  end
+
+  def self.socket_dir
+    @socket_dir
+  end
+
   def self.error_strings
     @error_strings ||= ['ERROR']
   end

data/lib/origen_sim/artifacts.rb

@@ -0,0 +1,101 @@
+module OrigenSim
+  module Artifacts
+    class Artifacts
+      include Origen::Componentable
+
+      # Disable accessors on the simulator. Artifact retrieval must use simulator.artifact[name]
+      COMPONENTABLE_ADDS_ACCESSORS = false
+
+      # Clean up the names a bit. Componentable assumes the class name is the singleton name, but we're doing the opposite here.
+      COMPONENTABLE_SINGLETON_NAME = 'artifact'
+      COMPONENTABLE_PLURAL_NAME = 'artifacts'
+
+      def initialize
+        # Don't need the full extent of Origen::Mdoel, so we'll just init the includer class directly.
+        Origen::Componentable.init_includer_class(self)
+      end
+
+      # Force the class to be an OrigenSim::Artifacts::Artifact
+      def add(name, options = {}, &block)
+        instances = _split_by_instances(name, options, &block)
+        return_instances = []
+        instances.each do |n, opts|
+          opts[:class_name] = OrigenSim::Artifacts::Artifact
+          return_instances << _add(n, opts)
+        end
+
+        return_instances.size == 1 ? return_instances.first : return_instances
+      end
+
+      def populate
+        artifacts.each do |name, artifact|
+          Origen.log.info "Populating artifact: #{artifact.target}"
+          Origen.log.info "                 to: #{artifact.run_target}"
+          artifact.populate
+        end
+        true
+      end
+
+      def clean
+        artifacts.each do |name, artifact|
+          Origen.log.info "Cleaning artifact: #{artifact.run_target}"
+          artifact.clean
+        end
+        true
+      end
+    end
+
+    class Artifact
+      attr_reader :name
+      attr_reader :parent
+
+      def initialize(options)
+        @name = options.delete(:name)
+        @parent = options.delete(:parent)
+        @options = options
+      end
+
+      def target
+        Pathname(@options[:target] || parent.artifact_dir)
+      end
+
+      def run_target
+        run_target = Pathname(@options[:run_target] || parent.artifact_run_dir)
+        if run_target.absolute?
+          run_target.join(target.basename)
+        else
+          parent.artifact_run_dir.join(run_target).join(target.basename)
+        end
+      end
+
+      def populate_method
+        @options[:populate_method] || parent.artifact_populate_method
+      end
+      alias_method :pop_method, :populate_method
+
+      def populate
+        if populate_method == :symlink
+          File.symlink(target, run_target)
+        elsif populate_method == :copy
+          FileUtils.cp(target, run_target)
+        else
+          Origen.app.fail! "Cannot populate artifact :#{name} with populate method #{populate_method}!"
+        end
+      end
+
+      def clean
+        if File.exist?(run_target)
+          if File.symlink?(run_target)
+            File.unlink(run_target)
+          else
+            FileUtils.rm_r(run_target)
+          end
+        end
+      end
+
+      def reconfigure(options)
+        @options = options
+      end
+    end
+  end
+end

data/lib/origen_sim/commands/build.rb

@@ -107,14 +107,6 @@ else
 
   puts
   puts
-  puts 'Testbench and VPI extension created!'
-  puts
-  puts 'This file can be imported into an Origen top-level DUT model to define the pins:'
-  puts
-  puts "  #{output_directory}/#{rtl_top_module}.rb"
-  puts
-  puts 'See below for what to do now to create an Origen-enabled simulation object for your particular simulator:'
-  puts
   puts '-----------------------------------------------------------'
   puts 'Cadence Incisive (irun)'
   puts '-----------------------------------------------------------'
@@ -145,7 +137,7 @@ else
   puts 'Add the following to your build script (AND REMOVE ANY OTHER TESTBENCH!):'
   puts
   puts "  #{output_directory}/origen.v \\"
-  puts "  #{output_directory}/brdige.c \\"
+  puts "  #{output_directory}/bridge.c \\"
   puts "  #{output_directory}/client.c \\"
   puts '  -CFLAGS "-std=c99" \\'
   puts '  +vpi \\'
@@ -187,5 +179,45 @@ else
   puts "  #{output_directory}/origen.vpi"
   puts '  origen.vvp'
   puts
+  puts '-----------------------------------------------------------'
+  puts 'Verdi w/ Synopsys VCS'
+  puts '-----------------------------------------------------------'
   puts
+  puts 'Add the following to your build script (AND REMOVE ANY OTHER TESTBENCH!):'
+  puts
+  puts "  #{output_directory}/origen.v \\"
+  puts "  #{output_directory}/brdige.c \\"
+  puts "  #{output_directory}/client.c \\"
+  puts '  -CFLAGS "-std=c99" \\'
+  puts '  +vpi \\'
+  puts "  #{output_directory}/origen.c \\"
+  puts '  +define+ORIGEN_FSDB=1 \\'
+  puts '  -debug_access+all \\'
+  puts '  +lint=all,noVCDE,noIWU,noVNGS,noCAWM-L,noPORTFRC,noZERO,noNS \\'
+  puts '  -PP \\'
+  puts '  -timescale=1ns/100ps \\'
+  puts '  -full64 \\'
+  puts '  -lca \\'
+  puts '  -kdb \\'
+  puts
+  puts 'Here is an example which may work for the file you just parsed (add additional -incdir options at the end if required):'
+  puts
+  puts "  #{ENV['ORIGEN_SIM_VCS'] || 'vcs'} #{rtl_top} #{output_directory}/origen.v #{output_directory}/bridge.c #{output_directory}/client.c -CFLAGS \"-std=c99\" +vpi #{output_directory}/origen.c +define+ORIGEN_FSDB=1 +incdir+#{Pathname.new(rtl_top).dirname} -debug_access+all +lint=all,noVCDE,noIWU,noVNGS,noCAWM-L,noPORTFRC,noZERO,noNS -PP -timescale=1ns/100ps -full64 -lca -kdb"
+  puts
+  puts 'Copy the following files (produced by vcs) to simulation/<target>/verdi/. within your Origen application:'
+  puts
+  puts '  simv'
+  puts '  simv.daidir'
+  puts
+  puts '-----------------------------------------------------------'
+  puts
+  puts 'Testbench and VPI extension created!'
+  puts
+  puts 'This file can be imported into an Origen top-level DUT model to define the pins:'
+  puts
+  puts "  #{output_directory}/#{rtl_top_module}.rb"
+  puts
+  puts 'See above for what to do now to create an Origen-enabled simulation object for your particular simulator.'
+  puts
+
 end

data/lib/origen_sim/heartbeat.rb

@@ -3,12 +3,24 @@ module OrigenSim
   class Heartbeat < Thread
     attr_reader :socket
 
+    # Can't use this with threads currently because Byebug pauses the sleep,
+    # during a breakpoint, which means that the simulator is killed.
+    # Currently working around via a forked process implementation instead
+    # whenever this is set to false.
+    THREADSAFE = false
+
     def initialize(socket)
       @socket = socket
       @continue = true
       super do
         while @continue
-          socket.write("OK\n")
+          begin
+            socket.write("OK\n")
+          rescue Errno::EPIPE => e
+            Origen.log.error 'Communication with the simulation monitor has been lost!'
+            sleep 2
+            exit 1
+          end
           sleep 5
         end
       end

data/lib/origen_sim/origen_testers/api.rb

@@ -8,17 +8,83 @@ module OrigenTesters
     end
     alias_method :simulator?, :sim?
 
+    def sim_delay(id, options = {}, &block)
+      if sim? && dut_version <= '0.12.0'
+        OrigenSim.error "Use of sim_delay requires a DUT model compiled with OrigenSim version > 0.12.0, the current dut was compiled with #{dut_version}"
+      end
+      orig_id = id
+      id = "delay_#{id}".to_sym  # Just to make sure it is unique from the sim_capture IDs
+      if @sim_capture || @sim_delay
+        fail 'Nesting of sim_capture and/or sim_delay blocks is not yet supported!'
+      end
+      Origen::OrgFile.open(id) do |org_file|
+        @org_file = org_file
+        if update_capture?
+          @sim_delay = true
+          # This enables errors to be captured in a separate variable so that they don't affect
+          # the overall simulation result
+          start_cycle = cycle_count
+          delay = 0
+          simulator.match_loop do
+            if options[:resolution]
+              if options[:resolution].is_a?(Hash)
+                resolution_in_cycles = time_to_cycles(options[:resolution])
+              else
+                resolution_in_cycles = options[:resolution]
+              end
+            end
+            timeout_in_cycles = time_to_cycles(options)
+            e = -1
+            until (e == simulator.match_errors) || (timeout_in_cycles > 0 ? delay > timeout_in_cycles : false)
+              delay = cycle_count - start_cycle
+              e = simulator.match_errors
+              pre_block_cycle = cycle_count
+              block.call
+              if resolution_in_cycles
+                remaining = resolution_in_cycles - (cycle_count - pre_block_cycle)
+                remaining.cycles if remaining > 0
+              else
+                # Make sure time is advancing, the block does not necessarily have to advance time
+                1.cycle if pre_block_cycle == cycle_count
+              end
+            end
+          end
+          Origen.log.debug "sim_delay #{orig_id} resolved after #{delay} cycles"
+          # We now know how long it took before the block could pass, now record that information
+          # to the org file for next time
+          org_file.record('tester', 'cycle')
+          org_file.file  # Need to call this since we are bypassing the regular capture API here
+          Origen::OrgFile.cycle(delay)
+        else
+          unless org_file.exist?
+            fail "The simulation delay \"#{orig_id}\" has not been simulated yet, re-run this pattern with a simulation target first!"
+          end
+          org_file.read_line do |operations, cycles|
+            cycles.cycles
+          end
+        end
+      end
+      # Finally execute the block after waiting
+      if options[:padding]
+        time_to_cycles(options[:padding]).cycles
+      end
+      block.call
+      @sim_delay = nil
+    end
+
     def sim_capture(id, *pins)
-      if @sim_capture
-        fail 'Nesting of sim_capture blocks is not yet supported!'
+      if @sim_capture || @sim_delay
+        fail 'Nesting of sim_capture and/or sim_delay blocks is not yet supported!'
       end
+      @sim_capture_id = id
       options = pins.last.is_a?(Hash) ? pins.pop : {}
       pins = pins.map { |p| p.is_a?(String) || p.is_a?(Symbol) ? dut.pin(p) : p }
       pins.each(&:save)
       @sim_capture = pins.map { |p| [p, "origen.dut.#{p.rtl_name}"] }
       Origen::OrgFile.open(id) do |org_file|
         @org_file = org_file
-        if update_capture?
+        @update_capture = update_capture?
+        if @update_capture
           @sim_capture.each { |pin, net| pin.record_to_org_file(only: :assert) }
         end
         yield
@@ -34,7 +100,7 @@ module OrigenTesters
         # really assume that it will be constant for all cycles covered by the repeat
         cycles = options.delete(:repeat) || 1
         cycles.times do
-          if update_capture?
+          if @update_capture
             _origen_testers_cycle(options)
             @sim_capture.each do |pin, net|
               pin.assert(simulator.peek(net))
@@ -45,7 +111,7 @@ module OrigenTesters
             Origen::OrgFile.cycle
           else
             unless @org_file.exist?
-              fail "The simulation capture \"#{id}\" has not been made yet, re-run this pattern with a simulation target first!"
+              fail "The simulation capture \"#{@sim_capture_id}\" has not been simulated yet, re-run this pattern with a simulation target first!"
             end
             apply_captured_data
             _origen_testers_cycle(options)
@@ -70,8 +136,25 @@ module OrigenTesters
     end
 
     def update_capture?
-      return @update_capture if defined? @update_capture
-      @update_capture = sim? && (!@org_file.exist? || Origen.app!.update_sim_captures)
+      sim? && (!@org_file.exist? || Origen.app!.update_sim_captures)
+    end
+
+    def time_to_cycles(options)
+      options = {
+        cycles:         0,
+        time_in_cycles: 0,
+        time_in_us:     0,
+        time_in_ns:     0,
+        time_in_ms:     0,
+        time_in_s:      0
+      }.merge(options)
+      cycles = 0
+      cycles += options[:cycles] + options[:time_in_cycles]
+      cycles += s_to_cycles(options[:time_in_s])
+      cycles += ms_to_cycles(options[:time_in_ms])
+      cycles += us_to_cycles(options[:time_in_us])
+      cycles += ns_to_cycles(options[:time_in_ns])
+      cycles
     end
   end
 end