Initial auto-sync LoongArch support (#2349)

* Initial auto-sync LoongArch support - Accompanied llvm changes: capstone-engine/llvm-capstone#45 - MC Tests are generated from llvm - Instruction groups are implemented - Register accesses are implemented - Memory operands are handled for memory instructions - Code are formatted using clang-format of LLVM 17 - Import tests from LLVM MC - Collect operand type and access - Collect registers read/modified --------- Co-authored-by: CoA <1109673069@qq.com> * Ensure same indent for all patched lines. * Emit upper case OP_GROUP enum * Spell all enum values in capital letters. * Capticalize enums in loongarch_detail.c * Add test which contains now a tab. * Run clang-format on test_loongarch.c --------- Co-authored-by: CoA <1109673069@qq.com> Co-authored-by: Rot127 <unisono@quyllur.org>
capstone-engine · Jun 26, 2024 · 95966a1 · 95966a1
1 parent a3fd6ac
commit 95966a1
Show file tree

Hide file tree

Showing 229 changed files with 60,695 additions and 58 deletions.
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -64,6 +64,13 @@ HPPA:
   - suite/MC/HPPA/*
   - tests/test_hppa.c
 
+LoongArch:
+  - arch/LoongArch/*
+  - cstool/cstool_loongarch.c
+  - include/capstone/loongarch.h
+  - suite/MC/LoongArch/*
+  - tests/test_loongarch.c
+
 M680X:
   - arch/M680X/*
   - cstool/cstool_m680x.c

diff --git a/.github/workflows/auto-sync.yml b/.github/workflows/auto-sync.yml
@@ -46,6 +46,7 @@ jobs:
           ./src/autosync/ASUpdater.py -d -a Alpha -s IncGen
           ./src/autosync/ASUpdater.py -d -a ARM -s IncGen
           ./src/autosync/ASUpdater.py -d -a PPC -s IncGen
+          ./src/autosync/ASUpdater.py -d -a LoongArch -s IncGen
 
       - name: CppTranslator - Patch tests
         run: |
@@ -60,6 +61,7 @@ jobs:
           ./src/autosync/ASUpdater.py --ci -d -a AArch64 -s Translate
           ./src/autosync/ASUpdater.py --ci -d -a ARM -s Translate
           ./src/autosync/ASUpdater.py --ci -d -a PPC -s Translate
+          ./src/autosync/ASUpdater.py --ci -d -a LoongArch -s Translate
 
       - name: Test Header patcher
         run: |

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -81,8 +81,8 @@ 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)
-set(SUPPORTED_ARCHITECTURE_LABELS ARM AARCH64 M68K MIPS PowerPC Sparc SystemZ XCore x86 TMS320C64x M680x EVM MOS65XX WASM BPF RISCV SH TriCore Alpha HPPA)
+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_ARCHITECTURE_LABELS ARM AARCH64 M68K MIPS PowerPC Sparc SystemZ XCore x86 TMS320C64x M680x EVM MOS65XX WASM BPF RISCV SH TriCore Alpha HPPA LoongArch)
 
 list(LENGTH SUPPORTED_ARCHITECTURES count)
 math(EXPR count "${count}-1")
@@ -188,6 +188,7 @@ set(HEADERS_COMMON
     include/capstone/sh.h
     include/capstone/alpha.h
     include/capstone/hppa.h
+    include/capstone/loongarch.h
 )
 
 set(TEST_SOURCES test_basic.c test_detail.c test_skipdata.c test_iter.c)
@@ -654,6 +655,24 @@ if(CAPSTONE_HPPA_SUPPORT)
     set(TEST_SOURCES ${TEST_SOURCES} test_hppa.c)
 endif()
 
+if (CAPSTONE_LOONGARCH_SUPPORT)
+    add_definitions(-DCAPSTONE_HAS_LOONGARCH)
+    set(SOURCES_LOONGARCH
+            arch/LoongArch/LoongArchDisassembler.c
+            arch/LoongArch/LoongArchDisassemblerExtension.c
+            arch/LoongArch/LoongArchInstPrinter.c
+            arch/LoongArch/LoongArchMapping.c
+            arch/LoongArch/LoongArchModule.c
+            )
+    set(HEADERS_LOONGARCH
+            arch/LoongArch/LoongArchInstPrinter.h
+            arch/LoongArch/LoongArchMapping.h
+            arch/LoongArch/LoongArchModule.h
+            arch/LoongArch/LoongArchLinkage.h
+            )
+    set(TEST_SOURCES ${TEST_SOURCES} test_loongarch.c)
+endif ()
+
 if (CAPSTONE_OSXKERNEL_SUPPORT)
     add_definitions(-DCAPSTONE_HAS_OSXKERNEL)
 endif()
@@ -680,6 +699,7 @@ set(ALL_SOURCES
     ${SOURCES_TRICORE}
     ${SOURCES_ALPHA}
     ${SOURCES_HPPA}
+    ${SOURCES_LOONGARCH}
 )
 
 set(ALL_HEADERS
@@ -705,6 +725,7 @@ set(ALL_HEADERS
     ${HEADERS_TRICORE}
     ${HEADERS_ALPHA}
     ${HEADERS_HPPA}
+    ${HEADERS_LOONGARCH}
 )
 
 ## properties
@@ -770,6 +791,7 @@ source_group("Source\\SH" FILES ${SOURCES_SH})
 source_group("Source\\TriCore" FILES ${SOURCES_TRICORE})
 source_group("Source\\Alpha" FILES ${SOURCES_ALPHA})
 source_group("Source\\HPPA" FILES ${SOURCES_HPPA})
+source_group("Source\\LoongArch" FILES ${SOURCES_LOONGARCH})
 
 source_group("Include\\Common" FILES ${HEADERS_COMMON})
 source_group("Include\\Engine" FILES ${HEADERS_ENGINE})
@@ -793,6 +815,7 @@ source_group("Include\\SH" FILES ${HEADERS_SH})
 source_group("Include\\TriCore" FILES ${HEADERS_TRICORE})
 source_group("Include\\Alpha" FILES ${HEADERS_ALPHA})
 source_group("Include\\HPPA" FILES ${HEADERS_HPPA})
+source_group("Include\\LoongArch" FILES ${HEADERS_LOONGARCH})
 
 ## installation
 if(CAPSTONE_INSTALL)

diff --git a/COMPILE.TXT b/COMPILE.TXT
@@ -90,6 +90,7 @@ Capstone requires no prerequisite packages, so it is easy to compile & install.
 	/usr/include/capstone/capstone.h
 	/usr/include/capstone/evm.h
 	/usr/include/capstone/hppa.h
+	/usr/include/capstone/loongarch.h
 	/usr/include/capstone/m680x.h
 	/usr/include/capstone/m68k.h
 	/usr/include/capstone/mips.h

diff --git a/COMPILE_CMAKE.TXT b/COMPILE_CMAKE.TXT
@@ -23,6 +23,7 @@ Get CMake for free from http://www.cmake.org.
   - CAPSTONE_AARCH64_SUPPORT: support AARCH64. Run cmake with -DCAPSTONE_AARCH64_SUPPORT=0 to remove AARCH64.
   - CAPSTONE_ALPHA_SUPPORT: support Alpha. Run cmake with -DCAPSTONE_ALPHA_SUPPORT=0 to remove Alpha.
   - CAPSTONE_HPPA_SUPPORT: support HPPA. Run cmake with -DCAPSTONE_HPPA_SUPPORT=0 to remove HPPA.
+  - CAPSTONE_LOONGARCH_SUPPORT: support LoongArch. Run cmake with -DCAPSTONE_LOONGARCH_SUPPORT=0 to remove LoongArch.
   - 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.
@@ -120,7 +121,7 @@ Get CMake for free from http://www.cmake.org.
 
   Will just target the x86 architecture. The list of available architectures is: ARM,
   AARCH64, M68K, MIPS, PowerPC, Sparc, SystemZ, XCore, x86, TMS320C64x, M680x, EVM, MOS65XX,
-  WASM, BPF, RISCV, Alpha, HPPA.
+  WASM, BPF, RISCV, Alpha, HPPA, LoongArch.
 
 (4) You can also create an installation image with cmake, by using the 'install' target.
   Use:

diff --git a/CREDITS.TXT b/CREDITS.TXT
@@ -88,4 +88,5 @@ fanfuqiang & citypw & porto703 : RISCV architecture.
 Josh "blacktop" Maine: Arm64 architecture improvements.
 Finn Wilkinson: AArch64 update to Armv9.2-a (SME + SVE2 support)
 Billow & Sidneyp : TriCore architecture.
-Dmitry Sibirtsev: Alpha & HPPA architecture.
+Dmitry Sibirtsev: Alpha & HPPA architecture.
+Jiajie Chen & Yanglin Xun: LoongArch architecture.
diff --git a/MCInst.h b/MCInst.h
@@ -26,6 +26,7 @@
 typedef struct MCInst MCInst;
 typedef struct cs_struct cs_struct;
 typedef struct MCOperand MCOperand;
+typedef unsigned MCRegister;
 
 /// MCOperand - Instances of this class represent operands of the MCInst class.
 /// This is a simple discriminated union.

diff --git a/Makefile b/Makefile
@@ -345,12 +345,21 @@ ifneq (,$(findstring hppa,$(CAPSTONE_ARCHS)))
 	LIBOBJ_HPPA += $(LIBSRC_HPPA:%.c=$(OBJDIR)/%.o)
 endif
 
+DEP_LOONGARCH =
+DEP_LOONGARCH += $(wildcard arch/LoongArch/LoongArch*.inc)
+
+LIBOBJ_LOONGARCH =
+ifneq (,$(findstring loongarch,$(CAPSTONE_ARCHS)))
+	CFLAGS += -DCAPSTONE_HAS_LOONGARCH
+	LIBSRC_LOONGARCH += $(wildcard arch/LoongArch/LoongArch*.c)
+	LIBOBJ_LOONGARCH += $(LIBSRC_LOONGARCH:%.c=$(OBJDIR)/%.o)
+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_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) $(LIBOBJ_ALPHA) $(LIBOBJ_HPPA)
+LIBOBJ += $(LIBOBJ_TRICORE) $(LIBOBJ_ALPHA) $(LIBOBJ_HPPA) $(LIBOBJ_LOONGARCH)
 
 
 ifeq ($(PKG_EXTRA),)
@@ -488,6 +497,7 @@ $(LIBOBJ_BPF): $(DEP_BPF)
 $(LIBOBJ_TRICORE): $(DEP_TRICORE)
 $(LIBOBJ_ALPHA): $(DEP_ALPHA)
 $(LIBOBJ_HPPA): $(DEP_HPPA)
+$(LIBOBJ_LOONGARCH): $(DEP_LOONGARCH)
 
 ifeq ($(CAPSTONE_STATIC),yes)
 $(ARCHIVE): $(LIBOBJ)
@@ -575,11 +585,13 @@ dist:
 
 TESTS  = test_basic test_detail test_arm test_aarch64 test_m68k test_mips test_ppc test_sparc test_tricore test_hppa
 TESTS += test_systemz test_x86 test_xcore test_iter test_evm test_riscv test_mos65xx test_wasm test_bpf test_alpha
+TESTS += test_loongarch
 TESTS += test_basic.static test_detail.static test_arm.static test_aarch64.static
 TESTS += test_m68k.static test_mips.static test_ppc.static test_sparc.static
 TESTS += test_systemz.static test_x86.static test_xcore.static test_m680x.static
 TESTS += test_skipdata test_skipdata.static test_iter.static test_evm.static test_riscv.static
 TESTS += test_mos65xx.static test_wasm.static test_bpf.static test_alpha.static test_hppa.static
+TESTS += test_loongarch.static
 
 check: $(TESTS)
 

diff --git a/Mapping.c b/Mapping.c
@@ -337,6 +337,7 @@ DEFINE_get_detail_op(tricore, TriCore);
 DEFINE_get_detail_op(aarch64, AArch64);
 DEFINE_get_detail_op(alpha, Alpha);
 DEFINE_get_detail_op(hppa, HPPA);
+DEFINE_get_detail_op(loongarch, LoongArch);
 
 /// Returns true if for this architecture the
 /// alias operands should be filled.

diff --git a/Mapping.h b/Mapping.h
@@ -30,6 +30,7 @@ typedef struct insn_map {
 	bool indirect_branch;	  // indirect branch instruction?
 	union {
 		ppc_suppl_info ppc;
+		loongarch_suppl_info loongarch;
 	} suppl_info; // Supplementary information for each instruction.
 #endif
 } insn_map;
@@ -135,6 +136,7 @@ DECL_get_detail_op(tricore, TriCore);
 DECL_get_detail_op(aarch64, AArch64);
 DECL_get_detail_op(alpha, Alpha);
 DECL_get_detail_op(hppa, HPPA);
+DECL_get_detail_op(loongarch, LoongArch);
 
 /// Increments the detail->arch.op_count by one.
 #define DEFINE_inc_detail_op_count(arch, ARCH) \
@@ -162,6 +164,8 @@ DEFINE_inc_detail_op_count(alpha, Alpha);
 DEFINE_dec_detail_op_count(alpha, Alpha);
 DEFINE_inc_detail_op_count(hppa, HPPA);
 DEFINE_dec_detail_op_count(hppa, HPPA);
+DEFINE_inc_detail_op_count(loongarch, LoongArch);
+DEFINE_dec_detail_op_count(loongarch, LoongArch);
 
 /// Returns true if a memory operand is currently edited.
 static inline bool doing_mem(const MCInst *MI)
@@ -189,6 +193,7 @@ DEFINE_get_arch_detail(tricore, TriCore);
 DEFINE_get_arch_detail(aarch64, AArch64);
 DEFINE_get_arch_detail(alpha, Alpha);
 DEFINE_get_arch_detail(hppa, HPPA);
+DEFINE_get_arch_detail(loongarch, LoongArch);
 
 static inline bool detail_is_set(const MCInst *MI)
 {

diff --git a/README.md b/README.md
@@ -16,8 +16,8 @@ Created by Nguyen Anh Quynh, then developed and maintained by a small community,
 Capstone offers some unparalleled features:
 
 - Support multiple hardware architectures: ARM, AArch64, Alpha, BPF, Ethereum VM,
-  HP PA-RISC (HPPA), M68K, M680X, Mips, MOS65XX, PPC, RISC-V(rv32G/rv64G), SH, Sparc,
-  SystemZ, TMS320C64X, TriCore, Webassembly, XCore and X86 (16, 32, 64).
+  LoongArch, HP PA-RISC (HPPA), M68K, M680X, Mips, MOS65XX, PPC, RISC-V(rv32G/rv64G), SH,
+  Sparc, SystemZ, TMS320C64X, TriCore, Webassembly, XCore and X86 (16, 32, 64).
 
 - Having clean/simple/lightweight/intuitive architecture-neutral API.