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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
// vim: ts=8 sw=2 smarttab
/*
* Ceph - scalable distributed file system
*
* Copyright (C) 2016 John Spray <john.spray@redhat.com>
*
* This is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software
* Foundation. See file COPYING.
*/
#include "PyFormatter.h"
#include "common/debug.h"
#include "MgrPyModule.h"
#define dout_subsys ceph_subsys_mgr
#undef dout_prefix
#define dout_prefix *_dout << "mgr " << __func__ << " "
MgrPyModule::MgrPyModule(const std::string &module_name_)
: module_name(module_name_), pModule(nullptr), pClass(nullptr),
pClassInstance(nullptr)
{}
MgrPyModule::~MgrPyModule()
{
Py_XDECREF(pModule);
Py_XDECREF(pClass);
Py_XDECREF(pClassInstance);
}
int MgrPyModule::load()
{
// Load the module
PyObject *pName = PyString_FromString(module_name.c_str());
pModule = PyImport_Import(pName);
Py_DECREF(pName);
if (pModule == nullptr) {
derr << "Module not found: '" << module_name << "'" << dendl;
return -ENOENT;
}
// Find the class
// TODO: let them call it what they want instead of just 'Module'
pClass = PyObject_GetAttrString(pModule, (const char*)"Module");
if (pClass == nullptr) {
derr << "Class not found in module '" << module_name << "'" << dendl;
return -EINVAL;
}
// Just using the module name as the handle, replace with a
// uuidish thing if needed
auto pyHandle = PyString_FromString(module_name.c_str());
auto pArgs = PyTuple_Pack(1, pyHandle);
pClassInstance = PyObject_CallObject(pClass, pArgs);
if (pClassInstance == nullptr) {
derr << "Failed to construct class in '" << module_name << "'" << dendl;
return -EINVAL;
} else {
dout(1) << "Constructed class from module: " << module_name << dendl;
}
Py_DECREF(pArgs);
return load_commands();
}
int MgrPyModule::serve()
{
assert(pClassInstance != nullptr);
PyGILState_STATE gstate;
gstate = PyGILState_Ensure();
auto pValue = PyObject_CallMethod(pClassInstance,
(const char*)"serve", (const char*)"()");
if (pValue != NULL) {
Py_DECREF(pValue);
} else {
PyErr_Print();
return -EINVAL;
}
PyGILState_Release(gstate);
return 0;
}
// FIXME: DRY wrt serve
void MgrPyModule::shutdown()
{
assert(pClassInstance != nullptr);
PyGILState_STATE gstate;
gstate = PyGILState_Ensure();
auto pValue = PyObject_CallMethod(pClassInstance,
(const char*)"shutdown", (const char*)"()");
if (pValue != NULL) {
Py_DECREF(pValue);
} else {
PyErr_Print();
derr << "Failed to invoke shutdown() on " << module_name << dendl;
}
PyGILState_Release(gstate);
}
void MgrPyModule::notify(const std::string ¬ify_type, const std::string ¬ify_id)
{
assert(pClassInstance != nullptr);
PyGILState_STATE gstate;
gstate = PyGILState_Ensure();
// Execute
auto pValue = PyObject_CallMethod(pClassInstance, (const char*)"notify", "(ss)",
notify_type.c_str(), notify_id.c_str());
if (pValue != NULL) {
Py_DECREF(pValue);
} else {
PyErr_Print();
// FIXME: callers can't be expected to handle a python module
// that has spontaneously broken, but Mgr() should provide
// a hook to unload misbehaving modules when they have an
// error somewhere like this
}
PyGILState_Release(gstate);
}
int MgrPyModule::load_commands()
{
PyGILState_STATE gstate;
gstate = PyGILState_Ensure();
PyObject *command_list = PyObject_GetAttrString(pClassInstance, "COMMANDS");
assert(command_list != nullptr);
const size_t list_size = PyList_Size(command_list);
for (size_t i = 0; i < list_size; ++i) {
PyObject *command = PyList_GetItem(command_list, i);
assert(command != nullptr);
ModuleCommand item;
PyObject *pCmd = PyDict_GetItemString(command, "cmd");
assert(pCmd != nullptr);
item.cmdstring = PyString_AsString(pCmd);
dout(20) << "loaded command " << item.cmdstring << dendl;
PyObject *pDesc = PyDict_GetItemString(command, "desc");
assert(pDesc != nullptr);
item.helpstring = PyString_AsString(pDesc);
PyObject *pPerm = PyDict_GetItemString(command, "perm");
assert(pPerm != nullptr);
item.perm = PyString_AsString(pPerm);
item.handler = this;
commands.push_back(item);
}
Py_DECREF(command_list);
PyGILState_Release(gstate);
dout(10) << "loaded " << commands.size() << " commands" << dendl;
return 0;
}
int MgrPyModule::handle_command(
const cmdmap_t &cmdmap,
std::stringstream *ss,
std::stringstream *ds)
{
assert(ss != nullptr);
assert(ds != nullptr);
PyGILState_STATE gstate;
gstate = PyGILState_Ensure();
PyFormatter f;
cmdmap_dump(cmdmap, &f);
PyObject *py_cmd = f.get();
auto pResult = PyObject_CallMethod(pClassInstance,
(const char*)"handle_command", (const char*)"(O)", py_cmd);
Py_DECREF(py_cmd);
int r = 0;
if (pResult != NULL) {
if (PyTuple_Size(pResult) != 3) {
r = -EINVAL;
} else {
r = PyInt_AsLong(PyTuple_GetItem(pResult, 0));
*ds << PyString_AsString(PyTuple_GetItem(pResult, 1));
*ss << PyString_AsString(PyTuple_GetItem(pResult, 2));
}
Py_DECREF(pResult);
} else {
PyErr_Print();
r = -EINVAL;
}
PyGILState_Release(gstate);
return r;
}
|
