summaryrefslogtreecommitdiff
path: root/tools/d2c/rules.c
blob: 6f2e0757dfb5c3ee8d9627b947f5b24db3347553 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * rules.h - prototypes pour les variations de décodage selon certaines conditions
 *
 * Copyright (C) 2014 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  OpenIDA 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.
 *
 *  OpenIDA 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 "rules.h"


#include <malloc.h>
#include <stdbool.h>
#include <string.h>


#include "helpers.h"
#include "qckcall.h"



/* -------------------------- CONDITIONS DE DECLENCHEMENTS -------------------------- */


/* Expression d'une condition */
struct _cond_expr
{
    bool is_simple;                         /* Sélection de champ          */

    union
    {
        struct
        {
            char *variable;                 /* Variable manipulée          */
            CondCompType comp;              /* Type de comparaison         */
            char *bvalue;                   /* Valeur binaire comparée     */

        } simple;

        struct
        {
            cond_expr *a;                   /* Première sous-expression    */
            CondOpType operator;            /* Relation entre expressions  */
            cond_expr *b;                   /* Seconde sous-expression     */

        } composed;

    };

};


/* Libère de la mémoire une expression conditionnelle. */
static void delete_cond_expr(cond_expr *);

/* Traduit en code une expression de condition. */
static bool write_cond_expr(const cond_expr *, int, const coding_bits *);



/* ------------------------- REGLES ET ACTIONS CONSEQUENTES ------------------------- */


/* Règle particulière */
typedef struct _extra_rule
{
    cond_expr *expr;                        /* Expression de déclenchement */
    rule_action action;                     /* Conséquence d'une validation*/

} extra_rule;

/* Règles de décodage supplémentaires */
struct _decoding_rules
{
    extra_rule *extra;                      /* Règles conditionnelles      */
    size_t extra_count;                     /* Nombre de ces règles        */

};



/* ---------------------------------------------------------------------------------- */
/*                            CONDITIONS DE DECLENCHEMENTS                            */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : variable = désignation de la variable à manipuler.           *
*                comp     = type de comparaison à utiliser.                   *
*                bvalue   = valeur binaire à comparer.                        *
*                                                                             *
*  Description : Crée une expression conditionnelle simple.                   *
*                                                                             *
*  Retour      : Structure mise en place.                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

