Add -stack-info-frame command (MI)

[ki.stfu]

Summary

Add -stack-info-frame command + test.

All tests pass on OS X.

[abidh]

Apart from one comment, look ok.

tools/lldb-mi/MICmdCmdStack.h

80

I think we should not continue this practice of adding the name of the authors.

[emaste]

tools/lldb-mi/MICmdCmdStack.h

80

The Gotchas and Changes header entries are also atypical for LLDB.

Looking through tools/lldb-mi I see exactly one Changes entry that is not 'None`:

MICmnStreamStdin.h:38:// Changes: Factored out OS specific handling of reading stdin  - IOR 16/06/2014.

SVN is very good at tracking changes to these files; there's no need to try to do it manually as well.

I also see only four Gotchas that are not None, two of which are the same. I'd suggest we just avoid these in newly added code.

[ki.stfu]

Remove Gotchas/Authors/Changes sections from header

[clayborg]

Just a quick reminder you might want to use triple quotes instead of desensitizing every other character in the python test case code.

Looks good otherwise.

test/tools/lldb-mi/TestMiStack.py

204

Use triple quotes?

self.expect('''^error,msg="Command 'stack-info-frame'. Invalid process during debug session"''')

212

Triple quotes?

self.expect('''^done,bkpt={number="1"''')

219

triple quotes?

[ki.stfu]

In D7750#126758, @clayborg wrote:

Just a quick reminder you might want to use triple quotes instead of desensitizing every other character in the python test case code.

Looks good otherwise.

Ok. I'll remebmer. Thanks.

test/tools/lldb-mi/TestMiStack.py

def test_lldbmi_stack_info_depth(self):
         # Test stack depth
         self.runCmd("-stack-info-depth")
         self.expect("\^done,depth=\"[1-9]\"")
 
     @lldbmi_test
     @expectedFailureWindows("llvm.org/pr22274: need a pexpect replacement for windows")
     @skipIfFreeBSD # llvm.org/pr22411: Failure presumably due to known thread races
     @skipIfLinux # llvm.org/pr22411: Failure presumably due to known thread races
+    def test_lldbmi_stack_info_frame(self):
+        """Test that 'lldb-mi --interpreter' can show information about current frame."""
+
+        self.spawnLldbMi(args = None)
+
+        # Test that -stack-info-frame fails when program isn't running
+        self.runCmd("-stack-info-frame")
+        self.expect("\^error,msg=\"Command 'stack-info-frame'. Invalid process during debug session\"")
+
+        # Load executable
+        self.runCmd("-file-exec-and-symbols %s" % self.myexe)
+        self.expect("\^done")
+
+        # Run to main
+        self.runCmd("-break-insert -f main")
+        self.expect("\^done,bkpt={number=\"1\"")
+        self.runCmd("-exec-run")
+        self.expect("\^running")
+        self.expect("\*stopped,reason=\"breakpoint-hit\"")
+
+        # Test that -stack-info-frame works when program is running
+        self.runCmd("-stack-info-frame")
+        self.expect("\^done,frame=\{level=\"0\",addr=\".+\",func=\"main\",file=\"main\.c\",fullname=\".*main\.c\",line=\"\d+\"\}")
+
+    @lldbmi_test
+    @expectedFailureWindows("llvm.org/pr22274: need a pexpect replacement for windows")
+    @skipIfFreeBSD # llvm.org/pr22411: Failure presumably due to known thread races
+    @skipIfLinux # llvm.org/pr22411: Failure presumably due to known thread races
     def test_lldbmi_stack_list_frames(self):
         """Test that 'lldb-mi --interpreter' can lists the frames on the stack."""
 
         self.spawnLldbMi(args = None)
 
         # Load executable
         self.runCmd("-file-exec-and-symbols %s" % self.myexe)
         self.expect("\^done")

tools/lldb-mi/MICmdCmdStack.h

 //===-- MICmdCmdStack.h -----------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 //++
 // File:        MICmdCmdStack.h
 //
 // Overview:    CMICmdCmdStackInfoDepth         interface.
+//              CMICmdCmdStackInfoFrame         interface.
 //              CMICmdCmdStackListFrames        interface.
 //              CMICmdCmdStackListArguments     interface.
 //              CMICmdCmdStackListLocals        interface.
 //
 //              To implement new MI commands derive a new command class from the command base
 //              class. To enable the new command for interpretation add the new command class
 //              to the command factory. The files of relevance are:
 //                  MICmdCommands.cpp

 // Copyright:   None.
 //--
 
 #pragma once
 
 // In-house headers:
 #include "MICmdBase.h"
 #include "MICmnMIValueList.h"
