Commit | Line | Data |
---|---|---|
b530cc79 | 1 | /* |
fea511a6 | 2 | * The Virtio 9p transport driver |
b530cc79 | 3 | * |
e2735b77 EVH |
4 | * This is a block based transport driver based on the lguest block driver |
5 | * code. | |
b530cc79 | 6 | * |
fea511a6 | 7 | * Copyright (C) 2007, 2008 Eric Van Hensbergen, IBM Corporation |
b530cc79 EVH |
8 | * |
9 | * Based on virtio console driver | |
10 | * Copyright (C) 2006, 2007 Rusty Russell, IBM Corporation | |
11 | * | |
12 | * This program is free software; you can redistribute it and/or modify | |
13 | * it under the terms of the GNU General Public License version 2 | |
14 | * as published by the Free Software Foundation. | |
15 | * | |
16 | * This program is distributed in the hope that it will be useful, | |
17 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | * GNU General Public License for more details. | |
20 | * | |
21 | * You should have received a copy of the GNU General Public License | |
22 | * along with this program; if not, write to: | |
23 | * Free Software Foundation | |
24 | * 51 Franklin Street, Fifth Floor | |
25 | * Boston, MA 02111-1301 USA | |
26 | * | |
27 | */ | |
28 | ||
29 | #include <linux/in.h> | |
30 | #include <linux/module.h> | |
31 | #include <linux/net.h> | |
32 | #include <linux/ipv6.h> | |
33 | #include <linux/errno.h> | |
34 | #include <linux/kernel.h> | |
35 | #include <linux/un.h> | |
36 | #include <linux/uaccess.h> | |
37 | #include <linux/inet.h> | |
38 | #include <linux/idr.h> | |
39 | #include <linux/file.h> | |
40 | #include <net/9p/9p.h> | |
41 | #include <linux/parser.h> | |
8b81ef58 | 42 | #include <net/9p/client.h> |
b530cc79 EVH |
43 | #include <net/9p/transport.h> |
44 | #include <linux/scatterlist.h> | |
45 | #include <linux/virtio.h> | |
46 | #include <linux/virtio_9p.h> | |
47 | ||
e2735b77 EVH |
48 | #define VIRTQUEUE_NUM 128 |
49 | ||
b530cc79 | 50 | /* a single mutex to manage channel initialization and attachment */ |
c1549497 | 51 | static DEFINE_MUTEX(virtio_9p_lock); |
b530cc79 EVH |
52 | /* global which tracks highest initialized channel */ |
53 | static int chan_index; | |
54 | ||
ee443996 EVH |
55 | /** |
56 | * struct virtio_chan - per-instance transport information | |
57 | * @initialized: whether the channel is initialized | |
58 | * @inuse: whether the channel is in use | |
59 | * @lock: protects multiple elements within this structure | |
60 | * @vdev: virtio dev associated with this channel | |
61 | * @vq: virtio queue associated with this channel | |
62 | * @tagpool: accounting for tag ids (and request slots) | |
63 | * @reqs: array of request slots | |
64 | * @max_tag: current number of request_slots allocated | |
65 | * @sg: scatter gather list which is used to pack a request (protected?) | |
66 | * | |
67 | * We keep all per-channel information in a structure. | |
b530cc79 EVH |
68 | * This structure is allocated within the devices dev->mem space. |
69 | * A pointer to the structure will get put in the transport private. | |
ee443996 | 70 | * |
b530cc79 | 71 | */ |
ee443996 | 72 | |
b530cc79 | 73 | static struct virtio_chan { |
ee443996 EVH |
74 | bool initialized; |
75 | bool inuse; | |
b530cc79 | 76 | |
e2735b77 EVH |
77 | spinlock_t lock; |
78 | ||
fea511a6 | 79 | struct p9_client *client; |
b530cc79 | 80 | struct virtio_device *vdev; |
e2735b77 | 81 | struct virtqueue *vq; |
b530cc79 | 82 | |
e2735b77 EVH |
83 | /* Scatterlist: can be too big for stack. */ |
84 | struct scatterlist sg[VIRTQUEUE_NUM]; | |
b530cc79 EVH |
85 | } channels[MAX_9P_CHAN]; |
86 | ||
87 | /* How many bytes left in this page. */ | |
88 | static unsigned int rest_of_page(void *data) | |
89 | { | |
90 | return PAGE_SIZE - ((unsigned long)data % PAGE_SIZE); | |
91 | } | |
92 | ||
ee443996 EVH |
93 | /** |
94 | * p9_virtio_close - reclaim resources of a channel | |
95 | * @trans: transport state | |
96 | * | |
97 | * This reclaims a channel by freeing its resources and | |
98 | * reseting its inuse flag. | |
99 | * | |
100 | */ | |
101 | ||
8b81ef58 | 102 | static void p9_virtio_close(struct p9_client *client) |
e2735b77 | 103 | { |
8b81ef58 | 104 | struct virtio_chan *chan = client->trans; |
b530cc79 | 105 | |
c1549497 | 106 | mutex_lock(&virtio_9p_lock); |
e2735b77 | 107 | chan->inuse = false; |
c1549497 | 108 | mutex_unlock(&virtio_9p_lock); |
b530cc79 EVH |
109 | } |
110 | ||
ee443996 EVH |
111 | /** |
112 | * req_done - callback which signals activity from the server | |
113 | * @vq: virtio queue activity was received on | |
114 | * | |
115 | * This notifies us that the server has triggered some activity | |
116 | * on the virtio channel - most likely a response to request we | |
117 | * sent. Figure out which requests now have responses and wake up | |
118 | * those threads. | |
119 | * | |
120 | * Bugs: could do with some additional sanity checking, but appears to work. | |
121 | * | |
122 | */ | |
123 | ||
e2735b77 | 124 | static void req_done(struct virtqueue *vq) |
b530cc79 | 125 | { |
e2735b77 EVH |
126 | struct virtio_chan *chan = vq->vdev->priv; |
127 | struct p9_fcall *rc; | |
128 | unsigned int len; | |
e2735b77 EVH |
129 | struct p9_req_t *req; |
130 | ||
91b8534f EVH |
131 | P9_DPRINTK(P9_DEBUG_TRANS, ": request done\n"); |
132 | ||
e2735b77 | 133 | while ((rc = chan->vq->vq_ops->get_buf(chan->vq, &len)) != NULL) { |
91b8534f EVH |
134 | P9_DPRINTK(P9_DEBUG_TRANS, ": rc %p\n", rc); |
135 | P9_DPRINTK(P9_DEBUG_TRANS, ": lookup tag %d\n", rc->tag); | |
fea511a6 | 136 | req = p9_tag_lookup(chan->client, rc->tag); |
1bab88b2 | 137 | req->status = REQ_STATUS_RCVD; |
91b8534f | 138 | p9_client_cb(chan->client, req); |
e2735b77 | 139 | } |
e2735b77 | 140 | } |
b530cc79 | 141 | |
ee443996 EVH |
142 | /** |
143 | * pack_sg_list - pack a scatter gather list from a linear buffer | |
144 | * @sg: scatter/gather list to pack into | |
145 | * @start: which segment of the sg_list to start at | |
146 | * @limit: maximum segment to pack data to | |
147 | * @data: data to pack into scatter/gather list | |
148 | * @count: amount of data to pack into the scatter/gather list | |
149 | * | |
150 | * sg_lists have multiple segments of various sizes. This will pack | |
151 | * arbitrary data into an existing scatter gather list, segmenting the | |
152 | * data as necessary within constraints. | |
153 | * | |
154 | */ | |
155 | ||
e2735b77 EVH |
156 | static int |
157 | pack_sg_list(struct scatterlist *sg, int start, int limit, char *data, | |
158 | int count) | |
159 | { | |
160 | int s; | |
161 | int index = start; | |
162 | ||
163 | while (count) { | |
164 | s = rest_of_page(data); | |
165 | if (s > count) | |
166 | s = count; | |
167 | sg_set_buf(&sg[index++], data, s); | |
168 | count -= s; | |
169 | data += s; | |
d6584f3a | 170 | BUG_ON(index > limit); |
e2735b77 | 171 | } |
b530cc79 | 172 | |
e2735b77 | 173 | return index-start; |
b530cc79 EVH |
174 | } |
175 | ||
91b8534f EVH |
176 | /* We don't currently allow canceling of virtio requests */ |
177 | static int p9_virtio_cancel(struct p9_client *client, struct p9_req_t *req) | |
178 | { | |
179 | return 1; | |
180 | } | |
181 | ||
ee443996 | 182 | /** |
91b8534f | 183 | * p9_virtio_request - issue a request |
ee443996 EVH |
184 | * @t: transport state |
185 | * @tc: &p9_fcall request to transmit | |
186 | * @rc: &p9_fcall to put reponse into | |
187 | * | |
188 | */ | |
189 | ||
e2735b77 | 190 | static int |
91b8534f | 191 | p9_virtio_request(struct p9_client *client, struct p9_req_t *req) |
b530cc79 | 192 | { |
e2735b77 | 193 | int in, out; |
91b8534f EVH |
194 | struct virtio_chan *chan = client->trans; |
195 | char *rdata = (char *)req->rc+sizeof(struct p9_fcall); | |
b530cc79 | 196 | |
91b8534f | 197 | P9_DPRINTK(P9_DEBUG_TRANS, "9p debug: virtio request\n"); |
b530cc79 | 198 | |
91b8534f EVH |
199 | out = pack_sg_list(chan->sg, 0, VIRTQUEUE_NUM, req->tc->sdata, |
200 | req->tc->size); | |
201 | in = pack_sg_list(chan->sg, out, VIRTQUEUE_NUM-out, rdata, | |
202 | client->msize); | |
b530cc79 | 203 | |
e2735b77 | 204 | req->status = REQ_STATUS_SENT; |
b530cc79 | 205 | |
91b8534f | 206 | if (chan->vq->vq_ops->add_buf(chan->vq, chan->sg, out, in, req->tc)) { |
e2735b77 EVH |
207 | P9_DPRINTK(P9_DEBUG_TRANS, |
208 | "9p debug: virtio rpc add_buf returned failure"); | |
209 | return -EIO; | |
210 | } | |
b530cc79 | 211 | |
e2735b77 | 212 | chan->vq->vq_ops->kick(chan->vq); |
b530cc79 | 213 | |
91b8534f | 214 | P9_DPRINTK(P9_DEBUG_TRANS, "9p debug: virtio request kicked\n"); |
e2735b77 | 215 | return 0; |
b530cc79 EVH |
216 | } |
217 | ||
ee443996 EVH |
218 | /** |
219 | * p9_virtio_probe - probe for existence of 9P virtio channels | |
220 | * @vdev: virtio device to probe | |
221 | * | |
222 | * This probes for existing virtio channels. At present only | |
223 | * a single channel is in use, so in the future more work may need | |
224 | * to be done here. | |
225 | * | |
226 | */ | |
227 | ||
e2735b77 | 228 | static int p9_virtio_probe(struct virtio_device *vdev) |
b530cc79 EVH |
229 | { |
230 | int err; | |
231 | struct virtio_chan *chan; | |
232 | int index; | |
233 | ||
c1549497 | 234 | mutex_lock(&virtio_9p_lock); |
b530cc79 EVH |
235 | index = chan_index++; |
236 | chan = &channels[index]; | |
c1549497 | 237 | mutex_unlock(&virtio_9p_lock); |
b530cc79 EVH |
238 | |
239 | if (chan_index > MAX_9P_CHAN) { | |
240 | printk(KERN_ERR "9p: virtio: Maximum channels exceeded\n"); | |
241 | BUG(); | |
b530cc79 EVH |
242 | err = -ENOMEM; |
243 | goto fail; | |
244 | } | |
245 | ||
e2735b77 | 246 | chan->vdev = vdev; |
b530cc79 | 247 | |
e2735b77 | 248 | /* We expect one virtqueue, for requests. */ |
d2a7ddda | 249 | chan->vq = virtio_find_single_vq(vdev, req_done, "requests"); |
e2735b77 EVH |
250 | if (IS_ERR(chan->vq)) { |
251 | err = PTR_ERR(chan->vq); | |
252 | goto out_free_vq; | |
b530cc79 | 253 | } |
e2735b77 EVH |
254 | chan->vq->vdev->priv = chan; |
255 | spin_lock_init(&chan->lock); | |
b530cc79 | 256 | |
e2735b77 | 257 | sg_init_table(chan->sg, VIRTQUEUE_NUM); |
b530cc79 | 258 | |
b530cc79 EVH |
259 | chan->inuse = false; |
260 | chan->initialized = true; | |
b530cc79 EVH |
261 | return 0; |
262 | ||
e2735b77 | 263 | out_free_vq: |
d2a7ddda | 264 | vdev->config->del_vqs(vdev); |
b530cc79 | 265 | fail: |
c1549497 | 266 | mutex_lock(&virtio_9p_lock); |
b530cc79 | 267 | chan_index--; |
c1549497 | 268 | mutex_unlock(&virtio_9p_lock); |
b530cc79 EVH |
269 | return err; |
270 | } | |
271 | ||
ee443996 EVH |
272 | |
273 | /** | |
274 | * p9_virtio_create - allocate a new virtio channel | |
8b81ef58 | 275 | * @client: client instance invoking this transport |
ee443996 EVH |
276 | * @devname: string identifying the channel to connect to (unused) |
277 | * @args: args passed from sys_mount() for per-transport options (unused) | |
ee443996 EVH |
278 | * |
279 | * This sets up a transport channel for 9p communication. Right now | |
b530cc79 EVH |
280 | * we only match the first available channel, but eventually we couldlook up |
281 | * alternate channels by matching devname versus a virtio_config entry. | |
282 | * We use a simple reference count mechanism to ensure that only a single | |
ee443996 EVH |
283 | * mount has a channel open at a time. |
284 | * | |
285 | * Bugs: doesn't allow identification of a specific channel | |
286 | * to allocate, channels are allocated sequentially. This was | |
287 | * a pragmatic decision to get things rolling, but ideally some | |
288 | * way of identifying the channel to attach to would be nice | |
289 | * if we are going to support multiple channels. | |
290 | * | |
291 | */ | |
292 | ||
8b81ef58 EVH |
293 | static int |
294 | p9_virtio_create(struct p9_client *client, const char *devname, char *args) | |
b530cc79 | 295 | { |
b530cc79 | 296 | struct virtio_chan *chan = channels; |
e2735b77 | 297 | int index = 0; |
b530cc79 | 298 | |
c1549497 | 299 | mutex_lock(&virtio_9p_lock); |
b530cc79 EVH |
300 | while (index < MAX_9P_CHAN) { |
301 | if (chan->initialized && !chan->inuse) { | |
302 | chan->inuse = true; | |
303 | break; | |
304 | } else { | |
305 | index++; | |
306 | chan = &channels[index]; | |
307 | } | |
308 | } | |
c1549497 | 309 | mutex_unlock(&virtio_9p_lock); |
b530cc79 EVH |
310 | |
311 | if (index >= MAX_9P_CHAN) { | |
e2735b77 | 312 | printk(KERN_ERR "9p: no channels available\n"); |
8b81ef58 | 313 | return -ENODEV; |
e2735b77 EVH |
314 | } |
315 | ||
8b81ef58 | 316 | client->trans = (void *)chan; |
fea511a6 | 317 | chan->client = client; |
b530cc79 | 318 | |
8b81ef58 | 319 | return 0; |
b530cc79 EVH |
320 | } |
321 | ||
ee443996 EVH |
322 | /** |
323 | * p9_virtio_remove - clean up resources associated with a virtio device | |
324 | * @vdev: virtio device to remove | |
325 | * | |
326 | */ | |
327 | ||
f3933545 EVH |
328 | static void p9_virtio_remove(struct virtio_device *vdev) |
329 | { | |
330 | struct virtio_chan *chan = vdev->priv; | |
331 | ||
332 | BUG_ON(chan->inuse); | |
333 | ||
334 | if (chan->initialized) { | |
d2a7ddda | 335 | vdev->config->del_vqs(vdev); |
f3933545 EVH |
336 | chan->initialized = false; |
337 | } | |
338 | } | |
339 | ||
b530cc79 EVH |
340 | #define VIRTIO_ID_9P 9 |
341 | ||
342 | static struct virtio_device_id id_table[] = { | |
343 | { VIRTIO_ID_9P, VIRTIO_DEV_ANY_ID }, | |
344 | { 0 }, | |
345 | }; | |
346 | ||
347 | /* The standard "struct lguest_driver": */ | |
348 | static struct virtio_driver p9_virtio_drv = { | |
349 | .driver.name = KBUILD_MODNAME, | |
350 | .driver.owner = THIS_MODULE, | |
351 | .id_table = id_table, | |
352 | .probe = p9_virtio_probe, | |
f3933545 | 353 | .remove = p9_virtio_remove, |
b530cc79 EVH |
354 | }; |
355 | ||
356 | static struct p9_trans_module p9_virtio_trans = { | |
357 | .name = "virtio", | |
358 | .create = p9_virtio_create, | |
8b81ef58 | 359 | .close = p9_virtio_close, |
91b8534f EVH |
360 | .request = p9_virtio_request, |
361 | .cancel = p9_virtio_cancel, | |
e2735b77 | 362 | .maxsize = PAGE_SIZE*16, |
b530cc79 | 363 | .def = 0, |
72029fe8 | 364 | .owner = THIS_MODULE, |
b530cc79 EVH |
365 | }; |
366 | ||
367 | /* The standard init function */ | |
368 | static int __init p9_virtio_init(void) | |
369 | { | |
370 | int count; | |
371 | ||
372 | for (count = 0; count < MAX_9P_CHAN; count++) | |
373 | channels[count].initialized = false; | |
374 | ||
375 | v9fs_register_trans(&p9_virtio_trans); | |
376 | return register_virtio_driver(&p9_virtio_drv); | |
377 | } | |
378 | ||
f3933545 EVH |
379 | static void __exit p9_virtio_cleanup(void) |
380 | { | |
381 | unregister_virtio_driver(&p9_virtio_drv); | |
72029fe8 | 382 | v9fs_unregister_trans(&p9_virtio_trans); |
f3933545 EVH |
383 | } |
384 | ||
b530cc79 | 385 | module_init(p9_virtio_init); |
f3933545 | 386 | module_exit(p9_virtio_cleanup); |
b530cc79 EVH |
387 | |
388 | MODULE_DEVICE_TABLE(virtio, id_table); | |
389 | MODULE_AUTHOR("Eric Van Hensbergen <ericvh@gmail.com>"); | |
390 | MODULE_DESCRIPTION("Virtio 9p Transport"); | |
391 | MODULE_LICENSE("GPL"); |