A workflow management system (WMS) More...

#include <WMS.h>

Inheritance diagram for wrench::WMS:
wrench::Service wrench::S4U_Daemon wrench::WorkloadTraceFileReplayer wrench::WorkloadTraceFileReplayerEventReceiver

Public Member Functions

void addDynamicOptimization (std::unique_ptr< DynamicOptimization >)
 Add a dynamic optimization to the list of optimizations. Optimizations are executed in order of insertion. More...
 
void addStaticOptimization (std::unique_ptr< StaticOptimization >)
 Add a static optimization to the list of optimizations. Optimizations are executed in order of insertion. More...
 
void addWorkflow (Workflow *workflow, double start_time=0)
 Assign a workflow to the WMS. More...
 
PilotJobSchedulergetPilotJobScheduler ()
 Get the WMS's pilot scheduler. More...
 
StandardJobSchedulergetStandardJobScheduler ()
 Get the WMS's pilot scheduler. More...
 
WorkflowgetWorkflow ()
 Get the workflow that was assigned to the WMS. More...
 
- Public Member Functions inherited from wrench::Service
std::string getHostname ()
 Get the name of the host on which the service is / will be running. More...
 
double getMessagePayloadValueAsDouble (std::string)
 Get a message payload of the Service as a double. More...
 
std::string getMessagePayloadValueAsString (std::string)
 Get a message payload of the Service as a string. More...
 
double getNetworkTimeoutValue ()
 Returns the service's network timeout value. More...
 
bool getPropertyValueAsBoolean (std::string)
 Get a property of the Service as a boolean. More...
 
double getPropertyValueAsDouble (std::string)
 Get a property of the Service as a double. More...
 
std::string getPropertyValueAsString (std::string)
 Get a property of the Service as a string. More...
 
bool isUp ()
 Returns true if the service is UP, false otherwise. More...
 
void setNetworkTimeoutValue (double value)
 Sets the service's network timeout value. More...
 
void setStateToDown ()
 Set the state of the service to DOWN.
 
void start (std::shared_ptr< Service > this_service, bool daemonize=false)
 Start the service. More...
 
virtual void stop ()
 Synchronously stop the service (does nothing if the service is already stopped) More...
 
- Public Member Functions inherited from wrench::S4U_Daemon
 S4U_Daemon (std::string hostname, std::string process_name_prefix, std::string mailbox_prefix)
 Constructor (daemon with a mailbox) More...
 
virtual ~S4U_Daemon ()
 Constructor (daemon without a mailbox) More...
 
virtual void cleanup ()
 Cleanup function called when the daemon terminates (for whatever reason)
 
void createLifeSaver (std::shared_ptr< S4U_Daemon > reference)
 Create a life saver for the daemon. More...
 
std::string getName ()
 Retrieve the process name. More...
 
void join ()
 Join (i.e., wait for) the daemon.
 
void resume ()
 Resume the daemon/actor.
 
void setTerminated ()
 Set the terminated status of the daemon/actor.
 
void startDaemon (bool daemonized)
 Start the daemon. More...
 
void suspend ()
 Suspend the daemon/actor.
 

Protected Member Functions

 WMS (std::unique_ptr< StandardJobScheduler > standard_job_scheduler, std::unique_ptr< PilotJobScheduler > pilot_job_scheduler, const std::set< ComputeService * > &compute_services, const std::set< StorageService * > &storage_services, const std::set< NetworkProximityService * > &network_proximity_services, FileRegistryService *file_registry_service, const std::string &hostname, const std::string suffix)
 Constructor: a WMS with a workflow instance, a scheduler implementation, and a list of compute services. More...
 
