/*
 * Copyright (c) 2005-2007, Kohsuke Ohtani
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the author nor the names of any co-contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _SYS_VNODE_H
#define _SYS_VNODE_H

#include <sys/types.h>
#include <sys/stat.h>
#include <sys/file.h>
#include <sys/list.h>
#include <sys/dirent.h>
#include <sys/syslimits.h>

struct vfsops;
struct vnops;
struct vnode;
struct file;

/*
 * Vnode types.
 */
enum {
	VNON,	    /* no type */
	VREG,	    /* regular file  */
	VDIR,	    /* directory */
	VBLK,	    /* block device */
	VCHR,	    /* character device */
	VLNK,	    /* symbolic link */
	VSOCK,	    /* socks */
	VFIFO	    /* FIFO */
};

/*
 * Reading or writing any of these items requires holding the
 * appropriate lock.
 */
struct vnode {
	struct list	v_link;		/* link for hash list */
	struct mount	*v_mount;	/* mounted vfs pointer */
	struct vnops	*v_op;		/* vnode operations */
	int		v_refcnt;	/* reference count */
	int		v_type;		/* vnode type */
	int		v_flags;	/* vnode flag */
	mode_t		v_mode;		/* file mode */
	size_t		v_size;		/* file size */
	mutex_t		v_lock;		/* lock for this vnode */
	int		v_nrlocks;	/* lock count (for debug) */
	int		v_blkno;	/* block number */
	char		*v_path;	/* pointer to path in fs */
	void		*v_data;	/* private data for fs */
};
typedef struct vnode *vnode_t;

/* flags for vnode */
#define VROOT		0x0001		/* root of its file system */

/*
 * Vnode attribute
 */
struct vattr {
	int		va_type;	/* vnode type */
	mode_t		va_mode;	/* file access mode */
};

/*
 * Modes
 */
#define VREAD		0x0004
#define VWRITE		0x0002
#define VEXEC		0x0001

/*
 * vnode operations
 */
struct vnops {
	int (*vop_open)		(vnode_t vp, int flags);
	int (*vop_close)	(vnode_t vp, file_t fp);
	int (*vop_read)		(vnode_t vp, file_t fp, void *buf, size_t size, size_t *result);
	int (*vop_write)	(vnode_t vp, file_t fp, void *buf, size_t size, size_t *result);
	int (*vop_seek)		(vnode_t vp, file_t fp, off_t oldoff, off_t newoff);
	int (*vop_ioctl)	(vnode_t vp, file_t fp, u_long cmd, void *arg);
	int (*vop_fsync)	(vnode_t vp, file_t fp);
	int (*vop_readdir)	(vnode_t vp, file_t fp, struct dirent *dirent);
	int (*vop_lookup)	(vnode_t dvp, char *name, vnode_t vp);
	int (*vop_create)	(vnode_t dvp, char *name, mode_t mode);
	int (*vop_remove)	(vnode_t dvp, vnode_t vp, char *name);
	int (*vop_rename)	(vnode_t dvp1, vnode_t vp1, char *name1, vnode_t dvp2, vnode_t vp2, char *name2);
	int (*vop_mkdir)	(vnode_t dvp, char *name, mode_t mode);
	int (*vop_rmdir)	(vnode_t dvp, vnode_t vp, char *name);
	int (*vop_getattr)	(vnode_t vp, struct vattr *vap);
	int (*vop_setattr)	(vnode_t vp, struct vattr *vap);
	int (*vop_inactive)	(vnode_t vp);
	int (*vop_truncate)	(vnode_t vp);
};

