systemrdl 0.1.0

data/lib/systemrdl/evaluator/builtin_properties.rb

@@ -0,0 +1,400 @@
+# frozen_string_literal: true
+
+module SystemRDL
+  module Evaluator
+    module BuiltinProperties
+      class << self
+        attr_reader :properties
+
+        def find(name)
+          properties.find { |prop| prop.name == name }
+        end
+
+        private
+
+        def def_property(name, &)
+          @properties ||= []
+          @properties << PropertyDefinition.new(name, &)
+        end
+      end
+
+      #
+      # Table G1—Property cross-reference
+      #
+      def_property :accesswidth do |prop|
+        prop.targets = [:reg]
+        prop.types = [:longint]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = false
+      end
+
+      def_property :addressing do |prop|
+        prop.targets = [:addrmap]
+        prop.types = [:addressingtype]
+        prop.dynamic_assign = false
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = :regalign
+      end
+
+      def_property :alignment do |prop|
+        prop.targets = [:addrmap, :regfile]
+        prop.types = [:longint]
+        prop.dynamic_assign = false
+        prop.ref_target = false
+        prop.per_element_assign = false
+      end
+
+      def_property :anded do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean]
+        prop.dynamic_assign = true
+        prop.ref_target = true
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :bigendian do |prop|
+        prop.targets = [:addrmap]
+        prop.types = [:boolean]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :desc do |prop|
+        prop.types = [:string]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = true
+        prop.default_value = proc { '' }
+      end
+
+      def_property :errextbus do |prop|
+        prop.targets = [:addrmap, :regfile, :reg]
+        prop.types = [:boolean]
+        prop.dynamic_assign = false
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :fieldwidth do |prop|
+        prop.targets = [:field]
+        prop.types = [:longint]
+        prop.dynamic_assign = false
+        prop.per_element_assign = false
+        prop.ref_target = false
+      end
+
+      def_property :hw do |prop|
+        prop.targets = [:field]
+        prop.types = [:accesstype]
+        prop.dynamic_assign = false
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = :rw
+      end
+
+      def_property :hwclr do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean, :field_reference, :property_reference]
+        prop.dynamic_assign = true
+        prop.ref_target = proc { set? }
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :hwenable do |prop|
+        prop.targets = [:field]
+        prop.types = [:field_reference, :property_reference]
+        prop.dynamic_assign = true
+        prop.ref_target = proc { set? }
+        prop.per_element_assign = false
+      end
+
+      def_property :hwmask do |prop|
+        prop.targets = [:field]
+        prop.types = [:field_reference, :property_reference]
+        prop.dynamic_assign = true
+        prop.ref_target = proc { set? }
+        prop.per_element_assign = false
+      end
+
+      def_property :hwset do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean, :field_reference, :property_reference]
+        prop.dynamic_assign = true
+        prop.ref_target = proc { set? }
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :littleendian do |prop|
+        prop.targets = [:addrmap]
+        prop.types = [:boolean]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :lsb0 do |prop|
+        prop.targets = [:addrmap]
+        prop.types = [:boolean]
+        prop.dynamic_assign = false
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :msb0 do |prop|
+        prop.targets = [:addrmap]
+        prop.types = [:boolean]
+        prop.dynamic_assign = false
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :name do |prop|
+        prop.types = [:string]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = true
+        prop.default_value = proc { |inst| inst.name.to_s }
+      end
+
+      def_property :next do |prop|
+        prop.targets = [:field]
+        prop.types = [:field_reference, :property_reference]
+        prop.dynamic_assign = true
+        prop.per_element_assign = false
+        prop.ref_target = proc { set? }
+      end
+
+      def_property :onread do |prop|
+        prop.targets = [:field]
+        prop.types = [:onreadtype]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = false
+      end
+
+      def_property :onwrite do |prop|
+        prop.targets = [:field]
+        prop.types = [:onwritetype]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = false
+      end
+
+      def_property :ored do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean]
+        prop.dynamic_assign = true
+        prop.ref_target = true
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :paritycheck do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean]
+        prop.dynamic_assign = false
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :precedence do |prop|
+        prop.targets = [:field]
+        prop.types = [:precedencetype]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = :sw
+      end
+
+      def_property :rclr do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :regwidth do |prop|
+        prop.targets = [:reg]
+        prop.types = [:longint]
+        prop.dynamic_assign = false
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = 32
+      end
+
+      def_property :reset do |prop|
+        prop.targets = [:field]
+        prop.types = [:bit, :field_reference, :property_reference]
+        prop.dynamic_assign = true
+        prop.ref_target = proc { set? }
+        prop.per_element_assign = false
+      end
+
+      def_property :resetsignal do |prop|
+        prop.targets = [:field]
+        prop.types = [:field_reference, :property_reference]
+        prop.dynamic_assign = true
+        prop.ref_target = proc { set? }
+        prop.per_element_assign = false
+      end
+
+      def_property :rset do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :rsvdset do |prop|
+        prop.targets = [:addrmap]
+        prop.types = [:boolean]
+        prop.dynamic_assign = false
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :rsvdsetX do |prop|
+        prop.targets = [:addrmap]
+        prop.types = [:boolean]
+        prop.dynamic_assign = false
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :shared do |prop|
+        prop.targets = [:reg]
+        prop.types = [:boolean]
+        prop.dynamic_assign = false
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :sharedextbus do |prop|
+        prop.targets = [:addrmap, :regfile]
+        prop.types = [:boolean]
+        prop.dynamic_assign = false
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :singlepulse do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :sw do |prop|
+        prop.targets = [:field]
+        prop.types = [:accesstype]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = :rw
+      end
+
+      def_property :swacc do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean]
+        prop.dynamic_assign = true
+        prop.ref_target = true
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :swmod do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean]
+        prop.dynamic_assign = true
+        prop.ref_target = true
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :swwe do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean, :field_reference, :property_reference]
+        prop.dynamic_assign = true
+        prop.ref_target = proc { set? }
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :swwel do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean, :field_reference, :property_reference]
+        prop.dynamic_assign = true
+        prop.ref_target = proc { set? }
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :we do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean, :field_reference, :property_reference]
+        prop.dynamic_assign = true
+        prop.ref_target = proc { set? }
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :wel do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean, :field_reference, :property_reference]
+        prop.dynamic_assign = true
+        prop.ref_target = proc { set? }
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :woclr do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :woset do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean]
+        prop.dynamic_assign = true
+        prop.ref_target = false
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+
+      def_property :xored do |prop|
+        prop.targets = [:field]
+        prop.types = [:boolean]
+        prop.dynamic_assign = true
+        prop.ref_target = true
+        prop.per_element_assign = false
+        prop.default_value = false
+      end
+    end
+  end
+end

