[wasm][debugger] Support indexing of valuetype scheme (#92637)

* Prepare test cases for signle dim.

* Fixed for constant indices.

* More tests + fix.

* Unblock, working after rebuild.

* Initial inlined arrays cleanup.

* Lines are shifted again.

* @thaystg's fix for inline arrays

* Added test for method on inline array.

* Multi-dim works as well.

* fix

* Tentative fix from feedback.

* 0th element is decoded before the loop.

* Feedback part 1.

src/mono/mono/component/debugger-agent.c

@@ -5328,14 +5328,15 @@ decode_vtype (MonoType *t, MonoDomain *domain, gpointer void_addr, gpointer void
  gpointer iter = NULL;
  MonoDomain *d;
  ErrorCode err;
+ int inlineArraySize = -1;
 
  /* is_enum, ignored */
  decode_byte (buf, &buf, limit);
  if (CHECK_PROTOCOL_VERSION(2, 61))
  decode_byte (buf, &buf, limit);
  klass = decode_typeid (buf, &buf, limit, &d, &err);
  if (CHECK_PROTOCOL_VERSION(2, 65))
- decode_int (buf, &buf, limit); //ignore inline array
+ inlineArraySize = decode_int (buf, &buf, limit);
  if (err != ERR_NONE)
  return err;
 
@@ -5360,6 +5361,12 @@ decode_vtype (MonoType *t, MonoDomain *domain, gpointer void_addr, gpointer void
  if (err != ERR_NONE)
  return err;
  nfields --;
+ if (CHECK_PROTOCOL_VERSION(2, 66) && inlineArraySize > 0)
+ {
+ int element_size = mono_class_instance_size (mono_class_from_mono_type_internal (f->type)) - MONO_ABI_SIZEOF (MonoObject);
+ for (int i = 1; i < inlineArraySize; i++)
+ decode_value (f->type, domain, ((char*)mono_vtype_get_field_addr (addr, f)) + (i*element_size), buf, &buf, limit, check_field_datatype, extra_space, members_in_extra_space);
+ }
  }
  g_assert (nfields == 0);
 
@@ -5434,14 +5441,15 @@ decode_vtype_compute_size (MonoType *t, MonoDomain *domain, gpointer void_buf, g
  gpointer iter = NULL;
  MonoDomain *d;
  ErrorCode err;
+ int inlineArraySize = -1;
 
  /* is_enum, ignored */
  decode_byte (buf, &buf, limit);
  if (CHECK_PROTOCOL_VERSION(2, 61))
  decode_byte (buf, &buf, limit);
  klass = decode_typeid (buf, &buf, limit, &d, &err);
  if (CHECK_PROTOCOL_VERSION(2, 65))
- decode_int (buf, &buf, limit); //ignore inline array
+ inlineArraySize = decode_int (buf, &buf, limit);
  if (err != ERR_NONE)
  goto end;
 
@@ -5464,6 +5472,14 @@ decode_vtype_compute_size (MonoType *t, MonoDomain *domain, gpointer void_buf, g
  if (err != ERR_NONE)
  return err;
  nfields --;
+ if (CHECK_PROTOCOL_VERSION(2, 66) && inlineArraySize > 0)
+ {
+ for (int i = 1; i < inlineArraySize; i++) {
+ field_size = decode_value_compute_size (f->type, 0, domain, buf, &buf, limit, members_in_extra_space);
+ if (members_in_extra_space)
+ ret += field_size;
+ }
+ }
  }
  g_assert (nfields == 0);
 

src/mono/wasm/debugger/BrowserDebugProxy/MemberReferenceResolver.cs

@@ -408,6 +408,12 @@ public async Task<JObject> Resolve(
  if (!context.SdbAgent.ValueCreator.TryGetValueTypeById(objectId.Value, out ValueTypeClass valueType))
  throw new InvalidOperationException($"Cannot apply indexing with [] to an expression of scheme '{objectId.Scheme}'");
  var typeInfo = await context.SdbAgent.GetTypeInfo(valueType.TypeId, token);
+ if (valueType.InlineArray == null)
+ {
+ JObject vtResult = await InvokeGetItemOnJObject(rootObject, valueType.TypeId, objectId, elementIdxInfo, token);
+ if (vtResult != null)
+ return vtResult;
+ }
  if (int.TryParse(elementIdxInfo.ElementIdxStr, out elementIdx) && elementIdx >= 0 && elementIdx < valueType.InlineArray.Count)
  return (JObject)valueType.InlineArray[elementIdx]["value"];
  throw new InvalidOperationException($"Index is outside the bounds of the inline array");
@@ -436,34 +442,11 @@ public async Task<JObject> Resolve(
  if (elementIdxInfo.Indexers is null || elementIdxInfo.Indexers.Count == 0)
  throw new InternalErrorException($"Unable to write index parameter to invoke the method in the runtime.");
 
- var typeIds = await context.SdbAgent.GetTypeIdsForObject(objectId.Value, true, token);
- int[] methodIds = await context.SdbAgent.GetMethodIdsByName(typeIds[0], "get_Item", BindingFlags.Default, token);
- if (methodIds == null || methodIds.Length == 0)
- throw new InvalidOperationException($"Type '{rootObject?["className"]?.Value<string>()}' cannot be indexed.");
-
- // ToDo: optimize the loop by choosing the right method at once without trying out them all
- for (int i = 0; i < methodIds.Length; i++)
- {
- MethodInfoWithDebugInformation methodInfo = await context.SdbAgent.GetMethodInfo(methodIds[i], token);
- ParameterInfo[] paramInfo = methodInfo.GetParametersInfo();
- if (paramInfo.Length == elementIdxInfo.DimensionsCount)
- {
- try
- {
- if (!CheckParametersCompatibility(paramInfo, elementIdxInfo.Indexers))
- continue;
- ArraySegment<byte> buffer = await WriteIndexObjectAsIndices(objectId, elementIdxInfo.Indexers, paramInfo);
- JObject getItemRetObj = await context.SdbAgent.InvokeMethod(buffer, methodIds[i], token);
- return (JObject)getItemRetObj["value"];
- }
- catch (Exception ex)
- {
- logger.LogDebug($"Attempt number {i + 1} out of {methodIds.Length} of invoking method {methodInfo.Name} with parameter named {paramInfo[0].Name} on type {type} failed. Method Id = {methodIds[i]}.\nInner exception: {ex}.");
- continue;
- }
- }
- }
- throw new InvalidOperationException($"Cannot apply indexing with [] to an object of type '{rootObject?["className"]?.Value<string>()}'");
+ List<int> typeIds = await context.SdbAgent.GetTypeIdsForObject(objectId.Value, true, token);
+ JObject objResult = await InvokeGetItemOnJObject(rootObject, typeIds[0], objectId, elementIdxInfo, token);
+ if (objResult == null)
+ throw new InvalidOperationException($"Cannot apply indexing with [] to an object of type '{rootObject?["className"]?.Value<string>()}'");
+ return objResult;
  default:
  throw new InvalidOperationException($"Cannot apply indexing with [] to an expression of scheme '{objectId.Scheme}'");
  }
@@ -543,6 +526,42 @@ async Task<ElementIndexInfo> GetElementIndexInfo(List<JObject> nestedIndexers)
  ElementIdxStr: elementIdxStr.ToString(),
  Indexers: indexers);
  }
+ }
+
+ private async Task<JObject> InvokeGetItemOnJObject(
+ JObject rootObject,
+ int typeId,
+ DotnetObjectId objectId,
+ ElementIndexInfo elementIdxInfo,
+ CancellationToken token)
+ {
+ int[] methodIds = await context.SdbAgent.GetMethodIdsByName(typeId, "get_Item", BindingFlags.Default, token);
+ if (methodIds == null || methodIds.Length == 0)
+ throw new InvalidOperationException($"Type '{rootObject?["className"]?.Value<string>()}' cannot be indexed.");
+ var type = rootObject?["type"]?.Value<string>();
+
+ // ToDo: optimize the loop by choosing the right method at once without trying out them all
+ for (int i = 0; i < methodIds.Length; i++)
+ {
+ MethodInfoWithDebugInformation methodInfo = await context.SdbAgent.GetMethodInfo(methodIds[i], token);
+ ParameterInfo[] paramInfo = methodInfo.GetParametersInfo();
+ if (paramInfo.Length != elementIdxInfo.DimensionsCount)
+ continue;
+ try
+ {
+ if (!CheckParametersCompatibility(paramInfo, elementIdxInfo.Indexers))
+ continue;
+ ArraySegment<byte> buffer = await WriteIndexObjectAsIndices(objectId, elementIdxInfo.Indexers, paramInfo);
+ JObject getItemRetObj = await context.SdbAgent.InvokeMethod(buffer, methodIds[i], token);
+ return (JObject)getItemRetObj["value"];
+ }
+ catch (Exception ex)
+ {
+ logger.LogDebug($"Attempt number {i + 1} out of {methodIds.Length} of invoking method {methodInfo.Name} with parameter named {paramInfo[0].Name} on type {type} failed. Method Id = {methodIds[i]}.\nInner exception: {ex}.");
+ continue;
+ }
+ }
+ return null;
 
  async Task<ArraySegment<byte>> WriteIndexObjectAsIndices(DotnetObjectId rootObjId, List<object> indexObjects, ParameterInfo[] paramInfo)
  {
@@ -578,19 +597,47 @@ private static bool CheckParametersCompatibility(ParameterInfo[] paramInfos, Lis
  return false;
  foreach ((ParameterInfo paramInfo, object indexObj) in paramInfos.Zip(indexObjects))
  {
- // shouldn't we check LiteralExpressionSyntax for compatibility as well?
- if (indexObj is JObject indexJObj && !CheckParameterCompatibility(paramInfo.TypeCode, indexJObj))
+ string argumentType = "", argumentClassName = "";
+ if (indexObj is JObject indexJObj)
+ {
+ argumentType = indexJObj["type"]?.Value<string>();
+ argumentClassName = indexJObj["className"]?.Value<string>();
+ }
+ else if (indexObj is LiteralExpressionSyntax literal)
+ {
+ // any primitive literal is an object
+ if (paramInfo.TypeCode.Value == ElementType.Object)
+ continue;
+ switch (literal.Kind())
+ {
+ case SyntaxKind.NumericLiteralExpression:
+ argumentType = "number";
+ break;
+ case SyntaxKind.StringLiteralExpression:
+ argumentType = "string";
+ break;
+ case SyntaxKind.TrueLiteralExpression:
+ case SyntaxKind.FalseLiteralExpression:
+ argumentType = "boolean";
+ break;
+ case SyntaxKind.CharacterLiteralExpression:
+ argumentType = "symbol";
+ break;
+ case SyntaxKind.NullLiteralExpression:
+ // do not check
+ continue;
+ }
+ }
+ if (!CheckParameterCompatibility(paramInfo.TypeCode, argumentType, argumentClassName))
  return false;
  }
  return true;
  }
 
- private static bool CheckParameterCompatibility(ElementType? paramTypeCode, JObject value)
+ private static bool CheckParameterCompatibility(ElementType? paramTypeCode, string argumentType, string argumentClassName="")
  {
  if (!paramTypeCode.HasValue)
  return true;
- var argumentType = value["type"]?.Value<string>();
- var argumentClassName = value["className"]?.Value<string>();
 
  switch (paramTypeCode.Value)
  {
@@ -624,6 +671,8 @@ private static bool CheckParameterCompatibility(ElementType? paramTypeCode, JObj
  return false;
  if (argumentType == "object")
  return false;
+ if (argumentType == "string" || argumentType == "symbol")
+ return false;
  break;
  case ElementType.String:
  if (argumentType != "string")

src/mono/wasm/debugger/BrowserDebugProxy/MonoSDBHelper.cs

@@ -905,7 +905,7 @@ internal sealed partial class MonoSDBHelper
 
  private static int debuggerObjectId;
  private static int cmdId = 1; //cmdId == 0 is used by events which come from runtime
- private const int MINOR_VERSION = 65;
+ private const int MINOR_VERSION = 66;
  private const int MAJOR_VERSION = 2;
 
  private int VmMinorVersion { get; set; }

src/mono/wasm/debugger/DebuggerTestSuite/ArrayTests.cs

@@ -684,7 +684,7 @@ public async Task InspectInlineArray(string varName)
  $"'[debugger-test] DebuggerTests.InlineArray:run'" +
  "); }, 1);";
 
- var pause_location = await EvaluateAndCheck(eval_expr, debugger_test_loc, 441, 12, "DebuggerTests.InlineArray.run");
+ var pause_location = await EvaluateAndCheck(eval_expr, debugger_test_loc, 442, 12, "DebuggerTests.InlineArray.run");
  var id = pause_location["callFrames"][0]["callFrameId"].Value<string>();
  await EvaluateOnCallFrameAndCheck(id,
  ($"{varName}[0]", TObject("DebuggerTests.InlineArray.E")),
@@ -714,6 +714,7 @@ await EvaluateOnCallFrameAndCheck(id,
  o = TObject("DebuggerTests.InlineArray.Two")
  }, "s_one_props#1");
  }
+
  [ConditionalFact(nameof(RunningOnChrome))]
  public async Task InspectInlineArray2()
  {
@@ -723,13 +724,14 @@ public async Task InspectInlineArray2()
  $"'[debugger-test] DebuggerTests.InlineArray:run2'" +
  "); }, 1);";
 
- var pause_location = await EvaluateAndCheck(eval_expr, debugger_test_loc, 459, 12, "DebuggerTests.InlineArray.run2");
+ var pause_location = await EvaluateAndCheck(eval_expr, debugger_test_loc, 460, 12, "DebuggerTests.InlineArray.run2");
  var id = pause_location["callFrames"][0]["callFrameId"].Value<string>();
  await EvaluateOnCallFrameAndCheck(id,
  ($"a2[0]", TNumber(1)),
  ($"a3[0]", TNumber(2)),
  ($"a4[0]", TObject("DebuggerTests.InlineArray.E")),
- ($"Arr4.myStaticField", TNumber(50))
+ ($"Arr4.myStaticField", TNumber(50)),
+ ($"a2.InlineMethod(1)", TNumber(101))
  );
 
  var (_, res) = await EvaluateOnCallFrame(id,$"a3[1]", expect_ok: false);

src/mono/wasm/debugger/DebuggerTestSuite/EvaluateOnCallFrame2Tests.cs

@@ -769,13 +769,32 @@ public async Task EvaluateObjectIndexingMultidimensional() => await CheckInspect
  var id = pause_location["callFrames"][0]["callFrameId"].Value<string>();
 
  await EvaluateOnCallFrameAndCheck(id,
- ("f[j, aDouble]", TNumber("3.34")), //only IdentifierNameSyntaxes
- ("f[1, aDouble]", TNumber("3.34")), //IdentifierNameSyntax with LiteralExpressionSyntax
- ("f[aChar, \"&\", longString]", TString("9-&-longString")),
- ("f[f.numArray[j], aDouble]", TNumber("4.34")), //ElementAccessExpressionSyntax
- ("f[f.numArray[j], f.numArray[0]]", TNumber("3")), //multiple ElementAccessExpressionSyntaxes
- ("f[f.numArray[f.numList[0]], f.numArray[i]]", TNumber("3")),
- ("f[f.numArray[f.numList[0]], f.numArray[f.numArray[i]]]", TNumber("4"))
+ ("c[j, aDouble]", TNumber("3.34")), //only IdentifierNameSyntaxes
+ ("c[1, aDouble]", TNumber("3.34")), //IdentifierNameSyntax with LiteralExpressionSyntax
+ ("c[aChar, \"&\", longString]", TString("9-&-longString")),
+ ("c[cc.numArray[j], aDouble]", TNumber("4.34")), //ElementAccessExpressionSyntax
+ ("c[cc.numArray[j], cc.numArray[0]]", TNumber("3")), //multiple ElementAccessExpressionSyntaxes
+ ("c[cc.numArray[cc.numList[0]], cc.numArray[i]]", TNumber("3")),
+ ("c[cc.numArray[cc.numList[0]], cc.numArray[cc.numArray[i]]]", TNumber("4"))
+ ); 
+ });
+
+ [Fact]
+ public async Task EvaluateValueTypeIndexingMultidimensional() => await CheckInspectLocalsAtBreakpointSite(
+ "DebuggerTests.EvaluateLocalsWithIndexingTests", "EvaluateLocals", 12, "DebuggerTests.EvaluateLocalsWithIndexingTests.EvaluateLocals",
+ "window.setTimeout(function() { invoke_static_method ('[debugger-test] DebuggerTests.EvaluateLocalsWithIndexingTests:EvaluateLocals'); })",
+ wait_for_event_fn: async (pause_location) =>
+ {
+ var id = pause_location["callFrames"][0]["callFrameId"].Value<string>();
+
+ await EvaluateOnCallFrameAndCheck(id,
+ ("s[j, aDouble]", TNumber("3.34")), //only IdentifierNameSyntaxes
+ ("s[1, aDouble]", TNumber("3.34")), //IdentifierNameSyntax with LiteralExpressionSyntax
+ ("s[aChar, \"&\", longString]", TString("9-&-longString")),
+ ("s[cc.numArray[j], aDouble]", TNumber("4.34")), //ElementAccessExpressionSyntax
+ ("s[cc.numArray[j], cc.numArray[0]]", TNumber("3")), //multiple ElementAccessExpressionSyntaxes
+ ("s[cc.numArray[cc.numList[0]], cc.numArray[i]]", TNumber("3")),
+ ("s[cc.numArray[cc.numList[0]], cc.numArray[cc.numArray[i]]]", TNumber("4"))
  ); 
  });