1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/*
* Copyright (c) 2015 Balabit
* Copyright (c) 2015 Balazs Scheidler <balazs.scheidler@balabit.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* As an additional exemption you are allowed to compile & link against the
* OpenSSL libraries as published by the OpenSSL project. See the file
* COPYING for details.
*
*/
#include "python-main.h"
#include "python-module.h"
#include "python-helpers.h"
#include "cfg.h"
#include "messages.h"
/*
* Some information about how we embed the Python interpreter:
* - instead of using the __main__ module, we use a separate _syslogng_main
* module as we want to replace it every time syslog-ng is reloaded
* - handling of our separate main module is implemented by this module
* - this separate __main__ module requires some magic though (most of it
* is in _py_construct_main_module(), see below.
* - the PyObject reference to the current main module is stored in the
* GlobalConfig instance (using the ModuleConfig mechanism)
* - the current main module is switched during config initialization, e.g.
* during runtime, _syslogng_main module refers to the main module of the current
* config
* - since _syslogng_main is different for each initialized syslog-ng
* configuration, it is not possible to use variables between reloads,
* _except_ by storing them in other, imported modules.
* - it is currently not possible to hook into the init/deinit mechanism in
* the global context (from Python), but it is possible for a DestDriver.
* It is doable also in the global context, but has not yet been done.
*/
static PyObject *
_py_construct_main_module(PythonConfig *pc)
{
PyObject *module;
PyObject *module_dict;
PyObject *modules = PyImport_GetModuleDict();
/* make sure the module registry doesn't contain our module */
if (PyDict_DelItemString(modules, "_syslogng_main") < 0)
PyErr_Clear();
/* create a new module */
module = PyImport_AddModule("_syslogng_main");
if (!module)
{
gchar buf[256];
msg_error("Error creating syslog-ng main module",
evt_tag_str("exception", _py_format_exception_text(buf, sizeof(buf))));
_py_finish_exception_handling();
return NULL;
}
/* make sure __builtins__ is there, it is normally automatically done for
* __main__ and any imported modules */
module_dict = PyModule_GetDict(module);
if (PyDict_GetItemString(module_dict, "__builtins__") == NULL)
{
PyObject *builtins_module = PyImport_ImportModule(PYTHON_BUILTIN_MODULE_NAME);
if (builtins_module == NULL ||
PyDict_SetItemString(module_dict, "__builtins__", builtins_module) < 0)
g_assert_not_reached();
Py_XDECREF(builtins_module);
}
/* there's a circular reference between GlobalConfig -> PythonConfig -> main_module -> main_module.__config__ -> GlobalConfig */
PyDict_SetItemString(module_dict, "__config__", PyCapsule_New(pc, "_syslogng_main.__config__", NULL));
/* return a reference */
Py_INCREF(module);
return module;
}
/* switch the _syslogng_main module to the one in a specific configuration */
void
_py_switch_to_config_main_module(PythonConfig *pc)
{
PyObject *modules = PyImport_GetModuleDict();
if (pc->main_module)
{
Py_INCREF(pc->main_module);
PyDict_SetItemString(modules, "_syslogng_main", pc->main_module);
}
else
{
PyDict_DelItemString(modules, "_syslogng_main");
}
}
/* get the current main module as stored in the current GlobalConfig.
* returns borrowed reference */
PyObject *
_py_get_main_module(PythonConfig *pc)
{
if (!pc->main_module)
pc->main_module = _py_construct_main_module(pc);
return pc->main_module;
}
gboolean
_py_init_main_module_for_config(PythonConfig *pc)
{
PyGILState_STATE gstate;
gboolean result;
gstate = PyGILState_Ensure();
result = _py_get_main_module(pc) != NULL;
PyGILState_Release(gstate);
return result;
}
PythonConfig *
_py_get_config_from_main_module(void)
{
PythonConfig *pc;
pc = (PythonConfig *) PyCapsule_Import("_syslogng_main.__config__", FALSE);
g_assert(pc != NULL);
return pc;
}
|
