Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 754 lines (621 sloc) 18.897 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
//
// Mono.CSharp.Debugger/MonoSymbolFile.cs
//
// Author:
// Martin Baulig (martin@ximian.com)
//
// (C) 2003 Ximian, Inc. http://www.ximian.com
//

//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//

using System;
using System.Reflection;
using SRE = System.Reflection.Emit;
using System.Collections;
using System.Text;
using System.Threading;
using System.IO;

namespace Mono.CompilerServices.SymbolWriter
{
public class MonoSymbolFileException : Exception
{
public MonoSymbolFileException ()
: base ()
{ }

public MonoSymbolFileException (string message, params object[] args)
: base (String.Format (message, args))
{ }
}

internal class MyBinaryWriter : BinaryWriter
{
public MyBinaryWriter (Stream stream)
: base (stream)
{ }

public void WriteLeb128 (int value)
{
base.Write7BitEncodedInt (value);
}
}

internal class MyBinaryReader : BinaryReader
{
public MyBinaryReader (Stream stream)
: base (stream)
{ }

public int ReadLeb128 ()
{
return base.Read7BitEncodedInt ();
}

public string ReadString (int offset)
{
long old_pos = BaseStream.Position;
BaseStream.Position = offset;

string text = ReadString ();

BaseStream.Position = old_pos;
return text;
}
}

public interface ISourceFile
{
SourceFileEntry Entry {
get;
}
}

public interface ICompileUnit
{
CompileUnitEntry Entry {
get;
}
}

public interface IMethodDef
{
string Name {
get;
}

int Token {
get;
}
}

#if !CECIL
internal class MonoDebuggerSupport
{
static GetMethodTokenFunc get_method_token;
static GetGuidFunc get_guid;
static GetLocalIndexFunc get_local_index;

delegate int GetMethodTokenFunc (MethodBase method);
delegate Guid GetGuidFunc (Module module);
delegate int GetLocalIndexFunc (SRE.LocalBuilder local);

static Delegate create_delegate (Type type, Type delegate_type, string name)
{
MethodInfo mi = type.GetMethod (name, BindingFlags.Static |
BindingFlags.NonPublic);
if (mi == null)
throw new Exception ("Can't find " + name);

return Delegate.CreateDelegate (delegate_type, mi);
}

static MonoDebuggerSupport ()
{
get_method_token = (GetMethodTokenFunc) create_delegate (
typeof (Assembly), typeof (GetMethodTokenFunc),
"MonoDebugger_GetMethodToken");

get_guid = (GetGuidFunc) create_delegate (
typeof (Module), typeof (GetGuidFunc), "Mono_GetGuid");

get_local_index = (GetLocalIndexFunc) create_delegate (
typeof (SRE.LocalBuilder), typeof (GetLocalIndexFunc),
"Mono_GetLocalIndex");
}

public static int GetMethodToken (MethodBase method)
{
return get_method_token (method);
}

public static Guid GetGuid (Module module)
{
return get_guid (module);
}

public static int GetLocalIndex (SRE.LocalBuilder local)
{
return get_local_index (local);
}
}
#endif

public class MonoSymbolFile : IDisposable
{
ArrayList methods = new ArrayList ();
ArrayList sources = new ArrayList ();
ArrayList comp_units = new ArrayList ();
Hashtable type_hash = new Hashtable ();
Hashtable anonymous_scopes;

OffsetTable ot;
int last_type_index;
int last_method_index;
int last_namespace_index;

public readonly string FileName = "<dynamic>";
public readonly int MajorVersion = OffsetTable.MajorVersion;
public readonly int MinorVersion = OffsetTable.MinorVersion;

public int NumLineNumbers;

internal MonoSymbolFile ()
{
ot = new OffsetTable ();
}

internal int AddSource (SourceFileEntry source)
{
sources.Add (source);
return sources.Count;
}

internal int AddCompileUnit (CompileUnitEntry entry)
{
comp_units.Add (entry);
return comp_units.Count;
}

internal int DefineType (Type type)
{
if (type_hash.Contains (type))
return (int) type_hash [type];

int index = ++last_type_index;
type_hash.Add (type, index);
return index;
}

internal void AddMethod (MethodEntry entry)
{
methods.Add (entry);
}

public MethodEntry DefineMethod (CompileUnitEntry comp_unit, int token,
ScopeVariable[] scope_vars, LocalVariableEntry[] locals,
LineNumberEntry[] lines, CodeBlockEntry[] code_blocks,
string real_name, MethodEntry.Flags flags,
int namespace_id)
{
if (reader != null)
throw new InvalidOperationException ();

MethodEntry method = new MethodEntry (
this, comp_unit, token, scope_vars, locals, lines, code_blocks,
real_name, flags, namespace_id);
AddMethod (method);
return method;
}

internal void DefineAnonymousScope (int id)
{
if (reader != null)
throw new InvalidOperationException ();

if (anonymous_scopes == null)
anonymous_scopes = new Hashtable ();

anonymous_scopes.Add (id, new AnonymousScopeEntry (id));
}

internal void DefineCapturedVariable (int scope_id, string name, string captured_name,
CapturedVariable.CapturedKind kind)
{
if (reader != null)
throw new InvalidOperationException ();

AnonymousScopeEntry scope = (AnonymousScopeEntry) anonymous_scopes [scope_id];
scope.AddCapturedVariable (name, captured_name, kind);
}

internal void DefineCapturedScope (int scope_id, int id, string captured_name)
{
if (reader != null)
throw new InvalidOperationException ();

AnonymousScopeEntry scope = (AnonymousScopeEntry) anonymous_scopes [scope_id];
scope.AddCapturedScope (id, captured_name);
}

internal int GetNextTypeIndex ()
{
return ++last_type_index;
}

internal int GetNextMethodIndex ()
{
return ++last_method_index;
}

internal int GetNextNamespaceIndex ()
{
return ++last_namespace_index;
}

void Write (MyBinaryWriter bw, Guid guid)
{
// Magic number and file version.
bw.Write (OffsetTable.Magic);
bw.Write (MajorVersion);
bw.Write (MinorVersion);

bw.Write (guid.ToByteArray ());

//
// Offsets of file sections; we must write this after we're done
// writing the whole file, so we just reserve the space for it here.
//
long offset_table_offset = bw.BaseStream.Position;
ot.Write (bw, MajorVersion, MinorVersion);

//
// Sort the methods according to their tokens and update their index.
//
methods.Sort ();
for (int i = 0; i < methods.Count; i++)
((MethodEntry) methods [i]).Index = i + 1;

//
// Write data sections.
//
ot.DataSectionOffset = (int) bw.BaseStream.Position;
foreach (SourceFileEntry source in sources)
source.WriteData (bw);
foreach (CompileUnitEntry comp_unit in comp_units)
comp_unit.WriteData (bw);
foreach (MethodEntry method in methods)
method.WriteData (this, bw);
ot.DataSectionSize = (int) bw.BaseStream.Position - ot.DataSectionOffset;

//
// Write the method index table.
//
ot.MethodTableOffset = (int) bw.BaseStream.Position;
for (int i = 0; i < methods.Count; i++) {
MethodEntry entry = (MethodEntry) methods [i];
entry.Write (bw);
}
ot.MethodTableSize = (int) bw.BaseStream.Position - ot.MethodTableOffset;

//
// Write source table.
//
ot.SourceTableOffset = (int) bw.BaseStream.Position;
for (int i = 0; i < sources.Count; i++) {
SourceFileEntry source = (SourceFileEntry) sources [i];
source.Write (bw);
}
ot.SourceTableSize = (int) bw.BaseStream.Position - ot.SourceTableOffset;

//
// Write compilation unit table.
//
ot.CompileUnitTableOffset = (int) bw.BaseStream.Position;
for (int i = 0; i < comp_units.Count; i++) {
CompileUnitEntry unit = (CompileUnitEntry) comp_units [i];
unit.Write (bw);
}
ot.CompileUnitTableSize = (int) bw.BaseStream.Position - ot.CompileUnitTableOffset;

//
// Write anonymous scope table.
//
ot.AnonymousScopeCount = anonymous_scopes != null ? anonymous_scopes.Count : 0;
ot.AnonymousScopeTableOffset = (int) bw.BaseStream.Position;
if (anonymous_scopes != null) {
foreach (AnonymousScopeEntry scope in anonymous_scopes.Values)
scope.Write (bw);
}
ot.AnonymousScopeTableSize = (int) bw.BaseStream.Position - ot.AnonymousScopeTableOffset;

//
// Fixup offset table.
//
ot.TypeCount = last_type_index;
ot.MethodCount = methods.Count;
ot.SourceCount = sources.Count;
ot.CompileUnitCount = comp_units.Count;

//
// Write offset table.
//
ot.TotalFileSize = (int) bw.BaseStream.Position;
bw.Seek ((int) offset_table_offset, SeekOrigin.Begin);
ot.Write (bw, MajorVersion, MinorVersion);
bw.Seek (0, SeekOrigin.End);

#if false
Console.WriteLine ("TOTAL: {0} line numbes, {1} bytes, extended {2} bytes, " +
"{3} methods.", NumLineNumbers, LineNumberSize,
ExtendedLineNumberSize, methods.Count);
#endif
}

public void CreateSymbolFile (Guid guid, FileStream fs)
{
if (reader != null)
throw new InvalidOperationException ();

Write (new MyBinaryWriter (fs), guid);
}

MyBinaryReader reader;
Hashtable source_file_hash;
Hashtable compile_unit_hash;

ArrayList method_list;
Hashtable method_token_hash;
Hashtable source_name_hash;

Guid guid;

MonoSymbolFile (string filename)
{
this.FileName = filename;

FileStream stream;
try {
stream = new FileStream (filename, FileMode.Open, FileAccess.Read);
reader = new MyBinaryReader (stream);
} catch (IOException ex) {
throw new MonoSymbolFileException (
"Cannot read symbol file `{0}': {1}", filename, ex.Message);
}

try {
long magic = reader.ReadInt64 ();
int major_version = reader.ReadInt32 ();
int minor_version = reader.ReadInt32 ();

if (magic != OffsetTable.Magic)
throw new MonoSymbolFileException (
"Symbol file `{0}' is not a valid " +
"Mono symbol file", filename);
if (major_version != OffsetTable.MajorVersion)
throw new MonoSymbolFileException (
"Symbol file `{0}' has version {1}, " +
"but expected {2}", filename, major_version,
OffsetTable.MajorVersion);
if (minor_version != OffsetTable.MinorVersion)
throw new MonoSymbolFileException (
"Symbol file `{0}' has version {1}.{2}, " +
"but expected {3}.{4}", filename, major_version,
minor_version, OffsetTable.MajorVersion,
OffsetTable.MinorVersion);

MajorVersion = major_version;
MinorVersion = minor_version;
guid = new Guid (reader.ReadBytes (16));

ot = new OffsetTable (reader, major_version, minor_version);
} catch {
throw new MonoSymbolFileException (
"Cannot read symbol file `{0}'", filename);
}

source_file_hash = new Hashtable ();
compile_unit_hash = new Hashtable ();
}

void CheckGuidMatch (Guid other, string filename, string assembly)
{
if (other == guid)
return;

throw new MonoSymbolFileException (
"Symbol file `{0}' does not match assembly `{1}'",
filename, assembly);
}

#if CECIL
protected MonoSymbolFile (string filename, Mono.Cecil.ModuleDefinition module)
: this (filename)
{
CheckGuidMatch (module.Mvid, filename, module.FullyQualifiedName);
}

public static MonoSymbolFile ReadSymbolFile (Mono.Cecil.ModuleDefinition module)
{
return ReadSymbolFile (module, module.FullyQualifiedName);
}

public static MonoSymbolFile ReadSymbolFile (Mono.Cecil.ModuleDefinition module, string filename)
{
string name = filename + ".mdb";

return new MonoSymbolFile (name, module);
}
#else
protected MonoSymbolFile (string filename, Assembly assembly) : this (filename)
{
// Check that the MDB file matches the assembly, if we have been
// passed an assembly.
if (assembly == null)
return;

Module[] modules = assembly.GetModules ();
Guid assembly_guid = MonoDebuggerSupport.GetGuid (modules [0]);

CheckGuidMatch (assembly_guid, filename, assembly.Location);
}

public static MonoSymbolFile ReadSymbolFile (Assembly assembly)
{
string filename = assembly.Location;
string name = filename + ".mdb";

return new MonoSymbolFile (name, assembly);
}
#endif

public static MonoSymbolFile ReadSymbolFile (string mdbFilename)
{
return new MonoSymbolFile (mdbFilename, null);
}

public int CompileUnitCount {
get { return ot.CompileUnitCount; }
}

public int SourceCount {
get { return ot.SourceCount; }
}

public int MethodCount {
get { return ot.MethodCount; }
}

public int TypeCount {
get { return ot.TypeCount; }
}

public int AnonymousScopeCount {
get { return ot.AnonymousScopeCount; }
}

public int NamespaceCount {
get { return last_namespace_index; }
}

public Guid Guid {
get { return guid; }
}

public OffsetTable OffsetTable {
get { return ot; }
}

internal int LineNumberCount = 0;
internal int LocalCount = 0;
internal int StringSize = 0;

internal int LineNumberSize = 0;
internal int ExtendedLineNumberSize = 0;

public SourceFileEntry GetSourceFile (int index)
{
if ((index < 1) || (index > ot.SourceCount))
throw new ArgumentException ();
if (reader == null)
throw new InvalidOperationException ();

lock (this) {
SourceFileEntry source = (SourceFileEntry) source_file_hash [index];
if (source != null)
return source;

long old_pos = reader.BaseStream.Position;

reader.BaseStream.Position = ot.SourceTableOffset +
SourceFileEntry.Size * (index - 1);
source = new SourceFileEntry (this, reader);
source_file_hash.Add (index, source);

reader.BaseStream.Position = old_pos;
return source;
}
}

public SourceFileEntry[] Sources {
get {
if (reader == null)
throw new InvalidOperationException ();

SourceFileEntry[] retval = new SourceFileEntry [SourceCount];
for (int i = 0; i < SourceCount; i++)
retval [i] = GetSourceFile (i + 1);
return retval;
}
}

public CompileUnitEntry GetCompileUnit (int index)
{
if ((index < 1) || (index > ot.CompileUnitCount))
throw new ArgumentException ();
if (reader == null)
throw new InvalidOperationException ();

lock (this) {
CompileUnitEntry unit = (CompileUnitEntry) compile_unit_hash [index];
if (unit != null)
return unit;

long old_pos = reader.BaseStream.Position;

reader.BaseStream.Position = ot.CompileUnitTableOffset +
CompileUnitEntry.Size * (index - 1);
unit = new CompileUnitEntry (this, reader);
compile_unit_hash.Add (index, unit);

reader.BaseStream.Position = old_pos;
return unit;
}
}

public CompileUnitEntry[] CompileUnits {
get {
if (reader == null)
throw new InvalidOperationException ();

CompileUnitEntry[] retval = new CompileUnitEntry [CompileUnitCount];
for (int i = 0; i < CompileUnitCount; i++)
retval [i] = GetCompileUnit (i + 1);
return retval;
}
}

void read_methods ()
{
lock (this) {
if (method_token_hash != null)
return;

method_token_hash = new Hashtable ();
method_list = new ArrayList ();

long old_pos = reader.BaseStream.Position;
reader.BaseStream.Position = ot.MethodTableOffset;

for (int i = 0; i < MethodCount; i++) {
MethodEntry entry = new MethodEntry (this, reader, i + 1);
method_token_hash.Add (entry.Token, entry);
method_list.Add (entry);
}

reader.BaseStream.Position = old_pos;
}
}

public MethodEntry GetMethodByToken (int token)
{
if (reader == null)
throw new InvalidOperationException ();

lock (this) {
read_methods ();
return (MethodEntry) method_token_hash [token];
}
}

public MethodEntry GetMethod (int index)
{
if ((index < 1) || (index > ot.MethodCount))
throw new ArgumentException ();
if (reader == null)
throw new InvalidOperationException ();

lock (this) {
read_methods ();
return (MethodEntry) method_list [index - 1];
}
}

public MethodEntry[] Methods {
get {
if (reader == null)
throw new InvalidOperationException ();

lock (this) {
read_methods ();
MethodEntry[] retval = new MethodEntry [MethodCount];
method_list.CopyTo (retval, 0);
return retval;
}
}
}

public int FindSource (string file_name)
{
if (reader == null)
throw new InvalidOperationException ();

lock (this) {
if (source_name_hash == null) {
source_name_hash = new Hashtable ();

for (int i = 0; i < ot.SourceCount; i++) {
SourceFileEntry source = GetSourceFile (i + 1);
source_name_hash.Add (source.FileName, i);
}
}

object value = source_name_hash [file_name];
if (value == null)
return -1;
return (int) value;
}
}

void read_scopes ()
{
lock (this) {
if (anonymous_scopes != null)
return;

long old_pos = reader.BaseStream.Position;
reader.BaseStream.Position = ot.AnonymousScopeTableOffset;

anonymous_scopes = new Hashtable ();
for (int i = 0; i < ot.AnonymousScopeCount; i++) {
AnonymousScopeEntry scope = new AnonymousScopeEntry (reader);
anonymous_scopes.Add (scope.ID, scope);
}

reader.BaseStream.Position = old_pos;
}
}

public AnonymousScopeEntry GetAnonymousScope (int id)
{
if (reader == null)
throw new InvalidOperationException ();

lock (this) {
read_scopes ();
return (AnonymousScopeEntry) anonymous_scopes [id];
}
}

public AnonymousScopeEntry[] AnonymousScopes {
get {
read_scopes ();
AnonymousScopeEntry[] scopes = new AnonymousScopeEntry [anonymous_scopes.Count];
anonymous_scopes.Values.CopyTo (scopes, 0);
return scopes;
}
}

internal MyBinaryReader BinaryReader {
get {
if (reader == null)
throw new InvalidOperationException ();

return reader;
}
}

public void Dispose ()
{
Dispose (true);
}

protected virtual void Dispose (bool disposing)
{
if (disposing) {
if (reader != null) {
reader.Close ();
reader = null;
}
}
}
}
}
Something went wrong with that request. Please try again.