Fix darwin-debug build in cmake (OS X)

[ki.stfu]

Summary

Fix build of darwin-debug in cmake on OS X. Currently it works in XCode.

This patch fixes test_launch_in_terminal test which doesn't work in OS X since the moment as it was added in r225284. The test fails because Target::Launch returns the following error: "the 'darwin-debug' executable doesn't exists at '/Users/IliaK/p/llvm/build_ninja/lib/python2.7/site-packages/lldb/darwin-debug'".

Log:
======================================================================
FAIL: test_launch_in_terminal (TestTerminal.LaunchInTerminalTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/IliaK/p/llvm/tools/lldb/test/functionalities/tty/TestTerminal.py", line 36, in test_launch_in_terminal
    self.assertTrue(error.Success(), "Make sure launch happened successfully in a terminal window")
AssertionError: False is not True : Make sure launch happened successfully in a terminal window
Config=x86_64-clang

For more information see following thread: http://lists.cs.uiuc.edu/pipermail/lldb-commits/Week-of-Mon-20150119/014983.html

[zturner]

scripts/Python/finishSwigPythonLLDB.py

342 ↗

(On Diff #18536)

Thanks for adding this to the Python script. Did you test the CMake build with both the shell script codepath and the python codepath? (e.g. by trying both values for LLDB_DEFAULT_ENABLE_PYTHON_SCRIPTS_SWIG_API_GENERATION)?

tools/darwin-debug/CMakeLists.txt

1 ↗

(On Diff #18536)

Should the executable be called darwin-debug instead of lldb-launcher?

[ki.stfu]

scripts/Python/finishSwigPythonLLDB.py

342 ↗

(On Diff #18536)

No. Only python codepath. I can't test it with shell script codepath. "export LLDB_DEFAULT_ENABLE_PYTHON_SCRIPTS_SWIG_API_GENERATION=0" didn't help

tools/darwin-debug/CMakeLists.txt

1 ↗

(On Diff #18536)

I don't mind. I took it from lldb.xcodeproj/project.pbxproj:

26579F67126A25920007C5CB /* darwin-debug */ = {
    isa = PBXNativeTarget;
    buildConfigurationList = 26579F6D126A25BF0007C5CB /* Build configuration list for PBXNativeTarget "darwin-debug" */;
    buildPhases = (
        26579F65126A25920007C5CB /* Sources */,
        26579F66126A25920007C5CB /* Frameworks */,
    );
    buildRules = (
    );
    dependencies = (
    );
    name = "darwin-debug";
    productName = "lldb-launcher";
    productReference = 26579F68126A25920007C5CB /* darwin-debug */;
    productType = "com.apple.product-type.tool";
};

[ki.stfu]

Fix symlink source in finishSwigPythonLLDB.py

[zturner]

LGTM

tools/darwin-debug/CMakeLists.txt

1 ↗

(On Diff #18536)

Ahh, probably best to match the xcode project then.

[clayborg]

looks good.

[ki.stfu]

Update scripts/Python/finish-swig-Python-LLDB.sh:

1. Fix syntax error
2. Create symlink only on Darwin

[ki.stfu]

Can anybody test that these changes don't affect to Linux and Windows:

1. Check that build_dir/bin/lldb-launcher doesn't exist
2. Check that build_dir/lib/python2.7/site-packages/lldb/darwin-debug doesn't exist

And test that these files are created when building by CMake using shell script codepath? Unfortunately I don't know how I can check it because LLDB_DEFAULT_ENABLE_PYTHON_SCRIPTS_SWIG_API_GENERATION didn't help me.

[zturner]

I can check windows later today. As for the CMake variable, I think I told
you the wrong name. Try this variable instead:

-DLLDB_ENABLE_PYTHON_SCRIPTS_SWIG_API_GENERATION=0

That should force it to use the shell script on MacOSX.

[ki.stfu]

In D7102#112255, @zturner wrote:

I can check windows later today. As for the CMake variable, I think I told
you the wrong name. Try this variable instead:

-DLLDB_ENABLE_PYTHON_SCRIPTS_SWIG_API_GENERATION=0

That should force it to use the shell script on MacOSX.

Yes, the both codepaths work on MacOSX. Can you commit this patch?

[zturner]

Yes, but please remind me on Monday so I don't forget.

[ki.stfu]

Hello,

Can you commit this patch?

Thanks,
Ilia

lldb/trunk/scripts/Python/finish-swig-Python-LLDB.sh

else
     fi
 else
     if [ $Debug -eq 1 ]
     then
         echo "${framework_python_dir}/_lldb.so already exists."
     fi
 fi
 
+if [ ${OS_NAME} = "Darwin" ] && [ $MakefileCalled -ne 0 ]
+then
+    # We are being built by CMake on Darwin
+
+    if [ ! -L "${framework_python_dir}/darwin-debug" ]
+    then
+        if [ $Debug -eq 1 ]
+        then
+            echo "Creating symlink for darwin-debug"
+        fi
+        cd "${framework_python_dir}"
+        ln -s "../../../../bin/lldb-launcher" darwin-debug
+    else
+        if [ $Debug -eq 1 ]
+        then
+            echo "${framework_python_dir}/darwin-debug already exists."
+        fi
+    fi
+fi
 
 create_python_package () {
     package_dir="${framework_python_dir}$1"
     package_files="$2"
     package_name=`echo $1 | tr '/' '.'`
     package_name="lldb${package_name}"
 
     if [ ! -d "${package_dir}" ]

lldb/trunk/scripts/Python/finishSwigPythonLLDB.py

except OSError as e:
     strMsg += " Src:'%s' Target:'%s'" % (strSrc, strTarget);
   except:
     bOk = False;
     strMsg = strErrMsgUnexpected % sys.exec_info()[ 0 ];
   
   return (bOk, strMsg);
   
 #++---------------------------------------------------------------------------
+# Details:  Make the symbolic link to the darwin-debug. Code for all platforms
+#           apart from Windows.
+# Args:   vDictArgs       - (R) Program input parameters.
+#     vstrFrameworkPythonDir  - (R) Python framework directory.
+#     vstrDarwinDebugFileName - (R) File name for darwin-debug.
+# Returns:  Bool - True = function success, False = failure.
+#     Str - Error description on task failure.
+# Throws: None.
+#--
+def make_symlink_darwin_debug( vDictArgs, vstrFrameworkPythonDir, vstrDarwinDebugFileName ):
+  dbg = utilsDebug.CDebugFnVerbose( "Python script make_symlink_other_platforms()" );
+  bOk = True;
+  strMsg = "";
+  bDbg = vDictArgs.has_key( "-d" );
+  strTarget = vstrDarwinDebugFileName
+  strDarwinDebugPath = "%s/%s" % (vstrFrameworkPythonDir, strTarget);
+  strTarget = os.path.normcase( strDarwinDebugPath );
+  strSrc = "";
+      
+  os.chdir( vstrFrameworkPythonDir );
+  bMakeFileCalled = vDictArgs.has_key( "-m" );
+  if not bMakeFileCalled:
+      return (bOk, strMsg);
+  else:
+    strSrc = os.path.normcase( "../../../../bin/lldb-launcher" );
+
+  if os.path.islink( strTarget ):
+    if bDbg:
+      print strMsglldbsoExists % strTarget;
+    return (bOk, strMsg);
+  
+  if bDbg:
+    print strMsglldbsoMk;
+    
+  try:
+    os.symlink( strSrc, strTarget );
+  except OSError as e:
+    bOk = False;
+    strMsg = "OSError( %d ): %s %s" % (e.errno, e.strerror, strErrMsgMakeSymlink);
+    strMsg += " Src:'%s' Target:'%s'" % (strSrc, strTarget);
+  except:
+    bOk = False;
+    strMsg = strErrMsgUnexpected % sys.exec_info()[ 0 ];
+  
+  return (bOk, strMsg);
+
+#++---------------------------------------------------------------------------
 # 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.
 # Returns:  Bool - True = function success, False = failure.
 #     strErrMsg - Error description on task failure.
 # Throws: None.
 #--
 def make_symlink( vDictArgs, vstrFrameworkPythonDir ):
   dbg = utilsDebug.CDebugFnVerbose( "Python script make_symlink()" );
   bOk = True;
   strWkDir = "";
   strErrMsg = "";
-  strSoFileName = "_lldb";
-   
   eOSType = utilsOsType.determine_os_type();
+
+    # Make symlink for _lldb
+  strSoFileName = "_lldb";
   if eOSType == utilsOsType.EnumOsType.Unknown:
     bOk = False;
     strErrMsg = strErrMsgOsTypeUnknown;
   elif eOSType == utilsOsType.EnumOsType.Windows:
     bOk, strErrMsg = make_symlink_windows( vDictArgs, 
                          vstrFrameworkPythonDir,
                          strSoFileName );
   else:
     bOk, strErrMsg = make_symlink_other_platforms( vDictArgs, 
                              vstrFrameworkPythonDir,
                              strSoFileName );   
+
+    # Make symlink for darwin-debug
+  strDarwinDebugFileName = "darwin-debug"
+  if bOk and eOSType == utilsOsType.EnumOsType.Darwin:
+    bOk, strErrMsg = make_symlink_darwin_debug( vDictArgs,
+                            vstrFrameworkPythonDir,
+                            strDarwinDebugFileName );
+
   return (bOk, strErrMsg);
 
 #++---------------------------------------------------------------------------
 # 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.

lldb/trunk/tools/CMakeLists.txt

 if (CMAKE_SYSTEM_NAME MATCHES "Darwin")
+  add_subdirectory(darwin-debug)
   add_subdirectory(debugserver)
 endif()
   add_subdirectory(driver)
 if (NOT __ANDROID_NDK__)
   add_subdirectory(lldb-mi)
 endif()
 if (CMAKE_SYSTEM_NAME MATCHES "FreeBSD" OR CMAKE_SYSTEM_NAME MATCHES "Linux")
   add_subdirectory(lldb-gdbserver)
 endif()
 if (NOT CMAKE_SYSTEM_NAME MATCHES "Windows")
   add_subdirectory(lldb-platform)
 endif()

lldb/trunk/tools/darwin-debug/CMakeLists.txt

+add_lldb_executable(lldb-launcher
+  darwin-debug.cpp
+  )