Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Implement a generic resource; use it as ancestor to specific ones
[simgrid.git] / src / simdag / sd_workstation.c
1 #include "private.h"
2 #include "simdag/simdag.h"
3 #include "xbt/dict.h"
4 #include "xbt/sysdep.h"
5 #include "surf/surf.h"
6
7 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_workstation, sd,
8                                 "Logging specific to SimDag (workstation)");
9
10 /* Creates a workstation and registers it in SD.
11  */
12 SD_workstation_t __SD_workstation_create(void *surf_workstation, void *data)
13 {
14
15   SD_workstation_t workstation;
16   const char *name;
17   SD_CHECK_INIT_DONE();
18   xbt_assert0(surf_workstation != NULL, "surf_workstation is NULL !");
19
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;
26
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++;
30
31   return workstation;
32 }
33
34 /**
35  * \brief Returns a workstation given its name
36  *
37  * If there is no such workstation, the function returns \c NULL.
38  *
39  * \param name workstation name
40  * \return the workstation, or \c NULL if there is no such workstation
41  */
42 SD_workstation_t SD_workstation_get_by_name(const char *name)
43 {
44   SD_CHECK_INIT_DONE();
45
46   xbt_assert0(name != NULL, "Invalid parameter");
47
48   return xbt_dict_get_or_null(sd_global->workstations, name);
49 }
50
51 /**
52  * \brief Returns the workstation list
53  *
54  * Use SD_workstation_get_number() to know the array size.
55  *
56  * \return an array of \ref SD_workstation_t containing all workstations
57  * \see SD_workstation_get_number()
58  */
59 const SD_workstation_t *SD_workstation_get_list(void)
60 {
61
62   xbt_dict_cursor_t cursor;
63   char *key;
64   void *data;
65   int i;
66
67   SD_CHECK_INIT_DONE();
68   xbt_assert0(SD_workstation_get_number() > 0, "There is no workstation!");
69
70
71
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);
75
76     i = 0;
77     xbt_dict_foreach(sd_global->workstations, cursor, key, data) {
78       sd_global->workstation_list[i++] = (SD_workstation_t) data;
79     }
80   }
81   return sd_global->workstation_list;
82 }
83
84 /**
85  * \brief Returns the number of workstations
86  *
87  * \return the number of existing workstations
88  * \see SD_workstation_get_list()
89  */
90 int SD_workstation_get_number(void)
91 {
92   SD_CHECK_INIT_DONE();
93   return sd_global->workstation_count;
94 }
95
96 /**
97  * \brief Returns the user data of a workstation
98  *
99  * \param workstation a workstation
100  * \return the user data associated with this workstation (can be \c NULL)
101  * \see SD_workstation_set_data()
102  */
103 void *SD_workstation_get_data(SD_workstation_t workstation)
104 {
105   SD_CHECK_INIT_DONE();
106   xbt_assert0(workstation != NULL, "Invalid parameter");
107   return workstation->data;
108 }
109
110 /**
111  * \brief Sets the user data of a workstation
112  *
113  * The new data can be \c NULL. The old data should have been freed first
114  * if it was not \c NULL.
115  *
116  * \param workstation a workstation
117  * \param data the new data you want to associate with this workstation
118  * \see SD_workstation_get_data()
119  */
120 void SD_workstation_set_data(SD_workstation_t workstation, void *data)
121 {
122   SD_CHECK_INIT_DONE();
123   xbt_assert0(workstation != NULL, "Invalid parameter");
124   workstation->data = data;
125 }
126
127 /**
128  * \brief Returns the name of a workstation
129  *
130  * \param workstation a workstation
131  * \return the name of this workstation (cannot be \c NULL)
132  */
133 const char *SD_workstation_get_name(SD_workstation_t workstation)
134 {
135   SD_CHECK_INIT_DONE();
136   xbt_assert0(workstation != NULL, "Invalid parameter");
137   return surf_resource_name(workstation->surf_workstation);
138 }
139
140 /**
141  * \brief Returns the value of a given workstation property
142  *
143  * \param ws a workstation
144  * \param name a property name
145  * \return value of a property (or NULL if property not set)
146  */
147 const char *SD_workstation_get_property_value(SD_workstation_t ws,
148                                               const char *name)
149 {
150   return xbt_dict_get_or_null(SD_workstation_get_properties(ws), name);
151 }
152
153
154 /**
155  * \brief Returns a #xbt_dict_t consisting of the list of properties assigned to this workstation
156  *
157  * \param workstation a workstation
158  * \return the dictionary containing the properties associated with the workstation
159  */
160 xbt_dict_t SD_workstation_get_properties(SD_workstation_t workstation)
161 {
162   SD_CHECK_INIT_DONE();
163   xbt_assert0((workstation != NULL), "Invalid parameters");
164
165   return (surf_workstation_model->get_properties
166           (workstation->surf_workstation));
167
168 }
169
170
171 /**
172  * \brief Returns the route between two workstations
173  *
174  * Use SD_route_get_size() to know the array size.
175  *
176  * \param src a workstation
177  * \param dst another workstation
178  * \return a new array of \ref SD_link_t representating the route between these two workstations
179  * \see SD_route_get_size(), SD_link_t
180  */
181 const SD_link_t *SD_route_get_list(SD_workstation_t src, SD_workstation_t dst)
182 {
183   void *surf_src;
184   void *surf_dst;
185   const void **surf_route;
186   int route_size;
187   const char *link_name;
188   int i;
189
190   SD_CHECK_INIT_DONE();
191
192   if (sd_global->recyclable_route == NULL) {
193     /* first run */
194     sd_global->recyclable_route = xbt_new(SD_link_t, SD_link_get_number());
195   }
196
197   surf_src = src->surf_workstation;
198   surf_dst = dst->surf_workstation;
199
200   surf_route =
201     surf_workstation_model->extension.workstation.get_route(surf_src,
202                                                             surf_dst);
203   route_size =
204     surf_workstation_model->extension.workstation.get_route_size(surf_src,
205                                                                  surf_dst);
206
207
208   for (i = 0; i < route_size; i++) {
209     link_name = surf_resource_name(surf_route[i]);
210     sd_global->recyclable_route[i] =
211       xbt_dict_get(sd_global->links, link_name);
212   }
213
214   return sd_global->recyclable_route;
215 }
216
217 /**
218  * \brief Returns the number of links on the route between two workstations
219  *
220  * \param src a workstation
221  * \param dst another workstation
222  * \return the number of links on the route between these two workstations
223  * \see SD_route_get_list()
224  */
225 int SD_route_get_size(SD_workstation_t src, SD_workstation_t dst)
226 {
227   SD_CHECK_INIT_DONE();
228   return surf_workstation_model->extension.workstation.
229     get_route_size(src->surf_workstation, dst->surf_workstation);
230 }
231
232 /**
233  * \brief Returns the total power of a workstation
234  *
235  * \param workstation a workstation
236  * \return the total power of this workstation
237  * \see SD_workstation_get_available_power()
238  */
239 double SD_workstation_get_power(SD_workstation_t workstation)
240 {
241   SD_CHECK_INIT_DONE();
242   xbt_assert0(workstation != NULL, "Invalid parameter");
243   return surf_workstation_model->extension.workstation.
244     get_speed(workstation->surf_workstation, 1.0);
245 }
246
247 /**
248  * \brief Returns the proportion of available power in a workstation
249  *
250  * \param workstation a workstation
251  * \return the proportion of power currently available in this workstation (normally a number between 0 and 1)
252  * \see SD_workstation_get_power()
253  */
254 double SD_workstation_get_available_power(SD_workstation_t workstation)
255 {
256   SD_CHECK_INIT_DONE();
257   xbt_assert0(workstation != NULL, "Invalid parameter");
258   return surf_workstation_model->extension.
259     workstation.get_available_speed(workstation->surf_workstation);
260 }
261
262 /**
263  * \brief Returns an approximative estimated time for the given computation amount on a workstation
264  *
265  * \param workstation a workstation
266  * \param computation_amount the computation amount you want to evaluate (in flops)
267  * \return an approximative astimated computation time for the given computation amount on this workstation (in seconds)
268  */
269 double SD_workstation_get_computation_time(SD_workstation_t workstation,
270                                            double computation_amount)
271 {
272   SD_CHECK_INIT_DONE();
273   xbt_assert0(workstation != NULL, "Invalid parameter");
274   xbt_assert0(computation_amount >= 0,
275               "computation_amount must be greater than or equal to zero");
276   return computation_amount / SD_workstation_get_power(workstation);
277 }
278
279 /**
280  * \brief Returns the latency of the route between two workstations, i.e. the sum of all link latencies
281  * between the workstations.
282  *
283  * \param src the first workstation
284  * \param dst the second workstation
285  * \return the latency of the route between the two workstations (in seconds)
286  * \see SD_route_get_current_bandwidth()
287  */
288 double SD_route_get_current_latency(SD_workstation_t src,
289                                     SD_workstation_t dst)
290 {
291
292   const SD_link_t *links;
293   int nb_links;
294   double latency;
295   int i;
296
297   SD_CHECK_INIT_DONE();
298   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
299   links = SD_route_get_list(src, dst);
300   nb_links = SD_route_get_size(src, dst);
301   latency = 0.0;
302
303   for (i = 0; i < nb_links; i++) {
304     latency += SD_link_get_current_latency(links[i]);
305   }
306
307   return latency;
308 }
309
310 /**
311  * \brief Returns the bandwidth of the route between two workstations, i.e. the minimum link bandwidth of all
312  * between the workstations.
313  *
314  * \param src the first workstation
315  * \param dst the second workstation
316  * \return the bandwidth of the route between the two workstations (in bytes/second)
317  * \see SD_route_get_current_latency()
318  */
319 double SD_route_get_current_bandwidth(SD_workstation_t src,
320                                       SD_workstation_t dst)
321 {
322
323   const SD_link_t *links;
324   int nb_links;
325   double bandwidth;
326   double min_bandwidth;
327   int i;
328
329   SD_CHECK_INIT_DONE();
330   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
331
332   links = SD_route_get_list(src, dst);
333   nb_links = SD_route_get_size(src, dst);
334   bandwidth = min_bandwidth = -1.0;
335
336
337   for (i = 0; i < nb_links; i++) {
338     bandwidth = SD_link_get_current_bandwidth(links[i]);
339     if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
340       min_bandwidth = bandwidth;
341   }
342
343   return min_bandwidth;
344 }
345
346 /**
347  * \brief Returns an approximative estimated time for the given
348  * communication amount between two workstations
349  *
350  * \param src the first workstation
351  * \param dst the second workstation
352  * \param communication_amount the communication amount you want to evaluate (in bytes)
353  * \return an approximative astimated computation time for the given communication amount
354  * between the workstations (in seconds)
355  */
356 double SD_route_get_communication_time(SD_workstation_t src,
357                                        SD_workstation_t dst,
358                                        double communication_amount)
359 {
360
361
362   /* total time = latency + transmission time of the slowest link
363      transmission time of a link = communication amount / link bandwidth */
364
365   const SD_link_t *links;
366   int nb_links;
367   double bandwidth, min_bandwidth;
368   double latency;
369   int i;
370
371   SD_CHECK_INIT_DONE();
372   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
373   xbt_assert0(communication_amount >= 0,
374               "communication_amount must be greater than or equal to zero");
375
376
377
378   if (communication_amount == 0.0)
379     return 0.0;
380
381   links = SD_route_get_list(src, dst);
382   nb_links = SD_route_get_size(src, dst);
383   min_bandwidth = -1.0;
384   latency = 0;
385
386   for (i = 0; i < nb_links; i++) {
387     latency += SD_link_get_current_latency(links[i]);
388     bandwidth = SD_link_get_current_bandwidth(links[i]);
389     if (bandwidth < min_bandwidth || min_bandwidth == -1.0)
390       min_bandwidth = bandwidth;
391   }
392
393   return latency + (communication_amount / min_bandwidth);
394 }
395
396 /**
397  * \brief Returns the access mode of this workstation.
398  *
399  * \param workstation a workstation
400  * \return the access mode for the tasks running on this workstation:
401  * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
402  *
403  * \see SD_workstation_set_access_mode(), e_SD_workstation_access_mode_t
404  */
405 e_SD_workstation_access_mode_t SD_workstation_get_access_mode(SD_workstation_t
406                                                               workstation)
407 {
408   SD_CHECK_INIT_DONE();
409   xbt_assert0(workstation != NULL, "Invalid parameter");
410   return workstation->access_mode;
411 }
412
413 /**
414  * \brief Sets the access mode for the tasks that will be executed on a workstation
415  *
416  * By default, a workstation model is shared, i.e. several tasks
417  * can be executed at the same time on a workstation. The CPU power of
418  * the workstation is shared between the running tasks on the workstation.
419  * In sequential mode, only one task can use the workstation, and the other
420  * tasks wait in a FIFO.
421  *
422  * \param workstation a workstation
423  * \param access_mode the access mode you want to set to this workstation:
424  * SD_WORKSTATION_SHARED_ACCESS or SD_WORKSTATION_SEQUENTIAL_ACCESS
425  *
426  * \see SD_workstation_get_access_mode(), e_SD_workstation_access_mode_t
427  */
428 void SD_workstation_set_access_mode(SD_workstation_t workstation,
429                                     e_SD_workstation_access_mode_t
430                                     access_mode)
431 {
432   SD_CHECK_INIT_DONE();
433   xbt_assert0(workstation != NULL, "Invalid parameter");
434
435   if (access_mode == workstation->access_mode) {
436     return;                     // nothing is changed
437   }
438
439   workstation->access_mode = access_mode;
440
441   if (access_mode == SD_WORKSTATION_SHARED_ACCESS) {
442     xbt_fifo_free(workstation->task_fifo);
443     workstation->task_fifo = NULL;
444   } else {
445     workstation->task_fifo = xbt_fifo_new();
446   }
447 }
448
449 /* Returns whether a task can start now on a workstation.
450                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               *//*
451                                                                                                                                                                                                                                                                                                                                                                                                    int __SD_workstation_can_start(SD_workstation_t workstation, SD_task_t task) {
452                                                                                                                                                                                                                                                                                                                                                                                                    SD_CHECK_INIT_DONE();
453                                                                                                                                                                                                                                                                                                                                                                                                    xbt_assert0(workstation != NULL && task != NULL, "Invalid parameter");
454
455                                                                                                                                                                                                                                                                                                                                                                                                    return !__SD_workstation_is_busy(workstation) &&
456                                                                                                                                                                                                                                                                                                                                                                                                    (xbt_fifo_size(workstation->task_fifo) == 0) || xbt_fifo_get_first_item(workstation->task_fifo) == task);
457                                                                                                                                                                                                                                                                                                                                                                                                    }
458                                                                                                                                                                                                                                                                                                                                                                                                  */
459
460 /* Returns whether a workstation is busy. A workstation is busy is it is
461  * in sequential mode and a task is running on it or the fifo is not empty.
462  */
463 int __SD_workstation_is_busy(SD_workstation_t workstation)
464 {
465   SD_CHECK_INIT_DONE();
466   xbt_assert0(workstation != NULL, "Invalid parameter");
467
468   DEBUG4
469     ("Workstation '%s' access mode: '%s', current task: %s, fifo size: %d",
470      SD_workstation_get_name(workstation),
471      (workstation->access_mode ==
472       SD_WORKSTATION_SHARED_ACCESS) ? "SHARED" : "FIFO",
473      (workstation->current_task ? SD_task_get_name(workstation->current_task)
474       : "none"),
475      (workstation->task_fifo ? xbt_fifo_size(workstation->task_fifo) : 0));
476
477   return workstation->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS &&
478     (workstation->current_task != NULL
479      || xbt_fifo_size(workstation->task_fifo) > 0);
480 }
481
482 /* Destroys a workstation.
483  */
484 void __SD_workstation_destroy(void *workstation)
485 {
486
487   SD_workstation_t w;
488
489   SD_CHECK_INIT_DONE();
490   xbt_assert0(workstation != NULL, "Invalid parameter");
491   /* workstation->surf_workstation is freed by surf_exit and workstation->data is freed by the user */
492
493   w = (SD_workstation_t) workstation;
494
495   if (w->access_mode == SD_WORKSTATION_SEQUENTIAL_ACCESS) {
496     xbt_fifo_free(w->task_fifo);
497   }
498   xbt_free(w);
499 }