Inst Schema

v0.2

Auto-generated

This page is generated from inst_schema.json by the schema doc generator. To update this page, edit the schema file and run bin/chore gen schema-docs.

Definitions

fully_resolved_opcodes

Property	Type	Required	Description
location	schema_defs.json#/$defs/field_location	✓
display_name	string	✓	field name, displayed in encoding drawings
value	One of: An integer, either native to JSON or a number-like string | object	✓
$child_of	One of: string | Array<string>

fully_resolved_variables

fully_resolved_format

old_encoding

Property	Type	Required	Description
match	One of: string | string | string
variables	Array<field>
additionalProperties	never

type

Property	Type	Required	Description
$ref	string	✓	Reference to an instruction type definition

subtype

Property	Type	Required	Description
$ref	string	✓	Reference to an instruction subtype definition

variable_metadata

field — Decode field

Decode field

Properties

Property	Type	Required	Description
$schema	string (const: inst_schema.json#)	✓	Path to schema, relative to <UDB ROOT>/schemas
kind	string (const: instruction)	✓
name	string	✓	Instruction mnemonic (must be lowercase)
long_name	string	✓	One line description of the instruction
description	string | Array<conditional_text>	✓	Detailed description of the instruction
definedBy	A condition (YAML structure or IDL function). See the conditions reference for details.	✓	Extension(s) that defines the instruction
access	object	✓
assembly	string	✓	Assembly format of the instruction. Can use decode variables
encoding	One of: old_encoding | object		Instruction encoding and decode variables
format	object
pseudoinstructions	Array<{when, to}> ↓ schema		Variations of this instruction that form a pseudoinstruction
data_independent_timing	boolean		Whether or not the instruction must execute with data-independent timing when the Zkt extension is supported
cert_normative_rules	Architecturally visible behaviors requiring validation by certification tests
operation_ast	object
operation()	string		Functional description of the instruction using IDL language
access_detail	string		Extra detail about access when at least one mode is 'sometimes'
hints	Array<{$ref}> ↓ schema		List of HINTs that use this instruction's codepoints

pseudoinstructions item schema

Property	Type	Required	Description
when	string		Condition when the instruction has an alias
to	string		pseudoinstruction format

hints item schema

Property	Type	Required	Description
$ref	string	✓	Ref to an instruction that is using a HINT codepoint(s) of this instruction

Tooling field

$source is an optional field set automatically by UDB tooling to record the file path this object was loaded from. You do not need to set it manually.

Schema Information

Property	Value
Version	v0.2
JSON Schema Version	Draft 07