summaryrefslogtreecommitdiffstats
path: root/nixos/lib/make-squashfs.nix
blob: cb861acbc373eff1c4294478ee70b2542f789222 (plain)
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
{
  lib,
  stdenv,
  squashfs-tools,
  closureInfo,

  fileName ? "squashfs",
  # The root directory of the squashfs filesystem is filled with the
  # closures of the Nix store paths listed here.
  storeContents ? [ ],
  # Pseudo files to be added to squashfs image
  pseudoFiles ? [ ],
  noStrip ? false,
  # Compression parameters.
  # For zstd compression you can use "zstd -Xcompression-level 6".
  comp ? "xz -Xdict-size 100%",
  # create hydra build product. will put image in directory instead
  # of directly in the store
  hydraBuildProduct ? false,
}:

let
  pseudoFilesArgs = lib.concatMapStrings (f: ''-p "${f}" '') pseudoFiles;
  compFlag = if comp == null then "-no-compression" else "-comp ${comp}";
in
stdenv.mkDerivation {
  name = "${fileName}${lib.optionalString (!hydraBuildProduct) ".img"}";
  __structuredAttrs = true;

  # the image will be self-contained so we can drop references
  # to the closure that was used to build it
  unsafeDiscardReferences.out = true;

  nativeBuildInputs = [ squashfs-tools ];

  buildCommand = ''
    closureInfo=${closureInfo { rootPaths = storeContents; }}

    # Also include a manifest of the closures in a format suitable
    # for nix-store --load-db.
    cp $closureInfo/registration nix-path-registration

    imgPath="$out"
  ''
  + lib.optionalString hydraBuildProduct ''

    mkdir $out
    imgPath="$out/${fileName}.squashfs"
  ''
  + lib.optionalString stdenv.buildPlatform.is32bit ''

    # 64 cores on i686 does not work
    # fails with FATAL ERROR: mangle2:: xz compress failed with error code 5
    if ((NIX_BUILD_CORES > 48)); then
      NIX_BUILD_CORES=48
    fi
  ''
  + ''

    # Generate the squashfs image.
    # We have to set SOURCE_DATE_EPOCH to 0 here for reproducibility (https://github.com/NixOS/nixpkgs/issues/390696)
    SOURCE_DATE_EPOCH=0 mksquashfs nix-path-registration $(cat $closureInfo/store-paths) $imgPath ${pseudoFilesArgs} \
      -no-hardlinks ${lib.optionalString noStrip "-no-strip"} -keep-as-directory -all-root -b 1048576 ${compFlag} \
      -processors $NIX_BUILD_CORES -root-mode 0755
  ''
  + lib.optionalString hydraBuildProduct ''

    mkdir -p $out/nix-support
    echo "file squashfs-image $out/${fileName}.squashfs" >> $out/nix-support/hydra-build-products
  '';
}