[mirror_ubuntu-jammy-kernel.git] / include / net / ping.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * INET		An implementation of the TCP/IP protocol suite for the LINUX
 *		operating system.  INET is implemented using the  BSD Socket
 *		interface as the means of communication with the user level.
 *
 *		Definitions for the "ping" module.
 */
#ifndef _PING_H
#define _PING_H

#include <net/icmp.h>
#include <net/netns/hash.h>

/* PING_HTABLE_SIZE must be power of 2 */
#define PING_HTABLE_SIZE 	64
#define PING_HTABLE_MASK 	(PING_HTABLE_SIZE-1)

#define ping_portaddr_for_each_entry(__sk, node, list) \
	hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)

/*
 * gid_t is either uint or ushort.  We want to pass it to
 * proc_dointvec_minmax(), so it must not be larger than MAX_INT
 */
#define GID_T_MAX (((gid_t)~0U) >> 1)

/* Compatibility glue so we can support IPv6 when it's compiled as a module */
struct pingv6_ops {
	int (*ipv6_recv_error)(struct sock *sk, struct msghdr *msg, int len,
			       int *addr_len);
	void (*ip6_datagram_recv_common_ctl)(struct sock *sk,
					     struct msghdr *msg,
					     struct sk_buff *skb);
	void (*ip6_datagram_recv_specific_ctl)(struct sock *sk,
					       struct msghdr *msg,
					       struct sk_buff *skb);
	int (*icmpv6_err_convert)(u8 type, u8 code, int *err);
	void (*ipv6_icmp_error)(struct sock *sk, struct sk_buff *skb, int err,
				__be16 port, u32 info, u8 *payload);
	int (*ipv6_chk_addr)(struct net *net, const struct in6_addr *addr,
			     const struct net_device *dev, int strict);
};

struct ping_iter_state {
	struct seq_net_private  p;
	int			bucket;
	sa_family_t		family;
};

extern struct proto ping_prot;
#if IS_ENABLED(CONFIG_IPV6)
extern struct pingv6_ops pingv6_ops;
#endif

struct pingfakehdr {
	struct icmphdr icmph;
	struct msghdr *msg;
	sa_family_t family;
	__wsum wcheck;
};

int  ping_get_port(struct sock *sk, unsigned short ident);
int ping_hash(struct sock *sk);
void ping_unhash(struct sock *sk);

int  ping_init_sock(struct sock *sk);
void ping_close(struct sock *sk, long timeout);
int  ping_bind(struct sock *sk, struct sockaddr *uaddr, int addr_len);
void ping_err(struct sk_buff *skb, int offset, u32 info);
int  ping_getfrag(void *from, char *to, int offset, int fraglen, int odd,
		  struct sk_buff *);

int  ping_recvmsg(struct sock *sk, struct msghdr *msg, size_t len, int noblock,
		  int flags, int *addr_len);
int  ping_common_sendmsg(int family, struct msghdr *msg, size_t len,
			 void *user_icmph, size_t icmph_len);
int  ping_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
bool ping_rcv(struct sk_buff *skb);

#ifdef CONFIG_PROC_FS
void *ping_seq_start(struct seq_file *seq, loff_t *pos, sa_family_t family);
void *ping_seq_next(struct seq_file *seq, void *v, loff_t *pos);
void ping_seq_stop(struct seq_file *seq, void *v);

int __init ping_proc_init(void);
void ping_proc_exit(void);
#endif

void __init ping_init(void);
int  __init pingv6_init(void);
void pingv6_exit(void);

#endif /* _PING_H */
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
c319b4d7 VK	2	/*
	3	* INET An implementation of the TCP/IP protocol suite for the LINUX
	4	* operating system. INET is implemented using the BSD Socket
	5	* interface as the means of communication with the user level.
	6	*
	7	* Definitions for the "ping" module.
c319b4d7 VK	8	*/
	9	#ifndef _PING_H
	10	#define _PING_H
	11
