Logo AND Algorithmique Numérique Distribuée

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