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
|
// -*- 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) 2017 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.
*/
#pragma once
// First because it includes Python.h
#include "PyModule.h"
#include <string>
#include <map>
#include <set>
#include <memory>
#include "common/LogClient.h"
#include "ActivePyModules.h"
#include "StandbyPyModules.h"
class MgrSession;
/**
* This class is responsible for setting up the python runtime environment
* and importing the python modules.
*
* It is *not* responsible for constructing instances of their BaseMgrModule
* subclasses: that is the job of ActiveMgrModule, which consumes the class
* references that we load here.
*/
class PyModuleRegistry
{
private:
mutable Mutex lock{"PyModuleRegistry::lock"};
LogChannelRef clog;
std::map<std::string, PyModuleRef> modules;
std::unique_ptr<ActivePyModules> active_modules;
std::unique_ptr<StandbyPyModules> standby_modules;
PyThreadState *pMainThreadState;
// We have our own copy of MgrMap, because we are constructed
// before ClusterState exists.
MgrMap mgr_map;
/**
* Discover python modules from local disk
*/
std::set<std::string> probe_modules(const std::string &path) const;
PyModuleConfig module_config;
public:
void handle_config(const std::string &k, const std::string &v);
void handle_config_notify();
/**
* Get references to all modules (whether they have loaded and/or
* errored) or not.
*/
std::list<PyModuleRef> get_modules() const
{
std::lock_guard l(lock);
std::list<PyModuleRef> modules_out;
for (const auto &i : modules) {
modules_out.push_back(i.second);
}
return modules_out;
}
explicit PyModuleRegistry(LogChannelRef clog_)
: clog(clog_)
{}
/**
* @return true if the mgrmap has changed such that the service needs restart
*/
bool handle_mgr_map(const MgrMap &mgr_map_);
void init();
void upgrade_config(
MonClient *monc,
const std::map<std::string, std::string> &old_config);
void active_start(
DaemonStateIndex &ds, ClusterState &cs,
const std::map<std::string, std::string> &kv_store,
MonClient &mc, LogChannelRef clog_, LogChannelRef audit_clog_,
Objecter &objecter_, Client &client_, Finisher &f,
DaemonServer &server);
void standby_start(MonClient &mc, Finisher &f);
bool is_standby_running() const
{
return standby_modules != nullptr;
}
void active_shutdown();
void shutdown();
std::vector<MonCommand> get_commands() const;
std::vector<ModuleCommand> get_py_commands() const;
/**
* Get the specified module. The module does not have to be
* loaded or runnable.
*
* Returns an empty reference if it does not exist.
*/
PyModuleRef get_module(const std::string &module_name)
{
std::lock_guard l(lock);
auto module_iter = modules.find(module_name);
if (module_iter == modules.end()) {
return {};
}
return module_iter->second;
}
/**
* Pass through command to the named module for execution.
*
* The command must exist in the COMMANDS reported by the module. If it
* doesn't then this will abort.
*
* If ActivePyModules has not been instantiated yet then this will
* return EAGAIN.
*/
int handle_command(
const ModuleCommand& module_command,
const MgrSession& session,
const cmdmap_t &cmdmap,
const bufferlist &inbuf,
std::stringstream *ds,
std::stringstream *ss);
/**
* Pass through health checks reported by modules, and report any
* modules that have failed (i.e. unhandled exceptions in serve())
*/
void get_health_checks(health_check_map_t *checks);
void get_progress_events(map<std::string,ProgressEvent> *events) {
if (active_modules) {
active_modules->get_progress_events(events);
}
}
// FIXME: breaking interface so that I don't have to go rewrite all
// the places that call into these (for now)
// >>>
void notify_all(const std::string ¬ify_type,
const std::string ¬ify_id)
{
if (active_modules) {
active_modules->notify_all(notify_type, notify_id);
}
}
void notify_all(const LogEntry &log_entry)
{
if (active_modules) {
active_modules->notify_all(log_entry);
}
}
std::map<std::string, std::string> get_services() const
{
ceph_assert(active_modules);
return active_modules->get_services();
}
// <<< (end of ActivePyModules cheeky call-throughs)
};
|
