R 13 eproducibilit Y: NixOS

Is NixOS Reproducible?

Tracking: nixos-unstable's nixos.iso_gnome.x86_64-linux job for x86_64-linux.

Build via:

git clone https://github.com/nixos/nixpkgs.git
cd nixpkgs
git checkout a518c77148585023ff56022f09c4b2c418a51ef5
nix-build ./nixos/release-combined.nix -A nixos.nixos.iso_gnome.x86_64-linux

4621 out of 4855 (95.18%) paths in the nixos.iso_gnome.x86_64-linux installation image are reproducible!

27 unchecked

unreproduced paths

• /nix/store/vgpv5w9lxnrxkdvb4hx1llxp811fd8pk-python3-3.10.9.drv
• (diffoscope) out

unchecked paths

• /nix/store/0wkm2k57g3ralxvpcmqsf2dr0b3k9p0z-xfsprogs-6.1.0.tar.xz.drv
• /nix/store/icdgp9yvx5x75nvfq516axpgapnd1xsv-port-for-apache2.4.patch.drv
• /nix/store/jrbqizqpdf6zg86zzf57r0gwsbrcm48d-source-sans-3.046.drv
• /nix/store/xrrkml1647vn5904rirbykl3vgs4grhw-fluidsynth-2.3.0.drv
• /nix/store/ja7d82f3mfn1a7pbhrhbmz7r9slm9ylr-kitemviews-5.101.0.drv
• /nix/store/g05472by6rmpq9m5rhqkirrfc9y5106m-gnome-user-docs-43.0.drv
• /nix/store/wj1pv79j02cqf14mb72gv8jp7fkadq6q-python3.10-tkinter-3.10.9.drv
• /nix/store/y22p4wgzn2f7032hmlnrsvr28vs9y7lx-plymouth-unstable-2021-10-18.drv
• /nix/store/8br9dmq394z5wl2fqbc6zc8vb17jqlna-Glob-0.10.2.drv
• /nix/store/6ay1i3cp9p2p83pckrzav7ns9s129bz1-firefox-unwrapped-108.0.1.drv
• /nix/store/prrqi4lrvsrrn8ph4qvkv86m8vfzlxax-2d3798252807cad9eb061ed2b37e35170c1a1daf.patch.drv
• /nix/store/68ajg40jq9hxirlk13s434d7m4i2vcxc-attachment.cgi?id=361056.drv
• /nix/store/i55mc5rssxs1jp3bk22cpd34sl0k0jvn-attachment.cgi?id=359589.drv
• /nix/store/zvzcy2y731z474nv1lc0my61acmnclcr-orc-0.4.32.drv
• /nix/store/szddj704fxl7v27pzl1nvmqgaqrljwa3-gyre-fonts-2.005.drv
• /nix/store/82z9z91hvn2na3i8xw7w15b5g3inrhyb-clang-14.0.6.drv
• /nix/store/n16va7rwpr8xpy5spnkipdly8ky4i1dn-hdf5-1.12.2.drv
• /nix/store/hr3kg2d02gcgliad2iymwijgbqc31f0a-qtwebengine-v5.15.11.tar.gz.drv
• /nix/store/l5wgjfj28j76pang1grl5pxbhy93w9r8-cargo-c-0.9.13.drv
• /nix/store/z7zsiasmx5wqf6p02kackhrvny552jjs-gmime-2.6.23.drv
• /nix/store/yva05vmzalihz70fx6xf2z5lfgm3rr55-imlib2-1.9.1.drv
• /nix/store/vflfd55fayxp4l7vgvq0mb1k24119737-source-code-pro-2.038.drv
• /nix/store/jdx2liv0y3qaayjb2s5jnxcw7h6dm9cc-llvm-12.0.1.drv
• /nix/store/d67zl5ba2iji2yw3vsajay68ccbqa0r2-ghc-9.2.4.drv
• /nix/store/6mr2fs8z9arz8wfc357szvcnz3vvmxv4-qtbase-5.15.7.drv
• /nix/store/4fhzrrl50nyr4q2j0z20jb3z399r94g7-nftables-1.0.6.drv
• /nix/store/zhd47vcb4r1y1z1m4wnmj4d39axrmsgk-re2-2022-12-01.drv

How are these tested?

Each build is run twice, at different times, on different hardware running different kernels.

How confident can we be in the results?

Fairly. We don't currently inject randomness at the filesystem layer, but many of the reproducibility issues are being exercised already. It isn't possible to guarantee a package is reproducible, just like it isn't possible to prove software is bug-free. It is possible there is nondeterminism in a package source, waiting for some specific circumstance.

This is why we run these tests: to track how we are doing over time, to submit bug fixes for nondeterminism when we find them.

How can I help?

• Look at issues and pull requests with the 'reproducible builds' label.
• Open new issues/PR's for reproducibility problems (like the ones reported above)
• Join the #reproducible-builds:nixos.org room on Matrix

How can we do better?

There are further steps we could take. For example, the next likely step is using disorderfs which injects additional nondeterminism by reordering directory entries.

How can I test my patches?

Nix has built-in support for checking a path is reproducible. There are two routes.

Pretending you are debugging a nondeterminism bug in hello. To check it, you build the package, and then build it again with --check --keep-failed. This will provide the differing output in a separate directory which you can use diffoscope on.

$ nix-build . -A hello
$ nix-build . -A hello --check --keep-failed
[...snip...]
error: derivation '/nix/store/...hello.drv' may not be deterministic:
output '/nix/store/...-hello' differs from '/nix/store/...hello.check'
$ diffoscope /nix/store/...hello /nix/store/...hello.check

Note: the .check output is not a valid store path, and will automatically be deleted on the next run of the Nix garbage collector.

There is support for an automatic diff-hook in Nix 2, but it is much more complicated to set up. If you would like to work on this, or need help setting it up, contact us on Matrix. We can work together to write docs on how to use it.