Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
2f90fa918c4b6526901d00815310ef07b26e9b04
[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 potability. */
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   {"Constant",
117    "Simplistic network model where all communication take a constant time (one second)",
118    surf_network_model_init_Constant},
119   {"CM02",
120    "Realistic network model with lmm_solve and no correction factors",
121    surf_network_model_init_CM02},
122   {"LV08",
123    "Realistic network model with lmm_solve, adequate correction factors (latency*=10.4, bandwidth*=.92, S=8775) and partial invalidation optimization",
124    im_surf_network_model_init_LegrandVelho},
125    {"LV08_fullupdate",
126     "Realistic network model wit lmm_solve, adequate correction factors (latency*=10.4, bandwidth*=.92, S=8775) but no further optimization. Should produce the same results as LV08, only slower.",
127     surf_network_model_init_LegrandVelho},
128   {"SMPI",
129    "Realistic network model with lmm_solve and correction factors on three intervals (< 1KiB, < 64 KiB, >= 64 KiB)",
130    surf_network_model_init_SMPI},
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    "Use NS3 tcp model",
139         surf_network_model_init_NS3},
140 #endif
141   {"Reno",
142    "Model using lagrange_solve instead of lmm_solve (experts only)",
143    surf_network_model_init_Reno},
144   {"Reno2",
145    "Model using lagrange_solve instead of lmm_solve (experts only)",
146    surf_network_model_init_Reno2},
147   {"Vegas",
148    "Model using lagrange_solve instead of lmm_solve (experts only)",
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_fullupdate", "CPU classical model time=size/power",
155    surf_cpu_model_init_Cas01},
156   {"Cas01",
157    "Variation of Cas01_fullupdate with partial invalidation optimization of lmm system. Should produce the same values, only faster",
158    surf_cpu_model_init_Cas01_im},
159   {"CpuTI",
160    "Variation of Cas01 with also trace integration. Should produce the same values, only faster if you use availability traces",
161    surf_cpu_model_init_ti},
162   {NULL, NULL,  NULL}      /* this array must be NULL terminated */
163 };
164
165 s_surf_model_description_t surf_workstation_model_description[] = {
166   {"CLM03",
167    "Default workstation model, using LV08 and CM02 as network and CPU",
168    surf_workstation_model_init_CLM03},
169   {"compound",
170    "Workstation model allowing you to use other network and CPU models",
171    surf_workstation_model_init_compound},
172   {"ptask_L07", "Workstation model with better parallel task modeling",
173    surf_workstation_model_init_ptask_L07},
174   {NULL, NULL, NULL}      /* this array must be NULL terminated */
175 };
176
177 /** Displays the long description of all registered models, and quit */
178 void model_help(const char *category, s_surf_model_description_t * table)
179 {
180   int i;
181   printf("Long description of the %s models accepted by this simulator:\n",
182          category);
183   for (i = 0; table[i].name; i++)
184     printf("  %s: %s\n", table[i].name, table[i].description);
185 }
186
187 int find_model_description(s_surf_model_description_t * table,
188                            const char *name)
189 {
190   int i;
191   char *name_list = NULL;
192
193   for (i = 0; table[i].name; i++)
194     if (!strcmp(name, table[i].name)) {
195       return i;
196     }
197   name_list = strdup(table[0].name);
198   for (i = 1; table[i].name; i++) {
199     name_list =
200         xbt_realloc(name_list,
201                     strlen(name_list) + strlen(table[i].name) + 2);
202     strcat(name_list, ", ");
203     strcat(name_list, table[i].name);
204   }
205   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
206   return -1;
207 }
208
209 double generic_maxmin_share_resources(xbt_swag_t running_actions,
210                                       size_t offset,
211                                       lmm_system_t sys,
212                                       void (*solve) (lmm_system_t))
213 {
214   surf_action_t action = NULL;
215   double min = -1;
216   double value = -1;
217 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
218
219   solve(sys);
220
221   xbt_swag_foreach(action, running_actions) {
222     value = lmm_variable_getvalue(VARIABLE(action));
223     if ((value > 0) || (action->max_duration >= 0))
224       break;
225   }
226
227   if (!action)
228     return -1.0;
229
230   if (value > 0) {
231     if (action->remains > 0)
232       min = action->remains / value;
233     else
234       min = 0.0;
235     if ((action->max_duration >= 0) && (action->max_duration < min))
236       min = action->max_duration;
237   } else
238     min = action->max_duration;
239
240
241   for (action = xbt_swag_getNext(action, running_actions->offset);
242        action;
243        action = xbt_swag_getNext(action, running_actions->offset)) {
244     value = lmm_variable_getvalue(VARIABLE(action));
245     if (value > 0) {
246       if (action->remains > 0)
247         value = action->remains / value;
248       else
249         value = 0.0;
250       if (value < min) {
251         min = value;
252         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
253       }
254     }
255     if ((action->max_duration >= 0) && (action->max_duration < min)) {
256       min = action->max_duration;
257       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
258     }
259   }
260   XBT_DEBUG("min value : %f", min);
261
262 #undef VARIABLE
263   return min;
264 }
265
266 XBT_LOG_EXTERNAL_CATEGORY(surf_cpu);
267 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
268 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange);
269 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange_dichotomy);
270 XBT_LOG_EXTERNAL_CATEGORY(surf_maxmin);
271 XBT_LOG_EXTERNAL_CATEGORY(surf_network);
272 XBT_LOG_EXTERNAL_CATEGORY(surf_trace);
273 XBT_LOG_EXTERNAL_CATEGORY(surf_parse);
274 XBT_LOG_EXTERNAL_CATEGORY(surf_timer);
275 XBT_LOG_EXTERNAL_CATEGORY(surf_workstation);
276 XBT_LOG_EXTERNAL_CATEGORY(surf_config);
277 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
278
279 #ifdef HAVE_GTNETS
280 XBT_LOG_EXTERNAL_CATEGORY(surf_network_gtnets);
281 #endif
282
283 void surf_init(int *argc, char **argv)
284 {
285         XBT_DEBUG("Create all Libs");
286         host_lib = xbt_lib_new();
287         link_lib = xbt_lib_new();
288         as_router_lib = xbt_lib_new();
289
290         XBT_DEBUG("ADD ROUTING LEVEL");
291         ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_free);
292         ROUTING_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,xbt_free);
293
294         XBT_DEBUG("ADD SURF LEVELS");
295         SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
296         SURF_WKS_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
297         SURF_LINK_LEVEL = xbt_lib_add_level(link_lib,surf_resource_free);
298
299   /* Connect our log channels: that must be done manually under windows */
300   XBT_LOG_CONNECT(surf_cpu, surf);
301   XBT_LOG_CONNECT(surf_kernel, surf);
302   XBT_LOG_CONNECT(surf_lagrange, surf);
303   XBT_LOG_CONNECT(surf_lagrange_dichotomy, surf_lagrange);
304   XBT_LOG_CONNECT(surf_maxmin, surf);
305   XBT_LOG_CONNECT(surf_network, surf);
306   XBT_LOG_CONNECT(surf_trace, surf);
307   XBT_LOG_CONNECT(surf_parse, surf);
308   XBT_LOG_CONNECT(surf_timer, surf);
309   XBT_LOG_CONNECT(surf_workstation, surf);
310   XBT_LOG_CONNECT(surf_config, surf);
311   XBT_LOG_CONNECT(surf_route, surf);
312
313 #ifdef HAVE_GTNETS
314   XBT_LOG_CONNECT(surf_network_gtnets, surf);
315 #endif
316
317   xbt_init(argc, argv);
318   if (!model_list)
319     model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
320   if (!history)
321     history = tmgr_history_new();
322
323   surf_config_init(argc, argv);
324   surf_action_init();
325   if (MC_IS_ENABLED)
326     MC_memory_init();
327 }
328
329 #ifdef _XBT_WIN32
330 # define FILE_DELIM "\\"
331 #else
332 # define FILE_DELIM "/"         /* FIXME: move to better location */
333 #endif
334
335 FILE *surf_fopen(const char *name, const char *mode)
336 {
337   unsigned int cpt;
338   char *path_elm = NULL;
339   char *buff;
340   FILE *file = NULL;
341
342   xbt_assert(name);
343
344   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
345     return fopen(name, mode);
346
347   /* search relative files in the path */
348   xbt_dynar_foreach(surf_path, cpt, path_elm) {
349     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
350     file = fopen(buff, mode);
351     free(buff);
352
353     if (file)
354       return file;
355   }
356   return NULL;
357 }
358
359 void surf_exit(void)
360 {
361   unsigned int iter;
362   surf_model_t model = NULL;
363
364   surf_config_finalize();
365
366   xbt_dynar_foreach(model_list, iter, model)
367       model->model_private->finalize();
368   xbt_dynar_free(&model_list);
369   routing_exit();
370
371   if (maxmin_system) {
372     lmm_system_free(maxmin_system);
373     maxmin_system = NULL;
374   }
375   if (history) {
376     tmgr_history_free(history);
377     history = NULL;
378   }
379   surf_action_exit();
380
381   xbt_dynar_free(&surf_path);
382
383   xbt_lib_free(&host_lib);
384   xbt_lib_free(&link_lib);
385   xbt_lib_free(&as_router_lib);
386
387
388   tmgr_finalize();
389   surf_parse_lex_destroy();
390   surf_parse_free_callbacks();
391
392   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
393 }
394
395 void surf_presolve(void)
396 {
397   double next_event_date = -1.0;
398   tmgr_trace_event_t event = NULL;
399   double value = -1.0;
400   surf_resource_t resource = NULL;
401   surf_model_t model = NULL;
402   unsigned int iter;
403
404   XBT_DEBUG
405       ("First Run! Let's \"purge\" events and put models in the right state");
406   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
407     if (next_event_date > NOW)
408       break;
409     while ((event =
410             tmgr_history_get_next_event_leq(history, next_event_date,
411                                             &value,
412                                             (void **) &resource))) {
413       resource->model->model_private->update_resource_state(resource,
414                                                             event, value,
415                                                             NOW);
416     }
417   }
418   xbt_dynar_foreach(model_list, iter, model)
419       model->model_private->update_actions_state(NOW, 0.0);
420 }
421
422 double surf_solve(double max_date)
423 {
424   double min = -1.0; /* duration */
425   double next_event_date = -1.0;
426   double model_next_action_end = -1.0;
427   double value = -1.0;
428   surf_resource_t resource = NULL;
429   surf_model_t model = NULL;
430   tmgr_trace_event_t event = NULL;
431   unsigned int iter;
432
433   if (max_date != -1.0 && max_date != NOW) {
434     min = max_date - NOW;
435   }
436
437   XBT_DEBUG("Looking for next action end for all models except NS3");
438   xbt_dynar_foreach(model_list, iter, model) {
439     if(strcmp(model->name,"network NS3") ){
440       XBT_DEBUG("Running for Resource [%s]", model->name);
441       model_next_action_end = model->model_private->share_resources(NOW);
442       XBT_DEBUG("Resource [%s] : next action end = %f",
443           model->name, model_next_action_end);
444       if (((min < 0.0) || (model_next_action_end < min))
445           && (model_next_action_end >= 0.0))
446         min = model_next_action_end;
447     }
448   }
449
450   XBT_DEBUG("Min for resources (except NS3) : %f", min);
451
452   XBT_DEBUG("Looking for next trace event");
453
454   do {
455     XBT_DEBUG("Next TRACE event : %f", next_event_date);
456
457     next_event_date = tmgr_history_next_date(history);
458
459     if(surf_network_model->name && !strcmp(surf_network_model->name,"network NS3")){
460       if(next_event_date!=-1.0 && min!=-1.0) {
461         min = MIN(next_event_date - NOW, min);
462       } else{
463         min = MAX(next_event_date - NOW, min);
464       }
465
466       XBT_DEBUG("Run for NS3 at most %f", min);
467       // run until min or next flow
468       model_next_action_end = surf_network_model->model_private->share_resources(min);
469
470       XBT_DEBUG("Min for NS3 : %f", model_next_action_end);
471       if(model_next_action_end>=0.0)
472         min = model_next_action_end;
473     }
474
475     if (next_event_date == -1.0) break;
476
477     if ((min != -1.0) && (next_event_date > NOW + min)) break;
478
479     XBT_DEBUG("Updating models");
480     while ((event =
481             tmgr_history_get_next_event_leq(history, next_event_date,
482                                             &value,
483                                             (void **) &resource))) {
484       if (resource->model->model_private->resource_used(resource)) {
485         min = next_event_date - NOW;
486         XBT_DEBUG
487             ("This event will modify model state. Next event set to %f",
488              min);
489       }
490       /* update state of model_obj according to new value. Does not touch lmm.
491          It will be modified if needed when updating actions */
492       XBT_DEBUG("Calling update_resource_state for resource %s with min %lf",
493              resource->model->name, min);
494       resource->model->model_private->update_resource_state(resource,
495                                                             event, value,
496                                                             NOW + min);
497     }
498   } while (1);
499
500   /* FIXME: Moved this test to here to avoid stoping simulation if there are actions running on cpus and all cpus are with availability = 0. 
501    * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
502    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
503   if (min < 0.0)
504     return -1.0;
505
506   XBT_DEBUG("Duration set to %f", min);
507
508   NOW = NOW + min;
509
510   xbt_dynar_foreach(model_list, iter, model)
511       model->model_private->update_actions_state(NOW, min);
512
513 #ifdef HAVE_TRACING
514   TRACE_paje_dump_buffer (0);
515 #endif
516
517   return min;
518 }
519
520 XBT_INLINE double surf_get_clock(void)
521 {
522   return NOW;
523 }