1 /* $NetBSD: specdev.h,v 1.46 2021/07/18 23:57:15 dholland Exp $ */ 2 3 /*- 4 * Copyright (c) 2008 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 18 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /* 30 * Copyright (c) 1990, 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. Neither the name of the University nor the names of its contributors 42 * may be used to endorse or promote products derived from this software 43 * without specific prior written permission. 44 * 45 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 46 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 47 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 48 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 49 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 50 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 51 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 54 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 55 * SUCH DAMAGE. 56 * 57 * @(#)specdev.h 8.6 (Berkeley) 5/21/95 58 */ 59 60 #ifndef _MISCFS_SPECFS_SPECDEV_H_ 61 #define _MISCFS_SPECFS_SPECDEV_H_ 62 63 #include <sys/mutex.h> 64 #include <sys/vnode.h> 65 66 typedef struct specnode { 67 vnode_t *sn_next; 68 struct specdev *sn_dev; 69 u_int sn_opencnt; 70 dev_t sn_rdev; 71 bool sn_gone; 72 } specnode_t; 73 74 typedef struct specdev { 75 struct mount *sd_mountpoint; 76 struct lockf *sd_lockf; 77 vnode_t *sd_bdevvp; 78 u_int sd_opencnt; 79 u_int sd_refcnt; 80 dev_t sd_rdev; 81 } specdev_t; 82 83 /* 84 * Exported shorthand 85 */ 86 #define v_specnext v_specnode->sn_next 87 #define v_rdev v_specnode->sn_rdev 88 #define v_speclockf v_specnode->sn_dev->sd_lockf 89 90 /* 91 * Special device management 92 */ 93 void spec_node_init(vnode_t *, dev_t); 94 void spec_node_destroy(vnode_t *); 95 int spec_node_lookup_by_dev(enum vtype, dev_t, vnode_t **); 96 int spec_node_lookup_by_mount(struct mount *, vnode_t **); 97 struct mount *spec_node_getmountedfs(vnode_t *); 98 void spec_node_setmountedfs(vnode_t *, struct mount *); 99 void spec_node_revoke(vnode_t *); 100 101 /* 102 * Prototypes for special file operations on vnodes. 103 */ 104 extern int (**spec_vnodeop_p)(void *); 105 struct nameidata; 106 struct componentname; 107 struct flock; 108 struct buf; 109 struct uio; 110 111 int spec_lookup(void *); 112 int spec_open(void *); 113 int spec_close(void *); 114 int spec_read(void *); 115 int spec_write(void *); 116 int spec_fdiscard(void *); 117 int spec_ioctl(void *); 118 int spec_poll(void *); 119 int spec_kqfilter(void *); 120 int spec_mmap(void *); 121 int spec_fsync(void *); 122 #define spec_seek genfs_nullop /* XXX should query device */ 123 int spec_inactive(void *); 124 int spec_reclaim(void *); 125 int spec_bmap(void *); 126 int spec_strategy(void *); 127 int spec_print(void *); 128 int spec_pathconf(void *); 129 int spec_advlock(void *); 130 131 /* 132 * This macro provides an initializer list for the fs-independent part 133 * of a filesystem's special file vnode ops descriptor table. We still 134 * need such a table in every filesystem, but we can at least avoid 135 * the cutpaste. 136 * 137 * This contains these ops: 138 * parsepath lookup 139 * create whiteout mknod open fallocate fdiscard ioctl poll kqfilter 140 * revoke mmap seek remove link rename mkdir rmdir symlink readdir 141 * readlink abortop bmap strategy pathconf advlock getpages putpages 142 * 143 * The filesystem should provide these ops that need to be its own: 144 * access and accessx 145 * getattr 146 * setattr 147 * fcntl 148 * inactive 149 * reclaim 150 * lock 151 * unlock 152 * print (should probably also call spec_print) 153 * islocked 154 * bwrite (normally vn_bwrite) 155 * openextattr 156 * closeextattr 157 * getextattr 158 * setextattr 159 * listextattr 160 * deleteextattr 161 * getacl 162 * setacl 163 * aclcheck 164 * 165 * The filesystem should also provide these ops that some filesystems 166 * do their own things with: 167 * close 168 * read 169 * write 170 * fsync 171 * In most cases "their own things" means adjust timestamps and call 172 * spec_foo. For fsync it varies, but should always also call spec_fsync. 173 * 174 * Note that because the op descriptor tables are unordered it does not 175 * matter where in the table this macro goes (except I think default 176 * still needs to be first...) 177 */ 178 #define GENFS_SPECOP_ENTRIES \ 179 { &vop_parsepath_desc, genfs_badop }, /* parsepath */ \ 180 { &vop_lookup_desc, spec_lookup }, /* lookup */ \ 181 { &vop_create_desc, genfs_badop }, /* create */ \ 182 { &vop_whiteout_desc, genfs_badop }, /* whiteout */ \ 183 { &vop_mknod_desc, genfs_badop }, /* mknod */ \ 184 { &vop_open_desc, spec_open }, /* open */ \ 185 { &vop_fallocate_desc, genfs_eopnotsupp }, /* fallocate */ \ 186 { &vop_fdiscard_desc, spec_fdiscard }, /* fdiscard */ \ 187 { &vop_ioctl_desc, spec_ioctl }, /* ioctl */ \ 188 { &vop_poll_desc, spec_poll }, /* poll */ \ 189 { &vop_kqfilter_desc, spec_kqfilter }, /* kqfilter */ \ 190 { &vop_revoke_desc, genfs_revoke }, /* revoke */ \ 191 { &vop_mmap_desc, spec_mmap }, /* mmap */ \ 192 { &vop_seek_desc, spec_seek }, /* seek */ \ 193 { &vop_remove_desc, genfs_badop }, /* remove */ \ 194 { &vop_link_desc, genfs_badop }, /* link */ \ 195 { &vop_rename_desc, genfs_badop }, /* rename */ \ 196 { &vop_mkdir_desc, genfs_badop }, /* mkdir */ \ 197 { &vop_rmdir_desc, genfs_badop }, /* rmdir */ \ 198 { &vop_symlink_desc, genfs_badop }, /* symlink */ \ 199 { &vop_readdir_desc, genfs_badop }, /* readdir */ \ 200 { &vop_readlink_desc, genfs_badop }, /* readlink */ \ 201 { &vop_abortop_desc, genfs_badop }, /* abortop */ \ 202 { &vop_bmap_desc, spec_bmap }, /* bmap */ \ 203 { &vop_strategy_desc, spec_strategy }, /* strategy */ \ 204 { &vop_pathconf_desc, spec_pathconf }, /* pathconf */ \ 205 { &vop_advlock_desc, spec_advlock }, /* advlock */ \ 206 { &vop_getpages_desc, genfs_getpages }, /* getpages */ \ 207 { &vop_putpages_desc, genfs_putpages } /* putpages */ 208 209 210 bool iskmemvp(struct vnode *); 211 void spec_init(void); 212 213 #endif /* _MISCFS_SPECFS_SPECDEV_H_ */ 214