[linux-block.git] / include / net / xdp.h

/* SPDX-License-Identifier: GPL-2.0-only */
/* include/net/xdp.h
 *
 * Copyright (c) 2017 Jesper Dangaard Brouer, Red Hat Inc.
 */
#ifndef __LINUX_NET_XDP_H__
#define __LINUX_NET_XDP_H__

#include <linux/skbuff.h> /* skb_shared_info */

/**
 * DOC: XDP RX-queue information
 *
 * The XDP RX-queue info (xdp_rxq_info) is associated with the driver
 * level RX-ring queues.  It is information that is specific to how
 * the driver have configured a given RX-ring queue.
 *
 * Each xdp_buff frame received in the driver carries a (pointer)
 * reference to this xdp_rxq_info structure.  This provides the XDP
 * data-path read-access to RX-info for both kernel and bpf-side
 * (limited subset).
 *
 * For now, direct access is only safe while running in NAPI/softirq
 * context.  Contents are read-mostly and must not be updated during
 * driver NAPI/softirq poll.
 *
 * The driver usage API is a register and unregister API.
 *
 * The struct is not directly tied to the XDP prog.  A new XDP prog
 * can be attached as long as it doesn't change the underlying
 * RX-ring.  If the RX-ring does change significantly, the NIC driver
 * naturally need to stop the RX-ring before purging and reallocating
 * memory.  In that process the driver MUST call unregister (which
 * also applies for driver shutdown and unload).  The register API is
 * also mandatory during RX-ring setup.
 */

enum xdp_mem_type {
	MEM_TYPE_PAGE_SHARED = 0, /* Split-page refcnt based model */
	MEM_TYPE_PAGE_ORDER0,     /* Orig XDP full page model */
	MEM_TYPE_PAGE_POOL,
	MEM_TYPE_XSK_BUFF_POOL,
	MEM_TYPE_MAX,
};

/* XDP flags for ndo_xdp_xmit */
#define XDP_XMIT_FLUSH		(1U << 0)	/* doorbell signal consumer */
#define XDP_XMIT_FLAGS_MASK	XDP_XMIT_FLUSH

struct xdp_mem_info {
	u32 type; /* enum xdp_mem_type, but known size type */
	u32 id;
};

struct page_pool;

struct xdp_rxq_info {
	struct net_device *dev;
	u32 queue_index;
	u32 reg_state;
	struct xdp_mem_info mem;
	unsigned int napi_id;
	u32 frag_size;
} ____cacheline_aligned; /* perf critical, avoid false-sharing */

struct xdp_txq_info {
	struct net_device *dev;
};

enum xdp_buff_flags {
	XDP_FLAGS_HAS_FRAGS		= BIT(0), /* non-linear xdp buff */
	XDP_FLAGS_FRAGS_PF_MEMALLOC	= BIT(1), /* xdp paged memory is under
						   * pressure
						   */
};

struct xdp_buff {
	void *data;
	void *data_end;
	void *data_meta;
	void *data_hard_start;
	struct xdp_rxq_info *rxq;
	struct xdp_txq_info *txq;
	u32 frame_sz; /* frame size to deduce data_hard_end/reserved tailroom*/
	u32 flags; /* supported values defined in xdp_buff_flags */
};

static __always_inline bool xdp_buff_has_frags(struct xdp_buff *xdp)
{
	return !!(xdp->flags & XDP_FLAGS_HAS_FRAGS);
}

static __always_inline void xdp_buff_set_frags_flag(struct xdp_buff *xdp)
{
	xdp->flags |= XDP_FLAGS_HAS_FRAGS;
}

static __always_inline void xdp_buff_clear_frags_flag(struct xdp_buff *xdp)
{
	xdp->flags &= ~XDP_FLAGS_HAS_FRAGS;
}

static __always_inline bool xdp_buff_is_frag_pfmemalloc(struct xdp_buff *xdp)
{
	return !!(xdp->flags & XDP_FLAGS_FRAGS_PF_MEMALLOC);
}

static __always_inline void xdp_buff_set_frag_pfmemalloc(struct xdp_buff *xdp)
{
	xdp->flags |= XDP_FLAGS_FRAGS_PF_MEMALLOC;
}

static __always_inline void
xdp_init_buff(struct xdp_buff *xdp, u32 frame_sz, struct xdp_rxq_info *rxq)
{
	xdp->frame_sz = frame_sz;
	xdp->rxq = rxq;
	xdp->flags = 0;
}

