Loading...
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>
47#include <xen/page.h>
48#include <linux/debugfs.h>
49
50typedef unsigned int pending_ring_idx_t;
51
52struct pending_tx_info {
53 struct xen_netif_tx_request req; /* tx request */
54 unsigned int extra_count;
55 /* Callback data for released SKBs. The callback is always
56 * xenvif_zerocopy_callback, desc contains the pending_idx, which is
57 * also an index in pending_tx_info array. It is initialized in
58 * xenvif_alloc and it never changes.
59 * skb_shinfo(skb)->destructor_arg points to the first mapped slot's
60 * callback_struct in this array of struct pending_tx_info's, then ctx
61 * to the next, or NULL if there is no more slot for this skb.
62 * ubuf_to_vif is a helper which finds the struct xenvif from a pointer
63 * to this field.
64 */
65 struct ubuf_info_msgzc callback_struct;
66};
67
68#define XEN_NETIF_TX_RING_SIZE __CONST_RING_SIZE(xen_netif_tx, XEN_PAGE_SIZE)
69#define XEN_NETIF_RX_RING_SIZE __CONST_RING_SIZE(xen_netif_rx, XEN_PAGE_SIZE)
70
71struct xenvif_rx_meta {
72 int id;
73 int size;
74 int gso_type;
75 int gso_size;
76};
77
78#define GSO_BIT(type) \
79 (1 << XEN_NETIF_GSO_TYPE_ ## type)
80
81/* Discriminate from any valid pending_idx value. */
82#define INVALID_PENDING_IDX 0xFFFF
83
84#define MAX_PENDING_REQS XEN_NETIF_TX_RING_SIZE
85
86/* The maximum number of frags is derived from the size of a grant (same
87 * as a Xen page size for now).
88 */
89#define MAX_XEN_SKB_FRAGS (65536 / XEN_PAGE_SIZE + 1)
90
91#define NETBACK_INVALID_HANDLE -1
92
93/* To avoid confusion, we define XEN_NETBK_LEGACY_SLOTS_MAX indicating
94 * the maximum slots a valid packet can use. Now this value is defined
95 * to be XEN_NETIF_NR_SLOTS_MIN, which is supposed to be supported by
96 * all backend.
97 */
98#define XEN_NETBK_LEGACY_SLOTS_MAX XEN_NETIF_NR_SLOTS_MIN
99
100/* Queue name is interface name with "-qNNN" appended */
101#define QUEUE_NAME_SIZE (IFNAMSIZ + 5)
102
103/* IRQ name is queue name with "-tx" or "-rx" appended */
104#define IRQ_NAME_SIZE (QUEUE_NAME_SIZE + 3)
105
106struct xenvif;
107
108struct xenvif_stats {
109 /* Stats fields to be updated per-queue.
110 * A subset of struct net_device_stats that contains only the
111 * fields that are updated in netback.c for each queue.
112 */
113 u64 rx_bytes;
114 u64 rx_packets;
115 u64 tx_bytes;
116 u64 tx_packets;
117
118 /* Additional stats used by xenvif */
119 unsigned long rx_gso_checksum_fixup;
120 unsigned long tx_zerocopy_sent;
121 unsigned long tx_zerocopy_success;
122 unsigned long tx_zerocopy_fail;
123 unsigned long tx_frag_overflow;
124};
125
126#define COPY_BATCH_SIZE 64
127
128struct xenvif_copy_state {
129 struct gnttab_copy op[COPY_BATCH_SIZE];
130 RING_IDX idx[COPY_BATCH_SIZE];
131 unsigned int num;
132 struct sk_buff_head *completed;
133};
134
135struct xenvif_queue { /* Per-queue data for xenvif */
136 unsigned int id; /* Queue ID, 0-based */
137 char name[QUEUE_NAME_SIZE]; /* DEVNAME-qN */
138 struct xenvif *vif; /* Parent VIF */
139
140 /*
141 * TX/RX common EOI handling.
142 * When feature-split-event-channels = 0, interrupt handler sets
143 * NETBK_COMMON_EOI, otherwise NETBK_RX_EOI and NETBK_TX_EOI are set
144 * by the RX and TX interrupt handlers.
145 * RX and TX handler threads will issue an EOI when either
146 * NETBK_COMMON_EOI or their specific bits (NETBK_RX_EOI or
147 * NETBK_TX_EOI) are set and they will reset those bits.
148 */
149 atomic_t eoi_pending;
150#define NETBK_RX_EOI 0x01
151#define NETBK_TX_EOI 0x02
152#define NETBK_COMMON_EOI 0x04
153
154 /* Use NAPI for guest TX */
155 struct napi_struct napi;
156 /* When feature-split-event-channels = 0, tx_irq = rx_irq. */
157 unsigned int tx_irq;
158 /* Only used when feature-split-event-channels = 1 */
159 char tx_irq_name[IRQ_NAME_SIZE]; /* DEVNAME-qN-tx */
160 struct xen_netif_tx_back_ring tx;
161 struct sk_buff_head tx_queue;
162 struct page *mmap_pages[MAX_PENDING_REQS];
163 pending_ring_idx_t pending_prod;
164 pending_ring_idx_t pending_cons;
165 u16 pending_ring[MAX_PENDING_REQS];
166 struct pending_tx_info pending_tx_info[MAX_PENDING_REQS];
167 grant_handle_t grant_tx_handle[MAX_PENDING_REQS];
168
169 struct gnttab_copy tx_copy_ops[2 * MAX_PENDING_REQS];
170 struct gnttab_map_grant_ref tx_map_ops[MAX_PENDING_REQS];
171 struct gnttab_unmap_grant_ref tx_unmap_ops[MAX_PENDING_REQS];
172 /* passed to gnttab_[un]map_refs with pages under (un)mapping */
173 struct page *pages_to_map[MAX_PENDING_REQS];
174 struct page *pages_to_unmap[MAX_PENDING_REQS];
175
176 /* This prevents zerocopy callbacks to race over dealloc_ring */
177 spinlock_t callback_lock;
178 /* This prevents dealloc thread and NAPI instance to race over response
179 * creation and pending_ring in xenvif_idx_release. In xenvif_tx_err
180 * it only protect response creation
181 */
182 spinlock_t response_lock;
183 pending_ring_idx_t dealloc_prod;
184 pending_ring_idx_t dealloc_cons;
185 u16 dealloc_ring[MAX_PENDING_REQS];
186 struct task_struct *dealloc_task;
187 wait_queue_head_t dealloc_wq;
188 atomic_t inflight_packets;
189
190 /* Use kthread for guest RX */
191 struct task_struct *task;
192 wait_queue_head_t wq;
193 /* When feature-split-event-channels = 0, tx_irq = rx_irq. */
194 unsigned int rx_irq;
195 /* Only used when feature-split-event-channels = 1 */
196 char rx_irq_name[IRQ_NAME_SIZE]; /* DEVNAME-qN-rx */
197 struct xen_netif_rx_back_ring rx;
198 struct sk_buff_head rx_queue;
199
200 unsigned int rx_queue_max;
201 unsigned int rx_queue_len;
202 unsigned long last_rx_time;
203 unsigned int rx_slots_needed;
204 bool stalled;
205
206 struct xenvif_copy_state rx_copy;
207
208 /* Transmit shaping: allow 'credit_bytes' every 'credit_usec'. */
209 unsigned long credit_bytes;
210 unsigned long credit_usec;
211 unsigned long remaining_credit;
212 struct timer_list credit_timeout;
213 u64 credit_window_start;
214 bool rate_limited;
215
216 /* Statistics */
217 struct xenvif_stats stats;
218};
219
220enum state_bit_shift {
221 /* This bit marks that the vif is connected */
222 VIF_STATUS_CONNECTED,
223};
224
225struct xenvif_mcast_addr {
226 struct list_head entry;
227 struct rcu_head rcu;
228 u8 addr[6];
229};
230
231#define XEN_NETBK_MCAST_MAX 64
232
233#define XEN_NETBK_MAX_HASH_KEY_SIZE 40
234#define XEN_NETBK_MAX_HASH_MAPPING_SIZE 128
235#define XEN_NETBK_HASH_TAG_SIZE 40
236
237struct xenvif_hash_cache_entry {
238 struct list_head link;
239 struct rcu_head rcu;
240 u8 tag[XEN_NETBK_HASH_TAG_SIZE];
241 unsigned int len;
242 u32 val;
243 int seq;
244};
245
246struct xenvif_hash_cache {
247 spinlock_t lock;
248 struct list_head list;
249 unsigned int count;
250 atomic_t seq;
251};
252
253struct xenvif_hash {
254 unsigned int alg;
255 u32 flags;
256 bool mapping_sel;
257 u8 key[XEN_NETBK_MAX_HASH_KEY_SIZE];
258 u32 mapping[2][XEN_NETBK_MAX_HASH_MAPPING_SIZE];
259 unsigned int size;
260 struct xenvif_hash_cache cache;
261};
262
263struct backend_info {
264 struct xenbus_device *dev;
265 struct xenvif *vif;
266
267 /* This is the state that will be reflected in xenstore when any
268 * active hotplug script completes.
269 */
270 enum xenbus_state state;
271
272 enum xenbus_state frontend_state;
273 struct xenbus_watch hotplug_status_watch;
274 u8 have_hotplug_status_watch:1;
275
276 const char *hotplug_script;
277};
278
279struct xenvif {
280 /* Unique identifier for this interface. */
281 domid_t domid;
282 unsigned int handle;
283
284 u8 fe_dev_addr[6];
285 struct list_head fe_mcast_addr;
286 unsigned int fe_mcast_count;
287
288 /* Frontend feature information. */
289 int gso_mask;
290
291 u8 can_sg:1;
292 u8 ip_csum:1;
293 u8 ipv6_csum:1;
294 u8 multicast_control:1;
295
296 /* headroom requested by xen-netfront */
297 u16 xdp_headroom;
298
299 /* Is this interface disabled? True when backend discovers
300 * frontend is rogue.
301 */
302 bool disabled;
303 unsigned long status;
304 unsigned long drain_timeout;
305 unsigned long stall_timeout;
306
307 /* Queues */
308 struct xenvif_queue *queues;
309 unsigned int num_queues; /* active queues, resource allocated */
310 unsigned int stalled_queues;
311
312 struct xenvif_hash hash;
313
314 struct xenbus_watch credit_watch;
315 struct xenbus_watch mcast_ctrl_watch;
316
317 struct backend_info *be;
318
319 spinlock_t lock;
320
321#ifdef CONFIG_DEBUG_FS
322 struct dentry *xenvif_dbg_root;
323#endif
324
325 struct xen_netif_ctrl_back_ring ctrl;
326 unsigned int ctrl_irq;
327
328 /* Miscellaneous private stuff. */
329 struct net_device *dev;
330};
331
332struct xenvif_rx_cb {
333 unsigned long expires;
334 int meta_slots_used;
335};
336
337#define XENVIF_RX_CB(skb) ((struct xenvif_rx_cb *)(skb)->cb)
338
339static inline struct xenbus_device *xenvif_to_xenbus_device(struct xenvif *vif)
340{
341 return to_xenbus_device(vif->dev->dev.parent);
342}
343
344void xenvif_tx_credit_callback(struct timer_list *t);
345
346struct xenvif *xenvif_alloc(struct device *parent,
347 domid_t domid,
348 unsigned int handle);
349
350int xenvif_init_queue(struct xenvif_queue *queue);
351void xenvif_deinit_queue(struct xenvif_queue *queue);
352
353int xenvif_connect_data(struct xenvif_queue *queue,
354 unsigned long tx_ring_ref,
355 unsigned long rx_ring_ref,
356 unsigned int tx_evtchn,
357 unsigned int rx_evtchn);
358void xenvif_disconnect_data(struct xenvif *vif);
359int xenvif_connect_ctrl(struct xenvif *vif, grant_ref_t ring_ref,
360 unsigned int evtchn);
361void xenvif_disconnect_ctrl(struct xenvif *vif);
362void xenvif_free(struct xenvif *vif);
363
364int xenvif_xenbus_init(void);
365void xenvif_xenbus_fini(void);
366
367/* (Un)Map communication rings. */
368void xenvif_unmap_frontend_data_rings(struct xenvif_queue *queue);
369int xenvif_map_frontend_data_rings(struct xenvif_queue *queue,
370 grant_ref_t tx_ring_ref,
371 grant_ref_t rx_ring_ref);
372
373/* Check for SKBs from frontend and schedule backend processing */
374void xenvif_napi_schedule_or_enable_events(struct xenvif_queue *queue);
375
376/* Prevent the device from generating any further traffic. */
377void xenvif_carrier_off(struct xenvif *vif);
378
379int xenvif_tx_action(struct xenvif_queue *queue, int budget);
380
381int xenvif_kthread_guest_rx(void *data);
382void xenvif_kick_thread(struct xenvif_queue *queue);
383
384int xenvif_dealloc_kthread(void *data);
385
386irqreturn_t xenvif_ctrl_irq_fn(int irq, void *data);
387
388bool xenvif_have_rx_work(struct xenvif_queue *queue, bool test_kthread);
389bool xenvif_rx_queue_tail(struct xenvif_queue *queue, struct sk_buff *skb);
390
391void xenvif_carrier_on(struct xenvif *vif);
392
393/* Callback from stack when TX packet can be released */
394void xenvif_zerocopy_callback(struct sk_buff *skb, struct ubuf_info *ubuf,
395 bool zerocopy_success);
396
397static inline pending_ring_idx_t nr_pending_reqs(struct xenvif_queue *queue)
398{
399 return MAX_PENDING_REQS -
400 queue->pending_prod + queue->pending_cons;
401}
402
403irqreturn_t xenvif_interrupt(int irq, void *dev_id);
404
405extern bool separate_tx_rx_irq;
406extern bool provides_xdp_headroom;
407
408extern unsigned int rx_drain_timeout_msecs;
409extern unsigned int rx_stall_timeout_msecs;
410extern unsigned int xenvif_max_queues;
411extern unsigned int xenvif_hash_cache_size;
412
413#ifdef CONFIG_DEBUG_FS
414extern struct dentry *xen_netback_dbg_root;
415#endif
416
417void xenvif_skb_zerocopy_prepare(struct xenvif_queue *queue,
418 struct sk_buff *skb);
419void xenvif_skb_zerocopy_complete(struct xenvif_queue *queue);
420
421/* Multicast control */
422bool xenvif_mcast_match(struct xenvif *vif, const u8 *addr);
423void xenvif_mcast_addr_list_free(struct xenvif *vif);
424
425/* Hash */
426void xenvif_init_hash(struct xenvif *vif);
427void xenvif_deinit_hash(struct xenvif *vif);
428
429u32 xenvif_set_hash_alg(struct xenvif *vif, u32 alg);
430u32 xenvif_get_hash_flags(struct xenvif *vif, u32 *flags);
431u32 xenvif_set_hash_flags(struct xenvif *vif, u32 flags);
432u32 xenvif_set_hash_key(struct xenvif *vif, u32 gref, u32 len);
433u32 xenvif_set_hash_mapping_size(struct xenvif *vif, u32 size);
434u32 xenvif_set_hash_mapping(struct xenvif *vif, u32 gref, u32 len,
435 u32 off);
436
437void xenvif_set_skb_hash(struct xenvif *vif, struct sk_buff *skb);
438
439#ifdef CONFIG_DEBUG_FS
440void xenvif_dump_hash_info(struct xenvif *vif, struct seq_file *m);
441#endif
442
443#endif /* __XEN_NETBACK__COMMON_H__ */
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>
47#include <xen/page.h>
48#include <linux/debugfs.h>
49
50typedef unsigned int pending_ring_idx_t;
51#define INVALID_PENDING_RING_IDX (~0U)
52
53struct pending_tx_info {
54 struct xen_netif_tx_request req; /* tx request */
55 unsigned int extra_count;
56 /* Callback data for released SKBs. The callback is always
57 * xenvif_zerocopy_callback, desc contains the pending_idx, which is
58 * also an index in pending_tx_info array. It is initialized in
59 * xenvif_alloc and it never changes.
60 * skb_shinfo(skb)->destructor_arg points to the first mapped slot's
61 * callback_struct in this array of struct pending_tx_info's, then ctx
62 * to the next, or NULL if there is no more slot for this skb.
63 * ubuf_to_vif is a helper which finds the struct xenvif from a pointer
64 * to this field.
65 */
66 struct ubuf_info callback_struct;
67};
68
69#define XEN_NETIF_TX_RING_SIZE __CONST_RING_SIZE(xen_netif_tx, XEN_PAGE_SIZE)
70#define XEN_NETIF_RX_RING_SIZE __CONST_RING_SIZE(xen_netif_rx, XEN_PAGE_SIZE)
71
72struct xenvif_rx_meta {
73 int id;
74 int size;
75 int gso_type;
76 int gso_size;
77};
78
79#define GSO_BIT(type) \
80 (1 << XEN_NETIF_GSO_TYPE_ ## type)
81
82/* Discriminate from any valid pending_idx value. */
83#define INVALID_PENDING_IDX 0xFFFF
84
85#define MAX_BUFFER_OFFSET XEN_PAGE_SIZE
86
87#define MAX_PENDING_REQS XEN_NETIF_TX_RING_SIZE
88
89/* The maximum number of frags is derived from the size of a grant (same
90 * as a Xen page size for now).
91 */
92#define MAX_XEN_SKB_FRAGS (65536 / XEN_PAGE_SIZE + 1)
93
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
103/* Queue name is interface name with "-qNNN" appended */
104#define QUEUE_NAME_SIZE (IFNAMSIZ + 5)
105
106/* IRQ name is queue name with "-tx" or "-rx" appended */
107#define IRQ_NAME_SIZE (QUEUE_NAME_SIZE + 3)
108
109struct xenvif;
110
111struct 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.
115 */
116 u64 rx_bytes;
117 u64 rx_packets;
118 u64 tx_bytes;
119 u64 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#define COPY_BATCH_SIZE 64
130
131struct xenvif_copy_state {
132 struct gnttab_copy op[COPY_BATCH_SIZE];
133 RING_IDX idx[COPY_BATCH_SIZE];
134 unsigned int num;
135 struct sk_buff_head *completed;
136};
137
138struct xenvif_queue { /* Per-queue data for xenvif */
139 unsigned int id; /* Queue ID, 0-based */
140 char name[QUEUE_NAME_SIZE]; /* DEVNAME-qN */
141 struct xenvif *vif; /* Parent VIF */
142
143 /* Use NAPI for guest TX */
144 struct napi_struct napi;
145 /* When feature-split-event-channels = 0, tx_irq = rx_irq. */
146 unsigned int tx_irq;
147 /* Only used when feature-split-event-channels = 1 */
148 char tx_irq_name[IRQ_NAME_SIZE]; /* DEVNAME-qN-tx */
149 struct xen_netif_tx_back_ring tx;
150 struct sk_buff_head tx_queue;
151 struct page *mmap_pages[MAX_PENDING_REQS];
152 pending_ring_idx_t pending_prod;
153 pending_ring_idx_t pending_cons;
154 u16 pending_ring[MAX_PENDING_REQS];
155 struct pending_tx_info pending_tx_info[MAX_PENDING_REQS];
156 grant_handle_t grant_tx_handle[MAX_PENDING_REQS];
157
158 struct gnttab_copy tx_copy_ops[MAX_PENDING_REQS];
159 struct gnttab_map_grant_ref tx_map_ops[MAX_PENDING_REQS];
160 struct gnttab_unmap_grant_ref tx_unmap_ops[MAX_PENDING_REQS];
161 /* passed to gnttab_[un]map_refs with pages under (un)mapping */
162 struct page *pages_to_map[MAX_PENDING_REQS];
163 struct page *pages_to_unmap[MAX_PENDING_REQS];
164
165 /* This prevents zerocopy callbacks to race over dealloc_ring */
166 spinlock_t callback_lock;
167 /* This prevents dealloc thread and NAPI instance to race over response
168 * creation and pending_ring in xenvif_idx_release. In xenvif_tx_err
169 * it only protect response creation
170 */
171 spinlock_t response_lock;
172 pending_ring_idx_t dealloc_prod;
173 pending_ring_idx_t dealloc_cons;
174 u16 dealloc_ring[MAX_PENDING_REQS];
175 struct task_struct *dealloc_task;
176 wait_queue_head_t dealloc_wq;
177 atomic_t inflight_packets;
178
179 /* Use kthread for guest RX */
180 struct task_struct *task;
181 wait_queue_head_t wq;
182 /* When feature-split-event-channels = 0, tx_irq = rx_irq. */
183 unsigned int rx_irq;
184 /* Only used when feature-split-event-channels = 1 */
185 char rx_irq_name[IRQ_NAME_SIZE]; /* DEVNAME-qN-rx */
186 struct xen_netif_rx_back_ring rx;
187 struct sk_buff_head rx_queue;
188
189 unsigned int rx_queue_max;
190 unsigned int rx_queue_len;
191 unsigned long last_rx_time;
192 bool stalled;
193
194 struct xenvif_copy_state rx_copy;
195
196 /* Transmit shaping: allow 'credit_bytes' every 'credit_usec'. */
197 unsigned long credit_bytes;
198 unsigned long credit_usec;
199 unsigned long remaining_credit;
200 struct timer_list credit_timeout;
201 u64 credit_window_start;
202 bool rate_limited;
203
204 /* Statistics */
205 struct xenvif_stats stats;
206};
207
208enum state_bit_shift {
209 /* This bit marks that the vif is connected */
210 VIF_STATUS_CONNECTED,
211};
212
213struct xenvif_mcast_addr {
214 struct list_head entry;
215 struct rcu_head rcu;
216 u8 addr[6];
217};
218
219#define XEN_NETBK_MCAST_MAX 64
220
221#define XEN_NETBK_MAX_HASH_KEY_SIZE 40
222#define XEN_NETBK_MAX_HASH_MAPPING_SIZE 128
223#define XEN_NETBK_HASH_TAG_SIZE 40
224
225struct xenvif_hash_cache_entry {
226 struct list_head link;
227 struct rcu_head rcu;
228 u8 tag[XEN_NETBK_HASH_TAG_SIZE];
229 unsigned int len;
230 u32 val;
231 int seq;
232};
233
234struct xenvif_hash_cache {
235 spinlock_t lock;
236 struct list_head list;
237 unsigned int count;
238 atomic_t seq;
239};
240
241struct xenvif_hash {
242 unsigned int alg;
243 u32 flags;
244 bool mapping_sel;
245 u8 key[XEN_NETBK_MAX_HASH_KEY_SIZE];
246 u32 mapping[2][XEN_NETBK_MAX_HASH_MAPPING_SIZE];
247 unsigned int size;
248 struct xenvif_hash_cache cache;
249};
250
251struct backend_info {
252 struct xenbus_device *dev;
253 struct xenvif *vif;
254
255 /* This is the state that will be reflected in xenstore when any
256 * active hotplug script completes.
257 */
258 enum xenbus_state state;
259
260 enum xenbus_state frontend_state;
261 struct xenbus_watch hotplug_status_watch;
262 u8 have_hotplug_status_watch:1;
263
264 const char *hotplug_script;
265};
266
267struct xenvif {
268 /* Unique identifier for this interface. */
269 domid_t domid;
270 unsigned int handle;
271
272 u8 fe_dev_addr[6];
273 struct list_head fe_mcast_addr;
274 unsigned int fe_mcast_count;
275
276 /* Frontend feature information. */
277 int gso_mask;
278
279 u8 can_sg:1;
280 u8 ip_csum:1;
281 u8 ipv6_csum:1;
282 u8 multicast_control:1;
283
284 /* headroom requested by xen-netfront */
285 u16 xdp_headroom;
286
287 /* Is this interface disabled? True when backend discovers
288 * frontend is rogue.
289 */
290 bool disabled;
291 unsigned long status;
292 unsigned long drain_timeout;
293 unsigned long stall_timeout;
294
295 /* Queues */
296 struct xenvif_queue *queues;
297 unsigned int num_queues; /* active queues, resource allocated */
298 unsigned int stalled_queues;
299
300 struct xenvif_hash hash;
301
302 struct xenbus_watch credit_watch;
303 struct xenbus_watch mcast_ctrl_watch;
304
305 struct backend_info *be;
306
307 spinlock_t lock;
308
309#ifdef CONFIG_DEBUG_FS
310 struct dentry *xenvif_dbg_root;
311#endif
312
313 struct xen_netif_ctrl_back_ring ctrl;
314 unsigned int ctrl_irq;
315
316 /* Miscellaneous private stuff. */
317 struct net_device *dev;
318};
319
320struct xenvif_rx_cb {
321 unsigned long expires;
322 int meta_slots_used;
323};
324
325#define XENVIF_RX_CB(skb) ((struct xenvif_rx_cb *)(skb)->cb)
326
327static inline struct xenbus_device *xenvif_to_xenbus_device(struct xenvif *vif)
328{
329 return to_xenbus_device(vif->dev->dev.parent);
330}
331
332void xenvif_tx_credit_callback(struct timer_list *t);
333
334struct xenvif *xenvif_alloc(struct device *parent,
335 domid_t domid,
336 unsigned int handle);
337
338int xenvif_init_queue(struct xenvif_queue *queue);
339void xenvif_deinit_queue(struct xenvif_queue *queue);
340
341int xenvif_connect_data(struct xenvif_queue *queue,
342 unsigned long tx_ring_ref,
343 unsigned long rx_ring_ref,
344 unsigned int tx_evtchn,
345 unsigned int rx_evtchn);
346void xenvif_disconnect_data(struct xenvif *vif);
347int xenvif_connect_ctrl(struct xenvif *vif, grant_ref_t ring_ref,
348 unsigned int evtchn);
349void xenvif_disconnect_ctrl(struct xenvif *vif);
350void xenvif_free(struct xenvif *vif);
351
352int xenvif_xenbus_init(void);
353void xenvif_xenbus_fini(void);
354
355int xenvif_schedulable(struct xenvif *vif);
356
357int xenvif_queue_stopped(struct xenvif_queue *queue);
358void xenvif_wake_queue(struct xenvif_queue *queue);
359
360/* (Un)Map communication rings. */
361void xenvif_unmap_frontend_data_rings(struct xenvif_queue *queue);
362int xenvif_map_frontend_data_rings(struct xenvif_queue *queue,
363 grant_ref_t tx_ring_ref,
364 grant_ref_t rx_ring_ref);
365
366/* Check for SKBs from frontend and schedule backend processing */
367void xenvif_napi_schedule_or_enable_events(struct xenvif_queue *queue);
368
369/* Prevent the device from generating any further traffic. */
370void xenvif_carrier_off(struct xenvif *vif);
371
372int xenvif_tx_action(struct xenvif_queue *queue, int budget);
373
374int xenvif_kthread_guest_rx(void *data);
375void xenvif_kick_thread(struct xenvif_queue *queue);
376
377int xenvif_dealloc_kthread(void *data);
378
379irqreturn_t xenvif_ctrl_irq_fn(int irq, void *data);
380
381void xenvif_rx_action(struct xenvif_queue *queue);
382void xenvif_rx_queue_tail(struct xenvif_queue *queue, struct sk_buff *skb);
383
384void xenvif_carrier_on(struct xenvif *vif);
385
386/* Callback from stack when TX packet can be released */
387void xenvif_zerocopy_callback(struct ubuf_info *ubuf, bool zerocopy_success);
388
389/* Unmap a pending page and release it back to the guest */
390void xenvif_idx_unmap(struct xenvif_queue *queue, u16 pending_idx);
391
392static inline pending_ring_idx_t nr_pending_reqs(struct xenvif_queue *queue)
393{
394 return MAX_PENDING_REQS -
395 queue->pending_prod + queue->pending_cons;
396}
397
398irqreturn_t xenvif_interrupt(int irq, void *dev_id);
399
400extern bool separate_tx_rx_irq;
401extern bool provides_xdp_headroom;
402
403extern unsigned int rx_drain_timeout_msecs;
404extern unsigned int rx_stall_timeout_msecs;
405extern unsigned int xenvif_max_queues;
406extern unsigned int xenvif_hash_cache_size;
407
408#ifdef CONFIG_DEBUG_FS
409extern struct dentry *xen_netback_dbg_root;
410#endif
411
412void xenvif_skb_zerocopy_prepare(struct xenvif_queue *queue,
413 struct sk_buff *skb);
414void xenvif_skb_zerocopy_complete(struct xenvif_queue *queue);
415
416/* Multicast control */
417bool xenvif_mcast_match(struct xenvif *vif, const u8 *addr);
418void xenvif_mcast_addr_list_free(struct xenvif *vif);
419
420/* Hash */
421void xenvif_init_hash(struct xenvif *vif);
422void xenvif_deinit_hash(struct xenvif *vif);
423
424u32 xenvif_set_hash_alg(struct xenvif *vif, u32 alg);
425u32 xenvif_get_hash_flags(struct xenvif *vif, u32 *flags);
426u32 xenvif_set_hash_flags(struct xenvif *vif, u32 flags);
427u32 xenvif_set_hash_key(struct xenvif *vif, u32 gref, u32 len);
428u32 xenvif_set_hash_mapping_size(struct xenvif *vif, u32 size);
429u32 xenvif_set_hash_mapping(struct xenvif *vif, u32 gref, u32 len,
430 u32 off);
431
432void xenvif_set_skb_hash(struct xenvif *vif, struct sk_buff *skb);
433
434#ifdef CONFIG_DEBUG_FS
435void xenvif_dump_hash_info(struct xenvif *vif, struct seq_file *m);
436#endif
437
438#endif /* __XEN_NETBACK__COMMON_H__ */