[lldb] Creates _liblldb symlink from cmake

[hhb]

Summary

This is another attempt of D67993.

This change removed hard coded relative paths. This way we can generate correct result when get_python_lib() returns a different path, or LLDB_PYTHON_RELATIVE_PATH is specified directly.

By moving things out of python, we are also able to correctly process more cross compile situations. E.g. .pyd vs .so for Windows.

[hhb]

Fix format

[hhb]

Rebase

[hhb]

Remove tailing whitespace

[hhb]

Fix file copy path

[hhb]

Fix file copy path

[hhb]

Fix typo

[hhb]

Adds VERBATIM

[tatyana-krasnukha]

lldb/CMakeLists.txt

228

The problem is that for multi-configuration generators the current configuration cannot be evaluated at the configuring step i.e. you cannot just insert ${CMAKE_CFG_INTDIR} in the dest_file path and use it here. The variable should be expanded in the post-build command.

244

This command still produces a path without configuration name, Visual Studio failed to execute the post-build step.

[tatyana-krasnukha]

D68858d.diff3 KBDownload

@hhb, please, take a look. Slightly changed your patch to make it work for Visual Studio.

[hhb]

Fix the build for multi-config generator.

[hhb]

Oops fix typo.

[hhb]

lldb/CMakeLists.txt

244

Thanks for testing and the patch! I found that CMAKE_CFG_INTDIR can actually be passed into function and expanded to $(Configure). At least in VS2019 community... Can you try this new version? Thanks again!

[tatyana-krasnukha]

Build and installation completed successfully! LGTM, though it would be good if anyone tests this with Xcode.

[hhb]

In D68858#1709458, @tatyana-krasnukha wrote:

Build and installation completed successfully! LGTM, though it would be good if anyone tests this with Xcode.

I just tested Xcode. For xcode LLDB_BUILD_FRAMEWORK is on by default so that's what I did. Both release and debug build looks good. Obviously xcode did something different than VS...

lldb/CMakeLists.txt

if (NOT LLDB_DISABLE_PYTHON)
   get_target_property(lldb_scripts_dir swig_wrapper BINARY_DIR)
   get_target_property(liblldb_build_dir liblldb LIBRARY_OUTPUT_DIRECTORY)
 
   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()
-  get_filename_component(lldb_python_build_path ${lldb_python_build_path} ABSOLUTE)
 
   # 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
       ${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")
 
+    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)
+      endif()
+      add_custom_command(TARGET ${target} POST_BUILD VERBATIM
+        COMMAND ${CMAKE_COMMAND} -E ${LLVM_LINK_OR_COPY} "${rel_dest_file}" "${output_dir}/${output_name}"
+        WORKING_DIRECTORY ${output_dir})
+    endfunction()
+
+  if(LLDB_BUILD_FRAMEWORK)
+    set(LIBLLDB_SYMLINK_DEST "${liblldb_build_dir}/LLDB.framework/LLDB")
+  else()
+    set(LIBLLDB_SYMLINK_DEST "${liblldb_build_dir}/liblldb${CMAKE_SHARED_LIBRARY_SUFFIX}")
+  endif()
+  if(WIN32)
+    if(CMAKE_BUILD_TYPE STREQUAL Debug)
+      set(LIBLLDB_SYMLINK_OUTPUT_FILE "_lldb_d.pyd")
+    else()
+      set(LIBLLDB_SYMLINK_OUTPUT_FILE "_lldb.pyd")
+    endif()
+  else()
+    set(LIBLLDB_SYMLINK_OUTPUT_FILE "_lldb.so")
+  endif()
+  create_relative_symlink(finish_swig ${LIBLLDB_SYMLINK_DEST}
+                          ${lldb_python_build_path} ${LIBLLDB_SYMLINK_OUTPUT_FILE})
+
+  if(NOT LLDB_BUILD_FRAMEWORK)
+    set(LLDB_ARGDUMPER_FILENAME "lldb-argdumper${CMAKE_EXECUTABLE_SUFFIX}")
+    create_relative_symlink(finish_swig "${LLVM_RUNTIME_OUTPUT_INTDIR}/${LLDB_ARGDUMPER_FILENAME}"
+                            ${lldb_python_build_path} ${LLDB_ARGDUMPER_FILENAME})
+  endif()
+
   add_dependencies(finish_swig swig_wrapper liblldb lldb-argdumper)
   set_target_properties(finish_swig swig_wrapper PROPERTIES FOLDER "lldb misc")
 
   # Ensure we do the python post-build step when building lldb.
   add_dependencies(lldb finish_swig)
 
   if(NOT LLDB_BUILD_FRAMEWORK)
     # Install the LLDB python module

