bsd/libkern/copyio.h

   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
  35 int     copyin(const user_addr_t uaddr, void *kaddr, size_t len) OS_WARN_RESULT;
  36 int     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 #else
  41 OS_ALWAYS_INLINE OS_WARN_RESULT static inline int
  42 __copyin_chk(const user_addr_t uaddr, void *kaddr, size_t len, size_t chk_size)
  43 {
  44         if (chk_size < len) {
  45                 panic("__copyin_chk object size check failed: uaddr %p, kaddr %p, (%zu < %zu)", (void*)uaddr, kaddr, len, chk_size);
  46         }
  47         return copyin(uaddr, kaddr, len);
  48 }
  49
  50 OS_ALWAYS_INLINE static inline int
  51 __copyout_chk(const void *kaddr, user_addr_t uaddr, size_t len, size_t chk_size)
  52 {
  53         if (chk_size < len) {
  54                 panic("__copyout_chk object size check failed: uaddr %p, kaddr %p, (%zu < %zu)", (void*)uaddr, kaddr, len, chk_size);
  55         }
  56         return copyout(kaddr, uaddr, len);
  57 }
  58 #define copyin(uaddr, kaddr, len) __copyin_chk(uaddr, kaddr, len, __builtin_object_size(kaddr, 0))
  59 #define copyout(kaddr, uaddr, len) __copyout_chk(kaddr, uaddr, len, __builtin_object_size(kaddr, 0))
  60 #endif
  61 __END_DECLS
  62 #endif /* _LIBKERN_COPYIO_H_ */