[deliverable/linux.git] / drivers / net / xen-netback / common.h

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation; or, when distributed
 * separately from the Linux kernel or incorporated into other
 * software packages, subject to the following license:
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this source file (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy, modify,
 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef __XEN_NETBACK__COMMON_H__
#define __XEN_NETBACK__COMMON_H__

#define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__

#include <linux/module.h>
#include <linux/interrupt.h>
#include <linux/slab.h>
#include <linux/ip.h>
#include <linux/in.h>
#include <linux/io.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/wait.h>
#include <linux/sched.h>

#include <xen/interface/io/netif.h>
#include <xen/interface/grant_table.h>
#include <xen/grant_table.h>
#include <xen/xenbus.h>
#include <linux/debugfs.h>

typedef unsigned int pending_ring_idx_t;
#define INVALID_PENDING_RING_IDX (~0U)

struct pending_tx_info {
	struct xen_netif_tx_request req; /* tx request */
	/* Callback data for released SKBs. The callback is always
	 * xenvif_zerocopy_callback, desc contains the pending_idx, which is
	 * also an index in pending_tx_info array. It is initialized in
	 * xenvif_alloc and it never changes.
	 * skb_shinfo(skb)->destructor_arg points to the first mapped slot's
	 * callback_struct in this array of struct pending_tx_info's, then ctx
	 * to the next, or NULL if there is no more slot for this skb.
	 * ubuf_to_vif is a helper which finds the struct xenvif from a pointer
	 * to this field.
	 */
	struct ubuf_info callback_struct;
};

#define XEN_NETIF_TX_RING_SIZE __CONST_RING_SIZE(xen_netif_tx, PAGE_SIZE)
#define XEN_NETIF_RX_RING_SIZE __CONST_RING_SIZE(xen_netif_rx, PAGE_SIZE)

struct xenvif_rx_meta {
	int id;
	int size;
	int gso_type;
	int gso_size;
};

#define GSO_BIT(type) \
	(1 << XEN_NETIF_GSO_TYPE_ ## type)

/* Discriminate from any valid pending_idx value. */
#define INVALID_PENDING_IDX 0xFFFF

#define MAX_BUFFER_OFFSET PAGE_SIZE

#define MAX_PENDING_REQS XEN_NETIF_TX_RING_SIZE

/* It's possible for an skb to have a maximal number of frags
 * but still be less than MAX_BUFFER_OFFSET in size. Thus the
 * worst-case number of copy operations is MAX_SKB_FRAGS per
 * ring slot.
 */
#define MAX_GRANT_COPY_OPS (MAX_SKB_FRAGS * XEN_NETIF_RX_RING_SIZE)

#define NETBACK_INVALID_HANDLE -1

/* To avoid confusion, we define XEN_NETBK_LEGACY_SLOTS_MAX indicating
 * the maximum slots a valid packet can use. Now this value is defined
 * to be XEN_NETIF_NR_SLOTS_MIN, which is supposed to be supported by
 * all backend.
 */
#define XEN_NETBK_LEGACY_SLOTS_MAX XEN_NETIF_NR_SLOTS_MIN

/* Queue name is interface name with "-qNNN" appended */
#define QUEUE_NAME_SIZE (IFNAMSIZ + 5)

/* IRQ name is queue name with "-tx" or "-rx" appended */
#define IRQ_NAME_SIZE (QUEUE_NAME_SIZE + 3)

struct xenvif;

struct xenvif_stats {
	/* Stats fields to be updated per-queue.
	 * A subset of struct net_device_stats that contains only the
	 * fields that are updated in netback.c for each queue.
	 */
	unsigned int rx_bytes;
	unsigned int rx_packets;
	unsigned int tx_bytes;
	unsigned int tx_packets;

	/* Additional stats used by xenvif */
	unsigned long rx_gso_checksum_fixup;
	unsigned long tx_zerocopy_sent;
	unsigned long tx_zerocopy_success;
	unsigned long tx_zerocopy_fail;
	unsigned long tx_frag_overflow;
};

struct xenvif_queue { /* Per-queue data for xenvif */
	unsigned int id; /* Queue ID, 0-based */
	char name[QUEUE_NAME_SIZE]; /* DEVNAME-qN */
	struct xenvif *vif; /* Parent VIF */

	/* Use NAPI for guest TX */
	struct napi_struct napi;
	/* When feature-split-event-channels = 0, tx_irq = rx_irq. */
	unsigned int tx_irq;
	/* Only used when feature-split-event-channels = 1 */
	char tx_irq_name[IRQ_NAME_SIZE]; /* DEVNAME-qN-tx */
	struct xen_netif_tx_back_ring tx;
	struct sk_buff_head tx_queue;
	struct page *mmap_pages[MAX_PENDING_REQS];
	pending_ring_idx_t pending_prod;
	pending_ring_idx_t pending_cons;
	u16 pending_ring[MAX_PENDING_REQS];
	struct pending_tx_info pending_tx_info[MAX_PENDING_REQS];
	grant_handle_t grant_tx_handle[MAX_PENDING_REQS];

	struct gnttab_copy tx_copy_ops[MAX_PENDING_REQS];
	struct gnttab_map_grant_ref tx_map_ops[MAX_PENDING_REQS];
	struct gnttab_unmap_grant_ref tx_unmap_ops[MAX_PENDING_REQS];
	/* passed to gnttab_[un]map_refs with pages under (un)mapping */
	struct page *pages_to_map[MAX_PENDING_REQS];
	struct page *pages_to_unmap[MAX_PENDING_REQS];

	/* This prevents zerocopy callbacks  to race over dealloc_ring */
	spinlock_t callback_lock;
	/* This prevents dealloc thread and NAPI instance to race over response
	 * creation and pending_ring in xenvif_idx_release. In xenvif_tx_err
	 * it only protect response creation
	 */
	spinlock_t response_lock;
	pending_ring_idx_t dealloc_prod;
	pending_ring_idx_t dealloc_cons;
	u16 dealloc_ring[MAX_PENDING_REQS];
	struct task_struct *dealloc_task;
	wait_queue_head_t dealloc_wq;
	atomic_t inflight_packets;

	/* Use kthread for guest RX */
	struct task_struct *task;
	wait_queue_head_t wq;
	/* When feature-split-event-channels = 0, tx_irq = rx_irq. */
	unsigned int rx_irq;
	/* Only used when feature-split-event-channels = 1 */
	char rx_irq_name[IRQ_NAME_SIZE]; /* DEVNAME-qN-rx */
	struct xen_netif_rx_back_ring rx;
	struct sk_buff_head rx_queue;

	unsigned int rx_queue_max;
	unsigned int rx_queue_len;
	unsigned long last_rx_time;
	bool stalled;

	struct gnttab_copy grant_copy_op[MAX_GRANT_COPY_OPS];

	/* We create one meta structure per ring request we consume, so
	 * the maximum number is the same as the ring size.
	 */
	struct xenvif_rx_meta meta[XEN_NETIF_RX_RING_SIZE];

	/* Transmit shaping: allow 'credit_bytes' every 'credit_usec'. */
	unsigned long   credit_bytes;
	unsigned long   credit_usec;
	unsigned long   remaining_credit;
	struct timer_list credit_timeout;
	u64 credit_window_start;

	/* Statistics */
	struct xenvif_stats stats;
};

/* Maximum number of Rx slots a to-guest packet may use, including the
 * slot needed for GSO meta-data.
 */
#define XEN_NETBK_RX_SLOTS_MAX (MAX_SKB_FRAGS + 1)

enum state_bit_shift {
	/* This bit marks that the vif is connected */
	VIF_STATUS_CONNECTED,
};

struct xenvif {
	/* Unique identifier for this interface. */
	domid_t          domid;
	unsigned int     handle;

	u8               fe_dev_addr[6];

	/* Frontend feature information. */
	int gso_mask;
	int gso_prefix_mask;

	u8 can_sg:1;
	u8 ip_csum:1;
	u8 ipv6_csum:1;

	/* Is this interface disabled? True when backend discovers
	 * frontend is rogue.
	 */
	bool disabled;
	unsigned long status;
	unsigned long drain_timeout;
	unsigned long stall_timeout;

	/* Queues */
	struct xenvif_queue *queues;
	unsigned int num_queues; /* active queues, resource allocated */
	unsigned int stalled_queues;

	spinlock_t lock;

#ifdef CONFIG_DEBUG_FS
	struct dentry *xenvif_dbg_root;
#endif

	/* Miscellaneous private stuff. */
	struct net_device *dev;
};

struct xenvif_rx_cb {
	unsigned long expires;
	int meta_slots_used;
};

#define XENVIF_RX_CB(skb) ((struct xenvif_rx_cb *)(skb)->cb)

static inline struct xenbus_device *xenvif_to_xenbus_device(struct xenvif *vif)
{
	return to_xenbus_device(vif->dev->dev.parent);
}

struct xenvif *xenvif_alloc(struct device *parent,
			    domid_t domid,
			    unsigned int handle);

int xenvif_init_queue(struct xenvif_queue *queue);
void xenvif_deinit_queue(struct xenvif_queue *queue);

int xenvif_connect(struct xenvif_queue *queue, unsigned long tx_ring_ref,
		   unsigned long rx_ring_ref, unsigned int tx_evtchn,
		   unsigned int rx_evtchn);
void xenvif_disconnect(struct xenvif *vif);
void xenvif_free(struct xenvif *vif);

int xenvif_xenbus_init(void);
void xenvif_xenbus_fini(void);

int xenvif_schedulable(struct xenvif *vif);

int xenvif_queue_stopped(struct xenvif_queue *queue);
void xenvif_wake_queue(struct xenvif_queue *queue);

/* (Un)Map communication rings. */
void xenvif_unmap_frontend_rings(struct xenvif_queue *queue);
int xenvif_map_frontend_rings(struct xenvif_queue *queue,
			      grant_ref_t tx_ring_ref,
			      grant_ref_t rx_ring_ref);

/* Check for SKBs from frontend and schedule backend processing */
void xenvif_napi_schedule_or_enable_events(struct xenvif_queue *queue);

/* Prevent the device from generating any further traffic. */
void xenvif_carrier_off(struct xenvif *vif);

int xenvif_tx_action(struct xenvif_queue *queue, int budget);

int xenvif_kthread_guest_rx(void *data);
void xenvif_kick_thread(struct xenvif_queue *queue);

int xenvif_dealloc_kthread(void *data);

void xenvif_rx_queue_tail(struct xenvif_queue *queue, struct sk_buff *skb);

/* Determine whether the needed number of slots (req) are available,
 * and set req_event if not.
 */
bool xenvif_rx_ring_slots_available(struct xenvif_queue *queue, int needed);

void xenvif_carrier_on(struct xenvif *vif);

/* Callback from stack when TX packet can be released */
void xenvif_zerocopy_callback(struct ubuf_info *ubuf, bool zerocopy_success);

/* Unmap a pending page and release it back to the guest */
void xenvif_idx_unmap(struct xenvif_queue *queue, u16 pending_idx);

static inline pending_ring_idx_t nr_pending_reqs(struct xenvif_queue *queue)
{
	return MAX_PENDING_REQS -
		queue->pending_prod + queue->pending_cons;
}

/* Callback from stack when TX packet can be released */
void xenvif_zerocopy_callback(struct ubuf_info *ubuf, bool zerocopy_success);

irqreturn_t xenvif_interrupt(int irq, void *dev_id);

extern bool separate_tx_rx_irq;

extern unsigned int rx_drain_timeout_msecs;
extern unsigned int rx_stall_timeout_msecs;
extern unsigned int xenvif_max_queues;

#ifdef CONFIG_DEBUG_FS
extern struct dentry *xen_netback_dbg_root;
#endif

void xenvif_skb_zerocopy_prepare(struct xenvif_queue *queue,
				 struct sk_buff *skb);
void xenvif_skb_zerocopy_complete(struct xenvif_queue *queue);

#endif /* __XEN_NETBACK__COMMON_H__ */
Commit	Line	Data
f942dc25 IC	1	/*
	2	* This program is free software; you can redistribute it and/or
	3	* modify it under the terms of the GNU General Public License version 2
	4	* as published by the Free Software Foundation; or, when distributed
	5	* separately from the Linux kernel or incorporated into other
	6	* software packages, subject to the following license:
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this source file (the "Software"), to deal in the Software without
	10	* restriction, including without limitation the rights to use, copy, modify,
	11	* merge, publish, distribute, sublicense, and/or sell copies of the Software,
	12	* and to permit persons to whom the Software is furnished to do so, subject to
	13	* the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
	23	* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
	24	* IN THE SOFTWARE.
	25	*/
	26
	27	#ifndef __XEN_NETBACK__COMMON_H__
	28	#define __XEN_NETBACK__COMMON_H__
	29
	30	#define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__
	31
	32	#include <linux/module.h>
	33	#include <linux/interrupt.h>
	34	#include <linux/slab.h>
	35	#include <linux/ip.h>
	36	#include <linux/in.h>
	37	#include <linux/io.h>
	38	#include <linux/netdevice.h>
	39	#include <linux/etherdevice.h>
	40	#include <linux/wait.h>
	41	#include <linux/sched.h>
	42
	43	#include <xen/interface/io/netif.h>
	44	#include <xen/interface/grant_table.h>
	45	#include <xen/grant_table.h>
	46	#include <xen/xenbus.h>
f51de243	47	#include <linux/debugfs.h>
f942dc25	48
b3f980bd WL	49	typedef unsigned int pending_ring_idx_t;
	50	#define INVALID_PENDING_RING_IDX (~0U)
	51
b3f980bd	52	struct pending_tx_info {
62bad319	53	struct xen_netif_tx_request req; /* tx request */
f53c3fe8 ZK	54	/* Callback data for released SKBs. The callback is always
	55	* xenvif_zerocopy_callback, desc contains the pending_idx, which is
	56	* also an index in pending_tx_info array. It is initialized in
	57	* xenvif_alloc and it never changes.
	58	* skb_shinfo(skb)->destructor_arg points to the first mapped slot's
	59	* callback_struct in this array of struct pending_tx_info's, then ctx
	60	* to the next, or NULL if there is no more slot for this skb.
	61	* ubuf_to_vif is a helper which finds the struct xenvif from a pointer
	62	* to this field.
	63	*/
	64	struct ubuf_info callback_struct;
b3f980bd WL	65	};
	66
	67	#define XEN_NETIF_TX_RING_SIZE __CONST_RING_SIZE(xen_netif_tx, PAGE_SIZE)
	68	#define XEN_NETIF_RX_RING_SIZE __CONST_RING_SIZE(xen_netif_rx, PAGE_SIZE)
	69
	70	struct xenvif_rx_meta {
	71	int id;
	72	int size;
82cada22	73	int gso_type;
b3f980bd WL	74	int gso_size;
	75	};
	76
82cada22 PD	77	#define GSO_BIT(type) \
	78	(1 << XEN_NETIF_GSO_TYPE_ ## type)
	79
b3f980bd WL	80	/* Discriminate from any valid pending_idx value. */
	81	#define INVALID_PENDING_IDX 0xFFFF
	82
	83	#define MAX_BUFFER_OFFSET PAGE_SIZE
	84
869b9b19	85	#define MAX_PENDING_REQS XEN_NETIF_TX_RING_SIZE
f942dc25	86
ac3d5ac2 PD	87	/* It's possible for an skb to have a maximal number of frags
	88	* but still be less than MAX_BUFFER_OFFSET in size. Thus the
	89	* worst-case number of copy operations is MAX_SKB_FRAGS per
	90	* ring slot.
	91	*/
	92	#define MAX_GRANT_COPY_OPS (MAX_SKB_FRAGS * XEN_NETIF_RX_RING_SIZE)
	93
121fa4b7 ZK	94	#define NETBACK_INVALID_HANDLE -1
	95
	96	/* To avoid confusion, we define XEN_NETBK_LEGACY_SLOTS_MAX indicating
	97	* the maximum slots a valid packet can use. Now this value is defined
	98	* to be XEN_NETIF_NR_SLOTS_MIN, which is supposed to be supported by
	99	* all backend.
	100	*/
	101	#define XEN_NETBK_LEGACY_SLOTS_MAX XEN_NETIF_NR_SLOTS_MIN
	102
e9ce7cb6 WL	103	/* Queue name is interface name with "-qNNN" appended */
e9ce7cb6 WL	104	#define QUEUE_NAME_SIZE (IFNAMSIZ + 5)
f942dc25	105
e9ce7cb6 WL	106	/* IRQ name is queue name with "-tx" or "-rx" appended */
	107	#define IRQ_NAME_SIZE (QUEUE_NAME_SIZE + 3)
	108
	109	struct xenvif;
	110
	111	struct xenvif_stats {
	112	/* Stats fields to be updated per-queue.
	113	* A subset of struct net_device_stats that contains only the
	114	* fields that are updated in netback.c for each queue.
e9d8b2c2	115	*/
e9ce7cb6 WL	116	unsigned int rx_bytes;
	117	unsigned int rx_packets;
	118	unsigned int tx_bytes;
	119	unsigned int tx_packets;
	120
	121	/* Additional stats used by xenvif */
	122	unsigned long rx_gso_checksum_fixup;
	123	unsigned long tx_zerocopy_sent;
	124	unsigned long tx_zerocopy_success;
	125	unsigned long tx_zerocopy_fail;
	126	unsigned long tx_frag_overflow;
	127	};
	128
	129	struct xenvif_queue { /* Per-queue data for xenvif */
	130	unsigned int id; /* Queue ID, 0-based */
	131	char name[QUEUE_NAME_SIZE]; /* DEVNAME-qN */
	132	struct xenvif vif; / Parent VIF */
e9d8b2c2	133
b3f980bd WL	134	/* Use NAPI for guest TX */
	135	struct napi_struct napi;
	136	/* When feature-split-event-channels = 0, tx_irq = rx_irq. */
	137	unsigned int tx_irq;
	138	/* Only used when feature-split-event-channels = 1 */
e9ce7cb6	139	char tx_irq_name[IRQ_NAME_SIZE]; /* DEVNAME-qN-tx */
b3f980bd WL	140	struct xen_netif_tx_back_ring tx;
	141	struct sk_buff_head tx_queue;
	142	struct page *mmap_pages[MAX_PENDING_REQS];
	143	pending_ring_idx_t pending_prod;
	144	pending_ring_idx_t pending_cons;
	145	u16 pending_ring[MAX_PENDING_REQS];
	146	struct pending_tx_info pending_tx_info[MAX_PENDING_REQS];
f53c3fe8	147	grant_handle_t grant_tx_handle[MAX_PENDING_REQS];
b3f980bd	148
bdab8275	149	struct gnttab_copy tx_copy_ops[MAX_PENDING_REQS];
f53c3fe8 ZK	150	struct gnttab_map_grant_ref tx_map_ops[MAX_PENDING_REQS];
	151	struct gnttab_unmap_grant_ref tx_unmap_ops[MAX_PENDING_REQS];
	152	/* passed to gnttab_[un]map_refs with pages under (un)mapping */
	153	struct page *pages_to_map[MAX_PENDING_REQS];
	154	struct page *pages_to_unmap[MAX_PENDING_REQS];
	155
	156	/* This prevents zerocopy callbacks to race over dealloc_ring */
	157	spinlock_t callback_lock;
	158	/* This prevents dealloc thread and NAPI instance to race over response
	159	* creation and pending_ring in xenvif_idx_release. In xenvif_tx_err
	160	* it only protect response creation
	161	*/
	162	spinlock_t response_lock;
	163	pending_ring_idx_t dealloc_prod;
	164	pending_ring_idx_t dealloc_cons;
	165	u16 dealloc_ring[MAX_PENDING_REQS];
	166	struct task_struct *dealloc_task;
	167	wait_queue_head_t dealloc_wq;
a64bd934	168	atomic_t inflight_packets;
f942dc25	169
b3f980bd WL	170	/* Use kthread for guest RX */
	171	struct task_struct *task;
	172	wait_queue_head_t wq;
e1f00a69	173	/* When feature-split-event-channels = 0, tx_irq = rx_irq. */
e1f00a69 WL	174	unsigned int rx_irq;
e1f00a69 WL	175	/* Only used when feature-split-event-channels = 1 */
e9ce7cb6	176	char rx_irq_name[IRQ_NAME_SIZE]; /* DEVNAME-qN-rx */
b3f980bd WL	177	struct xen_netif_rx_back_ring rx;
b3f980bd WL	178	struct sk_buff_head rx_queue;
09350788	179
f48da8b1 DV	180	unsigned int rx_queue_max;
f48da8b1 DV	181	unsigned int rx_queue_len;
ecf08d2d DV	182	unsigned long last_rx_time;
ecf08d2d DV	183	bool stalled;
b3f980bd	184
a55d9766	185	struct gnttab_copy grant_copy_op[MAX_GRANT_COPY_OPS];
f942dc25	186
ac3d5ac2 PD	187	/* We create one meta structure per ring request we consume, so
	188	* the maximum number is the same as the ring size.
	189	*/
	190	struct xenvif_rx_meta meta[XEN_NETIF_RX_RING_SIZE];
b3f980bd	191
e9ce7cb6 WL	192	/* Transmit shaping: allow 'credit_bytes' every 'credit_usec'. */
	193	unsigned long credit_bytes;
	194	unsigned long credit_usec;
	195	unsigned long remaining_credit;
	196	struct timer_list credit_timeout;
	197	u64 credit_window_start;
	198
	199	/* Statistics */
	200	struct xenvif_stats stats;
	201	};
	202
f48da8b1 DV	203	/* Maximum number of Rx slots a to-guest packet may use, including the
	204	* slot needed for GSO meta-data.
	205	*/
	206	#define XEN_NETBK_RX_SLOTS_MAX (MAX_SKB_FRAGS + 1)
	207
3d1af1df ZK	208	enum state_bit_shift {
3d1af1df ZK	209	/* This bit marks that the vif is connected */
f34a4cf9	210	VIF_STATUS_CONNECTED,
3d1af1df ZK	211	};
3d1af1df ZK	212
e9ce7cb6 WL	213	struct xenvif {
	214	/* Unique identifier for this interface. */
	215	domid_t domid;
	216	unsigned int handle;
	217
b3f980bd	218	u8 fe_dev_addr[6];
f942dc25	219
f942dc25	220	/* Frontend feature information. */
82cada22 PD	221	int gso_mask;
	222	int gso_prefix_mask;
	223
f942dc25	224	u8 can_sg:1;
146c8a77 PD	225	u8 ip_csum:1;
146c8a77 PD	226	u8 ipv6_csum:1;
f942dc25	227
e9ce7cb6 WL	228	/* Is this interface disabled? True when backend discovers
	229	* frontend is rogue.
	230	*/
	231	bool disabled;
3d1af1df	232	unsigned long status;
26c0e102 DV	233	unsigned long drain_timeout;
26c0e102 DV	234	unsigned long stall_timeout;
f942dc25	235
e9ce7cb6 WL	236	/* Queues */
e9ce7cb6 WL	237	struct xenvif_queue *queues;
f7b50c4e	238	unsigned int num_queues; /* active queues, resource allocated */
ecf08d2d DV	239	unsigned int stalled_queues;
	240
	241	spinlock_t lock;
f942dc25	242
f51de243 ZK	243	#ifdef CONFIG_DEBUG_FS
	244	struct dentry *xenvif_dbg_root;
	245	#endif
	246
f942dc25	247	/* Miscellaneous private stuff. */
f942dc25	248	struct net_device *dev;
f942dc25 IC	249	};
f942dc25 IC	250
f48da8b1 DV	251	struct xenvif_rx_cb {
	252	unsigned long expires;
	253	int meta_slots_used;
f48da8b1 DV	254	};
	255
	256	#define XENVIF_RX_CB(skb) ((struct xenvif_rx_cb *)(skb)->cb)
	257
c9d63699 DV	258	static inline struct xenbus_device xenvif_to_xenbus_device(struct xenvif vif)
	259	{
	260	return to_xenbus_device(vif->dev->dev.parent);
	261	}
	262
f942dc25 IC	263	struct xenvif xenvif_alloc(struct device parent,
	264	domid_t domid,
	265	unsigned int handle);
	266
e9ce7cb6	267	int xenvif_init_queue(struct xenvif_queue *queue);
8d3d53b3	268	void xenvif_deinit_queue(struct xenvif_queue *queue);
e9ce7cb6 WL	269
e9ce7cb6 WL	270	int xenvif_connect(struct xenvif_queue *queue, unsigned long tx_ring_ref,
e1f00a69 WL	271	unsigned long rx_ring_ref, unsigned int tx_evtchn,
e1f00a69 WL	272	unsigned int rx_evtchn);
f942dc25	273	void xenvif_disconnect(struct xenvif *vif);
279f438e	274	void xenvif_free(struct xenvif *vif);
f942dc25	275
f942dc25	276	int xenvif_xenbus_init(void);
b103f358	277	void xenvif_xenbus_fini(void);
f942dc25 IC	278
	279	int xenvif_schedulable(struct xenvif *vif);
	280
e9ce7cb6 WL	281	int xenvif_queue_stopped(struct xenvif_queue *queue);
e9ce7cb6 WL	282	void xenvif_wake_queue(struct xenvif_queue *queue);
f942dc25 IC	283
f942dc25 IC	284	/* (Un)Map communication rings. */
e9ce7cb6 WL	285	void xenvif_unmap_frontend_rings(struct xenvif_queue *queue);
e9ce7cb6 WL	286	int xenvif_map_frontend_rings(struct xenvif_queue *queue,
7376419a WL	287	grant_ref_t tx_ring_ref,
7376419a WL	288	grant_ref_t rx_ring_ref);
f942dc25	289
f942dc25	290	/* Check for SKBs from frontend and schedule backend processing */
e9ce7cb6	291	void xenvif_napi_schedule_or_enable_events(struct xenvif_queue *queue);
f942dc25	292
48856286 IC	293	/* Prevent the device from generating any further traffic. */
	294	void xenvif_carrier_off(struct xenvif *vif);
	295
e9ce7cb6	296	int xenvif_tx_action(struct xenvif_queue *queue, int budget);
b3f980bd	297
121fa4b7	298	int xenvif_kthread_guest_rx(void *data);
e9ce7cb6	299	void xenvif_kick_thread(struct xenvif_queue *queue);
ca2f09f2	300
f53c3fe8 ZK	301	int xenvif_dealloc_kthread(void *data);
f53c3fe8 ZK	302
f48da8b1 DV	303	void xenvif_rx_queue_tail(struct xenvif_queue queue, struct sk_buff skb);
f48da8b1 DV	304
ca2f09f2 PD	305	/* Determine whether the needed number of slots (req) are available,
	306	* and set req_event if not.
	307	*/
e9ce7cb6	308	bool xenvif_rx_ring_slots_available(struct xenvif_queue *queue, int needed);
ca2f09f2	309
e9ce7cb6	310	void xenvif_carrier_on(struct xenvif *vif);
b3f980bd	311
f53c3fe8 ZK	312	/* Callback from stack when TX packet can be released */
	313	void xenvif_zerocopy_callback(struct ubuf_info *ubuf, bool zerocopy_success);
	314
	315	/* Unmap a pending page and release it back to the guest */
e9ce7cb6	316	void xenvif_idx_unmap(struct xenvif_queue *queue, u16 pending_idx);
f53c3fe8	317
e9ce7cb6	318	static inline pending_ring_idx_t nr_pending_reqs(struct xenvif_queue *queue)
121fa4b7 ZK	319	{
121fa4b7 ZK	320	return MAX_PENDING_REQS -
e9ce7cb6	321	queue->pending_prod + queue->pending_cons;
121fa4b7 ZK	322	}
121fa4b7 ZK	323
3e2234b3 ZK	324	/* Callback from stack when TX packet can be released */
	325	void xenvif_zerocopy_callback(struct ubuf_info *ubuf, bool zerocopy_success);
	326
f51de243 ZK	327	irqreturn_t xenvif_interrupt(int irq, void *dev_id);
f51de243 ZK	328
e1f00a69 WL	329	extern bool separate_tx_rx_irq;
e1f00a69 WL	330
09350788	331	extern unsigned int rx_drain_timeout_msecs;
26c0e102	332	extern unsigned int rx_stall_timeout_msecs;
8d3d53b3	333	extern unsigned int xenvif_max_queues;
09350788	334
f51de243 ZK	335	#ifdef CONFIG_DEBUG_FS
	336	extern struct dentry *xen_netback_dbg_root;
	337	#endif
	338
a64bd934 WL	339	void xenvif_skb_zerocopy_prepare(struct xenvif_queue *queue,
	340	struct sk_buff *skb);
	341	void xenvif_skb_zerocopy_complete(struct xenvif_queue *queue);
	342
f942dc25	343	#endif /* __XEN_NETBACK__COMMON_H__ */