Logo AND Algorithmique Numérique Distribuée

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