PP-624 DRMAAv2 implementation for PBSPro

Target release	1.0
Epic	PP-624 - Getting issue details... STATUS
Document status	DRAFT
Document owner	Vinod (Deactivated)
Designer	Ram Pranesh Suresh Thelkar (Deactivated) Arun Grover (Deactivated) Vinod (Deactivated)
Developers	Ram Pranesh Suresh Thelkar (Deactivated) Arun Grover (Deactivated) Vinod (Deactivated)
QA	<TBD>

Goals

Implementation of DRMAAv2 Specification

Background and strategic fit

The Distributed Resource Management Application API Version 2 (DRMAA) specification defines an interface for tightly coupled, but still portable access to the majority of DRM systems. PBS is a Distributed Resource Management system(DRMS). Standardized access to PBS product through a DRMAAv2 implementation(API). High-level API designers, meta-scheduler architects and end users can rely on DRMAAv2 implementations for a unified access to execution resources.

DRMAAv2 Specification (Distributed Resource Management Application API 2)

Overview

Open standards are taking major role in the exponential growth in many areas. DRMAA2 is such an open standard. It is the successor of the wide-spread DRMAA standard. DRMAA is generally used for submitting jobs (or creating job work-flows) into a compute cluster by using a cluster resource management system like PBS Professional. Unlike DRMAA, with DRMAA2 you can not only submit jobs, you can also get cluster related information, like getting host names, types and status information or insight about queues configured in the resource management system. You can also monitor jobs not submitted within the application. Overall it covers many more use cases than the old DRMAA standard.

More details of DRMAA2 specification can be found from the following document.

https://www.ogf.org/documents/GFD.231.pdf

Assumptions

Color coding in Diagram

Requirements

The implementation of DRMAA2 specification for PBS Pro is broadly divided into the following requirements/user stories.

#	User Story	Importance	Notes
1	PP-628 - Getting issue details... STATUS
2	PP-634 - Getting issue details... STATUS
3	PP-631 - Getting issue details... STATUS
4	PP-630 - Getting issue details... STATUS
5	PP-629 - Getting issue details... STATUS
6	PP-632 - Getting issue details... STATUS
7	PP-633 - Getting issue details... STATUS
8	PP-643 - Getting issue details... STATUS
9	PP-626 - Getting issue details... STATUS
10	PP-644 - Getting issue details... STATUS
11	PP-636 - Getting issue details... STATUS

Architecture and design

Application stack

DRMAA2 Layout

Error rendering macro 'viewpdf' : Failed to find attachment with Name DRMAAv2_Layout.pdf

Note : Document is part of https://troeger.eu/files/talks/ogf35.pdf

Domain model diagram

ConnectionPool is a set of active connections with PBSPro. In multi-threaded application each thread uses one connection. ConnectionPool Is Member of DRMSystem

Job State model Defined in DRMAAv2 Specification

Error rendering macro 'viewpdf' : Failed to find attachment with Name statemodel.pdf

Note : Document is part of https://www.ogf.org/documents/GFD.231.pdf

DRMAA2 spec relies on concept of session to support the persistency of job and reservation information in multiple runs of short lived applications.

The SessionManager interface is the main interface of a DRMAA implementation for establishing communication with the DRMS. By the help of this interface, sessions for job management, monitoring, and/or reservation management can be maintained.

JobSession allows us to submit, control and monitor jobs. As opposed to MonitoringSession this allows us to control and monitor only those jobs submitted with in this job session only.
MonitoringSession allows us to get on-line status of jobs submitted with in DRMAA2 JobSession/s as well as those submitted outside of DRMAA2 as well. Within a monitoring session we can't submit or control jobs. Due to this reason we can say that DRMAA2 is good to write Job Monitoring GUIs.
ReservationSession allows us to submit, control and monitor standing or advanced reservations.

Refer DRMAAv2 document for description of Objects

Few important Sequence diagram

Source Directory structure in github

├── ...

├── PBSPro

│   ├── DRMAAv2                               # DRMAAv2 module Top level directory

|   ├──   ├──  -- configure.ac                # This file dictates the behavior of the final configure script that is generated by Autoconf.

|   ├──   ├──  -- INSTALL                     # Instructions for successful compilation of this

|   ├──   ├──  -- autogen.sh                  # This file provides automatic build system preparation and is useful for projects that use the GNU autotools.  
|   ├──   ├──  -- AUTHORS                     # Altair authors information

|   ├──   ├──  -- ChangeLog                   # Delta change information

|   ├──   ├──  -- COPYING                     # Altair Copyright information

|   ├──   ├──  -- NEWS                        # Latest news and updates

|   ├──   ├──  -- README                      # README

|   ├──   ├──   api                           # This directory contains all the function prototypes and definitions included in this API.

│   ├──   ├──   ├── c-binding                 # C style API definitions for external use

│   ├──   ├──   ├──   ├── -- drmaa2.cpp       # API definitions

│   ├──   ├──   ├──   ├── -- drmaa2.h         # API and declaration

│   ├──   ├──   ├── cpp-binding               # CPP style class definitions for external use

│   ├──   ├──   ├──  -- drmaa2.hpp            # Class level declaration

|   ├──   ├──   src                           # Core infrastructure source files

|   ├──   ├──   inc                           # Core infrastructure internal include files

|   ├──   ├──   m4                            # GNU m4 macros required for DRMAAv2

|   ├──   ├──   docs                          # Documentation files

|   ├──   ├──   ├──   man                     # Man pages
|   ├──   ├──   ├── -- Doxygen.in             # Doxygen configure file

|   ├──   ├──   test                          # Testing

|   ├──   ├──   ├──  unittesting              # White-box testing(using CppUnit).

|   ├──   ├──   ├──  benchmarks               # Placeholder for Load and stress tests

Directory structure in target

├── ...

├── $(DRMAAV2_LIB)

│   ├── libdrmaav2.so

├── $(DRMAAV2_INCLUDE)
│   ├── c-binding

│   ├──   ├── drmaa2.h

│   ├── cpp-binding

│   ├──   ├── drmaav2.hpp

Dependent packages

PBSPro - libdrmaav2.so needs libpbs.so library for IFL calls

cppunit - for unittesting

doxygen - for generating docs

Compiling DRMAA2 applications for PBS Pro

It is assumed that libdrmaa2.so or libdrmaa2.a is installed as follows prior to compiling a DRMAA2 application.

rpm --install <rpm for libdrmaav2 for PBS Pro>

Example: rpm --install libdrmaav2_pbspro-1.0-17.x86_64.rpm

By default this will install the library to /usr/lib/libdrmaa2.*(so or a) and the headers are installed at /usr/include/drmaa2.

Now DRMAA2 application can be compiled as follows.

gcc -I/usr/include/drmaa2 -L/usr/lib/libdrmaa2.so <drmaa2_app> -ldrmaa2

We also need to set the following before starting the application if in case we are using shared library.

export LD_LIBRARY_PATH=/usr/lib/libdrmaa2.so ./<drmaa2_app>

IFL call mapping with C-Style and CPP-style binding<WIP>