static __always_inline void
xdp_prepare_buff(struct xdp_buff *xdp, unsigned char *hard_start,
		 int headroom, int data_len, const bool meta_valid)
{
	unsigned char *data = hard_start + headroom;

	xdp->data_hard_start = hard_start;
	xdp->data = data;
	xdp->data_end = data + data_len;
	xdp->data_meta = meta_valid ? data : data + 1;
}

/* Reserve memory area at end-of data area.
 *
 * This macro reserves tailroom in the XDP buffer by limiting the
 * XDP/BPF data access to data_hard_end.  Notice same area (and size)
 * is used for XDP_PASS, when constructing the SKB via build_skb().
 */
#define xdp_data_hard_end(xdp)				\
	((xdp)->data_hard_start + (xdp)->frame_sz -	\
	 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))

static inline struct skb_shared_info *
xdp_get_shared_info_from_buff(struct xdp_buff *xdp)
{
	return (struct skb_shared_info *)xdp_data_hard_end(xdp);
}

static __always_inline unsigned int xdp_get_buff_len(struct xdp_buff *xdp)
{
	unsigned int len = xdp->data_end - xdp->data;
	struct skb_shared_info *sinfo;

	if (likely(!xdp_buff_has_frags(xdp)))
		goto out;

	sinfo = xdp_get_shared_info_from_buff(xdp);
	len += sinfo->xdp_frags_size;
out:
	return len;
}

struct xdp_frame {
	void *data;
	u16 len;
	u16 headroom;
	u32 metasize; /* uses lower 8-bits */
	/* Lifetime of xdp_rxq_info is limited to NAPI/enqueue time,
	 * while mem info is valid on remote CPU.
	 */
	struct xdp_mem_info mem;
	struct net_device *dev_rx; /* used by cpumap */
	u32 frame_sz;
	u32 flags; /* supported values defined in xdp_buff_flags */
};

static __always_inline bool xdp_frame_has_frags(struct xdp_frame *frame)
{
	return !!(frame->flags & XDP_FLAGS_HAS_FRAGS);
}

static __always_inline bool xdp_frame_is_frag_pfmemalloc(struct xdp_frame *frame)
{
	return !!(frame->flags & XDP_FLAGS_FRAGS_PF_MEMALLOC);
}

#define XDP_BULK_QUEUE_SIZE	16
struct xdp_frame_bulk {
	int count;
	void *xa;
	void *q[XDP_BULK_QUEUE_SIZE];
};

static __always_inline void xdp_frame_bulk_init(struct xdp_frame_bulk *bq)
{
	/* bq->count will be zero'ed when bq->xa gets updated */
	bq->xa = NULL;
}

static inline struct skb_shared_info *
xdp_get_shared_info_from_frame(struct xdp_frame *frame)
{
	void *data_hard_start = frame->data - frame->headroom - sizeof(*frame);

	return (struct skb_shared_info *)(data_hard_start + frame->frame_sz -
				SKB_DATA_ALIGN(sizeof(struct skb_shared_info)));
}

struct xdp_cpumap_stats {
	unsigned int redirect;
	unsigned int pass;
	unsigned int drop;
};

/* Clear kernel pointers in xdp_frame */
static inline void xdp_scrub_frame(struct xdp_frame *frame)
{
	frame->data = NULL;
	frame->dev_rx = NULL;
}

static inline void
xdp_update_skb_shared_info(struct sk_buff *skb, u8 nr_frags,
			   unsigned int size, unsigned int truesize,
			   bool pfmemalloc)
{
	skb_shinfo(skb)->nr_frags = nr_frags;

	skb->len += size;
	skb->data_len += size;
	skb->truesize += truesize;
	skb->pfmemalloc |= pfmemalloc;
}

/* Avoids inlining WARN macro in fast-path */
void xdp_warn(const char *msg, const char *func, const int line);
#define XDP_WARN(msg) xdp_warn(msg, __func__, __LINE__)

struct xdp_frame *xdp_convert_zc_to_xdp_frame(struct xdp_buff *xdp);
struct sk_buff *__xdp_build_skb_from_frame(struct xdp_frame *xdpf,
					   struct sk_buff *skb,
					   struct net_device *dev);
struct sk_buff *xdp_build_skb_from_frame(struct xdp_frame *xdpf,
					 struct net_device *dev);
int xdp_alloc_skb_bulk(void **skbs, int n_skb, gfp_t gfp);
struct xdp_frame *xdpf_clone(struct xdp_frame *xdpf);

