/** Loadable / plugin support. * * @file * @author Steffen Vogel * @copyright 2017, 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 . *********************************************************************************/ #pragma once #include "common.h" #include "utils.h" #include "api.h" #include "nodes/cbuilder.h" #include "hook_type.h" #include "node_type.h" #include "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) \ list_init(&plugins); \ list_push(&plugins, p); \ } \ __attribute__((destructor(110))) static void UNIQUE(__dtor)() { \ if (plugins.state != STATE_DESTROYED) \ list_remove(&plugins, p); \ } extern struct list plugins; enum plugin_type { PLUGIN_TYPE_HOOK, PLUGIN_TYPE_NODE, PLUGIN_TYPE_API, PLUGIN_TYPE_FORMAT, PLUGIN_TYPE_MODEL_CBUILDER }; struct plugin { const char *name; const char *description; void *handle; char *path; enum plugin_type type; enum state state; int (*load)(struct plugin *p); int (*unload)(struct plugin *p); union { struct format_type format; struct node_type node; struct hook_type hook; struct api_action api; struct cbuilder_model cb; }; }; /** 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 int plugin_init(struct plugin *p); int plugin_destroy(struct plugin *p); int plugin_parse(struct plugin *p, json_t *cfg); int plugin_load(struct plugin *p); int plugin_unload(struct plugin *p); 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