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 */
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");
139 * If we were able to solve at least partially the path, we can concatenate
140 * what worked and what didn't work
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';
149 * Duplicate the memory used by prev in case resolved_path and
150 * path are pointers for the same memory space
152 cut_path
= strdup(prev
);
153 if (cut_path
== NULL
) {
158 /* Concatenate the strings */
159 snprintf(resolved_path
, size
, "%s%s", try_path_prev
, cut_path
);
161 /* Free the allocated memory */
165 * Else, we just copy the path in our resolved_path to
169 strncpy(resolved_path
, path
, size
);
172 /* Then we return the 'partially' resolved path */
173 return resolved_path
;
182 * Make a full resolution of the given path even if it doesn't exist.
183 * This function uses the utils_partial_realpath function to resolve
184 * symlinks and relatives paths at the start of the string, and
185 * implements functionnalities to resolve the './' and '../' strings
186 * in the middle of a path. This function is only necessary because
187 * realpath(3) does not accept to resolve unexistent paths.
188 * The returned string was allocated in the function, it is thus of
189 * the responsibility of the caller to free this memory.
192 char *utils_expand_path(const char *path
)
194 char *next
, *previous
, *slash
, *start_path
, *absolute_path
= NULL
;
196 int is_dot
, is_dotdot
;
203 /* Allocate memory for the absolute_path */
204 absolute_path
= zmalloc(PATH_MAX
);
205 if (absolute_path
== NULL
) {
206 PERROR("zmalloc expand path");
211 * If the path is not already absolute nor explicitly relative,
212 * consider we're in the current directory
214 if (*path
!= '/' && strncmp(path
, "./", 2) != 0 &&
215 strncmp(path
, "../", 3) != 0) {
216 snprintf(absolute_path
, PATH_MAX
, "./%s", path
);
217 /* Else, we just copy the path */
219 strncpy(absolute_path
, path
, PATH_MAX
);
222 /* Resolve partially our path */
223 absolute_path
= utils_partial_realpath(absolute_path
,
224 absolute_path
, PATH_MAX
);
226 /* As long as we find '/./' in the working_path string */
227 while ((next
= strstr(absolute_path
, "/./"))) {
229 /* We prepare the start_path not containing it */
230 start_path
= strndup(absolute_path
, next
- absolute_path
);
235 /* And we concatenate it with the part after this string */
236 snprintf(absolute_path
, PATH_MAX
, "%s%s", start_path
, next
+ 2);
241 /* As long as we find '/../' in the working_path string */
242 while ((next
= strstr(absolute_path
, "/../"))) {
243 /* We find the last level of directory */
244 previous
= absolute_path
;
245 while ((slash
= strpbrk(previous
, "/")) && slash
!= next
) {
246 previous
= slash
+ 1;
249 /* Then we prepare the start_path not containing it */
250 start_path
= strndup(absolute_path
, previous
- absolute_path
);
256 /* And we concatenate it with the part after the '/../' */
257 snprintf(absolute_path
, PATH_MAX
, "%s%s", start_path
, next
+ 4);
259 /* We can free the memory used for the start path*/
262 /* Then we verify for symlinks using partial_realpath */
263 absolute_path
= utils_partial_realpath(absolute_path
,
264 absolute_path
, PATH_MAX
);
267 /* Identify the last token */
268 last_token
= strrchr(absolute_path
, '/');
270 /* Verify that this token is not a relative path */
271 is_dotdot
= (strcmp(last_token
, "/..") == 0);
272 is_dot
= (strcmp(last_token
, "/.") == 0);
274 /* If it is, take action */
275 if (is_dot
|| is_dotdot
) {
276 /* For both, remove this token */
279 /* If it was a reference to parent directory, go back one more time */
281 last_token
= strrchr(absolute_path
, '/');
283 /* If there was only one level left, we keep the first '/' */
284 if (last_token
== absolute_path
) {
292 return absolute_path
;
300 * Create a pipe in dst.
303 int utils_create_pipe(int *dst
)
313 PERROR("create pipe");
320 * Create pipe and set CLOEXEC flag to both fd.
322 * Make sure the pipe opened by this function are closed at some point. Use
323 * utils_close_pipe().
326 int utils_create_pipe_cloexec(int *dst
)
334 ret
= utils_create_pipe(dst
);
339 for (i
= 0; i
< 2; i
++) {
340 ret
= fcntl(dst
[i
], F_SETFD
, FD_CLOEXEC
);
342 PERROR("fcntl pipe cloexec");
352 * Create pipe and set fd flags to FD_CLOEXEC and O_NONBLOCK.
354 * Make sure the pipe opened by this function are closed at some point. Use
355 * utils_close_pipe(). Using pipe() and fcntl rather than pipe2() to
356 * support OSes other than Linux 2.6.23+.
359 int utils_create_pipe_cloexec_nonblock(int *dst
)
367 ret
= utils_create_pipe(dst
);
372 for (i
= 0; i
< 2; i
++) {
373 ret
= fcntl(dst
[i
], F_SETFD
, FD_CLOEXEC
);
375 PERROR("fcntl pipe cloexec");
379 * Note: we override any flag that could have been
380 * previously set on the fd.
382 ret
= fcntl(dst
[i
], F_SETFL
, O_NONBLOCK
);
384 PERROR("fcntl pipe nonblock");
394 * Close both read and write side of the pipe.
397 void utils_close_pipe(int *src
)
405 for (i
= 0; i
< 2; i
++) {
413 PERROR("close pipe");
419 * Create a new string using two strings range.
422 char *utils_strdupdelim(const char *begin
, const char *end
)
426 str
= zmalloc(end
- begin
+ 1);
428 PERROR("zmalloc strdupdelim");
432 memcpy(str
, begin
, end
- begin
);
433 str
[end
- begin
] = '\0';
440 * Set CLOEXEC flag to the give file descriptor.
443 int utils_set_fd_cloexec(int fd
)
452 ret
= fcntl(fd
, F_SETFD
, FD_CLOEXEC
);
454 PERROR("fcntl cloexec");
463 * Create pid file to the given path and filename.
466 int utils_create_pid_file(pid_t pid
, const char *filepath
)
473 fp
= fopen(filepath
, "w");
475 PERROR("open pid file %s", filepath
);
480 ret
= fprintf(fp
, "%d\n", pid
);
482 PERROR("fprintf pid file");
489 DBG("Pid %d written in file %s", pid
, filepath
);
496 * Create lock file to the given path and filename.
497 * Returns the associated file descriptor, -1 on error.
500 int utils_create_lock_file(const char *filepath
)
507 fd
= open(filepath
, O_CREAT
,
508 O_WRONLY
| S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
510 PERROR("open lock file %s", filepath
);
516 * Attempt to lock the file. If this fails, there is
517 * already a process using the same lock file running
518 * and we should exit.
520 ret
= flock(fd
, LOCK_EX
| LOCK_NB
);
522 ERR("Could not get lock file %s, another instance is running.",
525 PERROR("close lock file");
536 * Create directory using the given path and mode.
538 * On success, return 0 else a negative error code.
541 int utils_mkdir(const char *path
, mode_t mode
, int uid
, int gid
)
545 if (uid
< 0 || gid
< 0) {
546 ret
= mkdir(path
, mode
);
548 ret
= run_as_mkdir(path
, mode
, uid
, gid
);
551 if (errno
!= EEXIST
) {
552 PERROR("mkdir %s, uid %d, gid %d", path
? path
: "NULL",
563 * Internal version of mkdir_recursive. Runs as the current user.
564 * Don't call directly; use utils_mkdir_recursive().
566 * This function is ominously marked as "unsafe" since it should only
567 * be called by a caller that has transitioned to the uid and gid under which
568 * the directory creation should occur.
571 int _utils_mkdir_recursive_unsafe(const char *path
, mode_t mode
)
573 char *p
, tmp
[PATH_MAX
];
579 ret
= snprintf(tmp
, sizeof(tmp
), "%s", path
);
581 PERROR("snprintf mkdir");
586 if (tmp
[len
- 1] == '/') {
590 for (p
= tmp
+ 1; *p
; p
++) {
593 if (tmp
[strlen(tmp
) - 1] == '.' &&
594 tmp
[strlen(tmp
) - 2] == '.' &&
595 tmp
[strlen(tmp
) - 3] == '/') {
596 ERR("Using '/../' is not permitted in the trace path (%s)",
601 ret
= mkdir(tmp
, mode
);
603 if (errno
!= EEXIST
) {
604 PERROR("mkdir recursive");
613 ret
= mkdir(tmp
, mode
);
615 if (errno
!= EEXIST
) {
616 PERROR("mkdir recursive last element");
628 * Recursively create directory using the given path and mode, under the
629 * provided uid and gid.
631 * On success, return 0 else a negative error code.
634 int utils_mkdir_recursive(const char *path
, mode_t mode
, int uid
, int gid
)
638 if (uid
< 0 || gid
< 0) {
639 /* Run as current user. */
640 ret
= _utils_mkdir_recursive_unsafe(path
, mode
);
642 ret
= run_as_mkdir_recursive(path
, mode
, uid
, gid
);
645 PERROR("mkdir %s, uid %d, gid %d", path
? path
: "NULL",
653 * path is the output parameter. It needs to be PATH_MAX len.
655 * Return 0 on success or else a negative value.
657 static int utils_stream_file_name(char *path
,
658 const char *path_name
, const char *file_name
,
659 uint64_t size
, uint64_t count
,
663 char full_path
[PATH_MAX
];
664 char *path_name_suffix
= NULL
;
667 ret
= snprintf(full_path
, sizeof(full_path
), "%s/%s",
668 path_name
, file_name
);
670 PERROR("snprintf create output file");
674 /* Setup extra string if suffix or/and a count is needed. */
675 if (size
> 0 && suffix
) {
676 ret
= asprintf(&extra
, "_%" PRIu64
"%s", count
, suffix
);
677 } else if (size
> 0) {
678 ret
= asprintf(&extra
, "_%" PRIu64
, count
);
680 ret
= asprintf(&extra
, "%s", suffix
);
683 PERROR("Allocating extra string to name");
688 * If we split the trace in multiple files, we have to add the count at
689 * the end of the tracefile name.
692 ret
= asprintf(&path_name_suffix
, "%s%s", full_path
, extra
);
694 PERROR("Allocating path name with extra string");
695 goto error_free_suffix
;
697 strncpy(path
, path_name_suffix
, PATH_MAX
- 1);
698 path
[PATH_MAX
- 1] = '\0';
700 strncpy(path
, full_path
, PATH_MAX
- 1);
702 path
[PATH_MAX
- 1] = '\0';
705 free(path_name_suffix
);
713 * Create the stream file on disk.
715 * Return 0 on success or else a negative value.
718 int utils_create_stream_file(const char *path_name
, char *file_name
, uint64_t size
,
719 uint64_t count
, int uid
, int gid
, char *suffix
)
721 int ret
, flags
, mode
;
724 ret
= utils_stream_file_name(path
, path_name
, file_name
,
725 size
, count
, suffix
);
730 flags
= O_WRONLY
| O_CREAT
| O_TRUNC
;
731 /* Open with 660 mode */
732 mode
= S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
;
734 if (uid
< 0 || gid
< 0) {
735 ret
= open(path
, flags
, mode
);
737 ret
= run_as_open(path
, flags
, mode
, uid
, gid
);
740 PERROR("open stream path %s", path
);
747 * Unlink the stream tracefile from disk.
749 * Return 0 on success or else a negative value.
752 int utils_unlink_stream_file(const char *path_name
, char *file_name
, uint64_t size
,
753 uint64_t count
, int uid
, int gid
, char *suffix
)
758 ret
= utils_stream_file_name(path
, path_name
, file_name
,
759 size
, count
, suffix
);
763 if (uid
< 0 || gid
< 0) {
766 ret
= run_as_unlink(path
, uid
, gid
);
772 DBG("utils_unlink_stream_file %s returns %d", path
, ret
);
777 * Change the output tracefile according to the given size and count The
778 * new_count pointer is set during this operation.
780 * From the consumer, the stream lock MUST be held before calling this function
781 * because we are modifying the stream status.
783 * Return 0 on success or else a negative value.
786 int utils_rotate_stream_file(char *path_name
, char *file_name
, uint64_t size
,
787 uint64_t count
, int uid
, int gid
, int out_fd
, uint64_t *new_count
,
797 PERROR("Closing tracefile");
803 * In tracefile rotation, for the relay daemon we need
804 * to unlink the old file if present, because it may
805 * still be open in reading by the live thread, and we
806 * need to ensure that we do not overwrite the content
807 * between get_index and get_packet. Since we have no
808 * way to verify integrity of the data content compared
809 * to the associated index, we need to ensure the reader
810 * has exclusive access to the file content, and that
811 * the open of the data file is performed in get_index.
812 * Unlinking the old file rather than overwriting it
815 *new_count
= (*new_count
+ 1) % count
;
816 ret
= utils_unlink_stream_file(path_name
, file_name
,
817 size
, *new_count
, uid
, gid
, 0);
818 if (ret
< 0 && errno
!= ENOENT
) {
825 ret
= utils_create_stream_file(path_name
, file_name
, size
, *new_count
,
841 * Parse a string that represents a size in human readable format. It
842 * supports decimal integers suffixed by 'k', 'K', 'M' or 'G'.
844 * The suffix multiply the integer by:
849 * @param str The string to parse.
850 * @param size Pointer to a uint64_t that will be filled with the
853 * @return 0 on success, -1 on failure.
856 int utils_parse_size_suffix(const char * const str
, uint64_t * const size
)
865 DBG("utils_parse_size_suffix: received a NULL string.");
870 /* strtoull will accept a negative number, but we don't want to. */
871 if (strchr(str
, '-') != NULL
) {
872 DBG("utils_parse_size_suffix: invalid size string, should not contain '-'.");
877 /* str_end will point to the \0 */
878 str_end
= str
+ strlen(str
);
880 base_size
= strtoull(str
, &num_end
, 0);
882 PERROR("utils_parse_size_suffix strtoull");
887 if (num_end
== str
) {
888 /* strtoull parsed nothing, not good. */
889 DBG("utils_parse_size_suffix: strtoull had nothing good to parse.");
894 /* Check if a prefix is present. */
912 DBG("utils_parse_size_suffix: invalid suffix.");
917 /* Check for garbage after the valid input. */
918 if (num_end
!= str_end
) {
919 DBG("utils_parse_size_suffix: Garbage after size string.");
924 *size
= base_size
<< shift
;
926 /* Check for overflow */
927 if ((*size
>> shift
) != base_size
) {
928 DBG("utils_parse_size_suffix: oops, overflow detected.");
939 * fls: returns the position of the most significant bit.
940 * Returns 0 if no bit is set, else returns the position of the most
941 * significant bit (from 1 to 32 on 32-bit, from 1 to 64 on 64-bit).
943 #if defined(__i386) || defined(__x86_64)
944 static inline unsigned int fls_u32(uint32_t x
)
952 : "=r" (r
) : "rm" (x
));
959 static __attribute__((unused
)) unsigned int fls_u32(uint32_t x
)
966 if (!(x
& 0xFFFF0000U
)) {
970 if (!(x
& 0xFF000000U
)) {
974 if (!(x
& 0xF0000000U
)) {
978 if (!(x
& 0xC0000000U
)) {
982 if (!(x
& 0x80000000U
)) {
991 * Return the minimum order for which x <= (1UL << order).
992 * Return -1 if x is 0.
995 int utils_get_count_order_u32(uint32_t x
)
1001 return fls_u32(x
- 1);
1005 * Obtain the value of LTTNG_HOME environment variable, if exists.
1006 * Otherwise returns the value of HOME.
1009 char *utils_get_home_dir(void)
1014 val
= lttng_secure_getenv(DEFAULT_LTTNG_HOME_ENV_VAR
);
1018 val
= lttng_secure_getenv(DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR
);
1023 /* Fallback on the password file entry. */
1024 pwd
= getpwuid(getuid());
1030 DBG3("Home directory is '%s'", val
);
1037 * Get user's home directory. Dynamically allocated, must be freed
1041 char *utils_get_user_home_dir(uid_t uid
)
1044 struct passwd
*result
;
1045 char *home_dir
= NULL
;
1050 buflen
= sysconf(_SC_GETPW_R_SIZE_MAX
);
1055 buf
= zmalloc(buflen
);
1060 ret
= getpwuid_r(uid
, &pwd
, buf
, buflen
, &result
);
1061 if (ret
|| !result
) {
1062 if (ret
== ERANGE
) {
1070 home_dir
= strdup(pwd
.pw_dir
);
1077 * Obtain the value of LTTNG_KMOD_PROBES environment variable, if exists.
1078 * Otherwise returns NULL.
1081 char *utils_get_kmod_probes_list(void)
1083 return lttng_secure_getenv(DEFAULT_LTTNG_KMOD_PROBES
);
1087 * Obtain the value of LTTNG_EXTRA_KMOD_PROBES environment variable, if
1088 * exists. Otherwise returns NULL.
1091 char *utils_get_extra_kmod_probes_list(void)
1093 return lttng_secure_getenv(DEFAULT_LTTNG_EXTRA_KMOD_PROBES
);
1097 * With the given format, fill dst with the time of len maximum siz.
1099 * Return amount of bytes set in the buffer or else 0 on error.
1102 size_t utils_get_current_time_str(const char *format
, char *dst
, size_t len
)
1106 struct tm
*timeinfo
;
1111 /* Get date and time for session path */
1113 timeinfo
= localtime(&rawtime
);
1114 ret
= strftime(dst
, len
, format
, timeinfo
);
1116 ERR("Unable to strftime with format %s at dst %p of len %zu", format
,
1124 * Return the group ID matching name, else 0 if it cannot be found.
1127 gid_t
utils_get_group_id(const char *name
)
1131 grp
= getgrnam(name
);
1133 static volatile int warn_once
;
1136 WARN("No tracing group detected");
1145 * Return a newly allocated option string. This string is to be used as the
1146 * optstring argument of getopt_long(), see GETOPT(3). opt_count is the number
1147 * of elements in the long_options array. Returns NULL if the string's
1151 char *utils_generate_optstring(const struct option
*long_options
,
1155 size_t string_len
= opt_count
, str_pos
= 0;
1159 * Compute the necessary string length. One letter per option, two when an
1160 * argument is necessary, and a trailing NULL.
1162 for (i
= 0; i
< opt_count
; i
++) {
1163 string_len
+= long_options
[i
].has_arg
? 1 : 0;
1166 optstring
= zmalloc(string_len
);
1171 for (i
= 0; i
< opt_count
; i
++) {
1172 if (!long_options
[i
].name
) {
1173 /* Got to the trailing NULL element */
1177 if (long_options
[i
].val
!= '\0') {
1178 optstring
[str_pos
++] = (char) long_options
[i
].val
;
1179 if (long_options
[i
].has_arg
) {
1180 optstring
[str_pos
++] = ':';
1190 * Try to remove a hierarchy of empty directories, recursively. Don't unlink
1191 * any file. Try to rmdir any empty directory within the hierarchy.
1194 int utils_recursive_rmdir(const char *path
)
1197 int dir_fd
, ret
= 0, closeret
, is_empty
= 1;
1198 struct dirent
*entry
;
1200 /* Open directory */
1201 dir
= opendir(path
);
1203 PERROR("Cannot open '%s' path", path
);
1206 dir_fd
= dirfd(dir
);
1212 while ((entry
= readdir(dir
))) {
1213 if (!strcmp(entry
->d_name
, ".")
1214 || !strcmp(entry
->d_name
, ".."))
1216 switch (entry
->d_type
) {
1219 char subpath
[PATH_MAX
];
1221 strncpy(subpath
, path
, PATH_MAX
);
1222 subpath
[PATH_MAX
- 1] = '\0';
1223 strncat(subpath
, "/",
1224 PATH_MAX
- strlen(subpath
) - 1);
1225 strncat(subpath
, entry
->d_name
,
1226 PATH_MAX
- strlen(subpath
) - 1);
1227 if (utils_recursive_rmdir(subpath
)) {
1241 closeret
= closedir(dir
);
1246 DBG3("Attempting rmdir %s", path
);