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.
18 #include "sessiond-config.h"
20 #include "lttng-ust-ctl.h"
21 #include <common/defaults.h>
25 #include <common/error.h>
26 #include <common/utils.h>
27 #include <common/compat/getenv.h>
30 struct sessiond_config sessiond_config_build_defaults
= {
33 .verbose_consumer
= 0,
35 .agent_tcp_port
= { .begin
= DEFAULT_AGENT_TCP_PORT_RANGE_BEGIN
, .end
= DEFAULT_AGENT_TCP_PORT_RANGE_END
},
36 .app_socket_timeout
= DEFAULT_APP_SOCKET_RW_TIMEOUT
,
43 .tracing_group_name
.value
= DEFAULT_TRACING_GROUP
,
44 .kmod_probes_list
.value
= NULL
,
45 .kmod_extra_probes_list
.value
= NULL
,
49 .apps_unix_sock_path
.value
= NULL
,
50 .client_unix_sock_path
.value
= NULL
,
51 .wait_shm_path
.value
= NULL
,
52 .health_unix_sock_path
.value
= NULL
,
53 .lttng_ust_clock_plugin
.value
= NULL
,
54 .pid_file_path
.value
= NULL
,
55 .lock_file_path
.value
= NULL
,
56 .agent_port_file_path
.value
= NULL
,
57 .load_session_path
.value
= NULL
,
59 .consumerd32_path
.value
= NULL
,
60 .consumerd32_bin_path
.value
= NULL
,
61 .consumerd32_lib_dir
.value
= NULL
,
62 .consumerd32_err_unix_sock_path
.value
= NULL
,
63 .consumerd32_cmd_unix_sock_path
.value
= NULL
,
65 .consumerd64_path
.value
= NULL
,
66 .consumerd64_bin_path
.value
= NULL
,
67 .consumerd64_lib_dir
.value
= NULL
,
68 .consumerd64_err_unix_sock_path
.value
= NULL
,
69 .consumerd64_cmd_unix_sock_path
.value
= NULL
,
71 .kconsumerd_path
.value
= NULL
,
72 .kconsumerd_err_unix_sock_path
.value
= NULL
,
73 .kconsumerd_cmd_unix_sock_path
.value
= NULL
,
77 void config_string_fini(struct config_string
*str
)
79 config_string_set(str
, NULL
);
83 void config_string_set_static(struct config_string
*config_str
,
86 config_string_set(config_str
, (char *) value
);
87 config_str
->should_free
= false;
90 /* Only use for dynamically-allocated strings. */
92 void config_string_set(struct config_string
*config_str
, char *value
)
95 if (config_str
->should_free
) {
96 free(config_str
->value
);
97 config_str
->should_free
= false;
100 config_str
->should_free
= !!value
;
101 config_str
->value
= value
;
105 int sessiond_config_apply_env_config(struct sessiond_config
*config
)
108 const char *env_value
;
110 env_value
= getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
116 int_val
= strtoul(env_value
, &endptr
, 0);
117 if (errno
!= 0 || int_val
> INT_MAX
||
118 (int_val
< 0 && int_val
!= -1)) {
119 ERR("Invalid value \"%s\" used for \"%s\" environment variable",
120 env_value
, DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
125 config
->app_socket_timeout
= int_val
;
128 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD32_BIN");
130 config_string_set_static(&config
->consumerd32_bin_path
,
133 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD64_BIN");
135 config_string_set_static(&config
->consumerd64_bin_path
,
139 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD32_LIBDIR");
141 config_string_set_static(&config
->consumerd32_lib_dir
,
144 env_value
= lttng_secure_getenv("LTTNG_CONSUMERD64_LIBDIR");
146 config_string_set_static(&config
->consumerd64_lib_dir
,
150 env_value
= lttng_secure_getenv("LTTNG_UST_CLOCK_PLUGIN");
152 config_string_set_static(&config
->lttng_ust_clock_plugin
,
156 env_value
= lttng_secure_getenv(DEFAULT_LTTNG_KMOD_PROBES
);
158 config_string_set_static(&config
->kmod_probes_list
,
162 env_value
= lttng_secure_getenv(DEFAULT_LTTNG_EXTRA_KMOD_PROBES
);
164 config_string_set_static(&config
->kmod_extra_probes_list
,
172 int config_set_paths_root(struct sessiond_config
*config
)
176 config_string_set(&config
->rundir
, strdup(DEFAULT_LTTNG_RUNDIR
));
177 if (!config
->rundir
.value
) {
178 ERR("Failed to set rundir");
183 config_string_set_static(&config
->apps_unix_sock_path
,
184 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
185 config_string_set_static(&config
->client_unix_sock_path
,
186 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
187 config_string_set_static(&config
->wait_shm_path
,
188 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
189 config_string_set_static(&config
->health_unix_sock_path
,
190 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
196 int config_set_paths_non_root(struct sessiond_config
*config
)
199 const char *home_path
= utils_get_home_dir();
202 if (home_path
== NULL
) {
203 ERR("Can't get HOME directory for sockets creation.");
209 * Create rundir from home path. This will create something like
212 ret
= asprintf(&str
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
214 ERR("Failed to set rundir");
217 config_string_set(&config
->rundir
, str
);
220 ret
= asprintf(&str
, DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
222 ERR("Failed to set default home apps unix socket path");
225 config_string_set(&config
->apps_unix_sock_path
, str
);
228 ret
= asprintf(&str
, DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
230 ERR("Failed to set default home client unix socket path");
233 config_string_set(&config
->client_unix_sock_path
, str
);
236 ret
= asprintf(&str
, DEFAULT_HOME_APPS_WAIT_SHM_PATH
, getuid());
238 ERR("Failed to set default home apps wait shm path");
241 config_string_set(&config
->wait_shm_path
, str
);
244 ret
= asprintf(&str
, DEFAULT_HOME_HEALTH_UNIX_SOCK
, home_path
);
246 ERR("Failed to set default home health UNIX socket path");
249 config_string_set(&config
->health_unix_sock_path
, str
);
258 int sessiond_config_init(struct sessiond_config
*config
)
261 bool is_root
= (getuid() == 0);
265 memcpy(config
, &sessiond_config_build_defaults
, sizeof(*config
));
268 ret
= config_set_paths_root(config
);
270 ret
= config_set_paths_non_root(config
);
276 /* 32 bits consumerd path setup */
277 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD32_PATH
,
278 config
->rundir
.value
);
280 ERR("Failed to set 32-bit consumer path");
283 config_string_set(&config
->consumerd32_path
, str
);
286 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
287 config
->rundir
.value
);
289 ERR("Failed to set 32-bit consumer error socket path");
292 config_string_set(&config
->consumerd32_err_unix_sock_path
, str
);
295 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
296 config
->rundir
.value
);
298 ERR("Failed to set 32-bit consumer command socket path");
301 config_string_set(&config
->consumerd32_cmd_unix_sock_path
, str
);
304 /* 64 bits consumerd path setup */
305 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD64_PATH
,
306 config
->rundir
.value
);
308 ERR("Failed to set 64-bit consumer path");
311 config_string_set(&config
->consumerd64_path
, str
);
314 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
315 config
->rundir
.value
);
317 ERR("Failed to set 64-bit consumer error socket path");
320 config_string_set(&config
->consumerd64_err_unix_sock_path
, str
);
323 ret
= asprintf(&str
, DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
324 config
->rundir
.value
);
326 ERR("Failed to set 64-bit consumer command socket path");
329 config_string_set(&config
->consumerd64_cmd_unix_sock_path
, str
);
332 /* kconsumerd consumerd path setup */
333 ret
= asprintf(&str
, DEFAULT_KCONSUMERD_PATH
,
334 config
->rundir
.value
);
336 ERR("Failed to set kernel consumer path");
339 config_string_set(&config
->kconsumerd_path
, str
);
342 ret
= asprintf(&str
, DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
343 config
->rundir
.value
);
345 ERR("Failed to set kernel consumer error socket path");
348 config_string_set(&config
->kconsumerd_err_unix_sock_path
, str
);
351 ret
= asprintf(&str
, DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
352 config
->rundir
.value
);
354 ERR("Failed to set kernel consumer command socket path");
357 config_string_set(&config
->kconsumerd_cmd_unix_sock_path
, str
);
360 ret
= asprintf(&str
, "%s/%s", config
->rundir
.value
,
361 DEFAULT_LTTNG_SESSIOND_PIDFILE
);
363 ERR("Failed to set PID file path");
366 config_string_set(&config
->pid_file_path
, str
);
369 ret
= asprintf(&str
, "%s/%s", config
->rundir
.value
,
370 DEFAULT_LTTNG_SESSIOND_LOCKFILE
);
372 ERR("Failed to set lock file path");
375 config_string_set(&config
->lock_file_path
, str
);
378 ret
= asprintf(&str
, "%s/%s", config
->rundir
.value
,
379 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
);
381 ERR("Failed to set agent port file path");
384 config_string_set(&config
->agent_port_file_path
, str
);
388 * Allow INSTALL_BIN_PATH to be used as a target path for the
389 * native architecture size consumer if CONFIG_CONSUMER*_PATH
390 * has not been defined.
392 #if (CAA_BITS_PER_LONG == 32)
393 config_string_set_static(&config
->consumerd32_bin_path
,
394 INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
);
395 config_string_set_static(&config
->consumerd32_lib_dir
,
397 #elif (CAA_BITS_PER_LONG == 64)
398 config_string_set_static(&config
->consumerd64_bin_path
,
399 INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
);
400 config_string_set_static(&config
->consumerd64_lib_dir
,
403 #error "Unknown bitness"
408 sessiond_config_fini(config
);
413 void sessiond_config_fini(struct sessiond_config
*config
)
415 config_string_fini(&config
->tracing_group_name
);
416 config_string_fini(&config
->kmod_probes_list
);
417 config_string_fini(&config
->kmod_extra_probes_list
);
418 config_string_fini(&config
->rundir
);
419 config_string_fini(&config
->apps_unix_sock_path
);
420 config_string_fini(&config
->client_unix_sock_path
);
421 config_string_fini(&config
->wait_shm_path
);
422 config_string_fini(&config
->health_unix_sock_path
);
423 config_string_fini(&config
->lttng_ust_clock_plugin
);
424 config_string_fini(&config
->pid_file_path
);
425 config_string_fini(&config
->lock_file_path
);
426 config_string_fini(&config
->load_session_path
);
427 config_string_fini(&config
->agent_port_file_path
);
428 config_string_fini(&config
->consumerd32_path
);
429 config_string_fini(&config
->consumerd32_bin_path
);
430 config_string_fini(&config
->consumerd32_lib_dir
);
431 config_string_fini(&config
->consumerd32_err_unix_sock_path
);
432 config_string_fini(&config
->consumerd32_cmd_unix_sock_path
);
433 config_string_fini(&config
->consumerd64_path
);
434 config_string_fini(&config
->consumerd64_bin_path
);
435 config_string_fini(&config
->consumerd64_lib_dir
);
436 config_string_fini(&config
->consumerd64_err_unix_sock_path
);
437 config_string_fini(&config
->consumerd64_cmd_unix_sock_path
);
438 config_string_fini(&config
->kconsumerd_path
);
439 config_string_fini(&config
->kconsumerd_err_unix_sock_path
);
440 config_string_fini(&config
->kconsumerd_cmd_unix_sock_path
);
444 int resolve_path(struct config_string
*path
)
449 if (!path
->value
|| path
->value
[0] == '/') {
453 absolute_path
= utils_expand_path(path
->value
);
454 if (!absolute_path
) {
459 config_string_set(path
, absolute_path
);
464 #define RESOLVE_CHECK(path_config_str) \
465 if (resolve_path(path_config_str)) \
469 int sessiond_config_resolve_paths(struct sessiond_config
*config
)
471 RESOLVE_CHECK(&config
->apps_unix_sock_path
);
472 RESOLVE_CHECK(&config
->client_unix_sock_path
);
473 RESOLVE_CHECK(&config
->wait_shm_path
);
474 RESOLVE_CHECK(&config
->health_unix_sock_path
);
475 RESOLVE_CHECK(&config
->lttng_ust_clock_plugin
);
476 RESOLVE_CHECK(&config
->pid_file_path
);
477 RESOLVE_CHECK(&config
->lock_file_path
);
478 RESOLVE_CHECK(&config
->load_session_path
);
479 RESOLVE_CHECK(&config
->agent_port_file_path
);
480 RESOLVE_CHECK(&config
->consumerd32_path
);
481 RESOLVE_CHECK(&config
->consumerd32_bin_path
);
482 RESOLVE_CHECK(&config
->consumerd32_lib_dir
);
483 RESOLVE_CHECK(&config
->consumerd32_err_unix_sock_path
);
484 RESOLVE_CHECK(&config
->consumerd32_cmd_unix_sock_path
);
485 RESOLVE_CHECK(&config
->consumerd64_path
);
486 RESOLVE_CHECK(&config
->consumerd64_bin_path
);
487 RESOLVE_CHECK(&config
->consumerd64_lib_dir
);
488 RESOLVE_CHECK(&config
->consumerd64_err_unix_sock_path
);
489 RESOLVE_CHECK(&config
->consumerd64_cmd_unix_sock_path
);
490 RESOLVE_CHECK(&config
->kconsumerd_path
);
491 RESOLVE_CHECK(&config
->kconsumerd_err_unix_sock_path
);
492 RESOLVE_CHECK(&config
->kconsumerd_cmd_unix_sock_path
);
497 void sessiond_config_log(struct sessiond_config
*config
)
499 DBG_NO_LOC("[sessiond configuration]");
500 DBG_NO_LOC("\tverbose: %i", config
->verbose
);
501 DBG_NO_LOC("\tverbose consumer: %i", config
->verbose_consumer
);
502 DBG_NO_LOC("\tquiet mode: %s", config
->quiet
? "True" : "False");
503 if (config
->agent_tcp_port
.begin
== config
->agent_tcp_port
.end
) {
504 DBG_NO_LOC("\tagent_tcp_port: %i", config
->agent_tcp_port
.begin
);
506 DBG_NO_LOC("\tagent_tcp_port: [%i, %i]",
507 config
->agent_tcp_port
.begin
,
508 config
->agent_tcp_port
.end
);
510 DBG_NO_LOC("\tapplication socket timeout: %i", config
->app_socket_timeout
);
511 DBG_NO_LOC("\tno-kernel: %s", config
->no_kernel
? "True" : "False");
512 DBG_NO_LOC("\tbackground: %s", config
->background
? "True" : "False");
513 DBG_NO_LOC("\tdaemonize: %s", config
->daemonize
? "True" : "False");
514 DBG_NO_LOC("\tsignal parent on start: %s", config
->sig_parent
? "True" : "False");
515 DBG_NO_LOC("\ttracing group name: %s", config
->tracing_group_name
.value
? : "Unknown");
516 DBG_NO_LOC("\tkmod_probe_list: %s", config
->kmod_probes_list
.value
? : "None");
517 DBG_NO_LOC("\tkmod_extra_probe_list: %s", config
->kmod_extra_probes_list
.value
? : "None");
518 DBG_NO_LOC("\trundir: %s", config
->rundir
.value
? : "Unknown");
519 DBG_NO_LOC("\tapplication socket path: %s", config
->apps_unix_sock_path
.value
? : "Unknown");
520 DBG_NO_LOC("\tclient socket path: %s", config
->client_unix_sock_path
.value
? : "Unknown");
521 DBG_NO_LOC("\twait shm path: %s", config
->wait_shm_path
.value
? : "Unknown");
522 DBG_NO_LOC("\thealth socket path: %s", config
->health_unix_sock_path
.value
? : "Unknown");
523 DBG_NO_LOC("\tLTTNG_UST_CLOCK_PLUGIN: %s", config
->lttng_ust_clock_plugin
.value
? : "None");
524 DBG_NO_LOC("\tpid file path: %s", config
->pid_file_path
.value
? : "Unknown");
525 DBG_NO_LOC("\tlock file path: %s", config
->lock_file_path
.value
? : "Unknown");
526 DBG_NO_LOC("\tsession load path: %s", config
->load_session_path
.value
? : "None");
527 DBG_NO_LOC("\tagent port file path: %s", config
->agent_port_file_path
.value
? : "Unknown");
528 DBG_NO_LOC("\tconsumerd32 path: %s", config
->consumerd32_path
.value
? : "Unknown");
529 DBG_NO_LOC("\tconsumerd32 bin path: %s", config
->consumerd32_bin_path
.value
? : "Unknown");
530 DBG_NO_LOC("\tconsumerd32 lib dir: %s", config
->consumerd32_lib_dir
.value
? : "Unknown");
531 DBG_NO_LOC("\tconsumerd32 err unix sock path:%s", config
->consumerd32_err_unix_sock_path
.value
? : "Unknown");
532 DBG_NO_LOC("\tconsumerd32 cmd unix sock path:%s", config
->consumerd32_cmd_unix_sock_path
.value
? : "Unknown");
533 DBG_NO_LOC("\tconsumerd64 path: %s", config
->consumerd64_path
.value
? : "Unknown");
534 DBG_NO_LOC("\tconsumerd64 bin path: %s", config
->consumerd64_bin_path
.value
? : "Unknown");
535 DBG_NO_LOC("\tconsumerd64 lib dir: %s", config
->consumerd64_lib_dir
.value
? : "Unknown");
536 DBG_NO_LOC("\tconsumerd64 err unix sock path:%s", config
->consumerd64_err_unix_sock_path
.value
? : "Unknown");
537 DBG_NO_LOC("\tconsumerd64 cmd unix sock path:%s", config
->consumerd64_cmd_unix_sock_path
.value
? : "Unknown");
538 DBG_NO_LOC("\tkconsumerd path: %s", config
->kconsumerd_path
.value
? : "Unknown");
539 DBG_NO_LOC("\tkconsumerd err unix sock path: %s", config
->kconsumerd_err_unix_sock_path
.value
? : "Unknown");
540 DBG_NO_LOC("\tkconsumerd cmd unix sock path: %s", config
->kconsumerd_cmd_unix_sock_path
.value
? : "Unknown");