2017-02-12 14:35:05 -03:00
|
|
|
/** Loadable / plugin support.
|
|
|
|
*
|
|
|
|
* @file
|
|
|
|
* @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
|
|
|
|
* @copyright 2017, Institute for Automation of Complex Power Systems, EONERC
|
2017-04-27 12:56:43 +02:00
|
|
|
* @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.
|
2017-05-05 19:24:16 +00:00
|
|
|
*
|
2017-04-27 12:56:43 +02:00
|
|
|
* 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.
|
2017-05-05 19:24:16 +00:00
|
|
|
*
|
2017-04-27 12:56:43 +02:00
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2017-02-12 14:35:05 -03:00
|
|
|
*********************************************************************************/
|
|
|
|
|
2017-02-16 09:04:12 -03:00
|
|
|
#pragma once
|
2017-02-12 14:35:05 -03:00
|
|
|
|
2017-03-11 23:50:30 -03:00
|
|
|
#include "common.h"
|
|
|
|
#include "utils.h"
|
2018-05-13 13:51:28 +02:00
|
|
|
#include "api.h"
|
2017-02-18 10:51:43 -05:00
|
|
|
#include "nodes/cbuilder.h"
|
2018-05-13 13:51:28 +02:00
|
|
|
#include "hook_type.h"
|
|
|
|
#include "node_type.h"
|
|
|
|
#include "format_type.h"
|
2017-02-18 10:51:43 -05:00
|
|
|
|
2018-06-28 13:42:50 +02:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C"{
|
|
|
|
#endif
|
|
|
|
|
2018-07-02 10:51:01 +02:00
|
|
|
/** (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
|
|
|
|
*/
|
2017-02-12 14:35:05 -03:00
|
|
|
#define REGISTER_PLUGIN(p) \
|
2017-07-02 23:53:48 +02:00
|
|
|
__attribute__((constructor(110))) static void UNIQUE(__ctor)() {\
|
2017-07-24 19:21:57 +02:00
|
|
|
if (plugins.state == STATE_DESTROYED) \
|
|
|
|
list_init(&plugins); \
|
2017-02-12 14:35:05 -03:00
|
|
|
list_push(&plugins, p); \
|
|
|
|
} \
|
2017-07-02 23:53:48 +02:00
|
|
|
__attribute__((destructor(110))) static void UNIQUE(__dtor)() { \
|
2017-07-25 12:00:35 +02:00
|
|
|
if (plugins.state != STATE_DESTROYED) \
|
|
|
|
list_remove(&plugins, p); \
|
2017-02-12 14:35:05 -03:00
|
|
|
}
|
|
|
|
|
|
|
|
extern struct list plugins;
|
|
|
|
|
2017-03-03 20:21:33 -04:00
|
|
|
enum plugin_type {
|
2017-02-12 14:35:05 -03:00
|
|
|
PLUGIN_TYPE_HOOK,
|
|
|
|
PLUGIN_TYPE_NODE,
|
|
|
|
PLUGIN_TYPE_API,
|
2018-05-12 13:56:12 +02:00
|
|
|
PLUGIN_TYPE_FORMAT,
|
2017-02-12 14:35:05 -03:00
|
|
|
PLUGIN_TYPE_MODEL_CBUILDER
|
|
|
|
};
|
|
|
|
|
|
|
|
struct plugin {
|
2017-10-18 17:15:56 +02:00
|
|
|
const char *name;
|
|
|
|
const char *description;
|
2017-02-12 14:35:05 -03:00
|
|
|
void *handle;
|
2017-03-03 20:21:33 -04:00
|
|
|
char *path;
|
2017-05-05 19:24:16 +00:00
|
|
|
|
2017-03-03 20:21:33 -04:00
|
|
|
enum plugin_type type;
|
2017-03-11 23:50:30 -03:00
|
|
|
enum state state;
|
2017-05-05 19:24:16 +00:00
|
|
|
|
2017-02-12 14:35:05 -03:00
|
|
|
int (*load)(struct plugin *p);
|
|
|
|
int (*unload)(struct plugin *p);
|
2017-05-05 19:24:16 +00:00
|
|
|
|
2017-02-12 14:35:05 -03:00
|
|
|
union {
|
2018-05-13 13:51:28 +02:00
|
|
|
struct format_type format;
|
2017-02-18 10:51:43 -05:00
|
|
|
struct node_type node;
|
2017-03-17 01:08:48 -03:00
|
|
|
struct hook_type hook;
|
2018-05-13 13:51:28 +02:00
|
|
|
struct api_action api;
|
2017-02-18 10:51:43 -05:00
|
|
|
struct cbuilder_model cb;
|
2017-02-12 14:35:05 -03:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
2017-03-07 07:12:24 -04:00
|
|
|
/** Return a pointer to the plugin structure */
|
|
|
|
#define plugin(vt) ((struct plugin *) ((char *) (vt) - offsetof(struct plugin, api)))
|
|
|
|
|
|
|
|
#define plugin_name(vt) plugin(vt)->name
|
|
|
|
#define plugin_description(vt) plugin(vt)->description
|
|
|
|
|
2017-03-13 23:51:38 -03:00
|
|
|
int plugin_init(struct plugin *p);
|
2017-02-12 14:35:05 -03:00
|
|
|
|
2017-02-18 10:51:43 -05:00
|
|
|
int plugin_destroy(struct plugin *p);
|
|
|
|
|
2017-08-03 00:19:27 +02:00
|
|
|
int plugin_parse(struct plugin *p, json_t *cfg);
|
2017-02-18 10:51:43 -05:00
|
|
|
|
2017-02-12 14:35:05 -03:00
|
|
|
int plugin_load(struct plugin *p);
|
|
|
|
|
|
|
|
int plugin_unload(struct plugin *p);
|
|
|
|
|
2017-03-03 20:21:33 -04:00
|
|
|
void plugin_dump(enum plugin_type type);
|
|
|
|
|
2017-02-18 10:51:43 -05:00
|
|
|
/** Find registered and loaded plugin with given name and type. */
|
2017-07-24 19:33:35 +02:00
|
|
|
struct plugin * plugin_lookup(enum plugin_type type, const char *name);
|
2018-06-28 13:42:50 +02:00
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
2018-07-02 10:51:01 +02:00
|
|
|
#endif
|