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