summaryrefslogtreecommitdiff
path: root/src/arch/instruction.h
blob: 2eddc3c1f7774b5abf239091f3a5ad65311589a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

/* OpenIDA - Outil d'analyse de fichiers binaires
 * instruction.h - prototypes pour la gestion générique des instructions
 *
 * Copyright (C) 2008-2010 Cyrille Bagard
 *
 *  This file is part of OpenIDA.
 *
 *  OpenIDA is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  OpenIDA is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef _ARCH_INSTRUCTION_H
#define _ARCH_INSTRUCTION_H


#include <stdbool.h>
#include <glib-object.h>
#include <sys/types.h>


#include "archbase.h"
#include "operand.h"
#include "register.h"
#include "../decomp/context.h"
#include "../decomp/instruction.h"
#include "../format/executable.h"



/* Typage des instructions rencontrées */
typedef enum _InstructionLinkType
{
    ILT_NONE,                               /* Aucune instruction visée    */
    ILT_EXEC_FLOW,                          /* Raccord attendu entre blocs */
    ILT_JUMP,                               /* Saut inconditionnel         */
    ILT_CASE_JUMP,                          /* Saut suite à aiguillage     */
    ILT_JUMP_IF_TRUE,                       /* Saut conditionnel (si vrai) */
    ILT_JUMP_IF_FALSE,                      /* Saut conditionnel (si faux) */
    ILT_CALL,                               /* Appel d'une fonction        */
    ILT_CATCH_EXCEPTION                     /* Gestion d'une exception     */

} InstructionLinkType;


#define G_TYPE_ARCH_INSTRUCTION                 g_arch_instruction_get_type()
#define G_ARCH_INSTRUCTION(obj)                 (G_TYPE_CHECK_INSTANCE_CAST((obj), g_arch_instruction_get_type(), GArchInstruction))
#define G_IS_ARCH_INSTRUCTION(obj)              (G_TYPE_CHECK_INSTANCE_TYPE((obj), g_arch_instruction_get_type()))
#define G_ARCH_INSTRUCTION_GET_IFACE(inst)      (G_TYPE_INSTANCE_GET_INTERFACE((inst), g_arch_instruction_get_type(), GArchInstructionIface))


/* Définition générique d'une instruction d'architecture (instance) */
typedef struct _GArchInstruction GArchInstruction;

/* Définition générique d'une instruction d'architecture (classe) */
typedef struct _GArchInstructionClass GArchInstructionClass;


/* Indique le type défini pour une instruction d'architecture. */
GType g_arch_instruction_get_type(void);

/* Définit la localisation d'une instruction. */
void g_arch_instruction_set_location(GArchInstruction *, off_t, off_t, vmpa_t);

/* Fournit la localisation d'une instruction. */
void g_arch_instruction_get_location(const GArchInstruction *, off_t *, off_t *, vmpa_t *);

/* Attache un opérande supplémentaire à une instruction. */
void g_arch_instruction_attach_extra_operand(GArchInstruction *, GArchOperand *);

/* Indique la quantité d'opérandes présents dans l'instruction. */
size_t g_arch_instruction_count_operands(const GArchInstruction *);

/* Fournit un opérande donné d'une instruction. */
GArchOperand *g_arch_instruction_get_operand(const GArchInstruction *, size_t);

/* Remplace un opérande d'une instruction par un autre. */
void g_arch_instruction_replace_operand(GArchInstruction *, GArchOperand *, const GArchOperand *);

/* Détache un opérande liée d'une instruction. */
void g_arch_instruction_detach_operand(GArchInstruction *, GArchOperand *);

/* Liste les registres lus et écrits par l'instruction. */
void g_arch_instruction_get_rw_registers(const GArchInstruction *, GArchRegister ***, size_t *, GArchRegister ***, size_t *);



/* ------------------- DEFINITION DES LIAISONS ENTRE INSTRUCTIONS ------------------- */


/* Informe sur une éventuelle référence à une autre instruction. */
InstructionLinkType g_arch_instruction_get_link(const GArchInstruction *, vmpa_t *);

/* Indique si l'instruction correspond à un retour de fonction. */
bool g_arch_instruction_is_return(const GArchInstruction *instr);

/* Etablit un lien entre deux instructions. */
void g_arch_instruction_link_with(GArchInstruction *, GArchInstruction *, InstructionLinkType);

/* Indique si l'instruction a une ou plusieurs origines. */
bool g_arch_instruction_has_sources(const GArchInstruction *);

/* Indique si l'instruction a une suite autre que la suivante. */
bool g_arch_instruction_has_destinations(const GArchInstruction *);

/* Fournit les destinations d'une instruction donnée. */
size_t g_arch_instruction_get_destinations(const GArchInstruction *, GArchInstruction ***, InstructionLinkType **);



/* --------------------- CONVERSIONS DU FORMAT DES INSTRUCTIONS --------------------- */


/* Fournit le nom humain de l'instruction manipulée. */
const char *g_arch_instruction_get_keyword(const GArchInstruction *);

/* Ajoute à un tampon GLib le contenu de l'instance spécifiée. */
void g_arch_instruction_print(const GArchInstruction *, GCodeBuffer *, MemoryDataSize, const bin_t *, AsmSyntax);

/* Décompile une instruction de façon générique. */
GDecInstruction *g_arch_instruction_decompile(const GArchInstruction *, GDecContext *);



/* -------------------- TRAITEMENT DES INSTRUCTIONS PAR ENSEMBLE -------------------- */


/* Renvoie vers la dernière instruction d'une série. */
GArchInstruction *g_arch_instruction_find_last(const GArchInstruction *);

/* Ajoute une instruction à un ensemble existant. */
void g_arch_instruction_add_to_list(GArchInstruction **, GArchInstruction *);

/* Fournit l'élement suivant un autre pour un parcours. */
GArchInstruction *g_arch_instruction_get_prev_iter(const GArchInstruction *, const GArchInstruction *);

/* Fournit l'élement suivant un autre pour un parcours. */
GArchInstruction *g_arch_instruction_get_next_iter(const GArchInstruction *, const GArchInstruction *, vmpa_t);

/* Recherche une instruction d'après son adresse. */
GArchInstruction *g_arch_instruction_find_by_address(GArchInstruction *, vmpa_t, bool);



#endif  /* _ARCH_INSTRUCTION_H */