Merge pull request #1117 from tweag/unix_toolchain

Define Unix shell toolchain
tweag · Oct 15, 2019 · 5c8066d · 5c8066d
2 parents 3d702a1 + 3ea0f9e
commit 5c8066d
Show file tree

Hide file tree

Showing 9 changed files with 455 additions and 4 deletions.
diff --git a/haskell/cabal.bzl b/haskell/cabal.bzl
@@ -88,12 +88,12 @@ def _cabal_tool_flag(tool):
 def _make_path(hs, binaries):
     return ":".join([binary.dirname for binary in binaries.to_list()] + ["$PATH"])
 
-def _prepare_cabal_inputs(hs, cc, dep_info, cc_info, component, package_id, tool_inputs, tool_input_manifests, cabal, setup, srcs, flags, cabal_wrapper_tpl, package_database):
+def _prepare_cabal_inputs(hs, cc, unix, dep_info, cc_info, component, package_id, tool_inputs, tool_input_manifests, cabal, setup, srcs, flags, cabal_wrapper_tpl, package_database):
     """Compute Cabal wrapper, arguments, inputs."""
     with_profiling = is_profiling_enabled(hs)
 
     (ghci_extra_libs, env) = get_ghci_extra_libs(hs, cc_info)
-    env["PATH"] = _make_path(hs, tool_inputs)
+    env["PATH"] = _make_path(hs, tool_inputs) + ":" + ":".join(unix.paths)
     if hs.toolchain.is_darwin:
         env["SDKROOT"] = "macosx"  # See haskell/private/actions/link.bzl
 
