[linux.git] / include / linux / writeback.h

/*
 * include/linux/writeback.h.
 */
#ifndef WRITEBACK_H
#define WRITEBACK_H

struct backing_dev_info;

extern spinlock_t inode_lock;
extern struct list_head inode_in_use;
extern struct list_head inode_unused;

/*
 * Yes, writeback.h requires sched.h
 * No, sched.h is not included from here.
 */
static inline int task_is_pdflush(struct task_struct *task)
{
	return task->flags & PF_FLUSHER;
}

#define current_is_pdflush()	task_is_pdflush(current)

/*
 * fs/fs-writeback.c
 */
enum writeback_sync_modes {
	WB_SYNC_NONE,	/* Don't wait on anything */
	WB_SYNC_ALL,	/* Wait on every mapping */
	WB_SYNC_HOLD,	/* Hold the inode on sb_dirty for sys_sync() */
};

/*
 * A control structure which tells the writeback code what to do.  These are
 * always on the stack, and hence need no locking.  They are always initialised
 * in a manner such that unspecified fields are set to zero.
 */
struct writeback_control {
	struct backing_dev_info *bdi;	/* If !NULL, only write back this
					   queue */
	enum writeback_sync_modes sync_mode;
	unsigned long *older_than_this;	/* If !NULL, only write back inodes
					   older than this */
	long nr_to_write;		/* Write this many pages, and decrement
					   this for each page written */
	long pages_skipped;		/* Pages which were not written */

	/*
	 * For a_ops->writepages(): is start or end are non-zero then this is
	 * a hint that the filesystem need only write out the pages inside that
	 * byterange.  The byte at `end' is included in the writeout request.
	 */
	loff_t range_start;
	loff_t range_end;

	unsigned nonblocking:1;		/* Don't get stuck on request queues */
	unsigned encountered_congestion:1; /* An output: a queue is full */
	unsigned for_kupdate:1;		/* A kupdate writeback */
	unsigned for_reclaim:1;		/* Invoked from the page allocator */
	unsigned for_writepages:1;	/* This is a writepages() call */
	unsigned range_cyclic:1;	/* range_start is cyclic */
};

/*
 * fs/fs-writeback.c
 */	
void writeback_inodes(struct writeback_control *wbc);
void wake_up_inode(struct inode *inode);
int inode_wait(void *);
void sync_inodes_sb(struct super_block *, int wait);
void sync_inodes(int wait);

/* writeback.h requires fs.h; it, too, is not included from here. */
static inline void wait_on_inode(struct inode *inode)
{
	might_sleep();
	wait_on_bit(&inode->i_state, __I_LOCK, inode_wait,
							TASK_UNINTERRUPTIBLE);
}

/*
 * mm/page-writeback.c
 */
int wakeup_pdflush(long nr_pages);
void laptop_io_completion(void);
void laptop_sync_completion(void);
void throttle_vm_writeout(void);
void writeback_congestion_end(void);

/* These are exported to sysctl. */
extern int dirty_background_ratio;
extern int vm_dirty_ratio;
extern int dirty_writeback_interval;
extern int dirty_expire_interval;
extern int block_dump;
extern int laptop_mode;

struct ctl_table;
struct file;
int dirty_writeback_centisecs_handler(struct ctl_table *, int, struct file *,
				      void __user *, size_t *, loff_t *);

void page_writeback_init(void);
void balance_dirty_pages_ratelimited_nr(struct address_space *mapping,
					unsigned long nr_pages_dirtied);

static inline void
balance_dirty_pages_ratelimited(struct address_space *mapping)
{
	balance_dirty_pages_ratelimited_nr(mapping, 1);
}

int pdflush_operation(void (*fn)(unsigned long), unsigned long arg0);
int do_writepages(struct address_space *mapping, struct writeback_control *wbc);
int sync_page_range(struct inode *inode, struct address_space *mapping,
			loff_t pos, loff_t count);
int sync_page_range_nolock(struct inode *inode, struct address_space *mapping,
			   loff_t pos, loff_t count);
void set_page_dirty_balance(struct page *page);

/* pdflush.c */
extern int nr_pdflush_threads;	/* Global so it can be exported to sysctl
				   read-only. */


#endif		/* WRITEBACK_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* include/linux/writeback.h.
	3	*/
	4	#ifndef WRITEBACK_H
	5	#define WRITEBACK_H
	6
	7	struct backing_dev_info;
	8
	9	extern spinlock_t inode_lock;
	10	extern struct list_head inode_in_use;
	11	extern struct list_head inode_unused;
	12
	13	/*
	14	* Yes, writeback.h requires sched.h
	15	* No, sched.h is not included from here.
	16	*/
