drivers/net/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
  48 typedef unsigned int pending_ring_idx_t;
  49 #define INVALID_PENDING_RING_IDX (~0U)
  50
  51 struct pending_tx_info {
  52         struct xen_netif_tx_request req; /* tx request */
  53         /* Callback data for released SKBs. The callback is always
  54          * xenvif_zerocopy_callback, desc contains the pending_idx, which is
  55          * also an index in pending_tx_info array. It is initialized in
  56          * xenvif_alloc and it never changes.
  57          * skb_shinfo(skb)->destructor_arg points to the first mapped slot's
  58          * callback_struct in this array of struct pending_tx_info's, then ctx
  59          * to the next, or NULL if there is no more slot for this skb.
  60          * ubuf_to_vif is a helper which finds the struct xenvif from a pointer
  61          * to this field.
  62          */
  63         struct ubuf_info callback_struct;
  64 };
  65
  66 #define XEN_NETIF_TX_RING_SIZE __CONST_RING_SIZE(xen_netif_tx, PAGE_SIZE)
  67 #define XEN_NETIF_RX_RING_SIZE __CONST_RING_SIZE(xen_netif_rx, PAGE_SIZE)
  68
  69 struct xenvif_rx_meta {
  70         int id;
  71         int size;
  72         int gso_type;
  73         int gso_size;
  74 };
  75
  76 #define GSO_BIT(type) \
  77         (1 << XEN_NETIF_GSO_TYPE_ ## type)
  78
  79 /* Discriminate from any valid pending_idx value. */
  80 #define INVALID_PENDING_IDX 0xFFFF
  81
  82 #define MAX_BUFFER_OFFSET PAGE_SIZE
  83
  84 #define MAX_PENDING_REQS 256
  85
  86 /* It's possible for an skb to have a maximal number of frags
  87  * but still be less than MAX_BUFFER_OFFSET in size. Thus the
  88  * worst-case number of copy operations is MAX_SKB_FRAGS per
  89  * ring slot.
  90  */
  91 #define MAX_GRANT_COPY_OPS (MAX_SKB_FRAGS * XEN_NETIF_RX_RING_SIZE)
  92
  93 #define NETBACK_INVALID_HANDLE -1
  94
  95 /* To avoid confusion, we define XEN_NETBK_LEGACY_SLOTS_MAX indicating
  96  * the maximum slots a valid packet can use. Now this value is defined
  97  * to be XEN_NETIF_NR_SLOTS_MIN, which is supposed to be supported by
  98  * all backend.
  99  */
 100 #define XEN_NETBK_LEGACY_SLOTS_MAX XEN_NETIF_NR_SLOTS_MIN
 101
 102 struct xenvif {
 103         /* Unique identifier for this interface. */
 104         domid_t          domid;
 105         unsigned int     handle;
 106
 107         /* Use NAPI for guest TX */
 108         struct napi_struct napi;
 109         /* When feature-split-event-channels = 0, tx_irq = rx_irq. */
 110         unsigned int tx_irq;
 111         /* Only used when feature-split-event-channels = 1 */
 112         char tx_irq_name[IFNAMSIZ+4]; /* DEVNAME-tx */
 113         struct xen_netif_tx_back_ring tx;
 114         struct sk_buff_head tx_queue;
 115         struct page *mmap_pages[MAX_PENDING_REQS];
 116         pending_ring_idx_t pending_prod;
 117         pending_ring_idx_t pending_cons;
 118         u16 pending_ring[MAX_PENDING_REQS];
 119         struct pending_tx_info pending_tx_info[MAX_PENDING_REQS];
 120         grant_handle_t grant_tx_handle[MAX_PENDING_REQS];
 121
 122         struct gnttab_map_grant_ref tx_map_ops[MAX_PENDING_REQS];
 123         struct gnttab_unmap_grant_ref tx_unmap_ops[MAX_PENDING_REQS];
 124         /* passed to gnttab_[un]map_refs with pages under (un)mapping */
 125         struct page *pages_to_map[MAX_PENDING_REQS];
 126         struct page *pages_to_unmap[MAX_PENDING_REQS];
 127
 128         /* This prevents zerocopy callbacks  to race over dealloc_ring */
 129         spinlock_t callback_lock;
 130         /* This prevents dealloc thread and NAPI instance to race over response
 131          * creation and pending_ring in xenvif_idx_release. In xenvif_tx_err
 132          * it only protect response creation
 133          */
 134         spinlock_t response_lock;
 135         pending_ring_idx_t dealloc_prod;
 136         pending_ring_idx_t dealloc_cons;
 137         u16 dealloc_ring[MAX_PENDING_REQS];
 138         struct task_struct *dealloc_task;
 139         wait_queue_head_t dealloc_wq;
 140         struct timer_list dealloc_delay;
 141         bool dealloc_delay_timed_out;
 142
 143         /* Use kthread for guest RX */
 144         struct task_struct *task;
 145         wait_queue_head_t wq;
 146         /* When feature-split-event-channels = 0, tx_irq = rx_irq. */
 147         unsigned int rx_irq;
 148         /* Only used when feature-split-event-channels = 1 */
 149         char rx_irq_name[IFNAMSIZ+4]; /* DEVNAME-rx */
 150         struct xen_netif_rx_back_ring rx;
 151         struct sk_buff_head rx_queue;
 152         RING_IDX rx_last_skb_slots;
 153         bool rx_queue_purge;
 154
 155         struct timer_list wake_queue;
 156
 157         /* This array is allocated seperately as it is large */
 158         struct gnttab_copy *grant_copy_op;
 159
 160         /* We create one meta structure per ring request we consume, so
 161          * the maximum number is the same as the ring size.
 162          */
 163         struct xenvif_rx_meta meta[XEN_NETIF_RX_RING_SIZE];
 164
 165         u8               fe_dev_addr[6];
 166
 167         /* Frontend feature information. */
 168         int gso_mask;
 169         int gso_prefix_mask;
 170
 171         u8 can_sg:1;
 172         u8 ip_csum:1;
 173         u8 ipv6_csum:1;
 174
 175         /* Internal feature information. */
 176         u8 can_queue:1;     /* can queue packets for receiver? */
 177
 178         /* Transmit shaping: allow 'credit_bytes' every 'credit_usec'. */
 179         unsigned long   credit_bytes;
 180         unsigned long   credit_usec;
 181         unsigned long   remaining_credit;
 182         struct timer_list credit_timeout;
 183         u64 credit_window_start;
 184
 185         /* Statistics */
 186         unsigned long rx_gso_checksum_fixup;
 187         unsigned long tx_zerocopy_sent;
 188         unsigned long tx_zerocopy_success;
 189         unsigned long tx_zerocopy_fail;
 190         unsigned long tx_frag_overflow;
 191
 192         /* Miscellaneous private stuff. */
 193         struct net_device *dev;
 194 };
 195
 196 static inline struct xenbus_device *xenvif_to_xenbus_device(struct xenvif *vif)
 197 {
 198         return to_xenbus_device(vif->dev->dev.parent);
 199 }
 200
 201 struct xenvif *xenvif_alloc(struct device *parent,
 202                             domid_t domid,
 203                             unsigned int handle);
 204
 205 int xenvif_connect(struct xenvif *vif, unsigned long tx_ring_ref,
 206                    unsigned long rx_ring_ref, unsigned int tx_evtchn,
 207                    unsigned int rx_evtchn);
 208 void xenvif_disconnect(struct xenvif *vif);
 209 void xenvif_free(struct xenvif *vif);
 210
 211 int xenvif_xenbus_init(void);
 212 void xenvif_xenbus_fini(void);
 213
 214 int xenvif_schedulable(struct xenvif *vif);
 215
 216 int xenvif_must_stop_queue(struct xenvif *vif);
 217
 218 /* (Un)Map communication rings. */
 219 void xenvif_unmap_frontend_rings(struct xenvif *vif);
 220 int xenvif_map_frontend_rings(struct xenvif *vif,
 221                               grant_ref_t tx_ring_ref,
 222                               grant_ref_t rx_ring_ref);
 223
 224 /* Check for SKBs from frontend and schedule backend processing */
 225 void xenvif_check_rx_xenvif(struct xenvif *vif);
 226
 227 /* Prevent the device from generating any further traffic. */
 228 void xenvif_carrier_off(struct xenvif *vif);
 229
 230 int xenvif_tx_action(struct xenvif *vif, int budget);
 231
 232 int xenvif_kthread_guest_rx(void *data);
 233 void xenvif_kick_thread(struct xenvif *vif);
 234
 235 int xenvif_dealloc_kthread(void *data);
 236
 237 /* Determine whether the needed number of slots (req) are available,
 238  * and set req_event if not.
 239  */
 240 bool xenvif_rx_ring_slots_available(struct xenvif *vif, int needed);
 241
 242 void xenvif_stop_queue(struct xenvif *vif);
 243
 244 /* Callback from stack when TX packet can be released */
 245 void xenvif_zerocopy_callback(struct ubuf_info *ubuf, bool zerocopy_success);
 246
 247 /* Unmap a pending page and release it back to the guest */
 248 void xenvif_idx_unmap(struct xenvif *vif, u16 pending_idx);
 249
 250 static inline pending_ring_idx_t nr_pending_reqs(struct xenvif *vif)
 251 {
 252         return MAX_PENDING_REQS -
 253                 vif->pending_prod + vif->pending_cons;
 254 }
 255
 256 static inline bool xenvif_tx_pending_slots_available(struct xenvif *vif)
 257 {
 258         return nr_pending_reqs(vif) + XEN_NETBK_LEGACY_SLOTS_MAX
 259                 < MAX_PENDING_REQS;
 260 }
 261
 262 /* Callback from stack when TX packet can be released */
 263 void xenvif_zerocopy_callback(struct ubuf_info *ubuf, bool zerocopy_success);
 264
 265 extern bool separate_tx_rx_irq;
 266
 267 extern unsigned int rx_drain_timeout_msecs;
 268 extern unsigned int rx_drain_timeout_jiffies;
 269
 270 #endif /* __XEN_NETBACK__COMMON_H__ */