Apple compatibility changes for #2026 + misc. AARCH64 naming cleanups.

CMakeLists.txt

@@ -45,8 +45,8 @@ option(CAPSTONE_ARCHITECTURE_DEFAULT "Whether architectures are enabled by defau
 option(CAPSTONE_DEBUG "Whether to enable extra debug assertions" OFF)
 option(CAPSTONE_INSTALL "Generate install target" ${PROJECT_IS_TOP_LEVEL})
 
-set(SUPPORTED_ARCHITECTURES ARM ARM64 M68K MIPS PPC SPARC SYSZ XCORE X86 TMS320C64X M680X EVM MOS65XX WASM BPF RISCV SH TRICORE)
-set(SUPPORTED_ARCHITECTURE_LABELS ARM ARM64 M68K MIPS PowerPC Sparc SystemZ XCore x86 TMS320C64x M680x EVM MOS65XX WASM BPF RISCV SH TriCore)
+set(SUPPORTED_ARCHITECTURES ARM AARCH64 M68K MIPS PPC SPARC SYSZ XCORE X86 TMS320C64X M680X EVM MOS65XX WASM BPF RISCV SH TRICORE)
+set(SUPPORTED_ARCHITECTURE_LABELS ARM AARCH64 M68K MIPS PowerPC Sparc SystemZ XCore x86 TMS320C64x M680x EVM MOS65XX WASM BPF RISCV SH TriCore)
 
 list(LENGTH SUPPORTED_ARCHITECTURES count)
 math(EXPR count "${count}-1")
@@ -123,7 +123,7 @@ set(HEADERS_ENGINE
 )
 
 set(HEADERS_COMMON
-    include/capstone/arm64.h
+    include/capstone/aarch64.h
     include/capstone/arm.h
     include/capstone/capstone.h
     include/capstone/cs_operand.h
@@ -181,35 +181,35 @@ if(CAPSTONE_ARM_SUPPORT)
     set(TEST_SOURCES ${TEST_SOURCES} test_arm.c)
 endif()
 
-if(CAPSTONE_ARM64_SUPPORT)
-    add_definitions(-DCAPSTONE_HAS_ARM64)
-    set(SOURCES_ARM64
+if(CAPSTONE_AARCH64_SUPPORT)
+    add_definitions(-DCAPSTONE_HAS_AARCH64)
+    set(SOURCES_AARCH64
         arch/AArch64/AArch64BaseInfo.c
         arch/AArch64/AArch64Disassembler.c
+        arch/AArch64/AArch64DisassemblerExtension.c
         arch/AArch64/AArch64InstPrinter.c
         arch/AArch64/AArch64Mapping.c
         arch/AArch64/AArch64Module.c
     )
-    set(HEADERS_ARM64
+    set(HEADERS_AARCH64
         arch/AArch64/AArch64AddressingModes.h
         arch/AArch64/AArch64BaseInfo.h
-        arch/AArch64/AArch64Disassembler.h
+        arch/AArch64/AArch64DisassemblerExtension.h
         arch/AArch64/AArch64InstPrinter.h
+        arch/AArch64/AArch64Linkage.h
         arch/AArch64/AArch64Mapping.h
         arch/AArch64/AArch64GenAsmWriter.inc
         arch/AArch64/AArch64GenDisassemblerTables.inc
         arch/AArch64/AArch64GenInstrInfo.inc
         arch/AArch64/AArch64GenRegisterInfo.inc
         arch/AArch64/AArch64GenRegisterName.inc
-        arch/AArch64/AArch64GenRegisterV.inc
         arch/AArch64/AArch64GenSubtargetInfo.inc
         arch/AArch64/AArch64GenSystemOperands.inc
-        arch/AArch64/AArch64GenSystemOperands_enum.inc
-        arch/AArch64/AArch64MappingInsn.inc
-        arch/AArch64/AArch64MappingInsnName.inc
-        arch/AArch64/AArch64MappingInsnOp.inc
+        arch/AArch64/AArch64GenCSMappingInsn.inc
+        arch/AArch64/AArch64GenCSMappingInsnName.inc
+        arch/AArch64/AArch64GenCSMappingInsnOp.inc
     )
-    set(TEST_SOURCES ${TEST_SOURCES} test_arm64.c)
+    set(TEST_SOURCES ${TEST_SOURCES} test_aarch64.c)
 endif()
 
 if(CAPSTONE_MIPS_SUPPORT)
@@ -253,19 +253,23 @@ if(CAPSTONE_PPC_SUPPORT)
         arch/PowerPC/PPCModule.c
     )
     set(HEADERS_PPC
-        arch/PowerPC/PPCDisassembler.h
-        arch/PowerPC/PPCGenAsmWriter.inc
+        arch/PowerPC/PPCInstrInfo.h
         arch/PowerPC/PPCInstPrinter.h
+        arch/PowerPC/PPCLinkage.h
         arch/PowerPC/PPCMapping.h
+        arch/PowerPC/PPCMCTargetDesc.h
         arch/PowerPC/PPCPredicates.h
+        arch/PowerPC/PPCRegisterInfo.h
         arch/PowerPC/PPCGenAsmWriter.inc
-        arch/PowerPC/PPCGenRegisterName.inc
+        arch/PowerPC/PPCGenCSFeatureName.inc
+        arch/PowerPC/PPCGenCSMappingInsn.inc
+        arch/PowerPC/PPCGenCSMappingInsnOp.inc
+        arch/PowerPC/PPCGenCSMappingInsnName.inc
+        arch/PowerPC/PPCGenCSOpGroup.inc
         arch/PowerPC/PPCGenDisassemblerTables.inc
-        arch/PowerPC/PPCMappingInsn.inc
-        arch/PowerPC/PPCMappingInsnName.inc
+        arch/PowerPC/PPCGenInstrInfo.inc
         arch/PowerPC/PPCGenSubtargetInfo.inc
         arch/PowerPC/PPCGenRegisterInfo.inc
-        arch/PowerPC/PPCGenInstrInfo.inc
     )
     set(TEST_SOURCES ${TEST_SOURCES} test_ppc.c)
 endif()
@@ -572,7 +576,7 @@ endif()
 set(ALL_SOURCES
     ${SOURCES_ENGINE}
     ${SOURCES_ARM}
-    ${SOURCES_ARM64}
+    ${SOURCES_AARCH64}
     ${SOURCES_MIPS}
     ${SOURCES_PPC}
     ${SOURCES_X86}
@@ -595,7 +599,7 @@ set(ALL_HEADERS
     ${HEADERS_COMMON}
     ${HEADERS_ENGINE}
     ${HEADERS_ARM}
-    ${HEADERS_ARM64}
+    ${HEADERS_AARCH64}
     ${HEADERS_MIPS}
     ${HEADERS_PPC}
     ${HEADERS_X86}
@@ -658,7 +662,7 @@ endif()
 
 source_group("Source\\Engine" FILES ${SOURCES_ENGINE})
 source_group("Source\\ARM" FILES ${SOURCES_ARM})
-source_group("Source\\ARM64" FILES ${SOURCES_ARM64})
+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})
@@ -679,7 +683,7 @@ source_group("Source\\TriCore" FILES ${SOURCES_TRICORE})
 source_group("Include\\Common" FILES ${HEADERS_COMMON})
 source_group("Include\\Engine" FILES ${HEADERS_ENGINE})
 source_group("Include\\ARM" FILES ${HEADERS_ARM})
-source_group("Include\\ARM64" FILES ${HEADERS_ARM64})
+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})

COMPILE.TXT

@@ -148,7 +148,7 @@ Capstone requires no prerequisite packages, so it is easy to compile & install.
 (5) Cross-compile for Android
 
   To cross-compile for Android (smartphone/tablet), Android NDK is required.
-  NOTE: Only ARM and ARM64 are currently supported.
+  NOTE: Only ARM and AARCH64 are currently supported.
 
 	$ NDK=/android/android-ndk-r10e ./make.sh cross-android arm
   or

COMPILE_CMAKE.TXT

@@ -20,7 +20,7 @@ Get CMake for free from http://www.cmake.org.
   run "cmake" with the unwanted archs disabled (set to 0) as followings.
 
   - CAPSTONE_ARM_SUPPORT: support ARM. Run cmake with -DCAPSTONE_ARM_SUPPORT=0 to remove ARM.
-  - CAPSTONE_ARM64_SUPPORT: support ARM64. Run cmake with -DCAPSTONE_ARM64_SUPPORT=0 to remove ARM64.
+  - CAPSTONE_AARCH64_SUPPORT: support AARCH64. Run cmake with -DCAPSTONE_AARCH64_SUPPORT=0 to remove AARCH64.
   - CAPSTONE_M680X_SUPPORT: support M680X. Run cmake with -DCAPSTONE_M680X_SUPPORT=0 to remove M680X.
   - CAPSTONE_M68K_SUPPORT: support M68K. Run cmake with -DCAPSTONE_M68K_SUPPORT=0 to remove M68K.
   - CAPSTONE_MIPS_SUPPORT: support Mips. Run cmake with -DCAPSTONE_MIPS_SUPPORT=0 to remove Mips.
@@ -112,7 +112,7 @@ Get CMake for free from http://www.cmake.org.
     ../cmake.sh x86
 
   Will just target the x86 architecture. The list of available architectures is: ARM,
-  ARM64, M68K, MIPS, PowerPC, Sparc, SystemZ, XCore, x86, TMS320C64x, M680x, EVM, MOS65XX,
+  AARCH64, M68K, MIPS, PowerPC, Sparc, SystemZ, XCore, x86, TMS320C64x, M680x, EVM, MOS65XX,
   WASM, BPF, RISCV.
 
 (4) You can also create an installation image with cmake, by using the 'install' target.

COMPILE_MSVC.TXT

@@ -31,7 +31,7 @@ versions, and Windows Driver Kit 8.1 Update 1 or newer versions are required.
   to customize Capstone library, as followings.
 
   - CAPSTONE_HAS_ARM: support ARM. Delete this to remove ARM support.
-  - CAPSTONE_HAS_ARM64: support ARM64. Delete this to remove ARM64 support.
+  - CAPSTONE_HAS_AARCH64: support AARCH64. Delete this to remove AARCH64 support.
   - CAPSTONE_HAS_M68K: support M68K. Delete this to remove M68K support.
   - CAPSTONE_HAS_MIPS: support Mips. Delete this to remove Mips support.
   - CAPSTONE_HAS_POWERPC: support PPC. Delete this to remove PPC support.

HACK.TXT

@@ -5,7 +5,7 @@ Capstone source is organized as followings.
 
 .                   <- core engine + README + COMPILE.TXT etc
 ├── arch            <- code handling disasm engine for each arch
-│   ├── AArch64     <- ARM64 (aka ARMv8) engine
+│   ├── AArch64     <- AArch64 engine
 │   ├── ARM         <- ARM engine
 │   ├── BPF         <- Berkeley Packet Filter engine
 │   ├── EVM         <- Ethereum engine

MCInst.c

@@ -34,6 +34,8 @@ void MCInst_Init(MCInst *inst)
 	inst->xAcquireRelease = 0;
 	for (int i = 0; i < MAX_MC_OPS; ++i)
 		inst->tied_op_idx[i] = -1;
+	inst->isAliasInstr = false;
+	inst->fillDetailOps = false;
 }
 
 void MCInst_clear(MCInst *inst)
