[mirror_ubuntu-jammy-kernel.git] / include / linux / netpoll.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Common code for low-level network console, dump, and debugger code
 *
 * Derived from netconsole, kgdb-over-ethernet, and netdump patches
 */

#ifndef _LINUX_NETPOLL_H
#define _LINUX_NETPOLL_H

#include <linux/netdevice.h>
#include <linux/interrupt.h>
#include <linux/rcupdate.h>
#include <linux/list.h>
#include <linux/refcount.h>

union inet_addr {
	__u32		all[4];
	__be32		ip;
	__be32		ip6[4];
	struct in_addr	in;
	struct in6_addr	in6;
};

struct netpoll {
	struct net_device *dev;
	char dev_name[IFNAMSIZ];
	const char *name;

	union inet_addr local_ip, remote_ip;
	bool ipv6;
	u16 local_port, remote_port;
	u8 remote_mac[ETH_ALEN];
};

struct netpoll_info {
	refcount_t refcnt;

	struct semaphore dev_lock;

	struct sk_buff_head txq;

	struct delayed_work tx_work;

	struct netpoll *netpoll;
	struct rcu_head rcu;
};

#ifdef CONFIG_NETPOLL
void netpoll_poll_dev(struct net_device *dev);
void netpoll_poll_disable(struct net_device *dev);
void netpoll_poll_enable(struct net_device *dev);
#else
static inline void netpoll_poll_disable(struct net_device *dev) { return; }
static inline void netpoll_poll_enable(struct net_device *dev) { return; }
#endif

void netpoll_send_udp(struct netpoll *np, const char *msg, int len);
void netpoll_print_options(struct netpoll *np);
int netpoll_parse_options(struct netpoll *np, char *opt);
int __netpoll_setup(struct netpoll *np, struct net_device *ndev);
int netpoll_setup(struct netpoll *np);
void __netpoll_cleanup(struct netpoll *np);
void __netpoll_free(struct netpoll *np);
void netpoll_cleanup(struct netpoll *np);
netdev_tx_t netpoll_send_skb(struct netpoll *np, struct sk_buff *skb);

#ifdef CONFIG_NETPOLL
static inline void *netpoll_poll_lock(struct napi_struct *napi)
{
	struct net_device *dev = napi->dev;

	if (dev && dev->npinfo) {
		int owner = smp_processor_id();

		while (cmpxchg(&napi->poll_owner, -1, owner) != -1)
			cpu_relax();

		return napi;
	}
	return NULL;
}

static inline void netpoll_poll_unlock(void *have)
{
	struct napi_struct *napi = have;

	if (napi)
		smp_store_release(&napi->poll_owner, -1);
}

static inline bool netpoll_tx_running(struct net_device *dev)
{
	return irqs_disabled();
}

#else
static inline void *netpoll_poll_lock(struct napi_struct *napi)
{
	return NULL;
}
static inline void netpoll_poll_unlock(void *have)
{
}
static inline bool netpoll_tx_running(struct net_device *dev)
{
	return false;
}
#endif

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	* Common code for low-level network console, dump, and debugger code
	4	*
	5	* Derived from netconsole, kgdb-over-ethernet, and netdump patches
	6	*/
	7
	8	#ifndef _LINUX_NETPOLL_H
	9	#define _LINUX_NETPOLL_H
	10
	11	#include <linux/netdevice.h>
	12	#include <linux/interrupt.h>
53fb95d3	13	#include <linux/rcupdate.h>
1da177e4	14	#include <linux/list.h>
433cea4d	15	#include <linux/refcount.h>
1da177e4	16
b7394d24 CW	17	union inet_addr {
	18	__u32 all[4];
	19	__be32 ip;
	20	__be32 ip6[4];
	21	struct in_addr in;
	22	struct in6_addr in6;
	23	};
	24
