[lldb] move more things from python to cmake

[hhb]

Summary

Move the copy of six.py, lldb.py and macosx/heap

[davide]

What are you trying to accomplish here?

[mgorny]

I'm not sure if I like the usage of POST_BUILD stuff (it provides less control than separate targets) but overall this seems a good change. Replacing ~250 lines of reinventing the wheel with ~20 lines.

[labath]

In D69016#1710380, @davide wrote:

What are you trying to accomplish here?

I believe the goal is to delete the custom python script completely and rely on cmake to do this instead. Now that we no longer have two build systems to worry about, I think this is a very good idea and it simplifies the code a lot. I believe that at least @JDevlieghere was also in favour of this direction.

[hhb]

In D69016#1710466, @mgorny wrote:

I'm not sure if I like the usage of POST_BUILD stuff (it provides less control than separate targets) but overall this seems a good change. Replacing ~250 lines of reinventing the wheel with ~20 lines.

Agreed. After I move all the things to cmake, it will be a good idea to refactor POST_BUILD to separate targets. And make sure all file dependencies are correct. For now I want to keep the same semantic.

In D69016#1710716, @labath wrote:

In D69016#1710380, @davide wrote:

What are you trying to accomplish here?

I believe the goal is to delete the custom python script completely and rely on cmake to do this instead. Now that we no longer have two build systems to worry about, I think this is a very good idea and it simplifies the code a lot. I believe that at least @JDevlieghere was also in favour of this direction.

Besides that, I want to make sure cross compiling is correct. In the old python script, we only detect the build platform, and make decision based on that. That's obviously wrong for cross compiling...

lldb/CMakeLists.txt

if(LLDB_BUILD_FRAMEWORK)
     set(lldb_python_build_path "${liblldb_build_dir}/LLDB.framework/Resources/Python/lldb")
   else()
     set(lldb_python_build_path "${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/${LLDB_PYTHON_RELATIVE_PATH}/lldb")
   endif()
 
   # Add a Post-Build Event to copy over Python files and create the symlink
   # to liblldb.so for the Python API(hardlink on Windows).
   add_custom_target(finish_swig ALL
+    COMMAND ${CMAKE_COMMAND} -E make_directory ${lldb_python_build_path}
     COMMAND
       ${PYTHON_EXECUTABLE} ${LLDB_SOURCE_DIR}/scripts/finishSwigWrapperClasses.py
         --srcRoot=${LLDB_SOURCE_DIR}
         --targetDir=${liblldb_build_dir}
         --cfgBldDir=${lldb_scripts_dir}
         --prefix=${CMAKE_BINARY_DIR}
         --cmakeBuildConfiguration=${CMAKE_CFG_INTDIR}
         --lldbLibDir=lib${LLVM_LIBDIR_SUFFIX}
         --lldbPythonPath=${lldb_python_build_path}
         ${use_python_wrapper_from_src_dir}
         ${use_six_py_from_system}
     VERBATIM
     DEPENDS ${LLDB_SOURCE_DIR}/scripts/finishSwigWrapperClasses.py
     DEPENDS ${lldb_scripts_dir}/lldb.py
     COMMENT "Python script sym-linking LLDB Python API")
 
+  if(NOT LLDB_USE_SYSTEM_SIX)
+    add_custom_command(TARGET finish_swig POST_BUILD VERBATIM
+      COMMAND ${CMAKE_COMMAND} -E copy
+        "${LLDB_SOURCE_DIR}/third_party/Python/module/six/six.py"
+        "${lldb_python_build_path}/../six.py")
+  endif()
+
+  add_custom_command(TARGET finish_swig POST_BUILD VERBATIM
+    COMMAND ${CMAKE_COMMAND} -E copy
+      "${lldb_scripts_dir}/lldb.py"
+      "${lldb_python_build_path}/__init__.py")
+
+  if(APPLE)
+    SET(lldb_python_heap_dir "${lldb_python_build_path}/macosx/heap")
+    add_custom_command(TARGET finish_swig POST_BUILD VERBATIM
+      COMMAND ${CMAKE_COMMAND} -E make_directory ${lldb_python_heap_dir}
+      COMMAND ${CMAKE_COMMAND} -E copy
+        "${LLDB_SOURCE_DIR}/examples/darwin/heap_find/heap/heap_find.cpp"
+        "${LLDB_SOURCE_DIR}/examples/darwin/heap_find/heap/Makefile"
+        ${lldb_python_heap_dir})
+  endif()
+
   function(create_relative_symlink target dest_file output_dir output_name)
     get_filename_component(dest_file ${dest_file} ABSOLUTE)
     get_filename_component(output_dir ${output_dir} ABSOLUTE)
     file(RELATIVE_PATH rel_dest_file ${output_dir} ${dest_file})
     if(CMAKE_HOST_UNIX)
       set(LLVM_LINK_OR_COPY create_symlink)
     else()
       set(LLVM_LINK_OR_COPY copy)

