[mirror_ubuntu-artful-kernel.git] / block / blk.h

#ifndef BLK_INTERNAL_H
#define BLK_INTERNAL_H

#include <linux/idr.h>

/* Amount of time in which a process may batch requests */
#define BLK_BATCH_TIME	(HZ/50UL)

/* Number of requests a "batching" process may submit */
#define BLK_BATCH_REQ	32

/* Max future timer expiry for timeouts */
#define BLK_MAX_TIMEOUT		(5 * HZ)

extern struct kmem_cache *blk_requestq_cachep;
extern struct kmem_cache *request_cachep;
extern struct kobj_type blk_queue_ktype;
extern struct ida blk_queue_ida;

static inline void __blk_get_queue(struct request_queue *q)
{
	kobject_get(&q->kobj);
}

int blk_init_flush(struct request_queue *q);
void blk_exit_flush(struct request_queue *q);

int blk_init_rl(struct request_list *rl, struct request_queue *q,
		gfp_t gfp_mask);
void blk_exit_rl(struct request_list *rl);
void init_request_from_bio(struct request *req, struct bio *bio);
void blk_rq_bio_prep(struct request_queue *q, struct request *rq,
			struct bio *bio);
int blk_rq_append_bio(struct request_queue *q, struct request *rq,
		      struct bio *bio);
void blk_queue_bypass_start(struct request_queue *q);
void blk_queue_bypass_end(struct request_queue *q);
void blk_dequeue_request(struct request *rq);
void __blk_queue_free_tags(struct request_queue *q);
bool __blk_end_bidi_request(struct request *rq, int error,
			    unsigned int nr_bytes, unsigned int bidi_bytes);

void blk_rq_timed_out_timer(unsigned long data);
unsigned long blk_rq_timeout(unsigned long timeout);
void blk_add_timer(struct request *req);
void blk_delete_timer(struct request *);


bool bio_attempt_front_merge(struct request_queue *q, struct request *req,
			     struct bio *bio);
bool bio_attempt_back_merge(struct request_queue *q, struct request *req,
			    struct bio *bio);
bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
			    unsigned int *request_count);

void blk_account_io_start(struct request *req, bool new_io);
void blk_account_io_completion(struct request *req, unsigned int bytes);
void blk_account_io_done(struct request *req);

/*
 * Internal atomic flags for request handling
 */
enum rq_atomic_flags {
	REQ_ATOM_COMPLETE = 0,
	REQ_ATOM_STARTED,
};

/*
 * EH timer and IO completion will both attempt to 'grab' the request, make
 * sure that only one of them succeeds
 */
static inline int blk_mark_rq_complete(struct request *rq)
{
	return test_and_set_bit(REQ_ATOM_COMPLETE, &rq->atomic_flags);
}

static inline void blk_clear_rq_complete(struct request *rq)
{
	clear_bit(REQ_ATOM_COMPLETE, &rq->atomic_flags);
}

/*
 * Internal elevator interface
 */
#define ELV_ON_HASH(rq) ((rq)->cmd_flags & REQ_HASHED)

void blk_insert_flush(struct request *rq);

static inline struct request *__elv_next_request(struct request_queue *q)
{
	struct request *rq;

	while (1) {
		if (!list_empty(&q->queue_head)) {
			rq = list_entry_rq(q->queue_head.next);
			return rq;
		}

		/*
		 * Flush request is running and flush request isn't queueable
		 * in the drive, we can hold the queue till flush request is
		 * finished. Even we don't do this, driver can't dispatch next
		 * requests and will requeue them. And this can improve
		 * throughput too. For example, we have request flush1, write1,
		 * flush 2. flush1 is dispatched, then queue is hold, write1
		 * isn't inserted to queue. After flush1 is finished, flush2
		 * will be dispatched. Since disk cache is already clean,
		 * flush2 will be finished very soon, so looks like flush2 is
		 * folded to flush1.
		 * Since the queue is hold, a flag is set to indicate the queue
		 * should be restarted later. Please see flush_end_io() for
		 * details.
		 */
		if (q->flush_pending_idx != q->flush_running_idx &&
				!queue_flush_queueable(q)) {
			q->flush_queue_delayed = 1;
			return NULL;
		}
		if (unlikely(blk_queue_bypass(q)) ||
		    !q->elevator->type->ops.elevator_dispatch_fn(q, 0))
			return NULL;
	}
}