C-Style Binding	CPP-Style Binding	IFL calls
void drmaa2_jsession_free(drmaa2_jsession * js)	delete jobSession;
void drmaa2_rsession_free(drmaa2_rsession * rs)	delete reservationSession;
void drmaa2_j_free(drmaa2_j * j)	delete job;
void drmaa2_jarray_free(drmaa2_jarray * ja)	delete jobArray;
void drmaa2_r_free(drmaa2_r * r)	delete reservation;
drmaa2_string drmaa2_rsession_get_contact(const drmaa2_rsession rs);	reservationSession.getContact()
drmaa2_string drmaa2_rsession_get_session_name(const drmaa2_rsession rs);	reservationSession.getSessionName()
drmaa2_r drmaa2_rsession_get_reservation (const drmaa2_rsession rs, const drmaa2_string reservationId);	reservationSession.getReservation()	pbs_statresv
drmaa2_r drmaa2_rsession_request_reservation (const drmaa2_rsession rs, const drmaa2_rtemplate rt);	reservationSession.requestReservation()	pbs_submit_resv
drmaa2_r_list drmaa2_rsession_get_reservations (const drmaa2_rsession rs);	reservationSession.getReservations()	pbs_statresv
drmaa2_string drmaa2_r_get_id (const drmaa2_r r);	reservation.getId()
drmaa2_string drmaa2_r_get_session_name (const drmaa2_r r);	reservation.getId()
drmaa2_rtemplate drmaa2_r_get_reservation_template(const drmaa2_r r);	reservation.getReservationTemplate()
drmaa2_rinfo drmaa2_r_get_info(const drmaa2_r r);	reservation.getReservationInfo()	pbs_statresv
drmaa2_error drmaa2_r_terminate(drmaa2_r r);	reservation.terminate()	pbs_delresv
drmaa2_string drmaa2_jarray_get_id(const drmaa2_jarray ja);	jobArray.getId()
drmaa2_j_list drmaa2_jarray_get_jobs(const drmaa2_jarray ja);	jobArray.getJobs()	pbs_selectjob
drmaa2_string drmaa2_jarray_get_session_name(const drmaa2_jarray ja);	jobArray.getSessionName()
drmaa2_jtemplate drmaa2_jarray_get_job_template(const drmaa2_jarray ja);	jobArray.getJobTemplete()
drmaa2_error drmaa2_jarray_suspend(drmaa2_jarray ja);	jobArray.suspend()	pbs_sigjob
drmaa2_error drmaa2_jarray_resume(drmaa2_jarray ja);	jobArray.resume()	pbs_sigjob
drmaa2_error drmaa2_jarray_hold(drmaa2_jarray ja);	jobArray.hold()	pbs_holdjob
drmaa2_error drmaa2_jarray_release(drmaa2_jarray ja);	jobArray.release()	pbs_rlsjob
drmaa2_error drmaa2_jarray_terminate(drmaa2_jarray ja);	jobArray.terminate()	pbs_deljob
drmaa2_string drmaa2_jsession_get_contact(const drmaa2_jsession js);	jobSession.getContact()
drmaa2_string drmaa2_jsession_get_session_name(const drmaa2_jsession js);	jobSession.getSessionName()
drmaa2_string_list drmaa2_jsession_get_job_categories(const drmaa2_jsession js);	jobSession.getJobCategeries()
drmaa2_j_list drmaa2_jsession_get_jobs (const drmaa2_jsession js, const drmaa2_jinfo filter);	jobSession.getJobs()	pbs_selectjob
drmaa2_jarray drmaa2_jsession_get_job_array (const drmaa2_jsession js, const drmaa2_string jobarrayId);	jobSession.getJobArray()	pbs_selectjob
drmaa2_j drmaa2_jsession_run_job (const drmaa2_jsession js, const drmaa2_jtemplate jt);	jobSession.runJob()	pbs_runjob , pbs_asyrunjob
drmaa2_jarray drmaa2_jsession_run_bulk_jobs (const drmaa2_jsession js, const drmaa2_jtemplate jt, unsigned long begin_index, unsigned long end_index, unsigned long step, unsigned long max_parallel);	jobSession.runBulkJobs	pbs_runjob , pbs_asyrunjob
drmaa2_j drmaa2_jsession_wait_any_started (const drmaa2_jsession js, const drmaa2_j_list l, const time_t timeout);	jobSession.waitAnyStarted	pbs_selectjob
drmaa2_j drmaa2_jsession_wait_any_terminated (const drmaa2_jsession js, const drmaa2_j_list l, const time_t timeout);	jobSession.waitAnyTerminated	pbs_selectjob
drmaa2_string drmaa2_j_get_id(const drmaa2_j j);	job.getId()
drmaa2_string drmaa2_j_get_session_name(const drmaa2_j j);	job.getSessionName
drmaa2_jtemplate drmaa2_j_get_jt(const drmaa2_j j);	job.getJobTemplete()
drmaa2_error drmaa2_j_suspend(drmaa2_j j);	job.suspend()	pbs_sigjob
drmaa2_error drmaa2_j_resume(drmaa2_j j);	job.resume()	pbs_sigjob
drmaa2_error drmaa2_j_hold (drmaa2_j j);	job.hold()	pbs_holdjob
drmaa2_error drmaa2_j_release(drmaa2_j j);	job.resume()	pbs_rlsjob
drmaa2_error drmaa2_j_terminate(drmaa2_j j);	job.terminate()	pbs_deljob
drmaa2_jstate drmaa2_j_get_state (const drmaa2_j j, drmaa2_string * substate);	job.getState()
drmaa2_jinfo drmaa2_j_get_info(const drmaa2_j j);	job.getInfo()
drmaa2_error drmaa2_j_wait_started (const drmaa2_j j, const time_t timeout);	job.waitStarted()	pbs_selectjob
drmaa2_error drmaa2_j_wait_terminated (const drmaa2_j j, const time_t timeout);	job.waitTerminated()	pbs_selectjob
drmaa2_r_list drmaa2_msession_get_all_reservations (const drmaa2_msession ms);	monitoringSession.getAllReservations()	pbs_statresv
drmaa2_j_list drmaa2_msession_get_all_jobs (const drmaa2_msession ms, const drmaa2_jinfo filter);	monitoringSession.getAllJobs()	pbs_selectjob
drmaa2_queueinfo_list drmaa2_msession_get_all_queues (const drmaa2_msession ms, const drmaa2_string_list names);	monitoringSession.getAllQueues	pbs_statque
drmaa2_machineinfo_list drmaa2_msession_get_all_machines (const drmaa2_msession ms, const drmaa2_string_list names);	monitoringSession.getAllMachines()	pbs_statnode , pbs_stathost ,pbs_statvnode
drmaa2_string drmaa2_get_drms_name()	sessionManager.getDrmsName()
drmaa2_version drmaa2_get_drms_version()	sessionManager.getDrmsVersion()
drmaa2_string drmaa2_get_drmaa_name()	sessionManager.getDrmaaName()
drmaa2_version drmaa2_get_drmaa_version()	sessionManager.getDrmaaName()
drmaa2_bool drmaa2_supports()	sessionManager.supports()
drmaa2_jsession drmaa2_create_jsession (const char * session_name, const char * contact);	sessionManager.createJobSession()
drmaa2_rsession drmaa2_create_rsession(const char * session_name, const char * contact);	sessionManager.createReservationSession()
drmaa2_jsession drmaa2_open_jsession (const char * session_name);	sessionManager.openJobSession()
drmaa2_rsession drmaa2_open_rsession (const char * session_name);	sessionManager.openReservationSession()
drmaa2_msession drmaa2_open_msession (const char * session_name);	sessionManager.openMonitoringSession
drmaa2_error drmaa2_close_jsession (drmaa2_jsession js);	sessionManager.closeJobSession()
drmaa2_error drmaa2_close_rsession (drmaa2_rsession rs);	sessionManager.closeReservationSession()
drmaa2_error drmaa2_close_msession (drmaa2_msession ms);	sessionManager.closeMonitoringSession()
drmaa2_error drmaa2_destroy_jsession (const char * session_name);	sessionManager.destroyJobSession()
drmaa2_error drmaa2_destroy_rsession (const char * session_name);	sessionManager.closeReservationSession()
drmaa2_string_list drmaa2_get_jsession_names()	sessionManager.getJobSessionNames()
drmaa2_string_list drmaa2_get_rsession_names ()	sessionManager.getReservationSessionNames()
drmaa2_error drmaa2_register_event_notification (const drmaa2_callback callback);	sessionManager.registerEventNotification()

CPP-Style binding

