]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/fs/tmpfs/tmpfs_subr.c
add -n option to suppress clearing the build tree and add -DNO_CLEAN
[FreeBSD/FreeBSD.git] / sys / fs / tmpfs / tmpfs_subr.c
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$");
38
39 #include <sys/param.h>
40 #include <sys/namei.h>
41 #include <sys/priv.h>
42 #include <sys/proc.h>
43 #include <sys/stat.h>
44 #include <sys/systm.h>
45 #include <sys/vnode.h>
46 #include <sys/vmmeter.h>
47
48 #include <vm/vm.h>
49 #include <vm/vm_object.h>
50 #include <vm/vm_page.h>
51 #include <vm/vm_pager.h>
52 #include <vm/vm_extern.h>
53
54 #include <fs/tmpfs/tmpfs.h>
55 #include <fs/tmpfs/tmpfs_fifoops.h>
56 #include <fs/tmpfs/tmpfs_vnops.h>
57
58 /* --------------------------------------------------------------------- */
59
60 /*
61  * Allocates a new node of type 'type' inside the 'tmp' mount point, with
62  * its owner set to 'uid', its group to 'gid' and its mode set to 'mode',
63  * using the credentials of the process 'p'.
64  *
65  * If the node type is set to 'VDIR', then the parent parameter must point
66  * to the parent directory of the node being created.  It may only be NULL
67  * while allocating the root node.
68  *
69  * If the node type is set to 'VBLK' or 'VCHR', then the rdev parameter
70  * specifies the device the node represents.
71  *
72  * If the node type is set to 'VLNK', then the parameter target specifies
73  * the file name of the target file for the symbolic link that is being
74  * created.
75  *
76  * Note that new nodes are retrieved from the available list if it has
77  * items or, if it is empty, from the node pool as long as there is enough
78  * space to create them.
79  *
80  * Returns zero on success or an appropriate error code on failure.
81  */
82 int
83 tmpfs_alloc_node(struct tmpfs_mount *tmp, enum vtype type,
84     uid_t uid, gid_t gid, mode_t mode, struct tmpfs_node *parent,
85     char *target, dev_t rdev, struct thread *p, struct tmpfs_node **node)
86 {
87         struct tmpfs_node *nnode;
88
89         /* If the root directory of the 'tmp' file system is not yet
90          * allocated, this must be the request to do it. */
91         MPASS(IMPLIES(tmp->tm_root == NULL, parent == NULL && type == VDIR));
92
93         MPASS(IFF(type == VLNK, target != NULL));
94         MPASS(IFF(type == VBLK || type == VCHR, rdev != VNOVAL));
95
96         if (tmp->tm_nodes_inuse > tmp->tm_nodes_max)
97                 return (ENOSPC);
98
99         nnode = (struct tmpfs_node *)uma_zalloc_arg(
100                                 tmp->tm_node_pool, tmp, M_WAITOK);
101
102         /* Generic initialization. */
103         nnode->tn_type = type;
104         vfs_timestamp(&nnode->tn_atime);
105         nnode->tn_birthtime = nnode->tn_ctime = nnode->tn_mtime =
106             nnode->tn_atime;
107         nnode->tn_uid = uid;
108         nnode->tn_gid = gid;
109         nnode->tn_mode = mode;
110         nnode->tn_id = alloc_unr(tmp->tm_ino_unr);
111
112         /* Type-specific initialization. */
113         switch (nnode->tn_type) {
114         case VBLK:
115         case VCHR:
116                 nnode->tn_rdev = rdev;
117                 break;
118
119         case VDIR:
120                 TAILQ_INIT(&nnode->tn_dir.tn_dirhead);
121                 MPASS(parent != nnode);
122                 MPASS(IMPLIES(parent == NULL, tmp->tm_root == NULL));
123                 nnode->tn_dir.tn_parent = (parent == NULL) ? nnode : parent;
124                 nnode->tn_dir.tn_readdir_lastn = 0;
125                 nnode->tn_dir.tn_readdir_lastp = NULL;
126                 nnode->tn_links++;
127                 nnode->tn_dir.tn_parent->tn_links++;
128                 break;
129
130         case VFIFO:
131                 /* FALLTHROUGH */
132         case VSOCK:
133                 break;
134
135         case VLNK:
136                 MPASS(strlen(target) < MAXPATHLEN);
137                 nnode->tn_size = strlen(target);
138                 nnode->tn_link = malloc(nnode->tn_size, M_TMPFSNAME,
139                     M_WAITOK);
140                 memcpy(nnode->tn_link, target, nnode->tn_size);
141                 break;
142
143         case VREG:
144                 nnode->tn_reg.tn_aobj =
145                     vm_pager_allocate(OBJT_SWAP, NULL, 0, VM_PROT_DEFAULT, 0);
146                 nnode->tn_reg.tn_aobj_pages = 0;
147                 break;
148
149         default:
150                 panic("tmpfs_alloc_node: type %p %d", nnode, (int)nnode->tn_type);
151         }
152
153         TMPFS_LOCK(tmp);
154         LIST_INSERT_HEAD(&tmp->tm_nodes_used, nnode, tn_entries);
155         tmp->tm_nodes_inuse++;
156         TMPFS_UNLOCK(tmp);
157
158         *node = nnode;
159         return 0;
160 }
161
162 /* --------------------------------------------------------------------- */
163
164 /*
165  * Destroys the node pointed to by node from the file system 'tmp'.
166  * If the node does not belong to the given mount point, the results are
167  * unpredicted.
168  *
169  * If the node references a directory; no entries are allowed because
170  * their removal could need a recursive algorithm, something forbidden in
171  * kernel space.  Furthermore, there is not need to provide such
172  * functionality (recursive removal) because the only primitives offered
173  * to the user are the removal of empty directories and the deletion of
174  * individual files.
175  *
176  * Note that nodes are not really deleted; in fact, when a node has been
177  * allocated, it cannot be deleted during the whole life of the file
178  * system.  Instead, they are moved to the available list and remain there
179  * until reused.
180  */
181 void
182 tmpfs_free_node(struct tmpfs_mount *tmp, struct tmpfs_node *node)
183 {
184         size_t pages = 0;
185
186 #ifdef INVARIANTS
187         TMPFS_NODE_LOCK(node);
188         MPASS(node->tn_vnode == NULL);
189         TMPFS_NODE_UNLOCK(node);
190 #endif
191
192         TMPFS_LOCK(tmp);
193         LIST_REMOVE(node, tn_entries);
194         tmp->tm_nodes_inuse--;
195         TMPFS_UNLOCK(tmp);
196
197         switch (node->tn_type) {
198         case VNON:
199                 /* Do not do anything.  VNON is provided to let the
200                  * allocation routine clean itself easily by avoiding
201                  * duplicating code in it. */
202                 /* FALLTHROUGH */
203         case VBLK:
204                 /* FALLTHROUGH */
205         case VCHR:
206                 /* FALLTHROUGH */
207         case VDIR:
208                 /* FALLTHROUGH */
209         case VFIFO:
210                 /* FALLTHROUGH */
211         case VSOCK:
212                 break;
213
214         case VLNK:
215                 free(node->tn_link, M_TMPFSNAME);
216                 break;
217
218         case VREG:
219                 if (node->tn_reg.tn_aobj != NULL)
220                         vm_object_deallocate(node->tn_reg.tn_aobj);
221                 pages = node->tn_reg.tn_aobj_pages;
222                 break;
223
224         default:
225                 panic("tmpfs_free_node: type %p %d", node, (int)node->tn_type);
226         }
227
228         free_unr(tmp->tm_ino_unr, node->tn_id);
229         uma_zfree(tmp->tm_node_pool, node);
230
231         TMPFS_LOCK(tmp);
232         tmp->tm_pages_used -= pages;
233         TMPFS_UNLOCK(tmp);
234 }
235
236 /* --------------------------------------------------------------------- */
237
238 /*
239  * Allocates a new directory entry for the node node with a name of name.
240  * The new directory entry is returned in *de.
241  *
242  * The link count of node is increased by one to reflect the new object
243  * referencing it.
244  *
245  * Returns zero on success or an appropriate error code on failure.
246  */
247 int
248 tmpfs_alloc_dirent(struct tmpfs_mount *tmp, struct tmpfs_node *node,
249     const char *name, uint16_t len, struct tmpfs_dirent **de)
250 {
251         struct tmpfs_dirent *nde;
252
253         nde = (struct tmpfs_dirent *)uma_zalloc(
254                                         tmp->tm_dirent_pool, M_WAITOK);
255         nde->td_name = malloc(len, M_TMPFSNAME, M_WAITOK);
256         nde->td_namelen = len;
257         memcpy(nde->td_name, name, len);
258
259         nde->td_node = node;
260         node->tn_links++;
261
262         *de = nde;
263
264         return 0;
265 }
266
267 /* --------------------------------------------------------------------- */
268
269 /*
270  * Frees a directory entry.  It is the caller's responsibility to destroy
271  * the node referenced by it if needed.
272  *
273  * The link count of node is decreased by one to reflect the removal of an
274  * object that referenced it.  This only happens if 'node_exists' is true;
275  * otherwise the function will not access the node referred to by the
276  * directory entry, as it may already have been released from the outside.
277  */
278 void
279 tmpfs_free_dirent(struct tmpfs_mount *tmp, struct tmpfs_dirent *de,
280     boolean_t node_exists)
281 {
282         if (node_exists) {
283                 struct tmpfs_node *node;
284
285                 node = de->td_node;
286
287                 MPASS(node->tn_links > 0);
288                 node->tn_links--;
289         }
290
291         free(de->td_name, M_TMPFSNAME);
292         uma_zfree(tmp->tm_dirent_pool, de);
293 }
294
295 /* --------------------------------------------------------------------- */
296
297 /*
298  * Allocates a new vnode for the node node or returns a new reference to
299  * an existing one if the node had already a vnode referencing it.  The
300  * resulting locked vnode is returned in *vpp.
301  *
302  * Returns zero on success or an appropriate error code on failure.
303  */
304 int
305 tmpfs_alloc_vp(struct mount *mp, struct tmpfs_node *node, int lkflag,
306     struct vnode **vpp, struct thread *td)
307 {
308         int error = 0;
309         struct vnode *vp;
310
311 loop:
312         TMPFS_NODE_LOCK(node);
313         if ((vp = node->tn_vnode) != NULL) {
314                 VI_LOCK(vp);
315                 TMPFS_NODE_UNLOCK(node);
316                 vholdl(vp);
317                 (void) vget(vp, lkflag | LK_INTERLOCK | LK_RETRY, td);
318                 vdrop(vp);
319
320                 /*
321                  * Make sure the vnode is still there after
322                  * getting the interlock to avoid racing a free.
323                  */
324                 if (node->tn_vnode == NULL || node->tn_vnode != vp) {
325                         vput(vp);
326                         goto loop;
327                 }
328
329                 goto out;
330         }
331
332         /*
333          * otherwise lock the vp list while we call getnewvnode
334          * since that can block.
335          */
336         if (node->tn_vpstate & TMPFS_VNODE_ALLOCATING) {
337                 node->tn_vpstate |= TMPFS_VNODE_WANT;
338                 error = msleep((caddr_t) &node->tn_vpstate,
339                     TMPFS_NODE_MTX(node), PDROP | PCATCH,
340                     "tmpfs_alloc_vp", 0);
341                 if (error)
342                         return error;
343
344                 goto loop;
345         } else
346                 node->tn_vpstate |= TMPFS_VNODE_ALLOCATING;
347         
348         TMPFS_NODE_UNLOCK(node);
349
350         /* Get a new vnode and associate it with our node. */
351         error = getnewvnode("tmpfs", mp, &tmpfs_vnodeop_entries, &vp);
352         if (error != 0)
353                 goto unlock;
354         MPASS(vp != NULL);
355
356         (void) vn_lock(vp, lkflag | LK_RETRY);
357
358         vp->v_data = node;
359         vp->v_type = node->tn_type;
360
361         /* Type-specific initialization. */
362         switch (node->tn_type) {
363         case VBLK:
364                 /* FALLTHROUGH */
365         case VCHR:
366                 /* FALLTHROUGH */
367         case VLNK:
368                 /* FALLTHROUGH */
369         case VREG:
370                 /* FALLTHROUGH */
371         case VSOCK:
372                 break;
373         case VFIFO:
374                 vp->v_op = &tmpfs_fifoop_entries;
375                 break;
376         case VDIR:
377                 if (node->tn_dir.tn_parent == node)
378                         vp->v_vflag |= VV_ROOT;
379                 break;
380
381         default:
382                 panic("tmpfs_alloc_vp: type %p %d", node, (int)node->tn_type);
383         }
384
385         vnode_pager_setsize(vp, node->tn_size);
386         error = insmntque(vp, mp);
387         if (error)
388                 vp = NULL;
389
390 unlock:
391         TMPFS_NODE_LOCK(node);
392
393         MPASS(node->tn_vpstate & TMPFS_VNODE_ALLOCATING);
394         node->tn_vpstate &= ~TMPFS_VNODE_ALLOCATING;
395         node->tn_vnode = vp;
396
397         if (node->tn_vpstate & TMPFS_VNODE_WANT) {
398                 node->tn_vpstate &= ~TMPFS_VNODE_WANT;
399                 TMPFS_NODE_UNLOCK(node);
400                 wakeup((caddr_t) &node->tn_vpstate);
401         } else
402                 TMPFS_NODE_UNLOCK(node);
403
404 out:
405         *vpp = vp;
406
407         MPASS(IFF(error == 0, *vpp != NULL && VOP_ISLOCKED(*vpp)));
408 #ifdef INVARIANTS
409         TMPFS_NODE_LOCK(node);
410         MPASS(*vpp == node->tn_vnode);
411         TMPFS_NODE_UNLOCK(node);
412 #endif
413
414         return error;
415 }
416
417 /* --------------------------------------------------------------------- */
418
419 /*
420  * Destroys the association between the vnode vp and the node it
421  * references.
422  */
423 void
424 tmpfs_free_vp(struct vnode *vp)
425 {
426         struct tmpfs_node *node;
427
428         node = VP_TO_TMPFS_NODE(vp);
429
430         TMPFS_NODE_LOCK(node);
431         node->tn_vnode = NULL;
432         vp->v_data = NULL;
433         TMPFS_NODE_UNLOCK(node);
434 }
435
436 /* --------------------------------------------------------------------- */
437
438 /*
439  * Allocates a new file of type 'type' and adds it to the parent directory
440  * 'dvp'; this addition is done using the component name given in 'cnp'.
441  * The ownership of the new file is automatically assigned based on the
442  * credentials of the caller (through 'cnp'), the group is set based on
443  * the parent directory and the mode is determined from the 'vap' argument.
444  * If successful, *vpp holds a vnode to the newly created file and zero
445  * is returned.  Otherwise *vpp is NULL and the function returns an
446  * appropriate error code.
447  */
448 int
449 tmpfs_alloc_file(struct vnode *dvp, struct vnode **vpp, struct vattr *vap,
450     struct componentname *cnp, char *target)
451 {
452         int error;
453         struct tmpfs_dirent *de;
454         struct tmpfs_mount *tmp;
455         struct tmpfs_node *dnode;
456         struct tmpfs_node *node;
457         struct tmpfs_node *parent;
458
459         MPASS(VOP_ISLOCKED(dvp));
460         MPASS(cnp->cn_flags & HASBUF);
461
462         tmp = VFS_TO_TMPFS(dvp->v_mount);
463         dnode = VP_TO_TMPFS_DIR(dvp);
464         *vpp = NULL;
465
466         /* If the entry we are creating is a directory, we cannot overflow
467          * the number of links of its parent, because it will get a new
468          * link. */
469         if (vap->va_type == VDIR) {
470                 /* Ensure that we do not overflow the maximum number of links
471                  * imposed by the system. */
472                 MPASS(dnode->tn_links <= LINK_MAX);
473                 if (dnode->tn_links == LINK_MAX) {
474                         error = EMLINK;
475                         goto out;
476                 }
477
478                 parent = dnode;
479                 MPASS(parent != NULL);
480         } else
481                 parent = NULL;
482
483         /* Allocate a node that represents the new file. */
484         error = tmpfs_alloc_node(tmp, vap->va_type, cnp->cn_cred->cr_uid,
485             dnode->tn_gid, vap->va_mode, parent, target, vap->va_rdev,
486             cnp->cn_thread, &node);
487         if (error != 0)
488                 goto out;
489
490         /* Allocate a directory entry that points to the new file. */
491         error = tmpfs_alloc_dirent(tmp, node, cnp->cn_nameptr, cnp->cn_namelen,
492             &de);
493         if (error != 0) {
494                 tmpfs_free_node(tmp, node);
495                 goto out;
496         }
497
498         /* Allocate a vnode for the new file. */
499         error = tmpfs_alloc_vp(dvp->v_mount, node, LK_EXCLUSIVE, vpp,
500             cnp->cn_thread);
501         if (error != 0) {
502                 tmpfs_free_dirent(tmp, de, TRUE);
503                 tmpfs_free_node(tmp, node);
504                 goto out;
505         }
506
507         /* Now that all required items are allocated, we can proceed to
508          * insert the new node into the directory, an operation that
509          * cannot fail. */
510         tmpfs_dir_attach(dvp, de);
511
512 out:
513
514         return error;
515 }
516
517 /* --------------------------------------------------------------------- */
518
519 /*
520  * Attaches the directory entry de to the directory represented by vp.
521  * Note that this does not change the link count of the node pointed by
522  * the directory entry, as this is done by tmpfs_alloc_dirent.
523  */
524 void
525 tmpfs_dir_attach(struct vnode *vp, struct tmpfs_dirent *de)
526 {
527         struct tmpfs_node *dnode;
528
529         ASSERT_VOP_ELOCKED(vp, __func__);
530         dnode = VP_TO_TMPFS_DIR(vp);
531         TAILQ_INSERT_TAIL(&dnode->tn_dir.tn_dirhead, de, td_entries);
532         dnode->tn_size += sizeof(struct tmpfs_dirent);
533         dnode->tn_status |= TMPFS_NODE_ACCESSED | TMPFS_NODE_CHANGED | \
534             TMPFS_NODE_MODIFIED;
535 }
536
537 /* --------------------------------------------------------------------- */
538
539 /*
540  * Detaches the directory entry de from the directory represented by vp.
541  * Note that this does not change the link count of the node pointed by
542  * the directory entry, as this is done by tmpfs_free_dirent.
543  */
544 void
545 tmpfs_dir_detach(struct vnode *vp, struct tmpfs_dirent *de)
546 {
547         struct tmpfs_node *dnode;
548
549         ASSERT_VOP_ELOCKED(vp, __func__);
550         dnode = VP_TO_TMPFS_DIR(vp);
551
552         if (dnode->tn_dir.tn_readdir_lastp == de) {
553                 dnode->tn_dir.tn_readdir_lastn = 0;
554                 dnode->tn_dir.tn_readdir_lastp = NULL;
555         }
556
557         TAILQ_REMOVE(&dnode->tn_dir.tn_dirhead, de, td_entries);
558         dnode->tn_size -= sizeof(struct tmpfs_dirent);
559         dnode->tn_status |= TMPFS_NODE_ACCESSED | TMPFS_NODE_CHANGED | \
560             TMPFS_NODE_MODIFIED;
561 }
562
563 /* --------------------------------------------------------------------- */
564
565 /*
566  * Looks for a directory entry in the directory represented by node.
567  * 'cnp' describes the name of the entry to look for.  Note that the .
568  * and .. components are not allowed as they do not physically exist
569  * within directories.
570  *
571  * Returns a pointer to the entry when found, otherwise NULL.
572  */
573 struct tmpfs_dirent *
574 tmpfs_dir_lookup(struct tmpfs_node *node, struct componentname *cnp)
575 {
576         boolean_t found;
577         struct tmpfs_dirent *de;
578
579         MPASS(IMPLIES(cnp->cn_namelen == 1, cnp->cn_nameptr[0] != '.'));
580         MPASS(IMPLIES(cnp->cn_namelen == 2, !(cnp->cn_nameptr[0] == '.' &&
581             cnp->cn_nameptr[1] == '.')));
582         TMPFS_VALIDATE_DIR(node);
583
584         found = 0;
585         TAILQ_FOREACH(de, &node->tn_dir.tn_dirhead, td_entries) {
586                 MPASS(cnp->cn_namelen < 0xffff);
587                 if (de->td_namelen == (uint16_t)cnp->cn_namelen &&
588                     bcmp(de->td_name, cnp->cn_nameptr, de->td_namelen) == 0) {
589                         found = 1;
590                         break;
591                 }
592         }
593         node->tn_status |= TMPFS_NODE_ACCESSED;
594
595         return found ? de : NULL;
596 }
597
598 struct tmpfs_dirent *
599 tmpfs_dir_search(struct tmpfs_node *node, struct tmpfs_node *f)
600 {
601         struct tmpfs_dirent *de;
602
603         TMPFS_VALIDATE_DIR(node);
604         node->tn_status |= TMPFS_NODE_ACCESSED;
605         TAILQ_FOREACH(de, &node->tn_dir.tn_dirhead, td_entries) {
606                 if (de->td_node == f)
607                         return (de);
608         }
609         return (NULL);
610 }
611
612 /* --------------------------------------------------------------------- */
613
614 /*
615  * Helper function for tmpfs_readdir.  Creates a '.' entry for the given
616  * directory and returns it in the uio space.  The function returns 0
617  * on success, -1 if there was not enough space in the uio structure to
618  * hold the directory entry or an appropriate error code if another
619  * error happens.
620  */
621 int
622 tmpfs_dir_getdotdent(struct tmpfs_node *node, struct uio *uio)
623 {
624         int error;
625         struct dirent dent;
626
627         TMPFS_VALIDATE_DIR(node);
628         MPASS(uio->uio_offset == TMPFS_DIRCOOKIE_DOT);
629
630         dent.d_fileno = node->tn_id;
631         dent.d_type = DT_DIR;
632         dent.d_namlen = 1;
633         dent.d_name[0] = '.';
634         dent.d_name[1] = '\0';
635         dent.d_reclen = GENERIC_DIRSIZ(&dent);
636
637         if (dent.d_reclen > uio->uio_resid)
638                 error = -1;
639         else {
640                 error = uiomove(&dent, dent.d_reclen, uio);
641                 if (error == 0)
642                         uio->uio_offset = TMPFS_DIRCOOKIE_DOTDOT;
643         }
644
645         node->tn_status |= TMPFS_NODE_ACCESSED;
646
647         return error;
648 }
649
650 /* --------------------------------------------------------------------- */
651
652 /*
653  * Helper function for tmpfs_readdir.  Creates a '..' entry for the given
654  * directory and returns it in the uio space.  The function returns 0
655  * on success, -1 if there was not enough space in the uio structure to
656  * hold the directory entry or an appropriate error code if another
657  * error happens.
658  */
659 int
660 tmpfs_dir_getdotdotdent(struct tmpfs_node *node, struct uio *uio)
661 {
662         int error;
663         struct dirent dent;
664
665         TMPFS_VALIDATE_DIR(node);
666         MPASS(uio->uio_offset == TMPFS_DIRCOOKIE_DOTDOT);
667
668         dent.d_fileno = node->tn_dir.tn_parent->tn_id;
669         dent.d_type = DT_DIR;
670         dent.d_namlen = 2;
671         dent.d_name[0] = '.';
672         dent.d_name[1] = '.';
673         dent.d_name[2] = '\0';
674         dent.d_reclen = GENERIC_DIRSIZ(&dent);
675
676         if (dent.d_reclen > uio->uio_resid)
677                 error = -1;
678         else {
679                 error = uiomove(&dent, dent.d_reclen, uio);
680                 if (error == 0) {
681                         struct tmpfs_dirent *de;
682
683                         de = TAILQ_FIRST(&node->tn_dir.tn_dirhead);
684                         if (de == NULL)
685                                 uio->uio_offset = TMPFS_DIRCOOKIE_EOF;
686                         else
687                                 uio->uio_offset = tmpfs_dircookie(de);
688                 }
689         }
690
691         node->tn_status |= TMPFS_NODE_ACCESSED;
692
693         return error;
694 }
695
696 /* --------------------------------------------------------------------- */
697
698 /*
699  * Lookup a directory entry by its associated cookie.
700  */
701 struct tmpfs_dirent *
702 tmpfs_dir_lookupbycookie(struct tmpfs_node *node, off_t cookie)
703 {
704         struct tmpfs_dirent *de;
705
706         if (cookie == node->tn_dir.tn_readdir_lastn &&
707             node->tn_dir.tn_readdir_lastp != NULL) {
708                 return node->tn_dir.tn_readdir_lastp;
709         }
710
711         TAILQ_FOREACH(de, &node->tn_dir.tn_dirhead, td_entries) {
712                 if (tmpfs_dircookie(de) == cookie) {
713                         break;
714                 }
715         }
716
717         return de;
718 }
719
720 /* --------------------------------------------------------------------- */
721
722 /*
723  * Helper function for tmpfs_readdir.  Returns as much directory entries
724  * as can fit in the uio space.  The read starts at uio->uio_offset.
725  * The function returns 0 on success, -1 if there was not enough space
726  * in the uio structure to hold the directory entry or an appropriate
727  * error code if another error happens.
728  */
729 int
730 tmpfs_dir_getdents(struct tmpfs_node *node, struct uio *uio, off_t *cntp)
731 {
732         int error;
733         off_t startcookie;
734         struct tmpfs_dirent *de;
735
736         TMPFS_VALIDATE_DIR(node);
737
738         /* Locate the first directory entry we have to return.  We have cached
739          * the last readdir in the node, so use those values if appropriate.
740          * Otherwise do a linear scan to find the requested entry. */
741         startcookie = uio->uio_offset;
742         MPASS(startcookie != TMPFS_DIRCOOKIE_DOT);
743         MPASS(startcookie != TMPFS_DIRCOOKIE_DOTDOT);
744         if (startcookie == TMPFS_DIRCOOKIE_EOF) {
745                 return 0;
746         } else {
747                 de = tmpfs_dir_lookupbycookie(node, startcookie);
748         }
749         if (de == NULL) {
750                 return EINVAL;
751         }
752
753         /* Read as much entries as possible; i.e., until we reach the end of
754          * the directory or we exhaust uio space. */
755         do {
756                 struct dirent d;
757
758                 /* Create a dirent structure representing the current
759                  * tmpfs_node and fill it. */
760                 d.d_fileno = de->td_node->tn_id;
761                 switch (de->td_node->tn_type) {
762                 case VBLK:
763                         d.d_type = DT_BLK;
764                         break;
765
766                 case VCHR:
767                         d.d_type = DT_CHR;
768                         break;
769
770                 case VDIR:
771                         d.d_type = DT_DIR;
772                         break;
773
774                 case VFIFO:
775                         d.d_type = DT_FIFO;
776                         break;
777
778                 case VLNK:
779                         d.d_type = DT_LNK;
780                         break;
781
782                 case VREG:
783                         d.d_type = DT_REG;
784                         break;
785
786                 case VSOCK:
787                         d.d_type = DT_SOCK;
788                         break;
789
790                 default:
791                         panic("tmpfs_dir_getdents: type %p %d",
792                             de->td_node, (int)de->td_node->tn_type);
793                 }
794                 d.d_namlen = de->td_namelen;
795                 MPASS(de->td_namelen < sizeof(d.d_name));
796                 (void)memcpy(d.d_name, de->td_name, de->td_namelen);
797                 d.d_name[de->td_namelen] = '\0';
798                 d.d_reclen = GENERIC_DIRSIZ(&d);
799
800                 /* Stop reading if the directory entry we are treating is
801                  * bigger than the amount of data that can be returned. */
802                 if (d.d_reclen > uio->uio_resid) {
803                         error = -1;
804                         break;
805                 }
806
807                 /* Copy the new dirent structure into the output buffer and
808                  * advance pointers. */
809                 error = uiomove(&d, d.d_reclen, uio);
810
811                 (*cntp)++;
812                 de = TAILQ_NEXT(de, td_entries);
813         } while (error == 0 && uio->uio_resid > 0 && de != NULL);
814
815         /* Update the offset and cache. */
816         if (de == NULL) {
817                 uio->uio_offset = TMPFS_DIRCOOKIE_EOF;
818                 node->tn_dir.tn_readdir_lastn = 0;
819                 node->tn_dir.tn_readdir_lastp = NULL;
820         } else {
821                 node->tn_dir.tn_readdir_lastn = uio->uio_offset = tmpfs_dircookie(de);
822                 node->tn_dir.tn_readdir_lastp = de;
823         }
824
825         node->tn_status |= TMPFS_NODE_ACCESSED;
826         return error;
827 }
828
829 /* --------------------------------------------------------------------- */
830
831 /*
832  * Resizes the aobj associated to the regular file pointed to by vp to
833  * the size newsize.  'vp' must point to a vnode that represents a regular
834  * file.  'newsize' must be positive.
835  *
836  * Returns zero on success or an appropriate error code on failure.
837  */
838 int
839 tmpfs_reg_resize(struct vnode *vp, off_t newsize)
840 {
841         int error;
842         size_t newpages, oldpages;
843         struct tmpfs_mount *tmp;
844         struct tmpfs_node *node;
845         off_t oldsize;
846
847         MPASS(vp->v_type == VREG);
848         MPASS(newsize >= 0);
849
850         node = VP_TO_TMPFS_NODE(vp);
851         tmp = VFS_TO_TMPFS(vp->v_mount);
852
853         /* Convert the old and new sizes to the number of pages needed to
854          * store them.  It may happen that we do not need to do anything
855          * because the last allocated page can accommodate the change on
856          * its own. */
857         oldsize = node->tn_size;
858         oldpages = round_page(oldsize) / PAGE_SIZE;
859         MPASS(oldpages == node->tn_reg.tn_aobj_pages);
860         newpages = round_page(newsize) / PAGE_SIZE;
861
862         if (newpages > oldpages &&
863             newpages - oldpages > TMPFS_PAGES_AVAIL(tmp)) {
864                 error = ENOSPC;
865                 goto out;
866         }
867
868         node->tn_reg.tn_aobj_pages = newpages;
869
870         TMPFS_LOCK(tmp);
871         tmp->tm_pages_used += (newpages - oldpages);
872         TMPFS_UNLOCK(tmp);
873
874         node->tn_size = newsize;
875         vnode_pager_setsize(vp, newsize);
876         if (newsize < oldsize) {
877                 size_t zerolen = round_page(newsize) - newsize;
878                 vm_object_t uobj = node->tn_reg.tn_aobj;
879                 vm_page_t m;
880
881                 /*
882                  * free "backing store"
883                  */
884                 VM_OBJECT_LOCK(uobj);
885                 if (newpages < oldpages) {
886                         swap_pager_freespace(uobj,
887                                                 newpages, oldpages - newpages);
888                         vm_object_page_remove(uobj,
889                                 OFF_TO_IDX(newsize + PAGE_MASK), 0, FALSE);
890                 }
891
892                 /*
893                  * zero out the truncated part of the last page.
894                  */
895
896                 if (zerolen > 0) {
897                         m = vm_page_grab(uobj, OFF_TO_IDX(newsize),
898                                         VM_ALLOC_NORMAL | VM_ALLOC_RETRY);
899                         pmap_zero_page_area(m, PAGE_SIZE - zerolen,
900                                 zerolen);
901                         vm_page_wakeup(m);
902                 }
903                 VM_OBJECT_UNLOCK(uobj);
904
905         }
906
907         error = 0;
908
909 out:
910         return error;
911 }
912
913 /* --------------------------------------------------------------------- */
914
915 /*
916  * Change flags of the given vnode.
917  * Caller should execute tmpfs_update on vp after a successful execution.
918  * The vnode must be locked on entry and remain locked on exit.
919  */
920 int
921 tmpfs_chflags(struct vnode *vp, int flags, struct ucred *cred, struct thread *p)
922 {
923         int error;
924         struct tmpfs_node *node;
925
926         MPASS(VOP_ISLOCKED(vp));
927
928         node = VP_TO_TMPFS_NODE(vp);
929
930         /* Disallow this operation if the file system is mounted read-only. */
931         if (vp->v_mount->mnt_flag & MNT_RDONLY)
932                 return EROFS;
933
934         /*
935          * Callers may only modify the file flags on objects they
936          * have VADMIN rights for.
937          */
938         if ((error = VOP_ACCESS(vp, VADMIN, cred, p)))
939                 return (error);
940         /*
941          * Unprivileged processes are not permitted to unset system
942          * flags, or modify flags if any system flags are set.
943          */
944         if (!priv_check_cred(cred, PRIV_VFS_SYSFLAGS, 0)) {
945                 if (node->tn_flags
946                   & (SF_NOUNLINK | SF_IMMUTABLE | SF_APPEND)) {
947                         error = securelevel_gt(cred, 0);
948                         if (error)
949                                 return (error);
950                 }
951                 /* Snapshot flag cannot be set or cleared */
952                 if (((flags & SF_SNAPSHOT) != 0 &&
953                   (node->tn_flags & SF_SNAPSHOT) == 0) ||
954                   ((flags & SF_SNAPSHOT) == 0 &&
955                   (node->tn_flags & SF_SNAPSHOT) != 0))
956                         return (EPERM);
957                 node->tn_flags = flags;
958         } else {
959                 if (node->tn_flags
960                   & (SF_NOUNLINK | SF_IMMUTABLE | SF_APPEND) ||
961                   (flags & UF_SETTABLE) != flags)
962                         return (EPERM);
963                 node->tn_flags &= SF_SETTABLE;
964                 node->tn_flags |= (flags & UF_SETTABLE);
965         }
966         node->tn_status |= TMPFS_NODE_CHANGED;
967
968         MPASS(VOP_ISLOCKED(vp));
969
970         return 0;
971 }
972
973 /* --------------------------------------------------------------------- */
974
975 /*
976  * Change access mode on the given vnode.
977  * Caller should execute tmpfs_update on vp after a successful execution.
978  * The vnode must be locked on entry and remain locked on exit.
979  */
980 int
981 tmpfs_chmod(struct vnode *vp, mode_t mode, struct ucred *cred, struct thread *p)
982 {
983         int error;
984         struct tmpfs_node *node;
985
986         MPASS(VOP_ISLOCKED(vp));
987
988         node = VP_TO_TMPFS_NODE(vp);
989
990         /* Disallow this operation if the file system is mounted read-only. */
991         if (vp->v_mount->mnt_flag & MNT_RDONLY)
992                 return EROFS;
993
994         /* Immutable or append-only files cannot be modified, either. */
995         if (node->tn_flags & (IMMUTABLE | APPEND))
996                 return EPERM;
997
998         /*
999          * To modify the permissions on a file, must possess VADMIN
1000          * for that file.
1001          */
1002         if ((error = VOP_ACCESS(vp, VADMIN, cred, p)))
1003                 return (error);
1004
1005         /*
1006          * Privileged processes may set the sticky bit on non-directories,
1007          * as well as set the setgid bit on a file with a group that the
1008          * process is not a member of.
1009          */
1010         if (vp->v_type != VDIR && (mode & S_ISTXT)) {
1011                 if (priv_check_cred(cred, PRIV_VFS_STICKYFILE, 0))
1012                         return (EFTYPE);
1013         }
1014         if (!groupmember(node->tn_gid, cred) && (mode & S_ISGID)) {
1015                 error = priv_check_cred(cred, PRIV_VFS_SETGID, 0);
1016                 if (error)
1017                         return (error);
1018         }
1019
1020
1021         node->tn_mode &= ~ALLPERMS;
1022         node->tn_mode |= mode & ALLPERMS;
1023
1024         node->tn_status |= TMPFS_NODE_CHANGED;
1025
1026         MPASS(VOP_ISLOCKED(vp));
1027
1028         return 0;
1029 }
1030
1031 /* --------------------------------------------------------------------- */
1032
1033 /*
1034  * Change ownership of the given vnode.  At least one of uid or gid must
1035  * be different than VNOVAL.  If one is set to that value, the attribute
1036  * is unchanged.
1037  * Caller should execute tmpfs_update on vp after a successful execution.
1038  * The vnode must be locked on entry and remain locked on exit.
1039  */
1040 int
1041 tmpfs_chown(struct vnode *vp, uid_t uid, gid_t gid, struct ucred *cred,
1042     struct thread *p)
1043 {
1044         int error;
1045         struct tmpfs_node *node;
1046         uid_t ouid;
1047         gid_t ogid;
1048
1049         MPASS(VOP_ISLOCKED(vp));
1050
1051         node = VP_TO_TMPFS_NODE(vp);
1052
1053         /* Assign default values if they are unknown. */
1054         MPASS(uid != VNOVAL || gid != VNOVAL);
1055         if (uid == VNOVAL)
1056                 uid = node->tn_uid;
1057         if (gid == VNOVAL)
1058                 gid = node->tn_gid;
1059         MPASS(uid != VNOVAL && gid != VNOVAL);
1060
1061         /* Disallow this operation if the file system is mounted read-only. */
1062         if (vp->v_mount->mnt_flag & MNT_RDONLY)
1063                 return EROFS;
1064
1065         /* Immutable or append-only files cannot be modified, either. */
1066         if (node->tn_flags & (IMMUTABLE | APPEND))
1067                 return EPERM;
1068
1069         /*
1070          * To modify the ownership of a file, must possess VADMIN for that
1071          * file.
1072          */
1073         if ((error = VOP_ACCESS(vp, VADMIN, cred, p)))
1074                 return (error);
1075
1076         /*
1077          * To change the owner of a file, or change the group of a file to a
1078          * group of which we are not a member, the caller must have
1079          * privilege.
1080          */
1081         if ((uid != node->tn_uid ||
1082             (gid != node->tn_gid && !groupmember(gid, cred))) &&
1083             (error = priv_check_cred(cred, PRIV_VFS_CHOWN, 0)))
1084                 return (error);
1085
1086         ogid = node->tn_gid;
1087         ouid = node->tn_uid;
1088
1089         node->tn_uid = uid;
1090         node->tn_gid = gid;
1091
1092         node->tn_status |= TMPFS_NODE_CHANGED;
1093
1094         if ((node->tn_mode & (S_ISUID | S_ISGID)) && (ouid != uid || ogid != gid)) {
1095                 if (priv_check_cred(cred, PRIV_VFS_RETAINSUGID, 0))
1096                         node->tn_mode &= ~(S_ISUID | S_ISGID);
1097         }
1098
1099         MPASS(VOP_ISLOCKED(vp));
1100
1101         return 0;
1102 }
1103
1104 /* --------------------------------------------------------------------- */
1105
1106 /*
1107  * Change size of the given vnode.
1108  * Caller should execute tmpfs_update on vp after a successful execution.
1109  * The vnode must be locked on entry and remain locked on exit.
1110  */
1111 int
1112 tmpfs_chsize(struct vnode *vp, u_quad_t size, struct ucred *cred,
1113     struct thread *p)
1114 {
1115         int error;
1116         struct tmpfs_node *node;
1117
1118         MPASS(VOP_ISLOCKED(vp));
1119
1120         node = VP_TO_TMPFS_NODE(vp);
1121
1122         /* Decide whether this is a valid operation based on the file type. */
1123         error = 0;
1124         switch (vp->v_type) {
1125         case VDIR:
1126                 return EISDIR;
1127
1128         case VREG:
1129                 if (vp->v_mount->mnt_flag & MNT_RDONLY)
1130                         return EROFS;
1131                 break;
1132
1133         case VBLK:
1134                 /* FALLTHROUGH */
1135         case VCHR:
1136                 /* FALLTHROUGH */
1137         case VFIFO:
1138                 /* Allow modifications of special files even if in the file
1139                  * system is mounted read-only (we are not modifying the
1140                  * files themselves, but the objects they represent). */
1141                 return 0;
1142
1143         default:
1144                 /* Anything else is unsupported. */
1145                 return EOPNOTSUPP;
1146         }
1147
1148         /* Immutable or append-only files cannot be modified, either. */
1149         if (node->tn_flags & (IMMUTABLE | APPEND))
1150                 return EPERM;
1151
1152         error = tmpfs_truncate(vp, size);
1153         /* tmpfs_truncate will raise the NOTE_EXTEND and NOTE_ATTRIB kevents
1154          * for us, as will update tn_status; no need to do that here. */
1155
1156         MPASS(VOP_ISLOCKED(vp));
1157
1158         return error;
1159 }
1160
1161 /* --------------------------------------------------------------------- */
1162
1163 /*
1164  * Change access and modification times of the given vnode.
1165  * Caller should execute tmpfs_update on vp after a successful execution.
1166  * The vnode must be locked on entry and remain locked on exit.
1167  */
1168 int
1169 tmpfs_chtimes(struct vnode *vp, struct timespec *atime, struct timespec *mtime,
1170         struct timespec *birthtime, int vaflags, struct ucred *cred, struct thread *l)
1171 {
1172         int error;
1173         struct tmpfs_node *node;
1174
1175         MPASS(VOP_ISLOCKED(vp));
1176
1177         node = VP_TO_TMPFS_NODE(vp);
1178
1179         /* Disallow this operation if the file system is mounted read-only. */
1180         if (vp->v_mount->mnt_flag & MNT_RDONLY)
1181                 return EROFS;
1182
1183         /* Immutable or append-only files cannot be modified, either. */
1184         if (node->tn_flags & (IMMUTABLE | APPEND))
1185                 return EPERM;
1186
1187         /* Determine if the user have proper privilege to update time. */
1188         if (vaflags & VA_UTIMES_NULL) {
1189                 error = VOP_ACCESS(vp, VADMIN, cred, l);
1190                 if (error)
1191                         error = VOP_ACCESS(vp, VWRITE, cred, l);
1192         } else
1193                 error = VOP_ACCESS(vp, VADMIN, cred, l);
1194         if (error)
1195                 return (error);
1196
1197         if (atime->tv_sec != VNOVAL && atime->tv_nsec != VNOVAL)
1198                 node->tn_status |= TMPFS_NODE_ACCESSED;
1199
1200         if (mtime->tv_sec != VNOVAL && mtime->tv_nsec != VNOVAL)
1201                 node->tn_status |= TMPFS_NODE_MODIFIED;
1202
1203         if (birthtime->tv_nsec != VNOVAL && birthtime->tv_nsec != VNOVAL)
1204                 node->tn_status |= TMPFS_NODE_MODIFIED;
1205
1206         tmpfs_itimes(vp, atime, mtime);
1207
1208         if (birthtime->tv_nsec != VNOVAL && birthtime->tv_nsec != VNOVAL)
1209                 node->tn_birthtime = *birthtime;
1210         MPASS(VOP_ISLOCKED(vp));
1211
1212         return 0;
1213 }
1214
1215 /* --------------------------------------------------------------------- */
1216 /* Sync timestamps */
1217 void
1218 tmpfs_itimes(struct vnode *vp, const struct timespec *acc,
1219     const struct timespec *mod)
1220 {
1221         struct tmpfs_node *node;
1222         struct timespec now;
1223
1224         node = VP_TO_TMPFS_NODE(vp);
1225
1226         if ((node->tn_status & (TMPFS_NODE_ACCESSED | TMPFS_NODE_MODIFIED |
1227             TMPFS_NODE_CHANGED)) == 0)
1228                 return;
1229
1230         vfs_timestamp(&now);
1231         if (node->tn_status & TMPFS_NODE_ACCESSED) {
1232                 if (acc == NULL)
1233                          acc = &now;
1234                 node->tn_atime = *acc;
1235         }
1236         if (node->tn_status & TMPFS_NODE_MODIFIED) {
1237                 if (mod == NULL)
1238                         mod = &now;
1239                 node->tn_mtime = *mod;
1240         }
1241         if (node->tn_status & TMPFS_NODE_CHANGED) {
1242                 node->tn_ctime = now;
1243         }
1244         node->tn_status &=
1245             ~(TMPFS_NODE_ACCESSED | TMPFS_NODE_MODIFIED | TMPFS_NODE_CHANGED);
1246 }
1247
1248 /* --------------------------------------------------------------------- */
1249
1250 void
1251 tmpfs_update(struct vnode *vp)
1252 {
1253
1254         tmpfs_itimes(vp, NULL, NULL);
1255 }
1256
1257 /* --------------------------------------------------------------------- */
1258
1259 int
1260 tmpfs_truncate(struct vnode *vp, off_t length)
1261 {
1262         boolean_t extended;
1263         int error;
1264         struct tmpfs_node *node;
1265
1266         node = VP_TO_TMPFS_NODE(vp);
1267         extended = length > node->tn_size;
1268
1269         if (length < 0) {
1270                 error = EINVAL;
1271                 goto out;
1272         }
1273
1274         if (node->tn_size == length) {
1275                 error = 0;
1276                 goto out;
1277         }
1278
1279         if (length > VFS_TO_TMPFS(vp->v_mount)->tm_maxfilesize)
1280                 return (EFBIG);
1281
1282         error = tmpfs_reg_resize(vp, length);
1283         if (error == 0) {
1284                 node->tn_status |= TMPFS_NODE_CHANGED | TMPFS_NODE_MODIFIED;
1285         }
1286
1287 out:
1288         tmpfs_update(vp);
1289
1290         return error;
1291 }