2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
9 #include "sessiond-config.h"
10 #include "lttng-ust-ctl.h"
11 #include <common/defaults.h>
14 #include <common/error.h>
15 #include <common/utils.h>
16 #include <common/compat/errno.h>
17 #include <common/compat/getenv.h>
20 struct sessiond_config sessiond_config_build_defaults
= {
23 .verbose_consumer
= 0,
25 .agent_tcp_port
= { .begin
= DEFAULT_AGENT_TCP_PORT_RANGE_BEGIN
, .end
= DEFAULT_AGENT_TCP_PORT_RANGE_END
},
26 .event_notifier_buffer_size_kernel
= DEFAULT_EVENT_NOTIFIER_ERROR_COUNT_MAP_SIZE
,
27 .event_notifier_buffer_size_userspace
= DEFAULT_EVENT_NOTIFIER_ERROR_COUNT_MAP_SIZE
,
28 .app_socket_timeout
= DEFAULT_APP_SOCKET_RW_TIMEOUT
,
35 .tracing_group_name
.value
= (char *) DEFAULT_TRACING_GROUP
,
36 .kmod_probes_list
.value
= NULL
,
37 .kmod_extra_probes_list
.value
= NULL
,
41 .apps_unix_sock_path
.value
= NULL
,
42 .client_unix_sock_path
.value
= NULL
,
43 .wait_shm_path
.value
= NULL
,
44 .health_unix_sock_path
.value
= NULL
,
45 .lttng_ust_clock_plugin
.value
= NULL
,
46 .pid_file_path
.value
= NULL
,
47 .lock_file_path
.value
= NULL
,
48 .agent_port_file_path
.value
= NULL
,
49 .load_session_path
.value
= NULL
,
51 .consumerd32_path
.value
= NULL
,
52 .consumerd32_bin_path
.value
= NULL
,
53 .consumerd32_lib_dir
.value
= NULL
,
54 .consumerd32_err_unix_sock_path
.value
= NULL
,
55 .consumerd32_cmd_unix_sock_path
.value
= NULL
,
57 .consumerd64_path
.value
= NULL
,
58 .consumerd64_bin_path
.value
= NULL
,
59 .consumerd64_lib_dir
.value
= NULL
,
60 .consumerd64_err_unix_sock_path
.value
= NULL
,
61 .consumerd64_cmd_unix_sock_path
.value
= NULL
,
63 .kconsumerd_path
.value
= NULL
,
64 .kconsumerd_err_unix_sock_path
.value
= NULL
,
65 .kconsumerd_cmd_unix_sock_path
.value
= NULL
,
69 void config_string_fini(struct config_string
*str
)
71 config_string_set(str
, NULL
);
75 void config_string_set_static(struct config_string
*config_str
,
78 config_string_set(config_str
, (char *) value
);
79 config_str
->should_free
= false;
82 /* Only use for dynamically-allocated strings. */
83 void config_string_set(struct config_string
*config_str
, char *value
)
85 LTTNG_ASSERT(config_str
);
86 if (config_str
->should_free
) {
87 free(config_str
->value
);
88 config_str
->should_free
= false;
91 config_str
->should_free
= !!value
;
92 config_str
->value
= value
;
95 int sessiond_config_apply_env_config(struct sessiond_config
*config
)
98 const char *env_value
;
100 env_value
= getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
106 int_val
= strtoul(env_value
, &endptr
, 0);
107 if (errno
!= 0 || int_val
> INT_MAX
||
108 (int_val
< 0 && int_val
!= -1)) {
109 ERR("Invalid value \"%s\" used for \"%s\" environment variable",
110 env_value
, DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
115 config
->app_socket_timeout
= int_val
;
118 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD32_BIN");
120 config_string_set_static(&config
->consumerd32_bin_path
,
123 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD64_BIN");
125 config_string_set_static(&config
->consumerd64_bin_path
,
129 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD32_LIBDIR");
131 config_string_set_static(&config
->consumerd32_lib_dir
,
134 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD64_LIBDIR");
136 config_string_set_static(&config
->consumerd64_lib_dir
,
140 env_value
= lttng_secure_getenv("LTTNG_UST_CLOCK_PLUGIN");
142 config_string_set_static(&config
->lttng_ust_clock_plugin
,
146 env_value
= lttng_secure_getenv(DEFAULT_LTTNG_KMOD_PROBES
);
148 config_string_set_static(&config
->kmod_probes_list
,
152 env_value
= lttng_secure_getenv(DEFAULT_LTTNG_EXTRA_KMOD_PROBES
);
154 config_string_set_static(&config
->kmod_extra_probes_list
,
162 int config_set_paths_root(struct sessiond_config
*config
)
166 config_string_set(&config
->rundir
, strdup(DEFAULT_LTTNG_RUNDIR
));
167 if (!config
->rundir
.value
) {
168 ERR("Failed to set rundir");
173 config_string_set_static(&config
->apps_unix_sock_path
,
174 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
175 config_string_set_static(&config
->client_unix_sock_path
,
176 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
177 config_string_set_static(&config
->wait_shm_path
,
178 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
179 config_string_set_static(&config
->health_unix_sock_path
,
180 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
186 int config_set_paths_non_root(struct sessiond_config
*config
)
189 const char *home_path
= utils_get_home_dir();
192 if (home_path
== NULL
) {
193 ERR("Can't get HOME directory for sockets creation.");
199 * Create rundir from home path. This will create something like
202 ret
= asprintf(&str
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
204 ERR("Failed to set rundir");
207 config_string_set(&config
->rundir
, str
);
210 ret
= asprintf(&str
, DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
212 ERR("Failed to set default home apps unix socket path");
215 config_string_set(&config
->apps_unix_sock_path
, str
);
218 ret
= asprintf(&str
, DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
220 ERR("Failed to set default home client unix socket path");
223 config_string_set(&config
->client_unix_sock_path
, str
);
226 ret
= asprintf(&str
, DEFAULT_HOME_APPS_WAIT_SHM_PATH
, getuid());
228 ERR("Failed to set default home apps wait shm path");
231 config_string_set(&config
->wait_shm_path
, str
);
234 ret
= asprintf(&str
, DEFAULT_HOME_HEALTH_UNIX_SOCK
, home_path
);
236 ERR("Failed to set default home health UNIX socket path");
239 config_string_set(&config
->health_unix_sock_path
, str
);
247 int sessiond_config_init(struct sessiond_config
*config
)
250 bool is_root
= (getuid() == 0);
253 LTTNG_ASSERT(config
);
254 memcpy(config
, &sessiond_config_build_defaults
, sizeof(*config
));
257 ret
= config_set_paths_root(config
);
259 ret
= config_set_paths_non_root(config
);
265 /* 32 bits consumerd path setup */
266 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD32_PATH
,
267 config
->rundir
.value
);
269 ERR("Failed to set 32-bit consumer path");
272 config_string_set(&config
->consumerd32_path
, str
);
275 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
276 config
->rundir
.value
);
278 ERR("Failed to set 32-bit consumer error socket path");
281 config_string_set(&config
->consumerd32_err_unix_sock_path
, str
);
284 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
285 config
->rundir
.value
);
287 ERR("Failed to set 32-bit consumer command socket path");
290 config_string_set(&config
->consumerd32_cmd_unix_sock_path
, str
);
293 /* 64 bits consumerd path setup */
294 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD64_PATH
,
295 config
->rundir
.value
);
297 ERR("Failed to set 64-bit consumer path");
300 config_string_set(&config
->consumerd64_path
, str
);
303 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
304 config
->rundir
.value
);
306 ERR("Failed to set 64-bit consumer error socket path");
309 config_string_set(&config
->consumerd64_err_unix_sock_path
, str
);
312 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
313 config
->rundir
.value
);
315 ERR("Failed to set 64-bit consumer command socket path");
318 config_string_set(&config
->consumerd64_cmd_unix_sock_path
, str
);
321 /* kconsumerd consumerd path setup */
322 ret
= asprintf(&str
, DEFAULT_KCONSUMERD_PATH
,
323 config
->rundir
.value
);
325 ERR("Failed to set kernel consumer path");
328 config_string_set(&config
->kconsumerd_path
, str
);
331 ret
= asprintf(&str
, DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
332 config
->rundir
.value
);
334 ERR("Failed to set kernel consumer error socket path");
337 config_string_set(&config
->kconsumerd_err_unix_sock_path
, str
);
340 ret
= asprintf(&str
, DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
341 config
->rundir
.value
);
343 ERR("Failed to set kernel consumer command socket path");
346 config_string_set(&config
->kconsumerd_cmd_unix_sock_path
, str
);
349 ret
= asprintf(&str
, "%s/%s", config
->rundir
.value
,
350 DEFAULT_LTTNG_SESSIOND_PIDFILE
);
352 ERR("Failed to set PID file path");
355 config_string_set(&config
->pid_file_path
, str
);
358 ret
= asprintf(&str
, "%s/%s", config
->rundir
.value
,
359 DEFAULT_LTTNG_SESSIOND_LOCKFILE
);
361 ERR("Failed to set lock file path");
364 config_string_set(&config
->lock_file_path
, str
);
367 ret
= asprintf(&str
, "%s/%s", config
->rundir
.value
,
368 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
);
370 ERR("Failed to set agent port file path");
373 config_string_set(&config
->agent_port_file_path
, str
);
377 * Allow INSTALL_BIN_PATH to be used as a target path for the
378 * native architecture size consumer if CONFIG_CONSUMER*_PATH
379 * has not been defined.
381 #if (CAA_BITS_PER_LONG == 32)
382 config_string_set_static(&config
->consumerd32_bin_path
,
383 INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
);
384 config_string_set_static(&config
->consumerd32_lib_dir
,
386 #elif (CAA_BITS_PER_LONG == 64)
387 config_string_set_static(&config
->consumerd64_bin_path
,
388 INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
);
389 config_string_set_static(&config
->consumerd64_lib_dir
,
392 #error "Unknown bitness"
397 sessiond_config_fini(config
);
401 void sessiond_config_fini(struct sessiond_config
*config
)
403 config_string_fini(&config
->tracing_group_name
);
404 config_string_fini(&config
->kmod_probes_list
);
405 config_string_fini(&config
->kmod_extra_probes_list
);
406 config_string_fini(&config
->rundir
);
407 config_string_fini(&config
->apps_unix_sock_path
);
408 config_string_fini(&config
->client_unix_sock_path
);
409 config_string_fini(&config
->wait_shm_path
);
410 config_string_fini(&config
->health_unix_sock_path
);
411 config_string_fini(&config
->lttng_ust_clock_plugin
);
412 config_string_fini(&config
->pid_file_path
);
413 config_string_fini(&config
->lock_file_path
);
414 config_string_fini(&config
->load_session_path
);
415 config_string_fini(&config
->agent_port_file_path
);
416 config_string_fini(&config
->consumerd32_path
);
417 config_string_fini(&config
->consumerd32_bin_path
);
418 config_string_fini(&config
->consumerd32_lib_dir
);
419 config_string_fini(&config
->consumerd32_err_unix_sock_path
);
420 config_string_fini(&config
->consumerd32_cmd_unix_sock_path
);
421 config_string_fini(&config
->consumerd64_path
);
422 config_string_fini(&config
->consumerd64_bin_path
);
423 config_string_fini(&config
->consumerd64_lib_dir
);
424 config_string_fini(&config
->consumerd64_err_unix_sock_path
);
425 config_string_fini(&config
->consumerd64_cmd_unix_sock_path
);
426 config_string_fini(&config
->kconsumerd_path
);
427 config_string_fini(&config
->kconsumerd_err_unix_sock_path
);
428 config_string_fini(&config
->kconsumerd_cmd_unix_sock_path
);
432 int resolve_path(struct config_string
*path
)
437 if (!path
->value
|| path
->value
[0] == '/') {
441 absolute_path
= utils_expand_path(path
->value
);
442 if (!absolute_path
) {
447 config_string_set(path
, absolute_path
);
452 #define RESOLVE_CHECK(path_config_str) \
453 if (resolve_path(path_config_str)) \
456 int sessiond_config_resolve_paths(struct sessiond_config
*config
)
458 RESOLVE_CHECK(&config
->apps_unix_sock_path
);
459 RESOLVE_CHECK(&config
->client_unix_sock_path
);
460 RESOLVE_CHECK(&config
->wait_shm_path
);
461 RESOLVE_CHECK(&config
->health_unix_sock_path
);
462 RESOLVE_CHECK(&config
->lttng_ust_clock_plugin
);
463 RESOLVE_CHECK(&config
->pid_file_path
);
464 RESOLVE_CHECK(&config
->lock_file_path
);
465 RESOLVE_CHECK(&config
->load_session_path
);
466 RESOLVE_CHECK(&config
->agent_port_file_path
);
467 RESOLVE_CHECK(&config
->consumerd32_path
);
468 RESOLVE_CHECK(&config
->consumerd32_bin_path
);
469 RESOLVE_CHECK(&config
->consumerd32_lib_dir
);
470 RESOLVE_CHECK(&config
->consumerd32_err_unix_sock_path
);
471 RESOLVE_CHECK(&config
->consumerd32_cmd_unix_sock_path
);
472 RESOLVE_CHECK(&config
->consumerd64_path
);
473 RESOLVE_CHECK(&config
->consumerd64_bin_path
);
474 RESOLVE_CHECK(&config
->consumerd64_lib_dir
);
475 RESOLVE_CHECK(&config
->consumerd64_err_unix_sock_path
);
476 RESOLVE_CHECK(&config
->consumerd64_cmd_unix_sock_path
);
477 RESOLVE_CHECK(&config
->kconsumerd_path
);
478 RESOLVE_CHECK(&config
->kconsumerd_err_unix_sock_path
);
479 RESOLVE_CHECK(&config
->kconsumerd_cmd_unix_sock_path
);
483 void sessiond_config_log(struct sessiond_config
*config
)
485 DBG_NO_LOC("[sessiond configuration]");
486 DBG_NO_LOC("\tversion %s", VERSION
);
487 if (GIT_VERSION
[0] != '\0') {
488 DBG_NO_LOC("\tgit version %s", GIT_VERSION
);
490 if (EXTRA_VERSION_NAME
[0] != '\0') {
491 DBG_NO_LOC("\textra version name %s", EXTRA_VERSION_NAME
);
493 if (EXTRA_VERSION_DESCRIPTION
[0] != '\0') {
494 DBG_NO_LOC("\textra version description:\n\t%s", EXTRA_VERSION_DESCRIPTION
);
496 if (EXTRA_VERSION_PATCHES
[0] != '\0') {
497 DBG_NO_LOC("\textra version patches:\n\t%s", EXTRA_VERSION_PATCHES
);
499 DBG_NO_LOC("\tverbose: %i", config
->verbose
);
500 DBG_NO_LOC("\tverbose consumer: %i", config
->verbose_consumer
);
501 DBG_NO_LOC("\tquiet mode: %s", config
->quiet
? "True" : "False");
502 if (config
->agent_tcp_port
.begin
== config
->agent_tcp_port
.end
) {
503 DBG_NO_LOC("\tagent_tcp_port: %i", config
->agent_tcp_port
.begin
);
505 DBG_NO_LOC("\tagent_tcp_port: [%i, %i]",
506 config
->agent_tcp_port
.begin
,
507 config
->agent_tcp_port
.end
);
509 DBG_NO_LOC("\tapplication socket timeout: %i", config
->app_socket_timeout
);
510 DBG_NO_LOC("\tno-kernel: %s", config
->no_kernel
? "True" : "False");
511 DBG_NO_LOC("\tbackground: %s", config
->background
? "True" : "False");
512 DBG_NO_LOC("\tdaemonize: %s", config
->daemonize
? "True" : "False");
513 DBG_NO_LOC("\tsignal parent on start: %s", config
->sig_parent
? "True" : "False");
514 DBG_NO_LOC("\ttracing group name: %s", config
->tracing_group_name
.value
? : "Unknown");
515 DBG_NO_LOC("\tkmod_probe_list: %s", config
->kmod_probes_list
.value
? : "None");
516 DBG_NO_LOC("\tkmod_extra_probe_list: %s", config
->kmod_extra_probes_list
.value
? : "None");
517 DBG_NO_LOC("\trundir: %s", config
->rundir
.value
? : "Unknown");
518 DBG_NO_LOC("\tapplication socket path: %s", config
->apps_unix_sock_path
.value
? : "Unknown");
519 DBG_NO_LOC("\tclient socket path: %s", config
->client_unix_sock_path
.value
? : "Unknown");
520 DBG_NO_LOC("\twait shm path: %s", config
->wait_shm_path
.value
? : "Unknown");
521 DBG_NO_LOC("\thealth socket path: %s", config
->health_unix_sock_path
.value
? : "Unknown");
522 DBG_NO_LOC("\tLTTNG_UST_CLOCK_PLUGIN: %s", config
->lttng_ust_clock_plugin
.value
? : "None");
523 DBG_NO_LOC("\tpid file path: %s", config
->pid_file_path
.value
? : "Unknown");
524 DBG_NO_LOC("\tlock file path: %s", config
->lock_file_path
.value
? : "Unknown");
525 DBG_NO_LOC("\tsession load path: %s", config
->load_session_path
.value
? : "None");
526 DBG_NO_LOC("\tagent port file path: %s", config
->agent_port_file_path
.value
? : "Unknown");
527 DBG_NO_LOC("\tconsumerd32 path: %s", config
->consumerd32_path
.value
? : "Unknown");
528 DBG_NO_LOC("\tconsumerd32 bin path: %s", config
->consumerd32_bin_path
.value
? : "Unknown");
529 DBG_NO_LOC("\tconsumerd32 lib dir: %s", config
->consumerd32_lib_dir
.value
? : "Unknown");
530 DBG_NO_LOC("\tconsumerd32 err unix sock path:%s", config
->consumerd32_err_unix_sock_path
.value
? : "Unknown");
531 DBG_NO_LOC("\tconsumerd32 cmd unix sock path:%s", config
->consumerd32_cmd_unix_sock_path
.value
? : "Unknown");
532 DBG_NO_LOC("\tconsumerd64 path: %s", config
->consumerd64_path
.value
? : "Unknown");
533 DBG_NO_LOC("\tconsumerd64 bin path: %s", config
->consumerd64_bin_path
.value
? : "Unknown");
534 DBG_NO_LOC("\tconsumerd64 lib dir: %s", config
->consumerd64_lib_dir
.value
? : "Unknown");
535 DBG_NO_LOC("\tconsumerd64 err unix sock path:%s", config
->consumerd64_err_unix_sock_path
.value
? : "Unknown");
536 DBG_NO_LOC("\tconsumerd64 cmd unix sock path:%s", config
->consumerd64_cmd_unix_sock_path
.value
? : "Unknown");
537 DBG_NO_LOC("\tkconsumerd path: %s", config
->kconsumerd_path
.value
? : "Unknown");
538 DBG_NO_LOC("\tkconsumerd err unix sock path: %s", config
->kconsumerd_err_unix_sock_path
.value
? : "Unknown");
539 DBG_NO_LOC("\tkconsumerd cmd unix sock path: %s", config
->kconsumerd_cmd_unix_sock_path
.value
? : "Unknown");