[all-commits] [llvm/llvm-project] 004a26: [lldb] Fix shared library directory computation on...

[Pavel Labath via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 004a264f8c923922ecd34255bcb10f4adaa27ac5
      https://github.com/llvm/llvm-project/commit/004a264f8c923922ecd34255bcb10f4adaa27ac5
  Author: Pavel Labath <pavel at labath.sk>
  Date:   2021-02-18 (Thu, 18 Feb 2021)

  Changed paths:
    M lldb/include/lldb/Host/HostInfoBase.h
    M lldb/include/lldb/Host/linux/HostInfoLinux.h
    M lldb/include/lldb/Host/windows/HostInfoWindows.h
    M lldb/include/lldb/Initialization/SystemInitializerCommon.h
    M lldb/source/API/SystemInitializerFull.cpp
    M lldb/source/Host/common/HostInfoBase.cpp
    M lldb/source/Host/linux/HostInfoLinux.cpp
    M lldb/source/Host/windows/HostInfoWindows.cpp
    M lldb/source/Initialization/SystemInitializerCommon.cpp
    M lldb/source/Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.cpp
    M lldb/source/Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.h
    M lldb/test/API/functionalities/paths/TestPaths.py
    M lldb/tools/lldb-server/SystemInitializerLLGS.h
    M lldb/tools/lldb-test/SystemInitializerTest.cpp

  Log Message:
  -----------
  [lldb] Fix shared library directory computation on windows

Our code for locating the shared library directory works via dladdr (or
the windows equivalent) to locate the path of an address known to reside
in liblldb. This works great for C++ programs, but there's a catch.

When (lib)lldb is used from python (like in our test suite), this dladdr
call will return a path to the _lldb.so (or such) file in the python
directory. To compensate for this, we have code which attempts to
resolve this symlink, to ensure we get the canonical location. However,
here's the second catch.

On windows, this file is not a symlink (but a copy), so this logic
fails. Since most of our other paths are derived from the liblldb
location, all of these paths will be wrong, when running the test suite.
One effect of this was the failure to find lldb-server in D96202.

To fix this issue, I add some windows-specific code to locate the
liblldb directory. Since it cannot rely on symlinks, it works by
manually walking the directory tree -- essentially doing the opposite of
what we do when computing the python directory.

To avoid python leaking back into the host code, I implement this with
the help of a callback which can be passed to HostInfo::Initialize in
order to assist with the directory location. The callback lives inside
the python plugin.

I also strenghten the existing path test to ensure the returned path is
the right one.

Differential Revision: https://reviews.llvm.org/D96779