Difference between revisions of "Installation"

Latest revision as of 01:56, 30 September 2023

criu is an utility to checkpoint/restore a process tree. This page describes how to get CRIU binary on your box.

Installing from packages[edit]

Many distributions provide ready-to-use packages. If no, or the CRIU version you want is not yet there, you will need to get CRIU sources and compile it.

Obtaining CRIU sources[edit]

You can download the source code as a release tarball or sync the git repository. If you plan to modify CRIU sources (e.g. to contribute the code back) the latter way is highly recommended. The latest and greatest sources are:

Tarball:	criu-4.0.tar.gz
Version:	4.0 "CRIUDA"
Released:	20 Sep 2024
GIT tag:	v4.0

Installing build dependencies[edit]

Compiler and C Library[edit]

CRIU is mostly written in C and the build system is based on Makefiles. Thus just install standard gcc and make packages (on Debian use build-essential).

For building with 32bit tasks C/R support you will need libc6-dev-i386, gcc-multilib instead of gcc.

Cross-compilation for ARM is also possible.

Protocol Buffers[edit]

CRIU uses the Google Protocol Buffers to read and write images. The protoc tool is used at build time and CRIU is linked with the libprotobuf-c.so. Also CRIT uses python bindings and the descriptor.proto file which typically provided by a distribution's protobuf development package.

RPM packages: protobuf protobuf-c protobuf-c-devel protobuf-compiler protobuf-devel protobuf-python

Deb packages: libprotobuf-dev libprotobuf-c-dev protobuf-c-compiler protobuf-compiler python3-protobuf

Optionally, you may build protobuf from sources.

Other stuff[edit]

pkg-config to check on build library dependencies.
python-ipaddress is used by CRIT to pretty-print IP addresses and is also required by zdtm.py
libbsd-devel (RPM) / libbsd-dev (DEB) If available, CRIU will be compiled with setproctitle() support and set verbose process titles on service workers.
iproute2 version 3.5.0 or higher is needed for dumping network namespaces. The latest one can be cloned from iproute2. It should be compiled and a path to ip set as the CR_IP_TOOL variable
nftables (RPM) / libnftables-dev (DEB) If available, CRIU will be compiled with nftables C/R support
libcap-devel (RPM) / libcap-dev (DEB) - Require
libnet-devel libnl3-devel (RPM) / libnet1-dev (DEB) / libnl-3-dev libnet-dev (Ubuntu) - Require
libaio-devel (RPM) / libaio-dev (DEB) is needed to run tests
gnutls-devel (RPM) / libgnutls28-dev (DEB), if available, CRIU will be compiled with TLS support
python2-future or python3-future is now needed for zdtm.py tests launcher
libdrm-devel (RPM) / libdrm-dev (DEB) If available, CRIU will be compiled with support for AMD GPUs.

For APT use the --no-install-recommends parameter is to avoid asciidoc pulling in a lot of dependencies. Also read about ZDTM test suite if you will run CRIU tests, those sources need other deps.

Building the tool[edit]

Simply run make in the CRIU source directory. This is the standard way, but there are some options available.

There's a docker-build target in Makefile which builds CRIU in Ubuntu Docker container. Just run make docker-build and that's it.
CRIU has functionality that is either optional or behaves differently depending on the kernel CRIU is running on. By default build process includes maximum of it, but this behavior can be changed.
You may specify build dependencies by hands

Installing[edit]

CRIU works perfectly even when run from the sources directory (with the ./criu/criu command), but if you want to have in standard paths run make install. You may need to install asciidoc and xmlto packages to make install-man work.

Checking That It Works[edit]

Linux kernel v3.11 or newer is required, with some specific config options turned on. Various advanced CRIU features might require even newer kernel. So the first thing to do is to check the kernel by running criu check. At the end it should say "Looks OK", if it doesn't the messages on the screen explain what functionality is missing. If your distribution does not provide needed kernel, you might want to compile one yourself.

