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