summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/common/leb128.c
blob: 8e1bf28a56aca451d5a38e204fc1efae5ccf6191 (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

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


#include <assert.h>
#include <pygobject.h>


#include <common/leb128.h>


#include "packed.h"
#include "../access.h"
#include "../helpers.h"



/* Encode un nombre non signé encodé au format LEB128. */
static PyObject *py_leb128_pack_uleb128(PyObject *, PyObject *);

/* Encode un nombre signé encodé au format LEB128. */
static PyObject *py_leb128_pack_leb128(PyObject *, PyObject *);

/* Décode un nombre non signé encodé au format LEB128. */
static PyObject *py_leb128_unpack_uleb128(PyObject *, PyObject *);

/* Décode un nombre signé encodé au format LEB128. */
static PyObject *py_leb128_unpack_leb128(PyObject *, PyObject *);



/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet Python concerné par l'appel.                    *
*                args = tampon de données à constituer.                       *
*                                                                             *
*  Description : Encode un nombre non signé encodé au format LEB128.          *
*                                                                             *
*  Retour      : Bilan de l'opération : True en cas de succès, False sinon.   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_leb128_pack_uleb128(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Valeur à retourner          */
    uleb128_t value;                        /* Valeur à manipuler          */
    packed_buffer *pbuf;                    /* Tampon de données à employer*/
    int ret;                                /* Bilan de lecture des args.  */
    bool status;                            /* Bilan de l'opération        */

#define LEB128_PACK_ULEB128_METHOD PYTHON_METHOD_DEF                \
(                                                                   \
    pack_uleb128, "value, pbuf",                                    \
    METH_VARARGS, py_leb128,                                        \
    "Pack an unsigned LEB128 value into a data buffer.\n"           \
    "\n"                                                            \
    "The *value* is an integer value. The *pbuf* argument has to"   \
    " be a pychrysalide.common.PackedBuffer instance where data"    \
    " will be appended.\n"                                          \
    "\n"                                                            \
    "The returned value is the operation status: *True* for"        \
    " success, *False* for failure."                                \
)

    ret = PyArg_ParseTuple(args, "O&O&", convert_to_uleb128_value, &value, convert_to_packed_buffer, &pbuf);
    if (!ret) return NULL;

    status = pack_uleb128(&value, pbuf);

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

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet Python concerné par l'appel.                    *
*                args = tampon de données à constituer.                       *
*                                                                             *
*  Description : Encode un nombre signé encodé au format LEB128.              *
*                                                                             *
*  Retour      : Bilan de l'opération : True en cas de succès, False sinon.   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_leb128_pack_leb128(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Valeur à retourner          */
    leb128_t value;                         /* Valeur à manipuler          */
    packed_buffer *pbuf;                    /* Tampon de données à employer*/
    int ret;                                /* Bilan de lecture des args.  */
    bool status;                            /* Bilan de l'opération        */

#define LEB128_PACK_LEB128_METHOD PYTHON_METHOD_DEF                 \
(                                                                   \
    pack_leb128, "value, pbuf",                                     \
    METH_VARARGS, py_leb128,                                        \
    "Pack a signed LEB128 value into a data buffer.\n"              \
    "\n"                                                            \
    "The *value* is an integer value. The *pbuf* argument has to"   \
    " be a pychrysalide.common.PackedBuffer instance where data"    \
    " will be appended.\n"                                          \
    "\n"                                                            \
    "The returned value is the operation status: *True* for"        \
    " success, *False* for failure."                                \
)

    ret = PyArg_ParseTuple(args, "O&O&", convert_to_leb128_value, &value, convert_to_packed_buffer, &pbuf);
    if (!ret) return NULL;

    status = pack_leb128(&value, pbuf);

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

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet Python concerné par l'appel.                    *
*                args = tampon de données à consulter.                        *
*                                                                             *
*  Description : Décode un nombre non signé encodé au format LEB128.          *
*                                                                             *
*  Retour      : Bilan de l'opération : true en cas de succès, false sinon.   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_leb128_unpack_uleb128(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Valeur à retourner          */
    packed_buffer *pbuf;                    /* Tampon de données à employer*/
    int ret;                                /* Bilan de lecture des args.  */
    uleb128_t value;                        /* Valeur à manipuler          */
    bool status;                            /* Bilan de l'opération        */

#define LEB128_UNPACK_ULEB128_METHOD PYTHON_METHOD_DEF              \
(                                                                   \
    unpack_uleb128, "pbuf",                                         \
    METH_VARARGS, py_leb128,                                        \
    "Unpack an unsigned LEB128 value into a data buffer.\n"         \
    "\n"                                                            \
    "The *pbuf* argument has to be a"                               \
    " pychrysalide.common.PackedBuffer instance from where data"    \
    " will be read.\n"                                              \
    "\n"                                                            \
    "The returned value depends on the operation status: *None*"    \
    " for failure or a integer value for success."                  \
)

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

    status = unpack_uleb128(&value, pbuf);

    if (status)
        result = PyLong_FromUnsignedLongLong(value);

    else
    {
        result = Py_None;
        Py_INCREF(result);
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet Python concerné par l'appel.                    *
*                args = tampon de données à consulter.                        *
*                                                                             *
*  Description : Décode un nombre signé encodé au format LEB128.              *
*                                                                             *
*  Retour      : Bilan de l'opération : true en cas de succès, false sinon.   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_leb128_unpack_leb128(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Valeur à retourner          */
    packed_buffer *pbuf;                    /* Tampon de données à employer*/
    int ret;                                /* Bilan de lecture des args.  */
    leb128_t value;                        /* Valeur à manipuler          */
    bool status;                            /* Bilan de l'opération        */

#define LEB128_UNPACK_LEB128_METHOD PYTHON_METHOD_DEF               \
(                                                                   \
    unpack_leb128, "pbuf",                                          \
    METH_VARARGS, py_leb128,                                        \
    "Unpack a signed LEB128 value into a data buffer.\n"            \
    "\n"                                                            \
    "The *pbuf* argument has to be a"                               \
    " pychrysalide.common.PackedBuffer instance from where data"    \
    " will be read.\n"                                              \
    "\n"                                                            \
    "The returned value depends on the operation status: *None*"    \
    " for failure or a integer value for success."                  \
)

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

    status = unpack_leb128(&value, pbuf);

    if (status)
        result = PyLong_FromLongLong(value);

    else
    {
        result = Py_None;
        Py_INCREF(result);
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Définit une extension du module 'common' à compléter.        *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool populate_common_module_with_leb128(void)
{
    bool result;                            /* Bilan à retourner           */
    PyObject *module;                       /* Module à recompléter        */

    static PyMethodDef py_leb128_methods[] = {
        LEB128_PACK_ULEB128_METHOD,
        LEB128_PACK_LEB128_METHOD,
        LEB128_UNPACK_ULEB128_METHOD,
        LEB128_UNPACK_LEB128_METHOD,
        { NULL }
    };

    module = get_access_to_python_module("pychrysalide.common");

    result = register_python_module_methods(module, py_leb128_methods);

    return result;

}


/******************************************************************************
*                                                                             *
*  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 valeur LEB128 non signée.              *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

int convert_to_uleb128_value(PyObject *arg, void *dst)
{
    int result;                             /* Bilan à retourner           */
    unsigned long long value;               /* Valeur récupérée            */

    result = PyObject_IsInstance(arg, (PyObject *)&PyLong_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 ULEB128 value");
            break;

        case 1:
            value = PyLong_AsUnsignedLongLong(arg);
            *((uleb128_t *)dst) = value;
            break;

        default:
            assert(false);
            break;

    }

    return result;

}


/******************************************************************************
*                                                                             *
*  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 valeur LEB128 signée.                  *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

int convert_to_leb128_value(PyObject *arg, void *dst)
{
    int result;                             /* Bilan à retourner           */
    long long value;                        /* Valeur récupérée            */

    result = PyObject_IsInstance(arg, (PyObject *)&PyLong_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 LEB128 value");
            break;

        case 1:
            value = PyLong_AsLongLong(arg);
            *((leb128_t *)dst) = value;
            break;

        default:
            assert(false);
            break;

    }

    return result;

}