Include comments in LLDB-MI disassembly, and other MI changes

[EwanCrawford]

Summary

Hi everybody,

This patch includes the following three LLDB-MI changes:

1. Showing comments in disassembly code. The comments included in LLDB disassembly after the semi-colon are currently missing in MI, e.g.
   
   ^done,asm_insns=[...,{address="0x00000000004004ff",func-name="main",offset="18",size="2",inst="jmp 0x40050b ; <+30> at main.c:7"}]
   
   instead of
   
   ^done,asm_insns=[...,{address="0x00000000004004ff",func-name="main",offset="18",size="2",inst="jmp 0x40050b"}]

2. Improved logging. Moves log file to temp directory from current directory. Change log file name to reflect the time & date the log was taken on.

3. Support for '-var-create $regname' -var-create $regname is currently processed using expression evaluation, meaning the variable binds to the result of the expression not the register. Therefore any subsequent calls to -var-assign will not update the register. Fixed by detecting '$' prefix for registers.

Thanks,
Ewan

[ki.stfu]

Create a separate review for each of these changes and take into account the following comments please:

tools/lldb-mi/MICmdCmdData.cpp

413–419

minor fix:

const MIchar *pStrComment = instrt.GetComment(sbTarget);
CMIUtilString strComment;
if (pStrComment != nullptr && *pStrComment != '\0')
    strComment = CMIUtilString::Format("\t\t; %s", pStrComment);

442

const CMICmnMIValueConst miValueConst5(CMIUtilString::Format("%s %s%s", pStrMnemonic, pStrOperands, strComment.c_str()))

tools/lldb-mi/MICmdCmdVar.cpp

182–186

if (rStrExpression[0] == '$')
{
    const CMIUtilString rStrRegister(rStrExpression.substr(1).c_str());
    value = frame.FindRegister(rStrRegister.c_str());
}

tools/lldb-mi/MICmnLogMediumFile.cpp

30

why? add any ext back, please.

tools/lldb-mi/MIUtilDateTimeStd.cpp

85–88

std::time(&m_rawTime);
const std::tm *pTi = std::localtime(&m_rawTime);
const CMIUtilString strTime(CMIUtilString::Format("%d-%02d-%02d--%02d-%02d-%02d", pTi->tm_year + 1900, pTi->tm_mon,
                                                  pTi->tm_mday, pTi->tm_hour, pTi->tm_min, pTi->tm_sec));

tools/lldb-mi/MIUtilSystemLinux.cpp

107

Does it work on Windows?

tools/lldb-mi/MIUtilSystemWindows.cpp

139

Use dynamic memory

[EwanCrawford]

Thanks for the comments ki.stfu, I'll go ahead and split the patch up.

tools/lldb-mi/MICmdCmdData.cpp

         lldb::SBInstruction instrt = instructions.GetInstructionAtIndex(i);
         const MIchar *pStrMnemonic = instrt.GetMnemonic(sbTarget);
         pStrMnemonic = (pStrMnemonic != nullptr) ? pStrMnemonic : pUnknown;
+        const MIchar *pStrComment = instrt.GetComment(sbTarget);
+        pStrComment = (pStrComment != nullptr) ? pStrComment : "";
+        CMIUtilString strComment("");
+        if(*pStrComment != '\0')
+        {
+            strComment = CMIUtilString::Format("\t\t; %s",pStrComment);
+        }
         lldb::SBAddress address = instrt.GetAddress();
         lldb::addr_t addr = address.GetLoadAddress(sbTarget);
         const MIchar *pFnName = address.GetFunction().GetName();

         const CMICmnMIValueConst miValueConst4(CMIUtilString::Format("%d", instrtSize));
         const CMICmnMIValueResult miValueResult4("size", miValueConst4);
         miValueTuple.Add(miValueResult4);
-        const CMICmnMIValueConst miValueConst5(CMIUtilString::Format("%s %s", pStrMnemonic, pStrOperands));
+        const CMICmnMIValueConst miValueConst5(CMIUtilString::Format("%s %s%s", pStrMnemonic, pStrOperands,strComment.c_str()));
         const CMICmnMIValueResult miValueResult5("inst", miValueConst5);
         miValueTuple.Add(miValueResult5);
 

tools/lldb-mi/MICmdCmdVar.cpp

     lldb::SBThread thread = (nThreadId != UINT64_MAX) ? sbProcess.GetThreadByIndexID(nThreadId) : sbProcess.GetSelectedThread();
     m_nThreadId = thread.GetIndexID();
     lldb::SBFrame frame = bCurrentFrame ? thread.GetSelectedFrame() : thread.GetFrameAtIndex(nFrame);
+    lldb::SBValue value;
 
