summaryrefslogtreecommitdiff
path: root/src/format/executable.c
blob: ac67d620ae4b692b347439a3bf51d3999883bf6a (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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499

/* Chrysalide - Outil d'analyse de fichiers binaires
 * executable.c - support des formats d'exécutables
 *
 * 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/>.
 */


#include "executable.h"


#include <assert.h>
#include <malloc.h>
#include <stdio.h>
#include <stdlib.h>


#include "executable-int.h"
#include "format.h"
#include "../gui/panels/log.h"



/* Initialise la classe des formats d'exécutables génériques. */
static void g_executable_format_class_init(GExeFormatClass *);

/* Initialise une instance de format d'exécutable générique. */
static void g_executable_format_init(GExeFormat *);

/* Supprime toutes les références externes. */
static void g_executable_format_dispose(GExeFormat *);

/* Procède à la libération totale de la mémoire. */
static void g_executable_format_finalize(GExeFormat *);



/* Indique le type défini pour un format d'exécutable générique. */
G_DEFINE_TYPE(GExeFormat, g_executable_format, G_TYPE_BIN_FORMAT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des formats d'exécutables génériques.   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_executable_format_class_init(GExeFormatClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_executable_format_dispose;
    object->finalize = (GObjectFinalizeFunc)g_executable_format_finalize;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = instance à initialiser.                             *
*                                                                             *
*  Description : Initialise une instance de format d'exécutable générique.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_executable_format_init(GExeFormat *format)
{
    g_mutex_init(&format->mutex);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = instance d'objet GLib à traiter.                    *
*                                                                             *
*  Description : Supprime toutes les références externes.                     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_executable_format_dispose(GExeFormat *format)
{
    size_t i;                               /* Boucle de parcours          */

    for (i = 0; i < format->debugs_count; i++)
        g_object_unref(G_OBJECT(format->debugs[i]));

    if (format->portions != NULL)
        g_object_unref(G_OBJECT(format->portions));

    g_mutex_clear(&format->mutex);

    G_OBJECT_CLASS(g_executable_format_parent_class)->dispose(G_OBJECT(format));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = instance d'objet GLib à traiter.                    *
*                                                                             *
*  Description : Procède à la libération totale de la mémoire.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_executable_format_finalize(GExeFormat *format)
{
    G_OBJECT_CLASS(g_executable_format_parent_class)->finalize(G_OBJECT(format));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = informations chargées à compléter.                  *
*                info   = informations de débogage à lier.                    *
*                                                                             *
*  Description : Rajoute des informations de débogage à un exécutable.        *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_exe_format_add_debug_info(GExeFormat *format, GDbgFormat *info)
{
    /* Ajout dans la liste */

    format->debugs = (GDbgFormat **)realloc(format->debugs,
                                            ++format->debugs_count * sizeof(GDbgFormat *));

    format->debugs[format->debugs_count - 1] = info;

    /* Intégration des symboles */

    /* TODO */

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = informations chargées à consulter.                  *
*                                                                             *
*  Description : Compte le nombre de formats de débogage liés à l'exécutable. *
*                                                                             *
*  Retour      : Nombre de formats de débogage attachés.                      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

size_t g_exe_format_count_debug_info(const GExeFormat *format)
{
    return format->debugs_count;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = informations chargées à consulter.                  *
*                index  = indice des informations à transmettre.              *
*                                                                             *
*  Description : Fournit un format de débogage attaché à l'exécutable.        *
*                                                                             *
*  Retour      : Informations de débogage attachées.                          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GDbgFormat *g_exe_format_get_debug_info(const GExeFormat *format, size_t index)
{
    GDbgFormat *result;                     /* Format à retourner          */

    if (index >= format->debugs_count)
        result = NULL;

    else
    {
        result = format->debugs[index];
        g_object_ref(G_OBJECT(result));
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = informations chargées à consulter.                  *
*                                                                             *
*  Description : Indique le type d'architecture visée par le format.          *
*                                                                             *
*  Retour      : Identifiant de l'architecture ciblée par le format.          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

const char *g_exe_format_get_target_machine(const GExeFormat *format)
{
    return G_EXE_FORMAT_GET_CLASS(format)->get_machine(format);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à consulter.            *
*                addr   = adresse principale trouvée si possible. [OUT]       *
*                                                                             *
*  Description : Fournit l'adresse principale associée à un format.           *
*                                                                             *
*  Retour      : Bilan des recherches.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_exe_format_get_main_address(GExeFormat *format, vmpa2t *addr)
{
    bool result;                            /* Bilan à retourner           */
    GBinFormat *base;                       /* Version d'instance parente  */

    result = false;

    if (G_EXE_FORMAT_GET_CLASS(format)->get_main_addr != NULL)
        result = G_EXE_FORMAT_GET_CLASS(format)->get_main_addr(format, addr);

    if (!result)
    {
        base = G_BIN_FORMAT(format);

        g_rw_lock_reader_lock(&base->pt_lock);

        if (base->ep_count > 0)
            result = g_exe_format_translate_address_into_vmpa(format, base->entry_points[0], addr);

        g_rw_lock_reader_unlock(&base->pt_lock);

    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = instance à traiter.                                 *
*                status = barre de statut à tenir informée.                   *
*                                                                             *
*  Description : Effectue les ultimes opérations de chargement d'un binaire.  *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_executable_format_complete_loading(GExeFormat *format, GtkStatusStack *status)
{
    bool result;                            /* Bilan à faire remonter      */
    GBinFormat *base;                       /* Version basique du format   */
    vmpa2t addr;                            /* Emplacement vide de sens    */
    phys_t length;                          /* Taille de portion globale   */

    base = G_BIN_FORMAT(format);

    result = g_binary_format_complete_loading(base, status);

    if (result)
    {
        /**
         * Avant de lire l'entête du format, on ne sait pas où on se trouve !
         */
        init_vmpa(&addr, 0, VMPA_NO_VIRTUAL);

        length = g_binary_content_compute_size(base->content);

        format->portions = g_binary_portion_new(BPC_RAW, &addr, length);

        G_EXE_FORMAT_GET_CLASS(format)->refine_portions(format);

    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format  = description de l'exécutable à modifier.            *
*                portion = portion à inclure dans les définitions du format.  *
*                origin  = source de définition de la portion fournie.        *
*                                                                             *
*  Description : Procède à l'enregistrement d'une portion dans un format.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_exe_format_include_portion(GExeFormat *format, GBinPortion *portion, const vmpa2t *origin)
{
    phys_t available;                       /* Taille totale du bianire    */
    const mrange_t *range;                  /* Emplacement de la portion   */
    phys_t start;                           /* Début de zone de la portion */
    char *msg;                              /* Description d'une erreur    */
    phys_t remaining;                       /* Taille maximale envisageable*/
    bool truncated;                         /* Modification faite ?        */

    available = g_binary_content_compute_size(G_BIN_FORMAT(format)->content);

    range = g_binary_portion_get_range(portion);

    start = get_phy_addr(get_mrange_addr(range));

    if (start >= available)
    {
        assert(origin != NULL);

        asprintf(&msg, _("Defined binary portion '%s' is out of the file scope... Discarding!"),
                 g_binary_portion_get_desc(portion));

        g_binary_format_add_error(G_BIN_FORMAT(format), BFE_STRUCTURE, origin, msg);

        free(msg);

        g_object_unref(G_OBJECT(portion));

    }

    else
    {
        remaining = available - start;

        truncated = g_binary_portion_limit_range(portion, remaining);

        if (truncated)
            log_variadic_message(LMT_BAD_BINARY, _("Truncated binary portion '%s' to fit the binary content size!"),
                                 g_binary_portion_get_desc(portion));

        g_mutex_lock(&format->mutex);

        g_binary_portion_include(format->portions, portion);

        g_mutex_unlock(&format->mutex);

    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à consulter.            *
*                                                                             *
*  Description : Fournit la première couche des portions composent le binaire.*
*                                                                             *
*  Retour      : Arborescence des différentes portions binaires.              *
*                                                                             *
*  Remarques   : Le compteur de références de l'instance renvoyée doit être   *
*                décrémenté après usage.                                      *
*                                                                             *
******************************************************************************/

GBinPortion *g_exe_format_get_portions(GExeFormat *format)
{
    GBinPortion *result;                    /* Instance à retourner        */

    g_mutex_lock(&format->mutex);

    result = format->portions;

    if (result != NULL)
        g_object_ref(G_OBJECT(result));

    g_mutex_unlock(&format->mutex);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à consulter.            *
*                off    = position physique à retrouver.                      *
*                pos    = position correspondante. [OUT]                      *
*                                                                             *
*  Description : Fournit l'emplacement correspondant à une position physique. *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_exe_format_translate_offset_into_vmpa(const GExeFormat *format, phys_t off, vmpa2t *pos)
{
    bool result;                            /* Bilan à retourner           */

    result = G_EXE_FORMAT_GET_CLASS(format)->translate_phys(format, off, pos);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à consulter.            *
*                addr   = adresse virtuelle à retrouver.                      *
*                pos    = position correspondante. [OUT]                      *
*                                                                             *
*  Description : Fournit l'emplacement correspondant à une adresse virtuelle. *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_exe_format_translate_address_into_vmpa(const GExeFormat *format, virt_t addr, vmpa2t *pos)
{
    bool result;                            /* Bilan à retourner           */

    result = G_EXE_FORMAT_GET_CLASS(format)->translate_virt(format, addr, pos);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à consulter.            *
*                name   = nom de la section recherchée.                       *
*                range  = emplacement en mémoire à renseigner. [OUT]          *
*                                                                             *
*  Description : Fournit l'emplacement d'une section donnée.                  *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_exe_format_get_section_range_by_name(const GExeFormat *format, const char *name, mrange_t *range)
{
    bool result;                            /* Bilan à retourner           */

    result = G_EXE_FORMAT_GET_CLASS(format)->get_range_by_name(format, name, range);

    return result;

}