48 lines
1.7 KiB
Groff
48 lines
1.7 KiB
Groff
|
.TH GASM-AUDIT-INSTRUCTIONS 1 "2026-09-19" "gasm 0.33.0" "User Commands"
|
||
|
|
.SH NAME
|
||
|
|
gasm-audit-instructions \- diff the encoder against the Go toolchain, or measure a corpus
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.B gasm audit\-instructions [\-\-corpus [\fIdir\fR]] [amd64|arm64|riscv64|loong64]
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Compare the gasm encoder for the given architecture (default amd64)
|
||
|
|
against
|
||
|
|
.B go tool asm
|
||
|
|
and print the diff: superset encodings (gasm-only, shippable via
|
||
|
|
.BR "gasm asm \-\-format goobj" ),
|
||
|
|
known-but-unencodable names (the backlog) and go-only names (feature
|
||
|
|
gaps). The Go side is probed black-box with a battery of bare
|
||
|
|
mnemonics, so the audit tracks whatever toolchain
|
||
|
|
.B go env GOROOT
|
||
|
|
provides.
|
||
|
|
.PP
|
||
|
|
With
|
||
|
|
.BR \-\-corpus ,
|
||
|
|
the audit changes shape: it assembles every
|
||
|
|
.I .s
|
||
|
|
file under the given directory (default GOROOT/src) with the gasm
|
||
|
|
encoder only, no toolchain probing. A file whose name carries a
|
||
|
|
recognisable _arch suffix is attempted for that architecture; a file
|
||
|
|
without one is attempted for all four, exactly as a GOARCH build would
|
||
|
|
compile it. The report gives the headline number (files that assemble
|
||
|
|
for every target architecture), the per-architecture pass rates and the
|
||
|
|
most common failure reasons, which drive the encodability backlog by
|
||
|
|
frequency rather than by table order. A run over GOROOT takes under a
|
||
|
|
second.
|
||
|
|
.SH OPTIONS
|
||
|
|
.TP
|
||
|
|
.B \-\-corpus [\fIdir\fR]
|
||
|
|
Assemble a corpus of .s files and report pass rates and failure
|
||
|
|
reasons.
|
||
|
|
.SH EXIT STATUS
|
||
|
|
The mnemonic-diff mode reports through its output and exits 0; a failed
|
||
|
|
probe or an unknown architecture exits non-zero.
|
||
|
|
.SH EXAMPLES
|
||
|
|
.nf
|
||
|
|
gasm audit\-instructions amd64
|
||
|
|
gasm audit\-instructions \-\-corpus
|
||
|
|
gasm audit\-instructions \-\-corpus "$(go env GOROOT)/src/crypto"
|
||
|
|
.fi
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR gasm (1),
|
||
|
|
.BR gasm\-asm (1)
|