topologygenerator 0.0.1

data/lib/builders_examples/pdm_builders/PhaseI/pdm_constants.rb

@@ -0,0 +1,111 @@
+PDM_INITIAL_STRUCTURE = "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('../examples/Matias/PhaseI/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
+                    }
+                }
+        "
+
+NUMBER_OF_PDM_MODELS_IN_STRUCTURE = 3
+
+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; ../examples/Matias/PhaseI/Scilab/firstSimulation.sce ; 
+                    eachSimulationCommandName = Str; ../examples/Matias/PhaseI/Scilab/eachSimulation.sce ; 
+                    lastSimulationCommandName = Str; ../examples/Matias/PhaseI/Scilab/lastSimulation.sce ; 
+                    }
+                }
+            }
+    }'

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

@@ -0,0 +1,82 @@
+module FlowConcreteBuilder
+    def build_output_representation
+        scilab_definition = build_scilab_definition
+        cplusplus_definition = build_cplusplus_definition
+        {'scilab'=>scilab_definition, 'cplusplus'=>cplusplus_definition}
+    end
+
+    def build_scilab_definition
+        scilab_flows_definition = ''
+        scilab_flows_definition += "\n"
+        scilab_flows_definition += build_parameter_flow_distribution 'periodDistribution', distribution_rate
+        scilab_flows_definition += build_parameter_flow_distribution 'packetSizeDistribution', distribution_size
+        scilab_flows_definition
+    end
+
+    def build_parameter_flow_distribution(distribution_name, distribution_variable)
+        scilab_flow_parameter_distribution = ''
+        case distribution_variable
+        when ConstantDistribution
+            scilab_flow_parameter_distribution = "flow#{@id}.#{distribution_name} =  DISTRIBUTION_CONSTANT;\n"            
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_value = #{distribution_variable.value};   //  value for the constant distribution\n"
+        when ExponentialDistribution
+            scilab_flow_parameter_distribution = "flow#{@id}.#{distribution_name} =  DISTRIBUTION_EXPONENTIAL;\n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_mu = #{distribution_variable.mu};   //  mean for the exponential distribution.\n"
+        when NormalDistribution
+            scilab_flow_parameter_distribution = "flow#{@id}.#{distribution_name} =  DISTRIBUTION_NORMAL;\n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_mu = #{distribution_variable.mu}; \n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_var = #{distribution_variable.var}; \n"
+        when ParetoDistribution
+            scilab_flow_parameter_distribution = "flow#{@id}.#{distribution_name} =  DISTRIBUTION_PARETO;\n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_val1 = #{distribution_variable.val_1}; \n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_val2 = #{distribution_variable.val_2}; \n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_mean = #{distribution_variable.mean}; \n"
+        when SplitDistribution
+            scilab_flow_parameter_distribution = "flow#{@id}.#{distribution_name} =  DISTRIBUTION_SPLIT;\n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_shape = #{distribution_variable.shape}; \n"
+            scilab_flow_parameter_distribution += "flow#{@id}.#{distribution_name}_scale = #{distribution_variable.scale}; \n"
+        else
+            raise "Distribution provided has a class which was unexpected. Class was: #{distribution_variable.class}"
+        end
+        scilab_flow_parameter_distribution
+    end
+
+    def build_cplusplus_definition
+        start_time_of_flow = 0
+        # flow
+        cplusplus_flows_definition = "\n"
+        cplusplus_flows_definition += "\t ///// definition of flow #{@id} \n"
+        cplusplus_flows_definition += "\t auto flow#{@id}PeriodDistribution = readDistributionParameter(\"flow#{@id}.periodDistribution\"); \n"
+        cplusplus_flows_definition += "\t auto flow#{@id}PacketSizeDistribution = readDistributionParameter(\"flow#{@id}.packetSizeDistribution\"); \n"
+        cplusplus_flows_definition += "\t auto flow#{@id} = std::make_shared<Flow>(\"#{@id}\", #{start_time_of_flow} /*startTime*/, #{priority} /*typeOfService*/, flow#{@id}PeriodDistribution, flow#{@id}PacketSizeDistribution); \n"
+               
+        #routes
+        cplusplus_flows_definition += "\t // routes for flow #{@id} \n"
+        paths.each_with_index do |path, index| #  add each route/path in the flow       
+          cplusplus_flows_definition += "\t auto flow#{@id}_route#{index} = std::make_shared<Route>( std::deque<Route::Node>{ \n"
+          path.links.each do |link|
+              cplusplus_flows_definition += "\t\t\t {#{link.src_port}, \"#{link.src_element.id}.Routing\"}, \n"
+          end
+          last_link = path.links.last        
+          cplusplus_flows_definition += "\t\t\t {#{last_link.dst_port}, \"#{last_link.dst_element.id}.Routing\"} \n"
+          cplusplus_flows_definition += "\t });"
+          cplusplus_flows_definition += "\t \n"
+        end 
+        
+        
+        # registrations
+        cplusplus_flows_definition += "\t // register flow #{@id} with its routes\n"
+        unique_sources = paths.map{ |path| path.links.first.src_element.id }.uniq{|id| id}  # only add unique sources
+        unique_sources.each do |source|
+          cplusplus_flows_definition += "\t FlowDefinitions::registerFlowSourceNode(flow#{@id}, \"#{source}.GeneratorApplication\");  \n"  
+        end
+        
+        paths.each_with_index do |path, index| #  register each route/path in the flow  for each route
+          cplusplus_flows_definition += "\t FlowDefinitions::registerFlowRoute(flow#{@id}, flow#{@id}_route#{index});  \n"
+        end
+                
+        cplusplus_flows_definition += "\t \n"
+        
+        cplusplus_flows_definition
+    end
+end

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