CPP-style class defination

  
namespace drmaa2 {

typedef long TimeAmount;
typedef time_t AbsoluteTime;

enum DrmaaCapability {
    ADVANCE_RESERVATION,
    RESERVE_SLOTS,
    CALLBACK,
    BULK_JOBS_MAXPARALLEL,
    JT_EMAIL,
    JT_STAGING,
    JT_DEADLINE,
    JT_MAXSLOTS,
    JT_ACCOUNTINGID,
    RT_STARTNOW,
    RT_DURATION,
    RT_MACHINEOS,
    T_MACHINEARCH
};

enum JobState {
    UNDETERMINED,
    QUEUED,
    QUEUED_HELD,
    RUNNING,
    SUSPENDED,
    REQUEUED,
    REQUEUED_HELD,
    DONE,
    FAILED
};
enum OperatingSystem {
    AIX = 0,
    BSD = 1,
    LINUX = 2,
    HPUX = 3,
    IRIX = 4,
    MACOS = 5,
    SUNOS = 6,
    TRUE64 = 7,
    UNIXWARE = 8,
    WI = 9,
    WINNT = 10,
    OTHER_OS = 11
};

enum CpuArchitecture {
    ALPHA = 0,
    ARM = 1,
    CELL = 2,
    PARISC = 3,
    X86 = 4,
    X64 = 5,
    IA64 = 6,
    MIPS = 7,
    PPC = 8,
    PPC64 = 9,
    SPARC = 10,
    SPARC64 = 11,
    OTHER_CPU = 12
};
template<class T>
typedef map<string, T> Dictionary;

typedef list<string> StringList;
typedef list<string> OrderedStringList;
enum DrmaaEvent {
    NEW_STATE, MIGRATED, ATTRIBUTE_CHANGE
};

class DrmaaCallback {
    void notify(DrmaaNotification notification) = 0;
};
struct DrmaaNotification {
    DrmaaEvent event;
    string jobId;
    string sessionName;
    JobState jobState;
};
struct Version {
    string major;
    string minor;
};
struct ReservationTemplate {
    string reservationName;
    time_t startTime;
    time_t endTime;
    time_t duration;
    long minSlots;
    long maxSlots;
    set<string> usersACL;
    vector<string> candidateMachines;
    long minPhysMemory;
    OperatingSystem machineOS;
    CpuArchitecture machineArch;
};
struct QueueInfo {
    string name;
};
typedef list<QueueInfo> QueueInfoList;

struct JobInfo {
    string jobId;
    long exitStatus;
    string terminatingSignal;
    string annotation;
    JobState jobState;
    string jobSubState;
    vector<string> allocatedMachines;
    string submissionMachine;
    string jobOwner;
    long slots;
    string queueName;
    time_t wallclockTime;
    long cpuTime;
    time_t submissionTime;
    time_t dispatchTime;
    time_t finishTime;
};
typedef list<JobInfo> JobInfoList;

struct SlotInfo {
    string machineName;
    string slots;
};
typedef list<SlotInfo> SlotInfoList;

struct ReservationInfo {
    string reservationId;
    string reservationName;
    time_t reservedStartTime;
    time_t reservedEndTime;
    set<string> usersACL;
    long reservedSlots;
    SlotInfoList reservedMachines;
};
typedef list<ReservationInfo> ReservationInfoList;

struct JobTemplate {
    string remoteCommand;
    vector<string> args;
    bool submitAsHold;
    bool rerunnable;
    Dictionary<string> jobEnvironment;
    string workingDirectory;
    string jobCategory;
    set<string> email;
    bool emailOnStarted;
    bool emailOnTerminated;
    string jobName;
    string inputPath;
    string outputPath;
    string errorPath;
    bool joinFiles;
    string reservationId;
    string queueName;
    long minSlots;
    long maxSlots;
    long priority;
    vector<string> candidateMachines;
    long minPhysMemory;
    OperatingSystem machineOS;
    CpuArchitecture machineArch;
    time_t startTime;
    time_t deadlineTime;
    Dictionary<string> stageInFiles;
    Dictionary<string> stageOutFiles;
    Dictionary<string> resourceLimits;
    string accountingId;
};

struct MachineInfo {
    string name;
    bool available;
    long sockets;
    long coresPerSocket;
    long threadsPerCore;
    double load;
    long physMemory;
    long virtMemory;
    OperatingSystem machineOS;
    Version machineOSVersion;
    CpuArchitecture machineArch;
};
typedef list<MachineInfo> MachineInfoList;

class Drmaa2Exception;
class DeniedByDrmsException;
class DrmCommunicationException;
class TryLaterException;
class TimeoutException;
class InternalException;
class InvalidArgumentException;
class InvalidSessionException;
class InvalidStateException;
class OutOfResourceException;
class UnsupportedAttributeException;
class UnsupportedOperationException;
class ImplementationSpecificException;

class DrmaaReflective {
    /**
     * TODO : How to support reflective in C++?
     * Java provides reflection
     */
    StringList jobTemplateImplSpec;
    StringList jobInfoImplSpec;
    StringList reservationTemplateImplSpec;
    StringList reservationInfoImplSpec;
    StringList queueInfoImplSpec;
    StringList machineInfoImplSpec;
    StringList notificationImplSpec;
    string getInstanceValue(void *instance, string name);
    void setInstanceValue(void *instance, string name, string value);
    string describeAttribute(void *instance, string name);
};

class JobArray {
public:
    virtual ~JobArray(void);
    virtual string& getJobArrayId(void) const = 0;
    virtual JobList& getJobs(void) const = 0;
    virtual JobSession& getSession(void) const = 0;
    virtual JobTemplate& getJobTemplate(void) const = 0;

    virtual void suspend(void) = 0;
    virtual void resume(void) = 0;
    virtual void hold(void) = 0;
    virtual void release(void) = 0;
    virtual void terminate(void) = 0;
};

class Job {
public:
    virtual ~Job(void);
    virtual const string& getJobId(void) const = 0;
    virtual const JobInfo& getJobInfo(void) const = 0;
    virtual const JobState& getState(string& subState) const = 0;
    virtual const JobTemplate& getJobTemplate(void) const = 0;
    virtual void suspend(void) = 0;
    virtual void resume(void) = 0;
    virtual void hold(void) = 0;
    virtual void release(void) = 0;
    virtual void terminate(void) = 0;
    virtual void waitStarted(TimeAmount& timeout_) = 0;
    virtual void waitTerminated(TimeAmount& timeout_) = 0;
};
typedef list<Job> JobList;

class Reservation {
public:
    virtual ~Reservation(void);
    virtual const string& getReservationId(void) const = 0;
    virtual const ReservationSession& getSession(void) const = 0;
    virtual const ReservationTemplate& getReservationTemplate(void) const = 0;
    virtual const ReservationInfo& getInfo(void) const = 0;
    virtual void terminate(void) = 0;
};
typedef list<Reservation> ReservationList;

class ReservationSession {
public:
    virtual ~ReservationSession(void);
    virtual const string& getContact(void) const = 0;
    virtual const string& getSessionName(void) const = 0;
    virtual const Reservation& getReservation(string& reservationId_) = 0;
    virtual const Reservation& requestReservation(
            const ReservationTemplate& reservationTemplate_) = 0;
    virtual const ReservationList& getReservations(void) = 0;
};

class JobSession {
public:
    virtual ~JobSession(void);
    virtual const string& getContact(void) const = 0;
    virtual const string& getSessionName(void) const = 0;
    virtual const StringList getJobCategories(void) const = 0;
    virtual const JobList& getJobs(const JobInfo& filter_) = 0;
    virtual const JobArray& getJobArray(const string& jobArrayId_) = 0;
    virtual const string& runJob(const JobTemplate& jobTemplate_) = 0;
    virtual const JobArray& runBulkJobs(const JobTemplate& jobTemplate_,
            const long beginIndex_, const long endIndex_, const long step_,
            const long maxParallel_) = 0;
    virtual const Job& waitAnyStarted(const JobList& jobs_const,
            const TimeAmount timeout_) = 0;
    virtual const Job& waitAnyTerminated(const JobList& jobs_,
            const TimeAmount timeout_) = 0;
};

class MonitoringSession {
public:
    virtual ~MonitoringSession(void);
    virtual const MachineInfoList& getAllMachines(list<string> machines_) = 0;
    virtual const ReservationList& getAllReservations(void) = 0;
    virtual const JobList& getAllJobs(JobInfo& filter_) = 0;
    virtual const QueueInfoList& getAllQueues(list<string> queues_) = 0;
};

class SessionManager {

private:
    SessionManager();

public:
    /**
     * SessionManager as singleton
     */
    static SessionManager& getInstance() = 0;

public:
    virtual ~SessionManager(void);
    virtual const string& getDrmsName(void) const = 0;
    virtual const Version& getDrmsVersion(void) const = 0;
    virtual const Version& getDrmaaVersion(void) const = 0;

