summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/arch/operands/register.c
blob: d032e049dd5e3acd086381d7768694893a755b3d (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
 * register.c - équivalent Python du fichier "arch/operands/register.c"
 *
 * Copyright (C) 2019-2020 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#include "register.h"


#include <pygobject.h>


#include <i18n.h>
#include <arch/operands/register-int.h>
#include <plugins/dt.h>


#include "../operand.h"
#include "../register.h"
#include "../../access.h"
#include "../../helpers.h"
#include "../../glibext/bufferline.h"



/* ------------------------ GLUE POUR CREATION DEPUIS PYTHON ------------------------ */


/* Accompagne la création d'une instance dérivée en Python. */
static PyObject *py_register_operand_new(PyTypeObject *, PyObject *, PyObject *);

/* Initialise la classe des descriptions de fichier binaire. */
static void py_register_operand_init_gclass(GRegisterOperandClass *, gpointer);

/* Initialise une instance sur la base du dérivé de GObject. */
static int py_register_operand_init(PyObject *, PyObject *, PyObject *);



/* ------------------------- REGISTRE SOUS FORME D'OPERANDE ------------------------- */


/* Compare un opérande avec un autre. */
static PyObject *py_register_operand___cmp__(PyObject *, PyObject *);

/* Traduit un opérande en version humainement lisible. */
static PyObject *py_register_operand__print(PyObject *, PyObject *);

/* Fournit le registre associé à l'opérande. */
static PyObject *py_register_operand_get_register(PyObject *, void *);



/* ---------------------------------------------------------------------------------- */
/*                          GLUE POUR CREATION DEPUIS PYTHON                          */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : type = type du nouvel objet à mettre en place.               *
*                args = éventuelle liste d'arguments.                         *
*                kwds = éventuel dictionnaire de valeurs mises à disposition. *
*                                                                             *
*  Description : Accompagne la création d'une instance dérivée en Python.     *
*                                                                             *
*  Retour      : Nouvel objet Python mis en place ou NULL en cas d'échec.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_register_operand_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
    PyObject *result;                       /* Objet à retourner           */
    PyTypeObject *base;                     /* Type de base à dériver      */
    bool first_time;                        /* Evite les multiples passages*/
    GType gtype;                            /* Nouveau type de processeur  */
    bool status;                            /* Bilan d'un enregistrement   */

    /* Validations diverses */

    base = get_python_register_operand_type();

    if (type == base)
        goto simple_way;

    /* Mise en place d'un type dédié */

    first_time = (g_type_from_name(type->tp_name) == 0);

    gtype = build_dynamic_type(G_TYPE_REGISTER_OPERAND, type->tp_name,
                               (GClassInitFunc)py_register_operand_init_gclass, NULL, NULL);

    if (first_time)
    {
        status = register_class_for_dynamic_pygobject(gtype, type, base);

        if (!status)
        {
            result = NULL;
            goto exit;
        }

    }

    /* On crée, et on laisse ensuite la main à PyGObject_Type.tp_init() */

 simple_way:

    result = PyType_GenericNew(type, args, kwds);

 exit:

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : class  = classe à initialiser.                               *
*                unused = données non utilisées ici.                          *
*                                                                             *
*  Description : Initialise la classe des descriptions de fichier binaire.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void py_register_operand_init_gclass(GRegisterOperandClass *class, gpointer unused)
{

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet à initialiser (théoriquement).                  *
*                args = arguments fournis à l'appel.                          *
*                kwds = arguments de type key=val fournis.                    *
*                                                                             *
*  Description : Initialise une instance sur la base du dérivé de GObject.    *
*                                                                             *
*  Retour      : 0.                                                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_register_operand_init(PyObject *self, PyObject *args, PyObject *kwds)
{
    GArchRegister *reg;                     /* Registre brut transmis      */
    int ret;                                /* Bilan de lecture des args.  */
    GRegisterOperand *operand;              /* Opérande à manipuler        */

#define REGISTER_OPERAND_DOC                                                \
    "The RegisterOperand object handles an operand carrying an"             \
    " architecture register.\n"                                             \
    "\n"                                                                    \
    "Instances can be created using the following constructor:\n"           \
    "\n"                                                                    \
    "    RegisterOperand(reg)"                                              \
    "\n"                                                                    \
    "Where reg is an architecture register defined from a subclass of"      \
    " pychrysalide.arch.ArchRegister."

    /* Récupération des paramètres */

    ret = PyArg_ParseTuple(args, "O&", convert_to_arch_register, &reg);
    if (!ret) return -1;

    /* Initialisation d'un objet GLib */

    ret = forward_pygobjet_init(self);
    if (ret == -1) return -1;

    /* Eléments de base */

    operand = G_REGISTER_OPERAND(pygobject_get(self));

    g_object_ref(G_OBJECT(reg));
    operand->reg = reg;

    return 0;

}



/* ---------------------------------------------------------------------------------- */
/*                           REGISTRE SOUS FORME D'OPERANDE                           */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : self = serveur à manipuler.                                  *
*                args = arguments associés à l'appel.                         *
*                                                                             *
*  Description : Compare un opérande avec un autre.                           *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_register_operand___cmp__(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Bilan à retourner           */
    GRegisterOperand *other;                /* Autre opérande à manipuler  */
    int ret;                                /* Bilan de lecture des args.  */
    GRegisterOperand *operand;              /* Elément à manipuler         */
    int status;                             /* Bilan de comparaison        */

#define REGISTER_OPERAND_CMP_METHOD PYTHON_METHOD_DEF               \
(                                                                   \
    __cmp__, "$self, other, /",                                     \
    METH_VARARGS, py_register_operand,                              \
    "Implementation of the required method used to compare the"     \
    " operand with another one. This second object is always"       \
    " a pychrysalide.arch.RegisterOperand instance.\n"              \
    "\n"                                                            \
    "See the parent class for more information about this method."  \
)

    ret = PyArg_ParseTuple(args, "O&", convert_to_register_operand, &other);
    if (!ret) return NULL;

    operand = G_REGISTER_OPERAND(pygobject_get(self));

    status = g_arch_operand_compare(G_ARCH_OPERAND(operand), G_ARCH_OPERAND(other));

    result = PyLong_FromLong(status);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = serveur à manipuler.                                  *
*                args = arguments associés à l'appel.                         *
*                                                                             *
*  Description : Traduit un opérande en version humainement lisible.          *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_register_operand__print(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Bilan à retourner           */
    GBufferLine *line;                      /* Ligne fournie à peupler     */
    int ret;                                /* Bilan de lecture des args.  */
    GRegisterOperand *operand;              /* Elément à manipuler         */

#define REGISTER_OPERAND_PRINT_METHOD PYTHON_METHOD_DEF                 \
(                                                                       \
    _print, "$self, line, /",                                           \
    METH_VARARGS, py_register_operand,                                  \
    "Implementation of the required method used to print the operand"   \
    " into a rendering line, which is a provided"                       \
    " pychrysalide.glibext.BufferLine instance.\n"                      \
    "\n"                                                                \
    "See the parent class for more information about this method."      \
)

    ret = PyArg_ParseTuple(args, "O&", convert_to_buffer_line, &line);
    if (!ret) return NULL;

    operand = G_REGISTER_OPERAND(pygobject_get(self));

    g_arch_operand_print(G_ARCH_OPERAND(operand), line);

    result = Py_None;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit le registre associé à l'opérande.                    *
*                                                                             *
*  Retour      : Représentation interne du registre.                          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_register_operand_get_register(PyObject *self, void *closure)
{
    PyObject *result;                       /* Instance Python à retourner */
    GRegisterOperand *operand;              /* Version GLib de l'opérande  */
    GArchRegister *reg;                     /* Registre lié à l'opérande   */

#define REGISTER_OPERAND_REGISTER_ATTRIB PYTHON_GET_DEF_FULL    \
(                                                               \
    register, py_register_operand,                              \
    "Provide the register used by the operand, as an"           \
    " instance of type pychrysalide.arch.ArchRegister."         \
)

    operand = G_REGISTER_OPERAND(pygobject_get(self));

    reg = g_register_operand_get_register(operand);

    if (reg == NULL)
    {
        result = Py_None;
        Py_INCREF(result);
    }

    else
    {
        result = pygobject_new(G_OBJECT(reg));
        g_object_unref(reg);
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Fournit un accès à une définition de type à diffuser.        *
*                                                                             *
*  Retour      : Définition d'objet pour Python.                              *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

PyTypeObject *get_python_register_operand_type(void)
{
    static PyMethodDef py_register_operand_methods[] = {
        REGISTER_OPERAND_CMP_METHOD,
        REGISTER_OPERAND_PRINT_METHOD,
        { NULL }
    };

    static PyGetSetDef py_register_operand_getseters[] = {
        REGISTER_OPERAND_REGISTER_ATTRIB,
        { NULL }
    };

    static PyTypeObject py_register_operand_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.arch.operands.RegisterOperand",
        .tp_basicsize   = sizeof(PyGObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

        .tp_doc         = REGISTER_OPERAND_DOC,

        .tp_methods     = py_register_operand_methods,
        .tp_getset      = py_register_operand_getseters,

        .tp_init        = py_register_operand_init,
        .tp_new         = py_register_operand_new,

    };

    return &py_register_operand_type;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : module = module dont la définition est à compléter.          *
*                                                                             *
*  Description : Prend en charge l'objet 'pychrysalide.arch.ArchOperand'.     *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool ensure_python_register_operand_is_registered(void)
{
    PyTypeObject *type;                     /* Type Python 'ArchOperand'   */
    PyObject *module;                       /* Module à recompléter        */
    PyObject *dict;                         /* Dictionnaire du module      */

    type = get_python_register_operand_type();

    if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
    {
        module = get_access_to_python_module("pychrysalide.arch.operands");

        dict = PyModule_GetDict(module);

        if (!register_class_for_pygobject(dict, G_TYPE_REGISTER_OPERAND, type, get_python_arch_operand_type()))
            return false;

    }

    return true;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : arg = argument quelconque à tenter de convertir.             *
*                dst = destination des valeurs récupérées en cas de succès.   *
*                                                                             *
*  Description : Tente de convertir en opérande de registre.                  *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

int convert_to_register_operand(PyObject *arg, void *dst)
{
    int result;                             /* Bilan à retourner           */

    result = PyObject_IsInstance(arg, (PyObject *)get_python_register_operand_type());

    switch (result)
    {
        case -1:
            /* L'exception est déjà fixée par Python */
            result = 0;
            break;

        case 0:
            PyErr_SetString(PyExc_TypeError, "unable to convert the provided argument to register operand");
            break;

        case 1:
            *((GRegisterOperand **)dst) = G_REGISTER_OPERAND(pygobject_get(arg));
            break;

        default:
            assert(false);
            break;

    }

    return result;

}