wrench::ActionExecutor Class Reference

An service that performs an Action. More...

#include <ActionExecutor.h>

Inheritance diagram for wrench::ActionExecutor:

Public Member Functions
	ActionExecutor (std::string hostname, unsigned long num_cores, double ram_footprint, simgrid::s4u::Mailbox *callback_mailbox, std::shared_ptr< Action > action, std::shared_ptr< ActionExecutionService > action_execution_service)
	Constructor. More...
void	cleanup (bool has_returned_from_main, int return_value) override
	Cleanup method that implements the cleanup basics. More...
std::shared_ptr< Action >	getAction ()
	Returns the executor's action. More...
std::shared_ptr< ActionExecutionService >	getActionExecutionService () const
	Get the action execution service that started this action executor (or nullptr if stand-alone action executor) More...
double	getMemoryAllocated () const
	Return the action executor's allocated RAM. More...
unsigned long	getNumCoresAllocated () const
	Return the action executor's allocated nuber of cores. More...
void	kill (bool job_termination)
	Kill the worker thread. More...
int	main () override
	Main method of the action executor. More...
Public Member Functions inherited from wrench::ExecutionController
std::shared_ptr< BandwidthMeterService >	createBandwidthMeter (const std::map< std::string, double > &measurement_periods)
	Instantiate and start a bandwidth meter. More...
std::shared_ptr< BandwidthMeterService >	createBandwidthMeter (const std::vector< std::string > &linknames, double measurement_period)
	Instantiate and start a bandwidth meter. More...
virtual std::shared_ptr< DataMovementManager >	createDataMovementManager ()
	Instantiate and start a data movement manager. More...
std::shared_ptr< EnergyMeterService >	createEnergyMeter (const std::map< std::string, double > &measurement_periods)
	Instantiate and start an energy meter. More...
std::shared_ptr< EnergyMeterService >	createEnergyMeter (const std::vector< std::string > &hostnames, double measurement_period)
	Instantiate and start an energy meter. More...
virtual std::shared_ptr< JobManager >	createJobManager ()
	Instantiate and start a job manager. More...
virtual void	processEventCompoundJobCompletion (std::shared_ptr< CompoundJobCompletedEvent >)
	Process a standard job completion event. More...
virtual void	processEventCompoundJobFailure (std::shared_ptr< CompoundJobFailedEvent >)
	Process a standard job failure event. More...
virtual void	processEventFileCopyCompletion (std::shared_ptr< FileCopyCompletedEvent >)
	Process a file copy completion event. More...
virtual void	processEventFileCopyFailure (std::shared_ptr< FileCopyFailedEvent >)
	Process a file copy failure event. More...
virtual void	processEventPilotJobExpiration (std::shared_ptr< PilotJobExpiredEvent >)
	Process a pilot job expiration event. More...
virtual void	processEventPilotJobStart (std::shared_ptr< PilotJobStartedEvent >)
	Process a pilot job start event. More...
virtual void	processEventStandardJobCompletion (std::shared_ptr< StandardJobCompletedEvent >)
	Process a standard job completion event. More...
virtual void	processEventStandardJobFailure (std::shared_ptr< StandardJobFailedEvent >)
	Process a standard job failure event. More...
virtual void	processEventTimer (std::shared_ptr< TimerEvent >)
	Process a timer event. More...
void	waitForAndProcessNextEvent ()
	Wait for an execution event and then call the associated function to process that event.
bool	waitForAndProcessNextEvent (double timeout)
	Wait for an execution event and then call the associated function to process that event. More...
std::shared_ptr< ExecutionEvent >	waitForNextEvent ()
	Wait for an execution event. More...
std::shared_ptr< ExecutionEvent >	waitForNextEvent (double timeout)
	Wait for an execution event. More...
Public Member Functions inherited from wrench::Service
void	assertServiceIsUp ()
	Throws an exception if the service is not up. More...
std::string	getHostname ()
	Get the name of the host on which the service is / will be running. More...
const WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE &	getMessagePayloadList () const
	Get all message payloads and their values of the Service. More...
double	getMessagePayloadValue (WRENCH_MESSAGEPAYLOAD_TYPE)
	Get a message payload of the Service as a double. More...
double	getNetworkTimeoutValue ()
	Returns the service's network timeout value. More...
std::string	getPhysicalHostname ()
	Get the physical name of the host on which the service is / will be running. More...
