Commit | Line | Data |
---|---|---|
81b86775 DG |
1 | /* |
2 | * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com> | |
66495845 | 3 | * Copyright (C) 2013 - Raphaël Beamonte <raphael.beamonte@gmail.com> |
8db0dc00 | 4 | * Copyright (C) 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com> |
81b86775 DG |
5 | * |
6 | * This program is free software; you can redistribute it and/or modify it | |
7 | * under the terms of the GNU General Public License, version 2 only, as | |
8 | * published by the Free Software Foundation. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, but WITHOUT | |
11 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
12 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
13 | * more details. | |
14 | * | |
15 | * You should have received a copy of the GNU General Public License along with | |
16 | * this program; if not, write to the Free Software Foundation, Inc., 51 | |
17 | * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
18 | */ | |
19 | ||
6c1c0768 | 20 | #define _LGPL_SOURCE |
35f90c40 | 21 | #include <assert.h> |
81b86775 DG |
22 | #include <ctype.h> |
23 | #include <fcntl.h> | |
24 | #include <limits.h> | |
25 | #include <stdlib.h> | |
2d851108 | 26 | #include <sys/stat.h> |
0c7bcad5 | 27 | #include <sys/types.h> |
2d851108 | 28 | #include <unistd.h> |
fe4477ee | 29 | #include <inttypes.h> |
6c71277b | 30 | #include <grp.h> |
fb198a11 | 31 | #include <pwd.h> |
c9cb3e7d | 32 | #include <sys/file.h> |
a98e236e | 33 | #include <unistd.h> |
81b86775 DG |
34 | |
35 | #include <common/common.h> | |
fe4477ee | 36 | #include <common/runas.h> |
e8fa9fb0 | 37 | #include <common/compat/getenv.h> |
f5436bfc | 38 | #include <common/compat/string.h> |
5a2451c9 | 39 | #include <common/compat/dirent.h> |
d7c23421 | 40 | #include <lttng/constant.h> |
81b86775 DG |
41 | |
42 | #include "utils.h" | |
feb0f3e5 | 43 | #include "defaults.h" |
9cc0ed0d | 44 | #include "time.h" |
81b86775 | 45 | |
5154230f RB |
46 | /* |
47 | * Return a partial realpath(3) of the path even if the full path does not | |
48 | * exist. For instance, with /tmp/test1/test2/test3, if test2/ does not exist | |
49 | * but the /tmp/test1 does, the real path for /tmp/test1 is concatened with | |
50 | * /test2/test3 then returned. In normal time, realpath(3) fails if the end | |
51 | * point directory does not exist. | |
52 | * In case resolved_path is NULL, the string returned was allocated in the | |
53 | * function and thus need to be freed by the caller. The size argument allows | |
54 | * to specify the size of the resolved_path argument if given, or the size to | |
55 | * allocate. | |
56 | */ | |
57 | LTTNG_HIDDEN | |
58 | char *utils_partial_realpath(const char *path, char *resolved_path, size_t size) | |
59 | { | |
9482daac | 60 | char *cut_path = NULL, *try_path = NULL, *try_path_prev = NULL; |
5154230f RB |
61 | const char *next, *prev, *end; |
62 | ||
63 | /* Safety net */ | |
64 | if (path == NULL) { | |
65 | goto error; | |
66 | } | |
67 | ||
68 | /* | |
69 | * Identify the end of the path, we don't want to treat the | |
70 | * last char if it is a '/', we will just keep it on the side | |
71 | * to be added at the end, and return a value coherent with | |
72 | * the path given as argument | |
73 | */ | |
74 | end = path + strlen(path); | |
75 | if (*(end-1) == '/') { | |
76 | end--; | |
77 | } | |
78 | ||
79 | /* Initiate the values of the pointers before looping */ | |
80 | next = path; | |
81 | prev = next; | |
82 | /* Only to ensure try_path is not NULL to enter the while */ | |
83 | try_path = (char *)next; | |
84 | ||
85 | /* Resolve the canonical path of the first part of the path */ | |
86 | while (try_path != NULL && next != end) { | |
d7c23421 JG |
87 | char *try_path_buf = NULL; |
88 | ||
5154230f RB |
89 | /* |
90 | * If there is not any '/' left, we want to try with | |
91 | * the full path | |
92 | */ | |
93 | next = strpbrk(next + 1, "/"); | |
94 | if (next == NULL) { | |
95 | next = end; | |
96 | } | |
97 | ||
98 | /* Cut the part we will be trying to resolve */ | |
f5436bfc | 99 | cut_path = lttng_strndup(path, next - path); |
d9dbcf5e | 100 | if (cut_path == NULL) { |
f5436bfc | 101 | PERROR("lttng_strndup"); |
d9dbcf5e MD |
102 | goto error; |
103 | } | |
5154230f | 104 | |
d7c23421 JG |
105 | try_path_buf = zmalloc(LTTNG_PATH_MAX); |
106 | if (!try_path_buf) { | |
107 | PERROR("zmalloc"); | |
108 | goto error; | |
109 | } | |
110 | ||
5154230f | 111 | /* Try to resolve this part */ |
f3472d9a | 112 | try_path = realpath((char *) cut_path, try_path_buf); |
5154230f | 113 | if (try_path == NULL) { |
d7c23421 | 114 | free(try_path_buf); |
5154230f RB |
115 | /* |
116 | * There was an error, we just want to be assured it | |
117 | * is linked to an unexistent directory, if it's another | |
118 | * reason, we spawn an error | |
119 | */ | |
120 | switch (errno) { | |
121 | case ENOENT: | |
122 | /* Ignore the error */ | |
123 | break; | |
124 | default: | |
125 | PERROR("realpath (partial_realpath)"); | |
126 | goto error; | |
127 | break; | |
128 | } | |
129 | } else { | |
130 | /* Save the place we are before trying the next step */ | |
d7c23421 | 131 | try_path_buf = NULL; |
5154230f RB |
132 | free(try_path_prev); |
133 | try_path_prev = try_path; | |
134 | prev = next; | |
135 | } | |
136 | ||
137 | /* Free the allocated memory */ | |
138 | free(cut_path); | |
c14cc491 | 139 | cut_path = NULL; |
494a8e99 | 140 | } |
5154230f RB |
141 | |
142 | /* Allocate memory for the resolved path if necessary */ | |
143 | if (resolved_path == NULL) { | |
144 | resolved_path = zmalloc(size); | |
145 | if (resolved_path == NULL) { | |
146 | PERROR("zmalloc resolved path"); | |
147 | goto error; | |
148 | } | |
149 | } | |
150 | ||
151 | /* | |
152 | * If we were able to solve at least partially the path, we can concatenate | |
153 | * what worked and what didn't work | |
154 | */ | |
155 | if (try_path_prev != NULL) { | |
156 | /* If we risk to concatenate two '/', we remove one of them */ | |
157 | if (try_path_prev[strlen(try_path_prev) - 1] == '/' && prev[0] == '/') { | |
158 | try_path_prev[strlen(try_path_prev) - 1] = '\0'; | |
159 | } | |
160 | ||
161 | /* | |
162 | * Duplicate the memory used by prev in case resolved_path and | |
163 | * path are pointers for the same memory space | |
164 | */ | |
165 | cut_path = strdup(prev); | |
d9dbcf5e MD |
166 | if (cut_path == NULL) { |
167 | PERROR("strdup"); | |
168 | goto error; | |
169 | } | |
5154230f RB |
170 | |
171 | /* Concatenate the strings */ | |
172 | snprintf(resolved_path, size, "%s%s", try_path_prev, cut_path); | |
173 | ||
174 | /* Free the allocated memory */ | |
175 | free(cut_path); | |
176 | free(try_path_prev); | |
494a8e99 JG |
177 | cut_path = NULL; |
178 | try_path_prev = NULL; | |
5154230f RB |
179 | /* |
180 | * Else, we just copy the path in our resolved_path to | |
181 | * return it as is | |
182 | */ | |
183 | } else { | |
184 | strncpy(resolved_path, path, size); | |
185 | } | |
186 | ||
187 | /* Then we return the 'partially' resolved path */ | |
188 | return resolved_path; | |
189 | ||
190 | error: | |
191 | free(resolved_path); | |
9482daac | 192 | free(cut_path); |
b86d5f3f | 193 | free(try_path); |
32bd4678 MJ |
194 | if (try_path_prev != try_path) { |
195 | free(try_path_prev); | |
196 | } | |
5154230f RB |
197 | return NULL; |
198 | } | |
199 | ||
81b86775 | 200 | /* |
3d229795 RB |
201 | * Make a full resolution of the given path even if it doesn't exist. |
202 | * This function uses the utils_partial_realpath function to resolve | |
203 | * symlinks and relatives paths at the start of the string, and | |
204 | * implements functionnalities to resolve the './' and '../' strings | |
205 | * in the middle of a path. This function is only necessary because | |
206 | * realpath(3) does not accept to resolve unexistent paths. | |
207 | * The returned string was allocated in the function, it is thus of | |
208 | * the responsibility of the caller to free this memory. | |
81b86775 | 209 | */ |
90e535ef | 210 | LTTNG_HIDDEN |
81b86775 DG |
211 | char *utils_expand_path(const char *path) |
212 | { | |
3d229795 | 213 | char *next, *previous, *slash, *start_path, *absolute_path = NULL; |
5de083f4 RB |
214 | char *last_token; |
215 | int is_dot, is_dotdot; | |
81b86775 DG |
216 | |
217 | /* Safety net */ | |
218 | if (path == NULL) { | |
219 | goto error; | |
220 | } | |
221 | ||
3d229795 RB |
222 | /* Allocate memory for the absolute_path */ |
223 | absolute_path = zmalloc(PATH_MAX); | |
224 | if (absolute_path == NULL) { | |
81b86775 DG |
225 | PERROR("zmalloc expand path"); |
226 | goto error; | |
227 | } | |
228 | ||
3d229795 RB |
229 | /* |
230 | * If the path is not already absolute nor explicitly relative, | |
231 | * consider we're in the current directory | |
232 | */ | |
233 | if (*path != '/' && strncmp(path, "./", 2) != 0 && | |
234 | strncmp(path, "../", 3) != 0) { | |
235 | snprintf(absolute_path, PATH_MAX, "./%s", path); | |
2dcd84b7 | 236 | /* Else, we just copy the path */ |
116f95d9 | 237 | } else { |
3d229795 RB |
238 | strncpy(absolute_path, path, PATH_MAX); |
239 | } | |
116f95d9 | 240 | |
3d229795 RB |
241 | /* Resolve partially our path */ |
242 | absolute_path = utils_partial_realpath(absolute_path, | |
243 | absolute_path, PATH_MAX); | |
116f95d9 | 244 | |
3d229795 RB |
245 | /* As long as we find '/./' in the working_path string */ |
246 | while ((next = strstr(absolute_path, "/./"))) { | |
116f95d9 | 247 | |
3d229795 | 248 | /* We prepare the start_path not containing it */ |
f5436bfc | 249 | start_path = lttng_strndup(absolute_path, next - absolute_path); |
d9dbcf5e | 250 | if (!start_path) { |
f5436bfc | 251 | PERROR("lttng_strndup"); |
d9dbcf5e MD |
252 | goto error; |
253 | } | |
3d229795 RB |
254 | /* And we concatenate it with the part after this string */ |
255 | snprintf(absolute_path, PATH_MAX, "%s%s", start_path, next + 2); | |
116f95d9 | 256 | |
3d229795 RB |
257 | free(start_path); |
258 | } | |
116f95d9 | 259 | |
3d229795 RB |
260 | /* As long as we find '/../' in the working_path string */ |
261 | while ((next = strstr(absolute_path, "/../"))) { | |
262 | /* We find the last level of directory */ | |
263 | previous = absolute_path; | |
264 | while ((slash = strpbrk(previous, "/")) && slash != next) { | |
265 | previous = slash + 1; | |
81b86775 | 266 | } |
81b86775 | 267 | |
3d229795 | 268 | /* Then we prepare the start_path not containing it */ |
f5436bfc | 269 | start_path = lttng_strndup(absolute_path, previous - absolute_path); |
d9dbcf5e | 270 | if (!start_path) { |
f5436bfc | 271 | PERROR("lttng_strndup"); |
d9dbcf5e MD |
272 | goto error; |
273 | } | |
3d229795 RB |
274 | |
275 | /* And we concatenate it with the part after the '/../' */ | |
276 | snprintf(absolute_path, PATH_MAX, "%s%s", start_path, next + 4); | |
277 | ||
278 | /* We can free the memory used for the start path*/ | |
279 | free(start_path); | |
280 | ||
281 | /* Then we verify for symlinks using partial_realpath */ | |
282 | absolute_path = utils_partial_realpath(absolute_path, | |
283 | absolute_path, PATH_MAX); | |
116f95d9 | 284 | } |
81b86775 | 285 | |
5de083f4 RB |
286 | /* Identify the last token */ |
287 | last_token = strrchr(absolute_path, '/'); | |
288 | ||
289 | /* Verify that this token is not a relative path */ | |
290 | is_dotdot = (strcmp(last_token, "/..") == 0); | |
291 | is_dot = (strcmp(last_token, "/.") == 0); | |
292 | ||
293 | /* If it is, take action */ | |
294 | if (is_dot || is_dotdot) { | |
295 | /* For both, remove this token */ | |
296 | *last_token = '\0'; | |
297 | ||
298 | /* If it was a reference to parent directory, go back one more time */ | |
299 | if (is_dotdot) { | |
300 | last_token = strrchr(absolute_path, '/'); | |
301 | ||
302 | /* If there was only one level left, we keep the first '/' */ | |
303 | if (last_token == absolute_path) { | |
304 | last_token++; | |
305 | } | |
306 | ||
307 | *last_token = '\0'; | |
308 | } | |
309 | } | |
310 | ||
3d229795 | 311 | return absolute_path; |
81b86775 DG |
312 | |
313 | error: | |
3d229795 | 314 | free(absolute_path); |
81b86775 DG |
315 | return NULL; |
316 | } | |
317 | ||
318 | /* | |
319 | * Create a pipe in dst. | |
320 | */ | |
90e535ef | 321 | LTTNG_HIDDEN |
81b86775 DG |
322 | int utils_create_pipe(int *dst) |
323 | { | |
324 | int ret; | |
325 | ||
326 | if (dst == NULL) { | |
327 | return -1; | |
328 | } | |
329 | ||
330 | ret = pipe(dst); | |
331 | if (ret < 0) { | |
332 | PERROR("create pipe"); | |
333 | } | |
334 | ||
335 | return ret; | |
336 | } | |
337 | ||
338 | /* | |
339 | * Create pipe and set CLOEXEC flag to both fd. | |
340 | * | |
341 | * Make sure the pipe opened by this function are closed at some point. Use | |
342 | * utils_close_pipe(). | |
343 | */ | |
90e535ef | 344 | LTTNG_HIDDEN |
81b86775 DG |
345 | int utils_create_pipe_cloexec(int *dst) |
346 | { | |
347 | int ret, i; | |
348 | ||
349 | if (dst == NULL) { | |
350 | return -1; | |
351 | } | |
352 | ||
353 | ret = utils_create_pipe(dst); | |
354 | if (ret < 0) { | |
355 | goto error; | |
356 | } | |
357 | ||
358 | for (i = 0; i < 2; i++) { | |
359 | ret = fcntl(dst[i], F_SETFD, FD_CLOEXEC); | |
360 | if (ret < 0) { | |
361 | PERROR("fcntl pipe cloexec"); | |
362 | goto error; | |
363 | } | |
364 | } | |
365 | ||
366 | error: | |
367 | return ret; | |
368 | } | |
369 | ||
094f381c MD |
370 | /* |
371 | * Create pipe and set fd flags to FD_CLOEXEC and O_NONBLOCK. | |
372 | * | |
373 | * Make sure the pipe opened by this function are closed at some point. Use | |
374 | * utils_close_pipe(). Using pipe() and fcntl rather than pipe2() to | |
375 | * support OSes other than Linux 2.6.23+. | |
376 | */ | |
377 | LTTNG_HIDDEN | |
378 | int utils_create_pipe_cloexec_nonblock(int *dst) | |
379 | { | |
380 | int ret, i; | |
381 | ||
382 | if (dst == NULL) { | |
383 | return -1; | |
384 | } | |
385 | ||
386 | ret = utils_create_pipe(dst); | |
387 | if (ret < 0) { | |
388 | goto error; | |
389 | } | |
390 | ||
391 | for (i = 0; i < 2; i++) { | |
392 | ret = fcntl(dst[i], F_SETFD, FD_CLOEXEC); | |
393 | if (ret < 0) { | |
394 | PERROR("fcntl pipe cloexec"); | |
395 | goto error; | |
396 | } | |
397 | /* | |
398 | * Note: we override any flag that could have been | |
399 | * previously set on the fd. | |
400 | */ | |
401 | ret = fcntl(dst[i], F_SETFL, O_NONBLOCK); | |
402 | if (ret < 0) { | |
403 | PERROR("fcntl pipe nonblock"); | |
404 | goto error; | |
405 | } | |
406 | } | |
407 | ||
408 | error: | |
409 | return ret; | |
410 | } | |
411 | ||
81b86775 DG |
412 | /* |
413 | * Close both read and write side of the pipe. | |
414 | */ | |
90e535ef | 415 | LTTNG_HIDDEN |
81b86775 DG |
416 | void utils_close_pipe(int *src) |
417 | { | |
418 | int i, ret; | |
419 | ||
420 | if (src == NULL) { | |
421 | return; | |
422 | } | |
423 | ||
424 | for (i = 0; i < 2; i++) { | |
425 | /* Safety check */ | |
426 | if (src[i] < 0) { | |
427 | continue; | |
428 | } | |
429 | ||
430 | ret = close(src[i]); | |
431 | if (ret) { | |
432 | PERROR("close pipe"); | |
433 | } | |
434 | } | |
435 | } | |
a4b92340 DG |
436 | |
437 | /* | |
438 | * Create a new string using two strings range. | |
439 | */ | |
90e535ef | 440 | LTTNG_HIDDEN |
a4b92340 DG |
441 | char *utils_strdupdelim(const char *begin, const char *end) |
442 | { | |
443 | char *str; | |
444 | ||
445 | str = zmalloc(end - begin + 1); | |
446 | if (str == NULL) { | |
447 | PERROR("zmalloc strdupdelim"); | |
448 | goto error; | |
449 | } | |
450 | ||
451 | memcpy(str, begin, end - begin); | |
452 | str[end - begin] = '\0'; | |
453 | ||
454 | error: | |
455 | return str; | |
456 | } | |
b662582b DG |
457 | |
458 | /* | |
459 | * Set CLOEXEC flag to the give file descriptor. | |
460 | */ | |
90e535ef | 461 | LTTNG_HIDDEN |
b662582b DG |
462 | int utils_set_fd_cloexec(int fd) |
463 | { | |
464 | int ret; | |
465 | ||
466 | if (fd < 0) { | |
467 | ret = -EINVAL; | |
468 | goto end; | |
469 | } | |
470 | ||
471 | ret = fcntl(fd, F_SETFD, FD_CLOEXEC); | |
472 | if (ret < 0) { | |
473 | PERROR("fcntl cloexec"); | |
474 | ret = -errno; | |
475 | } | |
476 | ||
477 | end: | |
478 | return ret; | |
479 | } | |
35f90c40 DG |
480 | |
481 | /* | |
482 | * Create pid file to the given path and filename. | |
483 | */ | |
90e535ef | 484 | LTTNG_HIDDEN |
35f90c40 DG |
485 | int utils_create_pid_file(pid_t pid, const char *filepath) |
486 | { | |
487 | int ret; | |
488 | FILE *fp; | |
489 | ||
490 | assert(filepath); | |
491 | ||
492 | fp = fopen(filepath, "w"); | |
493 | if (fp == NULL) { | |
494 | PERROR("open pid file %s", filepath); | |
495 | ret = -1; | |
496 | goto error; | |
497 | } | |
498 | ||
d1f721c5 | 499 | ret = fprintf(fp, "%d\n", (int) pid); |
35f90c40 DG |
500 | if (ret < 0) { |
501 | PERROR("fprintf pid file"); | |
e205d79b | 502 | goto error; |
35f90c40 DG |
503 | } |
504 | ||
e205d79b MD |
505 | if (fclose(fp)) { |
506 | PERROR("fclose"); | |
507 | } | |
d1f721c5 | 508 | DBG("Pid %d written in file %s", (int) pid, filepath); |
e205d79b | 509 | ret = 0; |
35f90c40 DG |
510 | error: |
511 | return ret; | |
512 | } | |
2d851108 | 513 | |
c9cb3e7d JG |
514 | /* |
515 | * Create lock file to the given path and filename. | |
516 | * Returns the associated file descriptor, -1 on error. | |
517 | */ | |
518 | LTTNG_HIDDEN | |
519 | int utils_create_lock_file(const char *filepath) | |
520 | { | |
521 | int ret; | |
522 | int fd; | |
77e7fddf | 523 | struct flock lock; |
c9cb3e7d JG |
524 | |
525 | assert(filepath); | |
526 | ||
77e7fddf MJ |
527 | memset(&lock, 0, sizeof(lock)); |
528 | fd = open(filepath, O_CREAT | O_WRONLY, S_IRUSR | S_IWUSR | | |
529 | S_IRGRP | S_IWGRP); | |
c9cb3e7d JG |
530 | if (fd < 0) { |
531 | PERROR("open lock file %s", filepath); | |
85a7f3f9 | 532 | fd = -1; |
c9cb3e7d JG |
533 | goto error; |
534 | } | |
535 | ||
536 | /* | |
537 | * Attempt to lock the file. If this fails, there is | |
538 | * already a process using the same lock file running | |
539 | * and we should exit. | |
540 | */ | |
77e7fddf MJ |
541 | lock.l_whence = SEEK_SET; |
542 | lock.l_type = F_WRLCK; | |
543 | ||
544 | ret = fcntl(fd, F_SETLK, &lock); | |
545 | if (ret == -1) { | |
546 | PERROR("fcntl lock file"); | |
208ff148 | 547 | ERR("Could not get lock file %s, another instance is running.", |
c9cb3e7d | 548 | filepath); |
ffb0b851 JG |
549 | if (close(fd)) { |
550 | PERROR("close lock file"); | |
551 | } | |
c9cb3e7d JG |
552 | fd = ret; |
553 | goto error; | |
554 | } | |
555 | ||
556 | error: | |
557 | return fd; | |
558 | } | |
559 | ||
a98e236e JG |
560 | /* |
561 | * On some filesystems (e.g. nfs), mkdir will validate access rights before | |
562 | * checking for the existence of the path element. This means that on a setup | |
563 | * where "/home/" is a mounted NFS share, and running as an unpriviledged user, | |
564 | * recursively creating a path of the form "/home/my_user/trace/" will fail with | |
565 | * EACCES on mkdir("/home", ...). | |
566 | * | |
567 | * Performing a stat(...) on the path to check for existence allows us to | |
568 | * work around this behaviour. | |
569 | */ | |
570 | static | |
571 | int mkdir_check_exists(const char *path, mode_t mode) | |
572 | { | |
573 | int ret = 0; | |
574 | struct stat st; | |
575 | ||
576 | ret = stat(path, &st); | |
577 | if (ret == 0) { | |
578 | if (S_ISDIR(st.st_mode)) { | |
579 | /* Directory exists, skip. */ | |
580 | goto end; | |
581 | } else { | |
582 | /* Exists, but is not a directory. */ | |
583 | errno = ENOTDIR; | |
584 | ret = -1; | |
585 | goto end; | |
586 | } | |
587 | } | |
588 | ||
589 | /* | |
590 | * Let mkdir handle other errors as the caller expects mkdir | |
591 | * semantics. | |
592 | */ | |
593 | ret = mkdir(path, mode); | |
594 | end: | |
595 | return ret; | |
596 | } | |
597 | ||
2d851108 | 598 | /* |
d77dded2 | 599 | * Create directory using the given path and mode. |
2d851108 DG |
600 | * |
601 | * On success, return 0 else a negative error code. | |
602 | */ | |
90e535ef | 603 | LTTNG_HIDDEN |
d77dded2 JG |
604 | int utils_mkdir(const char *path, mode_t mode, int uid, int gid) |
605 | { | |
606 | int ret; | |
607 | ||
608 | if (uid < 0 || gid < 0) { | |
a98e236e | 609 | ret = mkdir_check_exists(path, mode); |
d77dded2 JG |
610 | } else { |
611 | ret = run_as_mkdir(path, mode, uid, gid); | |
612 | } | |
613 | if (ret < 0) { | |
614 | if (errno != EEXIST) { | |
615 | PERROR("mkdir %s, uid %d, gid %d", path ? path : "NULL", | |
616 | uid, gid); | |
617 | } else { | |
618 | ret = 0; | |
619 | } | |
620 | } | |
621 | ||
622 | return ret; | |
623 | } | |
624 | ||
625 | /* | |
626 | * Internal version of mkdir_recursive. Runs as the current user. | |
627 | * Don't call directly; use utils_mkdir_recursive(). | |
628 | * | |
629 | * This function is ominously marked as "unsafe" since it should only | |
630 | * be called by a caller that has transitioned to the uid and gid under which | |
631 | * the directory creation should occur. | |
632 | */ | |
633 | LTTNG_HIDDEN | |
634 | int _utils_mkdir_recursive_unsafe(const char *path, mode_t mode) | |
2d851108 DG |
635 | { |
636 | char *p, tmp[PATH_MAX]; | |
2d851108 DG |
637 | size_t len; |
638 | int ret; | |
639 | ||
640 | assert(path); | |
641 | ||
642 | ret = snprintf(tmp, sizeof(tmp), "%s", path); | |
643 | if (ret < 0) { | |
644 | PERROR("snprintf mkdir"); | |
645 | goto error; | |
646 | } | |
647 | ||
648 | len = ret; | |
649 | if (tmp[len - 1] == '/') { | |
650 | tmp[len - 1] = 0; | |
651 | } | |
652 | ||
653 | for (p = tmp + 1; *p; p++) { | |
654 | if (*p == '/') { | |
655 | *p = 0; | |
656 | if (tmp[strlen(tmp) - 1] == '.' && | |
657 | tmp[strlen(tmp) - 2] == '.' && | |
658 | tmp[strlen(tmp) - 3] == '/') { | |
659 | ERR("Using '/../' is not permitted in the trace path (%s)", | |
660 | tmp); | |
661 | ret = -1; | |
662 | goto error; | |
663 | } | |
a98e236e | 664 | ret = mkdir_check_exists(tmp, mode); |
2d851108 | 665 | if (ret < 0) { |
a98e236e | 666 | if (errno != EACCES) { |
0c7bcad5 MD |
667 | PERROR("mkdir recursive"); |
668 | ret = -errno; | |
669 | goto error; | |
2d851108 DG |
670 | } |
671 | } | |
672 | *p = '/'; | |
673 | } | |
674 | } | |
675 | ||
a98e236e | 676 | ret = mkdir_check_exists(tmp, mode); |
2d851108 | 677 | if (ret < 0) { |
a98e236e JG |
678 | PERROR("mkdir recursive last element"); |
679 | ret = -errno; | |
2d851108 DG |
680 | } |
681 | ||
682 | error: | |
683 | return ret; | |
684 | } | |
fe4477ee | 685 | |
d77dded2 JG |
686 | /* |
687 | * Recursively create directory using the given path and mode, under the | |
688 | * provided uid and gid. | |
689 | * | |
690 | * On success, return 0 else a negative error code. | |
691 | */ | |
692 | LTTNG_HIDDEN | |
693 | int utils_mkdir_recursive(const char *path, mode_t mode, int uid, int gid) | |
694 | { | |
695 | int ret; | |
696 | ||
697 | if (uid < 0 || gid < 0) { | |
698 | /* Run as current user. */ | |
699 | ret = _utils_mkdir_recursive_unsafe(path, mode); | |
700 | } else { | |
701 | ret = run_as_mkdir_recursive(path, mode, uid, gid); | |
702 | } | |
703 | if (ret < 0) { | |
704 | PERROR("mkdir %s, uid %d, gid %d", path ? path : "NULL", | |
705 | uid, gid); | |
706 | } | |
707 | ||
708 | return ret; | |
709 | } | |
710 | ||
fe4477ee | 711 | /* |
d77dded2 | 712 | * path is the output parameter. It needs to be PATH_MAX len. |
fe4477ee JD |
713 | * |
714 | * Return 0 on success or else a negative value. | |
715 | */ | |
bdafebb5 JG |
716 | LTTNG_HIDDEN |
717 | int utils_stream_file_name(char *path, | |
7591bab1 MD |
718 | const char *path_name, const char *file_name, |
719 | uint64_t size, uint64_t count, | |
720 | const char *suffix) | |
fe4477ee | 721 | { |
7591bab1 MD |
722 | int ret; |
723 | char full_path[PATH_MAX]; | |
724 | char *path_name_suffix = NULL; | |
309167d2 | 725 | char *extra = NULL; |
fe4477ee | 726 | |
fe4477ee JD |
727 | ret = snprintf(full_path, sizeof(full_path), "%s/%s", |
728 | path_name, file_name); | |
729 | if (ret < 0) { | |
730 | PERROR("snprintf create output file"); | |
731 | goto error; | |
732 | } | |
733 | ||
309167d2 JD |
734 | /* Setup extra string if suffix or/and a count is needed. */ |
735 | if (size > 0 && suffix) { | |
736 | ret = asprintf(&extra, "_%" PRIu64 "%s", count, suffix); | |
737 | } else if (size > 0) { | |
738 | ret = asprintf(&extra, "_%" PRIu64, count); | |
739 | } else if (suffix) { | |
740 | ret = asprintf(&extra, "%s", suffix); | |
741 | } | |
742 | if (ret < 0) { | |
743 | PERROR("Allocating extra string to name"); | |
744 | goto error; | |
745 | } | |
746 | ||
fe4477ee | 747 | /* |
7591bab1 MD |
748 | * If we split the trace in multiple files, we have to add the count at |
749 | * the end of the tracefile name. | |
fe4477ee | 750 | */ |
309167d2 JD |
751 | if (extra) { |
752 | ret = asprintf(&path_name_suffix, "%s%s", full_path, extra); | |
fe4477ee | 753 | if (ret < 0) { |
309167d2 JD |
754 | PERROR("Allocating path name with extra string"); |
755 | goto error_free_suffix; | |
fe4477ee | 756 | } |
7591bab1 MD |
757 | strncpy(path, path_name_suffix, PATH_MAX - 1); |
758 | path[PATH_MAX - 1] = '\0'; | |
fe4477ee | 759 | } else { |
7591bab1 MD |
760 | strncpy(path, full_path, PATH_MAX - 1); |
761 | } | |
762 | path[PATH_MAX - 1] = '\0'; | |
763 | ret = 0; | |
764 | ||
765 | free(path_name_suffix); | |
766 | error_free_suffix: | |
767 | free(extra); | |
768 | error: | |
769 | return ret; | |
770 | } | |
771 | ||
772 | /* | |
773 | * Create the stream file on disk. | |
774 | * | |
775 | * Return 0 on success or else a negative value. | |
776 | */ | |
777 | LTTNG_HIDDEN | |
778 | int utils_create_stream_file(const char *path_name, char *file_name, uint64_t size, | |
779 | uint64_t count, int uid, int gid, char *suffix) | |
780 | { | |
781 | int ret, flags, mode; | |
782 | char path[PATH_MAX]; | |
783 | ||
784 | ret = utils_stream_file_name(path, path_name, file_name, | |
785 | size, count, suffix); | |
786 | if (ret < 0) { | |
787 | goto error; | |
fe4477ee JD |
788 | } |
789 | ||
be96a7d1 | 790 | flags = O_WRONLY | O_CREAT | O_TRUNC; |
0f907de1 | 791 | /* Open with 660 mode */ |
be96a7d1 DG |
792 | mode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP; |
793 | ||
794 | if (uid < 0 || gid < 0) { | |
7591bab1 | 795 | ret = open(path, flags, mode); |
be96a7d1 | 796 | } else { |
7591bab1 | 797 | ret = run_as_open(path, flags, mode, uid, gid); |
be96a7d1 | 798 | } |
7591bab1 | 799 | if (ret < 0) { |
fe4477ee | 800 | PERROR("open stream path %s", path); |
fe4477ee | 801 | } |
7591bab1 MD |
802 | error: |
803 | return ret; | |
804 | } | |
fe4477ee | 805 | |
7591bab1 MD |
806 | /* |
807 | * Unlink the stream tracefile from disk. | |
808 | * | |
809 | * Return 0 on success or else a negative value. | |
810 | */ | |
811 | LTTNG_HIDDEN | |
812 | int utils_unlink_stream_file(const char *path_name, char *file_name, uint64_t size, | |
813 | uint64_t count, int uid, int gid, char *suffix) | |
814 | { | |
815 | int ret; | |
816 | char path[PATH_MAX]; | |
817 | ||
818 | ret = utils_stream_file_name(path, path_name, file_name, | |
819 | size, count, suffix); | |
820 | if (ret < 0) { | |
821 | goto error; | |
822 | } | |
823 | if (uid < 0 || gid < 0) { | |
824 | ret = unlink(path); | |
825 | } else { | |
826 | ret = run_as_unlink(path, uid, gid); | |
7591bab1 MD |
827 | } |
828 | if (ret < 0) { | |
829 | goto error; | |
830 | } | |
fe4477ee | 831 | error: |
7591bab1 | 832 | DBG("utils_unlink_stream_file %s returns %d", path, ret); |
fe4477ee JD |
833 | return ret; |
834 | } | |
835 | ||
bdafebb5 JG |
836 | LTTNG_HIDDEN |
837 | void utils_stream_file_rotation_get_new_count(uint64_t count, | |
838 | uint64_t *new_count, bool *should_unlink) | |
839 | { | |
840 | if (count > 0) { | |
841 | /* | |
842 | * In tracefile rotation, for the relay daemon we need | |
843 | * to unlink the old file if present, because it may | |
844 | * still be open in reading by the live thread, and we | |
845 | * need to ensure that we do not overwrite the content | |
846 | * between get_index and get_packet. Since we have no | |
847 | * way to verify integrity of the data content compared | |
848 | * to the associated index, we need to ensure the reader | |
849 | * has exclusive access to the file content, and that | |
850 | * the open of the data file is performed in get_index. | |
851 | * Unlinking the old file rather than overwriting it | |
852 | * achieves this. | |
853 | */ | |
854 | if (new_count) { | |
855 | *new_count = (*new_count + 1) % count; | |
856 | } | |
857 | *should_unlink = true; | |
858 | } else { | |
859 | if (new_count) { | |
860 | (*new_count)++; | |
861 | } | |
862 | *should_unlink = false; | |
863 | } | |
864 | } | |
865 | ||
fe4477ee JD |
866 | /* |
867 | * Change the output tracefile according to the given size and count The | |
868 | * new_count pointer is set during this operation. | |
869 | * | |
870 | * From the consumer, the stream lock MUST be held before calling this function | |
871 | * because we are modifying the stream status. | |
872 | * | |
873 | * Return 0 on success or else a negative value. | |
874 | */ | |
bc182241 | 875 | LTTNG_HIDDEN |
fe4477ee | 876 | int utils_rotate_stream_file(char *path_name, char *file_name, uint64_t size, |
309167d2 JD |
877 | uint64_t count, int uid, int gid, int out_fd, uint64_t *new_count, |
878 | int *stream_fd) | |
fe4477ee JD |
879 | { |
880 | int ret; | |
bdafebb5 | 881 | bool should_unlink; |
fe4477ee | 882 | |
309167d2 JD |
883 | assert(stream_fd); |
884 | ||
bdafebb5 JG |
885 | utils_stream_file_rotation_get_new_count(count, new_count, |
886 | &should_unlink); | |
887 | ||
fe4477ee JD |
888 | ret = close(out_fd); |
889 | if (ret < 0) { | |
890 | PERROR("Closing tracefile"); | |
891 | goto error; | |
892 | } | |
b5b0c181 | 893 | *stream_fd = -1; |
fe4477ee | 894 | |
bdafebb5 | 895 | if (should_unlink) { |
93ec662e JD |
896 | ret = utils_unlink_stream_file(path_name, file_name, size, |
897 | new_count ? *new_count : 0, uid, gid, 0); | |
7591bab1 MD |
898 | if (ret < 0 && errno != ENOENT) { |
899 | goto error; | |
900 | } | |
fe4477ee JD |
901 | } |
902 | ||
93ec662e JD |
903 | ret = utils_create_stream_file(path_name, file_name, size, |
904 | new_count ? *new_count : 0, uid, gid, 0); | |
309167d2 JD |
905 | if (ret < 0) { |
906 | goto error; | |
907 | } | |
908 | *stream_fd = ret; | |
909 | ||
910 | /* Success. */ | |
911 | ret = 0; | |
912 | ||
fe4477ee JD |
913 | error: |
914 | return ret; | |
915 | } | |
70d0b120 | 916 | |
70d0b120 SM |
917 | |
918 | /** | |
919 | * Parse a string that represents a size in human readable format. It | |
5983a922 | 920 | * supports decimal integers suffixed by 'k', 'K', 'M' or 'G'. |
70d0b120 SM |
921 | * |
922 | * The suffix multiply the integer by: | |
923 | * 'k': 1024 | |
924 | * 'M': 1024^2 | |
925 | * 'G': 1024^3 | |
926 | * | |
927 | * @param str The string to parse. | |
5983a922 | 928 | * @param size Pointer to a uint64_t that will be filled with the |
cfa9a5a2 | 929 | * resulting size. |
70d0b120 SM |
930 | * |
931 | * @return 0 on success, -1 on failure. | |
932 | */ | |
00a52467 | 933 | LTTNG_HIDDEN |
5983a922 | 934 | int utils_parse_size_suffix(const char * const str, uint64_t * const size) |
70d0b120 | 935 | { |
70d0b120 | 936 | int ret; |
5983a922 | 937 | uint64_t base_size; |
70d0b120 | 938 | long shift = 0; |
5983a922 SM |
939 | const char *str_end; |
940 | char *num_end; | |
70d0b120 SM |
941 | |
942 | if (!str) { | |
5983a922 | 943 | DBG("utils_parse_size_suffix: received a NULL string."); |
70d0b120 SM |
944 | ret = -1; |
945 | goto end; | |
946 | } | |
947 | ||
5983a922 SM |
948 | /* strtoull will accept a negative number, but we don't want to. */ |
949 | if (strchr(str, '-') != NULL) { | |
950 | DBG("utils_parse_size_suffix: invalid size string, should not contain '-'."); | |
70d0b120 | 951 | ret = -1; |
5983a922 | 952 | goto end; |
70d0b120 SM |
953 | } |
954 | ||
5983a922 SM |
955 | /* str_end will point to the \0 */ |
956 | str_end = str + strlen(str); | |
70d0b120 | 957 | errno = 0; |
5983a922 | 958 | base_size = strtoull(str, &num_end, 0); |
70d0b120 | 959 | if (errno != 0) { |
5983a922 | 960 | PERROR("utils_parse_size_suffix strtoull"); |
70d0b120 | 961 | ret = -1; |
5983a922 SM |
962 | goto end; |
963 | } | |
964 | ||
965 | if (num_end == str) { | |
966 | /* strtoull parsed nothing, not good. */ | |
967 | DBG("utils_parse_size_suffix: strtoull had nothing good to parse."); | |
968 | ret = -1; | |
969 | goto end; | |
970 | } | |
971 | ||
972 | /* Check if a prefix is present. */ | |
973 | switch (*num_end) { | |
974 | case 'G': | |
975 | shift = GIBI_LOG2; | |
976 | num_end++; | |
977 | break; | |
978 | case 'M': /* */ | |
979 | shift = MEBI_LOG2; | |
980 | num_end++; | |
981 | break; | |
982 | case 'K': | |
983 | case 'k': | |
984 | shift = KIBI_LOG2; | |
985 | num_end++; | |
986 | break; | |
987 | case '\0': | |
988 | break; | |
989 | default: | |
990 | DBG("utils_parse_size_suffix: invalid suffix."); | |
991 | ret = -1; | |
992 | goto end; | |
993 | } | |
994 | ||
995 | /* Check for garbage after the valid input. */ | |
996 | if (num_end != str_end) { | |
997 | DBG("utils_parse_size_suffix: Garbage after size string."); | |
998 | ret = -1; | |
999 | goto end; | |
70d0b120 SM |
1000 | } |
1001 | ||
1002 | *size = base_size << shift; | |
1003 | ||
1004 | /* Check for overflow */ | |
1005 | if ((*size >> shift) != base_size) { | |
5983a922 | 1006 | DBG("utils_parse_size_suffix: oops, overflow detected."); |
70d0b120 | 1007 | ret = -1; |
5983a922 | 1008 | goto end; |
70d0b120 SM |
1009 | } |
1010 | ||
1011 | ret = 0; | |
70d0b120 SM |
1012 | end: |
1013 | return ret; | |
1014 | } | |
cfa9a5a2 DG |
1015 | |
1016 | /* | |
1017 | * fls: returns the position of the most significant bit. | |
1018 | * Returns 0 if no bit is set, else returns the position of the most | |
1019 | * significant bit (from 1 to 32 on 32-bit, from 1 to 64 on 64-bit). | |
1020 | */ | |
1021 | #if defined(__i386) || defined(__x86_64) | |
1022 | static inline unsigned int fls_u32(uint32_t x) | |
1023 | { | |
1024 | int r; | |
1025 | ||
1026 | asm("bsrl %1,%0\n\t" | |
1027 | "jnz 1f\n\t" | |
1028 | "movl $-1,%0\n\t" | |
1029 | "1:\n\t" | |
1030 | : "=r" (r) : "rm" (x)); | |
1031 | return r + 1; | |
1032 | } | |
1033 | #define HAS_FLS_U32 | |
1034 | #endif | |
1035 | ||
0b83088a MJ |
1036 | #if defined(__x86_64) |
1037 | static inline | |
1038 | unsigned int fls_u64(uint64_t x) | |
1039 | { | |
1040 | long r; | |
1041 | ||
1042 | asm("bsrq %1,%0\n\t" | |
1043 | "jnz 1f\n\t" | |
1044 | "movq $-1,%0\n\t" | |
1045 | "1:\n\t" | |
1046 | : "=r" (r) : "rm" (x)); | |
1047 | return r + 1; | |
1048 | } | |
1049 | #define HAS_FLS_U64 | |
1050 | #endif | |
1051 | ||
1052 | #ifndef HAS_FLS_U64 | |
1053 | static __attribute__((unused)) | |
1054 | unsigned int fls_u64(uint64_t x) | |
1055 | { | |
1056 | unsigned int r = 64; | |
1057 | ||
1058 | if (!x) | |
1059 | return 0; | |
1060 | ||
1061 | if (!(x & 0xFFFFFFFF00000000ULL)) { | |
1062 | x <<= 32; | |
1063 | r -= 32; | |
1064 | } | |
1065 | if (!(x & 0xFFFF000000000000ULL)) { | |
1066 | x <<= 16; | |
1067 | r -= 16; | |
1068 | } | |
1069 | if (!(x & 0xFF00000000000000ULL)) { | |
1070 | x <<= 8; | |
1071 | r -= 8; | |
1072 | } | |
1073 | if (!(x & 0xF000000000000000ULL)) { | |
1074 | x <<= 4; | |
1075 | r -= 4; | |
1076 | } | |
1077 | if (!(x & 0xC000000000000000ULL)) { | |
1078 | x <<= 2; | |
1079 | r -= 2; | |
1080 | } | |
1081 | if (!(x & 0x8000000000000000ULL)) { | |
1082 | x <<= 1; | |
1083 | r -= 1; | |
1084 | } | |
1085 | return r; | |
1086 | } | |
1087 | #endif | |
1088 | ||
cfa9a5a2 DG |
1089 | #ifndef HAS_FLS_U32 |
1090 | static __attribute__((unused)) unsigned int fls_u32(uint32_t x) | |
1091 | { | |
1092 | unsigned int r = 32; | |
1093 | ||
1094 | if (!x) { | |
1095 | return 0; | |
1096 | } | |
1097 | if (!(x & 0xFFFF0000U)) { | |
1098 | x <<= 16; | |
1099 | r -= 16; | |
1100 | } | |
1101 | if (!(x & 0xFF000000U)) { | |
1102 | x <<= 8; | |
1103 | r -= 8; | |
1104 | } | |
1105 | if (!(x & 0xF0000000U)) { | |
1106 | x <<= 4; | |
1107 | r -= 4; | |
1108 | } | |
1109 | if (!(x & 0xC0000000U)) { | |
1110 | x <<= 2; | |
1111 | r -= 2; | |
1112 | } | |
1113 | if (!(x & 0x80000000U)) { | |
1114 | x <<= 1; | |
1115 | r -= 1; | |
1116 | } | |
1117 | return r; | |
1118 | } | |
1119 | #endif | |
1120 | ||
1121 | /* | |
1122 | * Return the minimum order for which x <= (1UL << order). | |
1123 | * Return -1 if x is 0. | |
1124 | */ | |
1125 | LTTNG_HIDDEN | |
1126 | int utils_get_count_order_u32(uint32_t x) | |
1127 | { | |
1128 | if (!x) { | |
1129 | return -1; | |
1130 | } | |
1131 | ||
1132 | return fls_u32(x - 1); | |
1133 | } | |
feb0f3e5 | 1134 | |
0b83088a MJ |
1135 | /* |
1136 | * Return the minimum order for which x <= (1UL << order). | |
1137 | * Return -1 if x is 0. | |
1138 | */ | |
1139 | LTTNG_HIDDEN | |
1140 | int utils_get_count_order_u64(uint64_t x) | |
1141 | { | |
1142 | if (!x) { | |
1143 | return -1; | |
1144 | } | |
1145 | ||
1146 | return fls_u64(x - 1); | |
1147 | } | |
1148 | ||
feb0f3e5 AM |
1149 | /** |
1150 | * Obtain the value of LTTNG_HOME environment variable, if exists. | |
1151 | * Otherwise returns the value of HOME. | |
1152 | */ | |
00a52467 | 1153 | LTTNG_HIDDEN |
feb0f3e5 AM |
1154 | char *utils_get_home_dir(void) |
1155 | { | |
1156 | char *val = NULL; | |
04135dbd DG |
1157 | struct passwd *pwd; |
1158 | ||
e8fa9fb0 | 1159 | val = lttng_secure_getenv(DEFAULT_LTTNG_HOME_ENV_VAR); |
feb0f3e5 | 1160 | if (val != NULL) { |
04135dbd DG |
1161 | goto end; |
1162 | } | |
e8fa9fb0 | 1163 | val = lttng_secure_getenv(DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR); |
04135dbd DG |
1164 | if (val != NULL) { |
1165 | goto end; | |
feb0f3e5 | 1166 | } |
04135dbd DG |
1167 | |
1168 | /* Fallback on the password file entry. */ | |
1169 | pwd = getpwuid(getuid()); | |
1170 | if (!pwd) { | |
1171 | goto end; | |
1172 | } | |
1173 | val = pwd->pw_dir; | |
1174 | ||
1175 | DBG3("Home directory is '%s'", val); | |
1176 | ||
1177 | end: | |
1178 | return val; | |
feb0f3e5 | 1179 | } |
26fe5938 | 1180 | |
fb198a11 JG |
1181 | /** |
1182 | * Get user's home directory. Dynamically allocated, must be freed | |
1183 | * by the caller. | |
1184 | */ | |
1185 | LTTNG_HIDDEN | |
1186 | char *utils_get_user_home_dir(uid_t uid) | |
1187 | { | |
1188 | struct passwd pwd; | |
1189 | struct passwd *result; | |
1190 | char *home_dir = NULL; | |
1191 | char *buf = NULL; | |
1192 | long buflen; | |
1193 | int ret; | |
1194 | ||
1195 | buflen = sysconf(_SC_GETPW_R_SIZE_MAX); | |
1196 | if (buflen == -1) { | |
1197 | goto end; | |
1198 | } | |
1199 | retry: | |
1200 | buf = zmalloc(buflen); | |
1201 | if (!buf) { | |
1202 | goto end; | |
1203 | } | |
1204 | ||
1205 | ret = getpwuid_r(uid, &pwd, buf, buflen, &result); | |
1206 | if (ret || !result) { | |
1207 | if (ret == ERANGE) { | |
1208 | free(buf); | |
1209 | buflen *= 2; | |
1210 | goto retry; | |
1211 | } | |
1212 | goto end; | |
1213 | } | |
1214 | ||
1215 | home_dir = strdup(pwd.pw_dir); | |
1216 | end: | |
1217 | free(buf); | |
1218 | return home_dir; | |
1219 | } | |
1220 | ||
fbb9748b JG |
1221 | /* |
1222 | * Obtain the value of LTTNG_KMOD_PROBES environment variable, if exists. | |
c9d42407 | 1223 | * Otherwise returns NULL. |
fbb9748b JG |
1224 | */ |
1225 | LTTNG_HIDDEN | |
1226 | char *utils_get_kmod_probes_list(void) | |
1227 | { | |
e8fa9fb0 | 1228 | return lttng_secure_getenv(DEFAULT_LTTNG_KMOD_PROBES); |
fbb9748b JG |
1229 | } |
1230 | ||
c9d42407 PP |
1231 | /* |
1232 | * Obtain the value of LTTNG_EXTRA_KMOD_PROBES environment variable, if | |
1233 | * exists. Otherwise returns NULL. | |
1234 | */ | |
1235 | LTTNG_HIDDEN | |
1236 | char *utils_get_extra_kmod_probes_list(void) | |
1237 | { | |
e8fa9fb0 | 1238 | return lttng_secure_getenv(DEFAULT_LTTNG_EXTRA_KMOD_PROBES); |
c9d42407 PP |
1239 | } |
1240 | ||
26fe5938 DG |
1241 | /* |
1242 | * With the given format, fill dst with the time of len maximum siz. | |
1243 | * | |
1244 | * Return amount of bytes set in the buffer or else 0 on error. | |
1245 | */ | |
1246 | LTTNG_HIDDEN | |
1247 | size_t utils_get_current_time_str(const char *format, char *dst, size_t len) | |
1248 | { | |
1249 | size_t ret; | |
1250 | time_t rawtime; | |
1251 | struct tm *timeinfo; | |
1252 | ||
1253 | assert(format); | |
1254 | assert(dst); | |
1255 | ||
1256 | /* Get date and time for session path */ | |
1257 | time(&rawtime); | |
1258 | timeinfo = localtime(&rawtime); | |
1259 | ret = strftime(dst, len, format, timeinfo); | |
1260 | if (ret == 0) { | |
68e6efdd | 1261 | ERR("Unable to strftime with format %s at dst %p of len %zu", format, |
26fe5938 DG |
1262 | dst, len); |
1263 | } | |
1264 | ||
1265 | return ret; | |
1266 | } | |
6c71277b MD |
1267 | |
1268 | /* | |
1269 | * Return the group ID matching name, else 0 if it cannot be found. | |
1270 | */ | |
1271 | LTTNG_HIDDEN | |
1272 | gid_t utils_get_group_id(const char *name) | |
1273 | { | |
1274 | struct group *grp; | |
1275 | ||
1276 | grp = getgrnam(name); | |
1277 | if (!grp) { | |
1278 | static volatile int warn_once; | |
1279 | ||
1280 | if (!warn_once) { | |
1281 | WARN("No tracing group detected"); | |
1282 | warn_once = 1; | |
1283 | } | |
1284 | return 0; | |
1285 | } | |
1286 | return grp->gr_gid; | |
1287 | } | |
8db0dc00 JG |
1288 | |
1289 | /* | |
1290 | * Return a newly allocated option string. This string is to be used as the | |
1291 | * optstring argument of getopt_long(), see GETOPT(3). opt_count is the number | |
1292 | * of elements in the long_options array. Returns NULL if the string's | |
1293 | * allocation fails. | |
1294 | */ | |
1295 | LTTNG_HIDDEN | |
1296 | char *utils_generate_optstring(const struct option *long_options, | |
1297 | size_t opt_count) | |
1298 | { | |
1299 | int i; | |
1300 | size_t string_len = opt_count, str_pos = 0; | |
1301 | char *optstring; | |
1302 | ||
1303 | /* | |
1304 | * Compute the necessary string length. One letter per option, two when an | |
1305 | * argument is necessary, and a trailing NULL. | |
1306 | */ | |
1307 | for (i = 0; i < opt_count; i++) { | |
1308 | string_len += long_options[i].has_arg ? 1 : 0; | |
1309 | } | |
1310 | ||
1311 | optstring = zmalloc(string_len); | |
1312 | if (!optstring) { | |
1313 | goto end; | |
1314 | } | |
1315 | ||
1316 | for (i = 0; i < opt_count; i++) { | |
1317 | if (!long_options[i].name) { | |
1318 | /* Got to the trailing NULL element */ | |
1319 | break; | |
1320 | } | |
1321 | ||
a596dcb9 JG |
1322 | if (long_options[i].val != '\0') { |
1323 | optstring[str_pos++] = (char) long_options[i].val; | |
1324 | if (long_options[i].has_arg) { | |
1325 | optstring[str_pos++] = ':'; | |
1326 | } | |
8db0dc00 JG |
1327 | } |
1328 | } | |
1329 | ||
1330 | end: | |
1331 | return optstring; | |
1332 | } | |
3d071855 MD |
1333 | |
1334 | /* | |
1335 | * Try to remove a hierarchy of empty directories, recursively. Don't unlink | |
9529ec1b | 1336 | * any file. Try to rmdir any empty directory within the hierarchy. |
3d071855 MD |
1337 | */ |
1338 | LTTNG_HIDDEN | |
1339 | int utils_recursive_rmdir(const char *path) | |
1340 | { | |
1341 | DIR *dir; | |
7a946beb | 1342 | size_t path_len; |
9529ec1b | 1343 | int dir_fd, ret = 0, closeret, is_empty = 1; |
3d071855 MD |
1344 | struct dirent *entry; |
1345 | ||
1346 | /* Open directory */ | |
1347 | dir = opendir(path); | |
1348 | if (!dir) { | |
1349 | PERROR("Cannot open '%s' path", path); | |
1350 | return -1; | |
1351 | } | |
5a2451c9 | 1352 | dir_fd = lttng_dirfd(dir); |
3d071855 | 1353 | if (dir_fd < 0) { |
5a2451c9 | 1354 | PERROR("lttng_dirfd"); |
3d071855 MD |
1355 | return -1; |
1356 | } | |
1357 | ||
7a946beb | 1358 | path_len = strlen(path); |
3d071855 | 1359 | while ((entry = readdir(dir))) { |
7a946beb MJ |
1360 | struct stat st; |
1361 | size_t name_len; | |
1362 | char filename[PATH_MAX]; | |
1363 | ||
3763af87 JG |
1364 | if (!strcmp(entry->d_name, ".") |
1365 | || !strcmp(entry->d_name, "..")) { | |
1366 | continue; | |
1367 | } | |
1368 | ||
7a946beb MJ |
1369 | name_len = strlen(entry->d_name); |
1370 | if (path_len + name_len + 2 > sizeof(filename)) { | |
1371 | ERR("Failed to remove file: path name too long (%s/%s)", | |
1372 | path, entry->d_name); | |
1373 | continue; | |
1374 | } | |
1375 | if (snprintf(filename, sizeof(filename), "%s/%s", | |
1376 | path, entry->d_name) < 0) { | |
1377 | ERR("Failed to format path."); | |
1378 | continue; | |
1379 | } | |
1380 | ||
1381 | if (stat(filename, &st)) { | |
1382 | PERROR("stat"); | |
1383 | continue; | |
1384 | } | |
1385 | ||
1386 | if (S_ISDIR(st.st_mode)) { | |
3d071855 MD |
1387 | char subpath[PATH_MAX]; |
1388 | ||
1389 | strncpy(subpath, path, PATH_MAX); | |
1390 | subpath[PATH_MAX - 1] = '\0'; | |
1391 | strncat(subpath, "/", | |
1392 | PATH_MAX - strlen(subpath) - 1); | |
1393 | strncat(subpath, entry->d_name, | |
1394 | PATH_MAX - strlen(subpath) - 1); | |
9529ec1b MD |
1395 | if (utils_recursive_rmdir(subpath)) { |
1396 | is_empty = 0; | |
3d071855 | 1397 | } |
7a946beb | 1398 | } else if (S_ISREG(st.st_mode)) { |
9529ec1b | 1399 | is_empty = 0; |
7a946beb | 1400 | } else { |
3d071855 MD |
1401 | ret = -EINVAL; |
1402 | goto end; | |
1403 | } | |
1404 | } | |
1405 | end: | |
1406 | closeret = closedir(dir); | |
1407 | if (closeret) { | |
1408 | PERROR("closedir"); | |
1409 | } | |
9529ec1b | 1410 | if (is_empty) { |
3d071855 MD |
1411 | DBG3("Attempting rmdir %s", path); |
1412 | ret = rmdir(path); | |
1413 | } | |
1414 | return ret; | |
1415 | } | |
93ec662e JD |
1416 | |
1417 | LTTNG_HIDDEN | |
1418 | int utils_truncate_stream_file(int fd, off_t length) | |
1419 | { | |
1420 | int ret; | |
b61e1dca | 1421 | off_t lseek_ret; |
93ec662e JD |
1422 | |
1423 | ret = ftruncate(fd, length); | |
1424 | if (ret < 0) { | |
1425 | PERROR("ftruncate"); | |
1426 | goto end; | |
1427 | } | |
b61e1dca GL |
1428 | lseek_ret = lseek(fd, length, SEEK_SET); |
1429 | if (lseek_ret < 0) { | |
93ec662e | 1430 | PERROR("lseek"); |
b61e1dca | 1431 | ret = -1; |
93ec662e JD |
1432 | goto end; |
1433 | } | |
93ec662e JD |
1434 | end: |
1435 | return ret; | |
1436 | } | |
4ba92f18 PP |
1437 | |
1438 | static const char *get_man_bin_path(void) | |
1439 | { | |
b7dce40d | 1440 | char *env_man_path = lttng_secure_getenv(DEFAULT_MAN_BIN_PATH_ENV); |
4ba92f18 PP |
1441 | |
1442 | if (env_man_path) { | |
1443 | return env_man_path; | |
1444 | } | |
1445 | ||
1446 | return DEFAULT_MAN_BIN_PATH; | |
1447 | } | |
1448 | ||
1449 | LTTNG_HIDDEN | |
1450 | int utils_show_man_page(int section, const char *page_name) | |
1451 | { | |
1452 | char section_string[8]; | |
1453 | const char *man_bin_path = get_man_bin_path(); | |
1454 | int ret; | |
1455 | ||
1456 | /* Section integer -> section string */ | |
1457 | ret = sprintf(section_string, "%d", section); | |
1458 | assert(ret > 0 && ret < 8); | |
1459 | ||
1460 | /* | |
1461 | * Execute man pager. | |
1462 | * | |
b07e7ef0 | 1463 | * We provide -M to man here because LTTng-tools can |
4ba92f18 PP |
1464 | * be installed outside /usr, in which case its man pages are |
1465 | * not located in the default /usr/share/man directory. | |
1466 | */ | |
b07e7ef0 | 1467 | ret = execlp(man_bin_path, "man", "-M", MANPATH, |
4ba92f18 PP |
1468 | section_string, page_name, NULL); |
1469 | return ret; | |
1470 | } | |
76375580 JR |
1471 | |
1472 | LTTNG_HIDDEN | |
1473 | int utils_change_working_dir(const char *path) | |
1474 | { | |
1475 | int ret; | |
1476 | ||
1477 | assert(path); | |
1478 | ||
1479 | ret = chdir(path); | |
1480 | if (ret) { | |
1481 | PERROR("Failed to change working directory: %s", path); | |
1482 | goto end; | |
1483 | } | |
1484 | ||
1485 | /* Check for write access */ | |
1486 | if (access(path, W_OK)) { | |
1487 | if (errno == EACCES) { | |
1488 | /* | |
1489 | * Do not treat this as an error since the permission | |
1490 | * might change in the lifetime of the process | |
1491 | */ | |
1492 | DBG("Working directory is not writable: %s", path); | |
1493 | } else { | |
1494 | PERROR("access"); | |
1495 | } | |
1496 | } | |
1497 | ||
1498 | end: | |
1499 | return ret; | |
1500 | } | |
9cc0ed0d MD |
1501 | |
1502 | LTTNG_HIDDEN | |
1503 | int timespec_to_ms(struct timespec ts, unsigned long *ms) | |
1504 | { | |
1505 | unsigned long res, remain_ms; | |
1506 | ||
1507 | if (ts.tv_sec > ULONG_MAX / MSEC_PER_SEC) { | |
1508 | errno = EOVERFLOW; | |
1509 | return -1; /* multiplication overflow */ | |
1510 | } | |
1511 | res = ts.tv_sec * MSEC_PER_SEC; | |
1512 | remain_ms = ULONG_MAX - res; | |
1513 | if (ts.tv_nsec / NSEC_PER_MSEC > remain_ms) { | |
1514 | errno = EOVERFLOW; | |
1515 | return -1; /* addition overflow */ | |
1516 | } | |
1517 | res += ts.tv_nsec / NSEC_PER_MSEC; | |
1518 | *ms = res; | |
1519 | return 0; | |
1520 | } | |
1521 | ||
1522 | LTTNG_HIDDEN | |
1523 | struct timespec timespec_abs_diff(struct timespec t1, struct timespec t2) | |
1524 | { | |
1525 | uint64_t ts1 = (uint64_t) t1.tv_sec * (uint64_t) NSEC_PER_SEC + | |
1526 | (uint64_t) t1.tv_nsec; | |
1527 | uint64_t ts2 = (uint64_t) t2.tv_sec * (uint64_t) NSEC_PER_SEC + | |
1528 | (uint64_t) t2.tv_nsec; | |
1529 | uint64_t diff = max(ts1, ts2) - min(ts1, ts2); | |
1530 | struct timespec res; | |
1531 | ||
1532 | res.tv_sec = diff / (uint64_t) NSEC_PER_SEC; | |
1533 | res.tv_nsec = diff % (uint64_t) NSEC_PER_SEC; | |
1534 | return res; | |
1535 | } |