1 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "surf_interface.hpp"
8 #include "simgrid/s4u/Engine.hpp"
9 #include "simgrid/sg_config.hpp"
10 #include "src/internal_config.h"
11 #include "src/surf/HostImpl.hpp"
12 #include "src/surf/xml/platf.hpp"
13 #include "surf/surf.hpp"
14 #include "xbt/module.h"
23 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (kernel)");
30 std::vector<simgrid::kernel::resource::Model*> all_existing_models; /* to destroy models correctly */
32 simgrid::trace_mgr::future_evt_set *future_evt_set = nullptr;
33 std::vector<std::string> surf_path;
34 std::vector<simgrid::s4u::Host*> host_that_restart;
35 /** set of hosts for which one want to be notified if they ever restart. */
36 std::set<std::string> watched_hosts;
37 extern std::map<std::string, simgrid::surf::StorageType*> storage_types;
39 s_surf_model_description_t* surf_plugin_description = nullptr;
40 XBT_PUBLIC void simgrid_add_plugin_description(const char* name, const char* description, void_f_void_t init_fun)
42 static int plugin_amount = 0;
44 /* no need to check for plugin name conflict: the compiler already ensures that the generated
45 * simgrid_##id##_plugin_register() is unique */
48 surf_plugin_description = static_cast<s_surf_model_description_t*>(
49 xbt_realloc(surf_plugin_description, sizeof(s_surf_model_description_t) * (plugin_amount + 2)));
51 surf_plugin_description[plugin_amount - 1] = {name, description, init_fun};
52 surf_plugin_description[plugin_amount] = {nullptr, nullptr, nullptr}; // this array must be null terminated
55 /* Don't forget to update the option description in smx_config when you change this */
56 s_surf_model_description_t surf_network_model_description[] = {
57 {"LV08", "Realistic network analytic model (slow-start modeled by multiplying latency by 13.01, bandwidth by .97; "
58 "bottleneck sharing uses a payload of S=20537 for evaluating RTT). ",
59 &surf_network_model_init_LegrandVelho},
60 {"Constant", "Simplistic network model where all communication take a constant time (one second). This model "
61 "provides the lowest realism, but is (marginally) faster.",
62 &surf_network_model_init_Constant},
63 {"SMPI", "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with "
64 "correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
65 &surf_network_model_init_SMPI},
66 {"IB", "Realistic network model specifically tailored for HPC settings, with Infiniband contention model",
67 &surf_network_model_init_IB},
68 {"CM02", "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of "
69 "small messages are thus poorly modeled).",
70 &surf_network_model_init_CM02},
71 {"NS3", "Network pseudo-model using the NS3 tcp model instead of an analytic model", &surf_network_model_init_NS3},
73 "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
74 &surf_network_model_init_Reno},
76 "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
77 &surf_network_model_init_Reno2},
79 "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
80 &surf_network_model_init_Vegas},
81 {nullptr, nullptr, nullptr} /* this array must be nullptr terminated */
85 void surf_network_model_init_SMPI() {
86 xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
88 void surf_network_model_init_IB() {
89 xbt_die("Please activate SMPI support in cmake to use the IB network model.");
93 void surf_network_model_init_NS3() {
94 xbt_die("Please activate NS3 support in cmake and install the dependencies to use the NS3 network model.");
98 s_surf_model_description_t surf_cpu_model_description[] = {
99 {"Cas01", "Simplistic CPU model (time=size/power).", &surf_cpu_model_init_Cas01},
100 {nullptr, nullptr, nullptr} /* this array must be nullptr terminated */
103 s_surf_model_description_t surf_host_model_description[] = {
104 {"default", "Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)", &surf_host_model_init_current_default},
105 {"compound", "Host model that is automatically chosen if you change the network and CPU models", &surf_host_model_init_compound},
106 {"ptask_L07", "Host model somehow similar to Cas01+CM02 but allowing parallel tasks", &surf_host_model_init_ptask_L07},
107 {nullptr, nullptr, nullptr} /* this array must be nullptr terminated */
110 s_surf_model_description_t surf_optimization_mode_description[] = {
111 {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining).", nullptr},
112 {"TI", "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU model for now).", nullptr},
113 {"Full", "Full update of remaining and variables. Slow but may be useful when debugging.", nullptr},
114 {nullptr, nullptr, nullptr} /* this array must be nullptr terminated */
117 s_surf_model_description_t surf_storage_model_description[] = {
118 {"default", "Simplistic storage model.", &surf_storage_model_init_default},
119 {nullptr, nullptr, nullptr} /* this array must be nullptr terminated */
124 double surf_get_clock()
129 /* returns whether #file_path is a absolute file path. Surprising, isn't it ? */
130 static bool is_absolute_file_path(const char* file_path)
133 WIN32_FIND_DATA wfd = {0};
134 HANDLE hFile = FindFirstFile(file_path, &wfd);
136 if (INVALID_HANDLE_VALUE == hFile)
142 return (file_path[0] == '/');
146 std::ifstream* surf_ifsopen(std::string name)
148 xbt_assert(not name.empty());
150 std::ifstream* fs = new std::ifstream();
151 if (is_absolute_file_path(name.c_str())) { /* don't mess with absolute file names */
152 fs->open(name.c_str(), std::ifstream::in);
155 /* search relative files in the path */
156 for (auto const& path_elm : surf_path) {
157 std::string buff = path_elm + "/" + name;
158 fs->open(buff.c_str(), std::ifstream::in);
160 if (not fs->fail()) {
161 XBT_DEBUG("Found file at %s", buff.c_str());
169 FILE *surf_fopen(const char *name, const char *mode)
171 FILE *file = nullptr;
175 if (is_absolute_file_path(name)) /* don't mess with absolute file names */
176 return fopen(name, mode);
178 /* search relative files in the path */
179 for (auto const& path_elm : surf_path) {
180 std::string buff = path_elm + "/" + name;
181 file = fopen(buff.c_str(), mode);
189 /** Displays the long description of all registered models, and quit */
190 void model_help(const char *category, s_surf_model_description_t * table)
192 printf("Long description of the %s models accepted by this simulator:\n", category);
193 for (int i = 0; table[i].name; i++)
194 printf(" %s: %s\n", table[i].name, table[i].description);
197 int find_model_description(s_surf_model_description_t* table, std::string name)
199 for (int i = 0; table[i].name; i++)
200 if (name == table[i].name)
203 if (not table[0].name)
204 xbt_die("No model is valid! This is a bug.");
206 std::string name_list = std::string(table[0].name);
207 for (int i = 1; table[i].name; i++)
208 name_list = name_list + ", " + table[i].name;
210 xbt_die("Model '%s' is invalid! Valid models are: %s.", name.c_str(), name_list.c_str());
214 void sg_version_check(int lib_version_major, int lib_version_minor, int lib_version_patch)
216 if ((lib_version_major != SIMGRID_VERSION_MAJOR) || (lib_version_minor != SIMGRID_VERSION_MINOR)) {
217 fprintf(stderr, "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
218 "and then linked against SimGrid %d.%d.%d. Please fix this.\n",
219 lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
220 SIMGRID_VERSION_PATCH);
223 if (lib_version_patch != SIMGRID_VERSION_PATCH) {
224 if (SIMGRID_VERSION_PATCH >= 90 || lib_version_patch >= 90) {
227 "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
228 "and then linked against SimGrid %d.%d.%d. \n"
229 "One of them is a development version, and should not be mixed with the stable release. Please fix this.\n",
230 lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
231 SIMGRID_VERSION_PATCH);
234 fprintf(stderr, "Warning: Your program was compiled with SimGrid version %d.%d.%d, "
235 "and then linked against SimGrid %d.%d.%d. Proceeding anyway.\n",
236 lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
237 SIMGRID_VERSION_PATCH);
241 void sg_version_get(int* ver_major, int* ver_minor, int* ver_patch)
243 *ver_major = SIMGRID_VERSION_MAJOR;
244 *ver_minor = SIMGRID_VERSION_MINOR;
245 *ver_patch = SIMGRID_VERSION_PATCH;
250 std::printf("This program was linked against %s (git: %s), found in %s.\n",
251 SIMGRID_VERSION_STRING, SIMGRID_GIT_VERSION, SIMGRID_INSTALL_PREFIX);
254 std::printf(" Model-checking support compiled in.\n");
256 std::printf(" Model-checking support disabled at compilation.\n");
260 std::printf(" NS3 support compiled in.\n");
262 std::printf(" NS3 support disabled at compilation.\n");
265 #if SIMGRID_HAVE_JEDULE
266 std::printf(" Jedule support compiled in.\n");
268 std::printf(" Jedule support disabled at compilation.\n");
272 std::printf(" Lua support compiled in.\n");
274 std::printf(" Lua support disabled at compilation.\n");
277 #if SIMGRID_HAVE_MALLOCATOR
278 std::printf(" Mallocator support compiled in.\n");
280 std::printf(" Mallocator support disabled at compilation.\n");
283 std::printf("\nTo cite SimGrid in a publication, please use:\n"
284 " Henri Casanova, Arnaud Giersch, Arnaud Legrand, Martin Quinson, Frédéric Suter. \n"
285 " Versatile, Scalable, and Accurate Simulation of Distributed Applications and Platforms. \n"
286 " Journal of Parallel and Distributed Computing, Elsevier, 2014, 74 (10), pp.2899-2917.\n");
287 std::printf("The pdf file and a BibTeX entry for LaTeX users can be found at http://hal.inria.fr/hal-01017319\n");
290 void surf_init(int *argc, char **argv)
292 if (USER_HOST_LEVEL != -1) // Already initialized
295 XBT_DEBUG("Create all Libs");
296 USER_HOST_LEVEL = simgrid::s4u::Host::extension_create(nullptr);
298 xbt_init(argc, argv);
299 if (not future_evt_set)
300 future_evt_set = new simgrid::trace_mgr::future_evt_set();
302 sg_config_init(argc, argv);
310 simgrid::s4u::Engine::shutdown();
311 for (auto const& e : storage_types) {
312 simgrid::surf::StorageType* stype = e.second;
313 delete stype->properties;
314 delete stype->model_properties;
318 for (auto const& model : all_existing_models)
321 xbt_free(surf_plugin_description);
323 delete future_evt_set;
324 future_evt_set = nullptr;
329 NOW = 0; /* Just in case the user plans to restart the simulation afterward */