summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/analysis/storage/serialize.c
blob: 3bf5183e8b28c73057f2b7653e20d0aa264304ed (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * serialize.c - équivalent Python du fichier "analysis/storage/serialize.h"
 *
 * Copyright (C) 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 "serialize.h"


#include <pygobject.h>


#include <analysis/storage/serialize-int.h>


#include "storage.h"
#include "tpmem.h"
#include "../../access.h"
#include "../../helpers.h"
#include "../../common/packed.h"



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


/* Procède à l'initialisation de l'interface de génération. */
static void py_serializable_object_interface_init(GSerializableObjectIface *, gpointer *);

/* Charge un objet depuis une mémoire tampon. */
static bool py_serializable_object_load_wrapper(GSerializableObject *, GObjectStorage *, GTypeMemory *, packed_buffer *);

/* Sauvegarde un objet dans une mémoire tampon. */
static bool py_serializable_object_store_wrapper(const GSerializableObject *, GObjectStorage *, GTypeMemory *, packed_buffer *);



/* ------------------------- CONNEXION AVEC L'API DE PYTHON ------------------------- */


/* Charge un objet depuis une mémoire tampon. */
static bool py_serializable_object_load(PyObject *, PyObject *);

/* Sauvegarde un objet dans une mémoire tampon. */
static bool py_serializable_object_store(PyObject *, PyObject *);



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


/******************************************************************************
*                                                                             *
*  Paramètres  : iface  = interface GLib à initialiser.                       *
*                unused = adresse non utilisée ici.                           *
*                                                                             *
*  Description : Procède à l'initialisation de l'interface de génération.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void py_serializable_object_interface_init(GSerializableObjectIface *iface, gpointer *unused)
{

#define SERIALIZABLE_OBJECT_DOC                                             \
    "SerializableObject defines an interface used to store and load"        \
    " objects to and from a data buffer.\n"                                 \
    "\n"                                                                    \
    "A typical class declaration for a new implementation looks like:\n"    \
    "\n"                                                                    \
    "    class NewImplem(GObject.Object, SerializableObject):\n"            \
    "        ...\n"                                                         \
    "\n"                                                                    \
    "The following methods have to be defined for new implementations:\n"   \
    "* pychrysalide.analysis.storage.SerializableObject._load();\n"         \
    "* pychrysalide.analysis.storage.SerializableObject._store();\n"

    iface->load = py_serializable_object_load_wrapper;
    iface->store = py_serializable_object_store_wrapper;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : object  = instruction d'assemblage à consulter.              *
*                storage = conservateur de données à manipuler ou NULL.       *
*                tpmem   = mémoire des types d'objets à compléter.            *
*                pbuf    = zone tampon à remplir.                             *
*                                                                             *
*  Description : Charge un objet depuis une mémoire tampon.                   *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool py_serializable_object_load_wrapper(GSerializableObject *object, GObjectStorage *storage, GTypeMemory *tpmem, packed_buffer *pbuf)
{
    bool result;                            /* Bilan à retourner           */
    PyGILState_STATE gstate;                /* Sauvegarde d'environnement  */
    PyObject *storage_obj;                  /* Objet Python à emmployer    */
    PyObject *args;                         /* Arguments pour l'appel      */
    PyObject *pyobj;                        /* Objet Python concerné       */
    PyObject *pyret;                        /* Bilan de consultation       */

#define SERIALIZABLE_OBJECT_LOAD_WRAPPER PYTHON_WRAPPER_DEF                     \
(                                                                               \
    _load, "$self, storage, tpmem, pbuf, /",                                    \
    METH_VARARGS,                                                               \
    "Abstract method used to load an object definition from buffered data.\n"   \
    "\n"                                                                        \
    "The *storage* is a pychrysalide.analysis.storage.ObjectStorage instance"   \
    " provided to store inner objects, if relevant, or None. The *tpmem* object"\
    " is a pychrysalide.analysis.storage.TypeMemory remembering all involved"   \
    " GLib types. The *pbuf* argument points to a"                              \
    " pychrysalide.common.PackedBuffer object containing the data to process.\n"\
    "\n"                                                                        \
    "The result is a boolean indicating the status of the operation."           \
)

    result = false;

    gstate = PyGILState_Ensure();

    pyobj = pygobject_new(G_OBJECT(object));

    if (has_python_method(pyobj, "_load"))
    {
        if (storage == NULL)
        {
            storage_obj = Py_None;
            Py_INCREF(storage_obj);
        }
        else
            storage_obj = pygobject_new(G_OBJECT(storage));

        args = PyTuple_New(3);
        PyTuple_SetItem(args, 0, storage_obj);
        PyTuple_SetItem(args, 1, pygobject_new(G_OBJECT(tpmem)));
        PyTuple_SetItem(args, 2, build_from_internal_packed_buffer(pbuf));

        pyret = run_python_method(pyobj, "_load", args);

        result = (pyret == Py_True ? true : false);

        Py_XDECREF(pyret);

        Py_DECREF(args);

    }

    Py_DECREF(pyobj);

    PyGILState_Release(gstate);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : object  = instruction d'assemblage à consulter.              *
*                storage = conservateur de données à manipuler ou NULL.       *
*                tpmem   = mémoire des types d'objets à compléter.            *
*                pbuf    = zone tampon à remplir.                             *
*                                                                             *
*  Description : Sauvegarde un objet dans une mémoire tampon.                 *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool py_serializable_object_store_wrapper(const GSerializableObject *object, GObjectStorage *storage, GTypeMemory *tpmem, packed_buffer *pbuf)
{
    bool result;                            /* Bilan à retourner           */
    PyGILState_STATE gstate;                /* Sauvegarde d'environnement  */
    PyObject *storage_obj;                  /* Objet Python à emmployer    */
    PyObject *args;                         /* Arguments pour l'appel      */
    PyObject *pyobj;                        /* Objet Python concerné       */
    PyObject *pyret;                        /* Bilan de consultation       */

#define SERIALIZABLE_OBJECT_STORE_WRAPPER PYTHON_WRAPPER_DEF                    \
(                                                                               \
    _store, "$self, storage, tpmem, pbuf, /",                                   \
    METH_VARARGS,                                                               \
    "Abstract method used to store an object definition into buffered data.\n"  \
    "\n"                                                                        \
    "The *storage* is a pychrysalide.analysis.storage.ObjectStorage instance"   \
    " provided to store inner objects, if relevant, or None. The *tpmem* object"\
    " is a pychrysalide.analysis.storage.TypeMemory remembering all involved"   \
    " GLib types. The *pbuf* argument points to a"                              \
    " pychrysalide.common.PackedBuffer object containing the data to process.\n"\
    "\n"                                                                        \
    "The result is a boolean indicating the status of the operation."           \
)

    result = false;

    gstate = PyGILState_Ensure();

    pyobj = pygobject_new(G_OBJECT(object));

    if (has_python_method(pyobj, "_store"))
    {
        if (storage == NULL)
        {
            storage_obj = Py_None;
            Py_INCREF(storage_obj);
        }
        else
            storage_obj = pygobject_new(G_OBJECT(storage));

        args = PyTuple_New(3);
        PyTuple_SetItem(args, 0, storage_obj);
        PyTuple_SetItem(args, 1, pygobject_new(G_OBJECT(tpmem)));
        PyTuple_SetItem(args, 2, build_from_internal_packed_buffer(pbuf));

        pyret = run_python_method(pyobj, "_store", args);

        result = (pyret == Py_True ? true : false);

        Py_XDECREF(pyret);

        Py_DECREF(args);

    }

    Py_DECREF(pyobj);

    PyGILState_Release(gstate);

    return result;

}



/* ---------------------------------------------------------------------------------- */
/*                           CONNEXION AVEC L'API DE PYTHON                           */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un générateur à manipuler.        *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Charge un objet depuis une mémoire tampon.                   *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool py_serializable_object_load(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Bilan à retourner           */
    GObjectStorage *storage;                /* Conservateur à manipuler    */
    GTypeMemory *tpmem;                     /* Gestionnaire de types       */
    packed_buffer *pbuf;                    /* Tampon de données à employer*/
    int ret;                                /* Bilan de lecture des args.  */
    GSerializableObject *object;            /* Version native              */
    bool status;                            /* Bilan de l'opération        */

#define SERIALIZABLE_OBJECT_LOAD_METHOD PYTHON_METHOD_DEF                       \
(                                                                               \
    load, "$self, storage, tpmem, pbuf, /",                                     \
    METH_VARARGS, py_serializable_object,                                       \
    "Load an object definition from buffered data.\n"                           \
    "\n"                                                                        \
    "The *storage* is a pychrysalide.analysis.storage.ObjectStorage instance"   \
    " provided to store inner objects, if relevant, or None. The *tpmem* object"\
    " is a pychrysalide.analysis.storage.TypeMemory remembering all involved"   \
    " GLib types. The *pbuf* argument points to a"                              \
    " pychrysalide.common.PackedBuffer object containing the data to process.\n"\
    "\n"                                                                        \
    "The result is a boolean indicating the status of the operation."           \
)

    ret = PyArg_ParseTuple(args, "O&O&O&", convert_to_object_storage_or_none, &storage,
                           convert_to_type_memory, &tpmem, convert_to_packed_buffer, &pbuf);
    if (!ret) return NULL;

    object = G_SERIALIZABLE_OBJECT(pygobject_get(self));

    status = g_serializable_object_load(object, storage, tpmem, pbuf);

    result = status ? Py_True : Py_False;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant un générateur à manipuler.        *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Sauvegarde un objet dans une mémoire tampon.                 *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool py_serializable_object_store(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Bilan à retourner           */
    GObjectStorage *storage;                /* Conservateur à manipuler    */
    GTypeMemory *tpmem;                     /* Gestionnaire de types       */
    packed_buffer *pbuf;                    /* Tampon de données à employer*/
    int ret;                                /* Bilan de lecture des args.  */
    GSerializableObject *object;            /* Version native              */
    bool status;                            /* Bilan de l'opération        */

#define SERIALIZABLE_OBJECT_STORE_METHOD PYTHON_METHOD_DEF                      \
(                                                                               \
    store, "$self, storage, tpmem, pbuf, /",                                    \
    METH_VARARGS, py_serializable_object,                                       \
    "Store an object definition into buffered data.\n"                          \
    "\n"                                                                        \
    "The *storage* is a pychrysalide.analysis.storage.ObjectStorage instance"   \
    " provided to store inner objects, if relevant, or None. The *tpmem* object"\
    " is a pychrysalide.analysis.storage.TypeMemory remembering all involved"   \
    " GLib types. The *pbuf* argument points to a"                              \
    " pychrysalide.common.PackedBuffer object containing the data to process.\n"\
    "\n"                                                                        \
    "The result is a boolean indicating the status of the operation."           \
)

    ret = PyArg_ParseTuple(args, "O&O&O&", convert_to_object_storage_or_none, &storage,
                           convert_to_type_memory, &tpmem, convert_to_packed_buffer, &pbuf);
    if (!ret) return NULL;

    object = G_SERIALIZABLE_OBJECT(pygobject_get(self));

    status = g_serializable_object_store(object, storage, tpmem, pbuf);

    result = status ? Py_True : Py_False;
    Py_INCREF(result);

    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_serializable_object_type(void)
{
    static PyMethodDef py_serializable_object_methods[] = {
        SERIALIZABLE_OBJECT_LOAD_WRAPPER,
        SERIALIZABLE_OBJECT_STORE_WRAPPER,
        SERIALIZABLE_OBJECT_LOAD_METHOD,
        SERIALIZABLE_OBJECT_STORE_METHOD,
        { NULL }
    };

    static PyGetSetDef py_serializable_object_getseters[] = {
        { NULL }
    };

    static PyTypeObject py_serializable_object_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.analysis.storage.SerializableObject",
        .tp_basicsize   = sizeof(PyObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

        .tp_doc         = SERIALIZABLE_OBJECT_DOC,

        .tp_methods     = py_serializable_object_methods,
        .tp_getset      = py_serializable_object_getseters,

    };

    return &py_serializable_object_type;

}


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

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

    static GInterfaceInfo info = {          /* Paramètres d'inscription    */

        .interface_init = (GInterfaceInitFunc)py_serializable_object_interface_init,
        .interface_finalize = NULL,
        .interface_data = NULL,

    };

    type = get_python_serializable_object_type();

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

        dict = PyModule_GetDict(module);

        if (!register_interface_for_pygobject(dict, G_TYPE_SERIALIZABLE_OBJECT, type, &info))
            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 objet adapté à une mise en cache.      *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

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

    result = PyObject_IsInstance(arg, (PyObject *)get_python_serializable_object_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 serializable object");
            break;

        case 1:
            *((GSerializableObject **)dst) = G_SERIALIZABLE_OBJECT(pygobject_get(arg));
            break;

        default:
            assert(false);
            break;

    }

    return result;

}