wrench::StandardJobExecutor Class Reference
A service that knows how to execute a standard job on a multi-node multi-core platform. Note that when killed in the middle of computing, this service will set (internal) running tasks' states to FAILED, and likely the calling service will want to make failed tasks READY and NOT_READY again to "unwind" the failed executions and resubmit tasks for execution. Also, this service does not increment task failure counts, as it does not know if the kill() was an actual failure (i.e., some timeout) or a feature (i.e., a WMS changing its mind) More...
#include <StandardJobExecutor.h>
Inheritance diagram for wrench::StandardJobExecutor:
Public Member Functions | |
| StandardJobExecutor (Simulation *simulation, std::string callback_mailbox, std::string hostname, StandardJob *job, std::map< std::string, std::tuple< unsigned long, double >> compute_resources, StorageService *scratch_space, bool part_of_pilot_job, PilotJob *parent_pilot_job, std::map< std::string, std::string > property_list, std::map< std::string, std::string > messagepayload_list) | |
| Constructor. More... | |
| ~StandardJobExecutor () | |
| Destructor. | |
| std::map< std::string, std::tuple< unsigned long, double > > | getComputeResources () |
| Get the executor's compute resources. More... | |
| std::set< WorkflowFile * > | getFilesInScratch () |
| Get the set of files stored in scratch space during the standard job's execution. More... | |
| StandardJob * | getJob () |
| Get the executor's job. More... | |
| void | kill () |
| Kill the executor. | |
 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, bool auto_restart) |
| 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... | |
| void | createLifeSaver (std::shared_ptr< S4U_Daemon > reference) |
| Create a life saver for the daemon. More... | |
| std::string | getName () |
| Retrieve the process name. More... | |
| bool | hasCleanlyTerminated () |
| Returned the terminated status of the daemon/actor. | |
| bool | isSetToAutoRestart () |
| Return the auto-restart status of the daemon. More... | |
| bool | join () |
| Join (i.e., wait for) the daemon. More... | |
| void | resume () |
| Resume the daemon/actor. | |
| void | setCleanlyTerminated () |
| Set the terminated status of the daemon/actor. | |
| void | startDaemon (bool daemonized, bool auto_restart) |
| Start the daemon. More... | |
| void | suspend () |
| Suspend the daemon/actor. | |
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. | |
| Simulation * | simulation |
| a pointer to the simulation object | |
| 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. | |
| void | runMainMethod () |
| Method that run's the user-defined main method (that's called by the S4U actor class) | |
| 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. | |
| Protected Attributes inherited from wrench::S4U_Daemon | |
| unsigned int | num_starts = 0 |
Detailed Description
A service that knows how to execute a standard job on a multi-node multi-core platform. Note that when killed in the middle of computing, this service will set (internal) running tasks' states to FAILED, and likely the calling service will want to make failed tasks READY and NOT_READY again to "unwind" the failed executions and resubmit tasks for execution. Also, this service does not increment task failure counts, as it does not know if the kill() was an actual failure (i.e., some timeout) or a feature (i.e., a WMS changing its mind)
Constructor & Destructor Documentation
◆ StandardJobExecutor()
| wrench::StandardJobExecutor::StandardJobExecutor | ( | Simulation * | simulation, |
| std::string | callback_mailbox, | ||
| std::string | hostname, | ||
| StandardJob * | job, | ||
| std::map< std::string, std::tuple< unsigned long, double >> | compute_resources, | ||
| StorageService * | scratch_space, | ||
| bool | part_of_pilot_job, | ||
| PilotJob * | parent_pilot_job, | ||
| std::map< std::string, std::string > | property_list, | ||
| std::map< std::string, std::string > | messagepayload_list | ||
| ) |
Constructor.
- Parameters
-
simulation a reference to a simulation object callback_mailbox the mailbox to which a reply will be sent hostname the name of the host on which this service will run (could be the first compute resources - see below) job the standard job to execute compute_resources a non-empty map of <num_cores, memory> tuples, indexed by hostname, which represent the compute resources the job should execute on - If num_cores == ComputeService::ALL_CORES, then ALL the cores of the host are used
- If memory == ComputeService::ALL_RAM, then ALL the ram of the host is used
scratch_space the usable scratch storage space (or nullptr if none) part_of_pilot_job true if the job executor is running within a pilot job property_list a property list messagepayload_list a message payload list
- Exceptions
-
std::invalid_argument std::runtime_error
Member Function Documentation
◆ getComputeResources()
| std::map< std::string, std::tuple< unsigned long, double > > wrench::StandardJobExecutor::getComputeResources | ( | ) |
Get the executor's compute resources.
- Returns
- a set of compute resources as <hostname, num cores, bytes of RAM> tuples
◆ getFilesInScratch()
| std::set< WorkflowFile * > wrench::StandardJobExecutor::getFilesInScratch | ( | ) |
Get the set of files stored in scratch space during the standard job's execution.
- Returns
- a set of files
◆ getJob()
| StandardJob * wrench::StandardJobExecutor::getJob | ( | ) |
Get the executor's job.
- Returns
- a standard job
The documentation for this class was generated from the following files:
- /Users/rafsilva/Documents/isi/workspace/wrench/wrench/include/wrench/services/compute/standard_job_executor/StandardJobExecutor.h
- /Users/rafsilva/Documents/isi/workspace/wrench/wrench/src/wrench/services/compute/standard_job_executor/StandardJobExecutor.cpp
