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