Difference between revisions of "Installation"

From CRIU
Jump to navigation Jump to search
(Moved)
m (→‎Other stuff: Add libbsd0 for Ubuntu)
(34 intermediate revisions by 4 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.
  
 
== Installing from packages ==
 
== 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.
+
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 Source ==
+
== 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 the latter way is highly recommended.
+
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}}
  
−
; Getting source tarball
+
== Installing build dependencies ==
−
: {{Latest release}}
 
−
 
 
−
; Cloning git repository
 
−
: <pre>git clone https://github.com/xemul/criu</pre>
 
−
 
 
−
== Dependencies ==
 
  
 
=== Compiler and C Library ===
 
=== 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).
+
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>).
  
−
For building on x86 with compatible 32-bit applications C/R support you will need <code>libc6-dev-i386, gcc-multilib</code> instead of <code>gcc</code>.
+
For building with [[32bit tasks C/R]] support you will need <code>libc6-dev-i386, gcc-multilib</code> instead of <code>gcc</code>.
  
−
If you are cross compiling for ARM, use distribution packages or download prebuilt toolchains from Linaro.
+
[[ARM crosscompile|Cross-compilation for ARM]] is also possible.
  
−
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
+
=== Protocol Buffers ===
−
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]]. 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.
  
−
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.
+
; RPM packages
 +
: <code>protobuf protobuf-c protobuf-c-devel protobuf-compiler protobuf-devel protobuf-python</code>
  
−
==== Distribution Packages ====
+
; Deb packages
−
The easiest way is to install distribution packages.
+
: <code>libprotobuf-dev libprotobuf-c0-dev protobuf-c-compiler protobuf-compiler python-protobuf</code>
  
−
* RPM package names
+
Optionally, you may [[build protobuf]] from sources.
−
** <code>group Development\ Tools</code>
 
−
** <code>protobuf</code>
 
−
** <code>protobuf-c</code>
 
−
** <code>protobuf-c-devel</code>
 
−
** <code>protobuf-compiler</code>
 
−
** <code>protobuf-devel</code>
 
−
** <code>protobuf-python</code>
 
−
** <code>libnet-devel</code>
 
−
** <code>libnl3-devel</code>
 
−
** <code>asciidoc</code> (for make install)
 
−
** <code>xmlto</code> (for make install)
 
−
* Debian package names
 
−
** <code>build-essential</code>
 
−
** <code>libprotobuf-dev</code>
 
−
** <code>libprotobuf-c0-dev</code>
 
−
** <code>protobuf-c-compiler</code>
 
−
** <code>protobuf-compiler</code>
 
−
** <code>python-protobuf</code>
 
−
** <code>libnet1-dev</code>
 
−
* Ubuntu
 
−
** The below will get your freshly installed Ubuntu host ready to compile criu. "--no-install-recommends" parameter is to avoid asciidoc pulling in a lot of dependencies.
 
−
** sudo apt-get install --no-install-recommends git build-essential libprotobuf-dev libprotobuf-c0-dev protobuf-c-compiler protobuf-compiler python-protobuf libnl-3-dev libpth-dev pkg-config libcap-dev asciidoc xmlto libnet-dev
 
  
−
[[Build protobuf]] from sources
+
=== Other stuff ===
  
−
=== Other deps ===
 
 
* <code>pkg-config</code> to check on build library dependencies.
 
