2 // System.Diagnostics.StackFrame.cs
5 // Alexander Klyubin (klyubin@aqris.com)
6 // Dietmar Maurer (dietmar@ximian.com)
9 // Copyright (C) 2004-2005 Novell, Inc (http://www.novell.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.Reflection;
33 using System.Runtime.CompilerServices;
34 using System.Security;
35 using System.Security.Permissions;
37 using System.Runtime.InteropServices;
39 namespace System.Diagnostics {
43 [MonoTODO ("Serialized objects are not compatible with MS.NET")]
44 [StructLayout (LayoutKind.Sequential)]
45 public class StackFrame {
47 public const int OFFSET_UNKNOWN = -1;
49 #region Keep in sync with object-internals.h
50 private int ilOffset = OFFSET_UNKNOWN;
51 private int nativeOffset = OFFSET_UNKNOWN;
52 private long methodAddress;
53 private uint methodIndex;
54 private MethodBase methodBase;
55 private string fileName;
56 private int lineNumber;
57 private int columnNumber;
58 #pragma warning disable 649
59 private string internalMethodName;
60 #pragma warning restore 649
63 [MethodImplAttribute(MethodImplOptions.InternalCall)]
64 extern static bool get_frame_info (int skip, bool needFileInfo, out MethodBase method,
65 out int iloffset, out int native_offset,
66 out string file, out int line, out int column);
70 get_frame_info (2, false, out methodBase, out ilOffset,
71 out nativeOffset, out fileName, out lineNumber,
75 [MethodImplAttribute (MethodImplOptions.NoInlining)]
76 public StackFrame (bool fNeedFileInfo)
78 get_frame_info (2, fNeedFileInfo, out methodBase, out ilOffset,
79 out nativeOffset, out fileName, out lineNumber,
83 [MethodImplAttribute (MethodImplOptions.NoInlining)]
84 public StackFrame (int skipFrames)
86 get_frame_info (skipFrames + 2, false, out methodBase, out ilOffset,
87 out nativeOffset, out fileName, out lineNumber,
91 [MethodImplAttribute (MethodImplOptions.NoInlining)]
92 public StackFrame (int skipFrames, bool fNeedFileInfo)
94 get_frame_info (skipFrames + 2, fNeedFileInfo, out methodBase, out ilOffset,
95 out nativeOffset, out fileName, out lineNumber,
99 // LAMESPEC: According to the MSDN docs, this creates a frame with _only_
100 // the filename and lineNumber, but MS fills out the frame info as well.
101 [MethodImplAttribute (MethodImplOptions.NoInlining)]
102 public StackFrame (string fileName, int lineNumber)
104 get_frame_info (2, false, out methodBase, out ilOffset,
105 out nativeOffset, out fileName, out lineNumber,
107 this.fileName = fileName;
108 this.lineNumber = lineNumber;
109 this.columnNumber = 0;
112 // LAMESPEC: According to the MSDN docs, this creates a frame with _only_
113 // the filename, lineNumber and colNumber, but MS fills out the frame info as well.
114 [MethodImplAttribute (MethodImplOptions.NoInlining)]
115 public StackFrame (string fileName, int lineNumber, int colNumber)
117 get_frame_info (2, false, out methodBase, out ilOffset,
118 out nativeOffset, out fileName, out lineNumber,
120 this.fileName = fileName;
121 this.lineNumber = lineNumber;
122 this.columnNumber = colNumber;
125 public virtual int GetFileLineNumber()
130 public virtual int GetFileColumnNumber()
135 public virtual string GetFileName()
138 if (SecurityManager.SecurityEnabled && (fileName != null) && (fileName.Length > 0)) {
139 string fn = Path.GetFullPath (fileName);
140 new FileIOPermission (FileIOPermissionAccess.PathDiscovery, fn).Demand ();
146 internal string GetSecureFileName ()
148 string filename = "<filename unknown>";
149 if (fileName == null)
152 filename = GetFileName ();
154 catch (SecurityException) {
160 public virtual int GetILOffset()
165 public virtual MethodBase GetMethod ()
170 public virtual int GetNativeOffset()
175 internal long GetMethodAddress ()
177 return methodAddress;
180 internal uint GetMethodIndex ()
185 internal string GetInternalMethodName ()
187 return internalMethodName;
190 public override string ToString ()
192 StringBuilder sb = new StringBuilder ();
194 if (methodBase == null) {
195 sb.Append (Locale.GetText ("<unknown method>"));
197 sb.Append (methodBase.Name);
200 sb.Append (Locale.GetText (" at "));
202 if (ilOffset == OFFSET_UNKNOWN) {
203 sb.Append (Locale.GetText ("<unknown offset>"));
205 sb.Append (Locale.GetText ("offset "));
206 sb.Append (ilOffset);
209 sb.Append (Locale.GetText (" in file:line:column "));
210 sb.Append (GetSecureFileName ());
211 sb.AppendFormat (":{0}:{1}", lineNumber, columnNumber);
212 return sb.ToString ();