bool	getPropertyValueAsBoolean (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as a boolean. More...
double	getPropertyValueAsDouble (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as a double. More...
std::string	getPropertyValueAsString (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as a string. More...
unsigned long	getPropertyValueAsUnsignedLong (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as an unsigned long. More...
bool	isUp ()
	Returns true if the service is UP, false otherwise. More...
void	resume ()
	Resume the service. 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...
void	suspend ()
	Suspend the service.
Public Member Functions inherited from wrench::S4U_Daemon
	S4U_Daemon (std::string hostname, std::string process_name_prefix)
	Constructor (daemon with a mailbox) More...
void	acquireDaemonLock ()
	Method to acquire the daemon's lock. 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...
int	getReturnValue ()
	Returns the value returned by main() (if the daemon has returned from main) More...
Simulation *	getSimulation ()
	Get the service's simulation. More...
S4U_Daemon::State	getState ()
	Get the daemon's state. More...
bool	hasReturnedFromMain ()
	Returns true if the daemon has returned from main() (i.e., not brutally killed) More...
bool	isDaemonized ()
	Return the daemonized status of the daemon. More...
bool	isSetToAutoRestart ()
	Return the auto-restart status of the daemon. More...
std::pair< bool, int >	join ()
	Join (i.e., wait for) the daemon. More...
void	releaseDaemonLock ()
	Method to release the daemon's lock. More...
void	resumeActor ()
	Resume the daemon/actor.
void	setSimulation (Simulation *simulation)
	Set the service's simulation. More...
void	setupOnExitFunction ()
	Sets up the on_exit function for the actor.
void	startDaemon (bool _daemonized, bool _auto_restart)
	Start the daemon. More...
void	suspendActor ()
	Suspend the daemon/actor.

Additional Inherited Members
Public Types inherited from wrench::S4U_Daemon
enum	State { UP, DOWN, SUSPENDED }
	Daemon states. More...
Static Public Member Functions inherited from wrench::S4U_Daemon
static simgrid::s4u::Mailbox *	getRunningActorRecvMailbox ()
	Return the running actor's recv mailbox. 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.
simgrid::s4u::Mailbox *	mailbox
	The daemon's mailbox.
std::string	process_name
	The name of the daemon.
simgrid::s4u::Mailbox *	recv_mailbox
	The daemon's receive mailbox (to send to another daemon so that that daemon can reply)
Static Public Attributes inherited from wrench::S4U_Daemon
static std::unordered_map< aid_t, simgrid::s4u::Mailbox * >	map_actor_to_recv_mailbox
Protected Member Functions inherited from wrench::ExecutionController
	ExecutionController (const std::string &hostname, const std::string suffix)
	Constructor. More...
void	setTimer (double date, std::string message)
	Sets a timer (which, when it goes off, will generate a TimerEvent) More...
Protected Member Functions inherited from wrench::Service
	Service (std::string hostname, std::string process_name_prefix)
	Constructor. More...
	~Service () override
	Destructor.
template<class T >
std::shared_ptr< T >	getSharedPtr ()
	Method to retrieve the shared_ptr to a service. More...
void	serviceSanityCheck ()
	Check whether the service is properly configured and running. More...
void	setMessagePayload (WRENCH_MESSAGEPAYLOAD_TYPE, double)
	Set a message payload of the Service. More...
void	setMessagePayloads (WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE default_messagepayload_values, WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE overriden_messagepayload_values)
	Set default and user-defined message payloads. More...
void	setProperties (WRENCH_PROPERTY_COLLECTION_TYPE default_property_values, WRENCH_PROPERTY_COLLECTION_TYPE overriden_property_values)
	Set default and user-defined properties. More...
void	setProperty (WRENCH_PROPERTY_TYPE, const std::string &)
	Set a property of the Service. More...
Protected Member Functions inherited from wrench::S4U_Daemon
bool	killActor ()
	Kill the daemon/actor (does nothing if already dead) More...
void	runMainMethod ()
	Method that run's the user-defined main method (that's called by the S4U actor class)
Static Protected Member Functions inherited from wrench::Service
static void	assertServiceIsUp (std::shared_ptr< Service > s)
	Assert for the service being up. More...
Protected Attributes inherited from wrench::Service
WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE	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)
WRENCH_PROPERTY_COLLECTION_TYPE	property_list
	The service's property list.
bool	shutting_down = false
	A boolean that indicates if the service is in the middle of shutting down.
Protected Attributes inherited from wrench::S4U_Daemon
unsigned int	num_starts = 0
	The number of time that this daemon has started (i.e., 1 + number of restarts)
Simulation *	simulation
	a pointer to the simulation object
State	state
	The service's state.

Detailed Description

An service that performs an Action.

Constructor & Destructor Documentation

ActionExecutor()

wrench::ActionExecutor::ActionExecutor	(	std::string	hostname,
		unsigned long	num_cores,
		double	ram_footprint,
		simgrid::s4u::Mailbox *	callback_mailbox,
		std::shared_ptr< Action >	action,
		std::shared_ptr< ActionExecutionService >	action_execution_service
	)

Constructor.

Parameters

hostname	the name of the host on which the action executor will run
num_cores	the number of cores
ram_footprint	the RAM footprint
callback_mailbox	the callback mailbox to which a "action done" or "action failed" message will be sent
action	the action to perform
action_execution_service	the parent action execution service

Member Function Documentation

cleanup()

void wrench::ActionExecutor::cleanup ( bool  has_returned_from_main, int  return_value  )

overridevirtual

Cleanup method that implements the cleanup basics.

Parameters

has_returned_from_main	true if main has returned
return_value	main's return value

Reimplemented from wrench::S4U_Daemon.

getAction()

std::shared_ptr< Action > wrench::ActionExecutor::getAction

(

)

Returns the executor's action.

Returns

the action

getActionExecutionService()

std::shared_ptr< ActionExecutionService > wrench::ActionExecutor::getActionExecutionService

(

)

const

Get the action execution service that started this action executor (or nullptr if stand-alone action executor)

Returns

an action execution service

getMemoryAllocated()

double wrench::ActionExecutor::getMemoryAllocated

(

)

const

Return the action executor's allocated RAM.

Returns

a number of bytes

getNumCoresAllocated()

unsigned long wrench::ActionExecutor::getNumCoresAllocated

(

)

const

Return the action executor's allocated nuber of cores.

Returns

a number of cores

kill()

void wrench::ActionExecutor::kill

(

bool

job_termination

)

Kill the worker thread.

Parameters

job_termination

if the reason for being killed is that the job was terminated by the submitter (as opposed to being terminated because the above service was also terminated).

main()

int wrench::ActionExecutor::main ( )

overridevirtual

Main method of the action executor.

Returns

1 if a failure timestamp should be generated, 0 otherwise

Exceptions

std::runtime_error

Implements wrench::ExecutionController.

---

The documentation for this class was generated from the following files:

• ActionExecutor.h
• ActionExecutor.cpp