~danyspin97/benice

Apply CPU and I/O policies
~danyspin97/benice

New ticket tracker added

25 days ago
~danyspin97/benice-discuss

New mailing list added

25 days ago

#benice

License Version Liberapay receiving

benice is a program that applies CPU and I/O policies on system processes. It uses a predefined set of rules that can be extended and customized.

#Features

  • Apply CPU scheduling policies
  • Apply CPU and I/O niceness value
  • Written in zig for efficency and safety
  • No system dependencies (does not use any system command)
  • Lightweight client/server architecture with fallback
  • No periodic process scanning

#Getting started

#Dependencies

benice only depends on zig master version.

#Build && Install

$ make
$ sudo make install PREFIX=/usr

#Usage

#Daemon

benice uses a client/server architecture. Therefore to properly work beniced daemon should be started. For security reasons (explained here), beniced needs to be run as root:

# beniced

benice can also work without the daemon, but it will need to read the rules each time. This can cause significant overhead when the number of rules to read is significant.

You can also use the provided systemd service to run beniced:

$ systemctl enable beniced
$ systemctl start beniced

#Client

benice can be used in two different ways:

  • by prepending benice before calling an executable
  • by creating symlinks in /usr/local/benice and prepend this directory to PATH

#Prepending benice executable

This is the easiest way that lets you apply benice rule to an executable. To run cat (provided that there is a rule for it), type:

$ benice cat [[args] ...]

This is the preferred method because this way benice can apply the rules to all supported processes on the system.

Run the following command to setup the symlinks in /usr/local/benice:

# benice-setup

benice installs by default a profile file in /etc/profile.d/ that prepend its directory to PATH. However, if you manually set this value in your .bashrc, you need to adjust it accordingly.

#Security

To set high I/O and CPU priorities, benice executable respectively needs CAP_SYS_ADMIN and CAP_SYS_NICE capabilities. These capabilities can only be set by the root user but benice executable does not require root privileges to be used and can potentially set high priorities to malicious processes. As a security reason, only users with root privileges can add rules. The daemon will listen on a low number port, so any non-root process cannot impersonate beniced.

#Credits

Credits to @Nefelim4ag for its work on Ananicy.

#License

benice is licensed under GPLv3.