Skip to content

Add type instructions and encodings as a separate schema #686

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.

Sign up for GitHub

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

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Add type instructions and encodings as a separate schema #686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4f102d1
feat(type):Add type to instruction schema. Allows referencing to spec…
AFOliveira Apr 28, 2025
1fda012
feat(type):Add instruction_type schema. Source of references to spec…
AFOliveira Apr 28, 2025
0e9d619
Merge branch 'main' into AFOliveira/jsonSchemaType
AFOliveira Apr 29, 2025
2209122
Fix pre-commit error on json schemas.
AFOliveira Apr 29, 2025
fc0d5b4
refactor(encoding schema): move encoding schema to shared schema_defs…
AFOliveira Apr 29, 2025
b98ba93
feat(schemas) : add subtype to the inst_schema and make it an optiona…
AFOliveira Apr 29, 2025
f2310a8
Merge remote-tracking branch 'origin/main' into AFOliveira/jsonSchema…
dhower-qc May 2, 2025
501a67b
feat(schema): wip on instruction type/subtype
dhower-qc May 2, 2025
b7aa7e8
feat(ruby): understand instruction types/subtypes in Ruby
dhower-qc May 5, 2025
d43e0f0
refactor(schema): change 'direction' to 'access' in inst var type
dhower-qc May 5, 2025
bc2bf84
refactor(schema): changing to inheritance for instruction types
dhower-qc May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions arch/inst/Zba/add.uw.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,18 @@ description: |
zero-extended least-significant word of rs1.
definedBy: Zba
assembly: xd, xs1, xs2
encoding:
match: 0000100----------000-----0111011
variables:
- name: rs2
location: 24-20
- name: rs1
location: 19-15
- name: rd
location: 11-7
format:
$inherits:
- inst_subtype/R/R-x.yaml#
- inst_opcode/OP-32.yaml#
opcodes:
funct7:
display_name: ADD.UW
value: 0b0000100
funct3:
display_name: ADD.UW
value: 0b000
opcode: { $inherits: inst_opcode/OP-32.yaml#/data }
access:
s: always
u: always
Expand All @@ -32,7 +35,7 @@ operation(): |
raise (ExceptionCode::IllegalInstruction, mode(), $encoding);
}

X[rd] = X[rs2] + X[rs1][31:0];
X[xd] = X[xs2] + X[xs1][31:0];

# SPDX-SnippetBegin
# SPDX-FileCopyrightText: 2017-2025 Contributors to the RISCV Sail Model <https://github.com/riscv/sail-riscv/blob/master/LICENCE>
Expand Down
9 changes: 9 additions & 0 deletions arch/inst_opcode/OP-32.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# yaml-language-server: $schema=../../schemas/inst_opcode_schema.json#

$schema: inst_opcode_schema.json#
kind: instruction_opcode
name: OP-32

data:
display_name: OP-32
value: 0b0111011
8 changes: 8 additions & 0 deletions arch/inst_opcode/funct3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# yaml-language-server: $schema=../../schemas/inst_opcode_schema.json#

$schema: inst_opcode_schema.json#
kind: instruction_opcode
name: funct3

