reactos/tools/rsym/rsym.h

   1 /* rsym.h */
   2
   3 #ifndef RSYM_H
   4 #define RSYM_H
   5
   6 #define IMAGE_DOS_MAGIC 0x5a4d
   7 #define IMAGE_PE_MAGIC 0x00004550
   8 #define IMAGE_SIZEOF_SHORT_NAME 8
   9
  10 #define IMAGE_FILE_LINE_NUMS_STRIPPED   0x0004
  11 #define IMAGE_FILE_LOCAL_SYMS_STRIPPED  0x0008
  12 #define IMAGE_FILE_DEBUG_STRIPPED   0x0200
  13
  14 #define IMAGE_DIRECTORY_ENTRY_BASERELOC 5
  15
  16 #define IMAGE_SCN_TYPE_NOLOAD     0x00000002
  17 #define IMAGE_SCN_TYPE_NO_PAD     0x00000008
  18 #define IMAGE_SCN_CNT_CODE        0x00000020
  19 #define IMAGE_SCN_CNT_INITIALIZED_DATA    0x00000040
  20 #define IMAGE_SCN_CNT_UNINITIALIZED_DATA  0x00000080
  21 #define IMAGE_SCN_LNK_OTHER       0x00000100
  22 #define IMAGE_SCN_LNK_INFO        0x00000200
  23 #define IMAGE_SCN_LNK_REMOVE      0x00000800
  24 #define IMAGE_SCN_NO_DEFER_SPEC_EXC 0x00004000
  25 #define IMAGE_SCN_GPREL           0x00008000
  26 #define IMAGE_SCN_MEM_PURGEABLE   0x00020000
  27 #define IMAGE_SCN_MEM_LOCKED      0x00040000
  28 #define IMAGE_SCN_MEM_PRELOAD     0x00080000
  29 #define IMAGE_SCN_LNK_NRELOC_OVFL 0x01000000
  30 #define IMAGE_SCN_MEM_DISCARDABLE 0x02000000
  31 #define IMAGE_SCN_MEM_NOT_CACHED  0x04000000
  32 #define IMAGE_SCN_MEM_NOT_PAGED   0x08000000
  33 #define IMAGE_SCN_MEM_SHARED      0x10000000
  34 #define IMAGE_SCN_MEM_EXECUTE     0x20000000
  35 #define IMAGE_SCN_MEM_READ        0x40000000
  36 #define IMAGE_SCN_MEM_WRITE       0x80000000
  37
  38 #define IMAGE_NUMBEROF_DIRECTORY_ENTRIES 16
  39
  40 typedef unsigned char BYTE;
  41 typedef unsigned char UCHAR;
  42 typedef unsigned short WORD;
  43 typedef unsigned short USHORT;
  44 typedef unsigned long long ULONGLONG;
  45 #if defined(__x86_64__) && defined(unix)
  46 typedef signed int LONG;
  47 typedef unsigned int ULONG;
  48 typedef unsigned int DWORD;
  49 #else
  50 typedef signed long LONG;
  51 typedef unsigned long ULONG;
  52 typedef unsigned long DWORD;
  53 #endif
  54 #if defined(_WIN64)
  55 typedef unsigned __int64 ULONG_PTR;
  56 #else
  57 #if defined(__x86_64__) && defined(unix)
  58 typedef  unsigned int  ULONG_PTR;
  59 #else
  60 typedef  unsigned long ULONG_PTR;
  61 #endif
  62 #endif
  63
  64 #pragma pack(push,2)
  65
  66 typedef struct _IMAGE_DOS_HEADER {
  67   WORD e_magic;
  68   WORD e_cblp;
  69   WORD e_cp;
  70   WORD e_crlc;
  71   WORD e_cparhdr;
  72   WORD e_minalloc;
  73   WORD e_maxalloc;
  74   WORD e_ss;
  75   WORD e_sp;
  76   WORD e_csum;
  77   WORD e_ip;
  78   WORD e_cs;
  79   WORD e_lfarlc;
  80   WORD e_ovno;
  81   WORD e_res[4];
  82   WORD e_oemid;
  83   WORD e_oeminfo;
  84   WORD e_res2[10];
  85   LONG e_lfanew;
  86 } IMAGE_DOS_HEADER,*PIMAGE_DOS_HEADER;
  87 #pragma pack(pop)
  88
  89 #pragma pack(push,4)
  90 typedef struct _IMAGE_FILE_HEADER {
  91         WORD Machine;
  92         WORD NumberOfSections;
  93         DWORD TimeDateStamp;
  94         DWORD PointerToSymbolTable;
  95         DWORD NumberOfSymbols;
  96         WORD SizeOfOptionalHeader;
  97         WORD Characteristics;
  98 } IMAGE_FILE_HEADER, *PIMAGE_FILE_HEADER;
  99 #pragma pack(pop)
 100
 101 typedef struct _IMAGE_DATA_DIRECTORY {
 102   DWORD VirtualAddress;
 103   DWORD Size;
 104 } IMAGE_DATA_DIRECTORY,*PIMAGE_DATA_DIRECTORY;
 105
 106 typedef struct _IMAGE_OPTIONAL_HEADER32 {
 107         WORD Magic;
 108         BYTE MajorLinkerVersion;
 109         BYTE MinorLinkerVersion;
 110         DWORD SizeOfCode;
 111         DWORD SizeOfInitializedData;
 112         DWORD SizeOfUninitializedData;
 113         DWORD AddressOfEntryPoint;
 114         DWORD BaseOfCode;
 115         DWORD BaseOfData;
 116         DWORD ImageBase;
 117         DWORD SectionAlignment;
 118         DWORD FileAlignment;
 119         WORD MajorOperatingSystemVersion;
 120         WORD MinorOperatingSystemVersion;
 121         WORD MajorImageVersion;
 122         WORD MinorImageVersion;
 123         WORD MajorSubsystemVersion;
 124         WORD MinorSubsystemVersion;
 125         DWORD Win32VersionValue;
 126         DWORD SizeOfImage;
 127         DWORD SizeOfHeaders;
 128         DWORD CheckSum;
 129         WORD Subsystem;
 130         WORD DllCharacteristics;
 131         DWORD SizeOfStackReserve;
 132         DWORD SizeOfStackCommit;
 133         DWORD SizeOfHeapReserve;
 134         DWORD SizeOfHeapCommit;
 135         DWORD LoaderFlags;
 136         DWORD NumberOfRvaAndSizes;
 137         IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES];
 138 } IMAGE_OPTIONAL_HEADER32,*PIMAGE_OPTIONAL_HEADER32;
 139
 140 typedef struct _IMAGE_OPTIONAL_HEADER64 {
 141         WORD Magic;
 142         BYTE MajorLinkerVersion;
 143         BYTE MinorLinkerVersion;
 144         DWORD SizeOfCode;
 145         DWORD SizeOfInitializedData;
 146         DWORD SizeOfUninitializedData;
 147         DWORD AddressOfEntryPoint;
 148         DWORD BaseOfCode;
 149         ULONGLONG ImageBase;
 150         DWORD SectionAlignment;
 151         DWORD FileAlignment;
 152         WORD MajorOperatingSystemVersion;
 153         WORD MinorOperatingSystemVersion;
 154         WORD MajorImageVersion;
 155         WORD MinorImageVersion;
 156         WORD MajorSubsystemVersion;
 157         WORD MinorSubsystemVersion;
 158         DWORD Win32VersionValue;
 159         DWORD SizeOfImage;
 160         DWORD SizeOfHeaders;
 161         DWORD CheckSum;
 162         WORD Subsystem;
 163         WORD DllCharacteristics;
 164         ULONGLONG SizeOfStackReserve;
 165         ULONGLONG SizeOfStackCommit;
 166         ULONGLONG SizeOfHeapReserve;
 167         ULONGLONG SizeOfHeapCommit;
 168         DWORD LoaderFlags;
 169         DWORD NumberOfRvaAndSizes;
 170         IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES];
 171 } IMAGE_OPTIONAL_HEADER64,*PIMAGE_OPTIONAL_HEADER64;
 172
 173
 174 #ifdef _TARGET_PE64
 175 typedef IMAGE_OPTIONAL_HEADER64 IMAGE_OPTIONAL_HEADER;
 176 typedef PIMAGE_OPTIONAL_HEADER64 PIMAGE_OPTIONAL_HEADER;
 177 #else
 178 typedef IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER;
 179 typedef PIMAGE_OPTIONAL_HEADER32 PIMAGE_OPTIONAL_HEADER;
 180 #endif
 181
 182 typedef struct _IMAGE_SECTION_HEADER {
 183   BYTE Name[IMAGE_SIZEOF_SHORT_NAME];
 184   union {
 185     DWORD PhysicalAddress;
 186     DWORD VirtualSize;
 187   } Misc;
 188   DWORD VirtualAddress;
 189   DWORD SizeOfRawData;
 190   DWORD PointerToRawData;
 191   DWORD PointerToRelocations;
 192   DWORD PointerToLinenumbers;
 193   WORD NumberOfRelocations;
 194   WORD NumberOfLinenumbers;
 195   DWORD Characteristics;
 196 } IMAGE_SECTION_HEADER,*PIMAGE_SECTION_HEADER;
 197
 198 #pragma pack(push,4)
 199 typedef struct _IMAGE_BASE_RELOCATION {
 200         DWORD VirtualAddress;
 201         DWORD SizeOfBlock;
 202     WORD  TypeOffset[1];
 203 } IMAGE_BASE_RELOCATION,*PIMAGE_BASE_RELOCATION;
 204 #pragma pack(pop)
 205
 206 typedef struct {
 207   USHORT f_magic;         /* magic number             */
 208   USHORT f_nscns;         /* number of sections       */
 209   ULONG  f_timdat;        /* time & date stamp        */
 210   ULONG  f_symptr;        /* file pointer to symtab   */
 211   ULONG  f_nsyms;         /* number of symtab entries */
 212   USHORT f_opthdr;        /* sizeof(optional hdr)     */
 213   USHORT f_flags;         /* flags                    */
 214 } FILHDR;
 215
 216 typedef struct {
 217   char           s_name[8];  /* section name                     */
 218   ULONG  s_paddr;    /* physical address, aliased s_nlib */
 219   ULONG  s_vaddr;    /* virtual address                  */
 220   ULONG  s_size;     /* section size                     */
 221   ULONG  s_scnptr;   /* file ptr to raw data for section */
 222   ULONG  s_relptr;   /* file ptr to relocation           */
 223   ULONG  s_lnnoptr;  /* file ptr to line numbers         */
 224   USHORT s_nreloc;   /* number of relocation entries     */
 225   USHORT s_nlnno;    /* number of line number entries    */
 226   ULONG  s_flags;    /* flags                            */
 227 } SCNHDR;
 228 #pragma pack(4)
 229
 230 typedef struct _SYMBOLFILE_HEADER {
 231   ULONG SymbolsOffset;
 232   ULONG SymbolsLength;
 233   ULONG StringsOffset;
 234   ULONG StringsLength;
 235 } SYMBOLFILE_HEADER, *PSYMBOLFILE_HEADER;
 236
 237 typedef struct _STAB_ENTRY {
 238   ULONG n_strx;         /* index into string table of name */
 239   UCHAR n_type;         /* type of symbol */
 240   UCHAR n_other;        /* misc info (usually empty) */
 241   USHORT n_desc;        /* description field */
 242   ULONG n_value;        /* value of symbol */
 243 } STAB_ENTRY, *PSTAB_ENTRY;
 244
 245 /* http://www.math.utah.edu/docs/info/stabs_12.html */
 246 #define N_GYSM   0x20
 247 #define N_FNAME  0x22
 248 #define N_FUN    0x24
 249 #define N_STSYM  0x26
 250 #define N_LCSYM  0x28
 251 #define N_MAIN   0x2A
 252 #define N_PC     0x30
 253 #define N_NSYMS  0x32
 254 #define N_NOMAP  0x34
 255 #define N_RSYM   0x40
 256 #define N_M2C    0x42
 257 #define N_SLINE  0x44
 258 #define N_DSLINE 0x46
 259 #define N_BSLINE 0x48
 260 #define N_BROWS  0x48
 261 #define N_DEFD   0x4A
 262 #define N_EHDECL 0x50
 263 #define N_MOD2   0x50
 264 #define N_CATCH  0x54
 265 #define N_SSYM   0x60
 266 #define N_SO     0x64
 267 #define N_LSYM   0x80
 268 #define N_BINCL  0x82
 269 #define N_SOL    0x84
 270 #define N_PSYM   0xA0
 271 #define N_EINCL  0xA2
 272 #define N_ENTRY  0xA4
 273 #define N_LBRAC  0xC0
 274 #define N_EXCL   0xC2
 275 #define N_SCOPE  0xC4
 276 #define N_RBRAC  0xE0
 277 #define N_BCOMM  0xE2
 278 #define N_ECOMM  0xE4
 279 #define N_ECOML  0xE8
 280 #define N_LENG   0xFE
 281
 282 /* COFF symbol table */
 283
 284 #define E_SYMNMLEN      8       /* # characters in a symbol name        */
 285 #define E_FILNMLEN      14      /* # characters in a file name          */
 286 #define E_DIMNUM        4       /* # array dimensions in auxiliary entry */
 287
 288 #define N_BTMASK        (0xf)
 289 #define N_TMASK         (0x30)
 290 #define N_BTSHFT        (4)
 291 #define N_TSHIFT        (2)
 292
 293 /* derived types, in e_type */
 294 #define DT_NON          (0)     /* no derived type */
 295 #define DT_PTR          (1)     /* pointer */
 296 #define DT_FCN          (2)     /* function */
 297 #define DT_ARY          (3)     /* array */
 298
 299 #define BTYPE(x)        ((x) & N_BTMASK)
 300
 301 #define ISPTR(x)        (((x) & N_TMASK) == (DT_PTR << N_BTSHFT))
 302 #define ISFCN(x)        (((x) & N_TMASK) == (DT_FCN << N_BTSHFT))
 303 #define ISARY(x)        (((x) & N_TMASK) == (DT_ARY << N_BTSHFT))
 304 #define ISTAG(x)        ((x)==C_STRTAG||(x)==C_UNTAG||(x)==C_ENTAG)
 305 #define DECREF(x) ((((x)>>N_TSHIFT)&~N_BTMASK)|((x)&N_BTMASK))
 306
 307 #define C_EFCN          0xff    /* physical end of function     */
 308 #define C_NULL          0
 309 #define C_AUTO          1       /* automatic variable           */
 310 #define C_EXT           2       /* external symbol              */
 311 #define C_STAT          3       /* static                       */
 312 #define C_REG           4       /* register variable            */
 313 #define C_EXTDEF        5       /* external definition          */
 314 #define C_LABEL         6       /* label                        */
 315 #define C_ULABEL        7       /* undefined label              */
 316 #define C_MOS           8       /* member of structure          */
 317 #define C_ARG           9       /* function argument            */
 318 #define C_STRTAG        10      /* structure tag                */
 319 #define C_MOU           11      /* member of union              */
 320 #define C_UNTAG         12      /* union tag                    */
 321 #define C_TPDEF         13      /* type definition              */
 322 #define C_USTATIC       14      /* undefined static             */
 323 #define C_ENTAG         15      /* enumeration tag              */
 324 #define C_MOE           16      /* member of enumeration        */
 325 #define C_REGPARM       17      /* register parameter           */
 326 #define C_FIELD         18      /* bit field                    */
 327 #define C_AUTOARG       19      /* auto argument                */
 328 #define C_LASTENT       20      /* dummy entry (end of block)   */
 329 #define C_BLOCK         100     /* ".bb" or ".eb"               */
 330 #define C_FCN           101     /* ".bf" or ".ef"               */
 331 #define C_EOS           102     /* end of structure             */
 332 #define C_FILE          103     /* file name                    */
 333 #define C_LINE          104     /* line # reformatted as symbol table entry */
 334 #define C_ALIAS         105     /* duplicate tag                */
 335 #define C_HIDDEN        106     /* ext symbol in dmert public lib */
 336
 337 #pragma pack(1)
 338 typedef struct _COFF_SYMENT
 339 {
 340   union
 341     {
 342       char e_name[E_SYMNMLEN];
 343       struct
 344         {
 345           ULONG e_zeroes;
 346           ULONG e_offset;
 347         }
 348       e;
 349     }
 350   e;
 351   ULONG e_value;
 352   short e_scnum;
 353   USHORT e_type;
 354   UCHAR e_sclass;
 355   UCHAR e_numaux;
 356 } COFF_SYMENT, *PCOFF_SYMENT;
 357 #pragma pack(4)
 358
 359 typedef struct _ROSSYM_ENTRY {
 360   ULONG_PTR Address;
 361   ULONG FunctionOffset;
 362   ULONG FileOffset;
 363   ULONG SourceLine;
 364 } ROSSYM_ENTRY, *PROSSYM_ENTRY;
 365
 366 #define ROUND_UP(N, S) (((N) + (S) - 1) & ~((S) - 1))
 367
 368 extern char*
 369 convert_path(const char* origpath);
 370
 371 extern void*
 372 load_file ( const char* file_name, size_t* file_size );
 373
 374 #endif/*RSYM_H*/