Home | History | Annotate | Line # | Download | only in genfs 
      1 /* $NetBSD: genfs_node.h,v 1.25 2025/12/25 09:08:28 nia 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. The name of the author may not be used to endorse or promote products
     16  *    derived from this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     28  */
     29 
     30 #ifndef	_MISCFS_GENFS_GENFS_NODE_H_
     31 #define	_MISCFS_GENFS_GENFS_NODE_H_
     32 
     33 #include <sys/rwlock.h>
     34 
     35 struct vm_page;
     36 struct kauth_cred;
     37 struct uio;
     38 struct vnode;
     39 
     40 struct genfs_ops {
     41 	void	(*gop_size)(struct vnode *, off_t, off_t *, int);
     42 	int	(*gop_alloc)(struct vnode *, off_t, off_t, int,
     43 	    struct kauth_cred *);
     44 	int	(*gop_write)(struct vnode *, struct vm_page **, int, int);
     45 	void	(*gop_markupdate)(struct vnode *, int);
     46 	void	(*gop_putrange)(struct vnode *, off_t, off_t *, off_t *);
     47 };
     48 
     49 #define GOP_SIZE(vp, size, eobp, flags) \
     50 	(*VTOG(vp)->g_op->gop_size)((vp), (size), (eobp), (flags))
     51 #define GOP_ALLOC(vp, off, len, flags, cred) \
     52 	(*VTOG(vp)->g_op->gop_alloc)((vp), (off), (len), (flags), (cred))
     53 #define GOP_WRITE(vp, pgs, npages, flags) \
     54 	(*VTOG(vp)->g_op->gop_write)((vp), (pgs), (npages), (flags))
     55 #define GOP_PUTRANGE(vp, off, lop, hip) \
     56 	(*VTOG(vp)->g_op->gop_putrange)((vp), (off), (lop), (hip))
     57 
     58 /*
     59  * GOP_MARKUPDATE: mark vnode's timestamps for update.
     60  *
     61  * => called with vmobjlock (and possibly other locks) held.
     62  * => used for accesses via mmap.
     63  */
     64 
     65 #define GOP_MARKUPDATE(vp, flags) \
     66 	(VTOG(vp)->g_op->gop_markupdate) ? \
     67 	(*VTOG(vp)->g_op->gop_markupdate)((vp), (flags)) : \
     68 	(void)0;
     69 
     70 /* Flags to GOP_SIZE */
     71 #define	GOP_SIZE_MEM	0x4	/* in-memory size */
     72 
     73 /* Flags to GOP_MARKUPDATE */
     74 #define	GOP_UPDATE_ACCESSED	1
     75 #define	GOP_UPDATE_MODIFIED	2
     76 
     77 struct genfs_node {
     78 	const struct genfs_ops	*g_op;		/* ops vector */
     79 	krwlock_t		g_glock;	/* getpages lock */
     80 };
     81 
     82 #define VTOG(vp) ((struct genfs_node *)(vp)->v_data)
     83 
     84 void	genfs_size(struct vnode *, off_t, off_t *, int);
     85 void	genfs_node_init(struct vnode *, const struct genfs_ops *);
     86 void	genfs_node_destroy(struct vnode *);
     87 void	genfs_gop_putrange(struct vnode *, off_t, off_t *, off_t *);
     88 int	genfs_gop_write(struct vnode *, struct vm_page **, int, int);
     89 int	genfs_gop_write_rwmap(struct vnode *, struct vm_page **, int, int);
     90 int	genfs_compat_gop_write(struct vnode *, struct vm_page **, int, int);
     91 void	genfs_directio(struct vnode *, struct uio *, int);
     92 
     93 void	genfs_node_wrlock(struct vnode *);
     94 void	genfs_node_rdlock(struct vnode *);
     95 int	genfs_node_rdtrylock(struct vnode *);
     96 void	genfs_node_unlock(struct vnode *);
     97 int	genfs_node_wrlocked(struct vnode *);
     98 
     99 #endif	/* _MISCFS_GENFS_GENFS_NODE_H_ */
    100