SystemZ Auto-Sync refactor

.github/workflows/CITest.yml

@@ -92,25 +92,20 @@ jobs:
         # Work-around ASAN bug https://github.com/google/sanitizers/issues/1716
         sudo sysctl vm.mmap_rnd_bits=28
 
-    - name: "Compatibility header test"
+    - name: unit tests
+      if: startsWith(matrix.config.build-system, 'cmake')
+      run: |
+        ctest --test-dir build --output-on-failure -R unit_*
+
+    - name: "Integration tests"
       if: startsWith(matrix.config.build-system, 'cmake') && matrix.config.diet-build == 'OFF'
       run: |
-        ctest --test-dir build --output-on-failure -R ASCompatibilityHeaderTest
+        ctest --test-dir build --output-on-failure -R integration_*
 
     - name: cstool - reaches disassembler engine
       run: |
         sh suite/run_invalid_cstool.sh
 
-    - name: cstest unit tests
-      if: startsWith(matrix.config.build-system, 'cmake')
-      run: |
-        ctest --test-dir build --output-on-failure -R UnitCSTest
-
-    - name: cstest integration tests
-      if: startsWith(matrix.config.build-system, 'cmake')
-      run: |
-        ctest --test-dir build --output-on-failure -R IntegrationCSTest
-
     - name: cstest MC
       if: startsWith(matrix.config.build-system, 'cmake')
       run: |

.github/workflows/auto-sync.yml

@@ -78,6 +78,7 @@ jobs:
           ./src/autosync/ASUpdater.py -d -a PPC -s IncGen
           ./src/autosync/ASUpdater.py -d -a LoongArch -s IncGen
           ./src/autosync/ASUpdater.py -d -a Mips -s IncGen
+          ./src/autosync/ASUpdater.py -d -a SystemZ -s IncGen
 
       - name: CppTranslator - Patch tests
         run: |
@@ -94,10 +95,4 @@ jobs:
           ./src/autosync/ASUpdater.py --ci -d -a PPC -s Translate
           ./src/autosync/ASUpdater.py --ci -d -a LoongArch -s Translate
           ./src/autosync/ASUpdater.py --ci -d -a Mips -s Translate
-
-      - name: Differ - Test save file is up-to-date
-        run: |
-          ./src/autosync/cpptranslator/Differ.py -a AArch64 --check_saved
-          ./src/autosync/cpptranslator/Differ.py -a ARM --check_saved
-          ./src/autosync/cpptranslator/Differ.py -a PPC --check_saved
-          ./src/autosync/cpptranslator/Differ.py -a LoongArch --check_saved
+          ./src/autosync/ASUpdater.py --ci -d -a SystemZ -s Translate

CMakeLists.txt

@@ -89,7 +89,7 @@ if(APPLE AND NOT CAPSTONE_BUILD_MACOS_THIN)
     set(CMAKE_OSX_ARCHITECTURES "x86_64;arm64")
 endif()
 
-set(SUPPORTED_ARCHITECTURES ARM AARCH64 M68K MIPS PPC SPARC SYSZ XCORE X86 TMS320C64X M680X EVM MOS65XX WASM BPF RISCV SH TRICORE ALPHA HPPA LOONGARCH)
+set(SUPPORTED_ARCHITECTURES ARM AARCH64 M68K MIPS PPC SPARC SYSTEMZ XCORE X86 TMS320C64X M680X EVM MOS65XX WASM BPF RISCV SH TRICORE ALPHA HPPA LOONGARCH)
 set(SUPPORTED_ARCHITECTURE_LABELS ARM AARCH64 M68K MIPS PowerPC Sparc SystemZ XCore x86 TMS320C64x M680x EVM MOS65XX WASM BPF RISCV SH TriCore Alpha HPPA LoongArch)
 
 # If building for OSX it's best to allow CMake to handle building both architectures
@@ -200,6 +200,7 @@ set(HEADERS_COMMON
     include/capstone/x86.h
     include/capstone/sparc.h
     include/capstone/systemz.h
+    include/capstone/systemz_compatibility.h
     include/capstone/xcore.h
     include/capstone/m68k.h
     include/capstone/tms320c64x.h
@@ -412,27 +413,34 @@ if(CAPSTONE_SPARC_SUPPORT)
     )
 endif()
 
