Make data breakpoints sort of work

Works with CodeLLDB mostly for named things. Expressions don't seem to
be supported by anyone.

Fixed some state issues with the connections being retained across
restarts in watches. ugh. so messy.

Added access type question.

Author: puremourning

python3/vimspector/breakpoints.py

@@ -495,23 +495,21 @@ def _ClearServerBreakpointData( self, conn: DebugAdapterConnection ):
           if not bp[ 'server_bp' ]:
             del bp[ 'server_bp' ]
 
-
       # Clear all instruction breakpoints because they aren't truly portable
       # across sessions.
-      #
-      # TODO: It might be possible to re-resolve the address stored in the
-      # breakpoint, though this would only work in a limited way (as load
-      # addresses will frequently not be the same across runs)
-
 
-      def ShouldKeep( bp ):
+      def ShouldKeepInsBP( bp ):
         if not bp[ 'is_instruction_breakpoint' ]:
           return True
         if 'address' in bp and bp[ 'session_id' ] != conn.GetSessionId():
           return True
         return False
 
-      breakpoints[ : ] = [ bp for bp in breakpoints if ShouldKeep( bp ) ]
+      breakpoints[ : ] = [ bp for bp in breakpoints if ShouldKeepInsBP( bp ) ]
+
+    # Erase any data breakpoints for this connection too
+    self._data_breakponts[ : ] = [ bp for bp in self._data_breakponts
+                                   if bp[ 'conn' ] != conn.GetSessionId() ]
 
 
   def _CopyServerLineBreakpointProperties( self,
@@ -1001,12 +999,11 @@ def response_handler( conn, msg, bp_idxs = [] ):
       'supportsDataBreakpoints' ]:
       connection: DebugAdapterConnection
       for connection in self._connections:
-        bp_idxs = []
         breakpoints = []
         for bp in self._data_breakponts:
           if bp[ 'state' ] != 'ENABLED':
             continue
-          if bp[ 'conn' ] == connection.GetSessionId():
+          if bp[ 'conn' ] != connection.GetSessionId():
             continue
           if not bp[ 'info' ].get( 'dataId' ):
             continue
@@ -1015,18 +1012,16 @@ def response_handler( conn, msg, bp_idxs = [] ):
           data_bp.update( bp[ 'options' ] )
           data_bp[ 'dataId' ] = bp[ 'info' ][ 'dataId' ]
           breakpoints.append( data_bp )
-          bp_idxs.append( [ len( breakpoints ), bp ] )
 
         if breakpoints:
           self._awaiting_bp_responses += 1
           connection.DoRequest(
-            lambda msg, conn=connection, idxs=bp_idxs: response_handler(
-              conn,
-              msg,
-              idxs ),
+            lambda msg, conn=connection: response_handler( conn, msg ),
             {
               'command': 'setDataBreakpoints',
-              'arguments': breakpoints,
+              'arguments': {
+                'breakpoints': breakpoints,
+              },
             },
             failure_handler = response_received
           )

python3/vimspector/debug_session.py

@@ -998,19 +998,29 @@ def OnDisassemblyWindowScrolled( self, win_id ):
       self._disassemblyView.OnWindowScrolled( win_id )
 
 
-  @CurrentSession()
+  @ParentOnly()
   @IfConnected()
   def AddDataBreakpoint( self, opts, buf = None, line_num = None ):
-    def add_bp( breakpoint_info ):
+    # Use the parent session, because the _connection_ comes from the
+    # variable/watch result that is actually chosen
+
+    def add_bp( conn, breakpoint_info ):
       if breakpoint_info[ 'dataId' ] is None:
         utils.UserMessage(
-          "Can't set data breakpoint here: { breakpoint_info[ 'description' ] }"
+          f"Can't set data breakpoint here: {breakpoint_info[ 'description' ]}"
         )
         return
 
-      # TODO: Ask the user about the possible DataBreakpointAccessType's and add
-      # that in to opts here
-      self._breakpoints.AddDataBreakpoint( breakpoint_info[ 'dataId' ], opts )
+      access_types = breakpoint_info.get( 'accessTypes' )
+      if access_types and 'accessType' not in opts:
+        access_type = utils.SelectFromList( 'What type of access?',
+                                            access_types )
+        if access_type is not None:
+          opts[ 'accessType' ] = access_type
+
+      self._breakpoints.AddDataBreakpoint( conn,
+                                           breakpoint_info,
+                                           opts )
 
     self._variablesView.GetDataBreakpointInfo( add_bp, buf, line_num )
 

python3/vimspector/settings.py

@@ -91,6 +91,7 @@
       'delete': [ '<Del>' ],
       'set_value': [ '<C-CR>', '<leader><CR>' ],
       'read_memory': [ '<leader>m' ],
