.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "BLK_INIT_QUEUE" "" "06 October 2005" "" ""

.SH NAME
blk_init_queue \- prepare a request queue for use with a block device
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
request_queue_t * blk_init_queue  (request_fn_proc * \fIrfn\fB, spinlock_t * \fIlock\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIrfn\fB\fR
The function to be called to process requests that have been
placed on the queue.
.TP
\fB\fIlock\fB\fR
Request queue spin lock
.SH "DESCRIPTION"
.PP
If a block device wishes to use the standard request handling procedures,
which sorts requests and coalesces adjacent requests, then it must
call \fBblk_init_queue\fR\&.  The function \fIrfn\fR will be called when there
are requests on the queue that need to be processed.  If the device
supports plugging, then \fIrfn\fR may not be called immediately when requests
are available on the queue, but may be called at some time later instead.
Plugged queues are generally unplugged when a buffer belonging to one
of the requests on the queue is needed, or due to memory pressure.
.PP
\fIrfn\fR is not required, or even expected, to remove all requests off the
queue, but only as many as it can handle at a time.  If it does leave
requests on the queue, it is responsible for arranging that the requests
get dealt with eventually.
.PP
The queue spin lock must be held while manipulating the requests on the
request queue.
.PP
Function returns a pointer to the initialized request queue, or NULL if
it didn't succeed.
.SH "NOTE"
.PP
\fBblk_init_queue\fR must be paired with a \fBblk_cleanup_queue\fR call
when the block device is deactivated (such as at module unload).