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 ((enum uio_seg)1)
81// UIO_SYSSPACE 2 defined in uio.h
82#define UIO_PHYS_USERSPACE ((enum uio_seg)3)
83#define UIO_PHYS_SYSSPACE ((enum uio_seg)4)
84// UIO_USERSPACE32 5 defined in uio.h
85#define UIO_USERISPACE32 ((enum uio_seg)6)
86#define UIO_PHYS_USERSPACE32 ((enum uio_seg)7)
87// UIO_USERSPACE64 8 defined in uio.h
88#define UIO_USERISPACE64 ((enum uio_seg)9)
89#define UIO_PHYS_USERSPACE64 ((enum uio_seg)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
95enum {
96 UIOF_USERISPACE = (1 << UIO_USERISPACE),
97 UIOF_PHYS_USERSPACE = (1 << UIO_PHYS_USERSPACE),
98 UIOF_PHYS_SYSSPACE = (1 << UIO_PHYS_SYSSPACE),
99 UIOF_USERISPACE32 = (1 << UIO_USERISPACE32),
100 UIOF_PHYS_USERSPACE32 = (1 << UIO_PHYS_USERSPACE32),
101 UIOF_USERISPACE64 = (1 << UIO_USERISPACE64),
102 UIOF_PHYS_USERSPACE64 = (1 << UIO_PHYS_USERSPACE64),
103};
104
105__BEGIN_DECLS
106struct user_iovec;
107
108#ifdef XNU_KERNEL_PRIVATE
109__private_extern__ struct user_iovec * uio_iovsaddr_user( uio_t a_uio );
110__private_extern__ int uio_calculateresid_user(uio_t __attribute((nonnull)) a_uio);
111__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 );
112__private_extern__ int copyin_user_iovec_array(user_addr_t uaddr, int spacetype, int count, struct user_iovec *dst);
113
114/*
115 * uio_reset_fast - reset an uio_t.
116 * Reset the given uio_t to initial values. The uio_t is not fully initialized
117 * until all iovecs are added using uio_add_ov calls.
118 * The a_iovcount value passed in the uio_create is the maximum number of
119 * iovecs you may add.
120 * a_spacetype must NOT be UIO_USERSPACE, UIO_SYSSPACE32 or UIO_PHYS_USERSPACE.
121 */
122__private_extern__ void uio_reset_fast( uio_t a_uio,
123 off_t a_offset, /* current offset */
124 int a_spacetype, /* type of address space */
125 int a_iodirection ); /* read or write flag */
126
127__private_extern__ int uio_copyout_user(const char *c_cp, int n, uio_t uio);
128__private_extern__ int uio_copyin_user(const char *c_cp, int n, uio_t uio);
129__private_extern__ int uio_copyout_sys(const char *c_cp, int n, uio_t uio);
130__private_extern__ int uio_copyin_sys(const char *c_cp, int n, uio_t uio);
131__private_extern__ int uio_copyout_phys_user(const char *c_cp, int n, uio_t uio);
132__private_extern__ int uio_copyin_phys_user(const char *c_cp, int n, uio_t uio);
133__private_extern__ int uio_copyout_phys_sys(const char *c_cp, int n, uio_t uio);
134__private_extern__ int uio_copyin_phys_sys(const char *c_cp, int n, uio_t uio);
135
136#endif /* XNU_KERNEL_PRIVATE */
137
138/* use kern_iovec for system space requests */
139struct kern_iovec {
140 u_int64_t iov_base; /* Base address; PAC signed, diversified with length. */
141 u_int64_t iov_len; /* Length. */
142};
143
144/* use user_iovec for user space requests */
145struct user_iovec {
146 user_addr_t iov_base; /* Base address. */
147 user_size_t iov_len; /* Length. */
148};
149
150/* use user32_iovec/user64_iovec for representing
151 * in-memory structures in 32-64 processes during copyin */
152struct user32_iovec {
153 uint32_t iov_base; /* Base address. */
154 uint32_t iov_len; /* Length. */
155};
156
157struct user64_iovec {
158 uint64_t iov_base; /* Base address. */
159 uint64_t iov_len; /* Length. */
160};
161
162union iovecs {
163 struct kern_iovec *kiovp;
164 struct user_iovec *uiovp;
165};
166
167/* WARNING - use accessor calls for uio_iov and uio_resid since these */
168/* fields vary depending on the originating address space. */
169struct uio {
170 void * XNU_PTRAUTH_SIGNED_PTR("uio.uio_iovs") uio_iovs; /* current iovec */
171 void * XNU_PTRAUTH_SIGNED_PTR("uio.uio_iovbase") uio_iovbase; /* iovec base */
172 int uio_max_iovs; /* max number of iovecs this uio_t can hold */
173 int uio_iovcnt; /* active iovecs */
174 off_t uio_offset;
175 enum uio_seg uio_segflg;
176 enum uio_rw uio_rw;
177 user_size_t uio_resid_64;
178 u_int32_t uio_flags;
179};
180
181/* values for uio_flags */
182#define UIO_FLAGS_INITED 0x00000001
183#define UIO_FLAGS_WE_ALLOCED 0x00000002
184#define UIO_FLAGS_IS_COMPRESSED_FILE 0x00000004
185
186__END_DECLS
187
188#define UIO_SIZEOF_IOVS( a_iovcount ) \
189 ( MAX(sizeof(struct user_iovec), sizeof(struct kern_iovec)) * (a_iovcount) )
190
191/*
192 * UIO_SIZEOF - return the amount of space a uio_t requires to
193 * contain the given number of iovecs.
194 */
195#ifndef P2ROUNDUP
196#define P2ROUNDUP(x, align) (-(-((long)x) & -((long)align)))
197#endif
198#define UIO_SIZEOF( a_iovcount ) \
199 ( P2ROUNDUP(sizeof(struct uio), sizeof(uint64_t)) \
200 + UIO_SIZEOF_IOVS(a_iovcount) )
201
202/*
203 * UIO_STACKBUF - use this macro to declare a stack buffer with the
204 * appropriate size an alignment for the given number of iovecs.
205 * The resulting buffer can then be passed to uio_createwithbuffer().
206 */
207#define UIO_STACKBUF(name, niov) \
208 uint64_t name[P2ROUNDUP(UIO_SIZEOF(niov), sizeof(uint64_t)) \
209 / sizeof(uint64_t)]
210
211#define UIO_IS_USER_SPACE32( a_uio_t ) \
212 ( (1 << (a_uio_t)->uio_segflg) & (UIOF_USERSPACE32 | UIOF_PHYS_USERSPACE32 | UIOF_USERISPACE32))
213#define UIO_IS_USER_SPACE64( a_uio_t ) \
214 ( (1 << (a_uio_t)->uio_segflg) & (UIOF_USERSPACE64 | UIOF_PHYS_USERSPACE64 | UIOF_USERISPACE64))
215#define UIO_IS_USER_SPACE( a_uio_t ) \
216 ( (1 << (a_uio_t)->uio_segflg) & (UIOF_USERSPACE32 | UIOF_PHYS_USERSPACE32 | UIOF_USERISPACE32 | \
217 UIOF_USERSPACE64 | UIOF_PHYS_USERSPACE64 | UIOF_USERISPACE64 | \
218 UIOF_USERSPACE | UIOF_PHYS_USERSPACE | UIOF_USERISPACE))
219#define UIO_IS_SYS_SPACE( a_uio_t ) \
220 ( (1 << (a_uio_t)->uio_segflg) & (UIOF_SYSSPACE | UIOF_PHYS_SYSSPACE | UIOF_SYSSPACE32))
221
222extern int ureadc(int c, struct uio *uio);
223
224#endif /* KERNEL_PRIVATE */
225#endif /* !_SYS_UIO_INTERNAL_H_ */
226