    virtual bool supports(const DrmaaCapability& capability_) = 0;

    virtual const JobSession& createJobSession(const string& sessionName_,
            const string& contact_) = 0;
    virtual const JobSession& openJobSession(const string& sessionName_) = 0;
    virtual void closeJobSession(JobSession& session_) = 0;
    virtual void destroyJobSession(const string& sessionName_) = 0;

    virtual const ReservationSession& createReservationSession(
            const string& sessionName_, const string& contact_) = 0;
    virtual const ReservationSession& openReservationSession(
            const string& sessionName_) = 0;
    virtual void closeReservationSession(ReservationSession& session_) = 0;
    void destroyReservationSession(const string& sessionName_) = 0;

    virtual const MonitoringSession& openMonitoringSession(
            const string& contact_) = 0;
    virtual void closeMonitoringSession(MonitoringSession& session_) = 0;

    virtual const StringList& getReservationSessionNames(void) = 0;
    virtual const StringList& getJobSessionNames(void) = 0;

};

C-Style binding APIs definition

Note: APIs are as defined in https://www.ogf.org/documents/GFD.230.pdf

Forward declaration required for API

typedef const char * drmaa2_string;
typedef struct drmaa2_list_s * drmaa2_list;
typedef struct drmaa2_list_s * drmaa2_string_list;
typedef struct drmaa2_list_s * drmaa2_j_list;
typedef struct drmaa2_list_s * drmaa2_queueinfo_list;
typedef struct drmaa2_list_s * drmaa2_machineinfo_list;
typedef struct drmaa2_list_s * drmaa2_slotinfo_list;
typedef struct drmaa2_list_s * drmaa2_r_list;
typedef struct drmaa2_dict_s * drmaa2_dict;
typedef drmaa2_jinfo_s * drmaa2_jinfo;
typedef drmaa2_slotinfo_s * drmaa2_slotinfo;
typedef drmaa2_rinfo_s * drmaa2_rinfo;
typedef drmaa2_jtemplate_s * drmaa2_jtemplate;
typedef drmaa2_rtemplate_s * drmaa2_rtemplate;
typedef drmaa2_notification_s * drmaa2_notification;
typedef drmaa2_queueinfo_s * drmaa2_queueinfo;
typedef drmaa2_version_s * drmaa2_version;
typedef drmaa2_machineinfo_s * drmaa2_machineinfo;
typedef struct drmaa2_jsession_s * drmaa2_jsession;
typedef struct drmaa2_rsession_s * drmaa2_rsession;
typedef struct drmaa2_msession_s * drmaa2_msession;
typedef struct drmaa2_j_s        * drmaa2_j;
typedef struct drmaa2_jarray_s   * drmaa2_jarray;
typedef struct drmaa2_r_s        * drmaa2_r;


/**
 Note : Names ending with _s are forward declaration 
**/

Job States defined in specification

typedef enum drmaa2_jstate {
    DRMAA2_UNDETERMINED                =  0,
    DRMAA2_QUEUED                      =  1,
    DRMAA2_QUEUED_HELD                 =  2,
    DRMAA2_RUNNING                     =  3,
    DRMAA2_SUSPENDED                   =  4,
    DRMAA2_REQUEUED                    =  5,
    DRMAA2_REQUEUED_HELD               =  6,
    DRMAA2_DONE                        =  7,
    DRMAA2_FAILED                      =  8
} drmaa2_jstate;

/**
Note : Refer DRMAA State Model in specfication
**/

API

   drmaa2_error drmaa2_close_jsession (drmaa2_jsession js_)
       drmaa2_close_jsession - closes the drmaa2_job session pointed by js

       Parameters:
           js_ - pointer to drmaa2_job session which needs to be closed

       Side-Effects: none

       Returns:
           drmaa2_error - returns DRMAA2_SUCCESS if successful DRMAA2_INVALID_SESSION if session is invalid

   drmaa2_error drmaa2_close_msession (drmaa2_msession ms_)
       Dis-associates monitoring session from DRMS. Should be callable only once else it should return DRMAA2_INVALID_SESSION error.

       Parameters:
           ms_ - pointer to drmaa2 monitoring session created earlier.

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if succeeds NULL and also sets sets drmaa2_lasterror_v to DRMAA2_INVALID_SESSION error if fails

   drmaa2_error drmaa2_close_rsession (drmaa2_rsession rs_)
       Disassociates reservation session from DRMS. Should be callable only once else it should return DRMAA2_INVALID_SESSION error.

       Parameters:
           rs_ - pointer to drmaa2 reservation session created earlier.

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if succeeds NULL and also sets sets drmaa2_lasterror_v to DRMAA2_INVALID_SESSION error if fails

   drmaa2_jsession drmaa2_create_jsession (const char * session_name_, const char * contact_)
       Creates a drmaa2 job session for a given name and contact.

       Parameters:
           session_name_ - Name of the session .
           contact_ - DRMS name.

       Side-Effects: none

       Returns:
           drmaa2_jsession if succeeds NULL if fails and sets drmaa2_lasterror_v to DRMAA2_INVALID_ARGUMENT error.

   drmaa2_rsession drmaa2_create_rsession (const char * session_name_, const char * contact_)
       Creates a drmaa2 reservation session for a given name and contact.

       Parameters:
           session_name_ - Name of the session.
           contact_ - DRMS name.

       Side-Effects: none

       Returns:
           drmaa2_jsession if succeeds NULL if fails and sets DRMAA2_INVALID_ARGUMENT error.

   drmaa2_string drmaa2_describe_attribute (const void * instance, const char * name)
   drmaa2_error drmaa2_destroy_jsession (const char * session_name_)
       drmaa2_destroy_jsession - destroys the drmaa2_job session pointed by js

       Parameters:
           session_name_ - pointer to drmaa2_job session which needs to be closed

       Side-Effects: none

           @return
               DRMAA2_SUCCESS if successful
           DRMAA2_INVALID_ARGUMENT if session name is invalid

   drmaa2_error drmaa2_destroy_rsession (const char * session_name_)
       Reaps the persisted or cached state information for the given session name.

       Parameters:
           session_name_ - Name of the session.

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if successful DRMAA2_INVALID_ARGUMENT if session name is invalid

   drmaa2_dict drmaa2_dict_create (const drmaa2_dict_entryfree callback)
       This function creates a drmaa dictionary.

       Parameters:
           callback - Call back function to call when free is called.

       Side-Effects: none

       Returns:
           drmaa2_dict

   drmaa2_error drmaa2_dict_del (drmaa2_dict d, const char * key)
       This function deletes the entry with specified key from the dictionary.

       Parameters:
           d - Pointer to drmaa dict
           key - pointer to key string

       Side-Effects: none

       Returns:
           drmaa2_error - DRMAA2_SUCCESS

           · DRMAA2_INVALID_ARGUMENT

   void drmaa2_dict_free (drmaa2_dict * dRef)
       This function frees a drmaa dict.

       Parameters:
           dRef - Pointer to drmaa dict

       Side-Effects: none

       Returns:
           void

   const char* drmaa2_dict_get (const drmaa2_dict d, const char * key)
       This function gets the key's value from the dictionary.

