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.
29 #include <json-c/json.h>
31 #include <afb/afb-req-common.h>
32 #include <afb/afb-event-itf.h>
34 #include "afb-context.h"
36 #include "afb-session.h"
39 #include "afb-export.h"
44 * Definition of a hook for xreq
46 struct afb_hook_xreq {
47 struct afb_hook_xreq *next; /**< next hook */
48 unsigned refcount; /**< reference count */
49 char *api; /**< api hooked or NULL for any */
50 char *verb; /**< verb hooked or NULL for any */
51 struct afb_session *session; /**< session hooked or NULL if any */
52 unsigned flags; /**< hook flags */
53 struct afb_hook_xreq_itf *itf; /**< interface of hook */
54 void *closure; /**< closure for callbacks */
58 * Definition of a hook for export
60 struct afb_hook_ditf {
61 struct afb_hook_ditf *next; /**< next hook */
62 unsigned refcount; /**< reference count */
63 char *api; /**< api hooked or NULL for any */
64 unsigned flags; /**< hook flags */
65 struct afb_hook_ditf_itf *itf; /**< interface of hook */
66 void *closure; /**< closure for callbacks */
70 * Definition of a hook for export
73 struct afb_hook_svc *next; /**< next hook */
74 unsigned refcount; /**< reference count */
75 char *api; /**< api hooked or NULL for any */
76 unsigned flags; /**< hook flags */
77 struct afb_hook_svc_itf *itf; /**< interface of hook */
78 void *closure; /**< closure for callbacks */
82 * Definition of a hook for evt
85 struct afb_hook_evt *next; /**< next hook */
86 unsigned refcount; /**< reference count */
87 char *pattern; /**< event pattern name hooked or NULL for any */
88 unsigned flags; /**< hook flags */
89 struct afb_hook_evt_itf *itf; /**< interface of hook */
90 void *closure; /**< closure for callbacks */
94 * Definition of a hook for global
96 struct afb_hook_global {
97 struct afb_hook_global *next; /**< next hook */
98 unsigned refcount; /**< reference count */
99 unsigned flags; /**< hook flags */
100 struct afb_hook_global_itf *itf; /**< interface of hook */
101 void *closure; /**< closure for callbacks */
104 /* synchronisation across threads */
105 static pthread_rwlock_t rwlock = PTHREAD_RWLOCK_INITIALIZER;
107 /* list of hooks for xreq */
108 static struct afb_hook_xreq *list_of_xreq_hooks = NULL;
110 /* list of hooks for export */
111 static struct afb_hook_ditf *list_of_ditf_hooks = NULL;
113 /* list of hooks for export */
114 static struct afb_hook_svc *list_of_svc_hooks = NULL;
116 /* list of hooks for evt */
117 static struct afb_hook_evt *list_of_evt_hooks = NULL;
119 /* list of hooks for global */
120 static struct afb_hook_global *list_of_global_hooks = NULL;
123 static unsigned next_hookid = 0;
125 /******************************************************************************
127 *****************************************************************************/
128 static void init_hookid(struct afb_hookid *hookid)
130 hookid->id = __atomic_add_fetch(&next_hookid, 1, __ATOMIC_RELAXED);
131 clock_gettime(CLOCK_MONOTONIC, &hookid->time);
134 /******************************************************************************
135 * section: default callbacks for tracing requests
136 *****************************************************************************/
138 static char *_pbuf_(const char *fmt, va_list args, char **palloc, char *sbuf, size_t szsbuf, size_t *outlen)
145 rc = vsnprintf(sbuf, szsbuf, fmt, args);
146 if ((size_t)rc >= szsbuf) {
148 sbuf[szsbuf-2] = sbuf[szsbuf-3] = sbuf[szsbuf-4] = '.';
149 rc = vasprintf(palloc, fmt, cp);
154 if (rc >= 0 && outlen)
155 *outlen = (size_t)rc;
159 #if 0 /* old behaviour: use NOTICE */
160 static void _hook_(const char *fmt1, const char *fmt2, va_list arg2, ...)
162 char *tag, *data, *mem1, *mem2, buf1[256], buf2[2000];
165 data = _pbuf_(fmt2, arg2, &mem2, buf2, sizeof buf2, NULL);
167 va_start(arg1, arg2);
168 tag = _pbuf_(fmt1, arg1, &mem1, buf1, sizeof buf1, NULL);
171 NOTICE("[HOOK %s] %s", tag, data);
176 #else /* new behaviour: emits directly to stderr */
177 static void _hook_(const char *fmt1, const char *fmt2, va_list arg2, ...)
179 static const char chars[] = "HOOK: [] \n";
180 char *mem1, *mem2, buf1[256], buf2[2000];
184 iov[0].iov_base = (void*)&chars[0];
187 va_start(arg1, arg2);
188 iov[1].iov_base = _pbuf_(fmt1, arg1, &mem1, buf1, sizeof buf1, &iov[1].iov_len);
191 iov[2].iov_base = (void*)&chars[7];
194 iov[3].iov_base = _pbuf_(fmt2, arg2, &mem2, buf2, sizeof buf2, &iov[3].iov_len);
196 iov[4].iov_base = (void*)&chars[9];
206 static void _hook_xreq_(const struct afb_xreq *xreq, const char *format, ...)
209 va_start(ap, format);
210 _hook_("xreq-%06d:%s/%s", format, ap, xreq->hookindex, xreq->api, xreq->verb);
214 static void hook_xreq_begin_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
217 _hook_xreq_(xreq, "BEGIN");
219 _hook_xreq_(xreq, "BEGIN uid=%d=%s gid=%d pid=%d label=%s id=%s",
220 (int)xreq->cred->uid,
222 (int)xreq->cred->gid,
223 (int)xreq->cred->pid,
224 xreq->cred->label?:"(null)",
225 xreq->cred->id?:"(null)"
229 static void hook_xreq_end_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
231 _hook_xreq_(xreq, "END");
234 static void hook_xreq_json_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct json_object *obj)
236 _hook_xreq_(xreq, "json() -> %s", json_object_to_json_string(obj));
239 static void hook_xreq_get_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *name, struct afb_arg arg)
241 _hook_xreq_(xreq, "get(%s) -> { name: %s, value: %s, path: %s }", name, arg.name, arg.value, arg.path);
244 static void hook_xreq_success_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct json_object *obj, const char *info)
246 _hook_xreq_(xreq, "success(%s, %s)", json_object_to_json_string(obj), info);
249 static void hook_xreq_fail_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *status, const char *info)
251 _hook_xreq_(xreq, "fail(%s, %s)", status, info);
254 static void hook_xreq_context_get_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, void *value)
256 _hook_xreq_(xreq, "context_get() -> %p", value);
259 static void hook_xreq_context_set_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, void *value, void (*free_value)(void*))
261 _hook_xreq_(xreq, "context_set(%p, %p)", value, free_value);
264 static void hook_xreq_addref_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
266 _hook_xreq_(xreq, "addref()");
269 static void hook_xreq_unref_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
271 _hook_xreq_(xreq, "unref()");
274 static void hook_xreq_session_close_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
276 _hook_xreq_(xreq, "session_close()");
279 static void hook_xreq_session_set_LOA_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, unsigned level, int result)
281 _hook_xreq_(xreq, "session_set_LOA(%u) -> %d", level, result);
284 static void hook_xreq_subscribe_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_event event, int result)
286 _hook_xreq_(xreq, "subscribe(%s:%d) -> %d", afb_evt_event_name(event), afb_evt_event_id(event), result);
289 static void hook_xreq_unsubscribe_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_event event, int result)
291 _hook_xreq_(xreq, "unsubscribe(%s:%d) -> %d", afb_evt_event_name(event), afb_evt_event_id(event), result);
294 static void hook_xreq_subcall_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args)
296 _hook_xreq_(xreq, "subcall(%s/%s, %s) ...", api, verb, json_object_to_json_string(args));
299 static void hook_xreq_subcall_result_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int status, struct json_object *result)
301 _hook_xreq_(xreq, " ...subcall... -> %d: %s", status, json_object_to_json_string(result));
304 static void hook_xreq_subcallsync_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args)
306 _hook_xreq_(xreq, "subcallsync(%s/%s, %s) ...", api, verb, json_object_to_json_string(args));
309 static void hook_xreq_subcallsync_result_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int status, struct json_object *result)
311 _hook_xreq_(xreq, " ...subcallsync... -> %d: %s", status, json_object_to_json_string(result));
314 static void hook_xreq_vverbose_default_cb(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)
321 len = vasprintf(&msg, fmt, ap);
325 _hook_xreq_(xreq, "vverbose(%d, %s, %d, %s) -> %s ? ? ?", level, file, line, func, fmt);
327 _hook_xreq_(xreq, "vverbose(%d, %s, %d, %s) -> %s", level, file, line, func, msg);
332 static void hook_xreq_store_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_stored_req *sreq)
334 _hook_xreq_(xreq, "store() -> %p", sreq);
337 static void hook_xreq_unstore_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
339 _hook_xreq_(xreq, "unstore()");
342 static void hook_xreq_subcall_req_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args)
344 _hook_xreq_(xreq, "subcall_req(%s/%s, %s) ...", api, verb, json_object_to_json_string(args));
347 static void hook_xreq_subcall_req_result_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int status, struct json_object *result)
349 _hook_xreq_(xreq, " ...subcall_req... -> %d: %s", status, json_object_to_json_string(result));
352 static void hook_xreq_has_permission_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *permission, int result)
354 _hook_xreq_(xreq, "has_permission(%s) -> %d", permission, result);
357 static void hook_xreq_get_application_id_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, char *result)
359 _hook_xreq_(xreq, "get_application_id() -> %s", result);
362 static struct afb_hook_xreq_itf hook_xreq_default_itf = {
363 .hook_xreq_begin = hook_xreq_begin_default_cb,
364 .hook_xreq_end = hook_xreq_end_default_cb,
365 .hook_xreq_json = hook_xreq_json_default_cb,
366 .hook_xreq_get = hook_xreq_get_default_cb,
367 .hook_xreq_success = hook_xreq_success_default_cb,
368 .hook_xreq_fail = hook_xreq_fail_default_cb,
369 .hook_xreq_context_get = hook_xreq_context_get_default_cb,
370 .hook_xreq_context_set = hook_xreq_context_set_default_cb,
371 .hook_xreq_addref = hook_xreq_addref_default_cb,
372 .hook_xreq_unref = hook_xreq_unref_default_cb,
373 .hook_xreq_session_close = hook_xreq_session_close_default_cb,
374 .hook_xreq_session_set_LOA = hook_xreq_session_set_LOA_default_cb,
375 .hook_xreq_subscribe = hook_xreq_subscribe_default_cb,
376 .hook_xreq_unsubscribe = hook_xreq_unsubscribe_default_cb,
377 .hook_xreq_subcall = hook_xreq_subcall_default_cb,
378 .hook_xreq_subcall_result = hook_xreq_subcall_result_default_cb,
379 .hook_xreq_subcallsync = hook_xreq_subcallsync_default_cb,
380 .hook_xreq_subcallsync_result = hook_xreq_subcallsync_result_default_cb,
381 .hook_xreq_vverbose = hook_xreq_vverbose_default_cb,
382 .hook_xreq_store = hook_xreq_store_default_cb,
383 .hook_xreq_unstore = hook_xreq_unstore_default_cb,
384 .hook_xreq_subcall_req = hook_xreq_subcall_req_default_cb,
385 .hook_xreq_subcall_req_result = hook_xreq_subcall_req_result_default_cb,
386 .hook_xreq_has_permission = hook_xreq_has_permission_default_cb,
387 .hook_xreq_get_application_id = hook_xreq_get_application_id_default_cb
390 /******************************************************************************
391 * section: hooks for tracing requests
392 *****************************************************************************/
394 #define _HOOK_XREQ_(what,...) \
395 struct afb_hook_xreq *hook; \
396 struct afb_hookid hookid; \
397 pthread_rwlock_rdlock(&rwlock); \
398 init_hookid(&hookid); \
399 hook = list_of_xreq_hooks; \
401 if (hook->itf->hook_xreq_##what \
402 && (hook->flags & afb_hook_flag_req_##what) != 0 \
403 && (!hook->session || hook->session == xreq->context.session) \
404 && (!hook->api || !strcasecmp(hook->api, xreq->api)) \
405 && (!hook->verb || !strcasecmp(hook->verb, xreq->verb))) { \
406 hook->itf->hook_xreq_##what(hook->closure, &hookid, __VA_ARGS__); \
410 pthread_rwlock_unlock(&rwlock);
413 void afb_hook_xreq_begin(const struct afb_xreq *xreq)
415 _HOOK_XREQ_(begin, xreq);
418 void afb_hook_xreq_end(const struct afb_xreq *xreq)
420 _HOOK_XREQ_(end, xreq);
423 struct json_object *afb_hook_xreq_json(const struct afb_xreq *xreq, struct json_object *obj)
425 _HOOK_XREQ_(json, xreq, obj);
429 struct afb_arg afb_hook_xreq_get(const struct afb_xreq *xreq, const char *name, struct afb_arg arg)
431 _HOOK_XREQ_(get, xreq, name, arg);
435 void afb_hook_xreq_success(const struct afb_xreq *xreq, struct json_object *obj, const char *info)
437 _HOOK_XREQ_(success, xreq, obj, info);
440 void afb_hook_xreq_fail(const struct afb_xreq *xreq, const char *status, const char *info)
442 _HOOK_XREQ_(fail, xreq, status, info);
445 void *afb_hook_xreq_context_get(const struct afb_xreq *xreq, void *value)
447 _HOOK_XREQ_(context_get, xreq, value);
451 void afb_hook_xreq_context_set(const struct afb_xreq *xreq, void *value, void (*free_value)(void*))
453 _HOOK_XREQ_(context_set, xreq, value, free_value);
456 void afb_hook_xreq_addref(const struct afb_xreq *xreq)
458 _HOOK_XREQ_(addref, xreq);
461 void afb_hook_xreq_unref(const struct afb_xreq *xreq)
463 _HOOK_XREQ_(unref, xreq);
466 void afb_hook_xreq_session_close(const struct afb_xreq *xreq)
468 _HOOK_XREQ_(session_close, xreq);
471 int afb_hook_xreq_session_set_LOA(const struct afb_xreq *xreq, unsigned level, int result)
473 _HOOK_XREQ_(session_set_LOA, xreq, level, result);
477 int afb_hook_xreq_subscribe(const struct afb_xreq *xreq, struct afb_event event, int result)
479 _HOOK_XREQ_(subscribe, xreq, event, result);
483 int afb_hook_xreq_unsubscribe(const struct afb_xreq *xreq, struct afb_event event, int result)
485 _HOOK_XREQ_(unsubscribe, xreq, event, result);
489 void afb_hook_xreq_subcall(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args)
491 _HOOK_XREQ_(subcall, xreq, api, verb, args);
494 void afb_hook_xreq_subcall_result(const struct afb_xreq *xreq, int status, struct json_object *result)
496 _HOOK_XREQ_(subcall_result, xreq, status, result);
499 void afb_hook_xreq_subcallsync(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args)
501 _HOOK_XREQ_(subcallsync, xreq, api, verb, args);
504 int afb_hook_xreq_subcallsync_result(const struct afb_xreq *xreq, int status, struct json_object *result)
506 _HOOK_XREQ_(subcallsync_result, xreq, status, result);
510 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)
512 _HOOK_XREQ_(vverbose, xreq, level, file ?: "?", line, func ?: "?", fmt, args);
515 void afb_hook_xreq_store(const struct afb_xreq *xreq, struct afb_stored_req *sreq)
517 _HOOK_XREQ_(store, xreq, sreq);
520 void afb_hook_xreq_unstore(const struct afb_xreq *xreq)
522 _HOOK_XREQ_(unstore, xreq);
525 void afb_hook_xreq_subcall_req(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args)
527 _HOOK_XREQ_(subcall_req, xreq, api, verb, args);
530 void afb_hook_xreq_subcall_req_result(const struct afb_xreq *xreq, int status, struct json_object *result)
532 _HOOK_XREQ_(subcall_req_result, xreq, status, result);
535 int afb_hook_xreq_has_permission(const struct afb_xreq *xreq, const char *permission, int result)
537 _HOOK_XREQ_(has_permission, xreq, permission, result);
541 char *afb_hook_xreq_get_application_id(const struct afb_xreq *xreq, char *result)
543 _HOOK_XREQ_(get_application_id, xreq, result);
547 /******************************************************************************
548 * section: hooking xreqs
549 *****************************************************************************/
551 void afb_hook_init_xreq(struct afb_xreq *xreq)
557 struct afb_hook_xreq *hook;
559 /* scan hook list to get the expected flags */
561 pthread_rwlock_rdlock(&rwlock);
562 hook = list_of_xreq_hooks;
564 f = hook->flags & afb_hook_flags_req_all;
566 && (!hook->session || hook->session == xreq->context.session)
567 && (!hook->api || !strcasecmp(hook->api, xreq->api))
568 && (!hook->verb || !strcasecmp(hook->verb, xreq->verb));
573 pthread_rwlock_unlock(&rwlock);
575 /* store the hooking data */
576 xreq->hookflags = flags;
578 pthread_rwlock_wrlock(&rwlock);
581 xreq->hookindex = reqindex;
582 pthread_rwlock_unlock(&rwlock);
586 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)
588 struct afb_hook_xreq *hook;
590 /* alloc the result */
591 hook = calloc(1, sizeof *hook);
595 /* get a copy of the names */
596 hook->api = api ? strdup(api) : NULL;
597 hook->verb = verb ? strdup(verb) : NULL;
598 if ((api && !hook->api) || (verb && !hook->verb)) {
605 /* initialise the rest */
606 hook->session = session;
608 afb_session_addref(session);
611 hook->itf = itf ? itf : &hook_xreq_default_itf;
612 hook->closure = closure;
614 /* record the hook */
615 pthread_rwlock_wrlock(&rwlock);
616 hook->next = list_of_xreq_hooks;
617 list_of_xreq_hooks = hook;
618 pthread_rwlock_unlock(&rwlock);
624 struct afb_hook_xreq *afb_hook_addref_xreq(struct afb_hook_xreq *hook)
626 pthread_rwlock_wrlock(&rwlock);
628 pthread_rwlock_unlock(&rwlock);
632 void afb_hook_unref_xreq(struct afb_hook_xreq *hook)
634 struct afb_hook_xreq **prv;
637 pthread_rwlock_wrlock(&rwlock);
638 if (--hook->refcount)
642 prv = &list_of_xreq_hooks;
643 while (*prv && *prv != hook)
648 pthread_rwlock_unlock(&rwlock);
654 afb_session_unref(hook->session);
660 /******************************************************************************
661 * section: default callbacks for tracing daemon interface
662 *****************************************************************************/
664 static void _hook_ditf_(const struct afb_export *export, const char *format, ...)
667 va_start(ap, format);
668 _hook_("export-%s", format, ap, afb_export_apiname(export));
672 static void hook_ditf_event_broadcast_before_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct json_object *object)
674 _hook_ditf_(export, "event_broadcast.before(%s, %s)....", name, json_object_to_json_string(object));
677 static void hook_ditf_event_broadcast_after_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct json_object *object, int result)
679 _hook_ditf_(export, "event_broadcast.after(%s, %s) -> %d", name, json_object_to_json_string(object), result);
682 static void hook_ditf_get_event_loop_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_event *result)
684 _hook_ditf_(export, "get_event_loop() -> %p", result);
687 static void hook_ditf_get_user_bus_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_bus *result)
689 _hook_ditf_(export, "get_user_bus() -> %p", result);
692 static void hook_ditf_get_system_bus_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_bus *result)
694 _hook_ditf_(export, "get_system_bus() -> %p", result);
697 static void hook_ditf_vverbose_cb(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)
704 len = vasprintf(&msg, fmt, ap);
708 _hook_ditf_(export, "vverbose(%d, %s, %d, %s) -> %s ? ? ?", level, file, line, function, fmt);
710 _hook_ditf_(export, "vverbose(%d, %s, %d, %s) -> %s", level, file, line, function, msg);
715 static void hook_ditf_event_make_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct afb_event result)
717 _hook_ditf_(export, "event_make(%s) -> %s:%d", name, afb_evt_event_name(result), afb_evt_event_id(result));
720 static void hook_ditf_rootdir_get_fd_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result)
724 _hook_ditf_(export, "rootdir_get_fd() -> %d, %m", result);
726 sprintf(path, "/proc/self/fd/%d", result);
727 readlink(path, path, sizeof path);
728 _hook_ditf_(export, "rootdir_get_fd() -> %d = %s", result, path);
732 static void hook_ditf_rootdir_open_locale_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *filename, int flags, const char *locale, int result)
738 _hook_ditf_(export, "rootdir_open_locale(%s, %d, %s) -> %d, %m", filename, flags, locale, result);
740 sprintf(path, "/proc/self/fd/%d", result);
741 readlink(path, path, sizeof path);
742 _hook_ditf_(export, "rootdir_open_locale(%s, %d, %s) -> %d = %s", filename, flags, locale, result, path);
746 static void hook_ditf_queue_job_cb(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)
748 _hook_ditf_(export, "queue_job(%p, %p, %p, %d) -> %d", callback, argument, group, timeout, result);
751 static void hook_ditf_unstore_req_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct afb_stored_req *sreq)
753 _hook_ditf_(export, "unstore_req(%p)", sreq);
756 static void hook_ditf_require_api_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, int initialized)
758 _hook_ditf_(export, "require_api(%s, %d)...", name, initialized);
761 static void hook_ditf_require_api_result_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, int initialized, int result)
763 _hook_ditf_(export, "...require_api(%s, %d) -> %d", name, initialized, result);
766 static void hook_ditf_rename_api_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *oldname, const char *newname, int result)
768 _hook_ditf_(export, "rename_api(%s -> %s) -> %d", oldname, newname, result);
771 static struct afb_hook_ditf_itf hook_ditf_default_itf = {
772 .hook_ditf_event_broadcast_before = hook_ditf_event_broadcast_before_cb,
773 .hook_ditf_event_broadcast_after = hook_ditf_event_broadcast_after_cb,
774 .hook_ditf_get_event_loop = hook_ditf_get_event_loop_cb,
775 .hook_ditf_get_user_bus = hook_ditf_get_user_bus_cb,
776 .hook_ditf_get_system_bus = hook_ditf_get_system_bus_cb,
777 .hook_ditf_vverbose = hook_ditf_vverbose_cb,
778 .hook_ditf_event_make = hook_ditf_event_make_cb,
779 .hook_ditf_rootdir_get_fd = hook_ditf_rootdir_get_fd_cb,
780 .hook_ditf_rootdir_open_locale = hook_ditf_rootdir_open_locale_cb,
781 .hook_ditf_queue_job = hook_ditf_queue_job_cb,
782 .hook_ditf_unstore_req = hook_ditf_unstore_req_cb,
783 .hook_ditf_require_api = hook_ditf_require_api_cb,
784 .hook_ditf_require_api_result = hook_ditf_require_api_result_cb,
785 .hook_ditf_rename_api = hook_ditf_rename_api_cb
788 /******************************************************************************
789 * section: hooks for tracing daemon interface (export)
790 *****************************************************************************/
792 #define _HOOK_DITF_(what,...) \
793 struct afb_hook_ditf *hook; \
794 struct afb_hookid hookid; \
795 const char *apiname = afb_export_apiname(export); \
796 pthread_rwlock_rdlock(&rwlock); \
797 init_hookid(&hookid); \
798 hook = list_of_ditf_hooks; \
800 if (hook->itf->hook_ditf_##what \
801 && (hook->flags & afb_hook_flag_ditf_##what) != 0 \
802 && (!hook->api || !strcasecmp(hook->api, apiname))) { \
803 hook->itf->hook_ditf_##what(hook->closure, &hookid, __VA_ARGS__); \
807 pthread_rwlock_unlock(&rwlock);
809 void afb_hook_ditf_event_broadcast_before(const struct afb_export *export, const char *name, struct json_object *object)
811 _HOOK_DITF_(event_broadcast_before, export, name, object);
814 int afb_hook_ditf_event_broadcast_after(const struct afb_export *export, const char *name, struct json_object *object, int result)
816 _HOOK_DITF_(event_broadcast_after, export, name, object, result);
820 struct sd_event *afb_hook_ditf_get_event_loop(const struct afb_export *export, struct sd_event *result)
822 _HOOK_DITF_(get_event_loop, export, result);
826 struct sd_bus *afb_hook_ditf_get_user_bus(const struct afb_export *export, struct sd_bus *result)
828 _HOOK_DITF_(get_user_bus, export, result);
832 struct sd_bus *afb_hook_ditf_get_system_bus(const struct afb_export *export, struct sd_bus *result)
834 _HOOK_DITF_(get_system_bus, export, result);
838 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)
840 _HOOK_DITF_(vverbose, export, level, file, line, function, fmt, args);
843 struct afb_event afb_hook_ditf_event_make(const struct afb_export *export, const char *name, struct afb_event result)
845 _HOOK_DITF_(event_make, export, name, result);
849 int afb_hook_ditf_rootdir_get_fd(const struct afb_export *export, int result)
851 _HOOK_DITF_(rootdir_get_fd, export, result);
855 int afb_hook_ditf_rootdir_open_locale(const struct afb_export *export, const char *filename, int flags, const char *locale, int result)
857 _HOOK_DITF_(rootdir_open_locale, export, filename, flags, locale, result);
861 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)
863 _HOOK_DITF_(queue_job, export, callback, argument, group, timeout, result);
867 void afb_hook_ditf_unstore_req(const struct afb_export *export, struct afb_stored_req *sreq)
869 _HOOK_DITF_(unstore_req, export, sreq);
872 void afb_hook_ditf_require_api(const struct afb_export *export, const char *name, int initialized)
874 _HOOK_DITF_(require_api, export, name, initialized);
877 int afb_hook_ditf_require_api_result(const struct afb_export *export, const char *name, int initialized, int result)
879 _HOOK_DITF_(require_api_result, export, name, initialized, result);
883 int afb_hook_ditf_rename_api(const struct afb_export *export, const char *oldname, const char *newname, int result)
885 _HOOK_DITF_(rename_api, export, oldname, newname, result);
889 /******************************************************************************
890 * section: hooking export
891 *****************************************************************************/
893 int afb_hook_flags_ditf(const char *api)
896 struct afb_hook_ditf *hook;
898 pthread_rwlock_rdlock(&rwlock);
900 hook = list_of_ditf_hooks;
902 if (!api || !hook->api || !strcasecmp(hook->api, api))
903 flags |= hook->flags;
906 pthread_rwlock_unlock(&rwlock);
910 struct afb_hook_ditf *afb_hook_create_ditf(const char *api, int flags, struct afb_hook_ditf_itf *itf, void *closure)
912 struct afb_hook_ditf *hook;
914 /* alloc the result */
915 hook = calloc(1, sizeof *hook);
919 /* get a copy of the names */
920 hook->api = api ? strdup(api) : NULL;
921 if (api && !hook->api) {
926 /* initialise the rest */
929 hook->itf = itf ? itf : &hook_ditf_default_itf;
930 hook->closure = closure;
932 /* record the hook */
933 pthread_rwlock_wrlock(&rwlock);
934 hook->next = list_of_ditf_hooks;
935 list_of_ditf_hooks = hook;
936 pthread_rwlock_unlock(&rwlock);
942 struct afb_hook_ditf *afb_hook_addref_ditf(struct afb_hook_ditf *hook)
944 pthread_rwlock_wrlock(&rwlock);
946 pthread_rwlock_unlock(&rwlock);
950 void afb_hook_unref_ditf(struct afb_hook_ditf *hook)
952 struct afb_hook_ditf **prv;
955 pthread_rwlock_wrlock(&rwlock);
956 if (--hook->refcount)
960 prv = &list_of_ditf_hooks;
961 while (*prv && *prv != hook)
966 pthread_rwlock_unlock(&rwlock);
975 /******************************************************************************
976 * section: default callbacks for tracing service interface (export)
977 *****************************************************************************/
979 static void _hook_svc_(const struct afb_export *export, const char *format, ...)
982 va_start(ap, format);
983 _hook_("export-%s", format, ap, afb_export_apiname(export));
987 static void hook_svc_start_before_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export)
989 _hook_svc_(export, "start.before");
992 static void hook_svc_start_after_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int status)
994 _hook_svc_(export, "start.after -> %d", status);
997 static void hook_svc_on_event_before_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *event, int eventid, struct json_object *object)
999 _hook_svc_(export, "on_event.before(%s, %d, %s)", event, eventid, json_object_to_json_string(object));
1002 static void hook_svc_on_event_after_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *event, int eventid, struct json_object *object)
1004 _hook_svc_(export, "on_event.after(%s, %d, %s)", event, eventid, json_object_to_json_string(object));
1007 static void hook_svc_call_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *api, const char *verb, struct json_object *args)
1009 _hook_svc_(export, "call(%s/%s, %s) ...", api, verb, json_object_to_json_string(args));
1012 static void hook_svc_call_result_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int status, struct json_object *result)
1014 _hook_svc_(export, " ...call... -> %d: %s", status, json_object_to_json_string(result));
1017 static void hook_svc_callsync_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *api, const char *verb, struct json_object *args)
1019 _hook_svc_(export, "callsync(%s/%s, %s) ...", api, verb, json_object_to_json_string(args));
1022 static void hook_svc_callsync_result_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int status, struct json_object *result)
1024 _hook_svc_(export, " ...callsync... -> %d: %s", status, json_object_to_json_string(result));
1027 static struct afb_hook_svc_itf hook_svc_default_itf = {
1028 .hook_svc_start_before = hook_svc_start_before_default_cb,
1029 .hook_svc_start_after = hook_svc_start_after_default_cb,
1030 .hook_svc_on_event_before = hook_svc_on_event_before_default_cb,
1031 .hook_svc_on_event_after = hook_svc_on_event_after_default_cb,
1032 .hook_svc_call = hook_svc_call_default_cb,
1033 .hook_svc_call_result = hook_svc_call_result_default_cb,
1034 .hook_svc_callsync = hook_svc_callsync_default_cb,
1035 .hook_svc_callsync_result = hook_svc_callsync_result_default_cb
1038 /******************************************************************************
1039 * section: hooks for tracing service interface (export)
1040 *****************************************************************************/
1042 #define _HOOK_SVC_(what,...) \
1043 struct afb_hook_svc *hook; \
1044 struct afb_hookid hookid; \
1045 const char *apiname = afb_export_apiname(export); \
1046 pthread_rwlock_rdlock(&rwlock); \
1047 init_hookid(&hookid); \
1048 hook = list_of_svc_hooks; \
1050 if (hook->itf->hook_svc_##what \
1051 && (hook->flags & afb_hook_flag_svc_##what) != 0 \
1052 && (!hook->api || !strcasecmp(hook->api, apiname))) { \
1053 hook->itf->hook_svc_##what(hook->closure, &hookid, __VA_ARGS__); \
1055 hook = hook->next; \
1057 pthread_rwlock_unlock(&rwlock);
1059 void afb_hook_svc_start_before(const struct afb_export *export)
1061 _HOOK_SVC_(start_before, export);
1064 int afb_hook_svc_start_after(const struct afb_export *export, int status)
1066 _HOOK_SVC_(start_after, export, status);
1070 void afb_hook_svc_on_event_before(const struct afb_export *export, const char *event, int eventid, struct json_object *object)
1072 _HOOK_SVC_(on_event_before, export, event, eventid, object);
1075 void afb_hook_svc_on_event_after(const struct afb_export *export, const char *event, int eventid, struct json_object *object)
1077 _HOOK_SVC_(on_event_after, export, event, eventid, object);
1080 void afb_hook_svc_call(const struct afb_export *export, const char *api, const char *verb, struct json_object *args)
1082 _HOOK_SVC_(call, export, api, verb, args);
1085 void afb_hook_svc_call_result(const struct afb_export *export, int status, struct json_object *result)
1087 _HOOK_SVC_(call_result, export, status, result);
1090 void afb_hook_svc_callsync(const struct afb_export *export, const char *api, const char *verb, struct json_object *args)
1092 _HOOK_SVC_(callsync, export, api, verb, args);
1095 int afb_hook_svc_callsync_result(const struct afb_export *export, int status, struct json_object *result)
1097 _HOOK_SVC_(callsync_result, export, status, result);
1101 /******************************************************************************
1102 * section: hooking services (export)
1103 *****************************************************************************/
1105 int afb_hook_flags_svc(const char *api)
1108 struct afb_hook_svc *hook;
1110 pthread_rwlock_rdlock(&rwlock);
1112 hook = list_of_svc_hooks;
1114 if (!api || !hook->api || !strcasecmp(hook->api, api))
1115 flags |= hook->flags;
1118 pthread_rwlock_unlock(&rwlock);
1122 struct afb_hook_svc *afb_hook_create_svc(const char *api, int flags, struct afb_hook_svc_itf *itf, void *closure)
1124 struct afb_hook_svc *hook;
1126 /* alloc the result */
1127 hook = calloc(1, sizeof *hook);
1131 /* get a copy of the names */
1132 hook->api = api ? strdup(api) : NULL;
1133 if (api && !hook->api) {
1138 /* initialise the rest */
1140 hook->flags = flags;
1141 hook->itf = itf ? itf : &hook_svc_default_itf;
1142 hook->closure = closure;
1144 /* record the hook */
1145 pthread_rwlock_wrlock(&rwlock);
1146 hook->next = list_of_svc_hooks;
1147 list_of_svc_hooks = hook;
1148 pthread_rwlock_unlock(&rwlock);
1154 struct afb_hook_svc *afb_hook_addref_svc(struct afb_hook_svc *hook)
1156 pthread_rwlock_wrlock(&rwlock);
1158 pthread_rwlock_unlock(&rwlock);
1162 void afb_hook_unref_svc(struct afb_hook_svc *hook)
1164 struct afb_hook_svc **prv;
1167 pthread_rwlock_wrlock(&rwlock);
1168 if (--hook->refcount)
1172 prv = &list_of_svc_hooks;
1173 while (*prv && *prv != hook)
1174 prv = &(*prv)->next;
1178 pthread_rwlock_unlock(&rwlock);
1187 /******************************************************************************
1188 * section: default callbacks for tracing service interface (evt)
1189 *****************************************************************************/
1191 static void _hook_evt_(const char *evt, int id, const char *format, ...)
1194 va_start(ap, format);
1195 _hook_("evt-%s:%d", format, ap, evt, id);
1199 static void hook_evt_create_default_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
1201 _hook_evt_(evt, id, "create");
1204 static void hook_evt_push_before_default_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj)
1206 _hook_evt_(evt, id, "push.before(%s)", json_object_to_json_string(obj));
1210 static void hook_evt_push_after_default_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj, int result)
1212 _hook_evt_(evt, id, "push.after(%s) -> %d", json_object_to_json_string(obj), result);
1215 static void hook_evt_broadcast_before_default_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj)
1217 _hook_evt_(evt, id, "broadcast.before(%s)", json_object_to_json_string(obj));
1220 static void hook_evt_broadcast_after_default_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj, int result)
1222 _hook_evt_(evt, id, "broadcast.after(%s) -> %d", json_object_to_json_string(obj), result);
1225 static void hook_evt_name_default_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
1227 _hook_evt_(evt, id, "name");
1230 static void hook_evt_drop_default_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
1232 _hook_evt_(evt, id, "drop");
1235 static struct afb_hook_evt_itf hook_evt_default_itf = {
1236 .hook_evt_create = hook_evt_create_default_cb,
1237 .hook_evt_push_before = hook_evt_push_before_default_cb,
1238 .hook_evt_push_after = hook_evt_push_after_default_cb,
1239 .hook_evt_broadcast_before = hook_evt_broadcast_before_default_cb,
1240 .hook_evt_broadcast_after = hook_evt_broadcast_after_default_cb,
1241 .hook_evt_name = hook_evt_name_default_cb,
1242 .hook_evt_drop = hook_evt_drop_default_cb
1245 /******************************************************************************
1246 * section: hooks for tracing events interface (evt)
1247 *****************************************************************************/
1249 #define _HOOK_EVT_(what,...) \
1250 struct afb_hook_evt *hook; \
1251 struct afb_hookid hookid; \
1252 pthread_rwlock_rdlock(&rwlock); \
1253 init_hookid(&hookid); \
1254 hook = list_of_evt_hooks; \
1256 if (hook->itf->hook_evt_##what \
1257 && (hook->flags & afb_hook_flag_evt_##what) != 0 \
1258 && (!hook->pattern || !fnmatch(hook->pattern, evt, FNM_CASEFOLD))) { \
1259 hook->itf->hook_evt_##what(hook->closure, &hookid, __VA_ARGS__); \
1261 hook = hook->next; \
1263 pthread_rwlock_unlock(&rwlock);
1265 void afb_hook_evt_create(const char *evt, int id)
1267 _HOOK_EVT_(create, evt, id);
1270 void afb_hook_evt_push_before(const char *evt, int id, struct json_object *obj)
1272 _HOOK_EVT_(push_before, evt, id, obj);
1275 int afb_hook_evt_push_after(const char *evt, int id, struct json_object *obj, int result)
1277 _HOOK_EVT_(push_after, evt, id, obj, result);
1281 void afb_hook_evt_broadcast_before(const char *evt, int id, struct json_object *obj)
1283 _HOOK_EVT_(broadcast_before, evt, id, obj);
1286 int afb_hook_evt_broadcast_after(const char *evt, int id, struct json_object *obj, int result)
1288 _HOOK_EVT_(broadcast_after, evt, id, obj, result);
1292 void afb_hook_evt_name(const char *evt, int id)
1294 _HOOK_EVT_(name, evt, id);
1297 void afb_hook_evt_drop(const char *evt, int id)
1299 _HOOK_EVT_(drop, evt, id);
1302 /******************************************************************************
1303 * section: hooking services (evt)
1304 *****************************************************************************/
1306 int afb_hook_flags_evt(const char *name)
1309 struct afb_hook_evt *hook;
1311 pthread_rwlock_rdlock(&rwlock);
1313 hook = list_of_evt_hooks;
1315 if (!name || !hook->pattern || !fnmatch(hook->pattern, name, FNM_CASEFOLD))
1316 flags |= hook->flags;
1319 pthread_rwlock_unlock(&rwlock);
1323 struct afb_hook_evt *afb_hook_create_evt(const char *pattern, int flags, struct afb_hook_evt_itf *itf, void *closure)
1325 struct afb_hook_evt *hook;
1327 /* alloc the result */
1328 hook = calloc(1, sizeof *hook);
1332 /* get a copy of the names */
1333 hook->pattern = pattern ? strdup(pattern) : NULL;
1334 if (pattern && !hook->pattern) {
1339 /* initialise the rest */
1341 hook->flags = flags;
1342 hook->itf = itf ? itf : &hook_evt_default_itf;
1343 hook->closure = closure;
1345 /* record the hook */
1346 pthread_rwlock_wrlock(&rwlock);
1347 hook->next = list_of_evt_hooks;
1348 list_of_evt_hooks = hook;
1349 pthread_rwlock_unlock(&rwlock);
1355 struct afb_hook_evt *afb_hook_addref_evt(struct afb_hook_evt *hook)
1357 pthread_rwlock_wrlock(&rwlock);
1359 pthread_rwlock_unlock(&rwlock);
1363 void afb_hook_unref_evt(struct afb_hook_evt *hook)
1365 struct afb_hook_evt **prv;
1368 pthread_rwlock_wrlock(&rwlock);
1369 if (--hook->refcount)
1373 prv = &list_of_evt_hooks;
1374 while (*prv && *prv != hook)
1375 prv = &(*prv)->next;
1379 pthread_rwlock_unlock(&rwlock);
1382 free(hook->pattern);
1388 /******************************************************************************
1389 * section: default callbacks for globals (global)
1390 *****************************************************************************/
1392 static void _hook_global_(const char *format, ...)
1395 va_start(ap, format);
1396 _hook_("global", format, ap);
1400 static void hook_global_vverbose_default_cb(void *closure, const struct afb_hookid *hookid, int level, const char *file, int line, const char *func, const char *fmt, va_list args)
1407 len = vasprintf(&msg, fmt, ap);
1411 _hook_global_("vverbose(%d, %s, %d, %s) -> %s ? ? ?", level, file, line, func, fmt);
1413 _hook_global_("vverbose(%d, %s, %d, %s) -> %s", level, file, line, func, msg);
1418 static struct afb_hook_global_itf hook_global_default_itf = {
1419 .hook_global_vverbose = hook_global_vverbose_default_cb
1422 /******************************************************************************
1423 * section: hooks for tracing globals (global)
1424 *****************************************************************************/
1426 #define _HOOK_GLOBAL_(what,...) \
1427 struct afb_hook_global *hook; \
1428 struct afb_hookid hookid; \
1429 pthread_rwlock_rdlock(&rwlock); \
1430 init_hookid(&hookid); \
1431 hook = list_of_global_hooks; \
1433 if (hook->itf->hook_global_##what \
1434 && (hook->flags & afb_hook_flag_global_##what) != 0) { \
1435 hook->itf->hook_global_##what(hook->closure, &hookid, __VA_ARGS__); \
1437 hook = hook->next; \
1439 pthread_rwlock_unlock(&rwlock);
1441 static void afb_hook_global_vverbose(int level, const char *file, int line, const char *func, const char *fmt, va_list args)
1443 _HOOK_GLOBAL_(vverbose, level, file ?: "?", line, func ?: "?", fmt ?: "", args);
1446 /******************************************************************************
1447 * section: hooking globals (global)
1448 *****************************************************************************/
1450 static void update_global()
1452 struct afb_hook_global *hook;
1455 pthread_rwlock_rdlock(&rwlock);
1456 hook = list_of_global_hooks;
1458 flags = hook->flags;
1461 verbose_observer = (flags & afb_hook_flag_global_vverbose) ? afb_hook_global_vverbose : NULL;
1462 pthread_rwlock_unlock(&rwlock);
1465 struct afb_hook_global *afb_hook_create_global(int flags, struct afb_hook_global_itf *itf, void *closure)
1467 struct afb_hook_global *hook;
1469 /* alloc the result */
1470 hook = calloc(1, sizeof *hook);
1474 /* initialise the rest */
1476 hook->flags = flags;
1477 hook->itf = itf ? itf : &hook_global_default_itf;
1478 hook->closure = closure;
1480 /* record the hook */
1481 pthread_rwlock_wrlock(&rwlock);
1482 hook->next = list_of_global_hooks;
1483 list_of_global_hooks = hook;
1484 pthread_rwlock_unlock(&rwlock);
1486 /* update hooking */
1493 struct afb_hook_global *afb_hook_addref_global(struct afb_hook_global *hook)
1495 pthread_rwlock_wrlock(&rwlock);
1497 pthread_rwlock_unlock(&rwlock);
1501 void afb_hook_unref_global(struct afb_hook_global *hook)
1503 struct afb_hook_global **prv;
1506 pthread_rwlock_wrlock(&rwlock);
1507 if (--hook->refcount)
1511 prv = &list_of_global_hooks;
1512 while (*prv && *prv != hook)
1513 prv = &(*prv)->next;
1517 pthread_rwlock_unlock(&rwlock);
1522 /* update hooking */