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 "simgrid/simdag.h"
11 #include "xbt/sysdep.h"
12 #include "surf/surf.h"
13 #include "surf/surf_resource.h"
14 #include "simgrid/msg.h" //FIXME: why?
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 * \remark The workstation order in the returned array is generally different from the workstation creation/declaration order in the XML platform (we use a hash table internally).
85 * \see SD_workstation_get_number()
87 const SD_workstation_t *SD_workstation_get_list(void)
90 xbt_lib_cursor_t cursor;
95 xbt_assert(SD_workstation_get_number() > 0, "There is no workstation!");
97 if (sd_global->workstation_list == NULL) { /* this is the first time the function is called */
98 sd_global->workstation_list =
99 xbt_new(SD_workstation_t, xbt_lib_length(host_lib));
102 xbt_lib_foreach(host_lib, cursor, key, data) {
103 if(data[SD_HOST_LEVEL])
104 sd_global->workstation_list[i++] = xbt_dict_cursor_get_elm(cursor);
107 return sd_global->workstation_list;
111 * \brief Returns the number of workstations
113 * \return the number of existing workstations
114 * \see SD_workstation_get_list()
116 int SD_workstation_get_number(void)
118 return xbt_lib_length(host_lib);
122 * \brief Returns the user data of a workstation
124 * \param workstation a workstation
125 * \return the user data associated with this workstation (can be \c NULL)
126 * \see SD_workstation_set_data()
128 void *SD_workstation_get_data(SD_workstation_t workstation)
130 return SD_workstation_priv(workstation)->data;
134 * \brief Sets the user data of a workstation
136 * The new data can be \c NULL. The old data should have been freed first
137 * if it was not \c NULL.
139 * \param workstation a workstation
140 * \param data the new data you want to associate with this workstation
141 * \see SD_workstation_get_data()
143 void SD_workstation_set_data(SD_workstation_t workstation, void *data)
145 SD_workstation_priv(workstation)->data = data;
149 * \brief Returns the name of a workstation
151 * \param workstation a workstation
152 * \return the name of this workstation (cannot be \c NULL)
154 const char *SD_workstation_get_name(SD_workstation_t workstation)
156 return sg_host_name(workstation);
160 * \brief Returns the value of a given workstation property
162 * \param ws a workstation
163 * \param name a property name
164 * \return value of a property (or NULL if property not set)
166 const char *SD_workstation_get_property_value(SD_workstation_t ws,
169 return xbt_dict_get_or_null(SD_workstation_get_properties(ws), name);
174 * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to this workstation
176 * \param workstation a workstation
177 * \return the dictionary containing the properties associated with the workstation
179 xbt_dict_t SD_workstation_get_properties(SD_workstation_t workstation)
181 return surf_resource_get_properties(surf_host_resource_priv(workstation));
185 /** @brief Displays debugging informations about a workstation */
186 void SD_workstation_dump(SD_workstation_t ws)
189 xbt_dict_cursor_t cursor=NULL;
191 SD_task_t task = NULL;
193 XBT_INFO("Displaying workstation %s", SD_workstation_get_name(ws));
194 XBT_INFO(" - power: %.0f", SD_workstation_get_power(ws));
195 XBT_INFO(" - available power: %.2f", SD_workstation_get_available_power(ws));
196 switch (SD_workstation_priv(ws)->access_mode){
197 case SD_WORKSTATION_SHARED_ACCESS:
198 XBT_INFO(" - access mode: Space shared");
200 case SD_WORKSTATION_SEQUENTIAL_ACCESS:
201 XBT_INFO(" - access mode: Exclusive");
202 task = SD_workstation_get_current_task(ws);
204 XBT_INFO(" current running task: %s",
205 SD_task_get_name(task));
207 XBT_INFO(" no task running");
211 props = SD_workstation_get_properties(ws);
213 if (!xbt_dict_is_empty(props)){
214 XBT_INFO(" - properties:");
216 xbt_dict_foreach(props,cursor,key,data) {
217 XBT_INFO(" %s->%s",key,data);
223 * \brief Returns the route between two workstations
225 * Use SD_route_get_size() to know the array size.
227 * \param src a workstation
228 * \param dst another workstation
229 * \return a new array of \ref SD_link_t representating the route between these two workstations
230 * \see SD_route_get_size(), SD_link_t
232 const SD_link_t *SD_route_get_list(SD_workstation_t src,
233 SD_workstation_t dst)
237 xbt_dynar_t surf_route;
238 const char *link_name;
242 if (sd_global->recyclable_route == NULL) {
244 sd_global->recyclable_route = xbt_new(SD_link_t, SD_link_get_number());
250 surf_route = surf_host_model_get_route((surf_host_model_t)surf_host_model,
253 xbt_dynar_foreach(surf_route, cpt, surf_link) {
254 link_name = surf_resource_name(surf_link);
255 sd_global->recyclable_route[cpt] =
256 xbt_lib_get_or_null(link_lib, link_name, SD_LINK_LEVEL);
258 return sd_global->recyclable_route;
262 * \brief Returns the number of links on the route between two workstations
264 * \param src a workstation
265 * \param dst another workstation
266 * \return the number of links on the route between these two workstations
267 * \see SD_route_get_list()
269 int SD_route_get_size(SD_workstation_t src, SD_workstation_t dst)
271 return xbt_dynar_length(surf_host_model_get_route(
272 (surf_host_model_t)surf_host_model, src, dst));
276 * \brief Returns the total power of a workstation
278 * \param workstation a workstation
279 * \return the total power of this workstation
280 * \see SD_workstation_get_available_power()
282 double SD_workstation_get_power(SD_workstation_t workstation)
284 return surf_host_get_speed(workstation, 1.0);
287 * \brief Returns the amount of cores of a workstation
289 * \param workstation a workstation
290 * \return the amount of cores of this workstation
292 int SD_workstation_get_cores(SD_workstation_t workstation) {
293 return surf_host_get_core(workstation);
297 * \brief Returns the proportion of available power in a workstation
299 * \param workstation a workstation
300 * \return the proportion of power currently available in this workstation (normally a number between 0 and 1)
301 * \see SD_workstation_get_power()
303 double SD_workstation_get_available_power(SD_workstation_t workstation)
305 return surf_host_get_available_speed(workstation);
309 * \brief Returns an approximative estimated time for the given computation amount on a workstation
311 * \param workstation a workstation
312 * \param flops_amount the computation amount you want to evaluate (in flops)
313 * \return an approximative estimated computation time for the given computation amount on this workstation (in seconds)
315 double SD_workstation_get_computation_time(SD_workstation_t workstation,
318 xbt_assert(flops_amount >= 0,
319 "flops_amount must be greater than or equal to zero");
320 return flops_amount / SD_workstation_get_power(workstation);
324 * \brief Returns the latency of the route between two workstations, i.e. the sum of all link latencies
325 * between the workstations.
327 * \param src the first workstation
328 * \param dst the second workstation
329 * \return the latency of the route between the two workstations (in seconds)
330 * \see SD_route_get_current_bandwidth()
332 double SD_route_get_current_latency(SD_workstation_t src,
333 SD_workstation_t dst)
336 const SD_link_t *links;
341 links = SD_route_get_list(src, dst);
342 nb_links = SD_route_get_size(src, dst);
345 for (i = 0; i < nb_links; i++) {
346 latency += SD_link_get_current_latency(links[i]);
353 * \brief Returns the bandwidth of the route between two workstations, i.e. the minimum link bandwidth of all
354 * between the workstations.
356 * \param src the first workstation
357 * \param dst the second workstation
358 * \return the bandwidth of the route between the two workstations (in bytes/second)
359 * \see SD_route_get_current_latency()
361 double SD_route_get_current_bandwidth(SD_workstation_t src,
362 SD_workstation_t dst)
365 const SD_link_t *links;
368 double min_bandwidth;
371 links = SD_route_get_list(src, dst);
372 nb_links = SD_route_get_size(src, dst);
373 min_bandwidth = -1.0;
375 for (i = 0; i < nb_links; i++) {
376 bandwidth = SD_link_get_current_bandwidth(links[i]);
377 if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
378 min_bandwidth = bandwidth;
381 return min_bandwidth;
385 * \brief Returns an approximative estimated time for the given
386 * communication amount between two workstations
388 * \param src the first workstation
389 * \param dst the second workstation
390 * \param bytes_amount the communication amount you want to evaluate (in bytes)
391 * \return an approximative estimated communication time for the given bytes amount
392 * between the workstations (in seconds)
394 double SD_route_get_communication_time(SD_workstation_t src,
395 SD_workstation_t dst,
400 /* total time = latency + transmission time of the slowest link
401 transmission time of a link = communication amount / link bandwidth */
403 const SD_link_t *links;
405 double bandwidth, min_bandwidth;
409 xbt_assert(bytes_amount >= 0, "bytes_amount must be greater than or equal to zero");
412 if (bytes_amount == 0.0)
415 links = SD_route_get_list(src, dst);
416 nb_links = SD_route_get_size(src, dst);
417 min_bandwidth = -1.0;
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;
427 return latency + (bytes_amount / min_bandwidth);
431 * \brief Returns the access mode of this workstation.
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
437 * \see SD_workstation_set_access_mode(), e_SD_workstation_access_mode_t
439 e_SD_workstation_access_mode_t
440 SD_workstation_get_access_mode(SD_workstation_t workstation)
442 return SD_workstation_priv(workstation)->access_mode;
446 * \brief Sets the access mode for the tasks that will be executed on a workstation
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.
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
458 * \see SD_workstation_get_access_mode(), e_SD_workstation_access_mode_t
460 void SD_workstation_set_access_mode(SD_workstation_t workstation,
461 e_SD_workstation_access_mode_t
464 xbt_assert(access_mode != SD_WORKSTATION_SEQUENTIAL_ACCESS ||
465 access_mode != SD_WORKSTATION_SHARED_ACCESS,
466 "Trying to set an invalid access mode");
468 if (access_mode == SD_workstation_priv(workstation)->access_mode) {
469 return; // nothing is changed
472 SD_workstation_priv(workstation)->access_mode = access_mode;
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;
478 SD_workstation_priv(workstation)->task_fifo = xbt_fifo_new();
483 * \brief Return the list of mounted storages on a workstation.
485 * \param workstation a workstation
486 * \return a dynar containing all mounted storages on the workstation
488 xbt_dict_t SD_workstation_get_mounted_storage_list(SD_workstation_t workstation){
489 return surf_host_get_mounted_storage_list(workstation);
493 * \brief Return the list of mounted storages on a workstation.
495 * \param workstation a workstation
496 * \return a dynar containing all mounted storages on the workstation
498 xbt_dynar_t SD_workstation_get_attached_storage_list(SD_workstation_t workstation){
499 return surf_host_get_attached_storage_list(workstation);
503 * \brief Returns the host name the storage is attached to
505 * This functions checks whether a storage is a valid pointer or not and return its name.
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);
513 /* Returns whether a task can start now on a workstation*/
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");
519 return !__SD_workstation_is_busy(workstation) &&
520 (xbt_fifo_size(workstation->task_fifo) == 0) || xbt_fifo_get_first_item(workstation->task_fifo) == task);
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.
527 int __SD_workstation_is_busy(SD_workstation_t workstation)
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)
537 (SD_workstation_priv(workstation)->task_fifo ? xbt_fifo_size(SD_workstation_priv(workstation)->task_fifo) :
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);
545 /* Destroys a workstation.
547 void __SD_workstation_destroy(void *workstation)
550 SD_workstation_priv_t w;
552 /* workstation->surf_workstation is freed by surf_exit and workstation->data is freed by the user */
554 w = (SD_workstation_priv_t) workstation;
556 if (w->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS) {
557 xbt_fifo_free(w->task_fifo);
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)
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");
572 return (SD_workstation_priv(workstation)->current_task);
576 * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to the AS
579 * \param AS, router name
580 * \return the xbt_dict_t properties of the AS
582 xbt_dict_t SD_as_router_get_properties(const char *asr)
584 return get_as_router_properties(asr);
587 * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to the AS
590 * \param AS, router name
591 * \param The name of a properties
592 * \return value of the properties
594 const char* SD_as_router_get_property_value(const char *asr, const char *name)
596 xbt_dict_t dict = get_as_router_properties(asr);
597 if(!dict) return NULL;
598 return xbt_dict_get_or_null(dict,name);