summaryrefslogtreecommitdiff
path: root/src/analysis/disass/loop.c
blob: c37c7f64046a92d9cee28a85bdb8e4d885a1fd8b (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * loop.c - détection des boucles dans du code machine
 *
 * 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 Chrysalide.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "loop.h"


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


#include "block.h"



/**
 * Adaptation de l'algorithme : "A New Algorithm for Identifying Loops in Decompilation".
 */



/* Informations associées à un bloc */
typedef struct _bblock_info_t
{
    bool traversed;                         /* Etat du traitement          */
    unsigned int dfsp_pos;                  /* Indice dans un chemin       */
    struct _bblock_info_t *iloop_header;    /* Pointeur de bloc d'entête   */

    bool irreducible;                       /* Détection d'irreducible     */

} bblock_info_t;

/* Informations associées à un lien */
typedef struct _bblock_link_t
{
    GCodeBlock *linked;                     /* Destination du bloc visé    */
    InstructionLinkType type;               /* Type de liaison             */
    bblock_info_t *info;                    /* Informations sur ce bloc    */

} bblock_link_t;


/* Détermine les liens vers des blocs successeurs d'un bloc. */
static bblock_link_t *get_block_links(GCodeBlock *, bblock_info_t *, bool, size_t *);

#define get_block_predecessors(b, i, c) \
    get_block_links(b, i, false, c)

#define get_block_successors(b, i, c) \
    get_block_links(b, i, true, c)

/* Libère de la mémoire les liens vers des blocs successeurs. */
static void delete_block_links(bblock_link_t *, size_t);

/* Marque un bloc comme étant un entête de boucle. */
static void tag_loop_head(bblock_info_t *, bblock_info_t *);

/* Parcourt une arborescence de blocs à la recherche de boucles. */
static bblock_info_t *traverse_basic_blocks_dfs(bblock_info_t *, GBlockList *, bblock_info_t *, unsigned int);

/* Indique si une boucle doit être définie. */
static bool should_be_natural_loop_link(bblock_info_t *, bblock_info_t *);

/* Définit les boucles entre un ensemble de blocs basiques. */
static void define_basic_blocks_loops(GBlockList *list, bblock_info_t *);



/******************************************************************************
*                                                                             *
*  Paramètres  : block = bloc de code, basique, à considérer.                 *
*                info  = informations complémentaires quant aux blocs.        *
*                succ  = true si les successeurs sont visés, false sinon.     *
*                count = nombre de liens effectivement utiles. [OUT]          *
*                                                                             *
*  Description : Détermine les liens vers des blocs successeurs d'un bloc.    *
*                                                                             *
*  Retour      : Liste de liens retrouvés ou NULL si vraiment aucun.          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bblock_link_t *get_block_links(GCodeBlock *block, bblock_info_t *info, bool succ, size_t *count)
{
    bblock_link_t *result;                  /* Liste à retourner           */
    size_t allocated;                       /* Nombre d'éléments au maximum*/
    block_link_t *links;                    /* Liens associés au bloc      */
    size_t i;                               /* Boucle de parcours          */
    bblock_link_t *new;                     /* Mémorisation de ce lien     */

    if (succ)
        links = g_code_block_get_destinations(block, &allocated);
    else
        links = g_code_block_get_sources(block, &allocated);

    result = malloc(allocated * sizeof(bblock_link_t));

    *count = 0;

    for (i = 0; i < allocated; i++)
    {
        switch (links[i].type)
        {
            case ILT_EXEC_FLOW:
            case ILT_JUMP:
            case ILT_CASE_JUMP:
            case ILT_JUMP_IF_TRUE:
            case ILT_JUMP_IF_FALSE:

                new = &result[(*count)++];

                new->linked = links[i].linked;
                g_object_ref(G_OBJECT(new->linked));

                new->type = links[i].type;

                new->info = info + g_code_block_get_index(new->linked);

                break;

            default:
                break;

        }

        unref_block_link(&links[i]);

    }

    if (links != NULL)
        free(links);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : links = liste de liens retrouvés ou NULL si vraiment aucun.  *
*                count = nombre de liens effectivement utiles.                *
*                                                                             *
*  Description : Libère de la mémoire les liens vers des blocs successeurs.   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void delete_block_links(bblock_link_t *links, size_t count)
{
    size_t i;                               /* Boucle de parcours          */

    for (i = 0; i < count; i++)
        g_object_unref(G_OBJECT(links[i].linked));

    if (links != NULL)
        free(links);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : blk = bloc à mettre à jour.                                  *
*                hdr = bloc d'entête à mémoriser.                             *
*                                                                             *
*  Description : Marque un bloc comme étant un entête de boucle.              *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void tag_loop_head(bblock_info_t *blk, bblock_info_t *hdr)
{
    bblock_info_t *cur1;                    /* Boucle de parcours #1       */
    bblock_info_t *cur2;                    /* Boucle de parcours #2       */
    bblock_info_t *ih;                      /* Boucle de parcours #3       */

    if (blk == hdr || hdr == NULL)
        goto done;

    cur1 = blk;
    cur2 = hdr;

    while (cur1->iloop_header != NULL)
    {
        ih = cur1->iloop_header;

        if (ih == cur2)
            goto done;

        if (ih->dfsp_pos < cur2->dfsp_pos)
        {
            cur1->iloop_header = cur2;
            cur1 = cur2;
            cur2 = ih;
        }

        else
            cur1 = ih;

    }

    cur1->iloop_header = cur2;

 done:

    ;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : root = élément racine à considérer.                          *
*                list = liste de blocs de code à consulter.                   *
*                info = informations complémentaires quant aux blocs.         *
*                pos  = position dans le chemin courant.                      *
*                                                                             *
*  Description : Parcourt une arborescence de blocs à la recherche de boucles.*
*                                                                             *
*  Retour      : Entête de boucle trouvée ou NULL.                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bblock_info_t *traverse_basic_blocks_dfs(bblock_info_t *root, GBlockList *list, bblock_info_t *info, unsigned int pos)
{
    GCodeBlock *block;                      /* Bloc basique courant        */
    bblock_link_t *links;                   /* Liste de successeurs        */
    size_t count;                           /* Taille de cette liste       */
    size_t i;                               /* Boucle de parcours          */
    bblock_info_t *succ;                    /* Successeur à traiter        */
    bblock_info_t *nh;                      /* Nouvel entête de boucle     */
    bblock_info_t *h;                       /* Entête de boucle            */

    root->traversed = true;
    root->dfsp_pos = pos;

    block = g_block_list_get_block(list, root - info);

    links = get_block_successors(block, info, &count);

    for (i = 0; i < count; i++)
    {
        succ = links[i].info;

        /* Cas A : bloc jamais traversé */
        if (!succ->traversed)
        {
            nh = traverse_basic_blocks_dfs(succ, list, info, pos + 1);
            tag_loop_head(root, nh);
        }

        else
        {
            /* Le successeur est dans DFSP(root) */
            if (succ->dfsp_pos > 0)
            {
                /* Cas B : on le marque en tant qu'entête de boucle */
                tag_loop_head(root, succ);
            }

            /* Cas C : on ne fait rien */
            else if (succ->iloop_header == NULL)
            {

            }

            else
            {
                h = succ->iloop_header;

                /* h est dans DFSP(root) */
                if (h->dfsp_pos > 0)
                {
                    /* Cas D */
                    tag_loop_head(root, h);
                }

                /* h n'est pas dans DFSP(root) */
                else
                {
                    /* Cas E : réentrance */

                    succ->irreducible = true;

                    while (h->iloop_header != NULL)
                    {
                        h = h->iloop_header;

                        /* h est dans DFSP(root) */
                        if (h->dfsp_pos > 0)
                        {
                            tag_loop_head(root, h);
                            break;
                        }

                    }

                }

            }

        }

    }

    delete_block_links(links, count);

    g_object_unref(G_OBJECT(block));

    /* Efface la position du bloc courant dans le chemin */
    root->dfsp_pos = 0;

    return root->iloop_header;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : dest   = informations du bloc de destination.                *
*                header = informations de l'entête de boucle.                 *
*                                                                             *
*  Description : Indique si une boucle doit être définie.                     *
*                                                                             *
*  Retour      : true si une boucle naturelle est bien présente.              *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool should_be_natural_loop_link(bblock_info_t *dest, bblock_info_t *header)
{
    bool result;                            /* Conclusion à retourner      */

    result = (dest == header);

    if (!result && header != NULL)
        result = should_be_natural_loop_link(dest, header->iloop_header);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : list = liste de blocs de code à consulter.                   *
*                info = informations complémentaires quant aux blocs.         *
*                                                                             *
*  Description : Définit les boucles entre un ensemble de blocs basiques.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void define_basic_blocks_loops(GBlockList *list, bblock_info_t *info)
{
    size_t available;                       /* Quantité de blocs présents  */
    size_t i;                               /* Boucle de parcours #1       */
    bblock_info_t *iter;                    /* Boucle de parcours #2       */
    GCodeBlock *block;                      /* Bloc basique courant        */
    bblock_link_t *links;                   /* Liste de successeurs        */
    size_t count;                           /* Taille de cette liste       */
    size_t k;                               /* Boucle de parcours #3       */
    GArchInstruction *first;                /* Instruction initiale de bloc*/
    GArchInstruction *last;                 /* Instruction finale de bloc  */
#ifndef NDEBUG
    bool status;                            /* Bilan du changement         */
#endif

    available = g_block_list_count_blocks(list);

    for (i = 0, iter = info; i < available; i++, iter++)
    {
        block = g_block_list_get_block(list, i);

        if (iter->irreducible)
        {
            links = get_block_predecessors(block, info, &count);

            for (k = 0; k < count; k++)
                if (should_be_natural_loop_link(iter->iloop_header, links[k].info->iloop_header))
                {
                    g_basic_block_get_boundaries(G_BASIC_BLOCK(links[k].linked), NULL, &last);
                    g_basic_block_get_boundaries(G_BASIC_BLOCK(block), &first, NULL);

                    g_arch_instruction_lock_dest(last);

#ifndef NDEBUG
                    status = g_arch_instruction_change_link(last, first, links[k].type, ILT_LOOP);
                    assert(status);
#else
                    g_arch_instruction_change_link(last, first, links[k].type, ILT_LOOP);
#endif

                    g_arch_instruction_unlock_dest(last);

                    g_object_unref(G_OBJECT(first));
                    g_object_unref(G_OBJECT(last));

                }

        }

        else
        {
            links = get_block_successors(block, info, &count);

            for (k = 0; k < count; k++)
                if (should_be_natural_loop_link(links[k].info, iter->iloop_header)
                    /**
                     * Il se peut qu'un bloc fasse référence à lui même !
                     *
                     * Cf. tests/analysis/disass/selfloop.c
                     *
                     * On évite ici une boucle sans fin en officialisant cette boucle.
                     */
                    || links[k].info == iter)
                {
                    g_basic_block_get_boundaries(G_BASIC_BLOCK(block), NULL, &last);
                    g_basic_block_get_boundaries(G_BASIC_BLOCK(links[k].linked), &first, NULL);

                    g_arch_instruction_lock_dest(last);

#ifndef NDEBUG
                    status = g_arch_instruction_change_link(last, first, links[k].type, ILT_LOOP);
                    assert(status);
#else
                    g_arch_instruction_change_link(last, first, links[k].type, ILT_LOOP);
#endif

                    g_arch_instruction_unlock_dest(last);

                    g_object_unref(G_OBJECT(first));
                    g_object_unref(G_OBJECT(last));

                }

        }

        delete_block_links(links, count);

        g_object_unref(G_OBJECT(block));

    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : list = liste de blocs de code à consulter.                   *
*                                                                             *
*  Description : Détecte les boucles dans du code machine.                    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void detect_loops_in_basic_blocks(GBlockList *list)
{
    size_t count;                           /* Quantité de blocs présents  */
    bblock_info_t *info;                    /* Informations supplémentaires*/

    count = g_block_list_count_blocks(list);

    if (count > 1)
    {
        info = calloc(count, sizeof(bblock_info_t));

        traverse_basic_blocks_dfs(&info[0], list, info, 1);

        define_basic_blocks_loops(list, info);

        free(info);

    }

}