[lttng-tools.git] / src / common / sessiond-comm / inet.hpp

/*
 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef _LTTCOMM_INET_H
#define _LTTCOMM_INET_H

#include "sessiond-comm.hpp"

#include <lttng/lttng-export.h>

#include <limits.h>
#include <sys/types.h>

/* See man tcp(7) for more detail about this value. */
#define LTTCOMM_INET_PROC_SYN_RETRIES_PATH "/proc/sys/net/ipv4/tcp_syn_retries"
#define LTTCOMM_INET_PROC_FIN_TIMEOUT_PATH "/proc/sys/net/ipv4/tcp_fin_timeout"

/*
 * The timeout value of a connect() is computed with an algorithm inside the
 * kernel using the defined TCP SYN retries so the end value in time is
 * approximative. According to tcp(7) man page, a value of 5 is roughly 180
 * seconds of timeout. With that information, we've computed a factor of 36
 * (180/5) by considering that it grows linearly. This is of course uncertain
 * but this is the best approximation we can do at runtime.
 */
#define LTTCOMM_INET_SYN_TIMEOUT_FACTOR 36

/*
 * Maximum timeout value in seconds of a TCP connection for both send/recv and
 * connect operations.
 */
LTTNG_EXPORT extern unsigned long lttcomm_inet_tcp_timeout;

/* Stub */
struct lttcomm_sock;

/* Net family callback */
extern int lttcomm_create_inet_sock(struct lttcomm_sock *sock, int type, int proto);

extern struct lttcomm_sock *lttcomm_accept_inet_sock(struct lttcomm_sock *sock);
extern int lttcomm_bind_inet_sock(struct lttcomm_sock *sock);
extern int lttcomm_close_inet_sock(struct lttcomm_sock *sock);
extern int lttcomm_connect_inet_sock(struct lttcomm_sock *sock);
extern int lttcomm_listen_inet_sock(struct lttcomm_sock *sock, int backlog);

extern ssize_t
lttcomm_recvmsg_inet_sock(struct lttcomm_sock *sock, void *buf, size_t len, int flags);
extern ssize_t
lttcomm_sendmsg_inet_sock(struct lttcomm_sock *sock, const void *buf, size_t len, int flags);

/* Initialize inet communication layer. */
extern void lttcomm_inet_init();

#endif /* _LTTCOMM_INET_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
	3	*
	4	* SPDX-License-Identifier: GPL-2.0-only
	5	*
	6	*/
	7
	8	#ifndef _LTTCOMM_INET_H
	9	#define _LTTCOMM_INET_H
	10
	11	#include "sessiond-comm.hpp"
	12
	13	#include <lttng/lttng-export.h>
	14
	15	#include <limits.h>
	16	#include <sys/types.h>
	17
	18	/* See man tcp(7) for more detail about this value. */
	19	#define LTTCOMM_INET_PROC_SYN_RETRIES_PATH "/proc/sys/net/ipv4/tcp_syn_retries"
	20	#define LTTCOMM_INET_PROC_FIN_TIMEOUT_PATH "/proc/sys/net/ipv4/tcp_fin_timeout"
	21
	22	/*
	23	* The timeout value of a connect() is computed with an algorithm inside the
	24	* kernel using the defined TCP SYN retries so the end value in time is
	25	* approximative. According to tcp(7) man page, a value of 5 is roughly 180
	26	* seconds of timeout. With that information, we've computed a factor of 36
	27	* (180/5) by considering that it grows linearly. This is of course uncertain
	28	* but this is the best approximation we can do at runtime.
	29	*/
	30	#define LTTCOMM_INET_SYN_TIMEOUT_FACTOR 36
	31
	32	/*
	33	* Maximum timeout value in seconds of a TCP connection for both send/recv and
	34	* connect operations.
	35	*/
	36	LTTNG_EXPORT extern unsigned long lttcomm_inet_tcp_timeout;
	37
	38	/* Stub */
	39	struct lttcomm_sock;
	40
	41	/* Net family callback */
	42	extern int lttcomm_create_inet_sock(struct lttcomm_sock *sock, int type, int proto);
	43
	44	extern struct lttcomm_sock lttcomm_accept_inet_sock(struct lttcomm_sock sock);
	45	extern int lttcomm_bind_inet_sock(struct lttcomm_sock *sock);
	46	extern int lttcomm_close_inet_sock(struct lttcomm_sock *sock);
	47	extern int lttcomm_connect_inet_sock(struct lttcomm_sock *sock);
	48	extern int lttcomm_listen_inet_sock(struct lttcomm_sock *sock, int backlog);
	49
	50	extern ssize_t
	51	lttcomm_recvmsg_inet_sock(struct lttcomm_sock sock, void buf, size_t len, int flags);
	52	extern ssize_t
	53	lttcomm_sendmsg_inet_sock(struct lttcomm_sock sock, const void buf, size_t len, int flags);
	54
	55	/* Initialize inet communication layer. */
	56	extern void lttcomm_inet_init();
	57
	58	#endif /* _LTTCOMM_INET_H */