X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-binding.h;h=ae700f4183a30365c4cbc6d1ad6c5ca12aff7374;hb=8a30491d5e60239a338e485311a29c43398726e9;hp=fe347af5681199e7ce28a97d6bc0eeb33699055a;hpb=5895a816ffca1b44aa5ec09042dda54919fa0b40;p=src%2Fapp-framework-binder.git diff --git a/include/afb/afb-binding.h b/include/afb/afb-binding.h index fe347af5..ae700f41 100644 --- a/include/afb/afb-binding.h +++ b/include/afb/afb-binding.h @@ -26,171 +26,205 @@ * * Functions of bindings of afb-daemon are accessible by authorized clients * through the apis module of afb-daemon. - * - * A binding is a shared library. This shared library must have at least one - * exported symbol for being registered in afb-daemon. - * */ +#define AFB_BINDING_LOWER_VERSION 1 +#define AFB_BINDING_UPPER_VERSION 2 + +#ifndef AFB_BINDING_VERSION +#define AFB_BINDING_VERSION 1 +#pragma GCC warning "\ +\n\ +\n\ + AFB_BINDING_VERSION should be defined before including \n\ + AFB_BINDING_VERSION defines the version of binding that you use.\n\ + Currently, known versions are 1 or 2.\n\ + Setting now AFB_BINDING_VERSION to 1 (version 1 by default)\n\ + NOTE THAT VERSION 2 IS NOW RECOMMENDED!\n\ + Consider to add one of the following define before including :\n\ +\n\ + #define AFB_BINDING_VERSION 1\n\ + #define AFB_BINDING_VERSION 2\n\ +\n\ + Note that in some case it will enforce you to include \n\ +" +#include /* old version side effect */ +#else +# if AFB_BINDING_VERSION == 1 +# pragma GCC warning "Using binding version 1, consider to switch to version 2" +# endif +#endif + +#if AFB_BINDING_VERSION != 0 +# if AFB_BINDING_VERSION < AFB_BINDING_LOWER_VERSION || AFB_BINDING_VERSION > AFB_BINDING_UPPER_VERSION +# error "Unsupported binding version AFB_BINDING_VERSION " #AFB_BINDING_VERSION +# endif +#endif + /* * Some function of the library are exported to afb-daemon. */ -#include "afb-event-itf.h" -#include "afb-req-itf.h" -#include "afb-service-itf.h" #include "afb-binding-v1.h" #include "afb-binding-v2.h" -/* - * config mode - */ -enum afb_mode { - AFB_MODE_LOCAL = 0, /* run locally */ - AFB_MODE_REMOTE, /* run remotely */ - AFB_MODE_GLOBAL /* run either remotely or locally (DONT USE! reserved for future) */ -}; +typedef struct afb_verb_desc_v1 afb_verb_desc_v1; +typedef struct afb_binding_desc_v1 afb_binding_desc_v1; +typedef struct afb_binding_v1 afb_binding_v1; +typedef struct afb_binding_interface_v1 afb_binding_interface_v1; + +typedef struct afb_verb_v2 afb_verb_v2; +typedef struct afb_binding_v2 afb_binding_v2; + +typedef enum afb_auth_type afb_auth_type; +typedef struct afb_auth afb_auth; +typedef struct afb_daemon afb_daemon; +typedef struct afb_event afb_event; +typedef struct afb_arg afb_arg; +typedef struct afb_req afb_req; +typedef struct afb_service afb_service; + +#if 0 +/* these typedef's shouldn't be needed */ +typedef enum afb_binding_type_v1 afb_binding_type_v1; +typedef enum afb_mode_v1 afb_mode_v1; +typedef enum afb_session_flags_v1 afb_session_flags_v1; +typedef enum afb_session_flags_v2 afb_session_flags_v2; +typedef struct afb_binding_data_v2 afb_binding_data_v2; +typedef struct afb_daemon_itf afb_daemon_itf; +typedef struct afb_event_itf afb_event_itf; +typedef struct afb_req_itf afb_req_itf; +typedef struct afb_service_itf afb_service_itf; +#endif -/* declaration of features of libsystemd */ -struct sd_event; -struct sd_bus; +/***************************************************************************************************/ -/* - * Definition of the facilities provided by the daemon. - */ -struct afb_daemon_itf { - int (*event_broadcast)(void *closure, const char *name, struct json_object *object); /* broadcasts evant 'name' with 'object' */ - struct sd_event *(*get_event_loop)(void *closure); /* gets the common systemd's event loop */ - struct sd_bus *(*get_user_bus)(void *closure); /* gets the common systemd's user d-bus */ - struct sd_bus *(*get_system_bus)(void *closure); /* gets the common systemd's system d-bus */ - void (*vverbose)(void*closure, int level, const char *file, int line, const char *fmt, va_list args); - struct afb_event (*event_make)(void *closure, const char *name); /* creates an event of 'name' */ - int (*rootdir_get_fd)(void *closure); - int (*rootdir_open_locale)(void *closure, const char *filename, int flags, const char *locale); -}; +#if AFB_BINDING_VERSION == 1 -/* - * 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; /* the interfacing functions */ - void *closure; /* the closure when calling these functions */ -}; +# define afb_binding afb_binding_v1 +# define afb_binding_interface afb_binding_interface_v1 -/* - * Interface between the daemon and the binding. - */ -struct afb_binding_interface -{ - struct afb_daemon daemon; /* access to the daemon facilies */ - int verbosity; /* level of verbosity */ - enum afb_mode mode; /* run mode (local or remote) */ -}; +# define AFB_SESSION_NONE AFB_SESSION_NONE_V1 +# define AFB_SESSION_CREATE AFB_SESSION_CREATE_V1 +# define AFB_SESSION_CLOSE AFB_SESSION_CLOSE_V1 +# define AFB_SESSION_RENEW AFB_SESSION_RENEW_V1 +# define AFB_SESSION_CHECK AFB_SESSION_CHECK_V1 -/* - * Retrieves the common systemd's event loop of AFB - * 'daemon' MUST be the daemon given in interface when activating the binding. - */ -static inline struct sd_event *afb_daemon_get_event_loop(struct afb_daemon daemon) -{ - return daemon.itf->get_event_loop(daemon.closure); -} +# define AFB_SESSION_LOA_GE AFB_SESSION_LOA_GE_V1 +# define AFB_SESSION_LOA_LE AFB_SESSION_LOA_LE_V1 +# define AFB_SESSION_LOA_EQ AFB_SESSION_LOA_EQ_V1 -/* - * Retrieves the common systemd's user/session d-bus of AFB - * 'daemon' MUST be the daemon given in interface when activating the binding. - */ -static inline struct sd_bus *afb_daemon_get_user_bus(struct afb_daemon daemon) -{ - return daemon.itf->get_user_bus(daemon.closure); -} +# define AFB_SESSION_LOA_SHIFT AFB_SESSION_LOA_SHIFT_V1 +# define AFB_SESSION_LOA_MASK AFB_SESSION_LOA_MASK_V1 -/* - * Retrieves the common systemd's system d-bus of AFB - * 'daemon' MUST be the daemon given in interface when activating the binding. - */ -static inline struct sd_bus *afb_daemon_get_system_bus(struct afb_daemon daemon) -{ - return daemon.itf->get_system_bus(daemon.closure); -} +# define AFB_SESSION_LOA_0 AFB_SESSION_LOA_0_V1 +# define AFB_SESSION_LOA_1 AFB_SESSION_LOA_1_V1 +# define AFB_SESSION_LOA_2 AFB_SESSION_LOA_2_V1 +# define AFB_SESSION_LOA_3 AFB_SESSION_LOA_3_V1 +# define AFB_SESSION_LOA_4 AFB_SESSION_LOA_4_V1 -/* - * Broadcasts widely the event of 'name' with the data 'object'. - * 'object' can be NULL. - * 'daemon' MUST be the daemon given in interface when activating the binding. - * - * For convenience, the function calls 'json_object_put' for 'object'. - * Thus, in the case where 'object' should remain available after - * the function returns, the function 'json_object_get' shall be used. - * - * Returns the count of clients that received the event. - */ -static inline int afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object) -{ - return daemon.itf->event_broadcast(daemon.closure, name, object); -} +# define AFB_SESSION_LOA_LE_0 AFB_SESSION_LOA_LE_0_V1 +# define AFB_SESSION_LOA_LE_1 AFB_SESSION_LOA_LE_1_V1 +# define AFB_SESSION_LOA_LE_2 AFB_SESSION_LOA_LE_2_V1 +# define AFB_SESSION_LOA_LE_3 AFB_SESSION_LOA_LE_3_V1 -/* - * Creates an event of 'name' and returns it. - * 'daemon' MUST be the daemon given in interface when activating the binding. - */ -static inline struct afb_event afb_daemon_make_event(struct afb_daemon daemon, const char *name) -{ - return daemon.itf->event_make(daemon.closure, name); -} +# define AFB_SESSION_LOA_EQ_0 AFB_SESSION_LOA_EQ_0_V1 +# define AFB_SESSION_LOA_EQ_1 AFB_SESSION_LOA_EQ_1_V1 +# define AFB_SESSION_LOA_EQ_2 AFB_SESSION_LOA_EQ_2_V1 +# define AFB_SESSION_LOA_EQ_3 AFB_SESSION_LOA_EQ_3_V1 -/* - * 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 binding. - */ -static inline void afb_daemon_verbose(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...) __attribute__((format(printf, 5, 6))); -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); - daemon.itf->vverbose(daemon.closure, level, file, line, fmt, args); - va_end(args); -} +# define AFB_SESSION_LOA_GE_0 AFB_SESSION_LOA_GE_0_V1 +# define AFB_SESSION_LOA_GE_1 AFB_SESSION_LOA_GE_1_V1 +# define AFB_SESSION_LOA_GE_2 AFB_SESSION_LOA_GE_2_V1 +# define AFB_SESSION_LOA_GE_3 AFB_SESSION_LOA_GE_3_V1 + +# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO) + +# define ERROR AFB_ERROR_V1 +# define WARNING AFB_WARNING_V1 +# define NOTICE AFB_NOTICE_V1 +# define INFO AFB_INFO_V1 +# define DEBUG AFB_DEBUG_V1 + +# define REQ_ERROR AFB_REQ_ERROR_V1 +# define REQ_WARNING AFB_REQ_WARNING_V1 +# define REQ_NOTICE AFB_REQ_NOTICE_V1 +# define REQ_INFO AFB_REQ_INFO_V1 +# define REQ_DEBUG AFB_REQ_DEBUG_V1 -/* - * Macros for logging messages - */ -#if !defined(NO_BINDING_VERBOSE_MACRO) -# if !defined(NO_BINDING_FILE_LINE_INDICATION) -# 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) -# else -# define ERROR(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,NULL,0,__VA_ARGS__);}while(0) -# define WARNING(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,NULL,0,__VA_ARGS__);}while(0) -# define NOTICE(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,NULL,0,__VA_ARGS__);}while(0) -# define INFO(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,NULL,0,__VA_ARGS__);}while(0) -# define DEBUG(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,NULL,0,__VA_ARGS__);}while(0) # endif + +#define afb_daemon_get_event_loop afb_daemon_get_event_loop_v1 +#define afb_daemon_get_user_bus afb_daemon_get_user_bus_v1 +#define afb_daemon_get_system_bus afb_daemon_get_system_bus_v1 +#define afb_daemon_broadcast_event afb_daemon_broadcast_event_v1 +#define afb_daemon_make_event afb_daemon_make_event_v1 +#define afb_daemon_verbose afb_daemon_verbose_v1 +#define afb_daemon_rootdir_get_fd afb_daemon_rootdir_get_fd_v1 +#define afb_daemon_rootdir_open_locale afb_daemon_rootdir_open_locale_v1 +#define afb_daemon_queue_job afb_daemon_queue_job_v1 +#define afb_daemon_require_api afb_daemon_require_api_v1 + +#define afb_service_call afb_service_call_v1 +#define afb_service_call_sync afb_service_call_sync_v1 + +#define afb_req_store afb_req_store_v1 +#define afb_req_unstore afb_req_unstore_v1 + #endif -/* - * Get the root directory file descriptor. This file descriptor can - * be used with functions 'openat', 'fstatat', ... - */ -static inline int afb_daemon_rootdir_get_fd(struct afb_daemon daemon) -{ - return daemon.itf->rootdir_get_fd(daemon.closure); -} +/***************************************************************************************************/ -/* - * Opens 'filename' within the root directory with 'flags' (see function openat) - * using the 'locale' definition (example: "jp,en-US") that can be NULL. - * Returns the file descriptor or -1 in case of error. - */ -static inline int afb_daemon_rootdir_open_locale(struct afb_daemon daemon, const char *filename, int flags, const char *locale) -{ - return daemon.itf->rootdir_open_locale(daemon.closure, filename, flags, locale); -} +#if AFB_BINDING_VERSION == 2 + +# define afb_binding afb_binding_v2 + +# define AFB_SESSION_NONE AFB_SESSION_NONE_V2 +# define AFB_SESSION_CLOSE AFB_SESSION_CLOSE_V2 +# define AFB_SESSION_RENEW AFB_SESSION_REFRESH_V2 +# define AFB_SESSION_REFRESH AFB_SESSION_REFRESH_V2 +# define AFB_SESSION_CHECK AFB_SESSION_CHECK_V2 + +# define AFB_SESSION_LOA_MASK AFB_SESSION_LOA_MASK_V2 + +# define AFB_SESSION_LOA_0 AFB_SESSION_LOA_0_V2 +# define AFB_SESSION_LOA_1 AFB_SESSION_LOA_1_V2 +# define AFB_SESSION_LOA_2 AFB_SESSION_LOA_2_V2 +# define AFB_SESSION_LOA_3 AFB_SESSION_LOA_3_V2 + +# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO) + +# define ERROR AFB_ERROR_V2 +# define WARNING AFB_WARNING_V2 +# define NOTICE AFB_NOTICE_V2 +# define INFO AFB_INFO_V2 +# define DEBUG AFB_DEBUG_V2 +# define REQ_ERROR AFB_REQ_ERROR_V2 +# define REQ_WARNING AFB_REQ_WARNING_V2 +# define REQ_NOTICE AFB_REQ_NOTICE_V2 +# define REQ_INFO AFB_REQ_INFO_V2 +# define REQ_DEBUG AFB_REQ_DEBUG_V2 + +# endif + +#define afb_daemon_get_event_loop afb_daemon_get_event_loop_v2 +#define afb_daemon_get_user_bus afb_daemon_get_user_bus_v2 +#define afb_daemon_get_system_bus afb_daemon_get_system_bus_v2 +#define afb_daemon_broadcast_event afb_daemon_broadcast_event_v2 +#define afb_daemon_make_event afb_daemon_make_event_v2 +#define afb_daemon_verbose afb_daemon_verbose_v2 +#define afb_daemon_rootdir_get_fd afb_daemon_rootdir_get_fd_v2 +#define afb_daemon_rootdir_open_locale afb_daemon_rootdir_open_locale_v2 +#define afb_daemon_queue_job afb_daemon_queue_job_v2 +#define afb_daemon_unstore_req afb_daemon_unstore_req_v2 +#define afb_daemon_require_api afb_daemon_require_api_v2 + +#define afb_service_call afb_service_call_v2 +#define afb_service_call_sync afb_service_call_sync_v2 + +#define afb_req_store afb_req_store_v2 +#define afb_req_unstore afb_daemon_unstore_req_v2 + +#endif