src/simdag/sd_workstation.c

   1 #include "private.h"
   2 #include "simdag/simdag.h"
   3 #include "xbt/dict.h"
   4 #include "xbt/sysdep.h"
   5 #include "surf/surf.h"
   6
   7 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_workstation, sd,
   8                                 "Logging specific to SimDag (workstation)");
   9
  10 /* Creates a workstation and registers it in SD.
  11  */
  12 SD_workstation_t __SD_workstation_create(void *surf_workstation, void *data)
  13 {
  14
  15   SD_workstation_t workstation;
  16   const char *name;
  17   SD_CHECK_INIT_DONE();
  18   xbt_assert0(surf_workstation != NULL, "surf_workstation is NULL !");
  19
  20   workstation = xbt_new(s_SD_workstation_t, 1);
  21   workstation->surf_workstation = surf_workstation;
  22   workstation->data = data;     /* user data */
  23   workstation->access_mode = SD_WORKSTATION_SHARED_ACCESS;      /* default mode is shared */
  24   workstation->task_fifo = NULL;
  25   workstation->current_task = NULL;
  26
  27   name = SD_workstation_get_name(workstation);
  28   xbt_dict_set(sd_global->workstations, name, workstation, __SD_workstation_destroy);   /* add the workstation to the dictionary */
  29   sd_global->workstation_count++;
  30
  31   return workstation;
  32 }
  33
  34 /**
  35  * \brief Returns a workstation given its name
  36  *
  37  * If there is no such workstation, the function returns \c NULL.
  38  *
  39  * \param name workstation name
  40  * \return the workstation, or \c NULL if there is no such workstation
  41  */
  42 SD_workstation_t SD_workstation_get_by_name(const char *name)
  43 {
  44   SD_CHECK_INIT_DONE();
  45
  46   xbt_assert0(name != NULL, "Invalid parameter");
  47
  48   return xbt_dict_get_or_null(sd_global->workstations, name);
  49 }
  50
  51 /**
  52  * \brief Returns the workstation list
  53  *
  54  * Use SD_workstation_get_number() to know the array size.
  55  *
  56  * \return an array of \ref SD_workstation_t containing all workstations
  57  * \see SD_workstation_get_number()
  58  */
  59 const SD_workstation_t *SD_workstation_get_list(void)
  60 {
  61
  62   xbt_dict_cursor_t cursor;
  63   char *key;
  64   void *data;
  65   int i;
  66
  67   SD_CHECK_INIT_DONE();
  68   xbt_assert0(SD_workstation_get_number() > 0, "There is no workstation!");
  69
  70
  71
  72   if (sd_global->workstation_list == NULL) {    /* this is the first time the function is called */
  73     sd_global->workstation_list =
  74       xbt_new(SD_workstation_t, sd_global->workstation_count);
  75
  76     i = 0;
  77     xbt_dict_foreach(sd_global->workstations, cursor, key, data) {
  78       sd_global->workstation_list[i++] = (SD_workstation_t) data;
  79     }
  80   }
  81   return sd_global->workstation_list;
  82 }
  83
  84 /**
  85  * \brief Returns the number of workstations
  86  *
  87  * \return the number of existing workstations
  88  * \see SD_workstation_get_list()
  89  */
  90 int SD_workstation_get_number(void)
  91 {
  92   SD_CHECK_INIT_DONE();
  93   return sd_global->workstation_count;
  94 }
  95
  96 /**
  97  * \brief Returns the user data of a workstation
  98  *
  99  * \param workstation a workstation
 100  * \return the user data associated with this workstation (can be \c NULL)
 101  * \see SD_workstation_set_data()
 102  */
 103 void *SD_workstation_get_data(SD_workstation_t workstation)
 104 {
 105   SD_CHECK_INIT_DONE();
 106   xbt_assert0(workstation != NULL, "Invalid parameter");
 107   return workstation->data;
 108 }
 109
 110 /**
 111  * \brief Sets the user data of a workstation
 112  *
 113  * The new data can be \c NULL. The old data should have been freed first
 114  * if it was not \c NULL.
 115  *
 116  * \param workstation a workstation
 117  * \param data the new data you want to associate with this workstation
 118  * \see SD_workstation_get_data()
 119  */
 120 void SD_workstation_set_data(SD_workstation_t workstation, void *data)
 121 {
 122   SD_CHECK_INIT_DONE();
 123   xbt_assert0(workstation != NULL, "Invalid parameter");
 124   workstation->data = data;
 125 }
 126
 127 /**
 128  * \brief Returns the name of a workstation
 129  *
 130  * \param workstation a workstation
 131  * \return the name of this workstation (cannot be \c NULL)
 132  */
 133 const char *SD_workstation_get_name(SD_workstation_t workstation)
 134 {
 135   SD_CHECK_INIT_DONE();
 136   xbt_assert0(workstation != NULL, "Invalid parameter");
 137   return surf_workstation_model->common_public->
 138     get_resource_name(workstation->surf_workstation);
 139 }
 140
 141 /**
 142  * \brief Returns the value of a given workstation property
 143  *
 144  * \param ws a workstation
 145  * \param name a property name
 146  * \return value of a property (or NULL if property not set)
 147  */
 148 const char *SD_workstation_get_property_value(SD_workstation_t ws,
 149                                               const char *name)
 150 {
 151   return xbt_dict_get_or_null(SD_workstation_get_properties(ws), name);
 152 }
 153
 154
 155 /**
 156  * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to this workstation
 157  *
 158  * \param workstation a workstation
 159  * \return the dictionary containing the properties associated with the workstation
 160  */
 161 xbt_dict_t SD_workstation_get_properties(SD_workstation_t workstation)
 162 {
 163   SD_CHECK_INIT_DONE();
 164   xbt_assert0((workstation != NULL), "Invalid parameters");
 165
 166   return (surf_workstation_model->common_public->
 167           get_properties(workstation->surf_workstation));
 168
 169 }
 170
 171
 172 /**
 173  * \brief Returns the route between two workstations
 174  *
 175  * Use SD_route_get_size() to know the array size.
 176  *
 177  * \param src a workstation
 178  * \param dst another workstation
 179  * \return a new array of \ref SD_link_t representating the route between these two workstations
 180  * \see SD_route_get_size(), SD_link_t
 181  */
 182 const SD_link_t *SD_route_get_list(SD_workstation_t src, SD_workstation_t dst)
 183 {
 184   void *surf_src;
 185   void *surf_dst;
 186   const void **surf_route;
 187   int route_size;
 188   const char *link_name;
 189   int i;
 190
 191   SD_CHECK_INIT_DONE();
 192
 193   if (sd_global->recyclable_route == NULL) {
 194     /* first run */
 195     sd_global->recyclable_route = xbt_new(SD_link_t, SD_link_get_number());
 196   }
 197
 198   surf_src = src->surf_workstation;
 199   surf_dst = dst->surf_workstation;
 200
 201   surf_route =
 202     surf_workstation_model->extension_public->get_route(surf_src, surf_dst);
 203   route_size =
 204     surf_workstation_model->extension_public->get_route_size(surf_src,
 205                                                              surf_dst);
 206
 207
 208   for (i = 0; i < route_size; i++) {
 209     link_name =
 210       surf_workstation_model->extension_public->get_link_name(surf_route[i]);
 211     sd_global->recyclable_route[i] =
 212       xbt_dict_get(sd_global->links, link_name);
 213   }
 214
 215   return sd_global->recyclable_route;
 216 }
 217
 218 /**
 219  * \brief Returns the number of links on the route between two workstations
 220  *
 221  * \param src a workstation
 222  * \param dst another workstation
 223  * \return the number of links on the route between these two workstations
 224  * \see SD_route_get_list()
 225  */
 226 int SD_route_get_size(SD_workstation_t src, SD_workstation_t dst)
 227 {
 228   SD_CHECK_INIT_DONE();
 229   return surf_workstation_model->extension_public->get_route_size(src->
 230                                                                   surf_workstation,
 231                                                                   dst->
 232                                                                   surf_workstation);
 233 }
 234
 235 /**
 236  * \brief Returns the total power of a workstation
 237  *
 238  * \param workstation a workstation
 239  * \return the total power of this workstation
 240  * \see SD_workstation_get_available_power()
 241  */
 242 double SD_workstation_get_power(SD_workstation_t workstation)
 243 {
 244   SD_CHECK_INIT_DONE();
 245   xbt_assert0(workstation != NULL, "Invalid parameter");
 246   return surf_workstation_model->extension_public->get_speed(workstation->
 247                                                              surf_workstation,
 248                                                              1.0);
 249 }
 250
 251 /**
 252  * \brief Returns the proportion of available power in a workstation
 253  *
 254  * \param workstation a workstation
 255  * \return the proportion of power currently available in this workstation (normally a number between 0 and 1)
 256  * \see SD_workstation_get_power()
 257  */
 258 double SD_workstation_get_available_power(SD_workstation_t workstation)
 259 {
 260   SD_CHECK_INIT_DONE();
 261   xbt_assert0(workstation != NULL, "Invalid parameter");
 262   return surf_workstation_model->extension_public->
 263     get_available_speed(workstation->surf_workstation);
 264 }
 265
 266 /**
 267  * \brief Returns an approximative estimated time for the given computation amount on a workstation
 268  *
 269  * \param workstation a workstation
 270  * \param computation_amount the computation amount you want to evaluate (in flops)
 271  * \return an approximative astimated computation time for the given computation amount on this workstation (in seconds)
 272  */
 273 double SD_workstation_get_computation_time(SD_workstation_t workstation,
 274                                            double computation_amount)
 275 {
 276   SD_CHECK_INIT_DONE();
 277   xbt_assert0(workstation != NULL, "Invalid parameter");
 278   xbt_assert0(computation_amount >= 0,
 279               "computation_amount must be greater than or equal to zero");
 280   return computation_amount / SD_workstation_get_power(workstation);
 281 }
 282
 283 /**
 284  * \brief Returns the latency of the route between two workstations, i.e. the sum of all link latencies
 285  * between the workstations.
 286  *
 287  * \param src the first workstation
 288  * \param dst the second workstation
 289  * \return the latency of the route between the two workstations (in seconds)
 290  * \see SD_route_get_current_bandwidth()
 291  */
 292 double SD_route_get_current_latency(SD_workstation_t src,
 293                                     SD_workstation_t dst)
 294 {
 295
 296   const SD_link_t *links;
 297   int nb_links;
 298   double latency;
 299   int i;
 300
 301   SD_CHECK_INIT_DONE();
 302   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
 303   links = SD_route_get_list(src, dst);
 304   nb_links = SD_route_get_size(src, dst);
 305   latency = 0.0;
 306
 307   for (i = 0; i < nb_links; i++) {
 308     latency += SD_link_get_current_latency(links[i]);
 309   }
 310
 311   return latency;
 312 }
 313
 314 /**
 315  * \brief Returns the bandwidth of the route between two workstations, i.e. the minimum link bandwidth of all
 316  * between the workstations.
 317  *
 318  * \param src the first workstation
 319  * \param dst the second workstation
 320  * \return the bandwidth of the route between the two workstations (in bytes/second)
 321  * \see SD_route_get_current_latency()
 322  */
 323 double SD_route_get_current_bandwidth(SD_workstation_t src,
 324                                       SD_workstation_t dst)
 325 {
 326
 327   const SD_link_t *links;
 328   int nb_links;
 329   double bandwidth;
 330   double min_bandwidth;
 331   int i;
 332
 333   SD_CHECK_INIT_DONE();
 334   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
 335
 336   links = SD_route_get_list(src, dst);
 337   nb_links = SD_route_get_size(src, dst);
 338   bandwidth = min_bandwidth = -1.0;
 339
 340
 341   for (i = 0; i < nb_links; i++) {
 342     bandwidth = SD_link_get_current_bandwidth(links[i]);
 343     if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
 344       min_bandwidth = bandwidth;
 345   }
 346
 347   return min_bandwidth;
 348 }
 349
 350 /**
 351  * \brief Returns an approximative estimated time for the given
 352  * communication amount between two workstations
 353  *
 354  * \param src the first workstation
 355  * \param dst the second workstation
 356  * \param communication_amount the communication amount you want to evaluate (in bytes)
 357  * \return an approximative astimated computation time for the given communication amount
 358  * between the workstations (in seconds)
 359  */
 360 double SD_route_get_communication_time(SD_workstation_t src,
 361                                        SD_workstation_t dst,
 362                                        double communication_amount)
 363 {
 364
 365
 366   /* total time = latency + transmission time of the slowest link
 367      transmission time of a link = communication amount / link bandwidth */
 368
 369   const SD_link_t *links;
 370   int nb_links;
 371   double bandwidth, min_bandwidth;
 372   double latency;
 373   int i;
 374
 375   SD_CHECK_INIT_DONE();
 376   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
 377   xbt_assert0(communication_amount >= 0,
 378               "communication_amount must be greater than or equal to zero");
 379
 380
 381
 382   if (communication_amount == 0.0)
 383     return 0.0;
 384
 385   links = SD_route_get_list(src, dst);
 386   nb_links = SD_route_get_size(src, dst);
 387   min_bandwidth = -1.0;
 388   latency = 0;
 389
 390   for (i = 0; i < nb_links; i++) {
 391     latency += SD_link_get_current_latency(links[i]);
 392     bandwidth = SD_link_get_current_bandwidth(links[i]);
 393     if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
 394       min_bandwidth = bandwidth;
 395   }
 396
 397   return latency + (communication_amount / min_bandwidth);
 398 }
 399
 400 /**
 401  * \brief Returns the access mode of this workstation.
 402  *
 403  * \param workstation a workstation
 404  * \return the access mode for the tasks running on this workstation:
 405  * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
 406  *
 407  * \see SD_workstation_set_access_mode(), e_SD_workstation_access_mode_t
 408  */
 409 e_SD_workstation_access_mode_t SD_workstation_get_access_mode(SD_workstation_t
 410                                                               workstation)
 411 {
 412   SD_CHECK_INIT_DONE();
 413   xbt_assert0(workstation != NULL, "Invalid parameter");
 414   return workstation->access_mode;
 415 }
 416
 417 /**
 418  * \brief Sets the access mode for the tasks that will be executed on a workstation
 419  *
 420  * By default, a workstation model is shared, i.e. several tasks
 421  * can be executed at the same time on a workstation. The CPU power of
 422  * the workstation is shared between the running tasks on the workstation.
 423  * In sequential mode, only one task can use the workstation, and the other
 424  * tasks wait in a FIFO.
 425  *
 426  * \param workstation a workstation
 427  * \param access_mode the access mode you want to set to this workstation:
 428  * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
 429  *
 430  * \see SD_workstation_get_access_mode(), e_SD_workstation_access_mode_t
 431  */
 432 void SD_workstation_set_access_mode(SD_workstation_t workstation,
 433                                     e_SD_workstation_access_mode_t
 434                                     access_mode)
 435 {
 436   SD_CHECK_INIT_DONE();
 437   xbt_assert0(workstation != NULL, "Invalid parameter");
 438
 439   if (access_mode == workstation->access_mode) {
 440     return;                     // nothing is changed
 441   }
 442
 443   workstation->access_mode = access_mode;
 444
 445   if (access_mode == SD_WORKSTATION_SHARED_ACCESS) {
 446     xbt_fifo_free(workstation->task_fifo);
 447     workstation->task_fifo = NULL;
 448   } else {
 449     workstation->task_fifo = xbt_fifo_new();
 450   }
 451 }
 452
 453 /* Returns whether a task can start now on a workstation.
 454                       *//*
 455                int __SD_workstation_can_start(SD_workstation_t workstation, SD_task_t task) {
 456                SD_CHECK_INIT_DONE();
 457                xbt_assert0(workstation != NULL && task != NULL, "Invalid parameter");
 458
 459                return !__SD_workstation_is_busy(workstation) &&
 460                (xbt_fifo_size(workstation->task_fifo) == 0) || xbt_fifo_get_first_item(workstation->task_fifo) == task);
 461                }
 462              */
 463
 464 /* Returns whether a workstation is busy. A workstation is busy is it is
 465  * in sequential mode and a task is running on it or the fifo is not empty.
 466  */
 467 int __SD_workstation_is_busy(SD_workstation_t workstation)
 468 {
 469   SD_CHECK_INIT_DONE();
 470   xbt_assert0(workstation != NULL, "Invalid parameter");
 471
 472   DEBUG4
 473     ("Workstation '%s' access mode: '%s', current task: %s, fifo size: %d",
 474      SD_workstation_get_name(workstation),
 475      (workstation->access_mode ==
 476       SD_WORKSTATION_SHARED_ACCESS) ? "SHARED" : "FIFO",
 477      (workstation->current_task ? SD_task_get_name(workstation->current_task)
 478       : "none"),
 479      (workstation->task_fifo ? xbt_fifo_size(workstation->task_fifo) : 0));
 480
 481   return workstation->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS &&
 482     (workstation->current_task != NULL
 483      || xbt_fifo_size(workstation->task_fifo) > 0);
 484 }
 485
 486 /* Destroys a workstation.
 487  */
 488 void __SD_workstation_destroy(void *workstation)
 489 {
 490
 491   SD_workstation_t w;
 492
 493   SD_CHECK_INIT_DONE();
 494   xbt_assert0(workstation != NULL, "Invalid parameter");
 495   /* workstation->surf_workstation is freed by surf_exit and workstation->data is freed by the user */
 496
 497   w = (SD_workstation_t) workstation;
 498
 499   if (w->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS) {
 500     xbt_fifo_free(w->task_fifo);
 501   }
 502   xbt_free(w);
 503 }