[deliverable/linux.git] / include / linux / pagemap.h

#ifndef _LINUX_PAGEMAP_H
#define _LINUX_PAGEMAP_H

/*
 * Copyright 1995 Linus Torvalds
 */
#include <linux/mm.h>
#include <linux/fs.h>
#include <linux/list.h>
#include <linux/highmem.h>
#include <linux/compiler.h>
#include <asm/uaccess.h>
#include <linux/gfp.h>

/*
 * Bits in mapping->flags.  The lower __GFP_BITS_SHIFT bits are the page
 * allocation mode flags.
 */
#define	AS_EIO		(__GFP_BITS_SHIFT + 0)	/* IO error on async write */
#define AS_ENOSPC	(__GFP_BITS_SHIFT + 1)	/* ENOSPC on async write */

static inline gfp_t mapping_gfp_mask(struct address_space * mapping)
{
	return (__force gfp_t)mapping->flags & __GFP_BITS_MASK;
}

/*
 * This is non-atomic.  Only to be used before the mapping is activated.
 * Probably needs a barrier...
 */
static inline void mapping_set_gfp_mask(struct address_space *m, gfp_t mask)
{
	m->flags = (m->flags & ~(__force unsigned long)__GFP_BITS_MASK) |
				(__force unsigned long)mask;
}

/*
 * The page cache can done in larger chunks than
 * one page, because it allows for more efficient
 * throughput (it can then be mapped into user
 * space in smaller chunks for same flexibility).
 *
 * Or rather, it _will_ be done in larger chunks.
 */
#define PAGE_CACHE_SHIFT	PAGE_SHIFT
#define PAGE_CACHE_SIZE		PAGE_SIZE
#define PAGE_CACHE_MASK		PAGE_MASK
#define PAGE_CACHE_ALIGN(addr)	(((addr)+PAGE_CACHE_SIZE-1)&PAGE_CACHE_MASK)

#define page_cache_get(page)		get_page(page)
#define page_cache_release(page)	put_page(page)
void release_pages(struct page **pages, int nr, int cold);

#ifdef CONFIG_NUMA
extern struct page *page_cache_alloc(struct address_space *x);
extern struct page *page_cache_alloc_cold(struct address_space *x);
#else
static inline struct page *page_cache_alloc(struct address_space *x)
{
	return alloc_pages(mapping_gfp_mask(x), 0);
}

static inline struct page *page_cache_alloc_cold(struct address_space *x)
{
	return alloc_pages(mapping_gfp_mask(x)|__GFP_COLD, 0);
}
#endif

typedef int filler_t(void *, struct page *);

extern struct page * find_get_page(struct address_space *mapping,
				unsigned long index);
extern struct page * find_lock_page(struct address_space *mapping,
				unsigned long index);
extern __deprecated_for_modules struct page * find_trylock_page(
			struct address_space *mapping, unsigned long index);
extern struct page * find_or_create_page(struct address_space *mapping,
				unsigned long index, gfp_t gfp_mask);
unsigned find_get_pages(struct address_space *mapping, pgoff_t start,
			unsigned int nr_pages, struct page **pages);
unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t start,
			       unsigned int nr_pages, struct page **pages);
unsigned find_get_pages_tag(struct address_space *mapping, pgoff_t *index,
			int tag, unsigned int nr_pages, struct page **pages);

/*
 * Returns locked page at given index in given cache, creating it if needed.
 */
static inline struct page *grab_cache_page(struct address_space *mapping, unsigned long index)
{
	return find_or_create_page(mapping, index, mapping_gfp_mask(mapping));
}

extern struct page * grab_cache_page_nowait(struct address_space *mapping,
				unsigned long index);
extern struct page * read_cache_page(struct address_space *mapping,
				unsigned long index, filler_t *filler,
				void *data);
extern int read_cache_pages(struct address_space *mapping,
		struct list_head *pages, filler_t *filler, void *data);

static inline struct page *read_mapping_page(struct address_space *mapping,
					     unsigned long index, void *data)
{
	filler_t *filler = (filler_t *)mapping->a_ops->readpage;
	return read_cache_page(mapping, index, filler, data);
}

int add_to_page_cache(struct page *page, struct address_space *mapping,
				unsigned long index, gfp_t gfp_mask);
int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
				unsigned long index, gfp_t gfp_mask);
extern void remove_from_page_cache(struct page *page);
extern void __remove_from_page_cache(struct page *page);

