include/ndk/ldrtypes.h

   1 /*++ NDK Version: 0098
   2
   3 Copyright (c) Alex Ionescu.  All rights reserved.
   4
   5 Header Name:
   6
   7     ldrtypes.h
   8
   9 Abstract:
  10
  11     Type definitions for the Loader.
  12
  13 Author:
  14
  15     Alex Ionescu (alexi@tinykrnl.org) - Updated - 27-Feb-2006
  16
  17 --*/
  18
  19 #ifndef _LDRTYPES_H
  20 #define _LDRTYPES_H
  21
  22 //
  23 // Dependencies
  24 //
  25 #include <umtypes.h>
  26
  27 //
  28 // Resource Type Levels
  29 //
  30 #define RESOURCE_TYPE_LEVEL                     0
  31 #define RESOURCE_NAME_LEVEL                     1
  32 #define RESOURCE_LANGUAGE_LEVEL                 2
  33 #define RESOURCE_DATA_LEVEL                     3
  34
  35 //
  36 // Loader Data Table Entry Flags
  37 //
  38 #define LDRP_STATIC_LINK                        0x00000002
  39 #define LDRP_IMAGE_DLL                          0x00000004
  40 #define LDRP_LOAD_IN_PROGRESS                   0x00001000
  41 #define LDRP_UNLOAD_IN_PROGRESS                 0x00002000
  42 #define LDRP_ENTRY_PROCESSED                    0x00004000
  43 #define LDRP_ENTRY_INSERTED                     0x00008000
  44 #define LDRP_CURRENT_LOAD                       0x00010000
  45 #define LDRP_FAILED_BUILTIN_LOAD                0x00020000
  46 #define LDRP_DONT_CALL_FOR_THREADS              0x00040000
  47 #define LDRP_PROCESS_ATTACH_CALLED              0x00080000
  48 #define LDRP_DEBUG_SYMBOLS_LOADED               0x00100000
  49 #define LDRP_IMAGE_NOT_AT_BASE                  0x00200000
  50 #define LDRP_COR_IMAGE                          0x00400000
  51 #define LDR_COR_OWNS_UNMAP                      0x00800000
  52 #define LDRP_SYSTEM_MAPPED                      0x01000000
  53 #define LDRP_IMAGE_VERIFYING                    0x02000000
  54 #define LDRP_DRIVER_DEPENDENT_DLL               0x04000000
  55 #define LDRP_ENTRY_NATIVE                       0x08000000
  56 #define LDRP_REDIRECTED                         0x10000000
  57 #define LDRP_NON_PAGED_DEBUG_INFO               0x20000000
  58 #define LDRP_MM_LOADED                          0x40000000
  59 #define LDRP_COMPAT_DATABASE_PROCESSED          0x80000000
  60
  61 //
  62 // Dll Characteristics for LdrLoadDll
  63 //
  64 #define LDR_IGNORE_CODE_AUTHZ_LEVEL                 0x00001000
  65
  66 //
  67 // LdrAddRef Flags
  68 //
  69 #define LDR_ADDREF_DLL_PIN                          0x00000001
  70
  71 //
  72 // LdrLockLoaderLock Flags
  73 //
  74 #define LDR_LOCK_LOADER_LOCK_FLAG_RAISE_ON_ERRORS   0x00000001
  75 #define LDR_LOCK_LOADER_LOCK_FLAG_TRY_ONLY          0x00000002
  76
  77 //
  78 // LdrUnlockLoaderLock Flags
  79 //
  80 #define LDR_UNLOCK_LOADER_LOCK_FLAG_RAISE_ON_ERRORS 0x00000001
  81
  82 //
  83 // LdrGetDllHandleEx Flags
  84 //
  85 #define LDR_GET_DLL_HANDLE_EX_UNCHANGED_REFCOUNT    0x00000001
  86 #define LDR_GET_DLL_HANDLE_EX_PIN                   0x00000002
  87
  88
  89 #define LDR_LOCK_LOADER_LOCK_DISPOSITION_INVALID           0
  90 #define LDR_LOCK_LOADER_LOCK_DISPOSITION_LOCK_ACQUIRED     1
  91 #define LDR_LOCK_LOADER_LOCK_DISPOSITION_LOCK_NOT_ACQUIRED 2
  92
  93 //
  94 // FIXME: THIS SHOULD *NOT* BE USED!
  95 //
  96 #define IMAGE_SCN_TYPE_NOLOAD                   0x00000002
  97
  98 //
  99 // Loader datafile/imagemapping macros
 100 //
 101 #define LDR_IS_DATAFILE(handle)     (((ULONG_PTR)(handle)) & (ULONG_PTR)1)
 102 #define LDR_IS_IMAGEMAPPING(handle) (((ULONG_PTR)(handle)) & (ULONG_PTR)2)
 103 #define LDR_IS_RESOURCE(handle)     (LDR_IS_IMAGEMAPPING(handle) || LDR_IS_DATAFILE(handle))
 104
 105 //
 106 // Loader Data stored in the PEB
 107 //
 108 typedef struct _PEB_LDR_DATA
 109 {
 110     ULONG Length;
 111     BOOLEAN Initialized;
 112     PVOID SsHandle;
 113     LIST_ENTRY InLoadOrderModuleList;
 114     LIST_ENTRY InMemoryOrderModuleList;
 115     LIST_ENTRY InInitializationOrderModuleList;
 116     PVOID EntryInProgress;
 117 #if (NTDDI_VERSION >= NTDDI_WIN7)
 118     UCHAR ShutdownInProgress;
 119     PVOID ShutdownThreadId;
 120 #endif
 121 } PEB_LDR_DATA, *PPEB_LDR_DATA;
 122
 123 //
 124 // Loader Data Table Entry
 125 //
 126 typedef struct _LDR_DATA_TABLE_ENTRY
 127 {
 128     LIST_ENTRY InLoadOrderLinks;
 129     LIST_ENTRY InMemoryOrderModuleList;
 130     LIST_ENTRY InInitializationOrderModuleList;
 131     PVOID DllBase;
 132     PVOID EntryPoint;
 133     ULONG SizeOfImage;
 134     UNICODE_STRING FullDllName;
 135     UNICODE_STRING BaseDllName;
 136     ULONG Flags;
 137     USHORT LoadCount;
 138     USHORT TlsIndex;
 139     union
 140     {
 141         LIST_ENTRY HashLinks;
 142         struct
 143         {
 144             PVOID SectionPointer;
 145             ULONG CheckSum;
 146         };
 147     };
 148     union
 149     {
 150         ULONG TimeDateStamp;
 151         PVOID LoadedImports;
 152     };
 153     PVOID EntryPointActivationContext;
 154     PVOID PatchInformation;
 155 } LDR_DATA_TABLE_ENTRY, *PLDR_DATA_TABLE_ENTRY;
 156
 157 //
 158 // Loaded Imports Reference Counting in Kernel
 159 //
 160 typedef struct _LOAD_IMPORTS
 161 {
 162     SIZE_T Count;
 163     PLDR_DATA_TABLE_ENTRY Entry[1];
 164 } LOAD_IMPORTS, *PLOAD_IMPORTS;
 165
 166 //
 167 // Loader Resource Information
 168 //
 169 typedef struct _LDR_RESOURCE_INFO
 170 {
 171     ULONG_PTR Type;
 172     ULONG_PTR Name;
 173     ULONG_PTR Language;
 174 } LDR_RESOURCE_INFO, *PLDR_RESOURCE_INFO;
 175
 176 typedef struct _LDR_ENUM_RESOURCE_INFO
 177 {
 178     ULONG_PTR Type;
 179     ULONG_PTR Name;
 180     ULONG_PTR Language;
 181     PVOID Data;
 182     SIZE_T Size;
 183     ULONG_PTR Reserved;
 184 } LDR_ENUM_RESOURCE_INFO, *PLDR_ENUM_RESOURCE_INFO;
 185
 186 //
 187 // DLL Notifications
 188 //
 189 typedef struct _LDR_DLL_LOADED_NOTIFICATION_DATA
 190 {
 191     ULONG Flags;
 192     PUNICODE_STRING FullDllName;
 193     PUNICODE_STRING BaseDllName;
 194     PVOID DllBase;
 195     ULONG SizeOfImage;
 196 } LDR_DLL_LOADED_NOTIFICATION_DATA, *PLDR_DLL_LOADED_NOTIFICATION_DATA;
 197
 198 typedef VOID
 199 (NTAPI *PLDR_DLL_LOADED_NOTIFICATION_CALLBACK)(
 200     IN BOOLEAN Type,
 201     IN struct _LDR_DLL_LOADED_NOTIFICATION_DATA *Data
 202 );
 203
 204 typedef struct _LDR_DLL_LOADED_NOTIFICATION_ENTRY
 205 {
 206     LIST_ENTRY NotificationListEntry;
 207     PLDR_DLL_LOADED_NOTIFICATION_CALLBACK Callback;
 208 } LDR_DLL_LOADED_NOTIFICATION_ENTRY, *PLDR_DLL_LOADED_NOTIFICATION_ENTRY;
 209
 210 //
 211 // Alternate Resources Support
 212 //
 213 typedef struct _ALT_RESOURCE_MODULE
 214 {
 215     LANGID LangId;
 216     PVOID ModuleBase;
 217 #if (NTDDI_VERSION >= NTDDI_LONGHORN)
 218     PVOID ModuleManifest;
 219 #endif
 220     PVOID AlternateModule;
 221 #if (NTDDI_VERSION >= NTDDI_LONGHORN)
 222     HANDLE AlternateFileHandle;
 223     ULONG ModuleCheckSum;
 224     ULONG ErrorCode;
 225 #endif
 226 } ALT_RESOURCE_MODULE, *PALT_RESOURCE_MODULE;
 227
 228 //
 229 // Callback function for LdrEnumerateLoadedModules
 230 //
 231 typedef VOID (NTAPI LDR_ENUM_CALLBACK)(IN PLDR_DATA_TABLE_ENTRY ModuleInformation, IN PVOID Parameter, OUT BOOLEAN *Stop);
 232 typedef LDR_ENUM_CALLBACK *PLDR_ENUM_CALLBACK;
 233
 234 //
 235 // DLL Main Routine
 236 //
 237 typedef BOOLEAN
 238 (NTAPI *PDLL_INIT_ROUTINE)(
 239     IN PVOID DllHandle,
 240     IN ULONG Reason,
 241     IN PCONTEXT Context OPTIONAL
 242 );
 243
 244 #endif