VFS messaging/interfacing work stage 2/99. This stage retools the vnode ops
[dragonfly.git] / sys / vfs / union / union_vnops.c
1 /*
2  * Copyright (c) 1992, 1993, 1994, 1995 Jan-Simon Pendry.
3  * Copyright (c) 1992, 1993, 1994, 1995
4  *      The Regents of the University of California.  All rights reserved.
5  *
6  * This code is derived from software contributed 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_vnops.c       8.32 (Berkeley) 6/23/95
38  * $FreeBSD: src/sys/miscfs/union/union_vnops.c,v 1.72 1999/12/15 23:02:14 eivind Exp $
39  * $DragonFly: src/sys/vfs/union/union_vnops.c,v 1.14 2004/08/17 18:57:36 dillon Exp $
40  */
41
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/proc.h>
45 #include <sys/fcntl.h>
46 #include <sys/stat.h>
47 #include <sys/kernel.h>
48 #include <sys/vnode.h>
49 #include <sys/mount.h>
50 #include <sys/namei.h>
51 #include <sys/malloc.h>
52 #include <sys/buf.h>
53 #include <sys/lock.h>
54 #include <sys/sysctl.h>
55 #include "union.h"
56
57 #include <vm/vm.h>
58 #include <vm/vnode_pager.h>
59
60 #include <vm/vm_page.h>
61 #include <vm/vm_object.h>
62
63 int uniondebug = 0;
64
65 #if UDEBUG_ENABLED
66 SYSCTL_INT(_vfs, OID_AUTO, uniondebug, CTLFLAG_RW, &uniondebug, 0, "");
67 #else
68 SYSCTL_INT(_vfs, OID_AUTO, uniondebug, CTLFLAG_RD, &uniondebug, 0, "");
69 #endif
70
71 static int      union_access (struct vop_access_args *ap);
72 static int      union_advlock (struct vop_advlock_args *ap);
73 static int      union_bmap (struct vop_bmap_args *ap);
74 static int      union_close (struct vop_close_args *ap);
75 static int      union_create (struct vop_create_args *ap);
76 static int      union_fsync (struct vop_fsync_args *ap);
77 static int      union_getattr (struct vop_getattr_args *ap);
78 static int      union_inactive (struct vop_inactive_args *ap);
79 static int      union_ioctl (struct vop_ioctl_args *ap);
80 static int      union_lease (struct vop_lease_args *ap);
81 static int      union_link (struct vop_link_args *ap);
82 static int      union_lock (struct vop_lock_args *ap);
83 static int      union_lookup (struct vop_lookup_args *ap);
84 static int      union_lookup1 (struct vnode *udvp, struct vnode **dvp,
85                                    struct vnode **vpp,
86                                    struct componentname *cnp);
87 static int      union_mkdir (struct vop_mkdir_args *ap);
88 static int      union_mknod (struct vop_mknod_args *ap);
89 static int      union_mmap (struct vop_mmap_args *ap);
90 static int      union_open (struct vop_open_args *ap);
91 static int      union_pathconf (struct vop_pathconf_args *ap);
92 static int      union_print (struct vop_print_args *ap);
93 static int      union_read (struct vop_read_args *ap);
94 static int      union_readdir (struct vop_readdir_args *ap);
95 static int      union_readlink (struct vop_readlink_args *ap);
96 static int      union_reclaim (struct vop_reclaim_args *ap);
97 static int      union_remove (struct vop_remove_args *ap);
98 static int      union_rename (struct vop_rename_args *ap);
99 static int      union_revoke (struct vop_revoke_args *ap);
100 static int      union_rmdir (struct vop_rmdir_args *ap);
101 static int      union_poll (struct vop_poll_args *ap);
102 static int      union_setattr (struct vop_setattr_args *ap);
103 static int      union_strategy (struct vop_strategy_args *ap);
104 static int      union_getpages (struct vop_getpages_args *ap);
105 static int      union_putpages (struct vop_putpages_args *ap);
106 static int      union_symlink (struct vop_symlink_args *ap);
107 static int      union_unlock (struct vop_unlock_args *ap);
108 static int      union_whiteout (struct vop_whiteout_args *ap);
109 static int      union_write (struct vop_read_args *ap);
110
111 static __inline
112 struct vnode *
113 union_lock_upper(struct union_node *un, struct thread *td)
114 {
115         struct vnode *uppervp;
116
117         if ((uppervp = un->un_uppervp) != NULL) {
118                 vref(uppervp);
119                 vn_lock(uppervp, NULL, LK_EXCLUSIVE | LK_CANRECURSE | LK_RETRY, td);
120         }
121         KASSERT((uppervp == NULL || uppervp->v_usecount > 0), ("uppervp usecount is 0"));
122         return(uppervp);
123 }
124
125 static __inline
126 void
127 union_unlock_upper(struct vnode *uppervp, struct thread *td)
128 {
129         vput(uppervp);
130 }
131
132 static __inline
133 struct vnode *
134 union_lock_other(struct union_node *un, struct thread *td)
135 {
136         struct vnode *vp;
137
138         if (un->un_uppervp != NULL) {
139                 vp = union_lock_upper(un, td);
140         } else if ((vp = un->un_lowervp) != NULL) {
141                 vref(vp);
142                 vn_lock(vp, NULL, LK_EXCLUSIVE | LK_CANRECURSE | LK_RETRY, td);
143         }
144         return(vp);
145 }
146
147 static __inline
148 void
149 union_unlock_other(struct vnode *vp, struct thread *td)
150 {
151         vput(vp);
152 }
153
154 /*
155  *      union_lookup:
156  *
157  *      udvp    must be exclusively locked on call and will remain 
158  *              exclusively locked on return.  This is the mount point 
159  *              for out filesystem.
160  *
161  *      dvp     Our base directory, locked and referenced.
162  *              The passed dvp will be dereferenced and unlocked on return
163  *              and a new dvp will be returned which is locked and 
164  *              referenced in the same variable.
165  *
166  *      vpp     is filled in with the result if no error occured,
167  *              locked and ref'd.
168  *
169  *              If an error is returned, *vpp is set to NULLVP.  If no
170  *              error occurs, *vpp is returned with a reference and an
171  *              exclusive lock.
172  */
173
174 static int
175 union_lookup1(struct vnode *udvp, struct vnode **pdvp, struct vnode **vpp,
176               struct componentname *cnp)
177 {
178         int error;
179         struct thread *td = cnp->cn_td;
180         struct vnode *dvp = *pdvp;
181         struct vnode *tdvp;
182         struct mount *mp;
183
184         /*
185          * If stepping up the directory tree, check for going
186          * back across the mount point, in which case do what
187          * lookup would do by stepping back down the mount
188          * hierarchy.
189          */
190         if (cnp->cn_flags & CNP_ISDOTDOT) {
191                 while ((dvp != udvp) && (dvp->v_flag & VROOT)) {
192                         /*
193                          * Don't do the NOCROSSMOUNT check
194                          * at this level.  By definition,
195                          * union fs deals with namespaces, not
196                          * filesystems.
197                          */
198                         tdvp = dvp;
199                         dvp = dvp->v_mount->mnt_vnodecovered;
200                         vref(dvp);
201                         vput(tdvp);
202                         vn_lock(dvp, NULL, LK_EXCLUSIVE | LK_RETRY, td);
203                 }
204         }
205
206         /*
207          * Set return dvp to be the upperdvp 'parent directory.
208          */
209         *pdvp = dvp;
210
211         /*
212          * If the VOP_LOOKUP call generates an error, tdvp is invalid and no
213          * changes will have been made to dvp, so we are set to return.
214          */
215
216         error = VOP_LOOKUP(dvp, NCPNULL, &tdvp, NCPPNULL, cnp);
217         if (error) {
218                 UDEBUG(("dvp %p error %d flags %lx\n", dvp, error, cnp->cn_flags));
219                 *vpp = NULL;
220                 return (error);
221         }
222
223         /*
224          * The parent directory will have been unlocked, unless lookup
225          * found the last component or if dvp == tdvp (tdvp must be locked).
226          *
227          * We want our dvp to remain locked and ref'd.  We also want tdvp
228          * to remain locked and ref'd.
229          */
230         UDEBUG(("parentdir %p result %p flag %lx\n", dvp, tdvp, cnp->cn_flags));
231
232         if (dvp != tdvp && (cnp->cn_flags & CNP_ISLASTCN) == 0)
233                 vn_lock(dvp, NULL, LK_EXCLUSIVE | LK_RETRY, td);
234
235         /*
236          * Lastly check if the current node is a mount point in
237          * which case walk up the mount hierarchy making sure not to
238          * bump into the root of the mount tree (ie. dvp != udvp).
239          *
240          * We use dvp as a temporary variable here, it is no longer related
241          * to the dvp above.  However, we have to ensure that both *pdvp and
242          * tdvp are locked on return.
243          */
244
245         dvp = tdvp;
246         while (
247             dvp != udvp && 
248             (dvp->v_type == VDIR) &&
249             (mp = dvp->v_mountedhere)
250         ) {
251                 int relock_pdvp = 0;
252
253                 if (vfs_busy(mp, 0, NULL, td))
254                         continue;
255
256                 if (dvp == *pdvp)
257                         relock_pdvp = 1;
258                 vput(dvp);
259                 dvp = NULL;
260                 error = VFS_ROOT(mp, &dvp);
261
262                 vfs_unbusy(mp, td);
263
264                 if (relock_pdvp)
265                         vn_lock(*pdvp, NULL, LK_EXCLUSIVE | LK_RETRY, td);
266
267                 if (error) {
268                         *vpp = NULL;
269                         return (error);
270                 }
271         }
272         *vpp = dvp;
273         return (0);
274 }
275
276 /*
277  * union_lookup(struct vnodeop_desc *a_desc, struct vnode *a_dvp,
278  *              struct vnode **a_vpp, struct componentname *a_cnp)
279  */
280 static int
281 union_lookup(struct vop_lookup_args *ap)
282 {
283         int error;
284         int uerror, lerror;
285         struct vnode *uppervp, *lowervp;
286         struct vnode *upperdvp, *lowerdvp;
287         struct vnode *dvp = ap->a_dvp;          /* starting dir */
288         struct union_node *dun = VTOUNION(dvp); /* associated union node */
289         struct componentname *cnp = ap->a_cnp;
290         struct thread *td = cnp->cn_td;
291         int lockparent = cnp->cn_flags & CNP_LOCKPARENT;
292         struct union_mount *um = MOUNTTOUNIONMOUNT(dvp->v_mount);
293         struct ucred *saved_cred = NULL;
294         int iswhiteout;
295         struct vattr va;
296
297         *ap->a_vpp = NULLVP;
298
299         /*
300          * Disallow write attemps to the filesystem mounted read-only.
301          */
302         if ((cnp->cn_flags & CNP_ISLASTCN) && 
303             (dvp->v_mount->mnt_flag & MNT_RDONLY) &&
304             (cnp->cn_nameiop == NAMEI_DELETE || cnp->cn_nameiop == NAMEI_RENAME)) {
305                 return (EROFS);
306         }
307
308         /*
309          * For any lookup's we do, always return with the parent locked
310          */
311         cnp->cn_flags |= CNP_LOCKPARENT;
312
313         lowerdvp = dun->un_lowervp;
314         uppervp = NULLVP;
315         lowervp = NULLVP;
316         iswhiteout = 0;
317
318         uerror = ENOENT;
319         lerror = ENOENT;
320
321         /*
322          * Get a private lock on uppervp and a reference, effectively 
323          * taking it out of the union_node's control.
324          *
325          * We must lock upperdvp while holding our lock on dvp
326          * to avoid a deadlock.
327          */
328         upperdvp = union_lock_upper(dun, td);
329
330         /*
331          * do the lookup in the upper level.
332          * if that level comsumes additional pathnames,
333          * then assume that something special is going
334          * on and just return that vnode.
335          */
336         if (upperdvp != NULLVP) {
337                 /*
338                  * We do not have to worry about the DOTDOT case, we've
339                  * already unlocked dvp.
340                  */
341                 UDEBUG(("A %p\n", upperdvp));
342
343                 /*
344                  * Do the lookup.   We must supply a locked and referenced
345                  * upperdvp to the function and will get a new locked and
346                  * referenced upperdvp back with the old having been 
347                  * dereferenced.
348                  *
349                  * If an error is returned, uppervp will be NULLVP.  If no
350                  * error occurs, uppervp will be the locked and referenced
351                  * return vnode or possibly NULL, depending on what is being
352                  * requested.  It is possible that the returned uppervp
353                  * will be the same as upperdvp.
354                  */
355                 uerror = union_lookup1(um->um_uppervp, &upperdvp, &uppervp, cnp);
356                 UDEBUG((
357                     "uerror %d upperdvp %p %d/%d, uppervp %p ref=%d/lck=%d\n",
358                     uerror,
359                     upperdvp,
360                     upperdvp->v_usecount,
361                     VOP_ISLOCKED(upperdvp, NULL),
362                     uppervp,
363                     (uppervp ? uppervp->v_usecount : -99),
364                     (uppervp ? VOP_ISLOCKED(uppervp, NULL) : -99)
365                 ));
366
367                 /*
368                  * Disallow write attemps to the filesystem mounted read-only.
369                  */
370                 if (uerror == EJUSTRETURN && (cnp->cn_flags & CNP_ISLASTCN) &&
371                     (dvp->v_mount->mnt_flag & MNT_RDONLY) &&
372                     (cnp->cn_nameiop == NAMEI_CREATE || cnp->cn_nameiop == NAMEI_RENAME)) {
373                         error = EROFS;
374                         goto out;
375                 }
376
377                 /*
378                  * Special case.  If cn_consume != 0 skip out.  The result
379                  * of the lookup is transfered to our return variable.  If
380                  * an error occured we have to throw away the results.
381                  */
382
383                 if (cnp->cn_consume != 0) {
384                         if ((error = uerror) == 0) {
385                                 *ap->a_vpp = uppervp;
386                                 uppervp = NULL;
387                         }
388                         goto out;
389                 }
390
391                 /*
392                  * Calculate whiteout, fall through
393                  */
394
395                 if (uerror == ENOENT || uerror == EJUSTRETURN) {
396                         if (cnp->cn_flags & CNP_ISWHITEOUT) {
397                                 iswhiteout = 1;
398                         } else if (lowerdvp != NULLVP) {
399                                 int terror;
400
401                                 terror = VOP_GETATTR(upperdvp, &va, cnp->cn_td);
402                                 if (terror == 0 && (va.va_flags & OPAQUE))
403                                         iswhiteout = 1;
404                         }
405                 }
406         }
407
408         /*
409          * in a similar way to the upper layer, do the lookup
410          * in the lower layer.   this time, if there is some
411          * component magic going on, then vput whatever we got
412          * back from the upper layer and return the lower vnode
413          * instead.
414          */
415
416         if (lowerdvp != NULLVP && !iswhiteout) {
417                 int nameiop;
418
419                 UDEBUG(("B %p\n", lowerdvp));
420
421                 /*
422                  * Force only LOOKUPs on the lower node, since
423                  * we won't be making changes to it anyway.
424                  */
425                 nameiop = cnp->cn_nameiop;
426                 cnp->cn_nameiop = NAMEI_LOOKUP;
427                 if (um->um_op == UNMNT_BELOW) {
428                         saved_cred = cnp->cn_cred;
429                         cnp->cn_cred = um->um_cred;
430                 }
431
432                 /*
433                  * We shouldn't have to worry about locking interactions
434                  * between the lower layer and our union layer (w.r.t.
435                  * `..' processing) because we don't futz with lowervp
436                  * locks in the union-node instantiation code path.
437                  *
438                  * union_lookup1() requires lowervp to be locked on entry,
439                  * and it will be unlocked on return.  The ref count will
440                  * not change.  On return lowervp doesn't represent anything
441                  * to us so we NULL it out.
442                  */
443                 vref(lowerdvp);
444                 vn_lock(lowerdvp, NULL, LK_EXCLUSIVE | LK_RETRY, td);
445                 lerror = union_lookup1(um->um_lowervp, &lowerdvp, &lowervp, cnp);
446                 if (lowerdvp == lowervp)
447                         vrele(lowerdvp);
448                 else
449                         vput(lowerdvp);
450                 lowerdvp = NULL;        /* lowerdvp invalid after vput */
451
452                 if (um->um_op == UNMNT_BELOW)
453                         cnp->cn_cred = saved_cred;
454                 cnp->cn_nameiop = nameiop;
455
456                 if (cnp->cn_consume != 0 || lerror == EACCES) {
457                         if ((error = lerror) == 0) {
458                                 *ap->a_vpp = lowervp;
459                                 lowervp = NULL;
460                         }
461                         goto out;
462                 }
463         } else {
464                 UDEBUG(("C %p\n", lowerdvp));
465                 if ((cnp->cn_flags & CNP_ISDOTDOT) && dun->un_pvp != NULLVP) {
466                         if ((lowervp = LOWERVP(dun->un_pvp)) != NULL) {
467                                 vref(lowervp);
468                                 vn_lock(lowervp, NULL, LK_EXCLUSIVE | LK_RETRY, td);
469                                 lerror = 0;
470                         }
471                 }
472         }
473
474         /*
475          * Ok.  Now we have uerror, uppervp, upperdvp, lerror, and lowervp.
476          *
477          * 1. If both layers returned an error, select the upper layer.
478          *
479          * 2. If the upper layer faile and the bottom layer succeeded,
480          *    two subcases occur:
481          *
482          *      a.  The bottom vnode is not a directory, in which case
483          *          just return a new union vnode referencing an
484          *          empty top layer and the existing bottom layer.
485          *
486          *      b.  The button vnode is a directory, in which case
487          *          create a new directory in the top layer and
488          *          and fall through to case 3.
489          *
490          * 3. If the top layer succeeded then return a new union
491          *    vnode referencing whatever the new top layer and
492          *    whatever the bottom layer returned.
493          */
494
495         /* case 1. */
496         if ((uerror != 0) && (lerror != 0)) {
497                 error = uerror;
498                 goto out;
499         }
500
501         /* case 2. */
502         if (uerror != 0 /* && (lerror == 0) */ ) {
503                 if (lowervp->v_type == VDIR) { /* case 2b. */
504                         KASSERT(uppervp == NULL, ("uppervp unexpectedly non-NULL"));
505                         /*
506                          * oops, uppervp has a problem, we may have to shadow.
507                          */
508                         uerror = union_mkshadow(um, upperdvp, cnp, &uppervp);
509                         if (uerror) {
510                                 error = uerror;
511                                 goto out;
512                         }
513                 }
514         }
515
516         /*
517          * Must call union_allocvp with both the upper and lower vnodes
518          * referenced and the upper vnode locked.   ap->a_vpp is returned 
519          * referenced and locked.  lowervp, uppervp, and upperdvp are 
520          * absorbed by union_allocvp() whether it succeeds or fails.
521          *
522          * upperdvp is the parent directory of uppervp which may be
523          * different, depending on the path, from dvp->un_uppervp.  That's
524          * why it is a separate argument.  Note that it must be unlocked.
525          *
526          * dvp must be locked on entry to the call and will be locked on
527          * return.
528          */
529
530         if (uppervp && uppervp != upperdvp)
531                 VOP_UNLOCK(uppervp, NULL, 0, td);
532         if (lowervp)
533                 VOP_UNLOCK(lowervp, NULL, 0, td);
534         if (upperdvp)
535                 VOP_UNLOCK(upperdvp, NULL, 0, td);
536
537         error = union_allocvp(ap->a_vpp, dvp->v_mount, dvp, upperdvp, cnp,
538                               uppervp, lowervp, 1);
539
540         UDEBUG(("Create %p = %p %p refs=%d\n", *ap->a_vpp, uppervp, lowervp, (*ap->a_vpp) ? ((*ap->a_vpp)->v_usecount) : -99));
541
542         uppervp = NULL;
543         upperdvp = NULL;
544         lowervp = NULL;
545
546         /* 
547          *      Termination Code
548          *
549          *      - put away any extra junk laying around.  Note that lowervp
550          *        (if not NULL) will never be the same as *ap->a_vp and 
551          *        neither will uppervp, because when we set that state we 
552          *        NULL-out lowervp or uppervp.  On the otherhand, upperdvp
553          *        may match uppervp or *ap->a_vpp.
554          *
555          *      - relock/unlock dvp if appropriate.
556          */
557
558 out:
559         if (upperdvp) {
560                 if (upperdvp == uppervp || upperdvp == *ap->a_vpp)
561                         vrele(upperdvp);
562                 else
563                         vput(upperdvp);
564         }
565
566         if (uppervp)
567                 vput(uppervp);
568
569         if (lowervp)
570                 vput(lowervp);
571
572         /*
573          * Restore LOCKPARENT state
574          */
575
576         if (!lockparent)
577                 cnp->cn_flags &= ~CNP_LOCKPARENT;
578
579         UDEBUG(("Out %d vpp %p/%d lower %p upper %p\n", error, *ap->a_vpp,
580                 ((*ap->a_vpp) ? (*ap->a_vpp)->v_usecount : -99),
581                 lowervp, uppervp));
582
583         /*
584          * dvp lock state, determine whether to relock dvp.  dvp is expected
585          * to be locked on return if:
586          *
587          *      - there was an error (except not EJUSTRETURN), or
588          *      - we hit the last component and lockparent is true
589          *
590          * dvp_is_locked is the current state of the dvp lock, not counting
591          * the possibility that *ap->a_vpp == dvp (in which case it is locked
592          * anyway).  Note that *ap->a_vpp == dvp only if no error occured.
593          */
594
595         if (*ap->a_vpp != dvp) {
596                 if ((error == 0 || error == EJUSTRETURN) &&
597                     (!lockparent || (cnp->cn_flags & CNP_ISLASTCN) == 0)) {
598                         VOP_UNLOCK(dvp, NULL, 0, td);
599                 }
600         }
601
602         /*
603          * Diagnostics
604          */
605
606 #ifdef DIAGNOSTIC
607         if (cnp->cn_namelen == 1 &&
608             cnp->cn_nameptr[0] == '.' &&
609             *ap->a_vpp != dvp) {
610                 panic("union_lookup returning . (%p) not same as startdir (%p)", ap->a_vpp, dvp);
611         }
612 #endif
613
614         return (error);
615 }
616
617 /*
618  *      union_create:
619  *
620  * a_dvp is locked on entry and remains locked on return.  a_vpp is returned
621  * locked if no error occurs, otherwise it is garbage.
622  *
623  * union_create(struct vnode *a_dvp, struct vnode **a_vpp,
624  *              struct componentname *a_cnp, struct vattr *a_vap)
625  */
626 static int
627 union_create(struct vop_create_args *ap)
628 {
629         struct union_node *dun = VTOUNION(ap->a_dvp);
630         struct componentname *cnp = ap->a_cnp;
631         struct thread *td = cnp->cn_td;
632         struct vnode *dvp;
633         int error = EROFS;
634
635         if ((dvp = union_lock_upper(dun, td)) != NULL) {
636                 struct vnode *vp;
637                 struct mount *mp;
638
639                 error = VOP_CREATE(dvp, NCPNULL, &vp, cnp, ap->a_vap);
640                 if (error == 0) {
641                         mp = ap->a_dvp->v_mount;
642                         VOP_UNLOCK(vp, NULL, 0, td);
643                         UDEBUG(("ALLOCVP-1 FROM %p REFS %d\n", vp, vp->v_usecount));
644                         error = union_allocvp(ap->a_vpp, mp, NULLVP, NULLVP,
645                                 cnp, vp, NULLVP, 1);
646                         UDEBUG(("ALLOCVP-2B FROM %p REFS %d\n", *ap->a_vpp, vp->v_usecount));
647                 }
648                 union_unlock_upper(dvp, td);
649         }
650         return (error);
651 }
652
653 /*
654  * union_whiteout(struct vnode *a_dvp, struct componentname *a_cnp,
655  *                int a_flags)
656  */
657 static int
658 union_whiteout(struct vop_whiteout_args *ap)
659 {
660         struct union_node *un = VTOUNION(ap->a_dvp);
661         struct componentname *cnp = ap->a_cnp;
662         struct vnode *uppervp;
663         int error = EOPNOTSUPP;
664
665         if ((uppervp = union_lock_upper(un, cnp->cn_td)) != NULLVP) {
666                 error = VOP_WHITEOUT(un->un_uppervp, NCPNULL, cnp, ap->a_flags);
667                 union_unlock_upper(uppervp, cnp->cn_td);
668         }
669         return(error);
670 }
671
672 /*
673  *      union_mknod:
674  *
675  *      a_dvp is locked on entry and should remain locked on return.
676  *      a_vpp is garbagre whether an error occurs or not.
677  *
678  * union_mknod(struct vnode *a_dvp, struct vnode **a_vpp,
679  *              struct componentname *a_cnp, struct vattr *a_vap)
680  */
681 static int
682 union_mknod(struct vop_mknod_args *ap)
683 {
684         struct union_node *dun = VTOUNION(ap->a_dvp);
685         struct componentname *cnp = ap->a_cnp;
686         struct vnode *dvp;
687         int error = EROFS;
688
689         if ((dvp = union_lock_upper(dun, cnp->cn_td)) != NULL) {
690                 error = VOP_MKNOD(dvp, NCPNULL, ap->a_vpp, cnp, ap->a_vap);
691                 union_unlock_upper(dvp, cnp->cn_td);
692         }
693         return (error);
694 }
695
696 /*
697  *      union_open:
698  *
699  *      run open VOP.  When opening the underlying vnode we have to mimic
700  *      vn_open.  What we *really* need to do to avoid screwups if the
701  *      open semantics change is to call vn_open().  For example, ufs blows
702  *      up if you open a file but do not vmio it prior to writing.
703  *
704  * union_open(struct vnodeop_desc *a_desc, struct vnode *a_vp, int a_mode,
705  *            struct ucred *a_cred, struct thread *a_td)
706  */
707 static int
708 union_open(struct vop_open_args *ap)
709 {
710         struct union_node *un = VTOUNION(ap->a_vp);
711         struct vnode *tvp;
712         int mode = ap->a_mode;
713         struct ucred *cred = ap->a_cred;
714         struct thread *td = ap->a_td;
715         int error = 0;
716         int tvpisupper = 1;
717
718         /*
719          * If there is an existing upper vp then simply open that.
720          * The upper vp takes precedence over the lower vp.  When opening
721          * a lower vp for writing copy it to the uppervp and then open the
722          * uppervp.
723          *
724          * At the end of this section tvp will be left locked.
725          */
726         if ((tvp = union_lock_upper(un, td)) == NULLVP) {
727                 /*
728                  * If the lower vnode is being opened for writing, then
729                  * copy the file contents to the upper vnode and open that,
730                  * otherwise can simply open the lower vnode.
731                  */
732                 tvp = un->un_lowervp;
733                 if ((ap->a_mode & FWRITE) && (tvp->v_type == VREG)) {
734                         int docopy = !(mode & O_TRUNC);
735                         error = union_copyup(un, docopy, cred, td);
736                         tvp = union_lock_upper(un, td);
737                 } else {
738                         un->un_openl++;
739                         vref(tvp);
740                         vn_lock(tvp, NULL, LK_EXCLUSIVE | LK_RETRY, td);
741                         tvpisupper = 0;
742                 }
743         }
744
745         /*
746          * We are holding the correct vnode, open it
747          */
748
749         if (error == 0)
750                 error = VOP_OPEN(tvp, mode, cred, td);
751
752         /*
753          * Absolutely necessary or UFS will blowup
754          */
755         if (error == 0 && vn_canvmio(tvp) == TRUE) {
756                 error = vfs_object_create(tvp, td);
757         }
758
759         /*
760          * Release any locks held
761          */
762         if (tvpisupper) {
763                 if (tvp)
764                         union_unlock_upper(tvp, td);
765         } else {
766                 vput(tvp);
767         }
768         return (error);
769 }
770
771 /*
772  *      union_close:
773  *
774  *      It is unclear whether a_vp is passed locked or unlocked.  Whatever
775  *      the case we do not change it.
776  *
777  * union_close(struct vnode *a_vp, int a_fflag, struct ucred *a_cred,
778  *              struct thread *a_td)
779  */
780 static int
781 union_close(struct vop_close_args *ap)
782 {
783         struct union_node *un = VTOUNION(ap->a_vp);
784         struct vnode *vp;
785
786         if ((vp = un->un_uppervp) == NULLVP) {
787 #ifdef UNION_DIAGNOSTIC
788                 if (un->un_openl <= 0)
789                         panic("union: un_openl cnt");
790 #endif
791                 --un->un_openl;
792                 vp = un->un_lowervp;
793         }
794         ap->a_head.a_ops = vp->v_ops;
795         ap->a_vp = vp;
796         return(vop_close_ap(ap));
797 }
798
799 /*
800  * Check access permission on the union vnode.
801  * The access check being enforced is to check
802  * against both the underlying vnode, and any
803  * copied vnode.  This ensures that no additional
804  * file permissions are given away simply because
805  * the user caused an implicit file copy.
806  *
807  * union_access(struct vnodeop_desc *a_desc, struct vnode *a_vp, int a_mode,
808  *              struct ucred *a_cred, struct thread *a_td)
809  */
810 static int
811 union_access(struct vop_access_args *ap)
812 {
813         struct union_node *un = VTOUNION(ap->a_vp);
814         struct thread *td = ap->a_td;
815         int error = EACCES;
816         struct vnode *vp;
817
818         /*
819          * Disallow write attempts on filesystems mounted read-only.
820          */
821         if ((ap->a_mode & VWRITE) && 
822             (ap->a_vp->v_mount->mnt_flag & MNT_RDONLY)) {
823                 switch (ap->a_vp->v_type) {
824                 case VREG: 
825                 case VDIR:
826                 case VLNK:
827                         return (EROFS);
828                 default:
829                         break;
830                 }
831         }
832
833         if ((vp = union_lock_upper(un, td)) != NULLVP) {
834                 ap->a_head.a_ops = vp->v_ops;
835                 ap->a_vp = vp;
836                 error = vop_access_ap(ap);
837                 union_unlock_upper(vp, td);
838                 return(error);
839         }
840
841         if ((vp = un->un_lowervp) != NULLVP) {
842                 vn_lock(vp, NULL, LK_EXCLUSIVE | LK_RETRY, td);
843                 ap->a_head.a_ops = vp->v_ops;
844                 ap->a_vp = vp;
845
846                 /*
847                  * Remove VWRITE from a_mode if our mount point is RW, because
848                  * we want to allow writes and lowervp may be read-only.
849                  */
850                 if ((un->un_vnode->v_mount->mnt_flag & MNT_RDONLY) == 0)
851                         ap->a_mode &= ~VWRITE;
852
853                 error = vop_access_ap(ap);
854                 if (error == 0) {
855                         struct union_mount *um;
856
857                         um = MOUNTTOUNIONMOUNT(un->un_vnode->v_mount);
858
859                         if (um->um_op == UNMNT_BELOW) {
860                                 ap->a_cred = um->um_cred;
861                                 error = vop_access_ap(ap);
862                         }
863                 }
864                 VOP_UNLOCK(vp, NULL, 0, td);
865         }
866         return(error);
867 }
868
869 /*
870  * We handle getattr only to change the fsid and
871  * track object sizes
872  *
873  * It's not clear whether VOP_GETATTR is to be
874  * called with the vnode locked or not.  stat() calls
875  * it with (vp) locked, and fstat calls it with
876  * (vp) unlocked. 
877  *
878  * Because of this we cannot use our normal locking functions
879  * if we do not intend to lock the main a_vp node.  At the moment
880  * we are running without any specific locking at all, but beware
881  * to any programmer that care must be taken if locking is added
882  * to this function.
883  *
884  * union_getattr(struct vnode *a_vp, struct vattr *a_vap,
885  *               struct ucred *a_cred, struct thread *a_td)
886  */
887 static int
888 union_getattr(struct vop_getattr_args *ap)
889 {
890         int error;
891         struct union_node *un = VTOUNION(ap->a_vp);
892         struct vnode *vp;
893         struct vattr *vap;
894         struct vattr va;
895
896         /*
897          * Some programs walk the filesystem hierarchy by counting
898          * links to directories to avoid stat'ing all the time.
899          * This means the link count on directories needs to be "correct".
900          * The only way to do that is to call getattr on both layers
901          * and fix up the link count.  The link count will not necessarily
902          * be accurate but will be large enough to defeat the tree walkers.
903          */
904
905         vap = ap->a_vap;
906
907         if ((vp = un->un_uppervp) != NULLVP) {
908                 error = VOP_GETATTR(vp, vap, ap->a_td);
909                 if (error)
910                         return (error);
911                 /* XXX isn't this dangerouso without a lock? */
912                 union_newsize(ap->a_vp, vap->va_size, VNOVAL);
913         }
914
915         if (vp == NULLVP) {
916                 vp = un->un_lowervp;
917         } else if (vp->v_type == VDIR && un->un_lowervp != NULLVP) {
918                 vp = un->un_lowervp;
919                 vap = &va;
920         } else {
921                 vp = NULLVP;
922         }
923
924         if (vp != NULLVP) {
925                 error = VOP_GETATTR(vp, vap, ap->a_td);
926                 if (error)
927                         return (error);
928                 /* XXX isn't this dangerous without a lock? */
929                 union_newsize(ap->a_vp, VNOVAL, vap->va_size);
930         }
931
932         if ((vap != ap->a_vap) && (vap->va_type == VDIR))
933                 ap->a_vap->va_nlink += vap->va_nlink;
934         return (0);
935 }
936
937 /*
938  * union_setattr(struct vnode *a_vp, struct vattr *a_vap,
939  *               struct ucred *a_cred, struct thread *a_td)
940  */
941 static int
942 union_setattr(struct vop_setattr_args *ap)
943 {
944         struct union_node *un = VTOUNION(ap->a_vp);
945         struct thread *td = ap->a_td;
946         struct vattr *vap = ap->a_vap;
947         struct vnode *uppervp;
948         int error;
949
950         /*
951          * Disallow write attempts on filesystems mounted read-only.
952          */
953         if ((ap->a_vp->v_mount->mnt_flag & MNT_RDONLY) &&
954             (vap->va_flags != VNOVAL || vap->va_uid != (uid_t)VNOVAL ||
955              vap->va_gid != (gid_t)VNOVAL || vap->va_atime.tv_sec != VNOVAL ||
956              vap->va_mtime.tv_sec != VNOVAL || 
957              vap->va_mode != (mode_t)VNOVAL)) {
958                 return (EROFS);
959         }
960
961         /*
962          * Handle case of truncating lower object to zero size,
963          * by creating a zero length upper object.  This is to
964          * handle the case of open with O_TRUNC and O_CREAT.
965          */
966         if (un->un_uppervp == NULLVP && (un->un_lowervp->v_type == VREG)) {
967                 error = union_copyup(un, (ap->a_vap->va_size != 0),
968                             ap->a_cred, ap->a_td);
969                 if (error)
970                         return (error);
971         }
972
973         /*
974          * Try to set attributes in upper layer,
975          * otherwise return read-only filesystem error.
976          */
977         error = EROFS;
978         if ((uppervp = union_lock_upper(un, td)) != NULLVP) {
979                 error = VOP_SETATTR(un->un_uppervp, ap->a_vap,
980                                         ap->a_cred, ap->a_td);
981                 if ((error == 0) && (ap->a_vap->va_size != VNOVAL))
982                         union_newsize(ap->a_vp, ap->a_vap->va_size, VNOVAL);
983                 union_unlock_upper(uppervp, td);
984         }
985         return (error);
986 }
987
988 /*
989  *      union_getpages:
990  */
991
992 static int
993 union_getpages(struct vop_getpages_args *ap)
994 {
995         int r;
996
997         r = vnode_pager_generic_getpages(ap->a_vp, ap->a_m, 
998                 ap->a_count, ap->a_reqpage);
999         return(r);
1000 }
1001
1002 /*
1003  *      union_putpages:
1004  */
1005
1006 static int
1007 union_putpages(struct vop_putpages_args *ap)
1008 {
1009         int r;
1010
1011         r = vnode_pager_generic_putpages(ap->a_vp, ap->a_m, ap->a_count,
1012                 ap->a_sync, ap->a_rtvals);
1013         return(r);
1014 }
1015
1016 /*
1017  * union_read(struct vnode *a_vp, struct uio *a_uio, int a_ioflag,
1018  *            struct ucred *a_cred)
1019  */
1020 static int
1021 union_read(struct vop_read_args *ap)
1022 {
1023         struct union_node *un = VTOUNION(ap->a_vp);
1024         struct thread *td = ap->a_uio->uio_td;
1025         struct vnode *uvp;
1026         int error;
1027
1028         uvp = union_lock_other(un, td);
1029         KASSERT(uvp != NULL, ("union_read: backing vnode missing!"));
1030
1031         if (ap->a_vp->v_flag & VOBJBUF)
1032                 union_vm_coherency(ap->a_vp, ap->a_uio, 0);
1033
1034         error = VOP_READ(uvp, ap->a_uio, ap->a_ioflag, ap->a_cred);
1035         union_unlock_other(uvp, td);
1036
1037         /*
1038          * XXX
1039          * perhaps the size of the underlying object has changed under
1040          * our feet.  take advantage of the offset information present
1041          * in the uio structure.
1042          */
1043         if (error == 0) {
1044                 struct union_node *un = VTOUNION(ap->a_vp);
1045                 off_t cur = ap->a_uio->uio_offset;
1046
1047                 if (uvp == un->un_uppervp) {
1048                         if (cur > un->un_uppersz)
1049                                 union_newsize(ap->a_vp, cur, VNOVAL);
1050                 } else {
1051                         if (cur > un->un_lowersz)
1052                                 union_newsize(ap->a_vp, VNOVAL, cur);
1053                 }
1054         }
1055         return (error);
1056 }
1057
1058 /*
1059  * union_write(struct vnode *a_vp, struct uio *a_uio, int a_ioflag,
1060  *              struct ucred *a_cred)
1061  */
1062 static int
1063 union_write(struct vop_read_args *ap)
1064 {
1065         struct union_node *un = VTOUNION(ap->a_vp);
1066         struct thread *td = ap->a_uio->uio_td;
1067         struct vnode *uppervp;
1068         int error;
1069
1070         if ((uppervp = union_lock_upper(un, td)) == NULLVP)
1071                 panic("union: missing upper layer in write");
1072
1073         /*
1074          * Since our VM pages are associated with our vnode rather then
1075          * the real vnode, and since we do not run our reads and writes 
1076          * through our own VM cache, we have a VM/VFS coherency problem. 
1077          * We solve them by invalidating or flushing the associated VM
1078          * pages prior to allowing a normal read or write to occur.
1079          *
1080          * VM-backed writes (UIO_NOCOPY) have to be converted to normal
1081          * writes because we are not cache-coherent.  Normal writes need
1082          * to be made coherent with our VM-backing store, which we do by
1083          * first flushing any dirty VM pages associated with the write
1084          * range, and then destroying any clean VM pages associated with
1085          * the write range.
1086          */
1087
1088         if (ap->a_uio->uio_segflg == UIO_NOCOPY) {
1089                 ap->a_uio->uio_segflg = UIO_SYSSPACE;
1090         } else if (ap->a_vp->v_flag & VOBJBUF) {
1091                 union_vm_coherency(ap->a_vp, ap->a_uio, 1);
1092         }
1093
1094         error = VOP_WRITE(uppervp, ap->a_uio, ap->a_ioflag, ap->a_cred);
1095
1096         /*
1097          * the size of the underlying object may be changed by the
1098          * write.
1099          */
1100         if (error == 0) {
1101                 off_t cur = ap->a_uio->uio_offset;
1102
1103                 if (cur > un->un_uppersz)
1104                         union_newsize(ap->a_vp, cur, VNOVAL);
1105         }
1106         union_unlock_upper(uppervp, td);
1107         return (error);
1108 }
1109
1110 /*
1111  * union_lease(struct vnode *a_vp, struct thread *a_td, struct ucred *a_cred,
1112  *              int a_flag)
1113  */
1114 static int
1115 union_lease(struct vop_lease_args *ap)
1116 {
1117         struct vnode *ovp = OTHERVP(ap->a_vp);
1118
1119         ap->a_head.a_ops = ovp->v_ops;
1120         ap->a_vp = ovp;
1121         return (vop_lease_ap(ap));
1122 }
1123
1124 /*
1125  * union_ioctl(struct vnode *a_vp, int a_command, caddr_t a_data, int a_fflag,
1126  *              struct ucred *a_cred, struct thread *a_td)
1127  */
1128 static int
1129 union_ioctl(struct vop_ioctl_args *ap)
1130 {
1131         struct vnode *ovp = OTHERVP(ap->a_vp);
1132
1133         ap->a_head.a_ops = ovp->v_ops;
1134         ap->a_vp = ovp;
1135         return(vop_ioctl_ap(ap));
1136 }
1137
1138 /*
1139  * union_poll(struct vnode *a_vp, int a_events, struct ucred *a_cred,
1140  *            struct thread *a_td)
1141  */
1142 static int
1143 union_poll(struct vop_poll_args *ap)
1144 {
1145         struct vnode *ovp = OTHERVP(ap->a_vp);
1146
1147         ap->a_head.a_ops = ovp->v_ops;
1148         ap->a_vp = ovp;
1149         return(vop_poll_ap(ap));
1150 }
1151
1152 /*
1153  * union_revoke(struct vnode *a_vp, int a_flags, struct thread *a_td)
1154  */
1155 static int
1156 union_revoke(struct vop_revoke_args *ap)
1157 {
1158         struct vnode *vp = ap->a_vp;
1159
1160         if (UPPERVP(vp))
1161                 VOP_REVOKE(UPPERVP(vp), ap->a_flags);
1162         if (LOWERVP(vp))
1163                 VOP_REVOKE(LOWERVP(vp), ap->a_flags);
1164         vgone(vp);
1165         return (0);
1166 }
1167
1168 /*
1169  * union_mmap(struct vnode *a_vp, int a_fflags, struct ucred *a_cred,
1170  *            struct thread *a_td)
1171  */
1172 static int
1173 union_mmap(struct vop_mmap_args *ap)
1174 {
1175         struct vnode *ovp = OTHERVP(ap->a_vp);
1176
1177         ap->a_head.a_ops = ovp->v_ops;
1178         ap->a_vp = ovp;
1179         return (vop_mmap_ap(ap));
1180 }
1181
1182 /*
1183  * union_fsync(struct vnode *a_vp, struct ucred *a_cred, int a_waitfor,
1184  *              struct thread *a_td)
1185  */
1186 static int
1187 union_fsync(struct vop_fsync_args *ap)
1188 {
1189         int error = 0;
1190         struct thread *td = ap->a_td;
1191         struct vnode *targetvp;
1192         struct union_node *un = VTOUNION(ap->a_vp);
1193
1194         if ((targetvp = union_lock_other(un, td)) != NULLVP) {
1195                 error = VOP_FSYNC(targetvp, ap->a_waitfor, td);
1196                 union_unlock_other(targetvp, td);
1197         }
1198
1199         return (error);
1200 }
1201
1202 /*
1203  *      union_remove:
1204  *
1205  *      Remove the specified cnp.  The dvp and vp are passed to us locked
1206  *      and must remain locked on return.
1207  *
1208  * union_remove(struct vnode *a_dvp, struct vnode *a_vp,
1209  *              struct componentname *a_cnp)
1210  */
1211 static int
1212 union_remove(struct vop_remove_args *ap)
1213 {
1214         struct union_node *dun = VTOUNION(ap->a_dvp);
1215         struct union_node *un = VTOUNION(ap->a_vp);
1216         struct componentname *cnp = ap->a_cnp;
1217         struct thread *td = cnp->cn_td;
1218         struct vnode *uppervp;
1219         struct vnode *upperdvp;
1220         int error;
1221
1222         if ((upperdvp = union_lock_upper(dun, td)) == NULLVP)
1223                 panic("union remove: null upper vnode");
1224
1225         if ((uppervp = union_lock_upper(un, td)) != NULLVP) {
1226                 if (union_dowhiteout(un, cnp->cn_cred, td))
1227                         cnp->cn_flags |= CNP_DOWHITEOUT;
1228                 error = VOP_REMOVE(upperdvp, NCPNULL, uppervp, cnp);
1229 #if 0
1230                 /* XXX */
1231                 if (!error)
1232                         union_removed_upper(un);
1233 #endif
1234                 union_unlock_upper(uppervp, td);
1235         } else {
1236                 error = union_mkwhiteout(
1237                             MOUNTTOUNIONMOUNT(ap->a_dvp->v_mount),
1238                             upperdvp, ap->a_cnp, un->un_path);
1239         }
1240         union_unlock_upper(upperdvp, td);
1241         return (error);
1242 }
1243
1244 /*
1245  *      union_link:
1246  *
1247  *      tdvp will be locked on entry, vp will not be locked on entry.
1248  *      tdvp should remain locked on return and vp should remain unlocked
1249  *      on return.
1250  *
1251  * union_link(struct vnode *a_tdvp, struct vnode *a_vp,
1252  *            struct componentname *a_cnp)
1253  */
1254 static int
1255 union_link(struct vop_link_args *ap)
1256 {
1257         struct componentname *cnp = ap->a_cnp;
1258         struct thread *td = cnp->cn_td;
1259         struct union_node *dun = VTOUNION(ap->a_tdvp);
1260         struct vnode *vp;
1261         struct vnode *tdvp;
1262         int error = 0;
1263
1264         if (ap->a_tdvp->v_ops != ap->a_vp->v_ops) {
1265                 vp = ap->a_vp;
1266         } else {
1267                 struct union_node *tun = VTOUNION(ap->a_vp);
1268
1269                 if (tun->un_uppervp == NULLVP) {
1270                         vn_lock(ap->a_vp, NULL, LK_EXCLUSIVE | LK_RETRY, td);
1271 #if 0
1272                         if (dun->un_uppervp == tun->un_dirvp) {
1273                                 if (dun->un_flags & UN_ULOCK) {
1274                                         dun->un_flags &= ~UN_ULOCK;
1275                                         VOP_UNLOCK(dun->un_uppervp, NULL, 0, td);
1276                                 }
1277                         }
1278 #endif
1279                         error = union_copyup(tun, 1, cnp->cn_cred, td);
1280 #if 0
1281                         if (dun->un_uppervp == tun->un_dirvp) {
1282                                 vn_lock(dun->un_uppervp, NULL,
1283                                             LK_EXCLUSIVE | LK_RETRY, td);
1284                                 dun->un_flags |= UN_ULOCK;
1285                         }
1286 #endif
1287                         VOP_UNLOCK(ap->a_vp, NULL, 0, td);
1288                 }
1289                 vp = tun->un_uppervp;
1290         }
1291
1292         if (error)
1293                 return (error);
1294
1295         /*
1296          * Make sure upper is locked, then unlock the union directory we were 
1297          * called with to avoid a deadlock while we are calling VOP_LINK on 
1298          * the upper (with tdvp locked and vp not locked).  Our ap->a_tdvp
1299          * is expected to be locked on return.
1300          */
1301
1302         if ((tdvp = union_lock_upper(dun, td)) == NULLVP)
1303                 return (EROFS);
1304
1305         VOP_UNLOCK(ap->a_tdvp, NULL, 0, td);    /* unlock calling node */
1306         error = VOP_LINK(tdvp, NCPNULL, vp, cnp); /* call link on upper */
1307
1308         /*
1309          * We have to unlock tdvp prior to relocking our calling node in
1310          * order to avoid a deadlock.
1311          */
1312         union_unlock_upper(tdvp, td);
1313         vn_lock(ap->a_tdvp, NULL, LK_EXCLUSIVE | LK_RETRY, td);
1314         return (error);
1315 }
1316
1317 /*
1318  * union_rename(struct vnode *a_fdvp, struct vnode *a_fvp,
1319  *              struct componentname *a_fcnp, struct vnode *a_tdvp,
1320  *              struct vnode *a_tvp, struct componentname *a_tcnp)
1321  */
1322 static int
1323 union_rename(struct vop_rename_args *ap)
1324 {
1325         int error;
1326         struct vnode *fdvp = ap->a_fdvp;
1327         struct vnode *fvp = ap->a_fvp;
1328         struct vnode *tdvp = ap->a_tdvp;
1329         struct vnode *tvp = ap->a_tvp;
1330
1331         /*
1332          * Figure out what fdvp to pass to our upper or lower vnode.  If we
1333          * replace the fdvp, release the original one and ref the new one.
1334          */
1335
1336         if (fdvp->v_tag == VT_UNION) {  /* always true */
1337                 struct union_node *un = VTOUNION(fdvp);
1338                 if (un->un_uppervp == NULLVP) {
1339                         /*
1340                          * this should never happen in normal
1341                          * operation but might if there was
1342                          * a problem creating the top-level shadow
1343                          * directory.
1344                          */
1345                         error = EXDEV;
1346                         goto bad;
1347                 }
1348                 fdvp = un->un_uppervp;
1349                 vref(fdvp);
1350                 vrele(ap->a_fdvp);
1351         }
1352
1353         /*
1354          * Figure out what fvp to pass to our upper or lower vnode.  If we
1355          * replace the fvp, release the original one and ref the new one.
1356          */
1357
1358         if (fvp->v_tag == VT_UNION) {   /* always true */
1359                 struct union_node *un = VTOUNION(fvp);
1360 #if 0
1361                 struct union_mount *um = MOUNTTOUNIONMOUNT(fvp->v_mount);
1362 #endif
1363
1364                 if (un->un_uppervp == NULLVP) {
1365                         switch(fvp->v_type) {
1366                         case VREG:
1367                                 vn_lock(un->un_vnode, NULL, LK_EXCLUSIVE | LK_RETRY, ap->a_fcnp->cn_td);
1368                                 error = union_copyup(un, 1, ap->a_fcnp->cn_cred, ap->a_fcnp->cn_td);
1369                                 VOP_UNLOCK(un->un_vnode, NULL, 0, ap->a_fcnp->cn_td);
1370                                 if (error)
1371                                         goto bad;
1372                                 break;
1373                         case VDIR:
1374                                 /*
1375                                  * XXX not yet.
1376                                  *
1377                                  * There is only one way to rename a directory
1378                                  * based in the lowervp, and that is to copy
1379                                  * the entire directory hierarchy.  Otherwise
1380                                  * it would not last across a reboot.
1381                                  */
1382 #if 0
1383                                 vrele(fvp);
1384                                 fvp = NULL;
1385                                 vn_lock(fdvp, NULL, LK_EXCLUSIVE | LK_RETRY, ap->a_fcnp->cn_td);
1386                                 error = union_mkshadow(um, fdvp, 
1387                                             ap->a_fcnp, &un->un_uppervp);
1388                                 VOP_UNLOCK(fdvp, NULL, 0, ap->a_fcnp->cn_td);
1389                                 if (un->un_uppervp)
1390                                         VOP_UNLOCK(un->un_uppervp, NULL, 0, ap->a_fcnp->cn_td);
1391                                 if (error)
1392                                         goto bad;
1393                                 break;
1394 #endif
1395                         default:
1396                                 error = EXDEV;
1397                                 goto bad;
1398                         }
1399                 }
1400
1401                 if (un->un_lowervp != NULLVP)
1402                         ap->a_fcnp->cn_flags |= CNP_DOWHITEOUT;
1403                 fvp = un->un_uppervp;
1404                 vref(fvp);
1405                 vrele(ap->a_fvp);
1406         }
1407
1408         /*
1409          * Figure out what tdvp (destination directory) to pass to the
1410          * lower level.  If we replace it with uppervp, we need to vput the 
1411          * old one.  The exclusive lock is transfered to what we will pass
1412          * down in the VOP_RENAME and we replace uppervp with a simple
1413          * reference.
1414          */
1415
1416         if (tdvp->v_tag == VT_UNION) {
1417                 struct union_node *un = VTOUNION(tdvp);
1418
1419                 if (un->un_uppervp == NULLVP) {
1420                         /*
1421                          * this should never happen in normal
1422                          * operation but might if there was
1423                          * a problem creating the top-level shadow
1424                          * directory.
1425                          */
1426                         error = EXDEV;
1427                         goto bad;
1428                 }
1429
1430                 /*
1431                  * new tdvp is a lock and reference on uppervp, put away
1432                  * the old tdvp.
1433                  */
1434                 tdvp = union_lock_upper(un, ap->a_tcnp->cn_td);
1435                 vput(ap->a_tdvp);
1436         }
1437
1438         /*
1439          * Figure out what tvp (destination file) to pass to the
1440          * lower level.
1441          *
1442          * If the uppervp file does not exist put away the (wrong)
1443          * file and change tvp to NULL.
1444          */
1445
1446         if (tvp != NULLVP && tvp->v_tag == VT_UNION) {
1447                 struct union_node *un = VTOUNION(tvp);
1448
1449                 tvp = union_lock_upper(un, ap->a_tcnp->cn_td);
1450                 vput(ap->a_tvp);
1451                 /* note: tvp may be NULL */
1452         }
1453
1454         /*
1455          * VOP_RENAME releases/vputs prior to returning, so we have no
1456          * cleanup to do.
1457          */
1458
1459         return (VOP_RENAME(fdvp, NCPNULL, fvp, ap->a_fcnp, tdvp, NCPNULL, tvp, ap->a_tcnp));
1460
1461         /*
1462          * Error.  We still have to release / vput the various elements.
1463          */
1464
1465 bad:
1466         vrele(fdvp);
1467         if (fvp)
1468                 vrele(fvp);
1469         vput(tdvp);
1470         if (tvp != NULLVP) {
1471                 if (tvp != tdvp)
1472                         vput(tvp);
1473                 else
1474                         vrele(tvp);
1475         }
1476         return (error);
1477 }
1478
1479 /*
1480  * union_mkdir(struct vnode *a_dvp, struct vnode **a_vpp,
1481  *              struct componentname *a_cnp, struct vattr *a_vap)
1482  */
1483 static int
1484 union_mkdir(struct vop_mkdir_args *ap)
1485 {
1486         struct union_node *dun = VTOUNION(ap->a_dvp);
1487         struct componentname *cnp = ap->a_cnp;
1488         struct thread *td = cnp->cn_td;
1489         struct vnode *upperdvp;
1490         int error = EROFS;
1491
1492         if ((upperdvp = union_lock_upper(dun, td)) != NULLVP) {
1493                 struct vnode *vp;
1494
1495                 error = VOP_MKDIR(upperdvp, NCPNULL, &vp, cnp, ap->a_vap);
1496                 union_unlock_upper(upperdvp, td);
1497
1498                 if (error == 0) {
1499                         VOP_UNLOCK(vp, NULL, 0, td);
1500                         UDEBUG(("ALLOCVP-2 FROM %p REFS %d\n", vp, vp->v_usecount));
1501                         error = union_allocvp(ap->a_vpp, ap->a_dvp->v_mount,
1502                                 ap->a_dvp, NULLVP, cnp, vp, NULLVP, 1);
1503                         UDEBUG(("ALLOCVP-2B FROM %p REFS %d\n", *ap->a_vpp, vp->v_usecount));
1504                 }
1505         }
1506         return (error);
1507 }
1508
1509 /*
1510  * union_rmdir(struct vnode *a_dvp, struct vnode *a_vp,
1511  *              struct componentname *a_cnp)
1512  */
1513 static int
1514 union_rmdir(struct vop_rmdir_args *ap)
1515 {
1516         struct union_node *dun = VTOUNION(ap->a_dvp);
1517         struct union_node *un = VTOUNION(ap->a_vp);
1518         struct componentname *cnp = ap->a_cnp;
1519         struct thread *td = cnp->cn_td;
1520         struct vnode *upperdvp;
1521         struct vnode *uppervp;
1522         int error;
1523
1524         if ((upperdvp = union_lock_upper(dun, td)) == NULLVP)
1525                 panic("union rmdir: null upper vnode");
1526
1527         if ((uppervp = union_lock_upper(un, td)) != NULLVP) {
1528                 if (union_dowhiteout(un, cnp->cn_cred, td))
1529                         cnp->cn_flags |= CNP_DOWHITEOUT;
1530                 error = VOP_RMDIR(upperdvp, NCPNULL, uppervp, ap->a_cnp);
1531                 union_unlock_upper(uppervp, td);
1532         } else {
1533                 error = union_mkwhiteout(
1534                             MOUNTTOUNIONMOUNT(ap->a_dvp->v_mount),
1535                             dun->un_uppervp, ap->a_cnp, un->un_path);
1536         }
1537         union_unlock_upper(upperdvp, td);
1538         return (error);
1539 }
1540
1541 /*
1542  *      union_symlink:
1543  *
1544  *      dvp is locked on entry and remains locked on return.  a_vpp is garbage
1545  *      (unused).
1546  *
1547  * union_symlink(struct vnode *a_dvp, struct vnode **a_vpp,
1548  *              struct componentname *a_cnp, struct vattr *a_vap,
1549  *              char *a_target)
1550  */
1551 static int
1552 union_symlink(struct vop_symlink_args *ap)
1553 {
1554         struct union_node *dun = VTOUNION(ap->a_dvp);
1555         struct componentname *cnp = ap->a_cnp;
1556         struct thread *td = cnp->cn_td;
1557         struct vnode *dvp;
1558         int error = EROFS;
1559
1560         if ((dvp = union_lock_upper(dun, td)) != NULLVP) {
1561                 error = VOP_SYMLINK(dvp, NCPNULL, ap->a_vpp, cnp, ap->a_vap,
1562                             ap->a_target);
1563                 union_unlock_upper(dvp, td);
1564         }
1565         return (error);
1566 }
1567
1568 /*
1569  * union_readdir works in concert with getdirentries and
1570  * readdir(3) to provide a list of entries in the unioned
1571  * directories.  getdirentries is responsible for walking
1572  * down the union stack.  readdir(3) is responsible for
1573  * eliminating duplicate names from the returned data stream.
1574  *
1575  * union_readdir(struct vnode *a_vp, struct uio *a_uio, struct ucred *a_cred,
1576  *               int *a_eofflag, u_long *a_cookies, int a_ncookies)
1577  */
1578 static int
1579 union_readdir(struct vop_readdir_args *ap)
1580 {
1581         struct union_node *un = VTOUNION(ap->a_vp);
1582         struct thread *td = ap->a_uio->uio_td;
1583         struct vnode *uvp;
1584         int error = 0;
1585
1586         if ((uvp = union_lock_upper(un, td)) != NULLVP) {
1587                 ap->a_head.a_ops = uvp->v_ops;
1588                 ap->a_vp = uvp;
1589                 error = vop_readdir_ap(ap);
1590                 union_unlock_upper(uvp, td);
1591         }
1592         return(error);
1593 }
1594
1595 /*
1596  * union_readlink(struct vnode *a_vp, struct uio *a_uio, struct ucred *a_cred)
1597  */
1598 static int
1599 union_readlink(struct vop_readlink_args *ap)
1600 {
1601         int error;
1602         struct union_node *un = VTOUNION(ap->a_vp);
1603         struct uio *uio = ap->a_uio;
1604         struct thread *td = uio->uio_td;
1605         struct vnode *vp;
1606
1607         vp = union_lock_other(un, td);
1608         KASSERT(vp != NULL, ("union_readlink: backing vnode missing!"));
1609
1610         ap->a_head.a_ops = vp->v_ops;
1611         ap->a_vp = vp;
1612         error = vop_readlink_ap(ap);
1613         union_unlock_other(vp, td);
1614
1615         return (error);
1616 }
1617
1618 /*
1619  *      union_inactive:
1620  *
1621  *      Called with the vnode locked.  We are expected to unlock the vnode.
1622  *
1623  * union_inactive(struct vnode *a_vp, struct thread *a_td)
1624  */
1625 static int
1626 union_inactive(struct vop_inactive_args *ap)
1627 {
1628         struct vnode *vp = ap->a_vp;
1629         struct thread *td = ap->a_td;
1630         struct union_node *un = VTOUNION(vp);
1631         struct vnode **vpp;
1632
1633         /*
1634          * Do nothing (and _don't_ bypass).
1635          * Wait to vrele lowervp until reclaim,
1636          * so that until then our union_node is in the
1637          * cache and reusable.
1638          *
1639          * NEEDSWORK: Someday, consider inactive'ing
1640          * the lowervp and then trying to reactivate it
1641          * with capabilities (v_id)
1642          * like they do in the name lookup cache code.
1643          * That's too much work for now.
1644          */
1645
1646         if (un->un_dircache != 0) {
1647                 for (vpp = un->un_dircache; *vpp != NULLVP; vpp++)
1648                         vrele(*vpp);
1649                 free (un->un_dircache, M_TEMP);
1650                 un->un_dircache = 0;
1651         }
1652
1653 #if 0
1654         if ((un->un_flags & UN_ULOCK) && un->un_uppervp) {
1655                 un->un_flags &= ~UN_ULOCK;
1656                 VOP_UNLOCK(un->un_uppervp, NULL, 0, td);
1657         }
1658 #endif
1659
1660         VOP_UNLOCK(vp, NULL, 0, td);
1661
1662         if ((un->un_flags & UN_CACHED) == 0)
1663                 vgone(vp);
1664
1665         return (0);
1666 }
1667
1668 /*
1669  * union_reclaim(struct vnode *a_vp)
1670  */
1671 static int
1672 union_reclaim(struct vop_reclaim_args *ap)
1673 {
1674         union_freevp(ap->a_vp);
1675
1676         return (0);
1677 }
1678
1679 static int
1680 union_lock(struct vop_lock_args *ap)
1681 {
1682 #if 0
1683         struct vnode *vp = ap->a_vp;
1684         struct thread *td = ap->a_td;
1685         int flags = ap->a_flags;
1686         struct union_node *un;
1687 #endif
1688         int error;
1689
1690         error = vop_stdlock(ap);
1691 #if 0
1692         un = VTOUNION(vp);
1693
1694         if (error == 0) {
1695                 /*
1696                  * Lock the upper if it exists and this is an exclusive lock
1697                  * request.
1698                  */
1699                 if (un->un_uppervp != NULLVP && 
1700                     (flags & LK_TYPE_MASK) == LK_EXCLUSIVE) {
1701                         if ((un->un_flags & UN_ULOCK) == 0 && vp->v_usecount) {
1702                                 error = vn_lock(un->un_uppervp, ap->a_vlock,
1703                                                 flags, td);
1704                                 if (error) {
1705                                         struct vop_unlock_args uap = { 0 };
1706                                         uap.a_vp = ap->a_vp;
1707                                         uap.a_vlock = ap->a_vlock;
1708                                         uap.a_flags = ap->a_flags;
1709                                         uap.a_td = ap->a_td;
1710                                         vop_stdunlock(&uap);
1711                                         return (error);
1712                                 }
1713                                 un->un_flags |= UN_ULOCK;
1714                         }
1715                 }
1716         }
1717 #endif
1718         return (error);
1719 }
1720
1721 /*
1722  *      union_unlock:
1723  *
1724  *      Unlock our union node.  This also unlocks uppervp.  
1725  *
1726  * union_unlock(struct vnode *a_vp, lwkt_tokref_t a_vlock, int a_flags,
1727  *              struct thread *a_td)
1728  */
1729 static int
1730 union_unlock(struct vop_unlock_args *ap)
1731 {
1732         int error;
1733 #if 0
1734         struct union_node *un = VTOUNION(ap->a_vp);
1735
1736         KASSERT((un->un_uppervp == NULL || un->un_uppervp->v_usecount > 0), ("uppervp usecount is 0"));
1737 #endif
1738
1739         error = vop_stdunlock(ap);
1740 #if 0
1741
1742         /*
1743          * If no exclusive locks remain and we are holding an uppervp lock,
1744          * remove the uppervp lock.
1745          */
1746
1747         if ((un->un_flags & UN_ULOCK) && 
1748             lockstatus(&un->un_lock, NULL) != LK_EXCLUSIVE) {
1749                 un->un_flags &= ~UN_ULOCK;
1750                 VOP_UNLOCK(un->un_uppervp, NULL, LK_EXCLUSIVE, td);
1751         }
1752 #endif
1753         return(error);
1754 }
1755
1756 /*
1757  *      union_bmap:
1758  *
1759  *      There isn't much we can do.  We cannot push through to the real vnode
1760  *      to get to the underlying device because this will bypass data
1761  *      cached by the real vnode.
1762  *
1763  *      For some reason we cannot return the 'real' vnode either, it seems
1764  *      to blow up memory maps.
1765  *
1766  * union_bmap(struct vnode *a_vp, daddr_t a_bn, struct vnode **a_vpp,
1767  *            daddr_t *a_bnp, int *a_runp, int *a_runb)
1768  */
1769 static int
1770 union_bmap(struct vop_bmap_args *ap)
1771 {
1772         return(EOPNOTSUPP);
1773 }
1774
1775 /*
1776  * union_print(struct vnode *a_vp)
1777  */
1778 static int
1779 union_print(struct vop_print_args *ap)
1780 {
1781         struct vnode *vp = ap->a_vp;
1782
1783         printf("\ttag VT_UNION, vp=%p, uppervp=%p, lowervp=%p\n",
1784                         vp, UPPERVP(vp), LOWERVP(vp));
1785         if (UPPERVP(vp) != NULLVP)
1786                 vprint("union: upper", UPPERVP(vp));
1787         if (LOWERVP(vp) != NULLVP)
1788                 vprint("union: lower", LOWERVP(vp));
1789
1790         return (0);
1791 }
1792
1793 /*
1794  * union_pathconf(struct vnode *a_vp, int a_name, int *a_retval)
1795  */
1796 static int
1797 union_pathconf(struct vop_pathconf_args *ap)
1798 {
1799         int error;
1800         struct thread *td = curthread;          /* XXX */
1801         struct union_node *un = VTOUNION(ap->a_vp);
1802         struct vnode *vp;
1803
1804         vp = union_lock_other(un, td);
1805         KASSERT(vp != NULL, ("union_pathconf: backing vnode missing!"));
1806
1807         ap->a_head.a_ops = vp->v_ops;
1808         ap->a_vp = vp;
1809         error = vop_pathconf_ap(ap);
1810         union_unlock_other(vp, td);
1811
1812         return (error);
1813 }
1814
1815 /*
1816  * union_advlock(struct vnode *a_vp, caddr_t a_id, int a_op,
1817  *               struct flock *a_fl, int a_flags)
1818  */
1819 static int
1820 union_advlock(struct vop_advlock_args *ap)
1821 {
1822         struct vnode *ovp = OTHERVP(ap->a_vp);
1823
1824         ap->a_head.a_ops = ovp->v_ops;
1825         ap->a_vp = ovp;
1826         return (vop_advlock_ap(ap));
1827 }
1828
1829
1830 /*
1831  * XXX - vop_strategy must be hand coded because it has no
1832  * YYY - and it is not coherent with anything
1833  *
1834  * vnode in its arguments.
1835  * This goes away with a merged VM/buffer cache.
1836  *
1837  * union_strategy(struct vnode *a_vp, struct buf *a_bp)
1838  */
1839 static int
1840 union_strategy(struct vop_strategy_args *ap)
1841 {
1842         struct buf *bp = ap->a_bp;
1843         struct vnode *othervp = OTHERVP(bp->b_vp);
1844
1845 #ifdef DIAGNOSTIC
1846         if (othervp == NULLVP)
1847                 panic("union_strategy: nil vp");
1848         if (((bp->b_flags & B_READ) == 0) &&
1849             (othervp == LOWERVP(bp->b_vp)))
1850                 panic("union_strategy: writing to lowervp");
1851 #endif
1852         return (VOP_STRATEGY(othervp, bp));
1853 }
1854
1855 /*
1856  * Global vfs data structures
1857  */
1858 struct vnodeopv_entry_desc union_vnodeop_entries[] = {
1859         { &vop_default_desc,            vop_defaultop },
1860         { &vop_access_desc,             (void *) union_access },
1861         { &vop_advlock_desc,            (void *) union_advlock },
1862         { &vop_bmap_desc,               (void *) union_bmap },
1863         { &vop_close_desc,              (void *) union_close },
1864         { &vop_create_desc,             (void *) union_create },
1865         { &vop_fsync_desc,              (void *) union_fsync },
1866         { &vop_getpages_desc,           (void *) union_getpages },
1867         { &vop_putpages_desc,           (void *) union_putpages },
1868         { &vop_getattr_desc,            (void *) union_getattr },
1869         { &vop_inactive_desc,           (void *) union_inactive },
1870         { &vop_ioctl_desc,              (void *) union_ioctl },
1871         { &vop_islocked_desc,           (void *) vop_stdislocked },
1872         { &vop_lease_desc,              (void *) union_lease },
1873         { &vop_link_desc,               (void *) union_link },
1874         { &vop_lock_desc,               (void *) union_lock },
1875         { &vop_lookup_desc,             (void *) union_lookup },
1876         { &vop_mkdir_desc,              (void *) union_mkdir },
1877         { &vop_mknod_desc,              (void *) union_mknod },
1878         { &vop_mmap_desc,               (void *) union_mmap },
1879         { &vop_open_desc,               (void *) union_open },
1880         { &vop_pathconf_desc,           (void *) union_pathconf },
1881         { &vop_poll_desc,               (void *) union_poll },
1882         { &vop_print_desc,              (void *) union_print },
1883         { &vop_read_desc,               (void *) union_read },
1884         { &vop_readdir_desc,            (void *) union_readdir },
1885         { &vop_readlink_desc,           (void *) union_readlink },
1886         { &vop_reclaim_desc,            (void *) union_reclaim },
1887         { &vop_remove_desc,             (void *) union_remove },
1888         { &vop_rename_desc,             (void *) union_rename },
1889         { &vop_revoke_desc,             (void *) union_revoke },
1890         { &vop_rmdir_desc,              (void *) union_rmdir },
1891         { &vop_setattr_desc,            (void *) union_setattr },
1892         { &vop_strategy_desc,           (void *) union_strategy },
1893         { &vop_symlink_desc,            (void *) union_symlink },
1894         { &vop_unlock_desc,             (void *) union_unlock },
1895         { &vop_whiteout_desc,           (void *) union_whiteout },
1896         { &vop_write_desc,              (void *) union_write },
1897         { NULL, NULL }
1898 };
1899