Home Explore Help
Sign In
rparedis
/
PythonDEVS-BBL
Watch 1
Star 0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 5814ed696c
Branches Tags
PythonDEVS-BBL
/
docs
/
_build
/
html
/
_modules
/
pypdevsbbl
/
tracers
/
ProfileTracer.html

ProfileTracer.html 19 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167 
  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    8. 

  8.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    9. 

  9.     <title>pypdevsbbl.tracers.ProfileTracer &#8212; Python(P)DEVS-BBL  documentation</title>
    10. 

  10.     <link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
    11. 

  11.     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" type="text/css" href="../../../_static/custom.css" />
    13. 

  13.     <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
    14. 

  14.     <script type="text/javascript" src="../../../_static/jquery.js"></script>
    15. 

  15.     <script type="text/javascript" src="../../../_static/underscore.js"></script>
    16. 

  16.     <script type="text/javascript" src="../../../_static/doctools.js"></script>
    17. 

  17.     <script type="text/javascript" src="../../../_static/language_data.js"></script>
    18. 

  18.     <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    19. 

  19.     <link rel="index" title="Index" href="../../../genindex.html" />
    20. 

  20.     <link rel="search" title="Search" href="../../../search.html" /> 
    21. 

  21.   </head><body>
    22. 

  22.     <div class="related" role="navigation" aria-label="related navigation">
    23. 

  23.       <h3>Navigation</h3>
    24. 

  24.       <ul>
    25. 

  25.         <li class="right" style="margin-right: 10px">
    26. 

  26.           <a href="../../../genindex.html" title="General Index"
    27. 

  27.              accesskey="I">index</a></li>
    28. 

  28.         <li class="right" >
    29. 

  29.           <a href="../../../py-modindex.html" title="Python Module Index"
    30. 

  30.              >modules</a> |</li>
    31. 

  31.         <li class="nav-item nav-item-0"><a href="../../../index.html">Python(P)DEVS-BBL  documentation</a> &#187;</li>
    32. 

  32.           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
    33. 

  33.           <li class="nav-item nav-item-2"><a href="../tracers.html" accesskey="U">pypdevsbbl.tracers</a> &#187;</li> 
    34. 

  34.       </ul>
    35. 

  35.     </div>  
    36. 

  36. 

  37.     <div class="document">
    38. 

  38.       <div class="documentwrapper">
    39. 

  39.         <div class="bodywrapper">
    40. 

  40.           <div class="body" role="main">
    41. 

  41.             
    42. 

  42.   <h1>Source code for pypdevsbbl.tracers.ProfileTracer</h1><div class="highlight"><pre>
    43. 

  43. <span></span><span class="c1">#  Copyright 2020 Modelling, Simulation and Design Lab (MSDL) at</span>
    44. 

  44. <span class="c1">#  McGill University and the University of Antwerp (http://msdl.cs.mcgill.ca/)</span>
    45. 

  45. <span class="c1">#</span>
    46. 

  46. <span class="c1">#  Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
    47. 

  47. <span class="c1">#  you may not use this file except in compliance with the License.</span>
    48. 

  48. <span class="c1">#  You may obtain a copy of the License at</span>
    49. 

  49. <span class="c1">#</span>
    50. 

  50. <span class="c1">#     http://www.apache.org/licenses/LICENSE-2.0</span>
    51. 

  51. <span class="c1">#</span>
    52. 

  52. <span class="c1">#  Unless required by applicable law or agreed to in writing, software</span>
    53. 

  53. <span class="c1">#  distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
    54. 

  54. <span class="c1">#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
    55. 

  55. <span class="c1">#  See the License for the specific language governing permissions and</span>
    56. 

  56. <span class="c1">#  limitations under the License.</span>
    57. 

  57. 

  58. <span class="sd">&quot;&quot;&quot;Makes up a profile of a simulation run.</span>
    59. 

  59. 

  60. <span class="sd">This file contains the tracer that can analyze the performance and throughput of</span>
    61. 

  61. <span class="sd">the messages traveling through a model during simulation.</span>
    62. 

  62. <span class="sd">&quot;&quot;&quot;</span>
    63. 

  63. 

  64. <span class="kn">from</span> <span class="nn">pypdevsbbl.tracers</span> <span class="kn">import</span> <span class="n">BaseTracer</span>
    65. 

  65. 

  66. <div class="viewcode-block" id="ProfileTracer"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.ProfileTracer.html#pypdevsbbl.tracers.ProfileTracer.ProfileTracer">[docs]</a><span class="k">class</span> <span class="nc">ProfileTracer</span><span class="p">(</span><span class="n">BaseTracer</span><span class="p">):</span>
    67. 

  67.     <span class="sd">&quot;&quot;&quot;Traces all the coming and going of messages and transitions.</span>
    68. 

  68. 

  69. <span class="sd">    The output file is in CSV-format and contains two tables, separated with a</span>
    70. 

  70. <span class="sd">    newline. For all DEVS blocks that underwent transitions, a summary of the</span>
    71. 

  71. <span class="sd">    counts of the internal, external and confluent ones. For all connections, an</span>
    72. 

  72. <span class="sd">    overview will be presented of the amount of messages that passed over these</span>
    73. 

  73. <span class="sd">    connections. Finally, a total for all values will be given as well.</span>
    74. 

  74. 

  75. <span class="sd">    Args:</span>
    76. 

  76. <span class="sd">        uid:                A unique identifier for distributed simulation.</span>
    77. 

  77. <span class="sd">                            Will be set automatically.</span>
    78. 

  78. <span class="sd">        server:             The server that runs the distributed simulation.</span>
    79. 

  79. <span class="sd">                            Will be set automatically.</span>
    80. 

  80. <span class="sd">        filename (str):     The name of the file to write the results to. When</span>
    81. 

  81. <span class="sd">                            ``None``, the console output will be used instead.</span>
    82. 

  82. <span class="sd">    &quot;&quot;&quot;</span>
    83. 

  83.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uid</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
    84. 

  84.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">uid</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span>
    85. 

  85.         <span class="bp">self</span><span class="o">.</span><span class="n">connections</span> <span class="o">=</span> <span class="p">{}</span>
    86. 

  86.         <span class="bp">self</span><span class="o">.</span><span class="n">internal</span> <span class="o">=</span> <span class="p">{}</span>
    87. 

  87.         <span class="bp">self</span><span class="o">.</span><span class="n">external</span> <span class="o">=</span> <span class="p">{}</span>
    88. 

  88.         <span class="bp">self</span><span class="o">.</span><span class="n">confluent</span> <span class="o">=</span> <span class="p">{}</span>
    89. 

  89. 

  90. <div class="viewcode-block" id="ProfileTracer.stopTracer"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.ProfileTracer.html#pypdevsbbl.tracers.ProfileTracer.ProfileTracer.stopTracer">[docs]</a>    <span class="k">def</span> <span class="nf">stopTracer</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    91. 

  91.         <span class="n">full</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">internal</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> <span class="o">|</span> <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">external</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> <span class="o">|</span> <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">confluent</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
    92. 

  92.         <span class="bp">self</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="s2">&quot;Name,Internal,External,Confluent</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
    93. 

  93.         <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">full</span><span class="p">:</span>
    94. 

  94.             <span class="bp">self</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">internal</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">external</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">confluent</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;,&#39;</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>
    95. 

  95.         <span class="bp">self</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="s2">&quot;TOTAL&quot;</span><span class="p">,</span> <span class="nb">sum</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">internal</span><span class="o">.</span><span class="n">values</span><span class="p">()),</span> <span class="nb">sum</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">external</span><span class="o">.</span><span class="n">values</span><span class="p">()),</span>
    96. 

  96.                    <span class="nb">sum</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">confluent</span><span class="o">.</span><span class="n">values</span><span class="p">()),</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;,&#39;</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>
    97. 

  97.         <span class="bp">self</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">Outport,Inport,Count</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
    98. 

  98.         <span class="k">for</span> <span class="n">pair</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connections</span><span class="p">:</span>
    99. 

  99.             <span class="bp">self</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="o">*</span><span class="n">pair</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">connections</span><span class="p">[</span><span class="n">pair</span><span class="p">],</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;,&#39;</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>
    100. 

  100.         <span class="bp">self</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="s2">&quot;TOTAL&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="nb">sum</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connections</span><span class="o">.</span><span class="n">values</span><span class="p">()),</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;,&#39;</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>
    101. 

  101.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">stopTracer</span><span class="p">()</span></div>
    102. 

  102. 

  103. <div class="viewcode-block" id="ProfileTracer.traceInternal"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.ProfileTracer.html#pypdevsbbl.tracers.ProfileTracer.ProfileTracer.traceInternal">[docs]</a>    <span class="k">def</span> <span class="nf">traceInternal</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aDEVS</span><span class="p">):</span>
    104. 

  104.         <span class="n">name</span> <span class="o">=</span> <span class="n">aDEVS</span><span class="o">.</span><span class="n">getModelFullName</span><span class="p">()</span>
    105. 

  105.         <span class="bp">self</span><span class="o">.</span><span class="n">internal</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
    106. 

  106.         <span class="bp">self</span><span class="o">.</span><span class="n">internal</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">+=</span> <span class="mi">1</span>
    107. 

  107. 

  108.         <span class="n">output</span> <span class="o">=</span> <span class="n">aDEVS</span><span class="o">.</span><span class="n">my_output</span>
    109. 

  109.         <span class="k">for</span> <span class="n">port</span> <span class="ow">in</span> <span class="n">output</span><span class="p">:</span>
    110. 

  110.             <span class="k">for</span> <span class="n">oport</span> <span class="ow">in</span> <span class="n">port</span><span class="o">.</span><span class="n">outline</span><span class="p">:</span>
    111. 

  111.                 <span class="k">if</span> <span class="n">oport</span><span class="o">.</span><span class="n">type</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;INPORT&#39;</span><span class="p">:</span>
    112. 

  112.                     <span class="n">name</span> <span class="o">=</span> <span class="p">(</span><span class="n">port</span><span class="o">.</span><span class="n">getPortFullName</span><span class="p">(),</span> <span class="n">oport</span><span class="o">.</span><span class="n">getPortFullName</span><span class="p">())</span>
    113. 

  113.                     <span class="bp">self</span><span class="o">.</span><span class="n">connections</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
    114. 

  114.                     <span class="bp">self</span><span class="o">.</span><span class="n">connections</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">+=</span> <span class="mi">1</span></div>
    115. 

  115. 

  116. <div class="viewcode-block" id="ProfileTracer.traceExternal"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.ProfileTracer.html#pypdevsbbl.tracers.ProfileTracer.ProfileTracer.traceExternal">[docs]</a>    <span class="k">def</span> <span class="nf">traceExternal</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aDEVS</span><span class="p">):</span>
    117. 

  117.         <span class="n">name</span> <span class="o">=</span> <span class="n">aDEVS</span><span class="o">.</span><span class="n">getModelFullName</span><span class="p">()</span>
    118. 

  118.         <span class="bp">self</span><span class="o">.</span><span class="n">external</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
    119. 

  119.         <span class="bp">self</span><span class="o">.</span><span class="n">external</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">+=</span> <span class="mi">1</span></div>
    120. 

  120. 

  121. <div class="viewcode-block" id="ProfileTracer.traceConfluent"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.ProfileTracer.html#pypdevsbbl.tracers.ProfileTracer.ProfileTracer.traceConfluent">[docs]</a>    <span class="k">def</span> <span class="nf">traceConfluent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aDEVS</span><span class="p">):</span>
    122. 

  122.         <span class="n">name</span> <span class="o">=</span> <span class="n">aDEVS</span><span class="o">.</span><span class="n">getModelFullName</span><span class="p">()</span>
    123. 

  123.         <span class="bp">self</span><span class="o">.</span><span class="n">confluent</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
    124. 

  124.         <span class="bp">self</span><span class="o">.</span><span class="n">confluent</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">+=</span> <span class="mi">1</span></div></div>
    125. 

  125. </pre></div>
    126. 

  126. 

  127.           </div>
    128. 

  128.         </div>
    129. 

  129.       </div>
    130. 

  130.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    131. 

  131.         <div class="sphinxsidebarwrapper">
    132. 

  132. <div id="searchbox" style="display: none" role="search">
    133. 

  133.   <h3>Quick search</h3>
    134. 

  134.     <div class="searchformwrapper">
    135. 

  135.     <form class="search" action="../../../search.html" method="get">
    136. 

  136.       <input type="text" name="q" />
    137. 

  137.       <input type="submit" value="Go" />
    138. 

  138.       <input type="hidden" name="check_keywords" value="yes" />
    139. 

  139.       <input type="hidden" name="area" value="default" />
    140. 

  140.     </form>
    141. 

  141.     </div>
    142. 

  142. </div>
    143. 

  143. <script type="text/javascript">$('#searchbox').show(0);</script>
    144. 

  144.         </div>
    145. 

  145.       </div>
    146. 

  146.       <div class="clearer"></div>
    147. 

  147.     </div>
    148. 

  148.     <div class="related" role="navigation" aria-label="related navigation">
    149. 

  149.       <h3>Navigation</h3>
    150. 

  150.       <ul>
    151. 

  151.         <li class="right" style="margin-right: 10px">
    152. 

  152.           <a href="../../../genindex.html" title="General Index"
    153. 

  153.              >index</a></li>
    154. 

  154.         <li class="right" >
    155. 

  155.           <a href="../../../py-modindex.html" title="Python Module Index"
    156. 

  156.              >modules</a> |</li>
    157. 

  157.         <li class="nav-item nav-item-0"><a href="../../../index.html">Python(P)DEVS-BBL  documentation</a> &#187;</li>
    158. 

  158.           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
    159. 

  159.           <li class="nav-item nav-item-2"><a href="../tracers.html" >pypdevsbbl.tracers</a> &#187;</li> 
    160. 

  160.       </ul>
    161. 

  161.     </div>
    162. 

  162.     <div class="footer" role="contentinfo">
    163. 

  163.         &#169; Copyright 2020, Randy Paredis.
    164. 

  164.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
    165. 

  165.     </div>
    166. 

  166.   </body>
    167. 

  167. </html>
    168.