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: Most probably you don't need manual installation, but rather Packages for your distro.|
- 1 Obtaining CRIU Source
- 2 Dependencies
- 2.1 Compiler and C Library
- 2.2 Protocol Buffers with C Bindings
- 2.3 Some minor, but useful dependencies
- 3 Building CRIU From Source
- 4 Checking That It Works
- 5 Using CR tools
Obtaining CRIU Source
You can download the source code as a release tarball or sync the git repository.
|Version:||3.16.1 "Petrified Puffin"|
|Released:||14 Oct 2021|
git clone git://git.criu.org/criu.git cd criu
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. They are ia32 architecture binaries. On a modern Debian based x86_64 you will need to install the
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.06_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.06-02_linux.tar.xz 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.
The easiest approach for most would be to install distribution packages. RPM package names:
protobuf-c-devel. Debian package names:
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 the following packages first:
autoconf curl g++ libtool.
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 ../..
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 ../..
Cross Compiling for ARMv7
If you would like to cross-compile 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 CC=`pwd`/../bin/arm-linux-gnueabihf-gcc make make install cd ../..
Cross Compiling for ARMv8
If you would like to cross-compile for armv8:
cd deps mkdir -p pbc-aarch64 cd pbc-aarch64 ../protobuf-c/configure --host=aarch64-linux-gnu --prefix=`pwd`/../aarch64-linux-gnu --disable-protoc CC=`pwd`/../bin/aarch64-linux-gnu-gcc make make install cd ../..
Some minor, but useful dependencies
If libbsd is available, CRIU will be compiled with setproctitle() support. It allows to make process titles of service workers to be more verbose.
Building CRIU From Source
With the CRIU source obtained in the first step and dependencies satisfied in the second step, we are now compile CRIU. For native compilation with the dependencies met using distribution packages, simply run
make in the CRIU source directory.
Here is an example of building natively specifying manually built dependencies.
make \ USERCFLAGS="-I`pwd`/deps/`uname -m`-linux-gnu/include -L`pwd`/deps/`uname -m`-linux-gnu/lib" \ PATH="`pwd`/deps/`uname -m`-linux-gnu/bin:$PATH"
Cross Compilation for ARMv7
make \ ARCH=arm \ CROSS_COMPILE=`pwd`/deps/bin/arm-linux-gnueabihf- \ USERCFLAGS="-I`pwd`/deps/arm-linux-gnueabihf/include -L`pwd`/deps/arm-linux-gnueabihf/lib" \ PATH="`pwd`/deps/`uname -m`-linux-gnu/bin:$PATH"
Cross Compilation for ARMv8
make \ ARCH=aarch64 \ CROSS_COMPILE=`pwd`/deps/bin/aarch64-linux-gnu- \ USERCFLAGS="-I`pwd`/deps/aarch64-linux-gnu/include -L`pwd`/deps/aarch64-linux-gnu/lib" \ PATH="`pwd`/deps/`uname -m`-linux-gnu/bin:$PATH"
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
- General setup -> Configure standard kernel features (expert users)
option, which depends on
- General setup -> Embedded system
(welcome to Kconfig reverse chains hell).
The following options must be enabled for CRIU to work:
- General setup -> Checkpoint/restore support
- General setup -> Namespaces support
- General setup -> Namespaces support -> UTS namespace
- General setup -> Namespaces support -> IPC namespace
- General setup -> Namespaces support -> PID namespaces
- General setup -> Namespaces support -> Network namespace
- General setup -> open by fhandle syscalls
- General setup -> Enable eventfd() system call
- General setup -> Enable eventpoll support
- File systems -> Inotify support for userspace
- Executable file formats -> Emulations -> IA32 Emulation
- Networking support -> Networking options -> Unix domain sockets -> UNIX: socket monitoring interface
- Networking support -> Networking options -> TCP/IP networking -> INET: socket monitoring interface
- Networking support -> Networking options -> TCP/IP networking -> INET: socket monitoring interface -> UDP: socket monitoring interface
- Networking support -> Networking options -> Packet socket -> Packet: sockets monitoring interface
- Networking support -> Networking options -> Netlink socket -> Netlink: sockets monitoring interface
- 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.
- Networking support -> Networking options -> Network testing -> Packet generator
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
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