summaryrefslogtreecommitdiff
path: root/src/format/symbol.h
blob: 7929bc91fc434904140da08eb34d15d3267a382e (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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196

/* Chrysalide - Outil d'analyse de fichiers binaires
 * symbol.h - prototypes pour la gestion des symboles dans un binaire
 *
 * Copyright (C) 2009-2017 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  Chrysalide 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.
 *
 *  Chrysalide 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 _FORMAT_SYMBOL_H
#define _FORMAT_SYMBOL_H


#include <glib-object.h>


#include "../analysis/routine.h"
#include "../analysis/db/item.h"
#include "../analysis/db/items/comment.h"
#include "../arch/instruction.h"
#include "../glibext/linegen.h"



/* --------------------- FONCTIONNALITES BASIQUES POUR SYMBOLES --------------------- */


/* Types de symbole */
typedef enum _SymbolType
{
    STP_DATA,                               /* Données brutes              */
    STP_ROUTINE,                            /* Simple morceau de code      */
    STP_CODE_LABEL,                         /* Renvoi au sein de code      */
    STP_OBJECT,                             /* Objet quelconque            */
    STP_ENTRY_POINT,                        /* Morceau de code en entrée   */
    STP_STRING,                             /* Chaîne de caractères        */
    STP_RO_STRING,                          /* Chaîne de caractères        */

    STP_COUNT

} SymbolType;


#define HAS_DATA_INSTR(type) (type == STP_DATA || type == STP_RO_STRING)



#define G_TYPE_BIN_SYMBOL               g_binary_symbol_get_type()
#define G_BIN_SYMBOL(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj), g_binary_symbol_get_type(), GBinSymbol))
#define G_IS_BIN_SYMBOL(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj), g_binary_symbol_get_type()))
#define G_BIN_SYMBOL_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST((klass), G_TYPE_BIN_SYMBOL, GBinSymbolClass))
#define G_IS_BIN_SYMBOL_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE((klass), G_TYPE_BIN_SYMBOL))
#define G_BIN_SYMBOL_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS((obj), G_TYPE_BIN_SYMBOL, GBinSymbolClass))


/* Symbole d'exécutable (instance) */
typedef struct _GBinSymbol GBinSymbol;

/* Symbole d'exécutable (classe) */
typedef struct _GBinSymbolClass GBinSymbolClass;


/* Indique le type défini pour un symbole d'exécutable. */
GType g_binary_symbol_get_type(void);

/* Crée un nouveau symbole d'exécutable. */
GBinSymbol *g_binary_symbol_new(SymbolType);

/* Compare deux symboles d'exécutable selon leurs propriétés. */
int g_binary_symbol_cmp(const GBinSymbol * const *, const GBinSymbol * const *);

/* Compare un symbole et une localisation. */
int g_binary_symbol_cmp_with_vmpa(const GBinSymbol *, const vmpa2t *);

/* Fournit le type du symbole. */
SymbolType g_binary_symbol_get_target_type(const GBinSymbol *);

/* Définit si un symbole est susceptible de démarrer un bloc. */
void g_binary_symbol_define_as_block_start(GBinSymbol *, bool);

/* Indique si un symbole est susceptible de démarrer un bloc. */
bool g_binary_symbol_is_block_start(GBinSymbol *);

/* Fournit un étiquette pour viser un symbole. */
const char *g_binary_symbol_get_label(const GBinSymbol *);

/* Définit un autre nom pour le symbole. */
void g_binary_symbol_set_alt_label(GBinSymbol *, const char *);

/* Raffine la définition de l'emplacement d'un symbole. */
void g_binary_symbol_fix_range(GBinSymbol *, const vmpa2t *);

/* Fournit l'emplacement où se situe un symbole. */
const mrange_t *g_binary_symbol_get_range(const GBinSymbol *);

/* Attache la routine associée au symbole. */
void _g_binary_symbol_attach_routine(GBinSymbol *, GBinRoutine *, SymbolType);

/* Attache la routine associée au symbole. */
void g_binary_symbol_attach_routine(GBinSymbol *, GBinRoutine *);

/* Attache l'instruction associée au symbole. */
void g_binary_symbol_attach_instruction(GBinSymbol *, GArchInstruction *);

/* Fournit l'éventuelle routine associée au symbole. */
GBinRoutine *g_binary_symbol_get_routine(const GBinSymbol *);

/* Fournit l'éventuelle instruction associée au symbole. */
GArchInstruction *g_binary_symbol_get_instruction(const GBinSymbol *);

/* Ajoute un commentaire facultatif au symbole. */
void g_binary_symbol_set_comment(GBinSymbol *, GDbComment *);

/* Fournit l'éventuel commentaire associé au symbole. */
GDbComment *g_binary_symbol_get_comment(const GBinSymbol *);


/**
 * Confort pour l'ajout de symboles basés sur des formats.
 */

#define SET_IMM_DISPLAY(_ins, _op, _idx, _dsp)                                      \
    do                                                                              \
    {                                                                               \
        GImmOperand *_imm;                                                          \
        _imm = G_IMM_OPERAND(g_arch_instruction_get_operand(_ins, _idx));           \
        g_imm_operand_set_default_display(&_imm, _dsp, G_SHARE_CONTAINER(_ins));    \
        g_imm_operand_set_display(&_imm, _dsp, G_SHARE_CONTAINER(_ins));            \
        _op = G_ARCH_OPERAND(_imm);                                                 \
    }                                                                               \
    while (0)

#define ADD_RAW_AS_SYM(_fmt, _sym, _ins, _cmt, _txt)                        \
    ({                                                                      \
        bool __result;                                                      \
        const vmpa2t *__addr;                                               \
        __addr = get_mrange_addr(g_arch_instruction_get_range(_ins));       \
        _cmt = g_db_comment_new_inlined(__addr, BLF_HAS_CODE, false);       \
        g_db_comment_add_static_text(_cmt, strdup(_txt)); /* ! */           \
        g_db_item_set_volatile(G_DB_ITEM(_cmt), true);                      \
        _sym = g_binary_symbol_new(STP_DATA);                               \
        g_binary_symbol_attach_instruction(_sym, _ins);                     \
        g_binary_symbol_set_comment(_sym, _cmt);                            \
        __result = g_binary_format_add_symbol(G_BIN_FORMAT(_fmt), _sym);    \
        __result;                                                           \
    })

#define ADD_RAW_AS_SYM_CST(_fmt, _sym, _ins, _cmt, _txt)                    \
    ({                                                                      \
        bool __result;                                                      \
        const vmpa2t *__addr;                                               \
        __addr = get_mrange_addr(g_arch_instruction_get_range(_ins));       \
        _cmt = g_db_comment_new_inlined(__addr, BLF_HAS_CODE, false);       \
        g_db_comment_add_static_text(_cmt, _txt);                           \
        g_db_item_set_volatile(G_DB_ITEM(_cmt), true);                      \
        _sym = g_binary_symbol_new(STP_DATA);                               \
        g_binary_symbol_attach_instruction(_sym, _ins);                     \
        g_binary_symbol_set_comment(_sym, _cmt);                            \
        __result = g_binary_format_add_symbol(G_BIN_FORMAT(_fmt), _sym);    \
        __result;                                                           \
    })

#define ADD_STR_AS_SYM(_fmt, _sym, _ins)                                    \
    ({                                                                      \
        bool __result;                                                      \
        _sym = g_binary_symbol_new(STP_RO_STRING);                          \
        g_binary_symbol_attach_instruction(_sym, _ins);                     \
        __result = g_binary_format_add_symbol(G_BIN_FORMAT(_fmt), _sym);    \
        __result;                                                           \
    })



/* ------------------------ OFFRE DE CAPACITES DE GENERATION ------------------------ */


/* Détermine si un symbole pour faire office de générateur. */
GLineGenerator *g_binary_symbol_produce_label(GBinSymbol *);



#endif  /* _FORMAT_SYMBOL_H */