static inline void elv_activate_rq(struct request_queue *q, struct request *rq)
{
	struct elevator_queue *e = q->elevator;

	if (e->type->ops.elevator_activate_req_fn)
		e->type->ops.elevator_activate_req_fn(q, rq);
}

static inline void elv_deactivate_rq(struct request_queue *q, struct request *rq)
{
	struct elevator_queue *e = q->elevator;

	if (e->type->ops.elevator_deactivate_req_fn)
		e->type->ops.elevator_deactivate_req_fn(q, rq);
}

#ifdef CONFIG_FAIL_IO_TIMEOUT
int blk_should_fake_timeout(struct request_queue *);
ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
ssize_t part_timeout_store(struct device *, struct device_attribute *,
				const char *, size_t);
#else
static inline int blk_should_fake_timeout(struct request_queue *q)
{
	return 0;
}
#endif

int ll_back_merge_fn(struct request_queue *q, struct request *req,
		     struct bio *bio);
int ll_front_merge_fn(struct request_queue *q, struct request *req, 
		      struct bio *bio);
int attempt_back_merge(struct request_queue *q, struct request *rq);
int attempt_front_merge(struct request_queue *q, struct request *rq);
int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
				struct request *next);
void blk_recalc_rq_segments(struct request *rq);
void blk_rq_set_mixed_merge(struct request *rq);
bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
int blk_try_merge(struct request *rq, struct bio *bio);

void blk_queue_congestion_threshold(struct request_queue *q);

void __blk_run_queue_uncond(struct request_queue *q);

int blk_dev_init(void);


/*
 * Return the threshold (number of used requests) at which the queue is
 * considered to be congested.  It include a little hysteresis to keep the
 * context switch rate down.
 */
static inline int queue_congestion_on_threshold(struct request_queue *q)
{
	return q->nr_congestion_on;
}

/*
 * The threshold at which a queue is considered to be uncongested
 */
static inline int queue_congestion_off_threshold(struct request_queue *q)
{
	return q->nr_congestion_off;
}

extern int blk_update_nr_requests(struct request_queue *, unsigned int);

/*
 * Contribute to IO statistics IFF:
 *
 *	a) it's attached to a gendisk, and
 *	b) the queue had IO stats enabled when this request was started, and
 *	c) it's a file system request
 */
static inline int blk_do_io_stat(struct request *rq)
{
	return rq->rq_disk &&
	       (rq->cmd_flags & REQ_IO_STAT) &&
		(rq->cmd_type == REQ_TYPE_FS);
}

/*
 * Internal io_context interface
 */
void get_io_context(struct io_context *ioc);
struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
			     gfp_t gfp_mask);
void ioc_clear_queue(struct request_queue *q);

int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);

/**
 * create_io_context - try to create task->io_context
 * @gfp_mask: allocation mask
 * @node: allocation node
 *
 * If %current->io_context is %NULL, allocate a new io_context and install
 * it.  Returns the current %current->io_context which may be %NULL if
 * allocation failed.
 *
 * Note that this function can't be called with IRQ disabled because
 * task_lock which protects %current->io_context is IRQ-unsafe.
 */
static inline struct io_context *create_io_context(gfp_t gfp_mask, int node)
{
	WARN_ON_ONCE(irqs_disabled());
	if (unlikely(!current->io_context))
		create_task_io_context(current, gfp_mask, node);
	return current->io_context;
}

/*
 * Internal throttling interface
 */
#ifdef CONFIG_BLK_DEV_THROTTLING
extern bool blk_throtl_bio(struct request_queue *q, struct bio *bio);
extern void blk_throtl_drain(struct request_queue *q);
extern int blk_throtl_init(struct request_queue *q);
extern void blk_throtl_exit(struct request_queue *q);
#else /* CONFIG_BLK_DEV_THROTTLING */
static inline bool blk_throtl_bio(struct request_queue *q, struct bio *bio)
{
	return false;
}
static inline void blk_throtl_drain(struct request_queue *q) { }
static inline int blk_throtl_init(struct request_queue *q) { return 0; }
static inline void blk_throtl_exit(struct request_queue *q) { }
#endif /* CONFIG_BLK_DEV_THROTTLING */

