3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
4 All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_action, simix,
14 "Logging specific to SIMIX (action)");
16 /************************************* Actions *********************************/
17 /** \brief Creates a new SIMIX action to communicate two hosts.
19 * This function creates a SURF action and allocates the data necessary to create the SIMIX action. It can raise a network_error exception if the host is unavailable.
20 * \param sender SIMIX host sender
21 * \param receiver SIMIX host receiver
22 * \param name Action name
23 * \param size Communication size (in bytes)
24 * \param rate Communication rate between hosts.
25 * \return A new SIMIX action
27 smx_action_t SIMIX_action_communicate(smx_host_t sender,
28 smx_host_t receiver, const char *name,
29 double size, double rate)
33 /* check if the host is active */
34 if (surf_workstation_model->extension.workstation.get_state(sender->host) !=
36 THROW1(network_error, 0, "Host %s failed, you cannot call this function",
39 if (surf_workstation_model->extension.workstation.
40 get_state(receiver->host) != SURF_RESOURCE_ON) {
41 THROW1(network_error, 0, "Host %s failed, you cannot call this function",
45 /* alloc structures */
46 act = xbt_new0(s_smx_action_t, 1);
47 act->cond_list = xbt_fifo_new();
48 act->sem_list = xbt_fifo_new();
51 act->name = xbt_strdup(name);
58 surf_workstation_model->extension.workstation.communicate(sender->host,
61 surf_workstation_model->action_data_set(act->surf_action, act);
63 DEBUG1("Create communicate action %p", act);
67 /** \brief Creates a new SIMIX action to execute an action.
69 * 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.
70 * \param host SIMIX host where the action will be executed
71 * \param name Action name
72 * \param amount Task amount (in bytes)
73 * \return A new SIMIX action
75 smx_action_t SIMIX_action_execute(smx_host_t host, const char *name,
80 /* check if the host is active */
81 if (surf_workstation_model->extension.workstation.get_state(host->host) !=
83 THROW1(host_error, 0, "Host %s failed, you cannot call this function",
87 /* alloc structures */
88 act = xbt_new0(s_smx_action_t, 1);
89 act->cond_list = xbt_fifo_new();
90 act->sem_list = xbt_fifo_new();
94 act->name = xbt_strdup(name);
99 /* set communication */
101 surf_workstation_model->extension.workstation.execute(host->host, amount);
103 surf_workstation_model->action_data_set(act->surf_action, act);
105 DEBUG1("Create execute action %p", act);
107 TRACE_smx_action_execute (act);
112 /** \brief Creates a new sleep SIMIX action.
114 * This function creates a SURF action and allocates the data necessary
115 * to create the SIMIX action. It can raise a host_error exception if the
116 * host crashed. The default SIMIX name of the action is "sleep".
118 * \param host SIMIX host where the sleep will run.
119 * \param duration Time duration of the sleep.
120 * \return A new SIMIX action
122 smx_action_t SIMIX_action_sleep(smx_host_t host, double duration)
124 char name[] = "sleep";
127 /* check if the host is active */
128 if (surf_workstation_model->extension.workstation.get_state(host->host) !=
130 THROW1(host_error, 0, "Host %s failed, you cannot call this function",
134 /* alloc structures */
135 act = xbt_new0(s_smx_action_t, 1);
136 act->cond_list = xbt_fifo_new();
137 act->sem_list = xbt_fifo_new();
139 /* initialize them */
141 act->name = xbt_strdup(name);
143 act->category = NULL;
147 surf_workstation_model->extension.workstation.sleep(host->host, duration);
149 surf_workstation_model->action_data_set(act->surf_action, act);
151 DEBUG1("Create sleep action %p", act);
156 * \brief Cancels an action.
158 * This functions stops the execution of an action. It calls a surf functions.
159 * \param action The SIMIX action
161 XBT_INLINE void SIMIX_action_cancel(smx_action_t action)
163 xbt_assert0((action != NULL), "Invalid parameter");
165 DEBUG1("Cancel action %p", action);
166 if (action->surf_action) {
167 surf_workstation_model->action_cancel(action->surf_action);
173 * \brief Changes the action's priority
175 * This functions changes the priority only. It calls a surf functions.
176 * \param action The SIMIX action
177 * \param priority The new priority
179 XBT_INLINE void SIMIX_action_set_priority(smx_action_t action, double priority)
181 xbt_assert0((action != NULL), "Invalid parameter");
183 surf_workstation_model->set_priority(action->surf_action, priority);
188 * \brief Resumes the execution of an action.
190 * This functions restarts the execution of an action. It just calls the right SURF function.
191 * \param action The SIMIX action
192 * \param priority The new priority
194 XBT_INLINE void SIMIX_action_resume(smx_action_t action)
196 xbt_assert0((action != NULL), "Invalid parameter");
198 surf_workstation_model->resume(action->surf_action);
203 * \brief Suspends the execution of an action.
205 * This functions suspends the execution of an action. It just calls the right SURF function.
206 * \param action The SIMIX action
207 * \param priority The new priority
209 XBT_INLINE void SIMIX_action_suspend(smx_action_t action)
211 xbt_assert0((action != NULL), "Invalid parameter");
213 surf_workstation_model->suspend(action->surf_action);
218 * \brief Destroys an action
220 * Destroys an action, freing its memory. This function cannot be called if there are a conditional waiting for it.
221 * \param action The SIMIX action
223 int SIMIX_action_destroy(smx_action_t action)
225 XBT_IN3("(%p:'%s',%d)", action, action->name, action->refcount);
226 xbt_assert0((action != NULL), "Invalid parameter");
229 if (action->refcount > 0)
232 xbt_assert1((xbt_fifo_size(action->cond_list) == 0),
233 "Conditional list not empty %d. There is a problem. Cannot destroy it now!",
234 xbt_fifo_size(action->cond_list));
236 xbt_assert1((xbt_fifo_size(action->sem_list) == 0),
237 "Semaphore list not empty %d. There is a problem. Cannot destroy it now!",
238 xbt_fifo_size(action->sem_list));
240 DEBUG1("Destroy action %p", action);
242 xbt_free(action->name);
244 xbt_fifo_free(action->cond_list);
245 xbt_fifo_free(action->sem_list);
247 if (action->surf_action)
248 action->surf_action->model_type->action_unref(action->surf_action);
250 TRACE_smx_action_destroy (action);
257 * \brief Increase refcount of anan action
259 * \param action The SIMIX action
261 XBT_INLINE void SIMIX_action_use(smx_action_t action)
263 XBT_IN3("(%p:'%s',%d)", action, action->name, action->refcount);
264 xbt_assert0((action != NULL), "Invalid parameter");
272 * \brief Decrease refcount of anan action
274 * \param action The SIMIX action
276 XBT_INLINE void SIMIX_action_release(smx_action_t action)
278 xbt_assert0((action != NULL), "Invalid parameter");
286 * \brief Set an action to a condition
288 * Creates the "link" between an action and a condition. You have to call this function when you create an action and want to wait its ending.
289 * \param action SIMIX action
290 * \param cond SIMIX cond
292 void SIMIX_register_action_to_condition(smx_action_t action, smx_cond_t cond)
294 xbt_assert0((action != NULL) && (cond != NULL), "Invalid parameters");
296 DEBUG2("Register action %p to cond %p", action, cond);
297 if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
298 __SIMIX_cond_display_actions(cond);
300 xbt_fifo_push(cond->actions, action);
302 if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
303 __SIMIX_cond_display_actions(cond);
305 DEBUG2("Register condition %p to action %p", cond, action);
307 if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
308 __SIMIX_action_display_conditions(action);
310 xbt_fifo_push(action->cond_list, cond);
312 if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
313 __SIMIX_action_display_conditions(action);
317 * \brief Unset an action to a condition.
319 * Destroys the "links" from the condition to this action.
320 * \param action SIMIX action
321 * \param cond SIMIX cond
323 void SIMIX_unregister_action_to_condition(smx_action_t action,
326 xbt_assert0((action != NULL) && (cond != NULL), "Invalid parameters");
328 if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
329 __SIMIX_cond_display_actions(cond);
331 xbt_fifo_remove_all(cond->actions, action);
333 if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
334 __SIMIX_cond_display_actions(cond);
336 if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
337 __SIMIX_action_display_conditions(action);
339 xbt_fifo_remove_all(action->cond_list, cond);
341 if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
342 __SIMIX_action_display_conditions(action);
345 * \brief Link an action to a semaphore
347 * When the action terminates, the semaphore gets signaled automatically.
349 XBT_INLINE void SIMIX_register_action_to_semaphore(smx_action_t action, smx_sem_t sem) {
351 DEBUG2("Register action %p to semaphore %p (and otherwise)", action, sem);
352 xbt_fifo_push(sem->actions, action);
353 xbt_fifo_push(action->sem_list, sem);
356 * \brief Unset an action to a semaphore.
358 * Destroys the "links" from the semaphore to this action.
360 XBT_INLINE void SIMIX_unregister_action_to_semaphore(smx_action_t action,
363 xbt_fifo_remove_all(sem->actions, action);
364 xbt_fifo_remove_all(action->sem_list, sem);
368 * \brief Return how much remais to be done in the action.
370 * \param action The SIMIX action
371 * \return Remains cost
373 XBT_INLINE double SIMIX_action_get_remains(smx_action_t action)
375 xbt_assert0((action != NULL), "Invalid parameter");
376 return surf_workstation_model->get_remains(action->surf_action);
379 smx_action_t SIMIX_action_parallel_execute(char *name, int host_nb,
380 smx_host_t * host_list,
381 double *computation_amount,
382 double *communication_amount,
383 double amount, double rate)
385 void **workstation_list = NULL;
389 /* alloc structures */
390 act = xbt_new0(s_smx_action_t, 1);
391 act->cond_list = xbt_fifo_new();
392 act->sem_list = xbt_fifo_new();
394 /* initialize them */
395 act->name = xbt_strdup(name);
397 act->category = NULL;
402 workstation_list = xbt_new0(void *, host_nb);
403 for (i = 0; i < host_nb; i++)
404 workstation_list[i] = host_list[i]->host;
407 surf_workstation_model->extension.workstation.
408 execute_parallel_task(host_nb, workstation_list, computation_amount,
409 communication_amount, amount, rate);
411 surf_workstation_model->action_data_set(act->surf_action, act);
416 XBT_INLINE e_surf_action_state_t SIMIX_action_get_state(smx_action_t action)
418 xbt_assert0((action != NULL), "Invalid parameter");
419 return surf_workstation_model->action_state_get(action->surf_action);
422 void __SIMIX_cond_display_actions(smx_cond_t cond)
424 xbt_fifo_item_t item = NULL;
425 smx_action_t action = NULL;
427 DEBUG1("Actions for condition %p", cond);
428 xbt_fifo_foreach(cond->actions, item, action, smx_action_t)
429 DEBUG2("\t %p [%s]", action, action->name);
432 void __SIMIX_action_display_conditions(smx_action_t action)
434 xbt_fifo_item_t item = NULL;
435 smx_cond_t cond = NULL;
437 DEBUG1("Conditions for action %p", action);
438 xbt_fifo_foreach(action->cond_list, item, cond, smx_cond_t)
439 DEBUG1("\t %p", cond);
442 XBT_INLINE char *SIMIX_action_get_name(smx_action_t action)
444 xbt_assert0((action != NULL), "Invalid parameter");
447 /** @brief Change the name of the action. Warning, the string you provide is not strdup()ed */
448 XBT_INLINE void SIMIX_action_set_name(smx_action_t action,char *name)
450 xbt_free(action->name);
454 /** @brief broadcast any condition and release any semaphore including this action */
455 void SIMIX_action_signal_all(smx_action_t action){
459 while ((cond = xbt_fifo_pop(action->cond_list)))
460 SIMIX_cond_broadcast(cond);
462 while ((sem = xbt_fifo_pop(action->sem_list)))
463 SIMIX_sem_release(sem);