1/*
2 * Copyright (c) 2017 Apple 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#ifndef _LIBKERN_COPYIO_H_
29#define _LIBKERN_COPYIO_H_
30
31#include <kern/debug.h>
32
33__BEGIN_DECLS
34
35int copyin(const user_addr_t uaddr, void *kaddr, size_t len) OS_WARN_RESULT;
36int copyout(const void *kaddr, user_addr_t udaddr, size_t len);
37
38#if defined (_FORTIFY_SOURCE) && _FORTIFY_SOURCE == 0
39/* FORTIFY_SOURCE disabled */
40
41#ifdef XNU_KERNEL_PRIVATE
42/* copyio wrappers that return mach error code */
43#define mach_copyin(uaddr, kaddr, len) (copyin(uaddr, kaddr, len) ? KERN_MEMORY_ERROR : KERN_SUCCESS)
44#define mach_copyout(kaddr, uaddr, len) (copyout(kaddr, uaddr, len) ? KERN_MEMORY_ERROR : KERN_SUCCESS)
45#endif /* XNU_KERNEL_PRIVATE */
46
47#else
48OS_ALWAYS_INLINE OS_WARN_RESULT static inline int
49__copyin_chk(const user_addr_t uaddr, void *kaddr, size_t len, size_t chk_size)
50{
51 if (chk_size < len) {
52 panic("__copyin_chk object size check failed: uaddr %p, kaddr %p, (%zu < %zu)", (void*)uaddr, kaddr, len, chk_size);
53 }
54 return copyin(uaddr, kaddr, len);
55}
56
57OS_ALWAYS_INLINE static inline int
58__copyout_chk(const void *kaddr, user_addr_t uaddr, size_t len, size_t chk_size)
59{
60 if (chk_size < len) {
61 panic("__copyout_chk object size check failed: uaddr %p, kaddr %p, (%zu < %zu)", (void*)uaddr, kaddr, len, chk_size);
62 }
63 return copyout(kaddr, udaddr: uaddr, len);
64}
65#define copyin(uaddr, kaddr, len) __copyin_chk(uaddr, kaddr, len, __builtin_object_size(kaddr, 0))
66#define copyout(kaddr, uaddr, len) __copyout_chk(kaddr, uaddr, len, __builtin_object_size(kaddr, 0))
67
68#ifdef XNU_KERNEL_PRIVATE
69/* copyio wrappers that return mach error code */
70#define mach_copyin(uaddr, kaddr, len) (__copyin_chk(uaddr, kaddr, len, __builtin_object_size(kaddr, 0)) ? KERN_MEMORY_ERROR : KERN_SUCCESS)
71#define mach_copyout(kaddr, uaddr, len) (__copyout_chk(kaddr, uaddr, len, __builtin_object_size(kaddr, 0)) ? KERN_MEMORY_ERROR : KERN_SUCCESS)
72#endif /* XNU_KERNEL_PRIVATE */
73
74#endif
75__END_DECLS
76#endif /* _LIBKERN_COPYIO_H_ */
77