static inline
void xdp_convert_frame_to_buff(struct xdp_frame *frame, struct xdp_buff *xdp)
{
	xdp->data_hard_start = frame->data - frame->headroom - sizeof(*frame);
	xdp->data = frame->data;
	xdp->data_end = frame->data + frame->len;
	xdp->data_meta = frame->data - frame->metasize;
	xdp->frame_sz = frame->frame_sz;
	xdp->flags = frame->flags;
}

static inline
int xdp_update_frame_from_buff(struct xdp_buff *xdp,
			       struct xdp_frame *xdp_frame)
{
	int metasize, headroom;

	/* Assure headroom is available for storing info */
	headroom = xdp->data - xdp->data_hard_start;
	metasize = xdp->data - xdp->data_meta;
	metasize = metasize > 0 ? metasize : 0;
	if (unlikely((headroom - metasize) < sizeof(*xdp_frame)))
		return -ENOSPC;

	/* Catch if driver didn't reserve tailroom for skb_shared_info */
	if (unlikely(xdp->data_end > xdp_data_hard_end(xdp))) {
		XDP_WARN("Driver BUG: missing reserved tailroom");
		return -ENOSPC;
	}

	xdp_frame->data = xdp->data;
	xdp_frame->len  = xdp->data_end - xdp->data;
	xdp_frame->headroom = headroom - sizeof(*xdp_frame);
	xdp_frame->metasize = metasize;
	xdp_frame->frame_sz = xdp->frame_sz;
	xdp_frame->flags = xdp->flags;

	return 0;
}

/* Convert xdp_buff to xdp_frame */
static inline
struct xdp_frame *xdp_convert_buff_to_frame(struct xdp_buff *xdp)
{
	struct xdp_frame *xdp_frame;

	if (xdp->rxq->mem.type == MEM_TYPE_XSK_BUFF_POOL)
		return xdp_convert_zc_to_xdp_frame(xdp);

	/* Store info in top of packet */
	xdp_frame = xdp->data_hard_start;
	if (unlikely(xdp_update_frame_from_buff(xdp, xdp_frame) < 0))
		return NULL;

	/* rxq only valid until napi_schedule ends, convert to xdp_mem_info */
	xdp_frame->mem = xdp->rxq->mem;

	return xdp_frame;
}

void __xdp_return(void *data, struct xdp_mem_info *mem, bool napi_direct,
		  struct xdp_buff *xdp);
void xdp_return_frame(struct xdp_frame *xdpf);
void xdp_return_frame_rx_napi(struct xdp_frame *xdpf);
void xdp_return_buff(struct xdp_buff *xdp);
void xdp_flush_frame_bulk(struct xdp_frame_bulk *bq);
void xdp_return_frame_bulk(struct xdp_frame *xdpf,
			   struct xdp_frame_bulk *bq);

/* When sending xdp_frame into the network stack, then there is no
 * return point callback, which is needed to release e.g. DMA-mapping
 * resources with page_pool.  Thus, have explicit function to release
 * frame resources.
 */
void __xdp_release_frame(void *data, struct xdp_mem_info *mem);
static inline void xdp_release_frame(struct xdp_frame *xdpf)
{
	struct xdp_mem_info *mem = &xdpf->mem;
	struct skb_shared_info *sinfo;
	int i;

	/* Curr only page_pool needs this */
	if (mem->type != MEM_TYPE_PAGE_POOL)
		return;

	if (likely(!xdp_frame_has_frags(xdpf)))
		goto out;

	sinfo = xdp_get_shared_info_from_frame(xdpf);
	for (i = 0; i < sinfo->nr_frags; i++) {
		struct page *page = skb_frag_page(&sinfo->frags[i]);

		__xdp_release_frame(page_address(page), mem);
	}
out:
	__xdp_release_frame(xdpf->data, mem);
}

static __always_inline unsigned int xdp_get_frame_len(struct xdp_frame *xdpf)
{
	struct skb_shared_info *sinfo;
	unsigned int len = xdpf->len;

	if (likely(!xdp_frame_has_frags(xdpf)))
		goto out;

	sinfo = xdp_get_shared_info_from_frame(xdpf);
	len += sinfo->xdp_frags_size;
out:
	return len;
}

int __xdp_rxq_info_reg(struct xdp_rxq_info *xdp_rxq,
		       struct net_device *dev, u32 queue_index,
		       unsigned int napi_id, u32 frag_size);
