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://www.kegel.com/mangle.html
29 * Gives information on the name mangling scheme used by MS compilers,
30 * used as the starting point for the code here. Contains a few
31 * mistakes and some incorrect assumptions, but the lists of types
34 #ifndef __WINE_WINEDUMP_H
35 #define __WINE_WINEDUMP_H
45 #define NONAMELESSUNION
46 #define NONAMELESSSTRUCT
50 /* Argument type constants */
51 #define MAX_FUNCTION_ARGS 32
54 #define ARG_STRING 0x1
55 #define ARG_WIDE_STRING 0x2
56 #define ARG_POINTER 0x3
58 #define ARG_DOUBLE 0x5
59 #define ARG_STRUCT 0x6 /* By value */
61 #define ARG_VARARGS 0x8
63 /* Compound type flags */
64 #define CT_BY_REFERENCE 0x1
65 #define CT_VOLATILE 0x2
67 #define CT_EXTENDED 0x8
71 #define SYM_STDCALL 0x2
72 #define SYM_THISCALL 0x4
73 #define SYM_DATA 0x8 /* Data, not a function */
75 typedef enum {NONE
, DMGL
, SPEC
, DUMP
} Mode
;
77 /* Structure holding a parsed symbol */
78 typedef struct __parsed_symbol
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
];
94 /* FIXME: Replace with some hash such as GHashTable */
95 typedef struct __search_symbol
97 struct __search_symbol
*next
;
99 char symbolname
[1]; /* static string, be ANSI C compliant by [1] */
103 typedef struct __globals
105 Mode mode
; /* SPEC, DEMANGLE or DUMP */
107 /* Options: generic */
108 int do_quiet
; /* -q */
109 int do_verbose
; /* -v */
111 /* Option arguments: generic */
112 const char *input_name
; /* */
113 const char *input_module
; /* input module name generated after input_name according mode */
115 /* Options: spec mode */
116 int do_code
; /* -c, -t, -f */
117 int do_trace
; /* -t, -f */
118 int do_cdecl
; /* -C */
119 int do_documentation
; /* -D */
121 /* Options: dump mode */
122 int do_demangle
; /* -d */
123 int do_dumpheader
; /* -f */
124 int do_dump_rawdata
; /* -x */
125 int do_debug
; /* -G == 1, -g == 2 */
126 int do_symbol_table
; /* -t */
128 /* Option arguments: spec mode */
129 int start_ordinal
; /* -s */
130 int end_ordinal
; /* -e */
131 search_symbol
*search_symbol
; /* -S */
132 char *directory
; /* -I */
133 const char *forward_dll
; /* -f */
134 const char *dll_name
; /* -o */
135 const char *uc_dll_name
; /* -o */
137 /* Option arguments: dump mode */
138 const char *dumpsect
; /* -j */
141 extern _globals globals
;
143 /* Names to use for output DLL */
144 #define OUTPUT_DLL_NAME \
145 (globals.dll_name ? globals.dll_name : (globals.input_module ? globals.input_module : globals.input_name))
146 #define OUTPUT_UC_DLL_NAME globals.uc_dll_name
148 /* Verbosity levels */
149 #define QUIET (globals.do_quiet)
150 #define NORMAL (!QUIET)
151 #define VERBOSE (globals.do_verbose)
153 /* Default calling convention */
154 #define CALLING_CONVENTION (globals.do_cdecl ? SYM_CDECL : SYM_STDCALL)
156 /* Image functions */
157 void dump_file(const char* name
);
160 int dll_open (const char *dll_name
);
162 int dll_next_symbol (parsed_symbol
* sym
);
164 /* Symbol functions */
165 int symbol_init(parsed_symbol
* symbol
, const char* name
);
167 int symbol_demangle (parsed_symbol
*symbol
);
169 int symbol_search (parsed_symbol
*symbol
);
171 void symbol_clear(parsed_symbol
*sym
);
173 int symbol_is_valid_c(const parsed_symbol
*sym
);
175 const char *symbol_get_call_convention(const parsed_symbol
*sym
);
177 const char *symbol_get_spec_type (const parsed_symbol
*sym
, size_t arg
);
179 void symbol_clean_string (char *string
);
181 int symbol_get_type (const char *string
);
183 /* Output functions */
184 void output_spec_preamble (void);
186 void output_spec_symbol (const parsed_symbol
*sym
);
188 void output_header_preamble (void);
190 void output_header_symbol (const parsed_symbol
*sym
);
192 void output_c_preamble (void);
194 void output_c_symbol (const parsed_symbol
*sym
);
196 void output_prototype (FILE *file
, const parsed_symbol
*sym
);
198 void output_makefile (void);
201 char *str_create (size_t num_str
, ...);
203 char *str_create_num (size_t num_str
, int num
, ...);
205 char *str_substring(const char *start
, const char *end
);
207 char *str_replace (char *str
, const char *oldstr
, const char *newstr
);
209 const char *str_match (const char *str
, const char *match
, int *found
);
211 const char *str_find_set (const char *str
, const char *findset
);
213 char *str_toupper (char *str
);
215 const char *get_machine_str(int mach
);
217 /* file dumping functions */
218 enum FileSig
{SIG_UNKNOWN
, SIG_DOS
, SIG_PE
, SIG_DBG
, SIG_PDB
, SIG_NE
, SIG_LE
, SIG_MDMP
, SIG_COFFLIB
, SIG_LNK
, SIG_EMF
, SIG_FNT
};
220 const void* PRD(unsigned long prd
, unsigned long len
);
221 unsigned long Offset(const void* ptr
);
223 typedef void (*file_dumper
)(void);
224 int dump_analysis(const char*, file_dumper
, enum FileSig
);
226 void dump_data( const unsigned char *ptr
, unsigned int size
, const char *prefix
);
227 const char* get_time_str( unsigned long );
228 unsigned int strlenW( const unsigned short *str
);
229 void dump_unicode_str( const unsigned short *str
, int len
);
230 const char* get_guid_str(const GUID
* guid
);
231 const char* get_symbol_str(const char* symname
);
232 void dump_file_header(const IMAGE_FILE_HEADER
*);
233 void dump_optional_header(const IMAGE_OPTIONAL_HEADER32
*, UINT
);
234 void dump_section(const IMAGE_SECTION_HEADER
*, const char* strtable
);
236 enum FileSig
get_kind_exec(void);
237 void dos_dump( void );
238 void pe_dump( void );
239 void ne_dump( void );
240 void le_dump( void );
241 enum FileSig
get_kind_mdmp(void);
242 void mdmp_dump( void );
243 enum FileSig
get_kind_lib(void);
244 void lib_dump( void );
245 enum FileSig
get_kind_dbg(void);
246 void dbg_dump( void );
247 enum FileSig
get_kind_lnk(void);
248 void lnk_dump( void );
249 enum FileSig
get_kind_emf(void);
250 void emf_dump( void );
251 enum FileSig
get_kind_pdb(void);
253 enum FileSig
get_kind_fnt(void);
254 void fnt_dump( void );
255 int codeview_dump_symbols(const void* root
, unsigned long size
);
256 int codeview_dump_types_from_offsets(const void* table
, const DWORD
* offsets
, unsigned num_types
);
257 int codeview_dump_types_from_block(const void* table
, unsigned long len
);
258 void codeview_dump_linetab(const char* linetab
, BOOL pascal_str
, const char* pfx
);
259 void codeview_dump_linetab2(const char* linetab
, DWORD size
, const char* strimage
, DWORD strsize
, const char* pfx
);
261 void dump_stabs(const void* pv_stabs
, unsigned szstabs
, const char* stabstr
, unsigned szstr
);
262 void dump_codeview(unsigned long ptr
, unsigned long len
);
263 void dump_coff(unsigned long coffbase
, unsigned long len
,
264 const IMAGE_SECTION_HEADER
*sectHead
);
265 void dump_coff_symbol_table(const IMAGE_SYMBOL
*coff_symbols
, unsigned num_sym
,
266 const IMAGE_SECTION_HEADER
*sectHead
);
267 void dump_frame_pointer_omission(unsigned long base
, unsigned long len
);
269 FILE *open_file (const char *name
, const char *ext
, const char *mode
);
272 void do_usage (const char *arg
) __attribute__ ((noreturn
));
273 void fatal (const char *message
) __attribute__ ((noreturn
));
275 void do_usage (const char *arg
);
276 void fatal (const char *message
);
281 #endif /* __WINE_WINEDUMP_H */