mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-30 00:00:11 +01:00
89 lines
2.6 KiB
C
89 lines
2.6 KiB
C
/** Loadable / plugin support.
|
|
*
|
|
* @file
|
|
* @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
|
|
* @copyright 2014-2019, Institute for Automation of Complex Power Systems, EONERC
|
|
* @license GNU General Public License (version 3)
|
|
*
|
|
* VILLASnode
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* any later version.
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*********************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include <villas/common.h>
|
|
#include <villas/utils.h>
|
|
#include <villas/node_type.h>
|
|
#include <villas/format_type.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** (De-)Register a plugin by adding it to the global plugin list.
|
|
*
|
|
* We make use of GCC's / Clang's constructor/destructor function
|
|
* attributes to let the following code be executed by the loader.
|
|
* This works only when we compile libvillas as a shared library!
|
|
*
|
|
* The __attribute__((constructor)) / __attribute__((destructor))
|
|
* is currently only supported by GCC and Clang
|
|
*
|
|
* See: https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#Common-Function-Attributes
|
|
*/
|
|
#define REGISTER_PLUGIN(p) \
|
|
__attribute__((constructor(110))) static void UNIQUE(__ctor)() {\
|
|
if (plugins.state == STATE_DESTROYED) \
|
|
vlist_init(&plugins); \
|
|
vlist_push(&plugins, p); \
|
|
} \
|
|
__attribute__((destructor(110))) static void UNIQUE(__dtor)() { \
|
|
if (plugins.state != STATE_DESTROYED) \
|
|
vlist_remove_all(&plugins, p); \
|
|
}
|
|
|
|
extern struct vlist plugins;
|
|
|
|
enum plugin_type {
|
|
PLUGIN_TYPE_NODE,
|
|
PLUGIN_TYPE_FORMAT,
|
|
};
|
|
|
|
struct plugin {
|
|
const char *name;
|
|
const char *description;
|
|
|
|
enum plugin_type type;
|
|
|
|
union {
|
|
struct format_type format;
|
|
struct node_type node;
|
|
};
|
|
};
|
|
|
|
/** Return a pointer to the plugin structure */
|
|
#define plugin(vt) ((struct plugin *) ((char *) (vt) - offsetof(struct plugin, format)))
|
|
|
|
#define plugin_name(vt) plugin(vt)->name
|
|
#define plugin_description(vt) plugin(vt)->description
|
|
|
|
void plugin_dump(enum plugin_type type);
|
|
|
|
/** Find registered and loaded plugin with given name and type. */
|
|
struct plugin * plugin_lookup(enum plugin_type type, const char *name);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|