2 * Copyright (C) 2016-2019 "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.
18 #if WITH_AFB_HOOK /***********************************************************/
30 #include <json-c/json.h>
31 #if !defined(JSON_C_TO_STRING_NOSLASHESCAPE)
32 #define JSON_C_TO_STRING_NOSLASHESCAPE 0
35 #include <afb/afb-req-x1.h>
36 #include <afb/afb-event-x2.h>
38 #include "afb-context.h"
40 #include "afb-session.h"
43 #include "afb-export.h"
46 #include "afb-msg-json.h"
48 #include "globmatch.h"
51 #define MATCH(pattern,string) (\
53 ? !fnmatch((pattern),(string),FNM_CASEFOLD|FNM_EXTMATCH|FNM_PERIOD) \
54 : afb_api_is_public(string))
56 #define MATCH_API(pattern,string) MATCH(pattern,string)
57 #define MATCH_VERB(pattern,string) MATCH(pattern,string)
58 #define MATCH_EVENT(pattern,string) MATCH(pattern,string)
59 #define MATCH_SESSION(pattern,string) MATCH(pattern,string)
62 * Definition of a hook for xreq
64 struct afb_hook_xreq {
65 struct afb_hook_xreq *next; /**< next hook */
66 unsigned refcount; /**< reference count */
67 unsigned flags; /**< hook flags */
68 char *api; /**< api hooked or NULL for any */
69 char *verb; /**< verb hooked or NULL for any */
70 struct afb_session *session; /**< session hooked or NULL if any */
71 struct afb_hook_xreq_itf *itf; /**< interface of hook */
72 void *closure; /**< closure for callbacks */
76 * Definition of a hook for export
79 struct afb_hook_api *next; /**< next hook */
80 unsigned refcount; /**< reference count */
81 unsigned flags; /**< hook flags */
82 char *api; /**< api hooked or NULL for any */
83 struct afb_hook_api_itf *itf; /**< interface of hook */
84 void *closure; /**< closure for callbacks */
88 * Definition of a hook for evt
91 struct afb_hook_evt *next; /**< next hook */
92 unsigned refcount; /**< reference count */
93 unsigned flags; /**< hook flags */
94 char *pattern; /**< event pattern name hooked or NULL for any */
95 struct afb_hook_evt_itf *itf; /**< interface of hook */
96 void *closure; /**< closure for callbacks */
100 * Definition of a hook for session
102 struct afb_hook_session {
103 struct afb_hook_session *next; /**< next hook */
104 unsigned refcount; /**< reference count */
105 unsigned flags; /**< hook flags */
106 char *pattern; /**< event pattern name hooked or NULL for any */
107 struct afb_hook_session_itf *itf; /**< interface of hook */
108 void *closure; /**< closure for callbacks */
112 * Definition of a hook for global
114 struct afb_hook_global {
115 struct afb_hook_global *next; /**< next hook */
116 unsigned refcount; /**< reference count */
117 unsigned flags; /**< hook flags */
118 struct afb_hook_global_itf *itf; /**< interface of hook */
119 void *closure; /**< closure for callbacks */
122 /* synchronization across threads */
123 static pthread_rwlock_t rwlock = PTHREAD_RWLOCK_INITIALIZER;
124 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
126 /* list of hooks for xreq */
127 static struct afb_hook_xreq *list_of_xreq_hooks = NULL;
129 /* list of hooks for export */
130 static struct afb_hook_api *list_of_api_hooks = NULL;
132 /* list of hooks for evt */
133 static struct afb_hook_evt *list_of_evt_hooks = NULL;
135 /* list of hooks for session */
136 static struct afb_hook_session *list_of_session_hooks = NULL;
138 /* list of hooks for global */
139 static struct afb_hook_global *list_of_global_hooks = NULL;
142 static unsigned next_hookid = 0;
144 /******************************************************************************
146 *****************************************************************************/
147 static void init_hookid(struct afb_hookid *hookid)
149 hookid->id = __atomic_add_fetch(&next_hookid, 1, __ATOMIC_RELAXED);
150 clock_gettime(CLOCK_REALTIME, &hookid->time);
153 /******************************************************************************
154 * section: default callbacks for tracing requests
155 *****************************************************************************/
157 static char *_pbuf_(const char *fmt, va_list args, char **palloc, char *sbuf, size_t szsbuf, size_t *outlen)
164 rc = vsnprintf(sbuf, szsbuf, fmt, args);
165 if ((size_t)rc >= szsbuf) {
167 sbuf[szsbuf-2] = sbuf[szsbuf-3] = sbuf[szsbuf-4] = '.';
168 rc = vasprintf(palloc, fmt, cp);
173 if (rc >= 0 && outlen)
174 *outlen = (size_t)rc;
178 static void _hook_(const char *fmt1, const char *fmt2, va_list arg2, ...)
180 static const char chars[] = "HOOK: [] \n";
181 char *mem1, *mem2, buf1[256], buf2[2000];
186 iov[0].iov_base = (void*)&chars[0];
190 va_start(arg1, arg2);
191 iov[1].iov_base = _pbuf_(fmt1, arg1, &mem1, buf1, sizeof buf1, &iov[1].iov_len);
195 iov[2].iov_base = (void*)&chars[7];
199 iov[3].iov_base = _pbuf_(fmt2, arg2, &mem2, buf2, sizeof buf2, &iov[3].iov_len);
202 iov[4].iov_base = (void*)&chars[9];
205 (void)writev(2, iov, 5);
211 static void _hook_xreq_(const struct afb_xreq *xreq, const char *format, ...)
214 va_start(ap, format);
215 _hook_("xreq-%06d:%s/%s", format, ap, xreq->hookindex, xreq->request.called_api, xreq->request.called_verb);
219 static void hook_xreq_begin_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
222 _hook_xreq_(xreq, "BEGIN");
224 _hook_xreq_(xreq, "BEGIN uid=%d=%s gid=%d pid=%d label=%s id=%s",
225 (int)xreq->cred->uid,
227 (int)xreq->cred->gid,
228 (int)xreq->cred->pid,
229 xreq->cred->label?:"(null)",
230 xreq->cred->id?:"(null)"
234 static void hook_xreq_end_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
236 _hook_xreq_(xreq, "END");
239 static void hook_xreq_json_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct json_object *obj)
241 _hook_xreq_(xreq, "json() -> %s", json_object_to_json_string_ext(obj, JSON_C_TO_STRING_NOSLASHESCAPE));
244 static void hook_xreq_get_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *name, struct afb_arg arg)
246 _hook_xreq_(xreq, "get(%s) -> { name: %s, value: %s, path: %s }", name, arg.name, arg.value, arg.path);
249 static void hook_xreq_reply_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct json_object *obj, const char *error, const char *info)
251 _hook_xreq_(xreq, "reply[%s](%s, %s)", error?:"success", json_object_to_json_string_ext(obj, JSON_C_TO_STRING_NOSLASHESCAPE), info);
254 static void hook_xreq_legacy_context_get_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_legacy_context_set_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_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
266 _hook_xreq_(xreq, "addref()");
269 static void hook_xreq_unref_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_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_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_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_event_x2 *event_x2, int result)
286 _hook_xreq_(xreq, "subscribe(%s:%d) -> %d", afb_evt_event_x2_fullname(event_x2), afb_evt_event_x2_id(event_x2), result);
289 static void hook_xreq_unsubscribe_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_event_x2 *event_x2, int result)
291 _hook_xreq_(xreq, "unsubscribe(%s:%d) -> %d", afb_evt_event_x2_fullname(event_x2), afb_evt_event_x2_id(event_x2), result);
294 static void hook_xreq_subcall_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_ext(args, JSON_C_TO_STRING_NOSLASHESCAPE));
299 static void hook_xreq_subcall_result_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct json_object *object, const char *error, const char *info)
301 _hook_xreq_(xreq, " ...subcall... [%s] -> %s (%s)", error?:"success", json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE), info?:"");
304 static void hook_xreq_subcallsync_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_ext(args, JSON_C_TO_STRING_NOSLASHESCAPE));
309 static void hook_xreq_subcallsync_result_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int status, struct json_object *object, const char *error, const char *info)
311 _hook_xreq_(xreq, " ...subcallsync... %d [%s] -> %s (%s)", status, error?:"success", json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE), info?:"");
314 static void hook_xreq_vverbose_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, %s, %d, %s) -> %s ? ? ?", level, verbose_name_of_level(level), file, line, func, fmt);
327 _hook_xreq_(xreq, "vverbose(%d:%s, %s, %d, %s) -> %s", level, verbose_name_of_level(level), file, line, func, msg);
332 static void hook_xreq_legacy_store_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_legacy_unstore_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
339 _hook_xreq_(xreq, "unstore()");
342 static void hook_xreq_has_permission_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *permission, int result)
344 _hook_xreq_(xreq, "has_permission(%s) -> %d", permission, result);
347 static void hook_xreq_get_application_id_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, char *result)
349 _hook_xreq_(xreq, "get_application_id() -> %s", result);
352 static void hook_xreq_context_make_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int replace, void *(*create_value)(void*), void (*free_value)(void*), void *create_closure, void *result)
354 _hook_xreq_(xreq, "context_make(replace=%s, %p, %p, %p) -> %p", replace?"yes":"no", create_value, free_value, create_closure, result);
357 static void hook_xreq_get_uid_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int result)
359 _hook_xreq_(xreq, "get_uid() -> %d", result);
362 static void hook_xreq_get_client_info_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct json_object *result)
364 _hook_xreq_(xreq, "get_client_info() -> %s", json_object_to_json_string_ext(result, JSON_C_TO_STRING_NOSLASHESCAPE));
367 static struct afb_hook_xreq_itf hook_xreq_default_itf = {
368 .hook_xreq_begin = hook_xreq_begin_cb,
369 .hook_xreq_end = hook_xreq_end_cb,
370 .hook_xreq_json = hook_xreq_json_cb,
371 .hook_xreq_get = hook_xreq_get_cb,
372 .hook_xreq_reply = hook_xreq_reply_cb,
373 .hook_xreq_legacy_context_get = hook_xreq_legacy_context_get_cb,
374 .hook_xreq_legacy_context_set = hook_xreq_legacy_context_set_cb,
375 .hook_xreq_addref = hook_xreq_addref_cb,
376 .hook_xreq_unref = hook_xreq_unref_cb,
377 .hook_xreq_session_close = hook_xreq_session_close_cb,
378 .hook_xreq_session_set_LOA = hook_xreq_session_set_LOA_cb,
379 .hook_xreq_subscribe = hook_xreq_subscribe_cb,
380 .hook_xreq_unsubscribe = hook_xreq_unsubscribe_cb,
381 .hook_xreq_subcall = hook_xreq_subcall_cb,
382 .hook_xreq_subcall_result = hook_xreq_subcall_result_cb,
383 .hook_xreq_subcallsync = hook_xreq_subcallsync_cb,
384 .hook_xreq_subcallsync_result = hook_xreq_subcallsync_result_cb,
385 .hook_xreq_vverbose = hook_xreq_vverbose_cb,
386 .hook_xreq_legacy_store = hook_xreq_legacy_store_cb,
387 .hook_xreq_legacy_unstore = hook_xreq_legacy_unstore_cb,
388 .hook_xreq_has_permission = hook_xreq_has_permission_cb,
389 .hook_xreq_get_application_id = hook_xreq_get_application_id_cb,
390 .hook_xreq_context_make = hook_xreq_context_make_cb,
391 .hook_xreq_get_uid = hook_xreq_get_uid_cb,
392 .hook_xreq_get_client_info = hook_xreq_get_client_info_cb,
395 /******************************************************************************
396 * section: hooks for tracing requests
397 *****************************************************************************/
399 #define _HOOK_XREQ_2_(flag,func,...) \
400 struct afb_hook_xreq *hook; \
401 struct afb_hookid hookid; \
402 pthread_rwlock_rdlock(&rwlock); \
403 init_hookid(&hookid); \
404 hook = list_of_xreq_hooks; \
407 && hook->itf->hook_xreq_##func \
408 && (hook->flags & afb_hook_flag_req_##flag) != 0 \
409 && (!hook->session || hook->session == xreq->context.session) \
410 && MATCH_API(hook->api, xreq->request.called_api) \
411 && MATCH_VERB(hook->verb, xreq->request.called_verb)) { \
412 hook->itf->hook_xreq_##func(hook->closure, &hookid, __VA_ARGS__); \
416 pthread_rwlock_unlock(&rwlock);
418 #define _HOOK_XREQ_(what,...) _HOOK_XREQ_2_(what,what,__VA_ARGS__)
420 void afb_hook_xreq_begin(const struct afb_xreq *xreq)
422 _HOOK_XREQ_(begin, xreq);
425 void afb_hook_xreq_end(const struct afb_xreq *xreq)
427 _HOOK_XREQ_(end, xreq);
430 struct json_object *afb_hook_xreq_json(const struct afb_xreq *xreq, struct json_object *obj)
432 _HOOK_XREQ_(json, xreq, obj);
436 struct afb_arg afb_hook_xreq_get(const struct afb_xreq *xreq, const char *name, struct afb_arg arg)
438 _HOOK_XREQ_(get, xreq, name, arg);
442 void afb_hook_xreq_reply(const struct afb_xreq *xreq, struct json_object *obj, const char *error, const char *info)
444 _HOOK_XREQ_(reply, xreq, obj, error, info);
447 void *afb_hook_xreq_legacy_context_get(const struct afb_xreq *xreq, void *value)
449 _HOOK_XREQ_(legacy_context_get, xreq, value);
453 void afb_hook_xreq_legacy_context_set(const struct afb_xreq *xreq, void *value, void (*free_value)(void*))
455 _HOOK_XREQ_(legacy_context_set, xreq, value, free_value);
458 void afb_hook_xreq_addref(const struct afb_xreq *xreq)
460 _HOOK_XREQ_(addref, xreq);
463 void afb_hook_xreq_unref(const struct afb_xreq *xreq)
465 _HOOK_XREQ_(unref, xreq);
468 void afb_hook_xreq_session_close(const struct afb_xreq *xreq)
470 _HOOK_XREQ_(session_close, xreq);
473 int afb_hook_xreq_session_set_LOA(const struct afb_xreq *xreq, unsigned level, int result)
475 _HOOK_XREQ_(session_set_LOA, xreq, level, result);
479 int afb_hook_xreq_subscribe(const struct afb_xreq *xreq, struct afb_event_x2 *event_x2, int result)
481 _HOOK_XREQ_(subscribe, xreq, event_x2, result);
485 int afb_hook_xreq_unsubscribe(const struct afb_xreq *xreq, struct afb_event_x2 *event_x2, int result)
487 _HOOK_XREQ_(unsubscribe, xreq, event_x2, result);
491 void afb_hook_xreq_subcall(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args, int flags)
493 _HOOK_XREQ_(subcall, xreq, api, verb, args);
496 void afb_hook_xreq_subcall_result(const struct afb_xreq *xreq, struct json_object *object, const char *error, const char *info)
498 _HOOK_XREQ_(subcall_result, xreq, object, error, info);
501 void afb_hook_xreq_subcallsync(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args, int flags)
503 _HOOK_XREQ_(subcallsync, xreq, api, verb, args);
506 int afb_hook_xreq_subcallsync_result(const struct afb_xreq *xreq, int status, struct json_object *object, const char *error, const char *info)
508 _HOOK_XREQ_(subcallsync_result, xreq, status, object, error, info);
512 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)
514 _HOOK_XREQ_(vverbose, xreq, level, file ?: "?", line, func ?: "?", fmt, args);
517 void afb_hook_xreq_legacy_store(const struct afb_xreq *xreq, struct afb_stored_req *sreq)
519 _HOOK_XREQ_(legacy_store, xreq, sreq);
522 void afb_hook_xreq_legacy_unstore(const struct afb_xreq *xreq)
524 _HOOK_XREQ_(legacy_unstore, xreq);
527 int afb_hook_xreq_has_permission(const struct afb_xreq *xreq, const char *permission, int result)
529 _HOOK_XREQ_(has_permission, xreq, permission, result);
533 char *afb_hook_xreq_get_application_id(const struct afb_xreq *xreq, char *result)
535 _HOOK_XREQ_(get_application_id, xreq, result);
539 void *afb_hook_xreq_context_make(const struct afb_xreq *xreq, int replace, void *(*create_value)(void*), void (*free_value)(void*), void *create_closure, void *result)
541 _HOOK_XREQ_(context_make, xreq, replace, create_value, free_value, create_closure, result);
545 int afb_hook_xreq_get_uid(const struct afb_xreq *xreq, int result)
547 _HOOK_XREQ_(get_uid, xreq, result);
551 struct json_object *afb_hook_xreq_get_client_info(const struct afb_xreq *xreq, struct json_object *result)
553 _HOOK_XREQ_(get_client_info, xreq, result);
557 /******************************************************************************
558 * section: hooking xreqs
559 *****************************************************************************/
561 void afb_hook_init_xreq(struct afb_xreq *xreq)
563 static int reqindex = 0;
567 struct afb_hook_xreq *hook;
569 /* scan hook list to get the expected flags */
571 pthread_rwlock_rdlock(&rwlock);
572 hook = list_of_xreq_hooks;
574 f = hook->flags & afb_hook_flags_req_all;
576 && (!hook->session || hook->session == xreq->context.session)
577 && MATCH_API(hook->api, xreq->request.called_api)
578 && MATCH_VERB(hook->verb, xreq->request.called_verb);
583 pthread_rwlock_unlock(&rwlock);
585 /* store the hooking data */
586 xreq->hookflags = flags;
589 x = __atomic_load_n(&reqindex, __ATOMIC_RELAXED);
590 xreq->hookindex = (x + 1) % 1000000 ?: 1;
591 } while (x != __atomic_exchange_n(&reqindex, xreq->hookindex, __ATOMIC_RELAXED));
595 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)
597 struct afb_hook_xreq *hook;
599 /* alloc the result */
600 hook = calloc(1, sizeof *hook);
604 /* get a copy of the names */
605 hook->api = api ? strdup(api) : NULL;
606 hook->verb = verb ? strdup(verb) : NULL;
607 if ((api && !hook->api) || (verb && !hook->verb)) {
614 /* initialise the rest */
615 hook->session = session;
617 afb_session_addref(session);
620 hook->itf = itf ? itf : &hook_xreq_default_itf;
621 hook->closure = closure;
623 /* record the hook */
624 pthread_mutex_lock(&mutex);
625 hook->next = list_of_xreq_hooks;
626 list_of_xreq_hooks = hook;
627 pthread_mutex_unlock(&mutex);
633 struct afb_hook_xreq *afb_hook_addref_xreq(struct afb_hook_xreq *hook)
635 __atomic_add_fetch(&hook->refcount, 1, __ATOMIC_RELAXED);
639 static void hook_clean_xreq()
641 struct afb_hook_xreq **prv, *hook, *head;
643 if (pthread_rwlock_trywrlock(&rwlock) == 0) {
644 /* unlink under mutex */
646 pthread_mutex_lock(&mutex);
647 prv = &list_of_xreq_hooks;
648 while ((hook = *prv)) {
657 pthread_mutex_unlock(&mutex);
658 pthread_rwlock_unlock(&rwlock);
660 /* free found hooks */
661 while((hook = head)) {
666 afb_session_unref(hook->session);
672 void afb_hook_unref_xreq(struct afb_hook_xreq *hook)
674 if (hook && !__atomic_sub_fetch(&hook->refcount, 1, __ATOMIC_RELAXED))
678 /******************************************************************************
679 * section: default callbacks for tracing daemon interface
680 *****************************************************************************/
682 static void _hook_api_(const struct afb_export *export, const char *format, ...)
685 va_start(ap, format);
686 _hook_("api-%s", format, ap, afb_export_apiname(export));
690 static void hook_api_event_broadcast_before_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct json_object *object)
692 _hook_api_(export, "event_broadcast.before(%s, %s)....", name, json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE));
695 static void hook_api_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)
697 _hook_api_(export, "event_broadcast.after(%s, %s) -> %d", name, json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE), result);
700 static void hook_api_get_event_loop_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_event *result)
702 _hook_api_(export, "get_event_loop() -> %p", result);
705 static void hook_api_get_user_bus_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_bus *result)
707 _hook_api_(export, "get_user_bus() -> %p", result);
710 static void hook_api_get_system_bus_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_bus *result)
712 _hook_api_(export, "get_system_bus() -> %p", result);
715 static void hook_api_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)
722 len = vasprintf(&msg, fmt, ap);
726 _hook_api_(export, "vverbose(%d:%s, %s, %d, %s) -> %s ? ? ?", level, verbose_name_of_level(level), file, line, function, fmt);
728 _hook_api_(export, "vverbose(%d:%s, %s, %d, %s) -> %s", level, verbose_name_of_level(level), file, line, function, msg);
733 static void hook_api_event_make_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct afb_event_x2 *result)
735 _hook_api_(export, "event_make(%s) -> %s:%d", name, afb_evt_event_x2_fullname(result), afb_evt_event_x2_id(result));
738 static void hook_api_rootdir_get_fd_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result)
740 char path[PATH_MAX], proc[100];
744 _hook_api_(export, "rootdir_get_fd() -> %d, %m", result);
746 snprintf(proc, sizeof proc, "/proc/self/fd/%d", result);
747 s = readlink(proc, path, sizeof path);
748 path[s < 0 ? 0 : s >= sizeof path ? sizeof path - 1 : s] = 0;
749 _hook_api_(export, "rootdir_get_fd() -> %d = %s", result, path);
753 static void hook_api_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)
755 char path[PATH_MAX], proc[100];
761 _hook_api_(export, "rootdir_open_locale(%s, %d, %s) -> %d, %m", filename, flags, locale, result);
763 snprintf(proc, sizeof proc, "/proc/self/fd/%d", result);
764 s = readlink(proc, path, sizeof path);
765 path[s < 0 ? 0 : s >= sizeof path ? sizeof path - 1 : s] = 0;
766 _hook_api_(export, "rootdir_open_locale(%s, %d, %s) -> %d = %s", filename, flags, locale, result, path);
770 static void hook_api_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)
772 _hook_api_(export, "queue_job(%p, %p, %p, %d) -> %d", callback, argument, group, timeout, result);
775 static void hook_api_unstore_req_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct afb_stored_req *sreq)
777 _hook_api_(export, "unstore_req(%p)", sreq);
780 static void hook_api_require_api_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, int initialized)
782 _hook_api_(export, "require_api(%s, %d)...", name, initialized);
785 static void hook_api_require_api_result_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, int initialized, int result)
787 _hook_api_(export, "...require_api(%s, %d) -> %d", name, initialized, result);
790 static void hook_api_add_alias_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *api, const char *alias, int result)
792 _hook_api_(export, "add_alias(%s -> %s) -> %d", api, alias?:"<null>", result);
795 static void hook_api_start_before_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export)
797 _hook_api_(export, "start.before");
800 static void hook_api_start_after_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int status)
802 _hook_api_(export, "start.after -> %d", status);
805 static void hook_api_on_event_before_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *event, int event_x2, struct json_object *object)
807 _hook_api_(export, "on_event.before(%s, %d, %s)", event, event_x2, json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE));
810 static void hook_api_on_event_after_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *event, int event_x2, struct json_object *object)
812 _hook_api_(export, "on_event.after(%s, %d, %s)", event, event_x2, json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE));
815 static void hook_api_call_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *api, const char *verb, struct json_object *args)
817 _hook_api_(export, "call(%s/%s, %s) ...", api, verb, json_object_to_json_string_ext(args, JSON_C_TO_STRING_NOSLASHESCAPE));
820 static void hook_api_call_result_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct json_object *object, const char *error, const char *info)
822 _hook_api_(export, " ...call... [%s] -> %s (%s)", error?:"success", json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE), info?:"");
825 static void hook_api_callsync_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *api, const char *verb, struct json_object *args)
827 _hook_api_(export, "callsync(%s/%s, %s) ...", api, verb, json_object_to_json_string_ext(args, JSON_C_TO_STRING_NOSLASHESCAPE));
830 static void hook_api_callsync_result_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int status, struct json_object *object, const char *error, const char *info)
832 _hook_api_(export, " ...callsync... %d [%s] -> %s (%s)", status, error?:"success", json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE), info?:"");
835 static void hook_api_new_api_before_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *api, const char *info, int noconcurrency)
837 _hook_api_(export, "new_api.before %s (%s)%s ...", api, info?:"", noconcurrency?" no-concurrency" : "");
840 static void hook_api_new_api_after_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result, const char *api)
842 _hook_api_(export, "... new_api.after %s -> %s (%d)", api, result >= 0 ? "OK" : "ERROR", result);
845 static void hook_api_api_set_verbs_v2_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result, const struct afb_verb_v2 *verbs)
847 _hook_api_(export, "set_verbs_v2 -> %s (%d)", result >= 0 ? "OK" : "ERROR", result);
850 static void hook_api_api_set_verbs_v3_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result, const struct afb_verb_v3 *verbs)
852 _hook_api_(export, "set_verbs_v3 -> %s (%d)", result >= 0 ? "OK" : "ERROR", result);
855 static void hook_api_api_add_verb_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result, const char *verb, const char *info, int glob)
857 _hook_api_(export, "add_verb(%s%s [%s]) -> %s (%d)", verb, glob?" (GLOB)":"", info?:"", result >= 0 ? "OK" : "ERROR", result);
860 static void hook_api_api_del_verb_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result, const char *verb)
862 _hook_api_(export, "del_verb(%s) -> %s (%d)", verb, result >= 0 ? "OK" : "ERROR", result);
865 static void hook_api_api_set_on_event_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result)
867 _hook_api_(export, "set_on_event -> %s (%d)", result >= 0 ? "OK" : "ERROR", result);
870 static void hook_api_api_set_on_init_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result)
872 _hook_api_(export, "set_on_init -> %s (%d)", result >= 0 ? "OK" : "ERROR", result);
875 static void hook_api_api_seal_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export)
877 _hook_api_(export, "seal");
880 static void hook_api_event_handler_add_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result, const char *pattern)
882 _hook_api_(export, "event_handler_add(%s) -> %s (%d)", pattern, result >= 0 ? "OK" : "ERROR", result);
885 static void hook_api_event_handler_del_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result, const char *pattern)
887 _hook_api_(export, "event_handler_del(%s) -> %s (%d)", pattern, result >= 0 ? "OK" : "ERROR", result);
890 static void hook_api_class_provide_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result, const char *name)
892 _hook_api_(export, "class_provide(%s) -> %s (%d)", name, result >= 0 ? "OK" : "ERROR", result);
895 static void hook_api_class_require_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result, const char *name)
897 _hook_api_(export, "class_require(%s) -> %s (%d)", name, result >= 0 ? "OK" : "ERROR", result);
900 static void hook_api_delete_api_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result)
902 _hook_api_(export, "delete_api -> %s (%d)", result >= 0 ? "OK" : "ERROR", result);
905 static void hook_api_on_event_handler_before_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *event, int event_x2, struct json_object *object, const char *pattern)
907 _hook_api_(export, "on_event_handler[%s].before(%s, %d, %s)", pattern, event, event_x2, json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE));
910 static void hook_api_on_event_handler_after_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *event, int event_x2, struct json_object *object, const char *pattern)
912 _hook_api_(export, "on_event_handler[%s].after(%s, %d, %s)", pattern, event, event_x2, json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE));
915 static void hook_api_settings_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct json_object *object)
917 _hook_api_(export, "settings -> %s", json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE));
920 static struct afb_hook_api_itf hook_api_default_itf = {
921 .hook_api_event_broadcast_before = hook_api_event_broadcast_before_cb,
922 .hook_api_event_broadcast_after = hook_api_event_broadcast_after_cb,
923 .hook_api_get_event_loop = hook_api_get_event_loop_cb,
924 .hook_api_get_user_bus = hook_api_get_user_bus_cb,
925 .hook_api_get_system_bus = hook_api_get_system_bus_cb,
926 .hook_api_vverbose = hook_api_vverbose_cb,
927 .hook_api_event_make = hook_api_event_make_cb,
928 .hook_api_rootdir_get_fd = hook_api_rootdir_get_fd_cb,
929 .hook_api_rootdir_open_locale = hook_api_rootdir_open_locale_cb,
930 .hook_api_queue_job = hook_api_queue_job_cb,
931 .hook_api_legacy_unstore_req = hook_api_unstore_req_cb,
932 .hook_api_require_api = hook_api_require_api_cb,
933 .hook_api_require_api_result = hook_api_require_api_result_cb,
934 .hook_api_add_alias = hook_api_add_alias_cb,
935 .hook_api_start_before = hook_api_start_before_cb,
936 .hook_api_start_after = hook_api_start_after_cb,
937 .hook_api_on_event_before = hook_api_on_event_before_cb,
938 .hook_api_on_event_after = hook_api_on_event_after_cb,
939 .hook_api_call = hook_api_call_cb,
940 .hook_api_call_result = hook_api_call_result_cb,
941 .hook_api_callsync = hook_api_callsync_cb,
942 .hook_api_callsync_result = hook_api_callsync_result_cb,
943 .hook_api_new_api_before = hook_api_new_api_before_cb,
944 .hook_api_new_api_after = hook_api_new_api_after_cb,
945 .hook_api_api_set_verbs_v2 = hook_api_api_set_verbs_v2_cb,
946 .hook_api_api_set_verbs_v3 = hook_api_api_set_verbs_v3_cb,
947 .hook_api_api_add_verb = hook_api_api_add_verb_cb,
948 .hook_api_api_del_verb = hook_api_api_del_verb_cb,
949 .hook_api_api_set_on_event = hook_api_api_set_on_event_cb,
950 .hook_api_api_set_on_init = hook_api_api_set_on_init_cb,
951 .hook_api_api_seal = hook_api_api_seal_cb,
952 .hook_api_event_handler_add = hook_api_event_handler_add_cb,
953 .hook_api_event_handler_del = hook_api_event_handler_del_cb,
954 .hook_api_class_provide = hook_api_class_provide_cb,
955 .hook_api_class_require = hook_api_class_require_cb,
956 .hook_api_delete_api = hook_api_delete_api_cb,
957 .hook_api_on_event_handler_before = hook_api_on_event_handler_before_cb,
958 .hook_api_on_event_handler_after = hook_api_on_event_handler_after_cb,
959 .hook_api_settings = hook_api_settings_cb,
962 /******************************************************************************
963 * section: hooks for tracing daemon interface (export)
964 *****************************************************************************/
966 #define _HOOK_API_2_(flag,func,...) \
967 struct afb_hook_api *hook; \
968 struct afb_hookid hookid; \
969 const char *apiname = afb_export_apiname(export); \
970 pthread_rwlock_rdlock(&rwlock); \
971 init_hookid(&hookid); \
972 hook = list_of_api_hooks; \
975 && hook->itf->hook_api_##func \
976 && (hook->flags & afb_hook_flag_api_##flag) != 0 \
977 && MATCH_API(hook->api, apiname)) { \
978 hook->itf->hook_api_##func(hook->closure, &hookid, __VA_ARGS__); \
982 pthread_rwlock_unlock(&rwlock);
984 #define _HOOK_API_(what,...) _HOOK_API_2_(what,what,__VA_ARGS__)
986 void afb_hook_api_event_broadcast_before(const struct afb_export *export, const char *name, struct json_object *object)
988 _HOOK_API_2_(event_broadcast, event_broadcast_before, export, name, object);
991 int afb_hook_api_event_broadcast_after(const struct afb_export *export, const char *name, struct json_object *object, int result)
993 _HOOK_API_2_(event_broadcast, event_broadcast_after, export, name, object, result);
997 struct sd_event *afb_hook_api_get_event_loop(const struct afb_export *export, struct sd_event *result)
999 _HOOK_API_(get_event_loop, export, result);
1003 struct sd_bus *afb_hook_api_get_user_bus(const struct afb_export *export, struct sd_bus *result)
1005 _HOOK_API_(get_user_bus, export, result);
1009 struct sd_bus *afb_hook_api_get_system_bus(const struct afb_export *export, struct sd_bus *result)
1011 _HOOK_API_(get_system_bus, export, result);
1015 void afb_hook_api_vverbose(const struct afb_export *export, int level, const char *file, int line, const char *function, const char *fmt, va_list args)
1017 _HOOK_API_(vverbose, export, level, file, line, function, fmt, args);
1020 struct afb_event_x2 *afb_hook_api_event_make(const struct afb_export *export, const char *name, struct afb_event_x2 *result)
1022 _HOOK_API_(event_make, export, name, result);
1026 int afb_hook_api_rootdir_get_fd(const struct afb_export *export, int result)
1028 _HOOK_API_(rootdir_get_fd, export, result);
1032 int afb_hook_api_rootdir_open_locale(const struct afb_export *export, const char *filename, int flags, const char *locale, int result)
1034 _HOOK_API_(rootdir_open_locale, export, filename, flags, locale, result);
1038 int afb_hook_api_queue_job(const struct afb_export *export, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout, int result)
1040 _HOOK_API_(queue_job, export, callback, argument, group, timeout, result);
1044 void afb_hook_api_legacy_unstore_req(const struct afb_export *export, struct afb_stored_req *sreq)
1046 _HOOK_API_(legacy_unstore_req, export, sreq);
1049 void afb_hook_api_require_api(const struct afb_export *export, const char *name, int initialized)
1051 _HOOK_API_(require_api, export, name, initialized);
1054 int afb_hook_api_require_api_result(const struct afb_export *export, const char *name, int initialized, int result)
1056 _HOOK_API_2_(require_api, require_api_result, export, name, initialized, result);
1060 int afb_hook_api_add_alias(const struct afb_export *export, const char *api, const char *alias, int result)
1062 _HOOK_API_(add_alias, export, api, alias, result);
1066 void afb_hook_api_start_before(const struct afb_export *export)
1068 _HOOK_API_2_(start, start_before, export);
1071 int afb_hook_api_start_after(const struct afb_export *export, int status)
1073 _HOOK_API_2_(start, start_after, export, status);
1077 void afb_hook_api_on_event_before(const struct afb_export *export, const char *event, int event_x2, struct json_object *object)
1079 _HOOK_API_2_(on_event, on_event_before, export, event, event_x2, object);
1082 void afb_hook_api_on_event_after(const struct afb_export *export, const char *event, int event_x2, struct json_object *object)
1084 _HOOK_API_2_(on_event, on_event_after, export, event, event_x2, object);
1087 void afb_hook_api_call(const struct afb_export *export, const char *api, const char *verb, struct json_object *args)
1089 _HOOK_API_(call, export, api, verb, args);
1092 void afb_hook_api_call_result(const struct afb_export *export, struct json_object *object, const char*error, const char *info)
1094 _HOOK_API_2_(call, call_result, export, object, error, info);
1098 void afb_hook_api_callsync(const struct afb_export *export, const char *api, const char *verb, struct json_object *args)
1100 _HOOK_API_(callsync, export, api, verb, args);
1103 int afb_hook_api_callsync_result(const struct afb_export *export, int status, struct json_object *object, const char *error, const char *info)
1105 _HOOK_API_2_(callsync, callsync_result, export, status, object, error, info);
1109 void afb_hook_api_new_api_before(const struct afb_export *export, const char *api, const char *info, int noconcurrency)
1111 _HOOK_API_2_(new_api, new_api_before, export, api, info, noconcurrency);
1114 int afb_hook_api_new_api_after(const struct afb_export *export, int result, const char *api)
1116 _HOOK_API_2_(new_api, new_api_after, export, result, api);
1120 int afb_hook_api_api_set_verbs_v2(const struct afb_export *export, int result, const struct afb_verb_v2 *verbs)
1122 _HOOK_API_2_(api_set_verbs, api_set_verbs_v2, export, result, verbs);
1126 int afb_hook_api_api_set_verbs_v3(const struct afb_export *export, int result, const struct afb_verb_v3 *verbs)
1128 _HOOK_API_2_(api_set_verbs, api_set_verbs_v3, export, result, verbs);
1132 int afb_hook_api_api_add_verb(const struct afb_export *export, int result, const char *verb, const char *info, int glob)
1134 _HOOK_API_(api_add_verb, export, result, verb, info, glob);
1138 int afb_hook_api_api_del_verb(const struct afb_export *export, int result, const char *verb)
1140 _HOOK_API_(api_del_verb, export, result, verb);
1144 int afb_hook_api_api_set_on_event(const struct afb_export *export, int result)
1146 _HOOK_API_(api_set_on_event, export, result);
1150 int afb_hook_api_api_set_on_init(const struct afb_export *export, int result)
1152 _HOOK_API_(api_set_on_init, export, result);
1156 void afb_hook_api_api_seal(const struct afb_export *export)
1158 _HOOK_API_(api_seal, export);
1161 int afb_hook_api_event_handler_add(const struct afb_export *export, int result, const char *pattern)
1163 _HOOK_API_(event_handler_add, export, result, pattern);
1166 int afb_hook_api_event_handler_del(const struct afb_export *export, int result, const char *pattern)
1168 _HOOK_API_(event_handler_del, export, result, pattern);
1171 int afb_hook_api_class_provide(const struct afb_export *export, int result, const char *name)
1173 _HOOK_API_(class_provide, export, result, name);
1176 int afb_hook_api_class_require(const struct afb_export *export, int result, const char *name)
1178 _HOOK_API_(class_require, export, result, name);
1182 int afb_hook_api_delete_api(const struct afb_export *export, int result)
1184 _HOOK_API_(delete_api, export, result);
1188 void afb_hook_api_on_event_handler_before(const struct afb_export *export, const char *event, int event_x2, struct json_object *object, const char *pattern)
1190 _HOOK_API_2_(on_event_handler, on_event_handler_before, export, event, event_x2, object, pattern);
1193 void afb_hook_api_on_event_handler_after(const struct afb_export *export, const char *event, int event_x2, struct json_object *object, const char *pattern)
1195 _HOOK_API_2_(on_event_handler, on_event_handler_after, export, event, event_x2, object, pattern);
1198 struct json_object *afb_hook_api_settings(const struct afb_export *export, struct json_object *object)
1200 _HOOK_API_(settings, export, object);
1204 /******************************************************************************
1205 * section: hooking export
1206 *****************************************************************************/
1208 int afb_hook_flags_api(const char *api)
1211 struct afb_hook_api *hook;
1214 pthread_rwlock_rdlock(&rwlock);
1215 hook = list_of_api_hooks;
1217 if (!api || MATCH_API(hook->api, api))
1218 flags |= hook->flags;
1221 pthread_rwlock_unlock(&rwlock);
1225 struct afb_hook_api *afb_hook_create_api(const char *api, int flags, struct afb_hook_api_itf *itf, void *closure)
1227 struct afb_hook_api *hook;
1229 /* alloc the result */
1230 hook = calloc(1, sizeof *hook);
1234 /* get a copy of the names */
1235 hook->api = api ? strdup(api) : NULL;
1236 if (api && !hook->api) {
1241 /* initialise the rest */
1243 hook->flags = flags;
1244 hook->itf = itf ? itf : &hook_api_default_itf;
1245 hook->closure = closure;
1247 /* record the hook */
1248 pthread_mutex_lock(&mutex);
1249 hook->next = list_of_api_hooks;
1250 list_of_api_hooks = hook;
1251 pthread_mutex_unlock(&mutex);
1257 struct afb_hook_api *afb_hook_addref_api(struct afb_hook_api *hook)
1259 __atomic_add_fetch(&hook->refcount, 1, __ATOMIC_RELAXED);
1263 static void hook_clean_api()
1265 struct afb_hook_api **prv, *hook, *head;
1267 if (pthread_rwlock_trywrlock(&rwlock) == 0) {
1268 /* unlink under mutex */
1270 pthread_mutex_lock(&mutex);
1271 prv = &list_of_api_hooks;
1272 while ((hook = *prv)) {
1274 prv = &(*prv)->next;
1281 pthread_mutex_unlock(&mutex);
1282 pthread_rwlock_unlock(&rwlock);
1284 /* free found hooks */
1285 while((hook = head)) {
1293 void afb_hook_unref_api(struct afb_hook_api *hook)
1295 if (hook && !__atomic_sub_fetch(&hook->refcount, 1, __ATOMIC_RELAXED))
1299 /******************************************************************************
1300 * section: default callbacks for tracing service interface (evt)
1301 *****************************************************************************/
1303 static void _hook_evt_(const char *evt, int id, const char *format, ...)
1306 va_start(ap, format);
1307 _hook_("evt-%s:%d", format, ap, evt, id);
1311 static void hook_evt_create_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
1313 _hook_evt_(evt, id, "create");
1316 static void hook_evt_push_before_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj)
1318 _hook_evt_(evt, id, "push.before(%s)", json_object_to_json_string_ext(obj, JSON_C_TO_STRING_NOSLASHESCAPE));
1322 static void hook_evt_push_after_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj, int result)
1324 _hook_evt_(evt, id, "push.after(%s) -> %d", json_object_to_json_string_ext(obj, JSON_C_TO_STRING_NOSLASHESCAPE), result);
1327 static void hook_evt_broadcast_before_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj)
1329 _hook_evt_(evt, id, "broadcast.before(%s)", json_object_to_json_string_ext(obj, JSON_C_TO_STRING_NOSLASHESCAPE));
1332 static void hook_evt_broadcast_after_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj, int result)
1334 _hook_evt_(evt, id, "broadcast.after(%s) -> %d", json_object_to_json_string_ext(obj, JSON_C_TO_STRING_NOSLASHESCAPE), result);
1337 static void hook_evt_name_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, const char *result)
1339 _hook_evt_(evt, id, "name -> %s", result);
1342 static void hook_evt_addref_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
1344 _hook_evt_(evt, id, "addref");
1347 static void hook_evt_unref_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
1349 _hook_evt_(evt, id, "unref");
1352 static struct afb_hook_evt_itf hook_evt_default_itf = {
1353 .hook_evt_create = hook_evt_create_cb,
1354 .hook_evt_push_before = hook_evt_push_before_cb,
1355 .hook_evt_push_after = hook_evt_push_after_cb,
1356 .hook_evt_broadcast_before = hook_evt_broadcast_before_cb,
1357 .hook_evt_broadcast_after = hook_evt_broadcast_after_cb,
1358 .hook_evt_name = hook_evt_name_cb,
1359 .hook_evt_addref = hook_evt_addref_cb,
1360 .hook_evt_unref = hook_evt_unref_cb
1363 /******************************************************************************
1364 * section: hooks for tracing events interface (evt)
1365 *****************************************************************************/
1367 #define _HOOK_EVT_(what,...) \
1368 struct afb_hook_evt *hook; \
1369 struct afb_hookid hookid; \
1370 pthread_rwlock_rdlock(&rwlock); \
1371 init_hookid(&hookid); \
1372 hook = list_of_evt_hooks; \
1374 if (hook->refcount \
1375 && hook->itf->hook_evt_##what \
1376 && (hook->flags & afb_hook_flag_evt_##what) != 0 \
1377 && MATCH_EVENT(hook->pattern, evt)) { \
1378 hook->itf->hook_evt_##what(hook->closure, &hookid, __VA_ARGS__); \
1380 hook = hook->next; \
1382 pthread_rwlock_unlock(&rwlock);
1384 void afb_hook_evt_create(const char *evt, int id)
1386 _HOOK_EVT_(create, evt, id);
1389 void afb_hook_evt_push_before(const char *evt, int id, struct json_object *obj)
1391 _HOOK_EVT_(push_before, evt, id, obj);
1394 int afb_hook_evt_push_after(const char *evt, int id, struct json_object *obj, int result)
1396 _HOOK_EVT_(push_after, evt, id, obj, result);
1400 void afb_hook_evt_broadcast_before(const char *evt, int id, struct json_object *obj)
1402 _HOOK_EVT_(broadcast_before, evt, id, obj);
1405 int afb_hook_evt_broadcast_after(const char *evt, int id, struct json_object *obj, int result)
1407 _HOOK_EVT_(broadcast_after, evt, id, obj, result);
1411 void afb_hook_evt_name(const char *evt, int id, const char *result)
1413 _HOOK_EVT_(name, evt, id, result);
1416 void afb_hook_evt_addref(const char *evt, int id)
1418 _HOOK_EVT_(addref, evt, id);
1421 void afb_hook_evt_unref(const char *evt, int id)
1423 _HOOK_EVT_(unref, evt, id);
1426 /******************************************************************************
1427 * section: hooking services (evt)
1428 *****************************************************************************/
1430 int afb_hook_flags_evt(const char *name)
1433 struct afb_hook_evt *hook;
1436 pthread_rwlock_rdlock(&rwlock);
1437 hook = list_of_evt_hooks;
1439 if (!name || MATCH_EVENT(hook->pattern, name))
1440 flags |= hook->flags;
1443 pthread_rwlock_unlock(&rwlock);
1447 struct afb_hook_evt *afb_hook_create_evt(const char *pattern, int flags, struct afb_hook_evt_itf *itf, void *closure)
1449 struct afb_hook_evt *hook;
1451 /* alloc the result */
1452 hook = calloc(1, sizeof *hook);
1456 /* get a copy of the names */
1457 hook->pattern = pattern ? strdup(pattern) : NULL;
1458 if (pattern && !hook->pattern) {
1463 /* initialise the rest */
1465 hook->flags = flags;
1466 hook->itf = itf ? itf : &hook_evt_default_itf;
1467 hook->closure = closure;
1469 /* record the hook */
1470 pthread_mutex_lock(&mutex);
1471 hook->next = list_of_evt_hooks;
1472 list_of_evt_hooks = hook;
1473 pthread_mutex_unlock(&mutex);
1479 struct afb_hook_evt *afb_hook_addref_evt(struct afb_hook_evt *hook)
1481 __atomic_add_fetch(&hook->refcount, 1, __ATOMIC_RELAXED);
1485 static void hook_clean_evt()
1487 struct afb_hook_evt **prv, *hook, *head;
1489 if (pthread_rwlock_trywrlock(&rwlock) == 0) {
1490 /* unlink under mutex */
1492 pthread_mutex_lock(&mutex);
1493 prv = &list_of_evt_hooks;
1494 while ((hook = *prv)) {
1496 prv = &(*prv)->next;
1503 pthread_mutex_unlock(&mutex);
1504 pthread_rwlock_unlock(&rwlock);
1506 /* free found hooks */
1507 while((hook = head)) {
1509 free(hook->pattern);
1515 void afb_hook_unref_evt(struct afb_hook_evt *hook)
1517 if (hook && !__atomic_sub_fetch(&hook->refcount, 1, __ATOMIC_RELAXED))
1521 /******************************************************************************
1522 * section: default callbacks for sessions (session)
1523 *****************************************************************************/
1525 static void _hook_session_(struct afb_session *session, const char *format, ...)
1528 va_start(ap, format);
1529 _hook_("session-%s", format, ap, afb_session_uuid(session));
1533 static void hook_session_create_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
1535 _hook_session_(session, "create -> token=%s", afb_session_token(session));
1538 static void hook_session_close_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
1540 _hook_session_(session, "close");
1543 static void hook_session_destroy_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
1545 _hook_session_(session, "destroy");
1548 static void hook_session_renew_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
1550 _hook_session_(session, "renew -> token=%s", afb_session_token(session));
1553 static void hook_session_addref_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
1555 _hook_session_(session, "addref");
1558 static void hook_session_unref_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
1560 _hook_session_(session, "unref");
1563 static struct afb_hook_session_itf hook_session_default_itf = {
1564 .hook_session_create = hook_session_create_cb,
1565 .hook_session_close = hook_session_close_cb,
1566 .hook_session_destroy = hook_session_destroy_cb,
1567 .hook_session_renew = hook_session_renew_cb,
1568 .hook_session_addref = hook_session_addref_cb,
1569 .hook_session_unref = hook_session_unref_cb
1572 /******************************************************************************
1573 * section: hooks for tracing sessions (session)
1574 *****************************************************************************/
1576 #define _HOOK_SESSION_(what,...) \
1577 struct afb_hook_session *hook; \
1578 struct afb_hookid hookid; \
1579 const char *sessid = 0; \
1580 pthread_rwlock_rdlock(&rwlock); \
1581 init_hookid(&hookid); \
1582 hook = list_of_session_hooks; \
1584 if (hook->refcount \
1585 && hook->itf->hook_session_##what \
1586 && (hook->flags & afb_hook_flag_session_##what) != 0 \
1587 && MATCH_SESSION(hook->pattern, (sessid?:(sessid=afb_session_uuid(session))))) { \
1588 hook->itf->hook_session_##what(hook->closure, &hookid, __VA_ARGS__); \
1590 hook = hook->next; \
1592 pthread_rwlock_unlock(&rwlock);
1594 void afb_hook_session_create(struct afb_session *session)
1596 _HOOK_SESSION_(create, session);
1599 void afb_hook_session_close(struct afb_session *session)
1601 _HOOK_SESSION_(close, session);
1604 void afb_hook_session_destroy(struct afb_session *session)
1606 _HOOK_SESSION_(destroy, session);
1609 void afb_hook_session_renew(struct afb_session *session)
1611 _HOOK_SESSION_(renew, session);
1614 void afb_hook_session_addref(struct afb_session *session)
1616 _HOOK_SESSION_(addref, session);
1619 void afb_hook_session_unref(struct afb_session *session)
1621 _HOOK_SESSION_(unref, session);
1625 /******************************************************************************
1626 * section: hooking sessions (session)
1627 *****************************************************************************/
1629 struct afb_hook_session *afb_hook_create_session(const char *pattern, int flags, struct afb_hook_session_itf *itf, void *closure)
1631 struct afb_hook_session *hook;
1633 /* alloc the result */
1634 hook = calloc(1, sizeof *hook);
1638 /* get a copy of the names */
1639 hook->pattern = pattern ? strdup(pattern) : NULL;
1640 if (pattern && !hook->pattern) {
1645 /* initialise the rest */
1647 hook->flags = flags;
1648 hook->itf = itf ? itf : &hook_session_default_itf;
1649 hook->closure = closure;
1651 /* record the hook */
1652 pthread_mutex_lock(&mutex);
1653 hook->next = list_of_session_hooks;
1654 list_of_session_hooks = hook;
1655 pthread_mutex_unlock(&mutex);
1661 struct afb_hook_session *afb_hook_addref_session(struct afb_hook_session *hook)
1663 __atomic_add_fetch(&hook->refcount, 1, __ATOMIC_RELAXED);
1667 static void hook_clean_session()
1669 struct afb_hook_session **prv, *hook, *head;
1671 if (pthread_rwlock_trywrlock(&rwlock) == 0) {
1672 /* unlink under mutex */
1674 pthread_mutex_lock(&mutex);
1675 prv = &list_of_session_hooks;
1676 while ((hook = *prv)) {
1678 prv = &(*prv)->next;
1685 pthread_mutex_unlock(&mutex);
1686 pthread_rwlock_unlock(&rwlock);
1688 /* free found hooks */
1689 while((hook = head)) {
1691 free(hook->pattern);
1697 void afb_hook_unref_session(struct afb_hook_session *hook)
1699 if (hook && !__atomic_sub_fetch(&hook->refcount, 1, __ATOMIC_RELAXED))
1700 hook_clean_session();
1703 /******************************************************************************
1704 * section: default callbacks for globals (global)
1705 *****************************************************************************/
1707 static void _hook_global_(const char *format, ...)
1710 va_start(ap, format);
1711 _hook_("global", format, ap);
1715 static void hook_global_vverbose_cb(void *closure, const struct afb_hookid *hookid, int level, const char *file, int line, const char *func, const char *fmt, va_list args)
1722 len = vasprintf(&msg, fmt, ap);
1726 _hook_global_("vverbose(%d:%s, %s, %d, %s) -> %s ? ? ?", level, verbose_name_of_level(level), file, line, func, fmt);
1728 _hook_global_("vverbose(%d:%s, %s, %d, %s) -> %s", level, verbose_name_of_level(level), file, line, func, msg);
1733 static struct afb_hook_global_itf hook_global_default_itf = {
1734 .hook_global_vverbose = hook_global_vverbose_cb
1737 /******************************************************************************
1738 * section: hooks for tracing globals (global)
1739 *****************************************************************************/
1741 #define _HOOK_GLOBAL_(what,...) \
1742 struct afb_hook_global *hook; \
1743 struct afb_hookid hookid; \
1744 pthread_rwlock_rdlock(&rwlock); \
1745 init_hookid(&hookid); \
1746 hook = list_of_global_hooks; \
1748 if (hook->refcount \
1749 && hook->itf->hook_global_##what \
1750 && (hook->flags & afb_hook_flag_global_##what) != 0) { \
1751 hook->itf->hook_global_##what(hook->closure, &hookid, __VA_ARGS__); \
1753 hook = hook->next; \
1755 pthread_rwlock_unlock(&rwlock);
1757 static void afb_hook_global_vverbose(int level, const char *file, int line, const char *func, const char *fmt, va_list args)
1759 _HOOK_GLOBAL_(vverbose, level, file ?: "?", line, func ?: "?", fmt ?: "", args);
1762 /******************************************************************************
1763 * section: hooking globals (global)
1764 *****************************************************************************/
1766 static void update_global()
1768 struct afb_hook_global *hook;
1771 pthread_rwlock_rdlock(&rwlock);
1772 hook = list_of_global_hooks;
1775 flags = hook->flags;
1778 verbose_observer = (flags & afb_hook_flag_global_vverbose) ? afb_hook_global_vverbose : NULL;
1779 pthread_rwlock_unlock(&rwlock);
1782 struct afb_hook_global *afb_hook_create_global(int flags, struct afb_hook_global_itf *itf, void *closure)
1784 struct afb_hook_global *hook;
1786 /* alloc the result */
1787 hook = calloc(1, sizeof *hook);
1791 /* initialise the rest */
1793 hook->flags = flags;
1794 hook->itf = itf ? itf : &hook_global_default_itf;
1795 hook->closure = closure;
1797 /* record the hook */
1798 pthread_mutex_lock(&mutex);
1799 hook->next = list_of_global_hooks;
1800 list_of_global_hooks = hook;
1801 pthread_mutex_unlock(&mutex);
1803 /* update hooking */
1810 struct afb_hook_global *afb_hook_addref_global(struct afb_hook_global *hook)
1812 __atomic_add_fetch(&hook->refcount, 1, __ATOMIC_RELAXED);
1816 static void hook_clean_global()
1818 struct afb_hook_global **prv, *hook, *head;
1820 if (pthread_rwlock_trywrlock(&rwlock) == 0) {
1821 /* unlink under mutex */
1823 pthread_mutex_lock(&mutex);
1824 prv = &list_of_global_hooks;
1825 while ((hook = *prv)) {
1827 prv = &(*prv)->next;
1834 pthread_mutex_unlock(&mutex);
1835 pthread_rwlock_unlock(&rwlock);
1837 /* free found hooks */
1838 while((hook = head)) {
1845 void afb_hook_unref_global(struct afb_hook_global *hook)
1847 if (hook && !__atomic_sub_fetch(&hook->refcount, 1, __ATOMIC_RELAXED)) {
1848 /* update hooking */
1850 hook_clean_global();
1854 #endif /* WITH_AFB_HOOK *******************************************************/