batch_job.h

Go to the documentation of this file.

/*
Copyright (C) 2003-2004 Douglas Thain and the University of Wisconsin
Copyright (C) 2005- The University of Notre Dame
This software is distributed under the GNU General Public License.
See the file COPYING for details.
*/

#ifndef BATCH_JOB_H
#define BATCH_JOB_H

#include <sys/stat.h>

#include <inttypes.h>
#include <stdint.h>
#include <time.h>

#include "jx.h"
#include "rmsummary.h"

typedef int64_t batch_job_id_t;
#define PRIbjid  PRId64
#define SCNbjid  SCNd64

/* Must be kept in sync with batch_job_subsystems. */
typedef enum {
        BATCH_QUEUE_TYPE_LOCAL,               
        BATCH_QUEUE_TYPE_CONDOR,              
        BATCH_QUEUE_TYPE_AMAZON,              
        BATCH_QUEUE_TYPE_LAMBDA,              
        BATCH_QUEUE_TYPE_AMAZON_BATCH,        
        BATCH_QUEUE_TYPE_SGE,                 
        BATCH_QUEUE_TYPE_MOAB,                
        BATCH_QUEUE_TYPE_PBS,                 
        BATCH_QUEUE_TYPE_LSF,                 
        BATCH_QUEUE_TYPE_TORQUE,              
        BATCH_QUEUE_TYPE_BLUE_WATERS,         
        BATCH_QUEUE_TYPE_SLURM,               
        BATCH_QUEUE_TYPE_CLUSTER,             
        BATCH_QUEUE_TYPE_WORK_QUEUE,          
        BATCH_QUEUE_TYPE_CHIRP,               
        BATCH_QUEUE_TYPE_MESOS,               
        BATCH_QUEUE_TYPE_K8S,                 
        BATCH_QUEUE_TYPE_DRYRUN,              
        BATCH_QUEUE_TYPE_MPI,
        BATCH_QUEUE_TYPE_UNKNOWN = -1         
} batch_queue_type_t;

struct batch_job_info {
        time_t submitted;    
        time_t started;      
        time_t finished;     
        time_t heartbeat;    
        int exited_normally; 
        int exit_code;       
        int exit_signal;     
        int disk_allocation_exhausted; 
        long log_pos;        
};

struct batch_job_info *batch_job_info_create();

void batch_job_info_delete(struct batch_job_info *info);

struct batch_queue *batch_queue_create(batch_queue_type_t type);

batch_job_id_t batch_job_submit(struct batch_queue *q, const char *cmdline, const char *input_files, const char *output_files, struct jx *envlist, const struct rmsummary *resources);

batch_job_id_t batch_job_wait(struct batch_queue *q, struct batch_job_info *info);

batch_job_id_t batch_job_wait_timeout(struct batch_queue *q, struct batch_job_info *info, time_t stoptime);

int batch_job_remove(struct batch_queue *q, batch_job_id_t jobid);

int batch_fs_chdir (struct batch_queue *q, const char *path);
int batch_fs_getcwd (struct batch_queue *q, char *buf, size_t size);
int batch_fs_mkdir (struct batch_queue *q, const char *path, mode_t mode, int recursive);
int batch_fs_putfile (struct batch_queue *q, const char *lpath, const char *rpath);
int batch_fs_rename (struct batch_queue *q, const char *lpath, const char *rpath);
int batch_fs_stat (struct batch_queue *q, const char *path, struct stat *buf);
int batch_fs_unlink (struct batch_queue *q, const char *path);

batch_queue_type_t batch_queue_type_from_string(const char *str);

const char *batch_queue_type_to_string(batch_queue_type_t t);

void batch_queue_set_logfile(struct batch_queue *q, const char *logfile);

void batch_queue_set_option(struct batch_queue *q, const char *what, const char *value);

void batch_queue_set_feature(struct batch_queue *q, const char *what, const char *value);

void batch_queue_set_int_option(struct batch_queue *q, const char *what, int value);

const char *batch_queue_get_option(struct batch_queue *q, const char *what);

int batch_queue_option_is_yes (struct batch_queue *q, const char *what);

const char *batch_queue_supports_feature (struct batch_queue *q, const char *what);


batch_queue_type_t batch_queue_get_type(struct batch_queue *q);

void batch_queue_delete(struct batch_queue *q);

const char *batch_queue_type_string();

int batch_queue_port(struct batch_queue *q);

/* Hack: provide a backdoor to allow the MPI module to perform
   some initial setup before the MPI batch queue is created.
*/
void batch_job_mpi_setup( const char *debug_filename, int mpi_cores, int mpi_memory );

#endif