il_trace.c File Reference

new rizin IL trace implementation More...

#include <rz_util.h>
#include <rz_analysis.h>

Go to the source code of this file.

Functions
RZ_API RzILTraceInstruction *	rz_analysis_il_trace_instruction_new (ut64 addr)
RZ_API void	rz_analysis_il_trace_instruction_free (RzILTraceInstruction *instruction)
RZ_API bool	rz_analysis_il_trace_add_mem (RzILTraceInstruction *trace, RzILTraceMemOp *mem)
RZ_API bool	rz_analysis_il_trace_add_reg (RzILTraceInstruction *trace, RzILTraceRegOp *reg)
RZ_API RzILTraceMemOp *	rz_analysis_il_get_mem_op_trace (RzILTraceInstruction *trace, ut64 addr, RzILTraceOpType op_type)
RZ_API RzILTraceRegOp *	rz_analysis_il_get_reg_op_trace (RzILTraceInstruction *trace, const char *regname, RzILTraceOpType op_type)
RZ_API bool	rz_analysis_il_mem_trace_contains (RzILTraceInstruction *trace, ut64 addr, RzILTraceOpType op_type)
RZ_API bool	rz_analysis_il_reg_trace_contains (RzILTraceInstruction *trace, const char *regname, RzILTraceOpType op_type)

Detailed Description

new rizin IL trace implementation

provide operations to new IL trace structure to record the memory changes and register changes. TODO : Should be moved to librz/il after integrations with new IL : should move the prototypes and trace structure to new header, too prototypes in <rz_analysis.h> Used by : analysis_tp.c, debug/trace.c

Definition in file il_trace.c.

Function Documentation

rz_analysis_il_get_mem_op_trace()

RZ_API RzILTraceMemOp* rz_analysis_il_get_mem_op_trace	(	RzILTraceInstruction *	trace,
		ut64	addr,
		RzILTraceOpType	op_type
	)

Find the memory change in an instruction by given address

Parameters

trace	RzILTraceInstruction *, instruction trace
addr	ut64, memory address
is_write	bool, true if you want to find a write operation to address, else find a read operation

Returns

RzILTraceMemOp *, info of memory change

Definition at line 135 of file il_trace.c.

                                                                                                                        {
    if (!trace) {
        return NULL;
    }
 
    RzPVector *mem_ops;
    RzILTraceMemOp *mem_op;
    switch (op_type) {
    case RZ_IL_TRACE_OP_WRITE:
        mem_ops = trace->write_mem_ops;
        break;
    case RZ_IL_TRACE_OP_READ:
        mem_ops = trace->read_mem_ops;
        break;
    default:
        rz_warn_if_reached();
        return NULL;
    }
 
    void **iter;
    rz_pvector_foreach (mem_ops, iter) {
        mem_op = *iter;
        if (mem_op->addr == addr) {
            return mem_op;
        }
    }
 
    return NULL;
}

References addr, NULL, rz_pvector_foreach, and rz_warn_if_reached.

Referenced by rz_analysis_il_mem_trace_contains().

rz_analysis_il_get_reg_op_trace()

RZ_API RzILTraceRegOp* rz_analysis_il_get_reg_op_trace	(	RzILTraceInstruction *	trace,
		const char *	regname,
		RzILTraceOpType	op_type
	)

Find the register change in an instruction by register name

Parameters

trace	RzILTraceInstruction *, instruction trace
regname	const char *, name of register
is_write	bool, true if you want to find a write operation to register, else find a read operation

Returns

RzILTraceRegOp *, info of register change

Definition at line 172 of file il_trace.c.

                                                                                                                                  {
    if (!(trace && regname)) {
        return NULL;
    }
 
    RzPVector *reg_ops;
    RzILTraceRegOp *reg_op;
    switch (op_type) {
    case RZ_IL_TRACE_OP_WRITE:
        reg_ops = trace->write_reg_ops;
        break;
    case RZ_IL_TRACE_OP_READ:
        reg_ops = trace->read_reg_ops;
        break;
    default:
        rz_warn_if_reached();
        return NULL;
    }
 
    void **iter;
    rz_pvector_foreach (reg_ops, iter) {
        reg_op = *iter;
        if (strcmp(reg_op->reg_name, regname) == 0) {
            return reg_op;
        }
    }
 
    return NULL;
}

References NULL, regname(), rz_pvector_foreach, and rz_warn_if_reached.

Referenced by get_addr(), rz_analysis_il_reg_trace_contains(), and type_match().

rz_analysis_il_mem_trace_contains()

RZ_API bool rz_analysis_il_mem_trace_contains	(	RzILTraceInstruction *	trace,
		ut64	addr,
		RzILTraceOpType	op_type
	)

Check if instruction contains a read/write to given address

Parameters

trace	RzILTraceInstruction *, instruction trace
addr	ut64, Address of memory
is_write	bool, set true to find if it contains a write to address, else read

Returns

bool, true if contains, else return a false

Definition at line 209 of file il_trace.c.

                                                                                                               {
    return rz_analysis_il_get_mem_op_trace(trace, addr, op_type) ? true : false;
}

References addr, rz_analysis_il_get_mem_op_trace(), and true.

Referenced by rz_analysis_il_trace_add_mem().

rz_analysis_il_reg_trace_contains()

RZ_API bool rz_analysis_il_reg_trace_contains	(	RzILTraceInstruction *	trace,
		const char *	regname,
		RzILTraceOpType	op_type
	)

Check if instruction contains a read/write to given register

Parameters

trace	RzILTraceInstruction *, instruction trace
regname	const char *, name of register
is_write	bool, set true to find if it contains a write to the register, else read

