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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
|
/*
* INTEL CONFIDENTIAL
* Copyright © 2011 Intel
* Corporation All Rights Reserved.
*
* The source code contained or described herein and all documents related to
* the source code ("Material") are owned by Intel Corporation or its suppliers
* or licensors. Title to the Material remains with Intel Corporation or its
* suppliers and licensors. The Material contains trade secrets and proprietary
* and confidential information of Intel or its suppliers and licensors. The
* Material is protected by worldwide copyright and trade secret laws and
* treaty provisions. No part of the Material may be used, copied, reproduced,
* modified, published, uploaded, posted, transmitted, distributed, or
* disclosed in any way without Intel’s prior express written permission.
*
* No license under any patent, copyright, trade secret or other intellectual
* property right is granted to or conferred upon you by disclosure or delivery
* of the Materials, either expressly, by implication, inducement, estoppel or
* otherwise. Any license under such intellectual property rights must be
* express and approved by Intel in writing.
*
* CREATED: 2011-06-01
* UPDATED: 2011-07-27
*/
#include <dlfcn.h>
#include <dirent.h>
#include <algorithm>
#include <ctype.h>
#include "SystemClass.h"
#include "SubsystemLibrary.h"
#include "AutoLog.h"
#include "VirtualSubsystem.h"
#include "NamedElementBuilderTemplate.h"
#include <assert.h>
#include "PluginLocation.h"
#include "Utility.h"
#define base CConfigurableElement
/**
* A plugin file name is of the form:
* lib<type>-subsystem.so or lib<type>-subsystem._host.so
*
* The plugin symbol is of the form:
* get<TYPE>SubsystemBuilder
*/
// Plugin file naming
const char* gpcPluginSuffix = "-subsystem";
const char* gpcPluginPrefix = "lib";
// Plugin symbol naming
const char* gpcPluginSymbolPrefix = "get";
const char* gpcPluginSymbolSuffix = "SubsystemBuilder";
// Used by subsystem plugins
typedef void (*GetSubsystemBuilder)(CSubsystemLibrary*);
CSystemClass::CSystemClass() : _pSubsystemLibrary(new CSubsystemLibrary)
{
}
CSystemClass::~CSystemClass()
{
delete _pSubsystemLibrary;
// Close all previously opened libraries
while (!_subsystemLibraries.empty())
{
dlclose(_subsystemLibraries.back());
_subsystemLibraries.pop_back();
}
}
bool CSystemClass::childrenAreDynamic() const
{
return true;
}
string CSystemClass::getKind() const
{
return "SystemClass";
}
bool CSystemClass::loadSubsystems(string& strError,
const CSubsystemPlugins* pSubsystemPlugins,
bool bVirtualSubsystemFallback)
{
CAutoLog autoLog_info(this, "Loading subsystem plugins");
// Start clean
_pSubsystemLibrary->clean();
// Add virtual subsystem builder
_pSubsystemLibrary->addElementBuilder("Virtual",
new TNamedElementBuilderTemplate<CVirtualSubsystem>());
// Set virtual subsytem as builder fallback if required
_pSubsystemLibrary->enableDefaultMechanism(bVirtualSubsystemFallback);
// Add subsystem defined in shared libraries
list<string> lstrError;
bool bLoadPluginsSuccess = loadSubsystemsFromSharedLibraries(lstrError, pSubsystemPlugins);
if (bLoadPluginsSuccess) {
log_info("All subsystem plugins successfully loaded");
} else {
// Log plugin as warning if no fallback available
log_table(!bVirtualSubsystemFallback, lstrError);
}
if (!bVirtualSubsystemFallback) {
// Any problem reported is an error as there is no fallback.
// Fill strError for caller.
CUtility::asString(lstrError, strError);
}
return bLoadPluginsSuccess || bVirtualSubsystemFallback;
}
bool CSystemClass::loadSubsystemsFromSharedLibraries(list<string>& lstrError,
const CSubsystemPlugins* pSubsystemPlugins)
{
// Plugin list
list<string> lstrPluginFiles;
uint32_t uiPluginLocation;
for (uiPluginLocation = 0; uiPluginLocation < pSubsystemPlugins->getNbChildren(); uiPluginLocation++) {
// Get Folder for current Plugin Location
const CPluginLocation* pPluginLocation = static_cast<const CPluginLocation*>(pSubsystemPlugins->getChild(uiPluginLocation));
const string& strFolder = pPluginLocation->getFolder();
// Iterator on Plugin List:
list<string>::const_iterator it;
const list<string>& pluginList = pPluginLocation->getPluginList();
for (it = pluginList.begin(); it != pluginList.end(); ++it) {
// Fill Plugin files list
lstrPluginFiles.push_back(strFolder + "/" + *it);
}
}
// Actually load plugins
while (!lstrPluginFiles.empty()) {
// Because plugins might depend on one another, loading will be done
// as an iteration process that finishes successfully when the remaining
// list of plugins to load gets empty or unsuccessfully if the loading
// process failed to load at least one of them
// Attempt to load the complete list
if (!loadPlugins(lstrPluginFiles, lstrError)) {
// Unable to load at least one plugin
break;
}
}
if (!lstrPluginFiles.empty()) {
// Unable to load at least one plugin
string strPluginUnloaded;
CUtility::asString(lstrPluginFiles, strPluginUnloaded, ", ");
lstrError.push_back("Unable to load the following plugins: " + strPluginUnloaded + ".");
return false;
}
return true;
}
// Plugin symbol computation
string CSystemClass::getPluginSymbol(const string& strPluginPath)
{
// Extract plugin type out of file name
string strPluginSuffix = gpcPluginSuffix;
string strPluginPrefix = gpcPluginPrefix;
// Remove folder and library prefix
size_t iPluginTypePos = strPluginPath.rfind('/') + 1 + strPluginPrefix.length();
// Get index of -subsystem.so or -subsystem_host.so suffix
size_t iSubsystemPos = strPluginPath.find(strPluginSuffix, iPluginTypePos);
// Get type (between iPluginTypePos and iSubsystemPos)
string strPluginType = strPluginPath.substr(iPluginTypePos, iSubsystemPos - iPluginTypePos);
// Make it upper case
std::transform(strPluginType.begin(), strPluginType.end(), strPluginType.begin(), ::toupper);
// Get plugin symbol
return gpcPluginSymbolPrefix + strPluginType + gpcPluginSymbolSuffix;
}
// Plugin loading
bool CSystemClass::loadPlugins(list<string>& lstrPluginFiles, list<string>& lstrError)
{
assert(lstrPluginFiles.size());
bool bAtLeastOneSubsystemPluginSuccessfullyLoaded = false;
list<string>::iterator it = lstrPluginFiles.begin();
while (it != lstrPluginFiles.end()) {
string strPluginFileName = *it;
log_info("Attempting to load subsystem plugin path \"%s\"", strPluginFileName.c_str());
// Load attempt
void* lib_handle = dlopen(strPluginFileName.c_str(), RTLD_LAZY);
if (!lib_handle) {
// Failed
lstrError.push_back("Plugin load failed: " + string(dlerror()));
// Next plugin
++it;
continue;
}
// Store libraries handles
_subsystemLibraries.push_back(lib_handle);
// Get plugin symbol
string strPluginSymbol = getPluginSymbol(strPluginFileName);
// Load symbol from library
GetSubsystemBuilder pfnGetSubsystemBuilder = (GetSubsystemBuilder)dlsym(lib_handle, strPluginSymbol.c_str());
if (!pfnGetSubsystemBuilder) {
lstrError.push_back("Subsystem plugin " + strPluginFileName +
" does not contain " + strPluginSymbol + " symbol.");
continue;
}
// Account for this success
bAtLeastOneSubsystemPluginSuccessfullyLoaded = true;
// Fill library
pfnGetSubsystemBuilder(_pSubsystemLibrary);
// Remove successfully loaded plugin from list and select next
lstrPluginFiles.erase(it++);
}
return bAtLeastOneSubsystemPluginSuccessfullyLoaded;
}
const CSubsystemLibrary* CSystemClass::getSubsystemLibrary() const
{
return _pSubsystemLibrary;
}
void CSystemClass::checkForSubsystemsToResync(CSyncerSet& syncerSet)
{
uint32_t uiNbChildren = getNbChildren();
uint32_t uiChild;
for (uiChild = 0; uiChild < uiNbChildren; uiChild++) {
CSubsystem* pSubsystem = static_cast<CSubsystem*>(getChild(uiChild));
// Collect and consume the need for a resync
if (pSubsystem->needResync(true)) {
log_info("Resynchronizing subsystem: %s", pSubsystem->getName().c_str());
// get all subsystem syncers
pSubsystem->fillSyncerSet(syncerSet);
}
}
}
void CSystemClass::cleanSubsystemsNeedToResync()
{
uint32_t uiNbChildren = getNbChildren();
uint32_t uiChild;
for (uiChild = 0; uiChild < uiNbChildren; uiChild++) {
CSubsystem* pSubsystem = static_cast<CSubsystem*>(getChild(uiChild));
// Consume the need for a resync
pSubsystem->needResync(true);
}
}
bool CSystemClass::init(string& strError)
{
return base::init(strError);
}
// From IXmlSource
void CSystemClass::toXml(CXmlElement& xmlElement, CXmlSerializingContext& serializingContext) const
{
// Set the name of system class
xmlElement.setNameAttribute(getName());
base::toXml(xmlElement, serializingContext);
}
|