+#include "MICmnMIValueTuple.h"
 
 //++ ============================================================================
 // Details: MI command class. MI commands derived from the command base class.
 //          *this class implements MI command "stack-info-depth".
 // Gotchas: None.
 // Authors: Illya Rudkin 21/03/2014.
 // Changes: None.
 //--
class CMICmdCmdStackInfoDepth : public CMICmdBase
   private:
     MIuint m_nThreadFrames;
     const CMIUtilString m_constStrArgThread;   // Not specified in MI spec but Eclipse gives this option
     const CMIUtilString m_constStrArgMaxDepth; // Not handled by *this command
 };
 
 //++ ============================================================================
 // Details: MI command class. MI commands derived from the command base class.
+//          *this class implements MI command "stack-info-frame".
+//--
+class CMICmdCmdStackInfoFrame : public CMICmdBase
+{
+    // Statics:
+  public:
+    // Required by the CMICmdFactory when registering *this command
+    static CMICmdBase *CreateSelf(void);
+
+    // Methods:
+  public:
+    /* ctor */ CMICmdCmdStackInfoFrame(void);
+
+    // Overridden:
+  public:
+    // From CMICmdInvoker::ICmd
+    virtual bool Execute(void);
+    virtual bool Acknowledge(void);
+    virtual bool ParseArgs(void);
+    // From CMICmnBase
+    /* dtor */ virtual ~CMICmdCmdStackInfoFrame(void);
+
+    // Attributes:
+  private:
+    CMICmnMIValueTuple m_miValueTuple;
+};
+
+//++ ============================================================================
+// Details: MI command class. MI commands derived from the command base class.
 //          *this class implements MI command "stack-list-frames".
 // Gotchas: None.
 // Authors: Illya Rudkin 21/03/2014.
 // Changes: None.
 //--
 class CMICmdCmdStackListFrames : public CMICmdBase
 {
     // Statics:

tools/lldb-mi/MICmdCmdStack.cpp

 //===-- MICmdCmdStack.cpp ---------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 //++
 // File:        MICmdCmdStack.cpp
 //
 // Overview:    CMICmdCmdStackInfoDepth         implementation.
+//              CMICmdCmdStackInfoFrame         implementation.
 //              CMICmdCmdStackListFrames        implementation.
 //              CMICmdCmdStackListArguments     implementation.
 //              CMICmdCmdStackListLocals        implementation.
 //
 // Environment: Compilers:  Visual C++ 12.
 //                          gcc (Ubuntu/Linaro 4.8.1-10ubuntu9) 4.8.1
 //              Libraries:  See MIReadmetxt.
 //
CMICmdCmdStackInfoDepth::CreateSelf(void)
     return new CMICmdCmdStackInfoDepth();
 }
 
 //---------------------------------------------------------------------------------------
 //---------------------------------------------------------------------------------------
 //---------------------------------------------------------------------------------------
 
 //++ ------------------------------------------------------------------------------------
