xref: /illumos-gate/usr/src/uts/common/fs/zfs/zfs_dir.c (revision 622200ad88c6c6382403a01985a94e22484baac6)
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 2006 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #pragma ident	"%Z%%M%	%I%	%E% SMI"
27 
28 #include <sys/types.h>
29 #include <sys/param.h>
30 #include <sys/time.h>
31 #include <sys/systm.h>
32 #include <sys/sysmacros.h>
33 #include <sys/resource.h>
34 #include <sys/vfs.h>
35 #include <sys/vnode.h>
36 #include <sys/file.h>
37 #include <sys/mode.h>
38 #include <sys/kmem.h>
39 #include <sys/uio.h>
40 #include <sys/pathname.h>
41 #include <sys/cmn_err.h>
42 #include <sys/errno.h>
43 #include <sys/stat.h>
44 #include <sys/unistd.h>
45 #include <sys/random.h>
46 #include <sys/policy.h>
47 #include <sys/zfs_dir.h>
48 #include <sys/zfs_acl.h>
49 #include <sys/fs/zfs.h>
50 #include "fs/fs_subr.h"
51 #include <sys/zap.h>
52 #include <sys/dmu.h>
53 #include <sys/atomic.h>
54 #include <sys/zfs_ctldir.h>
55 #include <sys/dnlc.h>
56 
57 /*
58  * Lock a directory entry.  A dirlock on <dzp, name> protects that name
59  * in dzp's directory zap object.  As long as you hold a dirlock, you can
60  * assume two things: (1) dzp cannot be reaped, and (2) no other thread
61  * can change the zap entry for (i.e. link or unlink) this name.
62  *
63  * Input arguments:
64  *	dzp	- znode for directory
65  *	name	- name of entry to lock
66  *	flag	- ZNEW: if the entry already exists, fail with EEXIST.
67  *		  ZEXISTS: if the entry does not exist, fail with ENOENT.
68  *		  ZSHARED: allow concurrent access with other ZSHARED callers.
69  *		  ZXATTR: we want dzp's xattr directory
70  *
71  * Output arguments:
72  *	zpp	- pointer to the znode for the entry (NULL if there isn't one)
73  *	dlpp	- pointer to the dirlock for this entry (NULL on error)
74  *
75  * Return value: 0 on success or errno on failure.
76  *
77  * NOTE: Always checks for, and rejects, '.' and '..'.
78  */
79 int
80 zfs_dirent_lock(zfs_dirlock_t **dlpp, znode_t *dzp, char *name, znode_t **zpp,
81 	int flag)
82 {
83 	zfsvfs_t	*zfsvfs = dzp->z_zfsvfs;
84 	zfs_dirlock_t	*dl;
85 	uint64_t	zoid;
86 	int		error;
87 	vnode_t		*vp;
88 
89 	*zpp = NULL;
90 	*dlpp = NULL;
91 
92 	/*
93 	 * Verify that we are not trying to lock '.', '..', or '.zfs'
94 	 */
95 	if (name[0] == '.' &&
96 	    (name[1] == '\0' || (name[1] == '.' && name[2] == '\0')) ||
97 	    zfs_has_ctldir(dzp) && strcmp(name, ZFS_CTLDIR_NAME) == 0)
98 		return (EEXIST);
99 
100 	/*
101 	 * Wait until there are no locks on this name.
102 	 */
103 	mutex_enter(&dzp->z_lock);
104 	for (;;) {
105 		if (dzp->z_reap) {
106 			mutex_exit(&dzp->z_lock);
107 			return (ENOENT);
108 		}
109 		for (dl = dzp->z_dirlocks; dl != NULL; dl = dl->dl_next)
110 			if (strcmp(name, dl->dl_name) == 0)
111 				break;
112 		if (dl == NULL)	{
113 			/*
114 			 * Allocate a new dirlock and add it to the list.
115 			 */
116 			dl = kmem_alloc(sizeof (zfs_dirlock_t), KM_SLEEP);
117 			cv_init(&dl->dl_cv, NULL, CV_DEFAULT, NULL);
118 			dl->dl_name = name;
119 			dl->dl_sharecnt = 0;
120 			dl->dl_namesize = 0;
121 			dl->dl_dzp = dzp;
122 			dl->dl_next = dzp->z_dirlocks;
123 			dzp->z_dirlocks = dl;
124 			break;
125 		}
126 		if ((flag & ZSHARED) && dl->dl_sharecnt != 0)
127 			break;
128 		cv_wait(&dl->dl_cv, &dzp->z_lock);
129 	}
130 
131 	if ((flag & ZSHARED) && ++dl->dl_sharecnt > 1 && dl->dl_namesize == 0) {
132 		/*
133 		 * We're the second shared reference to dl.  Make a copy of
134 		 * dl_name in case the first thread goes away before we do.
135 		 * Note that we initialize the new name before storing its
136 		 * pointer into dl_name, because the first thread may load
137 		 * dl->dl_name at any time.  He'll either see the old value,
138 		 * which is his, or the new shared copy; either is OK.
139 		 */
140 		dl->dl_namesize = strlen(dl->dl_name) + 1;
141 		name = kmem_alloc(dl->dl_namesize, KM_SLEEP);
142 		bcopy(dl->dl_name, name, dl->dl_namesize);
143 		dl->dl_name = name;
144 	}
145 
146 	mutex_exit(&dzp->z_lock);
147 
148 	/*
149 	 * We have a dirlock on the name.  (Note that it is the dirlock,
150 	 * not the dzp's z_lock, that protects the name in the zap object.)
151 	 * See if there's an object by this name; if so, put a hold on it.
152 	 */
153 	if (flag & ZXATTR) {
154 		zoid = dzp->z_phys->zp_xattr;
155 		error = (zoid == 0 ? ENOENT : 0);
156 	} else {
157 		vp = dnlc_lookup(ZTOV(dzp), name);
158 		if (vp == DNLC_NO_VNODE) {
159 			VN_RELE(vp);
160 			error = ENOENT;
161 		} else if (vp) {
162 			if (flag & ZNEW) {
163 				zfs_dirent_unlock(dl);
164 				VN_RELE(vp);
165 				return (EEXIST);
166 			}
167 			*dlpp = dl;
168 			*zpp = VTOZ(vp);
169 			return (0);
170 		} else {
171 			error = zap_lookup(zfsvfs->z_os, dzp->z_id, name,
172 			    8, 1, &zoid);
173 			if (error == ENOENT)
174 				dnlc_update(ZTOV(dzp), name, DNLC_NO_VNODE);
175 		}
176 	}
177 	if (error) {
178 		if (error != ENOENT || (flag & ZEXISTS)) {
179 			zfs_dirent_unlock(dl);
180 			return (error);
181 		}
182 	} else {
183 		if (flag & ZNEW) {
184 			zfs_dirent_unlock(dl);
185 			return (EEXIST);
186 		}
187 		error = zfs_zget(zfsvfs, zoid, zpp);
188 		if (error) {
189 			zfs_dirent_unlock(dl);
190 			return (error);
191 		}
192 		if (!(flag & ZXATTR))
193 			dnlc_update(ZTOV(dzp), name, ZTOV(*zpp));
194 	}
195 
196 	*dlpp = dl;
197 
198 	return (0);
199 }
200 
201 /*
202  * Unlock this directory entry and wake anyone who was waiting for it.
203  */
204 void
205 zfs_dirent_unlock(zfs_dirlock_t *dl)
206 {
207 	znode_t *dzp = dl->dl_dzp;
208 	zfs_dirlock_t **prev_dl, *cur_dl;
209 
210 	mutex_enter(&dzp->z_lock);
211 	if (dl->dl_sharecnt > 1) {
212 		dl->dl_sharecnt--;
213 		mutex_exit(&dzp->z_lock);
214 		return;
215 	}
216 	prev_dl = &dzp->z_dirlocks;
217 	while ((cur_dl = *prev_dl) != dl)
218 		prev_dl = &cur_dl->dl_next;
219 	*prev_dl = dl->dl_next;
220 	cv_broadcast(&dl->dl_cv);
221 	mutex_exit(&dzp->z_lock);
222 
223 	if (dl->dl_namesize != 0)
224 		kmem_free(dl->dl_name, dl->dl_namesize);
225 	cv_destroy(&dl->dl_cv);
226 	kmem_free(dl, sizeof (*dl));
227 }
228 
229 /*
230  * Look up an entry in a directory.
231  *
232  * NOTE: '.' and '..' are handled as special cases because
233  *	no directory entries are actually stored for them.  If this is
234  *	the root of a filesystem, then '.zfs' is also treated as a
235  *	special pseudo-directory.
236  */
237 int
238 zfs_dirlook(znode_t *dzp, char *name, vnode_t **vpp)
239 {
240 	zfs_dirlock_t *dl;
241 	znode_t *zp;
242 	int error = 0;
243 
244 	if (name[0] == 0 || (name[0] == '.' && name[1] == 0)) {
245 		*vpp = ZTOV(dzp);
246 		VN_HOLD(*vpp);
247 	} else if (name[0] == '.' && name[1] == '.' && name[2] == 0) {
248 		zfsvfs_t *zfsvfs = dzp->z_zfsvfs;
249 		/*
250 		 * If we are a snapshot mounted under .zfs, return
251 		 * the vp for the snapshot directory.
252 		 */
253 		if (zfsvfs->z_parent != zfsvfs) {
254 			error = zfsctl_root_lookup(zfsvfs->z_parent->z_ctldir,
255 			    "snapshot", vpp, NULL, 0, NULL, kcred);
256 			return (error);
257 		}
258 		rw_enter(&dzp->z_parent_lock, RW_READER);
259 		error = zfs_zget(zfsvfs, dzp->z_phys->zp_parent, &zp);
260 		if (error == 0)
261 			*vpp = ZTOV(zp);
262 		rw_exit(&dzp->z_parent_lock);
263 	} else if (zfs_has_ctldir(dzp) && strcmp(name, ZFS_CTLDIR_NAME) == 0) {
264 		*vpp = zfsctl_root(dzp);
265 	} else {
266 		error = zfs_dirent_lock(&dl, dzp, name, &zp, ZEXISTS | ZSHARED);
267 		if (error == 0) {
268 			*vpp = ZTOV(zp);
269 			zfs_dirent_unlock(dl);
270 			dzp->z_zn_prefetch = B_TRUE; /* enable prefetching */
271 		}
272 	}
273 
274 	return (error);
275 }
276 
277 static char *
278 zfs_dq_hexname(char namebuf[17], uint64_t x)
279 {
280 	char *name = &namebuf[16];
281 	const char digits[16] = "0123456789abcdef";
282 
283 	*name = '\0';
284 	do {
285 		*--name = digits[x & 0xf];
286 		x >>= 4;
287 	} while (x != 0);
288 
289 	return (name);
290 }
291 
292 /*
293  * Delete Queue Error Handling
294  *
295  * When dealing with the delete queue, we dmu_tx_hold_zap(), but we
296  * don't specify the name of the entry that we will be manipulating.  We
297  * also fib and say that we won't be adding any new entries to the
298  * delete queue, even though we might (this is to lower the minimum file
299  * size that can be deleted in a full filesystem).  So on the small
300  * chance that the delete queue is using a fat zap (ie. has more than
301  * 2000 entries), we *may* not pre-read a block that's needed.
302  * Therefore it is remotely possible for some of the assertions
303  * regarding the delete queue below to fail due to i/o error.  On a
304  * nondebug system, this will result in the space being leaked.
305  */
306 
307 void
308 zfs_dq_add(znode_t *zp, dmu_tx_t *tx)
309 {
310 	zfsvfs_t *zfsvfs = zp->z_zfsvfs;
311 	char obj_name[17];
312 	int error;
313 
314 	ASSERT(zp->z_reap);
315 	ASSERT3U(zp->z_phys->zp_links, ==, 0);
316 
317 	error = zap_add(zfsvfs->z_os, zfsvfs->z_dqueue,
318 	    zfs_dq_hexname(obj_name, zp->z_id), 8, 1, &zp->z_id, tx);
319 	ASSERT3U(error, ==, 0);
320 }
321 
322 /*
323  * Delete the entire contents of a directory.  Return a count
324  * of the number of entries that could not be deleted.
325  *
326  * NOTE: this function assumes that the directory is inactive,
327  *	so there is no need to lock its entries before deletion.
328  *	Also, it assumes the directory contents is *only* regular
329  *	files.
330  */
331 static int
332 zfs_purgedir(znode_t *dzp)
333 {
334 	zap_cursor_t	zc;
335 	zap_attribute_t	zap;
336 	znode_t		*xzp;
337 	dmu_tx_t	*tx;
338 	zfsvfs_t	*zfsvfs = dzp->z_zfsvfs;
339 	zfs_dirlock_t	dl;
340 	int skipped = 0;
341 	int error;
342 
343 	ASSERT(dzp->z_active == 0);
344 
345 	for (zap_cursor_init(&zc, zfsvfs->z_os, dzp->z_id);
346 	    (error = zap_cursor_retrieve(&zc, &zap)) == 0;
347 	    zap_cursor_advance(&zc)) {
348 		error = zfs_zget(zfsvfs, zap.za_first_integer, &xzp);
349 		ASSERT3U(error, ==, 0);
350 
351 		ASSERT((ZTOV(xzp)->v_type == VREG) ||
352 		    (ZTOV(xzp)->v_type == VLNK));
353 
354 		tx = dmu_tx_create(zfsvfs->z_os);
355 		dmu_tx_hold_bonus(tx, dzp->z_id);
356 		dmu_tx_hold_zap(tx, dzp->z_id, FALSE, zap.za_name);
357 		dmu_tx_hold_bonus(tx, xzp->z_id);
358 		dmu_tx_hold_zap(tx, zfsvfs->z_dqueue, FALSE, NULL);
359 		error = dmu_tx_assign(tx, TXG_WAIT);
360 		if (error) {
361 			dmu_tx_abort(tx);
362 			VN_RELE(ZTOV(xzp));
363 			skipped += 1;
364 			continue;
365 		}
366 		bzero(&dl, sizeof (dl));
367 		dl.dl_dzp = dzp;
368 		dl.dl_name = zap.za_name;
369 
370 		error = zfs_link_destroy(&dl, xzp, tx, 0, NULL);
371 		ASSERT3U(error, ==, 0);
372 		dmu_tx_commit(tx);
373 
374 		VN_RELE(ZTOV(xzp));
375 	}
376 	zap_cursor_fini(&zc);
377 	ASSERT(error == ENOENT);
378 	return (skipped);
379 }
380 
381 /*
382  * Special function to requeue the znodes for deletion that were
383  * in progress when we either crashed or umounted the file system.
384  */
385 static void
386 zfs_drain_dq(zfsvfs_t *zfsvfs)
387 {
388 	zap_cursor_t	zc;
389 	zap_attribute_t zap;
390 	dmu_object_info_t doi;
391 	znode_t		*zp;
392 	int		error;
393 
394 	/*
395 	 * Interate over the contents of the delete queue.
396 	 */
397 	for (zap_cursor_init(&zc, zfsvfs->z_os, zfsvfs->z_dqueue);
398 	    zap_cursor_retrieve(&zc, &zap) == 0;
399 	    zap_cursor_advance(&zc)) {
400 
401 		/*
402 		 * Need some helpers?
403 		 */
404 		if (zfs_delete_thread_target(zfsvfs, -1) != 0)
405 			return;
406 
407 		/*
408 		 * See what kind of object we have in queue
409 		 */
410 
411 		error = dmu_object_info(zfsvfs->z_os,
412 		    zap.za_first_integer, &doi);
413 		if (error != 0)
414 			continue;
415 
416 		ASSERT((doi.doi_type == DMU_OT_PLAIN_FILE_CONTENTS) ||
417 		    (doi.doi_type == DMU_OT_DIRECTORY_CONTENTS));
418 		/*
419 		 * We need to re-mark these queue entries for reaping,
420 		 * so we pull them back into core and set zp->z_reap.
421 		 */
422 		error = zfs_zget(zfsvfs, zap.za_first_integer, &zp);
423 
424 		/*
425 		 * We may pick up znodes that are already marked for reaping.
426 		 * This could happen during the purge of an extended attribute
427 		 * directory.  All we need to do is skip over them, since they
428 		 * are already in the system to be processed by the taskq.
429 		 */
430 		if (error != 0) {
431 			continue;
432 		}
433 		zp->z_reap = 1;
434 		VN_RELE(ZTOV(zp));
435 		break;
436 	}
437 	zap_cursor_fini(&zc);
438 }
439 
440 void
441 zfs_delete_thread(void *arg)
442 {
443 	zfsvfs_t	*zfsvfs = arg;
444 	zfs_delete_t 	*zd = &zfsvfs->z_delete_head;
445 	znode_t		*zp;
446 	callb_cpr_t	cprinfo;
447 
448 	CALLB_CPR_INIT(&cprinfo, &zd->z_mutex, callb_generic_cpr, "zfs_delete");
449 
450 	mutex_enter(&zd->z_mutex);
451 
452 	if (!zd->z_drained && !zd->z_draining) {
453 		zd->z_draining = B_TRUE;
454 		mutex_exit(&zd->z_mutex);
455 		zfs_drain_dq(zfsvfs);
456 		mutex_enter(&zd->z_mutex);
457 		zd->z_draining = B_FALSE;
458 		zd->z_drained = B_TRUE;
459 		cv_broadcast(&zd->z_quiesce_cv);
460 	}
461 
462 	while (zd->z_thread_count <= zd->z_thread_target) {
463 		zp = list_head(&zd->z_znodes);
464 		if (zp == NULL) {
465 			ASSERT(zd->z_znode_count == 0);
466 			CALLB_CPR_SAFE_BEGIN(&cprinfo);
467 			cv_wait(&zd->z_cv, &zd->z_mutex);
468 			CALLB_CPR_SAFE_END(&cprinfo, &zd->z_mutex);
469 			continue;
470 		}
471 		ASSERT(zd->z_znode_count != 0);
472 		list_remove(&zd->z_znodes, zp);
473 		if (--zd->z_znode_count == 0)
474 			cv_broadcast(&zd->z_quiesce_cv);
475 		mutex_exit(&zd->z_mutex);
476 		zfs_rmnode(zp);
477 		(void) zfs_delete_thread_target(zfsvfs, -1);
478 		mutex_enter(&zd->z_mutex);
479 	}
480 
481 	ASSERT(zd->z_thread_count != 0);
482 	if (--zd->z_thread_count == 0)
483 		cv_broadcast(&zd->z_cv);
484 
485 	CALLB_CPR_EXIT(&cprinfo);	/* NB: drops z_mutex */
486 	thread_exit();
487 }
488 
489 static int zfs_work_per_thread_shift = 11;	/* 2048 (2^11) per thread */
490 
491 /*
492  * Set the target number of delete threads to 'nthreads'.
493  * If nthreads == -1, choose a number based on current workload.
494  * If nthreads == 0, don't return until the threads have exited.
495  */
496 int
497 zfs_delete_thread_target(zfsvfs_t *zfsvfs, int nthreads)
498 {
499 	zfs_delete_t *zd = &zfsvfs->z_delete_head;
500 
501 	mutex_enter(&zd->z_mutex);
502 
503 	if (nthreads == -1) {
504 		if (zd->z_thread_target == 0) {
505 			mutex_exit(&zd->z_mutex);
506 			return (EBUSY);
507 		}
508 		nthreads = zd->z_znode_count >> zfs_work_per_thread_shift;
509 		nthreads = MIN(nthreads, ncpus << 1);
510 		nthreads = MAX(nthreads, 1);
511 		nthreads += !!zd->z_draining;
512 	}
513 
514 	zd->z_thread_target = nthreads;
515 
516 	while (zd->z_thread_count < zd->z_thread_target) {
517 		(void) thread_create(NULL, 0, zfs_delete_thread, zfsvfs,
518 		    0, &p0, TS_RUN, minclsyspri);
519 		zd->z_thread_count++;
520 	}
521 
522 	while (zd->z_thread_count > zd->z_thread_target && nthreads == 0) {
523 		cv_broadcast(&zd->z_cv);
524 		cv_wait(&zd->z_cv, &zd->z_mutex);
525 	}
526 
527 	mutex_exit(&zd->z_mutex);
528 
529 	return (0);
530 }
531 
532 /*
533  * Wait until everything that's been queued has been deleted.
534  */
535 void
536 zfs_delete_wait_empty(zfsvfs_t *zfsvfs)
537 {
538 	zfs_delete_t *zd = &zfsvfs->z_delete_head;
539 
540 	mutex_enter(&zd->z_mutex);
541 	ASSERT(zd->z_thread_target != 0);
542 	while (!zd->z_drained || zd->z_znode_count != 0) {
543 		ASSERT(zd->z_thread_target != 0);
544 		cv_wait(&zd->z_quiesce_cv, &zd->z_mutex);
545 	}
546 	mutex_exit(&zd->z_mutex);
547 }
548 
549 void
550 zfs_rmnode(znode_t *zp)
551 {
552 	zfsvfs_t	*zfsvfs = zp->z_zfsvfs;
553 	objset_t	*os = zfsvfs->z_os;
554 	znode_t		*xzp = NULL;
555 	char		obj_name[17];
556 	dmu_tx_t	*tx;
557 	uint64_t	acl_obj;
558 	int		error;
559 
560 	ASSERT(zp->z_active == 0);
561 	ASSERT(ZTOV(zp)->v_count == 0);
562 	ASSERT(zp->z_phys->zp_links == 0);
563 
564 	/*
565 	 * If this is an attribute directory, purge its contents.
566 	 */
567 	if (ZTOV(zp)->v_type == VDIR && (zp->z_phys->zp_flags & ZFS_XATTR))
568 		if (zfs_purgedir(zp) != 0) {
569 			zfs_delete_t *delq = &zfsvfs->z_delete_head;
570 			/*
571 			 * Add this back to the delete list to be retried later.
572 			 *
573 			 * XXX - this could just busy loop on us...
574 			 */
575 			mutex_enter(&delq->z_mutex);
576 			list_insert_tail(&delq->z_znodes, zp);
577 			delq->z_znode_count++;
578 			mutex_exit(&delq->z_mutex);
579 			return;
580 		}
581 
582 	/*
583 	 * If the file has extended attributes, unlink the xattr dir.
584 	 */
585 	if (zp->z_phys->zp_xattr) {
586 		error = zfs_zget(zfsvfs, zp->z_phys->zp_xattr, &xzp);
587 		ASSERT(error == 0);
588 	}
589 
590 	acl_obj = zp->z_phys->zp_acl.z_acl_extern_obj;
591 
592 	/*
593 	 * Set up the transaction.
594 	 */
595 	tx = dmu_tx_create(os);
596 	dmu_tx_hold_free(tx, zp->z_id, 0, DMU_OBJECT_END);
597 	dmu_tx_hold_zap(tx, zfsvfs->z_dqueue, FALSE, NULL);
598 	if (xzp) {
599 		dmu_tx_hold_bonus(tx, xzp->z_id);
600 		dmu_tx_hold_zap(tx, zfsvfs->z_dqueue, TRUE, NULL);
601 	}
602 	if (acl_obj)
603 		dmu_tx_hold_free(tx, acl_obj, 0, DMU_OBJECT_END);
604 	error = dmu_tx_assign(tx, TXG_WAIT);
605 	if (error) {
606 		zfs_delete_t *delq = &zfsvfs->z_delete_head;
607 
608 		dmu_tx_abort(tx);
609 		/*
610 		 * Add this back to the delete list to be retried later.
611 		 *
612 		 * XXX - this could just busy loop on us...
613 		 */
614 		mutex_enter(&delq->z_mutex);
615 		list_insert_tail(&delq->z_znodes, zp);
616 		delq->z_znode_count++;
617 		mutex_exit(&delq->z_mutex);
618 		return;
619 	}
620 
621 	if (xzp) {
622 		dmu_buf_will_dirty(xzp->z_dbuf, tx);
623 		mutex_enter(&xzp->z_lock);
624 		xzp->z_reap = 1;		/* mark xzp for deletion */
625 		xzp->z_phys->zp_links = 0;	/* no more links to it */
626 		mutex_exit(&xzp->z_lock);
627 		zfs_dq_add(xzp, tx);		/* add xzp to delete queue */
628 	}
629 
630 	/*
631 	 * Remove this znode from delete queue
632 	 */
633 	error = zap_remove(os, zfsvfs->z_dqueue,
634 	    zfs_dq_hexname(obj_name, zp->z_id), tx);
635 	ASSERT3U(error, ==, 0);
636 
637 	zfs_znode_delete(zp, tx);
638 
639 	dmu_tx_commit(tx);
640 
641 	if (xzp)
642 		VN_RELE(ZTOV(xzp));
643 }
644 
645 /*
646  * Link zp into dl.  Can only fail if zp has been reaped.
647  */
648 int
649 zfs_link_create(zfs_dirlock_t *dl, znode_t *zp, dmu_tx_t *tx, int flag)
650 {
651 	znode_t *dzp = dl->dl_dzp;
652 	vnode_t *vp = ZTOV(zp);
653 	int zp_is_dir = (vp->v_type == VDIR);
654 	int error;
655 
656 	dmu_buf_will_dirty(zp->z_dbuf, tx);
657 	mutex_enter(&zp->z_lock);
658 
659 	if (!(flag & ZRENAMING)) {
660 		if (zp->z_reap) {	/* no new links to reaped zp */
661 			ASSERT(!(flag & (ZNEW | ZEXISTS)));
662 			mutex_exit(&zp->z_lock);
663 			return (ENOENT);
664 		}
665 		zp->z_phys->zp_links++;
666 	}
667 	zp->z_phys->zp_parent = dzp->z_id;	/* dzp is now zp's parent */
668 
669 	if (!(flag & ZNEW))
670 		zfs_time_stamper_locked(zp, STATE_CHANGED, tx);
671 	mutex_exit(&zp->z_lock);
672 
673 	dmu_buf_will_dirty(dzp->z_dbuf, tx);
674 	mutex_enter(&dzp->z_lock);
675 	dzp->z_phys->zp_size++;			/* one dirent added */
676 	dzp->z_phys->zp_links += zp_is_dir;	/* ".." link from zp */
677 	zfs_time_stamper_locked(dzp, CONTENT_MODIFIED, tx);
678 	mutex_exit(&dzp->z_lock);
679 
680 	error = zap_add(zp->z_zfsvfs->z_os, dzp->z_id, dl->dl_name,
681 	    8, 1, &zp->z_id, tx);
682 	ASSERT(error == 0);
683 
684 	dnlc_update(ZTOV(dzp), dl->dl_name, vp);
685 
686 	return (0);
687 }
688 
689 /*
690  * Unlink zp from dl, and mark zp for reaping if this was the last link.
691  * Can fail if zp is a mount point (EBUSY) or a non-empty directory (EEXIST).
692  * If 'reaped_ptr' is NULL, we put reaped znodes on the delete queue.
693  * If it's non-NULL, we use it to indicate whether the znode needs reaping,
694  * and it's the caller's job to do it.
695  */
696 int
697 zfs_link_destroy(zfs_dirlock_t *dl, znode_t *zp, dmu_tx_t *tx, int flag,
698 	int *reaped_ptr)
699 {
700 	znode_t *dzp = dl->dl_dzp;
701 	vnode_t *vp = ZTOV(zp);
702 	int zp_is_dir = (vp->v_type == VDIR);
703 	int reaped = 0;
704 	int error;
705 
706 	dnlc_remove(ZTOV(dzp), dl->dl_name);
707 
708 	if (!(flag & ZRENAMING)) {
709 		dmu_buf_will_dirty(zp->z_dbuf, tx);
710 
711 		if (vn_vfswlock(vp))		/* prevent new mounts on zp */
712 			return (EBUSY);
713 
714 		if (vn_ismntpt(vp)) {		/* don't remove mount point */
715 			vn_vfsunlock(vp);
716 			return (EBUSY);
717 		}
718 
719 		mutex_enter(&zp->z_lock);
720 		if (zp_is_dir && !zfs_dirempty(zp)) {	/* dir not empty */
721 			mutex_exit(&zp->z_lock);
722 			vn_vfsunlock(vp);
723 			return (EEXIST);
724 		}
725 		ASSERT(zp->z_phys->zp_links > zp_is_dir);
726 		if (--zp->z_phys->zp_links == zp_is_dir) {
727 			zp->z_reap = 1;
728 			zp->z_phys->zp_links = 0;
729 			reaped = 1;
730 		} else {
731 			zfs_time_stamper_locked(zp, STATE_CHANGED, tx);
732 		}
733 		mutex_exit(&zp->z_lock);
734 		vn_vfsunlock(vp);
735 	}
736 
737 	dmu_buf_will_dirty(dzp->z_dbuf, tx);
738 	mutex_enter(&dzp->z_lock);
739 	dzp->z_phys->zp_size--;			/* one dirent removed */
740 	dzp->z_phys->zp_links -= zp_is_dir;	/* ".." link from zp */
741 	zfs_time_stamper_locked(dzp, CONTENT_MODIFIED, tx);
742 	mutex_exit(&dzp->z_lock);
743 
744 	error = zap_remove(zp->z_zfsvfs->z_os, dzp->z_id, dl->dl_name, tx);
745 	ASSERT(error == 0);
746 
747 	if (reaped_ptr != NULL)
748 		*reaped_ptr = reaped;
749 	else if (reaped)
750 		zfs_dq_add(zp, tx);
751 
752 	return (0);
753 }
754 
755 /*
756  * Indicate whether the directory is empty.  Works with or without z_lock
757  * held, but can only be consider a hint in the latter case.  Returns true
758  * if only "." and ".." remain and there's no work in progress.
759  */
760 boolean_t
761 zfs_dirempty(znode_t *dzp)
762 {
763 	return (dzp->z_phys->zp_size == 2 && dzp->z_dirlocks == 0);
764 }
765 
766 int
767 zfs_make_xattrdir(znode_t *zp, vattr_t *vap, vnode_t **xvpp, cred_t *cr)
768 {
769 	zfsvfs_t *zfsvfs = zp->z_zfsvfs;
770 	znode_t *xzp;
771 	dmu_tx_t *tx;
772 	uint64_t xoid;
773 	int error;
774 
775 	*xvpp = NULL;
776 
777 	if (error = zfs_zaccess(zp, ACE_WRITE_NAMED_ATTRS, cr))
778 		return (error);
779 
780 	tx = dmu_tx_create(zfsvfs->z_os);
781 	dmu_tx_hold_bonus(tx, zp->z_id);
782 	dmu_tx_hold_zap(tx, DMU_NEW_OBJECT, FALSE, NULL);
783 	error = dmu_tx_assign(tx, zfsvfs->z_assign);
784 	if (error) {
785 		dmu_tx_abort(tx);
786 		return (error);
787 	}
788 	zfs_mknode(zp, vap, &xoid, tx, cr, IS_XATTR, &xzp, 0);
789 	ASSERT(xzp->z_id == xoid);
790 	ASSERT(xzp->z_phys->zp_parent == zp->z_id);
791 	dmu_buf_will_dirty(zp->z_dbuf, tx);
792 	zp->z_phys->zp_xattr = xoid;
793 
794 	(void) zfs_log_create(zfsvfs->z_log, tx, TX_MKXATTR, zp, xzp, "");
795 	dmu_tx_commit(tx);
796 
797 	*xvpp = ZTOV(xzp);
798 
799 	return (0);
800 }
801 
802 /*
803  * Return a znode for the extended attribute directory for zp.
804  * ** If the directory does not already exist, it is created **
805  *
806  *	IN:	zp	- znode to obtain attribute directory from
807  *		cr	- credentials of caller
808  *
809  *	OUT:	xzpp	- pointer to extended attribute znode
810  *
811  *	RETURN:	0 on success
812  *		error number on failure
813  */
814 int
815 zfs_get_xattrdir(znode_t *zp, vnode_t **xvpp, cred_t *cr)
816 {
817 	zfsvfs_t	*zfsvfs = zp->z_zfsvfs;
818 	znode_t		*xzp;
819 	zfs_dirlock_t	*dl;
820 	vattr_t		va;
821 	int		error;
822 top:
823 	error = zfs_dirent_lock(&dl, zp, "", &xzp, ZXATTR);
824 	if (error)
825 		return (error);
826 
827 	if (xzp != NULL) {
828 		*xvpp = ZTOV(xzp);
829 		zfs_dirent_unlock(dl);
830 		return (0);
831 	}
832 
833 	ASSERT(zp->z_phys->zp_xattr == 0);
834 
835 	if (zfsvfs->z_vfs->vfs_flag & VFS_RDONLY) {
836 		zfs_dirent_unlock(dl);
837 		return (EROFS);
838 	}
839 
840 	/*
841 	 * The ability to 'create' files in an attribute
842 	 * directory comes from the write_xattr permission on the base file.
843 	 *
844 	 * The ability to 'search' an attribute directory requires
845 	 * read_xattr permission on the base file.
846 	 *
847 	 * Once in a directory the ability to read/write attributes
848 	 * is controlled by the permissions on the attribute file.
849 	 */
850 	va.va_mask = AT_TYPE | AT_MODE | AT_UID | AT_GID;
851 	va.va_type = VDIR;
852 	va.va_mode = S_IFDIR | S_ISVTX | 0777;
853 	va.va_uid = (uid_t)zp->z_phys->zp_uid;
854 	va.va_gid = (gid_t)zp->z_phys->zp_gid;
855 
856 	error = zfs_make_xattrdir(zp, &va, xvpp, cr);
857 	zfs_dirent_unlock(dl);
858 
859 	if (error == ERESTART && zfsvfs->z_assign == TXG_NOWAIT) {
860 		txg_wait_open(dmu_objset_pool(zfsvfs->z_os), 0);
861 		goto top;
862 	}
863 
864 	return (error);
865 }
866 
867 /*
868  * Decide whether it is okay to remove within a sticky directory.
869  *
870  * In sticky directories, write access is not sufficient;
871  * you can remove entries from a directory only if:
872  *
873  *	you own the directory,
874  *	you own the entry,
875  *	the entry is a plain file and you have write access,
876  *	or you are privileged (checked in secpolicy...).
877  *
878  * The function returns 0 if remove access is granted.
879  */
880 int
881 zfs_sticky_remove_access(znode_t *zdp, znode_t *zp, cred_t *cr)
882 {
883 	uid_t  		uid;
884 
885 	if (zdp->z_zfsvfs->z_assign >= TXG_INITIAL)	/* ZIL replay */
886 		return (0);
887 
888 	if ((zdp->z_phys->zp_mode & S_ISVTX) == 0 ||
889 	    (uid = crgetuid(cr)) == zdp->z_phys->zp_uid ||
890 	    uid == zp->z_phys->zp_uid ||
891 	    (ZTOV(zp)->v_type == VREG &&
892 	    zfs_zaccess(zp, ACE_WRITE_DATA, cr) == 0))
893 		return (0);
894 	else
895 		return (secpolicy_vnode_remove(cr));
896 }
897