You can then try running the ZDTM Test Suite which sits in the test/zdtm/ directory.

@@ Line 1: / Line 1: @@
-'''CRtools''' is an utility to checkpoint/restore a process tree.
+<code>criu</code> is an utility to checkpoint/restore a process tree. This page describes how to get CRIU binary on your box.
-== Tools installation ==
+== Installing from packages ==
-Get the latest release from [[Releases]].
+Many distributions provide ready-to-use [[packages]]. If no, or the CRIU version you want is not yet there, you will need to get CRIU sources and compile it.
-Alternatively, use [http://git.criu.org/?p=crtools.git;a=summary git.criu.org] git repository.
+== Obtaining CRIU sources ==
-Clone this repo to test new functionality. Anything but '''master''' branch are development ones, don't refer on them.
-Before building, make sure you have C bindings for Google's Protocol Buffers installed. In rpm-based world this is <code>protobuf-c-devel</code> package.
+You can download the source code as a [https://download.openvz.org/criu/ release tarball] or sync the [https://github.com/checkpoint-restore/criu git repository]. If you plan to modify CRIU sources (e.g. to [[How to submit patches|contribute the code back]]) the latter way is highly recommended. The latest and greatest sources are: {{Latest release}}
-Then run <code>make</code> in the sources root.
+== Installing build dependencies ==
-== Kernel configuration ==
+=== Compiler and C Library ===
-Make sure you have the following options turned on:
+CRIU is mostly written in C and the build system is based on Makefiles. Thus just install standard <code>gcc</code> and <code>make</code> packages (on Debian use <code>[https://packages.debian.org/build-essential build-essential]</code>).
-* General setup -> Checkpoint/restore support (<code>CONFIG_CHECKPOINT_RESTORE</code>)
+For building with [[32bit tasks C/R]] support you will need <code>libc6-dev-i386, gcc-multilib</code> instead of <code>gcc</code>.
-* General setup -> open by fhandle syscalls (<code>CONFIG_FHANDLE</code>)
-* General setup -> Enable eventfd() system call (<code>CONFIG_EVENTFD</code>)
-* General setup -> Enable eventpoll support (<code>CONFIG_EPOLL</code>)
-* File systems -> Inotify support for userspace (<code>CONFIG_INOTIFY_USER</code>)
-* Networking support -> Networking options -> Unix domain sockets -> UNIX: socket monitoring interface (<code>CONFIG_UNIX_DIAG</code>)
-* Networking support -> Networking options -> TCP/IP networking -> INET: socket monitoring interface (<code>CONFIG_INET_DIAG</code>)
-Note you might have to enable
+[[ARM crosscompile|Cross-compilation for ARM]] is also possible.
-* General setup -> Configure standard kernel features (expert users) (<code>CONFIG_EXPERT</code>)
+=== Protocol Buffers ===
-option, which depends on
+CRIU uses the [https://developers.google.com/protocol-buffers/ Google Protocol Buffers] to read and write [[images]]. The <code>protoc</code> tool is used at build time and CRIU is linked with the <code>libprotobuf-c.so</code>. Also [[CRIT]] uses python  bindings and the <code>descriptor.proto</code> file which typically provided by a distribution's protobuf development package.
-* General setup -> Embedded system (<code>CONFIG_EMBEDDED</code>)
+; RPM packages
+: <code>protobuf protobuf-c protobuf-c-devel protobuf-compiler protobuf-devel protobuf-python </code>
-(welcome to Kconfig reverse chains hell).
+; Deb packages
+: <code>libprotobuf-dev libprotobuf-c-dev protobuf-c-compiler protobuf-compiler python3-protobuf</code>
-The <code>v3.5</code> upstream kernel already has most of the required functionality merged. Some is sill out-of-tree though, so you might need to clone the [https://github.com/cyrillos/linux-2.6 linux-2.6-crtools.git], checkout the '''crtools-3.5''' branch and compile the kernel.
+Optionally, you may [[build protobuf]] from sources.
-== Checking how it works ==
+=== Other stuff ===
-You can first look into the [[ZDTM Test Suite]] which sits in the <code>tests/zdtm/</code> directory.
+* <code>pkg-config</code> to check on build library dependencies.
+* <code>python-ipaddress</code> is used by CRIT to pretty-print IP addresses and is also required by zdtm.py
+* <code>libbsd-devel</code> (RPM) / <code>libbsd-dev</code> (DEB) If available, CRIU will be compiled  with <code>setproctitle()</code> support and set verbose process titles on service workers.
+* <code>iproute2</code> version 3.5.0 or higher is needed for dumping network namespaces. The latest one can be cloned from [http://git.kernel.org/?p=linux/kernel/git/shemminger/iproute2.git;a=summary iproute2]. It should be compiled and a path to ip set as the [[environment variables|<code>CR_IP_TOOL</code> variable]]
+* <code>nftables</code> (RPM) / <code>libnftables-dev</code> (DEB) If available, CRIU will be compiled with nftables C/R support
+* <code>libcap-devel</code> (RPM) / <code>libcap-dev</code> (DEB) - Require
+* <code>libnet-devel libnl3-devel</code> (RPM) / <code>libnet1-dev</code> (DEB) / <code>libnl-3-dev libnet-dev</code> (Ubuntu) - Require
+* <code>libaio-devel</code> (RPM) / <code>libaio-dev</code> (DEB) is needed to run tests
+* <code>gnutls-devel</code> (RPM) / <code>libgnutls28-dev</code> (DEB), if available, CRIU will be compiled with [[TLS]] support
+* <code>python2-future</code> or <code>python3-future</code> is now needed for zdtm.py tests launcher
+* <code>libdrm-devel</code> (RPM) / <code>libdrm-dev</code> (DEB) If available, CRIU will be compiled with support for AMD GPUs.
-== Using CR tools ==
+For APT use the <code>--no-install-recommends</code> parameter is to avoid asciidoc pulling in a lot of dependencies.
+Also read about [[ZDTM test suite]] if you will run CRIU tests, those sources need other deps.
-Please see [[running CR tools]] article.
+== Building the tool ==
-== CR tools mailing list ==
+Simply run <code>make</code> in the CRIU source directory. This is the standard way, but there are some options available.
-If you're interested in CR tools development don't hesitate to subscribe to the CRtools mailing list which can be found here
+# There's a ''docker-build'' target in Makefile which builds CRIU in Ubuntu Docker container. Just run <code>make docker-build</code> and that's it.
-[https://openvz.org/mailman/listinfo/criu].
+# CRIU has functionality that is either optional or behaves differently depending on the kernel CRIU is running on. By default build process includes maximum of it, but this behavior [[configuring|can be changed]].
+# You may [[Manual build deps|specify build dependencies by hands]]
+== Installing ==
+CRIU works perfectly even when run from the sources directory (with the <code>./criu/criu</code> command), but if you want to have in standard paths run <code>make install</code>. You may need to install <code>asciidoc</code> and <code>xmlto</code> packages to make install-man work.
+== Checking That It Works ==
+Linux kernel v3.11 or newer is required, with some specific config options turned on. Various advanced CRIU features might require even newer kernel.  So the first thing to do is to [[Checking the kernel|check the kernel]] by running <code>criu check</code>. At the end it should say "Looks OK", if it doesn't the messages on the screen explain what functionality is missing. If your distribution does not provide needed kernel, you might want to [[Linux kernel|compile one yourself]].
+You can then try running the [[ZDTM Test Suite]] which sits in the <code>test/zdtm/</code> directory.
+== Further reading ==
+* [[Usage]]
+* [[Advanced usage]]
+* [[:Category:HOWTO]]
+[[Category:HOWTO]]
+[[Category:Editor help needed]]