};
/**
+ * \ingroup simix_host_management
* \brief Returns a host given its name.
*
* \param name The name of the host to get
}
/**
+ * \ingroup simix_host_management
* \brief Returns the name of a host.
*
* \param host A SIMIX host
}
/**
+ * \ingroup simix_host_management
* \brief Returns a dict of the properties assigned to a host.
*
* \param host A host
}
/**
+ * \ingroup simix_host_management
* \brief Returns the speed of the processor.
*
* The speed returned does not take into account the current load on the machine.
}
/**
+ * \ingroup simix_host_management
* \brief Returns the available speed of the processor.
*
* \return Speed currently available (in Mflop/s)
}
/**
+ * \ingroup simix_host_management
* \brief Returns the state of a host.
*
* Two states are possible: 1 if the host is active or 0 if it has crashed.
}
/**
+ * \ingroup simix_host_management
* \brief Returns the user data associated to a host.
*
* \param host SIMIX host
}
/**
+ * \ingroup simix_host_management
* \brief Sets the user data associated to a host.
*
* The host must not have previous user data associated to it.
SIMIX_simcall_push(simcall->issuer);
}
-/** \brief Creates an action that executes some computation of an host.
+/**
+ * \ingroup simix_host_management
+ * \brief Creates an action that executes some computation of an host.
*
* This function creates a SURF action and allocates the data necessary
* to create the SIMIX action. It can raise a host_error exception if the host crashed.
return simcall->host_execute.result;
}
-/** \brief Creates an action that may involve parallel computation on
+/**
+ * \ingroup simix_host_management
+ * \brief Creates an action that may involve parallel computation on
* several hosts and communication between them.
*
* \param name Name of the execution action to create
}
/**
+ * \ingroup simix_host_management
* \brief Destroys an execution action.
*
* Destroys an action, freing its memory. This function cannot be called if there are a conditional waiting for it.
}
/**
+ * \ingroup simix_host_management
* \brief Cancels an execution action.
*
* This functions stops the execution. It calls a surf function.
}
/**
+ * \ingroup simix_host_management
* \brief Returns how much of an execution action remains to be done.
*
* \param Action The execution action
}
/**
+ * \ingroup simix_host_management
* \brief Returns the state of an execution action.
*
* \param execution The execution action
}
/**
+ * \ingroup simix_host_management
* \brief Changes the priority of an execution action.
*
* This functions changes the priority only. It calls a surf function.
}
/**
+ * \ingroup simix_host_management
* \brief Waits for the completion of an execution action and destroy it.
*
* \param execution The execution action
}
/**
+ * \ingroup simix_process_management
* \brief Creates and runs a new SIMIX process.
*
* The structure and the corresponding thread are created and put in the list of ready processes.
SIMIX_simcall_push(simcall->issuer);
}
-/** \brief Kills a SIMIX process.
+/**
+ * \ingroup simix_process_management
+ * \brief Kills a SIMIX process.
*
* This function simply kills a process.
*
SIMIX_simcall_push(simcall->issuer);
}
-/** \brief Kills all SIMIX processes.
+/**
+ * \ingroup simix_process_management
+ * \brief Kills all SIMIX processes.
*/
void simcall_process_killall(void)
{
SIMIX_simcall_push(simcall->issuer);
}
-/** \brief Cleans up a SIMIX process.
+/**
+ * \ingroup simix_process_management
+ * \brief Cleans up a SIMIX process.
* \param process poor victim (must have already been killed)
*/
void simcall_process_cleanup(smx_process_t process)
}
/**
+ * \ingroup simix_process_management
* \brief Migrates an agent to another location.
*
* This function changes the value of the host on which \a process is running.
}
/**
+ * \ingroup simix_process_management
* \brief Suspends a process.
*
* This function suspends the process by suspending the action
}
/**
+ * \ingroup simix_process_management
* \brief Resumes a suspended process.
*
* This function resumes a suspended process by resuming the action
}
/**
+ * \ingroup simix_process_management
* \brief Returns the amount of SIMIX processes in the system
*
* Maestro internal process is not counted, only user code processes are
}
/**
+ * \ingroup simix_process_management
* \brief Return the user data of a #smx_process_t.
* \param process a SIMIX process
* \return the user data of this process
}
/**
+ * \ingroup simix_process_management
* \brief Set the user data of a #smx_process_t.
*
* This functions checks whether \a process is a valid pointer or not and set the user data associated to \a process if it is possible.
}
/**
+ * \ingroup simix_process_management
* \brief Set the kill time of a process.
* \param process a process
* \param kill_time a double
}
/**
+ * \ingroup simix_process_management
* \brief Return the location on which an agent is running.
*
* This functions checks whether \a process is a valid pointer or not and return the m_host_t corresponding to the location on which \a process is running.
}
/**
+ * \ingroup simix_process_management
* \brief Return the name of an agent.
*
* This functions checks whether \a process is a valid pointer or not and return its name.
}
/**
+ * \ingroup simix_process_management
* \brief 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.
return simcall->process_is_suspended.result;
}
-/** \ingroup m_process_management
+/**
+ * \ingroup simix_process_management
+ * \ingroup m_process_management
* \brief Return the properties
*
* This functions returns the properties associated with this process
return simcall->process_get_properties.result;
}
/**
+ * \ingroup simix_process_management
* \brief Add an on_exit function
* Add an on_exit function which will be executed when the process exits/is killed.
*/
SIMIX_simcall_push(simcall->issuer);
}
/**
+ * \ingroup simix_process_management
* \brief 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.
*/
SIMIX_simcall_push(simcall->issuer);
}
-/** \brief Creates a new sleep SIMIX action.
+/**
+ * \ingroup simix_process_management
+ * \brief Creates a new sleep SIMIX action.
*
* This function creates a SURF action and allocates the data necessary
* to create the SIMIX action. It can raise a host_error exception if the
}
/**
+ * \ingroup simix_rdv_management
* \brief Creates a new rendez-vous point
* \param name The name of the rendez-vous point
* \return The created rendez-vous point
/**
+ * \ingroup simix_rdv_management
* \brief Destroy a rendez-vous point
* \param name The rendez-vous point to destroy
*/
SIMIX_simcall_push(simcall->issuer);
}
-
+/**
+ * \ingroup simix_rdv_management
+ * \brief Returns a rendez-vous point knowing its name
+ */
smx_rdv_t simcall_rdv_get_by_name(const char *name)
{
xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
}
/**
+ * \ingroup simix_rdv_management
* \brief Counts the number of communication actions of a given host pending
* on a rendez-vous point.
* \param rdv The rendez-vous point
}
/**
+ * \ingroup simix_rdv_management
* \brief returns the communication at the head of the rendez-vous
* \param rdv The rendez-vous point
* \return The communication or NULL if empty
SIMIX_simcall_push(simcall->issuer);
return simcall->rdv_get_head.result;
}
-
+/**
+ * \ingroup simix_comm_management
+ *
+ */
void simcall_comm_send(smx_rdv_t rdv, double task_size, double rate,
void *src_buff, size_t src_buff_size,
int (*match_fun)(void *, void *, smx_action_t), void *data,
SIMIX_simcall_push(simcall->issuer);
}
}
-
+/**
+ * \ingroup simix_comm_management
+ */
smx_action_t simcall_comm_isend(smx_rdv_t rdv, double task_size, double rate,
void *src_buff, size_t src_buff_size,
int (*match_fun)(void *, void *, smx_action_t),
SIMIX_simcall_push(simcall->issuer);
return simcall->comm_isend.result;
}
-
+/**
+ * \ingroup simix_comm_management
+ */
void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
int (*match_fun)(void *, void *, smx_action_t), void *data, double timeout)
{
SIMIX_simcall_push(simcall->issuer);
}
}
-
+/**
+ * \ingroup simix_comm_management
+ */
smx_action_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
int (*match_fun)(void *, void *, smx_action_t), void *data)
{
SIMIX_simcall_push(simcall->issuer);
return simcall->comm_irecv.result;
}
-
void simcall_comm_destroy(smx_action_t comm)
{
xbt_assert(comm, "Invalid parameter");
SIMIX_simcall_push(simcall->issuer);
*/
}
-
+/**
+ * \ingroup simix_comm_management
+ */
void simcall_comm_cancel(smx_action_t comm)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
}
-
+/**
+ * \ingroup simix_comm_management
+ */
unsigned int simcall_comm_waitany(xbt_dynar_t comms)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->comm_waitany.result;
}
-
+/**
+ * \ingroup simix_comm_management
+ */
int simcall_comm_testany(xbt_dynar_t comms)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->comm_testany.result;
}
-
+/**
+ * \ingroup simix_comm_management
+ */
void simcall_comm_wait(smx_action_t comm, double timeout)
{
xbt_assert(isfinite(timeout), "timeout is not finite!");
SIMIX_simcall_push(simcall->issuer);
}
#endif
-
+/**
+ * \ingroup simix_comm_management
+ *
+ */
int simcall_comm_test(smx_action_t comm)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->comm_test.result;
}
-
+/**
+ * \ingroup simix_comm_management
+ *
+ */
double simcall_comm_get_remains(smx_action_t comm)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->comm_get_remains.result;
}
-
+/**
+ * \ingroup simix_comm_management
+ *
+ */
e_smx_state_t simcall_comm_get_state(smx_action_t comm)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->comm_get_state.result;
}
-
+/**
+ * \ingroup simix_comm_management
+ *
+ */
void *simcall_comm_get_src_data(smx_action_t comm)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->comm_get_src_data.result;
}
-
+/**
+ * \ingroup simix_comm_management
+ *
+ */
void *simcall_comm_get_dst_data(smx_action_t comm)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->comm_get_dst_data.result;
}
-
+/**
+ * \ingroup simix_comm_management
+ *
+ */
smx_process_t simcall_comm_get_src_proc(smx_action_t comm)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->comm_get_src_proc.result;
}
-
+/**
+ * \ingroup simix_comm_management
+ *
+ */
smx_process_t simcall_comm_get_dst_proc(smx_action_t comm)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
return simcall->comm_is_latency_bounded.result;
}
#endif
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
smx_mutex_t simcall_mutex_init(void)
{
if(!simix_global) {
SIMIX_simcall_push(simcall->issuer);
return simcall->mutex_init.result;
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
void simcall_mutex_destroy(smx_mutex_t mutex)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
void simcall_mutex_lock(smx_mutex_t mutex)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
int simcall_mutex_trylock(smx_mutex_t mutex)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->mutex_trylock.result;
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
void simcall_mutex_unlock(smx_mutex_t mutex)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
}
-
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
smx_cond_t simcall_cond_init(void)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->cond_init.result;
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
void simcall_cond_destroy(smx_cond_t cond)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
void simcall_cond_signal(smx_cond_t cond)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
void simcall_cond_wait_timeout(smx_cond_t cond,
smx_mutex_t mutex,
double timeout)
SIMIX_simcall_push(simcall->issuer);
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
void simcall_cond_broadcast(smx_cond_t cond)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
}
-
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
smx_sem_t simcall_sem_init(int capacity)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->sem_init.result;
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
void simcall_sem_destroy(smx_sem_t sem)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
void simcall_sem_release(smx_sem_t sem)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
int simcall_sem_would_block(smx_sem_t sem)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->sem_would_block.result;
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
void simcall_sem_acquire(smx_sem_t sem)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
{
xbt_assert(isfinite(timeout), "timeout is not finite!");
SIMIX_simcall_push(simcall->issuer);
}
-
+/**
+ * \ingroup simix_synchro_management
+ *
+ */
int simcall_sem_get_capacity(smx_sem_t sem)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
SIMIX_simcall_push(simcall->issuer);
return simcall->sem_get_capacity.result;
}
-
+/**
+ * \ingroup simix_file_management
+ *
+ */
double simcall_file_read(void* ptr, size_t size, size_t nmemb, smx_file_t stream)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
return simcall->file_read.result;
}
-
+/**
+ * \ingroup simix_file_management
+ *
+ */
size_t simcall_file_write(const void* ptr, size_t size, size_t nmemb, smx_file_t stream)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
return simcall->file_write.result;
}
-
+/**
+ * \ingroup simix_file_management
+ *
+ */
smx_file_t simcall_file_open(const char* mount, const char* path, const char* mode)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
return simcall->file_open.result;
}
-
+/**
+ * \ingroup simix_file_management
+ *
+ */
int simcall_file_close(smx_file_t fp)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
return simcall->file_close.result;
}
-
+/**
+ * \ingroup simix_file_management
+ *
+ */
int simcall_file_stat(smx_file_t fd, s_file_stat_t *buf)
{
smx_simcall_t simcall = SIMIX_simcall_mine();
