Difference between revisions of "Installation"

From CRIU
Jump to: navigation, search
(Native protobuf-c)
(Protocol Buffers)
 
(135 intermediate revisions by 17 users not shown)
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.
  
{{Note|Most probably you don't need manual installation, but rather [[Packages]] for your distro.}}
+
== Installing from packages ==
  
== Obtaining CRIU Source ==
+
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.
  
You can download the source code as a release tarball or sync the [http://git.criu.org/?p=criu.git;a=summary git repository].
+
== Obtaining CRIU sources ==
  
{{Out|{{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}}
  
git clone git://git.criu.org/criu.git
+
== Installing build dependencies ==
cd criu
 
 
 
== Dependencies ==
 
  
 
=== Compiler and C Library ===
 
=== Compiler and C Library ===
For native compilation on Debian based systems, install the <code>build-essential</code> package. For cross compiling for ARM and AArch64, the Linaro prebuilt toolchains are a good choice. Installing them is described below.
 
 
mkdir deps
 
cd deps
 
wget http://releases.linaro.org/14.06/components/toolchain/binaries/gcc-linaro-arm-linux-gnueabihf-4.9-2014.06_linux.tar.xz
 
tar --strip=1 -xf gcc-linaro-arm-linux-gnueabihf-4.9-2014.06_linux.tar.xz
 
wget http://releases.linaro.org/14.06/components/toolchain/binaries/gcc-linaro-aarch64-linux-gnu-4.9-2014.06-02_linux.tar.xz
 
tar --strip=1 -xf gcc-linaro-aarch64-linux-gnu-4.9-2014.06-02_linux.tar.xz
 
cd ..
 
 
=== Protocol Buffers with C Bindings ===
 
 
CRIU uses the [http://code.google.com/p/protobuf-c/ C language bindings] of [http://code.google.com/p/protobuf/ Google Protocol Buffers] for serialization. The <code>protoc</code> tool is required at build time and <code>libprotobuf-c.so</code> is required at build time and at run time, assuming dynamic linking.
 
 
==== Distribution Packages ====
 
The easiest approach for most would be to install distribution packages. RPM package names: <code>protobuf-c-compiler</code>, <code>protobuf-c-devel</code>. Debian package names: <code>protobuf-c-compiler</code>, <code>libprotobuf-c0-dev</code>.
 
 
==== Building Protocol Buffers From Source ====
 
If you would like to build from source, you can use the following commands to obtain the source code repositories, configure, and build the code.
 
 
===== Native protobuf =====
 
cd deps
 
git svn clone http://protobuf.googlecode.com/svn/trunk protobuf
 
cd protobuf
 
./autogen.sh
 
./configure --prefix=`pwd`/../`uname -m`-linux-gnu
 
make
 
make install
 
cd ../..
 
 
===== Native protobuf-c =====
 
 
cd deps
 
git svn clone http://protobuf-c.googlecode.com/svn/trunk protobuf-c
 
cd protobuf-c
 
./bootstrap
 
mkdir ../pbc-`uname -m`
 
cd ../pbc-`uname -m`
 
../protobuf-c/configure --prefix=`pwd`/../`uname -m`-linux-gnu \
 
  CPPFLAGS=-I`pwd`/../`uname -m`-linux-gnu/include \
 
  LDFLAGS=-L`pwd`/../`uname -m`-linux-gnu/lib \
 
  PATH="`pwd`/../`uname -m`-linux-gnu/bin:$PATH"
 
make
 
make install
 
cd ../..
 
 
===== Cross Compiling for ARMv7 =====
 
If you would like to cross-compile for armv7:
 
 
cd deps
 
mkdir -p pbc-arm
 
cd pbc-arm
 
../protobuf-c/configure --host=arm-linux-gnueabihf --prefix=`pwd`/../arm-linux-gnueabihf --disable-protoc CC=`pwd`/../bin/arm-linux-gnueabihf-gcc
 
make
 
make install
 
cd ../..
 
 
===== Cross Compiling for ARMv8 =====
 
If you would like to cross-compile for armv8:
 
 
cd deps
 
mkdir -p pbc-aarch64
 
cd pbc-aarch64
 
  ../protobuf-c/configure --host=aarch64-linux-gnu --prefix=`pwd`/../aarch64-linux-gnu --disable-protoc CC=`pwd`/../bin/aarch64-linux-gnu-gcc
 
make
 
make install
 
cd ../..
 
 
== Building CRIU From Source ==
 
 
=== Native Compilation ===
 
With the CRIU source obtained in the first step and dependencies satisfied in the second step, we are now compile CRIU. For native compilation with the dependencies met using distribution packages, simply run <code>make</code> in the CRIU source directory.
 
 
Here is an example of building natively specifying manually built dependencies.
 
 
make \
 
  USERCFLAGS="-I`pwd`/deps/`uname -m`-linux-gnu/include -L`pwd`/deps/`uname -m`-linux-gnu/lib" \
 
  PATH="`pwd`/deps/`uname -m`-linux-gnu/bin:$PATH"
 
 
=== Cross Compilation for ARMv7 ===
 
 
make \
 
  ARCH=arm \
 
  CROSS_COMPILE=`pwd`/deps/bin/arm-linux-gnueabihf- \
 
  USERCFLAGS="-I`pwd`/deps/arm-linux-gnueabihf/include -L`pwd`/deps/arm-linux-gnueabihf/lib" \
 
  PATH="`pwd`/deps/`uname -m`-linux-gnu/bin:$PATH"
 
 
=== Cross Compilation for ARMv8 ===
 
 
  make \
 
  ARCH=aarch64 \
 
  CROSS_COMPILE=`pwd`/deps/bin/aarch64-linux-gnu- \
 
  USERCFLAGS="-I`pwd`/deps/aarch64-linux-gnu/include -L`pwd`/deps/aarch64-linux-gnu/lib" \
 
  PATH="`pwd`/deps/`uname -m`-linux-gnu/bin:$PATH"
 
 
=== Linux Kernel ===
 
  
Linux kernel v3.11 or newer is required, with some specific options set. If your distribution does not provide needed kernel, you might want to compile one yourself. Note we also have our [[custom kernel]], which might contain some experimental CRIU related patches.
+
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>).
  
Note you might have to enable
+
For building with [[32bit tasks C/R]] support you will need <code>libc6-dev-i386, gcc-multilib</code> instead of <code>gcc</code>.
; <code>CONFIG_EXPERT</code>
 
: General setup -> Configure standard kernel features (expert users)
 
option, which depends on
 
; <code>CONFIG_EMBEDDED</code>
 
: General setup -> Embedded system
 
(welcome to Kconfig reverse chains hell).
 
  
The following options must be enabled for CRIU to work:
+
[[ARM crosscompile|Cross-compilation for ARM]] is also possible.
  
; <code>CONFIG_CHECKPOINT_RESTORE</code>
+
=== Protocol Buffers ===
: General setup -> Checkpoint/restore support
 
  
; <code>CONFIG_NAMESPACES</code>
+
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 -> Namespaces support
 
  
; <code>CONFIG_UTS_NS</code>
+
; RPM packages
: General setup -> Namespaces support -> UTS namespace
+
: <code>protobuf protobuf-c protobuf-c-devel protobuf-compiler protobuf-devel protobuf-python</code>
  
; <code>CONFIG_IPC_NS</code>
+
; Deb packages
: General setup -> Namespaces support -> IPC namespace
+
: <code>libprotobuf-dev libprotobuf-c-dev protobuf-c-compiler protobuf-compiler python-protobuf</code>
  
; <code>CONFIG_PID_NS</code>
+
Optionally, you may [[build protobuf]] from sources.
: General setup -> Namespaces support -> PID namespaces
 
  
; <code>CONFIG_NET_NS</code>
+
=== Other stuff ===
: General setup -> Namespaces support -> Network namespace
 
  
; <code>CONFIG_FHANDLE</code>
+
* <code>pkg-config</code> to check on build library dependencies.
: General setup -> open by fhandle syscalls
+
* <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)
 +
* <code>libnet-devel libnl3-devel</code> (RPM) / <code>libnet1-dev</code> (DEB) / <code>libnl-3-dev libnet-dev</code> (Ubuntu)
 +
* <code>libaio-devel</code> (RPM) / <code>libaio-dev</code> (DEB) is needed to run tests
 +
* <code>python2-future</code> or <code>python3-future</code> is now needed for zdtm.py tests launcher
  
; <code>CONFIG_EVENTFD</code>
+
For APT use the <code>--no-install-recommends</code> parameter is to avoid asciidoc pulling in a lot of dependencies.
: General setup -> Enable eventfd() system call
+
Also read about [[ZDTM test suite]] if you will run CRIU tests, those sources need other deps.
  
; <code>CONFIG_EPOLL</code>
+
== Building the tool ==
: General setup -> Enable eventpoll support
 
  
; <code>CONFIG_INOTIFY_USER</code>
+
Simply run <code>make</code> in the CRIU source directory. This is the standard way, but there are some options available.
: File systems -> Inotify support for userspace
 
  
; <code>CONFIG_IA32_EMULATION</code>
+
# 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.
: Executable file formats -> Emulations -> IA32 Emulation
+
# 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]]
  
; <code>CONFIG_UNIX_DIAG</code>
+
== Installing ==
: Networking support -> Networking options -> Unix domain sockets -> UNIX: socket monitoring interface
 
  
; <code>CONFIG_INET_DIAG</code>
+
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.
: Networking support -> Networking options -> TCP/IP networking -> INET: socket monitoring interface
 
 
 
; <code>CONFIG_INET_UDP_DIAG</code>
 
: Networking support -> Networking options -> TCP/IP networking -> INET: socket monitoring interface -> UDP: socket monitoring interface
 
 
 
; <code>CONFIG_PACKET_DIAG</code>
 
: Networking support -> Networking options -> Packet socket -> Packet: sockets monitoring interface
 
 
 
; <code>CONFIG_NETLINK_DIAG</code>
 
: Networking support -> Networking options -> Netlink socket -> Netlink: sockets monitoring interface
 
 
 
For some [[usage scenarios]] there is an ability to track memory changes and produce [[incremental dumps]]. Need to enable
 
; <code>CONFIG_MEM_SOFT_DIRTY</code>
 
: Processor type and features -> Track memory changes
 
 
 
At the moment it's known that CRIU will '''NOT''' work if packet generator module is loaded. Thus make sure
 
that either module is unloaded or not compiled at all.
 
; <code>CONFIG_NET_PKTGEN</code>
 
: Networking support -> Networking options -> Network testing -> Packet generator
 
 
 
=== iproute2 ===
 
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>.
 
  
 
== Checking That It Works ==
 
== Checking That It Works ==
  
First thing to do is to run
+
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]].
 
 
<pre>
 
# criu check --ms
 
</pre>
 
 
 
At the end it should say "Looks OK", if it doesn't the messages on the screen explain what functionality is missing.
 
If you're using our custom kernel, then the <code>--ms</code> option should not 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.
 
You can then try running the [[ZDTM Test Suite]] which sits in the <code>tests/zdtm/</code> directory.
  
{{Out|There's a known issue with BTRFS spoiling dev_t values for files and sockets! Not all tests will work on it.}}
+
== Further reading ==
  
== Using CR tools ==
+
* [[Usage]]
 +
* [[Advanced usage]]
 +
* [[:Category:HOWTO]]
  
Please see [[Usage]] and [[Advanced usage]], as well as [[:Category:HOWTO]].
+
[[Category:HOWTO]]
 +
[[Category:Editor help needed]]

Latest revision as of 05:52, 24 December 2020

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-3.15.tar.bz2
Version: 3.15 "Titanium Falcon"
Released: 03 Nov 2020
GIT tag: v3.15

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 python-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)
  • libnet-devel libnl3-devel (RPM) / libnet1-dev (DEB) / libnl-3-dev libnet-dev (Ubuntu)
  • libaio-devel (RPM) / libaio-dev (DEB) is needed to run tests
  • 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[edit]

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

  1. There's a docker-build target in Makefile which builds CRIU in Ubuntu Docker container. Just run make docker-build and that's it.
  2. 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.
  3. 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 tests/zdtm/ directory.

Further reading[edit]