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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * module.c - intégration du répertoire arch en tant que module
 *
 * Copyright (C) 2012-2017 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 "module.h"


#include <assert.h>


#include <arch/archbase.h>
#include <common/endianness.h>


#include "context.h"
#include "feeder.h"
#include "immediate.h"
#include "instriter.h"
#include "instruction.h"
#include "operand.h"
#include "processor.h"
#include "raw.h"
#include "register.h"
#include "targetableop.h"
#include "undefined.h"
#include "vmpa.h"
#include "operands/module.h"
#include "../helpers.h"



/* Définit les constantes de base pour une architecture. */
static bool py_base_define_constants(PyTypeObject *);



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

static bool py_base_define_constants(PyTypeObject *obj_type)
{
    bool result;                            /* Bilan à retourner           */

    result = true;

    if (result) result = PyDict_AddULongMacro(obj_type, MDS_UNDEFINED);

    if (result) result = PyDict_AddULongMacro(obj_type, MDS_4_BITS_UNSIGNED);
    if (result) result = PyDict_AddULongMacro(obj_type, MDS_8_BITS_UNSIGNED);
    if (result) result = PyDict_AddULongMacro(obj_type, MDS_16_BITS_UNSIGNED);
    if (result) result = PyDict_AddULongMacro(obj_type, MDS_32_BITS_UNSIGNED);
    if (result) result = PyDict_AddULongMacro(obj_type, MDS_64_BITS_UNSIGNED);

    if (result) result = PyDict_AddULongMacro(obj_type, MDS_4_BITS_SIGNED);
    if (result) result = PyDict_AddULongMacro(obj_type, MDS_8_BITS_SIGNED);
    if (result) result = PyDict_AddULongMacro(obj_type, MDS_16_BITS_SIGNED);
    if (result) result = PyDict_AddULongMacro(obj_type, MDS_32_BITS_SIGNED);
    if (result) result = PyDict_AddULongMacro(obj_type, MDS_64_BITS_SIGNED);

    if (result) result = PyDict_AddULongMacro(obj_type, MDS_4_BITS);
    if (result) result = PyDict_AddULongMacro(obj_type, MDS_8_BITS);
    if (result) result = PyDict_AddULongMacro(obj_type, MDS_16_BITS);
    if (result) result = PyDict_AddULongMacro(obj_type, MDS_32_BITS);
    if (result) result = PyDict_AddULongMacro(obj_type, MDS_64_BITS);

    /**
     * Comme il existe déjà le module struct, de nouvelles primitives de
     * lecture/écriture de données sensibles au boutisme sont inutiles dans Python.
     *
     * On choisit donc de ne pas créer de nouvelle entité dans le module Chrysalide
     * pour exporter les constantes suivantes.
     */

    if (result) result = PyDict_AddULongMacro(obj_type, SRE_LITTLE);
    if (result) result = PyDict_AddULongMacro(obj_type, SRE_LITTLE_WORD);
    if (result) result = PyDict_AddULongMacro(obj_type, SRE_BIG_WORD);
    if (result) result = PyDict_AddULongMacro(obj_type, SRE_BIG);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : super = module dont la définition est à compléter.           *
*                                                                             *
*  Description : Ajoute le module 'arch' à un module Python.                  *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool add_arch_module(PyObject *super)
{
    bool result;                            /* Bilan à retourner           */
    PyObject *module;                       /* Sous-module mis en place    */

    static PyModuleDef py_chrysalide_arch_module = {

        .m_base = PyModuleDef_HEAD_INIT,

        .m_name = "pychrysalide.arch",
        .m_doc = "Python module for Chrysalide.arch",

        .m_size = -1,

    };

    module = build_python_module(super, &py_chrysalide_arch_module);

    result = (module != NULL);

    if (result) result = add_arch_operands_module(module);

    if (result) result = py_base_define_constants(Py_TYPE(module));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Intègre les objets du module 'arch'.                         *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool populate_arch_module(void)
{
    bool result;                            /* Bilan à retourner           */

    result = true;

    if (result) result = ensure_python_proc_context_is_registered();
    if (result) result = ensure_python_proxy_feeder_is_registered();
    if (result) result = ensure_python_imm_operand_is_registered();
    if (result) result = ensure_python_instr_iterator_is_registered();
    if (result) result = ensure_python_arch_instruction_is_registered();
    if (result) result = ensure_python_arch_operand_is_registered();
    if (result) result = ensure_python_arch_processor_is_registered();
    if (result) result = ensure_python_raw_instruction_is_registered();
    if (result) result = ensure_python_arch_register_is_registered();
    if (result) result = ensure_python_targetable_operand_is_registered();
    if (result) result = ensure_python_undefined_instruction_is_registered();
    if (result) result = ensure_python_vmpa_is_registered();
    if (result) result = ensure_python_mrange_is_registered();

    if (result) result = populate_arch_operands_module();

    assert(result);

    return result;

}