2005-04-16 16:20:36 -06:00
|
|
|
/*
|
|
|
|
* linux/include/linux/nfs_page.h
|
|
|
|
*
|
|
|
|
* Copyright (C) 2000 Trond Myklebust
|
|
|
|
*
|
|
|
|
* NFS page cache wrapper.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _LINUX_NFS_PAGE_H
|
|
|
|
#define _LINUX_NFS_PAGE_H
|
|
|
|
|
|
|
|
|
|
|
|
#include <linux/list.h>
|
|
|
|
#include <linux/pagemap.h>
|
|
|
|
#include <linux/wait.h>
|
|
|
|
#include <linux/sunrpc/auth.h>
|
|
|
|
#include <linux/nfs_xdr.h>
|
|
|
|
|
2007-06-17 11:26:38 -06:00
|
|
|
#include <linux/kref.h>
|
2005-04-16 16:20:36 -06:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Valid flags for a dirty buffer
|
|
|
|
*/
|
2008-06-13 11:25:22 -06:00
|
|
|
enum {
|
2014-05-15 09:56:41 -06:00
|
|
|
PG_BUSY = 0, /* nfs_{un}lock_request */
|
|
|
|
PG_MAPPED, /* page private set for buffered io */
|
|
|
|
PG_CLEAN, /* write succeeded */
|
|
|
|
PG_COMMIT_TO_DS, /* used by pnfs layouts */
|
2014-07-17 18:42:16 -06:00
|
|
|
PG_INODE_REF, /* extra ref held by inode when in writeback */
|
2014-05-15 09:56:45 -06:00
|
|
|
PG_HEADLOCK, /* page group lock of wb_head */
|
|
|
|
PG_TEARDOWN, /* page group sync for destroy */
|
2014-05-15 09:56:46 -06:00
|
|
|
PG_UNLOCKPAGE, /* page group sync bit in read path */
|
|
|
|
PG_UPTODATE, /* page group sync bit in read path */
|
2014-05-15 09:56:47 -06:00
|
|
|
PG_WB_END, /* page group sync bit in write path */
|
|
|
|
PG_REMOVE, /* page group sync bit in write path */
|
2017-07-11 15:53:48 -06:00
|
|
|
PG_CONTENDED1, /* Is someone waiting for a lock? */
|
|
|
|
PG_CONTENDED2, /* Is someone waiting for a lock? */
|
2008-06-13 11:25:22 -06:00
|
|
|
};
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-06-22 11:16:31 -06:00
|
|
|
struct nfs_inode;
|
2005-04-16 16:20:36 -06:00
|
|
|
struct nfs_page {
|
2012-03-08 15:29:35 -07:00
|
|
|
struct list_head wb_list; /* Defines state of page: */
|
2005-04-16 16:20:36 -06:00
|
|
|
struct page *wb_page; /* page to read in/write out */
|
|
|
|
struct nfs_open_context *wb_context; /* File state context info */
|
2010-06-25 14:35:53 -06:00
|
|
|
struct nfs_lock_context *wb_lock_context; /* lock context info */
|
2016-04-01 06:29:48 -06:00
|
|
|
pgoff_t wb_index; /* Offset >> PAGE_SHIFT */
|
|
|
|
unsigned int wb_offset, /* Offset & ~PAGE_MASK */
|
2005-04-16 16:20:36 -06:00
|
|
|
wb_pgbase, /* Start of page data */
|
|
|
|
wb_bytes; /* Length of request */
|
2007-06-17 11:26:38 -06:00
|
|
|
struct kref wb_kref; /* reference count */
|
2005-04-16 16:20:36 -06:00
|
|
|
unsigned long wb_flags;
|
2012-06-08 09:56:09 -06:00
|
|
|
struct nfs_write_verifier wb_verf; /* Commit cookie */
|
2014-05-15 09:56:45 -06:00
|
|
|
struct nfs_page *wb_this_page; /* list of reqs for this page */
|
|
|
|
struct nfs_page *wb_head; /* head pointer for req list */
|
2005-04-16 16:20:36 -06:00
|
|
|
};
|
|
|
|
|
2011-06-10 11:30:23 -06:00
|
|
|
struct nfs_pageio_descriptor;
|
|
|
|
struct nfs_pageio_ops {
|
2011-06-10 11:30:23 -06:00
|
|
|
void (*pg_init)(struct nfs_pageio_descriptor *, struct nfs_page *);
|
2014-05-15 09:56:43 -06:00
|
|
|
size_t (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *,
|
|
|
|
struct nfs_page *);
|
2011-06-10 11:30:23 -06:00
|
|
|
int (*pg_doio)(struct nfs_pageio_descriptor *);
|
2014-09-19 08:55:07 -06:00
|
|
|
unsigned int (*pg_get_mirror_count)(struct nfs_pageio_descriptor *,
|
|
|
|
struct nfs_page *);
|
2014-09-10 13:44:18 -06:00
|
|
|
void (*pg_cleanup)(struct nfs_pageio_descriptor *);
|
2011-06-10 11:30:23 -06:00
|
|
|
};
|
|
|
|
|
2014-05-06 07:12:30 -06:00
|
|
|
struct nfs_rw_ops {
|
2014-06-09 09:48:33 -06:00
|
|
|
struct nfs_pgio_header *(*rw_alloc_header)(void);
|
|
|
|
void (*rw_free_header)(struct nfs_pgio_header *);
|
2014-06-09 09:48:35 -06:00
|
|
|
int (*rw_done)(struct rpc_task *, struct nfs_pgio_header *,
|
|
|
|
struct inode *);
|
|
|
|
void (*rw_result)(struct rpc_task *, struct nfs_pgio_header *);
|
|
|
|
void (*rw_initiate)(struct nfs_pgio_header *, struct rpc_message *,
|
2014-06-09 14:12:20 -06:00
|
|
|
const struct nfs_rpc_ops *,
|
2014-05-06 07:12:37 -06:00
|
|
|
struct rpc_task_setup *, int);
|
2014-05-06 07:12:30 -06:00
|
|
|
};
|
|
|
|
|
2014-09-19 08:55:07 -06:00
|
|
|
struct nfs_pgio_mirror {
|
2007-04-02 16:48:28 -06:00
|
|
|
struct list_head pg_list;
|
2007-04-02 16:48:28 -06:00
|
|
|
unsigned long pg_bytes_written;
|
2007-04-02 16:48:28 -06:00
|
|
|
size_t pg_count;
|
|
|
|
size_t pg_bsize;
|
|
|
|
unsigned int pg_base;
|
2014-09-19 08:55:07 -06:00
|
|
|
unsigned char pg_recoalesce : 1;
|
|
|
|
};
|
2007-04-02 16:48:28 -06:00
|
|
|
|
2014-09-19 08:55:07 -06:00
|
|
|
struct nfs_pageio_descriptor {
|
|
|
|
unsigned char pg_moreio : 1;
|
2007-04-02 16:48:28 -06:00
|
|
|
struct inode *pg_inode;
|
2011-06-10 11:30:23 -06:00
|
|
|
const struct nfs_pageio_ops *pg_ops;
|
2014-05-06 07:12:30 -06:00
|
|
|
const struct nfs_rw_ops *pg_rw_ops;
|
2007-04-02 16:48:28 -06:00
|
|
|
int pg_ioflags;
|
|
|
|
int pg_error;
|
2011-07-12 11:42:02 -06:00
|
|
|
const struct rpc_call_ops *pg_rpc_callops;
|
2012-04-20 12:47:48 -06:00
|
|
|
const struct nfs_pgio_completion_ops *pg_completion_ops;
|
2011-02-28 18:34:14 -07:00
|
|
|
struct pnfs_layout_segment *pg_lseg;
|
2017-06-20 17:35:37 -06:00
|
|
|
struct nfs_io_completion *pg_io_completion;
|
2012-04-20 12:47:51 -06:00
|
|
|
struct nfs_direct_req *pg_dreq;
|
2014-09-19 08:55:07 -06:00
|
|
|
unsigned int pg_bsize; /* default bsize for mirrors */
|
|
|
|
|
|
|
|
u32 pg_mirror_count;
|
|
|
|
struct nfs_pgio_mirror *pg_mirrors;
|
|
|
|
struct nfs_pgio_mirror pg_mirrors_static[1];
|
|
|
|
struct nfs_pgio_mirror *pg_mirrors_dynamic;
|
|
|
|
u32 pg_mirror_idx; /* current mirror */
|
2007-04-02 16:48:28 -06:00
|
|
|
};
|
|
|
|
|
2014-09-19 08:55:07 -06:00
|
|
|
/* arbitrarily selected limit to number of mirrors */
|
|
|
|
#define NFS_PAGEIO_DESCRIPTOR_MIRROR_MAX 16
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
#define NFS_WBACK_BUSY(req) (test_bit(PG_BUSY,&(req)->wb_flags))
|
|
|
|
|
|
|
|
extern struct nfs_page *nfs_create_request(struct nfs_open_context *ctx,
|
|
|
|
struct page *page,
|
2014-05-15 09:56:45 -06:00
|
|
|
struct nfs_page *last,
|
2005-04-16 16:20:36 -06:00
|
|
|
unsigned int offset,
|
|
|
|
unsigned int count);
|
2014-05-15 09:56:45 -06:00
|
|
|
extern void nfs_release_request(struct nfs_page *);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
|
|
|
|
2007-04-02 16:48:28 -06:00
|
|
|
extern void nfs_pageio_init(struct nfs_pageio_descriptor *desc,
|
|
|
|
struct inode *inode,
|
2011-06-10 11:30:23 -06:00
|
|
|
const struct nfs_pageio_ops *pg_ops,
|
2012-04-20 12:47:48 -06:00
|
|
|
const struct nfs_pgio_completion_ops *compl_ops,
|
2014-05-06 07:12:30 -06:00
|
|
|
const struct nfs_rw_ops *rw_ops,
|
2007-04-02 16:48:28 -06:00
|
|
|
size_t bsize,
|
2017-08-20 09:33:25 -06:00
|
|
|
int how);
|
2007-04-02 16:48:28 -06:00
|
|
|
extern int nfs_pageio_add_request(struct nfs_pageio_descriptor *,
|
|
|
|
struct nfs_page *);
|
2014-06-09 09:48:38 -06:00
|
|
|
extern int nfs_pageio_resend(struct nfs_pageio_descriptor *,
|
|
|
|
struct nfs_pgio_header *);
|
2007-04-02 16:48:28 -06:00
|
|
|
extern void nfs_pageio_complete(struct nfs_pageio_descriptor *desc);
|
2007-05-20 08:18:27 -06:00
|
|
|
extern void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t);
|
2014-05-15 09:56:43 -06:00
|
|
|
extern size_t nfs_generic_pg_test(struct nfs_pageio_descriptor *desc,
|
2011-06-19 16:33:46 -06:00
|
|
|
struct nfs_page *prev,
|
|
|
|
struct nfs_page *req);
|
2005-04-16 16:20:36 -06:00
|
|
|
extern int nfs_wait_on_request(struct nfs_page *);
|
|
|
|
extern void nfs_unlock_request(struct nfs_page *req);
|
2014-05-15 09:56:45 -06:00
|
|
|
extern void nfs_unlock_and_release_request(struct nfs_page *);
|
2017-07-17 08:54:14 -06:00
|
|
|
extern int nfs_page_group_lock(struct nfs_page *);
|
2014-05-15 09:56:45 -06:00
|
|
|
extern void nfs_page_group_unlock(struct nfs_page *);
|
|
|
|
extern bool nfs_page_group_sync_on_bit(struct nfs_page *, unsigned int);
|
2017-04-11 10:50:10 -06:00
|
|
|
extern bool nfs_async_iocounter_wait(struct rpc_task *, struct nfs_lock_context *);
|
2005-06-22 11:16:30 -06:00
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
/*
|
2012-05-09 11:19:15 -06:00
|
|
|
* Lock the page of an asynchronous request
|
2005-04-16 16:20:36 -06:00
|
|
|
*/
|
2012-03-15 15:16:40 -06:00
|
|
|
static inline int
|
|
|
|
nfs_lock_request(struct nfs_page *req)
|
|
|
|
{
|
2012-05-09 11:19:15 -06:00
|
|
|
return !test_and_set_bit(PG_BUSY, &req->wb_flags);
|
2012-03-15 15:16:40 -06:00
|
|
|
}
|
|
|
|
|
2005-06-22 11:16:31 -06:00
|
|
|
/**
|
|
|
|
* nfs_list_add_request - Insert a request into a list
|
|
|
|
* @req: request
|
|
|
|
* @head: head of list into which to insert the request.
|
|
|
|
*/
|
|
|
|
static inline void
|
|
|
|
nfs_list_add_request(struct nfs_page *req, struct list_head *head)
|
|
|
|
{
|
|
|
|
list_add_tail(&req->wb_list, head);
|
|
|
|
}
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
|
|
|
|
/**
|
|
|
|
* nfs_list_remove_request - Remove a request from its wb_list
|
|
|
|
* @req: request
|
|
|
|
*/
|
|
|
|
static inline void
|
|
|
|
nfs_list_remove_request(struct nfs_page *req)
|
|
|
|
{
|
|
|
|
if (list_empty(&req->wb_list))
|
|
|
|
return;
|
|
|
|
list_del_init(&req->wb_list);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline struct nfs_page *
|
|
|
|
nfs_list_entry(struct list_head *head)
|
|
|
|
{
|
|
|
|
return list_entry(head, struct nfs_page, wb_list);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline
|
|
|
|
loff_t req_offset(struct nfs_page *req)
|
|
|
|
{
|
mm, fs: get rid of PAGE_CACHE_* and page_cache_{get,release} macros
PAGE_CACHE_{SIZE,SHIFT,MASK,ALIGN} macros were introduced *long* time
ago with promise that one day it will be possible to implement page
cache with bigger chunks than PAGE_SIZE.
This promise never materialized. And unlikely will.
We have many places where PAGE_CACHE_SIZE assumed to be equal to
PAGE_SIZE. And it's constant source of confusion on whether
PAGE_CACHE_* or PAGE_* constant should be used in a particular case,
especially on the border between fs and mm.
Global switching to PAGE_CACHE_SIZE != PAGE_SIZE would cause to much
breakage to be doable.
Let's stop pretending that pages in page cache are special. They are
not.
The changes are pretty straight-forward:
- <foo> << (PAGE_CACHE_SHIFT - PAGE_SHIFT) -> <foo>;
- <foo> >> (PAGE_CACHE_SHIFT - PAGE_SHIFT) -> <foo>;
- PAGE_CACHE_{SIZE,SHIFT,MASK,ALIGN} -> PAGE_{SIZE,SHIFT,MASK,ALIGN};
- page_cache_get() -> get_page();
- page_cache_release() -> put_page();
This patch contains automated changes generated with coccinelle using
script below. For some reason, coccinelle doesn't patch header files.
I've called spatch for them manually.
The only adjustment after coccinelle is revert of changes to
PAGE_CAHCE_ALIGN definition: we are going to drop it later.
There are few places in the code where coccinelle didn't reach. I'll
fix them manually in a separate patch. Comments and documentation also
will be addressed with the separate patch.
virtual patch
@@
expression E;
@@
- E << (PAGE_CACHE_SHIFT - PAGE_SHIFT)
+ E
@@
expression E;
@@
- E >> (PAGE_CACHE_SHIFT - PAGE_SHIFT)
+ E
@@
@@
- PAGE_CACHE_SHIFT
+ PAGE_SHIFT
@@
@@
- PAGE_CACHE_SIZE
+ PAGE_SIZE
@@
@@
- PAGE_CACHE_MASK
+ PAGE_MASK
@@
expression E;
@@
- PAGE_CACHE_ALIGN(E)
+ PAGE_ALIGN(E)
@@
expression E;
@@
- page_cache_get(E)
+ get_page(E)
@@
expression E;
@@
- page_cache_release(E)
+ put_page(E)
Signed-off-by: Kirill A. Shutemov <kirill.shutemov@linux.intel.com>
Acked-by: Michal Hocko <mhocko@suse.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2016-04-01 06:29:47 -06:00
|
|
|
return (((loff_t)req->wb_index) << PAGE_SHIFT) + req->wb_offset;
|
2005-04-16 16:20:36 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
#endif /* _LINUX_NFS_PAGE_H */
|