1 /* Copyright (c) 2004-2021. 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/kernel/resource/profile/FutureEvtSet.hpp"
11 #include "src/kernel/resource/profile/Profile.hpp"
12 #include "src/surf/HostImpl.hpp"
13 #include "src/surf/xml/platf.hpp"
14 #include "src/xbt_modinter.h" /* whether initialization was already done */
15 #include "surf/surf.hpp"
16 #include "xbt/module.h"
25 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
26 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (kernel)");
32 std::vector<simgrid::kernel::resource::Model*> all_existing_models; /* to destroy models correctly */
34 simgrid::kernel::profile::FutureEvtSet future_evt_set;
35 std::vector<std::string> surf_path;
37 std::vector<surf_model_description_t>* surf_plugin_description = nullptr;
39 static void XBT_ATTRIB_DESTRUCTOR(800) simgrid_free_plugin_description()
41 delete surf_plugin_description;
42 surf_plugin_description = nullptr;
45 XBT_PUBLIC void simgrid_add_plugin_description(const char* name, const char* description, void_f_void_t init_fun)
47 if (not surf_plugin_description)
48 surf_plugin_description = new std::vector<surf_model_description_t>();
49 surf_plugin_description->emplace_back(surf_model_description_t{name, description, init_fun});
52 /* Don't forget to update the option description in smx_config when you change this */
53 const std::vector<surf_model_description_t> surf_network_model_description = {
55 "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},
59 "Simplistic network model where all communication take a constant time (one second). This model "
60 "provides the lowest realism, but is (marginally) faster.",
61 &surf_network_model_init_Constant},
63 "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},
69 "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of "
70 "small messages are thus poorly modeled).",
71 &surf_network_model_init_CM02},
72 {"ns-3", "Network pseudo-model using the ns-3 tcp model instead of an analytic model",
73 &surf_network_model_init_NS3},
77 void surf_network_model_init_SMPI()
79 xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
81 void surf_network_model_init_IB()
83 xbt_die("Please activate SMPI support in cmake to use the IB network model.");
87 void surf_network_model_init_NS3()
89 xbt_die("Please activate ns-3 support in cmake and install the dependencies to use the NS3 network model.");
93 const std::vector<surf_model_description_t> surf_cpu_model_description = {
94 {"Cas01", "Simplistic CPU model (time=size/speed).", &surf_cpu_model_init_Cas01},
97 const std::vector<surf_model_description_t> surf_host_model_description = {
98 {"default", "Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
99 &surf_host_model_init_current_default},
100 {"compound", "Host model that is automatically chosen if you change the network and CPU models",
101 &surf_host_model_init_compound},
102 {"ptask_L07", "Host model somehow similar to Cas01+CM02 but allowing parallel tasks",
103 &surf_host_model_init_ptask_L07},
106 const std::vector<surf_model_description_t> surf_optimization_mode_description = {
107 {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining).", nullptr},
109 "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU "
112 {"Full", "Full update of remaining and variables. Slow but may be useful when debugging.", nullptr},
115 const std::vector<surf_model_description_t> surf_disk_model_description = {
116 {"default", "Simplistic disk model.", &surf_disk_model_init_default},
121 double surf_get_clock()
126 /* returns whether #file_path is an absolute file path. Surprising, isn't it ? */
127 static bool is_absolute_file_path(const std::string& file_path)
130 WIN32_FIND_DATA wfd = {0};
131 HANDLE hFile = FindFirstFile(file_path.c_str(), &wfd);
133 if (INVALID_HANDLE_VALUE == hFile)
139 return (file_path.c_str()[0] == '/');
143 std::ifstream* surf_ifsopen(const std::string& name)
145 xbt_assert(not name.empty());
147 auto* fs = new std::ifstream();
148 if (is_absolute_file_path(name)) { /* don't mess with absolute file names */
149 fs->open(name.c_str(), std::ifstream::in);
152 /* search relative files in the path */
153 for (auto const& path_elm : surf_path) {
154 std::string buff = path_elm + "/" + name;
155 fs->open(buff.c_str(), std::ifstream::in);
157 if (not fs->fail()) {
158 XBT_DEBUG("Found file at %s", buff.c_str());
166 FILE* surf_fopen(const std::string& name, const char* mode)
168 FILE* file = nullptr;
170 if (is_absolute_file_path(name)) /* don't mess with absolute file names */
171 return fopen(name.c_str(), mode);
173 /* search relative files in the path */
174 for (auto const& path_elm : surf_path) {
175 std::string buff = path_elm + "/" + name;
176 file = fopen(buff.c_str(), mode);
184 /** Displays the long description of all registered models, and quit */
185 void model_help(const char* category, const std::vector<surf_model_description_t>& table)
187 XBT_HELP("Long description of the %s models accepted by this simulator:", category);
188 for (auto const& item : table)
189 XBT_HELP(" %s: %s", item.name, item.description);
192 int find_model_description(const std::vector<surf_model_description_t>& table, const std::string& name)
194 auto pos = std::find_if(table.begin(), table.end(),
195 [&name](const surf_model_description_t& item) { return item.name == name; });
196 if (pos != table.end())
197 return static_cast<int>(std::distance(table.begin(), pos));
200 xbt_die("No model is valid! This is a bug.");
203 std::string name_list;
204 for (auto const& item : table) {
205 name_list += sep + item.name;
209 xbt_die("Model '%s' is invalid! Valid models are: %s.", name.c_str(), name_list.c_str());
213 void surf_init(int* argc, char** argv)
215 if (xbt_initialized > 0)
218 xbt_init(argc, argv);
220 sg_config_init(argc, argv);
225 simgrid::s4u::Engine::shutdown();
227 for (auto const& model : all_existing_models)
233 NOW = 0; /* Just in case the user plans to restart the simulation afterward */