From b2ed30d593f1ca98cce2565f18e7fda8783bbbe9 Mon Sep 17 00:00:00 2001 From: Danny Auble <da@schedmd.com> Date: Thu, 28 Jun 2012 12:06:02 -0700 Subject: [PATCH] minor modifications to the launch plugin webpage --- doc/html/launch_plugins.shtml | 60 ++++++++--------------------------- 1 file changed, 14 insertions(+), 46 deletions(-) diff --git a/doc/html/launch_plugins.shtml b/doc/html/launch_plugins.shtml index 5141eeca78d..c0bd9443194 100644 --- a/doc/html/launch_plugins.shtml +++ b/doc/html/launch_plugins.shtml @@ -1,12 +1,12 @@ <!--#include virtual="header.txt"--> -<h1><a name="top">SLURM Launch Plugin API</a></h1> +<h1><a name="top">Launch Plugin API</a></h1> <h2> Overview</h2> -<p> This document describes SLURM launch plugins and the API that -defines them. It is intended as a resource to programmers wishing to write -their own SLURM launch plugins. - +<p> This document describes the launch plugin that is responsible for + launching a parallel task in SLURM and the API that defines them. It + is intended as a resource to programmers wishing to write their own + launch plugin. <p><span class="commandline">const char plugin_name[]="<i>launch SLURM plugin</i>"</span> @@ -16,9 +16,11 @@ plugin_name[]="<i>launch SLURM plugin</i>"</span> plugin_type[]="<i>launch/slurm</i>"</span><br> <p style="margin-left:.2in"> -<li><b>poe</b> TBD -<li><b>runjob</b> TBD -<li><b>slurm</b> TBD<br> +<li><b>poe</b>—Use IBM's poe to launch tasks - used with IBM's PE + typically when using an IBM proprietary interconnect. +<li><b>runjob</b>—Use IBM's runjob to launch tasks - used on + BlueGene/Q machines. +<li><b>slurm</b>—Use SLURM's default launching infrastructure<br> <p>The programmer is urged to study <span class="commandline">src/plugins/launch/slurm/launch_slurm.c</span> for a sample implementation of a SLURM launch plugin. @@ -26,41 +28,6 @@ for a sample implementation of a SLURM launch plugin. <h2>API Functions</h2> -<p class="commandline"> launch_common_get_slurm_step_layout(srun_job_t *job) -<p style="margin-left:.2in"><b>Description</b>:<br> -Gets the slurm job step layout. -<p style="margin-left:.2in"><b>Arguments</b>: <br> -<span class="commandline"> job:</span> the job step to get. -<p style="margin-left:.2in"><b>Returns</b>: <br> -<span class="commandline">SLURM_SUCCESS</span> on success, or<br> -<span class="commandline">SLURM_ERROR</span> on failure. - -<p class="commandline"> launch_common_create_job_step(srun_job_t *job, - bool use_all_cpus, void (*signal_function)(int), sig_atomic_t - *destroy_job) -<p style="margin-left:.2in"><b>Description</b>:<br> -creates the job step with the given info. -<p style="margin-left:.2in"><b>Arguments</b>: <br> -<span class="commandline"> job:</span> job to be created into a job -step. -<span class="commandline"> use_all_cpus:</span> the choice to use all -the cpus. -<span class="commandline"> signal_function:</span> function that -handles the signals coming in. -<span class="commandline"> destroy_job:</span> pointer to a global -flag signifying id the job was canceled while allocating. -<p style="margin-left:.2in"><b>Returns</b>: <br> -<span class="commandline">SLURM_SUCCESS</span> on success, or<br> -<span class="commandline">SLURM_ERROR</span> on failure. - -<p class="commandline"> launch_common_set_stdio_fds(srun_job_t - *job,slurm_step_io_fds_t *cio_fds) -<p style="margin-left:.2in"><b>Description</b>:<br> -sets the stdio_fds to the given info. -<p style="margin-left:.2in"><b>Arguments</b>: <br> -<span class="commandline"> job:</span> the job that is set. -<span class="commandline"> cio_fds:</span> filling in the io descriptor. - <p class="commandline"> int init(void) <p style="margin-left:.2in"><b>Description</b>:<br> Called when the plugin is loaded, before any other functions are @@ -80,7 +47,8 @@ sets the stdio_fds to the given info. <p style="margin-left:.2in"><b>Description</b>:<br> Sets up the srun operation. <p style="margin-left:.2in"><b>Arguments</b>: <br> - <span class="commandline"> rest:</span> Handles all the signals + <span class="commandline"> rest:</span> extra parameters on the + command line not processed by srun <p style="margin-left:.2in"><b>Returns</b>: <br> <span class="commandline">SLURM_SUCCESS</span> on success, or<br> <span class="commandline">SLURM_ERROR</span> on failure. @@ -139,12 +107,12 @@ sets the stdio_fds to the given info. <p class="commandline"> void launch_p_fwd_signal(int signal) <p style="margin-left:.2in"><b>Description</b>:<br> - Sends a forward signal to any underlyning tasks. + Sends a forward signal to any underlying tasks. <p style="margin-left:.2in"><b>Arguments</b>: <br> <span class="commandline"> signal:</span> the signal that needs to be sent. <p class="footer"><a href="#top">top</a> -<p style="text-align:center;">Last modified 22 June 2012</p> +<p style="text-align:center;">Last modified 28 June 2012</p> <!--#include virtual="footer.txt"--> -- GitLab