Architecture updater (auto-sync) - Updating PPC

CMakeLists.txt

@@ -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()

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)
@@ -280,3 +282,9 @@ 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;
+}

MCInst.h

@@ -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,10 @@ 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;
+}
+
 #endif

MCInstPrinter.c

@@ -6,6 +6,7 @@
 #include <capstone/platform.h>
 
 extern bool ARM_getFeatureBits(unsigned int mode, unsigned int feature);
+extern bool PPC_getFeatureBits(unsigned int mode, unsigned int feature);
 
 static bool testFeatureBits(const MCInst *MI, uint32_t Value)
 {
@@ -15,6 +16,8 @@ static bool testFeatureBits(const MCInst *MI, uint32_t Value)
 		assert(0 && "Not implemented for current arch.");
 	case CS_ARCH_ARM:
 		return ARM_getFeatureBits(MI->csh->mode, Value);
+	case CS_ARCH_PPC:
+		return PPC_getFeatureBits(MI->csh->mode, Value);
 	}
 }
 

Mapping.c

@@ -3,6 +3,7 @@
 /*    Rot127 <unisono@quyllur.org>, 2022-2023 */
 
 #include "Mapping.h"
+#include "capstone/capstone.h"
 
 // create a cache for fast id lookup
 static unsigned short *make_id2insn(const insn_map *insns, unsigned int size)
@@ -311,3 +312,60 @@ const cs_ac_type mapping_get_op_access(MCInst *MI, unsigned OpNum,
 DEFINE_get_detail_op(arm, ARM);
 DEFINE_get_detail_op(ppc, PPC);
 DEFINE_get_detail_op(tricore, TriCore);
+
+/// Returns true if for this architecture the
+/// alias operands should be filled.
+/// TODO: Replace this with a proper option.
+/// 			So it can be toggled between disas() calls.
+bool map_use_alias_details(const MCInst *MI) {
+	assert(MI);
+	return !(MI->csh->detail_opt & CS_OPT_DETAIL_REAL);
+}
+
+/// Sets the setDetailOps flag to @p Val.
+/// If detail == NULLit refuses to set the flag to true.
+void map_set_fill_detail_ops(MCInst *MI, bool Val) {
+	assert(MI);
+	if (!detail_is_set(MI)) {
+		MI->fillDetailOps = false;
+		return;
+	}
+
+	MI->fillDetailOps = Val;
+}
+
+/// Sets the instruction alias flags and the given alias id.
+void map_set_is_alias_insn(MCInst *MI, bool Val, uint64_t Alias) {
+	assert(MI);
+	MI->isAliasInstr = Val;
+	MI->flat_insn->is_alias = Val;
+	MI->flat_insn->alias_id = Alias;
+}
+
+/// Sets an alternative id for some instruction.
+/// Or -1 if it fails.
+/// You must add (<ARCH>_INS_ALIAS_BEGIN + 1) to the id to get the real id.
+void map_set_alias_id(MCInst *MI, const SStream *O, const name_map *alias_mnem_id_map, int map_size) {
+	if (!MCInst_isAlias(MI))
+		return;
+
+	char alias_mnem[16] = { 0 };
+	int i = 0, j = 0;
+	const char *asm_str_buf = O->buffer;
+	// Skip spaces and tabs
+	while (asm_str_buf[i] == ' ' || asm_str_buf[i] == '\t') {
+		if (!asm_str_buf[i]) {
+			MI->flat_insn->alias_id = -1;
+			return;
+		}
+		++i;
+	}
+	for (; j < sizeof(alias_mnem) - 1; ++j, ++i) {
+		if (!asm_str_buf[i] || asm_str_buf[i] == ' ' || asm_str_buf[i] == '\t')
+			break;
+		alias_mnem[j] = O->buffer[i];
+	}
+
+	MI->flat_insn->alias_id = name2id(alias_mnem_id_map, map_size, alias_mnem);
+}
+

Mapping.h

@@ -28,6 +28,9 @@ typedef struct insn_map {
 		[MAX_NUM_GROUPS]; ///< list of group this instruction belong to
 	bool branch;		  // branch instruction?
 	bool indirect_branch;	  // indirect branch instruction?
+	union {
+		ppc_suppl_info ppc;
+	} suppl_info; // Supplementary information for each instruction.
 #endif
 } insn_map;
 
@@ -166,7 +169,7 @@ DEFINE_get_arch_detail(tricore, TriCore);
 static inline bool detail_is_set(const MCInst *MI)
 {
 	assert(MI && MI->flat_insn);
-	return MI->flat_insn->detail != NULL;
+	return MI->flat_insn->detail != NULL && MI->csh->detail_opt & CS_OPT_ON;
 }
 
 static inline cs_detail *get_detail(const MCInst *MI)
@@ -175,4 +178,30 @@ static inline cs_detail *get_detail(const MCInst *MI)
 	return MI->flat_insn->detail;
 }
 
