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"
13 #include "simgrid/sg_config.h"
17 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
19 "Logging specific to SURF (kernel)");
21 /* Additional declarations for Windows portability. */
29 static const char *disk_drives_letter_table[MAX_DRIVE] = {
57 #endif /* #ifdef _XBT_WIN32 */
60 * Returns the initial path. On Windows the initial path is
61 * the current directory for the current process in the other
62 * case the function returns "./" that represents the current
63 * directory on Unix/Linux platforms.
66 const char *__surf_get_initial_path(void)
71 char current_directory[MAX_PATH + 1] = { 0 };
72 unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
78 strncpy(root, current_directory, 3);
80 for (i = 0; i < MAX_DRIVE; i++) {
81 if (toupper(root[0]) == disk_drives_letter_table[i][0])
82 return disk_drives_letter_table[i];
91 /* The __surf_is_absolute_file_path() returns 1 if
92 * file_path is a absolute file path, in the other
93 * case the function returns 0.
95 int __surf_is_absolute_file_path(const char *file_path)
98 WIN32_FIND_DATA wfd = { 0 };
99 HANDLE hFile = FindFirstFile(file_path, &wfd);
101 if (INVALID_HANDLE_VALUE == hFile)
107 return (file_path[0] == '/');
113 /* model_list_invoke contains only surf_workstation and surf_vm_workstation.
114 * The callback functions of cpu_model and network_model will be called from
115 * those of these workstation models. */
116 xbt_dynar_t model_list = NULL; /* for destroying all models correctly */
117 xbt_dynar_t model_list_invoke = NULL; /* for invoking callbacks */
118 tmgr_history_t history = NULL;
119 lmm_system_t maxmin_system = NULL;
120 xbt_dynar_t surf_path = NULL;
122 /* Don't forget to update the option description in smx_config when you change this */
123 s_surf_model_description_t surf_network_model_description[] = {
125 "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). ",
126 surf_network_model_init_LegrandVelho},
128 "Simplistic network model where all communication take a constant time (one second). This model provides the lowest realism, but is (marginally) faster.",
129 surf_network_model_init_Constant},
131 "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
132 surf_network_model_init_SMPI},
134 "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of small messages are thus poorly modeled).",
135 surf_network_model_init_CM02},
138 "Network pseudo-model using the GTNets simulator instead of an analytic model",
139 surf_network_model_init_GTNETS},
143 "Network pseudo-model using the NS3 tcp model instead of an analytic model",
144 surf_network_model_init_NS3},
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_Reno},
150 "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
151 surf_network_model_init_Reno2},
153 "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
154 surf_network_model_init_Vegas},
155 {NULL, NULL, NULL} /* this array must be NULL terminated */
158 s_surf_model_description_t surf_cpu_model_description[] = {
160 "Simplistic CPU model (time=size/power).",
161 surf_cpu_model_init_Cas01},
162 {NULL, NULL, NULL} /* this array must be NULL terminated */
165 s_surf_model_description_t surf_workstation_model_description[] = {
167 "Default workstation model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
168 surf_workstation_model_init_current_default},
170 "Workstation model that is automatically chosen if you change the network and CPU models",
171 surf_workstation_model_init_compound},
172 {"ptask_L07", "Workstation model somehow similar to Cas01+CM02 but allowing parallel tasks",
173 surf_workstation_model_init_ptask_L07},
174 {NULL, NULL, NULL} /* this array must be NULL terminated */
177 s_surf_model_description_t surf_optimization_mode_description[] = {
179 "Lazy action management (partial invalidation in lmm + heap in action remaining).",
182 "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU model for now).",
185 "Full update of remaining and variables. Slow but may be useful when debugging.",
187 {NULL, NULL, NULL} /* this array must be NULL terminated */
190 s_surf_model_description_t surf_storage_model_description[] = {
192 "Simplistic storage model.",
193 surf_storage_model_init_default},
194 {NULL, NULL, NULL} /* this array must be NULL terminated */
197 /* ********************************************************************* */
198 /* TUTORIAL: New model */
199 s_surf_model_description_t surf_new_model_description[] = {
202 surf_new_model_init_default},
203 {NULL, NULL, NULL} /* this array must be NULL terminated */
205 /* ********************************************************************* */
207 #ifdef CONTEXT_THREADS
208 static xbt_parmap_t surf_parmap = NULL; /* parallel map on models */
211 static double *surf_mins = NULL; /* return value of share_resources for each model */
212 static int surf_min_index; /* current index in surf_mins */
213 static double min; /* duration determined by surf_solve */
215 static void surf_share_resources(surf_model_t model);
216 static void surf_update_actions_state(surf_model_t model);
218 /** Displays the long description of all registered models, and quit */
219 void model_help(const char *category, s_surf_model_description_t * table)
222 printf("Long description of the %s models accepted by this simulator:\n",
224 for (i = 0; table[i].name; i++)
225 printf(" %s: %s\n", table[i].name, table[i].description);
228 int find_model_description(s_surf_model_description_t * table,
232 char *name_list = NULL;
234 for (i = 0; table[i].name; i++)
235 if (!strcmp(name, table[i].name)) {
238 name_list = strdup(table[0].name);
239 for (i = 1; table[i].name; i++) {
241 xbt_realloc(name_list,
242 strlen(name_list) + strlen(table[i].name) + 3);
243 strcat(name_list, ", ");
244 strcat(name_list, table[i].name);
246 xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
250 double generic_maxmin_share_resources(xbt_swag_t running_actions,
253 void (*solve) (lmm_system_t))
255 surf_action_t action = NULL;
258 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + (offset))))
262 xbt_swag_foreach(action, running_actions) {
263 value = lmm_variable_getvalue(VARIABLE(action));
264 if ((value > 0) || (action->max_duration >= 0))
272 if (action->remains > 0)
273 min = action->remains / value;
276 if ((action->max_duration >= 0) && (action->max_duration < min))
277 min = action->max_duration;
279 min = action->max_duration;
282 for (action = xbt_swag_getNext(action, running_actions->offset);
284 action = xbt_swag_getNext(action, running_actions->offset)) {
285 value = lmm_variable_getvalue(VARIABLE(action));
287 if (action->remains > 0)
288 value = action->remains / value;
293 XBT_DEBUG("Updating min (value) with %p: %f", action, min);
296 if ((action->max_duration >= 0) && (action->max_duration < min)) {
297 min = action->max_duration;
298 XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
301 XBT_DEBUG("min value : %f", min);
307 double generic_share_resources_lazy(double now, surf_model_t model)
309 surf_action_lmm_t action = NULL;
314 ("Before share resources, the size of modified actions set is %d",
315 xbt_swag_size(model->model_private->modified_set));
317 lmm_solve(model->model_private->maxmin_system);
320 ("After share resources, The size of modified actions set is %d",
321 xbt_swag_size(model->model_private->modified_set));
323 while((action = xbt_swag_extract(model->model_private->modified_set))) {
324 int max_dur_flag = 0;
326 if (action->generic_action.state_set !=
327 model->states.running_action_set)
330 /* bogus priority, skip it */
331 if (action->generic_action.priority <= 0)
334 generic_update_action_remaining_lazy(action,now);
337 value = lmm_variable_getvalue(action->variable);
339 if (action->generic_action.remains > 0) {
340 value = action->generic_action.remains / value;
348 if ((action->generic_action.max_duration != NO_MAX_DURATION)
350 || action->generic_action.start +
351 action->generic_action.max_duration < min)) {
352 min = action->generic_action.start +
353 action->generic_action.max_duration;
357 XBT_DEBUG("Action(%p) Start %lf Finish %lf Max_duration %lf", action,
358 action->generic_action.start, now + value,
359 action->generic_action.max_duration);
362 surf_action_lmm_heap_remove(model->model_private->action_heap,action);
363 surf_action_lmm_heap_insert(model->model_private->action_heap,action, min, max_dur_flag ? MAX_DURATION : NORMAL);
364 XBT_DEBUG("Insert at heap action(%p) min %lf now %lf", action, min,
366 } else DIE_IMPOSSIBLE;
369 //hereafter must have already the min value for this resource model
370 if (xbt_heap_size(model->model_private->action_heap) > 0)
371 min = xbt_heap_maxkey(model->model_private->action_heap) - now;
375 XBT_DEBUG("The minimum with the HEAP %lf", min);
379 static XBT_INLINE void routing_asr_host_free(void *p)
381 sg_routing_edge_t elm = p;
386 static XBT_INLINE void routing_asr_prop_free(void *p)
392 void sg_version(int *ver_major,int *ver_minor,int *ver_patch) {
393 *ver_major = SIMGRID_VERSION_MAJOR;
394 *ver_minor = SIMGRID_VERSION_MINOR;
395 *ver_patch = SIMGRID_VERSION_PATCH;
398 void surf_init(int *argc, char **argv)
400 XBT_DEBUG("Create all Libs");
401 host_lib = xbt_lib_new();
402 link_lib = xbt_lib_new();
403 as_router_lib = xbt_lib_new();
404 storage_lib = xbt_lib_new();
405 storage_type_lib = xbt_lib_new();
406 watched_hosts_lib = xbt_dict_new();
408 XBT_DEBUG("Add routing levels");
409 ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,routing_asr_host_free);
410 ROUTING_ASR_LEVEL = xbt_lib_add_level(as_router_lib,routing_asr_host_free);
411 ROUTING_PROP_ASR_LEVEL = xbt_lib_add_level(as_router_lib,routing_asr_prop_free);
413 XBT_DEBUG("Add SURF levels");
414 SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
415 SURF_WKS_LEVEL = xbt_lib_add_level(host_lib,surf_resource_free);
416 SURF_LINK_LEVEL = xbt_lib_add_level(link_lib,surf_resource_free);
418 xbt_init(argc, argv);
420 model_list = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
421 if (!model_list_invoke)
422 model_list_invoke = xbt_dynar_new(sizeof(surf_model_private_t), NULL);
424 history = tmgr_history_new();
427 TRACE_add_start_function(TRACE_surf_alloc);
428 TRACE_add_end_function(TRACE_surf_release);
431 sg_config_init(argc, argv);
439 # define FILE_DELIM "\\"
441 # define FILE_DELIM "/" /* FIXME: move to better location */
444 FILE *surf_fopen(const char *name, const char *mode)
447 char *path_elm = NULL;
453 if (__surf_is_absolute_file_path(name)) /* don't mess with absolute file names */
454 return fopen(name, mode);
456 /* search relative files in the path */
457 xbt_dynar_foreach(surf_path, cpt, path_elm) {
458 buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
459 file = fopen(buff, mode);
471 surf_model_t model = NULL;
473 sg_config_finalize();
475 xbt_dynar_foreach(model_list, iter, model)
476 model->model_private->finalize(model);
477 xbt_dynar_free(&model_list);
479 xbt_dynar_free(&model_list_invoke);
484 lmm_system_free(maxmin_system);
485 maxmin_system = NULL;
488 tmgr_history_free(history);
493 #ifdef CONTEXT_THREADS
494 xbt_parmap_destroy(surf_parmap);
499 xbt_dynar_free(&surf_path);
501 xbt_lib_free(&host_lib);
502 xbt_lib_free(&link_lib);
503 xbt_lib_free(&as_router_lib);
504 xbt_lib_free(&storage_lib);
505 xbt_lib_free(&storage_type_lib);
507 xbt_dict_free(&watched_hosts_lib);
510 surf_parse_lex_destroy();
511 surf_parse_free_callbacks();
513 NOW = 0; /* Just in case the user plans to restart the simulation afterward */
516 void surf_presolve(void)
518 double next_event_date = -1.0;
519 tmgr_trace_event_t event = NULL;
521 surf_resource_t resource = NULL;
522 surf_model_t model = NULL;
526 ("First Run! Let's \"purge\" events and put models in the right state");
527 while ((next_event_date = tmgr_history_next_date(history)) != -1.0) {
528 if (next_event_date > NOW)
531 tmgr_history_get_next_event_leq(history, next_event_date,
533 (void **) &resource))) {
535 resource->model->model_private->update_resource_state(resource,
542 /* FIXME: see what is check_update_action_state(). if necessary, use model_list_invoke. */
543 xbt_dynar_foreach(model_list, iter, model)
544 model->model_private->update_actions_state(model, NOW, 0.0);
547 double surf_solve(double max_date)
549 min = -1.0; /* duration */
550 double next_event_date = -1.0;
551 double model_next_action_end = -1.0;
553 surf_resource_t resource = NULL;
554 surf_model_t model = NULL;
555 tmgr_trace_event_t event = NULL;
558 if (max_date != -1.0 && max_date != NOW) {
559 min = max_date - NOW;
562 XBT_DEBUG("Looking for next action end for all models except NS3");
564 if (surf_mins == NULL) {
565 surf_mins = xbt_new(double, xbt_dynar_length(model_list_invoke));
569 /* sequential version */
570 xbt_dynar_foreach(model_list_invoke, iter, model) {
571 surf_share_resources(model);
575 for (i = 0; i < xbt_dynar_length(model_list_invoke); i++) {
576 if ((min < 0.0 || surf_mins[i] < min)
577 && surf_mins[i] >= 0.0) {
582 XBT_DEBUG("Min for resources (remember that NS3 don't update that value) : %f", min);
584 XBT_DEBUG("Looking for next trace event");
587 XBT_DEBUG("Next TRACE event : %f", next_event_date);
589 next_event_date = tmgr_history_next_date(history);
591 if(surf_network_model->name && !strcmp(surf_network_model->name,"network NS3")){
592 if(next_event_date!=-1.0 && min!=-1.0) {
593 min = MIN(next_event_date - NOW, min);
595 min = MAX(next_event_date - NOW, min);
598 XBT_DEBUG("Run for network at most %f", min);
599 // run until min or next flow
600 model_next_action_end = surf_network_model->model_private->share_resources(surf_network_model, min);
602 XBT_DEBUG("Min for network : %f", model_next_action_end);
603 if(model_next_action_end>=0.0)
604 min = model_next_action_end;
607 if (next_event_date < 0.0) {
608 XBT_DEBUG("no next TRACE event. Stop searching for it");
612 if ((min == -1.0) || (next_event_date > NOW + min)) break;
614 XBT_DEBUG("Updating models (min = %g, NOW = %g, next_event_date = %g)",min, NOW, next_event_date);
616 tmgr_history_get_next_event_leq(history, next_event_date,
618 (void **) &resource))) {
619 if (resource->model->model_private->resource_used(resource)) {
620 min = next_event_date - NOW;
622 ("This event will modify model state. Next event set to %f",
625 /* update state of model_obj according to new value. Does not touch lmm.
626 It will be modified if needed when updating actions */
627 XBT_DEBUG("Calling update_resource_state for resource %s with min %lf",
628 resource->model->name, min);
629 resource->model->model_private->update_resource_state(resource,
635 /* FIXME: Moved this test to here to avoid stopping simulation if there are actions running on cpus and all cpus are with availability = 0.
636 * This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a trace with periodicity > 0.
637 * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed */
639 XBT_DEBUG("No next event at all. Bail out now.");
643 XBT_DEBUG("Duration set to %f", min);
646 /* FIXME: model_list or model_list_invoke? revisit here later */
647 /* sequential version */
648 xbt_dynar_foreach(model_list, iter, model) {
649 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(model, 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(model, NOW, min);
682 /* This function is a pimple that we ought to fix. But it won't be easy.
684 * The surf_solve() function does properly return the set of actions that changed.
685 * Instead, each model change a global data, and then the caller of surf_solve must
686 * pick into these sets of action_failed and action_done.
688 * This was not clean but ok as long as we didn't had to restart the processes when the resource comes back up.
689 * We worked by putting sentinel actions on every resources we are interested in,
690 * so that surf informs us if/when the corresponding resource fails.
692 * But this does not work to get Simix informed of when a resource comes back up, and this is where this pimple comes.
693 * We have a set of resources that are currently down and for which simix needs to know when it comes back up.
694 * And the current function is called *at every simulation step* to sweep over that set, searching for a resource
695 * that was turned back up in the meanwhile. This is UGLY and slow.
697 * The proper solution would be to not rely on globals for the action_failed and action_done swags.
698 * They must be passed as parameter by the caller (the handling of these actions in simix may let you
699 * think that these two sets can be merged, but their handling in SimDag induce the contrary unless this
700 * simdag code can check by itself whether the action is done of failed -- seems very doable, but yet more
703 * Once surf_solve() is passed the set of actions that changed, you want to add a new set of resources back up
704 * as parameter to this function. You also want to add a boolean field "restart_watched" to each resource, and
705 * make sure that whenever a resource with this field enabled comes back up, it's added to that set so that Simix
706 * sees it and react accordingly. This would kill that need for surf to call simix.
710 static void remove_watched_host(void *key)
712 xbt_dict_remove(watched_hosts_lib, *(char**)key);
715 void surf_watched_hosts(void)
719 xbt_dict_cursor_t cursor;
720 xbt_dynar_t hosts = xbt_dynar_new(sizeof(char*), NULL);
722 XBT_DEBUG("Check for host SURF_RESOURCE_ON on watched_hosts_lib");
723 xbt_dict_foreach(watched_hosts_lib,cursor,key,host)
725 if(SIMIX_host_get_state(host) == SURF_RESOURCE_ON){
726 XBT_INFO("Restart processes on host: %s",SIMIX_host_get_name(host));
727 SIMIX_host_autorestart(host);
728 xbt_dynar_push_as(hosts, char*, key);
731 XBT_DEBUG("See SURF_RESOURCE_OFF on host: %s",key);
733 xbt_dynar_map(hosts, remove_watched_host);
734 xbt_dynar_free(&hosts);