diff --git a/doc/html/accounting_storageplugins.shtml b/doc/html/accounting_storageplugins.shtml index dfe7b4c1bfdc107b48d584caf8589a4c823f2719..a6180363be4a23d97d1b7db05caf2e16295adaff 100644 --- a/doc/html/accounting_storageplugins.shtml +++ b/doc/html/accounting_storageplugins.shtml @@ -47,7 +47,28 @@ The Job Accounting Storage API uses hooks in the slurmctld. <p>All of the following functions are required. Functions which are not implemented must be stubbed. -<h4>Functions called by the accounting_storage plugin</h4> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + +<h3>Functions called by the accounting_storage plugin</h3> <p class="commandline">void *acct_storage_p_get_connection(bool make_agent, int conn_num, bool rollback, char *location) @@ -986,6 +1007,6 @@ ability to implement a particular API version using the mechanism outlined for SLURM plugins. <p class="footer"><a href="#top">top</a> -<p style="text-align:center;">Last modified 6 March 2013</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/acct_gather_energy_plugins.shtml b/doc/html/acct_gather_energy_plugins.shtml index 4b55ef2e818d6818eddde1a914534bd5bda78314..0cf77016fc9054c586347674c3687247b053c998 100644 --- a/doc/html/acct_gather_energy_plugins.shtml +++ b/doc/html/acct_gather_energy_plugins.shtml @@ -41,6 +41,27 @@ for a sample implementation of a SLURM energy accounting plugin. <p>All of the following functions are required. Functions which are not implemented must be stubbed. +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">int acct_gather_energy_p_update_node_energy(void) <p style="margin-left:.2in"><b>Description</b>:<br> Updates energy accounting data for a node. @@ -99,7 +120,7 @@ for SLURM plugins.</p> <p class="footer"><a href="#top">top</a> -<p style="text-align:center;">Last modified 8 November 2012</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/acct_gather_profile_plugins.shtml b/doc/html/acct_gather_profile_plugins.shtml index 62a9fcbf376cf419d66fdad0df9e825af5ee5e91..9f25b4f8a4807b17c830acf0c7e66ac17832660d 100644 --- a/doc/html/acct_gather_profile_plugins.shtml +++ b/doc/html/acct_gather_profile_plugins.shtml @@ -77,6 +77,27 @@ for a sample implementation of a SLURM profile accounting plugin. <p>All of the following functions are required. Functions which are not implemented must be stubbed. +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline"> void acct_gather_profile_g_conf_options(s_p_options_t **full_options, int *full_options_cnt) @@ -340,6 +361,6 @@ outlined for SLURM plugins.</p> <p class="footer"><a href="#top">top</a> -<p style="text-align:center;">Last modified 1 April 2013</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/authplugins.shtml b/doc/html/authplugins.shtml index 2aa2e37712bc1d4d11649e6c740c0f146c58aa6a..a04fc2966d103ec35d33ab07b203c98536c5c138 100644 --- a/doc/html/authplugins.shtml +++ b/doc/html/authplugins.shtml @@ -66,6 +66,27 @@ or equal to the symbol SLURM_AUTH_FIRST_LOCAL_ERROR.</p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">void *slurm_auth_create (void **argv, char *auth_info);</p> <p style="margin-left:.2in"><b>Description</b>: Allocates from the free store an anonymous credential object and returns a pointer to it. The pointer should @@ -212,6 +233,6 @@ plugin that transmitted it. It is at the discretion of the plugin author whether to maintain data format compatibility across different versions of the plugin.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 3 June 2009</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/checkpoint_plugins.shtml b/doc/html/checkpoint_plugins.shtml index 32fe7e5ac45e16682b4f1a2b362c392e365838c8..3f7d45ea76cdc0df180cbab366d1195e686c56ac 100644 --- a/doc/html/checkpoint_plugins.shtml +++ b/doc/html/checkpoint_plugins.shtml @@ -57,6 +57,27 @@ with each job step.</p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">int slurm_ckpt_alloc_job (check_jobinfo_t *jobinfo);</p> <p style="margin-left:.2in"><b>Description</b>: Allocate storage for job-step specific checkpoint data.</p> @@ -195,6 +216,6 @@ A checkpoint plugin conveys its ability to implement a particular API version using the mechanism outlined for SLURM plugins.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 7 January 2013</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/core_spec_plugins.shtml b/doc/html/core_spec_plugins.shtml index 9e316d55e30d99e5c06785204b7f8d73a3c31e3d..869db46dd5e64702f144f43cf15ace3358d876f8 100644 --- a/doc/html/core_spec_plugins.shtml +++ b/doc/html/core_spec_plugins.shtml @@ -41,6 +41,27 @@ these functions will be called once for each job step on each compute node.</p> <p>All of the following functions are required. Functions which are not implemented must be stubbed. +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline"> int core_spec_p_set(uint64_t cont_id, uint16_t core_count) <p style="margin-left:.2in"><b>Description</b>:<br> @@ -113,6 +134,6 @@ node. Future releases of SLURM may revise this API. <p class="footer"><a href="#top">top</a> -<p style="text-align:center;">Last modified 6 February 2014</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/crypto_plugins.shtml b/doc/html/crypto_plugins.shtml index c7756a8878f9a83673f92c20698c9d55b2b9bec5..97eee3a89dc8d6cdf1b53050b3454f9d7334d348 100644 --- a/doc/html/crypto_plugins.shtml +++ b/doc/html/crypto_plugins.shtml @@ -58,6 +58,26 @@ arising, should be SLURM_SUCCESS. </p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> <p class="commandline">void * crypto_read_private_key (const char *path);</p> <p style="margin-left:.2in"><b>Description</b>: Generate a private key @@ -146,6 +166,6 @@ A cryptographic plugin conveys its ability to implement a particular API version using the mechanism outlined for SLURM plugins.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 24 July 2007</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/ext_sensorsplugins.shtml b/doc/html/ext_sensorsplugins.shtml index 1daef16373c0c24341a1b374e974e2621fdaeaa2..37977442066ee3dca2921e6851541038fa7736cf 100644 --- a/doc/html/ext_sensorsplugins.shtml +++ b/doc/html/ext_sensorsplugins.shtml @@ -37,6 +37,27 @@ for a sample implementation of a SLURM external sensors plugin. <p>All of the following functions are required. Functions which are not implemented must be stubbed. +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">extern int ext_sensors_read_conf(void) <p style="margin-left:.2in"><b>Description</b>:<br> Reads the external sensors plugin configuration file (ext_sensors.conf) @@ -107,6 +128,6 @@ outlined for SLURM plugins.</p> <p class="footer"><a href="#top">top</a> -<p style="text-align:center;">Last modified 12 February 2013</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/gres_plugins.shtml b/doc/html/gres_plugins.shtml index 890042822584e67e8e7b4db3614ed680bce01e07..0b938116367619a3537d4ca66cea53d1a93784f4 100644 --- a/doc/html/gres_plugins.shtml +++ b/doc/html/gres_plugins.shtml @@ -45,6 +45,27 @@ nothing today). <p>All of the following functions are required. Functions which are not implemented must be stubbed. +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline"> int node_config_load(List gres_conf_list) <p style="margin-left:.2in"><b>Description</b>:<br> @@ -155,6 +176,6 @@ Data type depends upon the value of gres_step_data_type data_type.<br> Future releases of SLURM may revise this API. <p class="footer"><a href="#top">top</a> -<p style="text-align:center;">Last modified 6 August 2013</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/job_container_plugins.shtml b/doc/html/job_container_plugins.shtml index e47ca39176c5e50cf796fe98d009995c8aa4b96c..fc0e30b24a065cdb91c1da8545cac85f0d09ce31 100644 --- a/doc/html/job_container_plugins.shtml +++ b/doc/html/job_container_plugins.shtml @@ -59,6 +59,27 @@ Successful API calls are not required to reset errno to a known value.</p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">int container_p_create (uint32_t job_id);</p> <p style="margin-left:.2in"><b>Description</b>: Create a container. The caller should insure that be valid @@ -121,6 +142,6 @@ mechanism outlined for Slurm plugins.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 19 July 2013</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/job_submit_plugins.shtml b/doc/html/job_submit_plugins.shtml index 8d8fed2d0d3f30e12ea680a8c6b3f5097b5c3cfb..78c91a4c81aeb6ad7ba3bbab210836322100b35c 100644 --- a/doc/html/job_submit_plugins.shtml +++ b/doc/html/job_submit_plugins.shtml @@ -47,6 +47,27 @@ the installation directory).</p> <p>All of the following functions are required. Functions which are not implemented must be stubbed. +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline"> int job_submit(struct job_descriptor *job_desc, uint32_t submit_uid, char **error_msg) <p style="margin-left:.2in"><b>Description</b>:<br> @@ -145,6 +166,6 @@ appropriate error message printed for that errno. releases of SLURM may revise this API. <p class="footer"><a href="#top">top</a> -<p style="text-align:center;">Last modified 7 August 2013</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/jobacct_gatherplugins.shtml b/doc/html/jobacct_gatherplugins.shtml index 3fa76ad3f7689d5587641d010fa9e84b918d520b..888d304fff19c15097efbf16a0958ecce84151c6 100644 --- a/doc/html/jobacct_gatherplugins.shtml +++ b/doc/html/jobacct_gatherplugins.shtml @@ -45,6 +45,27 @@ for a sample implementation of a SLURM job accounting gather plugin. <p>All of the following functions are required. Functions which are not implemented must be stubbed. +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">int jobacct_gather_p_poll_data(List task_list, bool pgid_plugin, uint64_t cont_id) <p style="margin-left:.2in"><b>Description</b>:<br> Build a table of all current processes. @@ -291,6 +312,6 @@ for SLURM plugins.</p> <p class="footer"><a href="#top">top</a> -<p style="text-align:center;">Last modified 21 June 2012</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/jobcompplugins.shtml b/doc/html/jobcompplugins.shtml index e7ae65afac6e81507ce982611f792862f16be329..9f6e1693df9ff1b275dba9ebfbb4b62c06135c61 100644 --- a/doc/html/jobcompplugins.shtml +++ b/doc/html/jobcompplugins.shtml @@ -57,6 +57,27 @@ SLURM_SUCCESS. </p> <h2>API Functions</h2> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">int slurm_jobcomp_set_location (char * location);</p> <p style="margin-left:.2in"><b>Description</b>: Specify the location to be used for job logging.</p> <p style="margin-left:.2in"><b>Argument</b>:<span class="commandline"> location</span> @@ -131,6 +152,6 @@ releases of SLURM may revise this API. A job completion plugin conveys its abili to implement a particular API version using the mechanism outlined for SLURM plugins.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 26 March 2010</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/launch_plugins.shtml b/doc/html/launch_plugins.shtml index 668f33f38a603d1acf6500f812aa1220ffaa79e1..a912d57d9bedfbd568e4ebe671dd7f626a4b2042 100644 --- a/doc/html/launch_plugins.shtml +++ b/doc/html/launch_plugins.shtml @@ -32,20 +32,26 @@ for a sample implementation of a SLURM launch plugin. <h2>API Functions</h2> -<p class="commandline"> int init(void) +<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 called. Put global initialization here. <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. + <span class="commandline">SLURM_ERROR</span> on failure.</p> -<p class="commandline"> int fini(void) +<p class="commandline"> void fini (void) <p style="margin-left:.2in"><b>Description</b>:<br> Called when the plugin is removed. Clear any allocated storage here. -<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 style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> <p class="commandline"> int launch_p_setup_srun_opt(char **rest) <p style="margin-left:.2in"><b>Description</b>:<br> @@ -127,6 +133,6 @@ for a sample implementation of a SLURM launch plugin. <p class="footer"><a href="#top">top</a> -<p style="text-align:center;">Last modified 9 November 2012</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/mpiplugins.shtml b/doc/html/mpiplugins.shtml index fc19300dc8954e898b1a70153b8ec84f3ed83daa..a4dfa69217e984f6023661ed6dccf813bab0dd12 100644 --- a/doc/html/mpiplugins.shtml +++ b/doc/html/mpiplugins.shtml @@ -68,6 +68,27 @@ permitted on various data structures is identified for each function.</p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">int mpi_p_init (stepd_step_rec_t *job, int rank);</p> <p style="margin-left:.2in"><b>Description</b>: Used by slurmd to configure the slurmd's environment to that of the correct mpi.</p> @@ -126,6 +147,6 @@ to maintain data format compatibility across different versions of the plugin.</ <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 3 April 2012</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/plugins.shtml b/doc/html/plugins.shtml index d58b811875fc048d46cbb5017cb3eb8c7ce72a40..4ae2cc3c6f5e3a91e6babfdfb025306798126562 100644 --- a/doc/html/plugins.shtml +++ b/doc/html/plugins.shtml @@ -62,7 +62,8 @@ rounded to the next lowest 1,000. Only the major version number of this symbol is significant.</li> </ul> <p class="footer"><a href="#top">top</a></p> -<h2>API Functions</h2> + +<h2>API Functions in All Plugins</h2> <p class="commandline">int init (void);</p> <p style="margin-left:.2in"><b>Description</b>: If present, this function is called just after the plugin is loaded. This allows the plugin to perform any global @@ -77,15 +78,18 @@ just before the plugin is unloaded. This allows the plugin to do any finalizatio after the last plugin-specific API call is made.</p> <p style="margin-left:.2in"><b>Arguments</b>: None.</p> <p style="margin-left:.2in"><b>Returns</b>: None.</p> -<p><b>Note</b>: These functions are not the same as those described in the <span class="commandline">dlopen -(3)</span> system library. The C run-time system co-opts those symbols for its -own initialization. The system <span class="commandline">init()</span> is called -before the SLURM <span class="commandline">plugininit()</span>, and the SLURM -<span class="commandline">fini()</span> is called before the system's <span class="commandline">fini()</span>.</p> -<p>The functions need not appear. The plugin may provide either <span class="commandline">init()</span> -or <span class="commandline">fini()</span> or both.</p> +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> +<p>The functions need not appear. The plugin may provide either +<span class="commandline">init()</span> or <span class="commandline">fini()</span> or both.</p> <p class="footer"><a href="#top">top</a></p> <h2>Thread Safety</h2> + <p>SLURM is a multithreaded application. The SLURM plugin library may exercise the plugin functions in a re-entrant fashion. It is the responsibility of the plugin author to provide the necessarily mutual exclusion and synchronization @@ -108,6 +112,6 @@ utilize a thread for that functionality. This thread may be created by the for an example of how to do this.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 9 July 2004</p></td> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/preemption_plugins.shtml b/doc/html/preemption_plugins.shtml index 7d2c3232938ef9173b68d20d1e433ca23b61620b..23cf7d27579746e049f8d5bea98df23aa06e96d8 100644 --- a/doc/html/preemption_plugins.shtml +++ b/doc/html/preemption_plugins.shtml @@ -40,6 +40,27 @@ for an example implementation of a SLURM preemption plugin.</p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">List find_preemptable_jobs( struct job_record *job_ptr)</p> <p style="margin-left:.2in"><b>Description</b>: Identifies the jobs @@ -80,6 +101,6 @@ plugins.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 22 May 2010</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/priority_plugins.shtml b/doc/html/priority_plugins.shtml index 7d0833f986eb8b15209275985bd67472c2f19541..b2d6889988f0518fed76cba3297452a7ec1d0761 100644 --- a/doc/html/priority_plugins.shtml +++ b/doc/html/priority_plugins.shtml @@ -75,6 +75,27 @@ asked to see.</p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">uint32_t priority_p_set(uint32_t last_prio, struct job_record *job_ptr)</p> <p style="margin-left:.2in"><b>Description</b>: Sets the priority of the job.</p> <p style="margin-left:.2in"><b>Arguments</b>:<br> @@ -125,6 +146,6 @@ plugins.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 1 November 2013</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/proctrack_plugins.shtml b/doc/html/proctrack_plugins.shtml index 2fec4aea014be5d51c61035200c5ddfc64bed754..b713bd7616b97caff0cf35147ef089195405b78a 100644 --- a/doc/html/proctrack_plugins.shtml +++ b/doc/html/proctrack_plugins.shtml @@ -79,6 +79,27 @@ Successful API calls are not required to reset errno to a known value.</p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">int proctrack_p_create (stepd_step_rec_t *job);</p> <p style="margin-left:.2in"><b>Description</b>: Create a container. The caller should insure that be valid @@ -162,6 +183,6 @@ mechanism outlined for Slurm plugins.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 6 March 2014</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/schedplugins.shtml b/doc/html/schedplugins.shtml index e8d58bc73f9c797dec9de3fd560f2550bef09abb..89290728b237ee3f7e797e39fbd1fe189d3e4461 100644 --- a/doc/html/schedplugins.shtml +++ b/doc/html/schedplugins.shtml @@ -77,6 +77,27 @@ SLURM_SUCCESS. </p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">int slurm_sched_p_reconfig (void);</p> <p style="margin-left:.2in"><b>Description</b>: Reread any configuration files.</p> <p style="margin-left:.2in"><b>Arguments</b>: None</p> @@ -166,6 +187,6 @@ releases of SLURM may revise this API. A scheduler plugin conveys its ability to implement a particular API version using the mechanism outlined for SLURM plugins.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 4 October 2013</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/selectplugins.shtml b/doc/html/selectplugins.shtml index 71dbab4372a3f03965fa63766fea67198c0ddb0d..cc9136f29f173597563a2a9ea7605207a9651a75 100644 --- a/doc/html/selectplugins.shtml +++ b/doc/html/selectplugins.shtml @@ -98,6 +98,27 @@ manipulations (these functions are directly accessible from the plugin).</p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <h3>State Save Functions</h3> <p class="commandline">int select_p_state_save (char *dir_name);</p> @@ -749,6 +770,6 @@ to maintain data format compatibility across different versions of the plugin.</ <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 24 February 2014</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/slurmctld_plugstack.shtml b/doc/html/slurmctld_plugstack.shtml index 7f06c2e5e395b8b28e5ac7a05f536223c2bf225d..ce6d7d18dec2450225466f467e16052c1e145d7e 100644 --- a/doc/html/slurmctld_plugstack.shtml +++ b/doc/html/slurmctld_plugstack.shtml @@ -25,10 +25,31 @@ Slurm can be configured to use multiple slurmctld_plugstack plugins if desired.< <h2>API Functions</h2> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p>Only the init and fini functions of the plugin will be called. The init function will be called when the slurmctld daemon begins accepting RPCs. The fini function will be called when the slurmctld daemon stops accepting RPCs. -In the cased of the backup slurmctld daemon, the init and fini functions may +In the case of the backup slurmctld daemon, the init and fini functions may be called multiple times (when it assumes control functions and then when it reliquishes them to the primary slurmctld daemon).</p> @@ -37,6 +58,6 @@ reliquishes them to the primary slurmctld daemon).</p> releases of SLURM may revise this API. <p class="footer"><a href="#top">top</a> -<p style="text-align:center;">Last modified 23 January 2013</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/switchplugins.shtml b/doc/html/switchplugins.shtml index 952173fe10f83f87fd39e7d3cf3533d1f235a711..91b14c9f9029cea06997590f8aa1226c708e7333 100644 --- a/doc/html/switchplugins.shtml +++ b/doc/html/switchplugins.shtml @@ -70,6 +70,27 @@ SLURM_SUCCESS. </p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <h3>Global Switch State Functions</h3> <p class="commandline">int switch_p_libstate_save (char *dir_name);</p> <p style="margin-left:.2in"><b>Description</b>: Save any global switch state to a file @@ -581,6 +602,6 @@ plugin that transmitted it. It is at the discretion of the plugin author whether to maintain data format compatibility across different versions of the plugin.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 26 June 2013</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/taskplugins.shtml b/doc/html/taskplugins.shtml index 5ffacadcf16b3ef07a8811e528ca6d4f3ca8def1..cf15fd4ed2e7d6a290375f60fef3cf4da0afcef5 100644 --- a/doc/html/taskplugins.shtml +++ b/doc/html/taskplugins.shtml @@ -47,6 +47,27 @@ SLURM_ERROR.</p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">int task_p_slurmd_batch_request (uint32_t job_id, batch_job_launch_msg_t *req);</p> <p style="margin-left:.2in"><b>Description</b>: Prepare to launch a batch job. @@ -213,6 +234,6 @@ appropriate value to indicate the reason for failure.</p> Future releases of SLURM may revise this API.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 2 July 2013</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/topology_plugin.shtml b/doc/html/topology_plugin.shtml index 2c093847e5d01bd541ea4e86ebd9f8826609ee4f..99397da640e989fb60eb56913d531d55979eb47f 100644 --- a/doc/html/topology_plugin.shtml +++ b/doc/html/topology_plugin.shtml @@ -59,6 +59,27 @@ arising, should be SLURM_SUCCESS. </p> <p>The following functions must appear. Functions which are not implemented should be stubbed.</p> +<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 + called. Put global initialization here. +<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> + +<p class="commandline"> void fini (void) +<p style="margin-left:.2in"><b>Description</b>:<br> + Called when the plugin is removed. Clear any allocated storage here. +<p style="margin-left:.2in"><b>Returns</b>: None.</p> + +<p><b>Note</b>: These init and fini functions are not the same as those +described in the <span class="commandline">dlopen (3)</span> system library. +The C run-time system co-opts those symbols for its own initialization. +The system <span class="commandline">_init()</span> is called before the SLURM +<span class="commandline">init()</span>, and the SLURM +<span class="commandline">fini()</span> is called before the system's +<span class="commandline">_fini()</span>.</p> + <p class="commandline">int topo_build_config(void);</p> <p style="margin-left:.2in"><b>Description</b>: Generate topology information.</p> <p style="margin-left:.2in"><b>Returns</b>: SLURM_SUCCESS or @@ -90,6 +111,6 @@ SLURM_ERROR on failure.</p> Future releases of SLURM may revise this API.</p> <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 13 January 2011</p> +<p style="text-align:center;">Last modified 8 May 2014</p> <!--#include virtual="footer.txt"-->