Working on API test migration

Author: Kevin Frei

lldb/packages/Python/lldbsuite/test/make/Makefile.rules

@@ -51,7 +51,7 @@ LLDB_BASE_DIR := $(THIS_FILE_DIR)/../../../../../
 #
 # GNUWin32 uname gives "windows32" or "server version windows32" while
 # some versions of MSYS uname return "MSYS_NT*", but most environments
-# standardize on "Windows_NT", so we'll make it consistent here. 
+# standardize on "Windows_NT", so we'll make it consistent here.
 # When running tests from Visual Studio, the environment variable isn't
 # inherited all the way down to the process spawned for make.
 #----------------------------------------------------------------------
@@ -210,6 +210,12 @@ else
 	ifeq "$(SPLIT_DEBUG_SYMBOLS)" "YES"
 		DSYM = $(EXE).debug
 	endif
+
+	ifeq "$(MERGE_DWOS)" "YES"
+		MAKE_DWO := YES
+		DWP_NAME = $(EXE).dwp
+		DYLIB_DWP_NAME = $(DYLIB_NAME).dwp
+	endif
 endif
 
 LIMIT_DEBUG_INFO_FLAGS =
@@ -357,6 +363,7 @@ ifneq "$(OS)" "Darwin"
 
 	OBJCOPY ?= $(call replace_cc_with,objcopy)
 	ARCHIVER ?= $(call replace_cc_with,ar)
+	DWP ?= $(call reaplce_cc_with,dwp)
 	override AR = $(ARCHIVER)
 endif
 
@@ -565,9 +572,16 @@ else
 endif
 else
 ifeq "$(SPLIT_DEBUG_SYMBOLS)" "YES"
+	ifneq "$(KEEP_FULL_DEBUG_BINARY)" "YES"
 	$(OBJCOPY) --only-keep-debug "$(EXE)" "$(DSYM)"
+	else
+	cp "$(EXE)" "$(DSYM)"
+	endif
 	$(OBJCOPY) --strip-debug --add-gnu-debuglink="$(DSYM)" "$(EXE)" "$(EXE)"
 endif
+ifeq "$(MERGE_DWOS)" "YES"
+	$(DWP) -o "$(DWP_FILE)" $(DWOS)
+endif
 endif
 
 #----------------------------------------------------------------------
@@ -610,9 +624,16 @@ endif
 else
 	$(LD) $(DYLIB_OBJECTS) $(LDFLAGS) -shared -o "$(DYLIB_FILENAME)"
 ifeq "$(SPLIT_DEBUG_SYMBOLS)" "YES"
+	ifneq "$(KEEP_FULL_DEBUG_BINARY)" "YES"
+	cp "$(DYLIB_FILENAME)" "$(DYLIB_FILENAME).debug"
+	else
 	$(OBJCOPY) --only-keep-debug "$(DYLIB_FILENAME)" "$(DYLIB_FILENAME).debug"
+	endif
 	$(OBJCOPY) --strip-debug --add-gnu-debuglink="$(DYLIB_FILENAME).debug" "$(DYLIB_FILENAME)" "$(DYLIB_FILENAME)"
 endif
+ifeq "$(MERGE_DWOS)" "YES"
+	$(DWP) -o $(DYLIB_DWP_FILE) $(DYLIB_DWOS)
+endif
 endif
 
 #----------------------------------------------------------------------

lldb/test/API/debuginfod/Makefile

