No description
Find a file
Mahadasyam, Shashank (SGC) bab72af9a5 vma: introduce --allow-uprobes option
This commit teaches criu to deal with processes which have a "[uprobes]" vma.

This vma is mapped by the kernel when execution hits a uprobe location. This
is done so as to execute the uprobe'd instruciton out-of-line in the special
vma. The uprobe'd location is replaced by a software breakpoint instruction,
which is int3 on x86. When execution reaches that location, control is
transferred over to the kernel, which then executes whatever handler code
it has to, for the uprobe, and then executed the replaced instruction out-of-line
in the special vma. For more details, refer to this commit:
d4b3b6384f

Reason for adding a new option
------------------------------

A new option is added instead of making the uprobes vma handling transparent
to the user, so that when a dump is attempted on a process tree in which a
process has the uprobes vma, criu will error, asking the user to use this option.
This gives the user a chance to check what uprobes are attached to the processes
being dumped, and try to ensure that those uprobes are active on restore as well.

Again, the same reason for requiring this option on restore as well. Because
if a process is dumped with an active uprobe, and on restore if the uprobe
is not active, then if execution reaches the uprobe location, then the process
will be sent a SIGTRAP, whose default behaviour will terminate and core dump
the process. This is because the code pages are dumped with the software
breakpoint instruction replacement at the uprobe'd locations. On restore, if
execution reaches these locations and the kernel sees no associated active
uprobes, then it'll send a SIGTRAP.

So, using this option is on dump and restore is an implicit guarantee on the
user's behalf that they'll take care of the active uprobes and that any future
SIGTRAPs because of this are not on us! :)

Handling uprobes vma on dump
----------------------------

We don't need to store any information about the uprobes vma because it's
completely handled by the kernel, transparent to userspace. So, when a uprobes
vma is detected, we check if the --allow-uprobes option was specified or not.
If so, then the allow_uprobes boolean in the inventory image is set (this is
used on restore). The uprobes vma is skipped from being added to the vma list.

Handling uprobes vma on restore
-------------------------------

If allow_uprobes is set in the inventory image, then check if --allow-uprobes
is specified or not. Restoring the vma is not required.

Fixes: checkpoint-restore#1961
Signed-off-by: Shashank Balaji <shashank.mahadasyam@sony.com>
2025-11-05 15:41:34 -08:00
.circleci ci: silence CircleCI warning about deprecated image 2024-09-11 16:02:11 -07:00
.github ci: run alpine tests on arm64 2025-11-05 15:41:34 -08:00
compel make: prevent redefinition of 'struct sigcontext' 2025-11-05 15:40:55 -08:00
contrib ci: run alpine tests on arm64 2025-11-05 15:41:34 -08:00
coredump criu-coredump: add VMA_AREA_UPROBES flag 2025-11-05 15:41:34 -08:00
crit contributing: update links to mailing list 2025-11-02 07:48:24 -08:00
criu vma: introduce --allow-uprobes option 2025-11-05 15:41:34 -08:00
Documentation plugins/amdgpu: Update README.md and criu-amdgpu-plugin.txt 2025-11-02 07:48:22 -08:00
images vma: introduce --allow-uprobes option 2025-11-05 15:41:34 -08:00
include criu: fix log_keep_err signal deadlock 2025-03-25 14:31:33 -07:00
lib crit: add VMA_AREA_UPROBES flag 2025-11-05 15:41:34 -08:00
plugins image: use protoc instead of protoc-c 2025-11-02 07:48:22 -08:00
scripts ci/java: update base image from focal to jammy 2025-11-02 07:48:24 -08:00
soccr soccr: Log name of socket queue that failed to restore. 2023-10-22 13:29:25 -07:00
test zdtm: add sk-unix-restore-fs-share test 2025-11-05 15:41:34 -08:00
.cirrus.yml ci: consolidate aarch64 tests on GitHub runners 2025-11-02 07:48:24 -08:00
.clang-format clang-format: disable column limit constraint 2023-10-22 13:29:25 -07:00
.codespellrc Makefile: move codespell options to .codespellrc 2025-03-21 12:40:31 -07:00
.gitignore Keep images/google/protobuf directory 2025-11-02 07:48:22 -08:00
.lgtm.yml images: remove symlink for descriptor.proto 2025-11-02 07:48:22 -08:00
.mailmap mailmap: update my email 2023-04-15 21:17:21 -07:00
CLAUDE.md docs: add developer overviews for AI assistants 2025-11-02 07:48:23 -08:00
CONTRIBUTING.md contributing: update links to mailing list 2025-11-02 07:48:24 -08:00
COPYING COPYING: fix a typo in a preamble 2016-08-11 16:18:43 +03:00
CREDITS Add the CREDITS file 2012-07-30 13:52:37 +04:00
flake.lock feat: introduce Nix flake 2025-11-02 07:48:22 -08:00
flake.nix feat: introduce Nix flake 2025-11-02 07:48:22 -08:00
GEMINI.md docs: add developer overviews for AI assistants 2025-11-02 07:48:23 -08:00
INSTALL.md docs: mark make commands with same format as elsewhere 2025-03-21 12:40:31 -07:00
MAINTAINERS Add Alexander Mikhalitsyn to maintainers 2023-04-15 21:17:21 -07:00
MAINTAINERS_GUIDE.md Fix some codespell warnings 2022-04-28 17:53:52 -07:00
Makefile Remove travis-ci leftovers 2025-11-02 07:48:23 -08:00
Makefile.compel Remove travis-ci leftovers 2025-11-02 07:48:23 -08:00
Makefile.config make: remove checks and warnings for bsd strlcat and strlcpy 2025-11-02 07:48:21 -08:00
Makefile.install criu/plugin: Add NVIDIA CUDA plugin 2024-09-11 16:02:11 -07:00
Makefile.versions criu: Version 4.1.1 2025-07-29 09:10:08 -07:00
README.md readme: update link to FAQ page 2024-09-11 16:02:11 -07:00

