summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/analysis/block.c
blob: 1456e15b1e0effd60a826706c4b4ddb175113c01 (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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543

/* Chrysalide - Outil d'analyse de fichiers binaires
 * block.c - équivalent Python du fichier "analysis/block.c"
 *
 * Copyright (C) 2013-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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#include "block.h"


#include <pygobject.h>


#include <analysis/block.h>


#include "../access.h"
#include "../helpers.h"
#include "../arch/vmpa.h"



/* ----------------------------- BLOC DE CODE GENERIQUE ----------------------------- */


/* Indique l'indice d'intégration du bloc dans une liste. */
static PyObject *py_code_block_get_index(PyObject *, void *);

/* Fournit le rang du bloc de code dans le flot d'exécution. */
static PyObject *py_code_block_get_rank(PyObject *, void *);

/* Fournit les détails d'une source de bloc de code. */
static PyObject *py_code_block_get_sources(PyObject *, void *);

/* Fournit les détails des destinations de bloc de code. */
static PyObject *py_code_block_get_destinations(PyObject *, void *);



/* ------------------------- REGROUPEMENT EN LISTE DE BLOCS ------------------------- */


/* Recherche un bloc de code débutant à une adresse donnée. */
static PyObject *py_block_list_find_by_starting_addr(PyObject *, PyObject *);

/* Itère sur l'ensemble des blocs de code inclus dans une liste. */
static PyObject *py_block_list_iter(PyObject *);

/* Dénombre les blocs de code inclus dans une liste. */
static PyObject *py_block_list_count(PyObject *, void *);



/* ---------------------------------------------------------------------------------- */
/*                               BLOC DE CODE GENERIQUE                               */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Indique l'indice d'intégration du bloc dans une liste.       *
*                                                                             *
*  Retour      : Indice valide dans une liste.                                *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_code_block_get_index(PyObject *self, void *closure)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    GCodeBlock *block;                      /* Bloc de code à consulter    */
    size_t value;                           /* Valeur à transmettre        */

    block = G_CODE_BLOCK(pygobject_get(self));

    value = g_code_block_get_index(block);

    result = PyLong_FromSize_t(value);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit le rang du bloc de code dans le flot d'exécution.    *
*                                                                             *
*  Retour      : Indice supérieur ou égal à zéro.                             *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_code_block_get_rank(PyObject *self, void *closure)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    GCodeBlock *block;                      /* Bloc de code à consulter    */
    size_t value;                           /* Valeur à transmettre        */

    block = G_CODE_BLOCK(pygobject_get(self));

    value = g_code_block_get_rank(block);

    result = PyLong_FromSize_t(value);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit les détails d'une source de bloc de code.            *
*                                                                             *
*  Retour      : Liens déterminés vers des bloc de code de source.            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_code_block_get_sources(PyObject *self, void *closure)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    GCodeBlock *block;                      /* Bloc de code à consulter    */
    size_t count;                           /* Quantité de blocs liés      */
    size_t i;                               /* Boucle de parcours          */
    const block_link_t *link;               /* Informations conservées     */
    PyObject *info;                         /* Informations à transmettre  */

    block = G_CODE_BLOCK(pygobject_get(self));

    g_code_block_lock_src(block);

    count = g_code_block_count_sources(block);

    result = PyTuple_New(count);

    for (i = 0; i < count; i++)
    {
        link = g_code_block_get_source(block, i);

        info = PyTuple_New(2);

        PyTuple_SetItem(info, 0, pygobject_new(G_OBJECT(link->linked)));
        PyTuple_SetItem(info, 1, PyLong_FromUnsignedLong(link->type));

        PyTuple_SetItem(result, i, info);

        unref_block_link(link);

    }

    g_code_block_unlock_src(block);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit les détails des destinations de bloc de code.        *
*                                                                             *
*  Retour      : Liens déterminés vers des bloc de code de destination.       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_code_block_get_destinations(PyObject *self, void *closure)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    GCodeBlock *block;                      /* Bloc de code à consulter    */
    size_t count;                           /* Quantité de blocs liés      */
    size_t i;                               /* Boucle de parcours          */
    const block_link_t *link;               /* Informations conservées     */
    PyObject *info;                         /* Informations à transmettre  */

    block = G_CODE_BLOCK(pygobject_get(self));

    g_code_block_lock_dest(block);

    count = g_code_block_count_destinations(block);

    result = PyTuple_New(count);

    for (i = 0; i < count; i++)
    {
        link = g_code_block_get_destination(block, i);

        info = PyTuple_New(2);

        PyTuple_SetItem(info, 0, pygobject_new(G_OBJECT(link->linked)));
        PyTuple_SetItem(info, 1, PyLong_FromUnsignedLong(link->type));

        PyTuple_SetItem(result, i, info);

        unref_block_link(link);

    }

    g_code_block_unlock_dest(block);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Fournit un accès à une définition de type à diffuser.        *
*                                                                             *
*  Retour      : Définition d'objet pour Python.                              *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

PyTypeObject *get_python_code_block_type(void)
{
    static PyMethodDef py_code_block_methods[] = {
        { NULL }
    };

    static PyGetSetDef py_code_block_getseters[] = {
        {
            "index", py_code_block_get_index, NULL,
            "Index of the code block in the parent list, if any.", NULL
        },
        {
            "rank", py_code_block_get_rank, NULL,
            "Rang of the code block.", NULL
        },
        {
            "sources", py_code_block_get_sources, NULL,
            "List of source blocks.", NULL
        },
        {
            "destinations", py_code_block_get_destinations, NULL,
            "List of destination blocks.", NULL
        },
        { NULL }
    };

    static PyTypeObject py_code_block_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.analysis.CodeBlock",

        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

        .tp_doc         = "PyChrysalide code block",

        .tp_methods     = py_code_block_methods,
        .tp_getset      = py_code_block_getseters,

    };

    return &py_code_block_type;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Prend en charge l'objet 'pychrysalide.analysis.CodeBlock'.   *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool ensure_python_code_block_is_registered(void)
{
    PyTypeObject *type;                     /* Type Python 'InstrBlock'    */
    PyObject *module;                       /* Module à recompléter        */
    PyObject *dict;                         /* Dictionnaire du module      */

    type = get_python_code_block_type();

    if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
    {
        module = get_access_to_python_module("pychrysalide.analysis");

        dict = PyModule_GetDict(module);

        if (!register_class_for_pygobject(dict, G_TYPE_CODE_BLOCK, type, &PyGObject_Type))
            return false;

    }

    return true;

}



/* ---------------------------------------------------------------------------------- */
/*                           REGROUPEMENT EN LISTE DE BLOCS                           */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant une liste de blocs de code.       *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Recherche un bloc de code débutant à une adresse donnée.     *
*                                                                             *
*  Retour      : Bloc de code trouvé ou None si aucun.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_block_list_find_by_starting_addr(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Conclusion à retourner      */
    vmpa2t addr;                            /* Emplacement ciblé           */
    int ret;                                /* Bilan de lecture des args.  */
    GBlockList *list;                       /* Liste de blocs manipulée    */
    GCodeBlock *found;                      /* Eventuel bloc trouvé        */

    ret = PyArg_ParseTuple(args, "O&", convert_any_to_vmpa, &addr);
    if (!ret) return NULL;

    list = G_BLOCK_LIST(pygobject_get(self));

    found = g_block_list_find_by_starting_addr(list, &addr);

    if (found != NULL)
    {
        result = pygobject_new(G_OBJECT(found));
        g_object_unref(G_OBJECT(found));
    }
    else
    {
        result = Py_None;
        Py_INCREF(result);
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet Python concerné par l'appel.                    *
*                                                                             *
*  Description : Itère sur l'ensemble des blocs de code inclus dans une liste.*
*                                                                             *
*  Retour      : Liste de blocs de code capable d'itération.                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_block_list_iter(PyObject *self)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    GBlockList *list;                       /* Liste de blocs manipulée    */
    size_t count;                           /* Nombre de blocs présents    */
    size_t i;                               /* Boucle de parcours          */
    GCodeBlock *block;                      /* Bloc de code à intégrer     */

    list = G_BLOCK_LIST(pygobject_get(self));

    count = g_block_list_count_blocks(list);

    result = PyTuple_New(count);

    for (i = 0; i < count; i++)
    {
        block = g_block_list_get_block(list, i);

        PyTuple_SetItem(result, i, pygobject_new(G_OBJECT(block)));

        g_object_unref(G_OBJECT(block));

    }

    result = PySeqIter_New(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Dénombre les blocs de code inclus dans une liste.            *
*                                                                             *
*  Retour      : Quantité de blocs de code.                                   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_block_list_count(PyObject *self, void *closure)
{
    PyObject *result;                       /* Trouvailles à retourner     */
    GBlockList *list;                       /* Liste de blocs manipulée    */
    size_t count;                           /* Nombre de blocs présents    */

    list = G_BLOCK_LIST(pygobject_get(self));

    count = g_block_list_count_blocks(list);

    result = PyLong_FromUnsignedLong(count);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Fournit un accès à une définition de type à diffuser.        *
*                                                                             *
*  Retour      : Définition d'objet pour Python.                              *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

PyTypeObject *get_python_block_list_type(void)
{
    static PyMethodDef py_block_list_methods[] = {
        {
            "find_by_starting_addr", py_block_list_find_by_starting_addr,
            METH_VARARGS,
            "find_by_starting_addr($self, addr, /)\n--\n\nFind a code block starting at a given address."
        },
        { NULL }
    };

    static PyGetSetDef py_block_list_getseters[] = {
        {
            "count", py_block_list_count, NULL,
            "Quantity of code blocks included in the list.", NULL
        },
        { NULL }
    };

    static PyTypeObject py_block_list_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.analysis.BlockList",

        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

        .tp_doc         = "PyChrysalide basic block",

        .tp_iter        = py_block_list_iter,

        .tp_methods     = py_block_list_methods,
        .tp_getset      = py_block_list_getseters,

    };

    return &py_block_list_type;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Prend en charge l'objet 'pychrysalide.analysis.BlockList'.   *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool ensure_python_block_list_is_registered(void)
{
    PyTypeObject *type;                     /* Type Python 'BlockList'     */
    PyObject *module;                       /* Module à recompléter        */
    PyObject *dict;                         /* Dictionnaire du module      */

    type = get_python_block_list_type();

    if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
    {
        module = get_access_to_python_module("pychrysalide.analysis");

        dict = PyModule_GetDict(module);

        if (!register_class_for_pygobject(dict, G_TYPE_BLOCK_LIST, type, &PyGObject_Type))
            return false;

    }

    return true;

}