+      'add_data_breakpoint': [ '<F9>' ],
     },
     'stack_trace': {
       'expand_or_jump': [ '<CR>', '<2-LeftMouse>' ],

python3/vimspector/variables.py

@@ -19,7 +19,7 @@
 from functools import partial
 import typing
 
-from vimspector import utils, settings
+from vimspector import utils, settings, session_manager
 from vimspector.debug_adapter_connection import DebugAdapterConnection
 
 
@@ -67,7 +67,7 @@ def FrameID( self ):
     assert False
 
   @abc.abstractmethod
-  def EvaluateName( self ):
+  def Name( self ):
     assert False
 
   @abc.abstractmethod
@@ -78,6 +78,9 @@ def MemoryReference( self ):
   def HoverText( self ):
     return ""
 
+  def Update( self, connection ):
+    self.connection = connection
+
 
 class Scope( Expandable ):
   """Holds an expandable scope (a DAP scope dict), with expand/collapse state"""
@@ -94,10 +97,11 @@ def MemoryReference( self ):
   def FrameID( self ):
     return None
 
-  def EvaluateName( self ):
+  def Name( self ):
     return self.scope[ 'name' ]
 
-  def Update( self, scope ):
+  def Update( self, connection, scope ):
+    super().Update( connection )
     self.scope = scope
 
   def HoverText( self ):
@@ -125,10 +129,11 @@ def MemoryReference( self ):
   def FrameID( self ):
     return self.watch.expression.get( 'frameId' )
 
-  def EvaluateName( self ):
+  def Name( self ):
     return self.watch.expression.get( 'expression' )
 
-  def Update( self, result ):
+  def Update( self, connection, result ):
+    super().Update( connection )
     self.changed = False
     if self.result[ 'result' ] != result[ 'result' ]:
       self.changed = True
@@ -145,8 +150,8 @@ def HoverText( self ):
 
 
 class WatchFailure( WatchResult ):
-  def __init__( self, connection: DebugAdapterConnection, reason ):
-    super().__init__( connection, { 'result': reason } )
+  def __init__( self, connection: DebugAdapterConnection, watch, reason ):
+    super().__init__( connection, watch, { 'result': reason } )
     self.changed = True
 
 
@@ -170,10 +175,11 @@ def MemoryReference( self ):
   def FrameID( self ):
     return self.container.FrameID()
 
-  def EvaluateName( self ):
-    return self.variable.get( 'evaluateName', self.variable[ 'name' ] )
+  def Name( self ):
+    return self.variable[ 'name' ]
 
-  def Update( self, variable ):
+  def Update( self, connection, variable ):
+    super().Update( connection )
     self.changed = False
     if self.variable[ 'value' ] != variable[ 'value' ]:
       self.changed = True
@@ -201,6 +207,11 @@ def __init__( self, connection: DebugAdapterConnection, expression: dict ):
     self.result = None
 
   def SetCurrentFrame( self, connection, frame ):
+    if connection is None:
+      self.connection = None
+      self.result.connection = None
+      return
+
     if self.connection is None:
       self.connection = connection
     elif self.connection != connection:
@@ -253,6 +264,9 @@ def AddExpandMappings( mappings = None ):
   for mapping in utils.GetVimList( mappings, 'read_memory' ):
     vim.command( f'nnoremap <silent> <buffer> { mapping } '
                  ':<C-u>call vimspector#ReadMemory()<CR>' )
+  for mapping in utils.GetVimList( mappings, 'add_data_breakpoint' ):
+    vim.command( f'nnoremap <silent> <buffer> { mapping } '
+                 ':<C-u>call vimspector#AddDataBreakpoint()<CR>' )
 
 
 
@@ -348,7 +362,7 @@ def ConnectionClosed( self, connection ):
     ]
     for w in self._watches:
       if w.connection == connection:
-        w.connection = None
+        w.SetCurrentFrame( None, None )
 
 
   def Reset( self ):
@@ -388,7 +402,7 @@ def scopes_consumer( message ):
         if not found:
           scope = Scope( connection, scope_body )
         else:
-          scope.Update( scope_body )
+          scope.Update( connection, scope_body )
 
         new_scopes.append( scope )
 
@@ -459,9 +473,9 @@ def handler( message ):
 
       watch = self._variable_eval
       if watch.result is None or watch.result.connection != connection:
-        watch.result = WatchResult( connection, message[ 'body' ] )
+        watch.result = WatchResult( connection, watch, message[ 'body' ] )
       else:
-        watch.result.Update( message[ 'body' ] )
+        watch.result.Update( connection, message[ 'body' ] )
 
       popup_win_id = utils.CreateTooltip( [], is_hover )
       # record the global eval window id
