Difference between revisions of "Action scripts"

From CRIU
Jump to: navigation, search
(link to docker; don't link twice)
(Update list of supported hooks)
Line 1: Line 1:
 
With the <code>--action-script</code> command line option, CRIU can call your action scripts (also known as hooks) at various stages of dumping/restoring. The following hooks are available:
 
With the <code>--action-script</code> command line option, CRIU can call your action scripts (also known as hooks) at various stages of dumping/restoring. The following hooks are available:
 +
 +
;<code>pre-dump</code>
 +
: called before the beginning of dump
 +
 +
;<code>post-dump</code>
 +
: called when CRIU finished dumping tasks and before unfreezing them
 +
 +
;<code>pre-restore</code>
 +
: called before the beginning of restore
 +
 +
;<code>post-restore</code>
 +
: called when CRIU has finished restoring tasks and before unlocking the network
  
 
;<code>network-lock</code>
 
;<code>network-lock</code>
Line 7: Line 19:
 
: requested to unlock a container network (used by Docker and LXC)
 
: requested to unlock a container network (used by Docker and LXC)
  
;<code>post-dump</code>
+
;<code>setup-namespaces</code>
: called when CRIU finished dumping tasks before unfreezing them
+
: called when the root task is alive and new set of namespaces is created to set them up
 +
 
 +
;<code>post-setup-namespaces</code>
 +
: called after namespaces are configured
 +
 
 +
;<code>pre-resume</code>
 +
: called at the moment when processes and resources are already restored but not yet in running state
  
;<code>post-restore</code>
+
;<code>post-resume</code>
: called when CRIU has finished restoring tasks before unlocking the network
+
: called at the very end, when everything is restored and processes were resumed
  
;<code>setup-namespaces</code>
+
;<code>orphan-pts-master</code>
: called when the root task is alive and new set of namespaces is created to set them up
+
: called after master pty is opened and unlocked (used by Docker)
  
 
== CLI ==
 
== CLI ==

Revision as of 19:09, 12 February 2019

With the --action-script command line option, CRIU can call your action scripts (also known as hooks) at various stages of dumping/restoring. The following hooks are available:

pre-dump
called before the beginning of dump
post-dump
called when CRIU finished dumping tasks and before unfreezing them
pre-restore
called before the beginning of restore
post-restore
called when CRIU has finished restoring tasks and before unlocking the network
network-lock
request to lock a container network (used by Docker and LXC)
network-unlock
requested to unlock a container network (used by Docker and LXC)
setup-namespaces
called when the root task is alive and new set of namespaces is created to set them up
post-setup-namespaces
called after namespaces are configured
pre-resume
called at the moment when processes and resources are already restored but not yet in running state
post-resume
called at the very end, when everything is restored and processes were resumed
orphan-pts-master
called after master pty is opened and unlocked (used by Docker)

CLI

These hooks are added with the --action-script shell-code-to-execute option. When called, the CRTOOLS_SCRIPT_ACTION environment is set to a value determining which type of action is performed.

RPC

In case of RPC, action scripts are implemented as notifications. Once CRIU service wants to execute a script, it sends an RPC message to the caller and waits for it to respond with criu_req message having notify_success = true.

Library

When using a library, one can set up a callback using the criu_set_notify routine.