summaryrefslogtreecommitdiff
path: root/src/analysis/decomp/reduce.c
blob: 42ff983a77a38542477660d651678564ab225e35 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * reduce.c - réduction de l'usage des [pseudo]-registres
 *
 * Copyright (C) 2012-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 "reduce.h"


#include <malloc.h>


#include "../../decomp/expr/assign.h"
#include "../../decomp/expr/block.h"
#include "../../decomp/expr/immediate.h"
#include "../../decomp/expr/pseudo.h"



/* ------------------------ DECOMPTE DES USAGES DE VARIABLES ------------------------ */


/* Mémorisation de l'usage d'une variable */
typedef struct _assigned_value
{
    GDecInstruction *value;                 /* Valeur de cette variable    */

    GDecInstruction *assign;                /* Lieu d'assignation          */
    GDecInstruction *parent;                /* Zone à nettoyer au besoin   */

    size_t used_counter;                    /* Décompte des utilisations   */
    size_t shared_counter;                  /* Partage entre tables        */

} assigned_value;


/* Conserve tous les éléments concernant une assignation. */
static assigned_value *memorize_assigned_value(GDecInstruction *, GDecInstruction *, GDecInstruction *);

/* Met (éventuellement) fin à un suivi d'assignation. */
static void forget_assigned_value(assigned_value *);

/* Constitue un lieu de conservation d'associations pour bloc. */
static GHashTable *create_tracking_table(GHashTable *);

/* Met à jour les décomptes des différentes assignations. */
static void merge_usages(GHashTable *, GHashTable *);

/* Prend notre d'une assignation d'une valeur à une variable. */
static void note_new_variable(GHashTable *, GDecInstruction *, assigned_value *);



/* ---------------------- VISITES DES INSTRUCTIONS DECOMPILEES ---------------------- */


/* Prend note de tous les accès aux différentes variables. */
static void collect_used_variables(GDecInstruction *, GDecInstruction *, GHashTable *);

/* Procède au remplacement de variables à rejeter. */
static void replace_useless_variable(GDecInstruction *, GHashTable *);

/* Visite un groupe d'instructions décompilées. */
static bool visit_instructions_block(GDecInstruction *, GDecInstruction *, DecInstrVisitFlags, GHashTable **);