lldb/scripts/Python/finishSwigPythonLLDB.py

 strErrMsgCreatePyPkgMissingSlash = "Parameter 3 fn create_py_pkg() missing slash"
 strErrMsgMkLinkExecute = "Command mklink failed: %s"
 strErrMsgMakeSymlink = "creating symbolic link"
 strErrMsgUnexpected = "Unexpected error: %s"
 strMsgCopySixPy = "Copying six.py from '%s' to '%s'"
 strErrMsgCopySixPyFailed = "Unable to copy '%s' to '%s'"
 
 
-def is_debug_interpreter():
-    return hasattr(sys, 'gettotalrefcount')
-
-#++---------------------------------------------------------------------------
-# Details:  Copy files needed by lldb/macosx/heap.py to build libheap.dylib.
-# Args:     vDictArgs               - (R) Program input parameters.
-#           vstrFrameworkPythonDir  - (R) Python framework directory.
-# Returns:  Bool - True = function success, False = failure.
-#           Str - Error description on task failure.
-# Throws:   None.
-#--
-
-
-def macosx_copy_file_for_heap(vDictArgs, vstrFrameworkPythonDir):
-    dbg = utilsDebug.CDebugFnVerbose(
-        "Python script macosx_copy_file_for_heap()")
-    bOk = True
-    strMsg = ""
-
-    eOSType = utilsOsType.determine_os_type()
-    if eOSType != utilsOsType.EnumOsType.Darwin:
-        return (bOk, strMsg)
-
-    strHeapDir = os.path.join(vstrFrameworkPythonDir, "macosx", "heap")
-    strHeapDir = os.path.normcase(strHeapDir)
-    if os.path.exists(strHeapDir) and os.path.isdir(strHeapDir):
-        return (bOk, strMsg)
-
-    os.makedirs(strHeapDir)
-
-    strRoot = os.path.normpath(vDictArgs["--srcRoot"])
-    strSrc = os.path.join(
-        strRoot,
-        "examples",
-        "darwin",
-        "heap_find",
-        "heap",
-        "heap_find.cpp")
-    shutil.copy(strSrc, strHeapDir)
-    strSrc = os.path.join(
-        strRoot,
-        "examples",
-        "darwin",
-        "heap_find",
-        "heap",
-        "Makefile")
-    shutil.copy(strSrc, strHeapDir)
-
-    return (bOk, strMsg)
-
 #++---------------------------------------------------------------------------
 # Details:  Create Python packages and Python __init__ files.
 # Args:     vDictArgs               - (R) Program input parameters.
 #           vstrFrameworkPythonDir  - (R) Python framework directory.
 #           vstrPkgDir              - (R) Destination for copied Python files.
 #           vListPkgFiles           - (R) List of source Python files.
 # Returns:  Bool - True = function success, False = failure.
 #           Str - Error description on task failure.
