tmpfs_subr.c revision 312068
1/*	$NetBSD: tmpfs_subr.c,v 1.35 2007/07/09 21:10:50 ad Exp $	*/
2
3/*-
4 * Copyright (c) 2005 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Julio M. Merino Vidal, developed as part of Google's Summer of Code
9 * 2005 program.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33/*
34 * Efficient memory file system supporting functions.
35 */
36#include <sys/cdefs.h>
37__FBSDID("$FreeBSD: stable/10/sys/fs/tmpfs/tmpfs_subr.c 312068 2017-01-13 12:45:54Z kib $");
38
39#include <sys/param.h>
40#include <sys/fnv_hash.h>
41#include <sys/lock.h>
42#include <sys/namei.h>
43#include <sys/priv.h>
44#include <sys/proc.h>
45#include <sys/rwlock.h>
46#include <sys/stat.h>
47#include <sys/systm.h>
48#include <sys/sysctl.h>
49#include <sys/vnode.h>
50#include <sys/vmmeter.h>
51
52#include <vm/vm.h>
53#include <vm/vm_param.h>
54#include <vm/vm_object.h>
55#include <vm/vm_page.h>
56#include <vm/vm_pageout.h>
57#include <vm/vm_pager.h>
58#include <vm/vm_extern.h>
59
60#include <fs/tmpfs/tmpfs.h>
61#include <fs/tmpfs/tmpfs_fifoops.h>
62#include <fs/tmpfs/tmpfs_vnops.h>
63
64struct tmpfs_dir_cursor {
65	struct tmpfs_dirent	*tdc_current;
66	struct tmpfs_dirent	*tdc_tree;
67};
68
69SYSCTL_NODE(_vfs, OID_AUTO, tmpfs, CTLFLAG_RW, 0, "tmpfs file system");
70
71static long tmpfs_pages_reserved = TMPFS_PAGES_MINRESERVED;
72
73static int
74sysctl_mem_reserved(SYSCTL_HANDLER_ARGS)
75{
76	int error;
77	long pages, bytes;
78
79	pages = *(long *)arg1;
80	bytes = pages * PAGE_SIZE;
81
82	error = sysctl_handle_long(oidp, &bytes, 0, req);
83	if (error || !req->newptr)
84		return (error);
85
86	pages = bytes / PAGE_SIZE;
87	if (pages < TMPFS_PAGES_MINRESERVED)
88		return (EINVAL);
89
90	*(long *)arg1 = pages;
91	return (0);
92}
93
94SYSCTL_PROC(_vfs_tmpfs, OID_AUTO, memory_reserved, CTLTYPE_LONG|CTLFLAG_RW,
95    &tmpfs_pages_reserved, 0, sysctl_mem_reserved, "L",
96    "Amount of available memory and swap below which tmpfs growth stops");
97
98static __inline int tmpfs_dirtree_cmp(struct tmpfs_dirent *a,
99    struct tmpfs_dirent *b);
100RB_PROTOTYPE_STATIC(tmpfs_dir, tmpfs_dirent, uh.td_entries, tmpfs_dirtree_cmp);
101
102size_t
103tmpfs_mem_avail(void)
104{
105	vm_ooffset_t avail;
106
107	avail = swap_pager_avail + cnt.v_free_count + cnt.v_cache_count -
108	    tmpfs_pages_reserved;
109	if (__predict_false(avail < 0))
110		avail = 0;
111	return (avail);
112}
113
114size_t
115tmpfs_pages_used(struct tmpfs_mount *tmp)
116{
117	const size_t node_size = sizeof(struct tmpfs_node) +
118	    sizeof(struct tmpfs_dirent);
119	size_t meta_pages;
120
121	meta_pages = howmany((uintmax_t)tmp->tm_nodes_inuse * node_size,
122	    PAGE_SIZE);
123	return (meta_pages + tmp->tm_pages_used);
124}
125
126static size_t
127tmpfs_pages_check_avail(struct tmpfs_mount *tmp, size_t req_pages)
128{
129	if (tmpfs_mem_avail() < req_pages)
130		return (0);
131
132	if (tmp->tm_pages_max != SIZE_MAX &&
133	    tmp->tm_pages_max < req_pages + tmpfs_pages_used(tmp))
134			return (0);
135
136	return (1);
137}
138
139/*
140 * Allocates a new node of type 'type' inside the 'tmp' mount point, with
141 * its owner set to 'uid', its group to 'gid' and its mode set to 'mode',
142 * using the credentials of the process 'p'.
143 *
144 * If the node type is set to 'VDIR', then the parent parameter must point
145 * to the parent directory of the node being created.  It may only be NULL
146 * while allocating the root node.
147 *
148 * If the node type is set to 'VBLK' or 'VCHR', then the rdev parameter
149 * specifies the device the node represents.
150 *
151 * If the node type is set to 'VLNK', then the parameter target specifies
152 * the file name of the target file for the symbolic link that is being
153 * created.
154 *
155 * Note that new nodes are retrieved from the available list if it has
156 * items or, if it is empty, from the node pool as long as there is enough
157 * space to create them.
158 *
159 * Returns zero on success or an appropriate error code on failure.
160 */
161int
162tmpfs_alloc_node(struct mount *mp, struct tmpfs_mount *tmp, enum vtype type,
163    uid_t uid, gid_t gid, mode_t mode, struct tmpfs_node *parent,
164    char *target, dev_t rdev, struct tmpfs_node **node)
165{
166	struct tmpfs_node *nnode;
167	vm_object_t obj;
168
169	/* If the root directory of the 'tmp' file system is not yet
170	 * allocated, this must be the request to do it. */
171	MPASS(IMPLIES(tmp->tm_root == NULL, parent == NULL && type == VDIR));
172	KASSERT(tmp->tm_root == NULL || mp->mnt_writeopcount > 0,
173	    ("creating node not under vn_start_write"));
174
175	MPASS(IFF(type == VLNK, target != NULL));
176	MPASS(IFF(type == VBLK || type == VCHR, rdev != VNOVAL));
177
178	if (tmp->tm_nodes_inuse >= tmp->tm_nodes_max)
179		return (ENOSPC);
180	if (tmpfs_pages_check_avail(tmp, 1) == 0)
181		return (ENOSPC);
182
183	if ((mp->mnt_kern_flag & MNTK_UNMOUNT) != 0) {
184		/*
185		 * When a new tmpfs node is created for fully
186		 * constructed mount point, there must be a parent
187		 * node, which vnode is locked exclusively.  As
188		 * consequence, if the unmount is executing in
189		 * parallel, vflush() cannot reclaim the parent vnode.
190		 * Due to this, the check for MNTK_UNMOUNT flag is not
191		 * racy: if we did not see MNTK_UNMOUNT flag, then tmp
192		 * cannot be destroyed until node construction is
193		 * finished and the parent vnode unlocked.
194		 *
195		 * Tmpfs does not need to instantiate new nodes during
196		 * unmount.
197		 */
198		return (EBUSY);
199	}
200
201	nnode = (struct tmpfs_node *)uma_zalloc_arg(
202				tmp->tm_node_pool, tmp, M_WAITOK);
203
204	/* Generic initialization. */
205	nnode->tn_type = type;
206	vfs_timestamp(&nnode->tn_atime);
207	nnode->tn_birthtime = nnode->tn_ctime = nnode->tn_mtime =
208	    nnode->tn_atime;
209	nnode->tn_uid = uid;
210	nnode->tn_gid = gid;
211	nnode->tn_mode = mode;
212	nnode->tn_id = alloc_unr(tmp->tm_ino_unr);
213
214	/* Type-specific initialization. */
215	switch (nnode->tn_type) {
216	case VBLK:
217	case VCHR:
218		nnode->tn_rdev = rdev;
219		break;
220
221	case VDIR:
222		RB_INIT(&nnode->tn_dir.tn_dirhead);
223		LIST_INIT(&nnode->tn_dir.tn_dupindex);
224		MPASS(parent != nnode);
225		MPASS(IMPLIES(parent == NULL, tmp->tm_root == NULL));
226		nnode->tn_dir.tn_parent = (parent == NULL) ? nnode : parent;
227		nnode->tn_dir.tn_readdir_lastn = 0;
228		nnode->tn_dir.tn_readdir_lastp = NULL;
229		nnode->tn_links++;
230		TMPFS_NODE_LOCK(nnode->tn_dir.tn_parent);
231		nnode->tn_dir.tn_parent->tn_links++;
232		TMPFS_NODE_UNLOCK(nnode->tn_dir.tn_parent);
233		break;
234
235	case VFIFO:
236		/* FALLTHROUGH */
237	case VSOCK:
238		break;
239
240	case VLNK:
241		MPASS(strlen(target) < MAXPATHLEN);
242		nnode->tn_size = strlen(target);
243		nnode->tn_link = malloc(nnode->tn_size, M_TMPFSNAME,
244		    M_WAITOK);
245		memcpy(nnode->tn_link, target, nnode->tn_size);
246		break;
247
248	case VREG:
249		obj = nnode->tn_reg.tn_aobj =
250		    vm_pager_allocate(OBJT_SWAP, NULL, 0, VM_PROT_DEFAULT, 0,
251			NULL /* XXXKIB - tmpfs needs swap reservation */);
252		VM_OBJECT_WLOCK(obj);
253		/* OBJ_TMPFS is set together with the setting of vp->v_object */
254		vm_object_set_flag(obj, OBJ_NOSPLIT | OBJ_TMPFS_NODE);
255		vm_object_clear_flag(obj, OBJ_ONEMAPPING);
256		VM_OBJECT_WUNLOCK(obj);
257		break;
258
259	default:
260		panic("tmpfs_alloc_node: type %p %d", nnode, (int)nnode->tn_type);
261	}
262
263	TMPFS_LOCK(tmp);
264	LIST_INSERT_HEAD(&tmp->tm_nodes_used, nnode, tn_entries);
265	tmp->tm_nodes_inuse++;
266	TMPFS_UNLOCK(tmp);
267
268	*node = nnode;
269	return 0;
270}
271
272/*
273 * Destroys the node pointed to by node from the file system 'tmp'.
274 * If the node does not belong to the given mount point, the results are
275 * unpredicted.
276 *
277 * If the node references a directory; no entries are allowed because
278 * their removal could need a recursive algorithm, something forbidden in
279 * kernel space.  Furthermore, there is not need to provide such
280 * functionality (recursive removal) because the only primitives offered
281 * to the user are the removal of empty directories and the deletion of
282 * individual files.
283 *
284 * Note that nodes are not really deleted; in fact, when a node has been
285 * allocated, it cannot be deleted during the whole life of the file
286 * system.  Instead, they are moved to the available list and remain there
287 * until reused.
288 */
289void
290tmpfs_free_node(struct tmpfs_mount *tmp, struct tmpfs_node *node)
291{
292	vm_object_t uobj;
293
294#ifdef INVARIANTS
295	TMPFS_NODE_LOCK(node);
296	MPASS(node->tn_vnode == NULL);
297	MPASS((node->tn_vpstate & TMPFS_VNODE_ALLOCATING) == 0);
298	TMPFS_NODE_UNLOCK(node);
299#endif
300
301	TMPFS_LOCK(tmp);
302	LIST_REMOVE(node, tn_entries);
303	tmp->tm_nodes_inuse--;
304	TMPFS_UNLOCK(tmp);
305
306	switch (node->tn_type) {
307	case VNON:
308		/* Do not do anything.  VNON is provided to let the
309		 * allocation routine clean itself easily by avoiding
310		 * duplicating code in it. */
311		/* FALLTHROUGH */
312	case VBLK:
313		/* FALLTHROUGH */
314	case VCHR:
315		/* FALLTHROUGH */
316	case VDIR:
317		/* FALLTHROUGH */
318	case VFIFO:
319		/* FALLTHROUGH */
320	case VSOCK:
321		break;
322
323	case VLNK:
324		free(node->tn_link, M_TMPFSNAME);
325		break;
326
327	case VREG:
328		uobj = node->tn_reg.tn_aobj;
329		if (uobj != NULL) {
330			TMPFS_LOCK(tmp);
331			tmp->tm_pages_used -= uobj->size;
332			TMPFS_UNLOCK(tmp);
333			KASSERT((uobj->flags & OBJ_TMPFS) == 0,
334			    ("leaked OBJ_TMPFS node %p vm_obj %p", node, uobj));
335			vm_object_deallocate(uobj);
336		}
337		break;
338
339	default:
340		panic("tmpfs_free_node: type %p %d", node, (int)node->tn_type);
341	}
342
343	free_unr(tmp->tm_ino_unr, node->tn_id);
344	uma_zfree(tmp->tm_node_pool, node);
345}
346
347static __inline uint32_t
348tmpfs_dirent_hash(const char *name, u_int len)
349{
350	uint32_t hash;
351
352	hash = fnv_32_buf(name, len, FNV1_32_INIT + len) & TMPFS_DIRCOOKIE_MASK;
353#ifdef TMPFS_DEBUG_DIRCOOKIE_DUP
354	hash &= 0xf;
355#endif
356	if (hash < TMPFS_DIRCOOKIE_MIN)
357		hash += TMPFS_DIRCOOKIE_MIN;
358
359	return (hash);
360}
361
362static __inline off_t
363tmpfs_dirent_cookie(struct tmpfs_dirent *de)
364{
365	if (de == NULL)
366		return (TMPFS_DIRCOOKIE_EOF);
367
368	MPASS(de->td_cookie >= TMPFS_DIRCOOKIE_MIN);
369
370	return (de->td_cookie);
371}
372
373static __inline boolean_t
374tmpfs_dirent_dup(struct tmpfs_dirent *de)
375{
376	return ((de->td_cookie & TMPFS_DIRCOOKIE_DUP) != 0);
377}
378
379static __inline boolean_t
380tmpfs_dirent_duphead(struct tmpfs_dirent *de)
381{
382	return ((de->td_cookie & TMPFS_DIRCOOKIE_DUPHEAD) != 0);
383}
384
385void
386tmpfs_dirent_init(struct tmpfs_dirent *de, const char *name, u_int namelen)
387{
388	de->td_hash = de->td_cookie = tmpfs_dirent_hash(name, namelen);
389	memcpy(de->ud.td_name, name, namelen);
390	de->td_namelen = namelen;
391}
392
393/*
394 * Allocates a new directory entry for the node node with a name of name.
395 * The new directory entry is returned in *de.
396 *
397 * The link count of node is increased by one to reflect the new object
398 * referencing it.
399 *
400 * Returns zero on success or an appropriate error code on failure.
401 */
402int
403tmpfs_alloc_dirent(struct tmpfs_mount *tmp, struct tmpfs_node *node,
404    const char *name, u_int len, struct tmpfs_dirent **de)
405{
406	struct tmpfs_dirent *nde;
407
408	nde = uma_zalloc(tmp->tm_dirent_pool, M_WAITOK);
409	nde->td_node = node;
410	if (name != NULL) {
411		nde->ud.td_name = malloc(len, M_TMPFSNAME, M_WAITOK);
412		tmpfs_dirent_init(nde, name, len);
413	} else
414		nde->td_namelen = 0;
415	if (node != NULL)
416		node->tn_links++;
417
418	*de = nde;
419
420	return 0;
421}
422
423/*
424 * Frees a directory entry.  It is the caller's responsibility to destroy
425 * the node referenced by it if needed.
426 *
427 * The link count of node is decreased by one to reflect the removal of an
428 * object that referenced it.  This only happens if 'node_exists' is true;
429 * otherwise the function will not access the node referred to by the
430 * directory entry, as it may already have been released from the outside.
431 */
432void
433tmpfs_free_dirent(struct tmpfs_mount *tmp, struct tmpfs_dirent *de)
434{
435	struct tmpfs_node *node;
436
437	node = de->td_node;
438	if (node != NULL) {
439		MPASS(node->tn_links > 0);
440		node->tn_links--;
441	}
442	if (!tmpfs_dirent_duphead(de) && de->ud.td_name != NULL)
443		free(de->ud.td_name, M_TMPFSNAME);
444	uma_zfree(tmp->tm_dirent_pool, de);
445}
446
447void
448tmpfs_destroy_vobject(struct vnode *vp, vm_object_t obj)
449{
450
451	ASSERT_VOP_ELOCKED(vp, "tmpfs_destroy_vobject");
452	if (vp->v_type != VREG || obj == NULL)
453		return;
454
455	VM_OBJECT_WLOCK(obj);
456	VI_LOCK(vp);
457	vm_object_clear_flag(obj, OBJ_TMPFS);
458	obj->un_pager.swp.swp_tmpfs = NULL;
459	VI_UNLOCK(vp);
460	VM_OBJECT_WUNLOCK(obj);
461}
462
463/*
464 * Need to clear v_object for insmntque failure.
465 */
466static void
467tmpfs_insmntque_dtr(struct vnode *vp, void *dtr_arg)
468{
469
470	tmpfs_destroy_vobject(vp, vp->v_object);
471	vp->v_object = NULL;
472	vp->v_data = NULL;
473	vp->v_op = &dead_vnodeops;
474	vgone(vp);
475	vput(vp);
476}
477
478/*
479 * Allocates a new vnode for the node node or returns a new reference to
480 * an existing one if the node had already a vnode referencing it.  The
481 * resulting locked vnode is returned in *vpp.
482 *
483 * Returns zero on success or an appropriate error code on failure.
484 */
485int
486tmpfs_alloc_vp(struct mount *mp, struct tmpfs_node *node, int lkflag,
487    struct vnode **vpp)
488{
489	struct vnode *vp;
490	vm_object_t object;
491	int error;
492
493	error = 0;
494loop:
495	TMPFS_NODE_LOCK(node);
496loop1:
497	if ((vp = node->tn_vnode) != NULL) {
498		MPASS((node->tn_vpstate & TMPFS_VNODE_DOOMED) == 0);
499		VI_LOCK(vp);
500		if ((node->tn_type == VDIR && node->tn_dir.tn_parent == NULL) ||
501		    ((vp->v_iflag & VI_DOOMED) != 0 &&
502		    (lkflag & LK_NOWAIT) != 0)) {
503			VI_UNLOCK(vp);
504			TMPFS_NODE_UNLOCK(node);
505			error = ENOENT;
506			vp = NULL;
507			goto out;
508		}
509		if ((vp->v_iflag & VI_DOOMED) != 0) {
510			VI_UNLOCK(vp);
511			node->tn_vpstate |= TMPFS_VNODE_WRECLAIM;
512			while ((node->tn_vpstate & TMPFS_VNODE_WRECLAIM) != 0) {
513				msleep(&node->tn_vnode, TMPFS_NODE_MTX(node),
514				    0, "tmpfsE", 0);
515			}
516			goto loop1;
517		}
518		TMPFS_NODE_UNLOCK(node);
519		error = vget(vp, lkflag | LK_INTERLOCK, curthread);
520		if (error == ENOENT)
521			goto loop;
522		if (error != 0) {
523			vp = NULL;
524			goto out;
525		}
526
527		/*
528		 * Make sure the vnode is still there after
529		 * getting the interlock to avoid racing a free.
530		 */
531		if (node->tn_vnode == NULL || node->tn_vnode != vp) {
532			vput(vp);
533			goto loop;
534		}
535
536		goto out;
537	}
538
539	if ((node->tn_vpstate & TMPFS_VNODE_DOOMED) ||
540	    (node->tn_type == VDIR && node->tn_dir.tn_parent == NULL)) {
541		TMPFS_NODE_UNLOCK(node);
542		error = ENOENT;
543		vp = NULL;
544		goto out;
545	}
546
547	/*
548	 * otherwise lock the vp list while we call getnewvnode
549	 * since that can block.
550	 */
551	if (node->tn_vpstate & TMPFS_VNODE_ALLOCATING) {
552		node->tn_vpstate |= TMPFS_VNODE_WANT;
553		error = msleep((caddr_t) &node->tn_vpstate,
554		    TMPFS_NODE_MTX(node), PDROP | PCATCH,
555		    "tmpfs_alloc_vp", 0);
556		if (error)
557			return error;
558
559		goto loop;
560	} else
561		node->tn_vpstate |= TMPFS_VNODE_ALLOCATING;
562
563	TMPFS_NODE_UNLOCK(node);
564
565	/* Get a new vnode and associate it with our node. */
566	error = getnewvnode("tmpfs", mp, &tmpfs_vnodeop_entries, &vp);
567	if (error != 0)
568		goto unlock;
569	MPASS(vp != NULL);
570
571	/* lkflag is ignored, the lock is exclusive */
572	(void) vn_lock(vp, lkflag | LK_RETRY);
573
574	vp->v_data = node;
575	vp->v_type = node->tn_type;
576
577	/* Type-specific initialization. */
578	switch (node->tn_type) {
579	case VBLK:
580		/* FALLTHROUGH */
581	case VCHR:
582		/* FALLTHROUGH */
583	case VLNK:
584		/* FALLTHROUGH */
585	case VSOCK:
586		break;
587	case VFIFO:
588		vp->v_op = &tmpfs_fifoop_entries;
589		break;
590	case VREG:
591		object = node->tn_reg.tn_aobj;
592		VM_OBJECT_WLOCK(object);
593		VI_LOCK(vp);
594		KASSERT(vp->v_object == NULL, ("Not NULL v_object in tmpfs"));
595		vp->v_object = object;
596		object->un_pager.swp.swp_tmpfs = vp;
597		vm_object_set_flag(object, OBJ_TMPFS);
598		VI_UNLOCK(vp);
599		VM_OBJECT_WUNLOCK(object);
600		break;
601	case VDIR:
602		MPASS(node->tn_dir.tn_parent != NULL);
603		if (node->tn_dir.tn_parent == node)
604			vp->v_vflag |= VV_ROOT;
605		break;
606
607	default:
608		panic("tmpfs_alloc_vp: type %p %d", node, (int)node->tn_type);
609	}
610	if (vp->v_type != VFIFO)
611		VN_LOCK_ASHARE(vp);
612
613	error = insmntque1(vp, mp, tmpfs_insmntque_dtr, NULL);
614	if (error)
615		vp = NULL;
616
617unlock:
618	TMPFS_NODE_LOCK(node);
619
620	MPASS(node->tn_vpstate & TMPFS_VNODE_ALLOCATING);
621	node->tn_vpstate &= ~TMPFS_VNODE_ALLOCATING;
622	node->tn_vnode = vp;
623
624	if (node->tn_vpstate & TMPFS_VNODE_WANT) {
625		node->tn_vpstate &= ~TMPFS_VNODE_WANT;
626		TMPFS_NODE_UNLOCK(node);
627		wakeup((caddr_t) &node->tn_vpstate);
628	} else
629		TMPFS_NODE_UNLOCK(node);
630
631out:
632	*vpp = vp;
633
634#ifdef INVARIANTS
635	if (error == 0) {
636		MPASS(*vpp != NULL && VOP_ISLOCKED(*vpp));
637		TMPFS_NODE_LOCK(node);
638		MPASS(*vpp == node->tn_vnode);
639		TMPFS_NODE_UNLOCK(node);
640	}
641#endif
642
643	return error;
644}
645
646/*
647 * Destroys the association between the vnode vp and the node it
648 * references.
649 */
650void
651tmpfs_free_vp(struct vnode *vp)
652{
653	struct tmpfs_node *node;
654
655	node = VP_TO_TMPFS_NODE(vp);
656
657	TMPFS_NODE_ASSERT_LOCKED(node);
658	node->tn_vnode = NULL;
659	if ((node->tn_vpstate & TMPFS_VNODE_WRECLAIM) != 0)
660		wakeup(&node->tn_vnode);
661	node->tn_vpstate &= ~TMPFS_VNODE_WRECLAIM;
662	vp->v_data = NULL;
663}
664
665/*
666 * Allocates a new file of type 'type' and adds it to the parent directory
667 * 'dvp'; this addition is done using the component name given in 'cnp'.
668 * The ownership of the new file is automatically assigned based on the
669 * credentials of the caller (through 'cnp'), the group is set based on
670 * the parent directory and the mode is determined from the 'vap' argument.
671 * If successful, *vpp holds a vnode to the newly created file and zero
672 * is returned.  Otherwise *vpp is NULL and the function returns an
673 * appropriate error code.
674 */
675int
676tmpfs_alloc_file(struct vnode *dvp, struct vnode **vpp, struct vattr *vap,
677    struct componentname *cnp, char *target)
678{
679	int error;
680	struct tmpfs_dirent *de;
681	struct tmpfs_mount *tmp;
682	struct tmpfs_node *dnode;
683	struct tmpfs_node *node;
684	struct tmpfs_node *parent;
685
686	MPASS(VOP_ISLOCKED(dvp));
687	MPASS(cnp->cn_flags & HASBUF);
688
689	tmp = VFS_TO_TMPFS(dvp->v_mount);
690	dnode = VP_TO_TMPFS_DIR(dvp);
691	*vpp = NULL;
692
693	/* If the entry we are creating is a directory, we cannot overflow
694	 * the number of links of its parent, because it will get a new
695	 * link. */
696	if (vap->va_type == VDIR) {
697		/* Ensure that we do not overflow the maximum number of links
698		 * imposed by the system. */
699		MPASS(dnode->tn_links <= LINK_MAX);
700		if (dnode->tn_links == LINK_MAX) {
701			return (EMLINK);
702		}
703
704		parent = dnode;
705		MPASS(parent != NULL);
706	} else
707		parent = NULL;
708
709	/* Allocate a node that represents the new file. */
710	error = tmpfs_alloc_node(dvp->v_mount, tmp, vap->va_type,
711	    cnp->cn_cred->cr_uid,
712	    dnode->tn_gid, vap->va_mode, parent, target, vap->va_rdev, &node);
713	if (error != 0)
714		return (error);
715
716	/* Allocate a directory entry that points to the new file. */
717	error = tmpfs_alloc_dirent(tmp, node, cnp->cn_nameptr, cnp->cn_namelen,
718	    &de);
719	if (error != 0) {
720		tmpfs_free_node(tmp, node);
721		return (error);
722	}
723
724	/* Allocate a vnode for the new file. */
725	error = tmpfs_alloc_vp(dvp->v_mount, node, LK_EXCLUSIVE, vpp);
726	if (error != 0) {
727		tmpfs_free_dirent(tmp, de);
728		tmpfs_free_node(tmp, node);
729		return (error);
730	}
731
732	/* Now that all required items are allocated, we can proceed to
733	 * insert the new node into the directory, an operation that
734	 * cannot fail. */
735	if (cnp->cn_flags & ISWHITEOUT)
736		tmpfs_dir_whiteout_remove(dvp, cnp);
737	tmpfs_dir_attach(dvp, de);
738	return (0);
739}
740
741static struct tmpfs_dirent *
742tmpfs_dir_first(struct tmpfs_node *dnode, struct tmpfs_dir_cursor *dc)
743{
744	struct tmpfs_dirent *de;
745
746	de = RB_MIN(tmpfs_dir, &dnode->tn_dir.tn_dirhead);
747	dc->tdc_tree = de;
748	if (de != NULL && tmpfs_dirent_duphead(de))
749		de = LIST_FIRST(&de->ud.td_duphead);
750	dc->tdc_current = de;
751
752	return (dc->tdc_current);
753}
754
755static struct tmpfs_dirent *
756tmpfs_dir_next(struct tmpfs_node *dnode, struct tmpfs_dir_cursor *dc)
757{
758	struct tmpfs_dirent *de;
759
760	MPASS(dc->tdc_tree != NULL);
761	if (tmpfs_dirent_dup(dc->tdc_current)) {
762		dc->tdc_current = LIST_NEXT(dc->tdc_current, uh.td_dup.entries);
763		if (dc->tdc_current != NULL)
764			return (dc->tdc_current);
765	}
766	dc->tdc_tree = dc->tdc_current = RB_NEXT(tmpfs_dir,
767	    &dnode->tn_dir.tn_dirhead, dc->tdc_tree);
768	if ((de = dc->tdc_current) != NULL && tmpfs_dirent_duphead(de)) {
769		dc->tdc_current = LIST_FIRST(&de->ud.td_duphead);
770		MPASS(dc->tdc_current != NULL);
771	}
772
773	return (dc->tdc_current);
774}
775
776/* Lookup directory entry in RB-Tree. Function may return duphead entry. */
777static struct tmpfs_dirent *
778tmpfs_dir_xlookup_hash(struct tmpfs_node *dnode, uint32_t hash)
779{
780	struct tmpfs_dirent *de, dekey;
781
782	dekey.td_hash = hash;
783	de = RB_FIND(tmpfs_dir, &dnode->tn_dir.tn_dirhead, &dekey);
784	return (de);
785}
786
787/* Lookup directory entry by cookie, initialize directory cursor accordingly. */
788static struct tmpfs_dirent *
789tmpfs_dir_lookup_cookie(struct tmpfs_node *node, off_t cookie,
790    struct tmpfs_dir_cursor *dc)
791{
792	struct tmpfs_dir *dirhead = &node->tn_dir.tn_dirhead;
793	struct tmpfs_dirent *de, dekey;
794
795	MPASS(cookie >= TMPFS_DIRCOOKIE_MIN);
796
797	if (cookie == node->tn_dir.tn_readdir_lastn &&
798	    (de = node->tn_dir.tn_readdir_lastp) != NULL) {
799		/* Protect against possible race, tn_readdir_last[pn]
800		 * may be updated with only shared vnode lock held. */
801		if (cookie == tmpfs_dirent_cookie(de))
802			goto out;
803	}
804
805	if ((cookie & TMPFS_DIRCOOKIE_DUP) != 0) {
806		LIST_FOREACH(de, &node->tn_dir.tn_dupindex,
807		    uh.td_dup.index_entries) {
808			MPASS(tmpfs_dirent_dup(de));
809			if (de->td_cookie == cookie)
810				goto out;
811			/* dupindex list is sorted. */
812			if (de->td_cookie < cookie) {
813				de = NULL;
814				goto out;
815			}
816		}
817		MPASS(de == NULL);
818		goto out;
819	}
820
821	if ((cookie & TMPFS_DIRCOOKIE_MASK) != cookie) {
822		de = NULL;
823	} else {
824		dekey.td_hash = cookie;
825		/* Recover if direntry for cookie was removed */
826		de = RB_NFIND(tmpfs_dir, dirhead, &dekey);
827	}
828	dc->tdc_tree = de;
829	dc->tdc_current = de;
830	if (de != NULL && tmpfs_dirent_duphead(de)) {
831		dc->tdc_current = LIST_FIRST(&de->ud.td_duphead);
832		MPASS(dc->tdc_current != NULL);
833	}
834	return (dc->tdc_current);
835
836out:
837	dc->tdc_tree = de;
838	dc->tdc_current = de;
839	if (de != NULL && tmpfs_dirent_dup(de))
840		dc->tdc_tree = tmpfs_dir_xlookup_hash(node,
841		    de->td_hash);
842	return (dc->tdc_current);
843}
844
845/*
846 * Looks for a directory entry in the directory represented by node.
847 * 'cnp' describes the name of the entry to look for.  Note that the .
848 * and .. components are not allowed as they do not physically exist
849 * within directories.
850 *
851 * Returns a pointer to the entry when found, otherwise NULL.
852 */
853struct tmpfs_dirent *
854tmpfs_dir_lookup(struct tmpfs_node *node, struct tmpfs_node *f,
855    struct componentname *cnp)
856{
857	struct tmpfs_dir_duphead *duphead;
858	struct tmpfs_dirent *de;
859	uint32_t hash;
860
861	MPASS(IMPLIES(cnp->cn_namelen == 1, cnp->cn_nameptr[0] != '.'));
862	MPASS(IMPLIES(cnp->cn_namelen == 2, !(cnp->cn_nameptr[0] == '.' &&
863	    cnp->cn_nameptr[1] == '.')));
864	TMPFS_VALIDATE_DIR(node);
865
866	hash = tmpfs_dirent_hash(cnp->cn_nameptr, cnp->cn_namelen);
867	de = tmpfs_dir_xlookup_hash(node, hash);
868	if (de != NULL && tmpfs_dirent_duphead(de)) {
869		duphead = &de->ud.td_duphead;
870		LIST_FOREACH(de, duphead, uh.td_dup.entries) {
871			if (TMPFS_DIRENT_MATCHES(de, cnp->cn_nameptr,
872			    cnp->cn_namelen))
873				break;
874		}
875	} else if (de != NULL) {
876		if (!TMPFS_DIRENT_MATCHES(de, cnp->cn_nameptr,
877		    cnp->cn_namelen))
878			de = NULL;
879	}
880	if (de != NULL && f != NULL && de->td_node != f)
881		de = NULL;
882
883	return (de);
884}
885
886/*
887 * Attach duplicate-cookie directory entry nde to dnode and insert to dupindex
888 * list, allocate new cookie value.
889 */
890static void
891tmpfs_dir_attach_dup(struct tmpfs_node *dnode,
892    struct tmpfs_dir_duphead *duphead, struct tmpfs_dirent *nde)
893{
894	struct tmpfs_dir_duphead *dupindex;
895	struct tmpfs_dirent *de, *pde;
896
897	dupindex = &dnode->tn_dir.tn_dupindex;
898	de = LIST_FIRST(dupindex);
899	if (de == NULL || de->td_cookie < TMPFS_DIRCOOKIE_DUP_MAX) {
900		if (de == NULL)
901			nde->td_cookie = TMPFS_DIRCOOKIE_DUP_MIN;
902		else
903			nde->td_cookie = de->td_cookie + 1;
904		MPASS(tmpfs_dirent_dup(nde));
905		LIST_INSERT_HEAD(dupindex, nde, uh.td_dup.index_entries);
906		LIST_INSERT_HEAD(duphead, nde, uh.td_dup.entries);
907		return;
908	}
909
910	/*
911	 * Cookie numbers are near exhaustion. Scan dupindex list for unused
912	 * numbers. dupindex list is sorted in descending order. Keep it so
913	 * after inserting nde.
914	 */
915	while (1) {
916		pde = de;
917		de = LIST_NEXT(de, uh.td_dup.index_entries);
918		if (de == NULL && pde->td_cookie != TMPFS_DIRCOOKIE_DUP_MIN) {
919			/*
920			 * Last element of the index doesn't have minimal cookie
921			 * value, use it.
922			 */
923			nde->td_cookie = TMPFS_DIRCOOKIE_DUP_MIN;
924			LIST_INSERT_AFTER(pde, nde, uh.td_dup.index_entries);
925			LIST_INSERT_HEAD(duphead, nde, uh.td_dup.entries);
926			return;
927		} else if (de == NULL) {
928			/*
929			 * We are so lucky have 2^30 hash duplicates in single
930			 * directory :) Return largest possible cookie value.
931			 * It should be fine except possible issues with
932			 * VOP_READDIR restart.
933			 */
934			nde->td_cookie = TMPFS_DIRCOOKIE_DUP_MAX;
935			LIST_INSERT_HEAD(dupindex, nde,
936			    uh.td_dup.index_entries);
937			LIST_INSERT_HEAD(duphead, nde, uh.td_dup.entries);
938			return;
939		}
940		if (de->td_cookie + 1 == pde->td_cookie ||
941		    de->td_cookie >= TMPFS_DIRCOOKIE_DUP_MAX)
942			continue;	/* No hole or invalid cookie. */
943		nde->td_cookie = de->td_cookie + 1;
944		MPASS(tmpfs_dirent_dup(nde));
945		MPASS(pde->td_cookie > nde->td_cookie);
946		MPASS(nde->td_cookie > de->td_cookie);
947		LIST_INSERT_BEFORE(de, nde, uh.td_dup.index_entries);
948		LIST_INSERT_HEAD(duphead, nde, uh.td_dup.entries);
949		return;
950	};
951}
952
953/*
954 * Attaches the directory entry de to the directory represented by vp.
955 * Note that this does not change the link count of the node pointed by
956 * the directory entry, as this is done by tmpfs_alloc_dirent.
957 */
958void
959tmpfs_dir_attach(struct vnode *vp, struct tmpfs_dirent *de)
960{
961	struct tmpfs_node *dnode;
962	struct tmpfs_dirent *xde, *nde;
963
964	ASSERT_VOP_ELOCKED(vp, __func__);
965	MPASS(de->td_namelen > 0);
966	MPASS(de->td_hash >= TMPFS_DIRCOOKIE_MIN);
967	MPASS(de->td_cookie == de->td_hash);
968
969	dnode = VP_TO_TMPFS_DIR(vp);
970	dnode->tn_dir.tn_readdir_lastn = 0;
971	dnode->tn_dir.tn_readdir_lastp = NULL;
972
973	MPASS(!tmpfs_dirent_dup(de));
974	xde = RB_INSERT(tmpfs_dir, &dnode->tn_dir.tn_dirhead, de);
975	if (xde != NULL && tmpfs_dirent_duphead(xde))
976		tmpfs_dir_attach_dup(dnode, &xde->ud.td_duphead, de);
977	else if (xde != NULL) {
978		/*
979		 * Allocate new duphead. Swap xde with duphead to avoid
980		 * adding/removing elements with the same hash.
981		 */
982		MPASS(!tmpfs_dirent_dup(xde));
983		tmpfs_alloc_dirent(VFS_TO_TMPFS(vp->v_mount), NULL, NULL, 0,
984		    &nde);
985		/* *nde = *xde; XXX gcc 4.2.1 may generate invalid code. */
986		memcpy(nde, xde, sizeof(*xde));
987		xde->td_cookie |= TMPFS_DIRCOOKIE_DUPHEAD;
988		LIST_INIT(&xde->ud.td_duphead);
989		xde->td_namelen = 0;
990		xde->td_node = NULL;
991		tmpfs_dir_attach_dup(dnode, &xde->ud.td_duphead, nde);
992		tmpfs_dir_attach_dup(dnode, &xde->ud.td_duphead, de);
993	}
994	dnode->tn_size += sizeof(struct tmpfs_dirent);
995	dnode->tn_status |= TMPFS_NODE_ACCESSED | TMPFS_NODE_CHANGED | \
996	    TMPFS_NODE_MODIFIED;
997	tmpfs_update(vp);
998}
999
1000/*
1001 * Detaches the directory entry de from the directory represented by vp.
1002 * Note that this does not change the link count of the node pointed by
1003 * the directory entry, as this is done by tmpfs_free_dirent.
1004 */
1005void
1006tmpfs_dir_detach(struct vnode *vp, struct tmpfs_dirent *de)
1007{
1008	struct tmpfs_mount *tmp;
1009	struct tmpfs_dir *head;
1010	struct tmpfs_node *dnode;
1011	struct tmpfs_dirent *xde;
1012
1013	ASSERT_VOP_ELOCKED(vp, __func__);
1014
1015	dnode = VP_TO_TMPFS_DIR(vp);
1016	head = &dnode->tn_dir.tn_dirhead;
1017	dnode->tn_dir.tn_readdir_lastn = 0;
1018	dnode->tn_dir.tn_readdir_lastp = NULL;
1019
1020	if (tmpfs_dirent_dup(de)) {
1021		/* Remove duphead if de was last entry. */
1022		if (LIST_NEXT(de, uh.td_dup.entries) == NULL) {
1023			xde = tmpfs_dir_xlookup_hash(dnode, de->td_hash);
1024			MPASS(tmpfs_dirent_duphead(xde));
1025		} else
1026			xde = NULL;
1027		LIST_REMOVE(de, uh.td_dup.entries);
1028		LIST_REMOVE(de, uh.td_dup.index_entries);
1029		if (xde != NULL) {
1030			if (LIST_EMPTY(&xde->ud.td_duphead)) {
1031				RB_REMOVE(tmpfs_dir, head, xde);
1032				tmp = VFS_TO_TMPFS(vp->v_mount);
1033				MPASS(xde->td_node == NULL);
1034				tmpfs_free_dirent(tmp, xde);
1035			}
1036		}
1037		de->td_cookie = de->td_hash;
1038	} else
1039		RB_REMOVE(tmpfs_dir, head, de);
1040
1041	dnode->tn_size -= sizeof(struct tmpfs_dirent);
1042	dnode->tn_status |= TMPFS_NODE_ACCESSED | TMPFS_NODE_CHANGED | \
1043	    TMPFS_NODE_MODIFIED;
1044	tmpfs_update(vp);
1045}
1046
1047void
1048tmpfs_dir_destroy(struct tmpfs_mount *tmp, struct tmpfs_node *dnode)
1049{
1050	struct tmpfs_dirent *de, *dde, *nde;
1051
1052	RB_FOREACH_SAFE(de, tmpfs_dir, &dnode->tn_dir.tn_dirhead, nde) {
1053		RB_REMOVE(tmpfs_dir, &dnode->tn_dir.tn_dirhead, de);
1054		/* Node may already be destroyed. */
1055		de->td_node = NULL;
1056		if (tmpfs_dirent_duphead(de)) {
1057			while ((dde = LIST_FIRST(&de->ud.td_duphead)) != NULL) {
1058				LIST_REMOVE(dde, uh.td_dup.entries);
1059				dde->td_node = NULL;
1060				tmpfs_free_dirent(tmp, dde);
1061			}
1062		}
1063		tmpfs_free_dirent(tmp, de);
1064	}
1065}
1066
1067/*
1068 * Helper function for tmpfs_readdir.  Creates a '.' entry for the given
1069 * directory and returns it in the uio space.  The function returns 0
1070 * on success, -1 if there was not enough space in the uio structure to
1071 * hold the directory entry or an appropriate error code if another
1072 * error happens.
1073 */
1074static int
1075tmpfs_dir_getdotdent(struct tmpfs_node *node, struct uio *uio)
1076{
1077	int error;
1078	struct dirent dent;
1079
1080	TMPFS_VALIDATE_DIR(node);
1081	MPASS(uio->uio_offset == TMPFS_DIRCOOKIE_DOT);
1082
1083	dent.d_fileno = node->tn_id;
1084	dent.d_type = DT_DIR;
1085	dent.d_namlen = 1;
1086	dent.d_name[0] = '.';
1087	dent.d_name[1] = '\0';
1088	dent.d_reclen = GENERIC_DIRSIZ(&dent);
1089
1090	if (dent.d_reclen > uio->uio_resid)
1091		error = EJUSTRETURN;
1092	else
1093		error = uiomove(&dent, dent.d_reclen, uio);
1094
1095	node->tn_status |= TMPFS_NODE_ACCESSED;
1096
1097	return error;
1098}
1099
1100/*
1101 * Helper function for tmpfs_readdir.  Creates a '..' entry for the given
1102 * directory and returns it in the uio space.  The function returns 0
1103 * on success, -1 if there was not enough space in the uio structure to
1104 * hold the directory entry or an appropriate error code if another
1105 * error happens.
1106 */
1107static int
1108tmpfs_dir_getdotdotdent(struct tmpfs_node *node, struct uio *uio)
1109{
1110	int error;
1111	struct dirent dent;
1112
1113	TMPFS_VALIDATE_DIR(node);
1114	MPASS(uio->uio_offset == TMPFS_DIRCOOKIE_DOTDOT);
1115
1116	/*
1117	 * Return ENOENT if the current node is already removed.
1118	 */
1119	TMPFS_ASSERT_LOCKED(node);
1120	if (node->tn_dir.tn_parent == NULL) {
1121		return (ENOENT);
1122	}
1123
1124	TMPFS_NODE_LOCK(node->tn_dir.tn_parent);
1125	dent.d_fileno = node->tn_dir.tn_parent->tn_id;
1126	TMPFS_NODE_UNLOCK(node->tn_dir.tn_parent);
1127
1128	dent.d_type = DT_DIR;
1129	dent.d_namlen = 2;
1130	dent.d_name[0] = '.';
1131	dent.d_name[1] = '.';
1132	dent.d_name[2] = '\0';
1133	dent.d_reclen = GENERIC_DIRSIZ(&dent);
1134
1135	if (dent.d_reclen > uio->uio_resid)
1136		error = EJUSTRETURN;
1137	else
1138		error = uiomove(&dent, dent.d_reclen, uio);
1139
1140	node->tn_status |= TMPFS_NODE_ACCESSED;
1141
1142	return error;
1143}
1144
1145/*
1146 * Helper function for tmpfs_readdir.  Returns as much directory entries
1147 * as can fit in the uio space.  The read starts at uio->uio_offset.
1148 * The function returns 0 on success, -1 if there was not enough space
1149 * in the uio structure to hold the directory entry or an appropriate
1150 * error code if another error happens.
1151 */
1152int
1153tmpfs_dir_getdents(struct tmpfs_node *node, struct uio *uio, int maxcookies,
1154    u_long *cookies, int *ncookies)
1155{
1156	struct tmpfs_dir_cursor dc;
1157	struct tmpfs_dirent *de;
1158	off_t off;
1159	int error;
1160
1161	TMPFS_VALIDATE_DIR(node);
1162
1163	off = 0;
1164
1165	/*
1166	 * Lookup the node from the current offset.  The starting offset of
1167	 * 0 will lookup both '.' and '..', and then the first real entry,
1168	 * or EOF if there are none.  Then find all entries for the dir that
1169	 * fit into the buffer.  Once no more entries are found (de == NULL),
1170	 * the offset is set to TMPFS_DIRCOOKIE_EOF, which will cause the next
1171	 * call to return 0.
1172	 */
1173	switch (uio->uio_offset) {
1174	case TMPFS_DIRCOOKIE_DOT:
1175		error = tmpfs_dir_getdotdent(node, uio);
1176		if (error != 0)
1177			return (error);
1178		uio->uio_offset = TMPFS_DIRCOOKIE_DOTDOT;
1179		if (cookies != NULL)
1180			cookies[(*ncookies)++] = off = uio->uio_offset;
1181		/* FALLTHROUGH */
1182	case TMPFS_DIRCOOKIE_DOTDOT:
1183		error = tmpfs_dir_getdotdotdent(node, uio);
1184		if (error != 0)
1185			return (error);
1186		de = tmpfs_dir_first(node, &dc);
1187		uio->uio_offset = tmpfs_dirent_cookie(de);
1188		if (cookies != NULL)
1189			cookies[(*ncookies)++] = off = uio->uio_offset;
1190		/* EOF. */
1191		if (de == NULL)
1192			return (0);
1193		break;
1194	case TMPFS_DIRCOOKIE_EOF:
1195		return (0);
1196	default:
1197		de = tmpfs_dir_lookup_cookie(node, uio->uio_offset, &dc);
1198		if (de == NULL)
1199			return (EINVAL);
1200		if (cookies != NULL)
1201			off = tmpfs_dirent_cookie(de);
1202	}
1203
1204	/* Read as much entries as possible; i.e., until we reach the end of
1205	 * the directory or we exhaust uio space. */
1206	do {
1207		struct dirent d;
1208
1209		/* Create a dirent structure representing the current
1210		 * tmpfs_node and fill it. */
1211		if (de->td_node == NULL) {
1212			d.d_fileno = 1;
1213			d.d_type = DT_WHT;
1214		} else {
1215			d.d_fileno = de->td_node->tn_id;
1216			switch (de->td_node->tn_type) {
1217			case VBLK:
1218				d.d_type = DT_BLK;
1219				break;
1220
1221			case VCHR:
1222				d.d_type = DT_CHR;
1223				break;
1224
1225			case VDIR:
1226				d.d_type = DT_DIR;
1227				break;
1228
1229			case VFIFO:
1230				d.d_type = DT_FIFO;
1231				break;
1232
1233			case VLNK:
1234				d.d_type = DT_LNK;
1235				break;
1236
1237			case VREG:
1238				d.d_type = DT_REG;
1239				break;
1240
1241			case VSOCK:
1242				d.d_type = DT_SOCK;
1243				break;
1244
1245			default:
1246				panic("tmpfs_dir_getdents: type %p %d",
1247				    de->td_node, (int)de->td_node->tn_type);
1248			}
1249		}
1250		d.d_namlen = de->td_namelen;
1251		MPASS(de->td_namelen < sizeof(d.d_name));
1252		(void)memcpy(d.d_name, de->ud.td_name, de->td_namelen);
1253		d.d_name[de->td_namelen] = '\0';
1254		d.d_reclen = GENERIC_DIRSIZ(&d);
1255
1256		/* Stop reading if the directory entry we are treating is
1257		 * bigger than the amount of data that can be returned. */
1258		if (d.d_reclen > uio->uio_resid) {
1259			error = EJUSTRETURN;
1260			break;
1261		}
1262
1263		/* Copy the new dirent structure into the output buffer and
1264		 * advance pointers. */
1265		error = uiomove(&d, d.d_reclen, uio);
1266		if (error == 0) {
1267			de = tmpfs_dir_next(node, &dc);
1268			if (cookies != NULL) {
1269				off = tmpfs_dirent_cookie(de);
1270				MPASS(*ncookies < maxcookies);
1271				cookies[(*ncookies)++] = off;
1272			}
1273		}
1274	} while (error == 0 && uio->uio_resid > 0 && de != NULL);
1275
1276	/* Skip setting off when using cookies as it is already done above. */
1277	if (cookies == NULL)
1278		off = tmpfs_dirent_cookie(de);
1279
1280	/* Update the offset and cache. */
1281	uio->uio_offset = off;
1282	node->tn_dir.tn_readdir_lastn = off;
1283	node->tn_dir.tn_readdir_lastp = de;
1284
1285	node->tn_status |= TMPFS_NODE_ACCESSED;
1286	return error;
1287}
1288
1289int
1290tmpfs_dir_whiteout_add(struct vnode *dvp, struct componentname *cnp)
1291{
1292	struct tmpfs_dirent *de;
1293	int error;
1294
1295	error = tmpfs_alloc_dirent(VFS_TO_TMPFS(dvp->v_mount), NULL,
1296	    cnp->cn_nameptr, cnp->cn_namelen, &de);
1297	if (error != 0)
1298		return (error);
1299	tmpfs_dir_attach(dvp, de);
1300	return (0);
1301}
1302
1303void
1304tmpfs_dir_whiteout_remove(struct vnode *dvp, struct componentname *cnp)
1305{
1306	struct tmpfs_dirent *de;
1307
1308	de = tmpfs_dir_lookup(VP_TO_TMPFS_DIR(dvp), NULL, cnp);
1309	MPASS(de != NULL && de->td_node == NULL);
1310	tmpfs_dir_detach(dvp, de);
1311	tmpfs_free_dirent(VFS_TO_TMPFS(dvp->v_mount), de);
1312}
1313
1314/*
1315 * Resizes the aobj associated with the regular file pointed to by 'vp' to the
1316 * size 'newsize'.  'vp' must point to a vnode that represents a regular file.
1317 * 'newsize' must be positive.
1318 *
1319 * Returns zero on success or an appropriate error code on failure.
1320 */
1321int
1322tmpfs_reg_resize(struct vnode *vp, off_t newsize, boolean_t ignerr)
1323{
1324	struct tmpfs_mount *tmp;
1325	struct tmpfs_node *node;
1326	vm_object_t uobj;
1327	vm_page_t m, ma[1];
1328	vm_pindex_t idx, newpages, oldpages;
1329	off_t oldsize;
1330	int base, rv;
1331
1332	MPASS(vp->v_type == VREG);
1333	MPASS(newsize >= 0);
1334
1335	node = VP_TO_TMPFS_NODE(vp);
1336	uobj = node->tn_reg.tn_aobj;
1337	tmp = VFS_TO_TMPFS(vp->v_mount);
1338
1339	/*
1340	 * Convert the old and new sizes to the number of pages needed to
1341	 * store them.  It may happen that we do not need to do anything
1342	 * because the last allocated page can accommodate the change on
1343	 * its own.
1344	 */
1345	oldsize = node->tn_size;
1346	oldpages = OFF_TO_IDX(oldsize + PAGE_MASK);
1347	MPASS(oldpages == uobj->size);
1348	newpages = OFF_TO_IDX(newsize + PAGE_MASK);
1349	if (newpages > oldpages &&
1350	    tmpfs_pages_check_avail(tmp, newpages - oldpages) == 0)
1351		return (ENOSPC);
1352
1353	VM_OBJECT_WLOCK(uobj);
1354	if (newsize < oldsize) {
1355		/*
1356		 * Zero the truncated part of the last page.
1357		 */
1358		base = newsize & PAGE_MASK;
1359		if (base != 0) {
1360			idx = OFF_TO_IDX(newsize);
1361retry:
1362			m = vm_page_lookup(uobj, idx);
1363			if (m != NULL) {
1364				if (vm_page_sleep_if_busy(m, "tmfssz"))
1365					goto retry;
1366				MPASS(m->valid == VM_PAGE_BITS_ALL);
1367			} else if (vm_pager_has_page(uobj, idx, NULL, NULL)) {
1368				m = vm_page_alloc(uobj, idx, VM_ALLOC_NORMAL);
1369				if (m == NULL) {
1370					VM_OBJECT_WUNLOCK(uobj);
1371					VM_WAIT;
1372					VM_OBJECT_WLOCK(uobj);
1373					goto retry;
1374				} else if (m->valid != VM_PAGE_BITS_ALL) {
1375					ma[0] = m;
1376					rv = vm_pager_get_pages(uobj, ma, 1, 0);
1377					m = vm_page_lookup(uobj, idx);
1378				} else
1379					/* A cached page was reactivated. */
1380					rv = VM_PAGER_OK;
1381				vm_page_lock(m);
1382				if (rv == VM_PAGER_OK) {
1383					vm_page_deactivate(m);
1384					vm_page_unlock(m);
1385					vm_page_xunbusy(m);
1386				} else {
1387					vm_page_free(m);
1388					vm_page_unlock(m);
1389					if (ignerr)
1390						m = NULL;
1391					else {
1392						VM_OBJECT_WUNLOCK(uobj);
1393						return (EIO);
1394					}
1395				}
1396			}
1397			if (m != NULL) {
1398				pmap_zero_page_area(m, base, PAGE_SIZE - base);
1399				vm_page_dirty(m);
1400				vm_pager_page_unswapped(m);
1401			}
1402		}
1403
1404		/*
1405		 * Release any swap space and free any whole pages.
1406		 */
1407		if (newpages < oldpages) {
1408			swap_pager_freespace(uobj, newpages, oldpages -
1409			    newpages);
1410			vm_object_page_remove(uobj, newpages, 0, 0);
1411		}
1412	}
1413	uobj->size = newpages;
1414	VM_OBJECT_WUNLOCK(uobj);
1415
1416	TMPFS_LOCK(tmp);
1417	tmp->tm_pages_used += (newpages - oldpages);
1418	TMPFS_UNLOCK(tmp);
1419
1420	node->tn_size = newsize;
1421	return (0);
1422}
1423
1424void
1425tmpfs_check_mtime(struct vnode *vp)
1426{
1427	struct tmpfs_node *node;
1428	struct vm_object *obj;
1429
1430	ASSERT_VOP_ELOCKED(vp, "check_mtime");
1431	if (vp->v_type != VREG)
1432		return;
1433	obj = vp->v_object;
1434	KASSERT((obj->flags & (OBJ_TMPFS_NODE | OBJ_TMPFS)) ==
1435	    (OBJ_TMPFS_NODE | OBJ_TMPFS), ("non-tmpfs obj"));
1436	/* unlocked read */
1437	if ((obj->flags & OBJ_TMPFS_DIRTY) != 0) {
1438		VM_OBJECT_WLOCK(obj);
1439		if ((obj->flags & OBJ_TMPFS_DIRTY) != 0) {
1440			obj->flags &= ~OBJ_TMPFS_DIRTY;
1441			node = VP_TO_TMPFS_NODE(vp);
1442			node->tn_status |= TMPFS_NODE_MODIFIED |
1443			    TMPFS_NODE_CHANGED;
1444		}
1445		VM_OBJECT_WUNLOCK(obj);
1446	}
1447}
1448
1449/*
1450 * Change flags of the given vnode.
1451 * Caller should execute tmpfs_update on vp after a successful execution.
1452 * The vnode must be locked on entry and remain locked on exit.
1453 */
1454int
1455tmpfs_chflags(struct vnode *vp, u_long flags, struct ucred *cred,
1456    struct thread *p)
1457{
1458	int error;
1459	struct tmpfs_node *node;
1460
1461	ASSERT_VOP_ELOCKED(vp, "chflags");
1462
1463	node = VP_TO_TMPFS_NODE(vp);
1464
1465	if ((flags & ~(SF_APPEND | SF_ARCHIVED | SF_IMMUTABLE | SF_NOUNLINK |
1466	    UF_APPEND | UF_ARCHIVE | UF_HIDDEN | UF_IMMUTABLE | UF_NODUMP |
1467	    UF_NOUNLINK | UF_OFFLINE | UF_OPAQUE | UF_READONLY | UF_REPARSE |
1468	    UF_SPARSE | UF_SYSTEM)) != 0)
1469		return (EOPNOTSUPP);
1470
1471	/* Disallow this operation if the file system is mounted read-only. */
1472	if (vp->v_mount->mnt_flag & MNT_RDONLY)
1473		return EROFS;
1474
1475	/*
1476	 * Callers may only modify the file flags on objects they
1477	 * have VADMIN rights for.
1478	 */
1479	if ((error = VOP_ACCESS(vp, VADMIN, cred, p)))
1480		return (error);
1481	/*
1482	 * Unprivileged processes are not permitted to unset system
1483	 * flags, or modify flags if any system flags are set.
1484	 */
1485	if (!priv_check_cred(cred, PRIV_VFS_SYSFLAGS, 0)) {
1486		if (node->tn_flags &
1487		    (SF_NOUNLINK | SF_IMMUTABLE | SF_APPEND)) {
1488			error = securelevel_gt(cred, 0);
1489			if (error)
1490				return (error);
1491		}
1492	} else {
1493		if (node->tn_flags &
1494		    (SF_NOUNLINK | SF_IMMUTABLE | SF_APPEND) ||
1495		    ((flags ^ node->tn_flags) & SF_SETTABLE))
1496			return (EPERM);
1497	}
1498	node->tn_flags = flags;
1499	node->tn_status |= TMPFS_NODE_CHANGED;
1500
1501	ASSERT_VOP_ELOCKED(vp, "chflags2");
1502
1503	return (0);
1504}
1505
1506/*
1507 * Change access mode on the given vnode.
1508 * Caller should execute tmpfs_update on vp after a successful execution.
1509 * The vnode must be locked on entry and remain locked on exit.
1510 */
1511int
1512tmpfs_chmod(struct vnode *vp, mode_t mode, struct ucred *cred, struct thread *p)
1513{
1514	int error;
1515	struct tmpfs_node *node;
1516
1517	ASSERT_VOP_ELOCKED(vp, "chmod");
1518
1519	node = VP_TO_TMPFS_NODE(vp);
1520
1521	/* Disallow this operation if the file system is mounted read-only. */
1522	if (vp->v_mount->mnt_flag & MNT_RDONLY)
1523		return EROFS;
1524
1525	/* Immutable or append-only files cannot be modified, either. */
1526	if (node->tn_flags & (IMMUTABLE | APPEND))
1527		return EPERM;
1528
1529	/*
1530	 * To modify the permissions on a file, must possess VADMIN
1531	 * for that file.
1532	 */
1533	if ((error = VOP_ACCESS(vp, VADMIN, cred, p)))
1534		return (error);
1535
1536	/*
1537	 * Privileged processes may set the sticky bit on non-directories,
1538	 * as well as set the setgid bit on a file with a group that the
1539	 * process is not a member of.
1540	 */
1541	if (vp->v_type != VDIR && (mode & S_ISTXT)) {
1542		if (priv_check_cred(cred, PRIV_VFS_STICKYFILE, 0))
1543			return (EFTYPE);
1544	}
1545	if (!groupmember(node->tn_gid, cred) && (mode & S_ISGID)) {
1546		error = priv_check_cred(cred, PRIV_VFS_SETGID, 0);
1547		if (error)
1548			return (error);
1549	}
1550
1551
1552	node->tn_mode &= ~ALLPERMS;
1553	node->tn_mode |= mode & ALLPERMS;
1554
1555	node->tn_status |= TMPFS_NODE_CHANGED;
1556
1557	ASSERT_VOP_ELOCKED(vp, "chmod2");
1558
1559	return (0);
1560}
1561
1562/*
1563 * Change ownership of the given vnode.  At least one of uid or gid must
1564 * be different than VNOVAL.  If one is set to that value, the attribute
1565 * is unchanged.
1566 * Caller should execute tmpfs_update on vp after a successful execution.
1567 * The vnode must be locked on entry and remain locked on exit.
1568 */
1569int
1570tmpfs_chown(struct vnode *vp, uid_t uid, gid_t gid, struct ucred *cred,
1571    struct thread *p)
1572{
1573	int error;
1574	struct tmpfs_node *node;
1575	uid_t ouid;
1576	gid_t ogid;
1577
1578	ASSERT_VOP_ELOCKED(vp, "chown");
1579
1580	node = VP_TO_TMPFS_NODE(vp);
1581
1582	/* Assign default values if they are unknown. */
1583	MPASS(uid != VNOVAL || gid != VNOVAL);
1584	if (uid == VNOVAL)
1585		uid = node->tn_uid;
1586	if (gid == VNOVAL)
1587		gid = node->tn_gid;
1588	MPASS(uid != VNOVAL && gid != VNOVAL);
1589
1590	/* Disallow this operation if the file system is mounted read-only. */
1591	if (vp->v_mount->mnt_flag & MNT_RDONLY)
1592		return EROFS;
1593
1594	/* Immutable or append-only files cannot be modified, either. */
1595	if (node->tn_flags & (IMMUTABLE | APPEND))
1596		return EPERM;
1597
1598	/*
1599	 * To modify the ownership of a file, must possess VADMIN for that
1600	 * file.
1601	 */
1602	if ((error = VOP_ACCESS(vp, VADMIN, cred, p)))
1603		return (error);
1604
1605	/*
1606	 * To change the owner of a file, or change the group of a file to a
1607	 * group of which we are not a member, the caller must have
1608	 * privilege.
1609	 */
1610	if ((uid != node->tn_uid ||
1611	    (gid != node->tn_gid && !groupmember(gid, cred))) &&
1612	    (error = priv_check_cred(cred, PRIV_VFS_CHOWN, 0)))
1613		return (error);
1614
1615	ogid = node->tn_gid;
1616	ouid = node->tn_uid;
1617
1618	node->tn_uid = uid;
1619	node->tn_gid = gid;
1620
1621	node->tn_status |= TMPFS_NODE_CHANGED;
1622
1623	if ((node->tn_mode & (S_ISUID | S_ISGID)) && (ouid != uid || ogid != gid)) {
1624		if (priv_check_cred(cred, PRIV_VFS_RETAINSUGID, 0))
1625			node->tn_mode &= ~(S_ISUID | S_ISGID);
1626	}
1627
1628	ASSERT_VOP_ELOCKED(vp, "chown2");
1629
1630	return (0);
1631}
1632
1633/*
1634 * Change size of the given vnode.
1635 * Caller should execute tmpfs_update on vp after a successful execution.
1636 * The vnode must be locked on entry and remain locked on exit.
1637 */
1638int
1639tmpfs_chsize(struct vnode *vp, u_quad_t size, struct ucred *cred,
1640    struct thread *p)
1641{
1642	int error;
1643	struct tmpfs_node *node;
1644
1645	ASSERT_VOP_ELOCKED(vp, "chsize");
1646
1647	node = VP_TO_TMPFS_NODE(vp);
1648
1649	/* Decide whether this is a valid operation based on the file type. */
1650	error = 0;
1651	switch (vp->v_type) {
1652	case VDIR:
1653		return EISDIR;
1654
1655	case VREG:
1656		if (vp->v_mount->mnt_flag & MNT_RDONLY)
1657			return EROFS;
1658		break;
1659
1660	case VBLK:
1661		/* FALLTHROUGH */
1662	case VCHR:
1663		/* FALLTHROUGH */
1664	case VFIFO:
1665		/* Allow modifications of special files even if in the file
1666		 * system is mounted read-only (we are not modifying the
1667		 * files themselves, but the objects they represent). */
1668		return 0;
1669
1670	default:
1671		/* Anything else is unsupported. */
1672		return EOPNOTSUPP;
1673	}
1674
1675	/* Immutable or append-only files cannot be modified, either. */
1676	if (node->tn_flags & (IMMUTABLE | APPEND))
1677		return EPERM;
1678
1679	error = tmpfs_truncate(vp, size);
1680	/* tmpfs_truncate will raise the NOTE_EXTEND and NOTE_ATTRIB kevents
1681	 * for us, as will update tn_status; no need to do that here. */
1682
1683	ASSERT_VOP_ELOCKED(vp, "chsize2");
1684
1685	return (error);
1686}
1687
1688/*
1689 * Change access and modification times of the given vnode.
1690 * Caller should execute tmpfs_update on vp after a successful execution.
1691 * The vnode must be locked on entry and remain locked on exit.
1692 */
1693int
1694tmpfs_chtimes(struct vnode *vp, struct vattr *vap,
1695    struct ucred *cred, struct thread *l)
1696{
1697	int error;
1698	struct tmpfs_node *node;
1699
1700	ASSERT_VOP_ELOCKED(vp, "chtimes");
1701
1702	node = VP_TO_TMPFS_NODE(vp);
1703
1704	/* Disallow this operation if the file system is mounted read-only. */
1705	if (vp->v_mount->mnt_flag & MNT_RDONLY)
1706		return EROFS;
1707
1708	/* Immutable or append-only files cannot be modified, either. */
1709	if (node->tn_flags & (IMMUTABLE | APPEND))
1710		return EPERM;
1711
1712	error = vn_utimes_perm(vp, vap, cred, l);
1713	if (error != 0)
1714		return (error);
1715
1716	if (vap->va_atime.tv_sec != VNOVAL && vap->va_atime.tv_nsec != VNOVAL)
1717		node->tn_status |= TMPFS_NODE_ACCESSED;
1718
1719	if (vap->va_mtime.tv_sec != VNOVAL && vap->va_mtime.tv_nsec != VNOVAL)
1720		node->tn_status |= TMPFS_NODE_MODIFIED;
1721
1722	if (vap->va_birthtime.tv_nsec != VNOVAL &&
1723	    vap->va_birthtime.tv_nsec != VNOVAL)
1724		node->tn_status |= TMPFS_NODE_MODIFIED;
1725
1726	tmpfs_itimes(vp, &vap->va_atime, &vap->va_mtime);
1727
1728	if (vap->va_birthtime.tv_nsec != VNOVAL &&
1729	    vap->va_birthtime.tv_nsec != VNOVAL)
1730		node->tn_birthtime = vap->va_birthtime;
1731	ASSERT_VOP_ELOCKED(vp, "chtimes2");
1732
1733	return (0);
1734}
1735
1736/* Sync timestamps */
1737void
1738tmpfs_itimes(struct vnode *vp, const struct timespec *acc,
1739    const struct timespec *mod)
1740{
1741	struct tmpfs_node *node;
1742	struct timespec now;
1743
1744	node = VP_TO_TMPFS_NODE(vp);
1745
1746	if ((node->tn_status & (TMPFS_NODE_ACCESSED | TMPFS_NODE_MODIFIED |
1747	    TMPFS_NODE_CHANGED)) == 0)
1748		return;
1749
1750	vfs_timestamp(&now);
1751	if (node->tn_status & TMPFS_NODE_ACCESSED) {
1752		if (acc == NULL)
1753			 acc = &now;
1754		node->tn_atime = *acc;
1755	}
1756	if (node->tn_status & TMPFS_NODE_MODIFIED) {
1757		if (mod == NULL)
1758			mod = &now;
1759		node->tn_mtime = *mod;
1760	}
1761	if (node->tn_status & TMPFS_NODE_CHANGED) {
1762		node->tn_ctime = now;
1763	}
1764	node->tn_status &=
1765	    ~(TMPFS_NODE_ACCESSED | TMPFS_NODE_MODIFIED | TMPFS_NODE_CHANGED);
1766}
1767
1768void
1769tmpfs_update(struct vnode *vp)
1770{
1771
1772	tmpfs_itimes(vp, NULL, NULL);
1773}
1774
1775int
1776tmpfs_truncate(struct vnode *vp, off_t length)
1777{
1778	int error;
1779	struct tmpfs_node *node;
1780
1781	node = VP_TO_TMPFS_NODE(vp);
1782
1783	if (length < 0) {
1784		error = EINVAL;
1785		goto out;
1786	}
1787
1788	if (node->tn_size == length) {
1789		error = 0;
1790		goto out;
1791	}
1792
1793	if (length > VFS_TO_TMPFS(vp->v_mount)->tm_maxfilesize)
1794		return (EFBIG);
1795
1796	error = tmpfs_reg_resize(vp, length, FALSE);
1797	if (error == 0) {
1798		node->tn_status |= TMPFS_NODE_CHANGED | TMPFS_NODE_MODIFIED;
1799	}
1800
1801out:
1802	tmpfs_update(vp);
1803
1804	return error;
1805}
1806
1807static __inline int
1808tmpfs_dirtree_cmp(struct tmpfs_dirent *a, struct tmpfs_dirent *b)
1809{
1810	if (a->td_hash > b->td_hash)
1811		return (1);
1812	else if (a->td_hash < b->td_hash)
1813		return (-1);
1814	return (0);
1815}
1816
1817RB_GENERATE_STATIC(tmpfs_dir, tmpfs_dirent, uh.td_entries, tmpfs_dirtree_cmp);
1818