Add an argument to vfs_add_vnodeops() to specify VVF_* flags for the vop_ops
[dragonfly.git] / sys / vfs / union / union_vfsops.c
1 /*
2  * Copyright (c) 1994, 1995 The Regents of the University of California.
3  * Copyright (c) 1994, 1995 Jan-Simon Pendry.
4  * All rights reserved.
5  *
6  * This code is derived from software donated to Berkeley by
7  * Jan-Simon Pendry.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *      This product includes software developed by the University of
20  *      California, Berkeley and its contributors.
21  * 4. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *      @(#)union_vfsops.c      8.20 (Berkeley) 5/20/95
38  * $FreeBSD: src/sys/miscfs/union/union_vfsops.c,v 1.39.2.2 2001/10/25 19:18:53 dillon Exp $
39  * $DragonFly: src/sys/vfs/union/union_vfsops.c,v 1.21 2005/09/17 07:43:12 dillon Exp $
40  */
41
42 /*
43  * Union Layer
44  */
45
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/kernel.h>
49 #include <sys/proc.h>
50 #include <sys/vnode.h>
51 #include <sys/mount.h>
52 #include <sys/nlookup.h>
53 #include <sys/namei.h>
54 #include <sys/malloc.h>
55 #include <sys/filedesc.h>
56 #include "union.h"
57 #include <vm/vm_zone.h>
58
59 extern struct vnodeopv_entry_desc union_vnodeop_entries[];
60
61 static MALLOC_DEFINE(M_UNIONFSMNT, "UNION mount", "UNION mount structure");
62
63 extern int      union_init (struct vfsconf *);
64 static int      union_mount (struct mount *mp, char *path, caddr_t data,
65                                  struct thread *td);
66 static int      union_root (struct mount *mp, struct vnode **vpp);
67 static int      union_statfs (struct mount *mp, struct statfs *sbp,
68                                   struct thread *td);
69 static int      union_unmount (struct mount *mp, int mntflags,
70                                    struct thread *td);
71
72 /*
73  * Mount union filesystem
74  */
75 static int
76 union_mount(struct mount *mp, char *path, caddr_t data, struct thread *td)
77 {
78         int error = 0;
79         struct union_args args;
80         struct vnode *lowerrootvp = NULLVP;
81         struct vnode *upperrootvp = NULLVP;
82         struct union_mount *um = 0;
83         struct ucred *cred = 0;
84         struct nlookupdata nd;
85         char *cp = 0;
86         int len;
87         u_int size;
88
89         UDEBUG(("union_mount(mp = %p)\n", (void *)mp));
90
91         KKASSERT(td->td_proc);
92
93         /*
94          * Disable clustered write, otherwise system becomes unstable.
95          */
96         mp->mnt_flag |= MNT_NOCLUSTERW;
97
98         /*
99          * Update is a no-op
100          */
101         if (mp->mnt_flag & MNT_UPDATE) {
102                 /*
103                  * Need to provide.
104                  * 1. a way to convert between rdonly and rdwr mounts.
105                  * 2. support for nfs exports.
106                  */
107                 error = EOPNOTSUPP;
108                 goto bad;
109         }
110
111         /*
112          * Get argument
113          */
114         error = copyin(data, (caddr_t)&args, sizeof(struct union_args));
115         if (error)
116                 goto bad;
117
118         /*
119          * Obtain lower vnode.  Vnode is stored in mp->mnt_vnodecovered.
120          * We need to reference it but not lock it.
121          */
122
123         lowerrootvp = mp->mnt_vnodecovered;
124         vref(lowerrootvp);
125
126 #if 0
127         /*
128          * Unlock lower node to avoid deadlock.
129          */
130         if (lowerrootvp->v_tag == VT_UNION)
131                 VOP_UNLOCK(lowerrootvp, 0, td);
132 #endif
133
134         /*
135          * Obtain upper vnode by calling nlookup() on the path.  The
136          * upperrootvp will be turned referenced but not locked.
137          */
138         error = nlookup_init(&nd, args.target, UIO_USERSPACE, NLC_FOLLOW);
139         if (error == 0)
140                 error = nlookup(&nd);
141         if (error == 0)
142                 error = cache_vref(nd.nl_ncp, nd.nl_cred, &upperrootvp);
143         nlookup_done(&nd);
144         if (error)
145                 goto bad;
146
147         UDEBUG(("mount_root UPPERVP %p locked = %d\n", upperrootvp,
148             VOP_ISLOCKED(upperrootvp, NULL)));
149
150         /*
151          * Check multi union mount to avoid `lock myself again' panic.
152          * Also require that it be a directory.
153          */
154         if (upperrootvp == VTOUNION(lowerrootvp)->un_uppervp) {
155 #ifdef DIAGNOSTIC
156                 printf("union_mount: multi union mount?\n");
157 #endif
158                 error = EDEADLK;
159                 goto bad;
160         }
161
162         if (upperrootvp->v_type != VDIR) {
163                 error = EINVAL;
164                 goto bad;
165         }
166
167         /*
168          * Allocate our union_mount structure and populate the fields.
169          * The vnode references are stored in the union_mount as held,
170          * unlocked references.  Depending on the _BELOW flag, the
171          * filesystems are viewed in a different order.  In effect this
172          * is the same as providing a mount-under option to the mount
173          * syscall.
174          */
175
176         um = (struct union_mount *) malloc(sizeof(struct union_mount),
177                                 M_UNIONFSMNT, M_WAITOK);
178
179         bzero(um, sizeof(struct union_mount));
180
181         um->um_op = args.mntflags & UNMNT_OPMASK;
182
183         switch (um->um_op) {
184         case UNMNT_ABOVE:
185                 um->um_lowervp = lowerrootvp;
186                 um->um_uppervp = upperrootvp;
187                 upperrootvp = NULL;
188                 lowerrootvp = NULL;
189                 break;
190
191         case UNMNT_BELOW:
192                 um->um_lowervp = upperrootvp;
193                 um->um_uppervp = lowerrootvp;
194                 upperrootvp = NULL;
195                 lowerrootvp = NULL;
196                 break;
197
198         case UNMNT_REPLACE:
199                 vrele(lowerrootvp);
200                 lowerrootvp = NULL;
201                 um->um_uppervp = upperrootvp;
202                 um->um_lowervp = lowerrootvp;
203                 upperrootvp = NULL;
204                 break;
205
206         default:
207                 error = EINVAL;
208                 goto bad;
209         }
210
211         /*
212          * Unless the mount is readonly, ensure that the top layer
213          * supports whiteout operations
214          */
215         if ((mp->mnt_flag & MNT_RDONLY) == 0) {
216                 error = VOP_WHITEOUT(um->um_uppervp, NULL, NAMEI_LOOKUP);
217                 if (error)
218                         goto bad;
219         }
220
221         um->um_cred = crhold(td->td_proc->p_ucred);
222         um->um_cmode = UN_DIRMODE & ~td->td_proc->p_fd->fd_cmask;
223
224         /*
225          * Depending on what you think the MNT_LOCAL flag might mean,
226          * you may want the && to be || on the conditional below.
227          * At the moment it has been defined that the filesystem is
228          * only local if it is all local, ie the MNT_LOCAL flag implies
229          * that the entire namespace is local.  If you think the MNT_LOCAL
230          * flag implies that some of the files might be stored locally
231          * then you will want to change the conditional.
232          */
233         if (um->um_op == UNMNT_ABOVE) {
234                 if (((um->um_lowervp == NULLVP) ||
235                      (um->um_lowervp->v_mount->mnt_flag & MNT_LOCAL)) &&
236                     (um->um_uppervp->v_mount->mnt_flag & MNT_LOCAL))
237                         mp->mnt_flag |= MNT_LOCAL;
238         }
239
240         /*
241          * Copy in the upper layer's RDONLY flag.  This is for the benefit
242          * of lookup() which explicitly checks the flag, rather than asking
243          * the filesystem for its own opinion.  This means, that an update
244          * mount of the underlying filesystem to go from rdonly to rdwr
245          * will leave the unioned view as read-only.
246          */
247         mp->mnt_flag |= (um->um_uppervp->v_mount->mnt_flag & MNT_RDONLY);
248
249         mp->mnt_data = (qaddr_t) um;
250         vfs_getnewfsid(mp);
251
252         switch (um->um_op) {
253         case UNMNT_ABOVE:
254                 cp = "<above>:";
255                 break;
256         case UNMNT_BELOW:
257                 cp = "<below>:";
258                 break;
259         case UNMNT_REPLACE:
260                 cp = "";
261                 break;
262         }
263         len = strlen(cp);
264         bcopy(cp, mp->mnt_stat.f_mntfromname, len);
265
266         cp = mp->mnt_stat.f_mntfromname + len;
267         len = MNAMELEN - len;
268
269         (void) copyinstr(args.target, cp, len - 1, &size);
270         bzero(cp + size, len - size);
271
272         vfs_add_vnodeops(mp, &mp->mnt_vn_norm_ops,
273                          union_vnodeop_entries, 0);
274
275         (void)union_statfs(mp, &mp->mnt_stat, td);
276
277         return (0);
278
279 bad:
280         if (um) {
281                 if (um->um_uppervp)
282                         vrele(um->um_uppervp);
283                 if (um->um_lowervp)
284                         vrele(um->um_lowervp);
285                 /* XXX other fields */
286                 free(um, M_UNIONFSMNT);
287         }
288         if (cred)
289                 crfree(cred);
290         if (upperrootvp)
291                 vrele(upperrootvp);
292         if (lowerrootvp)
293                 vrele(lowerrootvp);
294         return (error);
295 }
296
297 /*
298  * Free reference to union layer
299  */
300 static int
301 union_unmount(struct mount *mp, int mntflags, struct thread *td)
302 {
303         struct union_mount *um = MOUNTTOUNIONMOUNT(mp);
304         int error;
305         int freeing;
306         int flags = 0;
307
308         UDEBUG(("union_unmount(mp = %p)\n", (void *)mp));
309
310         if (mntflags & MNT_FORCE)
311                 flags |= FORCECLOSE;
312
313         /*
314          * Keep flushing vnodes from the mount list.
315          * This is needed because of the un_pvp held
316          * reference to the parent vnode.
317          * If more vnodes have been freed on a given pass,
318          * the try again.  The loop will iterate at most
319          * (d) times, where (d) is the maximum tree depth
320          * in the filesystem.
321          */
322         for (freeing = 0; (error = vflush(mp, 0, flags)) != 0;) {
323                 int n = mp->mnt_nvnodelistsize;
324
325                 /* if this is unchanged then stop */
326                 if (n == freeing)
327                         break;
328
329                 /* otherwise try once more time */
330                 freeing = n;
331         }
332
333         /* If the most recent vflush failed, the filesystem is still busy. */
334         if (error)
335                 return (error);
336
337         /*
338          * Discard references to upper and lower target vnodes.
339          */
340         if (um->um_lowervp)
341                 vrele(um->um_lowervp);
342         vrele(um->um_uppervp);
343         crfree(um->um_cred);
344         /*
345          * Finally, throw away the union_mount structure
346          */
347         free(mp->mnt_data, M_UNIONFSMNT);       /* XXX */
348         mp->mnt_data = 0;
349         return (0);
350 }
351
352 static int
353 union_root(struct mount *mp, struct vnode **vpp)
354 {
355         struct union_mount *um = MOUNTTOUNIONMOUNT(mp);
356         int error;
357
358         /*
359          * Supply an unlocked reference to um_uppervp and to um_lowervp.  It
360          * is possible for um_uppervp to be locked without the associated
361          * root union_node being locked.  We let union_allocvp() deal with
362          * it.
363          */
364         UDEBUG(("union_root UPPERVP %p locked = %d\n", um->um_uppervp,
365             VOP_ISLOCKED(um->um_uppervp, NULL)));
366
367         vref(um->um_uppervp);
368         if (um->um_lowervp)
369                 vref(um->um_lowervp);
370
371         error = union_allocvp(vpp, mp, NULLVP, NULLVP, NULL, 
372                     um->um_uppervp, um->um_lowervp, 1);
373         UDEBUG(("error %d\n", error));
374         UDEBUG(("union_root2 UPPERVP %p locked = %d\n", um->um_uppervp,
375             VOP_ISLOCKED(um->um_uppervp, NULL)));
376
377         return (error);
378 }
379
380 static int
381 union_statfs(struct mount *mp, struct statfs *sbp, struct thread *td)
382 {
383         int error;
384         struct union_mount *um = MOUNTTOUNIONMOUNT(mp);
385         struct statfs mstat;
386         int lbsize;
387
388         UDEBUG(("union_statfs(mp = %p, lvp = %p, uvp = %p)\n",
389             (void *)mp, (void *)um->um_lowervp, (void *)um->um_uppervp));
390
391         bzero(&mstat, sizeof(mstat));
392
393         if (um->um_lowervp) {
394                 error = VFS_STATFS(um->um_lowervp->v_mount, &mstat, td);
395                 if (error)
396                         return (error);
397         }
398
399         /* now copy across the "interesting" information and fake the rest */
400 #if 0
401         sbp->f_type = mstat.f_type;
402         sbp->f_flags = mstat.f_flags;
403         sbp->f_bsize = mstat.f_bsize;
404         sbp->f_iosize = mstat.f_iosize;
405 #endif
406         lbsize = mstat.f_bsize;
407         sbp->f_blocks = mstat.f_blocks;
408         sbp->f_bfree = mstat.f_bfree;
409         sbp->f_bavail = mstat.f_bavail;
410         sbp->f_files = mstat.f_files;
411         sbp->f_ffree = mstat.f_ffree;
412
413         error = VFS_STATFS(um->um_uppervp->v_mount, &mstat, td);
414         if (error)
415                 return (error);
416
417         sbp->f_flags = mstat.f_flags;
418         sbp->f_bsize = mstat.f_bsize;
419         sbp->f_iosize = mstat.f_iosize;
420
421         /*
422          * if the lower and upper blocksizes differ, then frig the
423          * block counts so that the sizes reported by df make some
424          * kind of sense.  none of this makes sense though.
425          */
426
427         if (mstat.f_bsize != lbsize)
428                 sbp->f_blocks = ((off_t) sbp->f_blocks * lbsize) / mstat.f_bsize;
429
430         /*
431          * The "total" fields count total resources in all layers,
432          * the "free" fields count only those resources which are
433          * free in the upper layer (since only the upper layer
434          * is writeable).
435          */
436         sbp->f_blocks += mstat.f_blocks;
437         sbp->f_bfree = mstat.f_bfree;
438         sbp->f_bavail = mstat.f_bavail;
439         sbp->f_files += mstat.f_files;
440         sbp->f_ffree = mstat.f_ffree;
441
442         if (sbp != &mp->mnt_stat) {
443                 sbp->f_type = mp->mnt_vfc->vfc_typenum;
444                 bcopy(&mp->mnt_stat.f_fsid, &sbp->f_fsid, sizeof(sbp->f_fsid));
445                 bcopy(mp->mnt_stat.f_mntfromname, sbp->f_mntfromname, MNAMELEN);
446         }
447         return (0);
448 }
449
450 static struct vfsops union_vfsops = {
451         .vfs_mount =            union_mount,
452         .vfs_unmount =          union_unmount,
453         .vfs_root =             union_root,
454         .vfs_statfs =           union_statfs,
455         .vfs_sync =             vfs_stdsync,
456         .vfs_init =             union_init
457 };
458
459 VFS_SET(union_vfsops, union, VFCF_LOOPBACK);