osfmk/kern/exc_guard.h

   1 /*
   2  * Copyright (c) 2016 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 /*
  29  * Mach Operating System
  30  * Copyright (c) 1989 Carnegie-Mellon University
  31  * Copyright (c) 1988 Carnegie-Mellon University
  32  * Copyright (c) 1987 Carnegie-Mellon University
  33  * All rights reserved.  The CMU software License Agreement specifies
  34  * the terms and conditions for use and redistribution.
  35  */
  36
  37 /*
  38  * EXC_GUARD related macros, namespace etc.
  39  */
  40
  41 #ifndef _EXC_GUARD_H_
  42 #define _EXC_GUARD_H_
  43
  44 /*
  45  * EXC_GUARD exception code namespace.
  46  *
  47  * code:
  48  * +-------------------+----------------+--------------+
  49  * |[63:61] guard type | [60:32] flavor | [31:0] target|
  50  * +-------------------+----------------+--------------+
  51  *
  52  * subcode:
  53  * +---------------------------------------------------+
  54  * |[63:0] guard identifier                            |
  55  * +---------------------------------------------------+
  56  */
  57
  58 #define EXC_GUARD_DECODE_GUARD_TYPE(code) \
  59         (((code) >> 61) & 0x7ull)
  60 #define EXC_GUARD_DECODE_GUARD_FLAVOR(code) \
  61         (((code) >> 32) & 0x1fffffff)
  62 #define EXC_GUARD_DECODE_GUARD_TARGET(code) \
  63         ((uint32_t)(code))
  64
  65 /* EXC_GUARD types */
  66
  67 /*
  68  * Mach port guards use the exception codes like this:
  69  *
  70  * code:
  71  * +-----------------------------+----------------+-----------------+
  72  * |[63:61] GUARD_TYPE_MACH_PORT | [60:32] flavor | [31:0] port name|
  73  * +-----------------------------+----------------+-----------------+
  74  *
  75  * subcode:
  76  * +----------------------------------------------------------------+
  77  * |[63:0] guard identifier                                         |
  78  * +----------------------------------------------------------------+
  79  */
  80
  81 #define GUARD_TYPE_MACH_PORT    0x1      /* guarded mach port */
  82
  83 /*
  84  * File descriptor guards use the exception codes this:
  85  *
  86  * code:
  87  * +-----------------------------+----------------+-----------------+
  88  * |[63:61] GUARD_TYPE_FD        | [60:32] flavor | [31:0] fd       |
  89  * +-----------------------------+----------------+-----------------+
  90  *
  91  * subcode:
  92  * +----------------------------------------------------------------+
  93  * |[63:0] guard identifier                                         |
  94  * +----------------------------------------------------------------+
  95  */
  96
  97 #define GUARD_TYPE_FD           0x2     /* guarded file descriptor */
  98
  99 /*
 100  * User generated guards use the exception codes this:
 101  *
 102  * code:
 103  * +-----------------------------+----------------+-----------------+
 104  * |[63:61] GUARD_TYPE_USER      | [60:32] unused | [31:0] namespc  |
 105  * +-----------------------------+----------------+-----------------+
 106  *
 107  * subcode:
 108  * +----------------------------------------------------------------+
 109  * |[63:0] reason_code                                              |
 110  * +----------------------------------------------------------------+
 111  */
 112
 113 #define GUARD_TYPE_USER         0x3     /* Userland assertions */
 114
 115 /*
 116  * Vnode guards use the exception codes like this:
 117  *
 118  * code:
 119  * +-----------------------------+----------------+-----------------+
 120  * |[63:61] GUARD_TYPE_VN        | [60:32] flavor | [31:0] pid      |
 121  * +-----------------------------+----------------+-----------------+
 122  *
 123  * subcode:
 124  * +----------------------------------------------------------------+
 125  * |[63:0] guard identifier                                         |
 126  * +----------------------------------------------------------------+
 127  */
 128
 129 #define GUARD_TYPE_VN           0x4     /* guarded vnode */
 130
 131 #ifdef KERNEL
 132
 133 #define EXC_GUARD_ENCODE_TYPE(code, type) \
 134         ((code) |= (((uint64_t)(type) & 0x7ull) << 61))
 135 #define EXC_GUARD_ENCODE_FLAVOR(code, flavor) \
 136         ((code) |= (((uint64_t)(flavor) & 0x1fffffffull) << 32))
 137 #define EXC_GUARD_ENCODE_TARGET(code, target) \
 138         ((code) |= (((uint64_t)(target) & 0xffffffffull)))
 139
 140 #endif /* KERNEL */
 141
 142 #endif /* _EXC_GUARD_H_ */