lldb/scripts/Python/finishSwigPythonLLDB.py

except IOError as e:
         if e.errno == 2:
             strMsg += " Src:'%s' Dst:'%s'" % (strSrc, strDst)
     except:
         bOk = False
         strMsg = strErrMsgUnexpected % sys.exec_info()[0]
 
     return (bOk, strMsg)
 
-#++---------------------------------------------------------------------------
-# Details:  Make the symbolic link on a Windows platform.
-# Args:     vstrSrcFile             - (R) Source file name.
-#           vstrTargetFile          - (R) Destination file name.
-# Returns:  Bool - True = function success, False = failure.
-#           Str - Error description on task failure.
-# Throws:   None.
-#--
-
-
-def make_symlink_windows(vstrSrcPath, vstrTargetPath):
-    print(("Making symlink from %s to %s" % (vstrSrcPath, vstrTargetPath)))
-    dbg = utilsDebug.CDebugFnVerbose("Python script make_symlink_windows()")
-    bOk = True
-    strErrMsg = ""
-    # If the src file doesn't exist, this is an error and we should throw.
-    src_stat = os.stat(vstrSrcPath)
-
-    try:
-        target_stat = os.stat(vstrTargetPath)
-        # If the target file exists but refers to a different file, delete it so that we can
-        # re-create the link.  This can happen if you run this script once (creating a link)
-        # and then delete the source file (so that a brand new file gets created the next time
-        # you compile and link), and then re-run this script, so that both the target hardlink
-        # and the source file exist, but the target refers to an old copy of
-        # the source.
-        if (target_stat.st_ino == src_stat.st_ino) and (
-                target_stat.st_dev == src_stat.st_dev):
-            return (bOk, strErrMsg)
-
-        os.remove(vstrTargetPath)
-    except:
-        # If the target file don't exist, ignore this exception, we will link
-        # it shortly.
-        pass
-
-    try:
-        csl = ctypes.windll.kernel32.CreateHardLinkW
-        csl.argtypes = (ctypes.c_wchar_p, ctypes.c_wchar_p, ctypes.c_uint32)
-        csl.restype = ctypes.c_ubyte
-        if csl(vstrTargetPath, vstrSrcPath, 0) == 0:
-            raise ctypes.WinError()
-    except Exception as e:
-        if e.errno != 17:
-            bOk = False
-            strErrMsg = "WinError(%d): %s %s" % (
-                e.errno, e.strerror, strErrMsgMakeSymlink)
-            strErrMsg += " Src:'%s' Target:'%s'" % (
-                vstrSrcPath, vstrTargetPath)
-
-    return (bOk, strErrMsg)
-
-#++---------------------------------------------------------------------------
-# Details:  Make the symbolic link on a UNIX style platform.
-# Args:     vstrSrcFile             - (R) Source file name.
-#           vstrTargetFile          - (R) Destination file name.
-# Returns:  Bool - True = function success, False = failure.
-#           Str - Error description on task failure.
-# Throws:   None.
-#--
-
-
-def make_symlink_other_platforms(vstrSrcPath, vstrTargetPath):
-    dbg = utilsDebug.CDebugFnVerbose(
-        "Python script make_symlink_other_platforms()")
-    bOk = True
-    strErrMsg = ""
-
-    try:
-        os.symlink(vstrSrcPath, vstrTargetPath)
-    except OSError as e:
-        bOk = False
-        strErrMsg = "OSError(%d): %s %s" % (
-            e.errno, e.strerror, strErrMsgMakeSymlink)
-        strErrMsg += " Src:'%s' Target:'%s'" % (vstrSrcPath, vstrTargetPath)
-    except:
-        bOk = False
-        strErrMsg = strErrMsgUnexpected % sys.exec_info()[0]
-
-    return (bOk, strErrMsg)
-
-
-def make_symlink_native(vDictArgs, strSrc, strTarget):
-    eOSType = utilsOsType.determine_os_type()
-    bDbg = "-d" in vDictArgs
-    bOk = True
-    strErrMsg = ""
-
-    target_filename = os.path.basename(strTarget)
-    if eOSType == utilsOsType.EnumOsType.Unknown:
-        bOk = False
-        strErrMsg = strErrMsgOsTypeUnknown
-    elif eOSType == utilsOsType.EnumOsType.Windows:
-        if bDbg:
-            print((strMsgSymlinkMk % (target_filename, strSrc, strTarget)))
-        bOk, strErrMsg = make_symlink_windows(strSrc,
-                                              strTarget)
-    else:
-        if os.path.islink(strTarget):
-            if bDbg:
-                print((strMsgSymlinkExists % target_filename))
-            return (bOk, strErrMsg)
-        if bDbg:
-            print((strMsgSymlinkMk % (target_filename, strSrc, strTarget)))
-        bOk, strErrMsg = make_symlink_other_platforms(strSrc,
-                                                      strTarget)
-
-    return (bOk, strErrMsg)
-
-#++---------------------------------------------------------------------------
-# Details:  Make the symbolic link.
-# Args:     vDictArgs               - (R) Program input parameters.
-#           vstrFrameworkPythonDir  - (R) Python framework directory.
-#           vstrSrcFile             - (R) Source file name.
-#           vstrTargetFile          - (R) Destination file name.
-# Returns:  Bool - True = function success, False = failure.
-#           Str - Error description on task failure.
-# Throws:   None.
-#--
-
-
-def make_symlink(
-        vDictArgs,
-        vstrFrameworkPythonDir,
-        vstrSrcFile,
-        vstrTargetFile):
-    dbg = utilsDebug.CDebugFnVerbose("Python script make_symlink()")
-    strTarget = os.path.join(vstrFrameworkPythonDir, vstrTargetFile)
-    strTarget = os.path.normcase(strTarget)
-    strSrc = ""
-
-    os.chdir(vstrFrameworkPythonDir)
-    bMakeFileCalled = "-m" in vDictArgs
-    eOSType = utilsOsType.determine_os_type()
-    if not bMakeFileCalled:
-        strBuildDir = os.path.join("..", "..", "..")
-    else:
-        # Resolve vstrSrcFile path relatively the build directory
-        if eOSType == utilsOsType.EnumOsType.Windows:
-            # On a Windows platform the vstrFrameworkPythonDir looks like:
-            # llvm\\build\\Lib\\site-packages\\lldb
-            strBuildDir = os.path.join("..", "..", "..")
-        else:
-            # On a UNIX style platform the vstrFrameworkPythonDir looks like:
-            # llvm/build/lib/python2.7/site-packages/lldb
-            strBuildDir = os.path.join("..", "..", "..", "..")
-    strSrc = os.path.normcase(os.path.join(strBuildDir, vstrSrcFile))
-
-    return make_symlink_native(vDictArgs, strSrc, strTarget)
-
-
-#++---------------------------------------------------------------------------
-# Details:  Make the symbolic that the script bridge for Python will need in
-#           the Python framework directory.
-# Args:     vDictArgs               - (R) Program input parameters.
-#           vstrFrameworkPythonDir  - (R) Python framework directory.
-#           vstrLiblldbName         - (R) File name for _lldb library.
-#           vstrLiblldbDir          - (R) liblldb directory.
-# Returns:  Bool - True = function success, False = failure.
-#           Str - Error description on task failure.
-# Throws:   None.
-#--
-def make_symlink_liblldb(
-        vDictArgs,
-        vstrFrameworkPythonDir,
-        vstrLiblldbFileName,
-        vstrLldbLibDir):
-    dbg = utilsDebug.CDebugFnVerbose("Python script make_symlink_liblldb()")
-    bOk = True
-    strErrMsg = ""
-    strTarget = vstrLiblldbFileName
-    strSrc = ""
-
-    eOSType = utilsOsType.determine_os_type()
-    if eOSType == utilsOsType.EnumOsType.Windows:
-        # When importing an extension module using a debug version of python, you
-        # write, for example, "import foo", but the interpreter searches for
-        # "foo_d.pyd"
-        if is_debug_interpreter():
-            strTarget += "_d"
-        strTarget += ".pyd"
-    else:
-        strTarget += ".so"
-
-    bMakeFileCalled = "-m" in vDictArgs
-    if not bMakeFileCalled:
-        strSrc = "LLDB"
-    else:
-        strLibFileExtn = ""
-        if eOSType == utilsOsType.EnumOsType.Windows:
-            strSrc = os.path.join("bin", "liblldb.dll")
-        else:
-            if eOSType == utilsOsType.EnumOsType.Darwin:
-                strLibFileExtn = ".dylib"
-            else:
-                strLibFileExtn = ".so"
-            strSrc = os.path.join(vstrLldbLibDir, "liblldb" + strLibFileExtn)
-
-    bOk, strErrMsg = make_symlink(
-        vDictArgs, vstrFrameworkPythonDir, strSrc, strTarget)
-
-    return (bOk, strErrMsg)
-
-#++---------------------------------------------------------------------------
-# Details:  Make the symbolic link to the lldb-argdumper.
-# Args:     vDictArgs               - (R) Program input parameters.
-#           vstrFrameworkPythonDir  - (R) Python framework directory.
-#           vstrArgdumperFileName   - (R) File name for lldb-argdumper.
-# Returns:  Bool - True = function success, False = failure.
-#           Str - Error description on task failure.
-# Throws:   None.
-#--
-
-
-def make_symlink_lldb_argdumper(
-        vDictArgs,
-        vstrFrameworkPythonDir,
-        vstrArgdumperFileName):
-    dbg = utilsDebug.CDebugFnVerbose(
-        "Python script make_symlink_lldb_argdumper()")
-    bOk = True
-    strErrMsg = ""
-    strTarget = vstrArgdumperFileName
-    strSrc = ""
-
-    eOSType = utilsOsType.determine_os_type()
-    if eOSType == utilsOsType.EnumOsType.Windows:
-        strTarget += ".exe"
-
-    bMakeFileCalled = "-m" in vDictArgs
-    if not bMakeFileCalled:
-        return (bOk, strErrMsg)
-    else:
-        strExeFileExtn = ""
-        if eOSType == utilsOsType.EnumOsType.Windows:
-            strExeFileExtn = ".exe"
-        strSrc = os.path.join("bin", "lldb-argdumper" + strExeFileExtn)
-
-    bOk, strErrMsg = make_symlink(
-        vDictArgs, vstrFrameworkPythonDir, strSrc, strTarget)
-
-    return (bOk, strErrMsg)
-
-#++---------------------------------------------------------------------------
-# Details:  Make the symlink that the script bridge for Python will need in
-#           the Python framework directory.
-# Args:     vDictArgs               - (R) Program input parameters.
-#           vstrFrameworkPythonDir  - (R) Python framework directory.
-#           vstrLldbLibDir          - (R) liblldb directory.
-# Returns:  Bool - True = function success, False = failure.
-#           strErrMsg - Error description on task failure.
-# Throws:   None.
-#--
-
-
-def create_symlinks(vDictArgs, vstrFrameworkPythonDir, vstrLldbLibDir):
-    dbg = utilsDebug.CDebugFnVerbose("Python script create_symlinks()")
-    bOk = True
-    strErrMsg = ""
-    eOSType = utilsOsType.determine_os_type()
-
-    # Make symlink for _lldb
-    strLibLldbFileName = "_lldb"
-    if bOk:
-        bOk, strErrMsg = make_symlink_liblldb(vDictArgs,
-                                              vstrFrameworkPythonDir,
-                                              strLibLldbFileName,
-                                              vstrLldbLibDir)
-
-    # Make symlink for lldb-argdumper
-    strArgdumperFileName = "lldb-argdumper"
-    if bOk:
-        bOk, strErrMsg = make_symlink_lldb_argdumper(vDictArgs,
-                                                     vstrFrameworkPythonDir,
-                                                     strArgdumperFileName)
-
-    return (bOk, strErrMsg)
-
 
 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"
def main(vDictArgs):
 
     if bOk:
         bOk, strLldbLibDir, strMsg = get_liblldb_dir(vDictArgs)
 
     if bOk:
         bOk, strMsg = find_or_create_python_dir(
             vDictArgs, strFrameworkPythonDir)
 
-    if bOk:
-        bOk, strMsg = create_symlinks(
-            vDictArgs, strFrameworkPythonDir, strLldbLibDir)
-
     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,