Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove unused type definitions.
[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/internal_config.h"
11 #include "src/simgrid/version.h"
12 #include "src/surf/HostImpl.hpp"
13 #include "src/surf/xml/platf.hpp"
14 #include "surf/surf.hpp"
15 #include "xbt/module.h"
16
17 #include <fstream>
18 #include <string>
19
20 #ifdef _WIN32
21 #include <windows.h>
22 #endif
23
24 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (kernel)");
26
27 /*********
28  * Utils *
29  *********/
30
31 std::vector<simgrid::kernel::resource::Model*> all_existing_models; /* to destroy models correctly */
32
33 simgrid::kernel::profile::FutureEvtSet future_evt_set;
34 std::vector<std::string> surf_path;
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::kernel::resource::StorageType*> storage_types;
38
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)
41 {
42   static int plugin_amount = 0;
43
44   /* no need to check for plugin name conflict: the compiler already ensures that the generated
45    * simgrid_##id##_plugin_register() is unique */
46
47   plugin_amount++;
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)));
50
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
53 }
54
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},
72     {"Reno",
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},
75     {"Reno2",
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},
78     {"Vegas",
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 */
82 };
83
84 #if ! HAVE_SMPI
85 void surf_network_model_init_SMPI() {
86   xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
87 }
88 void surf_network_model_init_IB() {
89   xbt_die("Please activate SMPI support in cmake to use the IB network model.");
90 }
91 #endif
92 #if !SIMGRID_HAVE_NS3
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.");
95 }
96 #endif
97
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 */
101 };
102
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 */
108 };
109
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 */
115 };
116
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 */
120 };
121
122 double NOW = 0;
123
124 double surf_get_clock()
125 {
126   return NOW;
127 }
128
129 /* returns whether #file_path is a absolute file path. Surprising, isn't it ? */
130 static bool is_absolute_file_path(const std::string& file_path)
131 {
132 #ifdef _WIN32
133   WIN32_FIND_DATA wfd = {0};
134   HANDLE hFile        = FindFirstFile(file_path.c_str(), &wfd);
135
136   if (INVALID_HANDLE_VALUE == hFile)
137     return false;
138
139   FindClose(hFile);
140   return true;
141 #else
142   return (file_path.c_str()[0] == '/');
143 #endif
144 }
145
146 std::ifstream* surf_ifsopen(const std::string& name)
147 {
148   xbt_assert(not name.empty());
149
150   std::ifstream* fs = new std::ifstream();
151   if (is_absolute_file_path(name)) { /* don't mess with absolute file names */
152     fs->open(name.c_str(), std::ifstream::in);
153   }
154
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);
159
160     if (not fs->fail()) {
161       XBT_DEBUG("Found file at %s", buff.c_str());
162       return fs;
163     }
164   }
165
166   return fs;
167 }
168
169 FILE* surf_fopen(const std::string& name, const char* mode)
170 {
171   FILE *file = nullptr;
172
173   if (is_absolute_file_path(name)) /* don't mess with absolute file names */
174     return fopen(name.c_str(), mode);
175
176   /* search relative files in the path */
177   for (auto const& path_elm : surf_path) {
178     std::string buff = path_elm + "/" + name;
179     file             = fopen(buff.c_str(), mode);
180
181     if (file)
182       return file;
183   }
184   return nullptr;
185 }
186
187 /** Displays the long description of all registered models, and quit */
188 void model_help(const char *category, s_surf_model_description_t * table)
189 {
190   printf("Long description of the %s models accepted by this simulator:\n", category);
191   for (int i = 0; table[i].name; i++)
192     printf("  %s: %s\n", table[i].name, table[i].description);
193 }
194
195 int find_model_description(s_surf_model_description_t* table, const std::string& name)
196 {
197   for (int i = 0; table[i].name; i++)
198     if (name == table[i].name)
199       return i;
200
201   if (not table[0].name)
202     xbt_die("No model is valid! This is a bug.");
203
204   std::string name_list = std::string(table[0].name);
205   for (int i = 1; table[i].name; i++)
206     name_list = name_list + ", " + table[i].name;
207
208   xbt_die("Model '%s' is invalid! Valid models are: %s.", name.c_str(), name_list.c_str());
209   return -1;
210 }
211
212 void sg_version_check(int lib_version_major, int lib_version_minor, int lib_version_patch)
213 {
214   if ((lib_version_major != SIMGRID_VERSION_MAJOR) || (lib_version_minor != SIMGRID_VERSION_MINOR)) {
215     fprintf(stderr, "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
216                     "and then linked against SimGrid %d.%d.%d. Please fix this.\n",
217             lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
218             SIMGRID_VERSION_PATCH);
219     abort();
220   }
221   if (lib_version_patch != SIMGRID_VERSION_PATCH) {
222     if (SIMGRID_VERSION_PATCH > 89 || lib_version_patch > 89) {
223       fprintf(
224           stderr,
225           "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
226           "and then linked against SimGrid %d.%d.%d. \n"
227           "One of them is a development version, and should not be mixed with the stable release. Please fix this.\n",
228           lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
229           SIMGRID_VERSION_PATCH);
230       abort();
231     }
232     fprintf(stderr, "Warning: Your program was compiled with SimGrid version %d.%d.%d, "
233                     "and then linked against SimGrid %d.%d.%d. Proceeding anyway.\n",
234             lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
235             SIMGRID_VERSION_PATCH);
236   }
237 }
238
239 void sg_version_get(int* ver_major, int* ver_minor, int* ver_patch)
240 {
241   *ver_major = SIMGRID_VERSION_MAJOR;
242   *ver_minor = SIMGRID_VERSION_MINOR;
243   *ver_patch = SIMGRID_VERSION_PATCH;
244 }
245
246 void sg_version()
247 {
248   std::printf("This program was linked against %s (git: %s), found in %s.\n",
249               SIMGRID_VERSION_STRING, SIMGRID_GIT_VERSION, SIMGRID_INSTALL_PREFIX);
250
251 #if SIMGRID_HAVE_MC
252   std::printf("   Model-checking support compiled in.\n");
253 #else
254   std::printf("   Model-checking support disabled at compilation.\n");
255 #endif
256
257 #if SIMGRID_HAVE_NS3
258   std::printf("   NS3 support compiled in.\n");
259 #else
260   std::printf("   NS3 support disabled at compilation.\n");
261 #endif
262
263 #if SIMGRID_HAVE_JEDULE
264   std::printf("   Jedule support compiled in.\n");
265 #else
266   std::printf("   Jedule support disabled at compilation.\n");
267 #endif
268
269 #if SIMGRID_HAVE_LUA
270   std::printf("   Lua support compiled in.\n");
271 #else
272   std::printf("   Lua support disabled at compilation.\n");
273 #endif
274
275 #if SIMGRID_HAVE_MALLOCATOR
276   std::printf("   Mallocator support compiled in.\n");
277 #else
278   std::printf("   Mallocator support disabled at compilation.\n");
279 #endif
280
281   std::printf("\nTo cite SimGrid in a publication, please use:\n"
282               "   Henri Casanova, Arnaud Giersch, Arnaud Legrand, Martin Quinson, Frédéric Suter. \n"
283               "   Versatile, Scalable, and Accurate Simulation of Distributed Applications and Platforms. \n"
284               "   Journal of Parallel and Distributed Computing, Elsevier, 2014, 74 (10), pp.2899-2917.\n");
285   std::printf("The pdf file and a BibTeX entry for LaTeX users can be found at http://hal.inria.fr/hal-01017319\n");
286 }
287
288 void surf_init(int *argc, char **argv)
289 {
290   if (USER_HOST_LEVEL != -1) // Already initialized
291     return;
292
293   XBT_DEBUG("Create all Libs");
294   USER_HOST_LEVEL = simgrid::s4u::Host::extension_create(nullptr);
295
296   xbt_init(argc, argv);
297
298   sg_config_init(argc, argv);
299
300   if (MC_is_active())
301     MC_memory_init();
302 }
303
304 void surf_exit()
305 {
306   simgrid::s4u::Engine::shutdown();
307   for (auto const& e : storage_types) {
308     simgrid::kernel::resource::StorageType* stype = e.second;
309     delete stype->properties;
310     delete stype->model_properties;
311     delete stype;
312   }
313
314   for (auto const& model : all_existing_models)
315     delete model;
316
317   xbt_free(surf_plugin_description);
318
319   tmgr_finalize();
320   sg_platf_exit();
321
322   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
323 }