reactos/include/imagehlp.h

   1 /*
   2         imagehlp.h - Include file for IMAGEHLP.DLL APIs
   3
   4         Written by Mumit Khan <khan@nanotech.wisc.edu>
   5
   6         This file is part of a free library for the Win32 API.
   7
   8         NOTE: This strictly does not belong in the Win32 API since it's
   9         really part of Platform SDK. However,GDB needs it and we might
  10         as well provide it here.
  11
  12         This library is distributed in the hope that it will be useful,
  13         but WITHOUT ANY WARRANTY; without even the implied warranty of
  14         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  15
  16 */
  17
  18 #ifndef _IMAGEHLP_H
  19 #define _IMAGEHLP_H
  20 #if __GNUC__ >=3
  21 #pragma GCC system_header
  22 #endif
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 #define API_VERSION_NUMBER 7
  29 #define BIND_NO_BOUND_IMPORTS 0x00000001
  30 #define BIND_NO_UPDATE 0x00000002
  31 #define BIND_ALL_IMAGES 0x00000004
  32 #define BIND_CACHE_IMPORT_DLLS 0x00000008
  33 #define CBA_DEFERRED_SYMBOL_LOAD_START 1
  34 #define CBA_DEFERRED_SYMBOL_LOAD_COMPLETE 2
  35 #define CBA_DEFERRED_SYMBOL_LOAD_FAILURE 3
  36 #define CBA_SYMBOLS_UNLOADED 4
  37 #define CBA_DUPLICATE_SYMBOL 5
  38 #define CERT_PE_IMAGE_DIGEST_DEBUG_INFO 1
  39 #define CERT_PE_IMAGE_DIGEST_RESOURCES 2
  40 #define CERT_PE_IMAGE_DIGEST_ALL_IMPORT_INFO 4
  41 #define CERT_PE_IMAGE_DIGEST_NON_PE_INFO 8
  42 #define CERT_SECTION_TYPE_ANY 255
  43 #define CHECKSUM_SUCCESS        0
  44 #define CHECKSUM_OPEN_FAILURE   1
  45 #define CHECKSUM_MAP_FAILURE    2
  46 #define CHECKSUM_MAPVIEW_FAILURE        3
  47 #define CHECKSUM_UNICODE_FAILURE        4
  48 #define IMAGE_SEPARATION        65536
  49 #define SPLITSYM_REMOVE_PRIVATE 1
  50 #define SPLITSYM_EXTRACT_ALL    2
  51 #define SPLITSYM_SYMBOLPATH_IS_SRC      4
  52 #define SYMF_OMAP_GENERATED     1
  53 #define SYMF_OMAP_MODIFIED      2
  54 #define SYMOPT_CASE_INSENSITIVE 1
  55 #define SYMOPT_UNDNAME  2
  56 #define SYMOPT_DEFERRED_LOADS   4
  57 #define SYMOPT_NO_CPP   8
  58 #define SYMOPT_LOAD_LINES       16
  59 #define SYMOPT_OMAP_FIND_NEAREST        32
  60 #define UNDNAME_COMPLETE        0
  61 #define UNDNAME_NO_LEADING_UNDERSCORES  1
  62 #define UNDNAME_NO_MS_KEYWORDS  2
  63 #define UNDNAME_NO_FUNCTION_RETURNS     4
  64 #define UNDNAME_NO_ALLOCATION_MODEL     8
  65 #define UNDNAME_NO_ALLOCATION_LANGUAGE  16
  66 #define UNDNAME_NO_MS_THISTYPE  32
  67 #define UNDNAME_NO_CV_THISTYPE  64
  68 #define UNDNAME_NO_THISTYPE     96
  69 #define UNDNAME_NO_ACCESS_SPECIFIERS    128
  70 #define UNDNAME_NO_THROW_SIGNATURES     256
  71 #define UNDNAME_NO_MEMBER_TYPE  512
  72 #define UNDNAME_NO_RETURN_UDT_MODEL     1024
  73 #define UNDNAME_32_BIT_DECODE   2048
  74 #define UNDNAME_NAME_ONLY       4096
  75 #define UNDNAME_NO_ARGUMENTS    8192
  76 #define UNDNAME_NO_SPECIAL_SYMS 16384
  77
  78 #ifdef _IMAGEHLP_SOURCE_
  79     #define IMAGEAPI __stdcall
  80     #define DBHLP_DEPRECIATED
  81 #else
  82     #define IMAGEAPI DECLSPEC_IMPORT __stdcall
  83     #if (_MSC_VER >= 1300) && !defined(MIDL_PASS)
  84         #define DBHLP_DEPRECIATED __declspec(deprecated)
  85     #else
  86         #define DBHLP_DEPRECIATED
  87     #endif
  88 #endif
  89
  90 #define DBHLPAPI IMAGEAPI
  91
  92 #ifndef RC_INVOKED
  93
  94 typedef enum _IMAGEHLP_STATUS_REASON {
  95         BindOutOfMemory,
  96         BindRvaToVaFailed,
  97         BindNoRoomInImage,
  98         BindImportModuleFailed,
  99         BindImportProcedureFailed,
 100         BindImportModule,
 101         BindImportProcedure,
 102         BindForwarder,
 103         BindForwarderNOT,
 104         BindImageModified,
 105         BindExpandFileHeaders,
 106         BindImageComplete,
 107         BindMismatchedSymbols,
 108         BindSymbolsNotUpdated
 109 } IMAGEHLP_STATUS_REASON;
 110 typedef BOOL(STDCALL*PIMAGEHLP_STATUS_ROUTINE)(IMAGEHLP_STATUS_REASON,LPSTR,LPSTR,ULONG,ULONG);
 111 typedef struct _LOADED_IMAGE {
 112         LPSTR ModuleName;
 113         HANDLE hFile;
 114         PUCHAR MappedAddress;
 115         PIMAGE_NT_HEADERS FileHeader;
 116         PIMAGE_SECTION_HEADER LastRvaSection;
 117         ULONG NumberOfSections;
 118         PIMAGE_SECTION_HEADER Sections;
 119         ULONG Characteristics;
 120         BOOLEAN fSystemImage;
 121         BOOLEAN fDOSImage;
 122         LIST_ENTRY Links;
 123         ULONG SizeOfImage;
 124 } LOADED_IMAGE,*PLOADED_IMAGE;
 125 typedef struct _IMAGE_DEBUG_INFORMATION {
 126         LIST_ENTRY List;
 127         DWORD Size;
 128         PVOID MappedBase;
 129         USHORT Machine;
 130         USHORT Characteristics;
 131         DWORD CheckSum;
 132         DWORD ImageBase;
 133         DWORD SizeOfImage;
 134         DWORD NumberOfSections;
 135         PIMAGE_SECTION_HEADER Sections;
 136         DWORD ExportedNamesSize;
 137         LPSTR ExportedNames;
 138         DWORD NumberOfFunctionTableEntries;
 139         PIMAGE_FUNCTION_ENTRY FunctionTableEntries;
 140         DWORD LowestFunctionStartingAddress;
 141         DWORD HighestFunctionEndingAddress;
 142         DWORD NumberOfFpoTableEntries;
 143         PFPO_DATA FpoTableEntries;
 144         DWORD SizeOfCoffSymbols;
 145         PIMAGE_COFF_SYMBOLS_HEADER CoffSymbols;
 146         DWORD SizeOfCodeViewSymbols;
 147         PVOID CodeViewSymbols;
 148         LPSTR ImageFilePath;
 149         LPSTR ImageFileName;
 150         LPSTR DebugFilePath;
 151         DWORD TimeDateStamp;
 152         BOOL RomImage;
 153         PIMAGE_DEBUG_DIRECTORY DebugDirectory;
 154         DWORD NumberOfDebugDirectories;
 155         DWORD Reserved[3];
 156 } IMAGE_DEBUG_INFORMATION,*PIMAGE_DEBUG_INFORMATION;
 157 typedef enum {
 158         AddrMode1616,
 159         AddrMode1632,
 160         AddrModeReal,
 161         AddrModeFlat
 162 } ADDRESS_MODE;
 163 typedef struct _tagADDRESS {
 164         DWORD Offset;
 165         WORD Segment;
 166         ADDRESS_MODE Mode;
 167 } ADDRESS,*LPADDRESS;
 168 typedef struct _KDHELP {
 169         DWORD Thread;
 170         DWORD ThCallbackStack;
 171         DWORD NextCallback;
 172         DWORD FramePointer;
 173         DWORD KiCallUserMode;
 174         DWORD KeUserCallbackDispatcher;
 175         DWORD SystemRangeStart;
 176 } KDHELP,*PKDHELP;
 177 typedef struct _tagSTACKFRAME {
 178         ADDRESS AddrPC;
 179         ADDRESS AddrReturn;
 180         ADDRESS AddrFrame;
 181         ADDRESS AddrStack;
 182         LPVOID FuncTableEntry;
 183         DWORD Params[4];
 184         BOOL Far;
 185         BOOL Virtual;
 186         DWORD Reserved[3];
 187         KDHELP KdHelp;
 188 } STACKFRAME,*LPSTACKFRAME;
 189 typedef BOOL(STDCALL*PREAD_PROCESS_MEMORY_ROUTINE)(HANDLE ,LPCVOID,LPVOID,DWORD,LPDWORD);
 190 typedef LPVOID(STDCALL*PFUNCTION_TABLE_ACCESS_ROUTINE)(HANDLE,DWORD);
 191 typedef DWORD(STDCALL*PGET_MODULE_BASE_ROUTINE)(HANDLE,DWORD);
 192 typedef DWORD(STDCALL*PTRANSLATE_ADDRESS_ROUTINE)(HANDLE,HANDLE,LPADDRESS);
 193 typedef struct API_VERSION {
 194         USHORT MajorVersion;
 195         USHORT MinorVersion;
 196         USHORT Revision;
 197         USHORT Reserved;
 198 } API_VERSION,*LPAPI_VERSION;
 199 typedef BOOL(CALLBACK*PSYM_ENUMMODULES_CALLBACK)(LPSTR,ULONG,PVOID);
 200 typedef BOOL(CALLBACK*PSYM_ENUMSYMBOLS_CALLBACK)(LPSTR,ULONG,ULONG,PVOID);
 201 typedef BOOL(CALLBACK*PENUMLOADED_MODULES_CALLBACK)(LPSTR,ULONG,ULONG,PVOID);
 202 typedef BOOL(CALLBACK*PSYMBOL_REGISTERED_CALLBACK)(HANDLE,ULONG,PVOID,PVOID);
 203 typedef enum {
 204         SymNone,
 205         SymCoff,
 206         SymCv,
 207         SymPdb,
 208         SymExport,
 209         SymDeferred,
 210         SymSym
 211 } SYM_TYPE;
 212 typedef struct _IMAGEHLP_SYMBOL {
 213         DWORD SizeOfStruct;
 214         DWORD Address;
 215         DWORD Size;
 216         DWORD Flags;
 217         DWORD MaxNameLength;
 218         CHAR Name[1];
 219 } IMAGEHLP_SYMBOL,*PIMAGEHLP_SYMBOL;
 220 typedef struct _IMAGEHLP_MODULE {
 221         DWORD SizeOfStruct;
 222         DWORD BaseOfImage;
 223         DWORD ImageSize;
 224         DWORD TimeDateStamp;
 225         DWORD CheckSum;
 226         DWORD NumSyms;
 227         SYM_TYPE SymType;
 228         CHAR ModuleName[32];
 229         CHAR ImageName[256];
 230         CHAR LoadedImageName[256];
 231 } IMAGEHLP_MODULE,*PIMAGEHLP_MODULE;
 232 typedef struct _IMAGEHLP_LINE {
 233         DWORD SizeOfStruct;
 234         DWORD Key;
 235         DWORD LineNumber;
 236         PCHAR FileName;
 237         DWORD Address;
 238 } IMAGEHLP_LINE,*PIMAGEHLP_LINE;
 239 typedef struct _IMAGEHLP_DEFERRED_SYMBOL_LOAD {
 240         DWORD SizeOfStruct;
 241         DWORD BaseOfImage;
 242         DWORD CheckSum;
 243         DWORD TimeDateStamp;
 244         CHAR FileName[MAX_PATH];
 245         BOOLEAN Reparse;
 246 } IMAGEHLP_DEFERRED_SYMBOL_LOAD,*PIMAGEHLP_DEFERRED_SYMBOL_LOAD;
 247 typedef struct _IMAGEHLP_DUPLICATE_SYMBOL {
 248         DWORD SizeOfStruct;
 249         DWORD NumberOfDups;
 250         PIMAGEHLP_SYMBOL Symbol;
 251         ULONG SelectedSymbol;
 252 } IMAGEHLP_DUPLICATE_SYMBOL,*PIMAGEHLP_DUPLICATE_SYMBOL;
 253 typedef PVOID DIGEST_HANDLE;
 254 typedef BOOL(WINAPI*DIGEST_FUNCTION)(DIGEST_HANDLE refdata,PBYTE pData,DWORD dwLength);
 255
 256 PIMAGE_NT_HEADERS IMAGEAPI CheckSumMappedFile(LPVOID,DWORD,LPDWORD,LPDWORD);
 257 DWORD IMAGEAPI MapFileAndCheckSumA(LPSTR,LPDWORD,LPDWORD);
 258 DWORD IMAGEAPI MapFileAndCheckSumW(PWSTR,LPDWORD,LPDWORD);
 259 BOOL IMAGEAPI TouchFileTimes(HANDLE,LPSYSTEMTIME);
 260 BOOL IMAGEAPI SplitSymbols(LPSTR,LPSTR,LPSTR,DWORD);
 261 HANDLE IMAGEAPI FindDebugInfoFile(LPSTR,LPSTR,LPSTR);
 262 HANDLE IMAGEAPI FindExecutableImage(LPSTR,LPSTR,LPSTR);
 263 BOOL IMAGEAPI UpdateDebugInfoFile(LPSTR,LPSTR,LPSTR,PIMAGE_NT_HEADERS);
 264 BOOL IMAGEAPI UpdateDebugInfoFileEx(LPSTR,LPSTR,LPSTR,PIMAGE_NT_HEADERS,DWORD);
 265 BOOL IMAGEAPI BindImage(IN LPSTR,IN LPSTR,IN LPSTR);
 266 BOOL IMAGEAPI BindImageEx(IN DWORD,IN LPSTR,IN LPSTR,IN LPSTR,IN PIMAGEHLP_STATUS_ROUTINE);
 267 BOOL IMAGEAPI ReBaseImage(IN LPSTR,IN LPSTR,IN BOOL, IN BOOL,IN BOOL, IN ULONG, OUT ULONG*, OUT ULONG*, OUT ULONG*, IN OUT ULONG*, IN ULONG);
 268
 269 PLOADED_IMAGE IMAGEAPI ImageLoad(LPSTR,LPSTR);
 270 BOOL IMAGEAPI ImageUnload(PLOADED_IMAGE);
 271 PIMAGE_NT_HEADERS IMAGEAPI ImageNtHeader(IN PVOID);
 272 PVOID IMAGEAPI ImageDirectoryEntryToData(IN PVOID,IN BOOLEAN,IN USHORT,OUT PULONG);
 273 PVOID IMAGEAPI ImageDirectoryEntryToDataEx(IN PVOID Base, IN BOOLEAN MappedAsImage, IN USHORT DirectoryEntry, OUT PULONG Size, OUT PIMAGE_SECTION_HEADER *FoundSection OPTIONAL);
 274 PVOID IMAGEAPI ImageDirectoryEntryToData32(PVOID Base, BOOLEAN MappedAsImage, USHORT DirectoryEntry, PULONG Size, PIMAGE_SECTION_HEADER *FoundHeader OPTIONAL, PIMAGE_FILE_HEADER FileHeader, PIMAGE_OPTIONAL_HEADER OptionalHeader);
 275 PIMAGE_SECTION_HEADER IMAGEAPI ImageRvaToSection(IN PIMAGE_NT_HEADERS,IN PVOID,IN ULONG);
 276 PVOID IMAGEAPI ImageRvaToVa(IN PIMAGE_NT_HEADERS,IN PVOID,IN ULONG,IN OUT PIMAGE_SECTION_HEADER*);
 277 BOOL IMAGEAPI MapAndLoad(LPSTR,LPSTR,PLOADED_IMAGE,BOOL,BOOL);
 278 BOOL IMAGEAPI GetImageConfigInformation(PLOADED_IMAGE,PIMAGE_LOAD_CONFIG_DIRECTORY);
 279 DWORD IMAGEAPI GetImageUnusedHeaderBytes(PLOADED_IMAGE,LPDWORD);
 280 BOOL IMAGEAPI SetImageConfigInformation(PLOADED_IMAGE,PIMAGE_LOAD_CONFIG_DIRECTORY);
 281 BOOL IMAGEAPI UnMapAndLoad(PLOADED_IMAGE);
 282 PIMAGE_DEBUG_INFORMATION IMAGEAPI MapDebugInformation(HANDLE,LPSTR,LPSTR,DWORD);
 283 BOOL IMAGEAPI UnmapDebugInformation(PIMAGE_DEBUG_INFORMATION);
 284 HANDLE IMAGEAPI FindExecutableImage(LPSTR,LPSTR,LPSTR);
 285 BOOL IMAGEAPI SearchTreeForFile(LPSTR,LPSTR,LPSTR);
 286 BOOL IMAGEAPI MakeSureDirectoryPathExists(LPCSTR);
 287 DWORD IMAGEAPI WINAPI UnDecorateSymbolName(LPCSTR,LPSTR,DWORD, DWORD);
 288 BOOL
 289 IMAGEAPI
 290 StackWalk(DWORD,HANDLE,HANDLE,LPSTACKFRAME,LPVOID,PREAD_PROCESS_MEMORY_ROUTINE,PFUNCTION_TABLE_ACCESS_ROUTINE,PGET_MODULE_BASE_ROUTINE,PTRANSLATE_ADDRESS_ROUTINE);
 291 LPAPI_VERSION IMAGEAPI ImagehlpApiVersion(VOID);
 292 LPAPI_VERSION IMAGEAPI ImagehlpApiVersionEx(LPAPI_VERSION);
 293 DWORD IMAGEAPI GetTimestampForLoadedLibrary(HMODULE);
 294 BOOL IMAGEAPI RemovePrivateCvSymbolic(PCHAR,PCHAR*,ULONG*);
 295 VOID IMAGEAPI RemoveRelocations(PCHAR);
 296 DWORD IMAGEAPI SymSetOptions(IN DWORD);
 297 DWORD IMAGEAPI SymGetOptions(VOID);
 298 BOOL IMAGEAPI SymCleanup(IN HANDLE);
 299 BOOL IMAGEAPI SymEnumerateModules(IN HANDLE,IN PSYM_ENUMMODULES_CALLBACK,IN PVOID);
 300 BOOL IMAGEAPI SymEnumerateSymbols(IN HANDLE,IN DWORD,IN PSYM_ENUMSYMBOLS_CALLBACK,IN PVOID);
 301 BOOL IMAGEAPI EnumerateLoadedModules(IN HANDLE,IN PENUMLOADED_MODULES_CALLBACK,IN PVOID);
 302 LPVOID IMAGEAPI SymFunctionTableAccess(HANDLE,DWORD);
 303 BOOL IMAGEAPI SymGetModuleInfo(IN HANDLE,IN DWORD,OUT PIMAGEHLP_MODULE);
 304 DWORD IMAGEAPI SymGetModuleBase(IN HANDLE,IN DWORD);
 305 BOOL IMAGEAPI SymGetSymFromAddr(IN HANDLE,IN DWORD,OUT PDWORD,OUT PIMAGEHLP_SYMBOL);
 306 BOOL IMAGEAPI SymGetSymFromName(IN HANDLE,IN LPSTR,OUT PIMAGEHLP_SYMBOL);
 307 BOOL IMAGEAPI SymGetSymNext(IN HANDLE,IN OUT PIMAGEHLP_SYMBOL);
 308 BOOL IMAGEAPI SymGetSymPrev(IN HANDLE,IN OUT PIMAGEHLP_SYMBOL);
 309 BOOL IMAGEAPI SymGetLineFromAddr(IN HANDLE,IN DWORD,OUT PDWORD,OUT PIMAGEHLP_LINE);
 310 BOOL IMAGEAPI SymGetLineFromName(IN HANDLE,IN LPSTR,IN LPSTR,IN DWORD,OUT PLONG,IN OUT PIMAGEHLP_LINE);
 311 BOOL IMAGEAPI SymGetLineNext(IN HANDLE,IN OUT PIMAGEHLP_LINE);
 312 BOOL IMAGEAPI SymGetLinePrev(IN HANDLE,IN OUT PIMAGEHLP_LINE);
 313 BOOL IMAGEAPI SymMatchFileName(IN LPSTR,IN LPSTR,OUT LPSTR*,OUT LPSTR*);
 314 BOOL IMAGEAPI SymInitialize(IN HANDLE,IN LPSTR,IN BOOL);
 315 BOOL IMAGEAPI SymGetSearchPath(IN HANDLE,OUT LPSTR,IN DWORD);
 316 BOOL IMAGEAPI SymSetSearchPath(IN HANDLE,IN LPSTR);
 317 DWORD IMAGEAPI SymLoadModule(IN HANDLE,IN HANDLE,IN PSTR,IN PSTR,IN DWORD,IN DWORD);
 318 BOOL IMAGEAPI SymUnloadModule(IN HANDLE,IN DWORD);
 319 BOOL IMAGEAPI SymUnDName(IN PIMAGEHLP_SYMBOL,OUT LPSTR,IN DWORD);
 320 BOOL IMAGEAPI SymRegisterCallback(IN HANDLE,IN PSYMBOL_REGISTERED_CALLBACK,IN PVOID);
 321 BOOL IMAGEAPI ImageGetDigestStream(IN HANDLE,IN DWORD,IN DIGEST_FUNCTION,IN DIGEST_HANDLE);
 322 //BOOL IMAGEAPI ImageAddCertificate(IN HANDLE,IN LPWIN_CERTIFICATE,OUT PDWORD);
 323 BOOL IMAGEAPI ImageRemoveCertificate(IN HANDLE,IN DWORD);
 324 BOOL IMAGEAPI ImageEnumerateCertificates(IN HANDLE,IN WORD,OUT PDWORD,IN OUT PDWORD OPTIONAL,IN OUT DWORD OPTIONAL);
 325 //BOOL IMAGEAPI ImageGetCertificateData(IN HANDLE,IN DWORD,OUT LPWIN_CERTIFICATE,IN OUT PDWORD);
 326 //BOOL IMAGEAPI ImageGetCertificateHeader(IN HANDLE,IN DWORD,IN OUT LPWIN_CERTIFICATE);
 327 BOOL IMAGEAPI CopyPdb(CHAR const*,CHAR const*,BOOL);
 328 BOOL IMAGEAPI RemovePrivateCvSymbolicEx(PCHAR,ULONG,PCHAR*,ULONG*);
 329
 330 #endif /* RC_INVOKED */
 331
 332 #ifdef UNICODE
 333 #define MapFileAndCheckSum MapFileAndCheckSumW
 334 #else
 335 #define MapFileAndCheckSum MapFileAndCheckSumA
 336 #endif
 337
 338 #ifdef __cplusplus
 339 }
 340 #endif
 341
 342 #endif /* _IMAGEHLP_H */
 343