Return "Unknown" error instead of "Fatal" on unhandled agent replies
[lttng-tools.git] / src / bin / lttng-sessiond / agent.c
1 /*
2 * Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
3 *
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.
7 *
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
11 * more details.
12 *
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.
16 */
17
18 #define _GNU_SOURCE
19 #define _LGPL_SOURCE
20 #include <assert.h>
21 #include <urcu/uatomic.h>
22
23 #include <common/common.h>
24 #include <common/sessiond-comm/agent.h>
25
26 #include <common/compat/endian.h>
27
28 #include "agent.h"
29 #include "ust-app.h"
30 #include "utils.h"
31 #include "error.h"
32
33 #define AGENT_RET_CODE_INDEX(code) (code - AGENT_RET_CODE_SUCCESS)
34
35 /*
36 * Human readable agent return code.
37 */
38 static const char *error_string_array[] = {
39 [ AGENT_RET_CODE_INDEX(AGENT_RET_CODE_SUCCESS) ] = "Success",
40 [ AGENT_RET_CODE_INDEX(AGENT_RET_CODE_INVALID) ] = "Invalid command",
41 [ AGENT_RET_CODE_INDEX(AGENT_RET_CODE_UNKNOWN_NAME) ] = "Unknown logger name",
42
43 /* Last element */
44 [ AGENT_RET_CODE_INDEX(AGENT_RET_CODE_NR) ] = "Unknown code",
45 };
46
47 static
48 void log_reply_code(uint32_t in_reply_ret_code)
49 {
50 int level = PRINT_DBG3;
51 /*
52 * reply_ret_code and in_reply_ret_code are kept separate to have a
53 * sanitized value (used to retrieve the human readable string) and the
54 * original value which is logged as-is.
55 */
56 uint32_t reply_ret_code = in_reply_ret_code;
57
58 if (reply_ret_code < AGENT_RET_CODE_SUCCESS ||
59 reply_ret_code >= AGENT_RET_CODE_NR) {
60 reply_ret_code = AGENT_RET_CODE_NR;
61 level = PRINT_ERR;
62 }
63
64 LOG(level, "Agent replied with retcode: %s (%"PRIu32")",
65 error_string_array[AGENT_RET_CODE_INDEX(
66 reply_ret_code)],
67 in_reply_ret_code);
68 }
69
70 /*
71 * Match function for the events hash table lookup by name.
72 */
73 static int ht_match_event_by_name(struct cds_lfht_node *node,
74 const void *_key)
75 {
76 struct agent_event *event;
77 const struct agent_ht_key *key;
78
79 assert(node);
80 assert(_key);
81
82 event = caa_container_of(node, struct agent_event, node.node);
83 key = _key;
84
85 /* Match 1 elements of the key: name. */
86
87 /* Event name */
88 if (strncmp(event->name, key->name, sizeof(event->name)) != 0) {
89 goto no_match;
90 }
91 /* Match. */
92 return 1;
93
94 no_match:
95 return 0;
96 }
97
98 /*
99 * Match function for the events hash table lookup by name and loglevel.
100 */
101 static int ht_match_event(struct cds_lfht_node *node,
102 const void *_key)
103 {
104 struct agent_event *event;
105 const struct agent_ht_key *key;
106
107 assert(node);
108 assert(_key);
109
110 event = caa_container_of(node, struct agent_event, node.node);
111 key = _key;
112
113 /* Match 2 elements of the key: name and loglevel. */
114
115 /* Event name */
116 if (strncmp(event->name, key->name, sizeof(event->name)) != 0) {
117 goto no_match;
118 }
119
120 if (event->loglevel != key->loglevel) {
121 if (event->loglevel_type == LTTNG_EVENT_LOGLEVEL_ALL &&
122 key->loglevel == 0 && event->loglevel == -1) {
123 goto match;
124 }
125 goto no_match;
126 }
127 match:
128 return 1;
129
130 no_match:
131 return 0;
132 }
133
134 /*
135 * Add unique agent event based on the event name and loglevel.
136 */
137 static void add_unique_agent_event(struct lttng_ht *ht,
138 struct agent_event *event)
139 {
140 struct cds_lfht_node *node_ptr;
141 struct agent_ht_key key;
142
143 assert(ht);
144 assert(ht->ht);
145 assert(event);
146
147 key.name = event->name;
148 key.loglevel = event->loglevel;
149
150 node_ptr = cds_lfht_add_unique(ht->ht,
151 ht->hash_fct(event->node.key, lttng_ht_seed),
152 ht_match_event, &key, &event->node.node);
153 assert(node_ptr == &event->node.node);
154 }
155
156 /*
157 * URCU delayed agent event reclaim.
158 */
159 static void destroy_event_agent_rcu(struct rcu_head *head)
160 {
161 struct lttng_ht_node_str *node =
162 caa_container_of(head, struct lttng_ht_node_str, head);
163 struct agent_event *event =
164 caa_container_of(node, struct agent_event, node);
165
166 free(event);
167 }
168
169 /*
170 * URCU delayed agent app reclaim.
171 */
172 static void destroy_app_agent_rcu(struct rcu_head *head)
173 {
174 struct lttng_ht_node_ulong *node =
175 caa_container_of(head, struct lttng_ht_node_ulong, head);
176 struct agent_app *app =
177 caa_container_of(node, struct agent_app, node);
178
179 free(app);
180 }
181
182 /*
183 * Communication with the agent. Send the message header to the given socket in
184 * big endian.
185 *
186 * Return 0 on success or else a negative errno message of sendmsg() op.
187 */
188 static int send_header(struct lttcomm_sock *sock, uint64_t data_size,
189 uint32_t cmd, uint32_t cmd_version)
190 {
191 int ret;
192 ssize_t size;
193 struct lttcomm_agent_hdr msg;
194
195 assert(sock);
196
197 memset(&msg, 0, sizeof(msg));
198 msg.data_size = htobe64(data_size);
199 msg.cmd = htobe32(cmd);
200 msg.cmd_version = htobe32(cmd_version);
201
202 size = sock->ops->sendmsg(sock, &msg, sizeof(msg), 0);
203 if (size < sizeof(msg)) {
204 ret = -errno;
205 goto error;
206 }
207 ret = 0;
208
209 error:
210 return ret;
211 }
212
213 /*
214 * Communication call with the agent. Send the payload to the given socket. The
215 * header MUST be sent prior to this call.
216 *
217 * Return 0 on success or else a negative errno value of sendmsg() op.
218 */
219 static int send_payload(struct lttcomm_sock *sock, void *data,
220 size_t size)
221 {
222 int ret;
223 ssize_t len;
224
225 assert(sock);
226 assert(data);
227
228 len = sock->ops->sendmsg(sock, data, size, 0);
229 if (len < size) {
230 ret = -errno;
231 goto error;
232 }
233 ret = 0;
234
235 error:
236 return ret;
237 }
238
239 /*
240 * Communication call with the agent. Receive reply from the agent using the
241 * given socket.
242 *
243 * Return 0 on success or else a negative errno value from recvmsg() op.
244 */
245 static int recv_reply(struct lttcomm_sock *sock, void *buf, size_t size)
246 {
247 int ret;
248 ssize_t len;
249
250 assert(sock);
251 assert(buf);
252
253 len = sock->ops->recvmsg(sock, buf, size, 0);
254 if (len < size) {
255 ret = -errno;
256 goto error;
257 }
258 ret = 0;
259
260 error:
261 return ret;
262 }
263
264 /*
265 * Internal event listing for a given app. Populate events.
266 *
267 * Return number of element in the list or else a negative LTTNG_ERR* code.
268 * On success, the caller is responsible for freeing the memory
269 * allocated for "events".
270 */
271 static ssize_t list_events(struct agent_app *app, struct lttng_event **events)
272 {
273 int ret, i, len = 0, offset = 0;
274 uint32_t nb_event;
275 size_t data_size;
276 uint32_t reply_ret_code;
277 struct lttng_event *tmp_events = NULL;
278 struct lttcomm_agent_list_reply *reply = NULL;
279 struct lttcomm_agent_list_reply_hdr reply_hdr;
280
281 assert(app);
282 assert(app->sock);
283 assert(events);
284
285 DBG2("Agent listing events for app pid: %d and socket %d", app->pid,
286 app->sock->fd);
287
288 ret = send_header(app->sock, 0, AGENT_CMD_LIST, 0);
289 if (ret < 0) {
290 goto error_io;
291 }
292
293 /* Get list header so we know how much we'll receive. */
294 ret = recv_reply(app->sock, &reply_hdr, sizeof(reply_hdr));
295 if (ret < 0) {
296 goto error_io;
297 }
298
299 reply_ret_code = be32toh(reply_hdr.ret_code);
300 log_reply_code(reply_ret_code);
301 switch (reply_ret_code) {
302 case AGENT_RET_CODE_SUCCESS:
303 data_size = be32toh(reply_hdr.data_size) + sizeof(*reply);
304 break;
305 default:
306 ret = LTTNG_ERR_UNK;
307 goto error;
308 }
309
310 reply = zmalloc(data_size);
311 if (!reply) {
312 ret = LTTNG_ERR_NOMEM;
313 goto error;
314 }
315
316 /* Get the list with the appropriate data size. */
317 ret = recv_reply(app->sock, reply, data_size);
318 if (ret < 0) {
319 goto error_io;
320 }
321
322 nb_event = be32toh(reply->nb_event);
323 tmp_events = zmalloc(sizeof(*tmp_events) * nb_event);
324 if (!tmp_events) {
325 ret = LTTNG_ERR_NOMEM;
326 goto error;
327 }
328
329 for (i = 0; i < nb_event; i++) {
330 offset += len;
331 strncpy(tmp_events[i].name, reply->payload + offset,
332 sizeof(tmp_events[i].name));
333 tmp_events[i].pid = app->pid;
334 tmp_events[i].enabled = -1;
335 len = strlen(reply->payload + offset) + 1;
336 }
337
338 *events = tmp_events;
339
340 free(reply);
341 return nb_event;
342
343 error_io:
344 ret = LTTNG_ERR_UST_LIST_FAIL;
345 error:
346 free(reply);
347 free(tmp_events);
348 return -ret;
349
350 }
351
352 /*
353 * Internal enable agent event on a agent application. This function
354 * communicates with the agent to enable a given event.
355 *
356 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
357 */
358 static int enable_event(struct agent_app *app, struct agent_event *event)
359 {
360 int ret;
361 uint64_t data_size;
362 uint32_t reply_ret_code;
363 struct lttcomm_agent_enable msg;
364 struct lttcomm_agent_generic_reply reply;
365
366 assert(app);
367 assert(app->sock);
368 assert(event);
369
370 DBG2("Agent enabling event %s for app pid: %d and socket %d", event->name,
371 app->pid, app->sock->fd);
372
373 data_size = sizeof(msg);
374
375 ret = send_header(app->sock, data_size, AGENT_CMD_ENABLE, 0);
376 if (ret < 0) {
377 goto error_io;
378 }
379
380 memset(&msg, 0, sizeof(msg));
381 msg.loglevel = event->loglevel;
382 msg.loglevel_type = event->loglevel_type;
383 strncpy(msg.name, event->name, sizeof(msg.name));
384 ret = send_payload(app->sock, &msg, sizeof(msg));
385 if (ret < 0) {
386 goto error_io;
387 }
388
389 ret = recv_reply(app->sock, &reply, sizeof(reply));
390 if (ret < 0) {
391 goto error_io;
392 }
393
394 reply_ret_code = be32toh(reply.ret_code);
395 log_reply_code(reply_ret_code);
396 switch (reply_ret_code) {
397 case AGENT_RET_CODE_SUCCESS:
398 break;
399 case AGENT_RET_CODE_UNKNOWN_NAME:
400 ret = LTTNG_ERR_UST_EVENT_NOT_FOUND;
401 goto error;
402 default:
403 ret = LTTNG_ERR_UNK;
404 goto error;
405 }
406
407 return LTTNG_OK;
408
409 error_io:
410 ret = LTTNG_ERR_UST_ENABLE_FAIL;
411 error:
412 return ret;
413 }
414
415 /*
416 * Internal disable agent event call on a agent application. This function
417 * communicates with the agent to disable a given event.
418 *
419 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
420 */
421 static int disable_event(struct agent_app *app, struct agent_event *event)
422 {
423 int ret;
424 uint64_t data_size;
425 uint32_t reply_ret_code;
426 struct lttcomm_agent_disable msg;
427 struct lttcomm_agent_generic_reply reply;
428
429 assert(app);
430 assert(app->sock);
431 assert(event);
432
433 DBG2("Agent disabling event %s for app pid: %d and socket %d", event->name,
434 app->pid, app->sock->fd);
435
436 data_size = sizeof(msg);
437
438 ret = send_header(app->sock, data_size, AGENT_CMD_DISABLE, 0);
439 if (ret < 0) {
440 goto error_io;
441 }
442
443 memset(&msg, 0, sizeof(msg));
444 strncpy(msg.name, event->name, sizeof(msg.name));
445 ret = send_payload(app->sock, &msg, sizeof(msg));
446 if (ret < 0) {
447 goto error_io;
448 }
449
450 ret = recv_reply(app->sock, &reply, sizeof(reply));
451 if (ret < 0) {
452 goto error_io;
453 }
454
455 reply_ret_code = be32toh(reply.ret_code);
456 log_reply_code(reply_ret_code);
457 switch (reply_ret_code) {
458 case AGENT_RET_CODE_SUCCESS:
459 break;
460 case AGENT_RET_CODE_UNKNOWN_NAME:
461 ret = LTTNG_ERR_UST_EVENT_NOT_FOUND;
462 goto error;
463 default:
464 ret = LTTNG_ERR_UNK;
465 goto error;
466 }
467
468 return LTTNG_OK;
469
470 error_io:
471 ret = LTTNG_ERR_UST_DISABLE_FAIL;
472 error:
473 return ret;
474 }
475
476 /*
477 * Send back the registration DONE command to a given agent application.
478 *
479 * Return 0 on success or else a negative value.
480 */
481 int agent_send_registration_done(struct agent_app *app)
482 {
483 assert(app);
484 assert(app->sock);
485
486 DBG("Agent sending registration done to app socket %d", app->sock->fd);
487
488 return send_header(app->sock, 0, AGENT_CMD_REG_DONE, 0);
489 }
490
491 /*
492 * Enable agent event on every agent applications registered with the session
493 * daemon.
494 *
495 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
496 */
497 int agent_enable_event(struct agent_event *event,
498 enum lttng_domain_type domain)
499 {
500 int ret;
501 struct agent_app *app;
502 struct lttng_ht_iter iter;
503
504 assert(event);
505
506 rcu_read_lock();
507
508 cds_lfht_for_each_entry(agent_apps_ht_by_sock->ht, &iter.iter, app,
509 node.node) {
510 if (app->domain != domain) {
511 continue;
512 }
513
514 /* Enable event on agent application through TCP socket. */
515 ret = enable_event(app, event);
516 if (ret != LTTNG_OK) {
517 goto error;
518 }
519 }
520
521 event->enabled = 1;
522 ret = LTTNG_OK;
523
524 error:
525 rcu_read_unlock();
526 return ret;
527 }
528
529 /*
530 * Disable agent event on every agent applications registered with the session
531 * daemon.
532 *
533 * Return LTTNG_OK on success or else a LTTNG_ERR* code.
534 */
535 int agent_disable_event(struct agent_event *event,
536 enum lttng_domain_type domain)
537 {
538 int ret = LTTNG_OK;
539 struct agent_app *app;
540 struct lttng_ht_iter iter;
541
542 assert(event);
543 if (!event->enabled) {
544 goto end;
545 }
546
547 rcu_read_lock();
548
549 cds_lfht_for_each_entry(agent_apps_ht_by_sock->ht, &iter.iter, app,
550 node.node) {
551 if (app->domain != domain) {
552 continue;
553 }
554
555 /* Enable event on agent application through TCP socket. */
556 ret = disable_event(app, event);
557 if (ret != LTTNG_OK) {
558 goto error;
559 }
560 }
561
562 event->enabled = 0;
563
564 error:
565 rcu_read_unlock();
566 end:
567 return ret;
568 }
569
570 /*
571 * Ask every agent for the list of possible event. Events is allocated with the
572 * events of every agent application.
573 *
574 * Return the number of events or else a negative value.
575 */
576 int agent_list_events(struct lttng_event **events,
577 enum lttng_domain_type domain)
578 {
579 int ret;
580 size_t nbmem, count = 0;
581 struct agent_app *app;
582 struct lttng_event *tmp_events = NULL;
583 struct lttng_ht_iter iter;
584
585 assert(events);
586
587 DBG2("Agent listing events for domain %d", domain);
588
589 nbmem = UST_APP_EVENT_LIST_SIZE;
590 tmp_events = zmalloc(nbmem * sizeof(*tmp_events));
591 if (!tmp_events) {
592 PERROR("zmalloc agent list events");
593 ret = -ENOMEM;
594 goto error;
595 }
596
597 rcu_read_lock();
598 cds_lfht_for_each_entry(agent_apps_ht_by_sock->ht, &iter.iter, app,
599 node.node) {
600 ssize_t nb_ev;
601 struct lttng_event *agent_events;
602
603 /* Skip domain not asked by the list. */
604 if (app->domain != domain) {
605 continue;
606 }
607
608 nb_ev = list_events(app, &agent_events);
609 if (nb_ev < 0) {
610 ret = nb_ev;
611 goto error_unlock;
612 }
613
614 if (count + nb_ev > nbmem) {
615 /* In case the realloc fails, we free the memory */
616 struct lttng_event *new_tmp_events;
617 size_t new_nbmem;
618
619 new_nbmem = max_t(size_t, count + nb_ev, nbmem << 1);
620 DBG2("Reallocating agent event list from %zu to %zu entries",
621 nbmem, new_nbmem);
622 new_tmp_events = realloc(tmp_events,
623 new_nbmem * sizeof(*new_tmp_events));
624 if (!new_tmp_events) {
625 PERROR("realloc agent events");
626 ret = -ENOMEM;
627 free(agent_events);
628 goto error_unlock;
629 }
630 /* Zero the new memory */
631 memset(new_tmp_events + nbmem, 0,
632 (new_nbmem - nbmem) * sizeof(*new_tmp_events));
633 nbmem = new_nbmem;
634 tmp_events = new_tmp_events;
635 }
636 memcpy(tmp_events + count, agent_events,
637 nb_ev * sizeof(*tmp_events));
638 free(agent_events);
639 count += nb_ev;
640 }
641 rcu_read_unlock();
642
643 ret = count;
644 *events = tmp_events;
645 return ret;
646
647 error_unlock:
648 rcu_read_unlock();
649 error:
650 free(tmp_events);
651 return ret;
652 }
653
654 /*
655 * Create a agent app object using the given PID.
656 *
657 * Return newly allocated object or else NULL on error.
658 */
659 struct agent_app *agent_create_app(pid_t pid, enum lttng_domain_type domain,
660 struct lttcomm_sock *sock)
661 {
662 struct agent_app *app;
663
664 assert(sock);
665
666 app = zmalloc(sizeof(*app));
667 if (!app) {
668 PERROR("zmalloc agent create");
669 goto error;
670 }
671
672 app->pid = pid;
673 app->domain = domain;
674 app->sock = sock;
675 lttng_ht_node_init_ulong(&app->node, (unsigned long) app->sock->fd);
676
677 error:
678 return app;
679 }
680
681 /*
682 * Lookup agent app by socket in the global hash table.
683 *
684 * RCU read side lock MUST be acquired.
685 *
686 * Return object if found else NULL.
687 */
688 struct agent_app *agent_find_app_by_sock(int sock)
689 {
690 struct lttng_ht_node_ulong *node;
691 struct lttng_ht_iter iter;
692 struct agent_app *app;
693
694 assert(sock >= 0);
695
696 lttng_ht_lookup(agent_apps_ht_by_sock, (void *)((unsigned long) sock), &iter);
697 node = lttng_ht_iter_get_node_ulong(&iter);
698 if (node == NULL) {
699 goto error;
700 }
701 app = caa_container_of(node, struct agent_app, node);
702
703 DBG3("Agent app pid %d found by sock %d.", app->pid, sock);
704 return app;
705
706 error:
707 DBG3("Agent app NOT found by sock %d.", sock);
708 return NULL;
709 }
710
711 /*
712 * Add agent application object to the global hash table.
713 */
714 void agent_add_app(struct agent_app *app)
715 {
716 assert(app);
717
718 DBG3("Agent adding app sock: %d and pid: %d to ht", app->sock->fd, app->pid);
719
720 rcu_read_lock();
721 lttng_ht_add_unique_ulong(agent_apps_ht_by_sock, &app->node);
722 rcu_read_unlock();
723 }
724
725 /*
726 * Delete agent application from the global hash table.
727 *
728 * rcu_read_lock() must be held by the caller.
729 */
730 void agent_delete_app(struct agent_app *app)
731 {
732 int ret;
733 struct lttng_ht_iter iter;
734
735 assert(app);
736
737 DBG3("Agent deleting app pid: %d and sock: %d", app->pid, app->sock->fd);
738
739 iter.iter.node = &app->node.node;
740 ret = lttng_ht_del(agent_apps_ht_by_sock, &iter);
741 assert(!ret);
742 }
743
744 /*
745 * Destroy an agent application object by detaching it from its corresponding
746 * UST app if one is connected by closing the socket. Finally, perform a
747 * delayed memory reclaim.
748 */
749 void agent_destroy_app(struct agent_app *app)
750 {
751 assert(app);
752
753 if (app->sock) {
754 app->sock->ops->close(app->sock);
755 lttcomm_destroy_sock(app->sock);
756 }
757
758 call_rcu(&app->node.head, destroy_app_agent_rcu);
759 }
760
761 /*
762 * Initialize an already allocated agent object.
763 *
764 * Return 0 on success or else a negative errno value.
765 */
766 int agent_init(struct agent *agt)
767 {
768 int ret;
769
770 assert(agt);
771
772 agt->events = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
773 if (!agt->events) {
774 ret = -ENOMEM;
775 goto error;
776 }
777 lttng_ht_node_init_u64(&agt->node, agt->domain);
778
779 return 0;
780
781 error:
782 return ret;
783 }
784
785 /*
786 * Add agent object to the given hash table.
787 */
788 void agent_add(struct agent *agt, struct lttng_ht *ht)
789 {
790 assert(agt);
791 assert(ht);
792
793 DBG3("Agent adding from domain %d", agt->domain);
794
795 rcu_read_lock();
796 lttng_ht_add_unique_u64(ht, &agt->node);
797 rcu_read_unlock();
798 }
799
800 /*
801 * Create an agent object for the given domain.
802 *
803 * Return the allocated agent or NULL on error.
804 */
805 struct agent *agent_create(enum lttng_domain_type domain)
806 {
807 int ret;
808 struct agent *agt;
809
810 agt = zmalloc(sizeof(*agt));
811 if (!agt) {
812 goto error;
813 }
814 agt->domain = domain;
815
816 ret = agent_init(agt);
817 if (ret < 0) {
818 free(agt);
819 agt = NULL;
820 goto error;
821 }
822
823 error:
824 return agt;
825 }
826
827 /*
828 * Create a newly allocated agent event data structure. If name is valid, it's
829 * copied into the created event.
830 *
831 * Return a new object else NULL on error.
832 */
833 struct agent_event *agent_create_event(const char *name,
834 struct lttng_filter_bytecode *filter)
835 {
836 struct agent_event *event;
837
838 DBG3("Agent create new event with name %s", name);
839
840 event = zmalloc(sizeof(*event));
841 if (!event) {
842 goto error;
843 }
844
845 if (name) {
846 strncpy(event->name, name, sizeof(event->name));
847 event->name[sizeof(event->name) - 1] = '\0';
848 lttng_ht_node_init_str(&event->node, event->name);
849 }
850
851 if (filter) {
852 event->filter = filter;
853 }
854
855 error:
856 return event;
857 }
858
859 /*
860 * Unique add of a agent event to an agent object.
861 */
862 void agent_add_event(struct agent_event *event, struct agent *agt)
863 {
864 assert(event);
865 assert(agt);
866 assert(agt->events);
867
868 DBG3("Agent adding event %s", event->name);
869
870 rcu_read_lock();
871 add_unique_agent_event(agt->events, event);
872 rcu_read_unlock();
873 agt->being_used = 1;
874 }
875
876 /*
877 * Find a agent event in the given agent using name.
878 *
879 * RCU read side lock MUST be acquired.
880 *
881 * Return object if found else NULL.
882 */
883 struct agent_event *agent_find_event_by_name(const char *name,
884 struct agent *agt)
885 {
886 struct lttng_ht_node_str *node;
887 struct lttng_ht_iter iter;
888 struct lttng_ht *ht;
889 struct agent_ht_key key;
890
891 assert(name);
892 assert(agt);
893 assert(agt->events);
894
895 ht = agt->events;
896 key.name = name;
897
898 cds_lfht_lookup(ht->ht, ht->hash_fct((void *) name, lttng_ht_seed),
899 ht_match_event_by_name, &key, &iter.iter);
900 node = lttng_ht_iter_get_node_str(&iter);
901 if (node == NULL) {
902 goto error;
903 }
904
905 DBG3("Agent event found %s by name.", name);
906 return caa_container_of(node, struct agent_event, node);
907
908 error:
909 DBG3("Agent NOT found by name %s.", name);
910 return NULL;
911 }
912
913 /*
914 * Find a agent event in the given agent using name and loglevel.
915 *
916 * RCU read side lock MUST be acquired.
917 *
918 * Return object if found else NULL.
919 */
920 struct agent_event *agent_find_event(const char *name, int loglevel,
921 struct agent *agt)
922 {
923 struct lttng_ht_node_str *node;
924 struct lttng_ht_iter iter;
925 struct lttng_ht *ht;
926 struct agent_ht_key key;
927
928 assert(name);
929 assert(agt);
930 assert(agt->events);
931
932 ht = agt->events;
933 key.name = name;
934 key.loglevel = loglevel;
935
936 cds_lfht_lookup(ht->ht, ht->hash_fct((void *) name, lttng_ht_seed),
937 ht_match_event, &key, &iter.iter);
938 node = lttng_ht_iter_get_node_str(&iter);
939 if (node == NULL) {
940 goto error;
941 }
942
943 DBG3("Agent event found %s.", name);
944 return caa_container_of(node, struct agent_event, node);
945
946 error:
947 DBG3("Agent event NOT found %s.", name);
948 return NULL;
949 }
950
951 /*
952 * Free given agent event. This event must not be globally visible at this
953 * point (only expected to be used on failure just after event creation). After
954 * this call, the pointer is not usable anymore.
955 */
956 void agent_destroy_event(struct agent_event *event)
957 {
958 assert(event);
959
960 free(event->filter);
961 free(event);
962 }
963
964 /*
965 * Destroy an agent completely. Note that the given pointer is NOT freed
966 * thus a reference to static or stack data can be passed to this function.
967 */
968 void agent_destroy(struct agent *agt)
969 {
970 struct lttng_ht_node_str *node;
971 struct lttng_ht_iter iter;
972
973 assert(agt);
974
975 DBG3("Agent destroy");
976
977 /*
978 * Just ignore if no events hash table exists. This is possible if for
979 * instance an agent object was allocated but not initialized.
980 */
981 if (!agt->events) {
982 return;
983 }
984
985 rcu_read_lock();
986 cds_lfht_for_each_entry(agt->events->ht, &iter.iter, node, node) {
987 int ret;
988 struct agent_event *event;
989
990 /*
991 * When destroying an event, we have to try to disable it on the agent
992 * side so the event stops generating data. The return value is not
993 * important since we have to continue anyway destroying the object.
994 */
995 event = caa_container_of(node, struct agent_event, node);
996 (void) agent_disable_event(event, agt->domain);
997
998 ret = lttng_ht_del(agt->events, &iter);
999 assert(!ret);
1000 call_rcu(&node->head, destroy_event_agent_rcu);
1001 }
1002 rcu_read_unlock();
1003
1004 ht_cleanup_push(agt->events);
1005 }
1006
1007 /*
1008 * Allocate agent_apps_ht_by_sock.
1009 */
1010 int agent_app_ht_alloc(void)
1011 {
1012 int ret = 0;
1013
1014 agent_apps_ht_by_sock = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
1015 if (!agent_apps_ht_by_sock) {
1016 ret = -1;
1017 }
1018
1019 return ret;
1020 }
1021
1022 /*
1023 * Destroy a agent application by socket.
1024 */
1025 void agent_destroy_app_by_sock(int sock)
1026 {
1027 struct agent_app *app;
1028
1029 assert(sock >= 0);
1030
1031 /*
1032 * Not finding an application is a very important error that should NEVER
1033 * happen. The hash table deletion is ONLY done through this call when the
1034 * main sessiond thread is torn down.
1035 */
1036 rcu_read_lock();
1037 app = agent_find_app_by_sock(sock);
1038 assert(app);
1039
1040 /* RCU read side lock is assumed to be held by this function. */
1041 agent_delete_app(app);
1042
1043 /* The application is freed in a RCU call but the socket is closed here. */
1044 agent_destroy_app(app);
1045 rcu_read_unlock();
1046 }
1047
1048 /*
1049 * Clean-up the agent app hash table and destroy it.
1050 */
1051 void agent_app_ht_clean(void)
1052 {
1053 struct lttng_ht_node_ulong *node;
1054 struct lttng_ht_iter iter;
1055
1056 if (!agent_apps_ht_by_sock) {
1057 return;
1058 }
1059 rcu_read_lock();
1060 cds_lfht_for_each_entry(agent_apps_ht_by_sock->ht, &iter.iter, node, node) {
1061 struct agent_app *app;
1062
1063 app = caa_container_of(node, struct agent_app, node);
1064 agent_destroy_app_by_sock(app->sock->fd);
1065 }
1066 rcu_read_unlock();
1067
1068 lttng_ht_destroy(agent_apps_ht_by_sock);
1069 }
1070
1071 /*
1072 * Update a agent application (given socket) using the given agent.
1073 *
1074 * Note that this function is most likely to be used with a tracing session
1075 * thus the caller should make sure to hold the appropriate lock(s).
1076 */
1077 void agent_update(struct agent *agt, int sock)
1078 {
1079 int ret;
1080 struct agent_app *app;
1081 struct agent_event *event;
1082 struct lttng_ht_iter iter;
1083
1084 assert(agt);
1085 assert(sock >= 0);
1086
1087 DBG("Agent updating app socket %d", sock);
1088
1089 rcu_read_lock();
1090 cds_lfht_for_each_entry(agt->events->ht, &iter.iter, event, node.node) {
1091 /* Skip event if disabled. */
1092 if (!event->enabled) {
1093 continue;
1094 }
1095
1096 app = agent_find_app_by_sock(sock);
1097 /*
1098 * We are in the registration path thus if the application is gone,
1099 * there is a serious code flow error.
1100 */
1101 assert(app);
1102
1103 ret = enable_event(app, event);
1104 if (ret != LTTNG_OK) {
1105 DBG2("Agent update unable to enable event %s on app pid: %d sock %d",
1106 event->name, app->pid, app->sock->fd);
1107 /* Let's try the others here and don't assume the app is dead. */
1108 continue;
1109 }
1110 }
1111 rcu_read_unlock();
1112 }
This page took 0.087232 seconds and 4 git commands to generate.