include/afb/afb-daemon-v2.h

   1 /*
   2  * Copyright (C) 2016, 2017 "IoT.bzh"
   3  * Author: José Bollo <jose.bollo@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #pragma once
  19
  20 #include "afb-daemon-itf.h"
  21
  22 /*
  23  * Retrieves the common systemd's event loop of AFB
  24  */
  25 static inline struct sd_event *afb_daemon_get_event_loop_v2()
  26 {
  27         return afb_get_daemon_v2().itf->get_event_loop(afb_get_daemon_v2().closure);
  28 }
  29
  30 /*
  31  * Retrieves the common systemd's user/session d-bus of AFB
  32  */
  33 static inline struct sd_bus *afb_daemon_get_user_bus_v2()
  34 {
  35         return afb_get_daemon_v2().itf->get_user_bus(afb_get_daemon_v2().closure);
  36 }
  37
  38 /*
  39  * Retrieves the common systemd's system d-bus of AFB
  40  */
  41 static inline struct sd_bus *afb_daemon_get_system_bus_v2()
  42 {
  43         return afb_get_daemon_v2().itf->get_system_bus(afb_get_daemon_v2().closure);
  44 }
  45
  46 /*
  47  * Broadcasts widely the event of 'name' with the data 'object'.
  48  * 'object' can be NULL.
  49  *
  50  * For convenience, the function calls 'json_object_put' for 'object'.
  51  * Thus, in the case where 'object' should remain available after
  52  * the function returns, the function 'json_object_get' shall be used.
  53  *
  54  * Calling this function is only forbidden during preinit.
  55  *
  56  * Returns the count of clients that received the event.
  57  */
  58 static inline int afb_daemon_broadcast_event_v2(const char *name, struct json_object *object)
  59 {
  60         return afb_get_daemon_v2().itf->event_broadcast(afb_get_daemon_v2().closure, name, object);
  61 }
  62
  63 /*
  64  * Creates an event of 'name' and returns it.
  65  *
  66  * Calling this function is only forbidden during preinit.
  67  *
  68  * See afb_event_is_valid to check if there is an error.
  69  */
  70 static inline struct afb_event afb_daemon_make_event_v2(const char *name)
  71 {
  72         return afb_get_daemon_v2().itf->event_make(afb_get_daemon_v2().closure, name);
  73 }
  74
  75 /*
  76  * Send a message described by 'fmt' and following parameters
  77  * to the journal for the verbosity 'level'.
  78  *
  79  * 'file', 'line' and 'func' are indicators of position of the code in source files
  80  * (see macros __FILE__, __LINE__ and __func__).
  81  *
  82  * 'level' is defined by syslog standard:
  83  *      EMERGENCY         0        System is unusable
  84  *      ALERT             1        Action must be taken immediately
  85  *      CRITICAL          2        Critical conditions
  86  *      ERROR             3        Error conditions
  87  *      WARNING           4        Warning conditions
  88  *      NOTICE            5        Normal but significant condition
  89  *      INFO              6        Informational
  90  *      DEBUG             7        Debug-level messages
  91  */
  92 static inline void afb_daemon_verbose_v2(int level, const char *file, int line, const char * func, const char *fmt, ...) __attribute__((format(printf, 5, 6)));
  93 static inline void afb_daemon_verbose_v2(int level, const char *file, int line, const char * func, const char *fmt, ...)
  94 {
  95         va_list args;
  96         va_start(args, fmt);
  97         afb_get_daemon_v2().itf->vverbose_v2(afb_get_daemon_v2().closure, level, file, line, func, fmt, args);
  98         va_end(args);
  99 }
 100
 101 /*
 102  * Get the root directory file descriptor. This file descriptor can
 103  * be used with functions 'openat', 'fstatat', ...
 104  */
 105 static inline int afb_daemon_rootdir_get_fd_v2()
 106 {
 107         return afb_get_daemon_v2().itf->rootdir_get_fd(afb_get_daemon_v2().closure);
 108 }
 109
 110 /*
 111  * Opens 'filename' within the root directory with 'flags' (see function openat)
 112  * using the 'locale' definition (example: "jp,en-US") that can be NULL.
 113  * Returns the file descriptor or -1 in case of error.
 114  */
 115 static inline int afb_daemon_rootdir_open_locale_v2(const char *filename, int flags, const char *locale)
 116 {
 117         return afb_get_daemon_v2().itf->rootdir_open_locale(afb_get_daemon_v2().closure, filename, flags, locale);
 118 }
 119
 120 /*
 121  * Queue the job defined by 'callback' and 'argument' for being executed asynchronously
 122  * in this thread (later) or in an other thread.
 123  * If 'group' is not NUL, the jobs queued with a same value (as the pointer value 'group')
 124  * are executed in sequence in the order of there submission.
 125  * If 'timeout' is not 0, it represent the maximum execution time for the job in seconds.
 126  * At first, the job is called with 0 as signum and the given argument.
 127  * The job is executed with the monitoring of its time and some signals like SIGSEGV and
 128  * SIGFPE. When a such signal is catched, the job is terminated and reexecuted but with
 129  * signum being the signal number (SIGALRM when timeout expired).
 130  *
 131  * Returns 0 in case of success or -1 in case of error.
 132  */
 133 static inline int afb_daemon_queue_job_v2(void (*callback)(int signum, void *arg), void *argument, void *group, int timeout)
 134 {
 135         return afb_get_daemon_v2().itf->queue_job(afb_get_daemon_v2().closure, callback, argument, group, timeout);
 136 }
 137
 138 /*
 139  * Retrieves the afb_req stored at 'sreq'.
 140  * Returns the stored request.
 141  * The count of reference is UNCHANGED, thus, the
 142  * function 'afb_req_unref' should be called on the result
 143  * after that the asynchronous reply if sent.
 144  */
 145 static inline struct afb_req afb_daemon_unstore_req_v2(struct afb_stored_req *sreq)
 146 {
 147         return afb_get_daemon_v2().itf->unstore_req(afb_get_daemon_v2().closure, sreq);
 148 }
 149
 150 /*
 151  * Tells that it requires the API of "name" to exist
 152  * and if 'initialized' is not null to be initialized.
 153  * Calling this function is only allowed within init.
 154  * Returns 0 in case of success or -1 in case of error.
 155  */
 156 static inline int afb_daemon_require_api_v2(const char *name, int initialized)
 157 {
 158         return afb_get_daemon_v2().itf->require_api(afb_get_daemon_v2().closure, name, initialized);
 159 }
 160
 161 /*
 162  * Set the name of the API to 'name'.
 163  * Calling this function is only allowed within preinit.
 164  * Returns 0 in case of success or -1 in case of error.
 165  */
 166 static inline int afb_daemon_rename_api_v2(const char *name)
 167 {
 168         return afb_get_daemon_v2().itf->rename_api(afb_get_daemon_v2().closure, name);
 169 }
 170
 171 static inline int afb_daemon_new_api_v2(
 172         const char *api,
 173         const char *info,
 174         int noconcurrency,
 175         int (*preinit)(void*, struct afb_dynapi *),
 176         void *closure)
 177 {
 178         return afb_get_daemon_v2().itf->new_api(afb_get_daemon_v2().closure, api, info, noconcurrency, preinit, closure);
 179 }
 180