Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add condition before use a mmalloc function.
[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 _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 _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 _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 _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", "Simplistic network model where all communication take a constant time (one second)", NULL, surf_network_model_init_Constant},
116     {"Vivaldi", "Scalable network model using the Vivaldi coordinate ideas", NULL, surf_network_model_init_Vivaldi},
117   {"CM02", "Realistic network model with lmm_solve and no correction factors", NULL, surf_network_model_init_CM02},
118   {"LV08", "Realistic network model with lmm_solve and these correction factors: latency*=10.4, bandwidth*=.92, S=8775" , NULL, surf_network_model_init_LegrandVelho},
119   {"SMPI", "Realistic network model with lmm_solve and correction factors on three intervals (< 1KiB, < 64 KiB, >= 64 KiB)", NULL, surf_network_model_init_SMPI},
120 #ifdef HAVE_GTNETS
121   {"GTNets", "Network Pseudo-model using the GTNets simulator instead of an analytic model", NULL, surf_network_model_init_GTNETS},
122 #endif
123   {"Reno", "Model using lagrange_solve instead of lmm_solve (experts only)", NULL, surf_network_model_init_Reno},
124   {"Reno2", "Model using lagrange_solve instead of lmm_solve (experts only)", NULL, surf_network_model_init_Reno2},
125   {"Vegas", "Model using lagrange_solve instead of lmm_solve (experts only)", NULL, surf_network_model_init_Vegas},
126   {NULL, NULL, NULL, NULL}            /* this array must be NULL terminated */
127 };
128
129 s_surf_model_description_t surf_cpu_model_description[] = {
130   {"Cas01_fullupdate", "CPU classical model time=size/power", NULL, surf_cpu_model_init_Cas01},
131   {"Cas01", "Variation of Cas01_fullupdate with partial invalidation optimization of lmm system. Should produce the same values, only faster", NULL, surf_cpu_model_init_Cas01_im},
132   {"CpuTI", "Variation of Cas01 with also trace integration. Should produce the same values, only faster if you use availability traces", NULL, surf_cpu_model_init_ti},
133   {NULL, NULL, NULL, NULL}            /* this array must be NULL terminated */
134 };
135
136 s_surf_model_description_t surf_workstation_model_description[] = {
137   {"CLM03", "Default workstation model, using LV08 and CM02 as network and CPU", NULL, surf_workstation_model_init_CLM03, create_workstations},
138   {"compound", "Workstation model allowing you to use other network and CPU models", NULL, surf_workstation_model_init_compound, create_workstations},
139   {"ptask_L07", "Workstation model with better parallel task modeling", NULL, surf_workstation_model_init_ptask_L07, NULL},
140   {NULL, NULL, NULL, NULL}            /* this array must be NULL terminated */
141 };
142
143 void update_model_description(s_surf_model_description_t * table,
144                               const char *name, surf_model_t model)
145 {
146   int i = find_model_description(table, name);
147   table[i].model = model;
148 }
149
150 /** Displays the long description of all registered models, and quit */
151 void model_help(const char* category, s_surf_model_description_t * table) {
152   int i;
153   printf("Long description of the %s models accepted by this simulator:\n",category);
154   for (i = 0; table[i].name; i++)
155     printf("  %s: %s\n", table[i].name, table[i].description);
156 }
157
158 int find_model_description(s_surf_model_description_t * table,
159                            const char *name)
160 {
161   int i;
162   char *name_list = NULL;
163
164   for (i = 0; table[i].name; i++)
165     if (!strcmp(name, table[i].name)) {
166       return i;
167     }
168   name_list = strdup(table[0].name);
169   for (i = 1; table[i].name; i++) {
170     name_list =
171       xbt_realloc(name_list, strlen(name_list) + strlen(table[i].name) + 2);
172     strcat(name_list, ", ");
173     strcat(name_list, table[i].name);
174   }
175   xbt_assert2(0, "Model '%s' is invalid! Valid models are: %s.", name,
176               name_list);
177 }
178
179 double generic_maxmin_share_resources(xbt_swag_t running_actions,
180                                       size_t offset,
181                                       lmm_system_t sys,
182                                       void (*solve) (lmm_system_t))
183 {
184   surf_action_t action = NULL;
185   double min = -1;
186   double value = -1;
187 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
188
189   xbt_assert0(solve, "Give me a real solver function!");
190   solve(sys);
191
192   xbt_swag_foreach(action, running_actions) {
193     value = lmm_variable_getvalue(VARIABLE(action));
194     if ((value > 0) || (action->max_duration >= 0))
195       break;
196   }
197
198   if (!action)
199     return -1.0;
200
201   if (value > 0) {
202     if (action->remains > 0)
203       min = action->remains / value;
204     else
205       min = 0.0;
206     if ((action->max_duration >= 0) && (action->max_duration < min))
207       min = action->max_duration;
208   } else
209     min = action->max_duration;
210
211
212   for (action = xbt_swag_getNext(action, running_actions->offset);
213        action; action = xbt_swag_getNext(action, running_actions->offset)) {
214     value = lmm_variable_getvalue(VARIABLE(action));
215     if (value > 0) {
216       if (action->remains > 0)
217         value = action->remains / value;
218       else
219         value = 0.0;
220       if (value < min) {
221         min = value;
222         DEBUG2("Updating min (value) with %p: %f", action, min);
223       }
224     }
225     if ((action->max_duration >= 0) && (action->max_duration < min)) {
226       min = action->max_duration;
227       DEBUG2("Updating min (duration) with %p: %f", action, min);
228     }
229   }
230   DEBUG1("min value : %f", min);
231
232 #undef VARIABLE
233   return min;
234 }
235
236
237 XBT_LOG_EXTERNAL_CATEGORY(surf_cpu);
238 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
239 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange);
240 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange_dichotomy);
241 XBT_LOG_EXTERNAL_CATEGORY(surf_maxmin);
242 XBT_LOG_EXTERNAL_CATEGORY(surf_network);
243 XBT_LOG_EXTERNAL_CATEGORY(surf_trace);
244 XBT_LOG_EXTERNAL_CATEGORY(surf_parse);
245 XBT_LOG_EXTERNAL_CATEGORY(surf_timer);
246 XBT_LOG_EXTERNAL_CATEGORY(surf_workstation);
247 XBT_LOG_EXTERNAL_CATEGORY(surf_config);
248 XBT_LOG_EXTERNAL_CATEGORY(surf_routing);
249
250
251 #ifdef HAVE_GTNETS
252 XBT_LOG_EXTERNAL_CATEGORY(surf_network_gtnets);
253 #endif
254
255 void surf_init(int *argc, char **argv)
256
257   /* Connect our log channels: that must be done manually under windows */
258   XBT_LOG_CONNECT(surf_cpu, surf);
259   XBT_LOG_CONNECT(surf_kernel, surf);
260   XBT_LOG_CONNECT(surf_lagrange, surf);
261   XBT_LOG_CONNECT(surf_lagrange_dichotomy, surf_lagrange);
262   XBT_LOG_CONNECT(surf_maxmin, surf);
263   XBT_LOG_CONNECT(surf_network, surf);
264   XBT_LOG_CONNECT(surf_trace, surf);
265   XBT_LOG_CONNECT(surf_parse, surf);
266   XBT_LOG_CONNECT(surf_timer, surf);
267   XBT_LOG_CONNECT(surf_workstation, surf);
268   XBT_LOG_CONNECT(surf_config, surf);
269   XBT_LOG_CONNECT(surf_routing, surf);
270
271 #ifdef HAVE_GTNETS
272   XBT_LOG_CONNECT(surf_network_gtnets, surf);
273 #endif
274
275   xbt_init(argc, argv);
276   if (!model_list)
277     model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
278   if (!history)
279     history = tmgr_history_new();
280
281   surf_config_init(argc, argv);
282 #ifdef HAVE_MC
283   if (_surf_do_model_check)
284     MC_memory_init();
285 #endif
286 }
287
288 #ifdef WIN32
289 # define FILE_DELIM "\\"
290 #else
291 # define FILE_DELIM "/"         /* FIXME: move to better location */
292 #endif
293
294 FILE *surf_fopen(const char *name, const char *mode)
295 {
296   unsigned int cpt;
297   char *path_elm = NULL;
298   char *buff;
299   FILE *file = NULL;
300
301   xbt_assert(name);
302
303   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
304     return fopen(name, mode);
305
306   /* search relative files in the path */
307   xbt_dynar_foreach(surf_path, cpt, path_elm) {
308     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
309     file = fopen(buff, mode);
310     free(buff);
311
312     if (file)
313       return file;
314   }
315   return NULL;
316 }
317
318 void surf_exit(void)
319 {
320   unsigned int iter;
321   surf_model_t model = NULL;
322
323   surf_config_finalize();
324
325   xbt_dynar_foreach(model_list, iter, model)
326     model->model_private->finalize();
327   xbt_dynar_free(&model_list);
328
329   if (maxmin_system) {
330     lmm_system_free(maxmin_system);
331     maxmin_system = NULL;
332   }
333   if (history) {
334     tmgr_history_free(history);
335     history = NULL;
336   }
337
338   if (surf_path)
339     xbt_dynar_free(&surf_path);
340
341   tmgr_finalize();
342   surf_parse_lex_destroy();
343   surf_parse_free_callbacks();
344   xbt_dict_free(&route_table);
345   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
346 }
347
348 void surf_presolve(void)
349 {
350   double next_event_date = -1.0;
351   tmgr_trace_event_t event = NULL;
352   double value = -1.0;
353   surf_resource_t resource = NULL;
354   surf_model_t model = NULL;
355   unsigned int iter;
356
357   DEBUG0
358     ("First Run! Let's \"purge\" events and put models in the right state");
359   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
360     if (next_event_date > NOW)
361       break;
362     while ((event =
363             tmgr_history_get_next_event_leq(history, next_event_date,
364                                             &value, (void **) &resource))) {
365       resource->model->model_private->update_resource_state(resource,
366                                                             event, value,
367                                                             NOW);
368     }
369   }
370   xbt_dynar_foreach(model_list, iter, model)
371     model->model_private->update_actions_state(NOW, 0.0);
372 }
373
374 double surf_solve(void)
375 {
376   double min = -1.0;
377   double next_event_date = -1.0;
378   double model_next_action_end = -1.0;
379   double value = -1.0;
380   surf_resource_t resource = NULL;
381   surf_model_t model = NULL;
382   tmgr_trace_event_t event = NULL;
383   unsigned int iter;
384
385   min = -1.0;
386
387   DEBUG0("Looking for next action end");
388   xbt_dynar_foreach(model_list, iter, model) {
389     DEBUG1("Running for Resource [%s]", model->name);
390     model_next_action_end = model->model_private->share_resources(NOW);
391     DEBUG2("Resource [%s] : next action end = %f",
392            model->name, model_next_action_end);
393     if (((min < 0.0) || (model_next_action_end < min))
394         && (model_next_action_end >= 0.0))
395       min = model_next_action_end;
396   }
397   DEBUG1("Next action end : %f", min);
398
399   DEBUG0("Looking for next event");
400   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
401     DEBUG1("Next TRACE event : %f", next_event_date);
402     if ((min != -1.0) && (next_event_date > NOW + min))
403       break;
404     DEBUG0("Updating models");
405     while ((event =
406             tmgr_history_get_next_event_leq(history, next_event_date,
407                                             &value, (void **) &resource))) {
408       if (resource->model->model_private->resource_used(resource)) {
409         min = next_event_date - NOW;
410         DEBUG1
411           ("This event will modify model state. Next event set to %f", min);
412       }
413       /* update state of model_obj according to new value. Does not touch lmm.
414          It will be modified if needed when updating actions */
415       DEBUG2("Calling update_resource_state for resource %s with min %lf",
416              resource->model->name, min);
417       resource->model->model_private->update_resource_state(resource, event,
418                                                             value, NOW + min);
419     }
420   }
421
422   /* FIXME: Moved this test to here to avoid stoping simulation if there are actions running on cpus and all cpus are with availability = 0. 
423    * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
424    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
425   if (min < 0.0)
426     return -1.0;
427
428   DEBUG1("Duration set to %f", min);
429
430   NOW = NOW + min;
431
432   xbt_dynar_foreach(model_list, iter, model)
433     model->model_private->update_actions_state(NOW, min);
434
435   return min;
436 }
437
438 double surf_get_clock(void)
439 {
440   return NOW;
441 }