data/lib/systemrdl/evaluator/common.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SystemRDL
+  module Evaluator
+    module Common
+      include RaiseEvaluationError
+
+      def initialize(token_range)
+        @token_range = token_range
+      end
+
+      attr_reader :token_range
+      attr_reader :parent
+      attr_reader :component
+
+      def connect(parent, component)
+        @parent = parent
+        @component = component
+      end
+    end
+  end
+end

data/lib/systemrdl/evaluator/component_definition.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+module SystemRDL
+  module Evaluator
+    class ComponentDefinition
+      include Common
+
+      def initialize(id, elements, insts, token_range)
+        super(token_range)
+        @id = id || insts.insts[0].inst_id
+        @definitions = {}
+        @elements = elements
+        @insts = insts
+        @default_properties = {}
+      end
+
+      attr_reader :id
+      attr_reader :definitions
+
+      def connect(parent, component)
+        super
+        @component&.add_definition(self)
+        @elements.each { |element| element.connect(self, self) }
+        @insts&.connect(self, self)
+      end
+
+      def upper_layers(include_self: false)
+        return [] if layer == :root
+
+        layers = [*component.upper_layers, component]
+        layers << self if include_self
+        layers
+      end
+
+      def evaluate(instance, **optargs)
+        check_definable(instance)
+        @insts&.evaluate(instance, @parent, @id, **optargs)
+      end
+
+      def create_instances(parent_instance, inst_name, inst_values, token_range, **optargs)
+        eval_array(inst_values) do |array_info|
+          create_instance(
+            parent_instance, inst_name, inst_values,
+            array_info, token_range, **optargs
+          )
+        end
+      end
+
+      def validate(_instance)
+      end
+
+      def revalidate(_instance)
+      end
+
+      def finalize(_instance)
+      end
+
+      def assign_default_property(name, value, token_range)
+        if @default_properties.key?(name)
+          message = "#{name} already assigned in this scope"
+          raise_evaluation_error message, token_range
+        end
+
+        @default_properties[name] = value
+      end
+
+      def find_default_property(name)
+        upper_layers.reverse_each do |component|
+          if (prop = component.default_properties[name])
+            return prop
+          end
+        end
+
+        nil
+      end
+
+      private
+
+      def check_power_of_2(instance, name, min_value)
+        value = instance.property_value(name)
+        return unless value
+
+        return if power_of_2?(value.value, min_value)
+
+        message = "#{name} must be a power of 2: #{value}"
+        raise_evaluation_error message, value.token_range
+      end
+
+      def power_of_2?(value, min_value)
+        value >= min_value && value.nobits?(value - 1)
+      end
+
+      def check_property_exclusivity(instance, names)
+        properties =
+          names
+            .map { |name| instance.property_value(name) }
+            .select { |v| v&.value }
+        return if properties.size <= 1
+
+        labels = [names[..-2].join(', '), names[-1]].join(' and ')
+        message = "#{labels} properties are mutually exclusive"
+
+        raise_evaluation_error message, *properties.map(&:token_range)
+      end
+
+      def check_definable(instance)
+        return if instance.definable?(self)
+
+        message = "#{layer} definition not allowed in #{instance.layer}"
+        raise_evaluation_error message, token_range
+      end
+
+      def eval_array(_inst_values)
+        yield(nil, nil)
+      end
+
+      def create_instance(parent_instance, inst_name, inst_values, array_info, token_range, **optargs)
+        unless unique_instance?(parent_instance, inst_name, array_info)
+          message = "duplicated instance: #{inst_name}"
+          raise_evaluation_error message, token_range
+        end
+
+        instance = instance_class.new(self, parent_instance, inst_name, array_info, token_range)
+
+        init_properties(instance)
+        eval_body(instance, **optargs)
+        apply_inst_values(instance, inst_values)
+        post_build(instance)
+        instance.validate
+
+        parent_instance.instances << instance if parent_instance
+        instance
+      end
+
+      def unique_instance?(parent_instance, inst_name, array_info)
+        return true unless parent_instance
+
+        parent_instance.instances.none? do |inst|
+          if inst.name != inst_name
+            false
+          elsif inst.array? && array_info
+            inst.array_info.id != array_info.id
+          else
+            true
+          end
+        end
+      end
+
+      def init_properties(instance)
+        prop_defs = BuiltinProperties.properties
+        prop_defs.each do |prop_def|
+          next unless prop_def.target?(instance)
+
+          prop = prop_def.create(instance)
+          instance.properties << prop
+        end
+      end
+
+      def eval_body(instance, **optargs)
+        @default_properties.clear
+        @elements.each { |element| element.evaluate(instance, **optargs) }
+      end
+
+      def apply_inst_values(_instance, _inst_values)
+      end
+
+      def post_build(_instance)
+      end
+
+      protected
+
+      def add_definition(definition)
+        id = definition.id.value
+        if @definitions.key?(id)
+          message = "duplicated component: #{id}"
+          raise_evaluation_error message, definition.token_range
+        end
+
+        @definitions[id] = definition
+      end
+
+      attr_reader :default_properties
+    end
+  end
+end

