2 * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 #include "sessiond-config.h"
21 #include "lttng-ust-ctl.h"
22 #include <common/defaults.h>
26 #include <common/error.h>
27 #include <common/utils.h>
28 #include <common/compat/getenv.h>
31 struct sessiond_config sessiond_config_build_defaults
= {
34 .verbose_consumer
= 0,
36 .agent_tcp_port
= { .begin
= DEFAULT_AGENT_TCP_PORT_RANGE_BEGIN
, .end
= DEFAULT_AGENT_TCP_PORT_RANGE_END
},
37 .app_socket_timeout
= DEFAULT_APP_SOCKET_RW_TIMEOUT
,
44 .tracing_group_name
.value
= DEFAULT_TRACING_GROUP
,
45 .kmod_probes_list
.value
= NULL
,
46 .kmod_extra_probes_list
.value
= NULL
,
50 .apps_unix_sock_path
.value
= NULL
,
51 .client_unix_sock_path
.value
= NULL
,
52 .wait_shm_path
.value
= NULL
,
53 .health_unix_sock_path
.value
= NULL
,
54 .lttng_ust_clock_plugin
.value
= NULL
,
55 .pid_file_path
.value
= NULL
,
56 .lock_file_path
.value
= NULL
,
57 .agent_port_file_path
.value
= NULL
,
58 .load_session_path
.value
= NULL
,
60 .consumerd32_path
.value
= NULL
,
61 .consumerd32_bin_path
.value
= NULL
,
62 .consumerd32_lib_dir
.value
= NULL
,
63 .consumerd32_err_unix_sock_path
.value
= NULL
,
64 .consumerd32_cmd_unix_sock_path
.value
= NULL
,
66 .consumerd64_path
.value
= NULL
,
67 .consumerd64_bin_path
.value
= NULL
,
68 .consumerd64_lib_dir
.value
= NULL
,
69 .consumerd64_err_unix_sock_path
.value
= NULL
,
70 .consumerd64_cmd_unix_sock_path
.value
= NULL
,
72 .kconsumerd_path
.value
= NULL
,
73 .kconsumerd_err_unix_sock_path
.value
= NULL
,
74 .kconsumerd_cmd_unix_sock_path
.value
= NULL
,
78 void config_string_fini(struct config_string
*str
)
80 config_string_set(str
, NULL
);
84 void config_string_set_static(struct config_string
*config_str
,
87 config_string_set(config_str
, (char *) value
);
88 config_str
->should_free
= false;
91 /* Only use for dynamically-allocated strings. */
93 void config_string_set(struct config_string
*config_str
, char *value
)
96 if (config_str
->should_free
) {
97 free(config_str
->value
);
98 config_str
->should_free
= false;
101 config_str
->should_free
= !!value
;
102 config_str
->value
= value
;
106 int sessiond_config_apply_env_config(struct sessiond_config
*config
)
109 const char *env_value
;
111 env_value
= getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
117 int_val
= strtoul(env_value
, &endptr
, 0);
118 if (errno
!= 0 || int_val
> INT_MAX
||
119 (int_val
< 0 && int_val
!= -1)) {
120 ERR("Invalid value \"%s\" used for \"%s\" environment variable",
121 env_value
, DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
126 config
->app_socket_timeout
= int_val
;
129 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD32_BIN");
131 config_string_set_static(&config
->consumerd32_bin_path
,
134 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD64_BIN");
136 config_string_set_static(&config
->consumerd64_bin_path
,
140 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD32_LIBDIR");
142 config_string_set_static(&config
->consumerd32_lib_dir
,
145 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD64_LIBDIR");
147 config_string_set_static(&config
->consumerd64_lib_dir
,
151 env_value
= lttng_secure_getenv("LTTNG_UST_CLOCK_PLUGIN");
153 config_string_set_static(&config
->lttng_ust_clock_plugin
,
157 env_value
= lttng_secure_getenv(DEFAULT_LTTNG_KMOD_PROBES
);
159 config_string_set_static(&config
->kmod_probes_list
,
163 env_value
= lttng_secure_getenv(DEFAULT_LTTNG_EXTRA_KMOD_PROBES
);
165 config_string_set_static(&config
->kmod_extra_probes_list
,
173 int config_set_paths_root(struct sessiond_config
*config
)
177 config_string_set(&config
->rundir
, strdup(DEFAULT_LTTNG_RUNDIR
));
178 if (!config
->rundir
.value
) {
179 ERR("Failed to set rundir");
184 config_string_set_static(&config
->apps_unix_sock_path
,
185 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
186 config_string_set_static(&config
->client_unix_sock_path
,
187 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
188 config_string_set_static(&config
->wait_shm_path
,
189 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
190 config_string_set_static(&config
->health_unix_sock_path
,
191 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
197 int config_set_paths_non_root(struct sessiond_config
*config
)
200 const char *home_path
= utils_get_home_dir();
203 if (home_path
== NULL
) {
204 ERR("Can't get HOME directory for sockets creation.");
210 * Create rundir from home path. This will create something like
213 ret
= asprintf(&str
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
215 ERR("Failed to set rundir");
218 config_string_set(&config
->rundir
, str
);
221 ret
= asprintf(&str
, DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
223 ERR("Failed to set default home apps unix socket path");
226 config_string_set(&config
->apps_unix_sock_path
, str
);
229 ret
= asprintf(&str
, DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
231 ERR("Failed to set default home client unix socket path");
234 config_string_set(&config
->client_unix_sock_path
, str
);
237 ret
= asprintf(&str
, DEFAULT_HOME_APPS_WAIT_SHM_PATH
, getuid());
239 ERR("Failed to set default home apps wait shm path");
242 config_string_set(&config
->wait_shm_path
, str
);
245 ret
= asprintf(&str
, DEFAULT_HOME_HEALTH_UNIX_SOCK
, home_path
);
247 ERR("Failed to set default home health UNIX socket path");
250 config_string_set(&config
->health_unix_sock_path
, str
);
259 int sessiond_config_init(struct sessiond_config
*config
)
262 bool is_root
= (getuid() == 0);
266 memcpy(config
, &sessiond_config_build_defaults
, sizeof(*config
));
269 ret
= config_set_paths_root(config
);
271 ret
= config_set_paths_non_root(config
);
277 /* 32 bits consumerd path setup */
278 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD32_PATH
,
279 config
->rundir
.value
);
281 ERR("Failed to set 32-bit consumer path");
284 config_string_set(&config
->consumerd32_path
, str
);
287 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
288 config
->rundir
.value
);
290 ERR("Failed to set 32-bit consumer error socket path");
293 config_string_set(&config
->consumerd32_err_unix_sock_path
, str
);
296 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
297 config
->rundir
.value
);
299 ERR("Failed to set 32-bit consumer command socket path");
302 config_string_set(&config
->consumerd32_cmd_unix_sock_path
, str
);
305 /* 64 bits consumerd path setup */
306 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD64_PATH
,
307 config
->rundir
.value
);
309 ERR("Failed to set 64-bit consumer path");
312 config_string_set(&config
->consumerd64_path
, str
);
315 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
316 config
->rundir
.value
);
318 ERR("Failed to set 64-bit consumer error socket path");
321 config_string_set(&config
->consumerd64_err_unix_sock_path
, str
);
324 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
325 config
->rundir
.value
);
327 ERR("Failed to set 64-bit consumer command socket path");
330 config_string_set(&config
->consumerd64_cmd_unix_sock_path
, str
);
333 /* kconsumerd consumerd path setup */
334 ret
= asprintf(&str
, DEFAULT_KCONSUMERD_PATH
,
335 config
->rundir
.value
);
337 ERR("Failed to set kernel consumer path");
340 config_string_set(&config
->kconsumerd_path
, str
);
343 ret
= asprintf(&str
, DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
344 config
->rundir
.value
);
346 ERR("Failed to set kernel consumer error socket path");
349 config_string_set(&config
->kconsumerd_err_unix_sock_path
, str
);
352 ret
= asprintf(&str
, DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
353 config
->rundir
.value
);
355 ERR("Failed to set kernel consumer command socket path");
358 config_string_set(&config
->kconsumerd_cmd_unix_sock_path
, str
);
361 ret
= asprintf(&str
, "%s/%s", config
->rundir
.value
,
362 DEFAULT_LTTNG_SESSIOND_PIDFILE
);
364 ERR("Failed to set PID file path");
367 config_string_set(&config
->pid_file_path
, str
);
370 ret
= asprintf(&str
, "%s/%s", config
->rundir
.value
,
371 DEFAULT_LTTNG_SESSIOND_LOCKFILE
);
373 ERR("Failed to set lock file path");
376 config_string_set(&config
->lock_file_path
, str
);
379 ret
= asprintf(&str
, "%s/%s", config
->rundir
.value
,
380 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
);
382 ERR("Failed to set agent port file path");
385 config_string_set(&config
->agent_port_file_path
, str
);
389 * Allow INSTALL_BIN_PATH to be used as a target path for the
390 * native architecture size consumer if CONFIG_CONSUMER*_PATH
391 * has not been defined.
393 #if (CAA_BITS_PER_LONG == 32)
394 config_string_set_static(&config
->consumerd32_bin_path
,
395 INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
);
396 config_string_set_static(&config
->consumerd32_lib_dir
,
398 #elif (CAA_BITS_PER_LONG == 64)
399 config_string_set_static(&config
->consumerd64_bin_path
,
400 INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
);
401 config_string_set_static(&config
->consumerd64_lib_dir
,
404 #error "Unknown bitness"
409 sessiond_config_fini(config
);
414 void sessiond_config_fini(struct sessiond_config
*config
)
416 config_string_fini(&config
->tracing_group_name
);
417 config_string_fini(&config
->kmod_probes_list
);
418 config_string_fini(&config
->kmod_extra_probes_list
);
419 config_string_fini(&config
->rundir
);
420 config_string_fini(&config
->apps_unix_sock_path
);
421 config_string_fini(&config
->client_unix_sock_path
);
422 config_string_fini(&config
->wait_shm_path
);
423 config_string_fini(&config
->health_unix_sock_path
);
424 config_string_fini(&config
->lttng_ust_clock_plugin
);
425 config_string_fini(&config
->pid_file_path
);
426 config_string_fini(&config
->lock_file_path
);
427 config_string_fini(&config
->load_session_path
);
428 config_string_fini(&config
->agent_port_file_path
);
429 config_string_fini(&config
->consumerd32_path
);
430 config_string_fini(&config
->consumerd32_bin_path
);
431 config_string_fini(&config
->consumerd32_lib_dir
);
432 config_string_fini(&config
->consumerd32_err_unix_sock_path
);
433 config_string_fini(&config
->consumerd32_cmd_unix_sock_path
);
434 config_string_fini(&config
->consumerd64_path
);
435 config_string_fini(&config
->consumerd64_bin_path
);
436 config_string_fini(&config
->consumerd64_lib_dir
);
437 config_string_fini(&config
->consumerd64_err_unix_sock_path
);
438 config_string_fini(&config
->consumerd64_cmd_unix_sock_path
);
439 config_string_fini(&config
->kconsumerd_path
);
440 config_string_fini(&config
->kconsumerd_err_unix_sock_path
);
441 config_string_fini(&config
->kconsumerd_cmd_unix_sock_path
);
445 int resolve_path(struct config_string
*path
)
450 if (!path
->value
|| path
->value
[0] == '/') {
454 absolute_path
= utils_expand_path(path
->value
);
455 if (!absolute_path
) {
460 config_string_set(path
, absolute_path
);
465 #define RESOLVE_CHECK(path_config_str) \
466 if (resolve_path(path_config_str)) \
470 int sessiond_config_resolve_paths(struct sessiond_config
*config
)
472 RESOLVE_CHECK(&config
->apps_unix_sock_path
);
473 RESOLVE_CHECK(&config
->client_unix_sock_path
);
474 RESOLVE_CHECK(&config
->wait_shm_path
);
475 RESOLVE_CHECK(&config
->health_unix_sock_path
);
476 RESOLVE_CHECK(&config
->lttng_ust_clock_plugin
);
477 RESOLVE_CHECK(&config
->pid_file_path
);
478 RESOLVE_CHECK(&config
->lock_file_path
);
479 RESOLVE_CHECK(&config
->load_session_path
);
480 RESOLVE_CHECK(&config
->agent_port_file_path
);
481 RESOLVE_CHECK(&config
->consumerd32_path
);
482 RESOLVE_CHECK(&config
->consumerd32_bin_path
);
483 RESOLVE_CHECK(&config
->consumerd32_lib_dir
);
484 RESOLVE_CHECK(&config
->consumerd32_err_unix_sock_path
);
485 RESOLVE_CHECK(&config
->consumerd32_cmd_unix_sock_path
);
486 RESOLVE_CHECK(&config
->consumerd64_path
);
487 RESOLVE_CHECK(&config
->consumerd64_bin_path
);
488 RESOLVE_CHECK(&config
->consumerd64_lib_dir
);
489 RESOLVE_CHECK(&config
->consumerd64_err_unix_sock_path
);
490 RESOLVE_CHECK(&config
->consumerd64_cmd_unix_sock_path
);
491 RESOLVE_CHECK(&config
->kconsumerd_path
);
492 RESOLVE_CHECK(&config
->kconsumerd_err_unix_sock_path
);
493 RESOLVE_CHECK(&config
->kconsumerd_cmd_unix_sock_path
);
498 void sessiond_config_log(struct sessiond_config
*config
)
500 DBG_NO_LOC("[sessiond configuration]");
501 DBG_NO_LOC("\tversion %s", VERSION
);
502 if (GIT_VERSION
[0] != '\0') {
503 DBG_NO_LOC("\tgit version %s", GIT_VERSION
);
505 if (EXTRA_VERSION_NAME
[0] != '\0') {
506 DBG_NO_LOC("\textra version name %s", EXTRA_VERSION_NAME
);
508 if (EXTRA_VERSION_DESCRIPTION
[0] != '\0') {
509 DBG_NO_LOC("\textra version description:\n\t%s", EXTRA_VERSION_DESCRIPTION
);
511 if (EXTRA_VERSION_PATCHES
[0] != '\0') {
512 DBG_NO_LOC("\textra version patches:\n\t%s", EXTRA_VERSION_PATCHES
);
514 DBG_NO_LOC("\tverbose: %i", config
->verbose
);
515 DBG_NO_LOC("\tverbose consumer: %i", config
->verbose_consumer
);
516 DBG_NO_LOC("\tquiet mode: %s", config
->quiet
? "True" : "False");
517 if (config
->agent_tcp_port
.begin
== config
->agent_tcp_port
.end
) {
518 DBG_NO_LOC("\tagent_tcp_port: %i", config
->agent_tcp_port
.begin
);
520 DBG_NO_LOC("\tagent_tcp_port: [%i, %i]",
521 config
->agent_tcp_port
.begin
,
522 config
->agent_tcp_port
.end
);
524 DBG_NO_LOC("\tapplication socket timeout: %i", config
->app_socket_timeout
);
525 DBG_NO_LOC("\tno-kernel: %s", config
->no_kernel
? "True" : "False");
526 DBG_NO_LOC("\tbackground: %s", config
->background
? "True" : "False");
527 DBG_NO_LOC("\tdaemonize: %s", config
->daemonize
? "True" : "False");
528 DBG_NO_LOC("\tsignal parent on start: %s", config
->sig_parent
? "True" : "False");
529 DBG_NO_LOC("\ttracing group name: %s", config
->tracing_group_name
.value
? : "Unknown");
530 DBG_NO_LOC("\tkmod_probe_list: %s", config
->kmod_probes_list
.value
? : "None");
531 DBG_NO_LOC("\tkmod_extra_probe_list: %s", config
->kmod_extra_probes_list
.value
? : "None");
532 DBG_NO_LOC("\trundir: %s", config
->rundir
.value
? : "Unknown");
533 DBG_NO_LOC("\tapplication socket path: %s", config
->apps_unix_sock_path
.value
? : "Unknown");
534 DBG_NO_LOC("\tclient socket path: %s", config
->client_unix_sock_path
.value
? : "Unknown");
535 DBG_NO_LOC("\twait shm path: %s", config
->wait_shm_path
.value
? : "Unknown");
536 DBG_NO_LOC("\thealth socket path: %s", config
->health_unix_sock_path
.value
? : "Unknown");
537 DBG_NO_LOC("\tLTTNG_UST_CLOCK_PLUGIN: %s", config
->lttng_ust_clock_plugin
.value
? : "None");
538 DBG_NO_LOC("\tpid file path: %s", config
->pid_file_path
.value
? : "Unknown");
539 DBG_NO_LOC("\tlock file path: %s", config
->lock_file_path
.value
? : "Unknown");
540 DBG_NO_LOC("\tsession load path: %s", config
->load_session_path
.value
? : "None");
541 DBG_NO_LOC("\tagent port file path: %s", config
->agent_port_file_path
.value
? : "Unknown");
542 DBG_NO_LOC("\tconsumerd32 path: %s", config
->consumerd32_path
.value
? : "Unknown");
543 DBG_NO_LOC("\tconsumerd32 bin path: %s", config
->consumerd32_bin_path
.value
? : "Unknown");
544 DBG_NO_LOC("\tconsumerd32 lib dir: %s", config
->consumerd32_lib_dir
.value
? : "Unknown");
545 DBG_NO_LOC("\tconsumerd32 err unix sock path:%s", config
->consumerd32_err_unix_sock_path
.value
? : "Unknown");
546 DBG_NO_LOC("\tconsumerd32 cmd unix sock path:%s", config
->consumerd32_cmd_unix_sock_path
.value
? : "Unknown");
547 DBG_NO_LOC("\tconsumerd64 path: %s", config
->consumerd64_path
.value
? : "Unknown");
548 DBG_NO_LOC("\tconsumerd64 bin path: %s", config
->consumerd64_bin_path
.value
? : "Unknown");
549 DBG_NO_LOC("\tconsumerd64 lib dir: %s", config
->consumerd64_lib_dir
.value
? : "Unknown");
550 DBG_NO_LOC("\tconsumerd64 err unix sock path:%s", config
->consumerd64_err_unix_sock_path
.value
? : "Unknown");
551 DBG_NO_LOC("\tconsumerd64 cmd unix sock path:%s", config
->consumerd64_cmd_unix_sock_path
.value
? : "Unknown");
552 DBG_NO_LOC("\tkconsumerd path: %s", config
->kconsumerd_path
.value
? : "Unknown");
553 DBG_NO_LOC("\tkconsumerd err unix sock path: %s", config
->kconsumerd_err_unix_sock_path
.value
? : "Unknown");
554 DBG_NO_LOC("\tkconsumerd cmd unix sock path: %s", config
->kconsumerd_cmd_unix_sock_path
.value
? : "Unknown");