1*f6217f89SApple OSS Distributions /*
2*f6217f89SApple OSS Distributions * Copyright (c) 2017 Apple Inc. All rights reserved.
3*f6217f89SApple OSS Distributions *
4*f6217f89SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*f6217f89SApple OSS Distributions *
6*f6217f89SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code
7*f6217f89SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License
8*f6217f89SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in
9*f6217f89SApple OSS Distributions * compliance with the License. The rights granted to you under the License
10*f6217f89SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of,
11*f6217f89SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to
12*f6217f89SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any
13*f6217f89SApple OSS Distributions * terms of an Apple operating system software license agreement.
14*f6217f89SApple OSS Distributions *
15*f6217f89SApple OSS Distributions * Please obtain a copy of the License at
16*f6217f89SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*f6217f89SApple OSS Distributions *
18*f6217f89SApple OSS Distributions * The Original Code and all software distributed under the License are
19*f6217f89SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*f6217f89SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*f6217f89SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*f6217f89SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*f6217f89SApple OSS Distributions * Please see the License for the specific language governing rights and
24*f6217f89SApple OSS Distributions * limitations under the License.
25*f6217f89SApple OSS Distributions *
26*f6217f89SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*f6217f89SApple OSS Distributions */
28*f6217f89SApple OSS Distributions #ifndef _LIBKERN_COPYIO_H_
29*f6217f89SApple OSS Distributions #define _LIBKERN_COPYIO_H_
30*f6217f89SApple OSS Distributions
31*f6217f89SApple OSS Distributions #include <kern/debug.h>
32*f6217f89SApple OSS Distributions
33*f6217f89SApple OSS Distributions __BEGIN_DECLS
34*f6217f89SApple OSS Distributions
35*f6217f89SApple OSS Distributions int copyin(const user_addr_t uaddr, void *__sized_by(len) kaddr, size_t len) OS_WARN_RESULT;
36*f6217f89SApple OSS Distributions int copyout(const void *__sized_by(len) kaddr, user_addr_t udaddr, size_t len);
37*f6217f89SApple OSS Distributions
38*f6217f89SApple OSS Distributions #if defined (_FORTIFY_SOURCE) && _FORTIFY_SOURCE == 0
39*f6217f89SApple OSS Distributions /* FORTIFY_SOURCE disabled (it is assumed to be 1 if undefined) */
40*f6217f89SApple OSS Distributions
41*f6217f89SApple OSS Distributions #ifdef XNU_KERNEL_PRIVATE
42*f6217f89SApple OSS Distributions /* copyio wrappers that return mach error code */
43*f6217f89SApple OSS Distributions #define mach_copyin(uaddr, kaddr, len) (copyin(uaddr, kaddr, len) ? KERN_MEMORY_ERROR : KERN_SUCCESS)
44*f6217f89SApple OSS Distributions #define mach_copyout(kaddr, uaddr, len) (copyout(kaddr, uaddr, len) ? KERN_MEMORY_ERROR : KERN_SUCCESS)
45*f6217f89SApple OSS Distributions #endif /* XNU_KERNEL_PRIVATE */
46*f6217f89SApple OSS Distributions
47*f6217f89SApple OSS Distributions #else
48*f6217f89SApple OSS Distributions OS_ALWAYS_INLINE OS_WARN_RESULT static inline int
__copyin_chk(const user_addr_t uaddr,void * __sized_by (len)kaddr,size_t len,size_t chk_size)49*f6217f89SApple OSS Distributions __copyin_chk(const user_addr_t uaddr, void *__sized_by(len) kaddr, size_t len, size_t chk_size)
50*f6217f89SApple OSS Distributions {
51*f6217f89SApple OSS Distributions if (chk_size < len) {
52*f6217f89SApple OSS Distributions panic("__copyin_chk object size check failed: uaddr %p, kaddr %p, (%zu < %zu)", (void*)uaddr, kaddr, len, chk_size);
53*f6217f89SApple OSS Distributions }
54*f6217f89SApple OSS Distributions return copyin(uaddr, kaddr, len);
55*f6217f89SApple OSS Distributions }
56*f6217f89SApple OSS Distributions
57*f6217f89SApple OSS Distributions OS_ALWAYS_INLINE static inline int
__copyout_chk(const void * __sized_by (len)kaddr,user_addr_t uaddr,size_t len,size_t chk_size)58*f6217f89SApple OSS Distributions __copyout_chk(const void *__sized_by(len) kaddr, user_addr_t uaddr, size_t len, size_t chk_size)
59*f6217f89SApple OSS Distributions {
60*f6217f89SApple OSS Distributions if (chk_size < len) {
61*f6217f89SApple OSS Distributions panic("__copyout_chk object size check failed: uaddr %p, kaddr %p, (%zu < %zu)", (void*)uaddr, kaddr, len, chk_size);
62*f6217f89SApple OSS Distributions }
63*f6217f89SApple OSS Distributions return copyout(kaddr, uaddr, len);
64*f6217f89SApple OSS Distributions }
65*f6217f89SApple OSS Distributions #define copyin(uaddr, kaddr, len) __copyin_chk(uaddr, kaddr, len, __builtin_object_size(kaddr, 0))
66*f6217f89SApple OSS Distributions #define copyout(kaddr, uaddr, len) __copyout_chk(kaddr, uaddr, len, __builtin_object_size(kaddr, 0))
67*f6217f89SApple OSS Distributions
68*f6217f89SApple OSS Distributions #ifdef XNU_KERNEL_PRIVATE
69*f6217f89SApple OSS Distributions /* copyio wrappers that return mach error code */
70*f6217f89SApple OSS Distributions #define mach_copyin(uaddr, kaddr, len) (__copyin_chk(uaddr, kaddr, len, __builtin_object_size(kaddr, 0)) ? KERN_MEMORY_ERROR : KERN_SUCCESS)
71*f6217f89SApple OSS Distributions #define mach_copyout(kaddr, uaddr, len) (__copyout_chk(kaddr, uaddr, len, __builtin_object_size(kaddr, 0)) ? KERN_MEMORY_ERROR : KERN_SUCCESS)
72*f6217f89SApple OSS Distributions #endif /* XNU_KERNEL_PRIVATE */
73*f6217f89SApple OSS Distributions
74*f6217f89SApple OSS Distributions #endif
75*f6217f89SApple OSS Distributions __END_DECLS
76*f6217f89SApple OSS Distributions #endif /* _LIBKERN_COPYIO_H_ */
77