Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Reset the clock to 0 in surf_exit so that it gets zeroed in MSG_clean for people...
[simgrid.git] / src / surf / surf.c
1 /*      $Id$     */
2
3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #include <ctype.h>
9
10 #include "surf_private.h"
11 #include "xbt/module.h"
12
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
14                                 "Logging specific to SURF (kernel)");
15
16 int use_sdp_solver = 0;
17 int use_lagrange_solver = 0;
18
19 /* Additional declarations for Windows potability. */
20
21 #ifndef MAX_DRIVE
22 #define MAX_DRIVE 26
23 #endif
24
25 #ifdef _WIN32
26 #include <windows.h>
27 static const char *disk_drives_letter_table[MAX_DRIVE] = {
28   "A:\\",
29   "B:\\",
30   "C:\\",
31   "D:\\",
32   "E:\\",
33   "F:\\",
34   "G:\\",
35   "H:\\",
36   "I:\\",
37   "J:\\",
38   "K:\\",
39   "L:\\",
40   "M:\\",
41   "N:\\",
42   "O:\\",
43   "P:\\",
44   "Q:\\",
45   "R:\\",
46   "S:\\",
47   "T:\\",
48   "U:\\",
49   "V:\\",
50   "W:\\",
51   "X:\\",
52   "Y:\\",
53   "Z:\\"
54 };
55 #endif                          /* #ifdef _WIN32 */
56
57 /*
58  * Returns the initial path. On Windows the initial path is
59  * the current directory for the current process in the other
60  * case the function returns "./" that represents the current
61  * directory on Unix/Linux platforms.
62  */
63
64 const char *__surf_get_initial_path(void)
65 {
66
67 #ifdef _WIN32
68   unsigned i;
69   char current_directory[MAX_PATH + 1] = { 0 };
70   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
71   char root[4] = { 0 };
72
73   if (!len)
74     return NULL;
75
76   strncpy(root, current_directory, 3);
77
78   for (i = 0; i < MAX_DRIVE; i++) {
79     if (toupper(root[0]) == disk_drives_letter_table[i][0])
80       return disk_drives_letter_table[i];
81   }
82
83   return NULL;
84 #else
85   return "./";
86 #endif
87 }
88
89 /* The __surf_is_absolute_file_path() returns 1 if
90  * file_path is a absolute file path, in the other
91  * case the function returns 0.
92  */
93 int __surf_is_absolute_file_path(const char *file_path)
94 {
95 #ifdef _WIN32
96   WIN32_FIND_DATA wfd = { 0 };
97   HANDLE hFile = FindFirstFile(file_path, &wfd);
98
99   if (INVALID_HANDLE_VALUE == hFile)
100     return 0;
101
102   FindClose(hFile);
103   return 1;
104 #else
105   return (file_path[0] == '/');
106 #endif
107 }
108
109 typedef struct surf_model_object {
110   surf_model_t model;
111 } s_surf_model_object_t, *surf_model_object_t;
112
113 static double NOW = 0;
114
115 xbt_dynar_t model_list = NULL;
116 tmgr_history_t history = NULL;
117 lmm_system_t maxmin_system = NULL;
118 xbt_dynar_t surf_path = NULL;
119 const char *surf_action_state_names[6] = {
120   "SURF_ACTION_READY",
121   "SURF_ACTION_RUNNING",
122   "SURF_ACTION_FAILED",
123   "SURF_ACTION_DONE",
124   "SURF_ACTION_TO_FREE",
125   "SURF_ACTION_NOT_IN_THE_SYSTEM"
126 };
127
128 int surf_network_model_description_size = 3
129 #ifdef HAVE_GTNETS
130     + 1
131 #endif
132 #ifdef HAVE_SDP
133     + 1
134 #endif
135     ;
136 s_surf_model_description_t surf_network_model_description[] = {
137   {"CM02", NULL, surf_network_model_init_CM02},
138 #ifdef HAVE_GTNETS
139   {"GTNets", NULL, surf_network_model_init_GTNETS},
140 #endif
141 #ifdef HAVE_SDP
142   {"SDP", NULL, surf_network_model_init_SDP},
143 #endif
144   {"Reno", NULL, surf_network_model_init_Reno},
145   {"Vegas", NULL, surf_network_model_init_Vegas}
146 };
147
148 int surf_cpu_model_description_size = 1;
149 s_surf_model_description_t surf_cpu_model_description[] = {
150   {"Cas01", NULL, surf_cpu_model_init_Cas01},
151 };
152
153 int surf_workstation_model_description_size = 4;
154 s_surf_model_description_t surf_workstation_model_description[] = {
155   {"CLM03", NULL, surf_workstation_model_init_CLM03},
156   {"KCCFLN05", NULL, surf_workstation_model_init_KCCFLN05},
157   {"compound", NULL, surf_workstation_model_init_compound},
158   {"ptask_L07", NULL, surf_workstation_model_init_ptask_L07}
159 };
160
161 void update_model_description(s_surf_model_description_t * table,
162                                  int table_size,
163                                  const char *name,
164                                  surf_model_t model)
165 {
166   int i = find_model_description(table, table_size, name);
167   table[i].model = model;
168 }
169
170 int find_model_description(s_surf_model_description_t * table,
171                               int table_size, const char *name)
172 {
173   int i;
174   char *name_list = NULL;
175
176   for (i = 0; i < table_size; i++)
177     if (!strcmp(name, table[i].name)) {
178       return i;
179     }
180   name_list = strdup(table[0].name);
181   for (i = 1; i < table_size; i++) {
182     name_list =
183         xbt_realloc(name_list,
184                     strlen(name_list) + strlen(table[i].name) + 2);
185     strcat(name_list, ", ");
186     strcat(name_list, table[i].name);
187   }
188   xbt_assert2(0, "Model '%s' is invalid! Valid models are: %s.", name,
189               name_list);
190 }
191
192 double generic_maxmin_share_resources(xbt_swag_t running_actions,
193                                       size_t offset,
194                                       lmm_system_t sys,
195                                       void (*solve) (lmm_system_t))
196 {
197   surf_action_t action = NULL;
198   double min = -1;
199   double value = -1;
200 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
201
202   xbt_assert0(solve, "Give me a real solver function!");
203   solve(sys);
204
205   xbt_swag_foreach(action, running_actions) {
206     value = lmm_variable_getvalue(VARIABLE(action));
207     if ((value > 0) || (action->max_duration >= 0))
208       break;
209   }
210
211   if (!action)
212     return -1.0;
213
214   if (value > 0) {
215     if(action->remains>0) 
216       min = action->remains / value;
217     else 
218       min = 0.0;
219     if ((action->max_duration >= 0) && (action->max_duration < min))
220       min = action->max_duration;
221   } else
222     min = action->max_duration;
223
224   DEBUG5("Found action (%p: duration = %f, remains = %f, value = %f) ! %f",
225          action, action->max_duration, action->remains, value, min);
226
227   for (action = xbt_swag_getNext(action, running_actions->offset);
228        action;
229        action = xbt_swag_getNext(action, running_actions->offset)) {
230     value = lmm_variable_getvalue(VARIABLE(action));
231     if (value > 0) {
232       if(action->remains>0) 
233         value = action->remains / value;
234       else 
235         value = 0.0;
236       if (value < min) {
237         min = value;
238         DEBUG2("Updating min (value) with %p: %f", action, min);
239       }
240     }
241     if ((action->max_duration >= 0) && (action->max_duration < min)) {
242       min = action->max_duration;
243       DEBUG2("Updating min (duration) with %p: %f", action, min);
244     }
245   }
246   DEBUG1("min value : %f", min);
247
248 #undef VARIABLE
249   return min;
250 }
251
252 e_surf_action_state_t surf_action_get_state(surf_action_t action)
253 {
254   surf_action_state_t action_state =
255       &(action->model_type->common_public->states);
256
257   if (action->state_set == action_state->ready_action_set)
258     return SURF_ACTION_READY;
259   if (action->state_set == action_state->running_action_set)
260     return SURF_ACTION_RUNNING;
261   if (action->state_set == action_state->failed_action_set)
262     return SURF_ACTION_FAILED;
263   if (action->state_set == action_state->done_action_set)
264     return SURF_ACTION_DONE;
265   return SURF_ACTION_NOT_IN_THE_SYSTEM;
266 }
267
268 double surf_action_get_start_time(surf_action_t action)
269 {
270   return action->start;
271 }
272
273 double surf_action_get_finish_time(surf_action_t action)
274 {
275   return action->finish;
276 }
277
278 void surf_action_free(surf_action_t * action)
279 {
280   (*action)->model_type->common_public->action_cancel(*action);
281   free(*action);
282   *action = NULL;
283 }
284
285 void surf_action_change_state(surf_action_t action,
286                               e_surf_action_state_t state)
287 {
288   surf_action_state_t action_state =
289       &(action->model_type->common_public->states);
290   XBT_IN2("(%p,%s)", action, surf_action_state_names[state]);
291   xbt_swag_remove(action, action->state_set);
292
293   if (state == SURF_ACTION_READY)
294     action->state_set = action_state->ready_action_set;
295   else if (state == SURF_ACTION_RUNNING)
296     action->state_set = action_state->running_action_set;
297   else if (state == SURF_ACTION_FAILED)
298     action->state_set = action_state->failed_action_set;
299   else if (state == SURF_ACTION_DONE)
300     action->state_set = action_state->done_action_set;
301   else
302     action->state_set = NULL;
303
304   if (action->state_set)
305     xbt_swag_insert(action, action->state_set);
306   XBT_OUT;
307 }
308
309 void surf_action_set_data(surf_action_t action, void *data)
310 {
311   action->data = data;
312 }
313
314 void surf_init(int *argc, char **argv)
315 {
316   int i, j;
317   char *opt;
318
319   const char *initial_path;
320
321   xbt_init(argc, argv);
322   if (!surf_path) {
323
324     /* retrieves the current directory of the current process */
325     initial_path = __surf_get_initial_path();
326
327     xbt_assert0((initial_path),
328                 "__surf_get_initial_path() failed! Can't resolves current Windows directory");
329
330     surf_path = xbt_dynar_new(sizeof(char *), NULL);
331     xbt_dynar_push(surf_path, &initial_path);
332
333     for (i = 1; i < *argc; i++) {
334       if (!strncmp(argv[i], "--surf-path=", strlen("--surf-path="))) {
335         opt = strchr(argv[i], '=');
336         opt++;
337         xbt_dynar_push(surf_path, &opt);
338         /*remove this from argv */
339         for (j = i + 1; j < *argc; j++) {
340           argv[j - 1] = argv[j];
341         }
342         argv[j - 1] = NULL;
343         (*argc)--;
344         i--;                    /* compensate effect of next loop incrementation */
345       }
346     }
347   }
348   if (!model_list)
349     model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
350   if (!history)
351     history = tmgr_history_new();
352 }
353
354 static char *path_name = NULL;
355 FILE *surf_fopen(const char *name, const char *mode)
356 {
357   int i;
358   char *path = NULL;
359   FILE *file = NULL;
360   unsigned int path_name_len = 0;       /* don't count '\0' */
361
362   xbt_assert0(name, "Need a non-NULL file name");
363
364   xbt_assert0(surf_path,
365               "surf_init has to be called before using surf_fopen");
366
367   if (__surf_is_absolute_file_path(name)) {     /* don't mess with absolute file names */
368     return fopen(name, mode);
369
370   } else {                      /* search relative files in the path */
371
372     if (!path_name) {
373       path_name_len = strlen(name);
374       path_name = xbt_new0(char, path_name_len + 1);
375     }
376
377     xbt_dynar_foreach(surf_path, i, path) {
378       if (path_name_len < strlen(path) + strlen(name) + 1) {
379         path_name_len = strlen(path) + strlen(name) + 1;        /* plus '/' */
380         path_name = xbt_realloc(path_name, path_name_len + 1);
381       }
382       sprintf(path_name, "%s/%s", path, name);
383       file = fopen(path_name, mode);
384       if (file)
385         return file;
386     }
387   }
388   return file;
389 }
390
391 void surf_exit(void)
392 {
393   int i;
394   surf_model_t model = NULL;
395
396   xbt_dynar_foreach(model_list, i, model) {
397     model->common_private->finalize();
398   }
399
400   if (maxmin_system) {
401     lmm_system_free(maxmin_system);
402     maxmin_system = NULL;
403   }
404   if (history) {
405     tmgr_history_free(history);
406     history = NULL;
407   }
408   if (model_list)
409     xbt_dynar_free(&model_list);
410
411   if (surf_path)
412     xbt_dynar_free(&surf_path);
413
414   tmgr_finalize();
415   surf_parse_lex_destroy();
416   if (path_name) {
417     free(path_name);
418     path_name = NULL;
419   }
420   NOW=0; /* Just in case the user plans to restart the simulation afterward */
421   xbt_exit();
422 }
423
424 double surf_solve(void)
425 {
426   static int first_run = 1;
427
428   double min = -1.0;
429   double next_event_date = -1.0;
430   double model_next_action_end = -1.0;
431   double value = -1.0;
432   surf_model_object_t model_obj = NULL;
433   surf_model_t model = NULL;
434   tmgr_trace_event_t event = NULL;
435   int i;
436
437   if (first_run) {
438     DEBUG0
439         ("First Run! Let's \"purge\" events and put models in the right state");
440     while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
441       if (next_event_date > NOW)
442         break;
443       while ((event =
444               tmgr_history_get_next_event_leq(history, next_event_date,
445                                               &value,
446                                               (void **) &model_obj))) {
447         model_obj->model->common_private->
448             update_resource_state(model_obj, event, value);
449       }
450     }
451     xbt_dynar_foreach(model_list, i, model) {
452       model->common_private->update_actions_state(NOW, 0.0);
453     }
454     first_run = 0;
455     return 0.0;
456   }
457
458   min = -1.0;
459
460   DEBUG0("Looking for next action end");
461   xbt_dynar_foreach(model_list, i, model) {
462     DEBUG1("Running for Resource [%s]", model->common_public->name);
463     model_next_action_end =
464         model->common_private->share_resources(NOW);
465     DEBUG2("Resource [%s] : next action end = %f",
466            model->common_public->name, model_next_action_end);
467     if (((min < 0.0) || (model_next_action_end < min))
468         && (model_next_action_end >= 0.0))
469       min = model_next_action_end;
470   }
471   DEBUG1("Next action end : %f", min);
472
473   if (min < 0.0)
474     return -1.0;
475
476   DEBUG0("Looking for next event");
477   while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
478     DEBUG1("Next event : %f", next_event_date);
479     if (next_event_date > NOW + min)
480       break;
481     DEBUG0("Updating models");
482     while ((event =
483             tmgr_history_get_next_event_leq(history, next_event_date,
484                                             &value,
485                                             (void **) &model_obj))) {
486       if (model_obj->model->common_private->
487           resource_used(model_obj)) {
488         min = next_event_date - NOW;
489         DEBUG1
490             ("This event will modify model state. Next event set to %f",
491              min);
492       }
493       /* update state of model_obj according to new value. Does not touch lmm.
494          It will be modified if needed when updating actions */
495       model_obj->model->common_private->
496           update_resource_state(model_obj, event, value);
497     }
498   }
499
500   DEBUG1("Duration set to %f", min);
501
502   NOW = NOW + min;
503
504   xbt_dynar_foreach(model_list, i, model) {
505     model->common_private->update_actions_state(NOW, min);
506   }
507
508   return min;
509 }
510
511 double surf_get_clock(void)
512 {
513   return NOW;
514 }