summaryrefslogtreecommitdiff
path: root/plugins/pychrysa/common/bits.c
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/pychrysa/common/bits.c')
-rw-r--r--plugins/pychrysa/common/bits.c653
1 files changed, 653 insertions, 0 deletions
diff --git a/plugins/pychrysa/common/bits.c b/plugins/pychrysa/common/bits.c
new file mode 100644
index 0000000..33f81c3
--- /dev/null
+++ b/plugins/pychrysa/common/bits.c
@@ -0,0 +1,653 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * bits.c - équivalent Python du fichier "common/bits.c"
+ *
+ * Copyright (C) 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 "bits.h"
+
+
+#include "../helpers.h"
+
+
+
+/* Encapsulation d'un champ de bits */
+typedef struct _py_bitfield_t
+{
+ PyObject_HEAD /* A laisser en premier */
+
+ bitfield_t *native; /* Champ de bits représenté */
+
+} py_bitfield_t;
+
+
+
+/* Crée un nouvel objet Python de type 'bitfield_t'. */
+static PyObject *py_bitfield_new(PyTypeObject *, PyObject *, PyObject *);
+
+/* Crée une copie d'un champ de bits classique. */
+static PyObject *py_bitfield_dup(PyObject *, PyObject *);
+
+/* Effectue une opération de type 'and' avec le type 'bitfield'. */
+static PyObject *py_bitfield_nb_and(PyObject *, PyObject *);
+
+/* Effectue une opération de type 'or' avec le type 'bitfield'. */
+static PyObject *py_bitfield_nb_or(PyObject *, PyObject *);
+
+/* Effectue une comparaison avec un objet Python 'bitfield'. */
+static PyObject *py_bitfield_richcompare(PyObject *, PyObject *, int);
+
+/* Bascule à 0 un champ de bits dans son intégralité. */
+static PyObject *py_bitfield_reset_all(PyObject *, PyObject *);
+
+/* Bascule à 1 un champ de bits dans son intégralité. */
+static PyObject *py_bitfield_set_all(PyObject *, PyObject *);
+
+/* Bascule à 0 une partie d'un champ de bits. */
+static PyObject *py_bitfield_reset(PyObject *, PyObject *);
+
+/* Bascule à 1 une partie d'un champ de bits. */
+static PyObject *py_bitfield_set(PyObject *, PyObject *);
+
+/* Détermine si un bit est à 1 dans un champ de bits. */
+static PyObject *py_bitfield_test(PyObject *, PyObject *);
+
+/* Détermine si un ensemble de bits est à 0 dans un champ. */
+static PyObject *py_bitfield_test_none(PyObject *, PyObject *);
+
+/* Détermine si un ensemble de bits est à 1 dans un champ. */
+static PyObject *py_bitfield_test_all(PyObject *, PyObject *);
+
+
+
+/******************************************************************************
+* *
+* 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 'bitfield_t'. *
+* *
+* Retour : Instance Python mise en place. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_bitfield_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
+{
+ py_bitfield_t *result; /* Instance à retourner */
+ unsigned long length; /* Taille du champ à créer */
+ int state; /* Initialisation par défaut */
+ int ret; /* Bilan de lecture des args. */
+
+ ret = PyArg_ParseTuple(args, "kp", &length, &state);
+ if (!ret) return NULL;
+
+ result = (py_bitfield_t *)type->tp_alloc(type, 0);
+
+ result->native = create_bit_field(length, state);
+
+ return (PyObject *)result;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : self = champ de bits à dupliquer. *
+* args = non utilisé ici. *
+* *
+* Description : Crée une copie d'un champ de bits classique. *
+* *
+* Retour : Champ de bits mis en place. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_bitfield_dup(PyObject *self, PyObject *args)
+{
+ PyObject *result; /* Instance à retourner */
+ py_bitfield_t *bf; /* Instance à manipuler */
+
+ bf = (py_bitfield_t *)self;
+
+ result = build_from_internal_bitfield(bf->native);;
+
+ return result;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : o1 = premier élément concerné par l'opération. *
+* o2 = second élément concerné par l'opération. *
+* *
+* Description : Effectue une opération de type 'and' avec le type 'bitfield'.*
+* *
+* Retour : Résultat de l'opération. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_bitfield_nb_and(PyObject *o1, PyObject *o2)
+{
+ PyObject *result; /* Résultat à retourner */
+ int ret; /* Bilan de compatibilité */
+ py_bitfield_t *bf_1; /* Instance à manipuler #1 */
+ py_bitfield_t *bf_2; /* Instance à manipuler #2 */
+ py_bitfield_t *new; /* Nouvelle version en place */
+
+ ret = PyObject_IsInstance(o2, (PyObject *)get_python_bitfield_type());
+ if (!ret)
+ {
+ result = NULL;
+ goto pbna_done;
+ }
+
+ bf_1 = (py_bitfield_t *)o1;
+ bf_2 = (py_bitfield_t *)o2;
+
+ result = build_from_internal_bitfield(bf_1->native);
+
+ new = (py_bitfield_t *)result;
+
+ and_bit_field(new->native, bf_2->native);
+
+ pbna_done:
+
+ return result;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : o1 = premier élément concerné par l'opération. *
+* o2 = second élément concerné par l'opération. *
+* *
+* Description : Effectue une opération de type 'or' avec le type 'bitfield'. *
+* *
+* Retour : Résultat de l'opération. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_bitfield_nb_or(PyObject *o1, PyObject *o2)
+{
+ PyObject *result; /* Résultat à retourner */
+ int ret; /* Bilan de compatibilité */
+ py_bitfield_t *bf_1; /* Instance à manipuler #1 */
+ py_bitfield_t *bf_2; /* Instance à manipuler #2 */
+ py_bitfield_t *new; /* Nouvelle version en place */
+
+ ret = PyObject_IsInstance(o2, (PyObject *)get_python_bitfield_type());
+ if (!ret)
+ {
+ result = NULL;
+ goto pbna_done;
+ }
+
+ bf_1 = (py_bitfield_t *)o1;
+ bf_2 = (py_bitfield_t *)o2;
+
+ result = build_from_internal_bitfield(bf_1->native);
+
+ new = (py_bitfield_t *)result;
+
+ or_bit_field(new->native, bf_2->native);
+
+ pbna_done:
+
+ return result;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : a = premier object Python à consulter. *
+* b = second object Python à consulter. *
+* op = type de comparaison menée. *
+* *
+* Description : Effectue une comparaison avec un objet Python 'bitfield'. *
+* *
+* Retour : Bilan de l'opération. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_bitfield_richcompare(PyObject *a, PyObject *b, int op)
+{
+ PyObject *result; /* Bilan à retourner */
+ int ret; /* Bilan de lecture des args. */
+ py_bitfield_t *bf_a; /* Instance à manipuler #1 */
+ py_bitfield_t *bf_b; /* Instance à manipuler #2 */
+ int status; /* Résultat d'une comparaison */
+
+ ret = PyObject_IsInstance(b, (PyObject *)get_python_bitfield_type());
+ if (!ret)
+ {
+ result = Py_NotImplemented;
+ goto cmp_done;
+ }
+
+ bf_a = (py_bitfield_t *)a;
+ bf_b = (py_bitfield_t *)b;
+
+ status = compare_bit_fields(bf_a->native, bf_b->native);
+
+ result = status_to_rich_cmp_state(status, op);
+
+ cmp_done:
+
+ Py_INCREF(result);
+
+ return result;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : self = champ de bits à modifier. *
+* args = non utilisé ici. *
+* *
+* Description : Bascule à 0 un champ de bits dans son intégralité. *
+* *
+* Retour : Rien (None). *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_bitfield_reset_all(PyObject *self, PyObject *args)
+{
+ py_bitfield_t *bf; /* Instance à manipuler */
+
+ bf = (py_bitfield_t *)self;
+
+ reset_all_in_bit_field(bf->native);
+
+ Py_RETURN_NONE;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : self = champ de bits à modifier. *
+* args = non utilisé ici. *
+* *
+* Description : Bascule à 1 un champ de bits dans son intégralité. *
+* *
+* Retour : Rien (None). *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_bitfield_set_all(PyObject *self, PyObject *args)
+{
+ py_bitfield_t *bf; /* Instance à manipuler */
+
+ bf = (py_bitfield_t *)self;
+
+ set_all_in_bit_field(bf->native);
+
+ Py_RETURN_NONE;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : self = champ de bits à consulter. *
+* args = arguments fournis pour la conduite de l'opération. *
+* *
+* Description : Bascule à 0 une partie d'un champ de bits. *
+* *
+* Retour : - *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_bitfield_reset(PyObject *self, PyObject *args)
+{
+ unsigned long first; /* Indice du premier bit testé */
+ unsigned long count; /* Nombre de bits à analyser */
+ int ret; /* Bilan de lecture des args. */
+ py_bitfield_t *bf; /* Instance à manipuler */
+
+ ret = PyArg_ParseTuple(args, "kk", &first, &count);
+ if (!ret) return NULL;
+
+ bf = (py_bitfield_t *)self;
+
+ reset_in_bit_field(bf->native, first, count);
+
+ Py_RETURN_NONE;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : self = champ de bits à consulter. *
+* args = arguments fournis pour la conduite de l'opération. *
+* *
+* Description : Bascule à 1 une partie d'un champ de bits. *
+* *
+* Retour : - *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_bitfield_set(PyObject *self, PyObject *args)
+{
+ unsigned long first; /* Indice du premier bit testé */
+ unsigned long count; /* Nombre de bits à analyser */
+ int ret; /* Bilan de lecture des args. */
+ py_bitfield_t *bf; /* Instance à manipuler */
+
+ ret = PyArg_ParseTuple(args, "kk", &first, &count);
+ if (!ret) return NULL;
+
+ bf = (py_bitfield_t *)self;
+
+ set_in_bit_field(bf->native, first, count);
+
+ Py_RETURN_NONE;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : self = champ de bits à consulter. *
+* args = arguments fournis pour la conduite de l'opération. *
+* *
+* Description : Détermine si un bit est à 1 dans un champ de bits. *
+* *
+* Retour : true si le bit correspondant est à l'état haut. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_bitfield_test(PyObject *self, PyObject *args)
+{
+ PyObject *result; /* Bilan à faire remonter */
+ unsigned long n; /* Indice du bit à traiter */
+ int ret; /* Bilan de lecture des args. */
+ py_bitfield_t *bf; /* Instance à manipuler */
+ bool status; /* Bilan d'analyse */
+
+ ret = PyArg_ParseTuple(args, "k", &n);
+ if (!ret) return NULL;
+
+ bf = (py_bitfield_t *)self;
+
+ status = test_in_bit_field(bf->native, n);
+
+ result = status ? Py_True : Py_False;
+
+ Py_INCREF(result);
+
+ return result;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : self = champ de bits à consulter. *
+* args = arguments fournis pour la conduite de l'opération. *
+* *
+* Description : Détermine si un ensemble de bits est à 0 dans un champ. *
+* *
+* Retour : True si les bits correspondants sont à l'état bas. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_bitfield_test_none(PyObject *self, PyObject *args)
+{
+ PyObject *result; /* Bilan à faire remonter */
+ unsigned long first; /* Indice du premier bit testé */
+ unsigned long count; /* Nombre de bits à analyser */
+ int ret; /* Bilan de lecture des args. */
+ py_bitfield_t *bf; /* Instance à manipuler */
+ bool status; /* Bilan d'analyse */
+
+ ret = PyArg_ParseTuple(args, "kk", &first, &count);
+ if (!ret) return NULL;
+
+ bf = (py_bitfield_t *)self;
+
+ status = test_none_in_bit_field(bf->native, first, count);
+
+ result = status ? Py_True : Py_False;
+
+ Py_INCREF(result);
+
+ return result;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : self = champ de bits à consulter. *
+* args = arguments fournis pour la conduite de l'opération. *
+* *
+* Description : Détermine si un ensemble de bits est à 1 dans un champ. *
+* *
+* Retour : True si les bits correspondants sont à l'état haut. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+static PyObject *py_bitfield_test_all(PyObject *self, PyObject *args)
+{
+ PyObject *result; /* Bilan à faire remonter */
+ unsigned long first; /* Indice du premier bit testé */
+ unsigned long count; /* Nombre de bits à analyser */
+ int ret; /* Bilan de lecture des args. */
+ py_bitfield_t *bf; /* Instance à manipuler */
+ bool status; /* Bilan d'analyse */
+
+ ret = PyArg_ParseTuple(args, "kk", &first, &count);
+ if (!ret) return NULL;
+
+ bf = (py_bitfield_t *)self;
+
+ status = test_all_in_bit_field(bf->native, first, count);
+
+ result = status ? Py_True : Py_False;
+
+ Py_INCREF(result);
+
+ 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_bitfield_type(void)
+{
+ static PyNumberMethods py_bitfield_nb_proto = {
+
+ .nb_and = py_bitfield_nb_and,
+ .nb_or = py_bitfield_nb_or
+
+ };
+
+ static PyMethodDef py_bitfield_methods[] = {
+ {
+ "dup", py_bitfield_dup,
+ METH_NOARGS,
+ "dup(self, /)\n--\n\nDuplicate a bitfield."
+ },
+ {
+ "reset_all", py_bitfield_reset_all,
+ METH_NOARGS,
+ "reset_all(self, /)\n--\n\nSwitch to 0 all bits in a bitfield."
+ },
+ {
+ "set_all", py_bitfield_set_all,
+ METH_NOARGS,
+ "set_all(self, /)\n--\n\nSwitch to 1 all bits in a bitfield."
+ },
+ {
+ "reset", py_bitfield_reset,
+ METH_VARARGS,
+ "reset(self, first, count, /)\n--\n\nSwitch to 0 a part of bits in a bitfield."
+ },
+ {
+ "set", py_bitfield_set,
+ METH_VARARGS,
+ "set(self, first, count, /)\n--\n\nSwitch to 1 a part of bits in a bitfield."
+ },
+ {
+ "test", py_bitfield_test,
+ METH_VARARGS,
+ "test(self, n, /)\n--\n\nTest if a given bit is set in a bitfield."
+ },
+ {
+ "test_none", py_bitfield_test_none,
+ METH_VARARGS,
+ "test_none(self, first, count, /)\n--\n\nTest a range of bits to 0."
+ },
+ {
+ "test_all", py_bitfield_test_all,
+ METH_VARARGS,
+ "test_all(self, first, count, /)\n--\n\nTest a range of bits to 1."
+ },
+ { NULL }
+ };
+
+ static PyGetSetDef py_bitfield_getseters[] = {
+ { NULL }
+ };
+
+ static PyTypeObject py_bitfield_type = {
+
+ PyVarObject_HEAD_INIT(NULL, 0)
+
+ .tp_name = "pychrysalide.common.bitfield",
+ .tp_basicsize = sizeof(py_bitfield_t),
+
+ .tp_as_number = &py_bitfield_nb_proto,
+
+ .tp_flags = Py_TPFLAGS_DEFAULT,
+
+ .tp_doc = "Python object for bitfield_t.",
+
+ .tp_richcompare = py_bitfield_richcompare,
+
+ .tp_methods = py_bitfield_methods,
+ .tp_getset = py_bitfield_getseters,
+ .tp_new = (newfunc)py_bitfield_new
+
+ };
+
+ return &py_bitfield_type;
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : module = module dont la définition est à compléter. *
+* *
+* Description : Prend en charge l'objet 'pychrysalide.common.bitfield'. *
+* *
+* Retour : Bilan de l'opération. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+bool register_python_bitfield(PyObject *module)
+{
+ PyTypeObject *py_bitfield_type; /* Type Python pour 'bitfield' */
+ int ret; /* Bilan d'un appel */
+
+ py_bitfield_type = get_python_bitfield_type();
+
+ if (PyType_Ready(py_bitfield_type) != 0)
+ return false;
+
+ Py_INCREF(py_bitfield_type);
+ ret = PyModule_AddObject(module, "bitfield", (PyObject *)py_bitfield_type);
+
+ return (ret == 0);
+
+}
+
+
+/******************************************************************************
+* *
+* Paramètres : field = structure interne à copier en objet Python. *
+* *
+* Description : Convertit une structure de type 'bitfield' en objet Python. *
+* *
+* Retour : Object Python résultant de la conversion opérée. *
+* *
+* Remarques : - *
+* *
+******************************************************************************/
+
+PyObject *build_from_internal_bitfield(const bitfield_t *field)
+{
+ py_bitfield_t *result; /* Instance à retourner */
+ PyTypeObject *type; /* Type à instancier */
+
+ type = get_python_bitfield_type();
+
+ result = (py_bitfield_t *)type->tp_alloc(type, 0);
+
+ result->native = dup_bit_field(field);
+
+ return (PyObject *)result;
+
+}
generated by cgit v0.11.2-87-g4458 at 2024-04-19 07:06:48 (GMT)