diff options
Diffstat (limited to 'include/afb')
| -rw-r--r-- | include/afb/afb-binding-vdyn.h | 87 | ||||
| -rw-r--r-- | include/afb/afb-binding.h | 5 | ||||
| -rw-r--r-- | include/afb/afb-daemon-common.h | 2 | ||||
| -rw-r--r-- | include/afb/afb-daemon-v1.h | 9 | ||||
| -rw-r--r-- | include/afb/afb-daemon-v2.h | 9 | ||||
| -rw-r--r-- | include/afb/afb-dynapi-itf.h | 161 | ||||
| -rw-r--r-- | include/afb/afb-dynapi.h | 285 | ||||
| -rw-r--r-- | include/afb/afb-request-itf.h | 8 | ||||
| -rw-r--r-- | include/afb/afb-request.h | 2 |
9 files changed, 566 insertions, 2 deletions
diff --git a/include/afb/afb-binding-vdyn.h b/include/afb/afb-binding-vdyn.h new file mode 100644 index 00000000..6e7a0815 --- /dev/null +++ b/include/afb/afb-binding-vdyn.h @@ -0,0 +1,87 @@ +/* + * Copyright (C) 2016, 2017 "IoT.bzh" + * Author: José Bollo <jose.bollo@iot.bzh> + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#pragma once + +#include "afb-auth.h" +#include "afb-session-v2.h" +#include "afb-verbosity.h" + +#include "afb-eventid.h" +#include "afb-request.h" +#include "afb-dynapi.h" + +/* + * Macros for logging messages + */ +#if defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DATA) + +# define _AFB_DYNAPI_LOGGING_(vlevel,llevel,dynapi,...) \ + do{ \ + if(dynapi->verbosity>=vlevel) {\ + if (llevel <= AFB_VERBOSITY_LEVEL_ERROR) \ + afb_dynapi_verbose(dynapi,llevel,__FILE__,__LINE__,__func__,__VA_ARGS__); \ + else \ + afb_dynapi_verbose(dynapi,llevel,__FILE__,__LINE__,NULL,NULL); \ + } \ + }while(0) +# define _AFB_REQUEST_LOGGING_(vlevel,llevel,request,...) \ + do{ \ + if(request->dynapi->verbosity>=vlevel) \ + afb_request_verbose(request,llevel,__FILE__,__LINE__,NULL,NULL); \ + }while(0) + +#elif defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS) + +# define _AFB_DYNAPI_LOGGING_(vlevel,llevel,dynapi,...) \ + do{ \ + if(dynapi->verbosity>=vlevel) \ + afb_dynapi_verbose(dynapi,llevel,NULL,0,NULL,__VA_ARGS__); \ + }while(0) +# define _AFB_REQUEST_LOGGING_(vlevel,llevel,request,...) \ + do{ \ + if(request->dynapi->verbosity>=vlevel) \ + afb_request_verbose(request,llevel,NULL,0,NULL,__VA_ARGS__); \ + }while(0) + +#else + +# define _AFB_DYNAPI_LOGGING_(vlevel,llevel,dynapi,...) \ + do{ \ + if(dynapi->verbosity>=vlevel) \ + afb_dynapi_verbose(dynapi,llevel,__FILE__,__LINE__,__func__,__VA_ARGS__); \ + }while(0) +# define _AFB_REQUEST_LOGGING_(vlevel,llevel,request,...) \ + do{ \ + if(request->dynapi->verbosity>=vlevel) \ + afb_request_verbose(request,llevel,__FILE__,__LINE__,__func__,__VA_ARGS__); \ + }while(0) + +#endif + +#define AFB_DYNAPI_ERROR(...) _AFB_DYNAPI_LOGGING_(AFB_VERBOSITY_LEVEL_ERROR,_AFB_SYSLOG_LEVEL_ERROR_,__VA_ARGS__) +#define AFB_DYNAPI_WARNING(...) _AFB_DYNAPI_LOGGING_(AFB_VERBOSITY_LEVEL_WARNING,_AFB_SYSLOG_LEVEL_WARNING_,__VA_ARGS__) +#define AFB_DYNAPI_NOTICE(...) _AFB_DYNAPI_LOGGING_(AFB_VERBOSITY_LEVEL_NOTICE,_AFB_SYSLOG_LEVEL_NOTICE_,__VA_ARGS__) +#define AFB_DYNAPI_INFO(...) _AFB_DYNAPI_LOGGING_(AFB_VERBOSITY_LEVEL_INFO,_AFB_SYSLOG_LEVEL_INFO_,__VA_ARGS__) +#define AFB_DYNAPI_DEBUG(...) _AFB_DYNAPI_LOGGING_(AFB_VERBOSITY_LEVEL_DEBUG,_AFB_SYSLOG_LEVEL_DEBUG_,__VA_ARGS__) +#define AFB_REQUEST_ERROR(...) _AFB_REQUEST_LOGGING_(AFB_VERBOSITY_LEVEL_ERROR,_AFB_SYSLOG_LEVEL_ERROR_,__VA_ARGS__) +#define AFB_REQUEST_WARNING(...) _AFB_REQUEST_LOGGING_(AFB_VERBOSITY_LEVEL_WARNING,_AFB_SYSLOG_LEVEL_WARNING_,__VA_ARGS__) +#define AFB_REQUEST_NOTICE(...) _AFB_REQUEST_LOGGING_(AFB_VERBOSITY_LEVEL_NOTICE,_AFB_SYSLOG_LEVEL_NOTICE_,__VA_ARGS__) +#define AFB_REQUEST_INFO(...) _AFB_REQUEST_LOGGING_(AFB_VERBOSITY_LEVEL_INFO,_AFB_SYSLOG_LEVEL_INFO_,__VA_ARGS__) +#define AFB_REQUEST_DEBUG(...) _AFB_REQUEST_LOGGING_(AFB_VERBOSITY_LEVEL_DEBUG,_AFB_SYSLOG_LEVEL_DEBUG_,__VA_ARGS__) + + diff --git a/include/afb/afb-binding.h b/include/afb/afb-binding.h index f8e38c49..f7047596 100644 --- a/include/afb/afb-binding.h +++ b/include/afb/afb-binding.h @@ -67,6 +67,7 @@ #include "afb-binding-v1.h" #include "afb-binding-v2.h" +#include "afb-binding-vdyn.h" typedef struct afb_verb_desc_v1 afb_verb_desc_v1; typedef struct afb_binding_desc_v1 afb_binding_desc_v1; @@ -85,6 +86,10 @@ typedef struct afb_req afb_req; typedef struct afb_stored_req afb_stored_req; typedef struct afb_service afb_service; +typedef struct afb_dynapi afb_dynapi; +typedef struct afb_request afb_request; +typedef struct afb_eventid afb_eventid; + #if 0 /* these typedef's shouldn't be needed */ typedef enum afb_binding_type_v1 afb_binding_type_v1; diff --git a/include/afb/afb-daemon-common.h b/include/afb/afb-daemon-common.h index 5faf5758..b78f9af9 100644 --- a/include/afb/afb-daemon-common.h +++ b/include/afb/afb-daemon-common.h @@ -24,6 +24,7 @@ struct sd_event; struct sd_bus; struct afb_stored_req; struct afb_req; +struct afb_dynapi; /* * Definition of the facilities provided by the daemon. @@ -43,6 +44,7 @@ struct afb_daemon_itf struct afb_req (*unstore_req)(void*closure, struct afb_stored_req *sreq); int (*require_api)(void*closure, const char *name, int initialized); int (*rename_api)(void*closure, const char *name); + int (*new_api)(void *closure, const char *api, const char *info, int (*preinit)(void*, struct afb_dynapi *), void *preinit_closure); }; /* diff --git a/include/afb/afb-daemon-v1.h b/include/afb/afb-daemon-v1.h index 7fc2c235..9ac4f916 100644 --- a/include/afb/afb-daemon-v1.h +++ b/include/afb/afb-daemon-v1.h @@ -191,3 +191,12 @@ static inline int afb_daemon_rename_api_v1(struct afb_daemon daemon, const char return daemon.itf->rename_api(daemon.closure, name); } +static inline int afb_daemon_new_api_v1( + struct afb_daemon daemon, + const char *api, + const char *info, + int (*preinit)(void*, struct afb_dynapi *), + void *closure) +{ + return daemon.itf->new_api(daemon.closure, api, info, preinit, closure); +} diff --git a/include/afb/afb-daemon-v2.h b/include/afb/afb-daemon-v2.h index 1451a097..186fc6d6 100644 --- a/include/afb/afb-daemon-v2.h +++ b/include/afb/afb-daemon-v2.h @@ -168,3 +168,12 @@ static inline int afb_daemon_rename_api_v2(const char *name) return afb_get_daemon_v2().itf->rename_api(afb_get_daemon_v2().closure, name); } +static inline int afb_daemon_new_api_v2( + const char *api, + const char *info, + int (*preinit)(void*, struct afb_dynapi *), + void *closure) +{ + return afb_get_daemon_v2().itf->new_api(afb_get_daemon_v2().closure, api, info, preinit, closure); +} + diff --git a/include/afb/afb-dynapi-itf.h b/include/afb/afb-dynapi-itf.h new file mode 100644 index 00000000..dd291ae8 --- /dev/null +++ b/include/afb/afb-dynapi-itf.h @@ -0,0 +1,161 @@ +/* + * Copyright (C) 2016, 2017 "IoT.bzh" + * Author: José Bollo <jose.bollo@iot.bzh> + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#pragma once + +/* declared here */ +struct afb_dynapi; +struct afb_dynapi_itf; + +/* referenced here */ +#include <stdarg.h> +struct sd_event; +struct sd_bus; +struct afb_request; +struct afb_eventid; +struct afb_auth; +struct afb_verb_v2; + +/* + * structure for the dynapi + */ +struct afb_dynapi +{ + /* interface for the dynapi */ + const struct afb_dynapi_itf *itf; + + /* user defined data */ + void *userdata; + + /* current verbosity level */ + int verbosity; +}; + +/* + * Definition of the interface for the API + */ +struct afb_dynapi_itf +{ + /* CAUTION: respect the order, add at the end */ + + void (*vverbose)( + void *dynapi, + int level, + const char *file, + int line, + const char * func, + const char *fmt, + va_list args); + + /* gets the common systemd's event loop */ + struct sd_event *(*get_event_loop)( + void *dynapi); + + /* gets the common systemd's user d-bus */ + struct sd_bus *(*get_user_bus)( + void *dynapi); + + /* gets the common systemd's system d-bus */ + struct sd_bus *(*get_system_bus)( + void *dynapi); + + int (*rootdir_get_fd)( + void *dynapi); + + int (*rootdir_open_locale)( + void *dynapi, + const char *filename, + int flags, + const char *locale); + + int (*queue_job)( + void *dynapi, + void (*callback)(int signum, void *arg), + void *argument, + void *group, + int timeout); + + int (*require_api)( + void *dynapi, + const char *name, + int initialized); + + int (*rename_api)( + void *dynapi, + const char *name); + + /* broadcasts event 'name' with 'object' */ + int (*event_broadcast)( + void *dynapi, + const char *name, + struct json_object *object); + + /* creates an event of 'name' */ + struct afb_eventid *(*eventid_make)( + void *dynapi, + const char *name); + + void (*call)( + struct afb_dynapi *dynapi, + const char *api, + const char *verb, + struct json_object *args, + void (*callback)(void*, int, struct json_object*, struct afb_dynapi *), + void *callback_closure); + + int (*call_sync)( + void *dynapi, + const char *api, + const char *verb, + struct json_object *args, + struct json_object **result); + + int (*api_new_api)( + void *dynapi, + const char *api, + const char *info, + int (*preinit)(void*, struct afb_dynapi *), + void *closure); + + int (*api_set_verbs_v2)( + struct afb_dynapi *dynapi, + const struct afb_verb_v2 *verbs); + + int (*api_add_verb)( + struct afb_dynapi *dynapi, + const char *verb, + const char *info, + void (*callback)(struct afb_request *request), + const struct afb_auth *auth, + uint32_t session); + + int (*api_sub_verb)( + struct afb_dynapi *dynapi, + const char *verb); + + int (*api_set_on_event)( + struct afb_dynapi *dynapi, + void (*onevent)(struct afb_dynapi *dynapi, const char *event, struct json_object *object)); + + int (*api_set_on_init)( + struct afb_dynapi *dynapi, + int (*oninit)(struct afb_dynapi *dynapi)); + + void (*api_seal)( + struct afb_dynapi *dynapi); +}; + diff --git a/include/afb/afb-dynapi.h b/include/afb/afb-dynapi.h new file mode 100644 index 00000000..3d7c1469 --- /dev/null +++ b/include/afb/afb-dynapi.h @@ -0,0 +1,285 @@ +/* + * Copyright (C) 2016, 2017 "IoT.bzh" + * Author: José Bollo <jose.bollo@iot.bzh> + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#pragma once + +#include "afb-dynapi-itf.h" + +/* + * Send a message described by 'fmt' and following parameters + * to the journal for the verbosity 'level'. + * + * 'file', 'line' and 'func' are indicators of position of the code in source files + * (see macros __FILE__, __LINE__ and __func__). + * + * + * 'level' is defined by syslog standard: + * EMERGENCY 0 System is unusable + * ALERT 1 Action must be taken immediately + * CRITICAL 2 Critical conditions + * ERROR 3 Error conditions + * WARNING 4 Warning conditions + * NOTICE 5 Normal but significant condition + * INFO 6 Informational + * DEBUG 7 Debug-level messages + */ +static inline void afb_dynapi_verbose(struct afb_dynapi *dynapi, int level, const char *file, int line, const char *func, const char *fmt, ...) __attribute__((format(printf, 6, 7))); +static inline void afb_dynapi_verbose(struct afb_dynapi *dynapi, int level, const char *file, int line, const char *func, const char *fmt, ...) +{ + va_list args; + va_start(args, fmt); + dynapi->itf->vverbose(dynapi, level, file, line, func, fmt, args); + va_end(args); +} +static inline void afb_dynapi_vverbose(struct afb_dynapi *dynapi, int level, const char *file, int line, const char *func, const char *fmt, va_list args) +{ + dynapi->itf->vverbose(dynapi, level, file, line, func, fmt, args); +} + +/* + * Retrieves the common systemd's event loop of AFB + */ +static inline struct sd_event *afb_dynapi_get_event_loop(struct afb_dynapi *dynapi) +{ + return dynapi->itf->get_event_loop(dynapi); +} + +/* + * Retrieves the common systemd's user/session d-bus of AFB + */ +static inline struct sd_bus *afb_dynapi_get_user_bus(struct afb_dynapi *dynapi) +{ + return dynapi->itf->get_user_bus(dynapi); +} + +/* + * Retrieves the common systemd's system d-bus of AFB + */ +static inline struct sd_bus *afb_dynapi_get_system_bus(struct afb_dynapi *dynapi) +{ + return dynapi->itf->get_system_bus(dynapi); +} + +/* + * Get the root directory file descriptor. This file descriptor can + * be used with functions 'openat', 'fstatat', ... + */ +static inline int afb_dynapi_rootdir_get_fd(struct afb_dynapi *dynapi) +{ + return dynapi->itf->rootdir_get_fd(dynapi); +} + +/* + * 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_dynapi_rootdir_open_locale(struct afb_dynapi *dynapi, const char *filename, int flags, const char *locale) +{ + return dynapi->itf->rootdir_open_locale(dynapi, filename, flags, locale); +} + +/* + * Queue the job defined by 'callback' and 'argument' for being executed asynchronously + * in this thread (later) or in an other thread. + * If 'group' is not NUL, the jobs queued with a same value (as the pointer value 'group') + * are executed in sequence in the order of there submission. + * If 'timeout' is not 0, it represent the maximum execution time for the job in seconds. + * At first, the job is called with 0 as signum and the given argument. + * The job is executed with the monitoring of its time and some signals like SIGSEGV and + * SIGFPE. When a such signal is catched, the job is terminated and reexecuted but with + * signum being the signal number (SIGALRM when timeout expired). + * + * Returns 0 in case of success or -1 in case of error. + */ +static inline int afb_dynapi_queue_job(struct afb_dynapi *dynapi, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout) +{ + return dynapi->itf->queue_job(dynapi, callback, argument, group, timeout); +} + +/* + * Tells that it requires the API of "name" to exist + * and if 'initialized' is not null to be initialized. + * Calling this function is only allowed within init. + * Returns 0 in case of success or -1 in case of error. + */ +static inline int afb_dynapi_require_api(struct afb_dynapi *dynapi, const char *name, int initialized) +{ + return dynapi->itf->require_api(dynapi, name, initialized); +} + +/* + * Set the name of the API to 'name'. + * Calling this function is only allowed within preinit. + * Returns 0 in case of success or -1 in case of error. + */ +static inline int afb_dynapi_rename_api(struct afb_dynapi *dynapi, const char *name) +{ + return dynapi->itf->rename_api(dynapi, name); +} + +/* + * Broadcasts widely the event of 'name' with the data 'object'. + * 'object' can be NULL. + * + * 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. + * + * Calling this function is only forbidden during preinit. + * + * Returns the count of clients that received the event. + */ +static inline int afb_dynapi_broadcast_event(struct afb_dynapi *dynapi, const char *name, struct json_object *object) +{ + return dynapi->itf->event_broadcast(dynapi, name, object); +} + +/* + * Creates an event of 'name' and returns it. + * + * Calling this function is only forbidden during preinit. + * + * See afb_event_is_valid to check if there is an error. + */ +static inline struct afb_eventid *afb_dynapi_make_eventid(struct afb_dynapi *dynapi, const char *name) +{ + return dynapi->itf->eventid_make(dynapi, name); +} + +/** + * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding. + * The result of the call is delivered to the 'callback' function with the 'callback_closure'. + * + * For convenience, the function calls 'json_object_put' for 'args'. + * Thus, in the case where 'args' should remain available after + * the function returns, the function 'json_object_get' shall be used. + * + * The 'callback' receives 3 arguments: + * 1. 'closure' the user defined closure pointer 'callback_closure', + * 2. 'status' a status being 0 on success or negative when an error occured, + * 2. 'result' the resulting data as a JSON object. + * + * @param dynapi The dynapi + * @param api The api name of the method to call + * @param verb The verb name of the method to call + * @param args The arguments to pass to the method + * @param callback The to call on completion + * @param callback_closure The closure to pass to the callback + * + * @see also 'afb_req_subcall' + */ +static inline void afb_dynapi_call( + struct afb_dynapi *dynapi, + const char *api, + const char *verb, + struct json_object *args, + void (*callback)(void*closure, int status, struct json_object *result, struct afb_dynapi *dynapi), + void *callback_closure) +{ + dynapi->itf->call(dynapi, api, verb, args, callback, callback_closure); +} + +/** + * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding. + * 'result' will receive the response. + * + * For convenience, the function calls 'json_object_put' for 'args'. + * Thus, in the case where 'args' should remain available after + * the function returns, the function 'json_object_get' shall be used. + * + * @param dynapi The dynapi + * @param api The api name of the method to call + * @param verb The verb name of the method to call + * @param args The arguments to pass to the method + * @param result Where to store the result - should call json_object_put on it - + * + * @returns 0 in case of success or a negative value in case of error. + * + * @see also 'afb_req_subcall' + */ +static inline int afb_dynapi_call_sync( + struct afb_dynapi *dynapi, + const char *api, + const char *verb, + struct json_object *args, + struct json_object **result) +{ + return dynapi->itf->call_sync(dynapi, api, verb, args, result); +} + + +static inline int afb_dynapi_new_api( + struct afb_dynapi *dynapi, + const char *api, + const char *info, + int (*preinit)(void*, struct afb_dynapi *), + void *closure) +{ + return dynapi->itf->api_new_api(dynapi, api, info, preinit, closure); +} + +static inline int afb_dynapi_set_verbs_v2( + struct afb_dynapi *dynapi, + const struct afb_verb_v2 *verbs) +{ + return dynapi->itf->api_set_verbs_v2(dynapi, verbs); +} + +static inline int afb_dynapi_add_verb( + struct afb_dynapi *dynapi, + const char *verb, + const char *info, + void (*callback)(struct afb_request *request), + const struct afb_auth *auth, + uint32_t session) +{ + return dynapi->itf->api_add_verb(dynapi, verb, info, callback, auth, session); +} + + +static inline int afb_dynapi_sub_verb( + struct afb_dynapi *dynapi, + const char *verb) +{ + return dynapi->itf->api_sub_verb(dynapi, verb); +} + + +static inline int afb_dynapi_on_event( + struct afb_dynapi *dynapi, + void (*onevent)(struct afb_dynapi *dynapi, const char *event, struct json_object *object)) +{ + return dynapi->itf->api_set_on_event(dynapi, onevent); +} + + +static inline int afb_dynapi_on_init( + struct afb_dynapi *dynapi, + int (*oninit)(struct afb_dynapi *dynapi)) +{ + return dynapi->itf->api_set_on_init(dynapi, oninit); +} + + +static inline void afb_dynapi_seal( + struct afb_dynapi *dynapi) +{ + dynapi->itf->api_seal(dynapi); +} + + diff --git a/include/afb/afb-request-itf.h b/include/afb/afb-request-itf.h index 9e55a361..b9e4366a 100644 --- a/include/afb/afb-request-itf.h +++ b/include/afb/afb-request-itf.h @@ -28,6 +28,7 @@ struct json_object; struct afb_req; struct afb_event; struct afb_eventid; +struct afb_dynapi; struct afb_stored_req; /* @@ -42,9 +43,16 @@ struct afb_arg /* when the request is finalized this file is removed */ }; +/* + * structure for the request + */ struct afb_request { + /* interface for the request */ const struct afb_request_itf *itf; + + /* current dynapi if dynapi (is NULL for bindings v1 and v2) */ + struct afb_dynapi *dynapi; }; /* diff --git a/include/afb/afb-request.h b/include/afb/afb-request.h index 26b2ef11..678922b3 100644 --- a/include/afb/afb-request.h +++ b/include/afb/afb-request.h @@ -19,8 +19,6 @@ #include "afb-request-itf.h" -typedef struct afb_request afb_request; - /* * Gets from the request 'request' the argument of 'name'. * Returns a PLAIN structure of type 'struct afb_arg'. |