Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
use a sane way to declare postparse callbacks, now that this way exists
[simgrid.git] / src / surf / surf.c
1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 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 <ctype.h>
8
9 #include "surf_private.h"
10 #include "xbt/module.h"
11 #include "mc/mc.h"
12 #include "surf/surf_resource.h"
13 //#include "surf/surf_resource_lmm.h"
14
15
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
17                                 "Logging specific to SURF (kernel)");
18
19 /* Additional declarations for Windows potability. */
20
21 #ifndef MAX_DRIVE
22 #define MAX_DRIVE 26
23 #endif
24
25 #ifdef _XBT_WIN32
26 #include <windows.h>
27 static const char *disk_drives_letter_table[MAX_DRIVE] = {
28   "A:\\",
29   "B:\\",
30   "C:\\",
31   "D:\\",
32   "E:\\",
33   "F:\\",
34   "G:\\",
35   "H:\\",
36   "I:\\",
37   "J:\\",
38   "K:\\",
39   "L:\\",
40   "M:\\",
41   "N:\\",
42   "O:\\",
43   "P:\\",
44   "Q:\\",
45   "R:\\",
46   "S:\\",
47   "T:\\",
48   "U:\\",
49   "V:\\",
50   "W:\\",
51   "X:\\",
52   "Y:\\",
53   "Z:\\"
54 };
55 #endif                          /* #ifdef _XBT_WIN32 */
56
57 /*
58  * Returns the initial path. On Windows the initial path is
59  * the current directory for the current process in the other
60  * case the function returns "./" that represents the current
61  * directory on Unix/Linux platforms.
62  */
63
64 const char *__surf_get_initial_path(void)
65 {
66
67 #ifdef _XBT_WIN32
68   unsigned i;
69   char current_directory[MAX_PATH + 1] = { 0 };
70   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
71   char root[4] = { 0 };
72
73   if (!len)
74     return NULL;
75
76   strncpy(root, current_directory, 3);
77
78   for (i = 0; i < MAX_DRIVE; i++) {
79     if (toupper(root[0]) == disk_drives_letter_table[i][0])
80       return disk_drives_letter_table[i];
81   }
82
83   return NULL;
84 #else
85   return "./";
86 #endif
87 }
88
89 /* The __surf_is_absolute_file_path() returns 1 if
90  * file_path is a absolute file path, in the other
91  * case the function returns 0.
92  */
93 int __surf_is_absolute_file_path(const char *file_path)
94 {
95 #ifdef _XBT_WIN32
96   WIN32_FIND_DATA wfd = { 0 };
97   HANDLE hFile = FindFirstFile(file_path, &wfd);
98
99   if (INVALID_HANDLE_VALUE == hFile)
100     return 0;
101
102   FindClose(hFile);
103   return 1;
104 #else
105   return (file_path[0] == '/');
106 #endif
107 }
108
109 double NOW = 0;
110
111 xbt_dynar_t model_list = NULL;
112 tmgr_history_t history = NULL;
113 lmm_system_t maxmin_system = NULL;
114 xbt_dynar_t surf_path = NULL;
115
116 /* Don't forget to update the option description in smx_config when you change this */
117 s_surf_model_description_t surf_network_model_description[] = {
118   {"Constant",
119    "Simplistic network model where all communication take a constant time (one second)",
120    surf_network_model_init_Constant},
121   {"CM02",
122    "Realistic network model with lmm_solve and no correction factors",
123    surf_network_model_init_CM02},
124   {"LV08",
125    "Realistic network model with lmm_solve, adequate correction factors (latency*=10.4, bandwidth*=.92, S=8775) and partial invalidation optimization",
126    im_surf_network_model_init_LegrandVelho},
127    {"LV08_fullupdate",
128     "Realistic network model wit lmm_solve, adequate correction factors (latency*=10.4, bandwidth*=.92, S=8775) but no further optimization. Should produce the same results as LV08, only slower.",
129     surf_network_model_init_LegrandVelho},
130   {"SMPI",
131    "Realistic network model with lmm_solve and correction factors on three intervals (< 1KiB, < 64 KiB, >= 64 KiB)",
132    surf_network_model_init_SMPI},
133 #ifdef HAVE_GTNETS
134   {"GTNets",
135    "Network Pseudo-model using the GTNets simulator instead of an analytic model",
136    surf_network_model_init_GTNETS},
137 #endif
138 #ifdef HAVE_NS3
139   {"NS3",
140    "Use NS3 tcp model",
141         surf_network_model_init_NS3},
142 #endif
143   {"Reno",
144    "Model using lagrange_solve instead of lmm_solve (experts only)",
145    surf_network_model_init_Reno},
146   {"Reno2",
147    "Model using lagrange_solve instead of lmm_solve (experts only)",
148    surf_network_model_init_Reno2},
149   {"Vegas",
150    "Model using lagrange_solve instead of lmm_solve (experts only)",
151    surf_network_model_init_Vegas},
152   {NULL, NULL, NULL}      /* this array must be NULL terminated */
153 };
154
155 s_surf_model_description_t surf_cpu_model_description[] = {
156   {"Cas01_fullupdate", "CPU classical model time=size/power",
157    surf_cpu_model_init_Cas01},
158   {"Cas01",
159    "Variation of Cas01_fullupdate with partial invalidation optimization of lmm system. Should produce the same values, only faster",
160    surf_cpu_model_init_Cas01_im},
161   {"CpuTI",
162    "Variation of Cas01 with also trace integration. Should produce the same values, only faster if you use availability traces",
163    surf_cpu_model_init_ti},
164   {NULL, NULL,  NULL}      /* this array must be NULL terminated */
165 };
166
167 s_surf_model_description_t surf_workstation_model_description[] = {
168   {"CLM03",
169    "Default workstation model, using LV08 and CM02 as network and CPU",
170    surf_workstation_model_init_CLM03},
171   {"compound",
172    "Workstation model allowing you to use other network and CPU models",
173    surf_workstation_model_init_compound},
174   {"ptask_L07", "Workstation model with better parallel task modeling",
175    surf_workstation_model_init_ptask_L07},
176   {NULL, NULL, NULL}      /* this array must be NULL terminated */
177 };
178
179 /** Displays the long description of all registered models, and quit */
180 void model_help(const char *category, s_surf_model_description_t * table)
181 {
182   int i;
183   printf("Long description of the %s models accepted by this simulator:\n",
184          category);
185   for (i = 0; table[i].name; i++)
186     printf("  %s: %s\n", table[i].name, table[i].description);
187 }
188
189 int find_model_description(s_surf_model_description_t * table,
190                            const char *name)
191 {
192   int i;
193   char *name_list = NULL;
194
195   for (i = 0; table[i].name; i++)
196     if (!strcmp(name, table[i].name)) {
197       return i;
198     }
199   name_list = strdup(table[0].name);
200   for (i = 1; table[i].name; i++) {
201     name_list =
202         xbt_realloc(name_list,
203                     strlen(name_list) + strlen(table[i].name) + 2);
204     strcat(name_list, ", ");
205     strcat(name_list, table[i].name);
206   }
207   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
208   return -1;
209 }
210
211 double generic_maxmin_share_resources(xbt_swag_t running_actions,
212                                       size_t offset,
213                                       lmm_system_t sys,
214                                       void (*solve) (lmm_system_t))
215 {
216   surf_action_t action = NULL;
217   double min = -1;
218   double value = -1;
219 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
220
221   xbt_assert(solve, "Give me a real solver function!");
222   solve(sys);
223
224   xbt_swag_foreach(action, running_actions) {
225     value = lmm_variable_getvalue(VARIABLE(action));
226     if ((value > 0) || (action->max_duration >= 0))
227       break;
228   }
229
230   if (!action)
231     return -1.0;
232
233   if (value > 0) {
234     if (action->remains > 0)
235       min = action->remains / value;
236     else
237       min = 0.0;
238     if ((action->max_duration >= 0) && (action->max_duration < min))
239       min = action->max_duration;
240   } else
241     min = action->max_duration;
242
243
244   for (action = xbt_swag_getNext(action, running_actions->offset);
245        action;
246        action = xbt_swag_getNext(action, running_actions->offset)) {
247     value = lmm_variable_getvalue(VARIABLE(action));
248     if (value > 0) {
249       if (action->remains > 0)
250         value = action->remains / value;
251       else
252         value = 0.0;
253       if (value < min) {
254         min = value;
255         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
256       }
257     }
258     if ((action->max_duration >= 0) && (action->max_duration < min)) {
259       min = action->max_duration;
260       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
261     }
262   }
263   XBT_DEBUG("min value : %f", min);
264
265 #undef VARIABLE
266   return min;
267 }
268
269 XBT_LOG_EXTERNAL_CATEGORY(surf_cpu);
270 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
271 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange);
272 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange_dichotomy);
273 XBT_LOG_EXTERNAL_CATEGORY(surf_maxmin);
274 XBT_LOG_EXTERNAL_CATEGORY(surf_network);
275 XBT_LOG_EXTERNAL_CATEGORY(surf_trace);
276 XBT_LOG_EXTERNAL_CATEGORY(surf_parse);
277 XBT_LOG_EXTERNAL_CATEGORY(surf_timer);
278 XBT_LOG_EXTERNAL_CATEGORY(surf_workstation);
279 XBT_LOG_EXTERNAL_CATEGORY(surf_config);
280 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
281
282 #ifdef HAVE_GTNETS
283 XBT_LOG_EXTERNAL_CATEGORY(surf_network_gtnets);
284 #endif
285
286 void surf_init(int *argc, char **argv)
287 {
288         XBT_DEBUG("Create all Libs");
289         host_lib = xbt_lib_new();
290         link_lib = xbt_lib_new();
291         as_router_lib = xbt_lib_new();
292
293         XBT_DEBUG("ADD ROUTING LEVEL");
294         ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_free);
295         ROUTING_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,xbt_free);
296
297         XBT_DEBUG("ADD SURF LEVELS");
298         SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
299         SURF_WKS_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
300         SURF_LINK_LEVEL = xbt_lib_add_level(link_lib,surf_resource_free);
301
302   /* Connect our log channels: that must be done manually under windows */
303   XBT_LOG_CONNECT(surf_cpu, surf);
304   XBT_LOG_CONNECT(surf_kernel, surf);
305   XBT_LOG_CONNECT(surf_lagrange, surf);
306   XBT_LOG_CONNECT(surf_lagrange_dichotomy, surf_lagrange);
307   XBT_LOG_CONNECT(surf_maxmin, surf);
308   XBT_LOG_CONNECT(surf_network, surf);
309   XBT_LOG_CONNECT(surf_trace, surf);
310   XBT_LOG_CONNECT(surf_parse, surf);
311   XBT_LOG_CONNECT(surf_timer, surf);
312   XBT_LOG_CONNECT(surf_workstation, surf);
313   XBT_LOG_CONNECT(surf_config, surf);
314   XBT_LOG_CONNECT(surf_route, surf);
315
316 #ifdef HAVE_GTNETS
317   XBT_LOG_CONNECT(surf_network_gtnets, surf);
318 #endif
319
320   xbt_init(argc, argv);
321   if (!model_list)
322     model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
323   if (!history)
324     history = tmgr_history_new();
325
326   surf_config_init(argc, argv);
327   surf_action_init();
328   if (MC_IS_ENABLED)
329     MC_memory_init();
330 }
331
332 #ifdef _XBT_WIN32
333 # define FILE_DELIM "\\"
334 #else
335 # define FILE_DELIM "/"         /* FIXME: move to better location */
336 #endif
337
338 FILE *surf_fopen(const char *name, const char *mode)
339 {
340   unsigned int cpt;
341   char *path_elm = NULL;
342   char *buff;
343   FILE *file = NULL;
344
345   xbt_assert(name);
346
347   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
348     return fopen(name, mode);
349
350   /* search relative files in the path */
351   xbt_dynar_foreach(surf_path, cpt, path_elm) {
352     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
353     file = fopen(buff, mode);
354     free(buff);
355
356     if (file)
357       return file;
358   }
359   return NULL;
360 }
361
362 void surf_exit(void)
363 {
364   unsigned int iter;
365   surf_model_t model = NULL;
366
367   surf_config_finalize();
368
369   xbt_dynar_foreach(model_list, iter, model)
370       model->model_private->finalize();
371   xbt_dynar_free(&model_list);
372
373   if (maxmin_system) {
374     lmm_system_free(maxmin_system);
375     maxmin_system = NULL;
376   }
377   if (history) {
378     tmgr_history_free(history);
379     history = NULL;
380   }
381   surf_action_exit();
382
383   xbt_dynar_free(&surf_path);
384
385   xbt_lib_free(&host_lib);
386   xbt_lib_free(&link_lib);
387   xbt_lib_free(&as_router_lib);
388
389
390   tmgr_finalize();
391   surf_parse_lex_destroy();
392   surf_parse_free_callbacks();
393
394   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
395 }
396
397 void surf_presolve(void)
398 {
399   double next_event_date = -1.0;
400   tmgr_trace_event_t event = NULL;
401   double value = -1.0;
402   surf_resource_t resource = NULL;
403   surf_model_t model = NULL;
404   unsigned int iter;
405
406   XBT_DEBUG
407       ("First Run! Let's \"purge\" events and put models in the right state");
408   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
409     if (next_event_date > NOW)
410       break;
411     while ((event =
412             tmgr_history_get_next_event_leq(history, next_event_date,
413                                             &value,
414                                             (void **) &resource))) {
415       resource->model->model_private->update_resource_state(resource,
416                                                             event, value,
417                                                             NOW);
418     }
419   }
420   xbt_dynar_foreach(model_list, iter, model)
421       model->model_private->update_actions_state(NOW, 0.0);
422 }
423
424 double surf_solve(double max_date)
425 {
426   double min = -1.0; /* duration */
427   double next_event_date = -1.0;
428   double model_next_action_end = -1.0;
429   double value = -1.0;
430   surf_resource_t resource = NULL;
431   surf_model_t model = NULL;
432   tmgr_trace_event_t event = NULL;
433   unsigned int iter;
434
435   if (max_date != -1.0 && max_date != NOW) {
436     min = max_date - NOW;
437   }
438
439   XBT_DEBUG("Looking for next action end for all models except NS3");
440   xbt_dynar_foreach(model_list, iter, model) {
441     if(strcmp(model->name,"network NS3") ){
442       XBT_DEBUG("Running for Resource [%s]", model->name);
443       model_next_action_end = model->model_private->share_resources(NOW);
444       XBT_DEBUG("Resource [%s] : next action end = %f",
445           model->name, model_next_action_end);
446       if (((min < 0.0) || (model_next_action_end < min))
447           && (model_next_action_end >= 0.0))
448         min = model_next_action_end;
449     }
450   }
451
452   XBT_DEBUG("Min for resources (except NS3) : %f", min);
453
454   XBT_DEBUG("Looking for next trace event");
455
456   do {
457     XBT_DEBUG("Next TRACE event : %f", next_event_date);
458
459     next_event_date = tmgr_history_next_date(history);
460
461     if(surf_network_model->name && !strcmp(surf_network_model->name,"network NS3")){
462       if(next_event_date!=-1.0 && min!=-1.0) {
463         min = MIN(next_event_date - NOW, min);
464       } else{
465         min = MAX(next_event_date - NOW, min);
466       }
467
468       XBT_DEBUG("Run for NS3 at most %f", min);
469       // run until min or next flow
470       model_next_action_end = surf_network_model->model_private->share_resources(min);
471
472       XBT_DEBUG("Min for NS3 : %f", model_next_action_end);
473       if(model_next_action_end>=0.0)
474         min = model_next_action_end;
475     }
476
477     if (next_event_date == -1.0) break;
478
479     if ((min != -1.0) && (next_event_date > NOW + min)) break;
480
481     XBT_DEBUG("Updating models");
482     while ((event =
483             tmgr_history_get_next_event_leq(history, next_event_date,
484                                             &value,
485                                             (void **) &resource))) {
486       if (resource->model->model_private->resource_used(resource)) {
487         min = next_event_date - NOW;
488         XBT_DEBUG
489             ("This event will modify model state. Next event set to %f",
490              min);
491       }
492       /* update state of model_obj according to new value. Does not touch lmm.
493          It will be modified if needed when updating actions */
494       XBT_DEBUG("Calling update_resource_state for resource %s with min %lf",
495              resource->model->name, min);
496       resource->model->model_private->update_resource_state(resource,
497                                                             event, value,
498                                                             NOW + min);
499     }
500   } while (1);
501
502   /* FIXME: Moved this test to here to avoid stoping simulation if there are actions running on cpus and all cpus are with availability = 0. 
503    * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
504    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
505   if (min < 0.0)
506     return -1.0;
507
508   XBT_DEBUG("Duration set to %f", min);
509
510   NOW = NOW + min;
511
512   xbt_dynar_foreach(model_list, iter, model)
513       model->model_private->update_actions_state(NOW, min);
514
515 #ifdef HAVE_TRACING
516   TRACE_paje_dump_buffer (0);
517 #endif
518
519   return min;
520 }
521
522 XBT_INLINE double surf_get_clock(void)
523 {
524   return NOW;
525 }