bumblebee: cleanup, fix virtualgl, add useNvidia flag

pkgs/tools/X11/bumblebee/default.nix

···
 #
 # To use at startup, see hardware.bumblebee options.
 
-# This nix expression supports for now only the native nvidia driver.
-# It should not be hard to generalize this approach to support the
-# nouveau driver as well (parameterize hostEnv, i686Env over the
-# module package, and parameterize the two wrappers as well)
-
-{ stdenv, fetchurl, pkgconfig, help2man
-, libX11, glibc, glib, libbsd
-, makeWrapper, buildEnv, module_init_tools
-, xorg, xkeyboard_config
-, nvidia_x11, virtualgl
+{ stdenv, lib, fetchurl, pkgconfig, help2man, makeWrapper
+, glib, libbsd
+, libX11, libXext, xorgserver, xkbcomp, module_init_tools, xkeyboard_config, xf86videonouveau
+, nvidia_x11, virtualgl, primusLib
 # The below should only be non-null in a x86_64 system. On a i686
 # system the above nvidia_x11 and virtualgl will be the i686 packages.
 # TODO: Confusing. Perhaps use "SubArch" instead of i686?
 , nvidia_x11_i686 ? null
-, virtualgl_i686 ? null
+, primusLib_i686 ? null
 , useDisplayDevice ? false
-, extraDeviceOptions ? ""
+, extraNvidiaDeviceOptions ? ""
+, extraNouveauDeviceOptions ? ""
+, useNvidia ? true
 }:
-with stdenv.lib;
+
 let
   version = "3.2.1";
-  name = "bumblebee-${version}";
 
-  # Isolated X11 environment without the acceleration driver module.
-  # Includes the rest of the components needed for bumblebeed and
-  # optirun to spawn the second X server and to connect to it.
-  x11Env = buildEnv {
-    name = "bumblebee-env";
-    paths = [
-      module_init_tools
-      xorg.xorgserver
-      xorg.xrandr
-      xorg.xrdb
-      xorg.setxkbmap
-      xorg.libX11
-      xorg.libXext
-      xorg.xf86inputevdev
-    ];
-  };
+  primus = if useNvidia then primusLib else primusLib.override { nvidia_x11 = null; };
+  primus_i686 = if useNvidia then primusLib_i686 else primusLib_i686.override { nvidia_x11 = null; };
 
-  # The environment for the host architecture.
-  hostEnv = buildEnv {
-    name = "bumblebee-x64-env";
-    paths = [
-      nvidia_x11
-      virtualgl
-    ];
-  };
+  primusLibs = lib.makeLibraryPath ([primus] ++ lib.optional (primusLib_i686 != null) primus_i686);
 
-  # The environment for the sub architecture, i686, if there is one
-  i686Env = if virtualgl_i686 != null
-    then buildEnv {
-      name = "bumblebee-i686-env";
-      paths = [
-       nvidia_x11_i686
-       virtualgl_i686
-      ];
-    }
-    else null;
+  nvidia_x11s = [nvidia_x11] ++ lib.optional (nvidia_x11_i686 != null) nvidia_x11_i686;
 
-  allEnvs = [hostEnv] ++ optional (i686Env != null) i686Env;
-  ldPathString = makeLibraryPath allEnvs;
+  nvidiaLibs = lib.makeLibraryPath nvidia_x11s;
 
-  # By default we don't want to use a display device
-  deviceOptions = if useDisplayDevice
-                  then ""
-                  else ''
+  bbdPath = lib.makeSearchPath "bin" [ module_init_tools xorgserver ];
+  bbdLibs = lib.makeLibraryPath [ libX11 libXext ];
 
-                         #   Disable display device
-                             Option "UseEDID" "false"
-                             Option "UseDisplayDevice" "none"
-                       ''
-                  + extraDeviceOptions;
+  xmodules = lib.concatStringsSep "," (map (x: "${x}/lib/xorg/modules") ([ xorgserver ] ++ lib.optional (!useNvidia) xf86videonouveau));
 
-in stdenv.mkDerivation {
-  inherit name deviceOptions;
+in stdenv.mkDerivation rec {
+  name = "bumblebee-${version}";
 
   src = fetchurl {
     url = "http://bumblebee-project.org/${name}.tar.gz";
     sha256 = "03p3gvx99lwlavznrpg9l7jnl1yfg2adcj8jcjj0gxp20wxp060h";
   };
 
-  patches = [ ./xopts.patch ./nvidia-conf.patch];
+  patches = [ ./nixos.patch ];
+
+  # By default we don't want to use a display device
+  nvidiaDeviceOptions = lib.optionalString (!useDisplayDevice) ''
+    # Disable display device
+    Option "UseEDID" "false"
+    Option "UseDisplayDevice" "none"
+  '' + extraNvidiaDeviceOptions;
+
+  nouveauDeviceOptions = extraNouveauDeviceOptions;
 
   preConfigure = ''
     # Substitute the path to the actual modinfo program in module.c.
···
 
     # Apply configuration options
     substituteInPlace conf/xorg.conf.nvidia \
-      --subst-var deviceOptions
+      --subst-var nvidiaDeviceOptions
+
+    substituteInPlace conf/xorg.conf.nouveau \
+      --subst-var nouveauDeviceOptions
   '';
 
   # Build-time dependencies of bumblebeed and optirun.
   # Note that it has several runtime dependencies.
-  buildInputs = [ stdenv makeWrapper pkgconfig help2man libX11 glib libbsd ];
+  buildInputs = [ libX11 glib libbsd ];
+  nativeBuildInputs = [ makeWrapper pkgconfig help2man ];
 
   # The order of LDPATH is very specific: First X11 then the host
   # environment then the optional sub architecture paths.
···
   # include the sub architecture components.
   configureFlags = [
     "--with-udev-rules=$out/lib/udev/rules.d"
-    "CONF_DRIVER=nvidia"
-    "CONF_DRIVER_MODULE_NVIDIA=nvidia"
-    "CONF_LDPATH_NVIDIA=${x11Env}/lib:${ldPathString}"
-    "CONF_MODPATH_NVIDIA=${hostEnv}/lib/xorg/modules,${x11Env}/lib/xorg/modules"
+    # see #10282
+    #"CONF_PRIMUS_LD_PATH=${primusLibs}"
+  ] ++ lib.optionals useNvidia [
+    "CONF_LDPATH_NVIDIA=${nvidiaLibs}"
+    "CONF_MODPATH_NVIDIA=${nvidia_x11}/lib/xorg/modules"
   ];
 
-  # create a wrapper environment for bumblebeed and optirun
+  CFLAGS = [
+    "-DX_MODULE_APPENDS=\\\"${xmodules}\\\""
+    "-DX_XKB_DIR=\\\"${xkeyboard_config}/etc/X11/xkb\\\""
+  ];
+
   postInstall = ''
     wrapProgram "$out/sbin/bumblebeed" \
-      --prefix PATH : "${x11Env}/sbin:${x11Env}/bin:${hostEnv}/bin:\$PATH" \
-      --prefix LD_LIBRARY_PATH : "${x11Env}/lib:${hostEnv}/lib:\$LD_LIBRARY_PATH" \
-      --set FONTCONFIG_FILE "/etc/fonts/fonts.conf" \
-      --set XKB_BINDIR "${xorg.xkbcomp}/bin" \
-      --set XKB_DIR "${xkeyboard_config}/etc/X11/xkb"
+      --set XKB_BINDIR "${xkbcomp}/bin" \
+      --prefix PATH : "${bbdPath}" \
+      --prefix LD_LIBRARY_PATH : "${bbdLibs}"
 
     wrapProgram "$out/bin/optirun" \
-      --prefix PATH : "${hostEnv}/bin"
-  '' + (if i686Env == null
-    then ""
-    else ''
-    makeWrapper "$out/bin/.optirun-wrapped" "$out/bin/optirun32" \
-      --prefix PATH : "${i686Env}/bin"
-  '');
+      --prefix PATH : "${virtualgl}/bin"
+  '';
 
-  meta = {
+  meta = with stdenv.lib; {
     homepage = http://github.com/Bumblebee-Project/Bumblebee;
     description = "Daemon for managing Optimus videocards (power-on/off, spawns xservers)";
-    license = stdenv.lib.licenses.gpl3;
+    platforms = platforms.linux;
+    license = licenses.gpl3;
+    maintainers = with maintainers; [ abbradar ];
   };
 }

pkgs/tools/X11/bumblebee/nixos.patch

···
+diff --git a/conf/xorg.conf.nouveau b/conf/xorg.conf.nouveau
+index 87e48cb..60d6eaf 100644
+--- a/conf/xorg.conf.nouveau
++++ b/conf/xorg.conf.nouveau
+@@ -15,4 +15,5 @@ Section "Device"
+ #   This Setting is needed on Ubuntu 13.04.
+ #   BusID "PCI:01:00:0"
+ 
++@nouveauDeviceOptions@
+ EndSection
+diff --git a/conf/xorg.conf.nvidia b/conf/xorg.conf.nvidia
+index c3107f9..17072f4 100644
+--- a/conf/xorg.conf.nvidia
++++ b/conf/xorg.conf.nvidia
+@@ -29,6 +29,6 @@ Section "Device"
+     Option "ProbeAllGpus" "false"
+ 
+     Option "NoLogo" "true"
+-    Option "UseEDID" "false"
+-    Option "UseDisplayDevice" "none"
++
++@nvidiaDeviceOptions@
+ EndSection
+diff --git a/src/bbsecondary.c b/src/bbsecondary.c
+index 71a6b73..a682d8a 100644
+--- a/src/bbsecondary.c
++++ b/src/bbsecondary.c
+@@ -145,6 +145,23 @@ bool start_secondary(bool need_secondary) {
+     }
+ 
+     bb_log(LOG_INFO, "Starting X server on display %s.\n", bb_config.x_display);
++    const char mod_appends[] = X_MODULE_APPENDS;
++
++    char *mod_path;
++    int pathlen = strlen(bb_config.mod_path);
++    if (pathlen == 0) {
++      mod_path = mod_appends;
++    } else {
++      mod_path = malloc(pathlen + 1 + sizeof(mod_appends));
++      if (!mod_path) {
++        set_bb_error("Could not allocate memory for modules path\n");
++        return false;
++      }
++      strcpy(mod_path, bb_config.mod_path);
++      mod_path[pathlen] = ',';
++      strcpy(mod_path + pathlen + 1, mod_appends);
++    }
++
+     char *x_argv[] = {
+       XORG_BINARY,
+       bb_config.x_display,
+@@ -153,24 +170,25 @@ bool start_secondary(bool need_secondary) {
+       "-sharevts",
+       "-nolisten", "tcp",
+       "-noreset",
++      "-logfile", "/var/log/X.bumblebee.log",
++      "-xkbdir", X_XKB_DIR,
+       "-verbose", "3",
+       "-isolateDevice", pci_id,
+-      "-modulepath", bb_config.mod_path, // keep last
++      "-modulepath", mod_path,
+       NULL
+     };
+     enum {n_x_args = sizeof(x_argv) / sizeof(x_argv[0])};
+-    if (!*bb_config.mod_path) {
+-      x_argv[n_x_args - 3] = 0; //remove -modulepath if not set
+-    }
+     //close any previous pipe, if it (still) exists
+     if (bb_status.x_pipe[0] != -1){close(bb_status.x_pipe[0]); bb_status.x_pipe[0] = -1;}
+     if (bb_status.x_pipe[1] != -1){close(bb_status.x_pipe[1]); bb_status.x_pipe[1] = -1;}
+     //create a new pipe
+     if (pipe2(bb_status.x_pipe, O_NONBLOCK | O_CLOEXEC)){
+       set_bb_error("Could not create output pipe for X");
++      if (pathlen > 0) free(mod_path);
+       return false;
+     }
+     bb_status.x_pid = bb_run_fork_ld_redirect(x_argv, bb_config.ld_path, bb_status.x_pipe[1]);
++    if (pathlen > 0) free(mod_path);
+     //close the end of the pipe that is not ours
+     if (bb_status.x_pipe[1] != -1){close(bb_status.x_pipe[1]); bb_status.x_pipe[1] = -1;}
+   }

pkgs/tools/X11/bumblebee/nvidia-conf.patch

···
---- bumblebee-3.2.1/conf/xorg.conf.nvidia
-+++ bumblebee-3.2.1/conf/xorg.conf.nvidia
-@@ -29,6 +29,5 @@ Section "Device"
-     Option "ProbeAllGpus" "false"
- 
-     Option "NoLogo" "true"
--    Option "UseEDID" "false"
--    Option "UseDisplayDevice" "none"
-+@deviceOptions@
- EndSection
-

pkgs/tools/X11/bumblebee/xopts.patch

···
---- bumblebee-3.2.1/src/bbsecondary.c 2012-02-05 00:03:06.003439638 +0100
-+++ bumblebee-3.2.1/src/bbsecondary.c	2012-02-05 00:46:38.017382619 +0100
-@@ -149,6 +149,8 @@
-       "-sharevts",
-       "-nolisten", "tcp",
-       "-noreset",
-+      "-xkbdir", getenv("XKB_DIR"),
-+      "-logfile", "/var/log/X.bumblebee.log",
-       "-verbose", "3",
-       "-isolateDevice", pci_id,
-       "-modulepath",

pkgs/top-level/all-packages.nix

···
     nvidia_x11_i686 = if system == "x86_64-linux"
       then pkgsi686Linux.linuxPackages.nvidia_x11.override { libsOnly = true; }
       else null;
-    virtualgl = virtualgl;
-    virtualgl_i686 = if system == "x86_64-linux"
-      then pkgsi686Linux.virtualgl
+    primusLib_i686 = if system == "x86_64-linux"
+      then pkgsi686Linux.primusLib
       else null;
-  };
-
-  # use if you intend to connect the nvidia card to a monitor
-  bumblebee_display = bumblebee.override {
-    useDisplayDevice = true;
   };
 
   vkeybd = callPackage ../applications/audio/vkeybd {};