index.xml (87166B)
1 <?xml version="1.0" encoding="utf-8" standalone="yes"?> 2 <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:content="http://purl.org/rss/1.0/modules/content/"> 3 <channel> 4 <title>Electrosoup</title> 5 <link>https://electrosoup.com/</link> 6 <description>Recent content on Electrosoup</description> 7 <generator>Hugo -- gohugo.io</generator> 8 <language>en-US</language> 9 <managingEditor>christianermann@gmail.com (Christian Ermann)</managingEditor> 10 <webMaster>christianermann@gmail.com (Christian Ermann)</webMaster> 11 <lastBuildDate>Wed, 25 Aug 2021 00:00:00 +0000</lastBuildDate> 12 <atom:link href="https://electrosoup.com/index.xml" rel="self" type="application/rss+xml" /> 13 <item> 14 <title>Forth RV32I Assembler</title> 15 <link>https://electrosoup.com/posts/forth-rv32i-assembler/</link> 16 <pubDate>Wed, 13 Nov 2024 17:33:47 -0800</pubDate><author>christianermann@gmail.com (Christian Ermann)</author> 17 <guid>https://electrosoup.com/posts/forth-rv32i-assembler/</guid> 18 <description><p>Here&rsquo;s an assembler for RV32I that I wrote in Forth. I find the definitions of
the instructions and instruction types especially elegant, and I find it to be
a great demonstration of how concise and powerful Forth can be.</p></description> 19 <content:encoded><![CDATA[<p>Here’s an assembler for RV32I that I wrote in Forth. I find the definitions of 20 the instructions and instruction types especially elegant, and I find it to be 21 a great demonstration of how concise and powerful Forth can be.</p> 22 <p>All code in this post is licensed under the 23 <a href="https://www.gnu.org/licenses/agpl-3.0.en.html#license-text">AGPLv3</a>.</p> 24 25 26 27 28 29 <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-forth" data-lang="forth"><span class="line"><span class="ln"> 1</span><span class="cl"><span class="c1">\ encode stack values into proper instruction locations. all 30 </span></span></span><span class="line"><span class="ln"> 2</span><span class="cl"><span class="c1">\ encoding sequences must begin with 'opcode'. 31 </span></span></span><span class="line"><span class="ln"> 3</span><span class="cl"><span class="c1"></span><span class="kn">:</span> <span class="nc">opcode</span> <span class="k">hex </span> <span class="mi">7</span><span class="nf">F</span> <span class="k">and </span> <span class="k">; 32 </span></span></span><span class="line"><span class="ln"> 4</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">funct3</span> <span class="k">swap hex </span> <span class="mi">7</span> <span class="k">and decimal </span><span class="mi">12</span> <span class="k">lshift + ; 33 </span></span></span><span class="line"><span class="ln"> 5</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">funct7</span> <span class="k">swap hex </span> <span class="mi">7</span><span class="nf">F</span> <span class="k">and decimal </span><span class="mi">25</span> <span class="k">lshift + ; 34 </span></span></span><span class="line"><span class="ln"> 6</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">i-immed</span> <span class="k">swap hex </span> <span class="nf">FFF</span> <span class="k">and decimal </span><span class="mi">20</span> <span class="k">lshift + ; 35 </span></span></span><span class="line"><span class="ln"> 7</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">i-immed-shamt</span> <span class="k">swap hex </span> <span class="mi">1</span><span class="nf">F</span> <span class="k">and decimal </span><span class="mi">20</span> <span class="k">lshift + ; 36 </span></span></span><span class="line"><span class="ln"> 8</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">u-immed</span> <span class="k">swap hex </span> <span class="nf">FFFFF</span> <span class="k">and decimal </span><span class="mi">12</span> <span class="k">lshift + ; 37 </span></span></span><span class="line"><span class="ln"> 9</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">s-immed</span> <span class="k">over hex </span> <span class="nf">FE0</span> <span class="k">and decimal </span><span class="mi">20</span> <span class="k">lshift + 38 </span></span></span><span class="line"><span class="ln"> 10</span><span class="cl"><span class="k"></span> <span class="k">swap hex </span> <span class="mi">1</span><span class="nf">F</span> <span class="k">and decimal </span> <span class="mi">7</span> <span class="k">lshift + ; 39 </span></span></span><span class="line"><span class="ln"> 11</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">j-immed</span> <span class="k">over hex </span><span class="mi">100000</span> <span class="k">and decimal </span><span class="mi">11</span> <span class="k">lshift + 40 </span></span></span><span class="line"><span class="ln"> 12</span><span class="cl"><span class="k"></span> <span class="k">over hex </span> <span class="nf">FF000</span> <span class="k">and </span> <span class="k">+ 41 </span></span></span><span class="line"><span class="ln"> 13</span><span class="cl"><span class="k"></span> <span class="k">over hex </span> <span class="mi">800</span> <span class="k">and decimal </span> <span class="mi">9</span> <span class="k">lshift + 42 </span></span></span><span class="line"><span class="ln"> 14</span><span class="cl"><span class="k"></span> <span class="k">swap hex </span> <span class="mi">7</span><span class="nf">FE</span> <span class="k">and decimal </span><span class="mi">20</span> <span class="k">lshift + ; 43 </span></span></span><span class="line"><span class="ln"> 15</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">b-immed</span> <span class="k">over hex </span> <span class="mi">1000</span> <span class="k">and decimal </span><span class="mi">19</span> <span class="k">lshift + 44 </span></span></span><span class="line"><span class="ln"> 16</span><span class="cl"><span class="k"></span> <span class="k">over hex </span> <span class="mi">800</span> <span class="k">and decimal </span> <span class="mi">4</span> <span class="k">rshift + 45 </span></span></span><span class="line"><span class="ln"> 17</span><span class="cl"><span class="k"></span> <span class="k">over hex </span> <span class="mi">7</span><span class="nf">E0</span> <span class="k">and decimal </span><span class="mi">20</span> <span class="k">lshift + 46 </span></span></span><span class="line"><span class="ln"> 18</span><span class="cl"><span class="k"></span> <span class="k">swap hex </span> <span class="mi">1</span><span class="nf">E</span> <span class="k">and decimal </span> <span class="mi">7</span> <span class="k">lshift + ; 47 </span></span></span><span class="line"><span class="ln"> 19</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">rd</span> <span class="k">swap hex </span> <span class="mi">1</span><span class="nf">F</span> <span class="k">and decimal </span> <span class="mi">7</span> <span class="k">lshift + ; 48 </span></span></span><span class="line"><span class="ln"> 20</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">rs1</span> <span class="k">swap hex </span> <span class="mi">1</span><span class="nf">F</span> <span class="k">and decimal </span><span class="mi">15</span> <span class="k">lshift + ; 49 </span></span></span><span class="line"><span class="ln"> 21</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">rs2</span> <span class="k">swap hex </span> <span class="mi">1</span><span class="nf">F</span> <span class="k">and decimal </span><span class="mi">20</span> <span class="k">lshift + ; 50 </span></span></span><span class="line"><span class="ln"> 22</span><span class="cl"><span class="k"></span> 51 </span></span><span class="line"><span class="ln"> 23</span><span class="cl"><span class="c1">\ instruction types. all instruction values should be pushed on the 52 </span></span></span><span class="line"><span class="ln"> 24</span><span class="cl"><span class="c1">\ stack with the opcode last before calling. 53 </span></span></span><span class="line"><span class="ln"> 25</span><span class="cl"><span class="c1"></span><span class="kn">:</span> <span class="nc">r-type</span> <span class="nf">opcode</span> <span class="nf">funct3</span> <span class="nf">funct7</span> <span class="nf">rs2</span> <span class="nf">rs1</span> <span class="nf">rd</span> <span class="k">, ; 54 </span></span></span><span class="line"><span class="ln"> 26</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">i-type</span> <span class="nf">opcode</span> <span class="nf">funct3</span> <span class="nf">i-immed</span> <span class="nf">rs1</span> <span class="nf">rd</span> <span class="k">, ; 55 </span></span></span><span class="line"><span class="ln"> 27</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">i-type-shamt</span> <span class="nf">opcode</span> <span class="nf">funct3</span> <span class="nf">funct7</span> <span class="nf">i-immed-shamt</span> <span class="nf">rs1</span> <span class="nf">rd</span> <span class="k">, ; 56 </span></span></span><span class="line"><span class="ln"> 28</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">s-type</span> <span class="nf">opcode</span> <span class="nf">funct3</span> <span class="nf">s-immed</span> <span class="nf">rs2</span> <span class="nf">rs1</span> <span class="k">, ; 57 </span></span></span><span class="line"><span class="ln"> 29</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">b-type</span> <span class="nf">opcode</span> <span class="nf">funct3</span> <span class="nf">b-immed</span> <span class="nf">rs2</span> <span class="nf">rs1</span> <span class="k">, ; 58 </span></span></span><span class="line"><span class="ln"> 30</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">u-type</span> <span class="nf">opcode</span> <span class="nf">u-immed</span> <span class="nf">rd</span> <span class="k">, ; 59 </span></span></span><span class="line"><span class="ln"> 31</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">j-type</span> <span class="nf">opcode</span> <span class="nf">j-immed</span> <span class="nf">rd</span> <span class="k">, ; 60 </span></span></span><span class="line"><span class="ln"> 32</span><span class="cl"><span class="k"></span> 61 </span></span><span class="line"><span class="ln"> 33</span><span class="cl"><span class="c1">\ instructions. these are just simple encodings, no assembler 62 </span></span></span><span class="line"><span class="ln"> 34</span><span class="cl"><span class="c1">\ niceties yet. 63 </span></span></span><span class="line"><span class="ln"> 35</span><span class="cl"><span class="c1">\ funct7 funct3 opcode encoding 64 </span></span></span><span class="line"><span class="ln"> 36</span><span class="cl"><span class="c1"></span><span class="kn">:</span> <span class="nc">addi,</span> <span class="k">hex </span> <span class="mi">0</span> <span class="mi">13</span> <span class="nf">i-type</span> <span class="k">; 65 </span></span></span><span class="line"><span class="ln"> 37</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">andi,</span> <span class="k">hex </span> <span class="mi">7</span> <span class="mi">13</span> <span class="nf">i-type</span> <span class="k">; 66 </span></span></span><span class="line"><span class="ln"> 38</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">ori,</span> <span class="k">hex </span> <span class="mi">6</span> <span class="mi">13</span> <span class="nf">i-type</span> <span class="k">; 67 </span></span></span><span class="line"><span class="ln"> 39</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">xori,</span> <span class="k">hex </span> <span class="mi">4</span> <span class="mi">13</span> <span class="nf">i-type</span> <span class="k">; 68 </span></span></span><span class="line"><span class="ln"> 40</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">slli,</span> <span class="k">hex </span> <span class="mi">00</span> <span class="mi">1</span> <span class="mi">13</span> <span class="nf">i-type-shamt</span> <span class="k">; 69 </span></span></span><span class="line"><span class="ln"> 41</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">srli,</span> <span class="k">hex </span> <span class="mi">00</span> <span class="mi">5</span> <span class="mi">13</span> <span class="nf">i-type-shamt</span> <span class="k">; 70 </span></span></span><span class="line"><span class="ln"> 42</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">srai,</span> <span class="k">hex </span> <span class="mi">20</span> <span class="mi">5</span> <span class="mi">13</span> <span class="nf">i-type-shamt</span> <span class="k">; 71 </span></span></span><span class="line"><span class="ln"> 43</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">slti,</span> <span class="k">hex </span> <span class="mi">2</span> <span class="mi">13</span> <span class="nf">i-type</span> <span class="k">; 72 </span></span></span><span class="line"><span class="ln"> 44</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">sltiu,</span> <span class="k">hex </span> <span class="mi">3</span> <span class="mi">13</span> <span class="nf">i-type</span> <span class="k">; 73 </span></span></span><span class="line"><span class="ln"> 45</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">lui,</span> <span class="k">hex </span> <span class="mi">37</span> <span class="nf">u-type</span> <span class="k">; 74 </span></span></span><span class="line"><span class="ln"> 46</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">auipc,</span> <span class="k">hex </span> <span class="mi">17</span> <span class="nf">u-type</span> <span class="k">; 75 </span></span></span><span class="line"><span class="ln"> 47</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">add,</span> <span class="k">hex </span> <span class="mi">00</span> <span class="mi">0</span> <span class="mi">33</span> <span class="nf">r-type</span> <span class="k">; 76 </span></span></span><span class="line"><span class="ln"> 48</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">sub,</span> <span class="k">hex </span> <span class="mi">20</span> <span class="mi">0</span> <span class="mi">33</span> <span class="nf">r-type</span> <span class="k">; 77 </span></span></span><span class="line"><span class="ln"> 49</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">and,</span> <span class="k">hex </span> <span class="mi">00</span> <span class="mi">7</span> <span class="mi">33</span> <span class="nf">r-type</span> <span class="k">; 78 </span></span></span><span class="line"><span class="ln"> 50</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">or,</span> <span class="k">hex </span> <span class="mi">00</span> <span class="mi">6</span> <span class="mi">33</span> <span class="nf">r-type</span> <span class="k">; 79 </span></span></span><span class="line"><span class="ln"> 51</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">xor,</span> <span class="k">hex </span> <span class="mi">00</span> <span class="mi">4</span> <span class="mi">33</span> <span class="nf">r-type</span> <span class="k">; 80 </span></span></span><span class="line"><span class="ln"> 52</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">sll,</span> <span class="k">hex </span> <span class="mi">00</span> <span class="mi">1</span> <span class="mi">33</span> <span class="nf">r-type</span> <span class="k">; 81 </span></span></span><span class="line"><span class="ln"> 53</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">srl,</span> <span class="k">hex </span> <span class="mi">00</span> <span class="mi">5</span> <span class="mi">33</span> <span class="nf">r-type</span> <span class="k">; 82 </span></span></span><span class="line"><span class="ln"> 54</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">sra,</span> <span class="k">hex </span> <span class="mi">20</span> <span class="mi">5</span> <span class="mi">33</span> <span class="nf">r-type</span> <span class="k">; 83 </span></span></span><span class="line"><span class="ln"> 55</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">slt,</span> <span class="k">hex </span> <span class="mi">00</span> <span class="mi">2</span> <span class="mi">33</span> <span class="nf">r-type</span> <span class="k">; 84 </span></span></span><span class="line"><span class="ln"> 56</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">sltu,</span> <span class="k">hex </span> <span class="mi">00</span> <span class="mi">3</span> <span class="mi">33</span> <span class="nf">r-type</span> <span class="k">; 85 </span></span></span><span class="line"><span class="ln"> 57</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">jal,</span> <span class="k">hex </span> <span class="mi">6</span><span class="nf">F</span> <span class="nf">j-type</span> <span class="k">; 86 </span></span></span><span class="line"><span class="ln"> 58</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">jalr,</span> <span class="k">hex </span> <span class="mi">0</span> <span class="mi">67</span> <span class="nf">i-type</span> <span class="k">; 87 </span></span></span><span class="line"><span class="ln"> 59</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">beq,</span> <span class="k">hex </span> <span class="mi">0</span> <span class="mi">63</span> <span class="nf">b-type</span> <span class="k">; 88 </span></span></span><span class="line"><span class="ln"> 60</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">bne,</span> <span class="k">hex </span> <span class="mi">1</span> <span class="mi">63</span> <span class="nf">b-type</span> <span class="k">; 89 </span></span></span><span class="line"><span class="ln"> 61</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">blt,</span> <span class="k">hex </span> <span class="mi">4</span> <span class="mi">63</span> <span class="nf">b-type</span> <span class="k">; 90 </span></span></span><span class="line"><span class="ln"> 62</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">bltu,</span> <span class="k">hex </span> <span class="mi">6</span> <span class="mi">63</span> <span class="nf">b-type</span> <span class="k">; 91 </span></span></span><span class="line"><span class="ln"> 63</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">bge,</span> <span class="k">hex </span> <span class="mi">5</span> <span class="mi">63</span> <span class="nf">b-type</span> <span class="k">; 92 </span></span></span><span class="line"><span class="ln"> 64</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">bgeu,</span> <span class="k">hex </span> <span class="mi">7</span> <span class="mi">63</span> <span class="nf">b-type</span> <span class="k">; 93 </span></span></span><span class="line"><span class="ln"> 65</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">lw,</span> <span class="k">hex </span> <span class="mi">2</span> <span class="mi">03</span> <span class="nf">i-type</span> <span class="k">; 94 </span></span></span><span class="line"><span class="ln"> 66</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">lh,</span> <span class="k">hex </span> <span class="mi">1</span> <span class="mi">03</span> <span class="nf">i-type</span> <span class="k">; 95 </span></span></span><span class="line"><span class="ln"> 67</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">lhu,</span> <span class="k">hex </span> <span class="mi">5</span> <span class="mi">03</span> <span class="nf">i-type</span> <span class="k">; 96 </span></span></span><span class="line"><span class="ln"> 68</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">lb,</span> <span class="k">hex </span> <span class="mi">0</span> <span class="mi">03</span> <span class="nf">i-type</span> <span class="k">; 97 </span></span></span><span class="line"><span class="ln"> 69</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">sw,</span> <span class="k">hex </span> <span class="mi">2</span> <span class="mi">23</span> <span class="nf">s-type</span> <span class="k">; 98 </span></span></span><span class="line"><span class="ln"> 70</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">sh,</span> <span class="k">hex </span> <span class="mi">1</span> <span class="mi">23</span> <span class="nf">s-type</span> <span class="k">; 99 </span></span></span><span class="line"><span class="ln"> 71</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">sb,</span> <span class="k">hex </span> <span class="mi">0</span> <span class="mi">23</span> <span class="nf">s-type</span> <span class="k">; 100 </span></span></span><span class="line"><span class="ln"> 72</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">fence,</span> <span class="k">hex </span> <span class="mi">0</span> <span class="mi">0</span><span class="nf">F</span> <span class="nf">i-type</span> <span class="k">; 101 </span></span></span><span class="line"><span class="ln"> 73</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">ecall,</span> <span class="k">hex </span> <span class="mi">0</span> <span class="mi">73</span> <span class="nf">i-type</span> <span class="k">; 102 </span></span></span><span class="line"><span class="ln"> 74</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">ebreak,</span> <span class="k">hex </span> <span class="mi">0</span> <span class="mi">73</span> <span class="nf">i-type</span> <span class="k">; 103 </span></span></span><span class="line"><span class="ln"> 75</span><span class="cl"><span class="k"></span> 104 </span></span><span class="line"><span class="ln"> 76</span><span class="cl"><span class="c1">\ some instructions, now with nicer usage. 105 </span></span></span><span class="line"><span class="ln"> 77</span><span class="cl"><span class="c1"></span><span class="kn">:</span> <span class="nc">sw,</span> <span class="k">>r swap r> </span><span class="nf">sw,</span> <span class="k">; 106 </span></span></span><span class="line"><span class="ln"> 78</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">sh,</span> <span class="k">>r swap r> </span><span class="nf">sh,</span> <span class="k">; 107 </span></span></span><span class="line"><span class="ln"> 79</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">sb,</span> <span class="k">>r swap r> </span><span class="nf">sb,</span> <span class="k">; 108 </span></span></span><span class="line"><span class="ln"> 80</span><span class="cl"><span class="k"></span><span class="kn">:</span> <span class="nc">ecall,</span> <span class="mi">0</span> <span class="mi">0</span> <span class="mi">0</span> <span class="nf">ecall,</span> <span class="k">; </span> <span class="c1">\ usage: ecall, 109 </span></span></span><span class="line"><span class="ln"> 81</span><span class="cl"><span class="c1"></span><span class="kn">:</span> <span class="nc">ebreak,</span> <span class="mi">0</span> <span class="mi">0</span> <span class="mi">1</span> <span class="nf">ebreak,</span> <span class="k">; </span> <span class="c1">\ usage: ebreak, 110 </span></span></span><span class="line"><span class="ln"> 82</span><span class="cl"><span class="c1"></span><span class="kn">:</span> <span class="nc">fence,</span> <span class="k">>r </span><span class="mi">0</span> <span class="mi">0</span> <span class="k">r> </span><span class="nf">fence,</span> <span class="k">; </span><span class="c1">\ usage: imm fence, 111 </span></span></span><span class="line"><span class="ln"> 83</span><span class="cl"><span class="c1"></span> 112 </span></span><span class="line"><span class="ln"> 84</span><span class="cl"><span class="c1">\ registers 113 </span></span></span><span class="line"><span class="ln"> 85</span><span class="cl"><span class="c1"></span><span class="k">decimal 114 </span></span></span><span class="line"><span class="ln"> 86</span><span class="cl"><span class="k"></span> <span class="mi">0</span> <span class="kn">constant</span> <span class="nc">x0</span> <span class="mi">1</span> <span class="kn">constant</span> <span class="nc">x1</span> <span class="mi">2</span> <span class="kn">constant</span> <span class="nc">x2</span> <span class="mi">3</span> <span class="kn">constant</span> <span class="nc">x3</span> 115 </span></span><span class="line"><span class="ln"> 87</span><span class="cl"> <span class="mi">4</span> <span class="kn">constant</span> <span class="nc">x4</span> <span class="mi">5</span> <span class="kn">constant</span> <span class="nc">x5</span> <span class="mi">6</span> <span class="kn">constant</span> <span class="nc">x6</span> <span class="mi">7</span> <span class="kn">constant</span> <span class="nc">x7</span> 116 </span></span><span class="line"><span class="ln"> 88</span><span class="cl"> <span class="mi">8</span> <span class="kn">constant</span> <span class="nc">x8</span> <span class="mi">9</span> <span class="kn">constant</span> <span class="nc">x9</span> <span class="mi">10</span> <span class="kn">constant</span> <span class="nc">x10</span> <span class="mi">11</span> <span class="kn">constant</span> <span class="nc">x11</span> 117 </span></span><span class="line"><span class="ln"> 89</span><span class="cl"><span class="mi">12</span> <span class="kn">constant</span> <span class="nc">x12</span> <span class="mi">13</span> <span class="kn">constant</span> <span class="nc">x13</span> <span class="mi">14</span> <span class="kn">constant</span> <span class="nc">x14</span> <span class="mi">15</span> <span class="kn">constant</span> <span class="nc">x15</span> 118 </span></span><span class="line"><span class="ln"> 90</span><span class="cl"><span class="mi">16</span> <span class="kn">constant</span> <span class="nc">x16</span> <span class="mi">17</span> <span class="kn">constant</span> <span class="nc">x17</span> <span class="mi">18</span> <span class="kn">constant</span> <span class="nc">x18</span> <span class="mi">19</span> <span class="kn">constant</span> <span class="nc">x19</span> 119 </span></span><span class="line"><span class="ln"> 91</span><span class="cl"><span class="mi">20</span> <span class="kn">constant</span> <span class="nc">x20</span> <span class="mi">21</span> <span class="kn">constant</span> <span class="nc">x21</span> <span class="mi">22</span> <span class="kn">constant</span> <span class="nc">x22</span> <span class="mi">23</span> <span class="kn">constant</span> <span class="nc">x23</span> 120 </span></span><span class="line"><span class="ln"> 92</span><span class="cl"><span class="mi">24</span> <span class="kn">constant</span> <span class="nc">x24</span> <span class="mi">25</span> <span class="kn">constant</span> <span class="nc">x25</span> <span class="mi">26</span> <span class="kn">constant</span> <span class="nc">x26</span> <span class="mi">27</span> <span class="kn">constant</span> <span class="nc">x27</span> 121 </span></span><span class="line"><span class="ln"> 93</span><span class="cl"><span class="mi">28</span> <span class="kn">constant</span> <span class="nc">x28</span> <span class="mi">29</span> <span class="kn">constant</span> <span class="nc">x29</span> <span class="mi">30</span> <span class="kn">constant</span> <span class="nc">x30</span> <span class="mi">31</span> <span class="kn">constant</span> <span class="nc">x31</span> 122 </span></span><span class="line"><span class="ln"> 94</span><span class="cl"> 123 </span></span><span class="line"><span class="ln"> 95</span><span class="cl"><span class="c1">\ registers (calling convention) 124 </span></span></span><span class="line"><span class="ln"> 96</span><span class="cl"><span class="c1"></span><span class="nf">x0</span> <span class="kn">constant</span> <span class="nc">zero</span> <span class="c1">\ zero constant 125 </span></span></span><span class="line"><span class="ln"> 97</span><span class="cl"><span class="c1"></span><span class="nf">x1</span> <span class="kn">constant</span> <span class="nc">ra</span> <span class="c1">\ return address 126 </span></span></span><span class="line"><span class="ln"> 98</span><span class="cl"><span class="c1"></span><span class="nf">x2</span> <span class="kn">constant</span> <span class="nc">sp</span> <span class="c1">\ stack pointer 127 </span></span></span><span class="line"><span class="ln"> 99</span><span class="cl"><span class="c1"></span><span class="nf">x3</span> <span class="kn">constant</span> <span class="nc">gp</span> <span class="c1">\ global pointer 128 </span></span></span><span class="line"><span class="ln">100</span><span class="cl"><span class="c1"></span><span class="nf">x4</span> <span class="kn">constant</span> <span class="nc">tp</span> <span class="c1">\ thread pointer 129 </span></span></span><span class="line"><span class="ln">101</span><span class="cl"><span class="c1"></span><span class="nf">x8</span> <span class="kn">constant</span> <span class="nc">fp</span> <span class="c1">\ frame pointer 130 </span></span></span><span class="line"><span class="ln">102</span><span class="cl"><span class="c1">\ function arguments / return values (a0, a1) 131 </span></span></span><span class="line"><span class="ln">103</span><span class="cl"><span class="c1"></span><span class="nf">x10</span> <span class="kn">constant</span> <span class="nc">a0</span> <span class="nf">x11</span> <span class="kn">constant</span> <span class="nc">a1</span> <span class="nf">x12</span> <span class="kn">constant</span> <span class="nc">a2</span> <span class="nf">x13</span> <span class="kn">constant</span> <span class="nc">a3</span> 132 </span></span><span class="line"><span class="ln">104</span><span class="cl"><span class="nf">x14</span> <span class="kn">constant</span> <span class="nc">a4</span> <span class="nf">x15</span> <span class="kn">constant</span> <span class="nc">a5</span> <span class="nf">x16</span> <span class="kn">constant</span> <span class="nc">a6</span> <span class="nf">x17</span> <span class="kn">constant</span> <span class="nc">a7</span> 133 </span></span><span class="line"><span class="ln">105</span><span class="cl"><span class="c1">\ saved registers 134 </span></span></span><span class="line"><span class="ln">106</span><span class="cl"><span class="c1"></span><span class="nf">x8</span> <span class="kn">constant</span> <span class="nc">s0</span> <span class="nf">x9</span> <span class="kn">constant</span> <span class="nc">s1</span> <span class="nf">x18</span> <span class="kn">constant</span> <span class="nc">s2</span> <span class="nf">x19</span> <span class="kn">constant</span> <span class="nc">s3</span> 135 </span></span><span class="line"><span class="ln">107</span><span class="cl"><span class="nf">x20</span> <span class="kn">constant</span> <span class="nc">s4</span> <span class="nf">x21</span> <span class="kn">constant</span> <span class="nc">s5</span> <span class="nf">x22</span> <span class="kn">constant</span> <span class="nc">s6</span> <span class="nf">x23</span> <span class="kn">constant</span> <span class="nc">s7</span> 136 </span></span><span class="line"><span class="ln">108</span><span class="cl"><span class="nf">x24</span> <span class="kn">constant</span> <span class="nc">s8</span> <span class="nf">x25</span> <span class="kn">constant</span> <span class="nc">s9</span> <span class="nf">x26</span> <span class="kn">constant</span> <span class="nc">s10</span> <span class="nf">x27</span> <span class="kn">constant</span> <span class="nc">s11</span> 137 </span></span><span class="line"><span class="ln">109</span><span class="cl"><span class="c1">\ temporaries 138 </span></span></span><span class="line"><span class="ln">110</span><span class="cl"><span class="c1"></span><span class="nf">x5</span> <span class="kn">constant</span> <span class="nc">t0</span> <span class="nf">x6</span> <span class="kn">constant</span> <span class="nc">t1</span> <span class="nf">x7</span> <span class="kn">constant</span> <span class="nc">t2</span> <span class="nf">x28</span> <span class="kn">constant</span> <span class="nc">t3</span> 139 </span></span><span class="line"><span class="ln">111</span><span class="cl"><span class="nf">x29</span> <span class="kn">constant</span> <span class="nc">t4</span> <span class="nf">x30</span> <span class="kn">constant</span> <span class="nc">t5</span> <span class="nf">x31</span> <span class="kn">constant</span> <span class="nc">t6</span></span></span></code></pre></div><p>And here’s some tests to verify the instruction encodings are generated 140 correctly:</p> 141 142 143 144 145 146 <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-forth" data-lang="forth"><span class="line"><span class="ln"> 1</span><span class="cl"><span class="kn">:</span> <span class="nc">undo,</span> <span class="mi">-1</span> <span class="k">cells allot here @ ; </span><span class="c1">\ undoes the last ',' 147 </span></span></span><span class="line"><span class="ln"> 2</span><span class="cl"><span class="c1"></span><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">FF</span> <span class="nf">addi,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">0</span><span class="nf">FF58513</span> <span class="nf">}t</span> 148 </span></span><span class="line"><span class="ln"> 3</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">FF</span> <span class="nf">andi,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">0</span><span class="nf">FF5F513</span> <span class="nf">}t</span> 149 </span></span><span class="line"><span class="ln"> 4</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">FF</span> <span class="nf">ori,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">0</span><span class="nf">FF5E513</span> <span class="nf">}t</span> 150 </span></span><span class="line"><span class="ln"> 5</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">FF</span> <span class="nf">xori,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">0</span><span class="nf">FF5C513</span> <span class="nf">}t</span> 151 </span></span><span class="line"><span class="ln"> 6</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">slli,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">F59513</span> <span class="nf">}t</span> 152 </span></span><span class="line"><span class="ln"> 7</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">srli,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">F5D513</span> <span class="nf">}t</span> 153 </span></span><span class="line"><span class="ln"> 8</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">srai,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">40</span><span class="nf">F5D513</span> <span class="nf">}t</span> 154 </span></span><span class="line"><span class="ln"> 9</span><span class="cl"><span class="nf">t{</span> <span class="nf">t0</span> <span class="k">hex </span><span class="nf">FFFF</span> <span class="nf">lui,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">0</span><span class="nf">FFFF2B7</span> <span class="nf">}t</span> 155 </span></span><span class="line"><span class="ln">10</span><span class="cl"><span class="nf">t{</span> <span class="nf">t0</span> <span class="k">hex </span><span class="nf">FFFF</span> <span class="nf">auipc,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">0</span><span class="nf">FFFF297</span> <span class="nf">}t</span> 156 </span></span><span class="line"><span class="ln">11</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">FF</span> <span class="nf">slti,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">0</span><span class="nf">FF5A513</span> <span class="nf">}t</span> 157 </span></span><span class="line"><span class="ln">12</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">FF</span> <span class="nf">sltiu,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">0</span><span class="nf">FF5B513</span> <span class="nf">}t</span> 158 </span></span><span class="line"><span class="ln">13</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="nf">a2</span> <span class="nf">add,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">C58533</span> <span class="nf">}t</span> 159 </span></span><span class="line"><span class="ln">14</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="nf">a2</span> <span class="nf">sub,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">40</span><span class="nf">C58533</span> <span class="nf">}t</span> 160 </span></span><span class="line"><span class="ln">15</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="nf">a2</span> <span class="nf">and,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">C5F533</span> <span class="nf">}t</span> 161 </span></span><span class="line"><span class="ln">16</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="nf">a2</span> <span class="nf">or,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">C5E533</span> <span class="nf">}t</span> 162 </span></span><span class="line"><span class="ln">17</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="nf">a2</span> <span class="nf">xor,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">C5C533</span> <span class="nf">}t</span> 163 </span></span><span class="line"><span class="ln">18</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="nf">a2</span> <span class="nf">sll,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">C59533</span> <span class="nf">}t</span> 164 </span></span><span class="line"><span class="ln">19</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="nf">a2</span> <span class="nf">srl,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">C5D533</span> <span class="nf">}t</span> 165 </span></span><span class="line"><span class="ln">20</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="nf">a2</span> <span class="nf">sra,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">40</span><span class="nf">C5D533</span> <span class="nf">}t</span> 166 </span></span><span class="line"><span class="ln">21</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="nf">a2</span> <span class="nf">slt,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">C5A533</span> <span class="nf">}t</span> 167 </span></span><span class="line"><span class="ln">22</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="nf">a2</span> <span class="nf">sltu,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">C5B533</span> <span class="nf">}t</span> 168 </span></span><span class="line"><span class="ln">23</span><span class="cl"><span class="nf">t{</span> <span class="nf">ra</span> <span class="k">hex </span><span class="nf">FFFF</span> <span class="nf">jal,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">7</span><span class="nf">FF0F0EF</span> <span class="nf">}t</span> 169 </span></span><span class="line"><span class="ln">24</span><span class="cl"><span class="nf">t{</span> <span class="nf">ra</span> <span class="nf">a0</span> <span class="k">hex </span> <span class="nf">FF</span> <span class="nf">jalr,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">0</span><span class="nf">FF500E7</span> <span class="nf">}t</span> 170 </span></span><span class="line"><span class="ln">25</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">beq,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">B50763</span> <span class="nf">}t</span> 171 </span></span><span class="line"><span class="ln">26</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">bne,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">B51763</span> <span class="nf">}t</span> 172 </span></span><span class="line"><span class="ln">27</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">blt,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">B54763</span> <span class="nf">}t</span> 173 </span></span><span class="line"><span class="ln">28</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">bltu,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">B56763</span> <span class="nf">}t</span> 174 </span></span><span class="line"><span class="ln">29</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">bge,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">B55763</span> <span class="nf">}t</span> 175 </span></span><span class="line"><span class="ln">30</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">bgeu,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">B57763</span> <span class="nf">}t</span> 176 </span></span><span class="line"><span class="ln">31</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">lw,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">F5A503</span> <span class="nf">}t</span> 177 </span></span><span class="line"><span class="ln">32</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">lh,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">F59503</span> <span class="nf">}t</span> 178 </span></span><span class="line"><span class="ln">33</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">lhu,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">F5D503</span> <span class="nf">}t</span> 179 </span></span><span class="line"><span class="ln">34</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">lb,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">F58503</span> <span class="nf">}t</span> 180 </span></span><span class="line"><span class="ln">35</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">sw,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">A5A7A3</span> <span class="nf">}t</span> 181 </span></span><span class="line"><span class="ln">36</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">sh,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">A597A3</span> <span class="nf">}t</span> 182 </span></span><span class="line"><span class="ln">37</span><span class="cl"><span class="nf">t{</span> <span class="nf">a0</span> <span class="nf">a1</span> <span class="k">hex </span> <span class="nf">F</span> <span class="nf">sb,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00</span><span class="nf">A587A3</span> <span class="nf">}t</span> 183 </span></span><span class="line"><span class="ln">38</span><span class="cl"><span class="nf">t{</span> <span class="k">hex </span> <span class="mi">0</span><span class="nf">FF</span> <span class="nf">fence,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">0</span><span class="nf">FF0000F</span> <span class="nf">}t</span> 184 </span></span><span class="line"><span class="ln">39</span><span class="cl"><span class="nf">t{</span> <span class="nf">ecall,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00000073</span> <span class="nf">}t</span> 185 </span></span><span class="line"><span class="ln">40</span><span class="cl"><span class="nf">t{</span> <span class="nf">ebreak,</span> <span class="nf">undo,</span> <span class="nf">-></span> <span class="k">hex </span><span class="mi">00100073</span> <span class="err">}t</span></span></span></code></pre></div>]]></content:encoded> 186 </item> 187 <item> 188 <title>The Infamous 'link' Macro</title> 189 <link>https://electrosoup.com/posts/the-infamous-link-macro/</link> 190 <pubDate>Tue, 12 Nov 2024 13:01:09 -0800</pubDate><author>christianermann@gmail.com (Christian Ermann)</author> 191 <guid>https://electrosoup.com/posts/the-infamous-link-macro/</guid> 192 <description><p>Each word (or function, in other languages) in Forth is stored as an entry in
a linked list known as the dictionary. When bootstrapping a Forth from
assembly, it is your responsibility to create and maintain this linked list
structure. This is a tedious process and is the source of many errors when
re-arranging words or defining new words; it&rsquo;s incredibly easy to turn your
list into a graph by mistake.</p></description> 193 <content:encoded><![CDATA[<p>Each word (or function, in other languages) in Forth is stored as an entry in 194 a linked list known as the dictionary. When bootstrapping a Forth from 195 assembly, it is your responsibility to create and maintain this linked list 196 structure. This is a tedious process and is the source of many errors when 197 re-arranging words or defining new words; it’s incredibly easy to turn your 198 list into a graph by mistake.</p> 199 <p>In 200 <a href="https://rwmj.wordpress.com/2010/08/07/jonesforth-git-repository/">jonesforth</a>, 201 an x86 implementation of Forth, the assembler supports re-assigning new values 202 to assembler variables. This means an assember variable can be used to store 203 the memory address of the previous entry, and we have the ability to update it 204 or use it whenever we need to. I used this exact strategy in my 205 <a href="https://git.christianermann.dev/forth/log.html">incomplete x86 Forth</a> although 206 I used <a href="https://flatassembler.net/">FASM</a> instead of 207 <a href="https://wiki.osdev.org/GAS">GAS</a>. Unfortunately, GAS doesn’t support this 208 feature for ARM or RISC-V targets. It may be possible to pull this off on ARM 209 with the right set of relocation and/or relaxation parameters, but I was unable 210 to find success with RISC-V.</p> 211 <p>I did come up with an alternative set of macros that achieves the same goal 212 and should be more portable than the <code>jonesforth</code> solution:</p> 213 214 215 216 217 218 <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-GAS" data-lang="GAS"><span class="line"><span class="ln"> 1</span><span class="cl"><span class="na">.macro</span> <span class="no">this_link</span> 219 </span></span><span class="line"><span class="ln"> 2</span><span class="cl"> <span class="na">.globl</span> <span class="no">link_</span><span class="err">\+</span> 220 </span></span><span class="line"><span class="ln"> 3</span><span class="cl"><span class="nf">link_</span><span class="err">\+</span><span class="p">:</span> 221 </span></span><span class="line"><span class="ln"> 4</span><span class="cl"><span class="na">.endm</span> 222 </span></span><span class="line"><span class="ln"> 5</span><span class="cl"> 223 </span></span><span class="line"><span class="ln"> 6</span><span class="cl"><span class="na">.macro</span> <span class="no">prev_link</span> 224 </span></span><span class="line"><span class="ln"> 7</span><span class="cl"> <span class="na">.int</span> <span class="no">link_</span><span class="err">\+</span> 225 </span></span><span class="line"><span class="ln"> 8</span><span class="cl"><span class="na">.endm</span> 226 </span></span><span class="line"><span class="ln"> 9</span><span class="cl"> 227 </span></span><span class="line"><span class="ln">10</span><span class="cl"><span class="na">.macro</span> <span class="no">link</span> 228 </span></span><span class="line"><span class="ln">11</span><span class="cl"> <span class="nf">this_link</span> 229 </span></span><span class="line"><span class="ln">12</span><span class="cl"> <span class="nf">prev_link</span> 230 </span></span><span class="line"><span class="ln">13</span><span class="cl"><span class="na">.endm</span> 231 </span></span><span class="line"><span class="ln">14</span><span class="cl"> 232 </span></span><span class="line"><span class="ln">15</span><span class="cl"><span class="nf">this_link</span></span></span></code></pre></div><p>These macros depend on the special value 233 234 235 236 237 <code class="code-inline language-GAS"><span class="err">\+</span></code>. 238 This value is replaced by the invocation count of the current macro during 239 assembly. Since we want to 240 241 242 243 244 <code class="code-inline language-GAS"><span class="nf">link</span></code> 245 back to the previous word in the dictionary, we need 246 247 248 249 250 <code class="code-inline language-GAS"><span class="nf">prev_link</span></code> 251 to resolve to 1 word before 252 253 254 255 256 <code class="code-inline language-GAS"><span class="nf">this_link</span></code>, 257 which is why we call 258 259 260 261 262 <code class="code-inline language-GAS"><span class="nf">this_link</span></code> 263 once before defining any words.</p> 264 <p>You’ll also need to add this to your linker script to null-terminate your 265 dictionary, otherwise the start of your dictionary will be marked by the 266 address where the 267 268 269 270 271 <code class="code-inline language-GAS"><span class="nf">link_0</span></code> 272 label created by 273 274 275 276 277 <code class="code-inline language-GAS"><span class="nf">this_link</span></code> was stored:</p> 278 279 280 281 282 283 <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-GAS" data-lang="GAS"><span class="line"><span class="ln">1</span><span class="cl"><span class="nf">link_0</span> <span class="err">=</span> <span class="mi">0</span><span class="err">;</span></span></span></code></pre></div>]]></content:encoded> 284 </item> 285 <item> 286 <title>Writing a G-code Interpreter</title> 287 <link>https://electrosoup.com/posts/gcode-interpreter/</link> 288 <pubDate>Wed, 23 Oct 2024 16:29:40 -0700</pubDate><author>christianermann@gmail.com (Christian Ermann)</author> 289 <guid>https://electrosoup.com/posts/gcode-interpreter/</guid> 290 <description><p>I&rsquo;m currently working on a control system for a laser galvanometer (galvo) that
I want to use in a stereolithography (SLA) resin printer. I don&rsquo;t want to write
a custom slicer, as I feel like model slicing can be incredibly complicated and
existing free software (Cura, Slic3r, etc.) has many advanced features I don&rsquo;t
want to reimplement. However, this means my control system needs to understand
G-code, the language that these slicers output.</p></description> 291 <content:encoded><![CDATA[<p>I’m currently working on a control system for a laser galvanometer (galvo) that 292 I want to use in a stereolithography (SLA) resin printer. I don’t want to write 293 a custom slicer, as I feel like model slicing can be incredibly complicated and 294 existing free software (Cura, Slic3r, etc.) has many advanced features I don’t 295 want to reimplement. However, this means my control system needs to understand 296 G-code, the language that these slicers output.</p> 297 <p>As stated on the <a href="https://reprap.org/wiki/G-code">reprap wiki</a>, “G-code is a 298 list of fields that are separated by white spaces or line breaks. A field can 299 be interpreted as a command, parameter, or for any other special purpose.” For 300 now, we’ll ignore any special purposes. Here is an example of G-code that 301 describes a movement of the tool/hotend/laser to a specific location:</p> 302 303 304 305 306 307 <pre tabindex="0"><code class="language-gcode" data-lang="gcode"> G1 X10.4 Y7.4 Z8.3</code></pre><p>I was able to parse commands with parameters using a two-stage procedure:</p> 308 <pre><code>1. Retrieve the next white-space delimited token. 309 2. Accumulate tokens until two separate command tokens are found. 310 </code></pre> 311 <p>This second step is important because we can’t begin executing a command until 312 we’ve found all of its parameters and we don’t know if we’ve found all of its 313 parameters until we find the next command.</p> 314 <p>Once a command and all of its parameters have been parsed, it is passed to the 315 controller which updates the state of the machine. For each command that the 316 controller receives, it has to update its internal state, and in the case of 317 physical movement commands, send the proper signal to the laser galvo. Most 318 physical movement commands utilize interpolation so a timed control loop is 319 utilized to ensure the laser follows as close to the intended path as possible.</p> 320 <h2 id="system-diagram">System Diagram</h2> 321 322 323 324 <div class="goat svg-container "> 325 326 <svg 327 xmlns="http://www.w3.org/2000/svg" 328 font-family="Menlo,Lucida Console,monospace" 329 330 viewBox="0 0 384 249" 331 > 332 <g transform='translate(8,16)'> 333 <path d='M 80,16 L 296,16' fill='none' stroke='currentColor'></path> 334 <path d='M 16,64 L 112,64' fill='none' stroke='currentColor'></path> 335 <path d='M 256,64 L 368,64' fill='none' stroke='currentColor'></path> 336 <path d='M 128,80 L 240,80' fill='none' stroke='currentColor'></path> 337 <path d='M 16,96 L 112,96' fill='none' stroke='currentColor'></path> 338 <path d='M 256,96 L 368,96' fill='none' stroke='currentColor'></path> 339 <path d='M 80,144 L 296,144' fill='none' stroke='currentColor'></path> 340 <path d='M 0,192 L 120,192' fill='none' stroke='currentColor'></path> 341 <path d='M 256,192 L 368,192' fill='none' stroke='currentColor'></path> 342 <path d='M 136,208 L 240,208' fill='none' stroke='currentColor'></path> 343 <path d='M 0,224 L 120,224' fill='none' stroke='currentColor'></path> 344 <path d='M 256,224 L 368,224' fill='none' stroke='currentColor'></path> 345 <path d='M 0,192 L 0,224' fill='none' stroke='currentColor'></path> 346 <path d='M 16,64 L 16,96' fill='none' stroke='currentColor'></path> 347 <path d='M 64,32 L 64,48' fill='none' stroke='currentColor'></path> 348 <path d='M 64,160 L 64,176' fill='none' stroke='currentColor'></path> 349 <path d='M 112,64 L 112,96' fill='none' stroke='currentColor'></path> 350 <path d='M 120,192 L 120,224' fill='none' stroke='currentColor'></path> 351 <path d='M 256,64 L 256,96' fill='none' stroke='currentColor'></path> 352 <path d='M 256,192 L 256,224' fill='none' stroke='currentColor'></path> 353 <path d='M 312,32 L 312,48' fill='none' stroke='currentColor'></path> 354 <path d='M 312,112 L 312,128' fill='none' stroke='currentColor'></path> 355 <path d='M 368,64 L 368,96' fill='none' stroke='currentColor'></path> 356 <path d='M 368,192 L 368,224' fill='none' stroke='currentColor'></path> 357 <path d='M 312,48 L 312,56' fill='none' stroke='currentColor'></path> 358 <path d='M 312,104 L 312,112' fill='none' stroke='currentColor'></path> 359 <path d='M 64,48 L 64,56' fill='none' stroke='currentColor'></path> 360 <polygon points='80.000000,48.000000 68.000000,42.400002 68.000000,53.599998' fill='currentColor' transform='rotate(90.000000, 64.000000, 48.000000)'></polygon> 361 <path d='M 64,176 L 64,184' fill='none' stroke='currentColor'></path> 362 <polygon points='80.000000,176.000000 68.000000,170.399994 68.000000,181.600006' fill='currentColor' transform='rotate(90.000000, 64.000000, 176.000000)'></polygon> 363 <polygon points='248.000000,80.000000 236.000000,74.400002 236.000000,85.599998' fill='currentColor' transform='rotate(0.000000, 240.000000, 80.000000)'></polygon> 364 <polygon points='248.000000,208.000000 236.000000,202.399994 236.000000,213.600006' fill='currentColor' transform='rotate(0.000000, 240.000000, 208.000000)'></polygon> 365 <path d='M 80,16 A 16,16 0 0,0 64,32' fill='none' stroke='currentColor'></path> 366 <path d='M 296,16 A 16,16 0 0,1 312,32' fill='none' stroke='currentColor'></path> 367 <path d='M 80,144 A 16,16 0 0,0 64,160' fill='none' stroke='currentColor'></path> 368 <path d='M 312,128 A 16,16 0 0,1 296,144' fill='none' stroke='currentColor'></path> 369 <text text-anchor='middle' x='24' y='212' fill='currentColor' style='font-size:1em'>c</text> 370 <text text-anchor='middle' x='32' y='84' fill='currentColor' style='font-size:1em'>t</text> 371 <text text-anchor='middle' x='32' y='212' fill='currentColor' style='font-size:1em'>o</text> 372 <text text-anchor='middle' x='40' y='84' fill='currentColor' style='font-size:1em'>o</text> 373 <text text-anchor='middle' x='40' y='212' fill='currentColor' style='font-size:1em'>n</text> 374 <text text-anchor='middle' x='48' y='84' fill='currentColor' style='font-size:1em'>k</text> 375 <text text-anchor='middle' x='48' y='212' fill='currentColor' style='font-size:1em'>t</text> 376 <text text-anchor='middle' x='56' y='84' fill='currentColor' style='font-size:1em'>e</text> 377 <text text-anchor='middle' x='56' y='212' fill='currentColor' style='font-size:1em'>r</text> 378 <text text-anchor='middle' x='64' y='84' fill='currentColor' style='font-size:1em'>n</text> 379 <text text-anchor='middle' x='64' y='212' fill='currentColor' style='font-size:1em'>o</text> 380 <text text-anchor='middle' x='72' y='84' fill='currentColor' style='font-size:1em'>i</text> 381 <text text-anchor='middle' x='72' y='212' fill='currentColor' style='font-size:1em'>l</text> 382 <text text-anchor='middle' x='80' y='84' fill='currentColor' style='font-size:1em'>z</text> 383 <text text-anchor='middle' x='80' y='212' fill='currentColor' style='font-size:1em'>l</text> 384 <text text-anchor='middle' x='88' y='84' fill='currentColor' style='font-size:1em'>e</text> 385 <text text-anchor='middle' x='88' y='212' fill='currentColor' style='font-size:1em'>e</text> 386 <text text-anchor='middle' x='96' y='84' fill='currentColor' style='font-size:1em'>r</text> 387 <text text-anchor='middle' x='96' y='212' fill='currentColor' style='font-size:1em'>r</text> 388 <text text-anchor='middle' x='128' y='132' fill='currentColor' style='font-size:1em'>c</text> 389 <text text-anchor='middle' x='136' y='132' fill='currentColor' style='font-size:1em'>o</text> 390 <text text-anchor='middle' x='144' y='4' fill='currentColor' style='font-size:1em'>m</text> 391 <text text-anchor='middle' x='144' y='132' fill='currentColor' style='font-size:1em'>m</text> 392 <text text-anchor='middle' x='144' y='196' fill='currentColor' style='font-size:1em'>c</text> 393 <text text-anchor='middle' x='152' y='4' fill='currentColor' style='font-size:1em'>o</text> 394 <text text-anchor='middle' x='152' y='132' fill='currentColor' style='font-size:1em'>m</text> 395 <text text-anchor='middle' x='152' y='196' fill='currentColor' style='font-size:1em'>t</text> 396 <text text-anchor='middle' x='160' y='4' fill='currentColor' style='font-size:1em'>r</text> 397 <text text-anchor='middle' x='160' y='132' fill='currentColor' style='font-size:1em'>a</text> 398 <text text-anchor='middle' x='160' y='196' fill='currentColor' style='font-size:1em'>r</text> 399 <text text-anchor='middle' x='168' y='4' fill='currentColor' style='font-size:1em'>e</text> 400 <text text-anchor='middle' x='168' y='68' fill='currentColor' style='font-size:1em'>t</text> 401 <text text-anchor='middle' x='168' y='132' fill='currentColor' style='font-size:1em'>n</text> 402 <text text-anchor='middle' x='168' y='196' fill='currentColor' style='font-size:1em'>l</text> 403 <text text-anchor='middle' x='176' y='68' fill='currentColor' style='font-size:1em'>o</text> 404 <text text-anchor='middle' x='176' y='132' fill='currentColor' style='font-size:1em'>d</text> 405 <text text-anchor='middle' x='184' y='4' fill='currentColor' style='font-size:1em'>p</text> 406 <text text-anchor='middle' x='184' y='68' fill='currentColor' style='font-size:1em'>k</text> 407 <text text-anchor='middle' x='184' y='196' fill='currentColor' style='font-size:1em'>s</text> 408 <text text-anchor='middle' x='192' y='4' fill='currentColor' style='font-size:1em'>a</text> 409 <text text-anchor='middle' x='192' y='68' fill='currentColor' style='font-size:1em'>e</text> 410 <text text-anchor='middle' x='192' y='132' fill='currentColor' style='font-size:1em'>w</text> 411 <text text-anchor='middle' x='192' y='196' fill='currentColor' style='font-size:1em'>i</text> 412 <text text-anchor='middle' x='200' y='4' fill='currentColor' style='font-size:1em'>r</text> 413 <text text-anchor='middle' x='200' y='68' fill='currentColor' style='font-size:1em'>n</text> 414 <text text-anchor='middle' x='200' y='132' fill='currentColor' style='font-size:1em'>/</text> 415 <text text-anchor='middle' x='200' y='196' fill='currentColor' style='font-size:1em'>g</text> 416 <text text-anchor='middle' x='208' y='4' fill='currentColor' style='font-size:1em'>a</text> 417 <text text-anchor='middle' x='208' y='196' fill='currentColor' style='font-size:1em'>n</text> 418 <text text-anchor='middle' x='216' y='4' fill='currentColor' style='font-size:1em'>m</text> 419 <text text-anchor='middle' x='216' y='132' fill='currentColor' style='font-size:1em'>p</text> 420 <text text-anchor='middle' x='216' y='196' fill='currentColor' style='font-size:1em'>a</text> 421 <text text-anchor='middle' x='224' y='4' fill='currentColor' style='font-size:1em'>s</text> 422 <text text-anchor='middle' x='224' y='132' fill='currentColor' style='font-size:1em'>a</text> 423 <text text-anchor='middle' x='224' y='196' fill='currentColor' style='font-size:1em'>l</text> 424 <text text-anchor='middle' x='232' y='4' fill='currentColor' style='font-size:1em'>?</text> 425 <text text-anchor='middle' x='232' y='132' fill='currentColor' style='font-size:1em'>r</text> 426 <text text-anchor='middle' x='240' y='132' fill='currentColor' style='font-size:1em'>a</text> 427 <text text-anchor='middle' x='248' y='132' fill='currentColor' style='font-size:1em'>m</text> 428 <text text-anchor='middle' x='256' y='132' fill='currentColor' style='font-size:1em'>s</text> 429 <text text-anchor='middle' x='272' y='84' fill='currentColor' style='font-size:1em'>a</text> 430 <text text-anchor='middle' x='272' y='212' fill='currentColor' style='font-size:1em'>l</text> 431 <text text-anchor='middle' x='280' y='84' fill='currentColor' style='font-size:1em'>c</text> 432 <text text-anchor='middle' x='280' y='212' fill='currentColor' style='font-size:1em'>a</text> 433 <text text-anchor='middle' x='288' y='84' fill='currentColor' style='font-size:1em'>c</text> 434 <text text-anchor='middle' x='288' y='212' fill='currentColor' style='font-size:1em'>s</text> 435 <text text-anchor='middle' x='296' y='84' fill='currentColor' style='font-size:1em'>u</text> 436 <text text-anchor='middle' x='296' y='212' fill='currentColor' style='font-size:1em'>e</text> 437 <text text-anchor='middle' x='304' y='84' fill='currentColor' style='font-size:1em'>m</text> 438 <text text-anchor='middle' x='304' y='212' fill='currentColor' style='font-size:1em'>r</text> 439 <text text-anchor='middle' x='312' y='84' fill='currentColor' style='font-size:1em'>u</text> 440 <text text-anchor='middle' x='320' y='84' fill='currentColor' style='font-size:1em'>l</text> 441 <text text-anchor='middle' x='320' y='212' fill='currentColor' style='font-size:1em'>g</text> 442 <text text-anchor='middle' x='328' y='84' fill='currentColor' style='font-size:1em'>a</text> 443 <text text-anchor='middle' x='328' y='212' fill='currentColor' style='font-size:1em'>a</text> 444 <text text-anchor='middle' x='336' y='84' fill='currentColor' style='font-size:1em'>t</text> 445 <text text-anchor='middle' x='336' y='212' fill='currentColor' style='font-size:1em'>l</text> 446 <text text-anchor='middle' x='344' y='84' fill='currentColor' style='font-size:1em'>o</text> 447 <text text-anchor='middle' x='344' y='212' fill='currentColor' style='font-size:1em'>v</text> 448 <text text-anchor='middle' x='352' y='84' fill='currentColor' style='font-size:1em'>r</text> 449 <text text-anchor='middle' x='352' y='212' fill='currentColor' style='font-size:1em'>o</text> 450 </g> 451 452 </svg> 453 454 </div> 455 <h2 id="source-code">Source Code</h2> 456 <p>The source code for the G-code interpreter can be found 457 <a href="https://git.christianermann.dev/gcode-interpreter">here</a>. You may have issues 458 accessing the link if your ISP doesn’t support IPv6 yet.</p> 459 <p>Also, the names in the code are different than what’s shown in the diagram, so 460 here’s the mapping to help out with understanding the code:</p> 461 <table> 462 <thead> 463 <tr> 464 <th style="text-align: left">Diagram</th> 465 <th style="text-align: left">Source File</th> 466 </tr> 467 </thead> 468 <tbody> 469 <tr> 470 <td style="text-align: left">tokenizer</td> 471 <td style="text-align: left">token.c</td> 472 </tr> 473 <tr> 474 <td style="text-align: left">accumulator</td> 475 <td style="text-align: left">command.c</td> 476 </tr> 477 <tr> 478 <td style="text-align: left">controller</td> 479 <td style="text-align: left">machine.c</td> 480 </tr> 481 </tbody> 482 </table> 483 <p>I’ll try to keep this updated if the mapping changes as I continue to work on 484 this project.</p> 485 ]]></content:encoded> 486 </item> 487 <item> 488 <title>Understanding Camera Look-At.</title> 489 <link>https://electrosoup.com/posts/look-at/</link> 490 <pubDate>Mon, 10 Oct 2022 00:31:00 -0400</pubDate><author>christianermann@gmail.com (Christian Ermann)</author> 491 <guid>https://electrosoup.com/posts/look-at/</guid> 492 <description><p>Often times, we want to position the camera in our scene at a particular point,
such as the head of the character in a first-person shooter or the cockpit of a
plane in a flight simulator. We also want the camera to look in the direction
that the player is trying to move.</p></description> 493 <content:encoded><![CDATA[<p>Often times, we want to position the camera in our scene at a particular point, 494 such as the head of the character in a first-person shooter or the cockpit of a 495 plane in a flight simulator. We also want the camera to look in the direction 496 that the player is trying to move.</p> 497 <p>To do this, we need to find the forward, right, and up vectors that correspond 498 to the desired view.</p> 499 <p>If we let $\vec{p}$ be the camera’s position and $\vec{t}$ be the position of 500 what we want to look at, the camera’s look direction is 501 $$\vec{l}=\vec{t}-\vec{p}\,.$$ 502 Conventionally, the camera looks down the negative forward axis so 503 $$\vec{f}=-\vec{l}\,.$$</p> 504 <p>In order to determine the right vector, we need a reference up direction, 505 $\vec{up}$ (which isn’t necessarily orthogonal to $\vec{f}$). This enables us 506 to calculate 507 $$\vec{r} = \vec{f} \times \vec{up}$$ 508 and 509 $$\vec{u} = \vec{r} \times \vec{f}\,.$$</p> 510 <p>Now we can use the camera position $\vec{p}$ and normalized forms of $\vec{f}$, 511 $\vec{r}$, and $\vec{u}$ to fill in our 512 <a href="/posts/view-matrix/">view matrix</a>:</p> 513 <p>$$ 514 V 515 = 516 \begin{bmatrix} 517 r_{x} & r_{y} & r_{z} & -(\vec{r} \cdot \vec{p}) \\ 518 u_{x} & u_{y} & u_{z} & -(\vec{u} \cdot \vec{p}) \\ 519 f_{x} & f_{y} & f_{z} & -(\vec{f} \cdot \vec{p}) \\ 520 0 & 0 & 0 & 1 521 \end{bmatrix} 522 $$</p> 523 ]]></content:encoded> 524 </item> 525 <item> 526 <title>Deriving the View Matrix</title> 527 <link>https://electrosoup.com/posts/view-matrix/</link> 528 <pubDate>Sun, 21 Nov 2021 13:34:08 -0800</pubDate><author>christianermann@gmail.com (Christian Ermann)</author> 529 <guid>https://electrosoup.com/posts/view-matrix/</guid> 530 <description><p>In computer graphics, the view matrix is used to transform points from
world space into camera space. Below is an explanation of how to derive this
matrix.</p></description> 531 <content:encoded><![CDATA[<p>In computer graphics, the view matrix is used to transform points from 532 world space into camera space. Below is an explanation of how to derive this 533 matrix.</p> 534 <p>Let $V$ be the view matrix. 535 If $\vec{r}$, $\vec{u}$, and $\vec{f}$ denote the right, up, and forward 536 vectors of the camera and $\vec{p}$ is the camera’s position, $V$ should 537 satisfy the following properties: 538 $$ 539 \begin{matrix} 540 V_{1*} \times 541 \begin{bmatrix} 542 r_{x} \\ 543 r_{y} \\ 544 r_{z} \\ 545 0 546 \end{bmatrix} 547 = 548 \begin{bmatrix} 549 1 \\ 550 0 \\ 551 0 \\ 552 0 553 \end{bmatrix},& 554 V_{2*} \times 555 \begin{bmatrix} 556 u_{x} \\ 557 u_{y} \\ 558 u_{z} \\ 559 0 560 \end{bmatrix} 561 = 562 \begin{bmatrix} 563 0 \\ 564 1 \\ 565 0 \\ 566 0 567 \end{bmatrix},& 568 V_{3*} \times 569 \begin{bmatrix} 570 f_{x} \\ 571 f_{y} \\ 572 f_{z} \\ 573 0 574 \end{bmatrix} 575 = 576 \begin{bmatrix} 577 0 \\ 578 0 \\ 579 1 \\ 580 0 581 \end{bmatrix},& 582 V_{4*} \times 583 \begin{bmatrix} 584 p_{x} \\ 585 p_{y} \\ 586 p_{z} \\ 587 1 588 \end{bmatrix} 589 = 590 \begin{bmatrix} 591 0 \\ 592 0 \\ 593 0 \\ 594 1 595 \end{bmatrix} 596 \end{matrix} 597 $$ 598 In words, the view matrix should translate the camera to the origin and rotate 599 it to align with the $\vec{x}$, $\vec{y}$, and $\vec{z}$ axes.</p> 600 <p>This can be expressed more concisely as the product of two matrices: 601 $$ 602 V \times 603 \begin{bmatrix} 604 r_{x} & u_{x} & f_{x} & p_{x} \\ 605 r_{y} & u_{y} & f_{y} & p_{y} \\ 606 r_{z} & u_{z} & f_{z} & p_{z} \\ 607 0 & 0 & 0 & 1 608 \end{bmatrix} 609 = 610 \begin{bmatrix} 611 1 & 0 & 0 & 0 \\ 612 0 & 1 & 0 & 0 \\ 613 0 & 0 & 1 & 0 \\ 614 0 & 0 & 0 & 1 615 \end{bmatrix} 616 $$</p> 617 <p>To make this equation easier to solve, we can split the matrix containing our 618 camera parameters into the product of a translation matrix $T$ and a rotation 619 matrix $R$: 620 $$ 621 V \times (T \times R) = I 622 $$ 623 where 624 $$ 625 \begin{matrix} 626 T = 627 \begin{bmatrix} 628 1 & 0 & 0 & p_{x} \\ 629 0 & 1 & 0 & p_{y} \\ 630 0 & 0 & 1 & p_{z} \\ 631 0 & 0 & 0 & 1 632 \end{bmatrix},& 633 R = 634 \begin{bmatrix} 635 r_{x} & u_{x} & f_{x} & 0 \\ 636 r_{y} & u_{y} & f_{y} & 0 \\ 637 r_{z} & u_{z} & f_{z} & 0 \\ 638 0 & 0 & 0 & 1 639 \end{bmatrix} 640 \end{matrix} 641 $$</p> 642 <p>Solving for $V$ reveals that $V=R^{-1} \times T^{-1}$: 643 $$ 644 V = 645 \begin{bmatrix} 646 r_{x} & r_{y} & r_{z} & 0 \\ 647 u_{x} & u_{y} & u_{z} & 0 \\ 648 f_{x} & f_{y} & f_{z} & 0 \\ 649 0 & 0 & 0 & 1 650 \end{bmatrix} 651 \times 652 \begin{bmatrix} 653 1 & 0 & 0 & -p_{x} \\ 654 0 & 1 & 0 & -p_{y} \\ 655 0 & 0 & 1 & -p_{z} \\ 656 0 & 0 & 0 & 1 657 \end{bmatrix} 658 $$</p> 659 <p>And with some minor simplification, 660 $$ 661 V 662 = 663 \begin{bmatrix} 664 r_{x} & r_{y} & r_{z} & -(\vec{r} \cdot \vec{p}) \\ 665 u_{x} & u_{y} & u_{z} & -(\vec{u} \cdot \vec{p}) \\ 666 f_{x} & f_{y} & f_{z} & -(\vec{f} \cdot \vec{p}) \\ 667 0 & 0 & 0 & 1 668 \end{bmatrix} 669 $$</p> 670 <p>When we’re ready to render our scene, we can apply $V$ to each vertex $\vec{q}$ 671 by calculating 672 $$ 673 V \times \vec{q} 674 $$ 675 in our vertex shader.</p> 676 ]]></content:encoded> 677 </item> 678 <item> 679 <title>Unbind Your Vertex Array Objects.</title> 680 <link>https://electrosoup.com/posts/unbind/</link> 681 <pubDate>Wed, 25 Aug 2021 14:33:02 -0500</pubDate><author>christianermann@gmail.com (Christian Ermann)</author> 682 <guid>https://electrosoup.com/posts/unbind/</guid> 683 <description><p>When I first started learning about OpenGL, I always made sure to unbind each resource as soon as I was done using it. Over time I became more lenient with unbinding, as in many cases leaving resources bound is okay and leads to fewer API calls.</p></description> 684 <content:encoded><![CDATA[<p>When I first started learning about OpenGL, I always made sure to unbind each resource as soon as I was done using it. Over time I became more lenient with unbinding, as in many cases leaving resources bound is okay and leads to fewer API calls.</p> 685 <p>In addition, when I’m developing on my PC I have access to the newer Direct State Access (DSA) functions, so binding resources isn’t something I have to worry about as much. However, I do a fair amount of programming on my macbook which means I don’t always have access to the DSA functions.</p> 686 <p>I was working on a project recently that involved the vertex and index data for a mesh frequently changing. The actual mesh struct has a bit more going on, but we can think of it like this for now:</p> 687 688 689 690 691 <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-c" data-lang="c"><span class="line"><span class="ln">1</span><span class="cl"><span class="k">typedef</span> <span class="k">struct</span> <span class="p">{</span> 692 </span></span><span class="line"><span class="ln">2</span><span class="cl"> <span class="n">Vec3</span> <span class="o">*</span><span class="n">vertices</span><span class="p">;</span> 693 </span></span><span class="line"><span class="ln">3</span><span class="cl"> <span class="n">GLuint</span> <span class="o">*</span><span class="n">indices</span><span class="p">;</span> 694 </span></span><span class="line"><span class="ln">4</span><span class="cl"> <span class="n">GLuint</span> <span class="n">vao</span><span class="p">;</span> 695 </span></span><span class="line"><span class="ln">5</span><span class="cl"> <span class="n">GLuint</span> <span class="n">vbo</span><span class="p">;</span> 696 </span></span><span class="line"><span class="ln">6</span><span class="cl"> <span class="n">GLuint</span> <span class="n">ebo</span><span class="p">;</span> 697 </span></span><span class="line"><span class="ln">7</span><span class="cl"><span class="p">}</span> <span class="n">Mesh</span><span class="p">;</span></span></span></code></pre></div> 698 <p>So when it comes time to update the vertex or index data, we map the vertex buffer object to the vertices pointer and the element buffer object to the indices pointer. Then we can write all of our vertex and index data directly to the buffers, and then unmap them when we’re all done and need to draw.</p> 699 700 701 702 703 <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-c" data-lang="c"><span class="line"><span class="ln"> 1</span><span class="cl"><span class="p">...</span> 704 </span></span><span class="line"><span class="ln"> 2</span><span class="cl"> 705 </span></span><span class="line"><span class="ln"> 3</span><span class="cl"><span class="nf">glBindBuffer</span><span class="p">(</span><span class="n">GL_ARRAY_BUFFER</span><span class="p">,</span> <span class="n">mesh</span><span class="o">-></span><span class="n">vbo</span><span class="p">);</span> 706 </span></span><span class="line"><span class="ln"> 4</span><span class="cl"><span class="n">mesh</span><span class="o">-></span><span class="n">vertices</span> <span class="o">=</span> <span class="nf">glMapBuffer</span><span class="p">(</span><span class="n">GL_ARRAY_BUFFER</span><span class="p">,</span> <span class="n">GL_WRITE_ONLY</span><span class="p">);</span> 707 </span></span><span class="line"><span class="ln"> 5</span><span class="cl"> 708 </span></span><span class="line"><span class="ln"> 6</span><span class="cl"><span class="nf">glBindBuffer</span><span class="p">(</span><span class="n">GL_ELEMENT_ARRAY_BUFFER</span><span class="p">,</span> <span class="n">mesh</span><span class="o">-></span><span class="n">ebo</span><span class="p">);</span> 709 </span></span><span class="line"><span class="ln"> 7</span><span class="cl"><span class="n">mesh</span><span class="o">-></span><span class="n">indices</span> <span class="o">=</span> <span class="nf">glMapBuffer</span><span class="p">(</span><span class="n">GL_ELEMENT_ARRAY_BUFFER</span><span class="p">,</span> <span class="n">GL_WRITE_ONLY</span><span class="p">);</span> 710 </span></span><span class="line"><span class="ln"> 8</span><span class="cl"> 711 </span></span><span class="line"><span class="ln"> 9</span><span class="cl"><span class="c1">// While we have the buffers mapped, we can write data directly to 712 </span></span></span><span class="line"><span class="ln">10</span><span class="cl"><span class="c1">// mesh->vertices and mesh->indices. 713 </span></span></span><span class="line"><span class="ln">11</span><span class="cl"><span class="c1"></span> 714 </span></span><span class="line"><span class="ln">12</span><span class="cl"><span class="nf">glBindBuffer</span><span class="p">(</span><span class="n">GL_ARRAY_BUFFER</span><span class="p">,</span> <span class="n">mesh</span><span class="o">-></span><span class="n">vbo</span><span class="p">);</span> 715 </span></span><span class="line"><span class="ln">13</span><span class="cl"><span class="nf">glUnmapBuffer</span><span class="p">(</span><span class="n">GL_ARRAY_BUFFER</span><span class="p">);</span> 716 </span></span><span class="line"><span class="ln">14</span><span class="cl"><span class="n">mesh</span><span class="o">-></span><span class="n">vertices</span> <span class="o">=</span> <span class="nb">NULL</span> 717 </span></span><span class="line"><span class="ln">15</span><span class="cl"> 718 </span></span><span class="line"><span class="ln">16</span><span class="cl"><span class="nf">glBindBuffer</span><span class="p">(</span><span class="n">GL_ELEMENT_ARRAY_BUFFER</span><span class="p">,</span> <span class="n">mesh</span><span class="o">-></span><span class="n">ebo</span><span class="p">);</span> 719 </span></span><span class="line"><span class="ln">17</span><span class="cl"><span class="nf">glUnmapBuffer</span><span class="p">(</span><span class="n">GL_ELEMENT_ARRAY_BUFFER</span><span class="p">);</span> 720 </span></span><span class="line"><span class="ln">18</span><span class="cl"><span class="n">mesh</span><span class="o">-></span><span class="n">indices</span> <span class="o">=</span> <span class="nb">NULL</span> 721 </span></span><span class="line"><span class="ln">19</span><span class="cl"> 722 </span></span><span class="line"><span class="ln">20</span><span class="cl"><span class="c1">// Now that the buffers are unmapped, we can draw the mesh again. 723 </span></span></span><span class="line"><span class="ln">21</span><span class="cl"><span class="c1"></span> 724 </span></span><span class="line"><span class="ln">22</span><span class="cl"><span class="p">...</span></span></span></code></pre></div> 725 <p>Leaving the buffers bound in the above snippet didn’t cause problems and seemed a reasonable thing to do to reduce unnecessary OpenGL calls. 726 The issues I was running into were actually caused by how I was drawing each mesh:</p> 727 728 729 730 731 <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-c" data-lang="c"><span class="line"><span class="ln">1</span><span class="cl"><span class="p">...</span> 732 </span></span><span class="line"><span class="ln">2</span><span class="cl"> 733 </span></span><span class="line"><span class="ln">3</span><span class="cl"><span class="nf">glBindVertexArray</span><span class="p">(</span><span class="n">mesh</span><span class="o">-></span><span class="n">vao</span><span class="p">);</span> 734 </span></span><span class="line"><span class="ln">4</span><span class="cl"><span class="nf">glDrawElements</span><span class="p">(...);</span> 735 </span></span><span class="line"><span class="ln">5</span><span class="cl"> 736 </span></span><span class="line"><span class="ln">6</span><span class="cl"><span class="p">...</span></span></span></code></pre></div> 737 <p>Since I wasn’t unbinding the mesh’s vertex array object when I finished drawing it, when I updated another mesh’s vertex or index data and bound that mesh’s buffer objects, the vertex array object I forgot to unbind would now be using the incorrect buffers to draw with.</p> 738 <p>Luckily, there was a simple fix, and now I know to be more careful with unbinding vertex array objects:</p> 739 740 741 742 743 <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-c" data-lang="c"><span class="line"><span class="ln">1</span><span class="cl"><span class="p">...</span> 744 </span></span><span class="line"><span class="ln">2</span><span class="cl"> 745 </span></span><span class="line"><span class="ln">3</span><span class="cl"><span class="nf">glBindVertexArray</span><span class="p">(</span><span class="n">mesh</span><span class="o">-></span><span class="n">vao</span><span class="p">);</span> 746 </span></span><span class="line"><span class="ln">4</span><span class="cl"><span class="nf">glDrawElements</span><span class="p">(...);</span> 747 </span></span><span class="line"><span class="ln">5</span><span class="cl"><span class="nf">glBindVertexArray</span><span class="p">(</span><span class="mi">0</span><span class="p">);</span> 748 </span></span><span class="line"><span class="ln">6</span><span class="cl"> 749 </span></span><span class="line"><span class="ln">7</span><span class="cl"><span class="p">...</span></span></span></code></pre></div> 750 ]]></content:encoded> 751 </item> 752 </channel> 753 </rss>