       Parameters:
           d - Pointer to drmaa dict
           key - pointer to key string

       Side-Effects: none

       Returns:
           char *

   drmaa2_bool drmaa2_dict_has (const drmaa2_dict d, const char * key)
       This function checks for the presence of key in the dictionary.

       Parameters:
           d - Pointer to drmaa dict
           key - pointer to key string

       Side-Effects: none

       Returns:
           drmaa2_bool

   drmaa2_string_list drmaa2_dict_list (const drmaa2_dict d)
       This function returns a drmaa list of keys in the dictionary.

       Parameters:
           d - Pointer to drmaa dict

       Side-Effects: none

       Returns:
           drmaa2_string_list

   drmaa2_error drmaa2_dict_set (drmaa2_dict d, const char * key, const char * val)
       This function sets the key value pair to the dictionary.

       Parameters:
           d - Pointer to drmaa dict
           key - pointer to key string
           val - pointer to value string

       Side-Effects: none

       Returns:
           drmaa2_error - DRMAA2_SUCCESS

           · DRMAA2_INVALID_ARGUMENT

   drmaa2_string drmaa2_get_drmaa_name (void)
       drmaa2_get_drmaa_name - returns the DRM application name

       Parameters:
           - void

       Side-Effects: none

           ·

       Returns:
           drmaa2_string

   drmaa2_version drmaa2_get_drmaa_version (void)
       drmaa2_get_drmaa_version - returns the DRM application version

       Parameters:
           - void

       Side-Effects: none

       Returns:
           drmaa2_version

   drmaa2_string drmaa2_get_drms_name (void)
       drmaa2_get_drms_name - returns the DRM system name

       Parameters:
           - void

       Side-Effects: none

       Returns:
           drmaa2_string

   drmaa2_version drmaa2_get_drms_version (void)
       drmaa2_get_drms_version - returns the DRM system version

       Parameters:
           - void

       Side-Effects: none

       Returns:
           drmaa2_version

   drmaa2_string drmaa2_get_instance_value (const void * instance, const char * name)
   drmaa2_string_list drmaa2_get_jsession_names (void)
       drmaa2_get_jsession_names - returns the list of drmaa2_job sessions

       Side-Effects: none

       Returns:
           drmaa2_string_list - returns list of job session names available NULL and last error is set

   drmaa2_string_list drmaa2_get_rsession_names (void)
       Get a list of all reservation session names.

       Side-Effects: none

       Returns:
           drmaa2_string_list - list of reservation sessions NULL - If there are no existing reservation sessions

           · If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

   void drmaa2_j_free (drmaa2_j * j)
       drmaa2_j_free - frees the drmaa2_job structure pointed by j

       Parameters:
           j - pointer to drmaa2_job

       Side-Effects: none

       Returns:
           void

   drmaa2_string drmaa2_j_get_id (const drmaa2_j j)
                   drmaa2_j_get_id() - Returns newly allocated drmaa2_job id string

       Parameters:
           j - pointer to drmaa2_job structure.

       Side-Effects: none

       Returns:
           drmaa2_string - Gets the job id from drmaa2_job NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_jinfo drmaa2_j_get_info (const drmaa2_j j)
           drmaa2_j_get_info() - Gets drmaa2_job info structure from the drmaa2_job in drmaa2_j structure.

       Parameters:
           j - pointer to drmaa2_job structure.

       Side-Effects: none

       Returns:
           drmaa2_jinfo - returns drmaa2_jinfo if successful NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_jtemplate drmaa2_j_get_jt (const drmaa2_j j)
           drmaa2_j_get_jt() - Returns pointer of drmaa2_job template structure from Job.

       Parameters:
           j - pointer to drmaa2_job structure.

       Side-Effects: none

       Returns:
           drmaa2_string - gets the session name from drmaa2_session NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_string drmaa2_j_get_session_name (const drmaa2_j j)
           drmaa2_j_get_session_name() - Returns newly allocated session name string

       Parameters:
           j - pointer to drmaa2_job structure.

       Side-Effects: none

       Returns:
           drmaa2_string - gets the session name from drmaa2_session NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_jstate drmaa2_j_get_state (const drmaa2_j j, drmaa2_string * substate)
           drmaa2_j_get_state() - Gets drmaa2_job state from the drmaa2_job in drmaa2_j structure.

       Parameters:
           j - pointer to drmaa2_job structure.
           substate - state of the drmaa2_job in drmaa2_j structure

       Side-Effects: none

       Returns:
           drmaa2_jstate - returns current drmaa2_job state

   drmaa2_error drmaa2_j_hold (drmaa2_j j)
           drmaa2_j_hold() - Holds the drmaa2_job in drmaa2_j structure.

       Parameters:
           j - pointer to drmaa2_job structure.

       Side-Effects: none

       Returns:
           drmaa2_error - Returns DRMAA2_SUCCESS on success DRMAA2_INVALID_STATE if job state is invalid for hold

   drmaa2_error drmaa2_j_release (drmaa2_j j)
           drmaa2_j_release() - Releases the drmaa2_job in drmaa2_j structure.

       Parameters:
           j - pointer to drmaa2_job structure.

       Side-Effects: none

       Returns:
           drmaa2_error - Returns DRMAA2_SUCCESS on success DRMAA2_INVALID_STATE if job state is invalid for release

   drmaa2_error drmaa2_j_resume (drmaa2_j j)
           drmaa2_j_resume() - Resumes the drmaa2_job in drmaa2_j structure.

       Parameters:
           j - pointer to drmaa2_job structure.

       Side-Effects: none

       Returns:
           drmaa2_error - Returns DRMAA2_SUCCESS on success DRMAA2_INVALID_STATE if job state is invalid for resume

   drmaa2_error drmaa2_j_suspend (drmaa2_j j)
           drmaa2_j_suspend() - Suspends the drmaa2_job in drmaa2_j structure.

       Parameters:
           j - pointer to drmaa2_job structure.

       Side-Effects: none

       Returns:
           drmaa2_error - Returns DRMAA2_SUCCESS on success DRMAA2_INVALID_STATE if job state is invalid for suspend

   drmaa2_error drmaa2_j_terminate (drmaa2_j j)
           drmaa2_j_terminate() - Terminates the drmaa2_job in drmaa2_j structure.

       Parameters:
           j - pointer to drmaa2_job structure.

       Side-Effects: none

       Returns:
           drmaa2_error - Returns DRMAA2_SUCCESS on success DRMAA2_INVALID_STATE if job state is invalid for terminate

   drmaa2_error drmaa2_j_wait_started (const drmaa2_j j, const time_t timeout)
           drmaa2_j_wait_started() - Blocks till the drmaa2_job is started or till timeout expires

       Parameters:
           j - pointer to drmaa2_job structure.
           timeout - Timeout in time_t format.

       Side-Effects: none

       Returns:
           drmaa2_error - returns DRMAA2_SUCCESS if successful DRMAA2_TIMEOUT if timeout happened

   drmaa2_error drmaa2_j_wait_terminated (const drmaa2_j j, const time_t timeout)
           drmaa2_j_wait_terminated() - Blocks till the drmaa2_job is terminated or till timeout expires

       Parameters:
           j - pointer to drmaa2_job structure.
           timeout - Timeout in time_t format.

       Side-Effects: none

       Returns:
           drmaa2_error - returns DRMAA2_SUCCESS if successful DRMAA2_TIMEOUT if timeout happened

   void drmaa2_jarray_free (drmaa2_jarray * ja)
       drmaa2_jarray_free - frees the drmaa2_job array structure pointed by ja

       Parameters:
           ja - pointer to DRMAA jo array

       Side-Effects: none

       Returns:
           void

   drmaa2_string drmaa2_jarray_get_id (const drmaa2_jarray ja)
       drmaa2_jarray_get_id() Gets the id from drmaa2 drmaa2_job array.

       Parameters:
           ja - pointer to drmaa2_job array

       Side-Effects: none

