src/cpython.h

   1 /**
   2  * collectd - src/cpython.h
   3  * Copyright (C) 2009  Sven Trenkel
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Sven Trenkel <collectd at semidefinite.de>
  25  **/
  26
  27 /* These two macros are basicly Py_BEGIN_ALLOW_THREADS and Py_BEGIN_ALLOW_THREADS
  28  * from the other direction. If a Python thread calls a C function
  29  * Py_BEGIN_ALLOW_THREADS is used to allow other python threads to run because
  30  * we don't intend to call any Python functions.
  31  *
  32  * These two macros are used whenever a C thread intends to call some Python
  33  * function, usually because some registered callback was triggered.
  34  * Just like Py_BEGIN_ALLOW_THREADS it opens a block so these macros have to be
  35  * used in pairs. They aquire the GIL, create a new Python thread state and swap
  36  * the current thread state with the new one. This means this thread is now allowed
  37  * to execute Python code. */
  38
  39 #define CPY_LOCK_THREADS {\
  40         PyGILState_STATE gil_state;\
  41         gil_state = PyGILState_Ensure();
  42
  43 #define CPY_RETURN_FROM_THREADS \
  44         PyGILState_Release(gil_state);\
  45         return
  46
  47 #define CPY_RELEASE_THREADS \
  48         PyGILState_Release(gil_state);\
  49 }
  50
  51 /* Python 2.4 has this macro, older versions do not. */
  52 #ifndef Py_VISIT
  53 #define Py_VISIT(o) do {\
  54         int _vret;\
  55         if ((o) != NULL) {\
  56                 _vret = visit((o), arg);\
  57                 if (_vret != 0)\
  58                 return _vret;\
  59         }\
  60 } while (0)
  61 #endif
  62
  63 /* Python 2.4 has this macro, older versions do not. */
  64 #ifndef Py_CLEAR
  65 #define Py_CLEAR(o) do {\
  66         PyObject *tmp = o;\
  67         (o) = NULL;\
  68         Py_XDECREF(tmp);\
  69 } while (0)
  70 #endif
  71
  72 /* Python 2.4 has this macro, older versions do not. */
  73 #ifndef Py_RETURN_NONE
  74 # define Py_RETURN_NONE return Py_INCREF(Py_None), Py_None
  75 #endif
  76
  77
  78 /* Python3 compatibility layer. To keep the actual code as clean as possible
  79  * do a lot of defines here. */
  80
  81 #if PY_MAJOR_VERSION >= 3
  82 #define IS_PY3K
  83 #endif
  84
  85 #ifdef IS_PY3K
  86 #define PyInt_FromLong PyLong_FromLong
  87 //#define PyString_FromString PyBytes_FromString
  88 #define CPY_INIT_TYPE         PyVarObject_HEAD_INIT(NULL, 0)
  89 #define IS_BYTES_OR_UNICODE(o) (PyUnicode_Check(o) || PyBytes_Check(o))
  90 #else
  91 #define CPY_INIT_TYPE         PyObject_HEAD_INIT(NULL) 0,
  92 #define IS_BYTES_OR_UNICODE(o) (PyUnicode_Check(o) || PyString_Check(o))
  93 #endif
  94
  95 static inline const char *cpy_unicode_or_bytes_to_string(PyObject **o) {
  96         if (PyUnicode_Check(*o)) {
  97                 PyObject *tmp;
  98                 tmp = PyUnicode_AsEncodedString(*o, NULL, NULL); /* New reference. */
  99                 if (tmp == NULL)
 100                         return NULL;
 101                 Py_DECREF(*o);
 102                 *o = tmp;
 103         }
 104         return PyBytes_AsString(*o);
 105 }
 106
 107 static inline PyObject *cpy_string_to_unicode_or_bytes(const char *buf) {
 108 #ifdef IS_PY3K
 109 /* Python3 preferrs unicode */
 110         PyObject *ret;
 111         ret = PyUnicode_Decode(buf, strlen(buf), NULL, NULL);
 112         if (ret != NULL)
 113                 return ret;
 114         PyErr_Clear();
 115 #endif
 116         return PyBytes_FromString(buf);
 117 }
 118
 119  /* Python object declarations. */
 120
 121 typedef struct {
 122         PyObject_HEAD        /* No semicolon! */
 123         PyObject *parent;    /* Config */
 124         PyObject *key;       /* String */
 125         PyObject *values;    /* Sequence */
 126         PyObject *children;  /* Sequence */
 127 } Config;
 128
 129 PyTypeObject ConfigType;
 130
 131 typedef struct {
 132         PyObject_HEAD        /* No semicolon! */
 133         double time;
 134         char host[DATA_MAX_NAME_LEN];
 135         char plugin[DATA_MAX_NAME_LEN];
 136         char plugin_instance[DATA_MAX_NAME_LEN];
 137         char type[DATA_MAX_NAME_LEN];
 138         char type_instance[DATA_MAX_NAME_LEN];
 139 } PluginData;
 140
 141 PyTypeObject PluginDataType;
 142
 143 typedef struct {
 144         PluginData data;
 145         PyObject *values;    /* Sequence */
 146         int interval;
 147 } Values;
 148
 149 PyTypeObject ValuesType;
 150
 151 typedef struct {
 152         PluginData data;
 153         int severity;
 154         char message[NOTIF_MAX_MSG_LEN];
 155 } Notification;
 156
 157 PyTypeObject NotificationType;