0df7cc1f83d8cbdcc265fbf1d8a20a722bc7a860
[zfs.git] / module / zfs / zfs_dir.c
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23  */
24
25
26 #include <sys/types.h>
27 #include <sys/param.h>
28 #include <sys/time.h>
29 #include <sys/systm.h>
30 #include <sys/sysmacros.h>
31 #include <sys/resource.h>
32 #include <sys/vfs.h>
33 #include <sys/vnode.h>
34 #include <sys/file.h>
35 #include <sys/mode.h>
36 #include <sys/kmem.h>
37 #include <sys/uio.h>
38 #include <sys/pathname.h>
39 #include <sys/cmn_err.h>
40 #include <sys/errno.h>
41 #include <sys/stat.h>
42 #include <sys/unistd.h>
43 #include <sys/sunddi.h>
44 #include <sys/random.h>
45 #include <sys/policy.h>
46 #include <sys/zfs_dir.h>
47 #include <sys/zfs_acl.h>
48 #include <sys/fs/zfs.h>
49 #include "fs/fs_subr.h"
50 #include <sys/zap.h>
51 #include <sys/dmu.h>
52 #include <sys/atomic.h>
53 #include <sys/zfs_fuid.h>
54 #include <sys/sa.h>
55 #include <sys/zfs_sa.h>
56 #include <sys/dnlc.h>
57 #include <sys/extdirent.h>
58
59 /*
60  * zfs_match_find() is used by zfs_dirent_lock() to peform zap lookups
61  * of names after deciding which is the appropriate lookup interface.
62  */
63 static int
64 zfs_match_find(zfs_sb_t *zsb, znode_t *dzp, char *name, boolean_t exact,
65     boolean_t update, int *deflags, pathname_t *rpnp, uint64_t *zoid)
66 {
67         int error;
68
69         if (zsb->z_norm) {
70                 matchtype_t mt = MT_FIRST;
71                 boolean_t conflict = B_FALSE;
72                 size_t bufsz = 0;
73                 char *buf = NULL;
74
75                 if (rpnp) {
76                         buf = rpnp->pn_buf;
77                         bufsz = rpnp->pn_bufsize;
78                 }
79                 if (exact)
80                         mt = MT_EXACT;
81                 /*
82                  * In the non-mixed case we only expect there would ever
83                  * be one match, but we need to use the normalizing lookup.
84                  */
85                 error = zap_lookup_norm(zsb->z_os, dzp->z_id, name, 8, 1,
86                     zoid, mt, buf, bufsz, &conflict);
87                 if (!error && deflags)
88                         *deflags = conflict ? ED_CASE_CONFLICT : 0;
89         } else {
90                 error = zap_lookup(zsb->z_os, dzp->z_id, name, 8, 1, zoid);
91         }
92         *zoid = ZFS_DIRENT_OBJ(*zoid);
93
94 #ifdef HAVE_DNLC
95         if (error == ENOENT && update)
96                 dnlc_update(ZTOI(dzp), name, DNLC_NO_VNODE);
97 #endif /* HAVE_DNLC */
98
99         return (error);
100 }
101
102 /*
103  * Lock a directory entry.  A dirlock on <dzp, name> protects that name
104  * in dzp's directory zap object.  As long as you hold a dirlock, you can
105  * assume two things: (1) dzp cannot be reaped, and (2) no other thread
106  * can change the zap entry for (i.e. link or unlink) this name.
107  *
108  * Input arguments:
109  *      dzp     - znode for directory
110  *      name    - name of entry to lock
111  *      flag    - ZNEW: if the entry already exists, fail with EEXIST.
112  *                ZEXISTS: if the entry does not exist, fail with ENOENT.
113  *                ZSHARED: allow concurrent access with other ZSHARED callers.
114  *                ZXATTR: we want dzp's xattr directory
115  *                ZCILOOK: On a mixed sensitivity file system,
116  *                         this lookup should be case-insensitive.
117  *                ZCIEXACT: On a purely case-insensitive file system,
118  *                          this lookup should be case-sensitive.
119  *                ZRENAMING: we are locking for renaming, force narrow locks
120  *                ZHAVELOCK: Don't grab the z_name_lock for this call. The
121  *                           current thread already holds it.
122  *
123  * Output arguments:
124  *      zpp     - pointer to the znode for the entry (NULL if there isn't one)
125  *      dlpp    - pointer to the dirlock for this entry (NULL on error)
126  *      direntflags - (case-insensitive lookup only)
127  *              flags if multiple case-sensitive matches exist in directory
128  *      realpnp     - (case-insensitive lookup only)
129  *              actual name matched within the directory
130  *
131  * Return value: 0 on success or errno on failure.
132  *
133  * NOTE: Always checks for, and rejects, '.' and '..'.
134  * NOTE: For case-insensitive file systems we take wide locks (see below),
135  *       but return znode pointers to a single match.
136  */
137 int
138 zfs_dirent_lock(zfs_dirlock_t **dlpp, znode_t *dzp, char *name, znode_t **zpp,
139     int flag, int *direntflags, pathname_t *realpnp)
140 {
141         zfs_sb_t        *zsb = ZTOZSB(dzp);
142         zfs_dirlock_t   *dl;
143         boolean_t       update;
144         boolean_t       exact;
145         uint64_t        zoid;
146 #ifdef HAVE_DNLC
147         vnode_t         *vp = NULL;
148 #endif /* HAVE_DNLC */
149         int             error = 0;
150         int             cmpflags;
151
152         *zpp = NULL;
153         *dlpp = NULL;
154
155         /*
156          * Verify that we are not trying to lock '.', '..', or '.zfs'
157          */
158         if ((name[0] == '.' &&
159             (name[1] == '\0' || (name[1] == '.' && name[2] == '\0'))) ||
160             (zfs_has_ctldir(dzp) && strcmp(name, ZFS_CTLDIR_NAME) == 0))
161                 return (EEXIST);
162
163         /*
164          * Case sensitivity and normalization preferences are set when
165          * the file system is created.  These are stored in the
166          * zsb->z_case and zsb->z_norm fields.  These choices
167          * affect what vnodes can be cached in the DNLC, how we
168          * perform zap lookups, and the "width" of our dirlocks.
169          *
170          * A normal dirlock locks a single name.  Note that with
171          * normalization a name can be composed multiple ways, but
172          * when normalized, these names all compare equal.  A wide
173          * dirlock locks multiple names.  We need these when the file
174          * system is supporting mixed-mode access.  It is sometimes
175          * necessary to lock all case permutations of file name at
176          * once so that simultaneous case-insensitive/case-sensitive
177          * behaves as rationally as possible.
178          */
179
180         /*
181          * Decide if exact matches should be requested when performing
182          * a zap lookup on file systems supporting case-insensitive
183          * access.
184          */
185         exact =
186             ((zsb->z_case == ZFS_CASE_INSENSITIVE) && (flag & ZCIEXACT)) ||
187             ((zsb->z_case == ZFS_CASE_MIXED) && !(flag & ZCILOOK));
188
189         /*
190          * Only look in or update the DNLC if we are looking for the
191          * name on a file system that does not require normalization
192          * or case folding.  We can also look there if we happen to be
193          * on a non-normalizing, mixed sensitivity file system IF we
194          * are looking for the exact name.
195          *
196          * Maybe can add TO-UPPERed version of name to dnlc in ci-only
197          * case for performance improvement?
198          */
199         update = !zsb->z_norm ||
200             ((zsb->z_case == ZFS_CASE_MIXED) &&
201             !(zsb->z_norm & ~U8_TEXTPREP_TOUPPER) && !(flag & ZCILOOK));
202
203         /*
204          * ZRENAMING indicates we are in a situation where we should
205          * take narrow locks regardless of the file system's
206          * preferences for normalizing and case folding.  This will
207          * prevent us deadlocking trying to grab the same wide lock
208          * twice if the two names happen to be case-insensitive
209          * matches.
210          */
211         if (flag & ZRENAMING)
212                 cmpflags = 0;
213         else
214                 cmpflags = zsb->z_norm;
215
216         /*
217          * Wait until there are no locks on this name.
218          *
219          * Don't grab the the lock if it is already held. However, cannot
220          * have both ZSHARED and ZHAVELOCK together.
221          */
222         ASSERT(!(flag & ZSHARED) || !(flag & ZHAVELOCK));
223         if (!(flag & ZHAVELOCK))
224                 rw_enter(&dzp->z_name_lock, RW_READER);
225
226         mutex_enter(&dzp->z_lock);
227         for (;;) {
228                 if (dzp->z_unlinked) {
229                         mutex_exit(&dzp->z_lock);
230                         if (!(flag & ZHAVELOCK))
231                                 rw_exit(&dzp->z_name_lock);
232                         return (ENOENT);
233                 }
234                 for (dl = dzp->z_dirlocks; dl != NULL; dl = dl->dl_next) {
235                         if ((u8_strcmp(name, dl->dl_name, 0, cmpflags,
236                             U8_UNICODE_LATEST, &error) == 0) || error != 0)
237                                 break;
238                 }
239                 if (error != 0) {
240                         mutex_exit(&dzp->z_lock);
241                         if (!(flag & ZHAVELOCK))
242                                 rw_exit(&dzp->z_name_lock);
243                         return (ENOENT);
244                 }
245                 if (dl == NULL) {
246                         /*
247                          * Allocate a new dirlock and add it to the list.
248                          */
249                         dl = kmem_alloc(sizeof (zfs_dirlock_t), KM_SLEEP);
250                         cv_init(&dl->dl_cv, NULL, CV_DEFAULT, NULL);
251                         dl->dl_name = name;
252                         dl->dl_sharecnt = 0;
253                         dl->dl_namelock = 0;
254                         dl->dl_namesize = 0;
255                         dl->dl_dzp = dzp;
256                         dl->dl_next = dzp->z_dirlocks;
257                         dzp->z_dirlocks = dl;
258                         break;
259                 }
260                 if ((flag & ZSHARED) && dl->dl_sharecnt != 0)
261                         break;
262                 cv_wait(&dl->dl_cv, &dzp->z_lock);
263         }
264
265         /*
266          * If the z_name_lock was NOT held for this dirlock record it.
267          */
268         if (flag & ZHAVELOCK)
269                 dl->dl_namelock = 1;
270
271         if ((flag & ZSHARED) && ++dl->dl_sharecnt > 1 && dl->dl_namesize == 0) {
272                 /*
273                  * We're the second shared reference to dl.  Make a copy of
274                  * dl_name in case the first thread goes away before we do.
275                  * Note that we initialize the new name before storing its
276                  * pointer into dl_name, because the first thread may load
277                  * dl->dl_name at any time.  He'll either see the old value,
278                  * which is his, or the new shared copy; either is OK.
279                  */
280                 dl->dl_namesize = strlen(dl->dl_name) + 1;
281                 name = kmem_alloc(dl->dl_namesize, KM_SLEEP);
282                 bcopy(dl->dl_name, name, dl->dl_namesize);
283                 dl->dl_name = name;
284         }
285
286         mutex_exit(&dzp->z_lock);
287
288         /*
289          * We have a dirlock on the name.  (Note that it is the dirlock,
290          * not the dzp's z_lock, that protects the name in the zap object.)
291          * See if there's an object by this name; if so, put a hold on it.
292          */
293         if (flag & ZXATTR) {
294                 error = sa_lookup(dzp->z_sa_hdl, SA_ZPL_XATTR(zsb), &zoid,
295                     sizeof (zoid));
296                 if (error == 0)
297                         error = (zoid == 0 ? ENOENT : 0);
298         } else {
299 #ifdef HAVE_DNLC
300                 if (update)
301                         vp = dnlc_lookup(ZTOI(dzp), name);
302                 if (vp == DNLC_NO_VNODE) {
303                         iput(vp);
304                         error = ENOENT;
305                 } else if (vp) {
306                         if (flag & ZNEW) {
307                                 zfs_dirent_unlock(dl);
308                                 iput(vp);
309                                 return (EEXIST);
310                         }
311                         *dlpp = dl;
312                         *zpp = VTOZ(vp);
313                         return (0);
314                 } else {
315                         error = zfs_match_find(zsb, dzp, name, exact,
316                             update, direntflags, realpnp, &zoid);
317                 }
318 #else
319                 error = zfs_match_find(zsb, dzp, name, exact,
320                     update, direntflags, realpnp, &zoid);
321 #endif /* HAVE_DNLC */
322         }
323         if (error) {
324                 if (error != ENOENT || (flag & ZEXISTS)) {
325                         zfs_dirent_unlock(dl);
326                         return (error);
327                 }
328         } else {
329                 if (flag & ZNEW) {
330                         zfs_dirent_unlock(dl);
331                         return (EEXIST);
332                 }
333                 error = zfs_zget(zsb, zoid, zpp);
334                 if (error) {
335                         zfs_dirent_unlock(dl);
336                         return (error);
337                 }
338 #ifdef HAVE_DNLC
339                 if (!(flag & ZXATTR) && update)
340                         dnlc_update(ZTOI(dzp), name, ZTOI(*zpp));
341 #endif /* HAVE_DNLC */
342         }
343
344         *dlpp = dl;
345
346         return (0);
347 }
348
349 /*
350  * Unlock this directory entry and wake anyone who was waiting for it.
351  */
352 void
353 zfs_dirent_unlock(zfs_dirlock_t *dl)
354 {
355         znode_t *dzp = dl->dl_dzp;
356         zfs_dirlock_t **prev_dl, *cur_dl;
357
358         mutex_enter(&dzp->z_lock);
359
360         if (!dl->dl_namelock)
361                 rw_exit(&dzp->z_name_lock);
362
363         if (dl->dl_sharecnt > 1) {
364                 dl->dl_sharecnt--;
365                 mutex_exit(&dzp->z_lock);
366                 return;
367         }
368         prev_dl = &dzp->z_dirlocks;
369         while ((cur_dl = *prev_dl) != dl)
370                 prev_dl = &cur_dl->dl_next;
371         *prev_dl = dl->dl_next;
372         cv_broadcast(&dl->dl_cv);
373         mutex_exit(&dzp->z_lock);
374
375         if (dl->dl_namesize != 0)
376                 kmem_free(dl->dl_name, dl->dl_namesize);
377         cv_destroy(&dl->dl_cv);
378         kmem_free(dl, sizeof (*dl));
379 }
380
381 /*
382  * Look up an entry in a directory.
383  *
384  * NOTE: '.' and '..' are handled as special cases because
385  *      no directory entries are actually stored for them.  If this is
386  *      the root of a filesystem, then '.zfs' is also treated as a
387  *      special pseudo-directory.
388  */
389 int
390 zfs_dirlook(znode_t *dzp, char *name, struct inode **ipp, int flags,
391     int *deflg, pathname_t *rpnp)
392 {
393         zfs_dirlock_t *dl;
394         znode_t *zp;
395         int error = 0;
396         uint64_t parent;
397
398         if (name[0] == 0 || (name[0] == '.' && name[1] == 0)) {
399                 *ipp = ZTOI(dzp);
400                 igrab(*ipp);
401         } else if (name[0] == '.' && name[1] == '.' && name[2] == 0) {
402                 zfs_sb_t *zsb = ZTOZSB(dzp);
403
404                 /*
405                  * If we are a snapshot mounted under .zfs, return
406                  * the vp for the snapshot directory.
407                  */
408                 if ((error = sa_lookup(dzp->z_sa_hdl,
409                     SA_ZPL_PARENT(zsb), &parent, sizeof (parent))) != 0)
410                         return (error);
411 #ifdef HAVE_SNAPSHOT
412                 if (parent == dzp->z_id && zsb->z_parent != zsb) {
413                         error = zfsctl_root_lookup(zsb->z_parent->z_ctldir,
414                             "snapshot", ipp, NULL, 0, NULL, kcred,
415                             NULL, NULL, NULL);
416                         return (error);
417                 }
418 #endif /* HAVE_SNAPSHOT */
419                 rw_enter(&dzp->z_parent_lock, RW_READER);
420                 error = zfs_zget(zsb, parent, &zp);
421                 if (error == 0)
422                         *ipp = ZTOI(zp);
423                 rw_exit(&dzp->z_parent_lock);
424 #ifdef HAVE_SNAPSHOT
425         } else if (zfs_has_ctldir(dzp) && strcmp(name, ZFS_CTLDIR_NAME) == 0) {
426                 *ipp = zfsctl_root(dzp);
427 #endif /* HAVE_SNAPSHOT */
428         } else {
429                 int zf;
430
431                 zf = ZEXISTS | ZSHARED;
432                 if (flags & FIGNORECASE)
433                         zf |= ZCILOOK;
434
435                 error = zfs_dirent_lock(&dl, dzp, name, &zp, zf, deflg, rpnp);
436                 if (error == 0) {
437                         *ipp = ZTOI(zp);
438                         zfs_dirent_unlock(dl);
439                         dzp->z_zn_prefetch = B_TRUE; /* enable prefetching */
440                 }
441                 rpnp = NULL;
442         }
443
444         if ((flags & FIGNORECASE) && rpnp && !error)
445                 (void) strlcpy(rpnp->pn_buf, name, rpnp->pn_bufsize);
446
447         return (error);
448 }
449
450 /*
451  * unlinked Set (formerly known as the "delete queue") Error Handling
452  *
453  * When dealing with the unlinked set, we dmu_tx_hold_zap(), but we
454  * don't specify the name of the entry that we will be manipulating.  We
455  * also fib and say that we won't be adding any new entries to the
456  * unlinked set, even though we might (this is to lower the minimum file
457  * size that can be deleted in a full filesystem).  So on the small
458  * chance that the nlink list is using a fat zap (ie. has more than
459  * 2000 entries), we *may* not pre-read a block that's needed.
460  * Therefore it is remotely possible for some of the assertions
461  * regarding the unlinked set below to fail due to i/o error.  On a
462  * nondebug system, this will result in the space being leaked.
463  */
464 void
465 zfs_unlinked_add(znode_t *zp, dmu_tx_t *tx)
466 {
467         zfs_sb_t *zsb = ZTOZSB(zp);
468
469         ASSERT(zp->z_unlinked);
470         ASSERT(zp->z_links == 0);
471
472         VERIFY3U(0, ==,
473             zap_add_int(zsb->z_os, zsb->z_unlinkedobj, zp->z_id, tx));
474 }
475
476 /*
477  * Delete the entire contents of a directory.  Return a count
478  * of the number of entries that could not be deleted. If we encounter
479  * an error, return a count of at least one so that the directory stays
480  * in the unlinked set.
481  *
482  * NOTE: this function assumes that the directory is inactive,
483  *      so there is no need to lock its entries before deletion.
484  *      Also, it assumes the directory contents is *only* regular
485  *      files.
486  */
487 static int
488 zfs_purgedir(znode_t *dzp)
489 {
490         zap_cursor_t    zc;
491         zap_attribute_t zap;
492         znode_t         *xzp;
493         dmu_tx_t        *tx;
494         zfs_sb_t        *zsb = ZTOZSB(dzp);
495         zfs_dirlock_t   dl;
496         int skipped = 0;
497         int error;
498
499         for (zap_cursor_init(&zc, zsb->z_os, dzp->z_id);
500             (error = zap_cursor_retrieve(&zc, &zap)) == 0;
501             zap_cursor_advance(&zc)) {
502                 error = zfs_zget(zsb,
503                     ZFS_DIRENT_OBJ(zap.za_first_integer), &xzp);
504                 if (error) {
505                         skipped += 1;
506                         continue;
507                 }
508
509                 ASSERT(S_ISREG(ZTOI(xzp)->i_mode)||S_ISLNK(ZTOI(xzp)->i_mode));
510
511                 tx = dmu_tx_create(zsb->z_os);
512                 dmu_tx_hold_sa(tx, dzp->z_sa_hdl, B_FALSE);
513                 dmu_tx_hold_zap(tx, dzp->z_id, FALSE, zap.za_name);
514                 dmu_tx_hold_sa(tx, xzp->z_sa_hdl, B_FALSE);
515                 dmu_tx_hold_zap(tx, zsb->z_unlinkedobj, FALSE, NULL);
516                 /* Is this really needed ? */
517                 zfs_sa_upgrade_txholds(tx, xzp);
518                 error = dmu_tx_assign(tx, TXG_WAIT);
519                 if (error) {
520                         dmu_tx_abort(tx);
521                         iput(ZTOI(xzp));
522                         skipped += 1;
523                         continue;
524                 }
525                 bzero(&dl, sizeof (dl));
526                 dl.dl_dzp = dzp;
527                 dl.dl_name = zap.za_name;
528
529                 error = zfs_link_destroy(&dl, xzp, tx, 0, NULL);
530                 if (error)
531                         skipped += 1;
532                 dmu_tx_commit(tx);
533
534                 iput(ZTOI(xzp));
535         }
536         zap_cursor_fini(&zc);
537         if (error != ENOENT)
538                 skipped += 1;
539         return (skipped);
540 }
541
542 /*
543  * Clean up any znodes that had no links when we either crashed or
544  * (force) umounted the file system.
545  */
546 void
547 zfs_unlinked_drain(zfs_sb_t *zsb)
548 {
549         zap_cursor_t    zc;
550         zap_attribute_t zap;
551         dmu_object_info_t doi;
552         znode_t         *zp;
553         int             error;
554
555         /*
556          * Interate over the contents of the unlinked set.
557          */
558         for (zap_cursor_init(&zc, zsb->z_os, zsb->z_unlinkedobj);
559             zap_cursor_retrieve(&zc, &zap) == 0;
560             zap_cursor_advance(&zc)) {
561
562                 /*
563                  * See what kind of object we have in list
564                  */
565
566                 error = dmu_object_info(zsb->z_os, zap.za_first_integer, &doi);
567                 if (error != 0)
568                         continue;
569
570                 ASSERT((doi.doi_type == DMU_OT_PLAIN_FILE_CONTENTS) ||
571                     (doi.doi_type == DMU_OT_DIRECTORY_CONTENTS));
572                 /*
573                  * We need to re-mark these list entries for deletion,
574                  * so we pull them back into core and set zp->z_unlinked.
575                  */
576                 error = zfs_zget(zsb, zap.za_first_integer, &zp);
577
578                 /*
579                  * We may pick up znodes that are already marked for deletion.
580                  * This could happen during the purge of an extended attribute
581                  * directory.  All we need to do is skip over them, since they
582                  * are already in the system marked z_unlinked.
583                  */
584                 if (error != 0)
585                         continue;
586
587                 zp->z_unlinked = B_TRUE;
588
589                 /*
590                  * If this is an attribute directory, purge its contents.
591                  */
592                 if (S_ISDIR(ZTOI(zp)->i_mode) && (zp->z_pflags & ZFS_XATTR)) {
593                         /*
594                          * We don't need to check the return value of
595                          * zfs_purgedir here, because zfs_rmnode will just
596                          * return this xattr directory to the unlinked set
597                          * until all of its xattrs are gone.
598                          */
599                         (void) zfs_purgedir(zp);
600                 }
601
602                 iput(ZTOI(zp));
603         }
604         zap_cursor_fini(&zc);
605 }
606
607 void
608 zfs_rmnode(znode_t *zp)
609 {
610         zfs_sb_t        *zsb = ZTOZSB(zp);
611         objset_t        *os = zsb->z_os;
612         znode_t         *xzp = NULL;
613         dmu_tx_t        *tx;
614         uint64_t        acl_obj;
615         uint64_t        xattr_obj;
616         uint64_t        count;
617         int             error;
618
619         ASSERT(zp->z_links == 0);
620         ASSERT(atomic_read(&ZTOI(zp)->i_count) == 0);
621
622         /*
623          * If this is an attribute directory, purge its contents.
624          */
625         if (S_ISDIR(ZTOI(zp)->i_mode) && (zp->z_pflags & ZFS_XATTR)) {
626                 error = zap_count(os, zp->z_id, &count);
627                 if (error) {
628                         zfs_znode_dmu_fini(zp);
629                         return;
630                 }
631
632                 if (count > 0) {
633                         taskq_t *taskq;
634
635                         /*
636                          * There are still directory entries in this xattr
637                          * directory.  Let zfs_unlinked_drain() deal with
638                          * them to avoid deadlocking this process in the
639                          * zfs_purgedir()->zfs_zget()->ilookup() callpath
640                          * on the xattr inode's I_FREEING bit.
641                          */
642                         taskq = dsl_pool_iput_taskq(dmu_objset_pool(os));
643                         taskq_dispatch(taskq, (task_func_t *)
644                             zfs_unlinked_drain, zsb, TQ_SLEEP);
645
646                         zfs_znode_dmu_fini(zp);
647                         return;
648                 }
649         }
650
651         /*
652          * Free up all the data in the file.
653          */
654         error = dmu_free_long_range(os, zp->z_id, 0, DMU_OBJECT_END);
655         if (error) {
656                 /*
657                  * Not enough space.  Leave the file in the unlinked set.
658                  */
659                 zfs_znode_dmu_fini(zp);
660                 return;
661         }
662
663         /*
664          * If the file has extended attributes, we're going to unlink
665          * the xattr dir.
666          */
667         error = sa_lookup(zp->z_sa_hdl, SA_ZPL_XATTR(zsb),
668             &xattr_obj, sizeof (xattr_obj));
669         if (error == 0 && xattr_obj) {
670                 error = zfs_zget(zsb, xattr_obj, &xzp);
671                 ASSERT(error == 0);
672         }
673
674         acl_obj = zfs_external_acl(zp);
675
676         /*
677          * Set up the final transaction.
678          */
679         tx = dmu_tx_create(os);
680         dmu_tx_hold_free(tx, zp->z_id, 0, DMU_OBJECT_END);
681         dmu_tx_hold_zap(tx, zsb->z_unlinkedobj, FALSE, NULL);
682         if (xzp) {
683                 dmu_tx_hold_zap(tx, zsb->z_unlinkedobj, TRUE, NULL);
684                 dmu_tx_hold_sa(tx, xzp->z_sa_hdl, B_FALSE);
685         }
686         if (acl_obj)
687                 dmu_tx_hold_free(tx, acl_obj, 0, DMU_OBJECT_END);
688
689         zfs_sa_upgrade_txholds(tx, zp);
690         error = dmu_tx_assign(tx, TXG_WAIT);
691         if (error) {
692                 /*
693                  * Not enough space to delete the file.  Leave it in the
694                  * unlinked set, leaking it until the fs is remounted (at
695                  * which point we'll call zfs_unlinked_drain() to process it).
696                  */
697                 dmu_tx_abort(tx);
698                 zfs_znode_dmu_fini(zp);
699                 goto out;
700         }
701
702         if (xzp) {
703                 ASSERT(error == 0);
704                 mutex_enter(&xzp->z_lock);
705                 xzp->z_unlinked = B_TRUE;       /* mark xzp for deletion */
706                 xzp->z_links = 0;       /* no more links to it */
707                 VERIFY(0 == sa_update(xzp->z_sa_hdl, SA_ZPL_LINKS(zsb),
708                     &xzp->z_links, sizeof (xzp->z_links), tx));
709                 mutex_exit(&xzp->z_lock);
710                 zfs_unlinked_add(xzp, tx);
711         }
712
713         /* Remove this znode from the unlinked set */
714         VERIFY3U(0, ==,
715             zap_remove_int(zsb->z_os, zsb->z_unlinkedobj, zp->z_id, tx));
716
717         zfs_znode_delete(zp, tx);
718
719         dmu_tx_commit(tx);
720 out:
721         if (xzp)
722                 iput(ZTOI(xzp));
723 }
724
725 static uint64_t
726 zfs_dirent(znode_t *zp, uint64_t mode)
727 {
728         uint64_t de = zp->z_id;
729
730         if (ZTOZSB(zp)->z_version >= ZPL_VERSION_DIRENT_TYPE)
731                 de |= IFTODT(mode) << 60;
732         return (de);
733 }
734
735 /*
736  * Link zp into dl.  Can only fail if zp has been unlinked.
737  */
738 int
739 zfs_link_create(zfs_dirlock_t *dl, znode_t *zp, dmu_tx_t *tx, int flag)
740 {
741         znode_t *dzp = dl->dl_dzp;
742         zfs_sb_t *zsb = ZTOZSB(zp);
743         uint64_t value;
744         int zp_is_dir = S_ISDIR(ZTOI(zp)->i_mode);
745         sa_bulk_attr_t bulk[5];
746         uint64_t mtime[2], ctime[2];
747         int count = 0;
748         int error;
749
750         mutex_enter(&zp->z_lock);
751
752         if (!(flag & ZRENAMING)) {
753                 if (zp->z_unlinked) {   /* no new links to unlinked zp */
754                         ASSERT(!(flag & (ZNEW | ZEXISTS)));
755                         mutex_exit(&zp->z_lock);
756                         return (ENOENT);
757                 }
758                 zp->z_links++;
759                 SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_LINKS(zsb), NULL,
760                     &zp->z_links, sizeof (zp->z_links));
761
762         }
763         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_PARENT(zsb), NULL,
764             &dzp->z_id, sizeof (dzp->z_id));
765         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_FLAGS(zsb), NULL,
766             &zp->z_pflags, sizeof (zp->z_pflags));
767
768         if (!(flag & ZNEW)) {
769                 SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_CTIME(zsb), NULL,
770                     ctime, sizeof (ctime));
771                 zfs_tstamp_update_setup(zp, STATE_CHANGED, mtime,
772                     ctime, B_TRUE);
773         }
774         error = sa_bulk_update(zp->z_sa_hdl, bulk, count, tx);
775         ASSERT(error == 0);
776
777         mutex_exit(&zp->z_lock);
778
779         mutex_enter(&dzp->z_lock);
780         dzp->z_size++;
781         dzp->z_links += zp_is_dir;
782         count = 0;
783         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_SIZE(zsb), NULL,
784             &dzp->z_size, sizeof (dzp->z_size));
785         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_LINKS(zsb), NULL,
786             &dzp->z_links, sizeof (dzp->z_links));
787         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_MTIME(zsb), NULL,
788             mtime, sizeof (mtime));
789         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_CTIME(zsb), NULL,
790             ctime, sizeof (ctime));
791         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_FLAGS(zsb), NULL,
792             &dzp->z_pflags, sizeof (dzp->z_pflags));
793         zfs_tstamp_update_setup(dzp, CONTENT_MODIFIED, mtime, ctime, B_TRUE);
794         error = sa_bulk_update(dzp->z_sa_hdl, bulk, count, tx);
795         ASSERT(error == 0);
796         mutex_exit(&dzp->z_lock);
797
798         value = zfs_dirent(zp, zp->z_mode);
799         error = zap_add(ZTOZSB(zp)->z_os, dzp->z_id, dl->dl_name,
800             8, 1, &value, tx);
801         ASSERT(error == 0);
802
803         return (0);
804 }
805
806 static int
807 zfs_dropname(zfs_dirlock_t *dl, znode_t *zp, znode_t *dzp, dmu_tx_t *tx,
808     int flag)
809 {
810         int error;
811
812         if (ZTOZSB(zp)->z_norm) {
813                 if (((ZTOZSB(zp)->z_case == ZFS_CASE_INSENSITIVE) &&
814                     (flag & ZCIEXACT)) ||
815                     ((ZTOZSB(zp)->z_case == ZFS_CASE_MIXED) &&
816                     !(flag & ZCILOOK)))
817                         error = zap_remove_norm(ZTOZSB(zp)->z_os,
818                             dzp->z_id, dl->dl_name, MT_EXACT, tx);
819                 else
820                         error = zap_remove_norm(ZTOZSB(zp)->z_os,
821                             dzp->z_id, dl->dl_name, MT_FIRST, tx);
822         } else {
823                 error = zap_remove(ZTOZSB(zp)->z_os,
824                     dzp->z_id, dl->dl_name, tx);
825         }
826
827         return (error);
828 }
829
830 /*
831  * Unlink zp from dl, and mark zp for deletion if this was the last link.
832  * Can fail if zp is a mount point (EBUSY) or a non-empty directory (EEXIST).
833  * If 'unlinkedp' is NULL, we put unlinked znodes on the unlinked list.
834  * If it's non-NULL, we use it to indicate whether the znode needs deletion,
835  * and it's the caller's job to do it.
836  */
837 int
838 zfs_link_destroy(zfs_dirlock_t *dl, znode_t *zp, dmu_tx_t *tx, int flag,
839         boolean_t *unlinkedp)
840 {
841         znode_t *dzp = dl->dl_dzp;
842         zfs_sb_t *zsb = ZTOZSB(dzp);
843         int zp_is_dir = S_ISDIR(ZTOI(zp)->i_mode);
844         boolean_t unlinked = B_FALSE;
845         sa_bulk_attr_t bulk[5];
846         uint64_t mtime[2], ctime[2];
847         int count = 0;
848         int error;
849
850 #ifdef HAVE_DNLC
851         dnlc_remove(ZTOI(dzp), dl->dl_name);
852 #endif /* HAVE_DNLC */
853
854         if (!(flag & ZRENAMING)) {
855                 mutex_enter(&zp->z_lock);
856
857                 if (zp_is_dir && !zfs_dirempty(zp)) {
858                         mutex_exit(&zp->z_lock);
859                         return (EEXIST);
860                 }
861
862                 /*
863                  * If we get here, we are going to try to remove the object.
864                  * First try removing the name from the directory; if that
865                  * fails, return the error.
866                  */
867                 error = zfs_dropname(dl, zp, dzp, tx, flag);
868                 if (error != 0) {
869                         mutex_exit(&zp->z_lock);
870                         return (error);
871                 }
872
873                 if (zp->z_links <= zp_is_dir) {
874                         zfs_panic_recover("zfs: link count on %lu is %u, "
875                             "should be at least %u", zp->z_id,
876                             (int)zp->z_links, zp_is_dir + 1);
877                         zp->z_links = zp_is_dir + 1;
878                 }
879                 if (--zp->z_links == zp_is_dir) {
880                         zp->z_unlinked = B_TRUE;
881                         zp->z_links = 0;
882                         unlinked = B_TRUE;
883                 } else {
884                         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_CTIME(zsb),
885                             NULL, &ctime, sizeof (ctime));
886                         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_FLAGS(zsb),
887                             NULL, &zp->z_pflags, sizeof (zp->z_pflags));
888                         zfs_tstamp_update_setup(zp, STATE_CHANGED, mtime, ctime,
889                             B_TRUE);
890                 }
891                 SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_LINKS(zsb),
892                     NULL, &zp->z_links, sizeof (zp->z_links));
893                 error = sa_bulk_update(zp->z_sa_hdl, bulk, count, tx);
894                 count = 0;
895                 ASSERT(error == 0);
896                 mutex_exit(&zp->z_lock);
897         } else {
898                 error = zfs_dropname(dl, zp, dzp, tx, flag);
899                 if (error != 0)
900                         return (error);
901         }
902
903         mutex_enter(&dzp->z_lock);
904         dzp->z_size--;          /* one dirent removed */
905         dzp->z_links -= zp_is_dir;      /* ".." link from zp */
906         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_LINKS(zsb),
907             NULL, &dzp->z_links, sizeof (dzp->z_links));
908         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_SIZE(zsb),
909             NULL, &dzp->z_size, sizeof (dzp->z_size));
910         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_CTIME(zsb),
911             NULL, ctime, sizeof (ctime));
912         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_MTIME(zsb),
913             NULL, mtime, sizeof (mtime));
914         SA_ADD_BULK_ATTR(bulk, count, SA_ZPL_FLAGS(zsb),
915             NULL, &dzp->z_pflags, sizeof (dzp->z_pflags));
916         zfs_tstamp_update_setup(dzp, CONTENT_MODIFIED, mtime, ctime, B_TRUE);
917         error = sa_bulk_update(dzp->z_sa_hdl, bulk, count, tx);
918         ASSERT(error == 0);
919         mutex_exit(&dzp->z_lock);
920
921         if (unlinkedp != NULL)
922                 *unlinkedp = unlinked;
923         else if (unlinked)
924                 zfs_unlinked_add(zp, tx);
925
926         return (0);
927 }
928
929 /*
930  * Indicate whether the directory is empty.  Works with or without z_lock
931  * held, but can only be consider a hint in the latter case.  Returns true
932  * if only "." and ".." remain and there's no work in progress.
933  */
934 boolean_t
935 zfs_dirempty(znode_t *dzp)
936 {
937         return (dzp->z_size == 2 && dzp->z_dirlocks == 0);
938 }
939
940 int
941 zfs_make_xattrdir(znode_t *zp, vattr_t *vap, struct inode **xipp, cred_t *cr)
942 {
943         zfs_sb_t *zsb = ZTOZSB(zp);
944         znode_t *xzp;
945         dmu_tx_t *tx;
946         int error;
947         zfs_acl_ids_t acl_ids;
948         boolean_t fuid_dirtied;
949 #ifdef DEBUG
950         uint64_t parent;
951 #endif
952
953         *xipp = NULL;
954
955         if ((error = zfs_zaccess(zp, ACE_WRITE_NAMED_ATTRS, 0, B_FALSE, cr)))
956                 return (error);
957
958         if ((error = zfs_acl_ids_create(zp, IS_XATTR, vap, cr, NULL,
959             &acl_ids)) != 0)
960                 return (error);
961         if (zfs_acl_ids_overquota(zsb, &acl_ids)) {
962                 zfs_acl_ids_free(&acl_ids);
963                 return (EDQUOT);
964         }
965
966 top:
967         tx = dmu_tx_create(zsb->z_os);
968         dmu_tx_hold_sa_create(tx, acl_ids.z_aclp->z_acl_bytes +
969             ZFS_SA_BASE_ATTR_SIZE);
970         dmu_tx_hold_sa(tx, zp->z_sa_hdl, B_TRUE);
971         dmu_tx_hold_zap(tx, DMU_NEW_OBJECT, FALSE, NULL);
972         fuid_dirtied = zsb->z_fuid_dirty;
973         if (fuid_dirtied)
974                 zfs_fuid_txhold(zsb, tx);
975         error = dmu_tx_assign(tx, TXG_NOWAIT);
976         if (error) {
977                 if (error == ERESTART) {
978                         dmu_tx_wait(tx);
979                         dmu_tx_abort(tx);
980                         goto top;
981                 }
982                 zfs_acl_ids_free(&acl_ids);
983                 dmu_tx_abort(tx);
984                 return (error);
985         }
986         zfs_mknode(zp, vap, tx, cr, IS_XATTR, &xzp, &acl_ids);
987
988         if (fuid_dirtied)
989                 zfs_fuid_sync(zsb, tx);
990
991 #ifdef DEBUG
992         error = sa_lookup(xzp->z_sa_hdl, SA_ZPL_PARENT(zsb),
993             &parent, sizeof (parent));
994         ASSERT(error == 0 && parent == zp->z_id);
995 #endif
996
997         VERIFY(0 == sa_update(zp->z_sa_hdl, SA_ZPL_XATTR(zsb), &xzp->z_id,
998             sizeof (xzp->z_id), tx));
999
1000         (void) zfs_log_create(zsb->z_log, tx, TX_MKXATTR, zp,
1001             xzp, "", NULL, acl_ids.z_fuidp, vap);
1002
1003         zfs_acl_ids_free(&acl_ids);
1004         dmu_tx_commit(tx);
1005
1006         *xipp = ZTOI(xzp);
1007
1008         return (0);
1009 }
1010
1011 /*
1012  * Return a znode for the extended attribute directory for zp.
1013  * ** If the directory does not already exist, it is created **
1014  *
1015  *      IN:     zp      - znode to obtain attribute directory from
1016  *              cr      - credentials of caller
1017  *              flags   - flags from the VOP_LOOKUP call
1018  *
1019  *      OUT:    xipp    - pointer to extended attribute znode
1020  *
1021  *      RETURN: 0 on success
1022  *              error number on failure
1023  */
1024 int
1025 zfs_get_xattrdir(znode_t *zp, struct inode **xipp, cred_t *cr, int flags)
1026 {
1027         zfs_sb_t        *zsb = ZTOZSB(zp);
1028         znode_t         *xzp;
1029         zfs_dirlock_t   *dl;
1030         vattr_t         va;
1031         int             error;
1032 top:
1033         error = zfs_dirent_lock(&dl, zp, "", &xzp, ZXATTR, NULL, NULL);
1034         if (error)
1035                 return (error);
1036
1037         if (xzp != NULL) {
1038                 *xipp = ZTOI(xzp);
1039                 zfs_dirent_unlock(dl);
1040                 return (0);
1041         }
1042
1043         if (!(flags & CREATE_XATTR_DIR)) {
1044                 zfs_dirent_unlock(dl);
1045                 return (ENOENT);
1046         }
1047
1048         if (zsb->z_vfs->mnt_flags & MNT_READONLY) {
1049                 zfs_dirent_unlock(dl);
1050                 return (EROFS);
1051         }
1052
1053         /*
1054          * The ability to 'create' files in an attribute
1055          * directory comes from the write_xattr permission on the base file.
1056          *
1057          * The ability to 'search' an attribute directory requires
1058          * read_xattr permission on the base file.
1059          *
1060          * Once in a directory the ability to read/write attributes
1061          * is controlled by the permissions on the attribute file.
1062          */
1063         va.va_mask = ATTR_MODE | ATTR_UID | ATTR_GID;
1064         va.va_mode = S_IFDIR | S_ISVTX | 0777;
1065         zfs_fuid_map_ids(zp, cr, &va.va_uid, &va.va_gid);
1066
1067         va.va_dentry = NULL;
1068         error = zfs_make_xattrdir(zp, &va, xipp, cr);
1069         zfs_dirent_unlock(dl);
1070
1071         if (error == ERESTART) {
1072                 /* NB: we already did dmu_tx_wait() if necessary */
1073                 goto top;
1074         }
1075
1076         return (error);
1077 }
1078
1079 /*
1080  * Decide whether it is okay to remove within a sticky directory.
1081  *
1082  * In sticky directories, write access is not sufficient;
1083  * you can remove entries from a directory only if:
1084  *
1085  *      you own the directory,
1086  *      you own the entry,
1087  *      the entry is a plain file and you have write access,
1088  *      or you are privileged (checked in secpolicy...).
1089  *
1090  * The function returns 0 if remove access is granted.
1091  */
1092 int
1093 zfs_sticky_remove_access(znode_t *zdp, znode_t *zp, cred_t *cr)
1094 {
1095         uid_t           uid;
1096         uid_t           downer;
1097         uid_t           fowner;
1098         zfs_sb_t        *zsb = ZTOZSB(zdp);
1099
1100         if (zsb->z_replay)
1101                 return (0);
1102
1103         if ((zdp->z_mode & S_ISVTX) == 0)
1104                 return (0);
1105
1106         downer = zfs_fuid_map_id(zsb, zdp->z_uid, cr, ZFS_OWNER);
1107         fowner = zfs_fuid_map_id(zsb, zp->z_uid, cr, ZFS_OWNER);
1108
1109         if ((uid = crgetuid(cr)) == downer || uid == fowner ||
1110             (S_ISDIR(ZTOI(zp)->i_mode) &&
1111             zfs_zaccess(zp, ACE_WRITE_DATA, 0, B_FALSE, cr) == 0))
1112                 return (0);
1113         else
1114                 return (secpolicy_vnode_remove(cr));
1115 }