#endif /* BLK_INTERNAL_H */
Commit	Line	Data
8324aa91 JA	1	#ifndef BLK_INTERNAL_H
	2	#define BLK_INTERNAL_H
	3
a73f730d TH	4	#include <linux/idr.h>
a73f730d TH	5
86db1e29 JA	6	/* Amount of time in which a process may batch requests */
	7	#define BLK_BATCH_TIME (HZ/50UL)
	8
	9	/* Number of requests a "batching" process may submit */
	10	#define BLK_BATCH_REQ 32
	11
0d2602ca JA	12	/* Max future timer expiry for timeouts */
	13	#define BLK_MAX_TIMEOUT (5 * HZ)
	14
8324aa91	15	extern struct kmem_cache *blk_requestq_cachep;
320ae51f	16	extern struct kmem_cache *request_cachep;
8324aa91	17	extern struct kobj_type blk_queue_ktype;
a73f730d	18	extern struct ida blk_queue_ida;
8324aa91	19
09ac46c4 TH	20	static inline void __blk_get_queue(struct request_queue *q)
	21	{
	22	kobject_get(&q->kobj);
	23	}
	24
f3552655 ML	25	int blk_init_flush(struct request_queue *q);
	26	void blk_exit_flush(struct request_queue *q);
	27
5b788ce3 TH	28	int blk_init_rl(struct request_list rl, struct request_queue q,
	29	gfp_t gfp_mask);
	30	void blk_exit_rl(struct request_list *rl);
86db1e29 JA	31	void init_request_from_bio(struct request req, struct bio bio);
	32	void blk_rq_bio_prep(struct request_queue q, struct request rq,
	33	struct bio *bio);
a411f4bb BH	34	int blk_rq_append_bio(struct request_queue q, struct request rq,
a411f4bb BH	35	struct bio *bio);
d732580b TH	36	void blk_queue_bypass_start(struct request_queue *q);
d732580b TH	37	void blk_queue_bypass_end(struct request_queue *q);
9934c8c0	38	void blk_dequeue_request(struct request *rq);
8324aa91	39	void __blk_queue_free_tags(struct request_queue *q);
4853abaa JM	40	bool __blk_end_bidi_request(struct request *rq, int error,
4853abaa JM	41	unsigned int nr_bytes, unsigned int bidi_bytes);
8324aa91	42
242f9dcb	43	void blk_rq_timed_out_timer(unsigned long data);
0d2602ca	44	unsigned long blk_rq_timeout(unsigned long timeout);
87ee7b11	45	void blk_add_timer(struct request *req);
242f9dcb	46	void blk_delete_timer(struct request *);
242f9dcb	47
320ae51f JA	48
	49	bool bio_attempt_front_merge(struct request_queue q, struct request req,
	50	struct bio *bio);
	51	bool bio_attempt_back_merge(struct request_queue q, struct request req,
	52	struct bio *bio);
	53	bool blk_attempt_plug_merge(struct request_queue q, struct bio bio,
	54	unsigned int *request_count);
	55
	56	void blk_account_io_start(struct request *req, bool new_io);
	57	void blk_account_io_completion(struct request *req, unsigned int bytes);
	58	void blk_account_io_done(struct request *req);
	59
242f9dcb JA	60	/*
	61	* Internal atomic flags for request handling
	62	*/
	63	enum rq_atomic_flags {
	64	REQ_ATOM_COMPLETE = 0,
320ae51f	65	REQ_ATOM_STARTED,
242f9dcb JA	66	};
	67
	68	/*
	69	* EH timer and IO completion will both attempt to 'grab' the request, make
25985edc	70	* sure that only one of them succeeds
242f9dcb JA	71	*/
	72	static inline int blk_mark_rq_complete(struct request *rq)
	73	{
	74	return test_and_set_bit(REQ_ATOM_COMPLETE, &rq->atomic_flags);
	75	}
	76
	77	static inline void blk_clear_rq_complete(struct request *rq)
	78	{
	79	clear_bit(REQ_ATOM_COMPLETE, &rq->atomic_flags);
	80	}
86db1e29	81
158dbda0 TH	82	/*
	83	* Internal elevator interface
	84	*/
