2 * Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include <urcu/uatomic.h>
23 #include <common/common.h>
24 #include <common/sessiond-comm/agent.h>
26 #include <common/compat/endian.h>
33 * Match function for the events hash table lookup by name.
35 static int ht_match_event_by_name(struct cds_lfht_node
*node
,
38 struct agent_event
*event
;
39 const struct agent_ht_key
*key
;
44 event
= caa_container_of(node
, struct agent_event
, node
.node
);
47 /* Match 1 elements of the key: name. */
50 if (strncmp(event
->name
, key
->name
, sizeof(event
->name
)) != 0) {
61 * Match function for the events hash table lookup by name and loglevel.
63 static int ht_match_event(struct cds_lfht_node
*node
,
66 struct agent_event
*event
;
67 const struct agent_ht_key
*key
;
73 event
= caa_container_of(node
, struct agent_event
, node
.node
);
76 /* Match 2 elements of the key: name and loglevel. */
79 if (strncmp(event
->name
, key
->name
, sizeof(event
->name
)) != 0) {
83 /* Event loglevel value and type. */
84 ll_match
= loglevels_match(event
->loglevel_type
,
85 event
->loglevel_value
, key
->loglevel_type
,
86 key
->loglevel_value
, LTTNG_EVENT_LOGLEVEL_ALL
);
92 /* Filter expression */
93 if (strncmp(event
->filter_expression
, key
->filter_expression
,
94 strlen(event
->filter_expression
)) != 0) {
105 * Add unique agent event based on the event name and loglevel.
107 static void add_unique_agent_event(struct lttng_ht
*ht
,
108 struct agent_event
*event
)
110 struct cds_lfht_node
*node_ptr
;
111 struct agent_ht_key key
;
117 key
.name
= event
->name
;
118 key
.loglevel_value
= event
->loglevel_value
;
119 key
.loglevel_type
= event
->loglevel_type
;
120 key
.filter_expression
= event
->filter_expression
;
122 node_ptr
= cds_lfht_add_unique(ht
->ht
,
123 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
124 ht_match_event
, &key
, &event
->node
.node
);
125 assert(node_ptr
== &event
->node
.node
);
129 * URCU delayed agent event reclaim.
131 static void destroy_event_agent_rcu(struct rcu_head
*head
)
133 struct lttng_ht_node_str
*node
=
134 caa_container_of(head
, struct lttng_ht_node_str
, head
);
135 struct agent_event
*event
=
136 caa_container_of(node
, struct agent_event
, node
);
138 agent_destroy_event(event
);
142 * URCU delayed agent app reclaim.
144 static void destroy_app_agent_rcu(struct rcu_head
*head
)
146 struct lttng_ht_node_ulong
*node
=
147 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
148 struct agent_app
*app
=
149 caa_container_of(node
, struct agent_app
, node
);
155 * Communication with the agent. Send the message header to the given socket in
158 * Return 0 on success or else a negative errno message of sendmsg() op.
160 static int send_header(struct lttcomm_sock
*sock
, uint64_t data_size
,
161 uint32_t cmd
, uint32_t cmd_version
)
165 struct lttcomm_agent_hdr msg
;
169 memset(&msg
, 0, sizeof(msg
));
170 msg
.data_size
= htobe64(data_size
);
171 msg
.cmd
= htobe32(cmd
);
172 msg
.cmd_version
= htobe32(cmd_version
);
174 size
= sock
->ops
->sendmsg(sock
, &msg
, sizeof(msg
), 0);
175 if (size
< sizeof(msg
)) {
186 * Communication call with the agent. Send the payload to the given socket. The
187 * header MUST be sent prior to this call.
189 * Return 0 on success or else a negative errno value of sendmsg() op.
191 static int send_payload(struct lttcomm_sock
*sock
, void *data
,
200 len
= sock
->ops
->sendmsg(sock
, data
, size
, 0);
212 * Communication call with the agent. Receive reply from the agent using the
215 * Return 0 on success or else a negative errno value from recvmsg() op.
217 static int recv_reply(struct lttcomm_sock
*sock
, void *buf
, size_t size
)
225 len
= sock
->ops
->recvmsg(sock
, buf
, size
, 0);
237 * Internal event listing for a given app. Populate events.
239 * Return number of element in the list or else a negative LTTNG_ERR* code.
240 * On success, the caller is responsible for freeing the memory
241 * allocated for "events".
243 static ssize_t
list_events(struct agent_app
*app
, struct lttng_event
**events
)
245 int ret
, i
, len
= 0, offset
= 0;
248 struct lttng_event
*tmp_events
= NULL
;
249 struct lttcomm_agent_list_reply
*reply
= NULL
;
250 struct lttcomm_agent_list_reply_hdr reply_hdr
;
256 DBG2("Agent listing events for app pid: %d and socket %d", app
->pid
,
259 ret
= send_header(app
->sock
, 0, AGENT_CMD_LIST
, 0);
264 /* Get list header so we know how much we'll receive. */
265 ret
= recv_reply(app
->sock
, &reply_hdr
, sizeof(reply_hdr
));
270 switch (be32toh(reply_hdr
.ret_code
)) {
271 case AGENT_RET_CODE_SUCCESS
:
272 data_size
= be32toh(reply_hdr
.data_size
) + sizeof(*reply
);
275 ERR("Agent returned an unknown code: %" PRIu32
,
276 be32toh(reply_hdr
.ret_code
));
277 ret
= LTTNG_ERR_FATAL
;
281 reply
= zmalloc(data_size
);
283 ret
= LTTNG_ERR_NOMEM
;
287 /* Get the list with the appropriate data size. */
288 ret
= recv_reply(app
->sock
, reply
, data_size
);
293 nb_event
= be32toh(reply
->nb_event
);
294 tmp_events
= zmalloc(sizeof(*tmp_events
) * nb_event
);
296 ret
= LTTNG_ERR_NOMEM
;
300 for (i
= 0; i
< nb_event
; i
++) {
302 if (lttng_strncpy(tmp_events
[i
].name
, reply
->payload
+ offset
,
303 sizeof(tmp_events
[i
].name
))) {
304 ret
= LTTNG_ERR_INVALID
;
307 tmp_events
[i
].pid
= app
->pid
;
308 tmp_events
[i
].enabled
= -1;
309 len
= strlen(reply
->payload
+ offset
) + 1;
312 *events
= tmp_events
;
318 ret
= LTTNG_ERR_UST_LIST_FAIL
;
327 * Internal enable agent event on a agent application. This function
328 * communicates with the agent to enable a given event.
330 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
332 static int enable_event(struct agent_app
*app
, struct agent_event
*event
)
336 struct lttcomm_agent_enable msg
;
337 struct lttcomm_agent_generic_reply reply
;
343 DBG2("Agent enabling event %s for app pid: %d and socket %d", event
->name
,
344 app
->pid
, app
->sock
->fd
);
346 data_size
= sizeof(msg
);
348 ret
= send_header(app
->sock
, data_size
, AGENT_CMD_ENABLE
, 0);
353 memset(&msg
, 0, sizeof(msg
));
354 msg
.loglevel_value
= event
->loglevel_value
;
355 msg
.loglevel_type
= event
->loglevel_type
;
356 strncpy(msg
.name
, event
->name
, sizeof(msg
.name
));
357 ret
= send_payload(app
->sock
, &msg
, sizeof(msg
));
362 ret
= recv_reply(app
->sock
, &reply
, sizeof(reply
));
367 switch (be32toh(reply
.ret_code
)) {
368 case AGENT_RET_CODE_SUCCESS
:
370 case AGENT_RET_CODE_UNKNOWN_NAME
:
371 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
374 ERR("Agent returned an unknown code: %" PRIu32
,
375 be32toh(reply
.ret_code
));
376 ret
= LTTNG_ERR_FATAL
;
383 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
389 * Internal disable agent event call on a agent application. This function
390 * communicates with the agent to disable a given event.
392 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
394 static int disable_event(struct agent_app
*app
, struct agent_event
*event
)
398 struct lttcomm_agent_disable msg
;
399 struct lttcomm_agent_generic_reply reply
;
405 DBG2("Agent disabling event %s for app pid: %d and socket %d", event
->name
,
406 app
->pid
, app
->sock
->fd
);
408 data_size
= sizeof(msg
);
409 memset(&msg
, 0, sizeof(msg
));
410 if (lttng_strncpy(msg
.name
, event
->name
, sizeof(msg
.name
))) {
411 ret
= LTTNG_ERR_INVALID
;
415 ret
= send_header(app
->sock
, data_size
, AGENT_CMD_DISABLE
, 0);
420 ret
= send_payload(app
->sock
, &msg
, sizeof(msg
));
425 ret
= recv_reply(app
->sock
, &reply
, sizeof(reply
));
430 switch (be32toh(reply
.ret_code
)) {
431 case AGENT_RET_CODE_SUCCESS
:
433 case AGENT_RET_CODE_UNKNOWN_NAME
:
434 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
437 ERR("Agent returned an unknown code: %" PRIu32
,
438 be32toh(reply
.ret_code
));
439 ret
= LTTNG_ERR_FATAL
;
446 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
452 * Send back the registration DONE command to a given agent application.
454 * Return 0 on success or else a negative value.
456 int agent_send_registration_done(struct agent_app
*app
)
461 DBG("Agent sending registration done to app socket %d", app
->sock
->fd
);
463 return send_header(app
->sock
, 0, AGENT_CMD_REG_DONE
, 0);
467 * Enable agent event on every agent applications registered with the session
470 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
472 int agent_enable_event(struct agent_event
*event
,
473 enum lttng_domain_type domain
)
476 struct agent_app
*app
;
477 struct lttng_ht_iter iter
;
483 cds_lfht_for_each_entry(agent_apps_ht_by_sock
->ht
, &iter
.iter
, app
,
485 if (app
->domain
!= domain
) {
489 /* Enable event on agent application through TCP socket. */
490 ret
= enable_event(app
, event
);
491 if (ret
!= LTTNG_OK
) {
505 * Disable agent event on every agent applications registered with the session
508 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
510 int agent_disable_event(struct agent_event
*event
,
511 enum lttng_domain_type domain
)
514 struct agent_app
*app
;
515 struct lttng_ht_iter iter
;
518 if (!event
->enabled
) {
524 cds_lfht_for_each_entry(agent_apps_ht_by_sock
->ht
, &iter
.iter
, app
,
526 if (app
->domain
!= domain
) {
530 /* Enable event on agent application through TCP socket. */
531 ret
= disable_event(app
, event
);
532 if (ret
!= LTTNG_OK
) {
546 * Ask every agent for the list of possible event. Events is allocated with the
547 * events of every agent application.
549 * Return the number of events or else a negative value.
551 int agent_list_events(struct lttng_event
**events
,
552 enum lttng_domain_type domain
)
555 size_t nbmem
, count
= 0;
556 struct agent_app
*app
;
557 struct lttng_event
*tmp_events
= NULL
;
558 struct lttng_ht_iter iter
;
562 DBG2("Agent listing events for domain %d", domain
);
564 nbmem
= UST_APP_EVENT_LIST_SIZE
;
565 tmp_events
= zmalloc(nbmem
* sizeof(*tmp_events
));
567 PERROR("zmalloc agent list events");
573 cds_lfht_for_each_entry(agent_apps_ht_by_sock
->ht
, &iter
.iter
, app
,
576 struct lttng_event
*agent_events
;
578 /* Skip domain not asked by the list. */
579 if (app
->domain
!= domain
) {
583 nb_ev
= list_events(app
, &agent_events
);
589 if (count
+ nb_ev
> nbmem
) {
590 /* In case the realloc fails, we free the memory */
591 struct lttng_event
*new_tmp_events
;
594 new_nbmem
= max_t(size_t, count
+ nb_ev
, nbmem
<< 1);
595 DBG2("Reallocating agent event list from %zu to %zu entries",
597 new_tmp_events
= realloc(tmp_events
,
598 new_nbmem
* sizeof(*new_tmp_events
));
599 if (!new_tmp_events
) {
600 PERROR("realloc agent events");
605 /* Zero the new memory */
606 memset(new_tmp_events
+ nbmem
, 0,
607 (new_nbmem
- nbmem
) * sizeof(*new_tmp_events
));
609 tmp_events
= new_tmp_events
;
611 memcpy(tmp_events
+ count
, agent_events
,
612 nb_ev
* sizeof(*tmp_events
));
619 *events
= tmp_events
;
630 * Create a agent app object using the given PID.
632 * Return newly allocated object or else NULL on error.
634 struct agent_app
*agent_create_app(pid_t pid
, enum lttng_domain_type domain
,
635 struct lttcomm_sock
*sock
)
637 struct agent_app
*app
;
641 app
= zmalloc(sizeof(*app
));
643 PERROR("zmalloc agent create");
648 app
->domain
= domain
;
650 lttng_ht_node_init_ulong(&app
->node
, (unsigned long) app
->sock
->fd
);
657 * Lookup agent app by socket in the global hash table.
659 * RCU read side lock MUST be acquired.
661 * Return object if found else NULL.
663 struct agent_app
*agent_find_app_by_sock(int sock
)
665 struct lttng_ht_node_ulong
*node
;
666 struct lttng_ht_iter iter
;
667 struct agent_app
*app
;
671 lttng_ht_lookup(agent_apps_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
672 node
= lttng_ht_iter_get_node_ulong(&iter
);
676 app
= caa_container_of(node
, struct agent_app
, node
);
678 DBG3("Agent app pid %d found by sock %d.", app
->pid
, sock
);
682 DBG3("Agent app NOT found by sock %d.", sock
);
687 * Add agent application object to the global hash table.
689 void agent_add_app(struct agent_app
*app
)
693 DBG3("Agent adding app sock: %d and pid: %d to ht", app
->sock
->fd
, app
->pid
);
696 lttng_ht_add_unique_ulong(agent_apps_ht_by_sock
, &app
->node
);
701 * Delete agent application from the global hash table.
703 * rcu_read_lock() must be held by the caller.
705 void agent_delete_app(struct agent_app
*app
)
708 struct lttng_ht_iter iter
;
712 DBG3("Agent deleting app pid: %d and sock: %d", app
->pid
, app
->sock
->fd
);
714 iter
.iter
.node
= &app
->node
.node
;
715 ret
= lttng_ht_del(agent_apps_ht_by_sock
, &iter
);
720 * Destroy a agent application object by detaching it from its corresponding
721 * UST app if one is connected by closing the socket. Finally, perform a
722 * delayed memory reclaim.
724 void agent_destroy_app(struct agent_app
*app
)
729 app
->sock
->ops
->close(app
->sock
);
730 lttcomm_destroy_sock(app
->sock
);
733 call_rcu(&app
->node
.head
, destroy_app_agent_rcu
);
737 * Initialize an already allocated agent object.
739 * Return 0 on success or else a negative errno value.
741 int agent_init(struct agent
*agt
)
747 agt
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
752 lttng_ht_node_init_u64(&agt
->node
, agt
->domain
);
761 * Add agent object to the given hash table.
763 void agent_add(struct agent
*agt
, struct lttng_ht
*ht
)
768 DBG3("Agent adding from domain %d", agt
->domain
);
771 lttng_ht_add_unique_u64(ht
, &agt
->node
);
776 * Create an agent object for the given domain.
778 * Return the allocated agent or NULL on error.
780 struct agent
*agent_create(enum lttng_domain_type domain
)
785 agt
= zmalloc(sizeof(*agt
));
789 agt
->domain
= domain
;
791 ret
= agent_init(agt
);
803 * Create a newly allocated agent event data structure.
804 * Ownership of filter_expression is taken.
806 * Return a new object else NULL on error.
808 struct agent_event
*agent_create_event(const char *name
,
809 enum lttng_loglevel_type loglevel_type
, int loglevel_value
,
810 struct lttng_filter_bytecode
*filter
, char *filter_expression
)
812 struct agent_event
*event
= NULL
;
814 DBG3("Agent create new event with name %s, loglevel type %d, \
815 loglevel value %d and filter %s",
816 name
, loglevel_type
, loglevel_value
,
817 filter_expression
? filter_expression
: "NULL");
820 ERR("Failed to create agent event; no name provided.");
824 event
= zmalloc(sizeof(*event
));
829 strncpy(event
->name
, name
, sizeof(event
->name
));
830 event
->name
[sizeof(event
->name
) - 1] = '\0';
831 lttng_ht_node_init_str(&event
->node
, event
->name
);
833 event
->loglevel_value
= loglevel_value
;
834 event
->loglevel_type
= loglevel_type
;
835 event
->filter
= filter
;
836 event
->filter_expression
= filter_expression
;
842 * Unique add of a agent event to an agent object.
844 void agent_add_event(struct agent_event
*event
, struct agent
*agt
)
850 DBG3("Agent adding event %s", event
->name
);
853 add_unique_agent_event(agt
->events
, event
);
859 * Find multiple agent events sharing the given name.
861 * RCU read side lock MUST be acquired. It must be held for the
862 * duration of the iteration.
864 * Sets the given iterator.
866 void agent_find_events_by_name(const char *name
, struct agent
*agt
,
867 struct lttng_ht_iter
* iter
)
870 struct agent_ht_key key
;
880 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
881 ht_match_event_by_name
, &key
, &iter
->iter
);
885 * Get the next agent event duplicate by name. This should be called
886 * after a call to agent_find_events_by_name() to iterate on events.
888 * The RCU read lock must be held during the iteration and for as long
889 * as the object the iterator points to remains in use.
891 void agent_event_next_duplicate(const char *name
,
892 struct agent
*agt
, struct lttng_ht_iter
* iter
)
894 struct agent_ht_key key
;
898 cds_lfht_next_duplicate(agt
->events
->ht
, ht_match_event_by_name
,
903 * Find a agent event in the given agent using name, loglevel and filter.
905 * RCU read side lock MUST be acquired.
907 * Return object if found else NULL.
909 struct agent_event
*agent_find_event(const char *name
,
910 enum lttng_loglevel_type loglevel_type
, int loglevel_value
,
911 char *filter_expression
, struct agent
*agt
)
913 struct lttng_ht_node_str
*node
;
914 struct lttng_ht_iter iter
;
916 struct agent_ht_key key
;
924 key
.loglevel_value
= loglevel_value
;
925 key
.loglevel_type
= loglevel_type
;
926 key
.filter_expression
= filter_expression
;
928 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
929 ht_match_event
, &key
, &iter
.iter
);
930 node
= lttng_ht_iter_get_node_str(&iter
);
935 DBG3("Agent event found %s.", name
);
936 return caa_container_of(node
, struct agent_event
, node
);
939 DBG3("Agent event NOT found %s.", name
);
944 * Free given agent event. This event must not be globally visible at this
945 * point (only expected to be used on failure just after event creation). After
946 * this call, the pointer is not usable anymore.
948 void agent_destroy_event(struct agent_event
*event
)
953 free(event
->filter_expression
);
954 free(event
->exclusion
);
959 * Destroy an agent completely.
961 void agent_destroy(struct agent
*agt
)
963 struct lttng_ht_node_str
*node
;
964 struct lttng_ht_iter iter
;
968 DBG3("Agent destroy");
971 * Just ignore if no events hash table exists. This is possible if for
972 * instance an agent object was allocated but not initialized.
979 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, node
, node
) {
981 struct agent_event
*event
;
984 * When destroying an event, we have to try to disable it on the agent
985 * side so the event stops generating data. The return value is not
986 * important since we have to continue anyway destroying the object.
988 event
= caa_container_of(node
, struct agent_event
, node
);
989 (void) agent_disable_event(event
, agt
->domain
);
991 ret
= lttng_ht_del(agt
->events
, &iter
);
993 call_rcu(&node
->head
, destroy_event_agent_rcu
);
997 ht_cleanup_push(agt
->events
);
1002 * Allocate agent_apps_ht_by_sock.
1004 int agent_app_ht_alloc(void)
1008 agent_apps_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1009 if (!agent_apps_ht_by_sock
) {
1017 * Destroy a agent application by socket.
1019 void agent_destroy_app_by_sock(int sock
)
1021 struct agent_app
*app
;
1026 * Not finding an application is a very important error that should NEVER
1027 * happen. The hash table deletion is ONLY done through this call when the
1028 * main sessiond thread is torn down.
1031 app
= agent_find_app_by_sock(sock
);
1034 /* RCU read side lock is assumed to be held by this function. */
1035 agent_delete_app(app
);
1037 /* The application is freed in a RCU call but the socket is closed here. */
1038 agent_destroy_app(app
);
1043 * Clean-up the agent app hash table and destroy it.
1045 void agent_app_ht_clean(void)
1047 struct lttng_ht_node_ulong
*node
;
1048 struct lttng_ht_iter iter
;
1050 if (!agent_apps_ht_by_sock
) {
1054 cds_lfht_for_each_entry(agent_apps_ht_by_sock
->ht
, &iter
.iter
, node
, node
) {
1055 struct agent_app
*app
;
1057 app
= caa_container_of(node
, struct agent_app
, node
);
1058 agent_destroy_app_by_sock(app
->sock
->fd
);
1062 lttng_ht_destroy(agent_apps_ht_by_sock
);
1066 * Update a agent application (given socket) using the given agent.
1068 * Note that this function is most likely to be used with a tracing session
1069 * thus the caller should make sure to hold the appropriate lock(s).
1071 void agent_update(struct agent
*agt
, int sock
)
1074 struct agent_app
*app
;
1075 struct agent_event
*event
;
1076 struct lttng_ht_iter iter
;
1081 DBG("Agent updating app socket %d", sock
);
1084 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
1085 /* Skip event if disabled. */
1086 if (!event
->enabled
) {
1090 app
= agent_find_app_by_sock(sock
);
1092 * We are in the registration path thus if the application is gone,
1093 * there is a serious code flow error.
1097 ret
= enable_event(app
, event
);
1098 if (ret
!= LTTNG_OK
) {
1099 DBG2("Agent update unable to enable event %s on app pid: %d sock %d",
1100 event
->name
, app
->pid
, app
->sock
->fd
);
1101 /* Let's try the others here and don't assume the app is dead. */