/*
 * Return byte-offset into filesystem object for page.
 */
static inline loff_t page_offset(struct page *page)
{
	return ((loff_t)page->index) << PAGE_CACHE_SHIFT;
}

static inline pgoff_t linear_page_index(struct vm_area_struct *vma,
					unsigned long address)
{
	pgoff_t pgoff = (address - vma->vm_start) >> PAGE_SHIFT;
	pgoff += vma->vm_pgoff;
	return pgoff >> (PAGE_CACHE_SHIFT - PAGE_SHIFT);
}

extern void FASTCALL(__lock_page(struct page *page));
extern void FASTCALL(__lock_page_nosync(struct page *page));
extern void FASTCALL(unlock_page(struct page *page));

/*
 * lock_page may only be called if we have the page's inode pinned.
 */
static inline void lock_page(struct page *page)
{
	might_sleep();
	if (TestSetPageLocked(page))
		__lock_page(page);
}

/*
 * lock_page_nosync should only be used if we can't pin the page's inode.
 * Doesn't play quite so well with block device plugging.
 */
static inline void lock_page_nosync(struct page *page)
{
	might_sleep();
	if (TestSetPageLocked(page))
		__lock_page_nosync(page);
}
	
/*
 * This is exported only for wait_on_page_locked/wait_on_page_writeback.
 * Never use this directly!
 */
extern void FASTCALL(wait_on_page_bit(struct page *page, int bit_nr));

/* 
 * Wait for a page to be unlocked.
 *
 * This must be called with the caller "holding" the page,
 * ie with increased "page->count" so that the page won't
 * go away during the wait..
 */
static inline void wait_on_page_locked(struct page *page)
{
	if (PageLocked(page))
		wait_on_page_bit(page, PG_locked);
}

/* 
 * Wait for a page to complete writeback
 */
static inline void wait_on_page_writeback(struct page *page)
{
	if (PageWriteback(page))
		wait_on_page_bit(page, PG_writeback);
}

extern void end_page_writeback(struct page *page);

/*
 * Fault a userspace page into pagetables.  Return non-zero on a fault.
 *
 * This assumes that two userspace pages are always sufficient.  That's
 * not true if PAGE_CACHE_SIZE > PAGE_SIZE.
 */
static inline int fault_in_pages_writeable(char __user *uaddr, int size)
{
	int ret;

	/*
	 * Writing zeroes into userspace here is OK, because we know that if
	 * the zero gets there, we'll be overwriting it.
	 */
	ret = __put_user(0, uaddr);
	if (ret == 0) {
		char __user *end = uaddr + size - 1;

		/*
		 * If the page was already mapped, this will get a cache miss
		 * for sure, so try to avoid doing it.
		 */
		if (((unsigned long)uaddr & PAGE_MASK) !=
				((unsigned long)end & PAGE_MASK))
		 	ret = __put_user(0, end);
	}
	return ret;
}

static inline void fault_in_pages_readable(const char __user *uaddr, int size)
{
	volatile char c;
	int ret;

	ret = __get_user(c, uaddr);
	if (ret == 0) {
		const char __user *end = uaddr + size - 1;

		if (((unsigned long)uaddr & PAGE_MASK) !=
				((unsigned long)end & PAGE_MASK))
		 	__get_user(c, end);
	}
}

#endif /* _LINUX_PAGEMAP_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_PAGEMAP_H
	2	#define _LINUX_PAGEMAP_H
	3
	4	/*
	5	* Copyright 1995 Linus Torvalds
	6	*/
	7	#include <linux/mm.h>
	8	#include <linux/fs.h>
	9	#include <linux/list.h>
	10	#include <linux/highmem.h>
	11	#include <linux/compiler.h>
	12	#include <asm/uaccess.h>
	13	#include <linux/gfp.h>
	14
	15	/*
	16	* Bits in mapping->flags. The lower __GFP_BITS_SHIFT bits are the page
	17	* allocation mode flags.
	18	*/
	19	#define AS_EIO (__GFP_BITS_SHIFT + 0) /* IO error on async write */
	20	#define AS_ENOSPC (__GFP_BITS_SHIFT + 1) /* ENOSPC on async write */
	21
