about summary refs log tree commit diff
path: root/pkgs/servers/sql/mariadb/default.nix
blob: dfa16d47968e3e7e9d62e9c832b7b18f2bdae180 (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
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
let
  # shared across all versions
  generic =
    { version, hash
    , lib, stdenv, fetchurl, nixosTests, buildPackages
    # Native buildInputs components
    , bison, boost, cmake, fixDarwinDylibNames, flex, makeWrapper, pkg-config
    # Common components
    , curl, libiconv, ncurses, openssl, pcre2
    , libkrb5, libaio, liburing, systemd
    , CoreServices, cctools, perl
    , jemalloc, less, libedit
    # Server components
    , bzip2, lz4, lzo, snappy, xz, zlib, zstd
    , cracklib, judy, libevent, libxml2
    , linux-pam, numactl
    , fmt_8
    , withStorageMroonga ? true, kytea, libsodium, msgpack, zeromq
    , withStorageRocks ? true
    , withEmbedded ? false
    , withNuma ? false
    }:

  let
    isCross = stdenv.buildPlatform != stdenv.hostPlatform;

    libExt = stdenv.hostPlatform.extensions.sharedLibrary;

    mytopEnv = buildPackages.perl.withPackages (p: with p; [ DBDmysql DBI TermReadKey ]);

    common = rec { # attributes common to both builds
      inherit version;

      src = fetchurl {
        url = "https://downloads.mariadb.com/MariaDB/mariadb-${version}/source/mariadb-${version}.tar.gz";
        inherit hash;
      };

      outputs = [ "out" "man" ];

      nativeBuildInputs = [ cmake pkg-config ]
        ++ lib.optional stdenv.hostPlatform.isDarwin fixDarwinDylibNames
        ++ lib.optional (!stdenv.hostPlatform.isDarwin) makeWrapper;

      buildInputs = [
        libiconv ncurses zlib
        pcre2
        openssl
        curl
      ] ++ lib.optionals stdenv.hostPlatform.isLinux ([ libkrb5 systemd ]
        ++ (if (lib.versionOlder version "10.6") then [ libaio ] else [ liburing ]))
        ++ lib.optionals stdenv.hostPlatform.isDarwin [ CoreServices cctools perl libedit ]
        ++ lib.optionals (!stdenv.hostPlatform.isDarwin) [ jemalloc ];

      prePatch = ''
        sed -i 's,[^"]*/var/log,/var/log,g' storage/mroonga/vendor/groonga/CMakeLists.txt
      '';

      patches = [
        ./patch/cmake-includedir.patch
      ]
        # Fixes a build issue as documented on
        # https://jira.mariadb.org/browse/MDEV-26769?focusedCommentId=206073&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-206073
        ++ lib.optional (!stdenv.hostPlatform.isLinux && lib.versionAtLeast version "10.6") ./patch/macos-MDEV-26769-regression-fix.patch;

      cmakeFlags = [
        "-DBUILD_CONFIG=mysql_release"
        "-DMANUFACTURER=nixos.org"
        "-DDEFAULT_CHARSET=utf8mb4"
        "-DDEFAULT_COLLATION=utf8mb4_unicode_ci"
        "-DSECURITY_HARDENED=ON"

        "-DINSTALL_UNIX_ADDRDIR=/run/mysqld/mysqld.sock"
        "-DINSTALL_BINDIR=bin"
        "-DINSTALL_DOCDIR=share/doc/mysql"
        "-DINSTALL_DOCREADMEDIR=share/doc/mysql"
        "-DINSTALL_INCLUDEDIR=include/mysql"
        "-DINSTALL_LIBDIR=lib"
        "-DINSTALL_PLUGINDIR=lib/mysql/plugin"
        "-DINSTALL_INFODIR=share/mysql/docs"
        "-DINSTALL_MANDIR=share/man"
        "-DINSTALL_MYSQLSHAREDIR=share/mysql"
        "-DINSTALL_SCRIPTDIR=bin"
        "-DINSTALL_SUPPORTFILESDIR=share/doc/mysql"
        "-DINSTALL_MYSQLTESTDIR=OFF"
        "-DINSTALL_SQLBENCHDIR=OFF"
        "-DINSTALL_PAMDIR=share/pam/lib/security"
        "-DINSTALL_PAMDATADIR=share/pam/etc/security"

        "-DWITH_ZLIB=system"
        "-DWITH_SSL=system"
        "-DWITH_PCRE=system"
        "-DWITH_SAFEMALLOC=OFF"
        "-DWITH_UNIT_TESTS=OFF"
        "-DEMBEDDED_LIBRARY=OFF"
      ] ++ lib.optionals stdenv.hostPlatform.isDarwin [
        # On Darwin without sandbox, CMake will find the system java and attempt to build with java support, but
        # then it will fail during the actual build. Let's just disable the flag explicitly until someone decides
        # to pass in java explicitly.
        "-DCONNECT_WITH_JDBC=OFF"
        "-DCURSES_LIBRARY=${ncurses.out}/lib/libncurses.dylib"
      ] ++ lib.optionals (stdenv.hostPlatform.isDarwin && lib.versionAtLeast version "10.6") [
        # workaround for https://jira.mariadb.org/browse/MDEV-29925
        "-Dhave_C__Wl___as_needed="
      ] ++ lib.optionals isCross [
        # revisit this if nixpkgs supports any architecture whose stack grows upwards
        "-DSTACK_DIRECTION=-1"
        "-DCMAKE_CROSSCOMPILING_EMULATOR=${stdenv.hostPlatform.emulator buildPackages}"
      ];

      postInstall = lib.optionalString (!withEmbedded) ''
        # Remove Development components. Need to use libmysqlclient.
        rm "$out"/lib/mysql/plugin/daemon_example.ini
        rm "$out"/lib/{libmariadb.a,libmariadbclient.a,libmysqlclient.a,libmysqlclient_r.a,libmysqlservices.a}
        rm -f "$out"/bin/{mariadb-config,mariadb_config,mysql_config}
        rm -r $out/include
        rm -r $out/lib/pkgconfig
      '';

      # perlPackages.DBDmysql is broken on darwin
      postFixup = lib.optionalString (!stdenv.hostPlatform.isDarwin) ''
        wrapProgram $out/bin/mytop --set PATH ${lib.makeBinPath [ less ncurses ]}
      '';

      passthru.tests = let
        testVersion = "mariadb_${builtins.replaceStrings ["."] [""] (lib.versions.majorMinor version)}";
      in {
        mariadb-galera-rsync = nixosTests.mariadb-galera.${testVersion};
        mysql = nixosTests.mysql.${testVersion};
        mysql-autobackup = nixosTests.mysql-autobackup.${testVersion};
        mysql-backup = nixosTests.mysql-backup.${testVersion};
        mysql-replication = nixosTests.mysql-replication.${testVersion};
      };

      meta = with lib; {
        description = "Enhanced, drop-in replacement for MySQL";
        homepage    = "https://mariadb.org/";
        license     = licenses.gpl2Plus;
        maintainers = with maintainers; [ thoughtpolice ] ++ teams.helsinki-systems.members;
        platforms   = platforms.all;
      };
    };

    client = stdenv.mkDerivation (common // {
      pname = "mariadb-client";

      patches = common.patches ++ [
        ./patch/cmake-plugin-includedir.patch
      ];

      buildInputs = common.buildInputs
        ++ lib.optionals (lib.versionAtLeast common.version "10.7") [ fmt_8 ];

      cmakeFlags = common.cmakeFlags ++ [
        "-DPLUGIN_AUTH_PAM=NO"
        "-DWITHOUT_SERVER=ON"
        "-DWITH_WSREP=OFF"
        "-DINSTALL_MYSQLSHAREDIR=share/mysql-client"
      ];

      postInstall = common.postInstall + ''
        rm "$out"/bin/{mariadb-test,mysqltest}
        libmysqlclient_path=$(readlink -f $out/lib/libmysqlclient${libExt})
        rm "$out"/lib/{libmariadb${libExt},libmysqlclient${libExt},libmysqlclient_r${libExt}}
        mv "$libmysqlclient_path" "$out"/lib/libmysqlclient${libExt}
        ln -sv libmysqlclient${libExt} "$out"/lib/libmysqlclient_r${libExt}
      '';
    });

    server = stdenv.mkDerivation (common // {
      pname = "mariadb-server";

      nativeBuildInputs = common.nativeBuildInputs ++ [ bison boost.dev flex ];

      buildInputs = common.buildInputs ++ [
        bzip2 lz4 lzo snappy xz zstd
        cracklib judy libevent libxml2
      ] ++ lib.optional withNuma numactl
        ++ lib.optionals stdenv.hostPlatform.isLinux [ linux-pam ]
        ++ lib.optional (!stdenv.hostPlatform.isDarwin) mytopEnv
        ++ lib.optionals withStorageMroonga [ kytea libsodium msgpack zeromq ]
        ++ lib.optionals (lib.versionAtLeast common.version "10.7") [ fmt_8 ];

      propagatedBuildInputs = lib.optional withNuma numactl;

      postPatch = ''
        substituteInPlace scripts/galera_new_cluster.sh \
          --replace ":-mariadb" ":-mysql"
      '';

      cmakeFlags = common.cmakeFlags ++ [
        "-DMYSQL_DATADIR=/var/lib/mysql"
        "-DENABLED_LOCAL_INFILE=OFF"
        "-DWITH_READLINE=ON"
        "-DWITH_EXTRA_CHARSETS=all"
        "-DWITH_EMBEDDED_SERVER=${if withEmbedded then "ON" else "OFF"}"
        "-DWITH_UNIT_TESTS=OFF"
        "-DWITH_WSREP=ON"
        "-DWITH_INNODB_DISALLOW_WRITES=ON"
        "-DWITHOUT_EXAMPLE=1"
        "-DWITHOUT_FEDERATED=1"
        "-DWITHOUT_TOKUDB=1"
      ] ++ lib.optionals withNuma [
        "-DWITH_NUMA=ON"
      ] ++ lib.optionals (!withStorageMroonga) [
        "-DWITHOUT_MROONGA=1"
      ] ++ lib.optionals (!withStorageRocks) [
        "-DWITHOUT_ROCKSDB=1"
      ] ++ lib.optionals (!stdenv.hostPlatform.isDarwin && withStorageRocks) [
        "-DWITH_ROCKSDB_JEMALLOC=ON"
      ] ++ lib.optionals (!stdenv.hostPlatform.isDarwin) [
        "-DWITH_JEMALLOC=yes"
      ] ++ lib.optionals stdenv.hostPlatform.isDarwin [
        "-DPLUGIN_AUTH_PAM=NO"
        "-DPLUGIN_AUTH_PAM_V1=NO"
        "-DWITHOUT_OQGRAPH=1"
        "-DWITHOUT_PLUGIN_S3=1"
      ];

      preConfigure = lib.optionalString (!stdenv.hostPlatform.isDarwin) ''
        patchShebangs scripts/mytop.sh
      '';

      postInstall = common.postInstall + ''
        rm -r "$out"/share/aclocal
        chmod +x "$out"/bin/wsrep_sst_common
        rm -f "$out"/bin/{mariadb-client-test,mariadb-test,mysql_client_test,mysqltest}
      '' + lib.optionalString withStorageMroonga ''
        mv "$out"/share/{groonga,groonga-normalizer-mysql} "$out"/share/doc/mysql
      '' + lib.optionalString (!stdenv.hostPlatform.isDarwin && lib.versionAtLeast common.version "10.4") ''
        mv "$out"/OFF/suite/plugins/pam/pam_mariadb_mtr.so "$out"/share/pam/lib/security
        mv "$out"/OFF/suite/plugins/pam/mariadb_mtr "$out"/share/pam/etc/security
        rm -r "$out"/OFF
      '';

      CXXFLAGS = lib.optionalString stdenv.hostPlatform.isi686 "-fpermissive";
    });
  in
    server // {
      inherit client server;
    };
