1 /* Copyright (c) 2006-2014. The SimGrid Team.
2 * All rights reserved. */
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. */
8 #include "simdag/simdag.h"
11 #include "xbt/sysdep.h"
12 #include "surf/surf.h"
13 #include "surf/surf_resource.h"
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_workstation, sd,
17 "Logging specific to SimDag (workstation)");
19 /* Creates a workstation and registers it in SD.
21 SD_workstation_t __SD_workstation_create(void *surf_workstation,
25 SD_workstation_priv_t workstation;
28 workstation = xbt_new(s_SD_workstation_priv_t, 1);
29 workstation->data = data; /* user data */
30 workstation->access_mode = SD_WORKSTATION_SHARED_ACCESS; /* default mode is shared */
31 workstation->task_fifo = NULL;
32 workstation->current_task = NULL;
34 name = surf_resource_name(surf_workstation);
35 xbt_lib_set(host_lib,name,SD_HOST_LEVEL,workstation);
36 return xbt_lib_get_elm_or_null(host_lib,name);
39 /* Creates a storage and registers it in SD.
41 SD_storage_t __SD_storage_create(void *surf_storage, void *data)
44 SD_storage_priv_t storage;
47 storage = xbt_new(s_SD_storage_priv_t, 1);
48 storage->data = data; /* user data */
49 name = surf_resource_name(surf_storage);
50 storage->host = surf_storage_get_host(surf_storage_resource_by_name(name));
51 xbt_lib_set(storage_lib,name, SD_STORAGE_LEVEL, storage);
52 return xbt_lib_get_elm_or_null(storage_lib, name);
55 /* Destroys a storage.
57 void __SD_storage_destroy(void *storage)
61 s = (SD_storage_priv_t) storage;
66 * \brief Returns a workstation given its name
68 * If there is no such workstation, the function returns \c NULL.
70 * \param name workstation name
71 * \return the workstation, or \c NULL if there is no such workstation
73 SD_workstation_t SD_workstation_get_by_name(const char *name)
75 return xbt_lib_get_elm_or_null(host_lib, name);
79 * \brief Returns the workstation list
81 * Use SD_workstation_get_number() to know the array size.
83 * \return an array of \ref SD_workstation_t containing all workstations
84 * \see SD_workstation_get_number()
86 const SD_workstation_t *SD_workstation_get_list(void)
89 xbt_lib_cursor_t cursor;
94 xbt_assert(SD_workstation_get_number() > 0, "There is no workstation!");
96 if (sd_global->workstation_list == NULL) { /* this is the first time the function is called */
97 sd_global->workstation_list =
98 xbt_new(SD_workstation_t, xbt_lib_length(host_lib));
101 xbt_lib_foreach(host_lib, cursor, key, data) {
102 if(data[SD_HOST_LEVEL])
103 sd_global->workstation_list[i++] = xbt_dict_cursor_get_elm(cursor);
106 return sd_global->workstation_list;
110 * \brief Returns the number of workstations
112 * \return the number of existing workstations
113 * \see SD_workstation_get_list()
115 int SD_workstation_get_number(void)
117 return xbt_lib_length(host_lib);
121 * \brief Returns the user data of a workstation
123 * \param workstation a workstation
124 * \return the user data associated with this workstation (can be \c NULL)
125 * \see SD_workstation_set_data()
127 void *SD_workstation_get_data(SD_workstation_t workstation)
129 return SD_workstation_priv(workstation)->data;
133 * \brief Sets the user data of a workstation
135 * The new data can be \c NULL. The old data should have been freed first
136 * if it was not \c NULL.
138 * \param workstation a workstation
139 * \param data the new data you want to associate with this workstation
140 * \see SD_workstation_get_data()
142 void SD_workstation_set_data(SD_workstation_t workstation, void *data)
144 SD_workstation_priv(workstation)->data = data;
148 * \brief Returns the name of a workstation
150 * \param workstation a workstation
151 * \return the name of this workstation (cannot be \c NULL)
153 const char *SD_workstation_get_name(SD_workstation_t workstation)
155 return sg_host_name(workstation);
159 * \brief Returns the value of a given workstation property
161 * \param ws a workstation
162 * \param name a property name
163 * \return value of a property (or NULL if property not set)
165 const char *SD_workstation_get_property_value(SD_workstation_t ws,
168 return xbt_dict_get_or_null(SD_workstation_get_properties(ws), name);
173 * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to this workstation
175 * \param workstation a workstation
176 * \return the dictionary containing the properties associated with the workstation
178 xbt_dict_t SD_workstation_get_properties(SD_workstation_t workstation)
180 return surf_resource_get_properties(surf_workstation_resource_priv(workstation));
184 /** @brief Displays debugging informations about a workstation */
185 void SD_workstation_dump(SD_workstation_t ws)
188 xbt_dict_cursor_t cursor=NULL;
190 SD_task_t task = NULL;
192 XBT_INFO("Displaying workstation %s", SD_workstation_get_name(ws));
193 XBT_INFO(" - power: %.0f", SD_workstation_get_power(ws));
194 XBT_INFO(" - available power: %.2f", SD_workstation_get_available_power(ws));
195 switch (SD_workstation_priv(ws)->access_mode){
196 case SD_WORKSTATION_SHARED_ACCESS:
197 XBT_INFO(" - access mode: Space shared");
199 case SD_WORKSTATION_SEQUENTIAL_ACCESS:
200 XBT_INFO(" - access mode: Exclusive");
201 task = SD_workstation_get_current_task(ws);
203 XBT_INFO(" current running task: %s",
204 SD_task_get_name(task));
206 XBT_INFO(" no task running");
210 props = SD_workstation_get_properties(ws);
212 if (!xbt_dict_is_empty(props)){
213 XBT_INFO(" - properties:");
215 xbt_dict_foreach(props,cursor,key,data) {
216 XBT_INFO(" %s->%s",key,data);
222 * \brief Returns the route between two workstations
224 * Use SD_route_get_size() to know the array size.
226 * \param src a workstation
227 * \param dst another workstation
228 * \return a new array of \ref SD_link_t representating the route between these two workstations
229 * \see SD_route_get_size(), SD_link_t
231 const SD_link_t *SD_route_get_list(SD_workstation_t src,
232 SD_workstation_t dst)
236 xbt_dynar_t surf_route;
237 const char *link_name;
241 if (sd_global->recyclable_route == NULL) {
243 sd_global->recyclable_route = xbt_new(SD_link_t, SD_link_get_number());
249 surf_route = surf_workstation_model_get_route((surf_workstation_model_t)surf_workstation_model,
252 xbt_dynar_foreach(surf_route, cpt, surf_link) {
253 link_name = surf_resource_name(surf_link);
254 sd_global->recyclable_route[cpt] =
255 xbt_lib_get_or_null(link_lib, link_name, SD_LINK_LEVEL);
257 return sd_global->recyclable_route;
261 * \brief Returns the number of links on the route between two workstations
263 * \param src a workstation
264 * \param dst another workstation
265 * \return the number of links on the route between these two workstations
266 * \see SD_route_get_list()
268 int SD_route_get_size(SD_workstation_t src, SD_workstation_t dst)
270 return xbt_dynar_length(surf_workstation_model_get_route(
271 (surf_workstation_model_t)surf_workstation_model, src, dst));
275 * \brief Returns the total power of a workstation
277 * \param workstation a workstation
278 * \return the total power of this workstation
279 * \see SD_workstation_get_available_power()
281 double SD_workstation_get_power(SD_workstation_t workstation)
283 return surf_workstation_get_speed(workstation, 1.0);
286 * \brief Returns the amount of cores of a workstation
288 * \param workstation a workstation
289 * \return the amount of cores of this workstation
291 int SD_workstation_get_cores(SD_workstation_t workstation) {
292 return surf_workstation_get_core(workstation);
296 * \brief Returns the proportion of available power in a workstation
298 * \param workstation a workstation
299 * \return the proportion of power currently available in this workstation (normally a number between 0 and 1)
300 * \see SD_workstation_get_power()
302 double SD_workstation_get_available_power(SD_workstation_t workstation)
304 return surf_workstation_get_available_speed(workstation);
308 * \brief Returns an approximative estimated time for the given computation amount on a workstation
310 * \param workstation a workstation
311 * \param computation_amount the computation amount you want to evaluate (in flops)
312 * \return an approximative estimated computation time for the given computation amount on this workstation (in seconds)
314 double SD_workstation_get_computation_time(SD_workstation_t workstation,
315 double computation_amount)
317 xbt_assert(computation_amount >= 0,
318 "computation_amount must be greater than or equal to zero");
319 return computation_amount / SD_workstation_get_power(workstation);
323 * \brief Returns the latency of the route between two workstations, i.e. the sum of all link latencies
324 * between the workstations.
326 * \param src the first workstation
327 * \param dst the second workstation
328 * \return the latency of the route between the two workstations (in seconds)
329 * \see SD_route_get_current_bandwidth()
331 double SD_route_get_current_latency(SD_workstation_t src,
332 SD_workstation_t dst)
335 const SD_link_t *links;
340 links = SD_route_get_list(src, dst);
341 nb_links = SD_route_get_size(src, dst);
344 for (i = 0; i < nb_links; i++) {
345 latency += SD_link_get_current_latency(links[i]);
352 * \brief Returns the bandwidth of the route between two workstations, i.e. the minimum link bandwidth of all
353 * between the workstations.
355 * \param src the first workstation
356 * \param dst the second workstation
357 * \return the bandwidth of the route between the two workstations (in bytes/second)
358 * \see SD_route_get_current_latency()
360 double SD_route_get_current_bandwidth(SD_workstation_t src,
361 SD_workstation_t dst)
364 const SD_link_t *links;
367 double min_bandwidth;
370 links = SD_route_get_list(src, dst);
371 nb_links = SD_route_get_size(src, dst);
372 min_bandwidth = -1.0;
374 for (i = 0; i < nb_links; i++) {
375 bandwidth = SD_link_get_current_bandwidth(links[i]);
376 if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
377 min_bandwidth = bandwidth;
380 return min_bandwidth;
384 * \brief Returns an approximative estimated time for the given
385 * communication amount between two workstations
387 * \param src the first workstation
388 * \param dst the second workstation
389 * \param communication_amount the communication amount you want to evaluate (in bytes)
390 * \return an approximative estimated computation time for the given communication amount
391 * between the workstations (in seconds)
393 double SD_route_get_communication_time(SD_workstation_t src,
394 SD_workstation_t dst,
395 double communication_amount)
399 /* total time = latency + transmission time of the slowest link
400 transmission time of a link = communication amount / link bandwidth */
402 const SD_link_t *links;
404 double bandwidth, min_bandwidth;
408 xbt_assert(communication_amount >= 0,
409 "communication_amount must be greater than or equal to zero");
413 if (communication_amount == 0.0)
416 links = SD_route_get_list(src, dst);
417 nb_links = SD_route_get_size(src, dst);
418 min_bandwidth = -1.0;
421 for (i = 0; i < nb_links; i++) {
422 latency += SD_link_get_current_latency(links[i]);
423 bandwidth = SD_link_get_current_bandwidth(links[i]);
424 if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
425 min_bandwidth = bandwidth;
428 return latency + (communication_amount / min_bandwidth);
432 * \brief Returns the access mode of this workstation.
434 * \param workstation a workstation
435 * \return the access mode for the tasks running on this workstation:
436 * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
438 * \see SD_workstation_set_access_mode(), e_SD_workstation_access_mode_t
440 e_SD_workstation_access_mode_t
441 SD_workstation_get_access_mode(SD_workstation_t workstation)
443 return SD_workstation_priv(workstation)->access_mode;
447 * \brief Sets the access mode for the tasks that will be executed on a workstation
449 * By default, a workstation model is shared, i.e. several tasks
450 * can be executed at the same time on a workstation. The CPU power of
451 * the workstation is shared between the running tasks on the workstation.
452 * In sequential mode, only one task can use the workstation, and the other
453 * tasks wait in a FIFO.
455 * \param workstation a workstation
456 * \param access_mode the access mode you want to set to this workstation:
457 * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
459 * \see SD_workstation_get_access_mode(), e_SD_workstation_access_mode_t
461 void SD_workstation_set_access_mode(SD_workstation_t workstation,
462 e_SD_workstation_access_mode_t
465 xbt_assert(access_mode != SD_WORKSTATION_SEQUENTIAL_ACCESS ||
466 access_mode != SD_WORKSTATION_SHARED_ACCESS,
467 "Trying to set an invalid access mode");
469 if (access_mode == SD_workstation_priv(workstation)->access_mode) {
470 return; // nothing is changed
473 SD_workstation_priv(workstation)->access_mode = access_mode;
475 if (access_mode == SD_WORKSTATION_SHARED_ACCESS) {
476 xbt_fifo_free(SD_workstation_priv(workstation)->task_fifo);
477 SD_workstation_priv(workstation)->task_fifo = NULL;
479 SD_workstation_priv(workstation)->task_fifo = xbt_fifo_new();
484 * \brief Return the list of mounted storages on a workstation.
486 * \param workstation a workstation
487 * \return a dynar containing all mounted storages on the workstation
489 xbt_dict_t SD_workstation_get_mounted_storage_list(SD_workstation_t workstation){
490 return surf_workstation_get_mounted_storage_list(workstation);
494 * \brief Return the list of mounted storages on a workstation.
496 * \param workstation a workstation
497 * \return a dynar containing all mounted storages on the workstation
499 xbt_dynar_t SD_workstation_get_attached_storage_list(SD_workstation_t workstation){
500 return surf_workstation_get_attached_storage_list(workstation);
504 * \brief Returns the host name the storage is attached to
506 * This functions checks whether a storage is a valid pointer or not and return its name.
508 const char *SD_storage_get_host(msg_storage_t storage) {
509 xbt_assert((storage != NULL), "Invalid parameters");
510 SD_storage_priv_t priv = SD_storage_priv(storage);
514 /* Returns whether a task can start now on a workstation*/
516 int __SD_workstation_can_start(SD_workstation_t workstation, SD_task_t task) {
517 SD_CHECK_INIT_DONE();
518 xbt_assert(workstation != NULL && task != NULL, "Invalid parameter");
520 return !__SD_workstation_is_busy(workstation) &&
521 (xbt_fifo_size(workstation->task_fifo) == 0) || xbt_fifo_get_first_item(workstation->task_fifo) == task);
525 /* Returns whether a workstation is busy. A workstation is busy is it is
526 * in sequential mode and a task is running on it or the fifo is not empty.
528 int __SD_workstation_is_busy(SD_workstation_t workstation)
531 ("Workstation '%s' access mode: '%s', current task: %s, fifo size: %d",
532 SD_workstation_get_name(workstation),
533 (SD_workstation_priv(workstation)->access_mode ==
534 SD_WORKSTATION_SHARED_ACCESS) ? "SHARED" : "FIFO",
535 (SD_workstation_priv(workstation)->current_task ?
536 SD_task_get_name(SD_workstation_priv(workstation)->current_task)
538 (SD_workstation_priv(workstation)->task_fifo ? xbt_fifo_size(SD_workstation_priv(workstation)->task_fifo) :
541 return SD_workstation_priv(workstation)->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS &&
542 (SD_workstation_priv(workstation)->current_task != NULL
543 || xbt_fifo_size(SD_workstation_priv(workstation)->task_fifo) > 0);
546 /* Destroys a workstation.
548 void __SD_workstation_destroy(void *workstation)
551 SD_workstation_priv_t w;
553 /* workstation->surf_workstation is freed by surf_exit and workstation->data is freed by the user */
555 w = (SD_workstation_priv_t) workstation;
557 if (w->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS) {
558 xbt_fifo_free(w->task_fifo);
564 * \brief Returns the kind of the task currently running on a workstation
565 * Only call this with sequential access mode set
566 * \param workstation a workstation */
567 SD_task_t SD_workstation_get_current_task(SD_workstation_t workstation)
569 xbt_assert(SD_workstation_priv(workstation)->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS,
570 "Access mode must be set to SD_WORKSTATION_SEQUENTIAL_ACCESS"
571 " to use this function");
573 return (SD_workstation_priv(workstation)->current_task);
577 * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to the AS
580 * \param AS, router name
581 * \return the xbt_dict_t properties of the AS
583 xbt_dict_t SD_as_router_get_properties(const char *asr)
585 return get_as_router_properties(asr);
588 * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to the AS
591 * \param AS, router name
592 * \param The name of a properties
593 * \return value of the properties
595 const char* SD_as_router_get_property_value(const char *asr, const char *name)
597 xbt_dict_t dict = get_as_router_properties(asr);
598 if(!dict) return NULL;
599 return xbt_dict_get_or_null(dict,name);