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