typedef	int (*vnop_open_t)	(vnode_t, int);
typedef	int (*vnop_close_t)	(vnode_t, file_t);
typedef	int (*vnop_read_t)	(vnode_t, file_t, void *, size_t, size_t *);
typedef	int (*vnop_write_t)	(vnode_t, file_t, void *, size_t, size_t *);
typedef	int (*vnop_seek_t)	(vnode_t, file_t, off_t, off_t);
typedef	int (*vnop_ioctl_t)	(vnode_t, file_t, u_long, void *);
typedef	int (*vnop_fsync_t)	(vnode_t, file_t);
typedef	int (*vnop_readdir_t)	(vnode_t, file_t, struct dirent *);
typedef	int (*vnop_lookup_t)	(vnode_t, char *, vnode_t);
typedef	int (*vnop_create_t)	(vnode_t, char *, mode_t);
typedef	int (*vnop_remove_t)	(vnode_t, vnode_t, char *);
typedef	int (*vnop_rename_t)	(vnode_t, vnode_t, char *, vnode_t, vnode_t, char *);
typedef	int (*vnop_mkdir_t)	(vnode_t, char *, mode_t);
typedef	int (*vnop_rmdir_t)	(vnode_t, vnode_t, char *);
typedef	int (*vnop_getattr_t)	(vnode_t, struct vattr *);
typedef	int (*vnop_setattr_t)	(vnode_t, struct vattr *);
typedef	int (*vnop_inactive_t)	(vnode_t);
typedef	int (*vnop_truncate_t)	(vnode_t);

/*
 * vnode interface
 */
#define VOP_OPEN(VP, F)		   ((VP)->v_op->vop_open)(VP, F)
#define VOP_CLOSE(VP, FP)	   ((VP)->v_op->vop_close)(VP, FP)
#define VOP_READ(VP, FP, B, S, C)  ((VP)->v_op->vop_read)(VP, FP, B, S, C)
#define VOP_WRITE(VP, FP, B, S, C) ((VP)->v_op->vop_write)(VP, FP, B, S, C)
#define VOP_SEEK(VP, FP, OLD, NEW) ((VP)->v_op->vop_seek)(VP, FP, OLD, NEW)
#define VOP_IOCTL(VP, FP, C, A)	   ((VP)->v_op->vop_ioctl)(VP, FP, C, A)
#define VOP_FSYNC(VP, FP)	   ((VP)->v_op->vop_fsync)(VP, FP)
#define VOP_READDIR(VP, FP, DIR)   ((VP)->v_op->vop_readdir)(VP, FP, DIR)
#define VOP_LOOKUP(DVP, N, VP)	   ((DVP)->v_op->vop_lookup)(DVP, N, VP)
#define VOP_CREATE(DVP, N, M)	   ((DVP)->v_op->vop_create)(DVP, N, M)
#define VOP_REMOVE(DVP, VP, N)	   ((DVP)->v_op->vop_remove)(DVP, VP, N)
#define VOP_RENAME(DVP1, VP1, N1, DVP2, VP2, N2) \
			   ((DVP1)->v_op->vop_rename)(DVP1, VP1, N1, DVP2, VP2, N2)
#define VOP_MKDIR(DVP, N, M)	   ((DVP)->v_op->vop_mkdir)(DVP, N, M)
#define VOP_RMDIR(DVP, VP, N)	   ((DVP)->v_op->vop_rmdir)(DVP, VP, N)
#define VOP_GETATTR(VP, VAP)	   ((VP)->v_op->vop_getattr)(VP, VAP)
#define VOP_SETATTR(VP, VAP)	   ((VP)->v_op->vop_setattr)(VP, VAP)
#define VOP_INACTIVE(VP)	   ((VP)->v_op->vop_inactive)(VP)
#define VOP_TRUNCATE(VP)	   ((VP)->v_op->vop_truncate)(VP)

__BEGIN_DECLS
int	 vop_nullop(void);
int	 vop_einval(void);

vnode_t	 vn_lookup(struct mount *mp, char *path);
void	 vn_lock(vnode_t vp);
void	 vn_unlock(vnode_t vp);
int	 vn_stat(vnode_t vp, struct stat *st);
vnode_t	 vget(struct mount *mp, char *path);
void	 vput(vnode_t vp);
void	 vgone(vnode_t vp);
void	 vref(vnode_t vp);
void	 vrele(vnode_t vp);
int	 vcount(vnode_t vp);
void	 vflush(struct mount *mp);
__END_DECLS

#endif /* !_SYS_VNODE_H */