@@ -0,0 +1,105 @@
+C_SOURCES := main.c
+CFLAGS_EXTRAS := -std=c99
+
+MAKE_DWO := YES
+SPLIT_DEBUG_SYMBOLS := YES
+KEEP_FULL_DEBUG_BINARY := YES
+MERGE_DWOS := YES
+
+# From shell, I can do this stuff pretty easily:
+# OBJCOPY --dump-section .note.gnu.build-id=<output.36.bytes.bin> <input.bin>
+# hexdump -s 16 -e '"%02x"' output.bin
+# Or this in a single command:
+# objcopy --dump-section=.note.gnu.build-id=/dev/stdout adfinder.stripped | xxd -s 16 -g 0 -p
+# I think I need to add capabilities in the Makefile.rules to strip the binary (not an -OKD binary)
+# and to create a DWP file
+
+include Makefile.rules
+
+
+#!/bin/sh
+
+# Testing 5 different scenarios:
+# 1 - A stripped binary with it's corresponding unstripped binary:
+# 2 - A stripped binary with a corresponding --only-keep-debug symbols file
+# 3 - A split binary with it's corresponding DWP file
+# 4 - A stripped, split binary with an unstripped binary and a DWP file
+# 5 - A stripped, split binary with an --only-keep-debug symbols file and a DWP file
+
+##mkdir -p gen
+##mkdir -p run
+
+# First, compile & link the binaries (normal and split)
+
+##${builddir}/bin/clang -g -o gen/bin-normal.o -O0 -c main.c
+##ld -nostdlib gen/bin-normal.o --build-id=sha1 -o gen/bin-normal
+##${builddir}/bin/clang -g -gsplit-dwarf -o gen/bin-split.o -O0 -c main.c
+##ld -nostdlib gen/bin-split.o --build-id=sha1 -o gen/bin-split
+
+# Next, create the file variations we need
+
+# Variation 1: -g, stripped
+##${builddir}/bin/llvm-objcopy --strip-debug gen/bin-normal gen/bin-stripped
+# Variation 2: -g, stripped, --only-keep-debug symbols
+##${builddir}/bin/llvm-objcopy --only-keep-debug gen/bin-normal gen/sym-stripped
+# Variation 3: -gsplit-dwarf: .dwp
+##${builddir}/bin/llvm-dwp -e gen/bin-split -o gen/bin-split.dwp
+# Variation 4: -gsplit-dwarf: stripped, .dwp
+##${builddir}/bin/llvm-objcopy --strip-debug gen/bin-split gen/bin-split-stripped
+# Variation 5: -gsplit-dwarf: stripped, --only-keep-debug + .dwp
+##${builddir}/bin/llvm-objcopy --only-keep-debug gen/bin-split gen/sym-split
+
+# Finally, produce the .yaml files for testing
+
+# Scenario 1:
+# target:  bin-stripped
+# Scenario 1a:
+# symbols: bin-normal (hosted as debuginfo)
+# Scenario 1b:
+# symbols: bin-normal (hosted as executable)
+##${builddir}/bin/obj2yaml gen/bin-stripped -o bin-stripped.yaml
+##${builddir}/bin/obj2yaml gen/bin-normal -o bin-normal.yaml
+# @ testing time: yaml2obj bin-stripped.yaml -o ${out}/bin-stripped
+# @ testing time: yaml2obj bin-normal.yaml -o ${out}/bin-normal
+
+
+# Scenario 2:
+# target:  bin-stripped-okd
+# Scenario 2a:
+# symbols: sym-stripped (hosted as debuginfo)
+# Scenario 2b:
+# symbols: sym-stripped (hosted as executable)
+##${builddir}/bin/obj2yaml gen/sym-stripped -o sym-stripped.yaml
+# To produce a correct .gnu.debuglink, you have to do it at test generation time.
+# The section includes a CRC that yaml2obj doesn't properly produce.
+# @ testing time: yaml2obj sym-stripped.yaml -o ${out}/sym-stripped
+# @ testing time: llvm-objcopy bin-stripped --add-gnu-debuglink=${out}/sym-stripped ${out}/bin-stripped-okd
+
+# Scenario 3:
+# target: bin-split
+# DWP:    bin-split.dwp (hosted as debuginfo)
+##${builddir}/bin/obj2yaml gen/bin-split -o bin-split.yaml
+##${builddir}/bin/obj2yaml gen/bin-split.dwp -o bin-split-dwp.yaml
+# @ testing time: yaml2obj bin-split.yaml -o ${out}/bin-split
+# @ testing time: yaml2obj bin-split-dwp.yaml -o ${out}/bin-split.dwp
+
+# Scenario 4:
+# target:  bin-split-stripped
+# symbols: bin-split (hosted as executable)
+# DWP      bin-split.dwp (hosted as debuginfo)
+# This doesn't work from a file system "as is".
+# I believe you can set the symbol file manually to the bin-split file.
+# TODO: Need to check for the -no-locator test to see what the name of
+# the .dwp is expected to be.
+##${builddir}/bin/obj2yaml gen/bin-split-stripped -o bin-split-stripped.yaml
+# bin-split and bin-split.dwp already generated in Scenario 3
+# @ testing time: yaml2obj bin-split-stripped.yaml -o ${out}/bin-split-stripped
+
+# Scenario 5:
+# target:  bin-split-stripped-okd
+# symbols: sym-split (hosted as executable)
+# DWP:     bin-split.dwp (hosted as debuginfo)
+##${builddir}/bin/obj2yaml gen/sym-split -o sym-split.yaml
+# @ testing time: yaml2obj main-split-nodbg.yaml -o gen/main-split-nodbg.tmp
+# @ testing time: yaml2obj main-split-dbg.yaml -o run/main-split-dbg
+# @ testing time: llvm-objcopy gen/main-split-nodbg.tmp --add-gnu-debuglink=run/main-split-dbg run/main-split-nodbg

