origen_testers 0.31.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70a6d56474a5185e615615938f92867c97eae3ce7e5ef6539282de2bae8de2e1
-  data.tar.gz: 11395fe59eb06d014ed54222f2fee16f3f19077ccb80e047eb7d1367fe0e9db4
+  metadata.gz: 304c4bb6a3741adaf96f451a6e26172596105d5ac20b9d609ede29dab880095b
+  data.tar.gz: 419c7c5276d6107ffdbab5339c442a71b91be6a7b0ad62facd168a2d29eefc74
 SHA512:
-  metadata.gz: de963dedf5a5568b79206d8469626df8be8f7bd7a31ec84afa2cf395efc8004039f863a979c9080cc6c9efd52243018fc0a37bc4301339c1524f6a076321093f
-  data.tar.gz: 995df0ef974169c733cba653f1ae86a418a392645df0ead8e00d98726fa2ea2da127c83a3ef66dd6c910745b48e073c4a740e2552c25f899026f13925bb1a612
+  metadata.gz: 89fe1fa09bf028c8bd4d4df9d23bd97c7b670ce208319a4f365380eb9fae34dc084ff4bb8d78c596e711d3a0c5056a147f04c4a5b4cdea3b854922ca6c477d71
+  data.tar.gz: ed28f34456af11d5e4a844911a63849aff3bb03684edbe132ebbc3dbd11d7a9248f37166e5eb6966e544653bfded4335115e4cd910d54973dac12854faf74b26

data/config/application.rb

@@ -32,7 +32,9 @@ class OrigenTestersApplication < Origen::Application
         section.page :resources, heading: "Additional Resources"
         section.page :code, heading: "Dynamic Custom Code"
         section.page :j750, heading: "J750 API"
-        section.page :v93k, heading: "V93K API"
+        section.page :v93k, heading: "V93K Common API"
+        section.page :v93ksmt7, heading: "V93K SMT7 API"
+        section.page :v93ksmt8, heading: "V93K SMT8 API"
         section.page :ultraflex, heading: "UltraFLEX API"
         section.page :doc, heading: "Documenting the Program"
         section.page :custom, heading: "Creating Custom Testers"

data/config/shared_commands.rb

@@ -31,6 +31,10 @@ case @command
     $_testers_enable_vector_comments = ARGV.delete("-v") || ARGV.delete("--vector_comments")
     $_testers_no_inline_comments = ARGV.delete("--no_inline_comments")
 
+  when "program"
+    @application_options << ['--original_reference_file', 'Should only be used for regression testing when the reference uses a legacy version of origen_testers',
+                             lambda { |options| OrigenTesters::Generator.original_reference_file = true }]
+
   when "testers:build"
     require "#{Origen.root!}/lib/commands/build"
     exit 0

data/config/version.rb

@@ -1,6 +1,6 @@
 module OrigenTesters
   MAJOR = 0
-  MINOR = 31
+  MINOR = 40
   BUGFIX = 0
   DEV = nil
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')

data/lib/origen_testers/api.rb

@@ -113,6 +113,14 @@ module OrigenTesters
       false
     end
 
+    def smt7?
+      v93k? && smt_version.to_s[0] == '7'
+    end
+
+    def smt8?
+      v93k? && smt_version.to_s[0] == '8'
+    end
+
     def annotate(msg, options = {})
     end
 

data/lib/origen_testers/atp/flow.rb

@@ -222,15 +222,36 @@ module OrigenTesters::ATP
     #     flow.test ...
     #     flow.test ...
     #   end
-    def group(name, options = {})
-      extract_meta!(options) do
-        apply_conditions(options) do
-          children = [n1(:name, name)]
-          children << id(options[:id]) if options[:id]
-          children << on_fail(options[:on_fail]) if options[:on_fail]
-          children << on_pass(options[:on_pass]) if options[:on_pass]
-          g = n(:group, children)
-          append_to(g) { yield }
+    def group(name, options = {}, &block)
+      # The idiomatic way of creating a group in SMT8 is a sub-flow
+      if tester.try(:smt8?)
+        extract_meta!(options) do
+          apply_conditions(options) do
+            parent, sub_flow = *::Flow._sub_flow(name, options, &block)
+            path = sub_flow.output_file.relative_path_from(Origen.file_handler.output_directory)
+            ast = sub_flow.atp.raw
+            name, *children = *ast
+            nodes = [name]
+            nodes << id(options[:id]) if options[:id]
+            nodes << n1(:path, path.to_s)
+            nodes += children
+            ast = ast.updated :sub_flow, nodes,
+                              file:        options.delete(:source_file) || source_file,
+                              line_number: options.delete(:source_line_number) || source_line_number,
+                              description: options.delete(:description) || description
+            ast
+          end
+        end
+      else
+        extract_meta!(options) do
+          apply_conditions(options) do
+            children = [n1(:name, name)]
+            children << id(options[:id]) if options[:id]
+            children << on_fail(options[:on_fail]) if options[:on_fail]
+            children << on_pass(options[:on_pass]) if options[:on_pass]
+            g = n(:group, children)
+            append_to(g) { yield }
+          end
         end
       end
     end

