A workflow (to be executed by a WMS) More...

#include <Workflow.h>

Public Member Functions

 Workflow ()
 Constructor.
 
void addControlDependency (WorkflowTask *, WorkflowTask *)
 Create a control dependency between two workflow tasks. Will not do anything if there is already a path between the two tasks. More...
 
WorkflowFileaddFile (std::string, double)
 Add a new file to the workflow. More...
 
WorkflowTaskaddTask (std::string, double flops, unsigned long min_num_cores, unsigned long max_num_cores, double parallel_efficiency, double memory_requirement, WorkflowTask::TaskType type=WorkflowTask::TaskType::COMPUTE)
 Create and add a new computational task to the workflow. More...
 
void exportToEPS (std::string)
 Output the workflow's dependency graph to EPS. More...
 
std::string getCallbackMailbox ()
 Get the mailbox name associated to this workflow. More...
 
double getCompletionDate ()
 Sets the number of levels in the workflow. More...
 
WorkflowFilegetFileByID (std::string)
 Find a WorkflowFile based on its ID. More...
 
std::vector< WorkflowFile * > getFiles ()
 Get the list of all files in the workflow. More...
 
std::map< std::string,
WorkflowFile * > 
getInputFiles ()
 Retrieve a map (indexed by file id) of input files for a workflow (i.e., those files that are input to some tasks but output from none) More...
 
unsigned long getNumberOfTasks ()
 Get the number of tasks in the workflow. More...
 
unsigned long getNumLevels ()
 Returns the number of levels in the workflow. More...
 
std::map< std::string,
std::vector< WorkflowTask * > > 
getReadyClusters ()
 Get a map of clusters composed of ready tasks. More...
 
std::vector< WorkflowTask * > getReadyTasks ()
 Get a vector of ready tasks. More...
 
WorkflowTaskgetTaskByID (std::string)
 Find a WorkflowTask based on its ID. More...
 
std::vector< WorkflowTask * > getTaskChildren (const WorkflowTask *task)
 Get the list of children for a task. More...
 
std::vector< WorkflowTask * > getTaskParents (const WorkflowTask *task)
 Get the list of parents for a task. More...
 
std::vector< WorkflowTask * > getTasks ()
 Get the list of all tasks in the workflow. More...
 
std::vector< WorkflowTask * > getTasksInTopLevelRange (unsigned long min, unsigned long max)
 Returns all tasks with top-levels in a range. More...
 
bool isDone ()
 Returns whether all tasks are complete. More...
 
void loadFromDAX (const std::string &filename, const std::string &reference_flop_rate)
 Create a workflow based on a DAX file. More...
 
void loadFromJSON (const std::string &filename, const std::string &reference_flop_rate)
 Create a workflow based on a JSON file. More...
 
void removeTask (WorkflowTask *task)
 Remove a task from the workflow. WARNING: this method de-allocated memory for the task, making any pointer to the task invalid. More...
 
std::unique_ptr
< WorkflowExecutionEvent
waitForNextExecutionEvent ()
 Wait for the next worklow execution event. More...
 

Static Public Member Functions

static double getSumFlops (std::vector< WorkflowTask * > tasks)
 Get the total number of flops for a list of tasks. More...
 

Detailed Description

A workflow (to be executed by a WMS)

Member Function Documentation

void wrench::Workflow::addControlDependency ( WorkflowTask src,
WorkflowTask dst 
)

Create a control dependency between two workflow tasks. Will not do anything if there is already a path between the two tasks.

Parameters
srcthe parent task
dstthe child task
Exceptions
std::invalid_argument
WorkflowFile * wrench::Workflow::addFile ( std::string  id,
double  size 
)

Add a new file to the workflow.

Parameters
ida unique string id
sizea file size in bytes
Returns
the WorkflowFile instance
Exceptions
std::invalid_argument
WorkflowTask * wrench::Workflow::addTask ( std::string  id,
double  flops,
unsigned long  min_num_cores,
unsigned long  max_num_cores,
double  parallel_efficiency,
double  memory_requirement,
WorkflowTask::TaskType  type = WorkflowTask::TaskType::COMPUTE 
)

Create and add a new computational task to the workflow.

Parameters
ida unique string id
flopsnumber of flops
min_num_coresthe minimum number of cores required to run the task
max_num_coresthe maximum number of cores that can be used by the task (use INT_MAX for infinity)
parallel_efficiencythe multi-core parallel efficiency (number between 0.0 and 1.0)
memory_requirementmemory requirement (in bytes)
typeworkflow task type (WorkflowTask::TaskType)
Returns
the WorkflowTask instance
Exceptions
std::invalid_argument
void wrench::Workflow::exportToEPS ( std::string  eps_filename)

Output the workflow's dependency graph to EPS.

Parameters
eps_filenamea filename to which the EPS content is saved
std::string wrench::Workflow::getCallbackMailbox ( )

