Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[NS3] only update min using the return of NS3's share resources if there are active...
[simgrid.git] / src / surf / surf.c
1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
14                                 "Logging specific to SURF (kernel)");
15
16 /* Additional declarations for Windows potability. */
17
18 #ifndef MAX_DRIVE
19 #define MAX_DRIVE 26
20 #endif
21
22 #ifdef _XBT_WIN32
23 #include <windows.h>
24 static const char *disk_drives_letter_table[MAX_DRIVE] = {
25   "A:\\",
26   "B:\\",
27   "C:\\",
28   "D:\\",
29   "E:\\",
30   "F:\\",
31   "G:\\",
32   "H:\\",
33   "I:\\",
34   "J:\\",
35   "K:\\",
36   "L:\\",
37   "M:\\",
38   "N:\\",
39   "O:\\",
40   "P:\\",
41   "Q:\\",
42   "R:\\",
43   "S:\\",
44   "T:\\",
45   "U:\\",
46   "V:\\",
47   "W:\\",
48   "X:\\",
49   "Y:\\",
50   "Z:\\"
51 };
52 #endif                          /* #ifdef _XBT_WIN32 */
53
54 /*
55  * Returns the initial path. On Windows the initial path is
56  * the current directory for the current process in the other
57  * case the function returns "./" that represents the current
58  * directory on Unix/Linux platforms.
59  */
60
61 const char *__surf_get_initial_path(void)
62 {
63
64 #ifdef _XBT_WIN32
65   unsigned i;
66   char current_directory[MAX_PATH + 1] = { 0 };
67   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
68   char root[4] = { 0 };
69
70   if (!len)
71     return NULL;
72
73   strncpy(root, current_directory, 3);
74
75   for (i = 0; i < MAX_DRIVE; i++) {
76     if (toupper(root[0]) == disk_drives_letter_table[i][0])
77       return disk_drives_letter_table[i];
78   }
79
80   return NULL;
81 #else
82   return "./";
83 #endif
84 }
85
86 /* The __surf_is_absolute_file_path() returns 1 if
87  * file_path is a absolute file path, in the other
88  * case the function returns 0.
89  */
90 int __surf_is_absolute_file_path(const char *file_path)
91 {
92 #ifdef _XBT_WIN32
93   WIN32_FIND_DATA wfd = { 0 };
94   HANDLE hFile = FindFirstFile(file_path, &wfd);
95
96   if (INVALID_HANDLE_VALUE == hFile)
97     return 0;
98
99   FindClose(hFile);
100   return 1;
101 #else
102   return (file_path[0] == '/');
103 #endif
104 }
105
106 double NOW = 0;
107
108 xbt_dynar_t model_list = NULL;
109 tmgr_history_t history = NULL;
110 lmm_system_t maxmin_system = NULL;
111 xbt_dynar_t surf_path = NULL;
112
113 /* Don't forget to update the option description in smx_config when you change this */
114 s_surf_model_description_t surf_network_model_description[] = {
115   {"Constant",
116    "Simplistic network model where all communication take a constant time (one second)",
117    NULL, surf_network_model_init_Constant},
118   {"CM02",
119    "Realistic network model with lmm_solve and no correction factors",
120    NULL, surf_network_model_init_CM02},
121   {"LV08",
122    "Realistic network model with lmm_solve and these correction factors: latency*=10.4, bandwidth*=.92, S=8775",
123    NULL, surf_network_model_init_LegrandVelho},
124    {"LV08_im",
125     "Realistic network model with IMPROVED ACTION MANAGEMENT and these correction factors: latency*=10.4, bandwidth*=.92, S=8775",
126     NULL, im_surf_network_model_init_LegrandVelho},
127   {"SMPI",
128    "Realistic network model with lmm_solve and correction factors on three intervals (< 1KiB, < 64 KiB, >= 64 KiB)",
129    NULL, surf_network_model_init_SMPI},
130 #ifdef HAVE_GTNETS
131   {"GTNets",
132    "Network Pseudo-model using the GTNets simulator instead of an analytic model",
133    NULL, surf_network_model_init_GTNETS},
134 #endif
135 #ifdef HAVE_NS3
136   {"NS3",
137    "Use NS3 tcp model",
138         NULL, surf_network_model_init_NS3},
139 #endif
140   {"Reno",
141    "Model using lagrange_solve instead of lmm_solve (experts only)", NULL,
142    surf_network_model_init_Reno},
143   {"Reno2",
144    "Model using lagrange_solve instead of lmm_solve (experts only)", NULL,
145    surf_network_model_init_Reno2},
146   {"Vegas",
147    "Model using lagrange_solve instead of lmm_solve (experts only)", NULL,
148    surf_network_model_init_Vegas},
149   {NULL, NULL, NULL, NULL}      /* this array must be NULL terminated */
150 };
151
152 s_surf_model_description_t surf_cpu_model_description[] = {
153   {"Cas01_fullupdate", "CPU classical model time=size/power", NULL,
154    surf_cpu_model_init_Cas01},
155   {"Cas01",
156    "Variation of Cas01_fullupdate with partial invalidation optimization of lmm system. Should produce the same values, only faster",
157    NULL, surf_cpu_model_init_Cas01_im},
158   {"CpuTI",
159    "Variation of Cas01 with also trace integration. Should produce the same values, only faster if you use availability traces",
160    NULL, surf_cpu_model_init_ti},
161   {NULL, NULL, NULL, NULL}      /* this array must be NULL terminated */
162 };
163
164 s_surf_model_description_t surf_workstation_model_description[] = {
165   {"CLM03",
166    "Default workstation model, using LV08 and CM02 as network and CPU",
167    NULL, surf_workstation_model_init_CLM03, create_workstations},
168   {"compound",
169    "Workstation model allowing you to use other network and CPU models",
170    NULL, surf_workstation_model_init_compound, create_workstations},
171   {"ptask_L07", "Workstation model with better parallel task modeling",
172    NULL, surf_workstation_model_init_ptask_L07, NULL},
173   {NULL, NULL, NULL, NULL}      /* this array must be NULL terminated */
174 };
175
176 void update_model_description(s_surf_model_description_t * table,
177                               const char *name, surf_model_t model)
178 {
179   int i = find_model_description(table, name);
180   table[i].model = model;
181 }
182
183 /** Displays the long description of all registered models, and quit */
184 void model_help(const char *category, s_surf_model_description_t * table)
185 {
186   int i;
187   printf("Long description of the %s models accepted by this simulator:\n",
188          category);
189   for (i = 0; table[i].name; i++)
190     printf("  %s: %s\n", table[i].name, table[i].description);
191 }
192
193 int find_model_description(s_surf_model_description_t * table,
194                            const char *name)
195 {
196   int i;
197   char *name_list = NULL;
198
199   for (i = 0; table[i].name; i++)
200     if (!strcmp(name, table[i].name)) {
201       return i;
202     }
203   name_list = strdup(table[0].name);
204   for (i = 1; table[i].name; i++) {
205     name_list =
206         xbt_realloc(name_list,
207                     strlen(name_list) + strlen(table[i].name) + 2);
208     strcat(name_list, ", ");
209     strcat(name_list, table[i].name);
210   }
211   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
212   return -1;
213 }
214
215 double generic_maxmin_share_resources(xbt_swag_t running_actions,
216                                       size_t offset,
217                                       lmm_system_t sys,
218                                       void (*solve) (lmm_system_t))
219 {
220   surf_action_t action = NULL;
221   double min = -1;
222   double value = -1;
223 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
224
225   xbt_assert(solve, "Give me a real solver function!");
226   solve(sys);
227
228   xbt_swag_foreach(action, running_actions) {
229     value = lmm_variable_getvalue(VARIABLE(action));
230     if ((value > 0) || (action->max_duration >= 0))
231       break;
232   }
233
234   if (!action)
235     return -1.0;
236
237   if (value > 0) {
238     if (action->remains > 0)
239       min = action->remains / value;
240     else
241       min = 0.0;
242     if ((action->max_duration >= 0) && (action->max_duration < min))
243       min = action->max_duration;
244   } else
245     min = action->max_duration;
246
247
248   for (action = xbt_swag_getNext(action, running_actions->offset);
249        action;
250        action = xbt_swag_getNext(action, running_actions->offset)) {
251     value = lmm_variable_getvalue(VARIABLE(action));
252     if (value > 0) {
253       if (action->remains > 0)
254         value = action->remains / value;
255       else
256         value = 0.0;
257       if (value < min) {
258         min = value;
259         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
260       }
261     }
262     if ((action->max_duration >= 0) && (action->max_duration < min)) {
263       min = action->max_duration;
264       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
265     }
266   }
267   XBT_DEBUG("min value : %f", min);
268
269 #undef VARIABLE
270   return min;
271 }
272
273 XBT_LOG_EXTERNAL_CATEGORY(surf_cpu);
274 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
275 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange);
276 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange_dichotomy);
277 XBT_LOG_EXTERNAL_CATEGORY(surf_maxmin);
278 XBT_LOG_EXTERNAL_CATEGORY(surf_network);
279 XBT_LOG_EXTERNAL_CATEGORY(surf_trace);
280 XBT_LOG_EXTERNAL_CATEGORY(surf_parse);
281 XBT_LOG_EXTERNAL_CATEGORY(surf_timer);
282 XBT_LOG_EXTERNAL_CATEGORY(surf_workstation);
283 XBT_LOG_EXTERNAL_CATEGORY(surf_config);
284 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
285
286 #ifdef HAVE_GTNETS
287 XBT_LOG_EXTERNAL_CATEGORY(surf_network_gtnets);
288 #endif
289
290 void surf_init(int *argc, char **argv)
291 {
292         XBT_DEBUG("Create all Libs");
293         host_lib = xbt_lib_new();
294         link_lib = xbt_lib_new();
295         as_router_lib = xbt_lib_new();
296
297         XBT_DEBUG("ADD ROUTING LEVEL");
298         ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_free);
299         ROUTING_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,xbt_free);
300
301         XBT_DEBUG("ADD SURF LEVELS");
302         SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
303         SURF_WKS_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
304         SURF_LINK_LEVEL = xbt_lib_add_level(link_lib,surf_resource_free);
305
306   /* Connect our log channels: that must be done manually under windows */
307   XBT_LOG_CONNECT(surf_cpu, surf);
308   XBT_LOG_CONNECT(surf_kernel, surf);
309   XBT_LOG_CONNECT(surf_lagrange, surf);
310   XBT_LOG_CONNECT(surf_lagrange_dichotomy, surf_lagrange);
311   XBT_LOG_CONNECT(surf_maxmin, surf);
312   XBT_LOG_CONNECT(surf_network, surf);
313   XBT_LOG_CONNECT(surf_trace, surf);
314   XBT_LOG_CONNECT(surf_parse, surf);
315   XBT_LOG_CONNECT(surf_timer, surf);
316   XBT_LOG_CONNECT(surf_workstation, surf);
317   XBT_LOG_CONNECT(surf_config, surf);
318   XBT_LOG_CONNECT(surf_route, surf);
319
320 #ifdef HAVE_GTNETS
321   XBT_LOG_CONNECT(surf_network_gtnets, surf);
322 #endif
323
324   xbt_init(argc, argv);
325   if (!model_list)
326     model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
327   if (!history)
328     history = tmgr_history_new();
329
330   surf_config_init(argc, argv);
331   surf_action_init();
332   if (MC_IS_ENABLED)
333     MC_memory_init();
334 }
335
336 #ifdef _XBT_WIN32
337 # define FILE_DELIM "\\"
338 #else
339 # define FILE_DELIM "/"         /* FIXME: move to better location */
340 #endif
341
342 FILE *surf_fopen(const char *name, const char *mode)
343 {
344   unsigned int cpt;
345   char *path_elm = NULL;
346   char *buff;
347   FILE *file = NULL;
348
349   xbt_assert(name);
350
351   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
352     return fopen(name, mode);
353
354   /* search relative files in the path */
355   xbt_dynar_foreach(surf_path, cpt, path_elm) {
356     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
357     file = fopen(buff, mode);
358     free(buff);
359
360     if (file)
361       return file;
362   }
363   return NULL;
364 }
365
366 void surf_exit(void)
367 {
368   unsigned int iter;
369   surf_model_t model = NULL;
370
371   surf_config_finalize();
372
373   xbt_dynar_foreach(model_list, iter, model)
374       model->model_private->finalize();
375   xbt_dynar_free(&model_list);
376
377   if (maxmin_system) {
378     lmm_system_free(maxmin_system);
379     maxmin_system = NULL;
380   }
381   if (history) {
382     tmgr_history_free(history);
383     history = NULL;
384   }
385   surf_action_exit();
386
387   if (surf_path)
388     xbt_dynar_free(&surf_path);
389
390   xbt_lib_free(&host_lib);
391   xbt_lib_free(&link_lib);
392   xbt_lib_free(&as_router_lib);
393
394   tmgr_finalize();
395   surf_parse_lex_destroy();
396   surf_parse_free_callbacks();
397
398   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
399 }
400
401 void surf_presolve(void)
402 {
403   double next_event_date = -1.0;
404   tmgr_trace_event_t event = NULL;
405   double value = -1.0;
406   surf_resource_t resource = NULL;
407   surf_model_t model = NULL;
408   unsigned int iter;
409
410   XBT_DEBUG
411       ("First Run! Let's \"purge\" events and put models in the right state");
412   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
413     if (next_event_date > NOW)
414       break;
415     while ((event =
416             tmgr_history_get_next_event_leq(history, next_event_date,
417                                             &value,
418                                             (void **) &resource))) {
419       resource->model->model_private->update_resource_state(resource,
420                                                             event, value,
421                                                             NOW);
422     }
423   }
424   xbt_dynar_foreach(model_list, iter, model)
425       model->model_private->update_actions_state(NOW, 0.0);
426 }
427
428 double surf_solve(double max_date)
429 {
430   double min = -1.0; /* duration */
431   double next_event_date = -1.0;
432   double model_next_action_end = -1.0;
433   double value = -1.0;
434   surf_resource_t resource = NULL;
435   surf_model_t model = NULL;
436   tmgr_trace_event_t event = NULL;
437   unsigned int iter;
438
439   if (max_date != -1.0 && max_date != NOW) {
440     min = max_date - NOW;
441   }
442
443   XBT_DEBUG("Looking for next action end for all models except NS3");
444   xbt_dynar_foreach(model_list, iter, model) {
445     if(strcmp(model->name,"network NS3") ){
446       XBT_DEBUG("Running for Resource [%s]", model->name);
447       model_next_action_end = model->model_private->share_resources(NOW);
448       XBT_DEBUG("Resource [%s] : next action end = %f",
449           model->name, model_next_action_end);
450       if (((min < 0.0) || (model_next_action_end < min))
451           && (model_next_action_end >= 0.0))
452         min = model_next_action_end;
453     }
454   }
455
456   XBT_DEBUG("Min for resources (except NS3) : %f", min);
457
458   XBT_DEBUG("Looking for next trace event");
459
460   do {
461     XBT_DEBUG("Next TRACE event : %f", next_event_date);
462
463     next_event_date = tmgr_history_next_date(history);
464
465     if(surf_network_model->name && !strcmp(surf_network_model->name,"network NS3")){
466       if(next_event_date!=-1.0 && min!=-1.0) {
467         min = MIN(next_event_date - NOW, min);
468       } else{
469         min = MAX(next_event_date - NOW, min);
470       }
471
472       XBT_DEBUG("Run for NS3 at most %f", min);
473       // run until min or next flow
474       model_next_action_end = surf_network_model->model_private->share_resources(min);
475
476       XBT_DEBUG("Min for NS3 : %f", model_next_action_end);
477       if(model_next_action_end>=0.0)
478         min = model_next_action_end;
479     }
480
481     if (next_event_date == -1.0) break;
482
483     if ((min != -1.0) && (next_event_date > NOW + min)) break;
484
485     XBT_DEBUG("Updating models");
486     while ((event =
487             tmgr_history_get_next_event_leq(history, next_event_date,
488                                             &value,
489                                             (void **) &resource))) {
490       if (resource->model->model_private->resource_used(resource)) {
491         min = next_event_date - NOW;
492         XBT_DEBUG
493             ("This event will modify model state. Next event set to %f",
494              min);
495       }
496       /* update state of model_obj according to new value. Does not touch lmm.
497          It will be modified if needed when updating actions */
498       XBT_DEBUG("Calling update_resource_state for resource %s with min %lf",
499              resource->model->name, min);
500       resource->model->model_private->update_resource_state(resource,
501                                                             event, value,
502                                                             NOW + min);
503     }
504   } while (1);
505
506   /* FIXME: Moved this test to here to avoid stoping simulation if there are actions running on cpus and all cpus are with availability = 0. 
507    * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
508    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
509   if (min < 0.0)
510     return -1.0;
511
512   XBT_DEBUG("Duration set to %f", min);
513
514   NOW = NOW + min;
515
516   xbt_dynar_foreach(model_list, iter, model)
517       model->model_private->update_actions_state(NOW, min);
518
519 #ifdef HAVE_TRACING
520   TRACE_paje_dump_buffer (0);
521 #endif
522
523   return min;
524 }
525
526 XBT_INLINE double surf_get_clock(void)
527 {
528   return NOW;
529 }