summaryrefslogtreecommitdiff
path: root/tools/d2c/spec.c
blob: 4bf430782b8abe00ced7e94b99a20a4f2d349870 (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
 * spec.c - représentation complète d'un encodage
 *
 * Copyright (C) 2014-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 "spec.h"


#include <malloc.h>
#include <regex.h>
#include <stdio.h>
#include <string.h>


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



/* Mémorisation d'un encodage complet */
struct _encoding_spec
{
    char *prefix;                           /* Distinction principale      */
    char *lprefix;                          /* Distinction en minuscules   */
    unsigned int index;                     /* Distinction secondaire      */

    operands_format *format;                /* Définition des opérandes    */

    coding_bits *bits;                      /* Encodage des bits associés  */
    asm_syntax *syntax;                     /* Calligraphe d'assemblage    */
    conv_list *conversions;                 /* Conversions des données     */
    instr_hooks *hooks;                     /* Fonctions complémentaires   */
    decoding_rules *rules;                  /* Règles supplémentaires      */

};



/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Crée un nouveau suivi de l'encodage d'une instruction.       *
*                                                                             *
*  Retour      : Nouvelle structure prête à emploi.                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

encoding_spec *create_encoding_spec(void)
{
    encoding_spec *result;                  /* Définition vierge à renvoyer*/

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

    result->format = create_operands_format();

    result->bits = create_coding_bits();
    result->syntax = create_asm_syntax();
    result->conversions = create_conv_list();
    result->hooks = create_instr_hooks();
    result->rules = create_decoding_rules();

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : spec = spécification d'encodage à libérer de la mémoire.     *
*                                                                             *
*  Description : Supprime de la mémoire un suivi d'encodage d'une instruction.*
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void delete_encoding_spec(encoding_spec *spec)
{
    delete_operands_format(spec->format);

    delete_coding_bits(spec->bits);
    delete_asm_syntax(spec->syntax);
    delete_conv_list(spec->conversions);
    delete_instr_hooks(spec->hooks);
    delete_decoding_rules(spec->rules);

    free(spec);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : spec   = spécification d'encodage à compléter.               *
*                prefix = distinction principale entre les définitions.       *
*                index  = distinction secondaire entre les définitions.       *
*                                                                             *
*  Description : Définit le nom de code d'une spécification d'encodage.       *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void define_encoding_spec_code_name(encoding_spec *spec, char *prefix, unsigned int index)
{
    spec->prefix = prefix;
    spec->lprefix = make_string_lower(strdup(prefix));
    spec->index = index;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : spec   = spécification d'encodage à consulter.               *
*                prefix = distinction principale entre les définitions.       *
*                                                                             *
*  Description : Indique si une spécification se range dans une catégorie.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool has_encoding_spec_prefix(const encoding_spec *spec, const char *prefix)
{
    bool result;                            /* Bilan à renvoyer            */

    if (spec->prefix == NULL && prefix == NULL)
        result = true;

    else if (spec->prefix != NULL && prefix != NULL)
        result = strcmp(spec->prefix, prefix) == 0;

    else
        result = false;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : spec = spécification d'encodage à consulter.                 *
*                                                                             *
*  Description : Fournit le gestionnaire des définitions d'opérandes.         *
*                                                                             *
*  Retour      : Structure assurant la définition des opérandes               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

operands_format *get_format_in_encoding_spec(const encoding_spec *spec)
{
    return spec->format;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : spec = spécification d'encodage à consulter.                 *
*                                                                             *
*  Description : Fournit le gestionnaire des bits d'un encodage d'instruction.*
*                                                                             *
*  Retour      : Structure assurant le suivi des bits.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

coding_bits *get_bits_in_encoding_spec(const encoding_spec *spec)
{
    return spec->bits;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : spec = spécification d'encodage à consulter.                 *
*                                                                             *
*  Description : Fournit l'indicateur des écritures correctes d'assembleur.   *
*                                                                             *
*  Retour      : Structure assurant la gestion des éléments de syntaxe.       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

asm_syntax *get_syntax_in_encoding_spec(const encoding_spec *spec)
{
    return spec->syntax;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : spec = spécification d'encodage à consulter.                 *
*                                                                             *
*  Description : Fournit la liste des fonctions de conversion.                *
*                                                                             *
*  Retour      : Structure assurant la gestion des fonctions de conversion.   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

conv_list *get_conversions_in_encoding_spec(const encoding_spec *spec)
{
    return spec->conversions;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : spec = spécification d'encodage à consulter.                 *
*                                                                             *
*  Description : Fournit la liste des fonctions à lier à une instruction.     *
*                                                                             *
*  Retour      : Structure assurant la gestion des fonctions de conversion.   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

instr_hooks *get_hooks_in_encoding_spec(const encoding_spec *spec)
{
    return spec->hooks;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : spec = spécification d'encodage à consulter.                 *
*                                                                             *
*  Description : Fournit un ensemble de règles supplémentaires éventuel.      *
*                                                                             *
*  Retour      : Structure assurant la gestion de ces règles.                 *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

decoding_rules *get_rules_in_encoding_spec(const encoding_spec *spec)
{
    return spec->rules;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : spec    = spécification servant de base à l'opération.       *
*                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.         *
*                ins     = désignation première de l'instruction manipulée.   *
*                details = particularités de l'instruction.                   *
*                wide    = taille des mots manipulés (en bits).               *
*                pp      = pré-processeur pour les échanges de chaînes.       *
*                                                                             *
*  Description : Traduit en code une sous-fonction de désassemblage.          *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool write_encoding_spec_disass(const encoding_spec *spec, int fd, const char *arch, const char *subarch, const char *ins, const char *details, unsigned int wide, const pre_processor *pp)
{
    bool result;                            /* Bilan à retourner           */
    bool bad_exit;                          /* Ajout d'une sortie d'échec ?*/
    char *keyword;                          /* Mot clef appelable en code  */
    bool quick_exit;                        /* Inclusion de sortie rapide ?*/
    const char *new_ins;                    /* Nouvelle définition de nom  */
    char *encoding_fc;                      /* Spécification d'encodage    */
    char *cast;                             /* Conversion vers le format   */

    result = true;

    bad_exit = false;

    keyword = make_callable(ins, false);

    dprintf(fd, "\tGArchInstruction *%s_decode_%s%s_%s%u(uint%u_t _raw)\n",
            arch, keyword, details, spec->lprefix, spec->index, wide);

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

    dprintf(fd, "\t\tGArchInstruction *instr;\n");

    /* Déclaration des champs à retrouver */

    result &= mark_syntax_items(spec->syntax, spec->bits, spec->conversions);

    result &= mark_decoding_rules(spec->rules, spec->bits, spec->conversions);

    result &= declare_used_bits_fields(spec->bits, fd, wide);

    result &= declare_used_intermediate_conversions(spec->conversions, fd, spec->bits, pp, wide);

    result &= declare_syntax_items(spec->syntax, fd, spec->bits, spec->conversions, wide);

    dprintf(fd, "\n");

    result &= declare_hook_functions(spec->hooks, false, fd);

    /* Vérification que le décodage est possible */

    result &= check_bits_correctness(spec->bits, fd);

    dprintf(fd, "\n");

    /* Définition des champs bruts */

    result &= define_used_bits_fields(spec->bits, fd);

    result &= define_used_intermediate_conversions(spec->conversions, fd, arch, spec->bits, pp, &bad_exit);

    /* Inclusion des éventuelles règles */

    quick_exit = false;

    result &= write_decoding_rules(spec->rules, false, CAT_SEE,
                                   fd, arch, subarch, spec->bits, spec->conversions, pp, &quick_exit);

    result &= write_decoding_rules(spec->rules, false, CAT_UNPREDICTABLE,
                                   fd, arch, subarch, spec->bits, spec->conversions, pp, &quick_exit);

    /* Création de l'instruction en elle-même */

    new_ins = get_new_keyword_from_syntax_items(spec->syntax);

    dprintf(fd, "\t\tinstr = g_%s_instruction_new(\"%s\");\n", arch, new_ins != NULL ? new_ins : ins);

    dprintf(fd, "\n");

    /* Inscriptions des éventuelles fonctions ou propriété à lier */

    result &= write_hook_functions(spec->hooks, false, fd);

    result &= write_decoding_rules(spec->rules, false, CAT_CHECKED_CALL,
                                   fd, arch, subarch, spec->bits, spec->conversions, pp, &quick_exit);

    result &= write_decoding_rules(spec->rules, false, CAT_CALL,
                                   fd, arch, subarch, spec->bits, spec->conversions, pp, &quick_exit);

    /* Création des opérandes */

    result &= define_syntax_items(spec->syntax, fd, arch, spec->bits, spec->conversions, pp, &bad_exit);

    /* Conclusion de la procédure */

    if (quick_exit)
    {
        dprintf(fd, "\t quick_exit:\n");
        dprintf(fd, "\n");
    }

    /* Encodage en dernier lieu */

    asprintf(&encoding_fc, "g_%s_instruction_set_encoding", arch);

    cast = build_cast_if_needed(encoding_fc);

    dprintf(fd, "\t\t%s(%s(instr), \"%s\");\n", encoding_fc, cast, spec->prefix);

    free(cast);

    free(encoding_fc);

    /* Conclusion globale */

    dprintf(fd, "\n");

    dprintf(fd, "\t\treturn instr;\n");

    dprintf(fd, "\n");

    if (bad_exit)
    {
        dprintf(fd, "\t bad_exit:\n");
        dprintf(fd, "\n");

        dprintf(fd, "\t\tg_object_unref(G_OBJECT(instr));\n");
        dprintf(fd, "\t\treturn NULL;\n");

        dprintf(fd, "\n");

    }

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

    dprintf(fd, "\n");

    dprintf(fd, "\tif (result == NULL)\n");
    dprintf(fd, "\t\tresult = %s_decode_%s%s_%s%u(raw);\n",
            arch, keyword, details, spec->lprefix, spec->index);

    dprintf(fd, "\n");

    free(keyword);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : spec    = spécification servant de base à l'opération.       *
*                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.         *
*                ins     = désignation première de l'instruction manipulée.   *
*                sep     = caractère de séparation avant les détails.         *
*                details = particularités de l'instruction.                   *
*                pp      = pré-processeur pour les échanges de chaînes.       *
*                prefix  = préfixe pour le type de définitions d'opérandes.   *
*                                                                             *
*  Description : Traduit en code une sous-fonction de désassemblage.          *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool write_encoding_spec_format_disass(const encoding_spec *spec, int fd, const char *arch, const char *subarch, const char *ins, char sep, const char *details, const pre_processor *pp, const char *prefix)
{
    bool result;                            /* Bilan à retourner           */
    bool quick_exit;                        /* Inclusion de sortie rapide ?*/
    bool bad_exit;                          /* Ajout d'une sortie d'échec ?*/
    const char *new_ins;                    /* Nouvelle définition de nom  */

    result = true;

    /* Déclarations préalables */

    dprintf(fd, "\tGArchInstruction *result;               /* Instruction créée à renvoyer*/\n");
    dprintf(fd, "\tSourceEndian endian;                    /* Boutisme lié au binaire     */\n");

    dprintf(fd, "\n");

    result &= declare_hook_functions(spec->hooks, true, fd);

    /* Création de l'instruction en elle-même */

    new_ins = get_new_keyword_from_syntax_items(spec->syntax);

    if (new_ins != NULL)
        dprintf(fd, "\tresult = g_%s_instruction_new(\"%s\");\n", arch, new_ins);
    else
    {
        if (sep == '\0')
            dprintf(fd, "\tresult = g_%s_instruction_new(\"%s\");\n", arch, ins);
        else
            dprintf(fd, "\tresult = g_%s_instruction_new(\"%s%c%s\");\n", arch, ins, sep, details);
    }

    dprintf(fd, "\n");

    /* Inscriptions des éventuelles fonctions ou propriété à lier */

    result &= write_hook_functions(spec->hooks, true, fd);

    quick_exit = false;

    result &= write_decoding_rules(spec->rules, true, CAT_CHECKED_CALL,
                                   fd, arch, subarch, spec->bits, spec->conversions, pp, &quick_exit);

    result &= write_decoding_rules(spec->rules, true, CAT_CALL,
                                   fd, arch, subarch, spec->bits, spec->conversions, pp, &quick_exit);

    /* Création des opérandes */

    dprintf(fd, "\tendian = g_arch_processor_get_endianness(G_ARCH_PROCESSOR(proc));\n");

    dprintf(fd, "\n");

    bad_exit = false;

    result &= define_operands_loading(spec->format, fd, arch, prefix, &bad_exit);

    /* Conclusion de la procédure */

    dprintf(fd, "\treturn result;\n");

    dprintf(fd, "\n");

    if (quick_exit || bad_exit)
    {
        if (quick_exit)
            dprintf(fd, " quick_exit:\n");

        if (bad_exit)
            dprintf(fd, " bad_exit:\n");

        dprintf(fd, "\n");

        dprintf(fd, "\tg_object_unref(G_OBJECT(result));\n");
        dprintf(fd, "\treturn NULL;\n");

        dprintf(fd, "\n");

    }

    return result;

}