def create_py_pkg(
     if bDbg:
         print((strMsgCreatePyPkgInitFile % strPkgIniFile))
     file = open(strPkgIniFile, "w")
     file.write(strPyScript)
     file.close()
 
     return (bOk, strMsg)
 
-#++---------------------------------------------------------------------------
-# Details:  Copy the lldb.py file into the lldb package directory and rename
-#           to __init_.py.
-# Args:     vDictArgs               - (R) Program input parameters.
-#           vstrFrameworkPythonDir  - (R) Python framework directory.
-#           vstrCfgBldDir           - (R) Config directory path.
-# Returns:  Bool - True = function success, False = failure.
-#           Str - Error description on task failure.
-# Throws:   None.
-#--
-
-
-def copy_lldbpy_file_to_lldb_pkg_dir(
-        vDictArgs,
-        vstrFrameworkPythonDir,
-        vstrCfgBldDir):
-    dbg = utilsDebug.CDebugFnVerbose(
-        "Python script copy_lldbpy_file_to_lldb_pkg_dir()")
-    bOk = True
-    bDbg = "-d" in vDictArgs
-    strMsg = ""
-
-    strSrc = os.path.join(vstrCfgBldDir, "lldb.py")
-    strSrc = os.path.normcase(strSrc)
-    strDst = os.path.join(vstrFrameworkPythonDir, "__init__.py")
-    strDst = os.path.normcase(strDst)
-
-    if not os.path.exists(strSrc):
-        strMsg = strErrMsgLLDBPyFileNotNotFound % strSrc
-        return (bOk, strMsg)
-
-    try:
-        if bDbg:
-            print((strMsgCopyLLDBPy % (strSrc, strDst)))
-        shutil.copyfile(strSrc, strDst)
-    except IOError as e:
-        bOk = False
-        strMsg = "I/O error(%d): %s %s" % (e.errno,
-                                           e.strerror, strErrMsgCpLldbpy)
-        if e.errno == 2:
-            strMsg += " Src:'%s' Dst:'%s'" % (strSrc, strDst)
-    except:
-        bOk = False
-        strMsg = strErrMsgUnexpected % sys.exec_info()[0]
-
-    return (bOk, strMsg)
-
-
-def copy_six(vDictArgs, vstrFrameworkPythonDir):
-    dbg = utilsDebug.CDebugFnVerbose("Python script copy_six()")
-    bDbg = "-d" in vDictArgs
-    bOk = True
-    strMsg = ""
-    site_packages_dir = os.path.dirname(vstrFrameworkPythonDir)
-    six_module_filename = "six.py"
-    src_file = os.path.join(
-        vDictArgs['--srcRoot'],
-        "third_party",
-        "Python",
-        "module",
-        "six",
-        six_module_filename)
-    src_file = os.path.normpath(src_file)
-    target = os.path.join(site_packages_dir, six_module_filename)
-
-    if bDbg:
-        print((strMsgCopySixPy % (src_file, target)))
-    try:
-        shutil.copyfile(src_file, target)
-    except:
-        bOk = False
-        strMsg = strErrMsgCopySixPyFailed % (src_file, target)
-
-    return (bOk, strMsg)
-
-#++---------------------------------------------------------------------------
-# Details:  Look for the directory in which to put the Python files if it
-#           does not already exist, attempt to make it.
-# Args:     vDictArgs               - (R) Program input parameters.
-#           vstrFrameworkPythonDir  - (R) Python framework directory.
-# Returns:  Bool - True = function success, False = failure.
-#           Str - Error description on task failure.
-# Throws:   None.
-#--
-
-
-def find_or_create_python_dir(vDictArgs, vstrFrameworkPythonDir):
-    dbg = utilsDebug.CDebugFnVerbose(
-        "Python script find_or_create_python_dir()")
-    bOk = True
-    strMsg = ""
-    bDbg = "-d" in vDictArgs
-
-    if os.path.isdir(vstrFrameworkPythonDir):
-        if bDbg:
-            print((strMsgFrameWkPyExists % vstrFrameworkPythonDir))
-        return (bOk, strMsg)
-
-    if bDbg:
-        print((strMsgFrameWkPyMkDir % vstrFrameworkPythonDir))
-
-    try:
-        os.makedirs(vstrFrameworkPythonDir)
-    except OSError as exception:
-        bOk = False
-        strMsg = strErrMsgCreateFrmWkPyDirFailed % (
-            vstrFrameworkPythonDir, os.strerror(exception.errno))
-
-    return (bOk, strMsg)
-
-#++---------------------------------------------------------------------------
-# Details:  Retrieve the configuration build path if present and valid (using
-#           parameter --cfgBlddir or copy the Python Framework directory.
-# Args:     vDictArgs               - (R) Program input parameters.
-#           vstrFrameworkPythonDir  - (R) Python framework directory.
-# Returns:  Bool - True = function success, False = failure.
-#           Str - Config directory path.
-#           strErrMsg - Error description on task failure.
-# Throws:   None.
-#--
-
-
-def get_config_build_dir(vDictArgs, vstrFrameworkPythonDir):
-    dbg = utilsDebug.CDebugFnVerbose("Python script get_config_build_dir()")
-    bOk = True
-    strErrMsg = ""
-
-    strConfigBldDir = ""
-    bHaveConfigBldDir = "--cfgBldDir" in vDictArgs
-    if bHaveConfigBldDir:
-        strConfigBldDir = vDictArgs["--cfgBldDir"]
-    if (bHaveConfigBldDir == False) or (strConfigBldDir.__len__() == 0):
-        strConfigBldDir = vstrFrameworkPythonDir
-
-    return (bOk, strConfigBldDir, strErrMsg)
-
 
 #++---------------------------------------------------------------------------
 # Details:  Retrieve the directory path for Python's dist_packages/
 #           site_package folder depending on the type of OS platform being
 #           used.
 # Args:     vDictArgs   - (R) Program input parameters.
 # Returns:  Bool - True = function success, False = failure.
 #           Str - Python Framework directory path.
 #           strErrMsg - Error description on task failure.
 # Throws:   None.
 #--
 
 
 def get_framework_python_dir(vDictArgs):
     dbg = utilsDebug.CDebugFnVerbose(
         "Python script get_framework_python_dir()")
     bOk = True
     strErrMsg = ""
     strWkDir = os.path.normpath(vDictArgs["--lldbPythonPath"])
     return (bOk, strWkDir, strErrMsg)
 
-#++---------------------------------------------------------------------------
-# Details:  Retrieve the liblldb directory path, if it exists and is valid.
-# Args:     vDictArgs               - (R) Program input parameters.
-# Returns:  Bool - True = function success, False = failure.
-#           Str - liblldb directory path.
-#           strErrMsg - Error description on task failure.
-# Throws:   None.
-#--
-
-
-def get_liblldb_dir(vDictArgs):
-    dbg = utilsDebug.CDebugFnVerbose("Python script get_liblldb_dir()")
-    bOk = True
-    strErrMsg = ""
-
-    strLldbLibDir = ""
-    bHaveLldbLibDir = "--lldbLibDir" in vDictArgs
-    if bHaveLldbLibDir:
-        strLldbLibDir = vDictArgs["--lldbLibDir"]
-    if (bHaveLldbLibDir == False) or (strLldbLibDir.__len__() == 0):
-        strLldbLibDir = "lib"
-
-    return (bOk, strLldbLibDir, strErrMsg)
-
 #-----------------------------------------------------------------------------
 #-----------------------------------------------------------------------------
 #-----------------------------------------------------------------------------
 
 """ Details: Program main entry point fn. Called by another Python script.
 
     --------------------------------------------------------------------------
     Details: This script is to be called by another Python script. It is not
def main(vDictArgs):
     eOSType = utilsOsType.determine_os_type()
     if bDbg:
         pyVersion = sys.version_info
         print((strMsgOsVersion % utilsOsType.EnumOsType.name_of(eOSType)))
         print((strMsgPyVersion % (pyVersion[0], pyVersion[1])))
 
     bOk, strFrameworkPythonDir, strMsg = get_framework_python_dir(vDictArgs)
 
-    if bOk:
-        bOk, strCfgBldDir, strMsg = get_config_build_dir(
-            vDictArgs, strFrameworkPythonDir)
-    if bOk and bDbg:
-        print((strMsgPyFileLocatedHere % strFrameworkPythonDir))
-        print((strMsgConfigBuildDir % strCfgBldDir))
-
-    if bOk:
-        bOk, strLldbLibDir, strMsg = get_liblldb_dir(vDictArgs)
-
-    if bOk:
-        bOk, strMsg = find_or_create_python_dir(
-            vDictArgs, strFrameworkPythonDir)
-
-    bUseSystemSix = "--useSystemSix" in vDictArgs
-
-    if not bUseSystemSix and bOk:
-        bOk, strMsg = copy_six(vDictArgs, strFrameworkPythonDir)
-
-    if bOk:
-        bOk, strMsg = copy_lldbpy_file_to_lldb_pkg_dir(vDictArgs,
-                                                       strFrameworkPythonDir,
-                                                       strCfgBldDir)
     strRoot = os.path.normpath(vDictArgs["--srcRoot"])
     if bOk:
         # lldb
         listPkgFiles = [
             os.path.join(
                 strRoot,
                 "source",
                 "Interpreter",
if bOk and (eOSType == utilsOsType.EnumOsType.Darwin):
                 strRoot,
                 "examples",
                 "python",
                 "diagnose_nsstring.py")]
         bOk, strMsg = create_py_pkg(
             vDictArgs, strFrameworkPythonDir, "/diagnose", listPkgFiles)
 
     if bOk:
-        bOk, strMsg = macosx_copy_file_for_heap(
-            vDictArgs, strFrameworkPythonDir)
-
-    if bOk:
         return (0, strMsg)
     else:
         strErrMsgProgFail += strMsg
         return (-100, strErrMsgProgFail)
 
 
 #-----------------------------------------------------------------------------
 #-----------------------------------------------------------------------------
 #-----------------------------------------------------------------------------
 
 # This script can be called by another Python script by calling the main()
 # function directly
 if __name__ == "__main__":
     print("Script cannot be called directly, called by finishSwigWrapperClasses.py")