2008-11-25 Gonzalo Paniagua Javier <gonzalo@novell.com>
[mono.git] / mono / metadata / pedump.c
1 /*
2  * pedump.c: Dumps the contents of an extended PE/COFF file
3  *
4  * Author:
5  *   Miguel de Icaza (miguel@ximian.com)
6  *
7  * (C) 2001 Ximian, Inc.
8  */
9 #include <config.h>
10 #include <stdio.h>
11 #include <stdlib.h>
12 #include <string.h>
13 #include "image.h"
14 #include <glib.h>
15 #include "cil-coff.h"
16 #include "mono-endian.h"
17 #include "verify.h"
18 #include <mono/metadata/class.h>
19 #include <mono/metadata/debug-helpers.h>
20 #include <mono/metadata/tokentype.h>
21 #include <mono/metadata/appdomain.h>
22 #include <mono/metadata/assembly.h>
23 #include <mono/metadata/metadata-internals.h>
24 #include <mono/metadata/class-internals.h>
25 #include <mono/metadata/verify-internals.h>
26 #include "mono/utils/mono-digest.h"
27
28 gboolean dump_data = TRUE;
29 gboolean verify_pe = FALSE;
30 gboolean verify_metadata = FALSE;
31 gboolean verify_code = FALSE;
32
33 /* unused
34 static void
35 hex_dump (const char *buffer, int base, int count)
36 {
37         int i;
38         
39         for (i = 0; i < count; i++){
40                 if ((i % 16) == 0)
41                         printf ("\n0x%08x: ", (unsigned char) base + i);
42
43                 printf ("%02x ", (unsigned char) (buffer [i]));
44         }
45 }
46 */
47
48 static void
49 hex8 (const char *label, unsigned char x)
50 {
51         printf ("\t%s: 0x%02x\n", label, (unsigned char) x);
52 }
53
54 static void
55 hex16 (const char *label, guint16 x)
56 {
57         printf ("\t%s: 0x%04x\n", label, x);
58 }
59
60 static void
61 hex32 (const char *label, guint32 x)
62 {
63         printf ("\t%s: 0x%08x\n", label, x);
64 }
65
66 static void
67 dump_coff_header (MonoCOFFHeader *coff)
68 {
69         printf ("\nCOFF Header:\n");
70         hex16 ("                Machine", coff->coff_machine);
71         hex16 ("               Sections", coff->coff_sections);
72         hex32 ("             Time stamp", coff->coff_time);
73         hex32 ("Pointer to Symbol Table", coff->coff_symptr);
74         hex32 ("           Symbol Count", coff->coff_symcount);
75         hex16 ("   Optional Header Size", coff->coff_opt_header_size);
76         hex16 ("        Characteristics", coff->coff_attributes);
77
78 }
79
80 static void
81 dump_pe_header (MonoPEHeader *pe)
82 {
83         printf ("\nPE Header:\n");
84         hex16 ("         Magic (0x010b)", pe->pe_magic);
85         hex8  ("             LMajor (6)", pe->pe_major);
86         hex8  ("             LMinor (0)", pe->pe_minor);
87         hex32 ("              Code Size", pe->pe_code_size);
88         hex32 ("  Initialized Data Size", pe->pe_data_size);
89         hex32 ("Uninitialized Data Size", pe->pe_uninit_data_size);
90         hex32 ("        Entry Point RVA", pe->pe_rva_entry_point);
91         hex32 ("          Code Base RVA", pe->pe_rva_code_base);
92         hex32 ("          Data Base RVA", pe->pe_rva_data_base);
93         printf ("\n");
94 }
95
96 static void
97 dump_nt_header (MonoPEHeaderNT *nt)
98 {
99         printf ("\nNT Header:\n");
100
101         hex32 ("   Image Base (0x400000)", nt->pe_image_base);
102         hex32 ("Section Alignment (8192)", nt->pe_section_align);
103         hex32 ("   File Align (512/4096)", nt->pe_file_alignment);
104         hex16 ("            OS Major (4)", nt->pe_os_major);
105         hex16 ("            OS Minor (0)", nt->pe_os_minor);
106         hex16 ("          User Major (0)", nt->pe_user_major);
107         hex16 ("          User Minor (0)", nt->pe_user_minor);
108         hex16 ("        Subsys major (4)", nt->pe_subsys_major);
109         hex16 ("        Subsys minor (0)", nt->pe_subsys_minor);
110         hex32 ("               Reserverd", nt->pe_reserved_1);
111         hex32 ("              Image Size", nt->pe_image_size);
112         hex32 ("             Header Size", nt->pe_header_size);
113         hex32 ("            Checksum (0)", nt->pe_checksum);
114         hex16 ("               Subsystem", nt->pe_subsys_required);
115         hex16 ("           DLL Flags (0)", nt->pe_dll_flags);
116         hex32 (" Stack Reserve Size (1M)", nt->pe_stack_reserve);
117         hex32 ("Stack commit Size (4096)", nt->pe_stack_commit);
118         hex32 ("  Heap Reserve Size (1M)", nt->pe_heap_reserve);
119         hex32 (" Heap Commit Size (4096)", nt->pe_heap_commit);
120         hex32 ("      Loader flags (0x1)", nt->pe_loader_flags);
121         hex32 ("   Data Directories (16)", nt->pe_data_dir_count);
122 }
123
124 static void
125 dent (const char *label, MonoPEDirEntry de)
126 {
127         printf ("\t%s: 0x%08x [0x%08x]\n", label, de.rva, de.size);
128 }
129
130 static void
131 dump_blob (const char *desc, const char* p, guint32 size)
132 {
133         int i;
134
135         printf ("%s", desc);
136         if (!p) {
137                 printf (" none\n");
138                 return;
139         }
140
141         for (i = 0; i < size; ++i) {
142                 if (!(i % 16))
143                         printf ("\n\t");
144                 printf (" %02X", p [i] & 0xFF);
145         }
146         printf ("\n");
147 }
148
149 static void
150 dump_public_key (MonoImage *m)
151 {
152         guint32 size;
153         const char *p;
154
155         p = mono_image_get_public_key (m, &size);
156         dump_blob ("\nPublic key:", p, size);
157 }
158
159 static void
160 dump_strong_name (MonoImage *m)
161 {
162         guint32 size;
163         const char *p;
164
165         p = mono_image_get_strong_name (m, &size);
166         dump_blob ("\nStrong name:", p, size);
167 }
168
169 static void
170 dump_datadir (MonoPEDatadir *dd)
171 {
172         printf ("\nData directories:\n");
173         dent ("     Export Table", dd->pe_export_table);
174         dent ("     Import Table", dd->pe_import_table);
175         dent ("   Resource Table", dd->pe_resource_table);
176         dent ("  Exception Table", dd->pe_exception_table);
177         dent ("Certificate Table", dd->pe_certificate_table);
178         dent ("      Reloc Table", dd->pe_reloc_table);
179         dent ("            Debug", dd->pe_debug);
180         dent ("        Copyright", dd->pe_copyright);
181         dent ("       Global Ptr", dd->pe_global_ptr);
182         dent ("        TLS Table", dd->pe_tls_table);
183         dent ("Load Config Table", dd->pe_load_config_table);
184         dent ("     Bound Import", dd->pe_bound_import);
185         dent ("              IAT", dd->pe_iat);
186         dent ("Delay Import Desc", dd->pe_delay_import_desc);
187         dent ("       CLI Header", dd->pe_cli_header);
188 }
189
190 static void
191 dump_dotnet_header (MonoDotNetHeader *header)
192 {
193         dump_coff_header (&header->coff);
194         dump_pe_header (&header->pe);
195         dump_nt_header (&header->nt);
196         dump_datadir (&header->datadir);
197 }
198
199 static void
200 dump_section_table (MonoSectionTable *st)
201 {
202         guint32 flags = st->st_flags;
203                 
204         printf ("\n\tName: %s\n", st->st_name);
205         hex32 ("   Virtual Size", st->st_virtual_size);
206         hex32 ("Virtual Address", st->st_virtual_address);
207         hex32 ("  Raw Data Size", st->st_raw_data_size);
208         hex32 ("   Raw Data Ptr", st->st_raw_data_ptr);
209         hex32 ("      Reloc Ptr", st->st_reloc_ptr);
210         hex32 ("     LineNo Ptr", st->st_lineno_ptr);
211         hex16 ("    Reloc Count", st->st_reloc_count);
212         hex16 ("     Line Count", st->st_line_count);
213
214         printf ("\tFlags: %s%s%s%s%s%s%s%s%s%s\n",
215                 (flags & SECT_FLAGS_HAS_CODE) ? "code, " : "",
216                 (flags & SECT_FLAGS_HAS_INITIALIZED_DATA) ? "data, " : "",
217                 (flags & SECT_FLAGS_HAS_UNINITIALIZED_DATA) ? "bss, " : "",
218                 (flags & SECT_FLAGS_MEM_DISCARDABLE) ? "discard, " : "",
219                 (flags & SECT_FLAGS_MEM_NOT_CACHED) ? "nocache, " : "",
220                 (flags & SECT_FLAGS_MEM_NOT_PAGED) ? "nopage, " : "",
221                 (flags & SECT_FLAGS_MEM_SHARED) ? "shared, " : "",
222                 (flags & SECT_FLAGS_MEM_EXECUTE) ? "exec, " : "",
223                 (flags & SECT_FLAGS_MEM_READ) ? "read, " : "",
224                 (flags & SECT_FLAGS_MEM_WRITE) ? "write" : "");
225 }
226
227 static void
228 dump_sections (MonoCLIImageInfo *iinfo)
229 {
230         const int top = iinfo->cli_header.coff.coff_sections;
231         int i;
232         
233         for (i = 0; i < top; i++)
234                 dump_section_table (&iinfo->cli_section_tables [i]);
235 }
236
237 static void
238 dump_cli_header (MonoCLIHeader *ch)
239 {
240         printf ("\n");
241         printf ("          CLI header size: %d\n", ch->ch_size);
242         printf ("         Runtime required: %d.%d\n", ch->ch_runtime_major, ch->ch_runtime_minor);
243         printf ("                    Flags: %s, %s, %s, %s\n",
244                 (ch->ch_flags & CLI_FLAGS_ILONLY ? "ilonly" : "contains native"),
245                 (ch->ch_flags & CLI_FLAGS_32BITREQUIRED ? "32bits" : "32/64"),
246                 (ch->ch_flags & CLI_FLAGS_ILONLY ? "trackdebug" : "no-trackdebug"),
247                 (ch->ch_flags & CLI_FLAGS_STRONGNAMESIGNED ? "strongnamesigned" : "notsigned"));
248         dent   ("         Metadata", ch->ch_metadata);
249         hex32  ("Entry Point Token", ch->ch_entry_point);
250         dent   ("     Resources at", ch->ch_resources);
251         dent   ("   Strong Name at", ch->ch_strong_name);
252         dent   ("  Code Manager at", ch->ch_code_manager_table);
253         dent   ("  VTableFixups at", ch->ch_vtable_fixups);
254         dent   ("     EAT jumps at", ch->ch_export_address_table_jumps);
255 }       
256
257 static void
258 dsh (const char *label, MonoImage *meta, MonoStreamHeader *sh)
259 {
260         printf ("%s: 0x%08x - 0x%08x [%d == 0x%08x]\n",
261                 label,
262                 (int)(sh->data - meta->raw_metadata), (int)(sh->data + sh->size - meta->raw_metadata),
263                 sh->size, sh->size);
264 }
265
266 static void
267 dump_metadata_header (MonoImage *meta)
268 {
269         printf ("\nMetadata header:\n");
270         printf ("           Version: %d.%d\n", meta->md_version_major, meta->md_version_minor);
271         printf ("    Version string: %s\n", meta->version);
272 }
273
274 static void
275 dump_metadata_ptrs (MonoImage *meta)
276 {
277         printf ("\nMetadata pointers:\n");
278         dsh ("\tTables (#~)", meta, &meta->heap_tables);
279         dsh ("\t    Strings", meta, &meta->heap_strings);
280         dsh ("\t       Blob", meta, &meta->heap_blob);
281         dsh ("\tUser string", meta, &meta->heap_us);
282         dsh ("\t       GUID", meta, &meta->heap_guid);
283 }
284
285 static void
286 dump_metadata (MonoImage *meta)
287 {
288         int table;
289
290         dump_metadata_header (meta);
291
292         dump_metadata_ptrs (meta);
293
294         printf ("Rows:\n");
295         for (table = 0; table < MONO_TABLE_NUM; table++){
296                 if (meta->tables [table].rows == 0)
297                         continue;
298                 printf ("Table %s: %d records (%d bytes, at %p)\n",
299                         mono_meta_table_name (table),
300                         meta->tables [table].rows,
301                         meta->tables [table].row_size,
302                         meta->tables [table].base
303                         );
304         }
305 }
306
307 static void
308 dump_methoddef (MonoImage *metadata, guint32 token)
309 {
310         const char *loc;
311
312         if (!token)
313                 return;
314         loc = mono_metadata_locate_token (metadata, token);
315
316         printf ("RVA for Entry Point: 0x%08x\n", read32 (loc));
317 }
318
319 static void
320 dump_dotnet_iinfo (MonoImage *image)
321 {
322         MonoCLIImageInfo *iinfo = image->image_info;
323
324         dump_dotnet_header (&iinfo->cli_header);
325         dump_sections (iinfo);
326         dump_cli_header (&iinfo->cli_cli_header);
327         dump_strong_name (image);
328         dump_public_key (image);
329         dump_metadata (image);
330
331         dump_methoddef (image, iinfo->cli_cli_header.ch_entry_point);
332 }
333
334 static int
335 dump_verify_info (MonoImage *image, int flags)
336 {
337         GSList *errors, *tmp;
338         int count = 0, verifiable = 0;
339         const char* desc [] = {
340                 "Ok", "Error", "Warning", NULL, "CLS", NULL, NULL, NULL, "Not Verifiable"
341         };
342
343         if (verify_metadata) {
344                 errors = mono_image_verify_tables (image, flags);
345         
346                 for (tmp = errors; tmp; tmp = tmp->next) {
347                         MonoVerifyInfo *info = tmp->data;
348                         g_print ("%s: %s\n", desc [info->status], info->message);
349                         if (info->status == MONO_VERIFY_ERROR)
350                                 count++;
351                 }
352                 mono_free_verify_list (errors);
353         }
354
355         if (verify_code) { /* verify code */
356                 int i;
357                 MonoTableInfo *m = &image->tables [MONO_TABLE_METHOD];
358
359                 for (i = 0; i < m->rows; ++i) {
360                         MonoMethod *method;
361                         method = mono_get_method (image, MONO_TOKEN_METHOD_DEF | (i+1), NULL);
362                         errors = mono_method_verify (method, flags);
363                         if (errors) {
364                                 char *sig, *name;
365                                 MonoClass *klass = mono_method_get_class (method);
366                                 sig = mono_signature_get_desc (mono_method_signature (method), FALSE);
367                                 name = mono_type_full_name (&klass->byval_arg);
368                                 g_print ("In method: %s::%s(%s)\n", name, mono_method_get_name (method), sig);
369                                 g_free (name);
370                                 g_free (sig);
371                         }
372
373                         for (tmp = errors; tmp; tmp = tmp->next) {
374                                 MonoVerifyInfo *info = tmp->data;
375                                 g_print ("%s: %s\n", desc [info->status], info->message);
376                                 if (info->status == MONO_VERIFY_ERROR) {
377                                         count++;
378                                         verifiable = 3;
379                                 }
380                                 if(info->status == MONO_VERIFY_NOT_VERIFIABLE) {
381                                         if (verifiable < 2)
382                                                 verifiable = 2; 
383                                 }
384                         }
385                         mono_free_verify_list (errors);
386                 }
387         }
388
389         if (count)
390                 g_print ("Error count: %d\n", count);
391         return verifiable;
392 }
393
394 static void
395 usage (void)
396 {
397         printf ("Usage is: pedump [--verify error,warn,cls,all,code,fail-on-verifiable,non-strict,valid-only] file.exe\n");
398         exit (1);
399 }
400
401 #define VALID_ONLY_FLAG 0x08000000
402 #define VERIFY_CODE_ONLY MONO_VERIFY_ALL + 1 
403 int
404 main (int argc, char *argv [])
405 {
406         MonoImage *image;
407         char *file = NULL;
408         char *flags = NULL;
409         MiniVerifierMode verifier_mode = MONO_VERIFIER_MODE_VERIFIABLE;
410         const char *flag_desc [] = {"error", "warn", "cls", "all", "code", "fail-on-verifiable", "non-strict", "valid-only", NULL};
411         guint flag_vals [] = {MONO_VERIFY_ERROR, MONO_VERIFY_WARNING, MONO_VERIFY_CLS, MONO_VERIFY_ALL, VERIFY_CODE_ONLY, MONO_VERIFY_FAIL_FAST, MONO_VERIFY_NON_STRICT, VALID_ONLY_FLAG, 0};
412         int i;
413         
414         for (i = 1; i < argc; i++){
415                 if (argv [i][0] != '-'){
416                         file = argv [i];
417                         continue;
418                 }
419
420                 if (strcmp (argv [i], "--help") == 0)
421                         usage ();
422                 else if (strcmp (argv [i], "--verify") == 0) {
423                         verify_pe = 1;
424                         dump_data = 0;
425                         ++i;
426                         flags = argv [i];
427                 } else {
428                         usage ();
429                 }
430         }
431         
432         if (!file)
433                 usage ();
434
435         mono_perfcounters_init ();
436         mono_metadata_init ();
437         mono_images_init ();
438         mono_assemblies_init ();
439         mono_loader_init ();
440  
441         image = mono_image_open (file, NULL);
442         if (!image){
443                 fprintf (stderr, "Can not open image %s\n", file);
444                 exit (1);
445         }
446
447         if (dump_data)
448                 dump_dotnet_iinfo (image);
449         if (verify_pe) {
450                 int f = MONO_VERIFY_REPORT_ALL_ERRORS;
451                 char *tok = strtok (flags, ",");
452                 MonoAssembly *assembly;
453                 verify_metadata = 1;
454                 verify_code = 0;
455                 while (tok) {
456                         for (i = 0; flag_desc [i]; ++i) {
457                                 if (strcmp (tok, flag_desc [i]) == 0) {
458                                         if (flag_vals [i] == VERIFY_CODE_ONLY) {
459                                                 verify_metadata = 0;
460                                                 verify_code = 1;
461                                         } else if(flag_vals [i] == MONO_VERIFY_ALL)
462                                                 verify_code = 1;
463                                         if (flag_vals [i] == VALID_ONLY_FLAG)
464                                                 verifier_mode = MONO_VERIFIER_MODE_VALID;
465                                         else
466                                                 f |= flag_vals [i];
467                                         break;
468                                 }
469                         }
470                         if (!flag_desc [i])
471                                 g_print ("Unknown verify flag %s\n", tok);
472                         tok = strtok (NULL, ",");
473                 }
474
475                 mono_verifier_set_mode (verifier_mode);
476                 mono_init_from_assembly (file, file);
477                 assembly = mono_assembly_open (file, NULL);
478
479                 if (!assembly) {
480                         g_print ("Could not open assembly %s\n", file);
481                         return 4;
482                 }
483
484                 return dump_verify_info (assembly->image, f);
485         } else
486                 mono_image_close (image);
487         
488         return 0;
489 }
490