in
  self: {
    # see https://mariadb.org/about/#maintenance-policy for EOLs
    mariadb_105 = self.callPackage generic {
      # Supported until 2025-06-24
      # TODO should be removed
      version = "10.5.25";
      hash = "sha256-lhnQ9R6GQ1dGayxjMBo0pT99/ZnxjE/UUvqyK/Obpk4=";
      inherit (self.darwin.apple_sdk.frameworks) CoreServices;
    };
    mariadb_106 = self.callPackage generic {
      # Supported until 2026-07-06
      version = "10.6.18";
      hash = "sha256-aJihER9HEwcJ4ouix70aV+S7VxAfbhCeWX1R5tOFzxg=";
      inherit (self.darwin.apple_sdk.frameworks) CoreServices;
    };
    mariadb_1011 = self.callPackage generic {
      # Supported until 2028-02-16
      version = "10.11.8";
      hash = "sha256-XwTz4z2fHL7/BeecVNQdMCYwUAyZWu5ysGOOL5383w8=";
      inherit (self.darwin.apple_sdk.frameworks) CoreServices;
    };
    mariadb_110 = self.callPackage generic {
      # Supported until 2024-06-07
      # TODO should be removed
      version = "11.0.6";
      hash = "sha256-AYnWKUbDfG20a/GkaLqVgLy6joDwWVjsSDwzh+zPmgA=";
      inherit (self.darwin.apple_sdk.frameworks) CoreServices;
    };
  }