Merge pull request #71 from onera/19-wording-for-scenario-and-transaction

19 wording for scenario and transaction

Author: ccoquand

src/main/scala/onera/pmlanalyzer/pml/examples/mySys/MySysExport.scala

@@ -18,14 +18,12 @@
 package onera.pmlanalyzer.pml.examples.mySys
 
 import onera.pmlanalyzer.pml.exporters.*
-import onera.pmlanalyzer.pml.model.utils.Message
 import onera.pmlanalyzer.pml.operators.*
 import onera.pmlanalyzer.views.interference.examples.mySys.{
-  MySysInterferenceSpecification,
-  MyProcInterferenceSpecification
+  MyProcInterferenceSpecification,
+  MySysInterferenceSpecification
 }
 import onera.pmlanalyzer.views.interference.exporters.*
-import onera.pmlanalyzer.views.interference.operators.*
 
 /** Program entry point to export several version of Keystone
   */
@@ -76,7 +74,7 @@ object MySysExport extends App {
   MySys.exportDeactivatedComponents()
 
   // Export the transactions defined by the user
-  MySys.exportUserScenarios()
+  MySys.exportUserTransactions()
 
   MySys.exportSemanticsSize()
 

src/main/scala/onera/pmlanalyzer/pml/examples/mySys/MySysTransactionLibrary.scala

@@ -17,16 +17,14 @@
 
 package onera.pmlanalyzer.pml.examples.mySys
 
-import onera.pmlanalyzer.pml.model.configuration.TransactionLibrary
-import onera.pmlanalyzer.pml.operators.*
 import onera.pmlanalyzer.pml.model.configuration.*
+import onera.pmlanalyzer.pml.operators.*
 
 import scala.language.postfixOps
 
 /** This trait contains a library of all transactions that can occur on the
   * platform One way to define a
-  * [[onera.pmlanalyzer.pml.model.configuration.TransactionLibrary.Transaction]] or a
-  * [[onera.pmlanalyzer.pml.model.configuration.TransactionLibrary.Scenario]] is to use the
+  * [[onera.pmlanalyzer.pml.model.configuration.Transaction]] is to use the
   * read/write operators specifying which [[pml.model.software.Data]] is used by
   * which [[pml.model.software.Application]]. For instance
   * {{{val app4_wr_input_d : Transaction = Transaction(app4 write input_d)}}}
@@ -35,12 +33,12 @@ import scala.language.postfixOps
   * the data are provided in the [[MySysSoftwareAllocation]] trait.
   *
   * If you want to define several paths representing a multi-transaction use the
-  * [[onera.pmlanalyzer.pml.model.configuration.TransactionLibrary.Scenario]] For instance
-  * {{{val app1_rd_wr_L1 : Scenario = Scenario(app1_rd_L1, app1_wr_L1)}}}
-  * defines a scenario named '''app1_rd_wr_L1''' where app1 is reading and
+  * [[onera.pmlanalyzer.pml.model.configuration.Transaction]] For instance
+  * {{{val app1_rd_wr_L1 : Transaction = Transaction(app1_rd_L1, app1_wr_L1)}}}
+  * defines a transaction named '''app1_rd_wr_L1''' where app1 is reading and
   * writing L1 cache
   * @note
-  *   A transaction or a scenario is only '''declared''' here, it will be
+  *   A transaction or a transaction is only '''declared''' here, it will be
   *   considered during the interference analysis if it is actually used. This
   *   is done in the [[MySysTransactionLibrary]] files. A transaction
   *   should be a path from an initiator to a target, if several paths are
@@ -69,9 +67,9 @@ trait MySysTransactionLibrary extends TransactionLibrary {
   /** t13: [[MySysSoftwareAllocation.app1]] runs using [[MyProcPlatform.ARM0]]
     * cache
     *
-    * @group scenario_def
+    * @group transaction_def
     */
-  val t13: Scenario = Scenario(app1_rd_L1, app1_wr_L1)
+  val t13: Transaction = Transaction(app1_rd_L1, app1_wr_L1)
 
   /** t14: [[MySysSoftwareAllocation.app1]] it stores its output data in
     * [[MyProcPlatform.ddr]]
@@ -120,11 +118,11 @@ trait MySysTransactionLibrary extends TransactionLibrary {
   /** t31: When woke up, [[MySysSoftwareAllocation.app3]] reads the
     * [[MyProcPlatform.spi]] frame from [[MyProcPlatform.MemorySubsystem.sram]]
     * and transfers it to [[MyProcPlatform.spi]]
-    * @group scenario_def
+    * @group transaction_def
     */
   private val readFrame = Transaction(app3 read spi_frame)
   private val writeFrame = Transaction(app3 write output_spi_frame)
-  val t31: Scenario = Scenario(readFrame, writeFrame)
+  val t31: Transaction = Transaction(readFrame, writeFrame)
 
   /** t41: Each time an [[MyProcPlatform.eth]] frame arrives, it transfers the
     * payload of the frame to [[MyProcPlatform.MemorySubsystem.sram]]

src/main/scala/onera/pmlanalyzer/pml/examples/mySys/mySys.scala

@@ -22,7 +22,7 @@ package onera.pmlanalyzer.pml.examples
   *   [[MyProcPlatform]] for examples of [[pml.model.hardware.Hardware]]
   *   modelling features [[MySysSoftwareAllocation]] for examples of
   *   [[pml.model.software.Application]] modelling features
-  *   [[MySysTransactionLibrary]] for examples of transaction/scenario modelling
+  *   [[MySysTransactionLibrary]] for examples of transaction modelling
   *   features [[MySysLibraryConfiguration]] for example of transaction library
   *   configuration [[MySysExport]] for examples of platform instantiation and
   *   [[pml.exporters]] usage

src/main/scala/onera/pmlanalyzer/pml/examples/riscv/FU740/pml/FU740BenchmarkLibrary.scala

@@ -18,10 +18,6 @@
 package onera.pmlanalyzer.pml.examples.riscv.FU740.pml
 
 import onera.pmlanalyzer.pml.model.configuration.*
-import onera.pmlanalyzer.pml.model.configuration.TransactionLibrary.{
-  UserScenarioId,
-  UserTransactionId
-}
 import onera.pmlanalyzer.pml.operators.*
 
 import scala.language.postfixOps
@@ -33,37 +29,37 @@ trait FU740BenchmarkLibrary extends FU740TransactionLibrary {
   val Hart_0_Store_L1D: Transaction = Transaction(t0_1)
   val Hart_0_Load_L2: Transaction = Transaction(t0_2)
   val Hart_0_Store_L2: Transaction = Transaction(t0_3)
-  val Hart_0_Load_DDR_b0: Scenario = Scenario(t0_4)
-  val Hart_0_Store_DDR_b0: Scenario = Scenario(t0_5)
+  val Hart_0_Load_DDR_b0: Transaction = Transaction(t0_4)
+  val Hart_0_Store_DDR_b0: Transaction = Transaction(t0_5)
 
   val Hart_1_Load_L1D: Transaction = Transaction(t1_0)
   val Hart_1_Store_L1D: Transaction = Transaction(t1_1)
   val Hart_1_Load_LIM: Transaction = Transaction(t1_4)
   val Hart_1_Store_LIM: Transaction = Transaction(t1_5)
-  val Hart_1_Load_L2: Scenario = Scenario(t1_2)
-  val Hart_1_Store_L2: Scenario = Scenario(t1_3)
-  val Hart_1_Load_DDR_b0: Scenario = Scenario(t1_6)
-  val Hart_1_Store_DDR_b0: Scenario = Scenario(t1_7)
+  val Hart_1_Load_L2: Transaction = Transaction(t1_2)
+  val Hart_1_Store_L2: Transaction = Transaction(t1_3)
+  val Hart_1_Load_DDR_b0: Transaction = Transaction(t1_6)
+  val Hart_1_Store_DDR_b0: Transaction = Transaction(t1_7)
 
   val Hart_2_Load_L1D: Transaction = Transaction(t2_0)
   val Hart_2_Store_L1D: Transaction = Transaction(t2_1)
-  val Hart_2_Load_L2: Scenario = Scenario(t2_2)
-  val Hart_2_Store_L2: Scenario = Scenario(t2_3)
-  val Hart_2_Load_DDR_b0: Scenario = Scenario(t2_4)
-  val Hart_2_Store_DDR_b0: Scenario = Scenario(t2_5)
+  val Hart_2_Load_L2: Transaction = Transaction(t2_2)
+  val Hart_2_Store_L2: Transaction = Transaction(t2_3)
+  val Hart_2_Load_DDR_b0: Transaction = Transaction(t2_4)
+  val Hart_2_Store_DDR_b0: Transaction = Transaction(t2_5)
 
   val Hart_3_Load_L1D: Transaction = Transaction(t3_0)
   val Hart_3_Store_L1D: Transaction = Transaction(t3_1)
-  val Hart_3_Load_L2: Scenario = Scenario(t3_2)
-  val Hart_3_Store_L2: Scenario = Scenario(t3_3)
-  val Hart_3_Load_DDR_b0: Scenario = Scenario(t3_4)
-  val Hart_3_Store_DDR_b0: Scenario = Scenario(t3_5)
+  val Hart_3_Load_L2: Transaction = Transaction(t3_2)
+  val Hart_3_Store_L2: Transaction = Transaction(t3_3)
+  val Hart_3_Load_DDR_b0: Transaction = Transaction(t3_4)
+  val Hart_3_Store_DDR_b0: Transaction = Transaction(t3_5)
 
   val Hart_4_Load_L1D: Transaction = Transaction(t4_0)
   val Hart_4_Store_L1D: Transaction = Transaction(t4_1)
-  val Hart_4_Load_L2: Scenario = Scenario(t4_2)
-  val Hart_4_Store_L2: Scenario = Scenario(t4_3)
-  val Hart_4_Load_DDR_b0: Scenario = Scenario(t4_4)
-  val Hart_4_Store_DDR_b0: Scenario = Scenario(t4_5)
+  val Hart_4_Load_L2: Transaction = Transaction(t4_2)
+  val Hart_4_Store_L2: Transaction = Transaction(t4_3)
+  val Hart_4_Load_DDR_b0: Transaction = Transaction(t4_4)
+  val Hart_4_Store_DDR_b0: Transaction = Transaction(t4_5)
 
 }

src/main/scala/onera/pmlanalyzer/pml/examples/riscv/FU740/pml/FU740Export.scala

@@ -127,9 +127,6 @@ object FU740Export extends App {
     // Export the transactions defined by the user
     p.exportUserTransactions()
 
-    // Export the scenarios defined by the user
-    p.exportUserScenarios()
-
     // Export the service graph taking into account service interference
     p.exportRestrictedServiceGraphWithInterfere()
   }

src/main/scala/onera/pmlanalyzer/pml/examples/riscv/FU740/pml/FU740TransactionLibrary.scala

@@ -19,27 +19,19 @@ package onera.pmlanalyzer.pml.examples.riscv.FU740.pml
 
 import onera.pmlanalyzer.pml.examples.riscv.FU740.pml
 import onera.pmlanalyzer.pml.model.configuration.*
-import onera.pmlanalyzer.pml.model.configuration.TransactionLibrary.{
-  UserScenarioId,
-  UserTransactionId
-}
 import onera.pmlanalyzer.pml.model.hardware.Target
-import onera.pmlanalyzer.pml.model.software.Application
 import onera.pmlanalyzer.pml.operators.*
 import sourcecode.Name
 
 import scala.language.postfixOps
 
 /**
   * This trait contains a library of all transactions that can occur on the platform
-  * One way to define a [[pml.model.configuration.TransactionLibrary.Transaction]] or
-  * a [[pml.model.configuration.TransactionLibrary.Scenario]] is to use the read/write operators specifying
+  * One way to define a [[onera.pmlanalyzer.pml.model.configuration.Transaction]] is to use the read/write operators specifying
   * which [[pml.model.software.Data]] is used by which [[pml.model.software.Application]].
   * The location of the application and the data are provided in the [[FU740SoftwareAllocation]] trait.
   *
-  * If you want to define several paths representing a multi-transaction use the [[pml.model.configuration.TransactionLibrary.Scenario]]
-  *
-  * @note A transaction or a scenario is only '''declared''' here, it will be considered during the interference analysis if it is
+  * @note A transaction is only '''declared''' here, it will be considered during the interference analysis if it is
   *      actually used. This is done in the [[FU740LibraryConfiguration]] files.
   *      A transaction should be a path from an initiator to a target, if several paths are possible a warning will be raised.
   * @see [[pml.operators.Use.Ops]] for read/write operator definitions
@@ -48,7 +40,7 @@ trait FU740TransactionLibrary extends TransactionLibrary {
   self: FU740Platform with FU740SoftwareAllocation =>
 
   /*
-   * We model cached memory accesses using explicit scenarios, capturing the
+   * We model cached memory accesses using explicit transactions, capturing the
    * accesses to the updated caches. This could be:
    * - implicit, mapping the data in all updated targets.
    * - programmatic, based on the configuration of the cache hierarchy.
@@ -69,8 +61,8 @@ trait FU740TransactionLibrary extends TransactionLibrary {
   val t0_1: Transaction = Transaction(t0_wr_dtim)
   val t0_2: Transaction = Transaction(t0_rd_l2)
   val t0_3: Transaction = Transaction(t0_wr_l2)
-  val t0_4: Scenario = Scenario(t0_rd_mem, t0_l2_refill)
-  val t0_5: Scenario = Scenario(t0_wr_mem, t0_l2_refill)
+  val t0_4: Transaction = Transaction(t0_rd_mem, t0_l2_refill)
+  val t0_5: Transaction = Transaction(t0_wr_mem, t0_l2_refill)
 
   private val t1_rd_l1 = Transaction(app1 read d1.DL1Cache)
   private val t1_wr_l1 = Transaction(app1 write d1.DL1Cache)
@@ -85,10 +77,10 @@ trait FU740TransactionLibrary extends TransactionLibrary {
 
   val t1_0: Transaction = Transaction(t1_rd_l1)
   val t1_1: Transaction = Transaction(t1_wr_l1)
-  val t1_2: Scenario = Scenario(t1_rd_l2, t1_l1_refill)
-  val t1_3: Scenario = Scenario(t1_wr_l2, t1_l1_refill)
-  val t1_6: Scenario = Scenario(t1_rd_mem, t1_l2_refill, t1_l1_refill)
-  val t1_7: Scenario = Scenario(t1_wr_mem, t1_l2_refill, t1_l1_refill)
+  val t1_2: Transaction = Transaction(t1_rd_l2, t1_l1_refill)
+  val t1_3: Transaction = Transaction(t1_wr_l2, t1_l1_refill)
+  val t1_6: Transaction = Transaction(t1_rd_mem, t1_l2_refill, t1_l1_refill)
+  val t1_7: Transaction = Transaction(t1_wr_mem, t1_l2_refill, t1_l1_refill)
   val t1_4: Transaction = Transaction(t1_rd_lim)
   val t1_5: Transaction = Transaction(t1_wr_lim)
 
@@ -104,10 +96,10 @@ trait FU740TransactionLibrary extends TransactionLibrary {
 
   val t2_0: Transaction = Transaction(t2_rd_l1)
   val t2_1: Transaction = Transaction(t2_wr_l1)
-  val t2_2: Scenario = Scenario(t2_rd_l2, t2_l1_refill)
-  val t2_3: Scenario = Scenario(t2_wr_l2, t2_l1_refill)
-  val t2_4: Scenario = Scenario(t2_rd_mem, t2_l2_refill, t2_l1_refill)
-  val t2_5: Scenario = Scenario(t2_wr_mem, t2_l2_refill, t2_l1_refill)
+  val t2_2: Transaction = Transaction(t2_rd_l2, t2_l1_refill)
+  val t2_3: Transaction = Transaction(t2_wr_l2, t2_l1_refill)
+  val t2_4: Transaction = Transaction(t2_rd_mem, t2_l2_refill, t2_l1_refill)
+  val t2_5: Transaction = Transaction(t2_wr_mem, t2_l2_refill, t2_l1_refill)
   val t2_6: Transaction = Transaction(t2_rd_uart)
 
   private val t3_rd_l1 = Transaction(app3 read d3.DL1Cache)
@@ -121,10 +113,10 @@ trait FU740TransactionLibrary extends TransactionLibrary {
 
   val t3_0: Transaction = Transaction(t3_rd_l1)
   val t3_1: Transaction = Transaction(t3_wr_l1)
-  val t3_2: Scenario = Scenario(t3_rd_l2, t3_l1_refill)
-  val t3_3: Scenario = Scenario(t3_wr_l2, t3_l1_refill)
-  val t3_4: Scenario = Scenario(t3_rd_mem, t3_l2_refill, t3_l1_refill)
-  val t3_5: Scenario = Scenario(t3_wr_mem, t3_l2_refill, t3_l1_refill)
+  val t3_2: Transaction = Transaction(t3_rd_l2, t3_l1_refill)
+  val t3_3: Transaction = Transaction(t3_wr_l2, t3_l1_refill)
+  val t3_4: Transaction = Transaction(t3_rd_mem, t3_l2_refill, t3_l1_refill)
+  val t3_5: Transaction = Transaction(t3_wr_mem, t3_l2_refill, t3_l1_refill)
 
   private val t4_rd_l1 = Transaction(app4 read d4.DL1Cache)
   private val t4_wr_l1 = Transaction(app4 write d4.DL1Cache)
@@ -137,8 +129,8 @@ trait FU740TransactionLibrary extends TransactionLibrary {
 
   val t4_0: Transaction = Transaction(t4_rd_l1)
   val t4_1: Transaction = Transaction(t4_wr_l1)
-  val t4_2: Scenario = Scenario(t4_rd_l2, t4_l1_refill)
-  val t4_3: Scenario = Scenario(t4_wr_l2, t4_l1_refill)
-  val t4_4: Scenario = Scenario(t4_rd_mem, t4_l2_refill, t4_l1_refill)
-  val t4_5: Scenario = Scenario(t4_wr_mem, t4_l2_refill, t4_l1_refill)
+  val t4_2: Transaction = Transaction(t4_rd_l2, t4_l1_refill)
+  val t4_3: Transaction = Transaction(t4_wr_l2, t4_l1_refill)
+  val t4_4: Transaction = Transaction(t4_rd_mem, t4_l2_refill, t4_l1_refill)
+  val t4_5: Transaction = Transaction(t4_wr_mem, t4_l2_refill, t4_l1_refill)
 }

src/main/scala/onera/pmlanalyzer/pml/examples/riscv/FU740/pml/package.scala

@@ -22,7 +22,7 @@ package onera.pmlanalyzer.pml.examples.riscv.FU740
  *
   * @see [[FU740Platform]] for examples of [[pml.model.hardware.Hardware]] modelling features
   *      [[FU740SoftwareAllocation]] for examples of [[pml.model.software.Application]] modelling features
-  *      [[FU740TransactionLibrary]] for examples of transaction/scenario modelling features
+  *      [[FU740TransactionLibrary]] for examples of transaction modelling features
   *      [[FU740LibraryConfiguration]] for example of transaction library configuration
   *      [[FU740LibraryConfigurationFull]] for examples of specialisation of library configurations
   *      [[FU740Export]] for examples of platform instantiation and [[pml.exporters]] usage

src/main/scala/onera/pmlanalyzer/pml/examples/simpleKeystone/SimpleKeystoneTransactionLibrary.scala

@@ -25,8 +25,7 @@ import scala.language.postfixOps
 
 /** This trait contains a library of all transactions that can occur on the
   * platform One way to define a
-  * [[pml.model.configuration.TransactionLibrary.Transaction]] or a
-  * [[pml.model.configuration.TransactionLibrary.Scenario]] is to use the
+  * [[onera.pmlanalyzer.pml.model.configuration.Transaction]] is to use the
   * read/write operators specifying which [[pml.model.software.Data]] is used by
   * which [[pml.model.software.Application]]. For instance
   * {{{val app4_wr_input_d : Transaction = Transaction(app4 write input_d)}}}
@@ -35,12 +34,12 @@ import scala.language.postfixOps
   * the data are provided in the [[SimpleSoftwareAllocation]] trait.
   *
   * If you want to define several paths representing a multi-transaction use the
-  * [[pml.model.configuration.TransactionLibrary.Scenario]] For instance
-  * {{{val app1_rd_wr_L1 : Scenario = Scenario(app1_rd_L1, app1_wr_L1)}}}
-  * defines a scenario named '''app1_rd_wr_L1''' where app1 is reading and
+  * [[onera.pmlanalyzer.pml.model.configuration.Transaction]] For instance
+  * {{{val app1_rd_wr_L1 : Transaction = Transaction(app1_rd_L1, app1_wr_L1)}}}
+  * defines a transaction named '''app1_rd_wr_L1''' where app1 is reading and
   * writing L1 cache
   * @note
-  *   A transaction or a scenario is only '''declared''' here, it will be
+  *   A transaction is only '''declared''' here, it will be
   *   considered during the interference analysis if it is actually used. This
   *   is done in the [[SimpleKeystoneLibraryConfiguration]] files. A transaction
   *   should be a path from an initiator to a target, if several paths are
@@ -95,9 +94,9 @@ trait SimpleKeystoneTransactionLibrary extends TransactionLibrary {
 
   /** t14: [[SimpleSoftwareAllocation.app1]] runs using
     * [[SimpleKeystonePlatform.ARM0]] cache
-    * @group scenario_def
+    * @group transaction_def
     */
-  val t14_app1_rd_wr_L1: Scenario = Scenario(app1_rd_L1, app1_wr_L1)
+  val t14_app1_rd_wr_L1: Transaction = Transaction(app1_rd_L1, app1_wr_L1)
 
   /** t221: [[SimpleSoftwareAllocation.app22]] reads output data of
     * [[SimpleSoftwareAllocation.app1]] from [[SimpleKeystonePlatform.ddr]]
@@ -124,10 +123,10 @@ trait SimpleKeystoneTransactionLibrary extends TransactionLibrary {
     * [[SimpleKeystonePlatform.spi]] frame from
     * [[SimpleKeystonePlatform.MemorySubsystem.sram]] and transfers it to
     * [[SimpleKeystonePlatform.spi]]
-    * @group scenario_def
+    * @group transaction_def
     */
   private val readFrame = Transaction(app3 read output_d)
   private val writeFrame = Transaction(app3 write output_spi_frame)
-  val app3_transfer: Scenario =
-    Scenario(readFrame, writeFrame)
+  val app3_transfer: Transaction =
+    Transaction(readFrame, writeFrame)
 }

