1facf4a8dSllai1 /* 2facf4a8dSllai1 * CDDL HEADER START 3facf4a8dSllai1 * 4facf4a8dSllai1 * The contents of this file are subject to the terms of the 5facf4a8dSllai1 * Common Development and Distribution License (the "License"). 6facf4a8dSllai1 * You may not use this file except in compliance with the License. 7facf4a8dSllai1 * 8facf4a8dSllai1 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9facf4a8dSllai1 * or http://www.opensolaris.org/os/licensing. 10facf4a8dSllai1 * See the License for the specific language governing permissions 11facf4a8dSllai1 * and limitations under the License. 12facf4a8dSllai1 * 13facf4a8dSllai1 * When distributing Covered Code, include this CDDL HEADER in each 14facf4a8dSllai1 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15facf4a8dSllai1 * If applicable, add the following below this CDDL HEADER, with the 16facf4a8dSllai1 * fields enclosed by brackets "[]" replaced with your own identifying 17facf4a8dSllai1 * information: Portions Copyright [yyyy] [name of copyright owner] 18facf4a8dSllai1 * 19facf4a8dSllai1 * CDDL HEADER END 20facf4a8dSllai1 */ 21facf4a8dSllai1 /* 220fbb751dSJohn Levon * Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved. 23facf4a8dSllai1 */ 24facf4a8dSllai1 25facf4a8dSllai1 #ifndef _SYS_SDEV_IMPL_H 26facf4a8dSllai1 #define _SYS_SDEV_IMPL_H 27facf4a8dSllai1 28facf4a8dSllai1 #ifdef __cplusplus 29facf4a8dSllai1 extern "C" { 30facf4a8dSllai1 #endif 31facf4a8dSllai1 32facf4a8dSllai1 #include <rpc/rpc.h> 33facf4a8dSllai1 #include <sys/dirent.h> 34facf4a8dSllai1 #include <sys/vfs.h> 35aa59c4cbSrsb #include <sys/vfs_opreg.h> 36facf4a8dSllai1 #include <sys/list.h> 37facf4a8dSllai1 #include <sys/nvpair.h> 38facf4a8dSllai1 39facf4a8dSllai1 /* 40facf4a8dSllai1 * sdev_nodes are the file-system specific part of the 41facf4a8dSllai1 * vnodes for the device filesystem. 42facf4a8dSllai1 * 43facf4a8dSllai1 * The device filesystem exports two node types: 44facf4a8dSllai1 * 45facf4a8dSllai1 * VDIR nodes to represent directories 46facf4a8dSllai1 * VCHR & VBLK nodes to represent devices 47facf4a8dSllai1 */ 48facf4a8dSllai1 49facf4a8dSllai1 /* 50facf4a8dSllai1 * /dev mount arguments 51facf4a8dSllai1 */ 52facf4a8dSllai1 struct sdev_mountargs { 53facf4a8dSllai1 uint64_t sdev_attrdir; 54facf4a8dSllai1 }; 55facf4a8dSllai1 56facf4a8dSllai1 57facf4a8dSllai1 /* 58facf4a8dSllai1 * Nvpair names of profile information (list of device files available) of 59facf4a8dSllai1 * non-global /dev mounts. These strings must be unique among them. 60facf4a8dSllai1 */ 61facf4a8dSllai1 #define SDEV_NVNAME_MOUNTPT "prof_mountpt" 62facf4a8dSllai1 #define SDEV_NVNAME_INCLUDE "prof_include" 63facf4a8dSllai1 #define SDEV_NVNAME_EXCLUDE "prof_exclude" 64facf4a8dSllai1 #define SDEV_NVNAME_SYMLINK "prof_symlink" 65facf4a8dSllai1 #define SDEV_NVNAME_MAP "prof_map" 66facf4a8dSllai1 67facf4a8dSllai1 /* 68facf4a8dSllai1 * supported devfsadm_cmd 69facf4a8dSllai1 */ 70facf4a8dSllai1 #define DEVFSADMD_RUN_ALL 1 71facf4a8dSllai1 72facf4a8dSllai1 /* 73facf4a8dSllai1 * devfsadm_error codes 74facf4a8dSllai1 */ 75facf4a8dSllai1 #define DEVFSADM_RUN_INVALID 1 76facf4a8dSllai1 #define DEVFSADM_RUN_EPERM 2 77facf4a8dSllai1 #define DEVFSADM_RUN_NOTSUP 3 78facf4a8dSllai1 79facf4a8dSllai1 /* 80facf4a8dSllai1 * devfsadm/devname door data structures 81facf4a8dSllai1 */ 82facf4a8dSllai1 typedef struct sdev_door_arg { 83facf4a8dSllai1 uint8_t devfsadm_cmd; /* what to do for devfsadm[d] */ 84facf4a8dSllai1 } sdev_door_arg_t; 85facf4a8dSllai1 86facf4a8dSllai1 typedef struct sdev_door_res { 87facf4a8dSllai1 int32_t devfsadm_error; 88facf4a8dSllai1 } sdev_door_res_t; 89facf4a8dSllai1 90facf4a8dSllai1 #ifdef _KERNEL 91facf4a8dSllai1 92facf4a8dSllai1 struct sdev_dprof { 93facf4a8dSllai1 int has_glob; 94facf4a8dSllai1 nvlist_t *dev_name; 95facf4a8dSllai1 nvlist_t *dev_map; 96facf4a8dSllai1 nvlist_t *dev_symlink; 97facf4a8dSllai1 nvlist_t *dev_glob_incdir; 98facf4a8dSllai1 nvlist_t *dev_glob_excdir; 99facf4a8dSllai1 }; 100facf4a8dSllai1 101facf4a8dSllai1 /* 102facf4a8dSllai1 * devname_handle_t 103facf4a8dSllai1 */ 104facf4a8dSllai1 struct devname_handle { 105facf4a8dSllai1 struct sdev_node *dh_data; /* the sdev_node */ 106facf4a8dSllai1 void *dh_args; 107facf4a8dSllai1 }; 108facf4a8dSllai1 typedef struct devname_handle devname_handle_t; 109facf4a8dSllai1 110facf4a8dSllai1 /* 111facf4a8dSllai1 * Per-instance node data for the global zone instance 112facf4a8dSllai1 * Only one mount of /dev in the global zone 113facf4a8dSllai1 */ 114facf4a8dSllai1 typedef struct sdev_global_data { 115facf4a8dSllai1 struct devname_handle sdev_ghandle; 116facf4a8dSllai1 ulong_t sdev_dir_ggen; /* name space generation # */ 117facf4a8dSllai1 } sdev_global_data_t; 118facf4a8dSllai1 119facf4a8dSllai1 /* 120facf4a8dSllai1 * Per-instance node data - profile data per non-global zone mount instance 121facf4a8dSllai1 */ 122facf4a8dSllai1 typedef struct sdev_local_data { 123facf4a8dSllai1 ulong_t sdev_dir_lgen; /* cached generation # of /dev dir */ 124facf4a8dSllai1 ulong_t sdev_devtree_lgen; /* cached generation # of devtree */ 125facf4a8dSllai1 struct sdev_node *sdev_lorigin; /* corresponding global sdev_node */ 126facf4a8dSllai1 struct sdev_dprof sdev_lprof; /* profile for multi-inst */ 127facf4a8dSllai1 } sdev_local_data_t; 128facf4a8dSllai1 129facf4a8dSllai1 /* 130facf4a8dSllai1 * /dev filesystem sdev_node defines 131facf4a8dSllai1 */ 132facf4a8dSllai1 typedef struct sdev_node { 133facf4a8dSllai1 char *sdev_name; /* node name */ 134facf4a8dSllai1 size_t sdev_namelen; /* strlen(sdev_name) */ 135facf4a8dSllai1 char *sdev_path; /* absolute path */ 136facf4a8dSllai1 char *sdev_symlink; /* source for a symlink */ 137facf4a8dSllai1 struct vnode *sdev_vnode; /* vnode */ 138facf4a8dSllai1 139facf4a8dSllai1 krwlock_t sdev_contents; /* rw lock for this data structure */ 140facf4a8dSllai1 struct sdev_node *sdev_dotdot; /* parent */ 141aac43a5fSjg 142aac43a5fSjg avl_tree_t sdev_entries; /* VDIR: contents as avl tree */ 143aac43a5fSjg avl_node_t sdev_avllink; /* avl node linkage */ 144facf4a8dSllai1 145facf4a8dSllai1 struct vnode *sdev_attrvp; /* backing store vnode if persisted */ 146facf4a8dSllai1 struct vattr *sdev_attr; /* memory copy of the vattr */ 147facf4a8dSllai1 148facf4a8dSllai1 ino64_t sdev_ino; /* inode */ 149facf4a8dSllai1 uint_t sdev_nlink; /* link count */ 150facf4a8dSllai1 int sdev_state; /* state of this node */ 151facf4a8dSllai1 int sdev_flags; /* flags bit */ 152facf4a8dSllai1 153facf4a8dSllai1 kmutex_t sdev_lookup_lock; /* node creation synch lock */ 154facf4a8dSllai1 kcondvar_t sdev_lookup_cv; /* node creation sync cv */ 155facf4a8dSllai1 int sdev_lookup_flags; /* node creation flags */ 156facf4a8dSllai1 157facf4a8dSllai1 /* per-instance data, either global or non-global zone */ 158facf4a8dSllai1 union { 159facf4a8dSllai1 struct sdev_global_data sdev_globaldata; 160facf4a8dSllai1 struct sdev_local_data sdev_localdata; 161facf4a8dSllai1 } sdev_instance_data; 162d62bc4baSyz147064 163d62bc4baSyz147064 void *sdev_private; 164facf4a8dSllai1 } sdev_node_t; 165facf4a8dSllai1 166facf4a8dSllai1 #define sdev_ldata sdev_instance_data.sdev_localdata 167facf4a8dSllai1 #define sdev_gdata sdev_instance_data.sdev_globaldata 168facf4a8dSllai1 169facf4a8dSllai1 #define sdev_handle sdev_gdata.sdev_ghandle 170facf4a8dSllai1 #define sdev_gdir_gen sdev_gdata.sdev_dir_ggen 171facf4a8dSllai1 172facf4a8dSllai1 #define sdev_ldir_gen sdev_ldata.sdev_dir_lgen 173facf4a8dSllai1 #define sdev_devtree_gen sdev_ldata.sdev_devtree_lgen 174facf4a8dSllai1 #define sdev_origin sdev_ldata.sdev_lorigin 175facf4a8dSllai1 #define sdev_prof sdev_ldata.sdev_lprof 176facf4a8dSllai1 177facf4a8dSllai1 /* 178aac43a5fSjg * Directory contents traversal 179aac43a5fSjg */ 180aac43a5fSjg #define SDEV_FIRST_ENTRY(ddv) avl_first(&(ddv)->sdev_entries) 181aac43a5fSjg #define SDEV_NEXT_ENTRY(ddv, dv) AVL_NEXT(&(ddv)->sdev_entries, (dv)) 182aac43a5fSjg 183aac43a5fSjg /* 184*9e5aa9d8SRobert Mustacchi * See the big theory statement in sdev_vnops.c for an explanation of these 185*9e5aa9d8SRobert Mustacchi * states. 186facf4a8dSllai1 */ 187facf4a8dSllai1 typedef enum { 188facf4a8dSllai1 SDEV_ZOMBIE = -1, 189facf4a8dSllai1 SDEV_INIT = 0, 190facf4a8dSllai1 SDEV_READY 191facf4a8dSllai1 } sdev_node_state_t; 192facf4a8dSllai1 193facf4a8dSllai1 /* sdev_flags */ 194facf4a8dSllai1 #define SDEV_BUILD 0x0001 /* directory cache out-of-date */ 195*9e5aa9d8SRobert Mustacchi #define SDEV_GLOBAL 0x0002 /* global /dev nodes */ 196*9e5aa9d8SRobert Mustacchi #define SDEV_PERSIST 0x0004 /* backing store persisted node */ 197*9e5aa9d8SRobert Mustacchi #define SDEV_NO_NCACHE 0x0008 /* do not include in neg. cache */ 198*9e5aa9d8SRobert Mustacchi #define SDEV_DYNAMIC 0x0010 /* special-purpose vnode ops */ 199d62bc4baSyz147064 /* (ex: pts) */ 200*9e5aa9d8SRobert Mustacchi #define SDEV_VTOR 0x0020 /* validate sdev_nodes during search */ 201*9e5aa9d8SRobert Mustacchi #define SDEV_ATTR_INVALID 0x0040 /* invalid node attributes, */ 202d62bc4baSyz147064 /* need update */ 203*9e5aa9d8SRobert Mustacchi #define SDEV_SUBDIR 0x0080 /* match all subdirs under here */ 204*9e5aa9d8SRobert Mustacchi #define SDEV_ZONED 0x0100 /* zoned subdir */ 205facf4a8dSllai1 206facf4a8dSllai1 /* sdev_lookup_flags */ 207facf4a8dSllai1 #define SDEV_LOOKUP 0x0001 /* node creation in progress */ 208facf4a8dSllai1 #define SDEV_READDIR 0x0002 /* VDIR readdir in progress */ 209facf4a8dSllai1 #define SDEV_LGWAITING 0x0004 /* waiting for devfsadm completion */ 210facf4a8dSllai1 211facf4a8dSllai1 #define SDEV_VTOR_INVALID -1 212facf4a8dSllai1 #define SDEV_VTOR_SKIP 0 213facf4a8dSllai1 #define SDEV_VTOR_VALID 1 214b127ac41SPhilip Kirk #define SDEV_VTOR_STALE 2 215facf4a8dSllai1 216facf4a8dSllai1 /* convenient macros */ 217facf4a8dSllai1 #define SDEV_IS_GLOBAL(dv) \ 218facf4a8dSllai1 (dv->sdev_flags & SDEV_GLOBAL) 219facf4a8dSllai1 #define SDEV_IS_PERSIST(dv) \ 220facf4a8dSllai1 (dv->sdev_flags & SDEV_PERSIST) 221facf4a8dSllai1 #define SDEV_IS_DYNAMIC(dv) \ 222facf4a8dSllai1 (dv->sdev_flags & SDEV_DYNAMIC) 223facf4a8dSllai1 #define SDEV_IS_NO_NCACHE(dv) \ 224facf4a8dSllai1 (dv->sdev_flags & SDEV_NO_NCACHE) 225facf4a8dSllai1 #define SDEV_IS_LOOKUP(dv) \ 226facf4a8dSllai1 (dv->sdev_lookup_flags & SDEV_LOOKUP) 227facf4a8dSllai1 #define SDEV_IS_READDIR(dv) \ 228facf4a8dSllai1 (dv->sdev_lookup_flags & SDEV_READDIR) 229facf4a8dSllai1 #define SDEV_IS_LGWAITING(dv) \ 230facf4a8dSllai1 (dv->sdev_lookup_flags & SDEV_LGWAITING) 231facf4a8dSllai1 232facf4a8dSllai1 #define SDEVTOV(n) ((struct vnode *)(n)->sdev_vnode) 233facf4a8dSllai1 #define VTOSDEV(vp) ((struct sdev_node *)(vp)->v_data) 234facf4a8dSllai1 #define VN_HELD(v) ((v)->v_count != 0) 235facf4a8dSllai1 #define SDEV_HELD(dv) (VN_HELD(SDEVTOV(dv))) 236facf4a8dSllai1 #define SDEV_HOLD(dv) VN_HOLD(SDEVTOV(dv)) 237facf4a8dSllai1 #define SDEV_RELE(dv) VN_RELE(SDEVTOV(dv)) 238facf4a8dSllai1 #define SDEV_SIMPLE_RELE(dv) { \ 239facf4a8dSllai1 mutex_enter(&SDEVTOV(dv)->v_lock); \ 240facf4a8dSllai1 SDEVTOV(dv)->v_count--; \ 241facf4a8dSllai1 mutex_exit(&SDEVTOV(dv)->v_lock); \ 242facf4a8dSllai1 } 243facf4a8dSllai1 244facf4a8dSllai1 #define SDEV_ACL_FLAVOR(vp) (VFSTOSDEVFS(vp->v_vfsp)->sdev_acl_flavor) 245facf4a8dSllai1 246facf4a8dSllai1 /* 247facf4a8dSllai1 * some defaults 248facf4a8dSllai1 */ 249facf4a8dSllai1 #define SDEV_ROOTINO ((ino_t)2) 250facf4a8dSllai1 #define SDEV_UID_DEFAULT (0) 251facf4a8dSllai1 #define SDEV_GID_DEFAULT (3) 252facf4a8dSllai1 #define SDEV_DIRMODE_DEFAULT (S_IFDIR |0755) 253facf4a8dSllai1 #define SDEV_DEVMODE_DEFAULT (0600) 254facf4a8dSllai1 #define SDEV_LNKMODE_DEFAULT (S_IFLNK | 0777) 255facf4a8dSllai1 256facf4a8dSllai1 extern struct vattr sdev_vattr_dir; 257facf4a8dSllai1 extern struct vattr sdev_vattr_lnk; 258facf4a8dSllai1 extern struct vattr sdev_vattr_blk; 259facf4a8dSllai1 extern struct vattr sdev_vattr_chr; 260facf4a8dSllai1 261facf4a8dSllai1 /* 262facf4a8dSllai1 * devname_lookup_func() 263facf4a8dSllai1 */ 264facf4a8dSllai1 extern int devname_lookup_func(struct sdev_node *, char *, struct vnode **, 265facf4a8dSllai1 struct cred *, int (*)(struct sdev_node *, char *, void **, struct cred *, 266facf4a8dSllai1 void *, char *), int); 267facf4a8dSllai1 268facf4a8dSllai1 /* 269facf4a8dSllai1 * flags used by devname_lookup_func callbacks 270facf4a8dSllai1 */ 271facf4a8dSllai1 #define SDEV_VATTR 0x4 /* callback returning node vattr */ 272aecfc01dSrui zang - Sun Microsystems - Beijing China #define SDEV_VLINK 0x8 /* callback returning /dev link */ 273facf4a8dSllai1 274facf4a8dSllai1 /* 275facf4a8dSllai1 * devname_readdir_func() 276facf4a8dSllai1 */ 277facf4a8dSllai1 extern int devname_readdir_func(vnode_t *, uio_t *, cred_t *, int *, int); 278facf4a8dSllai1 279facf4a8dSllai1 /* 280facf4a8dSllai1 * flags for devname_readdir_func 281facf4a8dSllai1 */ 282facf4a8dSllai1 #define SDEV_BROWSE 0x1 /* fetch all entries from backing store */ 283facf4a8dSllai1 284facf4a8dSllai1 /* 285facf4a8dSllai1 * devname_setattr_func() 286facf4a8dSllai1 */ 287facf4a8dSllai1 extern int devname_setattr_func(struct vnode *, struct vattr *, int, 288facf4a8dSllai1 struct cred *, int (*)(struct sdev_node *, struct vattr *, int), int); 289facf4a8dSllai1 /* 290d62bc4baSyz147064 * devname_inactive_func() 291d62bc4baSyz147064 */ 292681d9761SEric Taylor extern void devname_inactive_func(struct vnode *, struct cred *, 293d62bc4baSyz147064 void (*)(struct vnode *)); 294d62bc4baSyz147064 295d62bc4baSyz147064 /* 296facf4a8dSllai1 * /dev file system instance defines 297facf4a8dSllai1 */ 298facf4a8dSllai1 /* 299facf4a8dSllai1 * /dev version of vfs_data 300facf4a8dSllai1 */ 301facf4a8dSllai1 struct sdev_data { 302facf4a8dSllai1 struct sdev_data *sdev_prev; 303facf4a8dSllai1 struct sdev_data *sdev_next; 304facf4a8dSllai1 struct sdev_node *sdev_root; 305facf4a8dSllai1 struct vfs *sdev_vfsp; 306facf4a8dSllai1 struct sdev_mountargs *sdev_mountargs; 307facf4a8dSllai1 ulong_t sdev_acl_flavor; 308facf4a8dSllai1 }; 309facf4a8dSllai1 310facf4a8dSllai1 #define VFSTOSDEVFS(vfsp) ((struct sdev_data *)((vfsp)->vfs_data)) 311facf4a8dSllai1 312facf4a8dSllai1 /* 313facf4a8dSllai1 * sdev_fid overlays the fid structure (for VFS_VGET) 314facf4a8dSllai1 */ 315facf4a8dSllai1 struct sdev_fid { 316facf4a8dSllai1 uint16_t sdevfid_len; 317facf4a8dSllai1 ino32_t sdevfid_ino; 318facf4a8dSllai1 int32_t sdevfid_gen; 319facf4a8dSllai1 }; 320facf4a8dSllai1 321facf4a8dSllai1 /* 322facf4a8dSllai1 * devfsadm and devname communication defines 323facf4a8dSllai1 */ 324facf4a8dSllai1 typedef enum { 325facf4a8dSllai1 DEVNAME_DEVFSADM_STOPPED = 0, /* devfsadm has never run */ 326facf4a8dSllai1 DEVNAME_DEVFSADM_RUNNING, /* devfsadm is running */ 327facf4a8dSllai1 DEVNAME_DEVFSADM_RUN /* devfsadm ran once */ 328facf4a8dSllai1 } devname_devfsadm_state_t; 329facf4a8dSllai1 330facf4a8dSllai1 extern volatile uint_t devfsadm_state; /* atomic mask for devfsadm status */ 331facf4a8dSllai1 332facf4a8dSllai1 #define DEVNAME_DEVFSADM_SET_RUNNING(devfsadm_state) \ 333facf4a8dSllai1 devfsadm_state = DEVNAME_DEVFSADM_RUNNING 334facf4a8dSllai1 #define DEVNAME_DEVFSADM_SET_STOP(devfsadm_state) \ 335facf4a8dSllai1 devfsadm_state = DEVNAME_DEVFSADM_STOPPED 336facf4a8dSllai1 #define DEVNAME_DEVFSADM_SET_RUN(devfsadm_state) \ 337facf4a8dSllai1 devfsadm_state = DEVNAME_DEVFSADM_RUN 338facf4a8dSllai1 #define DEVNAME_DEVFSADM_IS_RUNNING(devfsadm_state) \ 339facf4a8dSllai1 devfsadm_state == DEVNAME_DEVFSADM_RUNNING 340facf4a8dSllai1 #define DEVNAME_DEVFSADM_HAS_RUN(devfsadm_state) \ 341facf4a8dSllai1 (devfsadm_state == DEVNAME_DEVFSADM_RUN) 342facf4a8dSllai1 343facf4a8dSllai1 #define SDEV_BLOCK_OTHERS(dv, cmd) { \ 344facf4a8dSllai1 ASSERT(MUTEX_HELD(&dv->sdev_lookup_lock)); \ 345facf4a8dSllai1 dv->sdev_lookup_flags |= cmd; \ 346facf4a8dSllai1 } 347facf4a8dSllai1 extern void sdev_unblock_others(struct sdev_node *, uint_t); 348facf4a8dSllai1 #define SDEV_UNBLOCK_OTHERS(dv, cmd) { \ 349facf4a8dSllai1 sdev_unblock_others(dv, cmd); \ 350facf4a8dSllai1 } 351facf4a8dSllai1 352facf4a8dSllai1 #define SDEV_CLEAR_LOOKUP_FLAGS(dv, cmd) { \ 353facf4a8dSllai1 dv->sdev_lookup_flags &= ~cmd; \ 354facf4a8dSllai1 } 355facf4a8dSllai1 356facf4a8dSllai1 extern int sdev_wait4lookup(struct sdev_node *, int); 3573c5e027bSEric Taylor extern int devname_filename_register(char *); 358facf4a8dSllai1 extern int devname_nsmaps_register(char *, size_t); 359facf4a8dSllai1 extern void sdev_devfsadm_lockinit(void); 360facf4a8dSllai1 extern void sdev_devfsadm_lockdestroy(void); 361facf4a8dSllai1 extern void devname_add_devfsadm_node(char *); 362facf4a8dSllai1 extern void sdev_devfsadmd_thread(struct sdev_node *, struct sdev_node *, 363facf4a8dSllai1 struct cred *); 364facf4a8dSllai1 extern int devname_profile_update(char *, size_t); 365facf4a8dSllai1 extern struct sdev_data *sdev_find_mntinfo(char *); 366facf4a8dSllai1 void sdev_mntinfo_rele(struct sdev_data *); 367facf4a8dSllai1 extern struct vnodeops *devpts_getvnodeops(void); 368aecfc01dSrui zang - Sun Microsystems - Beijing China extern struct vnodeops *devvt_getvnodeops(void); 369facf4a8dSllai1 370facf4a8dSllai1 /* 371facf4a8dSllai1 * boot states - warning, the ordering here is significant 372facf4a8dSllai1 * 373facf4a8dSllai1 * the difference between "system available" and "boot complete" 374facf4a8dSllai1 * is a debounce timeout to catch some daemon issuing a readdir 375facf4a8dSllai1 * triggering a nuisance implict reconfig on each boot. 376facf4a8dSllai1 */ 377facf4a8dSllai1 #define SDEV_BOOT_STATE_INITIAL 0 378facf4a8dSllai1 #define SDEV_BOOT_STATE_RECONFIG 1 /* reconfig */ 379facf4a8dSllai1 #define SDEV_BOOT_STATE_SYSAVAIL 2 /* system available */ 380facf4a8dSllai1 #define SDEV_BOOT_STATE_COMPLETE 3 /* boot complete */ 381facf4a8dSllai1 382facf4a8dSllai1 /* 383facf4a8dSllai1 * Negative cache list and list element 384facf4a8dSllai1 * The mutex protects the flags against multiple accesses and 385facf4a8dSllai1 * must only be acquired when already holding the r/w lock. 386facf4a8dSllai1 */ 387facf4a8dSllai1 typedef struct sdev_nc_list { 388facf4a8dSllai1 list_t ncl_list; /* the list itself */ 389facf4a8dSllai1 kmutex_t ncl_mutex; /* protects ncl_flags */ 390facf4a8dSllai1 krwlock_t ncl_lock; /* protects ncl_list */ 391facf4a8dSllai1 int ncl_flags; 392facf4a8dSllai1 int ncl_nentries; 393facf4a8dSllai1 } sdev_nc_list_t; 394facf4a8dSllai1 395facf4a8dSllai1 typedef struct sdev_nc_node { 396facf4a8dSllai1 char *ncn_name; /* name of the node */ 397facf4a8dSllai1 int ncn_flags; /* state information */ 398facf4a8dSllai1 int ncn_expirecnt; /* remove once expired */ 399facf4a8dSllai1 list_node_t ncn_link; /* link to next in list */ 400facf4a8dSllai1 } sdev_nc_node_t; 401facf4a8dSllai1 402facf4a8dSllai1 /* ncl_flags */ 403facf4a8dSllai1 #define NCL_LIST_DIRTY 0x01 /* needs to be flushed */ 404facf4a8dSllai1 #define NCL_LIST_WRITING 0x02 /* write in progress */ 405facf4a8dSllai1 #define NCL_LIST_WENABLE 0x04 /* write-enabled post boot */ 406facf4a8dSllai1 407facf4a8dSllai1 /* ncn_flags */ 408facf4a8dSllai1 #define NCN_ACTIVE 0x01 /* a lookup has occurred */ 409facf4a8dSllai1 #define NCN_SRC_STORE 0x02 /* src: persistent store */ 410facf4a8dSllai1 #define NCN_SRC_CURRENT 0x04 /* src: current boot */ 411facf4a8dSllai1 412facf4a8dSllai1 /* sdev_lookup_failed flags */ 413facf4a8dSllai1 #define SLF_NO_NCACHE 0x01 /* node should not be added to ncache */ 414facf4a8dSllai1 #define SLF_REBUILT 0x02 /* reconfig performed during lookup attempt */ 415facf4a8dSllai1 416facf4a8dSllai1 /* 41783c4dfe9Sjg * The nvlist name and nvpair identifiers in the 41883c4dfe9Sjg * /etc/devices/devname_cache nvlist format 41983c4dfe9Sjg */ 42083c4dfe9Sjg #define DP_DEVNAME_ID "devname" 42183c4dfe9Sjg #define DP_DEVNAME_NCACHE_ID "ncache" 42283c4dfe9Sjg #define DP_DEVNAME_NC_EXPIRECNT_ID "expire-counts" 42383c4dfe9Sjg 42483c4dfe9Sjg /* devname-cache list element */ 42583c4dfe9Sjg typedef struct nvp_devname { 42683c4dfe9Sjg char **nvp_paths; 42783c4dfe9Sjg int *nvp_expirecnts; 42883c4dfe9Sjg int nvp_npaths; 42983c4dfe9Sjg list_node_t nvp_link; 43083c4dfe9Sjg } nvp_devname_t; 43183c4dfe9Sjg 43283c4dfe9Sjg /* 433facf4a8dSllai1 * name service globals and prototypes 434facf4a8dSllai1 */ 435facf4a8dSllai1 436facf4a8dSllai1 /* 437facf4a8dSllai1 * vnodeops and vfsops helpers 438facf4a8dSllai1 */ 439facf4a8dSllai1 440facf4a8dSllai1 typedef enum { 441facf4a8dSllai1 SDEV_CACHE_ADD = 0, 442facf4a8dSllai1 SDEV_CACHE_DELETE 443facf4a8dSllai1 } sdev_cache_ops_t; 444facf4a8dSllai1 445facf4a8dSllai1 extern struct sdev_node *sdev_cache_lookup(struct sdev_node *, char *); 446*9e5aa9d8SRobert Mustacchi extern void sdev_cache_update(struct sdev_node *, struct sdev_node **, char *, 447facf4a8dSllai1 sdev_cache_ops_t); 448facf4a8dSllai1 extern void sdev_node_cache_init(void); 449facf4a8dSllai1 extern void sdev_node_cache_fini(void); 450facf4a8dSllai1 extern struct sdev_node *sdev_mkroot(struct vfs *, dev_t, struct vnode *, 451facf4a8dSllai1 struct vnode *, struct cred *); 4526b938478Sjg extern void sdev_filldir_dynamic(struct sdev_node *); 453facf4a8dSllai1 extern int sdev_mknode(struct sdev_node *, char *, struct sdev_node **, 454facf4a8dSllai1 struct vattr *, struct vnode *, void *, struct cred *, sdev_node_state_t); 455681d9761SEric Taylor extern int sdev_getlink(struct vnode *linkvp, char **link); 456681d9761SEric Taylor 457facf4a8dSllai1 extern int sdev_nodeinit(struct sdev_node *, char *, struct sdev_node **, 458facf4a8dSllai1 vattr_t *); 459facf4a8dSllai1 extern int sdev_nodeready(struct sdev_node *, vattr_t *, vnode_t *, void *, 460facf4a8dSllai1 cred_t *); 461facf4a8dSllai1 extern int sdev_shadow_node(struct sdev_node *, struct cred *); 462facf4a8dSllai1 extern void sdev_nodedestroy(struct sdev_node *, uint_t); 463facf4a8dSllai1 extern void sdev_update_timestamps(struct vnode *, cred_t *, uint_t); 464facf4a8dSllai1 extern void sdev_vattr_merge(struct sdev_node *, struct vattr *); 465facf4a8dSllai1 extern void sdev_devstate_change(void); 466facf4a8dSllai1 extern int sdev_lookup_filter(sdev_node_t *, char *); 467facf4a8dSllai1 extern void sdev_lookup_failed(sdev_node_t *, char *, int); 468facf4a8dSllai1 extern int sdev_unlocked_access(void *, int, struct cred *); 469facf4a8dSllai1 470facf4a8dSllai1 #define SDEV_ENFORCE 0x1 471facf4a8dSllai1 extern void sdev_stale(struct sdev_node *); 472facf4a8dSllai1 extern int sdev_cleandir(struct sdev_node *, char *, uint_t); 473facf4a8dSllai1 extern int sdev_rnmnode(struct sdev_node *, struct sdev_node *, 474facf4a8dSllai1 struct sdev_node *, struct sdev_node **, char *, struct cred *); 475facf4a8dSllai1 extern size_t add_dir_entry(dirent64_t *, char *, size_t, ino_t, offset_t); 476681d9761SEric Taylor extern struct vattr *sdev_getdefault_attr(enum vtype type); 477facf4a8dSllai1 extern int sdev_to_vp(struct sdev_node *, struct vnode **); 478facf4a8dSllai1 extern ino_t sdev_mkino(struct sdev_node *); 479facf4a8dSllai1 extern int devname_backstore_lookup(struct sdev_node *, char *, 480facf4a8dSllai1 struct vnode **); 481facf4a8dSllai1 extern int sdev_is_devfs_node(char *); 482facf4a8dSllai1 extern int sdev_copyin_mountargs(struct mounta *, struct sdev_mountargs *); 483facf4a8dSllai1 extern int sdev_reserve_subdirs(struct sdev_node *); 484facf4a8dSllai1 extern int prof_lookup(); 485facf4a8dSllai1 extern void prof_filldir(struct sdev_node *); 486facf4a8dSllai1 extern int devpts_validate(struct sdev_node *dv); 487d62bc4baSyz147064 extern int devnet_validate(struct sdev_node *dv); 488b127ac41SPhilip Kirk extern int devipnet_validate(struct sdev_node *dv); 489aecfc01dSrui zang - Sun Microsystems - Beijing China extern int devvt_validate(struct sdev_node *dv); 490681d9761SEric Taylor extern int devzvol_validate(struct sdev_node *dv); 491facf4a8dSllai1 extern void *sdev_get_vtor(struct sdev_node *dv); 492facf4a8dSllai1 493facf4a8dSllai1 /* 494681d9761SEric Taylor * devinfo helpers 495681d9761SEric Taylor */ 496681d9761SEric Taylor extern int sdev_modctl_readdir(const char *, char ***, int *, int *, int); 497681d9761SEric Taylor extern void sdev_modctl_readdir_free(char **, int, int); 498681d9761SEric Taylor extern int sdev_modctl_devexists(const char *); 499681d9761SEric Taylor 500681d9761SEric Taylor /* 501facf4a8dSllai1 * ncache handlers 502facf4a8dSllai1 */ 503facf4a8dSllai1 504facf4a8dSllai1 extern void sdev_ncache_init(void); 505facf4a8dSllai1 extern void sdev_ncache_setup(void); 506facf4a8dSllai1 extern void sdev_ncache_teardown(void); 507facf4a8dSllai1 extern void sdev_nc_addname(sdev_nc_list_t *, sdev_node_t *, char *, int); 508facf4a8dSllai1 extern void sdev_nc_node_exists(sdev_node_t *); 509facf4a8dSllai1 extern void sdev_nc_path_exists(sdev_nc_list_t *, char *); 510facf4a8dSllai1 extern void sdev_modctl_dump_files(void); 511facf4a8dSllai1 512facf4a8dSllai1 /* 513facf4a8dSllai1 * globals 514facf4a8dSllai1 */ 5150bfaec69Sllai1 extern kmutex_t sdev_lock; 516facf4a8dSllai1 extern int devtype; 517facf4a8dSllai1 extern kmem_cache_t *sdev_node_cache; 518facf4a8dSllai1 extern struct vnodeops *sdev_vnodeops; 519facf4a8dSllai1 extern struct vnodeops *devpts_vnodeops; 520d62bc4baSyz147064 extern struct vnodeops *devnet_vnodeops; 521b127ac41SPhilip Kirk extern struct vnodeops *devipnet_vnodeops; 522aecfc01dSrui zang - Sun Microsystems - Beijing China extern struct vnodeops *devvt_vnodeops; 523facf4a8dSllai1 extern struct sdev_data *sdev_origins; /* mount info for global /dev instance */ 524681d9761SEric Taylor extern struct vnodeops *devzvol_vnodeops; 525681d9761SEric Taylor 526facf4a8dSllai1 extern const fs_operation_def_t sdev_vnodeops_tbl[]; 527facf4a8dSllai1 extern const fs_operation_def_t devpts_vnodeops_tbl[]; 528d62bc4baSyz147064 extern const fs_operation_def_t devnet_vnodeops_tbl[]; 529b127ac41SPhilip Kirk extern const fs_operation_def_t devipnet_vnodeops_tbl[]; 530aecfc01dSrui zang - Sun Microsystems - Beijing China extern const fs_operation_def_t devvt_vnodeops_tbl[]; 531facf4a8dSllai1 extern const fs_operation_def_t devsys_vnodeops_tbl[]; 532facf4a8dSllai1 extern const fs_operation_def_t devpseudo_vnodeops_tbl[]; 533681d9761SEric Taylor extern const fs_operation_def_t devzvol_vnodeops_tbl[]; 534facf4a8dSllai1 535facf4a8dSllai1 extern sdev_nc_list_t *sdev_ncache; 536facf4a8dSllai1 extern int sdev_reconfig_boot; 537facf4a8dSllai1 extern int sdev_boot_state; 538facf4a8dSllai1 extern int sdev_reconfig_verbose; 539facf4a8dSllai1 extern int sdev_reconfig_disable; 540facf4a8dSllai1 extern int sdev_nc_disable; 541facf4a8dSllai1 extern int sdev_nc_disable_reset; 542facf4a8dSllai1 extern int sdev_nc_verbose; 543facf4a8dSllai1 544facf4a8dSllai1 /* 545facf4a8dSllai1 * misc. defines 546facf4a8dSllai1 */ 547facf4a8dSllai1 #ifdef DEBUG 548facf4a8dSllai1 extern int sdev_debug; 549facf4a8dSllai1 #define SDEV_DEBUG 0x01 /* error messages to console/log */ 550facf4a8dSllai1 #define SDEV_DEBUG_VOPS 0x02 /* vnode ops errors */ 551facf4a8dSllai1 #define SDEV_DEBUG_DLF 0x04 /* trace devname_lookup_func */ 552facf4a8dSllai1 #define SDEV_DEBUG_DRF 0x08 /* trace devname_readdir_func */ 553facf4a8dSllai1 #define SDEV_DEBUG_NCACHE 0x10 /* negative cache tracing */ 554facf4a8dSllai1 #define SDEV_DEBUG_DEVFSADMD 0x20 /* comm. of devnamefs & devfsadm */ 555facf4a8dSllai1 #define SDEV_DEBUG_PTS 0x40 /* /dev/pts tracing */ 556facf4a8dSllai1 #define SDEV_DEBUG_RECONFIG 0x80 /* events triggering reconfig */ 557facf4a8dSllai1 #define SDEV_DEBUG_SDEV_NODE 0x100 /* trace sdev_node activities */ 558facf4a8dSllai1 #define SDEV_DEBUG_PROFILE 0x200 /* trace sdev_profile */ 559facf4a8dSllai1 #define SDEV_DEBUG_MODCTL 0x400 /* trace modctl activity */ 560facf4a8dSllai1 #define SDEV_DEBUG_FLK 0x800 /* trace failed lookups */ 561d62bc4baSyz147064 #define SDEV_DEBUG_NET 0x1000 /* /dev/net tracing */ 562681d9761SEric Taylor #define SDEV_DEBUG_ZVOL 0x2000 /* /dev/zvol/tracing */ 563facf4a8dSllai1 564facf4a8dSllai1 #define sdcmn_err(args) if (sdev_debug & SDEV_DEBUG) printf args 565facf4a8dSllai1 #define sdcmn_err2(args) if (sdev_debug & SDEV_DEBUG_VOPS) printf args 566facf4a8dSllai1 #define sdcmn_err3(args) if (sdev_debug & SDEV_DEBUG_DLF) printf args 567facf4a8dSllai1 #define sdcmn_err4(args) if (sdev_debug & SDEV_DEBUG_DRF) printf args 568facf4a8dSllai1 #define sdcmn_err5(args) if (sdev_debug & SDEV_DEBUG_NCACHE) printf args 569facf4a8dSllai1 #define sdcmn_err6(args) if (sdev_debug & SDEV_DEBUG_DEVFSADMD) printf args 570facf4a8dSllai1 #define sdcmn_err7(args) if (sdev_debug & SDEV_DEBUG_PTS) printf args 571facf4a8dSllai1 #define sdcmn_err8(args) if (sdev_debug & SDEV_DEBUG_RECONFIG) printf args 572facf4a8dSllai1 #define sdcmn_err9(args) if (sdev_debug & SDEV_DEBUG_SDEV_NODE) printf args 573facf4a8dSllai1 #define sdcmn_err10(args) if (sdev_debug & SDEV_DEBUG_PROFILE) printf args 574facf4a8dSllai1 #define sdcmn_err11(args) if (sdev_debug & SDEV_DEBUG_MODCTL) printf args 575d62bc4baSyz147064 #define sdcmn_err12(args) if (sdev_debug & SDEV_DEBUG_NET) printf args 576681d9761SEric Taylor #define sdcmn_err13(args) if (sdev_debug & SDEV_DEBUG_ZVOL) printf args 577facf4a8dSllai1 #define impossible(args) printf args 578facf4a8dSllai1 #else 579facf4a8dSllai1 #define sdcmn_err(args) /* does nothing */ 580facf4a8dSllai1 #define sdcmn_err2(args) /* does nothing */ 581facf4a8dSllai1 #define sdcmn_err3(args) /* does nothing */ 582facf4a8dSllai1 #define sdcmn_err4(args) /* does nothing */ 583facf4a8dSllai1 #define sdcmn_err5(args) /* does nothing */ 584facf4a8dSllai1 #define sdcmn_err6(args) /* does nothing */ 585facf4a8dSllai1 #define sdcmn_err7(args) /* does nothing */ 586facf4a8dSllai1 #define sdcmn_err8(args) /* does nothing */ 587facf4a8dSllai1 #define sdcmn_err9(args) /* does nothing */ 588facf4a8dSllai1 #define sdcmn_err10(args) /* does nothing */ 589facf4a8dSllai1 #define sdcmn_err11(args) /* does nothing */ 590d62bc4baSyz147064 #define sdcmn_err12(args) /* does nothing */ 591681d9761SEric Taylor #define sdcmn_err13(args) /* does nothing */ 592facf4a8dSllai1 #define impossible(args) /* does nothing */ 593facf4a8dSllai1 #endif 594facf4a8dSllai1 595facf4a8dSllai1 #ifdef DEBUG 596facf4a8dSllai1 #define SD_TRACE_FAILED_LOOKUP(ddv, nm, retried) \ 597facf4a8dSllai1 if ((sdev_debug & SDEV_DEBUG_FLK) || \ 598facf4a8dSllai1 ((retried) && (sdev_debug & SDEV_DEBUG_RECONFIG))) { \ 599facf4a8dSllai1 printf("lookup of %s/%s by %s failed, line %d\n", \ 600facf4a8dSllai1 (ddv)->sdev_name, (nm), curproc->p_user.u_comm, \ 601facf4a8dSllai1 __LINE__); \ 602facf4a8dSllai1 } 603facf4a8dSllai1 #else 604facf4a8dSllai1 #define SD_TRACE_FAILED_LOOKUP(ddv, nm, retried) 605facf4a8dSllai1 #endif 606facf4a8dSllai1 607facf4a8dSllai1 #endif /* _KERNEL */ 608facf4a8dSllai1 609facf4a8dSllai1 #ifdef __cplusplus 610facf4a8dSllai1 } 611facf4a8dSllai1 #endif 612facf4a8dSllai1 613facf4a8dSllai1 #endif /* _SYS_SDEV_IMPL_H */ 614