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