dd0fc66f	22	static inline gfp_t mapping_gfp_mask(struct address_space * mapping)
1da177e4	23	{
260b2367	24	return (__force gfp_t)mapping->flags & __GFP_BITS_MASK;
1da177e4 LT	25	}
	26
	27	/*
	28	* This is non-atomic. Only to be used before the mapping is activated.
	29	* Probably needs a barrier...
	30	*/
260b2367	31	static inline void mapping_set_gfp_mask(struct address_space *m, gfp_t mask)
1da177e4	32	{
260b2367 AV	33	m->flags = (m->flags & ~(__force unsigned long)__GFP_BITS_MASK) \|
260b2367 AV	34	(__force unsigned long)mask;
1da177e4 LT	35	}
	36
	37	/*
	38	* The page cache can done in larger chunks than
	39	* one page, because it allows for more efficient
	40	* throughput (it can then be mapped into user
	41	* space in smaller chunks for same flexibility).
	42	*
	43	* Or rather, it _will_ be done in larger chunks.
	44	*/
	45	#define PAGE_CACHE_SHIFT PAGE_SHIFT
	46	#define PAGE_CACHE_SIZE PAGE_SIZE
	47	#define PAGE_CACHE_MASK PAGE_MASK
	48	#define PAGE_CACHE_ALIGN(addr) (((addr)+PAGE_CACHE_SIZE-1)&PAGE_CACHE_MASK)
	49
	50	#define page_cache_get(page) get_page(page)
	51	#define page_cache_release(page) put_page(page)
	52	void release_pages(struct page **pages, int nr, int cold);
	53
44110fe3 PJ	54	#ifdef CONFIG_NUMA
	55	extern struct page page_cache_alloc(struct address_space x);
	56	extern struct page page_cache_alloc_cold(struct address_space x);
	57	#else
1da177e4 LT	58	static inline struct page page_cache_alloc(struct address_space x)
1da177e4 LT	59	{
2d6c666e	60	return alloc_pages(mapping_gfp_mask(x), 0);
1da177e4 LT	61	}
	62
	63	static inline struct page page_cache_alloc_cold(struct address_space x)
	64	{
2d6c666e	65	return alloc_pages(mapping_gfp_mask(x)\|__GFP_COLD, 0);
1da177e4	66	}
44110fe3	67	#endif
1da177e4 LT	68
	69	typedef int filler_t(void , struct page );
	70
	71	extern struct page * find_get_page(struct address_space *mapping,
	72	unsigned long index);
	73	extern struct page * find_lock_page(struct address_space *mapping,
	74	unsigned long index);
93fac704 NP	75	extern __deprecated_for_modules struct page * find_trylock_page(
93fac704 NP	76	struct address_space *mapping, unsigned long index);
1da177e4	77	extern struct page * find_or_create_page(struct address_space *mapping,
6daa0e28	78	unsigned long index, gfp_t gfp_mask);
1da177e4 LT	79	unsigned find_get_pages(struct address_space *mapping, pgoff_t start,
1da177e4 LT	80	unsigned int nr_pages, struct page **pages);
ebf43500 JA	81	unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t start,
ebf43500 JA	82	unsigned int nr_pages, struct page **pages);
1da177e4 LT	83	unsigned find_get_pages_tag(struct address_space mapping, pgoff_t index,
	84	int tag, unsigned int nr_pages, struct page **pages);
	85
	86	/*
	87	* Returns locked page at given index in given cache, creating it if needed.
	88	*/
	89	static inline struct page grab_cache_page(struct address_space mapping, unsigned long index)
	90	{
	91	return find_or_create_page(mapping, index, mapping_gfp_mask(mapping));
	92	}
	93
	94	extern struct page * grab_cache_page_nowait(struct address_space *mapping,
	95	unsigned long index);
	96	extern struct page * read_cache_page(struct address_space *mapping,
	97	unsigned long index, filler_t *filler,
	98	void *data);
	99	extern int read_cache_pages(struct address_space *mapping,
	100	struct list_head pages, filler_t filler, void *data);
	101
090d2b18 PE	102	static inline struct page read_mapping_page(struct address_space mapping,
	103	unsigned long index, void *data)
	104	{
	105	filler_t filler = (filler_t )mapping->a_ops->readpage;
	106	return read_cache_page(mapping, index, filler, data);
	107	}
	108
