X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-plugin.h;h=6f5cd08c67c3b30486c79494a81659c6e9e87868;hb=be4e0e2d3855ccbd3b683bfe6cc4c7f9d3254314;hp=d3f6423d8c23e9331e88123f107e6cc09b0aae81;hpb=65bc678960567038ca4d07d1f9c5784b6c7a7834;p=src%2Fapp-framework-binder.git diff --git a/include/afb/afb-plugin.h b/include/afb/afb-plugin.h index d3f6423d..6f5cd08c 100644 --- a/include/afb/afb-plugin.h +++ b/include/afb/afb-plugin.h @@ -17,8 +17,29 @@ #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 /* * Definition of the versions of the plugin. @@ -40,7 +61,33 @@ enum AFB_session_v1 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_MASK = 15 /* convenient mask used internally, bit-or of the previous masks */ + + 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 */ }; /* @@ -93,15 +140,16 @@ struct sd_bus; * Definition of the facilities provided by the daemon. */ struct afb_daemon_itf { - struct afb_evmgr (*get_evmgr)(void *closure); /* get the event manager */ + 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_evmgr, afb_daemon_get_event_loop, afb_daemon_get_user_bus, afb_daemon_get_system_bus + * 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; /* the interfacing functions */ @@ -119,7 +167,7 @@ struct AFB_interface }; /* - * The function for registering the plugin to AFB + * Function for registering the plugin */ extern const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *interface); @@ -127,9 +175,9 @@ extern const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface * Retrieves the event sender of AFB * 'daemon' MUST be the daemon given in interface when activating the plugin. */ -static inline struct afb_evmgr afb_daemon_get_evmgr(struct afb_daemon daemon) +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); } /* @@ -159,4 +207,24 @@ 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