1da177e4 LT	25	struct netpoll {
1da177e4 LT	26	struct net_device *dev;
bf6bce71 SH	27	char dev_name[IFNAMSIZ];
bf6bce71 SH	28	const char *name;
5de4a473	29
b7394d24 CW	30	union inet_addr local_ip, remote_ip;
b7394d24 CW	31	bool ipv6;
1da177e4	32	u16 local_port, remote_port;
09538641	33	u8 remote_mac[ETH_ALEN];
115c1d6e JM	34	};
	35
	36	struct netpoll_info {
433cea4d	37	refcount_t refcnt;
508e14b4	38
bd7c4b60	39	struct semaphore dev_lock;
508e14b4	40
b6cd27ed	41	struct sk_buff_head txq;
508e14b4	42
6d5aefb8	43	struct delayed_work tx_work;
0e34e931 WC	44
0e34e931 WC	45	struct netpoll *netpoll;
38e6bc18	46	struct rcu_head rcu;
1da177e4 LT	47	};
1da177e4 LT	48
ca99ca14	49	#ifdef CONFIG_NETPOLL
ac3d9dd0 ED	50	void netpoll_poll_dev(struct net_device *dev);
	51	void netpoll_poll_disable(struct net_device *dev);
	52	void netpoll_poll_enable(struct net_device *dev);
ca99ca14	53	#else
66b5552f EB	54	static inline void netpoll_poll_disable(struct net_device *dev) { return; }
66b5552f EB	55	static inline void netpoll_poll_enable(struct net_device *dev) { return; }
ca99ca14 NH	56	#endif
ca99ca14 NH	57
1da177e4	58	void netpoll_send_udp(struct netpoll np, const char msg, int len);
0bcc1816	59	void netpoll_print_options(struct netpoll *np);
1da177e4	60	int netpoll_parse_options(struct netpoll np, char opt);
a8779ec1	61	int __netpoll_setup(struct netpoll np, struct net_device ndev);
1da177e4	62	int netpoll_setup(struct netpoll *np);
8fdd95ec	63	void __netpoll_cleanup(struct netpoll *np);
c9fbd71f	64	void __netpoll_free(struct netpoll *np);
1da177e4	65	void netpoll_cleanup(struct netpoll *np);
1ddabdfa	66	netdev_tx_t netpoll_send_skb(struct netpoll np, struct sk_buff skb);
c2355e1a	67
e1bd4d3d	68	#ifdef CONFIG_NETPOLL
bea3348e SH	69	static inline void netpoll_poll_lock(struct napi_struct napi)
	70	{
	71	struct net_device *dev = napi->dev;
	72
bea3348e	73	if (dev && dev->npinfo) {
89c4b442 ED	74	int owner = smp_processor_id();
	75
	76	while (cmpxchg(&napi->poll_owner, -1, owner) != -1)
	77	cpu_relax();
	78
bea3348e	79	return napi;
1da177e4	80	}
53fb95d3	81	return NULL;
1da177e4 LT	82	}
1da177e4 LT	83
53fb95d3	84	static inline void netpoll_poll_unlock(void *have)
1da177e4	85	{
bea3348e	86	struct napi_struct *napi = have;
53fb95d3	87
89c4b442 ED	88	if (napi)
89c4b442 ED	89	smp_store_release(&napi->poll_owner, -1);
1da177e4 LT	90	}
1da177e4 LT	91
77ab8a54	92	static inline bool netpoll_tx_running(struct net_device *dev)
c18370f5 HX	93	{
	94	return irqs_disabled();
	95	}
	96
1da177e4	97	#else
bea3348e SH	98	static inline void netpoll_poll_lock(struct napi_struct napi)
	99	{
	100	return NULL;
	101	}
	102	static inline void netpoll_poll_unlock(void *have)
	103	{
	104	}
77ab8a54	105	static inline bool netpoll_tx_running(struct net_device *dev)
c18370f5	106	{
77ab8a54	107	return false;
c18370f5	108	}
1da177e4 LT	109	#endif
	110
	111	#endif