Escape strings in disassembly comments.

[ki.stfu]

Summary

Patch from [e-mail]

[ki.stfu]

Provide a test case for that please.

[ChuckR]

Added test for escaped characters in disassembly comments

[ki.stfu]

BTW, it will be fine if you merge the data-disassemble tests into 1. Can you do that?

[ChuckR]

Merge the new disassembly test into the original

[ki.stfu]

Lgtm

[ChuckR]

Can somebody please check this in?

[ki.stfu]

Rebase against ToT

[ChuckR]

Thank you.

test/tools/lldb-mi/data/TestMiData.py

def test_lldbmi_data_disassemble(self):
         self.runCmd("-data-evaluate-expression main")
         self.expect("\^done,value=\"0x[0-9a-f]+\"")
         addr = int(self.child.after.split("\"")[1], 16)
 
         # Test -data-disassemble: try to disassemble some address
         self.runCmd("-data-disassemble -s %#x -e %#x -- 0" % (addr, addr + 0x10))
         self.expect("\^done,asm_insns=\[{address=\"0x0*%x\",func-name=\"main\",offset=\"0\",size=\"[1-9]+\",inst=\".+?\"}," % addr)
 
+        # Run to hello_world
+        self.runCmd("-break-insert -f hello_world")
+        self.expect("\^done,bkpt={number=\"2\"")
+        self.runCmd("-exec-continue")
+        self.expect("\^running")
+        self.expect("\*stopped,reason=\"breakpoint-hit\"")
+
+        # Get an address for disassembling: use hello_world
+        self.runCmd("-data-evaluate-expression hello_world")
+        self.expect("\^done,value=\"0x[0-9a-f]+\"")
+        addr = int(self.child.after.split("\"")[1], 16)
+
+        # Test -data-disassemble: try to disassemble some address
+        self.runCmd("-data-disassemble -s %#x -e %#x -- 0" % (addr, addr + 0x10))
+
+        # This matches a line similar to:
+        # {address="0x0000000100000f18",func-name="hello_world()",offset="8",size="7",inst="leaq 0x65(%rip), %rdi; \"Hello, World!\\n\""},
+        # To match the escaped characters in the ouptut, we must use four backslashes per matches backslash
+        # See https://docs.python.org/2/howto/regex.html#the-backslash-plague
+        self.expect("{address=\"0x[0-9a-f]+\",func-name=\"hello_world\(\)\",offset=\"[0-9]+\",size=\"[0-9]+\",inst=\".+?; \\\\\"Hello, World!\\\\\\\\n\\\\\"\"},")
+
     @lldbmi_test
     @expectedFailureWindows("llvm.org/pr22274: need a pexpect replacement for windows")
     @skipIfFreeBSD # llvm.org/pr22411: Failure presumably due to known thread races
     @unittest2.skip("-data-evaluate-expression doesn't work on globals") #FIXME: the global case worked before refactoring
     def test_lldbmi_data_read_memory_bytes_global(self):
         """Test that -data-read-memory-bytes can access global buffers."""
 
         self.spawnLldbMi(args = None)

test/tools/lldb-mi/data/main.cpp

 //===-- main.cpp ------------------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
+#include <stdio.h>
+
 const char g_CharArray[] = "\x10\x11\x12\x13";
 static const char s_CharArray[] = "\x20\x21\x22\x23";
 
 void
 local_array_test_inner()
 {
     char array[] = { 0x01, 0x02, 0x03, 0x04 };
     char *first_element_ptr = &array[0];
     // BP_local_array_test_inner
     return;
 }
 
 void
 local_array_test()
 {
     char array[] = { 0x05, 0x06, 0x07, 0x08 };
     // BP_local_array_test
     local_array_test_inner();
     return;
 }
 
+void
+hello_world()
+{
+    printf("Hello, World!\n"); // BP_hello_world
+}
+
 int
 main(int argc, char const *argv[])
 { // FUNC_main
     local_array_test();
+    hello_world();
     return 0;
 }

tools/lldb-mi/MICmdCmdData.cpp

for (size_t i = 0; i < nInstructions; i++)
         const CMICmnMIValueResult miValueResult2("func-name", miValueConst2);
         miValueTuple.Add(miValueResult2);
         const CMICmnMIValueConst miValueConst3(CMIUtilString::Format("%lld", addrOffSet));
         const CMICmnMIValueResult miValueResult3("offset", miValueConst3);
         miValueTuple.Add(miValueResult3);
         const CMICmnMIValueConst miValueConst4(CMIUtilString::Format("%d", instrtSize));
         const CMICmnMIValueResult miValueResult4("size", miValueConst4);
         miValueTuple.Add(miValueResult4);
-        const CMICmnMIValueConst miValueConst5(CMIUtilString::Format("%s %s%s", pStrMnemonic, pStrOperands, strComment.c_str()));
+        const CMICmnMIValueConst miValueConst5(CMIUtilString::Format("%s %s%s", pStrMnemonic, pStrOperands, strComment.Escape(true).c_str()));
         const CMICmnMIValueResult miValueResult5("inst", miValueConst5);
         miValueTuple.Add(miValueResult5);
 
         if (nDisasmMode == 1)
         {
             lldb::SBLineEntry lineEntry = address.GetLineEntry();
             const MIuint nLine = lineEntry.GetLine();
             const MIchar *pFileName = lineEntry.GetFileSpec().GetFilename();