2 #include "simdag/simdag.h"
4 #include "xbt/sysdep.h"
7 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_workstation, sd,
8 "Logging specific to SimDag (workstation)");
10 /* Creates a workstation and registers it in SD.
12 SD_workstation_t __SD_workstation_create(void *surf_workstation, void *data)
15 SD_workstation_t workstation;
18 xbt_assert0(surf_workstation != NULL, "surf_workstation is NULL !");
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;
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++;
35 * \brief Returns a workstation given its name
37 * If there is no such workstation, the function returns \c NULL.
39 * \param name workstation name
40 * \return the workstation, or \c NULL if there is no such workstation
42 SD_workstation_t SD_workstation_get_by_name(const char *name)
46 xbt_assert0(name != NULL, "Invalid parameter");
48 return xbt_dict_get_or_null(sd_global->workstations, name);
52 * \brief Returns the workstation list
54 * Use SD_workstation_get_number() to know the array size.
56 * \return an array of \ref SD_workstation_t containing all workstations
57 * \see SD_workstation_get_number()
59 const SD_workstation_t *SD_workstation_get_list(void)
62 xbt_dict_cursor_t cursor;
68 xbt_assert0(SD_workstation_get_number() > 0, "There is no workstation!");
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);
77 xbt_dict_foreach(sd_global->workstations, cursor, key, data) {
78 sd_global->workstation_list[i++] = (SD_workstation_t) data;
81 return sd_global->workstation_list;
85 * \brief Returns the number of workstations
87 * \return the number of existing workstations
88 * \see SD_workstation_get_list()
90 int SD_workstation_get_number(void)
93 return sd_global->workstation_count;
97 * \brief Returns the user data of a workstation
99 * \param workstation a workstation
100 * \return the user data associated with this workstation (can be \c NULL)
101 * \see SD_workstation_set_data()
103 void *SD_workstation_get_data(SD_workstation_t workstation)
105 SD_CHECK_INIT_DONE();
106 xbt_assert0(workstation != NULL, "Invalid parameter");
107 return workstation->data;
111 * \brief Sets the user data of a workstation
113 * The new data can be \c NULL. The old data should have been freed first
114 * if it was not \c NULL.
116 * \param workstation a workstation
117 * \param data the new data you want to associate with this workstation
118 * \see SD_workstation_get_data()
120 void SD_workstation_set_data(SD_workstation_t workstation, void *data)
122 SD_CHECK_INIT_DONE();
123 xbt_assert0(workstation != NULL, "Invalid parameter");
124 workstation->data = data;
128 * \brief Returns the name of a workstation
130 * \param workstation a workstation
131 * \return the name of this workstation (cannot be \c NULL)
133 const char *SD_workstation_get_name(SD_workstation_t workstation)
135 SD_CHECK_INIT_DONE();
136 xbt_assert0(workstation != NULL, "Invalid parameter");
137 return surf_resource_name(workstation->surf_workstation);
141 * \brief Returns the value of a given workstation property
143 * \param ws a workstation
144 * \param name a property name
145 * \return value of a property (or NULL if property not set)
147 const char *SD_workstation_get_property_value(SD_workstation_t ws,
150 return xbt_dict_get_or_null(SD_workstation_get_properties(ws), name);
155 * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to this workstation
157 * \param workstation a workstation
158 * \return the dictionary containing the properties associated with the workstation
160 xbt_dict_t SD_workstation_get_properties(SD_workstation_t workstation)
162 SD_CHECK_INIT_DONE();
163 xbt_assert0((workstation != NULL), "Invalid parameters");
165 return surf_workstation_model->extension.workstation.get_properties(workstation->surf_workstation);
171 * \brief Returns the route between two workstations
173 * Use SD_route_get_size() to know the array size.
175 * \param src a workstation
176 * \param dst another workstation
177 * \return a new array of \ref SD_link_t representating the route between these two workstations
178 * \see SD_route_get_size(), SD_link_t
180 const SD_link_t *SD_route_get_list(SD_workstation_t src, SD_workstation_t dst)
184 xbt_dynar_t surf_route;
185 const char *link_name;
189 SD_CHECK_INIT_DONE();
191 if (sd_global->recyclable_route == NULL) {
193 sd_global->recyclable_route = xbt_new(SD_link_t, SD_link_get_number());
196 surf_src = src->surf_workstation;
197 surf_dst = dst->surf_workstation;
200 surf_workstation_model->extension.workstation.get_route(surf_src,
203 xbt_dynar_foreach(surf_route, cpt, surf_link) {
204 link_name = surf_resource_name(surf_link);
205 sd_global->recyclable_route[cpt] =
206 xbt_dict_get(sd_global->links, link_name);
209 return sd_global->recyclable_route;
213 * \brief Returns the number of links on the route between two workstations
215 * \param src a workstation
216 * \param dst another workstation
217 * \return the number of links on the route between these two workstations
218 * \see SD_route_get_list()
220 int SD_route_get_size(SD_workstation_t src, SD_workstation_t dst)
222 SD_CHECK_INIT_DONE();
223 return xbt_dynar_length(surf_workstation_model->extension.workstation.get_route(
224 src->surf_workstation,dst->surf_workstation));
228 * \brief Returns the total power of a workstation
230 * \param workstation a workstation
231 * \return the total power of this workstation
232 * \see SD_workstation_get_available_power()
234 double SD_workstation_get_power(SD_workstation_t workstation)
236 SD_CHECK_INIT_DONE();
237 xbt_assert0(workstation != NULL, "Invalid parameter");
238 return surf_workstation_model->extension.workstation.
239 get_speed(workstation->surf_workstation, 1.0);
243 * \brief Returns the proportion of available power in a workstation
245 * \param workstation a workstation
246 * \return the proportion of power currently available in this workstation (normally a number between 0 and 1)
247 * \see SD_workstation_get_power()
249 double SD_workstation_get_available_power(SD_workstation_t workstation)
251 SD_CHECK_INIT_DONE();
252 xbt_assert0(workstation != NULL, "Invalid parameter");
253 return surf_workstation_model->extension.
254 workstation.get_available_speed(workstation->surf_workstation);
258 * \brief Returns an approximative estimated time for the given computation amount on a workstation
260 * \param workstation a workstation
261 * \param computation_amount the computation amount you want to evaluate (in flops)
262 * \return an approximative astimated computation time for the given computation amount on this workstation (in seconds)
264 double SD_workstation_get_computation_time(SD_workstation_t workstation,
265 double computation_amount)
267 SD_CHECK_INIT_DONE();
268 xbt_assert0(workstation != NULL, "Invalid parameter");
269 xbt_assert0(computation_amount >= 0,
270 "computation_amount must be greater than or equal to zero");
271 return computation_amount / SD_workstation_get_power(workstation);
275 * \brief Returns the latency of the route between two workstations, i.e. the sum of all link latencies
276 * between the workstations.
278 * \param src the first workstation
279 * \param dst the second workstation
280 * \return the latency of the route between the two workstations (in seconds)
281 * \see SD_route_get_current_bandwidth()
283 double SD_route_get_current_latency(SD_workstation_t src,
284 SD_workstation_t dst)
287 const SD_link_t *links;
292 SD_CHECK_INIT_DONE();
293 xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
294 links = SD_route_get_list(src, dst);
295 nb_links = SD_route_get_size(src, dst);
298 for (i = 0; i < nb_links; i++) {
299 latency += SD_link_get_current_latency(links[i]);
306 * \brief Returns the bandwidth of the route between two workstations, i.e. the minimum link bandwidth of all
307 * between the workstations.
309 * \param src the first workstation
310 * \param dst the second workstation
311 * \return the bandwidth of the route between the two workstations (in bytes/second)
312 * \see SD_route_get_current_latency()
314 double SD_route_get_current_bandwidth(SD_workstation_t src,
315 SD_workstation_t dst)
318 const SD_link_t *links;
321 double min_bandwidth;
324 SD_CHECK_INIT_DONE();
325 xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
327 links = SD_route_get_list(src, dst);
328 nb_links = SD_route_get_size(src, dst);
329 bandwidth = min_bandwidth = -1.0;
332 for (i = 0; i < nb_links; i++) {
333 bandwidth = SD_link_get_current_bandwidth(links[i]);
334 if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
335 min_bandwidth = bandwidth;
338 return min_bandwidth;
342 * \brief Returns an approximative estimated time for the given
343 * communication amount between two workstations
345 * \param src the first workstation
346 * \param dst the second workstation
347 * \param communication_amount the communication amount you want to evaluate (in bytes)
348 * \return an approximative astimated computation time for the given communication amount
349 * between the workstations (in seconds)
351 double SD_route_get_communication_time(SD_workstation_t src,
352 SD_workstation_t dst,
353 double communication_amount)
357 /* total time = latency + transmission time of the slowest link
358 transmission time of a link = communication amount / link bandwidth */
360 const SD_link_t *links;
362 double bandwidth, min_bandwidth;
366 SD_CHECK_INIT_DONE();
367 xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
368 xbt_assert0(communication_amount >= 0,
369 "communication_amount must be greater than or equal to zero");
373 if (communication_amount == 0.0)
376 links = SD_route_get_list(src, dst);
377 nb_links = SD_route_get_size(src, dst);
378 min_bandwidth = -1.0;
381 for (i = 0; i < nb_links; i++) {
382 latency += SD_link_get_current_latency(links[i]);
383 bandwidth = SD_link_get_current_bandwidth(links[i]);
384 if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
385 min_bandwidth = bandwidth;
388 return latency + (communication_amount / min_bandwidth);
392 * \brief Returns the access mode of this workstation.
394 * \param workstation a workstation
395 * \return the access mode for the tasks running on this workstation:
396 * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
398 * \see SD_workstation_set_access_mode(), e_SD_workstation_access_mode_t
400 e_SD_workstation_access_mode_t SD_workstation_get_access_mode(SD_workstation_t
403 SD_CHECK_INIT_DONE();
404 xbt_assert0(workstation != NULL, "Invalid parameter");
405 return workstation->access_mode;
409 * \brief Sets the access mode for the tasks that will be executed on a workstation
411 * By default, a workstation model is shared, i.e. several tasks
412 * can be executed at the same time on a workstation. The CPU power of
413 * the workstation is shared between the running tasks on the workstation.
414 * In sequential mode, only one task can use the workstation, and the other
415 * tasks wait in a FIFO.
417 * \param workstation a workstation
418 * \param access_mode the access mode you want to set to this workstation:
419 * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
421 * \see SD_workstation_get_access_mode(), e_SD_workstation_access_mode_t
423 void SD_workstation_set_access_mode(SD_workstation_t workstation,
424 e_SD_workstation_access_mode_t
427 SD_CHECK_INIT_DONE();
428 xbt_assert0(workstation != NULL, "Invalid parameter");
430 if (access_mode == workstation->access_mode) {
431 return; // nothing is changed
434 workstation->access_mode = access_mode;
436 if (access_mode == SD_WORKSTATION_SHARED_ACCESS) {
437 xbt_fifo_free(workstation->task_fifo);
438 workstation->task_fifo = NULL;
440 workstation->task_fifo = xbt_fifo_new();
444 /* Returns whether a task can start now on a workstation.
446 int __SD_workstation_can_start(SD_workstation_t workstation, SD_task_t task) {
447 SD_CHECK_INIT_DONE();
448 xbt_assert0(workstation != NULL && task != NULL, "Invalid parameter");
450 return !__SD_workstation_is_busy(workstation) &&
451 (xbt_fifo_size(workstation->task_fifo) == 0) || xbt_fifo_get_first_item(workstation->task_fifo) == task);
455 /* Returns whether a workstation is busy. A workstation is busy is it is
456 * in sequential mode and a task is running on it or the fifo is not empty.
458 int __SD_workstation_is_busy(SD_workstation_t workstation)
460 SD_CHECK_INIT_DONE();
461 xbt_assert0(workstation != NULL, "Invalid parameter");
464 ("Workstation '%s' access mode: '%s', current task: %s, fifo size: %d",
465 SD_workstation_get_name(workstation),
466 (workstation->access_mode ==
467 SD_WORKSTATION_SHARED_ACCESS) ? "SHARED" : "FIFO",
468 (workstation->current_task ? SD_task_get_name(workstation->current_task)
470 (workstation->task_fifo ? xbt_fifo_size(workstation->task_fifo) : 0));
472 return workstation->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS &&
473 (workstation->current_task != NULL
474 || xbt_fifo_size(workstation->task_fifo) > 0);
477 /* Destroys a workstation.
479 void __SD_workstation_destroy(void *workstation)
484 SD_CHECK_INIT_DONE();
485 xbt_assert0(workstation != NULL, "Invalid parameter");
486 /* workstation->surf_workstation is freed by surf_exit and workstation->data is freed by the user */
488 w = (SD_workstation_t) workstation;
490 if (w->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS) {
491 xbt_fifo_free(w->task_fifo);