2006-01-17 03:02:19 +03:00
|
|
|
.\" $NetBSD: getiobuf.9,v 1.2 2006/01/17 00:02:19 wiz Exp $
|
2006-01-17 01:32:07 +03:00
|
|
|
.\"
|
|
|
|
|
.\" Copyright (c)2006 YAMAMOTO Takashi,
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\" ------------------------------------------------------------
|
|
|
|
|
.Dd January 17, 2006
|
|
|
|
|
.Dt GETIOBUF 9
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm getiobuf ,
|
|
|
|
|
.Nm getiobuf_nowait ,
|
|
|
|
|
.Nm putiobuf
|
|
|
|
|
.Nd I/O descriptor allocation interface
|
|
|
|
|
.\" ------------------------------------------------------------
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In sys/buf.h
|
|
|
|
|
.Ft struct buf *
|
|
|
|
|
.Fn getiobuf "void"
|
|
|
|
|
.Ft struct buf *
|
|
|
|
|
.Fn getiobuf_nowait "void"
|
|
|
|
|
.Ft void
|
|
|
|
|
.Fn putiobuf "struct buf *bp"
|
|
|
|
|
.\" ------------------------------------------------------------
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
.Bl -tag -width compact
|
|
|
|
|
.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
|
|
|
.Fn getiobuf
|
|
|
|
|
allocates a
|
|
|
|
|
.Em buf
|
|
|
|
|
structure.
|
|
|
|
|
Note that this buffer doesn't belong to buffer cache.
|
|
|
|
|
To free it,
|
|
|
|
|
.Fn putiobuf
|
|
|
|
|
should be used.
|
|
|
|
|
.Fn brelse
|
|
|
|
|
should not be used on it.
|
|
|
|
|
.Pp
|
|
|
|
|
.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
|
|
|
.Fn getiobuf_nowait
|
|
|
|
|
is the same as
|
|
|
|
|
.Fn getiobuf ,
|
|
|
|
|
except that
|
|
|
|
|
.Fn getiobuf_nowait
|
|
|
|
|
never sleeps.
|
|
|
|
|
.Pp
|
|
|
|
|
.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
|
|
|
.Fn putiobuf
|
|
|
|
|
frees
|
|
|
|
|
.Fa bp ,
|
|
|
|
|
which should be a buffer allocated with either of
|
|
|
|
|
.Fn getiobuf
|
|
|
|
|
or
|
|
|
|
|
.Fn getiobuf_nowait .
|
|
|
|
|
.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
|
|
|
.El
|
|
|
|
|
.\" ------------------------------------------------------------
|
|
|
|
|
.Sh SEE ALSO
|
2006-01-17 03:02:19 +03:00
|
|
|
.Xr buffercache 9 ,
|
|
|
|
|
.Xr intro 9
|
