puffs.h revision 1.13
1 /* $NetBSD: puffs.h,v 1.13 2006/12/01 12:50:06 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_unmount)(struct puffs_usermount *, int, pid_t); 78 int (*puffs_statvfs)(struct puffs_usermount *, 79 struct statvfs *, pid_t); 80 int (*puffs_sync)(struct puffs_usermount *, int, 81 const struct puffs_cred *, pid_t); 82 }; 83 84 struct puffs_vnops { 85 int (*puffs_lookup)(struct puffs_usermount *, 86 void *, void **, enum vtype *, voff_t *, dev_t *, 87 const struct puffs_cn *); 88 int (*puffs_create)(struct puffs_usermount *, 89 void *, void **, const struct puffs_cn *, const struct vattr *); 90 int (*puffs_mknod)(struct puffs_usermount *, 91 void *, void **, const struct puffs_cn *, const struct vattr *); 92 int (*puffs_open)(struct puffs_usermount *, 93 void *, int, const struct puffs_cred *, pid_t); 94 int (*puffs_close)(struct puffs_usermount *, 95 void *, int, const struct puffs_cred *, pid_t); 96 int (*puffs_access)(struct puffs_usermount *, 97 void *, int, const struct puffs_cred *, pid_t); 98 int (*puffs_getattr)(struct puffs_usermount *, 99 void *, struct vattr *, const struct puffs_cred *, pid_t); 100 int (*puffs_setattr)(struct puffs_usermount *, 101 void *, const struct vattr *, const struct puffs_cred *, pid_t); 102 int (*puffs_poll)(struct puffs_usermount *, 103 void *, struct puffs_vnreq_poll *); 104 int (*puffs_revoke)(struct puffs_usermount *, void *, int); 105 int (*puffs_mmap)(struct puffs_usermount *, 106 void *, struct puffs_vnreq_mmap *); 107 int (*puffs_fsync)(struct puffs_usermount *, 108 void *, const struct puffs_cred *, int, off_t, off_t, pid_t); 109 int (*puffs_seek)(struct puffs_usermount *, 110 void *, off_t, off_t, const struct puffs_cred *); 111 int (*puffs_remove)(struct puffs_usermount *, 112 void *, void *, const struct puffs_cn *); 113 int (*puffs_link)(struct puffs_usermount *, 114 void *, void *, const struct puffs_cn *); 115 int (*puffs_rename)(struct puffs_usermount *, 116 void *, void *, const struct puffs_cn *, void *, void *, 117 const struct puffs_cn *); 118 int (*puffs_mkdir)(struct puffs_usermount *, 119 void *, void **, const struct puffs_cn *, const struct vattr *); 120 int (*puffs_rmdir)(struct puffs_usermount *, 121 void *, void *, const struct puffs_cn *); 122 int (*puffs_symlink)(struct puffs_usermount *, 123 void *, void **, const struct puffs_cn *, const struct vattr *, 124 const char *); 125 int (*puffs_readdir)(struct puffs_usermount *, 126 void *, struct dirent *, const struct puffs_cred *, 127 off_t *, size_t *); 128 int (*puffs_readlink)(struct puffs_usermount *, 129 void *, const struct puffs_cred *, char *, size_t *); 130 int (*puffs_reclaim)(struct puffs_usermount *, 131 void *, pid_t); 132 int (*puffs_inactive)(struct puffs_usermount *, 133 void *, pid_t, int *); 134 int (*puffs_print)(struct puffs_usermount *, 135 void *); 136 int (*puffs_pathconf)(struct puffs_usermount *, 137 void *, int, int *); 138 int (*puffs_advlock)(struct puffs_usermount *, 139 void *, void *, int, struct flock *, int); 140 int (*puffs_getextattr)(struct puffs_usermount *, 141 void *, struct puffs_vnreq_getextattr *); 142 int (*puffs_setextattr)(struct puffs_usermount *, 143 void *, struct puffs_vnreq_setextattr *); 144 int (*puffs_listextattr)(struct puffs_usermount *, 145 void *, struct puffs_vnreq_listextattr *); 146 int (*puffs_read)(struct puffs_usermount *, void *, 147 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 148 int (*puffs_write)(struct puffs_usermount *, void *, 149 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 150 151 int (*puffs_ioctl1)(struct puffs_usermount *, void *, 152 struct puffs_vnreq_fcnioctl *, struct puffs_sizeop *); 153 int (*puffs_ioctl2)(struct puffs_usermount *, void *, 154 struct puffs_vnreq_fcnioctl *, struct puffs_sizeop *); 155 int (*puffs_fcntl1)(struct puffs_usermount *, void *, 156 struct puffs_vnreq_fcnioctl *, struct puffs_sizeop *); 157 int (*puffs_fcntl2)(struct puffs_usermount *, void *, 158 struct puffs_vnreq_fcnioctl *, struct puffs_sizeop *); 159 }; 160 161 struct puffs_usermount { 162 struct puffs_vfsops pu_pvfs; 163 struct puffs_vnops pu_pvn; 164 165 int pu_fd; 166 uint32_t pu_flags; 167 size_t pu_maxreqlen; 168 169 struct puffs_node *pu_rootnode; 170 const char * pu_rootpath; 171 fsid_t pu_fsidx; 172 LIST_HEAD(, puffs_node) pu_pnodelst; 173 174 int pu_wcnt; 175 void *pu_privdata; 176 }; 177 178 #define PUFFS_FLAG_KERN(a) ((a) & 0x0000ffff) 179 #define PUFFS_FLAG_LIB(a) ((a) & 0xffff0000) 180 181 #define PUFFS_FLAG_OPDUMP 0x80000000 /* dump all operations */ 182 183 struct puffs_usermount *puffs_mount(struct puffs_vfsops *, struct puffs_vnops *, 184 const char *, int, const char *, 185 uint32_t, size_t); 186 int puffs_mainloop(struct puffs_usermount *, int); 187 int puffs_oneop(struct puffs_usermount *, uint8_t *, size_t); 188 int puffs_getselectable(struct puffs_usermount *); 189 int puffs_setblockingmode(struct puffs_usermount *, int); 190 void puffs_dummyops(struct puffs_vnops *); 191 192 /* blocking mode argument */ 193 #define PUFFSDEV_BLOCK 0 194 #define PUFFSDEV_NONBLOCK 1 195 196 /* mainloop flags */ 197 #define PUFFSLOOP_NODAEMON 0x01 198 199 struct puffs_node * puffs_newpnode(struct puffs_usermount *, void *, 200 enum vtype); 201 void puffs_putpnode(struct puffs_node *); 202 void puffs_setvattr(struct vattr *, const struct vattr *); 203 204 int puffs_vfsnop_unmount(struct puffs_usermount *, int, pid_t); 205 int puffs_vfsnop_statvfs(struct puffs_usermount *, struct statvfs *, pid_t); 206 int puffs_vfsnop_sync(struct puffs_usermount *, int waitfor, 207 const struct puffs_cred *, pid_t); 208 209 #define DENT_DOT 0 210 #define DENT_DOTDOT 1 211 #define DENT_ADJ(a) ((a)-2) /* nth request means dir's n-2th */ 212 int puffs_gendotdent(struct dirent **, ino_t, int, size_t *); 213 int puffs_nextdent(struct dirent **, const char *, ino_t, 214 uint8_t, size_t *); 215 int puffs_vtype2dt(enum vtype); 216 enum vtype puffs_mode2vt(mode_t); 217 218 219 /* 220 * Operation credentials 221 */ 222 223 /* Credential fetch */ 224 int puffs_cred_getuid(const struct puffs_cred *pcr, uid_t *); 225 int puffs_cred_getgid(const struct puffs_cred *pcr, gid_t *); 226 int puffs_cred_getgroups(const struct puffs_cred *pcr, gid_t *, short *); 227 228 /* Credential check */ 229 int puffs_cred_isuid(const struct puffs_cred *pcr, uid_t); 230 int puffs_cred_hasgroup(const struct puffs_cred *pcr, gid_t); 231 /* kernel internal NOCRED */ 232 int puffs_cred_iskernel(const struct puffs_cred *pcr); 233 /* kernel internal FSCRED */ 234 int puffs_cred_isfs(const struct puffs_cred *pcr); 235 /* root || NOCRED || FSCRED */ 236 int puffs_cred_isjuggernaut(const struct puffs_cred *pcr); 237 238 239 #define PUFFSVFS_PROTOS(fsname) \ 240 int fsname##_mount(struct puffs_usermount *, void **); \ 241 int fsname##_unmount(struct puffs_usermount *, int, pid_t); \ 242 int fsname##_statvfs(struct puffs_usermount *, \ 243 struct statvfs *, pid_t); \ 244 int fsname##_sync(struct puffs_usermount *, int, \ 245 const struct puffs_cred *cred, pid_t); 246 247 #define PUFFSVN_PROTOS(fsname) \ 248 int fsname##_lookup(struct puffs_usermount *, \ 249 void *, void **, enum vtype *, voff_t *, dev_t *, \ 250 const struct puffs_cn *); \ 251 int fsname##_create(struct puffs_usermount *, \ 252 void *, void **, const struct puffs_cn *, \ 253 const struct vattr *); \ 254 int fsname##_mknod(struct puffs_usermount *, \ 255 void *, void **, const struct puffs_cn *, \ 256 const struct vattr *); \ 257 int fsname##_open(struct puffs_usermount *, \ 258 void *, int, const struct puffs_cred *, pid_t); \ 259 int fsname##_close(struct puffs_usermount *, \ 260 void *, int, const struct puffs_cred *, pid_t); \ 261 int fsname##_access(struct puffs_usermount *, \ 262 void *, int, const struct puffs_cred *, pid_t); \ 263 int fsname##_getattr(struct puffs_usermount *, \ 264 void *, struct vattr *, const struct puffs_cred *, pid_t); \ 265 int fsname##_setattr(struct puffs_usermount *, \ 266 void *, const struct vattr *, const struct puffs_cred *, \ 267 pid_t); \ 268 int fsname##_poll(struct puffs_usermount *, \ 269 void *, struct puffs_vnreq_poll *); \ 270 int fsname##_revoke(struct puffs_usermount *, void *, int); \ 271 int fsname##_mmap(struct puffs_usermount *, \ 272 void *, struct puffs_vnreq_mmap *); \ 273 int fsname##_fsync(struct puffs_usermount *, \ 274 void *, const struct puffs_cred *, int, off_t, off_t, \ 275 pid_t); \ 276 int fsname##_seek(struct puffs_usermount *, \ 277 void *, off_t, off_t, const struct puffs_cred *); \ 278 int fsname##_remove(struct puffs_usermount *, \ 279 void *, void *, const struct puffs_cn *); \ 280 int fsname##_link(struct puffs_usermount *, \ 281 void *, void *, const struct puffs_cn *); \ 282 int fsname##_rename(struct puffs_usermount *, \ 283 void *, void *, const struct puffs_cn *, void *, void *, \ 284 const struct puffs_cn *); \ 285 int fsname##_mkdir(struct puffs_usermount *, \ 286 void *, void **, const struct puffs_cn *, \ 287 const struct vattr *); \ 288 int fsname##_rmdir(struct puffs_usermount *, \ 289 void *, void *, const struct puffs_cn *); \ 290 int fsname##_symlink(struct puffs_usermount *, \ 291 void *, void **, const struct puffs_cn *, \ 292 const struct vattr *, const char *); \ 293 int fsname##_readdir(struct puffs_usermount *, \ 294 void *, struct dirent *, const struct puffs_cred *, \ 295 off_t *, size_t *); \ 296 int fsname##_readlink(struct puffs_usermount *, \ 297 void *, const struct puffs_cred *, char *, size_t *); \ 298 int fsname##_reclaim(struct puffs_usermount *, \ 299 void *, pid_t); \ 300 int fsname##_inactive(struct puffs_usermount *, \ 301 void *, pid_t, int *); \ 302 int fsname##_print(struct puffs_usermount *, \ 303 void *); \ 304 int fsname##_pathconf(struct puffs_usermount *, \ 305 void *, int, int *); \ 306 int fsname##_advlock(struct puffs_usermount *, \ 307 void *, void *, int, struct flock *, int); \ 308 int fsname##_getextattr(struct puffs_usermount *, \ 309 void *, struct puffs_vnreq_getextattr *); \ 310 int fsname##_setextattr(struct puffs_usermount *, \ 311 void *, struct puffs_vnreq_setextattr *); \ 312 int fsname##_listextattr(struct puffs_usermount *, \ 313 void *, struct puffs_vnreq_listextattr *); \ 314 int fsname##_read(struct puffs_usermount *, void *, \ 315 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 316 int fsname##_write(struct puffs_usermount *, void *, \ 317 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 318 319 #endif /* _PUFFS_USER_H_ */ 320
Indexes created Sun Sep 28 16:09:52 GMT 2025