360f92c2	85	#define ELV_ON_HASH(rq) ((rq)->cmd_flags & REQ_HASHED)
158dbda0	86
ae1b1539	87	void blk_insert_flush(struct request *rq);
dd831006	88
158dbda0 TH	89	static inline struct request __elv_next_request(struct request_queue q)
	90	{
	91	struct request *rq;
	92
	93	while (1) {
ae1b1539	94	if (!list_empty(&q->queue_head)) {
158dbda0	95	rq = list_entry_rq(q->queue_head.next);
ae1b1539	96	return rq;
158dbda0 TH	97	}
158dbda0 TH	98
3ac0cc45	99	/*
	100	* Flush request is running and flush request isn't queueable
	101	* in the drive, we can hold the queue till flush request is
	102	* finished. Even we don't do this, driver can't dispatch next
	103	* requests and will requeue them. And this can improve
	104	* throughput too. For example, we have request flush1, write1,
	105	* flush 2. flush1 is dispatched, then queue is hold, write1
	106	* isn't inserted to queue. After flush1 is finished, flush2
	107	* will be dispatched. Since disk cache is already clean,
	108	* flush2 will be finished very soon, so looks like flush2 is
	109	* folded to flush1.
	110	* Since the queue is hold, a flag is set to indicate the queue
	111	* should be restarted later. Please see flush_end_io() for
	112	* details.
	113	*/
	114	if (q->flush_pending_idx != q->flush_running_idx &&
	115	!queue_flush_queueable(q)) {
	116	q->flush_queue_delayed = 1;
	117	return NULL;
	118	}
556ee818	119	if (unlikely(blk_queue_bypass(q)) \|\|
22f746e2	120	!q->elevator->type->ops.elevator_dispatch_fn(q, 0))
158dbda0 TH	121	return NULL;
	122	}
	123	}
	124
	125	static inline void elv_activate_rq(struct request_queue q, struct request rq)
	126	{
	127	struct elevator_queue *e = q->elevator;
	128
22f746e2 TH	129	if (e->type->ops.elevator_activate_req_fn)
22f746e2 TH	130	e->type->ops.elevator_activate_req_fn(q, rq);
158dbda0 TH	131	}
	132
	133	static inline void elv_deactivate_rq(struct request_queue q, struct request rq)
	134	{
	135	struct elevator_queue *e = q->elevator;
	136
22f746e2 TH	137	if (e->type->ops.elevator_deactivate_req_fn)
22f746e2 TH	138	e->type->ops.elevator_deactivate_req_fn(q, rq);
158dbda0 TH	139	}
158dbda0 TH	140
581d4e28 JA	141	#ifdef CONFIG_FAIL_IO_TIMEOUT
	142	int blk_should_fake_timeout(struct request_queue *);
	143	ssize_t part_timeout_show(struct device , struct device_attribute , char *);
	144	ssize_t part_timeout_store(struct device , struct device_attribute ,
	145	const char *, size_t);
	146	#else
	147	static inline int blk_should_fake_timeout(struct request_queue *q)
	148	{
	149	return 0;
	150	}
	151	#endif
	152
d6d48196 JA	153	int ll_back_merge_fn(struct request_queue q, struct request req,
	154	struct bio *bio);
	155	int ll_front_merge_fn(struct request_queue q, struct request req,
	156	struct bio *bio);
	157	int attempt_back_merge(struct request_queue q, struct request rq);
	158	int attempt_front_merge(struct request_queue q, struct request rq);
5e84ea3a JA	159	int blk_attempt_req_merge(struct request_queue q, struct request rq,
5e84ea3a JA	160	struct request *next);
d6d48196	161	void blk_recalc_rq_segments(struct request *rq);
80a761fd	162	void blk_rq_set_mixed_merge(struct request *rq);
050c8ea8 TH	163	bool blk_rq_merge_ok(struct request rq, struct bio bio);
050c8ea8 TH	164	int blk_try_merge(struct request rq, struct bio bio);
d6d48196	165
8324aa91 JA	166	void blk_queue_congestion_threshold(struct request_queue *q);
8324aa91 JA	167
c246e80d BVA	168	void __blk_run_queue_uncond(struct request_queue *q);
c246e80d BVA	169
ff88972c AB	170	int blk_dev_init(void);
ff88972c AB	171
f253b86b	172
8324aa91 JA	173	/*
	174	* Return the threshold (number of used requests) at which the queue is
	175	* considered to be congested. It include a little hysteresis to keep the
	176	* context switch rate down.
	177	*/
	178	static inline int queue_congestion_on_threshold(struct request_queue *q)
	179	{
	180	return q->nr_congestion_on;
	181	}
	182
	183	/*
	184	* The threshold at which a queue is considered to be uncongested
	185	*/
	186	static inline int queue_congestion_off_threshold(struct request_queue *q)
	187	{
	188	return q->nr_congestion_off;
	189	}
	190
