284 lines
8.9 KiB
C
284 lines
8.9 KiB
C
/* $NetBSD: nfsnode.h,v 1.76 2021/10/21 13:21:55 andvar Exp $ */
|
|
|
|
/*
|
|
* Copyright (c) 1989, 1993
|
|
* The Regents of the University of California. All rights reserved.
|
|
*
|
|
* This code is derived from software contributed to Berkeley by
|
|
* Rick Macklem at The University of Guelph.
|
|
*
|
|
* 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 University nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
|
|
*
|
|
* @(#)nfsnode.h 8.9 (Berkeley) 5/14/95
|
|
*/
|
|
|
|
|
|
#ifndef _NFS_NFSNODE_H_
|
|
#define _NFS_NFSNODE_H_
|
|
|
|
#include <sys/condvar.h>
|
|
#include <sys/mutex.h>
|
|
|
|
#ifndef _NFS_NFS_H_
|
|
#include <nfs/nfs.h>
|
|
#endif
|
|
#include <miscfs/genfs/genfs.h>
|
|
#include <miscfs/genfs/genfs_node.h>
|
|
|
|
/*
|
|
* Definitions for the directory cache. Because directory cookies
|
|
* are an opaque 64 bit entity, we need to provide some sort of
|
|
* mapping between cookies and logical blocknumbers. Also,
|
|
* we should store the cookies from the server somewhere,
|
|
* to be able to satisfy VOP_READDIR requests for cookies.
|
|
* We can't store the cookies in the dirent structure, as some
|
|
* other systems.
|
|
*
|
|
* Each offset is hashed into a per-nfsnode hashtable. An entry
|
|
* found therein contains information about the (faked up)
|
|
* logical blocknumber, and also a pointer to a buffer where
|
|
* the cookies are stored.
|
|
*/
|
|
|
|
|
|
LIST_HEAD(nfsdirhashhead, nfsdircache);
|
|
TAILQ_HEAD(nfsdirchainhead, nfsdircache);
|
|
|
|
struct nfsdircache {
|
|
off_t dc_cookie; /* Own offset (key) */
|
|
off_t dc_blkcookie; /* Offset of block we're in */
|
|
LIST_ENTRY(nfsdircache) dc_hash; /* Hash chain */
|
|
TAILQ_ENTRY(nfsdircache) dc_chain; /* Least recently entered chn */
|
|
u_int32_t dc_cookie32; /* Key for 64<->32 xlate case */
|
|
int dc_entry; /* Entry number within block */
|
|
int dc_refcnt; /* Reference count */
|
|
int dc_flags; /* NFSDC_ flags */
|
|
};
|
|
|
|
#define NFSDC_INVALID 1
|
|
|
|
/*
|
|
* NFSDC_BLKNO: get buffer cache index
|
|
*/
|
|
#define NFSDC_BLKNO(ndp) ((daddr_t)(ndp)->dc_blkcookie)
|
|
|
|
/*
|
|
* The nfsnode is the nfs equivalent to ufs's inode. Any similarity
|
|
* is purely coincidental.
|
|
* There is a unique nfsnode allocated for each active file,
|
|
* each current directory, each mounted-on file, text file, and the root.
|
|
* An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
|
|
*/
|
|
|
|
struct nfsnode_spec {
|
|
struct timespec nspec_mtim; /* local mtime */
|
|
struct timespec nspec_atim; /* local atime */
|
|
};
|
|
|
|
struct nfsnode_reg {
|
|
off_t nreg_pushedlo; /* 1st blk in committed range */
|
|
off_t nreg_pushedhi; /* Last block in range */
|
|
off_t nreg_pushlo; /* 1st block in commit range */
|
|
off_t nreg_pushhi; /* Last block in range */
|
|
kmutex_t nreg_commitlock; /* Serialize commits XXX */
|
|
int nreg_commitflags;
|
|
int nreg_error; /* Save write error value */
|
|
};
|
|
|
|
struct nfsnode_dir {
|
|
off_t ndir_direof; /* EOF offset cache */
|
|
nfsuint64 ndir_cookieverf; /* Cookie verifier */
|
|
struct nfsdirhashhead *ndir_dircache; /* offset -> cache hash heads */
|
|
struct nfsdirchainhead ndir_dirchain; /* Chain of dir cookies */
|
|
struct timespec ndir_nctime; /* Last name cache entry */
|
|
unsigned ndir_dircachesize; /* Size of dir cookie cache */
|
|
};
|
|
|
|
struct nfsnode {
|
|
struct genfs_node n_gnode;
|
|
u_quad_t n_size; /* Current size of file */
|
|
|
|
union {
|
|
struct nfsnode_spec nu_spec;
|
|
struct nfsnode_reg nu_reg;
|
|
struct nfsnode_dir nu_dir;
|
|
} n_un1;
|
|
|
|
#define n_mtim n_un1.nu_spec.nspec_mtim
|
|
#define n_atim n_un1.nu_spec.nspec_atim
|
|
|
|
#define n_pushedlo n_un1.nu_reg.nreg_pushedlo
|
|
#define n_pushedhi n_un1.nu_reg.nreg_pushedhi
|
|
#define n_pushlo n_un1.nu_reg.nreg_pushlo
|
|
#define n_pushhi n_un1.nu_reg.nreg_pushhi
|
|
#define n_commitlock n_un1.nu_reg.nreg_commitlock
|
|
#define n_commitflags n_un1.nu_reg.nreg_commitflags
|
|
#define n_error n_un1.nu_reg.nreg_error
|
|
|
|
#define n_direofoffset n_un1.nu_dir.ndir_direof
|
|
#define n_cookieverf n_un1.nu_dir.ndir_cookieverf
|
|
#define n_dircache n_un1.nu_dir.ndir_dircache
|
|
#define n_dirchain n_un1.nu_dir.ndir_dirchain
|
|
#define n_nctime n_un1.nu_dir.ndir_nctime
|
|
#define n_dircachesize n_un1.nu_dir.ndir_dircachesize
|
|
|
|
union {
|
|
struct sillyrename *nf_silly; /* !VDIR: silly rename struct */
|
|
unsigned *ndir_dirgens; /* 32<->64bit xlate gen. no. */
|
|
} n_un2;
|
|
|
|
#define n_sillyrename n_un2.nf_silly
|
|
#define n_dirgens n_un2.ndir_dirgens
|
|
|
|
nfsfh_t *n_fhp; /* NFS File Handle */
|
|
struct vattr *n_vattr; /* Vnode attribute cache */
|
|
struct vnode *n_vnode; /* associated vnode */
|
|
struct lockf *n_lockf; /* Locking record of file */
|
|
time_t n_attrstamp; /* Attr. cache timestamp */
|
|
struct timespec n_mtime; /* Prev modify time. */
|
|
time_t n_ctime; /* Prev create time. */
|
|
short n_fhsize; /* size in bytes, of fh */
|
|
short n_flag; /* Flag for locking.. */
|
|
nfsfh_t n_fh; /* Small File Handle */
|
|
time_t n_accstamp; /* Access cache timestamp */
|
|
uid_t n_accuid; /* Last access requester */
|
|
int n_accmode; /* Mode last requested */
|
|
int n_accerror; /* Error last returned */
|
|
kauth_cred_t n_rcred;
|
|
kauth_cred_t n_wcred;
|
|
};
|
|
|
|
/*
|
|
* Values for n_commitflags
|
|
*/
|
|
#define NFS_COMMIT_PUSH_VALID 0x0001 /* push range valid */
|
|
#define NFS_COMMIT_PUSHED_VALID 0x0002 /* pushed range valid */
|
|
|
|
/*
|
|
* Flags for n_flag
|
|
*/
|
|
#define NFLUSHWANT 0x0001 /* Want wakeup from a flush in prog. */
|
|
#define NFLUSHINPROG 0x0002 /* Avoid multiple calls to vinvalbuf() */
|
|
#define NMODIFIED 0x0004 /* Might have a modified buffer in bio */
|
|
#define NWRITEERR 0x0008 /* Flag write errors so close will know */
|
|
#define NACC 0x0100 /* Special file accessed */
|
|
#define NUPD 0x0200 /* Special file updated */
|
|
#define NCHG 0x0400 /* Special file times changed */
|
|
#define NTRUNCDELAYED 0x1000 /* Should be truncated later;
|
|
implies stale cache */
|
|
#define NREMOVED 0x2000 /* Has been removed */
|
|
#define NUSEOPENCRED 0x4000 /* Try open cred first rather than owner's */
|
|
#define NEOFVALID 0x8000 /* dir: n_direofoffset is valid */
|
|
|
|
#define NFS_EOFVALID(ndp) ((ndp)->n_flag & NEOFVALID)
|
|
|
|
/*
|
|
* Convert between nfsnode pointers and vnode pointers
|
|
*/
|
|
#define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
|
|
#define NFSTOV(np) ((np)->n_vnode)
|
|
|
|
#ifdef _KERNEL
|
|
|
|
#include <sys/workqueue.h>
|
|
/*
|
|
* Silly rename structure that hangs off the nfsnode until the name
|
|
* can be removed by nfs_inactive()
|
|
*/
|
|
struct sillyrename {
|
|
struct work s_work;
|
|
kauth_cred_t s_cred;
|
|
struct vnode *s_dvp;
|
|
long s_namlen;
|
|
char s_name[20];
|
|
};
|
|
|
|
/*
|
|
* Per-nfsiod datas
|
|
*/
|
|
struct nfs_iod {
|
|
kmutex_t nid_lock;
|
|
kcondvar_t nid_cv;
|
|
LIST_ENTRY(nfs_iod) nid_idle;
|
|
struct nfsmount *nid_mount;
|
|
bool nid_exiting;
|
|
|
|
LIST_ENTRY(nfs_iod) nid_all;
|
|
};
|
|
|
|
LIST_HEAD(nfs_iodlist, nfs_iod);
|
|
extern kmutex_t nfs_iodlist_lock;
|
|
extern struct nfs_iodlist nfs_iodlist_idle;
|
|
extern struct nfs_iodlist nfs_iodlist_all;
|
|
extern u_long nfsdirhashmask;
|
|
|
|
/*
|
|
* Prototypes for NFS vnode operations
|
|
*/
|
|
int nfs_lookup(void *);
|
|
int nfs_create(void *);
|
|
int nfs_mknod(void *);
|
|
int nfs_open(void *);
|
|
int nfs_close(void *);
|
|
int nfsspec_close(void *);
|
|
int nfsfifo_close(void *);
|
|
int nfs_access(void *);
|
|
int nfsspec_access(void *);
|
|
int nfs_getattr(void *);
|
|
int nfs_setattr(void *);
|
|
int nfs_read(void *);
|
|
int nfs_write(void *);
|
|
int nfsspec_read(void *);
|
|
int nfsspec_write(void *);
|
|
int nfsfifo_read(void *);
|
|
int nfsfifo_write(void *);
|
|
int nfs_fsync(void *);
|
|
int nfs_remove(void *);
|
|
int nfs_link(void *);
|
|
int nfs_rename(void *);
|
|
int nfs_mkdir(void *);
|
|
int nfs_rmdir(void *);
|
|
int nfs_symlink(void *);
|
|
int nfs_readdir(void *);
|
|
int nfs_readlink(void *);
|
|
int nfs_inactive(void *);
|
|
int nfs_reclaim(void *);
|
|
int nfs_unlock(void *);
|
|
int nfs_bmap(void *);
|
|
int nfs_strategy(void *);
|
|
int nfs_print(void *);
|
|
int nfs_pathconf(void *);
|
|
int nfs_advlock(void *);
|
|
int nfs_getpages(void *);
|
|
int nfs_kqfilter(void *);
|
|
|
|
extern int (**nfsv2_vnodeop_p)(void *);
|
|
|
|
#define NFS_INVALIDATE_ATTRCACHE(np) (np)->n_attrstamp = 0
|
|
|
|
#endif /* _KERNEL */
|
|
|
|
#endif
|