/* Chrysalide - Outil d'analyse de fichiers binaires
* immediate.c - équivalent Python du fichier "arch/immediate.h"
*
* 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 "immediate.h"
#include <assert.h>
#include <pygobject.h>
#include <i18n.h>
#include <arch/immediate.h>
#include "operand.h"
#include "targetableop.h"
#include "../access.h"
#include "../helpers.h"
/* Fournit la valeur portée par une opérande numérique. */
static PyObject *py_imm_operand_get_value(PyObject *, void *);
/* Indique si l'affichage est complété avec des zéros. */
static PyObject *py_imm_operand_get_padding_by_default(PyObject *self, void *);
/* Précise si des zéro doivent compléter l'affichage ou non. */
static int py_imm_operand_set_padding_by_default(PyObject *, PyObject *, void *);
/* Indique si l'affichage est complété avec des zéros. */
static PyObject *py_imm_operand_get_padding(PyObject *self, void *);
/* Précise si des zéro doivent compléter l'affichage ou non. */
static int py_imm_operand_set_padding(PyObject *, PyObject *, void *);
/* Indique le format textuel par défaut de la valeur. */
static PyObject *py_imm_operand_get_default_display(PyObject *, void *);
/* Définit le format textuel par défaut de la valeur. */
static int py_imm_operand_set_default_display(PyObject *, PyObject *, void *);
/* Indique la grande ligne du format textuel de la valeur. */
static PyObject *py_imm_operand_get_display(PyObject *, void *);
/* Définit la grande ligne du format textuel de la valeur. */
static int py_imm_operand_set_display(PyObject *, PyObject *, void *);
/* Construit la chaîne de caractères correspondant à l'opérande. */
static PyObject *py_imm_operand_to_string(PyObject *, PyObject *);
/* Crée un nouvel objet Python de type 'ImmOperand'. */
static PyObject *py_imm_operand_new(PyTypeObject *, PyObject *, PyObject *);
/* Définit les constantes pour les opérandes d'immédiats. */
static bool py_imm_operand_define_constants(PyTypeObject *);
/******************************************************************************
* *
* Paramètres : self = objet Python concerné par l'appel. *
* closure = non utilisé ici. *
* *
* Description : Renseigne la taille de la valeur indiquée à la construction. *
* *
* Retour : Taille de la valeur représentée en mémoire. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_imm_operand_get_size(PyObject *self, void *closure)
{
PyObject *result; /* Instance Python à retourner */
GImmOperand *operand; /* Version GLib de l'opérande */
MemoryDataSize size; /* Type de donnée représentée */
operand = G_IMM_OPERAND(pygobject_get(self));
assert(operand != NULL);
size = g_imm_operand_get_size(operand);
result = Py_BuildValue("I", size);
return result;
}
/******************************************************************************
* *
* Paramètres : self = objet Python concerné par l'appel. *
* closure = non utilisé ici. *
* *
* Description : Fournit la valeur portée par une opérande numérique. *
* *
* Retour : Valeur contenue dans l'opérande, ou None en cas de soucis. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_imm_operand_get_value(PyObject *self, void *closure)
{
PyObject *result; /* Instance Python à retourner */
GImmOperand *operand; /* Version GLib de l'opérande */
MemoryDataSize size; /* Type de donnée représentée */
uint8_t uval8; /* Valeur sur 8 bits */
uint16_t uval16; /* Valeur sur 16 bits */
uint32_t uval32; /* Valeur sur 32 bits */
uint64_t uval64; /* Valeur sur 64 bits */
int8_t sval8; /* Valeur sur 8 bits */
int16_t sval16; /* Valeur sur 16 bits */
int32_t sval32; /* Valeur sur 32 bits */
int64_t sval64; /* Valeur sur 64 bits */
operand = G_IMM_OPERAND(pygobject_get(self));
assert(operand != NULL);
size = g_imm_operand_get_size(operand);
switch (size)
{
/* Pour GCC... */
case MDS_UNDEFINED:
result = Py_None;
Py_INCREF(result);
break;
case MDS_4_BITS_UNSIGNED:
case MDS_8_BITS_UNSIGNED:
g_imm_operand_get_value(operand, size, &uval8);
result = PyLong_FromUnsignedLong(uval8);
break;
case MDS_16_BITS_UNSIGNED:
g_imm_operand_get_value(operand, size, &uval16);
result = PyLong_FromUnsignedLong(uval16);
break;
case MDS_32_BITS_UNSIGNED:
g_imm_operand_get_value(operand, size, &uval32);
result = PyLong_FromUnsignedLong(uval32);
break;
case MDS_64_BITS_UNSIGNED:
g_imm_operand_get_value(operand, size, &uval64);
result = PyLong_FromUnsignedLongLong(uval64);
break;
case MDS_4_BITS_SIGNED:
case MDS_8_BITS_SIGNED:
g_imm_operand_get_value(operand, size, &sval8);
result = PyLong_FromLong(sval8);
break;
case MDS_16_BITS_SIGNED:
g_imm_operand_get_value(operand, size, &sval16);
result = PyLong_FromLong(sval16);
break;
case MDS_32_BITS_SIGNED:
g_imm_operand_get_value(operand, size, &sval32);
result = PyLong_FromLong(sval32);
break;
case MDS_64_BITS_SIGNED:
g_imm_operand_get_value(operand, size, &sval64);
result = PyLong_FromLongLong(sval64);
break;
/* Pour GCC... */
default:
assert(false);
result = Py_None;
Py_INCREF(result);
break;
}
return result;
}
/******************************************************************************
* *
* Paramètres : self = objet Python concerné par l'appel. *
* closure = non utilisé ici. *
* *
* Description : Indique si l'affichage est complété avec des zéros. *
* *
* Retour : true si des zéro sont ajoutés à l'affichage, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_imm_operand_get_padding_by_default(PyObject *self, void *closure)
{
PyObject *result; /* Instance Python à retourner */
GImmOperand *operand; /* Version GLib de l'opérande */
bool padding; /* Bourrage en préfixe ? */
operand = G_IMM_OPERAND(pygobject_get(self));
assert(operand != NULL);
padding = g_imm_operand_does_padding_by_default(operand);
result = Py_BuildValue("p", padding);
return result;
}
/******************************************************************************
* *
* Paramètres : self = objet Python concerné par l'appel. *
* value = valeur fournie à intégrer ou prendre en compte. *
* closure = non utilisé ici. *
* *
* Description : Précise si des zéro doivent compléter l'affichage ou non. *
* *
* Retour : Bilan de l'opération pour Python. *
* *
* Remarques : - *
* *
******************************************************************************/
static int py_imm_operand_set_padding_by_default(PyObject *self, PyObject *value, void *closure)
{
bool padding; /* Bourrage en préfixe ? */
GImmOperand *operand; /* Version GLib de l'opérande */
if (!PyBool_Check(value))
{
PyErr_SetString(PyExc_TypeError, _("Invalid padding state"));
return -1;
}
padding = (value == Py_True);
operand = G_IMM_OPERAND(pygobject_get(self));
assert(operand != NULL);
g_imm_operand_pad_by_default(operand, padding);
return 0;
}
/******************************************************************************
* *
* Paramètres : self = objet Python concerné par l'appel. *
* closure = non utilisé ici. *
* *
* Description : Indique si l'affichage est complété avec des zéros. *
* *
* Retour : true si des zéro sont ajoutés à l'affichage, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_imm_operand_get_padding(PyObject *self, void *closure)
{
PyObject *result; /* Instance Python à retourner */
GImmOperand *operand; /* Version GLib de l'opérande */
bool padding; /* Bourrage en préfixe ? */
operand = G_IMM_OPERAND(pygobject_get(self));
assert(operand != NULL);
padding = g_imm_operand_does_padding(operand);
result = Py_BuildValue("p", padding);
return result;
}
/******************************************************************************
* *
* Paramètres : self = objet Python concerné par l'appel. *
* value = valeur fournie à intégrer ou prendre en compte. *
* closure = non utilisé ici. *
* *
* Description : Précise si des zéro doivent compléter l'affichage ou non. *
* *
* Retour : Bilan de l'opération pour Python. *
* *
* Remarques : - *
* *
******************************************************************************/
static int py_imm_operand_set_padding(PyObject *self, PyObject *value, void *closure)
{
bool padding; /* Bourrage en préfixe ? */
GImmOperand *operand; /* Version GLib de l'opérande */
if (!PyBool_Check(value))
{
PyErr_SetString(PyExc_TypeError, _("Invalid padding state"));
return -1;
}
padding = (value == Py_True);
operand = G_IMM_OPERAND(pygobject_get(self));
assert(operand != NULL);
g_imm_operand_pad(operand, padding);
return 0;
}
/******************************************************************************
* *
* Paramètres : self = objet Python concerné par l'appel. *
* closure = non utilisé ici. *
* *
* Description : Indique le format textuel par défaut de la valeur. *
* *
* Retour : Format global d'un affichage de valeur. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_imm_operand_get_default_display(PyObject *self, void *closure)
{
PyObject *result; /* Instance Python à retourner */
GImmOperand *operand; /* Version GLib de l'opérande */
ImmOperandDisplay display; /* Type d'affichage courant */
operand = G_IMM_OPERAND(pygobject_get(self));
assert(operand != NULL);
display = g_imm_operand_get_default_display(operand);
result = Py_BuildValue("I", display);
return result;
}
/******************************************************************************
* *
* Paramètres : self = objet Python concerné par l'appel. *
* value = valeur fournie à intégrer ou prendre en compte. *
* closure = non utilisé ici. *
* *
* Description : Définit le format textuel par défaut de la valeur. *
* *
* Retour : Bilan de l'opération pour Python. *
* *
* Remarques : - *
* *
******************************************************************************/
static int py_imm_operand_set_default_display(PyObject *self, PyObject *value, void *closure)
{
ImmOperandDisplay display; /* Type d'affichage demandé */
GImmOperand *operand; /* Version GLib de l'opérande */
if (!PyLong_Check(value))
{
PyErr_SetString(PyExc_TypeError, _("Invalid display type"));
return -1;
}
display = PyLong_AsUnsignedLong(value);
if (!(IOD_BIN <= display && display <= IOD_CHAR))
{
PyErr_SetString(PyExc_TypeError, _("Invalid display type"));
return -1;
}
operand = G_IMM_OPERAND(pygobject_get(self));
assert(operand != NULL);
g_imm_operand_set_default_display(operand, display);
return 0;
}
/******************************************************************************
* *
* Paramètres : self = objet Python concerné par l'appel. *
* closure = non utilisé ici. *
* *
* Description : Indique la grande ligne du format textuel de la valeur. *
* *
* Retour : Format global d'un affichage de valeur. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_imm_operand_get_display(PyObject *self, void *closure)
{
PyObject *result; /* Instance Python à retourner */
GImmOperand *operand; /* Version GLib de l'opérande */
ImmOperandDisplay display; /* Type d'affichage courant */
operand = G_IMM_OPERAND(pygobject_get(self));
assert(operand != NULL);
display = g_imm_operand_get_display(operand);
result = Py_BuildValue("I", display);
return result;
}
/******************************************************************************
* *
* Paramètres : self = objet Python concerné par l'appel. *
* value = valeur fournie à intégrer ou prendre en compte. *
* closure = non utilisé ici. *
* *
* Description : Définit la grande ligne du format textuel de la valeur. *
* *
* Retour : Bilan de l'opération pour Python. *
* *
* Remarques : - *
* *
******************************************************************************/
static int py_imm_operand_set_display(PyObject *self, PyObject *value, void *closure)
{
ImmOperandDisplay display; /* Type d'affichage demandé */
GImmOperand *operand; /* Version GLib de l'opérande */
if (!PyLong_Check(value))
{
PyErr_SetString(PyExc_TypeError, _("Invalid display type"));
return -1;
}
display = PyLong_AsUnsignedLong(value);
if (!(IOD_BIN <= display && display <= IOD_CHAR))
{
PyErr_SetString(PyExc_TypeError, _("Invalid display type"));
return -1;
}
operand = G_IMM_OPERAND(pygobject_get(self));
assert(operand != NULL);
g_imm_operand_set_display(operand, display);
return 0;
}
/******************************************************************************
* *
* Paramètres : self = operande à manipuler. *
* args = arguments accompagnant l'appel. *
* *
* Description : Construit la chaîne de caractères correspondant à l'opérande.*
* *
* Retour : Chaîne de caractères mise en place. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_imm_operand_to_string(PyObject *self, PyObject *args)
{
PyObject *result; /* Instance à retourner */
GImmOperand *operand; /* Version GLib de l'opérande */
char value[IMM_MAX_SIZE]; /* Valeur humainement lisible */
operand = G_IMM_OPERAND(pygobject_get(self));
assert(operand != NULL);
g_imm_operand_to_string(operand, value);
result = PyUnicode_FromString(value);
return result;
}
/******************************************************************************
* *
* Paramètres : type = type de l'objet à instancier. *
* args = arguments fournis à l'appel. *
* kwds = arguments de type key=val fournis. *
* *
* Description : Crée un nouvel objet Python de type 'ImmOperand'. *
* *
* Retour : Instance Python mise en place. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_imm_operand_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
PyObject *result; /* Instance à retourner */
unsigned int raw_size; /* Taille obtenue de Python */
unsigned long long value; /* Valeur brute à représenter */
int ret; /* Bilan de lecture des args. */
MemoryDataSize size; /* Taille des données finale */
GArchOperand *operand; /* Création GLib à transmettre */
ret = PyArg_ParseTuple(args, "IK", &raw_size, &value);
if (!ret) return NULL;
size = raw_size;
if (size != MDS_UNDEFINED
&& !(MDS_4_BITS_UNSIGNED <= size && size <= MDS_64_BITS_UNSIGNED)
&& !(MDS_4_BITS_SIGNED <= size && size <= MDS_64_BITS_SIGNED))
{
PyErr_SetString(PyExc_ValueError, _("Invalid size to build an immediate operand"));
return NULL;
}
operand = g_imm_operand_new_from_value(size, value);
result = pygobject_new(G_OBJECT(operand));
g_object_unref(operand);
return (PyObject *)result;
}
/******************************************************************************
* *
* Paramètres : obj_type = type dont le dictionnaire est à compléter. *
* *
* Description : Définit les constantes pour les opérandes d'immédiats. *
* *
* Retour : true en cas de succès de l'opération, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
static bool py_imm_operand_define_constants(PyTypeObject *obj_type)
{
bool result; /* Bilan à retourner */
result = true;
result &= PyDict_AddIntMacro(obj_type, IOD_BIN);
result &= PyDict_AddIntMacro(obj_type, IOD_OCT);
result &= PyDict_AddIntMacro(obj_type, IOD_DEC);
result &= PyDict_AddIntMacro(obj_type, IOD_HEX);
result &= PyDict_AddIntMacro(obj_type, IOD_CHAR);
result &= PyDict_AddIntMacro(obj_type, IOD_COUNT);
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_imm_operand_type(void)
{
static PyMethodDef py_imm_operand_methods[] = {
{
"to_string", py_imm_operand_to_string,
METH_NOARGS,
"to_string($self, syntax, /)\n--\n\nConvert the immediate operand to a string."
},
{ NULL }
};
static PyGetSetDef py_imm_operand_getseters[] = {
{
"size", py_imm_operand_get_size, NULL,
"Size of the value contained in the operand.", NULL
},
{
"value", py_imm_operand_get_value, NULL,
"Value of the immediate operand.", NULL
},
{
"padding", py_imm_operand_get_padding, py_imm_operand_set_padding,
"Status of padding with zeros in front of the textual representation.", NULL
},
{
"default_padding", py_imm_operand_get_padding_by_default, py_imm_operand_set_padding_by_default,
"Status of default padding with zeros in front of the textual representation.", NULL
},
{
"default_display", py_imm_operand_get_default_display, py_imm_operand_set_default_display,
"Definition of the immediate operand default textual representation.", NULL
},
{
"display", py_imm_operand_get_display, py_imm_operand_set_display,
"Definition of the immediate operand current textual representation.", NULL
},
{ NULL }
};
static PyTypeObject py_imm_operand_type = {
PyVarObject_HEAD_INIT(NULL, 0)
.tp_name = "pychrysalide.arch.ImmOperand",
.tp_basicsize = sizeof(PyGObject),
.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_IS_ABSTRACT | Py_TPFLAGS_BASETYPE,
.tp_doc = "PyChrysalide immediate operand.",
.tp_methods = py_imm_operand_methods,
.tp_getset = py_imm_operand_getseters,
.tp_new = py_imm_operand_new
};
return &py_imm_operand_type;
}
/******************************************************************************
* *
* Paramètres : module = module dont la définition est à compléter. *
* *
* Description : Prend en charge l'objet 'pychrysalide.arch.ImmOperand'. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
bool ensure_python_imm_operand_is_registered(void)
{
PyTypeObject *type; /* Type Python 'ImmOperand' */
PyObject *module; /* Module à recompléter */
PyObject *dict; /* Dictionnaire du module */
type = get_python_imm_operand_type();
if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
{
module = get_access_to_python_module("pychrysalide.arch");
dict = PyModule_GetDict(module);
if (!ensure_python_arch_operand_is_registered())
return false;
if (!ensure_python_targetable_operand_is_registered())
return false;
if (!register_class_for_pygobject(dict, G_TYPE_IMM_OPERAND, type, get_python_arch_operand_type()))
return false;
if (!py_imm_operand_define_constants(type))
return false;
}
return true;
}