src/simdag/sd_workstation.c

   1 /* Copyright (c) 2006-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include "private.h"
   8 #include "simdag/simdag.h"
   9 #include "xbt/dict.h"
  10 #include "xbt/lib.h"
  11 #include "xbt/sysdep.h"
  12 #include "surf/surf.h"
  13 #include "surf/surf_resource.h"
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_workstation, sd,
  16                                 "Logging specific to SimDag (workstation)");
  17
  18 /* Creates a workstation and registers it in SD.
  19  */
  20 SD_workstation_t __SD_workstation_create(void *surf_workstation,
  21                                          void *data)
  22 {
  23
  24   SD_workstation_priv_t workstation;
  25   const char *name;
  26
  27   workstation = xbt_new(s_SD_workstation_priv_t, 1);
  28   workstation->data = data;     /* user data */
  29   workstation->access_mode = SD_WORKSTATION_SHARED_ACCESS;      /* default mode is shared */
  30   workstation->task_fifo = NULL;
  31   workstation->current_task = NULL;
  32
  33   name = surf_resource_name(surf_workstation);
  34   xbt_lib_set(host_lib,name,SD_HOST_LEVEL,workstation);
  35   return xbt_lib_get_elm_or_null(host_lib,name);
  36 }
  37
  38 /* Creates a storage and registers it in SD.
  39  */
  40 SD_storage_t __SD_storage_create(void *surf_storage, void *data)
  41 {
  42
  43   SD_storage_priv_t storage;
  44   const char *name;
  45
  46   storage = xbt_new(s_SD_storage_priv_t, 1);
  47   storage->data = data;     /* user data */
  48   name = surf_resource_name(surf_storage);
  49   storage->host = surf_storage_get_host(surf_storage_resource_by_name(name));
  50   xbt_lib_set(storage_lib,name, SD_STORAGE_LEVEL, storage);
  51   return xbt_lib_get_elm_or_null(storage_lib, name);
  52 }
  53
  54 /* Destroys a storage.
  55  */
  56 void __SD_storage_destroy(void *storage)
  57 {
  58   SD_storage_priv_t s;
  59
  60   s = (SD_storage_priv_t) storage;
  61   xbt_free(s);
  62 }
  63
  64 /**
  65  * \brief Returns a workstation given its name
  66  *
  67  * If there is no such workstation, the function returns \c NULL.
  68  *
  69  * \param name workstation name
  70  * \return the workstation, or \c NULL if there is no such workstation
  71  */
  72 SD_workstation_t SD_workstation_get_by_name(const char *name)
  73 {
  74   return xbt_lib_get_elm_or_null(host_lib, name);
  75 }
  76
  77 /**
  78  * \brief Returns the workstation list
  79  *
  80  * Use SD_workstation_get_number() to know the array size.
  81  *
  82  * \return an array of \ref SD_workstation_t containing all workstations
  83  * \see SD_workstation_get_number()
  84  */
  85 const SD_workstation_t *SD_workstation_get_list(void)
  86 {
  87
  88   xbt_lib_cursor_t cursor;
  89   char *key;
  90   void **data;
  91   int i;
  92
  93   xbt_assert(SD_workstation_get_number() > 0, "There is no workstation!");
  94
  95   if (sd_global->workstation_list == NULL) {    /* this is the first time the function is called */
  96     sd_global->workstation_list =
  97       xbt_new(SD_workstation_t, xbt_lib_length(host_lib));
  98
  99     i = 0;
 100     xbt_lib_foreach(host_lib, cursor, key, data) {
 101       if(data[SD_HOST_LEVEL])
 102         sd_global->workstation_list[i++] = xbt_dict_cursor_get_elm(cursor);
 103     }
 104   }
 105   return sd_global->workstation_list;
 106 }
 107
 108 /**
 109  * \brief Returns the number of workstations
 110  *
 111  * \return the number of existing workstations
 112  * \see SD_workstation_get_list()
 113  */
 114 int SD_workstation_get_number(void)
 115 {
 116   return xbt_lib_length(host_lib);
 117 }
 118
 119 /**
 120  * \brief Returns the user data of a workstation
 121  *
 122  * \param workstation a workstation
 123  * \return the user data associated with this workstation (can be \c NULL)
 124  * \see SD_workstation_set_data()
 125  */
 126 void *SD_workstation_get_data(SD_workstation_t workstation)
 127 {
 128   return SD_workstation_priv(workstation)->data;
 129 }
 130
 131 /**
 132  * \brief Sets the user data of a workstation
 133  *
 134  * The new data can be \c NULL. The old data should have been freed first
 135  * if it was not \c NULL.
 136  *
 137  * \param workstation a workstation
 138  * \param data the new data you want to associate with this workstation
 139  * \see SD_workstation_get_data()
 140  */
 141 void SD_workstation_set_data(SD_workstation_t workstation, void *data)
 142 {
 143   SD_workstation_priv(workstation)->data = data;
 144 }
 145
 146 /**
 147  * \brief Returns the name of a workstation
 148  *
 149  * \param workstation a workstation
 150  * \return the name of this workstation (cannot be \c NULL)
 151  */
 152 const char *SD_workstation_get_name(SD_workstation_t workstation)
 153 {
 154   return sg_host_name(workstation);
 155 }
 156
 157 /**
 158  * \brief Returns the value of a given workstation property
 159  *
 160  * \param ws a workstation
 161  * \param name a property name
 162  * \return value of a property (or NULL if property not set)
 163  */
 164 const char *SD_workstation_get_property_value(SD_workstation_t ws,
 165                                               const char *name)
 166 {
 167   return xbt_dict_get_or_null(SD_workstation_get_properties(ws), name);
 168 }
 169
 170
 171 /**
 172  * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to this workstation
 173  *
 174  * \param workstation a workstation
 175  * \return the dictionary containing the properties associated with the workstation
 176  */
 177 xbt_dict_t SD_workstation_get_properties(SD_workstation_t workstation)
 178 {
 179   return surf_resource_get_properties(surf_workstation_resource_priv(workstation));
 180 }
 181
 182
 183 /** @brief Displays debugging informations about a workstation */
 184 void SD_workstation_dump(SD_workstation_t ws)
 185 {
 186   xbt_dict_t props;
 187   xbt_dict_cursor_t cursor=NULL;
 188   char *key,*data;
 189   SD_task_t task = NULL;
 190
 191   XBT_INFO("Displaying workstation %s", SD_workstation_get_name(ws));
 192   XBT_INFO("  - power: %.0f", SD_workstation_get_power(ws));
 193   XBT_INFO("  - available power: %.2f", SD_workstation_get_available_power(ws));
 194   switch (SD_workstation_priv(ws)->access_mode){
 195   case SD_WORKSTATION_SHARED_ACCESS:
 196       XBT_INFO("  - access mode: Space shared");
 197       break;
 198   case SD_WORKSTATION_SEQUENTIAL_ACCESS:
 199       XBT_INFO("  - access mode: Exclusive");
 200     task = SD_workstation_get_current_task(ws);
 201     if(task)
 202       XBT_INFO("    current running task: %s",
 203                SD_task_get_name(task));
 204     else
 205       XBT_INFO("    no task running");
 206       break;
 207   default: break;
 208   }
 209   props = SD_workstation_get_properties(ws);
 210
 211   if (!xbt_dict_is_empty(props)){
 212     XBT_INFO("  - properties:");
 213
 214     xbt_dict_foreach(props,cursor,key,data) {
 215       XBT_INFO("    %s->%s",key,data);
 216     }
 217   }
 218 }
 219
 220 /**
 221  * \brief Returns the route between two workstations
 222  *
 223  * Use SD_route_get_size() to know the array size.
 224  *
 225  * \param src a workstation
 226  * \param dst another workstation
 227  * \return a new array of \ref SD_link_t representating the route between these two workstations
 228  * \see SD_route_get_size(), SD_link_t
 229  */
 230 const SD_link_t *SD_route_get_list(SD_workstation_t src,
 231                                    SD_workstation_t dst)
 232 {
 233   void *surf_src;
 234   void *surf_dst;
 235   xbt_dynar_t surf_route;
 236   const char *link_name;
 237   void *surf_link;
 238   unsigned int cpt;
 239
 240   if (sd_global->recyclable_route == NULL) {
 241     /* first run */
 242     sd_global->recyclable_route = xbt_new(SD_link_t, SD_link_get_number());
 243   }
 244
 245   surf_src = src;
 246   surf_dst = dst;
 247
 248   surf_route = surf_workstation_model_get_route((surf_workstation_model_t)surf_workstation_model,
 249                                                         surf_src, surf_dst);
 250
 251   xbt_dynar_foreach(surf_route, cpt, surf_link) {
 252     link_name = surf_resource_name(surf_link);
 253     sd_global->recyclable_route[cpt] =
 254         xbt_lib_get_or_null(link_lib, link_name, SD_LINK_LEVEL);
 255   }
 256   return sd_global->recyclable_route;
 257 }
 258
 259 /**
 260  * \brief Returns the number of links on the route between two workstations
 261  *
 262  * \param src a workstation
 263  * \param dst another workstation
 264  * \return the number of links on the route between these two workstations
 265  * \see SD_route_get_list()
 266  */
 267 int SD_route_get_size(SD_workstation_t src, SD_workstation_t dst)
 268 {
 269   return xbt_dynar_length(surf_workstation_model_get_route(
 270                     (surf_workstation_model_t)surf_workstation_model, src, dst));
 271 }
 272
 273 /**
 274  * \brief Returns the total power of a workstation
 275  *
 276  * \param workstation a workstation
 277  * \return the total power of this workstation
 278  * \see SD_workstation_get_available_power()
 279  */
 280 double SD_workstation_get_power(SD_workstation_t workstation)
 281 {
 282   return surf_workstation_get_speed(workstation, 1.0);
 283 }
 284 /**
 285  * \brief Returns the amount of cores of a workstation
 286  *
 287  * \param workstation a workstation
 288  * \return the amount of cores of this workstation
 289  */
 290 int SD_workstation_get_cores(SD_workstation_t workstation) {
 291   return surf_workstation_get_core(workstation);
 292 }
 293
 294 /**
 295  * \brief Returns the proportion of available power in a workstation
 296  *
 297  * \param workstation a workstation
 298  * \return the proportion of power currently available in this workstation (normally a number between 0 and 1)
 299  * \see SD_workstation_get_power()
 300  */
 301 double SD_workstation_get_available_power(SD_workstation_t workstation)
 302 {
 303   return surf_workstation_get_available_speed(workstation);
 304 }
 305
 306 /**
 307  * \brief Returns an approximative estimated time for the given computation amount on a workstation
 308  *
 309  * \param workstation a workstation
 310  * \param computation_amount the computation amount you want to evaluate (in flops)
 311  * \return an approximative estimated computation time for the given computation amount on this workstation (in seconds)
 312  */
 313 double SD_workstation_get_computation_time(SD_workstation_t workstation,
 314                                            double computation_amount)
 315 {
 316   xbt_assert(computation_amount >= 0,
 317               "computation_amount must be greater than or equal to zero");
 318   return computation_amount / SD_workstation_get_power(workstation);
 319 }
 320
 321 /**
 322  * \brief Returns the latency of the route between two workstations, i.e. the sum of all link latencies
 323  * between the workstations.
 324  *
 325  * \param src the first workstation
 326  * \param dst the second workstation
 327  * \return the latency of the route between the two workstations (in seconds)
 328  * \see SD_route_get_current_bandwidth()
 329  */
 330 double SD_route_get_current_latency(SD_workstation_t src,
 331                                     SD_workstation_t dst)
 332 {
 333
 334   const SD_link_t *links;
 335   int nb_links;
 336   double latency;
 337   int i;
 338
 339   links = SD_route_get_list(src, dst);
 340   nb_links = SD_route_get_size(src, dst);
 341   latency = 0.0;
 342
 343   for (i = 0; i < nb_links; i++) {
 344     latency += SD_link_get_current_latency(links[i]);
 345   }
 346
 347   return latency;
 348 }
 349
 350 /**
 351  * \brief Returns the bandwidth of the route between two workstations, i.e. the minimum link bandwidth of all
 352  * between the workstations.
 353  *
 354  * \param src the first workstation
 355  * \param dst the second workstation
 356  * \return the bandwidth of the route between the two workstations (in bytes/second)
 357  * \see SD_route_get_current_latency()
 358  */
 359 double SD_route_get_current_bandwidth(SD_workstation_t src,
 360                                       SD_workstation_t dst)
 361 {
 362
 363   const SD_link_t *links;
 364   int nb_links;
 365   double bandwidth;
 366   double min_bandwidth;
 367   int i;
 368
 369   links = SD_route_get_list(src, dst);
 370   nb_links = SD_route_get_size(src, dst);
 371   min_bandwidth = -1.0;
 372
 373   for (i = 0; i < nb_links; i++) {
 374     bandwidth = SD_link_get_current_bandwidth(links[i]);
 375     if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
 376       min_bandwidth = bandwidth;
 377   }
 378
 379   return min_bandwidth;
 380 }
 381
 382 /**
 383  * \brief Returns an approximative estimated time for the given
 384  * communication amount between two workstations
 385  *
 386  * \param src the first workstation
 387  * \param dst the second workstation
 388  * \param communication_amount the communication amount you want to evaluate (in bytes)
 389  * \return an approximative estimated computation time for the given communication amount
 390  * between the workstations (in seconds)
 391  */
 392 double SD_route_get_communication_time(SD_workstation_t src,
 393                                        SD_workstation_t dst,
 394                                        double communication_amount)
 395 {
 396
 397
 398   /* total time = latency + transmission time of the slowest link
 399      transmission time of a link = communication amount / link bandwidth */
 400
 401   const SD_link_t *links;
 402   int nb_links;
 403   double bandwidth, min_bandwidth;
 404   double latency;
 405   int i;
 406
 407   xbt_assert(communication_amount >= 0,
 408               "communication_amount must be greater than or equal to zero");
 409
 410
 411
 412   if (communication_amount == 0.0)
 413     return 0.0;
 414
 415   links = SD_route_get_list(src, dst);
 416   nb_links = SD_route_get_size(src, dst);
 417   min_bandwidth = -1.0;
 418   latency = 0;
 419
 420   for (i = 0; i < nb_links; i++) {
 421     latency += SD_link_get_current_latency(links[i]);
 422     bandwidth = SD_link_get_current_bandwidth(links[i]);
 423     if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
 424       min_bandwidth = bandwidth;
 425   }
 426
 427   return latency + (communication_amount / min_bandwidth);
 428 }
 429
 430 /**
 431  * \brief Returns the access mode of this workstation.
 432  *
 433  * \param workstation a workstation
 434  * \return the access mode for the tasks running on this workstation:
 435  * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
 436  *
 437  * \see SD_workstation_set_access_mode(), e_SD_workstation_access_mode_t
 438  */
 439 e_SD_workstation_access_mode_t
 440 SD_workstation_get_access_mode(SD_workstation_t workstation)
 441 {
 442   return SD_workstation_priv(workstation)->access_mode;
 443 }
 444
 445 /**
 446  * \brief Sets the access mode for the tasks that will be executed on a workstation
 447  *
 448  * By default, a workstation model is shared, i.e. several tasks
 449  * can be executed at the same time on a workstation. The CPU power of
 450  * the workstation is shared between the running tasks on the workstation.
 451  * In sequential mode, only one task can use the workstation, and the other
 452  * tasks wait in a FIFO.
 453  *
 454  * \param workstation a workstation
 455  * \param access_mode the access mode you want to set to this workstation:
 456  * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
 457  *
 458  * \see SD_workstation_get_access_mode(), e_SD_workstation_access_mode_t
 459  */
 460 void SD_workstation_set_access_mode(SD_workstation_t workstation,
 461                                     e_SD_workstation_access_mode_t
 462                                     access_mode)
 463 {
 464   xbt_assert(access_mode != SD_WORKSTATION_SEQUENTIAL_ACCESS ||
 465              access_mode != SD_WORKSTATION_SHARED_ACCESS,
 466              "Trying to set an invalid access mode");
 467
 468   if (access_mode == SD_workstation_priv(workstation)->access_mode) {
 469     return;                     // nothing is changed
 470   }
 471
 472   SD_workstation_priv(workstation)->access_mode = access_mode;
 473
 474   if (access_mode == SD_WORKSTATION_SHARED_ACCESS) {
 475     xbt_fifo_free(SD_workstation_priv(workstation)->task_fifo);
 476     SD_workstation_priv(workstation)->task_fifo = NULL;
 477   } else {
 478     SD_workstation_priv(workstation)->task_fifo = xbt_fifo_new();
 479   }
 480 }
 481
 482 /**
 483  * \brief Return the list of mounted storages on a workstation.
 484  *
 485  * \param workstation a workstation
 486  * \return a dynar containing all mounted storages on the workstation
 487  */
 488 xbt_dict_t SD_workstation_get_mounted_storage_list(SD_workstation_t workstation){
 489   return surf_workstation_get_mounted_storage_list(workstation);
 490 }
 491
 492 /**
 493  * \brief Return the list of mounted storages on a workstation.
 494  *
 495  * \param workstation a workstation
 496  * \return a dynar containing all mounted storages on the workstation
 497  */
 498 xbt_dynar_t SD_workstation_get_attached_storage_list(SD_workstation_t workstation){
 499   return surf_workstation_get_attached_storage_list(workstation);
 500 }
 501
 502 /**
 503  * \brief Returns the host name the storage is attached to
 504  *
 505  * This functions checks whether a storage is a valid pointer or not and return its name.
 506  */
 507 const char *SD_storage_get_host(msg_storage_t storage) {
 508   xbt_assert((storage != NULL), "Invalid parameters");
 509   SD_storage_priv_t priv = SD_storage_priv(storage);
 510   return priv->host;
 511 }
 512
 513 /* Returns whether a task can start now on a workstation*/
 514 /*
 515   int __SD_workstation_can_start(SD_workstation_t workstation, SD_task_t task) {
 516   SD_CHECK_INIT_DONE();
 517   xbt_assert(workstation != NULL && task != NULL, "Invalid parameter");
 518
 519   return !__SD_workstation_is_busy(workstation) &&
 520   (xbt_fifo_size(workstation->task_fifo) == 0) || xbt_fifo_get_first_item(workstation->task_fifo) == task);
 521   }
 522 */
 523
 524 /* Returns whether a workstation is busy. A workstation is busy is it is
 525  * in sequential mode and a task is running on it or the fifo is not empty.
 526  */
 527 int __SD_workstation_is_busy(SD_workstation_t workstation)
 528 {
 529   XBT_DEBUG
 530       ("Workstation '%s' access mode: '%s', current task: %s, fifo size: %d",
 531        SD_workstation_get_name(workstation),
 532        (SD_workstation_priv(workstation)->access_mode ==
 533         SD_WORKSTATION_SHARED_ACCESS) ? "SHARED" : "FIFO",
 534        (SD_workstation_priv(workstation)->current_task ?
 535         SD_task_get_name(SD_workstation_priv(workstation)->current_task)
 536         : "none"),
 537        (SD_workstation_priv(workstation)->task_fifo ? xbt_fifo_size(SD_workstation_priv(workstation)->task_fifo) :
 538         0));
 539
 540   return SD_workstation_priv(workstation)->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS &&
 541       (SD_workstation_priv(workstation)->current_task != NULL
 542        || xbt_fifo_size(SD_workstation_priv(workstation)->task_fifo) > 0);
 543 }
 544
 545 /* Destroys a workstation.
 546  */
 547 void __SD_workstation_destroy(void *workstation)
 548 {
 549
 550   SD_workstation_priv_t w;
 551
 552   /* workstation->surf_workstation is freed by surf_exit and workstation->data is freed by the user */
 553
 554   w = (SD_workstation_priv_t) workstation;
 555
 556   if (w->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS) {
 557     xbt_fifo_free(w->task_fifo);
 558   }
 559   xbt_free(w);
 560 }
 561
 562 /**
 563  * \brief Returns the kind of the task currently running on a workstation
 564  * Only call this with sequential access mode set
 565  * \param workstation a workstation */
 566 SD_task_t SD_workstation_get_current_task(SD_workstation_t workstation)
 567 {
 568   xbt_assert(SD_workstation_priv(workstation)->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS,
 569               "Access mode must be set to SD_WORKSTATION_SEQUENTIAL_ACCESS"
 570               " to use this function");
 571
 572   return (SD_workstation_priv(workstation)->current_task);
 573 }
 574
 575 /**
 576  * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to the AS
 577  * or router
 578  *
 579  * \param AS, router name
 580  * \return the xbt_dict_t properties of the AS
 581  */
 582 xbt_dict_t SD_as_router_get_properties(const char *asr)
 583 {
 584   return get_as_router_properties(asr);
 585 }
 586 /**
 587  * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to the AS
 588  * or router
 589  *
 590  * \param AS, router name
 591  * \param The name of a properties
 592  * \return value of the properties
 593  */
 594 const char* SD_as_router_get_property_value(const char *asr, const char *name)
 595 {
 596   xbt_dict_t dict = get_as_router_properties(asr);
 597   if(!dict) return NULL;
 598   return xbt_dict_get_or_null(dict,name);
 599 }