2 * Copyright (C) 2016, 2017 "IoT.bzh"
3 * Author José Bollo <jose.bollo@iot.bzh>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
29 #include <json-c/json.h>
30 #define AFB_BINDING_VERSION 0
31 #include <afb/afb-binding.h>
35 #include "afb-session.h"
37 #include "afb-export.h"
39 #include "afb-trace.h"
41 #include "wrap-json.h"
44 /*******************************************************************************/
45 /***** default names *****/
46 /*******************************************************************************/
48 #if !defined(DEFAULT_EVENT_NAME)
49 # define DEFAULT_EVENT_NAME "trace"
51 #if !defined(DEFAULT_TAG_NAME)
52 # define DEFAULT_TAG_NAME "trace"
55 /*******************************************************************************/
57 /*******************************************************************************/
59 /* structure for searching flags by names */
62 const char *name; /** the name */
63 int value; /** the value */
68 struct tag *next; /* link to the next */
69 char tag[1]; /* name of the tag */
72 /* struct for events */
74 struct event *next; /* link to the next event */
75 struct afb_evtid *evtid; /* the event */
78 /* struct for sessions */
80 struct afb_session *session; /* the session */
81 struct afb_trace *trace; /* the tracer */
84 /* struct for recording hooks */
86 struct hook *next; /* link to next hook */
87 void *handler; /* the handler of the hook */
88 struct event *event; /* the associated event */
89 struct tag *tag; /* the associated tag */
90 struct afb_session *session; /* the associated session */
96 Trace_Type_Xreq, /* xreq hooks */
97 Trace_Type_Ditf, /* export hooks */
98 Trace_Type_Svc, /* export hooks */
99 Trace_Type_Evt, /* evt hooks */
100 Trace_Type_Global, /* global hooks */
101 Trace_Type_Count /* count of types of hooks */
107 int refcount; /* reference count */
108 pthread_mutex_t mutex; /* concurrency management */
109 struct afb_daemon *daemon; /* daemon */
110 struct afb_session *bound; /* bound to session */
111 struct event *events; /* list of events */
112 struct tag *tags; /* list of tags */
113 struct hook *hooks[Trace_Type_Count]; /* hooks */
116 /*******************************************************************************/
117 /***** utility functions *****/
118 /*******************************************************************************/
120 static void ctxt_error(char **errors, const char *format, ...)
128 va_start(ap, format);
129 len = vsnprintf(buffer, sizeof buffer, format, ap);
131 if (len > (int)(sizeof buffer - 2))
132 len = (int)(sizeof buffer - 2);
133 buffer[len++] = '\n';
137 sz = errs ? strlen(errs) : 0;
138 errs = realloc(errs, sz + (size_t)len);
140 memcpy(errs + sz, buffer, len);
145 /* get the value of the flag of 'name' in the array 'flags' of 'count elements */
146 static int get_flag(const char *name, struct flag flags[], int count)
148 /* dichotomic search */
149 int lower = 0, upper = count;
150 while (lower < upper) {
151 int mid = (lower + upper) >> 1;
152 int cmp = strcmp(name, flags[mid].name);
154 return flags[mid].value;
164 static struct json_object *timestamp(const struct afb_hookid *hookid)
168 snprintf(ts, sizeof ts, "%llu.%06lu", (long long unsigned)hookid->time.tv_sec, (long unsigned)(hookid->time.tv_nsec / 1000));
169 return json_object_new_string(ts);
172 /* verbosity level name or NULL */
173 static const char *verbosity_level_name(int level)
175 static const char *names[] = {
183 return level >= Log_Level_Error && level <= Log_Level_Debug ? names[level - Log_Level_Error] : NULL;
187 static void emit(void *closure, const struct afb_hookid *hookid, const char *type, const char *fmt1, const char *fmt2, va_list ap2, ...)
189 struct hook *hook = closure;
190 struct json_object *data, *data1, *data2;
193 data1 = data2 = data = NULL;
195 wrap_json_vpack(&data1, fmt1, ap1);
198 wrap_json_vpack(&data2, fmt2, ap2);
200 wrap_json_pack(&data, "{so ss ss si so so*}",
201 "time", timestamp(hookid),
202 "tag", hook->tag->tag,
204 "id", (int)(hookid->id & INT_MAX),
208 afb_evt_evtid_push(hook->event->evtid, data);
211 /*******************************************************************************/
212 /***** trace the requests *****/
213 /*******************************************************************************/
215 static struct flag xreq_flags[] = { /* must be sorted by names */
216 { "addref", afb_hook_flag_req_addref },
217 { "all", afb_hook_flags_req_all },
218 { "args", afb_hook_flags_req_args },
219 { "begin", afb_hook_flag_req_begin },
220 { "common", afb_hook_flags_req_common },
221 { "context", afb_hook_flags_req_context },
222 { "context_get", afb_hook_flag_req_context_get },
223 { "context_make", afb_hook_flag_req_context_make },
224 { "context_set", afb_hook_flag_req_context_set },
225 { "end", afb_hook_flag_req_end },
226 { "event", afb_hook_flags_req_event },
227 { "extra", afb_hook_flags_req_extra },
228 { "fail", afb_hook_flag_req_fail },
229 { "get", afb_hook_flag_req_get },
230 { "get_application_id", afb_hook_flag_req_get_application_id },
231 { "get_uid", afb_hook_flag_req_get_uid },
232 { "has_permission", afb_hook_flag_req_has_permission },
233 { "json", afb_hook_flag_req_json },
234 { "life", afb_hook_flags_req_life },
235 { "ref", afb_hook_flags_req_ref },
236 { "result", afb_hook_flags_req_result },
237 { "security", afb_hook_flags_req_security },
238 { "session", afb_hook_flags_req_session },
239 { "session_close", afb_hook_flag_req_session_close },
240 { "session_set_LOA", afb_hook_flag_req_session_set_LOA },
241 { "store", afb_hook_flag_req_store },
242 { "stores", afb_hook_flags_req_stores },
243 { "subcall", afb_hook_flag_req_subcall },
244 { "subcall_req", afb_hook_flag_req_subcall_req },
245 { "subcall_req_result", afb_hook_flag_req_subcall_req_result },
246 { "subcall_result", afb_hook_flag_req_subcall_result },
247 { "subcalls", afb_hook_flags_req_subcalls },
248 { "subcallsync", afb_hook_flag_req_subcallsync },
249 { "subcallsync_result", afb_hook_flag_req_subcallsync_result },
250 { "subscribe", afb_hook_flag_req_subscribe },
251 { "success", afb_hook_flag_req_success },
252 { "unref", afb_hook_flag_req_unref },
253 { "unstore", afb_hook_flag_req_unstore },
254 { "unsubscribe", afb_hook_flag_req_unsubscribe },
255 { "vverbose", afb_hook_flag_req_vverbose },
258 /* get the xreq value for flag of 'name' */
259 static int get_xreq_flag(const char *name)
261 return get_flag(name, xreq_flags, (int)(sizeof xreq_flags / sizeof *xreq_flags));
264 static void hook_xreq(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *action, const char *format, ...)
266 struct json_object *cred = NULL;
267 const char *session = NULL;
270 if (xreq->context.session)
271 session = afb_session_uuid(xreq->context.session);
274 wrap_json_pack(&cred, "{si ss si si ss* ss*}",
275 "uid", (int)xreq->cred->uid,
276 "user", xreq->cred->user,
277 "gid", (int)xreq->cred->gid,
278 "pid", (int)xreq->cred->pid,
279 "label", xreq->cred->label,
282 va_start(ap, format);
283 emit(closure, hookid, "request", "{si ss ss ss so* ss*}", format, ap,
284 "index", xreq->hookindex,
285 "api", xreq->request.api,
286 "verb", xreq->request.verb,
293 static void hook_xreq_begin(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
295 hook_xreq(closure, hookid, xreq, "begin", NULL);
298 static void hook_xreq_end(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
300 hook_xreq(closure, hookid, xreq, "end", NULL);
303 static void hook_xreq_json(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct json_object *obj)
305 hook_xreq(closure, hookid, xreq, "json", "{sO?}",
309 static void hook_xreq_get(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *name, struct afb_arg arg)
311 hook_xreq(closure, hookid, xreq, "get", "{ss? ss? ss? ss?}",
318 static void hook_xreq_success(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct json_object *obj, const char *info)
320 hook_xreq(closure, hookid, xreq, "success", "{sO? ss?}",
325 static void hook_xreq_fail(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *status, const char *info)
327 hook_xreq(closure, hookid, xreq, "fail", "{ss? ss?}",
332 static void hook_xreq_context_get(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, void *value)
334 hook_xreq(closure, hookid, xreq, "context_get", NULL);
337 static void hook_xreq_context_set(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, void *value, void (*free_value)(void*))
339 hook_xreq(closure, hookid, xreq, "context_set", NULL);
342 static void hook_xreq_addref(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
344 hook_xreq(closure, hookid, xreq, "addref", NULL);
347 static void hook_xreq_unref(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
349 hook_xreq(closure, hookid, xreq, "unref", NULL);
352 static void hook_xreq_session_close(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
354 hook_xreq(closure, hookid, xreq, "session_close", NULL);
357 static void hook_xreq_session_set_LOA(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, unsigned level, int result)
359 hook_xreq(closure, hookid, xreq, "session_set_LOA", "{si si}",
364 static void hook_xreq_subscribe(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_eventid *eventid, int result)
366 hook_xreq(closure, hookid, xreq, "subscribe", "{s{ss si} si}",
368 "name", afb_evt_eventid_fullname(eventid),
369 "id", afb_evt_eventid_id(eventid),
373 static void hook_xreq_unsubscribe(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_eventid *eventid, int result)
375 hook_xreq(closure, hookid, xreq, "unsubscribe", "{s{ss? si} si}",
377 "name", afb_evt_eventid_fullname(eventid),
378 "id", afb_evt_eventid_id(eventid),
382 static void hook_xreq_subcall(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args)
384 hook_xreq(closure, hookid, xreq, "subcall", "{ss? ss? sO?}",
390 static void hook_xreq_subcall_result(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int status, struct json_object *result)
392 hook_xreq(closure, hookid, xreq, "subcall_result", "{si sO?}",
397 static void hook_xreq_subcallsync(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args)
399 hook_xreq(closure, hookid, xreq, "subcallsync", "{ss? ss? sO?}",
405 static void hook_xreq_subcallsync_result(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int status, struct json_object *result)
407 hook_xreq(closure, hookid, xreq, "subcallsync_result", "{si sO?}",
412 static void hook_xreq_vverbose(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int level, const char *file, int line, const char *func, const char *fmt, va_list args)
414 struct json_object *pos;
423 len = vasprintf(&msg, fmt, ap);
427 wrap_json_pack(&pos, "{ss si ss*}", "file", file, "line", line, "function", func);
429 hook_xreq(closure, hookid, xreq, "vverbose", "{si ss* ss? so*}",
431 "type", verbosity_level_name(level),
432 len < 0 ? "format" : "message", len < 0 ? fmt : msg,
438 static void hook_xreq_store(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_stored_req *sreq)
440 hook_xreq(closure, hookid, xreq, "store", NULL);
443 static void hook_xreq_unstore(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq)
445 hook_xreq(closure, hookid, xreq, "unstore", NULL);
448 static void hook_xreq_subcall_req(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args)
450 hook_xreq(closure, hookid, xreq, "subcall_req", "{ss? ss? sO?}",
456 static void hook_xreq_subcall_req_result(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int status, struct json_object *result)
458 hook_xreq(closure, hookid, xreq, "subcall_req_result", "{si sO?}",
463 static void hook_xreq_has_permission(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *permission, int result)
465 hook_xreq(closure, hookid, xreq, "has_permission", "{ss sb}",
466 "permission", permission,
470 static void hook_xreq_get_application_id(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, char *result)
472 hook_xreq(closure, hookid, xreq, "get_application_id", "{ss?}",
476 static void hook_xreq_context_make(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)
478 char pc[50], pf[50], pv[50], pr[50];
479 snprintf(pc, sizeof pc, "%p", create_value);
480 snprintf(pf, sizeof pf, "%p", free_value);
481 snprintf(pv, sizeof pv, "%p", create_closure);
482 snprintf(pr, sizeof pr, "%p", result);
483 hook_xreq(closure, hookid, xreq, "context_make", "{sb ss ss ss ss}",
491 static void hook_xreq_get_uid(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int result)
493 hook_xreq(closure, hookid, xreq, "get_uid", "{si}",
497 static struct afb_hook_xreq_itf hook_xreq_itf = {
498 .hook_xreq_begin = hook_xreq_begin,
499 .hook_xreq_end = hook_xreq_end,
500 .hook_xreq_json = hook_xreq_json,
501 .hook_xreq_get = hook_xreq_get,
502 .hook_xreq_success = hook_xreq_success,
503 .hook_xreq_fail = hook_xreq_fail,
504 .hook_xreq_context_get = hook_xreq_context_get,
505 .hook_xreq_context_set = hook_xreq_context_set,
506 .hook_xreq_addref = hook_xreq_addref,
507 .hook_xreq_unref = hook_xreq_unref,
508 .hook_xreq_session_close = hook_xreq_session_close,
509 .hook_xreq_session_set_LOA = hook_xreq_session_set_LOA,
510 .hook_xreq_subscribe = hook_xreq_subscribe,
511 .hook_xreq_unsubscribe = hook_xreq_unsubscribe,
512 .hook_xreq_subcall = hook_xreq_subcall,
513 .hook_xreq_subcall_result = hook_xreq_subcall_result,
514 .hook_xreq_subcallsync = hook_xreq_subcallsync,
515 .hook_xreq_subcallsync_result = hook_xreq_subcallsync_result,
516 .hook_xreq_vverbose = hook_xreq_vverbose,
517 .hook_xreq_store = hook_xreq_store,
518 .hook_xreq_unstore = hook_xreq_unstore,
519 .hook_xreq_subcall_req = hook_xreq_subcall_req,
520 .hook_xreq_subcall_req_result = hook_xreq_subcall_req_result,
521 .hook_xreq_has_permission = hook_xreq_has_permission,
522 .hook_xreq_get_application_id = hook_xreq_get_application_id,
523 .hook_xreq_context_make = hook_xreq_context_make,
524 .hook_xreq_get_uid = hook_xreq_get_uid,
527 /*******************************************************************************/
528 /***** trace the daemon interface *****/
529 /*******************************************************************************/
531 static struct flag ditf_flags[] = { /* must be sorted by names */
532 { "all", afb_hook_flags_ditf_all },
533 { "common", afb_hook_flags_ditf_common },
534 { "event_broadcast_after", afb_hook_flag_ditf_event_broadcast_after },
535 { "event_broadcast_before", afb_hook_flag_ditf_event_broadcast_before },
536 { "event_make", afb_hook_flag_ditf_event_make },
537 { "extra", afb_hook_flags_ditf_extra },
538 { "get_event_loop", afb_hook_flag_ditf_get_event_loop },
539 { "get_system_bus", afb_hook_flag_ditf_get_system_bus },
540 { "get_user_bus", afb_hook_flag_ditf_get_user_bus },
541 { "queue_job", afb_hook_flag_ditf_queue_job },
542 { "require_api", afb_hook_flag_ditf_require_api },
543 { "require_api_result", afb_hook_flag_ditf_require_api_result },
544 { "rootdir_get_fd", afb_hook_flag_ditf_rootdir_get_fd },
545 { "rootdir_open_locale", afb_hook_flag_ditf_rootdir_open_locale },
546 { "unstore_req", afb_hook_flag_ditf_unstore_req },
547 { "vverbose", afb_hook_flag_ditf_vverbose },
550 /* get the export value for flag of 'name' */
551 static int get_ditf_flag(const char *name)
553 return get_flag(name, ditf_flags, (int)(sizeof ditf_flags / sizeof *ditf_flags));
557 static void hook_ditf(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *action, const char *format, ...)
561 va_start(ap, format);
562 emit(closure, hookid, "daemon", "{ss ss}", format, ap,
563 "api", afb_export_apiname(export),
568 static void hook_ditf_event_broadcast_before(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct json_object *object)
570 hook_ditf(closure, hookid, export, "event_broadcast_before", "{ss sO*}",
571 "name", name, "data", object);
574 static void hook_ditf_event_broadcast_after(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct json_object *object, int result)
576 hook_ditf(closure, hookid, export, "event_broadcast_after", "{ss sO* si}",
577 "name", name, "data", object, "result", result);
580 static void hook_ditf_get_event_loop(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_event *result)
582 hook_ditf(closure, hookid, export, "get_event_loop", NULL);
585 static void hook_ditf_get_user_bus(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_bus *result)
587 hook_ditf(closure, hookid, export, "get_user_bus", NULL);
590 static void hook_ditf_get_system_bus(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_bus *result)
592 hook_ditf(closure, hookid, export, "get_system_bus", NULL);
595 static void hook_ditf_vverbose(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)
597 struct json_object *pos;
606 len = vasprintf(&msg, fmt, ap);
610 wrap_json_pack(&pos, "{ss si ss*}", "file", file, "line", line, "function", function);
612 hook_ditf(closure, hookid, export, "vverbose", "{si ss* ss? so*}",
614 "type", verbosity_level_name(level),
615 len < 0 ? "format" : "message", len < 0 ? fmt : msg,
621 static void hook_ditf_event_make(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct afb_eventid *result)
623 hook_ditf(closure, hookid, export, "event_make", "{ss ss si}",
624 "name", name, "event", afb_evt_eventid_fullname(result), "id", afb_evt_eventid_id(result));
627 static void hook_ditf_rootdir_get_fd(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result)
632 sprintf(path, "/proc/self/fd/%d", result);
633 readlink(path, path, sizeof path);
636 hook_ditf(closure, hookid, export, "rootdir_get_fd", "{ss}",
637 result < 0 ? "path" : "error",
638 result < 0 ? strerror(errno) : path);
641 static void hook_ditf_rootdir_open_locale(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *filename, int flags, const char *locale, int result)
646 sprintf(path, "/proc/self/fd/%d", result);
647 readlink(path, path, sizeof path);
650 hook_ditf(closure, hookid, export, "rootdir_open_locale", "{ss si ss* ss}",
654 result < 0 ? "path" : "error",
655 result < 0 ? strerror(errno) : path);
658 static void hook_ditf_queue_job(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)
660 hook_ditf(closure, hookid, export, "queue_job", "{ss}", "result", result);
663 static void hook_ditf_unstore_req(void * closure, const struct afb_hookid *hookid, const struct afb_export *export, struct afb_stored_req *sreq)
665 hook_ditf(closure, hookid, export, "unstore_req", NULL);
668 static void hook_ditf_require_api(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, int initialized)
670 hook_ditf(closure, hookid, export, "require_api", "{ss sb}", "name", name, "initialized", initialized);
673 static void hook_ditf_require_api_result(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, int initialized, int result)
675 hook_ditf(closure, hookid, export, "require_api_result", "{ss sb si}", "name", name, "initialized", initialized, "result", result);
678 static struct afb_hook_ditf_itf hook_ditf_itf = {
679 .hook_ditf_event_broadcast_before = hook_ditf_event_broadcast_before,
680 .hook_ditf_event_broadcast_after = hook_ditf_event_broadcast_after,
681 .hook_ditf_get_event_loop = hook_ditf_get_event_loop,
682 .hook_ditf_get_user_bus = hook_ditf_get_user_bus,
683 .hook_ditf_get_system_bus = hook_ditf_get_system_bus,
684 .hook_ditf_vverbose = hook_ditf_vverbose,
685 .hook_ditf_event_make = hook_ditf_event_make,
686 .hook_ditf_rootdir_get_fd = hook_ditf_rootdir_get_fd,
687 .hook_ditf_rootdir_open_locale = hook_ditf_rootdir_open_locale,
688 .hook_ditf_queue_job = hook_ditf_queue_job,
689 .hook_ditf_unstore_req = hook_ditf_unstore_req,
690 .hook_ditf_require_api = hook_ditf_require_api,
691 .hook_ditf_require_api_result = hook_ditf_require_api_result
694 /*******************************************************************************/
695 /***** trace the services *****/
696 /*******************************************************************************/
698 static struct flag svc_flags[] = { /* must be sorted by names */
699 { "all", afb_hook_flags_svc_all },
700 { "call", afb_hook_flag_svc_call },
701 { "call_result", afb_hook_flag_svc_call_result },
702 { "callsync", afb_hook_flag_svc_callsync },
703 { "callsync_result", afb_hook_flag_svc_callsync_result },
704 { "on_event_after", afb_hook_flag_svc_on_event_after },
705 { "on_event_before", afb_hook_flag_svc_on_event_before },
706 { "start_after", afb_hook_flag_svc_start_after },
707 { "start_before", afb_hook_flag_svc_start_before },
710 /* get the export value for flag of 'name' */
711 static int get_svc_flag(const char *name)
713 return get_flag(name, svc_flags, (int)(sizeof svc_flags / sizeof *svc_flags));
716 static void hook_svc(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *action, const char *format, ...)
720 va_start(ap, format);
721 emit(closure, hookid, "service", "{ss ss}", format, ap,
722 "api", afb_export_apiname(export),
727 static void hook_svc_start_before(void *closure, const struct afb_hookid *hookid, const struct afb_export *export)
729 hook_svc(closure, hookid, export, "start_before", NULL);
732 static void hook_svc_start_after(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int status)
734 hook_svc(closure, hookid, export, "start_after", "{si}", "result", status);
737 static void hook_svc_on_event_before(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *event, int evtid, struct json_object *object)
739 hook_svc(closure, hookid, export, "on_event_before", "{ss si sO*}",
740 "event", event, "id", evtid, "data", object);
743 static void hook_svc_on_event_after(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *event, int evtid, struct json_object *object)
745 hook_svc(closure, hookid, export, "on_event_after", "{ss si sO*}",
746 "event", event, "id", evtid, "data", object);
749 static void hook_svc_call(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *api, const char *verb, struct json_object *args)
751 hook_svc(closure, hookid, export, "call", "{ss ss sO*}",
752 "api", api, "verb", verb, "args", args);
755 static void hook_svc_call_result(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int status, struct json_object *result)
757 hook_svc(closure, hookid, export, "call_result", "{si sO*}",
758 "status", status, "result", result);
761 static void hook_svc_callsync(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *api, const char *verb, struct json_object *args)
763 hook_svc(closure, hookid, export, "callsync", "{ss ss sO*}",
764 "api", api, "verb", verb, "args", args);
767 static void hook_svc_callsync_result(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int status, struct json_object *result)
769 hook_svc(closure, hookid, export, "callsync_result", "{si sO*}",
770 "status", status, "result", result);
773 static struct afb_hook_svc_itf hook_svc_itf = {
774 .hook_svc_start_before = hook_svc_start_before,
775 .hook_svc_start_after = hook_svc_start_after,
776 .hook_svc_on_event_before = hook_svc_on_event_before,
777 .hook_svc_on_event_after = hook_svc_on_event_after,
778 .hook_svc_call = hook_svc_call,
779 .hook_svc_call_result = hook_svc_call_result,
780 .hook_svc_callsync = hook_svc_callsync,
781 .hook_svc_callsync_result = hook_svc_callsync_result
784 /*******************************************************************************/
785 /***** trace the events *****/
786 /*******************************************************************************/
788 static struct flag evt_flags[] = { /* must be sorted by names */
789 { "addref", afb_hook_flag_evt_addref },
790 { "all", afb_hook_flags_evt_all },
791 { "broadcast_after", afb_hook_flag_evt_broadcast_after },
792 { "broadcast_before", afb_hook_flag_evt_broadcast_before },
793 { "common", afb_hook_flags_evt_common },
794 { "create", afb_hook_flag_evt_create },
795 { "extra", afb_hook_flags_evt_extra },
796 { "name", afb_hook_flag_evt_name },
797 { "push_after", afb_hook_flag_evt_push_after },
798 { "push_before", afb_hook_flag_evt_push_before },
799 { "unref", afb_hook_flag_evt_unref },
802 /* get the evt value for flag of 'name' */
803 static int get_evt_flag(const char *name)
805 return get_flag(name, evt_flags, (int)(sizeof evt_flags / sizeof *evt_flags));
808 static void hook_evt(void *closure, const struct afb_hookid *hookid, const char *evt, int id, const char *action, const char *format, ...)
812 va_start(ap, format);
813 emit(closure, hookid, "event", "{si ss ss}", format, ap,
820 static void hook_evt_create(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
822 hook_evt(closure, hookid, evt, id, "create", NULL);
825 static void hook_evt_push_before(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj)
827 hook_evt(closure, hookid, evt, id, "push_before", "{sO*}", "data", obj);
831 static void hook_evt_push_after(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj, int result)
833 hook_evt(closure, hookid, evt, id, "push_after", "{sO* si}", "data", obj, "result", result);
836 static void hook_evt_broadcast_before(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj)
838 hook_evt(closure, hookid, evt, id, "broadcast_before", "{sO*}", "data", obj);
841 static void hook_evt_broadcast_after(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj, int result)
843 hook_evt(closure, hookid, evt, id, "broadcast_after", "{sO* si}", "data", obj, "result", result);
846 static void hook_evt_name(void *closure, const struct afb_hookid *hookid, const char *evt, int id, const char *result)
848 hook_evt(closure, hookid, evt, id, "name", "{ss}", "result", result);
851 static void hook_evt_addref(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
853 hook_evt(closure, hookid, evt, id, "addref", NULL);
856 static void hook_evt_unref(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
858 hook_evt(closure, hookid, evt, id, "unref", NULL);
861 static struct afb_hook_evt_itf hook_evt_itf = {
862 .hook_evt_create = hook_evt_create,
863 .hook_evt_push_before = hook_evt_push_before,
864 .hook_evt_push_after = hook_evt_push_after,
865 .hook_evt_broadcast_before = hook_evt_broadcast_before,
866 .hook_evt_broadcast_after = hook_evt_broadcast_after,
867 .hook_evt_name = hook_evt_name,
868 .hook_evt_addref = hook_evt_addref,
869 .hook_evt_unref = hook_evt_unref
872 /*******************************************************************************/
873 /***** trace the globals *****/
874 /*******************************************************************************/
876 static struct flag global_flags[] = { /* must be sorted by names */
877 { "all", afb_hook_flags_global_all },
878 { "vverbose", afb_hook_flag_global_vverbose },
881 /* get the global value for flag of 'name' */
882 static int get_global_flag(const char *name)
884 return get_flag(name, global_flags, (int)(sizeof global_flags / sizeof *global_flags));
887 static void hook_global(void *closure, const struct afb_hookid *hookid, const char *action, const char *format, ...)
891 va_start(ap, format);
892 emit(closure, hookid, "global", "{ss}", format, ap, "action", action);
896 static void hook_global_vverbose(void *closure, const struct afb_hookid *hookid, int level, const char *file, int line, const char *function, const char *fmt, va_list args)
898 struct json_object *pos;
907 len = vasprintf(&msg, fmt, ap);
911 wrap_json_pack(&pos, "{ss si ss*}", "file", file, "line", line, "function", function);
913 hook_global(closure, hookid, "vverbose", "{si ss* ss? so*}",
915 "type", verbosity_level_name(level),
916 len < 0 ? "format" : "message", len < 0 ? fmt : msg,
922 static struct afb_hook_global_itf hook_global_itf = {
923 .hook_global_vverbose = hook_global_vverbose,
926 /*******************************************************************************/
927 /***** abstract types *****/
928 /*******************************************************************************/
934 void (*unref)(void*);
935 int (*get_flag)(const char*);
937 abstracting[Trace_Type_Count] =
942 .unref = (void(*)(void*))afb_hook_unref_xreq,
943 .get_flag = get_xreq_flag
948 .unref = (void(*)(void*))afb_hook_unref_ditf,
949 .get_flag = get_ditf_flag
954 .unref = (void(*)(void*))afb_hook_unref_svc,
955 .get_flag = get_svc_flag
960 .unref = (void(*)(void*))afb_hook_unref_evt,
961 .get_flag = get_evt_flag
963 [Trace_Type_Global] =
966 .unref = (void(*)(void*))afb_hook_unref_global,
967 .get_flag = get_global_flag
971 /*******************************************************************************/
972 /***** handle trace data *****/
973 /*******************************************************************************/
975 /* drop hooks of 'trace' matching 'tag' and 'event' and 'session' */
976 static void trace_unhook(struct afb_trace *trace, struct tag *tag, struct event *event, struct afb_session *session)
979 struct hook *hook, **prev;
981 /* remove any event */
982 for (i = 0 ; i < Trace_Type_Count ; i++) {
983 prev = &trace->hooks[i];
984 while ((hook = *prev)) {
985 if ((tag && tag != hook->tag)
986 || (event && event != hook->event)
987 || (session && session != hook->session))
991 abstracting[i].unref(hook->handler);
998 /* cleanup: removes unused tags, events and sessions of the 'trace' */
999 static void trace_cleanup(struct afb_trace *trace)
1003 struct tag *tag, **ptag;
1004 struct event *event, **pevent;
1007 ptag = &trace->tags;
1008 while ((tag = *ptag)) {
1009 /* search for tag */
1010 for (hook = NULL, i = 0 ; !hook && i < Trace_Type_Count ; i++)
1011 for (hook = trace->hooks[i] ; hook && hook->tag != tag ; hook = hook->next);
1012 /* keep or free whether used or not */
1021 pevent = &trace->events;
1022 while ((event = *pevent)) {
1023 /* search for event */
1024 for (hook = NULL, i = 0 ; !hook && i < Trace_Type_Count ; i++)
1025 for (hook = trace->hooks[i] ; hook && hook->event != event ; hook = hook->next);
1026 /* keep or free whether used or not */
1028 pevent = &event->next;
1030 *pevent = event->next;
1031 afb_evt_evtid_unref(event->evtid);
1038 * Get the tag of 'name' within 'trace'.
1039 * If 'alloc' isn't zero, create the tag and add it.
1041 static struct tag *trace_get_tag(struct afb_trace *trace, const char *name, int alloc)
1045 /* search the tag of 'name' */
1047 while (tag && strcmp(name, tag->tag))
1050 if (!tag && alloc) {
1051 /* creation if needed */
1052 tag = malloc(sizeof * tag + strlen(name));
1054 strcpy(tag->tag, name);
1055 tag->next = trace->tags;
1063 * Get the event of 'name' within 'trace'.
1064 * If 'alloc' isn't zero, create the event and add it.
1066 static struct event *trace_get_event(struct afb_trace *trace, const char *name, int alloc)
1069 struct event *event;
1071 /* search the event */
1072 event = trace->events;
1073 while (event && strcmp(afb_evt_evtid_name(event->evtid), name))
1074 event = event->next;
1076 if (!event && alloc) {
1077 event = malloc(sizeof * event);
1079 e = afb_daemon_make_event_v1(*trace->daemon, name);
1080 event->evtid = afb_evt_eventid_to_evtid(afb_event_to_eventid(e));
1082 event->next = trace->events;
1083 trace->events = event;
1094 * called on session closing
1096 static void session_closed(void *item)
1098 struct cookie *cookie = item;
1100 pthread_mutex_lock(&cookie->trace->mutex);
1101 trace_unhook(cookie->trace, NULL, NULL, cookie->session);
1102 pthread_mutex_unlock(&cookie->trace->mutex);
1107 * records the cookie of session for tracking close
1109 static void *session_open(void *closure)
1111 struct cookie *param = closure, *cookie;
1112 cookie = malloc(sizeof *cookie);
1119 * Get the session of 'uuid' within 'trace'.
1120 * If 'alloc' isn't zero, create the session and add it.
1122 static struct afb_session *trace_get_session_by_uuid(struct afb_trace *trace, const char *uuid, int alloc)
1124 struct cookie cookie;
1127 cookie.session = afb_session_search(uuid);
1129 cookie.session = afb_session_get(uuid, AFB_SESSION_TIMEOUT_DEFAULT, NULL);
1130 if (cookie.session) {
1131 cookie.trace = trace;
1132 afb_session_cookie(cookie.session, cookie.trace, session_open, session_closed, &cookie, 0);
1135 return cookie.session;
1138 static struct hook *trace_make_detached_hook(struct afb_trace *trace, const char *event, const char *tag)
1142 tag = tag ?: DEFAULT_TAG_NAME;
1143 event = event ?: DEFAULT_EVENT_NAME;
1144 hook = malloc(sizeof *hook);
1146 hook->tag = trace_get_tag(trace, tag, 1);
1147 hook->event = trace_get_event(trace, event, 1);
1148 hook->session = NULL;
1149 hook->handler = NULL;
1154 static void trace_attach_hook(struct afb_trace *trace, struct hook *hook, enum trace_type type)
1156 hook->next = trace->hooks[type];
1157 trace->hooks[type] = hook;
1160 /*******************************************************************************/
1161 /***** handle client requests *****/
1162 /*******************************************************************************/
1166 struct afb_trace *trace;
1173 struct context *context;
1176 const char *session;
1179 const char *pattern;
1180 int flags[Trace_Type_Count];
1184 static void addhook(struct desc *desc, enum trace_type type)
1187 struct afb_session *session;
1188 struct afb_session *bind;
1189 struct afb_trace *trace = desc->context->trace;
1191 /* check permission for bound traces */
1192 bind = trace->bound;
1194 if (type != Trace_Type_Xreq) {
1195 ctxt_error(&desc->context->errors, "tracing %s is forbidden", abstracting[type].name);
1198 if (desc->session) {
1199 ctxt_error(&desc->context->errors, "setting session is forbidden");
1204 /* allocate the hook */
1205 hook = trace_make_detached_hook(trace, desc->name, desc->tag);
1207 ctxt_error(&desc->context->errors, "allocation of hook failed");
1211 /* create the hook handler */
1213 case Trace_Type_Xreq:
1215 session = afb_session_addref(bind);
1217 session = trace_get_session_by_uuid(trace, desc->session, 1);
1219 ctxt_error(&desc->context->errors, "allocation of session failed");
1224 hook->handler = afb_hook_create_xreq(desc->api, desc->verb, session,
1225 desc->flags[type], &hook_xreq_itf, hook);
1226 afb_session_unref(session);
1228 case Trace_Type_Ditf:
1229 hook->handler = afb_hook_create_ditf(desc->api, desc->flags[type], &hook_ditf_itf, hook);
1231 case Trace_Type_Svc:
1232 hook->handler = afb_hook_create_svc(desc->api, desc->flags[type], &hook_svc_itf, hook);
1234 case Trace_Type_Evt:
1235 hook->handler = afb_hook_create_evt(desc->pattern, desc->flags[type], &hook_evt_itf, hook);
1237 case Trace_Type_Global:
1238 hook->handler = afb_hook_create_global(desc->flags[type], &hook_global_itf, hook);
1243 if (!hook->handler) {
1244 ctxt_error(&desc->context->errors, "creation of hook failed");
1249 /* attach and activate the hook */
1250 afb_req_subscribe(desc->context->req, afb_evt_event_from_evtid(hook->event->evtid));
1251 trace_attach_hook(trace, hook, type);
1254 static void addhooks(struct desc *desc)
1258 for (i = 0 ; i < Trace_Type_Count ; i++) {
1264 static void add_flags(void *closure, struct json_object *object, enum trace_type type)
1267 const char *name, *queried;
1268 struct desc *desc = closure;
1270 if (wrap_json_unpack(object, "s", &name))
1271 ctxt_error(&desc->context->errors, "unexpected %s value %s",
1272 abstracting[type].name,
1273 json_object_to_json_string(object));
1275 queried = (name[0] == '*' && !name[1]) ? "all" : name;
1276 value = abstracting[type].get_flag(queried);
1278 desc->flags[type] |= value;
1280 ctxt_error(&desc->context->errors, "unknown %s name %s",
1281 abstracting[type].name, name);
1285 static void add_xreq_flags(void *closure, struct json_object *object)
1287 add_flags(closure, object, Trace_Type_Xreq);
1290 static void add_ditf_flags(void *closure, struct json_object *object)
1292 add_flags(closure, object, Trace_Type_Ditf);
1295 static void add_svc_flags(void *closure, struct json_object *object)
1297 add_flags(closure, object, Trace_Type_Svc);
1300 static void add_evt_flags(void *closure, struct json_object *object)
1302 add_flags(closure, object, Trace_Type_Evt);
1305 static void add_global_flags(void *closure, struct json_object *object)
1307 add_flags(closure, object, Trace_Type_Global);
1311 static void add(void *closure, struct json_object *object)
1315 struct json_object *request, *event, *daemon, *service, *sub, *global;
1317 memcpy (&desc, closure, sizeof desc);
1318 request = event = daemon = service = sub = global = NULL;
1320 rc = wrap_json_unpack(object, "{s?s s?s s?s s?s s?s s?s s?o s?o s?o s?o s?o s?o}",
1325 "session", &desc.session,
1326 "pattern", &desc.pattern,
1327 "request", &request,
1329 "service", &service,
1336 if (desc.api && desc.api[0] == '*' && !desc.api[1])
1339 if (desc.verb && desc.verb[0] == '*' && !desc.verb[1])
1342 if (desc.session && desc.session[0] == '*' && !desc.session[1])
1343 desc.session = NULL;
1345 /* get what is expected */
1347 wrap_json_optarray_for_all(request, add_xreq_flags, &desc);
1350 wrap_json_optarray_for_all(daemon, add_ditf_flags, &desc);
1353 wrap_json_optarray_for_all(service, add_svc_flags, &desc);
1356 wrap_json_optarray_for_all(event, add_evt_flags, &desc);
1359 wrap_json_optarray_for_all(global, add_global_flags, &desc);
1363 wrap_json_optarray_for_all(sub, add, &desc);
1368 wrap_json_optarray_for_all(object, add_xreq_flags, &desc);
1373 /* drop hooks of given tag */
1374 static void drop_tag(void *closure, struct json_object *object)
1377 struct context *context = closure;
1381 rc = wrap_json_unpack(object, "s", &name);
1383 ctxt_error(&context->errors, "unexpected tag value %s", json_object_to_json_string(object));
1385 tag = trace_get_tag(context->trace, name, 0);
1387 ctxt_error(&context->errors, "tag %s not found", name);
1389 trace_unhook(context->trace, tag, NULL, NULL);
1393 /* drop hooks of given event */
1394 static void drop_event(void *closure, struct json_object *object)
1397 struct context *context = closure;
1398 struct event *event;
1401 rc = wrap_json_unpack(object, "s", &name);
1403 ctxt_error(&context->errors, "unexpected event value %s", json_object_to_json_string(object));
1405 event = trace_get_event(context->trace, name, 0);
1407 ctxt_error(&context->errors, "event %s not found", name);
1409 trace_unhook(context->trace, NULL, event, NULL);
1413 /* drop hooks of given session */
1414 static void drop_session(void *closure, struct json_object *object)
1417 struct context *context = closure;
1418 struct afb_session *session;
1421 rc = wrap_json_unpack(object, "s", &uuid);
1423 ctxt_error(&context->errors, "unexpected session value %s", json_object_to_json_string(object));
1425 session = trace_get_session_by_uuid(context->trace, uuid, 0);
1427 ctxt_error(&context->errors, "session %s not found", uuid);
1429 trace_unhook(context->trace, NULL, NULL, session);
1430 afb_session_unref(session);
1435 /*******************************************************************************/
1436 /***** public interface *****/
1437 /*******************************************************************************/
1439 /* allocates an afb_trace instance */
1440 struct afb_trace *afb_trace_create(struct afb_daemon *daemon, struct afb_session *bound)
1442 struct afb_trace *trace;
1446 trace = calloc(1, sizeof *trace);
1448 trace->refcount = 1;
1449 trace->bound = bound;
1450 trace->daemon = daemon;
1451 pthread_mutex_init(&trace->mutex, NULL);
1456 /* add a reference to the trace */
1457 void afb_trace_addref(struct afb_trace *trace)
1459 __atomic_add_fetch(&trace->refcount, 1, __ATOMIC_RELAXED);
1462 /* drop one reference to the trace */
1463 void afb_trace_unref(struct afb_trace *trace)
1465 if (trace && !__atomic_sub_fetch(&trace->refcount, 1, __ATOMIC_RELAXED)) {
1467 trace_unhook(trace, NULL, NULL, NULL);
1468 trace_cleanup(trace);
1469 pthread_mutex_destroy(&trace->mutex);
1475 int afb_trace_add(struct afb_req req, struct json_object *args, struct afb_trace *trace)
1477 struct context context;
1480 memset(&context, 0, sizeof context);
1481 context.trace = trace;
1484 memset(&desc, 0, sizeof desc);
1485 desc.context = &context;
1487 pthread_mutex_lock(&trace->mutex);
1488 wrap_json_optarray_for_all(args, add, &desc);
1489 pthread_mutex_unlock(&trace->mutex);
1491 if (!context.errors)
1494 afb_req_fail(req, "error-detected", context.errors);
1495 free(context.errors);
1500 extern int afb_trace_drop(struct afb_req req, struct json_object *args, struct afb_trace *trace)
1503 struct context context;
1504 struct json_object *tags, *events, *sessions;
1506 memset(&context, 0, sizeof context);
1507 context.trace = trace;
1510 /* special: boolean value */
1511 if (!wrap_json_unpack(args, "b", &rc)) {
1513 pthread_mutex_lock(&trace->mutex);
1514 trace_unhook(trace, NULL, NULL, NULL);
1515 trace_cleanup(trace);
1516 pthread_mutex_unlock(&trace->mutex);
1521 tags = events = sessions = NULL;
1522 rc = wrap_json_unpack(args, "{s?o s?o s?o}",
1525 "session", &sessions);
1527 if (rc < 0 || !(events || tags || sessions)) {
1528 afb_req_fail(req, "error-detected", "bad drop arguments");
1532 pthread_mutex_lock(&trace->mutex);
1535 wrap_json_optarray_for_all(tags, drop_tag, &context);
1538 wrap_json_optarray_for_all(events, drop_event, &context);
1541 wrap_json_optarray_for_all(sessions, drop_session, &context);
1543 trace_cleanup(trace);
1545 pthread_mutex_unlock(&trace->mutex);
1547 if (!context.errors)
1550 afb_req_fail(req, "error-detected", context.errors);
1551 free(context.errors);