data/lib/systemrdl/evaluator/component_insts.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module SystemRDL
+  module Evaluator
+    class ComponentInsts
+      include Common
+
+      def initialize(insts, token_range)
+        super(token_range)
+        @insts = insts
+      end
+
+      attr_reader :insts
+
+      def connect(parent, component)
+        super
+        @insts.each { |inst| inst.connect(self, component) }
+      end
+
+      def evaluate(instance, base, id, **optargs)
+        component_definition = find_component_definition(base, id, **optargs)
+        check_recursive_instance(instance, component_definition)
+        check_instantiable(instance, component_definition)
+
+        @insts.each do |inst|
+          inst.evaluate(instance, component_definition, **optargs)
+        end
+      end
+
+      private
+
+      def find_component_definition(base, id, **optargs)
+        base.upper_layers(include_self: true).reverse_each do |component|
+          definition = component.definitions[id.value]
+          next unless definition
+
+          unless optargs[:test] || (definition.layer in :reg | :field)
+            message = "#{definition.layer} instance not supported yet"
+            raise_evaluation_error message, token_range
+          end
+
+          return definition
+        end
+
+        raise_evaluation_error "undefined component: #{id.value}", token_range
+      end
+
+      def check_recursive_instance(instance, component_definition)
+        components = instance.definition.upper_layers(include_self: true)
+        return if components.none? { |component| component.equal?(component_definition) }
+
+        message = 'recursive instance not allowed'
+        raise_evaluation_error message, token_range
+      end
+
+      def check_instantiable(instance, component_definition)
+        return if instance.instantiable?(component_definition)
+
+        message = "#{component_definition.layer} instance not allowed in #{instance.layer}"
+        raise_evaluation_error message, token_range
+      end
+    end
+
+    class ComponentInst
+      include Common
+
+      def initialize(inst_id, inst_values, token_range)
+        super(token_range)
+        @inst_id = inst_id
+        @inst_values = inst_values
+      end
+
+      attr_reader :inst_id
+
+      def evaluate(instance, component_definition, **optargs)
+        inst_values = eval_inst_values(instance, **optargs)
+        component_definition.create_instances(instance, @inst_id.value, inst_values, @token_range, **optargs)
+      end
+
+      private
+
+      def eval_inst_values(instance, **optargs)
+        @inst_values&.transform_values { |value| value&.evaluate(instance, **optargs) }
+      end
+    end
+
+    class ExplicitComponentInst
+      include Common
+
+      def initialize(id, insts, token_range)
+        super(token_range)
+        @id = id
+        @insts = insts
+      end
+
+      def connect(parent, component)
+        super
+        @insts.connect(self, component)
+      end
+
+      def evaluate(instance, **optargs)
+        @insts.evaluate(instance, @component, @id, **optargs)
+      end
+    end
+  end
+end