Get the mailbox name associated to this workflow.

Returns
the mailbox name
double wrench::Workflow::getCompletionDate ( )

Sets the number of levels in the workflow.

Parameters
num_levelsthe number of levels Returns the workflow's completion date
Returns
a date in seconds (or a negative value If the workflow has not completed)
WorkflowFile * wrench::Workflow::getFileByID ( std::string  id)

Find a WorkflowFile based on its ID.

Parameters
ida string id
Returns
the WorkflowFile instance (or throws a std::invalid_argument if not found)
Exceptions
std::invalid_argument
std::vector< WorkflowFile * > wrench::Workflow::getFiles ( )

Get the list of all files in the workflow.

Returns
a vector of files
std::map< std::string, WorkflowFile * > wrench::Workflow::getInputFiles ( )

Retrieve a map (indexed by file id) of input files for a workflow (i.e., those files that are input to some tasks but output from none)

Returns
a std::map of files
unsigned long wrench::Workflow::getNumberOfTasks ( )

Get the number of tasks in the workflow.

Returns
the number of tasks
unsigned long wrench::Workflow::getNumLevels ( )

Returns the number of levels in the workflow.

Returns
the number of levels
std::map< std::string, std::vector< WorkflowTask * > > wrench::Workflow::getReadyClusters ( )

Get a map of clusters composed of ready tasks.

Returns
map of workflow cluster tasks
std::vector< WorkflowTask * > wrench::Workflow::getReadyTasks ( )

Get a vector of ready tasks.

Returns
a vector of tasks
double wrench::Workflow::getSumFlops ( std::vector< WorkflowTask * >  tasks)
static

Get the total number of flops for a list of tasks.

Parameters
taskslist of tasks
Returns
the total number of flops
WorkflowTask * wrench::Workflow::getTaskByID ( std::string  id)

Find a WorkflowTask based on its ID.

Parameters
ida string id
Returns
a workflow task (or throws a std::invalid_argument if not found)
Exceptions
std::invalid_argument
std::vector< WorkflowTask * > wrench::Workflow::getTaskChildren ( const WorkflowTask task)

Get the list of children for a task.

Parameters
taska workflow task
Returns
a vector of tasks
std::vector< WorkflowTask * > wrench::Workflow::getTaskParents ( const WorkflowTask task)

Get the list of parents for a task.

Parameters
taska workflow task
Returns
a vector of tasks
std::vector< WorkflowTask * > wrench::Workflow::getTasks ( )

Get the list of all tasks in the workflow.

Returns
a vector of tasks
std::vector< WorkflowTask * > wrench::Workflow::getTasksInTopLevelRange ( unsigned long  min,
unsigned long  max 
)

Returns all tasks with top-levels in a range.

Parameters
minthe low end of the range (inclusive)
maxthe high end of the range (inclusive)
Returns
a vector of tasks
bool wrench::Workflow::isDone ( )

Returns whether all tasks are complete.

Returns
true or false
void wrench::Workflow::loadFromDAX ( const std::string &  filename,
const std::string &  reference_flop_rate 
)

Create a workflow based on a DAX file.

Parameters
filenamethe path to the DAX file
reference_flop_ratea reference compute speed (in flops/sec), assuming a task's computation is purely flops. This is needed because DAX files specify task execution times in seconds, but the WRENCH simulation needs some notion of "amount of computation" to apply reasonable scaling. (Because the XML platform description specifies host compute speeds in flops/sec). The times in the DAX file are thus asume to be obtained on an machine with flop rate reference_flop_rate.
Exceptions
std::invalid_argument
void wrench::Workflow::loadFromJSON ( const std::string &  filename,
const std::string &  reference_flop_rate 
)

Create a workflow based on a JSON file.

Parameters
filenamethe path to the JSON file
reference_flop_ratea reference compute speed (in flops/sec), assuming a task's computation is purely flops. This is needed because JSON files specify task execution times in seconds, but the WRENCH simulation needs some notion of "amount of computation" to apply reasonable scaling. (Because the XML platform description specifies host compute speeds in flops/sec). The times in the JSON file are thus asume to be obtained on an machine with flop rate reference_flop_rate.
Exceptions
std::invalid_argument
void wrench::Workflow::removeTask ( WorkflowTask task)

Remove a task from the workflow. WARNING: this method de-allocated memory for the task, making any pointer to the task invalid.

Parameters
taska task
Exceptions
std::invalid_argument
std::unique_ptr< WorkflowExecutionEvent > wrench::Workflow::waitForNextExecutionEvent ( )

Wait for the next worklow execution event.

Returns
a workflow execution event

The documentation for this class was generated from the following files:
  • /home/wrench/wrench/include/wrench/workflow/Workflow.h
  • /home/wrench/wrench/src/wrench/workflow/Workflow.cpp