xref: /netbsd-src/lib/libpuffs/puffs.h (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: puffs.h,v 1.100 2007/12/11 20:17:26 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 enum {
248 	PUFFS_STATE_BEFOREMOUNT,	PUFFS_STATE_RUNNING,
249 	PUFFS_STATE_UNMOUNTING,		PUFFS_STATE_UNMOUNTED
250 };
251 
252 #define PUFFS_FLAG_BUILDPATH	0x80000000	/* node paths in pnode */
253 #define PUFFS_FLAG_OPDUMP	0x40000000	/* dump all operations */
254 #define PUFFS_FLAG_HASHPATH	0x20000000	/* speedup: hash paths */
255 #define PUFFS_FLAG_MASK		0xe0000000
256 
257 #define PUFFS_FLAG_KERN(a)	((a) & PUFFS_KFLAG_MASK)
258 #define PUFFS_FLAG_LIB(a)	((a) & PUFFS_FLAG_MASK)
259 
260 /* blocking mode argument */
261 #define PUFFSDEV_BLOCK 0
262 #define PUFFSDEV_NONBLOCK 1
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_unmount(struct puffs_usermount *, int);		\
275 	int fsname##_fs_statvfs(struct puffs_usermount *,		\
276 	    struct statvfs *);						\
277 	int fsname##_fs_sync(struct puffs_usermount *, int,		\
278 	    const struct puffs_cred *cred);				\
279 	int fsname##_fs_fhtonode(struct puffs_usermount *, void *,	\
280 	    size_t, struct puffs_newinfo *);				\
281 	int fsname##_fs_nodetofh(struct puffs_usermount *, void *cookie,\
282 	    void *, size_t *);						\
283 	void fsname##_fs_suspend(struct puffs_usermount *, int);	\
284 									\
285 	int fsname##_node_lookup(struct puffs_usermount *,		\
286 	    void *, struct puffs_newinfo *, const struct puffs_cn *);	\
287 	int fsname##_node_create(struct puffs_usermount *,		\
288 	    void *, struct puffs_newinfo *, const struct puffs_cn *,	\
289 	    const struct vattr *);					\
290 	int fsname##_node_mknod(struct puffs_usermount *,		\
291 	    void *, struct puffs_newinfo *, const struct puffs_cn *,	\
292 	    const struct vattr *);					\
293 	int fsname##_node_open(struct puffs_usermount *,		\
294 	    void *, int, const struct puffs_cred *);			\
295 	int fsname##_node_close(struct puffs_usermount *,		\
296 	    void *, int, const struct puffs_cred *);			\
297 	int fsname##_node_access(struct puffs_usermount *,		\
298 	    void *, int, const struct puffs_cred *);			\
299 	int fsname##_node_getattr(struct puffs_usermount *,		\
300 	    void *, struct vattr *, const struct puffs_cred *);		\
301 	int fsname##_node_setattr(struct puffs_usermount *,		\
302 	    void *, const struct vattr *, const struct puffs_cred *);	\
303 	int fsname##_node_poll(struct puffs_usermount *, void *, int *);\
304 	int fsname##_node_mmap(struct puffs_usermount *,		\
305 	    void *, vm_prot_t, const struct puffs_cred *);		\
306 	int fsname##_node_fsync(struct puffs_usermount *,		\
307 	    void *, const struct puffs_cred *, int, off_t, off_t);	\
308 	int fsname##_node_seek(struct puffs_usermount *,		\
309 	    void *, off_t, off_t, const struct puffs_cred *);		\
310 	int fsname##_node_remove(struct puffs_usermount *,		\
311 	    void *, void *, const struct puffs_cn *);			\
312 	int fsname##_node_link(struct puffs_usermount *,		\
313 	    void *, void *, const struct puffs_cn *);			\
314 	int fsname##_node_rename(struct puffs_usermount *,		\
315 	    void *, void *, const struct puffs_cn *, void *, void *,	\
316 	    const struct puffs_cn *);					\
317 	int fsname##_node_mkdir(struct puffs_usermount *,		\
318 	    void *, struct puffs_newinfo *, const struct puffs_cn *,	\
319 	    const struct vattr *);					\
320 	int fsname##_node_rmdir(struct puffs_usermount *,		\
321 	    void *, void *, const struct puffs_cn *);			\
322 	int fsname##_node_symlink(struct puffs_usermount *,		\
323 	    void *, struct puffs_newinfo *, const struct puffs_cn *,	\
324 	    const struct vattr *, const char *);			\
325 	int fsname##_node_readdir(struct puffs_usermount *,		\
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_usermount *,		\
329 	    void *, const struct puffs_cred *, char *, size_t *);	\
330 	int fsname##_node_reclaim(struct puffs_usermount *, void *);	\
331 	int fsname##_node_inactive(struct puffs_usermount *, void *);	\
332 	int fsname##_node_print(struct puffs_usermount *,		\
333 	    void *);							\
334 	int fsname##_node_pathconf(struct puffs_usermount *,		\
335 	    void *, int, int *);					\
336 	int fsname##_node_advlock(struct puffs_usermount *,		\
337 	    void *, void *, int, struct flock *, int);			\
338 	int fsname##_node_read(struct puffs_usermount *, void *,	\
339 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\
340 	int fsname##_node_write(struct puffs_usermount *, void *,	\
341 	    uint8_t *, off_t, size_t *, const struct puffs_cred *, int);\
342 									\
343 	int fsname##_cache_write(struct puffs_usermount *, void *,	\
344 	    size_t, struct puffs_cacheinfo *);
345 
346 #define PUFFSOP_INIT(ops)						\
347     ops = malloc(sizeof(struct puffs_ops));				\
348     memset(ops, 0, sizeof(struct puffs_ops))
349 #define PUFFSOP_SET(ops, fsname, fsornode, opname)			\
350     (ops)->puffs_##fsornode##_##opname = fsname##_##fsornode##_##opname
351 #define PUFFSOP_SETFSNOP(ops, opname)					\
352     (ops)->puffs_fs_##opname = puffs_fsnop_##opname
353 
354 PUFFSOP_PROTOS(puffs_null)	/* XXX */
355 
356 #define PUFFS_DEVEL_LIBVERSION 32
357 #define puffs_init(a,b,c,d,e) \
358     _puffs_init(PUFFS_DEVEL_LIBVERSION,a,b,c,d,e)
359 
360 
361 #define PNPATH(pnode)	((pnode)->pn_po.po_path)
362 #define PNPLEN(pnode)	((pnode)->pn_po.po_len)
363 #define PCNPATH(pcnode)	((pcnode)->pcn_po_full.po_path)
364 #define PCNPLEN(pcnode)	((pcnode)->pcn_po_full.po_len)
365 #define PCNISDOTDOT(pcnode) \
366 	((pcnode)->pcn_namelen == 2 && strcmp((pcnode)->pcn_name, "..") == 0)
367 
368 #define PUFFS_STORE_DCOOKIE(cp, ncp, off)				\
369 if (cp)	{								\
370 	*((cp)++) = off;						\
371 	(*(ncp))++;							\
372 }
373 
374 /* mainloop */
375 typedef void (*puffs_ml_loop_fn)(struct puffs_usermount *);
376 
377 /* framebuf stuff */
378 struct puffs_framebuf;
379 typedef int (*puffs_framev_readframe_fn)(struct puffs_usermount *,
380 					   struct puffs_framebuf *,
381 					   int, int *);
382 typedef	int (*puffs_framev_writeframe_fn)(struct puffs_usermount *,
383 					    struct puffs_framebuf *,
384 					    int, int *);
385 typedef int (*puffs_framev_cmpframe_fn)(struct puffs_usermount *,
386 					 struct puffs_framebuf *,
387 					 struct puffs_framebuf *,
388 					 int *);
389 typedef void (*puffs_framev_fdnotify_fn)(struct puffs_usermount *, int, int);
390 typedef void (*puffs_framev_gotframe_fn)(struct puffs_usermount *,
391 					struct puffs_framebuf *);
392 typedef void (*puffs_framev_cb)(struct puffs_usermount *,
393 				struct puffs_framebuf *,
394 				void *, int);
395 #define PUFFS_FBIO_READ		0x01
396 #define PUFFS_FBIO_WRITE	0x02
397 #define PUFFS_FBIO_ERROR	0x04
398 
399 #define PUFFS_FBQUEUE_URGENT	0x01
400 
401 
402 __BEGIN_DECLS
403 
404 struct puffs_usermount *_puffs_init(int, struct puffs_ops *, const char *,
405 				    const char *, void *, uint32_t);
406 int		puffs_mount(struct puffs_usermount *, const char *, int, void*);
407 int		puffs_exit(struct puffs_usermount *, int);
408 int		puffs_mainloop(struct puffs_usermount *);
409 int		puffs_daemon(struct puffs_usermount *, int, 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_remove(struct puffs_node *);
439 void			puffs_pn_put(struct puffs_node *);
440 struct vattr		*puffs_pn_getvap(struct puffs_node *);
441 void *			puffs_pn_getpriv(struct puffs_node *);
442 void			puffs_pn_setpriv(struct puffs_node *, void *);
443 struct puffs_pathobj	*puffs_pn_getpo(struct puffs_node *);
444 struct puffs_usermount	*puffs_pn_getmnt(struct puffs_node *);
445 
446 void	puffs_newinfo_setcookie(struct puffs_newinfo *, void *);
447 void	puffs_newinfo_setvtype(struct puffs_newinfo *, enum vtype);
448 void	puffs_newinfo_setsize(struct puffs_newinfo *, voff_t);
449 void	puffs_newinfo_setrdev(struct puffs_newinfo *, dev_t);
450 
451 void			*puffs_pn_getmntspecific(struct puffs_node *);
452 
453 typedef		void *	(*puffs_nodewalk_fn)(struct puffs_usermount *,
454 					     struct puffs_node *, void *);
455 void			*puffs_pn_nodewalk(struct puffs_usermount *,
456 					   puffs_nodewalk_fn, void *);
457 
458 void			puffs_setvattr(struct vattr *, const struct vattr *);
459 void			puffs_vattr_null(struct vattr *);
460 
461 void			puffs_null_setops(struct puffs_ops *);
462 
463 /*
464  * generic/dummy routines applicable for some file systems
465  */
466 int  puffs_fsnop_unmount(struct puffs_usermount *, int);
467 int  puffs_fsnop_statvfs(struct puffs_usermount *, struct statvfs *);
468 void puffs_zerostatvfs(struct statvfs *);
469 int  puffs_fsnop_sync(struct puffs_usermount *, int waitfor,
470 		      const struct puffs_cred *);
471 int  puffs_genfs_node_reclaim(struct puffs_usermount *, void *);
472 
473 /*
474  * Subroutine stuff
475  */
476 
477 int		puffs_gendotdent(struct dirent **, ino_t, int, size_t *);
478 int		puffs_nextdent(struct dirent **, const char *, ino_t,
479 			       uint8_t, size_t *);
480 int		puffs_vtype2dt(enum vtype);
481 enum vtype	puffs_mode2vt(mode_t);
482 void		puffs_stat2vattr(struct vattr *va, const struct stat *);
483 mode_t		puffs_addvtype2mode(mode_t, enum vtype);
484 
485 
486 /*
487  * credentials & permissions
488  */
489 
490 /* Credential fetch */
491 int	puffs_cred_getuid(const struct puffs_cred *, uid_t *);
492 int	puffs_cred_getgid(const struct puffs_cred *, gid_t *);
493 int	puffs_cred_getgroups(const struct puffs_cred *, gid_t *, short *);
494 
495 /* Credential check */
496 bool	puffs_cred_isuid(const struct puffs_cred *, uid_t);
497 bool	puffs_cred_hasgroup(const struct puffs_cred *, gid_t);
498 bool	puffs_cred_isregular(const struct puffs_cred *);
499 bool	puffs_cred_iskernel(const struct puffs_cred *);
500 bool	puffs_cred_isfs(const struct puffs_cred *);
501 bool	puffs_cred_isjuggernaut(const struct puffs_cred *);
502 
503 /* misc */
504 int	puffs_access(enum vtype, mode_t, uid_t, gid_t, mode_t,
505 		     const struct puffs_cred *);
506 int	puffs_access_chown(uid_t, gid_t, uid_t, gid_t,
507 			   const struct puffs_cred *);
508 int	puffs_access_chmod(uid_t, gid_t, enum vtype, mode_t,
509 			   const struct puffs_cred *);
510 int	puffs_access_times(uid_t, gid_t, mode_t, int,
511 			   const struct puffs_cred *);
512 
513 
514 /*
515  * Call Context interfaces relevant for user.
516  */
517 
518 void			puffs_cc_yield(struct puffs_cc *);
519 void			puffs_cc_continue(struct puffs_cc *);
520 void			puffs_cc_schedule(struct puffs_cc *);
521 struct puffs_usermount	*puffs_cc_getusermount(struct puffs_cc *);
522 void 			*puffs_cc_getspecific(struct puffs_cc *);
523 int			puffs_cc_getcaller(struct puffs_cc *,pid_t *,lwpid_t *);
524 struct puffs_cc		*puffs_cc_getcc(struct puffs_usermount *);
525 
526 /*
527  * Flushing / invalidation routines
528  */
529 
530 int	puffs_inval_namecache_dir(struct puffs_usermount *, void *);
531 int	puffs_inval_namecache_all(struct puffs_usermount *);
532 
533 int	puffs_inval_pagecache_node(struct puffs_usermount *, void *);
534 int	puffs_inval_pagecache_node_range(struct puffs_usermount *, void *,
535 					 off_t, off_t);
536 int	puffs_flush_pagecache_node(struct puffs_usermount *, void *);
537 int	puffs_flush_pagecache_node_range(struct puffs_usermount *, void *,
538 					 off_t, off_t);
539 
540 /*
541  * Path constructicons
542  */
543 
544 int	puffs_stdpath_buildpath(struct puffs_usermount *,
545 			     const struct puffs_pathobj *,
546 			     const struct puffs_pathobj *, size_t,
547 			     struct puffs_pathobj *);
548 int	puffs_stdpath_cmppath(struct puffs_usermount *, struct puffs_pathobj *,
549 			   struct puffs_pathobj *, size_t, int);
550 void	puffs_stdpath_freepath(struct puffs_usermount *,struct puffs_pathobj *);
551 
552 void	*puffs_path_walkcmp(struct puffs_usermount *,
553 			    struct puffs_node *, void *);
554 void	*puffs_path_prefixadj(struct puffs_usermount *,
555 			      struct puffs_node *, void *);
556 int	puffs_path_pcnbuild(struct puffs_usermount *,
557 			    struct puffs_cn *, void *);
558 void	puffs_path_buildhash(struct puffs_usermount *, struct puffs_pathobj *);
559 void	puffs_set_pathbuild(struct puffs_usermount *, pu_pathbuild_fn); void	puffs_set_pathtransform(struct puffs_usermount *, pu_pathtransform_fn);
560 void	puffs_set_pathcmp(struct puffs_usermount *, pu_pathcmp_fn);
561 void	puffs_set_pathfree(struct puffs_usermount *, pu_pathfree_fn);
562 void	puffs_set_namemod(struct puffs_usermount *, pu_namemod_fn);
563 
564 void	puffs_set_errnotify(struct puffs_usermount *, pu_errnotify_fn);
565 void	puffs_set_prepost(struct puffs_usermount *,
566 			  pu_prepost_fn, pu_prepost_fn);
567 
568 /*
569  * Suspension
570  */
571 
572 int	puffs_fs_suspend(struct puffs_usermount *);
573 
574 /*
575  * Frame buffering
576  */
577 
578 void	puffs_framev_init(struct puffs_usermount *,
579 			  puffs_framev_readframe_fn,
580 			  puffs_framev_writeframe_fn,
581 			  puffs_framev_cmpframe_fn,
582 			  puffs_framev_gotframe_fn,
583 			  puffs_framev_fdnotify_fn);
584 
585 struct puffs_framebuf 	*puffs_framebuf_make(void);
586 void			puffs_framebuf_destroy(struct puffs_framebuf *);
587 int			puffs_framebuf_dup(struct puffs_framebuf *,
588 					   struct puffs_framebuf **);
589 void			puffs_framebuf_recycle(struct puffs_framebuf *);
590 int			puffs_framebuf_reserve_space(struct puffs_framebuf *,
591 						     size_t);
592 
593 int	puffs_framebuf_putdata(struct puffs_framebuf *, const void *, size_t);
594 int	puffs_framebuf_putdata_atoff(struct puffs_framebuf *, size_t,
595 				     const void *, size_t);
596 int	puffs_framebuf_getdata(struct puffs_framebuf *, void *, size_t);
597 int	puffs_framebuf_getdata_atoff(struct puffs_framebuf *, size_t,
598 				     void *, size_t);
599 
600 size_t	puffs_framebuf_telloff(struct puffs_framebuf *);
601 size_t	puffs_framebuf_tellsize(struct puffs_framebuf *);
602 size_t	puffs_framebuf_remaining(struct puffs_framebuf *);
603 int	puffs_framebuf_seekset(struct puffs_framebuf *, size_t);
604 int	puffs_framebuf_getwindow(struct puffs_framebuf *, size_t,
605 				 void **, size_t *);
606 
607 int	puffs_framev_enqueue_cc(struct puffs_cc *, int,
608 				struct puffs_framebuf *, int);
609 int	puffs_framev_enqueue_cb(struct puffs_usermount *, int,
610 				struct puffs_framebuf *,
611 				puffs_framev_cb, void *, int);
612 int	puffs_framev_enqueue_justsend(struct puffs_usermount *, int,
613 				      struct puffs_framebuf *, int, int);
614 int	puffs_framev_enqueue_directreceive(struct puffs_cc *, int,
615 					   struct puffs_framebuf *, int);
616 int	puffs_framev_enqueue_directsend(struct puffs_cc *, int,
617 					   struct puffs_framebuf *, int);
618 int	puffs_framev_enqueue_waitevent(struct puffs_cc *, int, int *);
619 int	puffs_framev_framebuf_ccpromote(struct puffs_framebuf *,
620 					struct puffs_cc *);
621 
622 int	puffs_framev_addfd(struct puffs_usermount *, int, int);
623 int	puffs_framev_enablefd(struct puffs_usermount *, int, int);
624 int	puffs_framev_disablefd(struct puffs_usermount *, int, int);
625 int	puffs_framev_removefd(struct puffs_usermount *, int, int);
626 void	puffs_framev_removeonclose(struct puffs_usermount *, int, int);
627 void	puffs_framev_unmountonclose(struct puffs_usermount *, int, int);
628 
629 __END_DECLS
630 
631 #endif /* _PUFFS_H_ */
632