summaryrefslogtreecommitdiff
path: root/plugins/mobicore/annotations.c
blob: 0f91ffbf679870064c71cab2402ac8e1d21472e0 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * annotations.c - enregistrement des annotations liées au format MCLF
 *
 * Copyright (C) 2015 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 "annotations.h"


#include <malloc.h>


#include <i18n.h>
#include <arch/raw.h>
#include <common/extstr.h>


#include "mclf-int.h"



/* Place des annotations sur un descripteur de segment MCLF. */
static bool annotate_mclf_segment_descriptor(GMCLFFormat *, const char *, vmpa2t *);

/* Place des annotations sur le début commun du binaire MCLF. */
static bool annotate_mclf_intro(GMCLFFormat *, vmpa2t *pos);

/* Place des annotations sur l'en-tête v1 du binaire MCLF. */
static bool annotate_mclf_header_v1(GMCLFFormat *, vmpa2t *pos);

/* Place des annotations sur l'en-tête du segment de code. */
static bool annotate_mclf_text_segment_header(GMCLFFormat *format, vmpa2t *);



/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à compléter.            *
*                prefix = désignation du segment dans son ensemble.           *
*                pos    = tête de lecture à initialiser / faire évoluer. [OUT]*
*                                                                             *
*  Description : Place des annotations sur un descripteur de segment MCLF.    *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool annotate_mclf_segment_descriptor(GMCLFFormat *format, const char *prefix, vmpa2t *pos)
{
    GBinContent *content;                   /* Contenu binaire à lire      */
    GArchInstruction *instr;                /* Instruction décodée         */
    char *text;                             /* Texte construit par étapes  */
    GDbComment *comment;                    /* Définition de commentaire   */
    GBinSymbol *symbol;                     /* Symbole à intégrer          */

    content = G_BIN_FORMAT(format)->content;

    /* start */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    text = strdup(prefix);
    text = stradd(text, _(": start address"));

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, text);

    free(text);

    /* len */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    text = strdup(prefix);
    text = stradd(text, _(": length"));

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, text);

    free(text);

    return true;

}



/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à compléter.            *
*                pos    = tête de lecture à initialiser / faire évoluer. [OUT]*
*                                                                             *
*  Description : Place des annotations sur le début commun du binaire MCLF.   *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool annotate_mclf_intro(GMCLFFormat *format, vmpa2t *pos)
{
    GBinContent *content;                   /* Contenu binaire à lire      */
    GArchInstruction *instr;                /* Instruction décodée         */
    GArchOperand *operand;                  /* Opérande à venir modifier   */
    GDbComment *comment;                    /* Définition de commentaire   */
    GBinSymbol *symbol;                     /* Symbole à intégrer          */

    content = G_BIN_FORMAT(format)->content;

    init_vmpa(pos, 0, format->header.v1.text.start);

    /* magic */

    instr = g_raw_instruction_new_array(content, MDS_8_BITS, 4, pos, format->endian);

    SET_IMM_DISPLAY(instr, operand, 0, IOD_CHAR);
    SET_IMM_DISPLAY(instr, operand, 1, IOD_CHAR);
    SET_IMM_DISPLAY(instr, operand, 2, IOD_CHAR);
    SET_IMM_DISPLAY(instr, operand, 3, IOD_CHAR);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("MCLF magic number"));

    /* version */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Version"));

    return true;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à compléter.            *
