Fix: relayd: rotation failure for multi-domain session
[lttng-tools.git] / src / bin / lttng-sessiond / sessiond-config.cpp
1 /*
2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 */
7
8 #include "version.h"
9 #include "sessiond-config.h"
10 #include "lttng-ust-ctl.h"
11 #include <common/defaults.h>
12 #include <limits.h>
13 #include <ctype.h>
14 #include <common/error.h>
15 #include <common/utils.h>
16 #include <common/compat/errno.h>
17 #include <common/compat/getenv.h>
18
19 static
20 struct sessiond_config sessiond_config_build_defaults = {
21 .verbose = 0,
22 .verbose_consumer = 0,
23 .agent_tcp_port = { .begin = DEFAULT_AGENT_TCP_PORT_RANGE_BEGIN, .end = DEFAULT_AGENT_TCP_PORT_RANGE_END },
24
25 .event_notifier_buffer_size_kernel = DEFAULT_EVENT_NOTIFIER_ERROR_COUNT_MAP_SIZE,
26 .event_notifier_buffer_size_userspace = DEFAULT_EVENT_NOTIFIER_ERROR_COUNT_MAP_SIZE,
27 .app_socket_timeout = DEFAULT_APP_SOCKET_RW_TIMEOUT,
28
29 .quiet = false,
30
31
32 .no_kernel = false,
33 .background = false,
34 .daemonize = false,
35 .sig_parent = false,
36
37 .tracing_group_name = { (char *) DEFAULT_TRACING_GROUP },
38 .kmod_probes_list = { nullptr },
39 .kmod_extra_probes_list = { nullptr },
40
41 .rundir = { nullptr },
42
43 .apps_unix_sock_path = { nullptr },
44 .client_unix_sock_path = { nullptr },
45 .wait_shm_path = { nullptr },
46 .health_unix_sock_path = { nullptr },
47 .lttng_ust_clock_plugin = { nullptr },
48 .pid_file_path = { nullptr },
49 .lock_file_path = { nullptr },
50 .load_session_path = { nullptr },
51 .agent_port_file_path = { nullptr },
52
53 .consumerd32_path = { nullptr },
54 .consumerd32_bin_path = { nullptr },
55 .consumerd32_lib_dir = { nullptr },
56 .consumerd32_err_unix_sock_path = { nullptr },
57 .consumerd32_cmd_unix_sock_path = { nullptr },
58
59 .consumerd64_path = { nullptr },
60 .consumerd64_bin_path = { nullptr },
61 .consumerd64_lib_dir = { nullptr },
62 .consumerd64_err_unix_sock_path = { nullptr },
63 .consumerd64_cmd_unix_sock_path = { nullptr },
64
65 .kconsumerd_path = { nullptr },
66 .kconsumerd_err_unix_sock_path = { nullptr },
67 .kconsumerd_cmd_unix_sock_path = { nullptr },
68 };
69
70 static
71 void config_string_fini(struct config_string *str)
72 {
73 config_string_set(str, NULL);
74 }
75
76 static
77 void config_string_set_static(struct config_string *config_str,
78 const char *value)
79 {
80 config_string_set(config_str, (char *) value);
81 config_str->should_free = false;
82 }
83
84 /* Only use for dynamically-allocated strings. */
85 void config_string_set(struct config_string *config_str, char *value)
86 {
87 LTTNG_ASSERT(config_str);
88 if (config_str->should_free) {
89 free(config_str->value);
90 config_str->should_free = false;
91 }
92
93 config_str->should_free = !!value;
94 config_str->value = value;
95 }
96
97 int sessiond_config_apply_env_config(struct sessiond_config *config)
98 {
99 int ret = 0;
100 const char *env_value;
101
102 env_value = getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV);
103 if (env_value) {
104 char *endptr;
105 long int_val;
106
107 errno = 0;
108 int_val = strtoul(env_value, &endptr, 0);
109 if (errno != 0 || int_val > INT_MAX ||
110 (int_val < 0 && int_val != -1)) {
111 ERR("Invalid value \"%s\" used for \"%s\" environment variable",
112 env_value, DEFAULT_APP_SOCKET_TIMEOUT_ENV);
113 ret = -1;
114 goto end;
115 }
116
117 config->app_socket_timeout = int_val;
118 }
119
120 env_value = lttng_secure_getenv("LTTNG_CONSUMERD32_BIN");
121 if (env_value) {
122 config_string_set_static(&config->consumerd32_bin_path,
123 env_value);
124 }
125 env_value = lttng_secure_getenv("LTTNG_CONSUMERD64_BIN");
126 if (env_value) {
127 config_string_set_static(&config->consumerd64_bin_path,
128 env_value);
129 }
130
131 env_value = lttng_secure_getenv("LTTNG_CONSUMERD32_LIBDIR");
132 if (env_value) {
133 config_string_set_static(&config->consumerd32_lib_dir,
134 env_value);
135 }
136 env_value = lttng_secure_getenv("LTTNG_CONSUMERD64_LIBDIR");
137 if (env_value) {
138 config_string_set_static(&config->consumerd64_lib_dir,
139 env_value);
140 }
141
142 env_value = lttng_secure_getenv("LTTNG_UST_CLOCK_PLUGIN");
143 if (env_value) {
144 config_string_set_static(&config->lttng_ust_clock_plugin,
145 env_value);
146 }
147
148 env_value = lttng_secure_getenv(DEFAULT_LTTNG_KMOD_PROBES);
149 if (env_value) {
150 config_string_set_static(&config->kmod_probes_list,
151 env_value);
152 }
153
154 env_value = lttng_secure_getenv(DEFAULT_LTTNG_EXTRA_KMOD_PROBES);
155 if (env_value) {
156 config_string_set_static(&config->kmod_extra_probes_list,
157 env_value);
158 }
159 end:
160 return ret;
161 }
162
163 static
164 int config_set_paths_root(struct sessiond_config *config)
165 {
166 int ret = 0;
167
168 config_string_set(&config->rundir, strdup(DEFAULT_LTTNG_RUNDIR));
169 if (!config->rundir.value) {
170 ERR("Failed to set rundir");
171 ret = -1;
172 goto end;
173 }
174
175 config_string_set_static(&config->apps_unix_sock_path,
176 DEFAULT_GLOBAL_APPS_UNIX_SOCK);
177 config_string_set_static(&config->client_unix_sock_path,
178 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK);
179 config_string_set_static(&config->wait_shm_path,
180 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH);
181 config_string_set_static(&config->health_unix_sock_path,
182 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK);
183 end:
184 return ret;
185 }
186
187 static
188 int config_set_paths_non_root(struct sessiond_config *config)
189 {
190 int ret = 0;
191 const char *home_path = utils_get_home_dir();
192 char *str;
193
194 if (home_path == NULL) {
195 ERR("Can't get HOME directory for sockets creation.");
196 ret = -1;
197 goto end;
198 }
199
200 /*
201 * Create rundir from home path. This will create something like
202 * $HOME/.lttng
203 */
204 ret = asprintf(&str, DEFAULT_LTTNG_HOME_RUNDIR, home_path);
205 if (ret < 0) {
206 ERR("Failed to set rundir");
207 goto end;
208 }
209 config_string_set(&config->rundir, str);
210 str = NULL;
211
212 ret = asprintf(&str, DEFAULT_HOME_APPS_UNIX_SOCK, home_path);
213 if (ret < 0) {
214 ERR("Failed to set default home apps unix socket path");
215 goto end;
216 }
217 config_string_set(&config->apps_unix_sock_path, str);
218 str = NULL;
219
220 ret = asprintf(&str, DEFAULT_HOME_CLIENT_UNIX_SOCK, home_path);
221 if (ret < 0) {
222 ERR("Failed to set default home client unix socket path");
223 goto end;
224 }
225 config_string_set(&config->client_unix_sock_path, str);
226 str = NULL;
227
228 ret = asprintf(&str, DEFAULT_HOME_APPS_WAIT_SHM_PATH, getuid());
229 if (ret < 0) {
230 ERR("Failed to set default home apps wait shm path");
231 goto end;
232 }
233 config_string_set(&config->wait_shm_path, str);
234 str = NULL;
235
236 ret = asprintf(&str, DEFAULT_HOME_HEALTH_UNIX_SOCK, home_path);
237 if (ret < 0) {
238 ERR("Failed to set default home health UNIX socket path");
239 goto end;
240 }
241 config_string_set(&config->health_unix_sock_path, str);
242 str = NULL;
243
244 ret = 0;
245 end:
246 return ret;
247 }
248
249 int sessiond_config_init(struct sessiond_config *config)
250 {
251 int ret;
252 bool is_root = (getuid() == 0);
253 char *str;
254
255 LTTNG_ASSERT(config);
256 memcpy(config, &sessiond_config_build_defaults, sizeof(*config));
257
258 if (is_root) {
259 ret = config_set_paths_root(config);
260 } else {
261 ret = config_set_paths_non_root(config);
262 }
263 if (ret < 0) {
264 goto error;
265 }
266
267 /* 32 bits consumerd path setup */
268 ret = asprintf(&str, DEFAULT_USTCONSUMERD32_PATH,
269 config->rundir.value);
270 if (ret < 0) {
271 ERR("Failed to set 32-bit consumer path");
272 goto error;
273 }
274 config_string_set(&config->consumerd32_path, str);
275 str = NULL;
276
277 ret = asprintf(&str, DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH,
278 config->rundir.value);
279 if (ret < 0) {
280 ERR("Failed to set 32-bit consumer error socket path");
281 goto error;
282 }
283 config_string_set(&config->consumerd32_err_unix_sock_path, str);
284 str = NULL;
285
286 ret = asprintf(&str, DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH,
287 config->rundir.value);
288 if (ret < 0) {
289 ERR("Failed to set 32-bit consumer command socket path");
290 goto error;
291 }
292 config_string_set(&config->consumerd32_cmd_unix_sock_path, str);
293 str = NULL;
294
295 /* 64 bits consumerd path setup */
296 ret = asprintf(&str, DEFAULT_USTCONSUMERD64_PATH,
297 config->rundir.value);
298 if (ret < 0) {
299 ERR("Failed to set 64-bit consumer path");
300 goto error;
301 }
302 config_string_set(&config->consumerd64_path, str);
303 str = NULL;
304
305 ret = asprintf(&str, DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH,
306 config->rundir.value);
307 if (ret < 0) {
308 ERR("Failed to set 64-bit consumer error socket path");
309 goto error;
310 }
311 config_string_set(&config->consumerd64_err_unix_sock_path, str);
312 str = NULL;
313
314 ret = asprintf(&str, DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH,
315 config->rundir.value);
316 if (ret < 0) {
317 ERR("Failed to set 64-bit consumer command socket path");
318 goto error;
319 }
320 config_string_set(&config->consumerd64_cmd_unix_sock_path, str);
321 str = NULL;
322
323 /* kconsumerd consumerd path setup */
324 ret = asprintf(&str, DEFAULT_KCONSUMERD_PATH,
325 config->rundir.value);
326 if (ret < 0) {
327 ERR("Failed to set kernel consumer path");
328 goto error;
329 }
330 config_string_set(&config->kconsumerd_path, str);
331 str = NULL;
332
333 ret = asprintf(&str, DEFAULT_KCONSUMERD_ERR_SOCK_PATH,
334 config->rundir.value);
335 if (ret < 0) {
336 ERR("Failed to set kernel consumer error socket path");
337 goto error;
338 }
339 config_string_set(&config->kconsumerd_err_unix_sock_path, str);
340 str = NULL;
341
342 ret = asprintf(&str, DEFAULT_KCONSUMERD_CMD_SOCK_PATH,
343 config->rundir.value);
344 if (ret < 0) {
345 ERR("Failed to set kernel consumer command socket path");
346 goto error;
347 }
348 config_string_set(&config->kconsumerd_cmd_unix_sock_path, str);
349 str = NULL;
350
351 ret = asprintf(&str, "%s/%s", config->rundir.value,
352 DEFAULT_LTTNG_SESSIOND_PIDFILE);
353 if (ret < 0) {
354 ERR("Failed to set PID file path");
355 goto error;
356 }
357 config_string_set(&config->pid_file_path, str);
358 str = NULL;
359
360 ret = asprintf(&str, "%s/%s", config->rundir.value,
361 DEFAULT_LTTNG_SESSIOND_LOCKFILE);
362 if (ret < 0) {
363 ERR("Failed to set lock file path");
364 goto error;
365 }
366 config_string_set(&config->lock_file_path, str);
367 str = NULL;
368
369 ret = asprintf(&str, "%s/%s", config->rundir.value,
370 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE);
371 if (ret < 0) {
372 ERR("Failed to set agent port file path");
373 goto error;
374 }
375 config_string_set(&config->agent_port_file_path, str);
376 str = NULL;
377
378 /*
379 * Allow INSTALL_BIN_PATH to be used as a target path for the
380 * native architecture size consumer if CONFIG_CONSUMER*_PATH
381 * has not been defined.
382 */
383 #if (CAA_BITS_PER_LONG == 32)
384 config_string_set_static(&config->consumerd32_bin_path,
385 INSTALL_BIN_PATH "/" DEFAULT_CONSUMERD_FILE);
386 config_string_set_static(&config->consumerd32_lib_dir,
387 INSTALL_LIB_PATH);
388 #elif (CAA_BITS_PER_LONG == 64)
389 config_string_set_static(&config->consumerd64_bin_path,
390 INSTALL_BIN_PATH "/" DEFAULT_CONSUMERD_FILE);
391 config_string_set_static(&config->consumerd64_lib_dir,
392 INSTALL_LIB_PATH);
393 #else
394 #error "Unknown bitness"
395 #endif
396 ret = 0;
397 return ret;
398 error:
399 sessiond_config_fini(config);
400 return ret;
401 }
402
403 void sessiond_config_fini(struct sessiond_config *config)
404 {
405 config_string_fini(&config->tracing_group_name);
406 config_string_fini(&config->kmod_probes_list);
407 config_string_fini(&config->kmod_extra_probes_list);
408 config_string_fini(&config->rundir);
409 config_string_fini(&config->apps_unix_sock_path);
410 config_string_fini(&config->client_unix_sock_path);
411 config_string_fini(&config->wait_shm_path);
412 config_string_fini(&config->health_unix_sock_path);
413 config_string_fini(&config->lttng_ust_clock_plugin);
414 config_string_fini(&config->pid_file_path);
415 config_string_fini(&config->lock_file_path);
416 config_string_fini(&config->load_session_path);
417 config_string_fini(&config->agent_port_file_path);
418 config_string_fini(&config->consumerd32_path);
419 config_string_fini(&config->consumerd32_bin_path);
420 config_string_fini(&config->consumerd32_lib_dir);
421 config_string_fini(&config->consumerd32_err_unix_sock_path);
422 config_string_fini(&config->consumerd32_cmd_unix_sock_path);
423 config_string_fini(&config->consumerd64_path);
424 config_string_fini(&config->consumerd64_bin_path);
425 config_string_fini(&config->consumerd64_lib_dir);
426 config_string_fini(&config->consumerd64_err_unix_sock_path);
427 config_string_fini(&config->consumerd64_cmd_unix_sock_path);
428 config_string_fini(&config->kconsumerd_path);
429 config_string_fini(&config->kconsumerd_err_unix_sock_path);
430 config_string_fini(&config->kconsumerd_cmd_unix_sock_path);
431 }
432
433 static
434 int resolve_path(struct config_string *path)
435 {
436 int ret = 0;
437 char *absolute_path;
438
439 if (!path->value || path->value[0] == '/') {
440 goto end;
441 }
442
443 absolute_path = utils_expand_path(path->value);
444 if (!absolute_path) {
445 ret = -1;
446 goto end;
447 }
448
449 config_string_set(path, absolute_path);
450 end:
451 return ret;
452 }
453
454 #define RESOLVE_CHECK(path_config_str) \
455 if (resolve_path(path_config_str)) \
456 return -1
457
458 int sessiond_config_resolve_paths(struct sessiond_config *config)
459 {
460 RESOLVE_CHECK(&config->apps_unix_sock_path);
461 RESOLVE_CHECK(&config->client_unix_sock_path);
462 RESOLVE_CHECK(&config->wait_shm_path);
463 RESOLVE_CHECK(&config->health_unix_sock_path);
464 RESOLVE_CHECK(&config->lttng_ust_clock_plugin);
465 RESOLVE_CHECK(&config->pid_file_path);
466 RESOLVE_CHECK(&config->lock_file_path);
467 RESOLVE_CHECK(&config->load_session_path);
468 RESOLVE_CHECK(&config->agent_port_file_path);
469 RESOLVE_CHECK(&config->consumerd32_path);
470 RESOLVE_CHECK(&config->consumerd32_bin_path);
471 RESOLVE_CHECK(&config->consumerd32_lib_dir);
472 RESOLVE_CHECK(&config->consumerd32_err_unix_sock_path);
473 RESOLVE_CHECK(&config->consumerd32_cmd_unix_sock_path);
474 RESOLVE_CHECK(&config->consumerd64_path);
475 RESOLVE_CHECK(&config->consumerd64_bin_path);
476 RESOLVE_CHECK(&config->consumerd64_lib_dir);
477 RESOLVE_CHECK(&config->consumerd64_err_unix_sock_path);
478 RESOLVE_CHECK(&config->consumerd64_cmd_unix_sock_path);
479 RESOLVE_CHECK(&config->kconsumerd_path);
480 RESOLVE_CHECK(&config->kconsumerd_err_unix_sock_path);
481 RESOLVE_CHECK(&config->kconsumerd_cmd_unix_sock_path);
482 return 0;
483 }
484
485 void sessiond_config_log(struct sessiond_config *config)
486 {
487 DBG_NO_LOC("[sessiond configuration]");
488 DBG_NO_LOC("\tversion %s", VERSION);
489 if (GIT_VERSION[0] != '\0') {
490 DBG_NO_LOC("\tgit version %s", GIT_VERSION);
491 }
492 if (EXTRA_VERSION_NAME[0] != '\0') {
493 DBG_NO_LOC("\textra version name %s", EXTRA_VERSION_NAME);
494 }
495 if (EXTRA_VERSION_DESCRIPTION[0] != '\0') {
496 DBG_NO_LOC("\textra version description:\n\t%s", EXTRA_VERSION_DESCRIPTION);
497 }
498 if (EXTRA_VERSION_PATCHES[0] != '\0') {
499 DBG_NO_LOC("\textra version patches:\n\t%s", EXTRA_VERSION_PATCHES);
500 }
501 DBG_NO_LOC("\tverbose: %i", config->verbose);
502 DBG_NO_LOC("\tverbose consumer: %i", config->verbose_consumer);
503 DBG_NO_LOC("\tquiet mode: %s", config->quiet ? "True" : "False");
504 if (config->agent_tcp_port.begin == config->agent_tcp_port.end) {
505 DBG_NO_LOC("\tagent_tcp_port: %i", config->agent_tcp_port.begin);
506 } else {
507 DBG_NO_LOC("\tagent_tcp_port: [%i, %i]",
508 config->agent_tcp_port.begin,
509 config->agent_tcp_port.end);
510 }
511 DBG_NO_LOC("\tapplication socket timeout: %i", config->app_socket_timeout);
512 DBG_NO_LOC("\tno-kernel: %s", config->no_kernel ? "True" : "False");
513 DBG_NO_LOC("\tbackground: %s", config->background ? "True" : "False");
514 DBG_NO_LOC("\tdaemonize: %s", config->daemonize ? "True" : "False");
515 DBG_NO_LOC("\tsignal parent on start: %s", config->sig_parent ? "True" : "False");
516 DBG_NO_LOC("\ttracing group name: %s", config->tracing_group_name.value ? : "Unknown");
517 DBG_NO_LOC("\tkmod_probe_list: %s", config->kmod_probes_list.value ? : "None");
518 DBG_NO_LOC("\tkmod_extra_probe_list: %s", config->kmod_extra_probes_list.value ? : "None");
519 DBG_NO_LOC("\trundir: %s", config->rundir.value ? : "Unknown");
520 DBG_NO_LOC("\tapplication socket path: %s", config->apps_unix_sock_path.value ? : "Unknown");
521 DBG_NO_LOC("\tclient socket path: %s", config->client_unix_sock_path.value ? : "Unknown");
522 DBG_NO_LOC("\twait shm path: %s", config->wait_shm_path.value ? : "Unknown");
523 DBG_NO_LOC("\thealth socket path: %s", config->health_unix_sock_path.value ? : "Unknown");
524 DBG_NO_LOC("\tLTTNG_UST_CLOCK_PLUGIN: %s", config->lttng_ust_clock_plugin.value ? : "None");
525 DBG_NO_LOC("\tpid file path: %s", config->pid_file_path.value ? : "Unknown");
526 DBG_NO_LOC("\tlock file path: %s", config->lock_file_path.value ? : "Unknown");
527 DBG_NO_LOC("\tsession load path: %s", config->load_session_path.value ? : "None");
528 DBG_NO_LOC("\tagent port file path: %s", config->agent_port_file_path.value ? : "Unknown");
529 DBG_NO_LOC("\tconsumerd32 path: %s", config->consumerd32_path.value ? : "Unknown");
530 DBG_NO_LOC("\tconsumerd32 bin path: %s", config->consumerd32_bin_path.value ? : "Unknown");
531 DBG_NO_LOC("\tconsumerd32 lib dir: %s", config->consumerd32_lib_dir.value ? : "Unknown");
532 DBG_NO_LOC("\tconsumerd32 err unix sock path:%s", config->consumerd32_err_unix_sock_path.value ? : "Unknown");
533 DBG_NO_LOC("\tconsumerd32 cmd unix sock path:%s", config->consumerd32_cmd_unix_sock_path.value ? : "Unknown");
534 DBG_NO_LOC("\tconsumerd64 path: %s", config->consumerd64_path.value ? : "Unknown");
535 DBG_NO_LOC("\tconsumerd64 bin path: %s", config->consumerd64_bin_path.value ? : "Unknown");
536 DBG_NO_LOC("\tconsumerd64 lib dir: %s", config->consumerd64_lib_dir.value ? : "Unknown");
537 DBG_NO_LOC("\tconsumerd64 err unix sock path:%s", config->consumerd64_err_unix_sock_path.value ? : "Unknown");
538 DBG_NO_LOC("\tconsumerd64 cmd unix sock path:%s", config->consumerd64_cmd_unix_sock_path.value ? : "Unknown");
539 DBG_NO_LOC("\tkconsumerd path: %s", config->kconsumerd_path.value ? : "Unknown");
540 DBG_NO_LOC("\tkconsumerd err unix sock path: %s", config->kconsumerd_err_unix_sock_path.value ? : "Unknown");
541 DBG_NO_LOC("\tkconsumerd cmd unix sock path: %s", config->kconsumerd_cmd_unix_sock_path.value ? : "Unknown");
542 }
This page took 0.04909 seconds and 4 git commands to generate.