data/lib/origen_testers/flow.rb

@@ -44,6 +44,40 @@ module OrigenTesters
       @unique_ids = val
     end
 
+    # Returns true if this is a top-level Origen test program flow
+    def top_level?
+      top_level == self
+    end
+
+    # Returns the flow's parent top-level flow object, or self if this is a top-level flow
+    def top_level
+      @top_level
+    end
+
+    # Returns the flow's immediate parent flow object, or nil if this is a top-level flow
+    def parent
+      @parent
+    end
+
+    # Returns a hash containing all child flows stored by their ID
+    def children
+      @children ||= {}.with_indifferent_access
+    end
+
+    # Returns the flow's ID prefixed with the IDs of its parent flows, joined by '.'
+    def path
+      @path ||= begin
+        ids = []
+        p = parent
+        while p
+          ids.unshift(p.id)
+          p = p.parent
+        end
+        ids << id
+        ids.map(&:to_s).join('.')
+      end
+    end
+
     def lines
       @lines
     end
@@ -102,8 +136,8 @@ module OrigenTesters
         @throwaway ||= ATP::Flow.new(self)
       else
         @model ||= begin
-          f = program.flow(id, description: OrigenTesters::Flow.flow_comments)
-          @sig = flow_sig(id)
+          f = program.flow(try(:path) || id, description: OrigenTesters::Flow.flow_comments)
+          @sig = flow_sig(try(:path) || id)
           # f.id = @sig if OrigenTesters::Flow.unique_ids
           f
         end

data/lib/origen_testers/generator.rb

@@ -13,12 +13,24 @@ module OrigenTesters
 
     included do
       include Origen::Generator::Comparator
+
+      attr_accessor :output_directory
     end
 
     def self.execute_source(file)
       load file
     end
 
+    # @api private
+    def self.original_reference_file=(val)
+      @original_reference_file = val
+    end
+
+    # @api private
+    def self.original_reference_file
+      !!@original_reference_file
+    end
+
     # When called on a generator no output files will be created from it
     def inhibit_output
       @inhibit_output = true
@@ -94,7 +106,10 @@ module OrigenTesters
       options = {
         include_extension: true
       }.merge(options)
+      # Allow generators to override this and fully define the filename if they want
+      return fully_formatted_filename if try(:fully_formatted_filename)
       name = (@filename || Origen.file_handler.current_file.basename('.rb')).to_s
+      name[0] = '' if name[0] == '_'
       if Origen.config.program_prefix
         unless name =~ /^#{Origen.config.program_prefix}/i
           name = "#{Origen.config.program_prefix}_#{name}"
@@ -105,7 +120,7 @@ module OrigenTesters
       body = f.basename(".#{ext}").to_s
       body.gsub!('_resources', '')
       if defined? self.class::OUTPUT_PREFIX
-        # Unless the fixfix is already in the name
+        # Unless the prefix is already in the name
         unless body =~ /#{self.class::OUTPUT_PREFIX}$/i
           body = "#{self.class::OUTPUT_PREFIX}_#{body}"
         end
@@ -201,17 +216,41 @@ module OrigenTesters
     end
 
     def output_file
-      if respond_to? :subdirectory
-        p = Pathname.new("#{Origen.file_handler.output_directory}/#{subdirectory}/#{filename}")
+      # If an explicit output directory has been set, use it
+      if output_directory
+        p = Pathname.new("#{output_directory}/#{filename}")
+      # Otherwise resolve one
       else
-        p = Pathname.new("#{Origen.file_handler.output_directory}/#{filename}")
+        if respond_to? :subdirectory
+          p = Pathname.new("#{Origen.file_handler.output_directory}/#{subdirectory}/#{filename}")
+        else
+          p = Pathname.new("#{Origen.file_handler.output_directory}/#{filename}")
+        end
       end
       FileUtils.mkdir_p p.dirname.to_s unless p.dirname.exist?
       p
     end
 
     def reference_file