lldb/test/API/debuginfod/TestSampleTest.py

@@ -0,0 +1,51 @@
+"""
+Describe the purpose of the test class here.
+"""
+
+
+import lldb
+import lldbsuite.test.lldbutil as lldbutil
+from lldbsuite.test.lldbtest import *
+
+
+class RenameThisSampleTestTestCase(TestBase):
+    # If your test case doesn't stress debug info, then
+    # set this to true.  That way it won't be run once for
+    # each debug info format.
+    NO_DEBUG_INFO_TESTCASE = True
+
+    def test_sample_rename_this(self):
+        """There can be many tests in a test case - describe this test here."""
+        self.build()
+        self.main_source_file = lldb.SBFileSpec("main.c")
+        self.sample_test()
+
+    def setUp(self):
+        # Call super's setUp().
+        TestBase.setUp(self)
+        # Set up your test case here. If your test doesn't need any set up then
+        # remove this method from your TestCase class.
+        # I need to setup the file-system-hosted Debuginfod server
+
+    def sample_test(self):
+        """You might use the test implementation in several ways, say so here."""
+
+        # This function starts a process, "a.out" by default, sets a source
+        # breakpoint, runs to it, and returns the thread, process & target.
+        # It optionally takes an SBLaunchOption argument if you want to pass
+        # arguments or environment variables.
+        (target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(
+            self, "Set a breakpoint here", self.main_source_file
+        )
+
+        frame = thread.GetFrameAtIndex(0)
+        test_var = frame.FindVariable("test_var")
+        self.assertSuccess(test_var.GetError(), "Failed to fetch test_var")
+        test_value = test_var.GetValueAsUnsigned()
+        self.assertEqual(test_value, 10, "Got the right value for test_var")
+
+    def sample_test_no_launch(self):
+        """Same as above but doesn't launch a process."""
+
+        target = self.createTestTarget()
+        self.expect_expr("global_test_var", result_value="10")

lldb/test/API/debuginfod/main.c

@@ -0,0 +1,9 @@
+// This is a dump little pair of test files
+
+int func(int argc, const char *argv[]) {
+  return (argc + 1) * (argv[argc][0] + 2);
+}
+
+int main(int argc, const char *argv[]) {
+  return func(0, argv);
+}

lldb/test/Shell/Debuginfod/Inputs/main.c

@@ -1,16 +1,10 @@
 // A script to (re)create the .yaml files is in 'make-inputs'. If you make changes
 // you'll need to update the .note.gnu.buildid values in the tests, as the cache names
 
-int func(int argc, const char **argv) { return (argc + 1) * (argv[argc][0] + 2); }
-
-__attribute__((force_align_arg_pointer)) void _start(void) {
-
-  /* main body of program: call main(), etc */
-
-  const char *argv[] = {""};
-  func(0, argv);
+int func(int argc, const char **argv) {
+  return (argc + 1) * (argv[argc][0] + 2);
+}
 
-  /* exit system call */
-  asm("mov $60,%rax; mov $0,%rdi; syscall");
-  __builtin_unreachable(); // tell the compiler to make sure side effects are done before the asm statement
+int main(int argc, const char *argv[]) {
+  return func(0, argv);
 }