winedump: Larger usage of symbol demangling while dumping.
[wine] / tools / winedump / dump.c
1 /*
2  *      File dumping utility
3  *
4  *      Copyright 2001,2005 Eric Pouech
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include "config.h"
22 #include "wine/port.h"
23
24 #include <stdlib.h>
25 #include <stdarg.h>
26 #include <stdio.h>
27 #ifdef HAVE_UNISTD_H
28 # include <unistd.h>
29 #endif
30 #include <time.h>
31 #ifdef HAVE_SYS_TYPES_H
32 # include <sys/types.h>
33 #endif
34 #ifdef HAVE_SYS_STAT_H
35 # include <sys/stat.h>
36 #endif
37 #ifdef HAVE_SYS_MMAN_H
38 #include <sys/mman.h>
39 #endif
40 #include <fcntl.h>
41
42 #define NONAMELESSUNION
43 #define NONAMELESSSTRUCT
44 #include "windef.h"
45 #include "winbase.h"
46 #include "winedump.h"
47
48 static void*                    dump_base;
49 static unsigned long            dump_total_len;
50
51 void dump_data( const unsigned char *ptr, unsigned int size, const char *prefix )
52 {
53     unsigned int i, j;
54
55     printf( "%s%08x: ", prefix, 0 );
56     if (!ptr)
57     {
58         printf("NULL\n");
59         return;
60     }
61     for (i = 0; i < size; i++)
62     {
63         printf( "%02x%c", ptr[i], (i % 16 == 7) ? '-' : ' ' );
64         if ((i % 16) == 15)
65         {
66             printf( " " );
67             for (j = 0; j < 16; j++)
68                 printf( "%c", isprint(ptr[i-15+j]) ? ptr[i-15+j] : '.' );
69             if (i < size-1) printf( "\n%s%08x: ", prefix, i + 1 );
70         }
71     }
72     if (i % 16)
73     {
74         printf( "%*s ", 3 * (16-(i%16)), "" );
75         for (j = 0; j < i % 16; j++)
76             printf( "%c", isprint(ptr[i-(i%16)+j]) ? ptr[i-(i%16)+j] : '.' );
77     }
78     printf( "\n" );
79 }
80
81 static char* dump_want_n(unsigned sz)
82 {
83     static char         buffer[4 * 1024];
84     static unsigned     idx;
85     char*               ret;
86
87     assert(sz < sizeof(buffer));
88     if (idx + sz >= sizeof(buffer)) idx = 0;
89     ret = &buffer[idx];
90     idx += sz;
91     return ret;
92 }
93
94 const char *get_time_str(unsigned long _t)
95 {
96     const time_t    t = (const time_t)_t;
97     const char      *str = ctime(&t);
98     size_t          len;
99     static char     buf[128];
100
101     if (!str) /* not valid time */
102     {
103         strcpy(buf, "not valid time");
104         return buf;
105     }
106
107     len = strlen(str);
108     /* FIXME: I don't get the same values from MS' pedump running under Wine...
109      * I wonder if Wine isn't broken wrt to GMT settings...
110      */
111     if (len && str[len-1] == '\n') len--;
112     if (len >= sizeof(buf)) len = sizeof(buf) - 1;
113     memcpy( buf, str, len );
114     buf[len] = 0;
115     return buf;
116 }
117
118 unsigned int strlenW( const WCHAR *str )
119 {
120     const WCHAR *s = str;
121     while (*s) s++;
122     return s - str;
123 }
124
125 void dump_unicode_str( const WCHAR *str, int len )
126 {
127     if (len == -1) len = strlenW( str );
128     printf( "L\"");
129     while (len-- > 0 && *str)
130     {
131         WCHAR c = *str++;
132         switch (c)
133         {
134         case '\n': printf( "\\n" ); break;
135         case '\r': printf( "\\r" ); break;
136         case '\t': printf( "\\t" ); break;
137         case '"':  printf( "\\\"" ); break;
138         case '\\': printf( "\\\\" ); break;
139         default:
140             if (c >= ' ' && c <= 126) putchar(c);
141             else printf( "\\u%04x",c);
142         }
143     }
144     printf( "\"" );
145 }
146
147 const char* get_symbol_str(const char* symname)
148 {
149     char*       tmp;
150     const char* ret;
151
152     if (!symname) return "(nil)";
153     if (globals.do_demangle)
154     {
155         parsed_symbol   symbol;
156
157         symbol_init(&symbol, symname);
158         if (symbol_demangle(&symbol) == -1)
159             ret = symname;
160         else if (symbol.flags & SYM_DATA)
161         {
162             ret = tmp = dump_want_n(strlen(symbol.arg_text[0]) + 1);
163             if (tmp) strcpy(tmp, symbol.arg_text[0]);
164         }
165         else
166         {
167             unsigned int i, len, start = symbol.flags & SYM_THISCALL ? 1 : 0;
168
169             len = strlen(symbol.return_text) + 3 /* ' __' */ +
170                 strlen(symbol_get_call_convention(&symbol)) + 1 /* ' ' */+
171                 strlen(symbol.function_name) + 1 /* ')' */;
172             if (!symbol.argc || (symbol.argc == 1 && symbol.flags & SYM_THISCALL))
173                 len += 4 /* "void" */;
174             else for (i = start; i < symbol.argc; i++)
175                 len += (i > start ? 2 /* ", " */ : 0 /* "" */) + strlen(symbol.arg_text[i]);
176             if (symbol.varargs) len += 5 /* ", ..." */;
177             len += 2; /* ")\0" */
178
179             ret = tmp = dump_want_n(len);
180             if (tmp)
181             {
182                 sprintf(tmp, "%s __%s %s(",
183                         symbol.return_text,
184                         symbol_get_call_convention(&symbol),
185                         symbol.function_name);
186                 if (!symbol.argc || (symbol.argc == 1 && symbol.flags & SYM_THISCALL))
187                     strcat(tmp, "void");
188                 else for (i = start; i < symbol.argc; i++)
189                 {
190                     if (i > start) strcat(tmp, ", ");
191                     strcat(tmp, symbol.arg_text[i]);
192                 }
193                 if (symbol.varargs) strcat(tmp, ", ...");
194                 strcat(tmp, ")");
195             }
196         }
197         symbol_clear(&symbol);
198     }
199     else ret = symname;
200     return ret;
201 }
202
203 char* guid_to_string(const GUID* guid, char* str, size_t sz)
204 {
205     snprintf(str, sz, "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
206              guid->Data1, guid->Data2, guid->Data3,
207              guid->Data4[0], guid->Data4[1], guid->Data4[2], guid->Data4[3],
208              guid->Data4[4], guid->Data4[5], guid->Data4[6], guid->Data4[7]);
209     return str;
210 }
211
212 const void*     PRD(unsigned long prd, unsigned long len)
213 {
214     return (prd + len > dump_total_len) ? NULL : (const char*)dump_base + prd;
215 }
216
217 unsigned long Offset(const void* ptr)
218 {
219     if (ptr < dump_base) {printf("<<<<<ptr below\n");return 0;}
220     if ((const char *)ptr >= (const char*)dump_base + dump_total_len) {printf("<<<<<ptr above\n");return 0;}
221     return (const char *)ptr - (const char *)dump_base;
222 }
223
224 static const struct dumper
225 {
226     enum FileSig        kind;
227     enum FileSig        (*get_kind)(void);
228     file_dumper         dumper; /* default dump tool */
229 }
230 dumpers[] =
231 {
232     {SIG_DOS,           get_kind_exec,  dos_dump},
233     {SIG_PE,            get_kind_exec,  pe_dump},
234     {SIG_DBG,           get_kind_dbg,   dbg_dump},
235     {SIG_PDB,           get_kind_pdb,   pdb_dump},
236     {SIG_NE,            get_kind_exec,  ne_dump},
237     {SIG_LE,            get_kind_exec,  le_dump},
238     {SIG_COFFLIB,       get_kind_lib,   lib_dump},
239     {SIG_MDMP,          get_kind_mdmp,  mdmp_dump},
240     {SIG_LNK,           get_kind_lnk,   lnk_dump},
241     {SIG_EMF,           get_kind_emf,   emf_dump},
242     {SIG_UNKNOWN,       NULL,           NULL} /* sentinel */
243 };
244
245 int dump_analysis(const char *name, file_dumper fn, enum FileSig wanted_sig)
246 {
247     int                 fd;
248     int                 ret = 1;
249     struct stat         s;
250     const struct dumper *dpr;
251
252     setbuf(stdout, NULL);
253
254     fd = open(name, O_RDONLY | O_BINARY);
255     if (fd == -1) fatal("Can't open file");
256
257     if (fstat(fd, &s) < 0) fatal("Can't get size");
258     dump_total_len = s.st_size;
259
260 #ifdef HAVE_MMAP
261     if ((dump_base = mmap(NULL, dump_total_len, PROT_READ, MAP_PRIVATE, fd, 0)) == (void *)-1)
262 #endif
263     {
264         if (!(dump_base = malloc( dump_total_len ))) fatal( "Out of memory" );
265         if ((unsigned long)read( fd, dump_base, dump_total_len ) != dump_total_len) fatal( "Cannot read file" );
266     }
267
268     printf("Contents of %s: %ld bytes\n\n", name, dump_total_len);
269
270     for (dpr = dumpers; dpr->kind != SIG_UNKNOWN; dpr++)
271     {
272         if (dpr->get_kind() == dpr->kind &&
273             (wanted_sig == SIG_UNKNOWN || wanted_sig == dpr->kind))
274         {
275             if (fn) fn(); else dpr->dumper();
276             break;
277         }
278     }
279     if (dpr->kind == SIG_UNKNOWN)
280     {
281         printf("Can't get a suitable file signature, aborting\n");
282         ret = 0;
283     }
284
285     if (ret) printf("Done dumping %s\n", name);
286 #ifdef HAVE_MMAP
287     if (munmap(dump_base, dump_total_len) == -1)
288 #endif
289     {
290         free( dump_base );
291     }
292     close(fd);
293
294     return ret;
295 }
296
297 void    dump_file(const char* name)
298 {
299     dump_analysis(name, NULL, SIG_UNKNOWN);
300 }