taskvine.h
Go to the documentation of this file.
/*
Copyright (C) 2022- The University of Notre Dame
This software is distributed under the GNU General Public License.
See the file COPYING for details.
*/
#ifndef TASKVINE_H
#define TASKVINE_H
#include "category.h"
#include "rmsummary.h"
#include "timestamp.h"
#include <sys/types.h>
struct vine_manager;
struct vine_task;
struct vine_file;
#define VINE_DEFAULT_PORT 9123
#define VINE_RANDOM_PORT 0
#define VINE_WAIT_FOREVER -1
typedef enum {
VINE_TRANSFER_ALWAYS = 0,
VINE_FIXED_LOCATION = 1,
VINE_WATCH = 2,
VINE_FAILURE_ONLY = 4,
VINE_SUCCESS_ONLY = 8,
VINE_RETRACT_ON_RESET = 16,
VINE_MOUNT_SYMLINK = 32,
VINE_MOUNT_MKDIR = 64
} vine_mount_flags_t;
typedef enum {
VINE_CACHE_LEVEL_TASK = 0,
VINE_CACHE_LEVEL_WORKFLOW = 1,
VINE_CACHE_LEVEL_WORKER = 2,
VINE_CACHE_LEVEL_FOREVER = 3
} vine_cache_level_t;
typedef enum {
VINE_PEER_NOSHARE = 1,
VINE_UNLINK_WHEN_DONE = 2
} vine_file_flags_t;
typedef enum {
VINE_SCHEDULE_UNSET = 0,
VINE_SCHEDULE_FCFS,
VINE_SCHEDULE_FILES,
VINE_SCHEDULE_TIME,
VINE_SCHEDULE_RAND,
VINE_SCHEDULE_WORST,
VINE_SCHEDULE_DISK
} vine_schedule_t;
typedef enum {
VINE_RESULT_SUCCESS = 0,
VINE_RESULT_INPUT_MISSING = 1,
VINE_RESULT_OUTPUT_MISSING = 2,
VINE_RESULT_STDOUT_MISSING = 4,
VINE_RESULT_SIGNAL = 1 << 3,
VINE_RESULT_RESOURCE_EXHAUSTION = 2 << 3,
VINE_RESULT_MAX_END_TIME = 3 << 3,
VINE_RESULT_UNKNOWN = 4 << 3,
VINE_RESULT_FORSAKEN = 5 << 3,
VINE_RESULT_MAX_RETRIES = 6 << 3,
VINE_RESULT_MAX_WALL_TIME = 7 << 3,
VINE_RESULT_RMONITOR_ERROR =
8 << 3,
VINE_RESULT_OUTPUT_TRANSFER_ERROR = 9 << 3,
VINE_RESULT_FIXED_LOCATION_MISSING = 10 << 3,
VINE_RESULT_CANCELLED = 11 << 3,
VINE_RESULT_LIBRARY_EXIT = 12 << 3,
VINE_RESULT_SANDBOX_EXHAUSTION = 13 << 3,
VINE_RESULT_MISSING_LIBRARY = 14 << 3
} vine_result_t;
typedef enum {
VINE_ALLOCATION_MODE_FIXED = CATEGORY_ALLOCATION_MODE_FIXED,
VINE_ALLOCATION_MODE_MAX = CATEGORY_ALLOCATION_MODE_MAX,
VINE_ALLOCATION_MODE_MIN_WASTE = CATEGORY_ALLOCATION_MODE_MIN_WASTE,
VINE_ALLOCATION_MODE_MAX_THROUGHPUT = CATEGORY_ALLOCATION_MODE_MAX_THROUGHPUT,
VINE_ALLOCATION_MODE_GREEDY_BUCKETING = CATEGORY_ALLOCATION_MODE_GREEDY_BUCKETING,
VINE_ALLOCATION_MODE_EXHAUSTIVE_BUCKETING = CATEGORY_ALLOCATION_MODE_EXHAUSTIVE_BUCKETING
} vine_category_mode_t;
typedef enum {
VINE_FILE = 1,
VINE_URL,
VINE_TEMP,
VINE_BUFFER,
VINE_MINI_TASK,
} vine_file_type_t;
struct vine_stats {
/* Stats for the current state of workers: */
int workers_connected;
int workers_init;
int workers_idle;
int workers_busy;
int workers_able;
/* Cumulative stats for workers: */
int workers_joined;
int workers_removed;
int workers_released;
int workers_idled_out;
int workers_slow;
int workers_blocked;
int workers_lost;
/* Stats for the current state of tasks: */
int tasks_waiting;
int tasks_on_workers;
int tasks_running;
int tasks_with_results;
/* Cumulative stats for tasks: */
int tasks_submitted;
int tasks_dispatched;
int tasks_done;
int tasks_failed;
int tasks_cancelled;
int tasks_exhausted_attempts;
/* All times in microseconds */
/* A time_when_* refers to an instant in time, otherwise it refers to a length of time. */
/* Master time statistics: */
timestamp_t time_when_started;
timestamp_t time_send;
timestamp_t time_receive;
timestamp_t time_send_good;
timestamp_t time_receive_good;
timestamp_t time_status_msgs;
timestamp_t time_internal;
timestamp_t time_polling;
timestamp_t time_application;
timestamp_t time_scheduling;
/* Workers time statistics: */
timestamp_t time_workers_execute;
timestamp_t time_workers_execute_good;
timestamp_t time_workers_execute_exhaustion;
/* BW statistics */
int64_t bytes_sent;
int64_t bytes_received;
double bandwidth;
/* resources statistics */
int capacity_tasks;
int capacity_cores;
int capacity_memory;
int capacity_disk;
int capacity_gpus;
int capacity_instantaneous;
int capacity_weighted;
int64_t total_cores;
int64_t total_memory;
int64_t total_disk;
int64_t total_gpus;
int64_t committed_cores;
int64_t committed_memory;
int64_t committed_disk;
int64_t committed_gpus;
int64_t max_cores;
int64_t max_memory;
int64_t max_disk;
int64_t max_gpus;
int64_t min_cores;
int64_t min_memory;
int64_t min_disk;
int64_t min_gpus;
int64_t inuse_cache;
};
struct vine_task *vine_task_create(const char *full_command);
void vine_task_delete(struct vine_task *t);
void vine_task_set_command(struct vine_task *t, const char *cmd);
void vine_task_set_library_required(struct vine_task *t, const char *name);
const char *vine_task_get_library_required(struct vine_task *t);
void vine_task_set_library_provided(struct vine_task *t, const char *name);
const char *vine_task_get_library_provided(struct vine_task *t);
void vine_task_set_function_slots(struct vine_task *t, int nslots);
void vine_task_set_function_exec_mode_from_string(struct vine_task *t, const char *exec_mode);
int vine_task_add_input(struct vine_task *t, struct vine_file *f, const char *remote_name, vine_mount_flags_t flags);
int vine_task_add_output(struct vine_task *t, struct vine_file *f, const char *remote_name, vine_mount_flags_t flags);
void vine_task_set_retries(struct vine_task *t, int64_t max_retries);
void vine_task_set_max_forsaken(struct vine_task *t, int64_t max_forsaken);
void vine_task_set_memory(struct vine_task *t, int64_t memory);
void vine_task_set_disk(struct vine_task *t, int64_t disk);
void vine_task_set_cores(struct vine_task *t, int cores);
void vine_task_set_gpus(struct vine_task *t, int gpus);
void vine_task_set_time_end(struct vine_task *t, int64_t useconds);
void vine_task_set_time_start(struct vine_task *t, int64_t useconds);
void vine_task_set_time_max(struct vine_task *t, int64_t seconds);
void vine_task_set_time_min(struct vine_task *t, int64_t seconds);
void vine_task_set_tag(struct vine_task *t, const char *tag);
void vine_task_set_category(struct vine_task *t, const char *category);
void vine_task_add_feature(struct vine_task *t, const char *name);
void vine_task_set_priority(struct vine_task *t, double priority);
void vine_task_set_env_var(struct vine_task *t, const char *name, const char *value);
void vine_task_set_scheduler(struct vine_task *t, vine_schedule_t algorithm);
int vine_task_set_monitor_output(struct vine_task *t, const char *monitor_output);
const char *vine_task_get_state(struct vine_task *t);
const char *vine_task_get_command(struct vine_task *t);
const char *vine_task_get_tag(struct vine_task *t);
const char *vine_task_get_category(struct vine_task *t);
int vine_task_get_id(struct vine_task *t);
vine_result_t vine_task_get_result(struct vine_task *t);
const char *vine_result_string(vine_result_t result);
int vine_task_get_exit_code(struct vine_task *t);
const char *vine_task_get_stdout(struct vine_task *t);
const char *vine_task_get_addrport(struct vine_task *t);
const char *vine_task_get_hostname(struct vine_task *t);
int64_t vine_task_get_metric(struct vine_task *t, const char *name);
void vine_task_set_resources(struct vine_task *t, const struct rmsummary *rm);
const struct rmsummary *vine_task_get_resources(struct vine_task *t, const char *name);
int vine_task_set_snapshot_file(struct vine_task *t, struct vine_file *monitor_snapshot_file);
int vine_task_add_starch_package(struct vine_task *t, struct vine_file *f);
int vine_task_add_poncho_package(struct vine_task *t, struct vine_file *f);
int vine_task_add_execution_context(struct vine_task *t, struct vine_file *f);
/* Deprecated alias for vine_task_add_execution_context. */
int vine_task_add_environment(struct vine_task *t, struct vine_file *f);
const char *vine_file_contents(struct vine_file *f);
size_t vine_file_size(struct vine_file *f);
const char *vine_file_source(struct vine_file *f);
vine_file_type_t vine_file_type(struct vine_file *f);
int vine_file_replica_count(struct vine_manager *m, struct vine_file *f);
struct vine_file *vine_declare_file(
struct vine_manager *m, const char *source, vine_cache_level_t cache, vine_file_flags_t flags);
struct vine_file *vine_declare_url(
struct vine_manager *m, const char *url, vine_cache_level_t cache, vine_file_flags_t flags);
struct vine_file *vine_declare_xrootd(struct vine_manager *m, const char *source, struct vine_file *proxy,
struct vine_file *env, vine_cache_level_t cache, vine_file_flags_t flags);
struct vine_file *vine_declare_chirp(struct vine_manager *m, const char *server, const char *source,
struct vine_file *ticket, struct vine_file *env, vine_cache_level_t cache, vine_file_flags_t flags);
struct vine_file *vine_declare_temp(struct vine_manager *m);
struct vine_file *vine_declare_buffer(struct vine_manager *m, const char *buffer, size_t size, vine_cache_level_t cache,
vine_file_flags_t flags);
struct vine_file *vine_declare_mini_task(struct vine_manager *m, struct vine_task *mini_task, const char *name,
vine_cache_level_t cache, vine_file_flags_t flags);
struct vine_file *vine_declare_untar(
struct vine_manager *m, struct vine_file *f, vine_cache_level_t cache, vine_file_flags_t flags);
struct vine_file *vine_declare_poncho(
struct vine_manager *m, struct vine_file *f, vine_cache_level_t cache, vine_file_flags_t flags);
struct vine_file *vine_declare_starch(
struct vine_manager *m, struct vine_file *f, vine_cache_level_t cache, vine_file_flags_t flags);
void vine_file_set_mode( struct vine_file *f, int mode );
const char *vine_fetch_file(struct vine_manager *m, struct vine_file *f);
void vine_undeclare_file(struct vine_manager *m, struct vine_file *f);
void vine_prune_file(struct vine_manager *m, struct vine_file *f);
struct vine_manager *vine_create(int port);
struct vine_manager *vine_ssl_create(int port, const char *key, const char *cert);
void vine_delete(struct vine_manager *m);
int vine_submit(struct vine_manager *m, struct vine_task *t);
void vine_manager_install_library(struct vine_manager *m, struct vine_task *t, const char *name);
void vine_manager_remove_library(struct vine_manager *m, const char *name);
struct vine_task *vine_manager_find_library_template(struct vine_manager *q, const char *library_name);
struct vine_task *vine_wait(struct vine_manager *m, int timeout);
struct vine_task *vine_wait_for_tag(struct vine_manager *m, const char *tag, int timeout);
struct vine_task *vine_wait_for_task_id(struct vine_manager *m, int task_id, int timeout);
int vine_hungry(struct vine_manager *m);
int vine_empty(struct vine_manager *m);
int vine_port(struct vine_manager *m);
void vine_set_name(struct vine_manager *m, const char *name);
const char *vine_get_name(struct vine_manager *m);
int vine_enable_monitoring(struct vine_manager *m, int watchdog, int time_series);
int vine_enable_peer_transfers(struct vine_manager *m);
int vine_disable_peer_transfers(struct vine_manager *m);
int vine_enable_proportional_resources(struct vine_manager *m);
int vine_disable_proportional_resources(struct vine_manager *m);
int vine_set_task_id_min(struct vine_manager *m, int minid);
void vine_block_host(struct vine_manager *m, const char *hostname);
void vine_block_host_with_timeout(struct vine_manager *m, const char *hostname, time_t seconds);
void vine_unblock_host(struct vine_manager *m, const char *hostname);
void vine_unblock_all(struct vine_manager *m);
void vine_get_stats(struct vine_manager *m, struct vine_stats *s);
void vine_get_stats_category(struct vine_manager *m, const char *c, struct vine_stats *s);
char *vine_get_status(struct vine_manager *m, const char *request);
struct rmsummary **vine_summarize_workers(struct vine_manager *m);
void vine_set_bandwidth_limit(struct vine_manager *m, const char *bandwidth);
double vine_get_effective_bandwidth(struct vine_manager *m);
int vine_enable_disconnect_slow_workers(struct vine_manager *m, double multiplier);
int vine_enable_disconnect_slow_workers_category(struct vine_manager *m, const char *category, double multiplier);
int vine_set_draining_by_hostname(struct vine_manager *m, const char *hostname, int drain_flag);
int vine_set_category_mode(struct vine_manager *m, const char *category, vine_category_mode_t mode);
void vine_set_category_max_concurrent(struct vine_manager *m, const char *category, int max_concurrent);
int vine_enable_category_resource(struct vine_manager *m, const char *category, const char *resource, int autolabel);
void vine_set_scheduler(struct vine_manager *m, vine_schedule_t algorithm);
void vine_set_priority(struct vine_manager *m, int priority);
void vine_set_tasks_left_count(struct vine_manager *m, int ntasks);
void vine_set_catalog_servers(struct vine_manager *m, const char *hosts);
/* Send updates to the catalog server.
@param m A manager object
*/
void vine_update_catalog(struct vine_manager *m);
void vine_set_property(struct vine_manager *m, const char *name, const char *value);
int vine_cancel_by_task_id(struct vine_manager *m, int id);
int vine_cancel_by_task_tag(struct vine_manager *m, const char *tag);
int vine_cancel_all(struct vine_manager *m);
int vine_enable_debug_log(const char *logfile);
int vine_enable_perf_log(struct vine_manager *m, const char *logfile);
int vine_enable_transactions_log(struct vine_manager *m, const char *logfile);
int vine_enable_taskgraph_log(struct vine_manager *m, const char *logfile);
int vine_workers_shutdown(struct vine_manager *m, int n);
void vine_set_password(struct vine_manager *m, const char *password);
int vine_set_password_file(struct vine_manager *m, const char *file);
void vine_set_keepalive_interval(struct vine_manager *m, int interval);
void vine_set_keepalive_timeout(struct vine_manager *m, int timeout);
void vine_set_manager_preferred_connection(struct vine_manager *m, const char *preferred_connection);
int vine_tune(struct vine_manager *m, const char *name, double value);
void vine_set_resources_max(struct vine_manager *m, const struct rmsummary *rm);
void vine_set_resources_min(struct vine_manager *m, const struct rmsummary *rm);
void vine_set_category_resources_max(struct vine_manager *m, const char *category, const struct rmsummary *rm);
void vine_set_category_resources_min(struct vine_manager *m, const char *category, const struct rmsummary *rm);
void vine_set_category_first_allocation_guess(struct vine_manager *m, const char *category, const struct rmsummary *rm);
void vine_initialize_categories(struct vine_manager *m, struct rmsummary *max, const char *summaries_file);
void vine_set_runtime_info_path(const char *path);
void vine_set_runtime_info_template(const char *template);
void vine_log_debug_app(struct vine_manager *q, const char *entry);
void vine_log_txn_app(struct vine_manager *q, const char *entry);
void vine_counters_print();
char *vine_version_string();
char *vine_get_path_log(struct vine_manager *m, const char *path);
char *vine_get_path_staging(struct vine_manager *m, const char *path);
char *vine_get_path_library_log(struct vine_manager *m, const char *path);
char *vine_get_path_cache(struct vine_manager *m, const char *path);
#endif
category.h
Implements bookkeeping for categories of tasks and their resources.
CATEGORY_ALLOCATION_MODE_MIN_WASTE
@ 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
@ 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
@ CATEGORY_ALLOCATION_MODE_GREEDY_BUCKETING
Use the greedy bucketing algorithm to label resources.
Definition category.h:61
CATEGORY_ALLOCATION_MODE_EXHAUSTIVE_BUCKETING
@ CATEGORY_ALLOCATION_MODE_EXHAUSTIVE_BUCKETING
Use the exhaustive bucketing algorithm to label resources.
Definition category.h:64
CATEGORY_ALLOCATION_MODE_MAX_THROUGHPUT
@ CATEGORY_ALLOCATION_MODE_MAX_THROUGHPUT
As above, but maximizing throughput.
Definition category.h:59
CATEGORY_ALLOCATION_MODE_MAX
@ CATEGORY_ALLOCATION_MODE_MAX
When monitoring is enabled, tasks are tried with maximum specified values of cores,...
Definition category.h:43
buffer
Definition buffer.h:26
category
Definition category.h:69
rmsummary
Definition rmsummary.h:27
vine_stats
Statistics describing a manager.
Definition taskvine.h:154
vine_stats::tasks_running
int tasks_running
Number of tasks currently executing at some worker.
Definition taskvine.h:177
vine_stats::time_internal
timestamp_t time_internal
Total time the manager spents in internal processing.
Definition taskvine.h:204
vine_stats::tasks_exhausted_attempts
int tasks_exhausted_attempts
Total number of task executions that failed given resource exhaustion.
Definition taskvine.h:187
vine_stats::workers_joined
int workers_joined
Total number of worker connections that were established to the manager.
Definition taskvine.h:164
vine_stats::committed_cores
int64_t committed_cores
Committed number of cores aggregated across the connected workers.
Definition taskvine.h:242
vine_stats::workers_blocked
int workers_blocked
Total number of workers blocked by the manager.
Definition taskvine.h:170
vine_stats::time_workers_execute_exhaustion
timestamp_t time_workers_execute_exhaustion
Total time workers spent executing tasks that exhausted resources.
Definition taskvine.h:214
vine_stats::time_scheduling
timestamp_t time_scheduling
Total time spend matching tasks to workers.
Definition taskvine.h:208
vine_stats::time_status_msgs
timestamp_t time_status_msgs
Total time spent sending and receiving status messages to and from workers, including workers' standa...
Definition taskvine.h:201
vine_stats::time_workers_execute_good
timestamp_t time_workers_execute_good
Total time workers spent executing done tasks with result VINE_RESULT_SUCCESS.
Definition taskvine.h:212
vine_stats::workers_connected
int workers_connected
Number of workers currently connected to the manager.
Definition taskvine.h:156
vine_stats::workers_released
int workers_released
Total number of worker connections that were asked by the manager to disconnect.
Definition taskvine.h:166
vine_stats::capacity_instantaneous
int capacity_instantaneous
The estimated number of tasks that this manager can support considering only the most recently comple...
Definition taskvine.h:232
vine_stats::workers_init
int workers_init
Number of workers connected, but that have not send their available resources report yet.
Definition taskvine.h:157
vine_stats::workers_slow
int workers_slow
Total number of workers disconnected for being too slow.
Definition taskvine.h:168
vine_stats::min_gpus
int64_t min_gpus
The smallest number of gpus observed among the connected workers.
Definition taskvine.h:255
vine_stats::workers_idle
int workers_idle
Number of workers that are not running a task.
Definition taskvine.h:159
vine_stats::workers_idled_out
int workers_idled_out
Total number of worker that disconnected for being idle.
Definition taskvine.h:167
vine_stats::max_disk
int64_t max_disk
The largest disk space in MB observed among the connected workers.
Definition taskvine.h:249
vine_stats::total_cores
int64_t total_cores
Total number of cores aggregated across the connected workers.
Definition taskvine.h:237
vine_stats::time_when_started
timestamp_t time_when_started
Absolute time at which the manager started.
Definition taskvine.h:193
vine_stats::workers_removed
int workers_removed
Total number of worker connections that were terminated.
Definition taskvine.h:165
vine_stats::tasks_cancelled
int tasks_cancelled
Total number of tasks cancelled.
Definition taskvine.h:186
vine_stats::capacity_tasks
int capacity_tasks
The estimated number of tasks that this manager can effectively support.
Definition taskvine.h:226
vine_stats::committed_disk
int64_t committed_disk
Committed disk space in MB aggregated across the connected workers.
Definition taskvine.h:244
vine_stats::total_disk
int64_t total_disk
Total disk space in MB aggregated across the connected workers.
Definition taskvine.h:239
vine_stats::workers_able
int workers_able
Number of workers on which the largest task can run.
Definition taskvine.h:161
vine_stats::min_cores
int64_t min_cores
The lowest number of cores observed among the connected workers.
Definition taskvine.h:252
vine_stats::bytes_sent
int64_t bytes_sent
Total number of file bytes (not including protocol control msg bytes) sent out to the workers by the ...
Definition taskvine.h:218
vine_stats::committed_gpus
int64_t committed_gpus
Committed number of gpus aggregated across the connected workers.
Definition taskvine.h:245
vine_stats::bytes_received
int64_t bytes_received
Total number of file bytes (not including protocol control msg bytes) received from the workers by th...
Definition taskvine.h:220
vine_stats::tasks_waiting
int tasks_waiting
Number of tasks waiting to be dispatched.
Definition taskvine.h:175
vine_stats::committed_memory
int64_t committed_memory
Committed memory in MB aggregated across the connected workers.
Definition taskvine.h:243
vine_stats::time_receive_good
timestamp_t time_receive_good
Total time spent in sending data to workers for tasks with result VINE_RESULT_SUCCESS.
Definition taskvine.h:199
vine_stats::tasks_dispatched
int tasks_dispatched
Total number of tasks dispatch to workers.
Definition taskvine.h:182
vine_stats::tasks_failed
int tasks_failed
Total number of tasks completed and returned to user with result other than VINE_RESULT_SUCCESS.
Definition taskvine.h:184
vine_stats::workers_lost
int workers_lost
Total number of worker connections that were unexpectedly lost.
Definition taskvine.h:171
vine_stats::total_memory
int64_t total_memory
Total memory in MB aggregated across the connected workers.
Definition taskvine.h:238
vine_stats::workers_busy
int workers_busy
Number of workers that are running at least one task.
Definition taskvine.h:160
vine_stats::capacity_memory
int capacity_memory
The estimated number of workers' MB of RAM that this manager can effectively support.
Definition taskvine.h:228
vine_stats::min_memory
int64_t min_memory
The smallest memory size in MB observed among the connected workers.
Definition taskvine.h:253
vine_stats::tasks_done
int tasks_done
Total number of tasks completed and returned to user.
Definition taskvine.h:183
vine_stats::capacity_disk
int capacity_disk
The estimated number of workers' MB of disk that this manager can effectively support.
Definition taskvine.h:230
vine_stats::tasks_with_results
int tasks_with_results
Number of tasks with retrieved results and waiting to be returned to user.
Definition taskvine.h:178
vine_stats::time_send
timestamp_t time_send
Total time spent in sending tasks to workers (tasks descriptions, and input files....
Definition taskvine.h:194
vine_stats::max_cores
int64_t max_cores
The highest number of cores observed among the connected workers.
Definition taskvine.h:247
vine_stats::time_application
timestamp_t time_application
Total time spent outside vine_wait.
Definition taskvine.h:207
vine_stats::time_receive
timestamp_t time_receive
Total time spent in receiving results from workers (output files.).
Definition taskvine.h:196
vine_stats::total_gpus
int64_t total_gpus
Total number of gpus aggregated across the connected workers.
Definition taskvine.h:240
vine_stats::bandwidth
double bandwidth
Average network bandwidth in MB/S observed by the manager when transferring to workers.
Definition taskvine.h:222
vine_stats::time_workers_execute
timestamp_t time_workers_execute
Total time workers spent executing done tasks.
Definition taskvine.h:211
vine_stats::max_gpus
int64_t max_gpus
The highest number of gpus observed among the connected workers.
Definition taskvine.h:250
vine_stats::time_polling
timestamp_t time_polling
Total time blocking waiting for worker communications (i.e., manager idle waiting for a worker messag...
Definition taskvine.h:205
vine_stats::min_disk
int64_t min_disk
The smallest disk space in MB observed among the connected workers.
Definition taskvine.h:254
vine_stats::capacity_gpus
int capacity_gpus
The estimated number of workers' GPUs that this manager can effectively support.
Definition taskvine.h:231
vine_stats::max_memory
int64_t max_memory
The largest memory size in MB observed among the connected workers.
Definition taskvine.h:248
vine_stats::tasks_on_workers
int tasks_on_workers
Number of tasks currently dispatched to some worker.
Definition taskvine.h:176
vine_stats::tasks_submitted
int tasks_submitted
Total number of tasks submitted to the manager.
Definition taskvine.h:181
vine_stats::inuse_cache
int64_t inuse_cache
Used disk space of declared files in MB aggregated across the connected workers.
Definition taskvine.h:257
vine_stats::capacity_weighted
int capacity_weighted
The estimated number of tasks that this manager can support placing greater weight on the most recent...
Definition taskvine.h:234
vine_stats::time_send_good
timestamp_t time_send_good
Total time spent in sending data to workers for tasks with result VINE_RESULT_SUCCESS.
Definition taskvine.h:197
vine_stats::capacity_cores
int capacity_cores
The estimated number of workers' cores that this manager can effectively support.
Definition taskvine.h:227
vine_task_set_memory
void vine_task_set_memory(struct vine_task *t, int64_t memory)
Specify the amount of disk space required by a task.
vine_task_set_scheduler
void vine_task_set_scheduler(struct vine_task *t, vine_schedule_t algorithm)
Select the scheduling algorithm for a single task.
vine_version_string
char * vine_version_string()
Return a string with the current version of taskvine.
vine_task_set_disk
void vine_task_set_disk(struct vine_task *t, int64_t disk)
Specify the amount of disk space required by a task.
vine_task_set_max_forsaken
void vine_task_set_max_forsaken(struct vine_task *t, int64_t max_forsaken)
Specify the total number of times this task can be return to the manager without being executed.
vine_task_set_snapshot_file
int vine_task_set_snapshot_file(struct vine_task *t, struct vine_file *monitor_snapshot_file)
When monitoring, indicates a json-encoded file that instructs the monitor to take a snapshot of the t...
vine_enable_category_resource
int vine_enable_category_resource(struct vine_manager *m, const char *category, const char *resource, int autolabel)
Turn on or off first-allocation labeling for a given category and resource.
vine_task_add_starch_package
int vine_task_add_starch_package(struct vine_task *t, struct vine_file *f)
Add a Starch package as an execution context.
vine_set_task_id_min
int vine_set_task_id_min(struct vine_manager *m, int minid)
Set the minimum task_id of future submitted tasks.
vine_task_set_monitor_output
int vine_task_set_monitor_output(struct vine_task *t, const char *monitor_output)
Specify a custom name for the monitoring summary.
vine_file_source
const char * vine_file_source(struct vine_file *f)
Get the filename of the file if the file is local to the manager.
vine_unblock_host
void vine_unblock_host(struct vine_manager *m, const char *hostname)
Unblock host from a manager.
vine_task_get_category
const char * vine_task_get_category(struct vine_task *t)
Get the category associated with the task.
vine_task_set_tag
void vine_task_set_tag(struct vine_task *t, const char *tag)
Attach a user defined string tag to the task.
vine_cancel_by_task_id
int vine_cancel_by_task_id(struct vine_manager *m, int id)
Cancel a submitted task using its task id.
vine_hungry
int vine_hungry(struct vine_manager *m)
Determine whether the manager is 'hungry' for more tasks.
vine_manager_remove_library
void vine_manager_remove_library(struct vine_manager *m, const char *name)
Indicate the library to be removed from all connected workers.
vine_declare_temp
struct vine_file * vine_declare_temp(struct vine_manager *m)
Create a scratch file object.
vine_set_catalog_servers
void vine_set_catalog_servers(struct vine_manager *m, const char *hosts)
Specify the catalog server(s) the manager should report to.
vine_set_resources_min
void vine_set_resources_min(struct vine_manager *m, const struct rmsummary *rm)
Sets the minimum resources a task without an explicit category ("default" category).
vine_summarize_workers
struct rmsummary ** vine_summarize_workers(struct vine_manager *m)
Summary data for all workers in buffer.
vine_set_runtime_info_path
void vine_set_runtime_info_path(const char *path)
Sets the path where runtime info directories (logs and staging) are created.
vine_wait_for_task_id
struct vine_task * vine_wait_for_task_id(struct vine_manager *m, int task_id, int timeout)
Wait for a task with a given task_id to complete.
vine_cancel_by_task_tag
int vine_cancel_by_task_tag(struct vine_manager *m, const char *tag)
Cancel a submitted task using its tag and remove it from manager.
vine_enable_monitoring
int vine_enable_monitoring(struct vine_manager *m, int watchdog, int time_series)
Enables resource monitoring for tasks.
vine_task_get_result
vine_result_t vine_task_get_result(struct vine_task *t)
Get the end result of the task.
vine_fetch_file
const char * vine_fetch_file(struct vine_manager *m, struct vine_file *f)
Fetch the contents of a file.
vine_tune
int vine_tune(struct vine_manager *m, const char *name, double value)
Tune advanced parameters for manager.
vine_mount_flags_t
vine_mount_flags_t
Select optional handling for input and output files: caching, unpacking, watching,...
Definition taskvine.h:43
VINE_TRANSFER_ALWAYS
@ VINE_TRANSFER_ALWAYS
Always transfer this file when needed.
Definition taskvine.h:44
VINE_RETRACT_ON_RESET
@ VINE_RETRACT_ON_RESET
Remove this file from the mount lists if the task is reset.
Definition taskvine.h:51
VINE_WATCH
@ VINE_WATCH
Watch the output file and send back changes as the task runs.
Definition taskvine.h:47
VINE_MOUNT_SYMLINK
@ VINE_MOUNT_SYMLINK
Permit this directory to be mounted via symlink instead of hardlink.
Definition taskvine.h:53
VINE_MOUNT_MKDIR
@ VINE_MOUNT_MKDIR
Create this empty output directory in the task sandbox prior to execution.
Definition taskvine.h:54
VINE_SUCCESS_ONLY
@ VINE_SUCCESS_ONLY
Only return this output file if the task succeeded.
Definition taskvine.h:50
VINE_FIXED_LOCATION
@ VINE_FIXED_LOCATION
Never transfer input files with this flag to a worker for execution.
Definition taskvine.h:45
VINE_FAILURE_ONLY
@ VINE_FAILURE_ONLY
Only return this output file if the task failed.
Definition taskvine.h:48
vine_task_get_tag
const char * vine_task_get_tag(struct vine_task *t)
Get the tag associated with the task.
vine_get_effective_bandwidth
double vine_get_effective_bandwidth(struct vine_manager *m)
Get current manager bandwidth.
vine_task_set_library_required
void vine_task_set_library_required(struct vine_task *t, const char *name)
Set the library name required by this task.
vine_disable_proportional_resources
int vine_disable_proportional_resources(struct vine_manager *m)
Disable proportional resources.
vine_get_stats
void vine_get_stats(struct vine_manager *m, struct vine_stats *s)
Get manager statistics (only from manager).
vine_task_set_command
void vine_task_set_command(struct vine_task *t, const char *cmd)
Indicate the command to be executed.
vine_file_flags_t
vine_file_flags_t
Control sharing and garbage collection behavior of file objects.
Definition taskvine.h:66
VINE_PEER_NOSHARE
@ VINE_PEER_NOSHARE
Schedule this file to be shared between peers where available.
Definition taskvine.h:67
VINE_UNLINK_WHEN_DONE
@ VINE_UNLINK_WHEN_DONE
Whether to delete the file when its reference count is 0.
Definition taskvine.h:69
vine_enable_debug_log
int vine_enable_debug_log(const char *logfile)
Turn on the debugging log output and send to the named file.
vine_unblock_all
void vine_unblock_all(struct vine_manager *m)
Unblock all host.
vine_task_set_function_slots
void vine_task_set_function_slots(struct vine_task *t, int nslots)
Set the number of concurrent functions a library can run.
vine_file_type_t
vine_file_type_t
The type of an input or output file to attach to a task.
Definition taskvine.h:144
VINE_URL
@ VINE_URL
A file obtained by downloading from a URL.
Definition taskvine.h:146
VINE_BUFFER
@ VINE_BUFFER
A file obtained from data in the manager's memory space.
Definition taskvine.h:148
VINE_MINI_TASK
@ VINE_MINI_TASK
A file obtained by executing a Unix command line.
Definition taskvine.h:149
VINE_FILE
@ VINE_FILE
A file or directory present at the manager.
Definition taskvine.h:145
VINE_TEMP
@ VINE_TEMP
A temporary file created as an output of a task.
Definition taskvine.h:147
vine_file_size
size_t vine_file_size(struct vine_file *f)
Get the length of a vine file.
vine_get_status
char * vine_get_status(struct vine_manager *m, const char *request)
Get manager information as json.
vine_block_host_with_timeout
void vine_block_host_with_timeout(struct vine_manager *m, const char *hostname, time_t seconds)
Block workers in hostname from a manager, but remove block after timeout seconds.
vine_set_priority
void vine_set_priority(struct vine_manager *m, int priority)
Change the priority for a given manager.
vine_task_set_time_end
void vine_task_set_time_end(struct vine_task *t, int64_t useconds)
Specify the maximum end time allowed for the task (in microseconds since the Epoch).
vine_log_debug_app
void vine_log_debug_app(struct vine_manager *q, const char *entry)
Adds a custom APPLICATION entry to the debug log.
vine_disable_peer_transfers
int vine_disable_peer_transfers(struct vine_manager *m)
Disable taskvine peer transfers to be scheduled by the manager.
vine_task_add_feature
void vine_task_add_feature(struct vine_task *t, const char *name)
Label the task with a user-defined feature.
vine_schedule_t
vine_schedule_t
Select overall scheduling algorithm for matching tasks to workers.
Definition taskvine.h:74
VINE_SCHEDULE_WORST
@ VINE_SCHEDULE_WORST
Select the worst fit worker (the worker with more unused resources).
Definition taskvine.h:80
VINE_SCHEDULE_FILES
@ VINE_SCHEDULE_FILES
Select worker that has the most data required by the task.
Definition taskvine.h:77
VINE_SCHEDULE_UNSET
@ VINE_SCHEDULE_UNSET
Internal use only.
Definition taskvine.h:75
VINE_SCHEDULE_TIME
@ VINE_SCHEDULE_TIME
Select worker that has the fastest execution time on previous tasks.
Definition taskvine.h:78
VINE_SCHEDULE_FCFS
@ VINE_SCHEDULE_FCFS
Select worker on a first-come-first-serve basis.
Definition taskvine.h:76
VINE_SCHEDULE_DISK
@ VINE_SCHEDULE_DISK
Select the worker with the largest free disk space.
Definition taskvine.h:81
VINE_SCHEDULE_RAND
@ VINE_SCHEDULE_RAND
Select a random worker.
Definition taskvine.h:79
vine_task_get_hostname
const char * vine_task_get_hostname(struct vine_task *t)
Get the hostname of the worker on which the task ran.
vine_task_set_cores
void vine_task_set_cores(struct vine_task *t, int cores)
Specify the number of cores required by a task.
vine_declare_untar
struct vine_file * vine_declare_untar(struct vine_manager *m, struct vine_file *f, vine_cache_level_t cache, vine_file_flags_t flags)
Create a file object by unpacking a tar archive.
vine_set_property
void vine_set_property(struct vine_manager *m, const char *name, const char *value)
Add a global property to the manager which will be included in periodic reports to the catalog server...
vine_result_t
vine_result_t
Possible outcomes for a task, returned by vine_task_get_result.
Definition taskvine.h:88
VINE_RESULT_MISSING_LIBRARY
@ VINE_RESULT_MISSING_LIBRARY
The task is a function requiring a library that does not exist.
Definition taskvine.h:111
VINE_RESULT_RESOURCE_EXHAUSTION
@ VINE_RESULT_RESOURCE_EXHAUSTION
The task used more resources than requested.
Definition taskvine.h:95
VINE_RESULT_SANDBOX_EXHAUSTION
@ VINE_RESULT_SANDBOX_EXHAUSTION
The task used more disk than the allowed sandbox.
Definition taskvine.h:110
VINE_RESULT_MAX_RETRIES
@ VINE_RESULT_MAX_RETRIES
Currently unused.
Definition taskvine.h:99
VINE_RESULT_FORSAKEN
@ VINE_RESULT_FORSAKEN
The task failed, but it was not a task error.
Definition taskvine.h:98
VINE_RESULT_FIXED_LOCATION_MISSING
@ VINE_RESULT_FIXED_LOCATION_MISSING
The task failed because no worker could satisfy the fixed location input file requirements.
Definition taskvine.h:106
VINE_RESULT_LIBRARY_EXIT
@ VINE_RESULT_LIBRARY_EXIT
Task is a library that has terminated.
Definition taskvine.h:109
VINE_RESULT_OUTPUT_MISSING
@ VINE_RESULT_OUTPUT_MISSING
The task ran but failed to generate a specified output file.
Definition taskvine.h:92
VINE_RESULT_SUCCESS
@ VINE_RESULT_SUCCESS
The task ran successfully, and its Unix exit code is given by vine_task_get_exit_code.
Definition taskvine.h:89
VINE_RESULT_UNKNOWN
@ VINE_RESULT_UNKNOWN
The result could not be classified.
Definition taskvine.h:97
VINE_RESULT_SIGNAL
@ VINE_RESULT_SIGNAL
The task was terminated with a signal.
Definition taskvine.h:94
VINE_RESULT_MAX_WALL_TIME
@ VINE_RESULT_MAX_WALL_TIME
The task ran for more than the specified time (relative since running in a worker).
Definition taskvine.h:100
VINE_RESULT_STDOUT_MISSING
@ VINE_RESULT_STDOUT_MISSING
The task ran but its stdout has been truncated.
Definition taskvine.h:93
VINE_RESULT_MAX_END_TIME
@ VINE_RESULT_MAX_END_TIME
The task ran after the specified (absolute since epoch) end time.
Definition taskvine.h:96
VINE_RESULT_OUTPUT_TRANSFER_ERROR
@ VINE_RESULT_OUTPUT_TRANSFER_ERROR
The task failed because an output could be transfered to the manager (not enough disk space,...
Definition taskvine.h:104
VINE_RESULT_INPUT_MISSING
@ VINE_RESULT_INPUT_MISSING
The task cannot be run due to a missing input file.
Definition taskvine.h:91
VINE_RESULT_CANCELLED
@ VINE_RESULT_CANCELLED
The task was cancelled by the caller.
Definition taskvine.h:108
VINE_RESULT_RMONITOR_ERROR
@ VINE_RESULT_RMONITOR_ERROR
The task failed because the monitor did not produce a summary report.
Definition taskvine.h:102
vine_manager_install_library
void vine_manager_install_library(struct vine_manager *m, struct vine_task *t, const char *name)
Indicate the library to be installed on all workers connected to the manager.
vine_task_set_gpus
void vine_task_set_gpus(struct vine_task *t, int gpus)
Specify the number of gpus required by a task.
vine_delete
void vine_delete(struct vine_manager *m)
Delete a manager.
vine_set_manager_preferred_connection
void vine_set_manager_preferred_connection(struct vine_manager *m, const char *preferred_connection)
Set the preference for using hostname over IP address to connect.
vine_set_runtime_info_template
void vine_set_runtime_info_template(const char *template)
Sets the directory where a workflow-specific runtime logs are directly written into.
vine_task_set_priority
void vine_task_set_priority(struct vine_task *t, double priority)
Specify the priority of this task relative to others in the manager.
vine_set_category_resources_max
void vine_set_category_resources_max(struct vine_manager *m, const char *category, const struct rmsummary *rm)
Sets the maximum resources a task in the category may use.
vine_get_path_cache
char * vine_get_path_cache(struct vine_manager *m, const char *path)
Returns path relative to the cache runtime directory.
vine_task_get_id
int vine_task_get_id(struct vine_task *t)
Get the unique ID of the task.
vine_result_string
const char * vine_result_string(vine_result_t result)
Explain result codes from tasks.
vine_file_contents
const char * vine_file_contents(struct vine_file *f)
Get the contents of a vine file.
vine_enable_disconnect_slow_workers
int vine_enable_disconnect_slow_workers(struct vine_manager *m, double multiplier)
Enable disconnect slow workers functionality for a given manager for tasks without an explicit catego...
vine_set_password_file
int vine_set_password_file(struct vine_manager *m, const char *file)
Add a mandatory password file that each worker must present.
vine_task_set_library_provided
void vine_task_set_library_provided(struct vine_task *t, const char *name)
Set the library name provided by this task.
vine_declare_file
struct vine_file * vine_declare_file(struct vine_manager *m, const char *source, vine_cache_level_t cache, vine_file_flags_t flags)
Declare a file object from a local file.
vine_cache_level_t
vine_cache_level_t
Control caching and sharing behavior of file objects.
Definition taskvine.h:58
VINE_CACHE_LEVEL_TASK
@ VINE_CACHE_LEVEL_TASK
Do not cache file at worker.
Definition taskvine.h:59
VINE_CACHE_LEVEL_FOREVER
@ VINE_CACHE_LEVEL_FOREVER
File remains at execution site when worker terminates.
Definition taskvine.h:62
VINE_CACHE_LEVEL_WORKER
@ VINE_CACHE_LEVEL_WORKER
File remains in cache of worker until worker terminates.
Definition taskvine.h:61
VINE_CACHE_LEVEL_WORKFLOW
@ VINE_CACHE_LEVEL_WORKFLOW
File remains in cache of worker until workflow ends.
Definition taskvine.h:60
vine_set_tasks_left_count
void vine_set_tasks_left_count(struct vine_manager *m, int ntasks)
Specify the number of tasks not yet submitted to the manager.
vine_task_set_time_start
void vine_task_set_time_start(struct vine_task *t, int64_t useconds)
Specify the minimum start time allowed for the task (in microseconds since the Epoch).
vine_set_password
void vine_set_password(struct vine_manager *m, const char *password)
Add a mandatory password that each worker must present.
vine_declare_url
struct vine_file * vine_declare_url(struct vine_manager *m, const char *url, vine_cache_level_t cache, vine_file_flags_t flags)
Declare a file object from a remote URL.
vine_task_add_input
int vine_task_add_input(struct vine_task *t, struct vine_file *f, const char *remote_name, vine_mount_flags_t flags)
Add a general file object as a input to a task.
vine_create
struct vine_manager * vine_create(int port)
Create a new manager.
vine_declare_starch
struct vine_file * vine_declare_starch(struct vine_manager *m, struct vine_file *f, vine_cache_level_t cache, vine_file_flags_t flags)
Create a file object by unpacking a starch package.
vine_task_get_library_required
const char * vine_task_get_library_required(struct vine_task *t)
Get the library name required by this task.
vine_declare_chirp
struct vine_file * vine_declare_chirp(struct vine_manager *m, const char *server, const char *source, struct vine_file *ticket, struct vine_file *env, vine_cache_level_t cache, vine_file_flags_t flags)
Create a file object of a remote file accessible from a chirp server.
vine_task_add_output
int vine_task_add_output(struct vine_task *t, struct vine_file *f, const char *remote_name, vine_mount_flags_t flags)
Add a general file object as a output of a task.
vine_declare_buffer
struct vine_file * vine_declare_buffer(struct vine_manager *m, const char *buffer, size_t size, vine_cache_level_t cache, vine_file_flags_t flags)
Create a file object from a data buffer.
vine_task_delete
void vine_task_delete(struct vine_task *t)
Delete a task.
vine_task_get_stdout
const char * vine_task_get_stdout(struct vine_task *t)
Get the standard output of the task.
vine_workers_shutdown
int vine_workers_shutdown(struct vine_manager *m, int n)
Shut down workers connected to the manager.
vine_task_get_resources
const struct rmsummary * vine_task_get_resources(struct vine_task *t, const char *name)
Get resource information (e.g., cores, memory, and disk) of a completed task.
vine_manager_find_library_template
struct vine_task * vine_manager_find_library_template(struct vine_manager *q, const char *library_name)
Find a library template on the manager.
vine_get_path_log
char * vine_get_path_log(struct vine_manager *m, const char *path)
Returns path relative to the logs runtime directory.
vine_file_type
vine_file_type_t vine_file_type(struct vine_file *f)
Get the type of file.
vine_task_set_env_var
void vine_task_set_env_var(struct vine_task *t, const char *name, const char *value)
Specify an environment variable to be added to the task.
vine_undeclare_file
void vine_undeclare_file(struct vine_manager *m, struct vine_file *f)
Un-declare a file that was created by vine_declare_file or similar functions.
vine_declare_poncho
struct vine_file * vine_declare_poncho(struct vine_manager *m, struct vine_file *f, vine_cache_level_t cache, vine_file_flags_t flags)
Create a file object by unpacking a poncho package.
vine_log_txn_app
void vine_log_txn_app(struct vine_manager *q, const char *entry)
Adds a custom APPLICATION entry to the transactions log.
vine_set_category_mode
int vine_set_category_mode(struct vine_manager *m, const char *category, vine_category_mode_t mode)
Turn on or off first-allocation labeling for a given category.
vine_set_keepalive_interval
void vine_set_keepalive_interval(struct vine_manager *m, int interval)
Change the keepalive interval for a given manager.
vine_task_set_time_min
void vine_task_set_time_min(struct vine_task *t, int64_t seconds)
Specify the minimum time (in seconds) the task is expected to run in a worker.
vine_task_set_resources
void vine_task_set_resources(struct vine_task *t, const struct rmsummary *rm)
Set the expected resource consumption of a task before execution.
vine_cancel_all
int vine_cancel_all(struct vine_manager *m)
Cancel all submitted tasks and remove them from the manager.
vine_task_get_metric
int64_t vine_task_get_metric(struct vine_task *t, const char *name)
Get a performance metric of a completed task.
vine_wait
struct vine_task * vine_wait(struct vine_manager *m, int timeout)
Wait for a task to complete.
vine_enable_proportional_resources
int vine_enable_proportional_resources(struct vine_manager *m)
When enabled, resources to tasks in are assigned in proportion to the size of the worker.
vine_file_replica_count
int vine_file_replica_count(struct vine_manager *m, struct vine_file *f)
Get the number of replicas of a file.
vine_task_set_retries
void vine_task_set_retries(struct vine_task *t, int64_t max_retries)
Specify the number of times this task is retried on worker errors.
vine_task_get_command
const char * vine_task_get_command(struct vine_task *t)
Get the command line of the task.
vine_enable_transactions_log
int vine_enable_transactions_log(struct vine_manager *m, const char *logfile)
Add a log file that records the states of the connected workers and tasks.
vine_get_stats_category
void vine_get_stats_category(struct vine_manager *m, const char *c, struct vine_stats *s)
Get the task statistics for the given category.
vine_counters_print
void vine_counters_print()
Display internal reference counts for troubleshooting purposes.
vine_task_get_library_provided
const char * vine_task_get_library_provided(struct vine_task *t)
Get the library name provided by this task.
vine_port
int vine_port(struct vine_manager *m)
Get the listening port of the manager.
vine_set_resources_max
void vine_set_resources_max(struct vine_manager *m, const struct rmsummary *rm)
Sets the maximum resources a task without an explicit category ("default" category).
vine_task_set_function_exec_mode_from_string
void vine_task_set_function_exec_mode_from_string(struct vine_task *t, const char *exec_mode)
Set the execution mode of functions inside a library.
vine_block_host
void vine_block_host(struct vine_manager *m, const char *hostname)
Block workers in hostname from working for manager q.
vine_declare_mini_task
struct vine_file * vine_declare_mini_task(struct vine_manager *m, struct vine_task *mini_task, const char *name, vine_cache_level_t cache, vine_file_flags_t flags)
Create a file object produced from a mini-task Attaches a task definition to produce an input file by...
vine_ssl_create
struct vine_manager * vine_ssl_create(int port, const char *key, const char *cert)
Create a new manager using SSL.
vine_task_get_exit_code
int vine_task_get_exit_code(struct vine_task *t)
Get the Unix exit code of the task.
vine_set_bandwidth_limit
void vine_set_bandwidth_limit(struct vine_manager *m, const char *bandwidth)
Limit the manager bandwidth when transferring files to and from workers.
vine_empty
int vine_empty(struct vine_manager *m)
Determine whether the manager is empty.
vine_category_mode_t
vine_category_mode_t
Select how to allocate resources for similar tasks with vine_set_category_mode.
Definition taskvine.h:116
VINE_ALLOCATION_MODE_FIXED
@ VINE_ALLOCATION_MODE_FIXED
When monitoring is disabled, all tasks run as VINE_ALLOCATION_MODE_FIXED.
Definition taskvine.h:120
VINE_ALLOCATION_MODE_MIN_WASTE
@ VINE_ALLOCATION_MODE_MIN_WASTE
As above, but tasks are first tried with an automatically computed allocation to minimize resource wa...
Definition taskvine.h:133
VINE_ALLOCATION_MODE_MAX_THROUGHPUT
@ VINE_ALLOCATION_MODE_MAX_THROUGHPUT
As above, but maximizing throughput.
Definition taskvine.h:136
VINE_ALLOCATION_MODE_MAX
@ VINE_ALLOCATION_MODE_MAX
When monitoring is enabled, tasks are tried with maximum specified values of cores,...
Definition taskvine.h:129
vine_prune_file
void vine_prune_file(struct vine_manager *m, struct vine_file *f)
Prune a file among the cluster.
vine_task_set_time_max
void vine_task_set_time_max(struct vine_task *t, int64_t seconds)
Specify the maximum time (in seconds) the task is allowed to run in a worker.
vine_set_name
void vine_set_name(struct vine_manager *m, const char *name)
Change the project name for a given manager.
vine_set_category_first_allocation_guess
void vine_set_category_first_allocation_guess(struct vine_manager *m, const char *category, const struct rmsummary *rm)
Set the initial guess for resource autolabeling for the given category.
vine_declare_xrootd
struct vine_file * vine_declare_xrootd(struct vine_manager *m, const char *source, struct vine_file *proxy, struct vine_file *env, vine_cache_level_t cache, vine_file_flags_t flags)
Create a file object of a remote file accessible from an xrootd server.
vine_set_category_resources_min
void vine_set_category_resources_min(struct vine_manager *m, const char *category, const struct rmsummary *rm)
Sets the minimum resources a task in the category may use.
vine_enable_perf_log
int vine_enable_perf_log(struct vine_manager *m, const char *logfile)
Add a performance log file that records cummulative statistics of the connected workers and submitted...
vine_wait_for_tag
struct vine_task * vine_wait_for_tag(struct vine_manager *m, const char *tag, int timeout)
Wait for a task with a given task to complete.
vine_get_path_staging
char * vine_get_path_staging(struct vine_manager *m, const char *path)
Returns path relative to the staging runtime directory.
vine_task_get_state
const char * vine_task_get_state(struct vine_task *t)
Get the state line of the task.
vine_task_set_category
void vine_task_set_category(struct vine_task *t, const char *category)
Label the task with the given category.
vine_task_create
struct vine_task * vine_task_create(const char *full_command)
Create a new task object.
vine_set_scheduler
void vine_set_scheduler(struct vine_manager *m, vine_schedule_t algorithm)
Change the worker selection algorithm.
vine_initialize_categories
void vine_initialize_categories(struct vine_manager *m, struct rmsummary *max, const char *summaries_file)
Initialize first value of categories.
vine_task_add_execution_context
int vine_task_add_execution_context(struct vine_task *t, struct vine_file *f)
Adds an execution context to the task.
vine_enable_peer_transfers
int vine_enable_peer_transfers(struct vine_manager *m)
Enable taskvine peer transfers to be scheduled by the manager.
vine_enable_disconnect_slow_workers_category
int vine_enable_disconnect_slow_workers_category(struct vine_manager *m, const char *category, double multiplier)
Enable disconnect slow workers functionality for a given category.
vine_file_set_mode
void vine_file_set_mode(struct vine_file *f, int mode)
Set the Unix mode permission bits of a declared file.
vine_submit
int vine_submit(struct vine_manager *m, struct vine_task *t)
Submit a task to a manager.
vine_task_get_addrport
const char * vine_task_get_addrport(struct vine_task *t)
Get the address and port of the worker on which the task ran.
vine_set_draining_by_hostname
int vine_set_draining_by_hostname(struct vine_manager *m, const char *hostname, int drain_flag)
Set the draining mode per worker hostname.
vine_get_name
const char * vine_get_name(struct vine_manager *m)
Get the project name of the manager.
vine_set_category_max_concurrent
void vine_set_category_max_concurrent(struct vine_manager *m, const char *category, int max_concurrent)
Set a maximum number of tasks of this category that can execute concurrently.
vine_get_path_library_log
char * vine_get_path_library_log(struct vine_manager *m, const char *path)
Returns path relative to the library logs runtime directory.
vine_enable_taskgraph_log
int vine_enable_taskgraph_log(struct vine_manager *m, const char *logfile)
Add an output log that produces the taskgraph in Grapvhiz Dot format.
vine_set_keepalive_timeout
void vine_set_keepalive_timeout(struct vine_manager *m, int timeout)
Change the keepalive timeout for identifying dead workers for a given manager.
vine_task_add_poncho_package
int vine_task_add_poncho_package(struct vine_task *t, struct vine_file *f)
Add a Poncho package as an execution context.
timestamp.h
Portable routines for high resolution timing.
timestamp_t
UINT64_T timestamp_t
A type to hold the current time, in microseconds since January 1st, 1970.
Definition timestamp.h:20