bsd/sys/uio.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  26 /*
  27  * Copyright (c) 1982, 1986, 1993, 1994
  28  *      The Regents of the University of California.  All rights reserved.
  29  *
  30  * Redistribution and use in source and binary forms, with or without
  31  * modification, are permitted provided that the following conditions
  32  * are met:
  33  * 1. Redistributions of source code must retain the above copyright
  34  *    notice, this list of conditions and the following disclaimer.
  35  * 2. Redistributions in binary form must reproduce the above copyright
  36  *    notice, this list of conditions and the following disclaimer in the
  37  *    documentation and/or other materials provided with the distribution.
  38  * 3. All advertising materials mentioning features or use of this software
  39  *    must display the following acknowledgement:
  40  *      This product includes software developed by the University of
  41  *      California, Berkeley and its contributors.
  42  * 4. Neither the name of the University nor the names of its contributors
  43  *    may be used to endorse or promote products derived from this software
  44  *    without specific prior written permission.
  45  *
  46  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  49  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  50  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  56  * SUCH DAMAGE.
  57  *
  58  *      @(#)uio.h       8.5 (Berkeley) 2/22/94
  59  */
  60
  61 #ifndef _SYS_UIO_H_
  62 #define _SYS_UIO_H_
  63
  64 /*
  65  * XXX
  66  * iov_base should be a void *.
  67  */
  68 struct iovec {
  69         char    *iov_base;      /* Base address. */
  70         size_t   iov_len;       /* Length. */
  71 };
  72
  73 enum    uio_rw { UIO_READ, UIO_WRITE };
  74
  75 /* Segment flag values. */
  76 enum uio_seg {
  77         UIO_USERSPACE,          /* from user data space */
  78         UIO_USERISPACE,         /* from user I space */
  79         UIO_SYSSPACE,           /* from system space */
  80         UIO_PHYS_USERSPACE      /* kernel address is physical, to/from user data space */
  81 };
  82
  83 #ifdef KERNEL
  84 struct uio {
  85         struct  iovec *uio_iov;
  86         int     uio_iovcnt;
  87         off_t   uio_offset;
  88         int     uio_resid;
  89         enum    uio_seg uio_segflg;
  90         enum    uio_rw uio_rw;
  91         struct  proc *uio_procp;
  92 };
  93
  94 /*
  95  * Limits
  96  */
  97 #define UIO_MAXIOV      1024            /* max 1K of iov's */
  98 #define UIO_SMALLIOV    8               /* 8 on stack, else malloc */
  99
 100 extern int uiomove __P((caddr_t cp, int n, struct uio *uio));
 101 extern int uiomove64 __P((unsigned long long cp, int n, struct uio *uio));
 102 extern int ureadc __P((int c, struct uio *uio));
 103 extern int uwritec __P((struct uio *uio));
 104
 105 #endif /* KERNEL */
 106
 107 #ifndef KERNEL
 108 #include <sys/cdefs.h>
 109
 110 __BEGIN_DECLS
 111 ssize_t readv __P((int, const struct iovec *, int));
 112 ssize_t writev __P((int, const struct iovec *, int));
 113 __END_DECLS
 114 #endif /* !KERNEL */
 115 #endif /* !_SYS_UIO_H_ */