work_queue.h

Go to the documentation of this file.
00001 /*
00002 Copyright (C) 2008- The University of Notre Dame
00003 This software is distributed under the GNU General Public License.
00004 See the file COPYING for details.
00005 */
00006 
00007 #ifndef WORK_QUEUE_H
00008 #define WORK_QUEUE_H
00009 
00020 #include <sys/types.h>
00021 #include "timestamp.h"
00022 
00023 #define WORK_QUEUE_DEFAULT_PORT 9123  
00024 #define WORK_QUEUE_RANDOM_PORT  0    
00025 #define WORK_QUEUE_WAITFORTASK  -1    
00027 #define WORK_QUEUE_SCHEDULE_UNSET 0
00028 #define WORK_QUEUE_SCHEDULE_FCFS         1 
00029 #define WORK_QUEUE_SCHEDULE_FILES        2 
00030 #define WORK_QUEUE_SCHEDULE_TIME         3 
00031 #define WORK_QUEUE_SCHEDULE_RAND         4 
00033 #define WORK_QUEUE_TASK_ORDER_FIFO 0  
00034 #define WORK_QUEUE_TASK_ORDER_LIFO 1  
00036 #define WORK_QUEUE_INPUT  0     
00037 #define WORK_QUEUE_OUTPUT 1     
00039 #define WORK_QUEUE_NOCACHE 0    
00040 #define WORK_QUEUE_CACHE 1      
00041 #define WORK_QUEUE_SYMLINK 2    /* Create a symlink to the file rather than copying it, if possible. */
00042 #define WORK_QUEUE_PREEXIST 4   /* If the filename already exists on the host, use it in place. */
00043 #define WORK_QUEUE_THIRDGET 8   /* Access the file on the client from a shared filesystem */
00044 #define WORK_QUEUE_THIRDPUT 8   /* Access the file on the client from a shared filesystem (included for readability) */
00045 #define WORK_QUEUE_WATCH 16     
00047 #define WORK_QUEUE_RESET_ALL        0  
00048 #define WORK_QUEUE_RESET_KEEP_TASKS 1  
00050 #define WORK_QUEUE_DEFAULT_KEEPALIVE_INTERVAL 300  
00051 #define WORK_QUEUE_DEFAULT_KEEPALIVE_TIMEOUT 30    
00053 #define WORK_QUEUE_RESULT_SUCCESS 0                
00054 #define WORK_QUEUE_RESULT_INPUT_MISSING 1  
00055 #define WORK_QUEUE_RESULT_OUTPUT_MISSING 2 
00056 #define WORK_QUEUE_RESULT_STDOUT_MISSING 4 
00057 #define WORK_QUEUE_RESULT_SIGNAL         8 
00058 #define WORK_QUEUE_RESULT_RESOURCE_EXHAUSTION 16 
00059 #define WORK_QUEUE_RESULT_TASK_TIMEOUT 32 
00061 extern double wq_option_fast_abort_multiplier; 
00063 extern int wq_option_scheduler; 
00067 struct work_queue_task {
00068         char *tag;                      
00069         char *command_line;             
00070         int worker_selection_algorithm;           
00071         char *output;                   
00072         struct list *input_files;       
00073         struct list *output_files;      
00074         int taskid;                     
00075         int return_status;              
00076         int result;                     
00077         char *host;                     
00078         char *hostname;                 
00080         timestamp_t time_committed;     
00082         timestamp_t time_task_submit;   
00083         timestamp_t time_task_finish;   
00084         timestamp_t time_send_input_start;      
00085         timestamp_t time_send_input_finish;     
00086         timestamp_t time_execute_cmd_start;                 
00087         timestamp_t time_execute_cmd_finish;            
00088         timestamp_t time_receive_result_start;  
00089         timestamp_t time_receive_result_finish; 
00090         timestamp_t time_receive_output_start;  
00091         timestamp_t time_receive_output_finish; 
00093         int64_t total_bytes_received;
00094         int64_t total_bytes_sent;
00095         int64_t total_bytes_transferred;
00096         timestamp_t total_transfer_time;    
00097         timestamp_t cmd_execution_time;    
00098         int total_submissions;                     
00099         timestamp_t total_cmd_execution_time;   
00101         int64_t maximum_end_time;                       
00102         int64_t memory;                       
00103         int64_t disk;
00104         int cores;
00105         int gpus;
00106         int unlabeled;
00107         
00108         timestamp_t time_app_delay;      
00109 };
00110 
00113 struct work_queue_stats {
00114         int total_workers_connected;    
00115         int workers_init;               
00116         int workers_idle;               
00117         int workers_busy;               
00118         int total_workers_joined;       
00119         int total_workers_removed;      
00121         int tasks_waiting;              
00122         int tasks_running;              
00123         int tasks_complete;             
00124         int total_tasks_dispatched;     
00125         int total_tasks_complete;       
00126         int total_tasks_failed;         
00127         int total_tasks_cancelled;      
00129         timestamp_t start_time;         
00130         timestamp_t total_send_time;    
00131         timestamp_t total_receive_time; 
00132         timestamp_t total_good_transfer_time;    
00134         timestamp_t total_execute_time; 
00135         timestamp_t total_good_execute_time; 
00138         int64_t total_bytes_sent;       
00139         int64_t total_bytes_received;   
00140         double efficiency;              
00141         double idle_percentage;         
00142         int capacity;                   
00144         double  bandwidth;              
00145         int64_t total_cores;            
00146         int64_t total_memory;           
00147         int64_t total_disk;                 
00148         int64_t total_gpus;             
00149         int64_t committed_cores;        
00150         int64_t committed_memory;       
00151         int64_t committed_disk;         
00152         int64_t committed_gpus;         
00153         int64_t min_cores;              
00154         int64_t max_cores;              
00155         int64_t min_memory;             
00156         int64_t max_memory;             
00157         int64_t min_disk;               
00158         int64_t max_disk;               
00159         int64_t min_gpus;               
00160         int64_t max_gpus;               
00161         int port;                                               
00162         int priority;                                   
00163         int workers_ready;              
00164         int workers_full;               
00165         int total_worker_slots;         
00166         int avg_capacity;               
00167 };
00168 
00169 
00173 
00181 struct work_queue_task *work_queue_task_create(const char *full_command);
00182 
00188 struct work_queue_task *work_queue_task_clone(const struct work_queue_task *task);
00189 
00194 void work_queue_task_specify_command( struct work_queue_task *t, const char *cmd );
00195 
00212 int work_queue_task_specify_file(struct work_queue_task *t, const char *local_name, const char *remote_name, int type, int flags);
00213 
00228 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, int type, int flags);
00229 
00240 int work_queue_task_specify_buffer(struct work_queue_task *t, const char *data, int length, const char *remote_name, int flags);
00241 
00255 int work_queue_task_specify_directory(struct work_queue_task *t, const char *local_name, const char *remote_name, int type, int flags, int recursive);
00256 
00262 void work_queue_task_specify_memory( struct work_queue_task *t, int64_t memory );
00263 
00269 void work_queue_task_specify_disk( struct work_queue_task *t, int64_t disk );
00270 
00276 void work_queue_task_specify_cores( struct work_queue_task *t, int cores );
00277 
00283 void work_queue_task_specify_gpus( struct work_queue_task *t, int gpus );
00284 
00290 void work_queue_task_specify_end_time( struct work_queue_task *t, int64_t seconds );
00291 
00298 void work_queue_task_specify_tag(struct work_queue_task *t, const char *tag);
00299 
00309 void work_queue_task_specify_algorithm(struct work_queue_task *t, int algo );
00310 
00315 void work_queue_task_delete(struct work_queue_task *t);
00316 
00318 
00322 
00339 struct work_queue *work_queue_create(int port);
00340 
00348 int work_queue_enable_monitoring(struct work_queue *q, char *monitor_summary_file);
00349 
00358 int work_queue_submit(struct work_queue *q, struct work_queue_task *t);
00359 
00364 void work_queue_blacklist_add(struct work_queue *q, const char *hostname);
00365 
00366 
00371 void work_queue_blacklist_remove(struct work_queue *q, const char *hostname);
00372 
00373 
00377 void work_queue_blacklist_clear(struct work_queue *q);
00378 
00393 struct work_queue_task *work_queue_wait(struct work_queue *q, int timeout);
00394 
00406 int work_queue_hungry(struct work_queue *q);
00407 
00415 int work_queue_empty(struct work_queue *q);
00416 
00423 int work_queue_port(struct work_queue *q);
00424 
00429 void work_queue_get_stats(struct work_queue *q, struct work_queue_stats *s);
00430 
00435 void work_queue_get_stats_hierarchy(struct work_queue *q, struct work_queue_stats *s);
00436 
00441 void work_queue_set_bandwidth_limit(struct work_queue *q, const char *bandwidth);
00442 
00447 double work_queue_get_effective_bandwidth(struct work_queue *q);
00448 
00455 char * work_queue_get_worker_summary( struct work_queue *q );
00456 
00462 int work_queue_activate_fast_abort(struct work_queue *q, double multiplier);
00463 
00464 
00468 int work_queue_send_receive_ratio(struct work_queue *q, double ratio);
00469 
00481 void work_queue_specify_algorithm(struct work_queue *q, int algo);
00482 
00492 void work_queue_specify_task_order(struct work_queue *q, int order);
00493 
00498 const char *work_queue_name(struct work_queue *q);
00499 
00504 void work_queue_specify_name(struct work_queue *q, const char *name);
00505 
00510 void work_queue_specify_priority(struct work_queue *q, int priority);
00511 
00517 void work_queue_specify_catalog_server(struct work_queue *q, const char *hostname, int port);
00518 
00524 struct work_queue_task *work_queue_cancel_by_taskid(struct work_queue *q, int id);
00525 
00531 struct work_queue_task *work_queue_cancel_by_tasktag(struct work_queue *q, const char *tag);
00532 
00537 struct list * work_queue_cancel_all_tasks(struct work_queue *q);
00538 
00543 int work_queue_shut_down_workers(struct work_queue *q, int n);
00544 
00549 void work_queue_delete(struct work_queue *q);
00550 
00556 int work_queue_specify_log(struct work_queue *q, const char *logfile);
00557 
00563 void work_queue_specify_password( struct work_queue *q, const char *password );
00564 
00571 int work_queue_specify_password_file( struct work_queue *q, const char *file );
00572 
00577 void work_queue_specify_keepalive_interval(struct work_queue *q, int interval);
00578 
00583 void work_queue_specify_keepalive_timeout(struct work_queue *q, int timeout);
00584 
00585 
00601 int work_queue_tune(struct work_queue *q, const char *name, double value);
00602 
00604 
00608 
00609 #define WORK_QUEUE_MASTER_MODE_STANDALONE 0 
00610 #define WORK_QUEUE_MASTER_MODE_CATALOG 1    
00619 void work_queue_specify_master_mode(struct work_queue *q, int mode);
00620 
00626 void work_queue_specify_estimate_capacity_on(struct work_queue *q, int estimate_capacity_on);
00627 
00636 int work_queue_task_specify_input_buf(struct work_queue_task *t, const char *buf, int length, const char *rname);
00637 
00645 int work_queue_task_specify_input_file(struct work_queue_task *t, const char *fname, const char *rname);
00646 
00654 int work_queue_task_specify_input_file_do_not_cache(struct work_queue_task *t, const char *fname, const char *rname);
00655 
00663 int work_queue_task_specify_output_file(struct work_queue_task *t, const char *rname, const char *fname);
00664 
00672 int work_queue_task_specify_output_file_do_not_cache(struct work_queue_task *t, const char *rname, const char *fname);
00673 
00675 
00676 /* Experimental feature - intentionally left undocumented.
00677 This feature exists to simplify performance evaulation and is not recommended
00678 for production use since it delays execution of the workload. 
00679 Force the master to wait for the given number of workers to connect before
00680 starting to dispatch tasks.  
00681 @param q A work queue object.
00682 @param worker The number of workers to wait before tasks are dispatched.*/
00683 void work_queue_activate_worker_waiting(struct work_queue *q, int resources);
00684 
00685 #endif

Generated on 8 Sep 2014 for cctools by  doxygen 1.6.1