summaryrefslogtreecommitdiffstats
path: root/pkgs/development/libraries/zlib/default.nix
blob: a400e4b60c63ce08deb2cc0cc2ef31c4feb070f9 (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
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
175
{
  lib,
  stdenv,
  fetchurl,
  shared ? !stdenv.hostPlatform.isStatic,
  # zlib's hand-written `./configure` script is a bit buggy, and it always
  # builds the static library. The `--enable-shared` argument (alias to
  # `--shared`) makes it build the shared library too. The `--static` argument
  # is particularly confusing - if used after `--shared` it disables the build
  # of the shared library. See also:
  #
  # - https://github.com/madler/zlib/pull/394
  #
  # Since --static is aliased to --disable-shared, we use this flag in the
  # `configureFlags` below, along with a few more relevant arguments to
  # `stdenv.mkDerivation`.
  #
  # We avoid the closure size penalty of this buggy upstream behavior by using
  # a dedicated output for the static library, which is fortuenatly also
  # supported by the `--libdir` argument to `./configure`.
  splitStaticOutput ? shared && !(stdenv.hostPlatform.isWindows || stdenv.hostPlatform.isCygwin),
  testers,
  minizip,
}:

# Note: this package is used for bootstrapping fetchurl, and thus
# cannot use fetchpatch! All mutable patches (generated by GitHub or
# cgit) that are needed here should be included directly in Nixpkgs as
# files.

stdenv.mkDerivation (finalAttrs: {
  pname = "zlib";
  version = "1.3.2";

  src =
    let
      inherit (finalAttrs) version;
    in
    fetchurl {
      urls = [
        # This URL works for 1.2.13 only; hopefully also for future releases.
        "https://github.com/madler/zlib/releases/download/v${version}/zlib-${version}.tar.gz"
        # Stable archive path, but captcha can be encountered, causing hash mismatch.
        "https://www.zlib.net/fossils/zlib-${version}.tar.gz"
      ];
      hash = "sha256-uzKaCizQJ00FUZ1hxmfAYuBpkNcuEl7i36jeZPARnRY=";
    };

  # https://github.com/madler/zlib/pull/1171
  patches = [
    ./export-variable.patch
  ];

  postPatch = ''
    substituteInPlace configure \
      --replace-fail '/usr/bin/libtool' '${stdenv.cc.targetPrefix}ar' \
      --replace-fail 'AR="libtool"' 'AR="${stdenv.cc.targetPrefix}ar"' \
      --replace-fail 'ARFLAGS="-o"' 'ARFLAGS="-r"'
    substituteInPlace win32/zlib.def \
      --replace-fail 'gzopen_w' ""
  '';

  strictDeps = true;
  outputs = [
    "out"
    "dev"
  ]
  ++ lib.optional splitStaticOutput "static";
  setOutputFlags = false;
  outputDoc = "dev"; # single tiny man3 page

  dontConfigure = (stdenv.hostPlatform.isMinGW || stdenv.hostPlatform.isCygwin);

  preConfigure = lib.optionalString (stdenv.hostPlatform != stdenv.buildPlatform) ''
    export CHOST=${stdenv.hostPlatform.config}
  '';

  configureFlags = [
    "--includedir=${placeholder "dev"}/include"
    "--sharedlibdir=${placeholder "out"}/lib"
    "--libdir=${placeholder (if splitStaticOutput then "static" else "out")}/lib"
    # See comment near splitStaticOutput argument
    (lib.enableFeature shared "shared")
  ];
  dontDisableStatic = true;
  dontAddStaticConfigureFlags = true;

  # Note we don't need to set `dontDisableStatic`, because static-disabling
  # works by grepping for `enable-static` in the `./configure` script
  # (see `pkgs/stdenv/generic/setup.sh`), and zlib's handwritten one does
  # not have such.
  # It wouldn't hurt setting `dontDisableStatic = static && !splitStaticOutput`
  # here (in case zlib ever switches to autoconf in the future),
  # but we don't do it simply to avoid mass rebuilds.

  postInstall =
    # jww (2015-01-06): Sometimes this library install as a .so, even on
    # Darwin; others time it installs as a .dylib.  I haven't yet figured out
    # what causes this difference.
    lib.optionalString stdenv.hostPlatform.isDarwin ''
      for file in $out/lib/*.so* $out/lib/*.dylib* ; do
        ${stdenv.cc.bintools.targetPrefix}install_name_tool -id "$file" $file
      done
    ''
    # Non-typical naming confuses libtool which then refuses to use zlib's DLL
    # in some cases, e.g. when compiling libpng.
    + lib.optionalString (stdenv.hostPlatform.isMinGW && shared) ''
      ln -s zlib1.dll $out/bin/libz.dll
    '';

  env =
    lib.optionalAttrs (!stdenv.hostPlatform.isDarwin) {
      # As zlib takes part in the stdenv building, we don't want references
      # to the bootstrap-tools libgcc (as uses to happen on arm/mips)
      NIX_CFLAGS_COMPILE = toString (
        [ "-static-libgcc" ] ++ lib.optional stdenv.hostPlatform.isCygwin "-DHAVE_UNISTD_H"
      );
    }
    // lib.optionalAttrs (stdenv.hostPlatform.linker == "lld") {
      # lld 16 enables --no-undefined-version by default
      # This makes configure think it can't build dynamic libraries
      # this may be removed when a version is packaged with https://github.com/madler/zlib/issues/960 fixed
      NIX_LDFLAGS = "--undefined-version";
    };

  # We don't strip on static cross-compilation because of reports that native
  # stripping corrupted the target library; see commit 12e960f5 for the report.
  dontStrip = stdenv.hostPlatform != stdenv.buildPlatform;
  configurePlatforms = [ ];

  installFlags = lib.optionals (stdenv.hostPlatform.isMinGW || stdenv.hostPlatform.isCygwin) [
    "BINARY_PATH=$(out)/bin"
    "INCLUDE_PATH=$(dev)/include"
    "LIBRARY_PATH=$(out)/lib"
  ];

  enableParallelBuilding = true;
  doCheck = true;

  makeFlags = [
    "PREFIX=${stdenv.cc.targetPrefix}"
    "pkgconfigdir=${placeholder "dev"}/share/pkgconfig"
  ]
  ++ lib.optionals (stdenv.hostPlatform.isMinGW || stdenv.hostPlatform.isCygwin) [
    "-f"
    "win32/Makefile.gcc"
  ]
  ++ lib.optionals stdenv.hostPlatform.isCygwin [
    "SHAREDLIB=cygz.dll"
    "IMPLIB=libz.dll.a"
  ]
  ++ lib.optionals shared [
    # Note that as of writing (zlib 1.2.11), this flag only has an effect
    # for Windows as it is specific to `win32/Makefile.gcc`.
    "SHARED_MODE=1"
  ];

  passthru.tests = {
    pkg-config = testers.testMetaPkgConfig finalAttrs.finalPackage;
    # uses `zlib` derivation:
    inherit minizip;
  };

  __structuredAttrs = true;

  meta = {
    homepage = "https://zlib.net";
    description = "Lossless data-compression library";
    license = lib.licenses.zlib;
    platforms = lib.platforms.all;
    pkgConfigModules = [ "zlib" ];
    teams = [ lib.teams.security-review ];
    identifiers.cpeParts = lib.meta.cpeFullVersionWithVendor "zlib" finalAttrs.version;
  };
})