Returns

bool, true if contains, else return a false

Definition at line 220 of file il_trace.c.

                                                                                                                         {
    return rz_analysis_il_get_reg_op_trace(trace, regname, op_type) ? true : false;
}

References regname(), rz_analysis_il_get_reg_op_trace(), and true.

Referenced by rz_analysis_il_trace_add_reg(), and type_pos_hit().

rz_analysis_il_trace_add_mem()

RZ_API bool rz_analysis_il_trace_add_mem	(	RzILTraceInstruction *	trace,
		RzILTraceMemOp *	mem
	)

add memory change to an instruction trace

Parameters

trace	RzILTraceInstruction *, trace of instruction which triggers a memory change
mem	RzILTraceMemOp *, info of memory change

Returns

true if succeed

Definition at line 70 of file il_trace.c.

                                                                                           {
    if (!(trace && mem)) {
        return false;
    }
 
    if (rz_analysis_il_mem_trace_contains(trace, mem->addr, mem->behavior)) {
        return false;
    }
 
    bool ret = false;
    switch (mem->behavior) {
    case RZ_IL_TRACE_OP_WRITE:
        ret = !!rz_pvector_push(trace->write_mem_ops, mem);
        trace->stats |= RZ_IL_TRACE_INS_HAS_MEM_W;
        break;
    case RZ_IL_TRACE_OP_READ:
        ret = !!rz_pvector_push(trace->read_mem_ops, mem);
        trace->stats |= RZ_IL_TRACE_INS_HAS_MEM_R;
        break;
    default:
        rz_warn_if_reached();
        break;
    }
    return ret;
}

References mem, rz_analysis_il_mem_trace_contains(), rz_pvector_push(), and rz_warn_if_reached.

Referenced by esil_add_mem_trace().

rz_analysis_il_trace_add_reg()

RZ_API bool rz_analysis_il_trace_add_reg	(	RzILTraceInstruction *	trace,
		RzILTraceRegOp *	reg
	)

add register change to an instruction trace

Parameters

trace	RzILTraceInstruction *, trace of instruction which triggers a register change
mem	RzILTraceRegOp *, info of register change

Returns

true if succeed

Definition at line 102 of file il_trace.c.

                                                                                           {
    if (!(trace && reg)) {
        return false;
    }
 
    if (rz_analysis_il_reg_trace_contains(trace, reg->reg_name, reg->behavior)) {
        return false;
    }
 
    bool ret = false;
    switch (reg->behavior) {
    case RZ_IL_TRACE_OP_WRITE:
        ret = !!rz_pvector_push(trace->write_reg_ops, reg);
        trace->stats |= RZ_IL_TRACE_INS_HAS_REG_W;
        break;
    case RZ_IL_TRACE_OP_READ:
        ret = !!rz_pvector_push(trace->read_reg_ops, reg);
        trace->stats |= RZ_IL_TRACE_INS_HAS_REG_R;
        break;
    default:
        rz_warn_if_reached();
        break;
    }
    return ret;
}

References reg, rz_analysis_il_reg_trace_contains(), rz_pvector_push(), and rz_warn_if_reached.

Referenced by esil_add_reg_trace().

rz_analysis_il_trace_instruction_free()

RZ_API void rz_analysis_il_trace_instruction_free

(

RzILTraceInstruction *

instruction

)

clean an IL trace

Parameters

instruction

RzILTraceInstruction, trace to be cleaned

Definition at line 53 of file il_trace.c.

                                                                                     {
    if (!instruction) {
        return;
    }
    rz_pvector_free(instruction->write_reg_ops);
    rz_pvector_free(instruction->read_reg_ops);
    rz_pvector_free(instruction->write_mem_ops);
    rz_pvector_free(instruction->read_mem_ops);
    free(instruction);
}

References free(), and rz_pvector_free().

Referenced by rz_analysis_esil_trace_new(), rz_analysis_il_trace_instruction_new(), rz_analysis_rzil_trace_new(), and rz_cmd_debug_traces_esil_delete_handler().

rz_analysis_il_trace_instruction_new()

RZ_API RzILTraceInstruction* rz_analysis_il_trace_instruction_new

(

ut64

addr

)

create and init a trace structure for an instruction at address

Parameters

addr	ut64, address of instruction

Returns

RzILTraceInstruction, trace structure of an instruction

Definition at line 24 of file il_trace.c.

                                                                             {
    RzILTraceInstruction *instruction_trace = RZ_NEW0(RzILTraceInstruction);
    if (!instruction_trace) {
        RZ_LOG_ERROR("Cannot create instruction trace\n");
        return NULL;
    }
 
    instruction_trace->addr = addr;
 
    instruction_trace->read_mem_ops = rz_pvector_new((RzPVectorFree)free);
    instruction_trace->read_reg_ops = rz_pvector_new((RzPVectorFree)free);
    instruction_trace->write_mem_ops = rz_pvector_new((RzPVectorFree)free);
    instruction_trace->write_reg_ops = rz_pvector_new((RzPVectorFree)free);
 
    if (!(instruction_trace->read_reg_ops &&
            instruction_trace->read_mem_ops &&
            instruction_trace->write_reg_ops &&
            instruction_trace->write_mem_ops)) {
        rz_analysis_il_trace_instruction_free(instruction_trace);
        return NULL;
    }
 
    return instruction_trace;
}

References addr, free(), NULL, rz_analysis_il_trace_instruction_free(), RZ_LOG_ERROR, RZ_NEW0, and rz_pvector_new().

Referenced by rz_analysis_esil_trace_op().