src/common/utils.h

   1 /*
   2  * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License, version 2 only, as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  11  * more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with
  14  * this program; if not, write to the Free Software Foundation, Inc., 51
  15  * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #ifndef _COMMON_UTILS_H
  19 #define _COMMON_UTILS_H
  20
  21 #include <sys/types.h>
  22 #include <unistd.h>
  23 #include <stdint.h>
  24 #include <getopt.h>
  25 #include <stdbool.h>
  26 #include <sys/types.h>
  27
  28 #include <common/compat/directory-handle.h>
  29
  30 #define KIBI_LOG2 10
  31 #define MEBI_LOG2 20
  32 #define GIBI_LOG2 30
  33
  34 char *utils_partial_realpath(const char *path, char *resolved_path,
  35                 size_t size);
  36 char *utils_expand_path(const char *path);
  37 char *utils_expand_path_keep_symlink(const char *path);
  38 int utils_create_pipe(int *dst);
  39 int utils_create_pipe_cloexec(int *dst);
  40 int utils_create_pipe_cloexec_nonblock(int *dst);
  41 void utils_close_pipe(int *src);
  42 char *utils_strdupdelim(const char *begin, const char *end);
  43 int utils_set_fd_cloexec(int fd);
  44 int utils_create_pid_file(pid_t pid, const char *filepath);
  45 int utils_mkdir(const char *path, mode_t mode, int uid, int gid);
  46 int utils_mkdir_recursive(const char *path, mode_t mode, int uid, int gid);
  47 int utils_create_stream_file(const char *path_name, char *file_name, uint64_t size,
  48                 uint64_t count, int uid, int gid, char *suffix);
  49 int utils_unlink_stream_file(const char *path_name, char *file_name, uint64_t size,
  50                 uint64_t count, int uid, int gid, char *suffix);
  51 int utils_stream_file_path(const char *path_name, const char *file_name,
  52                 uint64_t size, uint64_t count, const char *suffix,
  53                 char *out_stream_path, size_t stream_path_len);
  54 int utils_parse_size_suffix(char const * const str, uint64_t * const size);
  55 int utils_parse_time_suffix(char const * const str, uint64_t * const time_us);
  56 int utils_get_count_order_u32(uint32_t x);
  57 int utils_get_count_order_u64(uint64_t x);
  58 const char *utils_get_home_dir(void);
  59 char *utils_get_user_home_dir(uid_t uid);
  60 size_t utils_get_current_time_str(const char *format, char *dst, size_t len);
  61 int utils_get_group_id(const char *name, bool warn, gid_t *gid);
  62 char *utils_generate_optstring(const struct option *long_options,
  63                 size_t opt_count);
  64 int utils_create_lock_file(const char *filepath);
  65 int utils_recursive_rmdir(const char *path);
  66 int utils_truncate_stream_file(int fd, off_t length);
  67 int utils_show_help(int section, const char *page_name, const char *help_msg);
  68 int utils_get_memory_available(size_t *value);
  69 int utils_get_memory_total(size_t *value);
  70
  71 #endif /* _COMMON_UTILS_H */