Update documentation for refs/heads/feature/dynamorio-tracer.

Author: Nathan Gober Committer: GitHub Removed macos-specific setup step This step existed to support the macos-12 runner, which is [deprecated](actions/runner-images#10721 (comment)) and no longer the target of macos-latest.
joshualmashburn · Nov 21, 2024 · 9f59798 · 9f59798
1 parent aa433bd
commit 9f59798
Show file tree

Hide file tree

Showing 55 changed files with 9,067 additions and 0 deletions.
diff --git a/feature/dynamorio-tracer/.buildinfo b/feature/dynamorio-tracer/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 78900a5ac7921b4f150d7c6353f4423e
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/feature/dynamorio-tracer/.doctrees/Address-operations.doctree b/feature/dynamorio-tracer/.doctrees/Address-operations.doctree
diff --git a/feature/dynamorio-tracer/.doctrees/Bandwidth.doctree b/feature/dynamorio-tracer/.doctrees/Bandwidth.doctree
diff --git a/feature/dynamorio-tracer/.doctrees/Byte-sizes.doctree b/feature/dynamorio-tracer/.doctrees/Byte-sizes.doctree
diff --git a/feature/dynamorio-tracer/.doctrees/Cache-model.doctree b/feature/dynamorio-tracer/.doctrees/Cache-model.doctree
diff --git a/feature/dynamorio-tracer/.doctrees/Configuration-API.doctree b/feature/dynamorio-tracer/.doctrees/Configuration-API.doctree
diff --git a/feature/dynamorio-tracer/.doctrees/Core-model.doctree b/feature/dynamorio-tracer/.doctrees/Core-model.doctree
diff --git a/feature/dynamorio-tracer/.doctrees/Creating-a-configuration-file.doctree b/feature/dynamorio-tracer/.doctrees/Creating-a-configuration-file.doctree
diff --git a/feature/dynamorio-tracer/.doctrees/Legacy-modules.doctree b/feature/dynamorio-tracer/.doctrees/Legacy-modules.doctree
diff --git a/feature/dynamorio-tracer/.doctrees/Module-support-library.doctree b/feature/dynamorio-tracer/.doctrees/Module-support-library.doctree
diff --git a/feature/dynamorio-tracer/.doctrees/Modules.doctree b/feature/dynamorio-tracer/.doctrees/Modules.doctree
diff --git a/feature/dynamorio-tracer/.doctrees/Publications-using-champsim.doctree b/feature/dynamorio-tracer/.doctrees/Publications-using-champsim.doctree
diff --git a/feature/dynamorio-tracer/.doctrees/environment.pickle b/feature/dynamorio-tracer/.doctrees/environment.pickle
diff --git a/feature/dynamorio-tracer/.doctrees/index.doctree b/feature/dynamorio-tracer/.doctrees/index.doctree
diff --git a/feature/dynamorio-tracer/.nojekyll b/feature/dynamorio-tracer/.nojekyll
diff --git a/feature/dynamorio-tracer/Address-operations.html b/feature/dynamorio-tracer/Address-operations.html
diff --git a/feature/dynamorio-tracer/Bandwidth.html b/feature/dynamorio-tracer/Bandwidth.html
diff --git a/feature/dynamorio-tracer/Byte-sizes.html b/feature/dynamorio-tracer/Byte-sizes.html
diff --git a/feature/dynamorio-tracer/Cache-model.html b/feature/dynamorio-tracer/Cache-model.html
diff --git a/feature/dynamorio-tracer/Configuration-API.html b/feature/dynamorio-tracer/Configuration-API.html
diff --git a/feature/dynamorio-tracer/Core-model.html b/feature/dynamorio-tracer/Core-model.html
diff --git a/feature/dynamorio-tracer/Creating-a-configuration-file.html b/feature/dynamorio-tracer/Creating-a-configuration-file.html
diff --git a/feature/dynamorio-tracer/Legacy-modules.html b/feature/dynamorio-tracer/Legacy-modules.html
diff --git a/feature/dynamorio-tracer/Module-support-library.html b/feature/dynamorio-tracer/Module-support-library.html
diff --git a/feature/dynamorio-tracer/Modules.html b/feature/dynamorio-tracer/Modules.html
diff --git a/feature/dynamorio-tracer/Publications-using-champsim.html b/feature/dynamorio-tracer/Publications-using-champsim.html
@@ -0,0 +1,117 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>Publications &#8212; ChampSim  documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
+    <link rel="stylesheet" type="text/css" href="_static/nature.css?v=279e0f84" />
+    <script src="_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="_static/doctools.js?v=9bcbadda"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" /> 
+  </head><body>
+    <div class="related" role="navigation" aria-label="Related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ChampSim  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Publications</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+
+  <section id="publications">
+<span id="id1"></span><h1>Publications<a class="headerlink" href="#publications" title="Link to this heading">¶</a></h1>
+<p>ChampSim is primarily exhibited in</p>
+<div class="docutils container" id="id2">
+<ul class="simple">
+<li id="id3"><p>Nathan Gober, Gino Chacon, Lei Wang, Paul V. Gratz, Daniel A. Jiménez, Elvira Teran, Seth Pugsley, and Jinchun Kim. The championship simulator: architectural simulation for education and competition. 2022. <a class="reference external" href="https://arxiv.org/abs/2210.14324">arXiv:2210.14324</a>.</p></li>
+</ul>
+</div>
+<p>Other publications that use ChampSim for their results are listed below:</p>
+<div class="docutils container" id="id10">
+<ul class="simple">
+<li id="id16"><p>Gino Chacon, Nathan Gober, Krishnendra Nathella, Paul V. Gratz, and Daniel A. Jiménez. A characterization of the effects of software instruction prefetching on an aggressive front-end. In <em>Proceedings of the 47th Annual International Symposium on Computer Architecture</em>, 61–70. IEEE, 5 2020.</p></li>
+<li id="id12"><p>Nathan Gober, Gino Chacon, Daniel A. Jiménez, and Paul V. Gratz. Temporal ancestry prefetcher. In Seth Pugsley, Alaa Alameldeen, Muawya Al-otoom, and Huiyang Zhou, editors, <em>The First Instruction Prefetching Championship</em>. IEEE, 5 2020.</p></li>
+<li id="id13"><p>Daniel A. Jiménez, Gino Chacon, Nathan Gober, and Paul V. Gratz. Barca: branch agnostic region searching algorithm. In Seth Pugsley, Alaa Alameldeen, Muawya Al-otoom, and Huiyang Zhou, editors, <em>The First Instruction Prefetching Championship</em>. IEEE, 5 2020.</p></li>
+<li id="id14"><p>Eshan Bhatia, Gino Chacon, Seth Pugsley, Elvira Teran, Paul V. Gratz, and Daniel A. Jiménez. Perceptron-based prefetch filtering. In <em>Proceedings of the 47th Annual International Symposium on Computer Architecture</em>, 1–13. Phoenix, Arizona, 6 2019. IEEE. <a class="reference external" href="https://doi.org/10.1145/3307650.3322207">doi:10.1145/3307650.3322207</a>.</p></li>
+<li id="id15"><p>Samuel Pakalapati and Biswabandan Panda. Bouquet of instruction pointers: instruction pointer classifier-based spatial hardware prefetching. In <em>Proceedings of the 47th Annual International Symposium on Computer Architecture</em>, 118–131. Phoenix, Arizona, 6 2019. IEEE. <a class="reference external" href="https://doi.org/10.1109/ISCA45697.2020.00021">doi:10.1109/ISCA45697.2020.00021</a>.</p></li>
+<li id="id17"><p>Jinchun Kim, Seth H. Pugsley, Paul V. Gratz, A.L. Narasimha Reddy, Chris Wilkerson, and Zeshan Chishti. Path confidence based lookahead prefetching. In <em>MICRO-49: The 49th Annual IEEE\ACM International Symposium on Microarchitecture</em>, 1–12. Association for Computing Machinery, 10 2016. <a class="reference external" href="https://doi.org/10.1109/MICRO.2016.7783763">doi:10.1109/MICRO.2016.7783763</a>.</p></li>
+</ul>
+</div>
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+        <div class="sphinxsidebarwrapper">
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="_sources/Publications-using-champsim.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div><div role="note">
+  <h3> This page on other branches</h3>
+  <h4>Branches</h4>
+  <ul>
+
+        <li><a href="../../master/index.html">master</a></li>
+
+
+        <li><a href="../../develop/index.html">develop</a></li>
+
+
+        <li><strong>feature/dynamorio-tracer</strong></li>
+
+  </ul>
+</div>
+<search id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="Related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">ChampSim  documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Publications</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2023, The ChampSim Contributors.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
+    </div>
+  </body>
+</html>
diff --git a/feature/dynamorio-tracer/_sources/Address-operations.rst.txt b/feature/dynamorio-tracer/_sources/Address-operations.rst.txt
@@ -0,0 +1,44 @@
+.. _Address_operations:
+
+=======================================
+Address Operations
+=======================================
+
+-------------------------------------
+Addresses
+-------------------------------------
+
+.. doxygenclass:: champsim::address_slice
+   :members:
+
+.. doxygenfunction:: champsim::offset
+.. doxygenfunction:: champsim::uoffset
+.. doxygenfunction:: champsim::splice
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Convenience typedefs
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Champsim provides five specializations of an address slice in ``inc/champsim.h``
+
+.. doxygentypedef:: champsim::address
+.. doxygentypedef:: champsim::page_number
+.. doxygentypedef:: champsim::page_offset
+.. doxygentypedef:: champsim::block_number
+.. doxygentypedef:: champsim::block_offset
+
+--------------------------------------
+Extents
+--------------------------------------
+
+.. doxygenstruct:: champsim::static_extent
+   :members:
+.. doxygenstruct:: champsim::dynamic_extent
+   :members:
+.. doxygenstruct:: champsim::page_number_extent
+   :members:
+.. doxygenstruct:: champsim::page_offset_extent
+   :members:
+.. doxygenstruct:: champsim::block_number_extent
+   :members:
+.. doxygenstruct:: champsim::block_offset_extent
+   :members:
diff --git a/feature/dynamorio-tracer/_sources/Bandwidth.rst.txt b/feature/dynamorio-tracer/_sources/Bandwidth.rst.txt
@@ -0,0 +1,9 @@
+.. _Bandwidth:
+
+=============================================
+Bandwidth
+=============================================
+
+.. doxygenclass:: champsim::bandwidth
+   :members:
+
diff --git a/feature/dynamorio-tracer/_sources/Byte-sizes.rst.txt b/feature/dynamorio-tracer/_sources/Byte-sizes.rst.txt
@@ -0,0 +1,45 @@
+.. Byte Sizes:
+
+===========================================
+Byte Sizes
+===========================================
+
+ChampSim provides a strong type to represent a unit of byte size.
+Objects of this type are convertible to other byte sizes, but are more difficult to unintentionally use in arithmetic operations.
+
+.. doxygenclass:: champsim::data::size
+   :members:
+
+.. doxygenenum:: champsim::data::bits
+
+-----------------------------------------
+Convenience specializations
+-----------------------------------------
+
+ChampSim provides a number of ratio specializations for use in sizes:
+
+.. doxygentypedef:: champsim::kibi
+.. doxygentypedef:: champsim::mebi
+.. doxygentypedef:: champsim::gibi
+.. doxygentypedef:: champsim::tebi
+.. doxygentypedef:: champsim::pebi
+.. doxygentypedef:: champsim::exbi
+
+These types are also used in the convenience specializations:
+
+.. doxygentypedef:: champsim::data::bytes
+.. doxygentypedef:: champsim::data::kibibytes
+.. doxygentypedef:: champsim::data::mebibytes
+.. doxygentypedef:: champsim::data::gibibytes
+.. doxygentypedef:: champsim::data::tebibytes
+
+------------------------------------------
+Literals
+------------------------------------------
+
+.. doxygenfunction:: champsim::data::data_literals::operator""_b
+.. doxygenfunction:: champsim::data::data_literals::operator""_B
+.. doxygenfunction:: champsim::data::data_literals::operator""_kiB
+.. doxygenfunction:: champsim::data::data_literals::operator""_MiB
+.. doxygenfunction:: champsim::data::data_literals::operator""_GiB
+.. doxygenfunction:: champsim::data::data_literals::operator""_TiB
diff --git a/feature/dynamorio-tracer/_sources/Cache-model.rst.txt b/feature/dynamorio-tracer/_sources/Cache-model.rst.txt
@@ -0,0 +1,16 @@
+.. _Cache_model:
+
+=====================================
+Cache Model
+=====================================
+
+.. doxygenclass:: CACHE
+   :members:
+
+----------------------------------
+Builder
+----------------------------------
+
+.. doxygenclass:: champsim::cache_builder
+   :members:
+
diff --git a/feature/dynamorio-tracer/_sources/Configuration-API.rst.txt b/feature/dynamorio-tracer/_sources/Configuration-API.rst.txt
@@ -0,0 +1,73 @@
+.. _Configuration_API:
+
+=====================================
+Configuration API
+=====================================
+
+.. automodule:: config
+
+------------------------
+Parsing API
+------------------------
+
+.. autofunction:: config.parse.parse_config
+
+
+------------------------
+File Generation API
+------------------------
+
+The file generation API contains two interfaces: a high-level interface with :py:class:`config.filewrite.FileWriter`, and a low-level interface with :py:class:`config.filewrite.Fragment`.
+Users should prefer the high-level interface where possible.
+The low-level interface may provide greater flexibility when needed, for example a more parallel application.
+
+.. autoclass:: config.filewrite.FileWriter
+   :members:
+   :special-members: __enter__, __exit__
+
+.. autoclass:: config.filewrite.Fragment
+   :members:
+
+--------------------------
+Utility Functions
+--------------------------
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+System operations
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ChampSim's configuration makes frequent use of sequences of dictionaries. The following functions operate on a system, a dictionary whose values are dictionaries.
+
+.. autofunction:: config.util.iter_system
+.. autofunction:: config.util.combine_named
+.. autofunction:: config.util.upper_levels_for
+.. autofunction:: config.util.propogate_down
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Itertools extentions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The following functions are extentions of the itertools package.
+
+.. autofunction:: config.util.collect
+.. autofunction:: config.util.batch
+.. autofunction:: config.util.sliding
+.. autofunction:: config.util.cut
+.. autofunction:: config.util.do_for_first
+.. autofunction:: config.util.append_except_last
+.. autofunction:: config.util.multiline
+.. autofunction:: config.util.yield_from_star
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Dictionary Operations
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ChampSim frequently operates on dictionaries, so these functions are provided as convenience functions.
+
+.. autofunction:: config.util.chain
+.. autofunction:: config.util.subdict
+.. autofunction:: config.util.extend_each
+.. autofunction:: config.util.explode
+.. autofunction:: config.parse.duplicate_to_length
+.. autofunction:: config.parse.extract_element
+
diff --git a/feature/dynamorio-tracer/_sources/Core-model.rst.txt b/feature/dynamorio-tracer/_sources/Core-model.rst.txt
@@ -0,0 +1,16 @@
+.. _Core_model:
+
+=====================================
+Core Model
+=====================================
+
+.. doxygenclass:: O3_CPU
+   :members:
+
+----------------------------------
+Builder
+----------------------------------
+
+.. doxygenclass:: champsim::core_builder
+   :members:
+