2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include <sys/types.h>
27 #include <urcu/compiler.h>
29 #include <common/common.h>
32 #include "ust-consumer.h"
37 * Delete ust context safely. RCU read lock must be held before calling
41 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
44 ustctl_release_object(sock
, ua_ctx
->obj
);
51 * Delete ust app event safely. RCU read lock must be held before calling
55 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
58 struct lttng_ht_iter iter
;
59 struct ust_app_ctx
*ua_ctx
;
61 /* Destroy each context of event */
62 cds_lfht_for_each_entry(ua_event
->ctx
->ht
, &iter
.iter
, ua_ctx
,
64 ret
= lttng_ht_del(ua_event
->ctx
, &iter
);
66 delete_ust_app_ctx(sock
, ua_ctx
);
68 lttng_ht_destroy(ua_event
->ctx
);
70 if (ua_event
->obj
!= NULL
) {
71 ustctl_release_object(sock
, ua_event
->obj
);
78 * Delete ust app stream safely. RCU read lock must be held before calling
82 void delete_ust_app_stream(int sock
, struct ltt_ust_stream
*stream
)
85 ustctl_release_object(sock
, stream
->obj
);
86 lttng_fd_put(LTTNG_FD_APPS
, 2);
93 * Delete ust app channel safely. RCU read lock must be held before calling
97 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
)
100 struct lttng_ht_iter iter
;
101 struct ust_app_event
*ua_event
;
102 struct ust_app_ctx
*ua_ctx
;
103 struct ltt_ust_stream
*stream
, *stmp
;
106 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
107 cds_list_del(&stream
->list
);
108 delete_ust_app_stream(sock
, stream
);
112 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
113 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
115 delete_ust_app_ctx(sock
, ua_ctx
);
117 lttng_ht_destroy(ua_chan
->ctx
);
120 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
122 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
124 delete_ust_app_event(sock
, ua_event
);
126 lttng_ht_destroy(ua_chan
->events
);
128 if (ua_chan
->obj
!= NULL
) {
129 ustctl_release_object(sock
, ua_chan
->obj
);
130 lttng_fd_put(LTTNG_FD_APPS
, 2);
137 * Delete ust app session safely. RCU read lock must be held before calling
141 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
)
144 struct lttng_ht_iter iter
;
145 struct ust_app_channel
*ua_chan
;
147 if (ua_sess
->metadata
) {
148 if (ua_sess
->metadata
->stream_obj
) {
149 ustctl_release_object(sock
, ua_sess
->metadata
->stream_obj
);
150 lttng_fd_put(LTTNG_FD_APPS
, 2);
151 free(ua_sess
->metadata
->stream_obj
);
153 if (ua_sess
->metadata
->obj
) {
154 ustctl_release_object(sock
, ua_sess
->metadata
->obj
);
155 lttng_fd_put(LTTNG_FD_APPS
, 2);
156 free(ua_sess
->metadata
->obj
);
158 trace_ust_destroy_metadata(ua_sess
->metadata
);
161 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
163 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
165 delete_ust_app_channel(sock
, ua_chan
);
167 lttng_ht_destroy(ua_sess
->channels
);
169 if (ua_sess
->handle
!= -1) {
170 ustctl_release_handle(sock
, ua_sess
->handle
);
176 * Delete a traceable application structure from the global list. Never call
177 * this function outside of a call_rcu call.
180 void delete_ust_app(struct ust_app
*app
)
183 struct lttng_ht_iter iter
;
184 struct ust_app_session
*ua_sess
;
188 /* Delete ust app sessions info */
193 cds_lfht_for_each_entry(app
->sessions
->ht
, &iter
.iter
, ua_sess
,
195 ret
= lttng_ht_del(app
->sessions
, &iter
);
197 delete_ust_app_session(app
->sock
, ua_sess
);
199 lttng_ht_destroy(app
->sessions
);
202 * Wait until we have deleted the application from the sock hash table
203 * before closing this socket, otherwise an application could re-use the
204 * socket ID and race with the teardown, using the same hash table entry.
206 * It's OK to leave the close in call_rcu. We want it to stay unique for
207 * all RCU readers that could run concurrently with unregister app,
208 * therefore we _need_ to only close that socket after a grace period. So
209 * it should stay in this RCU callback.
211 * This close() is a very important step of the synchronization model so
212 * every modification to this function must be carefully reviewed.
218 lttng_fd_put(LTTNG_FD_APPS
, 1);
220 DBG2("UST app pid %d deleted", app
->pid
);
227 * URCU intermediate call to delete an UST app.
230 void delete_ust_app_rcu(struct rcu_head
*head
)
232 struct lttng_ht_node_ulong
*node
=
233 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
234 struct ust_app
*app
=
235 caa_container_of(node
, struct ust_app
, pid_n
);
237 DBG3("Call RCU deleting app PID %d", app
->pid
);
242 * Alloc new UST app session.
245 struct ust_app_session
*alloc_ust_app_session(void)
247 struct ust_app_session
*ua_sess
;
249 /* Init most of the default value by allocating and zeroing */
250 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
251 if (ua_sess
== NULL
) {
256 ua_sess
->handle
= -1;
257 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
266 * Alloc new UST app channel.
269 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
270 struct lttng_ust_channel
*attr
)
272 struct ust_app_channel
*ua_chan
;
274 /* Init most of the default value by allocating and zeroing */
275 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
276 if (ua_chan
== NULL
) {
281 /* Setup channel name */
282 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
283 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
285 ua_chan
->enabled
= 1;
286 ua_chan
->handle
= -1;
287 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
288 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
289 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
291 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
293 /* Copy attributes */
295 memcpy(&ua_chan
->attr
, attr
, sizeof(ua_chan
->attr
));
298 DBG3("UST app channel %s allocated", ua_chan
->name
);
307 * Alloc new UST app event.
310 struct ust_app_event
*alloc_ust_app_event(char *name
,
311 struct lttng_ust_event
*attr
)
313 struct ust_app_event
*ua_event
;
315 /* Init most of the default value by allocating and zeroing */
316 ua_event
= zmalloc(sizeof(struct ust_app_event
));
317 if (ua_event
== NULL
) {
322 ua_event
->enabled
= 1;
323 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
324 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
325 ua_event
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
326 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
328 /* Copy attributes */
330 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
333 DBG3("UST app event %s allocated", ua_event
->name
);
342 * Alloc new UST app context.
345 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
347 struct ust_app_ctx
*ua_ctx
;
349 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
350 if (ua_ctx
== NULL
) {
355 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
358 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
365 * Find an ust_app using the sock and return it. RCU read side lock must be
366 * held before calling this helper function.
369 struct ust_app
*find_app_by_sock(int sock
)
371 struct lttng_ht_node_ulong
*node
;
372 struct lttng_ht_iter iter
;
374 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
375 node
= lttng_ht_iter_get_node_ulong(&iter
);
377 DBG2("UST app find by sock %d not found", sock
);
381 return caa_container_of(node
, struct ust_app
, sock_n
);
388 * Create the channel context on the tracer.
391 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
392 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
396 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
397 ua_chan
->obj
, &ua_ctx
->obj
);
402 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
404 DBG2("UST app context created successfully for channel %s", ua_chan
->name
);
411 * Create the event context on the tracer.
414 int create_ust_event_context(struct ust_app_event
*ua_event
,
415 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
419 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
420 ua_event
->obj
, &ua_ctx
->obj
);
425 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
427 DBG2("UST app context created successfully for event %s", ua_event
->name
);
434 * Disable the specified event on to UST tracer for the UST session.
436 static int disable_ust_event(struct ust_app
*app
,
437 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
441 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
443 ERR("UST app event %s disable failed for app (pid: %d) "
444 "and session handle %d with ret %d",
445 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
449 DBG2("UST app event %s disabled successfully for app (pid: %d)",
450 ua_event
->attr
.name
, app
->pid
);
457 * Disable the specified channel on to UST tracer for the UST session.
459 static int disable_ust_channel(struct ust_app
*app
,
460 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
464 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
466 ERR("UST app channel %s disable failed for app (pid: %d) "
467 "and session handle %d with ret %d",
468 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
472 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
473 ua_chan
->name
, app
->pid
);
480 * Enable the specified channel on to UST tracer for the UST session.
482 static int enable_ust_channel(struct ust_app
*app
,
483 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
487 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
489 ERR("UST app channel %s enable failed for app (pid: %d) "
490 "and session handle %d with ret %d",
491 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
495 ua_chan
->enabled
= 1;
497 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
498 ua_chan
->name
, app
->pid
);
505 * Enable the specified event on to UST tracer for the UST session.
507 static int enable_ust_event(struct ust_app
*app
,
508 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
512 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
514 ERR("UST app event %s enable failed for app (pid: %d) "
515 "and session handle %d with ret %d",
516 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
520 DBG2("UST app event %s enabled successfully for app (pid: %d)",
521 ua_event
->attr
.name
, app
->pid
);
528 * Open metadata onto the UST tracer for a UST session.
530 static int open_ust_metadata(struct ust_app
*app
,
531 struct ust_app_session
*ua_sess
)
534 struct lttng_ust_channel_attr uattr
;
536 uattr
.overwrite
= ua_sess
->metadata
->attr
.overwrite
;
537 uattr
.subbuf_size
= ua_sess
->metadata
->attr
.subbuf_size
;
538 uattr
.num_subbuf
= ua_sess
->metadata
->attr
.num_subbuf
;
539 uattr
.switch_timer_interval
=
540 ua_sess
->metadata
->attr
.switch_timer_interval
;
541 uattr
.read_timer_interval
=
542 ua_sess
->metadata
->attr
.read_timer_interval
;
543 uattr
.output
= ua_sess
->metadata
->attr
.output
;
545 /* We are going to receive 2 fds, we need to reserve them. */
546 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
548 ERR("Exhausted number of available FD upon metadata open");
551 /* UST tracer metadata creation */
552 ret
= ustctl_open_metadata(app
->sock
, ua_sess
->handle
, &uattr
,
553 &ua_sess
->metadata
->obj
);
555 ERR("UST app open metadata failed for app pid:%d with ret %d",
560 ua_sess
->metadata
->handle
= ua_sess
->metadata
->obj
->handle
;
567 * Create stream onto the UST tracer for a UST session.
569 static int create_ust_stream(struct ust_app
*app
,
570 struct ust_app_session
*ua_sess
)
574 /* We are going to receive 2 fds, we need to reserve them. */
575 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
577 ERR("Exhausted number of available FD upon metadata stream create");
580 ret
= ustctl_create_stream(app
->sock
, ua_sess
->metadata
->obj
,
581 &ua_sess
->metadata
->stream_obj
);
583 ERR("UST create metadata stream failed");
592 * Create the specified channel onto the UST tracer for a UST session.
594 static int create_ust_channel(struct ust_app
*app
,
595 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
599 /* TODO: remove cast and use lttng-ust-abi.h */
601 /* We are going to receive 2 fds, we need to reserve them. */
602 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
604 ERR("Exhausted number of available FD upon create channel");
607 ret
= ustctl_create_channel(app
->sock
, ua_sess
->handle
,
608 (struct lttng_ust_channel_attr
*)&ua_chan
->attr
, &ua_chan
->obj
);
610 ERR("Creating channel %s for app (pid: %d, sock: %d) "
611 "and session handle %d with ret %d",
612 ua_chan
->name
, app
->pid
, app
->sock
,
613 ua_sess
->handle
, ret
);
614 lttng_fd_put(LTTNG_FD_APPS
, 2);
618 ua_chan
->handle
= ua_chan
->obj
->handle
;
620 DBG2("UST app channel %s created successfully for pid:%d and sock:%d",
621 ua_chan
->name
, app
->pid
, app
->sock
);
623 /* If channel is not enabled, disable it on the tracer */
624 if (!ua_chan
->enabled
) {
625 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
636 * Create the specified event onto the UST tracer for a UST session.
639 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
640 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
644 /* Create UST event on tracer */
645 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
648 if (ret
== -EEXIST
|| ret
== -EPERM
) {
652 ERR("Error ustctl create event %s for app pid: %d with ret %d",
653 ua_event
->attr
.name
, app
->pid
, ret
);
657 ua_event
->handle
= ua_event
->obj
->handle
;
659 DBG2("UST app event %s created successfully for pid:%d",
660 ua_event
->attr
.name
, app
->pid
);
662 /* If event not enabled, disable it on the tracer */
663 if (ua_event
->enabled
== 0) {
664 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
667 * If we hit an EPERM, something is wrong with our disable call. If
668 * we get an EEXIST, there is a problem on the tracer side since we
673 /* Code flow problem */
676 /* It's OK for our use case. */
691 * Copy data between an UST app event and a LTT event.
693 static void shadow_copy_event(struct ust_app_event
*ua_event
,
694 struct ltt_ust_event
*uevent
)
696 struct lttng_ht_iter iter
;
697 struct ltt_ust_context
*uctx
;
698 struct ust_app_ctx
*ua_ctx
;
700 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
701 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
703 ua_event
->enabled
= uevent
->enabled
;
705 /* Copy event attributes */
706 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
708 cds_lfht_for_each_entry(uevent
->ctx
->ht
, &iter
.iter
, uctx
, node
.node
) {
709 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
710 if (ua_ctx
== NULL
) {
711 /* malloc() failed. We should simply stop */
715 lttng_ht_node_init_ulong(&ua_ctx
->node
,
716 (unsigned long) ua_ctx
->ctx
.ctx
);
717 lttng_ht_add_unique_ulong(ua_event
->ctx
, &ua_ctx
->node
);
722 * Copy data between an UST app channel and a LTT channel.
724 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
725 struct ltt_ust_channel
*uchan
)
727 struct lttng_ht_iter iter
;
728 struct lttng_ht_node_str
*ua_event_node
;
729 struct ltt_ust_event
*uevent
;
730 struct ltt_ust_context
*uctx
;
731 struct ust_app_event
*ua_event
;
732 struct ust_app_ctx
*ua_ctx
;
734 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
736 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
737 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
738 /* Copy event attributes */
739 memcpy(&ua_chan
->attr
, &uchan
->attr
, sizeof(ua_chan
->attr
));
741 ua_chan
->enabled
= uchan
->enabled
;
743 cds_lfht_for_each_entry(uchan
->ctx
->ht
, &iter
.iter
, uctx
, node
.node
) {
744 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
745 if (ua_ctx
== NULL
) {
748 lttng_ht_node_init_ulong(&ua_ctx
->node
,
749 (unsigned long) ua_ctx
->ctx
.ctx
);
750 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
753 /* Copy all events from ltt ust channel to ust app channel */
754 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
755 struct lttng_ht_iter uiter
;
757 lttng_ht_lookup(ua_chan
->events
, (void *) uevent
->attr
.name
, &uiter
);
758 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
759 if (ua_event_node
== NULL
) {
760 DBG2("UST event %s not found on shadow copy channel",
762 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
763 if (ua_event
== NULL
) {
766 shadow_copy_event(ua_event
, uevent
);
767 lttng_ht_add_unique_str(ua_chan
->events
, &ua_event
->node
);
771 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
775 * Copy data between a UST app session and a regular LTT session.
777 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
778 struct ltt_ust_session
*usess
, struct ust_app
*app
)
780 struct lttng_ht_node_str
*ua_chan_node
;
781 struct lttng_ht_iter iter
;
782 struct ltt_ust_channel
*uchan
;
783 struct ust_app_channel
*ua_chan
;
789 /* Get date and time for unique app path */
791 timeinfo
= localtime(&rawtime
);
792 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
794 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
796 ua_sess
->id
= usess
->id
;
797 ua_sess
->uid
= usess
->uid
;
798 ua_sess
->gid
= usess
->gid
;
800 ret
= snprintf(ua_sess
->path
, PATH_MAX
, "%s/%s-%d-%s", usess
->pathname
,
801 app
->name
, app
->pid
, datetime
);
803 PERROR("asprintf UST shadow copy session");
804 /* TODO: We cannot return an error from here.. */
808 /* TODO: support all UST domain */
810 /* Iterate over all channels in global domain. */
811 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
813 struct lttng_ht_iter uiter
;
815 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
816 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
817 if (ua_chan_node
!= NULL
) {
818 /* Session exist. Contiuing. */
822 DBG2("Channel %s not found on shadow session copy, creating it",
824 ua_chan
= alloc_ust_app_channel(uchan
->name
, &uchan
->attr
);
825 if (ua_chan
== NULL
) {
826 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
830 shadow_copy_channel(ua_chan
, uchan
);
831 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
836 * Lookup sesison wrapper.
839 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
840 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
842 /* Get right UST app session from app */
843 lttng_ht_lookup(app
->sessions
, (void *)((unsigned long) usess
->id
), iter
);
847 * Return ust app session from the app session hashtable using the UST session
850 static struct ust_app_session
*lookup_session_by_app(
851 struct ltt_ust_session
*usess
, struct ust_app
*app
)
853 struct lttng_ht_iter iter
;
854 struct lttng_ht_node_ulong
*node
;
856 __lookup_session_by_app(usess
, app
, &iter
);
857 node
= lttng_ht_iter_get_node_ulong(&iter
);
862 return caa_container_of(node
, struct ust_app_session
, node
);
869 * Create a UST session onto the tracer of app and add it the session
872 * Return ust app session or NULL on error.
874 static struct ust_app_session
*create_ust_app_session(
875 struct ltt_ust_session
*usess
, struct ust_app
*app
)
878 struct ust_app_session
*ua_sess
;
880 ua_sess
= lookup_session_by_app(usess
, app
);
881 if (ua_sess
== NULL
) {
882 DBG2("UST app pid: %d session id %d not found, creating it",
883 app
->pid
, usess
->id
);
884 ua_sess
= alloc_ust_app_session();
885 if (ua_sess
== NULL
) {
886 /* Only malloc can failed so something is really wrong */
889 shadow_copy_session(ua_sess
, usess
, app
);
892 if (ua_sess
->handle
== -1) {
893 ret
= ustctl_create_session(app
->sock
);
895 ERR("Creating session for app pid %d", app
->pid
);
896 /* This means that the tracer is gone... */
897 delete_ust_app_session(-1, ua_sess
);
898 ua_sess
= (void*) -1UL;
902 ua_sess
->handle
= ret
;
904 /* Add ust app session to app's HT */
905 lttng_ht_node_init_ulong(&ua_sess
->node
, (unsigned long) ua_sess
->id
);
906 lttng_ht_add_unique_ulong(app
->sessions
, &ua_sess
->node
);
908 DBG2("UST app session created successfully with handle %d", ret
);
916 * Create a context for the channel on the tracer.
919 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
920 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
924 struct lttng_ht_iter iter
;
925 struct lttng_ht_node_ulong
*node
;
926 struct ust_app_ctx
*ua_ctx
;
928 DBG2("UST app adding context to channel %s", ua_chan
->name
);
930 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
931 node
= lttng_ht_iter_get_node_ulong(&iter
);
937 ua_ctx
= alloc_ust_app_ctx(uctx
);
938 if (ua_ctx
== NULL
) {
944 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
945 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
947 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
957 * Create an UST context and enable it for the event on the tracer.
960 int create_ust_app_event_context(struct ust_app_session
*ua_sess
,
961 struct ust_app_event
*ua_event
, struct lttng_ust_context
*uctx
,
965 struct lttng_ht_iter iter
;
966 struct lttng_ht_node_ulong
*node
;
967 struct ust_app_ctx
*ua_ctx
;
969 DBG2("UST app adding context to event %s", ua_event
->name
);
971 lttng_ht_lookup(ua_event
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
972 node
= lttng_ht_iter_get_node_ulong(&iter
);
978 ua_ctx
= alloc_ust_app_ctx(uctx
);
979 if (ua_ctx
== NULL
) {
985 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
986 lttng_ht_add_unique_ulong(ua_event
->ctx
, &ua_ctx
->node
);
988 ret
= create_ust_event_context(ua_event
, ua_ctx
, app
);
998 * Enable on the tracer side a ust app event for the session and channel.
1001 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1002 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1006 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1011 ua_event
->enabled
= 1;
1018 * Disable on the tracer side a ust app event for the session and channel.
1020 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1021 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1025 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1030 ua_event
->enabled
= 0;
1037 * Lookup ust app channel for session and disable it on the tracer side.
1040 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1041 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1045 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1050 ua_chan
->enabled
= 0;
1057 * Lookup ust app channel for session and enable it on the tracer side.
1059 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1060 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1063 struct lttng_ht_iter iter
;
1064 struct lttng_ht_node_str
*ua_chan_node
;
1065 struct ust_app_channel
*ua_chan
;
1067 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1068 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1069 if (ua_chan_node
== NULL
) {
1070 DBG2("Unable to find channel %s in ust session id %u",
1071 uchan
->name
, ua_sess
->id
);
1075 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1077 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1087 * Create UST app channel and create it on the tracer.
1089 static struct ust_app_channel
*create_ust_app_channel(
1090 struct ust_app_session
*ua_sess
, struct ltt_ust_channel
*uchan
,
1091 struct ust_app
*app
)
1094 struct lttng_ht_iter iter
;
1095 struct lttng_ht_node_str
*ua_chan_node
;
1096 struct ust_app_channel
*ua_chan
;
1098 /* Lookup channel in the ust app session */
1099 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1100 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1101 if (ua_chan_node
!= NULL
) {
1102 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1106 ua_chan
= alloc_ust_app_channel(uchan
->name
, &uchan
->attr
);
1107 if (ua_chan
== NULL
) {
1108 /* Only malloc can fail here */
1111 shadow_copy_channel(ua_chan
, uchan
);
1113 ret
= create_ust_channel(app
, ua_sess
, ua_chan
);
1115 /* Not found previously means that it does not exist on the tracer */
1116 assert(ret
!= -EEXIST
);
1120 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1122 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
1129 delete_ust_app_channel(-1, ua_chan
);
1134 * Create UST app event and create it on the tracer side.
1137 int create_ust_app_event(struct ust_app_session
*ua_sess
,
1138 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
1139 struct ust_app
*app
)
1142 struct lttng_ht_iter iter
;
1143 struct lttng_ht_node_str
*ua_event_node
;
1144 struct ust_app_event
*ua_event
;
1146 /* Get event node */
1147 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
1148 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
1149 if (ua_event_node
!= NULL
) {
1154 /* Does not exist so create one */
1155 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1156 if (ua_event
== NULL
) {
1157 /* Only malloc can failed so something is really wrong */
1161 shadow_copy_event(ua_event
, uevent
);
1163 /* Create it on the tracer side */
1164 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
1166 /* Not found previously means that it does not exist on the tracer */
1167 assert(ret
!= -EEXIST
);
1171 lttng_ht_add_unique_str(ua_chan
->events
, &ua_event
->node
);
1173 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
1180 /* Valid. Calling here is already in a read side lock */
1181 delete_ust_app_event(-1, ua_event
);
1186 * Create UST metadata and open it on the tracer side.
1188 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
1189 char *pathname
, struct ust_app
*app
)
1193 if (ua_sess
->metadata
== NULL
) {
1194 /* Allocate UST metadata */
1195 ua_sess
->metadata
= trace_ust_create_metadata(pathname
);
1196 if (ua_sess
->metadata
== NULL
) {
1197 /* malloc() failed */
1201 ret
= open_ust_metadata(app
, ua_sess
);
1203 DBG3("Opening metadata failed. Cleaning up memory");
1205 /* Cleanup failed metadata struct */
1206 free(ua_sess
->metadata
);
1208 * This is very important because delete_ust_app_session check if
1209 * the pointer is null or not in order to delete the metadata.
1211 ua_sess
->metadata
= NULL
;
1215 DBG2("UST metadata opened for app pid %d", app
->pid
);
1218 /* Open UST metadata stream */
1219 if (ua_sess
->metadata
->stream_obj
== NULL
) {
1220 ret
= create_ust_stream(app
, ua_sess
);
1225 ret
= run_as_mkdir(ua_sess
->path
, S_IRWXU
| S_IRWXG
,
1226 ua_sess
->uid
, ua_sess
->gid
);
1228 PERROR("mkdir UST metadata");
1232 ret
= snprintf(ua_sess
->metadata
->pathname
, PATH_MAX
,
1233 "%s/metadata", ua_sess
->path
);
1235 PERROR("asprintf UST create stream");
1239 DBG2("UST metadata stream object created for app pid %d",
1242 ERR("Attempting to create stream without metadata opened");
1253 * Return pointer to traceable apps list.
1255 struct lttng_ht
*ust_app_get_ht(void)
1261 * Return ust app pointer or NULL if not found.
1263 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
1265 struct lttng_ht_node_ulong
*node
;
1266 struct lttng_ht_iter iter
;
1269 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
1270 node
= lttng_ht_iter_get_node_ulong(&iter
);
1272 DBG2("UST app no found with pid %d", pid
);
1277 DBG2("Found UST app by pid %d", pid
);
1279 return caa_container_of(node
, struct ust_app
, pid_n
);
1287 * Using pid and uid (of the app), allocate a new ust_app struct and
1288 * add it to the global traceable app list.
1290 * On success, return 0, else return malloc -ENOMEM, or -EINVAL if app
1291 * bitness is not supported.
1293 int ust_app_register(struct ust_register_msg
*msg
, int sock
)
1295 struct ust_app
*lta
;
1298 if ((msg
->bits_per_long
== 64 && ust_consumerd64_fd
== -EINVAL
)
1299 || (msg
->bits_per_long
== 32 && ust_consumerd32_fd
== -EINVAL
)) {
1300 ERR("Registration failed: application \"%s\" (pid: %d) has "
1301 "%d-bit long, but no consumerd for this long size is available.\n",
1302 msg
->name
, msg
->pid
, msg
->bits_per_long
);
1307 lttng_fd_put(LTTNG_FD_APPS
, 1);
1310 if (msg
->major
!= LTTNG_UST_COMM_MAJOR
) {
1311 ERR("Registration failed: application \"%s\" (pid: %d) has "
1312 "communication protocol version %u.%u, but sessiond supports 2.x.\n",
1313 msg
->name
, msg
->pid
, msg
->major
, msg
->minor
);
1318 lttng_fd_put(LTTNG_FD_APPS
, 1);
1321 lta
= zmalloc(sizeof(struct ust_app
));
1327 lta
->ppid
= msg
->ppid
;
1328 lta
->uid
= msg
->uid
;
1329 lta
->gid
= msg
->gid
;
1330 lta
->compatible
= 0; /* Not compatible until proven */
1331 lta
->bits_per_long
= msg
->bits_per_long
;
1332 lta
->v_major
= msg
->major
;
1333 lta
->v_minor
= msg
->minor
;
1334 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
1335 lta
->name
[16] = '\0';
1336 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1338 lta
->pid
= msg
->pid
;
1339 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long)lta
->pid
);
1341 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long)lta
->sock
);
1346 * On a re-registration, we want to kick out the previous registration of
1349 lttng_ht_add_replace_ulong(ust_app_ht
, <a
->pid_n
);
1352 * The socket _should_ be unique until _we_ call close. So, a add_unique
1353 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
1354 * already in the table.
1356 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, <a
->sock_n
);
1360 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s"
1361 " (version %d.%d)", lta
->pid
, lta
->ppid
, lta
->uid
, lta
->gid
,
1362 lta
->sock
, lta
->name
, lta
->v_major
, lta
->v_minor
);
1368 * Unregister app by removing it from the global traceable app list and freeing
1371 * The socket is already closed at this point so no close to sock.
1373 void ust_app_unregister(int sock
)
1375 struct ust_app
*lta
;
1376 struct lttng_ht_node_ulong
*node
;
1377 struct lttng_ht_iter iter
;
1382 /* Get the node reference for a call_rcu */
1383 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1384 node
= lttng_ht_iter_get_node_ulong(&iter
);
1386 ERR("Unable to find app by sock %d", sock
);
1390 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
1392 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
1394 /* Remove application from PID hash table */
1395 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
1398 /* Assign second node for deletion */
1399 iter
.iter
.node
= <a
->pid_n
.node
;
1401 ret
= lttng_ht_del(ust_app_ht
, &iter
);
1405 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
1413 * Return traceable_app_count
1415 unsigned long ust_app_list_count(void)
1417 unsigned long count
;
1420 count
= lttng_ht_get_count(ust_app_ht
);
1427 * Fill events array with all events name of all registered apps.
1429 int ust_app_list_events(struct lttng_event
**events
)
1432 size_t nbmem
, count
= 0;
1433 struct lttng_ht_iter iter
;
1434 struct ust_app
*app
;
1435 struct lttng_event
*tmp
;
1437 nbmem
= UST_APP_EVENT_LIST_SIZE
;
1438 tmp
= zmalloc(nbmem
* sizeof(struct lttng_event
));
1440 PERROR("zmalloc ust app events");
1447 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
1448 struct lttng_ust_tracepoint_iter uiter
;
1450 if (!app
->compatible
) {
1452 * TODO: In time, we should notice the caller of this error by
1453 * telling him that this is a version error.
1457 handle
= ustctl_tracepoint_list(app
->sock
);
1459 ERR("UST app list events getting handle failed for app pid %d",
1464 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
1465 &uiter
)) != -ENOENT
) {
1466 if (count
>= nbmem
) {
1467 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
1470 tmp
= realloc(tmp
, nbmem
* sizeof(struct lttng_event
));
1472 PERROR("realloc ust app events");
1477 memcpy(tmp
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
1478 tmp
[count
].loglevel
= uiter
.loglevel
;
1479 tmp
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
1480 tmp
[count
].pid
= app
->pid
;
1481 tmp
[count
].enabled
= -1;
1489 DBG2("UST app list events done (%zu events)", count
);
1498 * Free and clean all traceable apps of the global list.
1500 void ust_app_clean_list(void)
1503 struct lttng_ht_iter iter
;
1504 struct lttng_ht_node_ulong
*node
;
1506 DBG2("UST app cleaning registered apps hash table");
1510 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, node
, node
) {
1511 ret
= lttng_ht_del(ust_app_ht
, &iter
);
1513 call_rcu(&node
->head
, delete_ust_app_rcu
);
1516 /* Cleanup socket hash table */
1517 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, node
, node
) {
1518 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
1522 /* Destroy is done only when the ht is empty */
1523 lttng_ht_destroy(ust_app_ht
);
1524 lttng_ht_destroy(ust_app_ht_by_sock
);
1530 * Init UST app hash table.
1532 void ust_app_ht_alloc(void)
1534 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1535 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1539 * For a specific UST session, disable the channel for all registered apps.
1541 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
1542 struct ltt_ust_channel
*uchan
)
1545 struct lttng_ht_iter iter
;
1546 struct lttng_ht_node_str
*ua_chan_node
;
1547 struct ust_app
*app
;
1548 struct ust_app_session
*ua_sess
;
1549 struct ust_app_channel
*ua_chan
;
1551 if (usess
== NULL
|| uchan
== NULL
) {
1552 ERR("Disabling UST global channel with NULL values");
1557 DBG2("UST app disabling channel %s from global domain for session id %d",
1558 uchan
->name
, usess
->id
);
1562 /* For every registered applications */
1563 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
1564 struct lttng_ht_iter uiter
;
1565 if (!app
->compatible
) {
1567 * TODO: In time, we should notice the caller of this error by
1568 * telling him that this is a version error.
1572 ua_sess
= lookup_session_by_app(usess
, app
);
1573 if (ua_sess
== NULL
) {
1578 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1579 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1580 /* If the session if found for the app, the channel must be there */
1581 assert(ua_chan_node
);
1583 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1584 /* The channel must not be already disabled */
1585 assert(ua_chan
->enabled
== 1);
1587 /* Disable channel onto application */
1588 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
1590 /* XXX: We might want to report this error at some point... */
1602 * For a specific UST session, enable the channel for all registered apps.
1604 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
1605 struct ltt_ust_channel
*uchan
)
1608 struct lttng_ht_iter iter
;
1609 struct ust_app
*app
;
1610 struct ust_app_session
*ua_sess
;
1612 if (usess
== NULL
|| uchan
== NULL
) {
1613 ERR("Adding UST global channel to NULL values");
1618 DBG2("UST app enabling channel %s to global domain for session id %d",
1619 uchan
->name
, usess
->id
);
1623 /* For every registered applications */
1624 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
1625 if (!app
->compatible
) {
1627 * TODO: In time, we should notice the caller of this error by
1628 * telling him that this is a version error.
1632 ua_sess
= lookup_session_by_app(usess
, app
);
1633 if (ua_sess
== NULL
) {
1637 /* Enable channel onto application */
1638 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
1640 /* XXX: We might want to report this error at some point... */
1652 * Disable an event in a channel and for a specific session.
1654 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
1655 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
1658 struct lttng_ht_iter iter
, uiter
;
1659 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
1660 struct ust_app
*app
;
1661 struct ust_app_session
*ua_sess
;
1662 struct ust_app_channel
*ua_chan
;
1663 struct ust_app_event
*ua_event
;
1665 DBG("UST app disabling event %s for all apps in channel "
1666 "%s for session id %d", uevent
->attr
.name
, uchan
->name
, usess
->id
);
1670 /* For all registered applications */
1671 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
1672 if (!app
->compatible
) {
1674 * TODO: In time, we should notice the caller of this error by
1675 * telling him that this is a version error.
1679 ua_sess
= lookup_session_by_app(usess
, app
);
1680 if (ua_sess
== NULL
) {
1685 /* Lookup channel in the ust app session */
1686 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1687 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1688 if (ua_chan_node
== NULL
) {
1689 DBG2("Channel %s not found in session id %d for app pid %d."
1690 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
1693 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1695 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
1696 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
1697 if (ua_event_node
== NULL
) {
1698 DBG2("Event %s not found in channel %s for app pid %d."
1699 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
1702 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
1704 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
1706 /* XXX: Report error someday... */
1717 * For a specific UST session and UST channel, the event for all
1720 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
1721 struct ltt_ust_channel
*uchan
)
1724 struct lttng_ht_iter iter
, uiter
;
1725 struct lttng_ht_node_str
*ua_chan_node
;
1726 struct ust_app
*app
;
1727 struct ust_app_session
*ua_sess
;
1728 struct ust_app_channel
*ua_chan
;
1729 struct ust_app_event
*ua_event
;
1731 DBG("UST app disabling all event for all apps in channel "
1732 "%s for session id %d", uchan
->name
, usess
->id
);
1736 /* For all registered applications */
1737 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
1738 if (!app
->compatible
) {
1740 * TODO: In time, we should notice the caller of this error by
1741 * telling him that this is a version error.
1745 ua_sess
= lookup_session_by_app(usess
, app
);
1746 /* If ua_sess is NULL, there is a code flow error */
1749 /* Lookup channel in the ust app session */
1750 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1751 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1752 /* If the channel is not found, there is a code flow error */
1753 assert(ua_chan_node
);
1755 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1757 /* Disable each events of channel */
1758 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
1760 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
1762 /* XXX: Report error someday... */
1774 * For a specific UST session, create the channel for all registered apps.
1776 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
1777 struct ltt_ust_channel
*uchan
)
1779 struct lttng_ht_iter iter
;
1780 struct ust_app
*app
;
1781 struct ust_app_session
*ua_sess
;
1782 struct ust_app_channel
*ua_chan
;
1784 /* Very wrong code flow */
1788 DBG2("UST app adding channel %s to global domain for session id %d",
1789 uchan
->name
, usess
->id
);
1793 /* For every registered applications */
1794 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
1795 if (!app
->compatible
) {
1797 * TODO: In time, we should notice the caller of this error by
1798 * telling him that this is a version error.
1803 * Create session on the tracer side and add it to app session HT. Note
1804 * that if session exist, it will simply return a pointer to the ust
1807 ua_sess
= create_ust_app_session(usess
, app
);
1808 if (ua_sess
== NULL
) {
1809 /* The malloc() failed. */
1811 } else if (ua_sess
== (void *) -1UL) {
1812 /* The application's socket is not valid. Contiuing */
1816 /* Create channel onto application */
1817 ua_chan
= create_ust_app_channel(ua_sess
, uchan
, app
);
1818 if (ua_chan
== NULL
) {
1819 /* Major problem here and it's maybe the tracer or malloc() */
1833 * Enable event for a specific session and channel on the tracer.
1835 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
1836 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
1839 struct lttng_ht_iter iter
, uiter
;
1840 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
1841 struct ust_app
*app
;
1842 struct ust_app_session
*ua_sess
;
1843 struct ust_app_channel
*ua_chan
;
1844 struct ust_app_event
*ua_event
;
1846 DBG("UST app enabling event %s for all apps for session id %d",
1847 uevent
->attr
.name
, usess
->id
);
1850 * NOTE: At this point, this function is called only if the session and
1851 * channel passed are already created for all apps. and enabled on the
1857 /* For all registered applications */
1858 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
1859 if (!app
->compatible
) {
1861 * TODO: In time, we should notice the caller of this error by
1862 * telling him that this is a version error.
1866 ua_sess
= lookup_session_by_app(usess
, app
);
1867 /* If ua_sess is NULL, there is a code flow error */
1870 /* Lookup channel in the ust app session */
1871 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1872 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1873 /* If the channel is not found, there is a code flow error */
1874 assert(ua_chan_node
);
1876 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1878 lttng_ht_lookup(ua_chan
->events
, (void*)uevent
->attr
.name
, &uiter
);
1879 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
1880 if (ua_event_node
== NULL
) {
1881 DBG3("UST app enable event %s not found for app PID %d."
1882 "Skipping app", uevent
->attr
.name
, app
->pid
);
1885 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
1887 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
1899 * For a specific existing UST session and UST channel, creates the event for
1900 * all registered apps.
1902 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
1903 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
1906 struct lttng_ht_iter iter
, uiter
;
1907 struct lttng_ht_node_str
*ua_chan_node
;
1908 struct ust_app
*app
;
1909 struct ust_app_session
*ua_sess
;
1910 struct ust_app_channel
*ua_chan
;
1912 DBG("UST app creating event %s for all apps for session id %d",
1913 uevent
->attr
.name
, usess
->id
);
1917 /* For all registered applications */
1918 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
1919 if (!app
->compatible
) {
1921 * TODO: In time, we should notice the caller of this error by
1922 * telling him that this is a version error.
1926 ua_sess
= lookup_session_by_app(usess
, app
);
1927 /* If ua_sess is NULL, there is a code flow error */
1930 /* Lookup channel in the ust app session */
1931 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1932 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1933 /* If the channel is not found, there is a code flow error */
1934 assert(ua_chan_node
);
1936 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1938 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
1940 if (ret
!= -EEXIST
) {
1941 /* Possible value at this point: -ENOMEM. If so, we stop! */
1944 DBG2("UST app event %s already exist on app PID %d",
1945 uevent
->attr
.name
, app
->pid
);
1956 * Start tracing for a specific UST session and app.
1958 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
1961 struct lttng_ht_iter iter
;
1962 struct ust_app_session
*ua_sess
;
1963 struct ust_app_channel
*ua_chan
;
1964 struct ltt_ust_stream
*ustream
;
1967 DBG("Starting tracing for ust app pid %d", app
->pid
);
1971 if (!app
->compatible
) {
1975 ua_sess
= lookup_session_by_app(usess
, app
);
1976 if (ua_sess
== NULL
) {
1977 goto error_rcu_unlock
;
1980 /* Upon restart, we skip the setup, already done */
1981 if (ua_sess
->started
) {
1985 /* Indicate that the session has been started once */
1986 ua_sess
->started
= 1;
1988 ret
= create_ust_app_metadata(ua_sess
, usess
->pathname
, app
);
1990 goto error_rcu_unlock
;
1993 /* For each channel */
1994 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
1996 /* Create all streams */
1998 /* Create UST stream */
1999 ustream
= zmalloc(sizeof(*ustream
));
2000 if (ustream
== NULL
) {
2001 PERROR("zmalloc ust stream");
2002 goto error_rcu_unlock
;
2005 /* We are going to receive 2 fds, we need to reserve them. */
2006 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2008 ERR("Exhausted number of available FD upon stream create");
2010 goto error_rcu_unlock
;
2012 ret
= ustctl_create_stream(app
->sock
, ua_chan
->obj
,
2015 /* Got all streams */
2016 lttng_fd_put(LTTNG_FD_APPS
, 2);
2020 ustream
->handle
= ustream
->obj
->handle
;
2022 /* Order is important */
2023 cds_list_add_tail(&ustream
->list
, &ua_chan
->streams
.head
);
2024 ret
= snprintf(ustream
->pathname
, PATH_MAX
, "%s/%s_%u",
2025 ua_sess
->path
, ua_chan
->name
,
2026 ua_chan
->streams
.count
++);
2028 PERROR("asprintf UST create stream");
2030 * XXX what should we do here with the
2035 DBG2("UST stream %d ready at %s", ua_chan
->streams
.count
,
2040 switch (app
->bits_per_long
) {
2042 consumerd_fd
= ust_consumerd64_fd
;
2045 consumerd_fd
= ust_consumerd32_fd
;
2049 goto error_rcu_unlock
;
2052 /* Setup UST consumer socket and send fds to it */
2053 ret
= ust_consumer_send_session(consumerd_fd
, ua_sess
);
2055 goto error_rcu_unlock
;
2058 /* Ask UST to open the write side of the wait pipe */
2059 DBG("Asking UST to open metadata stream wait pipe path: %s\n",
2060 ua_sess
->metadata
->stream_obj
->wait_pipe_path
);
2062 ret
= ustctl_open_wait_pipe(app
->sock
, ua_sess
->metadata
->obj
);
2065 ERR("Asking UST to open wait_pipe failed");
2069 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
2072 DBG("Asking UST to open channel wait pipe path: %s\n",
2073 ua_chan
->obj
->wait_pipe_path
);
2075 ret
= ustctl_open_wait_pipe(app
->sock
, ua_chan
->obj
);
2078 ERR("Asking UST to open wait_pipe failed for wait pipe: %s",
2079 ua_chan
->obj
->wait_pipe_path
);
2084 /* This start the UST tracing */
2085 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
2087 ERR("Error starting tracing for app pid: %d", app
->pid
);
2088 goto error_rcu_unlock
;
2091 /* Quiescent wait after starting trace */
2092 ustctl_wait_quiescent(app
->sock
);
2104 * Stop tracing for a specific UST session and app.
2106 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
2109 struct lttng_ht_iter iter
;
2110 struct ust_app_session
*ua_sess
;
2111 struct ust_app_channel
*ua_chan
;
2113 DBG("Stopping tracing for ust app pid %d", app
->pid
);
2117 if (!app
->compatible
) {
2121 ua_sess
= lookup_session_by_app(usess
, app
);
2122 if (ua_sess
== NULL
) {
2123 /* Only malloc can failed so something is really wrong */
2124 goto error_rcu_unlock
;
2128 * If started = 0, it means that stop trace has been called for a session
2129 * that was never started. This is a code flow error and should never
2132 assert(ua_sess
->started
== 1);
2134 /* This inhibits UST tracing */
2135 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
2137 ERR("Error stopping tracing for app pid: %d", app
->pid
);
2138 goto error_rcu_unlock
;
2141 /* Quiescent wait after stopping trace */
2142 ustctl_wait_quiescent(app
->sock
);
2144 /* Flushing buffers */
2145 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
2147 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
2149 ERR("UST app PID %d channel %s flush failed with ret %d",
2150 app
->pid
, ua_chan
->name
, ret
);
2151 /* Continuing flushing all buffers */
2156 /* Flush all buffers before stopping */
2157 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_sess
->metadata
->obj
);
2159 ERR("UST app PID %d metadata flush failed with ret %d", app
->pid
,
2173 * Destroy a specific UST session in apps.
2175 int ust_app_destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
2177 struct ust_app_session
*ua_sess
;
2178 struct lttng_ust_object_data obj
;
2179 struct lttng_ht_iter iter
;
2180 struct lttng_ht_node_ulong
*node
;
2183 DBG("Destroy tracing for ust app pid %d", app
->pid
);
2187 if (!app
->compatible
) {
2191 __lookup_session_by_app(usess
, app
, &iter
);
2192 node
= lttng_ht_iter_get_node_ulong(&iter
);
2194 /* Only malloc can failed so something is really wrong */
2195 goto error_rcu_unlock
;
2197 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
2198 ret
= lttng_ht_del(app
->sessions
, &iter
);
2200 obj
.handle
= ua_sess
->handle
;
2203 obj
.memory_map_size
= 0;
2204 ustctl_release_object(app
->sock
, &obj
);
2206 delete_ust_app_session(app
->sock
, ua_sess
);
2208 /* Quiescent wait after stopping trace */
2209 ustctl_wait_quiescent(app
->sock
);
2221 * Start tracing for the UST session.
2223 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
2226 struct lttng_ht_iter iter
;
2227 struct ust_app
*app
;
2229 DBG("Starting all UST traces");
2233 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
2234 ret
= ust_app_start_trace(usess
, app
);
2236 /* Continue to next apps even on error */
2247 * Start tracing for the UST session.
2249 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
2252 struct lttng_ht_iter iter
;
2253 struct ust_app
*app
;
2255 DBG("Stopping all UST traces");
2259 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
2260 ret
= ust_app_stop_trace(usess
, app
);
2262 /* Continue to next apps even on error */
2273 * Destroy app UST session.
2275 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
2278 struct lttng_ht_iter iter
;
2279 struct ust_app
*app
;
2281 DBG("Destroy all UST traces");
2285 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
2286 ret
= ust_app_destroy_trace(usess
, app
);
2288 /* Continue to next apps even on error */
2299 * Add channels/events from UST global domain to registered apps at sock.
2301 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
2304 struct lttng_ht_iter iter
, uiter
, iter_ctx
;
2305 struct ust_app
*app
;
2306 struct ust_app_session
*ua_sess
;
2307 struct ust_app_channel
*ua_chan
;
2308 struct ust_app_event
*ua_event
;
2309 struct ust_app_ctx
*ua_ctx
;
2311 if (usess
== NULL
) {
2312 ERR("No UST session on global update. Returning");
2316 DBG2("UST app global update for app sock %d for session id %d", sock
,
2321 app
= find_app_by_sock(sock
);
2323 ERR("Failed to update app sock %d", sock
);
2327 if (!app
->compatible
) {
2331 ua_sess
= create_ust_app_session(usess
, app
);
2332 if (ua_sess
== NULL
|| ua_sess
== (void *) -1UL) {
2337 * We can iterate safely here over all UST app session sicne the create ust
2338 * app session above made a shadow copy of the UST global domain from the
2341 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
2343 ret
= create_ust_channel(app
, ua_sess
, ua_chan
);
2345 /* FIXME: Should we quit here or continue... */
2349 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter_ctx
.iter
, ua_ctx
,
2351 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2353 /* FIXME: Should we quit here or continue... */
2359 /* For each events */
2360 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
2362 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2364 /* FIXME: Should we quit here or continue... */
2368 /* Add context on events. */
2369 cds_lfht_for_each_entry(ua_event
->ctx
->ht
, &iter_ctx
.iter
,
2370 ua_ctx
, node
.node
) {
2371 ret
= create_ust_event_context(ua_event
, ua_ctx
, app
);
2373 /* FIXME: Should we quit here or continue... */
2380 if (usess
->start_trace
) {
2381 ret
= ust_app_start_trace(usess
, app
);
2386 DBG2("UST trace started for app pid %d", app
->pid
);
2395 * Add context to a specific channel for global UST domain.
2397 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
2398 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
2401 struct lttng_ht_node_str
*ua_chan_node
;
2402 struct lttng_ht_iter iter
, uiter
;
2403 struct ust_app_channel
*ua_chan
= NULL
;
2404 struct ust_app_session
*ua_sess
;
2405 struct ust_app
*app
;
2409 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
2410 if (!app
->compatible
) {
2412 * TODO: In time, we should notice the caller of this error by
2413 * telling him that this is a version error.
2417 ua_sess
= lookup_session_by_app(usess
, app
);
2418 if (ua_sess
== NULL
) {
2422 /* Lookup channel in the ust app session */
2423 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
2424 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
2425 if (ua_chan_node
== NULL
) {
2428 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
2431 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
2442 * Add context to a specific event in a channel for global UST domain.
2444 int ust_app_add_ctx_event_glb(struct ltt_ust_session
*usess
,
2445 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
2446 struct ltt_ust_context
*uctx
)
2449 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
2450 struct lttng_ht_iter iter
, uiter
;
2451 struct ust_app_session
*ua_sess
;
2452 struct ust_app_event
*ua_event
;
2453 struct ust_app_channel
*ua_chan
= NULL
;
2454 struct ust_app
*app
;
2458 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
2459 if (!app
->compatible
) {
2461 * TODO: In time, we should notice the caller of this error by
2462 * telling him that this is a version error.
2466 ua_sess
= lookup_session_by_app(usess
, app
);
2467 if (ua_sess
== NULL
) {
2471 /* Lookup channel in the ust app session */
2472 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
2473 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
2474 if (ua_chan_node
== NULL
) {
2477 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
2480 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
2481 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
2482 if (ua_event_node
== NULL
) {
2485 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
,
2488 ret
= create_ust_app_event_context(ua_sess
, ua_event
, &uctx
->ctx
, app
);
2499 * Enable event for a channel from a UST session for a specific PID.
2501 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
2502 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
2505 struct lttng_ht_iter iter
;
2506 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
2507 struct ust_app
*app
;
2508 struct ust_app_session
*ua_sess
;
2509 struct ust_app_channel
*ua_chan
;
2510 struct ust_app_event
*ua_event
;
2512 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
2516 app
= ust_app_find_by_pid(pid
);
2518 ERR("UST app enable event per PID %d not found", pid
);
2523 if (!app
->compatible
) {
2528 ua_sess
= lookup_session_by_app(usess
, app
);
2529 /* If ua_sess is NULL, there is a code flow error */
2532 /* Lookup channel in the ust app session */
2533 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2534 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2535 /* If the channel is not found, there is a code flow error */
2536 assert(ua_chan_node
);
2538 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2540 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
2541 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
2542 if (ua_event_node
== NULL
) {
2543 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
2548 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
2550 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
2562 * Disable event for a channel from a UST session for a specific PID.
2564 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
2565 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
2568 struct lttng_ht_iter iter
;
2569 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
2570 struct ust_app
*app
;
2571 struct ust_app_session
*ua_sess
;
2572 struct ust_app_channel
*ua_chan
;
2573 struct ust_app_event
*ua_event
;
2575 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
2579 app
= ust_app_find_by_pid(pid
);
2581 ERR("UST app disable event per PID %d not found", pid
);
2586 if (!app
->compatible
) {
2591 ua_sess
= lookup_session_by_app(usess
, app
);
2592 /* If ua_sess is NULL, there is a code flow error */
2595 /* Lookup channel in the ust app session */
2596 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2597 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2598 if (ua_chan_node
== NULL
) {
2599 /* Channel does not exist, skip disabling */
2602 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2604 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
2605 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
2606 if (ua_event_node
== NULL
) {
2607 /* Event does not exist, skip disabling */
2610 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
2612 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
2623 * Validate version of UST apps and set the compatible bit.
2625 int ust_app_validate_version(int sock
)
2628 struct ust_app
*app
;
2632 app
= find_app_by_sock(sock
);
2635 ret
= ustctl_tracer_version(sock
, &app
->version
);
2640 /* Validate version */
2641 if (app
->version
.major
> UST_APP_MAJOR_VERSION
) {
2645 DBG2("UST app PID %d is compatible with major version %d "
2646 "(supporting <= %d)", app
->pid
, app
->version
.major
,
2647 UST_APP_MAJOR_VERSION
);
2648 app
->compatible
= 1;
2653 DBG2("UST app PID %d is not compatible with major version %d "
2654 "(supporting <= %d)", app
->pid
, app
->version
.major
,
2655 UST_APP_MAJOR_VERSION
);
2656 app
->compatible
= 0;
2662 * Calibrate registered applications.
2664 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
2667 struct lttng_ht_iter iter
;
2668 struct ust_app
*app
;
2672 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
2673 if (!app
->compatible
) {
2675 * TODO: In time, we should notice the caller of this error by
2676 * telling him that this is a version error.
2681 ret
= ustctl_calibrate(app
->sock
, calibrate
);
2685 /* Means that it's not implemented on the tracer side. */
2689 /* TODO: Report error to user */
2690 DBG2("Calibrate app PID %d returned with error %d",
2697 DBG("UST app global domain calibration finished");