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 struct req;
  21 struct afb_context;
  22 struct json_object;
  23 struct afb_arg;
  24 struct afb_event;
  25 struct afb_session;
  26 struct afb_xreq;
  27 struct afb_ditf;
  28 struct afb_svc;
  29 struct sd_bus;
  30 struct sd_event;
  31
  32 /*********************************************************
  33 * section hooking xreq
  34 *********************************************************/
  35 struct afb_hook_xreq;
  36
  37 /* individual flags */
  38 #define afb_hook_flag_req_begin                 0x000001
  39 #define afb_hook_flag_req_end                   0x000002
  40 #define afb_hook_flag_req_json                  0x000004
  41 #define afb_hook_flag_req_get                   0x000008
  42 #define afb_hook_flag_req_success               0x000010
  43 #define afb_hook_flag_req_fail                  0x000020
  44 #define afb_hook_flag_req_context_get           0x000040
  45 #define afb_hook_flag_req_context_set           0x000080
  46 #define afb_hook_flag_req_addref                0x000100
  47 #define afb_hook_flag_req_unref                 0x000200
  48 #define afb_hook_flag_req_session_close         0x000400
  49 #define afb_hook_flag_req_session_set_LOA       0x000800
  50 #define afb_hook_flag_req_subscribe             0x001000
  51 #define afb_hook_flag_req_unsubscribe           0x002000
  52 #define afb_hook_flag_req_subcall               0x004000
  53 #define afb_hook_flag_req_subcall_result        0x010800
  54 #define afb_hook_flag_req_subcallsync           0x020000
  55 #define afb_hook_flag_req_subcallsync_result    0x040000
  56
  57 /* common flags */
  58 #define afb_hook_flags_req_life         (afb_hook_flag_req_begin|afb_hook_flag_req_end)
  59 #define afb_hook_flags_req_args         (afb_hook_flag_req_json|afb_hook_flag_req_get)
  60 #define afb_hook_flags_req_result       (afb_hook_flag_req_success|afb_hook_flag_req_fail)
  61 #define afb_hook_flags_req_session      (afb_hook_flag_req_session_close|afb_hook_flag_req_session_set_LOA)
  62 #define afb_hook_flags_req_event        (afb_hook_flag_req_subscribe|afb_hook_flag_req_unsubscribe)
  63 #define afb_hook_flags_req_subcall      (afb_hook_flag_req_subcall|afb_hook_flag_req_subcall_result\
  64                                         |afb_hook_flag_req_subcallsync|afb_hook_flag_req_subcallsync_result)
  65
  66 /* extra flags */
  67 #define afb_hook_flags_req_ref          (afb_hook_flag_req_addref|afb_hook_flag_req_unref)
  68 #define afb_hook_flags_req_context      (afb_hook_flag_req_context_get|afb_hook_flag_req_context_set)
  69
  70 /* predefined groups */
  71 #define afb_hook_flags_req_common       (afb_hook_flags_req_life|afb_hook_flags_req_args|afb_hook_flags_req_result\
  72                                         |afb_hook_flags_req_session|afb_hook_flags_req_event|afb_hook_flags_req_subcall)
  73 #define afb_hook_flags_req_extra        (afb_hook_flags_req_common|afb_hook_flags_req_ref|afb_hook_flags_req_context)
  74 #define afb_hook_flags_req_all          (afb_hook_flags_req_extra)
  75
  76 struct afb_hook_xreq_itf {
  77         void (*hook_xreq_begin)(void * closure, const struct afb_xreq *xreq);
  78         void (*hook_xreq_end)(void * closure, const struct afb_xreq *xreq);
  79         void (*hook_xreq_json)(void * closure, const struct afb_xreq *xreq, struct json_object *obj);
  80         void (*hook_xreq_get)(void * closure, const struct afb_xreq *xreq, const char *name, struct afb_arg arg);
  81         void (*hook_xreq_success)(void * closure, const struct afb_xreq *xreq, struct json_object *obj, const char *info);
  82         void (*hook_xreq_fail)(void * closure, const struct afb_xreq *xreq, const char *status, const char *info);
  83         void (*hook_xreq_context_get)(void * closure, const struct afb_xreq *xreq, void *value);
  84         void (*hook_xreq_context_set)(void * closure, const struct afb_xreq *xreq, void *value, void (*free_value)(void*));
  85         void (*hook_xreq_addref)(void * closure, const struct afb_xreq *xreq);
  86         void (*hook_xreq_unref)(void * closure, const struct afb_xreq *xreq);
  87         void (*hook_xreq_session_close)(void * closure, const struct afb_xreq *xreq);
  88         void (*hook_xreq_session_set_LOA)(void * closure, const struct afb_xreq *xreq, unsigned level, int result);
  89         void (*hook_xreq_subscribe)(void * closure, const struct afb_xreq *xreq, struct afb_event event, int result);
  90         void (*hook_xreq_unsubscribe)(void * closure, const struct afb_xreq *xreq, struct afb_event event, int result);
  91         void (*hook_xreq_subcall)(void * closure, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
  92         void (*hook_xreq_subcall_result)(void * closure, const struct afb_xreq *xreq, int status, struct json_object *result);
  93         void (*hook_xreq_subcallsync)(void * closure, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
  94         void (*hook_xreq_subcallsync_result)(void * closure, const struct afb_xreq *xreq, int status, struct json_object *result);
  95 };
  96
  97 extern void afb_hook_init_xreq(struct afb_xreq *xreq);
  98
  99 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);
 100 extern struct afb_hook_xreq *afb_hook_addref_xreq(struct afb_hook_xreq *spec);
 101 extern void afb_hook_unref_xreq(struct afb_hook_xreq *spec);
 102
 103 /* hooks for xreq */
 104 extern void afb_hook_xreq_begin(const struct afb_xreq *xreq);
 105 extern void afb_hook_xreq_end(const struct afb_xreq *xreq);
 106 extern struct json_object *afb_hook_xreq_json(const struct afb_xreq *xreq, struct json_object *obj);
 107 extern struct afb_arg afb_hook_xreq_get(const struct afb_xreq *xreq, const char *name, struct afb_arg arg);
 108 extern void afb_hook_xreq_success(const struct afb_xreq *xreq, struct json_object *obj, const char *info);
 109 extern void afb_hook_xreq_fail(const struct afb_xreq *xreq, const char *status, const char *info);
 110 extern void *afb_hook_xreq_context_get(const struct afb_xreq *xreq, void *value);
 111 extern void afb_hook_xreq_context_set(const struct afb_xreq *xreq, void *value, void (*free_value)(void*));
 112 extern void afb_hook_xreq_addref(const struct afb_xreq *xreq);
 113 extern void afb_hook_xreq_unref(const struct afb_xreq *xreq);
 114 extern void afb_hook_xreq_session_close(const struct afb_xreq *xreq);
 115 extern int afb_hook_xreq_session_set_LOA(const struct afb_xreq *xreq, unsigned level, int result);
 116 extern int afb_hook_xreq_subscribe(const struct afb_xreq *xreq, struct afb_event event, int result);
 117 extern int afb_hook_xreq_unsubscribe(const struct afb_xreq *xreq, struct afb_event event, int result);
 118 extern void afb_hook_xreq_subcall(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
 119 extern void afb_hook_xreq_subcall_result(const struct afb_xreq *xreq, int status, struct json_object *result);
 120 extern void afb_hook_xreq_subcallsync(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
 121 extern int afb_hook_xreq_subcallsync_result(const struct afb_xreq *xreq, int status, struct json_object *result);
 122
 123 /*********************************************************
 124 * section hooking ditf (daemon interface)
 125 *********************************************************/
 126
 127 #define afb_hook_flag_ditf_vverbose                     0x000001
 128 #define afb_hook_flag_ditf_event_make                   0x000002
 129 #define afb_hook_flag_ditf_event_broadcast_before       0x000004
 130 #define afb_hook_flag_ditf_event_broadcast_after        0x000008
 131 #define afb_hook_flag_ditf_get_event_loop               0x000010
 132 #define afb_hook_flag_ditf_get_user_bus                 0x000020
 133 #define afb_hook_flag_ditf_get_system_bus               0x000040
 134 #define afb_hook_flag_ditf_rootdir_get_fd               0x000080
 135 #define afb_hook_flag_ditf_rootdir_open_locale          0x000100
 136 #define afb_hook_flag_ditf_queue_job                    0x000200
 137
 138 #define afb_hook_flags_ditf_common      (afb_hook_flag_ditf_vverbose\
 139                                         |afb_hook_flag_ditf_event_make\
 140                                         |afb_hook_flag_ditf_event_broadcast_before\
 141                                         |afb_hook_flag_ditf_event_broadcast_after)
 142 #define afb_hook_flags_ditf_extra       (afb_hook_flag_ditf_get_event_loop\
 143                                         |afb_hook_flag_ditf_get_user_bus\
 144                                         |afb_hook_flag_ditf_get_system_bus\
 145                                         |afb_hook_flag_ditf_rootdir_get_fd\
 146                                         |afb_hook_flag_ditf_rootdir_open_locale\
 147                                         |afb_hook_flag_ditf_queue_job)
 148
 149 #define afb_hook_flags_ditf_all         (afb_hook_flags_ditf_common|afb_hook_flags_ditf_extra)
 150
 151 struct afb_hook_ditf_itf {
 152         void (*hook_ditf_event_broadcast_before)(void *closure, const struct afb_ditf *ditf, const char *name, struct json_object *object);
 153         void (*hook_ditf_event_broadcast_after)(void *closure, const struct afb_ditf *ditf, const char *name, struct json_object *object, int result);
 154         void (*hook_ditf_get_event_loop)(void *closure, const struct afb_ditf *ditf, struct sd_event *result);
 155         void (*hook_ditf_get_user_bus)(void *closure, const struct afb_ditf *ditf, struct sd_bus *result);
 156         void (*hook_ditf_get_system_bus)(void *closure, const struct afb_ditf *ditf, struct sd_bus *result);
 157         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);
 158         void (*hook_ditf_event_make)(void *closure, const struct afb_ditf *ditf, const char *name, struct afb_event result);
 159         void (*hook_ditf_rootdir_get_fd)(void *closure, const struct afb_ditf *ditf, int result);
 160         void (*hook_ditf_rootdir_open_locale)(void *closure, const struct afb_ditf *ditf, const char *filename, int flags, const char *locale, int result);
 161         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);
 162 };
 163
 164 extern void afb_hook_ditf_event_broadcast_before(const struct afb_ditf *ditf, const char *name, struct json_object *object);
 165 extern int afb_hook_ditf_event_broadcast_after(const struct afb_ditf *ditf, const char *name, struct json_object *object, int result);
 166 extern struct sd_event *afb_hook_ditf_get_event_loop(const struct afb_ditf *ditf, struct sd_event *result);
 167 extern struct sd_bus *afb_hook_ditf_get_user_bus(const struct afb_ditf *ditf, struct sd_bus *result);
 168 extern struct sd_bus *afb_hook_ditf_get_system_bus(const struct afb_ditf *ditf, struct sd_bus *result);
 169 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);
 170 extern struct afb_event afb_hook_ditf_event_make(const struct afb_ditf *ditf, const char *name, struct afb_event result);
 171 extern int afb_hook_ditf_rootdir_get_fd(const struct afb_ditf *ditf, int result);
 172 extern int afb_hook_ditf_rootdir_open_locale(const struct afb_ditf *ditf, const char *filename, int flags, const char *locale, int result);
 173 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);
 174
 175 extern int afb_hook_flags_ditf(const char *api);
 176 extern struct afb_hook_ditf *afb_hook_create_ditf(const char *api, int flags, struct afb_hook_ditf_itf *itf, void *closure);
 177 extern struct afb_hook_ditf *afb_hook_addref_ditf(struct afb_hook_ditf *hook);
 178 extern void afb_hook_unref_ditf(struct afb_hook_ditf *hook);
 179
 180 /*********************************************************
 181 * section hooking svc (service interface)
 182 *********************************************************/
 183
 184 #define afb_hook_flag_svc_start_before          0x000001
 185 #define afb_hook_flag_svc_start_after           0x000002
 186 #define afb_hook_flag_svc_on_event_before       0x000004
 187 #define afb_hook_flag_svc_on_event_after        0x000008
 188 #define afb_hook_flag_svc_call                  0x000010
 189 #define afb_hook_flag_svc_call_result           0x000020
 190 #define afb_hook_flag_svc_callsync              0x000040
 191 #define afb_hook_flag_svc_callsync_result       0x000080
 192
 193 #define afb_hook_flags_svc_all          (afb_hook_flag_svc_start_before|afb_hook_flag_svc_start_after\
 194                                         |afb_hook_flag_svc_on_event_before|afb_hook_flag_svc_on_event_after\
 195                                         |afb_hook_flag_svc_call|afb_hook_flag_svc_call_result\
 196                                         |afb_hook_flag_svc_callsync|afb_hook_flag_svc_callsync_result)
 197
 198 struct afb_hook_svc_itf {
 199         void (*hook_svc_start_before)(void *closure, const struct afb_svc *svc);
 200         void (*hook_svc_start_after)(void *closure, const struct afb_svc *svc, int status);
 201         void (*hook_svc_on_event_before)(void *closure, const struct afb_svc *svc, const char *event, int eventid, struct json_object *object);
 202         void (*hook_svc_on_event_after)(void *closure, const struct afb_svc *svc, const char *event, int eventid, struct json_object *object);
 203         void (*hook_svc_call)(void *closure, const struct afb_svc *svc, const char *api, const char *verb, struct json_object *args);
 204         void (*hook_svc_call_result)(void *closure, const struct afb_svc *svc, int status, struct json_object *result);
 205         void (*hook_svc_callsync)(void *closure, const struct afb_svc *svc, const char *api, const char *verb, struct json_object *args);
 206         void (*hook_svc_callsync_result)(void *closure, const struct afb_svc *svc, int status, struct json_object *result);
 207 };
 208
 209 extern void afb_hook_svc_start_before(const struct afb_svc *svc);
 210 extern int afb_hook_svc_start_after(const struct afb_svc *svc, int status);
 211 extern void afb_hook_svc_on_event_before(const struct afb_svc *svc, const char *event, int eventid, struct json_object *object);
 212 extern void afb_hook_svc_on_event_after(const struct afb_svc *svc, const char *event, int eventid, struct json_object *object);
 213 extern void afb_hook_svc_call(const struct afb_svc *svc, const char *api, const char *verb, struct json_object *args);
 214 extern void afb_hook_svc_call_result(const struct afb_svc *svc, int status, struct json_object *result);
 215 extern void afb_hook_svc_callsync(const struct afb_svc *svc, const char *api, const char *verb, struct json_object *args);
 216 extern int afb_hook_svc_callsync_result(const struct afb_svc *svc, int status, struct json_object *result);
 217
 218 extern int afb_hook_flags_svc(const char *api);
 219 extern struct afb_hook_svc *afb_hook_create_svc(const char *api, int flags, struct afb_hook_svc_itf *itf, void *closure);
 220 extern struct afb_hook_svc *afb_hook_addref_svc(struct afb_hook_svc *hook);
 221 extern void afb_hook_unref_svc(struct afb_hook_svc *hook);
 222