include/mach-o/dyld_images.h

   1 /*
   2  * Copyright (c) 2006-2010 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 #ifndef _DYLD_IMAGES_
  24 #define _DYLD_IMAGES_
  25
  26 #include <stdbool.h>
  27 #include <unistd.h>
  28 #include <mach/mach.h>
  29 #include <uuid/uuid.h>
  30
  31 #if defined(__cplusplus) && (BUILDING_LIBDYLD || BUILDING_DYLD)
  32 #include <atomic>
  33 #endif
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39
  40
  41 /*
  42  *      Beginning in Mac OS X 10.4, this is how gdb discovers which mach-o images are loaded in a process.
  43  *
  44  *      gdb looks for the symbol "_dyld_all_image_infos" in dyld.  It contains the fields below.
  45  *
  46  *      For a snashot of what images are currently loaded, the infoArray fields contain a pointer
  47  *      to an array of all images. If infoArray is NULL, it means it is being modified, come back later.
  48  *
  49  *      To be notified of changes, gdb sets a break point on the address pointed to by the notificationn
  50  *      field.  The function it points to is called by dyld with an array of information about what images
  51  *      have been added (dyld_image_adding) or are about to be removed (dyld_image_removing).
  52  *
  53  * The notification is called after infoArray is updated.  This means that if gdb attaches to a process
  54  * and infoArray is NULL, gdb can set a break point on notification and let the proccess continue to
  55  * run until the break point.  Then gdb can inspect the full infoArray.
  56  *
  57  * The dyldVersion field always points to a C string that contains the dyld version.  For instance,
  58  * in dyld-127.3, dyldVersion would contain a pointer to "127.3".
  59  *
  60  * The errorMessage and terminationFlags fields are normally zero.  If dyld terminates a process
  61  * (for instance because a required dylib or symbol is missing), then the errorMessage field will
  62  * be set to point to a C string message buffer containing the reason dyld terminate the process.
  63  * The low bit of the terminationFlags will be set if dyld terminated the process before any user
  64  * code ran, in which case there is no need for the crash log to contain the backtrace.
  65  *
  66  * When dyld terminates a process because some required dylib or symbol cannot be bound, in
  67  * addition to the errorMessage field, it now sets the errorKind field and the corresponding
  68  * fields: errorClientOfDylibPath, errorTargetDylibPath, errorSymbol.
  69  *
  70  */
  71
  72 enum dyld_image_mode { dyld_image_adding=0, dyld_image_removing=1, dyld_image_info_change=2 };
  73
  74 struct dyld_image_info {
  75         const struct mach_header*       imageLoadAddress;       /* base address image is mapped into */
  76         const char*                                     imageFilePath;          /* path dyld used to load the image */
  77         uintptr_t                                       imageFileModDate;       /* time_t of image file */
  78                                                                                                         /* if stat().st_mtime of imageFilePath does not match imageFileModDate, */
  79                                                                                                         /* then file has been modified since dyld loaded it */
  80 };
  81
  82 struct dyld_uuid_info {
  83         const struct mach_header*       imageLoadAddress;       /* base address image is mapped into */
  84         uuid_t                                          imageUUID;                      /* UUID of image */
  85 };
  86
  87 #define DYLD_AOT_IMAGE_KEY_SIZE 32
  88 struct dyld_aot_image_info {
  89     const struct mach_header*   x86LoadAddress;
  90     const struct mach_header*   aotLoadAddress;
  91     const uint64_t              aotImageSize;
  92     const uint8_t               aotImageKey[DYLD_AOT_IMAGE_KEY_SIZE]; // uniquely identifying SHA-256 key for this aot
  93 };
  94
  95 struct dyld_aot_shared_cache_info {
  96     const uintptr_t cacheBaseAddress;
  97     uuid_t          cacheUUID;
  98 };
  99
 100 typedef void (*dyld_image_notifier)(enum dyld_image_mode mode, uint32_t infoCount, const struct dyld_image_info info[]);
 101
 102 /* for use in dyld_all_image_infos.errorKind field */
 103 enum {  dyld_error_kind_none=0,
 104                 dyld_error_kind_dylib_missing=1,
 105                 dyld_error_kind_dylib_wrong_arch=2,
 106                 dyld_error_kind_dylib_version=3,
 107                 dyld_error_kind_symbol_missing=4
 108         };
 109
 110 /* internal limit */
 111 #define DYLD_MAX_PROCESS_INFO_NOTIFY_COUNT  8
 112
 113 struct dyld_all_image_infos {
 114         uint32_t                                                version;                /* 1 in Mac OS X 10.4 and 10.5 */
 115         uint32_t                                                infoArrayCount;
 116 #if defined(__cplusplus) && (BUILDING_LIBDYLD || BUILDING_DYLD)
 117     std::atomic<const struct dyld_image_info*>  infoArray;
 118 #else
 119     const struct dyld_image_info*    infoArray;
 120 #endif
 121         dyld_image_notifier                             notification;
 122         bool                                                    processDetachedFromSharedRegion;
 123         /* the following fields are only in version 2 (Mac OS X 10.6, iPhoneOS 2.0) and later */
 124         bool                                                    libSystemInitialized;
 125         const struct mach_header*               dyldImageLoadAddress;
 126         /* the following field is only in version 3 (Mac OS X 10.6, iPhoneOS 3.0) and later */
 127         void*                                                   jitInfo;
 128         /* the following fields are only in version 5 (Mac OS X 10.6, iPhoneOS 3.0) and later */
 129         const char*                                             dyldVersion;
 130         const char*                                             errorMessage;
 131         uintptr_t                                               terminationFlags;
 132         /* the following field is only in version 6 (Mac OS X 10.6, iPhoneOS 3.1) and later */
 133         void*                                                   coreSymbolicationShmPage;
 134         /* the following field is only in version 7 (Mac OS X 10.6, iPhoneOS 3.1) and later */
 135         uintptr_t                                               systemOrderFlag;
 136         /* the following field is only in version 8 (Mac OS X 10.7, iPhoneOS 3.1) and later */
 137         uintptr_t                                               uuidArrayCount;
 138         const struct dyld_uuid_info*    uuidArray;              /* only images not in dyld shared cache */
 139         /* the following field is only in version 9 (Mac OS X 10.7, iOS 4.0) and later */
 140         struct dyld_all_image_infos*    dyldAllImageInfosAddress;
 141         /* the following field is only in version 10 (Mac OS X 10.7, iOS 4.2) and later */
 142         uintptr_t                                               initialImageCount;
 143         /* the following field is only in version 11 (Mac OS X 10.7, iOS 4.2) and later */
 144         uintptr_t                                               errorKind;
 145         const char*                                             errorClientOfDylibPath;
 146         const char*                                             errorTargetDylibPath;
 147         const char*                                             errorSymbol;
 148         /* the following field is only in version 12 (Mac OS X 10.7, iOS 4.3) and later */
 149         uintptr_t                                               sharedCacheSlide;
 150         /* the following field is only in version 13 (Mac OS X 10.9, iOS 7.0) and later */
 151         uint8_t                                                 sharedCacheUUID[16];
 152         /* the following field is only in version 15 (macOS 10.12, iOS 10.0) and later */
 153         uintptr_t                                               sharedCacheBaseAddress;
 154 #if defined(__cplusplus) && (BUILDING_LIBDYLD || BUILDING_DYLD)
 155     // We want this to be atomic in libdyld so that we can see updates when we map it shared
 156     std::atomic<uint64_t>           infoArrayChangeTimestamp;
 157 #else
 158         uint64_t                                                infoArrayChangeTimestamp;
 159 #endif
 160         const char*                                             dyldPath;
 161         mach_port_t                                             notifyPorts[DYLD_MAX_PROCESS_INFO_NOTIFY_COUNT];
 162 #if __LP64__
 163         uintptr_t                                               reserved[13-(DYLD_MAX_PROCESS_INFO_NOTIFY_COUNT/2)];
 164 #else
 165         uintptr_t                                               reserved[13-DYLD_MAX_PROCESS_INFO_NOTIFY_COUNT];
 166 #endif
 167         /* the following field is only in version 16 (macOS 10.13, iOS 11.0) and later */
 168     uintptr_t                       compact_dyld_image_info_addr;
 169     size_t                          compact_dyld_image_info_size;
 170     uint32_t                        platform; // FIXME: really a dyld_platform_t, but those aren't exposed here.
 171
 172     /* the following field is only in version 17 (macOS 10.16) and later */
 173     uint32_t                          aotInfoCount;
 174     const struct dyld_aot_image_info* aotInfoArray;
 175     uint64_t                          aotInfoArrayChangeTimestamp;
 176     uintptr_t                         aotSharedCacheBaseAddress;
 177     uint8_t                           aotSharedCacheUUID[16];
 178 };
 179
 180 /*
 181  * Beginning in Mac OS X 10.5, this is how gdb discovers where the shared cache is in a process.
 182  * Images that are in the shared cache have their segments rearranged, so when using imageFilePath
 183  * to load the file from disk, you have to know to adjust addresses based on how their segment
 184  * was rearranged.
 185  *
 186  * gdb looks for the symbol "_dyld_shared_region_ranges" in dyld.
 187  *
 188  * It contains information the count of shared regions used by the process.  The count is
 189  * the number of start/length pairs.
 190  */
 191 struct dyld_shared_cache_ranges {
 192         uintptr_t                                       sharedRegionsCount;     /* how many ranges follow */
 193         struct {
 194                 uintptr_t       start;
 195                 uintptr_t       length;
 196         }                                                       ranges[4];                      /* max regions */
 197 };
 198 extern struct dyld_shared_cache_ranges dyld_shared_cache_ranges __attribute__((visibility("hidden")));
 199
 200
 201
 202 #ifdef __cplusplus
 203 }
 204 #endif
 205
 206 #endif /* _DYLD_IMAGES_ */