Skip to content

Add extension list to manual generator #101

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

Merged
merged 2 commits into from
Oct 16, 2024
Merged

Add extension list to manual generator #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9306455
Add extension list to manual generator
Oct 16, 2024
eb62e0c
Merge branch 'main' into manual_appendices
dhower-qc Oct 16, 2024
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
93 changes: 29 additions & 64 deletions backends/manual/tasks.rake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,64 +30,6 @@ directory MANUAL_GEN_DIR / "adoc"
directory MANUAL_GEN_DIR / "antora"
directory MANUAL_GEN_DIR / "html"

# ["inst", "csr", "ext"].each do |type|
# directory MANUAL_GEN_DIR / "antora" / "modules" / "#{type}s" / "pages"

# Dir.glob($root / "arch" / type / "**" / "*.yaml") do |fn|
# file MANUAL_GEN_DIR / "adoc" / "#{File.basename(fn, '.yaml')}.adoc" => [
# "gen:arch",
# (MANUAL_GEN_DIR / "adoc").to_s,
# ($root / "backends" / "manual" / "templates" / "#{type}.adoc.erb").to_s,
# __FILE__
# ] do |t|
# name = File.basename(t.name, ".adoc")

# arch_def_32 = arch_def_for("_32")
# arch_def_64 = arch_def_for("_64")
# erb = case type
# when "inst"
# inst_32 = arch_def_32.instruction(name)
# raise "Could not find inst '#{name}' in RV32" if inst_32.nil?

# inst_64 = arch_def_64.instruction(name)
# raise "Could not find inst '#{name}' in RV64" if inst_64.nil?

# inst = inst_32 || inst_64

# ERB.new(File.read($root / "backends" / "manual" / "templates" / "inst.adoc.erb"), trim_mode: "-")
# when "csr"
# csr_32 = arch_def_32.csr(name)
# raise "Could not find csr '#{name}' in RV32" if csr_32.nil?

# csr_64 = arch_def_64.csr(name)
# raise "Could not find csr '#{name}' in RV32" if csr_64.nil?

# csr = csr_32 || csr_64

# ERB.new(File.read($root / "backends" / "manual" / "templates" / "csr.adoc.erb"), trim_mode: "-")
# when "ext"
# ext = arch_def_64.extension(name)
# raise "Could not find ext '#{name}'" if ext.nil?

# arch_def = arch_def_64

# ERB.new(File.read($root / "backends" / "manual" / "templates" / "ext.adoc.erb"), trim_mode: "-")
# else
# raise "Unhandled type '#{type}'"
# end

# File.write(t.name, erb.result(binding))
# end

# file MANUAL_GEN_DIR / "antora" / "modules" / "#{type}s" / "pages" => [
# (MANUAL_GEN_DIR / "adoc" / "#{File.basename(fn, '.yaml')}.adoc").to_s,
# (MANUAL_GEN_DIR / "antora" / "modules" / "#{type}s" / "pages").to_s
# ] do |t|
# FileUtils.cp t.prerequisites.first, t.name
# end
# end
# end

