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