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>
36 #include <common/common.h>
37 #include <common/runas.h>
43 * Return a partial realpath(3) of the path even if the full path does not
44 * exist. For instance, with /tmp/test1/test2/test3, if test2/ does not exist
45 * but the /tmp/test1 does, the real path for /tmp/test1 is concatened with
46 * /test2/test3 then returned. In normal time, realpath(3) fails if the end
47 * point directory does not exist.
48 * In case resolved_path is NULL, the string returned was allocated in the
49 * function and thus need to be freed by the caller. The size argument allows
50 * to specify the size of the resolved_path argument if given, or the size to
54 char *utils_partial_realpath(const char *path
, char *resolved_path
, size_t size
)
56 char *cut_path
, *try_path
= NULL
, *try_path_prev
= NULL
;
57 const char *next
, *prev
, *end
;
65 * Identify the end of the path, we don't want to treat the
66 * last char if it is a '/', we will just keep it on the side
67 * to be added at the end, and return a value coherent with
68 * the path given as argument
70 end
= path
+ strlen(path
);
71 if (*(end
-1) == '/') {
75 /* Initiate the values of the pointers before looping */
78 /* Only to ensure try_path is not NULL to enter the while */
79 try_path
= (char *)next
;
81 /* Resolve the canonical path of the first part of the path */
82 while (try_path
!= NULL
&& next
!= end
) {
84 * If there is not any '/' left, we want to try with
87 next
= strpbrk(next
+ 1, "/");
92 /* Cut the part we will be trying to resolve */
93 cut_path
= strndup(path
, next
- path
);
95 /* Try to resolve this part */
96 try_path
= realpath((char *)cut_path
, NULL
);
97 if (try_path
== NULL
) {
99 * There was an error, we just want to be assured it
100 * is linked to an unexistent directory, if it's another
101 * reason, we spawn an error
105 /* Ignore the error */
108 PERROR("realpath (partial_realpath)");
113 /* Save the place we are before trying the next step */
115 try_path_prev
= try_path
;
119 /* Free the allocated memory */
123 /* Allocate memory for the resolved path if necessary */
124 if (resolved_path
== NULL
) {
125 resolved_path
= zmalloc(size
);
126 if (resolved_path
== NULL
) {
127 PERROR("zmalloc resolved path");
133 * If we were able to solve at least partially the path, we can concatenate
134 * what worked and what didn't work
136 if (try_path_prev
!= NULL
) {
137 /* If we risk to concatenate two '/', we remove one of them */
138 if (try_path_prev
[strlen(try_path_prev
) - 1] == '/' && prev
[0] == '/') {
139 try_path_prev
[strlen(try_path_prev
) - 1] = '\0';
143 * Duplicate the memory used by prev in case resolved_path and
144 * path are pointers for the same memory space
146 cut_path
= strdup(prev
);
148 /* Concatenate the strings */
149 snprintf(resolved_path
, size
, "%s%s", try_path_prev
, cut_path
);
151 /* Free the allocated memory */
155 * Else, we just copy the path in our resolved_path to
159 strncpy(resolved_path
, path
, size
);
162 /* Then we return the 'partially' resolved path */
163 return resolved_path
;
171 * Make a full resolution of the given path even if it doesn't exist.
172 * This function uses the utils_partial_realpath function to resolve
173 * symlinks and relatives paths at the start of the string, and
174 * implements functionnalities to resolve the './' and '../' strings
175 * in the middle of a path. This function is only necessary because
176 * realpath(3) does not accept to resolve unexistent paths.
177 * The returned string was allocated in the function, it is thus of
178 * the responsibility of the caller to free this memory.
181 char *utils_expand_path(const char *path
)
183 char *next
, *previous
, *slash
, *start_path
, *absolute_path
= NULL
;
185 int is_dot
, is_dotdot
;
192 /* Allocate memory for the absolute_path */
193 absolute_path
= zmalloc(PATH_MAX
);
194 if (absolute_path
== NULL
) {
195 PERROR("zmalloc expand path");
200 * If the path is not already absolute nor explicitly relative,
201 * consider we're in the current directory
203 if (*path
!= '/' && strncmp(path
, "./", 2) != 0 &&
204 strncmp(path
, "../", 3) != 0) {
205 snprintf(absolute_path
, PATH_MAX
, "./%s", path
);
206 /* Else, we just copy the path */
208 strncpy(absolute_path
, path
, PATH_MAX
);
211 /* Resolve partially our path */
212 absolute_path
= utils_partial_realpath(absolute_path
,
213 absolute_path
, PATH_MAX
);
215 /* As long as we find '/./' in the working_path string */
216 while ((next
= strstr(absolute_path
, "/./"))) {
218 /* We prepare the start_path not containing it */
219 start_path
= strndup(absolute_path
, next
- absolute_path
);
221 /* And we concatenate it with the part after this string */
222 snprintf(absolute_path
, PATH_MAX
, "%s%s", start_path
, next
+ 2);
227 /* As long as we find '/../' in the working_path string */
228 while ((next
= strstr(absolute_path
, "/../"))) {
229 /* We find the last level of directory */
230 previous
= absolute_path
;
231 while ((slash
= strpbrk(previous
, "/")) && slash
!= next
) {
232 previous
= slash
+ 1;
235 /* Then we prepare the start_path not containing it */
236 start_path
= strndup(absolute_path
, previous
- absolute_path
);
238 /* And we concatenate it with the part after the '/../' */
239 snprintf(absolute_path
, PATH_MAX
, "%s%s", start_path
, next
+ 4);
241 /* We can free the memory used for the start path*/
244 /* Then we verify for symlinks using partial_realpath */
245 absolute_path
= utils_partial_realpath(absolute_path
,
246 absolute_path
, PATH_MAX
);
249 /* Identify the last token */
250 last_token
= strrchr(absolute_path
, '/');
252 /* Verify that this token is not a relative path */
253 is_dotdot
= (strcmp(last_token
, "/..") == 0);
254 is_dot
= (strcmp(last_token
, "/.") == 0);
256 /* If it is, take action */
257 if (is_dot
|| is_dotdot
) {
258 /* For both, remove this token */
261 /* If it was a reference to parent directory, go back one more time */
263 last_token
= strrchr(absolute_path
, '/');
265 /* If there was only one level left, we keep the first '/' */
266 if (last_token
== absolute_path
) {
274 return absolute_path
;
282 * Create a pipe in dst.
285 int utils_create_pipe(int *dst
)
295 PERROR("create pipe");
302 * Create pipe and set CLOEXEC flag to both fd.
304 * Make sure the pipe opened by this function are closed at some point. Use
305 * utils_close_pipe().
308 int utils_create_pipe_cloexec(int *dst
)
316 ret
= utils_create_pipe(dst
);
321 for (i
= 0; i
< 2; i
++) {
322 ret
= fcntl(dst
[i
], F_SETFD
, FD_CLOEXEC
);
324 PERROR("fcntl pipe cloexec");
334 * Create pipe and set fd flags to FD_CLOEXEC and O_NONBLOCK.
336 * Make sure the pipe opened by this function are closed at some point. Use
337 * utils_close_pipe(). Using pipe() and fcntl rather than pipe2() to
338 * support OSes other than Linux 2.6.23+.
341 int utils_create_pipe_cloexec_nonblock(int *dst
)
349 ret
= utils_create_pipe(dst
);
354 for (i
= 0; i
< 2; i
++) {
355 ret
= fcntl(dst
[i
], F_SETFD
, FD_CLOEXEC
);
357 PERROR("fcntl pipe cloexec");
361 * Note: we override any flag that could have been
362 * previously set on the fd.
364 ret
= fcntl(dst
[i
], F_SETFL
, O_NONBLOCK
);
366 PERROR("fcntl pipe nonblock");
376 * Close both read and write side of the pipe.
379 void utils_close_pipe(int *src
)
387 for (i
= 0; i
< 2; i
++) {
395 PERROR("close pipe");
401 * Create a new string using two strings range.
404 char *utils_strdupdelim(const char *begin
, const char *end
)
408 str
= zmalloc(end
- begin
+ 1);
410 PERROR("zmalloc strdupdelim");
414 memcpy(str
, begin
, end
- begin
);
415 str
[end
- begin
] = '\0';
422 * Set CLOEXEC flag to the give file descriptor.
425 int utils_set_fd_cloexec(int fd
)
434 ret
= fcntl(fd
, F_SETFD
, FD_CLOEXEC
);
436 PERROR("fcntl cloexec");
445 * Create pid file to the given path and filename.
448 int utils_create_pid_file(pid_t pid
, const char *filepath
)
455 fp
= fopen(filepath
, "w");
457 PERROR("open pid file %s", filepath
);
462 ret
= fprintf(fp
, "%d\n", pid
);
464 PERROR("fprintf pid file");
468 DBG("Pid %d written in file %s", pid
, filepath
);
474 * Create lock file to the given path and filename.
475 * Returns the associated file descriptor, -1 on error.
478 int utils_create_lock_file(const char *filepath
)
485 fd
= open(filepath
, O_CREAT
,
486 O_WRONLY
| S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
488 PERROR("open lock file %s", filepath
);
494 * Attempt to lock the file. If this fails, there is
495 * already a process using the same lock file running
496 * and we should exit.
498 ret
= flock(fd
, LOCK_EX
| LOCK_NB
);
500 WARN("Could not get lock file %s, another instance is running.",
512 * Recursively create directory using the given path and mode.
514 * On success, return 0 else a negative error code.
517 int utils_mkdir_recursive(const char *path
, mode_t mode
)
519 char *p
, tmp
[PATH_MAX
];
525 ret
= snprintf(tmp
, sizeof(tmp
), "%s", path
);
527 PERROR("snprintf mkdir");
532 if (tmp
[len
- 1] == '/') {
536 for (p
= tmp
+ 1; *p
; p
++) {
539 if (tmp
[strlen(tmp
) - 1] == '.' &&
540 tmp
[strlen(tmp
) - 2] == '.' &&
541 tmp
[strlen(tmp
) - 3] == '/') {
542 ERR("Using '/../' is not permitted in the trace path (%s)",
547 ret
= mkdir(tmp
, mode
);
549 if (errno
!= EEXIST
) {
550 PERROR("mkdir recursive");
559 ret
= mkdir(tmp
, mode
);
561 if (errno
!= EEXIST
) {
562 PERROR("mkdir recursive last piece");
574 * Create the stream tracefile on disk.
576 * Return 0 on success or else a negative value.
579 int utils_create_stream_file(const char *path_name
, char *file_name
, uint64_t size
,
580 uint64_t count
, int uid
, int gid
, char *suffix
)
582 int ret
, out_fd
, flags
, mode
;
583 char full_path
[PATH_MAX
], *path_name_suffix
= NULL
, *path
;
589 ret
= snprintf(full_path
, sizeof(full_path
), "%s/%s",
590 path_name
, file_name
);
592 PERROR("snprintf create output file");
596 /* Setup extra string if suffix or/and a count is needed. */
597 if (size
> 0 && suffix
) {
598 ret
= asprintf(&extra
, "_%" PRIu64
"%s", count
, suffix
);
599 } else if (size
> 0) {
600 ret
= asprintf(&extra
, "_%" PRIu64
, count
);
602 ret
= asprintf(&extra
, "%s", suffix
);
605 PERROR("Allocating extra string to name");
610 * If we split the trace in multiple files, we have to add the count at the
611 * end of the tracefile name
614 ret
= asprintf(&path_name_suffix
, "%s%s", full_path
, extra
);
616 PERROR("Allocating path name with extra string");
617 goto error_free_suffix
;
619 path
= path_name_suffix
;
624 flags
= O_WRONLY
| O_CREAT
| O_TRUNC
;
625 /* Open with 660 mode */
626 mode
= S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
;
628 if (uid
< 0 || gid
< 0) {
629 out_fd
= open(path
, flags
, mode
);
631 out_fd
= run_as_open(path
, flags
, mode
, uid
, gid
);
634 PERROR("open stream path %s", path
);
640 free(path_name_suffix
);
648 * Change the output tracefile according to the given size and count The
649 * new_count pointer is set during this operation.
651 * From the consumer, the stream lock MUST be held before calling this function
652 * because we are modifying the stream status.
654 * Return 0 on success or else a negative value.
657 int utils_rotate_stream_file(char *path_name
, char *file_name
, uint64_t size
,
658 uint64_t count
, int uid
, int gid
, int out_fd
, uint64_t *new_count
,
668 PERROR("Closing tracefile");
673 *new_count
= (*new_count
+ 1) % count
;
678 ret
= utils_create_stream_file(path_name
, file_name
, size
, *new_count
,
694 * Parse a string that represents a size in human readable format. It
695 * supports decimal integers suffixed by 'k', 'K', 'M' or 'G'.
697 * The suffix multiply the integer by:
702 * @param str The string to parse.
703 * @param size Pointer to a uint64_t that will be filled with the
706 * @return 0 on success, -1 on failure.
709 int utils_parse_size_suffix(const char * const str
, uint64_t * const size
)
718 DBG("utils_parse_size_suffix: received a NULL string.");
723 /* strtoull will accept a negative number, but we don't want to. */
724 if (strchr(str
, '-') != NULL
) {
725 DBG("utils_parse_size_suffix: invalid size string, should not contain '-'.");
730 /* str_end will point to the \0 */
731 str_end
= str
+ strlen(str
);
733 base_size
= strtoull(str
, &num_end
, 0);
735 PERROR("utils_parse_size_suffix strtoull");
740 if (num_end
== str
) {
741 /* strtoull parsed nothing, not good. */
742 DBG("utils_parse_size_suffix: strtoull had nothing good to parse.");
747 /* Check if a prefix is present. */
765 DBG("utils_parse_size_suffix: invalid suffix.");
770 /* Check for garbage after the valid input. */
771 if (num_end
!= str_end
) {
772 DBG("utils_parse_size_suffix: Garbage after size string.");
777 *size
= base_size
<< shift
;
779 /* Check for overflow */
780 if ((*size
>> shift
) != base_size
) {
781 DBG("utils_parse_size_suffix: oops, overflow detected.");
792 * fls: returns the position of the most significant bit.
793 * Returns 0 if no bit is set, else returns the position of the most
794 * significant bit (from 1 to 32 on 32-bit, from 1 to 64 on 64-bit).
796 #if defined(__i386) || defined(__x86_64)
797 static inline unsigned int fls_u32(uint32_t x
)
805 : "=r" (r
) : "rm" (x
));
812 static __attribute__((unused
)) unsigned int fls_u32(uint32_t x
)
819 if (!(x
& 0xFFFF0000U
)) {
823 if (!(x
& 0xFF000000U
)) {
827 if (!(x
& 0xF0000000U
)) {
831 if (!(x
& 0xC0000000U
)) {
835 if (!(x
& 0x80000000U
)) {
844 * Return the minimum order for which x <= (1UL << order).
845 * Return -1 if x is 0.
848 int utils_get_count_order_u32(uint32_t x
)
854 return fls_u32(x
- 1);
858 * Obtain the value of LTTNG_HOME environment variable, if exists.
859 * Otherwise returns the value of HOME.
862 char *utils_get_home_dir(void)
867 val
= getenv(DEFAULT_LTTNG_HOME_ENV_VAR
);
871 val
= getenv(DEFAULT_LTTNG_FALLBACK_HOME_ENV_VAR
);
876 /* Fallback on the password file entry. */
877 pwd
= getpwuid(getuid());
883 DBG3("Home directory is '%s'", val
);
890 * Get user's home directory. Dynamically allocated, must be freed
894 char *utils_get_user_home_dir(uid_t uid
)
897 struct passwd
*result
;
898 char *home_dir
= NULL
;
903 buflen
= sysconf(_SC_GETPW_R_SIZE_MAX
);
908 buf
= zmalloc(buflen
);
913 ret
= getpwuid_r(uid
, &pwd
, buf
, buflen
, &result
);
914 if (ret
|| !result
) {
923 home_dir
= strdup(pwd
.pw_dir
);
930 * Obtain the value of LTTNG_KMOD_PROBES environment variable, if exists.
931 * Otherwise returns NULL.
934 char *utils_get_kmod_probes_list(void)
936 return getenv(DEFAULT_LTTNG_KMOD_PROBES
);
940 * Obtain the value of LTTNG_EXTRA_KMOD_PROBES environment variable, if
941 * exists. Otherwise returns NULL.
944 char *utils_get_extra_kmod_probes_list(void)
946 return getenv(DEFAULT_LTTNG_EXTRA_KMOD_PROBES
);
950 * With the given format, fill dst with the time of len maximum siz.
952 * Return amount of bytes set in the buffer or else 0 on error.
955 size_t utils_get_current_time_str(const char *format
, char *dst
, size_t len
)
964 /* Get date and time for session path */
966 timeinfo
= localtime(&rawtime
);
967 ret
= strftime(dst
, len
, format
, timeinfo
);
969 ERR("Unable to strftime with format %s at dst %p of len %zu", format
,
977 * Return the group ID matching name, else 0 if it cannot be found.
980 gid_t
utils_get_group_id(const char *name
)
984 grp
= getgrnam(name
);
986 static volatile int warn_once
;
989 WARN("No tracing group detected");
998 * Return a newly allocated option string. This string is to be used as the
999 * optstring argument of getopt_long(), see GETOPT(3). opt_count is the number
1000 * of elements in the long_options array. Returns NULL if the string's
1004 char *utils_generate_optstring(const struct option
*long_options
,
1008 size_t string_len
= opt_count
, str_pos
= 0;
1012 * Compute the necessary string length. One letter per option, two when an
1013 * argument is necessary, and a trailing NULL.
1015 for (i
= 0; i
< opt_count
; i
++) {
1016 string_len
+= long_options
[i
].has_arg
? 1 : 0;
1019 optstring
= zmalloc(string_len
);
1024 for (i
= 0; i
< opt_count
; i
++) {
1025 if (!long_options
[i
].name
) {
1026 /* Got to the trailing NULL element */
1030 optstring
[str_pos
++] = (char)long_options
[i
].val
;
1031 if (long_options
[i
].has_arg
) {
1032 optstring
[str_pos
++] = ':';