X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-plugin.h;h=6f5cd08c67c3b30486c79494a81659c6e9e87868;hb=146bb49ca5acf4bbd5d9841398030c29b4333cc6;hp=2cfe6289bab4b712e501938efbda826049cf42b5;hpb=06382af9092babedbf56aa1c00b3bd7cb0b86cda;p=src%2Fapp-framework-binder.git diff --git a/include/afb/afb-plugin.h b/include/afb/afb-plugin.h index 2cfe6289..6f5cd08c 100644 --- a/include/afb/afb-plugin.h +++ b/include/afb/afb-plugin.h @@ -17,95 +17,214 @@ #pragma once +#include + +/***************************************************************************** + * This files is the main file to include for writing plugins dedicated to + * + * AFB-DAEMON + * + * Functions of plugins of afb-daemon are accessible by authorized clients + * through the apis module of afb-daemon. + * + * A plugin is a shared library. This shared library must have at least one + * exported symbol for being registered in afb-daemon. + * For the current version of afb-daemon, the function exported MUST be named + * + * pluginAfbV1Register + */ + +/* + * Some function of the library are exported to afb-daemon. + */ + #include -#include +#include -/* Plugin Type */ -enum AFB_pluginE +/* + * Definition of the versions of the plugin. + * The definition uses hashes. + */ +enum AFB_plugin_version { - AFB_PLUGIN_JSON = 123456789, -/* AFB_PLUGIN_JSCRIPT = 987654321, */ - AFB_PLUGIN_RAW = 987123546 + AFB_PLUGIN_VERSION_1 = 123456789 /* version 1 */ }; -/* Enum for Session/Token/Authentication middleware */ -enum AFB_sessionE +/* + * Enum for Session/Token/Authentication middleware. + * This enumeration is valid for plugins of type 1 + */ +enum AFB_session_v1 { - AFB_SESSION_NONE = 0, - AFB_SESSION_CREATE = 1, - AFB_SESSION_CLOSE = 2, - AFB_SESSION_RENEW = 4, - AFB_SESSION_CHECK = 8, - AFB_SESSION_MASK = 15 + AFB_SESSION_NONE = 0, /* no session and no authentification required */ + AFB_SESSION_CREATE = 1, /* requires authentification and first call of the session */ + AFB_SESSION_CLOSE = 2, /* closes the session after authentification */ + AFB_SESSION_RENEW = 4, /* refreshes the token after authentification */ + AFB_SESSION_CHECK = 8, /* enforce authentification */ + + AFB_SESSION_LOA_GE = 16, /* check that the LOA is greater or equal to the given value */ + AFB_SESSION_LOA_LE = 32, /* check that the LOA is lesser or equal to the given value */ + AFB_SESSION_LOA_EQ = 48, /* check that the LOA is equal to the given value */ + + AFB_SESSION_LOA_SHIFT = 6, /* shift for LOA */ + AFB_SESSION_LOA_MASK = 3, /* mask for LOA */ + + AFB_SESSION_LOA_0 = 0, /* value for LOA of 0 */ + AFB_SESSION_LOA_1 = 64, /* value for LOA of 1 */ + AFB_SESSION_LOA_2 = 128, /* value for LOA of 2 */ + AFB_SESSION_LOA_3 = 192, /* value for LOA of 3 */ + + AFB_SESSION_LOA_LE_0 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_0, /* check LOA <= 0 */ + AFB_SESSION_LOA_LE_1 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_1, /* check LOA <= 1 */ + AFB_SESSION_LOA_LE_2 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_2, /* check LOA <= 2 */ + AFB_SESSION_LOA_LE_3 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_3, /* check LOA <= 3 */ + + AFB_SESSION_LOA_GE_0 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_0, /* check LOA >= 0 */ + AFB_SESSION_LOA_GE_1 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_1, /* check LOA >= 1 */ + AFB_SESSION_LOA_GE_2 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_2, /* check LOA >= 2 */ + AFB_SESSION_LOA_GE_3 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_3, /* check LOA >= 3 */ + + AFB_SESSION_LOA_EQ_0 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_0, /* check LOA == 0 */ + AFB_SESSION_LOA_EQ_1 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_1, /* check LOA == 1 */ + AFB_SESSION_LOA_EQ_2 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_2, /* check LOA == 2 */ + AFB_SESSION_LOA_EQ_3 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_3 /* check LOA == 3 */ }; -/* API definition */ -struct AFB_restapi +/* + * Description of one verb of the API provided by the plugin + * This enumeration is valid for plugins of type 1 + */ +struct AFB_verb_desc_v1 { - const char *name; - enum AFB_sessionE session; - void (*callback)(struct afb_req req); - const char *info; + const char *name; /* name of the verb */ + enum AFB_session_v1 session; /* authorisation and session requirements of the verb */ + void (*callback)(struct afb_req req); /* callback function implementing the verb */ + const char *info; /* textual description of the verb */ }; -/* Plugin definition */ +/* + * Description of the plugins of type 1 + */ +struct AFB_plugin_desc_v1 +{ + const char *info; /* textual information about the plugin */ + const char *prefix; /* required prefix name for the plugin */ + const struct AFB_verb_desc_v1 *verbs; /* array of descriptions of verbs terminated by a NULL name */ +}; + +/* + * Description of a plugin + */ struct AFB_plugin { - enum AFB_pluginE type; - const char *info; - const char *prefix; - const struct AFB_restapi *apis; + enum AFB_plugin_version type; /* type of the plugin */ + union { + struct AFB_plugin_desc_v1 v1; /* description of the plugin of type 1 */ + }; }; -/* config mode */ +/* + * config mode + */ enum AFB_Mode { - AFB_MODE_LOCAL = 0, - AFB_MODE_REMOTE, - AFB_MODE_GLOBAL + AFB_MODE_LOCAL = 0, /* run locally */ + AFB_MODE_REMOTE, /* run remotely */ + AFB_MODE_GLOBAL /* run either remotely or locally (DONT USE! reserved for future) */ }; +/* declaration of features of libsystemd */ struct sd_event; struct sd_bus; +/* + * Definition of the facilities provided by the daemon. + */ struct afb_daemon_itf { - struct afb_evmgr (*get_evmgr)(void *closure); - struct sd_event *(*get_event_loop)(void *closure); - struct sd_bus *(*get_user_bus)(void *closure); - struct sd_bus *(*get_system_bus)(void *closure); + struct afb_event_sender (*get_event_sender)(void *closure); /* get the event manager */ + struct sd_event *(*get_event_loop)(void *closure); /* get the common systemd's event loop */ + struct sd_bus *(*get_user_bus)(void *closure); /* get the common systemd's user d-bus */ + struct sd_bus *(*get_system_bus)(void *closure); /* get the common systemd's system d-bus */ + void (*vverbose)(void*closure, int level, const char *file, int line, const char *fmt, va_list args); }; +/* + * Structure for accessing daemon. + * See also: afb_daemon_get_event_sender, afb_daemon_get_event_loop, afb_daemon_get_user_bus, afb_daemon_get_system_bus + */ struct afb_daemon { - const struct afb_daemon_itf *itf; - void *closure; + const struct afb_daemon_itf *itf; /* the interfacing functions */ + void *closure; /* the closure when calling these functions */ }; +/* + * Interface between the daemon and the plugin. + */ struct AFB_interface { - int verbosity; - enum AFB_Mode mode; - struct afb_daemon daemon; + struct afb_daemon daemon; /* access to the daemon facilies */ + int verbosity; /* level of verbosity */ + enum AFB_Mode mode; /* run mode (local or remote) */ }; -extern const struct AFB_plugin *pluginRegister (const struct AFB_interface *interface); +/* + * Function for registering the plugin + */ +extern const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *interface); -static inline struct afb_evmgr afb_daemon_get_evmgr(struct afb_daemon daemon) +/* + * Retrieves the event sender of AFB + * 'daemon' MUST be the daemon given in interface when activating the plugin. + */ +static inline struct afb_event_sender afb_daemon_get_event_sender(struct afb_daemon daemon) { - return daemon.itf->get_evmgr(daemon.closure); + return daemon.itf->get_event_sender(daemon.closure); } +/* + * Retrieves the common systemd's event loop of AFB + * 'daemon' MUST be the daemon given in interface when activating the plugin. + */ static inline struct sd_event *afb_daemon_get_event_loop(struct afb_daemon daemon) { return daemon.itf->get_event_loop(daemon.closure); } +/* + * Retrieves the common systemd's user/session d-bus of AFB + * 'daemon' MUST be the daemon given in interface when activating the plugin. + */ static inline struct sd_bus *afb_daemon_get_user_bus(struct afb_daemon daemon) { return daemon.itf->get_user_bus(daemon.closure); } +/* + * Retrieves the common systemd's system d-bus of AFB + * 'daemon' MUST be the daemon given in interface when activating the plugin. + */ static inline struct sd_bus *afb_daemon_get_system_bus(struct afb_daemon daemon) { return daemon.itf->get_system_bus(daemon.closure); } +/* + * Send a message described by 'fmt' and following parameters + * to the journal for the verbosity 'level'. + * 'file' and 'line' are indicators of position of the code in source files. + * 'daemon' MUST be the daemon given in interface when activating the plugin. + */ +static inline void afb_daemon_verbose(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...) +{ + va_list args; + va_start(args, fmt); + return daemon.itf->vverbose(daemon.closure, level, file, line, fmt, args); + va_end(args); +} +#if !defined(NO_PLUGIN_VERBOSE_MACRO) +# define ERROR(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define WARNING(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define NOTICE(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define INFO(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define DEBUG(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,__FILE__,__LINE__,__VA_ARGS__);}while(0) +#endif