dmtcp_launch -- start a process under DMTCP control

Kapil Arya, Gene Cooperman, Rohan Garg, et al.

September, 2017

Version 2.5.1

Table of Contents

• Synopsis
• Description
• Options
  • Connecting to the DMTCP Coordinator
  • Checkpoint image generation
  • Enable/disable plugins
  • Other options

Synopsis

dmtcp_launch [OPTIONS] [args...]

Description

dmtcp_launch is a tool to launch an application under DMTCP control.

Options

Connecting to the DMTCP Coordinator

A typical usage is:
rm ckpt_a.out_*.dmtcp # Remove any stale copies of ckpt image
dmtcp_launch --interval 5 a.out
dmtcp_command --checkpoint # Execute this in another window
# Kill the currently running a.out process
dmtcp_restart ckpt_a.out_*.dmtcp

-h, --coord-host hostname (environment variable DMTCP_COORD_HOST)

Hostname where dmtcp_coordinator is run (default: localhost)

-p, --coord-port port (environment variable DMTCP_COORD_PORT)

Port where dmtcp_coordinator is run (default: 7779)

--port-file filename

File to write listener port number. (Useful with --coord-port 0, which is used to assign a random port)

-j, --join

Join an existing coordinator, raise error if one doesn't already exist

--new-coordinator

Create a new coordinator at the given port. Fail if one already exists on the given port. The port can be specified with --coord-port, or with environment variable DMTCP_COORD_PORT. If no port is specified, start coordinator at a random port (same as specifying port '0').

--no-coordinator

Execute the process in stand-alone coordinator-less mode.
Use dmtcp_command or --interval to request checkpoints.

-i, -interval seconds (environment variable DMTCP_CHECKPOINT_INTERVAL)

Time in seconds between automatic checkpoints. 0 implies never (manual ckpt only); if not set and no env var, use default value set in dmtcp_coordinator or dmtcp_command. Not allowed if --join is specified

Checkpoint image generation

--gzip, --no-gzip (environment variable DMTCP_GZIP=[01])

Enable/disable compression of checkpoint images (default: 1 (enabled))
WARNING: gzip adds seconds. Without gzip, ckpt is often < 1s

--ckptdir path (environment variable DMTCP_CHECKPOINT_DIR)

Directory to store checkpoint images (default: curr dir at launch)

--ckpt-open-files

Checkpoint open files and restore old working dir. (default: do neither)

--checkpoint-open-files

Deprecated. Use --ckpt-open-files instead.

--ckpt-signal signum

Signal number used internally by DMTCP for checkpointing (default: 12)

--ckpt-signal signum

Deprecated. Use --ckpt-signal instead.

Enable/disable plugins

--with-plugin plugins (environment variable DMTCP_PLUGIN)

Colon-separated list of DMTCP plugins to be preloaded with DMTCP. (Absolute pathnames are required.)

--batch-queue, --rm

Enable support for resource managers (Torque PBS and SLURM). (default: disabled)

--ptrace

Enable support for PTRACE system call for gdb/strace etc. (default: disabled)

--modify-env

Update environment variables based on the environment on the restart host (e.g., DISPLAY=$DISPLAY). This can be set in a file dmtcp_env.txt. (default: disabled)

--ib, --infiniband

Enable InfiniBand plugin. (default: disabled)

--disable-alloc-plugin (environment variable DMTCP_ALLOC_PLUGIN=[01])

Disable alloc plugin (default: enabled).

--disable-dl-plugin (environment variable DMTCP_DL_PLUGIN=[01])

Disable dl plugin (default: enabled).

--disable-all-plugins (EXPERTS ONLY, FOR DEBUGGING)

Disable all plugins.

Other options

--prefix path

Prefix where DMTCP is installed on remote nodes.

--tmpdir path (environment variable DMTCP_TMPDIR)

Directory to store temporary files (default: $TMDPIR/dmtcp-$USER@$HOST or /tmp/dmtcp-$USER@$HOST)

-q, --quiet (or set environment variable DMTCP_QUIET = 0, 1, or 2)

Skip NOTE messages; if given twice, also skip WARNINGs

--help

Print this message and exit.

--version

Print version information and exit.

Reporting Bugs

See Also

Author

Version

DMTCP version 2.5.1 of September, 2017.

Copyright

License LGPLv3+: GNU LGPL version 3 or later .

This program comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under certain conditions; see COPYING file for details.