@@ -142,7 +144,7 @@ void MCOperand_setReg(MCOperand *op, unsigned Reg)
 	op->RegVal = Reg;
 }
 
-int64_t MCOperand_getImm(MCOperand *op)
+int64_t MCOperand_getImm(const MCOperand *op)
 {
 	return op->ImmVal;
 }
@@ -280,3 +282,20 @@ uint64_t MCInst_getOpVal(MCInst *MI, unsigned OpNum)
 	else
 		assert(0 && "Operand type not handled in this getter.");
 }
+
+void MCInst_setIsAlias(MCInst *MI, bool Flag) {
+	assert(MI);
+	MI->isAliasInstr = Flag;
+	MI->flat_insn->is_alias = Flag;
+}
+
+/// @brief Copies the relevant members of a temporary MCInst to
+/// the main MCInst. This is used if TryDecode was run on a temporary MCInst.
+/// @param MI The main MCInst
+/// @param TmpMI The temporary MCInst.
+void MCInst_updateWithTmpMI(MCInst *MI, MCInst *TmpMI) {
+	MI->size = TmpMI->size;
+	MI->Opcode = TmpMI->Opcode;
+	assert(MI->size < MAX_MC_OPS);
+	memcpy(MI->Operands, TmpMI->Operands, sizeof(MI->Operands[0]) * MI->size);
+}