/* ---------------------------------------------------------------------------------- */
/*                          DECOMPTE DES USAGES DE VARIABLES                          */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : value  = nouvelle valeur assignée à suivre.                  *
*                assign = instruction où la valeur est assignée.              *
*                parent = bloc d'instructions à soulager en cas d'effacement. *
*                table  = mémorisation des usages de variables.               *
*                                                                             *
*  Description : Conserve tous les éléments concernant une assignation.       *
*                                                                             *
*  Retour      : Structure mise en place.                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static assigned_value *memorize_assigned_value(GDecInstruction *value, GDecInstruction *assign, GDecInstruction *parent)
{
    assigned_value *result;                 /* Mémorisation à retourner    */

    result = (assigned_value *)calloc(1, sizeof(assigned_value));

    g_object_ref(G_OBJECT(value));
    result->value = value;

    g_object_ref(G_OBJECT(assign));
    g_object_ref(G_OBJECT(parent));
    result->assign = assign;
    result->parent = parent;

    result->used_counter = 0;
    result->shared_counter = 0;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : val = structure à libérer de la mémoire.                     *
*                                                                             *
*  Description : Met (éventuellement) fin à un suivi d'assignation.           *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void forget_assigned_value(assigned_value *val)
{
    if (--val->shared_counter == 0)
    {
        g_object_unref(G_OBJECT(val->value));

        g_object_unref(G_OBJECT(val->assign));
        g_object_unref(G_OBJECT(val->parent));

        free(val);

    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : parent = éventuel bloc d'instructions parent ou NULL.        *
*                                                                             *
*  Description : Constitue un lieu de conservation d'associations pour bloc.  *
*                                                                             *
*  Retour      : Table prête à emploi.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static GHashTable *create_tracking_table(GHashTable *parent)
{
    GHashTable *result;                     /* Création à retourner        */
    GHashTableIter iter;                    /* Boucle de parcours          */
    GDecInstruction *var;                   /* Variable assignée           */
    assigned_value *val;                    /* Valeur assignée             */

    result = g_hash_table_new_full(NULL, NULL, g_object_unref,
                                   (GDestroyNotify)forget_assigned_value);

    if (parent != NULL)
    {
        g_hash_table_iter_init(&iter, parent);

        while (g_hash_table_iter_next(&iter, (gpointer *)&var, (gpointer *)&val))
            note_new_variable(result, var, val);

    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : table = conservation des associations variable <-> valeur.   *
*                sub   = conservation issue d'un sous bloc.                   *
*                                                                             *
*  Description : Met à jour les décomptes des différentes assignations.       *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void merge_usages(GHashTable *table, GHashTable *sub)
{
    GHashTableIter iter;                    /* Boucle de parcours          */
    GDecInstruction *var;                   /* Variable assignée           */
    assigned_value *val;                    /* Valeur assignée             */
    assigned_value *update;                 /* Même valeur, mise à jour    */

    g_hash_table_iter_init(&iter, table);

    while (g_hash_table_iter_next(&iter, (gpointer *)&var, (gpointer *)&val))
    {
        update = (assigned_value *)g_hash_table_lookup(sub, var);

        val->used_counter = update->used_counter;

        g_hash_table_remove(sub, var);

    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : table = conservation des associations variable <-> valeur.   *
*                var   = variable en place à suivre.                          *
*                val   = valeur associée.                                     *
*                                                                             *
*  Description : Prend notre d'une assignation d'une valeur à une variable.   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void note_new_variable(GHashTable *table, GDecInstruction *var, assigned_value *val)
{
    g_object_ref(G_OBJECT(var));
    val->shared_counter++;

    g_hash_table_insert(table, var, val);

}



/* ---------------------------------------------------------------------------------- */
/*                        VISITES DES INSTRUCTIONS DECOMPILEES                        */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : instr  = instruction visitée.                                *
*                parent = instruction parente.                                *
*                table  = mémorisation des usages de variables.               *
*                                                                             *
*  Description : Prend note de tous les accès aux différentes variables.      *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void collect_used_variables(GDecInstruction *instr, GDecInstruction *parent, GHashTable *table)
{
    GAssignExpression *assign;              /* Instruction d'assignation   */
    GDecInstruction *dest;                  /* Variable de destination     */
    bool valid;                             /* Destination valide ?        */
    GDecInstruction *src;                   /* Valeur de source            */
    assigned_value *value;                  /* Valeur et ses informations  */

    if (G_IS_ASSIGN_EXPRESSION(instr))
    {
        assign = G_ASSIGN_EXPRESSION(instr);

        dest = G_DEC_INSTRUCTION(g_assign_expression_get_dest(assign));

        if (G_IS_PSEUDO_REGISTER(dest))
            valid = (g_pseudo_register_get_usage(G_PSEUDO_REGISTER(dest)) == PRU_LOCAL);
        else
            valid = true;

        if (valid)
        {
            src = G_DEC_INSTRUCTION(g_assign_expression_get_src(assign));

            value = memorize_assigned_value(src, instr, parent);
            note_new_variable(table, dest, value);

        }

    }
    else
    {
        value = (assigned_value *)g_hash_table_lookup(table, instr);

        if (value != NULL)
            value->used_counter++;

    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : block = bloc d'instructions décompilées à traiter.           *
*                table = mémorisation des usages de variables.                *
*                                                                             *
*  Description : Procède au remplacement de variables à rejeter.              *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void replace_useless_variable(GDecInstruction *block, GHashTable *table)
{
    GHashTableIter iter;                    /* Boucle de parcours          */
    GDecInstruction *var;                   /* Variable assignée           */
    assigned_value *val;                    /* Valeur assignée             */
    bool replace;                           /* Ordre de remplacement       */

    g_hash_table_iter_init(&iter, table);

    while (g_hash_table_iter_next(&iter, (gpointer *)&var, (gpointer *)&val))
    {
        replace = (G_IS_IMM_EXPRESSION(val->value) && (val->used_counter > 1));
        replace |= (val->used_counter == 2);    /* 1 assign. + 1 usage */

        if (!replace) continue;

        g_expr_block_delete_item(G_EXPR_BLOCK(val->parent), val->assign);

        g_dec_instruction_replace(block, var, val->value);

    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : instr  = instruction visitée.                                *
*                parent = instruction parente.                                *
*                flags  = moments des appels réalisés en retour.              *
*                table  = mémorisation des usages de variables.               *
*                                                                             *
*  Description : Visite un groupe d'instructions décompilées.                 *
*                                                                             *
*  Retour      : true afin d'aller jusqu'au terme du parcours.                *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool visit_instructions_block(GDecInstruction *instr, GDecInstruction *parent, DecInstrVisitFlags flags, GHashTable **table)
{
    GHashTable *sub;                        /* Associations pour sous-bloc */

    if (G_IS_EXPR_BLOCK(instr))
    {
        /* Entrée dans un bloc : on crée un contexte propre au bloc ! */
        if (flags == DVF_ENTER)
        {
            g_object_set_data(G_OBJECT(instr), "var_collect", *table);
            *table = create_tracking_table(*table);
        }

        /* Sortie du bloc : actions locales + purge ! */
        else if (flags == DVF_EXIT)
        {
            sub = *table;
            *table = (GHashTable *)g_object_get_data(G_OBJECT(instr), "var_collect");

            if (*table != NULL)
                merge_usages(*table, sub);

            replace_useless_variable(instr, sub);
            g_hash_table_unref(sub);

        }

    }

    else if (flags == DVF_ENTER)
        collect_used_variables(instr, parent, *table);

    return true;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : instr = instructions à traiter.                              *
*                                                                             *
*  Description : Réduit le nombre de variables utilisées, via propagations.   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void reduce_used_variables(GDecInstruction *instr)
{
    GHashTable *table;

    table = NULL;

    g_dec_instruction_visit(instr, (dec_instr_visitor_cb)visit_instructions_block,
                            DVF_ENTER | DVF_EXIT, &table);

}