2 * Winedump - A Wine DLL tool
4 * Copyright 2000 Jon Griffiths
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.
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.
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
21 * DLL symbol extraction based on file format from alib (anthonyw.cjb.net).
23 * Option processing shamelessly cadged from winebuild.
25 * All the cool functionality (prototyping, call tracing, forwarding)
26 * relies on Patrik Stridvall's 'function_grep.pl' script to work.
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.
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
39 #ifndef __WINE_WINEDUMP_H
40 #define __WINE_WINEDUMP_H
50 #define NONAMELESSUNION
51 #define NONAMELESSSTRUCT
55 /* Argument type constants */
56 #define MAX_FUNCTION_ARGS 32
59 #define ARG_STRING 0x1
60 #define ARG_WIDE_STRING 0x2
61 #define ARG_POINTER 0x3
63 #define ARG_DOUBLE 0x5
64 #define ARG_STRUCT 0x6 /* By value */
66 #define ARG_VARARGS 0x8
68 /* Compound type flags */
69 #define CT_BY_REFERENCE 0x1
70 #define CT_VOLATILE 0x2
72 #define CT_EXTENDED 0x8
76 #define SYM_STDCALL 0x2
77 #define SYM_THISCALL 0x4
78 #define SYM_DATA 0x8 /* Data, not a function */
80 typedef enum {NONE
, DMGL
, SPEC
, DUMP
} Mode
;
82 /* Structure holding a parsed symbol */
83 typedef struct __parsed_symbol
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 unsigned int n_u_refs
;
98 char *u_ref
[MAX_FUNCTION_ARGS
];
101 /* FIXME: Replace with some hash such as GHashTable */
102 typedef struct __search_symbol
104 struct __search_symbol
*next
;
106 char symbolname
[1]; /* static string, be ANSI C compliant by [1] */
110 typedef struct __globals
112 Mode mode
; /* SPEC, DEMANGLE or DUMP */
114 /* Options: generic */
115 int do_quiet
; /* -q */
116 int do_verbose
; /* -v */
118 /* Option arguments: generic */
119 const char *input_name
; /* */
120 const char *input_module
; /* input module name generated after input_name according mode */
122 /* Options: spec mode */
123 int do_code
; /* -c, -t, -f */
124 int do_trace
; /* -t, -f */
125 int do_cdecl
; /* -C */
126 int do_documentation
; /* -D */
128 /* Options: dump mode */
129 int do_demangle
; /* -d */
130 int do_dumpheader
; /* -f */
131 int do_dump_rawdata
; /* -x */
132 int do_debug
; /* -G == 1, -g == 2 */
134 /* Option arguments: spec mode */
135 int start_ordinal
; /* -s */
136 int end_ordinal
; /* -e */
137 search_symbol
*search_symbol
; /* -S */
138 char *directory
; /* -I */
139 const char *forward_dll
; /* -f */
140 const char *dll_name
; /* -o */
141 const char *uc_dll_name
; /* -o */
143 /* Option arguments: dump mode */
144 const char *dumpsect
; /* -j */
146 /* internal options */
150 extern _globals globals
;
152 /* Names to use for output DLL */
153 #define OUTPUT_DLL_NAME \
154 (globals.dll_name ? globals.dll_name : (globals.input_module ? globals.input_module : globals.input_name))
155 #define OUTPUT_UC_DLL_NAME globals.uc_dll_name
157 /* Verbosity levels */
158 #define QUIET (globals.do_quiet)
159 #define NORMAL (!QUIET)
160 #define VERBOSE (globals.do_verbose)
162 /* Default calling convention */
163 #define CALLING_CONVENTION (globals.do_cdecl ? SYM_CDECL : SYM_STDCALL)
165 /* Image functions */
166 void dump_file(const char* name
);
169 int dll_open (const char *dll_name
);
171 int dll_next_symbol (parsed_symbol
* sym
);
173 /* Symbol functions */
174 int symbol_init(parsed_symbol
* symbol
, const char* name
);
176 int symbol_demangle (parsed_symbol
*symbol
);
178 int symbol_search (parsed_symbol
*symbol
);
180 void symbol_clear(parsed_symbol
*sym
);
182 int symbol_is_valid_c(const parsed_symbol
*sym
);
184 const char *symbol_get_call_convention(const parsed_symbol
*sym
);
186 const char *symbol_get_spec_type (const parsed_symbol
*sym
, size_t arg
);
188 void symbol_clean_string (const char *string
);
190 int symbol_get_type (const char *string
);
192 /* Output functions */
193 void output_spec_preamble (void);
195 void output_spec_symbol (const parsed_symbol
*sym
);
197 void output_header_preamble (void);
199 void output_header_symbol (const parsed_symbol
*sym
);
201 void output_c_preamble (void);
203 void output_c_symbol (const parsed_symbol
*sym
);
205 void output_prototype (FILE *file
, const parsed_symbol
*sym
);
207 void output_makefile (void);
210 char *str_create (size_t num_str
, ...);
212 char *str_create_num (size_t num_str
, int num
, ...);
214 char *str_substring(const char *start
, const char *end
);
216 char *str_replace (char *str
, const char *oldstr
, const char *newstr
);
218 const char *str_match (const char *str
, const char *match
, int *found
);
220 const char *str_find_set (const char *str
, const char *findset
);
222 char *str_toupper (char *str
);
224 const char *get_machine_str(int mach
);
226 /* file dumping functions */
227 enum FileSig
{SIG_UNKNOWN
, SIG_DOS
, SIG_PE
, SIG_DBG
, SIG_PDB
, SIG_NE
, SIG_LE
, SIG_MDMP
, SIG_COFFLIB
, SIG_LNK
, SIG_EMF
};
229 const void* PRD(unsigned long prd
, unsigned long len
);
230 unsigned long Offset(const void* ptr
);
232 typedef void (*file_dumper
)(void);
233 int dump_analysis(const char*, file_dumper
, enum FileSig
);
235 void dump_data( const unsigned char *ptr
, unsigned int size
, const char *prefix
);
236 const char* get_time_str( unsigned long );
237 unsigned int strlenW( const unsigned short *str
);
238 void dump_unicode_str( const unsigned short *str
, int len
);
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 char* guid_to_string(const GUID
* guid
, char *str
, size_t sz
);
244 enum FileSig
get_kind_exec(void);
245 void dos_dump( void );
246 void pe_dump( void );
247 void ne_dump( void );
248 void le_dump( void );
249 enum FileSig
get_kind_mdmp(void);
250 void mdmp_dump( void );
251 enum FileSig
get_kind_lib(void);
252 void lib_dump( void );
253 enum FileSig
get_kind_dbg(void);
254 void dbg_dump( void );
255 enum FileSig
get_kind_lnk(void);
256 void lnk_dump( void );
257 enum FileSig
get_kind_emf(void);
258 void emf_dump( void );
259 enum FileSig
get_kind_pdb(void);
261 int codeview_dump_symbols(const void* root
, unsigned long size
);
262 int codeview_dump_types_from_offsets(const void* table
, const DWORD
* offsets
, unsigned num_types
);
263 int codeview_dump_types_from_block(const void* table
, unsigned long len
);
265 void dump_stabs(const void* pv_stabs
, unsigned szstabs
, const char* stabstr
, unsigned szstr
);
266 void dump_codeview(unsigned long ptr
, unsigned long len
);
267 void dump_coff(unsigned long coffbase
, unsigned long len
, const void* sect_map
);
268 void dump_frame_pointer_omission(unsigned long base
, unsigned long len
);
270 FILE *open_file (const char *name
, const char *ext
, const char *mode
);
273 void do_usage (void) __attribute__ ((noreturn
));
274 void fatal (const char *message
) __attribute__ ((noreturn
));
276 void do_usage (void);
277 void fatal (const char *message
);
282 #endif /* __WINE_WINEDUMP_H */