summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/arch/constants.c
blob: 36047951c32117f9adc4dd8e76d769c52125b67a (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * constants.c - ajout des constantes de base pour les architectures
 *
 * 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 "constants.h"


//#include <arch/instruction.h>
//#include <arch/processor.h>
#include <arch/vmpa.h>


#include "../helpers.h"


#if 0 // FIXME

/******************************************************************************
*                                                                             *
*  Paramètres  : type = type dont le dictionnaire est à compléter.            *
*                                                                             *
*  Description : Définit les constantes relatives aux instructions.           *
*                                                                             *
*  Retour      : true en cas de succès de l'opération, false sinon.           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool define_arch_instruction_constants(PyTypeObject *type)
{
    bool result;                            /* Bilan à retourner           */
    PyObject *values;                       /* Groupe de valeurs à établir */

    values = PyDict_New();

    result = add_const_to_group(values, "NONE", AIF_NONE);
    if (result) result = add_const_to_group(values, "ROUTINE_START", AIF_ROUTINE_START);
    if (result) result = add_const_to_group(values, "RETURN_POINT", AIF_RETURN_POINT);
    if (result) result = add_const_to_group(values, "COND_RETURN_POINT", AIF_COND_RETURN_POINT);
    if (result) result = add_const_to_group(values, "CALL", AIF_CALL);
    if (result) result = add_const_to_group(values, "LOW_USER", AIF_LOW_USER);
    if (result) result = add_const_to_group(values, "HIGH_USER", AIF_HIGH_USER);

    if (!result)
    {
        Py_DECREF(values);
        goto exit;
    }

    result = attach_constants_group_to_type(type, true, "ArchInstrFlag", values,
                                            "Flags for some instruction properties.");

    values = PyDict_New();

    result = add_const_to_group(values, "FETCH", IPH_FETCH);
    if (result) result = add_const_to_group(values, "LINK", IPH_LINK);
    if (result) result = add_const_to_group(values, "POST", IPH_POST);
    if (result) result = add_const_to_group(values, "COUNT", IPH_COUNT);

    if (!result)
    {
        Py_DECREF(values);
        goto exit;
    }

    result = attach_constants_group_to_type(type, false, "InstrProcessHook", values,
                                            "Kind of hook for instruction processing after disassembling.");

    values = PyDict_New();

    result = add_const_to_group(values, "EXEC_FLOW", ILT_EXEC_FLOW);
    if (result) result = add_const_to_group(values, "JUMP", ILT_JUMP);
    if (result) result = add_const_to_group(values, "CASE_JUMP", ILT_CASE_JUMP);
    if (result) result = add_const_to_group(values, "JUMP_IF_TRUE", ILT_JUMP_IF_TRUE);
    if (result) result = add_const_to_group(values, "JUMP_IF_FALSE", ILT_JUMP_IF_FALSE);
    if (result) result = add_const_to_group(values, "LOOP", ILT_LOOP);
    if (result) result = add_const_to_group(values, "CALL", ILT_CALL);
    if (result) result = add_const_to_group(values, "CATCH_EXCEPTION", ILT_CATCH_EXCEPTION);
    if (result) result = add_const_to_group(values, "REF", ILT_REF);
    if (result) result = add_const_to_group(values, "COUNT", ILT_COUNT);

    if (!result)
    {
        Py_DECREF(values);
        goto exit;
    }

    result = attach_constants_group_to_type(type, false, "InstructionLinkType", values,
                                            "Kind of link between two instructions.");

 exit:

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type = type dont le dictionnaire est à compléter.            *
*                                                                             *
*  Description : Définit les constantes relatives aux processeurs.            *
*                                                                             *
*  Retour      : true en cas de succès de l'opération, false sinon.           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool define_arch_processor_constants(PyTypeObject *type)
{
    bool result;                            /* Bilan à retourner           */
    PyObject *values;                       /* Groupe de valeurs à établir */

    values = PyDict_New();

    result = add_const_to_group(values, "DISASSEMBLY", APE_DISASSEMBLY);
    if (result) result = add_const_to_group(values, "LABEL", APE_LABEL);

    if (!result)
    {
        Py_DECREF(values);
        goto exit;
    }

    result = attach_constants_group_to_type(type, true, "ArchProcessingError", values,
                                            "Flags for error occurring while disassembling instructions.");

 exit:

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

int convert_to_arch_processing_error(PyObject *arg, void *dst)
{
    int result;                             /* Bilan à retourner           */
    unsigned long value;                    /* Valeur transcrite           */

    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 ArchProcessingError");
            break;

        case 1:
            value = PyLong_AsUnsignedLong(arg);

            if ((value & (APE_DISASSEMBLY | APE_LABEL)) != 0)
            {
                PyErr_SetString(PyExc_TypeError, "invalid value for ArchProcessingError");
                result = 0;
            }

            else
                *((ArchProcessingError *)dst) = value;

            break;

        default:
            assert(false);
            break;

    }

    return result;

}
#endif


/******************************************************************************
*                                                                             *
*  Paramètres  : type = type dont le dictionnaire est à compléter.            *
*                                                                             *
*  Description : Définit les constantes relatives aux emplacements.           *
*                                                                             *
*  Retour      : true en cas de succès de l'opération, false sinon.           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool define_arch_vmpa_constants(PyTypeObject *type)
{
    bool result;                            /* Bilan à retourner           */
    PyObject *values;                       /* Groupe de valeurs à établir */

    values = PyDict_New();

    result = add_const_to_group(values, "NO_PHYSICAL", VMPA_NO_PHYSICAL);
    if (result) result = add_const_to_group(values, "NO_VIRTUAL", VMPA_NO_VIRTUAL);

    if (!result)
    {
        Py_DECREF(values);
        goto exit;
    }

    result = attach_constants_group_to_type(type, false, "VmpaSpecialValue", values,
                                            "Special values for memory locations.");

 exit:

    return result;

}


