cctools
batch_job.h
Go to the documentation of this file.
1 /*
2 Copyright (C) 2003-2004 Douglas Thain and the University of Wisconsin
3 Copyright (C) 2005- The University of Notre Dame
4 This software is distributed under the GNU General Public License.
5 See the file COPYING for details.
6 */
7 
8 #ifndef BATCH_JOB_H
9 #define BATCH_JOB_H
10 
11 #include <sys/stat.h>
12 
13 #include <inttypes.h>
14 #include <stdint.h>
15 #include <time.h>
16 
17 #include "jx.h"
18 #include "rmsummary.h"
19 
28 typedef int64_t batch_job_id_t;
29 #define PRIbjid PRId64
30 #define SCNbjid SCNd64
31 
33 /* Must be kept in sync with batch_job_subsystems. */
34 typedef enum {
53  BATCH_QUEUE_TYPE_MPI,
56 
59  time_t submitted;
60  time_t started;
61  time_t finished;
62  time_t heartbeat;
64  int exit_code;
67  long log_pos;
68 };
69 
74 
78 void batch_job_info_delete(struct batch_job_info *info);
79 
85 
96 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);
97 
109 
122 batch_job_id_t batch_job_wait_timeout(struct batch_queue *q, struct batch_job_info *info, time_t stoptime);
123 
131 int batch_job_remove(struct batch_queue *q, batch_job_id_t jobid);
132 
133 int batch_fs_chdir (struct batch_queue *q, const char *path);
134 int batch_fs_getcwd (struct batch_queue *q, char *buf, size_t size);
135 int batch_fs_mkdir (struct batch_queue *q, const char *path, mode_t mode, int recursive);
136 int batch_fs_putfile (struct batch_queue *q, const char *lpath, const char *rpath);
137 int batch_fs_rename (struct batch_queue *q, const char *lpath, const char *rpath);
138 int batch_fs_stat (struct batch_queue *q, const char *path, struct stat *buf);
139 int batch_fs_unlink (struct batch_queue *q, const char *path);
140 
146 
152 
159 void batch_queue_set_logfile(struct batch_queue *q, const char *logfile);
160 
173 void batch_queue_set_option(struct batch_queue *q, const char *what, const char *value);
174 
183 void batch_queue_set_feature(struct batch_queue *q, const char *what, const char *value);
184 
190 void batch_queue_set_int_option(struct batch_queue *q, const char *what, int value);
191 
199 const char *batch_queue_get_option(struct batch_queue *q, const char *what);
200 
206 int batch_queue_option_is_yes (struct batch_queue *q, const char *what);
207 
215 const char *batch_queue_supports_feature (struct batch_queue *q, const char *what);
216 
217 
224 
232 void batch_queue_delete(struct batch_queue *q);
233 
238 const char *batch_queue_type_string();
239 
244 int batch_queue_port(struct batch_queue *q);
245 
246 /* Hack: provide a backdoor to allow the MPI module to perform
247  some initial setup before the MPI batch queue is created.
248 */
249 void batch_job_mpi_setup( const char *debug_filename, int mpi_cores, int mpi_memory );
250 
251 #endif
struct batch_job_info * batch_job_info_create()
Create a new batch_job_info struct.
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)
Submit a batch job.
batch_queue_type_t batch_queue_type_from_string(const char *str)
Converts a string into a batch queue type.
void batch_queue_delete(struct batch_queue *q)
Delete a batch queue.
int batch_job_remove(struct batch_queue *q, batch_job_id_t jobid)
Remove a batch job.
struct batch_queue * batch_queue_create(batch_queue_type_t type)
Create a new batch queue.
batch_job_id_t batch_job_wait_timeout(struct batch_queue *q, struct batch_job_info *info, time_t stoptime)
Wait for any batch job to complete, with a timeout.
batch_queue_type_t batch_queue_get_type(struct batch_queue *q)
Get batch queue type.
int64_t batch_job_id_t
An integer type indicating a unique batch job number.
Definition: batch_job.h:28
Batch jobs will be send to the SLURM Scheduler.
Definition: batch_job.h:46
Batch jobs will be sent to the Work Queue.
Definition: batch_job.h:48
time_t started
Time the job actually began executing.
Definition: batch_job.h:60
Batch jobs will be sent spun up Amazon ec2 instances.
Definition: batch_job.h:37
Batch jobs will be sent to Chirp.
Definition: batch_job.h:49
Batch jobs will be sent to the Moab Workload Manager.
Definition: batch_job.h:41
void batch_queue_set_option(struct batch_queue *q, const char *what, const char *value)
Add extra options to pass to the underlying batch system.
void batch_queue_set_feature(struct batch_queue *q, const char *what, const char *value)
Expresses support for feature in the underlying batch system.
Batch jobs will be sent to Sun Grid Engine.
Definition: batch_job.h:40
int exit_code
The result code of the job, if it exited normally.
Definition: batch_job.h:64
void batch_queue_set_int_option(struct batch_queue *q, const char *what, int value)
As batch_queue_set_option, but allowing an integer argument.
const char * batch_queue_type_to_string(batch_queue_type_t t)
Converts a batch queue type to a string.
void batch_queue_set_logfile(struct batch_queue *q, const char *logfile)
Set the log file used by the batch queue.
batch_queue_type_t
Indicates which type of batch submission to use.
Definition: batch_job.h:34
time_t heartbeat
Time the job last wrote heartbeat.
Definition: batch_job.h:62
const char * batch_queue_supports_feature(struct batch_queue *q, const char *what)
Get batch queue feature.
long log_pos
Last read position in the log file, for ftell and fseek.
Definition: batch_job.h:67
time_t finished
Time at which the job actually completed.
Definition: batch_job.h:61
int batch_queue_option_is_yes(struct batch_queue *q, const char *what)
Check if option is set to yes.
batch_job_id_t batch_job_wait(struct batch_queue *q, struct batch_job_info *info)
Wait for any batch job to complete.
int exit_signal
The signal by which the job was killed, if it exited abnormally.
Definition: batch_job.h:65
JSON Expressions (JX) library.
Batch jobs will be sent to a user-defined cluster manager.
Definition: batch_job.h:47
time_t submitted
Time the job was submitted to the system.
Definition: batch_job.h:59
const char * batch_queue_type_string()
Returns the list of queue types supported by this module.
Batch jobs will be sent to Mesos.
Definition: batch_job.h:50
An invalid batch queue type.
Definition: batch_job.h:54
Definition: rmsummary.h:26
Definition: batch_job_internal.h:50
Batch jobs will be sent to LSF.
Definition: batch_job.h:43
Batch jobs will be executed by an Amazon Lambda function with S3 objects.
Definition: batch_job.h:38
const char * batch_queue_get_option(struct batch_queue *q, const char *what)
Get batch queue options.
void batch_job_info_delete(struct batch_job_info *info)
Delete a batch_job_info struct.
JX value representing any expression type.
Definition: jx.h:115
Batch jobs will be send to the Torque Scheduler at Blue Waters.
Definition: batch_job.h:45
Batch jobs will not actually run.
Definition: batch_job.h:52
int disk_allocation_exhausted
Non-zero if the job filled its loop device allocation to capacity, zero otherwise.
Definition: batch_job.h:66
Batch jobs will be sent to Amazon Batch System.
Definition: batch_job.h:39
Batch jobs will be sent to Condor pool.
Definition: batch_job.h:36
int batch_queue_port(struct batch_queue *q)
Returns the port number of the batch queue.
Describes a batch job when it has completed.
Definition: batch_job.h:58
int exited_normally
Non-zero if the job ran to completion, zero otherwise.
Definition: batch_job.h:63
Batch jobs will run as local processes.
Definition: batch_job.h:35
Batch jobs will be send to the Torque Scheduler.
Definition: batch_job.h:44
Batch jobs will be sent to kubernetes.
Definition: batch_job.h:51
Batch jobs will be send to the PBS Scheduler.
Definition: batch_job.h:42