share/man/man9/uio.9

   1 .\"
   2 .\" Copyright (c) 1997 Joerg Wunsch
   3 .\"
   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 DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man9/uio.9,v 1.5.2.4 2001/12/17 11:30:19 ru Exp $
  27 .\" $DragonFly: src/share/man/man9/uio.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
  28 .\"
  29 .Dd February 2, 1997
  30 .Os
  31 .Dt UIO 9
  32 .Sh NAME
  33 .Nm uio ,
  34 .Nm uiomove
  35 .Nd device driver I/O routines
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In sys/uio.h
  39 .Pp
  40 .Bd -literal
  41 struct uio {
  42         struct  iovec *uio_iov;
  43         int     uio_iovcnt;
  44         off_t   uio_offset;
  45         int     uio_resid;
  46         enum    uio_seg uio_segflg;
  47         enum    uio_rw uio_rw;
  48         struct  proc *uio_procp;
  49 };
  50 .Ed
  51 .Ft int
  52 .Fn uiomove "caddr_t buf" "int howmuch" "struct uio *uiop"
  53 .Sh DESCRIPTION
  54 The function
  55 .Fn uiomove
  56 is used to handle transfer of data between buffers and I/O vectors
  57 that might possibly also cross the user/kernel space boundary.
  58 .Pp
  59 As a result of any
  60 .Xr read 2 ,
  61 .Xr write 2 ,
  62 .Xr readv 2 ,
  63 or
  64 .Xr writev 2
  65 system call that is being passed to a character-device driver, the
  66 appropriate driver
  67 .Va d_read
  68 or
  69 .Va d_write
  70 entry will be called with a pointer to a
  71 .Vt "struct uio"
  72 being passed.
  73 The transfer request is encoded in this structure.
  74 The driver itself should use
  75 .Fn uiomove
  76 to get at the data in this structure.
  77 .Pp
  78 The fields in the
  79 .Vt uio
  80 structure are:
  81 .Bl -tag -width ".Va uio_iovcnt"
  82 .It Va uio_iov
  83 The array of I/O vectors to be processed.
  84 In the case of scatter/gather
  85 I/O, this will be more than one vector.
  86 .It Va uio_iovcnt
  87 The number of I/O vectors present.
  88 .It Va uio_offset
  89 The offset into the device.
  90 .It Va uio_resid
  91 The number of bytes to process.
  92 .It Va uio_segflg
  93 One of the following flags:
  94 .Bl -tag -width ".Dv UIO_USERISPACE"
  95 .It Dv UIO_USERSPACE
  96 The I/O vector points into a process's address space.
  97 .It Dv UIO_SYSSPACE
  98 The I/O vector points into the kernel address space.
  99 .It Dv UIO_USERISPACE
 100 The I/O vector points into the instruction area of a process's address
 101 space.
 102 .It Dv UIO_NOCOPY
 103 Don't copy, already in object.
 104 .El
 105 .It Va uio_rw
 106 The direction of the desired transfer, either
 107 .Dv UIO_READ ,
 108 or
 109 .Dv UIO_WRITE .
 110 .It Va uio_td
 111 The pointer to a
 112 .Vt "struct thread"
 113 for the associated thread; used if
 114 .Va uio_segflg
 115 indicates that the transfer is to be made from/to a process's address
 116 space.
 117 .El
 118 .Sh EXAMPLES
 119 The idea is that the driver maintains a private buffer for its data,
 120 and processes the request in chunks of maximal the size of this
 121 buffer.
 122 Note that the buffer handling below is very simplified and
 123 won't work (the buffer pointer is not being advanced in case of a
 124 partial read), it's just here to demonstrate the
 125 .Nm
 126 handling.
 127 .Bd -literal
 128 /* MIN() can be found there: */
 129 #include <sys/param.h>
 130
 131 #define BUFSIZE 512
 132 static char buffer[BUFSIZE];
 133
 134 static int data_available;      /* amount of data that can be read */
 135
 136 static int
 137 fooread(dev_t dev, struct uio *uio, int flag)
 138 {
 139         int rv, amnt;
 140
 141         while (uio->uio_resid > 0) {
 142                 if (data_available > 0) {
 143                         amnt = MIN(uio->uio_resid, data_available);
 144                         if ((rv = uiomove((caddr_t)buffer, amnt, uio))
 145                             != 0)
 146                                 goto error;
 147                         data_available -= amnt;
 148                 } else {
 149                         tsleep(...);    /* wait for a better time */
 150                 }
 151         }
 152         return 0;
 153 error:
 154         /* do error cleanup here */
 155         return rv;
 156 }
 157 .Ed
 158 .Sh RETURN VALUES
 159 .Fn uiomove
 160 can return
 161 .Er EFAULT
 162 from the invoked
 163 .Xr copyin 9
 164 or
 165 .Xr copyout 9
 166 in case the transfer was to/from a process's address space.
 167 .Sh SEE ALSO
 168 .Xr read 2 ,
 169 .Xr readv 2 ,
 170 .Xr write 2 ,
 171 .Xr writev 2 ,
 172 .Xr copyin 9 ,
 173 .Xr copyout 9 ,
 174 .Xr sleep 9
 175 .Sh HISTORY
 176 The
 177 .Nm
 178 mechanism appeared in some early version of
 179 .Ux .
 180 .Sh AUTHORS
 181 This man page was written by
 182 .An J\(:org Wunsch .