TheRock/rocm-systems/projects/rocprofiler-systems/external/dyninst/instructionAPI/capstone/import.py

import argparse
import capstone
import x86

"""
  Process and import Capstone instruction mnemonics
    
    Each architecture is in a separate module and implements things like mnemonic prefixes and
    instruction aliases. The latter must be manually updated as more instructions are added to
    the ISAs.
    
  Usage:
    The mnemonics are stored in the output file 'mnemonics'. This can be directly copied to
    the appropriate architecture file in Dyninst (e.g., common/mnemonics/x86_entryIDs.h).
    Examining changes is then most easily done using git.
"""

if __name__ == "__main__":
    parser = argparse.ArgumentParser(
        description="Translate Capstone instruction data structures to Dyninst instruction data structures"
    )
    parser.add_argument(
        "--capstone",
        type=str,
        required=True,
        help="Capstone header (e.g., /capstone-engine/capstone/arch/X86/X86MappingInsnName.inc)"
    )

    parser.add_argument("--arch", type=str, choices=["x86"], default="x86")
    args = parser.parse_args()

    if args.arch == "x86":
        translator = x86.x86()

    with open("mnemonics", "w") as f:
        for p in translator.pseudo:
            f.write("{0:s}_{1:s}, /* pseudo mnemonic */\n".format(translator.dyninst_prefix, p))
        
        mnemonics = capstone.read_mnemonics(args.capstone)
        mnemonics.extend(translator.missing)
        mnemonics.sort()
        
        # Remove already-printed names
        mnemonics = [m for m in mnemonics if m not in translator.pseudo]

        for m in mnemonics:
          if m not in translator.aliases:
            f.write("{0:s}_{1:s},\n".format(translator.dyninst_prefix, m))
            continue
         
          if not translator.aliases[m]["seen"]:
            f.write("{0:s}_{1:s},\n".format(translator.dyninst_prefix, m))
            translator.aliases[m]["seen"] = True
            for a in translator.aliases[m]["values"]:
              f.write("{0:s}_{1:s} = {0:s}_{2:s},\n".format(translator.dyninst_prefix, a, m))
              translator.aliases[a]["seen"] = True