#if 0 // FIXME
/******************************************************************************
*                                                                             *
*  Paramètres  : type = type dont le dictionnaire est à compléter.            *
*                                                                             *
*  Description : Définit les constantes relatives aux contextes.              *
*                                                                             *
*  Retour      : true en cas de succès de l'opération, false sinon.           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool define_proc_context_constants(PyTypeObject *type)
{
    bool result;                            /* Bilan à retourner           */
    PyObject *values;                       /* Groupe de valeurs à établir */

    values = PyDict_New();

    result = add_const_to_group(values, "ENTRY_POINT", DPL_ENTRY_POINT);
    if (result) result = add_const_to_group(values, "FORMAT_POINT", DPL_FORMAT_POINT);
    if (result) result = add_const_to_group(values, "SYMBOL", DPL_SYMBOL);
    if (result) result = add_const_to_group(values, "OTHER", DPL_OTHER);
    if (result) result = add_const_to_group(values, "COUNT", DPL_COUNT);

    if (!result)
    {
        Py_DECREF(values);
        goto exit;
    }

    result = attach_constants_group_to_type(type, true, "DisassPriorityLevel", values,
                                            "Level of priority for a given point during the" \
                                            " disassembling process.");

 exit:

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

int convert_to_disass_priority_level(PyObject *arg, void *dst)
{
    int result;                             /* Bilan à retourner           */
    unsigned long value;                    /* Valeur transcrite           */

    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 DisassPriorityLevel");
            break;

        case 1:
            value = PyLong_AsUnsignedLong(arg);

            if (value > DPL_COUNT)
            {
                PyErr_SetString(PyExc_TypeError, "invalid value for DisassPriorityLevel");
                result = 0;
            }

            else
                *((DisassPriorityLevel *)dst) = value;

            break;

        default:
            assert(false);
            break;

    }

    return result;

}
#endif