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