#ifndef SIMGRID_ROUTING_NETZONEIMPL_HPP
#define SIMGRID_ROUTING_NETZONEIMPL_HPP
+#include <map>
+
#include "xbt/graph.h"
#include "simgrid/s4u/NetZone.hpp"
#include "simgrid/s4u/forward.hpp"
-#include "src/surf/xml/platf_private.hpp" // FIXME: kill sg_platf_route_cbarg_t to remove that UGLY include
-
namespace simgrid {
namespace kernel {
class EngineImpl;
namespace routing {
class BypassRoute;
-/** @brief Networking Zones
+/** @ingroup ROUTING_API
+ * @brief Private implementation of the Networking Zones
*
- * A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby
- * netzones. In SimGrid, there is a hierarchy of netzones, ie a tree with a unique root NetZone, that you can retrieve
- * from the s4u::Engine.
+ * A netzone is a network container, in charge of routing information between elements (hosts and sub-netzones)
+ * and to the nearby netzones. In SimGrid, there is a hierarchy of netzones, ie a tree with a unique root
+ * NetZone, that you can retrieve with simgrid::s4u::Engine::netRoot().
*
* The purpose of the kernel::routing module is to retrieve the routing path between two points in a time- and
* space-efficient manner. This is done by NetZoneImpl::getGlobalRoute(), called when creating a communication to
* retrieve both the list of links that the create communication will use, and the summed latency that these
* links represent.
*
- * The network could recompute the latency by itself from the list, but it would require an additional link
- * set traversal. This operation being on the critical path of SimGrid, the routing computes the latency on the
- * behalf of the network.
+ * The network model could recompute the latency by itself from the list, but it would require an additional
+ * traversal of the link set. This operation being on the critical path of SimGrid, the routing computes the
+ * latency on the behalf of the network while constructing the link set.
*
* Finding the path between two nodes is rather complex because we navigate a hierarchy of netzones, each of them
* being a full network. In addition, the routing can declare shortcuts (called bypasses), either within a NetZone
* at the route level or directly between NetZones. Also, each NetZone can use a differing routing algorithm, depending
- * on its class. @ref{FullZone} have a full matrix giving explicitly the path between any pair of their
- * contained nodes, while @ref{DijkstraZone} or @ref{FloydZone} rely on a shortest path algorithm. @ref{VivaldiZone}
+ * on its class. @ref FullZone have a full matrix giving explicitly the path between any pair of their
+ * contained nodes, while @ref DijkstraZone or @ref FloydZone rely on a shortest path algorithm. @ref VivaldiZone
* does not even have any link but only use only coordinate information to compute the latency.
*
* So NetZoneImpl::getGlobalRoute builds the path recursively asking its specific information to each traversed NetZone
friend simgrid::kernel::EngineImpl; // it destroys netRoot_
protected:
- explicit NetZoneImpl(NetZone * father, const char* name);
+ explicit NetZoneImpl(NetZone * father, std::string name);
virtual ~NetZoneImpl();
public:
/** @brief Make an host within that NetZone */
- simgrid::s4u::Host* createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount);
+ simgrid::s4u::Host* createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount,
+ std::map<std::string, std::string>* props);
/** @brief Creates a new route in this NetZone */
void addBypassRoute(sg_platf_route_cbarg_t e_route) override;
* @param into Container into which the traversed links and gateway informations should be pushed
* @param latency Accumulator in which the latencies should be added (caller must set it to 0)
*/
- virtual void getLocalRoute(NetCard * src, NetCard * dst, sg_platf_route_cbarg_t into, double* latency) = 0;
+ virtual void getLocalRoute(NetPoint * src, NetPoint * dst, sg_platf_route_cbarg_t into, double* latency) = 0;
/** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
/* returns whether we found a bypass path */
- bool getBypassRoute(routing::NetCard * src, routing::NetCard * dst,
- /* OUT */ std::vector<surf::Link*> * links, double* latency);
+ bool getBypassRoute(routing::NetPoint * src, routing::NetPoint * dst,
+ /* OUT */ std::vector<surf::LinkImpl*> * links, double* latency);
public:
/* @brief get the route between two nodes in the full platform
* @param links Accumulator in which all traversed links should be pushed (caller must empty it)
* @param latency Accumulator in which the latencies should be added (caller must set it to 0)
*/
- static void getGlobalRoute(routing::NetCard * src, routing::NetCard * dst,
- /* OUT */ std::vector<surf::Link*> * links, double* latency);
+ static void getGlobalRoute(routing::NetPoint * src, routing::NetPoint * dst,
+ /* OUT */ std::vector<surf::LinkImpl*> * links, double* latency);
- virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges) = 0;
+ virtual void getGraph(xbt_graph_t graph, std::map<std::string, xbt_node_t> * nodes,
+ std::map<std::string, xbt_edge_t> * edges) = 0;
enum class RoutingMode {
unset = 0, /**< Undefined type */
base, /**< Base case: use simple link lists for routing */
RoutingMode hierarchy_ = RoutingMode::unset;
private:
- std::map<std::pair<NetCard*, NetCard*>, BypassRoute*> bypassRoutes_; // src x dst -> route
- routing::NetCard* netcard_ = nullptr; // Our representative in the father NetZone
+ std::map<std::pair<NetPoint*, NetPoint*>, BypassRoute*> bypassRoutes_; // src x dst -> route
+ routing::NetPoint* netpoint_ = nullptr; // Our representative in the father NetZone
};
}
}
