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