ruby-vpi 16.0.1 → 17.0.0

data/lib/ruby-vpi/verilog_parser.rb

@@ -3,8 +3,10 @@
 # Copyright 2006-2007 Suraj N. Kurapati
 # See the file named LICENSE for details.
 
+require 'ruby-vpi/util'
+
 class VerilogParser
-  attr_reader :modules, :constants, :includes
+  attr_reader :modules
 
   # Parses the given Verilog source code.
   def initialize aInput
@@ -14,82 +16,57 @@ class VerilogParser
       input.gsub! %r{//.*$}, ''
       input.gsub! %r{/\*.*?\*/}m, ''
 
-    @modules = input.scan(%r{module.*?;}m).map! do |decl|
-      Module.new decl
-    end
-
-    @constants = input.scan(%r{(`define\s+(\w+)\s+(.+))}).map! do |matches|
-      Constant.new(*matches)
-    end
-
-    @includes = input.scan(%r{(`include\s*(\S+))}).map! do |matches|
-      Include.new(*matches)
+    @modules = input.scan(%r{(module.*?;)(.*?)endmodule}m).map do |matches|
+      Module.new(*matches)
     end
   end
 
-  Constant = Struct.new(:decl, :name, :value)
-  Include = Struct.new(:decl, :target)
-
   class Module
-    attr_reader :decl, :name, :parameters, :ports
+    attr_reader :decl, :body, :name,
+                :ports, :input_ports, :output_ports,
+                :clock_port, :reset_port
 
-    def initialize aDecl
+    def initialize aDecl, aBody
       @decl = aDecl.strip
+      @body = aBody
 
-      @decl =~ %r{module\s+(\w+)\s*(?:\#\((.*?)\))?\s*\((.*?)\)\s*;}m
-      @name, paramDecls, portDecls = $1, $2, $3
+      @decl =~ %r{module\s+(\w+)\s*(?:\#\(.*?\))?\s*(?:\((.*?)\))?\s*;}m
+      @name, portDecls = $1, $2.to_s
 
-      @parameters =
-        if paramDecls =~ %r{\bparameter\b(.*)$}
-          $1.split(',').map! do |decl|
-            Parameter.new decl
-          end
-        else
-          []
-        end
+      @ports        = portDecls.split(',').map {|decl| Port.new decl, self}
+      @input_ports  = @ports.select {|p| p.input?}
+      @output_ports = @ports.select {|p| p.output?}
 
-      @ports = portDecls.split(',').map! do |decl|
-        Port.new decl
-      end
-    end
-
-    class Parameter
-      attr_reader :decl, :name, :value
-
-      def initialize aDecl
-        @decl = aDecl.strip
-        @name, @value = @decl.split('=').map! {|s| s.strip}
-      end
+      @clock_port   = @ports.find {|p| p.name =~ /clock|clo?c?k/i}
+      @reset_port   = @ports.find {|p| p.name =~ /reset|re?se?t/i}
     end
 
     class Port
-      attr_reader :decl, :name, :size
+      attr_reader :decl, :name
 
-      def initialize aDecl
-        @decl = aDecl.strip
+      def initialize aDecl, aModule
+        @decl = aDecl
+        @name = aDecl.scan(/\S+/).last
 
-        @decl =~ /(\[.*?\])?\s*(\w+)$/
-        @size, @name = $1, $2
+        parser = /\b(input|output|inout)\b[^;]*\b#{@name}\b/m
+        aDecl =~ parser || aModule.body =~ parser
+        @type = $1
       end
 
       def input?
-        @decl =~ /\binput\b/
+        @type != 'output'
       end
 
       def output?
-        @decl =~ /\boutput\b/
-      end
-
-      def reg?
-        @decl =~ /\breg\b/
+        @type != 'input'
       end
     end
   end
 end
 
 class String
-  # Converts this string containing Verilog code into syntactically correct Ruby
-  # code.
+  # Converts this string containing Verilog
+  # code into syntactically correct Ruby code.
   def verilog_to_ruby
     content = self.dup
 
@@ -116,9 +93,4 @@ class String
 
     content
   end
-
-  # Converts this string into a valid Ruby constant name.
-  def to_ruby_const_name
-    self[0, 1].upcase << self[1..-1]
-  end
 end

data/lib/ruby-vpi/vpi.rb

@@ -1,28 +1,26 @@
-# A utility layer which transforms the VPI interface into one that is more
-# suitable for Ruby.
+# A utility layer which transforms the VPI interface
+# into one that is more suitable for Ruby.
 #--
 # Copyright 2006-2007 Suraj N. Kurapati
 # See the file named LICENSE for details.
 
 module Vpi
   # Number of bits in PLI_INT32.
-  INTEGER_BITS = 32
+  INTEGER_BITS  = 32
 
   # Lowest upper bound of PLI_INT32.
   INTEGER_LIMIT = 2 ** INTEGER_BITS
 
   # Bit-mask capable of capturing PLI_INT32.
-  INTEGER_MASK = INTEGER_LIMIT - 1
-
+  INTEGER_MASK  = INTEGER_LIMIT - 1
 
   # handles
 
     Handle = SWIG::TYPE_p_unsigned_int
 
-    # An object inside a Verilog simulation (see *vpiHandle* in IEEE Std.
-    # 1364-2005).
-    #
-    # VPI types and properties listed in ext/vpi_user.h can be specified by
+    # A handle is an object inside a Verilog simulation (see
+    # *vpiHandle* in IEEE Std.  1364-2005).  VPI types and
+    # properties listed in ext/vpi_user.h can be specified by
     # their names (strings or symbols) or integer constants.
     #
     # = Example names
@@ -41,17 +39,6 @@ module Vpi
     class Handle
       include Vpi
 
-      # inherit Enumerable methods, such as #each, #map, #select, etc.
-        Enumerable.instance_methods.each do |meth|
-          # using a string because define_method does not accept a block until
-          # Ruby 1.9
-          class_eval %{
-            def #{meth} *args, &block
-              self[*args].send(:#{meth}, &block)
-            end
-          }
-        end
-
       # Tests if the logic value of this handle is unknown (x).
       def x?
         self.hexStrVal =~ /x/i
@@ -72,6 +59,26 @@ module Vpi
         self.hexStrVal = 'z'
       end
 
+      # Tests if the logic value of this handle is at "logic high" level.
+      def high?
+        self.intVal != 0
+      end
+
+      # Sets the logic value of this handle to "logic high" level.
+      def high!
+        self.intVal = 1
+      end
+
+      # Tests if the logic value of this handle is at "logic low" level.
+      def low?
+        self.hexStrVal =~ /^0+$/
+      end
+
+      # Sets the logic value of this handle to "logic low" level.
+      def low!
+        self.intVal = 0
+      end
+
       # Tests if the logic value of this handle is currently at a positive edge.
       def posedge?
         old = @lastVal
@@ -88,18 +95,20 @@ module Vpi
         old == 1 && new == 0
       end
 
-      # Reads the value using the given format (integer constant) and returns a
-      # +S_vpi_value+ object.
+      # Reads the value using the given
+      # format (integer constant) and
+      # returns a +S_vpi_value+ object.
       def get_value_wrapper aFormat
-        val = S_vpi_value.new
+        val        = S_vpi_value.new
         val.format = aFormat
 
         vpi_get_value self, val
         val
       end
 
-      # Reads the value using the given format (name or integer constant) and
-      # returns it. If a format is not given, then the Verilog simulator will
+      # Reads the value using the given format (name or
+      # integer constant) and returns it.  If a format
+      # is not given, then the Verilog simulator will
       # attempt to determine the correct format.
       def get_value aFormat = VpiObjTypeVal
         val = get_value_wrapper(resolve_prop_type(aFormat))
@@ -112,7 +121,7 @@ module Vpi
             val.value.scalar
 
           when VpiIntVal
-            get_value_wrapper(VpiHexStrVal).value.str.to_i(16)
+            get_value_wrapper(VpiBinStrVal).value.str.gsub(/[^01]/, '0').to_i(2)
 
           when VpiRealVal
             val.value.real
@@ -131,10 +140,10 @@ module Vpi
         end
       end
 
-      # Writes the given value using the given format (name or integer
-      # constant), time, and delay, and then returns the given value. If a
-      # format is not given, then the Verilog simulator will attempt to
-      # determine the correct format.
+      # Writes the given value using the given format (name or
+      # integer constant), time, and delay, and then returns the
+      # given value.  If a format is not given, then the Verilog
+      # simulator will attempt to determine the correct format.
       def put_value aValue, aFormat = nil, aTime = nil, aDelay = VpiNoDelay
         aFormat =
           if aFormat
@@ -143,28 +152,27 @@ module Vpi
             get_value_wrapper(VpiObjTypeVal).format
           end
 
-        newVal = S_vpi_value.new
-        newVal.format = aFormat
+        newVal = S_vpi_value.new(:format => aFormat)
 
         case aFormat
           when VpiBinStrVal, VpiOctStrVal, VpiDecStrVal, VpiHexStrVal, VpiStringVal
-            newVal.value.str = aValue.to_s
+            newVal.value.str      = aValue.to_s
 
           when VpiScalarVal
-            newVal.value.scalar = aValue
+            newVal.value.scalar   = aValue
 
           when VpiIntVal
-            newVal.format = VpiHexStrVal
-            newVal.value.str = aValue.to_i.to_s(16)
+            newVal.format         = VpiHexStrVal
+            newVal.value.str      = aValue.to_i.to_s(16)
 
           when VpiRealVal
-            newVal.value.real = aValue.to_f
+            newVal.value.real     = aValue.to_f
 
           when VpiTimeVal
-            newVal.value.time = aValue
+            newVal.value.time     = aValue
 
           when VpiVectorVal
-            newVal.value.vector = aValue
+            newVal.value.vector   = aValue
 
           when VpiStrengthVal
             newVal.value.strength = aValue
@@ -173,7 +181,7 @@ module Vpi
             raise "unknown S_vpi_value.format: #{newVal.format}"
         end
 
-        vpi_put_value self, newVal, aTime, aDelay
+        vpi_put_value(self, newVal, aTime, aDelay)
 
         # ensure that value was written correctly
           readenVal = get_value(aFormat)
@@ -192,7 +200,7 @@ module Vpi
 
               when VpiIntVal
                 # allow for register overflow when limit reached
-                readenVal == (aValue.to_i % (2 ** self.vpiSize))
+                readenVal == (aValue.to_i % (2 ** vpi_get(VpiSize, self)))
 
               when VpiRealVal
                 readenVal == aValue.to_f
@@ -202,19 +210,19 @@ module Vpi
             end
 
           unless writtenCorrectly
-            raise "value written (#{aValue.inspect}) does not match value read (#{readenVal.inspect}) from handle #{self}"
+            raise "value written (#{aValue.inspect}) does not match value read (#{readenVal.inspect}) on handle #{self}"
           end
 
         aValue
       end
 
-      # Returns an array of child handles of the given types (name or integer
-      # constant).
+      # Returns an array of child handles of the
+      # given types (name or integer constant).
       def [] *aTypes
         handles = []
 
-        aTypes.each do |t|
-          t = resolve_prop_type(t)
+        aTypes.each do |arg|
+          t = resolve_prop_type(arg)
 
           if itr = vpi_iterate(t, self)
             while h = vpi_scan(itr)
@@ -226,8 +234,31 @@ module Vpi
         handles
       end
 
-      # Inspects the given VPI property names, in addition to those common to
-      # all handles.
+
+        # inherit Enumerable methods, such as #each, #map, #select, etc.
+        Enumerable.instance_methods.push('each').each do |meth|
+          # using a string because define_method
+          # does not accept a block until Ruby 1.9
+          class_eval %{
+            def #{meth}(*args, &block)
+              if ary = self[*args]
+                ary.#{meth}(&block)
+              end
+            end
+          }, __FILE__, __LINE__
+        end
+
+        # bypass Enumerable's #to_a method, which relies on #each
+        alias to_a []
+
+        # Sort by absolute VPI path.
+        def <=> other
+          self.fullName <=> other.fullName
+        end
+
+
+      # Inspects the given VPI property names, in
+      # addition to those common to all handles.
       def inspect *aPropNames
         aPropNames.unshift :fullName, :size, :file, :lineNo
 
@@ -240,8 +271,8 @@ module Vpi
 
       alias to_s inspect
 
-      # Registers a callback that is invoked whenever the value of this object
-      # changes.
+      # Registers a callback that is invoked
+      # whenever the value of this object changes.
       def cbValueChange aOptions = {}, &aHandler
         raise ArgumentError unless block_given?
 
@@ -262,20 +293,21 @@ module Vpi
 
       @@propCache = Hash.new {|h, k| h[k] = Property.resolve(k)}
 
-      # Provides access to this handle's (1) child handles and (2) VPI
-      # properties through method calls. In the case that a child handle has the
-      # same name as a VPI property, the child handle will be accessed instead
-      # of the VPI property. However, you can still access the VPI property via
-      # #get_value and #put_value.
+      # Provides access to this handle's (1) child handles
+      # and (2) VPI properties through method calls.  In the
+      # case that a child handle has the same name as a VPI
+      # property, the child handle will be accessed instead
+      # of the VPI property.  However, you can still access
+      # the VPI property via #get_value and #put_value.
       def method_missing aMeth, *aArgs, &aBlockArg
         if child = vpi_handle_by_name(aMeth.to_s, self)
-          # cache the child for future accesses, in order to cut down number of
-          # calls to method_missing
-            (class << self; self; end).class_eval do
-              define_method aMeth do
-                child
-              end
+          # cache the child for future accesses, in order
+          # to cut down number of calls to method_missing
+          (class << self; self; end).class_eval do
+            define_method aMeth do
+              child
             end
+          end
 
           child
 
@@ -283,8 +315,7 @@ module Vpi
           prop = @@propCache[aMeth]
 
           if prop.operation
-            self.send(prop.operation, prop.type, *aArgs, &aBlockArg)
-
+            self.__send__(prop.operation, prop.type, *aArgs, &aBlockArg)
           else
             case prop.accessor
               when :d	# delay values
@@ -301,19 +332,40 @@ module Vpi
                 end
 
               when :i	# integer values
-                vpi_get(prop.type, self) unless prop.assignment
+                unless prop.assignment
+                  vpi_get(prop.type, self)
+                else
+                  raise NotImplementedError
+                end
 
               when :b # boolean values
                 unless prop.assignment
                   value = vpi_get(prop, self)
                   value && (value != 0)	# zero is false in C
+                else
+                  raise NotImplementedError
                 end
 
               when :s	# string values
-                vpi_get_str(prop.type, self) unless prop.assignment
+                unless prop.assignment
+                  vpi_get_str(prop.type, self)
+                else
+                  raise NotImplementedError
+                end
 
               when :h	# handle values
-                vpi_handle(prop.type, self) unless prop.assignment
+                unless prop.assignment
+                  vpi_handle(prop.type, self)
+                else
+                  raise NotImplementedError
+                end
+
+              when :a # array of child handles
+                unless prop.assignment
+                  self[prop.type]
+                else
+                  raise NotImplementedError
+                end
 
               else
                 raise NoMethodError, "unable to access VPI property #{prop.name.inspect} through method #{aMeth.inspect} with arguments #{aArgs.inspect} for handle #{self}"
@@ -322,10 +374,12 @@ module Vpi
         end
       end
 
-      Property = Struct.new :type, :name, :operation, :accessor, :assignment
+      private
+
+      Property = Struct.new(:type, :name, :operation, :accessor, :assignment)
 
-      # Resolves the given shorthand name into a description of its VPI
-      # property.
+      # Resolves the given shorthand name into
+      # a description of its VPI property.
       def Property.resolve aName # :nodoc:
         # parse the given property name
           tokens = aName.to_s.split(/_/)
@@ -335,7 +389,7 @@ module Vpi
 
           addendum = $&
           isAssign = $& == '='
-          isQuery = $& == '?'
+          isQuery  = $& == '?'
 
 
           tokens.last =~ /^[a-z]$/ && tokens.pop
@@ -389,11 +443,9 @@ module Vpi
             end
           end
 
-        Property.new type, name, operation, accessor, isAssign
+        Property.new(type, name, operation, accessor, isAssign)
       end
 
-      private
-
       # resolve type names into type constants
       def resolve_prop_type aNameOrType
         if aNameOrType.is_a? Integer
@@ -412,14 +464,14 @@ module Vpi
 
     alias vpi_register_cb_old vpi_register_cb
 
-    # This is a Ruby version of the vpi_register_cb C function. It is identical
-    # to the C function, except for the following differences:
+    # This is a Ruby version of the vpi_register_cb C function.  It is
+    # identical to the C function, except for the following differences:
     #
-    # * This method accepts a block (callback handler) which is executed
-    #   whenever the callback occurs.
+    # * This method accepts a block (callback handler)
+    #   which is executed whenever the callback occurs.
     #
-    # * This method overwrites the +cb_rtn+ and +user_data+ fields of the given
-    #   +S_cb_data+ object.
+    # * This method overwrites the +cb_rtn+ and +user_data+
+    #   fields of the given +S_cb_data+ object.
     #
     def vpi_register_cb aData, &aHandler # :yields: Vpi::S_cb_data
       raise ArgumentError, "block must be given" unless block_given?
@@ -428,10 +480,10 @@ module Vpi
 
       # register the callback with Verilog
         aData.user_data = key
-        aData.cb_rtn = Vlog_relay_ruby
-        token = vpi_register_cb_old(aData)
+        aData.cb_rtn    = Vlog_relay_ruby
+        token           = vpi_register_cb_old(aData)
 
-      @@callbacks[key] = Callback.new(aHandler, token)
+      @@callbacks[key]  = Callback.new(aHandler, token)
       token
     end
 
@@ -446,10 +498,10 @@ module Vpi
       end
     end
 
-    # Proxy for relay_verilog which supports callbacks.
-    # This method should NOT be invoked from callback handlers (see
-    # vpi_register_cb) and threads -- otherwise the situation will be like seven
-    # remote controls changing the channel on a single television set!
+    # Proxy for relay_verilog which supports callbacks.  This method
+    # should NOT be invoked from callback handlers (see vpi_register_cb)
+    # and threads -- otherwise the situation will be like seven remote
+    # controls changing the channel on a single television set!
     def relay_verilog_proxy # :nodoc:
       loop do
         relay_verilog
@@ -469,28 +521,23 @@ module Vpi
 
   # simulation control
 
-    # Simulates the design under test according to RubyVpi.init_bench.
-    def simulate
-      # this is a dummy method! it is overwritten by RubyVpi.init_bench
-    end
-
     # Advances the simulation by the given number of steps.
     def advance_time aNumSteps = 1
       # schedule wake-up callback from verilog
-        time = S_vpi_time.new
-        time.integer = aNumSteps
-        time.type = VpiSimTime
-
-        value = S_vpi_value.new
-        value.format = VpiSuppressVal
-
-        alarm = S_cb_data.new
-        alarm.reason = CbAfterDelay
-        alarm.cb_rtn = Vlog_relay_ruby
-        alarm.obj = nil
-        alarm.time = time
-        alarm.value = value
-        alarm.index = 0
+        time            = S_vpi_time.new
+        time.integer    = aNumSteps
+        time.type       = VpiSimTime
+
+        value           = S_vpi_value.new
+        value.format    = VpiSuppressVal
+
+        alarm           = S_cb_data.new
+        alarm.reason    = CbAfterDelay
+        alarm.cb_rtn    = Vlog_relay_ruby
+        alarm.obj       = nil
+        alarm.time      = time
+        alarm.value     = value
+        alarm.index     = 0
         alarm.user_data = nil
 
         vpi_free_object(vpi_register_cb_old(alarm))
@@ -504,24 +551,22 @@ module Vpi
 
     # Returns the current simulation time as an integer.
     def simulation_time
-      t = S_vpi_time.new
-      t.type = VpiSimTime
-
+      t = S_vpi_time.new :type => VpiSimTime
       vpi_get_time nil, t
       t.to_i
     end
 
     class S_vpi_time
-      # Returns the high and low portions of this time as a single 64-bit
-      # integer.
+      # Returns the high and low portions of
+      # this time as a single 64-bit integer.
       def integer
         (self.high << INTEGER_BITS) | self.low
       end
 
-      # Sets the high and low portions of this time from the given 64-bit
-      # integer.
+      # Sets the high and low portions of this
+      # time from the given 64-bit integer.
       def integer= aValue
-        self.low = aValue & INTEGER_MASK
+        self.low  = aValue & INTEGER_MASK
         self.high = (aValue >> INTEGER_BITS) & INTEGER_MASK
       end
 
@@ -543,19 +588,19 @@ module Vpi
       end
     end
 
-    # make VPI structs more accessible by allowing their members to be
-    # initialized through the constructor
-      constants.grep(/^S_/).each do |s|
-        const_get(s).class_eval do
-          alias old_initialize initialize
+    # make VPI structs more accessible by allowing their
+    # members to be initialized through the constructor
+    constants.grep(/^S_/).each do |s|
+      const_get(s).class_eval do
+        alias old_initialize initialize
 
-          def initialize aMembers = {}
-            old_initialize
+        def initialize aMembers = {} #:nodoc:
+          old_initialize
 
-            aMembers.each_pair do |k, v|
-              __send__ "#{k}=", v
-            end
+          aMembers.each_pair do |k, v|
+            __send__ "#{k}=", v
           end
         end
       end
+    end
 end