/*
- * Copyright (C) 2016 "IoT.bzh"
+ * Copyright (C) 2016, 2017 "IoT.bzh"
* Author: José Bollo <jose.bollo@iot.bzh>
*
* Licensed under the Apache License, Version 2.0 (the "License");
*
* A binding 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
*
- * afbBindingV1Register
*/
+#define AFB_BINDING_LOWER_VERSION 1
+#define AFB_BINDING_UPPER_VERSION 2
+#define AFB_BINDING_DEFAULT_VERSION 1
+
+#ifndef AFB_BINDING_VERSION
+#define AFB_BINDING_VERSION AFB_BINDING_DEFAULT_VERSION
+#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/afb-event-itf.h>
-#include <afb/afb-req-itf.h>
+#include "afb-binding-v1.h"
+#include "afb-binding-v2.h"
-/*
- * Definition of the type+versions of the binding.
- * The definition uses hashes.
- */
-enum afb_binding_type
-{
- AFB_BINDING_VERSION_1 = 123456789 /* version 1 */
-};
+/***************************************************************************************************/
-/*
- * Enum for Session/Token/Assurance middleware.
- * This enumeration is valid for bindings of type 1
- */
-enum afb_session_v1
-{
- AFB_SESSION_NONE = 0, /* nothing required */
- AFB_SESSION_CREATE = 1, /* Obsolete */
- AFB_SESSION_CLOSE = 2, /* After token authentification, closes the session at end */
- AFB_SESSION_RENEW = 4, /* After token authentification, refreshes the token at end */
- AFB_SESSION_CHECK = 8, /* Requires token 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 = 7, /* 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_4 = 256, /* value for LOA of 4 */
-
- 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 */
-};
+#if AFB_BINDING_VERSION == 1
-/*
- * Description of one verb of the API provided by the binding
- * This enumeration is valid for bindings of type 1
- */
-struct afb_verb_desc_v1
-{
- 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 */
-};
+# define afb_binding afb_binding_v1
+# define afb_binding_interface afb_binding_interface_v1
-/*
- * Description of the bindings of type 1
- */
-struct afb_binding_desc_v1
-{
- const char *info; /* textual information about the binding */
- const char *prefix; /* required prefix name for the binding */
- const struct afb_verb_desc_v1 *verbs; /* array of descriptions of verbs terminated by a NULL name */
-};
+# 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
-/*
- * Description of a binding
- */
-struct afb_binding
-{
- enum afb_binding_type type; /* type of the binding */
- union {
- struct afb_binding_desc_v1 v1; /* description of the binding of type 1 */
- };
-};
+# 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
-/*
- * 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) */
-};
+# define AFB_SESSION_LOA_SHIFT AFB_SESSION_LOA_SHIFT_V1
+# define AFB_SESSION_LOA_MASK AFB_SESSION_LOA_MASK_V1
-/* declaration of features of libsystemd */
-struct sd_event;
-struct sd_bus;
+# 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
-/*
- * 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' */
-};
+# 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
-/*
- * 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_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
-/*
- * 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_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
-/*
- * Function for registering the binding
- */
-extern const struct afb_binding *afbBindingV1Register (const struct afb_binding_interface *interface);
+# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
-/*
- * 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 ERROR AFB_ERROR_V1
+# define WARNING AFB_WARNING_V1
+# define NOTICE AFB_NOTICE_V1
+# define INFO AFB_INFO_V1
+# define DEBUG AFB_DEBUG_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);
-}
+# endif
-/*
- * 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_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
-/*
- * 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 conveniency, 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_service_call afb_service_call_v1
+#define afb_service_call_sync afb_service_call_sync_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);
-}
+#endif
-/*
- * 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);
- return daemon.itf->vverbose(daemon.closure, level, file, line, fmt, args);
- va_end(args);
-}
+/***************************************************************************************************/
+
+#if AFB_BINDING_VERSION == 2
+
+# define afb_binding afb_binding_v2
+# define afb_binding_interface afb_binding_interface_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
-/*
- * 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
-#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_service_call afb_service_call_v2
+#define afb_service_call_sync afb_service_call_sync_v2
+
+#endif
Code Review / src / app-framework-binder.git / blobdiff