data:
location: 14-12
Comment on lines +7 to +8
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortuntely, "funct3" is not always at this location. It depends on the format. For example, CI, CSS, CIW, CL, CS all have a "funct3" at 15-13.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you prefer we just drop the indirection or call it something like R-funct3?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about something like this?

  • arch/inst_type/R.yaml (unchanged)
  • arch/inst_subtype/R-x.yaml: 
    data:
  type: { "$ref": "inst_type/R.yaml#" }
  subtype: { "$ref": "inst_subtype/R/R-x.yaml#" }
  $inherits:
    - inst_type/R.yaml#/opcodes
    - inst_var/xs2.yaml#/data
    - inst_var/xs1.yaml#/data
    - inst_var/xd.yaml#/data
  • arch/inst/Zba/add.uw.yaml: 
    format:
  $inherits: inst_subtype/R/R-x.yaml#
  opcodes:
    funct7:
      display_name: ADD.UW
      value: 0b0000100
    funct3:
      display_name: ADD.UW
      value: 0b000
    opcode: { $inherits: inst_opcode/OP-32.yaml#/data }
  • arch/inst_var/xs2.yaml: 
    data:
  $inherits: inst_type/R.yaml#/variables/rs2
  type: { "$ref": "inst_var_type/x_src_reg.yaml#" }

etc.

So, R-x subtype inherits opcodes from the base type, R.
And xs2 inherits attributes (just "location") from the base type R's rs2.
(I removed the top-level "inherits: OP-32" from "add.uw.yaml". Was that needed?)

8 changes: 8 additions & 0 deletions arch/inst_opcode/funct7.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# yaml-language-server: $schema=../../schemas/inst_opcode_schema.json#

$schema: inst_opcode_schema.json#
kind: instruction_opcode
name: funct7

data:
location: 31-25
8 changes: 8 additions & 0 deletions arch/inst_opcode/opcode.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# yaml-language-server: $schema=../../schemas/inst_opcode_schema.json#

$schema: inst_opcode_schema.json#
kind: instruction_opcode
name: opcode

data:
location: 6-0
16 changes: 16 additions & 0 deletions arch/inst_subtype/R/R-x.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# yaml-language-server: $schema=../../../schemas/inst_subtype_schema.json

$schema: inst_subtype_schema.json#
kind: instruction_subtype
name: R-x

data:
type: { "$ref": "inst_type/R.yaml#" }
subtype: { "$ref": "inst_subtype/R/R-x.yaml#" }
$inherits:
- inst_opcode/funct7.yaml#/data
- inst_opcode/funct3.yaml#/data
- inst_opcode/opcode.yaml#/data
- inst_var/xs2.yaml#/data
- inst_var/xs1.yaml#/data
- inst_var/xd.yaml#/data
20 changes: 20 additions & 0 deletions arch/inst_type/R.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# yaml-language-server: $schema=../../schemas/inst_type_schema.json#

$schema: inst_type_schema.json#
kind: instruction_type
name: R
description: R-type instructions usually have two source registers and one destination registers
opcodes:
funct7:
location: 31-25
funct3:
location: 14-12
opcode:
location: 6-0
variables:
rs2:
location: 24-20
rs1:
location: 19-15
rd:
location: 11-7
9 changes: 9 additions & 0 deletions arch/inst_var/xd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# yaml-language-server: $schema=../../schemas/inst_var_schema.json#

$schema: inst_var_schema.json#
kind: instruction_variable
name: xd

data:
location: 11-7
type: { "$ref": "inst_var_type/x_dst_reg.yaml#" }
9 changes: 9 additions & 0 deletions arch/inst_var/xs1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# yaml-language-server: $schema=../../schemas/inst_var_schema.json#

$schema: inst_var_schema.json#
kind: instruction_variable
name: xs1

data:
location: 19-15
type: { "$ref": "inst_var_type/x_src_reg.yaml#" }
9 changes: 9 additions & 0 deletions arch/inst_var/xs2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# yaml-language-server: $schema=../../schemas/inst_var_schema.json#

$schema: inst_var_schema.json#
kind: instruction_variable
name: xs2

data:
location: 24-20
type: { "$ref": "inst_var_type/x_src_reg.yaml#" }
8 changes: 8 additions & 0 deletions arch/inst_var_type/x_dst_reg.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# yaml-language-server: $schema=../../schemas/inst_var_type_schema.json#

$schema: inst_var_type_schema.json#
kind: instruction_variable_type
name: x_dst_reg
type: register_reference
register_file: X
access: W
8 changes: 8 additions & 0 deletions arch/inst_var_type/x_src_reg.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# yaml-language-server: $schema=../../schemas/inst_var_type_schema.json#

$schema: inst_var_type_schema.json#
kind: instruction_variable_type
name: x_src_reg
type: register_reference
register_file: X
access: R
Loading
Loading