Logo AND Algorithmique Numérique Distribuée

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