package inst

import "github.com/mmcloughlin/avo/internal/inst"

Package inst is the avo instruction database.

Index ¶

• Variables
• type Action
• func ActionFromReadWrite(r, w bool) Action
• func (a Action) Contains(s Action) bool
• func (a Action) Read() bool
• func (a Action) String() string
• func (a Action) Write() bool
• type Form
• func (f Form) Arity() int
• func (f Form) Signature() []string
• type ImplicitOperand
• type Instruction
• func Lookup(opcode string) (Instruction, bool)
• func (i Instruction) Arities() []int
• func (i Instruction) Arity() int
• func (i Instruction) IsBranch() bool
• func (i Instruction) IsConditionalBranch() bool
• func (i Instruction) IsNiladic() bool
• func (i Instruction) IsTerminal() bool
• func (i Instruction) IsVariadic() bool
• type Operand

Variables ¶

var Instructions = []Instruction{ /* 983 elements not displayed */

}

Types ¶

type Action ¶

type Action uint8

Action specifies the read/write operation of an instruction on an operand.

const (
	R  Action = 0x1
	W  Action = 0x2
	RW Action = R | W
)

Possible Action types.

func ActionFromReadWrite ¶

func ActionFromReadWrite(r, w bool) Action

ActionFromReadWrite builds an Action from boolean flags.

func (Action) Contains ¶

func (a Action) Contains(s Action) bool

Contains reports whether a supports all actions in s.

func (Action) Read ¶

func (a Action) Read() bool

Read reports whether a supports read.

func (Action) String ¶

func (a Action) String() string

String represents a as a human-readable string.

func (Action) Write ¶

func (a Action) Write() bool

Write reports whether a supports write.

type Form ¶

type Form struct {
	// Instruction sets this instruction form requires.
	ISA []string

	// Operands required for this form.
	Operands []Operand

	// Registers read or written but not explicitly passed to the instruction.
	ImplicitOperands []ImplicitOperand

	// CancellingInputs indicates this instruction form has no dependency on the
	// input operands when they refer to the same register. The classic example of
	// this is "XORQ RAX, RAX", in which case the output has no dependence on the
	// value of RAX. Instruction forms with cancelling inputs have only two input
	// operands, which have the same register type.
	CancellingInputs bool
}

Form specifies one accepted set of operands for an instruction.

func (Form) Arity ¶

func (f Form) Arity() int

Arity returns the number of operands this form expects.

func (Form) Signature ¶

func (f Form) Signature() []string

Signature returns the list of operand types.

type ImplicitOperand ¶

type ImplicitOperand struct {
	Register string
	Action   Action
}

ImplicitOperand describes a register that is implicitly read/written by an instruction.

type Instruction ¶

type Instruction struct {
	Opcode  string // Golang assembly mnemonic
	AliasOf string // Opcode of instruction that this is an alias for
	Summary string // Description of the instruction
	Forms   []Form // Accepted operand forms
}

Instruction represents an x86 instruction.

func Lookup ¶

func Lookup(opcode string) (Instruction, bool)

Lookup returns the instruction with the given opcode. Boolean return value indicates whether the instruction was found.

func (Instruction) Arities ¶

func (i Instruction) Arities() []int

Arities returns the unique arities among the instruction forms.

func (Instruction) Arity ¶

func (i Instruction) Arity() int

Arity is a convenience for returning the unique instruction arity when you know it is not variadic. Panics for a variadic instruction.

func (Instruction) IsBranch ¶

func (i Instruction) IsBranch() bool

IsBranch reports whether the instruction is a branch; that is, if it can cause control flow to jump to another location.

func (Instruction) IsConditionalBranch ¶

func (i Instruction) IsConditionalBranch() bool

IsConditionalBranch reports whether the instruction branches dependent on some condition.

func (Instruction) IsNiladic ¶

func (i Instruction) IsNiladic() bool

IsNiladic reports whether the instruction takes no operands.

func (Instruction) IsTerminal ¶

func (i Instruction) IsTerminal() bool

IsTerminal reports whether the instruction exits a function.

func (Instruction) IsVariadic ¶

func (i Instruction) IsVariadic() bool

IsVariadic reports whether the instruction has more than one arity.

type Operand ¶

type Operand struct {
	Type   string
	Action Action
}

Operand is an operand to an instruction, describing the expected type and read/write action.

Source Files ¶

doc.go table.go types.go ztable.go