global constraint projection

Author: Oron Port

compiler/ir/src/main/scala/dfhdl/compiler/ir/annotation.scala

@@ -60,9 +60,10 @@ end annotation
 object constraints:
   import annotation.HWAnnotation
   sealed abstract class Constraint extends HWAnnotation derives ReadWriter
+  sealed abstract class GlobalConstraint extends Constraint derives ReadWriter
   sealed abstract class SigConstraint extends Constraint derives ReadWriter:
     val bitIdx: ConfigN[Int]
-  final case class Device(name: String, properties: Map[String, String]) extends Constraint
+  final case class Device(name: String, properties: Map[String, String]) extends GlobalConstraint
       derives CanEqual, ReadWriter:
     protected def `prot_=~`(that: HWAnnotation)(using MemberGetSet): Boolean = this == that
     lazy val getRefs: List[DFRef.TwoWayAny] = Nil

core/src/main/scala/dfhdl/hw/annotation.scala

@@ -64,9 +64,11 @@ object constraints:
   sealed abstract class Constraint extends annotation.HWAnnotation:
     val isActive: Boolean = true
     val asIR: ir.constraints.Constraint
+  sealed abstract class GlobalConstraint extends Constraint:
+    val asIR: ir.constraints.GlobalConstraint
   sealed abstract class SigConstraint extends Constraint:
     val bitIdx: ir.ConfigN[Int]
-  final case class device(name: String, properties: (String, String)*) extends Constraint:
+  final case class device(name: String, properties: (String, String)*) extends GlobalConstraint:
     val asIR: ir.constraints.Device = ir.constraints.Device(name, properties.toMap)
 
   final case class io(

core/src/main/scala/dfhdl/platforms/resources/ResourceContext.scala

@@ -2,10 +2,17 @@ package dfhdl.platforms.resources
 import dfhdl.internals.*
 import dfhdl.core.*
 import scala.annotation.Annotation
+import dfhdl.compiler.ir.constraints.Constraint
+import scala.collection.mutable.ListBuffer
 
 trait ResourceContext extends OnCreateEvents, HasDFC, HasClsMetaArgs:
   final lazy val dfc: DFC = __dfc
   final lazy val id: String = dfc.nameOpt.get
+  private var resourceConstraints = ListBuffer[Constraint]()
+  def getResourceConstraints: List[Constraint] =
+    resourceConstraints.toList ++ dfc.annotations.collect {
+      case constraint: Constraint => constraint
+    }
   protected def __dfc: DFC =
     println("Severe error: missing DFHDL context!\nMake sure you enable the DFHDL compiler plugin.")
     sys.exit(1)
@@ -14,5 +21,10 @@ trait ResourceContext extends OnCreateEvents, HasDFC, HasClsMetaArgs:
       position: Position,
       docOpt: Option[String],
       annotations: List[Annotation]
-  ): Unit = {}
+  ): Unit =
+    annotations.foreach {
+      case constraint: dfhdl.hw.constraints.Constraint =>
+        resourceConstraints += constraint.asIR
+      case _ =>
+    }
 end ResourceContext

core/src/main/scala/dfhdl/platforms/resources/ResourceOwner.scala

@@ -1,12 +1,32 @@
 package dfhdl.platforms.resources
 import scala.collection.mutable.ListBuffer
+import dfhdl.compiler.ir
+
 trait ResourceOwner extends ResourceContext:
   dfc.mutableDB.ResourceOwnershipContext.enter(this)
   private val resources = ListBuffer[Resource]()
   private val children = ListBuffer[ResourceOwner]()
   private[resources] def getResources: List[Resource] = resources.toList
   private[resources] def getChildren: List[ResourceOwner] = children.toList
   private[resources] def addResource(resource: Resource): Unit = resources += resource
+  // projecting global constraints to the current design (typically this would be
+  // the top-level design, but we don't limit this for now)
+  private def projectGlobalConstraints(): Unit =
+    val globalConstraints = getResourceConstraints.collect {
+      case constraint: ir.constraints.GlobalConstraint => constraint
+    }
+    if (globalConstraints.nonEmpty)
+      import dfc.getSet
+      val ownerDesign = dfc.owner.asIR.getThisOrOwnerDesign
+      val updatedDclMeta =
+        ownerDesign.dclMeta.copy(annotations = ownerDesign.dclMeta.annotations ++ globalConstraints)
+      val updatedOwnerDesign = ownerDesign.copy(dclMeta = updatedDclMeta)
+      dfc.mutableDB.replaceMember(ownerDesign, updatedOwnerDesign)
+    end if
+  end projectGlobalConstraints
+
   override def onCreateEnd(thisOwner: Option[This]): Unit =
     dfc.mutableDB.ResourceOwnershipContext.exit()
     dfc.mutableDB.ResourceOwnershipContext.ownerOpt.foreach(_.children += this)
+    projectGlobalConstraints()
+end ResourceOwner