PIPluginLoader patch for several plugins

This commit is contained in:
2020-10-18 19:50:07 +03:00
parent 6d7da02de6
commit 5078269d0f
2 changed files with 149 additions and 63 deletions

View File

@@ -162,37 +162,70 @@
PIPluginInfo::PIPluginInfo() { PIPluginInfo::PIPluginInfo() {
in_plugin = false;
} }
void PIPluginInfo::setUserVersion(const PIString & v) { void PIPluginInfo::setUserVersion(const PIString & v) {
user_version[in_plugin ? 1 : 0] = v; user_version = v;
} }
void PIPluginInfo::setStaticSection(int type, void * ptr) { void PIPluginInfo::setStaticSection(int type, void * ptr) {
static_sections[in_plugin ? 1 : 0][type] = ptr; static_sections[type] = ptr;
} }
PIString PIPluginInfo::userVersion(bool plugin) const { PIString PIPluginInfo::userVersion() const {
return user_version[plugin ? 1 : 0]; return user_version;
} }
PIMap<int, void *> PIPluginInfo::staticSections(bool plugin) const { PIMap<int, void *> PIPluginInfo::staticSections() const {
return static_sections[plugin ? 1 : 0]; return static_sections;
} }
void PIPluginInfo::enterPlugin() {
in_plugin = true;
PIPluginInfoStorage::PIPluginInfoStorage() {
enterPlugin(0);
} }
PIPluginInfo * PIPluginInfo::instance() { PIPluginInfo * PIPluginInfoStorage::currentInfo() {
static PIPluginInfo ret; return info[current];
}
PIPluginInfo * PIPluginInfoStorage::pluginInfo(void * p) {
return info.value(p, nullptr);
}
PIPluginInfo * PIPluginInfoStorage::applicationInfo() {
return info[0];
}
PIPluginInfo * PIPluginInfoStorage::enterPlugin(void * p) {
current = p;
PIPluginInfo *& i(info[p]);
if (!i) i = new PIPluginInfo();
return i;
}
void PIPluginInfoStorage::unloadPlugin(void * p) {
if (current == p) current = 0;
PIPluginInfo *& i(info[p]);
if (!i) delete i;
info.remove(p);
}
PIPluginInfoStorage * PIPluginInfoStorage::instance() {
static PIPluginInfoStorage ret;
return &ret; return &ret;
} }
@@ -201,61 +234,61 @@ PIPluginInfo * PIPluginInfo::instance() {
PIPluginLoader::PIPluginLoader(const PIString & name) { PIPluginLoader::PIPluginLoader(const PIString & name) {
func_loader_version = nullptr; func_loader_version = nullptr;
func_plugin_info = nullptr;
func_static_merge = nullptr; func_static_merge = nullptr;
plugin_info = nullptr; error = Unknown;
loaded = false; loaded = false;
messages = true;
if (!name.isEmpty()) if (!name.isEmpty())
load(name); load(name);
} }
PIPluginLoader::~PIPluginLoader() { PIPluginLoader::~PIPluginLoader() {
lib.unload(); unload();
} }
bool PIPluginLoader::load(const PIString & name) { bool PIPluginLoader::load(const PIString & name) {
unload(); unload();
PIPluginInfo * ai = PIPluginInfoStorage::instance()->applicationInfo();
PIPluginInfo * pi = PIPluginInfoStorage::instance()->enterPlugin(this);
if (!lib.load(findLibrary(name))) { if (!lib.load(findLibrary(name))) {
piCout << "Load plugin \"" << name << "\"load failed with error: " << lib.lastError().trimmed(); unload();
error = LibraryLoadError;
error_str = "Load plugin \"" + name + "\" error: can`t load lib: " + lib.lastError();
if (messages) piCout << error_str;
return false; return false;
} }
//piCout << "loading" << lib.path() << "..."; //piCout << "loading" << lib.path() << "...";
func_loader_version = (FunctionLoaderVersion)lib.resolve(STR(__PIP_PLUGIN_LOADER_VERSION_FUNC__)); func_loader_version = (FunctionLoaderVersion)lib.resolve(STR(__PIP_PLUGIN_LOADER_VERSION_FUNC__));
if (!func_loader_version) { if (!func_loader_version) {
piCout << "Load plugin \"" << name << "\" error: can`t find" << STR(__PIP_PLUGIN_LOADER_VERSION_FUNC__);
unload(); unload();
error = MissingSymbols;
error_str = "Load plugin \"" + name + "\" error: can`t find " + STR(__PIP_PLUGIN_LOADER_VERSION_FUNC__);
if (messages) piCout << error_str;
return false; return false;
} }
if (__PIP_PLUGIN_LOADER_VERSION__ != func_loader_version()) { if (__PIP_PLUGIN_LOADER_VERSION__ != func_loader_version()) {
piCout << "Load plugin \"" << name << "\" error: invalid loader version: plugin" << __PIP_PLUGIN_LOADER_VERSION__ << "!=" << func_loader_version();
unload(); unload();
error = InvalidLoaderVersion;
error_str = "Load plugin \"" + name + "\" error: invalid loader version: application = " + PIString::fromNumber(func_loader_version())
+ ", plugin = " + PIString::fromNumber(__PIP_PLUGIN_LOADER_VERSION__);
if (messages) piCout << error_str;
return false; return false;
} }
func_plugin_info = (FunctionPluginInfo)lib.resolve(STR(__PIP_PLUGIN_PLUGIN_INFO_FUNC__)); if (ai->userVersion().size_s() > 1) {
if (!func_plugin_info) { PIString pversion = pi->userVersion(), lversion = ai->userVersion();
piCout << "Load plugin \"" << name << "\" error: can`t find" << STR(__PIP_PLUGIN_PLUGIN_INFO_FUNC__);
unload();
return false;
}
plugin_info = func_plugin_info();
if (!plugin_info) {
piCout << "Load plugin \"" << name << "\" error: null PIPluginInfo";
unload();
return false;
}
if (PIPluginInfo::instance()->userVersion(false).size_s() > 1) {
PIString pversion = plugin_info->userVersion(true), lversion = PIPluginInfo::instance()->userVersion(false);
if (pversion != lversion) { if (pversion != lversion) {
piCout << "Load plugin \"" << name << "\" error: invalid user version: plugin" << pversion << "!=" << lversion;
unload(); unload();
error = InvalidUserVersion;
error_str = "Load plugin \"" + name + "\" error: invalid user version: application = " + lversion + ", plugin = " + pversion;
if (messages) piCout << error_str;
return false; return false;
} }
} }
func_static_merge = (FunctionStaticMerge)lib.resolve(STR(__PIP_PLUGIN_STATIC_MERGE_FUNC__)); func_static_merge = (FunctionStaticMerge)lib.resolve(STR(__PIP_PLUGIN_STATIC_MERGE_FUNC__));
if (func_static_merge) { if (func_static_merge) {
auto pss = plugin_info->staticSections(true), lss = PIPluginInfo::instance()->staticSections(false); auto pss = pi->staticSections(), lss = ai->staticSections();
//piCout << lss.keys() << pss.keys(); //piCout << lss.keys() << pss.keys();
auto it = lss.makeIterator(); auto it = lss.makeIterator();
while (it.next()) { while (it.next()) {
@@ -267,14 +300,17 @@ bool PIPluginLoader::load(const PIString & name) {
} }
} }
loaded = true; loaded = true;
error = NoError;
return true; return true;
} }
void PIPluginLoader::unload() { void PIPluginLoader::unload() {
lib.unload(); lib.unload();
plugin_info = nullptr;
loaded = false; loaded = false;
error_str.clear();
error = Unknown;
PIPluginInfoStorage::instance()->unloadPlugin(this);
} }
@@ -283,13 +319,28 @@ bool PIPluginLoader::isLoaded() const {
} }
PIString PIPluginLoader::libPath() { PIPluginLoader::Error PIPluginLoader::lastError() const {
return lib.path(); return error;
} }
PIString PIPluginLoader::lastError() { PIString PIPluginLoader::lastErrorText() const {
return lib.lastError(); return error_str;
}
void PIPluginLoader::setMessages(bool yes) {
messages = yes;
}
bool PIPluginLoader::isMessages() const {
return messages;
}
PIString PIPluginLoader::libPath() {
return lib.path();
} }
@@ -300,8 +351,10 @@ void * PIPluginLoader::resolve(const char * name) {
void PIPluginLoader::mergeStatic() { void PIPluginLoader::mergeStatic() {
if (!loaded || !func_static_merge || !plugin_info) return; if (!loaded || !func_static_merge) return;
auto pss = plugin_info->staticSections(true), lss = PIPluginInfo::instance()->staticSections(false); PIPluginInfo * ai = PIPluginInfoStorage::instance()->applicationInfo();
PIPluginInfo * pi = PIPluginInfoStorage::instance()->pluginInfo(this);
auto pss = pi->staticSections(), lss = ai->staticSections();
auto it = lss.makeIterator(); auto it = lss.makeIterator();
while (it.next()) { while (it.next()) {
if (!pss.contains(it.key())) if (!pss.contains(it.key()))

View File

@@ -68,27 +68,24 @@
#endif #endif
#define __PIP_PLUGIN_LOADER_VERSION_FUNC__ pip_loader_version #define __PIP_PLUGIN_LOADER_VERSION_FUNC__ pip_loader_version
#define __PIP_PLUGIN_PLUGIN_INFO_FUNC__ pip_plugin_info
#define __PIP_PLUGIN_STATIC_MERGE_FUNC__ pip_merge_static #define __PIP_PLUGIN_STATIC_MERGE_FUNC__ pip_merge_static
#define __PIP_PLUGIN_LOADER_VERSION__ 1 #define __PIP_PLUGIN_LOADER_VERSION__ 2
#define PIP_PLUGIN_SET_USER_VERSION(v) \ #define PIP_PLUGIN_SET_USER_VERSION(v) \
STATIC_INITIALIZER_BEGIN \ STATIC_INITIALIZER_BEGIN \
PIPluginInfo::instance()->setUserVersion(v); \ PIPluginInfo * pi = PIPluginInfoStorage::instance()->currentInfo(); \
if (pi) pi->setUserVersion(v); \
STATIC_INITIALIZER_END STATIC_INITIALIZER_END
#define PIP_PLUGIN_ADD_STATIC_SECTION(type, ptr) \ #define PIP_PLUGIN_ADD_STATIC_SECTION(type, ptr) \
STATIC_INITIALIZER_BEGIN \ STATIC_INITIALIZER_BEGIN \
PIPluginInfo::instance()->setStaticSection(type, ptr); \ PIPluginInfo * pi = PIPluginInfoStorage::instance()->currentInfo(); \
if (pi) pi->setStaticSection(type, ptr); \
STATIC_INITIALIZER_END STATIC_INITIALIZER_END
#define PIP_PLUGIN \ #define PIP_PLUGIN \
STATIC_INITIALIZER_BEGIN \
PIPluginInfo::instance()->enterPlugin(); \
STATIC_INITIALIZER_END \
extern "C" { \ extern "C" { \
PIP_PLUGIN_EXPORT int __PIP_PLUGIN_LOADER_VERSION_FUNC__() {return __PIP_PLUGIN_LOADER_VERSION__;} \ PIP_PLUGIN_EXPORT int __PIP_PLUGIN_LOADER_VERSION_FUNC__() {return __PIP_PLUGIN_LOADER_VERSION__;} \
PIP_PLUGIN_EXPORT PIPluginInfo * __PIP_PLUGIN_PLUGIN_INFO_FUNC__() {return PIPluginInfo::instance();} \
} }
#define PIP_PLUGIN_STATIC_SECTION_MERGE \ #define PIP_PLUGIN_STATIC_SECTION_MERGE \
@@ -108,16 +105,34 @@ public:
void setUserVersion(const PIString & v); void setUserVersion(const PIString & v);
void setStaticSection(int type, void * ptr); void setStaticSection(int type, void * ptr);
PIString userVersion(bool plugin) const; PIString userVersion() const;
PIMap<int, void*> staticSections(bool plugin) const; PIMap<int, void*> staticSections() const;
void enterPlugin();
static PIPluginInfo * instance();
private: private:
PIString user_version[2]; PIString user_version;
PIMap<int, void*> static_sections[2]; PIMap<int, void*> static_sections;
bool in_plugin;
};
class PIP_EXPORT PIPluginInfoStorage {
public:
PIPluginInfoStorage();
PIPluginInfo * currentInfo();
PIPluginInfo * pluginInfo(void * p);
PIPluginInfo * applicationInfo();
PIPluginInfo * enterPlugin(void * p);
void unloadPlugin(void * p);
static PIPluginInfoStorage * instance();
private:
NO_COPY_CLASS(PIPluginInfoStorage)
void * current;
PIMap<void*, PIPluginInfo * > info;
}; };
@@ -127,9 +142,18 @@ private:
class PIP_EXPORT PIPluginLoader { class PIP_EXPORT PIPluginLoader {
public: public:
typedef int(*FunctionLoaderVersion)(); typedef int(*FunctionLoaderVersion)();
typedef PIPluginInfo*(*FunctionPluginInfo)();
typedef void(*FunctionStaticMerge)(int, void *, void *); typedef void(*FunctionStaticMerge)(int, void *, void *);
//! Possible load plugin error
enum Error {
Unknown /** No \a load call yet */ ,
NoError /** No error */ ,
LibraryLoadError /** System can`t load library */ ,
MissingSymbols /** Can`t find necessary symbols */ ,
InvalidLoaderVersion /** Integer version mismatch */ ,
InvalidUserVersion /** User version mismatch */ ,
};
//! Contruscts loader with filename "name" //! Contruscts loader with filename "name"
PIPluginLoader(const PIString & name = PIString()); PIPluginLoader(const PIString & name = PIString());
@@ -147,12 +171,21 @@ public:
//! Returns if plugin is successfully loaded //! Returns if plugin is successfully loaded
bool isLoaded() const; bool isLoaded() const;
//! Returns error of last \a load() call
Error lastError() const;
//! Returns error message of last \a load() call
PIString lastErrorText() const;
//! Set if %PIPluginLoader should print load messages, \b true by default
void setMessages(bool yes);
//! Returns if %PIPluginLoader should print load messages, \b true by default
bool isMessages() const;
//! Returns loaded plugin library path //! Returns loaded plugin library path
PIString libPath(); PIString libPath();
//! Returns library lastError
PIString lastError();
//! Resolve symbol "name" from plugin library //! Resolve symbol "name" from plugin library
void * resolve(const char * name); void * resolve(const char * name);
@@ -169,10 +202,10 @@ private:
PILibrary lib; PILibrary lib;
FunctionLoaderVersion func_loader_version; FunctionLoaderVersion func_loader_version;
FunctionPluginInfo func_plugin_info;
FunctionStaticMerge func_static_merge; FunctionStaticMerge func_static_merge;
PIPluginInfo * plugin_info; PIString error_str;
bool loaded; Error error;
bool loaded, messages;
}; };