1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_DV_NODE_H 27 #define _SYS_DV_NODE_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 /* 32 * dv_nodes are the file-system specific part of the 33 * vnodes for the device filesystem. 34 * 35 * The device filesystem exports two node types: 36 * 37 * VDIR nodes to represent nexus drivers 38 * VCHR & VBLK nodes to represent devices 39 */ 40 41 #include <sys/dirent.h> 42 #include <sys/sunddi.h> 43 #include <sys/devops.h> 44 #include <sys/ddi_impldefs.h> 45 #include <sys/fs/sdev_node.h> 46 #include <sys/devpolicy.h> 47 #include <sys/avl.h> 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 #ifdef _KERNEL 54 55 /* 56 * Here's the focal point of this filesystem 57 */ 58 typedef struct dv_node { 59 char *dv_name; /* pointer to name */ 60 size_t dv_namelen; /* strlen(dv_name) */ 61 struct vnode *dv_vnode; /* vnode for this dv_node */ 62 63 /* 64 * The dv_contents lock should be held (read) before looking at 65 * any of the fields below, and held (write) before modifying them. 66 */ 67 krwlock_t dv_contents; /* held while anything is changing */ 68 69 dev_info_t *dv_devi; /* VDIR: underlying devinfo node */ 70 /* has ndi_devi_hold on device */ 71 72 struct dv_node *dv_dotdot; /* parent: my parent dv_node */ 73 avl_tree_t dv_entries; /* VDIR: contents as avl tree */ 74 avl_node_t dv_avllink; /* avl node linkage */ 75 76 struct vnode *dv_attrvp; /* persistent attribute store */ 77 struct vattr *dv_attr; /* attributes not yet persistent */ 78 79 ino64_t dv_ino; /* fake inode */ 80 int dv_flags; /* state bits and stuff */ 81 uint_t dv_nlink; /* link count */ 82 uint_t dv_busy; /* directory busy count */ 83 devplcy_t *dv_priv; /* access privilege */ 84 mode_t dv_dflt_mode; /* create_priv_minor_node mode */ 85 struct sdev_dv *dv_sdev; /* sdev node[s] if exists */ 86 } dvnode_t; 87 88 #define DV_BUILD 0x1 /* directory out-of-date */ 89 #define DV_NO_FSPERM 0x2 /* ignore fs permissions */ 90 #define DV_INTERNAL 0x04 /* internal node */ 91 #define DV_ACL 0x08 /* node has acl */ 92 #define DV_DFLT_MODE 0x010 /* dv_dflt_mode set */ 93 94 #define DV_ROOTINO ((ino_t)2) /* root inode no. for devfs */ 95 96 #define DVTOV(n) ((struct vnode *)(n)->dv_vnode) 97 #define VTODV(vp) ((struct dv_node *)(vp)->v_data) 98 #define DV_STALE(dv) (dv->dv_devi == NULL) 99 100 #define DV_UID_DEFAULT 0 /* default uid for devs and dirs */ 101 #define DV_GID_DEFAULT 3 /* default gid for devs and dirs */ 102 #define DV_DIRMODE_DEFAULT (S_IFDIR | 0755) /* directories */ 103 #define DV_DEVMODE_DEFAULT (0600) /* special files */ 104 #define DV_DEVMODE_PRIV (0666) /* priv based access only */ 105 106 /* flags for devfs_clean() */ 107 #define DV_CLEAN_FORCE 0x01 /* force clean of refed directories */ 108 #define DV_RESET_PERM 0x02 /* force resetting of node permission */ 109 #define DV_CLEANDIR_LCK 0x04 /* dv_contents already held */ 110 111 struct devfs_data { 112 struct dv_node *devfs_root; 113 struct vfs *devfs_vfsp; 114 }; 115 116 #define VFSTODVFS(vfsp) ((struct devfs_data *)((vfsp)->vfs_data)) 117 118 /* dv_fid overlays the fid structure (for VFS_VGET) */ 119 struct dv_fid { 120 uint16_t dvfid_len; 121 ino32_t dvfid_ino; 122 int32_t dvfid_gen; 123 }; 124 125 /* 126 * Compare a vattr's and mperm_t's minor permissions (uid, gid & mode) 127 */ 128 #define VATTRP_MP_CMP(attrp, mp) \ 129 (!((attrp->va_uid == mp.mp_uid) && \ 130 (attrp->va_gid == mp.mp_gid) && \ 131 ((attrp->va_mode & S_IAMB) == (mp.mp_mode & S_IAMB)))) 132 133 /* 134 * Merge an mperm_t's minor permissions into a vattr 135 */ 136 #define VATTR_MP_MERGE(attr, mp) \ 137 attr.va_uid = mp.mp_uid; \ 138 attr.va_gid = mp.mp_gid; \ 139 attr.va_mode = \ 140 (attr.va_mode & ~S_IAMB) | (mp.mp_mode & S_IAMB); 141 142 #define VATTRP_MP_MERGE(attrp, mp) \ 143 attrp->va_uid = mp.mp_uid; \ 144 attrp->va_gid = mp.mp_gid; \ 145 attrp->va_mode = \ 146 (attrp->va_mode & ~S_IAMB) | (mp.mp_mode & S_IAMB); 147 148 /* 149 * dv_shadow_node flags 150 */ 151 #define DV_SHADOW_CREATE 0x01 /* create attribute node */ 152 #define DV_SHADOW_WRITE_HELD 0x02 /* dv_contents write held */ 153 154 /* 155 * Directory tree traversal 156 */ 157 #define DV_FIRST_ENTRY(ddv) avl_first(&(ddv)->dv_entries) 158 #define DV_NEXT_ENTRY(ddv, dv) AVL_NEXT(&(ddv)->dv_entries, (dv)) 159 160 extern uint_t devfs_clean_key; /* tsd key */ 161 extern const char dvnm[]; /* share some space.. */ 162 extern struct dv_node *dvroot; /* devfs root node */ 163 164 extern void dv_node_cache_init(void); 165 extern void dv_node_cache_fini(void); 166 extern struct dv_node *dv_mkdir(struct dv_node *, dev_info_t *, char *); 167 extern struct dv_node *dv_mkroot(struct vfs *, dev_t); 168 extern void dv_destroy(struct dv_node *, uint_t); 169 extern void dv_insert(struct dv_node *, struct dv_node *); 170 extern void dv_shadow_node(struct vnode *, char *nm, struct vnode *, 171 struct pathname *, struct vnode *, struct cred *, int); 172 extern int dv_find(struct dv_node *, char *, struct vnode **, 173 struct pathname *, struct vnode *, struct cred *, uint_t); 174 extern void dv_filldir(struct dv_node *); 175 extern int dv_cleandir(struct dv_node *, char *, uint_t); 176 extern void dv_vattr_merge(struct dv_node *, struct vattr *); 177 extern void dv_walk(struct dv_node *, char *, 178 void (*f)(struct dv_node *, void *), void *); 179 180 extern int devfs_clean(dev_info_t *, char *, uint_t); 181 extern int devfs_lookupname(char *, vnode_t **, vnode_t **); 182 extern int devfs_walk(char *, void (*f)(struct dv_node *, void *), void *); 183 extern int devfs_devpolicy(vnode_t *, devplcy_t **); 184 extern void devfs_get_defattr(vnode_t *, struct vattr *, int *); 185 186 extern struct dv_node *devfs_dip_to_dvnode(dev_info_t *); 187 extern int devfs_reset_perm(uint_t); 188 extern int devfs_remdrv_cleanup(const char *, const char *); 189 190 extern struct vnodeops *dv_vnodeops; 191 extern const struct fs_operation_def dv_vnodeops_template[]; 192 193 194 #ifdef DEBUG 195 extern int devfs_debug; 196 #define DV_DEBUG 0x01 197 #define DV_DEBUG2 0x02 198 #define DV_DEBUG3 0x04 199 #define DV_DEBUG4 0x08 200 #define DV_DEBUG5 0x10 201 #define DV_SYSERR 0x1000 202 #define DV_SYSTRACE 0x2000 203 #define dcmn_err(args) if (devfs_debug & DV_DEBUG) printf args 204 #define dcmn_err2(args) if (devfs_debug & DV_DEBUG2) printf args 205 #define dcmn_err3(args) if (devfs_debug & DV_DEBUG3) printf args 206 #define dcmn_err4(args) if (devfs_debug & DV_DEBUG4) printf args 207 #define dcmn_err5(args) if (devfs_debug & DV_DEBUG5) printf args 208 209 #define dsysdebug(err, args) \ 210 if ((err && (devfs_debug & DV_SYSERR)) || \ 211 (devfs_debug & DV_SYSTRACE)) printf args 212 #else 213 #define dcmn_err(args) /* nothing */ 214 #define dcmn_err2(args) /* nothing */ 215 #define dcmn_err3(args) /* nothing */ 216 #define dcmn_err4(args) /* nothing */ 217 #define dcmn_err5(args) /* nothing */ 218 #define dsysdebug(err, args) /* nothing */ 219 #endif 220 221 222 #endif /* _KERNEL */ 223 224 #ifdef __cplusplus 225 } 226 #endif 227 228 #endif /* _SYS_DV_NODE_H */ 229