CRIU - User contributions [en]

Installation

2015-04-15T21:31:20Z

Dwangoac: /* Installation */ Fix formatting

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

== 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.

== Obtaining CRIU Source ==

You can download the source code as a release tarball or sync the [http://git.criu.org/?p=criu.git;a=summary git repository]. If you plan to modify CRIU sources the latter way is highly recommended.

=== Getting source tarball ===
: {{Latest release}}

=== Cloning git repository ===
git clone https://github.com/xemul/criu

== Dependencies ==

=== Compiler and C Library ===

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, <code>[https://packages.debian.org/build-essential build-essential]</code> will pull in both at once).

If you are cross compiling for ARM, use distribution packages or download prebuilt toolchains from Linaro.

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
Downloading Linaro toolchains
<div class="mw-collapsible-content">
sudo apt-get install lib32stdc++6 lib32z1 # These are ia32 binaries
mkdir -p deps/`uname -m`-linux-gnu
cd deps
wget http://releases.linaro.org/14.09/components/toolchain/binaries/gcc-linaro-arm-linux-gnueabihf-4.9-2014.09_linux.tar.xz
tar --strip=1 -C `uname -m`-linux-gnu -xf gcc-linaro-arm-linux-gnueabihf-4.9-2014.09_linux.tar.xz
wget http://releases.linaro.org/14.09/components/toolchain/binaries/gcc-linaro-aarch64-linux-gnu-4.9-2014.09_linux.tar.xz
tar --strip=1 -C `uname -m`-linux-gnu -xf gcc-linaro-aarch64-linux-gnu-4.9-2014.09_linux.tar.xz
cd ..
</div>
</div>

=== 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.

==== Distribution Packages ====
The easiest way is to install distribution packages.

* RPM package names
** <code>protobuf</code>
** <code>protobuf-c</code>
** <code>protobuf-c-devel</code>
** <code>protobuf-compiler</code>
** <code>protobuf-devel</code>
** <code>protobuf-python</code>
* Debian package names
** <code>libprotobuf-dev</code>
** <code>libprotobuf-c0-dev</code>
** <code>protobuf-c-compiler</code>
** <code>protobuf-compiler</code>
** <code>python-protobuf</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. On a Debian based system, you may have to install <code>autoconf curl g++ libtool</code> packages first.

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
To build protobuf
<div class="mw-collapsible-content">
cd deps
git clone https://github.com/google/protobuf.git protobuf
cd protobuf
./autogen.sh
./configure --prefix=`pwd`/../`uname -m`-linux-gnu
make
make install
cd ../..
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
To build protobuf-c
<div class="mw-collapsible-content">
cd deps
git clone https://github.com/protobuf-c/protobuf-c.git protobuf-c
cd protobuf-c
./autogen.sh
mkdir ../pbc-`uname -m`
cd ../pbc-`uname -m`
../protobuf-c/configure --prefix=`pwd`/../`uname -m`-linux-gnu \
PKG_CONFIG_PATH=`pwd`/../`uname -m`-linux-gnu/lib/pkgconfig
make
make install
cd ../..
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
To cross-compile for ARM some more tricks will be required.
<div class="mw-collapsible-content">
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 PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make install PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
cd ../..

For ARM8

cd deps
mkdir -p pbc-aarch64
cd pbc-aarch64
../protobuf-c/configure --host=aarch64-linux-gnu --prefix=`pwd`/../aarch64-linux-gnu \
--disable-protoc PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make install PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
cd ../..
</div>
</div>

=== Other deps ===

* <code>python-ipaddr</code> is used by CRIT to pretty-print ip.
* 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.
* 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>.

== 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.

=== Configuring the kernel ===

Most likely the first thing to enable is the <code>CONFIG_EXPERT=y</code> (General setup -> Configure standard kernel features (expert users)) option, which on x86_64 depends on the <code>CONFIG_EMBEDDED=y</code> (General setup -> Embedded system) one (welcome to Kconfig reverse chains hell).

The following options must be enabled for CRIU to work:

* ''General setup'' options
** <code>CONFIG_CHECKPOINT_RESTORE=y</code> (Checkpoint/restore support)
** <code>CONFIG_NAMESPACES=y</code> (Namespaces support)
** <code>CONFIG_UTS_NS=y</code> (Namespaces support -> UTS namespace)
** <code>CONFIG_IPC_NS=y</code> (Namespaces support -> IPC namespace)
** <code>CONFIG_PID_NS=y</code> (Namespaces support -> PID namespaces)
** <code>CONFIG_NET_NS=y</code> (Namespaces support -> Network namespace)
** <code>CONFIG_FHANDLE=y</code> (Open by fhandle syscalls)
** <code>CONFIG_EVENTFD=y</code> (Enable eventfd() system call)
** <code>CONFIG_EPOLL=y</code> (Enable eventpoll support)
* ''Networking support -> Networking options'' options for sock-diag subsystem
** <code>CONFIG_UNIX_DIAG=y</code> (Unix domain sockets -> UNIX: socket monitoring interface)
** <code>CONFIG_INET_DIAG=y</code> (TCP/IP networking -> INET: socket monitoring interface)
** <code>CONFIG_INET_UDP_DIAG=y</code> (TCP/IP networking -> INET: socket monitoring interface -> UDP: socket monitoring interface)
** <code>CONFIG_PACKET_DIAG=y</code> (Packet socket -> Packet: sockets monitoring interface)
** <code>CONFIG_NETLINK_DIAG=y</code> (Netlink socket -> Netlink: sockets monitoring interface)
* Other options
** <code>CONFIG_INOTIFY_USER=y</code> (File systems -> Inotify support for userspace)
** <code>CONFIG_IA32_EMULATION=y</code> (x86 only) (Executable file formats -> Emulations -> IA32 Emulation)

For some [[usage scenarios]] there is an ability to track memory changes and produce [[incremental dumps]]. Need to enable the <code>CONFIG_MEM_SOFT_DIRTY=y</code> (optional) (Processor type and features -> Track memory changes).

Note we also have our [[custom kernel]], which might contain some experimental CRIU related patches.

== 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
cd 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>

== Installation ==
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:
* <code>asciidoc</code>
* <code>xmlto</code>

== Checking That It Works ==

First thing to do is to run <code>criu check --ms</code>.

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.

== Further reading ==

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

[[Category:HOWTO]]

Installation

2015-04-15T21:30:15Z

Dwangoac: /* Installation */ Add debian doc package information

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

== 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.

== Obtaining CRIU Source ==

You can download the source code as a release tarball or sync the [http://git.criu.org/?p=criu.git;a=summary git repository]. If you plan to modify CRIU sources the latter way is highly recommended.

=== Getting source tarball ===
: {{Latest release}}

=== Cloning git repository ===
git clone https://github.com/xemul/criu

== Dependencies ==

=== Compiler and C Library ===

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, <code>[https://packages.debian.org/build-essential build-essential]</code> will pull in both at once).

If you are cross compiling for ARM, use distribution packages or download prebuilt toolchains from Linaro.

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
Downloading Linaro toolchains
<div class="mw-collapsible-content">
sudo apt-get install lib32stdc++6 lib32z1 # These are ia32 binaries
mkdir -p deps/`uname -m`-linux-gnu
cd deps
wget http://releases.linaro.org/14.09/components/toolchain/binaries/gcc-linaro-arm-linux-gnueabihf-4.9-2014.09_linux.tar.xz
tar --strip=1 -C `uname -m`-linux-gnu -xf gcc-linaro-arm-linux-gnueabihf-4.9-2014.09_linux.tar.xz
wget http://releases.linaro.org/14.09/components/toolchain/binaries/gcc-linaro-aarch64-linux-gnu-4.9-2014.09_linux.tar.xz
tar --strip=1 -C `uname -m`-linux-gnu -xf gcc-linaro-aarch64-linux-gnu-4.9-2014.09_linux.tar.xz
cd ..
</div>
</div>

=== 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.

==== Distribution Packages ====
The easiest way is to install distribution packages.

* RPM package names
** <code>protobuf</code>
** <code>protobuf-c</code>
** <code>protobuf-c-devel</code>
** <code>protobuf-compiler</code>
** <code>protobuf-devel</code>
** <code>protobuf-python</code>
* Debian package names
** <code>libprotobuf-dev</code>
** <code>libprotobuf-c0-dev</code>
** <code>protobuf-c-compiler</code>
** <code>protobuf-compiler</code>
** <code>python-protobuf</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. On a Debian based system, you may have to install <code>autoconf curl g++ libtool</code> packages first.

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
To build protobuf
<div class="mw-collapsible-content">
cd deps
git clone https://github.com/google/protobuf.git protobuf
cd protobuf
./autogen.sh
./configure --prefix=`pwd`/../`uname -m`-linux-gnu
make
make install
cd ../..
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
To build protobuf-c
<div class="mw-collapsible-content">
cd deps
git clone https://github.com/protobuf-c/protobuf-c.git protobuf-c
cd protobuf-c
./autogen.sh
mkdir ../pbc-`uname -m`
cd ../pbc-`uname -m`
../protobuf-c/configure --prefix=`pwd`/../`uname -m`-linux-gnu \
PKG_CONFIG_PATH=`pwd`/../`uname -m`-linux-gnu/lib/pkgconfig
make
make install
cd ../..
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
To cross-compile for ARM some more tricks will be required.
<div class="mw-collapsible-content">
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 PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make install PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
cd ../..

For ARM8

cd deps
mkdir -p pbc-aarch64
cd pbc-aarch64
../protobuf-c/configure --host=aarch64-linux-gnu --prefix=`pwd`/../aarch64-linux-gnu \
--disable-protoc PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make install PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
cd ../..
</div>
</div>

=== Other deps ===

* <code>python-ipaddr</code> is used by CRIT to pretty-print ip.
* 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.
* 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>.

== 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.

=== Configuring the kernel ===

Most likely the first thing to enable is the <code>CONFIG_EXPERT=y</code> (General setup -> Configure standard kernel features (expert users)) option, which on x86_64 depends on the <code>CONFIG_EMBEDDED=y</code> (General setup -> Embedded system) one (welcome to Kconfig reverse chains hell).

The following options must be enabled for CRIU to work:

* ''General setup'' options
** <code>CONFIG_CHECKPOINT_RESTORE=y</code> (Checkpoint/restore support)
** <code>CONFIG_NAMESPACES=y</code> (Namespaces support)
** <code>CONFIG_UTS_NS=y</code> (Namespaces support -> UTS namespace)
** <code>CONFIG_IPC_NS=y</code> (Namespaces support -> IPC namespace)
** <code>CONFIG_PID_NS=y</code> (Namespaces support -> PID namespaces)
** <code>CONFIG_NET_NS=y</code> (Namespaces support -> Network namespace)
** <code>CONFIG_FHANDLE=y</code> (Open by fhandle syscalls)
** <code>CONFIG_EVENTFD=y</code> (Enable eventfd() system call)
** <code>CONFIG_EPOLL=y</code> (Enable eventpoll support)
* ''Networking support -> Networking options'' options for sock-diag subsystem
** <code>CONFIG_UNIX_DIAG=y</code> (Unix domain sockets -> UNIX: socket monitoring interface)
** <code>CONFIG_INET_DIAG=y</code> (TCP/IP networking -> INET: socket monitoring interface)
** <code>CONFIG_INET_UDP_DIAG=y</code> (TCP/IP networking -> INET: socket monitoring interface -> UDP: socket monitoring interface)
** <code>CONFIG_PACKET_DIAG=y</code> (Packet socket -> Packet: sockets monitoring interface)
** <code>CONFIG_NETLINK_DIAG=y</code> (Netlink socket -> Netlink: sockets monitoring interface)
* Other options
** <code>CONFIG_INOTIFY_USER=y</code> (File systems -> Inotify support for userspace)
** <code>CONFIG_IA32_EMULATION=y</code> (x86 only) (Executable file formats -> Emulations -> IA32 Emulation)

For some [[usage scenarios]] there is an ability to track memory changes and produce [[incremental dumps]]. Need to enable the <code>CONFIG_MEM_SOFT_DIRTY=y</code> (optional) (Processor type and features -> Track memory changes).

Note we also have our [[custom kernel]], which might contain some experimental CRIU related patches.

== 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
cd 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>

== Installation ==
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:
** <code>asciidoc</code>
** <code>xmlto</code>

== Checking That It Works ==

First thing to do is to run <code>criu check --ms</code>.

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.

== Further reading ==

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

[[Category:HOWTO]]

Installation

2015-04-15T21:26:32Z

Dwangoac: /* Distribution Packages */ Add libprotobuf-dev

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

== 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.

== Obtaining CRIU Source ==

You can download the source code as a release tarball or sync the [http://git.criu.org/?p=criu.git;a=summary git repository]. If you plan to modify CRIU sources the latter way is highly recommended.

=== Getting source tarball ===
: {{Latest release}}

=== Cloning git repository ===
git clone https://github.com/xemul/criu

== Dependencies ==

=== Compiler and C Library ===

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, <code>[https://packages.debian.org/build-essential build-essential]</code> will pull in both at once).

If you are cross compiling for ARM, use distribution packages or download prebuilt toolchains from Linaro.

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
Downloading Linaro toolchains
<div class="mw-collapsible-content">
sudo apt-get install lib32stdc++6 lib32z1 # These are ia32 binaries
mkdir -p deps/`uname -m`-linux-gnu
cd deps
wget http://releases.linaro.org/14.09/components/toolchain/binaries/gcc-linaro-arm-linux-gnueabihf-4.9-2014.09_linux.tar.xz
tar --strip=1 -C `uname -m`-linux-gnu -xf gcc-linaro-arm-linux-gnueabihf-4.9-2014.09_linux.tar.xz
wget http://releases.linaro.org/14.09/components/toolchain/binaries/gcc-linaro-aarch64-linux-gnu-4.9-2014.09_linux.tar.xz
tar --strip=1 -C `uname -m`-linux-gnu -xf gcc-linaro-aarch64-linux-gnu-4.9-2014.09_linux.tar.xz
cd ..
</div>
</div>

=== 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.

==== Distribution Packages ====
The easiest way is to install distribution packages.

* RPM package names
** <code>protobuf</code>
** <code>protobuf-c</code>
** <code>protobuf-c-devel</code>
** <code>protobuf-compiler</code>
** <code>protobuf-devel</code>
** <code>protobuf-python</code>
* Debian package names
** <code>libprotobuf-dev</code>
** <code>libprotobuf-c0-dev</code>
** <code>protobuf-c-compiler</code>
** <code>protobuf-compiler</code>
** <code>python-protobuf</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. On a Debian based system, you may have to install <code>autoconf curl g++ libtool</code> packages first.

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
To build protobuf
<div class="mw-collapsible-content">
cd deps
git clone https://github.com/google/protobuf.git protobuf
cd protobuf
./autogen.sh
./configure --prefix=`pwd`/../`uname -m`-linux-gnu
make
make install
cd ../..
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
To build protobuf-c
<div class="mw-collapsible-content">
cd deps
git clone https://github.com/protobuf-c/protobuf-c.git protobuf-c
cd protobuf-c
./autogen.sh
mkdir ../pbc-`uname -m`
cd ../pbc-`uname -m`
../protobuf-c/configure --prefix=`pwd`/../`uname -m`-linux-gnu \
PKG_CONFIG_PATH=`pwd`/../`uname -m`-linux-gnu/lib/pkgconfig
make
make install
cd ../..
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
To cross-compile for ARM some more tricks will be required.
<div class="mw-collapsible-content">
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 PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make install PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
cd ../..

For ARM8

cd deps
mkdir -p pbc-aarch64
cd pbc-aarch64
../protobuf-c/configure --host=aarch64-linux-gnu --prefix=`pwd`/../aarch64-linux-gnu \
--disable-protoc PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make install PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
cd ../..
</div>
</div>

=== Other deps ===

* <code>python-ipaddr</code> is used by CRIT to pretty-print ip.
* 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.
* 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>.

== 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.

=== Configuring the kernel ===

Most likely the first thing to enable is the <code>CONFIG_EXPERT=y</code> (General setup -> Configure standard kernel features (expert users)) option, which on x86_64 depends on the <code>CONFIG_EMBEDDED=y</code> (General setup -> Embedded system) one (welcome to Kconfig reverse chains hell).

The following options must be enabled for CRIU to work:

* ''General setup'' options
** <code>CONFIG_CHECKPOINT_RESTORE=y</code> (Checkpoint/restore support)
** <code>CONFIG_NAMESPACES=y</code> (Namespaces support)
** <code>CONFIG_UTS_NS=y</code> (Namespaces support -> UTS namespace)
** <code>CONFIG_IPC_NS=y</code> (Namespaces support -> IPC namespace)
** <code>CONFIG_PID_NS=y</code> (Namespaces support -> PID namespaces)
** <code>CONFIG_NET_NS=y</code> (Namespaces support -> Network namespace)
** <code>CONFIG_FHANDLE=y</code> (Open by fhandle syscalls)
** <code>CONFIG_EVENTFD=y</code> (Enable eventfd() system call)
** <code>CONFIG_EPOLL=y</code> (Enable eventpoll support)
* ''Networking support -> Networking options'' options for sock-diag subsystem
** <code>CONFIG_UNIX_DIAG=y</code> (Unix domain sockets -> UNIX: socket monitoring interface)
** <code>CONFIG_INET_DIAG=y</code> (TCP/IP networking -> INET: socket monitoring interface)
** <code>CONFIG_INET_UDP_DIAG=y</code> (TCP/IP networking -> INET: socket monitoring interface -> UDP: socket monitoring interface)
** <code>CONFIG_PACKET_DIAG=y</code> (Packet socket -> Packet: sockets monitoring interface)
** <code>CONFIG_NETLINK_DIAG=y</code> (Netlink socket -> Netlink: sockets monitoring interface)
* Other options
** <code>CONFIG_INOTIFY_USER=y</code> (File systems -> Inotify support for userspace)
** <code>CONFIG_IA32_EMULATION=y</code> (x86 only) (Executable file formats -> Emulations -> IA32 Emulation)

For some [[usage scenarios]] there is an ability to track memory changes and produce [[incremental dumps]]. Need to enable the <code>CONFIG_MEM_SOFT_DIRTY=y</code> (optional) (Processor type and features -> Track memory changes).

Note we also have our [[custom kernel]], which might contain some experimental CRIU related patches.

== 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
cd 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>

== Installation ==
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>

== Checking That It Works ==

First thing to do is to run <code>criu check --ms</code>.

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.

== Further reading ==

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

[[Category:HOWTO]]

Installation

2015-04-15T21:14:27Z

Dwangoac: /* Distribution Packages */ Fix python-protobuf .deb package name

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

== 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.

== Obtaining CRIU Source ==

You can download the source code as a release tarball or sync the [http://git.criu.org/?p=criu.git;a=summary git repository]. If you plan to modify CRIU sources the latter way is highly recommended.

=== Getting source tarball ===
: {{Latest release}}

=== Cloning git repository ===
git clone https://github.com/xemul/criu

== Dependencies ==

=== Compiler and C Library ===

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, <code>[https://packages.debian.org/build-essential build-essential]</code> will pull in both at once).

If you are cross compiling for ARM, use distribution packages or download prebuilt toolchains from Linaro.

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
Downloading Linaro toolchains
<div class="mw-collapsible-content">
sudo apt-get install lib32stdc++6 lib32z1 # These are ia32 binaries
mkdir -p deps/`uname -m`-linux-gnu
cd deps
wget http://releases.linaro.org/14.09/components/toolchain/binaries/gcc-linaro-arm-linux-gnueabihf-4.9-2014.09_linux.tar.xz
tar --strip=1 -C `uname -m`-linux-gnu -xf gcc-linaro-arm-linux-gnueabihf-4.9-2014.09_linux.tar.xz
wget http://releases.linaro.org/14.09/components/toolchain/binaries/gcc-linaro-aarch64-linux-gnu-4.9-2014.09_linux.tar.xz
tar --strip=1 -C `uname -m`-linux-gnu -xf gcc-linaro-aarch64-linux-gnu-4.9-2014.09_linux.tar.xz
cd ..
</div>
</div>

=== 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.

==== Distribution Packages ====
The easiest way is to install distribution packages.

* RPM package names
** <code>protobuf</code>
** <code>protobuf-c</code>
** <code>protobuf-c-devel</code>
** <code>protobuf-compiler</code>
** <code>protobuf-devel</code>
** <code>protobuf-python</code>
* Debian package names
** <code>libprotobuf-c0-dev</code>
** <code>protobuf-c-compiler</code>
** <code>protobuf-compiler</code>
** <code>python-protobuf</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. On a Debian based system, you may have to install <code>autoconf curl g++ libtool</code> packages first.

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
To build protobuf
<div class="mw-collapsible-content">
cd deps
git clone https://github.com/google/protobuf.git protobuf
cd protobuf
./autogen.sh
./configure --prefix=`pwd`/../`uname -m`-linux-gnu
make
make install
cd ../..
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
To build protobuf-c
<div class="mw-collapsible-content">
cd deps
git clone https://github.com/protobuf-c/protobuf-c.git protobuf-c
cd protobuf-c
./autogen.sh
mkdir ../pbc-`uname -m`
cd ../pbc-`uname -m`
../protobuf-c/configure --prefix=`pwd`/../`uname -m`-linux-gnu \
PKG_CONFIG_PATH=`pwd`/../`uname -m`-linux-gnu/lib/pkgconfig
make
make install
cd ../..
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
To cross-compile for ARM some more tricks will be required.
<div class="mw-collapsible-content">
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 PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make install PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
cd ../..

For ARM8

cd deps
mkdir -p pbc-aarch64
cd pbc-aarch64
../protobuf-c/configure --host=aarch64-linux-gnu --prefix=`pwd`/../aarch64-linux-gnu \
--disable-protoc PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
make install PATH=`pwd`/../`uname -m`-linux-gnu/bin:$PATH
cd ../..
</div>
</div>

=== Other deps ===

* <code>python-ipaddr</code> is used by CRIT to pretty-print ip.
* 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.
* 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>.

== 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.

=== Configuring the kernel ===

Most likely the first thing to enable is the <code>CONFIG_EXPERT=y</code> (General setup -> Configure standard kernel features (expert users)) option, which on x86_64 depends on the <code>CONFIG_EMBEDDED=y</code> (General setup -> Embedded system) one (welcome to Kconfig reverse chains hell).

The following options must be enabled for CRIU to work:

* ''General setup'' options
** <code>CONFIG_CHECKPOINT_RESTORE=y</code> (Checkpoint/restore support)
** <code>CONFIG_NAMESPACES=y</code> (Namespaces support)
** <code>CONFIG_UTS_NS=y</code> (Namespaces support -> UTS namespace)
** <code>CONFIG_IPC_NS=y</code> (Namespaces support -> IPC namespace)
** <code>CONFIG_PID_NS=y</code> (Namespaces support -> PID namespaces)
** <code>CONFIG_NET_NS=y</code> (Namespaces support -> Network namespace)
** <code>CONFIG_FHANDLE=y</code> (Open by fhandle syscalls)
** <code>CONFIG_EVENTFD=y</code> (Enable eventfd() system call)
** <code>CONFIG_EPOLL=y</code> (Enable eventpoll support)
* ''Networking support -> Networking options'' options for sock-diag subsystem
** <code>CONFIG_UNIX_DIAG=y</code> (Unix domain sockets -> UNIX: socket monitoring interface)
** <code>CONFIG_INET_DIAG=y</code> (TCP/IP networking -> INET: socket monitoring interface)
** <code>CONFIG_INET_UDP_DIAG=y</code> (TCP/IP networking -> INET: socket monitoring interface -> UDP: socket monitoring interface)
** <code>CONFIG_PACKET_DIAG=y</code> (Packet socket -> Packet: sockets monitoring interface)
** <code>CONFIG_NETLINK_DIAG=y</code> (Netlink socket -> Netlink: sockets monitoring interface)
* Other options
** <code>CONFIG_INOTIFY_USER=y</code> (File systems -> Inotify support for userspace)
** <code>CONFIG_IA32_EMULATION=y</code> (x86 only) (Executable file formats -> Emulations -> IA32 Emulation)

For some [[usage scenarios]] there is an ability to track memory changes and produce [[incremental dumps]]. Need to enable the <code>CONFIG_MEM_SOFT_DIRTY=y</code> (optional) (Processor type and features -> Track memory changes).

Note we also have our [[custom kernel]], which might contain some experimental CRIU related patches.

== 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
cd 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>

== Installation ==
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>

== Checking That It Works ==

First thing to do is to run <code>criu check --ms</code>.

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.

== Further reading ==

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

[[Category:HOWTO]]