Move lldb/test to lldb/packages/Python/lldbsuite/test.

This is the conclusion of an effort to get LLDB's Python code
structured into a bona-fide Python package.  This has a number
of benefits, but most notably the ability to more easily share
Python code between different but related pieces of LLDB's Python
infrastructure (for example, `scripts` can now share code with
`test`).

llvm-svn: 251532

3 files changed, 226 insertions, 0 deletions

diff --git a/lldb/packages/Python/lldbsuite/test/functionalities/watchpoint/multiple_threads/Makefile b/lldb/packages/Python/lldbsuite/test/functionalities/watchpoint/multiple_threads/Makefile
new file mode 100644
index 00000000000..7fef897c059
--- /dev/null
+++ b/lldb/packages/Python/lldbsuite/test/functionalities/watchpoint/multiple_threads/Makefile
@@ -0,0 +1,6 @@
+LEVEL = ../../../make
+
+ENABLE_STD_THREADS := YES
+CXX_SOURCES := main.cpp
+
+include $(LEVEL)/Makefile.rules
diff --git a/lldb/packages/Python/lldbsuite/test/functionalities/watchpoint/multiple_threads/TestWatchpointMultipleThreads.py b/lldb/packages/Python/lldbsuite/test/functionalities/watchpoint/multiple_threads/TestWatchpointMultipleThreads.py
new file mode 100644
index 00000000000..b615fc77e21
--- /dev/null
+++ b/lldb/packages/Python/lldbsuite/test/functionalities/watchpoint/multiple_threads/TestWatchpointMultipleThreads.py
@@ -0,0 +1,137 @@
+"""
+Test that lldb watchpoint works for multiple threads.
+"""
+
+from __future__ import print_function
+
+import use_lldb_suite
+
+import os, time
+import re
+import lldb
+from lldbtest import *
+import lldbutil
+
+class WatchpointForMultipleThreadsTestCase(TestBase):
+
+    mydir = TestBase.compute_mydir(__file__)
+
+    @expectedFailureAndroid(archs=['arm', 'aarch64']) # Watchpoints not supported
+    @expectedFailureWindows("llvm.org/pr24446") # WINDOWS XFAIL TRIAGE - Watchpoints not supported on Windows
+    def test_watchpoint_multiple_threads(self):
+        """Test that lldb watchpoint works for multiple threads."""
+        self.build()
+        self.setTearDownCleanup()
+        self.hello_multiple_threads()
+
+    @expectedFailureAndroid(archs=['arm', 'aarch64']) # Watchpoints not supported
+    @expectedFailureWindows("llvm.org/pr24446") # WINDOWS XFAIL TRIAGE - Watchpoints not supported on Windows
+    def test_watchpoint_multiple_threads_wp_set_and_then_delete(self):
+        """Test that lldb watchpoint works for multiple threads, and after the watchpoint is deleted, the watchpoint event should no longer fires."""
+        self.build()
+        self.setTearDownCleanup()
+        self.hello_multiple_threads_wp_set_and_then_delete()
+
+    def setUp(self):
+        # Call super's setUp().
+        TestBase.setUp(self)
+        # Our simple source filename.
+        self.source = 'main.cpp'
+        # Find the line number to break inside main().
+        self.first_stop = line_number(self.source, '// Set break point at this line')
+
+    def hello_multiple_threads(self):
+        """Test that lldb watchpoint works for multiple threads."""
+        self.runCmd("file %s" % os.path.join(os.getcwd(), 'a.out'), CURRENT_EXECUTABLE_SET)
+
+        # Add a breakpoint to set a watchpoint when stopped on the breakpoint.
+        lldbutil.run_break_set_by_file_and_line (self, None, self.first_stop, num_expected_locations=1)
+
+        # Run the program.
+        self.runCmd("run", RUN_SUCCEEDED)
+
+        # We should be stopped again due to the breakpoint.
+        # The stop reason of the thread should be breakpoint.
+        self.expect("thread list", STOPPED_DUE_TO_BREAKPOINT,
+            substrs = ['stopped',
+                       'stop reason = breakpoint'])
+
+        # Now let's set a write-type watchpoint for variable 'g_val'.
+        # The main.cpp, by design, misbehaves by not following the agreed upon
+        # protocol of using a mutex while accessing the global pool and by not
+        # writing to the variable.
+        self.expect("watchpoint set variable -w write g_val", WATCHPOINT_CREATED,
+            substrs = ['Watchpoint created', 'size = 4', 'type = w'])
+
+        # Use the '-v' option to do verbose listing of the watchpoint.
+        # The hit count should be 0 initially.
+        self.expect("watchpoint list -v",
+            substrs = ['hit_count = 0'])
+
+        while True:
+            self.runCmd("process continue")
+
+            self.runCmd("thread list")
+            if "stop reason = watchpoint" in self.res.GetOutput():
+                # Good, we verified that the watchpoint works!
+                self.runCmd("thread backtrace all")
+                break
+            else:
+                self.fail("The stop reason should be either break or watchpoint")
+
+        # Use the '-v' option to do verbose listing of the watchpoint.
+        # The hit count should now be 1.
+        self.expect("watchpoint list -v",
+            substrs = ['hit_count = 1'])
+
+    def hello_multiple_threads_wp_set_and_then_delete(self):
+        """Test that lldb watchpoint works for multiple threads, and after the watchpoint is deleted, the watchpoint event should no longer fires."""
+        self.runCmd("file %s" % os.path.join(os.getcwd(), 'a.out'), CURRENT_EXECUTABLE_SET)
+
+        # Add a breakpoint to set a watchpoint when stopped on the breakpoint.
+        lldbutil.run_break_set_by_file_and_line (self, None, self.first_stop, num_expected_locations=1)
+
+        # Run the program.
+        self.runCmd("run", RUN_SUCCEEDED)
+
+        # We should be stopped again due to the breakpoint.
+        # The stop reason of the thread should be breakpoint.
+        self.expect("thread list", STOPPED_DUE_TO_BREAKPOINT,
+            substrs = ['stopped',
+                       'stop reason = breakpoint'])
+
+        # Now let's set a write-type watchpoint for variable 'g_val'.
+        # The main.cpp, by design, misbehaves by not following the agreed upon
+        # protocol of using a mutex while accessing the global pool and by not
+        # writing to the variable.
+        self.expect("watchpoint set variable -w write g_val", WATCHPOINT_CREATED,
+            substrs = ['Watchpoint created', 'size = 4', 'type = w'])
+
+        # Use the '-v' option to do verbose listing of the watchpoint.
+        # The hit count should be 0 initially.
+        self.expect("watchpoint list -v",
+            substrs = ['hit_count = 0'])
+
+        watchpoint_stops = 0
+        while True:
+            self.runCmd("process continue")
+            self.runCmd("process status")
+            if re.search("Process .* exited", self.res.GetOutput()):
+                # Great, we are done with this test!
+                break
+
+            self.runCmd("thread list")
+            if "stop reason = watchpoint" in self.res.GetOutput():
+                self.runCmd("thread backtrace all")
+                watchpoint_stops += 1
+                if watchpoint_stops > 1:
+                    self.fail("Watchpoint hits not supposed to exceed 1 by design!")
+                # Good, we verified that the watchpoint works!  Now delete the watchpoint.
+                if self.TraceOn():
+                    print("watchpoint_stops=%d at the moment we delete the watchpoint" % watchpoint_stops)
+                self.runCmd("watchpoint delete 1")
+                self.expect("watchpoint list -v",
+                    substrs = ['No watchpoints currently set.'])
+                continue
+            else:
+                self.fail("The stop reason should be either break or watchpoint")
diff --git a/lldb/packages/Python/lldbsuite/test/functionalities/watchpoint/multiple_threads/main.cpp b/lldb/packages/Python/lldbsuite/test/functionalities/watchpoint/multiple_threads/main.cpp
new file mode 100644
index 00000000000..8a31041f8fc
--- /dev/null
+++ b/lldb/packages/Python/lldbsuite/test/functionalities/watchpoint/multiple_threads/main.cpp
@@ -0,0 +1,83 @@
+//===-- 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 <chrono>
+#include <cstdio>
+#include <mutex>
+#include <random>
+#include <thread>
+
+std::default_random_engine g_random_engine{std::random_device{}()};
+std::uniform_int_distribution<> g_distribution{0, 3000000};
+
+uint32_t g_val = 0;
+
+
+uint32_t
+access_pool (bool flag = false)
+{
+    static std::mutex g_access_mutex;
+    if (!flag)
+        g_access_mutex.lock();
+
+    uint32_t old_val = g_val;
+    if (flag)
+    {
+        printf("changing g_val to %d...\n", old_val + 1);
+        g_val = old_val + 1;
+    }
+
+    if (!flag)
+        g_access_mutex.unlock();
+    return g_val;
+}
+
+void
+thread_func (uint32_t thread_index)
+{
+    // Break here in order to allow the thread
+    // to inherit the global watchpoint state.
+    printf ("%s (thread index = %u) startng...\n", __FUNCTION__, thread_index);
+
+    uint32_t count = 0;
+    uint32_t val;
+    while (count++ < 15)
+    {
+        // random micro second sleep from zero to 3 seconds
+        int usec = g_distribution(g_random_engine);
+        printf ("%s (thread = %u) doing a usleep (%d)...\n", __FUNCTION__, thread_index, usec);
+        std::this_thread::sleep_for(std::chrono::microseconds{usec});
+
+        if (count < 7)
+            val = access_pool ();
+        else
+            val = access_pool (true);
+
+        printf ("%s (thread = %u) after usleep access_pool returns %d (count=%d)...\n", __FUNCTION__, thread_index, val, count);
+    }
+    printf ("%s (thread index = %u) exiting...\n", __FUNCTION__, thread_index);
+}
+
+
+int main (int argc, char const *argv[])
+{
+    std::thread threads[3];
+
+    printf ("Before turning all three threads loose...\n"); // Set break point at this line,
+                                                            // in order to set our watchpoint.
+    // Create 3 threads
+    for (auto &thread : threads)
+        thread = std::thread{thread_func, std::distance(threads, &thread)};
+
+    // Join all of our threads
+    for (auto &thread : threads)
+        thread.join();
+
+    return 0;
+}