7f1a757ff3932e66b2c8fd39347b9464b0c4eb6b
[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.23 2006/04/01 20:46:53 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 <sys/thread2.h>
52
53 #include "mfsnode.h"
54 #include "mfs_extern.h"
55
56 static int      mfs_badop (struct vop_generic_args *);
57 static int      mfs_bmap (struct vop_bmap_args *);
58 static int      mfs_close (struct vop_close_args *);
59 static int      mfs_fsync (struct vop_fsync_args *);
60 static int      mfs_freeblks (struct vop_freeblks_args *);
61 static int      mfs_inactive (struct vop_inactive_args *); /* XXX */
62 static int      mfs_open (struct vop_open_args *);
63 static int      mfs_reclaim (struct vop_reclaim_args *); /* XXX */
64 static int      mfs_print (struct vop_print_args *); /* XXX */
65 static int      mfs_strategy (struct vop_strategy_args *); /* XXX */
66 static int      mfs_getpages (struct vop_getpages_args *); /* XXX */
67 /*
68  * mfs vnode operations.  Note: the vops here are used for the MFS block
69  * device, not for operations on files (MFS calls the ffs mount code for that)
70  */
71 struct vop_ops *mfs_vnode_vops;
72 static struct vnodeopv_entry_desc mfs_vnodeop_entries[] = {
73         { &vop_default_desc,            (vnodeopv_entry_t) mfs_badop },
74         { &vop_bmap_desc,               (vnodeopv_entry_t) mfs_bmap },
75         { &vop_bwrite_desc,             vop_defaultop },
76         { &vop_close_desc,              (vnodeopv_entry_t) mfs_close },
77         { &vop_freeblks_desc,           (vnodeopv_entry_t) mfs_freeblks },
78         { &vop_fsync_desc,              (vnodeopv_entry_t) mfs_fsync },
79         { &vop_getpages_desc,           (vnodeopv_entry_t) mfs_getpages },
80         { &vop_inactive_desc,           (vnodeopv_entry_t) mfs_inactive },
81         { &vop_ioctl_desc,              vop_enotty },
82         { &vop_islocked_desc,           vop_defaultop },
83         { &vop_lock_desc,               vop_defaultop },
84         { &vop_open_desc,               (vnodeopv_entry_t) mfs_open },
85         { &vop_print_desc,              (vnodeopv_entry_t) mfs_print },
86         { &vop_reclaim_desc,            (vnodeopv_entry_t) mfs_reclaim },
87         { &vop_strategy_desc,           (vnodeopv_entry_t) mfs_strategy },
88         { &vop_unlock_desc,             vop_defaultop },
89         { NULL, NULL }
90 };
91 static struct vnodeopv_desc mfs_vnodeop_opv_desc =
92         { &mfs_vnode_vops, mfs_vnodeop_entries, 0 };
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 (vop_stdopen(ap));
120 }
121
122 static int
123 mfs_fsync(struct vop_fsync_args *ap)
124 {
125         return (VOCALL(spec_vnode_vops, &ap->a_head));
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_bio1.bio_offset = ap->a_offset;
149         bp->b_bcount = ap->a_length;
150         BUF_KERNPROC(bp);
151         vn_strategy(vp, &bp->b_bio1);
152         return(0);
153 }
154
155 /*
156  * Pass I/O requests to the memory filesystem process.
157  *
158  * mfs_strategy(struct vnode *a_vp, struct bio *a_bio)
159  */
160 static int
161 mfs_strategy(struct vop_strategy_args *ap)
162 {
163         struct bio *bio = ap->a_bio;
164         struct buf *bp = bio->bio_buf;
165         struct mfsnode *mfsp;
166         struct thread *td = curthread;          /* XXX */
167
168         mfsp = ap->a_vp->v_rdev->si_drv1;
169         if (mfsp == NULL) {
170                 bp->b_error = ENXIO;
171                 bp->b_flags |= B_ERROR;
172                 biodone(bio);
173                 return(0);
174         }
175
176         /*
177          * splbio required for queueing/dequeueing, in case of forwarded
178          * BPs from bio interrupts (?).  It may not be necessary.
179          */
180
181         crit_enter();
182
183         if (mfsp->mfs_td == NULL) {
184                 /*
185                  * mini-root.  Note: B_FREEBUF not supported at the moment,
186                  * I'm not sure what kind of dataspace b_data is in.
187                  */
188                 caddr_t base;
189
190                 base = mfsp->mfs_baseoff + bio->bio_offset;
191                 if (bp->b_flags & B_FREEBUF)
192                         ;
193                 else if (bp->b_flags & B_READ)
194                         bcopy(base, bp->b_data, bp->b_bcount);
195                 else
196                         bcopy(bp->b_data, base, bp->b_bcount);
197                 biodone(bio);
198         } else if (mfsp->mfs_td == td) {
199                 /*
200                  * VOP to self
201                  */
202                 crit_exit();
203                 mfs_doio(bio, mfsp);
204                 crit_enter();
205         } else {
206                 /*
207                  * VOP from some other process, queue to MFS process and
208                  * wake it up.
209                  */
210                 bioq_insert_tail(&mfsp->bio_queue, bio);
211                 wakeup((caddr_t)mfsp);
212         }
213         crit_exit();
214         return (0);
215 }
216
217 /*
218  * Memory file system I/O.
219  *
220  * Trivial on the HP since buffer has already been mapping into KVA space.
221  *
222  * Read and Write are handled with a simple copyin and copyout.    
223  *
224  * We also partially support VOP_FREEBLKS() via B_FREEBUF.  We can't implement
225  * completely -- for example, on fragments or inode metadata, but we can
226  * implement it for page-aligned requests.
227  */
228 void
229 mfs_doio(struct bio *bio, struct mfsnode *mfsp)
230 {
231         struct buf *bp = bio->bio_buf;
232         caddr_t base = mfsp->mfs_baseoff + bio->bio_offset;
233
234         if (bp->b_flags & B_FREEBUF) {
235                 /*
236                  * Implement B_FREEBUF, which allows the filesystem to tell
237                  * a block device when blocks are no longer needed (like when
238                  * a file is deleted).  We use the hook to MADV_FREE the VM.
239                  * This makes an MFS filesystem work as well or better then
240                  * a sun-style swap-mounted filesystem.
241                  */
242                 int bytes = bp->b_bcount;
243
244                 if ((vm_offset_t)base & PAGE_MASK) {
245                         int n = PAGE_SIZE - ((vm_offset_t)base & PAGE_MASK);
246                         bytes -= n;
247                         base += n;
248                 }
249                 if (bytes > 0) {
250                         struct madvise_args uap;
251
252                         bytes &= ~PAGE_MASK;
253                         if (bytes != 0) {
254                                 bzero(&uap, sizeof(uap));
255                                 uap.addr  = base;
256                                 uap.len   = bytes;
257                                 uap.behav = MADV_FREE;
258                                 madvise(&uap);
259                         }
260                 }
261                 bp->b_error = 0;
262         } else if (bp->b_flags & B_READ) {
263                 /*
264                  * Read data from our 'memory' disk
265                  */
266                 bp->b_error = copyin(base, bp->b_data, bp->b_bcount);
267         } else {
268                 /*
269                  * Write data to our 'memory' disk
270                  */
271                 bp->b_error = copyout(bp->b_data, base, bp->b_bcount);
272         }
273         if (bp->b_error)
274                 bp->b_flags |= B_ERROR;
275         biodone(bio);
276 }
277
278 /*
279  * This is a noop, simply returning what one has been given.
280  *
281  * mfs_bmap(struct vnode *a_vp, off_t a_loffset, struct vnode **a_vpp,
282  *          off_t *a_doffsetp, int *a_runp, int *a_runb)
283  */
284 static int
285 mfs_bmap(struct vop_bmap_args *ap)
286 {
287         if (ap->a_vpp != NULL)
288                 *ap->a_vpp = ap->a_vp;
289         if (ap->a_doffsetp != NULL)
290                 *ap->a_doffsetp = ap->a_loffset;
291         if (ap->a_runp != NULL)
292                 *ap->a_runp = 0;
293         if (ap->a_runb != NULL)
294                 *ap->a_runb = 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 bio *bio;
311         int error;
312
313         /*
314          * Finish any pending I/O requests.
315          */
316         while ((bio = bioq_first(&mfsp->bio_queue)) != NULL) {
317                 bioq_remove(&mfsp->bio_queue, bio);
318                 mfs_doio(bio, mfsp);
319                 wakeup((caddr_t)bio->bio_buf);
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                 goto done;
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 || (bioq_first(&mfsp->bio_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 done:
347         vop_stdclose(ap);
348         return (error);
349 }
350
351 /*
352  * Memory filesystem inactive routine
353  *
354  * mfs_inactive(struct vnode *a_vp, struct thread *a_td)
355  */
356 /* ARGSUSED */
357 static int
358 mfs_inactive(struct vop_inactive_args *ap)
359 {
360         struct vnode *vp = ap->a_vp;
361         struct mfsnode *mfsp = VTOMFS(vp);
362
363         if (bioq_first(&mfsp->bio_queue) != NULL)
364                 panic("mfs_inactive: not inactive (next buffer %p)",
365                         bioq_first(&mfsp->bio_queue));
366         return (0);
367 }
368
369 /*
370  * Reclaim a memory filesystem devvp so that it can be reused.
371  *
372  * mfs_reclaim(struct vnode *a_vp)
373  */
374 static int
375 mfs_reclaim(struct vop_reclaim_args *ap)
376 {
377         struct vnode *vp = ap->a_vp;
378
379         FREE(vp->v_data, M_MFSNODE);
380         vp->v_data = NULL;
381         return (0);
382 }
383
384 /*
385  * Print out the contents of an mfsnode.
386  *
387  * mfs_print(struct vnode *a_vp)
388  */
389 static int
390 mfs_print(struct vop_print_args *ap)
391 {
392         struct mfsnode *mfsp = VTOMFS(ap->a_vp);
393
394         printf("tag VT_MFS, td %p, base %p, size %ld\n",
395             mfsp->mfs_td, (void *)mfsp->mfs_baseoff, mfsp->mfs_size);
396         return (0);
397 }
398
399 /*
400  * Block device bad operation
401  */
402 static int
403 mfs_badop(struct vop_generic_args *ap)
404 {
405         int i;
406
407         printf("mfs_badop[%s]\n", ap->a_desc->vdesc_name);
408         i = vop_defaultop(ap);
409         printf("mfs_badop[%s] = %d\n", ap->a_desc->vdesc_name, i);
410         return (i);
411 }
412
413 static int
414 mfs_getpages(struct vop_getpages_args *ap)
415 {
416         return (VOCALL(spec_vnode_vops, &ap->a_head));
417 }