Allow the GHCi Linker to resolve related dependencies when loading DLLs
authorTamar Christina <tamar@zhox.com>
Sat, 7 Nov 2015 08:51:43 +0000 (03:51 -0500)
committerTamar Christina <tamar@zhox.com>
Sat, 7 Nov 2015 13:00:04 +0000 (14:00 +0100)
commit6e6438e15f33cb94ad6338e950e693f59d046385
tree445b9881c599f6977d6ad812462d9bf84c2570af
parentce1f1607ed7f8fedd2f63c8610cafefd59baaf32
Allow the GHCi Linker to resolve related dependencies when loading DLLs

Summary:
GHCi does not correctly tell the Windows Loader how to handle dependencies to DLL's
that are not on the standard Windows load path:

1. The directory from which the application loaded.
2. The current directory.
3. The system directory. Use the GetSystemDirectory function to get the path of this directory.
4. The 16-bit system directory. There is no function that obtains the path of this directory,
   but it is searched.
5. The Windows directory. Use the GetWindowsDirectory function to get the path of this directory.
6. The directories that are listed in the PATH environment variable.
   Note that this does not include the per-application path specified by the
   AppPaths registry key. The App Paths key is not used when computing the DLL search path.

So what this means is given two DLLs `A` and `B` and `B` depending on `A`.
If we put both DLLs into a new folder bin and then call GHC with:

`ghc -L$(PWD)/bin -lB`

the loading will fail as the Windows loader will try to load the dependency of `B` and fail
since it cannot find `A`.

*IMPORTANT* this patch drops XP Support.
The  APIs being used were natively added to Windows 8+ and backported to Windows 7 and Vista
via a mandatory security patch (in 2011). This means that there is a chance that KB2533623 has
not been installed on certain machines. For those machines I display a warning and
temporarily expand the `PATH` to allow it to load.

This patch will make sure that paths provided by the user with `-L` *and* the folder in which a
DLL is found are added to the search path. It does so using one of two methods depending upon how
new of a Windows version we are running on:

- If the APIs are available it will use `addDllDirectory` and `removeDllDirectory`.
   The order of which these directories are searched is nondeterministic.
- If the APIs are not available it means that we're running on a pretty old unpatched machine.
  But if it's being used in an environment with no internet access it may be the case.
  So if the APIs are not available we temporarily extend the `PATH` with the directories.
  A warning is also displayed to the user informing them that the linking may fail,
  and if it does, install the needed patch. The `PATH` variable has limitations.

Test Plan:
./validate

Added two new test T10955 and T10955dyn

Reviewers: erikd, bgamari, thomie, hvr, austin

Reviewed By: erikd, thomie

Subscribers: #ghc_windows_task_force

Differential Revision: https://phabricator.haskell.org/D1340

GHC Trac Issues: #10955
13 files changed:
compiler/ghci/Linker.hs
compiler/ghci/ObjLink.hs
includes/rts/Linker.h
rts/Linker.c
rts/RtsSymbols.c
rts/ghc.mk
testsuite/tests/ghci/linking/dyn/B.c [new file with mode: 0644]
testsuite/tests/ghci/linking/dyn/Makefile
testsuite/tests/ghci/linking/dyn/T10955.script [new file with mode: 0644]
testsuite/tests/ghci/linking/dyn/T10955.stdout [new file with mode: 0644]
testsuite/tests/ghci/linking/dyn/T10955dyn.hs [new file with mode: 0644]
testsuite/tests/ghci/linking/dyn/T10955dyn.stdout [new file with mode: 0644]
testsuite/tests/ghci/linking/dyn/all.T