+// Details: CMICmdCmdStackInfoFrame constructor.
+// Type:    Method.
+// Args:    None.
+// Return:  None.
+// Throws:  None.
+//--
+CMICmdCmdStackInfoFrame::CMICmdCmdStackInfoFrame(void)
+{
+    // Command factory matches this name with that received from the stdin stream
+    m_strMiCmd = "stack-info-frame";
+
+    // Required by the CMICmdFactory when registering *this command
+    m_pSelfCreatorFn = &CMICmdCmdStackInfoFrame::CreateSelf;
+}
+
+//++ ------------------------------------------------------------------------------------
+// Details: CMICmdCmdStackInfoFrame destructor.
+// Type:    Overrideable.
+// Args:    None.
+// Return:  None.
+// Throws:  None.
+//--
+CMICmdCmdStackInfoFrame::~CMICmdCmdStackInfoFrame(void)
+{
+}
+
+//++ ------------------------------------------------------------------------------------
+// Details: The invoker requires this function. The parses the command line options
+//          arguments to extract values for each of those arguments.
+// Type:    Overridden.
+// Args:    None.
+// Return:  MIstatus::success - Function succeeded.
+//          MIstatus::failure - Function failed.
+// Throws:  None.
+//--
+bool
+CMICmdCmdStackInfoFrame::ParseArgs(void)
+{
+    return ParseValidateCmdOptions();
+}
+
+//++ ------------------------------------------------------------------------------------
+// Details: The invoker requires this function. The command does work in this function.
+//          The command is likely to communicate with the LLDB SBDebugger in here.
+// Type:    Overridden.
+// Args:    None.
+// Return:  MIstatus::success - Function succeeded.
+//          MIstatus::failure - Function failed.
+// Throws:  None.
+//--
+bool
+CMICmdCmdStackInfoFrame::Execute(void)
+{
+    CMICmnLLDBDebugSessionInfo &rSessionInfo(CMICmnLLDBDebugSessionInfo::Instance());
+    lldb::SBProcess sbProcess = rSessionInfo.GetProcess();
+    if (!sbProcess.IsValid())
+    {
+        SetError(CMIUtilString::Format(MIRSRC(IDS_CMD_ERR_INVALID_PROCESS), m_cmdData.strMiCmd.c_str()));
+        return MIstatus::failure;
+    }
+
+    lldb::SBThread sbThread = sbProcess.GetSelectedThread();
+    MIuint nFrameId = sbThread.GetSelectedFrame().GetFrameID();
+    if (!rSessionInfo.MIResponseFormFrameInfo(sbThread, nFrameId, m_miValueTuple))
+         return MIstatus::failure;
+
+    return MIstatus::success;
+}
+
+//++ ------------------------------------------------------------------------------------
+// Details: The invoker requires this function. The command prepares a MI Record Result
+//          for the work carried out in the Execute().
+// Type:    Overridden.
+// Args:    None.
+// Return:  MIstatus::success - Function succeeded.
+//          MIstatus::failure - Function failed.
+// Throws:  None.
+//--
+bool
+CMICmdCmdStackInfoFrame::Acknowledge(void)
+{
+    const CMICmnMIValueResult miValueResult("frame", m_miValueTuple);
+    const CMICmnMIResultRecord miRecordResult(m_cmdData.strMiCmdToken, CMICmnMIResultRecord::eResultClass_Done, miValueResult);
+    m_miResultRecord = miRecordResult;
+
+    return MIstatus::success;
+}
+
+//++ ------------------------------------------------------------------------------------
+// Details: Required by the CMICmdFactory when registering *this command. The factory
+//          calls this function to create an instance of *this command.
+// Type:    Static method.
+// Args:    None.
+// Return:  CMICmdBase * - Pointer to a new command.
+// Throws:  None.
+//--
+CMICmdBase *
+CMICmdCmdStackInfoFrame::CreateSelf(void)
+{
+    return new CMICmdCmdStackInfoFrame();
+}
+
+//---------------------------------------------------------------------------------------
+//---------------------------------------------------------------------------------------
+//---------------------------------------------------------------------------------------
+
+//++ ------------------------------------------------------------------------------------
 // Details: CMICmdCmdStackListFrames constructor.
 // Type:    Method.
 // Args:    None.
 // Return:  None.
 // Throws:  None.
 //--
 CMICmdCmdStackListFrames::CMICmdCmdStackListFrames(void)
     : m_nThreadFrames(0)

tools/lldb-mi/MICmdCommands.cpp

MICmnCommands::RegisterAll(void)
     bOk &= Register<CMICmdCmdGdbInfo>();
     bOk &= Register<CMICmdCmdGdbSet>();
     bOk &= Register<CMICmdCmdGdbThread>();
     bOk &= Register<CMICmdCmdInferiorTtySet>();
     bOk &= Register<CMICmdCmdInterpreterExec>();
     bOk &= Register<CMICmdCmdListThreadGroups>();
     bOk &= Register<CMICmdCmdSource>();
     bOk &= Register<CMICmdCmdStackInfoDepth>();
+    bOk &= Register<CMICmdCmdStackInfoFrame>();
     bOk &= Register<CMICmdCmdStackListFrames>();
     bOk &= Register<CMICmdCmdStackListArguments>();
     bOk &= Register<CMICmdCmdStackListLocals>();
     bOk &= Register<CMICmdCmdSupportListFeatures>();
     bOk &= Register<CMICmdCmdTargetSelect>();
     bOk &= Register<CMICmdCmdThreadInfo>();
     bOk &= Register<CMICmdCmdVarAssign>();
     bOk &= Register<CMICmdCmdVarCreate>();