X86_64 GCC Test Docker Test Podman Test CircleCI

CRIU -- A project to implement checkpoint/restore functionality for Linux

CRIU (stands for Checkpoint and Restore in Userspace) is a utility to checkpoint/restore Linux tasks.

Using this tool, you can freeze a running application (or part of it) and checkpoint it to a hard drive as a collection of files. You can then use the files to restore and run the application from the point it was frozen at. The distinctive feature of the CRIU project is that it is mainly implemented in user space. There are some more projects doing C/R for Linux, and so far CRIU appears to be the most feature-rich and up-to-date with the kernel.

CRIU project is (almost) the never-ending story, because we have to always keep up with the Linux kernel supporting checkpoint and restore for all the features it provides. Thus we're looking for contributors of all kinds -- feedback, bug reports, testing, coding, writing, etc. Please refer to CONTRIBUTING.md if you would like to get involved.

The project started as the way to do live migration for OpenVZ Linux containers, but later grew to more sophisticated and flexible tool. It is currently used by (integrated into) OpenVZ, LXC/LXD, Docker, and other software, project gets tremendous help from the community, and its packages are included into many Linux distributions.

The project home is at http://criu.org. This wiki contains all the knowledge base for CRIU we have. Pages worth starting with are:

Checkpoint and restore of simple loop process

Advanced features

As main usage for CRIU is live migration, there's a library for it called P.Haul. Also the project exposes two cool core features as standalone libraries. These are libcompel for parasite code injection and libsoccr for TCP connections checkpoint-restore.

Live migration

True live migration using CRIU is possible, but doing all the steps by hands might be complicated. The phaul sub-project provides a Go library that encapsulates most of the complexity. This library and the Go bindings for CRIU are stored in the go-criu repository.

Parasite code injection

In order to get state of the running process CRIU needs to make this process execute some code, that would fetch the required information. To make this happen without killing the application itself, CRIU uses the parasite code injection technique, which is also available as a standalone library called libcompel.

TCP sockets checkpoint-restore

One of the CRIU features is the ability to save and restore state of a TCP socket without breaking the connection. This functionality is considered to be useful by itself, and we have it available as the libsoccr library.

Licence

The project is licensed under GPLv2 (though files sitting in the lib/ directory are LGPLv2.1).

All files in the images/ directory are licensed under the Expat license (so-called MIT). See the images/LICENSE file.