[lldb] Bump SWIG minimum version to 4

[JDevlieghere]

Summary

SWIG 4 was released in 2019 and has been the de-facto standard for a while now. All bots are running SWIG 4.0 or later.

Hans found out that after 662548c LLDB no longer work with SWIG 3 [1]. I'm not sure if the issue is specific to Windows or a particular SWIG 3 version, but I think it's a good time to bump the minimum requirements to SWIG 4.

[1] https://github.com/llvm/llvm-project/issues/64279

[bulbazord]

python.swig has a few checks for SWIG versions 3.0.9 and 3.0.10, those can be removed as well.

[JDevlieghere]

Remove check for SWIG 3.0.9-3.0.10 in python.swig.

[JDevlieghere]

Added the bot owners as reviewers for visibility.

[DavidSpickett]

We are on 4.01 (AArch64), 4.02 (Arm) and 4.1.1 (Windows on Arm), so we have no issues with this.

[JDevlieghere]

I didn't expect this to be controversial and I hear no objection so I'm going to go ahead and land this.

lldb/bindings/python/python.swig

 "try:
     # Try an absolute import first.  If we're being loaded from lldb,
     # _lldb should be a built-in module.
     import $module
 except ImportError:
     # Relative import should work if we are being loaded by Python.
     from . import $module"
 %enddef
-// These versions will not generate working python modules, so error out early.
-#if SWIG_VERSION >= 0x030009 && SWIG_VERSION < 0x030011
-#error Swig versions 3.0.9 and 3.0.10 are incompatible with lldb.
-#endif
 
 // The name of the module to be created.
 %module(docstring=DOCSTRING, moduleimport=MODULEIMPORT) lldb
 
 // Parameter types will be used in the autodoc string.
 %feature("autodoc", "1");
 
 %define ARRAYHELPER(type,name)

lldb/cmake/modules/FindLuaAndSwig.cmake

else()
   if (LLDB_ENABLE_SWIG)
     find_package(Lua 5.3 EXACT)
     if(LUA_FOUND)
       mark_as_advanced(
         LUA_LIBRARIES
         LUA_INCLUDE_DIR)
     endif()
   else()
-    message(STATUS "SWIG 3 or later is required for Lua support in LLDB but could not be found")
+    message(STATUS "SWIG 4 or later is required for Lua support in LLDB but could not be found")
   endif()
 
 
   include(FindPackageHandleStandardArgs)
   find_package_handle_standard_args(LuaAndSwig
                                     FOUND_VAR
                                       LUAANDSWIG_FOUND
                                     REQUIRED_VARS
                                       LUA_LIBRARIES
                                       LUA_INCLUDE_DIR
                                       LLDB_ENABLE_SWIG)
 endif()

lldb/cmake/modules/FindPythonAndSwig.cmake

 endmacro()
 
 if(Python3_LIBRARIES AND Python3_INCLUDE_DIRS AND Python3_EXECUTABLE AND LLDB_ENABLE_SWIG)
   set(PYTHONANDSWIG_FOUND TRUE)
 else()
   if (LLDB_ENABLE_SWIG)
     FindPython3()
   else()
