riscv / riscv-glossary Goto Github PK

https://github.com/riscv/riscv-j-extension/blob/master/zjpm/background.adoc

Add the [gloassary] asciidoctor block style appropriately. See https://docs.asciidoctor.org/asciidoc/latest/sections/glossary/

Create a symbol to indicate if term is an industry-standard acronym or RISC-V specific. Some sort of symbols or abbreviations may help.

Compare to what is in this spreadsheet - https://docs.google.com/spreadsheets/d/1-XrYmdH2aMinUovpLOJGVftGCbMJFRv-0_199-gQHaU/edit#gid=0

Extension name schemas: e.g. Z* for unpriv extensions, S* for priv extensions, Za* for atomics, Zb* for bitmanip stuff, Zv* for vector extensions, Zk* for crypto extensions, Sv* for Supervisor virtual memory extensions, Sh* for supervisor items, Sm* for Machine Mode extensions, and so on. I’m no expert on the schemas, so I would suggest working with Andrew Waterman to review the above.

Rather than just linking to the glossary, would like to create a way to single source the entries. So that after we agree on a term, that term can be populated in the priv and unpriv (or populated FROM the priv and unpriv) to the glossary and to other stand alone documents. Could use the anchor name to pull in? Then we would have a single source of truth for defintions.

Disambiguation entries, sort of like what Wikipedia does, for things which have the same acronym. For example you have IMSIC as one acronym, but not the one from AIA: Incoming MSI Controller, which in the RISC-V world is arguably more important. Also PLIC is Platform-Level Interrupt Controller. Also RV is sometimes an abbreviation for RISC-V.

Do we include all possible glossary items or just for ratified specs?

Request: adding another "chapter" to this with the official extension names in abbreviated and long form? eg, Zicsr.

Either beef them up or find a good spot to link them to for more information.

TSO for Total Store Ordering
All the misa letters (e.g. D for Double-precision FP, V for Vector, )
RV32E
RV64E
Hart — Hardware thread
binary16, binary32, binary64 — formats from IEEE 754
binary8p3, binary8p4, binary8p5 — formats proposed for IEEE standardization
AES — Advanced Encryption Standard
GCM — Galois Counter Mode
CBO — Cache Block Operation
Second Level Page Table — hypervisor page tables for supervisors
Indirect CSRs
BTB — Branch Target Buffer
Control Flow Integrity
CHERI — Capability Hardware Enhanced RISC Instructions
APLIC — Advanced Platform-Level Interrupt Controller
IPI — Interprocessor interrupts
IOMMU
IOPMP
Smmtt
SPMP
DMA — Direct Memory Access
ELF — Executable and Linkable Format
GOT — Global Offset Table
PLT — Program Linkage Table (aka Procedure Linkage Table)
NMI — Non-maskable Interrupt
Things from vector spec: SEW, VLEN, EEW, etc.
OoO — Out of Order
PC — Program Counter
QoS — Qualtify of Service
RTOS — Real-time Operating System
SIMD — Single Instruction Multiple Data
TEE — Trusted execution environment
Word — 32 bits
Doubleword — 64 bits
Shadow Stack
ulp — Unit in the Last Place https://en.wikipedia.org/wiki/Unit_in_the_last_place
COW — Copy on Write
CMODX — Concurrent Modification and Execution of Instructions
CoVE — Confidential VM Extension ABI for Confidential Computing
May-Be-Operations (MOPs)
Hints

Soon to be ratified spec has glossary here - https://github.com/riscv-non-isa/riscv-ap-tee/releases/download/0.6/riscv-cove.pdf

Need to see if there are additional topics.

We should use our standard doc dev method for building a PDF and HTML version, i.e. a Makefile using Docker.

ASLR — Address Space Layout Randomization
HBM — High-bandwidth Memory
HPC — High-performance Computing
ILP — Instruction Level Parallelism
LP64, ILP64 etc. — C/C++ data type size codes
NOC — Network on Chip
Acquire and Release — the paper Memory consistency and event ordering in scalable shared-memory multiprocessors by Gharachorloo et al
ROP — Return Oriented Programming

Docs-resources should be a submodule to comply with our docs dev guidelines.