puffs.h revision 1.5
1 /* $NetBSD: puffs.h,v 1.5 2006/11/09 13:11:01 pooka Exp $ */ 2 3 /* 4 * Copyright (c) 2005, 2006 Antti Kantee. All Rights Reserved. 5 * 6 * Development of this software was supported by the 7 * Google Summer of Code program and the Ulla Tuominen Foundation. 8 * The Google SoC project was mentored by Bill Studenmund. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. The name of the company nor the name of the author may be used to 19 * endorse or promote products derived from this software without specific 20 * prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS 23 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 24 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 25 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 */ 34 35 #ifndef _PUFFS_USER_H_ 36 #define _PUFFS_USER_H_ 37 38 #include <sys/param.h> 39 #include <sys/mount.h> 40 #include <sys/statvfs.h> 41 #include <sys/vnode.h> 42 43 #include <fs/puffs/puffs_msgif.h> 44 45 /* 46 * megaXXX: these are values from inside _KERNEL 47 * need to work on the translation for ALL the necessary values. 48 */ 49 #define PUFFS_VNOVAL (-1) 50 #define PUFFS_ISDOTDOT 0x2000 51 #define PUFFS_IO_APPEND 0x20 52 53 /* 54 * puffs vnode, i.e. puffs_node 55 * 56 * This represents all the relevant fields from struct vnode. 57 * This may some day become struct vnode, but let's keep it separate 58 * for now. 59 * 60 * XXX: this is not finished 61 */ 62 struct puffs_node { 63 off_t pn_size; 64 int pn_flag; /* struct vnode flags */ 65 void *pn_data; /* private data */ 66 enum vtype pn_type; 67 struct vattr pn_va; /* XXX: doesn't belong here*/ 68 69 struct puffs_usermount *pn_mnt; 70 71 LIST_ENTRY(puffs_node) pn_entries; 72 }; 73 74 /* callbacks for operations */ 75 struct puffs_vfsops { 76 int (*puffs_mount)(struct puffs_usermount *, void **); 77 int (*puffs_start)(struct puffs_usermount *); 78 int (*puffs_unmount)(struct puffs_usermount *, int, pid_t); 79 int (*puffs_statvfs)(struct puffs_usermount *, 80 struct statvfs *, pid_t); 81 int (*puffs_sync)(struct puffs_usermount *, int, 82 const struct puffs_cred *, pid_t); 83 }; 84 85 struct puffs_vnops { 86 int (*puffs_lookup)(struct puffs_usermount *, 87 void *, void **, enum vtype *, voff_t *, dev_t *, 88 const struct puffs_cn *); 89 int (*puffs_create)(struct puffs_usermount *, 90 void *, void **, const struct puffs_cn *, const struct vattr *); 91 int (*puffs_mknod)(struct puffs_usermount *, 92 void *, void **, const struct puffs_cn *, const struct vattr *); 93 int (*puffs_open)(struct puffs_usermount *, 94 void *, int, const struct puffs_cred *, pid_t); 95 int (*puffs_close)(struct puffs_usermount *, 96 void *, int, const struct puffs_cred *, pid_t); 97 int (*puffs_access)(struct puffs_usermount *, 98 void *, int, const struct puffs_cred *, pid_t); 99 int (*puffs_getattr)(struct puffs_usermount *, 100 void *, struct vattr *, const struct puffs_cred *, pid_t); 101 int (*puffs_setattr)(struct puffs_usermount *, 102 void *, const struct vattr *, const struct puffs_cred *, pid_t); 103 int (*puffs_poll)(struct puffs_usermount *, 104 void *, struct puffs_vnreq_poll *); 105 int (*puffs_revoke)(struct puffs_usermount *, void *, int); 106 int (*puffs_mmap)(struct puffs_usermount *, 107 void *, struct puffs_vnreq_mmap *); 108 int (*puffs_fsync)(struct puffs_usermount *, 109 void *, const struct puffs_cred *, int, off_t, off_t, pid_t); 110 int (*puffs_seek)(struct puffs_usermount *, 111 void *, off_t, off_t, const struct puffs_cred *); 112 int (*puffs_remove)(struct puffs_usermount *, 113 void *, void *, const struct puffs_cn *); 114 int (*puffs_link)(struct puffs_usermount *, 115 void *, void *, const struct puffs_cn *); 116 int (*puffs_rename)(struct puffs_usermount *, 117 void *, void *, const struct puffs_cn *, void *, void *, 118 const struct puffs_cn *); 119 int (*puffs_mkdir)(struct puffs_usermount *, 120 void *, void **, const struct puffs_cn *, const struct vattr *); 121 int (*puffs_rmdir)(struct puffs_usermount *, 122 void *, void *, const struct puffs_cn *); 123 int (*puffs_symlink)(struct puffs_usermount *, 124 void *, void **, const struct puffs_cn *, const struct vattr *, 125 const char *); 126 int (*puffs_readdir)(struct puffs_usermount *, 127 void *, struct dirent *, const struct puffs_cred *, 128 off_t *, size_t *); 129 int (*puffs_readlink)(struct puffs_usermount *, 130 void *, const struct puffs_cred *, char *, size_t *); 131 int (*puffs_reclaim)(struct puffs_usermount *, 132 void *, pid_t); 133 int (*puffs_inactive)(struct puffs_usermount *, 134 void *, pid_t, int *); 135 int (*puffs_print)(struct puffs_usermount *, 136 void *); 137 int (*puffs_pathconf)(struct puffs_usermount *, 138 void *, int, int *); 139 int (*puffs_advlock)(struct puffs_usermount *, 140 void *, void *, int, struct flock *, int); 141 int (*puffs_getextattr)(struct puffs_usermount *, 142 void *, struct puffs_vnreq_getextattr *); 143 int (*puffs_setextattr)(struct puffs_usermount *, 144 void *, struct puffs_vnreq_setextattr *); 145 int (*puffs_listextattr)(struct puffs_usermount *, 146 void *, struct puffs_vnreq_listextattr *); 147 int (*puffs_read)(struct puffs_usermount *, void *, 148 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 149 int (*puffs_write)(struct puffs_usermount *, void *, 150 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 151 152 int (*puffs_ioctl1)(struct puffs_usermount *, void *, 153 struct puffs_vnreq_fcnioctl *, struct puffs_sizeop *); 154 int (*puffs_ioctl2)(struct puffs_usermount *, void *, 155 struct puffs_vnreq_fcnioctl *, struct puffs_sizeop *); 156 int (*puffs_fcntl1)(struct puffs_usermount *, void *, 157 struct puffs_vnreq_fcnioctl *, struct puffs_sizeop *); 158 int (*puffs_fcntl2)(struct puffs_usermount *, void *, 159 struct puffs_vnreq_fcnioctl *, struct puffs_sizeop *); 160 }; 161 162 struct puffs_usermount { 163 struct puffs_vfsops pu_pvfs; 164 struct puffs_vnops pu_pvn; 165 166 int pu_fd; 167 uint32_t pu_flags; 168 size_t pu_maxreqlen; 169 170 struct puffs_node *pu_rootnode; 171 const char * pu_rootpath; 172 fsid_t pu_fsidx; 173 LIST_HEAD(, puffs_node) pu_pnodelst; 174 175 int pu_wcnt; 176 void *pu_privdata; 177 }; 178 179 #define PUFFSFLAG_OPDUMP 0x01 /* dump all operations */ 180 181 struct puffs_usermount *puffs_mount(struct puffs_vfsops *, struct puffs_vnops *, 182 const char *, int, const char *, 183 uint32_t, size_t); 184 int puffs_mainloop(struct puffs_usermount *); 185 int puffs_oneop(struct puffs_usermount *, uint8_t *, size_t); 186 int puffs_getselectable(struct puffs_usermount *); 187 int puffs_setblockingmode(struct puffs_usermount *, int); 188 void puffs_dummyops(struct puffs_vnops *); 189 190 #define PUFFSDEV_BLOCK 0 191 #define PUFFSDEV_NONBLOCK 1 192 193 struct puffs_node * puffs_newpnode(struct puffs_usermount *, void *, 194 enum vtype); 195 void puffs_putpnode(struct puffs_node *); 196 void puffs_setvattr(struct vattr *, const struct vattr *); 197 198 #define DENT_DOT 0 199 #define DENT_DOTDOT 1 200 #define DENT_ADJ(a) ((a)-2) /* nth request means dir's n-2th */ 201 int puffs_gendotdent(struct dirent **, ino_t, int, size_t *); 202 int puffs_nextdent(struct dirent **, const char *, ino_t, 203 uint8_t, size_t *); 204 int puffs_vtype2dt(enum vtype); 205 206 207 /* 208 * Operation credentials 209 */ 210 211 /* Credential fetch */ 212 int puffs_cred_getuid(const struct puffs_cred *pcr, uid_t *); 213 int puffs_cred_getgid(const struct puffs_cred *pcr, gid_t *); 214 int puffs_cred_getgroups(const struct puffs_cred *pcr, gid_t *, short *); 215 216 /* Credential check */ 217 int puffs_cred_isuid(const struct puffs_cred *pcr, uid_t); 218 int puffs_cred_hasgroup(const struct puffs_cred *pcr, gid_t); 219 /* kernel internal NOCRED */ 220 int puffs_cred_iskernel(const struct puffs_cred *pcr); 221 /* kernel internal FSCRED */ 222 int puffs_cred_isfs(const struct puffs_cred *pcr); 223 /* root || NOCRED || FSCRED */ 224 int puffs_cred_isjuggernaut(const struct puffs_cred *pcr); 225 226 227 #define PUFFSVFS_PROTOS(fsname) \ 228 int fsname##_mount(struct puffs_usermount *, void **); \ 229 int fsname##_start(struct puffs_usermount *); \ 230 int fsname##_unmount(struct puffs_usermount *, int, pid_t); \ 231 int fsname##_statvfs(struct puffs_usermount *, \ 232 struct statvfs *, pid_t); \ 233 int fsname##_sync(struct puffs_usermount *, int, \ 234 const struct puffs_cred *cred, pid_t); 235 236 #define PUFFSVN_PROTOS(fsname) \ 237 int fsname##_lookup(struct puffs_usermount *, \ 238 void *, void **, enum vtype *, voff_t *, dev_t *, \ 239 const struct puffs_cn *); \ 240 int fsname##_create(struct puffs_usermount *, \ 241 void *, void **, const struct puffs_cn *, \ 242 const struct vattr *); \ 243 int fsname##_mknod(struct puffs_usermount *, \ 244 void *, void **, const struct puffs_cn *, \ 245 const struct vattr *); \ 246 int fsname##_open(struct puffs_usermount *, \ 247 void *, int, const struct puffs_cred *, pid_t); \ 248 int fsname##_close(struct puffs_usermount *, \ 249 void *, int, struct puffs_cred *, pid_t); \ 250 int fsname##_access(struct puffs_usermount *, \ 251 void *, int, struct puffs_cred *, pid_t); \ 252 int fsname##_getattr(struct puffs_usermount *, \ 253 void *, struct vattr *, const struct puffs_cred *, pid_t); \ 254 int fsname##_setattr(struct puffs_usermount *, \ 255 void *, const struct vattr *, const struct puffs_cred *, \ 256 pid_t); \ 257 int fsname##_poll(struct puffs_usermount *, \ 258 void *, struct puffs_vnreq_poll *); \ 259 int fsname##_revoke(struct puffs_usermount *, void *, int); \ 260 int fsname##_mmap(struct puffs_usermount *, \ 261 void *, struct puffs_vnreq_mmap *); \ 262 int fsname##_fsync(struct puffs_usermount *, \ 263 void *, const struct puffs_cred *, int, off_t, off_t, \ 264 pid_t); \ 265 int fsname##_seek(struct puffs_usermount *, \ 266 void *, off_t, off_t, const struct puffs_cred *); \ 267 int fsname##_remove(struct puffs_usermount *, \ 268 void *, void *, const struct puffs_cn *); \ 269 int fsname##_link(struct puffs_usermount *, \ 270 void *, void *, const struct puffs_cn *); \ 271 int fsname##_rename(struct puffs_usermount *, \ 272 void *, void *, const struct puffs_cn *, void *, void *, \ 273 const struct puffs_cn *); \ 274 int fsname##_mkdir(struct puffs_usermount *, \ 275 void *, void **, const struct puffs_cn *, \ 276 const struct vattr *); \ 277 int fsname##_rmdir(struct puffs_usermount *, \ 278 void *, void *, const struct puffs_cn *); \ 279 int fsname##_symlink(struct puffs_usermount *, \ 280 void *, void **, const struct puffs_cn *, \ 281 const struct vattr *, const char *); \ 282 int fsname##_readdir(struct puffs_usermount *, \ 283 void *, struct dirent *, const struct puffs_cred *, \ 284 off_t *, size_t *); \ 285 int fsname##_readlink(struct puffs_usermount *, \ 286 void *, const struct puffs_cred *, char *, size_t *); \ 287 int fsname##_reclaim(struct puffs_usermount *, \ 288 void *, pid_t); \ 289 int fsname##_inactive(struct puffs_usermount *, \ 290 void *, pid_t, int *); \ 291 int fsname##_print(struct puffs_usermount *, \ 292 void *); \ 293 int fsname##_pathconf(struct puffs_usermount *, \ 294 void *, int, int *); \ 295 int fsname##_advlock(struct puffs_usermount *, \ 296 void *, void *, int, struct flock *, int); \ 297 int fsname##_getextattr(struct puffs_usermount *, \ 298 void *, struct puffs_vnreq_getextattr *); \ 299 int fsname##_setextattr(struct puffs_usermount *, \ 300 void *, struct puffs_vnreq_setextattr *); \ 301 int fsname##_listextattr(struct puffs_usermount *, \ 302 void *, struct puffs_vnreq_listextattr *); \ 303 int fsname##_read(struct puffs_usermount *, void *, \ 304 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 305 int fsname##_write(struct puffs_usermount *, void *, \ 306 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 307 308 #endif /* _PUFFS_USER_H_ */ 309
Indexes created Fri Sep 26 20:09:58 GMT 2025