xref: /linux/drivers/net/xen-netback/netback.c (revision 2d87650a3bf1b80f7d0d150ee1af3f8a89e5b7aa)
1 /*
2  * Back-end of the driver for virtual network devices. This portion of the
3  * driver exports a 'unified' network-device interface that can be accessed
4  * by any operating system that implements a compatible front end. A
5  * reference front-end implementation can be found in:
6  *  drivers/net/xen-netfront.c
7  *
8  * Copyright (c) 2002-2005, K A Fraser
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License version 2
12  * as published by the Free Software Foundation; or, when distributed
13  * separately from the Linux kernel or incorporated into other
14  * software packages, subject to the following license:
15  *
16  * Permission is hereby granted, free of charge, to any person obtaining a copy
17  * of this source file (the "Software"), to deal in the Software without
18  * restriction, including without limitation the rights to use, copy, modify,
19  * merge, publish, distribute, sublicense, and/or sell copies of the Software,
20  * and to permit persons to whom the Software is furnished to do so, subject to
21  * the following conditions:
22  *
23  * The above copyright notice and this permission notice shall be included in
24  * all copies or substantial portions of the Software.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
29  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
30  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
31  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
32  * IN THE SOFTWARE.
33  */
34 
35 #include "common.h"
36 
37 #include <linux/kthread.h>
38 #include <linux/if_vlan.h>
39 #include <linux/udp.h>
40 
41 #include <net/tcp.h>
42 #include <net/ip6_checksum.h>
43 
44 #include <xen/xen.h>
45 #include <xen/events.h>
46 #include <xen/interface/memory.h>
47 
48 #include <asm/xen/hypercall.h>
49 #include <asm/xen/page.h>
50 
51 /* Provide an option to disable split event channels at load time as
52  * event channels are limited resource. Split event channels are
53  * enabled by default.
54  */
55 bool separate_tx_rx_irq = 1;
56 module_param(separate_tx_rx_irq, bool, 0644);
57 
58 /*
59  * This is the maximum slots a skb can have. If a guest sends a skb
60  * which exceeds this limit it is considered malicious.
61  */
62 #define FATAL_SKB_SLOTS_DEFAULT 20
63 static unsigned int fatal_skb_slots = FATAL_SKB_SLOTS_DEFAULT;
64 module_param(fatal_skb_slots, uint, 0444);
65 
66 /*
67  * To avoid confusion, we define XEN_NETBK_LEGACY_SLOTS_MAX indicating
68  * the maximum slots a valid packet can use. Now this value is defined
69  * to be XEN_NETIF_NR_SLOTS_MIN, which is supposed to be supported by
70  * all backend.
71  */
72 #define XEN_NETBK_LEGACY_SLOTS_MAX XEN_NETIF_NR_SLOTS_MIN
73 
74 /*
75  * If head != INVALID_PENDING_RING_IDX, it means this tx request is head of
76  * one or more merged tx requests, otherwise it is the continuation of
77  * previous tx request.
78  */
79 static inline int pending_tx_is_head(struct xenvif *vif, RING_IDX idx)
80 {
81 	return vif->pending_tx_info[idx].head != INVALID_PENDING_RING_IDX;
82 }
83 
84 static void xenvif_idx_release(struct xenvif *vif, u16 pending_idx,
85 			       u8 status);
86 
87 static void make_tx_response(struct xenvif *vif,
88 			     struct xen_netif_tx_request *txp,
89 			     s8       st);
90 
91 static inline int tx_work_todo(struct xenvif *vif);
92 static inline int rx_work_todo(struct xenvif *vif);
93 
94 static struct xen_netif_rx_response *make_rx_response(struct xenvif *vif,
95 					     u16      id,
96 					     s8       st,
97 					     u16      offset,
98 					     u16      size,
99 					     u16      flags);
100 
101 static inline unsigned long idx_to_pfn(struct xenvif *vif,
102 				       u16 idx)
103 {
104 	return page_to_pfn(vif->mmap_pages[idx]);
105 }
106 
107 static inline unsigned long idx_to_kaddr(struct xenvif *vif,
108 					 u16 idx)
109 {
110 	return (unsigned long)pfn_to_kaddr(idx_to_pfn(vif, idx));
111 }
112 
113 /* This is a miniumum size for the linear area to avoid lots of
114  * calls to __pskb_pull_tail() as we set up checksum offsets. The
115  * value 128 was chosen as it covers all IPv4 and most likely
116  * IPv6 headers.
117  */
118 #define PKT_PROT_LEN 128
119 
120 static u16 frag_get_pending_idx(skb_frag_t *frag)
121 {
122 	return (u16)frag->page_offset;
123 }
124 
125 static void frag_set_pending_idx(skb_frag_t *frag, u16 pending_idx)
126 {
127 	frag->page_offset = pending_idx;
128 }
129 
130 static inline pending_ring_idx_t pending_index(unsigned i)
131 {
132 	return i & (MAX_PENDING_REQS-1);
133 }
134 
135 static inline pending_ring_idx_t nr_pending_reqs(struct xenvif *vif)
136 {
137 	return MAX_PENDING_REQS -
138 		vif->pending_prod + vif->pending_cons;
139 }
140 
141 bool xenvif_rx_ring_slots_available(struct xenvif *vif, int needed)
142 {
143 	RING_IDX prod, cons;
144 
145 	do {
146 		prod = vif->rx.sring->req_prod;
147 		cons = vif->rx.req_cons;
148 
149 		if (prod - cons >= needed)
150 			return true;
151 
152 		vif->rx.sring->req_event = prod + 1;
153 
154 		/* Make sure event is visible before we check prod
155 		 * again.
156 		 */
157 		mb();
158 	} while (vif->rx.sring->req_prod != prod);
159 
160 	return false;
161 }
162 
163 /*
164  * Returns true if we should start a new receive buffer instead of
165  * adding 'size' bytes to a buffer which currently contains 'offset'
166  * bytes.
167  */
168 static bool start_new_rx_buffer(int offset, unsigned long size, int head)
169 {
170 	/* simple case: we have completely filled the current buffer. */
171 	if (offset == MAX_BUFFER_OFFSET)
172 		return true;
173 
174 	/*
175 	 * complex case: start a fresh buffer if the current frag
176 	 * would overflow the current buffer but only if:
177 	 *     (i)   this frag would fit completely in the next buffer
178 	 * and (ii)  there is already some data in the current buffer
179 	 * and (iii) this is not the head buffer.
180 	 *
181 	 * Where:
182 	 * - (i) stops us splitting a frag into two copies
183 	 *   unless the frag is too large for a single buffer.
184 	 * - (ii) stops us from leaving a buffer pointlessly empty.
185 	 * - (iii) stops us leaving the first buffer
186 	 *   empty. Strictly speaking this is already covered
187 	 *   by (ii) but is explicitly checked because
188 	 *   netfront relies on the first buffer being
189 	 *   non-empty and can crash otherwise.
190 	 *
191 	 * This means we will effectively linearise small
192 	 * frags but do not needlessly split large buffers
193 	 * into multiple copies tend to give large frags their
194 	 * own buffers as before.
195 	 */
196 	if ((offset + size > MAX_BUFFER_OFFSET) &&
197 	    (size <= MAX_BUFFER_OFFSET) && offset && !head)
198 		return true;
199 
200 	return false;
201 }
202 
203 struct netrx_pending_operations {
204 	unsigned copy_prod, copy_cons;
205 	unsigned meta_prod, meta_cons;
206 	struct gnttab_copy *copy;
207 	struct xenvif_rx_meta *meta;
208 	int copy_off;
209 	grant_ref_t copy_gref;
210 };
211 
212 static struct xenvif_rx_meta *get_next_rx_buffer(struct xenvif *vif,
213 						 struct netrx_pending_operations *npo)
214 {
215 	struct xenvif_rx_meta *meta;
216 	struct xen_netif_rx_request *req;
217 
218 	req = RING_GET_REQUEST(&vif->rx, vif->rx.req_cons++);
219 
220 	meta = npo->meta + npo->meta_prod++;
221 	meta->gso_type = XEN_NETIF_GSO_TYPE_NONE;
222 	meta->gso_size = 0;
223 	meta->size = 0;
224 	meta->id = req->id;
225 
226 	npo->copy_off = 0;
227 	npo->copy_gref = req->gref;
228 
229 	return meta;
230 }
231 
232 /*
233  * Set up the grant operations for this fragment. If it's a flipping
234  * interface, we also set up the unmap request from here.
235  */
236 static void xenvif_gop_frag_copy(struct xenvif *vif, struct sk_buff *skb,
237 				 struct netrx_pending_operations *npo,
238 				 struct page *page, unsigned long size,
239 				 unsigned long offset, int *head)
240 {
241 	struct gnttab_copy *copy_gop;
242 	struct xenvif_rx_meta *meta;
243 	unsigned long bytes;
244 	int gso_type;
245 
246 	/* Data must not cross a page boundary. */
247 	BUG_ON(size + offset > PAGE_SIZE<<compound_order(page));
248 
249 	meta = npo->meta + npo->meta_prod - 1;
250 
251 	/* Skip unused frames from start of page */
252 	page += offset >> PAGE_SHIFT;
253 	offset &= ~PAGE_MASK;
254 
255 	while (size > 0) {
256 		BUG_ON(offset >= PAGE_SIZE);
257 		BUG_ON(npo->copy_off > MAX_BUFFER_OFFSET);
258 
259 		bytes = PAGE_SIZE - offset;
260 
261 		if (bytes > size)
262 			bytes = size;
263 
264 		if (start_new_rx_buffer(npo->copy_off, bytes, *head)) {
265 			/*
266 			 * Netfront requires there to be some data in the head
267 			 * buffer.
268 			 */
269 			BUG_ON(*head);
270 
271 			meta = get_next_rx_buffer(vif, npo);
272 		}
273 
274 		if (npo->copy_off + bytes > MAX_BUFFER_OFFSET)
275 			bytes = MAX_BUFFER_OFFSET - npo->copy_off;
276 
277 		copy_gop = npo->copy + npo->copy_prod++;
278 		copy_gop->flags = GNTCOPY_dest_gref;
279 		copy_gop->len = bytes;
280 
281 		copy_gop->source.domid = DOMID_SELF;
282 		copy_gop->source.u.gmfn = virt_to_mfn(page_address(page));
283 		copy_gop->source.offset = offset;
284 
285 		copy_gop->dest.domid = vif->domid;
286 		copy_gop->dest.offset = npo->copy_off;
287 		copy_gop->dest.u.ref = npo->copy_gref;
288 
289 		npo->copy_off += bytes;
290 		meta->size += bytes;
291 
292 		offset += bytes;
293 		size -= bytes;
294 
295 		/* Next frame */
296 		if (offset == PAGE_SIZE && size) {
297 			BUG_ON(!PageCompound(page));
298 			page++;
299 			offset = 0;
300 		}
301 
302 		/* Leave a gap for the GSO descriptor. */
303 		if (skb_shinfo(skb)->gso_type & SKB_GSO_TCPV4)
304 			gso_type = XEN_NETIF_GSO_TYPE_TCPV4;
305 		else if (skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6)
306 			gso_type = XEN_NETIF_GSO_TYPE_TCPV6;
307 		else
308 			gso_type = XEN_NETIF_GSO_TYPE_NONE;
309 
310 		if (*head && ((1 << gso_type) & vif->gso_mask))
311 			vif->rx.req_cons++;
312 
313 		*head = 0; /* There must be something in this buffer now. */
314 
315 	}
316 }
317 
318 /*
319  * Prepare an SKB to be transmitted to the frontend.
320  *
321  * This function is responsible for allocating grant operations, meta
322  * structures, etc.
323  *
324  * It returns the number of meta structures consumed. The number of
325  * ring slots used is always equal to the number of meta slots used
326  * plus the number of GSO descriptors used. Currently, we use either
327  * zero GSO descriptors (for non-GSO packets) or one descriptor (for
328  * frontend-side LRO).
329  */
330 static int xenvif_gop_skb(struct sk_buff *skb,
331 			  struct netrx_pending_operations *npo)
332 {
333 	struct xenvif *vif = netdev_priv(skb->dev);
334 	int nr_frags = skb_shinfo(skb)->nr_frags;
335 	int i;
336 	struct xen_netif_rx_request *req;
337 	struct xenvif_rx_meta *meta;
338 	unsigned char *data;
339 	int head = 1;
340 	int old_meta_prod;
341 	int gso_type;
342 	int gso_size;
343 
344 	old_meta_prod = npo->meta_prod;
345 
346 	if (skb_shinfo(skb)->gso_type & SKB_GSO_TCPV4) {
347 		gso_type = XEN_NETIF_GSO_TYPE_TCPV4;
348 		gso_size = skb_shinfo(skb)->gso_size;
349 	} else if (skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6) {
350 		gso_type = XEN_NETIF_GSO_TYPE_TCPV6;
351 		gso_size = skb_shinfo(skb)->gso_size;
352 	} else {
353 		gso_type = XEN_NETIF_GSO_TYPE_NONE;
354 		gso_size = 0;
355 	}
356 
357 	/* Set up a GSO prefix descriptor, if necessary */
358 	if ((1 << gso_type) & vif->gso_prefix_mask) {
359 		req = RING_GET_REQUEST(&vif->rx, vif->rx.req_cons++);
360 		meta = npo->meta + npo->meta_prod++;
361 		meta->gso_type = gso_type;
362 		meta->gso_size = gso_size;
363 		meta->size = 0;
364 		meta->id = req->id;
365 	}
366 
367 	req = RING_GET_REQUEST(&vif->rx, vif->rx.req_cons++);
368 	meta = npo->meta + npo->meta_prod++;
369 
370 	if ((1 << gso_type) & vif->gso_mask) {
371 		meta->gso_type = gso_type;
372 		meta->gso_size = gso_size;
373 	} else {
374 		meta->gso_type = XEN_NETIF_GSO_TYPE_NONE;
375 		meta->gso_size = 0;
376 	}
377 
378 	meta->size = 0;
379 	meta->id = req->id;
380 	npo->copy_off = 0;
381 	npo->copy_gref = req->gref;
382 
383 	data = skb->data;
384 	while (data < skb_tail_pointer(skb)) {
385 		unsigned int offset = offset_in_page(data);
386 		unsigned int len = PAGE_SIZE - offset;
387 
388 		if (data + len > skb_tail_pointer(skb))
389 			len = skb_tail_pointer(skb) - data;
390 
391 		xenvif_gop_frag_copy(vif, skb, npo,
392 				     virt_to_page(data), len, offset, &head);
393 		data += len;
394 	}
395 
396 	for (i = 0; i < nr_frags; i++) {
397 		xenvif_gop_frag_copy(vif, skb, npo,
398 				     skb_frag_page(&skb_shinfo(skb)->frags[i]),
399 				     skb_frag_size(&skb_shinfo(skb)->frags[i]),
400 				     skb_shinfo(skb)->frags[i].page_offset,
401 				     &head);
402 	}
403 
404 	return npo->meta_prod - old_meta_prod;
405 }
406 
407 /*
408  * This is a twin to xenvif_gop_skb.  Assume that xenvif_gop_skb was
409  * used to set up the operations on the top of
410  * netrx_pending_operations, which have since been done.  Check that
411  * they didn't give any errors and advance over them.
412  */
413 static int xenvif_check_gop(struct xenvif *vif, int nr_meta_slots,
414 			    struct netrx_pending_operations *npo)
415 {
416 	struct gnttab_copy     *copy_op;
417 	int status = XEN_NETIF_RSP_OKAY;
418 	int i;
419 
420 	for (i = 0; i < nr_meta_slots; i++) {
421 		copy_op = npo->copy + npo->copy_cons++;
422 		if (copy_op->status != GNTST_okay) {
423 			netdev_dbg(vif->dev,
424 				   "Bad status %d from copy to DOM%d.\n",
425 				   copy_op->status, vif->domid);
426 			status = XEN_NETIF_RSP_ERROR;
427 		}
428 	}
429 
430 	return status;
431 }
432 
433 static void xenvif_add_frag_responses(struct xenvif *vif, int status,
434 				      struct xenvif_rx_meta *meta,
435 				      int nr_meta_slots)
436 {
437 	int i;
438 	unsigned long offset;
439 
440 	/* No fragments used */
441 	if (nr_meta_slots <= 1)
442 		return;
443 
444 	nr_meta_slots--;
445 
446 	for (i = 0; i < nr_meta_slots; i++) {
447 		int flags;
448 		if (i == nr_meta_slots - 1)
449 			flags = 0;
450 		else
451 			flags = XEN_NETRXF_more_data;
452 
453 		offset = 0;
454 		make_rx_response(vif, meta[i].id, status, offset,
455 				 meta[i].size, flags);
456 	}
457 }
458 
459 struct skb_cb_overlay {
460 	int meta_slots_used;
461 };
462 
463 void xenvif_kick_thread(struct xenvif *vif)
464 {
465 	wake_up(&vif->wq);
466 }
467 
468 static void xenvif_rx_action(struct xenvif *vif)
469 {
470 	s8 status;
471 	u16 flags;
472 	struct xen_netif_rx_response *resp;
473 	struct sk_buff_head rxq;
474 	struct sk_buff *skb;
475 	LIST_HEAD(notify);
476 	int ret;
477 	unsigned long offset;
478 	struct skb_cb_overlay *sco;
479 	int need_to_notify = 0;
480 
481 	struct netrx_pending_operations npo = {
482 		.copy  = vif->grant_copy_op,
483 		.meta  = vif->meta,
484 	};
485 
486 	skb_queue_head_init(&rxq);
487 
488 	while ((skb = skb_dequeue(&vif->rx_queue)) != NULL) {
489 		int max_slots_needed;
490 		int i;
491 
492 		/* We need a cheap worse case estimate for the number of
493 		 * slots we'll use.
494 		 */
495 
496 		max_slots_needed = DIV_ROUND_UP(offset_in_page(skb->data) +
497 						skb_headlen(skb),
498 						PAGE_SIZE);
499 		for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
500 			unsigned int size;
501 			size = skb_frag_size(&skb_shinfo(skb)->frags[i]);
502 			max_slots_needed += DIV_ROUND_UP(size, PAGE_SIZE);
503 		}
504 		if (skb_shinfo(skb)->gso_type & SKB_GSO_TCPV4 ||
505 		    skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6)
506 			max_slots_needed++;
507 
508 		/* If the skb may not fit then bail out now */
509 		if (!xenvif_rx_ring_slots_available(vif, max_slots_needed)) {
510 			skb_queue_head(&vif->rx_queue, skb);
511 			need_to_notify = 1;
512 			break;
513 		}
514 
515 		sco = (struct skb_cb_overlay *)skb->cb;
516 		sco->meta_slots_used = xenvif_gop_skb(skb, &npo);
517 		BUG_ON(sco->meta_slots_used > max_slots_needed);
518 
519 		__skb_queue_tail(&rxq, skb);
520 	}
521 
522 	BUG_ON(npo.meta_prod > ARRAY_SIZE(vif->meta));
523 
524 	if (!npo.copy_prod)
525 		goto done;
526 
527 	BUG_ON(npo.copy_prod > ARRAY_SIZE(vif->grant_copy_op));
528 	gnttab_batch_copy(vif->grant_copy_op, npo.copy_prod);
529 
530 	while ((skb = __skb_dequeue(&rxq)) != NULL) {
531 		sco = (struct skb_cb_overlay *)skb->cb;
532 
533 		if ((1 << vif->meta[npo.meta_cons].gso_type) &
534 		    vif->gso_prefix_mask) {
535 			resp = RING_GET_RESPONSE(&vif->rx,
536 						 vif->rx.rsp_prod_pvt++);
537 
538 			resp->flags = XEN_NETRXF_gso_prefix | XEN_NETRXF_more_data;
539 
540 			resp->offset = vif->meta[npo.meta_cons].gso_size;
541 			resp->id = vif->meta[npo.meta_cons].id;
542 			resp->status = sco->meta_slots_used;
543 
544 			npo.meta_cons++;
545 			sco->meta_slots_used--;
546 		}
547 
548 
549 		vif->dev->stats.tx_bytes += skb->len;
550 		vif->dev->stats.tx_packets++;
551 
552 		status = xenvif_check_gop(vif, sco->meta_slots_used, &npo);
553 
554 		if (sco->meta_slots_used == 1)
555 			flags = 0;
556 		else
557 			flags = XEN_NETRXF_more_data;
558 
559 		if (skb->ip_summed == CHECKSUM_PARTIAL) /* local packet? */
560 			flags |= XEN_NETRXF_csum_blank | XEN_NETRXF_data_validated;
561 		else if (skb->ip_summed == CHECKSUM_UNNECESSARY)
562 			/* remote but checksummed. */
563 			flags |= XEN_NETRXF_data_validated;
564 
565 		offset = 0;
566 		resp = make_rx_response(vif, vif->meta[npo.meta_cons].id,
567 					status, offset,
568 					vif->meta[npo.meta_cons].size,
569 					flags);
570 
571 		if ((1 << vif->meta[npo.meta_cons].gso_type) &
572 		    vif->gso_mask) {
573 			struct xen_netif_extra_info *gso =
574 				(struct xen_netif_extra_info *)
575 				RING_GET_RESPONSE(&vif->rx,
576 						  vif->rx.rsp_prod_pvt++);
577 
578 			resp->flags |= XEN_NETRXF_extra_info;
579 
580 			gso->u.gso.type = vif->meta[npo.meta_cons].gso_type;
581 			gso->u.gso.size = vif->meta[npo.meta_cons].gso_size;
582 			gso->u.gso.pad = 0;
583 			gso->u.gso.features = 0;
584 
585 			gso->type = XEN_NETIF_EXTRA_TYPE_GSO;
586 			gso->flags = 0;
587 		}
588 
589 		xenvif_add_frag_responses(vif, status,
590 					  vif->meta + npo.meta_cons + 1,
591 					  sco->meta_slots_used);
592 
593 		RING_PUSH_RESPONSES_AND_CHECK_NOTIFY(&vif->rx, ret);
594 
595 		if (ret)
596 			need_to_notify = 1;
597 
598 		npo.meta_cons += sco->meta_slots_used;
599 		dev_kfree_skb(skb);
600 	}
601 
602 done:
603 	if (need_to_notify)
604 		notify_remote_via_irq(vif->rx_irq);
605 }
606 
607 void xenvif_check_rx_xenvif(struct xenvif *vif)
608 {
609 	int more_to_do;
610 
611 	RING_FINAL_CHECK_FOR_REQUESTS(&vif->tx, more_to_do);
612 
613 	if (more_to_do)
614 		napi_schedule(&vif->napi);
615 }
616 
617 static void tx_add_credit(struct xenvif *vif)
618 {
619 	unsigned long max_burst, max_credit;
620 
621 	/*
622 	 * Allow a burst big enough to transmit a jumbo packet of up to 128kB.
623 	 * Otherwise the interface can seize up due to insufficient credit.
624 	 */
625 	max_burst = RING_GET_REQUEST(&vif->tx, vif->tx.req_cons)->size;
626 	max_burst = min(max_burst, 131072UL);
627 	max_burst = max(max_burst, vif->credit_bytes);
628 
629 	/* Take care that adding a new chunk of credit doesn't wrap to zero. */
630 	max_credit = vif->remaining_credit + vif->credit_bytes;
631 	if (max_credit < vif->remaining_credit)
632 		max_credit = ULONG_MAX; /* wrapped: clamp to ULONG_MAX */
633 
634 	vif->remaining_credit = min(max_credit, max_burst);
635 }
636 
637 static void tx_credit_callback(unsigned long data)
638 {
639 	struct xenvif *vif = (struct xenvif *)data;
640 	tx_add_credit(vif);
641 	xenvif_check_rx_xenvif(vif);
642 }
643 
644 static void xenvif_tx_err(struct xenvif *vif,
645 			  struct xen_netif_tx_request *txp, RING_IDX end)
646 {
647 	RING_IDX cons = vif->tx.req_cons;
648 
649 	do {
650 		make_tx_response(vif, txp, XEN_NETIF_RSP_ERROR);
651 		if (cons == end)
652 			break;
653 		txp = RING_GET_REQUEST(&vif->tx, cons++);
654 	} while (1);
655 	vif->tx.req_cons = cons;
656 }
657 
658 static void xenvif_fatal_tx_err(struct xenvif *vif)
659 {
660 	netdev_err(vif->dev, "fatal error; disabling device\n");
661 	xenvif_carrier_off(vif);
662 }
663 
664 static int xenvif_count_requests(struct xenvif *vif,
665 				 struct xen_netif_tx_request *first,
666 				 struct xen_netif_tx_request *txp,
667 				 int work_to_do)
668 {
669 	RING_IDX cons = vif->tx.req_cons;
670 	int slots = 0;
671 	int drop_err = 0;
672 	int more_data;
673 
674 	if (!(first->flags & XEN_NETTXF_more_data))
675 		return 0;
676 
677 	do {
678 		struct xen_netif_tx_request dropped_tx = { 0 };
679 
680 		if (slots >= work_to_do) {
681 			netdev_err(vif->dev,
682 				   "Asked for %d slots but exceeds this limit\n",
683 				   work_to_do);
684 			xenvif_fatal_tx_err(vif);
685 			return -ENODATA;
686 		}
687 
688 		/* This guest is really using too many slots and
689 		 * considered malicious.
690 		 */
691 		if (unlikely(slots >= fatal_skb_slots)) {
692 			netdev_err(vif->dev,
693 				   "Malicious frontend using %d slots, threshold %u\n",
694 				   slots, fatal_skb_slots);
695 			xenvif_fatal_tx_err(vif);
696 			return -E2BIG;
697 		}
698 
699 		/* Xen network protocol had implicit dependency on
700 		 * MAX_SKB_FRAGS. XEN_NETBK_LEGACY_SLOTS_MAX is set to
701 		 * the historical MAX_SKB_FRAGS value 18 to honor the
702 		 * same behavior as before. Any packet using more than
703 		 * 18 slots but less than fatal_skb_slots slots is
704 		 * dropped
705 		 */
706 		if (!drop_err && slots >= XEN_NETBK_LEGACY_SLOTS_MAX) {
707 			if (net_ratelimit())
708 				netdev_dbg(vif->dev,
709 					   "Too many slots (%d) exceeding limit (%d), dropping packet\n",
710 					   slots, XEN_NETBK_LEGACY_SLOTS_MAX);
711 			drop_err = -E2BIG;
712 		}
713 
714 		if (drop_err)
715 			txp = &dropped_tx;
716 
717 		memcpy(txp, RING_GET_REQUEST(&vif->tx, cons + slots),
718 		       sizeof(*txp));
719 
720 		/* If the guest submitted a frame >= 64 KiB then
721 		 * first->size overflowed and following slots will
722 		 * appear to be larger than the frame.
723 		 *
724 		 * This cannot be fatal error as there are buggy
725 		 * frontends that do this.
726 		 *
727 		 * Consume all slots and drop the packet.
728 		 */
729 		if (!drop_err && txp->size > first->size) {
730 			if (net_ratelimit())
731 				netdev_dbg(vif->dev,
732 					   "Invalid tx request, slot size %u > remaining size %u\n",
733 					   txp->size, first->size);
734 			drop_err = -EIO;
735 		}
736 
737 		first->size -= txp->size;
738 		slots++;
739 
740 		if (unlikely((txp->offset + txp->size) > PAGE_SIZE)) {
741 			netdev_err(vif->dev, "Cross page boundary, txp->offset: %x, size: %u\n",
742 				 txp->offset, txp->size);
743 			xenvif_fatal_tx_err(vif);
744 			return -EINVAL;
745 		}
746 
747 		more_data = txp->flags & XEN_NETTXF_more_data;
748 
749 		if (!drop_err)
750 			txp++;
751 
752 	} while (more_data);
753 
754 	if (drop_err) {
755 		xenvif_tx_err(vif, first, cons + slots);
756 		return drop_err;
757 	}
758 
759 	return slots;
760 }
761 
762 static struct page *xenvif_alloc_page(struct xenvif *vif,
763 				      u16 pending_idx)
764 {
765 	struct page *page;
766 
767 	page = alloc_page(GFP_ATOMIC|__GFP_COLD);
768 	if (!page)
769 		return NULL;
770 	vif->mmap_pages[pending_idx] = page;
771 
772 	return page;
773 }
774 
775 static struct gnttab_copy *xenvif_get_requests(struct xenvif *vif,
776 					       struct sk_buff *skb,
777 					       struct xen_netif_tx_request *txp,
778 					       struct gnttab_copy *gop)
779 {
780 	struct skb_shared_info *shinfo = skb_shinfo(skb);
781 	skb_frag_t *frags = shinfo->frags;
782 	u16 pending_idx = *((u16 *)skb->data);
783 	u16 head_idx = 0;
784 	int slot, start;
785 	struct page *page;
786 	pending_ring_idx_t index, start_idx = 0;
787 	uint16_t dst_offset;
788 	unsigned int nr_slots;
789 	struct pending_tx_info *first = NULL;
790 
791 	/* At this point shinfo->nr_frags is in fact the number of
792 	 * slots, which can be as large as XEN_NETBK_LEGACY_SLOTS_MAX.
793 	 */
794 	nr_slots = shinfo->nr_frags;
795 
796 	/* Skip first skb fragment if it is on same page as header fragment. */
797 	start = (frag_get_pending_idx(&shinfo->frags[0]) == pending_idx);
798 
799 	/* Coalesce tx requests, at this point the packet passed in
800 	 * should be <= 64K. Any packets larger than 64K have been
801 	 * handled in xenvif_count_requests().
802 	 */
803 	for (shinfo->nr_frags = slot = start; slot < nr_slots;
804 	     shinfo->nr_frags++) {
805 		struct pending_tx_info *pending_tx_info =
806 			vif->pending_tx_info;
807 
808 		page = alloc_page(GFP_ATOMIC|__GFP_COLD);
809 		if (!page)
810 			goto err;
811 
812 		dst_offset = 0;
813 		first = NULL;
814 		while (dst_offset < PAGE_SIZE && slot < nr_slots) {
815 			gop->flags = GNTCOPY_source_gref;
816 
817 			gop->source.u.ref = txp->gref;
818 			gop->source.domid = vif->domid;
819 			gop->source.offset = txp->offset;
820 
821 			gop->dest.domid = DOMID_SELF;
822 
823 			gop->dest.offset = dst_offset;
824 			gop->dest.u.gmfn = virt_to_mfn(page_address(page));
825 
826 			if (dst_offset + txp->size > PAGE_SIZE) {
827 				/* This page can only merge a portion
828 				 * of tx request. Do not increment any
829 				 * pointer / counter here. The txp
830 				 * will be dealt with in future
831 				 * rounds, eventually hitting the
832 				 * `else` branch.
833 				 */
834 				gop->len = PAGE_SIZE - dst_offset;
835 				txp->offset += gop->len;
836 				txp->size -= gop->len;
837 				dst_offset += gop->len; /* quit loop */
838 			} else {
839 				/* This tx request can be merged in the page */
840 				gop->len = txp->size;
841 				dst_offset += gop->len;
842 
843 				index = pending_index(vif->pending_cons++);
844 
845 				pending_idx = vif->pending_ring[index];
846 
847 				memcpy(&pending_tx_info[pending_idx].req, txp,
848 				       sizeof(*txp));
849 
850 				/* Poison these fields, corresponding
851 				 * fields for head tx req will be set
852 				 * to correct values after the loop.
853 				 */
854 				vif->mmap_pages[pending_idx] = (void *)(~0UL);
855 				pending_tx_info[pending_idx].head =
856 					INVALID_PENDING_RING_IDX;
857 
858 				if (!first) {
859 					first = &pending_tx_info[pending_idx];
860 					start_idx = index;
861 					head_idx = pending_idx;
862 				}
863 
864 				txp++;
865 				slot++;
866 			}
867 
868 			gop++;
869 		}
870 
871 		first->req.offset = 0;
872 		first->req.size = dst_offset;
873 		first->head = start_idx;
874 		vif->mmap_pages[head_idx] = page;
875 		frag_set_pending_idx(&frags[shinfo->nr_frags], head_idx);
876 	}
877 
878 	BUG_ON(shinfo->nr_frags > MAX_SKB_FRAGS);
879 
880 	return gop;
881 err:
882 	/* Unwind, freeing all pages and sending error responses. */
883 	while (shinfo->nr_frags-- > start) {
884 		xenvif_idx_release(vif,
885 				frag_get_pending_idx(&frags[shinfo->nr_frags]),
886 				XEN_NETIF_RSP_ERROR);
887 	}
888 	/* The head too, if necessary. */
889 	if (start)
890 		xenvif_idx_release(vif, pending_idx, XEN_NETIF_RSP_ERROR);
891 
892 	return NULL;
893 }
894 
895 static int xenvif_tx_check_gop(struct xenvif *vif,
896 			       struct sk_buff *skb,
897 			       struct gnttab_copy **gopp)
898 {
899 	struct gnttab_copy *gop = *gopp;
900 	u16 pending_idx = *((u16 *)skb->data);
901 	struct skb_shared_info *shinfo = skb_shinfo(skb);
902 	struct pending_tx_info *tx_info;
903 	int nr_frags = shinfo->nr_frags;
904 	int i, err, start;
905 	u16 peek; /* peek into next tx request */
906 
907 	/* Check status of header. */
908 	err = gop->status;
909 	if (unlikely(err))
910 		xenvif_idx_release(vif, pending_idx, XEN_NETIF_RSP_ERROR);
911 
912 	/* Skip first skb fragment if it is on same page as header fragment. */
913 	start = (frag_get_pending_idx(&shinfo->frags[0]) == pending_idx);
914 
915 	for (i = start; i < nr_frags; i++) {
916 		int j, newerr;
917 		pending_ring_idx_t head;
918 
919 		pending_idx = frag_get_pending_idx(&shinfo->frags[i]);
920 		tx_info = &vif->pending_tx_info[pending_idx];
921 		head = tx_info->head;
922 
923 		/* Check error status: if okay then remember grant handle. */
924 		do {
925 			newerr = (++gop)->status;
926 			if (newerr)
927 				break;
928 			peek = vif->pending_ring[pending_index(++head)];
929 		} while (!pending_tx_is_head(vif, peek));
930 
931 		if (likely(!newerr)) {
932 			/* Had a previous error? Invalidate this fragment. */
933 			if (unlikely(err))
934 				xenvif_idx_release(vif, pending_idx,
935 						   XEN_NETIF_RSP_OKAY);
936 			continue;
937 		}
938 
939 		/* Error on this fragment: respond to client with an error. */
940 		xenvif_idx_release(vif, pending_idx, XEN_NETIF_RSP_ERROR);
941 
942 		/* Not the first error? Preceding frags already invalidated. */
943 		if (err)
944 			continue;
945 
946 		/* First error: invalidate header and preceding fragments. */
947 		pending_idx = *((u16 *)skb->data);
948 		xenvif_idx_release(vif, pending_idx, XEN_NETIF_RSP_OKAY);
949 		for (j = start; j < i; j++) {
950 			pending_idx = frag_get_pending_idx(&shinfo->frags[j]);
951 			xenvif_idx_release(vif, pending_idx,
952 					   XEN_NETIF_RSP_OKAY);
953 		}
954 
955 		/* Remember the error: invalidate all subsequent fragments. */
956 		err = newerr;
957 	}
958 
959 	*gopp = gop + 1;
960 	return err;
961 }
962 
963 static void xenvif_fill_frags(struct xenvif *vif, struct sk_buff *skb)
964 {
965 	struct skb_shared_info *shinfo = skb_shinfo(skb);
966 	int nr_frags = shinfo->nr_frags;
967 	int i;
968 
969 	for (i = 0; i < nr_frags; i++) {
970 		skb_frag_t *frag = shinfo->frags + i;
971 		struct xen_netif_tx_request *txp;
972 		struct page *page;
973 		u16 pending_idx;
974 
975 		pending_idx = frag_get_pending_idx(frag);
976 
977 		txp = &vif->pending_tx_info[pending_idx].req;
978 		page = virt_to_page(idx_to_kaddr(vif, pending_idx));
979 		__skb_fill_page_desc(skb, i, page, txp->offset, txp->size);
980 		skb->len += txp->size;
981 		skb->data_len += txp->size;
982 		skb->truesize += txp->size;
983 
984 		/* Take an extra reference to offset xenvif_idx_release */
985 		get_page(vif->mmap_pages[pending_idx]);
986 		xenvif_idx_release(vif, pending_idx, XEN_NETIF_RSP_OKAY);
987 	}
988 }
989 
990 static int xenvif_get_extras(struct xenvif *vif,
991 				struct xen_netif_extra_info *extras,
992 				int work_to_do)
993 {
994 	struct xen_netif_extra_info extra;
995 	RING_IDX cons = vif->tx.req_cons;
996 
997 	do {
998 		if (unlikely(work_to_do-- <= 0)) {
999 			netdev_err(vif->dev, "Missing extra info\n");
1000 			xenvif_fatal_tx_err(vif);
1001 			return -EBADR;
1002 		}
1003 
1004 		memcpy(&extra, RING_GET_REQUEST(&vif->tx, cons),
1005 		       sizeof(extra));
1006 		if (unlikely(!extra.type ||
1007 			     extra.type >= XEN_NETIF_EXTRA_TYPE_MAX)) {
1008 			vif->tx.req_cons = ++cons;
1009 			netdev_err(vif->dev,
1010 				   "Invalid extra type: %d\n", extra.type);
1011 			xenvif_fatal_tx_err(vif);
1012 			return -EINVAL;
1013 		}
1014 
1015 		memcpy(&extras[extra.type - 1], &extra, sizeof(extra));
1016 		vif->tx.req_cons = ++cons;
1017 	} while (extra.flags & XEN_NETIF_EXTRA_FLAG_MORE);
1018 
1019 	return work_to_do;
1020 }
1021 
1022 static int xenvif_set_skb_gso(struct xenvif *vif,
1023 			      struct sk_buff *skb,
1024 			      struct xen_netif_extra_info *gso)
1025 {
1026 	if (!gso->u.gso.size) {
1027 		netdev_err(vif->dev, "GSO size must not be zero.\n");
1028 		xenvif_fatal_tx_err(vif);
1029 		return -EINVAL;
1030 	}
1031 
1032 	switch (gso->u.gso.type) {
1033 	case XEN_NETIF_GSO_TYPE_TCPV4:
1034 		skb_shinfo(skb)->gso_type = SKB_GSO_TCPV4;
1035 		break;
1036 	case XEN_NETIF_GSO_TYPE_TCPV6:
1037 		skb_shinfo(skb)->gso_type = SKB_GSO_TCPV6;
1038 		break;
1039 	default:
1040 		netdev_err(vif->dev, "Bad GSO type %d.\n", gso->u.gso.type);
1041 		xenvif_fatal_tx_err(vif);
1042 		return -EINVAL;
1043 	}
1044 
1045 	skb_shinfo(skb)->gso_size = gso->u.gso.size;
1046 	/* gso_segs will be calculated later */
1047 
1048 	return 0;
1049 }
1050 
1051 static inline int maybe_pull_tail(struct sk_buff *skb, unsigned int len,
1052 				  unsigned int max)
1053 {
1054 	if (skb_headlen(skb) >= len)
1055 		return 0;
1056 
1057 	/* If we need to pullup then pullup to the max, so we
1058 	 * won't need to do it again.
1059 	 */
1060 	if (max > skb->len)
1061 		max = skb->len;
1062 
1063 	if (__pskb_pull_tail(skb, max - skb_headlen(skb)) == NULL)
1064 		return -ENOMEM;
1065 
1066 	if (skb_headlen(skb) < len)
1067 		return -EPROTO;
1068 
1069 	return 0;
1070 }
1071 
1072 /* This value should be large enough to cover a tagged ethernet header plus
1073  * maximally sized IP and TCP or UDP headers.
1074  */
1075 #define MAX_IP_HDR_LEN 128
1076 
1077 static int checksum_setup_ip(struct xenvif *vif, struct sk_buff *skb,
1078 			     int recalculate_partial_csum)
1079 {
1080 	unsigned int off;
1081 	bool fragment;
1082 	int err;
1083 
1084 	fragment = false;
1085 
1086 	err = maybe_pull_tail(skb,
1087 			      sizeof(struct iphdr),
1088 			      MAX_IP_HDR_LEN);
1089 	if (err < 0)
1090 		goto out;
1091 
1092 	if (ip_hdr(skb)->frag_off & htons(IP_OFFSET | IP_MF))
1093 		fragment = true;
1094 
1095 	off = ip_hdrlen(skb);
1096 
1097 	err = -EPROTO;
1098 
1099 	if (fragment)
1100 		goto out;
1101 
1102 	switch (ip_hdr(skb)->protocol) {
1103 	case IPPROTO_TCP:
1104 		err = maybe_pull_tail(skb,
1105 				      off + sizeof(struct tcphdr),
1106 				      MAX_IP_HDR_LEN);
1107 		if (err < 0)
1108 			goto out;
1109 
1110 		if (!skb_partial_csum_set(skb, off,
1111 					  offsetof(struct tcphdr, check)))
1112 			goto out;
1113 
1114 		if (recalculate_partial_csum)
1115 			tcp_hdr(skb)->check =
1116 				~csum_tcpudp_magic(ip_hdr(skb)->saddr,
1117 						   ip_hdr(skb)->daddr,
1118 						   skb->len - off,
1119 						   IPPROTO_TCP, 0);
1120 		break;
1121 	case IPPROTO_UDP:
1122 		err = maybe_pull_tail(skb,
1123 				      off + sizeof(struct udphdr),
1124 				      MAX_IP_HDR_LEN);
1125 		if (err < 0)
1126 			goto out;
1127 
1128 		if (!skb_partial_csum_set(skb, off,
1129 					  offsetof(struct udphdr, check)))
1130 			goto out;
1131 
1132 		if (recalculate_partial_csum)
1133 			udp_hdr(skb)->check =
1134 				~csum_tcpudp_magic(ip_hdr(skb)->saddr,
1135 						   ip_hdr(skb)->daddr,
1136 						   skb->len - off,
1137 						   IPPROTO_UDP, 0);
1138 		break;
1139 	default:
1140 		goto out;
1141 	}
1142 
1143 	err = 0;
1144 
1145 out:
1146 	return err;
1147 }
1148 
1149 /* This value should be large enough to cover a tagged ethernet header plus
1150  * an IPv6 header, all options, and a maximal TCP or UDP header.
1151  */
1152 #define MAX_IPV6_HDR_LEN 256
1153 
1154 #define OPT_HDR(type, skb, off) \
1155 	(type *)(skb_network_header(skb) + (off))
1156 
1157 static int checksum_setup_ipv6(struct xenvif *vif, struct sk_buff *skb,
1158 			       int recalculate_partial_csum)
1159 {
1160 	int err;
1161 	u8 nexthdr;
1162 	unsigned int off;
1163 	unsigned int len;
1164 	bool fragment;
1165 	bool done;
1166 
1167 	fragment = false;
1168 	done = false;
1169 
1170 	off = sizeof(struct ipv6hdr);
1171 
1172 	err = maybe_pull_tail(skb, off, MAX_IPV6_HDR_LEN);
1173 	if (err < 0)
1174 		goto out;
1175 
1176 	nexthdr = ipv6_hdr(skb)->nexthdr;
1177 
1178 	len = sizeof(struct ipv6hdr) + ntohs(ipv6_hdr(skb)->payload_len);
1179 	while (off <= len && !done) {
1180 		switch (nexthdr) {
1181 		case IPPROTO_DSTOPTS:
1182 		case IPPROTO_HOPOPTS:
1183 		case IPPROTO_ROUTING: {
1184 			struct ipv6_opt_hdr *hp;
1185 
1186 			err = maybe_pull_tail(skb,
1187 					      off +
1188 					      sizeof(struct ipv6_opt_hdr),
1189 					      MAX_IPV6_HDR_LEN);
1190 			if (err < 0)
1191 				goto out;
1192 
1193 			hp = OPT_HDR(struct ipv6_opt_hdr, skb, off);
1194 			nexthdr = hp->nexthdr;
1195 			off += ipv6_optlen(hp);
1196 			break;
1197 		}
1198 		case IPPROTO_AH: {
1199 			struct ip_auth_hdr *hp;
1200 
1201 			err = maybe_pull_tail(skb,
1202 					      off +
1203 					      sizeof(struct ip_auth_hdr),
1204 					      MAX_IPV6_HDR_LEN);
1205 			if (err < 0)
1206 				goto out;
1207 
1208 			hp = OPT_HDR(struct ip_auth_hdr, skb, off);
1209 			nexthdr = hp->nexthdr;
1210 			off += ipv6_authlen(hp);
1211 			break;
1212 		}
1213 		case IPPROTO_FRAGMENT: {
1214 			struct frag_hdr *hp;
1215 
1216 			err = maybe_pull_tail(skb,
1217 					      off +
1218 					      sizeof(struct frag_hdr),
1219 					      MAX_IPV6_HDR_LEN);
1220 			if (err < 0)
1221 				goto out;
1222 
1223 			hp = OPT_HDR(struct frag_hdr, skb, off);
1224 
1225 			if (hp->frag_off & htons(IP6_OFFSET | IP6_MF))
1226 				fragment = true;
1227 
1228 			nexthdr = hp->nexthdr;
1229 			off += sizeof(struct frag_hdr);
1230 			break;
1231 		}
1232 		default:
1233 			done = true;
1234 			break;
1235 		}
1236 	}
1237 
1238 	err = -EPROTO;
1239 
1240 	if (!done || fragment)
1241 		goto out;
1242 
1243 	switch (nexthdr) {
1244 	case IPPROTO_TCP:
1245 		err = maybe_pull_tail(skb,
1246 				      off + sizeof(struct tcphdr),
1247 				      MAX_IPV6_HDR_LEN);
1248 		if (err < 0)
1249 			goto out;
1250 
1251 		if (!skb_partial_csum_set(skb, off,
1252 					  offsetof(struct tcphdr, check)))
1253 			goto out;
1254 
1255 		if (recalculate_partial_csum)
1256 			tcp_hdr(skb)->check =
1257 				~csum_ipv6_magic(&ipv6_hdr(skb)->saddr,
1258 						 &ipv6_hdr(skb)->daddr,
1259 						 skb->len - off,
1260 						 IPPROTO_TCP, 0);
1261 		break;
1262 	case IPPROTO_UDP:
1263 		err = maybe_pull_tail(skb,
1264 				      off + sizeof(struct udphdr),
1265 				      MAX_IPV6_HDR_LEN);
1266 		if (err < 0)
1267 			goto out;
1268 
1269 		if (!skb_partial_csum_set(skb, off,
1270 					  offsetof(struct udphdr, check)))
1271 			goto out;
1272 
1273 		if (recalculate_partial_csum)
1274 			udp_hdr(skb)->check =
1275 				~csum_ipv6_magic(&ipv6_hdr(skb)->saddr,
1276 						 &ipv6_hdr(skb)->daddr,
1277 						 skb->len - off,
1278 						 IPPROTO_UDP, 0);
1279 		break;
1280 	default:
1281 		goto out;
1282 	}
1283 
1284 	err = 0;
1285 
1286 out:
1287 	return err;
1288 }
1289 
1290 static int checksum_setup(struct xenvif *vif, struct sk_buff *skb)
1291 {
1292 	int err = -EPROTO;
1293 	int recalculate_partial_csum = 0;
1294 
1295 	/* A GSO SKB must be CHECKSUM_PARTIAL. However some buggy
1296 	 * peers can fail to set NETRXF_csum_blank when sending a GSO
1297 	 * frame. In this case force the SKB to CHECKSUM_PARTIAL and
1298 	 * recalculate the partial checksum.
1299 	 */
1300 	if (skb->ip_summed != CHECKSUM_PARTIAL && skb_is_gso(skb)) {
1301 		vif->rx_gso_checksum_fixup++;
1302 		skb->ip_summed = CHECKSUM_PARTIAL;
1303 		recalculate_partial_csum = 1;
1304 	}
1305 
1306 	/* A non-CHECKSUM_PARTIAL SKB does not require setup. */
1307 	if (skb->ip_summed != CHECKSUM_PARTIAL)
1308 		return 0;
1309 
1310 	if (skb->protocol == htons(ETH_P_IP))
1311 		err = checksum_setup_ip(vif, skb, recalculate_partial_csum);
1312 	else if (skb->protocol == htons(ETH_P_IPV6))
1313 		err = checksum_setup_ipv6(vif, skb, recalculate_partial_csum);
1314 
1315 	return err;
1316 }
1317 
1318 static bool tx_credit_exceeded(struct xenvif *vif, unsigned size)
1319 {
1320 	u64 now = get_jiffies_64();
1321 	u64 next_credit = vif->credit_window_start +
1322 		msecs_to_jiffies(vif->credit_usec / 1000);
1323 
1324 	/* Timer could already be pending in rare cases. */
1325 	if (timer_pending(&vif->credit_timeout))
1326 		return true;
1327 
1328 	/* Passed the point where we can replenish credit? */
1329 	if (time_after_eq64(now, next_credit)) {
1330 		vif->credit_window_start = now;
1331 		tx_add_credit(vif);
1332 	}
1333 
1334 	/* Still too big to send right now? Set a callback. */
1335 	if (size > vif->remaining_credit) {
1336 		vif->credit_timeout.data     =
1337 			(unsigned long)vif;
1338 		vif->credit_timeout.function =
1339 			tx_credit_callback;
1340 		mod_timer(&vif->credit_timeout,
1341 			  next_credit);
1342 		vif->credit_window_start = next_credit;
1343 
1344 		return true;
1345 	}
1346 
1347 	return false;
1348 }
1349 
1350 static unsigned xenvif_tx_build_gops(struct xenvif *vif, int budget)
1351 {
1352 	struct gnttab_copy *gop = vif->tx_copy_ops, *request_gop;
1353 	struct sk_buff *skb;
1354 	int ret;
1355 
1356 	while ((nr_pending_reqs(vif) + XEN_NETBK_LEGACY_SLOTS_MAX
1357 		< MAX_PENDING_REQS) &&
1358 	       (skb_queue_len(&vif->tx_queue) < budget)) {
1359 		struct xen_netif_tx_request txreq;
1360 		struct xen_netif_tx_request txfrags[XEN_NETBK_LEGACY_SLOTS_MAX];
1361 		struct page *page;
1362 		struct xen_netif_extra_info extras[XEN_NETIF_EXTRA_TYPE_MAX-1];
1363 		u16 pending_idx;
1364 		RING_IDX idx;
1365 		int work_to_do;
1366 		unsigned int data_len;
1367 		pending_ring_idx_t index;
1368 
1369 		if (vif->tx.sring->req_prod - vif->tx.req_cons >
1370 		    XEN_NETIF_TX_RING_SIZE) {
1371 			netdev_err(vif->dev,
1372 				   "Impossible number of requests. "
1373 				   "req_prod %d, req_cons %d, size %ld\n",
1374 				   vif->tx.sring->req_prod, vif->tx.req_cons,
1375 				   XEN_NETIF_TX_RING_SIZE);
1376 			xenvif_fatal_tx_err(vif);
1377 			continue;
1378 		}
1379 
1380 		work_to_do = RING_HAS_UNCONSUMED_REQUESTS(&vif->tx);
1381 		if (!work_to_do)
1382 			break;
1383 
1384 		idx = vif->tx.req_cons;
1385 		rmb(); /* Ensure that we see the request before we copy it. */
1386 		memcpy(&txreq, RING_GET_REQUEST(&vif->tx, idx), sizeof(txreq));
1387 
1388 		/* Credit-based scheduling. */
1389 		if (txreq.size > vif->remaining_credit &&
1390 		    tx_credit_exceeded(vif, txreq.size))
1391 			break;
1392 
1393 		vif->remaining_credit -= txreq.size;
1394 
1395 		work_to_do--;
1396 		vif->tx.req_cons = ++idx;
1397 
1398 		memset(extras, 0, sizeof(extras));
1399 		if (txreq.flags & XEN_NETTXF_extra_info) {
1400 			work_to_do = xenvif_get_extras(vif, extras,
1401 						       work_to_do);
1402 			idx = vif->tx.req_cons;
1403 			if (unlikely(work_to_do < 0))
1404 				break;
1405 		}
1406 
1407 		ret = xenvif_count_requests(vif, &txreq, txfrags, work_to_do);
1408 		if (unlikely(ret < 0))
1409 			break;
1410 
1411 		idx += ret;
1412 
1413 		if (unlikely(txreq.size < ETH_HLEN)) {
1414 			netdev_dbg(vif->dev,
1415 				   "Bad packet size: %d\n", txreq.size);
1416 			xenvif_tx_err(vif, &txreq, idx);
1417 			break;
1418 		}
1419 
1420 		/* No crossing a page as the payload mustn't fragment. */
1421 		if (unlikely((txreq.offset + txreq.size) > PAGE_SIZE)) {
1422 			netdev_err(vif->dev,
1423 				   "txreq.offset: %x, size: %u, end: %lu\n",
1424 				   txreq.offset, txreq.size,
1425 				   (txreq.offset&~PAGE_MASK) + txreq.size);
1426 			xenvif_fatal_tx_err(vif);
1427 			break;
1428 		}
1429 
1430 		index = pending_index(vif->pending_cons);
1431 		pending_idx = vif->pending_ring[index];
1432 
1433 		data_len = (txreq.size > PKT_PROT_LEN &&
1434 			    ret < XEN_NETBK_LEGACY_SLOTS_MAX) ?
1435 			PKT_PROT_LEN : txreq.size;
1436 
1437 		skb = alloc_skb(data_len + NET_SKB_PAD + NET_IP_ALIGN,
1438 				GFP_ATOMIC | __GFP_NOWARN);
1439 		if (unlikely(skb == NULL)) {
1440 			netdev_dbg(vif->dev,
1441 				   "Can't allocate a skb in start_xmit.\n");
1442 			xenvif_tx_err(vif, &txreq, idx);
1443 			break;
1444 		}
1445 
1446 		/* Packets passed to netif_rx() must have some headroom. */
1447 		skb_reserve(skb, NET_SKB_PAD + NET_IP_ALIGN);
1448 
1449 		if (extras[XEN_NETIF_EXTRA_TYPE_GSO - 1].type) {
1450 			struct xen_netif_extra_info *gso;
1451 			gso = &extras[XEN_NETIF_EXTRA_TYPE_GSO - 1];
1452 
1453 			if (xenvif_set_skb_gso(vif, skb, gso)) {
1454 				/* Failure in xenvif_set_skb_gso is fatal. */
1455 				kfree_skb(skb);
1456 				break;
1457 			}
1458 		}
1459 
1460 		/* XXX could copy straight to head */
1461 		page = xenvif_alloc_page(vif, pending_idx);
1462 		if (!page) {
1463 			kfree_skb(skb);
1464 			xenvif_tx_err(vif, &txreq, idx);
1465 			break;
1466 		}
1467 
1468 		gop->source.u.ref = txreq.gref;
1469 		gop->source.domid = vif->domid;
1470 		gop->source.offset = txreq.offset;
1471 
1472 		gop->dest.u.gmfn = virt_to_mfn(page_address(page));
1473 		gop->dest.domid = DOMID_SELF;
1474 		gop->dest.offset = txreq.offset;
1475 
1476 		gop->len = txreq.size;
1477 		gop->flags = GNTCOPY_source_gref;
1478 
1479 		gop++;
1480 
1481 		memcpy(&vif->pending_tx_info[pending_idx].req,
1482 		       &txreq, sizeof(txreq));
1483 		vif->pending_tx_info[pending_idx].head = index;
1484 		*((u16 *)skb->data) = pending_idx;
1485 
1486 		__skb_put(skb, data_len);
1487 
1488 		skb_shinfo(skb)->nr_frags = ret;
1489 		if (data_len < txreq.size) {
1490 			skb_shinfo(skb)->nr_frags++;
1491 			frag_set_pending_idx(&skb_shinfo(skb)->frags[0],
1492 					     pending_idx);
1493 		} else {
1494 			frag_set_pending_idx(&skb_shinfo(skb)->frags[0],
1495 					     INVALID_PENDING_IDX);
1496 		}
1497 
1498 		vif->pending_cons++;
1499 
1500 		request_gop = xenvif_get_requests(vif, skb, txfrags, gop);
1501 		if (request_gop == NULL) {
1502 			kfree_skb(skb);
1503 			xenvif_tx_err(vif, &txreq, idx);
1504 			break;
1505 		}
1506 		gop = request_gop;
1507 
1508 		__skb_queue_tail(&vif->tx_queue, skb);
1509 
1510 		vif->tx.req_cons = idx;
1511 
1512 		if ((gop-vif->tx_copy_ops) >= ARRAY_SIZE(vif->tx_copy_ops))
1513 			break;
1514 	}
1515 
1516 	return gop - vif->tx_copy_ops;
1517 }
1518 
1519 
1520 static int xenvif_tx_submit(struct xenvif *vif)
1521 {
1522 	struct gnttab_copy *gop = vif->tx_copy_ops;
1523 	struct sk_buff *skb;
1524 	int work_done = 0;
1525 
1526 	while ((skb = __skb_dequeue(&vif->tx_queue)) != NULL) {
1527 		struct xen_netif_tx_request *txp;
1528 		u16 pending_idx;
1529 		unsigned data_len;
1530 
1531 		pending_idx = *((u16 *)skb->data);
1532 		txp = &vif->pending_tx_info[pending_idx].req;
1533 
1534 		/* Check the remap error code. */
1535 		if (unlikely(xenvif_tx_check_gop(vif, skb, &gop))) {
1536 			netdev_dbg(vif->dev, "netback grant failed.\n");
1537 			skb_shinfo(skb)->nr_frags = 0;
1538 			kfree_skb(skb);
1539 			continue;
1540 		}
1541 
1542 		data_len = skb->len;
1543 		memcpy(skb->data,
1544 		       (void *)(idx_to_kaddr(vif, pending_idx)|txp->offset),
1545 		       data_len);
1546 		if (data_len < txp->size) {
1547 			/* Append the packet payload as a fragment. */
1548 			txp->offset += data_len;
1549 			txp->size -= data_len;
1550 		} else {
1551 			/* Schedule a response immediately. */
1552 			xenvif_idx_release(vif, pending_idx,
1553 					   XEN_NETIF_RSP_OKAY);
1554 		}
1555 
1556 		if (txp->flags & XEN_NETTXF_csum_blank)
1557 			skb->ip_summed = CHECKSUM_PARTIAL;
1558 		else if (txp->flags & XEN_NETTXF_data_validated)
1559 			skb->ip_summed = CHECKSUM_UNNECESSARY;
1560 
1561 		xenvif_fill_frags(vif, skb);
1562 
1563 		if (skb_is_nonlinear(skb) && skb_headlen(skb) < PKT_PROT_LEN) {
1564 			int target = min_t(int, skb->len, PKT_PROT_LEN);
1565 			__pskb_pull_tail(skb, target - skb_headlen(skb));
1566 		}
1567 
1568 		skb->dev      = vif->dev;
1569 		skb->protocol = eth_type_trans(skb, skb->dev);
1570 		skb_reset_network_header(skb);
1571 
1572 		if (checksum_setup(vif, skb)) {
1573 			netdev_dbg(vif->dev,
1574 				   "Can't setup checksum in net_tx_action\n");
1575 			kfree_skb(skb);
1576 			continue;
1577 		}
1578 
1579 		skb_probe_transport_header(skb, 0);
1580 
1581 		/* If the packet is GSO then we will have just set up the
1582 		 * transport header offset in checksum_setup so it's now
1583 		 * straightforward to calculate gso_segs.
1584 		 */
1585 		if (skb_is_gso(skb)) {
1586 			int mss = skb_shinfo(skb)->gso_size;
1587 			int hdrlen = skb_transport_header(skb) -
1588 				skb_mac_header(skb) +
1589 				tcp_hdrlen(skb);
1590 
1591 			skb_shinfo(skb)->gso_segs =
1592 				DIV_ROUND_UP(skb->len - hdrlen, mss);
1593 		}
1594 
1595 		vif->dev->stats.rx_bytes += skb->len;
1596 		vif->dev->stats.rx_packets++;
1597 
1598 		work_done++;
1599 
1600 		netif_receive_skb(skb);
1601 	}
1602 
1603 	return work_done;
1604 }
1605 
1606 /* Called after netfront has transmitted */
1607 int xenvif_tx_action(struct xenvif *vif, int budget)
1608 {
1609 	unsigned nr_gops;
1610 	int work_done;
1611 
1612 	if (unlikely(!tx_work_todo(vif)))
1613 		return 0;
1614 
1615 	nr_gops = xenvif_tx_build_gops(vif, budget);
1616 
1617 	if (nr_gops == 0)
1618 		return 0;
1619 
1620 	gnttab_batch_copy(vif->tx_copy_ops, nr_gops);
1621 
1622 	work_done = xenvif_tx_submit(vif);
1623 
1624 	return work_done;
1625 }
1626 
1627 static void xenvif_idx_release(struct xenvif *vif, u16 pending_idx,
1628 			       u8 status)
1629 {
1630 	struct pending_tx_info *pending_tx_info;
1631 	pending_ring_idx_t head;
1632 	u16 peek; /* peek into next tx request */
1633 
1634 	BUG_ON(vif->mmap_pages[pending_idx] == (void *)(~0UL));
1635 
1636 	/* Already complete? */
1637 	if (vif->mmap_pages[pending_idx] == NULL)
1638 		return;
1639 
1640 	pending_tx_info = &vif->pending_tx_info[pending_idx];
1641 
1642 	head = pending_tx_info->head;
1643 
1644 	BUG_ON(!pending_tx_is_head(vif, head));
1645 	BUG_ON(vif->pending_ring[pending_index(head)] != pending_idx);
1646 
1647 	do {
1648 		pending_ring_idx_t index;
1649 		pending_ring_idx_t idx = pending_index(head);
1650 		u16 info_idx = vif->pending_ring[idx];
1651 
1652 		pending_tx_info = &vif->pending_tx_info[info_idx];
1653 		make_tx_response(vif, &pending_tx_info->req, status);
1654 
1655 		/* Setting any number other than
1656 		 * INVALID_PENDING_RING_IDX indicates this slot is
1657 		 * starting a new packet / ending a previous packet.
1658 		 */
1659 		pending_tx_info->head = 0;
1660 
1661 		index = pending_index(vif->pending_prod++);
1662 		vif->pending_ring[index] = vif->pending_ring[info_idx];
1663 
1664 		peek = vif->pending_ring[pending_index(++head)];
1665 
1666 	} while (!pending_tx_is_head(vif, peek));
1667 
1668 	put_page(vif->mmap_pages[pending_idx]);
1669 	vif->mmap_pages[pending_idx] = NULL;
1670 }
1671 
1672 
1673 static void make_tx_response(struct xenvif *vif,
1674 			     struct xen_netif_tx_request *txp,
1675 			     s8       st)
1676 {
1677 	RING_IDX i = vif->tx.rsp_prod_pvt;
1678 	struct xen_netif_tx_response *resp;
1679 	int notify;
1680 
1681 	resp = RING_GET_RESPONSE(&vif->tx, i);
1682 	resp->id     = txp->id;
1683 	resp->status = st;
1684 
1685 	if (txp->flags & XEN_NETTXF_extra_info)
1686 		RING_GET_RESPONSE(&vif->tx, ++i)->status = XEN_NETIF_RSP_NULL;
1687 
1688 	vif->tx.rsp_prod_pvt = ++i;
1689 	RING_PUSH_RESPONSES_AND_CHECK_NOTIFY(&vif->tx, notify);
1690 	if (notify)
1691 		notify_remote_via_irq(vif->tx_irq);
1692 }
1693 
1694 static struct xen_netif_rx_response *make_rx_response(struct xenvif *vif,
1695 					     u16      id,
1696 					     s8       st,
1697 					     u16      offset,
1698 					     u16      size,
1699 					     u16      flags)
1700 {
1701 	RING_IDX i = vif->rx.rsp_prod_pvt;
1702 	struct xen_netif_rx_response *resp;
1703 
1704 	resp = RING_GET_RESPONSE(&vif->rx, i);
1705 	resp->offset     = offset;
1706 	resp->flags      = flags;
1707 	resp->id         = id;
1708 	resp->status     = (s16)size;
1709 	if (st < 0)
1710 		resp->status = (s16)st;
1711 
1712 	vif->rx.rsp_prod_pvt = ++i;
1713 
1714 	return resp;
1715 }
1716 
1717 static inline int rx_work_todo(struct xenvif *vif)
1718 {
1719 	return !skb_queue_empty(&vif->rx_queue) || vif->rx_event;
1720 }
1721 
1722 static inline int tx_work_todo(struct xenvif *vif)
1723 {
1724 
1725 	if (likely(RING_HAS_UNCONSUMED_REQUESTS(&vif->tx)) &&
1726 	    (nr_pending_reqs(vif) + XEN_NETBK_LEGACY_SLOTS_MAX
1727 	     < MAX_PENDING_REQS))
1728 		return 1;
1729 
1730 	return 0;
1731 }
1732 
1733 void xenvif_unmap_frontend_rings(struct xenvif *vif)
1734 {
1735 	if (vif->tx.sring)
1736 		xenbus_unmap_ring_vfree(xenvif_to_xenbus_device(vif),
1737 					vif->tx.sring);
1738 	if (vif->rx.sring)
1739 		xenbus_unmap_ring_vfree(xenvif_to_xenbus_device(vif),
1740 					vif->rx.sring);
1741 }
1742 
1743 int xenvif_map_frontend_rings(struct xenvif *vif,
1744 			      grant_ref_t tx_ring_ref,
1745 			      grant_ref_t rx_ring_ref)
1746 {
1747 	void *addr;
1748 	struct xen_netif_tx_sring *txs;
1749 	struct xen_netif_rx_sring *rxs;
1750 
1751 	int err = -ENOMEM;
1752 
1753 	err = xenbus_map_ring_valloc(xenvif_to_xenbus_device(vif),
1754 				     tx_ring_ref, &addr);
1755 	if (err)
1756 		goto err;
1757 
1758 	txs = (struct xen_netif_tx_sring *)addr;
1759 	BACK_RING_INIT(&vif->tx, txs, PAGE_SIZE);
1760 
1761 	err = xenbus_map_ring_valloc(xenvif_to_xenbus_device(vif),
1762 				     rx_ring_ref, &addr);
1763 	if (err)
1764 		goto err;
1765 
1766 	rxs = (struct xen_netif_rx_sring *)addr;
1767 	BACK_RING_INIT(&vif->rx, rxs, PAGE_SIZE);
1768 
1769 	return 0;
1770 
1771 err:
1772 	xenvif_unmap_frontend_rings(vif);
1773 	return err;
1774 }
1775 
1776 void xenvif_stop_queue(struct xenvif *vif)
1777 {
1778 	if (!vif->can_queue)
1779 		return;
1780 
1781 	netif_stop_queue(vif->dev);
1782 }
1783 
1784 static void xenvif_start_queue(struct xenvif *vif)
1785 {
1786 	if (xenvif_schedulable(vif))
1787 		netif_wake_queue(vif->dev);
1788 }
1789 
1790 int xenvif_kthread(void *data)
1791 {
1792 	struct xenvif *vif = data;
1793 	struct sk_buff *skb;
1794 
1795 	while (!kthread_should_stop()) {
1796 		wait_event_interruptible(vif->wq,
1797 					 rx_work_todo(vif) ||
1798 					 kthread_should_stop());
1799 		if (kthread_should_stop())
1800 			break;
1801 
1802 		if (!skb_queue_empty(&vif->rx_queue))
1803 			xenvif_rx_action(vif);
1804 
1805 		vif->rx_event = false;
1806 
1807 		if (skb_queue_empty(&vif->rx_queue) &&
1808 		    netif_queue_stopped(vif->dev))
1809 			xenvif_start_queue(vif);
1810 
1811 		cond_resched();
1812 	}
1813 
1814 	/* Bin any remaining skbs */
1815 	while ((skb = skb_dequeue(&vif->rx_queue)) != NULL)
1816 		dev_kfree_skb(skb);
1817 
1818 	return 0;
1819 }
1820 
1821 static int __init netback_init(void)
1822 {
1823 	int rc = 0;
1824 
1825 	if (!xen_domain())
1826 		return -ENODEV;
1827 
1828 	if (fatal_skb_slots < XEN_NETBK_LEGACY_SLOTS_MAX) {
1829 		pr_info("fatal_skb_slots too small (%d), bump it to XEN_NETBK_LEGACY_SLOTS_MAX (%d)\n",
1830 			fatal_skb_slots, XEN_NETBK_LEGACY_SLOTS_MAX);
1831 		fatal_skb_slots = XEN_NETBK_LEGACY_SLOTS_MAX;
1832 	}
1833 
1834 	rc = xenvif_xenbus_init();
1835 	if (rc)
1836 		goto failed_init;
1837 
1838 	return 0;
1839 
1840 failed_init:
1841 	return rc;
1842 }
1843 
1844 module_init(netback_init);
1845 
1846 static void __exit netback_fini(void)
1847 {
1848 	xenvif_xenbus_fini();
1849 }
1850 module_exit(netback_fini);
1851 
1852 MODULE_LICENSE("Dual BSD/GPL");
1853 MODULE_ALIAS("xen-backend:vif");
1854