-      Pathname.new("#{Origen.file_handler.reference_directory}/#{filename}")
+      if OrigenTesters::Generator.original_reference_file
+        Pathname.new("#{Origen.file_handler.reference_directory}/#{filename}")
+      else
+        # If an explicit output directory has been set, use it
+        if output_directory
+          sub = Pathname.new(output_directory).relative_path_from(Origen.file_handler.output_directory)
+          dir = File.join(Origen.file_handler.reference_directory, sub)
+          FileUtils.mkdir_p(dir)
+          Pathname.new(File.join(dir, filename))
+        else
+          if respond_to? :subdirectory
+            dir = File.join(Origen.file_handler.reference_directory, subdirectory)
+            FileUtils.mkdir_p(dir)
+            Pathname.new(File.join(dir, filename))
+          else
+            Pathname.new("#{Origen.file_handler.reference_directory}/#{filename}")
+          end
+        end
+      end
     end
 
     def import(file, options = {})

data/lib/origen_testers/interface.rb

@@ -46,6 +46,10 @@ module OrigenTesters
       flow.test(name, options)
     end
 
+    def generating_sub_program?
+      (defined? @@generating_sub_program) ? @@generating_sub_program : false
+    end
+
     # Returns the abstract test program model for the current flow
     def atp
       flow.model
@@ -242,9 +246,21 @@ module OrigenTesters
       nil
     end
 
-    def pattern_references
+    # @api private
+    def clear_pattern_references
+      @@pattern_references = nil
+    end
+
+    # @api private
+    def merge_pattern_references(references)
+      references.each do |name, values|
+        pattern_references(name)[:main][:all].push(*values[:main][:all])
+      end
+    end
+
+    def pattern_references(name = pattern_references_name)
       @@pattern_references ||= {}
