Add size field to library load event

[paulmaybee]

Summary

(This revision supersedes the abandon: http://reviews.llvm.org/D9716)
Size field is used to let the debugger attribute an address to a specific library when symbols are not available.
For example:
OpenGLESApp4.app!Cube_draw() Line 74 C

	OpenGLESApp4.app!-[GameViewController glkView:drawInRect:](GameViewController * self, SEL _cmd, GLKView * view, CGRect rect) Line 89	C++
	GLKit!<redacted>	
	QuartzCore!<redacted>	
	QuartzCore!<redacted>	
	QuartzCore!<redacted>	
	QuartzCore!<redacted>	
	QuartzCore!<redacted>	
	UIKit!<redacted>	
	UIKit!<redacted>	
	UIKit!<redacted>	
	UIKit!<redacted>	
	FrontBoardServices!<redacted>	
	CoreFoundation!<redacted>

[ki.stfu]

Why have you opened a new CL? Anyway, close/abandon the D9716 and see my inline comments.

test/tools/lldb-mi/TestMiLibraryLoaded.py

30

Add the size field here please.

31

As I said in D9716, it will cause a false negative if path contains symbols that should be escaped (" or \ etc). I faced with the same issue in MiSyntaxTestCase. You should use analogue of CMIUtilString::AddSlashes here, or pass exactly = True option.

tools/lldb-mi/MICmnLLDBDebuggerHandleEvents.cpp

731

ignore a return code here. It should cause a compiler error since r242911. Have you tried to compile it?

735

Does it work for you? O_O

Should be:

const CMIUtilString strSize(CMIUtilString::Format("%" PRIu64, sbSection.GetByteSize()));

738

ignore a return code

[ki.stfu]

BTW, update MIExtensions.txt file please.

[paulmaybee]

Escape paths in library-loaded event and fix test case.

[ki.stfu]

test/tools/lldb-mi/TestMiLibraryLoaded.py

31

It's still may cause a false negative, so let's do the following (more details in D9716):

def add_slashes(x): return x.replace("\\", "\\\\").replace("\"", "\\\"").replace("\'", "\\\'").replace("\0", "\\\0")
self.expect([
        "=library-loaded,id=\"%s\",target-name=\"%s\",host-name=\"%s\",symbols-loaded=\"1\",symbols-path=\"%s\",loaded_addr=\"-\",size=\"[0-9]+\"" % (add_slashes(path), add_slashes(path), add_slashes(path), add_slashes(symbols_path)),
        "=library-loaded,id=\"%s\",target-name=\"%s\",host-name=\"%s\",symbols-loaded=\"0\",loaded_addr=\"-\",size=\"[0-9]+\"" % (add_slashes(path), add_slashes(path), add_slashes(path))
    ])

tools/lldb-mi/MICmnLLDBDebuggerHandleEvents.cpp

691

Just use the AddSlashes here.

695

Just use the AddSlashes here.

701

Just use the AddSlashes here.

718

Just use the AddSlashes here.

[paulmaybee]

Add add_slashes to test case. Replace Escape with AddSlashes. Update extension doc.

[paulmaybee]

ping

test/tools/lldb-mi/TestMiLibraryLoaded.py

31

exactly = True is there?

tools/lldb-mi/MICmnLLDBDebuggerHandleEvents.cpp

731

Oops. Sorry, wrong diff. Fixed now.

[abidh]

I asked this question in the other revision too. Can you give a reason why this field is needed. The following description you gave in this revision does not make much sense to me. I am not opposed to adding this field but would like to know what problem it solves before it is committed.

"Size field is used to let the debugger attribute an address to a specific library when symbols are not available.
For example:
OpenGLESApp4.app!Cube_draw() Line 74 C"

[paulmaybee]

I'm not sure what the misunderstanding is, so I'll rephrase our desire. The VS debugger decorates code addresses with the name of the shared library from which the code originated (example above). We wish to use the load address and size of the shared library text for the purpose of determining the library name. Is there is some other way for us to get the lib name?

[abidh]

In D11574#219248, @paulmaybee wrote:

I'm not sure what the misunderstanding is, so I'll rephrase our desire. The VS debugger decorates code addresses with the name of the shared library from which the code originated (example above). We wish to use the load address and size of the shared library text for the purpose of determining the library name. Is there is some other way for us to get the lib name?

So what I understand is that you want to get the address range of the library so that you can decorate functions which lies within that range. Seems a valid use case to me. In the core lldb, you could use something like "target modules lookup" command for this purpose.

[paulmaybee]

Can you please check in in for me. Thanks.

[ki.stfu]

In D11574#220627, @paulmaybee wrote:

Can you please check in in for me. Thanks.

Ok, tomorrow.

test/tools/lldb-mi/TestMiLibraryLoaded.py

         symbols_path = os.path.join(path + ".dSYM", "Contents", "Resources", "DWARF", self.myexe)
         self.expect([
                 "=library-loaded,id=\"%s\",target-name=\"%s\",host-name=\"%s\",symbols-loaded=\"1\",symbols-path=\"%s\",loaded_addr=\"-\"" % (path, path, path, symbols_path),
-                "=library-loaded,id=\"%s\",target-name=\"%s\",host-name=\"%s\",symbols-loaded=\"0\",loaded_addr=\"-\"" % (path, path, path)
+                "=library-loaded,id=\"%s\",target-name=\"%s\",host-name=\"%s\",symbols-loaded=\"0\",loaded_addr=\"-\",size=\"[0-9]+\"" % (path, path, path)
             ], exactly = True)
 
 if __name__ == '__main__':

tools/lldb-mi/MICmnLLDBDebuggerHandleEvents.cpp

             vwrMiOutOfBandRecord.Add(miValueResult5);
         }
         // Build "loaded_addr" field
-        const lldb::SBAddress sbAddress(vModule.GetObjectFileHeaderAddress());
+        lldb::SBAddress sbAddress(vModule.GetObjectFileHeaderAddress());
         CMICmnLLDBDebugSessionInfo &rSessionInfo(CMICmnLLDBDebugSessionInfo::Instance());
         const lldb::addr_t nLoadAddress(sbAddress.GetLoadAddress(rSessionInfo.GetTarget()));
         const CMIUtilString strLoadedAddr(nLoadAddress != LLDB_INVALID_ADDRESS ?

         const CMICmnMIValueConst miValueConst6(strLoadedAddr);
         const CMICmnMIValueResult miValueResult6("loaded_addr", miValueConst6);
         vwrMiOutOfBandRecord.Add(miValueResult6);
+        bOk = bOk && vwrMiOutOfBandRecord.Add(miValueResult6);
+        
+        // Build "size" field
+        lldb::SBSection sbSection = sbAddress.GetSection();
+        const CMIUtilString strSize(CMIUtilString::Format("%PRIu64", sbSection.GetByteSize()));
+        const CMICmnMIValueConst miValueConst7(strSize);
+        const CMICmnMIValueResult miValueResult7("size", miValueConst7);
+        bOk = bOk && vwrMiOutOfBandRecord.Add(miValueResult7);
     }
 
     return bOk;