X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Futils.c;h=eebed2adb71934800c5f0f49b42c6277817fa8e1;hp=d9bacad0e7a7f32dd660e2d6db28b754b7545066;hb=f895927f329180ca1e6f4426e9d3c6250ae698ba;hpb=ab5be9fa2eb5ba9600a82cd18fd3cfcbac69169a

diff --git a/src/common/utils.c b/src/common/utils.c
index d9bacad0e..eebed2adb 100644
--- a/src/common/utils.c
+++ b/src/common/utils.c
@@ -7,8 +7,8 @@
  *
  */
 
+#include "common/macros.h"
 #define _LGPL_SOURCE
-#include <assert.h>
 #include <ctype.h>
 #include <fcntl.h>
 #include <limits.h>
@@ -50,22 +50,24 @@
 #error MAX_NAME_LEN_SCANF_IS_A_BROKEN_API must be updated to match (PROC_MEMINFO_FIELD_MAX_NAME_LEN - 1)
 #endif
 
+#define FALLBACK_USER_BUFLEN 16384
+#define FALLBACK_GROUP_BUFLEN 16384
+
 /*
  * Return a partial realpath(3) of the path even if the full path does not
  * exist. For instance, with /tmp/test1/test2/test3, if test2/ does not exist
  * but the /tmp/test1 does, the real path for /tmp/test1 is concatened with
  * /test2/test3 then returned. In normal time, realpath(3) fails if the end
  * point directory does not exist.
- * In case resolved_path is NULL, the string returned was allocated in the
- * function and thus need to be freed by the caller. The size argument allows
- * to specify the size of the resolved_path argument if given, or the size to
- * allocate.
+ *
+ * Return a newly-allocated string.
  */
-LTTNG_HIDDEN
-char *utils_partial_realpath(const char *path, char *resolved_path, size_t size)
+static
+char *utils_partial_realpath(const char *path)
 {
 	char *cut_path = NULL, *try_path = NULL, *try_path_prev = NULL;
 	const char *next, *prev, *end;
+	char *resolved_path = NULL;
 
 	/* Safety net */
 	if (path == NULL) {
@@ -146,13 +148,11 @@ char *utils_partial_realpath(const char *path, char *resolved_path, size_t size)
 		cut_path = NULL;
 	}
 
-	/* Allocate memory for the resolved path if necessary */
+	/* Allocate memory for the resolved path. */
+	resolved_path = zmalloc(LTTNG_PATH_MAX);
 	if (resolved_path == NULL) {
-		resolved_path = zmalloc(size);
-		if (resolved_path == NULL) {
-			PERROR("zmalloc resolved path");
-			goto error;
-		}
+		PERROR("zmalloc resolved path");
+		goto error;
 	}
 
 	/*
@@ -176,7 +176,8 @@ char *utils_partial_realpath(const char *path, char *resolved_path, size_t size)
 		}
 
 		/* Concatenate the strings */
-		snprintf(resolved_path, size, "%s%s", try_path_prev, cut_path);
+		snprintf(resolved_path, LTTNG_PATH_MAX, "%s%s",
+				try_path_prev, cut_path);
 
 		/* Free the allocated memory */
 		free(cut_path);
@@ -188,7 +189,7 @@ char *utils_partial_realpath(const char *path, char *resolved_path, size_t size)
 	 * return it as is
 	 */
 	} else {
-		strncpy(resolved_path, path, size);
+		strncpy(resolved_path, path, LTTNG_PATH_MAX);
 	}
 
 	/* Then we return the 'partially' resolved path */
@@ -290,7 +291,7 @@ int expand_double_slashes_dot_and_dotdot(char *path)
 		 * Copy the current token which is neither a '.' nor a '..'.
 		 */
 		path[expanded_path_len++] = '/';
-		memcpy(&path[expanded_path_len], curr_char, curr_token_len);
+		memmove(&path[expanded_path_len], curr_char, curr_token_len);
 		expanded_path_len += curr_token_len;
 	}
 
