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. */
7 #include "surf_private.h"
8 #include "xbt/module.h"
10 #include "simix/smx_host_private.h"
11 #include "surf/surf_resource.h"
12 #include "xbt/xbt_os_thread.h"
16 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
18 "Logging specific to SURF (kernel)");
20 /* Additional declarations for Windows portability. */
28 static const char *disk_drives_letter_table[MAX_DRIVE] = {
56 #endif /* #ifdef _XBT_WIN32 */
59 * Returns the initial path. On Windows the initial path is
60 * the current directory for the current process in the other
61 * case the function returns "./" that represents the current
62 * directory on Unix/Linux platforms.
65 const char *__surf_get_initial_path(void)
70 char current_directory[MAX_PATH + 1] = { 0 };
71 unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
77 strncpy(root, current_directory, 3);
79 for (i = 0; i < MAX_DRIVE; i++) {
80 if (toupper(root[0]) == disk_drives_letter_table[i][0])
81 return disk_drives_letter_table[i];
90 /* The __surf_is_absolute_file_path() returns 1 if
91 * file_path is a absolute file path, in the other
92 * case the function returns 0.
94 int __surf_is_absolute_file_path(const char *file_path)
97 WIN32_FIND_DATA wfd = { 0 };
98 HANDLE hFile = FindFirstFile(file_path, &wfd);
100 if (INVALID_HANDLE_VALUE == hFile)
106 return (file_path[0] == '/');
112 xbt_dynar_t model_list = NULL;
113 tmgr_history_t history = NULL;
114 lmm_system_t maxmin_system = NULL;
115 xbt_dynar_t surf_path = NULL;
117 /* Don't forget to update the option description in smx_config when you change this */
118 s_surf_model_description_t surf_network_model_description[] = {
120 "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). ",
121 surf_network_model_init_LegrandVelho},
123 "Simplistic network model where all communication take a constant time (one second). This model provides the lowest realism, but is (marginally) faster.",
124 surf_network_model_init_Constant},
126 "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
127 surf_network_model_init_SMPI},
129 "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of small messages are thus poorly modeled).",
130 surf_network_model_init_CM02},
133 "Network pseudo-model using the GTNets simulator instead of an analytic model",
134 surf_network_model_init_GTNETS},
138 "Network pseudo-model using the NS3 tcp model instead of an analytic model",
139 surf_network_model_init_NS3},
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_Reno},
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_Reno2},
148 "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
149 surf_network_model_init_Vegas},
150 {NULL, NULL, NULL} /* this array must be NULL terminated */
153 s_surf_model_description_t surf_cpu_model_description[] = {
155 "Simplistic CPU model (time=size/power).",
156 surf_cpu_model_init_Cas01},
157 {NULL, NULL, NULL} /* this array must be NULL terminated */
160 s_surf_model_description_t surf_workstation_model_description[] = {
162 "Default workstation model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
163 surf_workstation_model_init_current_default},
165 "Workstation model that is automatically chosen if you change the network and CPU models",
166 surf_workstation_model_init_compound},
167 {"ptask_L07", "Workstation model somehow similar to Cas01+CM02 but allowing parallel tasks",
168 surf_workstation_model_init_ptask_L07},
169 {NULL, NULL, NULL} /* this array must be NULL terminated */
172 s_surf_model_description_t surf_optimization_mode_description[] = {
174 "Lazy action management (partial invalidation in lmm + heap in action remaining).",
177 "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU model for now).",
180 "Full update of remaining and variables. Slow but may be useful when debugging.",
182 {NULL, NULL, NULL} /* this array must be NULL terminated */
185 s_surf_model_description_t surf_storage_model_description[] = {
187 "Simplistic storage model.",
188 surf_storage_model_init_default},
189 {NULL, NULL, NULL} /* this array must be NULL terminated */
192 /* ********************************************************************* */
193 /* TUTORIAL: New model */
194 s_surf_model_description_t surf_new_model_description[] = {
197 surf_new_model_init_default},
198 {NULL, NULL, NULL} /* this array must be NULL terminated */
200 /* ********************************************************************* */
202 #ifdef CONTEXT_THREADS
203 static xbt_parmap_t surf_parmap = NULL; /* parallel map on models */
206 static int surf_nthreads = 1; /* number of threads of the parmap (1 means no parallelism) */
207 static double *surf_mins = NULL; /* return value of share_resources for each model */
208 static int surf_min_index; /* current index in surf_mins */
209 static double min; /* duration determined by surf_solve */
211 static void surf_share_resources(surf_model_t model);
212 static void surf_update_actions_state(surf_model_t model);
214 /** Displays the long description of all registered models, and quit */
215 void model_help(const char *category, s_surf_model_description_t * table)
218 printf("Long description of the %s models accepted by this simulator:\n",
220 for (i = 0; table[i].name; i++)
221 printf(" %s: %s\n", table[i].name, table[i].description);
224 int find_model_description(s_surf_model_description_t * table,
228 char *name_list = NULL;
230 for (i = 0; table[i].name; i++)
231 if (!strcmp(name, table[i].name)) {
234 name_list = strdup(table[0].name);
235 for (i = 1; table[i].name; i++) {
237 xbt_realloc(name_list,
238 strlen(name_list) + strlen(table[i].name) + 3);
239 strcat(name_list, ", ");
240 strcat(name_list, table[i].name);
242 xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
246 double generic_maxmin_share_resources(xbt_swag_t running_actions,
249 void (*solve) (lmm_system_t))
251 surf_action_t action = NULL;
254 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
258 xbt_swag_foreach(action, running_actions) {
259 value = lmm_variable_getvalue(VARIABLE(action));
260 if ((value > 0) || (action->max_duration >= 0))
268 if (action->remains > 0)
269 min = action->remains / value;
272 if ((action->max_duration >= 0) && (action->max_duration < min))
273 min = action->max_duration;
275 min = action->max_duration;
278 for (action = xbt_swag_getNext(action, running_actions->offset);
280 action = xbt_swag_getNext(action, running_actions->offset)) {
281 value = lmm_variable_getvalue(VARIABLE(action));
283 if (action->remains > 0)
284 value = action->remains / value;
289 XBT_DEBUG("Updating min (value) with %p: %f", action, min);
292 if ((action->max_duration >= 0) && (action->max_duration < min)) {
293 min = action->max_duration;
294 XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
297 XBT_DEBUG("min value : %f", min);
303 double generic_share_resources_lazy(double now, surf_model_t model)
305 surf_action_lmm_t action = NULL;
310 ("Before share resources, the size of modified actions set is %d",
311 xbt_swag_size(model->model_private->modified_set));
313 lmm_solve(model->model_private->maxmin_system);
316 ("After share resources, The size of modified actions set is %d",
317 xbt_swag_size(model->model_private->modified_set));
319 while((action = xbt_swag_extract(model->model_private->modified_set))) {
320 int max_dur_flag = 0;
322 if (action->generic_action.state_set !=
323 model->states.running_action_set)
326 /* bogus priority, skip it */
327 if (action->generic_action.priority <= 0)
330 generic_update_action_remaining_lazy(action,now);
333 value = lmm_variable_getvalue(action->variable);
335 if (action->generic_action.remains > 0) {
336 value = action->generic_action.remains / value;
344 if ((action->generic_action.max_duration != NO_MAX_DURATION)
346 || action->generic_action.start +
347 action->generic_action.max_duration < min)) {
348 min = action->generic_action.start +
349 action->generic_action.max_duration;
353 XBT_DEBUG("Action(%p) Start %lf Finish %lf Max_duration %lf", action,
354 action->generic_action.start, now + value,
355 action->generic_action.max_duration);
358 surf_action_lmm_heap_remove(model->model_private->action_heap,action);
359 surf_action_lmm_heap_insert(model->model_private->action_heap,action, min, max_dur_flag ? MAX_DURATION : NORMAL);
360 XBT_DEBUG("Insert at heap action(%p) min %lf now %lf", action, min,
362 } else DIE_IMPOSSIBLE;
365 //hereafter must have already the min value for this resource model
366 if (xbt_heap_size(model->model_private->action_heap) > 0)
367 min = xbt_heap_maxkey(model->model_private->action_heap) - now;
371 XBT_DEBUG("The minimum with the HEAP %lf", min);
375 static XBT_INLINE void routing_asr_host_free(void *p)
377 sg_routing_edge_t elm = p;
382 static XBT_INLINE void routing_asr_prop_free(void *p)
388 void sg_version(int *ver_major,int *ver_minor,int *ver_patch) {
389 *ver_major = SIMGRID_VERSION_MAJOR;
390 *ver_minor = SIMGRID_VERSION_MINOR;
391 *ver_patch = SIMGRID_VERSION_PATCH;
394 void surf_init(int *argc, char **argv)
396 XBT_DEBUG("Create all Libs");
397 host_lib = xbt_lib_new();
398 link_lib = xbt_lib_new();
399 as_router_lib = xbt_lib_new();
400 storage_lib = xbt_lib_new();
401 storage_type_lib = xbt_lib_new();
402 watched_hosts_lib = xbt_dict_new();
404 XBT_DEBUG("Add routing levels");
405 ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,routing_asr_host_free);
406 ROUTING_ASR_LEVEL = xbt_lib_add_level(as_router_lib,routing_asr_host_free);
407 ROUTING_PROP_ASR_LEVEL = xbt_lib_add_level(as_router_lib,routing_asr_prop_free);
409 XBT_DEBUG("Add SURF levels");
410 SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
411 SURF_WKS_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
412 SURF_LINK_LEVEL = xbt_lib_add_level(link_lib,surf_resource_free);
414 xbt_init(argc, argv);
416 model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
418 history = tmgr_history_new();
420 surf_config_init(argc, argv);
427 # define FILE_DELIM "\\"
429 # define FILE_DELIM "/" /* FIXME: move to better location */
432 FILE *surf_fopen(const char *name, const char *mode)
435 char *path_elm = NULL;
441 if (__surf_is_absolute_file_path(name)) /* don't mess with absolute file names */
442 return fopen(name, mode);
444 /* search relative files in the path */
445 xbt_dynar_foreach(surf_path, cpt, path_elm) {
446 buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
447 file = fopen(buff, mode);
459 surf_model_t model = NULL;
461 surf_config_finalize();
463 xbt_dynar_foreach(model_list, iter, model)
464 model->model_private->finalize();
465 xbt_dynar_free(&model_list);
469 lmm_system_free(maxmin_system);
470 maxmin_system = NULL;
473 tmgr_history_free(history);
478 #ifdef CONTEXT_THREADS
479 xbt_parmap_destroy(surf_parmap);
484 xbt_dynar_free(&surf_path);
486 xbt_lib_free(&host_lib);
487 xbt_lib_free(&link_lib);
488 xbt_lib_free(&as_router_lib);
489 xbt_lib_free(&storage_lib);
490 xbt_lib_free(&storage_type_lib);
492 xbt_dict_free(&watched_hosts_lib);
495 surf_parse_lex_destroy();
496 surf_parse_free_callbacks();
498 NOW = 0; /* Just in case the user plans to restart the simulation afterward */
501 void surf_presolve(void)
503 double next_event_date = -1.0;
504 tmgr_trace_event_t event = NULL;
506 surf_resource_t resource = NULL;
507 surf_model_t model = NULL;
511 ("First Run! Let's \"purge\" events and put models in the right state");
512 while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
513 if (next_event_date > NOW)
516 tmgr_history_get_next_event_leq(history, next_event_date,
518 (void **) &resource))) {
519 resource->model->model_private->update_resource_state(resource,
524 xbt_dynar_foreach(model_list, iter, model)
525 model->model_private->update_actions_state(NOW, 0.0);
528 double surf_solve(double max_date)
530 min = -1.0; /* duration */
531 double next_event_date = -1.0;
532 double model_next_action_end = -1.0;
534 surf_resource_t resource = NULL;
535 surf_model_t model = NULL;
536 tmgr_trace_event_t event = NULL;
539 if (max_date != -1.0 && max_date != NOW) {
540 min = max_date - NOW;
543 XBT_DEBUG("Looking for next action end for all models except NS3");
545 if (surf_mins == NULL) {
546 surf_mins = xbt_new(double, xbt_dynar_length(model_list));
551 if (surf_get_nthreads() > 1) {
552 /* parallel version */
553 #ifdef CONTEXT_THREADS
554 xbt_parmap_apply(surf_parmap, (void_f_pvoid_t) surf_share_resources, model_list);
556 xbt_die("Asked to run in parallel, but no thread at hand...");
560 /* sequential version */
561 xbt_dynar_foreach(model_list, iter, model) {
562 surf_share_resources(model);
567 for (i = 0; i < xbt_dynar_length(model_list); i++) {
568 if ((min < 0.0 || surf_mins[i] < min)
569 && surf_mins[i] >= 0.0) {
574 XBT_DEBUG("Min for resources (remember that NS3 don't update that value) : %f", min);
576 XBT_DEBUG("Looking for next trace event");
579 XBT_DEBUG("Next TRACE event : %f", next_event_date);
581 next_event_date = tmgr_history_next_date(history);
583 if(surf_network_model->name && !strcmp(surf_network_model->name,"network NS3")){
584 if(next_event_date!=-1.0 && min!=-1.0) {
585 min = MIN(next_event_date - NOW, min);
587 min = MAX(next_event_date - NOW, min);
590 XBT_DEBUG("Run for NS3 at most %f", min);
591 // run until min or next flow
592 model_next_action_end = surf_network_model->model_private->share_resources(min);
594 XBT_DEBUG("Min for NS3 : %f", model_next_action_end);
595 if(model_next_action_end>=0.0)
596 min = model_next_action_end;
599 if (next_event_date == -1.0) {
600 XBT_DEBUG("no next TRACE event. Stop searching for it");
604 if ((min != -1.0) && (next_event_date > NOW + min)) break;
606 XBT_DEBUG("Updating models");
608 tmgr_history_get_next_event_leq(history, next_event_date,
610 (void **) &resource))) {
611 if (resource->model->model_private->resource_used(resource)) {
612 min = next_event_date - NOW;
614 ("This event will modify model state. Next event set to %f",
617 /* update state of model_obj according to new value. Does not touch lmm.
618 It will be modified if needed when updating actions */
619 XBT_DEBUG("Calling update_resource_state for resource %s with min %lf",
620 resource->model->name, min);
621 resource->model->model_private->update_resource_state(resource,
627 /* FIXME: Moved this test to here to avoid stopping simulation if there are actions running on cpus and all cpus are with availability = 0.
628 * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
629 * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
631 XBT_DEBUG("No next event at all. Bail out now.");
635 XBT_DEBUG("Duration set to %f", min);
639 if (surf_get_nthreads() > 1) {
640 /* parallel version */
641 #ifdef CONTEXT_THREADS
642 xbt_parmap_apply(surf_parmap, (void_f_pvoid_t) surf_update_actions_state, model_list);
646 /* sequential version */
647 xbt_dynar_foreach(model_list, iter, model) {
648 surf_update_actions_state(model);
653 TRACE_paje_dump_buffer (0);
659 XBT_INLINE double surf_get_clock(void)
664 static void surf_share_resources(surf_model_t model)
666 double next_action_end = -1.0;
667 int i = __sync_fetch_and_add(&surf_min_index, 1);
668 if (strcmp(model->name,"network NS3")) {
669 XBT_DEBUG("Running for Resource [%s]", model->name);
670 next_action_end = model->model_private->share_resources(NOW);
671 XBT_DEBUG("Resource [%s] : next action end = %f",
672 model->name, next_action_end);
674 surf_mins[i] = next_action_end;
677 static void surf_update_actions_state(surf_model_t model)
679 model->model_private->update_actions_state(NOW, min);
683 * \brief Returns the number of parallel threads used to update the models.
684 * \return the number of threads (1 means no parallelism)
686 int surf_get_nthreads(void) {
687 return surf_nthreads;
691 * \brief Sets the number of parallel threads used to update the models.
693 * A value of 1 means no parallelism.
695 * \param nb_threads the number of threads to use
697 void surf_set_nthreads(int nthreads) {
700 nthreads = xbt_os_get_numcores();
701 XBT_INFO("Auto-setting surf/nthreads to %d",nthreads);
704 #ifdef CONTEXT_THREADS
705 xbt_parmap_destroy(surf_parmap);
710 #ifdef CONTEXT_THREADS
711 surf_parmap = xbt_parmap_new(nthreads, XBT_PARMAP_DEFAULT);
713 THROWF(arg_error, 0, "Cannot activate parallel threads in Surf: your architecture does not support threads");
717 surf_nthreads = nthreads;
720 void surf_watched_hosts(void)
724 xbt_dict_cursor_t cursor;
726 XBT_DEBUG("Check for host SURF_RESOURCE_ON on watched_hosts_lib");
727 xbt_dict_foreach(watched_hosts_lib,cursor,key,host)
729 if(SIMIX_host_get_state(host) == SURF_RESOURCE_ON){
730 XBT_INFO("Restart processes on host: %s",SIMIX_host_get_name(host));
731 SIMIX_host_autorestart(host);
732 xbt_dict_remove(watched_hosts_lib,key);
735 XBT_DEBUG("See SURF_RESOURCE_OFF on host: %s",key);