570216d53c9709dddcfaf480f68a465bc0a8f294
[lttng-tools.git] / src / common / utils.h
1 /*
2 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 */
7
8 #ifndef _COMMON_UTILS_H
9 #define _COMMON_UTILS_H
10
11 #include <getopt.h>
12 #include <lttng/lttng-error.h>
13 #include <stdbool.h>
14 #include <stdint.h>
15 #include <sys/types.h>
16 #include <unistd.h>
17
18 #include <common/compat/directory-handle.h>
19
20 #define KIBI_LOG2 10
21 #define MEBI_LOG2 20
22 #define GIBI_LOG2 30
23
24 char *utils_partial_realpath(const char *path, char *resolved_path,
25 size_t size);
26 char *utils_expand_path(const char *path);
27 char *utils_expand_path_keep_symlink(const char *path);
28 int utils_create_pipe(int *dst);
29 int utils_create_pipe_cloexec(int *dst);
30 int utils_create_pipe_cloexec_nonblock(int *dst);
31 void utils_close_pipe(int *src);
32 char *utils_strdupdelim(const char *begin, const char *end);
33 int utils_set_fd_cloexec(int fd);
34 int utils_create_pid_file(pid_t pid, const char *filepath);
35 int utils_mkdir(const char *path, mode_t mode, int uid, int gid);
36 int utils_mkdir_recursive(const char *path, mode_t mode, int uid, int gid);
37 int utils_stream_file_path(const char *path_name, const char *file_name,
38 uint64_t size, uint64_t count, const char *suffix,
39 char *out_stream_path, size_t stream_path_len);
40 int utils_parse_size_suffix(char const * const str, uint64_t * const size);
41 int utils_parse_time_suffix(char const * const str, uint64_t * const time_us);
42 int utils_get_count_order_u32(uint32_t x);
43 int utils_get_count_order_u64(uint64_t x);
44 const char *utils_get_home_dir(void);
45 char *utils_get_user_home_dir(uid_t uid);
46 size_t utils_get_current_time_str(const char *format, char *dst, size_t len);
47 int utils_get_group_id(const char *name, bool warn, gid_t *gid);
48 char *utils_generate_optstring(const struct option *long_options,
49 size_t opt_count);
50 int utils_create_lock_file(const char *filepath);
51 int utils_recursive_rmdir(const char *path);
52 int utils_truncate_stream_file(int fd, off_t length);
53 int utils_show_help(int section, const char *page_name, const char *help_msg);
54 int utils_get_memory_available(size_t *value);
55 int utils_get_memory_total(size_t *value);
56 int utils_change_working_directory(const char *path);
57 enum lttng_error_code utils_user_id_from_name(
58 const char *user_name, uid_t *user_id);
59 enum lttng_error_code utils_group_id_from_name(
60 const char *group_name, gid_t *group_id);
61
62 /*
63 * Parse `str` as an unsigned long long value.
64 *
65 * Return 0 on success. Return -1 on failure which can be because:
66 *
67 * - `str` is zero length
68 * - `str` contains invalid
69 */
70 LTTNG_HIDDEN
71 int utils_parse_unsigned_long_long(const char *str,
72 unsigned long long *value);
73
74 #endif /* _COMMON_UTILS_H */
This page took 0.041826 seconds and 3 git commands to generate.