-    message(STATUS "SWIG 3 or later is required for Python support in LLDB but could not be found")
+    message(STATUS "SWIG 4 or later is required for Python support in LLDB but could not be found")
   endif()
 
   get_property(MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
   if ("${Python3_VERSION}" VERSION_GREATER_EQUAL "3.7" AND
       "${SWIG_VERSION}" VERSION_LESS "4.0" AND WIN32 AND (
       ${MULTI_CONFIG} OR (uppercase_CMAKE_BUILD_TYPE STREQUAL "DEBUG")))
     # Technically this can happen with non-Windows builds too, but we are not
     # able to detect whether Python was built with assertions, and only Windows

lldb/cmake/modules/LLDBConfig.cmake

if(${find_package})
     endif()
     find_package(${package} ${ARG_VERSION} ${maybe_required} ${maybe_quiet})
     set(${variable} "${${found}}")
   endif()
 
   message(STATUS "${description}: ${${variable}}")
 endmacro()
 
-add_optional_dependency(LLDB_ENABLE_SWIG "Enable SWIG to generate LLDB bindings" SWIG SWIG_FOUND VERSION 3)
+add_optional_dependency(LLDB_ENABLE_SWIG "Enable SWIG to generate LLDB bindings" SWIG SWIG_FOUND VERSION 4)
 add_optional_dependency(LLDB_ENABLE_LIBEDIT "Enable editline support in LLDB" LibEdit LibEdit_FOUND)
 add_optional_dependency(LLDB_ENABLE_CURSES "Enable curses support in LLDB" CursesAndPanel CURSESANDPANEL_FOUND)
 add_optional_dependency(LLDB_ENABLE_LZMA "Enable LZMA compression support in LLDB" LibLZMA LIBLZMA_FOUND)
 add_optional_dependency(LLDB_ENABLE_LUA "Enable Lua scripting support in LLDB" LuaAndSwig LUAANDSWIG_FOUND)
 add_optional_dependency(LLDB_ENABLE_PYTHON "Enable Python scripting support in LLDB" PythonAndSwig PYTHONANDSWIG_FOUND)
 add_optional_dependency(LLDB_ENABLE_LIBXML2 "Enable Libxml 2 support in LLDB" LibXml2 LIBXML2_FOUND VERSION 2.8)
 add_optional_dependency(LLDB_ENABLE_FBSDVMCORE "Enable libfbsdvmcore support in LLDB" FBSDVMCore FBSDVMCore_FOUND QUIET)
 

lldb/docs/resources/build.rst

 
 * `CMake <https://cmake.org>`_
 * `Ninja <https://ninja-build.org>`_ (strongly recommended)
 
 If you want to run the test suite, you'll need to build LLDB with Python
 scripting support.
 
 * `Python <http://www.python.org/>`_
-* `SWIG <http://swig.org/>`_ 3 or later.
+* `SWIG <http://swig.org/>`_ 4 or later.
 
 Optional Dependencies
 *********************
 
 Although the following dependencies are optional, they have a big impact on
 LLDB's functionality. It is strongly encouraged to build LLDB with these
 dependencies enabled.
 

lldb/test/API/python_api/default-constructor/TestDefaultConstructorForAPIObjects.py

def test_SBDebugger(self):
         if self.TraceOn():
             print(obj)
         self.assertFalse(obj)
         # Do fuzz testing on the invalid obj, it should not crash lldb.
         import sb_debugger
 
         sb_debugger.fuzz_obj(obj)
 
-    # darwin: This test passes with swig 3.0.2, fails w/3.0.5 other tests fail
-    # with 2.0.12 http://llvm.org/pr23488
     def test_SBError(self):
         obj = lldb.SBError()
         if self.TraceOn():
             print(obj)
         self.assertFalse(obj)
         # Do fuzz testing on the invalid obj, it should not crash lldb.
         import sb_error
 
def test_SBListener(self):
         if self.TraceOn():
             print(obj)
         self.assertFalse(obj)
         # Do fuzz testing on the invalid obj, it should not crash lldb.
         import sb_listener
 
         sb_listener.fuzz_obj(obj)
 
-    # Py3 asserts due to a bug in SWIG.  Trying to upstream a patch to fix
-    # this in 3.0.8
-    @skipIf(py_version=[">=", (3, 0)], swig_version=["<", (3, 0, 8)])
     def test_SBModule(self):
         obj = lldb.SBModule()
         if self.TraceOn():
             print(obj)
         self.assertFalse(obj)
         # Do fuzz testing on the invalid obj, it should not crash lldb.
         import sb_module
 

lldb/test/API/python_api/lldbutil/TestSwigVersion.py

 
 class SwigVersionTestCase(TestBase):
     NO_DEBUG_INFO_TESTCASE = True
 
     def test(self):
         self.assertTrue(getattr(lldb, "swig_version"))
         self.assertIsInstance(lldb.swig_version, tuple)
         self.assertEqual(len(lldb.swig_version), 3)
-        self.assertGreaterEqual(lldb.swig_version[0], 1)
+        self.assertGreaterEqual(lldb.swig_version[0], 4)
         for v in lldb.swig_version:
             self.assertGreaterEqual(v, 0)

lldb/test/API/python_api/module_section/TestModuleAndSection.py

 """
 Test some SBModule and SBSection APIs.
 """
 
 import lldb
 from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test import lldbutil
 from lldbsuite.test.lldbutil import symbol_type_to_str
 
 
 class ModuleAndSectionAPIsTestCase(TestBase):
-    # Py3 asserts due to a bug in SWIG.  A fix for this was upstreamed into
-    # SWIG 3.0.8.
-    @skipIf(py_version=[">=", (3, 0)], swig_version=["<", (3, 0, 8)])
     def test_module_and_section(self):
         """Test module and section APIs."""
         self.build()
         exe = self.getBuildArtifact("a.out")
 
         target = self.dbg.CreateTarget(exe)
         self.assertTrue(target, VALID_TARGET)
         self.assertTrue(target.GetNumModules() > 0)

lldb/test/API/python_api/value/linked_list/TestValueAPILinkedList.py

class ValueAsLinkedListTestCase(TestBase):
     def setUp(self):
         # Call super's setUp().
         TestBase.setUp(self)
         # We'll use the test method name as the exe_name.
         self.exe_name = self.testMethodName
         # Find the line number to break at.
         self.line = line_number("main.cpp", "// Break at this line")
 
-    # Py3 asserts due to a bug in SWIG.  A fix for this was upstreamed into
-    # SWIG 3.0.8.
-    @skipIf(py_version=[">=", (3, 0)], swig_version=["<", (3, 0, 8)])
     def test(self):
         """Exercise SBValue API linked_list_iter."""
         d = {"EXE": self.exe_name}
         self.build(dictionary=d)
         self.setTearDownCleanup(dictionary=d)
         exe = self.getBuildArtifact(self.exe_name)
 
         # Create a target by the debugger.