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"
13 #include "xbt/xbt_os_thread.h"
15 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
17 "Logging specific to SURF (kernel)");
19 /* Additional declarations for Windows portability. */
27 static const char *disk_drives_letter_table[MAX_DRIVE] = {
55 #endif /* #ifdef _XBT_WIN32 */
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.
64 const char *__surf_get_initial_path(void)
69 char current_directory[MAX_PATH + 1] = { 0 };
70 unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
76 strncpy(root, current_directory, 3);
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];
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.
93 int __surf_is_absolute_file_path(const char *file_path)
96 WIN32_FIND_DATA wfd = { 0 };
97 HANDLE hFile = FindFirstFile(file_path, &wfd);
99 if (INVALID_HANDLE_VALUE == hFile)
105 return (file_path[0] == '/');
111 xbt_dynar_t model_list = NULL;
112 tmgr_history_t history = NULL;
113 lmm_system_t maxmin_system = NULL;
114 xbt_dynar_t surf_path = NULL;
116 /* Don't forget to update the option description in smx_config when you change this */
117 s_surf_model_description_t surf_network_model_description[] = {
119 "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). ",
120 surf_network_model_init_LegrandVelho},
122 "Simplistic network model where all communication take a constant time (one second). This model provides the lowest realism, but is (marginally) faster.",
123 surf_network_model_init_Constant},
125 "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
126 surf_network_model_init_SMPI},
128 "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of small messages are thus poorly modeled).",
129 surf_network_model_init_CM02},
132 "Network pseudo-model using the GTNets simulator instead of an analytic model",
133 surf_network_model_init_GTNETS},
137 "Network pseudo-model using the NS3 tcp model instead of an analytic model",
138 surf_network_model_init_NS3},
141 "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
142 surf_network_model_init_Reno},
144 "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
145 surf_network_model_init_Reno2},
147 "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
148 surf_network_model_init_Vegas},
149 {NULL, NULL, NULL} /* this array must be NULL terminated */
152 s_surf_model_description_t surf_cpu_model_description[] = {
154 "Simplistic CPU model (time=size/power).",
155 surf_cpu_model_init_Cas01},
156 {NULL, NULL, NULL} /* this array must be NULL terminated */
159 s_surf_model_description_t surf_workstation_model_description[] = {
161 "Default workstation model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
162 surf_workstation_model_init_current_default},
164 "Workstation model that is automatically chosen if you change the network and CPU models",
165 surf_workstation_model_init_compound},
166 {"ptask_L07", "Workstation model somehow similar to Cas01+CM02 but allowing parallel tasks",
167 surf_workstation_model_init_ptask_L07},
168 {NULL, NULL, NULL} /* this array must be NULL terminated */
171 s_surf_model_description_t surf_optimization_mode_description[] = {
173 "Lazy action management (partial invalidation in lmm + heap in action remaining).",
176 "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU model for now).",
179 "Full update of remaining and variables. Slow but may be useful when debugging.",
181 {NULL, NULL, NULL} /* this array must be NULL terminated */
184 s_surf_model_description_t surf_storage_model_description[] = {
186 "Simplistic storage model.",
187 surf_storage_model_init_default},
188 {NULL, NULL, NULL} /* this array must be NULL terminated */
191 #ifdef CONTEXT_THREADS
192 static xbt_parmap_t surf_parmap = NULL; /* parallel map on models */
195 static int surf_nthreads = 1; /* number of threads of the parmap (1 means no parallelism) */
196 static double *surf_mins = NULL; /* return value of share_resources for each model */
197 static int surf_min_index; /* current index in surf_mins */
198 static double min; /* duration determined by surf_solve */
200 static void surf_share_resources(surf_model_t model);
201 static void surf_update_actions_state(surf_model_t model);
203 /** Displays the long description of all registered models, and quit */
204 void model_help(const char *category, s_surf_model_description_t * table)
207 printf("Long description of the %s models accepted by this simulator:\n",
209 for (i = 0; table[i].name; i++)
210 printf(" %s: %s\n", table[i].name, table[i].description);
213 int find_model_description(s_surf_model_description_t * table,
217 char *name_list = NULL;
219 for (i = 0; table[i].name; i++)
220 if (!strcmp(name, table[i].name)) {
223 name_list = strdup(table[0].name);
224 for (i = 1; table[i].name; i++) {
226 xbt_realloc(name_list,
227 strlen(name_list) + strlen(table[i].name) + 3);
228 strcat(name_list, ", ");
229 strcat(name_list, table[i].name);
231 xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
235 double generic_maxmin_share_resources(xbt_swag_t running_actions,
238 void (*solve) (lmm_system_t))
240 surf_action_t action = NULL;
243 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
247 xbt_swag_foreach(action, running_actions) {
248 value = lmm_variable_getvalue(VARIABLE(action));
249 if ((value > 0) || (action->max_duration >= 0))
257 if (action->remains > 0)
258 min = action->remains / value;
261 if ((action->max_duration >= 0) && (action->max_duration < min))
262 min = action->max_duration;
264 min = action->max_duration;
267 for (action = xbt_swag_getNext(action, running_actions->offset);
269 action = xbt_swag_getNext(action, running_actions->offset)) {
270 value = lmm_variable_getvalue(VARIABLE(action));
272 if (action->remains > 0)
273 value = action->remains / value;
278 XBT_DEBUG("Updating min (value) with %p: %f", action, min);
281 if ((action->max_duration >= 0) && (action->max_duration < min)) {
282 min = action->max_duration;
283 XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
286 XBT_DEBUG("min value : %f", min);
292 double generic_share_resources_lazy(double now, surf_model_t model)
294 surf_action_lmm_t action = NULL;
299 ("Before share resources, the size of modified actions set is %d",
300 xbt_swag_size(model->model_private->modified_set));
302 lmm_solve(model->model_private->maxmin_system);
305 ("After share resources, The size of modified actions set is %d",
306 xbt_swag_size(model->model_private->modified_set));
308 while((action = xbt_swag_extract(model->model_private->modified_set))) {
309 int max_dur_flag = 0;
311 if (action->generic_action.state_set !=
312 model->states.running_action_set)
315 /* bogus priority, skip it */
316 if (action->generic_action.priority <= 0)
319 generic_update_action_remaining_lazy(action,now);
322 value = lmm_variable_getvalue(action->variable);
324 if (action->generic_action.remains > 0) {
325 value = action->generic_action.remains / value;
333 if ((action->generic_action.max_duration != NO_MAX_DURATION)
335 || action->generic_action.start +
336 action->generic_action.max_duration < min)) {
337 min = action->generic_action.start +
338 action->generic_action.max_duration;
342 XBT_DEBUG("Action(%p) Start %lf Finish %lf Max_duration %lf", action,
343 action->generic_action.start, now + value,
344 action->generic_action.max_duration);
347 surf_action_lmm_heap_remove(model->model_private->action_heap,action);
348 surf_action_lmm_heap_insert(model->model_private->action_heap,action, min, max_dur_flag ? MAX_DURATION : NORMAL);
349 XBT_DEBUG("Insert at heap action(%p) min %lf now %lf", action, min,
351 } else DIE_IMPOSSIBLE;
354 //hereafter must have already the min value for this resource model
355 if (xbt_heap_size(model->model_private->action_heap) > 0)
356 min = xbt_heap_maxkey(model->model_private->action_heap) - now;
360 XBT_DEBUG("The minimum with the HEAP %lf", min);
364 static XBT_INLINE void routing_asr_host_free(void *p)
366 sg_routing_edge_t elm = p;
371 void surf_init(int *argc, char **argv)
373 XBT_DEBUG("Create all Libs");
374 host_lib = xbt_lib_new();
375 link_lib = xbt_lib_new();
376 as_router_lib = xbt_lib_new();
377 storage_lib = xbt_lib_new();
378 storage_type_lib = xbt_lib_new();
380 XBT_DEBUG("ADD ROUTING LEVEL");
381 ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,routing_asr_host_free);
382 ROUTING_ASR_LEVEL = xbt_lib_add_level(as_router_lib,routing_asr_host_free);
384 XBT_DEBUG("ADD SURF LEVELS");
385 SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
386 SURF_WKS_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
387 SURF_LINK_LEVEL = xbt_lib_add_level(link_lib,surf_resource_free);
389 xbt_init(argc, argv);
391 model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
393 history = tmgr_history_new();
395 surf_config_init(argc, argv);
402 # define FILE_DELIM "\\"
404 # define FILE_DELIM "/" /* FIXME: move to better location */
407 FILE *surf_fopen(const char *name, const char *mode)
410 char *path_elm = NULL;
416 if (__surf_is_absolute_file_path(name)) /* don't mess with absolute file names */
417 return fopen(name, mode);
419 /* search relative files in the path */
420 xbt_dynar_foreach(surf_path, cpt, path_elm) {
421 buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
422 file = fopen(buff, mode);
434 surf_model_t model = NULL;
436 surf_config_finalize();
438 xbt_dynar_foreach(model_list, iter, model)
439 model->model_private->finalize();
440 xbt_dynar_free(&model_list);
444 lmm_system_free(maxmin_system);
445 maxmin_system = NULL;
448 tmgr_history_free(history);
453 #ifdef CONTEXT_THREADS
454 xbt_parmap_destroy(surf_parmap);
459 xbt_dynar_free(&surf_path);
461 xbt_lib_free(&host_lib);
462 xbt_lib_free(&link_lib);
463 xbt_lib_free(&as_router_lib);
464 xbt_lib_free(&storage_lib);
465 xbt_lib_free(&storage_type_lib);
468 surf_parse_lex_destroy();
469 surf_parse_free_callbacks();
471 NOW = 0; /* Just in case the user plans to restart the simulation afterward */
474 void surf_presolve(void)
476 double next_event_date = -1.0;
477 tmgr_trace_event_t event = NULL;
479 surf_resource_t resource = NULL;
480 surf_model_t model = NULL;
484 ("First Run! Let's \"purge\" events and put models in the right state");
485 while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
486 if (next_event_date > NOW)
489 tmgr_history_get_next_event_leq(history, next_event_date,
491 (void **) &resource))) {
492 resource->model->model_private->update_resource_state(resource,
497 xbt_dynar_foreach(model_list, iter, model)
498 model->model_private->update_actions_state(NOW, 0.0);
501 double surf_solve(double max_date)
503 min = -1.0; /* duration */
504 double next_event_date = -1.0;
505 double model_next_action_end = -1.0;
507 surf_resource_t resource = NULL;
508 surf_model_t model = NULL;
509 tmgr_trace_event_t event = NULL;
512 if (max_date != -1.0 && max_date != NOW) {
513 min = max_date - NOW;
516 XBT_DEBUG("Looking for next action end for all models except NS3");
518 if (surf_mins == NULL) {
519 surf_mins = xbt_new(double, xbt_dynar_length(model_list));
524 if (surf_get_nthreads() > 1) {
525 /* parallel version */
526 #ifdef CONTEXT_THREADS
527 xbt_parmap_apply(surf_parmap, (void_f_pvoid_t) surf_share_resources, model_list);
529 xbt_die("Asked to run in parallel, but no thread at hand...");
533 /* sequential version */
534 xbt_dynar_foreach(model_list, iter, model) {
535 surf_share_resources(model);
540 for (i = 0; i < xbt_dynar_length(model_list); i++) {
541 if ((min < 0.0 || surf_mins[i] < min)
542 && surf_mins[i] >= 0.0) {
547 XBT_DEBUG("Min for resources (remember that NS3 don't update that value) : %f", min);
549 XBT_DEBUG("Looking for next trace event");
552 XBT_DEBUG("Next TRACE event : %f", next_event_date);
554 next_event_date = tmgr_history_next_date(history);
556 if(surf_network_model->name && !strcmp(surf_network_model->name,"network NS3")){
557 if(next_event_date!=-1.0 && min!=-1.0) {
558 min = MIN(next_event_date - NOW, min);
560 min = MAX(next_event_date - NOW, min);
563 XBT_DEBUG("Run for NS3 at most %f", min);
564 // run until min or next flow
565 model_next_action_end = surf_network_model->model_private->share_resources(min);
567 XBT_DEBUG("Min for NS3 : %f", model_next_action_end);
568 if(model_next_action_end>=0.0)
569 min = model_next_action_end;
572 if (next_event_date == -1.0) {
573 XBT_DEBUG("no next TRACE event. Stop searching for it");
577 if ((min != -1.0) && (next_event_date > NOW + min)) break;
579 XBT_DEBUG("Updating models");
581 tmgr_history_get_next_event_leq(history, next_event_date,
583 (void **) &resource))) {
584 if (resource->model->model_private->resource_used(resource)) {
585 min = next_event_date - NOW;
587 ("This event will modify model state. Next event set to %f",
590 /* update state of model_obj according to new value. Does not touch lmm.
591 It will be modified if needed when updating actions */
592 XBT_DEBUG("Calling update_resource_state for resource %s with min %lf",
593 resource->model->name, min);
594 resource->model->model_private->update_resource_state(resource,
600 /* FIXME: Moved this test to here to avoid stopping simulation if there are actions running on cpus and all cpus are with availability = 0.
601 * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
602 * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
604 XBT_DEBUG("No next event at all. Bail out now.");
608 XBT_DEBUG("Duration set to %f", min);
612 if (surf_get_nthreads() > 1) {
613 /* parallel version */
614 #ifdef CONTEXT_THREADS
615 xbt_parmap_apply(surf_parmap, (void_f_pvoid_t) surf_update_actions_state, model_list);
619 /* sequential version */
620 xbt_dynar_foreach(model_list, iter, model) {
621 surf_update_actions_state(model);
626 TRACE_paje_dump_buffer (0);
632 XBT_INLINE double surf_get_clock(void)
637 static void surf_share_resources(surf_model_t model)
639 double next_action_end = -1.0;
640 int i = __sync_fetch_and_add(&surf_min_index, 1);
641 if (strcmp(model->name,"network NS3")) {
642 XBT_DEBUG("Running for Resource [%s]", model->name);
643 next_action_end = model->model_private->share_resources(NOW);
644 XBT_DEBUG("Resource [%s] : next action end = %f",
645 model->name, next_action_end);
647 surf_mins[i] = next_action_end;
650 static void surf_update_actions_state(surf_model_t model)
652 model->model_private->update_actions_state(NOW, min);
656 * \brief Returns the number of parallel threads used to update the models.
657 * \return the number of threads (1 means no parallelism)
659 int surf_get_nthreads(void) {
660 return surf_nthreads;
664 * \brief Sets the number of parallel threads used to update the models.
666 * A value of 1 means no parallelism.
668 * \param nb_threads the number of threads to use
670 void surf_set_nthreads(int nthreads) {
673 nthreads = xbt_os_get_numcores();
674 XBT_INFO("Auto-setting surf/nthreads to %d",nthreads);
677 #ifdef CONTEXT_THREADS
678 xbt_parmap_destroy(surf_parmap);
683 #ifdef CONTEXT_THREADS
684 surf_parmap = xbt_parmap_new(nthreads, XBT_PARMAP_DEFAULT);
686 THROWF(arg_error, 0, "Cannot activate parallel threads in Surf: your architecture does not support threads");
690 surf_nthreads = nthreads;