src/main/scala/onera/pmlanalyzer/pml/examples/simpleKeystone/package.scala

@@ -22,7 +22,7 @@ package onera.pmlanalyzer.pml.examples
   *   [[SimpleKeystonePlatform]] for examples of [[pml.model.hardware.Hardware]]
   *   modelling features [[SimpleSoftwareAllocation]] for examples of
   *   [[pml.model.software.Application]] modelling features
-  *   [[SimpleKeystoneTransactionLibrary]] for examples of transaction/scenario
+  *   [[SimpleKeystoneTransactionLibrary]] for examples of transaction
   *   modelling features [[SimpleKeystoneLibraryConfiguration]] for example of
   *   transaction library configuration
   *   [[SimpleKeystoneLibraryConfigurationFull]] for examples of specialisation

src/main/scala/onera/pmlanalyzer/pml/examples/simpleT1042/SimpleT1042TransactionLibrary.scala

@@ -38,7 +38,7 @@ trait SimpleT1042TransactionLibrary extends TransactionLibrary {
   val app1_wr_d2: Transaction = Transaction(app1 write d2)
   val app1_rd_L1: Transaction = Transaction(app1 read C1.L1)
   val app1_wr_L1: Transaction = Transaction(app1 write C1.L1)
-  val app1_rd_wr_L1: Scenario = Scenario(app1_rd_L1, app1_wr_L1)
+  val app1_rd_wr_L1: Transaction = Transaction(app1_rd_L1, app1_wr_L1)
   val app22_rd_d2: Transaction = Transaction(app22 read d2)
   val app22_wr_output_d: Transaction = Transaction(app22 write output_d)
   val app22_st_dma_reg: Transaction = Transaction(app22 write dma_reg)
@@ -50,6 +50,6 @@ trait SimpleT1042TransactionLibrary extends TransactionLibrary {
   private val app3_wr_output_pcie_frame: Transaction = Transaction(
     app3 write output_pcie_frame
   )
-  val app3_transfer: Scenario =
-    Scenario(app3_rd_output_d, app3_wr_output_pcie_frame)
+  val app3_transfer: Transaction =
+    Transaction(app3_rd_output_d, app3_wr_output_pcie_frame)
 }