From b4cd8e914018e4ec1ec6f82b265acfae910ea6a6 Mon Sep 17 00:00:00 2001
From: Benjamin Lee <benjamin@computer.surgery>
Date: Sat, 25 May 2024 18:04:17 -0700
Subject: [PATCH] fix dynamic builds with liburing

The original implementation of this was really weird, so I restructed it
a lot while debugging, and am just gonna leave the restructured version.

Root cause of the segfault seems to be that upstream nixpkgs liburing
derivation is generating both static and dynamic libraries, causing
rocksdb to statically link liburing in a dynamic build, pulling in some
allocator stuff at the same time. I created a PR[1] to fix this upstream,
but it probably won't be available on nixos-unstable for quite a while,
so we can also patch it locally.

[1]: https://github.com/NixOS/nixpkgs/pull/314945
---
 flake.nix                 | 18 ++++++++++++++++++
 nix/pkgs/main/default.nix | 30 +++++++++---------------------
 2 files changed, 27 insertions(+), 21 deletions(-)

diff --git a/flake.nix b/flake.nix
index 3f86cb42..982819f5 100644
--- a/flake.nix
+++ b/flake.nix
@@ -42,6 +42,24 @@
             (builtins.fromJSON (builtins.readFile ./flake.lock))
               .nodes.rocksdb.original.ref;
         });
+        # TODO: remove once https://github.com/NixOS/nixpkgs/pull/314945 is available
+        liburing = pkgs.liburing.overrideAttrs (old: {
+          # the configure script doesn't support these, and unconditionally
+          # builds both static and dynamic libraries.
+          configureFlags = pkgs.lib.subtractLists
+            [ "--enable-static" "--disable-shared" ]
+            old.configureFlags;
+
+          postInstall = old.postInstall + ''
+            # we remove the extra outputs
+            #
+            # we need to do this to prevent rocksdb from trying to link the
+            # static library in a dynamic stdenv
+            rm $out/lib/liburing*${
+              if pkgs.stdenv.hostPlatform.isStatic then ".so*" else ".a"
+            }
+          '';
+        });
       });
 
       scopeHost = mkScope pkgsHost;
diff --git a/nix/pkgs/main/default.nix b/nix/pkgs/main/default.nix
index 5d31fe15..86595691 100644
--- a/nix/pkgs/main/default.nix
+++ b/nix/pkgs/main/default.nix
@@ -9,9 +9,7 @@
 , rocksdb
 , rust
 , rust-jemalloc-sys
-, snappy
 , stdenv
-, pkgsStatic
 
 # Options (keep sorted)
 , default_features ? true
@@ -49,6 +47,8 @@ features'' = lib.subtractLists disable_features' features';
 
 featureEnabled = feature : builtins.elem feature features'';
 
+enableLiburing = featureEnabled "io_uring" && stdenv.isLinux;
+
 # This derivation will set the JEMALLOC_OVERRIDE variable, causing the
 # tikv-jemalloc-sys crate to use the nixpkgs jemalloc instead of building it's
 # own. In order for this to work, we need to set flags on the build that match
@@ -62,15 +62,9 @@ rust-jemalloc-sys' = (rust-jemalloc-sys.override {
     # tikv-jemalloc-sys/profiling feature
     lib.optional (featureEnabled "jemalloc_prof") "--enable-prof";
 });
-liburing' = pkgsStatic.liburing.overrideAttrs {
-  configureFlags = []; # liburing's configure file is handwritten so the default assumptions don't apply
-  isStatic = true;
-};
 
 buildDepsOnlyEnv =
   let
-    uring = featureEnabled "io_uring" && stdenv.isLinux;
-    extraDeps = lib.optionals uring [ liburing'.dev liburing'.out];
     rocksdb' = (rocksdb.override {
       jemalloc = rust-jemalloc-sys';
       # rocksdb fails to build with prefixed jemalloc, which is required on
@@ -84,7 +78,8 @@ buildDepsOnlyEnv =
       # TODO: static rocksdb fails to build on darwin
       # build log at <https://girlboss.ceo/~strawberry/pb/JjGH>
       meta.broken = stdenv.hostPlatform.isStatic && stdenv.isDarwin;
-      propagatedBuildInputs = old.propagatedBuildInputs ++ extraDeps;
+      # TODO: switch to enableUring option once https://github.com/NixOS/nixpkgs/pull/314945 is available
+      buildInputs = old.buildInputs ++ lib.optional enableLiburing liburing;
     });
   in
   {
@@ -108,18 +103,11 @@ buildDepsOnlyEnv =
 buildPackageEnv = {
   CONDUWUIT_VERSION_EXTRA = inputs.self.shortRev or inputs.self.dirtyShortRev or "";
 } // buildDepsOnlyEnv // {
-  CARGO_BUILD_RUSTFLAGS =
-     let
-       uring = featureEnabled "io_uring";
-       valid = (stdenv.hostPlatform.isAarch64 || stdenv.hostPlatform.isx86_64)
-              && stdenv.hostPlatform.isStatic
-              && !stdenv.isDarwin
-              && !stdenv.cc.bintools.isLLVM;
-     in
-       buildDepsOnlyEnv.CARGO_BUILD_RUSTFLAGS
-       + lib.optionalString (uring && valid) " -L${lib.getLib liburing'}/lib/ -luring"
-       + " -L${lib.getLib snappy}/lib/ -lsnappy";
-  };
+  # Only needed in static stdenv because these are transitive dependencies of rocksdb
+  CARGO_BUILD_RUSTFLAGS = buildDepsOnlyEnv.CARGO_BUILD_RUSTFLAGS
+    + lib.optionalString (enableLiburing && stdenv.hostPlatform.isStatic)
+      " -L${lib.getLib liburing}/lib -luring";
+};