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