2 * Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License, version 2 only, as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 51
16 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include <urcu/uatomic.h>
22 #include <urcu/rculist.h>
24 #include <common/common.h>
25 #include <common/sessiond-comm/agent.h>
27 #include <common/compat/endian.h>
34 #define AGENT_RET_CODE_INDEX(code) (code - AGENT_RET_CODE_SUCCESS)
37 * Agent application context representation.
39 struct agent_app_ctx
{
43 /* agent_app_ctx are part of the agent app_ctx_list. */
44 struct cds_list_head list_node
;
46 /* For call_rcu teardown. */
47 struct rcu_head rcu_node
;
51 * Human readable agent return code.
53 static const char *error_string_array
[] = {
54 [ AGENT_RET_CODE_INDEX(AGENT_RET_CODE_SUCCESS
) ] = "Success",
55 [ AGENT_RET_CODE_INDEX(AGENT_RET_CODE_INVALID
) ] = "Invalid command",
56 [ AGENT_RET_CODE_INDEX(AGENT_RET_CODE_UNKNOWN_NAME
) ] = "Unknown logger name",
59 [ AGENT_RET_CODE_INDEX(AGENT_RET_CODE_NR
) ] = "Unknown code",
63 void log_reply_code(uint32_t in_reply_ret_code
)
65 int level
= PRINT_DBG3
;
67 * reply_ret_code and in_reply_ret_code are kept separate to have a
68 * sanitized value (used to retrieve the human readable string) and the
69 * original value which is logged as-is.
71 uint32_t reply_ret_code
= in_reply_ret_code
;
73 if (reply_ret_code
< AGENT_RET_CODE_SUCCESS
||
74 reply_ret_code
>= AGENT_RET_CODE_NR
) {
75 reply_ret_code
= AGENT_RET_CODE_NR
;
79 LOG(level
, "Agent replied with retcode: %s (%"PRIu32
")",
80 error_string_array
[AGENT_RET_CODE_INDEX(
86 * Match function for the events hash table lookup by name.
88 static int ht_match_event_by_name(struct cds_lfht_node
*node
,
91 struct agent_event
*event
;
92 const struct agent_ht_key
*key
;
97 event
= caa_container_of(node
, struct agent_event
, node
.node
);
100 /* Match 1 elements of the key: name. */
103 if (strncmp(event
->name
, key
->name
, sizeof(event
->name
)) != 0) {
114 * Match function for the events hash table lookup by name and loglevel.
116 static int ht_match_event(struct cds_lfht_node
*node
,
119 struct agent_event
*event
;
120 const struct agent_ht_key
*key
;
126 event
= caa_container_of(node
, struct agent_event
, node
.node
);
129 /* Match 2 elements of the key: name and loglevel. */
132 if (strncmp(event
->name
, key
->name
, sizeof(event
->name
)) != 0) {
136 /* Event loglevel value and type. */
137 ll_match
= loglevels_match(event
->loglevel_type
,
138 event
->loglevel_value
, key
->loglevel_type
,
139 key
->loglevel_value
, LTTNG_EVENT_LOGLEVEL_ALL
);
145 /* Filter expression */
146 if (strncmp(event
->filter_expression
, key
->filter_expression
,
147 strlen(event
->filter_expression
)) != 0) {
158 * Add unique agent event based on the event name and loglevel.
160 static void add_unique_agent_event(struct lttng_ht
*ht
,
161 struct agent_event
*event
)
163 struct cds_lfht_node
*node_ptr
;
164 struct agent_ht_key key
;
170 key
.name
= event
->name
;
171 key
.loglevel_value
= event
->loglevel_value
;
172 key
.loglevel_type
= event
->loglevel_type
;
173 key
.filter_expression
= event
->filter_expression
;
175 node_ptr
= cds_lfht_add_unique(ht
->ht
,
176 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
177 ht_match_event
, &key
, &event
->node
.node
);
178 assert(node_ptr
== &event
->node
.node
);
182 * URCU delayed agent event reclaim.
184 static void destroy_event_agent_rcu(struct rcu_head
*head
)
186 struct lttng_ht_node_str
*node
=
187 caa_container_of(head
, struct lttng_ht_node_str
, head
);
188 struct agent_event
*event
=
189 caa_container_of(node
, struct agent_event
, node
);
191 agent_destroy_event(event
);
195 * URCU delayed agent app reclaim.
197 static void destroy_app_agent_rcu(struct rcu_head
*head
)
199 struct lttng_ht_node_ulong
*node
=
200 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
201 struct agent_app
*app
=
202 caa_container_of(node
, struct agent_app
, node
);
208 * Communication with the agent. Send the message header to the given socket in
211 * Return 0 on success or else a negative errno message of sendmsg() op.
213 static int send_header(struct lttcomm_sock
*sock
, uint64_t data_size
,
214 uint32_t cmd
, uint32_t cmd_version
)
218 struct lttcomm_agent_hdr msg
;
222 memset(&msg
, 0, sizeof(msg
));
223 msg
.data_size
= htobe64(data_size
);
224 msg
.cmd
= htobe32(cmd
);
225 msg
.cmd_version
= htobe32(cmd_version
);
227 size
= sock
->ops
->sendmsg(sock
, &msg
, sizeof(msg
), 0);
228 if (size
< sizeof(msg
)) {
239 * Communication call with the agent. Send the payload to the given socket. The
240 * header MUST be sent prior to this call.
242 * Return 0 on success or else a negative errno value of sendmsg() op.
244 static int send_payload(struct lttcomm_sock
*sock
, const void *data
,
253 len
= sock
->ops
->sendmsg(sock
, data
, size
, 0);
265 * Communication call with the agent. Receive reply from the agent using the
268 * Return 0 on success or else a negative errno value from recvmsg() op.
270 static int recv_reply(struct lttcomm_sock
*sock
, void *buf
, size_t size
)
278 len
= sock
->ops
->recvmsg(sock
, buf
, size
, 0);
290 * Internal event listing for a given app. Populate events.
292 * Return number of element in the list or else a negative LTTNG_ERR* code.
293 * On success, the caller is responsible for freeing the memory
294 * allocated for "events".
296 static ssize_t
list_events(struct agent_app
*app
, struct lttng_event
**events
)
298 int ret
, i
, len
= 0, offset
= 0;
301 uint32_t reply_ret_code
;
302 struct lttng_event
*tmp_events
= NULL
;
303 struct lttcomm_agent_list_reply
*reply
= NULL
;
304 struct lttcomm_agent_list_reply_hdr reply_hdr
;
310 DBG2("Agent listing events for app pid: %d and socket %d", app
->pid
,
313 ret
= send_header(app
->sock
, 0, AGENT_CMD_LIST
, 0);
318 /* Get list header so we know how much we'll receive. */
319 ret
= recv_reply(app
->sock
, &reply_hdr
, sizeof(reply_hdr
));
324 reply_ret_code
= be32toh(reply_hdr
.ret_code
);
325 log_reply_code(reply_ret_code
);
326 switch (reply_ret_code
) {
327 case AGENT_RET_CODE_SUCCESS
:
328 data_size
= be32toh(reply_hdr
.data_size
) + sizeof(*reply
);
335 reply
= zmalloc(data_size
);
337 ret
= LTTNG_ERR_NOMEM
;
341 /* Get the list with the appropriate data size. */
342 ret
= recv_reply(app
->sock
, reply
, data_size
);
347 nb_event
= be32toh(reply
->nb_event
);
348 tmp_events
= zmalloc(sizeof(*tmp_events
) * nb_event
);
350 ret
= LTTNG_ERR_NOMEM
;
354 for (i
= 0; i
< nb_event
; i
++) {
356 if (lttng_strncpy(tmp_events
[i
].name
, reply
->payload
+ offset
,
357 sizeof(tmp_events
[i
].name
))) {
358 ret
= LTTNG_ERR_INVALID
;
361 tmp_events
[i
].pid
= app
->pid
;
362 tmp_events
[i
].enabled
= -1;
363 len
= strlen(reply
->payload
+ offset
) + 1;
366 *events
= tmp_events
;
372 ret
= LTTNG_ERR_UST_LIST_FAIL
;
381 * Internal enable agent event on a agent application. This function
382 * communicates with the agent to enable a given event.
384 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
386 static int enable_event(struct agent_app
*app
, struct agent_event
*event
)
391 size_t filter_expression_length
;
392 uint32_t reply_ret_code
;
393 struct lttcomm_agent_enable_event msg
;
394 struct lttcomm_agent_generic_reply reply
;
400 DBG2("Agent enabling event %s for app pid: %d and socket %d", event
->name
,
401 app
->pid
, app
->sock
->fd
);
404 * Calculate the payload's size, which is the fixed-size struct followed
405 * by the variable-length filter expression (+1 for the ending \0).
407 if (!event
->filter_expression
) {
408 filter_expression_length
= 0;
410 filter_expression_length
= strlen(event
->filter_expression
) + 1;
412 data_size
= sizeof(msg
) + filter_expression_length
;
414 memset(&msg
, 0, sizeof(msg
));
415 msg
.loglevel_value
= htobe32(event
->loglevel_value
);
416 msg
.loglevel_type
= htobe32(event
->loglevel_type
);
417 if (lttng_strncpy(msg
.name
, event
->name
, sizeof(msg
.name
))) {
418 ret
= LTTNG_ERR_INVALID
;
421 msg
.filter_expression_length
= htobe32(filter_expression_length
);
423 ret
= send_header(app
->sock
, data_size
, AGENT_CMD_ENABLE
, 0);
428 bytes_to_send
= zmalloc(data_size
);
429 if (!bytes_to_send
) {
430 ret
= LTTNG_ERR_NOMEM
;
434 memcpy(bytes_to_send
, &msg
, sizeof(msg
));
435 if (filter_expression_length
> 0) {
436 memcpy(bytes_to_send
+ sizeof(msg
), event
->filter_expression
,
437 filter_expression_length
);
440 ret
= send_payload(app
->sock
, bytes_to_send
, data_size
);
446 ret
= recv_reply(app
->sock
, &reply
, sizeof(reply
));
451 reply_ret_code
= be32toh(reply
.ret_code
);
452 log_reply_code(reply_ret_code
);
453 switch (reply_ret_code
) {
454 case AGENT_RET_CODE_SUCCESS
:
456 case AGENT_RET_CODE_UNKNOWN_NAME
:
457 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
467 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
473 * Send Pascal-style string. Size is sent as a 32-bit big endian integer.
476 int send_pstring(struct lttcomm_sock
*sock
, const char *str
, uint32_t len
)
481 len_be
= htobe32(len
);
482 ret
= send_payload(sock
, &len_be
, sizeof(len_be
));
487 ret
= send_payload(sock
, str
, len
);
496 * Internal enable application context on an agent application. This function
497 * communicates with the agent to enable a given application context.
499 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
501 static int app_context_op(struct agent_app
*app
,
502 struct agent_app_ctx
*ctx
, enum lttcomm_agent_command cmd
)
505 uint32_t reply_ret_code
;
506 struct lttcomm_agent_generic_reply reply
;
507 size_t app_ctx_provider_name_len
, app_ctx_name_len
, data_size
;
512 assert(cmd
== AGENT_CMD_APP_CTX_ENABLE
||
513 cmd
== AGENT_CMD_APP_CTX_DISABLE
);
515 DBG2("Agent %s application %s:%s for app pid: %d and socket %d",
516 cmd
== AGENT_CMD_APP_CTX_ENABLE
? "enabling" : "disabling",
517 ctx
->provider_name
, ctx
->ctx_name
,
518 app
->pid
, app
->sock
->fd
);
521 * Calculate the payload's size, which consists of the size (u32, BE)
522 * of the provider name, the NULL-terminated provider name string, the
523 * size (u32, BE) of the context name, followed by the NULL-terminated
524 * context name string.
526 app_ctx_provider_name_len
= strlen(ctx
->provider_name
) + 1;
527 app_ctx_name_len
= strlen(ctx
->ctx_name
) + 1;
528 data_size
= sizeof(uint32_t) + app_ctx_provider_name_len
+
529 sizeof(uint32_t) + app_ctx_name_len
;
531 ret
= send_header(app
->sock
, data_size
, cmd
, 0);
536 if (app_ctx_provider_name_len
> UINT32_MAX
||
537 app_ctx_name_len
> UINT32_MAX
) {
538 ERR("Application context name > MAX_UINT32");
539 ret
= LTTNG_ERR_INVALID
;
543 ret
= send_pstring(app
->sock
, ctx
->provider_name
,
544 (uint32_t) app_ctx_provider_name_len
);
549 ret
= send_pstring(app
->sock
, ctx
->ctx_name
,
550 (uint32_t) app_ctx_name_len
);
555 ret
= recv_reply(app
->sock
, &reply
, sizeof(reply
));
560 reply_ret_code
= be32toh(reply
.ret_code
);
561 log_reply_code(reply_ret_code
);
562 switch (reply_ret_code
) {
563 case AGENT_RET_CODE_SUCCESS
:
573 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
579 * Internal disable agent event call on a agent application. This function
580 * communicates with the agent to disable a given event.
582 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
584 static int disable_event(struct agent_app
*app
, struct agent_event
*event
)
588 uint32_t reply_ret_code
;
589 struct lttcomm_agent_disable_event msg
;
590 struct lttcomm_agent_generic_reply reply
;
596 DBG2("Agent disabling event %s for app pid: %d and socket %d", event
->name
,
597 app
->pid
, app
->sock
->fd
);
599 data_size
= sizeof(msg
);
600 memset(&msg
, 0, sizeof(msg
));
601 if (lttng_strncpy(msg
.name
, event
->name
, sizeof(msg
.name
))) {
602 ret
= LTTNG_ERR_INVALID
;
606 ret
= send_header(app
->sock
, data_size
, AGENT_CMD_DISABLE
, 0);
611 ret
= send_payload(app
->sock
, &msg
, sizeof(msg
));
616 ret
= recv_reply(app
->sock
, &reply
, sizeof(reply
));
621 reply_ret_code
= be32toh(reply
.ret_code
);
622 log_reply_code(reply_ret_code
);
623 switch (reply_ret_code
) {
624 case AGENT_RET_CODE_SUCCESS
:
626 case AGENT_RET_CODE_UNKNOWN_NAME
:
627 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
637 ret
= LTTNG_ERR_UST_DISABLE_FAIL
;
643 * Send back the registration DONE command to a given agent application.
645 * Return 0 on success or else a negative value.
647 int agent_send_registration_done(struct agent_app
*app
)
652 DBG("Agent sending registration done to app socket %d", app
->sock
->fd
);
654 return send_header(app
->sock
, 0, AGENT_CMD_REG_DONE
, 0);
658 * Enable agent event on every agent applications registered with the session
661 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
663 int agent_enable_event(struct agent_event
*event
,
664 enum lttng_domain_type domain
)
667 struct agent_app
*app
;
668 struct lttng_ht_iter iter
;
674 cds_lfht_for_each_entry(agent_apps_ht_by_sock
->ht
, &iter
.iter
, app
,
676 if (app
->domain
!= domain
) {
680 /* Enable event on agent application through TCP socket. */
681 ret
= enable_event(app
, event
);
682 if (ret
!= LTTNG_OK
) {
696 void destroy_app_ctx(struct agent_app_ctx
*ctx
)
698 free(ctx
->provider_name
);
704 struct agent_app_ctx
*create_app_ctx(struct lttng_event_context
*ctx
)
706 struct agent_app_ctx
*agent_ctx
= NULL
;
712 assert(ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
);
713 agent_ctx
= zmalloc(sizeof(*ctx
));
718 agent_ctx
->provider_name
= strdup(ctx
->u
.app_ctx
.provider_name
);
719 agent_ctx
->ctx_name
= strdup(ctx
->u
.app_ctx
.ctx_name
);
720 if (!agent_ctx
->provider_name
|| !agent_ctx
->ctx_name
) {
721 destroy_app_ctx(agent_ctx
);
729 * Enable agent context on every agent applications registered with the session
732 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
734 int agent_enable_context(struct lttng_event_context
*ctx
,
735 enum lttng_domain_type domain
)
738 struct agent_app
*app
;
739 struct lttng_ht_iter iter
;
742 if (ctx
->ctx
!= LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
743 ret
= LTTNG_ERR_INVALID
;
749 cds_lfht_for_each_entry(agent_apps_ht_by_sock
->ht
, &iter
.iter
, app
,
751 struct agent_app_ctx
*agent_ctx
;
753 if (app
->domain
!= domain
) {
757 agent_ctx
= create_app_ctx(ctx
);
759 ret
= LTTNG_ERR_NOMEM
;
763 /* Enable event on agent application through TCP socket. */
764 ret
= app_context_op(app
, agent_ctx
, AGENT_CMD_APP_CTX_ENABLE
);
765 destroy_app_ctx(agent_ctx
);
766 if (ret
!= LTTNG_OK
) {
780 * Disable agent event on every agent application registered with the session
783 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
785 int agent_disable_event(struct agent_event
*event
,
786 enum lttng_domain_type domain
)
789 struct agent_app
*app
;
790 struct lttng_ht_iter iter
;
793 if (!event
->enabled
) {
799 cds_lfht_for_each_entry(agent_apps_ht_by_sock
->ht
, &iter
.iter
, app
,
801 if (app
->domain
!= domain
) {
805 /* Enable event on agent application through TCP socket. */
806 ret
= disable_event(app
, event
);
807 if (ret
!= LTTNG_OK
) {
821 * Disable agent context on every agent application registered with the session
824 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
826 int disable_context(struct agent_app_ctx
*ctx
, enum lttng_domain_type domain
)
829 struct agent_app
*app
;
830 struct lttng_ht_iter iter
;
835 DBG2("Disabling agent application context %s:%s",
836 ctx
->provider_name
, ctx
->ctx_name
);
837 cds_lfht_for_each_entry(agent_apps_ht_by_sock
->ht
, &iter
.iter
, app
,
839 if (app
->domain
!= domain
) {
843 ret
= app_context_op(app
, ctx
, AGENT_CMD_APP_CTX_DISABLE
);
844 if (ret
!= LTTNG_OK
) {
854 * Ask every agent for the list of possible event. Events is allocated with the
855 * events of every agent application.
857 * Return the number of events or else a negative value.
859 int agent_list_events(struct lttng_event
**events
,
860 enum lttng_domain_type domain
)
863 size_t nbmem
, count
= 0;
864 struct agent_app
*app
;
865 struct lttng_event
*tmp_events
= NULL
;
866 struct lttng_ht_iter iter
;
870 DBG2("Agent listing events for domain %d", domain
);
872 nbmem
= UST_APP_EVENT_LIST_SIZE
;
873 tmp_events
= zmalloc(nbmem
* sizeof(*tmp_events
));
875 PERROR("zmalloc agent list events");
881 cds_lfht_for_each_entry(agent_apps_ht_by_sock
->ht
, &iter
.iter
, app
,
884 struct lttng_event
*agent_events
;
886 /* Skip domain not asked by the list. */
887 if (app
->domain
!= domain
) {
891 nb_ev
= list_events(app
, &agent_events
);
897 if (count
+ nb_ev
> nbmem
) {
898 /* In case the realloc fails, we free the memory */
899 struct lttng_event
*new_tmp_events
;
902 new_nbmem
= max_t(size_t, count
+ nb_ev
, nbmem
<< 1);
903 DBG2("Reallocating agent event list from %zu to %zu entries",
905 new_tmp_events
= realloc(tmp_events
,
906 new_nbmem
* sizeof(*new_tmp_events
));
907 if (!new_tmp_events
) {
908 PERROR("realloc agent events");
913 /* Zero the new memory */
914 memset(new_tmp_events
+ nbmem
, 0,
915 (new_nbmem
- nbmem
) * sizeof(*new_tmp_events
));
917 tmp_events
= new_tmp_events
;
919 memcpy(tmp_events
+ count
, agent_events
,
920 nb_ev
* sizeof(*tmp_events
));
927 *events
= tmp_events
;
938 * Create a agent app object using the given PID.
940 * Return newly allocated object or else NULL on error.
942 struct agent_app
*agent_create_app(pid_t pid
, enum lttng_domain_type domain
,
943 struct lttcomm_sock
*sock
)
945 struct agent_app
*app
;
949 app
= zmalloc(sizeof(*app
));
951 PERROR("zmalloc agent create");
956 app
->domain
= domain
;
958 lttng_ht_node_init_ulong(&app
->node
, (unsigned long) app
->sock
->fd
);
965 * Lookup agent app by socket in the global hash table.
967 * RCU read side lock MUST be acquired.
969 * Return object if found else NULL.
971 struct agent_app
*agent_find_app_by_sock(int sock
)
973 struct lttng_ht_node_ulong
*node
;
974 struct lttng_ht_iter iter
;
975 struct agent_app
*app
;
979 lttng_ht_lookup(agent_apps_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
980 node
= lttng_ht_iter_get_node_ulong(&iter
);
984 app
= caa_container_of(node
, struct agent_app
, node
);
986 DBG3("Agent app pid %d found by sock %d.", app
->pid
, sock
);
990 DBG3("Agent app NOT found by sock %d.", sock
);
995 * Add agent application object to the global hash table.
997 void agent_add_app(struct agent_app
*app
)
1001 DBG3("Agent adding app sock: %d and pid: %d to ht", app
->sock
->fd
, app
->pid
);
1002 lttng_ht_add_unique_ulong(agent_apps_ht_by_sock
, &app
->node
);
1006 * Delete agent application from the global hash table.
1008 * rcu_read_lock() must be held by the caller.
1010 void agent_delete_app(struct agent_app
*app
)
1013 struct lttng_ht_iter iter
;
1017 DBG3("Agent deleting app pid: %d and sock: %d", app
->pid
, app
->sock
->fd
);
1019 iter
.iter
.node
= &app
->node
.node
;
1020 ret
= lttng_ht_del(agent_apps_ht_by_sock
, &iter
);
1025 * Destroy an agent application object by detaching it from its corresponding
1026 * UST app if one is connected by closing the socket. Finally, perform a
1027 * delayed memory reclaim.
1029 void agent_destroy_app(struct agent_app
*app
)
1034 app
->sock
->ops
->close(app
->sock
);
1035 lttcomm_destroy_sock(app
->sock
);
1038 call_rcu(&app
->node
.head
, destroy_app_agent_rcu
);
1042 * Initialize an already allocated agent object.
1044 * Return 0 on success or else a negative errno value.
1046 int agent_init(struct agent
*agt
)
1052 agt
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1057 lttng_ht_node_init_u64(&agt
->node
, agt
->domain
);
1059 CDS_INIT_LIST_HEAD(&agt
->app_ctx_list
);
1067 * Add agent object to the given hash table.
1069 void agent_add(struct agent
*agt
, struct lttng_ht
*ht
)
1074 DBG3("Agent adding from domain %d", agt
->domain
);
1076 lttng_ht_add_unique_u64(ht
, &agt
->node
);
1080 * Create an agent object for the given domain.
1082 * Return the allocated agent or NULL on error.
1084 struct agent
*agent_create(enum lttng_domain_type domain
)
1089 agt
= zmalloc(sizeof(struct agent
));
1093 agt
->domain
= domain
;
1095 ret
= agent_init(agt
);
1107 * Create a newly allocated agent event data structure.
1108 * Ownership of filter_expression is taken.
1110 * Return a new object else NULL on error.
1112 struct agent_event
*agent_create_event(const char *name
,
1113 enum lttng_loglevel_type loglevel_type
, int loglevel_value
,
1114 struct lttng_filter_bytecode
*filter
, char *filter_expression
)
1116 struct agent_event
*event
= NULL
;
1118 DBG3("Agent create new event with name %s, loglevel type %d, \
1119 loglevel value %d and filter %s",
1120 name
, loglevel_type
, loglevel_value
,
1121 filter_expression
? filter_expression
: "NULL");
1124 ERR("Failed to create agent event; no name provided.");
1128 event
= zmalloc(sizeof(*event
));
1133 strncpy(event
->name
, name
, sizeof(event
->name
));
1134 event
->name
[sizeof(event
->name
) - 1] = '\0';
1135 lttng_ht_node_init_str(&event
->node
, event
->name
);
1137 event
->loglevel_value
= loglevel_value
;
1138 event
->loglevel_type
= loglevel_type
;
1139 event
->filter
= filter
;
1140 event
->filter_expression
= filter_expression
;
1146 * Unique add of a agent event to an agent object.
1148 void agent_add_event(struct agent_event
*event
, struct agent
*agt
)
1152 assert(agt
->events
);
1154 DBG3("Agent adding event %s", event
->name
);
1155 add_unique_agent_event(agt
->events
, event
);
1156 agt
->being_used
= 1;
1160 * Unique add of a agent context to an agent object.
1162 int agent_add_context(struct lttng_event_context
*ctx
, struct agent
*agt
)
1165 struct agent_app_ctx
*agent_ctx
= NULL
;
1169 assert(agt
->events
);
1170 assert(ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
);
1172 agent_ctx
= create_app_ctx(ctx
);
1174 ret
= LTTNG_ERR_NOMEM
;
1178 DBG3("Agent adding context %s:%s", ctx
->u
.app_ctx
.provider_name
,
1179 ctx
->u
.app_ctx
.ctx_name
);
1180 cds_list_add_tail_rcu(&agent_ctx
->list_node
, &agt
->app_ctx_list
);
1186 * Find multiple agent events sharing the given name.
1188 * RCU read side lock MUST be acquired. It must be held for the
1189 * duration of the iteration.
1191 * Sets the given iterator.
1193 void agent_find_events_by_name(const char *name
, struct agent
*agt
,
1194 struct lttng_ht_iter
* iter
)
1196 struct lttng_ht
*ht
;
1197 struct agent_ht_key key
;
1201 assert(agt
->events
);
1207 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1208 ht_match_event_by_name
, &key
, &iter
->iter
);
1212 * Get the next agent event duplicate by name. This should be called
1213 * after a call to agent_find_events_by_name() to iterate on events.
1215 * The RCU read lock must be held during the iteration and for as long
1216 * as the object the iterator points to remains in use.
1218 void agent_event_next_duplicate(const char *name
,
1219 struct agent
*agt
, struct lttng_ht_iter
* iter
)
1221 struct agent_ht_key key
;
1225 cds_lfht_next_duplicate(agt
->events
->ht
, ht_match_event_by_name
,
1230 * Find a agent event in the given agent using name, loglevel and filter.
1232 * RCU read side lock MUST be acquired. It must be kept for as long as
1233 * the returned agent_event is used.
1235 * Return object if found else NULL.
1237 struct agent_event
*agent_find_event(const char *name
,
1238 enum lttng_loglevel_type loglevel_type
, int loglevel_value
,
1239 char *filter_expression
, struct agent
*agt
)
1241 struct lttng_ht_node_str
*node
;
1242 struct lttng_ht_iter iter
;
1243 struct lttng_ht
*ht
;
1244 struct agent_ht_key key
;
1248 assert(agt
->events
);
1252 key
.loglevel_value
= loglevel_value
;
1253 key
.loglevel_type
= loglevel_type
;
1254 key
.filter_expression
= filter_expression
;
1256 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1257 ht_match_event
, &key
, &iter
.iter
);
1258 node
= lttng_ht_iter_get_node_str(&iter
);
1263 DBG3("Agent event found %s.", name
);
1264 return caa_container_of(node
, struct agent_event
, node
);
1267 DBG3("Agent event NOT found %s.", name
);
1272 * Free given agent event. This event must not be globally visible at this
1273 * point (only expected to be used on failure just after event creation). After
1274 * this call, the pointer is not usable anymore.
1276 void agent_destroy_event(struct agent_event
*event
)
1280 free(event
->filter
);
1281 free(event
->filter_expression
);
1282 free(event
->exclusion
);
1287 void destroy_app_ctx_rcu(struct rcu_head
*head
)
1289 struct agent_app_ctx
*ctx
=
1290 caa_container_of(head
, struct agent_app_ctx
, rcu_node
);
1292 destroy_app_ctx(ctx
);
1296 * Destroy an agent completely.
1298 void agent_destroy(struct agent
*agt
)
1300 struct lttng_ht_node_str
*node
;
1301 struct lttng_ht_iter iter
;
1302 struct agent_app_ctx
*ctx
;
1306 DBG3("Agent destroy");
1309 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, node
, node
) {
1311 struct agent_event
*event
;
1314 * When destroying an event, we have to try to disable it on the
1315 * agent side so the event stops generating data. The return
1316 * value is not important since we have to continue anyway
1317 * destroying the object.
1319 event
= caa_container_of(node
, struct agent_event
, node
);
1320 (void) agent_disable_event(event
, agt
->domain
);
1322 ret
= lttng_ht_del(agt
->events
, &iter
);
1324 call_rcu(&node
->head
, destroy_event_agent_rcu
);
1327 cds_list_for_each_entry_rcu(ctx
, &agt
->app_ctx_list
, list_node
) {
1328 (void) disable_context(ctx
, agt
->domain
);
1329 cds_list_del(&ctx
->list_node
);
1330 call_rcu(&ctx
->rcu_node
, destroy_app_ctx_rcu
);
1333 ht_cleanup_push(agt
->events
);
1338 * Allocate agent_apps_ht_by_sock.
1340 int agent_app_ht_alloc(void)
1344 agent_apps_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1345 if (!agent_apps_ht_by_sock
) {
1353 * Destroy a agent application by socket.
1355 void agent_destroy_app_by_sock(int sock
)
1357 struct agent_app
*app
;
1362 * Not finding an application is a very important error that should NEVER
1363 * happen. The hash table deletion is ONLY done through this call when the
1364 * main sessiond thread is torn down.
1367 app
= agent_find_app_by_sock(sock
);
1370 /* RCU read side lock is assumed to be held by this function. */
1371 agent_delete_app(app
);
1373 /* The application is freed in a RCU call but the socket is closed here. */
1374 agent_destroy_app(app
);
1379 * Clean-up the agent app hash table and destroy it.
1381 void agent_app_ht_clean(void)
1383 struct lttng_ht_node_ulong
*node
;
1384 struct lttng_ht_iter iter
;
1386 if (!agent_apps_ht_by_sock
) {
1390 cds_lfht_for_each_entry(agent_apps_ht_by_sock
->ht
, &iter
.iter
, node
, node
) {
1391 struct agent_app
*app
;
1393 app
= caa_container_of(node
, struct agent_app
, node
);
1394 agent_destroy_app_by_sock(app
->sock
->fd
);
1398 lttng_ht_destroy(agent_apps_ht_by_sock
);
1402 * Update a agent application (given socket) using the given agent.
1404 * Note that this function is most likely to be used with a tracing session
1405 * thus the caller should make sure to hold the appropriate lock(s).
1407 void agent_update(struct agent
*agt
, int sock
)
1410 struct agent_app
*app
;
1411 struct agent_event
*event
;
1412 struct lttng_ht_iter iter
;
1413 struct agent_app_ctx
*ctx
;
1418 DBG("Agent updating app socket %d", sock
);
1421 app
= agent_find_app_by_sock(sock
);
1423 * We are in the registration path thus if the application is gone,
1424 * there is a serious code flow error.
1427 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
1428 /* Skip event if disabled. */
1429 if (!event
->enabled
) {
1433 ret
= enable_event(app
, event
);
1434 if (ret
!= LTTNG_OK
) {
1435 DBG2("Agent update unable to enable event %s on app pid: %d sock %d",
1436 event
->name
, app
->pid
, app
->sock
->fd
);
1437 /* Let's try the others here and don't assume the app is dead. */
1442 cds_list_for_each_entry_rcu(ctx
, &agt
->app_ctx_list
, list_node
) {
1443 ret
= app_context_op(app
, ctx
, AGENT_CMD_APP_CTX_ENABLE
);
1444 if (ret
!= LTTNG_OK
) {
1445 DBG2("Agent update unable to add application context %s:%s on app pid: %d sock %d",
1446 ctx
->provider_name
, ctx
->ctx_name
,
1447 app
->pid
, app
->sock
->fd
);