Difference between revisions of "Installation"

From CRIU
Jump to: navigation, search
(Building Protocol Buffers From Source)
(Protocol Buffers with C Bindings)
Line 18: Line 18:
  
 
=== Protocol Buffers with C Bindings ===
 
=== 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 ====
 
==== 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: <code>protobuf-c-devel</code>. Debian package name: <code>libprotobuf-c0-dev</code>.
+
The easiest approach for most would be to install distribution packages. RPM package names: <code>protobuf-compiler</code>,<code>protobuf-c-devel</code>. Debian package names: <code>protobuf-compiler</code>, <code>libprotobuf-c0-dev</code>.
  
 
==== Building Protocol Buffers From Source ====
 
==== 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 <code>git</code>. Note that when cross compiling you will need to compile once for your build machine in order to get a <code>protoc</code> binary to use in the build process, and build once for each target machine to generate <code>libprotobuf-c.so</code>.
+
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.
  
 +
mkdir deps
 +
cd deps
 
  git svn clone http://protobuf.googlecode.com/svn/trunk protobuf
 
  git svn clone http://protobuf.googlecode.com/svn/trunk protobuf
 
  cd protobuf
 
  cd protobuf
 
  ./autogen.sh
 
  ./autogen.sh
  ./configure --prefix=`pwd`/`uname -m`
+
  ./configure --prefix=`pwd`/../`uname -m`
 
  make
 
  make
 
  make install
 
  make install
  cd ..
+
  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 ..
 
  
 +
cd deps
 
  git svn clone http://protobuf-c.googlecode.com/svn/trunk protobuf-c
 
  git svn clone http://protobuf-c.googlecode.com/svn/trunk protobuf-c
 
  cd protobuf-c
 
  cd protobuf-c
  ./autogen.sh
+
  ./autogen.sh --prefix=`pwd`/../`uname -m` --disable-protoc
./configure --prefix=`pwd`/`uname -m` PATH="`pwd`/../protobuf/`uname -m`/bin:$PATH"
 
 
  make
 
  make
 
  make install
 
  make install

Revision as of 00:41, 26 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.svg Note: Most probably you don't need manual installation, but rather Packages for your distro.

Prerequisites

Compiler and C Library

For native compilation on Debian based systems, install the build-essential package. For cross compiling for ARM and AArch64, the Linaro prebuilt toolchains are a good choice. Installing them is described below.

mkdir toolchains
cd toolchains
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
export PATH="`pwd`/bin:$PATH"
cd ..

Protocol Buffers with C Bindings

CRIU uses the C language bindings of Google Protocol Buffers for serialization. The protoc tool is required at build time and libprotobuf-c.so 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: protobuf-compiler,protobuf-c-devel. Debian package names: protobuf-compiler, libprotobuf-c0-dev.

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.

mkdir deps
cd deps
git svn clone http://protobuf.googlecode.com/svn/trunk protobuf
cd protobuf
./autogen.sh
./configure --prefix=`pwd`/../`uname -m`
make
make install
cd ../..
cd deps
git svn clone http://protobuf-c.googlecode.com/svn/trunk protobuf-c
cd protobuf-c
./autogen.sh --prefix=`pwd`/../`uname -m` --disable-protoc
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-3.15.tar.bz2
Version: 3.15 "Titanium Falcon"
Released: 03 Nov 2020
GIT tag: v3.15

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.