       Returns:
           drmaa2_string - job id of drmaa2_job array NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_jtemplate drmaa2_jarray_get_job_template (const drmaa2_jarray ja)
       drmaa2_jarray_get_job_template - returns the drmaa2_job template used to submit the drmaa2_job array.

       Parameters:
           ja - pointer to drmaa2_job array

       Side-Effects: none

       Returns:
           drmaa2_jtemplate - returns job template from drmaa2_job array NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_j_list drmaa2_jarray_get_jobs (const drmaa2_jarray ja)
       drmaa2_jarray_get_jobs() Returns the list of jobs in the drmaa2_job array structure.

       Parameters:
           ja - Pointer to drmaa2_job array structure

       Side-Effects: none

       Returns:
           drmaa2_j_list - gets list of drmaa2_jobs from drmaa2_jarray NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_string drmaa2_jarray_get_session_name (const drmaa2_jarray ja)
       drmaa2_jarray_get_session_name - gets the session name in which the drmaa2_job array is submitted

       Parameters:
           ja - pointer to drmaa2_job array

       Side-Effects: none

       Returns:
           drmaa2_string - returns session name from drmaa2_job array NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_error drmaa2_jarray_hold (drmaa2_jarray ja)
       drmaa2_jarray_hold - holds the drmaa2_job array

       Parameters:
           ja - pointer to drmaa2_job array

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if successful drmaa2_error if fails

   drmaa2_error drmaa2_jarray_release (drmaa2_jarray ja)
       drmaa2_jarray_release - releases the drmaa2_job array

       Parameters:
           ja - pointer to drmaa2_job array

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if successful drmaa2_error if fails

   drmaa2_error drmaa2_jarray_resume (drmaa2_jarray ja)
       drmaa2_jarray_resume - resumes the drmaa2_job array

       Parameters:
           ja - pointer to drmaa2_job array

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if successful drmaa2_error if fails

   drmaa2_error drmaa2_jarray_suspend (drmaa2_jarray ja)
       drmaa2_jarray_suspend - suspends the drmaa2_job array

       Parameters:
           ja - pointer to drmaa2_job array

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if successful drmaa2_error if fails

   drmaa2_error drmaa2_jarray_terminate (drmaa2_jarray ja)
       drmaa2_jarray_terminate - terminates the drmaa2_job array

       Parameters:
           ja - pointer to drmaa2_job array

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if successful drmaa2_error if fails

   drmaa2_jinfo drmaa2_jinfo_create (void)
        drmaa2_jinfo_create() - creates a drmaa2_job info structure and returns its pointer

       Side-Effects: none

       Returns:
           drmaa2_jinfo - pointer to newly allocated drmaa2_jinfo structure NULL - if allocation fails and DRMAA2_OUT_OF_RESOURCE error is set

   void drmaa2_jinfo_free (drmaa2_jinfo * jiRef)
        drmaa2_jinfo_free() - frees the drmaa2_job info structure and its inner data types

       Parameters:
           jiRef - pointer to drmaa2_job info structure.

       Side-Effects: none

       Returns:
           void

   drmaa2_string_list drmaa2_jinfo_impl_spec (void)
       drmaa2_jinfo_impl_spec - Lists the drmaa spec implementations supported for job info (e.g. drmaa, drmaa2)

       Side-Effects: none

       Returns:
           drmaa2_string_list - list of drmaa spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

   void drmaa2_jsession_free (drmaa2_jsession * js)
       drmaa2_jsession_free Frees the memory of Job session pointed by js

       Parameters:
           js - pointer to drmaa2_jsession.

       Side-Effects: none

       Returns:
           void

   drmaa2_string drmaa2_jsession_get_contact (const drmaa2_jsession js)
       drmaa2_jsession_get_contact - Returns the DRMS name of the drmaa2_job session

       Parameters:
           js - pointer to drmaa2_job session.

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if successful drmaa2_error if fails

   drmaa2_jarray drmaa2_jsession_get_job_array (const drmaa2_jsession js, const drmaa2_string jobarrayId)
       drmaa2_jsession_get_job_array - returns the specified job array from the drmaa2_job session

       Parameters:
           js - pointer to drmaa2_job session.
           jobarrayId - Job array id which needs to be retrieved

       Side-Effects: none

       Returns:
           drmaa2_jarray - returns pointer to drmaa2_jarray with specified jobarrayId in the job session NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_string_list drmaa2_jsession_get_job_categories (const drmaa2_jsession js)
       drmaa2_jsession_get_job_categories - returns the string list of drmaa2_job categories in the drmaa2_job session

       Parameters:
           js - pointer to drmaa2_job session

       Side-Effects: none

       Returns:
           drmaa2_string_list - returns list of job categories from drmaa2_jsession NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_j_list drmaa2_jsession_get_jobs (const drmaa2_jsession js, const drmaa2_jinfo filter)
       drmaa2_jsession_get_jobs - returns list of jobs in the drmaa2_job session matching the jobinfo filter

       Parameters:
           js - pointer to drmaa2_job session js
           filter - filter for getting jobs with specific conditions

       Side-Effects: none

       Returns:
           drmaa2_j_list - returns list of jobs matching the drmaa2_job filter provided NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_string drmaa2_jsession_get_session_name (const drmaa2_jsession js)
       drmaa2_jsession_get_session_name - returns the session name from drmaa2_job session.

       Parameters:
           js - pointer to drmaa2_job session

       Side-Effects: none

       Returns:
           drmaa2_string - returns session name from drmaa2_jsession NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_jarray drmaa2_jsession_run_bulk_jobs (const drmaa2_jsession js_, const drmaa2_jtemplate jt_, unsigned long begin_index_, unsigned long end_index_, unsigned long step_, unsigned long
       max_parallel_)
       Write description of function here.

       Parameters:
           js_ - pointer to drmaa2_job session
           jt_ - Job template to be considered or used
           begin_index_ - Starting index of drmaa2_job array
           end_index_ - Ending index of drmaa2_job array
           step_ - Increment between each jobs
           max_parallel_ - Maximum parallel jobs to run

       Side-Effects: none

       Returns:
           drmaa2_jarray - returns pointer to drmaa2_jarray if successful NULL and sets last error to DRMAA2_INVALID_ARGUMENT if any argument is invalid NULL and sets last error to DRMAA2_INTERNAL
           if any internal error occurs

   drmaa2_j drmaa2_jsession_run_job (const drmaa2_jsession js_, const drmaa2_jtemplate jt_)
       drmaa2_jsession_run_job - runs job in the job session with the drmaa2_job template specified

       Parameters:
           js_ - pointer to drmaa2_job session
           jt_ - Job template that needs to be run

       Side-Effects: none

       Returns:
           drmaa2_j - returns pointer to job which is newly started in the job session NULL and sets last error to DRMAA2_INVALID_ARGUMENT if any argument is invalid NULL and sets last error to
           DRMAA2_INVALID_SESSION if session name is invalid

   drmaa2_j drmaa2_jsession_wait_any_started (const drmaa2_jsession js, const drmaa2_j_list l, const time_t timeout)
       drmaa2_jsession_wait_any_started - blocks till the drmaa2_job in the drmaa2_job session started or till the time out

       Parameters:
           js - pointer to drmaa2_job session
           l - list of drmaa2_jobs
           timeout - timeout to wait if event has not occurred

       Side-Effects: none

       Returns:
           drmaa2_j - returns pointer to drmaa2_job which started NULL and last error is set to DRMAA2_TIMEOUT if timeout happens

   drmaa2_j drmaa2_jsession_wait_any_terminated (const drmaa2_jsession js, const drmaa2_j_list l, const time_t timeout)
       drmaa2_jsession_wait_any_terminated - blocks till the drmaa2_job in the drmaa2_job session ended or till the time out

       Parameters:
           js - pointer to drmaa2_job session
           l - list of drmaa2_jobs
           timeout - timeout to wait if event has not occurs

       Side-Effects: none

