1 /* Copyright (c) 2017-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. */
8 #include "simgrid/kernel/routing/NetPoint.hpp"
9 #include "simgrid/kernel/routing/StarZone.hpp"
10 #include "simgrid/s4u/Engine.hpp"
11 #include "simgrid/s4u/Host.hpp"
12 #include "simgrid/s4u/NetZone.hpp"
13 #include "src/surf/network_interface.hpp"
14 #include "src/surf/surf_interface.hpp" // create models
15 #include "src/surf/xml/platf_private.hpp" // RouteCreationArgs and friends
21 simgrid::s4u::Engine e;
24 EngineWrapper(std::string name) : argv(&name[0]), e(&argc, &argv) {}
28 TEST_CASE("kernel::routing::StarZone: Creating Zone", "[creation]")
30 EngineWrapper e("test");
32 REQUIRE(simgrid::s4u::create_star_zone("test"));
35 // One day we may be able to test contracts and asserts with catch2
36 // https://github.com/catchorg/Catch2/issues/853
37 TEST_CASE("kernel::routing::StarZone: Adding routes (hosts): assert", "[.][assert]")
39 EngineWrapper e("test");
40 auto* zone = new simgrid::kernel::routing::StarZone("test");
41 auto* netpoint1 = new simgrid::kernel::routing::NetPoint("netpoint1", simgrid::kernel::routing::NetPoint::Type::Host);
42 auto* netpoint2 = new simgrid::kernel::routing::NetPoint("netpoint2", simgrid::kernel::routing::NetPoint::Type::Host);
44 SECTION("src and dst: nullptr") { zone->add_route(nullptr, nullptr, nullptr, nullptr, {}, false); }
46 SECTION("src: nullptr and symmetrical: true") { zone->add_route(nullptr, netpoint2, nullptr, nullptr, {}, true); }
48 SECTION("src and dst: not nullptr") { zone->add_route(netpoint1, netpoint2, nullptr, nullptr, {}, false); }
51 TEST_CASE("kernel::routing::StarZone: Adding routes (netzones): assert", "[.][assert]")
53 EngineWrapper e("test");
54 auto* zone = new simgrid::kernel::routing::StarZone("test");
56 new simgrid::kernel::routing::NetPoint("netpoint1", simgrid::kernel::routing::NetPoint::Type::NetZone);
58 new simgrid::kernel::routing::NetPoint("netpoint2", simgrid::kernel::routing::NetPoint::Type::NetZone);
60 SECTION("src: is a netzone and gw_src: nullptr") { zone->add_route(netpoint1, nullptr, nullptr, nullptr, {}, false); }
62 SECTION("src: is a netzone and gw_src: is a netzone")
64 zone->add_route(netpoint1, nullptr, netpoint2, nullptr, {}, false);
67 SECTION("dst: is a netzone and gw_dst: nullptr") { zone->add_route(nullptr, netpoint2, nullptr, nullptr, {}, false); }
69 SECTION("dst: is a netzone and gw_dst: is a netzone")
71 zone->add_route(nullptr, netpoint2, nullptr, netpoint1, {}, false);
75 TEST_CASE("kernel::routing::StarZone: Get routes: assert", "[.][assert]")
77 /* workaround to initialize things, they must be done in this particular order */
78 EngineWrapper e("test");
79 auto* zone = new simgrid::kernel::routing::StarZone("test");
80 surf_network_model_init_LegrandVelho();
81 surf_cpu_model_init_Cas01();
83 const auto* host1 = zone->create_host("netpoint1", {100});
84 const auto* host2 = zone->create_host("netpoint2", {100});
85 std::vector<simgrid::kernel::resource::LinkImpl*> links;
86 links.push_back(zone->create_link("link1", {100})->get_impl());
87 std::vector<simgrid::kernel::resource::LinkImpl*> links2;
88 links2.push_back(zone->create_link("link2", {100})->get_impl());
90 SECTION("Get route: no UP link")
92 zone->add_route(host1->get_netpoint(), nullptr, nullptr, nullptr, links, true);
93 zone->add_route(nullptr, host2->get_netpoint(), nullptr, nullptr, links2, false);
95 simgrid::kernel::routing::RouteCreationArgs route;
96 zone->get_local_route(host2->get_netpoint(), host1->get_netpoint(), &route, &lat);
99 SECTION("Get route: no DOWN link")
101 zone->add_route(host1->get_netpoint(), nullptr, nullptr, nullptr, links, false);
102 zone->add_route(host2->get_netpoint(), nullptr, nullptr, nullptr, links2, true);
104 simgrid::kernel::routing::RouteCreationArgs route;
105 zone->get_local_route(host2->get_netpoint(), host1->get_netpoint(), &route, &lat);
109 TEST_CASE("kernel::routing::StarZone: Adding routes (hosts): valid", "")
111 EngineWrapper e("test");
112 auto* zone = new simgrid::kernel::routing::StarZone("test");
113 auto* netpoint = new simgrid::kernel::routing::NetPoint("netpoint1", simgrid::kernel::routing::NetPoint::Type::Host);
115 SECTION("Source set, destination nullptr, symmetrical true")
117 zone->add_route(netpoint, nullptr, nullptr, nullptr, {}, true);
120 SECTION("Source nullptr, destination set, symmetrical false")
122 zone->add_route(nullptr, netpoint, nullptr, nullptr, {}, false);
125 SECTION("Source set, destination nullptr, symmetrical false")
127 zone->add_route(netpoint, nullptr, nullptr, nullptr, {}, false);
130 SECTION("Source == destination") { zone->add_route(netpoint, netpoint, nullptr, nullptr, {}, false); }
133 TEST_CASE("kernel::routing::StarZone: Adding routes (netzones): valid", "")
135 EngineWrapper e("test");
136 auto* zone = new simgrid::kernel::routing::StarZone("test");
137 auto* netpoint = new simgrid::kernel::routing::NetPoint("netpoint1", simgrid::kernel::routing::NetPoint::Type::Host);
138 auto* gw = new simgrid::kernel::routing::NetPoint("gw1", simgrid::kernel::routing::NetPoint::Type::Router);
140 SECTION("src: is a netzone, src_gw: is a router") { zone->add_route(netpoint, nullptr, gw, nullptr, {}, true); }
142 SECTION("dst: is a netzone, dst_gw: is a router") { zone->add_route(nullptr, netpoint, nullptr, gw, {}, false); }
145 TEST_CASE("kernel::routing::StarZone: Get routes (hosts)", "")
147 /* workaround to initialize things, they must be done in this particular order */
148 EngineWrapper e("test");
149 auto* zone = new simgrid::kernel::routing::StarZone("test");
150 surf_network_model_init_LegrandVelho();
151 surf_cpu_model_init_Cas01();
153 const auto* host1 = zone->create_host("netpoint1", {100});
154 const auto* host2 = zone->create_host("netpoint2", {100});
156 SECTION("Get route: no shared link")
158 std::vector<simgrid::kernel::resource::LinkImpl*> links;
159 links.push_back(zone->create_link("link1", {100})->set_latency(10)->get_impl());
160 std::vector<simgrid::kernel::resource::LinkImpl*> links2;
161 links2.push_back(zone->create_link("link2", {200})->set_latency(20)->get_impl());
162 zone->add_route(host1->get_netpoint(), nullptr, nullptr, nullptr, links, true);
163 zone->add_route(host2->get_netpoint(), nullptr, nullptr, nullptr, links2, true);
167 simgrid::kernel::routing::RouteCreationArgs route;
168 zone->get_local_route(host1->get_netpoint(), host2->get_netpoint(), &route, &lat);
170 REQUIRE(route.gw_src == nullptr);
171 REQUIRE(route.gw_dst == nullptr);
172 REQUIRE(route.link_list.size() == 2);
173 REQUIRE(route.link_list[0]->get_name() == "link1");
174 REQUIRE(route.link_list[1]->get_name() == "link2");
177 SECTION("Get route: shared link(backbone)")
179 auto* backbone = zone->create_link("backbone", {1000})->set_latency(100)->get_impl();
180 std::vector<simgrid::kernel::resource::LinkImpl*> links;
181 links.push_back(zone->create_link("link1", {100})->set_latency(10)->get_impl());
182 links.push_back(backbone);
183 std::vector<simgrid::kernel::resource::LinkImpl*> links2;
184 links2.push_back(zone->create_link("link2", {200})->set_latency(20)->get_impl());
185 links2.push_back(backbone);
187 zone->add_route(host1->get_netpoint(), nullptr, nullptr, nullptr, links, true);
188 zone->add_route(host2->get_netpoint(), nullptr, nullptr, nullptr, links2, true);
192 simgrid::kernel::routing::RouteCreationArgs route;
193 zone->get_local_route(host1->get_netpoint(), host2->get_netpoint(), &route, &lat);
195 REQUIRE(route.link_list.size() == 3);
196 REQUIRE(route.link_list[0]->get_name() == "link1");
197 REQUIRE(route.link_list[1]->get_name() == "backbone");
198 REQUIRE(route.link_list[2]->get_name() == "link2");
201 SECTION("Get route: loopback")
203 auto* backbone = zone->create_link("backbone", {1000})->set_latency(100)->get_impl();
204 std::vector<simgrid::kernel::resource::LinkImpl*> links;
205 links.push_back(zone->create_link("link1", {100})->set_latency(10)->get_impl());
206 links.push_back(backbone);
208 zone->add_route(host1->get_netpoint(), host1->get_netpoint(), nullptr, nullptr, links, true);
212 simgrid::kernel::routing::RouteCreationArgs route;
213 zone->get_local_route(host1->get_netpoint(), host1->get_netpoint(), &route, &lat);
215 REQUIRE(route.link_list.size() == 2);
216 REQUIRE(route.link_list[0]->get_name() == "link1");
217 REQUIRE(route.link_list[1]->get_name() == "backbone");
221 TEST_CASE("kernel::routing::StarZone: Get routes (netzones)", "")
223 /* workaround to initialize things, they must be done in this particular order */
224 EngineWrapper e("test");
225 auto* zone = new simgrid::kernel::routing::StarZone("test");
226 surf_network_model_init_LegrandVelho();
227 surf_cpu_model_init_Cas01();
230 (new simgrid::kernel::routing::NetPoint("subzone1", simgrid::kernel::routing::NetPoint::Type::NetZone))
231 ->set_englobing_zone(zone);
233 (new simgrid::kernel::routing::NetPoint("subzone2", simgrid::kernel::routing::NetPoint::Type::NetZone))
234 ->set_englobing_zone(zone);
235 auto* router1 = new simgrid::kernel::routing::NetPoint("router1", simgrid::kernel::routing::NetPoint::Type::Router);
236 auto* router2 = new simgrid::kernel::routing::NetPoint("router2", simgrid::kernel::routing::NetPoint::Type::Router);
238 SECTION("Get route: netzone")
240 std::vector<simgrid::kernel::resource::LinkImpl*> links;
241 links.push_back(zone->create_link("link1", {100})->set_latency(10)->get_impl());
242 std::vector<simgrid::kernel::resource::LinkImpl*> links2;
243 links2.push_back(zone->create_link("link2", {200})->set_latency(20)->get_impl());
244 zone->add_route(subzone1, nullptr, router1, nullptr, links, true);
245 zone->add_route(subzone2, nullptr, router2, nullptr, links2, true);
249 simgrid::kernel::routing::RouteCreationArgs route;
250 zone->get_local_route(subzone1, subzone2, &route, &lat);
252 REQUIRE(route.gw_src == router1);
253 REQUIRE(route.gw_dst == router2);
254 REQUIRE(route.link_list.size() == 2);
255 REQUIRE(route.link_list[0]->get_name() == "link1");
256 REQUIRE(route.link_list[1]->get_name() == "link2");