tools/winedump/winedump.h

   1 /*
   2  *  Winedump - A Wine DLL tool
   3  *
   4  *  Copyright 2000 Jon Griffiths
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  *
  20  *  References:
  21  *  DLL symbol extraction based on file format from alib (anthonyw.cjb.net).
  22  *
  23  *  Option processing shamelessly cadged from winebuild.
  24  *
  25  *  All the cool functionality (prototyping, call tracing, forwarding)
  26  *  relies on Patrik Stridvall's 'function_grep.pl' script to work.
  27  *
  28  *  http://msdn.microsoft.com/library/periodic/period96/msj/S330.htm
  29  *  This article provides both a description and freely downloadable
  30  *  implementation, in source code form, of how to extract symbols
  31  *  from Win32 PE executables/DLLs.
  32  *
  33  *  http://www.kegel.com/mangle.html
  34  *  Gives information on the name mangling scheme used by MS compilers,
  35  *  used as the starting point for the code here. Contains a few
  36  *  mistakes and some incorrect assumptions, but the lists of types
  37  *  are pure gold.
  38  */
  39 #ifndef __WINE_WINEDUMP_H
  40 #define __WINE_WINEDUMP_H
  41
  42 #include <stdlib.h>
  43 #include <stdio.h>
  44 #include <string.h>
  45 #include <ctype.h>
  46 #include <errno.h>
  47 #include <assert.h>
  48 #include <stdarg.h>
  49
  50 #define NONAMELESSUNION
  51 #define NONAMELESSSTRUCT
  52 #include "windef.h"
  53 #include "winbase.h"
  54
  55 /* Argument type constants */
  56 #define MAX_FUNCTION_ARGS   32
  57
  58 #define ARG_VOID            0x0
  59 #define ARG_STRING          0x1
  60 #define ARG_WIDE_STRING     0x2
  61 #define ARG_POINTER         0x3
  62 #define ARG_LONG            0x4
  63 #define ARG_DOUBLE          0x5
  64 #define ARG_STRUCT          0x6 /* By value */
  65 #define ARG_FLOAT           0x7
  66 #define ARG_VARARGS         0x8
  67
  68 /* Compound type flags */
  69 #define CT_BY_REFERENCE     0x1
  70 #define CT_VOLATILE         0x2
  71 #define CT_CONST            0x4
  72 #define CT_EXTENDED         0x8
  73
  74 /* symbol flags */
  75 #define SYM_CDECL           0x1
  76 #define SYM_STDCALL         0x2
  77 #define SYM_THISCALL        0x4
  78 #define SYM_DATA            0x8 /* Data, not a function */
  79
  80 typedef enum {NONE, DMGL, SPEC, DUMP} Mode;
  81
  82 /* Structure holding a parsed symbol */
  83 typedef struct __parsed_symbol
  84 {
  85   char *symbol;
  86   int   ordinal;
  87   char *return_text;
  88   char  return_type;
  89   char *function_name;
  90   int varargs;
  91   unsigned int argc;
  92   unsigned int flags;
  93   char  arg_type [MAX_FUNCTION_ARGS];
  94   char  arg_flag [MAX_FUNCTION_ARGS];
  95   char *arg_text [MAX_FUNCTION_ARGS];
  96   char *arg_name [MAX_FUNCTION_ARGS];
  97 } parsed_symbol;
  98
  99 /* FIXME: Replace with some hash such as GHashTable */
 100 typedef struct __search_symbol
 101 {
 102   struct __search_symbol *next;
 103   int found;
 104   char symbolname[1];    /* static string, be ANSI C compliant by [1] */
 105 } search_symbol;
 106
 107 /* All globals */
 108 typedef struct __globals
 109 {
 110   Mode  mode;              /* SPEC, DEMANGLE or DUMP */
 111
 112   /* Options: generic */
 113   int   do_quiet;          /* -q */
 114   int   do_verbose;        /* -v */
 115
 116   /* Option arguments: generic */
 117   const char *input_name;  /* */
 118   const char *input_module; /* input module name generated after input_name according mode */
 119
 120   /* Options: spec mode */
 121   int   do_code;           /* -c, -t, -f */
 122   int   do_trace;          /* -t, -f */
 123   int   do_cdecl;          /* -C */
 124   int   do_documentation;  /* -D */
 125
 126   /* Options: dump mode */
 127   int   do_demangle;        /* -d */
 128   int   do_dumpheader;      /* -f */
 129   int   do_dump_rawdata;    /* -x */
 130   int   do_debug;           /* -G == 1, -g == 2 */
 131
 132   /* Option arguments: spec mode */
 133   int   start_ordinal;     /* -s */
 134   int   end_ordinal;       /* -e */
 135   search_symbol *search_symbol; /* -S */
 136   char *directory;         /* -I */
 137   const char *forward_dll; /* -f */
 138   const char *dll_name;    /* -o */
 139   const char *uc_dll_name;       /* -o */
 140
 141   /* Option arguments: dump mode */
 142   const char *dumpsect;    /* -j */
 143
 144   /* internal options */
 145   int   do_ordinals;
 146 } _globals;
 147
 148 extern _globals globals;
 149
 150 /* Names to use for output DLL */
 151 #define OUTPUT_DLL_NAME \
 152           (globals.dll_name ? globals.dll_name : (globals.input_module ? globals.input_module : globals.input_name))
 153 #define OUTPUT_UC_DLL_NAME globals.uc_dll_name
 154
 155 /* Verbosity levels */
 156 #define QUIET   (globals.do_quiet)
 157 #define NORMAL  (!QUIET)
 158 #define VERBOSE (globals.do_verbose)
 159
 160 /* Default calling convention */
 161 #define CALLING_CONVENTION (globals.do_cdecl ? SYM_CDECL : SYM_STDCALL)
 162
 163 /* Image functions */
 164 void    dump_file(const char* name);
 165
 166 /* DLL functions */
 167 int   dll_open (const char *dll_name);
 168
 169 int   dll_next_symbol (parsed_symbol * sym);
 170
 171 /* Symbol functions */
 172 int   symbol_init(parsed_symbol* symbol, const char* name);
 173
 174 int   symbol_demangle (parsed_symbol *symbol);
 175
 176 int   symbol_search (parsed_symbol *symbol);
 177
 178 void  symbol_clear(parsed_symbol *sym);
 179
 180 int   symbol_is_valid_c(const parsed_symbol *sym);
 181
 182 const char *symbol_get_call_convention(const parsed_symbol *sym);
 183
 184 const char *symbol_get_spec_type (const parsed_symbol *sym, size_t arg);
 185
 186 void  symbol_clean_string (const char *string);
 187
 188 int   symbol_get_type (const char *string);
 189
 190 /* Output functions */
 191 void  output_spec_preamble (void);
 192
 193 void  output_spec_symbol (const parsed_symbol *sym);
 194
 195 void  output_header_preamble (void);
 196
 197 void  output_header_symbol (const parsed_symbol *sym);
 198
 199 void  output_c_preamble (void);
 200
 201 void  output_c_symbol (const parsed_symbol *sym);
 202
 203 void  output_prototype (FILE *file, const parsed_symbol *sym);
 204
 205 void  output_makefile (void);
 206
 207 /* Misc functions */
 208 char *str_create (size_t num_str, ...);
 209
 210 char *str_create_num (size_t num_str, int num, ...);
 211
 212 char *str_substring(const char *start, const char *end);
 213
 214 char *str_replace (char *str, const char *oldstr, const char *newstr);
 215
 216 const char *str_match (const char *str, const char *match, int *found);
 217
 218 const char *str_find_set (const char *str, const char *findset);
 219
 220 char *str_toupper (char *str);
 221
 222 const char *get_machine_str(int mach);
 223
 224 /* file dumping functions */
 225 enum FileSig {SIG_UNKNOWN, SIG_DOS, SIG_PE, SIG_DBG, SIG_PDB, SIG_NE, SIG_LE, SIG_MDMP, SIG_COFFLIB, SIG_LNK, SIG_EMF};
 226
 227 const void*     PRD(unsigned long prd, unsigned long len);
 228 unsigned long   Offset(const void* ptr);
 229
 230 typedef void (*file_dumper)(void);
 231 int             dump_analysis(const char*, file_dumper, enum FileSig);
 232
 233 void            dump_data( const unsigned char *ptr, unsigned int size, const char *prefix );
 234 const char*     get_time_str( unsigned long );
 235 unsigned int    strlenW( const unsigned short *str );
 236 void            dump_unicode_str( const unsigned short *str, int len );
 237 const char*     get_guid_str(const GUID* guid);
 238 const char*     get_symbol_str(const char* symname);
 239 void            dump_file_header(const IMAGE_FILE_HEADER *);
 240 void            dump_optional_header(const IMAGE_OPTIONAL_HEADER32 *, UINT);
 241 void            dump_section(const IMAGE_SECTION_HEADER *);
 242
 243 enum FileSig    get_kind_exec(void);
 244 void            dos_dump( void );
 245 void            pe_dump( void );
 246 void            ne_dump( void );
 247 void            le_dump( void );
 248 enum FileSig    get_kind_mdmp(void);
 249 void            mdmp_dump( void );
 250 enum FileSig    get_kind_lib(void);
 251 void            lib_dump( void );
 252 enum FileSig    get_kind_dbg(void);
 253 void            dbg_dump( void );
 254 enum FileSig    get_kind_lnk(void);
 255 void            lnk_dump( void );
 256 enum FileSig    get_kind_emf(void);
 257 void            emf_dump( void );
 258 enum FileSig    get_kind_pdb(void);
 259 void            pdb_dump(void);
 260 int             codeview_dump_symbols(const void* root, unsigned long size);
 261 int             codeview_dump_types_from_offsets(const void* table, const DWORD* offsets, unsigned num_types);
 262 int             codeview_dump_types_from_block(const void* table, unsigned long len);
 263
 264 void            dump_stabs(const void* pv_stabs, unsigned szstabs, const char* stabstr, unsigned szstr);
 265 void            dump_codeview(unsigned long ptr, unsigned long len);
 266 void            dump_coff(unsigned long coffbase, unsigned long len, const void* sect_map);
 267 void            dump_frame_pointer_omission(unsigned long base, unsigned long len);
 268
 269 FILE *open_file (const char *name, const char *ext, const char *mode);
 270
 271 #ifdef __GNUC__
 272 void  do_usage (void) __attribute__ ((noreturn));
 273 void  fatal (const char *message)  __attribute__ ((noreturn));
 274 #else
 275 void  do_usage (void);
 276 void  fatal (const char *message);
 277 #endif
 278
 279
 280
 281 #endif /* __WINE_WINEDUMP_H */