puffs.h revision 1.2
1 /* $NetBSD: puffs.h,v 1.2 2006/10/25 18:15:50 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; 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_start)(struct puffs_usermount *, 77 struct puffs_vfsreq_start *); 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 *, 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_getpages)(struct puffs_usermount *, 141 void *, struct puffs_vnreq_getpages *); 142 int (*puffs_putpages)(struct puffs_usermount *, 143 void *, struct puffs_vnreq_putpages *); 144 int (*puffs_getextattr)(struct puffs_usermount *, 145 void *, struct puffs_vnreq_getextattr *); 146 int (*puffs_setextattr)(struct puffs_usermount *, 147 void *, struct puffs_vnreq_setextattr *); 148 int (*puffs_listextattr)(struct puffs_usermount *, 149 void *, struct puffs_vnreq_listextattr *); 150 int (*puffs_read)(struct puffs_usermount *, void *, 151 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 152 int (*puffs_write)(struct puffs_usermount *, void *, 153 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 154 155 int (*puffs_ioctl1)(struct puffs_usermount *, void *, 156 struct puffs_vnreq_fcnioctl *, struct puffs_sizeop *); 157 int (*puffs_ioctl2)(struct puffs_usermount *, void *, 158 struct puffs_vnreq_fcnioctl *, struct puffs_sizeop *); 159 int (*puffs_fcntl1)(struct puffs_usermount *, void *, 160 struct puffs_vnreq_fcnioctl *, struct puffs_sizeop *); 161 int (*puffs_fcntl2)(struct puffs_usermount *, void *, 162 struct puffs_vnreq_fcnioctl *, struct puffs_sizeop *); 163 }; 164 165 struct puffs_usermount { 166 struct puffs_vfsops pu_pvfs; 167 struct puffs_vnops pu_pvn; 168 169 int pu_fd; 170 uint32_t pu_flags; 171 size_t pu_maxreqlen; 172 173 struct puffs_node *pu_rootnode; 174 const char * pu_rootpath; 175 LIST_HEAD(, puffs_node) pu_pnodelst; 176 177 int pu_wcnt; 178 void *pu_privdata; 179 }; 180 181 #define PUFFSFLAG_OPDUMP 0x01 /* 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 *); 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 struct puffs_node * puffs_newpnode(struct puffs_usermount *, void *, 193 enum vtype); 194 void puffs_putpnode(struct puffs_node *); 195 void puffs_setvattr(struct vattr *, const struct vattr *); 196 197 #define DENT_DOT 0 198 #define DENT_DOTDOT 1 199 #define DENT_ADJ(a) ((a)-2) /* nth request means dir's n-2th */ 200 int puffs_gendotdent(struct dirent **, ino_t, int, size_t *); 201 int puffs_nextdent(struct dirent **, const char *, ino_t, 202 uint8_t, size_t *); 203 int puffs_vtype2dt(enum vtype); 204 205 206 /* 207 * Operation credentials 208 */ 209 210 /* Credential fetch */ 211 int puffs_cred_getuid(const struct puffs_cred *pcr, uid_t *); 212 int puffs_cred_getgid(const struct puffs_cred *pcr, gid_t *); 213 int puffs_cred_getgroups(const struct puffs_cred *pcr, gid_t *, short *); 214 215 /* Credential check */ 216 int puffs_cred_isuid(const struct puffs_cred *pcr, uid_t); 217 int puffs_cred_hasgroup(const struct puffs_cred *pcr, gid_t); 218 /* kernel internal NOCRED */ 219 int puffs_cred_iskernel(const struct puffs_cred *pcr); 220 /* kernel internal FSCRED */ 221 int puffs_cred_isfs(const struct puffs_cred *pcr); 222 /* root || NOCRED || FSCRED */ 223 int puffs_cred_isjuggernaut(const struct puffs_cred *pcr); 224 225 226 #define PUFFSVFS_PROTOS(fsname) \ 227 int fsname##_start(struct puffs_usermount *, \ 228 struct puffs_vfsreq_start *); \ 229 int fsname##_unmount(struct puffs_usermount *, int, pid_t); \ 230 int fsname##_statvfs(struct puffs_usermount *, \ 231 struct statvfs *, pid_t); \ 232 int fsname##_sync(struct puffs_usermount *, int, \ 233 const struct puffs_cred *cred, pid_t); 234 235 #define PUFFSVN_PROTOS(fsname) \ 236 int fsname##_lookup(struct puffs_usermount *, \ 237 void *, void **, enum vtype *, const struct puffs_cn *); \ 238 int fsname##_create(struct puffs_usermount *, \ 239 void *, void **, const struct puffs_cn *, \ 240 const struct vattr *); \ 241 int fsname##_mknod(struct puffs_usermount *, \ 242 void *, void **, const struct puffs_cn *, \ 243 const struct vattr *); \ 244 int fsname##_open(struct puffs_usermount *, \ 245 void *, int, const struct puffs_cred *, pid_t); \ 246 int fsname##_close(struct puffs_usermount *, \ 247 void *, int, struct puffs_cred *, pid_t); \ 248 int fsname##_access(struct puffs_usermount *, \ 249 void *, int, struct puffs_cred *, pid_t); \ 250 int fsname##_getattr(struct puffs_usermount *, \ 251 void *, struct vattr *, const struct puffs_cred *, pid_t); \ 252 int fsname##_setattr(struct puffs_usermount *, \ 253 void *, const struct vattr *, const struct puffs_cred *, \ 254 pid_t); \ 255 int fsname##_poll(struct puffs_usermount *, \ 256 void *, struct puffs_vnreq_poll *); \ 257 int fsname##_revoke(struct puffs_usermount *, void *, int); \ 258 int fsname##_mmap(struct puffs_usermount *, \ 259 void *, struct puffs_vnreq_mmap *); \ 260 int fsname##_fsync(struct puffs_usermount *, \ 261 void *, const struct puffs_cred *, int, off_t, off_t, \ 262 pid_t); \ 263 int fsname##_seek(struct puffs_usermount *, \ 264 void *, off_t, off_t, const struct puffs_cred *); \ 265 int fsname##_remove(struct puffs_usermount *, \ 266 void *, void *, const struct puffs_cn *); \ 267 int fsname##_link(struct puffs_usermount *, \ 268 void *, void *, const struct puffs_cn *); \ 269 int fsname##_rename(struct puffs_usermount *, \ 270 void *, void *, const struct puffs_cn *, void *, void *, \ 271 const struct puffs_cn *); \ 272 int fsname##_mkdir(struct puffs_usermount *, \ 273 void *, void **, const struct puffs_cn *, \ 274 const struct vattr *); \ 275 int fsname##_rmdir(struct puffs_usermount *, \ 276 void *, void *, const struct puffs_cn *); \ 277 int fsname##_symlink(struct puffs_usermount *, \ 278 void *, void **, const struct puffs_cn *, \ 279 const struct vattr *, const char *); \ 280 int fsname##_readdir(struct puffs_usermount *, \ 281 void *, struct dirent *, const struct puffs_cred *, \ 282 off_t *, size_t *); \ 283 int fsname##_readlink(struct puffs_usermount *, \ 284 void *, const struct puffs_cred *, char *, size_t *); \ 285 int fsname##_reclaim(struct puffs_usermount *, \ 286 void *, pid_t); \ 287 int fsname##_inactive(struct puffs_usermount *, \ 288 void *, pid_t, int *); \ 289 int fsname##_print(struct puffs_usermount *, \ 290 void *); \ 291 int fsname##_pathconf(struct puffs_usermount *, \ 292 void *, int, int *); \ 293 int fsname##_advlock(struct puffs_usermount *, \ 294 void *, void *, int, struct flock *, int); \ 295 int fsname##_getpages(struct puffs_usermount *, \ 296 void *, struct puffs_vnreq_getpages *); \ 297 int fsname##_putpages(struct puffs_usermount *, \ 298 void *, struct puffs_vnreq_putpages *); \ 299 int fsname##_getextattr(struct puffs_usermount *, \ 300 void *, struct puffs_vnreq_getextattr *); \ 301 int fsname##_setextattr(struct puffs_usermount *, \ 302 void *, struct puffs_vnreq_setextattr *); \ 303 int fsname##_listextattr(struct puffs_usermount *, \ 304 void *, struct puffs_vnreq_listextattr *); \ 305 int fsname##_read(struct puffs_usermount *, void *, \ 306 uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 307 int fsname##_write(struct puffs_usermount *, void *, \ 308 uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 309 310 #endif /* _PUFFS_USER_H_ */ 311
Indexes created Fri Sep 26 20:09:58 GMT 2025