[linux-block.git] / fs / nfsd / filecache.h

#ifndef _FS_NFSD_FILECACHE_H
#define _FS_NFSD_FILECACHE_H

#include <linux/fsnotify_backend.h>

/*
 * This is the fsnotify_mark container that nfsd attaches to the files that it
 * is holding open. Note that we have a separate refcount here aside from the
 * one in the fsnotify_mark. We only want a single fsnotify_mark attached to
 * the inode, and for each nfsd_file to hold a reference to it.
 *
 * The fsnotify_mark is itself refcounted, but that's not sufficient to tell us
 * how to put that reference. If there are still outstanding nfsd_files that
 * reference the mark, then we would want to call fsnotify_put_mark on it.
 * If there were not, then we'd need to call fsnotify_destroy_mark. Since we
 * can't really tell the difference, we use the nfm_mark to keep track of how
 * many nfsd_files hold references to the mark. When that counter goes to zero
 * then we know to call fsnotify_destroy_mark on it.
 */
struct nfsd_file_mark {
	struct fsnotify_mark	nfm_mark;
	refcount_t		nfm_ref;
};

/*
 * A representation of a file that has been opened by knfsd. These are hashed
 * in the hashtable by inode pointer value. Note that this object doesn't
 * hold a reference to the inode by itself, so the nf_inode pointer should
 * never be dereferenced, only used for comparison.
 */
struct nfsd_file {
	struct rhlist_head	nf_rlist;
	void			*nf_inode;
	struct file		*nf_file;
	const struct cred	*nf_cred;
	struct net		*nf_net;
#define NFSD_FILE_HASHED	(0)
#define NFSD_FILE_PENDING	(1)
#define NFSD_FILE_REFERENCED	(2)
#define NFSD_FILE_GC		(3)
	unsigned long		nf_flags;
	refcount_t		nf_ref;
	unsigned char		nf_may;

	struct nfsd_file_mark	*nf_mark;
	struct list_head	nf_lru;
	struct rcu_head		nf_rcu;
	ktime_t			nf_birthtime;
};

int nfsd_file_cache_init(void);
void nfsd_file_cache_purge(struct net *);
void nfsd_file_cache_shutdown(void);
int nfsd_file_cache_start_net(struct net *net);
void nfsd_file_cache_shutdown_net(struct net *net);
void nfsd_file_put(struct nfsd_file *nf);
struct nfsd_file *nfsd_file_get(struct nfsd_file *nf);
void nfsd_file_close_inode_sync(struct inode *inode);
bool nfsd_file_is_cached(struct inode *inode);
__be32 nfsd_file_acquire_gc(struct svc_rqst *rqstp, struct svc_fh *fhp,
		  unsigned int may_flags, struct nfsd_file **nfp);
__be32 nfsd_file_acquire(struct svc_rqst *rqstp, struct svc_fh *fhp,
		  unsigned int may_flags, struct nfsd_file **nfp);
__be32 nfsd_file_acquire_opened(struct svc_rqst *rqstp, struct svc_fh *fhp,
		  unsigned int may_flags, struct file *file,
		  struct nfsd_file **nfp);
int nfsd_file_cache_stats_show(struct seq_file *m, void *v);
#endif /* _FS_NFSD_FILECACHE_H */
Commit	Line	Data
65294c1f JL	1	#ifndef _FS_NFSD_FILECACHE_H
	2	#define _FS_NFSD_FILECACHE_H
	3
	4	#include <linux/fsnotify_backend.h>
	5
	6	/*
	7	* This is the fsnotify_mark container that nfsd attaches to the files that it
	8	* is holding open. Note that we have a separate refcount here aside from the
	9	* one in the fsnotify_mark. We only want a single fsnotify_mark attached to
	10	* the inode, and for each nfsd_file to hold a reference to it.
	11	*
	12	* The fsnotify_mark is itself refcounted, but that's not sufficient to tell us
	13	* how to put that reference. If there are still outstanding nfsd_files that
	14	* reference the mark, then we would want to call fsnotify_put_mark on it.
	15	* If there were not, then we'd need to call fsnotify_destroy_mark. Since we
	16	* can't really tell the difference, we use the nfm_mark to keep track of how
	17	* many nfsd_files hold references to the mark. When that counter goes to zero
	18	* then we know to call fsnotify_destroy_mark on it.
	19	*/
	20	struct nfsd_file_mark {
	21	struct fsnotify_mark nfm_mark;
689827cd	22	refcount_t nfm_ref;
65294c1f JL	23	};
	24
	25	/*
	26	* A representation of a file that has been opened by knfsd. These are hashed
	27	* in the hashtable by inode pointer value. Note that this object doesn't
	28	* hold a reference to the inode by itself, so the nf_inode pointer should
	29	* never be dereferenced, only used for comparison.
	30	*/
	31	struct nfsd_file {
c4c649ab CL	32	struct rhlist_head nf_rlist;
c4c649ab CL	33	void *nf_inode;
65294c1f JL	34	struct file *nf_file;
65294c1f JL	35	const struct cred *nf_cred;
5e113224	36	struct net *nf_net;
65294c1f JL	37	#define NFSD_FILE_HASHED (0)
65294c1f JL	38	#define NFSD_FILE_PENDING (1)
23ba98de	39	#define NFSD_FILE_REFERENCED (2)
4d1ea845	40	#define NFSD_FILE_GC (3)
65294c1f	41	unsigned long nf_flags;
689827cd	42	refcount_t nf_ref;
65294c1f	43	unsigned char nf_may;
c4c649ab	44
65294c1f	45	struct nfsd_file_mark *nf_mark;
c4c649ab CL	46	struct list_head nf_lru;
c4c649ab CL	47	struct rcu_head nf_rcu;
904940e9	48	ktime_t nf_birthtime;
65294c1f JL	49	};
	50
	51	int nfsd_file_cache_init(void);
5e113224	52	void nfsd_file_cache_purge(struct net *);
65294c1f	53	void nfsd_file_cache_shutdown(void);
9542e6a6 TM	54	int nfsd_file_cache_start_net(struct net *net);
9542e6a6 TM	55	void nfsd_file_cache_shutdown_net(struct net *net);
65294c1f JL	56	void nfsd_file_put(struct nfsd_file *nf);
	57	struct nfsd_file nfsd_file_get(struct nfsd_file nf);
	58	void nfsd_file_close_inode_sync(struct inode *inode);
	59	bool nfsd_file_is_cached(struct inode *inode);
4d1ea845 CL	60	__be32 nfsd_file_acquire_gc(struct svc_rqst rqstp, struct svc_fh fhp,
4d1ea845 CL	61	unsigned int may_flags, struct nfsd_file **nfp);
65294c1f JL	62	__be32 nfsd_file_acquire(struct svc_rqst rqstp, struct svc_fh fhp,
65294c1f JL	63	unsigned int may_flags, struct nfsd_file **nfp);
0b3a551f JL	64	__be32 nfsd_file_acquire_opened(struct svc_rqst rqstp, struct svc_fh fhp,
	65	unsigned int may_flags, struct file *file,
	66	struct nfsd_file **nfp);
1342f9dd	67	int nfsd_file_cache_stats_show(struct seq_file m, void v);
65294c1f	68	#endif /* _FS_NFSD_FILECACHE_H */