AArch64 update to LLVM 18 (#2298)

* Run clang-format

* Remove arm.h header from AArch64 files

* Update all AArch64 module files to LLVM-18.

* Add check if the differs save file is up-to-date with the current files.

* Add new generator for MC test trnaslation.

* Fix warnings

* Update generated AsmWriter files

* Remove unused variable

* Change MCPhysReg type to int16_t as LLVM 18 dictates.

With LLVM 18 the MCPhysReg value's type is changed to int16_t.
If we update modules to LLVM 18, they will generate
compiler warnings that uint16_t* should not be casted to int16_t*.

This makes changing the all tables to int16_t necessary, because the alternative is
to duplicate all MCPhysReg related code. Which is even worse.

* Assign enum values to raw_struct member

* Add printAdrAdrpLabel def

* Add header to regression test files.

* Write files to build dir and ignore more parsing errors.

* Fix parsing of MC test files.

* Reset parser after every block

* Add write and patch header step.

* Add and update MC tests for AArch64

* Fix clang-tidy warnings

* Don't warn about padding issues.

They break automatically initialized structs we can not change easily.

* Fix: Incorrect access of LLVM instruction descriptions.

* Initialize DecoderComplete flag

* Add more mapping and flag details

* Add function to get MCInstDesc from table

* Fix incorrect memory operand access types.

* Fix test where memory was not written, ut only read.

* Attempt to fix Windows build

* Fix 2268

The enum values were different and hence lead to different decoding.

* Refactor SME operands.

- Splits SME operands in Matrix and Predicate operands.
- Fixes general problems of incorrect detections with
the vector select/index operands of predicate registers.
- Simplifies code.

* Fix up typo in WRITE

* Print actual path to struct fields

* Add Registers of SME operands to the reg-read list

* Add tests for SME operands.

* Use Capstone reg enum for comparison

* Fix tests: 'Vector arra...' to 'operands[x].vas'

* Add the developer fuzz option.

* Fix Python bindings for SME operands

* Fix variable shadowing.

* Fix clang-tidy warnings

* Add missing break.

* Fix varg usage

* Brackets for case

* Handle AArch64_OP_GROUP_AdrAdrpLabel

* Fix endian issue with fuzzing start bytes

* Move previous sme.pred to it's own operand type.

* Fix calculation for imm ranges

* Print list member flag

* Fix up operand strings for cstest

* Do only a shallow clone of the cmocka stable branch

* Fix: Don't categorize ZT0 as a SME matrix operand.

* Remove unused code.

* Add flag to distinguish Vn and Qn registers.

* Add all registers to detail struct, even if emitted in the asm text

* Fix: Increment op count after each list member is added.

* Remove implicit write to NZCV for MSR Imm instructions.

* Handle several alias operands.

* Add details for zero alias with za0.h

* Add SME tile to write list if written

* Add write access flags to operands which are zeroed.

* Add SME tests of #2285

* Fix tests with latest syntax changes.

* Fix segfault if memory operand is only a label without register.

* Fix python bindings

* Attempt to fix clang-tidy warning for some configurations.

* Add missing test file (accidentially blocked by gitignore.)

* Print clang-tidy version before linting.

* Update differ save file

* Formatting

* Use clang-tidy-15 as if possible.

* Remove search patterns for MC tests, since they need to be reworked anyways.

* Enum to upper case change

* Add information to read the OSS fuzz result.

* Fix special case of SVE2 operands.

Apparently ZT0 registers can an index attached,
get which is BOUND to it. We have no "index for reg" field.
So it is simply saved as an immediate.

* Handle LLVM expressions without asserts.

* Ensure choices are always saved.

* OP_GROUP enums can't be all upper case because they contain type information.

* Fix compatibility header patching

* Update saved_choices.json

* Allow mode == None in test_corpus

.github/workflows/CITest.yml

@@ -132,7 +132,6 @@ jobs:
           clang -lcapstone src/test_arm64_compatibility_header.c -o test_arm64_compatibility_header
         fi
         ./test_arm64_compatibility_header
-        cd "$(git rev-parse --show-toplevel)"
 
     - name: cstool - reaches disassembler engine
       run: |

.github/workflows/auto-sync.yml

@@ -66,3 +66,8 @@ jobs:
       - name: Test Header patcher
         run: |
           python -m unittest src/autosync/Tests/test_header_patcher.py
+          python -m unittest src/autosync/Tests/test_mcupdater.py
+
+      - name: Differ - Test save file is up-to-date
+        run: |
+          ./src/autosync/cpptranslator/Differ.py -a AArch64 --check_saved

.github/workflows/clang-tidy.yml

@@ -26,6 +26,10 @@ jobs:
         CC=clang sudo cmake --build . --config Release
         cd ..
 
+    - name: Install clang-tidy-15
+      run: |
+        sudo apt install clang-tidy-15
+
     - name: Check for warnings
       env:
         base_sha: ${{ github.event.pull_request.base.sha }}

CMakeLists.txt

@@ -890,6 +890,7 @@ if(CAPSTONE_BUILD_CSTEST)
         PREFIX extern
         GIT_REPOSITORY "https://git.cryptomilk.org/projects/cmocka.git"
         GIT_TAG "origin/stable-1.1"
+        GIT_SHALLOW true
         CONFIGURE_COMMAND cmake -DBUILD_SHARED_LIBS=OFF ../cmocka_ext/
         BUILD_COMMAND cmake --build . --config Release
         INSTALL_COMMAND ""

MCInst.c

@@ -1,6 +1,5 @@
 /* Capstone Disassembly Engine */
 /* By Nguyen Anh Quynh <[email protected]>, 2013-2019 */
-
 #if defined(CAPSTONE_HAS_OSXKERNEL)
 #include <Availability.h>
 #include <libkern/libkern.h>
@@ -11,6 +10,7 @@
 #include <string.h>
 #include <assert.h>
 
+#include "MCInstrDesc.h"
 #include "MCInst.h"
 #include "utils.h"
 
@@ -105,12 +105,12 @@ bool MCOperand_isValid(const MCOperand *op)
 
 bool MCOperand_isReg(const MCOperand *op)
 {
-	return op->Kind == kRegister;
+	return op->Kind == kRegister || op->MachineOperandType == kRegister;
 }
 
 bool MCOperand_isImm(const MCOperand *op)
 {
-	return op->Kind == kImmediate;
+	return op->Kind == kImmediate || op->MachineOperandType == kImmediate;
 }
 
 bool MCOperand_isFPImm(const MCOperand *op)
@@ -224,16 +224,26 @@ bool MCInst_isPredicable(const MCInstrDesc *MIDesc)
 /// Checks if tied operands exist in the instruction and sets
 /// - The writeback flag in detail
 /// - Saves the indices of the tied destination operands.
-void MCInst_handleWriteback(MCInst *MI, const MCInstrDesc *InstDesc)
-{
-	const MCOperandInfo *OpInfo = InstDesc[MCInst_getOpcode(MI)].OpInfo;
-	unsigned short NumOps = InstDesc[MCInst_getOpcode(MI)].NumOperands;
+void MCInst_handleWriteback(MCInst *MI, const MCInstrDesc *InstDescTable, unsigned tbl_size)
+{
+	const MCInstrDesc *InstDesc = NULL;
+	const MCOperandInfo *OpInfo = NULL;
+	unsigned short NumOps = 0;
+	if (MI->csh->arch == CS_ARCH_ARM) {
+		// Uses old (pre LLVM 18) indexing method.
+		InstDesc = &InstDescTable[MCInst_getOpcode(MI)];
+		OpInfo = InstDescTable[MCInst_getOpcode(MI)].OpInfo;
+		NumOps = InstDescTable[MCInst_getOpcode(MI)].NumOperands;
+	} else {
+		InstDesc = MCInstrDesc_get(MCInst_getOpcode(MI), InstDescTable, tbl_size);
+		OpInfo = MCInstrDesc_get(MCInst_getOpcode(MI), InstDescTable, tbl_size)->OpInfo;
+		NumOps = MCInstrDesc_get(MCInst_getOpcode(MI), InstDescTable, tbl_size)->NumOperands;
+	}
 
-	unsigned i;
-	for (i = 0; i < NumOps; ++i) {
+	for (unsigned i = 0; i < NumOps; ++i) {
 		if (MCOperandInfo_isTiedToOp(&OpInfo[i])) {
 			int idx = MCOperandInfo_getOperandConstraint(
-				&InstDesc[MCInst_getOpcode(MI)], i,
+				InstDesc, i,
 				MCOI_TIED_TO);
 
 			if (idx == -1)

MCInst.h

@@ -159,7 +159,7 @@ void MCInst_addOperand2(MCInst *inst, MCOperand *Op);
 
 bool MCInst_isPredicable(const MCInstrDesc *MIDesc);
 
-void MCInst_handleWriteback(MCInst *MI, const MCInstrDesc *InstDesc);
+void MCInst_handleWriteback(MCInst *MI, const MCInstrDesc *InstDescTable, unsigned tbl_size);
 
 bool MCInst_opIsTied(const MCInst *MI, unsigned OpNum);
 

MCInstrDesc.c

@@ -38,4 +38,11 @@ int MCOperandInfo_getOperandConstraint(const MCInstrDesc *InstrDesc,
 		return (OpInfo.Constraints >> ValuePos) & 0xf;
 	}
 	return -1;
-}
+}
+
+/// Returns the instruction description for the given MCInst opcode.
+/// Function should be called like:
+/// MCInstrDesc_get(MCInst_getOpcode(MI), ARCHInstDesc, ARR_SIZE(ARCHInstDesc));
+const MCInstrDesc *MCInstrDesc_get(unsigned opcode, const MCInstrDesc *table, unsigned tbl_size) {
+	return &table[tbl_size - 1 - opcode];
+}

MCInstrDesc.h

@@ -163,5 +163,9 @@ bool MCOperandInfo_isTiedToOp(const MCOperandInfo *m);
 int MCOperandInfo_getOperandConstraint(const MCInstrDesc *OpInfo,
 				       unsigned OpNum,
 				       MCOI_OperandConstraint Constraint);
+const MCInstrDesc *MCInstrDesc_get(unsigned opcode,
+                                   const MCInstrDesc *table,
+                                   unsigned tbl_size);
+
 
 #endif

MCRegisterInfo.h

@@ -23,7 +23,7 @@
 
 /// An unsigned integer type large enough to represent all physical registers,
 /// but not necessarily virtual registers.
-typedef uint16_t MCPhysReg;
+typedef int16_t MCPhysReg;
 typedef const MCPhysReg* iterator;
 
 typedef struct MCRegisterClass2 {

Mapping.h

@@ -31,6 +31,7 @@ typedef struct insn_map {
 	union {
 		ppc_suppl_info ppc;
 		loongarch_suppl_info loongarch;
+		aarch64_suppl_info aarch64;
 	} suppl_info; // Supplementary information for each instruction.
 #endif
 } insn_map;