@@ -367,11 +368,13 @@ char *_utils_expand_path(const char *path, bool keep_symlink)
 
 	if (keep_symlink) {
 		/* Resolve partially our path */
-		absolute_path = utils_partial_realpath(absolute_path,
-				absolute_path, LTTNG_PATH_MAX);
-		if (!absolute_path) {
+		char *new_absolute_path = utils_partial_realpath(absolute_path);
+		if (!new_absolute_path) {
 			goto error;
 		}
+
+		free(absolute_path);
+		absolute_path = new_absolute_path;
 	}
 
 	ret = expand_double_slashes_dot_and_dotdot(absolute_path);
@@ -410,13 +413,11 @@ error:
 	free(absolute_path);
 	return NULL;
 }
-LTTNG_HIDDEN
 char *utils_expand_path(const char *path)
 {
 	return _utils_expand_path(path, true);
 }
 
-LTTNG_HIDDEN
 char *utils_expand_path_keep_symlink(const char *path)
 {
 	return _utils_expand_path(path, false);
@@ -424,7 +425,6 @@ char *utils_expand_path_keep_symlink(const char *path)
 /*
  * Create a pipe in dst.
  */
-LTTNG_HIDDEN
 int utils_create_pipe(int *dst)
 {
 	int ret;
@@ -447,7 +447,6 @@ int utils_create_pipe(int *dst)
  * Make sure the pipe opened by this function are closed at some point. Use
  * utils_close_pipe().
  */
-LTTNG_HIDDEN
 int utils_create_pipe_cloexec(int *dst)
 {
 	int ret, i;
@@ -480,7 +479,6 @@ error:
  * utils_close_pipe(). Using pipe() and fcntl rather than pipe2() to
  * support OSes other than Linux 2.6.23+.
  */
-LTTNG_HIDDEN
 int utils_create_pipe_cloexec_nonblock(int *dst)
 {
 	int ret, i;
@@ -518,7 +516,6 @@ error:
 /*
  * Close both read and write side of the pipe.
  */
-LTTNG_HIDDEN
 void utils_close_pipe(int *src)
 {
 	int i, ret;
@@ -537,13 +534,13 @@ void utils_close_pipe(int *src)
 		if (ret) {
 			PERROR("close pipe");
 		}
+		src[i] = -1;
 	}
 }
 
 /*
  * Create a new string using two strings range.
  */
-LTTNG_HIDDEN
 char *utils_strdupdelim(const char *begin, const char *end)
 {
 	char *str;
@@ -564,7 +561,6 @@ error:
 /*
  * Set CLOEXEC flag to the give file descriptor.
  */
-LTTNG_HIDDEN
 int utils_set_fd_cloexec(int fd)
 {
 	int ret;
@@ -587,13 +583,12 @@ end:
 /*
  * Create pid file to the given path and filename.
  */
-LTTNG_HIDDEN
 int utils_create_pid_file(pid_t pid, const char *filepath)
 {
 	int ret;
 	FILE *fp;
 
-	assert(filepath);
+	LTTNG_ASSERT(filepath);
 
 	fp = fopen(filepath, "w");
 	if (fp == NULL) {
@@ -621,14 +616,13 @@ error:
  * Create lock file to the given path and filename.
  * Returns the associated file descriptor, -1 on error.
  */
-LTTNG_HIDDEN
 int utils_create_lock_file(const char *filepath)
 {
 	int ret;
 	int fd;
 	struct flock lock;
 
-	assert(filepath);
+	LTTNG_ASSERT(filepath);
 
 	memset(&lock, 0, sizeof(lock));
 	fd = open(filepath, O_CREAT | O_WRONLY, S_IRUSR | S_IWUSR |
@@ -668,14 +662,13 @@ error:
  *
  * On success, return 0 else a negative error code.
  */
-LTTNG_HIDDEN
 int utils_mkdir(const char *path, mode_t mode, int uid, int gid)
 {
 	int ret;
 	struct lttng_directory_handle *handle;
 	const struct lttng_credentials creds = {
-		.uid = (uid_t) uid,
-		.gid = (gid_t) gid,
+		.uid = LTTNG_OPTIONAL_INIT_VALUE(uid),
+		.gid = LTTNG_OPTIONAL_INIT_VALUE(gid),
 	};
 
 	handle = lttng_directory_handle_create(NULL);
@@ -697,14 +690,13 @@ end:
  *
  * On success, return 0 else a negative error code.
  */
-LTTNG_HIDDEN
 int utils_mkdir_recursive(const char *path, mode_t mode, int uid, int gid)
 {
 	int ret;
 	struct lttng_directory_handle *handle;
 	const struct lttng_credentials creds = {
-		.uid = (uid_t) uid,
-		.gid = (gid_t) gid,
+		.uid = LTTNG_OPTIONAL_INIT_VALUE(uid),
+		.gid = LTTNG_OPTIONAL_INIT_VALUE(gid),
 	};
 
 	handle = lttng_directory_handle_create(NULL);
@@ -725,13 +717,12 @@ end:
  *
  * Return 0 on success or else a negative value.
  */
-LTTNG_HIDDEN
 int utils_stream_file_path(const char *path_name, const char *file_name,
 		uint64_t size, uint64_t count, const char *suffix,
 		char *out_stream_path, size_t stream_path_len)
 {
 	int ret;
-        char count_str[MAX_INT_DEC_LEN(count) + 1] = {};
+	char count_str[MAX_INT_DEC_LEN(count) + 1] = {};
 	const char *path_separator;
 
 	if (path_name && (path_name[0] == '\0' ||
@@ -746,10 +737,10 @@ int utils_stream_file_path(const char *path_name, const char *file_name,
 	if (size > 0) {
 		ret = snprintf(count_str, sizeof(count_str), "_%" PRIu64,
 				count);
-		assert(ret > 0 && ret < sizeof(count_str));
+		LTTNG_ASSERT(ret > 0 && ret < sizeof(count_str));
 	}
 
-        ret = snprintf(out_stream_path, stream_path_len, "%s%s%s%s%s",
+	ret = snprintf(out_stream_path, stream_path_len, "%s%s%s%s%s",
 			path_name, path_separator, file_name, count_str,
 			suffix);
 	if (ret < 0 || ret >= stream_path_len) {
@@ -776,7 +767,6 @@ int utils_stream_file_path(const char *path_name, const char *file_name,
  *
  * @return 0 on success, -1 on failure.
  */
-LTTNG_HIDDEN
 int utils_parse_size_suffix(const char * const str, uint64_t * const size)
 {
 	int ret;
@@ -883,7 +873,6 @@ end:
  *
  * @return 0 on success, -1 on failure.
  */
-LTTNG_HIDDEN
 int utils_parse_time_suffix(char const * const str, uint64_t * const time_us)
 {
 	int ret;
@@ -1096,7 +1085,6 @@ static __attribute__((unused)) unsigned int fls_u32(uint32_t x)
  * Return the minimum order for which x <= (1UL << order).
  * Return -1 if x is 0.
  */
-LTTNG_HIDDEN
 int utils_get_count_order_u32(uint32_t x)
 {
 	if (!x) {
@@ -1110,7 +1098,6 @@ int utils_get_count_order_u32(uint32_t x)
  * Return the minimum order for which x <= (1UL << order).
  * Return -1 if x is 0.
  */
-LTTNG_HIDDEN
 int utils_get_count_order_u64(uint64_t x)
 {
 	if (!x) {
@@ -1124,7 +1111,6 @@ int utils_get_count_order_u64(uint64_t x)
  * Obtain the value of LTTNG_HOME environment variable, if exists.
  * Otherwise returns the value of HOME.
  */
-LTTNG_HIDDEN
 const char *utils_get_home_dir(void)
 {
 	char *val = NULL;
@@ -1156,7 +1142,6 @@ end:
  * Get user's home directory. Dynamically allocated, must be freed
  * by the caller.
  */
-LTTNG_HIDDEN
 char *utils_get_user_home_dir(uid_t uid)
 {
 	struct passwd pwd;
@@ -1197,15 +1182,14 @@ end:
  *
  * Return amount of bytes set in the buffer or else 0 on error.
  */
-LTTNG_HIDDEN
 size_t utils_get_current_time_str(const char *format, char *dst, size_t len)
 {
 	size_t ret;
 	time_t rawtime;
 	struct tm *timeinfo;
 
-	assert(format);
-	assert(dst);
+	LTTNG_ASSERT(format);
+	LTTNG_ASSERT(dst);
 
 	/* Get date and time for session path */
 	time(&rawtime);
@@ -1223,7 +1207,6 @@ size_t utils_get_current_time_str(const char *format, char *dst, size_t len)
  * Return 0 on success and set *gid to the group_ID matching the passed name.
  * Else -1 if it cannot be found or an error occurred.
  */
-LTTNG_HIDDEN
 int utils_get_group_id(const char *name, bool warn, gid_t *gid)
 {
 	static volatile int warn_once;
@@ -1269,8 +1252,14 @@ int utils_get_group_id(const char *name, bool warn, gid_t *gid)
 		}
 	}
 	if (ret) {
-		PERROR("Failed to get group file entry for group name \"%s\"",
-				name);
+		if (ret == ESRCH) {
+			DBG("Could not find group file entry for group name '%s'",
+					name);
+		} else {
+			PERROR("Failed to get group file entry for group name '%s'",
+					name);
+		}
+
 		ret = -1;
 		goto error;
 	}
@@ -1299,7 +1288,6 @@ error:
  * of elements in the long_options array. Returns NULL if the string's
  * allocation fails.
  */
-LTTNG_HIDDEN
 char *utils_generate_optstring(const struct option *long_options,
 		size_t opt_count)
 {
@@ -1342,7 +1330,6 @@ end:
  * Try to remove a hierarchy of empty directories, recursively. Don't unlink
  * any file. Try to rmdir any empty directory within the hierarchy.
  */
-LTTNG_HIDDEN
 int utils_recursive_rmdir(const char *path)
 {
 	int ret;
@@ -1359,7 +1346,6 @@ end:
 	return ret;
 }
 
-LTTNG_HIDDEN
 int utils_truncate_stream_file(int fd, off_t length)
 {
 	int ret;
@@ -1391,7 +1377,6 @@ static const char *get_man_bin_path(void)
 	return DEFAULT_MAN_BIN_PATH;
 }
 
-LTTNG_HIDDEN
 int utils_show_help(int section, const char *page_name,
 		const char *help_msg)
 {
@@ -1406,7 +1391,7 @@ int utils_show_help(int section, const char *page_name,
 
 	/* Section integer -> section string */
 	ret = sprintf(section_string, "%d", section);
-	assert(ret > 0 && ret < 8);
+	LTTNG_ASSERT(ret > 0 && ret < 8);
 
 	/*
 	 * Execute man pager.
@@ -1480,7 +1465,6 @@ fopen_error:
  * the information in `/proc/meminfo`. The number returned by this function is
  * a best guess.
  */
-LTTNG_HIDDEN
 int utils_get_memory_available(size_t *value)
 {
 	return read_proc_meminfo_field(PROC_MEMINFO_MEMAVAILABLE_LINE, value);
@@ -1490,18 +1474,16 @@ int utils_get_memory_available(size_t *value)
  * Returns the total size of the memory on the system in bytes based on the
  * the information in `/proc/meminfo`.
  */
-LTTNG_HIDDEN
 int utils_get_memory_total(size_t *value)
 {
 	return read_proc_meminfo_field(PROC_MEMINFO_MEMTOTAL_LINE, value);
 }
 
-LTTNG_HIDDEN
 int utils_change_working_directory(const char *path)
 {
 	int ret;
 
-	assert(path);
+	LTTNG_ASSERT(path);
 
 	DBG("Changing working directory to \"%s\"", path);
 	ret = chdir(path);
@@ -1527,3 +1509,167 @@ int utils_change_working_directory(const char *path)
 end:
 	return ret;
 }
+
+enum lttng_error_code utils_user_id_from_name(const char *user_name, uid_t *uid)
+{
+	struct passwd p, *pres;
+	int ret;
+	enum lttng_error_code ret_val = LTTNG_OK;
+	char *buf = NULL;
+	ssize_t buflen;
+
+	buflen = sysconf(_SC_GETPW_R_SIZE_MAX);
+	if (buflen < 0) {
+		buflen = FALLBACK_USER_BUFLEN;
+	}
+
+	buf = zmalloc(buflen);
+	if (!buf) {
+		ret_val = LTTNG_ERR_NOMEM;
+		goto end;
+	}
+
+	for (;;) {
+		ret = getpwnam_r(user_name, &p, buf, buflen, &pres);
+		switch (ret) {
+		case EINTR:
+			continue;
+		case ERANGE:
+			buflen *= 2;
+			free(buf);
+			buf = zmalloc(buflen);
+			if (!buf) {
+				ret_val = LTTNG_ERR_NOMEM;
+				goto end;
+			}
+			continue;
+		default:
+			goto end_loop;
+		}
+	}
+end_loop:
+
+	switch (ret) {
+	case 0:
+		if (pres == NULL) {
+			ret_val = LTTNG_ERR_USER_NOT_FOUND;
+		} else {
+			*uid = p.pw_uid;
+			DBG("Lookup of tracker UID/VUID: name '%s' maps to uid %" PRId64,
+					user_name, (int64_t) *uid);
+			ret_val = LTTNG_OK;
+		}
+		break;
+	case ENOENT:
+	case ESRCH:
+	case EBADF:
+	case EPERM:
+		ret_val = LTTNG_ERR_USER_NOT_FOUND;
+		break;
+	default:
+		ret_val = LTTNG_ERR_NOMEM;
+	}
+end:
+	free(buf);
+	return ret_val;
+}
+
+enum lttng_error_code utils_group_id_from_name(
+		const char *group_name, gid_t *gid)
+{
+	struct group g, *gres;
+	int ret;
+	enum lttng_error_code ret_val = LTTNG_OK;
+	char *buf = NULL;
+	ssize_t buflen;
+
+	buflen = sysconf(_SC_GETGR_R_SIZE_MAX);
+	if (buflen < 0) {
+		buflen = FALLBACK_GROUP_BUFLEN;
+	}
+
+	buf = zmalloc(buflen);
+	if (!buf) {
+		ret_val = LTTNG_ERR_NOMEM;
+		goto end;
+	}
+
+	for (;;) {
+		ret = getgrnam_r(group_name, &g, buf, buflen, &gres);
+		switch (ret) {
+		case EINTR:
+			continue;
+		case ERANGE:
+			buflen *= 2;
+			free(buf);
+			buf = zmalloc(buflen);
+			if (!buf) {
+				ret_val = LTTNG_ERR_NOMEM;
+				goto end;
+			}
+			continue;
+		default:
+			goto end_loop;
+		}
+	}
+end_loop:
+
+	switch (ret) {
+	case 0:
+		if (gres == NULL) {
+			ret_val = LTTNG_ERR_GROUP_NOT_FOUND;
+		} else {
+			*gid = g.gr_gid;
+			DBG("Lookup of tracker GID/GUID: name '%s' maps to gid %" PRId64,
+					group_name, (int64_t) *gid);
+			ret_val = LTTNG_OK;
+		}
+		break;
+	case ENOENT:
+	case ESRCH:
+	case EBADF:
+	case EPERM:
+		ret_val = LTTNG_ERR_GROUP_NOT_FOUND;
+		break;
+	default:
+		ret_val = LTTNG_ERR_NOMEM;
+	}
+end:
+	free(buf);
+	return ret_val;
+}
+
+int utils_parse_unsigned_long_long(const char *str,
+		unsigned long long *value)
+{
+	int ret;
+	char *endptr;
+
+	LTTNG_ASSERT(str);
+	LTTNG_ASSERT(value);
+
+	errno = 0;
+	*value = strtoull(str, &endptr, 10);
+
+	/* Conversion failed. Out of range? */
+	if (errno != 0) {
+		/* Don't print an error; allow the caller to log a better error. */
+		DBG("Failed to parse string as unsigned long long number: string = '%s', errno = %d",
+				str, errno);
+		ret = -1;
+		goto end;
+	}
+
+	/* Not the end of the string or empty string. */
+	if (*endptr || endptr == str) {
+		DBG("Failed to parse string as unsigned long long number: string = '%s'",
+				str);
+		ret = -1;
+		goto end;
+	}
+
+	ret = 0;
+
+end:
+	return ret;
+}