[lttng-tools.git] / src / common / utils.h

/*
 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, version 2 only, as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _COMMON_UTILS_H
#define _COMMON_UTILS_H

#include <sys/types.h>
#include <unistd.h>
#include <stdint.h>
#include <getopt.h>
#include <stdbool.h>
#include <sys/types.h>

#define KIBI_LOG2 10
#define MEBI_LOG2 20
#define GIBI_LOG2 30

char *utils_partial_realpath(const char *path, char *resolved_path,
		size_t size);
char *utils_expand_path(const char *path);
int utils_create_pipe(int *dst);
int utils_create_pipe_cloexec(int *dst);
int utils_create_pipe_cloexec_nonblock(int *dst);
void utils_close_pipe(int *src);
char *utils_strdupdelim(const char *begin, const char *end);
int utils_set_fd_cloexec(int fd);
int utils_create_pid_file(pid_t pid, const char *filepath);
int utils_mkdir(const char *path, mode_t mode, int uid, int gid);
int utils_mkdir_recursive(const char *path, mode_t mode, int uid, int gid);
int utils_create_stream_file(const char *path_name, char *file_name, uint64_t size,
		uint64_t count, int uid, int gid, char *suffix);
int utils_unlink_stream_file(const char *path_name, char *file_name, uint64_t size,
		uint64_t count, int uid, int gid, char *suffix);
int utils_rotate_stream_file(char *path_name, char *file_name, uint64_t size,
		uint64_t count, int uid, int gid, int out_fd, uint64_t *new_count,
		int *stream_fd);
int utils_parse_size_suffix(char const * const str, uint64_t * const size);
int utils_get_count_order_u32(uint32_t x);
int utils_get_count_order_u64(uint64_t x);
char *utils_get_home_dir(void);
char *utils_get_user_home_dir(uid_t uid);
size_t utils_get_current_time_str(const char *format, char *dst, size_t len);
int utils_get_group_id(const char *name, bool warn, gid_t *gid);
char *utils_generate_optstring(const struct option *long_options,
		size_t opt_count);
int utils_create_lock_file(const char *filepath);
int utils_recursive_rmdir(const char *path);
int utils_truncate_stream_file(int fd, off_t length);
int utils_show_help(int section, const char *page_name, const char *help_msg);

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