cond_expr *build_simple_cond_expression(char *variable, CondCompType comp, char *bvalue)
{
    cond_expr *result;                      /* Structure à retourner       */

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

    result->is_simple = true;

    result->simple.variable = make_string_lower(variable);
    result->simple.comp = comp;
    result->simple.bvalue = bvalue;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : a        = première expression à intégrer.                   *
*                operator = type de comparaison à utiliser.                   *
*                b        = second expression à intégrer.                     *
*                                                                             *
*  Description : Crée une expression conditionnelle composée.                 *
*                                                                             *
*  Retour      : Structure mise en place.                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

cond_expr *build_composed_cond_expression(cond_expr *a, CondOpType operator, cond_expr *b)
{
    cond_expr *result;                      /* Structure à retourner       */

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

    result->is_simple = false;

    result->composed.a = a;
    result->composed.operator = operator;
    result->composed.b = b;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : expr = représentation d'expression à traiter.                *
*                                                                             *
*  Description : Libère de la mémoire une expression conditionnelle.          *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void delete_cond_expr(cond_expr *expr)
{
    if (expr->is_simple)
    {
        free(expr->simple.variable);
        free(expr->simple.bvalue);
    }
    else
    {
        delete_cond_expr(expr->composed.a);
        delete_cond_expr(expr->composed.b);
    }

    free(expr);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : expr = expression simple ou composée à transposer.           *
*                fd   = descripteur d'un flux ouvert en écriture.             *
*                bits = gestionnaire des bits d'encodage.                     *
*                                                                             *
*  Description : Traduit en code une expression de condition.                 *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool write_cond_expr(const cond_expr *expr, int fd, const coding_bits *bits)
{
    bool result;                            /* Bilan à renvoyer            */
    const raw_bitfield *bf;                 /* Champ de bits de définition */

    result = true;

    dprintf(fd, "(");

    if (expr->is_simple)
    {
        bf = find_named_field_in_bits(bits, expr->simple.variable);
        if (bf == NULL)
        {
            fprintf(stderr, "Error: no bitfield defined the requested variable '%s'.\n", expr->simple.variable);
            result = false;
            goto wce_exit;
        }

        if (get_raw_bitfield_length(bf) != strlen(expr->simple.bvalue))
        {
            fprintf(stderr, "Error: variable '%s' and provided value sizes do not match (%u vs %zu).\n",
                    expr->simple.variable, get_raw_bitfield_length(bf), strlen(expr->simple.bvalue));
            result = false;
            goto wce_exit;
        }

        dprintf(fd, "raw_%s", expr->simple.variable);

        switch (expr->simple.comp)
        {
            case CCT_EQUAL:
                dprintf(fd, " == ");
                break;
            case CCT_DIFF:
                dprintf(fd, " != ");
                break;
        }

        dprintf(fd, "b%s", expr->simple.bvalue);

    }
    else
    {
        result = write_cond_expr(expr->composed.a, fd, bits);
        if (!result) goto wce_exit;

        switch (expr->composed.operator)
        {
            case COT_AND:
                dprintf(fd, " && ");
                break;
            case COT_OR:
                dprintf(fd, " || ");
                break;
        }

        result = write_cond_expr(expr->composed.b, fd, bits);
        if (!result) goto wce_exit;

    }

    dprintf(fd, ")");

 wce_exit:

    return result;

}



/* ---------------------------------------------------------------------------------- */
/*                           REGLES ET ACTIONS CONSEQUENTES                           */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Crée un nouveau rassemblement de règles de décodage.         *
*                                                                             *
*  Retour      : Nouvelle structure prête à emploi.                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

decoding_rules *create_decoding_rules(void)
{
    decoding_rules *result;                       /* Définition vierge à renvoyer*/

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

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : rules = ensemble de règles de décodage à supprimer.          *
*                                                                             *
*  Description : Supprime de la mémoire un ensemble de règles supplémentaires.*
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void delete_decoding_rules(decoding_rules *rules)
{
    size_t i;                               /* Boucle de parcours          */
    extra_rule *rule;                       /* Règle à traiter             */

    for (i = 0; i < rules->extra_count; i++)
    {
        rule = &rules->extra[i];

        if (rule->expr != NULL)
            delete_cond_expr(rule->expr);

        switch (rule->action.type)
        {
            case CAT_SEE:
                free(rule->action.details);
                break;

            case CAT_UNPREDICTABLE:
                break;

            case CAT_CALL:
                free(rule->action.callee);
                delete_arg_list(rule->action.args);
                break;

        }

    }

    if (rules->extra != NULL)
        free(rules->extra);

    free(rules);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : rules   = ensemble de règles à compléter.                    *
*                expr    = représentation d'expression à conserver.           *
*                action  = conséquence associée à la règle.                   *
*                                                                             *
*  Description : Ajoute une règle complète à la définition d'un codage.       *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void register_conditional_rule(decoding_rules *rules, cond_expr *expr, const rule_action *action)
{
    extra_rule *rule;                       /* Nouvelle prise en compte    */

    rules->extra = (extra_rule *)realloc(rules->extra, ++rules->extra_count * sizeof(extra_rule));

    rule = &rules->extra[rules->extra_count - 1];

    rule->expr = expr;
    rule->action = *action;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : rules   = ensemble de règles à consulter.                    *
*                filter  = filtre sur les règles à effectivement imprimer.    *
*                fd      = descripteur d'un flux ouvert en écriture.          *
*                arch    = architecture visée par l'opération.                *
*                subarch = sous-catégorie de cette même architecture.         *
*                bits    = gestionnaire des bits d'encodage.                  *
*                list    = liste de l'ensemble des fonctions de conversion.   *
*                pp      = pré-processeur pour les échanges de chaînes.       *
*                exit    = exprime le besoin d'une voie de sortie. [OUT]      *
*                                                                             *
*  Description : Traduit en code les éventuelles règles présentes.            *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool write_decoding_rules(decoding_rules *rules, CondActionType filter, int fd, const char *arch, const char *subarch, const coding_bits *bits, const conv_list *list, const pre_processor *pp, bool *exit)
{
    bool result;                            /* Bilan à remonter            */
    const extra_rule *rule;                 /* Règle en cours d'écriture   */
    size_t i;                               /* Boucle de parcours          */
    const char *callable;                   /* Fonction à appeler          */

    result = true;

    for (i = 0; i < rules->extra_count; i++)
    {
        rule = &rules->extra[i];

        if (rule->action.type != filter)
            continue;

        if (rule->expr != NULL)
        {
            dprintf(fd, "\t\tif ");

            result = write_cond_expr(rule->expr, fd, bits);
            if (!result) break;

            dprintf(fd, "\n");
            dprintf(fd, "\t\t{\n");

        }

        switch (rule->action.type)
        {
            case CAT_SEE:

                dprintf(fd, "\t\t\tinstr = %s_read_%sinstr_%s", arch, subarch, rule->action.details);

                /* TODO : adapter les paramètres d'appel selon le 'coder' */
                dprintf(fd, "(_raw);\n");

                dprintf(fd, "\t\t\tgoto quick_exit;\n");

                *exit = true;
                break;

            case CAT_UNPREDICTABLE:
                break;

            case CAT_CALL:

                callable = find_macro(pp, rule->action.callee);

                if (callable == NULL)
                    callable = rule->action.callee;

                if (rule->expr != NULL)
                    dprintf(fd, "\t");

                result = call_instr_func(callable, rule->action.args, fd, bits, list, pp);

                if (rule->expr != NULL)
                    dprintf(fd, "\t");

                dprintf(fd, "\t\t\tgoto quick_exit;\n");

                *exit = true;
                break;

        }

        if (rule->expr != NULL)
            dprintf(fd, "\t\t}\n");

        dprintf(fd, "\n");

    }

    return result;

}