nixpkgs/pkgs/tools/admin/tigervnc/default.nix
Graham Christensen c2b898da76 treewide: drop -l$NIX_BUILD_CORES
Passing `-l$NIX_BUILD_CORES` improperly limits the overall system load.

For a build machine which is configured to run `$B` builds where each
build gets `total cores / B` cores (`$C`), passing `-l $C` to make will
improperly limit the load to `$C` instead of `$B * $C`.

This effect becomes quite pronounced on machines with 80 cores, with
40 simultaneous builds and a cores limit of 2. On a machine with this
configuration, Nix will run 40 builds and make will limit the overall
system load to approximately 2. A build machine with this many cores
can happily run with a load approaching 80.

A non-solution is to oversubscribe the machine, by picking a larger
`$C`. However, there is no way to divide the number of cores in a way
which fairly subdivides the available cores when `$B` is greater than
1.

There has been exploration of passing a jobserver in to the sandbox,
or sharing a jobserver between all the builds. This is one option, but
relatively complicated and only supports make. Lots of other software
uses its own implementation of `-j` and doesn't support either `-l` or
the Make jobserver.

For the case of an interactive user machine, the user should limit
overall system load using `$B`, `$C`, and optionally systemd's
cpu/network/io limiting features.

Making this change should significantly improve the utilization of our
build farm, and improve the throughput of Hydra.
2022-09-22 16:01:23 -04:00

170 lines
4.6 KiB
Nix

{ lib
, stdenv
, fetchFromGitHub
, fetchpatch
, xorg
, xkeyboard_config
, zlib
, libjpeg_turbo
, pixman
, fltk
, cmake
, gettext
, libtool
, libGLU
, gnutls
, gawk
, pam
, nettle
, xterm
, openssh
, perl
, makeWrapper
, nixosTests
}:
with lib;
stdenv.mkDerivation rec {
version = "1.12.0";
pname = "tigervnc";
src = fetchFromGitHub {
owner = "TigerVNC";
repo = "tigervnc";
rev = "v${version}";
sha256 = "sha256-77X+AvHFWfYYIio3c+EYf11jg/1IbYhNUweRIDHMOZw=";
};
patches = [
(fetchpatch {
url = "https://patch-diff.githubusercontent.com/raw/TigerVNC/tigervnc/pull/1383.patch";
sha256 = "sha256-r3QLtxVD0wIv2NWVN9r0LVxSlLurDHgkAZfkpIjmZyU=";
name = "Xvnc-support-Xorg-1.21-PR1383.patch";
})
];
postPatch = lib.optionalString stdenv.isLinux ''
sed -i -e '/^\$cmd \.= " -pn";/a$cmd .= " -xkbdir ${xkeyboard_config}/etc/X11/xkb";' unix/vncserver/vncserver.in
fontPath=
substituteInPlace vncviewer/vncviewer.cxx \
--replace '"/usr/bin/ssh' '"${openssh}/bin/ssh'
cp unix/xserver21.1.1.patch unix/xserver211.patch
source_top="$(pwd)"
'' + ''
# On Mac, do not build a .dmg, instead copy the .app to the source dir
gawk -i inplace 'BEGIN { del=0 } /hdiutil/ { del=2 } del<=0 { print } /$VERSION.dmg/ { del -= 1 }' release/makemacapp.in
echo "mv \"\$APPROOT\" \"\$SRCDIR/\"" >> release/makemacapp.in
'';
dontUseCmakeBuildDir = true;
cmakeFlags = [
"-DCMAKE_INSTALL_PREFIX=${placeholder "out"}"
"-DCMAKE_INSTALL_SBINDIR=${placeholder "out"}/bin"
"-DCMAKE_INSTALL_LIBEXECDIR=${placeholder "out"}/bin"
];
postBuild = lib.optionalString stdenv.isLinux ''
export NIX_CFLAGS_COMPILE="$NIX_CFLAGS_COMPILE -Wno-error=int-to-pointer-cast -Wno-error=pointer-to-int-cast"
export CXXFLAGS="$CXXFLAGS -fpermissive"
# Build Xvnc
tar xf ${xorg.xorgserver.src}
cp -R xorg*/* unix/xserver
pushd unix/xserver
version=$(echo ${xorg.xorgserver.name} | sed 's/.*-\([0-9]\+\).\([0-9]\+\).*/\1\2/g')
patch -p1 < "$source_top/unix/xserver$version.patch"
autoreconf -vfi
./configure $configureFlags --disable-devel-docs --disable-docs \
--disable-xorg --disable-xnest --disable-xvfb --disable-dmx \
--disable-xwin --disable-xephyr --disable-kdrive --with-pic \
--disable-xorgcfg --disable-xprint --disable-static \
--enable-composite --disable-xtrap --enable-xcsecurity \
--disable-{a,c,m}fb \
--disable-xwayland \
--disable-config-dbus --disable-config-udev --disable-config-hal \
--disable-xevie \
--disable-dri --disable-dri2 --disable-dri3 --enable-glx \
--enable-install-libxf86config \
--prefix="$out" --disable-unit-tests \
--with-xkb-path=${xkeyboard_config}/share/X11/xkb \
--with-xkb-bin-directory=${xorg.xkbcomp}/bin \
--with-xkb-output=$out/share/X11/xkb/compiled
make TIGERVNC_SRC=$src TIGERVNC_BUILDDIR=`pwd`/../.. -j$NIX_BUILD_CORES
popd
'' + lib.optionalString stdenv.isDarwin ''
make dmg
'';
postInstall = lib.optionalString stdenv.isLinux ''
pushd unix/xserver/hw/vnc
make TIGERVNC_SRC=$src TIGERVNC_BUILDDIR=`pwd`/../../../.. install
popd
rm -f $out/lib/xorg/protocol.txt
wrapProgram $out/bin/vncserver \
--prefix PATH : ${lib.makeBinPath (with xorg; [ xterm twm xsetroot xauth ]) }
'' + lib.optionalString stdenv.isDarwin ''
mkdir -p $out/Applications
mv 'TigerVNC Viewer ${version}.app' $out/Applications/
rm $out/bin/vncviewer
echo "#!/usr/bin/env bash
open $out/Applications/TigerVNC\ Viewer\ ${version}.app --args \$@" >> $out/bin/vncviewer
chmod +x $out/bin/vncviewer
'';
buildInputs = [
fltk
gnutls
libjpeg_turbo
pixman
gawk
] ++ lib.optionals stdenv.isLinux (with xorg; [
nettle
pam
perl
xorgproto
utilmacros
libXtst
libXext
libX11
libXext
libICE
libXi
libSM
libXft
libxkbfile
libXfont2
libpciaccess
libGLU
] ++ xorg.xorgserver.buildInputs
);
nativeBuildInputs = [
cmake
gettext
] ++ lib.optionals stdenv.isLinux (with xorg; [
fontutil
libtool
makeWrapper
utilmacros
zlib
] ++ xorg.xorgserver.nativeBuildInputs);
propagatedBuildInputs = lib.optional stdenv.isLinux xorg.xorgserver.propagatedBuildInputs;
passthru.tests.tigervnc = nixosTests.vnc.testTigerVNC;
meta = {
homepage = "https://tigervnc.org/";
license = lib.licenses.gpl2Plus;
description = "Fork of tightVNC, made in cooperation with VirtualGL";
maintainers = with lib.maintainers; [viric];
platforms = lib.platforms.unix;
# Prevent a store collision.
priority = 4;
};
}