file MANUAL_GEN_DIR / "antora" / "antora.yml" => (MANUAL_GEN_DIR / "antora").to_s do |t|
File.write t.name, <<~ANTORA
name: riscv_manual
Expand Down Expand Up @@ -226,7 +168,7 @@ end
# rule to create instruction appendix page
rule %r{#{MANUAL_GEN_DIR}/.*/.*/antora/modules/insts/pages/.*.adoc} => [
__FILE__,
"gen:arch",
"#{$root}/.stamps/arch-gen-_64.stamp",
($root / "backends" / "manual" / "templates" / "instruction.adoc.erb").to_s
] do |t|
inst_name = File.basename(t.name, ".adoc")
Expand All @@ -240,13 +182,13 @@ rule %r{#{MANUAL_GEN_DIR}/.*/.*/antora/modules/insts/pages/.*.adoc} => [
erb.filename = inst_template_path.to_s

FileUtils.mkdir_p File.dirname(t.name)
File.write t.name, AntoraUtils.resolve_links(erb.result(binding))
File.write t.name, AntoraUtils.resolve_links(arch_def.find_replace_links(erb.result(binding)))
end

# rule to create csr appendix page
rule %r{#{MANUAL_GEN_DIR}/.*/.*/antora/modules/csrs/pages/.*.adoc} => [
__FILE__,
"gen:arch",
"#{$root}/.stamps/arch-gen-_64.stamp",
($root / "backends" / "manual" / "templates" / "csr.adoc.erb").to_s
] do |t|
csr_name = File.basename(t.name, ".adoc")
Expand All @@ -260,13 +202,33 @@ rule %r{#{MANUAL_GEN_DIR}/.*/.*/antora/modules/csrs/pages/.*.adoc} => [
erb.filename = csr_template_path.to_s

FileUtils.mkdir_p File.dirname(t.name)
File.write t.name, AntoraUtils.resolve_links(erb.result(binding))
File.write t.name, AntoraUtils.resolve_links(arch_def.find_replace_links(erb.result(binding)))
end

# rule to create ext appendix page
rule %r{#{MANUAL_GEN_DIR}/.*/.*/antora/modules/exts/pages/.*.adoc} => [
__FILE__,
"#{$root}/.stamps/arch-gen-_64.stamp",
($root / "backends" / "manual" / "templates" / "ext.adoc.erb").to_s
] do |t|
ext_name = File.basename(t.name, ".adoc")

arch_def = arch_def_for("_64")
ext = arch_def.extension(ext_name)
raise "Can't find extension '#{ext_name}'" if ext.nil?

ext_template_path = $root / "backends" / "manual" / "templates" / "ext.adoc.erb"
erb = ERB.new(ext_template_path.read, trim_mode: "-")
erb.filename = ext_template_path.to_s

FileUtils.mkdir_p File.dirname(t.name)
File.write t.name, AntoraUtils.resolve_links(arch_def.find_replace_links(erb.result(binding)))
end

# rule to create IDL function appendix page
rule %r{#{MANUAL_GEN_DIR}/.*/.*/antora/modules/funcs/pages/funcs.adoc} => [
__FILE__,
"gen:arch",
"#{$root}/.stamps/arch-gen-_64.stamp",
($root / "backends" / "manual" / "templates" / "func.adoc.erb").to_s
] do |t|
arch_def = arch_def_for("_64")
Expand All @@ -276,7 +238,7 @@ rule %r{#{MANUAL_GEN_DIR}/.*/.*/antora/modules/funcs/pages/funcs.adoc} => [
erb.filename = funcs_template_path.to_s

FileUtils.mkdir_p File.dirname(t.name)
File.write t.name, AntoraUtils.resolve_links(erb.result(binding))
File.write t.name, AntoraUtils.resolve_links(arch_def.find_replace_links(erb.result(binding)))
end

rule %r{#{MANUAL_GEN_DIR}/.*/top/.*/antora/landing/antora.yml} => [
Expand Down Expand Up @@ -429,6 +391,9 @@ namespace :gen do
version.csrs.each do |csr|
Rake::Task[antora_path / "modules" / "csrs" / "pages" / "#{csr.name}.adoc"].invoke
end
version.extensions.each do |ext|
Rake::Task[antora_path / "modules" / "exts" / "pages" / "#{ext.name}.adoc"].invoke
end
end

landing_page_path = MANUAL_GEN_DIR / ENV["MANUAL_NAME"] / "top" / output_hash / "antora" / "landing" / "modules" / "ROOT" / "pages" / "index.adoc"
Expand Down
70 changes: 70 additions & 0 deletions backends/manual/templates/ext.adoc.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
[ext:$<%= ext.name %>-def]
= <%= ext.name %> Extension
<%= ext.long_name %>

== Versions

<%- ext.versions.each do |v| -%>
<%- implemented = arch_def.implemented_extensions.include?(ExtensionVersion.new(ext.name, v["version"])) -%>
<%= v["version"] %>::
State:::
<%= v["state"] %>
<%- if v["state"] == "ratified" -%>
Ratification date:::
<%= v["ratification_date"] %>
<%- end -%>
<%- if v.key?("changes") -%>
Changes:::
<%- v["changes"].each do |change| %>
* <%= change %>
<%- end -%>
<%- end -%>
<%- if v.key?("url") -%>
Ratification document:::
<%= v["url"] %>
<%- end -%>
<%- if v.key?("implies") -%>
Implies:::
<%- implications = v["implies"][0].is_a?(Array) ? v["implies"] : [v["implies"]] -%>
<%- implications.each do |i| -%>
* `<%= i[0] %>` version <%= i[1] %>
<%- end -%>
<%- end -%>
<%- end -%>

== Synopsis

<%= ext.description %>

<%- insts = arch_def.instructions.select { |i| ext.versions.any? { |v| i.defined_by?(ext.name, v["version"]) } } -%>
<%- unless insts.empty? -%>
== Instructions

The following instructions are defined by this extension:

[cols="1,3"]
|===
<%- insts.each do |inst| -%>
| <%= "`#{inst.name}`" %> | *<%= inst.long_name %>*
<%- end -%>
|===
<%- end -%>

<%- unless ext.params.empty? -%>
== Parameters

This extension has the following implementation options:

<%- ext.params.sort_by { |p| p.name }.each do |param| -%>
<%= param.name %>::
+
--
|===
h| Type | <%= param.schema["type"] %>
h| Valid Values | <%= Schema.new(param.schema).to_pretty_s %>
h| Description a| <%= param.desc %>
|===
--
<%- end -%>

<%- end -%>
5 changes: 5 additions & 0 deletions backends/manual/templates/isa_nav.adoc.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,10 @@
* xref:csrs:<%= csr.name %>.adoc[<%= csr.name %>]
<%- end -%>

.Alphabetical list of extensions
<%- manual_version.extensions.sort { |a, b| a.name <=> b.name }.each do |ext| -%>
* xref:exts:<%= ext.name %>.adoc[<%= ext.name %>]
<%- end -%>

.Execution functions (IDL)
* xref:funcs:funcs.adoc[Functions]
Loading