Difference between revisions of "Installation"
m (→Protocol Buffers)
|Line 84:||Line 84:|
== Linux Kernel ==
== 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
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]].
== Building CRIU From Source ==
== Building CRIU From Source ==
Revision as of 12:55, 12 July 2017
criu is an utility to checkpoint/restore a process tree. This page describes how to manually build and install prerequisites and the tool itself.
- 1 Installing from packages
- 2 Obtaining CRIU Source
- 3 Dependencies
- 4 Linux Kernel
- 5 Building CRIU From Source
- 6 Installation
- 7 Checking That It Works
- 8 Further reading
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
- Getting source tarball
|Version:||3.16.1 "Petrified Puffin"|
|Released:||14 Oct 2021|
- Cloning git repository
git clone https://github.com/xemul/criu
Compiler and C Library
CRIU is mostly written in C and the build system is based on Makefiles. Thus just install standard
make packages (on Debian,
build-essential will pull in both at once).
For building on x86 with compatible 32-bit applications C/R support you will need
libc6-dev-i386, gcc-multilib instead of
If you are cross compiling for ARM, use distribution packages or download prebuilt toolchains from Linaro.
Downloading Linaro toolchains
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 ..
CRIU uses the Google Protocol Buffers to read and write images and thus requires C language bindings. The
protoc tool is required at build time and the
libprotobuf-c.so shared object is required at build and run time. CRIT also uses python language bindings for protocol buffers and requires the
descriptor.proto file typically provided by a distribution's protobuf development package.
The easiest way is to install distribution packages.
- RPM package names
group Development\ Tools
asciidoc(for make install)
xmlto(for make install)
- Debian package names
- 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
Optionally, you may build protobuf from sources.
pkg-configto check on build library dependencies.
libnl3-devel(RPM distros) or
libnl-3-dev(DEB distros) for network operations.
python-ipaddris used by CRIT to pretty-print ip.
libbsdavailable, 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 iproute2. It should be compiled and a path to ip written in the environment variable
- If you would like to use
make testyou should install
- For test launcher
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.
Building CRIU From Source
make 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
make docker-build and that's it.
Building natively, but specifying built dependencies manually
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 ../..
Cross Compilation for ARM
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 ../..
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 ../..
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
CRIU works perfectly even when run from the sources directory (with the "./criu" command), but if you want to have in standard paths run
You may need to install the following packages to generate docs in Debian-based OS's to avoid errors from install-man:
Checking That It Works
First thing to do is to run
criu check. At the end it should say "Looks OK", if it doesn't the messages on the screen explain what functionality is missing.
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
If you're using our custom kernel, then the
--all 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