2008-01-29 16:53:40 +03:00
/*
2010-09-03 13:56:17 +04:00
* Functions to sequence FLUSH and FUA writes .
2011-01-25 14:43:54 +03:00
*
* Copyright ( C ) 2011 Max Planck Institute for Gravitational Physics
* Copyright ( C ) 2011 Tejun Heo < tj @ kernel . org >
*
* This file is released under the GPLv2 .
*
* REQ_ { FLUSH | FUA } requests are decomposed to sequences consisted of three
* optional steps - PREFLUSH , DATA and POSTFLUSH - according to the request
* properties and hardware capability .
*
* If a request doesn ' t have data , only REQ_FLUSH makes sense , which
* indicates a simple flush request . If there is data , REQ_FLUSH indicates
* that the device cache should be flushed before the data is executed , and
* REQ_FUA means that the data must be on non - volatile media on request
* completion .
*
* If the device doesn ' t have writeback cache , FLUSH and FUA don ' t make any
* difference . The requests are either completed immediately if there ' s no
* data or executed as normal requests otherwise .
*
* If the device has writeback cache and supports FUA , REQ_FLUSH is
* translated to PREFLUSH but REQ_FUA is passed down directly with DATA .
*
* If the device has writeback cache and doesn ' t support FUA , REQ_FLUSH is
* translated to PREFLUSH and REQ_FUA to POSTFLUSH .
*
* The actual execution of flush is double buffered . Whenever a request
* needs to execute PRE or POSTFLUSH , it queues at
* q - > flush_queue [ q - > flush_pending_idx ] . Once certain criteria are met , a
* flush is issued and the pending_idx is toggled . When the flush
* completes , all the requests which were pending are proceeded to the next
* step . This allows arbitrary merging of different types of FLUSH / FUA
* requests .
*
* Currently , the following conditions are used to determine when to issue
* flush .
*
* C1 . At any given time , only one flush shall be in progress . This makes
* double buffering sufficient .
*
* C2 . Flush is deferred if any request is executing DATA of its sequence .
* This avoids issuing separate POSTFLUSHes for requests which shared
* PREFLUSH .
*
* C3 . The second condition is ignored if there is a request which has
* waited longer than FLUSH_PENDING_TIMEOUT . This is to avoid
* starvation in the unlikely case where there are continuous stream of
* FUA ( without FLUSH ) requests .
*
* For devices which support FUA , it isn ' t clear whether C2 ( and thus C3 )
* is beneficial .
*
* Note that a sequenced FLUSH / FUA request with DATA is completed twice .
* Once while executing DATA and again after the whole sequence is
* complete . The first completion updates the contained bio but doesn ' t
* finish it so that the bio submitter is notified only after the whole
* sequence is complete . This is implemented by testing REQ_FLUSH_SEQ in
* req_bio_endio ( ) .
*
* The above peculiarity requires that each FLUSH / FUA request has only one
* bio attached to it , which is guaranteed as they aren ' t allowed to be
* merged in the usual way .
2008-01-29 16:53:40 +03:00
*/
2011-01-25 14:43:54 +03:00
2008-01-29 16:53:40 +03:00
# include <linux/kernel.h>
# include <linux/module.h>
# include <linux/bio.h>
# include <linux/blkdev.h>
include cleanup: Update gfp.h and slab.h includes to prepare for breaking implicit slab.h inclusion from percpu.h
percpu.h is included by sched.h and module.h and thus ends up being
included when building most .c files. percpu.h includes slab.h which
in turn includes gfp.h making everything defined by the two files
universally available and complicating inclusion dependencies.
percpu.h -> slab.h dependency is about to be removed. Prepare for
this change by updating users of gfp and slab facilities include those
headers directly instead of assuming availability. As this conversion
needs to touch large number of source files, the following script is
used as the basis of conversion.
http://userweb.kernel.org/~tj/misc/slabh-sweep.py
The script does the followings.
* Scan files for gfp and slab usages and update includes such that
only the necessary includes are there. ie. if only gfp is used,
gfp.h, if slab is used, slab.h.
* When the script inserts a new include, it looks at the include
blocks and try to put the new include such that its order conforms
to its surrounding. It's put in the include block which contains
core kernel includes, in the same order that the rest are ordered -
alphabetical, Christmas tree, rev-Xmas-tree or at the end if there
doesn't seem to be any matching order.
* If the script can't find a place to put a new include (mostly
because the file doesn't have fitting include block), it prints out
an error message indicating which .h file needs to be added to the
file.
The conversion was done in the following steps.
1. The initial automatic conversion of all .c files updated slightly
over 4000 files, deleting around 700 includes and adding ~480 gfp.h
and ~3000 slab.h inclusions. The script emitted errors for ~400
files.
2. Each error was manually checked. Some didn't need the inclusion,
some needed manual addition while adding it to implementation .h or
embedding .c file was more appropriate for others. This step added
inclusions to around 150 files.
3. The script was run again and the output was compared to the edits
from #2 to make sure no file was left behind.
4. Several build tests were done and a couple of problems were fixed.
e.g. lib/decompress_*.c used malloc/free() wrappers around slab
APIs requiring slab.h to be added manually.
5. The script was run on all .h files but without automatically
editing them as sprinkling gfp.h and slab.h inclusions around .h
files could easily lead to inclusion dependency hell. Most gfp.h
inclusion directives were ignored as stuff from gfp.h was usually
wildly available and often used in preprocessor macros. Each
slab.h inclusion directive was examined and added manually as
necessary.
6. percpu.h was updated not to include slab.h.
7. Build test were done on the following configurations and failures
were fixed. CONFIG_GCOV_KERNEL was turned off for all tests (as my
distributed build env didn't work with gcov compiles) and a few
more options had to be turned off depending on archs to make things
build (like ipr on powerpc/64 which failed due to missing writeq).
* x86 and x86_64 UP and SMP allmodconfig and a custom test config.
* powerpc and powerpc64 SMP allmodconfig
* sparc and sparc64 SMP allmodconfig
* ia64 SMP allmodconfig
* s390 SMP allmodconfig
* alpha SMP allmodconfig
* um on x86_64 SMP allmodconfig
8. percpu.h modifications were reverted so that it could be applied as
a separate patch and serve as bisection point.
Given the fact that I had only a couple of failures from tests on step
6, I'm fairly confident about the coverage of this conversion patch.
If there is a breakage, it's likely to be something in one of the arch
headers which should be easily discoverable easily on most builds of
the specific arch.
Signed-off-by: Tejun Heo <tj@kernel.org>
Guess-its-ok-by: Christoph Lameter <cl@linux-foundation.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Lee Schermerhorn <Lee.Schermerhorn@hp.com>
2010-03-24 11:04:11 +03:00
# include <linux/gfp.h>
2008-01-29 16:53:40 +03:00
# include "blk.h"
2010-09-03 13:56:17 +04:00
/* FLUSH/FUA sequences */
enum {
2011-01-25 14:43:54 +03:00
REQ_FSEQ_PREFLUSH = ( 1 < < 0 ) , /* pre-flushing in progress */
REQ_FSEQ_DATA = ( 1 < < 1 ) , /* data write in progress */
REQ_FSEQ_POSTFLUSH = ( 1 < < 2 ) , /* post-flushing in progress */
REQ_FSEQ_DONE = ( 1 < < 3 ) ,
REQ_FSEQ_ACTIONS = REQ_FSEQ_PREFLUSH | REQ_FSEQ_DATA |
REQ_FSEQ_POSTFLUSH ,
/*
* If flush has been pending longer than the following timeout ,
* it ' s issued even if flush_data requests are still in flight .
*/
FLUSH_PENDING_TIMEOUT = 5 * HZ ,
2010-09-03 13:56:17 +04:00
} ;
2011-01-25 14:43:54 +03:00
static bool blk_kick_flush ( struct request_queue * q ) ;
2010-09-03 13:56:16 +04:00
2011-01-25 14:43:54 +03:00
static unsigned int blk_flush_policy ( unsigned int fflags , struct request * rq )
2008-01-29 16:53:40 +03:00
{
2011-01-25 14:43:54 +03:00
unsigned int policy = 0 ;
2008-01-29 16:53:40 +03:00
2011-01-25 14:43:54 +03:00
if ( fflags & REQ_FLUSH ) {
if ( rq - > cmd_flags & REQ_FLUSH )
policy | = REQ_FSEQ_PREFLUSH ;
if ( blk_rq_sectors ( rq ) )
policy | = REQ_FSEQ_DATA ;
if ( ! ( fflags & REQ_FUA ) & & ( rq - > cmd_flags & REQ_FUA ) )
policy | = REQ_FSEQ_POSTFLUSH ;
2010-09-03 13:56:16 +04:00
}
2011-01-25 14:43:54 +03:00
return policy ;
2008-01-29 16:53:40 +03:00
}
2011-01-25 14:43:54 +03:00
static unsigned int blk_flush_cur_seq ( struct request * rq )
2010-09-03 13:56:17 +04:00
{
2011-01-25 14:43:54 +03:00
return 1 < < ffz ( rq - > flush . seq ) ;
}
2010-09-03 13:56:17 +04:00
2011-01-25 14:43:54 +03:00
static void blk_flush_restore_request ( struct request * rq )
{
2010-09-03 13:56:17 +04:00
/*
2011-01-25 14:43:54 +03:00
* After flush data completion , @ rq - > bio is % NULL but we need to
* complete the bio again . @ rq - > biotail is guaranteed to equal the
* original @ rq - > bio . Restore it .
2010-09-03 13:56:17 +04:00
*/
2011-01-25 14:43:54 +03:00
rq - > bio = rq - > biotail ;
/* make @rq a normal request */
rq - > cmd_flags & = ~ REQ_FLUSH_SEQ ;
rq - > end_io = NULL ;
2010-09-03 13:56:17 +04:00
}
2011-01-25 14:43:54 +03:00
/**
* blk_flush_complete_seq - complete flush sequence
* @ rq : FLUSH / FUA request being sequenced
* @ seq : sequences to complete ( mask of % REQ_FSEQ_ * , can be zero )
* @ error : whether an error occurred
*
* @ rq just completed @ seq part of its flush sequence , record the
* completion and trigger the next step .
*
* CONTEXT :
* spin_lock_irq ( q - > queue_lock )
*
* RETURNS :
* % true if requests were added to the dispatch queue , % false otherwise .
*/
static bool blk_flush_complete_seq ( struct request * rq , unsigned int seq ,
int error )
2008-01-29 16:53:40 +03:00
{
2011-01-25 14:43:54 +03:00
struct request_queue * q = rq - > q ;
struct list_head * pending = & q - > flush_queue [ q - > flush_pending_idx ] ;
bool queued = false ;
BUG_ON ( rq - > flush . seq & seq ) ;
rq - > flush . seq | = seq ;
if ( likely ( ! error ) )
seq = blk_flush_cur_seq ( rq ) ;
else
seq = REQ_FSEQ_DONE ;
switch ( seq ) {
case REQ_FSEQ_PREFLUSH :
case REQ_FSEQ_POSTFLUSH :
/* queue for flush */
if ( list_empty ( pending ) )
q - > flush_pending_since = jiffies ;
list_move_tail ( & rq - > flush . list , pending ) ;
break ;
case REQ_FSEQ_DATA :
list_move_tail ( & rq - > flush . list , & q - > flush_data_in_flight ) ;
list_add ( & rq - > queuelist , & q - > queue_head ) ;
queued = true ;
break ;
case REQ_FSEQ_DONE :
/*
* @ rq was previously adjusted by blk_flush_issue ( ) for
* flush sequencing and may already have gone through the
* flush data request completion path . Restore @ rq for
* normal completion and end it .
*/
BUG_ON ( ! list_empty ( & rq - > queuelist ) ) ;
list_del_init ( & rq - > flush . list ) ;
blk_flush_restore_request ( rq ) ;
__blk_end_request_all ( rq , error ) ;
break ;
default :
BUG ( ) ;
}
return blk_kick_flush ( q ) | queued ;
2008-01-29 16:53:40 +03:00
}
2011-01-25 14:43:54 +03:00
static void flush_end_io ( struct request * flush_rq , int error )
2008-01-29 16:53:40 +03:00
{
2011-01-25 14:43:54 +03:00
struct request_queue * q = flush_rq - > q ;
struct list_head * running = & q - > flush_queue [ q - > flush_running_idx ] ;
bool queued = false ;
struct request * rq , * n ;
BUG_ON ( q - > flush_pending_idx = = q - > flush_running_idx ) ;
/* account completion of the flush request */
q - > flush_running_idx ^ = 1 ;
elv_completed_request ( q , flush_rq ) ;
/* and push the waiting requests to the next stage */
list_for_each_entry_safe ( rq , n , running , flush . list ) {
unsigned int seq = blk_flush_cur_seq ( rq ) ;
BUG_ON ( seq ! = REQ_FSEQ_PREFLUSH & & seq ! = REQ_FSEQ_POSTFLUSH ) ;
queued | = blk_flush_complete_seq ( rq , seq , error ) ;
}
2010-09-03 13:56:17 +04:00
/*
* Moving a request silently to empty queue_head may stall the
2011-03-02 16:48:06 +03:00
* queue . Kick the queue in those cases . This function is called
* from request completion path and calling directly into
* request_fn may confuse the driver . Always use kblockd .
2010-09-03 13:56:17 +04:00
*/
2011-03-10 10:52:07 +03:00
if ( queued )
2011-03-02 16:48:06 +03:00
__blk_run_queue ( q , true ) ;
2008-01-29 16:53:40 +03:00
}
2011-01-25 14:43:54 +03:00
/**
* blk_kick_flush - consider issuing flush request
* @ q : request_queue being kicked
*
* Flush related states of @ q have changed , consider issuing flush request .
* Please read the comment at the top of this file for more info .
*
* CONTEXT :
* spin_lock_irq ( q - > queue_lock )
*
* RETURNS :
* % true if flush was issued , % false otherwise .
*/
static bool blk_kick_flush ( struct request_queue * q )
2008-01-29 16:53:40 +03:00
{
2011-01-25 14:43:54 +03:00
struct list_head * pending = & q - > flush_queue [ q - > flush_pending_idx ] ;
struct request * first_rq =
list_first_entry ( pending , struct request , flush . list ) ;
/* C1 described at the top of this file */
if ( q - > flush_pending_idx ! = q - > flush_running_idx | | list_empty ( pending ) )
return false ;
/* C2 and C3 */
if ( ! list_empty ( & q - > flush_data_in_flight ) & &
time_before ( jiffies ,
q - > flush_pending_since + FLUSH_PENDING_TIMEOUT ) )
return false ;
/*
* Issue flush and toggle pending_idx . This makes pending_idx
* different from running_idx , which means flush is in flight .
*/
blk_rq_init ( q , & q - > flush_rq ) ;
q - > flush_rq . cmd_type = REQ_TYPE_FS ;
q - > flush_rq . cmd_flags = WRITE_FLUSH | REQ_FLUSH_SEQ ;
q - > flush_rq . rq_disk = first_rq - > rq_disk ;
q - > flush_rq . end_io = flush_end_io ;
q - > flush_pending_idx ^ = 1 ;
2011-03-04 21:09:02 +03:00
elv_insert ( q , & q - > flush_rq , ELEVATOR_INSERT_REQUEUE ) ;
2011-01-25 14:43:54 +03:00
return true ;
2008-01-29 16:53:40 +03:00
}
2011-01-25 14:43:54 +03:00
static void flush_data_end_io ( struct request * rq , int error )
2008-01-29 16:53:40 +03:00
{
2011-01-25 14:43:54 +03:00
struct request_queue * q = rq - > q ;
2011-03-04 21:09:02 +03:00
/*
* After populating an empty queue , kick it to avoid stall . Read
* the comment in flush_end_io ( ) .
*/
2011-03-08 15:19:51 +03:00
if ( blk_flush_complete_seq ( rq , REQ_FSEQ_DATA , error ) )
2011-03-04 21:09:02 +03:00
__blk_run_queue ( q , true ) ;
2008-01-29 16:53:40 +03:00
}
2011-01-25 14:43:54 +03:00
/**
* blk_insert_flush - insert a new FLUSH / FUA request
* @ rq : request to insert
*
* To be called from elv_insert ( ) for % ELEVATOR_INSERT_FLUSH insertions .
* @ rq is being submitted . Analyze what needs to be done and put it on the
* right queue .
*
* CONTEXT :
* spin_lock_irq ( q - > queue_lock )
*/
void blk_insert_flush ( struct request * rq )
2008-01-29 16:53:40 +03:00
{
2011-01-25 14:43:54 +03:00
struct request_queue * q = rq - > q ;
unsigned int fflags = q - > flush_flags ; /* may change, cache */
unsigned int policy = blk_flush_policy ( fflags , rq ) ;
2008-01-29 16:53:40 +03:00
2011-01-25 14:43:54 +03:00
BUG_ON ( rq - > end_io ) ;
BUG_ON ( ! rq - > bio | | rq - > bio ! = rq - > biotail ) ;
2010-09-03 13:56:17 +04:00
2011-01-25 14:43:54 +03:00
/*
* @ policy now records what operations need to be done . Adjust
* REQ_FLUSH and FUA for the driver .
*/
rq - > cmd_flags & = ~ REQ_FLUSH ;
if ( ! ( fflags & REQ_FUA ) )
rq - > cmd_flags & = ~ REQ_FUA ;
/*
* If there ' s data but flush is not necessary , the request can be
* processed directly without going through flush machinery . Queue
* for normal execution .
*/
if ( ( policy & REQ_FSEQ_DATA ) & &
! ( policy & ( REQ_FSEQ_PREFLUSH | REQ_FSEQ_POSTFLUSH ) ) ) {
list_add ( & rq - > queuelist , & q - > queue_head ) ;
return ;
2010-09-03 13:56:16 +04:00
}
2010-09-03 13:56:17 +04:00
2011-01-25 14:43:54 +03:00
/*
* @ rq should go through flush machinery . Mark it part of flush
* sequence and submit for further processing .
*/
memset ( & rq - > flush , 0 , sizeof ( rq - > flush ) ) ;
INIT_LIST_HEAD ( & rq - > flush . list ) ;
2011-01-25 14:43:49 +03:00
rq - > cmd_flags | = REQ_FLUSH_SEQ ;
2011-01-25 14:43:54 +03:00
rq - > end_io = flush_data_end_io ;
blk_flush_complete_seq ( rq , REQ_FSEQ_ACTIONS & ~ policy , 0 ) ;
2008-01-29 16:53:40 +03:00
}
2011-01-25 14:43:54 +03:00
/**
* blk_abort_flushes - @ q is being aborted , abort flush requests
* @ q : request_queue being aborted
*
* To be called from elv_abort_queue ( ) . @ q is being aborted . Prepare all
* FLUSH / FUA requests for abortion .
*
* CONTEXT :
* spin_lock_irq ( q - > queue_lock )
*/
void blk_abort_flushes ( struct request_queue * q )
2008-01-29 16:53:40 +03:00
{
2011-01-25 14:43:54 +03:00
struct request * rq , * n ;
int i ;
2010-09-03 13:56:16 +04:00
2010-09-03 13:56:17 +04:00
/*
2011-01-25 14:43:54 +03:00
* Requests in flight for data are already owned by the dispatch
* queue or the device driver . Just restore for normal completion .
2010-09-03 13:56:17 +04:00
*/
2011-01-25 14:43:54 +03:00
list_for_each_entry_safe ( rq , n , & q - > flush_data_in_flight , flush . list ) {
list_del_init ( & rq - > flush . list ) ;
blk_flush_restore_request ( rq ) ;
2010-09-03 13:56:17 +04:00
}
2010-09-03 13:56:16 +04:00
2010-09-03 13:56:17 +04:00
/*
2011-01-25 14:43:54 +03:00
* We need to give away requests on flush queues . Restore for
* normal completion and put them on the dispatch queue .
2010-09-03 13:56:17 +04:00
*/
2011-01-25 14:43:54 +03:00
for ( i = 0 ; i < ARRAY_SIZE ( q - > flush_queue ) ; i + + ) {
list_for_each_entry_safe ( rq , n , & q - > flush_queue [ i ] ,
flush . list ) {
list_del_init ( & rq - > flush . list ) ;
blk_flush_restore_request ( rq ) ;
list_add_tail ( & rq - > queuelist , & q - > queue_head ) ;
}
2010-09-03 13:56:16 +04:00
}
2008-01-29 16:53:40 +03:00
}
2010-09-03 13:56:17 +04:00
static void bio_end_flush ( struct bio * bio , int err )
2008-01-29 16:53:40 +03:00
{
2010-09-03 13:56:17 +04:00
if ( err )
2008-01-29 16:53:40 +03:00
clear_bit ( BIO_UPTODATE , & bio - > bi_flags ) ;
2010-04-28 17:55:07 +04:00
if ( bio - > bi_private )
complete ( bio - > bi_private ) ;
bio_put ( bio ) ;
2008-01-29 16:53:40 +03:00
}
/**
* blkdev_issue_flush - queue a flush
* @ bdev : blockdev to issue flush for
2010-04-28 17:55:06 +04:00
* @ gfp_mask : memory allocation flags ( for bio_alloc )
2008-01-29 16:53:40 +03:00
* @ error_sector : error sector
*
* Description :
* Issue a flush for the block device in question . Caller can supply
* room for storing the error offset in case of a flush error , if they
2010-04-28 17:55:07 +04:00
* wish to . If WAIT flag is not passed then caller may check only what
* request was pushed in some internal queue for later handling .
2008-01-29 16:53:40 +03:00
*/
2010-04-28 17:55:06 +04:00
int blkdev_issue_flush ( struct block_device * bdev , gfp_t gfp_mask ,
2010-09-16 22:51:46 +04:00
sector_t * error_sector )
2008-01-29 16:53:40 +03:00
{
DECLARE_COMPLETION_ONSTACK ( wait ) ;
struct request_queue * q ;
struct bio * bio ;
2010-04-28 17:55:06 +04:00
int ret = 0 ;
2008-01-29 16:53:40 +03:00
if ( bdev - > bd_disk = = NULL )
return - ENXIO ;
q = bdev_get_queue ( bdev ) ;
if ( ! q )
return - ENXIO ;
2010-07-13 11:50:50 +04:00
/*
* some block devices may not have their queue correctly set up here
* ( e . g . loop device without a backing file ) and so issuing a flush
* here will panic . Ensure there is a request function before issuing
2010-09-03 13:56:17 +04:00
* the flush .
2010-07-13 11:50:50 +04:00
*/
if ( ! q - > make_request_fn )
return - ENXIO ;
2010-04-28 17:55:06 +04:00
bio = bio_alloc ( gfp_mask , 0 ) ;
2010-09-03 13:56:17 +04:00
bio - > bi_end_io = bio_end_flush ;
2008-01-29 16:53:40 +03:00
bio - > bi_bdev = bdev ;
2010-09-16 22:51:46 +04:00
bio - > bi_private = & wait ;
2008-01-29 16:53:40 +03:00
2010-04-28 17:55:07 +04:00
bio_get ( bio ) ;
2010-09-03 13:56:17 +04:00
submit_bio ( WRITE_FLUSH , bio ) ;
2010-09-16 22:51:46 +04:00
wait_for_completion ( & wait ) ;
/*
* The driver must store the error location in - > bi_sector , if
* it supports it . For non - stacked drivers , this should be
* copied from blk_rq_pos ( rq ) .
*/
if ( error_sector )
* error_sector = bio - > bi_sector ;
2008-01-29 16:53:40 +03:00
2010-09-03 13:56:17 +04:00
if ( ! bio_flagged ( bio , BIO_UPTODATE ) )
2008-01-29 16:53:40 +03:00
ret = - EIO ;
bio_put ( bio ) ;
return ret ;
}
EXPORT_SYMBOL ( blkdev_issue_flush ) ;