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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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 /* Argument type constants */
  51 #define MAX_FUNCTION_ARGS   32
  52
  53 #define ARG_VOID            0x0
  54 #define ARG_STRING          0x1
  55 #define ARG_WIDE_STRING     0x2
  56 #define ARG_POINTER         0x3
  57 #define ARG_LONG            0x4
  58 #define ARG_DOUBLE          0x5
  59 #define ARG_STRUCT          0x6 /* By value */
  60 #define ARG_FLOAT           0x7
  61 #define ARG_VARARGS         0x8
  62
  63 /* Compound type flags */
  64 #define CT_BY_REFERENCE     0x1
  65 #define CT_VOLATILE         0x2
  66 #define CT_CONST            0x4
  67 #define CT_EXTENDED         0x8
  68
  69 /* symbol flags */
  70 #define SYM_CDECL           0x1
  71 #define SYM_STDCALL         0x2
  72 #define SYM_THISCALL        0x4
  73 #define SYM_DATA            0x8 /* Data, not a function */
  74
  75 typedef enum {NONE, DMGL, SPEC, DUMP, EMF, LNK} Mode;
  76
  77 /* Structure holding a parsed symbol */
  78 typedef struct __parsed_symbol
  79 {
  80   char *symbol;
  81   int   ordinal;
  82   char *return_text;
  83   char  return_type;
  84   char *function_name;
  85   int varargs;
  86   unsigned int argc;
  87   unsigned int flags;
  88   char  arg_type [MAX_FUNCTION_ARGS];
  89   char  arg_flag [MAX_FUNCTION_ARGS];
  90   char *arg_text [MAX_FUNCTION_ARGS];
  91   char *arg_name [MAX_FUNCTION_ARGS];
  92   unsigned int n_u_refs;
  93   char *u_ref    [MAX_FUNCTION_ARGS];
  94 } parsed_symbol;
  95
  96 /* FIXME: Replace with some hash such as GHashTable */
  97 typedef struct __search_symbol
  98 {
  99   struct __search_symbol *next;
 100   int found;
 101   char symbolname[1];    /* static string, be ANSI C compliant by [1] */
 102 } search_symbol;
 103
 104 /* All globals */
 105 typedef struct __globals
 106 {
 107   Mode  mode;              /* SPEC, DEMANGLE or DUMP */
 108
 109   /* Options: generic */
 110   int   do_quiet;          /* -q */
 111   int   do_verbose;        /* -v */
 112
 113   /* Option arguments: generic */
 114   const char *input_name;  /* */
 115   const char *input_module; /* input module name generated after input_name according mode */
 116
 117   /* Options: spec mode */
 118   int   do_code;           /* -c, -t, -f */
 119   int   do_trace;          /* -t, -f */
 120   int   do_cdecl;          /* -C */
 121   int   do_documentation;  /* -D */
 122
 123   /* Options: dump mode */
 124   int   do_demangle;        /* -d */
 125   int   do_dumpheader;      /* -f */
 126
 127   /* Option arguments: spec mode */
 128   int   start_ordinal;     /* -s */
 129   int   end_ordinal;       /* -e */
 130   search_symbol *search_symbol; /* -S */
 131   char *directory;         /* -I */
 132   const char *forward_dll; /* -f */
 133   const char *dll_name;    /* -o */
 134   const char *uc_dll_name;       /* -o */
 135
 136   /* Option arguments: dump mode */
 137   const char *dumpsect;    /* -j */
 138
 139   /* internal options */
 140   int   do_ordinals;
 141 } _globals;
 142
 143 extern _globals globals;
 144
 145 /* Names to use for output DLL */
 146 #define OUTPUT_DLL_NAME \
 147           (globals.dll_name ? globals.dll_name : (globals.input_module ? globals.input_module : globals.input_name))
 148 #define OUTPUT_UC_DLL_NAME globals.uc_dll_name
 149
 150 /* Verbosity levels */
 151 #define QUIET   (globals.do_quiet)
 152 #define NORMAL  (!QUIET)
 153 #define VERBOSE (globals.do_verbose)
 154
 155 /* Default calling convention */
 156 #define CALLING_CONVENTION (globals.do_cdecl ? SYM_CDECL : SYM_STDCALL)
 157
 158 /* EMF functions */
 159 int   dump_emf (const char *emf);
 160
 161 /* LNK functions */
 162 int   dump_lnk (const char *lnk);
 163
 164 /* Image functions */
 165 void    dump_file(const char* name);
 166
 167 /* DLL functions */
 168 int   dll_open (const char *dll_name);
 169
 170 int   dll_next_symbol (parsed_symbol * sym);
 171
 172 /* Symbol functions */
 173 int   symbol_init(parsed_symbol* symbol, const char* name);
 174
 175 int   symbol_demangle (parsed_symbol *symbol);
 176
 177 int   symbol_search (parsed_symbol *symbol);
 178
 179 void  symbol_clear(parsed_symbol *sym);
 180
 181 int   symbol_is_valid_c(const parsed_symbol *sym);
 182
 183 const char *symbol_get_call_convention(const parsed_symbol *sym);
 184
 185 const char *symbol_get_spec_type (const parsed_symbol *sym, size_t arg);
 186
 187 void  symbol_clean_string (const char *string);
 188
 189 int   symbol_get_type (const char *string);
 190
 191 /* Output functions */
 192 void  output_spec_preamble (void);
 193
 194 void  output_spec_symbol (const parsed_symbol *sym);
 195
 196 void  output_header_preamble (void);
 197
 198 void  output_header_symbol (const parsed_symbol *sym);
 199
 200 void  output_c_preamble (void);
 201
 202 void  output_c_symbol (const parsed_symbol *sym);
 203
 204 void  output_prototype (FILE *file, const parsed_symbol *sym);
 205
 206 void  output_makefile (void);
 207
 208 void  output_install_script (void);
 209
 210 /* Misc functions */
 211 char *str_create (size_t num_str, ...);
 212
 213 char *str_create_num (size_t num_str, int num, ...);
 214
 215 char *str_substring(const char *start, const char *end);
 216
 217 char *str_replace (char *str, const char *oldstr, const char *newstr);
 218
 219 const char *str_match (const char *str, const char *match, int *found);
 220
 221 const char *str_find_set (const char *str, const char *findset);
 222
 223 char *str_toupper (char *str);
 224
 225 /* file dumping functions */
 226 enum FileSig {SIG_UNKNOWN, SIG_DOS, SIG_PE, SIG_DBG, SIG_NE, SIG_LE, SIG_MDMP};
 227
 228 void*           PRD(unsigned long prd, unsigned long len);
 229 unsigned long   Offset(void* ptr);
 230
 231 typedef void (*file_dumper)(enum FileSig, void*);
 232 int             dump_analysis(const char*, file_dumper, enum FileSig);
 233
 234 void            dump_data( const unsigned char *ptr, unsigned int size, const char *prefix );
 235 const char*     get_time_str( unsigned long );
 236 unsigned int    strlenW( const unsigned short *str );
 237 void            dump_unicode_str( const unsigned short *str, int len );
 238
 239 void            ne_dump( const void *exe, size_t exe_size );
 240 void            le_dump( const void *exe, size_t exe_size );
 241 void            mdmp_dump( void );
 242
 243 FILE *open_file (const char *name, const char *ext, const char *mode);
 244
 245 #ifdef __GNUC__
 246 void  do_usage (void) __attribute__ ((noreturn));
 247 void  fatal (const char *message)  __attribute__ ((noreturn));
 248 #else
 249 void  do_usage (void);
 250 void  fatal (const char *message);
 251 #endif
 252
 253
 254
 255 #endif /* __WINE_WINEDUMP_H */