1/* $NetBSD: genfs_node.h,v 1.24 2020/03/14 21:47:41 ad 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#include <sys/rwlock.h>
 37
 38struct vm_page;
 39struct kauth_cred;
 40struct uio;
 41struct vnode;
 42
 43struct genfs_ops {
 44	void	(*gop_size)(struct vnode *, off_t, off_t *, int);
 45	int	(*gop_alloc)(struct vnode *, off_t, off_t, int,
 46	    struct kauth_cred *);
 47	int	(*gop_write)(struct vnode *, struct vm_page **, int, int);
 48	void	(*gop_markupdate)(struct vnode *, int);
 49	void	(*gop_putrange)(struct vnode *, off_t, off_t *, off_t *);
 50};
 51
 52#define GOP_SIZE(vp, size, eobp, flags) \
 53	(*VTOG(vp)->g_op->gop_size)((vp), (size), (eobp), (flags))
 54#define GOP_ALLOC(vp, off, len, flags, cred) \
 55	(*VTOG(vp)->g_op->gop_alloc)((vp), (off), (len), (flags), (cred))
 56#define GOP_WRITE(vp, pgs, npages, flags) \
 57	(*VTOG(vp)->g_op->gop_write)((vp), (pgs), (npages), (flags))
 58#define GOP_PUTRANGE(vp, off, lop, hip) \
 59	(*VTOG(vp)->g_op->gop_putrange)((vp), (off), (lop), (hip))
 60
 61/*
 62 * GOP_MARKUPDATE: mark vnode's timestamps for update.
 63 *
 64 * => called with vmobjlock (and possibly other locks) held.
 65 * => used for accesses via mmap.
 66 */
 67
 68#define GOP_MARKUPDATE(vp, flags) \
 69	(VTOG(vp)->g_op->gop_markupdate) ? \
 70	(*VTOG(vp)->g_op->gop_markupdate)((vp), (flags)) : \
 71	(void)0;
 72
 73/* Flags to GOP_SIZE */
 74#define	GOP_SIZE_MEM	0x4	/* in-memory size */
 75
 76/* Flags to GOP_MARKUPDATE */
 77#define	GOP_UPDATE_ACCESSED	1
 78#define	GOP_UPDATE_MODIFIED	2
 79
 80struct genfs_node {
 81	const struct genfs_ops	*g_op;		/* ops vector */
 82	krwlock_t		g_glock;	/* getpages lock */
 83};
 84
 85#define VTOG(vp) ((struct genfs_node *)(vp)->v_data)
 86
 87void	genfs_size(struct vnode *, off_t, off_t *, int);
 88void	genfs_node_init(struct vnode *, const struct genfs_ops *);
 89void	genfs_node_destroy(struct vnode *);
 90void	genfs_gop_putrange(struct vnode *, off_t, off_t *, off_t *);
 91int	genfs_gop_write(struct vnode *, struct vm_page **, int, int);
 92int	genfs_gop_write_rwmap(struct vnode *, struct vm_page **, int, int);
 93int	genfs_compat_gop_write(struct vnode *, struct vm_page **, int, int);
 94void	genfs_directio(struct vnode *, struct uio *, int);
 95
 96void	genfs_node_wrlock(struct vnode *);
 97void	genfs_node_rdlock(struct vnode *);
 98int	genfs_node_rdtrylock(struct vnode *);
 99void	genfs_node_unlock(struct vnode *);
100int	genfs_node_wrlocked(struct vnode *);
101
102#endif	/* _MISCFS_GENFS_GENFS_NODE_H_ */