2 * pythonmod.c: unbound module C wrapper
4 * Copyright (c) 2009, Zdenek Vasicek (vasicek AT fit.vutbr.cz)
5 * Marek Vavrusa (xvavru00 AT stud.fit.vutbr.cz)
7 * This software is open source.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * * Redistributions of source code must retain the above copyright notice,
14 * this list of conditions and the following disclaimer.
16 * * Redistributions in binary form must reproduce the above copyright notice,
17 * this list of conditions and the following disclaimer in the documentation
18 * and/or other materials provided with the distribution.
20 * * Neither the name of the organization nor the names of its
21 * contributors may be used to endorse or promote products derived from this
22 * software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
26 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
27 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
38 * Python module for unbound. Calls python script.
41 /* ignore the varargs unused warning from SWIGs internal vararg support */
43 #pragma GCC diagnostic ignored "-Wunused-parameter"
44 #pragma GCC diagnostic ignored "-Wunused-but-set-variable"
48 #include "sldns/sbuffer.h"
50 #undef _POSIX_C_SOURCE
54 #include "pythonmod/pythonmod.h"
55 #include "util/module.h"
56 #include "util/config_file.h"
57 #include "pythonmod_utils.h"
60 typedef struct PyObject PyObject;
61 typedef struct PyThreadState PyThreadState;
62 typedef void* PyGILState_STATE;
66 * Global state for the module.
68 struct pythonmod_env {
70 /** Python script filename. */
73 /** Python main thread */
74 PyThreadState* mainthr;
78 /** Module init function */
80 /** Module deinit function */
81 PyObject* func_deinit;
82 /** Module operate function */
83 PyObject* func_operate;
84 /** Module super_inform function */
85 PyObject* func_inform;
87 /** Python dictionary. */
94 struct module_qstate* qstate;
98 * Per query state for the iterator module.
100 struct pythonmod_qstate {
102 /** Module per query data. */
108 #include "pythonmod/interface.h"
111 int pythonmod_init(struct module_env* env, int id)
113 /* Initialize module */
114 FILE* script_py = NULL;
115 PyObject* py_cfg, *res;
116 PyGILState_STATE gil;
117 struct pythonmod_env* pe = (struct pythonmod_env*)calloc(1, sizeof(struct pythonmod_env));
120 log_err("pythonmod: malloc failure");
124 env->modinfo[id] = (void*) pe;
126 /* Initialize module */
127 pe->fname = env->cfg->python_script;
128 if(pe->fname==NULL || pe->fname[0]==0) {
129 log_err("pythonmod: no script given.");
133 /* Initialize Python libraries */
134 if (!Py_IsInitialized())
136 #if PY_MAJOR_VERSION >= 3
138 mbstowcs(progname, "unbound", 8);
140 char *progname = "unbound";
142 Py_SetProgramName(progname);
145 PyEval_InitThreads();
147 pe->mainthr = PyEval_SaveThread();
150 gil = PyGILState_Ensure();
152 /* Initialize Python */
153 PyRun_SimpleString("import sys \n");
154 PyRun_SimpleString("sys.path.append('.') \n");
155 if(env->cfg->directory && env->cfg->directory[0]) {
157 snprintf(wdir, sizeof(wdir), "sys.path.append('%s') \n",
158 env->cfg->directory);
159 PyRun_SimpleString(wdir);
161 PyRun_SimpleString("sys.path.append('"RUN_DIR"') \n");
162 PyRun_SimpleString("sys.path.append('"SHARE_DIR"') \n");
163 PyRun_SimpleString("import distutils.sysconfig \n");
164 PyRun_SimpleString("sys.path.append(distutils.sysconfig.get_python_lib(1,0)) \n");
165 if (PyRun_SimpleString("from unboundmodule import *\n") < 0)
167 log_err("pythonmod: cannot initialize core module: unboundmodule.py");
168 PyGILState_Release(gil);
172 /* Check Python file load */
173 if ((script_py = fopen(pe->fname, "r")) == NULL)
175 log_err("pythonmod: can't open file %s for reading", pe->fname);
176 PyGILState_Release(gil);
181 pe->module = PyImport_AddModule("__main__");
182 pe->dict = PyModule_GetDict(pe->module);
185 PyModule_AddObject(pe->module, "mod_env", pe->data);
187 /* TODO: deallocation of pe->... if an error occurs */
189 if (PyRun_SimpleFile(script_py, pe->fname) < 0)
191 log_err("pythonmod: can't parse Python script %s", pe->fname);
192 PyGILState_Release(gil);
198 if ((pe->func_init = PyDict_GetItemString(pe->dict, "init")) == NULL)
200 log_err("pythonmod: function init is missing in %s", pe->fname);
201 PyGILState_Release(gil);
204 if ((pe->func_deinit = PyDict_GetItemString(pe->dict, "deinit")) == NULL)
206 log_err("pythonmod: function deinit is missing in %s", pe->fname);
207 PyGILState_Release(gil);
210 if ((pe->func_operate = PyDict_GetItemString(pe->dict, "operate")) == NULL)
212 log_err("pythonmod: function operate is missing in %s", pe->fname);
213 PyGILState_Release(gil);
216 if ((pe->func_inform = PyDict_GetItemString(pe->dict, "inform_super")) == NULL)
218 log_err("pythonmod: function inform_super is missing in %s", pe->fname);
219 PyGILState_Release(gil);
223 py_cfg = SWIG_NewPointerObj((void*) env->cfg, SWIGTYPE_p_config_file, 0);
224 res = PyObject_CallFunction(pe->func_init, "iO", id, py_cfg);
225 if (PyErr_Occurred())
227 log_err("pythonmod: Exception occurred in function init");
233 PyGILState_Release(gil);
238 void pythonmod_deinit(struct module_env* env, int id)
240 struct pythonmod_env* pe = env->modinfo[id];
244 /* Free Python resources */
245 if(pe->module != NULL)
248 PyGILState_STATE gil = PyGILState_Ensure();
251 res = PyObject_CallFunction(pe->func_deinit, "i", id);
252 if (PyErr_Occurred()) {
253 log_err("pythonmod: Exception occurred in function deinit");
256 /* Free result if any */
258 /* Free shared data if any */
259 Py_XDECREF(pe->data);
260 PyGILState_Release(gil);
262 PyEval_RestoreThread(pe->mainthr);
269 /* Module is deallocated in Python */
270 env->modinfo[id] = NULL;
273 void pythonmod_inform_super(struct module_qstate* qstate, int id, struct module_qstate* super)
275 struct pythonmod_env* pe = (struct pythonmod_env*)qstate->env->modinfo[id];
276 struct pythonmod_qstate* pq = (struct pythonmod_qstate*)qstate->minfo[id];
277 PyObject* py_qstate, *py_sqstate, *res;
278 PyGILState_STATE gil = PyGILState_Ensure();
280 log_query_info(VERB_ALGO, "pythonmod: inform_super, sub is", &qstate->qinfo);
281 log_query_info(VERB_ALGO, "super is", &super->qinfo);
283 py_qstate = SWIG_NewPointerObj((void*) qstate, SWIGTYPE_p_module_qstate, 0);
284 py_sqstate = SWIG_NewPointerObj((void*) super, SWIGTYPE_p_module_qstate, 0);
286 res = PyObject_CallFunction(pe->func_inform, "iOOO", id, py_qstate,
287 py_sqstate, pq->data);
289 if (PyErr_Occurred())
291 log_err("pythonmod: Exception occurred in function inform_super");
293 qstate->ext_state[id] = module_error;
295 else if ((res == NULL) || (!PyObject_IsTrue(res)))
297 log_err("pythonmod: python returned bad code in inform_super");
298 qstate->ext_state[id] = module_error;
302 Py_XDECREF(py_sqstate);
303 Py_XDECREF(py_qstate);
305 PyGILState_Release(gil);
308 void pythonmod_operate(struct module_qstate* qstate, enum module_ev event,
309 int id, struct outbound_entry* ATTR_UNUSED(outbound))
311 struct pythonmod_env* pe = (struct pythonmod_env*)qstate->env->modinfo[id];
312 struct pythonmod_qstate* pq = (struct pythonmod_qstate*)qstate->minfo[id];
313 PyObject* py_qstate, *res;
314 PyGILState_STATE gil = PyGILState_Ensure();
319 pq = qstate->minfo[id] = malloc(sizeof(struct pythonmod_qstate));
321 /* Initialize per query data */
327 py_qstate = SWIG_NewPointerObj((void*) qstate, SWIGTYPE_p_module_qstate, 0);
328 res = PyObject_CallFunction(pe->func_operate, "iiOO", id, (int) event,
329 py_qstate, pq->data);
330 if (PyErr_Occurred())
332 log_err("pythonmod: Exception occurred in function operate, event: %s", strmodulevent(event));
334 qstate->ext_state[id] = module_error;
336 else if ((res == NULL) || (!PyObject_IsTrue(res)))
338 log_err("pythonmod: python returned bad code, event: %s", strmodulevent(event));
339 qstate->ext_state[id] = module_error;
342 Py_XDECREF(py_qstate);
344 PyGILState_Release(gil);
347 void pythonmod_clear(struct module_qstate* qstate, int id)
349 struct pythonmod_qstate* pq;
353 pq = (struct pythonmod_qstate*)qstate->minfo[id];
354 verbose(VERB_ALGO, "pythonmod: clear, id: %d, pq:%lX", id,
355 (unsigned long int)pq);
358 PyGILState_STATE gil = PyGILState_Ensure();
360 PyGILState_Release(gil);
365 qstate->minfo[id] = NULL;
368 size_t pythonmod_get_mem(struct module_env* env, int id)
370 struct pythonmod_env* pe = (struct pythonmod_env*)env->modinfo[id];
371 verbose(VERB_ALGO, "pythonmod: get_mem, id: %d, pe:%lX", id,
372 (unsigned long int)pe);
379 * The module function block
381 static struct module_func_block pythonmod_block = {
383 &pythonmod_init, &pythonmod_deinit, &pythonmod_operate, &pythonmod_inform_super,
384 &pythonmod_clear, &pythonmod_get_mem
387 struct module_func_block* pythonmod_get_funcblock(void)
389 return &pythonmod_block;