Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add human-readable instruction name annotations #520

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Commits on Aug 12, 2024

  1. Add names for some base instructions

    jriyyya authored and ThinkOpenly committed Aug 12, 2024
    Configuration menu
    Copy the full SHA
    1da5e7c View commit details
    Browse the repository at this point in the history

Commits on Aug 26, 2024

  1. Configuration menu
    Copy the full SHA
    0b5ab31 View commit details
    Browse the repository at this point in the history

Commits on Sep 9, 2024

  1. Add names for mnemonic suffixes

    Some instruction groups combinatorically construct mnemonics with various
    suffixes:
    ```
    mapping clause assembly = LOAD(imm, rs1, rd, is_unsigned, size, aq, rl)
      <-> "l" ^ size_mnemonic(size) ^ maybe_u(is_unsigned) ^ maybe_aq(aq) ^ maybe_rl(rl) ^ spc() ^ reg_name(rd) ^ sep() ^ hex_bits_signed_12(imm) ^ "(" ^ reg_name(rs1) ^ ")"
    ```
    Here, the mnemonic is constructed from
    "l" + { "b", "h", "w", "d" } + { "", "u" } + { "", ".aq" } + { "", ".rl" }.
    
    These mnemonic suffixes should be annotated inline for readability.
    
    In addition human-readable names can be similarly constructed, as in
    "load word unsigned acquire release", by concatenating the notes.
    ThinkOpenly committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    6670d78 View commit details
    Browse the repository at this point in the history