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>
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.
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
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.
29 #include <sys/types.h>
37 #include <common/common.h>
38 #include <common/runas.h>
39 #include <common/compat/getenv.h>
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
56 char *utils_partial_realpath(const char *path
, char *resolved_path
, size_t size
)
58 char *cut_path
= NULL
, *try_path
= NULL
, *try_path_prev
= NULL
;
59 const char *next
, *prev
, *end
;
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
72 end
= path
+ strlen(path
);
73 if (*(end
-1) == '/') {
77 /* Initiate the values of the pointers before looping */
80 /* Only to ensure try_path is not NULL to enter the while */
81 try_path
= (char *)next
;
83 /* Resolve the canonical path of the first part of the path */
84 while (try_path
!= NULL
&& next
!= end
) {
86 * If there is not any '/' left, we want to try with
89 next
= strpbrk(next
+ 1, "/");
94 /* Cut the part we will be trying to resolve */
95 cut_path
= strndup(path
, next
- path
);
96 if (cut_path
== NULL
) {
101 /* Try to resolve this part */
102 try_path
= realpath((char *)cut_path
, NULL
);
103 if (try_path
== NULL
) {
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
111 /* Ignore the error */
114 PERROR("realpath (partial_realpath)");
119 /* Save the place we are before trying the next step */
121 try_path_prev
= try_path
;
125 /* Free the allocated memory */
130 /* Allocate memory for the resolved path if necessary */
131 if (resolved_path
== NULL
) {
132 resolved_path
= zmalloc(size
);
133 if (resolved_path
== NULL
) {
134 PERROR("zmalloc resolved path");
140 * If we were able to solve at least partially the path, we can concatenate
141 * what worked and what didn't work
143 if (try_path_prev
!= NULL
) {
144 /* If we risk to concatenate two '/', we remove one of them */
145 if (try_path_prev
[strlen(try_path_prev
) - 1] == '/' && prev
[0] == '/') {
146 try_path_prev
[strlen(try_path_prev
) - 1] = '\0';
150 * Duplicate the memory used by prev in case resolved_path and
151 * path are pointers for the same memory space
153 cut_path
= strdup(prev
);
154 if (cut_path
== NULL
) {
159 /* Concatenate the strings */
160 snprintf(resolved_path
, size
, "%s%s", try_path_prev
, cut_path
);
162 /* Free the allocated memory */
166 * Else, we just copy the path in our resolved_path to
170 strncpy(resolved_path
, path
, size
);
173 /* Then we return the 'partially' resolved path */
174 return resolved_path
;
180 if (try_path_prev
!= try_path
) {
187 * Make a full resolution of the given path even if it doesn't exist.
188 * This function uses the utils_partial_realpath function to resolve
189 * symlinks and relatives paths at the start of the string, and
190 * implements functionnalities to resolve the './' and '../' strings
191 * in the middle of a path. This function is only necessary because
192 * realpath(3) does not accept to resolve unexistent paths.
193 * The returned string was allocated in the function, it is thus of
194 * the responsibility of the caller to free this memory.
197 char *utils_expand_path(const char *path
)
199 char *next
, *previous
, *slash
, *start_path
, *absolute_path
= NULL
;
201 int is_dot
, is_dotdot
;
208 /* Allocate memory for the absolute_path */
209 absolute_path
= zmalloc(PATH_MAX
);
210 if (absolute_path
== NULL
) {
211 PERROR("zmalloc expand path");
216 * If the path is not already absolute nor explicitly relative,
217 * consider we're in the current directory
219 if (*path
!= '/' && strncmp(path
, "./", 2) != 0 &&
220 strncmp(path
, "../", 3) != 0) {
221 snprintf(absolute_path
, PATH_MAX
, "./%s", path
);
222 /* Else, we just copy the path */
224 strncpy(absolute_path
, path
, PATH_MAX
);
227 /* Resolve partially our path */
228 absolute_path
= utils_partial_realpath(absolute_path
,
229 absolute_path
, PATH_MAX
);
231 /* As long as we find '/./' in the working_path string */
232 while ((next
= strstr(absolute_path
, "/./"))) {
234 /* We prepare the start_path not containing it */
235 start_path
= strndup(absolute_path
, next
- absolute_path
);
240 /* And we concatenate it with the part after this string */
241 snprintf(absolute_path
, PATH_MAX
, "%s%s", start_path
, next
+ 2);
246 /* As long as we find '/../' in the working_path string */
247 while ((next
= strstr(absolute_path
, "/../"))) {
248 /* We find the last level of directory */
249 previous
= absolute_path
;
250 while ((slash
= strpbrk(previous
, "/")) && slash
!= next
) {
251 previous
= slash
+ 1;
254 /* Then we prepare the start_path not containing it */
255 start_path
= strndup(absolute_path
, previous
- absolute_path
);
261 /* And we concatenate it with the part after the '/../' */
262 snprintf(absolute_path
, PATH_MAX
, "%s%s", start_path
, next
+ 4);
264 /* We can free the memory used for the start path*/
267 /* Then we verify for symlinks using partial_realpath */
268 absolute_path
= utils_partial_realpath(absolute_path
,
269 absolute_path
, PATH_MAX
);
272 /* Identify the last token */
273 last_token
= strrchr(absolute_path
, '/');
275 /* Verify that this token is not a relative path */
276 is_dotdot
= (strcmp(last_token
, "/..") == 0);
277 is_dot
= (strcmp(last_token
, "/.") == 0);
279 /* If it is, take action */
280 if (is_dot
|| is_dotdot
) {
281 /* For both, remove this token */
284 /* If it was a reference to parent directory, go back one more time */
286 last_token
= strrchr(absolute_path
, '/');
288 /* If there was only one level left, we keep the first '/' */
289 if (last_token
== absolute_path
) {
297 return absolute_path
;
305 * Create a pipe in dst.
308 int utils_create_pipe(int *dst
)
318 PERROR("create pipe");
325 * Create pipe and set CLOEXEC flag to both fd.
327 * Make sure the pipe opened by this function are closed at some point. Use
328 * utils_close_pipe().
331 int utils_create_pipe_cloexec(int *dst
)
339 ret
= utils_create_pipe(dst
);
344 for (i
= 0; i
< 2; i
++) {
345 ret
= fcntl(dst
[i
], F_SETFD
, FD_CLOEXEC
);
347 PERROR("fcntl pipe cloexec");
357 * Create pipe and set fd flags to FD_CLOEXEC and O_NONBLOCK.
359 * Make sure the pipe opened by this function are closed at some point. Use
360 * utils_close_pipe(). Using pipe() and fcntl rather than pipe2() to
361 * support OSes other than Linux 2.6.23+.
364 int utils_create_pipe_cloexec_nonblock(int *dst
)
372 ret
= utils_create_pipe(dst
);
377 for (i
= 0; i
< 2; i
++) {
378 ret
= fcntl(dst
[i
], F_SETFD
, FD_CLOEXEC
);
380 PERROR("fcntl pipe cloexec");
384 * Note: we override any flag that could have been
385 * previously set on the fd.
387 ret
= fcntl(dst
[i
], F_SETFL
, O_NONBLOCK
);
389 PERROR("fcntl pipe nonblock");
399 * Close both read and write side of the pipe.
402 void utils_close_pipe(int *src
)
410 for (i
= 0; i
< 2; i
++) {
418 PERROR("close pipe");
424 * Create a new string using two strings range.
427 char *utils_strdupdelim(const char *begin
, const char *end
)
431 str
= zmalloc(end
- begin
+ 1);
433 PERROR("zmalloc strdupdelim");
437 memcpy(str
, begin
, end
- begin
);
438 str
[end
- begin
] = '\0';
445 * Set CLOEXEC flag to the give file descriptor.
448 int utils_set_fd_cloexec(int fd
)
457 ret
= fcntl(fd
, F_SETFD
, FD_CLOEXEC
);
459 PERROR("fcntl cloexec");
468 * Create pid file to the given path and filename.
471 int utils_create_pid_file(pid_t pid
, const char *filepath
)
478 fp
= fopen(filepath
, "w");
480 PERROR("open pid file %s", filepath
);
485 ret
= fprintf(fp
, "%d\n", pid
);
487 PERROR("fprintf pid file");
494 DBG("Pid %d written in file %s", pid
, filepath
);
501 * Create lock file to the given path and filename.
502 * Returns the associated file descriptor, -1 on error.
505 int utils_create_lock_file(const char *filepath
)
512 fd
= open(filepath
, O_CREAT
,
513 O_WRONLY
| S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
515 PERROR("open lock file %s", filepath
);
521 * Attempt to lock the file. If this fails, there is
522 * already a process using the same lock file running
523 * and we should exit.
525 ret
= flock(fd
, LOCK_EX
| LOCK_NB
);
527 ERR("Could not get lock file %s, another instance is running.",
530 PERROR("close lock file");
541 * On some filesystems (e.g. nfs), mkdir will validate access rights before
542 * checking for the existence of the path element. This means that on a setup
543 * where "/home/" is a mounted NFS share, and running as an unpriviledged user,
544 * recursively creating a path of the form "/home/my_user/trace/" will fail with
545 * EACCES on mkdir("/home", ...).
547 * Performing a stat(...) on the path to check for existence allows us to
548 * work around this behaviour.
551 int mkdir_check_exists(const char *path
, mode_t mode
)
556 ret
= stat(path
, &st
);
558 if (S_ISDIR(st
.st_mode
)) {
559 /* Directory exists, skip. */
562 /* Exists, but is not a directory. */
570 * Let mkdir handle other errors as the caller expects mkdir
573 ret
= mkdir(path
, mode
);
579 * Create directory using the given path and mode.
581 * On success, return 0 else a negative error code.
584 int utils_mkdir(const char *path
, mode_t mode
, int uid
, int gid
)
588 if (uid
< 0 || gid
< 0) {
589 ret
= mkdir_check_exists(path
, mode
);
591 ret
= run_as_mkdir(path
, mode
, uid
, gid
);
594 if (errno
!= EEXIST
) {
595 PERROR("mkdir %s, uid %d, gid %d", path
? path
: "NULL",
606 * Internal version of mkdir_recursive. Runs as the current user.
607 * Don't call directly; use utils_mkdir_recursive().
609 * This function is ominously marked as "unsafe" since it should only
610 * be called by a caller that has transitioned to the uid and gid under which
611 * the directory creation should occur.
614 int _utils_mkdir_recursive_unsafe(const char *path
, mode_t mode
)
616 char *p
, tmp
[PATH_MAX
];
622 ret
= snprintf(tmp
, sizeof(tmp
), "%s", path
);
624 PERROR("snprintf mkdir");
629 if (tmp
[len
- 1] == '/') {
633 for (p
= tmp
+ 1; *p
; p
++) {
636 if (tmp
[strlen(tmp
) - 1] == '.' &&
637 tmp
[strlen(tmp
) - 2] == '.' &&
638 tmp
[strlen(tmp
) - 3] == '/') {
639 ERR("Using '/../' is not permitted in the trace path (%s)",
644 ret
= mkdir_check_exists(tmp
, mode
);
646 if (errno
!= EACCES
) {
647 PERROR("mkdir recursive");
656 ret
= mkdir_check_exists(tmp
, mode
);
658 PERROR("mkdir recursive last element");
667 * Recursively create directory using the given path and mode, under the
668 * provided uid and gid.
670 * On success, return 0 else a negative error code.
673 int utils_mkdir_recursive(const char *path
, mode_t mode
, int uid
, int gid
)
677 if (uid
< 0 || gid
< 0) {
678 /* Run as current user. */
679 ret
= _utils_mkdir_recursive_unsafe(path
, mode
);
681 ret
= run_as_mkdir_recursive(path
, mode
, uid
, gid
);
684 PERROR("mkdir %s, uid %d, gid %d", path
? path
: "NULL",
692 * path is the output parameter. It needs to be PATH_MAX len.
694 * Return 0 on success or else a negative value.
696 static int utils_stream_file_name(char *path
,
697 const char *path_name
, const char *file_name
,
698 uint64_t size
, uint64_t count
,
702 char full_path
[PATH_MAX
];
703 char *path_name_suffix
= NULL
;
706 ret
= snprintf(full_path
, sizeof(full_path
), "%s/%s",
707 path_name
, file_name
);
709 PERROR("snprintf create output file");
713 /* Setup extra string if suffix or/and a count is needed. */
714 if (size
> 0 && suffix
) {
715 ret
= asprintf(&extra
, "_%" PRIu64
"%s", count
, suffix
);
716 } else if (size
> 0) {
717 ret
= asprintf(&extra
, "_%" PRIu64
, count
);
719 ret
= asprintf(&extra
, "%s", suffix
);
722 PERROR("Allocating extra string to name");
727 * If we split the trace in multiple files, we have to add the count at
728 * the end of the tracefile name.
731 ret
= asprintf(&path_name_suffix
, "%s%s", full_path
, extra
);
733 PERROR("Allocating path name with extra string");
734 goto error_free_suffix
;
736 strncpy(path
, path_name_suffix
, PATH_MAX
- 1);
737 path
[PATH_MAX
- 1] = '\0';
739 strncpy(path
, full_path
, PATH_MAX
- 1);
741 path
[PATH_MAX
- 1] = '\0';
744 free(path_name_suffix
);
752 * Create the stream file on disk.
754 * Return 0 on success or else a negative value.
757 int utils_create_stream_file(const char *path_name
, char *file_name
, uint64_t size
,
758 uint64_t count
, int uid
, int gid
, char *suffix
)
760 int ret
, flags
, mode
;
763 ret
= utils_stream_file_name(path
, path_name
, file_name
,
764 size
, count
, suffix
);
769 flags
= O_WRONLY
| O_CREAT
| O_TRUNC
;
770 /* Open with 660 mode */
771 mode
= S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
;
773 if (uid
< 0 || gid
< 0) {
774 ret
= open(path
, flags
, mode
);
776 ret
= run_as_open(path
, flags
, mode
, uid
, gid
);
779 PERROR("open stream path %s", path
);
786 * Unlink the stream tracefile from disk.
788 * Return 0 on success or else a negative value.
791 int utils_unlink_stream_file(const char *path_name
, char *file_name
, uint64_t size
,
792 uint64_t count
, int uid
, int gid
, char *suffix
)
797 ret
= utils_stream_file_name(path
, path_name
, file_name
,
798 size
, count
, suffix
);
802 if (uid
< 0 || gid
< 0) {
805 ret
= run_as_unlink(path
, uid
, gid
);
811 DBG("utils_unlink_stream_file %s returns %d", path
, ret
);
816 * Change the output tracefile according to the given size and count The
817 * new_count pointer is set during this operation.
819 * From the consumer, the stream lock MUST be held before calling this function
820 * because we are modifying the stream status.
822 * Return 0 on success or else a negative value.
825 int utils_rotate_stream_file(char *path_name
, char *file_name
, uint64_t size
,
826 uint64_t count
, int uid
, int gid
, int out_fd
, uint64_t *new_count
,
836 PERROR("Closing tracefile");
843 * In tracefile rotation, for the relay daemon we need
844 * to unlink the old file if present, because it may
845 * still be open in reading by the live thread, and we
846 * need to ensure that we do not overwrite the content
847 * between get_index and get_packet. Since we have no
848 * way to verify integrity of the data content compared
849 * to the associated index, we need to ensure the reader
850 * has exclusive access to the file content, and that
851 * the open of the data file is performed in get_index.
852 * Unlinking the old file rather than overwriting it
855 *new_count
= (*new_count
+ 1) % count
;
856 ret
= utils_unlink_stream_file(path_name
, file_name
,
857 size
, *new_count
, uid
, gid
, 0);
858 if (ret
< 0 && errno
!= ENOENT
) {
865 ret
= utils_create_stream_file(path_name
, file_name
, size
, *new_count
,
881 * Parse a string that represents a size in human readable format. It
882 * supports decimal integers suffixed by 'k', 'K', 'M' or 'G'.
884 * The suffix multiply the integer by:
889 * @param str The string to parse.
890 * @param size Pointer to a uint64_t that will be filled with the
893 * @return 0 on success, -1 on failure.
896 int utils_parse_size_suffix(const char * const str
, uint64_t * const size
)
905 DBG("utils_parse_size_suffix: received a NULL string.");
910 /* strtoull will accept a negative number, but we don't want to. */
911 if (strchr(str
, '-') != NULL
) {
912 DBG("utils_parse_size_suffix: invalid size string, should not contain '-'.");
917 /* str_end will point to the \0 */
918 str_end
= str
+ strlen(str
);
920 base_size
= strtoull(str
, &num_end
, 0);
922 PERROR("utils_parse_size_suffix strtoull");
927 if (num_end
== str
) {
928 /* strtoull parsed nothing, not good. */
929 DBG("utils_parse_size_suffix: strtoull had nothing good to parse.");
934 /* Check if a prefix is present. */
952 DBG("utils_parse_size_suffix: invalid suffix.");
957 /* Check for garbage after the valid input. */
958 if (num_end
!= str_end
) {
959 DBG("utils_parse_size_suffix: Garbage after size string.");
964 *size
= base_size
<< shift
;
966 /* Check for overflow */
967 if ((*size
>> shift
) != base_size
) {
968 DBG("utils_parse_size_suffix: oops, overflow detected.");
979 * fls: returns the position of the most significant bit.
980 * Returns 0 if no bit is set, else returns the position of the most
981 * significant bit (from 1 to 32 on 32-bit, from 1 to 64 on 64-bit).
983 #if defined(__i386) || defined(__x86_64)
984 static inline unsigned int fls_u32(uint32_t x
)
992 : "=r" (r
) : "rm" (x
));
999 static __attribute__((unused
)) unsigned int fls_u32(uint32_t x
)
1001 unsigned int r
= 32;
1006 if (!(x
& 0xFFFF0000U
)) {
1010 if (!(x
& 0xFF000000U
)) {
1014 if (!(x
& 0xF0000000U
)) {
1018 if (!(x
& 0xC0000000U
)) {
1022 if (!(x
& 0x80000000U
)) {
1031 * Return the minimum order for which x <= (1UL << order).
1032 * Return -1 if x is 0.
1035 int utils_get_count_order_u32(uint32_t x
)
1041 return fls_u32(x
- 1);
1045 * Obtain the value of LTTNG_HOME environment variable, if exists.
1046 * Otherwise returns the value of HOME.
1049 char *utils_get_home_dir(void)
1054 val
= lttng_secure_getenv(DEFAULT_LTTNG_HOME_ENV_VAR
);
1058 val
= lttng_secure_getenv(DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR
);
1063 /* Fallback on the password file entry. */
1064 pwd
= getpwuid(getuid());
1070 DBG3("Home directory is '%s'", val
);
1077 * Get user's home directory. Dynamically allocated, must be freed
1081 char *utils_get_user_home_dir(uid_t uid
)
1084 struct passwd
*result
;
1085 char *home_dir
= NULL
;
1090 buflen
= sysconf(_SC_GETPW_R_SIZE_MAX
);
1095 buf
= zmalloc(buflen
);
1100 ret
= getpwuid_r(uid
, &pwd
, buf
, buflen
, &result
);
1101 if (ret
|| !result
) {
1102 if (ret
== ERANGE
) {
1110 home_dir
= strdup(pwd
.pw_dir
);
1117 * Obtain the value of LTTNG_KMOD_PROBES environment variable, if exists.
1118 * Otherwise returns NULL.
1121 char *utils_get_kmod_probes_list(void)
1123 return lttng_secure_getenv(DEFAULT_LTTNG_KMOD_PROBES
);
1127 * Obtain the value of LTTNG_EXTRA_KMOD_PROBES environment variable, if
1128 * exists. Otherwise returns NULL.
1131 char *utils_get_extra_kmod_probes_list(void)
1133 return lttng_secure_getenv(DEFAULT_LTTNG_EXTRA_KMOD_PROBES
);
1137 * With the given format, fill dst with the time of len maximum siz.
1139 * Return amount of bytes set in the buffer or else 0 on error.
1142 size_t utils_get_current_time_str(const char *format
, char *dst
, size_t len
)
1146 struct tm
*timeinfo
;
1151 /* Get date and time for session path */
1153 timeinfo
= localtime(&rawtime
);
1154 ret
= strftime(dst
, len
, format
, timeinfo
);
1156 ERR("Unable to strftime with format %s at dst %p of len %zu", format
,
1164 * Return the group ID matching name, else 0 if it cannot be found.
1167 gid_t
utils_get_group_id(const char *name
)
1171 grp
= getgrnam(name
);
1173 static volatile int warn_once
;
1176 WARN("No tracing group detected");
1185 * Return a newly allocated option string. This string is to be used as the
1186 * optstring argument of getopt_long(), see GETOPT(3). opt_count is the number
1187 * of elements in the long_options array. Returns NULL if the string's
1191 char *utils_generate_optstring(const struct option
*long_options
,
1195 size_t string_len
= opt_count
, str_pos
= 0;
1199 * Compute the necessary string length. One letter per option, two when an
1200 * argument is necessary, and a trailing NULL.
1202 for (i
= 0; i
< opt_count
; i
++) {
1203 string_len
+= long_options
[i
].has_arg
? 1 : 0;
1206 optstring
= zmalloc(string_len
);
1211 for (i
= 0; i
< opt_count
; i
++) {
1212 if (!long_options
[i
].name
) {
1213 /* Got to the trailing NULL element */
1217 if (long_options
[i
].val
!= '\0') {
1218 optstring
[str_pos
++] = (char) long_options
[i
].val
;
1219 if (long_options
[i
].has_arg
) {
1220 optstring
[str_pos
++] = ':';
1230 * Try to remove a hierarchy of empty directories, recursively. Don't unlink
1231 * any file. Try to rmdir any empty directory within the hierarchy.
1234 int utils_recursive_rmdir(const char *path
)
1237 int dir_fd
, ret
= 0, closeret
, is_empty
= 1;
1238 struct dirent
*entry
;
1240 /* Open directory */
1241 dir
= opendir(path
);
1243 PERROR("Cannot open '%s' path", path
);
1246 dir_fd
= dirfd(dir
);
1252 while ((entry
= readdir(dir
))) {
1253 if (!strcmp(entry
->d_name
, ".")
1254 || !strcmp(entry
->d_name
, ".."))
1256 switch (entry
->d_type
) {
1259 char subpath
[PATH_MAX
];
1261 strncpy(subpath
, path
, PATH_MAX
);
1262 subpath
[PATH_MAX
- 1] = '\0';
1263 strncat(subpath
, "/",
1264 PATH_MAX
- strlen(subpath
) - 1);
1265 strncat(subpath
, entry
->d_name
,
1266 PATH_MAX
- strlen(subpath
) - 1);
1267 if (utils_recursive_rmdir(subpath
)) {
1281 closeret
= closedir(dir
);
1286 DBG3("Attempting rmdir %s", path
);