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