runtime/objc-config.h

   1 /*
   2  * Copyright (c) 1999-2002, 2005-2008 Apple Inc.  All Rights Reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef _OBJC_CONFIG_H_
  25 #define _OBJC_CONFIG_H_
  26
  27 #include <TargetConditionals.h>
  28
  29 // Avoid the !NDEBUG double negative.
  30 #if !NDEBUG
  31 #   define DEBUG 1
  32 #else
  33 #   define DEBUG 0
  34 #endif
  35
  36 // Define SUPPORT_GC=1 to enable garbage collection.
  37 // Be sure to edit OBJC_NO_GC and OBJC_NO_GC_API in objc-api.h as well.
  38 #if TARGET_OS_EMBEDDED  ||  TARGET_OS_IPHONE  ||  TARGET_OS_WIN32  ||  (TARGET_OS_MAC && __x86_64h__)
  39 #   define SUPPORT_GC 0
  40 #else
  41 #   define SUPPORT_GC 1
  42 #endif
  43
  44 // Define SUPPORT_ZONES=1 to enable malloc zone support in NXHashTable.
  45 #if TARGET_OS_EMBEDDED  ||  TARGET_OS_IPHONE
  46 #   define SUPPORT_ZONES 0
  47 #else
  48 #   define SUPPORT_ZONES 1
  49 #endif
  50
  51 // Define SUPPORT_MOD=1 to use the mod operator in NXHashTable and objc-sel-set
  52 #if defined(__arm__)
  53 #   define SUPPORT_MOD 0
  54 #else
  55 #   define SUPPORT_MOD 1
  56 #endif
  57
  58 // Define SUPPORT_PREOPT=1 to enable dyld shared cache optimizations
  59 #if TARGET_OS_WIN32  ||  TARGET_IPHONE_SIMULATOR
  60 #   define SUPPORT_PREOPT 0
  61 #else
  62 #   define SUPPORT_PREOPT 1
  63 #endif
  64
  65 // Define SUPPORT_TAGGED_POINTERS=1 to enable tagged pointer objects
  66 // Be sure to edit tagged pointer SPI in objc-internal.h as well.
  67 #if !(__OBJC2__  &&  __LP64__)
  68 #   define SUPPORT_TAGGED_POINTERS 0
  69 #else
  70 #   define SUPPORT_TAGGED_POINTERS 1
  71 #endif
  72
  73 // Define SUPPORT_MSB_TAGGED_POINTERS to use the MSB
  74 // as the tagged pointer marker instead of the LSB.
  75 // Be sure to edit tagged pointer SPI in objc-internal.h as well.
  76 #if !SUPPORT_TAGGED_POINTERS  ||  !TARGET_OS_IPHONE
  77 #   define SUPPORT_MSB_TAGGED_POINTERS 0
  78 #else
  79 #   define SUPPORT_MSB_TAGGED_POINTERS 1
  80 #endif
  81
  82 // Define SUPPORT_NONPOINTER_ISA=1 to enable extra data in the isa field.
  83 #if !__LP64__  ||  TARGET_OS_WIN32  ||  TARGET_IPHONE_SIMULATOR
  84 #   define SUPPORT_NONPOINTER_ISA 0
  85 #else
  86 #   define SUPPORT_NONPOINTER_ISA 1
  87 #endif
  88
  89 // Define SUPPORT_FIXUP=1 to repair calls sites for fixup dispatch.
  90 // Fixup messaging itself is no longer supported.
  91 // Be sure to edit objc-abi.h as well (objc_msgSend*_fixup)
  92 // Note TARGET_OS_MAC is also set for iOS simulator.
  93 #if !__x86_64__  ||  !TARGET_OS_MAC
  94 #   define SUPPORT_FIXUP 0
  95 #else
  96 #   define SUPPORT_FIXUP 1
  97 #endif
  98
  99 // Define SUPPORT_IGNORED_SELECTOR_CONSTANT to remap GC-ignored selectors.
 100 // Good: fast ignore in objc_msgSend. Bad: disable shared cache optimizations
 101 // Now used only for old-ABI GC.
 102 // This is required for binary compatibility on 32-bit Mac: rdar://13757938
 103 #if __OBJC2__  ||  !SUPPORT_GC
 104 #   define SUPPORT_IGNORED_SELECTOR_CONSTANT 0
 105 #else
 106 #   define SUPPORT_IGNORED_SELECTOR_CONSTANT 1
 107 #   if defined(__i386__)
 108 #       define kIgnore 0xfffeb010
 109 #   else
 110 #       error unknown architecture
 111 #   endif
 112 #endif
 113
 114 // Define SUPPORT_ZEROCOST_EXCEPTIONS to use "zero-cost" exceptions for OBJC2.
 115 // Be sure to edit objc-exception.h as well (objc_add/removeExceptionHandler)
 116 #if !__OBJC2__  ||  (defined(__arm__)  &&  __USING_SJLJ_EXCEPTIONS__)
 117 #   define SUPPORT_ZEROCOST_EXCEPTIONS 0
 118 #else
 119 #   define SUPPORT_ZEROCOST_EXCEPTIONS 1
 120 #endif
 121
 122 // Define SUPPORT_ALT_HANDLERS if you're using zero-cost exceptions
 123 // but also need to support AppKit's alt-handler scheme
 124 // Be sure to edit objc-exception.h as well (objc_add/removeExceptionHandler)
 125 #if !SUPPORT_ZEROCOST_EXCEPTIONS  ||  TARGET_OS_IPHONE  ||  TARGET_OS_EMBEDDED
 126 #   define SUPPORT_ALT_HANDLERS 0
 127 #else
 128 #   define SUPPORT_ALT_HANDLERS 1
 129 #endif
 130
 131 // Define SUPPORT_RETURN_AUTORELEASE to optimize autoreleased return values
 132 #if !__OBJC2__  ||  TARGET_OS_WIN32
 133 #   define SUPPORT_RETURN_AUTORELEASE 0
 134 #else
 135 #   define SUPPORT_RETURN_AUTORELEASE 1
 136 #endif
 137
 138 // Define SUPPORT_STRET on architectures that need separate struct-return ABI.
 139 #if defined(__arm64__)
 140 #   define SUPPORT_STRET 0
 141 #else
 142 #   define SUPPORT_STRET 1
 143 #endif
 144
 145 // Define SUPPORT_MESSAGE_LOGGING to enable NSObjCMessageLoggingEnabled
 146 #if TARGET_OS_WIN32  ||  TARGET_OS_EMBEDDED
 147 #   define SUPPORT_MESSAGE_LOGGING 0
 148 #else
 149 #   define SUPPORT_MESSAGE_LOGGING 1
 150 #endif
 151
 152 // Define SUPPORT_QOS_HACK to work around deadlocks due to QoS bugs.
 153 #if !__OBJC2__  ||  TARGET_OS_WIN32
 154 #   define SUPPORT_QOS_HACK 0
 155 #else
 156 #   define SUPPORT_QOS_HACK 1
 157 #endif
 158
 159 // OBJC_INSTRUMENTED controls whether message dispatching is dynamically
 160 // monitored.  Monitoring introduces substantial overhead.
 161 // NOTE: To define this condition, do so in the build command, NOT by
 162 // uncommenting the line here.  This is because objc-class.h heeds this
 163 // condition, but objc-class.h can not #include this file (objc-config.h)
 164 // because objc-class.h is public and objc-config.h is not.
 165 //#define OBJC_INSTRUMENTED
 166
 167 #endif