2 // Mono.CSharp.Debugger/MonoSymbolTable.cs
5 // Martin Baulig (martin@ximian.com)
7 // (C) 2002 Ximian, Inc. http://www.ximian.com
11 // Permission is hereby granted, free of charge, to any person obtaining
12 // a copy of this software and associated documentation files (the
13 // "Software"), to deal in the Software without restriction, including
14 // without limitation the rights to use, copy, modify, merge, publish,
15 // distribute, sublicense, and/or sell copies of the Software, and to
16 // permit persons to whom the Software is furnished to do so, subject to
17 // the following conditions:
19 // The above copyright notice and this permission notice shall be
20 // included in all copies or substantial portions of the Software.
22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 using System.Security.Cryptography;
33 using System.Collections.Generic;
38 // Parts which are actually written into the symbol file are marked with
40 // #region This is actually written to the symbol file
43 // Please do not modify these regions without previously talking to me.
45 // All changes to the file format must be synchronized in several places:
47 // a) The fields in these regions (and their order) must match the actual
48 // contents of the symbol file.
50 // This helps people to understand the symbol file format without reading
51 // too much source code, ie. you look at the appropriate region and then
52 // you know what's actually in the file.
54 // It is also required to help me enforce b).
56 // b) The regions must be kept in sync with the unmanaged code in
57 // mono/metadata/debug-mono-symfile.h
59 // When making changes to the file format, you must also increase two version
62 // i) OffsetTable.Version in this file.
63 // ii) MONO_SYMBOL_FILE_VERSION in mono/metadata/debug-mono-symfile.h
65 // After doing so, recompile everything, including the debugger. Symbol files
66 // with different versions are incompatible to each other and the debugger and
67 // the runtime enfore this, so you need to recompile all your assemblies after
68 // changing the file format.
71 namespace Mono.CompilerServices.SymbolWriter
73 public class OffsetTable
75 public const int MajorVersion = 50;
76 public const int MinorVersion = 0;
77 public const long Magic = 0x45e82623fd7fa614;
79 #region This is actually written to the symbol file
80 public int TotalFileSize;
81 public int DataSectionOffset;
82 public int DataSectionSize;
83 public int CompileUnitCount;
84 public int CompileUnitTableOffset;
85 public int CompileUnitTableSize;
86 public int SourceCount;
87 public int SourceTableOffset;
88 public int SourceTableSize;
89 public int MethodCount;
90 public int MethodTableOffset;
91 public int MethodTableSize;
93 public int AnonymousScopeCount;
94 public int AnonymousScopeTableOffset;
95 public int AnonymousScopeTableSize;
104 public Flags FileFlags;
106 public int LineNumberTable_LineBase = LineNumberTable.Default_LineBase;
107 public int LineNumberTable_LineRange = LineNumberTable.Default_LineRange;
108 public int LineNumberTable_OpcodeBase = LineNumberTable.Default_OpcodeBase;
111 internal OffsetTable ()
113 int platform = (int) Environment.OSVersion.Platform;
114 if ((platform != 4) && (platform != 128))
115 FileFlags |= Flags.WindowsFileNames;
118 internal OffsetTable (BinaryReader reader, int major_version, int minor_version)
120 TotalFileSize = reader.ReadInt32 ();
121 DataSectionOffset = reader.ReadInt32 ();
122 DataSectionSize = reader.ReadInt32 ();
123 CompileUnitCount = reader.ReadInt32 ();
124 CompileUnitTableOffset = reader.ReadInt32 ();
125 CompileUnitTableSize = reader.ReadInt32 ();
126 SourceCount = reader.ReadInt32 ();
127 SourceTableOffset = reader.ReadInt32 ();
128 SourceTableSize = reader.ReadInt32 ();
129 MethodCount = reader.ReadInt32 ();
130 MethodTableOffset = reader.ReadInt32 ();
131 MethodTableSize = reader.ReadInt32 ();
132 TypeCount = reader.ReadInt32 ();
134 AnonymousScopeCount = reader.ReadInt32 ();
135 AnonymousScopeTableOffset = reader.ReadInt32 ();
136 AnonymousScopeTableSize = reader.ReadInt32 ();
138 LineNumberTable_LineBase = reader.ReadInt32 ();
139 LineNumberTable_LineRange = reader.ReadInt32 ();
140 LineNumberTable_OpcodeBase = reader.ReadInt32 ();
142 FileFlags = (Flags) reader.ReadInt32 ();
145 internal void Write (BinaryWriter bw, int major_version, int minor_version)
147 bw.Write (TotalFileSize);
148 bw.Write (DataSectionOffset);
149 bw.Write (DataSectionSize);
150 bw.Write (CompileUnitCount);
151 bw.Write (CompileUnitTableOffset);
152 bw.Write (CompileUnitTableSize);
153 bw.Write (SourceCount);
154 bw.Write (SourceTableOffset);
155 bw.Write (SourceTableSize);
156 bw.Write (MethodCount);
157 bw.Write (MethodTableOffset);
158 bw.Write (MethodTableSize);
159 bw.Write (TypeCount);
161 bw.Write (AnonymousScopeCount);
162 bw.Write (AnonymousScopeTableOffset);
163 bw.Write (AnonymousScopeTableSize);
165 bw.Write (LineNumberTable_LineBase);
166 bw.Write (LineNumberTable_LineRange);
167 bw.Write (LineNumberTable_OpcodeBase);
169 bw.Write ((int) FileFlags);
172 public override string ToString ()
174 return String.Format (
175 "OffsetTable [{0} - {1}:{2} - {3}:{4}:{5} - {6}:{7}:{8} - {9}]",
176 TotalFileSize, DataSectionOffset, DataSectionSize, SourceCount,
177 SourceTableOffset, SourceTableSize, MethodCount, MethodTableOffset,
178 MethodTableSize, TypeCount);
182 public class LineNumberEntry
184 #region This is actually written to the symbol file
185 public readonly int Row;
187 public readonly int File;
188 public readonly int Offset;
189 public readonly bool IsHidden; // Obsolete is never used
192 public sealed class LocationComparer : IComparer<LineNumberEntry>
194 public static readonly LocationComparer Default = new LocationComparer ();
196 public int Compare (LineNumberEntry l1, LineNumberEntry l2)
198 return l1.Row == l2.Row ?
199 l1.Column.CompareTo (l2.Column) :
200 l1.Row.CompareTo (l2.Row);
204 public static readonly LineNumberEntry Null = new LineNumberEntry (0, 0, 0, 0);
206 public LineNumberEntry (int file, int row, int column, int offset)
207 : this (file, row, offset, column, false)
211 public LineNumberEntry (int file, int row, int offset)
212 : this (file, row, -1, offset, false)
216 public LineNumberEntry (int file, int row, int column, int offset, bool is_hidden)
220 this.Column = column;
221 this.Offset = offset;
222 this.IsHidden = is_hidden;
225 public override string ToString ()
227 return String.Format ("[Line {0}:{1,2}:{3}]", File, Row, Column, Offset);
231 public class CodeBlockEntry
234 #region This is actually written to the symbol file
236 public Type BlockType;
237 public int StartOffset;
238 public int EndOffset;
243 CompilerGenerated = 2,
245 IteratorDispatcher = 4
248 public CodeBlockEntry (int index, int parent, Type type, int start_offset)
251 this.Parent = parent;
252 this.BlockType = type;
253 this.StartOffset = start_offset;
256 internal CodeBlockEntry (int index, MyBinaryReader reader)
259 int type_flag = reader.ReadLeb128 ();
260 BlockType = (Type) (type_flag & 0x3f);
261 this.Parent = reader.ReadLeb128 ();
262 this.StartOffset = reader.ReadLeb128 ();
263 this.EndOffset = reader.ReadLeb128 ();
265 /* Reserved for future extensions. */
266 if ((type_flag & 0x40) != 0) {
267 int data_size = reader.ReadInt16 ();
268 reader.BaseStream.Position += data_size;
272 public void Close (int end_offset)
274 this.EndOffset = end_offset;
277 internal void Write (MyBinaryWriter bw)
279 bw.WriteLeb128 ((int) BlockType);
280 bw.WriteLeb128 (Parent);
281 bw.WriteLeb128 (StartOffset);
282 bw.WriteLeb128 (EndOffset);
285 public override string ToString ()
287 return String.Format ("[CodeBlock {0}:{1}:{2}:{3}:{4}]",
288 Index, Parent, BlockType, StartOffset, EndOffset);
292 public struct LocalVariableEntry
294 #region This is actually written to the symbol file
295 public readonly int Index;
296 public readonly string Name;
297 public readonly int BlockIndex;
300 public LocalVariableEntry (int index, string name, int block)
304 this.BlockIndex = block;
307 internal LocalVariableEntry (MonoSymbolFile file, MyBinaryReader reader)
309 Index = reader.ReadLeb128 ();
310 Name = reader.ReadString ();
311 BlockIndex = reader.ReadLeb128 ();
314 internal void Write (MonoSymbolFile file, MyBinaryWriter bw)
316 bw.WriteLeb128 (Index);
318 bw.WriteLeb128 (BlockIndex);
321 public override string ToString ()
323 return String.Format ("[LocalVariable {0}:{1}:{2}]",
324 Name, Index, BlockIndex - 1);
328 public struct CapturedVariable
330 #region This is actually written to the symbol file
331 public readonly string Name;
332 public readonly string CapturedName;
333 public readonly CapturedKind Kind;
336 public enum CapturedKind : byte
343 public CapturedVariable (string name, string captured_name,
347 this.CapturedName = captured_name;
351 internal CapturedVariable (MyBinaryReader reader)
353 Name = reader.ReadString ();
354 CapturedName = reader.ReadString ();
355 Kind = (CapturedKind) reader.ReadByte ();
358 internal void Write (MyBinaryWriter bw)
361 bw.Write (CapturedName);
362 bw.Write ((byte) Kind);
365 public override string ToString ()
367 return String.Format ("[CapturedVariable {0}:{1}:{2}]",
368 Name, CapturedName, Kind);
372 public struct CapturedScope
374 #region This is actually written to the symbol file
375 public readonly int Scope;
376 public readonly string CapturedName;
379 public CapturedScope (int scope, string captured_name)
382 this.CapturedName = captured_name;
385 internal CapturedScope (MyBinaryReader reader)
387 Scope = reader.ReadLeb128 ();
388 CapturedName = reader.ReadString ();
391 internal void Write (MyBinaryWriter bw)
393 bw.WriteLeb128 (Scope);
394 bw.Write (CapturedName);
397 public override string ToString ()
399 return String.Format ("[CapturedScope {0}:{1}]",
400 Scope, CapturedName);
404 public struct ScopeVariable
406 #region This is actually written to the symbol file
407 public readonly int Scope;
408 public readonly int Index;
411 public ScopeVariable (int scope, int index)
417 internal ScopeVariable (MyBinaryReader reader)
419 Scope = reader.ReadLeb128 ();
420 Index = reader.ReadLeb128 ();
423 internal void Write (MyBinaryWriter bw)
425 bw.WriteLeb128 (Scope);
426 bw.WriteLeb128 (Index);
429 public override string ToString ()
431 return String.Format ("[ScopeVariable {0}:{1}]", Scope, Index);
435 public class AnonymousScopeEntry
437 #region This is actually written to the symbol file
438 public readonly int ID;
441 List<CapturedVariable> captured_vars = new List<CapturedVariable> ();
442 List<CapturedScope> captured_scopes = new List<CapturedScope> ();
444 public AnonymousScopeEntry (int id)
449 internal AnonymousScopeEntry (MyBinaryReader reader)
451 ID = reader.ReadLeb128 ();
453 int num_captured_vars = reader.ReadLeb128 ();
454 for (int i = 0; i < num_captured_vars; i++)
455 captured_vars.Add (new CapturedVariable (reader));
457 int num_captured_scopes = reader.ReadLeb128 ();
458 for (int i = 0; i < num_captured_scopes; i++)
459 captured_scopes.Add (new CapturedScope (reader));
462 internal void AddCapturedVariable (string name, string captured_name,
463 CapturedVariable.CapturedKind kind)
465 captured_vars.Add (new CapturedVariable (name, captured_name, kind));
468 public CapturedVariable[] CapturedVariables {
470 CapturedVariable[] retval = new CapturedVariable [captured_vars.Count];
471 captured_vars.CopyTo (retval, 0);
476 internal void AddCapturedScope (int scope, string captured_name)
478 captured_scopes.Add (new CapturedScope (scope, captured_name));
481 public CapturedScope[] CapturedScopes {
483 CapturedScope[] retval = new CapturedScope [captured_scopes.Count];
484 captured_scopes.CopyTo (retval, 0);
489 internal void Write (MyBinaryWriter bw)
493 bw.WriteLeb128 (captured_vars.Count);
494 foreach (CapturedVariable cv in captured_vars)
497 bw.WriteLeb128 (captured_scopes.Count);
498 foreach (CapturedScope cs in captured_scopes)
502 public override string ToString ()
504 return String.Format ("[AnonymousScope {0}]", ID);
508 public class CompileUnitEntry : ICompileUnit
510 #region This is actually written to the symbol file
511 public readonly int Index;
516 SourceFileEntry source;
517 List<SourceFileEntry> include_files;
518 List<NamespaceEntry> namespaces;
522 public static int Size {
526 CompileUnitEntry ICompileUnit.Entry {
530 public CompileUnitEntry (MonoSymbolFile file, SourceFileEntry source)
533 this.source = source;
535 this.Index = file.AddCompileUnit (this);
538 namespaces = new List<NamespaceEntry> ();
541 public void AddFile (SourceFileEntry file)
544 throw new InvalidOperationException ();
546 if (include_files == null)
547 include_files = new List<SourceFileEntry> ();
549 include_files.Add (file);
552 public SourceFileEntry SourceFile {
562 public int DefineNamespace (string name, string[] using_clauses, int parent)
565 throw new InvalidOperationException ();
567 int index = file.GetNextNamespaceIndex ();
568 NamespaceEntry ns = new NamespaceEntry (name, index, using_clauses, parent);
573 internal void WriteData (MyBinaryWriter bw)
575 DataOffset = (int) bw.BaseStream.Position;
576 bw.WriteLeb128 (source.Index);
578 int count_includes = include_files != null ? include_files.Count : 0;
579 bw.WriteLeb128 (count_includes);
580 if (include_files != null) {
581 foreach (SourceFileEntry entry in include_files)
582 bw.WriteLeb128 (entry.Index);
585 bw.WriteLeb128 (namespaces.Count);
586 foreach (NamespaceEntry ns in namespaces)
590 internal void Write (BinaryWriter bw)
593 bw.Write (DataOffset);
596 internal CompileUnitEntry (MonoSymbolFile file, MyBinaryReader reader)
600 Index = reader.ReadInt32 ();
601 DataOffset = reader.ReadInt32 ();
607 throw new InvalidOperationException ();
610 if (namespaces != null)
613 MyBinaryReader reader = file.BinaryReader;
614 int old_pos = (int) reader.BaseStream.Position;
616 reader.BaseStream.Position = DataOffset;
618 int source_idx = reader.ReadLeb128 ();
619 source = file.GetSourceFile (source_idx);
621 int count_includes = reader.ReadLeb128 ();
622 if (count_includes > 0) {
623 include_files = new List<SourceFileEntry> ();
624 for (int i = 0; i < count_includes; i++)
625 include_files.Add (file.GetSourceFile (reader.ReadLeb128 ()));
628 int count_ns = reader.ReadLeb128 ();
629 namespaces = new List<NamespaceEntry> ();
630 for (int i = 0; i < count_ns; i ++)
631 namespaces.Add (new NamespaceEntry (file, reader));
633 reader.BaseStream.Position = old_pos;
637 public NamespaceEntry[] Namespaces {
640 NamespaceEntry[] retval = new NamespaceEntry [namespaces.Count];
641 namespaces.CopyTo (retval, 0);
646 public SourceFileEntry[] IncludeFiles {
649 if (include_files == null)
650 return new SourceFileEntry [0];
652 SourceFileEntry[] retval = new SourceFileEntry [include_files.Count];
653 include_files.CopyTo (retval, 0);
659 public class SourceFileEntry
661 #region This is actually written to the symbol file
662 public readonly int Index;
673 public static int Size {
677 public SourceFileEntry (MonoSymbolFile file, string file_name)
680 this.file_name = file_name;
681 this.Index = file.AddSource (this);
686 public SourceFileEntry (MonoSymbolFile file, string file_name, byte[] guid, byte[] checksum)
687 : this (file, file_name)
690 this.hash = checksum;
693 public byte[] Checksum {
699 internal void WriteData (MyBinaryWriter bw)
701 DataOffset = (int) bw.BaseStream.Position;
702 bw.Write (file_name);
709 using (FileStream fs = new FileStream (file_name, FileMode.Open, FileAccess.Read)) {
710 MD5 md5 = MD5.Create ();
711 hash = md5.ComputeHash (fs);
714 hash = new byte [16];
720 bw.Write ((byte) (auto_generated ? 1 : 0));
723 internal void Write (BinaryWriter bw)
726 bw.Write (DataOffset);
729 internal SourceFileEntry (MonoSymbolFile file, MyBinaryReader reader)
733 Index = reader.ReadInt32 ();
734 DataOffset = reader.ReadInt32 ();
736 int old_pos = (int) reader.BaseStream.Position;
737 reader.BaseStream.Position = DataOffset;
739 file_name = reader.ReadString ();
740 guid = reader.ReadBytes (16);
741 hash = reader.ReadBytes (16);
742 auto_generated = reader.ReadByte () == 1;
744 reader.BaseStream.Position = old_pos;
747 public string FileName {
748 get { return file_name; }
751 public bool AutoGenerated {
752 get { return auto_generated; }
755 public void SetAutoGenerated ()
758 throw new InvalidOperationException ();
760 auto_generated = true;
761 file.OffsetTable.FileFlags |= OffsetTable.Flags.IsAspxSource;
764 public bool CheckChecksum ()
767 using (FileStream fs = new FileStream (file_name, FileMode.Open)) {
768 MD5 md5 = MD5.Create ();
769 byte[] data = md5.ComputeHash (fs);
770 for (int i = 0; i < 16; i++)
771 if (data [i] != hash [i])
780 public override string ToString ()
782 return String.Format ("SourceFileEntry ({0}:{1})", Index, DataOffset);
786 public class LineNumberTable
788 protected LineNumberEntry[] _line_numbers;
789 public LineNumberEntry[] LineNumbers {
790 get { return _line_numbers; }
793 public readonly int LineBase;
794 public readonly int LineRange;
795 public readonly byte OpcodeBase;
796 public readonly int MaxAddressIncrement;
798 #region Configurable constants
799 public const int Default_LineBase = -1;
800 public const int Default_LineRange = 8;
801 public const byte Default_OpcodeBase = 9;
805 public const byte DW_LNS_copy = 1;
806 public const byte DW_LNS_advance_pc = 2;
807 public const byte DW_LNS_advance_line = 3;
808 public const byte DW_LNS_set_file = 4;
809 public const byte DW_LNS_const_add_pc = 8;
811 public const byte DW_LNE_end_sequence = 1;
814 public const byte DW_LNE_MONO_negate_is_hidden = 0x40;
816 internal const byte DW_LNE_MONO__extensions_start = 0x40;
817 internal const byte DW_LNE_MONO__extensions_end = 0x7f;
819 protected LineNumberTable (MonoSymbolFile file)
821 this.LineBase = file.OffsetTable.LineNumberTable_LineBase;
822 this.LineRange = file.OffsetTable.LineNumberTable_LineRange;
823 this.OpcodeBase = (byte) file.OffsetTable.LineNumberTable_OpcodeBase;
824 this.MaxAddressIncrement = (255 - OpcodeBase) / LineRange;
827 internal LineNumberTable (MonoSymbolFile file, LineNumberEntry[] lines)
830 this._line_numbers = lines;
833 internal void Write (MonoSymbolFile file, MyBinaryWriter bw, bool readColumnsInfo)
835 int start = (int) bw.BaseStream.Position;
837 bool last_is_hidden = false;
838 int last_line = 1, last_offset = 0, last_file = 1;
839 for (int i = 0; i < LineNumbers.Length; i++) {
840 int line_inc = LineNumbers [i].Row - last_line;
841 int offset_inc = LineNumbers [i].Offset - last_offset;
843 if (LineNumbers [i].File != last_file) {
844 bw.Write (DW_LNS_set_file);
845 bw.WriteLeb128 (LineNumbers [i].File);
846 last_file = LineNumbers [i].File;
849 if (LineNumbers [i].IsHidden != last_is_hidden) {
852 bw.Write (DW_LNE_MONO_negate_is_hidden);
853 last_is_hidden = LineNumbers [i].IsHidden;
856 if (offset_inc >= MaxAddressIncrement) {
857 if (offset_inc < 2 * MaxAddressIncrement) {
858 bw.Write (DW_LNS_const_add_pc);
859 offset_inc -= MaxAddressIncrement;
861 bw.Write (DW_LNS_advance_pc);
862 bw.WriteLeb128 (offset_inc);
867 if ((line_inc < LineBase) || (line_inc >= LineBase + LineRange)) {
868 bw.Write (DW_LNS_advance_line);
869 bw.WriteLeb128 (line_inc);
870 if (offset_inc != 0) {
871 bw.Write (DW_LNS_advance_pc);
872 bw.WriteLeb128 (offset_inc);
874 bw.Write (DW_LNS_copy);
877 opcode = (byte) (line_inc - LineBase + (LineRange * offset_inc) +
882 last_line = LineNumbers [i].Row;
883 last_offset = LineNumbers [i].Offset;
888 bw.Write (DW_LNE_end_sequence);
890 for (int i = 0; i < LineNumbers.Length; i++) {
891 var ln = LineNumbers [i];
893 bw.WriteLeb128 (ln.Column);
896 file.ExtendedLineNumberSize += (int) bw.BaseStream.Position - start;
899 internal static LineNumberTable Read (MonoSymbolFile file, MyBinaryReader br, bool readColumnsInfo)
901 LineNumberTable lnt = new LineNumberTable (file);
902 lnt.DoRead (file, br, readColumnsInfo);
906 void DoRead (MonoSymbolFile file, MyBinaryReader br, bool includesColumns)
908 var lines = new List<LineNumberEntry> ();
910 bool is_hidden = false, modified = false;
911 int stm_line = 1, stm_offset = 0, stm_file = 1;
913 byte opcode = br.ReadByte ();
916 byte size = br.ReadByte ();
917 long end_pos = br.BaseStream.Position + size;
918 opcode = br.ReadByte ();
920 if (opcode == DW_LNE_end_sequence) {
922 lines.Add (new LineNumberEntry (
923 stm_file, stm_line, -1, stm_offset, is_hidden));
925 } else if (opcode == DW_LNE_MONO_negate_is_hidden) {
926 is_hidden = !is_hidden;
928 } else if ((opcode >= DW_LNE_MONO__extensions_start) &&
929 (opcode <= DW_LNE_MONO__extensions_end)) {
930 ; // reserved for future extensions
932 throw new MonoSymbolFileException ("Unknown extended opcode {0:x}", opcode);
935 br.BaseStream.Position = end_pos;
937 } else if (opcode < OpcodeBase) {
940 lines.Add (new LineNumberEntry (
941 stm_file, stm_line, -1, stm_offset, is_hidden));
944 case DW_LNS_advance_pc:
945 stm_offset += br.ReadLeb128 ();
948 case DW_LNS_advance_line:
949 stm_line += br.ReadLeb128 ();
952 case DW_LNS_set_file:
953 stm_file = br.ReadLeb128 ();
956 case DW_LNS_const_add_pc:
957 stm_offset += MaxAddressIncrement;
961 throw new MonoSymbolFileException (
962 "Unknown standard opcode {0:x} in LNT",
966 opcode -= OpcodeBase;
968 stm_offset += opcode / LineRange;
969 stm_line += LineBase + (opcode % LineRange);
970 lines.Add (new LineNumberEntry (
971 stm_file, stm_line, -1, stm_offset, is_hidden));
976 _line_numbers = lines.ToArray ();
978 if (includesColumns) {
979 for (int i = 0; i < _line_numbers.Length; ++i) {
980 var ln = _line_numbers[i];
982 ln.Column = br.ReadLeb128 ();
987 public bool GetMethodBounds (out LineNumberEntry start, out LineNumberEntry end)
989 if (_line_numbers.Length > 1) {
990 start = _line_numbers [0];
991 end = _line_numbers [_line_numbers.Length - 1];
995 start = LineNumberEntry.Null;
996 end = LineNumberEntry.Null;
1001 public class MethodEntry : IComparable
1003 #region This is actually written to the symbol file
1004 public readonly int CompileUnitIndex;
1005 public readonly int Token;
1006 public readonly int NamespaceID;
1009 int LocalVariableTableOffset;
1010 int LineNumberTableOffset;
1011 int CodeBlockTableOffset;
1012 int ScopeVariableTableOffset;
1019 public Flags MethodFlags {
1020 get { return flags; }
1023 public readonly CompileUnitEntry CompileUnit;
1025 LocalVariableEntry[] locals;
1026 CodeBlockEntry[] code_blocks;
1027 ScopeVariable[] scope_vars;
1028 LineNumberTable lnt;
1031 public readonly MonoSymbolFile SymbolFile;
1034 get { return index; }
1035 set { index = value; }
1041 LocalNamesAmbiguous = 1,
1042 ColumnsInfoIncluded = 1 << 1
1045 public const int Size = 12;
1047 internal MethodEntry (MonoSymbolFile file, MyBinaryReader reader, int index)
1049 this.SymbolFile = file;
1052 Token = reader.ReadInt32 ();
1053 DataOffset = reader.ReadInt32 ();
1054 LineNumberTableOffset = reader.ReadInt32 ();
1056 long old_pos = reader.BaseStream.Position;
1057 reader.BaseStream.Position = DataOffset;
1059 CompileUnitIndex = reader.ReadLeb128 ();
1060 LocalVariableTableOffset = reader.ReadLeb128 ();
1061 NamespaceID = reader.ReadLeb128 ();
1063 CodeBlockTableOffset = reader.ReadLeb128 ();
1064 ScopeVariableTableOffset = reader.ReadLeb128 ();
1066 RealNameOffset = reader.ReadLeb128 ();
1068 flags = (Flags) reader.ReadLeb128 ();
1070 reader.BaseStream.Position = old_pos;
1072 CompileUnit = file.GetCompileUnit (CompileUnitIndex);
1075 internal MethodEntry (MonoSymbolFile file, CompileUnitEntry comp_unit,
1076 int token, ScopeVariable[] scope_vars,
1077 LocalVariableEntry[] locals, LineNumberEntry[] lines,
1078 CodeBlockEntry[] code_blocks, string real_name,
1079 Flags flags, int namespace_id)
1081 this.SymbolFile = file;
1082 this.real_name = real_name;
1083 this.locals = locals;
1084 this.code_blocks = code_blocks;
1085 this.scope_vars = scope_vars;
1091 CompileUnitIndex = comp_unit.Index;
1092 CompileUnit = comp_unit;
1093 NamespaceID = namespace_id;
1095 CheckLineNumberTable (lines);
1096 lnt = new LineNumberTable (file, lines);
1097 file.NumLineNumbers += lines.Length;
1099 int num_locals = locals != null ? locals.Length : 0;
1101 if (num_locals <= 32) {
1102 // Most of the time, the O(n^2) factor is actually
1103 // less than the cost of allocating the hash table,
1104 // 32 is a rough number obtained through some testing.
1106 for (int i = 0; i < num_locals; i ++) {
1107 string nm = locals [i].Name;
1109 for (int j = i + 1; j < num_locals; j ++) {
1110 if (locals [j].Name == nm) {
1111 flags |= Flags.LocalNamesAmbiguous;
1112 goto locals_check_done;
1119 var local_names = new Dictionary<string, LocalVariableEntry> ();
1120 foreach (LocalVariableEntry local in locals) {
1121 if (local_names.ContainsKey (local.Name)) {
1122 flags |= Flags.LocalNamesAmbiguous;
1125 local_names.Add (local.Name, local);
1130 static void CheckLineNumberTable (LineNumberEntry[] line_numbers)
1132 int last_offset = -1;
1135 if (line_numbers == null)
1138 for (int i = 0; i < line_numbers.Length; i++) {
1139 LineNumberEntry line = line_numbers [i];
1141 if (line.Equals (LineNumberEntry.Null))
1142 throw new MonoSymbolFileException ();
1144 if (line.Offset < last_offset)
1145 throw new MonoSymbolFileException ();
1147 if (line.Offset > last_offset) {
1148 last_row = line.Row;
1149 last_offset = line.Offset;
1150 } else if (line.Row > last_row) {
1151 last_row = line.Row;
1156 internal void Write (MyBinaryWriter bw)
1158 if ((index <= 0) || (DataOffset == 0))
1159 throw new InvalidOperationException ();
1162 bw.Write (DataOffset);
1163 bw.Write (LineNumberTableOffset);
1166 internal void WriteData (MonoSymbolFile file, MyBinaryWriter bw)
1169 throw new InvalidOperationException ();
1171 LocalVariableTableOffset = (int) bw.BaseStream.Position;
1172 int num_locals = locals != null ? locals.Length : 0;
1173 bw.WriteLeb128 (num_locals);
1174 for (int i = 0; i < num_locals; i++)
1175 locals [i].Write (file, bw);
1176 file.LocalCount += num_locals;
1178 CodeBlockTableOffset = (int) bw.BaseStream.Position;
1179 int num_code_blocks = code_blocks != null ? code_blocks.Length : 0;
1180 bw.WriteLeb128 (num_code_blocks);
1181 for (int i = 0; i < num_code_blocks; i++)
1182 code_blocks [i].Write (bw);
1184 ScopeVariableTableOffset = (int) bw.BaseStream.Position;
1185 int num_scope_vars = scope_vars != null ? scope_vars.Length : 0;
1186 bw.WriteLeb128 (num_scope_vars);
1187 for (int i = 0; i < num_scope_vars; i++)
1188 scope_vars [i].Write (bw);
1190 if (real_name != null) {
1191 RealNameOffset = (int) bw.BaseStream.Position;
1192 bw.Write (real_name);
1195 LineNumberTableOffset = (int) bw.BaseStream.Position;
1196 lnt.Write (file, bw, (flags & Flags.ColumnsInfoIncluded) != 0);
1198 DataOffset = (int) bw.BaseStream.Position;
1200 bw.WriteLeb128 (CompileUnitIndex);
1201 bw.WriteLeb128 (LocalVariableTableOffset);
1202 bw.WriteLeb128 (NamespaceID);
1204 bw.WriteLeb128 (CodeBlockTableOffset);
1205 bw.WriteLeb128 (ScopeVariableTableOffset);
1207 bw.WriteLeb128 (RealNameOffset);
1208 bw.WriteLeb128 ((int) flags);
1211 public LineNumberTable GetLineNumberTable ()
1217 if (LineNumberTableOffset == 0)
1220 MyBinaryReader reader = SymbolFile.BinaryReader;
1221 long old_pos = reader.BaseStream.Position;
1222 reader.BaseStream.Position = LineNumberTableOffset;
1224 lnt = LineNumberTable.Read (SymbolFile, reader, (flags & Flags.ColumnsInfoIncluded) != 0);
1226 reader.BaseStream.Position = old_pos;
1231 public LocalVariableEntry[] GetLocals ()
1237 if (LocalVariableTableOffset == 0)
1240 MyBinaryReader reader = SymbolFile.BinaryReader;
1241 long old_pos = reader.BaseStream.Position;
1242 reader.BaseStream.Position = LocalVariableTableOffset;
1244 int num_locals = reader.ReadLeb128 ();
1245 locals = new LocalVariableEntry [num_locals];
1247 for (int i = 0; i < num_locals; i++)
1248 locals [i] = new LocalVariableEntry (SymbolFile, reader);
1250 reader.BaseStream.Position = old_pos;
1255 public CodeBlockEntry[] GetCodeBlocks ()
1258 if (code_blocks != null)
1261 if (CodeBlockTableOffset == 0)
1264 MyBinaryReader reader = SymbolFile.BinaryReader;
1265 long old_pos = reader.BaseStream.Position;
1266 reader.BaseStream.Position = CodeBlockTableOffset;
1268 int num_code_blocks = reader.ReadLeb128 ();
1269 code_blocks = new CodeBlockEntry [num_code_blocks];
1271 for (int i = 0; i < num_code_blocks; i++)
1272 code_blocks [i] = new CodeBlockEntry (i, reader);
1274 reader.BaseStream.Position = old_pos;
1279 public ScopeVariable[] GetScopeVariables ()
1282 if (scope_vars != null)
1285 if (ScopeVariableTableOffset == 0)
1288 MyBinaryReader reader = SymbolFile.BinaryReader;
1289 long old_pos = reader.BaseStream.Position;
1290 reader.BaseStream.Position = ScopeVariableTableOffset;
1292 int num_scope_vars = reader.ReadLeb128 ();
1293 scope_vars = new ScopeVariable [num_scope_vars];
1295 for (int i = 0; i < num_scope_vars; i++)
1296 scope_vars [i] = new ScopeVariable (reader);
1298 reader.BaseStream.Position = old_pos;
1303 public string GetRealName ()
1306 if (real_name != null)
1309 if (RealNameOffset == 0)
1312 real_name = SymbolFile.BinaryReader.ReadString (RealNameOffset);
1317 public int CompareTo (object obj)
1319 MethodEntry method = (MethodEntry) obj;
1321 if (method.Token < Token)
1323 else if (method.Token > Token)
1329 public override string ToString ()
1331 return String.Format ("[Method {0}:{1:x}:{2}:{3}]",
1332 index, Token, CompileUnitIndex, CompileUnit);
1336 public struct NamespaceEntry
1338 #region This is actually written to the symbol file
1339 public readonly string Name;
1340 public readonly int Index;
1341 public readonly int Parent;
1342 public readonly string[] UsingClauses;
1345 public NamespaceEntry (string name, int index, string[] using_clauses, int parent)
1349 this.Parent = parent;
1350 this.UsingClauses = using_clauses != null ? using_clauses : new string [0];
1353 internal NamespaceEntry (MonoSymbolFile file, MyBinaryReader reader)
1355 Name = reader.ReadString ();
1356 Index = reader.ReadLeb128 ();
1357 Parent = reader.ReadLeb128 ();
1359 int count = reader.ReadLeb128 ();
1360 UsingClauses = new string [count];
1361 for (int i = 0; i < count; i++)
1362 UsingClauses [i] = reader.ReadString ();
1365 internal void Write (MonoSymbolFile file, MyBinaryWriter bw)
1368 bw.WriteLeb128 (Index);
1369 bw.WriteLeb128 (Parent);
1370 bw.WriteLeb128 (UsingClauses.Length);
1371 foreach (string uc in UsingClauses)
1375 public override string ToString ()
1377 return String.Format ("[Namespace {0}:{1}:{2}]", Name, Index, Parent);