6d0bfe22	12	#include <net/icmp.h>
c319b4d7 VK	13	#include <net/netns/hash.h>
	14
	15	/* PING_HTABLE_SIZE must be power of 2 */
	16	#define PING_HTABLE_SIZE 64
	17	#define PING_HTABLE_MASK (PING_HTABLE_SIZE-1)
	18
	19	#define ping_portaddr_for_each_entry(__sk, node, list) \
	20	hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
	21
	22	/*
	23	* gid_t is either uint or ushort. We want to pass it to
	24	* proc_dointvec_minmax(), so it must not be larger than MAX_INT
	25	*/
	26	#define GID_T_MAX (((gid_t)~0U) >> 1)
	27
6d0bfe22 LC	28	/* Compatibility glue so we can support IPv6 when it's compiled as a module */
6d0bfe22 LC	29	struct pingv6_ops {
85fbaa75 HFS	30	int (ipv6_recv_error)(struct sock sk, struct msghdr *msg, int len,
85fbaa75 HFS	31	int *addr_len);
4b261c75 HFS	32	void (ip6_datagram_recv_common_ctl)(struct sock sk,
	33	struct msghdr *msg,
	34	struct sk_buff *skb);
	35	void (ip6_datagram_recv_specific_ctl)(struct sock sk,
	36	struct msghdr *msg,
	37	struct sk_buff *skb);
6d0bfe22 LC	38	int (icmpv6_err_convert)(u8 type, u8 code, int err);
	39	void (ipv6_icmp_error)(struct sock sk, struct sk_buff *skb, int err,
	40	__be16 port, u32 info, u8 *payload);
	41	int (ipv6_chk_addr)(struct net net, const struct in6_addr *addr,
6bc19fb8	42	const struct net_device *dev, int strict);
6d0bfe22 LC	43	};
6d0bfe22 LC	44
c319b4d7 VK	45	struct ping_iter_state {
	46	struct seq_net_private p;
	47	int bucket;
8cc785f6	48	sa_family_t family;
c319b4d7 VK	49	};
	50
	51	extern struct proto ping_prot;
6d0bfe22 LC	52	#if IS_ENABLED(CONFIG_IPV6)
	53	extern struct pingv6_ops pingv6_ops;
	54	#endif
c319b4d7	55
6d0bfe22 LC	56	struct pingfakehdr {
6d0bfe22 LC	57	struct icmphdr icmph;
cacdc7d2	58	struct msghdr *msg;
6d0bfe22 LC	59	sa_family_t family;
	60	__wsum wcheck;
	61	};
c319b4d7	62
6d0bfe22	63	int ping_get_port(struct sock *sk, unsigned short ident);
086c653f	64	int ping_hash(struct sock *sk);
6d0bfe22 LC	65	void ping_unhash(struct sock *sk);
	66
	67	int ping_init_sock(struct sock *sk);
	68	void ping_close(struct sock *sk, long timeout);
	69	int ping_bind(struct sock sk, struct sockaddr uaddr, int addr_len);
	70	void ping_err(struct sk_buff *skb, int offset, u32 info);
	71	int ping_getfrag(void from, char to, int offset, int fraglen, int odd,
	72	struct sk_buff *);
	73
1b784140 YX	74	int ping_recvmsg(struct sock sk, struct msghdr msg, size_t len, int noblock,
1b784140 YX	75	int flags, int *addr_len);
6d0bfe22 LC	76	int ping_common_sendmsg(int family, struct msghdr *msg, size_t len,
6d0bfe22 LC	77	void *user_icmph, size_t icmph_len);
6d0bfe22	78	int ping_queue_rcv_skb(struct sock sk, struct sk_buff skb);
e3e32170	79	bool ping_rcv(struct sk_buff *skb);
c319b4d7	80
c319b4d7	81	#ifdef CONFIG_PROC_FS
d862e546 LC	82	void ping_seq_start(struct seq_file seq, loff_t *pos, sa_family_t family);
	83	void ping_seq_next(struct seq_file seq, void v, loff_t pos);
	84	void ping_seq_stop(struct seq_file seq, void v);
d862e546	85
6d3b334d JP	86	int __init ping_proc_init(void);
6d3b334d JP	87	void ping_proc_exit(void);
c319b4d7 VK	88	#endif
	89
	90	void __init ping_init(void);
6d0bfe22 LC	91	int __init pingv6_init(void);
6d0bfe22 LC	92	void pingv6_exit(void);
c319b4d7 VK	93
c319b4d7 VK	94	#endif /* _PING_H */