static inline int
xdp_rxq_info_reg(struct xdp_rxq_info *xdp_rxq,
		 struct net_device *dev, u32 queue_index,
		 unsigned int napi_id)
{
	return __xdp_rxq_info_reg(xdp_rxq, dev, queue_index, napi_id, 0);
}

void xdp_rxq_info_unreg(struct xdp_rxq_info *xdp_rxq);
void xdp_rxq_info_unused(struct xdp_rxq_info *xdp_rxq);
bool xdp_rxq_info_is_reg(struct xdp_rxq_info *xdp_rxq);
int xdp_rxq_info_reg_mem_model(struct xdp_rxq_info *xdp_rxq,
			       enum xdp_mem_type type, void *allocator);
void xdp_rxq_info_unreg_mem_model(struct xdp_rxq_info *xdp_rxq);
int xdp_reg_mem_model(struct xdp_mem_info *mem,
		      enum xdp_mem_type type, void *allocator);
void xdp_unreg_mem_model(struct xdp_mem_info *mem);

/* Drivers not supporting XDP metadata can use this helper, which
 * rejects any room expansion for metadata as a result.
 */
static __always_inline void
xdp_set_data_meta_invalid(struct xdp_buff *xdp)
{
	xdp->data_meta = xdp->data + 1;
}

static __always_inline bool
xdp_data_meta_unsupported(const struct xdp_buff *xdp)
{
	return unlikely(xdp->data_meta > xdp->data);
}

static inline bool xdp_metalen_invalid(unsigned long metalen)
{
	return (metalen & (sizeof(__u32) - 1)) || (metalen > 32);
}

struct xdp_attachment_info {
	struct bpf_prog *prog;
	u32 flags;
};

struct netdev_bpf;
void xdp_attachment_setup(struct xdp_attachment_info *info,
			  struct netdev_bpf *bpf);

#define DEV_MAP_BULK_SIZE XDP_BULK_QUEUE_SIZE

#endif /* __LINUX_NET_XDP_H__ */
Commit	Line	Data
ddc64d0a	1	/* SPDX-License-Identifier: GPL-2.0-only */
aecd67b6 JDB	2	/* include/net/xdp.h
	3	*
	4	* Copyright (c) 2017 Jesper Dangaard Brouer, Red Hat Inc.
aecd67b6 JDB	5	*/
	6	#ifndef __LINUX_NET_XDP_H__
	7	#define __LINUX_NET_XDP_H__
	8
f95f0f95 JDB	9	#include <linux/skbuff.h> /* skb_shared_info */
f95f0f95 JDB	10
aecd67b6 JDB	11	/**
	12	* DOC: XDP RX-queue information
	13	*
	14	* The XDP RX-queue info (xdp_rxq_info) is associated with the driver
	15	* level RX-ring queues. It is information that is specific to how
	16	* the driver have configured a given RX-ring queue.
	17	*
6bbc7103	18	* Each xdp_buff frame received in the driver carries a (pointer)
aecd67b6 JDB	19	* reference to this xdp_rxq_info structure. This provides the XDP
	20	* data-path read-access to RX-info for both kernel and bpf-side
	21	* (limited subset).
	22	*
	23	* For now, direct access is only safe while running in NAPI/softirq
6bbc7103	24	* context. Contents are read-mostly and must not be updated during
aecd67b6 JDB	25	* driver NAPI/softirq poll.
	26	*
	27	* The driver usage API is a register and unregister API.
	28	*
	29	* The struct is not directly tied to the XDP prog. A new XDP prog
	30	* can be attached as long as it doesn't change the underlying
	31	* RX-ring. If the RX-ring does change significantly, the NIC driver
	32	* naturally need to stop the RX-ring before purging and reallocating
6bbc7103 KJ	33	* memory. In that process the driver MUST call unregister (which
6bbc7103 KJ	34	* also applies for driver shutdown and unload). The register API is
aecd67b6 JDB	35	* also mandatory during RX-ring setup.
	36	*/
	37
5ab073ff JDB	38	enum xdp_mem_type {
	39	MEM_TYPE_PAGE_SHARED = 0, /* Split-page refcnt based model */
	40	MEM_TYPE_PAGE_ORDER0, /* Orig XDP full page model */
57d0a1c1	41	MEM_TYPE_PAGE_POOL,
2b43470a	42	MEM_TYPE_XSK_BUFF_POOL,
5ab073ff JDB	43	MEM_TYPE_MAX,
	44	};
	45
