src/common/utils.h

   1 /*
   2  * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-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 int utils_create_pipe(int *dst);
  25 int utils_create_pipe_cloexec(int *dst);
  26 int utils_create_pipe_cloexec_nonblock(int *dst);
  27 void utils_close_pipe(int *src);
  28 char *utils_strdupdelim(const char *begin, const char *end);
  29 int utils_set_fd_cloexec(int fd);
  30 int utils_create_pid_file(pid_t pid, const char *filepath);
  31 int utils_mkdir(const char *path, mode_t mode, int uid, int gid);
  32 int utils_mkdir_recursive(const char *path, mode_t mode, int uid, int gid);
  33 int utils_stream_file_path(const char *path_name, const char *file_name,
  34                 uint64_t size, uint64_t count, const char *suffix,
  35                 char *out_stream_path, size_t stream_path_len);
  36 int utils_parse_size_suffix(char const * const str, uint64_t * const size);
  37 int utils_parse_time_suffix(char const * const str, uint64_t * const time_us);
  38 int utils_get_count_order_u32(uint32_t x);
  39 int utils_get_count_order_u64(uint64_t x);
  40 const char *utils_get_home_dir(void);
  41 char *utils_get_user_home_dir(uid_t uid);
  42
  43 size_t utils_get_current_time_str(const char *format, char *dst, size_t len)
  44         ATTR_FORMAT_STRFTIME(1);
  45
  46 int utils_get_group_id(const char *name, bool warn, gid_t *gid);
  47 char *utils_generate_optstring(const struct option *long_options,
  48                 size_t opt_count);
  49 int utils_create_lock_file(const char *filepath);
  50 int utils_recursive_rmdir(const char *path);
  51 int utils_truncate_stream_file(int fd, off_t length);
  52 int utils_show_help(int section, const char *page_name, const char *help_msg);
  53 int utils_get_memory_available(uint64_t *value);
  54 int utils_get_memory_total(uint64_t *value);
  55 int utils_change_working_directory(const char *path);
  56 enum lttng_error_code utils_user_id_from_name(
  57                 const char *user_name, uid_t *user_id);
  58 enum lttng_error_code utils_group_id_from_name(
  59                 const char *group_name, gid_t *group_id);
  60
  61 /*
  62  * Parse `str` as an unsigned long long value.
  63  *
  64  * Return 0 on success.  Return -1 on failure which can be because:
  65  *
  66  * - `str` is zero length
  67  * - `str` contains invalid
  68  */
  69 int utils_parse_unsigned_long_long(const char *str,
  70                 unsigned long long *value);
  71
  72 #endif /* _COMMON_UTILS_H */