GNU Linux-libre 4.9.333-gnu1
[releases.git] / drivers / net / xen-netback / rx.c
1 /*
2  * Copyright (c) 2016 Citrix Systems Inc.
3  * Copyright (c) 2002-2005, K A Fraser
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License version 2
7  * as published by the Free Software Foundation; or, when distributed
8  * separately from the Linux kernel or incorporated into other
9  * software packages, subject to the following license:
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining a copy
12  * of this source file (the "Software"), to deal in the Software without
13  * restriction, including without limitation the rights to use, copy, modify,
14  * merge, publish, distribute, sublicense, and/or sell copies of the Software,
15  * and to permit persons to whom the Software is furnished to do so, subject to
16  * the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be included in
19  * all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
27  * IN THE SOFTWARE.
28  */
29 #include "common.h"
30
31 #include <linux/kthread.h>
32
33 #include <xen/xen.h>
34 #include <xen/events.h>
35
36 /*
37  * Update the needed ring page slots for the first SKB queued.
38  * Note that any call sequence outside the RX thread calling this function
39  * needs to wake up the RX thread via a call of xenvif_kick_thread()
40  * afterwards in order to avoid a race with putting the thread to sleep.
41  */
42 static void xenvif_update_needed_slots(struct xenvif_queue *queue,
43                                        const struct sk_buff *skb)
44 {
45         unsigned int needed = 0;
46
47         if (skb) {
48                 needed = DIV_ROUND_UP(skb->len, XEN_PAGE_SIZE);
49                 if (skb_is_gso(skb))
50                         needed++;
51                 if (skb->sw_hash)
52                         needed++;
53         }
54
55         WRITE_ONCE(queue->rx_slots_needed, needed);
56 }
57
58 static bool xenvif_rx_ring_slots_available(struct xenvif_queue *queue)
59 {
60         RING_IDX prod, cons;
61         unsigned int needed;
62
63         needed = READ_ONCE(queue->rx_slots_needed);
64         if (!needed)
65                 return false;
66
67         do {
68                 prod = queue->rx.sring->req_prod;
69                 cons = queue->rx.req_cons;
70
71                 if (prod - cons >= needed)
72                         return true;
73
74                 queue->rx.sring->req_event = prod + 1;
75
76                 /* Make sure event is visible before we check prod
77                  * again.
78                  */
79                 mb();
80         } while (queue->rx.sring->req_prod != prod);
81
82         return false;
83 }
84
85 void xenvif_rx_queue_tail(struct xenvif_queue *queue, struct sk_buff *skb)
86 {
87         unsigned long flags;
88
89         spin_lock_irqsave(&queue->rx_queue.lock, flags);
90
91         if (queue->rx_queue_len >= queue->rx_queue_max) {
92                 struct net_device *dev = queue->vif->dev;
93
94                 netif_tx_stop_queue(netdev_get_tx_queue(dev, queue->id));
95                 kfree_skb(skb);
96                 queue->vif->dev->stats.rx_dropped++;
97         } else {
98                 if (skb_queue_empty(&queue->rx_queue))
99                         xenvif_update_needed_slots(queue, skb);
100
101                 __skb_queue_tail(&queue->rx_queue, skb);
102
103                 queue->rx_queue_len += skb->len;
104         }
105
106         spin_unlock_irqrestore(&queue->rx_queue.lock, flags);
107 }
108
109 static struct sk_buff *xenvif_rx_dequeue(struct xenvif_queue *queue)
110 {
111         struct sk_buff *skb;
112
113         spin_lock_irq(&queue->rx_queue.lock);
114
115         skb = __skb_dequeue(&queue->rx_queue);
116         if (skb) {
117                 xenvif_update_needed_slots(queue, skb_peek(&queue->rx_queue));
118
119                 queue->rx_queue_len -= skb->len;
120                 if (queue->rx_queue_len < queue->rx_queue_max) {
121                         struct netdev_queue *txq;
122
123                         txq = netdev_get_tx_queue(queue->vif->dev, queue->id);
124                         netif_tx_wake_queue(txq);
125                 }
126         }
127
128         spin_unlock_irq(&queue->rx_queue.lock);
129
130         return skb;
131 }
132
133 static void xenvif_rx_queue_purge(struct xenvif_queue *queue)
134 {
135         struct sk_buff *skb;
136
137         while ((skb = xenvif_rx_dequeue(queue)) != NULL)
138                 kfree_skb(skb);
139 }
140
141 static void xenvif_rx_queue_drop_expired(struct xenvif_queue *queue)
142 {
143         struct sk_buff *skb;
144
145         for (;;) {
146                 skb = skb_peek(&queue->rx_queue);
147                 if (!skb)
148                         break;
149                 if (time_before(jiffies, XENVIF_RX_CB(skb)->expires))
150                         break;
151                 xenvif_rx_dequeue(queue);
152                 kfree_skb(skb);
153                 queue->vif->dev->stats.rx_dropped++;
154         }
155 }
156
157 static void xenvif_rx_copy_flush(struct xenvif_queue *queue)
158 {
159         unsigned int i;
160         int notify;
161
162         gnttab_batch_copy(queue->rx_copy.op, queue->rx_copy.num);
163
164         for (i = 0; i < queue->rx_copy.num; i++) {
165                 struct gnttab_copy *op;
166
167                 op = &queue->rx_copy.op[i];
168
169                 /* If the copy failed, overwrite the status field in
170                  * the corresponding response.
171                  */
172                 if (unlikely(op->status != GNTST_okay)) {
173                         struct xen_netif_rx_response *rsp;
174
175                         rsp = RING_GET_RESPONSE(&queue->rx,
176                                                 queue->rx_copy.idx[i]);
177                         rsp->status = op->status;
178                 }
179         }
180
181         queue->rx_copy.num = 0;
182
183         /* Push responses for all completed packets. */
184         RING_PUSH_RESPONSES_AND_CHECK_NOTIFY(&queue->rx, notify);
185         if (notify)
186                 notify_remote_via_irq(queue->rx_irq);
187
188         __skb_queue_purge(queue->rx_copy.completed);
189 }
190
191 static void xenvif_rx_copy_add(struct xenvif_queue *queue,
192                                struct xen_netif_rx_request *req,
193                                unsigned int offset, void *data, size_t len)
194 {
195         struct gnttab_copy *op;
196         struct page *page;
197         struct xen_page_foreign *foreign;
198
199         if (queue->rx_copy.num == COPY_BATCH_SIZE)
200                 xenvif_rx_copy_flush(queue);
201
202         op = &queue->rx_copy.op[queue->rx_copy.num];
203
204         page = virt_to_page(data);
205
206         op->flags = GNTCOPY_dest_gref;
207
208         foreign = xen_page_foreign(page);
209         if (foreign) {
210                 op->source.domid = foreign->domid;
211                 op->source.u.ref = foreign->gref;
212                 op->flags |= GNTCOPY_source_gref;
213         } else {
214                 op->source.u.gmfn = virt_to_gfn(data);
215                 op->source.domid  = DOMID_SELF;
216         }
217
218         op->source.offset = xen_offset_in_page(data);
219         op->dest.u.ref    = req->gref;
220         op->dest.domid    = queue->vif->domid;
221         op->dest.offset   = offset;
222         op->len           = len;
223
224         queue->rx_copy.idx[queue->rx_copy.num] = queue->rx.req_cons;
225         queue->rx_copy.num++;
226 }
227
228 static unsigned int xenvif_gso_type(struct sk_buff *skb)
229 {
230         if (skb_is_gso(skb)) {
231                 if (skb_shinfo(skb)->gso_type & SKB_GSO_TCPV4)
232                         return XEN_NETIF_GSO_TYPE_TCPV4;
233                 else
234                         return XEN_NETIF_GSO_TYPE_TCPV6;
235         }
236         return XEN_NETIF_GSO_TYPE_NONE;
237 }
238
239 struct xenvif_pkt_state {
240         struct sk_buff *skb;
241         size_t remaining_len;
242         struct sk_buff *frag_iter;
243         int frag; /* frag == -1 => frag_iter->head */
244         unsigned int frag_offset;
245         struct xen_netif_extra_info extras[XEN_NETIF_EXTRA_TYPE_MAX - 1];
246         unsigned int extra_count;
247         unsigned int slot;
248 };
249
250 static void xenvif_rx_next_skb(struct xenvif_queue *queue,
251                                struct xenvif_pkt_state *pkt)
252 {
253         struct sk_buff *skb;
254         unsigned int gso_type;
255
256         skb = xenvif_rx_dequeue(queue);
257
258         queue->stats.tx_bytes += skb->len;
259         queue->stats.tx_packets++;
260
261         /* Reset packet state. */
262         memset(pkt, 0, sizeof(struct xenvif_pkt_state));
263
264         pkt->skb = skb;
265         pkt->frag_iter = skb;
266         pkt->remaining_len = skb->len;
267         pkt->frag = -1;
268
269         gso_type = xenvif_gso_type(skb);
270         if ((1 << gso_type) & queue->vif->gso_mask) {
271                 struct xen_netif_extra_info *extra;
272
273                 extra = &pkt->extras[XEN_NETIF_EXTRA_TYPE_GSO - 1];
274
275                 extra->u.gso.type = gso_type;
276                 extra->u.gso.size = skb_shinfo(skb)->gso_size;
277                 extra->u.gso.pad = 0;
278                 extra->u.gso.features = 0;
279                 extra->type = XEN_NETIF_EXTRA_TYPE_GSO;
280                 extra->flags = 0;
281
282                 pkt->extra_count++;
283         }
284
285         if (skb->sw_hash) {
286                 struct xen_netif_extra_info *extra;
287
288                 extra = &pkt->extras[XEN_NETIF_EXTRA_TYPE_HASH - 1];
289
290                 extra->u.hash.algorithm =
291                         XEN_NETIF_CTRL_HASH_ALGORITHM_TOEPLITZ;
292
293                 if (skb->l4_hash)
294                         extra->u.hash.type =
295                                 skb->protocol == htons(ETH_P_IP) ?
296                                 _XEN_NETIF_CTRL_HASH_TYPE_IPV4_TCP :
297                                 _XEN_NETIF_CTRL_HASH_TYPE_IPV6_TCP;
298                 else
299                         extra->u.hash.type =
300                                 skb->protocol == htons(ETH_P_IP) ?
301                                 _XEN_NETIF_CTRL_HASH_TYPE_IPV4 :
302                                 _XEN_NETIF_CTRL_HASH_TYPE_IPV6;
303
304                 *(uint32_t *)extra->u.hash.value = skb_get_hash_raw(skb);
305
306                 extra->type = XEN_NETIF_EXTRA_TYPE_HASH;
307                 extra->flags = 0;
308
309                 pkt->extra_count++;
310         }
311 }
312
313 static void xenvif_rx_complete(struct xenvif_queue *queue,
314                                struct xenvif_pkt_state *pkt)
315 {
316         /* All responses are ready to be pushed. */
317         queue->rx.rsp_prod_pvt = queue->rx.req_cons;
318
319         __skb_queue_tail(queue->rx_copy.completed, pkt->skb);
320 }
321
322 static void xenvif_rx_next_frag(struct xenvif_pkt_state *pkt)
323 {
324         struct sk_buff *frag_iter = pkt->frag_iter;
325         unsigned int nr_frags = skb_shinfo(frag_iter)->nr_frags;
326
327         pkt->frag++;
328         pkt->frag_offset = 0;
329
330         if (pkt->frag >= nr_frags) {
331                 if (frag_iter == pkt->skb)
332                         pkt->frag_iter = skb_shinfo(frag_iter)->frag_list;
333                 else
334                         pkt->frag_iter = frag_iter->next;
335
336                 pkt->frag = -1;
337         }
338 }
339
340 static void xenvif_rx_next_chunk(struct xenvif_queue *queue,
341                                  struct xenvif_pkt_state *pkt,
342                                  unsigned int offset, void **data,
343                                  size_t *len)
344 {
345         struct sk_buff *frag_iter = pkt->frag_iter;
346         void *frag_data;
347         size_t frag_len, chunk_len;
348
349         BUG_ON(!frag_iter);
350
351         if (pkt->frag == -1) {
352                 frag_data = frag_iter->data;
353                 frag_len = skb_headlen(frag_iter);
354         } else {
355                 skb_frag_t *frag = &skb_shinfo(frag_iter)->frags[pkt->frag];
356
357                 frag_data = skb_frag_address(frag);
358                 frag_len = skb_frag_size(frag);
359         }
360
361         frag_data += pkt->frag_offset;
362         frag_len -= pkt->frag_offset;
363
364         chunk_len = min_t(size_t, frag_len, XEN_PAGE_SIZE - offset);
365         chunk_len = min_t(size_t, chunk_len, XEN_PAGE_SIZE -
366                                              xen_offset_in_page(frag_data));
367
368         pkt->frag_offset += chunk_len;
369
370         /* Advance to next frag? */
371         if (frag_len == chunk_len)
372                 xenvif_rx_next_frag(pkt);
373
374         *data = frag_data;
375         *len = chunk_len;
376 }
377
378 static void xenvif_rx_data_slot(struct xenvif_queue *queue,
379                                 struct xenvif_pkt_state *pkt,
380                                 struct xen_netif_rx_request *req,
381                                 struct xen_netif_rx_response *rsp)
382 {
383         unsigned int offset = 0;
384         unsigned int flags;
385
386         do {
387                 size_t len;
388                 void *data;
389
390                 xenvif_rx_next_chunk(queue, pkt, offset, &data, &len);
391                 xenvif_rx_copy_add(queue, req, offset, data, len);
392
393                 offset += len;
394                 pkt->remaining_len -= len;
395
396         } while (offset < XEN_PAGE_SIZE && pkt->remaining_len > 0);
397
398         if (pkt->remaining_len > 0)
399                 flags = XEN_NETRXF_more_data;
400         else
401                 flags = 0;
402
403         if (pkt->slot == 0) {
404                 struct sk_buff *skb = pkt->skb;
405
406                 if (skb->ip_summed == CHECKSUM_PARTIAL)
407                         flags |= XEN_NETRXF_csum_blank |
408                                  XEN_NETRXF_data_validated;
409                 else if (skb->ip_summed == CHECKSUM_UNNECESSARY)
410                         flags |= XEN_NETRXF_data_validated;
411
412                 if (pkt->extra_count != 0)
413                         flags |= XEN_NETRXF_extra_info;
414         }
415
416         rsp->offset = 0;
417         rsp->flags = flags;
418         rsp->id = req->id;
419         rsp->status = (s16)offset;
420 }
421
422 static void xenvif_rx_extra_slot(struct xenvif_queue *queue,
423                                  struct xenvif_pkt_state *pkt,
424                                  struct xen_netif_rx_request *req,
425                                  struct xen_netif_rx_response *rsp)
426 {
427         struct xen_netif_extra_info *extra = (void *)rsp;
428         unsigned int i;
429
430         pkt->extra_count--;
431
432         for (i = 0; i < ARRAY_SIZE(pkt->extras); i++) {
433                 if (pkt->extras[i].type) {
434                         *extra = pkt->extras[i];
435
436                         if (pkt->extra_count != 0)
437                                 extra->flags |= XEN_NETIF_EXTRA_FLAG_MORE;
438
439                         pkt->extras[i].type = 0;
440                         return;
441                 }
442         }
443         BUG();
444 }
445
446 void xenvif_rx_skb(struct xenvif_queue *queue)
447 {
448         struct xenvif_pkt_state pkt;
449
450         xenvif_rx_next_skb(queue, &pkt);
451
452         queue->last_rx_time = jiffies;
453
454         do {
455                 struct xen_netif_rx_request *req;
456                 struct xen_netif_rx_response *rsp;
457
458                 req = RING_GET_REQUEST(&queue->rx, queue->rx.req_cons);
459                 rsp = RING_GET_RESPONSE(&queue->rx, queue->rx.req_cons);
460
461                 /* Extras must go after the first data slot */
462                 if (pkt.slot != 0 && pkt.extra_count != 0)
463                         xenvif_rx_extra_slot(queue, &pkt, req, rsp);
464                 else
465                         xenvif_rx_data_slot(queue, &pkt, req, rsp);
466
467                 queue->rx.req_cons++;
468                 pkt.slot++;
469         } while (pkt.remaining_len > 0 || pkt.extra_count != 0);
470
471         xenvif_rx_complete(queue, &pkt);
472 }
473
474 #define RX_BATCH_SIZE 64
475
476 void xenvif_rx_action(struct xenvif_queue *queue)
477 {
478         struct sk_buff_head completed_skbs;
479         unsigned int work_done = 0;
480
481         __skb_queue_head_init(&completed_skbs);
482         queue->rx_copy.completed = &completed_skbs;
483
484         while (xenvif_rx_ring_slots_available(queue) &&
485                !skb_queue_empty(&queue->rx_queue) &&
486                work_done < RX_BATCH_SIZE) {
487                 xenvif_rx_skb(queue);
488                 work_done++;
489         }
490
491         /* Flush any pending copies and complete all skbs. */
492         xenvif_rx_copy_flush(queue);
493 }
494
495 static RING_IDX xenvif_rx_queue_slots(const struct xenvif_queue *queue)
496 {
497         RING_IDX prod, cons;
498
499         prod = queue->rx.sring->req_prod;
500         cons = queue->rx.req_cons;
501
502         return prod - cons;
503 }
504
505 static bool xenvif_rx_queue_stalled(const struct xenvif_queue *queue)
506 {
507         unsigned int needed = READ_ONCE(queue->rx_slots_needed);
508
509         return !queue->stalled &&
510                 xenvif_rx_queue_slots(queue) < needed &&
511                 time_after(jiffies,
512                            queue->last_rx_time + queue->vif->stall_timeout);
513 }
514
515 static bool xenvif_rx_queue_ready(struct xenvif_queue *queue)
516 {
517         unsigned int needed = READ_ONCE(queue->rx_slots_needed);
518
519         return queue->stalled && xenvif_rx_queue_slots(queue) >= needed;
520 }
521
522 bool xenvif_have_rx_work(struct xenvif_queue *queue, bool test_kthread)
523 {
524         return xenvif_rx_ring_slots_available(queue) ||
525                 (queue->vif->stall_timeout &&
526                  (xenvif_rx_queue_stalled(queue) ||
527                   xenvif_rx_queue_ready(queue))) ||
528                 (test_kthread && kthread_should_stop()) ||
529                 queue->vif->disabled;
530 }
531
532 static long xenvif_rx_queue_timeout(struct xenvif_queue *queue)
533 {
534         struct sk_buff *skb;
535         long timeout;
536
537         skb = skb_peek(&queue->rx_queue);
538         if (!skb)
539                 return MAX_SCHEDULE_TIMEOUT;
540
541         timeout = XENVIF_RX_CB(skb)->expires - jiffies;
542         return timeout < 0 ? 0 : timeout;
543 }
544
545 /* Wait until the guest Rx thread has work.
546  *
547  * The timeout needs to be adjusted based on the current head of the
548  * queue (and not just the head at the beginning).  In particular, if
549  * the queue is initially empty an infinite timeout is used and this
550  * needs to be reduced when a skb is queued.
551  *
552  * This cannot be done with wait_event_timeout() because it only
553  * calculates the timeout once.
554  */
555 static void xenvif_wait_for_rx_work(struct xenvif_queue *queue)
556 {
557         DEFINE_WAIT(wait);
558
559         if (xenvif_have_rx_work(queue, true))
560                 return;
561
562         for (;;) {
563                 long ret;
564
565                 prepare_to_wait(&queue->wq, &wait, TASK_INTERRUPTIBLE);
566                 if (xenvif_have_rx_work(queue, true))
567                         break;
568                 if (atomic_fetch_andnot(NETBK_RX_EOI | NETBK_COMMON_EOI,
569                                         &queue->eoi_pending) &
570                     (NETBK_RX_EOI | NETBK_COMMON_EOI))
571                         xen_irq_lateeoi(queue->rx_irq, 0);
572
573                 ret = schedule_timeout(xenvif_rx_queue_timeout(queue));
574                 if (!ret)
575                         break;
576         }
577         finish_wait(&queue->wq, &wait);
578 }
579
580 static void xenvif_queue_carrier_off(struct xenvif_queue *queue)
581 {
582         struct xenvif *vif = queue->vif;
583
584         queue->stalled = true;
585
586         /* At least one queue has stalled? Disable the carrier. */
587         spin_lock(&vif->lock);
588         if (vif->stalled_queues++ == 0) {
589                 netdev_info(vif->dev, "Guest Rx stalled");
590                 netif_carrier_off(vif->dev);
591         }
592         spin_unlock(&vif->lock);
593 }
594
595 static void xenvif_queue_carrier_on(struct xenvif_queue *queue)
596 {
597         struct xenvif *vif = queue->vif;
598
599         queue->last_rx_time = jiffies; /* Reset Rx stall detection. */
600         queue->stalled = false;
601
602         /* All queues are ready? Enable the carrier. */
603         spin_lock(&vif->lock);
604         if (--vif->stalled_queues == 0) {
605                 netdev_info(vif->dev, "Guest Rx ready");
606                 netif_carrier_on(vif->dev);
607         }
608         spin_unlock(&vif->lock);
609 }
610
611 int xenvif_kthread_guest_rx(void *data)
612 {
613         struct xenvif_queue *queue = data;
614         struct xenvif *vif = queue->vif;
615
616         if (!vif->stall_timeout)
617                 xenvif_queue_carrier_on(queue);
618
619         for (;;) {
620                 xenvif_wait_for_rx_work(queue);
621
622                 if (kthread_should_stop())
623                         break;
624
625                 /* This frontend is found to be rogue, disable it in
626                  * kthread context. Currently this is only set when
627                  * netback finds out frontend sends malformed packet,
628                  * but we cannot disable the interface in softirq
629                  * context so we defer it here, if this thread is
630                  * associated with queue 0.
631                  */
632                 if (unlikely(vif->disabled && queue->id == 0)) {
633                         xenvif_carrier_off(vif);
634                         break;
635                 }
636
637                 if (!skb_queue_empty(&queue->rx_queue))
638                         xenvif_rx_action(queue);
639
640                 /* If the guest hasn't provided any Rx slots for a
641                  * while it's probably not responsive, drop the
642                  * carrier so packets are dropped earlier.
643                  */
644                 if (vif->stall_timeout) {
645                         if (xenvif_rx_queue_stalled(queue))
646                                 xenvif_queue_carrier_off(queue);
647                         else if (xenvif_rx_queue_ready(queue))
648                                 xenvif_queue_carrier_on(queue);
649                 }
650
651                 /* Queued packets may have foreign pages from other
652                  * domains.  These cannot be queued indefinitely as
653                  * this would starve guests of grant refs and transmit
654                  * slots.
655                  */
656                 xenvif_rx_queue_drop_expired(queue);
657
658                 cond_resched();
659         }
660
661         /* Bin any remaining skbs */
662         xenvif_rx_queue_purge(queue);
663
664         return 0;
665 }