Logo AND Algorithmique Numérique Distribuée

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