1da177e4	109	int add_to_page_cache(struct page page, struct address_space mapping,
6daa0e28	110	unsigned long index, gfp_t gfp_mask);
1da177e4	111	int add_to_page_cache_lru(struct page page, struct address_space mapping,
6daa0e28	112	unsigned long index, gfp_t gfp_mask);
1da177e4 LT	113	extern void remove_from_page_cache(struct page *page);
	114	extern void __remove_from_page_cache(struct page *page);
	115
1da177e4 LT	116	/*
	117	* Return byte-offset into filesystem object for page.
	118	*/
	119	static inline loff_t page_offset(struct page *page)
	120	{
	121	return ((loff_t)page->index) << PAGE_CACHE_SHIFT;
	122	}
	123
	124	static inline pgoff_t linear_page_index(struct vm_area_struct *vma,
	125	unsigned long address)
	126	{
	127	pgoff_t pgoff = (address - vma->vm_start) >> PAGE_SHIFT;
	128	pgoff += vma->vm_pgoff;
	129	return pgoff >> (PAGE_CACHE_SHIFT - PAGE_SHIFT);
	130	}
	131
	132	extern void FASTCALL(__lock_page(struct page *page));
db37648c	133	extern void FASTCALL(__lock_page_nosync(struct page *page));
1da177e4 LT	134	extern void FASTCALL(unlock_page(struct page *page));
1da177e4 LT	135
db37648c NP	136	/*
	137	* lock_page may only be called if we have the page's inode pinned.
	138	*/
1da177e4 LT	139	static inline void lock_page(struct page *page)
	140	{
	141	might_sleep();
	142	if (TestSetPageLocked(page))
	143	__lock_page(page);
	144	}
db37648c NP	145
	146	/*
	147	* lock_page_nosync should only be used if we can't pin the page's inode.
	148	* Doesn't play quite so well with block device plugging.
	149	*/
	150	static inline void lock_page_nosync(struct page *page)
	151	{
	152	might_sleep();
	153	if (TestSetPageLocked(page))
	154	__lock_page_nosync(page);
	155	}
1da177e4 LT	156
	157	/*
	158	* This is exported only for wait_on_page_locked/wait_on_page_writeback.
	159	* Never use this directly!
	160	*/
	161	extern void FASTCALL(wait_on_page_bit(struct page *page, int bit_nr));
	162
	163	/*
	164	* Wait for a page to be unlocked.
	165	*
	166	* This must be called with the caller "holding" the page,
	167	* ie with increased "page->count" so that the page won't
	168	* go away during the wait..
	169	*/
	170	static inline void wait_on_page_locked(struct page *page)
	171	{
	172	if (PageLocked(page))
	173	wait_on_page_bit(page, PG_locked);
	174	}
	175
	176	/*
	177	* Wait for a page to complete writeback
	178	*/
	179	static inline void wait_on_page_writeback(struct page *page)
	180	{
	181	if (PageWriteback(page))
	182	wait_on_page_bit(page, PG_writeback);
	183	}
	184
	185	extern void end_page_writeback(struct page *page);
	186
	187	/*
	188	* Fault a userspace page into pagetables. Return non-zero on a fault.
	189	*
	190	* This assumes that two userspace pages are always sufficient. That's
	191	* not true if PAGE_CACHE_SIZE > PAGE_SIZE.
	192	*/
	193	static inline int fault_in_pages_writeable(char __user *uaddr, int size)
	194	{
	195	int ret;
	196
	197	/*
	198	* Writing zeroes into userspace here is OK, because we know that if
	199	* the zero gets there, we'll be overwriting it.
	200	*/
	201	ret = __put_user(0, uaddr);
	202	if (ret == 0) {
	203	char __user *end = uaddr + size - 1;
	204
	205	/*
	206	* If the page was already mapped, this will get a cache miss
	207	* for sure, so try to avoid doing it.
	208	*/
	209	if (((unsigned long)uaddr & PAGE_MASK) !=
	210	((unsigned long)end & PAGE_MASK))
	211	ret = __put_user(0, end);
	212	}
	213	return ret;
	214	}
	215
	216	static inline void fault_in_pages_readable(const char __user *uaddr, int size)
	217	{
	218	volatile char c;
	219	int ret;
220
221	ret = __get_user(c, uaddr);
222	if (ret == 0) {
223	const char __user *end = uaddr + size - 1;
224
225	if (((unsigned long)uaddr & PAGE_MASK) !=
226	((unsigned long)end & PAGE_MASK))
227	__get_user(c, end);
228	}
229	}
230
231	#endif /* _LINUX_PAGEMAP_H */