MCInst.h

@@ -68,7 +68,7 @@ unsigned MCOperand_getReg(const MCOperand *op);
 /// setReg - Set the register number.
 void MCOperand_setReg(MCOperand *op, unsigned Reg);
 
-int64_t MCOperand_getImm(MCOperand *op);
+int64_t MCOperand_getImm(const MCOperand *op);
 
 void MCOperand_setImm(MCOperand *op, int64_t Val);
 
@@ -129,6 +129,8 @@ struct MCInst {
 	cs_wasm_op wasm_data;    // for WASM operand
 	MCRegisterInfo *MRI;
 	uint8_t xAcquireRelease;   // X86 xacquire/xrelease
+	bool isAliasInstr; // Flag if this MCInst is an alias.
+	bool fillDetailOps; // If set, detail->operands gets filled.
 };
 
 void MCInst_Init(MCInst *inst);
@@ -163,4 +165,12 @@ bool MCInst_opIsTying(const MCInst *MI, unsigned OpNum);
 
 uint64_t MCInst_getOpVal(MCInst *MI, unsigned OpNum);
 
+void MCInst_setIsAlias(MCInst *MI, bool Flag);
+
+static inline bool MCInst_isAlias(const MCInst *MI) {
+	return MI->isAliasInstr;
+}
+
+void MCInst_updateWithTmpMI(MCInst *MI, MCInst *TmpMI);
+
 #endif

