topologygenerator 0.0.1

data/lib/builders_examples/pdm_builders/PhaseIWithPriorityQueues/Router_concrete_builder.rb

@@ -0,0 +1,449 @@
+module RouterConcreteBuilder
+    def build_output_representation
+        template = 
+        "   Coupled
+              {
+              Type = Coordinator
+              Name = #{id}
+              Ports = #{@in_elements.size}; #{@out_elements.size}
+              Description = Coupled DEVS model
+              Graphic
+                  {
+                  Position = #{-13455 + 2000 * (my_number - 2)} ; #{-9510 + 1600 * (my_number - 2)}
+                  Dimension = 660; 1470
+                  Direction = Down
+                  Color = 15
+                  Icon = %datanetworks%switch.jpg
+                  Window = 5000; 5000; 5000; 5000
+                  }
+              Parameters
+                  {
+                  }
+              System
+                  {
+        "
+
+        @in_elements.each_with_index do |in_elem, index|
+          template += buildInPort index
+        end
+        
+        @out_elements.each_with_index do |out_elem, index|
+          template += buildOutPort index
+        end 
+
+        template += buildRouting @in_elements.size, @out_elements.size
+
+        scilab_router_definition = ''
+        scilab_router_definition += "\n"
+        scilab_router_definition += "#{id}.numberOfQueues = #{priority_weights.size} ;\n"
+        scilab_router_definition += "#{id}.queueCapacity = #{buffer}; \n"
+        @out_elements.each_with_index do |out_elem, index|
+            template += buildEgressPort index
+            scilab_router_definition += "#{id}.egressPort#{index}.PriorityQueue.WRRScheduler.weights = #{priority_weights}; \n"
+        end
+
+        template += buildLines @in_elements.size, @out_elements.size
+             
+        template += "       }
+              }
+        "
+
+        {'scilab'=>scilab_router_definition, 'pdm'=>template}
+    end
+    
+    def buildInPort (portNumber)
+"                    Inport
+                      {
+                      Name = Inport#{portNumber}
+                      CoupledPort = #{portNumber+1}
+                      Description = 
+                      Graphic
+                          {
+                          Position = #{-5000 + 1000* portNumber+1}  ; -6525
+                          Dimension = 600
+                          Direction = Right
+                          }
+                      }
+"      
+    end
+    
+  def buildOutPort (portNumber)
+"               Outport
+                     {
+                     Name = Outport#{portNumber+1}
+                     CoupledPort = #{portNumber+1}
+                     Description = 
+                     Graphic
+                        {
+                        Position = #{-5000 + 1000* portNumber} ; 2175
+                        Dimension = 600
+                        Direction = Right
+                        }
+                     }
+"
+  end
+  
+  def buildRouting (nInports, nOutports)
+"               Atomic
+                      {
+                      Name = Routing
+                      Ports = #{nInports} ; #{nOutports}
+                      Path = PhaseI/Router.h
+                      Description = InN: Incomming packets\\nInN: Outgoing packets \\n This model routes incoming packets to outports. The decision is based on the global table GlobalFlowBasedRoutingTable(flowId, routerName). If there are more than one possible outport, the model uses a routingPolicy (currently hardcoded to Round-Robin) to decide.
+                      Graphic
+                          {
+                          Position = -3600 ; -4155
+                          Dimension = 615 ; 1785
+                          Direction = Down
+                          Color = 15
+                          Icon = %datanetworks%router.jpg
+                          }
+                      Parameters
+                          {
+                          }
+                      }
+"
+  end
+    
+  def buildEgressPort (portNumber)
+"               Coupled
+                     {
+                     Type = Coordinator
+                     Name = egressPort#{portNumber}
+                     Ports = 1; 1
+                     Description = Coupled DEVS model
+                     Graphic
+                         {
+                         Position = #{-4710 + 1200 * portNumber}; -1860
+                         Dimension = 1170; 870
+                         Direction = Down
+                         Color = 15
+                         Icon = %datanetworks%priorityegressport.jpg
+                         Window = 5000; 5000; 5000; 5000
+                         }
+                     Parameters
+                         {
+                         }
+                     System
+                         {
+                         Inport
+                             {
+                             Name = Inport0
+                             CoupledPort = 1
+                             Description = 
+                             Graphic
+                                 {
+                                 Position = -4695 ; -3525
+                                 Dimension = 390
+                                 Direction = Right
+                                 }
+                             }
+                         Outport
+                             {
+                             Name = Outport0
+                             CoupledPort = 1
+                             Description = 
+                             Graphic
+                                 {
+                                 Position = -1785 ; 600
+                                 Dimension = 435
+                                 Direction = Right
+                                 }
+                             }
+                         Atomic
+                             {
+                             Name = Link
+                             Ports = 1 ; 1
+                             Path = PhaseI/Link.h
+                             Description = Vector to scalar signal
+                             Graphic
+                                 {
+                                 Position = -3990 ; -915
+                                 Dimension = 630 ; 630
+                                 Direction = Down
+                                 Color = 15
+                                 Icon = %vectors%vec2scalar.svg
+                                 }
+                             Parameters
+                                 {
+                                 link.capacity = Str; #{id}.egressPort#{portNumber}.link.capacity ; Signal Index
+                                 link.delay = Str; #{id}.egressPort#{portNumber}.link.delay ; 
+                                 }
+                             }
+                         Coupled
+                             {
+                             Type = Coordinator
+                             Name = PriorityQueue
+                             Ports = 2; 1
+                             Description = Coupled DEVS model
+                             Graphic
+                                 {
+                                 Position = -4080; -2895
+                                 Dimension = 810; 990
+                                 Direction = Down
+                                 Color = 15
+                                 Icon = %datanetworks%priorityqueue.jpg
+                                 Window = 5000; 5000; 5000; 5000
+                                 }
+                             Parameters
+                                 {
+                                 }
+                             System
+                                 {
+                                 Inport
+                                     {
+                                     Name = inPackets
+                                     CoupledPort = 1
+                                     Description = 
+                                     Graphic
+                                         {
+                                         Position = -10710 ; -2625
+                                         Dimension = 570
+                                         Direction = Right
+                                         }
+                                     }
+                                 Outport
+                                     {
+                                     Name = outPackets
+                                     CoupledPort = 1
+                                     Description = 
+                                     Graphic
+                                         {
+                                         Position = -3990 ; -3750
+                                         Dimension = 630
+                                         Direction = Right
+                                         }
+                                     }
+                                 Inport
+                                     {
+                                     Name = inDequeReq
+                                     CoupledPort = 2
+                                     Description = 
+                                     Graphic
+                                         {
+                                         Position = -5880 ; -525
+                                         Dimension = 525
+                                         Direction = Right
+                                         }
+                                     }
+                                 Atomic
+                                     {
+                                     Name = prioritySelect
+                                     Ports = 1 ; 1
+                                     Path = PhaseI/PacketPrioritySelect.h
+                                     Description = Receives packets, and based on their flowId it selects which output port to send it through
+                                     Graphic
+                                         {
+                                         Position = -8805 ; -2985
+                                         Dimension = 675 ; 720
+                                         Direction = Right
+                                         Color = 15
+                                         Icon = None
+                                         }
+                                     Parameters
+                                         {
+                                         }
+                                     }
+                                 Atomic
+                                     {
+                                     Name = VQueues
+                                     Ports = 2 ; 2
+                                     Path = PhaseI/Vector_NetworkQueueWithSizeOutput.h
+                                     Description = In0 Incomming packets to queue\\nIn1 Incoming signal to request dequeue\\nOut0 Outgoing dequeued packets\\nOut1 Outgoing queue lenght information\\n\\nQueues incoming packets and enqueues them as required by a\\nexternal entity. FIFO Policy (FirstInFirstOut). Provides information\\nits internal state.
+                                     Graphic
+                                         {
+                                         Position = -7200 ; -2805
+                                         Dimension = 600 ; 675
+                                         Direction = Right
+                                         Color = 15
+                                         Icon = %datanetworks%queue_vec.png
+                                         }
+                                     Parameters
+                                         {
+                                         MaxCapacity = Str; #{id}.queueCapacity ; Queue Capacity in Bytes. (Use -1 for INF capacity)
+                                         ForcedPeriod = Str; -1 ; Force minimum period to transition. Use -1 for INF
+                                         Instances = Str; #{id}.numberOfQueues ; 
+                                         }
+                                     }
+                                 Atomic
+                                     {
+                                     Name = WRRScheduler
+                                     Ports = 2 ; 1
+                                     Path = PhaseI/WRRScheduler.h
+                                     Description = Atomic DEVS model
+                                     Graphic
+                                         {
+                                         Position = -4530 ; -2505
+                                         Dimension = 675 ; 675
+                                         Direction = Right
+                                         Color = 15
+                                         Icon = None
+                                         }
+                                     Parameters
+                                         {
+                                         numberOfQueues = Str; #{id}.numberOfQueues ; 
+                                         weights = Str; #{id}.egressPort#{portNumber}.PriorityQueue.WRRScheduler.weights; vector<double> with the weights for each queue
+                                         }
+                                     }
+                                 Atomic
+                                     {
+                                     Name = Vect2Scal
+                                     Ports = 1 ; 1
+                                     Path = vector/Vector2Scalar.h
+                                     Description = Vector to scalar signal
+                                     Graphic
+                                         {
+                                         Position = -5505 ; -4080
+                                         Dimension = 675 ; 675
+                                         Direction = Right
+                                         Color = 15
+                                         Icon = %vectors%vec2scalar.svg
+                                         }
+                                     Parameters
+                                         {
+                                         Index = Str; -1 ; Signal Index
+                                         }
+                                     }
+                                 Line
+                                     {
+                                     Source = Cmp ;  1 ;  1 ; 0
+                                     Sink = Cmp ;  2 ;  1 ; -1
+                                     PointX = -8025 ; -8025 ; -7365
+                                     PointY = -2625 ; -2625 ; -2625
+                                     }
+                                 Line
+                                     {
+                                     Source = Prt ;  1 ;  1 ; 0
+                                     Sink = Cmp ;  1 ;  1 ; -1
+                                     PointX = -9975 ; -9975 ; -8940
+                                     PointY = -2625 ; -2625 ; -2625
+                                     }
+                                 Line
+                                     {
+                                     Source = Cmp ;  2 ;  2 ; 0
+                                     Sink = Cmp ;  3 ;  1 ; -1
+                                     PointX = -6450 ; -6450 ; -4665
+                                     PointY = -2325 ; -2325 ; -2325
+                                     }
+                                 Line
+                                     {
+                                     Source = Prt ;  3 ;  1 ; 0
+                                     Sink = Cmp ;  3 ;  2 ; -1
+                                     PointX = -5250 ; -5025 ; -5025 ; -4665
+                                     PointY = -525 ; -525 ; -2025 ; -2025
+                                     }
+                                 Line
+                                     {
+                                     Source = Cmp ;  3 ;  1 ; 0
+                                     Sink = Cmp ;  2 ;  2 ; -1
+                                     PointX = -3750 ; -3300 ; -3300 ; -7500 ; -7500 ; -7365
+                                     PointY = -2175 ; -2175 ; -1275 ; -1275 ; -2325 ; -2325
+                                     }
+                                 Line
+                                     {
+                                     Source = Cmp ;  4 ;  1 ; 0
+                                     Sink = Prt ;  2 ;  1 ; -1
+                                     PointX = -4725 ; -4725 ; -4140
+                                     PointY = -3750 ; -3750 ; -3750
+                                     }
+                                 Line
+                                     {
+                                     Source = Cmp ;  4 ;  1 ; -1
+                                     Sink = Cmp ;  2 ;  1 ; 0
+                                     PointX = -5640 ; -6075 ; -6075 ; -6450
+                                     PointY = -3750 ; -3750 ; -2625 ; -2625
+                                     }
+                                 }
+                             }
+                                 Point
+                                     {
+                                     ConectedLines = 1 ; 4 ; 5
+                                     ConectedExtrems = Org ; Org ; Org
+                                     Position = -3675 ; 150
+                                     }
+                                 Line
+                                     {
+                                     Source = Cmp ;  1 ;  1 ; 0
+                                     Sink = Pnt ;  1 ; -1 ; 0
+                                     PointX = -3675 ; -3675 ; -3675
+                                     PointY = -150 ; -150 ; 150
+                                     }
+                                 Line
+                                     {
+                                     Source = Prt ;  1 ;  1 ; 0
+                                     Sink = Cmp ;  2 ;  1 ; -1
+                                     PointX = -4200 ; -3900 ; -3900
+                                     PointY = -3525 ; -3525 ; -2940
+                                     }
+                                 Line
+                                     {
+                                     Source = Cmp ;  2 ;  1 ; 0
+                                     Sink = Cmp ;  1 ;  1 ; -1
+                                     PointX = -3675 ; -3675 ; -3675
+                                     PointY = -1875 ; -1875 ; -1065
+                                     }
+                                 Line
+                                     {
+                                     Source = Cmp ;  2 ;  2 ; -1
+                                     Sink = Pnt ;  1 ; -1 ; 0
+                                     PointX = -3450 ; -3450 ; -2775 ; -2775 ; -3675
+                                     PointY = -2940 ; -3300 ; -3300 ; 150 ; 150
+                                     }
+                                 Line
+                                     {
+                                     Source = Pnt ;  1 ; -1 ; 0
+                                     Sink = Prt ;  2 ;  1 ; -1
+                                     PointX = -3675 ; -3675 ; -1965
+                                     PointY = 150 ; 600 ; 600
+                                     }
+                         }
+                     }
+"
+  end
+  
+  def buildLines(in_elements_quantity, out_elements_quantity)
+    routing_position = 1 #Because is the first component after ports
+    first_egress_port_position = routing_position
+    first_output_port_position = in_elements_quantity # Because I have as many inputs_ports as in_elements
+
+    lines = ''
+    #from inports to Routing
+    (1..in_elements_quantity).each do |i|
+        lines += "Line
+            {
+            Source = Prt ;  #{i} ;  1 ; 0
+            Sink = Cmp ; #{routing_position}  ;  #{i} ; -1
+            PointX = -11325 ; -11325 ; -9840
+            PointY = -2625 ; -2625 ; -2625
+            }
+        "
+    end
+
+    # from Routing to egressPorts
+    (1..out_elements_quantity).each do |i|
+        lines += "Line
+            {
+            Source = Cmp ;  #{routing_position} ;  #{i} ; 0
+            Sink = Cmp ; #{first_egress_port_position + i}  ;  1 ; -1
+            PointX = -11325 ; -11325 ; -9840
+            PointY = -2625 ; -2625 ; -2625
+            }
+        "
+    end
+
+    # from egressPorts to outports
+    (1..out_elements_quantity).each do |i|
+        lines += "Line
+            {
+            Source = Cmp ;  #{first_egress_port_position + i} ;  1 ; 0
+            Sink = Prt ; #{first_output_port_position + i}  ;  1 ; -1
+            PointX = -11325 ; -11325 ; -9840
+            PointY = -2625 ; -2625 ; -2625
+            }
+        "
+    end    
+
+    lines
+  end
+      
+end

data/lib/builders_examples/pdm_builders/PhaseIWithPriorityQueues/output_concrete_builder.rb

@@ -0,0 +1,229 @@
+module OutputConcreteBuilder
+    NUMBER_OF_PDM_MODELS_IN_STRUCTURE = 3
+  
+    OUTPUT_PDM_FILE_NAME = 'topology.pdm'
+    OUTPUT_CPP_FILE_NAME = 'FlowDefinitions.cpp'
+    OUTPUT_FLOWS_SCILAB_FILE_NAME = 'flows_definition.scilabParams'
+    OUTPUT_ROUTERS_SCILAB_FILE_NAME = 'routers_definition.scilabParams'
+    OUTPUT_LINKS_SCILAB_FILE_NAME = 'links_definition.scilabParams'
+    OUTPUT_HOSTS_SCILAB_FILE_NAME = 'hosts_definition.scilabParams'
+    
+    def initialize_concrete_builder(topology_provider, directory_concrete_builders, output_directory)
+        @topology_provider = topology_provider
+        @directory_concrete_builders = directory_concrete_builders
+        @output_directory = output_directory
+    end
+
+    def build_output_content
+        build_host_link_router_output
+
+        build_flow_output
+    end
+
+    def build_host_link_router_output
+        graph_elements = topology_provider.get_topology
+        pdm_topology = pmd_initial_struture 
+        
+        router_scilab_params = ''
+        link_scilab_params = ''
+        host_scilab_params = ''
+
+        elements_which_are_not_flows = graph_elements.select{ |elem| [Host,Router,Link].include? elem.class }
+
+        elements_which_are_not_flows.each do |element|
+            output_representation = element.transform_to_output_representation @directory_concrete_builders
+            pdm_topology += output_representation['pdm']
+            router_scilab_params += output_representation['scilab'] if element.is_a? Router
+            link_scilab_params += output_representation['scilab'] if element.is_a? Link
+            host_scilab_params += output_representation['scilab'] if element.is_a? Host
+        end
+        
+        pdm_topology += create_lines_between_graph_elements graph_elements
+
+        pdm_topology += pdm_final_structure
+
+        write_file "#{@output_directory}/#{OUTPUT_PDM_FILE_NAME}",
+                    pdm_topology
+
+        write_file "#{@output_directory}/#{OUTPUT_ROUTERS_SCILAB_FILE_NAME}",
+                    router_scilab_params
+
+        write_file "#{@output_directory}/#{OUTPUT_LINKS_SCILAB_FILE_NAME}",
+                    link_scilab_params
+
+        write_file "#{@output_directory}/#{OUTPUT_HOSTS_SCILAB_FILE_NAME}",
+                    host_scilab_params
+    end
+
+    def create_lines_between_graph_elements(graph_elements)
+        links = graph_elements.select { |node| node.is_a? Link }
+        lines = ''
+        links.each do |link|
+            src_pdm_pos = get_pdm_position link.src_element, graph_elements
+            dst_pdm_pos = get_pdm_position link.dst_element, graph_elements
+            link_pdm_pos = get_pdm_position link, graph_elements
+            lines += link.create_pdm_line_between_src_and_dst src_pdm_pos, dst_pdm_pos, link_pdm_pos
+        end
+        lines
+    end
+
+    def get_pdm_position(network_elem, graph_elements)
+        #Here links DONT have a modeled representation, so we just have to count routers and hosts
+        return -1 if network_elem.is_a? Link
+        
+        network_elem_index = graph_elements.index { |elem| elem.id == network_elem.id }
+        my_pdm_position = 0
+        (0..network_elem_index).each do |i|
+            my_pdm_position += 1 unless graph_elements[i].is_a? Link
+        end
+        NUMBER_OF_PDM_MODELS_IN_STRUCTURE + my_pdm_position
+    end    
+
+    def build_flow_output
+        graph_elements = topology_provider.get_topology 
+
+        flows = graph_elements.select { |elem| elem.is_a? Flow }        
+
+        scilab_flows_definition = ''
+        cplusplus_flows_defined = ''
+        flows.each do |flow|
+            flow_output = flow.transform_to_output_representation @directory_concrete_builders
+            scilab_flows_definition += flow_output['scilab']
+            cplusplus_flows_defined += flow_output['cplusplus']
+        end
+
+        write_file "#{@output_directory}/#{OUTPUT_FLOWS_SCILAB_FILE_NAME}",
+                    scilab_flows_definition
+
+        write_file  "#{@output_directory}/#{OUTPUT_CPP_FILE_NAME}",
+                   (build_cplusplus_output cplusplus_flows_defined)
+    end
+
+    def build_cplusplus_output(cplusplus_flows_defined)
+        cplusplus_flows_definition = "#include \"FlowDefinitions.h\" \n"
+        cplusplus_flows_definition += "\n"
+        cplusplus_flows_definition += "std::multimap<std::string, std::shared_ptr<Flow>> FlowDefinitions::Flows; \n"
+        cplusplus_flows_definition += "\n"
+        cplusplus_flows_definition += "void FlowDefinitions::defineFlows(){ \n"
+        cplusplus_flows_definition += "\n"
+        cplusplus_flows_definition += cplusplus_flows_defined
+        cplusplus_flows_definition += '}'
+        cplusplus_flows_definition
+    end
+    
+    def pmd_initial_struture
+      "Coupled
+          {
+              Type = Root
+              Name = MyTopology
+              Ports = 0; 0
+              Description = Testing the creation of a topology by getting the info from the controller
+              Graphic
+                  {
+                      Position = 0; 0
+                      Dimension = 600; 600
+                      Direction = Right
+                      Color = 15
+                      Icon = 
+                      Window = 5000; 5000; 5000; 5000
+                  }
+              Parameters
+                  {
+                  }
+              System
+                  {
+                  Atomic
+                      {
+                      Name = LoadScilabParams
+                      Ports = 1 ; 0
+                      Path = sinks/RunScilabJob.h
+                      Description = If Scilab is configured as backed in the cmd line options, this model runs Scilab commands at Init, Exit and when receive events.
+                      Graphic
+                          {
+                          Position = -13845 ; -14220 
+                          Dimension = 540 ; 540
+                          Direction = Right
+                          Color = 15
+                          Icon = %sinks%scilab.ico
+                          }
+                      Parameters
+                          {
+                          Run at Init = Str; exec('#{File.absolute_path(@output_directory)}/Scilab/model.scilabParams', 0) ; Scilab Job at Init
+                          Run at External = Str;  ; Scilab Job when receive event
+                          Run at Exit = Str;  ; Scilab Job at Exit
+                          }
+                      }
+                  Atomic
+                      {
+                      Name = ExperimenetTracker
+                      Ports = 0 ; 0
+                      Path = sinks/SimulationExperimentTracker.h
+                      Description = Allows to use multiple simulation runs setting new parameter values in each run. It configures Scilab variables according to the current simunation number. This model should run with 1st priority!!
+                      Graphic
+                          {
+                          Position = -11220 ; -14220
+                          Dimension = 540 ; 540
+                          Direction = Right
+                          Color = 15
+                          Icon = %realtime%lcd.svg
+                          }
+                      Parameters
+                          {
+                          ScilabSimulationSetID = Str; SimulationName ; indicates the simulation set ID
+                          ScilabSimulationCounterVariableName = Str; ExperimentNumber ; Name of the Scilab variable that indicates the simulation number.
+                          ScilabParametersVariableName = Str; ParameterValues ; Name of the Scilab variable that contains the parameter values for each simulation
+                          ScilabParametersValuesVariableName = Str; ParameterNames ; Name of the Scilab variable that contains the parameter names for each simulation
+                          }
+                      }
+                  Atomic
+                      {
+                      Name = UpdateScilabParams
+                      Ports = 1 ; 0
+                      Path = sinks/RunScilabJob.h
+                      Description = If Scilab is configured as backed in the cmd line options, this model runs Scilab commands at Init, Exit and when receive events.
+                      Graphic
+                          {
+                          Position = -8670 ; -14220
+                          Dimension = 540 ; 540
+                          Direction = Right
+                          Color = 15
+                          Icon = %sinks%scilab.ico
+                          }
+                      Parameters
+                          {
+                          Run at Init = Str;  ; Scilab Job at Init
+                          Run at External = Str;  ; Scilab Job when receive event
+                          Run at Exit = Str;  ; Scilab Job at Exit
+                          }
+                      }
+              "
+    end  
+    
+    def pdm_final_structure
+      "Atomic
+                      {
+                      Name = FinalizationCommands
+                      Ports = 0 ; 0
+                      Path = sinks/multipleSimulationCommands.h
+                      Description = Executes Scilab commands when using multiple simulation runs (at the end of each simulation, and at the end of ALL simulations).\\nThis model should run with LAST priority
+                      Graphic
+                          {
+                          Position = -6270 ; -14220
+                          Dimension = 540 ; 540
+                          Direction = Right
+                          Color = 15
+                          Icon = %datanetworks%scilab.bmp
+                          }
+                      Parameters
+                          {
+                          initSimulationCommandName = Str; #{File.absolute_path(@output_directory)}/Scilab/firstSimulation.sce ; 
+                          eachSimulationCommandName = Str; #{File.absolute_path(@output_directory)}/Scilab/eachSimulation.sce ; 
+                          lastSimulationCommandName = Str; #{File.absolute_path(@output_directory)}/Scilab/lastSimulation.sce ; 
+                          }
+                      }
+                  }
+          }"
+    end
+      
+    
+end

data/lib/builders_examples/ruby_builders/Flow_concrete_builder.rb

@@ -0,0 +1,5 @@
+module FlowConcreteBuilder    
+    def build_output_representation
+        ""
+    end      
+end

data/lib/builders_examples/ruby_builders/Host_concrete_builder.rb

@@ -0,0 +1,5 @@
+module HostConcreteBuilder    
+    def build_output_representation
+        "hosts.push @topology.add_host \"#{id}\""
+    end      
+end