Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
adapt perl tesh to handle timeout from command line, and defaut to 50 for windows...
[simgrid.git] / src / surf / surf.c
1 /* Copyright (c) 2004-2013. 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 "surf_private.h"
8 #include "xbt/module.h"
9 #include "mc/mc.h"
10 #include "simix/smx_host_private.h"
11 #include "surf/surf_resource.h"
12 #include "xbt/xbt_os_thread.h"
13 #include "simgrid/sg_config.h"
14
15 #include <ctype.h>
16
17 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
19                                 "Logging specific to SURF (kernel)");
20
21 /* Additional declarations for Windows portability. */
22
23 #ifndef MAX_DRIVE
24 #define MAX_DRIVE 26
25 #endif
26
27 #ifdef _XBT_WIN32
28 #include <windows.h>
29 static const char *disk_drives_letter_table[MAX_DRIVE] = {
30   "A:\\",
31   "B:\\",
32   "C:\\",
33   "D:\\",
34   "E:\\",
35   "F:\\",
36   "G:\\",
37   "H:\\",
38   "I:\\",
39   "J:\\",
40   "K:\\",
41   "L:\\",
42   "M:\\",
43   "N:\\",
44   "O:\\",
45   "P:\\",
46   "Q:\\",
47   "R:\\",
48   "S:\\",
49   "T:\\",
50   "U:\\",
51   "V:\\",
52   "W:\\",
53   "X:\\",
54   "Y:\\",
55   "Z:\\"
56 };
57 #endif                          /* #ifdef _XBT_WIN32 */
58
59 /*
60  * Returns the initial path. On Windows the initial path is
61  * the current directory for the current process in the other
62  * case the function returns "./" that represents the current
63  * directory on Unix/Linux platforms.
64  */
65
66 const char *__surf_get_initial_path(void)
67 {
68
69 #ifdef _XBT_WIN32
70   unsigned i;
71   char current_directory[MAX_PATH + 1] = { 0 };
72   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
73   char root[4] = { 0 };
74
75   if (!len)
76     return NULL;
77
78   strncpy(root, current_directory, 3);
79
80   for (i = 0; i < MAX_DRIVE; i++) {
81     if (toupper(root[0]) == disk_drives_letter_table[i][0])
82       return disk_drives_letter_table[i];
83   }
84
85   return NULL;
86 #else
87   return "./";
88 #endif
89 }
90
91 /* The __surf_is_absolute_file_path() returns 1 if
92  * file_path is a absolute file path, in the other
93  * case the function returns 0.
94  */
95 int __surf_is_absolute_file_path(const char *file_path)
96 {
97 #ifdef _XBT_WIN32
98   WIN32_FIND_DATA wfd = { 0 };
99   HANDLE hFile = FindFirstFile(file_path, &wfd);
100
101   if (INVALID_HANDLE_VALUE == hFile)
102     return 0;
103
104   FindClose(hFile);
105   return 1;
106 #else
107   return (file_path[0] == '/');
108 #endif
109 }
110
111 double NOW = 0;
112
113 xbt_dynar_t model_list = NULL;
114 tmgr_history_t history = NULL;
115 lmm_system_t maxmin_system = NULL;
116 xbt_dynar_t surf_path = NULL;
117 xbt_dynar_t host_that_restart = NULL;
118 xbt_dict_t watched_hosts_lib;
119
120 /* Don't forget to update the option description in smx_config when you change this */
121 s_surf_model_description_t surf_network_model_description[] = {
122   {"LV08",
123    "Realistic network analytic model (slow-start modeled by multiplying latency by 10.4, bandwidth by .92; bottleneck sharing uses a payload of S=8775 for evaluating RTT). ",
124    surf_network_model_init_LegrandVelho},
125   {"Constant",
126    "Simplistic network model where all communication take a constant time (one second). This model provides the lowest realism, but is (marginally) faster.",
127    surf_network_model_init_Constant},
128   {"SMPI",
129    "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
130    surf_network_model_init_SMPI},
131   {"CM02",
132    "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of small messages are thus poorly modeled).",
133    surf_network_model_init_CM02},
134 #ifdef HAVE_GTNETS
135   {"GTNets",
136    "Network pseudo-model using the GTNets simulator instead of an analytic model",
137    surf_network_model_init_GTNETS},
138 #endif
139 #ifdef HAVE_NS3
140   {"NS3",
141    "Network pseudo-model using the NS3 tcp model instead of an analytic model",
142   surf_network_model_init_NS3},
143 #endif
144   {"Reno",
145    "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
146    surf_network_model_init_Reno},
147   {"Reno2",
148    "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
149    surf_network_model_init_Reno2},
150   {"Vegas",
151    "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
152    surf_network_model_init_Vegas},
153   {NULL, NULL, NULL}      /* this array must be NULL terminated */
154 };
155
156 s_surf_model_description_t surf_cpu_model_description[] = {
157   {"Cas01",
158    "Simplistic CPU model (time=size/power).",
159    surf_cpu_model_init_Cas01},
160   {NULL, NULL,  NULL}      /* this array must be NULL terminated */
161 };
162
163 s_surf_model_description_t surf_workstation_model_description[] = {
164   {"default",
165    "Default workstation model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
166    surf_workstation_model_init_current_default},
167   {"compound",
168    "Workstation model that is automatically chosen if you change the network and CPU models",
169    surf_workstation_model_init_compound},
170   {"ptask_L07", "Workstation model somehow similar to Cas01+CM02 but allowing parallel tasks",
171    surf_workstation_model_init_ptask_L07},
172   {NULL, NULL, NULL}      /* this array must be NULL terminated */
173 };
174
175 s_surf_model_description_t surf_optimization_mode_description[] = {
176   {"Lazy",
177    "Lazy action management (partial invalidation in lmm + heap in action remaining).",
178    NULL},
179   {"TI",
180    "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU model for now).",
181     NULL},
182   {"Full",
183    "Full update of remaining and variables. Slow but may be useful when debugging.",
184    NULL},
185   {NULL, NULL, NULL}      /* this array must be NULL terminated */
186 };
187
188 s_surf_model_description_t surf_storage_model_description[] = {
189   {"default",
190    "Simplistic storage model.",
191    surf_storage_model_init_default},
192   {NULL, NULL,  NULL}      /* this array must be NULL terminated */
193 };
194
195 /* ********************************************************************* */
196 /* TUTORIAL: New model                                                   */
197 s_surf_model_description_t surf_new_model_description[] = {
198   {"default",
199    "Tutorial model.",
200    surf_new_model_init_default},
201   {NULL, NULL,  NULL}      /* this array must be NULL terminated */
202 };
203 /* ********************************************************************* */
204
205 #ifdef CONTEXT_THREADS
206 static xbt_parmap_t surf_parmap = NULL; /* parallel map on models */
207 #endif
208
209 static double *surf_mins = NULL; /* return value of share_resources for each model */
210 static int surf_min_index;       /* current index in surf_mins */
211 static double min;               /* duration determined by surf_solve */
212
213 static void surf_share_resources(surf_model_t model);
214 static void surf_update_actions_state(surf_model_t model);
215
216 /** Displays the long description of all registered models, and quit */
217 void model_help(const char *category, s_surf_model_description_t * table)
218 {
219   int i;
220   printf("Long description of the %s models accepted by this simulator:\n",
221          category);
222   for (i = 0; table[i].name; i++)
223     printf("  %s: %s\n", table[i].name, table[i].description);
224 }
225
226 int find_model_description(s_surf_model_description_t * table,
227                            const char *name)
228 {
229   int i;
230   char *name_list = NULL;
231
232   for (i = 0; table[i].name; i++)
233     if (!strcmp(name, table[i].name)) {
234       return i;
235     }
236   name_list = strdup(table[0].name);
237   for (i = 1; table[i].name; i++) {
238     name_list =
239         xbt_realloc(name_list,
240                     strlen(name_list) + strlen(table[i].name) + 3);
241     strcat(name_list, ", ");
242     strcat(name_list, table[i].name);
243   }
244   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
245   return -1;
246 }
247
248 double generic_maxmin_share_resources(xbt_swag_t running_actions,
249                                       size_t offset,
250                                       lmm_system_t sys,
251                                       void (*solve) (lmm_system_t))
252 {
253   surf_action_t action = NULL;
254   double min = -1;
255   double value = -1;
256 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
257
258   solve(sys);
259
260   xbt_swag_foreach(action, running_actions) {
261     value = lmm_variable_getvalue(VARIABLE(action));
262     if ((value > 0) || (action->max_duration >= 0))
263       break;
264   }
265
266   if (!action)
267     return -1.0;
268
269   if (value > 0) {
270     if (action->remains > 0)
271       min = action->remains / value;
272     else
273       min = 0.0;
274     if ((action->max_duration >= 0) && (action->max_duration < min))
275       min = action->max_duration;
276   } else
277     min = action->max_duration;
278
279
280   for (action = xbt_swag_getNext(action, running_actions->offset);
281        action;
282        action = xbt_swag_getNext(action, running_actions->offset)) {
283     value = lmm_variable_getvalue(VARIABLE(action));
284     if (value > 0) {
285       if (action->remains > 0)
286         value = action->remains / value;
287       else
288         value = 0.0;
289       if (value < min) {
290         min = value;
291         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
292       }
293     }
294     if ((action->max_duration >= 0) && (action->max_duration < min)) {
295       min = action->max_duration;
296       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
297     }
298   }
299   XBT_DEBUG("min value : %f", min);
300
301 #undef VARIABLE
302   return min;
303 }
304
305 double generic_share_resources_lazy(double now, surf_model_t model)
306 {
307   surf_action_lmm_t action = NULL;
308   double min = -1;
309   double value;
310
311   XBT_DEBUG
312       ("Before share resources, the size of modified actions set is %d",
313        xbt_swag_size(model->model_private->modified_set));
314
315   lmm_solve(model->model_private->maxmin_system);
316
317   XBT_DEBUG
318       ("After share resources, The size of modified actions set is %d",
319        xbt_swag_size(model->model_private->modified_set));
320
321   while((action = xbt_swag_extract(model->model_private->modified_set))) {
322     int max_dur_flag = 0;
323
324     if (action->generic_action.state_set !=
325         model->states.running_action_set)
326       continue;
327
328     /* bogus priority, skip it */
329     if (action->generic_action.priority <= 0)
330       continue;
331
332     generic_update_action_remaining_lazy(action,now);
333
334     min = -1;
335     value = lmm_variable_getvalue(action->variable);
336     if (value > 0) {
337       if (action->generic_action.remains > 0) {
338         value = action->generic_action.remains / value;
339         min = now + value;
340       } else {
341         value = 0.0;
342         min = now;
343       }
344     }
345
346     if ((action->generic_action.max_duration != NO_MAX_DURATION)
347         && (min == -1
348             || action->generic_action.start +
349             action->generic_action.max_duration < min)) {
350       min = action->generic_action.start +
351           action->generic_action.max_duration;
352       max_dur_flag = 1;
353     }
354
355     XBT_DEBUG("Action(%p) Start %lf Finish %lf Max_duration %lf", action,
356         action->generic_action.start, now + value,
357         action->generic_action.max_duration);
358
359     if (min != -1) {
360       surf_action_lmm_heap_remove(model->model_private->action_heap,action);
361       surf_action_lmm_heap_insert(model->model_private->action_heap,action, min, max_dur_flag ? MAX_DURATION : NORMAL);
362       XBT_DEBUG("Insert at heap action(%p) min %lf now %lf", action, min,
363                 now);
364     } else DIE_IMPOSSIBLE;
365   }
366
367   //hereafter must have already the min value for this resource model
368   if (xbt_heap_size(model->model_private->action_heap) > 0)
369     min = xbt_heap_maxkey(model->model_private->action_heap) - now;
370   else
371     min = -1;
372
373   XBT_DEBUG("The minimum with the HEAP %lf", min);
374
375   return min;
376 }
377 static XBT_INLINE void routing_asr_host_free(void *p)
378 {
379   sg_routing_edge_t elm = p;
380   free(elm->name);
381   xbt_free(elm);
382 }
383
384 static XBT_INLINE void routing_asr_prop_free(void *p)
385 {
386   xbt_dict_t elm = p;
387   xbt_dict_free(&elm);
388 }
389
390 void sg_version(int *ver_major,int *ver_minor,int *ver_patch) {
391   *ver_major = SIMGRID_VERSION_MAJOR;
392   *ver_minor = SIMGRID_VERSION_MINOR;
393   *ver_patch = SIMGRID_VERSION_PATCH;
394 }
395
396 void surf_init(int *argc, char **argv)
397 {
398   XBT_DEBUG("Create all Libs");
399   host_lib = xbt_lib_new();
400   link_lib = xbt_lib_new();
401   as_router_lib = xbt_lib_new();
402   storage_lib = xbt_lib_new();
403   storage_type_lib = xbt_lib_new();
404   watched_hosts_lib = xbt_dict_new();
405
406   XBT_DEBUG("Add routing levels");
407   ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,routing_asr_host_free);
408   ROUTING_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,routing_asr_host_free);
409   ROUTING_PROP_ASR_LEVEL = xbt_lib_add_level(as_router_lib,routing_asr_prop_free);
410
411   XBT_DEBUG("Add SURF levels");
412   SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
413   SURF_WKS_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
414   SURF_LINK_LEVEL = xbt_lib_add_level(link_lib,surf_resource_free);
415
416   xbt_init(argc, argv);
417   if (!model_list)
418     model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
419   if (!history)
420     history = tmgr_history_new();
421
422 #ifdef HAVE_TRACING
423   TRACE_add_start_function(TRACE_surf_alloc);
424   TRACE_add_end_function(TRACE_surf_release);
425 #endif
426
427   sg_config_init(argc, argv);
428
429   surf_action_init();
430   if (MC_is_active())
431     MC_memory_init();
432 }
433
434 #ifdef _XBT_WIN32
435 # define FILE_DELIM "\\"
436 #else
437 # define FILE_DELIM "/"         /* FIXME: move to better location */
438 #endif
439
440 FILE *surf_fopen(const char *name, const char *mode)
441 {
442   unsigned int cpt;
443   char *path_elm = NULL;
444   char *buff;
445   FILE *file = NULL;
446
447   xbt_assert(name);
448
449   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
450     return fopen(name, mode);
451
452   /* search relative files in the path */
453   xbt_dynar_foreach(surf_path, cpt, path_elm) {
454     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
455     file = fopen(buff, mode);
456     free(buff);
457
458     if (file)
459       return file;
460   }
461   return NULL;
462 }
463
464 void surf_exit(void)
465 {
466   unsigned int iter;
467   surf_model_t model = NULL;
468
469   sg_config_finalize();
470
471   xbt_dynar_foreach(model_list, iter, model)
472       model->model_private->finalize();
473   xbt_dynar_free(&model_list);
474   routing_exit();
475
476   if (maxmin_system) {
477     lmm_system_free(maxmin_system);
478     maxmin_system = NULL;
479   }
480   if (history) {
481     tmgr_history_free(history);
482     history = NULL;
483   }
484   surf_action_exit();
485
486 #ifdef CONTEXT_THREADS
487   xbt_parmap_destroy(surf_parmap);
488   xbt_free(surf_mins);
489   surf_mins = NULL;
490 #endif
491   xbt_dynar_free(&host_that_restart);
492   xbt_dynar_free(&surf_path);
493
494   xbt_lib_free(&host_lib);
495   xbt_lib_free(&link_lib);
496   xbt_lib_free(&as_router_lib);
497   xbt_lib_free(&storage_lib);
498   xbt_lib_free(&storage_type_lib);
499
500   xbt_dict_free(&watched_hosts_lib);
501
502   tmgr_finalize();
503   surf_parse_lex_destroy();
504   surf_parse_free_callbacks();
505
506   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
507 }
508
509 void surf_presolve(void)
510 {
511   double next_event_date = -1.0;
512   tmgr_trace_event_t event = NULL;
513   double value = -1.0;
514   surf_resource_t resource = NULL;
515   surf_model_t model = NULL;
516   unsigned int iter;
517
518   XBT_DEBUG
519       ("First Run! Let's \"purge\" events and put models in the right state");
520   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
521     if (next_event_date > NOW)
522       break;
523     while ((event =
524             tmgr_history_get_next_event_leq(history, next_event_date,
525                                             &value,
526                                             (void **) &resource))) {
527       if (value >= 0){
528         resource->model->model_private->update_resource_state(resource,
529                                                               event, value,
530                                                               NOW);
531       }
532     }
533   }
534   xbt_dynar_foreach(model_list, iter, model)
535       model->model_private->update_actions_state(NOW, 0.0);
536 }
537
538 double surf_solve(double max_date)
539 {
540   min = -1.0; /* duration */
541   double next_event_date = -1.0;
542   double model_next_action_end = -1.0;
543   double value = -1.0;
544   surf_resource_t resource = NULL;
545   surf_model_t model = NULL;
546   tmgr_trace_event_t event = NULL;
547   unsigned int iter;
548
549   if(!host_that_restart)
550     host_that_restart = xbt_dynar_new(sizeof(char*), NULL);
551
552   if (max_date != -1.0 && max_date != NOW) {
553     min = max_date - NOW;
554   }
555
556   XBT_DEBUG("Looking for next action end for all models except NS3");
557
558   if (surf_mins == NULL) {
559     surf_mins = xbt_new(double, xbt_dynar_length(model_list));
560   }
561   surf_min_index = 0;
562
563   /* sequential version */
564   xbt_dynar_foreach(model_list, iter, model) {
565     surf_share_resources(model);
566   }
567
568   unsigned i;
569   for (i = 0; i < xbt_dynar_length(model_list); i++) {
570     if ((min < 0.0 || surf_mins[i] < min)
571         && surf_mins[i] >= 0.0) {
572       min = surf_mins[i];
573     }
574   }
575
576   XBT_DEBUG("Min for resources (remember that NS3 don't update that value) : %f", min);
577
578   XBT_DEBUG("Looking for next trace event");
579
580   do {
581     XBT_DEBUG("Next TRACE event : %f", next_event_date);
582
583     next_event_date = tmgr_history_next_date(history);
584
585     if(surf_network_model->name && !strcmp(surf_network_model->name,"network NS3")){
586       if(next_event_date!=-1.0 && min!=-1.0) {
587         min = MIN(next_event_date - NOW, min);
588       } else{
589         min = MAX(next_event_date - NOW, min);
590       }
591
592       XBT_DEBUG("Run for network at most %f", min);
593       // run until min or next flow
594       model_next_action_end = surf_network_model->model_private->share_resources(min);
595
596       XBT_DEBUG("Min for network : %f", model_next_action_end);
597       if(model_next_action_end>=0.0)
598         min = model_next_action_end;
599     }
600
601     if (next_event_date < 0.0) {
602       XBT_DEBUG("no next TRACE event. Stop searching for it");
603       break;
604     }
605
606     if ((min == -1.0) || (next_event_date > NOW + min)) break;
607
608     XBT_DEBUG("Updating models (min = %g, NOW = %g, next_event_date = %g)",min, NOW, next_event_date);
609     while ((event =
610             tmgr_history_get_next_event_leq(history, next_event_date,
611                                             &value,
612                                             (void **) &resource))) {
613       if (resource->model->model_private->resource_used(resource) ||
614           xbt_dict_get_or_null(watched_hosts_lib,resource->name)
615           ) {
616         min = next_event_date - NOW;
617         XBT_DEBUG
618             ("This event will modify model state. Next event set to %f",
619              min);
620       }
621       /* update state of model_obj according to new value. Does not touch lmm.
622          It will be modified if needed when updating actions */
623       XBT_DEBUG("Calling update_resource_state for resource %s with min %lf",
624              resource->name, min);
625
626       resource->model->model_private->update_resource_state(resource,
627                                                             event, value,
628                                                             next_event_date);
629     }
630   } while (1);
631
632   /* FIXME: Moved this test to here to avoid stopping simulation if there are actions running on cpus and all cpus are with availability = 0.
633    * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
634    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
635   if (min == -1.0) {
636   XBT_DEBUG("No next event at all. Bail out now.");
637     return -1.0;
638   }
639
640   XBT_DEBUG("Duration set to %f", min);
641
642   NOW = NOW + min;
643
644   /* sequential version */
645   xbt_dynar_foreach(model_list, iter, model) {
646     surf_update_actions_state(model);
647   }
648
649 #ifdef HAVE_TRACING
650   TRACE_paje_dump_buffer (0);
651 #endif
652
653   return min;
654 }
655
656 XBT_INLINE double surf_get_clock(void)
657 {
658   return NOW;
659 }
660
661 static void surf_share_resources(surf_model_t model)
662 {
663   double next_action_end = -1.0;
664   int i = __sync_fetch_and_add(&surf_min_index, 1);
665   if (strcmp(model->name,"network NS3")) {
666     XBT_DEBUG("Running for Resource [%s]", model->name);
667     next_action_end = model->model_private->share_resources(NOW);
668     XBT_DEBUG("Resource [%s] : next action end = %f",
669         model->name, next_action_end);
670   }
671   surf_mins[i] = next_action_end;
672 }
673
674 static void surf_update_actions_state(surf_model_t model)
675 {
676   model->model_private->update_actions_state(NOW, min);
677 }
678