void checkDeferredStart ()
 Check whether the WMS has a deferred start simulation time (likely the first call in the main() routine of any WMS. More...
 
std::shared_ptr
< DataMovementManager
createDataMovementManager ()
 Instantiate and start a data movement manager. More...
 
std::shared_ptr< JobManagercreateJobManager ()
 Instantiate and start a job manager. More...
 
std::set< ComputeService * > getAvailableComputeServices ()
 Obtain the list of compute services available to the WMS. More...
 
FileRegistryServicegetAvailableFileRegistryService ()
 Obtain the file registry service available to the WMS. More...
 
std::set
< NetworkProximityService * > 
getAvailableNetworkProximityServices ()
 Obtain the list of network proximity services available to the WMS. More...
 
std::set< StorageService * > getAvailableStorageServices ()
 Obtain the list of storage services available to the WMS. More...
 
virtual void processEventFileCopyCompletion (std::unique_ptr< FileCopyCompletedEvent >)
 Process a WorkflowExecutionEvent::FILE_COPY_COMPLETION event. More...
 
virtual void processEventFileCopyFailure (std::unique_ptr< FileCopyFailedEvent >)
 Process a WorkflowExecutionEvent::FILE_COPY_FAILURE event. More...
 
virtual void processEventPilotJobExpiration (std::unique_ptr< PilotJobExpiredEvent >)
 Process a WorkflowExecutionEvent::PILOT_JOB_EXPIRATION event. More...
 
virtual void processEventPilotJobStart (std::unique_ptr< PilotJobStartedEvent >)
 Process a WorkflowExecutionEvent::PILOT_JOB_START event. More...
 
virtual void processEventStandardJobCompletion (std::unique_ptr< StandardJobCompletedEvent >)
 Process a WorkflowExecutionEvent::STANDARD_JOB_COMPLETION. More...
 
virtual void processEventStandardJobFailure (std::unique_ptr< StandardJobFailedEvent >)
 Process a WorkflowExecutionEvent::STANDARD_JOB_FAILURE event. More...
 
void runDynamicOptimizations ()
 Perform dynamic optimizations. Optimizations are executed in order of insertion.
 
void runStaticOptimizations ()
 Perform static optimizations. Optimizations are executed in order of insertion.
 
void waitForAndProcessNextEvent ()
 Wait for a workflow execution event and then call the associated function to process that event. More...
 
- Protected Member Functions inherited from wrench::Service
 Service (std::string hostname, std::string process_name_prefix, std::string mailbox_name_prefix)
 Constructor. More...
 
void serviceSanityCheck ()
 Check whether the service is properly configured and running. More...
 
void setMessagePayload (std::string, std::string)
 Set a message payload of the Service. More...
 
void setMessagePayloads (std::map< std::string, std::string > default_messagepayload_values, std::map< std::string, std::string > overriden_messagepayload_values)
 Set default and user-defined message payloads. More...
 
void setProperties (std::map< std::string, std::string > default_property_values, std::map< std::string, std::string > overriden_property_values)
 Set default and user-defined properties. More...
 
void setProperty (std::string, std::string)
 Set a property of the Service. More...
 
- Protected Member Functions inherited from wrench::S4U_Daemon
void acquireDaemonLock ()
 Lock the daemon's lock.
 
void killActor ()
 Kill the daemon/actor.
 
void releaseDaemonLock ()
 Unlock the daemon's lock.
 

Additional Inherited Members

- Public Types inherited from wrench::Service
enum  State { UP, DOWN }
 Service states. More...
 
- Public Attributes inherited from wrench::S4U_Daemon
std::string hostname
 The name of the host on which the daemon is running.
 
LifeSaver * life_saver = nullptr
 The daemon's life saver.
 
std::string mailbox_name
 The name of the daemon's mailbox.
 
std::string process_name
 The name of the daemon.
 
Simulationsimulation
 a pointer to the simulation object
 
- Protected Attributes inherited from wrench::Service
std::map< std::string,
std::string > 
messagepayload_list
 The service's messagepayload list.
 
std::string name
 The service's name.
 
double network_timeout = 30.0
 The time (in seconds) after which a service that doesn't send back a reply (control) message causes a NetworkTimeOut exception. (default: 30 second; if <0 never timeout)
 
std::map< std::string,
std::string > 
property_list
 The service's property list.
 
State state
 The service's state.
 

Detailed Description

A workflow management system (WMS)

Constructor & Destructor Documentation

wrench::WMS::WMS ( std::unique_ptr< StandardJobScheduler standard_job_scheduler,
std::unique_ptr< PilotJobScheduler pilot_job_scheduler,
const std::set< ComputeService * > &  compute_services,
const std::set< StorageService * > &  storage_services,
const std::set< NetworkProximityService * > &  network_proximity_services,
FileRegistryService file_registry_service,
const std::string &  hostname,
const std::string  suffix 
)
protected

Constructor: a WMS with a workflow instance, a scheduler implementation, and a list of compute services.

Parameters
standard_job_schedulera standard job scheduler implementation (if nullptr then none is used)
pilot_job_schedulera pilot job scheduler implementation (if nullptr then none is used)
compute_servicesa set of compute services available to run jobs (if {} then none is available)
storage_servicesa set of storage services available to the WMS (if {} then none is available)
network_proximity_servicesa set of network proximity services available to the WMS (if {} then none is available)
file_registry_servicea file registry services available to the WMS (if nullptr then none is available)
hostnamethe name of the host on which to run the WMS
suffixa string to append to the WMS process name (useful for debug output)
Exceptions
std::invalid_argument

Member Function Documentation

void wrench::WMS::addDynamicOptimization ( std::unique_ptr< DynamicOptimization optimization)

Add a dynamic optimization to the list of optimizations. Optimizations are executed in order of insertion.

Parameters
optimizationa dynamic optimization implementation
void wrench::WMS::addStaticOptimization ( std::unique_ptr< StaticOptimization optimization)

Add a static optimization to the list of optimizations. Optimizations are executed in order of insertion.

Parameters
optimizationa static optimization implementation
void wrench::WMS::addWorkflow ( Workflow workflow,
double  start_time = 0 
)

Assign a workflow to the WMS.

Parameters
workflowa workflow to execute
start_timethe simulated time when the WMS should start executed the workflow (0 if not specified)
Exceptions
std::invalid_argument

Set the simulation pointer member variable of the workflow so that the workflow tasks have access to it for creating SimulationTimestamps

void wrench::WMS::checkDeferredStart ( )
protected

Check whether the WMS has a deferred start simulation time (likely the first call in the main() routine of any WMS.

Exceptions
std::runtime_error
std::shared_ptr< DataMovementManager > wrench::WMS::createDataMovementManager ( )
protected

Instantiate and start a data movement manager.

Returns
a data movement manager
std::shared_ptr< JobManager > wrench::WMS::createJobManager ( )
protected

Instantiate and start a job manager.

Returns
a job manager
std::set< ComputeService * > wrench::WMS::getAvailableComputeServices ( )
protected

Obtain the list of compute services available to the WMS.

Returns
a set of compute services
FileRegistryService * wrench::WMS::getAvailableFileRegistryService ( )
protected

Obtain the file registry service available to the WMS.

Returns
a file registry services
std::set< NetworkProximityService * > wrench::WMS::getAvailableNetworkProximityServices ( )
protected

Obtain the list of network proximity services available to the WMS.

Returns
a set of network proximity services
std::set< StorageService * > wrench::WMS::getAvailableStorageServices ( )
protected

Obtain the list of storage services available to the WMS.

Returns
a set of storage services
PilotJobScheduler * wrench::WMS::getPilotJobScheduler ( )

Get the WMS's pilot scheduler.

Returns
the pilot scheduler, or nullptr if none
StandardJobScheduler * wrench::WMS::getStandardJobScheduler ( )

Get the WMS's pilot scheduler.

Returns
the pilot scheduler, or nullptr if none
Workflow * wrench::WMS::getWorkflow ( )

Get the workflow that was assigned to the WMS.

Returns
a workflow
void wrench::WMS::processEventFileCopyCompletion ( std::unique_ptr< FileCopyCompletedEvent event)
protectedvirtual

Process a WorkflowExecutionEvent::FILE_COPY_COMPLETION event.

Parameters
eventa workflow execution event
void wrench::WMS::processEventFileCopyFailure ( std::unique_ptr< FileCopyFailedEvent event)
protectedvirtual

Process a WorkflowExecutionEvent::FILE_COPY_FAILURE event.

Parameters
eventa workflow execution event
void wrench::WMS::processEventPilotJobExpiration ( std::unique_ptr< PilotJobExpiredEvent event)
protectedvirtual

Process a WorkflowExecutionEvent::PILOT_JOB_EXPIRATION event.

Parameters
eventa workflow execution event
void wrench::WMS::processEventPilotJobStart ( std::unique_ptr< PilotJobStartedEvent event)
protectedvirtual

Process a WorkflowExecutionEvent::PILOT_JOB_START event.

Parameters
eventa workflow execution event
void wrench::WMS::processEventStandardJobCompletion ( std::unique_ptr< StandardJobCompletedEvent event)
protectedvirtual

Process a WorkflowExecutionEvent::STANDARD_JOB_COMPLETION.

Parameters
eventa workflow execution event
void wrench::WMS::processEventStandardJobFailure ( std::unique_ptr< StandardJobFailedEvent event)
protectedvirtual

Process a WorkflowExecutionEvent::STANDARD_JOB_FAILURE event.

Parameters
eventa workflow execution event
void wrench::WMS::waitForAndProcessNextEvent ( )
protected

Wait for a workflow execution event and then call the associated function to process that event.

Exceptions
wrench::WorkflowExecutionException

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