dyld3/libdyldEntryVector.h

   1 /*
   2  * Copyright (c) 2017 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
  25
  26 #ifndef __DYLD_ENTRY_VECTOR_H__
  27 #define __DYLD_ENTRY_VECTOR_H__
  28
  29 #include <mach-o/loader.h>
  30 #include <Availability.h>
  31
  32 #include "Loading.h"
  33
  34 struct dyld_all_image_infos;
  35 class DyldSharedCache;
  36 struct ProgramVars;
  37
  38 namespace dyld3 {
  39
  40 typedef void  (*MainFunc)(void);
  41
  42 struct LibDyldEntryVector
  43 {
  44     enum { kCurrentVectorVersion = 10 };
  45     // The 32-bit caches steal bits to make rebase chains, so use 32-bits for the binary format version storage, but mask only some to actually use
  46     enum { kBinaryFormatVersionMask = 0x00FFFFFF };
  47
  48     uint32_t    vectorVersion;              // should be kCurrentVectorVersion
  49     uint32_t    binaryFormatVersion;        // should be dyld3::closure::kFormatVersion
  50     void        (*setVars)(const mach_header* mainMH, int argc, const char* argv[], const char* envp[], const char* apple[], bool keysOff, bool platformBinariesOnly);
  51     void        (*setHaltFunction)(void (*func)(const char* message) __attribute__((noreturn)) );
  52     void        (*setOldAllImageInfo)(dyld_all_image_infos*);
  53     void        (*setInitialImageList)(const closure::LaunchClosure* closure,
  54                                         const DyldSharedCache* dyldCacheLoadAddress, const char* dyldCachePath,
  55                                         const Array<LoadedImage>& initialImages, LoadedImage& libSystem);
  56     void        (*runInitialzersBottomUp)(const mach_header* topImageLoadAddress);
  57     void        (*startFunc)();
  58     // added in version 3
  59     void        (*setChildForkFunction)(void (*func)());
  60     // added in version 4
  61     void        (*setLogFunction)(void (*logFunction)(const char* format, va_list list));
  62     // added in version 5
  63     void        (*setRestrictions)(bool allowAtPaths, bool allowEnvVars, bool allowFallbackPaths);
  64     // added in version 6
  65     void        (*setNotifyMonitoringDyldMain)(void (*notifyMonitoringDyldMain)());
  66     void        (*setNotifyMonitoringDyld)(void (*notifyMonitoringDyldMain)(bool unloading, unsigned imageCount,
  67                                                                             const struct mach_header* loadAddresses[],
  68                                                                             const char* imagePaths[]));
  69     // added in version 7
  70     void        (*setHasCacheOverrides)(bool someCacheImageOverriden);
  71
  72     // added in version 8
  73     void        (*setProgramVars)(struct ProgramVars* progVars);
  74
  75     // added in version 9
  76     void        (*setLaunchMode)(uint32_t flags);
  77
  78     // added in version 10
  79     MainFunc    (*getDriverkitMain)(void);
  80 };
  81
  82 extern const LibDyldEntryVector entryVectorForDyld;
  83
  84 extern int compatFuncLookup(const char* name, void** address) __API_AVAILABLE(ios(13.0));
  85
  86 } // namespace dyld3
  87
  88
  89 #endif // __DYLD_ENTRY_VECTOR_H__
  90
  91
  92
  93