vkernel - Settable serial numbers for virtual disks.
[dragonfly.git] / sys / dev / virtual / vkernel / disk / vdisk.c
1 /*
2  * Copyright (c) 2006 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  */
35
36 /*
37  * Virtual disk driver
38  */
39 #include <sys/types.h>
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/kernel.h>
43 #include <sys/malloc.h>
44 #include <sys/conf.h>
45 #include <sys/bus.h>
46 #include <sys/buf.h>
47 #include <sys/devicestat.h>
48 #include <sys/disk.h>
49 #include <machine/cothread.h>
50 #include <machine/md_var.h>
51
52 #include <sys/buf2.h>
53
54 #include <sys/stat.h>
55 #include <unistd.h>
56
57 struct vkd_softc {
58         struct bio_queue_head bio_queue;
59         struct devstat stats;
60         struct disk disk;
61         cothread_t      cotd;
62         TAILQ_HEAD(, bio) cotd_queue;
63         TAILQ_HEAD(, bio) cotd_done;
64         cdev_t dev;
65         int unit;
66         int fd;
67 };
68
69 static void vkd_io_thread(cothread_t cotd);
70 static void vkd_io_intr(cothread_t cotd);
71 static void vkd_doio(struct vkd_softc *sc, struct bio *bio);
72
73 static d_strategy_t     vkdstrategy;
74 static d_open_t         vkdopen;
75
76 static struct dev_ops vkd_ops = {
77         { "vkd", 0, D_DISK },
78         .d_open =       vkdopen,
79         .d_close =      nullclose,
80         .d_read =       physread,
81         .d_write =      physwrite,
82         .d_strategy =   vkdstrategy,
83 };
84
85 static void
86 vkdinit(void *dummy __unused)
87 {
88         struct vkdisk_info *dsk;
89         struct vkd_softc *sc;
90         struct disk_info info;
91         struct stat st;
92         int i;
93
94         for (i = 0; i < DiskNum; i++) {
95                 /* check that the 'bus device' has been initialized */
96                 dsk = &DiskInfo[i];
97                 if (dsk == NULL || dsk->type != VKD_DISK)
98                         continue;
99                 if (dsk->fd < 0 || fstat(dsk->fd, &st) < 0)
100                         continue;
101
102                 /*
103                  * Devices may return a st_size of 0, try to use
104                  * lseek.
105                  */
106                 if (st.st_size == 0) {
107                         st.st_size = lseek(dsk->fd, 0L, SEEK_END);
108                         if (st.st_size == -1)
109                                 st.st_size = 0;
110                 }
111
112                 /* and create a new device */
113                 sc = kmalloc(sizeof(*sc), M_DEVBUF, M_WAITOK | M_ZERO);
114                 sc->unit = dsk->unit;
115                 sc->fd = dsk->fd;
116                 bioq_init(&sc->bio_queue);
117                 devstat_add_entry(&sc->stats, "vkd", sc->unit, DEV_BSIZE,
118                                   DEVSTAT_NO_ORDERED_TAGS,
119                                   DEVSTAT_TYPE_DIRECT | DEVSTAT_TYPE_IF_OTHER,
120                                   DEVSTAT_PRIORITY_DISK);
121                 sc->dev = disk_create(sc->unit, &sc->disk, &vkd_ops);
122                 sc->dev->si_drv1 = sc;
123                 sc->dev->si_iosize_max = min(MAXPHYS,256*1024);
124
125                 TAILQ_INIT(&sc->cotd_queue);
126                 TAILQ_INIT(&sc->cotd_done);
127                 sc->cotd = cothread_create(vkd_io_thread, vkd_io_intr, sc,
128                                            "vkd");
129
130                 bzero(&info, sizeof(info));
131                 info.d_media_blksize = DEV_BSIZE;
132                 info.d_media_blocks = st.st_size / info.d_media_blksize;
133
134                 info.d_nheads = 1;
135                 info.d_ncylinders = 1;
136                 info.d_secpertrack = info.d_media_blocks;
137                 info.d_secpercyl = info.d_secpertrack * info.d_nheads;
138
139                 if (dsk->serno) {
140                         info.d_serialno = kmalloc(SERNOLEN, M_TEMP, M_WAITOK | M_ZERO);
141                         strlcpy(info.d_serialno, dsk->serno, SERNOLEN);
142                 }
143                 disk_setdiskinfo(&sc->disk, &info);
144         }
145 }
146
147 SYSINIT(vkdisk, SI_SUB_DRIVERS, SI_ORDER_FIRST, vkdinit, NULL);
148
149 static int
150 vkdopen(struct dev_open_args *ap)
151 {
152         struct vkd_softc *sc;
153         /* struct disk_info info; */
154         struct stat st;
155         cdev_t dev;
156
157         dev = ap->a_head.a_dev;
158         sc = dev->si_drv1;
159         if (fstat(sc->fd, &st) < 0)
160                 return(ENXIO);
161
162         /*
163          * Devices may return a st_size of 0, try to use
164          * lseek.
165          */
166         if (st.st_size == 0) {
167                 st.st_size = lseek(sc->fd, 0L, SEEK_END);
168                 if (st.st_size == -1)
169                         st.st_size = 0;
170         }
171         if (st.st_size == 0)
172                 return(ENXIO);
173
174 /*
175         bzero(&info, sizeof(info));
176         info.d_media_blksize = DEV_BSIZE;
177         info.d_media_blocks = st.st_size / info.d_media_blksize;
178
179         info.d_nheads = 1;
180         info.d_ncylinders = 1;
181         info.d_secpertrack = info.d_media_blocks;
182         info.d_secpercyl = info.d_secpertrack * info.d_nheads;
183
184         disk_setdiskinfo(&sc->disk, &info); */
185         return(0);
186 }
187
188 static int
189 vkdstrategy(struct dev_strategy_args *ap)
190 {
191         struct bio *bio = ap->a_bio;
192         struct vkd_softc *sc;
193         cdev_t dev;
194
195         dev = ap->a_head.a_dev;
196         sc = dev->si_drv1;
197
198         devstat_start_transaction(&sc->stats);
199         cothread_lock(sc->cotd, 0);
200         TAILQ_INSERT_TAIL(&sc->cotd_queue, bio, bio_act);
201         cothread_signal(sc->cotd);
202         cothread_unlock(sc->cotd, 0);
203
204         return(0);
205 }
206
207 static
208 void
209 vkd_io_intr(cothread_t cotd)
210 {
211         struct vkd_softc *sc;
212         struct bio *bio;
213         TAILQ_HEAD(, bio) tmpq;
214
215         sc = cotd->arg;
216
217         /*
218          * We can't call back into the kernel while holding cothread!
219          */
220         TAILQ_INIT(&tmpq);
221         cothread_lock(cotd, 0);
222         while ((bio = TAILQ_FIRST(&sc->cotd_done)) != NULL) {
223                 TAILQ_REMOVE(&sc->cotd_done, bio, bio_act);
224                 TAILQ_INSERT_TAIL(&tmpq, bio, bio_act);
225         }
226         cothread_unlock(cotd, 0);
227
228         while ((bio = TAILQ_FIRST(&tmpq)) != NULL) {
229                 TAILQ_REMOVE(&tmpq, bio, bio_act);
230                 devstat_end_transaction_buf(&sc->stats, bio->bio_buf);
231                 biodone(bio);
232         }
233 }
234
235 /*
236  * WARNING!  This runs as a cothread and has no access to mycpu nor can it
237  * make vkernel-specific calls other then cothread_*() calls.
238  *
239  * WARNING!  A signal can occur and be discarded prior to our initial
240  * call to cothread_lock().  Process pending I/O before waiting.
241  */
242 static
243 void
244 vkd_io_thread(cothread_t cotd)
245 {
246         struct bio *bio;
247         struct vkd_softc *sc = cotd->arg;
248         int count;
249
250         cothread_lock(cotd, 1);
251         for (;;) {
252                 count = 0;
253                 while ((bio = TAILQ_FIRST(&sc->cotd_queue)) != NULL) {
254                         TAILQ_REMOVE(&sc->cotd_queue, bio, bio_act);
255                         cothread_unlock(cotd, 1);
256                         vkd_doio(sc, bio);
257                         cothread_lock(cotd, 1);
258                         TAILQ_INSERT_TAIL(&sc->cotd_done, bio, bio_act);
259                         if (++count == 8) {
260                                 cothread_intr(cotd);
261                                 count = 0;
262                         }
263                 }
264                 if (count)
265                         cothread_intr(cotd);
266                 cothread_wait(cotd);    /* interlocks cothread lock */
267         }
268         /* NOT REACHED */
269         cothread_unlock(cotd, 1);
270 }
271
272 static
273 void
274 vkd_doio(struct vkd_softc *sc, struct bio *bio)
275 {
276         struct buf *bp = bio->bio_buf;
277         int n;
278
279         switch(bp->b_cmd) {
280         case BUF_CMD_READ:
281                 n = pread(sc->fd, bp->b_data, bp->b_bcount, bio->bio_offset);
282                 break;
283         case BUF_CMD_WRITE:
284                 /* XXX HANDLE SHORT WRITE XXX */
285                 n = pwrite(sc->fd, bp->b_data, bp->b_bcount, bio->bio_offset);
286                 break;
287         case BUF_CMD_FLUSH:
288                 if (fsync(sc->fd) < 0)
289                         n = -1;
290                 else
291                         n = bp->b_bcount;
292                 break;
293         default:
294                 panic("vkd: bad b_cmd %d", bp->b_cmd);
295                 break; /* not reached */
296         }
297         if (n != bp->b_bcount) {
298                 bp->b_error = EIO;
299                 bp->b_flags |= B_ERROR;
300         }
301         bp->b_resid = bp->b_bcount - n;
302 }