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

#ifndef BLK_INTERNAL_H
#define BLK_INTERNAL_H

#include <linux/idr.h>
#include <linux/blk-mq.h>
#include "blk-mq.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)

struct blk_flush_queue {
	unsigned int		flush_queue_delayed:1;
	unsigned int		flush_pending_idx:1;
	unsigned int		flush_running_idx:1;
	unsigned long		flush_pending_since;
	struct list_head	flush_queue[2];
	struct list_head	flush_data_in_flight;
	struct request		*flush_rq;

	/*
	 * flush_rq shares tag with this rq, both can't be active
	 * at the same time
	 */
	struct request		*orig_rq;
	spinlock_t		mq_flush_lock;
};

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 struct blk_flush_queue *blk_get_flush_queue(
		struct request_queue *q, struct blk_mq_ctx *ctx)
{
	if (q->mq_ops)
		return blk_mq_map_queue(q, ctx->cpu)->fq;
	return q->fq;
}

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

struct blk_flush_queue *blk_alloc_flush_queue(struct request_queue *q,
		int node, int cmd_size);
void blk_free_flush_queue(struct blk_flush_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);
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_freeze_queue(struct request_queue *q);

static inline void blk_queue_enter_live(struct request_queue *q)
{
	/*
	 * Given that running in generic_make_request() context
	 * guarantees that a live reference against q_usage_counter has
	 * been established, further references under that same context
	 * need not check that the queue has been frozen (marked dead).
	 */
	percpu_ref_get(&q->q_usage_counter);
}

#ifdef CONFIG_BLK_DEV_INTEGRITY
void blk_flush_integrity(void);
#else
static inline void blk_flush_integrity(void)
{
}
#endif

void blk_timeout_work(struct work_struct *work);
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,
			    struct request **same_queue_rq);
unsigned int blk_plug_queued_count(struct request_queue *q);

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,
	REQ_ATOM_POLL_SLEPT,
};

/*
 * 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)->rq_flags & RQF_HASHED)

void blk_insert_flush(struct request *rq);

static inline struct request *__elv_next_request(struct request_queue *q)
{
	struct request *rq;
	struct blk_flush_queue *fq = blk_get_flush_queue(q, NULL);

	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 (fq->flush_pending_idx != fq->flush_running_idx &&
				!queue_flush_queueable(q)) {
			fq->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);

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