3 using System.Threading;
5 using System.Diagnostics;
6 using System.Collections;
7 using System.Collections.Generic;
8 using Mono.Cecil.Metadata;
10 namespace Mono.Debugger.Soft
12 public class VirtualMachine : Mirror
16 object startup_monitor;
17 AppDomainMirror root_domain;
18 Dictionary<int, EventRequest> requests;
19 ITargetProcess process;
21 internal Connection conn;
25 internal VirtualMachine (ITargetProcess process, Connection conn) : base () {
26 SetVirtualMachine (this);
28 queue_monitor = new Object ();
29 startup_monitor = new Object ();
30 requests = new Dictionary <int, EventRequest> ();
32 this.process = process;
33 conn.ErrorHandler += ErrorHandler;
36 // The standard output of the process is available normally through Process
37 public StreamReader StandardOutput { get; set; }
38 public StreamReader StandardError { get; set; }
41 public Process Process {
43 ProcessWrapper pw = process as ProcessWrapper;
45 throw new InvalidOperationException ("Process instance not available");
50 public ITargetProcess TargetProcess {
56 public AppDomainMirror RootDomain {
62 public EndPoint EndPoint {
64 var tcpConn = conn as TcpConnection;
66 return tcpConn.EndPoint;
71 public VersionInfo Version {
81 * It is impossible to determine when to resume when using this method, since
82 * the debuggee is suspended only once per event-set, not event.
84 [Obsolete ("Use GetNextEventSet () instead")]
85 public Event GetNextEvent () {
86 lock (queue_monitor) {
87 if (current_es == null || current_es_index == current_es.Events.Length) {
89 Monitor.Wait (queue_monitor);
90 current_es = (EventSet)queue.Dequeue ();
93 return current_es.Events [current_es_index ++];
97 public Event GetNextEvent (int timeout) {
98 throw new NotImplementedException ();
101 public EventSet GetNextEventSet () {
102 lock (queue_monitor) {
103 if (queue.Count == 0)
104 Monitor.Wait (queue_monitor);
107 current_es_index = 0;
109 return (EventSet)queue.Dequeue ();
113 [Obsolete ("Use GetNextEventSet () instead")]
114 public T GetNextEvent<T> () where T : Event {
115 return GetNextEvent () as T;
118 public void Suspend () {
122 public void Resume () {
125 } catch (CommandException ex) {
126 if (ex.ErrorCode == ErrorCode.NOT_SUSPENDED)
127 throw new InvalidOperationException ("The vm is not suspended.");
133 public void Exit (int exitCode) {
134 conn.VM_Exit (exitCode);
137 public void Dispose () {
141 notify_vm_event (EventType.VMDisconnect, SuspendPolicy.None, 0, 0, null);
144 public IList<ThreadMirror> GetThreads () {
145 long[] ids = vm.conn.VM_GetThreads ();
146 ThreadMirror[] res = new ThreadMirror [ids.Length];
147 for (int i = 0; i < ids.Length; ++i)
148 res [i] = GetThread (ids [i]);
152 // Same as the mirrorOf methods in JDI
153 public PrimitiveValue CreateValue (object value) {
155 return new PrimitiveValue (vm, null);
157 if (!value.GetType ().IsPrimitive)
158 throw new ArgumentException ("value must be of a primitive type instead of '" + value.GetType () + "'", "value");
160 return new PrimitiveValue (vm, value);
163 public EnumMirror CreateEnumMirror (TypeMirror type, PrimitiveValue value) {
164 return new EnumMirror (this, type, value);
168 // Enable send and receive timeouts on the connection and send a keepalive event
169 // every 'keepalive_interval' milliseconds.
172 public void SetSocketTimeouts (int send_timeout, int receive_timeout, int keepalive_interval)
174 conn.SetSocketTimeouts (send_timeout, receive_timeout, keepalive_interval);
178 // Methods to create event request objects
180 public BreakpointEventRequest CreateBreakpointRequest (MethodMirror method, long il_offset) {
181 return new BreakpointEventRequest (this, method, il_offset);
184 public BreakpointEventRequest CreateBreakpointRequest (Location loc) {
186 throw new ArgumentNullException ("loc");
188 return new BreakpointEventRequest (this, loc.Method, loc.ILOffset);
191 public StepEventRequest CreateStepRequest (ThreadMirror thread) {
192 return new StepEventRequest (this, thread);
195 public MethodEntryEventRequest CreateMethodEntryRequest () {
196 return new MethodEntryEventRequest (this);
199 public MethodExitEventRequest CreateMethodExitRequest () {
200 return new MethodExitEventRequest (this);
203 public ExceptionEventRequest CreateExceptionRequest (TypeMirror exc_type) {
204 return new ExceptionEventRequest (this, exc_type, true, true);
207 public ExceptionEventRequest CreateExceptionRequest (TypeMirror exc_type, bool caught, bool uncaught) {
208 return new ExceptionEventRequest (this, exc_type, caught, uncaught);
211 public AssemblyLoadEventRequest CreateAssemblyLoadRequest () {
212 return new AssemblyLoadEventRequest (this);
215 public TypeLoadEventRequest CreateTypeLoadRequest () {
216 return new TypeLoadEventRequest (this);
219 public void EnableEvents (params EventType[] events) {
220 foreach (EventType etype in events) {
221 if (etype == EventType.Breakpoint)
222 throw new ArgumentException ("Breakpoint events cannot be requested using EnableEvents", "events");
223 conn.EnableEvent (etype, SuspendPolicy.All, null);
227 public BreakpointEventRequest SetBreakpoint (MethodMirror method, long il_offset) {
228 BreakpointEventRequest req = CreateBreakpointRequest (method, il_offset);
235 public void ClearAllBreakpoints () {
236 conn.ClearAllBreakpoints ();
239 public void Disconnect () {
244 // Return a list of TypeMirror objects for all loaded types which reference the
245 // source file FNAME. Might return false positives.
246 // Since protocol version 2.7.
248 public IList<TypeMirror> GetTypesForSourceFile (string fname, bool ignoreCase) {
249 long[] ids = conn.VM_GetTypesForSourceFile (fname, ignoreCase);
250 var res = new TypeMirror [ids.Length];
251 for (int i = 0; i < ids.Length; ++i)
252 res [i] = GetType (ids [i]);
257 // Return a list of TypeMirror objects for all loaded types named 'NAME'.
258 // NAME should be in the the same for as with Assembly.GetType ().
259 // Since protocol version 2.9.
261 public IList<TypeMirror> GetTypes (string name, bool ignoreCase) {
262 long[] ids = conn.VM_GetTypes (name, ignoreCase);
263 var res = new TypeMirror [ids.Length];
264 for (int i = 0; i < ids.Length; ++i)
265 res [i] = GetType (ids [i]);
269 internal void queue_event_set (EventSet es) {
270 lock (queue_monitor) {
272 Monitor.Pulse (queue_monitor);
276 internal void ErrorHandler (object sender, ErrorHandlerEventArgs args) {
277 switch (args.ErrorCode) {
278 case ErrorCode.INVALID_OBJECT:
279 throw new ObjectCollectedException ();
280 case ErrorCode.INVALID_FRAMEID:
281 throw new InvalidStackFrameException ();
282 case ErrorCode.NOT_SUSPENDED:
283 throw new InvalidOperationException ("The vm is not suspended.");
284 case ErrorCode.NOT_IMPLEMENTED:
285 throw new NotSupportedException ("This request is not supported by the protocol version implemented by the debuggee.");
286 case ErrorCode.ABSENT_INFORMATION:
287 throw new AbsentInformationException ();
288 case ErrorCode.NO_SEQ_POINT_AT_IL_OFFSET:
289 throw new ArgumentException ("Cannot set breakpoint on the specified IL offset.");
291 throw new CommandException (args.ErrorCode);
295 /* Wait for the debuggee to start up and connect to it */
296 internal void connect () {
299 // Test the connection
300 version = conn.Version;
301 if (version.MajorVersion != Connection.MAJOR_VERSION)
302 throw new NotSupportedException (String.Format ("The debuggee implements protocol version {0}.{1}, while {2}.{3} is required.", version.MajorVersion, version.MinorVersion, Connection.MAJOR_VERSION, Connection.MINOR_VERSION));
304 long root_domain_id = conn.RootDomain;
305 root_domain = GetDomain (root_domain_id);
308 internal void notify_vm_event (EventType evtype, SuspendPolicy spolicy, int req_id, long thread_id, string vm_uri) {
309 //Console.WriteLine ("Event: " + evtype + "(" + vm_uri + ")");
312 case EventType.VMStart:
313 /* Notify the main thread that the debuggee started up */
314 lock (startup_monitor) {
315 Monitor.Pulse (startup_monitor);
317 queue_event_set (new EventSet (this, spolicy, new Event[] { new VMStartEvent (vm, req_id, thread_id) }));
319 case EventType.VMDeath:
320 queue_event_set (new EventSet (this, spolicy, new Event[] { new VMDeathEvent (vm, req_id) }));
322 case EventType.VMDisconnect:
323 queue_event_set (new EventSet (this, spolicy, new Event[] { new VMDisconnectEvent (vm, req_id) }));
326 throw new Exception ();
331 // Methods to create instances of mirror objects
335 class MirrorCache<T> {
336 static Dictionary <long, T> mirrors;
337 static object mirror_lock = new object ();
339 internal static T GetMirror (VirtualMachine vm, long id) {
342 mirrors = new Dictionary <long, T> ();
344 if (!mirrors.TryGetValue (id, out obj)) {
345 obj = CreateMirror (vm, id);
352 internal static T CreateMirror (VirtualMachine vm, long id) {
357 // FIXME: When to remove items from the cache ?
359 Dictionary <long, MethodMirror> methods;
360 object methods_lock = new object ();
362 internal MethodMirror GetMethod (long id) {
363 lock (methods_lock) {
365 methods = new Dictionary <long, MethodMirror> ();
369 if (!methods.TryGetValue (id, out obj)) {
370 obj = new MethodMirror (this, id);
377 Dictionary <long, AssemblyMirror> assemblies;
378 object assemblies_lock = new object ();
380 internal AssemblyMirror GetAssembly (long id) {
381 lock (assemblies_lock) {
382 if (assemblies == null)
383 assemblies = new Dictionary <long, AssemblyMirror> ();
387 if (!assemblies.TryGetValue (id, out obj)) {
388 obj = new AssemblyMirror (this, id);
389 assemblies [id] = obj;
395 Dictionary <long, ModuleMirror> modules;
396 object modules_lock = new object ();
398 internal ModuleMirror GetModule (long id) {
399 lock (modules_lock) {
401 modules = new Dictionary <long, ModuleMirror> ();
405 if (!modules.TryGetValue (id, out obj)) {
406 obj = new ModuleMirror (this, id);
413 Dictionary <long, AppDomainMirror> domains;
414 object domains_lock = new object ();
416 internal AppDomainMirror GetDomain (long id) {
417 lock (domains_lock) {
419 domains = new Dictionary <long, AppDomainMirror> ();
423 if (!domains.TryGetValue (id, out obj)) {
424 obj = new AppDomainMirror (this, id);
431 Dictionary <long, TypeMirror> types;
432 object types_lock = new object ();
434 internal TypeMirror GetType (long id) {
437 types = new Dictionary <long, TypeMirror> ();
441 if (!types.TryGetValue (id, out obj)) {
442 obj = new TypeMirror (this, id);
449 internal TypeMirror[] GetTypes (long[] ids) {
450 var res = new TypeMirror [ids.Length];
451 for (int i = 0; i < ids.Length; ++i)
452 res [i] = GetType (ids [i]);
456 Dictionary <long, ObjectMirror> objects;
457 object objects_lock = new object ();
459 internal T GetObject<T> (long id, long domain_id, long type_id) where T : ObjectMirror {
460 lock (objects_lock) {
462 objects = new Dictionary <long, ObjectMirror> ();
464 if (!objects.TryGetValue (id, out obj)) {
466 * Obtain the domain/type of the object to determine the type of
467 * object we need to create.
469 if (domain_id == 0 || type_id == 0) {
470 if (conn.Version.AtLeast (2, 5)) {
471 var info = conn.Object_GetInfo (id);
472 domain_id = info.domain_id;
473 type_id = info.type_id;
476 domain_id = conn.Object_GetDomain (id);
478 type_id = conn.Object_GetType (id);
481 AppDomainMirror d = GetDomain (domain_id);
482 TypeMirror t = GetType (type_id);
484 if (t.Assembly == d.Corlib && t.Namespace == "System.Threading" && t.Name == "Thread")
485 obj = new ThreadMirror (this, id, t, d);
486 else if (t.Assembly == d.Corlib && t.Namespace == "System" && t.Name == "String")
487 obj = new StringMirror (this, id, t, d);
488 else if (typeof (T) == typeof (ArrayMirror))
489 obj = new ArrayMirror (this, id, t, d);
491 obj = new ObjectMirror (this, id, t, d);
498 internal T GetObject<T> (long id) where T : ObjectMirror {
499 return GetObject<T> (id, 0, 0);
502 internal ObjectMirror GetObject (long objid) {
503 return GetObject<ObjectMirror> (objid);
506 internal ThreadMirror GetThread (long id) {
507 return GetObject <ThreadMirror> (id);
510 object requests_lock = new object ();
512 internal void AddRequest (EventRequest req, int id) {
513 lock (requests_lock) {
518 internal void RemoveRequest (EventRequest req, int id) {
519 lock (requests_lock) {
520 requests.Remove (id);
524 internal EventRequest GetRequest (int id) {
525 lock (requests_lock) {
526 return requests [id];
530 internal Value DecodeValue (ValueImpl v) {
532 return new PrimitiveValue (this, v.Value);
535 case ElementType.Void:
537 case ElementType.SzArray:
538 case ElementType.Array:
539 return GetObject<ArrayMirror> (v.Objid);
540 case ElementType.String:
541 return GetObject<StringMirror> (v.Objid);
542 case ElementType.Class:
543 case ElementType.Object:
544 return GetObject (v.Objid);
545 case ElementType.ValueType:
547 return new EnumMirror (this, GetType (v.Klass), DecodeValues (v.Fields));
549 return new StructMirror (this, GetType (v.Klass), DecodeValues (v.Fields));
550 case (ElementType)ValueTypeId.VALUE_TYPE_ID_NULL:
551 return new PrimitiveValue (this, null);
553 throw new NotImplementedException ("" + v.Type);
557 internal Value[] DecodeValues (ValueImpl[] values) {
558 Value[] res = new Value [values.Length];
559 for (int i = 0; i < values.Length; ++i)
560 res [i] = DecodeValue (values [i]);
564 internal ValueImpl EncodeValue (Value v) {
565 if (v is PrimitiveValue) {
566 object val = (v as PrimitiveValue).Value;
568 return new ValueImpl { Type = (ElementType)ValueTypeId.VALUE_TYPE_ID_NULL, Objid = 0 };
570 return new ValueImpl { Value = val };
571 } else if (v is ObjectMirror) {
572 return new ValueImpl { Type = ElementType.Object, Objid = (v as ObjectMirror).Id };
573 } else if (v is StructMirror) {
574 return new ValueImpl { Type = ElementType.ValueType, Klass = (v as StructMirror).Type.Id, Fields = EncodeValues ((v as StructMirror).Fields) };
576 throw new NotSupportedException ();
580 internal ValueImpl[] EncodeValues (IList<Value> values) {
581 ValueImpl[] res = new ValueImpl [values.Count];
582 for (int i = 0; i < values.Count; ++i)
583 res [i] = EncodeValue (values [i]);
587 internal void CheckProtocolVersion (int major, int minor) {
588 if (!conn.Version.AtLeast (major, minor))
589 throw new NotSupportedException ("This request is not supported by the protocol version implemented by the debuggee.");
593 class EventHandler : MarshalByRefObject, IEventHandler
597 public EventHandler (VirtualMachine vm) {
601 public void Events (SuspendPolicy suspend_policy, EventInfo[] events) {
602 var l = new List<Event> ();
604 for (int i = 0; i < events.Length; ++i) {
605 EventInfo ei = events [i];
606 int req_id = ei.ReqId;
607 long thread_id = ei.ThreadId;
609 long loc = ei.Location;
611 switch (ei.EventType) {
612 case EventType.VMStart:
613 vm.notify_vm_event (EventType.VMStart, suspend_policy, req_id, thread_id, null);
615 case EventType.VMDeath:
616 vm.notify_vm_event (EventType.VMDeath, suspend_policy, req_id, thread_id, null);
618 case EventType.ThreadStart:
619 l.Add (new ThreadStartEvent (vm, req_id, id));
621 case EventType.ThreadDeath:
622 l.Add (new ThreadDeathEvent (vm, req_id, id));
624 case EventType.AssemblyLoad:
625 l.Add (new AssemblyLoadEvent (vm, req_id, thread_id, id));
627 case EventType.AssemblyUnload:
628 l.Add (new AssemblyUnloadEvent (vm, req_id, thread_id, id));
630 case EventType.TypeLoad:
631 l.Add (new TypeLoadEvent (vm, req_id, thread_id, id));
633 case EventType.MethodEntry:
634 l.Add (new MethodEntryEvent (vm, req_id, thread_id, id));
636 case EventType.MethodExit:
637 l.Add (new MethodExitEvent (vm, req_id, thread_id, id));
639 case EventType.Breakpoint:
640 l.Add (new BreakpointEvent (vm, req_id, thread_id, id, loc));
643 l.Add (new StepEvent (vm, req_id, thread_id, id, loc));
645 case EventType.Exception:
646 l.Add (new ExceptionEvent (vm, req_id, thread_id, id, loc));
648 case EventType.AppDomainCreate:
649 l.Add (new AppDomainCreateEvent (vm, req_id, thread_id, id));
651 case EventType.AppDomainUnload:
652 l.Add (new AppDomainUnloadEvent (vm, req_id, thread_id, id));
654 case EventType.UserBreak:
655 l.Add (new UserBreakEvent (vm, req_id, thread_id));
657 case EventType.UserLog:
658 l.Add (new UserLogEvent (vm, req_id, thread_id, ei.Level, ei.Category, ei.Message));
666 vm.queue_event_set (new EventSet (vm, suspend_policy, l.ToArray ()));
669 public void VMDisconnect (int req_id, long thread_id, string vm_uri) {
670 vm.notify_vm_event (EventType.VMDisconnect, SuspendPolicy.None, req_id, thread_id, vm_uri);
674 internal class CommandException : Exception {
676 public CommandException (ErrorCode error_code) : base ("Debuggee returned error code " + error_code + ".") {
677 ErrorCode = error_code;
680 public ErrorCode ErrorCode {