@@ -0,0 +1,335 @@
+module HostConcreteBuilder
+   def build_output_representation
+      raise "A host should be either a generator or a receiving application. This host has 0 in_elements and 0 out_elements" if @in_elements.size == 0 && @out_elements.size == 0 
+      
+      pdm_output = "        Coupled
+            {
+            Type = Coordinator
+            Name = #{id}
+            Ports = #{@in_elements.size}; #{@out_elements.size}
+            Description = Coupled DEVS model
+            Graphic
+                {
+                Position = #{-13995 + 1600 * (my_number - 4)} ; -12375
+                Dimension = 390; 1050
+                Direction = Down
+                Color = 15
+                Icon = %datanetworks%server.jpg
+                Window = 5000; 5000; 5000; 5000
+                }
+            Parameters
+                {
+                }
+            System
+                {#{componentsPdm}                                               
+                }
+            }
+      "
+      scilab_host_output = "\n"     
+      scilab_host_output += "#{id}.egressPort.queueCapacity = #{queue_capacity};"
+      {'scilab'=>scilab_host_output, 'pdm'=>pdm_output}
+    end
+    
+  def componentsPdm
+    components = ''
+    # 1st we need the in/out ports
+    components += portsPdm
+    
+    # 2nd we need the components
+    components += generatorApplication if @out_elements.size > 0
+    components += receivingApplication if @in_elements.size > 0
+    # 3rd the lines
+    components += linksPdm 
+    
+    components
+  end  
+  
+  def portsPdm
+    ports = ''
+    # inports    
+    (0..@in_elements.size-1).each do |i|
+      ports +="
+              Inport
+              {
+                Name = Inport#{i}
+                CoupledPort = #{i+1}
+                Description = 
+                Graphic
+                    {
+                    Position = -9330 ; #{-3250 + (i*1000)}
+                    Dimension = 510
+                    Direction = Right
+                    }
+              }"         
+    end
+    
+    # outports
+    (0..@out_elements.size-1).each do |i|
+      ports += "
+                Outport
+                {
+                Name = Outport#{i}
+                CoupledPort = #{i+1}
+                Description = 
+                Graphic
+                    {
+                    Position = #{-7000 + (2000 * i)} ; 3600
+                    Dimension = 555
+                    Direction = Right
+                    }
+                }"            
+    end
+    
+    ports
+  end
+    
+  def linksPdm
+    links_pdm = ''
+        
+    # from generator (component 1) to router (component 2)
+    if @out_elements.size > 0 # if there is a generator
+      links_pdm += "
+                              Line
+                                  {
+                                  Source = Cmp ;  1 ;  1 ; 0
+                                  Sink = Cmp ;  2 ;  1 ; -1
+                                  PointX = -6300 ; -6300 ; -6300
+                                  PointY = -1725 ; -1725 ; -1140
+                                  }"
+    end
+        
+    (1..@out_elements.size).each do |i|
+      # from router (component 2) to egressLink (components 3,4.. outElems+2)
+      links_pdm += "                     
+                              Line    
+                                  {
+                                  Source = Cmp ;  2 ;  #{i} ; 0
+                                  Sink = Cmp ;  #{i+2} ;  1 ; -1
+                                  PointX = -6300 ; -6300 ; -6300
+                                  PointY = -1725 ; -1725 ; -1140
+                                  }"        
+      # from egressLink (components 3,4.. outElems+2) to outports 
+      links_pdm += "
+                              Line
+                                  {
+                                  Source = Cmp ;  #{i+2}  ;  1 ; 0
+                                  Sink = Prt ;  #{i} ;  1 ; -1
+                                  PointX = #{-7200 + (2000 * (i-1))} ; #{-7200 + (2000 * (i-1))} ; #{-7200 + (2000 * (i-1))}
+                                  PointY = 900 ; 3525 ; 3525
+                                  }"
+    end
+    
+    # from inports to receiving app
+    (0..@in_elements.size-1).each do |i|    
+      links_pdm +="
+        Line
+        {
+          Source = Prt ;  #{(@out_elements.size + 1) + i} ;  1 ; 0
+          Sink = Cmp ;  #{(@out_elements.size * 3) + 1} ;  #{1 + i} ; -1
+          PointX = -8700 ; #{-8325 + (i * 300)} ; #{-8325 + (i * 300)}
+          PointY = #{-3250 + (i*1000)} ; #{-3250 + (i*1000)} ; -90
+        }"      
+    end      
+    
+    
+    links_pdm
+  end  
+    
+  def generatorApplication
+    pdm_generator_application = "
+    Atomic
+                        {
+                        Name = GeneratorApplication
+                        Ports = 0 ; 1
+                        Path = PhaseI/FelixServer.h
+                        Description = Generates jobs. Distribution for the rate and jobSize are retrieved from the Flows assigned to this server
+                        Graphic
+                            {
+                            Position = -7740 ; -4365
+                            Dimension = 630 ; 645
+                            Direction = Down
+                            Color = 15
+                            Icon = %datanetworks%generator.png
+                            }
+                        Parameters
+                            {
+                            }
+                        }
+    Atomic
+                        {
+                        Name = Routing
+                        Ports = 1 ; #{@out_elements.size}
+                        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 = -7740 ; -2115
+                            Dimension = 615 ; 1785
+                            Direction = Down
+                            Color = 15
+                            Icon = %datanetworks%router.jpg
+                            }
+                        Parameters
+                            {
+                            }
+                        }"
+    (0..@out_elements.size-1).each do |i|
+        pdm_generator_application += "                        
+                        Coupled
+                            {
+                            Type = Coordinator
+                            Name = egressPort#{i}
+                            Ports = 1; 1
+                            Description = Coupled DEVS model
+                            Graphic
+                                {
+                                Position = #{-7700 + (2000 * i)}; -120
+                                Dimension = 990; 840
+                                Direction = Down
+                                Color = 15
+                                Icon = %datanetworks%egressport.jpg
+                                Window = 5000; 5000; 5000; 5000
+                                }
+                            Parameters
+                                {
+                                }
+                            System
+                                {
+                                Inport
+                                    {
+                                    Name = Inport0
+                                    CoupledPort = 1
+                                    Description = 
+                                    Graphic
+                                        {
+                                        Position = -4725 ; -3525
+                                        Dimension = 450
+                                        Direction = Right
+                                        }
+                                    }
+                                Outport
+                                    {
+                                    Name = Outport0
+                                    CoupledPort = 1
+                                    Description = 
+                                    Graphic
+                                        {
+                                        Position = -930 ; 1575
+                                        Dimension = 525
+                                        Direction = Right
+                                        }
+                                    }
+                                Atomic
+                                    {
+                                    Name = portQueue
+                                    Ports = 2 ; 2
+                                    Path = PhaseI/NetworkQueue.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 = -3855 ; -2355
+                                        Dimension = 675 ; 675
+                                        Direction = Down
+                                        Color = 15
+                                        Icon = %datanetworks%queue.png
+                                        }
+                                    Parameters
+                                        {
+                                        MaxCapacity = Str; #{id}.egressPort.queueCapacity ; Queue Capacity in Bytes. (Use -1 for INF capacity)
+                                        ForcedPeriod = Str; -1 ; Force minimum period to transition. Use -1 for INF
+                                        }
+                                    }
+                                Atomic
+                                    {
+                                    Name = Link
+                                    Ports = 1 ; 1
+                                    Path = PhaseI/Link.h
+                                    Description = Vector to scalar signal
+                                    Graphic
+                                        {
+                                        Position = -3990 ; -540
+                                        Dimension = 630 ; 630
+                                        Direction = Down
+                                        Color = 15
+                                        Icon = %vectors%vec2scalar.svg
+                                        }
+                                    Parameters
+                                        {
+                                        link.capacity = Str; #{id}.egressPort#{i}.link.capacity ; Signal Index
+                                        link.delay = Str; #{id}.egressPort#{i}.link.delay ; 
+                                        }
+                                    }
+                                Point
+                                    {
+                                    ConectedLines = 3 ; 4 ; 5
+                                    ConectedExtrems = Org ; Org ; Org
+                                    Position = -3705 ; 765
+                                    }
+                                Line
+                                    {
+                                    Source = Prt ;  1 ;  1 ; 0
+                                    Sink = Cmp ;  1 ;  1 ; -1
+                                    PointX = -4125 ; -3675 ; -3675
+                                    PointY = -3525 ; -3525 ; -2490
+                                    }
+                                Line
+                                    {
+                                    Source = Cmp ;  1 ;  1 ; 0
+                                    Sink = Cmp ;  2 ;  1 ; -1
+                                    PointX = -3675 ; -3675 ; -3675
+                                    PointY = -1575 ; -1575 ; -690
+                                    }
+                                Line
+                                    {
+                                    Source = Cmp ;  2 ;  1 ; 0
+                                    Sink = Pnt ;  1 ; -1 ; 0
+                                    PointX = -3675 ; -3705 ; -3705
+                                    PointY = 225 ; 225 ; 765
+                                    }
+                                Line
+                                    {
+                                    Source = Cmp ;  1 ;  2 ; -1
+                                    Sink = Pnt ;  1 ; -1 ; 0
+                                    PointX = -3375 ; -3375 ; -2775 ; -2775 ; -3705
+                                    PointY = -2490 ; -2775 ; -2775 ; 765 ; 765
+                                    }
+                                Line
+                                    {
+                                    Source = Pnt ;  1 ; -1 ; 0
+                                    Sink = Prt ;  2 ;  1 ; -1
+                                    PointX = -3705 ; -3705 ; -1065
+                                    PointY = 765 ; 1575 ; 1575
+                                    }
+                                }
+                            }"   
+    end 
+    pdm_generator_application
+  end  
+    
+    
+  def receivingApplication
+      # atomic model for receiving application 
+      pdm_receiving_app = "                        
+      Atomic
+      {
+        Name = ReceivingApplication
+        Ports = #{@in_elements.size} ; 0
+        Path = PhaseI/Packetsink.h
+        Description = Generates jobs. Distribution for the rate and jobSize are retrieved from the Flows assigned to this server
+        Graphic
+            {
+            Position = -8490 ; 45
+            Dimension = 630 ; 675
+            Direction = Down
+            Color = 15
+            Icon = %datanetworks%generator.png
+            }
+        Parameters
+            {
+            }
+      }"      
+      
+      pdm_receiving_app
+    end
+      
+end

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

@@ -0,0 +1,25 @@
+module LinkConcreteBuilder
+    def build_output_representation
+      scilab_link_definition = ''
+      
+      #Think a better way to do this. This is the only thing that I could image to find out which link is this
+      egressPortnumber = src_element.out_elements.index dst_element
+      scilab_link_definition += "\n"
+      scilab_link_definition += "#{src_element.id}.egressPort#{egressPortnumber}.link.capacity = #{bandwith} ;\n"
+      scilab_link_definition += "#{src_element.id}.egressPort#{egressPortnumber}.link.delay = #{delay}; \n"
+    
+      {'scilab'=>scilab_link_definition, 'pdm'=>''}
+    end
+
+    def create_pdm_line_between_src_and_dst(src_element_pdm_pos, dst_element_pdm_pos, link_element_pdm_pos)
+    "Line
+                       {
+                       Source = Cmp ;  #{src_element_pdm_pos} ;   #{@src_port + 1} ; 0
+                       Sink = Cmp ;  #{dst_element_pdm_pos} ;  #{@dst_port + 1} ; -1
+                       PointX = -9675 ; -9675 ; -9675
+                       PointY = -10350 ; -10350 ; -9990
+                       }
+                       "
+  end
+
+end