| 1 | /* |
| 2 | * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com> |
| 3 | * Copyright (C) 2013 - Raphaël Beamonte <raphael.beamonte@gmail.com> |
| 4 | * Copyright (C) 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 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 |
| 21 | #include <assert.h> |
| 22 | #include <ctype.h> |
| 23 | #include <fcntl.h> |
| 24 | #include <limits.h> |
| 25 | #include <stdlib.h> |
| 26 | #include <string.h> |
| 27 | #include <sys/stat.h> |
| 28 | #include <sys/types.h> |
| 29 | #include <unistd.h> |
| 30 | #include <inttypes.h> |
| 31 | #include <regex.h> |
| 32 | #include <grp.h> |
| 33 | |
| 34 | #include <common/common.h> |
| 35 | #include <common/runas.h> |
| 36 | |
| 37 | #include "utils.h" |
| 38 | #include "defaults.h" |
| 39 | |
| 40 | /* |
| 41 | * Return a partial realpath(3) of the path even if the full path does not |
| 42 | * exist. For instance, with /tmp/test1/test2/test3, if test2/ does not exist |
| 43 | * but the /tmp/test1 does, the real path for /tmp/test1 is concatened with |
| 44 | * /test2/test3 then returned. In normal time, realpath(3) fails if the end |
| 45 | * point directory does not exist. |
| 46 | * In case resolved_path is NULL, the string returned was allocated in the |
| 47 | * function and thus need to be freed by the caller. The size argument allows |
| 48 | * to specify the size of the resolved_path argument if given, or the size to |
| 49 | * allocate. |
| 50 | */ |
| 51 | LTTNG_HIDDEN |
| 52 | char *utils_partial_realpath(const char *path, char *resolved_path, size_t size) |
| 53 | { |
| 54 | char *cut_path, *try_path = NULL, *try_path_prev = NULL; |
| 55 | const char *next, *prev, *end; |
| 56 | |
| 57 | /* Safety net */ |
| 58 | if (path == NULL) { |
| 59 | goto error; |
| 60 | } |
| 61 | |
| 62 | /* |
| 63 | * Identify the end of the path, we don't want to treat the |
| 64 | * last char if it is a '/', we will just keep it on the side |
| 65 | * to be added at the end, and return a value coherent with |
| 66 | * the path given as argument |
| 67 | */ |
| 68 | end = path + strlen(path); |
| 69 | if (*(end-1) == '/') { |
| 70 | end--; |
| 71 | } |
| 72 | |
| 73 | /* Initiate the values of the pointers before looping */ |
| 74 | next = path; |
| 75 | prev = next; |
| 76 | /* Only to ensure try_path is not NULL to enter the while */ |
| 77 | try_path = (char *)next; |
| 78 | |
| 79 | /* Resolve the canonical path of the first part of the path */ |
| 80 | while (try_path != NULL && next != end) { |
| 81 | /* |
| 82 | * If there is not any '/' left, we want to try with |
| 83 | * the full path |
| 84 | */ |
| 85 | next = strpbrk(next + 1, "/"); |
| 86 | if (next == NULL) { |
| 87 | next = end; |
| 88 | } |
| 89 | |
| 90 | /* Cut the part we will be trying to resolve */ |
| 91 | cut_path = strndup(path, next - path); |
| 92 | |
| 93 | /* Try to resolve this part */ |
| 94 | try_path = realpath((char *)cut_path, NULL); |
| 95 | if (try_path == NULL) { |
| 96 | /* |
| 97 | * There was an error, we just want to be assured it |
| 98 | * is linked to an unexistent directory, if it's another |
| 99 | * reason, we spawn an error |
| 100 | */ |
| 101 | switch (errno) { |
| 102 | case ENOENT: |
| 103 | /* Ignore the error */ |
| 104 | break; |
| 105 | default: |
| 106 | PERROR("realpath (partial_realpath)"); |
| 107 | goto error; |
| 108 | break; |
| 109 | } |
| 110 | } else { |
| 111 | /* Save the place we are before trying the next step */ |
| 112 | free(try_path_prev); |
| 113 | try_path_prev = try_path; |
| 114 | prev = next; |
| 115 | } |
| 116 | |
| 117 | /* Free the allocated memory */ |
| 118 | free(cut_path); |
| 119 | }; |
| 120 | |
| 121 | /* Allocate memory for the resolved path if necessary */ |
| 122 | if (resolved_path == NULL) { |
| 123 | resolved_path = zmalloc(size); |
| 124 | if (resolved_path == NULL) { |
| 125 | PERROR("zmalloc resolved path"); |
| 126 | goto error; |
| 127 | } |
| 128 | } |
| 129 | |
| 130 | /* |
| 131 | * If we were able to solve at least partially the path, we can concatenate |
| 132 | * what worked and what didn't work |
| 133 | */ |
| 134 | if (try_path_prev != NULL) { |
| 135 | /* If we risk to concatenate two '/', we remove one of them */ |
| 136 | if (try_path_prev[strlen(try_path_prev) - 1] == '/' && prev[0] == '/') { |
| 137 | try_path_prev[strlen(try_path_prev) - 1] = '\0'; |
| 138 | } |
| 139 | |
| 140 | /* |
| 141 | * Duplicate the memory used by prev in case resolved_path and |
| 142 | * path are pointers for the same memory space |
| 143 | */ |
| 144 | cut_path = strdup(prev); |
| 145 | |
| 146 | /* Concatenate the strings */ |
| 147 | snprintf(resolved_path, size, "%s%s", try_path_prev, cut_path); |
| 148 | |
| 149 | /* Free the allocated memory */ |
| 150 | free(cut_path); |
| 151 | free(try_path_prev); |
| 152 | /* |
| 153 | * Else, we just copy the path in our resolved_path to |
| 154 | * return it as is |
| 155 | */ |
| 156 | } else { |
| 157 | strncpy(resolved_path, path, size); |
| 158 | } |
| 159 | |
| 160 | /* Then we return the 'partially' resolved path */ |
| 161 | return resolved_path; |
| 162 | |
| 163 | error: |
| 164 | free(resolved_path); |
| 165 | return NULL; |
| 166 | } |
| 167 | |
| 168 | /* |
| 169 | * Make a full resolution of the given path even if it doesn't exist. |
| 170 | * This function uses the utils_partial_realpath function to resolve |
| 171 | * symlinks and relatives paths at the start of the string, and |
| 172 | * implements functionnalities to resolve the './' and '../' strings |
| 173 | * in the middle of a path. This function is only necessary because |
| 174 | * realpath(3) does not accept to resolve unexistent paths. |
| 175 | * The returned string was allocated in the function, it is thus of |
| 176 | * the responsibility of the caller to free this memory. |
| 177 | */ |
| 178 | LTTNG_HIDDEN |
| 179 | char *utils_expand_path(const char *path) |
| 180 | { |
| 181 | char *next, *previous, *slash, *start_path, *absolute_path = NULL; |
| 182 | char *last_token; |
| 183 | int is_dot, is_dotdot; |
| 184 | |
| 185 | /* Safety net */ |
| 186 | if (path == NULL) { |
| 187 | goto error; |
| 188 | } |
| 189 | |
| 190 | /* Allocate memory for the absolute_path */ |
| 191 | absolute_path = zmalloc(PATH_MAX); |
| 192 | if (absolute_path == NULL) { |
| 193 | PERROR("zmalloc expand path"); |
| 194 | goto error; |
| 195 | } |
| 196 | |
| 197 | /* |
| 198 | * If the path is not already absolute nor explicitly relative, |
| 199 | * consider we're in the current directory |
| 200 | */ |
| 201 | if (*path != '/' && strncmp(path, "./", 2) != 0 && |
| 202 | strncmp(path, "../", 3) != 0) { |
| 203 | snprintf(absolute_path, PATH_MAX, "./%s", path); |
| 204 | /* Else, we just copy the path */ |
| 205 | } else { |
| 206 | strncpy(absolute_path, path, PATH_MAX); |
| 207 | } |
| 208 | |
| 209 | /* Resolve partially our path */ |
| 210 | absolute_path = utils_partial_realpath(absolute_path, |
| 211 | absolute_path, PATH_MAX); |
| 212 | |
| 213 | /* As long as we find '/./' in the working_path string */ |
| 214 | while ((next = strstr(absolute_path, "/./"))) { |
| 215 | |
| 216 | /* We prepare the start_path not containing it */ |
| 217 | start_path = strndup(absolute_path, next - absolute_path); |
| 218 | |
| 219 | /* And we concatenate it with the part after this string */ |
| 220 | snprintf(absolute_path, PATH_MAX, "%s%s", start_path, next + 2); |
| 221 | |
| 222 | free(start_path); |
| 223 | } |
| 224 | |
| 225 | /* As long as we find '/../' in the working_path string */ |
| 226 | while ((next = strstr(absolute_path, "/../"))) { |
| 227 | /* We find the last level of directory */ |
| 228 | previous = absolute_path; |
| 229 | while ((slash = strpbrk(previous, "/")) && slash != next) { |
| 230 | previous = slash + 1; |
| 231 | } |
| 232 | |
| 233 | /* Then we prepare the start_path not containing it */ |
| 234 | start_path = strndup(absolute_path, previous - absolute_path); |
| 235 | |
| 236 | /* And we concatenate it with the part after the '/../' */ |
| 237 | snprintf(absolute_path, PATH_MAX, "%s%s", start_path, next + 4); |
| 238 | |
| 239 | /* We can free the memory used for the start path*/ |
| 240 | free(start_path); |
| 241 | |
| 242 | /* Then we verify for symlinks using partial_realpath */ |
| 243 | absolute_path = utils_partial_realpath(absolute_path, |
| 244 | absolute_path, PATH_MAX); |
| 245 | } |
| 246 | |
| 247 | /* Identify the last token */ |
| 248 | last_token = strrchr(absolute_path, '/'); |
| 249 | |
| 250 | /* Verify that this token is not a relative path */ |
| 251 | is_dotdot = (strcmp(last_token, "/..") == 0); |
| 252 | is_dot = (strcmp(last_token, "/.") == 0); |
| 253 | |
| 254 | /* If it is, take action */ |
| 255 | if (is_dot || is_dotdot) { |
| 256 | /* For both, remove this token */ |
| 257 | *last_token = '\0'; |
| 258 | |
| 259 | /* If it was a reference to parent directory, go back one more time */ |
| 260 | if (is_dotdot) { |
| 261 | last_token = strrchr(absolute_path, '/'); |
| 262 | |
| 263 | /* If there was only one level left, we keep the first '/' */ |
| 264 | if (last_token == absolute_path) { |
| 265 | last_token++; |
| 266 | } |
| 267 | |
| 268 | *last_token = '\0'; |
| 269 | } |
| 270 | } |
| 271 | |
| 272 | return absolute_path; |
| 273 | |
| 274 | error: |
| 275 | free(absolute_path); |
| 276 | return NULL; |
| 277 | } |
| 278 | |
| 279 | /* |
| 280 | * Create a pipe in dst. |
| 281 | */ |
| 282 | LTTNG_HIDDEN |
| 283 | int utils_create_pipe(int *dst) |
| 284 | { |
| 285 | int ret; |
| 286 | |
| 287 | if (dst == NULL) { |
| 288 | return -1; |
| 289 | } |
| 290 | |
| 291 | ret = pipe(dst); |
| 292 | if (ret < 0) { |
| 293 | PERROR("create pipe"); |
| 294 | } |
| 295 | |
| 296 | return ret; |
| 297 | } |
| 298 | |
| 299 | /* |
| 300 | * Create pipe and set CLOEXEC flag to both fd. |
| 301 | * |
| 302 | * Make sure the pipe opened by this function are closed at some point. Use |
| 303 | * utils_close_pipe(). |
| 304 | */ |
| 305 | LTTNG_HIDDEN |
| 306 | int utils_create_pipe_cloexec(int *dst) |
| 307 | { |
| 308 | int ret, i; |
| 309 | |
| 310 | if (dst == NULL) { |
| 311 | return -1; |
| 312 | } |
| 313 | |
| 314 | ret = utils_create_pipe(dst); |
| 315 | if (ret < 0) { |
| 316 | goto error; |
| 317 | } |
| 318 | |
| 319 | for (i = 0; i < 2; i++) { |
| 320 | ret = fcntl(dst[i], F_SETFD, FD_CLOEXEC); |
| 321 | if (ret < 0) { |
| 322 | PERROR("fcntl pipe cloexec"); |
| 323 | goto error; |
| 324 | } |
| 325 | } |
| 326 | |
| 327 | error: |
| 328 | return ret; |
| 329 | } |
| 330 | |
| 331 | /* |
| 332 | * Create pipe and set fd flags to FD_CLOEXEC and O_NONBLOCK. |
| 333 | * |
| 334 | * Make sure the pipe opened by this function are closed at some point. Use |
| 335 | * utils_close_pipe(). Using pipe() and fcntl rather than pipe2() to |
| 336 | * support OSes other than Linux 2.6.23+. |
| 337 | */ |
| 338 | LTTNG_HIDDEN |
| 339 | int utils_create_pipe_cloexec_nonblock(int *dst) |
| 340 | { |
| 341 | int ret, i; |
| 342 | |
| 343 | if (dst == NULL) { |
| 344 | return -1; |
| 345 | } |
| 346 | |
| 347 | ret = utils_create_pipe(dst); |
| 348 | if (ret < 0) { |
| 349 | goto error; |
| 350 | } |
| 351 | |
| 352 | for (i = 0; i < 2; i++) { |
| 353 | ret = fcntl(dst[i], F_SETFD, FD_CLOEXEC); |
| 354 | if (ret < 0) { |
| 355 | PERROR("fcntl pipe cloexec"); |
| 356 | goto error; |
| 357 | } |
| 358 | /* |
| 359 | * Note: we override any flag that could have been |
| 360 | * previously set on the fd. |
| 361 | */ |
| 362 | ret = fcntl(dst[i], F_SETFL, O_NONBLOCK); |
| 363 | if (ret < 0) { |
| 364 | PERROR("fcntl pipe nonblock"); |
| 365 | goto error; |
| 366 | } |
| 367 | } |
| 368 | |
| 369 | error: |
| 370 | return ret; |
| 371 | } |
| 372 | |
| 373 | /* |
| 374 | * Close both read and write side of the pipe. |
| 375 | */ |
| 376 | LTTNG_HIDDEN |
| 377 | void utils_close_pipe(int *src) |
| 378 | { |
| 379 | int i, ret; |
| 380 | |
| 381 | if (src == NULL) { |
| 382 | return; |
| 383 | } |
| 384 | |
| 385 | for (i = 0; i < 2; i++) { |
| 386 | /* Safety check */ |
| 387 | if (src[i] < 0) { |
| 388 | continue; |
| 389 | } |
| 390 | |
| 391 | ret = close(src[i]); |
| 392 | if (ret) { |
| 393 | PERROR("close pipe"); |
| 394 | } |
| 395 | } |
| 396 | } |
| 397 | |
| 398 | /* |
| 399 | * Create a new string using two strings range. |
| 400 | */ |
| 401 | LTTNG_HIDDEN |
| 402 | char *utils_strdupdelim(const char *begin, const char *end) |
| 403 | { |
| 404 | char *str; |
| 405 | |
| 406 | str = zmalloc(end - begin + 1); |
| 407 | if (str == NULL) { |
| 408 | PERROR("zmalloc strdupdelim"); |
| 409 | goto error; |
| 410 | } |
| 411 | |
| 412 | memcpy(str, begin, end - begin); |
| 413 | str[end - begin] = '\0'; |
| 414 | |
| 415 | error: |
| 416 | return str; |
| 417 | } |
| 418 | |
| 419 | /* |
| 420 | * Set CLOEXEC flag to the give file descriptor. |
| 421 | */ |
| 422 | LTTNG_HIDDEN |
| 423 | int utils_set_fd_cloexec(int fd) |
| 424 | { |
| 425 | int ret; |
| 426 | |
| 427 | if (fd < 0) { |
| 428 | ret = -EINVAL; |
| 429 | goto end; |
| 430 | } |
| 431 | |
| 432 | ret = fcntl(fd, F_SETFD, FD_CLOEXEC); |
| 433 | if (ret < 0) { |
| 434 | PERROR("fcntl cloexec"); |
| 435 | ret = -errno; |
| 436 | } |
| 437 | |
| 438 | end: |
| 439 | return ret; |
| 440 | } |
| 441 | |
| 442 | /* |
| 443 | * Create pid file to the given path and filename. |
| 444 | */ |
| 445 | LTTNG_HIDDEN |
| 446 | int utils_create_pid_file(pid_t pid, const char *filepath) |
| 447 | { |
| 448 | int ret; |
| 449 | FILE *fp; |
| 450 | |
| 451 | assert(filepath); |
| 452 | |
| 453 | fp = fopen(filepath, "w"); |
| 454 | if (fp == NULL) { |
| 455 | PERROR("open pid file %s", filepath); |
| 456 | ret = -1; |
| 457 | goto error; |
| 458 | } |
| 459 | |
| 460 | ret = fprintf(fp, "%d\n", pid); |
| 461 | if (ret < 0) { |
| 462 | PERROR("fprintf pid file"); |
| 463 | } |
| 464 | |
| 465 | fclose(fp); |
| 466 | DBG("Pid %d written in file %s", pid, filepath); |
| 467 | error: |
| 468 | return ret; |
| 469 | } |
| 470 | |
| 471 | /* |
| 472 | * Recursively create directory using the given path and mode. |
| 473 | * |
| 474 | * On success, return 0 else a negative error code. |
| 475 | */ |
| 476 | LTTNG_HIDDEN |
| 477 | int utils_mkdir_recursive(const char *path, mode_t mode) |
| 478 | { |
| 479 | char *p, tmp[PATH_MAX]; |
| 480 | size_t len; |
| 481 | int ret; |
| 482 | |
| 483 | assert(path); |
| 484 | |
| 485 | ret = snprintf(tmp, sizeof(tmp), "%s", path); |
| 486 | if (ret < 0) { |
| 487 | PERROR("snprintf mkdir"); |
| 488 | goto error; |
| 489 | } |
| 490 | |
| 491 | len = ret; |
| 492 | if (tmp[len - 1] == '/') { |
| 493 | tmp[len - 1] = 0; |
| 494 | } |
| 495 | |
| 496 | for (p = tmp + 1; *p; p++) { |
| 497 | if (*p == '/') { |
| 498 | *p = 0; |
| 499 | if (tmp[strlen(tmp) - 1] == '.' && |
| 500 | tmp[strlen(tmp) - 2] == '.' && |
| 501 | tmp[strlen(tmp) - 3] == '/') { |
| 502 | ERR("Using '/../' is not permitted in the trace path (%s)", |
| 503 | tmp); |
| 504 | ret = -1; |
| 505 | goto error; |
| 506 | } |
| 507 | ret = mkdir(tmp, mode); |
| 508 | if (ret < 0) { |
| 509 | if (errno != EEXIST) { |
| 510 | PERROR("mkdir recursive"); |
| 511 | ret = -errno; |
| 512 | goto error; |
| 513 | } |
| 514 | } |
| 515 | *p = '/'; |
| 516 | } |
| 517 | } |
| 518 | |
| 519 | ret = mkdir(tmp, mode); |
| 520 | if (ret < 0) { |
| 521 | if (errno != EEXIST) { |
| 522 | PERROR("mkdir recursive last piece"); |
| 523 | ret = -errno; |
| 524 | } else { |
| 525 | ret = 0; |
| 526 | } |
| 527 | } |
| 528 | |
| 529 | error: |
| 530 | return ret; |
| 531 | } |
| 532 | |
| 533 | /* |
| 534 | * Create the stream tracefile on disk. |
| 535 | * |
| 536 | * Return 0 on success or else a negative value. |
| 537 | */ |
| 538 | LTTNG_HIDDEN |
| 539 | int utils_create_stream_file(const char *path_name, char *file_name, uint64_t size, |
| 540 | uint64_t count, int uid, int gid, char *suffix) |
| 541 | { |
| 542 | int ret, out_fd, flags, mode; |
| 543 | char full_path[PATH_MAX], *path_name_suffix = NULL, *path; |
| 544 | char *extra = NULL; |
| 545 | |
| 546 | assert(path_name); |
| 547 | assert(file_name); |
| 548 | |
| 549 | ret = snprintf(full_path, sizeof(full_path), "%s/%s", |
| 550 | path_name, file_name); |
| 551 | if (ret < 0) { |
| 552 | PERROR("snprintf create output file"); |
| 553 | goto error; |
| 554 | } |
| 555 | |
| 556 | /* Setup extra string if suffix or/and a count is needed. */ |
| 557 | if (size > 0 && suffix) { |
| 558 | ret = asprintf(&extra, "_%" PRIu64 "%s", count, suffix); |
| 559 | } else if (size > 0) { |
| 560 | ret = asprintf(&extra, "_%" PRIu64, count); |
| 561 | } else if (suffix) { |
| 562 | ret = asprintf(&extra, "%s", suffix); |
| 563 | } |
| 564 | if (ret < 0) { |
| 565 | PERROR("Allocating extra string to name"); |
| 566 | goto error; |
| 567 | } |
| 568 | |
| 569 | /* |
| 570 | * If we split the trace in multiple files, we have to add the count at the |
| 571 | * end of the tracefile name |
| 572 | */ |
| 573 | if (extra) { |
| 574 | ret = asprintf(&path_name_suffix, "%s%s", full_path, extra); |
| 575 | if (ret < 0) { |
| 576 | PERROR("Allocating path name with extra string"); |
| 577 | goto error_free_suffix; |
| 578 | } |
| 579 | path = path_name_suffix; |
| 580 | } else { |
| 581 | path = full_path; |
| 582 | } |
| 583 | |
| 584 | flags = O_WRONLY | O_CREAT | O_TRUNC; |
| 585 | /* Open with 660 mode */ |
| 586 | mode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP; |
| 587 | |
| 588 | if (uid < 0 || gid < 0) { |
| 589 | out_fd = open(path, flags, mode); |
| 590 | } else { |
| 591 | out_fd = run_as_open(path, flags, mode, uid, gid); |
| 592 | } |
| 593 | if (out_fd < 0) { |
| 594 | PERROR("open stream path %s", path); |
| 595 | goto error_open; |
| 596 | } |
| 597 | ret = out_fd; |
| 598 | |
| 599 | error_open: |
| 600 | free(path_name_suffix); |
| 601 | error_free_suffix: |
| 602 | free(extra); |
| 603 | error: |
| 604 | return ret; |
| 605 | } |
| 606 | |
| 607 | /* |
| 608 | * Change the output tracefile according to the given size and count The |
| 609 | * new_count pointer is set during this operation. |
| 610 | * |
| 611 | * From the consumer, the stream lock MUST be held before calling this function |
| 612 | * because we are modifying the stream status. |
| 613 | * |
| 614 | * Return 0 on success or else a negative value. |
| 615 | */ |
| 616 | LTTNG_HIDDEN |
| 617 | int utils_rotate_stream_file(char *path_name, char *file_name, uint64_t size, |
| 618 | uint64_t count, int uid, int gid, int out_fd, uint64_t *new_count, |
| 619 | int *stream_fd) |
| 620 | { |
| 621 | int ret; |
| 622 | |
| 623 | assert(new_count); |
| 624 | assert(stream_fd); |
| 625 | |
| 626 | ret = close(out_fd); |
| 627 | if (ret < 0) { |
| 628 | PERROR("Closing tracefile"); |
| 629 | goto error; |
| 630 | } |
| 631 | |
| 632 | if (count > 0) { |
| 633 | *new_count = (*new_count + 1) % count; |
| 634 | } else { |
| 635 | (*new_count)++; |
| 636 | } |
| 637 | |
| 638 | ret = utils_create_stream_file(path_name, file_name, size, *new_count, |
| 639 | uid, gid, 0); |
| 640 | if (ret < 0) { |
| 641 | goto error; |
| 642 | } |
| 643 | *stream_fd = ret; |
| 644 | |
| 645 | /* Success. */ |
| 646 | ret = 0; |
| 647 | |
| 648 | error: |
| 649 | return ret; |
| 650 | } |
| 651 | |
| 652 | /** |
| 653 | * Prints the error message corresponding to a regex error code. |
| 654 | * |
| 655 | * @param errcode The error code. |
| 656 | * @param regex The regex object that produced the error code. |
| 657 | */ |
| 658 | static void regex_print_error(int errcode, regex_t *regex) |
| 659 | { |
| 660 | /* Get length of error message and allocate accordingly */ |
| 661 | size_t length; |
| 662 | char *buffer; |
| 663 | |
| 664 | assert(regex != NULL); |
| 665 | |
| 666 | length = regerror(errcode, regex, NULL, 0); |
| 667 | if (length == 0) { |
| 668 | ERR("regerror returned a length of 0"); |
| 669 | return; |
| 670 | } |
| 671 | |
| 672 | buffer = zmalloc(length); |
| 673 | if (!buffer) { |
| 674 | ERR("regex_print_error: zmalloc failed"); |
| 675 | return; |
| 676 | } |
| 677 | |
| 678 | /* Get and print error message */ |
| 679 | regerror(errcode, regex, buffer, length); |
| 680 | ERR("regex error: %s\n", buffer); |
| 681 | free(buffer); |
| 682 | |
| 683 | } |
| 684 | |
| 685 | /** |
| 686 | * Parse a string that represents a size in human readable format. It |
| 687 | * supports decimal integers suffixed by 'k', 'M' or 'G'. |
| 688 | * |
| 689 | * The suffix multiply the integer by: |
| 690 | * 'k': 1024 |
| 691 | * 'M': 1024^2 |
| 692 | * 'G': 1024^3 |
| 693 | * |
| 694 | * @param str The string to parse. |
| 695 | * @param size Pointer to a size_t that will be filled with the |
| 696 | * resulting size. |
| 697 | * |
| 698 | * @return 0 on success, -1 on failure. |
| 699 | */ |
| 700 | LTTNG_HIDDEN |
| 701 | int utils_parse_size_suffix(char *str, uint64_t *size) |
| 702 | { |
| 703 | regex_t regex; |
| 704 | int ret; |
| 705 | const int nmatch = 3; |
| 706 | regmatch_t suffix_match, matches[nmatch]; |
| 707 | unsigned long long base_size; |
| 708 | long shift = 0; |
| 709 | |
| 710 | if (!str) { |
| 711 | return 0; |
| 712 | } |
| 713 | |
| 714 | /* Compile regex */ |
| 715 | ret = regcomp(®ex, "^\\(0x\\)\\{0,1\\}[0-9][0-9]*\\([kKMG]\\{0,1\\}\\)$", 0); |
| 716 | if (ret != 0) { |
| 717 | regex_print_error(ret, ®ex); |
| 718 | ret = -1; |
| 719 | goto end; |
| 720 | } |
| 721 | |
| 722 | /* Match regex */ |
| 723 | ret = regexec(®ex, str, nmatch, matches, 0); |
| 724 | if (ret != 0) { |
| 725 | ret = -1; |
| 726 | goto free; |
| 727 | } |
| 728 | |
| 729 | /* There is a match ! */ |
| 730 | errno = 0; |
| 731 | base_size = strtoull(str, NULL, 0); |
| 732 | if (errno != 0) { |
| 733 | PERROR("strtoull"); |
| 734 | ret = -1; |
| 735 | goto free; |
| 736 | } |
| 737 | |
| 738 | /* Check if there is a suffix */ |
| 739 | suffix_match = matches[2]; |
| 740 | if (suffix_match.rm_eo - suffix_match.rm_so == 1) { |
| 741 | switch (*(str + suffix_match.rm_so)) { |
| 742 | case 'K': |
| 743 | case 'k': |
| 744 | shift = KIBI_LOG2; |
| 745 | break; |
| 746 | case 'M': |
| 747 | shift = MEBI_LOG2; |
| 748 | break; |
| 749 | case 'G': |
| 750 | shift = GIBI_LOG2; |
| 751 | break; |
| 752 | default: |
| 753 | ERR("parse_human_size: invalid suffix"); |
| 754 | ret = -1; |
| 755 | goto free; |
| 756 | } |
| 757 | } |
| 758 | |
| 759 | *size = base_size << shift; |
| 760 | |
| 761 | /* Check for overflow */ |
| 762 | if ((*size >> shift) != base_size) { |
| 763 | ERR("parse_size_suffix: oops, overflow detected."); |
| 764 | ret = -1; |
| 765 | goto free; |
| 766 | } |
| 767 | |
| 768 | ret = 0; |
| 769 | |
| 770 | free: |
| 771 | regfree(®ex); |
| 772 | end: |
| 773 | return ret; |
| 774 | } |
| 775 | |
| 776 | /* |
| 777 | * fls: returns the position of the most significant bit. |
| 778 | * Returns 0 if no bit is set, else returns the position of the most |
| 779 | * significant bit (from 1 to 32 on 32-bit, from 1 to 64 on 64-bit). |
| 780 | */ |
| 781 | #if defined(__i386) || defined(__x86_64) |
| 782 | static inline unsigned int fls_u32(uint32_t x) |
| 783 | { |
| 784 | int r; |
| 785 | |
| 786 | asm("bsrl %1,%0\n\t" |
| 787 | "jnz 1f\n\t" |
| 788 | "movl $-1,%0\n\t" |
| 789 | "1:\n\t" |
| 790 | : "=r" (r) : "rm" (x)); |
| 791 | return r + 1; |
| 792 | } |
| 793 | #define HAS_FLS_U32 |
| 794 | #endif |
| 795 | |
| 796 | #ifndef HAS_FLS_U32 |
| 797 | static __attribute__((unused)) unsigned int fls_u32(uint32_t x) |
| 798 | { |
| 799 | unsigned int r = 32; |
| 800 | |
| 801 | if (!x) { |
| 802 | return 0; |
| 803 | } |
| 804 | if (!(x & 0xFFFF0000U)) { |
| 805 | x <<= 16; |
| 806 | r -= 16; |
| 807 | } |
| 808 | if (!(x & 0xFF000000U)) { |
| 809 | x <<= 8; |
| 810 | r -= 8; |
| 811 | } |
| 812 | if (!(x & 0xF0000000U)) { |
| 813 | x <<= 4; |
| 814 | r -= 4; |
| 815 | } |
| 816 | if (!(x & 0xC0000000U)) { |
| 817 | x <<= 2; |
| 818 | r -= 2; |
| 819 | } |
| 820 | if (!(x & 0x80000000U)) { |
| 821 | x <<= 1; |
| 822 | r -= 1; |
| 823 | } |
| 824 | return r; |
| 825 | } |
| 826 | #endif |
| 827 | |
| 828 | /* |
| 829 | * Return the minimum order for which x <= (1UL << order). |
| 830 | * Return -1 if x is 0. |
| 831 | */ |
| 832 | LTTNG_HIDDEN |
| 833 | int utils_get_count_order_u32(uint32_t x) |
| 834 | { |
| 835 | if (!x) { |
| 836 | return -1; |
| 837 | } |
| 838 | |
| 839 | return fls_u32(x - 1); |
| 840 | } |
| 841 | |
| 842 | /** |
| 843 | * Obtain the value of LTTNG_HOME environment variable, if exists. |
| 844 | * Otherwise returns the value of HOME. |
| 845 | */ |
| 846 | LTTNG_HIDDEN |
| 847 | char *utils_get_home_dir(void) |
| 848 | { |
| 849 | char *val = NULL; |
| 850 | val = getenv(DEFAULT_LTTNG_HOME_ENV_VAR); |
| 851 | if (val != NULL) { |
| 852 | return val; |
| 853 | } |
| 854 | return getenv(DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR); |
| 855 | } |
| 856 | |
| 857 | /* |
| 858 | * With the given format, fill dst with the time of len maximum siz. |
| 859 | * |
| 860 | * Return amount of bytes set in the buffer or else 0 on error. |
| 861 | */ |
| 862 | LTTNG_HIDDEN |
| 863 | size_t utils_get_current_time_str(const char *format, char *dst, size_t len) |
| 864 | { |
| 865 | size_t ret; |
| 866 | time_t rawtime; |
| 867 | struct tm *timeinfo; |
| 868 | |
| 869 | assert(format); |
| 870 | assert(dst); |
| 871 | |
| 872 | /* Get date and time for session path */ |
| 873 | time(&rawtime); |
| 874 | timeinfo = localtime(&rawtime); |
| 875 | ret = strftime(dst, len, format, timeinfo); |
| 876 | if (ret == 0) { |
| 877 | ERR("Unable to strftime with format %s at dst %p of len %lu", format, |
| 878 | dst, len); |
| 879 | } |
| 880 | |
| 881 | return ret; |
| 882 | } |
| 883 | |
| 884 | /* |
| 885 | * Return the group ID matching name, else 0 if it cannot be found. |
| 886 | */ |
| 887 | LTTNG_HIDDEN |
| 888 | gid_t utils_get_group_id(const char *name) |
| 889 | { |
| 890 | struct group *grp; |
| 891 | |
| 892 | grp = getgrnam(name); |
| 893 | if (!grp) { |
| 894 | static volatile int warn_once; |
| 895 | |
| 896 | if (!warn_once) { |
| 897 | WARN("No tracing group detected"); |
| 898 | warn_once = 1; |
| 899 | } |
| 900 | return 0; |
| 901 | } |
| 902 | return grp->gr_gid; |
| 903 | } |
| 904 | |
| 905 | /* |
| 906 | * Return a newly allocated option string. This string is to be used as the |
| 907 | * optstring argument of getopt_long(), see GETOPT(3). opt_count is the number |
| 908 | * of elements in the long_options array. Returns NULL if the string's |
| 909 | * allocation fails. |
| 910 | */ |
| 911 | LTTNG_HIDDEN |
| 912 | char *utils_generate_optstring(const struct option *long_options, |
| 913 | size_t opt_count) |
| 914 | { |
| 915 | int i; |
| 916 | size_t string_len = opt_count, str_pos = 0; |
| 917 | char *optstring; |
| 918 | |
| 919 | /* |
| 920 | * Compute the necessary string length. One letter per option, two when an |
| 921 | * argument is necessary, and a trailing NULL. |
| 922 | */ |
| 923 | for (i = 0; i < opt_count; i++) { |
| 924 | string_len += long_options[i].has_arg ? 1 : 0; |
| 925 | } |
| 926 | |
| 927 | optstring = zmalloc(string_len); |
| 928 | if (!optstring) { |
| 929 | goto end; |
| 930 | } |
| 931 | |
| 932 | for (i = 0; i < opt_count; i++) { |
| 933 | if (!long_options[i].name) { |
| 934 | /* Got to the trailing NULL element */ |
| 935 | break; |
| 936 | } |
| 937 | |
| 938 | optstring[str_pos++] = (char)long_options[i].val; |
| 939 | if (long_options[i].has_arg) { |
| 940 | optstring[str_pos++] = ':'; |
| 941 | } |
| 942 | } |
| 943 | |
| 944 | end: |
| 945 | return optstring; |
| 946 | } |