Detailed Description

Functions
smx_actor_t	simcall_process_create (const char name, xbt_main_func_t code, void data, sg_host_t host, double kill_time, int argc, char **argv, xbt_dict_t properties, int auto_restart)
	Creates and runs a new SIMIX process. More...

smx_activity_t	simcall_execution_start (const char *name, double flops_amount, double priority, double bound)
	Creates a synchro that executes some computation of an host. More...

smx_activity_t	simcall_execution_parallel_start (const char name, int host_nb, sg_host_t host_list, double flops_amount, double bytes_amount, double amount, double rate, double timeout)
	Creates a synchro that may involve parallel computation on several hosts and communication between them. More...

void	simcall_execution_cancel (smx_activity_t execution)
	Cancels an execution synchro. More...

void	simcall_execution_set_priority (smx_activity_t execution, double priority)
	Changes the priority of an execution synchro. More...

void	simcall_execution_set_bound (smx_activity_t execution, double bound)
	Changes the capping (the maximum CPU utilization) of an execution synchro. More...

void	simcall_process_kill (smx_actor_t process)
	Kills a SIMIX process. More...

void	simcall_process_killall (int reset_pid)
	Kills all SIMIX processes. More...

void	simcall_process_cleanup (smx_actor_t process)
	Cleans up a SIMIX process. More...

void	simcall_process_set_host (smx_actor_t process, sg_host_t dest)
	Migrates an agent to another location. More...

void	simcall_process_suspend (smx_actor_t process)
	Suspends a process. More...

void	simcall_process_resume (smx_actor_t process)
	Resumes a suspended process. More...

int	simcall_process_count ()
	Returns the amount of SIMIX processes in the system. More...

void *	simcall_process_get_data (smx_actor_t process)
	Return the user data of a smx_actor_t. More...

void	simcall_process_set_data (smx_actor_t process, void *data)
	Set the user data of a smx_actor_t. More...

void	simcall_process_set_kill_time (smx_actor_t process, double kill_time)
	Set the kill time of a process. More...

double	simcall_process_get_kill_time (smx_actor_t process)
	Get the kill time of a process (or 0 if unset). More...

int	simcall_process_is_suspended (smx_actor_t process)
	Returns true if the process is suspended . More...

xbt_dict_t	simcall_process_get_properties (smx_actor_t process)
	Return the properties. More...

void	simcall_process_on_exit (smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data)
	Add an on_exit function Add an on_exit function which will be executed when the process exits/is killed. More...

void	simcall_process_auto_restart_set (smx_actor_t process, int auto_restart)
	Sets the process to be auto-restarted or not by SIMIX when its host comes back up. More...

smx_actor_t	simcall_process_restart (smx_actor_t process)
	Restarts the process, killing it and starting it again from scratch. More...

e_smx_state_t	simcall_process_sleep (double duration)
	Creates a new sleep SIMIX synchro. More...

Function Documentation

◆ simcall_process_create()

smx_actor_t simcall_process_create	(	const char *	name,
		xbt_main_func_t	code,
		void *	data,
		sg_host_t	host,
		double	kill_time,
		int	argc,
		char **	argv,
		xbt_dict_t	properties,
		int	auto_restart
	)

Creates and runs a new SIMIX process.

The structure and the corresponding thread are created and put in the list of ready processes.

Parameters

name	a name for the process. It is for user-level information and can be nullptr.
code	the main function of the process
data	a pointer to any data one may want to attach to the new object. It is for user-level information and can be nullptr. It can be retrieved with the function simcall_process_get_data.
host	where the new agent is executed.
kill_time	time when the process is killed
argc	first argument passed to code
argv	second argument passed to code
properties	the properties of the process
auto_restart	either it is autorestarting or not.

◆ simcall_execution_start()

smx_activity_t simcall_execution_start	(	const char *	name,
		double	flops_amount,
		double	priority,
		double	bound
	)

Creates a synchro that executes some computation of an host.

This function creates a SURF action and allocates the data necessary to create the SIMIX synchro. It can raise a host_error exception if the host crashed.

Parameters

name	Name of the execution synchro to create
flops_amount	amount Computation amount (in flops)
priority	computation priority
bound

Returns: A new SIMIX execution synchronization

◆ simcall_execution_parallel_start()

smx_activity_t simcall_execution_parallel_start	(	const char *	name,
		int	host_nb,
		sg_host_t *	host_list,
		double *	flops_amount,
		double *	bytes_amount,
		double	amount,
		double	rate,
		double	timeout
	)

Creates a synchro that may involve parallel computation on several hosts and communication between them.

Parameters

name	Name of the execution synchro to create
host_nb	Number of hosts where the synchro will be executed
host_list	Array (of size host_nb) of hosts where the synchro will be executed
flops_amount	Array (of size host_nb) of computation amount of hosts (in bytes)
bytes_amount	Array (of size host_nb * host_nb) representing the communication amount between each pair of hosts
amount	the SURF action amount
rate	the SURF action rate
timeout	timeout

Returns: A new SIMIX execution synchronization

◆ simcall_execution_cancel()

void simcall_execution_cancel ( smx_activity_t execution )

