2 * Copyright (C) 2016, 2017 "IoT.bzh"
3 * Author José Bollo <jose.bollo@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
31 struct afb_stored_req;
38 struct afb_hook_global;
40 /*********************************************************
42 *********************************************************/
45 unsigned id; /* id of the hook event */
46 struct timespec time; /* time of the hook event */
49 /*********************************************************
50 * section hooking xreq
51 *********************************************************/
53 /* individual flags */
54 #define afb_hook_flag_req_begin 0x00000001
55 #define afb_hook_flag_req_end 0x00000002
56 #define afb_hook_flag_req_json 0x00000004
57 #define afb_hook_flag_req_get 0x00000008
58 #define afb_hook_flag_req_success 0x00000010
59 #define afb_hook_flag_req_fail 0x00000020
60 #define afb_hook_flag_req_context_get 0x00000040
61 #define afb_hook_flag_req_context_set 0x00000080
62 #define afb_hook_flag_req_addref 0x00000100
63 #define afb_hook_flag_req_unref 0x00000200
64 #define afb_hook_flag_req_session_close 0x00000400
65 #define afb_hook_flag_req_session_set_LOA 0x00000800
66 #define afb_hook_flag_req_subscribe 0x00001000
67 #define afb_hook_flag_req_unsubscribe 0x00002000
68 #define afb_hook_flag_req_subcall 0x00004000
69 #define afb_hook_flag_req_subcall_result 0x00008000
70 #define afb_hook_flag_req_subcallsync 0x00010000
71 #define afb_hook_flag_req_subcallsync_result 0x00020000
72 #define afb_hook_flag_req_vverbose 0x00040000
73 #define afb_hook_flag_req_store 0x00080000
74 #define afb_hook_flag_req_unstore 0x00100000
75 #define afb_hook_flag_req_subcall_req 0x00200000
76 #define afb_hook_flag_req_subcall_req_result 0x00400000
77 #define afb_hook_flag_req_has_permission 0x00800000
80 #define afb_hook_flags_req_life (afb_hook_flag_req_begin|afb_hook_flag_req_end)
81 #define afb_hook_flags_req_args (afb_hook_flag_req_json|afb_hook_flag_req_get)
82 #define afb_hook_flags_req_result (afb_hook_flag_req_success|afb_hook_flag_req_fail)
83 #define afb_hook_flags_req_session (afb_hook_flag_req_session_close|afb_hook_flag_req_session_set_LOA)
84 #define afb_hook_flags_req_event (afb_hook_flag_req_subscribe|afb_hook_flag_req_unsubscribe)
85 #define afb_hook_flags_req_subcalls (afb_hook_flag_req_subcall|afb_hook_flag_req_subcall_result\
86 |afb_hook_flag_req_subcall_req|afb_hook_flag_req_subcall_req_result\
87 |afb_hook_flag_req_subcallsync|afb_hook_flag_req_subcallsync_result)
90 #define afb_hook_flags_req_ref (afb_hook_flag_req_addref|afb_hook_flag_req_unref)
91 #define afb_hook_flags_req_context (afb_hook_flag_req_context_get|afb_hook_flag_req_context_set)
92 #define afb_hook_flags_req_stores (afb_hook_flag_req_store|afb_hook_flag_req_unstore)
94 /* predefined groups */
95 #define afb_hook_flags_req_common (afb_hook_flags_req_life|afb_hook_flags_req_args|afb_hook_flags_req_result\
96 |afb_hook_flags_req_session|afb_hook_flags_req_event|afb_hook_flags_req_subcalls\
97 |afb_hook_flag_req_vverbose|afb_hook_flag_req_has_permission)
98 #define afb_hook_flags_req_extra (afb_hook_flags_req_common|afb_hook_flags_req_ref|afb_hook_flags_req_context\
99 |afb_hook_flags_req_stores)
100 #define afb_hook_flags_req_all (afb_hook_flags_req_extra)
102 struct afb_hook_xreq_itf {
103 void (*hook_xreq_begin)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq);
104 void (*hook_xreq_end)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq);
105 void (*hook_xreq_json)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct json_object *obj);
106 void (*hook_xreq_get)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *name, struct afb_arg arg);
107 void (*hook_xreq_success)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct json_object *obj, const char *info);
108 void (*hook_xreq_fail)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *status, const char *info);
109 void (*hook_xreq_context_get)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, void *value);
110 void (*hook_xreq_context_set)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, void *value, void (*free_value)(void*));
111 void (*hook_xreq_addref)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq);
112 void (*hook_xreq_unref)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq);
113 void (*hook_xreq_session_close)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq);
114 void (*hook_xreq_session_set_LOA)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, unsigned level, int result);
115 void (*hook_xreq_subscribe)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_event event, int result);
116 void (*hook_xreq_unsubscribe)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_event event, int result);
117 void (*hook_xreq_subcall)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
118 void (*hook_xreq_subcall_result)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int status, struct json_object *result);
119 void (*hook_xreq_subcallsync)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
120 void (*hook_xreq_subcallsync_result)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int status, struct json_object *result);
121 void (*hook_xreq_vverbose)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int level, const char *file, int line, const char *func, const char *fmt, va_list args);
122 void (*hook_xreq_store)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_stored_req *sreq);
123 void (*hook_xreq_unstore)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq);
124 void (*hook_xreq_subcall_req)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
125 void (*hook_xreq_subcall_req_result)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int status, struct json_object *result);
126 void (*hook_xreq_has_permission)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *permission, int result);
129 extern void afb_hook_init_xreq(struct afb_xreq *xreq);
131 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);
132 extern struct afb_hook_xreq *afb_hook_addref_xreq(struct afb_hook_xreq *spec);
133 extern void afb_hook_unref_xreq(struct afb_hook_xreq *spec);
136 extern void afb_hook_xreq_begin(const struct afb_xreq *xreq);
137 extern void afb_hook_xreq_end(const struct afb_xreq *xreq);
138 extern struct json_object *afb_hook_xreq_json(const struct afb_xreq *xreq, struct json_object *obj);
139 extern struct afb_arg afb_hook_xreq_get(const struct afb_xreq *xreq, const char *name, struct afb_arg arg);
140 extern void afb_hook_xreq_success(const struct afb_xreq *xreq, struct json_object *obj, const char *info);
141 extern void afb_hook_xreq_fail(const struct afb_xreq *xreq, const char *status, const char *info);
142 extern void *afb_hook_xreq_context_get(const struct afb_xreq *xreq, void *value);
143 extern void afb_hook_xreq_context_set(const struct afb_xreq *xreq, void *value, void (*free_value)(void*));
144 extern void afb_hook_xreq_addref(const struct afb_xreq *xreq);
145 extern void afb_hook_xreq_unref(const struct afb_xreq *xreq);
146 extern void afb_hook_xreq_session_close(const struct afb_xreq *xreq);
147 extern int afb_hook_xreq_session_set_LOA(const struct afb_xreq *xreq, unsigned level, int result);
148 extern int afb_hook_xreq_subscribe(const struct afb_xreq *xreq, struct afb_event event, int result);
149 extern int afb_hook_xreq_unsubscribe(const struct afb_xreq *xreq, struct afb_event event, int result);
150 extern void afb_hook_xreq_subcall(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
151 extern void afb_hook_xreq_subcall_result(const struct afb_xreq *xreq, int status, struct json_object *result);
152 extern void afb_hook_xreq_subcallsync(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
153 extern int afb_hook_xreq_subcallsync_result(const struct afb_xreq *xreq, int status, struct json_object *result);
154 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);
155 extern void afb_hook_xreq_store(const struct afb_xreq *xreq, struct afb_stored_req *sreq);
156 extern void afb_hook_xreq_unstore(const struct afb_xreq *xreq);
157 extern void afb_hook_xreq_subcall_req(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
158 extern void afb_hook_xreq_subcall_req_result(const struct afb_xreq *xreq, int status, struct json_object *result);
159 extern int afb_hook_xreq_has_permission(const struct afb_xreq *xreq, const char *permission, int result);
161 /*********************************************************
162 * section hooking export (daemon interface)
163 *********************************************************/
165 #define afb_hook_flag_ditf_vverbose 0x000001
166 #define afb_hook_flag_ditf_event_make 0x000002
167 #define afb_hook_flag_ditf_event_broadcast_before 0x000004
168 #define afb_hook_flag_ditf_event_broadcast_after 0x000008
169 #define afb_hook_flag_ditf_get_event_loop 0x000010
170 #define afb_hook_flag_ditf_get_user_bus 0x000020
171 #define afb_hook_flag_ditf_get_system_bus 0x000040
172 #define afb_hook_flag_ditf_rootdir_get_fd 0x000080
173 #define afb_hook_flag_ditf_rootdir_open_locale 0x000100
174 #define afb_hook_flag_ditf_queue_job 0x000200
175 #define afb_hook_flag_ditf_unstore_req 0x000400
176 #define afb_hook_flag_ditf_require_api 0x000800
177 #define afb_hook_flag_ditf_require_api_result 0x001000
178 #define afb_hook_flag_ditf_rename_api 0x002000
180 #define afb_hook_flags_ditf_common (afb_hook_flag_ditf_vverbose\
181 |afb_hook_flag_ditf_event_make\
182 |afb_hook_flag_ditf_event_broadcast_before\
183 |afb_hook_flag_ditf_event_broadcast_after\
184 |afb_hook_flag_ditf_rename_api)
185 #define afb_hook_flags_ditf_extra (afb_hook_flag_ditf_get_event_loop\
186 |afb_hook_flag_ditf_get_user_bus\
187 |afb_hook_flag_ditf_get_system_bus\
188 |afb_hook_flag_ditf_rootdir_get_fd\
189 |afb_hook_flag_ditf_rootdir_open_locale\
190 |afb_hook_flag_ditf_queue_job\
191 |afb_hook_flag_ditf_unstore_req\
192 |afb_hook_flag_ditf_require_api\
193 |afb_hook_flag_ditf_require_api_result)
195 #define afb_hook_flags_ditf_all (afb_hook_flags_ditf_common|afb_hook_flags_ditf_extra)
197 struct afb_hook_ditf_itf {
198 void (*hook_ditf_event_broadcast_before)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct json_object *object);
199 void (*hook_ditf_event_broadcast_after)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct json_object *object, int result);
200 void (*hook_ditf_get_event_loop)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_event *result);
201 void (*hook_ditf_get_user_bus)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_bus *result);
202 void (*hook_ditf_get_system_bus)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_bus *result);
203 void (*hook_ditf_vverbose)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int level, const char *file, int line, const char *function, const char *fmt, va_list args);
204 void (*hook_ditf_event_make)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct afb_event result);
205 void (*hook_ditf_rootdir_get_fd)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result);
206 void (*hook_ditf_rootdir_open_locale)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *filename, int flags, const char *locale, int result);
207 void (*hook_ditf_queue_job)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout, int result);
208 void (*hook_ditf_unstore_req)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct afb_stored_req *sreq);
209 void (*hook_ditf_require_api)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, int initialized);
210 void (*hook_ditf_require_api_result)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, int initialized, int result);
211 void (*hook_ditf_rename_api)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *oldname, const char *newname, int result);
214 extern void afb_hook_ditf_event_broadcast_before(const struct afb_export *export, const char *name, struct json_object *object);
215 extern int afb_hook_ditf_event_broadcast_after(const struct afb_export *export, const char *name, struct json_object *object, int result);
216 extern struct sd_event *afb_hook_ditf_get_event_loop(const struct afb_export *export, struct sd_event *result);
217 extern struct sd_bus *afb_hook_ditf_get_user_bus(const struct afb_export *export, struct sd_bus *result);
218 extern struct sd_bus *afb_hook_ditf_get_system_bus(const struct afb_export *export, struct sd_bus *result);
219 extern void afb_hook_ditf_vverbose(const struct afb_export *export, int level, const char *file, int line, const char *function, const char *fmt, va_list args);
220 extern struct afb_event afb_hook_ditf_event_make(const struct afb_export *export, const char *name, struct afb_event result);
221 extern int afb_hook_ditf_rootdir_get_fd(const struct afb_export *export, int result);
222 extern int afb_hook_ditf_rootdir_open_locale(const struct afb_export *export, const char *filename, int flags, const char *locale, int result);
223 extern int afb_hook_ditf_queue_job(const struct afb_export *export, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout, int result);
224 extern void afb_hook_ditf_unstore_req(const struct afb_export *export, struct afb_stored_req *sreq);
225 extern void afb_hook_ditf_require_api(const struct afb_export *export, const char *name, int initialized);
226 extern int afb_hook_ditf_require_api_result(const struct afb_export *export, const char *name, int initialized, int result);
227 extern int afb_hook_ditf_rename_api(const struct afb_export *export, const char *oldname, const char *newname, int result);
229 extern int afb_hook_flags_ditf(const char *api);
230 extern struct afb_hook_ditf *afb_hook_create_ditf(const char *api, int flags, struct afb_hook_ditf_itf *itf, void *closure);
231 extern struct afb_hook_ditf *afb_hook_addref_ditf(struct afb_hook_ditf *hook);
232 extern void afb_hook_unref_ditf(struct afb_hook_ditf *hook);
234 /*********************************************************
235 * section hooking export (service interface)
236 *********************************************************/
238 #define afb_hook_flag_svc_start_before 0x000001
239 #define afb_hook_flag_svc_start_after 0x000002
240 #define afb_hook_flag_svc_on_event_before 0x000004
241 #define afb_hook_flag_svc_on_event_after 0x000008
242 #define afb_hook_flag_svc_call 0x000010
243 #define afb_hook_flag_svc_call_result 0x000020
244 #define afb_hook_flag_svc_callsync 0x000040
245 #define afb_hook_flag_svc_callsync_result 0x000080
247 #define afb_hook_flags_svc_all (afb_hook_flag_svc_start_before|afb_hook_flag_svc_start_after\
248 |afb_hook_flag_svc_on_event_before|afb_hook_flag_svc_on_event_after\
249 |afb_hook_flag_svc_call|afb_hook_flag_svc_call_result\
250 |afb_hook_flag_svc_callsync|afb_hook_flag_svc_callsync_result)
252 struct afb_hook_svc_itf {
253 void (*hook_svc_start_before)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export);
254 void (*hook_svc_start_after)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int status);
255 void (*hook_svc_on_event_before)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *event, int eventid, struct json_object *object);
256 void (*hook_svc_on_event_after)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *event, int eventid, struct json_object *object);
257 void (*hook_svc_call)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *api, const char *verb, struct json_object *args);
258 void (*hook_svc_call_result)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int status, struct json_object *result);
259 void (*hook_svc_callsync)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *api, const char *verb, struct json_object *args);
260 void (*hook_svc_callsync_result)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int status, struct json_object *result);
263 extern void afb_hook_svc_start_before(const struct afb_export *export);
264 extern int afb_hook_svc_start_after(const struct afb_export *export, int status);
265 extern void afb_hook_svc_on_event_before(const struct afb_export *export, const char *event, int eventid, struct json_object *object);
266 extern void afb_hook_svc_on_event_after(const struct afb_export *export, const char *event, int eventid, struct json_object *object);
267 extern void afb_hook_svc_call(const struct afb_export *export, const char *api, const char *verb, struct json_object *args);
268 extern void afb_hook_svc_call_result(const struct afb_export *export, int status, struct json_object *result);
269 extern void afb_hook_svc_callsync(const struct afb_export *export, const char *api, const char *verb, struct json_object *args);
270 extern int afb_hook_svc_callsync_result(const struct afb_export *export, int status, struct json_object *result);
272 extern int afb_hook_flags_svc(const char *api);
273 extern struct afb_hook_svc *afb_hook_create_svc(const char *api, int flags, struct afb_hook_svc_itf *itf, void *closure);
274 extern struct afb_hook_svc *afb_hook_addref_svc(struct afb_hook_svc *hook);
275 extern void afb_hook_unref_svc(struct afb_hook_svc *hook);
277 /*********************************************************
278 * section hooking evt (event interface)
279 *********************************************************/
281 #define afb_hook_flag_evt_create 0x000001
282 #define afb_hook_flag_evt_push_before 0x000002
283 #define afb_hook_flag_evt_push_after 0x000004
284 #define afb_hook_flag_evt_broadcast_before 0x000008
285 #define afb_hook_flag_evt_broadcast_after 0x000010
286 #define afb_hook_flag_evt_name 0x000020
287 #define afb_hook_flag_evt_drop 0x000040
289 #define afb_hook_flags_evt_common (afb_hook_flag_evt_push_before|afb_hook_flag_evt_broadcast_before)
290 #define afb_hook_flags_evt_extra (afb_hook_flags_evt_common\
291 |afb_hook_flag_evt_push_after|afb_hook_flag_evt_broadcast_after\
292 |afb_hook_flag_evt_create|afb_hook_flag_evt_drop)
293 #define afb_hook_flags_evt_all (afb_hook_flags_evt_extra|afb_hook_flag_evt_name)
295 struct afb_hook_evt_itf {
296 void (*hook_evt_create)(void *closure, const struct afb_hookid *hookid, const char *evt, int id);
297 void (*hook_evt_push_before)(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj);
298 void (*hook_evt_push_after)(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj, int result);
299 void (*hook_evt_broadcast_before)(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj);
300 void (*hook_evt_broadcast_after)(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj, int result);
301 void (*hook_evt_name)(void *closure, const struct afb_hookid *hookid, const char *evt, int id);
302 void (*hook_evt_drop)(void *closure, const struct afb_hookid *hookid, const char *evt, int id);
305 extern void afb_hook_evt_create(const char *evt, int id);
306 extern void afb_hook_evt_push_before(const char *evt, int id, struct json_object *obj);
307 extern int afb_hook_evt_push_after(const char *evt, int id, struct json_object *obj, int result);
308 extern void afb_hook_evt_broadcast_before(const char *evt, int id, struct json_object *obj);
309 extern int afb_hook_evt_broadcast_after(const char *evt, int id, struct json_object *obj, int result);
310 extern void afb_hook_evt_name(const char *evt, int id);
311 extern void afb_hook_evt_drop(const char *evt, int id);
313 extern int afb_hook_flags_evt(const char *name);
314 extern struct afb_hook_evt *afb_hook_create_evt(const char *pattern, int flags, struct afb_hook_evt_itf *itf, void *closure);
315 extern struct afb_hook_evt *afb_hook_addref_evt(struct afb_hook_evt *hook);
316 extern void afb_hook_unref_evt(struct afb_hook_evt *hook);
318 /*********************************************************
319 * section hooking global (global interface)
320 *********************************************************/
322 #define afb_hook_flag_global_vverbose 0x000001
324 #define afb_hook_flags_global_all (afb_hook_flag_global_vverbose)
326 struct afb_hook_global_itf {
327 void (*hook_global_vverbose)(void *closure, const struct afb_hookid *hookid, int level, const char *file, int line, const char *function, const char *fmt, va_list args);
330 extern struct afb_hook_global *afb_hook_create_global(int flags, struct afb_hook_global_itf *itf, void *closure);
331 extern struct afb_hook_global *afb_hook_addref_global(struct afb_hook_global *hook);
332 extern void afb_hook_unref_global(struct afb_hook_global *hook);