       Returns:
           drmaa2_j - returns pointer to drmaa2_job which terminated NULL and last error is set to DRMAA2_TIMEOUT if timeout happens

   drmaa2_jtemplate drmaa2_jtemplate_create (void)
        drmaa2_jtemplate_create() - creates a drmaa2_job template structure and returns its pointer

       Side-Effects: none

       Returns:
           drmaa2_jtemplate - pointer to drmaa2_jtemplate if allocated NULL - if allocation fails and DRMAA2_OUT_OF_RESOURCE error is set

   void drmaa2_jtemplate_free (drmaa2_jtemplate * jtemplate)
        drmaa2_jtemplate_free() - frees a drmaa2_job template structure and its inner data types

       Parameters:
           jtemplate - pointer to drmaa2_job template structure.

       Side-Effects: none

       Returns:
           void

   drmaa2_string_list drmaa2_jtemplate_impl_spec (void)
       drmaa2_jtemplate_impl_spec - Lists the drmaa spec implementations supported for job template (e.g. drmaa, drmaa2)

       Side-Effects: none

       Returns:
           drmaa2_string_list - list of drmaa spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

   drmaa2_error drmaa2_lasterror (void)
       This function returns the last occurred error.

       Side-Effects: none

       Returns:
           drmaa2_error

   drmaa2_string drmaa2_lasterror_text (void)
       This function returns the last occurred error in string.

       Side-Effects: none

       Returns:
           drmaa2_string - newly allocated string of last error NULL - If no error text exists

   drmaa2_error drmaa2_list_add (drmaa2_list l, const void * value)
       This function adds an element to the list.

       Parameters:
           l - Pointer to drmaa list
           value - pointer to the element which needs to be inserted

       Side-Effects: none

       Returns:
           drmaa2_error - DRMAA2_INVALID_ARGUMENT

           · DRMAA2_OUT_OF_RESOURCE

           · DRMAA2_SUCCESS

   drmaa2_list drmaa2_list_create (const drmaa2_listtype t, const drmaa2_list_entryfree callback)
       This function creates a drmaa list.

       Parameters:
           t - Type of the list which needs to be created
           callback - Call back function to call when free is called.

       Side-Effects: none

       Returns:
           drmaa2_list

   drmaa2_error drmaa2_list_del (drmaa2_list l, long pos)
       This function deletes an element from the list.

       Parameters:
           l - Pointer to drmaa list
           pos - position of the element which needs to be deleted

       Side-Effects: none

       Returns:
           drmaa2_error - DRMAA2_INVALID_ARGUMENT

           · DRMAA2_SUCCESS

   void drmaa2_list_free (drmaa2_list * l)
       s This function frees a drmaa list

       Parameters:
           l - Pointer to drmaa list

       Side-Effects: none

       Returns:
           void

   const void* drmaa2_list_get (const drmaa2_list l, long index)
       This function gets the element form a particular position of the list.

       Parameters:
           l - Pointer to drmaa list
           index - postion from whcih the data has to be taken

       Side-Effects: none

       Returns:
           void* - pointer to the element retured as void* NULL - If the position is not valid

   long drmaa2_list_size (const drmaa2_list l)
       This function returns the size of the list.

       Parameters:
           l - Pointer to drmaa list

       Side-Effects: none

       Returns:
           long - size of list

   drmaa2_machineinfo drmaa2_machineinfo_create (void)
        drmaa2_machineinfo_create() - creates a drmaa2_machineinfo info structure and returns its pointer

       Side-Effects: none

       Returns:
           drmaa2_machineinfo - pointer to newly allocated drmaa2_machineinfo structure NULL - if allocation fails and DRMAA2_OUT_OF_RESOURCE error is set

   void drmaa2_machineinfo_free (drmaa2_machineinfo * miRef)
       This function frees the pre-allocated drmaa machine info structure.

       Parameters:
           miRef - Pointer to drmaa machine info

       Side-Effects: none

       Returns:
           void

   drmaa2_string_list drmaa2_machineinfo_impl_spec (void)
       drmaa2_machineinfo_impl_spec - Lists the machine info spec implementations supported

       Side-Effects: none

       Returns:
           drmaa2_string_list -list of machineinfo spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

   void drmaa2_msession_free (drmaa2_msession * ms)
   drmaa2_j_list drmaa2_msession_get_all_jobs (const drmaa2_msession ms_, const drmaa2_jinfo filter_)
       Returns the list of all jobs i.e. DRMAA2 jobs and the jobs submitted out of DRMAA2 library also. The list or number of jobs returned should adhere to DRMS policies. Ex: The list might be
       limited to contain only the jobs seen by the DRMAA2 user.