*                pos    = tête de lecture à faire évoluer. [OUT]              *
*                                                                             *
*  Description : Place des annotations sur l'en-tête v1 du binaire MCLF.      *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool annotate_mclf_header_v1(GMCLFFormat *format, vmpa2t *pos)
{
    GBinContent *content;                   /* Contenu binaire à lire      */
    GArchInstruction *instr;                /* Instruction décodée         */
    GDbComment *comment;                    /* Définition de commentaire   */
    GBinSymbol *symbol;                     /* Symbole à intégrer          */
    const char *text;                       /* Commentaire variable        */

    content = G_BIN_FORMAT(format)->content;

    /* flags */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Service flags"));

    /* mem_type */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    switch (format->header.v1.mem_type)
    {
        case MCLF_MEM_TYPE_INTERNAL_PREFERRED:
            text = _("Memory to use: internal if available, otherwise external memory");
            break;
        case MCLF_MEM_TYPE_INTERNAL:
            text = _("Internal memory must be used for executing the service");
            break;
        case MCLF_MEM_TYPE_EXTERNAL:
            text = _("External memory must be used for executing the service");
            break;
        default:
            text = _("Unknown memory usage");
            break;
    }

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, text);

    /* service_type */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    switch (format->header.v1.service_type)
    {
        case SERVICE_TYPE_ILLEGAL:
            text = _("Service type is invalid");
            break;

        case SERVICE_TYPE_DRIVER:
            text = _("Service is a driver");
            break;

        case SERVICE_TYPE_SP_TRUSTLET:
            text = _("Service is a Trustlet");
            break;

        case SERVICE_TYPE_SYSTEM_TRUSTLET:
            text = _("Service is a system Trustlet");
            break;
    }

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, text);

    /* num_instances */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Number of instances which can be run simultaneously"));

    /* uuid */

    instr = g_raw_instruction_new_array(content, MDS_8_BITS, 16, pos, format->endian);

    g_raw_instruction_mark_as_padding(G_RAW_INSTRUCTION(instr), true);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Loadable service unique identifier (UUID)"));

    /* driver_id */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    if (format->header.v1.service_type == SERVICE_TYPE_DRIVER)
        text = _("Driver ID");
    else
        text = _("Unused Driver ID");

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Number of threads"));

    /* num_threads */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Number of threads"));

    /* text.start */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Virtual text segment: start address"));

    /* text.len */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Virtual text segment: length"));

    /* data.start */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Virtual data segment: start address"));

    /* data.len */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Virtual data segment: length"));

    /* bss_len */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Length of the BSS segment in bytes"));

    /* entry */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Virtual start address of service code"));





    /* service_version */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Version of the interface the driver exports"));




    /* sip_id */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Silicon Provider ID"));

    /* sip_data */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 3, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Platform specific device identifier"));

    /* permitted_hw_cfg */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Configuration which is allowed to execute binary"));


    return true;

}









/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à compléter.            *
*                pos    = tête de lecture à initialiser / faire évoluer. [OUT]*
*                                                                             *
*  Description : Place des annotations sur l'en-tête du segment de code.      *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool annotate_mclf_text_segment_header(GMCLFFormat *format, vmpa2t *pos)
{
    GBinContent *content;                   /* Contenu binaire à lire      */
    vmpa2t old;                             /* Position précédente         */
    phys_t diff;                            /* Décallage entre positions   */
    GArchInstruction *instr;                /* Instruction décodée         */
    GDbComment *comment;                    /* Définition de commentaire   */
    GBinSymbol *symbol;                     /* Symbole à intégrer          */

    content = G_BIN_FORMAT(format)->content;

    copy_vmpa(&old, pos);
    init_vmpa(pos, 0x80, format->header.v1.text.start + 0x80);

    diff = compute_vmpa_diff(&old, pos);

    printf("DIFF : %u\n", (unsigned int)diff);

    instr = g_raw_instruction_new_array(content, MDS_8_BITS, diff, &old, format->endian);

    g_raw_instruction_mark_as_padding(G_RAW_INSTRUCTION(instr), true);

    ADD_RAW_AS_SYM(format, symbol, &old, instr, comment, _("Padding"));

    /* version */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Version of the TextHeader structure"));

    /* text_header_len */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Size of this structure"));

    /* required_feat */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Features that Mobicore must understand when loading"));

    /* mc_lib_entry */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Address for McLib entry"));

    /* mc_lib_data */

    if (!annotate_mclf_segment_descriptor(format, _("Segment for McLib data"), pos))
        return false;

    //Segment for McLib data

    /* mc_lib_base */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("McLib base address"));

    /* tl_api_vers */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("TlApi version used when building trustlet"));

    /* dr_api_vers */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("DrApi version used when building trustlet"));

    /* ta_properties */

    instr = g_raw_instruction_new_array(content, MDS_32_BITS, 1, pos, format->endian);

    ADD_RAW_AS_SYM(format, symbol, pos, instr, comment, _("Address of _TA_Properties in the TA"));

    return true;

}










/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à compléter.            *
*                                                                             *
*  Description : Place des annotations sur le binaire MCLF.                   *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool annotate_mclf_binary(GMCLFFormat *format)
{
    bool result;                            /* Bilan à retourner           */
    vmpa2t pos;                             /* Localisation des symboles   */


    result = annotate_mclf_intro(format, &pos);

    result &= annotate_mclf_header_v1(format, &pos);

    result &= annotate_mclf_text_segment_header(format, &pos);

    return result;

}