1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011. The SimGrid Team.
2 * All rights reserved. */
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. */
9 #include "surf_private.h"
10 #include "xbt/module.h"
12 #include "surf/surf_resource.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
15 "Logging specific to SURF (kernel)");
17 /* Additional declarations for Windows portability. */
25 static const char *disk_drives_letter_table[MAX_DRIVE] = {
53 #endif /* #ifdef _XBT_WIN32 */
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.
62 const char *__surf_get_initial_path(void)
67 char current_directory[MAX_PATH + 1] = { 0 };
68 unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
74 strncpy(root, current_directory, 3);
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];
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.
91 int __surf_is_absolute_file_path(const char *file_path)
94 WIN32_FIND_DATA wfd = { 0 };
95 HANDLE hFile = FindFirstFile(file_path, &wfd);
97 if (INVALID_HANDLE_VALUE == hFile)
103 return (file_path[0] == '/');
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;
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[] = {
117 "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). ",
118 surf_network_model_init_LegrandVelho},
120 "Simplistic network model where all communication take a constant time (one second). This model provides the lowest realism, but is (marginally) faster.",
121 surf_network_model_init_Constant},
123 "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
124 surf_network_model_init_SMPI},
126 "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of small messages are thus poorly modeled).",
127 surf_network_model_init_CM02},
130 "Network pseudo-model using the GTNets simulator instead of an analytic model",
131 surf_network_model_init_GTNETS},
135 "Network pseudo-model using the NS3 tcp model instead of an analytic model",
136 surf_network_model_init_NS3},
139 "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
140 surf_network_model_init_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_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_Vegas},
147 {NULL, NULL, NULL} /* this array must be NULL terminated */
150 s_surf_model_description_t surf_cpu_model_description[] = {
152 "Simplistic CPU model (time=size/power).",
153 surf_cpu_model_init_Cas01},
154 {NULL, NULL, NULL} /* this array must be NULL terminated */
157 s_surf_model_description_t surf_workstation_model_description[] = {
159 "Default workstation model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
160 surf_workstation_model_init_current_default},
162 "Workstation model that is automatically chosen if you change the network and CPU models",
163 surf_workstation_model_init_compound},
164 {"ptask_L07", "Workstation model somehow similar to Cas01+CM02 but allowing parallel tasks",
165 surf_workstation_model_init_ptask_L07},
166 {NULL, NULL, NULL} /* this array must be NULL terminated */
169 s_surf_model_description_t surf_optimization_mode_description[] = {
171 "Lazy action management (partial invalidation in lmm + heap in action remaining).",
174 "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU model for now).",
177 "Full update of remaining and variables. Slow but may be useful when debugging.",
179 {NULL, NULL, NULL} /* this array must be NULL terminated */
182 #ifdef CONTEXT_THREADS
183 static xbt_parmap_t surf_parmap; /* parallel map for share_resources */
186 static int surf_nthreads; /* number of threads of the parmap (1 means no parallelism) */
187 static double *surf_mins = NULL; /* return value of share_resources for each model */
188 static int surf_min_index; /* current index in surf_mins */
190 static void surf_share_resources(surf_model_t model);
192 /** Displays the long description of all registered models, and quit */
193 void model_help(const char *category, s_surf_model_description_t * table)
196 printf("Long description of the %s models accepted by this simulator:\n",
198 for (i = 0; table[i].name; i++)
199 printf(" %s: %s\n", table[i].name, table[i].description);
202 int find_model_description(s_surf_model_description_t * table,
206 char *name_list = NULL;
208 for (i = 0; table[i].name; i++)
209 if (!strcmp(name, table[i].name)) {
212 name_list = strdup(table[0].name);
213 for (i = 1; table[i].name; i++) {
215 xbt_realloc(name_list,
216 strlen(name_list) + strlen(table[i].name) + 3);
217 strcat(name_list, ", ");
218 strcat(name_list, table[i].name);
220 xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
224 double generic_maxmin_share_resources(xbt_swag_t running_actions,
227 void (*solve) (lmm_system_t))
229 surf_action_t action = NULL;
232 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
236 xbt_swag_foreach(action, running_actions) {
237 value = lmm_variable_getvalue(VARIABLE(action));
238 if ((value > 0) || (action->max_duration >= 0))
246 if (action->remains > 0)
247 min = action->remains / value;
250 if ((action->max_duration >= 0) && (action->max_duration < min))
251 min = action->max_duration;
253 min = action->max_duration;
256 for (action = xbt_swag_getNext(action, running_actions->offset);
258 action = xbt_swag_getNext(action, running_actions->offset)) {
259 value = lmm_variable_getvalue(VARIABLE(action));
261 if (action->remains > 0)
262 value = action->remains / value;
267 XBT_DEBUG("Updating min (value) with %p: %f", action, min);
270 if ((action->max_duration >= 0) && (action->max_duration < min)) {
271 min = action->max_duration;
272 XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
275 XBT_DEBUG("min value : %f", min);
281 XBT_LOG_EXTERNAL_CATEGORY(surf_cpu);
282 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
283 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange);
284 XBT_LOG_EXTERNAL_CATEGORY(surf_lagrange_dichotomy);
285 XBT_LOG_EXTERNAL_CATEGORY(surf_maxmin);
286 XBT_LOG_EXTERNAL_CATEGORY(surf_network);
287 XBT_LOG_EXTERNAL_CATEGORY(surf_trace);
288 XBT_LOG_EXTERNAL_CATEGORY(surf_parse);
289 XBT_LOG_EXTERNAL_CATEGORY(surf_timer);
290 XBT_LOG_EXTERNAL_CATEGORY(surf_workstation);
291 XBT_LOG_EXTERNAL_CATEGORY(surf_config);
292 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
295 XBT_LOG_EXTERNAL_CATEGORY(surf_network_gtnets);
298 void surf_init(int *argc, char **argv)
300 XBT_DEBUG("Create all Libs");
301 host_lib = xbt_lib_new();
302 link_lib = xbt_lib_new();
303 as_router_lib = xbt_lib_new();
305 XBT_DEBUG("ADD ROUTING LEVEL");
306 ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,xbt_free);
307 ROUTING_ASR_LEVEL = xbt_lib_add_level(as_router_lib,xbt_free);
309 XBT_DEBUG("ADD SURF LEVELS");
310 SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
311 SURF_WKS_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
312 SURF_LINK_LEVEL = xbt_lib_add_level(link_lib,surf_resource_free);
314 /* Connect our log channels: that must be done manually under windows */
315 XBT_LOG_CONNECT(surf_cpu, surf);
316 XBT_LOG_CONNECT(surf_kernel, surf);
317 XBT_LOG_CONNECT(surf_lagrange, surf);
318 XBT_LOG_CONNECT(surf_lagrange_dichotomy, surf_lagrange);
319 XBT_LOG_CONNECT(surf_maxmin, surf);
320 XBT_LOG_CONNECT(surf_network, surf);
321 XBT_LOG_CONNECT(surf_trace, surf);
322 XBT_LOG_CONNECT(surf_parse, surf);
323 XBT_LOG_CONNECT(surf_timer, surf);
324 XBT_LOG_CONNECT(surf_workstation, surf);
325 XBT_LOG_CONNECT(surf_config, surf);
326 XBT_LOG_CONNECT(surf_route, surf);
329 XBT_LOG_CONNECT(surf_network_gtnets, surf);
332 xbt_init(argc, argv);
334 model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
336 history = tmgr_history_new();
337 surf_parmap = xbt_parmap_new(4, XBT_PARMAP_DEFAULT);
339 surf_config_init(argc, argv);
346 # define FILE_DELIM "\\"
348 # define FILE_DELIM "/" /* FIXME: move to better location */
351 FILE *surf_fopen(const char *name, const char *mode)
354 char *path_elm = NULL;
360 if (__surf_is_absolute_file_path(name)) /* don't mess with absolute file names */
361 return fopen(name, mode);
363 /* search relative files in the path */
364 xbt_dynar_foreach(surf_path, cpt, path_elm) {
365 buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
366 file = fopen(buff, mode);
378 surf_model_t model = NULL;
380 surf_config_finalize();
382 xbt_dynar_foreach(model_list, iter, model)
383 model->model_private->finalize();
384 xbt_dynar_free(&model_list);
388 lmm_system_free(maxmin_system);
389 maxmin_system = NULL;
392 tmgr_history_free(history);
397 #ifdef CONTEXT_THREADS
398 xbt_parmap_destroy(surf_parmap);
402 xbt_dynar_free(&surf_path);
404 xbt_lib_free(&host_lib);
405 xbt_lib_free(&link_lib);
406 xbt_lib_free(&as_router_lib);
410 surf_parse_lex_destroy();
411 surf_parse_free_callbacks();
413 NOW = 0; /* Just in case the user plans to restart the simulation afterward */
416 void surf_presolve(void)
418 double next_event_date = -1.0;
419 tmgr_trace_event_t event = NULL;
421 surf_resource_t resource = NULL;
422 surf_model_t model = NULL;
426 ("First Run! Let's \"purge\" events and put models in the right state");
427 while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
428 if (next_event_date > NOW)
431 tmgr_history_get_next_event_leq(history, next_event_date,
433 (void **) &resource))) {
434 resource->model->model_private->update_resource_state(resource,
439 xbt_dynar_foreach(model_list, iter, model)
440 model->model_private->update_actions_state(NOW, 0.0);
443 double surf_solve(double max_date)
445 double min = -1.0; /* duration */
446 double next_event_date = -1.0;
447 double model_next_action_end = -1.0;
449 surf_resource_t resource = NULL;
450 surf_model_t model = NULL;
451 tmgr_trace_event_t event = NULL;
454 if (max_date != -1.0 && max_date != NOW) {
455 min = max_date - NOW;
458 XBT_DEBUG("Looking for next action end for all models except NS3");
460 if (surf_mins == NULL) {
461 surf_mins = xbt_new(double, xbt_dynar_length(model_list));
465 if (surf_get_nthreads() > 1) {
466 /* parallel version */
467 xbt_parmap_apply(surf_parmap, (void_f_pvoid_t) surf_share_resources, model_list);
470 /* sequential version */
471 xbt_dynar_foreach(model_list, iter, model) {
472 surf_share_resources(model);
477 for (i = 0; i < xbt_dynar_length(model_list); i++) {
478 if ((min < 0.0 || surf_mins[i] < min)
479 && surf_mins[i] >= 0.0) {
484 XBT_DEBUG("Min for resources (remember that NS3 dont update that value) : %f", min);
486 XBT_DEBUG("Looking for next trace event");
489 XBT_DEBUG("Next TRACE event : %f", next_event_date);
491 next_event_date = tmgr_history_next_date(history);
493 if(surf_network_model->name && !strcmp(surf_network_model->name,"network NS3")){
494 if(next_event_date!=-1.0 && min!=-1.0) {
495 min = MIN(next_event_date - NOW, min);
497 min = MAX(next_event_date - NOW, min);
500 XBT_DEBUG("Run for NS3 at most %f", min);
501 // run until min or next flow
502 model_next_action_end = surf_network_model->model_private->share_resources(min);
504 XBT_DEBUG("Min for NS3 : %f", model_next_action_end);
505 if(model_next_action_end>=0.0)
506 min = model_next_action_end;
509 if (next_event_date == -1.0) {
510 XBT_DEBUG("no next TRACE event. Stop searching for it");
514 if ((min != -1.0) && (next_event_date > NOW + min)) break;
516 XBT_DEBUG("Updating models");
518 tmgr_history_get_next_event_leq(history, next_event_date,
520 (void **) &resource))) {
521 if (resource->model->model_private->resource_used(resource)) {
522 min = next_event_date - NOW;
524 ("This event will modify model state. Next event set to %f",
527 /* update state of model_obj according to new value. Does not touch lmm.
528 It will be modified if needed when updating actions */
529 XBT_DEBUG("Calling update_resource_state for resource %s with min %lf",
530 resource->model->name, min);
531 resource->model->model_private->update_resource_state(resource,
537 /* FIXME: Moved this test to here to avoid stopping simulation if there are actions running on cpus and all cpus are with availability = 0.
538 * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
539 * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
541 XBT_DEBUG("No next event at all. Bail out now.");
545 XBT_DEBUG("Duration set to %f", min);
549 xbt_dynar_foreach(model_list, iter, model)
550 model->model_private->update_actions_state(NOW, min);
553 TRACE_paje_dump_buffer (0);
559 XBT_INLINE double surf_get_clock(void)
564 static void surf_share_resources(surf_model_t model) {
566 if (strcmp(model->name,"network NS3")) {
567 XBT_DEBUG("Running for Resource [%s]", model->name);
568 double next_action_end = model->model_private->share_resources(NOW);
569 XBT_DEBUG("Resource [%s] : next action end = %f",
570 model->name, next_action_end);
571 int i = __sync_fetch_and_add(&surf_min_index, 1);
572 surf_mins[i] = next_action_end;
577 * \brief Returns the number of parallel threads used to update the models.
578 * \return the number of threads (1 means no parallelism)
580 int surf_get_nthreads(void) {
581 return surf_nthreads;
585 * \brief Sets the number of parallel threads used to update the models.
587 * A value of 1 means no parallelism.
589 * \param nb_threads the number of threads to use
591 void surf_set_nthreads(int nthreads) {
593 xbt_assert(nthreads > 0, "Invalid number of parallel threads: %d", nthreads);
596 #ifndef CONTEXT_THREADS
597 THROWF(arg_error, 0, "Cannot activate parallel threads in Surf: your architecture does not support threads");
601 surf_nthreads = nthreads;