<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>experiments/armvis/README.md - collab/polyglot-riscv-arm @ main</title>
<meta name="description" content="experiments/armvis/README.md in collab/polyglot-riscv-arm at main.">
<meta property="og:title" content="experiments/armvis/README.md - collab/polyglot-riscv-arm @ main">
<meta property="og:description" content="experiments/armvis/README.md in collab/polyglot-riscv-arm at main.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="main" data-tip="b777b16aa3c1d8872f562c5a8186cc64bdab35d2">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>collab/polyglot-riscv-arm</h1>
<p class="desc">what if the same machine code was valid riscv and arm asm</p>
</div>
<pre class="clone">git clone https://git.julia.blue/collab/polyglot-riscv-arm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Jonathan Dönszelmann</span><span class="commit-message" data-commit="885cc4eea5837905f3bfd2feb4c8e001c14c06b0">website start</span><span class="snapshot-sha sha" data-commit="885cc4eea5837905f3bfd2feb4c8e001c14c06b0">885cc4e</span><time datetime="2024-10-21T21:46:26+02:00" title="2024-10-21 21:46:26 +0200">2024-10-21</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a class="current" href="/collab/polyglot-riscv-arm/ref/main/">main</a><a class="all" href="/collab/polyglot-riscv-arm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/collab/polyglot-riscv-arm/">polyglot-riscv-arm</a> / <a href="/collab/polyglot-riscv-arm/ref/main/tree/experiments/">experiments</a> / <a href="/collab/polyglot-riscv-arm/ref/main/tree/experiments/armvis/">armvis</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.7 KiB</span><span>41 lines</span></span><span class="actions"><a class="raw" href="/collab/polyglot-riscv-arm/raw/de4777dcc368057d922a07560422369784ea6634/experiments/armvis/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>ARM Analysis and Visualization</h1>
<p><img src="./img/arm64_solarized.png" alt="arm64solarized" /></p>
<p>This image is a visual representation of the ARM64 instruction, with all
instructions plotted over a Hilbert curve and colored according to their
instruction class (<code>general</code>, <code>float</code>, <code>advsimd</code>, <code>sve</code>, etc...).</p>
<p>This is a set of tools for analyzing and visualizing the ARM64 architecture.
The tools parse the ARM machine readable architecture (MRA) and can generate
images and data sets. These tools are not particularly optimized, so generating
the data files may take a lot of space.</p>
<p>The tools consist of</p>
<ul>
<li><code>arm-classify</code>: creates a JSON record of every instruction encoding type.</li>
<li><code>arm-gen</code>: generates a map of all ARM64 instructions to their encoding type.</li>
<li><code>arm-map</code>: generates a list of all blocks of 256 ARM64 instructions, and the
weight of each instruction class within the block.</li>
<li><code>arm-vis</code>: generates a PNG file from a mapping by plotting the instructions
over a Hilbert curve and using a palette of colors to represent different
instruction classes.</li>
</ul>
<h1>Generating Images</h1>
<p>To generate the images from scratch, first download the MRA for AArch64 and
extract it. Then run the following commands, which may take a long time
(multiple hours) and use about 9G of disk space. Long commands will print the
execution percentage as they run.</p>
<pre>$ arm-classify MRA_ISA &gt; data/arm64.json
$ go run cmd/arm-gen/decode_gen.go data/arm64.json &gt; cmd/arm-gen/decode.go # regenerate decode.go
$ go install ./cmd/arm-gen # rebuild arm-gen
$ arm-gen -o data/arm64.dat
$ make -C capstone &amp;&amp; ./postprocess/capstone data/arm64.dat
$ arm-map -data data/arm64.dat -json data/arm64.json &gt; data/arm64.map
$ arm-vis -o img/arm64.png -theme monokai data/arm64.map
</pre>
<p><img src="./img/arm64_monokai.png" alt="arm64monokai" /></p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>ARM Analysis and Visualization</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">![arm64solarized](./img/arm64_solarized.png)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">This image is a visual representation of the ARM64 instruction, with all</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">instructions plotted over a Hilbert curve and colored according to their</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">instruction class (`general`, `float`, `advsimd`, `sve`, etc...).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">This is a set of tools for analyzing and visualizing the ARM64 architecture.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">The tools parse the ARM machine readable architecture (MRA) and can generate</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">images and data sets. These tools are not particularly optimized, so generating</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">the data files may take a lot of space.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">The tools consist of</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>* </a-p>`arm-classify`: creates a JSON record of every instruction encoding type.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>* </a-p>`arm-gen`: generates a map of all ARM64 instructions to their encoding type.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>* </a-p>`arm-map`: generates a list of all blocks of 256 ARM64 instructions, and the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>  </a-p>weight of each instruction class within the block.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>* </a-p>`arm-vis`: generates a PNG file from a mapping by plotting the instructions</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>  </a-p>over a Hilbert curve and using a palette of colors to represent different</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>  </a-p>instruction classes.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p># </a-p><a-tt>Generating Images</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>To generate the images from scratch, first download the MRA for AArch64 and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>extract it. Then run the following commands, which may take a long time</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>(multiple hours) and use about 9G of disk space. Long commands will print the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>execution percentage as they run.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>$ arm-classify MRA_ISA &gt; data/arm64.json</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>$ go run cmd/arm-gen/decode_gen.go data/arm64.json &gt; cmd/arm-gen/decode.go # regenerate decode.go</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>$ go install ./cmd/arm-gen # rebuild arm-gen</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>$ arm-gen -o data/arm64.dat</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>$ make -C capstone &amp;&amp; ./postprocess/capstone data/arm64.dat</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>$ arm-map -data data/arm64.dat -json data/arm64.json &gt; data/arm64.map</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>$ arm-vis -o img/arm64.png -theme monokai data/arm64.map</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text">![arm64monokai](./img/arm64_monokai.png)</span></span></pre></div></div>
</main>
</body>
</html>
