[dotest] Use in-tree dsymutil on Darwin

[JDevlieghere]

Summary

With the upstream implementation of dsymutil containing almost all
functionality from the one shipped with Xcode, we want to use the
in-tree version for running the test suite.

This will also allow us to re-enable TestUnicodeSymbols which was
failing because of the discrepancy in how Unicode symbols were hashed in
lldb and older versions of dsymutil.

[aprantl]

packages/Python/lldbsuite/test/dotest.py

306

I suppose we could point to llvm-dsymutil even on non-darwin platforms? Might be useful if we want to have no-execute-Darwin tests running on Linux bots?

[JDevlieghere]

packages/Python/lldbsuite/test/dotest.py

306

Jup that is true, I'll change the logic to make that happen

[JDevlieghere]

• Address Adrian's feedback

[davide]

LGTM

packages/Python/lldbsuite/test/dotest.py

else:
         else:
             # 'clang' on ubuntu 14.04 is 3.4 so we try clang-3.5 first
             candidateCompilers = ['clang-3.5', 'clang', 'gcc']
             for candidate in candidateCompilers:
                 if which(candidate):
                     configuration.compiler = candidate
                     break
 
+    if platform_system == 'Darwin':
+      if args.dsymutil:
+        os.environ['DSYMUTIL'] = args.dsymutil
+      else:
+        os.environ['DSYMUTIL'] = seven.get_command_output(
+            'xcrun -find -toolchain default dsymutil')
+
     if args.channels:
         lldbtest_config.channels = args.channels
 
     if args.log_success:
         lldbtest_config.log_success = args.log_success
 
     if args.out_of_tree_debugserver:
         lldbtest_config.out_of_tree_debugserver = args.out_of_tree_debugserver

packages/Python/lldbsuite/test/dotest_args.py

if sys.platform == 'darwin':
             '''Specify the name of the Apple SDK (macosx, macosx.internal, iphoneos, iphoneos.internal, or path to SDK) and use the appropriate tools from that SDK's toolchain.'''))
     # FIXME? This won't work for different extra flags according to each arch.
     group.add_argument(
         '-E',
         metavar='extra-flags',
         help=textwrap.dedent('''Specify the extra flags to be passed to the toolchain when building the inferior programs to be debugged
                                                            suggestions: do not lump the "-A arch1 -A arch2" together such that the -E option applies to only one of the architectures'''))
 
+    group.add_argument('--dsymutil', metavar='dsymutil', dest='dsymutil', help=textwrap.dedent('Which dsymutil to use'))
+
     # Test filtering options
     group = parser.add_argument_group('Test filtering options')
     group.add_argument(
         '-f',
         metavar='filterspec',
         action='append',
         help='Specify a filter, which consists of the test class name, a dot, followed by the test method, to only admit such test into the test suite')  # FIXME: Example?
     X('-l', "Don't skip long running tests")

packages/Python/lldbsuite/test/make/Makefile.rules

 # to compile for. The default is the flag that clang accepts.
 #----------------------------------------------------------------------
 ARCHFLAG ?= -arch
 
 #----------------------------------------------------------------------
 # Change any build/tool options needed
 #----------------------------------------------------------------------
 ifeq "$(OS)" "Darwin"
-  DS := $(shell xcrun -find -toolchain default dsymutil)
+  DS := $(DSYMUTIL)
   DSFLAGS =
   DSYM = $(EXE).dSYM
   AR := $(CROSS_COMPILE)libtool
   ARFLAGS := -static -o
 else
   AR := $(CROSS_COMPILE)ar
   # On non-Apple platforms, -arch becomes -m
   ARCHFLAG := -m
ifneq "$(DYLIB_NAME)" ""
   $(RM) $(DYLIB_NAME).lib $(DYLIB_NAME).exp
 endif
 else
   $(RM) "$(EXE)"
 endif
 
 #----------------------------------------------------------------------
 # From http://blog.melski.net/tag/debugging-makefiles/
-# 
+#
 # Usage: make print-CC print-CXX print-LD
 #----------------------------------------------------------------------
 print-%:
   @echo '$*=$($*)'
   @echo '  origin = $(origin $*)'
   @echo '  flavor = $(flavor $*)'
   @echo '   value = $(value  $*)'
 
 ### Local Variables: ###
 ### mode:makefile ###
 ### End: ###

test/CMakeLists.txt

 function(add_python_test_target name test_script args comment)
   set(PYTHON_TEST_COMMAND
     ${PYTHON_EXECUTABLE}
     ${test_script}
     ${args}
     )
 
   add_custom_target(${name}
     COMMAND ${PYTHON_TEST_COMMAND} ${ARG_DEFAULT_ARGS}
     COMMENT "${comment}"
     DEPENDS ${LLDB_TEST_DEPS}
     USES_TERMINAL
     )
 endfunction()
 
-set(LLDB_TEST_DEPS lldb)
+set(LLDB_TEST_DEPS lldb dsymutil)
 
 # darwin-debug is an hard dependency for the testsuite.
 if (CMAKE_SYSTEM_NAME MATCHES "Darwin")
   list(APPEND LLDB_TEST_DEPS darwin-debug)
 endif()
 
 if(TARGET lldb-server)
   list(APPEND LLDB_TEST_DEPS lldb-server)

 # The .nodindex suffix is a marker for Spotlight to never index the
 # build directory.  LLDB queries Spotlight to locate .dSYM bundles
 # based on the UUID embedded in a binary, and because the UUID is a
 # hash of filename and .text section, there *will* be conflicts inside
 # the build directory.
 set(LLDB_TEST_COMMON_ARGS
   --arch=${LLDB_TEST_ARCH}
   --executable $<TARGET_FILE:lldb>
+  --dsymutil $<TARGET_FILE:dsymutil>
   -s
   ${CMAKE_BINARY_DIR}/lldb-test-traces
   --build-dir
   ${CMAKE_BINARY_DIR}/lldb-test-build.noindex
   -S nm
   -u CXXFLAGS
   -u CFLAGS
   -C ${LLDB_TEST_C_COMPILER}