docs: Add supported versions and fix-backport policy
[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.hpp"
9 #include "sessiond-config.hpp"
10 #include "lttng-ust-ctl.hpp"
11 #include <common/defaults.hpp>
12 #include <limits.h>
13 #include <ctype.h>
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>
19
20 static
21 struct sessiond_config sessiond_config_build_defaults = {
22 .verbose = 0,
23 .verbose_consumer = 0,
24 .agent_tcp_port = { .begin = DEFAULT_AGENT_TCP_PORT_RANGE_BEGIN, .end = DEFAULT_AGENT_TCP_PORT_RANGE_END },
25
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,
29
30 .quiet = false,
31
32
33 .no_kernel = false,
34 .background = false,
35 .daemonize = false,
36 .sig_parent = false,
37
38 .tracing_group_name = { (char *) DEFAULT_TRACING_GROUP, false },
39
40 .kmod_probes_list = { nullptr, false },
41 .kmod_extra_probes_list = { nullptr, false },
42
43 .rundir = { nullptr, false },
44
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 },
54
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 },
60
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 },
66
67 .kconsumerd_path = { nullptr, false },
68 .kconsumerd_err_unix_sock_path = { nullptr, false },
69 .kconsumerd_cmd_unix_sock_path = { nullptr, false },
70 };
71
72 static
73 void config_string_fini(struct config_string *str)
74 {
75 config_string_set(str, NULL);
76 }
77
78 static
79 void config_string_set_static(struct config_string *config_str,
80 const char *value)
81 {
82 config_string_set(config_str, (char *) value);
83 config_str->should_free = false;
84 }
85
86 /* Only use for dynamically-allocated strings. */
87 void config_string_set(struct config_string *config_str, char *value)
88 {
89 LTTNG_ASSERT(config_str);
90 if (config_str->should_free) {
91 free(config_str->value);
92 config_str->should_free = false;
93 }
94
95 config_str->should_free = !!value;
96 config_str->value = value;
97 }
98
99 int sessiond_config_apply_env_config(struct sessiond_config *config)
100 {
101 int ret = 0;
102 const char *env_value;
103
104 env_value = getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV);
105 if (env_value) {
106 char *endptr;
107 long int_val;
108
109 errno = 0;
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);
115 ret = -1;
116 goto end;
117 }
118
119 config->app_socket_timeout = int_val;
120 }
121
122 env_value = lttng_secure_getenv("LTTNG_CONSUMERD32_BIN");
123 if (env_value) {
124 config_string_set_static(&config->consumerd32_bin_path,
125 env_value);
126 }
127 env_value = lttng_secure_getenv("LTTNG_CONSUMERD64_BIN");
128 if (env_value) {
129 config_string_set_static(&config->consumerd64_bin_path,
130 env_value);
131 }
132
133 env_value = lttng_secure_getenv("LTTNG_CONSUMERD32_LIBDIR");
134 if (env_value) {
135 config_string_set_static(&config->consumerd32_lib_dir,
136 env_value);
137 }
138 env_value = lttng_secure_getenv("LTTNG_CONSUMERD64_LIBDIR");
139 if (env_value) {
140 config_string_set_static(&config->consumerd64_lib_dir,
141 env_value);
142 }
143
144 env_value = lttng_secure_getenv("LTTNG_UST_CLOCK_PLUGIN");
145 if (env_value) {
146 config_string_set_static(&config->lttng_ust_clock_plugin,
147 env_value);
148 }
149
150 env_value = lttng_secure_getenv(DEFAULT_LTTNG_KMOD_PROBES);
151 if (env_value) {
152 config_string_set_static(&config->kmod_probes_list,
153 env_value);
154 }
155
156 env_value = lttng_secure_getenv(DEFAULT_LTTNG_EXTRA_KMOD_PROBES);
157 if (env_value) {
158 config_string_set_static(&config->kmod_extra_probes_list,
159 env_value);
160 }
161 end:
162 return ret;
163 }
164
165 static
166 int config_set_paths_root(struct sessiond_config *config)
167 {
168 int ret = 0;
169
170 config_string_set(&config->rundir, strdup(DEFAULT_LTTNG_RUNDIR));
171 if (!config->rundir.value) {
172 ERR("Failed to set rundir");
173 ret = -1;
174 goto end;
175 }
176
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);
185 end:
186 return ret;
187 }
188
189 static
190 int config_set_paths_non_root(struct sessiond_config *config)
191 {
192 int ret = 0;
193 const char *home_path = utils_get_home_dir();
194 char *str;
195
196 if (home_path == NULL) {
197 ERR("Can't get HOME directory for sockets creation.");
198 ret = -1;
199 goto end;
200 }
201
202 /*
203 * Create rundir from home path. This will create something like
204 * $HOME/.lttng
205 */
206 ret = asprintf(&str, DEFAULT_LTTNG_HOME_RUNDIR, home_path);
207 if (ret < 0) {
208 ERR("Failed to set rundir");
209 goto end;
210 }
211 config_string_set(&config->rundir, str);
212 str = NULL;
213
214 ret = asprintf(&str, DEFAULT_HOME_APPS_UNIX_SOCK, home_path);
215 if (ret < 0) {
216 ERR("Failed to set default home apps unix socket path");
217 goto end;
218 }
219 config_string_set(&config->apps_unix_sock_path, str);
220 str = NULL;
221
222 ret = asprintf(&str, DEFAULT_HOME_CLIENT_UNIX_SOCK, home_path);
223 if (ret < 0) {
224 ERR("Failed to set default home client unix socket path");
225 goto end;
226 }
227 config_string_set(&config->client_unix_sock_path, str);
228 str = NULL;
229
230 ret = asprintf(&str, DEFAULT_HOME_APPS_WAIT_SHM_PATH, getuid());
231 if (ret < 0) {
232 ERR("Failed to set default home apps wait shm path");
233 goto end;
234 }
235 config_string_set(&config->wait_shm_path, str);
236 str = NULL;
237
238 ret = asprintf(&str, DEFAULT_HOME_HEALTH_UNIX_SOCK, home_path);
239 if (ret < 0) {
240 ERR("Failed to set default home health UNIX socket path");
241 goto end;
242 }
243 config_string_set(&config->health_unix_sock_path, str);
244 str = NULL;
245
246 ret = 0;
247 end:
248 return ret;
249 }
250
251 int sessiond_config_init(struct sessiond_config *config)
252 {
253 int ret;
254 bool is_root = (getuid() == 0);
255 char *str;
256
257 LTTNG_ASSERT(config);
258 memcpy(config, &sessiond_config_build_defaults, sizeof(*config));
259
260 if (is_root) {
261 ret = config_set_paths_root(config);
262 } else {
263 ret = config_set_paths_non_root(config);
264 }
265 if (ret < 0) {
266 goto error;
267 }
268
269 /* 32 bits consumerd path setup */
270 ret = asprintf(&str, DEFAULT_USTCONSUMERD32_PATH,
271 config->rundir.value);
272 if (ret < 0) {
273 ERR("Failed to set 32-bit consumer path");
274 goto error;
275 }
276 config_string_set(&config->consumerd32_path, str);
277 str = NULL;
278
279 ret = asprintf(&str, DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH,
280 config->rundir.value);
281 if (ret < 0) {
282 ERR("Failed to set 32-bit consumer error socket path");
283 goto error;
284 }
285 config_string_set(&config->consumerd32_err_unix_sock_path, str);
286 str = NULL;
287
288 ret = asprintf(&str, DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH,
289 config->rundir.value);
290 if (ret < 0) {
291 ERR("Failed to set 32-bit consumer command socket path");
292 goto error;
293 }
294 config_string_set(&config->consumerd32_cmd_unix_sock_path, str);
295 str = NULL;
296
297 /* 64 bits consumerd path setup */
298 ret = asprintf(&str, DEFAULT_USTCONSUMERD64_PATH,
299 config->rundir.value);
300 if (ret < 0) {
301 ERR("Failed to set 64-bit consumer path");
302 goto error;
303 }
304 config_string_set(&config->consumerd64_path, str);
305 str = NULL;
306
307 ret = asprintf(&str, DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH,
308 config->rundir.value);
309 if (ret < 0) {
310 ERR("Failed to set 64-bit consumer error socket path");
311 goto error;
312 }
313 config_string_set(&config->consumerd64_err_unix_sock_path, str);
314 str = NULL;
315
316 ret = asprintf(&str, DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH,
317 config->rundir.value);
318 if (ret < 0) {
319 ERR("Failed to set 64-bit consumer command socket path");
320 goto error;
321 }
322 config_string_set(&config->consumerd64_cmd_unix_sock_path, str);
323 str = NULL;
324
325 /* kconsumerd consumerd path setup */
326 ret = asprintf(&str, DEFAULT_KCONSUMERD_PATH,
327 config->rundir.value);
328 if (ret < 0) {
329 ERR("Failed to set kernel consumer path");
330 goto error;
331 }
332 config_string_set(&config->kconsumerd_path, str);
333 str = NULL;
334
335 ret = asprintf(&str, DEFAULT_KCONSUMERD_ERR_SOCK_PATH,
336 config->rundir.value);
337 if (ret < 0) {
338 ERR("Failed to set kernel consumer error socket path");
339 goto error;
340 }
341 config_string_set(&config->kconsumerd_err_unix_sock_path, str);
342 str = NULL;
343
344 ret = asprintf(&str, DEFAULT_KCONSUMERD_CMD_SOCK_PATH,
345 config->rundir.value);
346 if (ret < 0) {
347 ERR("Failed to set kernel consumer command socket path");
348 goto error;
349 }
350 config_string_set(&config->kconsumerd_cmd_unix_sock_path, str);
351 str = NULL;
352
353 ret = asprintf(&str, "%s/%s", config->rundir.value,
354 DEFAULT_LTTNG_SESSIOND_PIDFILE);
355 if (ret < 0) {
356 ERR("Failed to set PID file path");
357 goto error;
358 }
359 config_string_set(&config->pid_file_path, str);
360 str = NULL;
361
362 ret = asprintf(&str, "%s/%s", config->rundir.value,
363 DEFAULT_LTTNG_SESSIOND_LOCKFILE);
364 if (ret < 0) {
365 ERR("Failed to set lock file path");
366 goto error;
367 }
368 config_string_set(&config->lock_file_path, str);
369 str = NULL;
370
371 ret = asprintf(&str, "%s/%s", config->rundir.value,
372 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE);
373 if (ret < 0) {
374 ERR("Failed to set agent port file path");
375 goto error;
376 }
377 config_string_set(&config->agent_port_file_path, str);
378 str = NULL;
379
380 /*
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.
384 */
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,
389 INSTALL_LIB_PATH);
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,
394 INSTALL_LIB_PATH);
395 #else
396 #error "Unknown bitness"
397 #endif
398 ret = 0;
399 return ret;
400 error:
401 sessiond_config_fini(config);
402 return ret;
403 }
404
405 void sessiond_config_fini(struct sessiond_config *config)
406 {
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);
433 }
434
435 static
436 int resolve_path(struct config_string *path)
437 {
438 int ret = 0;
439 char *absolute_path;
440
441 if (!path->value || path->value[0] == '/') {
442 goto end;
443 }
444
445 absolute_path = utils_expand_path(path->value);
446 if (!absolute_path) {
447 ret = -1;
448 goto end;
449 }
450
451 config_string_set(path, absolute_path);
452 end:
453 return ret;
454 }
455
456 #define RESOLVE_CHECK(path_config_str) \
457 if (resolve_path(path_config_str)) \
458 return -1
459
460 int sessiond_config_resolve_paths(struct sessiond_config *config)
461 {
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);
484 return 0;
485 }
486
487 void sessiond_config_log(struct sessiond_config *config)
488 {
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);
493 }
494 if (EXTRA_VERSION_NAME[0] != '\0') {
495 DBG_NO_LOC("\textra version name %s", EXTRA_VERSION_NAME);
496 }
497 if (EXTRA_VERSION_DESCRIPTION[0] != '\0') {
498 DBG_NO_LOC("\textra version description:\n\t%s", EXTRA_VERSION_DESCRIPTION);
499 }
500 if (EXTRA_VERSION_PATCHES[0] != '\0') {
501 DBG_NO_LOC("\textra version patches:\n\t%s", EXTRA_VERSION_PATCHES);
502 }
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);
508 } else {
509 DBG_NO_LOC("\tagent_tcp_port: [%i, %i]",
510 config->agent_tcp_port.begin,
511 config->agent_tcp_port.end);
512 }
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");
544 }
This page took 0.039515 seconds and 4 git commands to generate.