1ad3638eeSXin LI /* $NetBSD: tmpfs.h,v 1.26 2007/02/22 06:37:00 thorpej Exp $ */ 2d1fa59e9SXin LI 3e08d5567SXin LI /*- 4*b61a5730SWarner Losh * SPDX-License-Identifier: BSD-2-Clause 5d63027b6SPedro F. Giffuni * 6ad3638eeSXin LI * Copyright (c) 2005, 2006 The NetBSD Foundation, Inc. 7d1fa59e9SXin LI * All rights reserved. 8d1fa59e9SXin LI * 9d1fa59e9SXin LI * This code is derived from software contributed to The NetBSD Foundation 10d1fa59e9SXin LI * by Julio M. Merino Vidal, developed as part of Google's Summer of Code 11d1fa59e9SXin LI * 2005 program. 12d1fa59e9SXin LI * 13d1fa59e9SXin LI * Redistribution and use in source and binary forms, with or without 14d1fa59e9SXin LI * modification, are permitted provided that the following conditions 15d1fa59e9SXin LI * are met: 16d1fa59e9SXin LI * 1. Redistributions of source code must retain the above copyright 17d1fa59e9SXin LI * notice, this list of conditions and the following disclaimer. 18d1fa59e9SXin LI * 2. Redistributions in binary form must reproduce the above copyright 19d1fa59e9SXin LI * notice, this list of conditions and the following disclaimer in the 20d1fa59e9SXin LI * documentation and/or other materials provided with the distribution. 21d1fa59e9SXin LI * 22d1fa59e9SXin LI * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 23d1fa59e9SXin LI * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 24d1fa59e9SXin LI * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 25d1fa59e9SXin LI * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 26d1fa59e9SXin LI * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27d1fa59e9SXin LI * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28d1fa59e9SXin LI * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29d1fa59e9SXin LI * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30d1fa59e9SXin LI * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31d1fa59e9SXin LI * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32d1fa59e9SXin LI * POSSIBILITY OF SUCH DAMAGE. 33d1fa59e9SXin LI * 34d1fa59e9SXin LI * $FreeBSD$ 35d1fa59e9SXin LI */ 36d1fa59e9SXin LI 37d1fa59e9SXin LI #ifndef _FS_TMPFS_TMPFS_H_ 38d1fa59e9SXin LI #define _FS_TMPFS_TMPFS_H_ 39d1fa59e9SXin LI 40693d10a2SRyan Moeller #include <sys/cdefs.h> 41d1fa59e9SXin LI #include <sys/queue.h> 424fd5efe7SGleb Kurtsou #include <sys/tree.h> 43d1fa59e9SXin LI 44135beaf6SGleb Smirnoff #ifdef _SYS_MALLOC_H_ 459b258fcaSXin LI MALLOC_DECLARE(M_TMPFSNAME); 46135beaf6SGleb Smirnoff #endif 47d1fa59e9SXin LI 48128e2584SMateusz Guzik #define OBJ_TMPFS OBJ_PAGERPRIV1 /* has tmpfs vnode allocated */ 49eec2e4efSMateusz Guzik #define OBJ_TMPFS_VREF OBJ_PAGERPRIV2 /* vnode is referenced */ 5028bc23abSKonstantin Belousov 51d1fa59e9SXin LI /* 52d1fa59e9SXin LI * Internal representation of a tmpfs directory entry. 53d1fa59e9SXin LI */ 544fd5efe7SGleb Kurtsou 554fd5efe7SGleb Kurtsou LIST_HEAD(tmpfs_dir_duphead, tmpfs_dirent); 564fd5efe7SGleb Kurtsou 57d1fa59e9SXin LI struct tmpfs_dirent { 584fd5efe7SGleb Kurtsou /* 594fd5efe7SGleb Kurtsou * Depending on td_cookie flag entry can be of 3 types: 604fd5efe7SGleb Kurtsou * - regular -- no hash collisions, stored in RB-Tree 614fd5efe7SGleb Kurtsou * - duphead -- synthetic linked list head for dup entries 624fd5efe7SGleb Kurtsou * - dup -- stored in linked list instead of RB-Tree 634fd5efe7SGleb Kurtsou */ 644fd5efe7SGleb Kurtsou union { 654fd5efe7SGleb Kurtsou /* regular and duphead entry types */ 664fd5efe7SGleb Kurtsou RB_ENTRY(tmpfs_dirent) td_entries; 67d1fa59e9SXin LI 684fd5efe7SGleb Kurtsou /* dup entry type */ 694fd5efe7SGleb Kurtsou struct { 704fd5efe7SGleb Kurtsou LIST_ENTRY(tmpfs_dirent) entries; 714fd5efe7SGleb Kurtsou LIST_ENTRY(tmpfs_dirent) index_entries; 724fd5efe7SGleb Kurtsou } td_dup; 734fd5efe7SGleb Kurtsou } uh; 74d1fa59e9SXin LI 754fd5efe7SGleb Kurtsou uint32_t td_cookie; 764fd5efe7SGleb Kurtsou uint32_t td_hash; 774fd5efe7SGleb Kurtsou u_int td_namelen; 78d1fa59e9SXin LI 79bba7ed20SKonstantin Belousov /* 80bba7ed20SKonstantin Belousov * Pointer to the node this entry refers to. In case this field 81bba7ed20SKonstantin Belousov * is NULL, the node is a whiteout. 82bba7ed20SKonstantin Belousov */ 83d1fa59e9SXin LI struct tmpfs_node * td_node; 844fd5efe7SGleb Kurtsou 854fd5efe7SGleb Kurtsou union { 864fd5efe7SGleb Kurtsou /* 874fd5efe7SGleb Kurtsou * The name of the entry, allocated from a string pool. This 884fd5efe7SGleb Kurtsou * string is not required to be zero-terminated. 894fd5efe7SGleb Kurtsou */ 904fd5efe7SGleb Kurtsou char * td_name; /* regular, dup */ 914fd5efe7SGleb Kurtsou struct tmpfs_dir_duphead td_duphead; /* duphead */ 924fd5efe7SGleb Kurtsou } ud; 93d1fa59e9SXin LI }; 94d1fa59e9SXin LI 95bba7ed20SKonstantin Belousov /* 96bba7ed20SKonstantin Belousov * A directory in tmpfs holds a collection of directory entries, which 97bba7ed20SKonstantin Belousov * in turn point to other files (which can be directories themselves). 98d1fa59e9SXin LI * 99bba7ed20SKonstantin Belousov * In tmpfs, this collection is managed by a RB-Tree, whose head is 100bba7ed20SKonstantin Belousov * defined by the struct tmpfs_dir type. 101d1fa59e9SXin LI * 1024fd5efe7SGleb Kurtsou * It is important to notice that directories do not have entries for . and 103d1fa59e9SXin LI * .. as other file systems do. These can be generated when requested 104d1fa59e9SXin LI * based on information available by other means, such as the pointer to 105d1fa59e9SXin LI * the node itself in the former case or the pointer to the parent directory 106d1fa59e9SXin LI * in the latter case. This is done to simplify tmpfs's code and, more 107bba7ed20SKonstantin Belousov * importantly, to remove redundancy. 108bba7ed20SKonstantin Belousov */ 1094fd5efe7SGleb Kurtsou RB_HEAD(tmpfs_dir, tmpfs_dirent); 110d1fa59e9SXin LI 111bba7ed20SKonstantin Belousov /* 112bba7ed20SKonstantin Belousov * Each entry in a directory has a cookie that identifies it. Cookies 113ad3638eeSXin LI * supersede offsets within directories because, given how tmpfs stores 1144fd5efe7SGleb Kurtsou * directories in memory, there is no such thing as an offset. 115ad3638eeSXin LI * 116ad3638eeSXin LI * The '.', '..' and the end of directory markers have fixed cookies which 117ad3638eeSXin LI * cannot collide with the cookies generated by other entries. The cookies 1184fd5efe7SGleb Kurtsou * for the other entries are generated based on the file name hash value or 1194fd5efe7SGleb Kurtsou * unique number in case of name hash collision. 120ad3638eeSXin LI * 1214fd5efe7SGleb Kurtsou * To preserve compatibility cookies are limited to 31 bits. 1224fd5efe7SGleb Kurtsou */ 1234fd5efe7SGleb Kurtsou 124d1fa59e9SXin LI #define TMPFS_DIRCOOKIE_DOT 0 125d1fa59e9SXin LI #define TMPFS_DIRCOOKIE_DOTDOT 1 126d1fa59e9SXin LI #define TMPFS_DIRCOOKIE_EOF 2 1274fd5efe7SGleb Kurtsou #define TMPFS_DIRCOOKIE_MASK ((off_t)0x3fffffffU) 1284fd5efe7SGleb Kurtsou #define TMPFS_DIRCOOKIE_MIN ((off_t)0x00000004U) 1294fd5efe7SGleb Kurtsou #define TMPFS_DIRCOOKIE_DUP ((off_t)0x40000000U) 1304fd5efe7SGleb Kurtsou #define TMPFS_DIRCOOKIE_DUPHEAD ((off_t)0x80000000U) 1314fd5efe7SGleb Kurtsou #define TMPFS_DIRCOOKIE_DUP_MIN TMPFS_DIRCOOKIE_DUP 1324fd5efe7SGleb Kurtsou #define TMPFS_DIRCOOKIE_DUP_MAX \ 1334fd5efe7SGleb Kurtsou (TMPFS_DIRCOOKIE_DUP | TMPFS_DIRCOOKIE_MASK) 134d1fa59e9SXin LI 135d1fa59e9SXin LI /* 13656242a4cSFedor Uporov * Internal representation of a tmpfs extended attribute entry. 13756242a4cSFedor Uporov */ 13856242a4cSFedor Uporov LIST_HEAD(tmpfs_extattr_list, tmpfs_extattr); 13956242a4cSFedor Uporov 14056242a4cSFedor Uporov struct tmpfs_extattr { 14156242a4cSFedor Uporov LIST_ENTRY(tmpfs_extattr) ea_extattrs; 14256242a4cSFedor Uporov int ea_namespace; /* attr namespace */ 14356242a4cSFedor Uporov char *ea_name; /* attr name */ 14456242a4cSFedor Uporov unsigned char ea_namelen; /* attr name length */ 14556242a4cSFedor Uporov char *ea_value; /* attr value buffer */ 14656242a4cSFedor Uporov ssize_t ea_size; /* attr value size */ 14756242a4cSFedor Uporov }; 14856242a4cSFedor Uporov 14956242a4cSFedor Uporov /* 150d1fa59e9SXin LI * Internal representation of a tmpfs file system node. 151d1fa59e9SXin LI * 152d1fa59e9SXin LI * This structure is splitted in two parts: one holds attributes common 153d1fa59e9SXin LI * to all file types and the other holds data that is only applicable to 154d1fa59e9SXin LI * a particular type. The code must be careful to only access those 155d1fa59e9SXin LI * attributes that are actually allowed by the node's type. 156d1fa59e9SXin LI * 157d1fa59e9SXin LI * Below is the key of locks used to protected the fields in the following 158d1fa59e9SXin LI * structures. 159bba7ed20SKonstantin Belousov * (v) vnode lock in exclusive mode 160bba7ed20SKonstantin Belousov * (vi) vnode lock in exclusive mode, or vnode lock in shared vnode and 161bba7ed20SKonstantin Belousov * tn_interlock 162bba7ed20SKonstantin Belousov * (i) tn_interlock 163280ffa5eSKonstantin Belousov * (m) tmpfs_mount tm_allnode_lock 164bba7ed20SKonstantin Belousov * (c) stable after creation 16537aea264SKonstantin Belousov * (v) tn_reg.tn_aobj vm_object lock 166d1fa59e9SXin LI */ 167d1fa59e9SXin LI struct tmpfs_node { 168bba7ed20SKonstantin Belousov /* 169bba7ed20SKonstantin Belousov * Doubly-linked list entry which links all existing nodes for 170bba7ed20SKonstantin Belousov * a single file system. This is provided to ease the removal 171bba7ed20SKonstantin Belousov * of all nodes during the unmount operation, and to support 17264c25043SKonstantin Belousov * the implementation of VOP_VNTOCNP(). tn_attached is false 17364c25043SKonstantin Belousov * when the node is removed from list and unlocked. 174bba7ed20SKonstantin Belousov */ 175bba7ed20SKonstantin Belousov LIST_ENTRY(tmpfs_node) tn_entries; /* (m) */ 176f24aa01fSMateusz Guzik 177f24aa01fSMateusz Guzik /* Node identifier. */ 178f24aa01fSMateusz Guzik ino_t tn_id; /* (c) */ 179d1fa59e9SXin LI 180bba7ed20SKonstantin Belousov /* 181bba7ed20SKonstantin Belousov * The node's type. Any of 'VBLK', 'VCHR', 'VDIR', 'VFIFO', 182d1fa59e9SXin LI * 'VLNK', 'VREG' and 'VSOCK' is allowed. The usage of vnode 183d1fa59e9SXin LI * types instead of a custom enumeration is to make things simpler 184bba7ed20SKonstantin Belousov * and faster, as we do not need to convert between two types. 185bba7ed20SKonstantin Belousov */ 186bba7ed20SKonstantin Belousov enum vtype tn_type; /* (c) */ 187d1fa59e9SXin LI 188f24aa01fSMateusz Guzik /* 189f24aa01fSMateusz Guzik * See the top comment. Reordered here to fill LP64 hole. 190f24aa01fSMateusz Guzik */ 191f24aa01fSMateusz Guzik bool tn_attached; /* (m) */ 192d1fa59e9SXin LI 193bba7ed20SKonstantin Belousov /* 194bba7ed20SKonstantin Belousov * Node's internal status. This is used by several file system 195d1fa59e9SXin LI * operations to do modifications to the node in a delayed 196bba7ed20SKonstantin Belousov * fashion. 197016b7c7eSKonstantin Belousov * 198016b7c7eSKonstantin Belousov * tn_accessed has a dedicated byte to allow update by store without 199016b7c7eSKonstantin Belousov * using atomics. This provides a micro-optimization to e.g. 200016b7c7eSKonstantin Belousov * tmpfs_read_pgcache(). 201bba7ed20SKonstantin Belousov */ 202016b7c7eSKonstantin Belousov uint8_t tn_status; /* (vi) */ 203016b7c7eSKonstantin Belousov uint8_t tn_accessed; /* unlocked */ 204d1fa59e9SXin LI 205bba7ed20SKonstantin Belousov /* 206bba7ed20SKonstantin Belousov * The node size. It does not necessarily match the real amount 207bba7ed20SKonstantin Belousov * of memory consumed by it. 208bba7ed20SKonstantin Belousov */ 209bba7ed20SKonstantin Belousov off_t tn_size; /* (v) */ 210d1fa59e9SXin LI 211d1fa59e9SXin LI /* Generic node attributes. */ 212bba7ed20SKonstantin Belousov uid_t tn_uid; /* (v) */ 213bba7ed20SKonstantin Belousov gid_t tn_gid; /* (v) */ 214bba7ed20SKonstantin Belousov mode_t tn_mode; /* (v) */ 21535b1a3abSJohn Baldwin int tn_links; /* (v) */ 216bba7ed20SKonstantin Belousov u_long tn_flags; /* (v) */ 217bba7ed20SKonstantin Belousov struct timespec tn_atime; /* (vi) */ 218bba7ed20SKonstantin Belousov struct timespec tn_mtime; /* (vi) */ 219bba7ed20SKonstantin Belousov struct timespec tn_ctime; /* (vi) */ 220bba7ed20SKonstantin Belousov struct timespec tn_birthtime; /* (v) */ 221bba7ed20SKonstantin Belousov unsigned long tn_gen; /* (c) */ 222d1fa59e9SXin LI 223bba7ed20SKonstantin Belousov /* 224bba7ed20SKonstantin Belousov * As there is a single vnode for each active file within the 225d1fa59e9SXin LI * system, care has to be taken to avoid allocating more than one 226d1fa59e9SXin LI * vnode per file. In order to do this, a bidirectional association 227d1fa59e9SXin LI * is kept between vnodes and nodes. 228d1fa59e9SXin LI * 229d1fa59e9SXin LI * Whenever a vnode is allocated, its v_data field is updated to 230d1fa59e9SXin LI * point to the node it references. At the same time, the node's 231d1fa59e9SXin LI * tn_vnode field is modified to point to the new vnode representing 232d1fa59e9SXin LI * it. Further attempts to allocate a vnode for this same node will 233d1fa59e9SXin LI * result in returning a new reference to the value stored in 234d1fa59e9SXin LI * tn_vnode. 235d1fa59e9SXin LI * 236d1fa59e9SXin LI * May be NULL when the node is unused (that is, no vnode has been 237bba7ed20SKonstantin Belousov * allocated for it or it has been reclaimed). 238bba7ed20SKonstantin Belousov */ 239bba7ed20SKonstantin Belousov struct vnode * tn_vnode; /* (i) */ 240d1fa59e9SXin LI 241bba7ed20SKonstantin Belousov /* 242bba7ed20SKonstantin Belousov * Interlock to protect tn_vpstate, and tn_status under shared 2435dc11286SKonstantin Belousov * vnode lock. 2445dc11286SKonstantin Belousov */ 245d1fa59e9SXin LI struct mtx tn_interlock; 246d1fa59e9SXin LI 247bba7ed20SKonstantin Belousov /* 248bba7ed20SKonstantin Belousov * Identify if current node has vnode assiocate with 249d1fa59e9SXin LI * or allocating vnode. 250d1fa59e9SXin LI */ 251bba7ed20SKonstantin Belousov int tn_vpstate; /* (i) */ 252d1fa59e9SXin LI 25364c25043SKonstantin Belousov /* Transient refcounter on this node. */ 2544601f5f5SKonstantin Belousov u_int tn_refcount; /* 0<->1 (m) + (i) */ 25564c25043SKonstantin Belousov 25656242a4cSFedor Uporov /* Extended attributes of this node. */ 25756242a4cSFedor Uporov struct tmpfs_extattr_list tn_extattrs; /* (v) */ 25856242a4cSFedor Uporov 259d1fa59e9SXin LI /* misc data field for different tn_type node */ 260d1fa59e9SXin LI union { 261d1fa59e9SXin LI /* Valid when tn_type == VBLK || tn_type == VCHR. */ 262bba7ed20SKonstantin Belousov dev_t tn_rdev; /* (c) */ 263d1fa59e9SXin LI 264d1fa59e9SXin LI /* Valid when tn_type == VDIR. */ 265d1fa59e9SXin LI struct tn_dir { 266bba7ed20SKonstantin Belousov /* 267bba7ed20SKonstantin Belousov * Pointer to the parent directory. The root 268d1fa59e9SXin LI * directory has a pointer to itself in this field; 269bba7ed20SKonstantin Belousov * this property identifies the root node. 270bba7ed20SKonstantin Belousov */ 271d1fa59e9SXin LI struct tmpfs_node * tn_parent; 272d1fa59e9SXin LI 273bba7ed20SKonstantin Belousov /* 274bba7ed20SKonstantin Belousov * Head of a tree that links the contents of 275bba7ed20SKonstantin Belousov * the directory together. 276bba7ed20SKonstantin Belousov */ 277d1fa59e9SXin LI struct tmpfs_dir tn_dirhead; 278d1fa59e9SXin LI 279bba7ed20SKonstantin Belousov /* 280bba7ed20SKonstantin Belousov * Head of a list the contains fake directory entries 2814fd5efe7SGleb Kurtsou * heads, i.e. entries with TMPFS_DIRCOOKIE_DUPHEAD 282bba7ed20SKonstantin Belousov * flag. 283bba7ed20SKonstantin Belousov */ 2844fd5efe7SGleb Kurtsou struct tmpfs_dir_duphead tn_dupindex; 2854fd5efe7SGleb Kurtsou 286bba7ed20SKonstantin Belousov /* 287bba7ed20SKonstantin Belousov * Number and pointer of the first directory entry 288d1fa59e9SXin LI * returned by the readdir operation if it were 289d1fa59e9SXin LI * called again to continue reading data from the 290d1fa59e9SXin LI * same directory as before. This is used to speed 291d1fa59e9SXin LI * up reads of long directories, assuming that no 292d1fa59e9SXin LI * more than one read is in progress at a given time. 293bba7ed20SKonstantin Belousov * Otherwise, these values are discarded. 294bba7ed20SKonstantin Belousov */ 295d1fa59e9SXin LI off_t tn_readdir_lastn; 296d1fa59e9SXin LI struct tmpfs_dirent * tn_readdir_lastp; 297d1fa59e9SXin LI } tn_dir; 298d1fa59e9SXin LI 299d1fa59e9SXin LI /* Valid when tn_type == VLNK. */ 300d1fa59e9SXin LI /* The link's target, allocated from a string pool. */ 301618029afSMateusz Guzik struct tn_link { 302618029afSMateusz Guzik char * tn_link_target; /* (c) */ 303618029afSMateusz Guzik char tn_link_smr; /* (c) */ 304618029afSMateusz Guzik } tn_link; 305d1fa59e9SXin LI 306d1fa59e9SXin LI /* Valid when tn_type == VREG. */ 307d1fa59e9SXin LI struct tn_reg { 308bba7ed20SKonstantin Belousov /* 309bba7ed20SKonstantin Belousov * The contents of regular files stored in a 310bba7ed20SKonstantin Belousov * tmpfs file system are represented by a 311bba7ed20SKonstantin Belousov * single anonymous memory object (aobj, for 312bba7ed20SKonstantin Belousov * short). The aobj provides direct access to 313bba7ed20SKonstantin Belousov * any position within the file. It is a task 314bba7ed20SKonstantin Belousov * of the memory management subsystem to issue 315bba7ed20SKonstantin Belousov * the required page ins or page outs whenever 316bba7ed20SKonstantin Belousov * a position within the file is accessed. 317bba7ed20SKonstantin Belousov */ 318bba7ed20SKonstantin Belousov vm_object_t tn_aobj; /* (c) */ 319081e36e7SKonstantin Belousov struct tmpfs_mount *tn_tmp; /* (c) */ 32037aea264SKonstantin Belousov vm_pindex_t tn_pages; /* (v) */ 321d1fa59e9SXin LI } tn_reg; 322bba7ed20SKonstantin Belousov } tn_spec; /* (v) */ 323d1fa59e9SXin LI }; 324d1fa59e9SXin LI LIST_HEAD(tmpfs_node_list, tmpfs_node); 325d1fa59e9SXin LI 326d1fa59e9SXin LI #define tn_rdev tn_spec.tn_rdev 327d1fa59e9SXin LI #define tn_dir tn_spec.tn_dir 328618029afSMateusz Guzik #define tn_link_target tn_spec.tn_link.tn_link_target 329618029afSMateusz Guzik #define tn_link_smr tn_spec.tn_link.tn_link_smr 330d1fa59e9SXin LI #define tn_reg tn_spec.tn_reg 331d1fa59e9SXin LI #define tn_fifo tn_spec.tn_fifo 332d1fa59e9SXin LI 33335b1a3abSJohn Baldwin #define TMPFS_LINK_MAX INT_MAX 33435b1a3abSJohn Baldwin 335d1fa59e9SXin LI #define TMPFS_NODE_LOCK(node) mtx_lock(&(node)->tn_interlock) 336d1fa59e9SXin LI #define TMPFS_NODE_UNLOCK(node) mtx_unlock(&(node)->tn_interlock) 337fb755714SXin LI #define TMPFS_NODE_MTX(node) (&(node)->tn_interlock) 338d2ca06cdSKonstantin Belousov #define TMPFS_NODE_ASSERT_LOCKED(node) mtx_assert(TMPFS_NODE_MTX(node), \ 339d2ca06cdSKonstantin Belousov MA_OWNED) 340d1fa59e9SXin LI 34182cf92d4SXin LI #ifdef INVARIANTS 34282cf92d4SXin LI #define TMPFS_ASSERT_LOCKED(node) do { \ 3434960d0d4SKonstantin Belousov MPASS((node) != NULL); \ 3444960d0d4SKonstantin Belousov MPASS((node)->tn_vnode != NULL); \ 3454960d0d4SKonstantin Belousov ASSERT_VOP_LOCKED((node)->tn_vnode, "tmpfs assert"); \ 34682cf92d4SXin LI } while (0) 34782cf92d4SXin LI #else 34882cf92d4SXin LI #define TMPFS_ASSERT_LOCKED(node) (void)0 34982cf92d4SXin LI #endif 35082cf92d4SXin LI 351016b7c7eSKonstantin Belousov /* tn_vpstate */ 352d1fa59e9SXin LI #define TMPFS_VNODE_ALLOCATING 1 353d1fa59e9SXin LI #define TMPFS_VNODE_WANT 2 35482cf92d4SXin LI #define TMPFS_VNODE_DOOMED 4 3558239a7a8SKonstantin Belousov #define TMPFS_VNODE_WRECLAIM 8 356d1fa59e9SXin LI 357016b7c7eSKonstantin Belousov /* tn_status */ 358016b7c7eSKonstantin Belousov #define TMPFS_NODE_MODIFIED 0x01 359016b7c7eSKonstantin Belousov #define TMPFS_NODE_CHANGED 0x02 360016b7c7eSKonstantin Belousov 361d1fa59e9SXin LI /* 362d1fa59e9SXin LI * Internal representation of a tmpfs mount point. 363d1fa59e9SXin LI */ 364d1fa59e9SXin LI struct tmpfs_mount { 365bba7ed20SKonstantin Belousov /* 366ac1a10efSMaxim Sobolev * Original value of the "size" parameter, for reference purposes, 367ac1a10efSMaxim Sobolev * mostly. 368ac1a10efSMaxim Sobolev */ 369ac1a10efSMaxim Sobolev off_t tm_size_max; 370ac1a10efSMaxim Sobolev /* 371bba7ed20SKonstantin Belousov * Maximum number of memory pages available for use by the file 372d1fa59e9SXin LI * system, set during mount time. This variable must never be 373974fd8c6SXin LI * used directly as it may be bigger than the current amount of 374ed2159c9SMateusz Guzik * free memory; in the extreme case, it will hold the ULONG_MAX 375bba7ed20SKonstantin Belousov * value. 376bba7ed20SKonstantin Belousov */ 377ed2159c9SMateusz Guzik u_long tm_pages_max; 378d1fa59e9SXin LI 379da7aa277SGleb Kurtsou /* Number of pages in use by the file system. */ 380ed2159c9SMateusz Guzik u_long tm_pages_used; 381d1fa59e9SXin LI 382bba7ed20SKonstantin Belousov /* 383bba7ed20SKonstantin Belousov * Pointer to the node representing the root directory of this 384bba7ed20SKonstantin Belousov * file system. 385bba7ed20SKonstantin Belousov */ 386d1fa59e9SXin LI struct tmpfs_node * tm_root; 387d1fa59e9SXin LI 388bba7ed20SKonstantin Belousov /* 389bba7ed20SKonstantin Belousov * Maximum number of possible nodes for this file system; set 390d1fa59e9SXin LI * during mount time. We need a hard limit on the maximum number 391d1fa59e9SXin LI * of nodes to avoid allocating too much of them; their objects 392d1fa59e9SXin LI * cannot be released until the file system is unmounted. 393d1fa59e9SXin LI * Otherwise, we could easily run out of memory by creating lots 394bba7ed20SKonstantin Belousov * of empty files and then simply removing them. 395bba7ed20SKonstantin Belousov */ 396d1fa59e9SXin LI ino_t tm_nodes_max; 397d1fa59e9SXin LI 3988d9a89a3SXin LI /* unrhdr used to allocate inode numbers */ 39930e0cf49SMateusz Guzik struct unrhdr64 tm_ino_unr; 400d1fa59e9SXin LI 401d1fa59e9SXin LI /* Number of nodes currently that are in use. */ 402d1fa59e9SXin LI ino_t tm_nodes_inuse; 403d1fa59e9SXin LI 40456242a4cSFedor Uporov /* Memory used by extended attributes */ 40556242a4cSFedor Uporov uint64_t tm_ea_memory_inuse; 40656242a4cSFedor Uporov 40756242a4cSFedor Uporov /* Maximum memory available for extended attributes */ 40856242a4cSFedor Uporov uint64_t tm_ea_memory_max; 40956242a4cSFedor Uporov 41064c25043SKonstantin Belousov /* Refcounter on this struct tmpfs_mount. */ 41164c25043SKonstantin Belousov uint64_t tm_refcount; 41264c25043SKonstantin Belousov 413d1fa59e9SXin LI /* maximum representable file size */ 414d1fa59e9SXin LI u_int64_t tm_maxfilesize; 415d1fa59e9SXin LI 416bba7ed20SKonstantin Belousov /* 417bba7ed20SKonstantin Belousov * The used list contains all nodes that are currently used by 418bba7ed20SKonstantin Belousov * the file system; i.e., they refer to existing files. 419bba7ed20SKonstantin Belousov */ 420d1fa59e9SXin LI struct tmpfs_node_list tm_nodes_used; 421d1fa59e9SXin LI 422bba7ed20SKonstantin Belousov /* All node lock to protect the node list and tmp_pages_used. */ 423280ffa5eSKonstantin Belousov struct mtx tm_allnode_lock; 424d1fa59e9SXin LI 425c5ab5ce3SJaakko Heinonen /* Read-only status. */ 42600ac6a98SKonstantin Belousov bool tm_ronly; 42700ac6a98SKonstantin Belousov /* Do not use namecache. */ 42800ac6a98SKonstantin Belousov bool tm_nonc; 429c1e84733SKonstantin Belousov /* Do not update mtime on writes through mmaped areas. */ 430c1e84733SKonstantin Belousov bool tm_nomtime; 431d1fa59e9SXin LI }; 432280ffa5eSKonstantin Belousov #define TMPFS_LOCK(tm) mtx_lock(&(tm)->tm_allnode_lock) 433280ffa5eSKonstantin Belousov #define TMPFS_UNLOCK(tm) mtx_unlock(&(tm)->tm_allnode_lock) 434280ffa5eSKonstantin Belousov #define TMPFS_MP_ASSERT_LOCKED(tm) mtx_assert(&(tm)->tm_allnode_lock, MA_OWNED) 435d1fa59e9SXin LI 436d1fa59e9SXin LI /* 437d1fa59e9SXin LI * This structure maps a file identifier to a tmpfs node. Used by the 438d1fa59e9SXin LI * NFS code. 439d1fa59e9SXin LI */ 440693d10a2SRyan Moeller struct tmpfs_fid_data { 441693d10a2SRyan Moeller ino_t tfd_id; 442693d10a2SRyan Moeller unsigned long tfd_gen; 443d1fa59e9SXin LI }; 444693d10a2SRyan Moeller _Static_assert(sizeof(struct tmpfs_fid_data) <= MAXFIDSZ, 445693d10a2SRyan Moeller "(struct tmpfs_fid_data) is larger than (struct fid).fid_data"); 446d1fa59e9SXin LI 4471c07d69bSKonstantin Belousov struct tmpfs_dir_cursor { 4481c07d69bSKonstantin Belousov struct tmpfs_dirent *tdc_current; 4491c07d69bSKonstantin Belousov struct tmpfs_dirent *tdc_tree; 4501c07d69bSKonstantin Belousov }; 4511c07d69bSKonstantin Belousov 452d1fa59e9SXin LI #ifdef _KERNEL 453d1fa59e9SXin LI /* 454d1fa59e9SXin LI * Prototypes for tmpfs_subr.c. 455d1fa59e9SXin LI */ 456d1fa59e9SXin LI 45764c25043SKonstantin Belousov void tmpfs_ref_node(struct tmpfs_node *node); 4584cda7f7eSKonstantin Belousov int tmpfs_alloc_node(struct mount *mp, struct tmpfs_mount *, enum vtype, 459d1fa59e9SXin LI uid_t uid, gid_t gid, mode_t mode, struct tmpfs_node *, 4601493c2eeSBrooks Davis const char *, dev_t, struct tmpfs_node **); 461081e36e7SKonstantin Belousov int tmpfs_fo_close(struct file *fp, struct thread *td); 462d1fa59e9SXin LI void tmpfs_free_node(struct tmpfs_mount *, struct tmpfs_node *); 46364c25043SKonstantin Belousov bool tmpfs_free_node_locked(struct tmpfs_mount *, struct tmpfs_node *, bool); 46464c25043SKonstantin Belousov void tmpfs_free_tmp(struct tmpfs_mount *); 465d1fa59e9SXin LI int tmpfs_alloc_dirent(struct tmpfs_mount *, struct tmpfs_node *, 4664fd5efe7SGleb Kurtsou const char *, u_int, struct tmpfs_dirent **); 4674fd5efe7SGleb Kurtsou void tmpfs_free_dirent(struct tmpfs_mount *, struct tmpfs_dirent *); 4684fd5efe7SGleb Kurtsou void tmpfs_dirent_init(struct tmpfs_dirent *, const char *, u_int); 469158cc900SKonstantin Belousov void tmpfs_destroy_vobject(struct vnode *vp, vm_object_t obj); 4700ae6383dSXin LI int tmpfs_alloc_vp(struct mount *, struct tmpfs_node *, int, 471dfd233edSAttilio Rao struct vnode **); 472d1fa59e9SXin LI void tmpfs_free_vp(struct vnode *); 473d1fa59e9SXin LI int tmpfs_alloc_file(struct vnode *, struct vnode **, struct vattr *, 4741493c2eeSBrooks Davis struct componentname *, const char *); 475f40cb1c6SKonstantin Belousov void tmpfs_check_mtime(struct vnode *); 476d1fa59e9SXin LI void tmpfs_dir_attach(struct vnode *, struct tmpfs_dirent *); 477d1fa59e9SXin LI void tmpfs_dir_detach(struct vnode *, struct tmpfs_dirent *); 4784fd5efe7SGleb Kurtsou void tmpfs_dir_destroy(struct tmpfs_mount *, struct tmpfs_node *); 479d1fa59e9SXin LI struct tmpfs_dirent * tmpfs_dir_lookup(struct tmpfs_node *node, 480e3c7e753SKonstantin Belousov struct tmpfs_node *f, 481d1fa59e9SXin LI struct componentname *cnp); 482e1cdc30fSKonstantin Belousov int tmpfs_dir_getdents(struct tmpfs_mount *, struct tmpfs_node *, 483b214fcceSAlan Somers struct uio *, int, uint64_t *, int *); 48499d57a6bSEd Schouten int tmpfs_dir_whiteout_add(struct vnode *, struct componentname *); 48599d57a6bSEd Schouten void tmpfs_dir_whiteout_remove(struct vnode *, struct componentname *); 4860b05cac3SAlan Cox int tmpfs_reg_resize(struct vnode *, off_t, boolean_t); 4878d7cd10bSKa Ho Ng int tmpfs_reg_punch_hole(struct vnode *vp, off_t *, off_t *); 488b4b2596bSPawel Jakub Dawidek int tmpfs_chflags(struct vnode *, u_long, struct ucred *, struct thread *); 489d1fa59e9SXin LI int tmpfs_chmod(struct vnode *, mode_t, struct ucred *, struct thread *); 490d1fa59e9SXin LI int tmpfs_chown(struct vnode *, uid_t, gid_t, struct ucred *, 491d1fa59e9SXin LI struct thread *); 492d1fa59e9SXin LI int tmpfs_chsize(struct vnode *, u_quad_t, struct ucred *, struct thread *); 4937b81a399SKonstantin Belousov int tmpfs_chtimes(struct vnode *, struct vattr *, struct ucred *cred, 4947b81a399SKonstantin Belousov struct thread *); 495d1fa59e9SXin LI void tmpfs_itimes(struct vnode *, const struct timespec *, 496d1fa59e9SXin LI const struct timespec *); 497d1fa59e9SXin LI 498016b7c7eSKonstantin Belousov void tmpfs_set_accessed(struct tmpfs_mount *tm, struct tmpfs_node *node); 499e1cdc30fSKonstantin Belousov void tmpfs_set_status(struct tmpfs_mount *tm, struct tmpfs_node *node, 500e1cdc30fSKonstantin Belousov int status); 501d1fa59e9SXin LI int tmpfs_truncate(struct vnode *, off_t); 5021c07d69bSKonstantin Belousov struct tmpfs_dirent *tmpfs_dir_first(struct tmpfs_node *dnode, 5031c07d69bSKonstantin Belousov struct tmpfs_dir_cursor *dc); 5041c07d69bSKonstantin Belousov struct tmpfs_dirent *tmpfs_dir_next(struct tmpfs_node *dnode, 5051c07d69bSKonstantin Belousov struct tmpfs_dir_cursor *dc); 50656242a4cSFedor Uporov bool tmpfs_pages_check_avail(struct tmpfs_mount *tmp, size_t req_pages); 50756242a4cSFedor Uporov void tmpfs_extattr_free(struct tmpfs_extattr* ea); 5082abdae33SMateusz Guzik static __inline void 5092abdae33SMateusz Guzik tmpfs_update(struct vnode *vp) 5102abdae33SMateusz Guzik { 5112abdae33SMateusz Guzik 5122abdae33SMateusz Guzik tmpfs_itimes(vp, NULL, NULL); 5132abdae33SMateusz Guzik } 514d1fa59e9SXin LI 515d1fa59e9SXin LI /* 516d1fa59e9SXin LI * Convenience macros to simplify some logical expressions. 517d1fa59e9SXin LI */ 518d1fa59e9SXin LI #define IMPLIES(a, b) (!(a) || (b)) 519d1fa59e9SXin LI 520d1fa59e9SXin LI /* 521d1fa59e9SXin LI * Checks that the directory entry pointed by 'de' matches the name 'name' 522d1fa59e9SXin LI * with a length of 'len'. 523d1fa59e9SXin LI */ 524d1fa59e9SXin LI #define TMPFS_DIRENT_MATCHES(de, name, len) \ 5254fd5efe7SGleb Kurtsou (de->td_namelen == len && \ 5264fd5efe7SGleb Kurtsou bcmp((de)->ud.td_name, (name), (de)->td_namelen) == 0) 527d1fa59e9SXin LI 528d1fa59e9SXin LI /* 529d1fa59e9SXin LI * Ensures that the node pointed by 'node' is a directory and that its 530d1fa59e9SXin LI * contents are consistent with respect to directories. 531d1fa59e9SXin LI */ 5324fd5efe7SGleb Kurtsou #define TMPFS_VALIDATE_DIR(node) do { \ 533d1fa59e9SXin LI MPASS((node)->tn_type == VDIR); \ 534d1fa59e9SXin LI MPASS((node)->tn_size % sizeof(struct tmpfs_dirent) == 0); \ 5354fd5efe7SGleb Kurtsou } while (0) 536d1fa59e9SXin LI 537d1fa59e9SXin LI /* 538da7aa277SGleb Kurtsou * Amount of memory pages to reserve for the system (e.g., to not use by 539da7aa277SGleb Kurtsou * tmpfs). 540d1fa59e9SXin LI */ 541b4b3e349SAllan Jude #if !defined(TMPFS_PAGES_MINRESERVED) 542da7aa277SGleb Kurtsou #define TMPFS_PAGES_MINRESERVED (4 * 1024 * 1024 / PAGE_SIZE) 543b4b3e349SAllan Jude #endif 544d1fa59e9SXin LI 54556242a4cSFedor Uporov /* 54656242a4cSFedor Uporov * Amount of memory to reserve for extended attributes. 54756242a4cSFedor Uporov */ 54856242a4cSFedor Uporov #if !defined(TMPFS_EA_MEMORY_RESERVED) 54956242a4cSFedor Uporov #define TMPFS_EA_MEMORY_RESERVED (16 * 1024 * 1024) 55056242a4cSFedor Uporov #endif 55156242a4cSFedor Uporov 552da7aa277SGleb Kurtsou size_t tmpfs_mem_avail(void); 553da7aa277SGleb Kurtsou size_t tmpfs_pages_used(struct tmpfs_mount *tmp); 55428bc23abSKonstantin Belousov int tmpfs_subr_init(void); 555a51c8071SKonstantin Belousov void tmpfs_subr_uninit(void); 556d1fa59e9SXin LI 55728bc23abSKonstantin Belousov extern int tmpfs_pager_type; 55828bc23abSKonstantin Belousov 559d1fa59e9SXin LI /* 560d1fa59e9SXin LI * Macros/functions to convert from generic data structures to tmpfs 561d1fa59e9SXin LI * specific ones. 562d1fa59e9SXin LI */ 563d1fa59e9SXin LI 564d9dc64f1SKonstantin Belousov static inline struct vnode * 565d9dc64f1SKonstantin Belousov VM_TO_TMPFS_VP(vm_object_t obj) 566d9dc64f1SKonstantin Belousov { 567d9dc64f1SKonstantin Belousov struct tmpfs_node *node; 568d9dc64f1SKonstantin Belousov 56937aea264SKonstantin Belousov if ((obj->flags & OBJ_TMPFS) == 0) 57037aea264SKonstantin Belousov return (NULL); 571d9dc64f1SKonstantin Belousov 572d9dc64f1SKonstantin Belousov /* 573d9dc64f1SKonstantin Belousov * swp_priv is the back-pointer to the tmpfs node, if any, 574d9dc64f1SKonstantin Belousov * which uses the vm object as backing store. The object 575d9dc64f1SKonstantin Belousov * handle is not used to avoid locking sw_alloc_sx on tmpfs 576d9dc64f1SKonstantin Belousov * node instantiation/destroy. 577d9dc64f1SKonstantin Belousov */ 578d9dc64f1SKonstantin Belousov node = obj->un_pager.swp.swp_priv; 579d9dc64f1SKonstantin Belousov return (node->tn_vnode); 580d9dc64f1SKonstantin Belousov } 581d9dc64f1SKonstantin Belousov 582bba7ed20SKonstantin Belousov static inline struct tmpfs_mount * 58337aea264SKonstantin Belousov VM_TO_TMPFS_MP(vm_object_t obj) 58437aea264SKonstantin Belousov { 58537aea264SKonstantin Belousov struct tmpfs_node *node; 58637aea264SKonstantin Belousov 58737aea264SKonstantin Belousov if ((obj->flags & OBJ_TMPFS) == 0) 58837aea264SKonstantin Belousov return (NULL); 58937aea264SKonstantin Belousov 59037aea264SKonstantin Belousov node = obj->un_pager.swp.swp_priv; 59137aea264SKonstantin Belousov MPASS(node->tn_type == VREG); 59237aea264SKonstantin Belousov return (node->tn_reg.tn_tmp); 59337aea264SKonstantin Belousov } 59437aea264SKonstantin Belousov 59537aea264SKonstantin Belousov static inline struct tmpfs_mount * 596d1fa59e9SXin LI VFS_TO_TMPFS(struct mount *mp) 597d1fa59e9SXin LI { 598d1fa59e9SXin LI struct tmpfs_mount *tmp; 599d1fa59e9SXin LI 600bba7ed20SKonstantin Belousov MPASS(mp != NULL && mp->mnt_data != NULL); 601bba7ed20SKonstantin Belousov tmp = (struct tmpfs_mount *)mp->mnt_data; 602bba7ed20SKonstantin Belousov return (tmp); 603d1fa59e9SXin LI } 604d1fa59e9SXin LI 605bba7ed20SKonstantin Belousov static inline struct tmpfs_node * 606d1fa59e9SXin LI VP_TO_TMPFS_NODE(struct vnode *vp) 607d1fa59e9SXin LI { 608d1fa59e9SXin LI struct tmpfs_node *node; 609d1fa59e9SXin LI 610bba7ed20SKonstantin Belousov MPASS(vp != NULL && vp->v_data != NULL); 611d1fa59e9SXin LI node = (struct tmpfs_node *)vp->v_data; 612bba7ed20SKonstantin Belousov return (node); 613d1fa59e9SXin LI } 614d1fa59e9SXin LI 615172ffe70SMateusz Guzik #define VP_TO_TMPFS_NODE_SMR(vp) \ 616172ffe70SMateusz Guzik ((struct tmpfs_node *)vn_load_v_data_smr(vp)) 617172ffe70SMateusz Guzik 618bba7ed20SKonstantin Belousov static inline struct tmpfs_node * 619d1fa59e9SXin LI VP_TO_TMPFS_DIR(struct vnode *vp) 620d1fa59e9SXin LI { 621d1fa59e9SXin LI struct tmpfs_node *node; 622d1fa59e9SXin LI 623d1fa59e9SXin LI node = VP_TO_TMPFS_NODE(vp); 624d1fa59e9SXin LI TMPFS_VALIDATE_DIR(node); 625bba7ed20SKonstantin Belousov return (node); 626d1fa59e9SXin LI } 627d1fa59e9SXin LI 62800ac6a98SKonstantin Belousov static inline bool 62900ac6a98SKonstantin Belousov tmpfs_use_nc(struct vnode *vp) 63000ac6a98SKonstantin Belousov { 63100ac6a98SKonstantin Belousov 63200ac6a98SKonstantin Belousov return (!(VFS_TO_TMPFS(vp->v_mount)->tm_nonc)); 63300ac6a98SKonstantin Belousov } 6342abdae33SMateusz Guzik 6352abdae33SMateusz Guzik static inline void 6362abdae33SMateusz Guzik tmpfs_update_getattr(struct vnode *vp) 6372abdae33SMateusz Guzik { 6382abdae33SMateusz Guzik struct tmpfs_node *node; 6392abdae33SMateusz Guzik 6402abdae33SMateusz Guzik node = VP_TO_TMPFS_NODE(vp); 641016b7c7eSKonstantin Belousov if (__predict_false((node->tn_status & (TMPFS_NODE_MODIFIED | 642016b7c7eSKonstantin Belousov TMPFS_NODE_CHANGED)) != 0 || node->tn_accessed)) 6432abdae33SMateusz Guzik tmpfs_update(vp); 6442abdae33SMateusz Guzik } 6452abdae33SMateusz Guzik 646081e36e7SKonstantin Belousov extern struct fileops tmpfs_fnops; 647081e36e7SKonstantin Belousov 648f9f4c60aSDoug Moore #endif /* _KERNEL */ 64900ac6a98SKonstantin Belousov 650d1fa59e9SXin LI #endif /* _FS_TMPFS_TMPFS_H_ */ 651