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 sd_bus;
  29 struct sd_event;
  30
  31 /*********************************************************
  32 * section hooking xreq
  33 *********************************************************/
  34 struct afb_hook_xreq;
  35
  36 /* individual flags */
  37 #define afb_hook_flag_req_begin                 0x000001
  38 #define afb_hook_flag_req_end                   0x000002
  39 #define afb_hook_flag_req_json                  0x000004
  40 #define afb_hook_flag_req_get                   0x000008
  41 #define afb_hook_flag_req_success               0x000010
  42 #define afb_hook_flag_req_fail                  0x000020
  43 #define afb_hook_flag_req_raw                   0x000040
  44 #define afb_hook_flag_req_send                  0x000080
  45 #define afb_hook_flag_req_context_get           0x000100
  46 #define afb_hook_flag_req_context_set           0x000200
  47 #define afb_hook_flag_req_addref                0x000400
  48 #define afb_hook_flag_req_unref                 0x000800
  49 #define afb_hook_flag_req_session_close         0x001000
  50 #define afb_hook_flag_req_session_set_LOA       0x002000
  51 #define afb_hook_flag_req_subscribe             0x004000
  52 #define afb_hook_flag_req_unsubscribe           0x010800
  53 #define afb_hook_flag_req_subcall               0x020000
  54 #define afb_hook_flag_req_subcall_result        0x040000
  55 #define afb_hook_flag_req_subcallsync           0x080000
  56 #define afb_hook_flag_req_subcallsync_result    0x100000
  57
  58 /* common flags */
  59 #define afb_hook_flags_req_life         (afb_hook_flag_req_begin|afb_hook_flag_req_end)
  60 #define afb_hook_flags_req_args         (afb_hook_flag_req_json|afb_hook_flag_req_get)
  61 #define afb_hook_flags_req_result       (afb_hook_flag_req_success|afb_hook_flag_req_fail)
  62 #define afb_hook_flags_req_session      (afb_hook_flag_req_session_close|afb_hook_flag_req_session_set_LOA)
  63 #define afb_hook_flags_req_event        (afb_hook_flag_req_subscribe|afb_hook_flag_req_unsubscribe)
  64 #define afb_hook_flags_req_subcall      (afb_hook_flag_req_subcall|afb_hook_flag_req_subcall_result\
  65                                         |afb_hook_flag_req_subcallsync|afb_hook_flag_req_subcallsync_result)
  66
  67 /* extra flags */
  68 #define afb_hook_flags_req_ref          (afb_hook_flag_req_addref|afb_hook_flag_req_unref)
  69 #define afb_hook_flags_req_context      (afb_hook_flag_req_context_get|afb_hook_flag_req_context_set)
  70
  71 /* internal flags */
  72 #define afb_hook_flags_req_internal     (afb_hook_flag_req_raw|afb_hook_flag_req_send)
  73
  74 /* predefined groups */
  75 #define afb_hook_flags_req_common       (afb_hook_flags_req_life|afb_hook_flags_req_args|afb_hook_flags_req_result\
  76                                         |afb_hook_flags_req_session|afb_hook_flags_req_event|afb_hook_flags_req_subcall)
  77 #define afb_hook_flags_req_extra        (afb_hook_flags_req_common|afb_hook_flags_req_ref|afb_hook_flags_req_context)
  78 #define afb_hook_flags_req_all          (afb_hook_flags_req_extra|afb_hook_flags_req_internal)
  79
  80 struct afb_hook_xreq_itf {
  81         void (*hook_xreq_begin)(void * closure, const struct afb_xreq *xreq);
  82         void (*hook_xreq_end)(void * closure, const struct afb_xreq *xreq);
  83         void (*hook_xreq_json)(void * closure, const struct afb_xreq *xreq, struct json_object *obj);
  84         void (*hook_xreq_get)(void * closure, const struct afb_xreq *xreq, const char *name, struct afb_arg arg);
  85         void (*hook_xreq_success)(void * closure, const struct afb_xreq *xreq, struct json_object *obj, const char *info);
  86         void (*hook_xreq_fail)(void * closure, const struct afb_xreq *xreq, const char *status, const char *info);
  87         void (*hook_xreq_raw)(void * closure, const struct afb_xreq *xreq, const char *buffer, size_t size);
  88         void (*hook_xreq_send)(void * closure, const struct afb_xreq *xreq, const char *buffer, size_t size);
  89         void (*hook_xreq_context_get)(void * closure, const struct afb_xreq *xreq, void *value);
  90         void (*hook_xreq_context_set)(void * closure, const struct afb_xreq *xreq, void *value, void (*free_value)(void*));
  91         void (*hook_xreq_addref)(void * closure, const struct afb_xreq *xreq);
  92         void (*hook_xreq_unref)(void * closure, const struct afb_xreq *xreq);
  93         void (*hook_xreq_session_close)(void * closure, const struct afb_xreq *xreq);
  94         void (*hook_xreq_session_set_LOA)(void * closure, const struct afb_xreq *xreq, unsigned level, int result);
  95         void (*hook_xreq_subscribe)(void * closure, const struct afb_xreq *xreq, struct afb_event event, int result);
  96         void (*hook_xreq_unsubscribe)(void * closure, const struct afb_xreq *xreq, struct afb_event event, int result);
  97         void (*hook_xreq_subcall)(void * closure, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
  98         void (*hook_xreq_subcall_result)(void * closure, const struct afb_xreq *xreq, int status, struct json_object *result);
  99         void (*hook_xreq_subcallsync)(void * closure, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
 100         void (*hook_xreq_subcallsync_result)(void * closure, const struct afb_xreq *xreq, int status, struct json_object *result);
 101 };
 102
 103 extern void afb_hook_init_xreq(struct afb_xreq *xreq);
 104
 105 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);
 106 extern struct afb_hook_xreq *afb_hook_addref_xreq(struct afb_hook_xreq *spec);
 107 extern void afb_hook_unref_xreq(struct afb_hook_xreq *spec);
 108
 109 /* hooks for xreq */
 110 extern void afb_hook_xreq_begin(const struct afb_xreq *xreq);
 111 extern void afb_hook_xreq_end(const struct afb_xreq *xreq);
 112 extern struct json_object *afb_hook_xreq_json(const struct afb_xreq *xreq, struct json_object *obj);
 113 extern struct afb_arg afb_hook_xreq_get(const struct afb_xreq *xreq, const char *name, struct afb_arg arg);
 114 extern void afb_hook_xreq_success(const struct afb_xreq *xreq, struct json_object *obj, const char *info);
 115 extern void afb_hook_xreq_fail(const struct afb_xreq *xreq, const char *status, const char *info);
 116 extern const char *afb_hook_xreq_raw(const struct afb_xreq *xreq, const char *buffer, size_t size);
 117 extern void afb_hook_xreq_send(const struct afb_xreq *xreq, const char *buffer, size_t size);
 118 extern void *afb_hook_xreq_context_get(const struct afb_xreq *xreq, void *value);
 119 extern void afb_hook_xreq_context_set(const struct afb_xreq *xreq, void *value, void (*free_value)(void*));
 120 extern void afb_hook_xreq_addref(const struct afb_xreq *xreq);
 121 extern void afb_hook_xreq_unref(const struct afb_xreq *xreq);
 122 extern void afb_hook_xreq_session_close(const struct afb_xreq *xreq);
 123 extern int afb_hook_xreq_session_set_LOA(const struct afb_xreq *xreq, unsigned level, int result);
 124 extern int afb_hook_xreq_subscribe(const struct afb_xreq *xreq, struct afb_event event, int result);
 125 extern int afb_hook_xreq_unsubscribe(const struct afb_xreq *xreq, struct afb_event event, int result);
 126 extern void afb_hook_xreq_subcall(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
 127 extern void afb_hook_xreq_subcall_result(const struct afb_xreq *xreq, int status, struct json_object *result);
 128 extern void afb_hook_xreq_subcallsync(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
 129 extern int afb_hook_xreq_subcallsync_result(const struct afb_xreq *xreq, int status, struct json_object *result);
 130
 131 /*********************************************************
 132 * section hooking ditf
 133 *********************************************************/
 134
 135 #define afb_hook_flag_ditf_vverbose                     0x000001
 136 #define afb_hook_flag_ditf_event_make                   0x000002
 137 #define afb_hook_flag_ditf_event_broadcast_before       0x000004
 138 #define afb_hook_flag_ditf_event_broadcast_after        0x000008
 139 #define afb_hook_flag_ditf_get_event_loop               0x000010
 140 #define afb_hook_flag_ditf_get_user_bus                 0x000020
 141 #define afb_hook_flag_ditf_get_system_bus               0x000040
 142 #define afb_hook_flag_ditf_rootdir_get_fd               0x000080
 143 #define afb_hook_flag_ditf_rootdir_open_locale          0x000100
 144 #define afb_hook_flag_ditf_queue_job                    0x000200
 145
 146 #define afb_hook_flags_ditf_common      (afb_hook_flag_ditf_vverbose\
 147                                         |afb_hook_flag_ditf_event_make\
 148                                         |afb_hook_flag_ditf_event_broadcast_before\
 149                                         |afb_hook_flag_ditf_event_broadcast_after)
 150 #define afb_hook_flags_ditf_extra       (afb_hook_flag_ditf_get_event_loop\
 151                                         |afb_hook_flag_ditf_get_user_bus\
 152                                         |afb_hook_flag_ditf_get_system_bus\
 153                                         |afb_hook_flag_ditf_rootdir_get_fd\
 154                                         |afb_hook_flag_ditf_rootdir_open_locale\
 155                                         |afb_hook_flag_ditf_queue_job)
 156
 157 #define afb_hook_flags_ditf_all         (afb_hook_flags_ditf_common|afb_hook_flags_ditf_extra)
 158
 159 struct afb_hook_ditf_itf {
 160         void (*hook_ditf_event_broadcast_before)(void *closure, const struct afb_ditf *ditf, const char *name, struct json_object *object);
 161         void (*hook_ditf_event_broadcast_after)(void *closure, const struct afb_ditf *ditf, const char *name, struct json_object *object, int result);
 162         void (*hook_ditf_get_event_loop)(void *closure, const struct afb_ditf *ditf, struct sd_event *result);
 163         void (*hook_ditf_get_user_bus)(void *closure, const struct afb_ditf *ditf, struct sd_bus *result);
 164         void (*hook_ditf_get_system_bus)(void *closure, const struct afb_ditf *ditf, struct sd_bus *result);
 165         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);
 166         void (*hook_ditf_event_make)(void *closure, const struct afb_ditf *ditf, const char *name, struct afb_event result);
 167         void (*hook_ditf_rootdir_get_fd)(void *closure, const struct afb_ditf *ditf, int result);
 168         void (*hook_ditf_rootdir_open_locale)(void *closure, const struct afb_ditf *ditf, const char *filename, int flags, const char *locale, int result);
 169         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);
 170 };
 171
 172 extern void afb_hook_ditf_event_broadcast_before(const struct afb_ditf *ditf, const char *name, struct json_object *object);
 173 extern int afb_hook_ditf_event_broadcast_after(const struct afb_ditf *ditf, const char *name, struct json_object *object, int result);
 174 extern struct sd_event *afb_hook_ditf_get_event_loop(const struct afb_ditf *ditf, struct sd_event *result);
 175 extern struct sd_bus *afb_hook_ditf_get_user_bus(const struct afb_ditf *ditf, struct sd_bus *result);
 176 extern struct sd_bus *afb_hook_ditf_get_system_bus(const struct afb_ditf *ditf, struct sd_bus *result);
 177 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);
 178 extern struct afb_event afb_hook_ditf_event_make(const struct afb_ditf *ditf, const char *name, struct afb_event result);
 179 extern int afb_hook_ditf_rootdir_get_fd(const struct afb_ditf *ditf, int result);
 180 extern int afb_hook_ditf_rootdir_open_locale(const struct afb_ditf *ditf, const char *filename, int flags, const char *locale, int result);
 181 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);
 182
 183 extern int afb_hook_flags_ditf(const char *api);
 184 extern struct afb_hook_ditf *afb_hook_create_ditf(const char *api, int flags, struct afb_hook_ditf_itf *itf, void *closure);
 185 extern struct afb_hook_ditf *afb_hook_addref_ditf(struct afb_hook_ditf *hook);
 186 extern void afb_hook_unref_ditf(struct afb_hook_ditf *hook);
 187