about summary refs log tree commit diff
path: root/nixpkgs/pkgs/build-support/rust/build-rust-package/default.nix
blob: 8707ce08470580353ed0d00e1c6d73e6a3602433 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
{ lib
, importCargoLock
, fetchCargoTarball
, stdenv
, callPackage
, cargoBuildHook
, cargoCheckHook
, cargoInstallHook
, cargoNextestHook
, cargoSetupHook
, cargo
, cargo-auditable
, buildPackages
, rustc
, libiconv
, windows
}:

let
  buildRustPackage =
    { name ? "${args.pname}-${args.version}"

      # Name for the vendored dependencies tarball
    , cargoDepsName ? name

    , src ? null
    , srcs ? null
    , preUnpack ? null
    , unpackPhase ? null
    , postUnpack ? null
    , cargoPatches ? []
    , patches ? []
    , sourceRoot ? null
    , logLevel ? ""
    , buildInputs ? []
    , nativeBuildInputs ? []
    , cargoUpdateHook ? ""
    , cargoDepsHook ? ""
    , buildType ? "release"
    , meta ? {}
    , cargoLock ? null
    , cargoVendorDir ? null
    , checkType ? buildType
    , buildNoDefaultFeatures ? false
    , checkNoDefaultFeatures ? buildNoDefaultFeatures
    , buildFeatures ? [ ]
    , checkFeatures ? buildFeatures
    , useNextest ? false
    , auditable ? !cargo-auditable.meta.broken

    , depsExtraArgs ? {}

    # Toggles whether a custom sysroot is created when the target is a .json file.
    , __internal_dontAddSysroot ? false

    # Needed to `pushd`/`popd` into a subdir of a tarball if this subdir
    # contains a Cargo.toml, but isn't part of a workspace (which is e.g. the
    # case for `rustfmt`/etc from the `rust-sources).
    # Otherwise, everything from the tarball would've been built/tested.
    , buildAndTestSubdir ? null
    , ... } @ args:

    assert cargoVendorDir == null && cargoLock == null
        -> !(args ? cargoSha256 && args.cargoSha256 != null) && !(args ? cargoHash && args.cargoHash != null)
        -> throw "cargoSha256, cargoHash, cargoVendorDir, or cargoLock must be set";

    let

      cargoDeps =
        if cargoVendorDir != null then null
        else if cargoLock != null then importCargoLock cargoLock
        else fetchCargoTarball ({
          inherit src srcs sourceRoot preUnpack unpackPhase postUnpack cargoUpdateHook;
          name = cargoDepsName;
          patches = cargoPatches;
        } // lib.optionalAttrs (args ? cargoHash) {
          hash = args.cargoHash;
        } // lib.optionalAttrs (args ? cargoSha256) {
          sha256 = args.cargoSha256;
        } // depsExtraArgs);

      target = stdenv.hostPlatform.rust.rustcTargetSpec;
      targetIsJSON = lib.hasSuffix ".json" target;
      useSysroot = targetIsJSON && !__internal_dontAddSysroot;

      sysroot = callPackage ./sysroot { } {
        inherit target;
        shortTarget = stdenv.hostPlatform.rust.cargoShortTarget;
        RUSTFLAGS = args.RUSTFLAGS or "";
        originalCargoToml = src + /Cargo.toml; # profile info is later extracted
      };

    in

    # Tests don't currently work for `no_std`, and all custom sysroots are currently built without `std`.
    # See https://os.phil-opp.com/testing/ for more information.
    assert useSysroot -> !(args.doCheck or true);

    stdenv.mkDerivation ((removeAttrs args [ "depsExtraArgs" "cargoUpdateHook" "cargoLock" ]) // lib.optionalAttrs useSysroot {
      RUSTFLAGS = "--sysroot ${sysroot} " + (args.RUSTFLAGS or "");
    } // {
      inherit buildAndTestSubdir cargoDeps;

      cargoBuildType = buildType;

      cargoCheckType = checkType;

      cargoBuildNoDefaultFeatures = buildNoDefaultFeatures;

      cargoCheckNoDefaultFeatures = checkNoDefaultFeatures;

      cargoBuildFeatures = buildFeatures;

      cargoCheckFeatures = checkFeatures;

      patchRegistryDeps = ./patch-registry-deps;

      nativeBuildInputs = nativeBuildInputs ++ lib.optionals auditable [
        (buildPackages.cargo-auditable-cargo-wrapper.override {
          inherit cargo cargo-auditable;
        })
      ] ++ [
        cargoBuildHook
        (if useNextest then cargoNextestHook else cargoCheckHook)
        cargoInstallHook
        cargoSetupHook
        rustc
      ];

      buildInputs = buildInputs
        ++ lib.optionals stdenv.hostPlatform.isDarwin [ libiconv ]
        ++ lib.optionals stdenv.hostPlatform.isMinGW [ windows.pthreads ];

      patches = cargoPatches ++ patches;

      PKG_CONFIG_ALLOW_CROSS =
        if stdenv.buildPlatform != stdenv.hostPlatform then 1 else 0;

      postUnpack = ''
        eval "$cargoDepsHook"

        export RUST_LOG=${logLevel}
      '' + (args.postUnpack or "");

      configurePhase = args.configurePhase or ''
        runHook preConfigure
        runHook postConfigure
      '';

      doCheck = args.doCheck or true;

      strictDeps = true;

      meta = {
        # default to Rust's platforms
        platforms = rustc.meta.platforms ++ [
          # Platforms without host tools from
          # https://doc.rust-lang.org/nightly/rustc/platform-support.html
          "armv7a-darwin"
          "armv5tel-linux" "armv7a-linux" "m68k-linux" "mipsel-linux"
          "mips64el-linux" "riscv32-linux"
          "armv6l-netbsd"
          "x86_64-redox"
          "wasm32-wasi"
        ];
        badPlatforms = [
          # Rust is currently unable to target the n32 ABI
          lib.systems.inspect.patterns.isMips64n32
        ];
      } // meta;
    }) // {
      overrideRustAttrs = f: buildRustPackage (args // (f args));
    };
in buildRustPackage