22e2c507	17	static inline int task_is_pdflush(struct task_struct *task)
1da177e4	18	{
22e2c507	19	return task->flags & PF_FLUSHER;
1da177e4 LT	20	}
1da177e4 LT	21
22e2c507 JA	22	#define current_is_pdflush() task_is_pdflush(current)
22e2c507 JA	23
1da177e4 LT	24	/*
	25	* fs/fs-writeback.c
	26	*/
	27	enum writeback_sync_modes {
	28	WB_SYNC_NONE, /* Don't wait on anything */
	29	WB_SYNC_ALL, /* Wait on every mapping */
	30	WB_SYNC_HOLD, /* Hold the inode on sb_dirty for sys_sync() */
	31	};
	32
	33	/*
	34	* A control structure which tells the writeback code what to do. These are
	35	* always on the stack, and hence need no locking. They are always initialised
	36	* in a manner such that unspecified fields are set to zero.
	37	*/
	38	struct writeback_control {
	39	struct backing_dev_info bdi; / If !NULL, only write back this
	40	queue */
	41	enum writeback_sync_modes sync_mode;
	42	unsigned long older_than_this; / If !NULL, only write back inodes
	43	older than this */
	44	long nr_to_write; /* Write this many pages, and decrement
	45	this for each page written */
	46	long pages_skipped; /* Pages which were not written */
	47
	48	/*
	49	* For a_ops->writepages(): is start or end are non-zero then this is
	50	* a hint that the filesystem need only write out the pages inside that
	51	* byterange. The byte at `end' is included in the writeout request.
	52	*/
111ebb6e OH	53	loff_t range_start;
111ebb6e OH	54	loff_t range_end;
1da177e4	55
22905f77 AM	56	unsigned nonblocking:1; /* Don't get stuck on request queues */
	57	unsigned encountered_congestion:1; /* An output: a queue is full */
	58	unsigned for_kupdate:1; /* A kupdate writeback */
	59	unsigned for_reclaim:1; /* Invoked from the page allocator */
	60	unsigned for_writepages:1; /* This is a writepages() call */
111ebb6e	61	unsigned range_cyclic:1; /* range_start is cyclic */
1da177e4 LT	62	};
1da177e4 LT	63
1da177e4 LT	64	/*
	65	* fs/fs-writeback.c
	66	*/
	67	void writeback_inodes(struct writeback_control *wbc);
	68	void wake_up_inode(struct inode *inode);
	69	int inode_wait(void *);
	70	void sync_inodes_sb(struct super_block *, int wait);
	71	void sync_inodes(int wait);
	72
	73	/* writeback.h requires fs.h; it, too, is not included from here. */
	74	static inline void wait_on_inode(struct inode *inode)
	75	{
	76	might_sleep();
	77	wait_on_bit(&inode->i_state, __I_LOCK, inode_wait,
	78	TASK_UNINTERRUPTIBLE);
	79	}
	80
	81	/*
	82	* mm/page-writeback.c
	83	*/
687a21ce	84	int wakeup_pdflush(long nr_pages);
1da177e4 LT	85	void laptop_io_completion(void);
	86	void laptop_sync_completion(void);
	87	void throttle_vm_writeout(void);
275a082f	88	void writeback_congestion_end(void);
1da177e4 LT	89
	90	/* These are exported to sysctl. */
	91	extern int dirty_background_ratio;
	92	extern int vm_dirty_ratio;
f6ef9438 BS	93	extern int dirty_writeback_interval;
f6ef9438 BS	94	extern int dirty_expire_interval;
1da177e4 LT	95	extern int block_dump;
	96	extern int laptop_mode;
	97
	98	struct ctl_table;
	99	struct file;
	100	int dirty_writeback_centisecs_handler(struct ctl_table , int, struct file ,
	101	void __user , size_t , loff_t *);
	102
	103	void page_writeback_init(void);
fa5a734e AM	104	void balance_dirty_pages_ratelimited_nr(struct address_space *mapping,
	105	unsigned long nr_pages_dirtied);
	106
	107	static inline void
	108	balance_dirty_pages_ratelimited(struct address_space *mapping)
	109	{
	110	balance_dirty_pages_ratelimited_nr(mapping, 1);
	111	}
	112
1da177e4 LT	113	int pdflush_operation(void (*fn)(unsigned long), unsigned long arg0);
	114	int do_writepages(struct address_space mapping, struct writeback_control wbc);
	115	int sync_page_range(struct inode inode, struct address_space mapping,
268fc16e OH	116	loff_t pos, loff_t count);
	117	int sync_page_range_nolock(struct inode inode, struct address_space mapping,
	118	loff_t pos, loff_t count);
edc79b2a	119	void set_page_dirty_balance(struct page *page);
1da177e4 LT	120
	121	/* pdflush.c */
	122	extern int nr_pdflush_threads; /* Global so it can be exported to sysctl
	123	read-only. */
	124
	125
	126	#endif /* WRITEBACK_H */