Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Add attribute "noreturn" to non-returning functions.
[simgrid.git] / src / surf / surf_interface.cpp
1 /* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include "surf_interface.hpp"
7 #include "mc/mc.h"
8 #include "simgrid/s4u/Engine.hpp"
9 #include "simgrid/sg_config.hpp"
10 #include "src/simgrid/version.h"
11 #include "src/surf/HostImpl.hpp"
12 #include "src/surf/xml/platf.hpp"
13 #include "surf/surf.hpp"
14 #include "xbt/module.h"
15
16 #include <fstream>
17 #include <string>
18
19 #ifdef _WIN32
20 #include <windows.h>
21 #endif
22
23 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (kernel)");
25
26 /*********
27  * Utils *
28  *********/
29
30 std::vector<simgrid::kernel::resource::Model*> all_existing_models; /* to destroy models correctly */
31
32 simgrid::kernel::profile::FutureEvtSet future_evt_set;
33 std::vector<std::string> surf_path;
34 /**  set of hosts for which one want to be notified if they ever restart. */
35 std::set<std::string> watched_hosts;
36 extern std::map<std::string, simgrid::kernel::resource::StorageType*> storage_types;
37
38 std::vector<surf_model_description_t>* surf_plugin_description = nullptr;
39
40 static void XBT_ATTRIB_DESTRUCTOR(800) simgrid_free_plugin_description()
41 {
42   delete surf_plugin_description;
43   surf_plugin_description = nullptr;
44 }
45
46 XBT_PUBLIC void simgrid_add_plugin_description(const char* name, const char* description, void_f_void_t init_fun)
47 {
48   if (not surf_plugin_description)
49     surf_plugin_description = new std::vector<surf_model_description_t>;
50   surf_plugin_description->emplace_back(surf_model_description_t{name, description, init_fun});
51 }
52
53 /* Don't forget to update the option description in smx_config when you change this */
54 const std::vector<surf_model_description_t> surf_network_model_description = {
55     {"LV08", "Realistic network analytic model (slow-start modeled by multiplying latency by 13.01, bandwidth by .97; "
56              "bottleneck sharing uses a payload of S=20537 for evaluating RTT). ",
57      &surf_network_model_init_LegrandVelho},
58     {"Constant", "Simplistic network model where all communication take a constant time (one second). This model "
59                  "provides the lowest realism, but is (marginally) faster.",
60      &surf_network_model_init_Constant},
61     {"SMPI", "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with "
62              "correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
63      &surf_network_model_init_SMPI},
64     {"IB", "Realistic network model specifically tailored for HPC settings, with Infiniband contention model",
65      &surf_network_model_init_IB},
66     {"CM02", "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of "
67              "small messages are thus poorly modeled).",
68      &surf_network_model_init_CM02},
69     {"NS3", "Network pseudo-model using the NS3 tcp model instead of an analytic model", &surf_network_model_init_NS3},
70     {"Reno",
71      "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
72      &surf_network_model_init_Reno},
73     {"Reno2",
74      "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
75      &surf_network_model_init_Reno2},
76     {"Vegas",
77      "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
78      &surf_network_model_init_Vegas},
79 };
80
81 #if ! HAVE_SMPI
82 void surf_network_model_init_SMPI() {
83   xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
84 }
85 void surf_network_model_init_IB() {
86   xbt_die("Please activate SMPI support in cmake to use the IB network model.");
87 }
88 #endif
89 #if !SIMGRID_HAVE_NS3
90 void surf_network_model_init_NS3() {
91   xbt_die("Please activate NS3 support in cmake and install the dependencies to use the NS3 network model.");
92 }
93 #endif
94
95 const std::vector<surf_model_description_t> surf_cpu_model_description = {
96     {"Cas01", "Simplistic CPU model (time=size/power).", &surf_cpu_model_init_Cas01},
97 };
98
99 const std::vector<surf_model_description_t> surf_host_model_description = {
100     {"default", "Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
101      &surf_host_model_init_current_default},
102     {"compound", "Host model that is automatically chosen if you change the network and CPU models",
103      &surf_host_model_init_compound},
104     {"ptask_L07", "Host model somehow similar to Cas01+CM02 but allowing parallel tasks",
105      &surf_host_model_init_ptask_L07},
106 };
107
108 const std::vector<surf_model_description_t> surf_optimization_mode_description = {
109     {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining).", nullptr},
110     {"TI", "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU "
111            "model for now).",
112      nullptr},
113     {"Full", "Full update of remaining and variables. Slow but may be useful when debugging.", nullptr},
114 };
115
116 const std::vector<surf_model_description_t> surf_storage_model_description = {
117     {"default", "Simplistic storage model.", &surf_storage_model_init_default},
118 };
119
120 double NOW = 0;
121
122 double surf_get_clock()
123 {
124   return NOW;
125 }
126
127 /* returns whether #file_path is a absolute file path. Surprising, isn't it ? */
128 static bool is_absolute_file_path(const std::string& file_path)
129 {
130 #ifdef _WIN32
131   WIN32_FIND_DATA wfd = {0};
132   HANDLE hFile        = FindFirstFile(file_path.c_str(), &wfd);
133
134   if (INVALID_HANDLE_VALUE == hFile)
135     return false;
136
137   FindClose(hFile);
138   return true;
139 #else
140   return (file_path.c_str()[0] == '/');
141 #endif
142 }
143
144 std::ifstream* surf_ifsopen(const std::string& name)
145 {
146   xbt_assert(not name.empty());
147
148   std::ifstream* fs = new std::ifstream();
149   if (is_absolute_file_path(name)) { /* don't mess with absolute file names */
150     fs->open(name.c_str(), std::ifstream::in);
151   }
152
153   /* search relative files in the path */
154   for (auto const& path_elm : surf_path) {
155     std::string buff = path_elm + "/" + name;
156     fs->open(buff.c_str(), std::ifstream::in);
157
158     if (not fs->fail()) {
159       XBT_DEBUG("Found file at %s", buff.c_str());
160       return fs;
161     }
162   }
163
164   return fs;
165 }
166
167 FILE* surf_fopen(const std::string& name, const char* mode)
168 {
169   FILE *file = nullptr;
170
171   if (is_absolute_file_path(name)) /* don't mess with absolute file names */
172     return fopen(name.c_str(), mode);
173
174   /* search relative files in the path */
175   for (auto const& path_elm : surf_path) {
176     std::string buff = path_elm + "/" + name;
177     file             = fopen(buff.c_str(), mode);
178
179     if (file)
180       return file;
181   }
182   return nullptr;
183 }
184
185 /** Displays the long description of all registered models, and quit */
186 void model_help(const char* category, const std::vector<surf_model_description_t>& table)
187 {
188   XBT_HELP("Long description of the %s models accepted by this simulator:", category);
189   for (auto const& item : table)
190     XBT_HELP("  %s: %s", item.name, item.description);
191 }
192
193 int find_model_description(const std::vector<surf_model_description_t>& table, const std::string& name)
194 {
195   auto pos = std::find_if(table.begin(), table.end(),
196                           [&name](const surf_model_description_t& item) { return item.name == name; });
197   if (pos != table.end())
198     return std::distance(table.begin(), pos);
199
200   if (table.empty())
201     xbt_die("No model is valid! This is a bug.");
202
203   std::string sep;
204   std::string name_list;
205   for (auto const& item : table) {
206     name_list += sep + item.name;
207     sep = ", ";
208   }
209
210   xbt_die("Model '%s' is invalid! Valid models are: %s.", name.c_str(), name_list.c_str());
211   return -1;
212 }
213
214 void sg_version_check(int lib_version_major, int lib_version_minor, int lib_version_patch)
215 {
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);
221     abort();
222   }
223   if (lib_version_patch != SIMGRID_VERSION_PATCH) {
224     if (SIMGRID_VERSION_PATCH > 89 || lib_version_patch > 89) {
225       fprintf(
226           stderr,
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);
232       abort();
233     }
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);
238   }
239 }
240
241 void sg_version_get(int* ver_major, int* ver_minor, int* ver_patch)
242 {
243   *ver_major = SIMGRID_VERSION_MAJOR;
244   *ver_minor = SIMGRID_VERSION_MINOR;
245   *ver_patch = SIMGRID_VERSION_PATCH;
246 }
247
248 void sg_version()
249 {
250   XBT_HELP("This program was linked against %s (git: %s), found in %s.", SIMGRID_VERSION_STRING, SIMGRID_GIT_VERSION,
251            SIMGRID_INSTALL_PREFIX);
252
253 #if SIMGRID_HAVE_MC
254   XBT_HELP("   Model-checking support compiled in.");
255 #else
256   XBT_HELP("   Model-checking support disabled at compilation.");
257 #endif
258
259 #if SIMGRID_HAVE_NS3
260   XBT_HELP("   NS3 support compiled in.");
261 #else
262   XBT_HELP("   NS3 support disabled at compilation.");
263 #endif
264
265 #if SIMGRID_HAVE_JEDULE
266   XBT_HELP("   Jedule support compiled in.");
267 #else
268   XBT_HELP("   Jedule support disabled at compilation.");
269 #endif
270
271 #if SIMGRID_HAVE_LUA
272   XBT_HELP("   Lua support compiled in.");
273 #else
274   XBT_HELP("   Lua support disabled at compilation.");
275 #endif
276
277 #if SIMGRID_HAVE_MALLOCATOR
278   XBT_HELP("   Mallocator support compiled in.");
279 #else
280   XBT_HELP("   Mallocator support disabled at compilation.");
281 #endif
282
283   XBT_HELP("\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            "The pdf file and a BibTeX entry for LaTeX users can be found at http://hal.inria.fr/hal-01017319");
288 }
289
290 void surf_init(int *argc, char **argv)
291 {
292   if (USER_HOST_LEVEL != -1) // Already initialized
293     return;
294
295   XBT_DEBUG("Create all Libs");
296   USER_HOST_LEVEL = simgrid::s4u::Host::extension_create(nullptr);
297
298   xbt_init(argc, argv);
299
300   sg_config_init(argc, argv);
301
302   if (MC_is_active())
303     MC_memory_init();
304 }
305
306 void surf_exit()
307 {
308   simgrid::s4u::Engine::shutdown();
309   for (auto const& e : storage_types) {
310     simgrid::kernel::resource::StorageType* stype = e.second;
311     delete stype->properties;
312     delete stype->model_properties;
313     delete stype;
314   }
315
316   for (auto const& model : all_existing_models)
317     delete model;
318
319   tmgr_finalize();
320   sg_platf_exit();
321
322   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
323 }