| 1 | /* |
| 2 | * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved. |
| 3 | * |
| 4 | * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ |
| 5 | * |
| 6 | * This file contains Original Code and/or Modifications of Original Code |
| 7 | * as defined in and that are subject to the Apple Public Source License |
| 8 | * Version 2.0 (the 'License'). You may not use this file except in |
| 9 | * compliance with the License. The rights granted to you under the License |
| 10 | * may not be used to create, or enable the creation or redistribution of, |
| 11 | * unlawful or unlicensed copies of an Apple operating system, or to |
| 12 | * circumvent, violate, or enable the circumvention or violation of, any |
| 13 | * terms of an Apple operating system software license agreement. |
| 14 | * |
| 15 | * Please obtain a copy of the License at |
| 16 | * http://www.opensource.apple.com/apsl/ and read it before using this file. |
| 17 | * |
| 18 | * The Original Code and all software distributed under the License are |
| 19 | * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER |
| 20 | * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, |
| 21 | * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, |
| 22 | * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. |
| 23 | * Please see the License for the specific language governing rights and |
| 24 | * limitations under the License. |
| 25 | * |
| 26 | * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ |
| 27 | */ |
| 28 | /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */ |
| 29 | /* |
| 30 | * Copyright (c) 1982, 1986, 1993, 1994 |
| 31 | * The Regents of the University of California. All rights reserved. |
| 32 | * |
| 33 | * Redistribution and use in source and binary forms, with or without |
| 34 | * modification, are permitted provided that the following conditions |
| 35 | * are met: |
| 36 | * 1. Redistributions of source code must retain the above copyright |
| 37 | * notice, this list of conditions and the following disclaimer. |
| 38 | * 2. Redistributions in binary form must reproduce the above copyright |
| 39 | * notice, this list of conditions and the following disclaimer in the |
| 40 | * documentation and/or other materials provided with the distribution. |
| 41 | * 3. All advertising materials mentioning features or use of this software |
| 42 | * must display the following acknowledgement: |
| 43 | * This product includes software developed by the University of |
| 44 | * California, Berkeley and its contributors. |
| 45 | * 4. Neither the name of the University nor the names of its contributors |
| 46 | * may be used to endorse or promote products derived from this software |
| 47 | * without specific prior written permission. |
| 48 | * |
| 49 | * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND |
| 50 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 51 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 52 | * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE |
| 53 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 54 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 55 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 56 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| 57 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| 58 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 59 | * SUCH DAMAGE. |
| 60 | * |
| 61 | * @(#)uio.h 8.5 (Berkeley) 2/22/94 |
| 62 | */ |
| 63 | |
| 64 | #ifndef _SYS_UIO_INTERNAL_H_ |
| 65 | #define _SYS_UIO_INTERNAL_H_ |
| 66 | |
| 67 | #include <sys/appleapiopts.h> |
| 68 | |
| 69 | #ifdef KERNEL_PRIVATE |
| 70 | #include <sys/uio.h> |
| 71 | #include <sys/malloc.h> |
| 72 | #include <sys/param.h> |
| 73 | |
| 74 | /* |
| 75 | * user / kernel address space type flags. |
| 76 | * WARNING - make sure to check when adding flags! Be sure new flags |
| 77 | * don't overlap the definitions in uio.h |
| 78 | */ |
| 79 | // UIO_USERSPACE 0 defined in uio.h |
| 80 | #define UIO_USERISPACE 1 |
| 81 | // UIO_SYSSPACE 2 defined in uio.h |
| 82 | #define UIO_PHYS_USERSPACE 3 |
| 83 | #define UIO_PHYS_SYSSPACE 4 |
| 84 | // UIO_USERSPACE32 5 defined in uio.h |
| 85 | #define UIO_USERISPACE32 6 |
| 86 | #define UIO_PHYS_USERSPACE32 7 |
| 87 | // UIO_USERSPACE64 8 defined in uio.h |
| 88 | #define UIO_USERISPACE64 9 |
| 89 | #define UIO_PHYS_USERSPACE64 10 |
| 90 | // UIO_SYSSPACE32 11 defined in uio.h |
| 91 | // UIO_PHYS_SYSSPACE32 12 reserved, never used. Use UIO_PHYS_SYSSPACE |
| 92 | // UIO_SYSSPACE64 13 reserved, never used. Use UIO_SYSSPACE |
| 93 | // UIO_PHYS_SYSSPACE64 14 reserved, never used. Use UIO_PHYS_SYSSPACE |
| 94 | |
| 95 | __BEGIN_DECLS |
| 96 | struct user_iovec; |
| 97 | |
| 98 | #ifdef XNU_KERNEL_PRIVATE |
| 99 | __private_extern__ struct user_iovec * uio_iovsaddr( uio_t a_uio ); |
| 100 | __private_extern__ void uio_calculateresid( uio_t a_uio ); |
| 101 | __private_extern__ void uio_setcurriovlen( uio_t a_uio, user_size_t a_value ); |
| 102 | __private_extern__ int uio_spacetype( uio_t a_uio ); |
| 103 | __private_extern__ uio_t uio_createwithbuffer( int a_iovcount, off_t a_offset, int a_spacetype, int a_iodirection, void *a_buf_p, size_t a_buffer_size ); |
| 104 | __private_extern__ int copyin_user_iovec_array(user_addr_t uaddr, int spacetype, int count, struct user_iovec *dst); |
| 105 | /* reverse of uio_update to "undo" uncommited I/O. This only works in |
| 106 | * limited cases */ |
| 107 | __private_extern__ void uio_pushback( uio_t a_uio, user_size_t a_count ); |
| 108 | #endif /* XNU_KERNEL_PRIVATE */ |
| 109 | |
| 110 | /* use kern_iovec for system space requests */ |
| 111 | struct kern_iovec { |
| 112 | u_int64_t iov_base; /* Base address. */ |
| 113 | u_int64_t iov_len; /* Length. */ |
| 114 | }; |
| 115 | |
| 116 | /* use user_iovec for user space requests */ |
| 117 | struct user_iovec { |
| 118 | user_addr_t iov_base; /* Base address. */ |
| 119 | user_size_t iov_len; /* Length. */ |
| 120 | }; |
| 121 | |
| 122 | /* use user32_iovec/user64_iovec for representing |
| 123 | * in-memory structures in 32-64 processes during copyin */ |
| 124 | struct user32_iovec { |
| 125 | uint32_t iov_base; /* Base address. */ |
| 126 | uint32_t iov_len; /* Length. */ |
| 127 | }; |
| 128 | |
| 129 | struct user64_iovec { |
| 130 | uint64_t iov_base; /* Base address. */ |
| 131 | uint64_t iov_len; /* Length. */ |
| 132 | }; |
| 133 | |
| 134 | union iovecs { |
| 135 | struct kern_iovec *kiovp; |
| 136 | struct user_iovec *uiovp; |
| 137 | }; |
| 138 | |
| 139 | /* WARNING - use accessor calls for uio_iov and uio_resid since these */ |
| 140 | /* fields vary depending on the originating address space. */ |
| 141 | struct uio { |
| 142 | union iovecs uio_iovs; /* current iovec */ |
| 143 | int uio_iovcnt; /* active iovecs */ |
| 144 | off_t uio_offset; |
| 145 | enum uio_seg uio_segflg; |
| 146 | enum uio_rw uio_rw; |
| 147 | user_ssize_t uio_resid_64; |
| 148 | int uio_size; /* size for use with kfree */ |
| 149 | int uio_max_iovs; /* max number of iovecs this uio_t can hold */ |
| 150 | u_int32_t uio_flags; |
| 151 | }; |
| 152 | |
| 153 | /* values for uio_flags */ |
| 154 | #define UIO_FLAGS_INITED 0x00000001 |
| 155 | #define UIO_FLAGS_WE_ALLOCED 0x00000002 |
| 156 | #define UIO_FLAGS_IS_COMPRESSED_FILE 0x00000004 |
| 157 | |
| 158 | __END_DECLS |
| 159 | |
| 160 | /* |
| 161 | * UIO_SIZEOF - return the amount of space a uio_t requires to |
| 162 | * contain the given number of iovecs. Use this macro to |
| 163 | * create a stack buffer that can be passed to uio_createwithbuffer. |
| 164 | */ |
| 165 | #define UIO_SIZEOF( a_iovcount ) \ |
| 166 | ( sizeof(struct uio) + (MAX(sizeof(struct user_iovec), sizeof(struct kern_iovec)) * (a_iovcount)) ) |
| 167 | |
| 168 | #define UIO_IS_USER_SPACE32( a_uio_t ) \ |
| 169 | ( (a_uio_t)->uio_segflg == UIO_USERSPACE32 || (a_uio_t)->uio_segflg == UIO_PHYS_USERSPACE32 || \ |
| 170 | (a_uio_t)->uio_segflg == UIO_USERISPACE32 ) |
| 171 | #define UIO_IS_USER_SPACE64( a_uio_t ) \ |
| 172 | ( (a_uio_t)->uio_segflg == UIO_USERSPACE64 || (a_uio_t)->uio_segflg == UIO_PHYS_USERSPACE64 || \ |
| 173 | (a_uio_t)->uio_segflg == UIO_USERISPACE64 ) |
| 174 | #define UIO_IS_USER_SPACE( a_uio_t ) \ |
| 175 | ( UIO_IS_USER_SPACE32((a_uio_t)) || UIO_IS_USER_SPACE64((a_uio_t)) || \ |
| 176 | (a_uio_t)->uio_segflg == UIO_USERSPACE || (a_uio_t)->uio_segflg == UIO_USERISPACE || \ |
| 177 | (a_uio_t)->uio_segflg == UIO_PHYS_USERSPACE ) |
| 178 | #define UIO_IS_SYS_SPACE( a_uio_t ) \ |
| 179 | ( (a_uio_t)->uio_segflg == UIO_SYSSPACE || (a_uio_t)->uio_segflg == UIO_PHYS_SYSSPACE || \ |
| 180 | (a_uio_t)->uio_segflg == UIO_SYSSPACE32 ) |
| 181 | |
| 182 | extern int ureadc(int c, struct uio *uio); |
| 183 | |
| 184 | #endif /* KERNEL_PRIVATE */ |
| 185 | #endif /* !_SYS_UIO_INTERNAL_H_ */ |