xref: /netbsd-src/sys/miscfs/genfs/genfs_node.h (revision 9c1da17e908379b8a470f1117a6395bd6a0ca559)
1 /* $NetBSD: genfs_node.h,v 1.8 2005/07/23 12:18:41 yamt Exp $ */
2 
3 /*
4  * Copyright (c) 2001 Chuck Silvers.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *      This product includes software developed by Chuck Silvers.
18  * 4. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef	_MISCFS_GENFS_GENFS_NODE_H_
34 #define	_MISCFS_GENFS_GENFS_NODE_H_
35 
36 struct vm_page;
37 
38 struct genfs_ops {
39 	void	(*gop_size)(struct vnode *, off_t, off_t *, int);
40 	int	(*gop_alloc)(struct vnode *, off_t, off_t, int, struct ucred *);
41 	int	(*gop_write)(struct vnode *, struct vm_page **, int, int);
42 	void	(*gop_markupdate)(struct vnode *, int);
43 };
44 
45 #define GOP_SIZE(vp, size, eobp, flags) \
46 	(*VTOG(vp)->g_op->gop_size)((vp), (size), (eobp), (flags))
47 #define GOP_ALLOC(vp, off, len, flags, cred) \
48 	(*VTOG(vp)->g_op->gop_alloc)((vp), (off), (len), (flags), (cred))
49 #define GOP_WRITE(vp, pgs, npages, flags) \
50 	(*VTOG(vp)->g_op->gop_write)((vp), (pgs), (npages), (flags))
51 
52 /*
53  * GOP_MARKUPDATE: mark vnode's timestamps for update.
54  *
55  * => called with v_interlock (and possibly other locks) held.
56  * => used for accesses via mmap.
57  */
58 
59 #define GOP_MARKUPDATE(vp, flags) \
60 	(VTOG(vp)->g_op->gop_markupdate) ? \
61 	(*VTOG(vp)->g_op->gop_markupdate)((vp), (flags)) : \
62 	(void)0;
63 
64 /* Flags to GOP_SIZE */
65 #define	GOP_SIZE_READ	0x1	/* Advise how many pages to read */
66 #define	GOP_SIZE_WRITE	0x2	/* Tell how many pages to write */
67 #define	GOP_SIZE_MEM	0x4	/* in-memory size */
68 
69 /* Flags to GOP_MARKUPDATE */
70 #define	GOP_UPDATE_ACCESSED	1
71 #define	GOP_UPDATE_MODIFIED	2
72 
73 struct genfs_node {
74 	const struct genfs_ops	*g_op;		/* ops vector */
75 	struct lock		g_glock;	/* getpages lock */
76 	int			g_dirtygen;
77 };
78 
79 #define VTOG(vp) ((struct genfs_node *)(vp)->v_data)
80 
81 void	genfs_size(struct vnode *, off_t, off_t *, int);
82 void	genfs_node_init(struct vnode *, const struct genfs_ops *);
83 int	genfs_gop_write(struct vnode *, struct vm_page **, int, int);
84 int	genfs_compat_gop_write(struct vnode *, struct vm_page **, int, int);
85 
86 #endif	/* _MISCFS_GENFS_GENFS_NODE_H_ */
87