fix: relayd: unaligned access in trace_chunk_registry_ht_key_hash
[lttng-tools.git] / src / bin / lttng-sessiond / client.cpp
1 /*
2 * Copyright (C) 2011 EfficiOS Inc.
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2013 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 *
6 * SPDX-License-Identifier: GPL-2.0-only
7 *
8 */
9
10 #include "agent-thread.hpp"
11 #include "clear.hpp"
12 #include "client.hpp"
13 #include "cmd.hpp"
14 #include "common/buffer-view.hpp"
15 #include "common/compat/socket.hpp"
16 #include "common/dynamic-array.hpp"
17 #include "common/dynamic-buffer.hpp"
18 #include "common/fd-handle.hpp"
19 #include "common/payload-view.hpp"
20 #include "common/payload.hpp"
21 #include "common/sessiond-comm/sessiond-comm.hpp"
22 #include "health-sessiond.hpp"
23 #include "kernel.hpp"
24 #include "lttng-sessiond.hpp"
25 #include "lttng/lttng-error.h"
26 #include "lttng/tracker.h"
27 #include "manage-consumer.hpp"
28 #include "save.hpp"
29 #include "testpoint.hpp"
30 #include "utils.hpp"
31
32 #include <common/compat/getenv.hpp>
33 #include <common/exception.hpp>
34 #include <common/tracker.hpp>
35 #include <common/unix.hpp>
36 #include <common/utils.hpp>
37
38 #include <lttng/error-query-internal.hpp>
39 #include <lttng/event-internal.hpp>
40 #include <lttng/session-descriptor-internal.hpp>
41 #include <lttng/session-internal.hpp>
42 #include <lttng/userspace-probe-internal.hpp>
43
44 #include <fcntl.h>
45 #include <pthread.h>
46 #include <signal.h>
47 #include <stddef.h>
48 #include <stdint.h>
49 #include <sys/stat.h>
50 #include <unistd.h>
51
52 namespace {
53 bool is_root;
54
55 struct thread_state {
56 sem_t ready;
57 bool running;
58 int client_sock;
59 } thread_state;
60 } /* namespace */
61
62 static void set_thread_status(bool running)
63 {
64 DBG("Marking client thread's state as %s", running ? "running" : "error");
65 thread_state.running = running;
66 sem_post(&thread_state.ready);
67 }
68
69 static bool wait_thread_status()
70 {
71 DBG("Waiting for client thread to be ready");
72 sem_wait(&thread_state.ready);
73 if (thread_state.running) {
74 DBG("Client thread is ready");
75 } else {
76 ERR("Initialization of client thread failed");
77 }
78
79 return thread_state.running;
80 }
81
82 /*
83 * Setup the outgoing data buffer for the response (llm) by allocating the
84 * right amount of memory and copying the original information from the lsm
85 * structure.
86 *
87 * Return 0 on success, negative value on error.
88 */
89 static int setup_lttng_msg(struct command_ctx *cmd_ctx,
90 const void *payload_buf,
91 size_t payload_len,
92 const void *cmd_header_buf,
93 size_t cmd_header_len)
94 {
95 int ret = 0;
96 const size_t header_len = sizeof(struct lttcomm_lttng_msg);
97 const size_t total_msg_size = header_len + cmd_header_len + payload_len;
98 lttcomm_lttng_msg llm{};
99
100 llm.cmd_type = cmd_ctx->lsm.cmd_type;
101 llm.pid = (uint32_t) cmd_ctx->lsm.domain.attr.pid;
102 llm.cmd_header_size = (uint32_t) cmd_header_len;
103 llm.data_size = (uint32_t) payload_len;
104
105 ret = lttng_dynamic_buffer_set_size(&cmd_ctx->reply_payload.buffer, 0);
106 if (ret) {
107 goto end;
108 }
109
110 lttng_dynamic_pointer_array_clear(&cmd_ctx->reply_payload._fd_handles);
111
112 cmd_ctx->lttng_msg_size = total_msg_size;
113
114 /* Append reply header. */
115 ret = lttng_dynamic_buffer_append(&cmd_ctx->reply_payload.buffer, &llm, sizeof(llm));
116 if (ret) {
117 goto end;
118 }
119
120 /* Append command header. */
121 if (cmd_header_len) {
122 ret = lttng_dynamic_buffer_append(
123 &cmd_ctx->reply_payload.buffer, cmd_header_buf, cmd_header_len);
124 if (ret) {
125 goto end;
126 }
127 }
128
129 /* Append payload. */
130 if (payload_len) {
131 ret = lttng_dynamic_buffer_append(
132 &cmd_ctx->reply_payload.buffer, payload_buf, payload_len);
133 if (ret) {
134 goto end;
135 }
136 }
137
138 end:
139 return ret;
140 }
141
142 static int setup_empty_lttng_msg(struct command_ctx *cmd_ctx)
143 {
144 int ret;
145 const struct lttcomm_lttng_msg llm = {};
146
147 ret = lttng_dynamic_buffer_set_size(&cmd_ctx->reply_payload.buffer, 0);
148 if (ret) {
149 goto end;
150 }
151
152 /* Append place-holder reply header. */
153 ret = lttng_dynamic_buffer_append(&cmd_ctx->reply_payload.buffer, &llm, sizeof(llm));
154 if (ret) {
155 goto end;
156 }
157
158 cmd_ctx->lttng_msg_size = sizeof(llm);
159 end:
160 return ret;
161 }
162
163 static void update_lttng_msg(struct command_ctx *cmd_ctx, size_t cmd_header_len, size_t payload_len)
164 {
165 const size_t header_len = sizeof(struct lttcomm_lttng_msg);
166 const size_t total_msg_size = header_len + cmd_header_len + payload_len;
167 struct lttcomm_lttng_msg *p_llm;
168 lttcomm_lttng_msg llm{};
169
170 llm.cmd_type = cmd_ctx->lsm.cmd_type;
171 llm.pid = (uint32_t) cmd_ctx->lsm.domain.attr.pid;
172 llm.cmd_header_size = (uint32_t) cmd_header_len;
173 llm.data_size = (uint32_t) payload_len;
174
175 LTTNG_ASSERT(cmd_ctx->reply_payload.buffer.size >= sizeof(llm));
176
177 p_llm = (typeof(p_llm)) cmd_ctx->reply_payload.buffer.data;
178
179 /* Update existing header. */
180 memcpy(p_llm, &llm, sizeof(llm));
181
182 cmd_ctx->lttng_msg_size = total_msg_size;
183 }
184
185 /*
186 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
187 * exec or it will fail.
188 */
189 static int spawn_consumer_thread(struct consumer_data *consumer_data)
190 {
191 return launch_consumer_management_thread(consumer_data) ? 0 : -1;
192 }
193
194 /*
195 * Fork and exec a consumer daemon (consumerd).
196 *
197 * Return pid if successful else -1.
198 */
199 static pid_t spawn_consumerd(struct consumer_data *consumer_data)
200 {
201 int ret;
202 pid_t pid;
203 const char *consumer_to_use;
204 const char *verbosity;
205 struct stat st;
206
207 DBG("Spawning consumerd");
208
209 pid = fork();
210 if (pid == 0) {
211 /*
212 * Exec consumerd.
213 */
214 if (the_config.verbose_consumer) {
215 verbosity = "--verbose";
216 } else if (lttng_opt_quiet) {
217 verbosity = "--quiet";
218 } else {
219 verbosity = "";
220 }
221
222 switch (consumer_data->type) {
223 case LTTNG_CONSUMER_KERNEL:
224 /*
225 * Find out which consumerd to execute. We will first try the
226 * 64-bit path, then the sessiond's installation directory, and
227 * fallback on the 32-bit one,
228 */
229 DBG3("Looking for a kernel consumer at these locations:");
230 DBG3(" 1) %s", the_config.consumerd64_bin_path.value ?: "NULL");
231 DBG3(" 2) %s/%s", INSTALL_BIN_PATH, DEFAULT_CONSUMERD_FILE);
232 DBG3(" 3) %s", the_config.consumerd32_bin_path.value ?: "NULL");
233 if (stat(the_config.consumerd64_bin_path.value, &st) == 0) {
234 DBG3("Found location #1");
235 consumer_to_use = the_config.consumerd64_bin_path.value;
236 } else if (stat(INSTALL_BIN_PATH "/" DEFAULT_CONSUMERD_FILE, &st) == 0) {
237 DBG3("Found location #2");
238 consumer_to_use = INSTALL_BIN_PATH "/" DEFAULT_CONSUMERD_FILE;
239 } else if (the_config.consumerd32_bin_path.value &&
240 stat(the_config.consumerd32_bin_path.value, &st) == 0) {
241 DBG3("Found location #3");
242 consumer_to_use = the_config.consumerd32_bin_path.value;
243 } else {
244 DBG("Could not find any valid consumerd executable");
245 ret = -EINVAL;
246 goto error;
247 }
248 DBG("Using kernel consumer at: %s", consumer_to_use);
249 (void) execl(consumer_to_use,
250 "lttng-consumerd",
251 verbosity,
252 "-k",
253 "--consumerd-cmd-sock",
254 consumer_data->cmd_unix_sock_path,
255 "--consumerd-err-sock",
256 consumer_data->err_unix_sock_path,
257 "--group",
258 the_config.tracing_group_name.value,
259 NULL);
260 break;
261 case LTTNG_CONSUMER64_UST:
262 {
263 if (the_config.consumerd64_lib_dir.value) {
264 const char *tmp;
265 size_t tmplen;
266 char *tmpnew;
267
268 tmp = lttng_secure_getenv("LD_LIBRARY_PATH");
269 if (!tmp) {
270 tmp = "";
271 }
272 tmplen = strlen(the_config.consumerd64_lib_dir.value) + 1 /* : */ +
273 strlen(tmp);
274 tmpnew = zmalloc<char>(tmplen + 1 /* \0 */);
275 if (!tmpnew) {
276 ret = -ENOMEM;
277 goto error;
278 }
279 strcat(tmpnew, the_config.consumerd64_lib_dir.value);
280 if (tmp[0] != '\0') {
281 strcat(tmpnew, ":");
282 strcat(tmpnew, tmp);
283 }
284 ret = setenv("LD_LIBRARY_PATH", tmpnew, 1);
285 free(tmpnew);
286 if (ret) {
287 ret = -errno;
288 goto error;
289 }
290 }
291 DBG("Using 64-bit UST consumer at: %s",
292 the_config.consumerd64_bin_path.value);
293 (void) execl(the_config.consumerd64_bin_path.value,
294 "lttng-consumerd",
295 verbosity,
296 "-u",
297 "--consumerd-cmd-sock",
298 consumer_data->cmd_unix_sock_path,
299 "--consumerd-err-sock",
300 consumer_data->err_unix_sock_path,
301 "--group",
302 the_config.tracing_group_name.value,
303 NULL);
304 break;
305 }
306 case LTTNG_CONSUMER32_UST:
307 {
308 if (the_config.consumerd32_lib_dir.value) {
309 const char *tmp;
310 size_t tmplen;
311 char *tmpnew;
312
313 tmp = lttng_secure_getenv("LD_LIBRARY_PATH");
314 if (!tmp) {
315 tmp = "";
316 }
317 tmplen = strlen(the_config.consumerd32_lib_dir.value) + 1 /* : */ +
318 strlen(tmp);
319 tmpnew = zmalloc<char>(tmplen + 1 /* \0 */);
320 if (!tmpnew) {
321 ret = -ENOMEM;
322 goto error;
323 }
324 strcat(tmpnew, the_config.consumerd32_lib_dir.value);
325 if (tmp[0] != '\0') {
326 strcat(tmpnew, ":");
327 strcat(tmpnew, tmp);
328 }
329 ret = setenv("LD_LIBRARY_PATH", tmpnew, 1);
330 free(tmpnew);
331 if (ret) {
332 ret = -errno;
333 goto error;
334 }
335 }
336 DBG("Using 32-bit UST consumer at: %s",
337 the_config.consumerd32_bin_path.value);
338 (void) execl(the_config.consumerd32_bin_path.value,
339 "lttng-consumerd",
340 verbosity,
341 "-u",
342 "--consumerd-cmd-sock",
343 consumer_data->cmd_unix_sock_path,
344 "--consumerd-err-sock",
345 consumer_data->err_unix_sock_path,
346 "--group",
347 the_config.tracing_group_name.value,
348 NULL);
349 break;
350 }
351 default:
352 ERR("unknown consumer type");
353 errno = 0;
354 }
355 if (errno != 0) {
356 PERROR("Consumer execl()");
357 }
358 /* Reaching this point, we got a failure on our execl(). */
359 exit(EXIT_FAILURE);
360 } else if (pid > 0) {
361 ret = pid;
362 } else {
363 PERROR("start consumer fork");
364 ret = -errno;
365 }
366 error:
367 return ret;
368 }
369
370 /*
371 * Spawn the consumerd daemon and session daemon thread.
372 */
373 static int start_consumerd(struct consumer_data *consumer_data)
374 {
375 int ret;
376
377 /*
378 * Set the listen() state on the socket since there is a possible race
379 * between the exec() of the consumer daemon and this call if place in the
380 * consumer thread. See bug #366 for more details.
381 */
382 ret = lttcomm_listen_unix_sock(consumer_data->err_sock);
383 if (ret < 0) {
384 goto error;
385 }
386
387 pthread_mutex_lock(&consumer_data->pid_mutex);
388 if (consumer_data->pid != 0) {
389 pthread_mutex_unlock(&consumer_data->pid_mutex);
390 goto end;
391 }
392
393 ret = spawn_consumerd(consumer_data);
394 if (ret < 0) {
395 ERR("Spawning consumerd failed");
396 pthread_mutex_unlock(&consumer_data->pid_mutex);
397 goto error;
398 }
399
400 /* Setting up the consumer_data pid */
401 consumer_data->pid = ret;
402 DBG2("Consumer pid %d", consumer_data->pid);
403 pthread_mutex_unlock(&consumer_data->pid_mutex);
404
405 DBG2("Spawning consumer control thread");
406 ret = spawn_consumer_thread(consumer_data);
407 if (ret < 0) {
408 ERR("Fatal error spawning consumer control thread");
409 goto error;
410 }
411
412 end:
413 return 0;
414
415 error:
416 /* Cleanup already created sockets on error. */
417 if (consumer_data->err_sock >= 0) {
418 int err;
419
420 err = close(consumer_data->err_sock);
421 if (err < 0) {
422 PERROR("close consumer data error socket");
423 }
424 }
425 return ret;
426 }
427
428 /*
429 * Copy consumer output from the tracing session to the domain session. The
430 * function also applies the right modification on a per domain basis for the
431 * trace files destination directory.
432 */
433 static int copy_session_consumer(int domain, struct ltt_session *session)
434 {
435 int ret;
436 const char *dir_name;
437 struct consumer_output *consumer;
438
439 LTTNG_ASSERT(session);
440 LTTNG_ASSERT(session->consumer);
441
442 switch (domain) {
443 case LTTNG_DOMAIN_KERNEL:
444 DBG3("Copying tracing session consumer output in kernel session");
445 /*
446 * XXX: We should audit the session creation and what this function
447 * does "extra" in order to avoid a destroy since this function is used
448 * in the domain session creation (kernel and ust) only. Same for UST
449 * domain.
450 */
451 if (session->kernel_session->consumer) {
452 consumer_output_put(session->kernel_session->consumer);
453 }
454 session->kernel_session->consumer = consumer_copy_output(session->consumer);
455 /* Ease our life a bit for the next part */
456 consumer = session->kernel_session->consumer;
457 dir_name = DEFAULT_KERNEL_TRACE_DIR;
458 break;
459 case LTTNG_DOMAIN_JUL:
460 case LTTNG_DOMAIN_LOG4J:
461 case LTTNG_DOMAIN_PYTHON:
462 case LTTNG_DOMAIN_UST:
463 DBG3("Copying tracing session consumer output in UST session");
464 if (session->ust_session->consumer) {
465 consumer_output_put(session->ust_session->consumer);
466 }
467 session->ust_session->consumer = consumer_copy_output(session->consumer);
468 /* Ease our life a bit for the next part */
469 consumer = session->ust_session->consumer;
470 dir_name = DEFAULT_UST_TRACE_DIR;
471 break;
472 default:
473 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
474 goto error;
475 }
476
477 /* Append correct directory to subdir */
478 ret = lttng_strncpy(consumer->domain_subdir, dir_name, sizeof(consumer->domain_subdir));
479 if (ret) {
480 ret = LTTNG_ERR_UNK;
481 goto error;
482 }
483 DBG3("Copy session consumer subdir %s", consumer->domain_subdir);
484 ret = LTTNG_OK;
485
486 error:
487 return ret;
488 }
489
490 /*
491 * Create an UST session and add it to the session ust list.
492 */
493 static int create_ust_session(struct ltt_session *session, const struct lttng_domain *domain)
494 {
495 int ret;
496 struct ltt_ust_session *lus = nullptr;
497
498 LTTNG_ASSERT(session);
499 LTTNG_ASSERT(domain);
500 LTTNG_ASSERT(session->consumer);
501
502 switch (domain->type) {
503 case LTTNG_DOMAIN_JUL:
504 case LTTNG_DOMAIN_LOG4J:
505 case LTTNG_DOMAIN_PYTHON:
506 case LTTNG_DOMAIN_UST:
507 break;
508 default:
509 ERR("Unknown UST domain on create session %d", domain->type);
510 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
511 goto error;
512 }
513
514 DBG("Creating UST session");
515
516 lus = trace_ust_create_session(session->id);
517 if (lus == nullptr) {
518 ret = LTTNG_ERR_UST_SESS_FAIL;
519 goto error;
520 }
521
522 lus->uid = session->uid;
523 lus->gid = session->gid;
524 lus->output_traces = session->output_traces;
525 lus->snapshot_mode = session->snapshot_mode;
526 lus->live_timer_interval = session->live_timer;
527 session->ust_session = lus;
528 if (session->shm_path[0]) {
529 strncpy(lus->root_shm_path, session->shm_path, sizeof(lus->root_shm_path));
530 lus->root_shm_path[sizeof(lus->root_shm_path) - 1] = '\0';
531 strncpy(lus->shm_path, session->shm_path, sizeof(lus->shm_path));
532 lus->shm_path[sizeof(lus->shm_path) - 1] = '\0';
533 strncat(lus->shm_path, "/ust", sizeof(lus->shm_path) - strlen(lus->shm_path) - 1);
534 }
535 /* Copy session output to the newly created UST session */
536 ret = copy_session_consumer(domain->type, session);
537 if (ret != LTTNG_OK) {
538 goto error;
539 }
540
541 return LTTNG_OK;
542
543 error:
544 free(lus);
545 session->ust_session = nullptr;
546 return ret;
547 }
548
549 /*
550 * Create a kernel tracer session then create the default channel.
551 */
552 static int create_kernel_session(struct ltt_session *session)
553 {
554 int ret;
555
556 DBG("Creating kernel session");
557
558 ret = kernel_create_session(session);
559 if (ret < 0) {
560 ret = LTTNG_ERR_KERN_SESS_FAIL;
561 goto error_create;
562 }
563
564 /* Code flow safety */
565 LTTNG_ASSERT(session->kernel_session);
566
567 /* Copy session output to the newly created Kernel session */
568 ret = copy_session_consumer(LTTNG_DOMAIN_KERNEL, session);
569 if (ret != LTTNG_OK) {
570 goto error;
571 }
572
573 session->kernel_session->uid = session->uid;
574 session->kernel_session->gid = session->gid;
575 session->kernel_session->output_traces = session->output_traces;
576 session->kernel_session->snapshot_mode = session->snapshot_mode;
577 session->kernel_session->is_live_session = session->live_timer != 0;
578
579 return LTTNG_OK;
580
581 error:
582 trace_kernel_destroy_session(session->kernel_session);
583 session->kernel_session = nullptr;
584 error_create:
585 return ret;
586 }
587
588 /*
589 * Count number of session permitted by uid/gid.
590 */
591 static unsigned int lttng_sessions_count(uid_t uid, gid_t gid __attribute__((unused)))
592 {
593 unsigned int i = 0;
594 struct ltt_session *session;
595 const struct ltt_session_list *session_list = session_get_list();
596
597 DBG("Counting number of available session for UID %d", uid);
598 cds_list_for_each_entry (session, &session_list->head, list) {
599 if (!session_get(session)) {
600 continue;
601 }
602 session_lock(session);
603 /* Only count the sessions the user can control. */
604 if (session_access_ok(session, uid) && !session->destroyed) {
605 i++;
606 }
607 session_unlock(session);
608 session_put(session);
609 }
610 return i;
611 }
612
613 static enum lttng_error_code receive_lttng_trigger(struct command_ctx *cmd_ctx,
614 int sock,
615 int *sock_error,
616 struct lttng_trigger **_trigger)
617 {
618 int ret;
619 size_t trigger_len;
620 ssize_t sock_recv_len;
621 enum lttng_error_code ret_code;
622 struct lttng_payload trigger_payload;
623 struct lttng_trigger *trigger = nullptr;
624
625 lttng_payload_init(&trigger_payload);
626 trigger_len = (size_t) cmd_ctx->lsm.u.trigger.length;
627 ret = lttng_dynamic_buffer_set_size(&trigger_payload.buffer, trigger_len);
628 if (ret) {
629 ret_code = LTTNG_ERR_NOMEM;
630 goto end;
631 }
632
633 sock_recv_len = lttcomm_recv_unix_sock(sock, trigger_payload.buffer.data, trigger_len);
634 if (sock_recv_len < 0 || sock_recv_len != trigger_len) {
635 ERR("Failed to receive trigger in command payload");
636 *sock_error = 1;
637 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
638 goto end;
639 }
640
641 /* Receive fds, if any. */
642 if (cmd_ctx->lsm.fd_count > 0) {
643 sock_recv_len = lttcomm_recv_payload_fds_unix_sock(
644 sock, cmd_ctx->lsm.fd_count, &trigger_payload);
645 if (sock_recv_len > 0 && sock_recv_len != cmd_ctx->lsm.fd_count * sizeof(int)) {
646 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
647 cmd_ctx->lsm.fd_count,
648 (int) ret);
649 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
650 *sock_error = 1;
651 goto end;
652 } else if (sock_recv_len <= 0) {
653 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
654 cmd_ctx->lsm.fd_count,
655 (int) ret);
656 ret_code = LTTNG_ERR_FATAL;
657 *sock_error = 1;
658 goto end;
659 }
660 }
661
662 /* Deserialize trigger. */
663 {
664 struct lttng_payload_view view =
665 lttng_payload_view_from_payload(&trigger_payload, 0, -1);
666
667 if (lttng_trigger_create_from_payload(&view, &trigger) != trigger_len) {
668 ERR("Invalid trigger received as part of command payload");
669 ret_code = LTTNG_ERR_INVALID_TRIGGER;
670 lttng_trigger_put(trigger);
671 goto end;
672 }
673 }
674
675 *_trigger = trigger;
676 ret_code = LTTNG_OK;
677
678 end:
679 lttng_payload_reset(&trigger_payload);
680 return ret_code;
681 }
682
683 static enum lttng_error_code receive_lttng_error_query(struct command_ctx *cmd_ctx,
684 int sock,
685 int *sock_error,
686 struct lttng_error_query **_query)
687 {
688 int ret;
689 size_t query_len;
690 ssize_t sock_recv_len;
691 enum lttng_error_code ret_code;
692 struct lttng_payload query_payload;
693 struct lttng_error_query *query = nullptr;
694
695 lttng_payload_init(&query_payload);
696 query_len = (size_t) cmd_ctx->lsm.u.error_query.length;
697 ret = lttng_dynamic_buffer_set_size(&query_payload.buffer, query_len);
698 if (ret) {
699 ret_code = LTTNG_ERR_NOMEM;
700 goto end;
701 }
702
703 sock_recv_len = lttcomm_recv_unix_sock(sock, query_payload.buffer.data, query_len);
704 if (sock_recv_len < 0 || sock_recv_len != query_len) {
705 ERR("Failed to receive error query in command payload");
706 *sock_error = 1;
707 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
708 goto end;
709 }
710
711 /* Receive fds, if any. */
712 if (cmd_ctx->lsm.fd_count > 0) {
713 sock_recv_len = lttcomm_recv_payload_fds_unix_sock(
714 sock, cmd_ctx->lsm.fd_count, &query_payload);
715 if (sock_recv_len > 0 && sock_recv_len != cmd_ctx->lsm.fd_count * sizeof(int)) {
716 ERR("Failed to receive all file descriptors for error query in command payload: expected fd count = %u, ret = %d",
717 cmd_ctx->lsm.fd_count,
718 (int) ret);
719 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
720 *sock_error = 1;
721 goto end;
722 } else if (sock_recv_len <= 0) {
723 ERR("Failed to receive file descriptors for error query in command payload: expected fd count = %u, ret = %d",
724 cmd_ctx->lsm.fd_count,
725 (int) ret);
726 ret_code = LTTNG_ERR_FATAL;
727 *sock_error = 1;
728 goto end;
729 }
730 }
731
732 /* Deserialize error query. */
733 {
734 struct lttng_payload_view view =
735 lttng_payload_view_from_payload(&query_payload, 0, -1);
736
737 if (lttng_error_query_create_from_payload(&view, &query) != query_len) {
738 ERR("Invalid error query received as part of command payload");
739 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
740 goto end;
741 }
742 }
743
744 *_query = query;
745 ret_code = LTTNG_OK;
746
747 end:
748 lttng_payload_reset(&query_payload);
749 return ret_code;
750 }
751
752 static enum lttng_error_code receive_lttng_event(struct command_ctx *cmd_ctx,
753 int sock,
754 int *sock_error,
755 struct lttng_event **out_event,
756 char **out_filter_expression,
757 struct lttng_bytecode **out_bytecode,
758 struct lttng_event_exclusion **out_exclusion)
759 {
760 int ret;
761 size_t event_len;
762 ssize_t sock_recv_len;
763 enum lttng_error_code ret_code;
764 struct lttng_payload event_payload;
765 struct lttng_event *local_event = nullptr;
766 char *local_filter_expression = nullptr;
767 struct lttng_bytecode *local_bytecode = nullptr;
768 struct lttng_event_exclusion *local_exclusion = nullptr;
769
770 lttng_payload_init(&event_payload);
771 if (cmd_ctx->lsm.cmd_type == LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT) {
772 event_len = (size_t) cmd_ctx->lsm.u.enable.length;
773 } else if (cmd_ctx->lsm.cmd_type == LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT) {
774 event_len = (size_t) cmd_ctx->lsm.u.disable.length;
775 } else {
776 abort();
777 }
778
779 ret = lttng_dynamic_buffer_set_size(&event_payload.buffer, event_len);
780 if (ret) {
781 ret_code = LTTNG_ERR_NOMEM;
782 goto end;
783 }
784
785 sock_recv_len = lttcomm_recv_unix_sock(sock, event_payload.buffer.data, event_len);
786 if (sock_recv_len < 0 || sock_recv_len != event_len) {
787 ERR("Failed to receive event in command payload");
788 *sock_error = 1;
789 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
790 goto end;
791 }
792
793 /* Receive fds, if any. */
794 if (cmd_ctx->lsm.fd_count > 0) {
795 sock_recv_len = lttcomm_recv_payload_fds_unix_sock(
796 sock, cmd_ctx->lsm.fd_count, &event_payload);
797 if (sock_recv_len > 0 && sock_recv_len != cmd_ctx->lsm.fd_count * sizeof(int)) {
798 ERR("Failed to receive all file descriptors for event in command payload: expected fd count = %u, ret = %d",
799 cmd_ctx->lsm.fd_count,
800 (int) ret);
801 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
802 *sock_error = 1;
803 goto end;
804 } else if (sock_recv_len <= 0) {
805 ERR("Failed to receive file descriptors for event in command payload: expected fd count = %u, ret = %d",
806 cmd_ctx->lsm.fd_count,
807 (int) ret);
808 ret_code = LTTNG_ERR_FATAL;
809 *sock_error = 1;
810 goto end;
811 }
812 }
813
814 /* Deserialize event. */
815 {
816 ssize_t len;
817 struct lttng_payload_view event_view =
818 lttng_payload_view_from_payload(&event_payload, 0, -1);
819
820 len = lttng_event_create_from_payload(&event_view,
821 &local_event,
822 &local_exclusion,
823 &local_filter_expression,
824 &local_bytecode);
825
826 if (len < 0) {
827 ERR("Failed to create an event from the received buffer");
828 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
829 goto end;
830 }
831
832 if (len != event_len) {
833 ERR("Userspace probe location from the received buffer is not the advertised length: header length = %zu" PRIu32
834 ", payload length = %zd",
835 event_len,
836 len);
837 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
838 goto end;
839 }
840 }
841
842 *out_event = local_event;
843 *out_exclusion = local_exclusion;
844 *out_filter_expression = local_filter_expression;
845 *out_bytecode = local_bytecode;
846 local_event = nullptr;
847 local_exclusion = nullptr;
848 local_filter_expression = nullptr;
849 local_bytecode = nullptr;
850
851 ret_code = LTTNG_OK;
852
853 end:
854 lttng_payload_reset(&event_payload);
855 lttng_event_destroy(local_event);
856 free(local_filter_expression);
857 free(local_bytecode);
858 free(local_exclusion);
859 return ret_code;
860 }
861
862 static enum lttng_error_code
863 receive_lttng_event_context(const struct command_ctx *cmd_ctx,
864 int sock,
865 int *sock_error,
866 struct lttng_event_context **out_event_context)
867 {
868 int ret;
869 const size_t event_context_len = (size_t) cmd_ctx->lsm.u.context.length;
870 ssize_t sock_recv_len;
871 enum lttng_error_code ret_code;
872 struct lttng_payload event_context_payload;
873 struct lttng_event_context *context = nullptr;
874
875 lttng_payload_init(&event_context_payload);
876
877 ret = lttng_dynamic_buffer_set_size(&event_context_payload.buffer, event_context_len);
878 if (ret) {
879 ret_code = LTTNG_ERR_NOMEM;
880 goto end;
881 }
882
883 sock_recv_len =
884 lttcomm_recv_unix_sock(sock, event_context_payload.buffer.data, event_context_len);
885 if (sock_recv_len < 0 || sock_recv_len != event_context_len) {
886 ERR("Failed to receive event context in command payload");
887 *sock_error = 1;
888 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
889 goto end;
890 }
891
892 /* Deserialize event. */
893 {
894 ssize_t len;
895 struct lttng_payload_view event_context_view =
896 lttng_payload_view_from_payload(&event_context_payload, 0, -1);
897
898 len = lttng_event_context_create_from_payload(&event_context_view, &context);
899
900 if (len < 0) {
901 ERR("Failed to create a event context from the received buffer");
902 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
903 goto end;
904 }
905
906 if (len != event_context_len) {
907 ERR("Event context from the received buffer is not the advertised length: expected length = %zu, payload length = %zd",
908 event_context_len,
909 len);
910 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
911 goto end;
912 }
913 }
914
915 *out_event_context = context;
916 context = nullptr;
917 ret_code = LTTNG_OK;
918
919 end:
920 lttng_event_context_destroy(context);
921 lttng_payload_reset(&event_context_payload);
922 return ret_code;
923 }
924
925 /*
926 * Version of setup_lttng_msg() without command header.
927 */
928 static int
929 setup_lttng_msg_no_cmd_header(struct command_ctx *cmd_ctx, void *payload_buf, size_t payload_len)
930 {
931 return setup_lttng_msg(cmd_ctx, payload_buf, payload_len, nullptr, 0);
932 }
933
934 /*
935 * Check if the current kernel tracer supports the session rotation feature.
936 * Return 1 if it does, 0 otherwise.
937 */
938 static int check_rotate_compatible()
939 {
940 int ret = 1;
941
942 if (the_kernel_tracer_version.major != 2 || the_kernel_tracer_version.minor < 11) {
943 DBG("Kernel tracer version is not compatible with the rotation feature");
944 ret = 0;
945 }
946
947 return ret;
948 }
949
950 /*
951 * Send data on a unix socket using the liblttsessiondcomm API.
952 *
953 * Return lttcomm error code.
954 */
955 static int send_unix_sock(int sock, struct lttng_payload_view *view)
956 {
957 int ret;
958 const int fd_count = lttng_payload_view_get_fd_handle_count(view);
959
960 /* Check valid length */
961 if (view->buffer.size == 0) {
962 ret = -1;
963 goto end;
964 }
965
966 ret = lttcomm_send_unix_sock(sock, view->buffer.data, view->buffer.size);
967 if (ret < 0) {
968 goto end;
969 }
970
971 if (fd_count > 0) {
972 ret = lttcomm_send_payload_view_fds_unix_sock(sock, view);
973 if (ret < 0) {
974 goto end;
975 }
976 }
977
978 end:
979 return ret;
980 }
981
982 /*
983 * Process the command requested by the lttng client within the command
984 * context structure. This function make sure that the return structure (llm)
985 * is set and ready for transmission before returning.
986 *
987 * Return any error encountered or 0 for success.
988 *
989 * "sock" is only used for special-case var. len data.
990 * A command may assume the ownership of the socket, in which case its value
991 * should be set to -1.
992 */
993 static int process_client_msg(struct command_ctx *cmd_ctx, int *sock, int *sock_error)
994 {
995 int ret = LTTNG_OK;
996 bool need_tracing_session = true;
997 bool need_domain;
998 bool need_consumerd;
999
1000 if (!lttcomm_sessiond_command_is_valid((lttcomm_sessiond_command) cmd_ctx->lsm.cmd_type)) {
1001 ERR("Unknown client command received: command id = %" PRIu32,
1002 cmd_ctx->lsm.cmd_type);
1003 ret = LTTNG_ERR_UND;
1004 goto error;
1005 }
1006
1007 DBG("Processing client command '%s\' (%d)",
1008 lttcomm_sessiond_command_str((lttcomm_sessiond_command) cmd_ctx->lsm.cmd_type),
1009 cmd_ctx->lsm.cmd_type);
1010
1011 *sock_error = 0;
1012
1013 switch (cmd_ctx->lsm.cmd_type) {
1014 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT:
1015 case LTTCOMM_SESSIOND_COMMAND_DESTROY_SESSION:
1016 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS:
1017 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS:
1018 case LTTCOMM_SESSIOND_COMMAND_START_TRACE:
1019 case LTTCOMM_SESSIOND_COMMAND_STOP_TRACE:
1020 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING:
1021 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_ADD_OUTPUT:
1022 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_DEL_OUTPUT:
1023 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_LIST_OUTPUT:
1024 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_RECORD:
1025 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION:
1026 case LTTCOMM_SESSIOND_COMMAND_SET_SESSION_SHM_PATH:
1027 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_METADATA:
1028 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_STATEDUMP:
1029 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION:
1030 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO:
1031 case LTTCOMM_SESSIOND_COMMAND_ROTATION_SET_SCHEDULE:
1032 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES:
1033 case LTTCOMM_SESSIOND_COMMAND_CLEAR_SESSION:
1034 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS:
1035 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY:
1036 case LTTCOMM_SESSIOND_COMMAND_KERNEL_TRACER_STATUS:
1037 need_domain = false;
1038 break;
1039 default:
1040 need_domain = true;
1041 }
1042
1043 /* Needs a functioning consumerd? */
1044 switch (cmd_ctx->lsm.cmd_type) {
1045 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER:
1046 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER:
1047 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY:
1048 need_consumerd = false;
1049 break;
1050 default:
1051 need_consumerd = true;
1052 break;
1053 }
1054
1055 if (the_config.no_kernel && need_domain &&
1056 cmd_ctx->lsm.domain.type == LTTNG_DOMAIN_KERNEL) {
1057 if (!is_root) {
1058 ret = LTTNG_ERR_NEED_ROOT_SESSIOND;
1059 } else {
1060 ret = LTTNG_ERR_KERN_NA;
1061 }
1062 goto error;
1063 }
1064
1065 /* Deny register consumer if we already have a spawned consumer. */
1066 if (cmd_ctx->lsm.cmd_type == LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER) {
1067 pthread_mutex_lock(&the_kconsumer_data.pid_mutex);
1068 if (the_kconsumer_data.pid > 0) {
1069 ret = LTTNG_ERR_KERN_CONSUMER_FAIL;
1070 pthread_mutex_unlock(&the_kconsumer_data.pid_mutex);
1071 goto error;
1072 }
1073 pthread_mutex_unlock(&the_kconsumer_data.pid_mutex);
1074 }
1075
1076 /*
1077 * Check for command that don't needs to allocate a returned payload. We do
1078 * this here so we don't have to make the call for no payload at each
1079 * command.
1080 */
1081 switch (cmd_ctx->lsm.cmd_type) {
1082 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS:
1083 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS:
1084 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS:
1085 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS:
1086 case LTTCOMM_SESSIOND_COMMAND_LIST_CHANNELS:
1087 case LTTCOMM_SESSIOND_COMMAND_LIST_EVENTS:
1088 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS:
1089 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES:
1090 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_POLICY:
1091 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET:
1092 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING:
1093 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION:
1094 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO:
1095 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER:
1096 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS:
1097 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY:
1098 break;
1099 default:
1100 /* Setup lttng message with no payload */
1101 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, nullptr, 0);
1102 if (ret < 0) {
1103 /* This label does not try to unlock the session */
1104 goto init_setup_error;
1105 }
1106 }
1107
1108 /* Commands that DO NOT need a session. */
1109 switch (cmd_ctx->lsm.cmd_type) {
1110 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT:
1111 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS:
1112 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS:
1113 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS:
1114 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS:
1115 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION:
1116 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER:
1117 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER:
1118 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS:
1119 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY:
1120 case LTTCOMM_SESSIOND_COMMAND_KERNEL_TRACER_STATUS:
1121 need_tracing_session = false;
1122 break;
1123 default:
1124 DBG("Getting session %s by name", cmd_ctx->lsm.session.name);
1125 /*
1126 * We keep the session list lock across _all_ commands
1127 * for now, because the per-session lock does not
1128 * handle teardown properly.
1129 */
1130 session_lock_list();
1131 cmd_ctx->session = session_find_by_name(cmd_ctx->lsm.session.name);
1132 if (cmd_ctx->session == nullptr) {
1133 ret = LTTNG_ERR_SESS_NOT_FOUND;
1134 goto error;
1135 } else {
1136 /* Acquire lock for the session */
1137 session_lock(cmd_ctx->session);
1138 }
1139 break;
1140 }
1141
1142 /*
1143 * Commands that need a valid session but should NOT create one if none
1144 * exists. Instead of creating one and destroying it when the command is
1145 * handled, process that right before so we save some round trip in useless
1146 * code path.
1147 */
1148 switch (cmd_ctx->lsm.cmd_type) {
1149 case LTTCOMM_SESSIOND_COMMAND_DISABLE_CHANNEL:
1150 case LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT:
1151 switch (cmd_ctx->lsm.domain.type) {
1152 case LTTNG_DOMAIN_KERNEL:
1153 if (!cmd_ctx->session->kernel_session) {
1154 ret = LTTNG_ERR_NO_CHANNEL;
1155 goto error;
1156 }
1157 break;
1158 case LTTNG_DOMAIN_JUL:
1159 case LTTNG_DOMAIN_LOG4J:
1160 case LTTNG_DOMAIN_PYTHON:
1161 case LTTNG_DOMAIN_UST:
1162 if (!cmd_ctx->session->ust_session) {
1163 ret = LTTNG_ERR_NO_CHANNEL;
1164 goto error;
1165 }
1166 break;
1167 default:
1168 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1169 goto error;
1170 }
1171 default:
1172 break;
1173 }
1174
1175 if (!need_domain) {
1176 goto skip_domain;
1177 }
1178
1179 /*
1180 * Check domain type for specific "pre-action".
1181 */
1182 switch (cmd_ctx->lsm.domain.type) {
1183 case LTTNG_DOMAIN_KERNEL:
1184 if (!is_root) {
1185 ret = LTTNG_ERR_NEED_ROOT_SESSIOND;
1186 goto error;
1187 }
1188
1189 /* Kernel tracer check */
1190 if (!kernel_tracer_is_initialized()) {
1191 /* Basically, load kernel tracer modules */
1192 ret = init_kernel_tracer();
1193 if (ret != 0) {
1194 goto error;
1195 }
1196 }
1197
1198 /* Consumer is in an ERROR state. Report back to client */
1199 if (need_consumerd && uatomic_read(&the_kernel_consumerd_state) == CONSUMER_ERROR) {
1200 ret = LTTNG_ERR_NO_KERNCONSUMERD;
1201 goto error;
1202 }
1203
1204 /* Need a session for kernel command */
1205 if (need_tracing_session) {
1206 if (cmd_ctx->session->kernel_session == nullptr) {
1207 ret = create_kernel_session(cmd_ctx->session);
1208 if (ret != LTTNG_OK) {
1209 ret = LTTNG_ERR_KERN_SESS_FAIL;
1210 goto error;
1211 }
1212 }
1213
1214 /* Start the kernel consumer daemon */
1215 pthread_mutex_lock(&the_kconsumer_data.pid_mutex);
1216 if (the_kconsumer_data.pid == 0 &&
1217 cmd_ctx->lsm.cmd_type != LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER) {
1218 pthread_mutex_unlock(&the_kconsumer_data.pid_mutex);
1219 ret = start_consumerd(&the_kconsumer_data);
1220 if (ret < 0) {
1221 ret = LTTNG_ERR_KERN_CONSUMER_FAIL;
1222 goto error;
1223 }
1224 uatomic_set(&the_kernel_consumerd_state, CONSUMER_STARTED);
1225 } else {
1226 pthread_mutex_unlock(&the_kconsumer_data.pid_mutex);
1227 }
1228
1229 /*
1230 * The consumer was just spawned so we need to add the socket to
1231 * the consumer output of the session if exist.
1232 */
1233 ret = consumer_create_socket(&the_kconsumer_data,
1234 cmd_ctx->session->kernel_session->consumer);
1235 if (ret < 0) {
1236 goto error;
1237 }
1238 }
1239
1240 break;
1241 case LTTNG_DOMAIN_JUL:
1242 case LTTNG_DOMAIN_LOG4J:
1243 case LTTNG_DOMAIN_PYTHON:
1244 if (!agent_tracing_is_enabled()) {
1245 ret = LTTNG_ERR_AGENT_TRACING_DISABLED;
1246 goto error;
1247 }
1248 /* Fallthrough */
1249 case LTTNG_DOMAIN_UST:
1250 {
1251 if (!ust_app_supported()) {
1252 ret = LTTNG_ERR_NO_UST;
1253 goto error;
1254 }
1255
1256 /* Consumer is in an ERROR state. Report back to client */
1257 if (need_consumerd && uatomic_read(&the_ust_consumerd_state) == CONSUMER_ERROR) {
1258 ret = LTTNG_ERR_NO_USTCONSUMERD;
1259 goto error;
1260 }
1261
1262 if (need_tracing_session) {
1263 /* Create UST session if none exist. */
1264 if (cmd_ctx->session->ust_session == nullptr) {
1265 lttng_domain domain = cmd_ctx->lsm.domain;
1266 ret = create_ust_session(cmd_ctx->session, &domain);
1267 if (ret != LTTNG_OK) {
1268 goto error;
1269 }
1270 }
1271
1272 /* Start the UST consumer daemons */
1273 /* 64-bit */
1274 pthread_mutex_lock(&the_ustconsumer64_data.pid_mutex);
1275 if (the_config.consumerd64_bin_path.value &&
1276 the_ustconsumer64_data.pid == 0 &&
1277 cmd_ctx->lsm.cmd_type != LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER) {
1278 pthread_mutex_unlock(&the_ustconsumer64_data.pid_mutex);
1279 ret = start_consumerd(&the_ustconsumer64_data);
1280 if (ret < 0) {
1281 ret = LTTNG_ERR_UST_CONSUMER64_FAIL;
1282 uatomic_set(&the_ust_consumerd64_fd, -EINVAL);
1283 goto error;
1284 }
1285
1286 uatomic_set(&the_ust_consumerd64_fd,
1287 the_ustconsumer64_data.cmd_sock);
1288 uatomic_set(&the_ust_consumerd_state, CONSUMER_STARTED);
1289 } else {
1290 pthread_mutex_unlock(&the_ustconsumer64_data.pid_mutex);
1291 }
1292
1293 /*
1294 * Setup socket for consumer 64 bit. No need for atomic access
1295 * since it was set above and can ONLY be set in this thread.
1296 */
1297 ret = consumer_create_socket(&the_ustconsumer64_data,
1298 cmd_ctx->session->ust_session->consumer);
1299 if (ret < 0) {
1300 goto error;
1301 }
1302
1303 /* 32-bit */
1304 pthread_mutex_lock(&the_ustconsumer32_data.pid_mutex);
1305 if (the_config.consumerd32_bin_path.value &&
1306 the_ustconsumer32_data.pid == 0 &&
1307 cmd_ctx->lsm.cmd_type != LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER) {
1308 pthread_mutex_unlock(&the_ustconsumer32_data.pid_mutex);
1309 ret = start_consumerd(&the_ustconsumer32_data);
1310 if (ret < 0) {
1311 ret = LTTNG_ERR_UST_CONSUMER32_FAIL;
1312 uatomic_set(&the_ust_consumerd32_fd, -EINVAL);
1313 goto error;
1314 }
1315
1316 uatomic_set(&the_ust_consumerd32_fd,
1317 the_ustconsumer32_data.cmd_sock);
1318 uatomic_set(&the_ust_consumerd_state, CONSUMER_STARTED);
1319 } else {
1320 pthread_mutex_unlock(&the_ustconsumer32_data.pid_mutex);
1321 }
1322
1323 /*
1324 * Setup socket for consumer 32 bit. No need for atomic access
1325 * since it was set above and can ONLY be set in this thread.
1326 */
1327 ret = consumer_create_socket(&the_ustconsumer32_data,
1328 cmd_ctx->session->ust_session->consumer);
1329 if (ret < 0) {
1330 goto error;
1331 }
1332 }
1333 break;
1334 }
1335 default:
1336 break;
1337 }
1338 skip_domain:
1339
1340 /* Validate consumer daemon state when start/stop trace command */
1341 if (cmd_ctx->lsm.cmd_type == LTTCOMM_SESSIOND_COMMAND_START_TRACE ||
1342 cmd_ctx->lsm.cmd_type == LTTCOMM_SESSIOND_COMMAND_STOP_TRACE) {
1343 switch (cmd_ctx->lsm.domain.type) {
1344 case LTTNG_DOMAIN_NONE:
1345 break;
1346 case LTTNG_DOMAIN_JUL:
1347 case LTTNG_DOMAIN_LOG4J:
1348 case LTTNG_DOMAIN_PYTHON:
1349 case LTTNG_DOMAIN_UST:
1350 if (uatomic_read(&the_ust_consumerd_state) != CONSUMER_STARTED) {
1351 ret = LTTNG_ERR_NO_USTCONSUMERD;
1352 goto error;
1353 }
1354 break;
1355 case LTTNG_DOMAIN_KERNEL:
1356 if (uatomic_read(&the_kernel_consumerd_state) != CONSUMER_STARTED) {
1357 ret = LTTNG_ERR_NO_KERNCONSUMERD;
1358 goto error;
1359 }
1360 break;
1361 default:
1362 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1363 goto error;
1364 }
1365 }
1366
1367 /*
1368 * Check that the UID matches that of the tracing session.
1369 * The root user can interact with all sessions.
1370 */
1371 if (need_tracing_session) {
1372 if (!session_access_ok(cmd_ctx->session,
1373 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx->creds)) ||
1374 cmd_ctx->session->destroyed) {
1375 ret = LTTNG_ERR_EPERM;
1376 goto error;
1377 }
1378 }
1379
1380 /*
1381 * Send relayd information to consumer as soon as we have a domain and a
1382 * session defined.
1383 */
1384 if (cmd_ctx->session && need_domain) {
1385 /*
1386 * Setup relayd if not done yet. If the relayd information was already
1387 * sent to the consumer, this call will gracefully return.
1388 */
1389 ret = cmd_setup_relayd(cmd_ctx->session);
1390 if (ret != LTTNG_OK) {
1391 goto error;
1392 }
1393 }
1394
1395 /* Process by command type */
1396 switch (cmd_ctx->lsm.cmd_type) {
1397 case LTTCOMM_SESSIOND_COMMAND_ADD_CONTEXT:
1398 {
1399 struct lttng_event_context *event_context = nullptr;
1400 const enum lttng_error_code ret_code =
1401 receive_lttng_event_context(cmd_ctx, *sock, sock_error, &event_context);
1402
1403 if (ret_code != LTTNG_OK) {
1404 ret = (int) ret_code;
1405 goto error;
1406 }
1407
1408 ret = cmd_add_context(cmd_ctx, event_context, the_kernel_poll_pipe[1]);
1409 lttng_event_context_destroy(event_context);
1410 break;
1411 }
1412 case LTTCOMM_SESSIOND_COMMAND_DISABLE_CHANNEL:
1413 {
1414 ret = cmd_disable_channel(cmd_ctx->session,
1415 cmd_ctx->lsm.domain.type,
1416 cmd_ctx->lsm.u.disable.channel_name);
1417 break;
1418 }
1419 case LTTCOMM_SESSIOND_COMMAND_ENABLE_CHANNEL:
1420 {
1421 ret = cmd_enable_channel(cmd_ctx, *sock, the_kernel_poll_pipe[1]);
1422 break;
1423 }
1424 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE:
1425 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE:
1426 {
1427 struct lttng_dynamic_buffer payload;
1428 struct lttng_buffer_view payload_view;
1429 const bool add_value = cmd_ctx->lsm.cmd_type ==
1430 LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE;
1431 const size_t name_len =
1432 cmd_ctx->lsm.u.process_attr_tracker_add_remove_include_value.name_len;
1433 const enum lttng_domain_type domain_type =
1434 (enum lttng_domain_type) cmd_ctx->lsm.domain.type;
1435 const enum lttng_process_attr process_attr =
1436 (enum lttng_process_attr) cmd_ctx->lsm.u
1437 .process_attr_tracker_add_remove_include_value.process_attr;
1438 const enum lttng_process_attr_value_type value_type =
1439 (enum lttng_process_attr_value_type) cmd_ctx->lsm.u
1440 .process_attr_tracker_add_remove_include_value.value_type;
1441 struct process_attr_value *value;
1442 enum lttng_error_code ret_code;
1443 long login_name_max;
1444
1445 login_name_max = sysconf(_SC_LOGIN_NAME_MAX);
1446 if (login_name_max < 0) {
1447 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1448 ret = LTTNG_ERR_INVALID;
1449 goto error;
1450 }
1451
1452 /* Receive remaining variable length payload if applicable. */
1453 if (name_len > login_name_max) {
1454 /*
1455 * POSIX mandates user and group names that are at least
1456 * 8 characters long. Note that although shadow-utils
1457 * (useradd, groupaadd, etc.) use 32 chars as their
1458 * limit (from bits/utmp.h, UT_NAMESIZE),
1459 * LOGIN_NAME_MAX is defined to 256.
1460 */
1461 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1462 add_value ? "addition" : "removal",
1463 name_len,
1464 login_name_max);
1465 ret = LTTNG_ERR_INVALID;
1466 goto error;
1467 }
1468
1469 lttng_dynamic_buffer_init(&payload);
1470 if (name_len != 0) {
1471 /*
1472 * Receive variable payload for user/group name
1473 * arguments.
1474 */
1475 ret = lttng_dynamic_buffer_set_size(&payload, name_len);
1476 if (ret) {
1477 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1478 add_value ? "add" : "remove");
1479 ret = LTTNG_ERR_NOMEM;
1480 goto error_add_remove_tracker_value;
1481 }
1482
1483 ret = lttcomm_recv_unix_sock(*sock, payload.data, name_len);
1484 if (ret <= 0) {
1485 ERR("Failed to receive payload of %s process attribute tracker value argument",
1486 add_value ? "add" : "remove");
1487 *sock_error = 1;
1488 ret = LTTNG_ERR_INVALID_PROTOCOL;
1489 goto error_add_remove_tracker_value;
1490 }
1491 }
1492
1493 payload_view = lttng_buffer_view_from_dynamic_buffer(&payload, 0, name_len);
1494 if (name_len > 0 && !lttng_buffer_view_is_valid(&payload_view)) {
1495 ret = LTTNG_ERR_INVALID_PROTOCOL;
1496 goto error_add_remove_tracker_value;
1497 }
1498
1499 /*
1500 * Validate the value type and domains are legal for the process
1501 * attribute tracker that is specified and convert the value to
1502 * add/remove to the internal sessiond representation.
1503 */
1504 ret_code = process_attr_value_from_comm(
1505 domain_type,
1506 process_attr,
1507 value_type,
1508 &cmd_ctx->lsm.u.process_attr_tracker_add_remove_include_value.integral_value,
1509 &payload_view,
1510 &value);
1511 if (ret_code != LTTNG_OK) {
1512 ret = ret_code;
1513 goto error_add_remove_tracker_value;
1514 }
1515
1516 if (add_value) {
1517 ret = cmd_process_attr_tracker_inclusion_set_add_value(
1518 cmd_ctx->session, domain_type, process_attr, value);
1519 } else {
1520 ret = cmd_process_attr_tracker_inclusion_set_remove_value(
1521 cmd_ctx->session, domain_type, process_attr, value);
1522 }
1523 process_attr_value_destroy(value);
1524 error_add_remove_tracker_value:
1525 lttng_dynamic_buffer_reset(&payload);
1526 break;
1527 }
1528 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_POLICY:
1529 {
1530 enum lttng_tracking_policy tracking_policy;
1531 const enum lttng_domain_type domain_type =
1532 (enum lttng_domain_type) cmd_ctx->lsm.domain.type;
1533 const enum lttng_process_attr process_attr =
1534 (enum lttng_process_attr) cmd_ctx->lsm.u
1535 .process_attr_tracker_get_tracking_policy.process_attr;
1536
1537 ret = cmd_process_attr_tracker_get_tracking_policy(
1538 cmd_ctx->session, domain_type, process_attr, &tracking_policy);
1539 if (ret != LTTNG_OK) {
1540 goto error;
1541 }
1542
1543 uint32_t tracking_policy_u32 = tracking_policy;
1544 ret = setup_lttng_msg_no_cmd_header(
1545 cmd_ctx, &tracking_policy_u32, sizeof(uint32_t));
1546 if (ret < 0) {
1547 ret = LTTNG_ERR_NOMEM;
1548 goto error;
1549 }
1550 ret = LTTNG_OK;
1551 break;
1552 }
1553 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_SET_POLICY:
1554 {
1555 const enum lttng_tracking_policy tracking_policy =
1556 (enum lttng_tracking_policy) cmd_ctx->lsm.u
1557 .process_attr_tracker_set_tracking_policy.tracking_policy;
1558 const enum lttng_domain_type domain_type =
1559 (enum lttng_domain_type) cmd_ctx->lsm.domain.type;
1560 const enum lttng_process_attr process_attr =
1561 (enum lttng_process_attr) cmd_ctx->lsm.u
1562 .process_attr_tracker_set_tracking_policy.process_attr;
1563
1564 ret = cmd_process_attr_tracker_set_tracking_policy(
1565 cmd_ctx->session, domain_type, process_attr, tracking_policy);
1566 if (ret != LTTNG_OK) {
1567 goto error;
1568 }
1569 break;
1570 }
1571 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET:
1572 {
1573 struct lttng_process_attr_values *values;
1574 struct lttng_dynamic_buffer reply;
1575 const enum lttng_domain_type domain_type =
1576 (enum lttng_domain_type) cmd_ctx->lsm.domain.type;
1577 const enum lttng_process_attr process_attr =
1578 (enum lttng_process_attr)
1579 cmd_ctx->lsm.u.process_attr_tracker_get_inclusion_set.process_attr;
1580
1581 ret = cmd_process_attr_tracker_get_inclusion_set(
1582 cmd_ctx->session, domain_type, process_attr, &values);
1583 if (ret != LTTNG_OK) {
1584 goto error;
1585 }
1586
1587 lttng_dynamic_buffer_init(&reply);
1588 ret = lttng_process_attr_values_serialize(values, &reply);
1589 if (ret < 0) {
1590 goto error_tracker_get_inclusion_set;
1591 }
1592
1593 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, reply.data, reply.size);
1594 if (ret < 0) {
1595 ret = LTTNG_ERR_NOMEM;
1596 goto error_tracker_get_inclusion_set;
1597 }
1598 ret = LTTNG_OK;
1599
1600 error_tracker_get_inclusion_set:
1601 lttng_process_attr_values_destroy(values);
1602 lttng_dynamic_buffer_reset(&reply);
1603 break;
1604 }
1605 case LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT:
1606 case LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT:
1607 {
1608 struct lttng_event *event;
1609 char *filter_expression;
1610 struct lttng_event_exclusion *exclusions;
1611 struct lttng_bytecode *bytecode;
1612 const enum lttng_error_code ret_code = receive_lttng_event(cmd_ctx,
1613 *sock,
1614 sock_error,
1615 &event,
1616 &filter_expression,
1617 &bytecode,
1618 &exclusions);
1619
1620 if (ret_code != LTTNG_OK) {
1621 ret = (int) ret_code;
1622 goto error;
1623 }
1624
1625 /*
1626 * Ownership of filter_expression, exclusions, and bytecode is
1627 * always transferred.
1628 */
1629 ret = cmd_ctx->lsm.cmd_type == LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT ?
1630 cmd_enable_event(cmd_ctx,
1631 event,
1632 filter_expression,
1633 exclusions,
1634 bytecode,
1635 the_kernel_poll_pipe[1]) :
1636 cmd_disable_event(cmd_ctx, event, filter_expression, bytecode, exclusions);
1637 lttng_event_destroy(event);
1638 break;
1639 }
1640 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS:
1641 {
1642 enum lttng_error_code ret_code;
1643 size_t original_payload_size;
1644 size_t payload_size;
1645 const size_t command_header_size = sizeof(struct lttcomm_list_command_header);
1646
1647 ret = setup_empty_lttng_msg(cmd_ctx);
1648 if (ret) {
1649 ret = LTTNG_ERR_NOMEM;
1650 goto setup_error;
1651 }
1652
1653 original_payload_size = cmd_ctx->reply_payload.buffer.size;
1654
1655 session_lock_list();
1656 ret_code = cmd_list_tracepoints(cmd_ctx->lsm.domain.type, &cmd_ctx->reply_payload);
1657 session_unlock_list();
1658 if (ret_code != LTTNG_OK) {
1659 ret = (int) ret_code;
1660 goto error;
1661 }
1662
1663 payload_size = cmd_ctx->reply_payload.buffer.size - command_header_size -
1664 original_payload_size;
1665 update_lttng_msg(cmd_ctx, command_header_size, payload_size);
1666
1667 ret = LTTNG_OK;
1668 break;
1669 }
1670 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS:
1671 {
1672 enum lttng_error_code ret_code;
1673 size_t original_payload_size;
1674 size_t payload_size;
1675 const size_t command_header_size = sizeof(struct lttcomm_list_command_header);
1676
1677 ret = setup_empty_lttng_msg(cmd_ctx);
1678 if (ret) {
1679 ret = LTTNG_ERR_NOMEM;
1680 goto setup_error;
1681 }
1682
1683 original_payload_size = cmd_ctx->reply_payload.buffer.size;
1684
1685 session_lock_list();
1686 ret_code = cmd_list_tracepoint_fields(cmd_ctx->lsm.domain.type,
1687 &cmd_ctx->reply_payload);
1688 session_unlock_list();
1689 if (ret_code != LTTNG_OK) {
1690 ret = (int) ret_code;
1691 goto error;
1692 }
1693
1694 payload_size = cmd_ctx->reply_payload.buffer.size - command_header_size -
1695 original_payload_size;
1696 update_lttng_msg(cmd_ctx, command_header_size, payload_size);
1697
1698 ret = LTTNG_OK;
1699 break;
1700 }
1701 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS:
1702 {
1703 enum lttng_error_code ret_code;
1704 size_t original_payload_size;
1705 size_t payload_size;
1706 const size_t command_header_size = sizeof(struct lttcomm_list_command_header);
1707
1708 ret = setup_empty_lttng_msg(cmd_ctx);
1709 if (ret) {
1710 ret = LTTNG_ERR_NOMEM;
1711 goto setup_error;
1712 }
1713
1714 original_payload_size = cmd_ctx->reply_payload.buffer.size;
1715
1716 ret_code = cmd_list_syscalls(&cmd_ctx->reply_payload);
1717 if (ret_code != LTTNG_OK) {
1718 ret = (int) ret_code;
1719 goto error;
1720 }
1721
1722 payload_size = cmd_ctx->reply_payload.buffer.size - command_header_size -
1723 original_payload_size;
1724 update_lttng_msg(cmd_ctx, command_header_size, payload_size);
1725
1726 ret = LTTNG_OK;
1727 break;
1728 }
1729 case LTTCOMM_SESSIOND_COMMAND_SET_CONSUMER_URI:
1730 {
1731 size_t nb_uri, len;
1732 struct lttng_uri *uris;
1733
1734 nb_uri = cmd_ctx->lsm.u.uri.size;
1735 len = nb_uri * sizeof(struct lttng_uri);
1736
1737 if (nb_uri == 0) {
1738 ret = LTTNG_ERR_INVALID;
1739 goto error;
1740 }
1741
1742 uris = calloc<lttng_uri>(nb_uri);
1743 if (uris == nullptr) {
1744 ret = LTTNG_ERR_FATAL;
1745 goto error;
1746 }
1747
1748 /* Receive variable len data */
1749 DBG("Receiving %zu URI(s) from client ...", nb_uri);
1750 ret = lttcomm_recv_unix_sock(*sock, uris, len);
1751 if (ret <= 0) {
1752 DBG("No URIs received from client... continuing");
1753 *sock_error = 1;
1754 ret = LTTNG_ERR_SESSION_FAIL;
1755 free(uris);
1756 goto error;
1757 }
1758
1759 ret = cmd_set_consumer_uri(cmd_ctx->session, nb_uri, uris);
1760 free(uris);
1761 if (ret != LTTNG_OK) {
1762 goto error;
1763 }
1764
1765 break;
1766 }
1767 case LTTCOMM_SESSIOND_COMMAND_START_TRACE:
1768 {
1769 /*
1770 * On the first start, if we have a kernel session and we have
1771 * enabled time or size-based rotations, we have to make sure
1772 * the kernel tracer supports it.
1773 */
1774 if (!cmd_ctx->session->has_been_started && cmd_ctx->session->kernel_session &&
1775 (cmd_ctx->session->rotate_timer_period || cmd_ctx->session->rotate_size) &&
1776 !check_rotate_compatible()) {
1777 DBG("Kernel tracer version is not compatible with the rotation feature");
1778 ret = LTTNG_ERR_ROTATION_WRONG_VERSION;
1779 goto error;
1780 }
1781 ret = cmd_start_trace(cmd_ctx->session);
1782 break;
1783 }
1784 case LTTCOMM_SESSIOND_COMMAND_STOP_TRACE:
1785 {
1786 ret = cmd_stop_trace(cmd_ctx->session);
1787 break;
1788 }
1789 case LTTCOMM_SESSIOND_COMMAND_DESTROY_SESSION:
1790 {
1791 ret = cmd_destroy_session(cmd_ctx->session, sock);
1792 break;
1793 }
1794 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS:
1795 {
1796 ssize_t nb_dom;
1797 struct lttng_domain *domains = nullptr;
1798
1799 nb_dom = cmd_list_domains(cmd_ctx->session, &domains);
1800 if (nb_dom < 0) {
1801 /* Return value is a negative lttng_error_code. */
1802 ret = -nb_dom;
1803 goto error;
1804 }
1805
1806 ret = setup_lttng_msg_no_cmd_header(
1807 cmd_ctx, domains, nb_dom * sizeof(struct lttng_domain));
1808 free(domains);
1809
1810 if (ret < 0) {
1811 goto setup_error;
1812 }
1813
1814 ret = LTTNG_OK;
1815 break;
1816 }
1817 case LTTCOMM_SESSIOND_COMMAND_LIST_CHANNELS:
1818 {
1819 enum lttng_error_code ret_code;
1820 size_t original_payload_size;
1821 size_t payload_size;
1822 const size_t command_header_size = sizeof(struct lttcomm_list_command_header);
1823
1824 ret = setup_empty_lttng_msg(cmd_ctx);
1825 if (ret) {
1826 ret = LTTNG_ERR_NOMEM;
1827 goto setup_error;
1828 }
1829
1830 original_payload_size = cmd_ctx->reply_payload.buffer.size;
1831
1832 ret_code = cmd_list_channels(
1833 cmd_ctx->lsm.domain.type, cmd_ctx->session, &cmd_ctx->reply_payload);
1834 if (ret_code != LTTNG_OK) {
1835 ret = (int) ret_code;
1836 goto error;
1837 }
1838
1839 payload_size = cmd_ctx->reply_payload.buffer.size - command_header_size -
1840 original_payload_size;
1841 update_lttng_msg(cmd_ctx, command_header_size, payload_size);
1842
1843 ret = LTTNG_OK;
1844 break;
1845 }
1846 case LTTCOMM_SESSIOND_COMMAND_LIST_EVENTS:
1847 {
1848 enum lttng_error_code ret_code;
1849 size_t original_payload_size;
1850 size_t payload_size;
1851 const size_t command_header_size = sizeof(struct lttcomm_list_command_header);
1852
1853 ret = setup_empty_lttng_msg(cmd_ctx);
1854 if (ret) {
1855 ret = LTTNG_ERR_NOMEM;
1856 goto setup_error;
1857 }
1858
1859 original_payload_size = cmd_ctx->reply_payload.buffer.size;
1860
1861 ret_code = cmd_list_events(cmd_ctx->lsm.domain.type,
1862 cmd_ctx->session,
1863 cmd_ctx->lsm.u.list.channel_name,
1864 &cmd_ctx->reply_payload);
1865 if (ret_code != LTTNG_OK) {
1866 ret = (int) ret_code;
1867 goto error;
1868 }
1869
1870 payload_size = cmd_ctx->reply_payload.buffer.size - command_header_size -
1871 original_payload_size;
1872 update_lttng_msg(cmd_ctx, command_header_size, payload_size);
1873
1874 ret = LTTNG_OK;
1875 break;
1876 }
1877 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS:
1878 {
1879 unsigned int nr_sessions;
1880 lttng_session *sessions_payload = nullptr;
1881 size_t payload_len = 0;
1882
1883 session_lock_list();
1884 nr_sessions = lttng_sessions_count(LTTNG_SOCK_GET_UID_CRED(&cmd_ctx->creds),
1885 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx->creds));
1886
1887 if (nr_sessions > 0) {
1888 payload_len = (sizeof(struct lttng_session) * nr_sessions) +
1889 (sizeof(struct lttng_session_extended) * nr_sessions);
1890 sessions_payload = zmalloc<lttng_session>(payload_len);
1891 if (!sessions_payload) {
1892 session_unlock_list();
1893 ret = -ENOMEM;
1894 goto setup_error;
1895 }
1896
1897 cmd_list_lttng_sessions(sessions_payload,
1898 nr_sessions,
1899 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx->creds),
1900 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx->creds));
1901 }
1902
1903 session_unlock_list();
1904
1905 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, sessions_payload, payload_len);
1906 free(sessions_payload);
1907
1908 if (ret < 0) {
1909 goto setup_error;
1910 }
1911
1912 ret = LTTNG_OK;
1913 break;
1914 }
1915 case LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER:
1916 {
1917 struct consumer_data *cdata;
1918
1919 switch (cmd_ctx->lsm.domain.type) {
1920 case LTTNG_DOMAIN_KERNEL:
1921 cdata = &the_kconsumer_data;
1922 break;
1923 default:
1924 ret = LTTNG_ERR_UND;
1925 goto error;
1926 }
1927
1928 ret = cmd_register_consumer(
1929 cmd_ctx->session, cmd_ctx->lsm.domain.type, cmd_ctx->lsm.u.reg.path, cdata);
1930 break;
1931 }
1932 case LTTCOMM_SESSIOND_COMMAND_KERNEL_TRACER_STATUS:
1933 {
1934 uint32_t u_status;
1935 enum lttng_kernel_tracer_status status;
1936
1937 ret = cmd_kernel_tracer_status(&status);
1938 if (ret != LTTNG_OK) {
1939 goto error;
1940 }
1941
1942 u_status = (uint32_t) status;
1943 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, &u_status, 4);
1944 if (ret < 0) {
1945 goto error;
1946 }
1947
1948 ret = LTTNG_OK;
1949 break;
1950 }
1951 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING:
1952 {
1953 int pending_ret;
1954 uint8_t pending_ret_byte;
1955
1956 pending_ret = cmd_data_pending(cmd_ctx->session);
1957
1958 /*
1959 * FIXME
1960 *
1961 * This function may returns 0 or 1 to indicate whether or not
1962 * there is data pending. In case of error, it should return an
1963 * LTTNG_ERR code. However, some code paths may still return
1964 * a nondescript error code, which we handle by returning an
1965 * "unknown" error.
1966 */
1967 if (pending_ret == 0 || pending_ret == 1) {
1968 /*
1969 * ret will be set to LTTNG_OK at the end of
1970 * this function.
1971 */
1972 } else if (pending_ret <= LTTNG_OK || pending_ret >= LTTNG_ERR_NR) {
1973 ret = LTTNG_ERR_UNK;
1974 goto error;
1975 } else {
1976 ret = pending_ret;
1977 goto error;
1978 }
1979
1980 pending_ret_byte = (uint8_t) pending_ret;
1981
1982 /* 1 byte to return whether or not data is pending */
1983 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, &pending_ret_byte, 1);
1984
1985 if (ret < 0) {
1986 goto setup_error;
1987 }
1988
1989 ret = LTTNG_OK;
1990 break;
1991 }
1992 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_ADD_OUTPUT:
1993 {
1994 uint32_t snapshot_id;
1995 struct lttcomm_lttng_output_id reply;
1996 lttng_snapshot_output output = cmd_ctx->lsm.u.snapshot_output.output;
1997
1998 ret = cmd_snapshot_add_output(cmd_ctx->session, &output, &snapshot_id);
1999 if (ret != LTTNG_OK) {
2000 goto error;
2001 }
2002 reply.id = snapshot_id;
2003
2004 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, &reply, sizeof(reply));
2005 if (ret < 0) {
2006 goto setup_error;
2007 }
2008
2009 /* Copy output list into message payload */
2010 ret = LTTNG_OK;
2011 break;
2012 }
2013 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_DEL_OUTPUT:
2014 {
2015 lttng_snapshot_output output = cmd_ctx->lsm.u.snapshot_output.output;
2016 ret = cmd_snapshot_del_output(cmd_ctx->session, &output);
2017 break;
2018 }
2019 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_LIST_OUTPUT:
2020 {
2021 ssize_t nb_output;
2022 struct lttng_snapshot_output *outputs = nullptr;
2023
2024 nb_output = cmd_snapshot_list_outputs(cmd_ctx->session, &outputs);
2025 if (nb_output < 0) {
2026 ret = -nb_output;
2027 goto error;
2028 }
2029
2030 LTTNG_ASSERT((nb_output > 0 && outputs) || nb_output == 0);
2031 ret = setup_lttng_msg_no_cmd_header(
2032 cmd_ctx, outputs, nb_output * sizeof(struct lttng_snapshot_output));
2033 free(outputs);
2034
2035 if (ret < 0) {
2036 goto setup_error;
2037 }
2038
2039 ret = LTTNG_OK;
2040 break;
2041 }
2042 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_RECORD:
2043 {
2044 lttng_snapshot_output output = cmd_ctx->lsm.u.snapshot_record.output;
2045 ret = cmd_snapshot_record(cmd_ctx->session, &output, 0); // RFC: set to zero since
2046 // it's ignored by
2047 // cmd_snapshot_record
2048 break;
2049 }
2050 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT:
2051 {
2052 struct lttng_dynamic_buffer payload;
2053 struct lttng_session_descriptor *return_descriptor = nullptr;
2054
2055 lttng_dynamic_buffer_init(&payload);
2056 ret = cmd_create_session(cmd_ctx, *sock, &return_descriptor);
2057 if (ret != LTTNG_OK) {
2058 goto error;
2059 }
2060
2061 ret = lttng_session_descriptor_serialize(return_descriptor, &payload);
2062 if (ret) {
2063 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2064 lttng_session_descriptor_destroy(return_descriptor);
2065 ret = LTTNG_ERR_NOMEM;
2066 goto error;
2067 }
2068 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, payload.data, payload.size);
2069 if (ret) {
2070 lttng_session_descriptor_destroy(return_descriptor);
2071 ret = LTTNG_ERR_NOMEM;
2072 goto error;
2073 }
2074 lttng_dynamic_buffer_reset(&payload);
2075 lttng_session_descriptor_destroy(return_descriptor);
2076 ret = LTTNG_OK;
2077 break;
2078 }
2079 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION:
2080 {
2081 ret = cmd_save_sessions(&cmd_ctx->lsm.u.save_session.attr, &cmd_ctx->creds);
2082 break;
2083 }
2084 case LTTCOMM_SESSIOND_COMMAND_SET_SESSION_SHM_PATH:
2085 {
2086 ret = cmd_set_session_shm_path(cmd_ctx->session,
2087 cmd_ctx->lsm.u.set_shm_path.shm_path);
2088 break;
2089 }
2090 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_METADATA:
2091 {
2092 ret = cmd_regenerate_metadata(cmd_ctx->session);
2093 break;
2094 }
2095 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_STATEDUMP:
2096 {
2097 ret = cmd_regenerate_statedump(cmd_ctx->session);
2098 break;
2099 }
2100 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER:
2101 {
2102 struct lttng_trigger *payload_trigger;
2103 struct lttng_trigger *return_trigger;
2104 size_t original_reply_payload_size;
2105 size_t reply_payload_size;
2106 const struct lttng_credentials cmd_creds = {
2107 .uid = LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx->creds.uid),
2108 .gid = LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx->creds.gid),
2109 };
2110
2111 ret = setup_empty_lttng_msg(cmd_ctx);
2112 if (ret) {
2113 ret = LTTNG_ERR_NOMEM;
2114 goto setup_error;
2115 }
2116
2117 ret = receive_lttng_trigger(cmd_ctx, *sock, sock_error, &payload_trigger);
2118 if (ret != LTTNG_OK) {
2119 goto error;
2120 }
2121
2122 original_reply_payload_size = cmd_ctx->reply_payload.buffer.size;
2123
2124 ret = cmd_register_trigger(&cmd_creds,
2125 payload_trigger,
2126 cmd_ctx->lsm.u.trigger.is_trigger_anonymous,
2127 the_notification_thread_handle,
2128 &return_trigger);
2129 if (ret != LTTNG_OK) {
2130 lttng_trigger_put(payload_trigger);
2131 goto error;
2132 }
2133
2134 ret = lttng_trigger_serialize(return_trigger, &cmd_ctx->reply_payload);
2135 lttng_trigger_put(payload_trigger);
2136 lttng_trigger_put(return_trigger);
2137 if (ret) {
2138 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2139 ret = LTTNG_ERR_NOMEM;
2140 goto error;
2141 }
2142
2143 reply_payload_size =
2144 cmd_ctx->reply_payload.buffer.size - original_reply_payload_size;
2145
2146 update_lttng_msg(cmd_ctx, 0, reply_payload_size);
2147
2148 ret = LTTNG_OK;
2149 break;
2150 }
2151 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER:
2152 {
2153 struct lttng_trigger *payload_trigger;
2154 const struct lttng_credentials cmd_creds = {
2155 .uid = LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx->creds.uid),
2156 .gid = LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx->creds.gid),
2157 };
2158
2159 ret = receive_lttng_trigger(cmd_ctx, *sock, sock_error, &payload_trigger);
2160 if (ret != LTTNG_OK) {
2161 goto error;
2162 }
2163
2164 ret = cmd_unregister_trigger(
2165 &cmd_creds, payload_trigger, the_notification_thread_handle);
2166 lttng_trigger_put(payload_trigger);
2167 break;
2168 }
2169 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION:
2170 {
2171 struct lttng_rotate_session_return rotate_return;
2172
2173 DBG("Client rotate session \"%s\"", cmd_ctx->session->name);
2174
2175 memset(&rotate_return, 0, sizeof(rotate_return));
2176 if (cmd_ctx->session->kernel_session && !check_rotate_compatible()) {
2177 DBG("Kernel tracer version is not compatible with the rotation feature");
2178 ret = LTTNG_ERR_ROTATION_WRONG_VERSION;
2179 goto error;
2180 }
2181
2182 ret = cmd_rotate_session(cmd_ctx->session,
2183 &rotate_return,
2184 false,
2185 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED);
2186 if (ret < 0) {
2187 ret = -ret;
2188 goto error;
2189 }
2190
2191 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, &rotate_return, sizeof(rotate_return));
2192 if (ret < 0) {
2193 ret = -ret;
2194 goto error;
2195 }
2196
2197 ret = LTTNG_OK;
2198 break;
2199 }
2200 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO:
2201 {
2202 struct lttng_rotation_get_info_return get_info_return;
2203
2204 memset(&get_info_return, 0, sizeof(get_info_return));
2205 ret = cmd_rotate_get_info(cmd_ctx->session,
2206 &get_info_return,
2207 cmd_ctx->lsm.u.get_rotation_info.rotation_id);
2208 if (ret < 0) {
2209 ret = -ret;
2210 goto error;
2211 }
2212
2213 ret = setup_lttng_msg_no_cmd_header(
2214 cmd_ctx, &get_info_return, sizeof(get_info_return));
2215 if (ret < 0) {
2216 ret = -ret;
2217 goto error;
2218 }
2219
2220 ret = LTTNG_OK;
2221 break;
2222 }
2223 case LTTCOMM_SESSIOND_COMMAND_ROTATION_SET_SCHEDULE:
2224 {
2225 bool set_schedule;
2226 enum lttng_rotation_schedule_type schedule_type;
2227 uint64_t value;
2228
2229 if (cmd_ctx->session->kernel_session && !check_rotate_compatible()) {
2230 DBG("Kernel tracer version does not support session rotations");
2231 ret = LTTNG_ERR_ROTATION_WRONG_VERSION;
2232 goto error;
2233 }
2234
2235 set_schedule = cmd_ctx->lsm.u.rotation_set_schedule.set == 1;
2236 schedule_type = (enum lttng_rotation_schedule_type)
2237 cmd_ctx->lsm.u.rotation_set_schedule.type;
2238 value = cmd_ctx->lsm.u.rotation_set_schedule.value;
2239
2240 ret = cmd_rotation_set_schedule(
2241 cmd_ctx->session, set_schedule, schedule_type, value);
2242 if (ret != LTTNG_OK) {
2243 goto error;
2244 }
2245
2246 break;
2247 }
2248 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES:
2249 {
2250 lttng_session_list_schedules_return schedules;
2251
2252 schedules.periodic.set = !!cmd_ctx->session->rotate_timer_period;
2253 schedules.periodic.value = cmd_ctx->session->rotate_timer_period;
2254 schedules.size.set = !!cmd_ctx->session->rotate_size;
2255 schedules.size.value = cmd_ctx->session->rotate_size;
2256
2257 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, &schedules, sizeof(schedules));
2258 if (ret < 0) {
2259 ret = -ret;
2260 goto error;
2261 }
2262
2263 ret = LTTNG_OK;
2264 break;
2265 }
2266 case LTTCOMM_SESSIOND_COMMAND_CLEAR_SESSION:
2267 {
2268 ret = cmd_clear_session(cmd_ctx->session, sock);
2269 break;
2270 }
2271 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS:
2272 {
2273 struct lttng_triggers *return_triggers = nullptr;
2274 size_t original_payload_size;
2275 size_t payload_size;
2276
2277 ret = setup_empty_lttng_msg(cmd_ctx);
2278 if (ret) {
2279 ret = LTTNG_ERR_NOMEM;
2280 goto setup_error;
2281 }
2282
2283 original_payload_size = cmd_ctx->reply_payload.buffer.size;
2284
2285 ret = cmd_list_triggers(cmd_ctx, the_notification_thread_handle, &return_triggers);
2286 if (ret != LTTNG_OK) {
2287 goto error;
2288 }
2289
2290 LTTNG_ASSERT(return_triggers);
2291 ret = lttng_triggers_serialize(return_triggers, &cmd_ctx->reply_payload);
2292 lttng_triggers_destroy(return_triggers);
2293 if (ret) {
2294 ERR("Failed to serialize triggers in reply to `list triggers` command");
2295 ret = LTTNG_ERR_NOMEM;
2296 goto error;
2297 }
2298
2299 payload_size = cmd_ctx->reply_payload.buffer.size - original_payload_size;
2300
2301 update_lttng_msg(cmd_ctx, 0, payload_size);
2302
2303 ret = LTTNG_OK;
2304 break;
2305 }
2306 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY:
2307 {
2308 struct lttng_error_query *query;
2309 const struct lttng_credentials cmd_creds = {
2310 .uid = LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx->creds.uid),
2311 .gid = LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx->creds.gid),
2312 };
2313 struct lttng_error_query_results *results = nullptr;
2314 size_t original_payload_size;
2315 size_t payload_size;
2316
2317 ret = setup_empty_lttng_msg(cmd_ctx);
2318 if (ret) {
2319 ret = LTTNG_ERR_NOMEM;
2320 goto setup_error;
2321 }
2322
2323 original_payload_size = cmd_ctx->reply_payload.buffer.size;
2324
2325 ret = receive_lttng_error_query(cmd_ctx, *sock, sock_error, &query);
2326 if (ret != LTTNG_OK) {
2327 goto error;
2328 }
2329
2330 ret = cmd_execute_error_query(
2331 &cmd_creds, query, &results, the_notification_thread_handle);
2332 lttng_error_query_destroy(query);
2333 if (ret != LTTNG_OK) {
2334 goto error;
2335 }
2336
2337 LTTNG_ASSERT(results);
2338 ret = lttng_error_query_results_serialize(results, &cmd_ctx->reply_payload);
2339 lttng_error_query_results_destroy(results);
2340 if (ret) {
2341 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2342 ret = LTTNG_ERR_NOMEM;
2343 goto error;
2344 }
2345
2346 payload_size = cmd_ctx->reply_payload.buffer.size - original_payload_size;
2347
2348 update_lttng_msg(cmd_ctx, 0, payload_size);
2349
2350 ret = LTTNG_OK;
2351
2352 break;
2353 }
2354 default:
2355 ret = LTTNG_ERR_UND;
2356 break;
2357 }
2358
2359 error:
2360 if (cmd_ctx->reply_payload.buffer.size == 0) {
2361 DBG("Missing llm header, creating one.");
2362 if (setup_lttng_msg_no_cmd_header(cmd_ctx, nullptr, 0) < 0) {
2363 goto setup_error;
2364 }
2365 }
2366 /* Set return code */
2367 ((struct lttcomm_lttng_msg *) (cmd_ctx->reply_payload.buffer.data))->ret_code = ret;
2368 setup_error:
2369 if (cmd_ctx->session) {
2370 session_unlock(cmd_ctx->session);
2371 session_put(cmd_ctx->session);
2372 cmd_ctx->session = nullptr;
2373 }
2374 if (need_tracing_session) {
2375 session_unlock_list();
2376 }
2377 init_setup_error:
2378 LTTNG_ASSERT(!rcu_read_ongoing());
2379 return ret;
2380 }
2381
2382 static int create_client_sock()
2383 {
2384 int ret, client_sock;
2385
2386 /* Create client tool unix socket */
2387 client_sock = lttcomm_create_unix_sock(the_config.client_unix_sock_path.value);
2388 if (client_sock < 0) {
2389 ERR("Create unix sock failed: %s", the_config.client_unix_sock_path.value);
2390 ret = -1;
2391 goto end;
2392 }
2393
2394 /* Set the cloexec flag */
2395 ret = utils_set_fd_cloexec(client_sock);
2396 if (ret < 0) {
2397 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2398 "Continuing but note that the consumer daemon will have a "
2399 "reference to this socket on exec()",
2400 client_sock);
2401 }
2402
2403 /* File permission MUST be 660 */
2404 ret = chmod(the_config.client_unix_sock_path.value, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
2405 if (ret < 0) {
2406 ERR("Set file permissions failed: %s", the_config.client_unix_sock_path.value);
2407 PERROR("chmod");
2408 (void) lttcomm_close_unix_sock(client_sock);
2409 ret = -1;
2410 goto end;
2411 }
2412 DBG("Created client socket (fd = %i)", client_sock);
2413 ret = client_sock;
2414 end:
2415 return ret;
2416 }
2417
2418 static void cleanup_client_thread(void *data)
2419 {
2420 struct lttng_pipe *quit_pipe = (lttng_pipe *) data;
2421
2422 lttng_pipe_destroy(quit_pipe);
2423 }
2424
2425 static void thread_init_cleanup(void *data __attribute__((unused)))
2426 {
2427 set_thread_status(false);
2428 }
2429
2430 /*
2431 * This thread manage all clients request using the unix client socket for
2432 * communication.
2433 */
2434 static void *thread_manage_clients(void *data)
2435 {
2436 int sock = -1, ret, i, err = -1;
2437 int sock_error;
2438 uint32_t nb_fd;
2439 struct lttng_poll_event events;
2440 const int client_sock = thread_state.client_sock;
2441 struct lttng_pipe *quit_pipe = (lttng_pipe *) data;
2442 const int thread_quit_pipe_fd = lttng_pipe_get_readfd(quit_pipe);
2443 struct command_ctx cmd_ctx = {};
2444
2445 DBG("[thread] Manage client started");
2446
2447 lttng_payload_init(&cmd_ctx.reply_payload);
2448
2449 is_root = (getuid() == 0);
2450
2451 pthread_cleanup_push(thread_init_cleanup, nullptr);
2452
2453 rcu_register_thread();
2454
2455 health_register(the_health_sessiond, HEALTH_SESSIOND_TYPE_CMD);
2456
2457 health_code_update();
2458
2459 ret = lttcomm_listen_unix_sock(client_sock);
2460 if (ret < 0) {
2461 goto error_listen;
2462 }
2463
2464 /*
2465 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2466 * more will be added to this poll set.
2467 */
2468 ret = lttng_poll_create(&events, 2, LTTNG_CLOEXEC);
2469 if (ret < 0) {
2470 goto error_create_poll;
2471 }
2472
2473 /* Add the application registration socket */
2474 ret = lttng_poll_add(&events, client_sock, LPOLLIN | LPOLLPRI);
2475 if (ret < 0) {
2476 goto error;
2477 }
2478
2479 /* Add thread quit pipe */
2480 ret = lttng_poll_add(&events, thread_quit_pipe_fd, LPOLLIN);
2481 if (ret < 0) {
2482 goto error;
2483 }
2484
2485 /* Set state as running. */
2486 set_thread_status(true);
2487 pthread_cleanup_pop(0);
2488
2489 /* This testpoint is after we signal readiness to the parent. */
2490 if (testpoint(sessiond_thread_manage_clients)) {
2491 goto error;
2492 }
2493
2494 if (testpoint(sessiond_thread_manage_clients_before_loop)) {
2495 goto error;
2496 }
2497
2498 health_code_update();
2499
2500 while (true) {
2501 const struct cmd_completion_handler *cmd_completion_handler;
2502
2503 cmd_ctx.creds.uid = UINT32_MAX;
2504 cmd_ctx.creds.gid = UINT32_MAX;
2505 cmd_ctx.creds.pid = 0;
2506 cmd_ctx.session = nullptr;
2507 lttng_payload_clear(&cmd_ctx.reply_payload);
2508 cmd_ctx.lttng_msg_size = 0;
2509
2510 DBG("Accepting client command ...");
2511
2512 /* Inifinite blocking call, waiting for transmission */
2513 restart:
2514 health_poll_entry();
2515 ret = lttng_poll_wait(&events, -1);
2516 health_poll_exit();
2517 if (ret < 0) {
2518 /*
2519 * Restart interrupted system call.
2520 */
2521 if (errno == EINTR) {
2522 goto restart;
2523 }
2524 goto error;
2525 }
2526
2527 nb_fd = ret;
2528
2529 for (i = 0; i < nb_fd; i++) {
2530 /* Fetch once the poll data. */
2531 const auto revents = LTTNG_POLL_GETEV(&events, i);
2532 const auto pollfd = LTTNG_POLL_GETFD(&events, i);
2533
2534 health_code_update();
2535
2536 /* Activity on thread quit pipe, exiting. */
2537 if (pollfd == thread_quit_pipe_fd) {
2538 DBG("Activity on thread quit pipe");
2539 err = 0;
2540 goto exit;
2541 }
2542
2543 /* Event on the registration socket */
2544 if (revents & LPOLLIN) {
2545 continue;
2546 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
2547 ERR("Client socket poll error");
2548 goto error;
2549 } else {
2550 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
2551 goto error;
2552 }
2553 }
2554
2555 DBG("Wait for client response");
2556
2557 health_code_update();
2558
2559 sock = lttcomm_accept_unix_sock(client_sock);
2560 if (sock < 0) {
2561 goto error;
2562 }
2563
2564 /*
2565 * Set the CLOEXEC flag. Return code is useless because either way, the
2566 * show must go on.
2567 */
2568 (void) utils_set_fd_cloexec(sock);
2569
2570 /* Set socket option for credentials retrieval */
2571 ret = lttcomm_setsockopt_creds_unix_sock(sock);
2572 if (ret < 0) {
2573 goto error;
2574 }
2575
2576 health_code_update();
2577
2578 /*
2579 * Data is received from the lttng client. The struct
2580 * lttcomm_session_msg (lsm) contains the command and data request of
2581 * the client.
2582 */
2583 DBG("Receiving data from client ...");
2584 ret = lttcomm_recv_creds_unix_sock(
2585 sock, &cmd_ctx.lsm, sizeof(struct lttcomm_session_msg), &cmd_ctx.creds);
2586 if (ret != sizeof(struct lttcomm_session_msg)) {
2587 DBG("Incomplete recv() from client... continuing");
2588 ret = close(sock);
2589 if (ret) {
2590 PERROR("close");
2591 }
2592 sock = -1;
2593 continue;
2594 }
2595
2596 health_code_update();
2597
2598 // TODO: Validate cmd_ctx including sanity check for
2599 // security purpose.
2600
2601 rcu_thread_online();
2602 /*
2603 * This function dispatch the work to the kernel or userspace tracer
2604 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2605 * informations for the client. The command context struct contains
2606 * everything this function may needs.
2607 */
2608 try {
2609 ret = process_client_msg(&cmd_ctx, &sock, &sock_error);
2610 rcu_thread_offline();
2611 if (ret < 0) {
2612 if (sock >= 0) {
2613 ret = close(sock);
2614 if (ret) {
2615 PERROR("close");
2616 }
2617 }
2618 sock = -1;
2619 /*
2620 * TODO: Inform client somehow of the fatal error. At
2621 * this point, ret < 0 means that a zmalloc failed
2622 * (ENOMEM). Error detected but still accept
2623 * command, unless a socket error has been
2624 * detected.
2625 */
2626 continue;
2627 }
2628 } catch (const std::bad_alloc& ex) {
2629 WARN_FMT("Failed to allocate memory while handling client request: {}",
2630 ex.what());
2631 ret = LTTNG_ERR_NOMEM;
2632 } catch (const lttng::ctl::error& ex) {
2633 WARN_FMT("Client request failed: {}", ex.what());
2634 ret = ex.code();
2635 } catch (const std::exception& ex) {
2636 WARN_FMT("Client request failed: {}", ex.what());
2637 ret = LTTNG_ERR_UNK;
2638 }
2639
2640 if (ret < LTTNG_OK || ret >= LTTNG_ERR_NR) {
2641 WARN("Command returned an invalid status code, returning unknown error: "
2642 "command type = %s (%d), ret = %d",
2643 lttcomm_sessiond_command_str(
2644 (lttcomm_sessiond_command) cmd_ctx.lsm.cmd_type),
2645 cmd_ctx.lsm.cmd_type,
2646 ret);
2647 ret = LTTNG_ERR_UNK;
2648 }
2649
2650 cmd_completion_handler = cmd_pop_completion_handler();
2651 if (cmd_completion_handler) {
2652 enum lttng_error_code completion_code;
2653
2654 completion_code = cmd_completion_handler->run(cmd_completion_handler->data);
2655 if (completion_code != LTTNG_OK) {
2656 continue;
2657 }
2658 }
2659
2660 health_code_update();
2661
2662 if (sock >= 0) {
2663 struct lttng_payload_view view =
2664 lttng_payload_view_from_payload(&cmd_ctx.reply_payload, 0, -1);
2665 struct lttcomm_lttng_msg *llm =
2666 (typeof(llm)) cmd_ctx.reply_payload.buffer.data;
2667
2668 LTTNG_ASSERT(cmd_ctx.reply_payload.buffer.size >= sizeof(*llm));
2669 LTTNG_ASSERT(cmd_ctx.lttng_msg_size == cmd_ctx.reply_payload.buffer.size);
2670
2671 llm->fd_count = lttng_payload_view_get_fd_handle_count(&view);
2672
2673 DBG("Sending response (size: %d, retcode: %s (%d))",
2674 cmd_ctx.lttng_msg_size,
2675 lttng_strerror(-llm->ret_code),
2676 llm->ret_code);
2677 ret = send_unix_sock(sock, &view);
2678 if (ret < 0) {
2679 ERR("Failed to send data back to client");
2680 }
2681
2682 /* End of transmission */
2683 ret = close(sock);
2684 if (ret) {
2685 PERROR("close");
2686 }
2687 }
2688 sock = -1;
2689
2690 health_code_update();
2691 }
2692
2693 exit:
2694 error:
2695 if (sock >= 0) {
2696 ret = close(sock);
2697 if (ret) {
2698 PERROR("close");
2699 }
2700 }
2701
2702 lttng_poll_clean(&events);
2703
2704 error_listen:
2705 error_create_poll:
2706 unlink(the_config.client_unix_sock_path.value);
2707 ret = close(client_sock);
2708 if (ret) {
2709 PERROR("close");
2710 }
2711
2712 if (err) {
2713 health_error();
2714 ERR("Health error occurred in %s", __func__);
2715 }
2716
2717 health_unregister(the_health_sessiond);
2718
2719 DBG("Client thread dying");
2720 lttng_payload_reset(&cmd_ctx.reply_payload);
2721 rcu_unregister_thread();
2722 return nullptr;
2723 }
2724
2725 static bool shutdown_client_thread(void *thread_data)
2726 {
2727 struct lttng_pipe *client_quit_pipe = (lttng_pipe *) thread_data;
2728 const int write_fd = lttng_pipe_get_writefd(client_quit_pipe);
2729
2730 return notify_thread_pipe(write_fd) == 1;
2731 }
2732
2733 struct lttng_thread *launch_client_thread()
2734 {
2735 bool thread_running;
2736 struct lttng_pipe *client_quit_pipe;
2737 struct lttng_thread *thread = nullptr;
2738 int client_sock_fd = -1;
2739
2740 sem_init(&thread_state.ready, 0, 0);
2741 client_quit_pipe = lttng_pipe_open(FD_CLOEXEC);
2742 if (!client_quit_pipe) {
2743 goto error;
2744 }
2745
2746 client_sock_fd = create_client_sock();
2747 if (client_sock_fd < 0) {
2748 goto error;
2749 }
2750
2751 thread_state.client_sock = client_sock_fd;
2752 thread = lttng_thread_create("Client management",
2753 thread_manage_clients,
2754 shutdown_client_thread,
2755 cleanup_client_thread,
2756 client_quit_pipe);
2757 if (!thread) {
2758 goto error;
2759 }
2760 /* The client thread now owns the client sock fd and the quit pipe. */
2761 client_sock_fd = -1;
2762 client_quit_pipe = nullptr;
2763
2764 /*
2765 * This thread is part of the threads that need to be fully
2766 * initialized before the session daemon is marked as "ready".
2767 */
2768 thread_running = wait_thread_status();
2769 if (!thread_running) {
2770 goto error;
2771 }
2772 return thread;
2773 error:
2774 if (client_sock_fd >= 0) {
2775 if (close(client_sock_fd)) {
2776 PERROR("Failed to close client socket");
2777 }
2778 }
2779 lttng_thread_put(thread);
2780 cleanup_client_thread(client_quit_pipe);
2781 return nullptr;
2782 }
This page took 0.124431 seconds and 4 git commands to generate.