winedump.h 8.61 KB
Newer Older
1
/*
2
 *  Winedump - A Wine DLL tool
3 4 5
 *
 *  Copyright 2000 Jon Griffiths
 *
6 7 8 9 10 11 12 13 14 15 16 17
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * 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 21 22
 *  References:
 *  DLL symbol extraction based on file format from alib (anthonyw.cjb.net).
 *
23
 *  Option processing shamelessly cadged from winebuild.
24 25 26 27 28
 *
 *  All the cool functionality (prototyping, call tracing, forwarding)
 *  relies on Patrik Stridvall's 'function_grep.pl' script to work.
 *
 *  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 34 35 36 37 38
 *
 *  http://www.kegel.com/mangle.html
 *  Gives information on the name mangling scheme used by MS compilers,
 *  used as the starting point for the code here. Contains a few
 *  mistakes and some incorrect assumptions, but the lists of types
 *  are pure gold.
 */
39 40
#ifndef __WINE_WINEDUMP_H
#define __WINE_WINEDUMP_H
41 42 43 44 45 46 47 48 49

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include <errno.h>
#include <assert.h>
#include <stdarg.h>

50 51 52 53 54
#define NONAMELESSUNION
#define NONAMELESSSTRUCT
#include "windef.h"
#include "winbase.h"

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
/* Argument type constants */
#define MAX_FUNCTION_ARGS   32

#define ARG_VOID            0x0
#define ARG_STRING          0x1
#define ARG_WIDE_STRING     0x2
#define ARG_POINTER         0x3
#define ARG_LONG            0x4
#define ARG_DOUBLE          0x5
#define ARG_STRUCT          0x6 /* By value */
#define ARG_FLOAT           0x7
#define ARG_VARARGS         0x8

/* Compound type flags */
#define CT_BY_REFERENCE     0x1
#define CT_VOLATILE         0x2
#define CT_CONST            0x4
72 73 74 75 76 77 78
#define CT_EXTENDED         0x8

/* symbol flags */
#define SYM_CDECL           0x1
#define SYM_STDCALL         0x2
#define SYM_THISCALL        0x4
#define SYM_DATA            0x8 /* Data, not a function */
79

80
typedef enum {NONE, DMGL, SPEC, DUMP} Mode;
81

82 83 84 85
/* Structure holding a parsed symbol */
typedef struct __parsed_symbol
{
  char *symbol;
86
  int   ordinal;
87 88 89
  char *return_text;
  char  return_type;
  char *function_name;
90
  int varargs;
91
  unsigned int argc;
92
  unsigned int flags;
93 94 95 96 97 98
  char  arg_type [MAX_FUNCTION_ARGS];
  char  arg_flag [MAX_FUNCTION_ARGS];
  char *arg_text [MAX_FUNCTION_ARGS];
  char *arg_name [MAX_FUNCTION_ARGS];
} parsed_symbol;

99 100 101 102 103 104 105 106
/* FIXME: Replace with some hash such as GHashTable */
typedef struct __search_symbol
{
  struct __search_symbol *next;
  int found;
  char symbolname[1];    /* static string, be ANSI C compliant by [1] */
} search_symbol;

107 108 109
/* All globals */
typedef struct __globals
{
110 111 112 113 114 115 116 117
  Mode  mode;		   /* SPEC, DEMANGLE or DUMP */

  /* Options: generic */
  int   do_quiet;          /* -q */
  int   do_verbose;        /* -v */

  /* Option arguments: generic */
  const char *input_name;  /* */
118
  const char *input_module; /* input module name generated after input_name according mode */
119 120

  /* Options: spec mode */
121 122 123 124 125
  int   do_code;           /* -c, -t, -f */
  int   do_trace;          /* -t, -f */
  int   do_cdecl;          /* -C */
  int   do_documentation;  /* -D */

126 127 128
  /* Options: dump mode */
  int   do_demangle;        /* -d */
  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 134
  int   start_ordinal;     /* -s */
  int   end_ordinal;       /* -e */
135
  search_symbol *search_symbol; /* -S */
136
  char *directory;         /* -I */
137 138
  const char *forward_dll; /* -f */
  const char *dll_name;    /* -o */
139
  const char *uc_dll_name;       /* -o */
140 141 142

  /* Option arguments: dump mode */
  const char *dumpsect;    /* -j */
143

144
  /* internal options */
145
  int   do_ordinals;
146 147 148 149 150 151
} _globals;