       Parameters:
           ms_ - pointer to drmaa2_msession created earlier
           filter_ - of type drmaa2_jinfo (through which we can query jobs per jobstate, job owner and per queue etc

       Side-Effects: none

       Returns:
           drmaa2_j_list if succeeds NULL if fails

   drmaa2_machineinfo_list drmaa2_msession_get_all_machines (const drmaa2_msession ms_, const drmaa2_string_list names_)
       Returns list of machines or hosts available for submitting jobs in the DRMS system.

       Parameters:
           ms_ pointer to drmaa2_msession created earlier
           names_ a list of queue names acts as filter i.e. we fetch info of only these queues.

       Side-Effects: none

       Returns:
           drmaa2_machineinfo_list if succeeds NULL if fails.

   drmaa2_queueinfo_list drmaa2_msession_get_all_queues (const drmaa2_msession ms_, const drmaa2_string_list names_)
       Returns list of queues available for submitting jobs in the DRMS system.

       Parameters:
           ms_ pointer to drmaa2_msession created earlier
           names_ a list of queue names acts as filter i.e. we fetch info of only these queues.

       Side-Effects: none

       Returns:
           drmaa2_queueinfo_list if succeeds NULL if fails.

   drmaa2_r_list drmaa2_msession_get_all_reservations (const drmaa2_msession ms_)
       Returns the list of all advance reservations visible for the user running the DRMAA-based application. The list or number of jobs returned should adhere to DRMS policies. Ex: The list might
       be limited to contain only the reservations seen by the DRMAA2 user.

       Parameters:
           ms_ pointer to drmaa2_msession created earlier

       Side-Effects: none

       Returns:
           drmaa2_j_list if succeeds NULL if fails

   void drmaa2_notification_free (drmaa2_notification * nRef)
       This function frees the pre-allocated drmaa notification structure.

       Parameters:
           nRef - Pointer to drmaa notification

       Side-Effects: none

       Returns:
           void

   drmaa2_string_list drmaa2_notification_impl_spec (void)
       drmaa2_notification_impl_spec - Lists the notification spec implementations supported

       Side-Effects: none

       Returns:
           drmaa2_string_list - list of notification spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

   drmaa2_jsession drmaa2_open_jsession (const char * session_name_)
       drmaa2_open_jsession - Opens an already existing drmaa2_job session

       Parameters:
           session_name_ - Session name of the drmaa2_job session which needs to be opened

       Side-Effects: none

       Returns:
           drmaa2_jsession - returns pointer to drmaa2_jsession for a session which is already present NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_msession drmaa2_open_msession (const char * contact_)
       Opens the monitoring session.

       Parameters:
           contact_ - Contact of the session

       Side-Effects: none

       Returns:
           drmaa2_msession if the session exists NULL if the session does not exist and if session name is invalid and also sets drmaa2_lasterror_v to DRMAA2_INVALID_ARGUMENT error

   drmaa2_rsession drmaa2_open_rsession (const char * session_name_)
       Opens the previously created session.

       Parameters:
           session_name_ - Name of the session.

       Side-Effects: none

       Returns:
           drmaa2_rsession if a session exists NULL if sets drmaa2_lasterror_v to DRMAA2_INVALID_ARGUMENT error.

   drmaa2_queueinfo drmaa2_queueinfo_create (void)
        drmaa2_queueinfo_create() - creates a drmaa2_queueinfo structure and returns its pointer

       Side-Effects: none

       Returns:
           drmaa2_queueinfo - pointer to newly allocated drmaa2_queueinfo structure NULL - if allocation fails and DRMAA2_OUT_OF_RESOURCE error is set

   void drmaa2_queueinfo_free (drmaa2_queueinfo * qiRef)
       This function frees the pre-allocated drmaa queueinfo structure.

       Parameters:
           qiRef - Pointer to drmaa queueinfo

       Side-Effects: none

       Returns:
           void

   drmaa2_string_list drmaa2_queueinfo_impl_spec (void)
       drmaa2_queueinfo_impl_spec - Lists the queue info spec implementations supported

       Side-Effects: none

       Returns:
           drmaa2_string_list -list of queueinfo spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

   void drmaa2_r_free (drmaa2_r * r)
   drmaa2_string drmaa2_r_get_id (const drmaa2_r r)
       Get the reservation id from a given reservation object.

       Parameters:
           r - given reservation object

       Side-Effects: none

       Returns:
           drmaa2_string

       Return values:
           - reservation id

   drmaa2_rinfo drmaa2_r_get_info (const drmaa2_r r)
       Get the reservation info from a given reservation object.

       Parameters:
           r - given reservation object

       Side-Effects: none

       Returns:
           drmaa2_rinfo - reservation info object NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_rtemplate drmaa2_r_get_reservation_template (const drmaa2_r r)
       Get the reservation template from a given reservation object.

       Parameters:
           r - given reservation object

       Side-Effects: none

       Returns:
           drmaa2_rtemplate- - reservation template NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_string drmaa2_r_get_session_name (const drmaa2_r r)
       Get the reservation session name from a given reservation object.

       Parameters:
           r - given reservation object

       Side-Effects: none

       Returns:
           drmaa2_string - reservation session name NULL - if fails and DRMAA2_INVALID_ARGUMENT error is set

   drmaa2_error drmaa2_r_terminate (drmaa2_r r)
       Terminate a given reservation.

       Parameters:
           r - given reservation object

       Side-Effects: none

       Returns:
           drmaa2_error - on success DRMAA2_SUCCESS DRMAA2_DENIED_BY_DRMS if failed

   drmaa2_error drmaa2_register_event_notification (const drmaa2_callback callback)
       Registers a drmaa2_callback with the DRMS library. For the first phase of implementation we do not support this.

       Parameters:
           callback - a structure of type drmaa2_callback containing the details of callback function, event etc

       Side-Effects: none

       Returns:
           DRMAA2_SUCCESS if succeeds DRMAA2_UNSUPPORTED_OPERATION error if fails

   drmaa2_rinfo drmaa2_rinfo_create (void)
        drmaa2_rinfo_create() - creates a drmaa2_reservation info structure and returns its pointer

       Side-Effects: none

       Returns:
           drmaa2_rinfo - pointer to newly allocated drmaa2_rinfo structure NULL - if allocation fails and DRMAA2_OUT_OF_RESOURCE error is set

   void drmaa2_rinfo_free (drmaa2_rinfo * riRef)
       This function frees the pre-allocated drmaa rinfo structure.

       Parameters:
           riRef - Pointer to drmaa reservation info

       Side-Effects: none

       Returns:
           void

   drmaa2_string_list drmaa2_rinfo_impl_spec (void)
       Lists the drmaa spec implementations supported for reservation info (e.g. drmaa, drmaa2)

       Side-Effects: none

       Returns:
           drmaa2_string_list - list of drmaa spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

   void drmaa2_rsession_free (drmaa2_rsession * rs)
       drmaa2_rsession_free Frees the memory of Reservation session pointed by rs

       Parameters:
           rs - pointer to drmaa2_rsession.

       Side-Effects: none

       Returns:
           void

   drmaa2_string drmaa2_rsession_get_contact (const drmaa2_rsession rs)
       Get the contact of a given drmaa2 reservation session.

       Parameters:
           rs - given reservation session

       Side-Effects: none

       Returns:
           drmaa2_string - contact name associated with reservation session NULL - if reservation session is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_SESSION

   drmaa2_r drmaa2_rsession_get_reservation (const drmaa2_rsession rs, const drmaa2_string reservationId)
       Get the reservation object from a specific reservation session with the given reservation id.

       Parameters:
           rs - given reservation session
           reservationId - given reservation id

       Side-Effects: none

       Returns:
           drmaa2_r- reservation NULL - if reservation session is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_SESSION

           · if reservation id is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_ARGUMENT

   drmaa2_r_list drmaa2_rsession_get_reservations (const drmaa2_rsession rs_)
       Get all the reservation objects from a specific reservation session.

       Parameters:
           rs_ - given reservation session

       Side-Effects: none

       Returns:
           drmaa2_r_list - reservation interface list NULL - if reservation session is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_SESSION

   drmaa2_string drmaa2_rsession_get_session_name (const drmaa2_rsession rs)
       Get the session name of a given drmaa2 reservation session.

       Parameters:
           rs - given reservation session

       Side-Effects: none

       Returns:
           drmaa2_string - session name associated with reservation session NULL - if reservation session is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_SESSION

   drmaa2_r drmaa2_rsession_request_reservation (const drmaa2_rsession rs, const drmaa2_rtemplate rt_)
       Creates a reservation object in a specific reservation session with the given reservation template. it also evaluates reservation template for the mandatory attributes and sends the request
       to DRMS.

       Parameters:
           rs - given reservation session
           rt_ - given reservation template

       Side-Effects: none

       Returns:
           drmaa2_r- reservation NULL - if reservation session is invalid, drmaa2_lasterror_v set to DRMAA2_INVALID_SESSION

           · if reservation template evaluation fails, drmaa2_lasterror_v set to DRMAA2_UNSUPPORTED_ATTRIBUTE

       · if DRMS rejects reservation request, drmaa2_lasterror_v set to DRMAA2_DENIED_BY_DRMS

   drmaa2_rtemplate drmaa2_rtemplate_create (void)
       This function frees the pre-allocated drmaa rtemplate structure.

       Side-Effects: none

       Returns:
           drmaa2_rtemplate

   void drmaa2_rtemplate_free (drmaa2_rtemplate * rt)
       This function frees the pre-allocated drmaa rtemplate structure.

       Parameters:
           rt - Pointer to drmaa rtemplate

       Side-Effects: none

       Returns:
           void

   drmaa2_string_list drmaa2_rtemplate_impl_spec (void)
       Lists the drmaa spec implementations supported for reservation template (e.g. drmaa, drmaa2)

       Side-Effects: none

       Returns:
           drmaa2_string_list - list of drmaa spec implementations supported NULL - If this feature is not supported, set drmaa2_lasterror_v to DRMAA2_UNSUPPORTED_OPERATION

   drmaa2_error drmaa2_set_instance_value (void * instance, const char * name, const char * value)
   void drmaa2_slotinfo_free (drmaa2_slotinfo * siRef)
       This function frees the pre-allocated drmaa slotinfo.

       Parameters:
           siRef - Pointer to drmaa slotinfo

       Side-Effects: none

       Returns:
           void

   void drmaa2_string_free (drmaa2_string * str)
       This function frees the previously allocated drmaa2_string.

       Parameters:
           str - pointer to pre allocated drmaa2_string

       Side-Effects: none

       Returns:
           void

   drmaa2_bool drmaa2_supports (const drmaa2_capability c)
       drmaa2_supports - returns true if drmaa supports the provided drmaa2_capability

       Parameters:
           c - drmaa2_capability enum value

       Side-Effects: none

       Returns:
           drmaa2_version

   void drmaa2_version_free (drmaa2_version * vRef)
       This function frees the pre-allocated drmaa version structure.

       Parameters:
           vRef - Pointer to drmaa version

       Side-Effects: none

       Returns:
           void

Questions

Question	Outcome

Not Doing

References

sessionManager.getDrmaaName()