Difference between revisions of "Images"

From CRIU
Jump to navigation Jump to search
(→‎Types of image files: mark table heading as such)
m (→‎Images with PB data: add ns-files)
 
(47 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
The criu utility dumps the state of processes/containers into a set of image files. This article describes the format of them.
 
The criu utility dumps the state of processes/containers into a set of image files. This article describes the format of them.
  
−
== General format description ==
+
== Types of image files ==
  
−
Most of the crtools image files begin with 32-bit magic cookie followed by zero or more entries of the same type (not size!). Most of the entries are encoded in the Google Protocol Buffers format and each is preceded with 32-bit entry size value (not including this 32-bit value itself). Optionally each entry may be followed by extra payload which depends on the entry type.
+
CRIU images can be in one of the following formats
  
−
IOW image files look like
+
* criu specific images in google protocol buffer format (PB format)
 +
* criu specific images with binary data in it
 +
* image files in 3rd party format (a.k.a. raw images)
 +
 
 +
== Images in criu-specific format ==
 +
 
 +
All criu-specific image files begin with 2 32-bit magic cookies. The first cookie is the type of file (see below) the second is the optional sub-type of image. Images in PB format are followed by zero or more entries of the same type (not size!), each entry is preceded with 32-bit entry size value (not including this 32-bit value itself). Optionally each entry may be followed by extra payload which depends on the entry type.
 +
 
 +
Currently there are 3 types of images
 +
 
 +
; Inventory file
 +
: This is the image file describing the set. It doesn't have sub-type magic.
 +
 
 +
; Image file
 +
: Regular image. Most of the text below is about these files.
 +
 
 +
; Auxiliary file
 +
: File that is not image, but criu generates one and it happens to be in protobuf format too. For now we have only stats and irmap cache files of that type. They also have sub-type magic.
 +
 
 +
IOW protocol-buffers image files look like
  
 
<pre>
 
<pre>
−
IMAGE_FILE ::= MAGIC { ENTRY }
+
IMAGE_FILE ::= MAGIC [MAGIC_2] { ENTRY }
 
ENTRY      ::= SIZE PAYLOAD [ EXTRA ]
 
ENTRY      ::= SIZE PAYLOAD [ EXTRA ]
 
PAYLOAD    ::= "message encoded in ProtocolBuffer format"
 
PAYLOAD    ::= "message encoded in ProtocolBuffer format"
Line 14: Line 33:
  
 
MAGIC      ::= "32 bit integer"
 
MAGIC      ::= "32 bit integer"
 +
MAGIC_2    ::= "32 bit integer"
 
SIZE      ::= "32 bit integer, equals the PAYLOAD length"
 
SIZE      ::= "32 bit integer, equals the PAYLOAD length"
 
</pre>
 
</pre>
 +
 +
Or, you can visualize it like
 +
 +
{| class="wikitable"
 +
|-
 +
! Type !! Size, bytes
 +
|-
 +
| Magic || 4
 +
|-
 +
| Size0 || 4
 +
|-
 +
| Message0 || Size0
 +
|-
 +
| ... || ...
 +
|-
 +
| SizeN || 4
 +
|-
 +
| MessageN || SizeN
 +
|}
  
 
The amount of entries in a image file depends on the type of file.
 
The amount of entries in a image file depends on the type of file.
  
−
== Types of image files ==
+
=== Images with PB data  ===
  
−
Images encoded with ProtocolBuffers can be one of
+
Such images can be one of
  
 
; Array image files
 
; Array image files
 
: In these files the amount of entries can be any. You should read the image file up to the EOF to find out the exact number.
 
: In these files the amount of entries can be any. You should read the image file up to the EOF to find out the exact number.
 +
 
; Single-entry image files
 
; Single-entry image files
 
: In these files exactly one entry is stored.
 
: In these files exactly one entry is stored.
  
−
A file type can be guessed by the magic. The description of the entries in ProtocolBuffers language are in <type>.proto files.
+
A file type can be guessed by the magic. The description of the entries in ProtocolBuffers language are in respective .proto files which reside in <code>images/</code> directory in the source tree.
  
 
{|class="wikitable sortable"
 
{|class="wikitable sortable"
Line 36: Line 76:
 
  ! description
 
  ! description
 
  ! extra payload
 
  ! extra payload
 +
! describing proto file
 +
|-
 +
| inventory || single-entry || Top level description of images || - || inventory.proto
 +
|-
 +
| fdinfo || array || [[Fdinfo-engine|Open file descriptors]] || - || fdinfo.proto
 +
|-
 +
| reg-files || array || Paths to [[:Category:Files|files]] opened with <code>open(2)</code> syscall || - || regfile.proto
 +
|-
 +
| ext-files || array || Files that are dumped/restored with plugins || - || ext-file.proto
 +
|-
 +
| ns-files || array || Linux procfs namespace entries || - || ns.proto
 +
|-
 +
| eventfd || array || Eventfd file information || - || eventfd.proto
 +
|-
 +
| eventpoll || array || Eventpoll file information || - || eventpoll.proto
 
  |-
 
  |-
−
  | inventory || single-entry || Top level description of images || -
+
  | eventpoll-tfd || array || Target file descriptors of eventpoll fds (merged into above) || - || eventpoll.proto
 
  |-
 
  |-
−
  | fdinfo || array || Open file descriptors || -
+
  | inotify || array || Inotify file information || - || fsnotify.proto
 
  |-
 
  |-
−
  | regfile || array || Paths to files opened with <code>open(2)</code> syscall || -
+
  | inotify-wd || array || Watch descriptors of inotify fds (merged into above) || - || fsnotify.proto
 
  |-
 
  |-
−
  | eventfd || array || Eventfd file information || -
+
  | signalfd || array || signalfd info || - || signalfd.proto
 
  |-
 
  |-
−
  | eventpoll || array || Eventpoll file information || -
+
  | core || single-entry || Core process info and (name, sigmask, itimers, etc.) arch-dependent information (registers, etc.) || - || core.proto
 
  |-
 
  |-
−
  | eventpoll-tfd || array || Target file descriptors of eventpoll fds || -
+
  | mm || single-entry || [[Memory dumping and restoring|Address space]] information (VMAs, segments, exe file, etc.) || - || mm.proto
 
  |-
 
  |-
−
  | inotify-file || array || Inotify file information || -
+
  | pipes || array || Pipes information || - || pipe.proto
 
  |-
 
  |-
−
  | inotify-wd || array || Watch descriptors of inotify fds || -
+
  | pipes-data || array || Contents of pipes || <code>entry.bytes</code> bytes of data sitting in a pipe || pipe-data.proto
 
  |-
 
  |-
−
  | signalfd || array || signalfd info
+
  | fifo || array || FIFO information || - || fifo.proto
 
  |-
 
  |-
−
  | core || single-entry || Arch-dependent information (registers, etc.) || -
+
  | fifo-data || array || Contents of FIFOs || same as in pipes-data || pipe-data.proto
 
  |-
 
  |-
−
  | mm || single-entry || Address space generic information (segments, exe file, etc.) || -
+
  | pstree || array || Process [[tree after restore|tree linkage]] || - || pstree.proto
 
  |-
 
  |-
−
  | vmas || array || Virtual mappings (<code>mmap(2)</code>) || -
+
  | ids || single || IDs of objects (mm, files, sihand, etc.) and namespaces || - || core.proto
 
  |-
 
  |-
−
  | pipes || array || Pipes information || -
+
  | sigacts || array || Signal handling map || - || sa.proto
 
  |-
 
  |-
−
  | pipes-data || array || Contents of pipes || <code>entry.bytes</code> bytes of data sitting in a pipe
+
  | unixsk || array || [[Unix sockets]] || - || sk-unix.proto
 
  |-
 
  |-
−
  | fifo || array || FIFO information || -
+
  | inetsk || array || PF_INET sockets, both IPv4 and IPv6 || - || sk-inet.proto
 
  |-
 
  |-
−
  | fifo-data || array || Contents of FIFOs || same as in pipes-data
+
  | sk-queues || array || Contents of socket queues || <code>entry.length</code> bytes of data, one entry per packet || sk-packet.proto
 
  |-
 
  |-
−
  | pstree || array || Process tree linkage and IDs || -
+
  | itimers || array || Interval timers state (merged into core image) || - || timer.proto
 
  |-
 
  |-
−
  | sigacts || array || Signal handling map || -
+
  | creds || single-entry || Task credentials: uids, gids, caps, etc. || - || creds.proto
 
  |-
 
  |-
−
  | unixsk || array || Unix domain sockets || -
+
  | fs || single-entry || Chroot and chdir information || - || fs.proto
 
  |-
 
  |-
−
  | inetsk || array || PF_INET sockets, both IPv4 and IPv6 || -
+
  | remap-fpath || array || File paths remaps (e.g. for [[invisible files]]) || - || remap-file-path.proto
 
  |-
 
  |-
−
  | sk-queues || array || Contents of socket queues || <code>entry.length</code> bytes of data, one entry per packet
+
  | ghost-file || single-entry || Ghost [[invisible files]] || Right after the entry up to the EOF goes the contents of the file || ghost-file.proto
 
  |-
 
  |-
−
  | itimers || array || Interval timers state || -
+
  | tcp-stream || single-entry || [[TCP connection]] state (including data in queues) || <code>entry.inq_len</code> bytes of in-queue data followed by <code>entry.outq_len</code> bytes of out-queue data || tcp-stream.proto
 
  |-
 
  |-
−
  | creds || single-entry || Task credentials: uids, gids, caps, etc. || -
+
  | mountpoints || array || [[Mountpoints]] information || - || mnt.proto
 
  |-
 
  |-
−
  | fs || single-entry || Chroot and chdir information || -
+
  | utsns || single-entry || Uname nodename and domainname of a UTS namespace || - || utsns.proto
 
  |-
 
  |-
−
  | path-remap || array || File paths remaps || -
+
  | tty || array || Information about opened [[TTYs]] || - || tty.proto
 +
|-
 +
| tty-info || array || Termios and similar stuff about [[TTYs]] || - || tty.proto
 +
|-
 +
| packetsk || array || Info about PF_PACKET sockets || - || packet-sock.proto
 +
|-
 +
| netdev || array || Info about [[:Category:Network|network]] devices || - || netdev.proto
 +
|}
 +
 
 +
=== Images with memory dumps ===
 +
 
 +
''Main article: [[memory dumps]]''.
 +
 
 +
Anonymous memory contents (both private and shared) is stored in two types of images:
 +
 
 +
; Pagemap files
 +
: These files contain info about which virtual regions are populated with data. The file is a set of protobuf messages.
 +
{{Note| Even though pagemap is an array kind of image (and can be included to the previous type), first pb message is of type pagemap_head and all the following ones are of type pagemap_entry.}}
 +
 
 +
; Pages files
 +
: These contain 4k pages that are to be put into the memory according to the pagemap.
 +
 
 +
== Raw images ==
 +
 
 +
These images contain data collected by CRIU with the help of some external tools.
 +
 
 +
{|class="wikitable sortable"
 
  |-
 
  |-
−
  | ghost-file || single-entry || Ghost files (those, not visible from FS, but still used by tasks) || Right after the entry up to the EOF goes the contents of the file
+
  ! Name
 +
! Tool supporting the format
 +
! Description
 +
! Decode command
 
  |-
 
  |-
−
  | tcp-stream || single-entry || TCP connection state (including data in queues) || -
+
  | ifaddr || ip from iproute2 || IP addresses on network devices || <nowiki>cat ifaddr-8.img | ip addr showdump</nowiki>
 
  |-
 
  |-
−
  | mountpoints || array || Mountpoints information || -
+
  | route || ip from iproute2 || Routing tables || <nowiki>cat route-8.img | ip route showdump</nowiki>
 
  |-
 
  |-
−
  | utsns || single-entry || Uname nodename and domainname of a UTS namespace || -
+
  | tmpfs || tar + gzip || Contents of a tmpfs filesystem || tar -tzf tmpfs-dev-49.tar.gz.img
 
  |}
 
  |}
  
−
There are, however, images which are not in ProtocolBuffers.
+
== Notes about protobuf ==
 +
We have a registered field number (1018) for [https://developers.google.com/protocol-buffers/docs/proto#options custom options] of all kinds. See protobuf/opts.proto for more info.
  
−
; Memory dumps
+
== See also ==
−
: These files contain memory dumps. The format is
+
 
−
<pre>
+
* [[CRIT]]: a tool to decode images to a human readable format
−
IMAGE ::= MAGIC [ ADDRESS DATA ]
+
* [[What's bad with V1 images]]
−
ADDRESS ::= "64-bit virtual address"
+
* [[Image field merging]]
−
DATA ::= "4K bytes blob (i.e. -- memory page)"
+
* [[Memory dumps]]
−
</pre>
+
 
 +
[[Category:Development]]
 +
[[Category:Images]]
 +
[[Category:Outdated]]

Latest revision as of 12:56, 15 September 2023

The criu utility dumps the state of processes/containers into a set of image files. This article describes the format of them.

Types of image files[edit]

CRIU images can be in one of the following formats

  • criu specific images in google protocol buffer format (PB format)
  • criu specific images with binary data in it
  • image files in 3rd party format (a.k.a. raw images)

Images in criu-specific format[edit]

All criu-specific image files begin with 2 32-bit magic cookies. The first cookie is the type of file (see below) the second is the optional sub-type of image. Images in PB format are followed by zero or more entries of the same type (not size!), each entry is preceded with 32-bit entry size value (not including this 32-bit value itself). Optionally each entry may be followed by extra payload which depends on the entry type.

Currently there are 3 types of images

Inventory file
This is the image file describing the set. It doesn't have sub-type magic.
Image file
Regular image. Most of the text below is about these files.
Auxiliary file
File that is not image, but criu generates one and it happens to be in protobuf format too. For now we have only stats and irmap cache files of that type. They also have sub-type magic.

IOW protocol-buffers image files look like 

IMAGE_FILE ::= MAGIC [MAGIC_2] { ENTRY }
ENTRY      ::= SIZE PAYLOAD [ EXTRA ]
PAYLOAD    ::= "message encoded in ProtocolBuffer format"
EXTRA      ::= "arbitrary blob, depends on the PAYLOAD contents"

MAGIC      ::= "32 bit integer"
MAGIC_2    ::= "32 bit integer"
SIZE       ::= "32 bit integer, equals the PAYLOAD length"

Or, you can visualize it like

Type Size, bytes
Magic 4
Size0 4
Message0 Size0
... ...
SizeN 4
MessageN SizeN

The amount of entries in a image file depends on the type of file.

Images with PB data[edit]

Such images can be one of

Array image files
In these files the amount of entries can be any. You should read the image file up to the EOF to find out the exact number.
Single-entry image files
In these files exactly one entry is stored.

A file type can be guessed by the magic. The description of the entries in ProtocolBuffers language are in respective .proto files which reside in images/ directory in the source tree.

name type description extra payload describing proto file
inventory single-entry Top level description of images - inventory.proto
fdinfo array Open file descriptors - fdinfo.proto
reg-files array Paths to files opened with open(2) syscall - regfile.proto
ext-files array Files that are dumped/restored with plugins - ext-file.proto
ns-files array Linux procfs namespace entries - ns.proto
eventfd array Eventfd file information - eventfd.proto
eventpoll array Eventpoll file information - eventpoll.proto
eventpoll-tfd array Target file descriptors of eventpoll fds (merged into above) - eventpoll.proto
inotify array Inotify file information - fsnotify.proto
inotify-wd array Watch descriptors of inotify fds (merged into above) - fsnotify.proto
signalfd array signalfd info - signalfd.proto
core single-entry Core process info and (name, sigmask, itimers, etc.) arch-dependent information (registers, etc.) - core.proto
mm single-entry Address space information (VMAs, segments, exe file, etc.) - mm.proto
pipes array Pipes information - pipe.proto
pipes-data array Contents of pipes entry.bytes bytes of data sitting in a pipe pipe-data.proto
fifo array FIFO information - fifo.proto
fifo-data array Contents of FIFOs same as in pipes-data pipe-data.proto
pstree array Process tree linkage - pstree.proto
ids single IDs of objects (mm, files, sihand, etc.) and namespaces - core.proto
sigacts array Signal handling map - sa.proto
unixsk array Unix sockets - sk-unix.proto
inetsk array PF_INET sockets, both IPv4 and IPv6 - sk-inet.proto
sk-queues array Contents of socket queues entry.length bytes of data, one entry per packet sk-packet.proto
itimers array Interval timers state (merged into core image) - timer.proto
creds single-entry Task credentials: uids, gids, caps, etc. - creds.proto
fs single-entry Chroot and chdir information - fs.proto
remap-fpath array File paths remaps (e.g. for invisible files) - remap-file-path.proto
ghost-file single-entry Ghost invisible files Right after the entry up to the EOF goes the contents of the file ghost-file.proto
tcp-stream single-entry TCP connection state (including data in queues) entry.inq_len bytes of in-queue data followed by entry.outq_len bytes of out-queue data tcp-stream.proto
mountpoints array Mountpoints information - mnt.proto
utsns single-entry Uname nodename and domainname of a UTS namespace - utsns.proto
tty array Information about opened TTYs - tty.proto
tty-info array Termios and similar stuff about TTYs - tty.proto
packetsk array Info about PF_PACKET sockets - packet-sock.proto
netdev array Info about network devices - netdev.proto

Images with memory dumps[edit]

Main article: memory dumps.

Anonymous memory contents (both private and shared) is stored in two types of images:

Pagemap files
These files contain info about which virtual regions are populated with data. The file is a set of protobuf messages.
Note.svg Note: Even though pagemap is an array kind of image (and can be included to the previous type), first pb message is of type pagemap_head and all the following ones are of type pagemap_entry.
Pages files
These contain 4k pages that are to be put into the memory according to the pagemap.

Raw images[edit]

These images contain data collected by CRIU with the help of some external tools.

Name Tool supporting the format Description Decode command
ifaddr ip from iproute2 IP addresses on network devices cat ifaddr-8.img | ip addr showdump
route ip from iproute2 Routing tables cat route-8.img | ip route showdump
tmpfs tar + gzip Contents of a tmpfs filesystem tar -tzf tmpfs-dev-49.tar.gz.img

Notes about protobuf[edit]

We have a registered field number (1018) for custom options of all kinds. See protobuf/opts.proto for more info.

See also[edit]

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