summaryrefslogtreecommitdiff
path: root/plugins/pychrysa/arch/instriter.c
blob: 0d65f26b6bd5c36b6571cf423efee2d7813273be (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

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


#include <pygobject.h>


#include <arch/processor.h>


#include "processor.h"



/* Transcription d'un itérateur en Python */
typedef struct _PyInstrIterator
{
    PyObject_HEAD;                          /* A laisser en premier        */

    instr_iter_t *native;                   /* Version native de l'objet   */

} PyInstrIterator;


/* Libère de la mémoire un itérateur sur des instructions. */
static void py_instr_iterator_dealloc(PyInstrIterator *);

/* Fournit l'instruction qui en suit une autre. */
static PyObject *py_instr_iterator_next(PyInstrIterator *);

/* Initialise un nouvel itérateur. */
static int py_instr_iterator_init(PyInstrIterator *, PyObject *, PyObject *);

/* Construit un nouvel itérateur. */
static PyObject *py_instr_iterator_new(PyTypeObject *, PyObject *, PyObject *);



/******************************************************************************
*                                                                             *
*  Paramètres  : self = itérateur à supprimer.                                *
*                                                                             *
*  Description : Libère de la mémoire un itérateur sur des instructions.      *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void py_instr_iterator_dealloc(PyInstrIterator *self)
{
    delete_instruction_iterator(self->native);

    Py_TYPE(self)->tp_free((PyObject *)self);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = itérateur à manipuler.                                *
*                                                                             *
*  Description : Fournit l'instruction qui en suit une autre.                 *
*                                                                             *
*  Retour      : Instruction suivante trouvée, ou NULL.                       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_instr_iterator_next(PyInstrIterator *self)
{
    PyObject *result;                       /* Résultat à retourner        */
    GArchInstruction *next;                 /* Instruction suivante        */

    next = get_instruction_iterator_next(self->native);

    if (next != NULL)
    {
        result = pygobject_new(G_OBJECT(next));
        g_object_unref(G_OBJECT(next));
    }

    else
    {
        PyErr_SetNone(PyExc_StopIteration);
        result = NULL;
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = instance d'objet à initialiser.                       *
*                args = arguments passés pour l'appel.                        *
*                kwds = mots clefs éventuellement fournis en complément.      *
*                                                                             *
*  Description : Initialise un nouvel itérateur.                              *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_instr_iterator_init(PyInstrIterator *self, PyObject *args, PyObject *kwds)
{
    int result;                             /* Bilan à retourner           */
    PyObject *proc_obj;                     /* Processeur version Python   */
    unsigned long index;                    /* Indice de première instruc. */
    int ret;                                /* Bilan de lecture des args.  */
    GArchProcessor *proc;                   /* Version native du processeur*/

    result = -1;

    ret = PyArg_ParseTuple(args, "Ok", &proc_obj, &index);
    if (ret == 0) goto piii_exit;

    ret = PyObject_IsInstance(proc_obj, (PyObject *)get_python_arch_processor_type());
    if (!ret) goto piii_exit;

    proc = G_ARCH_PROCESSOR(pygobject_get(proc_obj));

    self->native = create_instruction_iterator(proc, index);

    result = 0;

 piii_exit:

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type = type d'objet à mettre en place.                       *
*                args = arguments passés pour l'appel.                        *
*                kwds = mots clefs éventuellement fournis en complément.      *
*                                                                             *
*  Description : Construit un nouvel itérateur.                               *
*                                                                             *
*  Retour      : Définition d'objet pour Python.                              *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_instr_iterator_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
    PyInstrIterator *result;                /* Nouvelle instance à renvoyer*/
    int ret;                                /* Bilan de l'initialisation   */

    result = (PyInstrIterator *)type->tp_alloc(type, 0);

    if (result != NULL)
    {
        ret = py_instr_iterator_init(result, args, kwds);

        if (ret != 0)
        {
            Py_DECREF(result);
            result = NULL;
        }

    }

    return (PyObject *)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_instr_iterator_type(void)
{
    static PyTypeObject py_instr_iterator_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.arch.InstrIterator",
        .tp_basicsize   = sizeof(PyInstrIterator),

        .tp_dealloc     = (destructor)py_instr_iterator_dealloc,

        .tp_flags       = Py_TPFLAGS_DEFAULT,

        .tp_doc         = "Iterator for Chrysalide instructions loaded in a given processor.",

        .tp_iter        = PyObject_SelfIter,
        .tp_iternext    = (iternextfunc)py_instr_iterator_next,

        .tp_init        = (initproc)py_instr_iterator_init,
        .tp_new         = py_instr_iterator_new,

    };

    return &py_instr_iterator_type;

}


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

bool register_python_instr_iterator(PyObject *module)
{
    PyTypeObject *py_instr_iterator_type;   /* Type Python 'BinContent'    */
    int ret;                                /* Bilan d'un appel            */

    py_instr_iterator_type = get_python_instr_iterator_type();

    if (PyType_Ready(py_instr_iterator_type) < 0)
        return false;

    Py_INCREF(py_instr_iterator_type);
    ret = PyModule_AddObject(module, "InstrIterator", (PyObject *)py_instr_iterator_type);

    return (ret == 0);

}