share/man/man9/getiobuf.9

   1 .\"     $NetBSD: getiobuf.9,v 1.3 2008/05/06 11:32:47 yamt Exp $
   2 .\"
   3 .\" Copyright (c)2006,2008 YAMAMOTO Takashi,
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\" ------------------------------------------------------------
  27 .Dd May 6, 2008
  28 .Dt GETIOBUF 9
  29 .Os
  30 .Sh NAME
  31 .Nm getiobuf ,
  32 .Nm putiobuf
  33 .Nd I/O descriptor allocation interface
  34 .\" ------------------------------------------------------------
  35 .Sh SYNOPSIS
  36 .In sys/buf.h
  37 .Ft struct buf *
  38 .Fn getiobuf "struct vnode *vp" "bool waitok"
  39 .Ft void
  40 .Fn putiobuf "struct buf *bp"
  41 .\" ------------------------------------------------------------
  42 .Sh DESCRIPTION
  43 .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  44 .Fn getiobuf
  45 allocates a
  46 .Em buf
  47 structure.
  48 .Pp
  49 .Bl -tag -width waitok
  50 .It Fa vp
  51 The vnode to which the allocated buffer will be associated.
  52 This can be
  53 .Dv NULL .
  54 .It Fa waitok
  55 If true,
  56 .Fa getiobuf
  57 can sleep until enough memory is available.
  58 Otherwise, it returns
  59 .Dv NULL
  60 immediately if enough memory is not available.
  61 .El
  62 .Pp
  63 Note that the allocated buffer doesn't belong to buffer cache.
  64 To free it,
  65 .Fn putiobuf
  66 should be used.
  67 .Fn brelse
  68 should not be used on it.
  69 .Pp
  70 .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  71 .Fn putiobuf
  72 frees
  73 .Fa bp ,
  74 which should be a buffer allocated with
  75 .Fn getiobuf .
  76 .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  77 .Sh SEE ALSO
  78 .Xr buffercache 9 ,
  79 .Xr intro 9