src/afb-hook.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 <stdarg.h>
  21
  22 struct req;
  23 struct afb_context;
  24 struct json_object;
  25 struct afb_arg;
  26 struct afb_event;
  27 struct afb_session;
  28 struct afb_xreq;
  29 struct afb_ditf;
  30 struct afb_svc;
  31 struct afb_stored_req;
  32 struct sd_bus;
  33 struct sd_event;
  34
  35 /*********************************************************
  36 * section hooking xreq
  37 *********************************************************/
  38 struct afb_hook_xreq;
  39
  40 /* individual flags */
  41 #define afb_hook_flag_req_begin                 0x000001
  42 #define afb_hook_flag_req_end                   0x000002
  43 #define afb_hook_flag_req_json                  0x000004
  44 #define afb_hook_flag_req_get                   0x000008
  45 #define afb_hook_flag_req_success               0x000010
  46 #define afb_hook_flag_req_fail                  0x000020
  47 #define afb_hook_flag_req_context_get           0x000040
  48 #define afb_hook_flag_req_context_set           0x000080
  49 #define afb_hook_flag_req_addref                0x000100
  50 #define afb_hook_flag_req_unref                 0x000200
  51 #define afb_hook_flag_req_session_close         0x000400
  52 #define afb_hook_flag_req_session_set_LOA       0x000800
  53 #define afb_hook_flag_req_subscribe             0x001000
  54 #define afb_hook_flag_req_unsubscribe           0x002000
  55 #define afb_hook_flag_req_subcall               0x004000
  56 #define afb_hook_flag_req_subcall_result        0x010800
  57 #define afb_hook_flag_req_subcallsync           0x020000
  58 #define afb_hook_flag_req_subcallsync_result    0x040000
  59 #define afb_hook_flag_req_vverbose              0x080000
  60 #define afb_hook_flag_req_store                 0x100000
  61 #define afb_hook_flag_req_unstore               0x200000
  62
  63 /* common flags */
  64 #define afb_hook_flags_req_life         (afb_hook_flag_req_begin|afb_hook_flag_req_end)
  65 #define afb_hook_flags_req_args         (afb_hook_flag_req_json|afb_hook_flag_req_get)
  66 #define afb_hook_flags_req_result       (afb_hook_flag_req_success|afb_hook_flag_req_fail)
  67 #define afb_hook_flags_req_session      (afb_hook_flag_req_session_close|afb_hook_flag_req_session_set_LOA)
  68 #define afb_hook_flags_req_event        (afb_hook_flag_req_subscribe|afb_hook_flag_req_unsubscribe)
  69 #define afb_hook_flags_req_subcalls     (afb_hook_flag_req_subcall|afb_hook_flag_req_subcall_result\
  70                                         |afb_hook_flag_req_subcallsync|afb_hook_flag_req_subcallsync_result)
  71
  72 /* extra flags */
  73 #define afb_hook_flags_req_ref          (afb_hook_flag_req_addref|afb_hook_flag_req_unref)
  74 #define afb_hook_flags_req_context      (afb_hook_flag_req_context_get|afb_hook_flag_req_context_set)
  75 #define afb_hook_flags_req_stores       (afb_hook_flag_req_store|afb_hook_flag_req_unstore)
  76
  77 /* predefined groups */
  78 #define afb_hook_flags_req_common       (afb_hook_flags_req_life|afb_hook_flags_req_args|afb_hook_flags_req_result\
  79                                         |afb_hook_flags_req_session|afb_hook_flags_req_event|afb_hook_flags_req_subcalls\
  80                                         |afb_hook_flag_req_vverbose)
  81 #define afb_hook_flags_req_extra        (afb_hook_flags_req_common|afb_hook_flags_req_ref|afb_hook_flags_req_context\
  82                                         |afb_hook_flags_req_stores)
  83 #define afb_hook_flags_req_all          (afb_hook_flags_req_extra)
  84
  85 struct afb_hook_xreq_itf {
  86         void (*hook_xreq_begin)(void * closure, const struct afb_xreq *xreq);
  87         void (*hook_xreq_end)(void * closure, const struct afb_xreq *xreq);
  88         void (*hook_xreq_json)(void * closure, const struct afb_xreq *xreq, struct json_object *obj);
  89         void (*hook_xreq_get)(void * closure, const struct afb_xreq *xreq, const char *name, struct afb_arg arg);
  90         void (*hook_xreq_success)(void * closure, const struct afb_xreq *xreq, struct json_object *obj, const char *info);
  91         void (*hook_xreq_fail)(void * closure, const struct afb_xreq *xreq, const char *status, const char *info);
  92         void (*hook_xreq_context_get)(void * closure, const struct afb_xreq *xreq, void *value);
  93         void (*hook_xreq_context_set)(void * closure, const struct afb_xreq *xreq, void *value, void (*free_value)(void*));
  94         void (*hook_xreq_addref)(void * closure, const struct afb_xreq *xreq);
  95         void (*hook_xreq_unref)(void * closure, const struct afb_xreq *xreq);
  96         void (*hook_xreq_session_close)(void * closure, const struct afb_xreq *xreq);
  97         void (*hook_xreq_session_set_LOA)(void * closure, const struct afb_xreq *xreq, unsigned level, int result);
  98         void (*hook_xreq_subscribe)(void * closure, const struct afb_xreq *xreq, struct afb_event event, int result);
  99         void (*hook_xreq_unsubscribe)(void * closure, const struct afb_xreq *xreq, struct afb_event event, int result);
 100         void (*hook_xreq_subcall)(void * closure, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
 101         void (*hook_xreq_subcall_result)(void * closure, const struct afb_xreq *xreq, int status, struct json_object *result);
 102         void (*hook_xreq_subcallsync)(void * closure, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
 103         void (*hook_xreq_subcallsync_result)(void * closure, const struct afb_xreq *xreq, int status, struct json_object *result);
 104         void (*hook_xreq_vverbose)(void * closure, const struct afb_xreq *xreq, int level, const char *file, int line, const char *func, const char *fmt, va_list args);
 105         void (*hook_xreq_store)(void * closure, const struct afb_xreq *xreq, struct afb_stored_req *sreq);
 106         void (*hook_xreq_unstore)(void * closure, const struct afb_xreq *xreq);
 107 };
 108
 109 extern void afb_hook_init_xreq(struct afb_xreq *xreq);
 110
 111 extern struct afb_hook_xreq *afb_hook_create_xreq(const char *api, const char *verb, struct afb_session *session, int flags, struct afb_hook_xreq_itf *itf, void *closure);
 112 extern struct afb_hook_xreq *afb_hook_addref_xreq(struct afb_hook_xreq *spec);
 113 extern void afb_hook_unref_xreq(struct afb_hook_xreq *spec);
 114
 115 /* hooks for xreq */
 116 extern void afb_hook_xreq_begin(const struct afb_xreq *xreq);
 117 extern void afb_hook_xreq_end(const struct afb_xreq *xreq);
 118 extern struct json_object *afb_hook_xreq_json(const struct afb_xreq *xreq, struct json_object *obj);
 119 extern struct afb_arg afb_hook_xreq_get(const struct afb_xreq *xreq, const char *name, struct afb_arg arg);
 120 extern void afb_hook_xreq_success(const struct afb_xreq *xreq, struct json_object *obj, const char *info);
 121 extern void afb_hook_xreq_fail(const struct afb_xreq *xreq, const char *status, const char *info);
 122 extern void *afb_hook_xreq_context_get(const struct afb_xreq *xreq, void *value);
 123 extern void afb_hook_xreq_context_set(const struct afb_xreq *xreq, void *value, void (*free_value)(void*));
 124 extern void afb_hook_xreq_addref(const struct afb_xreq *xreq);
 125 extern void afb_hook_xreq_unref(const struct afb_xreq *xreq);
 126 extern void afb_hook_xreq_session_close(const struct afb_xreq *xreq);
 127 extern int afb_hook_xreq_session_set_LOA(const struct afb_xreq *xreq, unsigned level, int result);
 128 extern int afb_hook_xreq_subscribe(const struct afb_xreq *xreq, struct afb_event event, int result);
 129 extern int afb_hook_xreq_unsubscribe(const struct afb_xreq *xreq, struct afb_event event, int result);
 130 extern void afb_hook_xreq_subcall(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
 131 extern void afb_hook_xreq_subcall_result(const struct afb_xreq *xreq, int status, struct json_object *result);
 132 extern void afb_hook_xreq_subcallsync(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
 133 extern int afb_hook_xreq_subcallsync_result(const struct afb_xreq *xreq, int status, struct json_object *result);
 134 extern void afb_hook_xreq_vverbose(const struct afb_xreq *xreq, int level, const char *file, int line, const char *func, const char *fmt, va_list args);
 135 extern void afb_hook_xreq_store(const struct afb_xreq *xreq, struct afb_stored_req *sreq);
 136 extern void afb_hook_xreq_unstore(const struct afb_xreq *xreq);
 137
 138 /*********************************************************
 139 * section hooking ditf (daemon interface)
 140 *********************************************************/
 141
 142 #define afb_hook_flag_ditf_vverbose                     0x000001
 143 #define afb_hook_flag_ditf_event_make                   0x000002
 144 #define afb_hook_flag_ditf_event_broadcast_before       0x000004
 145 #define afb_hook_flag_ditf_event_broadcast_after        0x000008
 146 #define afb_hook_flag_ditf_get_event_loop               0x000010
 147 #define afb_hook_flag_ditf_get_user_bus                 0x000020
 148 #define afb_hook_flag_ditf_get_system_bus               0x000040
 149 #define afb_hook_flag_ditf_rootdir_get_fd               0x000080
 150 #define afb_hook_flag_ditf_rootdir_open_locale          0x000100
 151 #define afb_hook_flag_ditf_queue_job                    0x000200
 152 #define afb_hook_flag_ditf_unstore_req                  0x000400
 153 #define afb_hook_flag_ditf_require_api                  0x000800
 154 #define afb_hook_flag_ditf_require_api_result           0x001000
 155
 156 #define afb_hook_flags_ditf_common      (afb_hook_flag_ditf_vverbose\
 157                                         |afb_hook_flag_ditf_event_make\
 158                                         |afb_hook_flag_ditf_event_broadcast_before\
 159                                         |afb_hook_flag_ditf_event_broadcast_after)
 160 #define afb_hook_flags_ditf_extra       (afb_hook_flag_ditf_get_event_loop\
 161                                         |afb_hook_flag_ditf_get_user_bus\
 162                                         |afb_hook_flag_ditf_get_system_bus\
 163                                         |afb_hook_flag_ditf_rootdir_get_fd\
 164                                         |afb_hook_flag_ditf_rootdir_open_locale\
 165                                         |afb_hook_flag_ditf_queue_job\
 166                                         |afb_hook_flag_ditf_unstore_req\
 167                                         |afb_hook_flag_ditf_require_api\
 168                                         |afb_hook_flag_ditf_require_api_result)
 169
 170 #define afb_hook_flags_ditf_all         (afb_hook_flags_ditf_common|afb_hook_flags_ditf_extra)
 171
 172 struct afb_hook_ditf_itf {
 173         void (*hook_ditf_event_broadcast_before)(void *closure, const struct afb_ditf *ditf, const char *name, struct json_object *object);
 174         void (*hook_ditf_event_broadcast_after)(void *closure, const struct afb_ditf *ditf, const char *name, struct json_object *object, int result);
 175         void (*hook_ditf_get_event_loop)(void *closure, const struct afb_ditf *ditf, struct sd_event *result);
 176         void (*hook_ditf_get_user_bus)(void *closure, const struct afb_ditf *ditf, struct sd_bus *result);
 177         void (*hook_ditf_get_system_bus)(void *closure, const struct afb_ditf *ditf, struct sd_bus *result);
 178         void (*hook_ditf_vverbose)(void*closure, const struct afb_ditf *ditf, int level, const char *file, int line, const char *function, const char *fmt, va_list args);
 179         void (*hook_ditf_event_make)(void *closure, const struct afb_ditf *ditf, const char *name, struct afb_event result);
 180         void (*hook_ditf_rootdir_get_fd)(void *closure, const struct afb_ditf *ditf, int result);
 181         void (*hook_ditf_rootdir_open_locale)(void *closure, const struct afb_ditf *ditf, const char *filename, int flags, const char *locale, int result);
 182         void (*hook_ditf_queue_job)(void *closure, const struct afb_ditf *ditf, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout, int result);
 183         void (*hook_ditf_unstore_req)(void *closure, const struct afb_ditf *ditf, struct afb_stored_req *sreq);
 184         void (*hook_ditf_require_api)(void *closure, const struct afb_ditf *ditf, const char *name, int initialized);
 185         void (*hook_ditf_require_api_result)(void *closure, const struct afb_ditf *ditf, const char *name, int initialized, int result);
 186 };
 187
 188 extern void afb_hook_ditf_event_broadcast_before(const struct afb_ditf *ditf, const char *name, struct json_object *object);
 189 extern int afb_hook_ditf_event_broadcast_after(const struct afb_ditf *ditf, const char *name, struct json_object *object, int result);
 190 extern struct sd_event *afb_hook_ditf_get_event_loop(const struct afb_ditf *ditf, struct sd_event *result);
 191 extern struct sd_bus *afb_hook_ditf_get_user_bus(const struct afb_ditf *ditf, struct sd_bus *result);
 192 extern struct sd_bus *afb_hook_ditf_get_system_bus(const struct afb_ditf *ditf, struct sd_bus *result);
 193 extern void afb_hook_ditf_vverbose(const struct afb_ditf *ditf, int level, const char *file, int line, const char *function, const char *fmt, va_list args);
 194 extern struct afb_event afb_hook_ditf_event_make(const struct afb_ditf *ditf, const char *name, struct afb_event result);
 195 extern int afb_hook_ditf_rootdir_get_fd(const struct afb_ditf *ditf, int result);
 196 extern int afb_hook_ditf_rootdir_open_locale(const struct afb_ditf *ditf, const char *filename, int flags, const char *locale, int result);
 197 extern int afb_hook_ditf_queue_job(const struct afb_ditf *ditf, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout, int result);
 198 extern void afb_hook_ditf_unstore_req(const struct afb_ditf *ditf, struct afb_stored_req *sreq);
 199 extern void afb_hook_ditf_require_api(const struct afb_ditf *ditf, const char *name, int initialized);
 200 extern int afb_hook_ditf_require_api_result(const struct afb_ditf *ditf, const char *name, int initialized, int result);
 201
 202 extern int afb_hook_flags_ditf(const char *api);
 203 extern struct afb_hook_ditf *afb_hook_create_ditf(const char *api, int flags, struct afb_hook_ditf_itf *itf, void *closure);
 204 extern struct afb_hook_ditf *afb_hook_addref_ditf(struct afb_hook_ditf *hook);
 205 extern void afb_hook_unref_ditf(struct afb_hook_ditf *hook);
 206
 207 /*********************************************************
 208 * section hooking svc (service interface)
 209 *********************************************************/
 210
 211 #define afb_hook_flag_svc_start_before                  0x000001
 212 #define afb_hook_flag_svc_start_after                   0x000002
 213 #define afb_hook_flag_svc_on_event_before               0x000004
 214 #define afb_hook_flag_svc_on_event_after                0x000008
 215 #define afb_hook_flag_svc_call                          0x000010
 216 #define afb_hook_flag_svc_call_result                   0x000020
 217 #define afb_hook_flag_svc_callsync                      0x000040
 218 #define afb_hook_flag_svc_callsync_result               0x000080
 219
 220 #define afb_hook_flags_svc_all          (afb_hook_flag_svc_start_before|afb_hook_flag_svc_start_after\
 221                                         |afb_hook_flag_svc_on_event_before|afb_hook_flag_svc_on_event_after\
 222                                         |afb_hook_flag_svc_call|afb_hook_flag_svc_call_result\
 223                                         |afb_hook_flag_svc_callsync|afb_hook_flag_svc_callsync_result)
 224
 225 struct afb_hook_svc_itf {
 226         void (*hook_svc_start_before)(void *closure, const struct afb_svc *svc);
 227         void (*hook_svc_start_after)(void *closure, const struct afb_svc *svc, int status);
 228         void (*hook_svc_on_event_before)(void *closure, const struct afb_svc *svc, const char *event, int eventid, struct json_object *object);
 229         void (*hook_svc_on_event_after)(void *closure, const struct afb_svc *svc, const char *event, int eventid, struct json_object *object);
 230         void (*hook_svc_call)(void *closure, const struct afb_svc *svc, const char *api, const char *verb, struct json_object *args);
 231         void (*hook_svc_call_result)(void *closure, const struct afb_svc *svc, int status, struct json_object *result);
 232         void (*hook_svc_callsync)(void *closure, const struct afb_svc *svc, const char *api, const char *verb, struct json_object *args);
 233         void (*hook_svc_callsync_result)(void *closure, const struct afb_svc *svc, int status, struct json_object *result);
 234 };
 235
 236 extern void afb_hook_svc_start_before(const struct afb_svc *svc);
 237 extern int afb_hook_svc_start_after(const struct afb_svc *svc, int status);
 238 extern void afb_hook_svc_on_event_before(const struct afb_svc *svc, const char *event, int eventid, struct json_object *object);
 239 extern void afb_hook_svc_on_event_after(const struct afb_svc *svc, const char *event, int eventid, struct json_object *object);
 240 extern void afb_hook_svc_call(const struct afb_svc *svc, const char *api, const char *verb, struct json_object *args);
 241 extern void afb_hook_svc_call_result(const struct afb_svc *svc, int status, struct json_object *result);
 242 extern void afb_hook_svc_callsync(const struct afb_svc *svc, const char *api, const char *verb, struct json_object *args);
 243 extern int afb_hook_svc_callsync_result(const struct afb_svc *svc, int status, struct json_object *result);
 244
 245 extern int afb_hook_flags_svc(const char *api);
 246 extern struct afb_hook_svc *afb_hook_create_svc(const char *api, int flags, struct afb_hook_svc_itf *itf, void *closure);
 247 extern struct afb_hook_svc *afb_hook_addref_svc(struct afb_hook_svc *hook);
 248 extern void afb_hook_unref_svc(struct afb_hook_svc *hook);
 249
 250 /*********************************************************
 251 * section hooking evt (event interface)
 252 *********************************************************/
 253
 254 #define afb_hook_flag_evt_create                        0x000001
 255 #define afb_hook_flag_evt_push_before                   0x000002
 256 #define afb_hook_flag_evt_push_after                    0x000004
 257 #define afb_hook_flag_evt_broadcast_before              0x000008
 258 #define afb_hook_flag_evt_broadcast_after               0x000010
 259 #define afb_hook_flag_evt_name                          0x000020
 260 #define afb_hook_flag_evt_drop                          0x000040
 261
 262 #define afb_hook_flags_evt_common       (afb_hook_flag_evt_push_before|afb_hook_flag_evt_broadcast_before)
 263 #define afb_hook_flags_evt_extra        (afb_hook_flags_evt_common\
 264                                         |afb_hook_flag_evt_push_after|afb_hook_flag_evt_broadcast_after\
 265                                         |afb_hook_flag_evt_create|afb_hook_flag_evt_drop)
 266 #define afb_hook_flags_evt_all          (afb_hook_flags_evt_extra|afb_hook_flag_evt_name)
 267
 268 struct afb_hook_evt_itf {
 269         void (*hook_evt_create)(void *closure, const char *evt, int id);
 270         void (*hook_evt_push_before)(void *closure, const char *evt, int id, struct json_object *obj);
 271         void (*hook_evt_push_after)(void *closure, const char *evt, int id, struct json_object *obj, int result);
 272         void (*hook_evt_broadcast_before)(void *closure, const char *evt, int id, struct json_object *obj);
 273         void (*hook_evt_broadcast_after)(void *closure, const char *evt, int id, struct json_object *obj, int result);
 274         void (*hook_evt_name)(void *closure, const char *evt, int id);
 275         void (*hook_evt_drop)(void *closure, const char *evt, int id);
 276 };
 277
 278 extern void afb_hook_evt_create(const char *evt, int id);
 279 extern void afb_hook_evt_push_before(const char *evt, int id, struct json_object *obj);
 280 extern int afb_hook_evt_push_after(const char *evt, int id, struct json_object *obj, int result);
 281 extern void afb_hook_evt_broadcast_before(const char *evt, int id, struct json_object *obj);
 282 extern int afb_hook_evt_broadcast_after(const char *evt, int id, struct json_object *obj, int result);
 283 extern void afb_hook_evt_name(const char *evt, int id);
 284 extern void afb_hook_evt_drop(const char *evt, int id);
 285
 286 extern int afb_hook_flags_evt(const char *name);
 287 extern struct afb_hook_evt *afb_hook_create_evt(const char *name, int flags, struct afb_hook_evt_itf *itf, void *closure);
 288 extern struct afb_hook_evt *afb_hook_addref_evt(struct afb_hook_evt *hook);
 289 extern void afb_hook_unref_evt(struct afb_hook_evt *hook);
 290