Logo AND Algorithmique Numérique Distribuée

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