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"
50 #define MATCH(pattern,string) (\
52 ? !fnmatch((pattern),(string),FNM_CASEFOLD|FNM_EXTMATCH|FNM_PERIOD) \
53 : afb_api_is_public(string))
55 #define MATCH_API(pattern,string) MATCH(pattern,string)
56 #define MATCH_VERB(pattern,string) MATCH(pattern,string)
57 #define MATCH_EVENT(pattern,string) MATCH(pattern,string)
58 #define MATCH_SESSION(pattern,string) MATCH(pattern,string)
61 * Definition of a hook for xreq
63 struct afb_hook_xreq {
64 struct afb_hook_xreq *next; /**< next hook */
65 unsigned refcount; /**< reference count */
66 unsigned flags; /**< hook flags */
67 char *api; /**< api hooked or NULL for any */
68 char *verb; /**< verb hooked or NULL for any */
69 struct afb_session *session; /**< session hooked or NULL if any */
70 struct afb_hook_xreq_itf *itf; /**< interface of hook */
71 void *closure; /**< closure for callbacks */
75 * Definition of a hook for export
78 struct afb_hook_api *next; /**< next hook */
79 unsigned refcount; /**< reference count */
80 unsigned flags; /**< hook flags */
81 char *api; /**< api hooked or NULL for any */
82 struct afb_hook_api_itf *itf; /**< interface of hook */
83 void *closure; /**< closure for callbacks */
87 * Definition of a hook for evt
90 struct afb_hook_evt *next; /**< next hook */
91 unsigned refcount; /**< reference count */
92 unsigned flags; /**< hook flags */
93 char *pattern; /**< event pattern name hooked or NULL for any */
94 struct afb_hook_evt_itf *itf; /**< interface of hook */
95 void *closure; /**< closure for callbacks */
99 * Definition of a hook for session
101 struct afb_hook_session {
102 struct afb_hook_session *next; /**< next hook */
103 unsigned refcount; /**< reference count */
104 unsigned flags; /**< hook flags */
105 char *pattern; /**< event pattern name hooked or NULL for any */
106 struct afb_hook_session_itf *itf; /**< interface of hook */
107 void *closure; /**< closure for callbacks */
111 * Definition of a hook for global
113 struct afb_hook_global {
114 struct afb_hook_global *next; /**< next hook */
115 unsigned refcount; /**< reference count */
116 unsigned flags; /**< hook flags */
117 struct afb_hook_global_itf *itf; /**< interface of hook */
118 void *closure; /**< closure for callbacks */
121 /* synchronization across threads */
122 static pthread_rwlock_t rwlock = PTHREAD_RWLOCK_INITIALIZER;
123 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
125 /* list of hooks for xreq */
126 static struct afb_hook_xreq *list_of_xreq_hooks = NULL;
128 /* list of hooks for export */
129 static struct afb_hook_api *list_of_api_hooks = NULL;
131 /* list of hooks for evt */
132 static struct afb_hook_evt *list_of_evt_hooks = NULL;
134 /* list of hooks for session */
135 static struct afb_hook_session *list_of_session_hooks = NULL;
137 /* list of hooks for global */
138 static struct afb_hook_global *list_of_global_hooks = NULL;
141 static unsigned next_hookid = 0;
143 /******************************************************************************
145 *****************************************************************************/
146 static void init_hookid(struct afb_hookid *hookid)
148 hookid->id = __atomic_add_fetch(&next_hookid, 1, __ATOMIC_RELAXED);
149 clock_gettime(CLOCK_REALTIME, &hookid->time);
152 /******************************************************************************
153 * section: default callbacks for tracing requests
154 *****************************************************************************/
156 static char *_pbuf_(const char *fmt, va_list args, char **palloc, char *sbuf, size_t szsbuf, size_t *outlen)
163 rc = vsnprintf(sbuf, szsbuf, fmt, args);
164 if ((size_t)rc >= szsbuf) {
166 sbuf[szsbuf-2] = sbuf[szsbuf-3] = sbuf[szsbuf-4] = '.';
167 rc = vasprintf(palloc, fmt, cp);
172 if (rc >= 0 && outlen)
173 *outlen = (size_t)rc;
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];
185 iov[0].iov_base = (void*)&chars[0];
189 va_start(arg1, arg2);
190 iov[1].iov_base = _pbuf_(fmt1, arg1, &mem1, buf1, sizeof buf1, &iov[1].iov_len);
194 iov[2].iov_base = (void*)&chars[7];
198 iov[3].iov_base = _pbuf_(fmt2, arg2, &mem2, buf2, sizeof buf2, &iov[3].iov_len);
201 iov[4].iov_base = (void*)&chars[9];
204 (void)writev(2, iov, 5);
210 static void _hook_xreq_(const struct afb_xreq *xreq, const char *format, ...)
213 va_start(ap, format);
214 _hook_("xreq-%06d:%s/%s", format, ap, xreq->hookindex, xreq->request.called_api, xreq->request.called_verb);
218 static void hook_xreq_begin_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
221 _hook_xreq_(xreq, "BEGIN");
223 _hook_xreq_(xreq, "BEGIN uid=%d=%s gid=%d pid=%d label=%s id=%s",
224 (int)xreq->cred->uid,
226 (int)xreq->cred->gid,
227 (int)xreq->cred->pid,
228 xreq->cred->label?:"(null)",
229 xreq->cred->id?:"(null)"
233 static void hook_xreq_end_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
235 _hook_xreq_(xreq, "END");
238 static void hook_xreq_json_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct json_object *obj)
240 _hook_xreq_(xreq, "json() -> %s", json_object_to_json_string_ext(obj, JSON_C_TO_STRING_NOSLASHESCAPE));
243 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)
245 _hook_xreq_(xreq, "get(%s) -> { name: %s, value: %s, path: %s }", name, arg.name, arg.value, arg.path);
248 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)
250 _hook_xreq_(xreq, "reply[%s](%s, %s)", error?:"success", json_object_to_json_string_ext(obj, JSON_C_TO_STRING_NOSLASHESCAPE), info);
253 static void hook_xreq_legacy_context_get_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, void *value)
255 _hook_xreq_(xreq, "context_get() -> %p", value);
258 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*))
260 _hook_xreq_(xreq, "context_set(%p, %p)", value, free_value);
263 static void hook_xreq_addref_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
265 _hook_xreq_(xreq, "addref()");
268 static void hook_xreq_unref_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
270 _hook_xreq_(xreq, "unref()");
273 static void hook_xreq_session_close_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
275 _hook_xreq_(xreq, "session_close()");
278 static void hook_xreq_session_set_LOA_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, unsigned level, int result)
280 _hook_xreq_(xreq, "session_set_LOA(%u) -> %d", level, result);
283 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)
285 _hook_xreq_(xreq, "subscribe(%s:%d) -> %d", afb_evt_event_x2_fullname(event_x2), afb_evt_event_x2_id(event_x2), result);
288 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)
290 _hook_xreq_(xreq, "unsubscribe(%s:%d) -> %d", afb_evt_event_x2_fullname(event_x2), afb_evt_event_x2_id(event_x2), result);
293 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)
295 _hook_xreq_(xreq, "subcall(%s/%s, %s) ...", api, verb, json_object_to_json_string_ext(args, JSON_C_TO_STRING_NOSLASHESCAPE));
298 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)
300 _hook_xreq_(xreq, " ...subcall... [%s] -> %s (%s)", error?:"success", json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE), info?:"");
303 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)
305 _hook_xreq_(xreq, "subcallsync(%s/%s, %s) ...", api, verb, json_object_to_json_string_ext(args, JSON_C_TO_STRING_NOSLASHESCAPE));
308 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)
310 _hook_xreq_(xreq, " ...subcallsync... %d [%s] -> %s (%s)", status, error?:"success", json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE), info?:"");
313 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)
320 len = vasprintf(&msg, fmt, ap);
324 _hook_xreq_(xreq, "vverbose(%d:%s, %s, %d, %s) -> %s ? ? ?", level, verbose_name_of_level(level), file, line, func, fmt);
326 _hook_xreq_(xreq, "vverbose(%d:%s, %s, %d, %s) -> %s", level, verbose_name_of_level(level), file, line, func, msg);
331 static void hook_xreq_legacy_store_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_stored_req *sreq)
333 _hook_xreq_(xreq, "store() -> %p", sreq);
336 static void hook_xreq_legacy_unstore_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
338 _hook_xreq_(xreq, "unstore()");
341 static void hook_xreq_has_permission_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *permission, int result)
343 _hook_xreq_(xreq, "has_permission(%s) -> %d", permission, result);
346 static void hook_xreq_get_application_id_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, char *result)
348 _hook_xreq_(xreq, "get_application_id() -> %s", result);
351 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)
353 _hook_xreq_(xreq, "context_make(replace=%s, %p, %p, %p) -> %p", replace?"yes":"no", create_value, free_value, create_closure, result);
356 static void hook_xreq_get_uid_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int result)
358 _hook_xreq_(xreq, "get_uid() -> %d", result);
361 static void hook_xreq_get_client_info_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct json_object *result)
363 _hook_xreq_(xreq, "get_client_info() -> %s", json_object_to_json_string_ext(result, JSON_C_TO_STRING_NOSLASHESCAPE));
366 static struct afb_hook_xreq_itf hook_xreq_default_itf = {
367 .hook_xreq_begin = hook_xreq_begin_cb,
368 .hook_xreq_end = hook_xreq_end_cb,
369 .hook_xreq_json = hook_xreq_json_cb,
370 .hook_xreq_get = hook_xreq_get_cb,
371 .hook_xreq_reply = hook_xreq_reply_cb,
372 .hook_xreq_legacy_context_get = hook_xreq_legacy_context_get_cb,
373 .hook_xreq_legacy_context_set = hook_xreq_legacy_context_set_cb,
374 .hook_xreq_addref = hook_xreq_addref_cb,
375 .hook_xreq_unref = hook_xreq_unref_cb,
376 .hook_xreq_session_close = hook_xreq_session_close_cb,
377 .hook_xreq_session_set_LOA = hook_xreq_session_set_LOA_cb,
378 .hook_xreq_subscribe = hook_xreq_subscribe_cb,
379 .hook_xreq_unsubscribe = hook_xreq_unsubscribe_cb,
380 .hook_xreq_subcall = hook_xreq_subcall_cb,
381 .hook_xreq_subcall_result = hook_xreq_subcall_result_cb,
382 .hook_xreq_subcallsync = hook_xreq_subcallsync_cb,
383 .hook_xreq_subcallsync_result = hook_xreq_subcallsync_result_cb,
384 .hook_xreq_vverbose = hook_xreq_vverbose_cb,
385 .hook_xreq_legacy_store = hook_xreq_legacy_store_cb,
386 .hook_xreq_legacy_unstore = hook_xreq_legacy_unstore_cb,
387 .hook_xreq_has_permission = hook_xreq_has_permission_cb,
388 .hook_xreq_get_application_id = hook_xreq_get_application_id_cb,
389 .hook_xreq_context_make = hook_xreq_context_make_cb,
390 .hook_xreq_get_uid = hook_xreq_get_uid_cb,
391 .hook_xreq_get_client_info = hook_xreq_get_client_info_cb,
394 /******************************************************************************
395 * section: hooks for tracing requests
396 *****************************************************************************/
398 #define _HOOK_XREQ_2_(flag,func,...) \
399 struct afb_hook_xreq *hook; \
400 struct afb_hookid hookid; \
401 pthread_rwlock_rdlock(&rwlock); \
402 init_hookid(&hookid); \
403 hook = list_of_xreq_hooks; \
406 && hook->itf->hook_xreq_##func \
407 && (hook->flags & afb_hook_flag_req_##flag) != 0 \
408 && (!hook->session || hook->session == xreq->context.session) \
409 && MATCH_API(hook->api, xreq->request.called_api) \
410 && MATCH_VERB(hook->verb, xreq->request.called_verb)) { \
411 hook->itf->hook_xreq_##func(hook->closure, &hookid, __VA_ARGS__); \
415 pthread_rwlock_unlock(&rwlock);
417 #define _HOOK_XREQ_(what,...) _HOOK_XREQ_2_(what,what,__VA_ARGS__)
419 void afb_hook_xreq_begin(const struct afb_xreq *xreq)
421 _HOOK_XREQ_(begin, xreq);
424 void afb_hook_xreq_end(const struct afb_xreq *xreq)
426 _HOOK_XREQ_(end, xreq);
429 struct json_object *afb_hook_xreq_json(const struct afb_xreq *xreq, struct json_object *obj)
431 _HOOK_XREQ_(json, xreq, obj);
435 struct afb_arg afb_hook_xreq_get(const struct afb_xreq *xreq, const char *name, struct afb_arg arg)
437 _HOOK_XREQ_(get, xreq, name, arg);
441 void afb_hook_xreq_reply(const struct afb_xreq *xreq, struct json_object *obj, const char *error, const char *info)
443 _HOOK_XREQ_(reply, xreq, obj, error, info);
446 void *afb_hook_xreq_legacy_context_get(const struct afb_xreq *xreq, void *value)
448 _HOOK_XREQ_(legacy_context_get, xreq, value);
452 void afb_hook_xreq_legacy_context_set(const struct afb_xreq *xreq, void *value, void (*free_value)(void*))
454 _HOOK_XREQ_(legacy_context_set, xreq, value, free_value);
457 void afb_hook_xreq_addref(const struct afb_xreq *xreq)
459 _HOOK_XREQ_(addref, xreq);
462 void afb_hook_xreq_unref(const struct afb_xreq *xreq)
464 _HOOK_XREQ_(unref, xreq);
467 void afb_hook_xreq_session_close(const struct afb_xreq *xreq)
469 _HOOK_XREQ_(session_close, xreq);
472 int afb_hook_xreq_session_set_LOA(const struct afb_xreq *xreq, unsigned level, int result)
474 _HOOK_XREQ_(session_set_LOA, xreq, level, result);
478 int afb_hook_xreq_subscribe(const struct afb_xreq *xreq, struct afb_event_x2 *event_x2, int result)
480 _HOOK_XREQ_(subscribe, xreq, event_x2, result);
484 int afb_hook_xreq_unsubscribe(const struct afb_xreq *xreq, struct afb_event_x2 *event_x2, int result)
486 _HOOK_XREQ_(unsubscribe, xreq, event_x2, result);
490 void afb_hook_xreq_subcall(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args, int flags)
492 _HOOK_XREQ_(subcall, xreq, api, verb, args);
495 void afb_hook_xreq_subcall_result(const struct afb_xreq *xreq, struct json_object *object, const char *error, const char *info)
497 _HOOK_XREQ_(subcall_result, xreq, object, error, info);
500 void afb_hook_xreq_subcallsync(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args, int flags)
502 _HOOK_XREQ_(subcallsync, xreq, api, verb, args);
505 int afb_hook_xreq_subcallsync_result(const struct afb_xreq *xreq, int status, struct json_object *object, const char *error, const char *info)
507 _HOOK_XREQ_(subcallsync_result, xreq, status, object, error, info);
511 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)
513 _HOOK_XREQ_(vverbose, xreq, level, file ?: "?", line, func ?: "?", fmt, args);
516 void afb_hook_xreq_legacy_store(const struct afb_xreq *xreq, struct afb_stored_req *sreq)
518 _HOOK_XREQ_(legacy_store, xreq, sreq);
521 void afb_hook_xreq_legacy_unstore(const struct afb_xreq *xreq)
523 _HOOK_XREQ_(legacy_unstore, xreq);
526 int afb_hook_xreq_has_permission(const struct afb_xreq *xreq, const char *permission, int result)
528 _HOOK_XREQ_(has_permission, xreq, permission, result);
532 char *afb_hook_xreq_get_application_id(const struct afb_xreq *xreq, char *result)
534 _HOOK_XREQ_(get_application_id, xreq, result);
538 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)
540 _HOOK_XREQ_(context_make, xreq, replace, create_value, free_value, create_closure, result);
544 int afb_hook_xreq_get_uid(const struct afb_xreq *xreq, int result)
546 _HOOK_XREQ_(get_uid, xreq, result);
550 struct json_object *afb_hook_xreq_get_client_info(const struct afb_xreq *xreq, struct json_object *result)
552 _HOOK_XREQ_(get_client_info, xreq, result);
556 /******************************************************************************
557 * section: hooking xreqs
558 *****************************************************************************/
560 void afb_hook_init_xreq(struct afb_xreq *xreq)
562 static int reqindex = 0;
566 struct afb_hook_xreq *hook;
568 /* scan hook list to get the expected flags */
570 pthread_rwlock_rdlock(&rwlock);
571 hook = list_of_xreq_hooks;
573 f = hook->flags & afb_hook_flags_req_all;
575 && (!hook->session || hook->session == xreq->context.session)
576 && MATCH_API(hook->api, xreq->request.called_api)
577 && MATCH_VERB(hook->verb, xreq->request.called_verb);
582 pthread_rwlock_unlock(&rwlock);
584 /* store the hooking data */
585 xreq->hookflags = flags;
588 x = __atomic_load_n(&reqindex, __ATOMIC_RELAXED);
589 xreq->hookindex = (x + 1) % 1000000 ?: 1;
590 } while (x != __atomic_exchange_n(&reqindex, xreq->hookindex, __ATOMIC_RELAXED));
594 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)
596 struct afb_hook_xreq *hook;
598 /* alloc the result */
599 hook = calloc(1, sizeof *hook);
603 /* get a copy of the names */
604 hook->api = api ? strdup(api) : NULL;
605 hook->verb = verb ? strdup(verb) : NULL;
606 if ((api && !hook->api) || (verb && !hook->verb)) {
613 /* initialise the rest */
614 hook->session = session;
616 afb_session_addref(session);
619 hook->itf = itf ? itf : &hook_xreq_default_itf;
620 hook->closure = closure;
622 /* record the hook */
623 pthread_mutex_lock(&mutex);
624 hook->next = list_of_xreq_hooks;
625 list_of_xreq_hooks = hook;
626 pthread_mutex_unlock(&mutex);
632 struct afb_hook_xreq *afb_hook_addref_xreq(struct afb_hook_xreq *hook)
634 __atomic_add_fetch(&hook->refcount, 1, __ATOMIC_RELAXED);
638 static void hook_clean_xreq()
640 struct afb_hook_xreq **prv, *hook, *head;
642 if (pthread_rwlock_trywrlock(&rwlock) == 0) {
643 /* unlink under mutex */
645 pthread_mutex_lock(&mutex);
646 prv = &list_of_xreq_hooks;
647 while ((hook = *prv)) {
656 pthread_mutex_unlock(&mutex);
657 pthread_rwlock_unlock(&rwlock);
659 /* free found hooks */
660 while((hook = head)) {
665 afb_session_unref(hook->session);
671 void afb_hook_unref_xreq(struct afb_hook_xreq *hook)
673 if (hook && !__atomic_sub_fetch(&hook->refcount, 1, __ATOMIC_RELAXED))
677 /******************************************************************************
678 * section: default callbacks for tracing daemon interface
679 *****************************************************************************/
681 static void _hook_api_(const struct afb_export *export, const char *format, ...)
684 va_start(ap, format);
685 _hook_("api-%s", format, ap, afb_export_apiname(export));
689 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)
691 _hook_api_(export, "event_broadcast.before(%s, %s)....", name, json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE));
694 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)
696 _hook_api_(export, "event_broadcast.after(%s, %s) -> %d", name, json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE), result);
699 static void hook_api_get_event_loop_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_event *result)
701 _hook_api_(export, "get_event_loop() -> %p", result);
704 static void hook_api_get_user_bus_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_bus *result)
706 _hook_api_(export, "get_user_bus() -> %p", result);
709 static void hook_api_get_system_bus_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_bus *result)
711 _hook_api_(export, "get_system_bus() -> %p", result);
714 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)
721 len = vasprintf(&msg, fmt, ap);
725 _hook_api_(export, "vverbose(%d:%s, %s, %d, %s) -> %s ? ? ?", level, verbose_name_of_level(level), file, line, function, fmt);
727 _hook_api_(export, "vverbose(%d:%s, %s, %d, %s) -> %s", level, verbose_name_of_level(level), file, line, function, msg);
732 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)
734 _hook_api_(export, "event_make(%s) -> %s:%d", name, afb_evt_event_x2_fullname(result), afb_evt_event_x2_id(result));
737 static void hook_api_rootdir_get_fd_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result)
739 char path[PATH_MAX], proc[100];
743 _hook_api_(export, "rootdir_get_fd() -> %d, %m", result);
745 snprintf(proc, sizeof proc, "/proc/self/fd/%d", result);
746 s = readlink(proc, path, sizeof path);
747 path[s < 0 ? 0 : s >= sizeof path ? sizeof path - 1 : s] = 0;
748 _hook_api_(export, "rootdir_get_fd() -> %d = %s", result, path);
752 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)
754 char path[PATH_MAX], proc[100];
760 _hook_api_(export, "rootdir_open_locale(%s, %d, %s) -> %d, %m", filename, flags, locale, result);
762 snprintf(proc, sizeof proc, "/proc/self/fd/%d", result);
763 s = readlink(proc, path, sizeof path);
764 path[s < 0 ? 0 : s >= sizeof path ? sizeof path - 1 : s] = 0;
765 _hook_api_(export, "rootdir_open_locale(%s, %d, %s) -> %d = %s", filename, flags, locale, result, path);
769 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)
771 _hook_api_(export, "queue_job(%p, %p, %p, %d) -> %d", callback, argument, group, timeout, result);
774 static void hook_api_unstore_req_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct afb_stored_req *sreq)
776 _hook_api_(export, "unstore_req(%p)", sreq);
779 static void hook_api_require_api_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, int initialized)
781 _hook_api_(export, "require_api(%s, %d)...", name, initialized);
784 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)
786 _hook_api_(export, "...require_api(%s, %d) -> %d", name, initialized, result);
789 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)
791 _hook_api_(export, "add_alias(%s -> %s) -> %d", api, alias?:"<null>", result);
794 static void hook_api_start_before_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export)
796 _hook_api_(export, "start.before");
799 static void hook_api_start_after_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int status)
801 _hook_api_(export, "start.after -> %d", status);
804 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)
806 _hook_api_(export, "on_event.before(%s, %d, %s)", event, event_x2, json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE));
809 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)
811 _hook_api_(export, "on_event.after(%s, %d, %s)", event, event_x2, json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE));
814 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)
816 _hook_api_(export, "call(%s/%s, %s) ...", api, verb, json_object_to_json_string_ext(args, JSON_C_TO_STRING_NOSLASHESCAPE));
819 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)
821 _hook_api_(export, " ...call... [%s] -> %s (%s)", error?:"success", json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE), info?:"");
824 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)
826 _hook_api_(export, "callsync(%s/%s, %s) ...", api, verb, json_object_to_json_string_ext(args, JSON_C_TO_STRING_NOSLASHESCAPE));
829 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)
831 _hook_api_(export, " ...callsync... %d [%s] -> %s (%s)", status, error?:"success", json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE), info?:"");
834 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)
836 _hook_api_(export, "new_api.before %s (%s)%s ...", api, info?:"", noconcurrency?" no-concurrency" : "");
839 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)
841 _hook_api_(export, "... new_api.after %s -> %s (%d)", api, result >= 0 ? "OK" : "ERROR", result);
844 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)
846 _hook_api_(export, "set_verbs_v2 -> %s (%d)", result >= 0 ? "OK" : "ERROR", result);
849 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)
851 _hook_api_(export, "set_verbs_v3 -> %s (%d)", result >= 0 ? "OK" : "ERROR", result);
854 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)
856 _hook_api_(export, "add_verb(%s%s [%s]) -> %s (%d)", verb, glob?" (GLOB)":"", info?:"", result >= 0 ? "OK" : "ERROR", result);
859 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)
861 _hook_api_(export, "del_verb(%s) -> %s (%d)", verb, result >= 0 ? "OK" : "ERROR", result);
864 static void hook_api_api_set_on_event_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result)
866 _hook_api_(export, "set_on_event -> %s (%d)", result >= 0 ? "OK" : "ERROR", result);
869 static void hook_api_api_set_on_init_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result)
871 _hook_api_(export, "set_on_init -> %s (%d)", result >= 0 ? "OK" : "ERROR", result);
874 static void hook_api_api_seal_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export)
876 _hook_api_(export, "seal");
879 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)
881 _hook_api_(export, "event_handler_add(%s) -> %s (%d)", pattern, result >= 0 ? "OK" : "ERROR", result);
884 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)
886 _hook_api_(export, "event_handler_del(%s) -> %s (%d)", pattern, result >= 0 ? "OK" : "ERROR", result);
889 static void hook_api_class_provide_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result, const char *name)
891 _hook_api_(export, "class_provide(%s) -> %s (%d)", name, result >= 0 ? "OK" : "ERROR", result);
894 static void hook_api_class_require_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result, const char *name)
896 _hook_api_(export, "class_require(%s) -> %s (%d)", name, result >= 0 ? "OK" : "ERROR", result);
899 static void hook_api_delete_api_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result)
901 _hook_api_(export, "delete_api -> %s (%d)", result >= 0 ? "OK" : "ERROR", result);
904 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)
906 _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));
909 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)
911 _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));
914 static void hook_api_settings_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct json_object *object)
916 _hook_api_(export, "settings -> %s", json_object_to_json_string_ext(object, JSON_C_TO_STRING_NOSLASHESCAPE));
919 static struct afb_hook_api_itf hook_api_default_itf = {
920 .hook_api_event_broadcast_before = hook_api_event_broadcast_before_cb,
921 .hook_api_event_broadcast_after = hook_api_event_broadcast_after_cb,
922 .hook_api_get_event_loop = hook_api_get_event_loop_cb,
923 .hook_api_get_user_bus = hook_api_get_user_bus_cb,
924 .hook_api_get_system_bus = hook_api_get_system_bus_cb,
925 .hook_api_vverbose = hook_api_vverbose_cb,
926 .hook_api_event_make = hook_api_event_make_cb,
927 .hook_api_rootdir_get_fd = hook_api_rootdir_get_fd_cb,
928 .hook_api_rootdir_open_locale = hook_api_rootdir_open_locale_cb,
929 .hook_api_queue_job = hook_api_queue_job_cb,
930 .hook_api_legacy_unstore_req = hook_api_unstore_req_cb,
931 .hook_api_require_api = hook_api_require_api_cb,
932 .hook_api_require_api_result = hook_api_require_api_result_cb,
933 .hook_api_add_alias = hook_api_add_alias_cb,
934 .hook_api_start_before = hook_api_start_before_cb,
935 .hook_api_start_after = hook_api_start_after_cb,
936 .hook_api_on_event_before = hook_api_on_event_before_cb,
937 .hook_api_on_event_after = hook_api_on_event_after_cb,
938 .hook_api_call = hook_api_call_cb,
939 .hook_api_call_result = hook_api_call_result_cb,
940 .hook_api_callsync = hook_api_callsync_cb,
941 .hook_api_callsync_result = hook_api_callsync_result_cb,
942 .hook_api_new_api_before = hook_api_new_api_before_cb,
943 .hook_api_new_api_after = hook_api_new_api_after_cb,
944 .hook_api_api_set_verbs_v2 = hook_api_api_set_verbs_v2_cb,
945 .hook_api_api_set_verbs_v3 = hook_api_api_set_verbs_v3_cb,
946 .hook_api_api_add_verb = hook_api_api_add_verb_cb,
947 .hook_api_api_del_verb = hook_api_api_del_verb_cb,
948 .hook_api_api_set_on_event = hook_api_api_set_on_event_cb,
949 .hook_api_api_set_on_init = hook_api_api_set_on_init_cb,
950 .hook_api_api_seal = hook_api_api_seal_cb,
951 .hook_api_event_handler_add = hook_api_event_handler_add_cb,
952 .hook_api_event_handler_del = hook_api_event_handler_del_cb,
953 .hook_api_class_provide = hook_api_class_provide_cb,
954 .hook_api_class_require = hook_api_class_require_cb,
955 .hook_api_delete_api = hook_api_delete_api_cb,
956 .hook_api_on_event_handler_before = hook_api_on_event_handler_before_cb,
957 .hook_api_on_event_handler_after = hook_api_on_event_handler_after_cb,
958 .hook_api_settings = hook_api_settings_cb,
961 /******************************************************************************
962 * section: hooks for tracing daemon interface (export)
963 *****************************************************************************/
965 #define _HOOK_API_2_(flag,func,...) \
966 struct afb_hook_api *hook; \
967 struct afb_hookid hookid; \
968 const char *apiname = afb_export_apiname(export); \
969 pthread_rwlock_rdlock(&rwlock); \
970 init_hookid(&hookid); \
971 hook = list_of_api_hooks; \
974 && hook->itf->hook_api_##func \
975 && (hook->flags & afb_hook_flag_api_##flag) != 0 \
976 && MATCH_API(hook->api, apiname)) { \
977 hook->itf->hook_api_##func(hook->closure, &hookid, __VA_ARGS__); \
981 pthread_rwlock_unlock(&rwlock);
983 #define _HOOK_API_(what,...) _HOOK_API_2_(what,what,__VA_ARGS__)
985 void afb_hook_api_event_broadcast_before(const struct afb_export *export, const char *name, struct json_object *object)
987 _HOOK_API_2_(event_broadcast, event_broadcast_before, export, name, object);
990 int afb_hook_api_event_broadcast_after(const struct afb_export *export, const char *name, struct json_object *object, int result)
992 _HOOK_API_2_(event_broadcast, event_broadcast_after, export, name, object, result);
996 struct sd_event *afb_hook_api_get_event_loop(const struct afb_export *export, struct sd_event *result)
998 _HOOK_API_(get_event_loop, export, result);
1002 struct sd_bus *afb_hook_api_get_user_bus(const struct afb_export *export, struct sd_bus *result)
1004 _HOOK_API_(get_user_bus, export, result);
1008 struct sd_bus *afb_hook_api_get_system_bus(const struct afb_export *export, struct sd_bus *result)
1010 _HOOK_API_(get_system_bus, export, result);
1014 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)
1016 _HOOK_API_(vverbose, export, level, file, line, function, fmt, args);
1019 struct afb_event_x2 *afb_hook_api_event_make(const struct afb_export *export, const char *name, struct afb_event_x2 *result)
1021 _HOOK_API_(event_make, export, name, result);
1025 int afb_hook_api_rootdir_get_fd(const struct afb_export *export, int result)
1027 _HOOK_API_(rootdir_get_fd, export, result);
1031 int afb_hook_api_rootdir_open_locale(const struct afb_export *export, const char *filename, int flags, const char *locale, int result)
1033 _HOOK_API_(rootdir_open_locale, export, filename, flags, locale, result);
1037 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)
1039 _HOOK_API_(queue_job, export, callback, argument, group, timeout, result);
1043 void afb_hook_api_legacy_unstore_req(const struct afb_export *export, struct afb_stored_req *sreq)
1045 _HOOK_API_(legacy_unstore_req, export, sreq);
1048 void afb_hook_api_require_api(const struct afb_export *export, const char *name, int initialized)
1050 _HOOK_API_(require_api, export, name, initialized);
1053 int afb_hook_api_require_api_result(const struct afb_export *export, const char *name, int initialized, int result)
1055 _HOOK_API_2_(require_api, require_api_result, export, name, initialized, result);
1059 int afb_hook_api_add_alias(const struct afb_export *export, const char *api, const char *alias, int result)
1061 _HOOK_API_(add_alias, export, api, alias, result);
1065 void afb_hook_api_start_before(const struct afb_export *export)
1067 _HOOK_API_2_(start, start_before, export);
1070 int afb_hook_api_start_after(const struct afb_export *export, int status)
1072 _HOOK_API_2_(start, start_after, export, status);
1076 void afb_hook_api_on_event_before(const struct afb_export *export, const char *event, int event_x2, struct json_object *object)
1078 _HOOK_API_2_(on_event, on_event_before, export, event, event_x2, object);
1081 void afb_hook_api_on_event_after(const struct afb_export *export, const char *event, int event_x2, struct json_object *object)
1083 _HOOK_API_2_(on_event, on_event_after, export, event, event_x2, object);
1086 void afb_hook_api_call(const struct afb_export *export, const char *api, const char *verb, struct json_object *args)
1088 _HOOK_API_(call, export, api, verb, args);
1091 void afb_hook_api_call_result(const struct afb_export *export, struct json_object *object, const char*error, const char *info)
1093 _HOOK_API_2_(call, call_result, export, object, error, info);
1097 void afb_hook_api_callsync(const struct afb_export *export, const char *api, const char *verb, struct json_object *args)
1099 _HOOK_API_(callsync, export, api, verb, args);
1102 int afb_hook_api_callsync_result(const struct afb_export *export, int status, struct json_object *object, const char *error, const char *info)
1104 _HOOK_API_2_(callsync, callsync_result, export, status, object, error, info);
1108 void afb_hook_api_new_api_before(const struct afb_export *export, const char *api, const char *info, int noconcurrency)
1110 _HOOK_API_2_(new_api, new_api_before, export, api, info, noconcurrency);
1113 int afb_hook_api_new_api_after(const struct afb_export *export, int result, const char *api)
1115 _HOOK_API_2_(new_api, new_api_after, export, result, api);
1119 int afb_hook_api_api_set_verbs_v2(const struct afb_export *export, int result, const struct afb_verb_v2 *verbs)
1121 _HOOK_API_2_(api_set_verbs, api_set_verbs_v2, export, result, verbs);
1125 int afb_hook_api_api_set_verbs_v3(const struct afb_export *export, int result, const struct afb_verb_v3 *verbs)
1127 _HOOK_API_2_(api_set_verbs, api_set_verbs_v3, export, result, verbs);
1131 int afb_hook_api_api_add_verb(const struct afb_export *export, int result, const char *verb, const char *info, int glob)
1133 _HOOK_API_(api_add_verb, export, result, verb, info, glob);
1137 int afb_hook_api_api_del_verb(const struct afb_export *export, int result, const char *verb)
1139 _HOOK_API_(api_del_verb, export, result, verb);
1143 int afb_hook_api_api_set_on_event(const struct afb_export *export, int result)
1145 _HOOK_API_(api_set_on_event, export, result);
1149 int afb_hook_api_api_set_on_init(const struct afb_export *export, int result)
1151 _HOOK_API_(api_set_on_init, export, result);
1155 void afb_hook_api_api_seal(const struct afb_export *export)
1157 _HOOK_API_(api_seal, export);
1160 int afb_hook_api_event_handler_add(const struct afb_export *export, int result, const char *pattern)
1162 _HOOK_API_(event_handler_add, export, result, pattern);
1165 int afb_hook_api_event_handler_del(const struct afb_export *export, int result, const char *pattern)
1167 _HOOK_API_(event_handler_del, export, result, pattern);
1170 int afb_hook_api_class_provide(const struct afb_export *export, int result, const char *name)
1172 _HOOK_API_(class_provide, export, result, name);
1175 int afb_hook_api_class_require(const struct afb_export *export, int result, const char *name)
1177 _HOOK_API_(class_require, export, result, name);
1181 int afb_hook_api_delete_api(const struct afb_export *export, int result)
1183 _HOOK_API_(delete_api, export, result);
1187 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)
1189 _HOOK_API_2_(on_event_handler, on_event_handler_before, export, event, event_x2, object, pattern);
1192 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)
1194 _HOOK_API_2_(on_event_handler, on_event_handler_after, export, event, event_x2, object, pattern);
1197 struct json_object *afb_hook_api_settings(const struct afb_export *export, struct json_object *object)
1199 _HOOK_API_(settings, export, object);
1203 /******************************************************************************
1204 * section: hooking export
1205 *****************************************************************************/
1207 int afb_hook_flags_api(const char *api)
1210 struct afb_hook_api *hook;
1213 pthread_rwlock_rdlock(&rwlock);
1214 hook = list_of_api_hooks;
1216 if (!api || MATCH_API(hook->api, api))
1217 flags |= hook->flags;
1220 pthread_rwlock_unlock(&rwlock);
1224 struct afb_hook_api *afb_hook_create_api(const char *api, int flags, struct afb_hook_api_itf *itf, void *closure)
1226 struct afb_hook_api *hook;
1228 /* alloc the result */
1229 hook = calloc(1, sizeof *hook);
1233 /* get a copy of the names */
1234 hook->api = api ? strdup(api) : NULL;
1235 if (api && !hook->api) {
1240 /* initialise the rest */
1242 hook->flags = flags;
1243 hook->itf = itf ? itf : &hook_api_default_itf;
1244 hook->closure = closure;
1246 /* record the hook */
1247 pthread_mutex_lock(&mutex);
1248 hook->next = list_of_api_hooks;
1249 list_of_api_hooks = hook;
1250 pthread_mutex_unlock(&mutex);
1256 struct afb_hook_api *afb_hook_addref_api(struct afb_hook_api *hook)
1258 __atomic_add_fetch(&hook->refcount, 1, __ATOMIC_RELAXED);
1262 static void hook_clean_api()
1264 struct afb_hook_api **prv, *hook, *head;
1266 if (pthread_rwlock_trywrlock(&rwlock) == 0) {
1267 /* unlink under mutex */
1269 pthread_mutex_lock(&mutex);
1270 prv = &list_of_api_hooks;
1271 while ((hook = *prv)) {
1273 prv = &(*prv)->next;
1280 pthread_mutex_unlock(&mutex);
1281 pthread_rwlock_unlock(&rwlock);
1283 /* free found hooks */
1284 while((hook = head)) {
1292 void afb_hook_unref_api(struct afb_hook_api *hook)
1294 if (hook && !__atomic_sub_fetch(&hook->refcount, 1, __ATOMIC_RELAXED))
1298 /******************************************************************************
1299 * section: default callbacks for tracing service interface (evt)
1300 *****************************************************************************/
1302 static void _hook_evt_(const char *evt, int id, const char *format, ...)
1305 va_start(ap, format);
1306 _hook_("evt-%s:%d", format, ap, evt, id);
1310 static void hook_evt_create_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
1312 _hook_evt_(evt, id, "create");
1315 static void hook_evt_push_before_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj)
1317 _hook_evt_(evt, id, "push.before(%s)", json_object_to_json_string_ext(obj, JSON_C_TO_STRING_NOSLASHESCAPE));
1321 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)
1323 _hook_evt_(evt, id, "push.after(%s) -> %d", json_object_to_json_string_ext(obj, JSON_C_TO_STRING_NOSLASHESCAPE), result);
1326 static void hook_evt_broadcast_before_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj)
1328 _hook_evt_(evt, id, "broadcast.before(%s)", json_object_to_json_string_ext(obj, JSON_C_TO_STRING_NOSLASHESCAPE));
1331 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)
1333 _hook_evt_(evt, id, "broadcast.after(%s) -> %d", json_object_to_json_string_ext(obj, JSON_C_TO_STRING_NOSLASHESCAPE), result);
1336 static void hook_evt_name_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, const char *result)
1338 _hook_evt_(evt, id, "name -> %s", result);
1341 static void hook_evt_addref_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
1343 _hook_evt_(evt, id, "addref");
1346 static void hook_evt_unref_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
1348 _hook_evt_(evt, id, "unref");
1351 static struct afb_hook_evt_itf hook_evt_default_itf = {
1352 .hook_evt_create = hook_evt_create_cb,
1353 .hook_evt_push_before = hook_evt_push_before_cb,
1354 .hook_evt_push_after = hook_evt_push_after_cb,
1355 .hook_evt_broadcast_before = hook_evt_broadcast_before_cb,
1356 .hook_evt_broadcast_after = hook_evt_broadcast_after_cb,
1357 .hook_evt_name = hook_evt_name_cb,
1358 .hook_evt_addref = hook_evt_addref_cb,
1359 .hook_evt_unref = hook_evt_unref_cb
1362 /******************************************************************************
1363 * section: hooks for tracing events interface (evt)
1364 *****************************************************************************/
1366 #define _HOOK_EVT_(what,...) \
1367 struct afb_hook_evt *hook; \
1368 struct afb_hookid hookid; \
1369 pthread_rwlock_rdlock(&rwlock); \
1370 init_hookid(&hookid); \
1371 hook = list_of_evt_hooks; \
1373 if (hook->refcount \
1374 && hook->itf->hook_evt_##what \
1375 && (hook->flags & afb_hook_flag_evt_##what) != 0 \
1376 && MATCH_EVENT(hook->pattern, evt)) { \
1377 hook->itf->hook_evt_##what(hook->closure, &hookid, __VA_ARGS__); \
1379 hook = hook->next; \
1381 pthread_rwlock_unlock(&rwlock);
1383 void afb_hook_evt_create(const char *evt, int id)
1385 _HOOK_EVT_(create, evt, id);
1388 void afb_hook_evt_push_before(const char *evt, int id, struct json_object *obj)
1390 _HOOK_EVT_(push_before, evt, id, obj);
1393 int afb_hook_evt_push_after(const char *evt, int id, struct json_object *obj, int result)
1395 _HOOK_EVT_(push_after, evt, id, obj, result);
1399 void afb_hook_evt_broadcast_before(const char *evt, int id, struct json_object *obj)
1401 _HOOK_EVT_(broadcast_before, evt, id, obj);
1404 int afb_hook_evt_broadcast_after(const char *evt, int id, struct json_object *obj, int result)
1406 _HOOK_EVT_(broadcast_after, evt, id, obj, result);
1410 void afb_hook_evt_name(const char *evt, int id, const char *result)
1412 _HOOK_EVT_(name, evt, id, result);
1415 void afb_hook_evt_addref(const char *evt, int id)
1417 _HOOK_EVT_(addref, evt, id);
1420 void afb_hook_evt_unref(const char *evt, int id)
1422 _HOOK_EVT_(unref, evt, id);
1425 /******************************************************************************
1426 * section: hooking services (evt)
1427 *****************************************************************************/
1429 int afb_hook_flags_evt(const char *name)
1432 struct afb_hook_evt *hook;
1435 pthread_rwlock_rdlock(&rwlock);
1436 hook = list_of_evt_hooks;
1438 if (!name || MATCH_EVENT(hook->pattern, name))
1439 flags |= hook->flags;
1442 pthread_rwlock_unlock(&rwlock);
1446 struct afb_hook_evt *afb_hook_create_evt(const char *pattern, int flags, struct afb_hook_evt_itf *itf, void *closure)
1448 struct afb_hook_evt *hook;
1450 /* alloc the result */
1451 hook = calloc(1, sizeof *hook);
1455 /* get a copy of the names */
1456 hook->pattern = pattern ? strdup(pattern) : NULL;
1457 if (pattern && !hook->pattern) {
1462 /* initialise the rest */
1464 hook->flags = flags;
1465 hook->itf = itf ? itf : &hook_evt_default_itf;
1466 hook->closure = closure;
1468 /* record the hook */
1469 pthread_mutex_lock(&mutex);
1470 hook->next = list_of_evt_hooks;
1471 list_of_evt_hooks = hook;
1472 pthread_mutex_unlock(&mutex);
1478 struct afb_hook_evt *afb_hook_addref_evt(struct afb_hook_evt *hook)
1480 __atomic_add_fetch(&hook->refcount, 1, __ATOMIC_RELAXED);
1484 static void hook_clean_evt()
1486 struct afb_hook_evt **prv, *hook, *head;
1488 if (pthread_rwlock_trywrlock(&rwlock) == 0) {
1489 /* unlink under mutex */
1491 pthread_mutex_lock(&mutex);
1492 prv = &list_of_evt_hooks;
1493 while ((hook = *prv)) {
1495 prv = &(*prv)->next;
1502 pthread_mutex_unlock(&mutex);
1503 pthread_rwlock_unlock(&rwlock);
1505 /* free found hooks */
1506 while((hook = head)) {
1508 free(hook->pattern);
1514 void afb_hook_unref_evt(struct afb_hook_evt *hook)
1516 if (hook && !__atomic_sub_fetch(&hook->refcount, 1, __ATOMIC_RELAXED))
1520 /******************************************************************************
1521 * section: default callbacks for sessions (session)
1522 *****************************************************************************/
1524 static void _hook_session_(struct afb_session *session, const char *format, ...)
1527 va_start(ap, format);
1528 _hook_("session-%s", format, ap, afb_session_uuid(session));
1532 static void hook_session_create_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
1534 _hook_session_(session, "create -> token=%s", afb_session_token(session));
1537 static void hook_session_close_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
1539 _hook_session_(session, "close");
1542 static void hook_session_destroy_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
1544 _hook_session_(session, "destroy");
1547 static void hook_session_renew_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
1549 _hook_session_(session, "renew -> token=%s", afb_session_token(session));
1552 static void hook_session_addref_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
1554 _hook_session_(session, "addref");
1557 static void hook_session_unref_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
1559 _hook_session_(session, "unref");
1562 static struct afb_hook_session_itf hook_session_default_itf = {
1563 .hook_session_create = hook_session_create_cb,
1564 .hook_session_close = hook_session_close_cb,
1565 .hook_session_destroy = hook_session_destroy_cb,
1566 .hook_session_renew = hook_session_renew_cb,
1567 .hook_session_addref = hook_session_addref_cb,
1568 .hook_session_unref = hook_session_unref_cb
1571 /******************************************************************************
1572 * section: hooks for tracing sessions (session)
1573 *****************************************************************************/
1575 #define _HOOK_SESSION_(what,...) \
1576 struct afb_hook_session *hook; \
1577 struct afb_hookid hookid; \
1578 const char *sessid = 0; \
1579 pthread_rwlock_rdlock(&rwlock); \
1580 init_hookid(&hookid); \
1581 hook = list_of_session_hooks; \
1583 if (hook->refcount \
1584 && hook->itf->hook_session_##what \
1585 && (hook->flags & afb_hook_flag_session_##what) != 0 \
1586 && MATCH_SESSION(hook->pattern, (sessid?:(sessid=afb_session_uuid(session))))) { \
1587 hook->itf->hook_session_##what(hook->closure, &hookid, __VA_ARGS__); \
1589 hook = hook->next; \
1591 pthread_rwlock_unlock(&rwlock);
1593 void afb_hook_session_create(struct afb_session *session)
1595 _HOOK_SESSION_(create, session);
1598 void afb_hook_session_close(struct afb_session *session)
1600 _HOOK_SESSION_(close, session);
1603 void afb_hook_session_destroy(struct afb_session *session)
1605 _HOOK_SESSION_(destroy, session);
1608 void afb_hook_session_renew(struct afb_session *session)
1610 _HOOK_SESSION_(renew, session);
1613 void afb_hook_session_addref(struct afb_session *session)
1615 _HOOK_SESSION_(addref, session);
1618 void afb_hook_session_unref(struct afb_session *session)
1620 _HOOK_SESSION_(unref, session);
1624 /******************************************************************************
1625 * section: hooking sessions (session)
1626 *****************************************************************************/
1628 struct afb_hook_session *afb_hook_create_session(const char *pattern, int flags, struct afb_hook_session_itf *itf, void *closure)
1630 struct afb_hook_session *hook;
1632 /* alloc the result */
1633 hook = calloc(1, sizeof *hook);
1637 /* get a copy of the names */
1638 hook->pattern = pattern ? strdup(pattern) : NULL;
1639 if (pattern && !hook->pattern) {
1644 /* initialise the rest */
1646 hook->flags = flags;
1647 hook->itf = itf ? itf : &hook_session_default_itf;
1648 hook->closure = closure;
1650 /* record the hook */
1651 pthread_mutex_lock(&mutex);
1652 hook->next = list_of_session_hooks;
1653 list_of_session_hooks = hook;
1654 pthread_mutex_unlock(&mutex);
1660 struct afb_hook_session *afb_hook_addref_session(struct afb_hook_session *hook)
1662 __atomic_add_fetch(&hook->refcount, 1, __ATOMIC_RELAXED);
1666 static void hook_clean_session()
1668 struct afb_hook_session **prv, *hook, *head;
1670 if (pthread_rwlock_trywrlock(&rwlock) == 0) {
1671 /* unlink under mutex */
1673 pthread_mutex_lock(&mutex);
1674 prv = &list_of_session_hooks;
1675 while ((hook = *prv)) {
1677 prv = &(*prv)->next;
1684 pthread_mutex_unlock(&mutex);
1685 pthread_rwlock_unlock(&rwlock);
1687 /* free found hooks */
1688 while((hook = head)) {
1690 free(hook->pattern);
1696 void afb_hook_unref_session(struct afb_hook_session *hook)
1698 if (hook && !__atomic_sub_fetch(&hook->refcount, 1, __ATOMIC_RELAXED))
1699 hook_clean_session();
1702 /******************************************************************************
1703 * section: default callbacks for globals (global)
1704 *****************************************************************************/
1706 static void _hook_global_(const char *format, ...)
1709 va_start(ap, format);
1710 _hook_("global", format, ap);
1714 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)
1721 len = vasprintf(&msg, fmt, ap);
1725 _hook_global_("vverbose(%d:%s, %s, %d, %s) -> %s ? ? ?", level, verbose_name_of_level(level), file, line, func, fmt);
1727 _hook_global_("vverbose(%d:%s, %s, %d, %s) -> %s", level, verbose_name_of_level(level), file, line, func, msg);
1732 static struct afb_hook_global_itf hook_global_default_itf = {
1733 .hook_global_vverbose = hook_global_vverbose_cb
1736 /******************************************************************************
1737 * section: hooks for tracing globals (global)
1738 *****************************************************************************/
1740 #define _HOOK_GLOBAL_(what,...) \
1741 struct afb_hook_global *hook; \
1742 struct afb_hookid hookid; \
1743 pthread_rwlock_rdlock(&rwlock); \
1744 init_hookid(&hookid); \
1745 hook = list_of_global_hooks; \
1747 if (hook->refcount \
1748 && hook->itf->hook_global_##what \
1749 && (hook->flags & afb_hook_flag_global_##what) != 0) { \
1750 hook->itf->hook_global_##what(hook->closure, &hookid, __VA_ARGS__); \
1752 hook = hook->next; \
1754 pthread_rwlock_unlock(&rwlock);
1756 static void afb_hook_global_vverbose(int level, const char *file, int line, const char *func, const char *fmt, va_list args)
1758 _HOOK_GLOBAL_(vverbose, level, file ?: "?", line, func ?: "?", fmt ?: "", args);
1761 /******************************************************************************
1762 * section: hooking globals (global)
1763 *****************************************************************************/
1765 static void update_global()
1767 struct afb_hook_global *hook;
1770 pthread_rwlock_rdlock(&rwlock);
1771 hook = list_of_global_hooks;
1774 flags = hook->flags;
1777 verbose_observer = (flags & afb_hook_flag_global_vverbose) ? afb_hook_global_vverbose : NULL;
1778 pthread_rwlock_unlock(&rwlock);
1781 struct afb_hook_global *afb_hook_create_global(int flags, struct afb_hook_global_itf *itf, void *closure)
1783 struct afb_hook_global *hook;
1785 /* alloc the result */
1786 hook = calloc(1, sizeof *hook);
1790 /* initialise the rest */
1792 hook->flags = flags;
1793 hook->itf = itf ? itf : &hook_global_default_itf;
1794 hook->closure = closure;
1796 /* record the hook */
1797 pthread_mutex_lock(&mutex);
1798 hook->next = list_of_global_hooks;
1799 list_of_global_hooks = hook;
1800 pthread_mutex_unlock(&mutex);
1802 /* update hooking */
1809 struct afb_hook_global *afb_hook_addref_global(struct afb_hook_global *hook)
1811 __atomic_add_fetch(&hook->refcount, 1, __ATOMIC_RELAXED);
1815 static void hook_clean_global()
1817 struct afb_hook_global **prv, *hook, *head;
1819 if (pthread_rwlock_trywrlock(&rwlock) == 0) {
1820 /* unlink under mutex */
1822 pthread_mutex_lock(&mutex);
1823 prv = &list_of_global_hooks;
1824 while ((hook = *prv)) {
1826 prv = &(*prv)->next;
1833 pthread_mutex_unlock(&mutex);
1834 pthread_rwlock_unlock(&rwlock);
1836 /* free found hooks */
1837 while((hook = head)) {
1844 void afb_hook_unref_global(struct afb_hook_global *hook)
1846 if (hook && !__atomic_sub_fetch(&hook->refcount, 1, __ATOMIC_RELAXED)) {
1847 /* update hooking */
1849 hook_clean_global();
1853 #endif /* WITH_AFB_HOOK *******************************************************/