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
  49   /* initialize them */
  50   act->name = xbt_strdup(name);
  51   act->source = sender;
  52
  53
  54   act->surf_action =
  55     surf_workstation_model->extension.workstation.communicate(sender->host,
  56                                                               receiver->host,
  57                                                               size, rate);
  58   surf_workstation_model->action_data_set(act->surf_action, act);
  59
  60   DEBUG1("Create communicate action %p", act);
  61   return act;
  62 }
  63
  64 /** \brief Creates a new SIMIX action to execute an action.
  65  *
  66  *      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.
  67  *      \param host SIMIX host where the action will be executed
  68  *      \param name Action name
  69  *      \param amount Task amount (in bytes)
  70  *      \return A new SIMIX action
  71  * */
  72 smx_action_t SIMIX_action_execute(smx_host_t host, const char *name,
  73                                   double amount)
  74 {
  75   smx_action_t act;
  76
  77   /* check if the host is active */
  78   if (surf_workstation_model->extension.workstation.get_state(host->host) !=
  79       SURF_RESOURCE_ON) {
  80     THROW1(host_error, 0, "Host %s failed, you cannot call this function",
  81            host->name);
  82   }
  83
  84   /* alloc structures */
  85   act = xbt_new0(s_smx_action_t, 1);
  86   act->cond_list = xbt_fifo_new();
  87
  88   /* initialize them */
  89   act->source = host;
  90   act->name = xbt_strdup(name);
  91
  92   /* set communication */
  93   act->surf_action =
  94     surf_workstation_model->extension.workstation.execute(host->host, amount);
  95
  96   surf_workstation_model->action_data_set(act->surf_action, act);
  97
  98   DEBUG1("Create execute action %p", act);
  99   return act;
 100 }
 101
 102 /** \brief Creates a new sleep SIMIX action.
 103  *
 104  *      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. The default SIMIX name of the action is "sleep".
 105  *      \param host SIMIX host where the sleep will run.
 106  *      \param duration Time duration of the sleep.
 107  *      \return A new SIMIX action
 108  * */
 109 smx_action_t SIMIX_action_sleep(smx_host_t host, double duration)
 110 {
 111   char name[] = "sleep";
 112   smx_action_t act;
 113
 114   /* check if the host is active */
 115   if (surf_workstation_model->extension.workstation.get_state(host->host) !=
 116       SURF_RESOURCE_ON) {
 117     THROW1(host_error, 0, "Host %s failed, you cannot call this function",
 118            host->name);
 119   }
 120
 121   /* alloc structures */
 122   act = xbt_new0(s_smx_action_t, 1);
 123   act->cond_list = xbt_fifo_new();
 124
 125   /* initialize them */
 126   act->source = host;
 127   act->name = xbt_strdup(name);
 128
 129   act->surf_action =
 130     surf_workstation_model->extension.workstation.sleep(host->host, duration);
 131
 132   surf_workstation_model->action_data_set(act->surf_action, act);
 133
 134   DEBUG1("Create sleep action %p", act);
 135   return act;
 136 }
 137
 138 /**
 139  *      \brief Cancels an action.
 140  *
 141  *      This functions stops the execution of an action. It calls a surf functions.
 142  *      \param action The SIMIX action
 143  */
 144 void SIMIX_action_cancel(smx_action_t action)
 145 {
 146   xbt_assert0((action != NULL), "Invalid parameter");
 147
 148   DEBUG1("Cancel action %p", action);
 149   if (action->surf_action) {
 150     surf_workstation_model->action_cancel(action->surf_action);
 151   }
 152   return;
 153 }
 154
 155 /**
 156  *      \brief Changes the action's priority
 157  *
 158  *      This functions changes the priority only. It calls a surf functions.
 159  *      \param action The SIMIX action
 160  *      \param priority The new priority
 161  */
 162 void SIMIX_action_set_priority(smx_action_t action, double priority)
 163 {
 164   xbt_assert0((action != NULL), "Invalid parameter");
 165
 166   surf_workstation_model->set_priority(action->surf_action, priority);
 167   return;
 168 }
 169
 170 /**
 171  *      \brief Destroys an action
 172  *
 173  *      Destroys an action, freing its memory. This function cannot be called if there are a conditional waiting for it.
 174  *      \param action The SIMIX action
 175  */
 176 int SIMIX_action_destroy(smx_action_t action)
 177 {
 178   XBT_IN3("(%p:'%s',%d)", action, action->name, action->refcount);
 179   xbt_assert0((action != NULL), "Invalid parameter");
 180
 181   action->refcount--;
 182   if (action->refcount > 0)
 183     return 0;
 184
 185   xbt_assert1((xbt_fifo_size(action->cond_list) == 0),
 186               "Conditional list not empty %d. There is a problem. Cannot destroy it now!",
 187               xbt_fifo_size(action->cond_list));
 188
 189   DEBUG1("Destroy action %p", action);
 190   if (action->name)
 191     xbt_free(action->name);
 192
 193   xbt_fifo_free(action->cond_list);
 194
 195   if (action->surf_action)
 196     action->surf_action->model_type->action_unref(action->surf_action);
 197
 198   xbt_free(action);
 199   return 1;
 200 }
 201
 202 /**
 203  *      \brief Increase refcount of anan action
 204  *
 205  *      \param action The SIMIX action
 206  */
 207 void SIMIX_action_use(smx_action_t action)
 208 {
 209   XBT_IN3("(%p:'%s',%d)", action, action->name, action->refcount);
 210   xbt_assert0((action != NULL), "Invalid parameter");
 211
 212   action->refcount++;
 213
 214   return;
 215 }
 216
 217 /**
 218  *      \brief Decrease refcount of anan action
 219  *
 220  *      \param action The SIMIX action
 221  */
 222 void SIMIX_action_release(smx_action_t action)
 223 {
 224   xbt_assert0((action != NULL), "Invalid parameter");
 225
 226   action->refcount--;
 227
 228   return;
 229 }
 230
 231 /**
 232  *      \brief Set an action to a condition
 233  *
 234  *      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.
 235  *      \param action SIMIX action
 236  *      \param cond SIMIX cond
 237  */
 238 void SIMIX_register_action_to_condition(smx_action_t action, smx_cond_t cond)
 239 {
 240   xbt_assert0((action != NULL) && (cond != NULL), "Invalid parameters");
 241
 242   DEBUG2("Register action %p to cond %p", action, cond);
 243   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 244     __SIMIX_cond_display_actions(cond);
 245
 246   xbt_fifo_push(cond->actions, action);
 247
 248   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 249     __SIMIX_cond_display_actions(cond);
 250
 251   DEBUG2("Register condition %p to action %p", cond, action);
 252
 253   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 254     __SIMIX_action_display_conditions(action);
 255
 256   xbt_fifo_push(action->cond_list, cond);
 257
 258   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 259     __SIMIX_action_display_conditions(action);
 260 }
 261
 262 /**
 263  *      \brief Unset an action to a condition.
 264  *
 265  *      Destroys the "links" from the condition to this action.
 266  *      \param action SIMIX action
 267  *      \param cond SIMIX cond
 268  */
 269 void SIMIX_unregister_action_to_condition(smx_action_t action,
 270                                           smx_cond_t cond)
 271 {
 272   xbt_assert0((action != NULL) && (cond != NULL), "Invalid parameters");
 273
 274   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 275     __SIMIX_cond_display_actions(cond);
 276
 277   xbt_fifo_remove_all(cond->actions, action);
 278
 279   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 280     __SIMIX_cond_display_actions(cond);
 281
 282   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 283     __SIMIX_action_display_conditions(action);
 284
 285   xbt_fifo_remove_all(action->cond_list, cond);
 286
 287   if(XBT_LOG_ISENABLED(simix_action, xbt_log_priority_debug))
 288     __SIMIX_action_display_conditions(action);
 289 }
 290
 291 /**
 292  *      \brief Return how much remais to be done in the action.
 293  *
 294  *      \param action The SIMIX action
 295  *      \return Remains cost
 296  */
 297 double SIMIX_action_get_remains(smx_action_t action)
 298 {
 299   xbt_assert0((action != NULL), "Invalid parameter");
 300   return surf_workstation_model->get_remains(action->surf_action);
 301 }
 302
 303 smx_action_t SIMIX_action_parallel_execute(char *name, int host_nb,
 304                                            smx_host_t * host_list,
 305                                            double *computation_amount,
 306                                            double *communication_amount,
 307                                            double amount, double rate)
 308 {
 309   void **workstation_list = NULL;
 310   smx_action_t act;
 311   int i;
 312
 313   /* alloc structures */
 314   act = xbt_new0(s_smx_action_t, 1);
 315   act->cond_list = xbt_fifo_new();
 316
 317   /* initialize them */
 318   act->name = xbt_strdup(name);
 319
 320   /* set action */
 321
 322   workstation_list = xbt_new0(void *, host_nb);
 323   for (i = 0; i < host_nb; i++)
 324     workstation_list[i] = host_list[i]->host;
 325
 326   act->surf_action =
 327     surf_workstation_model->extension.workstation.
 328     execute_parallel_task(host_nb, workstation_list, computation_amount,
 329                           communication_amount, amount, rate);
 330
 331   surf_workstation_model->action_data_set(act->surf_action, act);
 332
 333   return act;
 334 }
 335
 336 e_surf_action_state_t SIMIX_action_get_state(smx_action_t action)
 337 {
 338   xbt_assert0((action != NULL), "Invalid parameter");
 339   return surf_workstation_model->action_state_get(action->surf_action);
 340 }
 341
 342 void __SIMIX_cond_display_actions(smx_cond_t cond)
 343 {
 344   xbt_fifo_item_t item = NULL;
 345   smx_action_t action = NULL;
 346
 347   DEBUG1("Actions for condition %p", cond);
 348   xbt_fifo_foreach(cond->actions, item, action, smx_action_t)
 349     DEBUG2("\t %p [%s]", action, action->name);
 350 }
 351
 352 void __SIMIX_action_display_conditions(smx_action_t action)
 353 {
 354   xbt_fifo_item_t item = NULL;
 355   smx_cond_t cond = NULL;
 356
 357   DEBUG1("Conditions for action %p", action);
 358   xbt_fifo_foreach(action->cond_list, item, cond, smx_cond_t)
 359     DEBUG1("\t %p", cond);
 360 }
 361
 362 char *SIMIX_action_get_name(smx_action_t action)
 363 {
 364   xbt_assert0((action != NULL), "Invalid parameter");
 365   return action->name;
 366 }
 367
 368 void SIMIX_action_signal_all(smx_action_t action)
 369 {
 370   smx_cond_t cond;
 371
 372   while ((cond = xbt_fifo_pop(action->cond_list)))
 373     SIMIX_cond_broadcast(cond);
 374
 375   return;
 376 }