2 * debug-mono-ppdb.c: Support for the portable PDB symbol
7 * Mono Project (http://www.mono-project.com)
9 * Copyright 2015 Xamarin Inc (http://www.xamarin.com)
17 #include <mono/metadata/metadata.h>
18 #include <mono/metadata/tabledefs.h>
19 #include <mono/metadata/tokentype.h>
20 #include <mono/metadata/debug-helpers.h>
21 #include <mono/metadata/mono-debug.h>
22 #include <mono/metadata/debug-mono-symfile.h>
23 #include <mono/metadata/mono-debug-debugger.h>
24 #include <mono/metadata/mono-endian.h>
25 #include <mono/metadata/metadata-internals.h>
26 #include <mono/metadata/class-internals.h>
27 #include <mono/metadata/cil-coff.h>
29 #include "debug-mono-ppdb.h"
31 struct _MonoPPDBFile {
34 GHashTable *method_hash;
37 /* IMAGE_DEBUG_DIRECTORY structure */
40 gint32 characteristics;
41 gint32 time_date_stamp;
48 } ImageDebugDirectory;
54 } CodeviewDebugDirectory;
59 guint64 referenced_tables;
63 get_pe_debug_guid (MonoImage *image, guint8 *out_guid, gint32 *out_age, gint32 *out_timestamp)
65 MonoPEDirEntry *debug_dir_entry;
66 ImageDebugDirectory *debug_dir;
68 debug_dir_entry = &((MonoCLIImageInfo*)image->image_info)->cli_header.datadir.pe_debug;
69 if (!debug_dir_entry->size)
72 int offset = mono_cli_rva_image_map (image, debug_dir_entry->rva);
73 debug_dir = (ImageDebugDirectory*)(image->raw_data + offset);
74 if (debug_dir->type == 2 && debug_dir->major_version == 0x100 && debug_dir->minor_version == 0x504d) {
75 /* This is a 'CODEVIEW' debug directory */
76 CodeviewDebugDirectory *dir = (CodeviewDebugDirectory*)(image->raw_data + debug_dir->pointer);
78 if (dir->signature == 0x53445352) {
79 memcpy (out_guid, dir->guid, 16);
81 *out_timestamp = debug_dir->time_date_stamp;
89 doc_free (gpointer key)
91 MonoDebugSourceInfo *info = (MonoDebugSourceInfo *)key;
93 g_free (info->source_file);
98 mono_ppdb_load_file (MonoImage *image, const guint8 *raw_contents, int size)
100 MonoImage *ppdb_image = NULL;
101 const char *filename;
102 char *s, *ppdb_filename;
103 MonoImageOpenStatus status;
110 if (size > 4 && strncmp ((char*)raw_contents, "BSJB", 4) == 0)
111 ppdb_image = mono_image_open_from_data_internal ((char*)raw_contents, size, TRUE, &status, FALSE, TRUE, NULL);
113 /* ppdb files drop the .exe/.dll extension */
114 filename = mono_image_get_filename (image);
115 if (strlen (filename) > 4 && (!strcmp (filename + strlen (filename) - 4, ".exe") || !strcmp (filename + strlen (filename) - 4, ".dll"))) {
116 s = g_strdup (filename);
117 s [strlen (filename) - 4] = '\0';
118 ppdb_filename = g_strdup_printf ("%s.pdb", s);
121 ppdb_filename = g_strdup_printf ("%s.pdb", filename);
124 ppdb_image = mono_image_open_metadata_only (ppdb_filename, &status);
126 g_free (ppdb_filename);
132 * Check that the images match.
133 * The same id is stored in the Debug Directory of the PE file, and in the
134 * #Pdb stream in the ppdb file.
136 if (get_pe_debug_guid (image, pe_guid, &pe_age, &pe_timestamp)) {
137 PdbStreamHeader *pdb_stream = (PdbStreamHeader*)ppdb_image->heap_pdb.data;
139 g_assert (pdb_stream);
141 /* The pdb id is a concentation of the pe guid and the timestamp */
142 if (memcmp (pe_guid, pdb_stream->guid, 16) != 0 || memcmp (&pe_timestamp, pdb_stream->guid + 16, 4) != 0) {
143 g_warning ("Symbol file %s doesn't match image %s", ppdb_image->name,
145 mono_image_close (ppdb_image);
150 ppdb = g_new0 (MonoPPDBFile, 1);
151 ppdb->image = ppdb_image;
152 ppdb->doc_hash = g_hash_table_new_full (NULL, NULL, NULL, (GDestroyNotify) doc_free);
153 ppdb->method_hash = g_hash_table_new_full (NULL, NULL, NULL, (GDestroyNotify) g_free);
159 mono_ppdb_close (MonoDebugHandle *handle)
161 MonoPPDBFile *ppdb = handle->ppdb;
163 mono_image_close (ppdb->image);
164 g_hash_table_destroy (ppdb->doc_hash);
165 g_hash_table_destroy (ppdb->method_hash);
169 MonoDebugMethodInfo *
170 mono_ppdb_lookup_method (MonoDebugHandle *handle, MonoMethod *method)
172 MonoDebugMethodInfo *minfo;
173 MonoPPDBFile *ppdb = handle->ppdb;
175 if (handle->image != mono_class_get_image (mono_method_get_class (method)))
178 mono_debugger_lock ();
180 minfo = (MonoDebugMethodInfo *)g_hash_table_lookup (ppdb->method_hash, method);
182 mono_debugger_unlock ();
186 minfo = g_new0 (MonoDebugMethodInfo, 1);
188 minfo->method = method;
189 minfo->handle = handle;
191 g_hash_table_insert (ppdb->method_hash, method, minfo);
193 mono_debugger_unlock ();
198 static MonoDebugSourceInfo*
199 get_docinfo (MonoPPDBFile *ppdb, MonoImage *image, int docidx)
201 MonoTableInfo *tables = image->tables;
202 guint32 cols [MONO_DOCUMENT_SIZE];
205 const char *part_ptr;
206 int size, part_size, partidx, nparts;
209 MonoDebugSourceInfo *res, *cached;
211 mono_debugger_lock ();
212 cached = (MonoDebugSourceInfo *)g_hash_table_lookup (ppdb->doc_hash, GUINT_TO_POINTER (docidx));
213 mono_debugger_unlock ();
217 mono_metadata_decode_row (&tables [MONO_TABLE_DOCUMENT], docidx-1, cols, MONO_DOCUMENT_SIZE);
219 ptr = mono_metadata_blob_heap (image, cols [MONO_DOCUMENT_NAME]);
220 size = mono_metadata_decode_blob_size (ptr, &ptr);
227 s = g_string_new ("");
230 while (ptr < start + size) {
231 partidx = mono_metadata_decode_value (ptr, &ptr);
233 g_string_append_c (s, sep);
235 part_ptr = mono_metadata_blob_heap (image, partidx);
236 part_size = mono_metadata_decode_blob_size (part_ptr, &part_ptr);
239 g_string_append_len (s, part_ptr, part_size);
244 res = g_new0 (MonoDebugSourceInfo, 1);
245 res->source_file = g_string_free (s, FALSE);
247 res->hash = (guint8*)mono_metadata_blob_heap (image, cols [MONO_DOCUMENT_HASH]);
249 mono_debugger_lock ();
250 cached = (MonoDebugSourceInfo *)g_hash_table_lookup (ppdb->doc_hash, GUINT_TO_POINTER (docidx));
252 g_hash_table_insert (ppdb->doc_hash, GUINT_TO_POINTER (docidx), res);
257 mono_debugger_unlock ();
262 get_docname (MonoPPDBFile *ppdb, MonoImage *image, int docidx)
264 MonoDebugSourceInfo *info;
266 info = get_docinfo (ppdb, image, docidx);
267 return g_strdup (info->source_file);
271 * mono_ppdb_lookup_location:
272 * @minfo: A `MonoDebugMethodInfo' which can be retrieved by
273 * mono_debug_lookup_method().
274 * @offset: IL offset within the corresponding method's CIL code.
276 * This function is similar to mono_debug_lookup_location(), but we
277 * already looked up the method and also already did the
278 * `native address -> IL offset' mapping.
280 MonoDebugSourceLocation *
281 mono_ppdb_lookup_location (MonoDebugMethodInfo *minfo, uint32_t offset)
283 MonoPPDBFile *ppdb = minfo->handle->ppdb;
284 MonoImage *image = ppdb->image;
285 MonoMethod *method = minfo->method;
286 MonoTableInfo *tables = image->tables;
287 guint32 cols [MONO_METHODBODY_SIZE];
291 int idx, size, docidx, iloffset, delta_il, delta_lines, delta_cols, start_line, start_col, adv_line, adv_col;
292 gboolean first = TRUE, first_non_hidden = TRUE;
293 MonoDebugSourceLocation *location;
298 idx = mono_metadata_token_index (method->token);
300 mono_metadata_decode_row (&tables [MONO_TABLE_METHODBODY], idx-1, cols, MONO_METHODBODY_SIZE);
302 docidx = cols [MONO_METHODBODY_DOCUMENT];
304 if (!cols [MONO_METHODBODY_SEQ_POINTS])
306 ptr = mono_metadata_blob_heap (image, cols [MONO_METHODBODY_SEQ_POINTS]);
307 size = mono_metadata_decode_blob_size (ptr, &ptr);
312 mono_metadata_decode_value (ptr, &ptr);
314 docidx = mono_metadata_decode_value (ptr, &ptr);
315 docname = get_docname (ppdb, image, docidx);
321 delta_il = mono_metadata_decode_value (ptr, &ptr);
322 if (!first && delta_il == 0) {
323 /* document-record */
324 docidx = mono_metadata_decode_value (ptr, &ptr);
325 docname = get_docname (ppdb, image, docidx);
328 if (!first && iloffset + delta_il > offset)
330 iloffset += delta_il;
333 delta_lines = mono_metadata_decode_value (ptr, &ptr);
334 if (delta_lines == 0)
335 delta_cols = mono_metadata_decode_value (ptr, &ptr);
337 delta_cols = mono_metadata_decode_signed_value (ptr, &ptr);
338 if (delta_lines == 0 && delta_cols == 0)
339 /* hidden-sequence-point-record */
341 if (first_non_hidden) {
342 start_line = mono_metadata_decode_value (ptr, &ptr);
343 start_col = mono_metadata_decode_value (ptr, &ptr);
345 adv_line = mono_metadata_decode_signed_value (ptr, &ptr);
346 adv_col = mono_metadata_decode_signed_value (ptr, &ptr);
347 start_line += adv_line;
348 start_col += adv_col;
350 first_non_hidden = FALSE;
353 location = g_new0 (MonoDebugSourceLocation, 1);
354 location->source_file = docname;
355 location->row = start_line;
356 location->il_offset = iloffset;
362 mono_ppdb_get_seq_points (MonoDebugMethodInfo *minfo, char **source_file, GPtrArray **source_file_list, int **source_files, MonoSymSeqPoint **seq_points, int *n_seq_points)
364 MonoPPDBFile *ppdb = minfo->handle->ppdb;
365 MonoImage *image = ppdb->image;
366 MonoMethod *method = minfo->method;
367 MonoTableInfo *tables = image->tables;
368 guint32 cols [MONO_METHODBODY_SIZE];
371 MonoDebugSourceInfo *docinfo;
372 int i, method_idx, size, docidx, iloffset, delta_il, delta_lines, delta_cols, start_line, start_col, adv_line, adv_col;
373 gboolean first = TRUE, first_non_hidden = TRUE;
376 GPtrArray *sfiles = NULL;
377 GPtrArray *sindexes = NULL;
381 if (source_file_list)
382 *source_file_list = NULL;
384 *source_files = NULL;
390 if (source_file_list)
391 *source_file_list = sfiles = g_ptr_array_new ();
393 sindexes = g_ptr_array_new ();
398 method_idx = mono_metadata_token_index (method->token);
400 mono_metadata_decode_row (&tables [MONO_TABLE_METHODBODY], method_idx-1, cols, MONO_METHODBODY_SIZE);
402 docidx = cols [MONO_METHODBODY_DOCUMENT];
404 if (!cols [MONO_METHODBODY_SEQ_POINTS])
407 ptr = mono_metadata_blob_heap (image, cols [MONO_METHODBODY_SEQ_POINTS]);
408 size = mono_metadata_decode_blob_size (ptr, &ptr);
411 sps = g_array_new (FALSE, TRUE, sizeof (MonoSymSeqPoint));
415 mono_metadata_decode_value (ptr, &ptr);
417 docidx = mono_metadata_decode_value (ptr, &ptr);
418 docinfo = get_docinfo (ppdb, image, docidx);
421 g_ptr_array_add (sfiles, docinfo);
427 delta_il = mono_metadata_decode_value (ptr, &ptr);
428 if (!first && delta_il == 0) {
429 /* subsequent-document-record */
430 docidx = mono_metadata_decode_value (ptr, &ptr);
431 docinfo = get_docinfo (ppdb, image, docidx);
433 g_ptr_array_add (sfiles, docinfo);
436 iloffset += delta_il;
439 delta_lines = mono_metadata_decode_value (ptr, &ptr);
440 if (delta_lines == 0)
441 delta_cols = mono_metadata_decode_value (ptr, &ptr);
443 delta_cols = mono_metadata_decode_signed_value (ptr, &ptr);
445 if (delta_lines == 0 && delta_cols == 0) {
446 /* Hidden sequence point */
450 if (first_non_hidden) {
451 start_line = mono_metadata_decode_value (ptr, &ptr);
452 start_col = mono_metadata_decode_value (ptr, &ptr);
454 adv_line = mono_metadata_decode_signed_value (ptr, &ptr);
455 adv_col = mono_metadata_decode_signed_value (ptr, &ptr);
456 start_line += adv_line;
457 start_col += adv_col;
459 first_non_hidden = FALSE;
461 memset (&sp, 0, sizeof (sp));
462 sp.il_offset = iloffset;
463 sp.line = start_line;
464 sp.column = start_col;
465 sp.end_line = start_line + delta_lines;
466 sp.end_column = start_col + delta_cols;
468 g_array_append_val (sps, sp);
470 g_ptr_array_add (sindexes, GUINT_TO_POINTER (sfiles->len - 1));
474 *n_seq_points = sps->len;
475 g_assert (seq_points);
476 *seq_points = g_new (MonoSymSeqPoint, sps->len);
477 memcpy (*seq_points, sps->data, sps->len * sizeof (MonoSymSeqPoint));
481 *source_file = g_strdup (((MonoDebugSourceInfo*)g_ptr_array_index (sfiles, 0))->source_file);
483 *source_files = g_new (int, sps->len);
484 for (i = 0; i < sps->len; ++i)
485 (*source_files)[i] = GPOINTER_TO_INT (g_ptr_array_index (sindexes, i));
486 g_ptr_array_free (sindexes, TRUE);
489 g_array_free (sps, TRUE);
493 mono_ppdb_lookup_locals (MonoDebugMethodInfo *minfo)
495 MonoPPDBFile *ppdb = minfo->handle->ppdb;
496 MonoImage *image = ppdb->image;
497 MonoTableInfo *tables = image->tables;
498 MonoMethod *method = minfo->method;
499 guint32 cols [MONO_LOCALSCOPE_SIZE];
500 guint32 locals_cols [MONO_LOCALVARIABLE_SIZE];
501 int i, lindex, sindex, method_idx, start_scope_idx, scope_idx, locals_idx, locals_end_idx, nscopes;
502 MonoDebugLocalsInfo *res;
503 MonoMethodSignature *sig;
508 sig = mono_method_signature (method);
512 method_idx = mono_metadata_token_index (method->token);
514 start_scope_idx = mono_metadata_localscope_from_methoddef (image, method_idx);
516 if (!start_scope_idx)
519 /* Compute number of locals and scopes */
520 scope_idx = start_scope_idx;
521 mono_metadata_decode_row (&tables [MONO_TABLE_LOCALSCOPE], scope_idx-1, cols, MONO_LOCALSCOPE_SIZE);
522 locals_idx = cols [MONO_LOCALSCOPE_VARIABLELIST];
524 // https://github.com/dotnet/roslyn/blob/2ae8d5fed96ab3f1164031f9b4ac827f53289159/docs/specs/PortablePdb-Metadata.md#LocalScopeTable
526 // The variableList attribute in the pdb metadata table is a contiguous array that starts at a
527 // given offset (locals_idx) above and
530 // continues to the smaller of:
532 // the last row of the LocalVariable table
533 // the next run of LocalVariables, found by inspecting the VariableList of the next row in this LocalScope table.
535 // this endpoint becomes locals_end_idx below
537 // March to the last scope that is in this method
538 while (scope_idx <= tables [MONO_TABLE_LOCALSCOPE].rows) {
539 mono_metadata_decode_row (&tables [MONO_TABLE_LOCALSCOPE], scope_idx-1, cols, MONO_LOCALSCOPE_SIZE);
540 if (cols [MONO_LOCALSCOPE_METHOD] != method_idx)
544 // The number of scopes is the difference in the indices
545 // for the first and last scopes
546 nscopes = scope_idx - start_scope_idx;
548 // Ends with "the last row of the LocalVariable table"
549 // this happens if the above loop marched one past the end
551 if (scope_idx > tables [MONO_TABLE_LOCALSCOPE].rows) {
552 locals_end_idx = tables [MONO_TABLE_LOCALVARIABLE].rows + 1;
554 // Ends with "the next run of LocalVariables,
555 // found by inspecting the VariableList of the next row in this LocalScope table."
556 locals_end_idx = cols [MONO_LOCALSCOPE_VARIABLELIST];
559 res = g_new0 (MonoDebugLocalsInfo, 1);
560 res->num_blocks = nscopes;
561 res->code_blocks = g_new0 (MonoDebugCodeBlock, res->num_blocks);
562 res->num_locals = locals_end_idx - locals_idx;
563 res->locals = g_new0 (MonoDebugLocalVar, res->num_locals);
566 for (sindex = 0; sindex < nscopes; ++sindex) {
567 scope_idx = start_scope_idx + sindex;
568 mono_metadata_decode_row (&tables [MONO_TABLE_LOCALSCOPE], scope_idx-1, cols, MONO_LOCALSCOPE_SIZE);
570 locals_idx = cols [MONO_LOCALSCOPE_VARIABLELIST];
571 if (scope_idx == tables [MONO_TABLE_LOCALSCOPE].rows) {
572 locals_end_idx = tables [MONO_TABLE_LOCALVARIABLE].rows + 1;
574 locals_end_idx = mono_metadata_decode_row_col (&tables [MONO_TABLE_LOCALSCOPE], scope_idx-1 + 1, MONO_LOCALSCOPE_VARIABLELIST);
577 res->code_blocks [sindex].start_offset = cols [MONO_LOCALSCOPE_STARTOFFSET];
578 res->code_blocks [sindex].end_offset = cols [MONO_LOCALSCOPE_STARTOFFSET] + cols [MONO_LOCALSCOPE_LENGTH];
580 //printf ("Scope: %s %d %d %d-%d\n", mono_method_full_name (method, 1), cols [MONO_LOCALSCOPE_STARTOFFSET], cols [MONO_LOCALSCOPE_LENGTH], locals_idx, locals_end_idx);
582 for (i = locals_idx; i < locals_end_idx; ++i) {
583 mono_metadata_decode_row (&tables [MONO_TABLE_LOCALVARIABLE], i - 1, locals_cols, MONO_LOCALVARIABLE_SIZE);
585 res->locals [lindex].name = g_strdup (mono_metadata_string_heap (image, locals_cols [MONO_LOCALVARIABLE_NAME]));
586 res->locals [lindex].index = locals_cols [MONO_LOCALVARIABLE_INDEX];
587 res->locals [lindex].block = &res->code_blocks [sindex];
590 //printf ("\t %s %d\n", mono_metadata_string_heap (image, locals_cols [MONO_LOCALVARIABLE_NAME]), locals_cols [MONO_LOCALVARIABLE_INDEX]);