lib/talloc/pytalloc.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Python Talloc Module
   4    Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2010
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include <Python.h>
  21 #include <talloc.h>
  22 #include <pytalloc.h>
  23
  24 void inittalloc(void);
  25
  26 /* print a talloc tree report for a talloc python object */
  27 static PyObject *py_talloc_report_full(PyObject *self, PyObject *args)
  28 {
  29         PyObject *py_obj = Py_None;
  30         PyTypeObject *type;
  31
  32         if (!PyArg_ParseTuple(args, "|O", &py_obj))
  33                 return NULL;
  34
  35         if (py_obj == Py_None) {
  36                 talloc_report_full(NULL, stdout);
  37         } else {
  38                 type = (PyTypeObject*)PyObject_Type(py_obj);
  39                 talloc_report_full(py_talloc_get_mem_ctx(py_obj), stdout);
  40         }
  41         return Py_None;
  42 }
  43
  44 /* enable null tracking */
  45 static PyObject *py_talloc_enable_null_tracking(PyObject *self)
  46 {
  47         talloc_enable_null_tracking();
  48         return Py_None;
  49 }
  50
  51 /* return the number of talloc blocks */
  52 static PyObject *py_talloc_total_blocks(PyObject *self, PyObject *args)
  53 {
  54         PyObject *py_obj = Py_None;
  55         PyTypeObject *type;
  56
  57         if (!PyArg_ParseTuple(args, "|O", &py_obj))
  58                 return NULL;
  59
  60         if (py_obj == Py_None) {
  61                 return PyLong_FromLong(talloc_total_blocks(NULL));
  62         }
  63
  64         type = (PyTypeObject*)PyObject_Type(py_obj);
  65
  66         return PyLong_FromLong(talloc_total_blocks(py_talloc_get_mem_ctx(py_obj)));
  67 }
  68
  69 static PyMethodDef talloc_methods[] = {
  70         { "report_full", (PyCFunction)py_talloc_report_full, METH_VARARGS,
  71                 "show a talloc tree for an object"},
  72         { "enable_null_tracking", (PyCFunction)py_talloc_enable_null_tracking, METH_NOARGS,
  73                 "enable tracking of the NULL object"},
  74         { "total_blocks", (PyCFunction)py_talloc_total_blocks, METH_VARARGS,
  75                 "return talloc block count"},
  76         { NULL }
  77 };
  78
  79 /**
  80  * Default (but only slightly more useful than the default) implementation of Repr().
  81  */
  82 static PyObject *py_talloc_default_repr(PyObject *obj)
  83 {
  84         py_talloc_Object *talloc_obj = (py_talloc_Object *)obj;
  85         PyTypeObject *type = (PyTypeObject*)PyObject_Type(obj);
  86
  87         return PyString_FromFormat("<%s talloc object at 0x%p>",
  88                                    type->tp_name, talloc_obj->ptr);
  89 }
  90
  91 /**
  92  * Simple dealloc for talloc-wrapping PyObjects
  93  */
  94 static void py_talloc_dealloc(PyObject* self)
  95 {
  96         py_talloc_Object *obj = (py_talloc_Object *)self;
  97         assert(talloc_unlink(NULL, obj->talloc_ctx) != -1);
  98         obj->talloc_ctx = NULL;
  99         self->ob_type->tp_free(self);
 100 }
 101
 102 /**
 103  * Default (but only slightly more useful than the default) implementation of cmp.
 104  */
 105 static int py_talloc_default_cmp(PyObject *_obj1, PyObject *_obj2)
 106 {
 107         py_talloc_Object *obj1 = (py_talloc_Object *)_obj1,
 108                                          *obj2 = (py_talloc_Object *)_obj2;
 109         if (obj1->ob_type != obj2->ob_type)
 110                 return (obj1->ob_type - obj2->ob_type);
 111
 112         return ((char *)py_talloc_get_ptr(obj1) - (char *)py_talloc_get_ptr(obj2));
 113 }
 114
 115 static PyTypeObject TallocObject_Type = {
 116         .tp_name = "talloc.Object",
 117         .tp_doc = "Python wrapper for a talloc-maintained object.",
 118         .tp_basicsize = sizeof(py_talloc_Object),
 119         .tp_dealloc = (destructor)py_talloc_dealloc,
 120         .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
 121         .tp_repr = py_talloc_default_repr,
 122         .tp_compare = py_talloc_default_cmp,
 123 };
 124
 125 void inittalloc(void)
 126 {
 127         PyObject *m;
 128
 129         if (PyType_Ready(&TallocObject_Type) < 0)
 130                 return;
 131
 132         m = Py_InitModule3("talloc", talloc_methods,
 133                                            "Python wrapping of talloc-maintained objects.");
 134         if (m == NULL)
 135                 return;
 136
 137         Py_INCREF(&TallocObject_Type);
 138         PyModule_AddObject(m, "Object", (PyObject *)&TallocObject_Type);
 139 }