suite/cstest/src/arm_detail.c

/* Capstone testing regression */
/* By Do Minh Tuan <tuanit96@gmail.com>, 02-2019 */


#include "factory.h" 

char *get_detail_arm(csh *handle, cs_mode mode, cs_insn *ins)
{
	cs_arm *arm;
	int i;
	cs_regs regs_read, regs_write;
	uint8_t regs_read_count, regs_write_count;
	char *result;

	result = (char *)malloc(sizeof(char));
	result[0] = '\0';

	if (ins->detail == NULL)
		return result;

	arm = &(ins->detail->arm);

	if (arm->op_count)
		add_str(&result, " ; op_count: %u", arm->op_count);

	for (i = 0; i < arm->op_count; i++) {
		cs_arm_op *op = &(arm->operands[i]);
		switch((int)op->type) {
			default:
				break;
			case ARM_OP_REG:
				add_str(&result, " ; operands[%u].type: REG = %s", i, cs_reg_name(*handle, op->reg));
				break;
			case ARM_OP_IMM:
				add_str(&result, " ; operands[%u].type: IMM = 0x%x", i, op->imm);
				break;
			case ARM_OP_FP:
#if defined(_KERNEL_MODE)
				// Issue #681: Windows kernel does not support formatting float point
				add_str(&result, " ; operands[%u].type: FP = <float_point_unsupported>", i);
#else
				add_str(&result, " ; operands[%u].type: FP = %f", i, op->fp);
#endif
				break;
			case ARM_OP_MEM:
				add_str(&result, " ; operands[%u].type: MEM", i);
				if (op->mem.base != ARM_REG_INVALID)
					add_str(&result, " ; operands[%u].mem.base: REG = %s", i, cs_reg_name(*handle, op->mem.base));
				if (op->mem.index != ARM_REG_INVALID)
					add_str(&result, " ; operands[%u].mem.index: REG = %s", i, cs_reg_name(*handle, op->mem.index));
				if (op->mem.scale != 1)
					add_str(&result, " ; operands[%u].mem.scale: %d", i, op->mem.scale);
				if (op->mem.disp != 0)
					add_str(&result, " ; operands[%u].mem.disp: 0x%x", i, op->mem.disp);
				if (op->mem.align != 0)
					add_str(&result, " ; operands[%u].mem.align: 0x%x", i, op->mem.align);
				if (op->mem.lshift != 0)
					add_str(&result, " ; operands[%u].mem.lshift: 0x%x", i, op->mem.lshift);

				break;
			case ARM_OP_PIMM:
				add_str(&result, " ; operands[%u].type: P-IMM = %u", i, op->imm);
				break;
			case ARM_OP_CIMM:
				add_str(&result, " ; operands[%u].type: C-IMM = %u", i, op->imm);
				break;
			case ARM_OP_SETEND:
				add_str(&result, " ; operands[%u].type: SETEND = %s", i, op->setend == ARM_SETEND_BE? "be" : "le");
				break;
			case ARM_OP_SYSM:
				add_str(&result, " ; operands[%u].type: SYSM = 0x%" PRIx16 "\n", i, op->sysop.sysm);
				add_str(&result, " ; operands[%u].type: MASK = %" PRIu8 "\n", i, op->sysop.msr_mask);
				break;
			case ARM_OP_SYSREG:
				add_str(&result, " ; operands[%u].type: SYSREG = %s", i, cs_reg_name(*handle, (uint32_t) op->sysop.reg.mclasssysreg));
				add_str(&result, " ; operands[%u].type: MASK = %" PRIu8, i, op->sysop.msr_mask);
				break;
			case ARM_OP_BANKEDREG:
				// FIXME: Printing the name is currenliy not supported if the encodings overlap
				// with system registers.
				add_str(&result, " ; operands[%u].type: BANKEDREG = %" PRIu32, i, (uint32_t) op->sysop.reg.bankedreg);
				if (op->sysop.msr_mask != UINT8_MAX)
					add_str(&result, " ; operands[%u].type: MASK = %" PRIu8, i, op->sysop.msr_mask);
			case ARM_OP_SPSR:
			case ARM_OP_CPSR: {
				const char type = op->type == ARM_OP_SPSR ? 'S' : 'C';
				add_str(&result, " ; operands[%u].type: %cPSR = ", i, type);
				uint16_t field = op->sysop.psr_bits;
				if ((field & ARM_FIELD_SPSR_F) || (field & ARM_FIELD_CPSR_F))
					add_str(&result, "f");
				if ((field & ARM_FIELD_SPSR_S) || (field & ARM_FIELD_CPSR_S))
					add_str(&result, "s");
				if ((field & ARM_FIELD_SPSR_X) || (field & ARM_FIELD_CPSR_X))
					add_str(&result, "x");
				if ((field & ARM_FIELD_SPSR_C) || (field & ARM_FIELD_CPSR_C))
					add_str(&result, "c");
				add_str(&result, " ; operands[%u].type: MASK = %" PRIu8, i, op->sysop.msr_mask);
				break;
			}
		}

		if (op->neon_lane != -1) {
			add_str(&result, " ; operands[%u].neon_lane = %u", i, op->neon_lane);
		}

		switch(op->access) {
			default:
				break;
			case CS_AC_READ:
				add_str(&result, " ; operands[%u].access: READ", i);
				break;
			case CS_AC_WRITE:
				add_str(&result, " ; operands[%u].access: WRITE", i);
				break;
			case CS_AC_READ | CS_AC_WRITE:
				add_str(&result, " ; operands[%u].access: READ | WRITE", i);
				break;
		}

		if (op->shift.type != ARM_SFT_INVALID && op->shift.value) {
			if (op->shift.type < ARM_SFT_ASR_REG)
				add_str(&result, " ; Shift: %u = %u", op->shift.type, op->shift.value);
			else
				add_str(&result, " ; Shift: %u = %s", op->shift.type, cs_reg_name(*handle, op->shift.value));
		}

		if (op->vector_index != -1) {
			add_str(&result, " ; operands[%u].vector_index = %u", i, op->vector_index);
		}

		if (op->subtracted)
			add_str(&result, " ; Subtracted: True");
	}

	if (arm->cc != ARMCC_AL && arm->cc != ARMCC_UNDEF)
		add_str(&result, " ; Code condition: %u", arm->cc);

	if (arm->pred_mask)
		add_str(&result, " ; Predicate Mask: 0x%x", arm->pred_mask);

	if (arm->vcc != ARMVCC_None)
		add_str(&result, " ; Vector code condition: %u", arm->vcc);

	if (arm->update_flags)
		add_str(&result, " ; Update-flags: True");

	if (ins->detail->writeback)
		add_str(&result, " ; Write-back: True");

	if (arm->cps_mode)
		add_str(&result, " ; CPSI-mode: %u", arm->cps_mode);

	if (arm->cps_flag)
		add_str(&result, " ; CPSI-flag: %u", arm->cps_flag);

	if (arm->vector_data)
		add_str(&result, " ; Vector-data: %u", arm->vector_data);

	if (arm->vector_size)
		add_str(&result, " ; Vector-size: %u", arm->vector_size);

	if (arm->usermode)
		add_str(&result, " ; User-mode: True");

	if (arm->mem_barrier)
		add_str(&result, " ; Memory-barrier: %u", arm->mem_barrier);

	if (!cs_regs_access(*handle, ins, regs_read, &regs_read_count, regs_write, &regs_write_count)) {
		if (regs_read_count) {
			add_str(&result, " ; Registers read:");
			for(i = 0; i < regs_read_count; i++) {
				add_str(&result, " %s", cs_reg_name(*handle, regs_read[i]));
			}
		}

		if (regs_write_count) {
			add_str(&result, " ; Registers modified:");
			for(i = 0; i < regs_write_count; i++) {
				add_str(&result, " %s", cs_reg_name(*handle, regs_write[i]));
			}
		}
	}

	return result;
}