Getters

Get properties of instructions. More...

Modules
	For loops
	Getters on for loops.
	Function calls
	Getters on function calls.
	If Then Else
	Getters on if then else branchs.
	Mixed instruction types
	Getters on several types of instructions.
	X10 constructs
	Getters on X10 constructs.

Functions
instruction_type	instruction_get_type (const instruction *instr)
	Get an instruction's type. More...

Detailed Description

Get properties of instructions.

Since

version 1.0.0

The type of an instruction can be inspected with instruction_get_type().

Getters valid for several types

The following getters are valid for several types of instructions. Their behaviour depends on the actual type of the target instruction.

• instruction_identifier()

  This getter is only valid for INSTR_FOR and INSTR_CALL.

  • INSTR_FOR: get the identifier of the foor loop (equivalent to instruction_for_loop_get_identifier()).
  • INSTR_CALL: get the identifier of the function loop (equivalent to instruction_function_call_get_identifier()).

• instruction_body()

  This getter is not valid for INSTR_CALL, INSTR_ADVANCE and INSTR_UNKNOWN. It is valid to use this getter for all other types of instruction.

  It returns the inner body of the target instruction. For instructions which may have two bodies (INSTR_IF and INSTR_IF_ELSE), this getter returns the body which is known as "true" body.

  Depending on an instruction's type, the behaviour of this getter is equivalent to:

  • instruction_for_loop_get_body() for INSTR_FOR instructions.
  • instruction_if_then_else_get_true_body() for INSTR_IF and INSTR_IF_ELSE instructions.
  • instruction_other_get_block() for INSTR_FINISH, INSTR_ASYNC, INSTR_CLOCKED_FINISH and INSTR_CLOCKED_ASYNC instructions.

Getters on function calls

The getters specific to INSTR_CALL instructions are:

• instruction_function_call_get_identifier() returns the identifier of the function.
• instruction_function_call_get_arguments() returns the arguments of the function call.

Getters on for loops

The getters for INSTR_FOR instructions are:

• instruction_for_loop_get_identifier() returns the identifier of the iterator.
• instruction_for_loop_get_left_boundary() returns the left boundary of the loop.
• instruction_for_loop_get_right_boundary() returns the right boundary of the loop.
• instruction_for_loop_get_body() returns the body of the loop.

Getters on branchs

The getters for INSTR_IF and INSTR_IF_ELSE instructions are:

• instruction_if_then_else_get_has_else() returns a boolean which indicates whether the branch has an else body.
• instruction_if_then_else_get_condition() returns the branching condition.
• instruction_if_then_else_get_true_body() returns the "true" body (also known as an "if body").
• instruction_if_then_else_get_false_body() returns the "false" body (also known as an "else body").

Getters on X10 block wrappers

Use instruction_other_get_block() to get the inner block of INSTR_FINISH, INSTR_CLOCKED_FINISH, INSTR_ASYNC and INSTR_CLOCKED_ASYNC instructions.

Function Documentation

instruction_type instruction_get_type ( const instruction *  instr )

related

Get an instruction's type.

Since

version 1.0.0

Parameters

instr

Target instruction.

Returns

The instruction's type.