-    const bool bArgs = true;
-    const bool bLocals = true;
-    const bool bStatics = true;
-    const bool bInScopeOnly = false;
-    const lldb::SBValueList valueList = frame.GetVariables(bArgs, bLocals, bStatics, bInScopeOnly);
-    lldb::SBValue value = valueList.GetFirstValueByName(rStrExpression.c_str());
+    if(rStrExpression[0] == '$')
+    {
+        CMIUtilString rStrRegister(rStrExpression.substr(1,std::string::npos).c_str());
+        value = frame.FindRegister(rStrRegister.c_str());
+    }
+    else
+    {
+        const bool bArgs = true;
+        const bool bLocals = true;
+        const bool bStatics = true;
+        const bool bInScopeOnly = false;
+        const lldb::SBValueList valueList = frame.GetVariables(bArgs, bLocals, bStatics, bInScopeOnly);
+        value = valueList.GetFirstValueByName(rStrExpression.c_str());
+    }
+
     if (!value.IsValid())
         value = frame.EvaluateExpression(rStrExpression.c_str());
 

tools/lldb-mi/MICmnLogMediumFile.cpp

 //--
 CMICmnLogMediumFile::CMICmnLogMediumFile(void)
     : m_constThisMediumName(MIRSRC(IDS_MEDIUMFILE_NAME))
-    , m_constMediumFileName("lldb-mi-log.txt")
+    , m_constMediumFileName("lldb-mi-log")
     , m_fileNamePath(MIRSRC(IDS_MEDIUMFILE_ERR_INVALID_PATH))
     , m_eVerbosityType(CMICmnLog::eLogVerbosity_Log)
     , m_strDate(CMIUtilDateTimeStd().GetDate())

 
     m_fileNamePath = MIRSRC(IDS_MEDIUMFILE_ERR_INVALID_PATH);
 
-    CMIUtilString strPathName;
-    if (CMIUtilSystem().GetLogFilesPath(strPathName))
+    CMIUtilString strPath;
+    if (CMIUtilSystem().GetLogFilesPath(strPath))
     {
-        const CMIUtilString strPath = CMIUtilFileStd::StripOffFileName(strPathName);
+        CMIUtilDateTimeStd date;
 
-// ToDo: Review this LINUX log file quick fix so not hidden
-// AD:
-//      Linux was creating a log file here called '.\log.txt'.  The '.' on linux
-//      signifies that this file is 'hidden' and not normally visible.  A quick fix
-//      is to remove the path component all together.  Linux also normally uses '/'
-//      as directory separators, again leading to the problem of the hidden log.
 #if defined(_MSC_VER)
-        m_fileNamePath = CMIUtilString::Format("%s\\%s", strPath.c_str(), m_constMediumFileName.c_str());
+        m_fileNamePath = CMIUtilString::Format("%s\\%s--%s.txt", strPath.c_str(), m_constMediumFileName.c_str(), date.GetDateTimeLogFilename().c_str());
 #else
-        m_fileNamePath = CMIUtilString::Format("%s", m_constMediumFileName.c_str());
+        m_fileNamePath = CMIUtilString::Format( "%s/%s--%s.txt", strPath.c_str(), m_constMediumFileName.c_str(), date.GetDateTimeLogFilename().c_str());
 #endif // defined ( _MSC_VER )
 
         return MIstatus::success;

tools/lldb-mi/MIUtilDateTimeStd.h

 
     CMIUtilString GetDate(void);
     CMIUtilString GetTime(void);
+    CMIUtilString GetDateTimeLogFilename(void);
 
     // Overrideable:
   public:

tools/lldb-mi/MIUtilDateTimeStd.cpp

 
     return strTime;
 }
+
+//++ ------------------------------------------------------------------------------------
+// Details: Retrieve system local current date and time in yyyy-MM-dd--HH-mm-ss format for log file names.
+// Type:    Method.
+// Args:    None.
+// Return:  CMIUtilString - Text description.
+// Throws:  None.
+//--
+CMIUtilString
+CMIUtilDateTimeStd::GetDateTimeLogFilename(void)
+{
+    std::time( &m_rawTime );
+    const std::tm * pTi = std::localtime(&m_rawTime);
+    const CMIUtilString strTime(CMIUtilString::Format("%d-%02d-%02d--%02d-%02d-%02d", pTi->tm_year + 1900, pTi->tm_mon,
+                                                      pTi->tm_mday, pTi->tm_hour, pTi->tm_min, pTi->tm_sec));
+
+    return strTime;
+}

tools/lldb-mi/MIUtilSystemLinux.cpp

 bool
 CMIUtilSystemLinux::GetLogFilesPath(CMIUtilString &vrwFileNamePath) const
 {
-    vrwFileNamePath = CMIUtilString(".");
+    vrwFileNamePath = CMIUtilString(P_tmpdir);
     return MIstatus::success;
 }
 

tools/lldb-mi/MIUtilSystemWindows.cpp

 bool
 CMIUtilSystemWindows::GetLogFilesPath(CMIUtilString &vrwFileNamePath) const
 {
-    return GetExecutablesPath(vrwFileNamePath);
+    bool bOk = MIstatus::success;
+    char pPath[MAX_PATH];
+    const DWORD nLen = ::GetTempPath(MAX_PATH, &pPath[0]);
+    const CMIUtilString strLastErr(GetOSLastError());
+    if ((nLen != 0) && (strLastErr == "Unknown OS error"))
+        vrwFileNamePath = &pPath[0];
+    else
+    {
+        bOk = MIstatus::failure;
+        vrwFileNamePath = strLastErr;
+    }
+
+    return bOk;
 }
 
 #endif // #if defined( _MSC_VER )