summaryrefslogtreecommitdiff
path: root/src/analysis/binary.h
blob: 41c7f7adcbd8c303f6af1110103a36d102a56451 (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
197
198
199
200

/* Chrysalide - Outil d'analyse de fichiers binaires
 * binary.h - prototypes pour le traitement des flots de code binaire
 *
 * Copyright (C) 2008-2014 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 _ANALYSIS_BINARY_H
#define _ANALYSIS_BINARY_H


#include <glib-object.h>
#include <stdbool.h>

#include "content.h"
#include "db/collection.h"
#include "db/client.h"
#include "db/protocol.h"
#include "../arch/processor.h"
#include "../common/xml.h"
#include "../format/debuggable.h"
#include "../format/executable.h"
#include "../glibext/gcodebuffer.h"



/* Redéfinition depuis project.c : projet d'étude regroupant les binaires analysés (instance) */
typedef struct _GStudyProject GStudyProject;



#define G_TYPE_LOADED_BINARY               g_loaded_binary_get_type()
#define G_LOADED_BINARY(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj), g_loaded_binary_get_type(), GLoadedBinary))
#define G_IS_LOADED_BINARY(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj), g_loaded_binary_get_type()))
#define G_LOADED_BINARY_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST((klass), G_TYPE_LOADED_BINARY, GLoadedBinaryClass))
#define G_IS_LOADED_BINARY_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE((klass), G_TYPE_LOADED_BINARY))
#define G_LOADED_BINARY_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS((obj), G_TYPE_LOADED_BINARY, GLoadedBinaryClass))


/* Description de fichier binaire (instance) */
typedef struct _GLoadedBinary GLoadedBinary;

/* Description de fichier binaire (classe) */
typedef struct _GLoadedBinaryClass GLoadedBinaryClass;


/* Modèle de sélection des parties */
typedef enum _BinaryPartModel
{
    BPM_DEFAULT,                            /* Selon le modèle par défaut  */
    BPM_ROUTINES,                           /* Sélection par les routines  */
    BPM_USER,                               /* Définitions utilisateur     */

    BPM_COUNT

} BinaryPartModel;

/* Type de représentations */
typedef enum _BinaryView
{
    BVW_BLOCK,                              /* Version basique             */
    BVW_GRAPH,                              /* Affichage en graphique      */
    BVW_SOURCE,                             /* Code décompilé              */

    BVW_COUNT

} BinaryView;


/* Indique le type défini pour une description de fichier binaire. */
GType g_loaded_binary_get_type(void);

/* Interprète un contenu binaire chargé. */
GLoadedBinary *g_loaded_binary_new(GBinContent *);

/* Interprète un contenu binaire chargé avec un appui XML. */
GLoadedBinary *g_loaded_binary_new_from_xml(xmlXPathContextPtr, const char *, GStudyProject *);

/* Ecrit une sauvegarde du binaire dans un fichier XML. */
bool g_loaded_binary_save(const GLoadedBinary *, xmlDocPtr, xmlXPathContextPtr, const char *);

/* Fournit le nom associé à l'élément binaire. */
const char *g_loaded_binary_get_name(const GLoadedBinary *, bool);



/* ------------------------- INFORMATIONS D'ENREGISTREMENTS ------------------------- */


/* Identifie l'utilisateur analysant le binaire courant. */
const char *g_loaded_binary_get_username(const GLoadedBinary *);

/* Définit l'utilisateur analysant le binaire courant. */
void g_loaded_binary_set_username(GLoadedBinary *, const char *);

/* Détermine si tous les enregistrements sont locaux ou non. */
bool g_loaded_binary_get_local_storage(const GLoadedBinary *);

/* Définit si tous les enregistrements sont locaux ou non. */
void g_loaded_binary_set_local_storage(GLoadedBinary *, bool);

/* Identifie le serveur distant associé au binaire courant. */
void g_loaded_binary_get_remote_server(const GLoadedBinary *, const char **, unsigned short *);

/* Définit le serveur distant associé au binaire courant. */
void g_loaded_binary_set_remote_server(GLoadedBinary *, const char *, unsigned short);

/* Indique la forme d'enregistrement d'une fonctionnalité. */
DBStorage g_loaded_binary_get_storage(const GLoadedBinary *, DBFeatures);

/* Définit la forme d'enregistrement d'une fonctionnalité. */
void g_loaded_binary_set_storage(GLoadedBinary *, DBFeatures, DBStorage);



/* -------------------------- MANIPULATION DES COLLECTIONS -------------------------- */


/* Fournit le client assurant la liaison avec un serveur. */
GDbClient *g_loaded_binary_get_db_client(const GLoadedBinary *);

/* Fournit l'ensemble des collections utilisées par un binaire. */
GList *g_loaded_binary_get_all_collections(const GLoadedBinary *);

/* Trouve une collection assurant une fonctionnalité donnée. */
GDbCollection *g_loaded_binary_find_collection(const GLoadedBinary *, DBFeatures);

/* Demande l'intégration d'une modification dans une collection. */
bool _g_loaded_binary_add_to_collection(GLoadedBinary *, GDbItem *, bool);

#define g_loaded_binary_add_to_collection(b, i) \
    _g_loaded_binary_add_to_collection(b, i, true)

/* Demande la suppression de modification dans une collection. */
bool _g_loaded_binary_remove_from_collection(GLoadedBinary *, DBFeatures, GDbItem *, bool);

#define g_loaded_binary_remove_from_collection(b, f, i) \
    _g_loaded_binary_remove_from_collection(b, f, i, true)



/**
 * TODO :
 *
 * - connect_signal
 * - add_obj
 *
 */






/* Lance l'analyse d'un élément binaire chargé. */
void g_loaded_binary_analyse(GLoadedBinary *);

/* Fournit le format de fichier reconnu dans le contenu binaire. */
bool g_loaded_binary_attach_debug_info(GLoadedBinary *, GBinContent *);

/* Fournit le format de fichier reconnu dans le contenu binaire. */
GExeFormat *g_loaded_binary_get_format(const GLoadedBinary *);

/* Fournit le processeur de l'architecture liée au binaire. */
GArchProcessor *g_loaded_binary_get_processor(const GLoadedBinary *);

/* Fournit le tampon associé au contenu assembleur d'un binaire. */
GCodeBuffer *g_loaded_binary_get_disassembled_buffer(const GLoadedBinary *);

/* Fournit le tampon associé au contenu d'un fichier source. */
GCodeBuffer *g_loaded_binary_get_decompiled_buffer(const GLoadedBinary *, size_t);

/* Définit si une colonne donnée doit apparaître dans le rendu. */
void g_loaded_binary_set_column_display(GLoadedBinary *, BinaryView, BufferLineColumn, bool);

/* Indique quelles colonnes doivent apparaître dans le rendu. */
const bool *g_loaded_binary_get_column_display(GLoadedBinary *, BinaryView);

/* Indique si les lignes doivent apparaître dans le rendu. */
bool *g_loaded_binary_display_decomp_lines(GLoadedBinary *);



#endif  /* _ANALYSIS_BINARY_H */