Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

sbcast(1) [debian man page]

SBCAST(1)							 Slurm components							 SBCAST(1)

NAME

       sbcast - transmit a file to the nodes allocated to a SLURM job.

SYNOPSIS

       sbcast [-CfpstvV] SOURCE DEST

DESCRIPTION

       sbcast  is  used  to  transmit  a  file to all nodes allocated to the currenly active SLURM job.  This command should only be executed from
       within a SLURM batch job or within the shell spawned after a SLURM job's resource allocation.  SOURCE is the name of a file on the  current
       node.   DEST should be the fully qualified pathname for the file copy to be created on each node.  DEST should be on a file system local to
       that node.  Note that parallel file systems may provide better performance than sbcast can provide, although performance will vary by  file
       size, degree of parallelism, and network type.

OPTIONS

       -C, --compress
	      Compress the file being transmitted.

       -f, --force
	      If the destination file already exists, replace it.

       -F number, --fanout=number
	      Specify the fanout of messages used for file transfer.  Maximum value is currently eight.

       -p, --preserve
	      Preserves modification times, access times, and modes from the original file.

       -s size, --size=size
	      Specify  the  block  size  used  for  file broadcast.  The size can have a suffix of k or m for kilobytes or megabytes respecitively
	      (defaults to bytes).  This size subject to rounding and range limits to maintain good performance. This value may need to be set	on
	      systems with very limited memory.

       -t seconds, fB--timeout=seconds
	      Specify  the  message  timeout  in  seconds.   The default value is MessageTimeout as reported by "scontrol show config".  Setting a
	      higher value may be necessitated by relatively slow I/O performance on the compute node disks.

       -v, --verbose
	      Provide detailed event logging through program execution.

       -V, --version
	      Print version information and exit.

ENVIRONMENT VARIABLES

       Some sbcast options may be set via environment variables.  These environment variables, along with their corresponding options, are  listed
       below. (Note: Command line options will always override these settings.)

       SBCAST_COMPRESS	   -C, --compress

       SBCAST_FANOUT	   -F number, fB--fanout=number

       SBCAST_FORCE	   -f, --force

       SBCAST_PRESERVE	   -p, --preserve

       SBCAST_SIZE	   -s size, --size=size

       SBCAST_TIMEOUT	   -t seconds, fB--timeout=seconds

AUTHORIZATION

       When  using  the  SLURM	db,  users  who have AdminLevel's defined (Operator or Admin) and users who are account coordinators are given the
       authority to invoke sbcast on other user's jobs.

EXAMPLE

       Using a batch script, transmit local file my.prog to /tmp/my.proc on the local nodes and then execute it.

       > cat my.job
       #!/bin/bash
       sbcast my.prog /tmp/my.prog
       srun /tmp/my.prog

       > sbatch --nodes=8 my.job
       srun: jobid 12345 submitted

COPYING

       Copyright (C) 2006 The Regents of the University of California.	Produced at  Lawrence  Livermore  National  Laboratory	(cf,  DISCLAIMER).
       CODE-OCEC-09-009. All rights reserved.

       This file is part of SLURM, a resource management program.  For details, see <http://www.schedmd.com/slurmdocs/>.

       SLURM is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free
       Software Foundation; either version 2 of the License, or (at your option) any later version.

       SLURM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY	or
       FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

SEE ALSO

       srun(1)

sbcast 2.0							    April 2006								 SBCAST(1)

Check Out this Related Man Page

SRUN_CR(1)							 slurm components							SRUN_CR(1)

NAME

       srun_cr - run parallel jobs with checkpoint/restart support

SYNOPSIS

       srun_cr [OPTIONS...]

DESCRIPTION

       The  design of srun_cr is inspired by mpiexec_cr from MVAPICH2 and cr_restart form BLCR.  It is a wrapper around the srun command to enable
       batch job checkpoint/restart support when used with SLURM's checkpoint/blcr plugin.

OPTIONS

       The srun_cr execute line options are identical to those of the srun command.  See "man srun" for details.

DETAILS

       After initialization, srun_cr registers a thread context callback function.  Then it forks a process and executes "cr_run --omit srun" with
       its  arguments.	 cr_run  is  employed to exclude the srun process from being dumped upon checkpoint.  All catchable signals except SIGCHLD
       sent to srun_cr will be forwarded to the child srun process.  SIGCHLD will be captured to mimic the exit status	of  srun  when	it  exits.
       Then srun_cr loops waiting for termination of tasks being launched from srun.

       The  step  launch  logic  of  SLURM  is	augmented  to  check  if  srun	is  running  under  srun_cr.   If  true,  the environment variable
       SURN_SRUN_CR_SOCKET should be present, the value of which is the address of a Unix domain socket created and listened to be srun_cr.  After
       launching the tasks, srun tires to connect to the socket and sends the job ID, step ID and the nodes allocated to the step to srun_cr.

       Upon  checkpoint, srun_cr checks to see if the tasks have been launched.  If not srun_cr first forwards the checkpoint request to the tasks
       by calling the SLURM API slurm_checkpoint_tasks() before dumping its process context.

       Upon restart, srun_cr checks to see if the tasks have been previously  launched	and  checkpointed.   If  true,	the  environment  variable
       SLURM_RESTART_DIR  is  set to the directory of the checkpoint image files of the tasks.	Then srun is forked and executed again.  The envi-
       ronment variable will be used by the srun command to restart execution of the tasks from the previous checkpoint.

COPYING

       Copyright (C) 2009 National University of Defense Technology, China.  Produced at National University of  Defense  Technology,  China  (cf,
       DISCLAIMER).  CODE-OCEC-09-009. All rights reserved.

       This file is part of SLURM, a resource management program.  For details, see <http://www.schedmd.com/slurmdocs/>.

       SLURM is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free
       Software Foundation; either version 2 of the License, or (at your option) any later version.

       SLURM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY	or
       FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

SEE ALSO

       srun(1)

srun_cr 2.0							    March 2009								SRUN_CR(1)
Man Page