Difference between revisions of "Installation"

Revision as of 10:08, 23 July 2014

criu is an utility to checkpoint/restore a process tree. This page describes how to manually build and install prerequisites and the tool itself.

Note: Most probably you don't need manual installation, but rather Packages for your distro.

Prerequisites

Protocol Buffers with C Bindings

Distribution Packages

CRIU uses the C bindings of Google's Protocol Buffers. The easiest approach for most would be to install a distribution packages. RPM package name: protobuf-c-devel. Debian package name: libprotobuf-c0-dev.

Building Protocol Buffers From Source

If you would like to build from source instead of using a package, the Protocol Buffer library can be found at http://code.google.com/p/protobuf/, while the Protocol Buffer C bindings can be found at http://code.google.com/p/protobuf-c/. You can use the following commands to obtain the source code repositories via git. Note that when cross compiling you will need to compile once for your build machine in order to get a protoc binary to use in the build process, and build once for each target machine to generate libprotobuf.so.

git svn clone http://protobuf.googlecode.com/svn/trunk protobuf
cd protobuf
./autogen.sh
./configure --prefix=`pwd`/`uname -m`
make
make install
cd ..

If you are cross compiling, then you will additionally want to build a version for your target architecture. This example targets AArch64.

cd protobuf
./configure --host=aarch64-linux-gnu --prefix=`pwd`/aarch64 --with-protoc=`pwd`/`uname -m`/bin/protoc
make
make install
cd ..

git svn clone http://protobuf-c.googlecode.com/svn/trunk protobuf-c
cd protobuf-c
./autogen.sh
./configure --prefix=`pwd`/`uname -m` PATH="`pwd`/../protobuf/`uname -m`/bin:$PATH"
make
make install
cd ..

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.

Note you might have to enable

CONFIG_EXPERT: General setup -> Configure standard kernel features (expert users)

option, which depends on

CONFIG_EMBEDDED: General setup -> Embedded system

(welcome to Kconfig reverse chains hell).

The following options must be enabled for CRIU to work:

CONFIG_CHECKPOINT_RESTORE: General setup -> Checkpoint/restore support

CONFIG_NAMESPACES: General setup -> Namespaces support

CONFIG_UTS_NS: General setup -> Namespaces support -> UTS namespace

CONFIG_IPC_NS: General setup -> Namespaces support -> IPC namespace

CONFIG_PID_NS: General setup -> Namespaces support -> PID namespaces

CONFIG_NET_NS: General setup -> Namespaces support -> Network namespace

CONFIG_FHANDLE: General setup -> open by fhandle syscalls

CONFIG_EVENTFD: General setup -> Enable eventfd() system call

CONFIG_EPOLL: General setup -> Enable eventpoll support

CONFIG_INOTIFY_USER: File systems -> Inotify support for userspace

CONFIG_IA32_EMULATION: Executable file formats -> Emulations -> IA32 Emulation

CONFIG_UNIX_DIAG: Networking support -> Networking options -> Unix domain sockets -> UNIX: socket monitoring interface

CONFIG_INET_DIAG: Networking support -> Networking options -> TCP/IP networking -> INET: socket monitoring interface

CONFIG_INET_UDP_DIAG: Networking support -> Networking options -> TCP/IP networking -> INET: socket monitoring interface -> UDP: socket monitoring interface

CONFIG_PACKET_DIAG: Networking support -> Networking options -> Packet socket -> Packet: sockets monitoring interface

CONFIG_NETLINK_DIAG: 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

CONFIG_MEM_SOFT_DIRTY: 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.

CONFIG_NET_PKTGEN: 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 iproute2. It should be compiled and a path to ip written in the environment variable CR_IP_TOOL.

Building CRIU From Source

Get the latest release:

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

Alternatively, use git.criu.org git repository. Clone this repo to test new functionality.

Then run make in the sources root. Please note that the tool only supports x86_64 and ARM architectures.

Checking That It Works

First thing to do is to run

# criu check --ms

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

There's a known issue with BTRFS spoiling dev_t values for files and sockets! Not all tests will work on it.

Using CR tools

Please see Usage and Advanced usage, as well as Category:HOWTO.