Fix compile warning.
[dragonfly.git] / sys / vfs / mfs / mfs_vnops.c
1 /*
2  * Copyright (c) 1989, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by the University of
16  *      California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *      @(#)mfs_vnops.c 8.11 (Berkeley) 5/22/95
34  * $FreeBSD: src/sys/ufs/mfs/mfs_vnops.c,v 1.47.2.1 2001/05/22 02:06:43 bp Exp $
35  * $DragonFly: src/sys/vfs/mfs/mfs_vnops.c,v 1.13 2004/05/19 22:53:04 dillon Exp $
36  */
37
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
41 #include <sys/proc.h>
42 #include <sys/buf.h>
43 #include <sys/vnode.h>
44 #include <sys/malloc.h>
45 #include <sys/sysproto.h>
46 #include <sys/mman.h>
47 #include <sys/conf.h>
48
49 #include <sys/buf2.h>
50
51 #include "mfsnode.h"
52 #include "mfs_extern.h"
53
54 static int      mfs_badop (struct vop_generic_args *);
55 static int      mfs_bmap (struct vop_bmap_args *);
56 static int      mfs_close (struct vop_close_args *);
57 static int      mfs_fsync (struct vop_fsync_args *);
58 static int      mfs_freeblks (struct vop_freeblks_args *);
59 static int      mfs_inactive (struct vop_inactive_args *); /* XXX */
60 static int      mfs_open (struct vop_open_args *);
61 static int      mfs_reclaim (struct vop_reclaim_args *); /* XXX */
62 static int      mfs_print (struct vop_print_args *); /* XXX */
63 static int      mfs_strategy (struct vop_strategy_args *); /* XXX */
64 static int      mfs_getpages (struct vop_getpages_args *); /* XXX */
65 /*
66  * mfs vnode operations.
67  */
68 vop_t **mfs_vnodeop_p;
69 static struct vnodeopv_entry_desc mfs_vnodeop_entries[] = {
70         { &vop_default_desc,            (vop_t *) mfs_badop },
71         { &vop_bmap_desc,               (vop_t *) mfs_bmap },
72         { &vop_bwrite_desc,             (vop_t *) vop_defaultop },
73         { &vop_close_desc,              (vop_t *) mfs_close },
74         { &vop_createvobject_desc,      (vop_t *) vop_stdcreatevobject },
75         { &vop_destroyvobject_desc,     (vop_t *) vop_stddestroyvobject },
76         { &vop_freeblks_desc,           (vop_t *) mfs_freeblks },
77         { &vop_fsync_desc,              (vop_t *) mfs_fsync },
78         { &vop_getpages_desc,           (vop_t *) mfs_getpages },
79         { &vop_getvobject_desc,         (vop_t *) vop_stdgetvobject },
80         { &vop_inactive_desc,           (vop_t *) mfs_inactive },
81         { &vop_ioctl_desc,              (vop_t *) vop_enotty },
82         { &vop_islocked_desc,           (vop_t *) vop_defaultop },
83         { &vop_lock_desc,               (vop_t *) vop_defaultop },
84         { &vop_open_desc,               (vop_t *) mfs_open },
85         { &vop_print_desc,              (vop_t *) mfs_print },
86         { &vop_reclaim_desc,            (vop_t *) mfs_reclaim },
87         { &vop_strategy_desc,           (vop_t *) mfs_strategy },
88         { &vop_unlock_desc,             (vop_t *) vop_defaultop },
89         { NULL, NULL }
90 };
91 static struct vnodeopv_desc mfs_vnodeop_opv_desc =
92         { &mfs_vnodeop_p, mfs_vnodeop_entries };
93
94 VNODEOP_SET(mfs_vnodeop_opv_desc);
95
96 /*
97  * Vnode Operations.
98  *
99  * Open called to allow memory filesystem to initialize and
100  * validate before actual IO. Record our process identifier
101  * so we can tell when we are doing I/O to ourself.
102  *
103  * NOTE: new device sequencing.  mounts check the device reference count
104  * before calling open, so we must associate the device in open and 
105  * disassociate it in close rather then faking it when we created the vnode.
106  *
107  * mfs_open(struct vnode *a_vp, int a_mode, struct ucred *a_cred,
108  *          struct thread *a_td)
109  */
110 /* ARGSUSED */
111 static int
112 mfs_open(struct vop_open_args *ap)
113 {
114         struct vnode *vp = ap->a_vp;
115
116         if (vp->v_type != VCHR)
117                 panic("mfs_open not VCHR");
118         v_associate_rdev(vp, udev2dev(vp->v_udev, 0));
119         return (0);
120 }
121
122 static int
123 mfs_fsync(struct vop_fsync_args *ap)
124 {
125         return (VOCALL(spec_vnodeop_p, VOFFSET(vop_fsync), ap));
126 }
127
128 /*
129  * mfs_freeblks() - hook to allow us to free physical memory.
130  *
131  *      We implement the B_FREEBUF strategy.  We can't just madvise()
132  *      here because we have to do it in the correct order vs other bio
133  *      requests, so we queue it.
134  *
135  *      Note: geteblk() sets B_INVAL.  We leave it set to guarentee buffer
136  *      throw-away on brelse()? XXX
137  *
138  * mfs_freeblks(struct vnode *a_vp, daddr_t a_addr, daddr_t a_length)
139  */
140 static int
141 mfs_freeblks(struct vop_freeblks_args *ap)
142 {       
143         struct buf *bp;
144         struct vnode *vp = ap->a_vp;
145
146         bp = geteblk(ap->a_length);
147         bp->b_flags |= B_FREEBUF | B_ASYNC;
148         bp->b_dev = vp->v_rdev;
149         bp->b_blkno = ap->a_addr;
150         bp->b_offset = dbtob(ap->a_addr);
151         bp->b_bcount = ap->a_length;
152         BUF_KERNPROC(bp);
153         VOP_STRATEGY(vp, bp);
154         return(0);
155 }
156
157 /*
158  * Pass I/O requests to the memory filesystem process.
159  *
160  * mfs_strategy(struct vnode *a_vp, struct buf *a_bp)
161  */
162 static int
163 mfs_strategy(struct vop_strategy_args *ap)
164 {
165         struct buf *bp = ap->a_bp;
166         struct mfsnode *mfsp;
167         struct thread *td = curthread;          /* XXX */
168         int s;
169
170         bp->b_dev = ap->a_vp->v_rdev;
171         mfsp = bp->b_dev->si_drv1;
172         if (mfsp == NULL) {
173                 bp->b_error = ENXIO;
174                 bp->b_flags |= B_ERROR;
175                 biodone(bp);
176                 return(0);
177         }
178
179         /*
180          * splbio required for queueing/dequeueing, in case of forwarded
181          * BPs from bio interrupts (?).  It may not be necessary.
182          */
183
184         s = splbio();
185
186         if (mfsp->mfs_td == NULL) {
187                 /*
188                  * mini-root.  Note: B_FREEBUF not supported at the moment,
189                  * I'm not sure what kind of dataspace b_data is in.
190                  */
191                 caddr_t base;
192
193                 base = mfsp->mfs_baseoff + (bp->b_blkno << DEV_BSHIFT);
194                 if (bp->b_flags & B_FREEBUF)
195                         ;
196                 if (bp->b_flags & B_READ)
197                         bcopy(base, bp->b_data, bp->b_bcount);
198                 else
199                         bcopy(bp->b_data, base, bp->b_bcount);
200                 biodone(bp);
201         } else if (mfsp->mfs_td == td) {
202                 /*
203                  * VOP to self
204                  */
205                 splx(s);
206                 mfs_doio(bp, mfsp);
207                 s = splbio();
208         } else {
209                 /*
210                  * VOP from some other process, queue to MFS process and
211                  * wake it up.
212                  */
213                 bufq_insert_tail(&mfsp->buf_queue, bp);
214                 wakeup((caddr_t)mfsp);
215         }
216         splx(s);
217         return (0);
218 }
219
220 /*
221  * Memory file system I/O.
222  *
223  * Trivial on the HP since buffer has already been mapping into KVA space.
224  *
225  * Read and Write are handled with a simple copyin and copyout.    
226  *
227  * We also partially support VOP_FREEBLKS() via B_FREEBUF.  We can't implement
228  * completely -- for example, on fragments or inode metadata, but we can
229  * implement it for page-aligned requests.
230  */
231 void
232 mfs_doio(struct buf *bp, struct mfsnode *mfsp)
233 {
234         caddr_t base = mfsp->mfs_baseoff + (bp->b_blkno << DEV_BSHIFT);
235
236         if (bp->b_flags & B_FREEBUF) {
237                 /*
238                  * Implement B_FREEBUF, which allows the filesystem to tell
239                  * a block device when blocks are no longer needed (like when
240                  * a file is deleted).  We use the hook to MADV_FREE the VM.
241                  * This makes an MFS filesystem work as well or better then
242                  * a sun-style swap-mounted filesystem.
243                  */
244                 int bytes = bp->b_bcount;
245
246                 if ((vm_offset_t)base & PAGE_MASK) {
247                         int n = PAGE_SIZE - ((vm_offset_t)base & PAGE_MASK);
248                         bytes -= n;
249                         base += n;
250                 }
251                 if (bytes > 0) {
252                         struct madvise_args uap;
253
254                         bytes &= ~PAGE_MASK;
255                         if (bytes != 0) {
256                                 bzero(&uap, sizeof(uap));
257                                 uap.addr  = base;
258                                 uap.len   = bytes;
259                                 uap.behav = MADV_FREE;
260                                 madvise(&uap);
261                         }
262                 }
263                 bp->b_error = 0;
264         } else if (bp->b_flags & B_READ) {
265                 /*
266                  * Read data from our 'memory' disk
267                  */
268                 bp->b_error = copyin(base, bp->b_data, bp->b_bcount);
269         } else {
270                 /*
271                  * Write data to our 'memory' disk
272                  */
273                 bp->b_error = copyout(bp->b_data, base, bp->b_bcount);
274         }
275         if (bp->b_error)
276                 bp->b_flags |= B_ERROR;
277         biodone(bp);
278 }
279
280 /*
281  * This is a noop, simply returning what one has been given.
282  *
283  * mfs_bmap(struct vnode *a_vp, ufs_daddr_t a_bn, struct vnode **a_vpp,
284  *          ufs_daddr_t *a_bnp, int *a_runp)
285  */
286 static int
287 mfs_bmap(struct vop_bmap_args *ap)
288 {
289         if (ap->a_vpp != NULL)
290                 *ap->a_vpp = ap->a_vp;
291         if (ap->a_bnp != NULL)
292                 *ap->a_bnp = ap->a_bn;
293         if (ap->a_runp != NULL)
294                 *ap->a_runp = 0;
295         return (0);
296 }
297
298 /*
299  * Memory filesystem close routine
300  *
301  * mfs_close(struct vnode *a_vp, int a_fflag, struct ucred *a_cred,
302  *           struct thread *a_td)
303  */
304 /* ARGSUSED */
305 static int
306 mfs_close(struct vop_close_args *ap)
307 {
308         struct vnode *vp = ap->a_vp;
309         struct mfsnode *mfsp = VTOMFS(vp);
310         struct buf *bp;
311         int error;
312
313         /*
314          * Finish any pending I/O requests.
315          */
316         while ((bp = bufq_first(&mfsp->buf_queue)) != NULL) {
317                 bufq_remove(&mfsp->buf_queue, bp);
318                 mfs_doio(bp, mfsp);
319                 wakeup((caddr_t)bp);
320         }
321         /*
322          * On last close of a memory filesystem
323          * we must invalidate any in core blocks, so that
324          * we can, free up its vnode.
325          */
326         if ((error = vinvalbuf(vp, 1, ap->a_td, 0, 0)) != 0)
327                 return (error);
328         /*
329          * There should be no way to have any more uses of this
330          * vnode, so if we find any other uses, it is a panic.
331          */
332         if (vp->v_usecount > 1)
333                 printf("mfs_close: ref count %d > 1\n", vp->v_usecount);
334         if (vp->v_usecount > 1 || (bufq_first(&mfsp->buf_queue) != NULL))
335                 panic("mfs_close");
336         /*
337          * Send a request to the filesystem server to exit.
338          */
339         mfsp->mfs_active = 0;
340         v_release_rdev(vp);
341         if (mfsp->mfs_dev) {
342                 destroy_dev(mfsp->mfs_dev);
343                 mfsp->mfs_dev = NULL;
344         }
345         wakeup((caddr_t)mfsp);
346         return (0);
347 }
348
349 /*
350  * Memory filesystem inactive routine
351  *
352  * mfs_inactive(struct vnode *a_vp, struct thread *a_td)
353  */
354 /* ARGSUSED */
355 static int
356 mfs_inactive(struct vop_inactive_args *ap)
357 {
358         struct vnode *vp = ap->a_vp;
359         struct mfsnode *mfsp = VTOMFS(vp);
360
361         if (bufq_first(&mfsp->buf_queue) != NULL)
362                 panic("mfs_inactive: not inactive (next buffer %p)",
363                         bufq_first(&mfsp->buf_queue));
364         VOP_UNLOCK(vp, NULL, 0, ap->a_td);
365         return (0);
366 }
367
368 /*
369  * Reclaim a memory filesystem devvp so that it can be reused.
370  *
371  * mfs_reclaim(struct vnode *a_vp)
372  */
373 static int
374 mfs_reclaim(struct vop_reclaim_args *ap)
375 {
376         struct vnode *vp = ap->a_vp;
377
378         FREE(vp->v_data, M_MFSNODE);
379         vp->v_data = NULL;
380         return (0);
381 }
382
383 /*
384  * Print out the contents of an mfsnode.
385  *
386  * mfs_print(struct vnode *a_vp)
387  */
388 static int
389 mfs_print(struct vop_print_args *ap)
390 {
391         struct mfsnode *mfsp = VTOMFS(ap->a_vp);
392
393         printf("tag VT_MFS, td %p, base %p, size %ld\n",
394             mfsp->mfs_td, (void *)mfsp->mfs_baseoff, mfsp->mfs_size);
395         return (0);
396 }
397
398 /*
399  * Block device bad operation
400  */
401 static int
402 mfs_badop(struct vop_generic_args *ap)
403 {
404         int i;
405
406         printf("mfs_badop[%s]\n", ap->a_desc->vdesc_name);
407         i = vop_defaultop(ap);
408         printf("mfs_badop[%s] = %d\n", ap->a_desc->vdesc_name,i);
409         return (i);
410 }
411
412 static int
413 mfs_getpages(struct vop_getpages_args *ap)
414 {
415         return (VOCALL(spec_vnodeop_p, VOFFSET(vop_getpages), ap));
416 }