-      @@pattern_references[pattern_references_name] ||= {
+      @@pattern_references[name] ||= {
         main:       {
           all:    [],
           origen: [],
@@ -324,6 +340,10 @@ module OrigenTesters
     end
     alias_method :top_level_flow_filename, :top_level_flow
 
+    def discard_top_level_flow
+      @@top_level_flow = nil
+    end
+
     def flow_generator
       flow
     end

data/lib/origen_testers/origen_ext/generator.rb

@@ -9,7 +9,7 @@ module Origen
   class Generator
     include Comparator
 
-    # Makes more sense for this plugin to own this method now
+    # @api private
     def generate_program(file, options)
       Origen.file_handler.resolve_files(file, ignore_with_prefix: '_', default_dir: "#{Origen.root}/program") do |path|
         Origen.file_handler.current_file = path
@@ -17,8 +17,9 @@ module Origen
         j.pattern = path
         j.run
       end
+      yield if block_given?
       Origen.interface.write_files(options)
-      unless options[:quiet] || !Origen.interface.write?
+      unless options[:quiet] || !Origen.interface.write? || options[:skip_referenced_pattern_write]
         if options[:referenced_pattern_list]
           file = "#{Origen.root}/list/#{options[:referenced_pattern_list]}"
         else
@@ -48,7 +49,7 @@ module Origen
         ref_file = File.join(Origen.file_handler.reference_directory, Pathname.new(file).basename)
         check_for_changes(file, ref_file)
       end
-      Origen.interface.on_program_completion(options)
+      Origen.interface.on_program_completion(options) unless options[:skip_on_program_completion]
     end
   end
 end

data/lib/origen_testers/origen_ext/generator/flow.rb

@@ -8,8 +8,6 @@ end
 module Origen
   class Generator
     class Flow
-      alias_method :orig_create, :create
-
       # Create a call stack of flows so that we can work out where the nodes
       # of the ATP AST originated from
       def create(options = {}, &block)
@@ -32,10 +30,18 @@ module Origen
         if OrigenTesters::Flow.flow_comments
           top = false
           name = options[:name] || Pathname.new(file).basename('.rb').to_s.sub(/^_/, '')
-          Origen.interface.flow.group(name, description: flow_comments) do
-            orig_create(options, &block)
+          # Generate imports as separate sub-flow files on this platform
+          if tester.v93k? && tester.smt8?
+            parent, sub_flow = *_sub_flow(name, options, &block)
+            path = sub_flow.output_file.relative_path_from(Origen.file_handler.output_directory)
+            parent.atp.sub_flow(sub_flow.atp.raw, path: path.to_s)
+          else
+            Origen.interface.flow.group(name, description: flow_comments) do
+              _create(options, &block)
+            end
           end
         else
+          @top_level_flow = nil
           OrigenTesters::Flow.flow_comments = flow_comments
           if options.key?(:unique_ids)
             OrigenTesters::Flow.unique_ids = options.delete(:unique_ids)
@@ -43,13 +49,101 @@ module Origen
             OrigenTesters::Flow.unique_ids = true
           end
           top = true
-          orig_create(options, &block)
+          _create(options, &block)
         end
         OrigenTesters::Flow.callstack.pop
         OrigenTesters::Flow.comment_stack.pop
         OrigenTesters::Flow.flow_comments = nil if top
       end
 
+      # @api private
+      def _sub_flow(name, options, &block)
+        @top_level_flow ||= Origen.interface.flow
+        parent = Origen.interface.flow
+        # If the parent flow already has a child flow of this name then we need to generate a
+        # new unique name/id
+        # Also generate a new name when the child flow name matches the parent flow name, SMT8.2
+        # onwards does not allow this
+        if parent.children[name] || parent.name.to_s == name.to_s
+          i = 0
+          tempname = name
+          while parent.children[tempname] || parent.name.to_s == tempname.to_s
+            i += 1
+            tempname = "#{name}_#{i}"
+          end
+          name = tempname
+        end
+        if parent
+          id = parent.path + ".#{name}"
+        else
+          id = name
+        end
+        sub_flow = Origen.interface.with_flow(id) do
+          Origen.interface.flow.instance_variable_set(:@top_level, @top_level_flow)
+          Origen.interface.flow.instance_variable_set(:@parent, parent)
+          _create(options, &block)
+        end
+        parent.children[name] = sub_flow
+        [parent, sub_flow]
+      end
+
+      # @api private
+      def _create(options = {}, &block)
+        # Refresh the target to start all settings from scratch each time
+        # This is an easy way to reset all registered values
+        Origen.app.reload_target!
+        Origen.tester.generating = :program
+        # Make the top level flow globally available, this helps to assign test descriptions
+        # to the correct flow whenever tests are instantiated from sub-flows
+        if Origen.interface_loaded? && Origen.interface.top_level_flow
+          sub_flow = true
+          if Origen.tester.doc?
+            Origen.interface.flow.start_section
+          end
+        else
+          sub_flow = false
+        end
+        job.output_file_body = options.delete(:name).to_s if options[:name]
+        if sub_flow
+          interface = Origen.interface
+          opts = Origen.generator.option_pipeline.pop || {}
+          Origen.interface.startup(options) if Origen.interface.respond_to?(:startup)
+          interface.instance_exec(opts, &block)
+          Origen.interface.shutdown(options) if Origen.interface.respond_to?(:shutdown)
+          if Origen.tester.doc?
+            Origen.interface.flow.stop_section
+          end
+          interface.close(flow: true, sub_flow: true)
+        else
+          Origen.log.info "Generating... #{Origen.file_handler.current_file.basename}"
+          interface = Origen.reset_interface(options)
+          Origen.interface.set_top_level_flow
+          Origen.interface.flow_generator.set_flow_description(Origen.interface.consume_comments)
+          options[:top_level] = true
+          Origen.interface.flow.instance_variable_set('@top_level', Origen.interface.flow)
+          Origen.interface.flow.on_top_level_set if Origen.interface.flow.respond_to?(:on_top_level_set)
+          Origen.app.listeners_for(:on_flow_start).each do |listener|
+            listener.on_flow_start(options)
+          end
+          Origen.interface.startup(options) if Origen.interface.respond_to?(:startup)
+          interface.instance_eval(&block)
+          Origen.interface.shutdown(options) if Origen.interface.respond_to?(:shutdown)
+          interface.at_flow_end if interface.respond_to?(:at_flow_end)
+          Origen.app.listeners_for(:on_flow_end).each do |listener|
+            listener.on_flow_end(options)
+          end
+          interface.close(flow: true)
+        end
+      end
+
+      def reset
+        Origen.interface.clear_top_level_flow if Origen.interface_loaded?
+      end
+
+      def job
+        Origen.app.current_job
+      end
+
       def _extract_comments(file, flow_line)
         flow_comments = []
         comments = {}