puffs.h revision 1.64
1 1.64 pooka /* $NetBSD: puffs.h,v 1.64 2007/06/24 18:42:25 pooka Exp $ */ 2 1.1 pooka 3 1.1 pooka /* 4 1.49 pooka * Copyright (c) 2005, 2006, 2007 Antti Kantee. All Rights Reserved. 5 1.1 pooka * 6 1.1 pooka * Development of this software was supported by the 7 1.1 pooka * Google Summer of Code program and the Ulla Tuominen Foundation. 8 1.1 pooka * The Google SoC project was mentored by Bill Studenmund. 9 1.1 pooka * 10 1.1 pooka * Redistribution and use in source and binary forms, with or without 11 1.1 pooka * modification, are permitted provided that the following conditions 12 1.1 pooka * are met: 13 1.1 pooka * 1. Redistributions of source code must retain the above copyright 14 1.1 pooka * notice, this list of conditions and the following disclaimer. 15 1.1 pooka * 2. Redistributions in binary form must reproduce the above copyright 16 1.1 pooka * notice, this list of conditions and the following disclaimer in the 17 1.1 pooka * documentation and/or other materials provided with the distribution. 18 1.1 pooka * 19 1.1 pooka * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS 20 1.1 pooka * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 21 1.1 pooka * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 22 1.1 pooka * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23 1.1 pooka * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 1.1 pooka * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 25 1.1 pooka * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 1.1 pooka * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 1.1 pooka * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 1.1 pooka * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 1.1 pooka * SUCH DAMAGE. 30 1.1 pooka */ 31 1.1 pooka 32 1.14 pooka #ifndef _PUFFS_H_ 33 1.14 pooka #define _PUFFS_H_ 34 1.1 pooka 35 1.1 pooka #include <sys/param.h> 36 1.30 pooka #include <sys/types.h> 37 1.1 pooka #include <sys/mount.h> 38 1.23 pooka #include <sys/stat.h> 39 1.1 pooka #include <sys/statvfs.h> 40 1.56 pooka #include <sys/time.h> 41 1.1 pooka #include <sys/vnode.h> 42 1.1 pooka 43 1.1 pooka #include <fs/puffs/puffs_msgif.h> 44 1.1 pooka 45 1.19 pooka #include <mntopts.h> 46 1.17 pooka #include <string.h> 47 1.17 pooka 48 1.17 pooka /* forwards */ 49 1.17 pooka struct puffs_cc; 50 1.17 pooka 51 1.17 pooka struct puffs_getreq; 52 1.17 pooka struct puffs_putreq; 53 1.17 pooka 54 1.25 pooka /* paths */ 55 1.25 pooka struct puffs_pathobj { 56 1.49 pooka void *po_path; 57 1.49 pooka size_t po_len; 58 1.49 pooka uint32_t po_hash; 59 1.25 pooka }; 60 1.25 pooka 61 1.25 pooka /* for prefix rename */ 62 1.25 pooka struct puffs_pathinfo { 63 1.25 pooka struct puffs_pathobj *pi_old; 64 1.25 pooka struct puffs_pathobj *pi_new; 65 1.25 pooka }; 66 1.25 pooka 67 1.33 pooka /* describes one segment cached in the kernel */ 68 1.33 pooka struct puffs_kcache { 69 1.33 pooka off_t pkc_start; 70 1.33 pooka off_t pkc_end; 71 1.33 pooka 72 1.33 pooka LIST_ENTRY(puffs_kcache) pkc_entries; 73 1.33 pooka }; 74 1.33 pooka 75 1.25 pooka /* XXX: might disappear from here into a private header */ 76 1.17 pooka struct puffs_node { 77 1.25 pooka off_t pn_size; 78 1.63 pooka int pn_flags; 79 1.25 pooka struct vattr pn_va; 80 1.17 pooka 81 1.25 pooka void *pn_data; /* private data */ 82 1.17 pooka 83 1.25 pooka struct puffs_pathobj pn_po; /* PUFFS_FLAG_BUILDPATH */ 84 1.17 pooka 85 1.25 pooka struct puffs_usermount *pn_mnt; 86 1.25 pooka LIST_ENTRY(puffs_node) pn_entries; 87 1.33 pooka 88 1.33 pooka LIST_HEAD(,puffs_kcache)pn_cacheinfo; /* PUFFS_KFLAG_CACHE */ 89 1.17 pooka }; 90 1.63 pooka #define PUFFS_NODE_REMOVED 0x01 /* not on entry list */ 91 1.17 pooka 92 1.17 pooka 93 1.17 pooka struct puffs_usermount; 94 1.17 pooka 95 1.1 pooka /* 96 1.1 pooka * megaXXX: these are values from inside _KERNEL 97 1.1 pooka * need to work on the translation for ALL the necessary values. 98 1.1 pooka */ 99 1.1 pooka #define PUFFS_VNOVAL (-1) 100 1.1 pooka #define PUFFS_IO_APPEND 0x20 101 1.34 pooka #define PUFFS_VEXEC 01 102 1.34 pooka #define PUFFS_VWRITE 02 103 1.34 pooka #define PUFFS_VREAD 04 104 1.1 pooka 105 1.24 pooka #define PUFFS_FSYNC_DATAONLY 0x0002 106 1.24 pooka #define PUFFS_FSYNC_CACHE 0x0100 107 1.24 pooka 108 1.1 pooka /* 109 1.17 pooka * Magic constants 110 1.1 pooka */ 111 1.22 pooka #define PUFFS_CC_STACKSIZE_DEFAULT (1024*1024) 112 1.1 pooka 113 1.17 pooka struct puffs_cn { 114 1.17 pooka struct puffs_kcn *pcn_pkcnp; /* kernel input */ 115 1.25 pooka struct puffs_pathobj pcn_po_full; /* PUFFS_FLAG_BUILDPATH */ 116 1.1 pooka }; 117 1.17 pooka #define pcn_nameiop pcn_pkcnp->pkcn_nameiop 118 1.17 pooka #define pcn_flags pcn_pkcnp->pkcn_flags 119 1.17 pooka #define pcn_pid pcn_pkcnp->pkcn_pid 120 1.17 pooka #define pcn_cred pcn_pkcnp->pkcn_cred 121 1.17 pooka #define pcn_name pcn_pkcnp->pkcn_name 122 1.17 pooka #define pcn_namelen pcn_pkcnp->pkcn_namelen 123 1.1 pooka 124 1.19 pooka /* 125 1.19 pooka * Puffs options to mount 126 1.19 pooka */ 127 1.19 pooka /* kernel */ 128 1.19 pooka #define PUFFSMOPT_CACHE { "cache", 1, PUFFS_KFLAG_NOCACHE, 1 } 129 1.19 pooka #define PUFFSMOPT_ALLOPS { "allops", 0, PUFFS_KFLAG_ALLOPS, 1 } 130 1.19 pooka 131 1.19 pooka /* libpuffs */ 132 1.19 pooka #define PUFFSMOPT_DUMP { "dump", 0, PUFFS_FLAG_OPDUMP, 1 } 133 1.19 pooka 134 1.19 pooka #define PUFFSMOPT_STD \ 135 1.19 pooka PUFFSMOPT_CACHE, \ 136 1.19 pooka PUFFSMOPT_ALLOPS, \ 137 1.19 pooka PUFFSMOPT_DUMP 138 1.19 pooka 139 1.19 pooka extern const struct mntopt puffsmopts[]; /* puffs.c */ 140 1.19 pooka 141 1.1 pooka /* callbacks for operations */ 142 1.14 pooka struct puffs_ops { 143 1.17 pooka int (*puffs_fs_unmount)(struct puffs_cc *, int, pid_t); 144 1.17 pooka int (*puffs_fs_statvfs)(struct puffs_cc *, 145 1.1 pooka struct statvfs *, pid_t); 146 1.17 pooka int (*puffs_fs_sync)(struct puffs_cc *, int, 147 1.1 pooka const struct puffs_cred *, pid_t); 148 1.41 pooka int (*puffs_fs_fhtonode)(struct puffs_cc *, void *, size_t, 149 1.41 pooka void **, enum vtype *, voff_t *, dev_t *); 150 1.41 pooka int (*puffs_fs_nodetofh)(struct puffs_cc *, void *cookie, 151 1.41 pooka void *, size_t *); 152 1.29 pooka void (*puffs_fs_suspend)(struct puffs_cc *, int); 153 1.1 pooka 154 1.17 pooka int (*puffs_node_lookup)(struct puffs_cc *, 155 1.4 pooka void *, void **, enum vtype *, voff_t *, dev_t *, 156 1.3 pooka const struct puffs_cn *); 157 1.17 pooka int (*puffs_node_create)(struct puffs_cc *, 158 1.1 pooka void *, void **, const struct puffs_cn *, const struct vattr *); 159 1.17 pooka int (*puffs_node_mknod)(struct puffs_cc *, 160 1.1 pooka void *, void **, const struct puffs_cn *, const struct vattr *); 161 1.17 pooka int (*puffs_node_open)(struct puffs_cc *, 162 1.1 pooka void *, int, const struct puffs_cred *, pid_t); 163 1.17 pooka int (*puffs_node_close)(struct puffs_cc *, 164 1.1 pooka void *, int, const struct puffs_cred *, pid_t); 165 1.17 pooka int (*puffs_node_access)(struct puffs_cc *, 166 1.1 pooka void *, int, const struct puffs_cred *, pid_t); 167 1.17 pooka int (*puffs_node_getattr)(struct puffs_cc *, 168 1.1 pooka void *, struct vattr *, const struct puffs_cred *, pid_t); 169 1.17 pooka int (*puffs_node_setattr)(struct puffs_cc *, 170 1.1 pooka void *, const struct vattr *, const struct puffs_cred *, pid_t); 171 1.59 pooka int (*puffs_node_poll)(struct puffs_cc *, void *, int *, pid_t); 172 1.17 pooka int (*puffs_node_mmap)(struct puffs_cc *, 173 1.15 pooka void *, int, const struct puffs_cred *, pid_t); 174 1.17 pooka int (*puffs_node_fsync)(struct puffs_cc *, 175 1.1 pooka void *, const struct puffs_cred *, int, off_t, off_t, pid_t); 176 1.17 pooka int (*puffs_node_seek)(struct puffs_cc *, 177 1.1 pooka void *, off_t, off_t, const struct puffs_cred *); 178 1.17 pooka int (*puffs_node_remove)(struct puffs_cc *, 179 1.1 pooka void *, void *, const struct puffs_cn *); 180 1.17 pooka int (*puffs_node_link)(struct puffs_cc *, 181 1.1 pooka void *, void *, const struct puffs_cn *); 182 1.17 pooka int (*puffs_node_rename)(struct puffs_cc *, 183 1.1 pooka void *, void *, const struct puffs_cn *, void *, void *, 184 1.1 pooka const struct puffs_cn *); 185 1.17 pooka int (*puffs_node_mkdir)(struct puffs_cc *, 186 1.1 pooka void *, void **, const struct puffs_cn *, const struct vattr *); 187 1.17 pooka int (*puffs_node_rmdir)(struct puffs_cc *, 188 1.1 pooka void *, void *, const struct puffs_cn *); 189 1.17 pooka int (*puffs_node_symlink)(struct puffs_cc *, 190 1.1 pooka void *, void **, const struct puffs_cn *, const struct vattr *, 191 1.1 pooka const char *); 192 1.17 pooka int (*puffs_node_readdir)(struct puffs_cc *, 193 1.41 pooka void *, struct dirent *, off_t *, size_t *, 194 1.41 pooka const struct puffs_cred *, int *, off_t *, size_t *); 195 1.17 pooka int (*puffs_node_readlink)(struct puffs_cc *, 196 1.1 pooka void *, const struct puffs_cred *, char *, size_t *); 197 1.17 pooka int (*puffs_node_reclaim)(struct puffs_cc *, 198 1.1 pooka void *, pid_t); 199 1.17 pooka int (*puffs_node_inactive)(struct puffs_cc *, 200 1.2 pooka void *, pid_t, int *); 201 1.17 pooka int (*puffs_node_print)(struct puffs_cc *, 202 1.1 pooka void *); 203 1.17 pooka int (*puffs_node_pathconf)(struct puffs_cc *, 204 1.1 pooka void *, int, int *); 205 1.17 pooka int (*puffs_node_advlock)(struct puffs_cc *, 206 1.1 pooka void *, void *, int, struct flock *, int); 207 1.17 pooka int (*puffs_node_getextattr)(struct puffs_cc *, 208 1.1 pooka void *, struct puffs_vnreq_getextattr *); 209 1.17 pooka int (*puffs_node_setextattr)(struct puffs_cc *, 210 1.1 pooka void *, struct puffs_vnreq_setextattr *); 211 1.17 pooka int (*puffs_node_listextattr)(struct puffs_cc *, 212 1.1 pooka void *, struct puffs_vnreq_listextattr *); 213 1.17 pooka int (*puffs_node_read)(struct puffs_cc *, void *, 214 1.1 pooka uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 215 1.17 pooka int (*puffs_node_write)(struct puffs_cc *, void *, 216 1.1 pooka uint8_t *, off_t, size_t *, const struct puffs_cred *, int); 217 1.33 pooka 218 1.33 pooka int (*puffs_cache_write)(struct puffs_usermount *, 219 1.33 pooka void *, size_t, struct puffs_cacherun *); 220 1.1 pooka }; 221 1.1 pooka 222 1.30 pooka typedef int (*pu_pathbuild_fn)(struct puffs_usermount *, 223 1.30 pooka const struct puffs_pathobj *, 224 1.30 pooka const struct puffs_pathobj *, size_t, 225 1.25 pooka struct puffs_pathobj *); 226 1.25 pooka typedef int (*pu_pathtransform_fn)(struct puffs_usermount *, 227 1.30 pooka const struct puffs_pathobj *, 228 1.25 pooka const struct puffs_cn *, 229 1.25 pooka struct puffs_pathobj *); 230 1.25 pooka typedef int (*pu_pathcmp_fn)(struct puffs_usermount *, struct puffs_pathobj *, 231 1.31 pooka struct puffs_pathobj *, size_t, int); 232 1.25 pooka typedef void (*pu_pathfree_fn)(struct puffs_usermount *, 233 1.25 pooka struct puffs_pathobj *); 234 1.25 pooka typedef int (*pu_namemod_fn)(struct puffs_usermount *, 235 1.25 pooka struct puffs_pathobj *, struct puffs_cn *); 236 1.25 pooka 237 1.17 pooka enum { 238 1.58 pooka PUFFS_STATE_BEFOREMOUNT, PUFFS_STATE_RUNNING, 239 1.43 pooka PUFFS_STATE_UNMOUNTING, PUFFS_STATE_UNMOUNTED 240 1.17 pooka }; 241 1.17 pooka 242 1.19 pooka #define PUFFS_FLAG_BUILDPATH 0x80000000 /* node paths in pnode */ 243 1.19 pooka #define PUFFS_FLAG_OPDUMP 0x40000000 /* dump all operations */ 244 1.49 pooka #define PUFFS_FLAG_HASHPATH 0x20000000 /* speedup: hash paths */ 245 1.49 pooka #define PUFFS_FLAG_MASK 0xe0000000 246 1.48 pooka 247 1.48 pooka #define PUFFS_FLAG_KERN(a) ((a) & PUFFS_KFLAG_MASK) 248 1.48 pooka #define PUFFS_FLAG_LIB(a) ((a) & PUFFS_FLAG_MASK) 249 1.1 pooka 250 1.12 pooka /* blocking mode argument */ 251 1.5 pooka #define PUFFSDEV_BLOCK 0 252 1.5 pooka #define PUFFSDEV_NONBLOCK 1 253 1.5 pooka 254 1.12 pooka /* mainloop flags */ 255 1.12 pooka #define PUFFSLOOP_NODAEMON 0x01 256 1.12 pooka 257 1.1 pooka #define DENT_DOT 0 258 1.1 pooka #define DENT_DOTDOT 1 259 1.1 pooka #define DENT_ADJ(a) ((a)-2) /* nth request means dir's n-2th */ 260 1.1 pooka 261 1.1 pooka 262 1.1 pooka /* 263 1.17 pooka * protos 264 1.16 pooka */ 265 1.16 pooka 266 1.14 pooka #define PUFFSOP_PROTOS(fsname) \ 267 1.17 pooka int fsname##_fs_mount(struct puffs_usermount *, void **, \ 268 1.17 pooka struct statvfs *); \ 269 1.17 pooka int fsname##_fs_unmount(struct puffs_cc *, int, pid_t); \ 270 1.17 pooka int fsname##_fs_statvfs(struct puffs_cc *, \ 271 1.1 pooka struct statvfs *, pid_t); \ 272 1.17 pooka int fsname##_fs_sync(struct puffs_cc *, int, \ 273 1.14 pooka const struct puffs_cred *cred, pid_t); \ 274 1.41 pooka int fsname##_fs_fhtonode(struct puffs_cc *, void *, size_t, \ 275 1.41 pooka void **, enum vtype *, voff_t *, dev_t *); \ 276 1.41 pooka int fsname##_fs_nodetofh(struct puffs_cc *, void *cookie, \ 277 1.41 pooka void *, size_t *); \ 278 1.29 pooka void fsname##_fs_suspend(struct puffs_cc *, int); \ 279 1.14 pooka \ 280 1.17 pooka int fsname##_node_lookup(struct puffs_cc *, \ 281 1.4 pooka void *, void **, enum vtype *, voff_t *, dev_t *, \ 282 1.3 pooka const struct puffs_cn *); \ 283 1.17 pooka int fsname##_node_create(struct puffs_cc *, \ 284 1.1 pooka void *, void **, const struct puffs_cn *, \ 285 1.1 pooka const struct vattr *); \ 286 1.17 pooka int fsname##_node_mknod(struct puffs_cc *, \ 287 1.1 pooka void *, void **, const struct puffs_cn *, \ 288 1.1 pooka const struct vattr *); \ 289 1.17 pooka int fsname##_node_open(struct puffs_cc *, \ 290 1.1 pooka void *, int, const struct puffs_cred *, pid_t); \ 291 1.17 pooka int fsname##_node_close(struct puffs_cc *, \ 292 1.11 pooka void *, int, const struct puffs_cred *, pid_t); \ 293 1.17 pooka int fsname##_node_access(struct puffs_cc *, \ 294 1.11 pooka void *, int, const struct puffs_cred *, pid_t); \ 295 1.17 pooka int fsname##_node_getattr(struct puffs_cc *, \ 296 1.1 pooka void *, struct vattr *, const struct puffs_cred *, pid_t); \ 297 1.17 pooka int fsname##_node_setattr(struct puffs_cc *, \ 298 1.1 pooka void *, const struct vattr *, const struct puffs_cred *, \ 299 1.1 pooka pid_t); \ 300 1.59 pooka int fsname##_node_poll(struct puffs_cc *, void *, int *,pid_t); \ 301 1.17 pooka int fsname##_node_mmap(struct puffs_cc *, \ 302 1.15 pooka void *, int, const struct puffs_cred *, pid_t); \ 303 1.17 pooka int fsname##_node_fsync(struct puffs_cc *, \ 304 1.1 pooka void *, const struct puffs_cred *, int, off_t, off_t, \ 305 1.1 pooka pid_t); \ 306 1.17 pooka int fsname##_node_seek(struct puffs_cc *, \ 307 1.1 pooka void *, off_t, off_t, const struct puffs_cred *); \ 308 1.17 pooka int fsname##_node_remove(struct puffs_cc *, \ 309 1.1 pooka void *, void *, const struct puffs_cn *); \ 310 1.17 pooka int fsname##_node_link(struct puffs_cc *, \ 311 1.1 pooka void *, void *, const struct puffs_cn *); \ 312 1.17 pooka int fsname##_node_rename(struct puffs_cc *, \ 313 1.1 pooka void *, void *, const struct puffs_cn *, void *, void *, \ 314 1.1 pooka const struct puffs_cn *); \ 315 1.17 pooka int fsname##_node_mkdir(struct puffs_cc *, \ 316 1.1 pooka void *, void **, const struct puffs_cn *, \ 317 1.1 pooka const struct vattr *); \ 318 1.17 pooka int fsname##_node_rmdir(struct puffs_cc *, \ 319 1.1 pooka void *, void *, const struct puffs_cn *); \ 320 1.17 pooka int fsname##_node_symlink(struct puffs_cc *, \ 321 1.1 pooka void *, void **, const struct puffs_cn *, \ 322 1.1 pooka const struct vattr *, const char *); \ 323 1.17 pooka int fsname##_node_readdir(struct puffs_cc *, \ 324 1.41 pooka void *, struct dirent *, off_t *, size_t *, \ 325 1.41 pooka const struct puffs_cred *, int *, off_t *, size_t *); \ 326 1.17 pooka int fsname##_node_readlink(struct puffs_cc *, \ 327 1.1 pooka void *, const struct puffs_cred *, char *, size_t *); \ 328 1.17 pooka int fsname##_node_reclaim(struct puffs_cc *, \ 329 1.1 pooka void *, pid_t); \ 330 1.17 pooka int fsname##_node_inactive(struct puffs_cc *, \ 331 1.2 pooka void *, pid_t, int *); \ 332 1.17 pooka int fsname##_node_print(struct puffs_cc *, \ 333 1.1 pooka void *); \ 334 1.17 pooka int fsname##_node_pathconf(struct puffs_cc *, \ 335 1.1 pooka void *, int, int *); \ 336 1.17 pooka int fsname##_node_advlock(struct puffs_cc *, \ 337 1.1 pooka void *, void *, int, struct flock *, int); \ 338 1.17 pooka int fsname##_node_getextattr(struct puffs_cc *, \ 339 1.1 pooka void *, struct puffs_vnreq_getextattr *); \ 340 1.17 pooka int fsname##_node_setextattr(struct puffs_cc *, \ 341 1.1 pooka void *, struct puffs_vnreq_setextattr *); \ 342 1.17 pooka int fsname##_node_listextattr(struct puffs_cc *, \ 343 1.1 pooka void *, struct puffs_vnreq_listextattr *); \ 344 1.17 pooka int fsname##_node_read(struct puffs_cc *, void *, \ 345 1.1 pooka uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 346 1.17 pooka int fsname##_node_write(struct puffs_cc *, void *, \ 347 1.33 pooka uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\ 348 1.33 pooka \ 349 1.33 pooka int fsname##_cache_write(struct puffs_usermount *, void *, \ 350 1.33 pooka size_t, struct puffs_cacheinfo *); 351 1.1 pooka 352 1.14 pooka #define PUFFSOP_INIT(ops) \ 353 1.17 pooka ops = malloc(sizeof(struct puffs_ops)); \ 354 1.14 pooka memset(ops, 0, sizeof(struct puffs_ops)) 355 1.14 pooka #define PUFFSOP_SET(ops, fsname, fsornode, opname) \ 356 1.14 pooka (ops)->puffs_##fsornode##_##opname = fsname##_##fsornode##_##opname 357 1.14 pooka #define PUFFSOP_SETFSNOP(ops, opname) \ 358 1.14 pooka (ops)->puffs_fs_##opname = puffs_fsnop_##opname 359 1.14 pooka 360 1.64 pooka PUFFSOP_PROTOS(puffs_null) /* XXX */ 361 1.64 pooka 362 1.60 pooka #define PUFFS_DEVEL_LIBVERSION 20 363 1.43 pooka #define puffs_init(a,b,c,d) \ 364 1.43 pooka _puffs_init(PUFFS_DEVEL_LIBVERSION,a,b,c,d) 365 1.17 pooka 366 1.25 pooka 367 1.25 pooka #define PNPATH(pnode) ((pnode)->pn_po.po_path) 368 1.25 pooka #define PNPLEN(pnode) ((pnode)->pn_po.po_len) 369 1.25 pooka #define PCNPATH(pcnode) ((pcnode)->pcn_po_full.po_path) 370 1.25 pooka #define PCNPLEN(pcnode) ((pcnode)->pcn_po_full.po_len) 371 1.30 pooka #define PCNISDOTDOT(pcnode) \ 372 1.30 pooka ((pcnode)->pcn_namelen == 2 && strcmp((pcnode)->pcn_name, "..") == 0) 373 1.25 pooka 374 1.46 pooka #define PUFFS_STORE_DCOOKIE(cp, ncp, off) \ 375 1.46 pooka if (cp) { \ 376 1.46 pooka *((cp)++) = off; \ 377 1.46 pooka (*(ncp))++; \ 378 1.46 pooka } 379 1.46 pooka 380 1.56 pooka /* mainloop */ 381 1.56 pooka typedef void (*puffs_ml_loop_fn)(struct puffs_usermount *); 382 1.56 pooka 383 1.50 pooka /* framebuf stuff */ 384 1.50 pooka struct puffs_framebuf; 385 1.56 pooka typedef int (*puffs_framev_readframe_fn)(struct puffs_usermount *, 386 1.50 pooka struct puffs_framebuf *, 387 1.50 pooka int, int *); 388 1.56 pooka typedef int (*puffs_framev_writeframe_fn)(struct puffs_usermount *, 389 1.50 pooka struct puffs_framebuf *, 390 1.50 pooka int, int *); 391 1.60 pooka typedef int (*puffs_framev_cmpframe_fn)(struct puffs_usermount *, 392 1.50 pooka struct puffs_framebuf *, 393 1.50 pooka struct puffs_framebuf *); 394 1.56 pooka typedef void (*puffs_framev_fdnotify_fn)(struct puffs_usermount *, int, int); 395 1.56 pooka typedef void (*puffs_framev_cb)(struct puffs_usermount *, 396 1.56 pooka struct puffs_framebuf *, 397 1.57 pooka void *, int); 398 1.56 pooka #define PUFFS_FBGONE_READ 0x01 399 1.56 pooka #define PUFFS_FBGONE_WRITE 0x02 400 1.56 pooka #define PUFFS_FBGONE_BOTH(a) ((a)==(PUFFS_FBGONE_READ|PUFFS_FBGONE_WRITE)) 401 1.50 pooka 402 1.50 pooka 403 1.17 pooka __BEGIN_DECLS 404 1.17 pooka 405 1.43 pooka struct puffs_usermount *_puffs_init(int, struct puffs_ops *pops, const char *, 406 1.43 pooka void *, uint32_t); 407 1.58 pooka int puffs_mount(struct puffs_usermount *, const char *, int, void*); 408 1.19 pooka int puffs_exit(struct puffs_usermount *, int); 409 1.17 pooka int puffs_mainloop(struct puffs_usermount *, int); 410 1.17 pooka 411 1.17 pooka 412 1.17 pooka int puffs_getselectable(struct puffs_usermount *); 413 1.17 pooka int puffs_setblockingmode(struct puffs_usermount *, int); 414 1.17 pooka int puffs_getstate(struct puffs_usermount *); 415 1.17 pooka void puffs_setstacksize(struct puffs_usermount *, size_t); 416 1.17 pooka 417 1.56 pooka void puffs_ml_setloopfn(struct puffs_usermount *, puffs_ml_loop_fn); 418 1.56 pooka void puffs_ml_settimeout(struct puffs_usermount *, struct timespec *); 419 1.56 pooka 420 1.42 pooka void puffs_setroot(struct puffs_usermount *, 421 1.42 pooka struct puffs_node *); 422 1.42 pooka struct puffs_node *puffs_getroot(struct puffs_usermount *); 423 1.58 pooka void puffs_setrootinfo(struct puffs_usermount *, 424 1.58 pooka enum vtype, vsize_t, dev_t); 425 1.58 pooka 426 1.42 pooka void *puffs_getspecific(struct puffs_usermount *); 427 1.44 pooka void puffs_setmaxreqlen(struct puffs_usermount *, size_t); 428 1.42 pooka size_t puffs_getmaxreqlen(struct puffs_usermount *); 429 1.45 pooka void puffs_setfhsize(struct puffs_usermount *, size_t, int); 430 1.44 pooka 431 1.44 pooka void puffs_setncookiehash(struct puffs_usermount *, int); 432 1.42 pooka 433 1.25 pooka struct puffs_pathobj *puffs_getrootpathobj(struct puffs_usermount *); 434 1.25 pooka 435 1.52 pooka void puffs_setback(struct puffs_cc *, int); 436 1.52 pooka 437 1.23 pooka struct puffs_node *puffs_pn_new(struct puffs_usermount *, void *); 438 1.63 pooka void puffs_pn_remove(struct puffs_node *); 439 1.17 pooka void puffs_pn_put(struct puffs_node *); 440 1.25 pooka 441 1.42 pooka void *puffs_pn_getmntspecific(struct puffs_node *); 442 1.42 pooka 443 1.25 pooka typedef void * (*puffs_nodewalk_fn)(struct puffs_usermount *, 444 1.25 pooka struct puffs_node *, void *); 445 1.25 pooka void *puffs_pn_nodewalk(struct puffs_usermount *, 446 1.25 pooka puffs_nodewalk_fn, void *); 447 1.23 pooka 448 1.17 pooka void puffs_setvattr(struct vattr *, const struct vattr *); 449 1.17 pooka void puffs_vattr_null(struct vattr *); 450 1.17 pooka 451 1.64 pooka void puffs_null_setops(struct puffs_ops *); 452 1.64 pooka 453 1.17 pooka /* 454 1.30 pooka * generic/dummy routines applicable for some file systems 455 1.30 pooka */ 456 1.30 pooka int puffs_fsnop_unmount(struct puffs_cc *, int, pid_t); 457 1.30 pooka int puffs_fsnop_statvfs(struct puffs_cc *, struct statvfs *, pid_t); 458 1.30 pooka void puffs_zerostatvfs(struct statvfs *); 459 1.30 pooka int puffs_fsnop_sync(struct puffs_cc *, int waitfor, 460 1.30 pooka const struct puffs_cred *, pid_t); 461 1.30 pooka int puffs_genfs_node_reclaim(struct puffs_cc *, void *, pid_t); 462 1.30 pooka 463 1.30 pooka /* 464 1.23 pooka * Subroutine stuff 465 1.23 pooka */ 466 1.23 pooka 467 1.23 pooka int puffs_gendotdent(struct dirent **, ino_t, int, size_t *); 468 1.23 pooka int puffs_nextdent(struct dirent **, const char *, ino_t, 469 1.23 pooka uint8_t, size_t *); 470 1.23 pooka int puffs_vtype2dt(enum vtype); 471 1.23 pooka enum vtype puffs_mode2vt(mode_t); 472 1.23 pooka void puffs_stat2vattr(struct vattr *va, const struct stat *); 473 1.32 pooka mode_t puffs_addvtype2mode(mode_t, enum vtype); 474 1.35 pooka 475 1.35 pooka 476 1.35 pooka /* 477 1.35 pooka * credentials & permissions 478 1.35 pooka */ 479 1.35 pooka 480 1.35 pooka /* Credential fetch */ 481 1.35 pooka int puffs_cred_getuid(const struct puffs_cred *pcr, uid_t *); 482 1.35 pooka int puffs_cred_getgid(const struct puffs_cred *pcr, gid_t *); 483 1.35 pooka int puffs_cred_getgroups(const struct puffs_cred *pcr, gid_t *, short *); 484 1.35 pooka 485 1.35 pooka /* Credential check */ 486 1.36 pooka int puffs_cred_isuid(const struct puffs_cred *, uid_t); 487 1.36 pooka int puffs_cred_hasgroup(const struct puffs_cred *, gid_t); 488 1.37 pooka int puffs_cred_isregular(const struct puffs_cred *); 489 1.36 pooka int puffs_cred_iskernel(const struct puffs_cred *); 490 1.36 pooka int puffs_cred_isfs(const struct puffs_cred *); 491 1.36 pooka int puffs_cred_isjuggernaut(const struct puffs_cred *); 492 1.35 pooka 493 1.35 pooka /* misc */ 494 1.35 pooka int puffs_access(enum vtype, mode_t, uid_t, gid_t, mode_t, 495 1.35 pooka const struct puffs_cred *); 496 1.38 pooka int puffs_access_chown(uid_t, gid_t, uid_t, gid_t, 497 1.38 pooka const struct puffs_cred *); 498 1.38 pooka int puffs_access_chmod(uid_t, gid_t, enum vtype, mode_t, 499 1.38 pooka const struct puffs_cred *); 500 1.38 pooka int puffs_access_times(uid_t, gid_t, mode_t, int, 501 1.38 pooka const struct puffs_cred *); 502 1.35 pooka 503 1.23 pooka 504 1.23 pooka /* 505 1.17 pooka * Requests 506 1.17 pooka */ 507 1.17 pooka 508 1.27 pooka struct puffs_getreq *puffs_req_makeget(struct puffs_usermount *, 509 1.27 pooka size_t, int); 510 1.27 pooka int puffs_req_loadget(struct puffs_getreq *); 511 1.27 pooka struct puffs_req *puffs_req_get(struct puffs_getreq *); 512 1.27 pooka int puffs_req_remainingget(struct puffs_getreq *); 513 1.27 pooka void puffs_req_setmaxget(struct puffs_getreq *, int); 514 1.27 pooka void puffs_req_destroyget(struct puffs_getreq *); 515 1.27 pooka 516 1.27 pooka struct puffs_putreq *puffs_req_makeput(struct puffs_usermount *); 517 1.27 pooka void puffs_req_put(struct puffs_putreq *,struct puffs_req *); 518 1.27 pooka void puffs_req_putcc(struct puffs_putreq *,struct puffs_cc*); 519 1.27 pooka int puffs_req_putput(struct puffs_putreq *); 520 1.27 pooka void puffs_req_resetput(struct puffs_putreq *); 521 1.27 pooka void puffs_req_destroyput(struct puffs_putreq *); 522 1.27 pooka 523 1.53 pooka int puffs_req_handle(struct puffs_getreq *, 524 1.27 pooka struct puffs_putreq *, int); 525 1.17 pooka 526 1.17 pooka /* 527 1.17 pooka * Call Context interfaces relevant for user. 528 1.17 pooka */ 529 1.17 pooka 530 1.17 pooka void puffs_cc_yield(struct puffs_cc *); 531 1.17 pooka void puffs_cc_continue(struct puffs_cc *); 532 1.17 pooka struct puffs_usermount *puffs_cc_getusermount(struct puffs_cc *); 533 1.47 pooka void *puffs_cc_getspecific(struct puffs_cc *); 534 1.19 pooka struct puffs_cc *puffs_cc_create(struct puffs_usermount *); 535 1.19 pooka void puffs_cc_destroy(struct puffs_cc *); 536 1.17 pooka 537 1.17 pooka /* 538 1.17 pooka * Execute or continue a request 539 1.17 pooka */ 540 1.17 pooka 541 1.28 pooka int puffs_dopreq(struct puffs_usermount *, struct puffs_req *, 542 1.28 pooka struct puffs_putreq *); 543 1.56 pooka void puffs_docc(struct puffs_cc *, struct puffs_putreq *); 544 1.17 pooka 545 1.20 pooka /* 546 1.20 pooka * Flushing / invalidation routines 547 1.20 pooka */ 548 1.20 pooka 549 1.21 pooka int puffs_inval_namecache_dir(struct puffs_usermount *, void *); 550 1.21 pooka int puffs_inval_namecache_all(struct puffs_usermount *); 551 1.20 pooka 552 1.33 pooka int puffs_inval_pagecache_node(struct puffs_usermount *, void *); 553 1.39 pooka int puffs_inval_pagecache_node_range(struct puffs_usermount *, void *, 554 1.39 pooka off_t, off_t); 555 1.40 pooka int puffs_flush_pagecache_node(struct puffs_usermount *, void *); 556 1.40 pooka int puffs_flush_pagecache_node_range(struct puffs_usermount *, void *, 557 1.40 pooka off_t, off_t); 558 1.33 pooka 559 1.25 pooka /* 560 1.25 pooka * Path constructicons 561 1.25 pooka */ 562 1.25 pooka 563 1.31 pooka int puffs_stdpath_buildpath(struct puffs_usermount *, 564 1.30 pooka const struct puffs_pathobj *, 565 1.30 pooka const struct puffs_pathobj *, size_t, 566 1.25 pooka struct puffs_pathobj *); 567 1.31 pooka int puffs_stdpath_cmppath(struct puffs_usermount *, struct puffs_pathobj *, 568 1.31 pooka struct puffs_pathobj *, size_t, int); 569 1.31 pooka void puffs_stdpath_freepath(struct puffs_usermount *,struct puffs_pathobj *); 570 1.25 pooka 571 1.31 pooka void *puffs_path_walkcmp(struct puffs_usermount *, 572 1.31 pooka struct puffs_node *, void *); 573 1.25 pooka void *puffs_path_prefixadj(struct puffs_usermount *, 574 1.25 pooka struct puffs_node *, void *); 575 1.25 pooka int puffs_path_pcnbuild(struct puffs_usermount *, 576 1.25 pooka struct puffs_cn *, void *); 577 1.49 pooka void puffs_path_buildhash(struct puffs_usermount *, struct puffs_pathobj *); 578 1.25 pooka 579 1.25 pooka void puffs_set_pathbuild(struct puffs_usermount *, pu_pathbuild_fn); 580 1.25 pooka void puffs_set_pathtransform(struct puffs_usermount *, pu_pathtransform_fn); 581 1.25 pooka void puffs_set_pathcmp(struct puffs_usermount *, pu_pathcmp_fn); 582 1.25 pooka void puffs_set_pathfree(struct puffs_usermount *, pu_pathfree_fn); 583 1.25 pooka void puffs_set_namemod(struct puffs_usermount *, pu_namemod_fn); 584 1.25 pooka 585 1.29 pooka /* 586 1.29 pooka * Suspension 587 1.29 pooka */ 588 1.29 pooka 589 1.29 pooka int puffs_fs_suspend(struct puffs_usermount *); 590 1.29 pooka 591 1.50 pooka /* 592 1.50 pooka * Frame buffering 593 1.50 pooka */ 594 1.50 pooka 595 1.56 pooka void puffs_framev_init(struct puffs_usermount *, 596 1.56 pooka puffs_framev_readframe_fn, 597 1.56 pooka puffs_framev_writeframe_fn, 598 1.60 pooka puffs_framev_cmpframe_fn, 599 1.56 pooka puffs_framev_fdnotify_fn); 600 1.55 pooka 601 1.50 pooka struct puffs_framebuf *puffs_framebuf_make(void); 602 1.50 pooka void puffs_framebuf_destroy(struct puffs_framebuf *); 603 1.50 pooka void puffs_framebuf_recycle(struct puffs_framebuf *); 604 1.50 pooka int puffs_framebuf_reserve_space(struct puffs_framebuf *, 605 1.50 pooka size_t); 606 1.50 pooka 607 1.50 pooka int puffs_framebuf_putdata(struct puffs_framebuf *, const void *, size_t); 608 1.50 pooka int puffs_framebuf_putdata_atoff(struct puffs_framebuf *, size_t, 609 1.50 pooka const void *, size_t); 610 1.50 pooka int puffs_framebuf_getdata(struct puffs_framebuf *, void *, size_t); 611 1.50 pooka int puffs_framebuf_getdata_atoff(struct puffs_framebuf *, size_t, 612 1.50 pooka void *, size_t); 613 1.50 pooka 614 1.50 pooka size_t puffs_framebuf_telloff(struct puffs_framebuf *); 615 1.50 pooka size_t puffs_framebuf_tellsize(struct puffs_framebuf *); 616 1.50 pooka size_t puffs_framebuf_remaining(struct puffs_framebuf *); 617 1.50 pooka int puffs_framebuf_seekset(struct puffs_framebuf *, size_t); 618 1.50 pooka int puffs_framebuf_getwindow(struct puffs_framebuf *, size_t, 619 1.50 pooka void **, size_t *); 620 1.50 pooka 621 1.56 pooka int puffs_framev_enqueue_cc(struct puffs_cc *, int, 622 1.56 pooka struct puffs_framebuf *); 623 1.56 pooka int puffs_framev_enqueue_cb(struct puffs_usermount *, int, 624 1.56 pooka struct puffs_framebuf *, 625 1.56 pooka puffs_framev_cb, void *); 626 1.56 pooka int puffs_framev_enqueue_justsend(struct puffs_usermount *, int, 627 1.56 pooka struct puffs_framebuf *, int); 628 1.61 pooka int puffs_framev_framebuf_ccpromote(struct puffs_framebuf *, 629 1.61 pooka struct puffs_cc *); 630 1.56 pooka 631 1.56 pooka int puffs_framev_addfd(struct puffs_usermount *pu, int); 632 1.56 pooka int puffs_framev_removefd(struct puffs_usermount *pu, int, int); 633 1.56 pooka void puffs_framev_unmountonclose(struct puffs_usermount *pu, int, int); 634 1.54 pooka 635 1.17 pooka __END_DECLS 636 1.17 pooka 637 1.14 pooka #endif /* _PUFFS_H_ */ 638
Indexes created Sun Sep 28 07:09:56 GMT 2025