mcs/class/Mono.CSharp.Debugger/MonoSymbolFile.cs

   1 //
   2 // System.Diagnostics.SymbolStore/MonoSymbolFile.cs
   3 //
   4 // Author:
   5 //   Martin Baulig (martin@gnome.org)
   6 //
   7 // (C) 2003 Ximian, Inc.  http://www.ximian.com
   8 //
   9
  10 using System;
  11 using System.Reflection;
  12 using System.Reflection.Emit;
  13 using System.Collections;
  14 using System.Text;
  15 using System.IO;
  16
  17 namespace Mono.CSharp.Debugger
  18 {
  19         public class MonoSymbolFileException : Exception
  20         {
  21                 public MonoSymbolFileException ()
  22                         : base ()
  23                 { }
  24
  25                 public MonoSymbolFileException (string message, params object[] args)
  26                         : base (String.Format (message, args))
  27                 { }
  28         }
  29
  30         internal class MyMemoryStream : Stream
  31         {
  32                 int length;
  33                 int real_length;
  34                 int position;
  35
  36                 int chunk_size = 4096;
  37                 ArrayList chunks = new ArrayList ();
  38
  39                 private struct Chunk {
  40                         public readonly int Offset;
  41                         public readonly int Length;
  42                         public byte[] Buffer;
  43
  44                         public Chunk (int offset, int length)
  45                         {
  46                                 this.Offset = offset;
  47                                 this.Length = length;
  48                                 this.Buffer = new Byte [length];
  49                         }
  50                 }
  51
  52                 public override long Position {
  53                         get { return position; }
  54
  55                         set {
  56                                 if (value > length)
  57                                         throw new ArgumentOutOfRangeException ();
  58
  59                                 position = (int) value;
  60                         }
  61                 }
  62
  63                 public override long Length {
  64                         get { return length; }
  65                 }
  66
  67                 public override bool CanRead {
  68                         get { return true; }
  69                 }
  70
  71                 public override bool CanWrite {
  72                         get { return true; }
  73                 }
  74
  75                 public override bool CanSeek {
  76                         get { return true; }
  77                 }
  78
  79                 public override void SetLength (long new_length)
  80                 {
  81                         if (new_length < length)
  82                                 throw new ArgumentException ();
  83
  84                         while (new_length >= real_length) {
  85                                 Chunk new_chunk = new Chunk (real_length, chunk_size);
  86                                 chunks.Add (new_chunk);
  87                                 real_length += chunk_size;
  88                         }
  89
  90                         length = (int) new_length;
  91                 }
  92
  93                 public override void Flush ()
  94                 { }
  95
  96                 public override long Seek (long offset, SeekOrigin origin)
  97                 {
  98                         int ref_point;
  99
 100                         switch (origin) {
 101                         case SeekOrigin.Begin:
 102                                 ref_point = 0;
 103                                 break;
 104                         case SeekOrigin.Current:
 105                                 ref_point = position;
 106                                 break;
 107                         case SeekOrigin.End:
 108                                 ref_point = length;
 109                                 break;
 110                         default:
 111                                 throw new ArgumentException ("Invalid SeekOrigin");
 112                         }
 113
 114                         if ((ref_point + offset < 0) || (offset > real_length))
 115                                 throw new ArgumentOutOfRangeException ();
 116
 117                         position = ref_point + (int) offset;
 118
 119                         return position;
 120                 }
 121
 122                 Chunk FindChunk (int offset)
 123                 {
 124                         return (Chunk) chunks [offset / chunk_size];
 125                 }
 126
 127                 public override int Read (byte[] buffer, int offset, int count)
 128                 {
 129                         int old_count = count;
 130
 131                         while (count > 0) {
 132                                 Chunk chunk = FindChunk (position);
 133                                 int coffset = position - chunk.Offset;
 134                                 int rest = chunk.Length - coffset;
 135                                 int size = System.Math.Min (count, rest);
 136
 137                                 Array.Copy (chunk.Buffer, coffset, buffer, offset, size);
 138                                 position += size;
 139                                 offset += size;
 140                                 count -= size;
 141                         }
 142
 143                         return old_count;
 144                 }
 145
 146                 public override void Write (byte[] buffer, int offset, int count)
 147                 {
 148                         if (position + count > length)
 149                                 SetLength (position + count);
 150
 151                         while (count > 0) {
 152                                 Chunk chunk = FindChunk (position);
 153                                 int coffset = position - chunk.Offset;
 154                                 int rest = chunk.Length - coffset;
 155                                 int size = System.Math.Min (count, rest);
 156
 157                                 Array.Copy (buffer, offset, chunk.Buffer, coffset, size);
 158                                 position += size;
 159                                 offset += size;
 160                                 count -= size;
 161                         }
 162                 }
 163
 164                 public byte[] GetContents ()
 165                 {
 166                         byte[] retval = new byte [length];
 167                         position = 0;
 168                         Read (retval, 0, length);
 169                         return retval;
 170                 }
 171         }
 172
 173         public class MonoSymbolFile : IDisposable
 174         {
 175                 ArrayList methods = new ArrayList ();
 176                 ArrayList sources = new ArrayList ();
 177                 Hashtable method_source_hash = new Hashtable ();
 178                 Hashtable type_hash = new Hashtable ();
 179
 180                 OffsetTable ot;
 181                 int last_type_index;
 182                 int last_method_index;
 183                 int last_source_index;
 184                 int last_namespace_index;
 185
 186                 public MonoSymbolFile ()
 187                 { }
 188
 189                 internal int AddSource (SourceFileEntry source)
 190                 {
 191                         sources.Add (source);
 192                         return ++last_source_index;
 193                 }
 194
 195                 internal int DefineType (Type type)
 196                 {
 197                         if (type_hash.Contains (type))
 198                                 return (int) type_hash [type];
 199
 200                         int index = ++last_type_index;
 201                         type_hash.Add (type, index);
 202                         return index;
 203                 }
 204
 205                 internal void AddMethod (MethodEntry entry)
 206                 {
 207                         methods.Add (entry);
 208                 }
 209
 210                 internal int GetNextTypeIndex ()
 211                 {
 212                         return ++last_type_index;
 213                 }
 214
 215                 internal int GetNextMethodIndex ()
 216                 {
 217                         return ++last_method_index;
 218                 }
 219
 220                 internal int GetNextNamespaceIndex ()
 221                 {
 222                         return ++last_namespace_index;
 223                 }
 224
 225                 internal void WriteString (BinaryWriter bw, string text)
 226                 {
 227                         byte[] data = Encoding.UTF8.GetBytes (text);
 228                         bw.Write ((int) data.Length);
 229                         bw.Write (data);
 230                         StringSize += data.Length;
 231                 }
 232
 233                 internal string ReadString (int offset)
 234                 {
 235                         int old_pos = (int) reader.BaseStream.Position;
 236                         reader.BaseStream.Position = offset;
 237                         int length = reader.ReadInt32 ();
 238
 239                         byte[] data = reader.ReadBytes (length);
 240                         string text = Encoding.UTF8.GetString (data);
 241                         reader.BaseStream.Position = old_pos;
 242                         return text;
 243                 }
 244
 245                 void Write (BinaryWriter bw)
 246                 {
 247                         // Magic number and file version.
 248                         bw.Write (OffsetTable.Magic);
 249                         bw.Write (OffsetTable.Version);
 250
 251                         //
 252                         // Offsets of file sections; we must write this after we're done
 253                         // writing the whole file, so we just reserve the space for it here.
 254                         //
 255                         long offset_table_offset = bw.BaseStream.Position;
 256                         ot.Write (bw);
 257
 258                         //
 259                         // Write data sections.
 260                         //
 261                         ot.DataSectionOffset = (int) bw.BaseStream.Position;
 262                         foreach (SourceFileEntry source in sources)
 263                                 source.WriteData (bw);
 264                         ot.DataSectionSize = (int) bw.BaseStream.Position - ot.DataSectionOffset;
 265
 266                         //
 267                         // Write method table.
 268                         //
 269                         ot.MethodTableOffset = (int) bw.BaseStream.Position;
 270                         for (int i = 0; i < methods.Count; i++) {
 271                                 MethodEntry entry = (MethodEntry) methods [i];
 272                                 entry.WriteIndex (bw);
 273                         }
 274                         ot.MethodTableSize = (int) bw.BaseStream.Position - ot.MethodTableOffset;
 275
 276                         //
 277                         // Write source table.
 278                         //
 279                         ot.SourceTableOffset = (int) bw.BaseStream.Position;
 280                         for (int i = 0; i < sources.Count; i++) {
 281                                 SourceFileEntry source = (SourceFileEntry) sources [i];
 282                                 source.Write (bw);
 283                         }
 284                         ot.SourceTableSize = (int) bw.BaseStream.Position - ot.SourceTableOffset;
 285
 286                         //
 287                         // Fixup offset table.
 288                         //
 289                         ot.TypeCount = last_type_index;
 290                         ot.MethodCount = methods.Count;
 291                         ot.SourceCount = sources.Count;
 292
 293                         //
 294                         // Write offset table.
 295                         //
 296                         ot.TotalFileSize = (int) bw.BaseStream.Position;
 297                         bw.Seek ((int) offset_table_offset, SeekOrigin.Begin);
 298                         ot.Write (bw);
 299                         bw.Seek (0, SeekOrigin.End);
 300                 }
 301
 302                 public byte[] CreateSymbolFile ()
 303                 {
 304                         if (reader != null)
 305                                 throw new InvalidOperationException ();
 306
 307                         using (MyMemoryStream stream = new MyMemoryStream ()) {
 308                                 Write (new BinaryWriter (stream));
 309                                 Console.WriteLine ("WROTE SYMFILE: {0} sources, {1} methods, {2} types, " +
 310                                                    "{3} line numbers, {4} locals, {5} namespaces, " +
 311                                                    "{6} bytes of string data",
 312                                                    SourceCount, MethodCount, TypeCount, LineNumberCount,
 313                                                    LocalCount, NamespaceCount, StringSize);
 314                                 Console.WriteLine (ot);
 315                                 return stream.GetContents ();
 316                         }
 317                 }
 318
 319                 Assembly assembly;
 320                 BinaryReader reader;
 321                 Hashtable method_hash;
 322                 Hashtable source_file_hash;
 323
 324                 Hashtable method_token_hash;
 325                 Hashtable method_name_hash;
 326                 Hashtable method_full_name_hash;
 327                 Hashtable source_name_hash;
 328
 329                 protected MonoSymbolFile (Assembly assembly, Stream stream)
 330                 {
 331                         this.assembly = assembly;
 332
 333                         reader = new BinaryReader (stream);
 334
 335                         try {
 336                                 long magic = reader.ReadInt64 ();
 337                                 long version = reader.ReadInt32 ();
 338                                 if ((magic != OffsetTable.Magic) || (version != OffsetTable.Version))
 339                                         throw new MonoSymbolFileException ();
 340                                 ot = new OffsetTable (reader);
 341                         } catch {
 342                                 throw new MonoSymbolFileException ();
 343                         }
 344
 345                         method_hash = new Hashtable ();
 346                         source_file_hash = new Hashtable ();
 347                 }
 348
 349                 public static MonoSymbolFile ReadSymbolFile (Assembly assembly)
 350                 {
 351                         Stream stream = assembly.GetManifestResourceStream ("MonoSymbolFile");
 352                         if (stream == null)
 353                                 return null;
 354
 355                         return new MonoSymbolFile (assembly, stream);
 356                 }
 357
 358                 public Assembly Assembly {
 359                         get { return assembly; }
 360                 }
 361
 362                 public int SourceCount {
 363                         get { return ot.SourceCount; }
 364                 }
 365
 366                 public int MethodCount {
 367                         get { return ot.MethodCount; }
 368                 }
 369
 370                 public int TypeCount {
 371                         get { return ot.TypeCount; }
 372                 }
 373
 374                 public int NamespaceCount {
 375                         get { return last_namespace_index; }
 376                 }
 377
 378                 internal int LineNumberCount = 0;
 379                 internal int LocalCount = 0;
 380                 internal int StringSize = 0;
 381
 382                 public SourceFileEntry GetSourceFile (int index)
 383                 {
 384                         if ((index < 1) || (index > ot.SourceCount))
 385                                 throw new ArgumentException ();
 386                         if (reader == null)
 387                                 throw new InvalidOperationException ();
 388
 389                         SourceFileEntry source = (SourceFileEntry) source_file_hash [index];
 390                         if (source != null)
 391                                 return source;
 392
 393                         reader.BaseStream.Position = ot.SourceTableOffset +
 394                                 SourceFileEntry.Size * (index - 1);
 395                         source = new SourceFileEntry (this, reader);
 396                         source_file_hash.Add (index, source);
 397                         return source;
 398                 }
 399
 400                 public SourceFileEntry[] Sources {
 401                         get {
 402                                 if (reader == null)
 403                                         throw new InvalidOperationException ();
 404
 405                                 SourceFileEntry[] retval = new SourceFileEntry [SourceCount];
 406                                 for (int i = 0; i < SourceCount; i++)
 407                                         retval [i] = GetSourceFile (i + 1);
 408                                 return retval;
 409                         }
 410                 }
 411
 412                 public MethodIndexEntry GetMethodIndexEntry (int index)
 413                 {
 414                         int old_pos = (int) reader.BaseStream.Position;
 415                         reader.BaseStream.Position = ot.MethodTableOffset +
 416                                 MethodIndexEntry.Size * (index - 1);
 417                         MethodIndexEntry ie = new MethodIndexEntry (reader);
 418                         reader.BaseStream.Position = old_pos;
 419                         return ie;
 420                 }
 421
 422                 public MethodEntry GetMethodByToken (int token)
 423                 {
 424                         if (reader == null)
 425                                 throw new InvalidOperationException ();
 426
 427                         if (method_token_hash == null) {
 428                                 method_token_hash = new Hashtable ();
 429
 430                                 for (int i = 0; i < MethodCount; i++) {
 431                                         MethodIndexEntry ie = GetMethodIndexEntry (i + 1);
 432
 433                                         method_token_hash.Add (ie.Token, i);
 434                                 }
 435                         }
 436
 437                         object value = method_token_hash [token];
 438                         if (value == null)
 439                                 return null;
 440
 441                         return GetMethod ((int) value);
 442                 }
 443
 444                 public MethodEntry GetMethod (MethodBase method)
 445                 {
 446                         if (reader == null)
 447                                 throw new InvalidOperationException ();
 448                         int token = assembly.MonoDebugger_GetMethodToken (method);
 449                         return GetMethodByToken (token);
 450                 }
 451
 452                 public MethodEntry GetMethod (int index)
 453                 {
 454                         if ((index < 1) || (index > ot.MethodCount))
 455                                 throw new ArgumentException ();
 456                         if (reader == null)
 457                                 throw new InvalidOperationException ();
 458
 459                         MethodEntry entry = (MethodEntry) method_hash [index];
 460                         if (entry != null)
 461                                 return entry;
 462
 463                         MethodIndexEntry ie = GetMethodIndexEntry (index);
 464                         reader.BaseStream.Position = ie.FileOffset;
 465
 466                         entry = new MethodEntry (this, reader, index);
 467                         method_hash.Add (index, entry);
 468                         return entry;
 469                 }
 470
 471                 public MethodEntry[] Methods {
 472                         get {
 473                                 if (reader == null)
 474                                         throw new InvalidOperationException ();
 475
 476                                 MethodEntry[] retval = new MethodEntry [MethodCount];
 477                                 for (int i = 0; i < MethodCount; i++)
 478                                         retval [i] = GetMethod (i + 1);
 479                                 return retval;
 480                         }
 481                 }
 482
 483                 public MethodSourceEntry GetMethodSource (int index)
 484                 {
 485                         if ((index < 1) || (index > ot.MethodCount))
 486                                 throw new ArgumentException ();
 487                         if (reader == null)
 488                                 throw new InvalidOperationException ();
 489
 490                         object entry = method_source_hash [index];
 491                         if (entry != null)
 492                                 return (MethodSourceEntry) entry;
 493
 494                         MethodEntry method = GetMethod (index);
 495                         foreach (MethodSourceEntry source in method.SourceFile.Methods) {
 496                                 if (source.Index == index) {
 497                                         method_source_hash.Add (index, source);
 498                                         return source;
 499                                 }
 500                         }
 501
 502                         throw new MonoSymbolFileException ("Internal error.");
 503                 }
 504
 505                 public int FindMethod (string full_name)
 506                 {
 507                         if (reader == null)
 508                                 throw new InvalidOperationException ();
 509
 510                         if (method_full_name_hash == null) {
 511                                 method_full_name_hash = new Hashtable ();
 512
 513                                 for (int i = 0; i < ot.MethodCount; i++) {
 514                                         MethodIndexEntry ie = GetMethodIndexEntry (i + 1);
 515                                         string name = ReadString (ie.FullNameOffset);
 516
 517                                         method_full_name_hash.Add (name, i + 1);
 518                                 }
 519                         }
 520
 521                         object value = method_full_name_hash [full_name];
 522                         if (value == null)
 523                                 return -1;
 524                         return (int) value;
 525                 }
 526
 527                 public int[] MethodLookup (string query)
 528                 {
 529                         if (reader == null)
 530                                 throw new InvalidOperationException ();
 531
 532                         ArrayList list;
 533                         if (method_name_hash == null) {
 534                                 method_name_hash = new Hashtable ();
 535
 536                                 for (int i = 0; i < ot.MethodCount; i++) {
 537                                         MethodIndexEntry ie = GetMethodIndexEntry (i + 1);
 538                                         string full_name = ReadString (ie.FullNameOffset);
 539
 540                                         int pos = full_name.IndexOf ('(');
 541                                         string name = full_name.Substring (0, pos);
 542
 543                                         list = method_name_hash [name] as ArrayList;
 544                                         if (list == null) {
 545                                                 list = new ArrayList ();
 546                                                 method_name_hash.Add (name, list);
 547                                         }
 548
 549                                         list.Add (i + 1);
 550                                 }
 551                         }
 552
 553                         list = method_name_hash [query] as ArrayList;
 554                         if (list == null)
 555                                 return new int [0];
 556
 557                         int[] retval = new int [list.Count];
 558                         list.CopyTo (retval, 0);
 559                         return retval;
 560                 }
 561
 562                 public int FindSource (string file_name)
 563                 {
 564                         if (reader == null)
 565                                 throw new InvalidOperationException ();
 566
 567                         if (source_name_hash == null) {
 568                                 source_name_hash = new Hashtable ();
 569
 570                                 for (int i = 0; i < ot.SourceCount; i++) {
 571                                         SourceFileEntry source = GetSourceFile (i + 1);
 572
 573                                         source_name_hash.Add (source.FileName, i);
 574                                 }
 575                         }
 576
 577                         object value = source_name_hash [file_name];
 578                         if (value == null)
 579                                 return -1;
 580                         return (int) value;
 581                 }
 582
 583                 internal BinaryReader BinaryReader {
 584                         get {
 585                                 if (reader == null)
 586                                         throw new InvalidOperationException ();
 587
 588                                 return reader;
 589                         }
 590                 }
 591
 592                 void IDisposable.Dispose ()
 593                 {
 594                         Dispose (true);
 595                 }
 596
 597                 protected virtual void Dispose (bool disposing)
 598                 {
 599                         if (disposing) {
 600                                 if (reader != null) {
 601                                         reader.Close ();
 602                                         reader = null;
 603                                 }
 604                         }
 605                 }
 606         }
 607 }