-if(CAPSTONE_SYSZ_SUPPORT)
-    add_definitions(-DCAPSTONE_HAS_SYSZ)
-    set(SOURCES_SYSZ
+if(CAPSTONE_SYSTEMZ_SUPPORT)
+    add_definitions(-DCAPSTONE_HAS_SYSTEMZ)
+    set(SOURCES_SYSTEMZ
         arch/SystemZ/SystemZDisassembler.c
+        arch/SystemZ/SystemZDisassemblerExtension.c
         arch/SystemZ/SystemZInstPrinter.c
         arch/SystemZ/SystemZMapping.c
         arch/SystemZ/SystemZModule.c
         arch/SystemZ/SystemZMCTargetDesc.c
     )
-    set(HEADERS_SYSZ
-        arch/SystemZ/SystemZDisassembler.h
+    set(HEADERS_SYSTEMZ
+        arch/SystemZ/SystemZLinkage.h
+        arch/SystemZ/SystemZDisassemblerExtension.h
+        arch/SystemZ/SystemZInstPrinter.h
+        arch/SystemZ/SystemZMCTargetDesc.h
+        arch/SystemZ/SystemZMapping.h
+        arch/SystemZ/SystemZModule.h
         arch/SystemZ/SystemZGenAsmWriter.inc
+        arch/SystemZ/SystemZGenCSAliasMnemMap.inc
+        arch/SystemZ/SystemZGenCSFeatureName.inc
+        arch/SystemZ/SystemZGenCSMappingInsn.inc
+        arch/SystemZ/SystemZGenCSMappingInsnName.inc
+        arch/SystemZ/SystemZGenCSMappingInsnOp.inc
+        arch/SystemZ/SystemZGenCSOpGroup.inc
         arch/SystemZ/SystemZGenDisassemblerTables.inc
-        arch/SystemZ/SystemZGenInsnNameMaps.inc
         arch/SystemZ/SystemZGenInstrInfo.inc
         arch/SystemZ/SystemZGenRegisterInfo.inc
         arch/SystemZ/SystemZGenSubtargetInfo.inc
-        arch/SystemZ/SystemZInstPrinter.h
-        arch/SystemZ/SystemZMapping.h
-        arch/SystemZ/SystemZMappingInsn.inc
-        arch/SystemZ/SystemZMCTargetDesc.h
     )
 endif()
 
@@ -688,7 +696,7 @@ set(ALL_SOURCES
     ${SOURCES_PPC}
     ${SOURCES_X86}
     ${SOURCES_SPARC}
-    ${SOURCES_SYSZ}
+    ${SOURCES_SYSTEMZ}
     ${SOURCES_XCORE}
     ${SOURCES_M68K}
     ${SOURCES_TMS320C64X}
@@ -714,7 +722,7 @@ set(ALL_HEADERS
     ${HEADERS_PPC}
     ${HEADERS_X86}
     ${HEADERS_SPARC}
-    ${HEADERS_SYSZ}
+    ${HEADERS_SYSTEMZ}
     ${HEADERS_XCORE}
     ${HEADERS_M68K}
     ${HEADERS_TMS320C64X}
@@ -765,7 +773,7 @@ source_group("Source\\AARCH64" FILES ${SOURCES_AARCH64})
 source_group("Source\\Mips" FILES ${SOURCES_MIPS})
 source_group("Source\\PowerPC" FILES ${SOURCES_PPC})
 source_group("Source\\Sparc" FILES ${SOURCES_SPARC})
-source_group("Source\\SystemZ" FILES ${SOURCES_SYSZ})
+source_group("Source\\SystemZ" FILES ${SOURCES_SYSTEMZ})
 source_group("Source\\X86" FILES ${SOURCES_X86})
 source_group("Source\\XCore" FILES ${SOURCES_XCORE})
 source_group("Source\\M68K" FILES ${SOURCES_M68K})
@@ -789,7 +797,7 @@ source_group("Include\\AARCH64" FILES ${HEADERS_AARCH64})
 source_group("Include\\Mips" FILES ${HEADERS_MIPS})
 source_group("Include\\PowerPC" FILES ${HEADERS_PPC})
 source_group("Include\\Sparc" FILES ${HEADERS_SPARC})
-source_group("Include\\SystemZ" FILES ${HEADERS_SYSZ})
+source_group("Include\\SystemZ" FILES ${HEADERS_SYSTEMZ})
 source_group("Include\\X86" FILES ${HEADERS_X86})
 source_group("Include\\XCore" FILES ${HEADERS_XCORE})
 source_group("Include\\M68K" FILES ${HEADERS_M68K})
@@ -898,8 +906,4 @@ if(CAPSTONE_BUILD_CSTEST)
     add_subdirectory(${TESTS_INTEGRATION_DIR})
     set(TESTS_UNIT_DIR ${PROJECT_SOURCE_DIR}/tests/unit)
     add_subdirectory(${TESTS_UNIT_DIR})
-
-    # Unit tests for auto-sync
-    set(AUTO_SYNC_C_TEST_DIR ${PROJECT_SOURCE_DIR}/suite/auto-sync/c_tests/)
-    add_subdirectory(${AUTO_SYNC_C_TEST_DIR})
 endif()

COMPILE_CMAKE.TXT

@@ -28,7 +28,7 @@ Get CMake for free from http://www.cmake.org.
   - CAPSTONE_MOS65XX_SUPPORT: support MOS65XX. Run cmake with -DCAPSTONE_MOS65XX_SUPPORT=0 to remove MOS65XX.
   - CAPSTONE_PPC_SUPPORT: support PPC. Run cmake with -DCAPSTONE_PPC_SUPPORT=0 to remove PPC.
   - CAPSTONE_SPARC_SUPPORT: support Sparc. Run cmake with -DCAPSTONE_SPARC_SUPPORT=0 to remove Sparc.
-  - CAPSTONE_SYSZ_SUPPORT: support SystemZ. Run cmake with -DCAPSTONE_SYSZ_SUPPORT=0 to remove SystemZ.
+  - CAPSTONE_SYSTEMZ_SUPPORT: support SystemZ. Run cmake with -DCAPSTONE_SYSTEMZ_SUPPORT=0 to remove SystemZ.
   - CAPSTONE_XCORE_SUPPORT: support XCore. Run cmake with -DCAPSTONE_XCORE_SUPPORT=0 to remove XCore.
   - CAPSTONE_TRICORE_SUPPORT: support TriCore. Run cmake with -DCAPSTONE_TRICORE_SUPPORT=0 to remove TriCore.
   - CAPSTONE_X86_SUPPORT: support X86. Run cmake with -DCAPSTONE_X86_SUPPORT=0 to remove X86.

MCAsmInfo.h

@@ -0,0 +1,19 @@
+// Copyright © 2024 Rot127 <[email protected]>
+// SPDX-License-Identifier: BSD-3
+
+/// The equivalent of the MCAsmInfo class in LLVM.
+/// We save only some flags of the original class here.
+
+#ifndef CS_MCASMINFO_H
+#define CS_MCASMINFO_H
+
+typedef enum {
+  SYSTEMZASMDIALECT_AD_ATT = 0,
+  SYSTEMZASMDIALECT_AD_HLASM = 1,
+} MCAsmInfoAssemblerDialect;
+
+typedef struct {
+  MCAsmInfoAssemblerDialect assemblerDialect;
+} MCAsmInfo;
+
+#endif // CS_MCASMINFO_H

MCInst.c

@@ -16,7 +16,7 @@
 
 #define MCINST_CACHE (ARR_SIZE(mcInst->Operands) - 1)
 
-void MCInst_Init(MCInst *inst)
+void MCInst_Init(MCInst *inst, cs_arch arch)
 {
 	// unnecessary to initialize in loop . its expensive and inst->size should be honored
 	inst->Operands[0].Kind = kInvalid;
@@ -37,6 +37,15 @@ void MCInst_Init(MCInst *inst)
 	inst->isAliasInstr = false;
 	inst->fillDetailOps = false;
 	memset(&inst->hppa_ext, 0, sizeof(inst->hppa_ext));
+
+	// Set default assembly dialect.
+	switch (arch) {
+	default:
+		break;
+	case CS_ARCH_SYSTEMZ:
+		inst->MAI.assemblerDialect = SYSTEMZASMDIALECT_AD_HLASM;
+		break;
+	}
 }
 
 void MCInst_clear(MCInst *inst)
@@ -150,6 +159,11 @@ int64_t MCOperand_getImm(const MCOperand *op)
 	return op->ImmVal;
 }
 
+int64_t MCOperand_getExpr(const MCOperand *op)
+{
+	return op->ImmVal;
+}
+
 void MCOperand_setImm(MCOperand *op, int64_t Val)
 {
 	op->ImmVal = Val;

MCInst.h

@@ -20,6 +20,7 @@
 #define CS_MCINST_H
 
 #include "include/capstone/capstone.h"
+#include "MCAsmInfo.h"
 #include "MCInstrDesc.h"
 #include "MCRegisterInfo.h"
 
@@ -73,6 +74,8 @@ int64_t MCOperand_getImm(const MCOperand *op);
 
 void MCOperand_setImm(MCOperand *op, int64_t Val);
 
+int64_t MCOperand_getExpr(const MCOperand *op);
+
 double MCOperand_getFPImm(const MCOperand *op);
 
 void MCOperand_setFPImm(MCOperand *op, double Val);
@@ -133,9 +136,10 @@ struct MCInst {
 	bool isAliasInstr; // Flag if this MCInst is an alias.
 	bool fillDetailOps; // If set, detail->operands gets filled.
 	hppa_ext hppa_ext;	///< for HPPA operand. Contains info about modifiers and their effect on the instruction
+	MCAsmInfo MAI; ///< The equivalent to MCAsmInfo in LLVM. It holds flags relevant for the asm style to print.
 };
 
-void MCInst_Init(MCInst *inst);
+void MCInst_Init(MCInst *inst, cs_arch arch);
 
 void MCInst_clear(MCInst *inst);
 

Mapping.c

@@ -340,6 +340,7 @@ DEFINE_get_detail_op(hppa, HPPA);
 DEFINE_get_detail_op(loongarch, LoongArch);
 DEFINE_get_detail_op(mips, Mips);
 DEFINE_get_detail_op(riscv, RISCV);
+DEFINE_get_detail_op(systemz, SystemZ);
 
 /// Returns true if for this architecture the
 /// alias operands should be filled.
@@ -433,7 +434,7 @@ uint64_t enum_map_bin_search(const cs_enum_id_map *map, size_t map_len,
 		} else if (id[i] > map[m].str[j]) {
 			l = m + 1;
 		}
-		if (m == 0 || (l + r) / 2 >= map_len) {
+		if ((m == 0 && id[i] < map[m].str[j]) || (l + r) / 2 >= map_len) {
 			// Break before we go out of bounds.
 			break;
 		}

Mapping.h

@@ -32,6 +32,7 @@ typedef struct insn_map {
 		ppc_suppl_info ppc;
 		loongarch_suppl_info loongarch;
 		aarch64_suppl_info aarch64;
+		systemz_suppl_info systemz;
 	} suppl_info; // Supplementary information for each instruction.
 #endif
 } insn_map;
@@ -140,6 +141,7 @@ DECL_get_detail_op(hppa, HPPA);
 DECL_get_detail_op(loongarch, LoongArch);
 DECL_get_detail_op(mips, Mips);
 DECL_get_detail_op(riscv, RISCV);
+DECL_get_detail_op(systemz, SystemZ);
 
 /// Increments the detail->arch.op_count by one.
 #define DEFINE_inc_detail_op_count(arch, ARCH) \
@@ -173,6 +175,8 @@ DEFINE_inc_detail_op_count(mips, Mips);
 DEFINE_dec_detail_op_count(mips, Mips);
 DEFINE_inc_detail_op_count(riscv, RISCV);
 DEFINE_dec_detail_op_count(riscv, RISCV);
+DEFINE_inc_detail_op_count(systemz, SystemZ);
+DEFINE_dec_detail_op_count(systemz, SystemZ);
 
 /// Returns true if a memory operand is currently edited.
 static inline bool doing_mem(const MCInst *MI)
@@ -203,6 +207,7 @@ DEFINE_get_arch_detail(hppa, HPPA);
 DEFINE_get_arch_detail(loongarch, LoongArch);
 DEFINE_get_arch_detail(mips, Mips);
 DEFINE_get_arch_detail(riscv, RISCV);
+DEFINE_get_arch_detail(systemz, SystemZ);
 
 static inline bool detail_is_set(const MCInst *MI)
 {