@@ -566,10 +580,10 @@ def EvaluateWatches( self,
 
   def _UpdateWatchExpression( self, watch: Watch, message: dict ):
     if watch.result is not None:
-      watch.result.Update( message[ 'body' ] )
+      watch.result.Update( watch.connection, message[ 'body' ] )
     else:
       watch.result = WatchResult( watch.connection,
-                                  watch[ 'frameId' ],
+                                  watch,
                                   message[ 'body' ] )
 
     if ( watch.result.IsExpandable() and
@@ -590,7 +604,7 @@ def _WatchExpressionFailed( self, reason: str, watch: Watch ):
       # We already have a result for this watch. Wut ?
       return
 
-    watch.result = WatchFailure( watch.connection, reason )
+    watch.result = WatchFailure( watch.connection, watch, reason )
     self._DrawWatches()
 
   def _GetVariable( self, buf = None, line_num = None ):
@@ -682,7 +696,7 @@ def handler( message ):
           },
         } )
 
-      variable.Update( new_variable )
+      variable.Update( variable.connection, new_variable )
       view.draw()
 
     def failure_handler( reason, message ):
@@ -714,15 +728,17 @@ def GetDataBreakpointInfo( self,
     variable: Expandable
     view: View
 
-    if not self._server_capabilities.get( 'supportsDataBreakpoints' ):
-      return None
-
     variable, view = self._GetVariable( buf, line_num )
     if variable is None:
       return None
 
+    if not session_manager.Get().GetSession(
+      variable.connection.GetSessionId() )._server_capabilities.get(
+        'supportsDataBreakpoints' ):
+      return None
+
     arguments = {
-      'name': variable.EvaluateName()
+      'name': variable.Name()
     }
     frameId = variable.FrameID()
     if frameId:
@@ -732,7 +748,8 @@ def GetDataBreakpointInfo( self,
       arguments[ 'variablesReference' ] = (
         variable.container.VariablesReference() )
 
-    variable.connection.DoRequest( lambda msg: then( msg[ 'body' ] ), {
+    variable.connection.DoRequest( lambda msg: then( variable.connection,
+                                                     msg[ 'body' ] ), {
       'command': 'dataBreakpointInfo',
       'arguments': arguments,
     } )
@@ -886,7 +903,7 @@ def _ConsumeVariables( self, draw, parent, message ):
       if not found:
         variable = Variable( parent.connection, parent, variable_body )
       else:
-        variable.Update( variable_body )
+        variable.Update( parent.connection, variable_body )
 
       new_variables.append( variable )
 

support/test/cpp/simple_c_program/.vimspector.json

@@ -56,7 +56,7 @@
       "adapter": "vscode-cpptools",
       "variables": {
         "BUILDME": {
-          "shell": "g++ -o ${workspaceRoot}/test -g -std=c++17 ${workspaceRoot}/test_c.cpp"
+          "shell": "g++ -o ${workspaceRoot}/test -g -std=c++17 ${file}"
         },
         "arch": {
           "shell": "uname -m"
@@ -78,7 +78,7 @@
       "adapter": "vscode-cpptools",
       "variables": {
         "BUILDME": {
-          "shell": "g++ -o ${workspaceRoot}/test -g -std=c++17 ${workspaceRoot}/test_c.cpp"
+          "shell": "g++ -o ${workspaceRoot}/test -g -std=c++17 ${file}"
         }
       },
       "configuration": {

support/test/cpp/simple_c_program/memory.cpp

@@ -0,0 +1,24 @@
+struct Test
+{
+  int x;
+  int y;
+};
+
+int main( int argc , char ** argv )
+{
+  Test x[] = {
+    { 1, 2 },
+    { 3, 4 },
+    { 5, 6 },
+  };
+
+  Test y = { 7, 8 };
+
+  x[0].x += argc;
+  argv[ 0 ][ 0 ] = 'x' ;
+
+  y.x += **argv;
+  y.y += argc * **argv;
+
+  return argc;
+}

support/test/rust/vimspector_test/.vimspector.json

@@ -5,7 +5,8 @@
       "adapter": "CodeLLDB",
       "configuration": {
         "request": "launch",
-        "program": "${workspaceRoot}/target/debug/vimspector_test"
+        "program": "${workspaceRoot}/target/debug/vimspector_test",
+        "expressions": "native"
       }
     }
   }

support/test/rust/vimspector_test/src/main.rs

@@ -1,4 +1,18 @@
+struct Point {
+  x: i32,
+  y: i32,
+}
+
 fn main() {
   let s = "World!";
   println!("Hello, {}!", s);
+
+  let mut p = Point{ x: 1, y: 11 };
+
+  p.x = 11;
+  p.y = 11;
+  p.x += 11;
+  p.y += 11;
+
+  println!("Point: {}, {}", p.x, p.y);
 }