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 | ||
20 | #define _GNU_SOURCE | |
6c1c0768 | 21 | #define _LGPL_SOURCE |
35f90c40 | 22 | #include <assert.h> |
81b86775 DG |
23 | #include <ctype.h> |
24 | #include <fcntl.h> | |
25 | #include <limits.h> | |
26 | #include <stdlib.h> | |
27 | #include <string.h> | |
2d851108 | 28 | #include <sys/stat.h> |
0c7bcad5 | 29 | #include <sys/types.h> |
2d851108 | 30 | #include <unistd.h> |
fe4477ee | 31 | #include <inttypes.h> |
6c71277b | 32 | #include <grp.h> |
fb198a11 | 33 | #include <pwd.h> |
c9cb3e7d | 34 | #include <sys/file.h> |
3d071855 | 35 | #include <dirent.h> |
81b86775 DG |
36 | |
37 | #include <common/common.h> | |
fe4477ee | 38 | #include <common/runas.h> |
e8fa9fb0 | 39 | #include <common/compat/getenv.h> |
81b86775 DG |
40 | |
41 | #include "utils.h" | |
feb0f3e5 | 42 | #include "defaults.h" |
81b86775 | 43 | |
5154230f RB |
44 | /* |
45 | * Return a partial realpath(3) of the path even if the full path does not | |
46 | * exist. For instance, with /tmp/test1/test2/test3, if test2/ does not exist | |
47 | * but the /tmp/test1 does, the real path for /tmp/test1 is concatened with | |
48 | * /test2/test3 then returned. In normal time, realpath(3) fails if the end | |
49 | * point directory does not exist. | |
50 | * In case resolved_path is NULL, the string returned was allocated in the | |
51 | * function and thus need to be freed by the caller. The size argument allows | |
52 | * to specify the size of the resolved_path argument if given, or the size to | |
53 | * allocate. | |
54 | */ | |
55 | LTTNG_HIDDEN | |
56 | char *utils_partial_realpath(const char *path, char *resolved_path, size_t size) | |
57 | { | |
58 | char *cut_path, *try_path = NULL, *try_path_prev = NULL; | |
59 | const char *next, *prev, *end; | |
60 | ||
61 | /* Safety net */ | |
62 | if (path == NULL) { | |
63 | goto error; | |
64 | } | |
65 | ||
66 | /* | |
67 | * Identify the end of the path, we don't want to treat the | |
68 | * last char if it is a '/', we will just keep it on the side | |
69 | * to be added at the end, and return a value coherent with | |
70 | * the path given as argument | |
71 | */ | |
72 | end = path + strlen(path); | |
73 | if (*(end-1) == '/') { | |
74 | end--; | |
75 | } | |
76 | ||
77 | /* Initiate the values of the pointers before looping */ | |
78 | next = path; | |
79 | prev = next; | |
80 | /* Only to ensure try_path is not NULL to enter the while */ | |
81 | try_path = (char *)next; | |
82 | ||
83 | /* Resolve the canonical path of the first part of the path */ | |
84 | while (try_path != NULL && next != end) { | |
85 | /* | |
86 | * If there is not any '/' left, we want to try with | |
87 | * the full path | |
88 | */ | |
89 | next = strpbrk(next + 1, "/"); | |
90 | if (next == NULL) { | |
91 | next = end; | |
92 | } | |
93 | ||
94 | /* Cut the part we will be trying to resolve */ | |
95 | cut_path = strndup(path, next - path); | |
d9dbcf5e MD |
96 | if (cut_path == NULL) { |
97 | PERROR("strndup"); | |
98 | goto error; | |
99 | } | |
5154230f RB |
100 | |
101 | /* Try to resolve this part */ | |
102 | try_path = realpath((char *)cut_path, NULL); | |
103 | if (try_path == NULL) { | |
104 | /* | |
105 | * There was an error, we just want to be assured it | |
106 | * is linked to an unexistent directory, if it's another | |
107 | * reason, we spawn an error | |
108 | */ | |
109 | switch (errno) { | |
110 | case ENOENT: | |
111 | /* Ignore the error */ | |
112 | break; | |
113 | default: | |
114 | PERROR("realpath (partial_realpath)"); | |
115 | goto error; | |
116 | break; | |
117 | } | |
118 | } else { | |
119 | /* Save the place we are before trying the next step */ | |
120 | free(try_path_prev); | |
121 | try_path_prev = try_path; | |
122 | prev = next; | |
123 | } | |
124 | ||
125 | /* Free the allocated memory */ | |
126 | free(cut_path); | |
127 | }; | |
128 | ||
129 | /* Allocate memory for the resolved path if necessary */ | |
130 | if (resolved_path == NULL) { | |
131 | resolved_path = zmalloc(size); | |
132 | if (resolved_path == NULL) { | |
133 | PERROR("zmalloc resolved path"); | |
134 | goto error; | |
135 | } | |
136 | } | |
137 | ||
138 | /* | |
139 | * If we were able to solve at least partially the path, we can concatenate | |
140 | * what worked and what didn't work | |
141 | */ | |
142 | if (try_path_prev != NULL) { | |
143 | /* If we risk to concatenate two '/', we remove one of them */ | |
144 | if (try_path_prev[strlen(try_path_prev) - 1] == '/' && prev[0] == '/') { | |
145 | try_path_prev[strlen(try_path_prev) - 1] = '\0'; | |
146 | } | |
147 | ||
148 | /* | |
149 | * Duplicate the memory used by prev in case resolved_path and | |
150 | * path are pointers for the same memory space | |
151 | */ | |
152 | cut_path = strdup(prev); | |
d9dbcf5e MD |
153 | if (cut_path == NULL) { |
154 | PERROR("strdup"); | |
155 | goto error; | |
156 | } | |
5154230f RB |
157 | |
158 | /* Concatenate the strings */ | |
159 | snprintf(resolved_path, size, "%s%s", try_path_prev, cut_path); | |
160 | ||
161 | /* Free the allocated memory */ | |
162 | free(cut_path); | |
163 | free(try_path_prev); | |
164 | /* | |
165 | * Else, we just copy the path in our resolved_path to | |
166 | * return it as is | |
167 | */ | |
168 | } else { | |
169 | strncpy(resolved_path, path, size); | |
170 | } | |
171 | ||
172 | /* Then we return the 'partially' resolved path */ | |
173 | return resolved_path; | |
174 | ||
175 | error: | |
176 | free(resolved_path); | |
177 | return NULL; | |
178 | } | |
179 | ||
81b86775 | 180 | /* |
3d229795 RB |
181 | * Make a full resolution of the given path even if it doesn't exist. |
182 | * This function uses the utils_partial_realpath function to resolve | |
183 | * symlinks and relatives paths at the start of the string, and | |
184 | * implements functionnalities to resolve the './' and '../' strings | |
185 | * in the middle of a path. This function is only necessary because | |
186 | * realpath(3) does not accept to resolve unexistent paths. | |
187 | * The returned string was allocated in the function, it is thus of | |
188 | * the responsibility of the caller to free this memory. | |
81b86775 | 189 | */ |
90e535ef | 190 | LTTNG_HIDDEN |
81b86775 DG |
191 | char *utils_expand_path(const char *path) |
192 | { | |
3d229795 | 193 | char *next, *previous, *slash, *start_path, *absolute_path = NULL; |
5de083f4 RB |
194 | char *last_token; |
195 | int is_dot, is_dotdot; | |
81b86775 DG |
196 | |
197 | /* Safety net */ | |
198 | if (path == NULL) { | |
199 | goto error; | |
200 | } | |
201 | ||
3d229795 RB |
202 | /* Allocate memory for the absolute_path */ |
203 | absolute_path = zmalloc(PATH_MAX); | |
204 | if (absolute_path == NULL) { | |
81b86775 DG |
205 | PERROR("zmalloc expand path"); |
206 | goto error; | |
207 | } | |
208 | ||
3d229795 RB |
209 | /* |
210 | * If the path is not already absolute nor explicitly relative, | |
211 | * consider we're in the current directory | |
212 | */ | |
213 | if (*path != '/' && strncmp(path, "./", 2) != 0 && | |
214 | strncmp(path, "../", 3) != 0) { | |
215 | snprintf(absolute_path, PATH_MAX, "./%s", path); | |
2dcd84b7 | 216 | /* Else, we just copy the path */ |
116f95d9 | 217 | } else { |
3d229795 RB |
218 | strncpy(absolute_path, path, PATH_MAX); |
219 | } | |
116f95d9 | 220 | |
3d229795 RB |
221 | /* Resolve partially our path */ |
222 | absolute_path = utils_partial_realpath(absolute_path, | |
223 | absolute_path, PATH_MAX); | |
116f95d9 | 224 | |
3d229795 RB |
225 | /* As long as we find '/./' in the working_path string */ |
226 | while ((next = strstr(absolute_path, "/./"))) { | |
116f95d9 | 227 | |
3d229795 RB |
228 | /* We prepare the start_path not containing it */ |
229 | start_path = strndup(absolute_path, next - absolute_path); | |
d9dbcf5e MD |
230 | if (!start_path) { |
231 | PERROR("strndup"); | |
232 | goto error; | |
233 | } | |
3d229795 RB |
234 | /* And we concatenate it with the part after this string */ |
235 | snprintf(absolute_path, PATH_MAX, "%s%s", start_path, next + 2); | |
116f95d9 | 236 | |
3d229795 RB |
237 | free(start_path); |
238 | } | |
116f95d9 | 239 | |
3d229795 RB |
240 | /* As long as we find '/../' in the working_path string */ |
241 | while ((next = strstr(absolute_path, "/../"))) { | |
242 | /* We find the last level of directory */ | |
243 | previous = absolute_path; | |
244 | while ((slash = strpbrk(previous, "/")) && slash != next) { | |
245 | previous = slash + 1; | |
81b86775 | 246 | } |
81b86775 | 247 | |
3d229795 RB |
248 | /* Then we prepare the start_path not containing it */ |
249 | start_path = strndup(absolute_path, previous - absolute_path); | |
d9dbcf5e MD |
250 | if (!start_path) { |
251 | PERROR("strndup"); | |
252 | goto error; | |
253 | } | |
3d229795 RB |
254 | |
255 | /* And we concatenate it with the part after the '/../' */ | |
256 | snprintf(absolute_path, PATH_MAX, "%s%s", start_path, next + 4); | |
257 | ||
258 | /* We can free the memory used for the start path*/ | |
259 | free(start_path); | |
260 | ||
261 | /* Then we verify for symlinks using partial_realpath */ | |
262 | absolute_path = utils_partial_realpath(absolute_path, | |
263 | absolute_path, PATH_MAX); | |
116f95d9 | 264 | } |
81b86775 | 265 | |
5de083f4 RB |
266 | /* Identify the last token */ |
267 | last_token = strrchr(absolute_path, '/'); | |
268 | ||
269 | /* Verify that this token is not a relative path */ | |
270 | is_dotdot = (strcmp(last_token, "/..") == 0); | |
271 | is_dot = (strcmp(last_token, "/.") == 0); | |
272 | ||
273 | /* If it is, take action */ | |
274 | if (is_dot || is_dotdot) { | |
275 | /* For both, remove this token */ | |
276 | *last_token = '\0'; | |
277 | ||
278 | /* If it was a reference to parent directory, go back one more time */ | |
279 | if (is_dotdot) { | |
280 | last_token = strrchr(absolute_path, '/'); | |
281 | ||
282 | /* If there was only one level left, we keep the first '/' */ | |
283 | if (last_token == absolute_path) { | |
284 | last_token++; | |
285 | } | |
286 | ||
287 | *last_token = '\0'; | |
288 | } | |
289 | } | |
290 | ||
3d229795 | 291 | return absolute_path; |
81b86775 DG |
292 | |
293 | error: | |
3d229795 | 294 | free(absolute_path); |
81b86775 DG |
295 | return NULL; |
296 | } | |
297 | ||
298 | /* | |
299 | * Create a pipe in dst. | |
300 | */ | |
90e535ef | 301 | LTTNG_HIDDEN |
81b86775 DG |
302 | int utils_create_pipe(int *dst) |
303 | { | |
304 | int ret; | |
305 | ||
306 | if (dst == NULL) { | |
307 | return -1; | |
308 | } | |
309 | ||
310 | ret = pipe(dst); | |
311 | if (ret < 0) { | |
312 | PERROR("create pipe"); | |
313 | } | |
314 | ||
315 | return ret; | |
316 | } | |
317 | ||
318 | /* | |
319 | * Create pipe and set CLOEXEC flag to both fd. | |
320 | * | |
321 | * Make sure the pipe opened by this function are closed at some point. Use | |
322 | * utils_close_pipe(). | |
323 | */ | |
90e535ef | 324 | LTTNG_HIDDEN |
81b86775 DG |
325 | int utils_create_pipe_cloexec(int *dst) |
326 | { | |
327 | int ret, i; | |
328 | ||
329 | if (dst == NULL) { | |
330 | return -1; | |
331 | } | |
332 | ||
333 | ret = utils_create_pipe(dst); | |
334 | if (ret < 0) { | |
335 | goto error; | |
336 | } | |
337 | ||
338 | for (i = 0; i < 2; i++) { | |
339 | ret = fcntl(dst[i], F_SETFD, FD_CLOEXEC); | |
340 | if (ret < 0) { | |
341 | PERROR("fcntl pipe cloexec"); | |
342 | goto error; | |
343 | } | |
344 | } | |
345 | ||
346 | error: | |
347 | return ret; | |
348 | } | |
349 | ||
094f381c MD |
350 | /* |
351 | * Create pipe and set fd flags to FD_CLOEXEC and O_NONBLOCK. | |
352 | * | |
353 | * Make sure the pipe opened by this function are closed at some point. Use | |
354 | * utils_close_pipe(). Using pipe() and fcntl rather than pipe2() to | |
355 | * support OSes other than Linux 2.6.23+. | |
356 | */ | |
357 | LTTNG_HIDDEN | |
358 | int utils_create_pipe_cloexec_nonblock(int *dst) | |
359 | { | |
360 | int ret, i; | |
361 | ||
362 | if (dst == NULL) { | |
363 | return -1; | |
364 | } | |
365 | ||
366 | ret = utils_create_pipe(dst); | |
367 | if (ret < 0) { | |
368 | goto error; | |
369 | } | |
370 | ||
371 | for (i = 0; i < 2; i++) { | |
372 | ret = fcntl(dst[i], F_SETFD, FD_CLOEXEC); | |
373 | if (ret < 0) { | |
374 | PERROR("fcntl pipe cloexec"); | |
375 | goto error; | |
376 | } | |
377 | /* | |
378 | * Note: we override any flag that could have been | |
379 | * previously set on the fd. | |
380 | */ | |
381 | ret = fcntl(dst[i], F_SETFL, O_NONBLOCK); | |
382 | if (ret < 0) { | |
383 | PERROR("fcntl pipe nonblock"); | |
384 | goto error; | |
385 | } | |
386 | } | |
387 | ||
388 | error: | |
389 | return ret; | |
390 | } | |
391 | ||
81b86775 DG |
392 | /* |
393 | * Close both read and write side of the pipe. | |
394 | */ | |
90e535ef | 395 | LTTNG_HIDDEN |
81b86775 DG |
396 | void utils_close_pipe(int *src) |
397 | { | |
398 | int i, ret; | |
399 | ||
400 | if (src == NULL) { | |
401 | return; | |
402 | } | |
403 | ||
404 | for (i = 0; i < 2; i++) { | |
405 | /* Safety check */ | |
406 | if (src[i] < 0) { | |
407 | continue; | |
408 | } | |
409 | ||
410 | ret = close(src[i]); | |
411 | if (ret) { | |
412 | PERROR("close pipe"); | |
413 | } | |
414 | } | |
415 | } | |
a4b92340 DG |
416 | |
417 | /* | |
418 | * Create a new string using two strings range. | |
419 | */ | |
90e535ef | 420 | LTTNG_HIDDEN |
a4b92340 DG |
421 | char *utils_strdupdelim(const char *begin, const char *end) |
422 | { | |
423 | char *str; | |
424 | ||
425 | str = zmalloc(end - begin + 1); | |
426 | if (str == NULL) { | |
427 | PERROR("zmalloc strdupdelim"); | |
428 | goto error; | |
429 | } | |
430 | ||
431 | memcpy(str, begin, end - begin); | |
432 | str[end - begin] = '\0'; | |
433 | ||
434 | error: | |
435 | return str; | |
436 | } | |
b662582b DG |
437 | |
438 | /* | |
439 | * Set CLOEXEC flag to the give file descriptor. | |
440 | */ | |
90e535ef | 441 | LTTNG_HIDDEN |
b662582b DG |
442 | int utils_set_fd_cloexec(int fd) |
443 | { | |
444 | int ret; | |
445 | ||
446 | if (fd < 0) { | |
447 | ret = -EINVAL; | |
448 | goto end; | |
449 | } | |
450 | ||
451 | ret = fcntl(fd, F_SETFD, FD_CLOEXEC); | |
452 | if (ret < 0) { | |
453 | PERROR("fcntl cloexec"); | |
454 | ret = -errno; | |
455 | } | |
456 | ||
457 | end: | |
458 | return ret; | |
459 | } | |
35f90c40 DG |
460 | |
461 | /* | |
462 | * Create pid file to the given path and filename. | |
463 | */ | |
90e535ef | 464 | LTTNG_HIDDEN |
35f90c40 DG |
465 | int utils_create_pid_file(pid_t pid, const char *filepath) |
466 | { | |
467 | int ret; | |
468 | FILE *fp; | |
469 | ||
470 | assert(filepath); | |
471 | ||
472 | fp = fopen(filepath, "w"); | |
473 | if (fp == NULL) { | |
474 | PERROR("open pid file %s", filepath); | |
475 | ret = -1; | |
476 | goto error; | |
477 | } | |
478 | ||
479 | ret = fprintf(fp, "%d\n", pid); | |
480 | if (ret < 0) { | |
481 | PERROR("fprintf pid file"); | |
e205d79b | 482 | goto error; |
35f90c40 DG |
483 | } |
484 | ||
e205d79b MD |
485 | if (fclose(fp)) { |
486 | PERROR("fclose"); | |
487 | } | |
35f90c40 | 488 | DBG("Pid %d written in file %s", pid, filepath); |
e205d79b | 489 | ret = 0; |
35f90c40 DG |
490 | error: |
491 | return ret; | |
492 | } | |
2d851108 | 493 | |
c9cb3e7d JG |
494 | /* |
495 | * Create lock file to the given path and filename. | |
496 | * Returns the associated file descriptor, -1 on error. | |
497 | */ | |
498 | LTTNG_HIDDEN | |
499 | int utils_create_lock_file(const char *filepath) | |
500 | { | |
501 | int ret; | |
502 | int fd; | |
503 | ||
504 | assert(filepath); | |
505 | ||
506 | fd = open(filepath, O_CREAT, | |
507 | O_WRONLY | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP); | |
508 | if (fd < 0) { | |
509 | PERROR("open lock file %s", filepath); | |
510 | ret = -1; | |
511 | goto error; | |
512 | } | |
513 | ||
514 | /* | |
515 | * Attempt to lock the file. If this fails, there is | |
516 | * already a process using the same lock file running | |
517 | * and we should exit. | |
518 | */ | |
519 | ret = flock(fd, LOCK_EX | LOCK_NB); | |
520 | if (ret) { | |
208ff148 | 521 | ERR("Could not get lock file %s, another instance is running.", |
c9cb3e7d | 522 | filepath); |
ffb0b851 JG |
523 | if (close(fd)) { |
524 | PERROR("close lock file"); | |
525 | } | |
c9cb3e7d JG |
526 | fd = ret; |
527 | goto error; | |
528 | } | |
529 | ||
530 | error: | |
531 | return fd; | |
532 | } | |
533 | ||
2d851108 DG |
534 | /* |
535 | * Recursively create directory using the given path and mode. | |
536 | * | |
537 | * On success, return 0 else a negative error code. | |
538 | */ | |
90e535ef | 539 | LTTNG_HIDDEN |
2d851108 DG |
540 | int utils_mkdir_recursive(const char *path, mode_t mode) |
541 | { | |
542 | char *p, tmp[PATH_MAX]; | |
2d851108 DG |
543 | size_t len; |
544 | int ret; | |
545 | ||
546 | assert(path); | |
547 | ||
548 | ret = snprintf(tmp, sizeof(tmp), "%s", path); | |
549 | if (ret < 0) { | |
550 | PERROR("snprintf mkdir"); | |
551 | goto error; | |
552 | } | |
553 | ||
554 | len = ret; | |
555 | if (tmp[len - 1] == '/') { | |
556 | tmp[len - 1] = 0; | |
557 | } | |
558 | ||
559 | for (p = tmp + 1; *p; p++) { | |
560 | if (*p == '/') { | |
561 | *p = 0; | |
562 | if (tmp[strlen(tmp) - 1] == '.' && | |
563 | tmp[strlen(tmp) - 2] == '.' && | |
564 | tmp[strlen(tmp) - 3] == '/') { | |
565 | ERR("Using '/../' is not permitted in the trace path (%s)", | |
566 | tmp); | |
567 | ret = -1; | |
568 | goto error; | |
569 | } | |
0c7bcad5 | 570 | ret = mkdir(tmp, mode); |
2d851108 | 571 | if (ret < 0) { |
0c7bcad5 MD |
572 | if (errno != EEXIST) { |
573 | PERROR("mkdir recursive"); | |
574 | ret = -errno; | |
575 | goto error; | |
2d851108 DG |
576 | } |
577 | } | |
578 | *p = '/'; | |
579 | } | |
580 | } | |
581 | ||
582 | ret = mkdir(tmp, mode); | |
583 | if (ret < 0) { | |
584 | if (errno != EEXIST) { | |
585 | PERROR("mkdir recursive last piece"); | |
586 | ret = -errno; | |
587 | } else { | |
588 | ret = 0; | |
589 | } | |
590 | } | |
591 | ||
592 | error: | |
593 | return ret; | |
594 | } | |
fe4477ee JD |
595 | |
596 | /* | |
597 | * Create the stream tracefile on disk. | |
598 | * | |
599 | * Return 0 on success or else a negative value. | |
600 | */ | |
bc182241 | 601 | LTTNG_HIDDEN |
07b86b52 | 602 | int utils_create_stream_file(const char *path_name, char *file_name, uint64_t size, |
309167d2 | 603 | uint64_t count, int uid, int gid, char *suffix) |
fe4477ee | 604 | { |
be96a7d1 | 605 | int ret, out_fd, flags, mode; |
309167d2 JD |
606 | char full_path[PATH_MAX], *path_name_suffix = NULL, *path; |
607 | char *extra = NULL; | |
fe4477ee JD |
608 | |
609 | assert(path_name); | |
610 | assert(file_name); | |
611 | ||
612 | ret = snprintf(full_path, sizeof(full_path), "%s/%s", | |
613 | path_name, file_name); | |
614 | if (ret < 0) { | |
615 | PERROR("snprintf create output file"); | |
616 | goto error; | |
617 | } | |
618 | ||
309167d2 JD |
619 | /* Setup extra string if suffix or/and a count is needed. */ |
620 | if (size > 0 && suffix) { | |
621 | ret = asprintf(&extra, "_%" PRIu64 "%s", count, suffix); | |
622 | } else if (size > 0) { | |
623 | ret = asprintf(&extra, "_%" PRIu64, count); | |
624 | } else if (suffix) { | |
625 | ret = asprintf(&extra, "%s", suffix); | |
626 | } | |
627 | if (ret < 0) { | |
628 | PERROR("Allocating extra string to name"); | |
629 | goto error; | |
630 | } | |
631 | ||
fe4477ee JD |
632 | /* |
633 | * If we split the trace in multiple files, we have to add the count at the | |
634 | * end of the tracefile name | |
635 | */ | |
309167d2 JD |
636 | if (extra) { |
637 | ret = asprintf(&path_name_suffix, "%s%s", full_path, extra); | |
fe4477ee | 638 | if (ret < 0) { |
309167d2 JD |
639 | PERROR("Allocating path name with extra string"); |
640 | goto error_free_suffix; | |
fe4477ee | 641 | } |
309167d2 | 642 | path = path_name_suffix; |
fe4477ee JD |
643 | } else { |
644 | path = full_path; | |
645 | } | |
646 | ||
be96a7d1 | 647 | flags = O_WRONLY | O_CREAT | O_TRUNC; |
0f907de1 | 648 | /* Open with 660 mode */ |
be96a7d1 DG |
649 | mode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP; |
650 | ||
651 | if (uid < 0 || gid < 0) { | |
652 | out_fd = open(path, flags, mode); | |
653 | } else { | |
654 | out_fd = run_as_open(path, flags, mode, uid, gid); | |
655 | } | |
fe4477ee JD |
656 | if (out_fd < 0) { |
657 | PERROR("open stream path %s", path); | |
658 | goto error_open; | |
659 | } | |
660 | ret = out_fd; | |
661 | ||
662 | error_open: | |
309167d2 JD |
663 | free(path_name_suffix); |
664 | error_free_suffix: | |
665 | free(extra); | |
fe4477ee JD |
666 | error: |
667 | return ret; | |
668 | } | |
669 | ||
670 | /* | |
671 | * Change the output tracefile according to the given size and count The | |
672 | * new_count pointer is set during this operation. | |
673 | * | |
674 | * From the consumer, the stream lock MUST be held before calling this function | |
675 | * because we are modifying the stream status. | |
676 | * | |
677 | * Return 0 on success or else a negative value. | |
678 | */ | |
bc182241 | 679 | LTTNG_HIDDEN |
fe4477ee | 680 | int utils_rotate_stream_file(char *path_name, char *file_name, uint64_t size, |
309167d2 JD |
681 | uint64_t count, int uid, int gid, int out_fd, uint64_t *new_count, |
682 | int *stream_fd) | |
fe4477ee JD |
683 | { |
684 | int ret; | |
685 | ||
309167d2 JD |
686 | assert(new_count); |
687 | assert(stream_fd); | |
688 | ||
fe4477ee JD |
689 | ret = close(out_fd); |
690 | if (ret < 0) { | |
691 | PERROR("Closing tracefile"); | |
692 | goto error; | |
693 | } | |
694 | ||
695 | if (count > 0) { | |
696 | *new_count = (*new_count + 1) % count; | |
697 | } else { | |
698 | (*new_count)++; | |
699 | } | |
700 | ||
309167d2 JD |
701 | ret = utils_create_stream_file(path_name, file_name, size, *new_count, |
702 | uid, gid, 0); | |
703 | if (ret < 0) { | |
704 | goto error; | |
705 | } | |
706 | *stream_fd = ret; | |
707 | ||
708 | /* Success. */ | |
709 | ret = 0; | |
710 | ||
fe4477ee JD |
711 | error: |
712 | return ret; | |
713 | } | |
70d0b120 | 714 | |
70d0b120 SM |
715 | |
716 | /** | |
717 | * Parse a string that represents a size in human readable format. It | |
5983a922 | 718 | * supports decimal integers suffixed by 'k', 'K', 'M' or 'G'. |
70d0b120 SM |
719 | * |
720 | * The suffix multiply the integer by: | |
721 | * 'k': 1024 | |
722 | * 'M': 1024^2 | |
723 | * 'G': 1024^3 | |
724 | * | |
725 | * @param str The string to parse. | |
5983a922 | 726 | * @param size Pointer to a uint64_t that will be filled with the |
cfa9a5a2 | 727 | * resulting size. |
70d0b120 SM |
728 | * |
729 | * @return 0 on success, -1 on failure. | |
730 | */ | |
00a52467 | 731 | LTTNG_HIDDEN |
5983a922 | 732 | int utils_parse_size_suffix(const char * const str, uint64_t * const size) |
70d0b120 | 733 | { |
70d0b120 | 734 | int ret; |
5983a922 | 735 | uint64_t base_size; |
70d0b120 | 736 | long shift = 0; |
5983a922 SM |
737 | const char *str_end; |
738 | char *num_end; | |
70d0b120 SM |
739 | |
740 | if (!str) { | |
5983a922 | 741 | DBG("utils_parse_size_suffix: received a NULL string."); |
70d0b120 SM |
742 | ret = -1; |
743 | goto end; | |
744 | } | |
745 | ||
5983a922 SM |
746 | /* strtoull will accept a negative number, but we don't want to. */ |
747 | if (strchr(str, '-') != NULL) { | |
748 | DBG("utils_parse_size_suffix: invalid size string, should not contain '-'."); | |
70d0b120 | 749 | ret = -1; |
5983a922 | 750 | goto end; |
70d0b120 SM |
751 | } |
752 | ||
5983a922 SM |
753 | /* str_end will point to the \0 */ |
754 | str_end = str + strlen(str); | |
70d0b120 | 755 | errno = 0; |
5983a922 | 756 | base_size = strtoull(str, &num_end, 0); |
70d0b120 | 757 | if (errno != 0) { |
5983a922 | 758 | PERROR("utils_parse_size_suffix strtoull"); |
70d0b120 | 759 | ret = -1; |
5983a922 SM |
760 | goto end; |
761 | } | |
762 | ||
763 | if (num_end == str) { | |
764 | /* strtoull parsed nothing, not good. */ | |
765 | DBG("utils_parse_size_suffix: strtoull had nothing good to parse."); | |
766 | ret = -1; | |
767 | goto end; | |
768 | } | |
769 | ||
770 | /* Check if a prefix is present. */ | |
771 | switch (*num_end) { | |
772 | case 'G': | |
773 | shift = GIBI_LOG2; | |
774 | num_end++; | |
775 | break; | |
776 | case 'M': /* */ | |
777 | shift = MEBI_LOG2; | |
778 | num_end++; | |
779 | break; | |
780 | case 'K': | |
781 | case 'k': | |
782 | shift = KIBI_LOG2; | |
783 | num_end++; | |
784 | break; | |
785 | case '\0': | |
786 | break; | |
787 | default: | |
788 | DBG("utils_parse_size_suffix: invalid suffix."); | |
789 | ret = -1; | |
790 | goto end; | |
791 | } | |
792 | ||
793 | /* Check for garbage after the valid input. */ | |
794 | if (num_end != str_end) { | |
795 | DBG("utils_parse_size_suffix: Garbage after size string."); | |
796 | ret = -1; | |
797 | goto end; | |
70d0b120 SM |
798 | } |
799 | ||
800 | *size = base_size << shift; | |
801 | ||
802 | /* Check for overflow */ | |
803 | if ((*size >> shift) != base_size) { | |
5983a922 | 804 | DBG("utils_parse_size_suffix: oops, overflow detected."); |
70d0b120 | 805 | ret = -1; |
5983a922 | 806 | goto end; |
70d0b120 SM |
807 | } |
808 | ||
809 | ret = 0; | |
70d0b120 SM |
810 | end: |
811 | return ret; | |
812 | } | |
cfa9a5a2 DG |
813 | |
814 | /* | |
815 | * fls: returns the position of the most significant bit. | |
816 | * Returns 0 if no bit is set, else returns the position of the most | |
817 | * significant bit (from 1 to 32 on 32-bit, from 1 to 64 on 64-bit). | |
818 | */ | |
819 | #if defined(__i386) || defined(__x86_64) | |
820 | static inline unsigned int fls_u32(uint32_t x) | |
821 | { | |
822 | int r; | |
823 | ||
824 | asm("bsrl %1,%0\n\t" | |
825 | "jnz 1f\n\t" | |
826 | "movl $-1,%0\n\t" | |
827 | "1:\n\t" | |
828 | : "=r" (r) : "rm" (x)); | |
829 | return r + 1; | |
830 | } | |
831 | #define HAS_FLS_U32 | |
832 | #endif | |
833 | ||
834 | #ifndef HAS_FLS_U32 | |
835 | static __attribute__((unused)) unsigned int fls_u32(uint32_t x) | |
836 | { | |
837 | unsigned int r = 32; | |
838 | ||
839 | if (!x) { | |
840 | return 0; | |
841 | } | |
842 | if (!(x & 0xFFFF0000U)) { | |
843 | x <<= 16; | |
844 | r -= 16; | |
845 | } | |
846 | if (!(x & 0xFF000000U)) { | |
847 | x <<= 8; | |
848 | r -= 8; | |
849 | } | |
850 | if (!(x & 0xF0000000U)) { | |
851 | x <<= 4; | |
852 | r -= 4; | |
853 | } | |
854 | if (!(x & 0xC0000000U)) { | |
855 | x <<= 2; | |
856 | r -= 2; | |
857 | } | |
858 | if (!(x & 0x80000000U)) { | |
859 | x <<= 1; | |
860 | r -= 1; | |
861 | } | |
862 | return r; | |
863 | } | |
864 | #endif | |
865 | ||
866 | /* | |
867 | * Return the minimum order for which x <= (1UL << order). | |
868 | * Return -1 if x is 0. | |
869 | */ | |
870 | LTTNG_HIDDEN | |
871 | int utils_get_count_order_u32(uint32_t x) | |
872 | { | |
873 | if (!x) { | |
874 | return -1; | |
875 | } | |
876 | ||
877 | return fls_u32(x - 1); | |
878 | } | |
feb0f3e5 AM |
879 | |
880 | /** | |
881 | * Obtain the value of LTTNG_HOME environment variable, if exists. | |
882 | * Otherwise returns the value of HOME. | |
883 | */ | |
00a52467 | 884 | LTTNG_HIDDEN |
feb0f3e5 AM |
885 | char *utils_get_home_dir(void) |
886 | { | |
887 | char *val = NULL; | |
04135dbd DG |
888 | struct passwd *pwd; |
889 | ||
e8fa9fb0 | 890 | val = lttng_secure_getenv(DEFAULT_LTTNG_HOME_ENV_VAR); |
feb0f3e5 | 891 | if (val != NULL) { |
04135dbd DG |
892 | goto end; |
893 | } | |
e8fa9fb0 | 894 | val = lttng_secure_getenv(DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR); |
04135dbd DG |
895 | if (val != NULL) { |
896 | goto end; | |
feb0f3e5 | 897 | } |
04135dbd DG |
898 | |
899 | /* Fallback on the password file entry. */ | |
900 | pwd = getpwuid(getuid()); | |
901 | if (!pwd) { | |
902 | goto end; | |
903 | } | |
904 | val = pwd->pw_dir; | |
905 | ||
906 | DBG3("Home directory is '%s'", val); | |
907 | ||
908 | end: | |
909 | return val; | |
feb0f3e5 | 910 | } |
26fe5938 | 911 | |
fb198a11 JG |
912 | /** |
913 | * Get user's home directory. Dynamically allocated, must be freed | |
914 | * by the caller. | |
915 | */ | |
916 | LTTNG_HIDDEN | |
917 | char *utils_get_user_home_dir(uid_t uid) | |
918 | { | |
919 | struct passwd pwd; | |
920 | struct passwd *result; | |
921 | char *home_dir = NULL; | |
922 | char *buf = NULL; | |
923 | long buflen; | |
924 | int ret; | |
925 | ||
926 | buflen = sysconf(_SC_GETPW_R_SIZE_MAX); | |
927 | if (buflen == -1) { | |
928 | goto end; | |
929 | } | |
930 | retry: | |
931 | buf = zmalloc(buflen); | |
932 | if (!buf) { | |
933 | goto end; | |
934 | } | |
935 | ||
936 | ret = getpwuid_r(uid, &pwd, buf, buflen, &result); | |
937 | if (ret || !result) { | |
938 | if (ret == ERANGE) { | |
939 | free(buf); | |
940 | buflen *= 2; | |
941 | goto retry; | |
942 | } | |
943 | goto end; | |
944 | } | |
945 | ||
946 | home_dir = strdup(pwd.pw_dir); | |
947 | end: | |
948 | free(buf); | |
949 | return home_dir; | |
950 | } | |
951 | ||
fbb9748b JG |
952 | /* |
953 | * Obtain the value of LTTNG_KMOD_PROBES environment variable, if exists. | |
c9d42407 | 954 | * Otherwise returns NULL. |
fbb9748b JG |
955 | */ |
956 | LTTNG_HIDDEN | |
957 | char *utils_get_kmod_probes_list(void) | |
958 | { | |
e8fa9fb0 | 959 | return lttng_secure_getenv(DEFAULT_LTTNG_KMOD_PROBES); |
fbb9748b JG |
960 | } |
961 | ||
c9d42407 PP |
962 | /* |
963 | * Obtain the value of LTTNG_EXTRA_KMOD_PROBES environment variable, if | |
964 | * exists. Otherwise returns NULL. | |
965 | */ | |
966 | LTTNG_HIDDEN | |
967 | char *utils_get_extra_kmod_probes_list(void) | |
968 | { | |
e8fa9fb0 | 969 | return lttng_secure_getenv(DEFAULT_LTTNG_EXTRA_KMOD_PROBES); |
c9d42407 PP |
970 | } |
971 | ||
26fe5938 DG |
972 | /* |
973 | * With the given format, fill dst with the time of len maximum siz. | |
974 | * | |
975 | * Return amount of bytes set in the buffer or else 0 on error. | |
976 | */ | |
977 | LTTNG_HIDDEN | |
978 | size_t utils_get_current_time_str(const char *format, char *dst, size_t len) | |
979 | { | |
980 | size_t ret; | |
981 | time_t rawtime; | |
982 | struct tm *timeinfo; | |
983 | ||
984 | assert(format); | |
985 | assert(dst); | |
986 | ||
987 | /* Get date and time for session path */ | |
988 | time(&rawtime); | |
989 | timeinfo = localtime(&rawtime); | |
990 | ret = strftime(dst, len, format, timeinfo); | |
991 | if (ret == 0) { | |
68e6efdd | 992 | ERR("Unable to strftime with format %s at dst %p of len %zu", format, |
26fe5938 DG |
993 | dst, len); |
994 | } | |
995 | ||
996 | return ret; | |
997 | } | |
6c71277b MD |
998 | |
999 | /* | |
1000 | * Return the group ID matching name, else 0 if it cannot be found. | |
1001 | */ | |
1002 | LTTNG_HIDDEN | |
1003 | gid_t utils_get_group_id(const char *name) | |
1004 | { | |
1005 | struct group *grp; | |
1006 | ||
1007 | grp = getgrnam(name); | |
1008 | if (!grp) { | |
1009 | static volatile int warn_once; | |
1010 | ||
1011 | if (!warn_once) { | |
1012 | WARN("No tracing group detected"); | |
1013 | warn_once = 1; | |
1014 | } | |
1015 | return 0; | |
1016 | } | |
1017 | return grp->gr_gid; | |
1018 | } | |
8db0dc00 JG |
1019 | |
1020 | /* | |
1021 | * Return a newly allocated option string. This string is to be used as the | |
1022 | * optstring argument of getopt_long(), see GETOPT(3). opt_count is the number | |
1023 | * of elements in the long_options array. Returns NULL if the string's | |
1024 | * allocation fails. | |
1025 | */ | |
1026 | LTTNG_HIDDEN | |
1027 | char *utils_generate_optstring(const struct option *long_options, | |
1028 | size_t opt_count) | |
1029 | { | |
1030 | int i; | |
1031 | size_t string_len = opt_count, str_pos = 0; | |
1032 | char *optstring; | |
1033 | ||
1034 | /* | |
1035 | * Compute the necessary string length. One letter per option, two when an | |
1036 | * argument is necessary, and a trailing NULL. | |
1037 | */ | |
1038 | for (i = 0; i < opt_count; i++) { | |
1039 | string_len += long_options[i].has_arg ? 1 : 0; | |
1040 | } | |
1041 | ||
1042 | optstring = zmalloc(string_len); | |
1043 | if (!optstring) { | |
1044 | goto end; | |
1045 | } | |
1046 | ||
1047 | for (i = 0; i < opt_count; i++) { | |
1048 | if (!long_options[i].name) { | |
1049 | /* Got to the trailing NULL element */ | |
1050 | break; | |
1051 | } | |
1052 | ||
5f1e4ef4 JG |
1053 | if (long_options[i].val != '\0') { |
1054 | optstring[str_pos++] = (char) long_options[i].val; | |
1055 | if (long_options[i].has_arg) { | |
1056 | optstring[str_pos++] = ':'; | |
1057 | } | |
8db0dc00 JG |
1058 | } |
1059 | } | |
1060 | ||
1061 | end: | |
1062 | return optstring; | |
1063 | } | |
3d071855 MD |
1064 | |
1065 | /* | |
1066 | * Try to remove a hierarchy of empty directories, recursively. Don't unlink | |
9529ec1b | 1067 | * any file. Try to rmdir any empty directory within the hierarchy. |
3d071855 MD |
1068 | */ |
1069 | LTTNG_HIDDEN | |
1070 | int utils_recursive_rmdir(const char *path) | |
1071 | { | |
1072 | DIR *dir; | |
9529ec1b | 1073 | int dir_fd, ret = 0, closeret, is_empty = 1; |
3d071855 MD |
1074 | struct dirent *entry; |
1075 | ||
1076 | /* Open directory */ | |
1077 | dir = opendir(path); | |
1078 | if (!dir) { | |
1079 | PERROR("Cannot open '%s' path", path); | |
1080 | return -1; | |
1081 | } | |
1082 | dir_fd = dirfd(dir); | |
1083 | if (dir_fd < 0) { | |
1084 | PERROR("dirfd"); | |
1085 | return -1; | |
1086 | } | |
1087 | ||
1088 | while ((entry = readdir(dir))) { | |
1089 | if (!strcmp(entry->d_name, ".") | |
1090 | || !strcmp(entry->d_name, "..")) | |
1091 | continue; | |
1092 | switch (entry->d_type) { | |
1093 | case DT_DIR: | |
1094 | { | |
1095 | char subpath[PATH_MAX]; | |
1096 | ||
1097 | strncpy(subpath, path, PATH_MAX); | |
1098 | subpath[PATH_MAX - 1] = '\0'; | |
1099 | strncat(subpath, "/", | |
1100 | PATH_MAX - strlen(subpath) - 1); | |
1101 | strncat(subpath, entry->d_name, | |
1102 | PATH_MAX - strlen(subpath) - 1); | |
9529ec1b MD |
1103 | if (utils_recursive_rmdir(subpath)) { |
1104 | is_empty = 0; | |
3d071855 MD |
1105 | } |
1106 | break; | |
1107 | } | |
1108 | case DT_REG: | |
9529ec1b MD |
1109 | is_empty = 0; |
1110 | break; | |
3d071855 MD |
1111 | default: |
1112 | ret = -EINVAL; | |
1113 | goto end; | |
1114 | } | |
1115 | } | |
1116 | end: | |
1117 | closeret = closedir(dir); | |
1118 | if (closeret) { | |
1119 | PERROR("closedir"); | |
1120 | } | |
9529ec1b | 1121 | if (is_empty) { |
3d071855 MD |
1122 | DBG3("Attempting rmdir %s", path); |
1123 | ret = rmdir(path); | |
1124 | } | |
1125 | return ret; | |
1126 | } |