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
  27 #define KIBI_LOG2 10
  28 #define MEBI_LOG2 20
  29 #define GIBI_LOG2 30
  30
  31 char *utils_partial_realpath(const char *path, char *resolved_path,
  32                 size_t size);
  33 char *utils_expand_path(const char *path);
  34 int utils_create_pipe(int *dst);
  35 int utils_create_pipe_cloexec(int *dst);
  36 int utils_create_pipe_cloexec_nonblock(int *dst);
  37 void utils_close_pipe(int *src);
  38 char *utils_strdupdelim(const char *begin, const char *end);
  39 int utils_set_fd_cloexec(int fd);
  40 int utils_create_pid_file(pid_t pid, const char *filepath);
  41 int utils_mkdir(const char *path, mode_t mode, int uid, int gid);
  42 int utils_mkdir_recursive(const char *path, mode_t mode, int uid, int gid);
  43 int utils_stream_file_name(char *path, const char *path_name,
  44                 const char *file_name, uint64_t size, uint64_t count,
  45                 const char *suffix);
  46 int utils_create_stream_file(const char *path_name, char *file_name, uint64_t size,
  47                 uint64_t count, int uid, int gid, char *suffix);
  48 int utils_unlink_stream_file(const char *path_name, char *file_name, uint64_t size,
  49                 uint64_t count, int uid, int gid, char *suffix);
  50 void utils_stream_file_rotation_get_new_count(uint64_t count,
  51                 uint64_t *new_count, bool *should_unlink);
  52 int utils_rotate_stream_file(char *path_name, char *file_name, uint64_t size,
  53                 uint64_t count, int uid, int gid, int out_fd, uint64_t *new_count,
  54                 int *stream_fd);
  55 int utils_parse_size_suffix(char const * const str, uint64_t * const size);
  56 int utils_get_count_order_u32(uint32_t x);
  57 int utils_get_count_order_u64(uint64_t x);
  58 char *utils_get_home_dir(void);
  59 char *utils_get_user_home_dir(uid_t uid);
  60 char *utils_get_kmod_probes_list(void);
  61 char *utils_get_extra_kmod_probes_list(void);
  62 size_t utils_get_current_time_str(const char *format, char *dst, size_t len);
  63 gid_t utils_get_group_id(const char *name);
  64 char *utils_generate_optstring(const struct option *long_options,
  65                 size_t opt_count);
  66 int utils_create_lock_file(const char *filepath);
  67 int utils_recursive_rmdir(const char *path);
  68 int utils_truncate_stream_file(int fd, off_t length);
  69 int utils_show_man_page(int section, const char *page_name);
  70 int utils_change_working_dir(const char *path);
  71
  72 #endif /* _COMMON_UTILS_H */