e3a2b3f9 JA	191	extern int blk_update_nr_requests(struct request_queue *, unsigned int);
e3a2b3f9 JA	192
c2553b58 JA	193	/*
	194	* Contribute to IO statistics IFF:
	195	*
	196	* a) it's attached to a gendisk, and
	197	* b) the queue had IO stats enabled when this request was started, and
e2a60da7	198	* c) it's a file system request
c2553b58	199	*/
26308eab	200	static inline int blk_do_io_stat(struct request *rq)
fb8ec18c	201	{
33659ebb CH	202	return rq->rq_disk &&
33659ebb CH	203	(rq->cmd_flags & REQ_IO_STAT) &&
e2a60da7	204	(rq->cmd_type == REQ_TYPE_FS);
fb8ec18c JA	205	}
fb8ec18c JA	206
f2dbd76a TH	207	/*
	208	* Internal io_context interface
	209	*/
	210	void get_io_context(struct io_context *ioc);
47fdd4ca	211	struct io_cq ioc_lookup_icq(struct io_context ioc, struct request_queue *q);
24acfc34 TH	212	struct io_cq ioc_create_icq(struct io_context ioc, struct request_queue *q,
24acfc34 TH	213	gfp_t gfp_mask);
7e5a8794	214	void ioc_clear_queue(struct request_queue *q);
f2dbd76a	215
24acfc34	216	int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
f2dbd76a TH	217
	218	/**
	219	* create_io_context - try to create task->io_context
f2dbd76a TH	220	* @gfp_mask: allocation mask
	221	* @node: allocation node
	222	*
24acfc34 TH	223	* If %current->io_context is %NULL, allocate a new io_context and install
	224	* it. Returns the current %current->io_context which may be %NULL if
	225	* allocation failed.
f2dbd76a TH	226	*
f2dbd76a TH	227	* Note that this function can't be called with IRQ disabled because
24acfc34	228	* task_lock which protects %current->io_context is IRQ-unsafe.
f2dbd76a	229	*/
24acfc34	230	static inline struct io_context *create_io_context(gfp_t gfp_mask, int node)
f2dbd76a TH	231	{
f2dbd76a TH	232	WARN_ON_ONCE(irqs_disabled());
24acfc34 TH	233	if (unlikely(!current->io_context))
	234	create_task_io_context(current, gfp_mask, node);
	235	return current->io_context;
f2dbd76a TH	236	}
	237
	238	/*
	239	* Internal throttling interface
	240	*/
bc9fcbf9	241	#ifdef CONFIG_BLK_DEV_THROTTLING
bc16a4f9	242	extern bool blk_throtl_bio(struct request_queue q, struct bio bio);
c9a929dd	243	extern void blk_throtl_drain(struct request_queue *q);
bc9fcbf9 TH	244	extern int blk_throtl_init(struct request_queue *q);
	245	extern void blk_throtl_exit(struct request_queue *q);
	246	#else /* CONFIG_BLK_DEV_THROTTLING */
bc16a4f9	247	static inline bool blk_throtl_bio(struct request_queue q, struct bio bio)
bc9fcbf9	248	{
bc16a4f9	249	return false;
bc9fcbf9	250	}
c9a929dd	251	static inline void blk_throtl_drain(struct request_queue *q) { }
bc9fcbf9 TH	252	static inline int blk_throtl_init(struct request_queue *q) { return 0; }
	253	static inline void blk_throtl_exit(struct request_queue *q) { }
	254	#endif /* CONFIG_BLK_DEV_THROTTLING */
	255
	256	#endif /* BLK_INTERNAL_H */