bsd/sys/vnode_internal.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  29 /*
  30  * Copyright (c) 1989, 1993
  31  *      The Regents of the University of California.  All rights reserved.
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions
  35  * are met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. All advertising materials mentioning features or use of this software
  42  *    must display the following acknowledgement:
  43  *      This product includes software developed by the University of
  44  *      California, Berkeley and its contributors.
  45  * 4. Neither the name of the University nor the names of its contributors
  46  *    may be used to endorse or promote products derived from this software
  47  *    without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59  * SUCH DAMAGE.
  60  *
  61  *      @(#)vnode.h     8.17 (Berkeley) 5/20/95
  62  */
  63
  64 #ifndef _SYS_VNODE_INTERNAL_H_
  65 #define _SYS_VNODE_INTERNAL_H_
  66
  67 #define INTERIM_FSNODE_LOCK     1
  68
  69 #include <sys/appleapiopts.h>
  70 #include <sys/cdefs.h>
  71 #include <sys/queue.h>
  72 #include <sys/lock.h>
  73
  74 #include <sys/time.h>
  75 #include <sys/uio.h>
  76
  77 #include <sys/vm.h>
  78 #include <sys/systm.h>
  79 #include <kern/locks.h>
  80 #include <vm/vm_kern.h>
  81 #include <sys/vnode.h>
  82 #include <sys/namei.h>
  83 #include <sys/vfs_context.h>
  84
  85
  86 struct lockf;
  87
  88 LIST_HEAD(buflists, buf);
  89
  90
  91 struct unsafe_fsnode {
  92         lck_mtx_t fsnodelock;
  93         int32_t   fsnode_count;
  94         void *    fsnodeowner;
  95 };
  96
  97 /*
  98  * Reading or writing any of these items requires holding the appropriate lock.
  99  * v_freelist is locked by the global vnode_list_lock
 100  * v_mntvnodes is locked by the mount_lock
 101  * v_nclinks and v_ncchildren are protected by the global name_cache_lock
 102  * v_cleanblkhd and v_dirtyblkhd and v_iterblkflags are locked via the global buf_mtxp
 103  * the rest of the structure is protected by the vnode_lock
 104  */
 105 struct vnode {
 106         lck_mtx_t v_lock;                       /* vnode mutex */
 107         TAILQ_ENTRY(vnode) v_freelist;          /* vnode freelist */
 108         TAILQ_ENTRY(vnode) v_mntvnodes;         /* vnodes for mount point */
 109         LIST_HEAD(, namecache) v_nclinks;       /* name cache entries that name this vnode */
 110         LIST_HEAD(, namecache) v_ncchildren;    /* name cache entries that regard us as there parent */
 111         vnode_t  v_defer_reclaimlist;           /* in case we have to defer the reclaim to avoid recursion */
 112         u_long   v_flag;                        /* vnode flags (see below) */
 113         u_short  v_lflag;                       /* vnode local and named ref flags */
 114         u_char   v_iterblkflags;                /* buf iterator flags */
 115         u_char   v_references;                  /* number of times io_count has been granted */
 116         int32_t  v_kusecount;                   /* count of in-kernel refs */
 117         int32_t  v_usecount;                    /* reference count of users */
 118         int32_t  v_iocount;                     /* iocounters */
 119         void *   v_owner;                       /* act that owns the vnode */
 120         enum vtype v_type;                      /* vnode type */
 121         u_long   v_id;                          /* identity of vnode contents */
 122         union {
 123                 struct mount    *vu_mountedhere;/* ptr to mounted vfs (VDIR) */
 124                 struct socket   *vu_socket;     /* unix ipc (VSOCK) */
 125                 struct specinfo *vu_specinfo;   /* device (VCHR, VBLK) */
 126                 struct fifoinfo *vu_fifoinfo;   /* fifo (VFIFO) */
 127                 struct ubc_info *vu_ubcinfo;    /* valid for (VREG) */
 128         } v_un;
 129         struct  buflists v_cleanblkhd;          /* clean blocklist head */
 130         struct  buflists v_dirtyblkhd;          /* dirty blocklist head */
 131         kauth_cred_t v_cred;
 132         int     v_cred_timestamp;
 133         long    v_numoutput;                    /* num of writes in progress */
 134         long    v_writecount;                   /* reference count of writers */
 135         char *  v_name;                         /* name component of the vnode */
 136         vnode_t v_parent;                       /* pointer to parent vnode */
 137 #ifdef INTERIM_FSNODE_LOCK
 138         struct lockf    *v_lockf;               /* advisory lock list head */
 139         struct unsafe_fsnode *v_unsafefs;       /* pointer to struct used to lock */
 140 #endif                                          /* vnodes on unsafe filesystems */
 141         int     (**v_op)(void *);               /* vnode operations vector */
 142         enum vtagtype v_tag;                    /* type of underlying data */
 143         mount_t v_mount;                        /* ptr to vfs we are in */
 144         void *  v_data;                         /* private data for fs */
 145 };
 146
 147 #define v_mountedhere   v_un.vu_mountedhere
 148 #define v_socket        v_un.vu_socket
 149 #define v_specinfo      v_un.vu_specinfo
 150 #define v_fifoinfo      v_un.vu_fifoinfo
 151 #define v_ubcinfo       v_un.vu_ubcinfo
 152
 153
 154 /*
 155  * v_iterblkflags
 156  */
 157 #define VBI_ITER                0x1
 158 #define VBI_ITERWANT            0x2
 159 #define VBI_CLEAN               0x4
 160 #define VBI_DIRTY               0x8
 161 #define VBI_NEWBUF              0x10
 162
 163
 164 /*
 165  * v_lflags
 166  */
 167 #define VL_SUSPENDED    0x0001          /* vnode is suspended */
 168 #define VL_DRAIN        0x0002          /* vnode is being drained */
 169 #define VL_TERMINATE    0x0004          /* vnode is marked for termination */
 170 #define VL_TERMWANT     0x0008          /* vnode is marked for termination */
 171 #define VL_DEAD         0x0010          /* vnode is dead and completed recycle */
 172 #define VL_MARKTERM     0x0020          /* vnode is dead and completed recycle */
 173 #define VL_MOUNTDEAD    0x0040          /* v_moutnedhere is dead   */
 174 #define VL_NEEDINACTIVE 0x0080          /* delay VNOP_INACTIVE until iocount goes to 0 */
 175
 176 #define VNAMED_UBC      0x2000          /* ubc named reference */
 177 #define VNAMED_MOUNT    0x4000          /* mount point named reference */
 178 #define VNAMED_FSHASH   0x8000          /* FS hash named reference */
 179
 180
 181 /*
 182  * v_flags
 183  */
 184 #define VROOT           0x000001        /* root of its file system */
 185 #define VTEXT           0x000002        /* vnode is a pure text prototype */
 186 #define VSYSTEM         0x000004        /* vnode being used by kernel */
 187 #define VISTTY          0x000008        /* vnode represents a tty */
 188 #define VWASMAPPED      0x000010        /* vnode was mapped before */
 189 #define VTERMINATE      0x000020        /* terminating memory object */
 190 #define VTERMWANT       0x000040        /* wating for memory object death */
 191 #define VMOUNT          0x000080        /* mount operation in progress */
 192 #define VBWAIT          0x000100        /* waiting for output to complete */
 193 #define VALIASED        0x000200        /* vnode has an alias */
 194 #define VNOCACHE_DATA   0x000400        /* don't keep data cached once it's been consumed */
 195 #define VSTANDARD       0x000800        /* vnode obtained from common pool */
 196 #define VAGE            0x001000        /* Insert vnode at head of free list */
 197 #define VRAOFF          0x002000        /* read ahead disabled */
 198 #define VNCACHEABLE     0x004000        /* vnode is allowed to be put back in name cache */
 199 #define VUINACTIVE      0x008000        /* UBC vnode is on inactive list */
 200 #define VSWAP           0x010000        /* vnode is being used as swapfile */
 201 #define VTHROTTLED      0x020000        /* writes or pageouts have been throttled */
 202                 /* wakeup tasks waiting when count falls below threshold */
 203 #define VNOFLUSH        0x040000        /* don't vflush() if SKIPSYSTEM */
 204 #define VLOCKLOCAL      0x080000        /* this vnode does adv locking in vfs */
 205 #define VISHARDLINK     0x100000        /* hard link needs special processing on lookup and in volfs */
 206
 207 #define VCRED_EXPIRED   2               /* number of seconds to keep cached credential valid */
 208
 209
 210 /*
 211  * Global vnode data.
 212  */
 213 extern  struct vnode *rootvnode;        /* root (i.e. "/") vnode */
 214
 215
 216 /*
 217  * Mods for exensibility.
 218  */
 219
 220 /*
 221  * Flags for vdesc_flags:
 222  */
 223 #define VDESC_MAX_VPS           16
 224 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
 225 #define VDESC_VP0_WILLRELE      0x0001
 226 #define VDESC_VP1_WILLRELE      0x0002
 227 #define VDESC_VP2_WILLRELE      0x0004
 228 #define VDESC_VP3_WILLRELE      0x0008
 229 #define VDESC_NOMAP_VPP         0x0100
 230 #define VDESC_VPP_WILLRELE      0x0200
 231
 232 /*
 233  * VDESC_NO_OFFSET is used to identify the end of the offset list
 234  * and in places where no such field exists.
 235  */
 236 #define VDESC_NO_OFFSET -1
 237
 238 /*
 239  * This structure describes the vnode operation taking place.
 240  */
 241 struct vnodeop_desc {
 242         int     vdesc_offset;           /* offset in vector--first for speed */
 243         char    *vdesc_name;            /* a readable name for debugging */
 244         int     vdesc_flags;            /* VDESC_* flags */
 245
 246         /*
 247          * These ops are used by bypass routines to map and locate arguments.
 248          * Creds and procs are not needed in bypass routines, but sometimes
 249          * they are useful to (for example) transport layers.
 250          * Nameidata is useful because it has a cred in it.
 251          */
 252         int     *vdesc_vp_offsets;      /* list ended by VDESC_NO_OFFSET */
 253         int     vdesc_vpp_offset;       /* return vpp location */
 254         int     vdesc_cred_offset;      /* cred location, if any */
 255         int     vdesc_proc_offset;      /* proc location, if any */
 256         int     vdesc_componentname_offset; /* if any */
 257         int     vdesc_context_offset;   /* context location, if any */
 258         /*
 259          * Finally, we've got a list of private data (about each operation)
 260          * for each transport layer.  (Support to manage this list is not
 261          * yet part of BSD.)
 262          */
 263         caddr_t *vdesc_transports;
 264 };
 265
 266 /*
 267  * A list of all the operation descs.
 268  */
 269 extern struct vnodeop_desc *vnodeop_descs[];
 270
 271 /*
 272  * Interlock for scanning list of vnodes attached to a mountpoint
 273  */
 274 extern void * mntvnode_slock;
 275
 276 /*
 277  * This macro is very helpful in defining those offsets in the vdesc struct.
 278  *
 279  * This is stolen from X11R4.  I ingored all the fancy stuff for
 280  * Crays, so if you decide to port this to such a serious machine,
 281  * you might want to consult Intrisics.h's XtOffset{,Of,To}.
 282  */
 283 #define VOPARG_OFFSET(p_type,field) \
 284         ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
 285 #define VOPARG_OFFSETOF(s_type,field) \
 286         VOPARG_OFFSET(s_type*,field)
 287 #define VOPARG_OFFSETTO(S_TYPE,S_OFFSET,STRUCT_P) \
 288         ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET)))
 289
 290
 291
 292 /*
 293  * VOCALL calls an op given an ops vector.  We break it out because BSD's
 294  * vclean changes the ops vector and then wants to call ops with the old
 295  * vector.
 296  */
 297 #define VOCALL(OPSV,OFF,AP) (( *((OPSV)[(OFF)])) (AP))
 298
 299 /*
 300  * This call works for vnodes in the kernel.
 301  */
 302 #define VCALL(VP,OFF,AP) VOCALL((VP)->v_op,(OFF),(AP))
 303 #define VDESC(OP) (& __CONCAT(OP,_desc))
 304 #define VOFFSET(OP) (VDESC(OP)->vdesc_offset)
 305
 306
 307
 308 int     build_path(vnode_t first_vp, char *buff, int buflen, int *outlen);
 309 int     bdevvp(dev_t dev, struct vnode **vpp);
 310 void    cvtstat(struct stat *st, struct ostat *ost);
 311 void    vprint(const char *label, struct vnode *vp);
 312
 313
 314 __private_extern__ int is_package_name(char *name, int len);
 315 __private_extern__ int set_package_extensions_table(void *data, int nentries, int maxwidth);
 316 int     vn_rdwr(enum uio_rw rw, struct vnode *vp, caddr_t base,
 317                         int len, off_t offset, enum uio_seg segflg, int ioflg,
 318                         struct ucred *cred, int *aresid, struct proc *p);
 319 int     vn_rdwr_64(enum uio_rw rw, struct vnode *vp, uint64_t base,
 320                         int64_t len, off_t offset, enum uio_seg segflg,
 321                         int ioflg, struct ucred *cred, int *aresid,
 322                         struct proc *p);
 323 void    fifo_printinfo(struct vnode *vp);
 324 int     vn_lock(struct vnode *vp, int flags, struct proc *p);
 325 int     vn_open(struct nameidata *ndp, int fmode, int cmode);
 326 int     vn_open_modflags(struct nameidata *ndp, int *fmode, int cmode);
 327 int     vn_open_auth(struct nameidata *ndp, int *fmode, struct vnode_attr *);
 328 int     vn_close(vnode_t, int flags, struct ucred *cred, struct proc *p);
 329
 330 #define VN_CREATE_NOAUTH                (1<<0)
 331 #define VN_CREATE_NOINHERIT             (1<<1)
 332 errno_t vn_create(vnode_t, vnode_t *, struct componentname *, struct vnode_attr *, int flags, vfs_context_t);
 333
 334
 335 int     vn_getxattr(vnode_t, const char *, uio_t, size_t *, int, vfs_context_t);
 336 int     vn_setxattr(vnode_t, const char *, uio_t, int, vfs_context_t);
 337 int     vn_removexattr(vnode_t, const char *, int, vfs_context_t);
 338 int     vn_listxattr(vnode_t, uio_t, size_t *, int, vfs_context_t);
 339
 340 void    name_cache_lock(void);
 341 void    name_cache_unlock(void);
 342
 343 char *  vnode_getname(vnode_t vp);
 344 void    vnode_putname(char *name);
 345
 346 vnode_t vnode_getparent(vnode_t vp);
 347
 348 int vn_pathconf(vnode_t, int, register_t *, vfs_context_t);
 349
 350 void    vnode_list_lock(void);
 351 void    vnode_list_unlock(void);
 352 int     vnode_ref_ext(vnode_t, int);
 353 void    vnode_rele_ext(vnode_t, int, int);
 354 void    vnode_rele_internal(vnode_t, int, int, int);
 355 int     vnode_getwithref(vnode_t);
 356 int     vnode_put_locked(vnode_t);
 357
 358 int     vnode_issock(vnode_t);
 359
 360 void    unlock_fsnode(vnode_t, int *);
 361 int     lock_fsnode(vnode_t, int *);
 362
 363 errno_t vnode_resume(vnode_t);
 364
 365 errno_t vnode_size(vnode_t, off_t *, vfs_context_t);
 366 errno_t vnode_setsize(vnode_t, off_t, int ioflag, vfs_context_t);
 367 int     vnode_setattr_fallback(vnode_t vp, struct vnode_attr *vap, vfs_context_t ctx);
 368
 369 void SPECHASH_LOCK(void);
 370 void SPECHASH_UNLOCK(void);
 371
 372 int check_cdevmounted(dev_t, enum vtype, int *);
 373
 374 void    vnode_authorize_init(void);
 375
 376 #endif /* !_SYS_VNODE_INTERNAL_H_ */