1 /* Copyright (c) 2006, 2007, 2008, 2009, 2010. 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"
10 #include "xbt/sysdep.h"
11 #include "surf/surf.h"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_workstation, sd,
14 "Logging specific to SimDag (workstation)");
16 /* Creates a workstation and registers it in SD.
18 SD_workstation_t __SD_workstation_create(void *surf_workstation,
22 SD_workstation_t workstation;
25 workstation = xbt_new(s_SD_workstation_t, 1);
26 workstation->surf_workstation = surf_workstation;
27 workstation->data = data; /* user data */
28 workstation->access_mode = SD_WORKSTATION_SHARED_ACCESS; /* default mode is shared */
29 workstation->task_fifo = NULL;
30 workstation->current_task = NULL;
32 name = SD_workstation_get_name(workstation);
33 xbt_lib_set(host_lib,name,SD_HOST_LEVEL,workstation);
38 * \brief Returns a workstation given its name
40 * If there is no such workstation, the function returns \c NULL.
42 * \param name workstation name
43 * \return the workstation, or \c NULL if there is no such workstation
45 SD_workstation_t SD_workstation_get_by_name(const char *name)
47 return xbt_lib_get_or_null(host_lib, name, SD_HOST_LEVEL);
51 * \brief Returns the workstation list
53 * Use SD_workstation_get_number() to know the array size.
55 * \return an array of \ref SD_workstation_t containing all workstations
56 * \see SD_workstation_get_number()
58 const SD_workstation_t *SD_workstation_get_list(void)
61 xbt_lib_cursor_t cursor;
66 xbt_assert(SD_workstation_get_number() > 0, "There is no workstation!");
68 if (sd_global->workstation_list == NULL) { /* this is the first time the function is called */
69 sd_global->workstation_list =
70 xbt_new(SD_workstation_t, host_lib->count);
73 xbt_lib_foreach(host_lib, cursor, key, data) {
74 if(data[SD_HOST_LEVEL])
75 sd_global->workstation_list[i++] = (SD_workstation_t) data[SD_HOST_LEVEL];
78 return sd_global->workstation_list;
82 * \brief Returns the number of workstations
84 * \return the number of existing workstations
85 * \see SD_workstation_get_list()
87 int SD_workstation_get_number(void)
89 return host_lib->count;
93 * \brief Returns the user data of a workstation
95 * \param workstation a workstation
96 * \return the user data associated with this workstation (can be \c NULL)
97 * \see SD_workstation_set_data()
99 void *SD_workstation_get_data(SD_workstation_t workstation)
101 return workstation->data;
105 * \brief Sets the user data of a workstation
107 * The new data can be \c NULL. The old data should have been freed first
108 * if it was not \c NULL.
110 * \param workstation a workstation
111 * \param data the new data you want to associate with this workstation
112 * \see SD_workstation_get_data()
114 void SD_workstation_set_data(SD_workstation_t workstation, void *data)
116 workstation->data = data;
120 * \brief Returns the name of a workstation
122 * \param workstation a workstation
123 * \return the name of this workstation (cannot be \c NULL)
125 const char *SD_workstation_get_name(SD_workstation_t workstation)
127 return surf_resource_name(workstation->surf_workstation);
131 * \brief Returns the value of a given workstation property
133 * \param ws a workstation
134 * \param name a property name
135 * \return value of a property (or NULL if property not set)
137 const char *SD_workstation_get_property_value(SD_workstation_t ws,
140 return xbt_dict_get_or_null(SD_workstation_get_properties(ws), name);
145 * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to this workstation
147 * \param workstation a workstation
148 * \return the dictionary containing the properties associated with the workstation
150 xbt_dict_t SD_workstation_get_properties(SD_workstation_t workstation)
152 return surf_workstation_model->extension.
153 workstation.get_properties(workstation->surf_workstation);
159 * \brief Returns the route between two workstations
161 * Use SD_route_get_size() to know the array size.
163 * \param src a workstation
164 * \param dst another workstation
165 * \return a new array of \ref SD_link_t representating the route between these two workstations
166 * \see SD_route_get_size(), SD_link_t
168 const SD_link_t *SD_route_get_list(SD_workstation_t src,
169 SD_workstation_t dst)
173 xbt_dynar_t surf_route;
174 const char *link_name;
178 if (sd_global->recyclable_route == NULL) {
180 sd_global->recyclable_route = xbt_new(SD_link_t, SD_link_get_number());
183 surf_src = src->surf_workstation;
184 surf_dst = dst->surf_workstation;
186 surf_workstation_model->extension.workstation.get_route(surf_src,
189 xbt_dynar_foreach(surf_route, cpt, surf_link) {
190 link_name = surf_resource_name(surf_link);
191 sd_global->recyclable_route[cpt] =
192 xbt_lib_get_or_null(link_lib, link_name, SD_LINK_LEVEL);
194 return sd_global->recyclable_route;
198 * \brief Returns the number of links on the route between two workstations
200 * \param src a workstation
201 * \param dst another workstation
202 * \return the number of links on the route between these two workstations
203 * \see SD_route_get_list()
205 int SD_route_get_size(SD_workstation_t src, SD_workstation_t dst)
207 return xbt_dynar_length(surf_workstation_model->extension.
208 workstation.get_route(src->surf_workstation,
209 dst->surf_workstation));
213 * \brief Returns the total power of a workstation
215 * \param workstation a workstation
216 * \return the total power of this workstation
217 * \see SD_workstation_get_available_power()
219 double SD_workstation_get_power(SD_workstation_t workstation)
221 return surf_workstation_model->extension.workstation.
222 get_speed(workstation->surf_workstation, 1.0);
226 * \brief Returns the proportion of available power in a workstation
228 * \param workstation a workstation
229 * \return the proportion of power currently available in this workstation (normally a number between 0 and 1)
230 * \see SD_workstation_get_power()
232 double SD_workstation_get_available_power(SD_workstation_t workstation)
234 return surf_workstation_model->extension.
235 workstation.get_available_speed(workstation->surf_workstation);
239 * \brief Returns an approximative estimated time for the given computation amount on a workstation
241 * \param workstation a workstation
242 * \param computation_amount the computation amount you want to evaluate (in flops)
243 * \return an approximative astimated computation time for the given computation amount on this workstation (in seconds)
245 double SD_workstation_get_computation_time(SD_workstation_t workstation,
246 double computation_amount)
248 xbt_assert(computation_amount >= 0,
249 "computation_amount must be greater than or equal to zero");
250 return computation_amount / SD_workstation_get_power(workstation);
254 * \brief Returns the latency of the route between two workstations, i.e. the sum of all link latencies
255 * between the workstations.
257 * \param src the first workstation
258 * \param dst the second workstation
259 * \return the latency of the route between the two workstations (in seconds)
260 * \see SD_route_get_current_bandwidth()
262 double SD_route_get_current_latency(SD_workstation_t src,
263 SD_workstation_t dst)
266 const SD_link_t *links;
271 links = SD_route_get_list(src, dst);
272 nb_links = SD_route_get_size(src, dst);
275 for (i = 0; i < nb_links; i++) {
276 latency += SD_link_get_current_latency(links[i]);
283 * \brief Returns the bandwidth of the route between two workstations, i.e. the minimum link bandwidth of all
284 * between the workstations.
286 * \param src the first workstation
287 * \param dst the second workstation
288 * \return the bandwidth of the route between the two workstations (in bytes/second)
289 * \see SD_route_get_current_latency()
291 double SD_route_get_current_bandwidth(SD_workstation_t src,
292 SD_workstation_t dst)
295 const SD_link_t *links;
298 double min_bandwidth;
301 links = SD_route_get_list(src, dst);
302 nb_links = SD_route_get_size(src, dst);
303 bandwidth = min_bandwidth = -1.0;
306 for (i = 0; i < nb_links; i++) {
307 bandwidth = SD_link_get_current_bandwidth(links[i]);
308 if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
309 min_bandwidth = bandwidth;
312 return min_bandwidth;
316 * \brief Returns an approximative estimated time for the given
317 * communication amount between two workstations
319 * \param src the first workstation
320 * \param dst the second workstation
321 * \param communication_amount the communication amount you want to evaluate (in bytes)
322 * \return an approximative astimated computation time for the given communication amount
323 * between the workstations (in seconds)
325 double SD_route_get_communication_time(SD_workstation_t src,
326 SD_workstation_t dst,
327 double communication_amount)
331 /* total time = latency + transmission time of the slowest link
332 transmission time of a link = communication amount / link bandwidth */
334 const SD_link_t *links;
336 double bandwidth, min_bandwidth;
340 xbt_assert(communication_amount >= 0,
341 "communication_amount must be greater than or equal to zero");
345 if (communication_amount == 0.0)
348 links = SD_route_get_list(src, dst);
349 nb_links = SD_route_get_size(src, dst);
350 min_bandwidth = -1.0;
353 for (i = 0; i < nb_links; i++) {
354 latency += SD_link_get_current_latency(links[i]);
355 bandwidth = SD_link_get_current_bandwidth(links[i]);
356 if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
357 min_bandwidth = bandwidth;
360 return latency + (communication_amount / min_bandwidth);
364 * \brief Returns the access mode of this workstation.
366 * \param workstation a workstation
367 * \return the access mode for the tasks running on this workstation:
368 * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
370 * \see SD_workstation_set_access_mode(), e_SD_workstation_access_mode_t
372 e_SD_workstation_access_mode_t
373 SD_workstation_get_access_mode(SD_workstation_t workstation)
375 return workstation->access_mode;
379 * \brief Sets the access mode for the tasks that will be executed on a workstation
381 * By default, a workstation model is shared, i.e. several tasks
382 * can be executed at the same time on a workstation. The CPU power of
383 * the workstation is shared between the running tasks on the workstation.
384 * In sequential mode, only one task can use the workstation, and the other
385 * tasks wait in a FIFO.
387 * \param workstation a workstation
388 * \param access_mode the access mode you want to set to this workstation:
389 * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
391 * \see SD_workstation_get_access_mode(), e_SD_workstation_access_mode_t
393 void SD_workstation_set_access_mode(SD_workstation_t workstation,
394 e_SD_workstation_access_mode_t
397 if (access_mode == workstation->access_mode) {
398 return; // nothing is changed
401 workstation->access_mode = access_mode;
403 if (access_mode == SD_WORKSTATION_SHARED_ACCESS) {
404 xbt_fifo_free(workstation->task_fifo);
405 workstation->task_fifo = NULL;
407 workstation->task_fifo = xbt_fifo_new();
411 /* Returns whether a task can start now on a workstation.
413 int __SD_workstation_can_start(SD_workstation_t workstation, SD_task_t task) {
414 SD_CHECK_INIT_DONE();
415 xbt_assert(workstation != NULL && task != NULL, "Invalid parameter");
417 return !__SD_workstation_is_busy(workstation) &&
418 (xbt_fifo_size(workstation->task_fifo) == 0) || xbt_fifo_get_first_item(workstation->task_fifo) == task);
422 /* Returns whether a workstation is busy. A workstation is busy is it is
423 * in sequential mode and a task is running on it or the fifo is not empty.
425 int __SD_workstation_is_busy(SD_workstation_t workstation)
428 ("Workstation '%s' access mode: '%s', current task: %s, fifo size: %d",
429 SD_workstation_get_name(workstation),
430 (workstation->access_mode ==
431 SD_WORKSTATION_SHARED_ACCESS) ? "SHARED" : "FIFO",
432 (workstation->current_task ?
433 SD_task_get_name(workstation->current_task)
435 (workstation->task_fifo ? xbt_fifo_size(workstation->task_fifo) :
438 return workstation->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS &&
439 (workstation->current_task != NULL
440 || xbt_fifo_size(workstation->task_fifo) > 0);
443 /* Destroys a workstation.
445 void __SD_workstation_destroy(void *workstation)
450 /* workstation->surf_workstation is freed by surf_exit and workstation->data is freed by the user */
452 w = (SD_workstation_t) workstation;
454 if (w->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS) {
455 xbt_fifo_free(w->task_fifo);
461 * \brief Returns the kind of the task currently running on a workstation
462 * Only call this with sequential access mode set
463 * \param workstation a workstation */
464 SD_task_t SD_workstation_get_current_task(SD_workstation_t workstation)
466 xbt_assert(workstation->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS,
467 "Access mode must be set to SD_WORKSTATION_SEQUENTIAL_ACCESS"
468 " to use this function");
470 return (workstation->current_task);