2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
9 #include "sessiond-config.hpp"
10 #include "lttng-ust-ctl.hpp"
11 #include <common/defaults.hpp>
14 #include <common/error.hpp>
15 #include <common/utils.hpp>
16 #include <common/path.hpp>
17 #include <common/compat/errno.hpp>
18 #include <common/compat/getenv.hpp>
21 struct sessiond_config sessiond_config_build_defaults
= {
23 .verbose_consumer
= 0,
24 .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
,
38 .tracing_group_name
= { (char *) DEFAULT_TRACING_GROUP
, false },
40 .kmod_probes_list
= { nullptr, false },
41 .kmod_extra_probes_list
= { nullptr, false },
43 .rundir
= { nullptr, false },
45 .apps_unix_sock_path
= { nullptr, false },
46 .client_unix_sock_path
= { nullptr, false },
47 .wait_shm_path
= { nullptr, false },
48 .health_unix_sock_path
= { nullptr, false },
49 .lttng_ust_clock_plugin
= { nullptr, false },
50 .pid_file_path
= { nullptr, false },
51 .lock_file_path
= { nullptr, false },
52 .load_session_path
= { nullptr, false },
53 .agent_port_file_path
= { nullptr, false },
55 .consumerd32_path
= { nullptr, false },
56 .consumerd32_bin_path
= { nullptr, false },
57 .consumerd32_lib_dir
= { nullptr, false },
58 .consumerd32_err_unix_sock_path
= { nullptr, false },
59 .consumerd32_cmd_unix_sock_path
= { nullptr, false },
61 .consumerd64_path
= { nullptr, false },
62 .consumerd64_bin_path
= { nullptr, false },
63 .consumerd64_lib_dir
= { nullptr, false },
64 .consumerd64_err_unix_sock_path
= { nullptr, false },
65 .consumerd64_cmd_unix_sock_path
= { nullptr, false },
67 .kconsumerd_path
= { nullptr, false },
68 .kconsumerd_err_unix_sock_path
= { nullptr, false },
69 .kconsumerd_cmd_unix_sock_path
= { nullptr, false },
73 void config_string_fini(struct config_string
*str
)
75 config_string_set(str
, NULL
);
79 void config_string_set_static(struct config_string
*config_str
,
82 config_string_set(config_str
, (char *) value
);
83 config_str
->should_free
= false;
86 /* Only use for dynamically-allocated strings. */
87 void config_string_set(struct config_string
*config_str
, char *value
)
89 LTTNG_ASSERT(config_str
);
90 if (config_str
->should_free
) {
91 free(config_str
->value
);
92 config_str
->should_free
= false;
95 config_str
->should_free
= !!value
;
96 config_str
->value
= value
;
99 int sessiond_config_apply_env_config(struct sessiond_config
*config
)
102 const char *env_value
;
104 env_value
= getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
110 int_val
= strtoul(env_value
, &endptr
, 0);
111 if (errno
!= 0 || int_val
> INT_MAX
||
112 (int_val
< 0 && int_val
!= -1)) {
113 ERR("Invalid value \"%s\" used for \"%s\" environment variable",
114 env_value
, DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
119 config
->app_socket_timeout
= int_val
;
122 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD32_BIN");
124 config_string_set_static(&config
->consumerd32_bin_path
,
127 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD64_BIN");
129 config_string_set_static(&config
->consumerd64_bin_path
,
133 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD32_LIBDIR");
135 config_string_set_static(&config
->consumerd32_lib_dir
,
138 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD64_LIBDIR");
140 config_string_set_static(&config
->consumerd64_lib_dir
,
144 env_value
= lttng_secure_getenv("LTTNG_UST_CLOCK_PLUGIN");
146 config_string_set_static(&config
->lttng_ust_clock_plugin
,
150 env_value
= lttng_secure_getenv(DEFAULT_LTTNG_KMOD_PROBES
);
152 config_string_set_static(&config
->kmod_probes_list
,
156 env_value
= lttng_secure_getenv(DEFAULT_LTTNG_EXTRA_KMOD_PROBES
);
158 config_string_set_static(&config
->kmod_extra_probes_list
,
166 int config_set_paths_root(struct sessiond_config
*config
)
170 config_string_set(&config
->rundir
, strdup(DEFAULT_LTTNG_RUNDIR
));
171 if (!config
->rundir
.value
) {
172 ERR("Failed to set rundir");
177 config_string_set_static(&config
->apps_unix_sock_path
,
178 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
179 config_string_set_static(&config
->client_unix_sock_path
,
180 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
181 config_string_set_static(&config
->wait_shm_path
,
182 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
183 config_string_set_static(&config
->health_unix_sock_path
,
184 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
190 int config_set_paths_non_root(struct sessiond_config
*config
)
193 const char *home_path
= utils_get_home_dir();
196 if (home_path
== NULL
) {
197 ERR("Can't get HOME directory for sockets creation.");
203 * Create rundir from home path. This will create something like
206 ret
= asprintf(&str
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
208 ERR("Failed to set rundir");
211 config_string_set(&config
->rundir
, str
);
214 ret
= asprintf(&str
, DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
216 ERR("Failed to set default home apps unix socket path");
219 config_string_set(&config
->apps_unix_sock_path
, str
);
222 ret
= asprintf(&str
, DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
224 ERR("Failed to set default home client unix socket path");
227 config_string_set(&config
->client_unix_sock_path
, str
);
230 ret
= asprintf(&str
, DEFAULT_HOME_APPS_WAIT_SHM_PATH
, getuid());
232 ERR("Failed to set default home apps wait shm path");
235 config_string_set(&config
->wait_shm_path
, str
);
238 ret
= asprintf(&str
, DEFAULT_HOME_HEALTH_UNIX_SOCK
, home_path
);
240 ERR("Failed to set default home health UNIX socket path");
243 config_string_set(&config
->health_unix_sock_path
, str
);
251 int sessiond_config_init(struct sessiond_config
*config
)
254 bool is_root
= (getuid() == 0);
257 LTTNG_ASSERT(config
);
258 memcpy(config
, &sessiond_config_build_defaults
, sizeof(*config
));
261 ret
= config_set_paths_root(config
);
263 ret
= config_set_paths_non_root(config
);
269 /* 32 bits consumerd path setup */
270 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD32_PATH
,
271 config
->rundir
.value
);
273 ERR("Failed to set 32-bit consumer path");
276 config_string_set(&config
->consumerd32_path
, str
);
279 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
280 config
->rundir
.value
);
282 ERR("Failed to set 32-bit consumer error socket path");
285 config_string_set(&config
->consumerd32_err_unix_sock_path
, str
);
288 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
289 config
->rundir
.value
);
291 ERR("Failed to set 32-bit consumer command socket path");
294 config_string_set(&config
->consumerd32_cmd_unix_sock_path
, str
);
297 /* 64 bits consumerd path setup */
298 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD64_PATH
,
299 config
->rundir
.value
);
301 ERR("Failed to set 64-bit consumer path");
304 config_string_set(&config
->consumerd64_path
, str
);
307 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
308 config
->rundir
.value
);
310 ERR("Failed to set 64-bit consumer error socket path");
313 config_string_set(&config
->consumerd64_err_unix_sock_path
, str
);
316 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
317 config
->rundir
.value
);
319 ERR("Failed to set 64-bit consumer command socket path");
322 config_string_set(&config
->consumerd64_cmd_unix_sock_path
, str
);
325 /* kconsumerd consumerd path setup */
326 ret
= asprintf(&str
, DEFAULT_KCONSUMERD_PATH
,
327 config
->rundir
.value
);
329 ERR("Failed to set kernel consumer path");
332 config_string_set(&config
->kconsumerd_path
, str
);
335 ret
= asprintf(&str
, DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
336 config
->rundir
.value
);
338 ERR("Failed to set kernel consumer error socket path");
341 config_string_set(&config
->kconsumerd_err_unix_sock_path
, str
);
344 ret
= asprintf(&str
, DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
345 config
->rundir
.value
);
347 ERR("Failed to set kernel consumer command socket path");
350 config_string_set(&config
->kconsumerd_cmd_unix_sock_path
, str
);
353 ret
= asprintf(&str
, "%s/%s", config
->rundir
.value
,
354 DEFAULT_LTTNG_SESSIOND_PIDFILE
);
356 ERR("Failed to set PID file path");
359 config_string_set(&config
->pid_file_path
, str
);
362 ret
= asprintf(&str
, "%s/%s", config
->rundir
.value
,
363 DEFAULT_LTTNG_SESSIOND_LOCKFILE
);
365 ERR("Failed to set lock file path");
368 config_string_set(&config
->lock_file_path
, str
);
371 ret
= asprintf(&str
, "%s/%s", config
->rundir
.value
,
372 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
);
374 ERR("Failed to set agent port file path");
377 config_string_set(&config
->agent_port_file_path
, str
);
381 * Allow INSTALL_BIN_PATH to be used as a target path for the
382 * native architecture size consumer if CONFIG_CONSUMER*_PATH
383 * has not been defined.
385 #if (CAA_BITS_PER_LONG == 32)
386 config_string_set_static(&config
->consumerd32_bin_path
,
387 INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
);
388 config_string_set_static(&config
->consumerd32_lib_dir
,
390 #elif (CAA_BITS_PER_LONG == 64)
391 config_string_set_static(&config
->consumerd64_bin_path
,
392 INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
);
393 config_string_set_static(&config
->consumerd64_lib_dir
,
396 #error "Unknown bitness"
401 sessiond_config_fini(config
);
405 void sessiond_config_fini(struct sessiond_config
*config
)
407 config_string_fini(&config
->tracing_group_name
);
408 config_string_fini(&config
->kmod_probes_list
);
409 config_string_fini(&config
->kmod_extra_probes_list
);
410 config_string_fini(&config
->rundir
);
411 config_string_fini(&config
->apps_unix_sock_path
);
412 config_string_fini(&config
->client_unix_sock_path
);
413 config_string_fini(&config
->wait_shm_path
);
414 config_string_fini(&config
->health_unix_sock_path
);
415 config_string_fini(&config
->lttng_ust_clock_plugin
);
416 config_string_fini(&config
->pid_file_path
);
417 config_string_fini(&config
->lock_file_path
);
418 config_string_fini(&config
->load_session_path
);
419 config_string_fini(&config
->agent_port_file_path
);
420 config_string_fini(&config
->consumerd32_path
);
421 config_string_fini(&config
->consumerd32_bin_path
);
422 config_string_fini(&config
->consumerd32_lib_dir
);
423 config_string_fini(&config
->consumerd32_err_unix_sock_path
);
424 config_string_fini(&config
->consumerd32_cmd_unix_sock_path
);
425 config_string_fini(&config
->consumerd64_path
);
426 config_string_fini(&config
->consumerd64_bin_path
);
427 config_string_fini(&config
->consumerd64_lib_dir
);
428 config_string_fini(&config
->consumerd64_err_unix_sock_path
);
429 config_string_fini(&config
->consumerd64_cmd_unix_sock_path
);
430 config_string_fini(&config
->kconsumerd_path
);
431 config_string_fini(&config
->kconsumerd_err_unix_sock_path
);
432 config_string_fini(&config
->kconsumerd_cmd_unix_sock_path
);
436 int resolve_path(struct config_string
*path
)
441 if (!path
->value
|| path
->value
[0] == '/') {
445 absolute_path
= utils_expand_path(path
->value
);
446 if (!absolute_path
) {
451 config_string_set(path
, absolute_path
);
456 #define RESOLVE_CHECK(path_config_str) \
457 if (resolve_path(path_config_str)) \
460 int sessiond_config_resolve_paths(struct sessiond_config
*config
)
462 RESOLVE_CHECK(&config
->apps_unix_sock_path
);
463 RESOLVE_CHECK(&config
->client_unix_sock_path
);
464 RESOLVE_CHECK(&config
->wait_shm_path
);
465 RESOLVE_CHECK(&config
->health_unix_sock_path
);
466 RESOLVE_CHECK(&config
->lttng_ust_clock_plugin
);
467 RESOLVE_CHECK(&config
->pid_file_path
);
468 RESOLVE_CHECK(&config
->lock_file_path
);
469 RESOLVE_CHECK(&config
->load_session_path
);
470 RESOLVE_CHECK(&config
->agent_port_file_path
);
471 RESOLVE_CHECK(&config
->consumerd32_path
);
472 RESOLVE_CHECK(&config
->consumerd32_bin_path
);
473 RESOLVE_CHECK(&config
->consumerd32_lib_dir
);
474 RESOLVE_CHECK(&config
->consumerd32_err_unix_sock_path
);
475 RESOLVE_CHECK(&config
->consumerd32_cmd_unix_sock_path
);
476 RESOLVE_CHECK(&config
->consumerd64_path
);
477 RESOLVE_CHECK(&config
->consumerd64_bin_path
);
478 RESOLVE_CHECK(&config
->consumerd64_lib_dir
);
479 RESOLVE_CHECK(&config
->consumerd64_err_unix_sock_path
);
480 RESOLVE_CHECK(&config
->consumerd64_cmd_unix_sock_path
);
481 RESOLVE_CHECK(&config
->kconsumerd_path
);
482 RESOLVE_CHECK(&config
->kconsumerd_err_unix_sock_path
);
483 RESOLVE_CHECK(&config
->kconsumerd_cmd_unix_sock_path
);
487 void sessiond_config_log(struct sessiond_config
*config
)
489 DBG_NO_LOC("[sessiond configuration]");
490 DBG_NO_LOC("\tversion %s", VERSION
);
491 if (GIT_VERSION
[0] != '\0') {
492 DBG_NO_LOC("\tgit version %s", GIT_VERSION
);
494 if (EXTRA_VERSION_NAME
[0] != '\0') {
495 DBG_NO_LOC("\textra version name %s", EXTRA_VERSION_NAME
);
497 if (EXTRA_VERSION_DESCRIPTION
[0] != '\0') {
498 DBG_NO_LOC("\textra version description:\n\t%s", EXTRA_VERSION_DESCRIPTION
);
500 if (EXTRA_VERSION_PATCHES
[0] != '\0') {
501 DBG_NO_LOC("\textra version patches:\n\t%s", EXTRA_VERSION_PATCHES
);
503 DBG_NO_LOC("\tverbose: %i", config
->verbose
);
504 DBG_NO_LOC("\tverbose consumer: %i", config
->verbose_consumer
);
505 DBG_NO_LOC("\tquiet mode: %s", config
->quiet
? "True" : "False");
506 if (config
->agent_tcp_port
.begin
== config
->agent_tcp_port
.end
) {
507 DBG_NO_LOC("\tagent_tcp_port: %i", config
->agent_tcp_port
.begin
);
509 DBG_NO_LOC("\tagent_tcp_port: [%i, %i]",
510 config
->agent_tcp_port
.begin
,
511 config
->agent_tcp_port
.end
);
513 DBG_NO_LOC("\tapplication socket timeout: %i", config
->app_socket_timeout
);
514 DBG_NO_LOC("\tno-kernel: %s", config
->no_kernel
? "True" : "False");
515 DBG_NO_LOC("\tbackground: %s", config
->background
? "True" : "False");
516 DBG_NO_LOC("\tdaemonize: %s", config
->daemonize
? "True" : "False");
517 DBG_NO_LOC("\tsignal parent on start: %s", config
->sig_parent
? "True" : "False");
518 DBG_NO_LOC("\ttracing group name: %s", config
->tracing_group_name
.value
? : "Unknown");
519 DBG_NO_LOC("\tkmod_probe_list: %s", config
->kmod_probes_list
.value
? : "None");
520 DBG_NO_LOC("\tkmod_extra_probe_list: %s", config
->kmod_extra_probes_list
.value
? : "None");
521 DBG_NO_LOC("\trundir: %s", config
->rundir
.value
? : "Unknown");
522 DBG_NO_LOC("\tapplication socket path: %s", config
->apps_unix_sock_path
.value
? : "Unknown");
523 DBG_NO_LOC("\tclient socket path: %s", config
->client_unix_sock_path
.value
? : "Unknown");
524 DBG_NO_LOC("\twait shm path: %s", config
->wait_shm_path
.value
? : "Unknown");
525 DBG_NO_LOC("\thealth socket path: %s", config
->health_unix_sock_path
.value
? : "Unknown");
526 DBG_NO_LOC("\tLTTNG_UST_CLOCK_PLUGIN: %s", config
->lttng_ust_clock_plugin
.value
? : "None");
527 DBG_NO_LOC("\tpid file path: %s", config
->pid_file_path
.value
? : "Unknown");
528 DBG_NO_LOC("\tlock file path: %s", config
->lock_file_path
.value
? : "Unknown");
529 DBG_NO_LOC("\tsession load path: %s", config
->load_session_path
.value
? : "None");
530 DBG_NO_LOC("\tagent port file path: %s", config
->agent_port_file_path
.value
? : "Unknown");
531 DBG_NO_LOC("\tconsumerd32 path: %s", config
->consumerd32_path
.value
? : "Unknown");
532 DBG_NO_LOC("\tconsumerd32 bin path: %s", config
->consumerd32_bin_path
.value
? : "Unknown");
533 DBG_NO_LOC("\tconsumerd32 lib dir: %s", config
->consumerd32_lib_dir
.value
? : "Unknown");
534 DBG_NO_LOC("\tconsumerd32 err unix sock path:%s", config
->consumerd32_err_unix_sock_path
.value
? : "Unknown");
535 DBG_NO_LOC("\tconsumerd32 cmd unix sock path:%s", config
->consumerd32_cmd_unix_sock_path
.value
? : "Unknown");
536 DBG_NO_LOC("\tconsumerd64 path: %s", config
->consumerd64_path
.value
? : "Unknown");
537 DBG_NO_LOC("\tconsumerd64 bin path: %s", config
->consumerd64_bin_path
.value
? : "Unknown");
538 DBG_NO_LOC("\tconsumerd64 lib dir: %s", config
->consumerd64_lib_dir
.value
? : "Unknown");
539 DBG_NO_LOC("\tconsumerd64 err unix sock path:%s", config
->consumerd64_err_unix_sock_path
.value
? : "Unknown");
540 DBG_NO_LOC("\tconsumerd64 cmd unix sock path:%s", config
->consumerd64_cmd_unix_sock_path
.value
? : "Unknown");
541 DBG_NO_LOC("\tkconsumerd path: %s", config
->kconsumerd_path
.value
? : "Unknown");
542 DBG_NO_LOC("\tkconsumerd err unix sock path: %s", config
->kconsumerd_err_unix_sock_path
.value
? : "Unknown");
543 DBG_NO_LOC("\tkconsumerd cmd unix sock path: %s", config
->kconsumerd_cmd_unix_sock_path
.value
? : "Unknown");