Logo AND Algorithmique Numérique Distribuée

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