MCInstPrinter.c

@@ -6,15 +6,27 @@
 #include <capstone/platform.h>
 
 extern bool ARM_getFeatureBits(unsigned int mode, unsigned int feature);
+extern bool PPC_getFeatureBits(unsigned int mode, unsigned int feature);
+extern bool AArch64_getFeatureBits(unsigned int mode, unsigned int feature);
 
 static bool testFeatureBits(const MCInst *MI, uint32_t Value)
 {
 	assert(MI && MI->csh);
 	switch (MI->csh->arch) {
 	default:
 		assert(0 && "Not implemented for current arch.");
+#ifdef CAPSTONE_HAS_ARM
 	case CS_ARCH_ARM:
 		return ARM_getFeatureBits(MI->csh->mode, Value);
+#endif
+#ifdef CAPSTONE_HAS_PPC
+	case CS_ARCH_PPC:
+		return PPC_getFeatureBits(MI->csh->mode, Value);
+#endif
+#ifdef CAPSTONE_HAS_AARCH64
+	case CS_ARCH_AARCH64:
+		return AArch64_getFeatureBits(MI->csh->mode, Value);
+#endif
 	}
 }
 
@@ -180,6 +192,11 @@ unsigned int binsearch_IndexTypeEncoding(const struct IndexType *index, size_t s
 	while(left <= right) {
 		m = (left + right) / 2;
 		if (encoding == index[m].encoding) {
+			// LLVM actually uses lower_bound for the index table search
+			// Here we need to check if a previous entry is of the same encoding
+			// and return the first one.
+			while (m > 0 && encoding == index[m - 1].encoding)
+				--m;
 			return m;
 		}
 
@@ -213,6 +230,11 @@ unsigned int binsearch_IndexTypeStrEncoding(const struct IndexTypeStr *index, si
 	while(left <= right) {
 		m = (left + right) / 2;
 		if (strcmp(name, index[m].name) == 0) {
+			// LLVM actually uses lower_bound for the index table search
+			// Here we need to check if a previous entry is of the same encoding
+			// and return the first one.
+			while (m > 0 && (strcmp(name, index[m - 1].name) == 0))
+				--m;
 			return m;
 		}
 

Makefile

@@ -126,14 +126,15 @@ ifneq (,$(findstring arm,$(CAPSTONE_ARCHS)))
 	LIBOBJ_ARM += $(LIBSRC_ARM:%.c=$(OBJDIR)/%.o)
 endif
 
-DEP_ARM64 =
-DEP_ARM64 += $(wildcard arch/AArch64/AArch64*.inc)
+DEP_AARCH64 =
+DEP_AARCH64 += $(wildcard arch/AArch64/AArch64*.inc)
 
-LIBOBJ_ARM64 =
+LIBOBJ_AARCH64 =
 ifneq (,$(findstring aarch64,$(CAPSTONE_ARCHS)))
 	CFLAGS += -DCAPSTONE_HAS_ARM64
-	LIBSRC_ARM64 += $(wildcard arch/AArch64/AArch64*.c)
-	LIBOBJ_ARM64 += $(LIBSRC_ARM64:%.c=$(OBJDIR)/%.o)
+	CFLAGS += -DCAPSTONE_HAS_AARCH64
+	LIBSRC_AARCH64 += $(wildcard arch/AArch64/AArch64*.c)
+	LIBOBJ_AARCH64 += $(LIBSRC_AARCH64:%.c=$(OBJDIR)/%.o)
 endif
 
 
@@ -327,7 +328,7 @@ endif
 
 LIBOBJ =
 LIBOBJ += $(OBJDIR)/cs.o $(OBJDIR)/utils.o $(OBJDIR)/SStream.o $(OBJDIR)/MCInstrDesc.o $(OBJDIR)/MCRegisterInfo.o $(OBJDIR)/MCInst.o $(OBJDIR)/MCInstPrinter.o $(OBJDIR)/Mapping.o
-LIBOBJ += $(LIBOBJ_ARM) $(LIBOBJ_ARM64) $(LIBOBJ_M68K) $(LIBOBJ_MIPS) $(LIBOBJ_PPC) $(LIBOBJ_RISCV) $(LIBOBJ_SPARC) $(LIBOBJ_SYSZ) $(LIBOBJ_SH)
+LIBOBJ += $(LIBOBJ_ARM) $(LIBOBJ_AARCH64) $(LIBOBJ_M68K) $(LIBOBJ_MIPS) $(LIBOBJ_PPC) $(LIBOBJ_RISCV) $(LIBOBJ_SPARC) $(LIBOBJ_SYSZ) $(LIBOBJ_SH)
 LIBOBJ += $(LIBOBJ_X86) $(LIBOBJ_XCORE) $(LIBOBJ_TMS320C64X) $(LIBOBJ_M680X) $(LIBOBJ_EVM) $(LIBOBJ_MOS65XX) $(LIBOBJ_WASM) $(LIBOBJ_BPF)
 LIBOBJ += $(LIBOBJ_TRICORE)
 
@@ -448,7 +449,7 @@ endif
 $(LIBOBJ): config.mk
 
 $(LIBOBJ_ARM): $(DEP_ARM)
-$(LIBOBJ_ARM64): $(DEP_ARM64)
+$(LIBOBJ_AARCH64): $(DEP_AARCH64)
 $(LIBOBJ_M68K): $(DEP_M68K)
 $(LIBOBJ_MIPS): $(DEP_MIPS)
 $(LIBOBJ_PPC): $(DEP_PPC)