42b33468	46	/* XDP flags for ndo_xdp_xmit */
42b33468 JDB	47	#define XDP_XMIT_FLUSH (1U << 0) /* doorbell signal consumer */
	48	#define XDP_XMIT_FLAGS_MASK XDP_XMIT_FLUSH
	49
5ab073ff JDB	50	struct xdp_mem_info {
5ab073ff JDB	51	u32 type; /* enum xdp_mem_type, but known size type */
8d5d8852	52	u32 id;
5ab073ff JDB	53	};
5ab073ff JDB	54
57d0a1c1 JDB	55	struct page_pool;
57d0a1c1 JDB	56
aecd67b6 JDB	57	struct xdp_rxq_info {
	58	struct net_device *dev;
	59	u32 queue_index;
	60	u32 reg_state;
5ab073ff	61	struct xdp_mem_info mem;
b02e5a0e	62	unsigned int napi_id;
bf25146a	63	u32 frag_size;
aecd67b6 JDB	64	} ____cacheline_aligned; /* perf critical, avoid false-sharing */
aecd67b6 JDB	65
64b59025 DA	66	struct xdp_txq_info {
	67	struct net_device *dev;
	68	};
	69
2e88d4ff	70	enum xdp_buff_flags {
d65a1906 LB	71	XDP_FLAGS_HAS_FRAGS = BIT(0), /* non-linear xdp buff */
	72	XDP_FLAGS_FRAGS_PF_MEMALLOC = BIT(1), /* xdp paged memory is under
	73	* pressure
	74	*/
2e88d4ff LB	75	};
2e88d4ff LB	76
106ca27f JDB	77	struct xdp_buff {
	78	void *data;
	79	void *data_end;
	80	void *data_meta;
	81	void *data_hard_start;
	82	struct xdp_rxq_info *rxq;
64b59025	83	struct xdp_txq_info *txq;
f95f0f95	84	u32 frame_sz; /* frame size to deduce data_hard_end/reserved tailroom*/
2e88d4ff	85	u32 flags; /* supported values defined in xdp_buff_flags */
106ca27f	86	};
5ab073ff	87
2e88d4ff LB	88	static __always_inline bool xdp_buff_has_frags(struct xdp_buff *xdp)
	89	{
	90	return !!(xdp->flags & XDP_FLAGS_HAS_FRAGS);
	91	}
	92
	93	static __always_inline void xdp_buff_set_frags_flag(struct xdp_buff *xdp)
	94	{
	95	xdp->flags \|= XDP_FLAGS_HAS_FRAGS;
	96	}
	97
	98	static __always_inline void xdp_buff_clear_frags_flag(struct xdp_buff *xdp)
	99	{
	100	xdp->flags &= ~XDP_FLAGS_HAS_FRAGS;
	101	}
	102
d65a1906 LB	103	static __always_inline bool xdp_buff_is_frag_pfmemalloc(struct xdp_buff *xdp)
	104	{
	105	return !!(xdp->flags & XDP_FLAGS_FRAGS_PF_MEMALLOC);
	106	}
	107
	108	static __always_inline void xdp_buff_set_frag_pfmemalloc(struct xdp_buff *xdp)
	109	{
	110	xdp->flags \|= XDP_FLAGS_FRAGS_PF_MEMALLOC;
	111	}
	112
43b5169d LB	113	static __always_inline void
	114	xdp_init_buff(struct xdp_buff xdp, u32 frame_sz, struct xdp_rxq_info rxq)
	115	{
	116	xdp->frame_sz = frame_sz;
	117	xdp->rxq = rxq;
2e88d4ff	118	xdp->flags = 0;
43b5169d LB	119	}
43b5169d LB	120
be9df4af LB	121	static __always_inline void
	122	xdp_prepare_buff(struct xdp_buff xdp, unsigned char hard_start,
	123	int headroom, int data_len, const bool meta_valid)
	124	{
	125	unsigned char *data = hard_start + headroom;
	126
	127	xdp->data_hard_start = hard_start;
	128	xdp->data = data;
	129	xdp->data_end = data + data_len;
	130	xdp->data_meta = meta_valid ? data : data + 1;
	131	}
	132
