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.
34 /*********************************************************
35 * section hooking xreq
36 *********************************************************/
39 /* individual flags */
40 #define afb_hook_flag_req_begin 0x000001
41 #define afb_hook_flag_req_end 0x000002
42 #define afb_hook_flag_req_json 0x000004
43 #define afb_hook_flag_req_get 0x000008
44 #define afb_hook_flag_req_success 0x000010
45 #define afb_hook_flag_req_fail 0x000020
46 #define afb_hook_flag_req_context_get 0x000040
47 #define afb_hook_flag_req_context_set 0x000080
48 #define afb_hook_flag_req_addref 0x000100
49 #define afb_hook_flag_req_unref 0x000200
50 #define afb_hook_flag_req_session_close 0x000400
51 #define afb_hook_flag_req_session_set_LOA 0x000800
52 #define afb_hook_flag_req_subscribe 0x001000
53 #define afb_hook_flag_req_unsubscribe 0x002000
54 #define afb_hook_flag_req_subcall 0x004000
55 #define afb_hook_flag_req_subcall_result 0x010800
56 #define afb_hook_flag_req_subcallsync 0x020000
57 #define afb_hook_flag_req_subcallsync_result 0x040000
58 #define afb_hook_flag_req_vverbose 0x080000
61 #define afb_hook_flags_req_life (afb_hook_flag_req_begin|afb_hook_flag_req_end)
62 #define afb_hook_flags_req_args (afb_hook_flag_req_json|afb_hook_flag_req_get)
63 #define afb_hook_flags_req_result (afb_hook_flag_req_success|afb_hook_flag_req_fail)
64 #define afb_hook_flags_req_session (afb_hook_flag_req_session_close|afb_hook_flag_req_session_set_LOA)
65 #define afb_hook_flags_req_event (afb_hook_flag_req_subscribe|afb_hook_flag_req_unsubscribe)
66 #define afb_hook_flags_req_subcall (afb_hook_flag_req_subcall|afb_hook_flag_req_subcall_result\
67 |afb_hook_flag_req_subcallsync|afb_hook_flag_req_subcallsync_result)
70 #define afb_hook_flags_req_ref (afb_hook_flag_req_addref|afb_hook_flag_req_unref)
71 #define afb_hook_flags_req_context (afb_hook_flag_req_context_get|afb_hook_flag_req_context_set)
73 /* predefined groups */
74 #define afb_hook_flags_req_common (afb_hook_flags_req_life|afb_hook_flags_req_args|afb_hook_flags_req_result\
75 |afb_hook_flags_req_session|afb_hook_flags_req_event|afb_hook_flags_req_subcall\
76 |afb_hook_flag_req_vverbose)
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)
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_context_get)(void * closure, const struct afb_xreq *xreq, void *value);
88 void (*hook_xreq_context_set)(void * closure, const struct afb_xreq *xreq, void *value, void (*free_value)(void*));
89 void (*hook_xreq_addref)(void * closure, const struct afb_xreq *xreq);
90 void (*hook_xreq_unref)(void * closure, const struct afb_xreq *xreq);
91 void (*hook_xreq_session_close)(void * closure, const struct afb_xreq *xreq);
92 void (*hook_xreq_session_set_LOA)(void * closure, const struct afb_xreq *xreq, unsigned level, int result);
93 void (*hook_xreq_subscribe)(void * closure, const struct afb_xreq *xreq, struct afb_event event, int result);
94 void (*hook_xreq_unsubscribe)(void * closure, const struct afb_xreq *xreq, struct afb_event event, int result);
95 void (*hook_xreq_subcall)(void * closure, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
96 void (*hook_xreq_subcall_result)(void * closure, const struct afb_xreq *xreq, int status, struct json_object *result);
97 void (*hook_xreq_subcallsync)(void * closure, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
98 void (*hook_xreq_subcallsync_result)(void * closure, const struct afb_xreq *xreq, int status, struct json_object *result);
99 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);
102 extern void afb_hook_init_xreq(struct afb_xreq *xreq);
104 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);
105 extern struct afb_hook_xreq *afb_hook_addref_xreq(struct afb_hook_xreq *spec);
106 extern void afb_hook_unref_xreq(struct afb_hook_xreq *spec);
109 extern void afb_hook_xreq_begin(const struct afb_xreq *xreq);
110 extern void afb_hook_xreq_end(const struct afb_xreq *xreq);
111 extern struct json_object *afb_hook_xreq_json(const struct afb_xreq *xreq, struct json_object *obj);
112 extern struct afb_arg afb_hook_xreq_get(const struct afb_xreq *xreq, const char *name, struct afb_arg arg);
113 extern void afb_hook_xreq_success(const struct afb_xreq *xreq, struct json_object *obj, const char *info);
114 extern void afb_hook_xreq_fail(const struct afb_xreq *xreq, const char *status, const char *info);
115 extern void *afb_hook_xreq_context_get(const struct afb_xreq *xreq, void *value);
116 extern void afb_hook_xreq_context_set(const struct afb_xreq *xreq, void *value, void (*free_value)(void*));
117 extern void afb_hook_xreq_addref(const struct afb_xreq *xreq);
118 extern void afb_hook_xreq_unref(const struct afb_xreq *xreq);
119 extern void afb_hook_xreq_session_close(const struct afb_xreq *xreq);
120 extern int afb_hook_xreq_session_set_LOA(const struct afb_xreq *xreq, unsigned level, int result);
121 extern int afb_hook_xreq_subscribe(const struct afb_xreq *xreq, struct afb_event event, int result);
122 extern int afb_hook_xreq_unsubscribe(const struct afb_xreq *xreq, struct afb_event event, int result);
123 extern void afb_hook_xreq_subcall(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
124 extern void afb_hook_xreq_subcall_result(const struct afb_xreq *xreq, int status, struct json_object *result);
125 extern void afb_hook_xreq_subcallsync(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
126 extern int afb_hook_xreq_subcallsync_result(const struct afb_xreq *xreq, int status, struct json_object *result);
127 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);
129 /*********************************************************
130 * section hooking ditf (daemon interface)
131 *********************************************************/
133 #define afb_hook_flag_ditf_vverbose 0x000001
134 #define afb_hook_flag_ditf_event_make 0x000002
135 #define afb_hook_flag_ditf_event_broadcast_before 0x000004
136 #define afb_hook_flag_ditf_event_broadcast_after 0x000008
137 #define afb_hook_flag_ditf_get_event_loop 0x000010
138 #define afb_hook_flag_ditf_get_user_bus 0x000020
139 #define afb_hook_flag_ditf_get_system_bus 0x000040
140 #define afb_hook_flag_ditf_rootdir_get_fd 0x000080
141 #define afb_hook_flag_ditf_rootdir_open_locale 0x000100
142 #define afb_hook_flag_ditf_queue_job 0x000200
144 #define afb_hook_flags_ditf_common (afb_hook_flag_ditf_vverbose\
145 |afb_hook_flag_ditf_event_make\
146 |afb_hook_flag_ditf_event_broadcast_before\
147 |afb_hook_flag_ditf_event_broadcast_after)
148 #define afb_hook_flags_ditf_extra (afb_hook_flag_ditf_get_event_loop\
149 |afb_hook_flag_ditf_get_user_bus\
150 |afb_hook_flag_ditf_get_system_bus\
151 |afb_hook_flag_ditf_rootdir_get_fd\
152 |afb_hook_flag_ditf_rootdir_open_locale\
153 |afb_hook_flag_ditf_queue_job)
155 #define afb_hook_flags_ditf_all (afb_hook_flags_ditf_common|afb_hook_flags_ditf_extra)
157 struct afb_hook_ditf_itf {
158 void (*hook_ditf_event_broadcast_before)(void *closure, const struct afb_ditf *ditf, const char *name, struct json_object *object);
159 void (*hook_ditf_event_broadcast_after)(void *closure, const struct afb_ditf *ditf, const char *name, struct json_object *object, int result);
160 void (*hook_ditf_get_event_loop)(void *closure, const struct afb_ditf *ditf, struct sd_event *result);
161 void (*hook_ditf_get_user_bus)(void *closure, const struct afb_ditf *ditf, struct sd_bus *result);
162 void (*hook_ditf_get_system_bus)(void *closure, const struct afb_ditf *ditf, struct sd_bus *result);
163 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);
164 void (*hook_ditf_event_make)(void *closure, const struct afb_ditf *ditf, const char *name, struct afb_event result);
165 void (*hook_ditf_rootdir_get_fd)(void *closure, const struct afb_ditf *ditf, int result);
166 void (*hook_ditf_rootdir_open_locale)(void *closure, const struct afb_ditf *ditf, const char *filename, int flags, const char *locale, int result);
167 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 extern void afb_hook_ditf_event_broadcast_before(const struct afb_ditf *ditf, const char *name, struct json_object *object);
171 extern int afb_hook_ditf_event_broadcast_after(const struct afb_ditf *ditf, const char *name, struct json_object *object, int result);
172 extern struct sd_event *afb_hook_ditf_get_event_loop(const struct afb_ditf *ditf, struct sd_event *result);
173 extern struct sd_bus *afb_hook_ditf_get_user_bus(const struct afb_ditf *ditf, struct sd_bus *result);
174 extern struct sd_bus *afb_hook_ditf_get_system_bus(const struct afb_ditf *ditf, struct sd_bus *result);
175 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);
176 extern struct afb_event afb_hook_ditf_event_make(const struct afb_ditf *ditf, const char *name, struct afb_event result);
177 extern int afb_hook_ditf_rootdir_get_fd(const struct afb_ditf *ditf, int result);
178 extern int afb_hook_ditf_rootdir_open_locale(const struct afb_ditf *ditf, const char *filename, int flags, const char *locale, int result);
179 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);
181 extern int afb_hook_flags_ditf(const char *api);
182 extern struct afb_hook_ditf *afb_hook_create_ditf(const char *api, int flags, struct afb_hook_ditf_itf *itf, void *closure);
183 extern struct afb_hook_ditf *afb_hook_addref_ditf(struct afb_hook_ditf *hook);
184 extern void afb_hook_unref_ditf(struct afb_hook_ditf *hook);
186 /*********************************************************
187 * section hooking svc (service interface)
188 *********************************************************/
190 #define afb_hook_flag_svc_start_before 0x000001
191 #define afb_hook_flag_svc_start_after 0x000002
192 #define afb_hook_flag_svc_on_event_before 0x000004
193 #define afb_hook_flag_svc_on_event_after 0x000008
194 #define afb_hook_flag_svc_call 0x000010
195 #define afb_hook_flag_svc_call_result 0x000020
196 #define afb_hook_flag_svc_callsync 0x000040
197 #define afb_hook_flag_svc_callsync_result 0x000080
199 #define afb_hook_flags_svc_all (afb_hook_flag_svc_start_before|afb_hook_flag_svc_start_after\
200 |afb_hook_flag_svc_on_event_before|afb_hook_flag_svc_on_event_after\
201 |afb_hook_flag_svc_call|afb_hook_flag_svc_call_result\
202 |afb_hook_flag_svc_callsync|afb_hook_flag_svc_callsync_result)
204 struct afb_hook_svc_itf {
205 void (*hook_svc_start_before)(void *closure, const struct afb_svc *svc);
206 void (*hook_svc_start_after)(void *closure, const struct afb_svc *svc, int status);
207 void (*hook_svc_on_event_before)(void *closure, const struct afb_svc *svc, const char *event, int eventid, struct json_object *object);
208 void (*hook_svc_on_event_after)(void *closure, const struct afb_svc *svc, const char *event, int eventid, struct json_object *object);
209 void (*hook_svc_call)(void *closure, const struct afb_svc *svc, const char *api, const char *verb, struct json_object *args);
210 void (*hook_svc_call_result)(void *closure, const struct afb_svc *svc, int status, struct json_object *result);
211 void (*hook_svc_callsync)(void *closure, const struct afb_svc *svc, const char *api, const char *verb, struct json_object *args);
212 void (*hook_svc_callsync_result)(void *closure, const struct afb_svc *svc, int status, struct json_object *result);
215 extern void afb_hook_svc_start_before(const struct afb_svc *svc);
216 extern int afb_hook_svc_start_after(const struct afb_svc *svc, int status);
217 extern void afb_hook_svc_on_event_before(const struct afb_svc *svc, const char *event, int eventid, struct json_object *object);
218 extern void afb_hook_svc_on_event_after(const struct afb_svc *svc, const char *event, int eventid, struct json_object *object);
219 extern void afb_hook_svc_call(const struct afb_svc *svc, const char *api, const char *verb, struct json_object *args);
220 extern void afb_hook_svc_call_result(const struct afb_svc *svc, int status, struct json_object *result);
221 extern void afb_hook_svc_callsync(const struct afb_svc *svc, const char *api, const char *verb, struct json_object *args);
222 extern int afb_hook_svc_callsync_result(const struct afb_svc *svc, int status, struct json_object *result);
224 extern int afb_hook_flags_svc(const char *api);
225 extern struct afb_hook_svc *afb_hook_create_svc(const char *api, int flags, struct afb_hook_svc_itf *itf, void *closure);
226 extern struct afb_hook_svc *afb_hook_addref_svc(struct afb_hook_svc *hook);
227 extern void afb_hook_unref_svc(struct afb_hook_svc *hook);
229 /*********************************************************
230 * section hooking evt (event interface)
231 *********************************************************/
233 #define afb_hook_flag_evt_create 0x000001
234 #define afb_hook_flag_evt_push_before 0x000002
235 #define afb_hook_flag_evt_push_after 0x000004
236 #define afb_hook_flag_evt_broadcast_before 0x000008
237 #define afb_hook_flag_evt_broadcast_after 0x000010
238 #define afb_hook_flag_evt_name 0x000020
239 #define afb_hook_flag_evt_drop 0x000040
241 #define afb_hook_flags_evt_common (afb_hook_flag_evt_push_before|afb_hook_flag_evt_broadcast_before)
242 #define afb_hook_flags_evt_extra (afb_hook_flags_evt_common\
243 |afb_hook_flag_evt_push_after|afb_hook_flag_evt_broadcast_after\
244 |afb_hook_flag_evt_create|afb_hook_flag_evt_drop)
245 #define afb_hook_flags_evt_all (afb_hook_flags_evt_extra|afb_hook_flag_evt_name)
247 struct afb_hook_evt_itf {
248 void (*hook_evt_create)(void *closure, const char *evt, int id);
249 void (*hook_evt_push_before)(void *closure, const char *evt, int id, struct json_object *obj);
250 void (*hook_evt_push_after)(void *closure, const char *evt, int id, struct json_object *obj, int result);
251 void (*hook_evt_broadcast_before)(void *closure, const char *evt, int id, struct json_object *obj);
252 void (*hook_evt_broadcast_after)(void *closure, const char *evt, int id, struct json_object *obj, int result);
253 void (*hook_evt_name)(void *closure, const char *evt, int id);
254 void (*hook_evt_drop)(void *closure, const char *evt, int id);
257 extern void afb_hook_evt_create(const char *evt, int id);
258 extern void afb_hook_evt_push_before(const char *evt, int id, struct json_object *obj);
259 extern int afb_hook_evt_push_after(const char *evt, int id, struct json_object *obj, int result);
260 extern void afb_hook_evt_broadcast_before(const char *evt, int id, struct json_object *obj);
261 extern int afb_hook_evt_broadcast_after(const char *evt, int id, struct json_object *obj, int result);
262 extern void afb_hook_evt_name(const char *evt, int id);
263 extern void afb_hook_evt_drop(const char *evt, int id);
265 extern int afb_hook_flags_evt(const char *name);
266 extern struct afb_hook_evt *afb_hook_create_evt(const char *name, int flags, struct afb_hook_evt_itf *itf, void *closure);
267 extern struct afb_hook_evt *afb_hook_addref_evt(struct afb_hook_evt *hook);
268 extern void afb_hook_unref_evt(struct afb_hook_evt *hook);