Difference between revisions of "Installation"

Revision as of 20:09, 12 October 2022

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

Installing from packages

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

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-3.19.tar.gz
Version:	3.19 "Bronze Peacock"
Released:	27 Nov 2023
GIT tag:	v3.19

Installing build dependencies

Compiler and C Library

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

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

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

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

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

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

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 tests/zdtm/ directory.

@@ Line 1: / Line 1: @@
-<code>criu</code> is an utility to checkpoint/restore a process tree. This page describes how to manually build and install prerequisites and the tool itself.
+<code>criu</code> is an utility to checkpoint/restore a process tree. This page describes how to get CRIU binary on your box.
 == Installing from packages ==
-Some 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.
+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 Source ==
+== Obtaining CRIU sources ==
-You can download the source code as a [https://download.openvz.org/criu/ release tarball] or sync the [https://github.com/xemul/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}}
+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}}
-== Build dependencies ==
+== Installing build dependencies ==
 === Compiler and C Library ===
@@ Line 21: / Line 21: @@
 === Protocol Buffers ===
-CRIU uses the [https://developers.google.com/protocol-buffers/ Google Protocol Buffers] to read and write [[images]] and thus requires [https://github.com/protobuf-c/protobuf-c C language bindings]. The <code>protoc</code> tool is required at build time and the <code>libprotobuf-c.so</code> shared object is required at build and run time. [[CRIT]] also uses python language bindings for protocol buffers and requires the <code>descriptor.proto</code> file typically provided by a distribution's protobuf development package.
+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.
-==== Distribution Packages ====
+; RPM packages
-The easiest way is to install distribution packages.
+: <code>protobuf protobuf-c protobuf-c-devel protobuf-compiler protobuf-devel protobuf-python </code>
-* RPM package names
+; Deb packages
-** <code>group Development\ Tools</code>
+: <code>libprotobuf-dev libprotobuf-c-dev protobuf-c-compiler protobuf-compiler python3-protobuf</code>
-** <code>protobuf</code>
-** <code>protobuf-c</code>
-** <code>protobuf-c-devel</code>
-** <code>protobuf-compiler</code>
-** <code>protobuf-devel</code>
-** <code>protobuf-python</code>
-** <code>libnet-devel</code>
-** <code>libnl3-devel</code>
-* Debian package names
-** <code>build-essential</code>
-** <code>libprotobuf-dev</code>
-** <code>libprotobuf-c0-dev</code>
-** <code>protobuf-c-compiler</code>
-** <code>protobuf-compiler</code>
-** <code>python-protobuf</code>
-** <code>libnet1-dev</code>
-* Ubuntu
-** The below will get your freshly installed Ubuntu host ready to compile criu. "--no-install-recommends" parameter is to avoid asciidoc pulling in a lot of dependencies.
-** sudo apt-get install --no-install-recommends git build-essential libprotobuf-dev libprotobuf-c0-dev protobuf-c-compiler protobuf-compiler python-protobuf libnl-3-dev libpth-dev pkg-config libcap-dev asciidoc xmlto libnet-dev
 Optionally, you may [[build protobuf]] from sources.
-=== Other deps ===
+=== Other stuff ===
 * <code>pkg-config</code> to check on build library dependencies.
-* <code>libnl3</code> and <code>libnl3-devel</code> (RPM distros) or <code>libnl-3-dev</code> (DEB distros) for network operations.
+* <code>python-ipaddress</code> is used by CRIT to pretty-print IP addresses and is also required by zdtm.py
-* <code>python-ipaddr</code> is used by CRIT to pretty-print ip.
+* <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.
-* If <code>libbsd</code> available, CRIU will be compiled with setproctitle() support. It will allow to make process titles of service workers to be more verbose.
+* <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]]
-* The iproute2 tool 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 written in the environment variable <code>CR_IP_TOOL</code>.
+* <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) or <code>libcap-dev</code> (DEB)
+* <code>libcap-devel</code> (RPM) / <code>libcap-dev</code> (DEB) - Require
-* If you would like to use <code>make test</code> you should install <code>libaio-devel</code> (RPM) or <code>libaio-dev</code> (DEB).
+* <code>libnet-devel libnl3-devel</code> (RPM) / <code>libnet1-dev</code> (DEB) / <code>libnl-3-dev libnet-dev</code> (Ubuntu) - Require
-* For test launcher <code>zdtm.py</code> you need <code>PyYAML</code> (RPM) or <code>python-yaml</code> (DEB).
+* <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
-== Linux Kernel ==
+* <code>python2-future</code> or <code>python3-future</code> is now needed for zdtm.py tests launcher
-Linux kernel v3.11 or newer is required, with some specific options set. Various CRIU features might require even newer kernel. If your distribution does not provide needed kernel, you might want to [[Linux kernel|compile one yourself]]. Criu can [[check the kernel]] features presence.
-== Building CRIU From Source ==
-=== Native Compilation ===
-Simply run <code>make</code> in the CRIU source directory.
-=== Compilation in Docker container ===
-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.
-=== Non-standard compilation ===
-<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
-Building natively, but specifying built dependencies manually
-<div class="mw-collapsible-content">
- cd deps
- rsync -a --exclude=.git --exclude=deps .. criu-`uname -m`
- cd criu-`uname -m`
- make \
-   USERCFLAGS="-I`pwd`/../`uname -m`-linux-gnu/include -L`pwd`/../`uname -m`-linux-gnu/lib" \
-   PATH="`pwd`/../`uname -m`-linux-gnu/bin:$PATH"
- sudo LD_LIBRARY_PATH=`pwd`/../`uname -m`-linux-gnu/lib ./criu check
- cd ../..
-</div>
-</div>
-<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
-Cross Compilation for ARM
-<div class="mw-collapsible-content">
-ARMv7
- cd deps
- rsync -a --exclude=.git --exclude=deps .. criu-arm
- cd criu-arm
- make \
-   ARCH=arm \
-   CROSS_COMPILE=`pwd`/../`uname -m`-linux-gnu/bin/arm-linux-gnueabihf- \
-   USERCFLAGS="-I`pwd`/../arm-linux-gnueabihf/include -L`pwd`/../arm-linux-gnueabihf/lib" \
-   PATH="`pwd`/../`uname -m`-linux-gnu/bin:$PATH"
- cd ../..
-ARMv8
+For APT use the <code>--no-install-recommends</code> parameter is to avoid asciidoc pulling in a lot of dependencies.
-  cd deps
+Also read about [[ZDTM test suite]] if you will run CRIU tests, those sources need other deps.
-  rsync -a --exclude=.git --exclude=deps .. criu-aarch64
-  cd criu-aarch64
-  make \
-   ARCH=aarch64 \
-   CROSS_COMPILE=`pwd`/../`uname -m`-linux-gnu/bin/aarch64-linux-gnu- \
-   USERCFLAGS="-I`pwd`/../aarch64-linux-gnu/include -L`pwd`/../aarch64-linux-gnu/lib" \
-   PATH="`pwd`/../`uname -m`-linux-gnu/bin:$PATH"
-  cd ../..
-</div>
-</div>
-=== Configuration ===
+== Building the tool ==
-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.
+Simply run <code>make</code> in the CRIU source directory. This is the standard way, but there are some options available.
-''Main article: [[Configuring]]''
+# 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.
+# 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]]
-== Installation ==
+== Installing ==
-CRIU works perfectly even when run from the sources directory (with the "./criu" command), but if you want to have in standard paths run <code>make install</code>.
-You may need to install the following packages to generate docs in Debian-based OS's to avoid errors from install-man:
+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.
-* <code>asciidoc</code>
-* <code>xmlto</code>
 == Checking That It Works ==
-First thing to do is to run <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.
+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]].
-Some kernel functionality is required in rare cases and may not block the dump (but sometimes may). These features can be checked by adding the <code>--extra</code> flag.
-If you're using our custom kernel, then the <code>--all</code> option can be used, in this case CRIU would check for ''all'' the kernel features to work.
 You can then try running the [[ZDTM Test Suite]] which sits in the <code>tests/zdtm/</code> directory.
@@ Line 141: / Line 67: @@
 == Further reading ==
-* [[Checking the kernel]]
 * [[Usage]]
 * [[Advanced usage]]
@@ Line 147: / Line 72: @@
 [[Category:HOWTO]]
+[[Category:Editor help needed]]