f95f0f95 JDB	133	/* Reserve memory area at end-of data area.
	134	*
	135	* This macro reserves tailroom in the XDP buffer by limiting the
	136	* XDP/BPF data access to data_hard_end. Notice same area (and size)
	137	* is used for XDP_PASS, when constructing the SKB via build_skb().
	138	*/
	139	#define xdp_data_hard_end(xdp) \
	140	((xdp)->data_hard_start + (xdp)->frame_sz - \
	141	SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
	142
2f0bc54b LB	143	static inline struct skb_shared_info *
	144	xdp_get_shared_info_from_buff(struct xdp_buff *xdp)
	145	{
	146	return (struct skb_shared_info *)xdp_data_hard_end(xdp);
	147	}
	148
0165cc81 LB	149	static __always_inline unsigned int xdp_get_buff_len(struct xdp_buff *xdp)
	150	{
	151	unsigned int len = xdp->data_end - xdp->data;
	152	struct skb_shared_info *sinfo;
	153
	154	if (likely(!xdp_buff_has_frags(xdp)))
	155	goto out;
	156
	157	sinfo = xdp_get_shared_info_from_buff(xdp);
	158	len += sinfo->xdp_frags_size;
	159	out:
	160	return len;
	161	}
	162
c0048cff JDB	163	struct xdp_frame {
	164	void *data;
	165	u16 len;
	166	u16 headroom;
b860a1b9	167	u32 metasize; /* uses lower 8-bits */
c0048cff JDB	168	/* Lifetime of xdp_rxq_info is limited to NAPI/enqueue time,
	169	* while mem info is valid on remote CPU.
	170	*/
	171	struct xdp_mem_info mem;
70280ed9	172	struct net_device dev_rx; / used by cpumap */
b860a1b9	173	u32 frame_sz;
2e88d4ff	174	u32 flags; /* supported values defined in xdp_buff_flags */
c0048cff JDB	175	};
c0048cff JDB	176
2e88d4ff LB	177	static __always_inline bool xdp_frame_has_frags(struct xdp_frame *frame)
	178	{
	179	return !!(frame->flags & XDP_FLAGS_HAS_FRAGS);
	180	}
	181
d65a1906 LB	182	static __always_inline bool xdp_frame_is_frag_pfmemalloc(struct xdp_frame *frame)
	183	{
	184	return !!(frame->flags & XDP_FLAGS_FRAGS_PF_MEMALLOC);
	185	}
	186
89653987 LB	187	#define XDP_BULK_QUEUE_SIZE 16
	188	struct xdp_frame_bulk {
	189	int count;
	190	void *xa;
	191	void *q[XDP_BULK_QUEUE_SIZE];
	192	};
	193
	194	static __always_inline void xdp_frame_bulk_init(struct xdp_frame_bulk *bq)
	195	{
	196	/* bq->count will be zero'ed when bq->xa gets updated */
	197	bq->xa = NULL;
	198	}
dee72f8a	199
2f0bc54b LB	200	static inline struct skb_shared_info *
	201	xdp_get_shared_info_from_frame(struct xdp_frame *frame)
	202	{
	203	void data_hard_start = frame->data - frame->headroom - sizeof(frame);
	204
	205	return (struct skb_shared_info *)(data_hard_start + frame->frame_sz -
	206	SKB_DATA_ALIGN(sizeof(struct skb_shared_info)));
	207	}
	208
92164774	209	struct xdp_cpumap_stats {
28b1520e	210	unsigned int redirect;
92164774 LB	211	unsigned int pass;
	212	unsigned int drop;
	213	};
	214
a8d5b4ab TM	215	/* Clear kernel pointers in xdp_frame */
	216	static inline void xdp_scrub_frame(struct xdp_frame *frame)
	217	{
	218	frame->data = NULL;
	219	frame->dev_rx = NULL;
	220	}
	221
d65a1906 LB	222	static inline void
	223	xdp_update_skb_shared_info(struct sk_buff *skb, u8 nr_frags,
	224	unsigned int size, unsigned int truesize,
	225	bool pfmemalloc)
	226	{
	227	skb_shinfo(skb)->nr_frags = nr_frags;
	228
	229	skb->len += size;
	230	skb->data_len += size;
	231	skb->truesize += truesize;
	232	skb->pfmemalloc \|= pfmemalloc;
	233	}
	234
34cc0b33 JDB	235	/* Avoids inlining WARN macro in fast-path */
	236	void xdp_warn(const char msg, const char func, const int line);
	237	#define XDP_WARN(msg) xdp_warn(msg, __func__, __LINE__)
	238
b0d1beef	239	struct xdp_frame xdp_convert_zc_to_xdp_frame(struct xdp_buff xdp);
97a0e1ea LB	240	struct sk_buff __xdp_build_skb_from_frame(struct xdp_frame xdpf,
	241	struct sk_buff *skb,
	242	struct net_device *dev);
89f479f0 LB	243	struct sk_buff xdp_build_skb_from_frame(struct xdp_frame xdpf,
89f479f0 LB	244	struct net_device *dev);
65e6dcf7	245	int xdp_alloc_skb_bulk(void **skbs, int n_skb, gfp_t gfp);
e624d4ed	246	struct xdp_frame xdpf_clone(struct xdp_frame xdpf);
b0d1beef	247
fc379872 LB	248	static inline
	249	void xdp_convert_frame_to_buff(struct xdp_frame frame, struct xdp_buff xdp)
	250	{
	251	xdp->data_hard_start = frame->data - frame->headroom - sizeof(*frame);
	252	xdp->data = frame->data;
	253	xdp->data_end = frame->data + frame->len;
	254	xdp->data_meta = frame->data - frame->metasize;
	255	xdp->frame_sz = frame->frame_sz;
2e88d4ff	256	xdp->flags = frame->flags;
fc379872 LB	257	}
fc379872 LB	258
c0048cff	259	static inline
daa5cdc3 DA	260	int xdp_update_frame_from_buff(struct xdp_buff *xdp,
daa5cdc3 DA	261	struct xdp_frame *xdp_frame)
c0048cff	262	{
daa5cdc3	263	int metasize, headroom;
02b55e56	264
c0048cff JDB	265	/* Assure headroom is available for storing info */
	266	headroom = xdp->data - xdp->data_hard_start;
	267	metasize = xdp->data - xdp->data_meta;
	268	metasize = metasize > 0 ? metasize : 0;
	269	if (unlikely((headroom - metasize) < sizeof(*xdp_frame)))
daa5cdc3	270	return -ENOSPC;
c0048cff	271
34cc0b33 JDB	272	/* Catch if driver didn't reserve tailroom for skb_shared_info */
	273	if (unlikely(xdp->data_end > xdp_data_hard_end(xdp))) {
	274	XDP_WARN("Driver BUG: missing reserved tailroom");
daa5cdc3	275	return -ENOSPC;
34cc0b33 JDB	276	}
34cc0b33 JDB	277
c0048cff JDB	278	xdp_frame->data = xdp->data;
	279	xdp_frame->len = xdp->data_end - xdp->data;
	280	xdp_frame->headroom = headroom - sizeof(*xdp_frame);
	281	xdp_frame->metasize = metasize;
34cc0b33	282	xdp_frame->frame_sz = xdp->frame_sz;
2e88d4ff	283	xdp_frame->flags = xdp->flags;
c0048cff	284
daa5cdc3 DA	285	return 0;
	286	}
	287
	288	/* Convert xdp_buff to xdp_frame */
	289	static inline
	290	struct xdp_frame xdp_convert_buff_to_frame(struct xdp_buff xdp)
	291	{
	292	struct xdp_frame *xdp_frame;
	293
	294	if (xdp->rxq->mem.type == MEM_TYPE_XSK_BUFF_POOL)
	295	return xdp_convert_zc_to_xdp_frame(xdp);
	296
	297	/* Store info in top of packet */
	298	xdp_frame = xdp->data_hard_start;
	299	if (unlikely(xdp_update_frame_from_buff(xdp, xdp_frame) < 0))
	300	return NULL;
	301
c0048cff JDB	302	/* rxq only valid until napi_schedule ends, convert to xdp_mem_info */
	303	xdp_frame->mem = xdp->rxq->mem;
	304
	305	return xdp_frame;
	306	}
	307
bf25146a EC	308	void __xdp_return(void data, struct xdp_mem_info mem, bool napi_direct,
bf25146a EC	309	struct xdp_buff *xdp);
03993094	310	void xdp_return_frame(struct xdp_frame *xdpf);
389ab7f0	311	void xdp_return_frame_rx_napi(struct xdp_frame *xdpf);
c497176c	312	void xdp_return_buff(struct xdp_buff *xdp);
89653987 LB	313	void xdp_flush_frame_bulk(struct xdp_frame_bulk *bq);
	314	void xdp_return_frame_bulk(struct xdp_frame *xdpf,
	315	struct xdp_frame_bulk *bq);
5ab073ff	316
6bf071bf JDB	317	/* When sending xdp_frame into the network stack, then there is no
	318	* return point callback, which is needed to release e.g. DMA-mapping
	319	* resources with page_pool. Thus, have explicit function to release
	320	* frame resources.
	321	*/
	322	void __xdp_release_frame(void data, struct xdp_mem_info mem);
	323	static inline void xdp_release_frame(struct xdp_frame *xdpf)
	324	{
	325	struct xdp_mem_info *mem = &xdpf->mem;
7c48cb01 LB	326	struct skb_shared_info *sinfo;
7c48cb01 LB	327	int i;
6bf071bf JDB	328
6bf071bf JDB	329	/* Curr only page_pool needs this */
7c48cb01 LB	330	if (mem->type != MEM_TYPE_PAGE_POOL)
	331	return;
	332
	333	if (likely(!xdp_frame_has_frags(xdpf)))
	334	goto out;
	335
	336	sinfo = xdp_get_shared_info_from_frame(xdpf);
	337	for (i = 0; i < sinfo->nr_frags; i++) {
	338	struct page *page = skb_frag_page(&sinfo->frags[i]);
	339
	340	__xdp_release_frame(page_address(page), mem);
	341	}
	342	out:
	343	__xdp_release_frame(xdpf->data, mem);
6bf071bf JDB	344	}
6bf071bf JDB	345
5142239a LB	346	static __always_inline unsigned int xdp_get_frame_len(struct xdp_frame *xdpf)
	347	{
	348	struct skb_shared_info *sinfo;
	349	unsigned int len = xdpf->len;
	350
	351	if (likely(!xdp_frame_has_frags(xdpf)))
	352	goto out;
	353
	354	sinfo = xdp_get_shared_info_from_frame(xdpf);
	355	len += sinfo->xdp_frags_size;
	356	out:
	357	return len;
	358	}
	359
bf25146a EC	360	int __xdp_rxq_info_reg(struct xdp_rxq_info *xdp_rxq,
	361	struct net_device *dev, u32 queue_index,
	362	unsigned int napi_id, u32 frag_size);
	363	static inline int
	364	xdp_rxq_info_reg(struct xdp_rxq_info *xdp_rxq,
	365	struct net_device *dev, u32 queue_index,
	366	unsigned int napi_id)
	367	{
	368	return __xdp_rxq_info_reg(xdp_rxq, dev, queue_index, napi_id, 0);
	369	}
	370
aecd67b6 JDB	371	void xdp_rxq_info_unreg(struct xdp_rxq_info *xdp_rxq);
aecd67b6 JDB	372	void xdp_rxq_info_unused(struct xdp_rxq_info *xdp_rxq);
c0124f32	373	bool xdp_rxq_info_is_reg(struct xdp_rxq_info *xdp_rxq);
5ab073ff JDB	374	int xdp_rxq_info_reg_mem_model(struct xdp_rxq_info *xdp_rxq,
5ab073ff JDB	375	enum xdp_mem_type type, void *allocator);
dce5bd61	376	void xdp_rxq_info_unreg_mem_model(struct xdp_rxq_info *xdp_rxq);
4a48ef70 THJ	377	int xdp_reg_mem_model(struct xdp_mem_info *mem,
	378	enum xdp_mem_type type, void *allocator);
	379	void xdp_unreg_mem_model(struct xdp_mem_info *mem);
aecd67b6	380
106ca27f JDB	381	/* Drivers not supporting XDP metadata can use this helper, which
	382	* rejects any room expansion for metadata as a result.
	383	*/
	384	static __always_inline void
	385	xdp_set_data_meta_invalid(struct xdp_buff *xdp)
	386	{
	387	xdp->data_meta = xdp->data + 1;
	388	}
	389
	390	static __always_inline bool
	391	xdp_data_meta_unsupported(const struct xdp_buff *xdp)
	392	{
	393	return unlikely(xdp->data_meta > xdp->data);
	394	}
	395
7445cf31 ZE	396	static inline bool xdp_metalen_invalid(unsigned long metalen)
	397	{
	398	return (metalen & (sizeof(__u32) - 1)) \|\| (metalen > 32);
	399	}
	400
05296620 JK	401	struct xdp_attachment_info {
	402	struct bpf_prog *prog;
	403	u32 flags;
	404	};
	405
	406	struct netdev_bpf;
05296620 JK	407	void xdp_attachment_setup(struct xdp_attachment_info *info,
	408	struct netdev_bpf *bpf);
	409
89653987	410	#define DEV_MAP_BULK_SIZE XDP_BULK_QUEUE_SIZE
788f87ac	411
aecd67b6	412	#endif /* __LINUX_NET_XDP_H__ */