25#define WORK_QUEUE_DEFAULT_PORT 9123
26#define WORK_QUEUE_RANDOM_PORT 0
28#define WORK_QUEUE_WAITFORTASK -1
30#define WORK_QUEUE_DEFAULT_KEEPALIVE_INTERVAL 120
31#define WORK_QUEUE_DEFAULT_KEEPALIVE_TIMEOUT 30
56 WORK_QUEUE_SCHEDULE_UNSET = 0,
1195#define WORK_QUEUE_TASK_ORDER_FIFO 0
1196#define WORK_QUEUE_TASK_ORDER_LIFO 1
1207#define WORK_QUEUE_MANAGER_MODE_STANDALONE 0
1208#define WORK_QUEUE_MANAGER_MODE_CATALOG 1
1288#define work_queue_master_preferred_connection work_queue_manager_preferred_connection
1289#define work_queue_specify_master_mode work_queue_specify_manager_mode
1290#define work_queue_blacklist_add work_queue_block_host
1291#define work_queue_blacklist_add_with_timeout work_queue_block_host_with_timeout
1292#define work_queue_blacklist_remove work_queue_unblock_host
1293#define work_queue_blacklist_clear work_queue_unblock_all
Implements bookkeeping for categories of tasks and their resources.
category_allocation_t
Valid states for the lifetime of automatic resource allocations for a single task.
Definition category.h:22
@ CATEGORY_ALLOCATION_MODE_MIN_WASTE
As above, but tasks are first tried with an automatically computed allocation to minimize resource wa...
Definition category.h:55
@ CATEGORY_ALLOCATION_MODE_FIXED
When monitoring is disabled, all tasks run as WORK_QUEUE_ALLOCATION_MODE_FIXED.
Definition category.h:36
@ CATEGORY_ALLOCATION_MODE_GREEDY_BUCKETING
Use the greedy bucketing algorithm to label resources.
Definition category.h:61
@ CATEGORY_ALLOCATION_MODE_EXHAUSTIVE_BUCKETING
Use the exhaustive bucketing algorithm to label resources.
Definition category.h:64
@ CATEGORY_ALLOCATION_MODE_MAX_THROUGHPUT
As above, but maximizing throughput.
Definition category.h:59
@ CATEGORY_ALLOCATION_MODE_MAX
When monitoring is enabled, tasks are tried with maximum specified values of cores,...
Definition category.h:43
Definition rmsummary.h:27
Statistics describing a work queue.
Definition work_queue.h:226
double efficiency
Definition work_queue.h:342
int total_workers_idled_out
Definition work_queue.h:318
int64_t max_cores
The highest number of cores observed among the connected workers.
Definition work_queue.h:298
int64_t total_memory
Total memory in MB aggregated across the connected workers.
Definition work_queue.h:291
double bandwidth
Average network bandwidth in MB/S observed by the manager when transferring to workers.
Definition work_queue.h:279
int tasks_submitted
Total number of tasks submitted to the queue.
Definition work_queue.h:250
timestamp_t time_application
Total time spent outside work_queue_wait.
Definition work_queue.h:269
int capacity_tasks
The estimated number of tasks that this manager can effectively support.
Definition work_queue.h:282
int total_exhausted_attempts
Definition work_queue.h:327
int total_tasks_failed
Definition work_queue.h:325
int workers_idle
Number of workers that are not running a task.
Definition work_queue.h:230
int capacity_gpus
The estimated number of workers' GPUs that this manager can effectively support.
Definition work_queue.h:286
int64_t total_bytes_received
Definition work_queue.h:338
timestamp_t time_send
Total time spent in sending tasks to workers (tasks descriptions, and input files....
Definition work_queue.h:262
int tasks_cancelled
Total number of tasks cancelled.
Definition work_queue.h:254
timestamp_t time_workers_execute_good
Total time workers spent executing done tasks with result WQ_RESULT_SUCCESS.
Definition work_queue.h:273
int workers_connected
Number of workers currently connected to the manager.
Definition work_queue.h:228
int workers_fast_aborted
Total number of worker connections terminated for being too slow.
Definition work_queue.h:239
timestamp_t total_exhausted_execute_time
Definition work_queue.h:335
int workers_init
Number of workers connected, but that have not send their available resources report yet.
Definition work_queue.h:229
int64_t committed_memory
Committed memory in MB aggregated across the connected workers.
Definition work_queue.h:295
int capacity_cores
The estimated number of workers' cores that this manager can effectively support.
Definition work_queue.h:283
int64_t max_disk
The largest disk space in MB observed among the connected workers.
Definition work_queue.h:300
int total_tasks_complete
Definition work_queue.h:324
int total_workers_removed
Definition work_queue.h:316
int capacity_memory
The estimated number of workers' MB of RAM that this manager can effectively support.
Definition work_queue.h:284
int64_t total_disk
Total disk space in MB aggregated across the connected workers.
Definition work_queue.h:292
int workers_able
Number of workers on which the largest task can run.
Definition work_queue.h:232
int64_t total_cores
Total number of cores aggregated across the connected workers.
Definition work_queue.h:290
double capacity
Definition work_queue.h:340
int64_t max_memory
The largest memory size in MB observed among the connected workers.
Definition work_queue.h:299
int64_t min_cores
The lowest number of cores observed among the connected workers.
Definition work_queue.h:302
timestamp_t start_time
Definition work_queue.h:328
timestamp_t time_internal
Total time the queue spents in internal processing.
Definition work_queue.h:267
double manager_load
In the range of [0,1].
Definition work_queue.h:306
timestamp_t time_receive
Total time spent in receiving results from workers (output files.).
Definition work_queue.h:263
int capacity_instantaneous
The estimated number of tasks that this manager can support considering only the most recently comple...
Definition work_queue.h:287
int workers_blocked
Total number of workers blocked by the manager.
Definition work_queue.h:240
int avg_capacity
Definition work_queue.h:355
int64_t min_gpus
Definition work_queue.h:348
int tasks_dispatched
Total number of tasks dispatch to workers.
Definition work_queue.h:251
int tasks_running
Number of tasks currently executing at some worker.
Definition work_queue.h:246
int workers_removed
Total number of worker connections that were released by the manager, idled-out, fast-aborted,...
Definition work_queue.h:236
timestamp_t total_good_transfer_time
Definition work_queue.h:331
int64_t bytes_sent
Total number of file bytes (not including protocol control msg bytes) sent out to the workers by the ...
Definition work_queue.h:277
timestamp_t total_good_execute_time
Definition work_queue.h:334
int workers_ready
Definition work_queue.h:352
int total_workers_joined
Definition work_queue.h:315
int tasks_exhausted_attempts
Total number of task executions that failed given resource exhaustion.
Definition work_queue.h:255
int workers_idled_out
Total number of worker that disconnected for being idle.
Definition work_queue.h:238
timestamp_t time_status_msgs
Total time spent sending and receiving status messages to and from workers, including workers' standa...
Definition work_queue.h:266
int tasks_waiting
Number of tasks waiting to be dispatched.
Definition work_queue.h:244
int port
Definition work_queue.h:350
int workers_full
Definition work_queue.h:353
int tasks_done
Total number of tasks completed and returned to user.
Definition work_queue.h:252
double idle_percentage
Definition work_queue.h:343
int tasks_on_workers
Number of tasks currently dispatched to some worker.
Definition work_queue.h:245
int capacity_weighted
The estimated number of tasks that this manager can support placing greater weight on the most recent...
Definition work_queue.h:288
timestamp_t total_receive_time
Definition work_queue.h:330
int workers_busy
Number of workers that are running at least one task.
Definition work_queue.h:231
int64_t committed_cores
Committed number of cores aggregated across the connected workers.
Definition work_queue.h:294
int workers_blacklisted
Definition work_queue.h:356
timestamp_t time_workers_execute
Total time workers spent executing done tasks.
Definition work_queue.h:272
int64_t min_disk
The smallest disk space in MB observed among the connected workers.
Definition work_queue.h:304
int workers_joined
Total number of worker connections that were established to the manager.
Definition work_queue.h:235
timestamp_t time_send_good
Total time spent in sending data to workers for tasks with result WQ_RESULT_SUCCESS.
Definition work_queue.h:264
int total_tasks_cancelled
Definition work_queue.h:326
timestamp_t time_polling
Total time blocking waiting for worker communications (i.e., manager idle waiting for a worker messag...
Definition work_queue.h:268
int priority
Definition work_queue.h:351
int tasks_failed
Total number of tasks completed and returned to user with result other than WQ_RESULT_SUCCESS.
Definition work_queue.h:253
int64_t max_gpus
Definition work_queue.h:347
timestamp_t time_receive_good
Total time spent in sending data to workers for tasks with result WQ_RESULT_SUCCESS.
Definition work_queue.h:265
int total_workers_connected
Definition work_queue.h:314
int64_t committed_gpus
Definition work_queue.h:346
int workers_released
Total number of worker connections that were asked by the manager to disconnect.
Definition work_queue.h:237
int64_t total_gpus
Definition work_queue.h:345
int64_t bytes_received
Total number of file bytes (not including protocol control msg bytes) received from the workers by th...
Definition work_queue.h:278
int capacity_disk
The estimated number of workers' MB of disk that this manager can effectively support.
Definition work_queue.h:285
int total_workers_lost
Definition work_queue.h:317
int total_tasks_dispatched
Definition work_queue.h:323
int total_worker_slots
Definition work_queue.h:354
int64_t min_memory
The smallest memory size in MB observed among the connected workers.
Definition work_queue.h:303
timestamp_t time_workers_execute_exhaustion
Total time workers spent executing tasks that exhausted resources.
Definition work_queue.h:274
int tasks_complete
Definition work_queue.h:321
int64_t total_bytes_sent
Definition work_queue.h:337
int total_workers_fast_aborted
Definition work_queue.h:319
timestamp_t total_send_time
Definition work_queue.h:329
int64_t committed_disk
Committed disk space in MB aggregated across the connected workers.
Definition work_queue.h:296
int workers_lost
Total number of worker connections that were unexpectedly lost.
Definition work_queue.h:241
int tasks_with_results
Number of tasks with retrieved results and waiting to be returned to user.
Definition work_queue.h:247
timestamp_t time_when_started
Absolute time at which the manager started.
Definition work_queue.h:261
timestamp_t total_execute_time
Definition work_queue.h:333
A task description.
Definition work_queue.h:135
timestamp_t time_when_retrieval
The time when output files start to be transfered back to the manager.
Definition work_queue.h:174
int64_t bytes_received
Number of bytes received since task has last started receiving input data.
Definition work_queue.h:181
struct list * env_list
Environment variables applied to the task.
Definition work_queue.h:142
int fast_abort_count
Number of times this task has been terminated for running too long.
Definition work_queue.h:159
timestamp_t time_app_delay
Definition work_queue.h:221
char * tag
An optional user-defined logical name for the task.
Definition work_queue.h:136
timestamp_t time_when_submitted
The time at which this task was added to the queue.
Definition work_queue.h:163
category_allocation_t resource_request
See category_allocation_t.
Definition work_queue.h:152
int try_count
The number of times the task has been dispatched to a worker.
Definition work_queue.h:157
timestamp_t time_workers_execute_last
Duration of the last complete execution for this task.
Definition work_queue.h:176
timestamp_t time_send_input_finish
Definition work_queue.h:201
timestamp_t time_committed
Definition work_queue.h:198
struct list * features
User-defined features this task requires.
Definition work_queue.h:191
char * monitor_output_directory
Custom output directory for the monitoring output files.
Definition work_queue.h:188
int max_retries
Number of times the task is tried to be executed on some workers until success.
Definition work_queue.h:155
timestamp_t time_receive_output_finish
Definition work_queue.h:205
timestamp_t total_cmd_execution_time
Definition work_queue.h:213
timestamp_t time_when_commit_end
The time when the task is completely transfered to a worker.
Definition work_queue.h:172
timestamp_t total_time_until_worker_failure
Definition work_queue.h:215
char * coprocess
The name of the coprocess name in the worker that executes this task.
Definition work_queue.h:149
struct list * output_files
The output files (other than the standard output stream) created by the program to be retrieved from ...
Definition work_queue.h:141
char * output
The standard output of the task.
Definition work_queue.h:139
int exhausted_attempts
Number of times the task failed given exhausted resources.
Definition work_queue.h:158
struct rmsummary * resources_requested
Number of cores, disk, memory, time, etc.
Definition work_queue.h:187
char * monitor_snapshot_file
Filename the monitor checks to produce snapshots.
Definition work_queue.h:190
timestamp_t time_receive_result_start
Definition work_queue.h:202
timestamp_t time_execute_cmd_start
Definition work_queue.h:207
char * command_line
The program(s) to execute, as a shell command line.
Definition work_queue.h:137
char * host
The address and port of the host on which it ran.
Definition work_queue.h:146
struct rmsummary * resources_measured
When monitoring is enabled, it points to the measured resources used by the task in its latest attemp...
Definition work_queue.h:186
double priority
The priority of this task relative to others in the queue: higher number run earlier.
Definition work_queue.h:154
timestamp_t time_task_finish
Definition work_queue.h:197
int64_t total_bytes_sent
Definition work_queue.h:218
int disk_allocation_exhausted
Non-zero if a task filled its loop device allocation, zero otherwise.
Definition work_queue.h:166
timestamp_t time_receive_result_finish
Definition work_queue.h:203
timestamp_t time_workers_execute_failure
Accumulated time for runs that terminated in worker failure/disconnection.
Definition work_queue.h:179
timestamp_t time_workers_execute_all
Accumulated time for executing the command on any worker, regardless of whether the task completed (i...
Definition work_queue.h:177
timestamp_t time_workers_execute_exhaustion
Accumulated time spent in attempts that exhausted resources.
Definition work_queue.h:178
timestamp_t total_cmd_exhausted_execute_time
Definition work_queue.h:214
timestamp_t time_when_done
The time at which the task is mark as retrieved, after transfering output files and other final proce...
Definition work_queue.h:164
int64_t bytes_transferred
Number of bytes transferred since task has last started transferring input data.
Definition work_queue.h:183
timestamp_t time_send_input_start
Definition work_queue.h:200
char * category
User-provided label for the task.
Definition work_queue.h:151
timestamp_t cmd_execution_time
Definition work_queue.h:212
int64_t total_bytes_received
Definition work_queue.h:217
timestamp_t time_task_submit
Definition work_queue.h:196
timestamp_t time_receive_output_start
Definition work_queue.h:204
int64_t total_bytes_transferred
Definition work_queue.h:219
struct list * input_files
The files to transfer to the worker and place in the executing directory.
Definition work_queue.h:140
int64_t bytes_sent
Number of bytes sent since task has last started sending input data.
Definition work_queue.h:182
int taskid
A unique task id number.
Definition work_queue.h:143
struct rmsummary * resources_allocated
Resources allocated to the task its latest attempt.
Definition work_queue.h:185
int return_status
The exit code of the command line.
Definition work_queue.h:144
work_queue_schedule_t worker_selection_algorithm
How to choose worker to run the task.
Definition work_queue.h:138
timestamp_t time_execute_cmd_finish
Definition work_queue.h:208
char * hostname
The name of the host on which it ran.
Definition work_queue.h:147
int64_t min_running_time
Minimum time (in seconds) the task needs to run.
Definition work_queue.h:168
timestamp_t total_transfer_time
Definition work_queue.h:210
work_queue_result_t result
The result of the task (see work_queue_result_t.
Definition work_queue.h:145
timestamp_t time_when_commit_start
The time when the task starts to be transfered to a worker.
Definition work_queue.h:171
Portable routines for high resolution timing.
UINT64_T timestamp_t
A type to hold the current time, in microseconds since January 1st, 1970.
Definition timestamp.h:20
struct work_queue * work_queue_ssl_create(int port, const char *key, const char *cert)
Create a new work queue using SSL.
int work_queue_port(struct work_queue *q)
Get the listening port of the queue.
void work_queue_specify_num_tasks_left(struct work_queue *q, int ntasks)
Specify the number of tasks not yet submitted to the queue.
const char * work_queue_result_str(work_queue_result_t result)
Explain result codes from tasks.
void work_queue_task_specify_algorithm(struct work_queue_task *t, work_queue_schedule_t algorithm)
Select the scheduling algorithm for a single task.
void work_queue_task_specify_running_time_min(struct work_queue_task *t, int64_t seconds)
Specify the minimum time (in seconds) the task is expected to run in a worker.
work_queue_schedule_t
Task scheduling modes used by work_queue_specify_algorithm and work_queue_task_specify_algorithm.
Definition work_queue.h:55
@ WORK_QUEUE_SCHEDULE_WORST
Select the worst fit worker (the worker with more unused resources).
Definition work_queue.h:61
@ WORK_QUEUE_SCHEDULE_RAND
Select a random worker.
Definition work_queue.h:60
@ WORK_QUEUE_SCHEDULE_FCFS
Select worker on a first-come-first-serve basis.
Definition work_queue.h:57
@ WORK_QUEUE_SCHEDULE_FILES
Select worker that has the most data required by the task.
Definition work_queue.h:58
@ WORK_QUEUE_SCHEDULE_TIME
Select worker that has the fastest execution time on previous tasks.
Definition work_queue.h:59
void work_queue_task_specify_category(struct work_queue_task *t, const char *category)
Label the task with the given category.
void work_queue_specify_min_resources(struct work_queue *q, const struct rmsummary *rm)
Sets the minimum resources a task without an explicit category ("default" category).
struct list * work_queue_cancel_all_tasks(struct work_queue *q)
Cancel all submitted tasks and remove them from the queue.
void work_queue_specify_name(struct work_queue *q, const char *name)
Change the project name for a given queue.
void work_queue_specify_category_max_concurrent(struct work_queue *q, const char *category, int max_concurrent)
Set a maximum number of tasks of this category that can execute concurrently.
void work_queue_task_specify_priority(struct work_queue_task *t, double priority)
Specify the priority of this task relative to others in the queue.
void work_queue_block_host_with_timeout(struct work_queue *q, const char *hostname, time_t seconds)
Block workers in hostname from a queue, but remove block after timeout seconds.
void work_queue_specify_estimate_capacity_on(struct work_queue *q, int estimate_capacity_on)
Change whether to estimate manager capacity for a given queue.
void work_queue_task_specify_coprocess(struct work_queue_task *t, const char *coprocess_name)
Indicate the command to be executed.
work_queue_file_t
Types of files that can be attached to a task.
Definition work_queue.h:97
@ WORK_QUEUE_DIRECTORY
File-spec is a directory.
Definition work_queue.h:102
@ WORK_QUEUE_FILE
File-spec is a regular file.
Definition work_queue.h:98
@ WORK_QUEUE_FILE_PIECE
File-spec refers to only a part of a file.
Definition work_queue.h:101
@ WORK_QUEUE_BUFFER
Data comes from buffer memory.
Definition work_queue.h:99
@ WORK_QUEUE_URL
File-spec refers to an URL.
Definition work_queue.h:103
@ WORK_QUEUE_REMOTECMD
File-spec is a regular file.
Definition work_queue.h:100
int work_queue_task_specify_input_file(struct work_queue_task *t, const char *fname, const char *rname)
Add an input file to a task.
void work_queue_task_specify_tag(struct work_queue_task *t, const char *tag)
Attach a user defined string tag to the task.
void work_queue_block_host(struct work_queue *q, const char *hostname)
Block workers in hostname from working for queue q.
void work_queue_specify_keepalive_timeout(struct work_queue *q, int timeout)
Change the keepalive timeout for identifying dead workers for a given queue.
int work_queue_specify_draining_by_hostname(struct work_queue *q, const char *hostname, int drain_flag)
Set the draining mode per worker hostname.
void work_queue_specify_keepalive_interval(struct work_queue *q, int interval)
Change the keepalive interval for a given queue.
void work_queue_specify_password(struct work_queue *q, const char *password)
Add a mandatory password that each worker must present.
void work_queue_task_specify_start_time_min(struct work_queue_task *t, int64_t useconds)
Specify the minimum start time allowed for the task (in microseconds since the Epoch).
void work_queue_task_specify_max_retries(struct work_queue_task *t, int64_t max_retries)
Specify the number of times this task is retried on worker errors.
char * work_queue_get_worker_summary(struct work_queue *q)
Summarize workers.
void work_queue_task_specify_feature(struct work_queue_task *t, const char *name)
Label the task with a user-defined feature.
int work_queue_tune(struct work_queue *q, const char *name, double value)
Tune advanced parameters for work queue.
void work_queue_delete(struct work_queue *q)
Delete a work queue.
void work_queue_unblock_host(struct work_queue *q, const char *hostname)
Unblock host from a queue.
void work_queue_task_specify_command(struct work_queue_task *t, const char *cmd)
Indicate the command to be executed.
int work_queue_task_specify_directory(struct work_queue_task *t, const char *local_name, const char *remote_name, work_queue_file_type_t type, work_queue_file_flags_t flags, int recursive)
Add a directory to a task.
void work_queue_task_specify_memory(struct work_queue_task *t, int64_t memory)
Specify the amount of disk space required by a task.
int work_queue_enable_monitoring(struct work_queue *q, char *monitor_output_directory, int watchdog)
Enables resource monitoring on the give work queue.
void work_queue_specify_priority(struct work_queue *q, int priority)
Change the priority for a given queue.
void work_queue_unblock_all(struct work_queue *q)
Unblock all host.
void work_queue_specify_manager_mode(struct work_queue *q, int mode)
Specify the manager mode for a given queue.
char * work_queue_generate_disk_alloc_full_filename(char *pwd, int taskid)
Generate a worker-level unique filename to indicate a disk allocation being full.
void work_queue_task_specify_gpus(struct work_queue_task *t, int gpus)
Specify the number of gpus required by a task.
work_queue_category_mode_t
Definition work_queue.h:110
@ WORK_QUEUE_ALLOCATION_MODE_EXHAUSTIVE_BUCKETING
Use the exhaustive bucketing algorithm to label resources.
Definition work_queue.h:127
@ WORK_QUEUE_ALLOCATION_MODE_MAX_THROUGHPUT
As above, but maximizing throughput.
Definition work_queue.h:123
@ WORK_QUEUE_ALLOCATION_MODE_MIN_WASTE
As above, but tasks are first tried with an automatically computed allocation to minimize resource wa...
Definition work_queue.h:121
@ WORK_QUEUE_ALLOCATION_MODE_FIXED
When monitoring is disabled, all tasks run as WORK_QUEUE_ALLOCATION_MODE_FIXED.
Definition work_queue.h:111
@ WORK_QUEUE_ALLOCATION_MODE_MAX
When monitoring is enabled, tasks are tried with maximum specified values of cores,...
Definition work_queue.h:114
@ WORK_QUEUE_ALLOCATION_MODE_GREEDY_BUCKETING
Use the greedy bucketing algorithm to label resources.
Definition work_queue.h:125
void work_queue_initialize_categories(struct work_queue *q, struct rmsummary *max, const char *summaries_file)
Initialize first value of categories.
void work_queue_task_specify_monitor_output(struct work_queue_task *t, const char *monitor_output)
Specify a custom name for the monitoring summary.
void work_queue_set_bandwidth_limit(struct work_queue *q, const char *bandwidth)
Limit the queue bandwidth when transferring files to and from workers.
int work_queue_task_specify_file_command(struct work_queue_task *t, const char *cmd, const char *remote_name, work_queue_file_type_t type, work_queue_file_flags_t flags)
Gets/puts file at remote_name using cmd at worker.
work_queue_task_state_t work_queue_task_state(struct work_queue *q, int taskid)
Get the current state of the task.
void work_queue_specify_max_resources(struct work_queue *q, const struct rmsummary *rm)
Sets the maximum resources a task without an explicit category ("default" category).
void work_queue_specify_tlq_port(struct work_queue *q, int port)
Change the home host and port for a given queue (used by TLQ).
const char * work_queue_name(struct work_queue *q)
Get the project name of the queue.
int work_queue_specify_transactions_log(struct work_queue *q, const char *logfile)
Add a log file that records the states of the connected workers and tasks.
work_queue_task_state_t
State of a task throughout its lifetime.
Definition work_queue.h:85
@ WORK_QUEUE_TASK_UNKNOWN
There is no such task.
Definition work_queue.h:86
@ WORK_QUEUE_TASK_CANCELED
Task was canceled before completion.
Definition work_queue.h:92
@ WORK_QUEUE_TASK_WAITING_RETRIEVAL
Task results are available at the worker.
Definition work_queue.h:89
@ WORK_QUEUE_TASK_DONE
Task is done, and returned through work_queue_wait >
Definition work_queue.h:91
@ WORK_QUEUE_TASK_READY
Task is ready to be run, waiting in queue.
Definition work_queue.h:87
@ WORK_QUEUE_TASK_RUNNING
Task has been dispatched to some worker.
Definition work_queue.h:88
@ WORK_QUEUE_TASK_RETRIEVED
Task results are available at the manager.
Definition work_queue.h:90
int work_queue_empty(struct work_queue *q)
Determine whether the queue is empty.
double work_queue_get_effective_bandwidth(struct work_queue *q)
Get current queue bandwidth.
void work_queue_specify_debug_path(struct work_queue *q, const char *path)
Change the debug log path for a given queue (used by TLQ).
void work_queue_get_stats_hierarchy(struct work_queue *q, struct work_queue_stats *s)
Get statistics of the manager queue together with foremen information.
void work_queue_manager_preferred_connection(struct work_queue *q, const char *preferred_connection)
Set the preference for using hostname over IP address to connect.
void work_queue_specify_catalog_servers(struct work_queue *q, const char *hosts)
Specify the catalog server(s) the manager should report to.
void work_queue_invalidate_cached_file(struct work_queue *q, const char *local_name, work_queue_file_t type)
Invalidate cached file.
int work_queue_task_specify_output_file(struct work_queue_task *t, const char *rname, const char *fname)
Add an output file to a task.
void work_queue_get_stats(struct work_queue *q, struct work_queue_stats *s)
Get queue statistics (only from manager).
work_queue_file_type_t
The input/output type of files used by work_queue_task_specify_file and similar.
Definition work_queue.h:35
@ WORK_QUEUE_OUTPUT
Specify an output object.
Definition work_queue.h:37
@ WORK_QUEUE_INPUT
Specify an input object.
Definition work_queue.h:36
int work_queue_specify_log(struct work_queue *q, const char *logfile)
Add a log file that records cummulative statistics of the connected workers and submitted tasks.
void work_queue_task_specify_end_time(struct work_queue_task *t, int64_t useconds)
Specify the maximum end time allowed for the task (in microseconds since the Epoch).
work_queue_file_flags_t
File handling flags used by work_queue_task_specify_file and similar.
Definition work_queue.h:42
@ WORK_QUEUE_FAILURE_ONLY
Only return this output file if the task failed.
Definition work_queue.h:47
@ WORK_QUEUE_PREEXIST
If the filename already exists on the host, use it in place.
Definition work_queue.h:50
@ WORK_QUEUE_CACHE
Cache file at execution site for later use.
Definition work_queue.h:44
@ WORK_QUEUE_WATCH
Watch the output file and send back changes as the task runs.
Definition work_queue.h:46
@ WORK_QUEUE_SUCCESS_ONLY
Only return this output file if the task succeeded.
Definition work_queue.h:48
@ WORK_QUEUE_NOCACHE
Do not cache file at execution site.
Definition work_queue.h:43
@ WORK_QUEUE_SYMLINK
Create a symlink to the file rather than copying it, if possible.
Definition work_queue.h:45
char * work_queue_status(struct work_queue *q, const char *request)
Get queue information as json.
int work_queue_enable_monitoring_full(struct work_queue *q, char *monitor_output_directory, int watchdog)
Enables resource monitoring on the give work queue.
int work_queue_specify_snapshot_file(struct work_queue_task *t, const char *monitor_snapshot_file)
When monitoring, indicates a json-encoded file that instructs the monitor to take a snapshot of the t...
void work_queue_task_specify_running_time(struct work_queue_task *t, int64_t useconds)
Specify the maximum time (in microseconds) the task is allowed to run in a worker.
struct work_queue_task * work_queue_cancel_by_tasktag(struct work_queue *q, const char *tag)
Cancel a submitted task using its tag and remove it from queue.
struct rmsummary ** work_queue_workers_summary(struct work_queue *q)
Summary data for all workers in buffer.
void work_queue_specify_catalog_server(struct work_queue *q, const char *hostname, int port)
Specify the catalog server the manager should report to.
int work_queue_task_specify_input_file_do_not_cache(struct work_queue_task *t, const char *fname, const char *rname)
Add an input file to a task, without caching.
void work_queue_task_delete(struct work_queue_task *t)
Delete a task.
void work_queue_specify_category_first_allocation_guess(struct work_queue *q, const char *category, const struct rmsummary *rm)
Set the initial guess for resource autolabeling for the given category.
int work_queue_activate_fast_abort(struct work_queue *q, double multiplier)
Turn on or off fast abort functionality for a given queue for tasks without an explicit category.
int work_queue_task_specify_file_piece(struct work_queue_task *t, const char *local_name, const char *remote_name, off_t start_byte, off_t end_byte, work_queue_file_type_t type, work_queue_file_flags_t flags)
Add a file piece to a task.
int work_queue_task_specify_url(struct work_queue_task *t, const char *url, const char *remote_name, work_queue_file_type_t type, work_queue_file_flags_t flags)
Add a url as an input for a task.
void work_queue_task_specify_cores(struct work_queue_task *t, int cores)
Specify the number of cores required by a task.
struct work_queue_task * work_queue_cancel_by_taskid(struct work_queue *q, int id)
Cancel a submitted task using its task id and remove it from queue.
struct work_queue_task * work_queue_wait_for_tag(struct work_queue *q, const char *tag, int timeout)
Wait for a task with a given task to complete.
struct work_queue_task * work_queue_task_clone(const struct work_queue_task *task)
Create a copy of a task Create a functionally identical copy of a work_queue_task that can be re-subm...
int work_queue_submit(struct work_queue *q, struct work_queue_task *t)
Submit a task to a queue.
struct work_queue_task * work_queue_wait(struct work_queue *q, int timeout)
Wait for a task to complete.
void work_queue_specify_category_max_resources(struct work_queue *q, const char *category, const struct rmsummary *rm)
Sets the maximum resources a task in the category may use.
int work_queue_shut_down_workers(struct work_queue *q, int n)
Shut down workers connected to the work_queue system.
struct work_queue_task * work_queue_task_create(const char *full_command)
Create a new task object.
struct work_queue * work_queue_create(int port)
Create a new work queue.
int work_queue_enable_category_resource(struct work_queue *q, const char *category, const char *resource, int autolabel)
Turn on or off first-allocation labeling for a given category and resource.
int work_queue_task_specify_output_file_do_not_cache(struct work_queue_task *t, const char *rname, const char *fname)
Add an output file to a task without caching.
void work_queue_specify_category_min_resources(struct work_queue *q, const char *category, const struct rmsummary *rm)
Sets the minimum resources a task in the category may use.
int work_queue_activate_fast_abort_category(struct work_queue *q, const char *category, double multiplier)
Turn on or off fast abort functionality for a given category.
int work_queue_task_specify_file(struct work_queue_task *t, const char *local_name, const char *remote_name, work_queue_file_type_t type, work_queue_file_flags_t flags)
Add a file to a task.
void work_queue_task_specify_disk(struct work_queue_task *t, int64_t disk)
Specify the amount of disk space required by a task.
void work_queue_task_specify_enviroment_variable(struct work_queue_task *t, const char *name, const char *value)
Same as work_queue_task_specify_environment_variable, but with a typo in environment.
work_queue_result_t
Task result types set when a task is complete.
Definition work_queue.h:66
@ WORK_QUEUE_RESULT_OUTPUT_MISSING
The task ran but failed to generate a specified output file.
Definition work_queue.h:69
@ WORK_QUEUE_RESULT_SIGNAL
The task was terminated with a signal.
Definition work_queue.h:71
@ WORK_QUEUE_RESULT_RMONITOR_ERROR
The task failed because the monitor did not produce a summary report.
Definition work_queue.h:79
@ WORK_QUEUE_RESULT_UNKNOWN
The result could not be classified.
Definition work_queue.h:74
@ WORK_QUEUE_RESULT_RESOURCE_EXHAUSTION
The task used more resources than requested.
Definition work_queue.h:72
@ WORK_QUEUE_RESULT_INPUT_MISSING
The task cannot be run due to a missing input file.
Definition work_queue.h:68
@ WORK_QUEUE_RESULT_MAX_RETRIES
The task could not be completed successfully in the given number of retries.
Definition work_queue.h:76
@ WORK_QUEUE_RESULT_OUTPUT_TRANSFER_ERROR
The task failed because an output could be transfered to the manager (not enough disk space,...
Definition work_queue.h:80
@ WORK_QUEUE_RESULT_SUCCESS
The task ran successfully.
Definition work_queue.h:67
@ WORK_QUEUE_RESULT_FORSAKEN
The task failed, but it was not a task error.
Definition work_queue.h:75
@ WORK_QUEUE_RESULT_STDOUT_MISSING
The task ran but its stdout has been truncated.
Definition work_queue.h:70
@ WORK_QUEUE_RESULT_TASK_TIMEOUT
The task ran after the specified (absolute since epoch) end time.
Definition work_queue.h:73
@ WORK_QUEUE_RESULT_DISK_ALLOC_FULL
The task filled its loop device allocation but needed more space.
Definition work_queue.h:78
@ WORK_QUEUE_RESULT_TASK_MAX_RUN_TIME
The task ran for more than the specified time (relative since running in a worker).
Definition work_queue.h:77
int work_queue_task_specify_input_buf(struct work_queue_task *t, const char *buf, int length, const char *rname)
Add an input buffer to a task.
void work_queue_specify_algorithm(struct work_queue *q, work_queue_schedule_t algorithm)
Change the worker selection algorithm.
void work_queue_task_specify_environment_variable(struct work_queue_task *t, const char *name, const char *value)
Specify an environment variable to be added to the task.
int work_queue_specify_password_file(struct work_queue *q, const char *file)
Add a mandatory password file that each worker must present.
int work_queue_task_specify_buffer(struct work_queue_task *t, const char *data, int length, const char *remote_name, work_queue_file_flags_t flags)
Add an input buffer to a task.
void work_queue_task_specify_running_time_max(struct work_queue_task *t, int64_t seconds)
Specify the maximum time (in seconds) the task is allowed to run in a worker.
int work_queue_specify_min_taskid(struct work_queue *q, int minid)
Set the minimum taskid of future submitted tasks.
void work_queue_specify_task_order(struct work_queue *q, int order)
Specified how the submitted tasks should be ordered.
int work_queue_specify_category_mode(struct work_queue *q, const char *category, work_queue_category_mode_t mode)
Turn on or off first-allocation labeling for a given category.
int work_queue_hungry(struct work_queue *q)
Determine whether the queue is 'hungry' for more tasks.
void work_queue_get_stats_category(struct work_queue *q, const char *c, struct work_queue_stats *s)
Get the task statistics for the given category.