summaryrefslogtreecommitdiff
path: root/pkgs/development/interpreters/erlang/generic-builder.nix
blob: 7c33178708dd4dffff9ad2fb462c757483f45d08 (about) (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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
{
  lib,
  stdenv,
  fetchFromGitHub,
  makeWrapper,
  gawk,
  gnum4,
  gnused,
  libxml2,
  libxslt,
  ncurses,
  openssl,
  perl,
  runtimeShell,
  openjdk11 ? null, # javacSupport
  unixODBC ? null, # odbcSupport
  libGL ? null,
  libGLU ? null,
  wxGTK ? null,
  xorg ? null,
  parallelBuild ? false,
  systemd,
  wxSupport ? true,
  # systemd support for epmd
  systemdSupport ? lib.meta.availableOn stdenv.hostPlatform systemd,
  # updateScript deps
  writeScript,
  common-updater-scripts,
  coreutils,
  git,
  wrapGAppsHook3,
  zlib,
}:
{
  baseName ? "erlang",
  version,
  sha256 ? null,
  rev ? "OTP-${version}",
  src ? fetchFromGitHub {
    inherit rev sha256;
    owner = "erlang";
    repo = "otp";
  },
  enableHipe ? true,
  enableDebugInfo ? false,
  enableThreads ? true,
  enableSmpSupport ? true,
  enableKernelPoll ? true,
  javacSupport ? false,
  javacPackages ? [ openjdk11 ],
  odbcSupport ? false,
  odbcPackages ? [ unixODBC ],
  opensslPackage ? openssl,
  systemdSupport ? lib.meta.availableOn stdenv.hostPlatform systemd,
  wxPackages ? [
    libGL
    libGLU
    wxGTK
    xorg.libX11
    wrapGAppsHook3
  ],
  preUnpack ? "",
  postUnpack ? "",
  patches ? [ ],
  patchPhase ? "",
  prePatch ? "",
  postPatch ? "",
  configureFlags ? [ ],
  configurePhase ? "",
  preConfigure ? "",
  postConfigure ? "",
  buildPhase ? "",
  preBuild ? "",
  postBuild ? "",
  installPhase ? "",
  preInstall ? "",
  postInstall ? "",
  checkPhase ? "",
  preCheck ? "",
  postCheck ? "",
  fixupPhase ? "",
  preFixup ? "",
  postFixup ? "",
  meta ? { },
}:

assert
  wxSupport
  -> (
    if stdenv.hostPlatform.isDarwin then
      wxGTK != null
    else
      libGL != null && libGLU != null && wxGTK != null && xorg != null
  );

assert odbcSupport -> unixODBC != null;
assert javacSupport -> openjdk11 != null;

let
  inherit (lib)
    optional
    optionals
    optionalAttrs
    optionalString
    ;
  wxPackages2 = if stdenv.hostPlatform.isDarwin then [ wxGTK ] else wxPackages;

in
stdenv.mkDerivation (
  {
    # name is used instead of pname to
    # - not have to pass pnames as argument
    # - have a separate pname for erlang (main module)
    name =
      "${baseName}"
      + optionalString javacSupport "_javac"
      + optionalString odbcSupport "_odbc"
      + "-${version}";

    inherit src version;

    LANG = "C.UTF-8";

    nativeBuildInputs = [
      makeWrapper
      perl
      gnum4
      libxslt
      libxml2
    ];

    env = {
      # only build shell/IDE docs and man pages
      DOC_TARGETS = "chunks man";
    };

    buildInputs =
      [
        ncurses
        opensslPackage
        zlib
      ]
      ++ optionals wxSupport wxPackages2
      ++ optionals odbcSupport odbcPackages
      ++ optionals javacSupport javacPackages
      ++ optional systemdSupport systemd;

    debugInfo = enableDebugInfo;

    # On some machines, parallel build reliably crashes on `GEN    asn1ct_eval_ext.erl` step
    enableParallelBuilding = parallelBuild;

    postPatch =
      ''
        patchShebangs make

        ${postPatch}
      ''
      + optionalString (lib.versionOlder "25" version) ''
        substituteInPlace lib/os_mon/src/disksup.erl \
          --replace-fail '"sh ' '"${runtimeShell} '
      '';

    configureFlags =
      [ "--with-ssl=${lib.getOutput "out" opensslPackage}" ]
      ++ [ "--with-ssl-incl=${lib.getDev opensslPackage}" ] # This flag was introduced in R24
      ++ optional enableThreads "--enable-threads"
      ++ optional enableSmpSupport "--enable-smp-support"
      ++ optional enableKernelPoll "--enable-kernel-poll"
      ++ optional enableHipe "--enable-hipe"
      ++ optional javacSupport "--with-javac"
      ++ optional odbcSupport "--with-odbc=${unixODBC}"
      ++ optional wxSupport "--enable-wx"
      ++ optional systemdSupport "--enable-systemd"
      ++ optional stdenv.hostPlatform.isDarwin "--enable-darwin-64bit"
      # make[3]: *** [yecc.beam] Segmentation fault: 11
      ++ optional (stdenv.hostPlatform.isDarwin && stdenv.hostPlatform.isx86_64) "--disable-jit"
      ++ configureFlags;

    # install-docs will generate and install manpages and html docs
    # (PDFs are generated only when fop is available).
    installTargets = [
      "install"
      "install-docs"
    ];

    postInstall = ''
      ln -s $out/lib/erlang/lib/erl_interface*/bin/erl_call $out/bin/erl_call

      ${postInstall}
    '';

    # Some erlang bin/ scripts run sed and awk
    postFixup = ''
      wrapProgram $out/lib/erlang/bin/erl --prefix PATH ":" "${gnused}/bin/"
      wrapProgram $out/lib/erlang/bin/start_erl --prefix PATH ":" "${
        lib.makeBinPath [
          gnused
          gawk
        ]
      }"
    '';

    passthru = {
      updateScript =
        let
          major = builtins.head (builtins.splitVersion version);
        in
        writeScript "update.sh" ''
          #!${stdenv.shell}
          set -ox errexit
          PATH=${
            lib.makeBinPath [
              common-updater-scripts
              coreutils
              git
              gnused
            ]
          }
          latest=$(list-git-tags --url=https://github.com/erlang/otp.git | sed -n 's/^OTP-${major}/${major}/p' | sort -V | tail -1)
          if [ "$latest" != "${version}" ]; then
            nixpkgs="$(git rev-parse --show-toplevel)"
            nix_file="$nixpkgs/pkgs/development/interpreters/erlang/${major}.nix"
            update-source-version ${baseName}_${major} "$latest" --version-key=version --print-changes --file="$nix_file"
          else
            echo "${baseName}R${major} is already up-to-date"
          fi
        '';
    };

    meta =
      with lib;
      (
        {
          homepage = "https://www.erlang.org/";
          downloadPage = "https://www.erlang.org/download.html";
          description = "Programming language used for massively scalable soft real-time systems";

          longDescription = ''
            Erlang is a programming language used to build massively scalable
            soft real-time systems with requirements on high availability.
            Some of its uses are in telecoms, banking, e-commerce, computer
            telephony and instant messaging. Erlang's runtime system has
            built-in support for concurrency, distribution and fault
            tolerance.
          '';

          platforms = platforms.unix;
          maintainers = teams.beam.members;
          license = licenses.asl20;
        }
        // meta
      );
  }
  // optionalAttrs (preUnpack != "") { inherit preUnpack; }
  // optionalAttrs (postUnpack != "") { inherit postUnpack; }
  // optionalAttrs (patches != [ ]) { inherit patches; }
  // optionalAttrs (prePatch != "") { inherit prePatch; }
  // optionalAttrs (patchPhase != "") { inherit patchPhase; }
  // optionalAttrs (configurePhase != "") { inherit configurePhase; }
  // optionalAttrs (preConfigure != "") { inherit preConfigure; }
  // optionalAttrs (postConfigure != "") { inherit postConfigure; }
  // optionalAttrs (buildPhase != "") { inherit buildPhase; }
  // optionalAttrs (preBuild != "") { inherit preBuild; }
  // optionalAttrs (postBuild != "") { inherit postBuild; }
  // optionalAttrs (checkPhase != "") { inherit checkPhase; }
  // optionalAttrs (preCheck != "") { inherit preCheck; }
  // optionalAttrs (postCheck != "") { inherit postCheck; }
  // optionalAttrs (installPhase != "") { inherit installPhase; }
  // optionalAttrs (preInstall != "") { inherit preInstall; }
  // optionalAttrs (fixupPhase != "") { inherit fixupPhase; }
  // optionalAttrs (preFixup != "") { inherit preFixup; }
  // optionalAttrs (postFixup != "") { inherit postFixup; }
)