extern _globals globals;

/* Names to use for output DLL */
#define OUTPUT_DLL_NAME \
152
          (globals.dll_name ? globals.dll_name : (globals.input_module ? globals.input_module : globals.input_name))
153 154 155 156 157 158 159 160
#define OUTPUT_UC_DLL_NAME globals.uc_dll_name

/* Verbosity levels */
#define QUIET   (globals.do_quiet)
#define NORMAL  (!QUIET)
#define VERBOSE (globals.do_verbose)

/* Default calling convention */
161
#define CALLING_CONVENTION (globals.do_cdecl ? SYM_CDECL : SYM_STDCALL)
162

163 164
/* Image functions */
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 173
int   symbol_init(parsed_symbol* symbol, const char* name);

174 175 176 177 178 179 180 181
int   symbol_demangle (parsed_symbol *symbol);

int   symbol_search (parsed_symbol *symbol);

void  symbol_clear(parsed_symbol *sym);

int   symbol_is_valid_c(const parsed_symbol *sym);

182
const char *symbol_get_call_convention(const parsed_symbol *sym);
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

const char *symbol_get_spec_type (const parsed_symbol *sym, size_t arg);

void  symbol_clean_string (const char *string);

int   symbol_get_type (const char *string);

/* Output functions */
void  output_spec_preamble (void);

void  output_spec_symbol (const parsed_symbol *sym);

void  output_header_preamble (void);

void  output_header_symbol (const parsed_symbol *sym);

void  output_c_preamble (void);

void  output_c_symbol (const parsed_symbol *sym);

203 204
void  output_prototype (FILE *file, const parsed_symbol *sym);

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
void  output_makefile (void);

/* Misc functions */
char *str_create (size_t num_str, ...);

char *str_create_num (size_t num_str, int num, ...);

char *str_substring(const char *start, const char *end);

char *str_replace (char *str, const char *oldstr, const char *newstr);

const char *str_match (const char *str, const char *match, int *found);

const char *str_find_set (const char *str, const char *findset);

char *str_toupper (char *str);

222 223
const char *get_machine_str(int mach);

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 228
const void*	PRD(unsigned long prd, unsigned long len);
unsigned long	Offset(const void* ptr);
229

230
typedef void (*file_dumper)(void);
231 232 233 234 235 236
int             dump_analysis(const char*, file_dumper, enum FileSig);

void            dump_data( const unsigned char *ptr, unsigned int size, const char *prefix );
const char*	get_time_str( unsigned long );
unsigned int    strlenW( const unsigned short *str );
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 240
void            dump_file_header(const IMAGE_FILE_HEADER *);
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 247
void            ne_dump( void );
void            le_dump( void );
248
enum FileSig    get_kind_mdmp(void);
249
void            mdmp_dump( void );
250 251 252
enum FileSig    get_kind_lib(void);
void            lib_dump( void );
enum FileSig    get_kind_dbg(void);
253
void	        dbg_dump( void );
254 255
enum FileSig    get_kind_lnk(void);
void	        lnk_dump( void );
256 257
enum FileSig    get_kind_emf(void);
void            emf_dump( void );
258 259
enum FileSig    get_kind_pdb(void);
void            pdb_dump(void);
260
int             codeview_dump_symbols(const void* root, unsigned long size);
261 262
int             codeview_dump_types_from_offsets(const void* table, const DWORD* offsets, unsigned num_types);
int             codeview_dump_types_from_block(const void* table, unsigned long len);
Alexandre Julliard's avatar
Alexandre Julliard committed
263

264 265 266 267
void            dump_stabs(const void* pv_stabs, unsigned szstabs, const char* stabstr, unsigned szstr);
void		dump_codeview(unsigned long ptr, unsigned long len);
void		dump_coff(unsigned long coffbase, unsigned long len, const void* sect_map);
void		dump_frame_pointer_omission(unsigned long base, unsigned long len);
268

269 270 271 272
FILE *open_file (const char *name, const char *ext, const char *mode);

#ifdef __GNUC__
void  do_usage (void) __attribute__ ((noreturn));
273
void  fatal (const char *message)  __attribute__ ((noreturn));
274 275
#else
void  do_usage (void);
276
void  fatal (const char *message);
277 278 279 280
#endif



281
#endif /* __WINE_WINEDUMP_H */