@@ -109,6 +109,7 @@ def _prepare_cabal_inputs(hs, cc, dep_info, cc_info, component, package_id, tool
             "%{ghc_pkg}": hs.tools.ghc_pkg.path,
             "%{runghc}": hs.tools.runghc.path,
             "%{ar}": cc.tools.ar,
+            "%{cc}": cc.tools.cc,
             "%{strip}": cc.tools.strip,
             # XXX Workaround
             # https://github.com/bazelbuild/bazel/issues/5980.
@@ -176,6 +177,7 @@ def _haskell_cabal_library_impl(ctx):
     cc_info = cc_common.merge_cc_infos(
         cc_infos = [dep[CcInfo] for dep in ctx.attr.deps if CcInfo in dep],
     )
+    unix = ctx.toolchains["@rules_haskell//haskell/private/unix:toolchain_type"]
     package_id = "{}-{}".format(
         ctx.attr.package_name if ctx.attr.package_name else hs.label.name,
         ctx.attr.version,
@@ -218,6 +220,7 @@ def _haskell_cabal_library_impl(ctx):
     c = _prepare_cabal_inputs(
         hs,
         cc,
+        unix,
         dep_info,
         cc_info,
         component = "lib:{}".format(
@@ -334,7 +337,10 @@ haskell_cabal_library = rule(
             default = Label("@bazel_tools//tools/cpp:current_cc_toolchain"),
         ),
     },
-    toolchains = ["@rules_haskell//haskell:toolchain"],
+    toolchains = [
+        "@rules_haskell//haskell:toolchain",
+        "@rules_haskell//haskell/private/unix:toolchain_type",
+    ],
     fragments = ["cpp"],
 )
 """Use Cabal to build a library.
@@ -373,6 +379,7 @@ def _haskell_cabal_binary_impl(ctx):
     cc_info = cc_common.merge_cc_infos(
         cc_infos = [dep[CcInfo] for dep in ctx.attr.deps if CcInfo in dep],
     )
+    unix = ctx.toolchains["@rules_haskell//haskell/private/unix:toolchain_type"]
 
     cabal = _find_cabal(hs, ctx.files.srcs)
     setup = _find_setup(hs, cabal, ctx.files.srcs)
@@ -395,6 +402,7 @@ def _haskell_cabal_binary_impl(ctx):
     c = _prepare_cabal_inputs(
         hs,
         cc,
+        unix,
         dep_info,
         cc_info,
         component = "exe:{}".format(hs.label.name),
@@ -468,7 +476,10 @@ haskell_cabal_binary = rule(
             default = Label("@bazel_tools//tools/cpp:current_cc_toolchain"),
         ),
     },
-    toolchains = ["@rules_haskell//haskell:toolchain"],
+    toolchains = [
+        "@rules_haskell//haskell:toolchain",
+        "@rules_haskell//haskell/private/unix:toolchain_type",
+    ],
     fragments = ["cpp"],
 )
 """Use Cabal to build a binary.

diff --git a/haskell/ghc_bindist.bzl b/haskell/ghc_bindist.bzl
@@ -1,6 +1,10 @@
 """Workspace rules (GHC binary distributions)"""
 
 load("@bazel_tools//tools/build_defs/repo:utils.bzl", "patch")
+load(
+    "@rules_haskell//haskell/private/unix:unix_configure.bzl",
+    "unix_configure",
+)
 
 _GHC_DEFAULT_VERSION = "8.6.5"
 
@@ -448,6 +452,9 @@ def haskell_register_ghc_bindists(
             haddock_flags = haddock_flags,
             repl_ghci_args = repl_ghci_args,
         )
+    local_unix_repo_name = "rules_haskell_unix_local"
+    if local_unix_repo_name not in native.existing_rules():
+        unix_configure(name = local_unix_repo_name)
 
 def _find_python(repository_ctx):
     python = repository_ctx.which("python3")

diff --git a/haskell/nixpkgs.bzl b/haskell/nixpkgs.bzl
@@ -4,6 +4,10 @@ load(
     "@io_tweag_rules_nixpkgs//nixpkgs:nixpkgs.bzl",
     "nixpkgs_package",
 )
+load(
+    "@rules_haskell//haskell/private/unix:unix_nixpkgs.bzl",
+    "unix_nixpkgs",
+)
 
 def _ghc_nixpkgs_haskell_toolchain_impl(repository_ctx):
     compiler_flags_select = "select({})".format(
@@ -167,6 +171,7 @@ def haskell_register_ghc_nixpkgs(
         repl_ghci_args = None,
         locale_archive = None,
         attribute_path = "haskellPackages.ghc",
+        unix_attributes = None,
         nix_file = None,
         nix_file_deps = [],
         nixopts = None,
@@ -187,6 +192,7 @@ def haskell_register_ghc_nixpkgs(
     Args:
       compiler_flags_select: temporary workaround to pass conditional arguments.
         See https://github.com/bazelbuild/bazel/issues/9199 for details.
+      unix_attributes: List of attribute paths to extract standard Unix shell tools from.
 
 
     Example:
@@ -208,6 +214,7 @@ def haskell_register_ghc_nixpkgs(
 
     """
     nixpkgs_ghc_repo_name = "rules_haskell_ghc_nixpkgs"
+    nixpkgs_unix_repo_name = "rules_haskell_unix_nixpkgs"
     haskell_toolchain_repo_name = "rules_haskell_ghc_nixpkgs_haskell_toolchain"
     toolchain_repo_name = "rules_haskell_ghc_nixpkgs_toolchain"
 
@@ -242,6 +249,20 @@ def haskell_register_ghc_nixpkgs(
     _ghc_nixpkgs_toolchain(name = toolchain_repo_name)
     native.register_toolchains("@{}//:toolchain".format(toolchain_repo_name))
 
+    # Unix tools toolchain required for Cabal packages
+    unix_nixpkgs_kwargs = dict(
+        nix_file_deps = nix_file_deps,
+        nixopts = nixopts,
+        repositories = repositories,
+        repository = repository,
+    )
+    if unix_attributes != None:
+        unix_nixpkgs_kwargs["packages"] = unix_attributes
+    unix_nixpkgs(
+        name = nixpkgs_unix_repo_name,
+        **unix_nixpkgs_kwargs
+    )
+
 def _find_children(repository_ctx, target_dir):
     find_args = [
         "find",

diff --git a/haskell/private/cabal_wrapper.sh.tpl b/haskell/private/cabal_wrapper.sh.tpl
@@ -84,6 +84,7 @@ done
 shift 1
 
 ar=$(realpath %{ar})
+cc=$(realpath %{cc})
 strip=$(realpath %{strip})
 distdir=$(mktemp -d)
 libdir="$pkgroot/${name}_iface"
@@ -99,6 +100,15 @@ trap cleanup EXIT
 
 %{ghc_pkg} recache --package-db=$package_database
 
+WITH_GCC=
+if [[ %{is_windows} != True ]]; then
+    # Use the cc-wrapper for Cabal builds.
+    # Note, we cannot currently use it on Windows because the solution to the
+    # following issue is not released, yet.
+    #   https://github.com/bazelbuild/bazel/issues/9390
+    WITH_GCC="--with-gcc=$cc"
+fi
+
 ENABLE_RELOCATABLE=
 if [[ %{is_windows} != True ]]; then
     ENABLE_RELOCATABLE=--enable-relocatable
@@ -119,6 +129,7 @@ $execroot/%{runghc} $setup configure \
     --with-compiler=$execroot/%{ghc} \
     --with-hc-pkg=$execroot/%{ghc_pkg} \
     --with-ar=$ar \
+    $WITH_GCC \
     --with-strip=$strip \
     --enable-deterministic \
     $ENABLE_RELOCATABLE \

diff --git a/haskell/private/unix/BUILD.bazel b/haskell/private/unix/BUILD.bazel
@@ -0,0 +1,4 @@
+toolchain_type(
+    name = "toolchain_type",
+    visibility = ["//visibility:public"],
+)
diff --git a/haskell/private/unix/unix_commands.bzl b/haskell/private/unix/unix_commands.bzl
@@ -0,0 +1,165 @@
+# List of Unix commands as specified by IEEE Std 1003.1-2008.
+# Extracted from https://en.wikipedia.org/wiki/List_of_Unix_commands.
+unix_commands = [
+    "admin",
+    "alias",
+    "ar",
+    "asa",
+    "at",
+    "awk",
+    "basename",
+    "batch",
+    "bc",
+    "bg",
+    "cc",
+    "c99",
+    "cal",
+    "cat",
+    "cd",
+    "cflow",
+    "chgrp",
+    "chmod",
+    "chown",
+    "cksum",
+    "cmp",
+    "comm",
+    "command",
+    "compress",
+    "cp",
+    "crontab",
+    "csplit",
+    "ctags",
+    "cut",
+    "cxref",
+    "date",
+    "dd",
+    "delta",
+    "df",
+    "diff",
+    "dirname",
+    "du",
+    "echo",
+    "ed",
+    "env",
+    "ex",
+    "expand",
+    "expr",
+    "false",
+    "fc",
+    "fg",
+    "file",
+    "find",
+    "fold",
+    "fort77",
+    "fuser",
+    "gencat",
+    "get",
+    "getconf",
+    "getopts",
+    "grep",
+    "hash",
+    "head",
+    "iconv",
+    "id",
+    "ipcrm",
+    "ipcs",
+    "jobs",
+    "join",
+    "kill",
+    "lex",
+    "link",
+    "ln",
+    "locale",
+    "localedef",
+    "logger",
+    "logname",
+    "lp",
+    "ls",
+    "m4",
+    "mailx",
+    "make",
+    "man",
+    "mesg",
+    "mkdir",
+    "mkfifo",
+    "more",
+    "mv",
+    "newgrp",
+    "nice",
+    "nl",
+    "nm",
+    "nohup",
+    "od",
+    "paste",
+    "patch",
+    "pathchk",
+    "pax",
+    "pr",
+    "printf",
+    "prs",
+    "ps",
+    "pwd",
+    "qalter",
+    "qdel",
+    "qhold",
+    "qmove",
+    "qmsg",
+    "qrerun",
+    "qrls",
+    "qselect",
+    "qsig",
+    "qstat",
+    "qsub",
+    "read",
+    "renice",
+    "rm",
+    "rmdel",
+    "rmdir",
+    "sact",
+    "sccs",
+    "sed",
+    "sh",
+    "sleep",
+    "sort",
+    "split",
+    "strings",
+    "strip",
+    "stty",
+    "tabs",
+    "tail",
+    "talk",
+    "tee",
+    "test",
+    "time",
+    "touch",
+    "tput",
+    "tr",
+    "true",
+    "tsort",
+    "tty",
+    "type",
+    "ulimit",
+    "umask",
+    "unalias",
+    "uname",
+    "uncompress",
+    "unexpand",
+    "unget",
+    "uniq",
+    "unlink",
+    "uucp",
+    "uudecode",
+    "uuencode",
+    "uustat",
+    "uux",
+    "val",
+    "vi",
+    "wait",
+    "wc",
+    "what",
+    "who",
+    "write",
+    "xargs",
+    "yacc",
+    "zcat",
+]