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

/*
 * Copyright (C) 2018 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef FD_TRACKER_UTILS_H
#define FD_TRACKER_UTILS_H

#include <common/fd-tracker/fd-tracker.h>

struct lttng_poll_event;

/*
 * Utility implementing a close_fd callback which receives one file descriptor
 * and closes it, returning close()'s return value.
 */
int fd_tracker_util_close_fd(void *, int *fd);

/*
 * Create a pipe and track its underlying fds.
 */
int fd_tracker_util_pipe_open_cloexec(
		struct fd_tracker *tracker, const char *name, int *pipe);
int fd_tracker_util_pipe_close(struct fd_tracker *tracker, int *pipe);

/*
 * Create a poll event and track its underlying fd, if applicable.
 */
int fd_tracker_util_poll_create(struct fd_tracker *tracker,
		const char *name,
		struct lttng_poll_event *events,
		int size,
		int flags);
int fd_tracker_util_poll_clean(
		struct fd_tracker *tracker, struct lttng_poll_event *events);

#endif /* FD_TRACKER_UTILS_H */
Commit	Line	Data
df038819	1	/*
ab5be9fa	2	* Copyright (C) 2018 Jérémie Galarneau <jeremie.galarneau@efficios.com>
df038819	3	*
ab5be9fa	4	* SPDX-License-Identifier: GPL-2.0-only
df038819	5	*
df038819 JG	6	*/
	7
	8	#ifndef FD_TRACKER_UTILS_H
	9	#define FD_TRACKER_UTILS_H
	10
184597e3 JG	11	#include <common/fd-tracker/fd-tracker.h>
	12
	13	struct lttng_poll_event;
	14
df038819 JG	15	/*
	16	* Utility implementing a close_fd callback which receives one file descriptor
	17	* and closes it, returning close()'s return value.
	18	*/
	19	int fd_tracker_util_close_fd(void , int fd);
	20
c3e9c4c6 JG	21	/*
	22	* Create a pipe and track its underlying fds.
	23	*/
5c1f54d1 JG	24	int fd_tracker_util_pipe_open_cloexec(
5c1f54d1 JG	25	struct fd_tracker tracker, const char name, int *pipe);
c3e9c4c6 JG	26	int fd_tracker_util_pipe_close(struct fd_tracker tracker, int pipe);
c3e9c4c6 JG	27
184597e3 JG	28	/*
	29	* Create a poll event and track its underlying fd, if applicable.
	30	*/
5c1f54d1 JG	31	int fd_tracker_util_poll_create(struct fd_tracker *tracker,
	32	const char *name,
	33	struct lttng_poll_event *events,
	34	int size,
	35	int flags);
	36	int fd_tracker_util_poll_clean(
	37	struct fd_tracker tracker, struct lttng_poll_event events);
184597e3	38
df038819	39	#endif /* FD_TRACKER_UTILS_H */