+static inline bool set_detail_ops(const MCInst *MI)
+{
+	assert(MI && MI->flat_insn);
+	return MI->fillDetailOps;
+}
+
+/// Returns if the given instruction is an alias instruction.
+#define RETURN_IF_INSN_IS_ALIAS(MI) \
+do { \
+	if (MI->isAliasInstr) \
+		return; \
+} while(0)
+
+void map_set_fill_detail_ops(MCInst *MI, bool Val);
+
+static inline bool map_fill_detail_ops(MCInst *MI) {
+	assert(MI);
+	return MI->fillDetailOps;
+}
+
+void map_set_is_alias_insn(MCInst *MI, bool Val, uint64_t Alias);
+
+bool map_use_alias_details(const MCInst *MI);
+
+void map_set_alias_id(MCInst *MI, const SStream *O, const name_map *alias_mnem_id_map, int map_size);
+
 #endif // CS_MAPPING_H

SStream.c

@@ -24,8 +24,26 @@
 
 void SStream_Init(SStream *ss)
 {
+	assert(ss);
 	ss->index = 0;
 	ss->buffer[0] = '\0';
+	ss->is_closed = false;
+}
+
+/**
+ * Open the output stream. Every write attempt is accepted again.
+ */
+void SStream_Open(SStream *ss) {
+	assert(ss);
+	ss->is_closed = false;
+}
+
+/**
+ * Closes the output stream. Every write attempt is ignored.
+ */
+void SStream_Close(SStream *ss) {
+	assert(ss);
+	ss->is_closed = true;
 }
 
 /**
@@ -34,6 +52,7 @@ void SStream_Init(SStream *ss)
 void SStream_concat0(SStream *ss, const char *s)
 {
 #ifndef CAPSTONE_DIET
+	SSTREAM_RETURN_IF_CLOSED(ss);
 	if (s[0] == '\0')
 		return;
 	unsigned int len = (unsigned int) strlen(s);
@@ -50,6 +69,7 @@ void SStream_concat0(SStream *ss, const char *s)
 void SStream_concat1(SStream *ss, const char c)
 {
 #ifndef CAPSTONE_DIET
+	SSTREAM_RETURN_IF_CLOSED(ss);
 	if (c == '\0')
 		return;
 	ss->buffer[ss->index] = c;
@@ -64,6 +84,7 @@ void SStream_concat1(SStream *ss, const char c)
 void SStream_concat(SStream *ss, const char *fmt, ...)
 {
 #ifndef CAPSTONE_DIET
+	SSTREAM_RETURN_IF_CLOSED(ss);
 	va_list ap;
 	int ret;
 
@@ -77,6 +98,7 @@ void SStream_concat(SStream *ss, const char *fmt, ...)
 // print number with prefix #
 void printInt64Bang(SStream *O, int64_t val)
 {
+	SSTREAM_RETURN_IF_CLOSED(O);
 	if (val >= 0) {
 		if (val > HEX_THRESHOLD)
 			SStream_concat(O, "#0x%"PRIx64, val);
@@ -95,6 +117,7 @@ void printInt64Bang(SStream *O, int64_t val)
 
 void printUInt64Bang(SStream *O, uint64_t val)
 {
+	SSTREAM_RETURN_IF_CLOSED(O);
 	if (val > HEX_THRESHOLD)
 		SStream_concat(O, "#0x%"PRIx64, val);
 	else
@@ -104,6 +127,7 @@ void printUInt64Bang(SStream *O, uint64_t val)
 // print number
 void printInt64(SStream *O, int64_t val)
 {
+	SSTREAM_RETURN_IF_CLOSED(O);
 	if (val >= 0) {
 		if (val > HEX_THRESHOLD)
 			SStream_concat(O, "0x%"PRIx64, val);
@@ -122,6 +146,7 @@ void printInt64(SStream *O, int64_t val)
 
 void printUInt64(SStream *O, uint64_t val)
 {
+	SSTREAM_RETURN_IF_CLOSED(O);
 	if (val > HEX_THRESHOLD)
 		SStream_concat(O, "0x%"PRIx64, val);
 	else
@@ -131,6 +156,7 @@ void printUInt64(SStream *O, uint64_t val)
 // print number in decimal mode
 void printInt32BangDec(SStream *O, int32_t val)
 {
+	SSTREAM_RETURN_IF_CLOSED(O);
 	if (val >= 0)
 		SStream_concat(O, "#%u", val);
 	else {
@@ -143,6 +169,7 @@ void printInt32BangDec(SStream *O, int32_t val)
 
 void printInt32Bang(SStream *O, int32_t val)
 {
+	SSTREAM_RETURN_IF_CLOSED(O);
 	if (val >= 0) {
 		if (val > HEX_THRESHOLD)
 			SStream_concat(O, "#0x%x", val);
@@ -161,6 +188,7 @@ void printInt32Bang(SStream *O, int32_t val)
 
 void printInt32(SStream *O, int32_t val)
 {
+	SSTREAM_RETURN_IF_CLOSED(O);
 	if (val >= 0) {
 		if (val > HEX_THRESHOLD)
 			SStream_concat(O, "0x%x", val);
@@ -179,6 +207,7 @@ void printInt32(SStream *O, int32_t val)
 
 void printUInt32Bang(SStream *O, uint32_t val)
 {
+	SSTREAM_RETURN_IF_CLOSED(O);
 	if (val > HEX_THRESHOLD)
 		SStream_concat(O, "#0x%x", val);
 	else
@@ -187,6 +216,7 @@ void printUInt32Bang(SStream *O, uint32_t val)
 
 void printUInt32(SStream *O, uint32_t val)
 {
+	SSTREAM_RETURN_IF_CLOSED(O);
 	if (val > HEX_THRESHOLD)
 		SStream_concat(O, "0x%x", val);
 	else
@@ -195,10 +225,12 @@ void printUInt32(SStream *O, uint32_t val)
 
 void printFloat(SStream *O, float val)
 {
+	SSTREAM_RETURN_IF_CLOSED(O);
 	SStream_concat(O, "%e", val);
 }
 
 void printFloatBang(SStream *O, float val)
 {
+	SSTREAM_RETURN_IF_CLOSED(O);
 	SStream_concat(O, "#%e", val);
 }

SStream.h

@@ -9,10 +9,21 @@
 typedef struct SStream {
 	char buffer[512];
 	int index;
+	bool is_closed;
 } SStream;
 
+#define SSTREAM_RETURN_IF_CLOSED(OS) \
+do { \
+	if (OS->is_closed) \
+		return; \
+} while(0)
+
 void SStream_Init(SStream *ss);
 
+void SStream_Open(SStream *ss);
+
+void SStream_Close(SStream *ss);
+
 void SStream_concat(SStream *ss, const char *fmt, ...);
 
 void SStream_concat0(SStream *ss, const char *s);