* <code>pkg-config</code> to check on build library dependencies.
−
* <code>libnl3</code> and <code>libnl3-devel</code> (RPM distros) or <code>libnl-3-dev</code> (DEB distros) for network operations.
+
* <code>python-ipaddress</code> is used by CRIT to pretty-print IP addresses and is also required by zdtm.py
−
* <code>python-ipaddr</code> is used by CRIT to pretty-print ip.
+
* <code>libbsd</code> (RPM and DEB) / <code>libbsd0</code> (Ubuntu). If available, CRIU will be compiled with <code>setproctitle()</code> support and set verbose process titles on service workers.
−
* 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.
+
* <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]]
−
* 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>.
+
* <code>libcap-devel</code> (RPM) / <code>libcap-dev</code> (DEB)
−
* <code>libcap-devel</code> (RPM) or <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)
−
* If you would like to use <code>make test</code> you should install <code>libaio-devel</code> (RPM) or <code>libaio-dev</code> (DEB).
+
* <code>libaio-devel</code> (RPM) / <code>libaio-dev</code> (DEB) is needed to run tests
−
* For test launcher <code>zdtm.py</code> you need <code>PyYAML</code> (RPM) or <code>python-yaml</code> (DEB).
+
* <code>python2-future</code> or <code>python3-future</code> is now needed for zdtm.py tests launcher
−
 
 
−
== 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 not required by CRIU, but C/R supported ([[ZDTM test suite]] may fail without them):
 
−
* <code>CONFIG_INOTIFY_USER=y</code> (File systems -> Inotify support for userspace)
 
−
* <code>CONFIG_FANOTIFY=y</code> (File systems -> Filesystem wide access notification)
 
−
* <code>CONFIG_NETFILTER_XT_MARK=y</code> (Networking support -> Networking options -> Network packet filtering framework (Netfilter) -> Core Netfilter Configuration -> Netfilter Xtables support (required for ip_tables) -> nfmark target and match support)
 
−
* <code>CONFIG_MEMCG=y</code> (General setup -> Control Group support -> Memory controller)
 
−
* <code>CONFIG_CGROUP_DEVICE=y</code> (General setup -> Control Group support -> Device controller)
 
−
* <code>CONFIG_MACVLAN=y</code> (Device Drivers -> Network device support -> Network core driver support -> MAC-VLAN support)
 
−
* <code>CONFIG_BRIDGE=y</code> (Networking support -> Networking options -> 802.1d Ethernet Bridging)
 
−
* <code>CONFIG_BINFMT_MISC=y</code> (Userspace binary formats -> Kernel support for MISC binaries)
 
−
* <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 ===
+
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.
  
−
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.
+
== Building the tool ==
  
−
=== Non-standard compilation ===
+
Simply run <code>make</code> in the CRIU source directory. This is the standard way, but there are some options available.
  
−
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
+
# 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.
−
Building natively, but specifying built dependencies manually
+
# 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]].
−
<div class="mw-collapsible-content">
+
# You may [[Manual build deps|specify build dependencies by hands]]
−
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">
+
== Installing ==
−
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
+
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.
−
  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>
 
−
 
 
−
=== Configuration ===
 
−
 
 
−
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.
 
−
 
 
−
''Main article: [[Configuring]]''
 
−
 
 
−
== 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 ==
 
== Checking That It Works ==
  
−
First thing to do is to run <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]].
−
 
 
−
Some kernel functionality is required in rare cases and may not block the dump (but sometimes may). These features can be checked by adding the <code>--extra</code> flag.
 
−
 
 
−
If you're using our custom kernel, then the <code>--all</code> option can 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.
Line 201: Line 65:
 
== Further reading ==
 
== Further reading ==
  
−
* [[Checking the kernel]]
 
 
* [[Usage]]
 
* [[Usage]]
 
* [[Advanced usage]]
 
* [[Advanced usage]]
Line 207: Line 70:
  
 
[[Category:HOWTO]]
 
[[Category:HOWTO]]
 +
[[Category:Editor help needed]]

Revision as of 07:17, 1 September 2018

criu is an utility to checkpoint/restore a process tree. This page describes how to get CRIU binary on your box.

Installing from packages

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

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.19.tar.gz
Version: 3.19 "Bronze Peacock"
Released: 27 Nov 2023
GIT tag: v3.19

Installing build dependencies

Compiler and C Library

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

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-c0-dev protobuf-c-compiler protobuf-compiler python-protobuf

Optionally, you may build protobuf from sources.

Other stuff

  • 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 (RPM and DEB) / libbsd0 (Ubuntu). 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
  • 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

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

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

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

Retrieved from "https://criu.org/index.php?title=Installation&oldid=4662"