[sanitizer-common] Force pickup of llvm-symbolizer from new binaries.

[hctim]

Summary

It's possible currently that the sanitizer runtimes when testing grab
the path to the symbolizer through *SAN_SYMBOLIZER_PATH=...

This can be polluted by things like Android's setup script. This patch
forces external_symbolizer_path=$new_build_out_dir/llvm-symbolizer when
%env_tool_options is used.

[hctim]

(looks like a broke a bot - LMTAL for an in-flight fix: http://lab.llvm.org:8011/#/builders/37/builds/1311/steps/33/logs/stdio)

[hctim]

(buildbreak fixed in 30d292ddbb7e)

[morehouse]

Also seems to have broken the Android bot even after your fix:

(there is currently a build issue obscuring the breakage in latest builds)

Function symbolization seems to be broken on Android.

[hctim]

In D93352#2460367, @morehouse wrote:

Also seems to have broken the Android bot even after your fix:

(there is currently a build issue obscuring the breakage in latest builds)

Function symbolization seems to be broken on Android.

Thanks for the heads up - yeah, we don't push the symbolizer on device on Android and everything's invoked through a wrapper script. Let me fix it up.

compiler-rt/test/sanitizer_common/lit.common.cfg.py

if config.host_os == 'Darwin':
   if config.tool_name == "tsan":
     default_tool_options += ['ignore_interceptors_accesses=0']
 elif config.android:
   # The same as on Darwin, we default to "abort_on_error=1" which slows down
   # testing. Also, all existing tests are using "not" instead of "not --crash"
   # which does not work for abort()-terminated programs.
   default_tool_options += ['abort_on_error=0']
 
+# If the user has a poisoned *SAN_SYMBOLIZER_PATH (like what's setup by
+# build/envsetup.sh on Android), then they can end up with an out-of-date
+# symbolizer for the tests. Ensure they get the one from the recent build tree.
+symbolizer_path="''"
+if len(config.binary_path):
+  symbolizer_path = os.path.join(config.binary_path, "llvm-symbolizer")
+default_tool_options += ['external_symbolizer_path=' + symbolizer_path]
+
 default_tool_options_str = ':'.join(default_tool_options)
 if default_tool_options_str:
   config.environment[tool_options] = default_tool_options_str
   default_tool_options_str += ':'
 
 extra_link_flags = []
 
 if config.host_os in ['Linux']:

compiler-rt/test/sanitizer_common/lit.site.cfg.py.in

 @LIT_SITE_CFG_IN_HEADER@
 
 # Tool-specific config options.
 config.name_suffix = "@CONFIG_NAME@"
 config.tool_name = "@SANITIZER_COMMON_LIT_TEST_MODE@"
 config.target_cflags = "@SANITIZER_COMMON_TEST_TARGET_CFLAGS@"
 config.target_arch = "@SANITIZER_COMMON_TEST_TARGET_ARCH@"
+config.binary_path = "@CMAKE_RUNTIME_OUTPUT_DIRECTORY@"
 
 # Load common config for all compiler-rt lit tests.
 lit_config.load_config(config, "@COMPILER_RT_BINARY_DIR@/test/lit.common.configured")
 
 # Load tool-specific config that would do the real work.
 lit_config.load_config(config, "@SANITIZER_COMMON_LIT_SOURCE_DIR@/lit.common.cfg.py")