Initial crack at manuals

Author: Derek Hower

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "ext/docs-resources"]
 	path = ext/docs-resources
 	url = https://github.com/riscv/docs-resources.git
+[submodule "ext/riscv-isa-manual"]
+	path = ext/riscv-isa-manual
+	url = https://github.com/riscv/riscv-isa-manual

backends/arch_gen/tasks.rake

@@ -66,13 +66,34 @@ file "#{$root}/.stamps/arch-gen.stamp" => (
     profile_obj[profile_name]["__source"] = f
     [profile_name, profile_obj[profile_name]]
   end.to_h
+  manual_hash = {}
+  Dir.glob($root / "arch" / "manual" / "**" / "contents.yaml").map do |f|
+    manual_version = YAML.load_file(f)
+    manual_id = manual_version["manual"]
+    unless manual_hash.key?(manual_id)
+      manual_info_files = Dir.glob($root / "arch" / "manual" / "**" / "#{manual_id}.yaml")
+      raise "Could not find manual info '#{manual_id}'.yaml, needed by #{f}" if manual_info_files.empty?
+      raise "Found multiple manual infos '#{manual_id}'.yaml, needed by #{f}" if manual_info_files.size > 1
+
+      manual_info_file = manual_info_files.first
+      manual_hash[manual_id] = YAML.load_file(manual_info_file)
+      manual_hash[manual_id]["__source"] = manual_info_file
+      # TODO: schema validation
+    end
+
+    manual_hash[manual_id]["versions"] ||= []
+    manual_hash[manual_id]["versions"] << YAML.load_file(f)
+    # TODO: schema validation
+    manual_hash[manual_id]["versions"].last["__source"] = f
+  end
 
   arch_def = {
     "instructions" => inst_hash,
     "extensions" => ext_hash,
     "csrs" => csr_hash,
     "profile_families" => profile_family_hash,
-    "profiles" => profile_hash
+    "profiles" => profile_hash,
+    "manuals" => manual_hash
   }
 
   dest = "#{$root}/gen/_/arch/arch_def.yaml"

ext/riscv-isa-manual

@@ -11,6 +11,7 @@
 require_relative "idl/passes/reachable_functions"
 require_relative "idl/passes/reachable_functions_unevaluated"
 require_relative "idl/passes/reachable_exceptions"
+require_relative "arch_obj_models/manual"
 require_relative "arch_obj_models/profile"
 require_relative "arch_obj_models/csr_field"
 require_relative "arch_obj_models/csr"
@@ -224,6 +225,31 @@ def function(name)
     function_hash[name]
   end
 
+  # @return [Array<Manual>] List of all manuals defined by the architecture
+  def manuals
+    return @manuals unless @manuals.nil?
+
+    @manuals = []
+    @arch_def["manuals"].each_value do |manual_data|
+      @manuals << Manual.new(manual_data, self)
+    end
+    @manuals
+  end
+
+  # @return [Hash<String, Manual>] All manuals, indexed by name
+  def manuals_hash
+    return @manuals_hash unless @manuals_hash.nil?
+
+    @manuals_hash = {}
+    manuals.each do |manual|
+      @manuals_hash[manual.name] = manual
+    end
+    @manuals_hash
+  end
+
+  # @return [Manual,nil] A manual named +name+, or nil if it doesn't exist
+  def manual(name) = manuals_hash[name]
+
   # @return [Array<ProfileFamily>] All known profile families
   def profile_families
     return @profile_families unless @profile_families.nil?