Allow overlapping extensions with --warn-overlap

Author: colluca

src/riscv_opcodes/parse.py

@@ -31,8 +31,9 @@ def generate_extensions(
     go: bool,
     latex: bool,
     svg: bool,
+    warn_overlap: bool = False,
 ):
-    instr_dict = create_inst_dict(extensions, include_pseudo)
+    instr_dict = create_inst_dict(extensions, include_pseudo, warn_overlap=warn_overlap)
     instr_dict = dict(sorted(instr_dict.items()))
     instr_dict_with_segment = add_segmented_vls_insn(instr_dict)
 
@@ -41,7 +42,7 @@ def generate_extensions(
 
     if c:
         instr_dict_c = create_inst_dict(
-            extensions, False, include_pseudo_ops=emitted_pseudo_ops
+            extensions, False, include_pseudo_ops=emitted_pseudo_ops, warn_overlap=warn_overlap
         )
         instr_dict_c = dict(sorted(instr_dict_c.items()))
         make_c(instr_dict_c)
@@ -97,6 +98,11 @@ def main():
     parser.add_argument("-go", action="store_true", help="Generate output for Go")
     parser.add_argument("-latex", action="store_true", help="Generate output for Latex")
     parser.add_argument("-svg", action="store_true", help="Generate .svg output")
+    parser.add_argument(
+        "--warn-overlap",
+        action="store_true",
+        help="Warn instead of error on overlapping instruction encodings",
+    )
     parser.add_argument(
         "extensions",
         nargs="*",
@@ -118,4 +124,5 @@ def main():
         args.go,
         args.latex,
         args.svg,
+        args.warn_overlap,
     )

src/riscv_opcodes/shared_utils.py

@@ -407,7 +407,7 @@ def read_lines(file: str) -> "list[str]":
 
 # Update the instruction dictionary
 def process_standard_instructions(
-    lines: "list[str]", instr_dict: InstrDict, file_name: str
+    lines: "list[str]", instr_dict: InstrDict, file_name: str, warn_overlap: bool = False
 ):
     """Processes standard instructions from the given lines and updates the instruction dictionary."""
     for line in lines:
@@ -437,9 +437,11 @@ def process_standard_instructions(
                     and not instruction_overlap_allowed(name, key)
                     and same_base_isa(ext_name, item["extension"])
                 ):
-                    log_and_exit(
-                        f'Instruction {name} in extension {ext_name} overlaps with {key} in {item["extension"]}'
-                    )
+                    overlap_msg = f'Instruction {name} in extension {ext_name} overlaps with {key} in {item["extension"]}'
+                    if warn_overlap:
+                        logging.warning(overlap_msg)
+                    else:
+                        log_and_exit(overlap_msg)
 
             instr_dict[name] = single_dict
 
@@ -543,6 +545,7 @@ def create_inst_dict(
     file_filter: "list[str]",
     include_pseudo: bool = False,
     include_pseudo_ops: "Optional[list[str]]" = None,
+    warn_overlap: bool = False,
 ) -> InstrDict:
     """
     Creates a dictionary of instructions based on the provided file filters.
@@ -607,7 +610,7 @@ def create_inst_dict(
     for file_name in file_names:
         logging.debug(f"Parsing File: {file_name} for standard instructions")
         lines = read_lines(file_name)
-        process_standard_instructions(lines, instr_dict, file_name)
+        process_standard_instructions(lines, instr_dict, file_name, warn_overlap)
 
     logging.debug("Collecting pseudo instructions")
     for file_name in file_names: