// Checks Locals, followed by `this`
public async Task <JObject> Resolve(string var_name, CancellationToken token)
{
if (scopeCache.Locals.Count == 0 && !locals_fetched)
{
Result scope_res = await proxy.GetScopeProperties(sessionId, scopeId, token);
if (scope_res.IsErr)
{
throw new Exception($"BUG: Unable to get properties for scope: {scopeId}. {scope_res}");
}
locals_fetched = true;
}
if (scopeCache.Locals.TryGetValue(var_name, out JObject obj))
{
return(obj["value"]?.Value <JObject>());
}
if (scopeCache.MemberReferences.TryGetValue(var_name, out JObject ret))
{
return(ret);
}
if (varIds == null)
{
Frame scope = ctx.CallStack.FirstOrDefault(s => s.Id == scopeId);
varIds = scope.Method.GetLiveVarsAt(scope.Location.CliLocation.Offset);
}
Result res = await proxy.SendMonoCommand(sessionId, MonoCommands.EvaluateMemberAccess(scopeId, var_name, varIds), token);
if (res.IsOk)
{
ret = res.Value?["result"]?["value"]?["value"]?.Value <JObject>();
scopeCache.MemberReferences[var_name] = ret;
}
else
{
logger.LogDebug(res.Error.ToString());
}
return(ret);
}
async Task <Breakpoint> SetMonoBreakpoint(SessionId sessionId, string reqId, SourceLocation location, CancellationToken token)
{
var bp = new Breakpoint(reqId, location, BreakpointState.Pending);
var asm_name = bp.Location.CliLocation.Method.Assembly.Name;
var method_token = bp.Location.CliLocation.Method.Token;
var il_offset = bp.Location.CliLocation.Offset;
var res = await SendMonoCommand(sessionId, MonoCommands.SetBreakpoint(asm_name, method_token, il_offset), token);
var ret_code = res.Value?["result"]?["value"]?.Value <int>();
if (ret_code.HasValue)
{
bp.RemoteId = ret_code.Value;
bp.State = BreakpointState.Active;
//Log ("verbose", $"BP local id {bp.LocalId} enabled with remote id {bp.RemoteId}");
}
return(bp);
}
internal async Task <Result> GetScopeProperties(MessageId msg_id, int scope_id, CancellationToken token)
{
try
{
var ctx = GetContext(msg_id);
var scope = ctx.CallStack.FirstOrDefault(s => s.Id == scope_id);
if (scope == null)
{
return(Result.Err(JObject.FromObject(new { message = $"Could not find scope with id #{scope_id}" })));
}
var var_ids = scope.Method.GetLiveVarsAt(scope.Location.CliLocation.Offset);
var res = await SendMonoCommand(msg_id, MonoCommands.GetScopeVariables(scope.Id, var_ids), token);
//if we fail we just buble that to the IDE (and let it panic over it)
if (res.IsErr)
{
return(res);
}
var values = res.Value?["result"]?["value"]?.Values <JObject>().ToArray();
if (values == null || values.Length == 0)
{
return(Result.OkFromObject(new { result = Array.Empty <object>() }));
}
var frameCache = ctx.GetCacheForScope(scope_id);
foreach (var value in values)
{
frameCache.Locals[value["name"]?.Value <string>()] = value;
}
return(Result.OkFromObject(new { result = values }));
}
catch (Exception exception)
{
Log("verbose", $"Error resolving scope properties {exception.Message}");
return(Result.Exception(exception));
}
}
async Task <DebugStore> RuntimeReady(SessionId sessionId, CancellationToken token)
{
var context = GetContext(sessionId);
if (Interlocked.CompareExchange(ref context.ready, new TaskCompletionSource <DebugStore>(), null) != null)
{
return(await context.ready.Task);
}
var clear_result = await SendMonoCommand(sessionId, MonoCommands.ClearAllBreakpoints(), token);
if (clear_result.IsErr)
{
Log("verbose", $"Failed to clear breakpoints due to {clear_result}");
}
var store = await LoadStore(sessionId, token);
context.ready.SetResult(store);
SendEvent(sessionId, "Mono.runtimeReady", new JObject(), token);
return(store);
}
async Task <Result> RuntimeGetProperties(MessageId id, DotnetObjectId objectId, JToken args, CancellationToken token)
{
if (objectId.Scheme == "scope")
{
return(await GetScopeProperties(id, int.Parse(objectId.Value), token));
}
var res = await SendMonoCommand(id, MonoCommands.GetDetails(objectId, args), token);
if (res.IsErr)
{
return(res);
}
if (objectId.Scheme == "cfo_res")
{
// Runtime.callFunctionOn result object
var value_json_str = res.Value["result"]?["value"]?["__value_as_json_string__"]?.Value <string>();
if (value_json_str != null)
{
res = Result.OkFromObject(new
{
result = JArray.Parse(value_json_str)
});
}
else
{
res = Result.OkFromObject(new { result = new { } });
}
}
else
{
res = Result.Ok(JObject.FromObject(new { result = res.Value["result"]["value"] }));
}
return(res);
}
async Task <DebugStore> LoadStore(SessionId sessionId, CancellationToken token)
{
var context = GetContext(sessionId);
if (Interlocked.CompareExchange(ref context.store, new DebugStore(logger), null) != null)
{
return(await context.Source.Task);
}
try
{
var loaded_files = context.LoadedFiles;
if (loaded_files == null)
{
var loaded = await SendMonoCommand(sessionId, MonoCommands.GetLoadedFiles(), token);
loaded_files = loaded.Value?["result"]?["value"]?.ToObject <string[]>();
}
await
foreach (var source in context.store.Load(sessionId, loaded_files, token).WithCancellation(token))
{
await OnSourceFileAdded(sessionId, source, context, token);
}
}
catch (Exception e)
{
context.Source.SetException(e);
}
if (!context.Source.Task.IsCompleted)
{
context.Source.SetResult(context.store);
}
return(context.store);
}
async Task <bool> OnPause(SessionId sessionId, JObject args, CancellationToken token)
{
//FIXME we should send release objects every now and then? Or intercept those we inject and deal in the runtime
var res = await SendMonoCommand(sessionId, MonoCommands.GetCallStack(), token);
var orig_callframes = args?["callFrames"]?.Values <JObject>();
var context = GetContext(sessionId);
JObject data = null;
var reason = "other";//other means breakpoint
if (res.IsErr)
{
//Give up and send the original call stack
return(false);
}
//step one, figure out where did we hit
var res_value = res.Value?["result"]?["value"];
if (res_value == null || res_value is JValue)
{
//Give up and send the original call stack
return(false);
}
Log("verbose", $"call stack (err is {res.Error} value is:\n{res.Value}");
var bp_id = res_value?["breakpoint_id"]?.Value <int>();
Log("verbose", $"We just hit bp {bp_id}");
if (!bp_id.HasValue)
{
//Give up and send the original call stack
return(false);
}
var bp = context.BreakpointRequests.Values.SelectMany(v => v.Locations).FirstOrDefault(b => b.RemoteId == bp_id.Value);
var callFrames = new List <object>();
foreach (var frame in orig_callframes)
{
var function_name = frame["functionName"]?.Value <string>();
var url = frame["url"]?.Value <string>();
if ("mono_wasm_fire_bp" == function_name || "_mono_wasm_fire_bp" == function_name ||
"_mono_wasm_fire_exception" == function_name)
{
if ("_mono_wasm_fire_exception" == function_name)
{
var exception_obj_id = await SendMonoCommand(sessionId, MonoCommands.GetExceptionObject(), token);
var res_val = exception_obj_id.Value?["result"]?["value"];
var exception_dotnet_obj_id = new DotnetObjectId("object", res_val?["exception_id"]?.Value <string>());
data = JObject.FromObject(new
{
type = "object",
subtype = "error",
className = res_val?["class_name"]?.Value <string>(),
uncaught = res_val?["uncaught"]?.Value <bool>(),
description = res_val?["message"]?.Value <string>() + "\n",
objectId = exception_dotnet_obj_id.ToString()
});
reason = "exception";
}
var frames = new List <Frame>();
var the_mono_frames = res.Value?["result"]?["value"]?["frames"]?.Values <JObject>();
foreach (var mono_frame in the_mono_frames)
{
int frame_id = mono_frame["frame_id"].Value <int>();
var il_pos = mono_frame["il_pos"].Value <int>();
var method_token = mono_frame["method_token"].Value <uint>();
var assembly_name = mono_frame["assembly_name"].Value <string>();
// This can be different than `method.Name`, like in case of generic methods
var method_name = mono_frame["method_name"]?.Value <string>();
var store = await LoadStore(sessionId, token);
var asm = store.GetAssemblyByName(assembly_name);
if (asm == null)
{
Log("info", $"Unable to find assembly: {assembly_name}");
continue;
}
var method = asm.GetMethodByToken(method_token);
if (method == null && !asm.Image.HasSymbols)
{
try
{
method = await LoadSymbolsOnDemand(asm, method_token, sessionId, token);
}
catch (Exception e)
{
Log("info", $"Unable to find il offset: {il_pos} in method token: {method_token} assembly name: {assembly_name} exception: {e.ToString()}");
continue;
}
}
if (method == null)
{
Log("info", $"Unable to find il offset: {il_pos} in method token: {method_token} assembly name: {assembly_name}");
continue;
}
var location = method?.GetLocationByIl(il_pos);
// When hitting a breakpoint on the "IncrementCount" method in the standard
// Blazor project template, one of the stack frames is inside mscorlib.dll
// and we get location==null for it. It will trigger a NullReferenceException
// if we don't skip over that stack frame.
if (location == null)
{
continue;
}
Log("info", $"frame il offset: {il_pos} method token: {method_token} assembly name: {assembly_name}");
Log("info", $"\tmethod {method_name} location: {location}");
frames.Add(new Frame(method, location, frame_id));
callFrames.Add(new
{
functionName = method_name,
callFrameId = $"dotnet:scope:{frame_id}",
functionLocation = method.StartLocation.AsLocation(),
location = location.AsLocation(),
url = store.ToUrl(location),
scopeChain = new[]
{
new
{
type = "local",
@object = new
{
@type = "object",
className = "Object",
description = "Object",
objectId = $"dotnet:scope:{frame_id}",
},
name = method_name,
startLocation = method.StartLocation.AsLocation(),
endLocation = method.EndLocation.AsLocation(),
}
}
});
context.CallStack = frames;
}
}
else if (!(function_name.StartsWith("wasm-function", StringComparison.Ordinal) ||
url.StartsWith("wasm://wasm/", StringComparison.Ordinal)))
{
callFrames.Add(frame);
}
}
var bp_list = new string[bp == null ? 0 : 1];
if (bp != null)
{
bp_list[0] = bp.StackId;
}
var o = JObject.FromObject(new
{
callFrames,
reason,
data,
hitBreakpoints = bp_list,
});
SendEvent(sessionId, "Debugger.paused", o, token);
return(true);
}
internal Task <Result> SendMonoCommand(SessionId id, MonoCommands cmd, CancellationToken token) => SendCommand(id, "Runtime.evaluate", JObject.FromObject(cmd), token);
protected override async Task <bool> AcceptCommand(MessageId id, string method, JObject args, CancellationToken token)
{
// Inspector doesn't use the Target domain or sessions
// so we try to init immediately
if (hideWebDriver && id == SessionId.Null)
{
await DeleteWebDriver(id, token);
}
if (!contexts.TryGetValue(id, out var context))
{
return(false);
}
switch (method)
{
case "Target.attachToTarget":
{
var resp = await SendCommand(id, method, args, token);
await DeleteWebDriver(new SessionId(resp.Value["sessionId"]?.ToString()), token);
break;
}
case "Debugger.enable":
{
var resp = await SendCommand(id, method, args, token);
context.DebuggerId = resp.Value["debuggerId"]?.ToString();
if (await IsRuntimeAlreadyReadyAlready(id, token))
{
await RuntimeReady(id, token);
}
SendResponse(id, resp, token);
return(true);
}
case "Debugger.getScriptSource":
{
var script = args?["scriptId"]?.Value <string>();
return(await OnGetScriptSource(id, script, token));
}
case "Runtime.compileScript":
{
var exp = args?["expression"]?.Value <string>();
if (exp.StartsWith("//dotnet:", StringComparison.Ordinal))
{
OnCompileDotnetScript(id, token);
return(true);
}
break;
}
case "Debugger.getPossibleBreakpoints":
{
var resp = await SendCommand(id, method, args, token);
if (resp.IsOk && resp.Value["locations"].HasValues)
{
SendResponse(id, resp, token);
return(true);
}
var start = SourceLocation.Parse(args?["start"] as JObject);
//FIXME support variant where restrictToFunction=true and end is omitted
var end = SourceLocation.Parse(args?["end"] as JObject);
if (start != null && end != null && await GetPossibleBreakpoints(id, start, end, token))
{
return(true);
}
SendResponse(id, resp, token);
return(true);
}
case "Debugger.setBreakpoint":
{
break;
}
case "Debugger.setBreakpointByUrl":
{
var resp = await SendCommand(id, method, args, token);
if (!resp.IsOk)
{
SendResponse(id, resp, token);
return(true);
}
var bpid = resp.Value["breakpointId"]?.ToString();
var locations = resp.Value["locations"]?.Values <object>();
var request = BreakpointRequest.Parse(bpid, args);
// is the store done loading?
var loaded = context.Source.Task.IsCompleted;
if (!loaded)
{
// Send and empty response immediately if not
// and register the breakpoint for resolution
context.BreakpointRequests[bpid] = request;
SendResponse(id, resp, token);
}
if (await IsRuntimeAlreadyReadyAlready(id, token))
{
var store = await RuntimeReady(id, token);
Log("verbose", $"BP req {args}");
await SetBreakpoint(id, store, request, !loaded, token);
}
if (loaded)
{
// we were already loaded so we should send a response
// with the locations included and register the request
context.BreakpointRequests[bpid] = request;
var result = Result.OkFromObject(request.AsSetBreakpointByUrlResponse(locations));
SendResponse(id, result, token);
}
return(true);
}
case "Debugger.removeBreakpoint":
{
await RemoveBreakpoint(id, args, token);
break;
}
case "Debugger.resume":
{
await OnResume(id, token);
break;
}
case "Debugger.stepInto":
{
return(await Step(id, StepKind.Into, token));
}
case "Debugger.stepOut":
{
return(await Step(id, StepKind.Out, token));
}
case "Debugger.stepOver":
{
return(await Step(id, StepKind.Over, token));
}
case "Debugger.evaluateOnCallFrame":
{
if (!DotnetObjectId.TryParse(args?["callFrameId"], out var objectId))
{
return(false);
}
switch (objectId.Scheme)
{
case "scope":
return(await OnEvaluateOnCallFrame(id,
int.Parse(objectId.Value),
args?["expression"]?.Value <string>(), token));
default:
return(false);
}
}
case "Runtime.getProperties":
{
if (!DotnetObjectId.TryParse(args?["objectId"], out var objectId))
{
break;
}
var result = await RuntimeGetProperties(id, objectId, args, token);
SendResponse(id, result, token);
return(true);
}
case "Runtime.releaseObject":
{
if (!(DotnetObjectId.TryParse(args["objectId"], out var objectId) && objectId.Scheme == "cfo_res"))
{
break;
}
await SendMonoCommand(id, MonoCommands.ReleaseObject(objectId), token);
SendResponse(id, Result.OkFromObject(new { }), token);
return(true);
}
case "Debugger.setPauseOnExceptions":
{
string state = args["state"].Value <string>();
await SendMonoCommand(id, MonoCommands.SetPauseOnExceptions(state), token);
// Pass this on to JS too
return(false);
}
// Protocol extensions
case "DotnetDebugger.addSymbolServerUrl":
{
string url = args["url"]?.Value <string>();
if (!String.IsNullOrEmpty(url) && !urlSymbolServerList.Contains(url))
{
urlSymbolServerList.Add(url);
}
SendResponse(id, Result.OkFromObject(new { }), token);
return(true);
}
case "DotnetDebugger.getMethodLocation":
{
Console.WriteLine("set-breakpoint-by-method: " + id + " " + args);
var store = await RuntimeReady(id, token);
string aname = args["assemblyName"]?.Value <string>();
string typeName = args["typeName"]?.Value <string>();
string methodName = args["methodName"]?.Value <string>();
if (aname == null || typeName == null || methodName == null)
{
SendResponse(id, Result.Err("Invalid protocol message '" + args + "'."), token);
return(true);
}
// GetAssemblyByName seems to work on file names
var assembly = store.GetAssemblyByName(aname);
if (assembly == null)
{
assembly = store.GetAssemblyByName(aname + ".exe");
}
if (assembly == null)
{
assembly = store.GetAssemblyByName(aname + ".dll");
}
if (assembly == null)
{
SendResponse(id, Result.Err("Assembly '" + aname + "' not found."), token);
return(true);
}
var type = assembly.GetTypeByName(typeName);
if (type == null)
{
SendResponse(id, Result.Err($"Type '{typeName}' not found."), token);
return(true);
}
var methodInfo = type.Methods.FirstOrDefault(m => m.Name == methodName);
if (methodInfo == null)
{
// Maybe this is an async method, in which case the debug info is attached
// to the async method implementation, in class named:
// `{type_name}/<method_name>::MoveNext`
methodInfo = assembly.TypesByName.Values.SingleOrDefault(t => t.FullName.StartsWith($"{typeName}/<{methodName}>"))?
.Methods.FirstOrDefault(mi => mi.Name == "MoveNext");
}
if (methodInfo == null)
{
SendResponse(id, Result.Err($"Method '{typeName}:{methodName}' not found."), token);
return(true);
}
var src_url = methodInfo.Assembly.Sources.Single(sf => sf.SourceId == methodInfo.SourceId).Url;
SendResponse(id, Result.OkFromObject(new
{
result = new { line = methodInfo.StartLocation.Line, column = methodInfo.StartLocation.Column, url = src_url }
}), token);
return(true);
}
case "Runtime.callFunctionOn":
{
if (!DotnetObjectId.TryParse(args["objectId"], out var objectId))
{
return(false);
}
if (objectId.Scheme == "scope")
{
SendResponse(id,
Result.Exception(new ArgumentException(
$"Runtime.callFunctionOn not supported with scope ({objectId}).")),
token);
return(true);
}
var res = await SendMonoCommand(id, MonoCommands.CallFunctionOn(args), token);
var res_value_type = res.Value?["result"]?["value"]?.Type;
if (res.IsOk && res_value_type == JTokenType.Object || res_value_type == JTokenType.Object)
{
res = Result.OkFromObject(new { result = res.Value["result"]["value"] });
}
SendResponse(id, res, token);
return(true);
}
}
return(false);
}
