1 /* Copyright (c) 2013-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 #ifndef SIMGRID_ROUTING_GENERIC_HPP_
7 #define SIMGRID_ROUTING_GENERIC_HPP_
9 #include <simgrid/kernel/routing/NetZoneImpl.hpp>
15 /** @ingroup ROUTING_API
16 * @brief NetZone with an explicit routing (abstract class)
18 * This abstract class factorizes code between its subclasses: Full, Dijkstra and Floyd.
21 * <caption>Comparison of the RoutedZone subclasses</caption>
22 * <tr><td></td><td>DijkstraZone</td><td>FloydZone</td><td>FullZone</td></tr>
23 * <tr><td><b>Platform-file content</b></td>
24 * <td>Only 1-hop routes (rather small)</td>
25 * <td>Only 1-hop routes (rather small)</td>
26 * <td>Every path, explicitly (very large)</td>
28 * <tr><td><b>Initialization time</b></td>
29 * <td>Almost nothing</td>
30 * <td>Floyd-Warshall algorithm: O(n^3)</td>
31 * <td>Almost nothing</td>
33 * <tr><td><b>Memory usage</b></td>
34 * <td>1-hop routes (+ cache of routes)</td>
35 * <td>O(n^2) data (intermediate)</td>
36 * <td>O(n^2) + sum of path lengths (very large)</td>
38 * <tr><td><b>Lookup time</b></td>
39 * <td>Dijkstra Algo: O(n^3)</td>
40 * <td>not much (reconstruction phase)</td>
41 * <td>Almost nothing</td>
43 * <tr><td><b>Expressiveness</b></td>
44 * <td>Only shortest path</td>
45 * <td>Only shortest path</td>
51 class XBT_PRIVATE RoutedZone : public NetZoneImpl {
53 explicit RoutedZone(NetZoneImpl* father, const std::string& name, resource::NetworkModel* netmodel);
55 void get_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
56 std::map<std::string, xbt_edge_t, std::less<>>* edges) override;
59 RouteCreationArgs* new_extended_route(RoutingMode hierarchy, NetPoint* gw_src, NetPoint* gw_dst,
60 const std::vector<resource::LinkImpl*>& link_list, bool preserve_order);
61 XBT_ATTRIB_DEPRECATED_v330("Please drop 2nd, 3rd and 7th parameters") virtual RouteCreationArgs* new_extended_route(
62 RoutingMode hierarchy, NetPoint* /* src */, NetPoint* /* dst */, NetPoint* gw_src, NetPoint* gw_dst,
63 std::vector<resource::LinkImpl*>& link_list, bool /* symmetrical */, bool preserve_order)
65 return new_extended_route(hierarchy, gw_src, gw_dst, link_list, preserve_order);
67 void get_route_check_params(NetPoint* src, NetPoint* dst) const;
68 void add_route_check_params(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
69 const std::vector<resource::LinkImpl*>& link_list, bool symmetrical) const;
71 } // namespace routing
73 } // namespace simgrid
75 XBT_PRIVATE xbt_node_t new_xbt_graph_node(const s_xbt_graph_t* graph, const char* name,
76 std::map<std::string, xbt_node_t, std::less<>>* nodes);
77 XBT_PRIVATE xbt_edge_t new_xbt_graph_edge(const s_xbt_graph_t* graph, xbt_node_t s, xbt_node_t d,
78 std::map<std::string, xbt_edge_t, std::less<>>* edges);
80 #endif /* SIMGRID_ROUTING_GENERIC_HPP_ */