src/simix/smx_action.c

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
   4    All rights reserved.                                          */
   5
   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. */
   8
   9 #include "private.h"
  10 #include "xbt/log.h"
  11 #include "xbt/ex.h"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_action, simix,
  14                                 "Logging specific to SIMIX (action)");
  15
  16 /************************************* Actions *********************************/
  17 /** \brief Creates a new SIMIX action to communicate two hosts.
  18  *
  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
  26  * */
  27 smx_action_t SIMIX_action_communicate(smx_host_t sender,
  28                                       smx_host_t receiver, const char *name,
  29                                       double size, double rate)
  30 {
  31   smx_action_t act;
  32
  33   /* check if the host is active */
  34   if (surf_workstation_model->extension.workstation.get_state(sender->host) !=
  35       SURF_RESOURCE_ON) {
  36     THROW1(network_error, 0, "Host %s failed, you cannot call this function",
  37            sender->name);
  38   }
  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",
  42            receiver->name);
  43   }
  44
  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();
  49
  50   /* initialize them */
  51   act->name = xbt_strdup(name);
  52   act->source = sender;
  53 #ifdef HAVE_TRACING
  54   act->category = NULL;
  55 #endif
  56
  57   act->surf_action =
  58     surf_workstation_model->extension.workstation.communicate(sender->host,
  59                                                               receiver->host,
  60                                                               size, rate);
  61   surf_workstation_model->action_data_set(act->surf_action, act);
  62
  63   DEBUG1("Create communicate action %p", act);
  64   return act;
  65 }
  66
  67 /** \brief Creates a new SIMIX action to execute an action.
  68  *
  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
  74  * */
  75 smx_action_t SIMIX_action_execute(smx_host_t host, const char *name,
  76                                   double amount)
  77 {
  78   smx_action_t act;
  79
  80   /* check if the host is active */
  81   if (surf_workstation_model->extension.workstation.get_state(host->host) !=
  82       SURF_RESOURCE_ON) {
  83     THROW1(host_error, 0, "Host %s failed, you cannot call this function",
  84            host->name);
  85   }
  86
  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();
  91
  92   /* initialize them */
  93   act->source = host;
  94   act->name = xbt_strdup(name);
  95 #ifdef HAVE_TRACING
  96   act->category = NULL;
  97 #endif
  98
  99   /* set communication */
 100   act->surf_action =
 101     surf_workstation_model->extension.workstation.execute(host->host, amount);
 102
 103   surf_workstation_model->action_data_set(act->surf_action, act);
 104
 105   DEBUG1("Create execute action %p", act);
 106 #ifdef HAVE_TRACING
 107   TRACE_smx_action_execute (act);
 108 #endif
 109   return act;
 110 }
 111
 112 /** \brief Creates a new sleep SIMIX action.
 113  *
 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".
 117  *
 118  *      \param host SIMIX host where the sleep will run.
 119  *      \param duration Time duration of the sleep.
 120  *      \return A new SIMIX action
 121  * */
 122 smx_action_t SIMIX_action_sleep(smx_host_t host, double duration)
 123 {
 124   char name[] = "sleep";
 125   smx_action_t act;
 126
 127   /* check if the host is active */
 128   if (surf_workstation_model->extension.workstation.get_state(host->host) !=
 129       SURF_RESOURCE_ON) {
 130     THROW1(host_error, 0, "Host %s failed, you cannot call this function",
 131            host->name);
 132   }
 133
 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();
 138
 139   /* initialize them */
 140   act->source = host;
 141   act->name = xbt_strdup(name);
 142 #ifdef HAVE_TRACING
 143   act->category = NULL;
 144 #endif
 145
 146   act->surf_action =
 147     surf_workstation_model->extension.workstation.sleep(host->host, duration);
 148
 149   surf_workstation_model->action_data_set(act->surf_action, act);
 150
 151   DEBUG1("Create sleep action %p", act);
 152   return act;
 153 }
 154
 155 /**
 156  *      \brief Cancels an action.
 157  *
 158  *      This functions stops the execution of an action. It calls a surf functions.
 159  *      \param action The SIMIX action
 160  */
 161 XBT_INLINE void SIMIX_action_cancel(smx_action_t action)
 162 {
 163   xbt_assert0((action != NULL), "Invalid parameter");
 164
 165   DEBUG1("Cancel action %p", action);
 166   if (action->surf_action) {
 167     surf_workstation_model->action_cancel(action->surf_action);
 168   }
 169   return;
 170 }
 171
 172 /**
 173  *      \brief Changes the action's priority
 174  *
 175  *      This functions changes the priority only. It calls a surf functions.
 176  *      \param action The SIMIX action
 177  *      \param priority The new priority
 178  */
 179 XBT_INLINE void SIMIX_action_set_priority(smx_action_t action, double priority)
 180 {
 181   xbt_assert0((action != NULL), "Invalid parameter");
 182
 183   surf_workstation_model->set_priority(action->surf_action, priority);
 184   return;
 185 }
 186
 187 /**
 188  *      \brief Destroys an action
 189  *
 190  *      Destroys an action, freing its memory. This function cannot be called if there are a conditional waiting for it.
 191  *      \param action The SIMIX action
 192  */
 193 int SIMIX_action_destroy(smx_action_t action)
 194 {
 195   XBT_IN3("(%p:'%s',%d)", action, action->name, action->refcount);
 196   xbt_assert0((action != NULL), "Invalid parameter");
 197
 198   action->refcount--;
 199   if (action->refcount > 0)
 200     return 0;
 201
 202   xbt_assert1((xbt_fifo_size(action->cond_list) == 0),
 203               "Conditional list not empty %d. There is a problem. Cannot destroy it now!",
 204               xbt_fifo_size(action->cond_list));
 205
 206   xbt_assert1((xbt_fifo_size(action->sem_list) == 0),
 207               "Semaphore list not empty %d. There is a problem. Cannot destroy it now!",
 208               xbt_fifo_size(action->sem_list));
 209
 210   DEBUG1("Destroy action %p", action);
 211   if (action->name)
 212     xbt_free(action->name);
 213
 214   xbt_fifo_free(action->cond_list);
 215   xbt_fifo_free(action->sem_list);
 216
 217   if (action->surf_action)
 218     action->surf_action->model_type->action_unref(action->surf_action);
 219 #ifdef HAVE_TRACING
 220   TRACE_smx_action_destroy (action);
 221 #endif
 222   xbt_free(action);
 223   return 1;
 224 }
 225
 226 /**
 227  *      \brief Increase refcount of anan action
 228  *
 229  *      \param action The SIMIX action
 230  */
 231 XBT_INLINE void SIMIX_action_use(smx_action_t action)
 232 {
 233   XBT_IN3("(%p:'%s',%d)", action, action->name, action->refcount);
 234   xbt_assert0((action != NULL), "Invalid parameter");
 235
 236   action->refcount++;
 237
 238   return;
 239 }
 240
 241 /**
 242  *      \brief Decrease refcount of anan action
 243  *
 244  *      \param action The SIMIX action
 245  */
 246 XBT_INLINE void SIMIX_action_release(smx_action_t action)
 247 {
 248   xbt_assert0((action != NULL), "Invalid parameter");
 249
 250   action->refcount--;
 251
 252   return;
 253 }
 254
 255 /**
 256  *  \brief Set an action to a condition
 257  *
 258  *  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.
 259  *  \param action SIMIX action
 260  *  \param cond SIMIX cond
 261  */
 262 void SIMIX_register_action_to_condition(smx_action_t action, smx_cond_t cond)
 263 {
 264   xbt_assert0((action != NULL) && (cond != NULL), "Invalid parameters");
 265
 266   DEBUG2("Register action %p to cond %p", action, cond);
 267   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 268     __SIMIX_cond_display_actions(cond);
 269
 270   xbt_fifo_push(cond->actions, action);
 271
 272   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 273     __SIMIX_cond_display_actions(cond);
 274
 275   DEBUG2("Register condition %p to action %p", cond, action);
 276
 277   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 278     __SIMIX_action_display_conditions(action);
 279
 280   xbt_fifo_push(action->cond_list, cond);
 281
 282   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 283     __SIMIX_action_display_conditions(action);
 284 }
 285
 286 /**
 287  *  \brief Unset an action to a condition.
 288  *
 289  *  Destroys the "links" from the condition to this action.
 290  *  \param action SIMIX action
 291  *  \param cond SIMIX cond
 292  */
 293 void SIMIX_unregister_action_to_condition(smx_action_t action,
 294                                           smx_cond_t cond)
 295 {
 296   xbt_assert0((action != NULL) && (cond != NULL), "Invalid parameters");
 297
 298   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 299     __SIMIX_cond_display_actions(cond);
 300
 301   xbt_fifo_remove_all(cond->actions, action);
 302
 303   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 304     __SIMIX_cond_display_actions(cond);
 305
 306   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 307     __SIMIX_action_display_conditions(action);
 308
 309   xbt_fifo_remove_all(action->cond_list, cond);
 310
 311   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 312     __SIMIX_action_display_conditions(action);
 313 }
 314 /**
 315  *  \brief Link an action to a semaphore
 316  *
 317  *  When the action terminates, the semaphore gets signaled automatically.
 318  */
 319 XBT_INLINE void SIMIX_register_action_to_semaphore(smx_action_t action, smx_sem_t sem) {
 320
 321   DEBUG2("Register action %p to semaphore %p (and otherwise)", action, sem);
 322   xbt_fifo_push(sem->actions, action);
 323   xbt_fifo_push(action->sem_list, sem);
 324 }
 325 /**
 326  *  \brief Unset an action to a semaphore.
 327  *
 328  *  Destroys the "links" from the semaphore to this action.
 329  */
 330 XBT_INLINE void SIMIX_unregister_action_to_semaphore(smx_action_t action,
 331                                           smx_sem_t sem)
 332 {
 333   xbt_fifo_remove_all(sem->actions, action);
 334   xbt_fifo_remove_all(action->sem_list, sem);
 335 }
 336
 337 /**
 338  *      \brief Return how much remais to be done in the action.
 339  *
 340  *      \param action The SIMIX action
 341  *      \return Remains cost
 342  */
 343 XBT_INLINE double SIMIX_action_get_remains(smx_action_t action)
 344 {
 345   xbt_assert0((action != NULL), "Invalid parameter");
 346   return surf_workstation_model->get_remains(action->surf_action);
 347 }
 348
 349 smx_action_t SIMIX_action_parallel_execute(char *name, int host_nb,
 350                                            smx_host_t * host_list,
 351                                            double *computation_amount,
 352                                            double *communication_amount,
 353                                            double amount, double rate)
 354 {
 355   void **workstation_list = NULL;
 356   smx_action_t act;
 357   int i;
 358
 359   /* alloc structures */
 360   act = xbt_new0(s_smx_action_t, 1);
 361   act->cond_list = xbt_fifo_new();
 362   act->sem_list = xbt_fifo_new();
 363
 364   /* initialize them */
 365   act->name = xbt_strdup(name);
 366 #ifdef HAVE_TRACING
 367   act->category = NULL;
 368 #endif
 369
 370   /* set action */
 371
 372   workstation_list = xbt_new0(void *, host_nb);
 373   for (i = 0; i < host_nb; i++)
 374     workstation_list[i] = host_list[i]->host;
 375
 376   act->surf_action =
 377     surf_workstation_model->extension.workstation.
 378     execute_parallel_task(host_nb, workstation_list, computation_amount,
 379                           communication_amount, amount, rate);
 380
 381   surf_workstation_model->action_data_set(act->surf_action, act);
 382
 383   return act;
 384 }
 385
 386 XBT_INLINE e_surf_action_state_t SIMIX_action_get_state(smx_action_t action)
 387 {
 388   xbt_assert0((action != NULL), "Invalid parameter");
 389   return surf_workstation_model->action_state_get(action->surf_action);
 390 }
 391
 392 void __SIMIX_cond_display_actions(smx_cond_t cond)
 393 {
 394   xbt_fifo_item_t item = NULL;
 395   smx_action_t action = NULL;
 396
 397   DEBUG1("Actions for condition %p", cond);
 398   xbt_fifo_foreach(cond->actions, item, action, smx_action_t)
 399     DEBUG2("\t %p [%s]", action, action->name);
 400 }
 401
 402 void __SIMIX_action_display_conditions(smx_action_t action)
 403 {
 404   xbt_fifo_item_t item = NULL;
 405   smx_cond_t cond = NULL;
 406
 407   DEBUG1("Conditions for action %p", action);
 408   xbt_fifo_foreach(action->cond_list, item, cond, smx_cond_t)
 409     DEBUG1("\t %p", cond);
 410 }
 411
 412 XBT_INLINE char *SIMIX_action_get_name(smx_action_t action)
 413 {
 414   xbt_assert0((action != NULL), "Invalid parameter");
 415   return action->name;
 416 }
 417 /** @brief Change the name of the action. Warning, the string you provide is not strdup()ed */
 418 XBT_INLINE void SIMIX_action_set_name(smx_action_t action,char *name)
 419 {
 420   xbt_free(action->name);
 421   action->name = name;
 422 }
 423
 424 /** @brief broadcast any condition and release any semaphore including this action */
 425 void SIMIX_action_signal_all(smx_action_t action){
 426   smx_cond_t cond;
 427   smx_sem_t sem;
 428
 429   while ((cond = xbt_fifo_pop(action->cond_list)))
 430     SIMIX_cond_broadcast(cond);
 431
 432   while ((sem = xbt_fifo_pop(action->sem_list)))
 433     SIMIX_sem_release(sem);
 434 }