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