Give the MFS pseudo block device vnode a VM object, as is now required
[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.24 2006/04/02 01:35:34 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 <vm/vm.h>
50 #include <vm/vm_object.h>
51 #include <vm/vm_page.h>
52 #include <vm/vm_pager.h>
53 #include <vm/vnode_pager.h>
54
55 #include <sys/buf2.h>
56 #include <sys/thread2.h>
57
58 #include "mfsnode.h"
59 #include "mfs_extern.h"
60
61 static int      mfs_badop (struct vop_generic_args *);
62 static int      mfs_bmap (struct vop_bmap_args *);
63 static int      mfs_close (struct vop_close_args *);
64 static int      mfs_fsync (struct vop_fsync_args *);
65 static int      mfs_freeblks (struct vop_freeblks_args *);
66 static int      mfs_inactive (struct vop_inactive_args *); /* XXX */
67 static int      mfs_open (struct vop_open_args *);
68 static int      mfs_reclaim (struct vop_reclaim_args *); /* XXX */
69 static int      mfs_print (struct vop_print_args *); /* XXX */
70 static int      mfs_strategy (struct vop_strategy_args *); /* XXX */
71 static int      mfs_getpages (struct vop_getpages_args *); /* XXX */
72 /*
73  * mfs vnode operations.  Note: the vops here are used for the MFS block
74  * device, not for operations on files (MFS calls the ffs mount code for that)
75  */
76 struct vop_ops *mfs_vnode_vops;
77 static struct vnodeopv_entry_desc mfs_vnodeop_entries[] = {
78         { &vop_default_desc,            (vnodeopv_entry_t) mfs_badop },
79         { &vop_bmap_desc,               (vnodeopv_entry_t) mfs_bmap },
80         { &vop_bwrite_desc,             vop_defaultop },
81         { &vop_close_desc,              (vnodeopv_entry_t) mfs_close },
82         { &vop_freeblks_desc,           (vnodeopv_entry_t) mfs_freeblks },
83         { &vop_fsync_desc,              (vnodeopv_entry_t) mfs_fsync },
84         { &vop_getpages_desc,           (vnodeopv_entry_t) mfs_getpages },
85         { &vop_inactive_desc,           (vnodeopv_entry_t) mfs_inactive },
86         { &vop_ioctl_desc,              vop_enotty },
87         { &vop_islocked_desc,           vop_defaultop },
88         { &vop_lock_desc,               vop_defaultop },
89         { &vop_open_desc,               (vnodeopv_entry_t) mfs_open },
90         { &vop_print_desc,              (vnodeopv_entry_t) mfs_print },
91         { &vop_reclaim_desc,            (vnodeopv_entry_t) mfs_reclaim },
92         { &vop_strategy_desc,           (vnodeopv_entry_t) mfs_strategy },
93         { &vop_unlock_desc,             vop_defaultop },
94         { NULL, NULL }
95 };
96 static struct vnodeopv_desc mfs_vnodeop_opv_desc =
97         { &mfs_vnode_vops, mfs_vnodeop_entries, 0 };
98
99 VNODEOP_SET(mfs_vnodeop_opv_desc);
100
101 /*
102  * Vnode Operations.
103  *
104  * Open called to allow memory filesystem to initialize and
105  * validate before actual IO. Record our process identifier
106  * so we can tell when we are doing I/O to ourself.
107  *
108  * NOTE: new device sequencing.  mounts check the device reference count
109  * before calling open, so we must associate the device in open and 
110  * disassociate it in close rather then faking it when we created the vnode.
111  *
112  * mfs_open(struct vnode *a_vp, int a_mode, struct ucred *a_cred,
113  *          struct thread *a_td)
114  */
115 /* ARGSUSED */
116 static int
117 mfs_open(struct vop_open_args *ap)
118 {
119         struct vnode *vp = ap->a_vp;
120
121         if (vp->v_type != VCHR)
122                 panic("mfs_open not VCHR");
123         v_associate_rdev(vp, udev2dev(vp->v_udev, 0));
124         return (vop_stdopen(ap));
125 }
126
127 static int
128 mfs_fsync(struct vop_fsync_args *ap)
129 {
130         return (VOCALL(spec_vnode_vops, &ap->a_head));
131 }
132
133 /*
134  * mfs_freeblks() - hook to allow us to free physical memory.
135  *
136  *      We implement the B_FREEBUF strategy.  We can't just madvise()
137  *      here because we have to do it in the correct order vs other bio
138  *      requests, so we queue it.
139  *
140  *      Note: geteblk() sets B_INVAL.  We leave it set to guarentee buffer
141  *      throw-away on brelse()? XXX
142  *
143  * mfs_freeblks(struct vnode *a_vp, daddr_t a_addr, daddr_t a_length)
144  */
145 static int
146 mfs_freeblks(struct vop_freeblks_args *ap)
147 {       
148         struct buf *bp;
149         struct vnode *vp = ap->a_vp;
150
151         bp = geteblk(ap->a_length);
152         bp->b_flags |= B_FREEBUF | B_ASYNC;
153         bp->b_bio1.bio_offset = ap->a_offset;
154         bp->b_bcount = ap->a_length;
155         BUF_KERNPROC(bp);
156         vn_strategy(vp, &bp->b_bio1);
157         return(0);
158 }
159
160 /*
161  * Pass I/O requests to the memory filesystem process.
162  *
163  * mfs_strategy(struct vnode *a_vp, struct bio *a_bio)
164  */
165 static int
166 mfs_strategy(struct vop_strategy_args *ap)
167 {
168         struct bio *bio = ap->a_bio;
169         struct buf *bp = bio->bio_buf;
170         struct mfsnode *mfsp;
171         struct thread *td = curthread;          /* XXX */
172
173         mfsp = ap->a_vp->v_rdev->si_drv1;
174         if (mfsp == NULL) {
175                 bp->b_error = ENXIO;
176                 bp->b_flags |= B_ERROR;
177                 biodone(bio);
178                 return(0);
179         }
180
181         /*
182          * splbio required for queueing/dequeueing, in case of forwarded
183          * BPs from bio interrupts (?).  It may not be necessary.
184          */
185
186         crit_enter();
187
188         if (mfsp->mfs_td == NULL) {
189                 /*
190                  * mini-root.  Note: B_FREEBUF not supported at the moment,
191                  * I'm not sure what kind of dataspace b_data is in.
192                  */
193                 caddr_t base;
194
195                 base = mfsp->mfs_baseoff + bio->bio_offset;
196                 if (bp->b_flags & B_FREEBUF)
197                         ;
198                 else if (bp->b_flags & B_READ)
199                         bcopy(base, bp->b_data, bp->b_bcount);
200                 else
201                         bcopy(bp->b_data, base, bp->b_bcount);
202                 biodone(bio);
203         } else if (mfsp->mfs_td == td) {
204                 /*
205                  * VOP to self
206                  */
207                 crit_exit();
208                 mfs_doio(bio, mfsp);
209                 crit_enter();
210         } else {
211                 /*
212                  * VOP from some other process, queue to MFS process and
213                  * wake it up.
214                  */
215                 bioq_insert_tail(&mfsp->bio_queue, bio);
216                 wakeup((caddr_t)mfsp);
217         }
218         crit_exit();
219         return (0);
220 }
221
222 /*
223  * Memory file system I/O.
224  *
225  * Trivial on the HP since buffer has already been mapping into KVA space.
226  *
227  * Read and Write are handled with a simple copyin and copyout.    
228  *
229  * We also partially support VOP_FREEBLKS() via B_FREEBUF.  We can't implement
230  * completely -- for example, on fragments or inode metadata, but we can
231  * implement it for page-aligned requests.
232  */
233 void
234 mfs_doio(struct bio *bio, struct mfsnode *mfsp)
235 {
236         struct buf *bp = bio->bio_buf;
237         caddr_t base = mfsp->mfs_baseoff + bio->bio_offset;
238
239         if (bp->b_flags & B_FREEBUF) {
240                 /*
241                  * Implement B_FREEBUF, which allows the filesystem to tell
242                  * a block device when blocks are no longer needed (like when
243                  * a file is deleted).  We use the hook to MADV_FREE the VM.
244                  * This makes an MFS filesystem work as well or better then
245                  * a sun-style swap-mounted filesystem.
246                  */
247                 int bytes = bp->b_bcount;
248
249                 if ((vm_offset_t)base & PAGE_MASK) {
250                         int n = PAGE_SIZE - ((vm_offset_t)base & PAGE_MASK);
251                         bytes -= n;
252                         base += n;
253                 }
254                 if (bytes > 0) {
255                         struct madvise_args uap;
256
257                         bytes &= ~PAGE_MASK;
258                         if (bytes != 0) {
259                                 bzero(&uap, sizeof(uap));
260                                 uap.addr  = base;
261                                 uap.len   = bytes;
262                                 uap.behav = MADV_FREE;
263                                 madvise(&uap);
264                         }
265                 }
266                 bp->b_error = 0;
267         } else if (bp->b_flags & B_READ) {
268                 /*
269                  * Read data from our 'memory' disk
270                  */
271                 bp->b_error = copyin(base, bp->b_data, bp->b_bcount);
272         } else {
273                 /*
274                  * Write data to our 'memory' disk
275                  */
276                 bp->b_error = copyout(bp->b_data, base, bp->b_bcount);
277         }
278         if (bp->b_error)
279                 bp->b_flags |= B_ERROR;
280         biodone(bio);
281 }
282
283 /*
284  * This is a noop, simply returning what one has been given.
285  *
286  * mfs_bmap(struct vnode *a_vp, off_t a_loffset, struct vnode **a_vpp,
287  *          off_t *a_doffsetp, int *a_runp, int *a_runb)
288  */
289 static int
290 mfs_bmap(struct vop_bmap_args *ap)
291 {
292         if (ap->a_vpp != NULL)
293                 *ap->a_vpp = ap->a_vp;
294         if (ap->a_doffsetp != NULL)
295                 *ap->a_doffsetp = ap->a_loffset;
296         if (ap->a_runp != NULL)
297                 *ap->a_runp = 0;
298         if (ap->a_runb != NULL)
299                 *ap->a_runb = 0;
300         return (0);
301 }
302
303 /*
304  * Memory filesystem close routine
305  *
306  * mfs_close(struct vnode *a_vp, int a_fflag, struct ucred *a_cred,
307  *           struct thread *a_td)
308  */
309 /* ARGSUSED */
310 static int
311 mfs_close(struct vop_close_args *ap)
312 {
313         struct vnode *vp = ap->a_vp;
314         struct mfsnode *mfsp = VTOMFS(vp);
315         struct bio *bio;
316         int error = 0;
317
318         /*
319          * Finish any pending I/O requests.
320          */
321         while ((bio = bioq_first(&mfsp->bio_queue)) != NULL) {
322                 bioq_remove(&mfsp->bio_queue, bio);
323                 mfs_doio(bio, mfsp);
324                 wakeup((caddr_t)bio->bio_buf);
325         }
326
327         /*
328          * We really only care about the last close
329          */
330         if (vp->v_opencount > 1)
331                 goto done;
332
333         /*
334          * Synchronize any remaining buffers and then destroy them.
335          */
336         if ((error = vinvalbuf(vp, V_SAVE, ap->a_td, 0, 0)) != 0)
337                 goto done;
338
339         /*
340          * Get rid of the pseudo-backing object.  Since the object is
341          * not directly memory mapped, we don't have to worry about 
342          * synchronizing it.
343          */
344         if (vp->v_object)
345                 vm_pager_deallocate(vp->v_object);
346
347         /*
348          * There should be no way to have any more uses of this
349          * vnode, so if we find any other uses, it is a panic.
350          */
351         if (vp->v_usecount > 1)
352                 printf("mfs_close: ref count %d > 1\n", vp->v_usecount);
353         if (vp->v_usecount > 1 || (bioq_first(&mfsp->bio_queue) != NULL))
354                 panic("mfs_close");
355         /*
356          * Send a request to the filesystem server to exit.
357          */
358         mfsp->mfs_active = 0;
359         v_release_rdev(vp);
360         if (mfsp->mfs_dev) {
361                 destroy_dev(mfsp->mfs_dev);
362                 mfsp->mfs_dev = NULL;
363         }
364         wakeup((caddr_t)mfsp);
365 done:
366         vop_stdclose(ap);
367         return (error);
368 }
369
370 /*
371  * Memory filesystem inactive routine
372  *
373  * mfs_inactive(struct vnode *a_vp, struct thread *a_td)
374  */
375 /* ARGSUSED */
376 static int
377 mfs_inactive(struct vop_inactive_args *ap)
378 {
379         struct vnode *vp = ap->a_vp;
380         struct mfsnode *mfsp = VTOMFS(vp);
381
382         if (bioq_first(&mfsp->bio_queue) != NULL)
383                 panic("mfs_inactive: not inactive (next buffer %p)",
384                         bioq_first(&mfsp->bio_queue));
385         return (0);
386 }
387
388 /*
389  * Reclaim a memory filesystem devvp so that it can be reused.
390  *
391  * mfs_reclaim(struct vnode *a_vp)
392  */
393 static int
394 mfs_reclaim(struct vop_reclaim_args *ap)
395 {
396         struct vnode *vp = ap->a_vp;
397
398         FREE(vp->v_data, M_MFSNODE);
399         vp->v_data = NULL;
400         return (0);
401 }
402
403 /*
404  * Print out the contents of an mfsnode.
405  *
406  * mfs_print(struct vnode *a_vp)
407  */
408 static int
409 mfs_print(struct vop_print_args *ap)
410 {
411         struct mfsnode *mfsp = VTOMFS(ap->a_vp);
412
413         printf("tag VT_MFS, td %p, base %p, size %ld\n",
414             mfsp->mfs_td, (void *)mfsp->mfs_baseoff, mfsp->mfs_size);
415         return (0);
416 }
417
418 /*
419  * Block device bad operation
420  */
421 static int
422 mfs_badop(struct vop_generic_args *ap)
423 {
424         int i;
425
426         printf("mfs_badop[%s]\n", ap->a_desc->vdesc_name);
427         i = vop_defaultop(ap);
428         printf("mfs_badop[%s] = %d\n", ap->a_desc->vdesc_name, i);
429         return (i);
430 }
431
432 static int
433 mfs_getpages(struct vop_getpages_args *ap)
434 {
435         return (VOCALL(spec_vnode_vops, &ap->a_head));
436 }