Changes

== Obtaining CRIU sources ==

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

== Installing build dependencies ==

== Installing build dependencies ==

; RPM packages

; RPM packages

: <code>protobuf protobuf-c protobuf-c-devel protobuf-compiler protobuf-devel protobuf-python</code>

: <code>protobuf protobuf-c protobuf-c-devel protobuf-compiler protobuf-devel protobuf-python </code>

; Debian packages

; Deb packages

: <code>libprotobuf-dev libprotobuf-c0-dev protobuf-c-compiler protobuf-compiler python-protobuf</code>

: <code>libprotobuf-dev libprotobuf-c-dev protobuf-c-compiler protobuf-compiler python3-protobuf</code>

 

: <code>libprotobuf-dev libprotobuf-c0-dev protobuf-c-compiler protobuf-compiler python-protobuf</code>

Optionally, you may [[build protobuf]] from sources.

Optionally, you may [[build protobuf]] from sources.

* <code>pkg-config</code> to check on build library dependencies.

* <code>pkg-config</code> to check on build library dependencies.

* <code>python-ipaddr</code> is used by CRIT to pretty-print ip.

* <code>python-ipaddress</code> is used by CRIT to pretty-print IP addresses and is also required by zdtm.py

* <code>libbsd</code>. If available, CRIU will be compiled with <code>setproctitle()</code> support. It will allow to make process titles of service workers to be more verbose.

* <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 written in the environment variable <code>CR_IP_TOOL</code>.

* <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>libcap-devel</code> (RPM) / <code>libcap-dev</code> (DEB)

* <code>nftables</code> (RPM) / <code>libnftables-dev</code> (DEB) If available, CRIU will be compiled with nftables C/R support

* <code>libnet-devel libnl3-devel</code> (RPM) / <code>libnet1-dev</code> (DEB) / <code>libnl-3-dev libnet-dev</code> (Ubuntu)

* <code>libcap-devel</code> (RPM) / <code>libcap-dev</code> (DEB) - Require

* <code>libnet-devel libnl3-devel</code> (RPM) / <code>libnet1-dev</code> (DEB) / <code>libnl-3-dev libnet-dev</code> (Ubuntu) - Require

For APT use the <code>--no-install-recommends</code> parameter is to avoid asciidoc pulling in a lot of dependencies.

For APT use the <code>--no-install-recommends</code> 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.

Also read about [[ZDTM test suite]] if you will run CRIU tests, those sources need other deps.

== Building the tool ==

== Building the tool ==

== Checking That It Works ==

== Checking That It Works ==

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.

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

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.

[[Category:HOWTO]]

[[Category:HOWTO]]