commit c21d10ba30f90d5554f0e16fb73af52600f1f8f4 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2405.section.md

···

       92
       92
        
       

     

       93
       93
        
       - [Handheld Daemon](https://github.com/hhd-dev/hhd), support for gaming handhelds like the Legion Go, ROG Ally, and GPD Win. Available as [services.handheld-daemon](#opt-services.handheld-daemon.enable).

     

       94
       94
        
       

     

       95
       95
       +
       - [BenchExec](https://github.com/sosy-lab/benchexec), a framework for reliable benchmarking and resource measurement, available as [programs.benchexec](#opt-programs.benchexec.enable),

     

       96
       96
       +
         As well as related programs

     

       97
       97
       +
         [CPU Energy Meter](https://github.com/sosy-lab/cpu-energy-meter), available as [programs.cpu-energy-meter](#opt-programs.cpu-energy-meter.enable), and

     

       98
       98
       +
         [PQoS Wrapper](https://gitlab.com/sosy-lab/software/pqos-wrapper), available as [programs.pqos-wrapper](#opt-programs.pqos-wrapper.enable).

     

       99
       99
       +
       

     

       95
       100
        
       - [Guix](https://guix.gnu.org), a functional package manager inspired by Nix. Available as [services.guix](#opt-services.guix.enable).

     

       96
       101
        
       

     

       97
       102
        
       - [PhotonVision](https://photonvision.org/), a free, fast, and easy-to-use computer vision solution for the FIRST® Robotics Competition.

nixos/modules/module-list.nix

···

       158
       158
        
         ./programs/bash/ls-colors.nix

     

       159
       159
        
         ./programs/bash/undistract-me.nix

     

       160
       160
        
         ./programs/bcc.nix

     

       161
       161
       +
         ./programs/benchexec.nix

     

       161
       162
        
         ./programs/browserpass.nix

     

       162
       163
        
         ./programs/calls.nix

     

       163
       164
        
         ./programs/captive-browser.nix

     
···

       167
       168
        
         ./programs/chromium.nix

     

       168
       169
        
         ./programs/clash-verge.nix

     

       169
       170
        
         ./programs/cnping.nix

     

       171
       171
       +
         ./programs/cpu-energy-meter.nix

     

       170
       172
        
         ./programs/command-not-found/command-not-found.nix

     

       171
       173
        
         ./programs/coolercontrol.nix

     

       172
       174
        
         ./programs/criu.nix

     
···

       250
       252
        
         ./programs/pantheon-tweaks.nix

     

       251
       253
        
         ./programs/partition-manager.nix

     

       252
       254
        
         ./programs/plotinus.nix

     

       255
       255
       +
         ./programs/pqos-wrapper.nix

     

       253
       256
        
         ./programs/projecteur.nix

     

       254
       257
        
         ./programs/proxychains.nix

     

       255
       258
        
         ./programs/qdmr.nix

+98

nixos/modules/programs/benchexec.nix

···

       1
       1
       +
       { lib

     

       2
       2
       +
       , pkgs

     

       3
       3
       +
       , config

     

       4
       4
       +
       , options

     

       5
       5
       +
       , ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         cfg = config.programs.benchexec;

     

       9
       9
       +
         opt = options.programs.benchexec;

     

       10
       10
       +
       

     

       11
       11
       +
         filterUsers = x:

     

       12
       12
       +
           if builtins.isString x then config.users.users ? ${x} else

     

       13
       13
       +
           if builtins.isInt    x then x                         else

     

       14
       14
       +
           throw "filterUsers expects string (username) or int (UID)";

     

       15
       15
       +
       

     

       16
       16
       +
         uid = x:

     

       17
       17
       +
           if builtins.isString x then config.users.users.${x}.uid else

     

       18
       18
       +
           if builtins.isInt    x then x                           else

     

       19
       19
       +
           throw "uid expects string (username) or int (UID)";

     

       20
       20
       +
       in

     

       21
       21
       +
       {

     

       22
       22
       +
         options.programs.benchexec = {

     

       23
       23
       +
           enable = lib.mkEnableOption "BenchExec";

     

       24
       24
       +
           package = lib.options.mkPackageOption pkgs "benchexec" { };

     

       25
       25
       +
       

     

       26
       26
       +
           users = lib.options.mkOption {

     

       27
       27
       +
             type = with lib.types; listOf (either str int);

     

       28
       28
       +
             description = ''

     

       29
       29
       +
               Users that intend to use BenchExec.

     

       30
       30
       +
               Provide usernames of users that are configured via {option}`${options.users.users}` as string,

     

       31
       31
       +
               and UIDs of "mutable users" as integers.

     

       32
       32
       +
               Control group delegation will be configured via systemd.

     

       33
       33
       +
               For more information, see <https://github.com/sosy-lab/benchexec/blob/3.18/doc/INSTALL.md#setting-up-cgroups>.

     

       34
       34
       +
             '';

     

       35
       35
       +
             default = [ ];

     

       36
       36
       +
             example = lib.literalExpression ''

     

       37
       37
       +
               [

     

       38
       38
       +
                 "alice" # username of a user configured via ${options.users.users}

     

       39
       39
       +
                 1007    # UID of a mutable user

     

       40
       40
       +
               ]

     

       41
       41
       +
             '';

     

       42
       42
       +
           };

     

       43
       43
       +
         };

     

       44
       44
       +
       

     

       45
       45
       +
         config = lib.mkIf cfg.enable {

     

       46
       46
       +
           assertions = (map

     

       47
       47
       +
             (user: {

     

       48
       48
       +
               assertion = config.users.users ? ${user};

     

       49
       49
       +
               message = ''

     

       50
       50
       +
                 The user '${user}' intends to use BenchExec (via `${opt.users}`), but is not configured via `${options.users.users}`.

     

       51
       51
       +
               '';

     

       52
       52
       +
             })

     

       53
       53
       +
             (builtins.filter builtins.isString cfg.users)

     

       54
       54
       +
           ) ++ (map

     

       55
       55
       +
             (id: {

     

       56
       56
       +
               assertion = config.users.mutableUsers;

     

       57
       57
       +
               message = ''

     

       58
       58
       +
                 The user with UID '${id}' intends to use BenchExec (via `${opt.users}`), but mutable users are disabled via `${options.users.mutableUsers}`.

     

       59
       59
       +
               '';

     

       60
       60
       +
             })

     

       61
       61
       +
             (builtins.filter builtins.isInt cfg.users)

     

       62
       62
       +
           ) ++ [

     

       63
       63
       +
             {

     

       64
       64
       +
               assertion = config.systemd.enableUnifiedCgroupHierarchy == true;

     

       65
       65
       +
               message = ''

     

       66
       66
       +
                 The BenchExec module `${opt.enable}` only supports control groups 2 (`${options.systemd.enableUnifiedCgroupHierarchy} = true`).

     

       67
       67
       +
               '';

     

       68
       68
       +
             }

     

       69
       69
       +
           ];

     

       70
       70
       +
       

     

       71
       71
       +
           environment.systemPackages = [ cfg.package ];

     

       72
       72
       +
       

     

       73
       73
       +
           # See <https://github.com/sosy-lab/benchexec/blob/3.18/doc/INSTALL.md#setting-up-cgroups>.

     

       74
       74
       +
           systemd.services = builtins.listToAttrs (map

     

       75
       75
       +
             (user: {

     

       76
       76
       +
               name = "user@${builtins.toString (uid user)}";

     

       77
       77
       +
               value = {

     

       78
       78
       +
                 serviceConfig.Delegate = "yes";

     

       79
       79
       +
                 overrideStrategy = "asDropin";

     

       80
       80
       +
               };

     

       81
       81
       +
             })

     

       82
       82
       +
             (builtins.filter filterUsers cfg.users));

     

       83
       83
       +
       

     

       84
       84
       +
           # See <https://github.com/sosy-lab/benchexec/blob/3.18/doc/INSTALL.md#requirements>.

     

       85
       85
       +
           virtualisation.lxc.lxcfs.enable = lib.mkDefault true;

     

       86
       86
       +
       

     

       87
       87
       +
           # See <https://github.com/sosy-lab/benchexec/blob/3.18/doc/INSTALL.md#requirements>.

     

       88
       88
       +
           programs = {

     

       89
       89
       +
             cpu-energy-meter.enable = lib.mkDefault true;

     

       90
       90
       +
             pqos-wrapper.enable = lib.mkDefault true;

     

       91
       91
       +
           };

     

       92
       92
       +
       

     

       93
       93
       +
           # See <https://github.com/sosy-lab/benchexec/blob/3.18/doc/INSTALL.md#kernel-requirements>.

     

       94
       94
       +
           security.unprivilegedUsernsClone = true;

     

       95
       95
       +
         };

     

       96
       96
       +
       

     

       97
       97
       +
         meta.maintainers = with lib.maintainers; [ lorenzleutgeb ];

     

       98
       98
       +
       }

+27

nixos/modules/programs/cpu-energy-meter.nix

···

       1
       1
       +
       { config

     

       2
       2
       +
       , lib

     

       3
       3
       +
       , pkgs

     

       4
       4
       +
       , ...

     

       5
       5
       +
       }: {

     

       6
       6
       +
         options.programs.cpu-energy-meter = {

     

       7
       7
       +
           enable = lib.mkEnableOption "CPU Energy Meter";

     

       8
       8
       +
           package = lib.mkPackageOption pkgs "cpu-energy-meter" { };

     

       9
       9
       +
         };

     

       10
       10
       +
       

     

       11
       11
       +
         config =

     

       12
       12
       +
           let

     

       13
       13
       +
             cfg = config.programs.cpu-energy-meter;

     

       14
       14
       +
           in

     

       15
       15
       +
           lib.mkIf cfg.enable {

     

       16
       16
       +
             hardware.cpu.x86.msr.enable = true;

     

       17
       17
       +
       

     

       18
       18
       +
             security.wrappers.${cfg.package.meta.mainProgram} = {

     

       19
       19
       +
               owner = "nobody";

     

       20
       20
       +
               group = config.hardware.cpu.x86.msr.group;

     

       21
       21
       +
               source = lib.getExe cfg.package;

     

       22
       22
       +
               capabilities = "cap_sys_rawio=ep";

     

       23
       23
       +
             };

     

       24
       24
       +
           };

     

       25
       25
       +
       

     

       26
       26
       +
         meta.maintainers = with lib.maintainers; [ lorenzleutgeb ];

     

       27
       27
       +
       }

+27

nixos/modules/programs/pqos-wrapper.nix

···

       1
       1
       +
       { config

     

       2
       2
       +
       , lib

     

       3
       3
       +
       , pkgs

     

       4
       4
       +
       , ...

     

       5
       5
       +
       }:

     

       6
       6
       +
       let

     

       7
       7
       +
         cfg = config.programs.pqos-wrapper;

     

       8
       8
       +
       in

     

       9
       9
       +
       {

     

       10
       10
       +
         options.programs.pqos-wrapper = {

     

       11
       11
       +
           enable = lib.mkEnableOption "PQoS Wrapper for BenchExec";

     

       12
       12
       +
           package = lib.mkPackageOption pkgs "pqos-wrapper" { };

     

       13
       13
       +
         };

     

       14
       14
       +
       

     

       15
       15
       +
         config = lib.mkIf cfg.enable {

     

       16
       16
       +
           hardware.cpu.x86.msr.enable = true;

     

       17
       17
       +
       

     

       18
       18
       +
           security.wrappers.${cfg.package.meta.mainProgram} = {

     

       19
       19
       +
             owner = "nobody";

     

       20
       20
       +
             group = config.hardware.cpu.x86.msr.group;

     

       21
       21
       +
             source = lib.getExe cfg.package;

     

       22
       22
       +
             capabilities = "cap_sys_rawio=eip";

     

       23
       23
       +
           };

     

       24
       24
       +
         };

     

       25
       25
       +
       

     

       26
       26
       +
         meta.maintainers = with lib.maintainers; [ lorenzleutgeb ];

     

       27
       27
       +
       }

nixos/tests/all-tests.nix

···

       144
       144
        
         bcachefs = handleTestOn ["x86_64-linux" "aarch64-linux"] ./bcachefs.nix {};

     

       145
       145
        
         beanstalkd = handleTest ./beanstalkd.nix {};

     

       146
       146
        
         bees = handleTest ./bees.nix {};

     

       147
       147
       +
         benchexec = handleTest ./benchexec.nix {};

     

       147
       148
        
         binary-cache = handleTest ./binary-cache.nix {};

     

       148
       149
        
         bind = handleTest ./bind.nix {};

     

       149
       150
        
         bird = handleTest ./bird.nix {};

+54

nixos/tests/benchexec.nix

···

       1
       1
       +
       import ./make-test-python.nix ({ pkgs, lib, ... }:

     

       2
       2
       +
       let

     

       3
       3
       +
         user = "alice";

     

       4
       4
       +
       in

     

       5
       5
       +
       {

     

       6
       6
       +
         name = "benchexec";

     

       7
       7
       +
       

     

       8
       8
       +
         nodes.benchexec = {

     

       9
       9
       +
           imports = [ ./common/user-account.nix ];

     

       10
       10
       +
       

     

       11
       11
       +
           programs.benchexec = {

     

       12
       12
       +
             enable = true;

     

       13
       13
       +
             users = [ user ];

     

       14
       14
       +
           };

     

       15
       15
       +
         };

     

       16
       16
       +
       

     

       17
       17
       +
         testScript = { ... }:

     

       18
       18
       +
           let

     

       19
       19
       +
             runexec = lib.getExe' pkgs.benchexec "runexec";

     

       20
       20
       +
             echo = builtins.toString pkgs.benchexec;

     

       21
       21
       +
             test = lib.getExe (pkgs.writeShellApplication rec {

     

       22
       22
       +
               name = "test";

     

       23
       23
       +
               meta.mainProgram = name;

     

       24
       24
       +
               text = "echo '${echo}'";

     

       25
       25
       +
             });

     

       26
       26
       +
             wd = "/tmp";

     

       27
       27
       +
             stdout = "${wd}/runexec.out";

     

       28
       28
       +
             stderr = "${wd}/runexec.err";

     

       29
       29
       +
           in

     

       30
       30
       +
           ''

     

       31
       31
       +
             start_all()

     

       32
       32
       +
             machine.wait_for_unit("multi-user.target")

     

       33
       33
       +
             benchexec.succeed(''''\

     

       34
       34
       +
                 systemd-run \

     

       35
       35
       +
                   --property='StandardOutput=file:${stdout}' \

     

       36
       36
       +
                   --property='StandardError=file:${stderr}' \

     

       37
       37
       +
                   --unit=runexec --wait --user --machine='${user}@' \

     

       38
       38
       +
                   --working-directory ${wd} \

     

       39
       39
       +
                 '${runexec}' \

     

       40
       40
       +
                   --debug \

     

       41
       41
       +
                   --read-only-dir / \

     

       42
       42
       +
                   --hidden-dir /home \

     

       43
       43
       +
                   '${test}' \

     

       44
       44
       +
             '''')

     

       45
       45
       +
             benchexec.succeed("grep -s '${echo}' ${wd}/output.log")

     

       46
       46
       +
             benchexec.succeed("test \"$(grep -Ec '((start|wall|cpu)time|memory)=' ${stdout})\" = 4")

     

       47
       47
       +
             benchexec.succeed("! grep -E '(WARNING|ERROR)' ${stderr}")

     

       48
       48
       +
           '';

     

       49
       49
       +
       

     

       50
       50
       +
         interactive.nodes.benchexec.services.kmscon = {

     

       51
       51
       +
           enable = true;

     

       52
       52
       +
           fonts = [{ name = "Fira Code"; package = pkgs.fira-code; }];

     

       53
       53
       +
         };

     

       54
       54
       +
       })

+62

pkgs/by-name/be/benchexec/package.nix

···

       1
       1
       +
       { lib

     

       2
       2
       +
       , fetchFromGitHub

     

       3
       3
       +
       , python3

     

       4
       4
       +
       , libseccomp

     

       5
       5
       +
       , nixosTests

     

       6
       6
       +
       , testers

     

       7
       7
       +
       , benchexec

     

       8
       8
       +
       }:

     

       9
       9
       +
       python3.pkgs.buildPythonApplication rec {

     

       10
       10
       +
         pname = "benchexec";

     

       11
       11
       +
         version = "3.21";

     

       12
       12
       +
       

     

       13
       13
       +
         src = fetchFromGitHub {

     

       14
       14
       +
           owner = "sosy-lab";

     

       15
       15
       +
           repo = "benchexec";

     

       16
       16
       +
           rev = version;

     

       17
       17
       +
           hash = "sha256-bE3brmmLHZQakDKvd47I1hm9Dcsu6DrSeJyjWWtEZWI=";

     

       18
       18
       +
         };

     

       19
       19
       +
       

     

       20
       20
       +
         pyproject = true;

     

       21
       21
       +
       

     

       22
       22
       +
         nativeBuildInputs = with python3.pkgs; [ setuptools ];

     

       23
       23
       +
       

     

       24
       24
       +
         # NOTE: CPU Energy Meter is not added,

     

       25
       25
       +
         # because BenchExec should call the wrapper configured

     

       26
       26
       +
         # via `security.wrappers.cpu-energy-meter`

     

       27
       27
       +
         # in `programs.cpu-energy-meter`, which will have the required

     

       28
       28
       +
         # capabilities to access MSR.

     

       29
       29
       +
         # If we add `cpu-energy-meter` here, BenchExec will instead call an executable

     

       30
       30
       +
         # without `CAP_SYS_RAWIO` and fail.

     

       31
       31
       +
         propagatedBuildInputs = with python3.pkgs; [

     

       32
       32
       +
           coloredlogs

     

       33
       33
       +
           lxml

     

       34
       34
       +
           pystemd

     

       35
       35
       +
           pyyaml

     

       36
       36
       +
         ];

     

       37
       37
       +
       

     

       38
       38
       +
         makeWrapperArgs = [ "--set-default LIBSECCOMP ${lib.getLib libseccomp}/lib/libseccomp.so" ];

     

       39
       39
       +
       

     

       40
       40
       +
         passthru.tests =

     

       41
       41
       +
           let

     

       42
       42
       +
             testVersion = result: testers.testVersion {

     

       43
       43
       +
               command = "${result} --version";

     

       44
       44
       +
               package = benchexec;

     

       45
       45
       +
             };

     

       46
       46
       +
           in

     

       47
       47
       +
           {

     

       48
       48
       +
             nixos = nixosTests.benchexec;

     

       49
       49
       +
             benchexec-version = testVersion "benchexec";

     

       50
       50
       +
             runexec-version = testVersion "runexec";

     

       51
       51
       +
             table-generator-version = testVersion "table-generator";

     

       52
       52
       +
             containerexec-version = testVersion "containerexec";

     

       53
       53
       +
           };

     

       54
       54
       +
       

     

       55
       55
       +
         meta = with lib; {

     

       56
       56
       +
           description = "A Framework for Reliable Benchmarking and Resource Measurement.";

     

       57
       57
       +
           homepage = "https://github.com/sosy-lab/benchexec";

     

       58
       58
       +
           maintainers = with maintainers; [ lorenzleutgeb ];

     

       59
       59
       +
           license = licenses.asl20;

     

       60
       60
       +
           mainProgram = "benchexec";

     

       61
       61
       +
         };

     

       62
       62
       +
       }

+40

pkgs/by-name/cp/cpu-energy-meter/package.nix

···

       1
       1
       +
       { lib

     

       2
       2
       +
       , stdenv

     

       3
       3
       +
       , fetchFromGitHub

     

       4
       4
       +
       , libcap

     

       5
       5
       +
       }:

     

       6
       6
       +
       stdenv.mkDerivation rec {

     

       7
       7
       +
         pname = "cpu-energy-meter";

     

       8
       8
       +
         version = "1.2";

     

       9
       9
       +
       

     

       10
       10
       +
         src = fetchFromGitHub {

     

       11
       11
       +
           owner = "sosy-lab";

     

       12
       12
       +
           repo = "cpu-energy-meter";

     

       13
       13
       +
           rev = version;

     

       14
       14
       +
           hash = "sha256-QW65Z8mRYLHcyLeOtNAHjwPNWAUP214wqIYclK+whFw=";

     

       15
       15
       +
         };

     

       16
       16
       +
       

     

       17
       17
       +
         postPatch = ''

     

       18
       18
       +
           substituteInPlace Makefile \

     

       19
       19
       +
             --replace "DESTDIR :=" "DESTDIR := $out" \

     

       20
       20
       +
             --replace "PREFIX := /usr/local" "PREFIX :="

     

       21
       21
       +
         '';

     

       22
       22
       +
       

     

       23
       23
       +
         buildInputs = [ libcap ];

     

       24
       24
       +
       

     

       25
       25
       +
         env.NIX_CFLAGS_COMPILE = "-fcommon";

     

       26
       26
       +
       

     

       27
       27
       +
         postInstall = ''

     

       28
       28
       +
           install -Dm444 -t $out/etc/udev/rules.d $src/debian/additional_files/59-msr.rules

     

       29
       29
       +
         '';

     

       30
       30
       +
       

     

       31
       31
       +
         meta = with lib; {

     

       32
       32
       +
           description = "A tool for measuring energy consumption of Intel CPUs";

     

       33
       33
       +
           homepage = "https://github.com/sosy-lab/cpu-energy-meter";

     

       34
       34
       +
           changelog = "https://github.com/sosy-lab/cpu-energy-meter/blob/main/CHANGELOG.md";

     

       35
       35
       +
           maintainers = with maintainers; [ lorenzleutgeb ];

     

       36
       36
       +
           license = licenses.bsd3;

     

       37
       37
       +
           platforms = [ "x86_64-linux" ];

     

       38
       38
       +
           mainProgram = "cpu-energy-meter";

     

       39
       39
       +
         };

     

       40
       40
       +
       }

+28

pkgs/by-name/pq/pqos-wrapper/package.nix

···

       1
       1
       +
       { lib

     

       2
       2
       +
       , intel-cmt-cat

     

       3
       3
       +
       , fetchFromGitLab

     

       4
       4
       +
       , python3

     

       5
       5
       +
       }:

     

       6
       6
       +
       python3.pkgs.buildPythonApplication rec {

     

       7
       7
       +
         pname = "pqos-wrapper";

     

       8
       8
       +
         version = "unstable-2022-01-31";

     

       9
       9
       +
       

     

       10
       10
       +
         src = fetchFromGitLab {

     

       11
       11
       +
           group = "sosy-lab";

     

       12
       12
       +
           owner = "software";

     

       13
       13
       +
           repo = pname;

     

       14
       14
       +
           rev = "ce816497a07dcb4b931652b98359e4601a292b15";

     

       15
       15
       +
           hash = "sha256-SaYr6lVucpJjVtGgxRbDGYbOoBwdfEDVKtvD+M1L0o4=";

     

       16
       16
       +
         };

     

       17
       17
       +
       

     

       18
       18
       +
         makeWrapperArgs = [ "--prefix LD_LIBRARY_PATH : ${lib.makeLibraryPath [ intel-cmt-cat ]}" ];

     

       19
       19
       +
       

     

       20
       20
       +
         meta = with lib; {

     

       21
       21
       +
           description = "Wrapper for Intel PQoS for the purpose of using it in BenchExec";

     

       22
       22
       +
           homepage = "https://gitlab.com/sosy-lab/software/pqos-wrapper";

     

       23
       23
       +
           maintainers = with maintainers; [ lorenzleutgeb ];

     

       24
       24
       +
           license = licenses.asl20;

     

       25
       25
       +
           platforms = [ "x86_64-linux" ];

     

       26
       26
       +
           mainProgram = "pqos_wrapper";

     

       27
       27
       +
         };

     

       28
       28
       +
       }