1WINEDUMP(1) Wine Developers Manual WINEDUMP(1)
2
6 winedump - A Wine DLL tool
7
9 winedump [-h | sym sym | spec dll | dump file ] [mode_options]
10
12 winedump is a Wine tool which aims to help:
13 A: Reimplementing a Win32 DLL for use within Wine, or
14 B: Compiling a Win32 application with Winelib that uses x86 DLLs
15 For both tasks in order to be able to link to the Win functions some
17 glue code is needed. This 'glue' comes in the form of a .spec file.
18 The .spec file, along with some dummy code, is used to create a
19 Wine .so corresponding to the Windows DLL. The winebuild program
20 can then resolve calls made to DLL functions.
21 Creating a .spec file is a labour intensive task during which it is
23 easy to make a mistake. The idea of winedump is to automate this task
24 and create the majority of the support code needed for your DLL. In
25 addition you can have winedump create code to help you re-implement a
26 DLL, by providing tracing of calls to the DLL, and (in some cases)
27 automatically determining the parameters, calling conventions, and
28 return values of the DLL functions.
29 Another use for this tool is to display (dump) information about a 32bit
31 DLL or PE format image file. When used in this way winedump functions
32 similarly to tools such as pedump provided by many Win32 compiler
33 vendors.
34 Finally winedump can be also used to demangle C++ symbols.
36
38 winedump can be used in several different modes. The first argument to
39 the program determines the mode winedump will run in.
40 -h Help mode. Basic usage help is printed.
42 dump To dump the contents of a file.
44 spec For generating .spec files and stub DLLs.
46 sym Symbol mode. Used to demangle C++ symbols.
48
50 Mode options depend on the mode given as the first argument.
51 Help mode:
53 No options are used.
54 The program prints the help info and then exits.
55 Dump mode:
57 file Dumps the contents of file. Various file formats are supported
59 (PE, NE, LE, Minidumps, .lnk).
60 -C Turns on symbol demangling.
62 -f Dumps file header information.
64 This option dumps only the standard PE header structures,
65 along with the COFF sections available in the file.
66 -j dir_name
68 Dumps only the content of directory dir_name, for files which
69 header points to directories. For PE files, the import,
70 export, debug, resource, tls, loadcfg,
71 clr, reloc and except directories, as well as the
72 apiset section, are implemented. For NE files, the export
73 and resource directories are implemented.
74 -x Dumps everything.
76 This command prints all available information (including all
77 available directories - see -j option) about the file. You may
78 wish to pipe the output through more/less or into a file, since
79 a lot of output will be produced.
80 -G Dumps contents of debug section if any (for now, only stabs
82 information is supported).
83 Spec mode:
85 dll Use dll for input file and generate implementation code.
87 -I dir Look for prototypes in dir (implies -c). In the case of
89 Windows DLLs, this could be either the standard include
90 directory from your compiler, or a SDK include directory.
91 If you have a text document with prototypes (such as
92 documentation) that can be used also, however you may need
93 to delete some non-code lines to ensure that prototypes are
94 parsed correctly.
95 The dir argument can also be a file specification (e.g.
96 include/*). If it contains wildcards you must quote it to
97 prevent the shell from expanding it.
98 If you have no prototypes, specify /dev/null as dir.
99 winedump may still be able to generate some working stub
100 code for you.
101 -c Generate skeleton code (requires -I).
103 This option tells winedump to create function stubs for each
104 function in the DLL. As winedump reads each exported symbol
105 from the source DLL, it first tries to demangle the name. If
106 the name is a C++ symbol, the arguments, class and return
107 value are all encoded into the symbol name. Winedump
108 converts this information into a C function prototype. If
109 this fails, the file(s) specified in the -I argument are
110 scanned for a function prototype. If one is found it is used
111 for the next step of the process, code generation.
112 -t TRACE arguments (implies -c).
114 This option produces the same code as -c, except that
115 arguments are printed out when the function is called.
116 Structs that are passed by value are printed as "struct",
117 and functions that take variable argument lists print "...".
118 -f dll Forward calls to dll (implies -t).
120 This is the most complicated level of code generation. The
121 same code is generated as -t, however support is added for
122 forwarding calls to another DLL. The DLL to forward to is
123 given as dll.
124 -D Generate documentation.
126 By default, winedump generates a standard comment at the
127 header of each function it generates. Passing this option
128 makes winedump output a full header template for standard
129 Wine documentation, listing the parameters and return value
130 of the function.
131 -o name
133 Set the output dll name (default: dll).
134 By default, if winedump is run on DLL foo, it creates
135 files foo.spec, foo_main.c etc, and prefixes any
136 functions generated with FOO_. If -o bar is given,
137 these will become bar.spec, bar_main.c and BAR_
138 respectively.
139 This option is mostly useful when generating a forwarding DLL.
140 -C Assume __cdecl calls (default: __stdcall).
142 If winebuild cannot determine the calling convention,
143 __stdcall is used by default, unless this option has
144 been given.
145 Unless -q is given, a warning will be printed for every
146 function that winedump determines the calling convention
147 for and which does not match the assumed calling convention.
148 -s num Start prototype search after symbol num.
150 -e num End prototype search after symbol num.
152 By passing the -s or -e options you can have winedump try to
153 generate code for only some functions in your DLL. This may
154 be used to generate a single function, for example, if you
155 wanted to add functionality to an existing DLL.
156 -S symfile
158 Search only prototype names found in symfile.
159 If you want to only generate code for a subset of exported
160 functions from your source DLL, you can use this option to
161 provide a text file containing the names of the symbols to
162 extract, one per line. Only the symbols present in this file
163 will be used in your output DLL.
164 -q Don't show progress (quiet).
166 No output is printed unless a fatal error is encountered.
167 -v Show lots of detail while working (verbose).
169 There are 3 levels of output while winedump is running. The
170 default level, when neither -q or -v are given, prints the
171 number of exported functions found in the dll, followed by
172 the name of each function as it is processed, and a status
173 indication of whether it was processed OK. With -v given, a
174 lot of information is dumped while winedump works: this is
175 intended to help debug any problems.
176 Sym mode:
178 sym Demangles C++ symbol sym and then exits.
180
182 function_grep.pl
183 Perl script used to retrieve a function prototype.
184 Files output in spec mode for foo.dll:
186 foo.spec
187 This is the .spec file.
188 foo_dll.h
189 foo_main.c
190 These are the source code files containing the minimum set
191 of code to build a stub DLL. The C file contains one
192 function, FOO_Init, which does nothing (but must be
193 present).
194 Makefile.in
195 This is a template for configure to produce a makefile. It
196 is designed for a DLL that will be inserted into the Wine
197 source tree.
198
200 C++ name demangling is not fully in sync with the implementation in
201 msvcrt. It might be useful to submit your C++ name to the testsuite
202 for msvcrt.
203 Bugs can be reported on the Wine bug tracker ⟨https://bugs.winehq.org⟩.
205
207 Jon P. Griffiths <jon_p_griffiths at yahoo dot com>
208 Michael Stefaniuc <mstefani at redhat dot com>
209
211 winedump is part of the Wine distribution, which is available through
212 WineHQ, the Wine development headquarters ⟨https://www.winehq.org/⟩.
213
215 wine(1)
216 Wine documentation and support ⟨https://www.winehq.org/help⟩.
217Wine 8.19 October 2005 WINEDUMP(1)