# Slurm Scheduler Plugin API

## Overview

This document describe. Slurm scheduler plugins and the API that defines them. It is intended as a resource to programmers wishing to write their own SLURM scheduler plugins. This describes version 110 of the API.

It is noteworthy that two different models are used for job scheduling. The backfill scheduler let. Slurm establish the initial job priority and can periodically alter job priorities to change their order within the queue. The wiki scheduler establishes an initial priority of zero (held) for all jobs. These jobs only begin execution when the wiki scheduler explicitly raises the their priority (releasing them). Developers may use the model that best fits their needs. Note that a separate node selection plugin is available for controlling that aspect of scheduling.

Slurm scheduler plugins are Slurm plugins that implement the Slurm scheduler API described herein. They must conform to the Slurm Plugin API with the following specifications:

const char plugin_type[]
The major type must be "sched." The minor type can be any recognizable abbreviation for the type of scheduler. We recommend, for example:

- builtin—A plugin that implements the API without providing any actual scheduling services. This is the default behavior and implements first-in-first-out scheduling.
- backfill—Raise the priority of jobs if doing so results in their starting earlier without any delay in the expected initiation time of any higher priority job.
- wiki—Uses The Maui Scheduler (Wiki version) as an external entity to control Slurm job scheduling.
- wiki2—Uses Moab Cluster Suite as an external entity to control Slurm job scheduling. Note that wiki2 is an expanded version of the wiki plugin with additional functions supported specifically for Moab.

The plugin_name and plugin_version symbols required by the Slurm Plugin API require no specialization for scheduler support. Note carefully, however, the versioning discussion below.

The programmer is urged to study src/plugins/sched/backfill and src/plugins/sched/builtin for sample implementations of a Slurm scheduler plugin.

## Data Objects

The implementation must maintain (though not necessarily directly export) an enumerated errno to allow Slurm to discover as practically as possible the reason for any failed API call. Plugin-specific enumerated integer values should be used when appropriate. It is desirable that these values be mapped into the range ESLURM_SCHED_MIN and ESLURM_SCHED_MAX as defined in slurm/slurm_errno.h. The error number should be returned by the function slurm_sched_get_errno() and string describing the error's meaning should be returned by the function slurm_sched_strerror() described below.

These values must not be used as return values in integer-valued functions in the API. The proper error return value from integer-valued functions is SLURM_ERROR. The implementation should endeavor to provide useful and pertinent information by whatever means is practical. In some cases this means an errno for each credential, since plugins must be re-entrant. If a plugin maintains a global errno in place of or in addition to a per-credential errno, it is not required to enforce mutual exclusion on it. Successful API calls are not required to reset any errno to a known value. However, the initial value of any errno, prior to any error condition arising, should be SLURM_SUCCESS.

## API Functions

The following functions must appear. Functions which are not implemented should be stubbed.

int init (void)

Description:
Called when the plugin is loaded, before any other functions are called. Put global initialization here.

Returns:
SLURM_SUCCESS on success, or
SLURM_ERROR on failure.

void fini (void)

Description:
Called when the plugin is removed. Clear any allocated storage here.

Returns: None.

Note: These init and fini functions are not the same as those described in the dlopen (3) system library. The C run-time system co-opts those symbols for its own initialization. The system _init() is called before the SLURM init(), and the SLURM fini() is called before the system's _fini().

int slurm_sched_p_reconfig (void);

Description: Reread any configuration files.

Arguments: None

Returns: SLURM_SUCCESS if successful. On fail ure, the plugin should return SLURM_ERROR and set the errno to an appropriate value to indicate the reason for failure.

int slurm_sched_p_schedule (void);

Description: For passive schedulers, invoke a scheduling pass.

Arguments: None

Returns: SLURM_SUCCESS if successful. On failure, the plugin should return SLURM_ERROR and set the errno to an appropriate value to indicate the reason for failure.

int slurm_sched_p_newalloc (void);

Description: Note the successful allocation of resources to a job.

Arguments: Pointer to the slurmctld job structure. This can be used to get partition, allocated resources, time limit, etc.

Returns: SLURM_SUCCESS if successful. On failure, the plugin should return SLURM_ERROR and set the errno to an appropriate value to indicate the reason for failure.

int slurm_sched_p_freealloc (void);

Description: Note the successful release of resources for a job.

Arguments: Pointer to the slurmctld job structure. This can be used to get partition, allocated resources, time limit, etc.

Returns: SLURM_SUCCESS if successful. On failure, the plugin should return SLURM_ERROR and set the errno to an appropriate value to indicate the reason for failure.

uint32_t slurm_sched_p_initial_priority ( uint32_t last_prio, struct job_record *job_ptr);

Description: Establish the initial priority of a new job.

Arguments:
last_prio (input) default priority of the previously submitted job. This can be used to provide First-In-First-Out scheduling by assigning the new job a priority lower than this value. This could also be used to establish an initial priority of zero for all jobs, representing a "held" state. The scheduler plugin can then decide where and when to initiate pending jobs by altering their priority and (optionally) list of required nodes.
job_ptr (input) Pointer to the slurmctld job structure. This can be used to get partition, resource requirements, time limit, etc.

Returns: The priority to be assigned to this job.

void slurm_sched_p_job_is_pending (void);

Description: Note that some job is pending execution.

Arguments: None

Returns: Nothing.

void slurm_sched_p_partition_change (void);

Description: Note that some partition state change happened such as time or size limits.

Arguments: None

Returns: Nothing.

char *slurm_sched_p_get_conf (void);

Description: Return scheduler specific configuration information to be reported for the scontrol show configuration command.

Arguments: None

Returns: A string containing configuration information. The return value is released using the xfree() function.

int slurm_sched_p_get_errno (void);

Description: Return the number of a scheduler specific error.

Arguments: None

Returns: Error number for the last failure encountered by the scheduler plugin.

const char *slurm_sched_p_strerror(int errnum);

Description: Return a string description of a scheduler specific error code.

Arguments:
errnum (input) a scheduler specific error code.

Returns: Pointer to string describing the error or NULL if no description found in this plugin.

## Versioning

This document describes version 110 of the Slurm Scheduler API. Future 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.

Last modified 8 May 2014