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