Skip to content
Snippets Groups Projects
Commit 9b8aa85a authored by Moe Jette's avatar Moe Jette
Browse files

Added new document providing an overview of SLURM APIs.

parent cde9a4e8
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
doc/Makefile.am
+ 1
− 0
View file @ 9b8aa85a
......@@ -5,6 +5,7 @@ SUBDIRS = man
htmldir = ${prefix}/share/doc/@PACKAGE@-@VERSION@/html
html_DATA = \
html/api.html \
html/arch.gif \
html/authplugins.html \
html/bluegene.html \
......
doc/html/api.html 0 → 100644
+ 399
− 0
View file @ 9b8aa85a
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Pragma" content="no-cache">
<meta http-equiv="keywords" content="Simple Linux Utility for Resource Management, SLURM, resource management,
Linux clusters, high-performance computing, Livermore Computing">
<meta name="LLNLRandR" content="UCRL-WEB-213976"
<meta name="LLNLRandRdate" content="28 October 2005">
<meta name="distribution" content="global">
<meta name="description" content="Simple Linux Utility for Resource Management">
<meta name="copyright"
content="This document is copyrighted U.S.
Department of Energy under Contract W-7405-Eng-48">
<meta name="Author" content="Morris Jette">
<meta name="email" content="jette1@llnl.gov">
<meta name="Classification"
content="DOE:DOE Web sites via organizational
structure:Laboratories and Other Field Facilities">
<title>Simple Linux Utility for Resource Management: Application Programming Interface (API)</title>
<link href="slurmstyles.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#000000" text="#000000" leftmargin="0" topmargin="0">
<table width="770" border="0" cellspacing="0" cellpadding="0">
<tr>
<td><img src="slurm_banner.jpg" width="770" height="145" usemap="#Map" border="0" alt="Simple Linux Utility for Resource Management"></td>
</tr>
</table>
<table width="770" border="0" cellspacing="0" cellpadding="3" bgcolor="#FFFFFF">
<tr>
<td width="100%">
<table width="760" border="0" cellspacing="0" cellpadding="4" align="right">
<tr>
<td valign="top" bgcolor="#000000"><p><img src="spacer.gif" width="110" height="1" alt=""></p>
<p><a href="slurm.html" class="nav" align="center">Home</a></p>
<p><span class="whitetext">About</span><br>
<a href="overview.html" class="nav">Overview</a><br>
<a href="news.html" class="nav">What's New</a><br>
<a href="publications.html" class="nav">Publications</a><br>
<a href="team.html" class="nav">SLURM Team</a></p>
<p><span class="whitetext">Using</span><br>
<a href="documentation.html" class="nav">Documentation</a><br>
<a href="faq.html" class="nav">FAQ</a><br>
<a href="help.html" class="nav">Getting Help</a><br>
<a href="mail.html" class="nav">Mailing Lists</a></p>
<p><span class="whitetext">Installing</span><br>
<a href="platforms.html" class="nav">Platforms</a><br>
<a href="download.html" class="nav">Download</a><br>
<a href="quickstart_admin.html" class="nav">Guide</a></p></td>
<td><img src="spacer.gif" width="10" height="1" alt=""></td>
<td valign="top"><h2><a name="top">SLURM Switch Plugin API</a></h2>
<h3>Overview</h3>
<p>All of the SLURM commands utilize a collection of Application Progamming
Interfaces (APIs).
User and system applications can directly use these APIs as desired to
achieve tighter integration with SLURM.
For example, SLURM data structures and error codes can be directly
examined rather than executing SLURM commands and parsing their output.
This document describes SLURM APIs.
You should see the man pages for individual APIs to get more details.</p>
<h3>Get Overall SLURM Information</h3>
<ul>
<li><b>slurm_api_version</b>&#151;Get SLURM API version number.</li>
<li><b>slurm_load_ctl_conf</b>&#151;Load system-wide configuration
specifications. Free with <i>slurm_free_ctl_conf</i> to avoid memory
leak.</li>
<li><b>slurm_print_ctl_conf</b>&#151;Print system-wide configuration
specifications.</li>
<li><b>slurm_free_ctl_conf</b>&#151;Free storage allocated by
<i>slurm_load_ctl_conf</i>.</li>
</ul>
<p class="footer"><a href="#top">top</a></p>
<h3>Get Job Information</h3>
<ul>
<li><b>slurm_pid2jobid</b>&#151;For a given process ID on a node
get the corresponding SLURM job ID.</li>
<li><b>slurm_get_end_time</b>&#151;For a given SLURM job ID
get the expected termination time.</li>
<li><b>slurm_load_jobs</b>&#151;Load job information.
Free with <i>slurm_free_job_info_msg</i> to avoid memory leak.</li>
<li><b>slurm_print_job_info_msg</b>&#151;Print information about
all jobs.</li>
<li><b>slurm_print_job_info</b>&#151;Print information about
a specific job.</li>
<li><b>slurm_get_select_jobinfo</b>&#151;Get <i>select</i> plugin
specific information associated with the job. The information
available is will vary by select plugin type configured.</li>
<li><b>slurm_free_job_info_msg</b>&#151;Free storage allocated by
<i>slurm_load_jobs</i>.</li>
</ul>
<p class="footer"><a href="#top">top</a></p>
<h3>Get Job Step Information</h3>
<ul>
<li><b>slurm_get_job_steps</b>&#151;Load job step information.
Free with <i>slurm_free_job_step_info_response_msg</i> to
avoid memory leak.</li>
<li><b>slurm_print_job_step_info_msg</b>&#151;Print information about
all job steps.</li>
<li><b>slurm_print_job_step_info</b>&#151;Print information about
a specific job step.</li>
<li><b>slurm_free_job_step_info_response_msg</b>&#151;Free storage
allocated by <i>slurm_get_job_steps</i>.</li>
</ul>
<p class="footer"><a href="#top">top</a></p>
<h3>Get Node Information</h3>
<ul>
<li><b>slurm_load_node</b>&#151;Load node information.
Free with <i>slurm_free_node_info</i> to avoid memory leak.</li>
<li><b>slurm_print_node_info_msg</b>&#151;Print information about
all nodes.</li>
<li><b>slurm_print_node_table</b>&#151;Print information about
a specific node.</li>
<li><b>slurm_free_node_info</b>&#151;Free storage
allocated by <i>slurm_load_node</i>.</li>
</ul>
<p class="footer"><a href="#top">top</a></p>
<h3>Get Partition Information</h3>
<ul>
<li><b>slurm_load_partitions</b>&#151;Load partition (queue) information.
Free with <i>slurm_free_partition_info</i> to avoid memory leak.</li>
<li><b>slurm_print_partition_info_msg</b>&#151;Print information about
all partitions.</li>
<li><b>slurm_print_partition_info</b>&#151;Print information about
a specific partition.</li>
<li><b>slurm_free_partition_info</b>&#151;Free storage
allocated by <i>slurm_load_partitions</i>.</li>
</ul>
<p class="footer"><a href="#top">top</a></p>
<h3>Error Handling</h3>
<ul>
<li><b>slurm_get_errno</b>&#151;Return the error code set by the
last SLURM API function executed.</li>
<li><b>slurm_perror</b>&#151;Print SLURM error information to
standard output.</li>
<li><b>slurm_strerror</b>&#151;Return a string describing a specific
SLURM error code.</li>
</ul>
<p class="footer"><a href="#top">top</a></p>
<h3>Resource Allocation</h3>
<ul>
<li><b>slurm_init_job_desc_msg</b>&#151;Initialize the data structure
used in resource allocation requests. You can then just set the fields
of particular interest and let the others use default values.</li>
<li><b>slurm_job_will_run</b>&#151;Determine if a job would be
immediately initiated if submitted now.</li>
<li><b>slurm_allocate_resources</b>&#151;Allocate resources for a job.
Response message must be freed using
<i>slurm_free_resource_allocation_response_msg</i> to avoid a
memory leak.</li>
<li><b>slurm_free_resource_allocation_response_msg</b>&#151;
Frees memory allocated by <i>slurm_allocate_resources</i>.</li>
<li><b>slurm_allocate_resources_and_run</b>&#151;Allocate resources for a
job and spawn a job step. Response message must be freed using
<i>slurm_free_resource_allocation_and_run_response_msg</i> to avoid a
memory leak.</li>
<li><b>slurm_free_resource_allocation_and_run_response_msg</b>&#151;
Frees memory allocated by <i>slurm_allocate_resources_and_run</i>.</li>
<li><b>slurm_submit_batch_job</b>&#151;Submit a script for later
execution. Response message must be freed using
<i>slurm_free_submit_response_response_msg</i> to avoid a
memory leak.</li>
<li><b>slurm_free_submit_response_response_msg</b>&#151;
Frees memory allocated by <i>slurm_submit_batch_job</i>.</li>
<li><b>slurm_confirm_allocation</b>&#151;Test if a resource allocation has
already been made for a given job id. Response message must be freed using
<i>slurm_free_resource_allocation_response_msg</i> to avoid a
memory leak. This can be used to confirm that an
allocation is still active or for error recovery.</li>
</ul>
<p class="footer"><a href="#top">top</a></p>
<h3>Job Step Creation</h3>
<p>SLURM job steps involve numerous interactions with the
<i>slurmd</i> daemon. The job step creation is only the
first step in the process. We don't advise direct user
creation of job steps, but include the information here
for completeness.</p>
<ul>
<li><b>slurm_job_step_create</b>&#151;Initiate a job step.
Allocated memory must be freed by
<i>slurm_free_job_step_create_response_msg</i> to avoid a
memory leak.</li>
<li><b>slurm_free_job_step_create_response_msg</b>&#151;Free
memory allocated by <i>slurm_job_step_create</i>.
<li><b>slurm_step_ctx_create</b>&#151;Create job step context.
Destroy using <i>slurm_step_ctx_destroy</i>.</li>
<li><b>slurm_step_ctx_destroy</b>&#151;Destroy a job step context
created by <i>slurm_step_ctx_create</i>.</li>
<li><b>slurm_step_ctx_get</b>&#151;Get values from job step context.</li>
<li><b>slurm_step_ctx_set</b>&#151;Set values in job step context.</li>
<li><b>slurm_jobinfo_ctx_get</b>&#151;Get values from a <i>jobinfo</i>
field as returned by <i>slurm_step_ctx_get</i>.</li>
<li><b>slurm_spawn</b>&#151;Spawn tasks and establish communcations.</li>
<li><b>slurm_spawn_kill</b>&#151;Signal spawned tasks.</li>
</ul>
<p class="footer"><a href="#top">top</a></p>
<h3>Job and Job Step Signaling and Cancelling</h3>
<ul>
<li><b>slurm_kill_job</b>&#151;Signal or cancel a job.</li>
<li><b>slurm_kill_job_step</b>&#151;Signal or cancel a job step.</li>
</ul>
<p class="footer"><a href="#top">top</a></p>
<h3>Job Completion</h3>
<ul>
<li><b>slurm_complete_job</b>&#151;Note completion of a job.
Releases resource allocation for the job.</li>
<li><b>slurm_complete_job_step</b>&#151;Note completion of a
job step.</li>
</ul>
<p class="footer"><a href="#top">top</a></p>
<h3>Checkpoint</h3>
<ul>
<li><b>slurm_checkpoint_able</b>&#151;Note that a specific job or
job step is elligible for checkpoint.</li>
<li><b>slurm_checkpoint_complete</b>&#151;Note that a requested
checkpoint has completed.</li>
<li><b>slurm_checkpoint_create</b>&#151;Request a checkpoint for
a specific job step. Continue execution upon completion of the
checkpoint.</li>
<li><b>slurm_checkpoint_vacate</b>&#151;Request a checkpoint for
a specific job step. Terminate execution upon completion of the
checkpoint.</li>
<li><b>slurm_checkpoint_disable</b>&#151;Make the identified job step
non-checkpointable.</li>
<li><b>slurm_checkpoint_enable</b>&#151;Make the identified job
step checkpointable.</li>
<li><b>slurm_checkpoint_error</b>&#151;Get error information for
the last checkpoint operation on a given job step.</li>
<li><b>slurm_checkpoint_restart</b>&#151;Request that a previously
checkpointed job resume execution.</li>
</ul>
<p class="footer"><a href="#top">top</a></p>
<h3>Administrative Functions</h3>
<p>Most of these functions can only be exected by user <i>root</i>.</p>
<ul>
<li><b>slurm_reconfigure</b>&#151;Update slurm daemons
based upon current <i>slurm.conf</i> configuration file.
Use this after updating the configuration file to
insure that it takes effect.</li>
<li><b>slurm_shutdown</b>&#151;Terminate slurm daemons.</li>
<li><b>slurm_update_job</b>&#151;Update state
information associated with a given job.</li>
<li><b>slurm_update_node</b>&#151;Update state
information associated with a given node. NOTE: Most
of a node's characteristics can not be modified.</li>
<li><b>slurm_init_part_desc_msg</b>&#151;Initialize a
partition update descriptor. Used this to initialize
the data structure used in <i>slurm_update_partition</i>.</li>
<li><b>slurm_update_partition</b>&#151;Update state
information associated with a given partition.</li>
<li><b>slurm_delete_partition</b>&#151;Destroy a partition.</li>
</ul>
<p class="footer"><a href="#top">top</a></p>
<h3>SLURM Host List Support</h3>
<p>SLURM uses a condensed format to express node names.
For example <i>linux[1-3,6]</i> represents <i>linux1</i>,
<i>linux2</i>, <i>linux3</i>, and <i>linux6</i>. These
functions permit you to translate the SLURM expression
into a list of individual node names.</p>
<ul>
<li><b>slurm_hostlist_create</b>&#151;Translate a SLURM
node name expression into a record used for parsing.
Use <i>slurm_hostlist_destroy</i> to free the allocated
storage.</li>
<li><b>slurm_hostlist_shift</b>&#151;Get the next node
name.</li>
<li><b>slurm_hostlist_destroy</b>&#151;Release storage
allocated by <i>slurm_hostlist_create</i>.
</ul>
<p class="footer"><a href="#top">top</a></p></td>
</tr>
<tr>
<td colspan="3"><hr> <p>For information about this page, contact
<a href="mailto:slurm-dev@lists.llnl.gov">slurm-dev@lists.llnl.gov</a>.</p>
<p><a href="http://www.llnl.gov/"><img align=middle src="lll.gif" width="32" height="32" border="0"></a></p>
<p class="footer">UCRL-WEB-213976<br>
Last modified 25 October 2005</p></td>
</tr>
</table>
</td>
</tr>
</table>
<map name="Map">
<area shape="rect" coords="616,4,762,97" href="../">
<area shape="rect" coords="330,1,468,11" href="http://www.llnl.gov/disclaimer.html">
<area shape="rect" coords="11,23,213,115" href="slurm.html">
</map>
</body>
</html>
doc/html/documentation.html
+ 3
− 2
View file @ 9b8aa85a
......@@ -9,7 +9,7 @@
<meta http-equiv="keywords" content="Simple Linux Utility for Resource Management, SLURM, resource management,
Linux clusters, high-performance computing, Livermore Computing">
<meta name="LLNLRandR" content="UCRL-WEB-213976">
<meta name="LLNLRandRdate" content="12 August 2005">
<meta name="LLNLRandRdate" content="28 October 2005">
<meta name="distribution" content="global">
<meta name="description" content="Simple Linux Utility for Resource Management">
<meta name="copyright"
......@@ -70,6 +70,7 @@ structure:Laboratories and Other Field Facilities">
<h3>SLURM Developers</h3>
<ul>
<li><a href="programmer_guide.html">Programmer Guide</a></li>
<li><a href="api.html">Application Programmer Interface (API) Guide</a></li>
<li><a href="plugins.html">Plugin Programmer Guide</a></li>
<li><a href="authplugins.html">Authentication Plugin Programmer Guide</a></li>
<li><a href="checkpoint_plugins.html">Job Checkpoint Plugin Programmer Guild</a></li>
......@@ -85,7 +86,7 @@ structure:Laboratories and Other Field Facilities">
<td colspan="3"><hr> <p>For information about this page, contact <a href="mailto:slurm-dev@lists.llnl.gov">slurm-dev@lists.llnl.gov</a>.</p>
<p><a href="http://www.llnl.gov/"><img align=middle src="lll.gif" width="32" height="32" border="0"></a></p>
<p class="footer">UCRL-WEB-213976<br>
Last modified 12 August 2005</p></td>
Last modified 28 October 2005</p></td>
</tr>
</table>
</td>
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
Nutzungsbedingungen | Datenschutzerklärung | Barrierefreiheitserklärung