From 25c0a66934375dc7ef8a7d7c8b5e13d716ba6057 Mon Sep 17 00:00:00 2001
From: Dmitri Smirnov <yuslepukhin@users.noreply.github.com>
Date: Mon, 10 Oct 2022 10:06:55 -0700
Subject: [PATCH] Natvis adjustments to make debugging bearable (#13237)

### Description

- Fix Abseil::InlinedVector inlined storage visualization
- Fix typo in protobuf natvis.
- Add basic gsl.natvis


### Motivation and Context
Debugging is hard.
---
 cmake/external/abseil-cpp.natvis    | 28 +++++++++++++++++-----------
 cmake/external/gsl.natvis           | 14 ++++++++++++++
 cmake/external/onnx_protobuf.natvis |  2 +-
 cmake/onnxruntime_common.cmake      |  6 +++++-
 4 files changed, 37 insertions(+), 13 deletions(-)
 create mode 100644 cmake/external/gsl.natvis

diff --git a/cmake/external/abseil-cpp.natvis b/cmake/external/abseil-cpp.natvis
index c9f3a93f24..dd74a92bce 100644
--- a/cmake/external/abseil-cpp.natvis
+++ b/cmake/external/abseil-cpp.natvis
@@ -1,19 +1,25 @@
 <?xml version="1.0" encoding="utf-8"?>
 <AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
   <Type Name="absl::lts_20211102::InlinedVector&lt;*&gt;">
-    <DisplayString>{{ size={ storage_.metadata_.value >> 1 } }}</DisplayString>
+    <Intrinsic Name="_size" Expression="storage_.metadata_.value >> 1"/>
+    <Intrinsic Name="_is_allocated" Expression="(storage_.metadata_.value &amp; 1) == 1"/>
+    <Intrinsic Name="_inlined_data" Expression="($T1*)storage_.data_.inlined.inlined_data"/>
+    <Intrinsic Name="_allocated_data" Expression="storage_.data_.allocated.allocated_data"/>
+    <DisplayString>{{ size={ _size() }}}</DisplayString>
     <Expand>
-      <Item Name="[capacity]" ExcludeView="simple" Condition="(storage_.metadata_.value &amp; 1) == 0">$T2</Item>
-      <Item Name="[capacity]" ExcludeView="simple" Condition="(storage_.metadata_.value &amp; 1) == 1">storage_.data_.allocated.allocated_capacity</Item>
+      <Item Name="[capacity]" ExcludeView="simple" Condition="!_is_allocated()">$T2</Item>
+      <Item Name="[capacity]" ExcludeView="simple" Condition="_is_allocated()">storage_.data_.allocated.allocated_capacity</Item>
       <Item Name="[N]" ExcludeView="simple">$T2</Item>
-      <Item Name="[allocator]" ExcludeView="simple" Condition="(storage_.metadata_.value &amp; 1) == 1">storage_.metadata_</Item>
-      <IndexListItems Condition="(storage_.metadata_.value &amp; 1) == 0">
-        <Size>storage_.metadata_.value &gt;&gt; 1</Size>
-        <ValueNode>(($T1 &amp;)(storage_.data_.inlined.inlined_data[$i]))</ValueNode>
+      <Item Name="[size]" ExcludeView="simple">_size()</Item>
+      <Item Name="[is_allocated]" ExcludeView="simple">_is_allocated()</Item>
+      <Item Name="[allocator]" ExcludeView="simple" Condition="_is_allocated()">storage_.metadata_</Item>
+      <IndexListItems Condition="!_is_allocated()">
+        <Size>_size()</Size>
+        <ValueNode>_inlined_data()[$i]</ValueNode>
       </IndexListItems>
-      <IndexListItems Condition="(storage_.metadata_.value &amp; 1) == 1">
-        <Size>storage_.metadata_.value &gt;&gt; 1</Size>
-        <ValueNode>storage_.data_.allocated.allocated_data[$i]</ValueNode>
+      <IndexListItems Condition="_is_allocated()">
+        <Size>_size()</Size>
+        <ValueNode>_allocated_data()[$i]</ValueNode>
       </IndexListItems>
     </Expand>
   </Type>
@@ -45,4 +51,4 @@
       <Item Name="[value]" ExcludeView="simple">value.second</Item>
     </Expand>
   </Type>
-</AutoVisualizer>
\ No newline at end of file
+</AutoVisualizer>
diff --git a/cmake/external/gsl.natvis b/cmake/external/gsl.natvis
new file mode 100644
index 0000000000..5fbe9b9da1
--- /dev/null
+++ b/cmake/external/gsl.natvis
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
+  <Type Name="gsl::span&lt;*&gt;">
+    <Intrinsic Name="_size" Expression="(last_ - first_)"/>
+    <DisplayString>{{ size={ _size() }}}</DisplayString>
+    <Expand>
+      <Item Name="[size]" ExcludeView="simple">_size()</Item>
+      <IndexListItems Condition="_size() &gt; 0">
+        <Size>_size()</Size>
+        <ValueNode>first_[$i]</ValueNode>
+      </IndexListItems>
+    </Expand>
+  </Type>
+</AutoVisualizer>
diff --git a/cmake/external/onnx_protobuf.natvis b/cmake/external/onnx_protobuf.natvis
index ee32395d20..c0a6fec4db 100644
--- a/cmake/external/onnx_protobuf.natvis
+++ b/cmake/external/onnx_protobuf.natvis
@@ -192,7 +192,7 @@
   
   <Type Name="onnx::TypeProto_Sequence">
     <Intrinsic Name="_has_element_type" Expression="(_has_bits_.has_bits_[0] &amp; 0x00000001u) != 0"/>
-    <DisplayString Condition="has_element_type()">{{ elem_type={ *elem_type_ } }}</DisplayString>
+    <DisplayString Condition="_has_element_type()">{{ elem_type={ *elem_type_ } }}</DisplayString>
     <Expand>
       <Item Name="[elem_type]" Condition="_has_element_type()" ExcludeView="simple">elem_type_</Item>
       <Item Name="[has_element_type]" ExcludeView="simple">_has_element_type()</Item>
diff --git a/cmake/onnxruntime_common.cmake b/cmake/onnxruntime_common.cmake
index 5b383ce27b..a4426d6713 100644
--- a/cmake/onnxruntime_common.cmake
+++ b/cmake/onnxruntime_common.cmake
@@ -115,7 +115,11 @@ if(NOT onnxruntime_DISABLE_ABSEIL)
     set(ABSEIL_NATVIS_FILE "abseil-cpp.natvis")
     target_sources(
         onnxruntime_common
-        INTERFACE $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/external/${ABSEIL_NATVIS_FILE}>
+        INTERFACE $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/external/${ABSEIL_NATVIS_FILE}>)
+    set(GSL_NATVIS_FILE "gsl.natvis")
+    target_sources(
+        onnxruntime_common
+        INTERFACE $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/external/${GSL_NATVIS_FILE}>
     )
   endif()
 endif()