Cancels an execution synchro.

This functions stops the execution. It calls a surf function.

Parameters

execution The execution synchro to cancel

◆ simcall_execution_set_priority()

void simcall_execution_set_priority	(	smx_activity_t	execution,
		double	priority
	)

Changes the priority of an execution synchro.

This functions changes the priority only. It calls a surf function.

Parameters

execution	The execution synchro
priority	The new priority

◆ simcall_execution_set_bound()

void simcall_execution_set_bound	(	smx_activity_t	execution,
		double	bound
	)

Changes the capping (the maximum CPU utilization) of an execution synchro.

This functions changes the capping only. It calls a surf function.

Parameters

execution	The execution synchro
bound	The new bound

◆ simcall_process_kill()

void simcall_process_kill ( smx_actor_t process )

Kills a SIMIX process.

This function simply kills a process.

Parameters

process poor victim

◆ simcall_process_killall()

void simcall_process_killall ( int reset_pid )

Kills all SIMIX processes.

◆ simcall_process_cleanup()

void simcall_process_cleanup ( smx_actor_t process )

Cleans up a SIMIX process.

Parameters

process poor victim (must have already been killed)

◆ simcall_process_set_host()

void simcall_process_set_host	(	smx_actor_t	process,
		sg_host_t	dest
	)

Migrates an agent to another location.

This function changes the value of the host on which process is running.

Parameters

process	the process to migrate
dest	name of the new host

◆ simcall_process_suspend()

void simcall_process_suspend ( smx_actor_t process )

Suspends a process.

This function suspends the process by suspending the synchro it was waiting for completion.

Parameters

process a SIMIX process

◆ simcall_process_resume()

void simcall_process_resume ( smx_actor_t process )

Resumes a suspended process.

This function resumes a suspended process by resuming the synchro it was waiting for completion.

Parameters

process a SIMIX process

◆ simcall_process_count()

int simcall_process_count ( )

Returns the amount of SIMIX processes in the system.

Maestro internal process is not counted, only user code processes are

◆ simcall_process_get_data()

void* simcall_process_get_data ( smx_actor_t process )

Return the user data of a smx_actor_t.

Parameters

process a SIMIX process

Returns: the user data of this process

◆ simcall_process_set_data()

void simcall_process_set_data	(	smx_actor_t	process,
		void *	data
	)

Set the user data of a smx_actor_t.

This functions sets the user data associated to process.

Parameters

process	SIMIX process
data	User data

◆ simcall_process_set_kill_time()

void simcall_process_set_kill_time	(	smx_actor_t	process,
		double	kill_time
	)

Set the kill time of a process.

◆ simcall_process_get_kill_time()

double simcall_process_get_kill_time ( smx_actor_t process )

Get the kill time of a process (or 0 if unset).

◆ simcall_process_is_suspended()

int simcall_process_is_suspended ( smx_actor_t process )

Returns true if the process is suspended .

This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.

Parameters

process SIMIX process

Returns: 1, if the process is suspended, else 0.

◆ simcall_process_get_properties()

xbt_dict_t simcall_process_get_properties ( smx_actor_t process )

Return the properties.

This functions returns the properties associated with this process

◆ simcall_process_on_exit()

void simcall_process_on_exit	(	smx_actor_t	process,
		int_f_pvoid_pvoid_t	fun,
		void *	data
	)

Add an on_exit function Add an on_exit function which will be executed when the process exits/is killed.

◆ simcall_process_auto_restart_set()

void simcall_process_auto_restart_set	(	smx_actor_t	process,
		int	auto_restart
	)

Sets the process to be auto-restarted or not by SIMIX when its host comes back up.

Will restart the process when the host comes back up if auto_restart is set to 1.

◆ simcall_process_restart()

smx_actor_t simcall_process_restart ( smx_actor_t process )

Restarts the process, killing it and starting it again from scratch.

◆ simcall_process_sleep()

e_smx_state_t simcall_process_sleep ( double duration )

Creates a new sleep SIMIX synchro.

This function creates a SURF action and allocates the data necessary to create the SIMIX synchro. It can raise a host_error exception if the host crashed. The default SIMIX name of the synchro is "sleep".

Parameters

duration Time duration of the sleep.

Returns: A result telling whether the sleep was successful

Detailed Description

Functions

Function Documentation

◆ simcall_process_create()

◆ simcall_execution_start()

◆ simcall_execution_parallel_start()

◆ simcall_execution_cancel()

◆ simcall_execution_set_priority()

◆ simcall_execution_set_bound()

◆ simcall_process_kill()

◆ simcall_process_killall()

◆ simcall_process_cleanup()

◆ simcall_process_set_host()

◆ simcall_process_suspend()

◆ simcall_process_resume()

◆ simcall_process_count()

◆ simcall_process_get_data()

◆ simcall_process_set_data()

◆ simcall_process_set_kill_time()

◆ simcall_process_get_kill_time()

◆ simcall_process_is_suspended()

◆ simcall_process_get_properties()

◆ simcall_process_on_exit()

◆ simcall_process_auto_restart_set()

◆ simcall_process_restart()

◆ simcall_process_sleep()