depot/third_party/nixpkgs/pkgs/os-specific/darwin/binutils/default.nix

{ lib, stdenv, makeWrapper, binutils-unwrapped, cctools, llvm, clang-unwrapped, dualAs ? false }:

# Make sure both underlying packages claim to have prepended their binaries
# with the same targetPrefix.
assert binutils-unwrapped.targetPrefix == cctools.targetPrefix;

let
  inherit (binutils-unwrapped) targetPrefix;
  cmds = [
    "ar" "ranlib" "as" "install_name_tool"
    "ld" "strip" "otool" "lipo" "nm" "strings" "size"
    "codesign_allocate"
  ];
  isCCToolsLLVM = lib.getName cctools == "cctools-llvm";
in

# TODO: loop over targetPrefixed binaries too
stdenv.mkDerivation {
  pname = "${targetPrefix}cctools-binutils-darwin" + lib.optionalString dualAs "-dualas";
  inherit (cctools) version;
  outputs = [ "out" "man" ];
  buildCommand = ''
    mkdir -p $out/bin $out/include

    ln -s ${binutils-unwrapped.out}/bin/${targetPrefix}c++filt $out/bin/${targetPrefix}c++filt

    # We specifically need:
    # - ld: binutils doesn't provide it on darwin
    # - as: as above
    # - ar: the binutils one produces .a files that the cctools ld doesn't like
    # - ranlib: for compatibility with ar
    # - otool: we use it for some of our name mangling
    # - install_name_tool: we use it to rewrite stuff in our bootstrap tools
    # - strip: the binutils one seems to break mach-o files
    # - lipo: gcc build assumes it exists
    # - nm: the gnu one doesn't understand many new load commands
    for i in ${lib.concatStringsSep " " (map (e: targetPrefix + e) cmds)}; do
      ln -sf "${cctools}/bin/$i" "$out/bin/$i"
    done

    ln -s ${llvm}/bin/dsymutil $out/bin/dsymutil

    ln -s ${binutils-unwrapped.out}/share $out/share

    mkdir -p "$man"/share/man/man{1,5}
    for i in ${lib.concatStringsSep " " cmds}; do
      for path in "${cctools.man}"/share/man/man?/$i.*; do
        dest_path="$man''${path#${cctools.man}}"
        ln -sv "$path" "$dest_path"
      done
    done
  ''
  + lib.optionalString (!isCCToolsLLVM) (
    # cctools-port has a `libexec` folder for `as`, but cctools-llvm uses the clang
    # assembler on both platforms. Only link it when cctools is cctools-port.
    ''
      ln -s ${cctools}/libexec $out/libexec
    ''
    # cctools-llvm uses the LLVM assembler on both architectures, so use the assembler
    # from that instead of relinking it.
    #
    # On aarch64-darwin we must use clang, because "as" from cctools just doesn't
    # handle the arch. Proxying calls to clang produces quite a bit of warnings,
    # and using clang directly here is a better option than relying on cctools.
    # On x86_64-darwin the Clang version is too old to support this mode.
    + lib.optionalString stdenv.isAarch64 ''
      rm $out/bin/${targetPrefix}as
      makeWrapper "${clang-unwrapped}/bin/clang" "$out/bin/${targetPrefix}as" \
        --add-flags "-x assembler -integrated-as -c"
    ''
    # x86-64 Darwin gnat-bootstrap emits assembly
    # with MOVQ as the mnemonic for quadword interunit moves
    # such as `movq %rbp, %xmm0`.
    # The clang integrated assembler recognises this as valid,
    # but unfortunately the cctools-port GNU assembler does not;
    # it instead uses MOVD as the mnemonic.
    # The assembly that a GCC build emits is determined at build time
    # and cannot be changed afterwards.
    #
    # To build GNAT on x86-64 Darwin, therefore,
    # we need both the clang _and_ the cctools-port assemblers to be available:
    # the former to build at least the stage1 compiler,
    # and the latter at least to be detectable
    # as the target for the final compiler.
    #
    # We choose to match the Aarch64 case above,
    # wrapping the clang integrated assembler as `as`.
    # It then seems sensible to wrap the cctools GNU assembler as `gas`.
    #
    + lib.optionalString (stdenv.isx86_64 && dualAs) ''
      mv $out/bin/${targetPrefix}as $out/bin/${targetPrefix}gas
      makeWrapper "${clang-unwrapped}/bin/clang" "$out/bin/${targetPrefix}as" \
        --add-flags "-x assembler -integrated-as -c"
    ''
  );

  nativeBuildInputs = lib.optionals (!isCCToolsLLVM && (stdenv.isAarch64 || dualAs)) [ makeWrapper ];

  passthru = {
    inherit targetPrefix;
    isCCTools = true;
  };

  meta = {
    maintainers = with lib.maintainers; [ matthewbauer ];
    priority = 10;
  };
}