-/* Copyright (c) 2016-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2016-2023. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#define SIMGRID_ROUTING_NETZONEIMPL_HPP
#include <simgrid/forward.h>
+#include <simgrid/s4u/Link.hpp>
#include <simgrid/s4u/NetZone.hpp>
#include <xbt/PropertyHolder.hpp>
#include <xbt/graph.h>
#include <map>
+#include <unordered_set>
#include <vector>
-namespace simgrid {
-namespace kernel {
-namespace routing {
+namespace simgrid::kernel::routing {
+
+class Route {
+public:
+ Route() = default;
+ explicit Route(NetPoint* src, NetPoint* dst, NetPoint* gwSrc, NetPoint* gwDst)
+ : src_(src), dst_(dst), gw_src_(gwSrc), gw_dst_(gwDst)
+ {
+ }
+ NetPoint* src_ = nullptr;
+ NetPoint* dst_ = nullptr;
+ NetPoint* gw_src_ = nullptr;
+ NetPoint* gw_dst_ = nullptr;
+ std::vector<resource::StandardLinkImpl*> link_list_;
+};
class BypassRoute {
public:
explicit BypassRoute(NetPoint* gwSrc, NetPoint* gwDst) : gw_src(gwSrc), gw_dst(gwDst) {}
NetPoint* gw_src;
NetPoint* gw_dst;
- std::vector<resource::LinkImpl*> links;
+ std::vector<resource::StandardLinkImpl*> links;
};
/** @ingroup ROUTING_API
s4u::NetZone piface_;
// our content, as known to our graph routing algorithm (maps vertex_id -> vertex)
- std::vector<kernel::routing::NetPoint*> vertices_;
+ std::vector<NetPoint*> vertices_;
+ std::map<std::string, resource::StandardLinkImpl*, std::less<>> links_;
+ /* save split-duplex links separately, keep links_ with only LinkImpl* seen by the user
+ * members of a split-duplex are saved in the links_ */
+ std::map<std::string, std::unique_ptr<resource::SplitDuplexLinkImpl>, std::less<>> split_duplex_links_;
+ std::map<std::string, resource::HostImpl*, std::less<>> hosts_;
+ std::map<std::string, NetPoint*, std::less<>> gateways_;
- NetZoneImpl* father_ = nullptr;
+ NetZoneImpl* parent_ = nullptr;
std::vector<NetZoneImpl*> children_; // sub-netzones
std::string name_;
bool sealed_ = false; // We cannot add more content when sealed
- std::map<std::pair<NetPoint*, NetPoint*>, BypassRoute*> bypass_routes_; // src x dst -> route
- routing::NetPoint* netpoint_ = nullptr; // Our representative in the father NetZone
+ std::map<std::pair<const NetPoint*, const NetPoint*>, BypassRoute*> bypass_routes_; // src x dst -> route
+ NetPoint* netpoint_ = nullptr; // Our representative in the parent NetZone
protected:
- explicit NetZoneImpl(NetZoneImpl* father, const std::string& name, resource::NetworkModel* network_model);
+ explicit NetZoneImpl(const std::string& name);
NetZoneImpl(const NetZoneImpl&) = delete;
NetZoneImpl& operator=(const NetZoneImpl&) = delete;
virtual ~NetZoneImpl();
* @param into Container into which the traversed links and gateway information should be pushed
* @param latency Accumulator in which the latencies should be added (caller must set it to 0)
*/
- virtual void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) = 0;
+ virtual void get_local_route(const NetPoint* src, const NetPoint* dst, Route* 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 get_bypass_route(routing::NetPoint* src, routing::NetPoint* dst,
- /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency);
+ bool get_bypass_route(const routing::NetPoint* src, const routing::NetPoint* dst,
+ /* OUT */ std::vector<resource::StandardLinkImpl*>& links, double* latency,
+ std::unordered_set<NetZoneImpl*>& netzones);
+
+ /** @brief Get the NetZone that is represented by the netpoint */
+ const NetZoneImpl* get_netzone_recursive(const NetPoint* netpoint) const;
+
+ /** @brief Get the list of LinkImpl* to add in a route, considering split-duplex links and the direction */
+ std::vector<resource::StandardLinkImpl*> get_link_list_impl(const std::vector<s4u::LinkInRoute>& link_list,
+ bool backroute) const;
+
+ static xbt_node_t new_xbt_graph_node(const s_xbt_graph_t* graph, const char* name,
+ std::map<std::string, xbt_node_t, std::less<>>* nodes);
+ static xbt_edge_t new_xbt_graph_edge(const s_xbt_graph_t* graph, xbt_node_t src, xbt_node_t dst,
+ std::map<std::string, xbt_edge_t, std::less<>>* edges);
public:
enum class RoutingMode {
- unset = 0, /**< Undefined type */
- base, /**< Base case: use simple link lists for routing */
- recursive /**< Recursive case: also return gateway information */
+ base, /**< Base case: use simple link lists for routing */
+ recursive /**< Recursive case: also return gateway information */
};
- /* FIXME: protect the following fields once the construction madness is sorted out */
- RoutingMode hierarchy_ = RoutingMode::unset;
-
- resource::NetworkModel* network_model_;
+ /** @brief Retrieves the network model associated to this NetZone */
+ const std::shared_ptr<resource::NetworkModel>& get_network_model() const { return network_model_; }
+ /** @brief Retrieves the CPU model for virtual machines associated to this NetZone */
+ const std::shared_ptr<resource::CpuModel>& get_cpu_vm_model() const { return cpu_model_vm_; }
+ /** @brief Retrieves the CPU model for physical machines associated to this NetZone */
+ const std::shared_ptr<resource::CpuModel>& get_cpu_pm_model() const { return cpu_model_pm_; }
+ /** @brief Retrieves the disk model associated to this NetZone */
+ const std::shared_ptr<resource::DiskModel>& get_disk_model() const { return disk_model_; }
+ /** @brief Retrieves the host model associated to this NetZone */
+ const std::shared_ptr<resource::HostModel>& get_host_model() const { return host_model_; }
+ const s4u::NetZone* get_iface() const { return &piface_; }
s4u::NetZone* get_iface() { return &piface_; }
unsigned int get_table_size() const { return vertices_.size(); }
- std::vector<kernel::routing::NetPoint*> get_vertices() const { return vertices_; }
- NetZoneImpl* get_father() const { return father_; }
+ std::vector<NetPoint*> get_vertices() const { return vertices_; }
+ NetZoneImpl* get_parent() const { return parent_; }
/** @brief Returns the list of direct children (no grand-children). This returns the internal data, no copy.
* Don't mess with it.*/
- std::vector<NetZoneImpl*>* get_children() { return &children_; }
+ const std::vector<NetZoneImpl*>& get_children() const { return children_; }
+ /** @brief Get current netzone hierarchy */
+ RoutingMode get_hierarchy() const { return hierarchy_; }
+
/** @brief Retrieves the name of that netzone as a C++ string */
const std::string& get_name() const { return name_; }
/** @brief Retrieves the name of that netzone as a C string */
const char* get_cname() const { return name_.c_str(); };
+ /** @brief Gets the netpoint associated to this netzone */
+ NetPoint* get_netpoint() const { return netpoint_; }
+
+ void set_gateway(const std::string& name, NetPoint* router);
+ /** @brief Gets the gateway associated to this netzone */
+ NetPoint* get_gateway() const;
+ NetPoint* get_gateway(const std::string& name) const { return gateways_.at(name); }
+
std::vector<s4u::Host*> get_all_hosts() const;
- int get_host_count() const;
+ size_t get_host_count() const;
+
+ /**
+ * @brief Recursively gets all links declared in this netzone
+ *
+ * Include children netzones.
+ * @return List of links
+ */
+ std::vector<s4u::Link*> get_all_links() const;
+ /**
+ * @brief Recursively gets all links declared in this netzone.
+ *
+ * Using a filter function
+ * Include children netzones.
+ * @param filter Select links based on this filter
+ * @return List of links
+ */
+ std::vector<s4u::Link*> get_filtered_links(const std::function<bool(s4u::Link*)>& filter) const;
+ /** @brief Get total number of links declared in this netzone (and its children) */
+ size_t get_link_count() const;
+
+ /**
+ * @brief Searches by the link by its name inside this netzone.
+ * Recursively searches in children netzones
+ *
+ * @param name Link name
+ * @return Link object or nullptr if not found
+ */
+ resource::StandardLinkImpl* get_link_by_name_or_null(const std::string& name) const;
+
+ /**
+ * @brief Searches for split-duplex links by its name inside this netzone.
+ * Recursively searches in child netzones
+ *
+ * @param name Split-duplex Link name
+ * @return Link object or nullptr if not found
+ */
+ resource::SplitDuplexLinkImpl* get_split_duplex_link_by_name_or_null(const std::string& name) const;
+
+ /**
+ * @brief Searches for a host by its name (recursively)
+ * Including children netzones and VMs on physival hosts
+ *
+ * @param name Host (or VM) name
+ * @return HostImpl pointer
+ */
+ resource::HostImpl* get_host_by_name_or_null(const std::string& name) const;
+
+ /**
+ * @brief Gets list of hosts on this netzone recursively.
+ *
+ * Note: This includes hosts on children netzones and VMs on physical hosts.
+ *
+ * @param filter Filter function to select specific nodes
+ * @return List of hosts
+ */
+ std::vector<s4u::Host*> get_filtered_hosts(const std::function<bool(s4u::Host*)>& filter) const;
/** @brief Make a host within that NetZone */
- s4u::Host* create_host(const std::string& name, const std::vector<double>& speed_per_pstate, int core_count,
- const std::map<std::string, std::string>* props);
+ s4u::Host* create_host(const std::string& name, const std::vector<double>& speed_per_pstate);
+ /** @brief Create a disk with the disk model from this NetZone */
+ s4u::Disk* create_disk(const std::string& name, double read_bandwidth, double write_bandwidth);
+ /** @brief Make a link within that NetZone */
+ s4u::Link* create_link(const std::string& name, const std::vector<double>& bandwidths);
+ s4u::SplitDuplexLink* create_split_duplex_link(const std::string& name, const std::vector<double>& bandwidths);
+ /** @brief Make a router within that NetZone */
+ NetPoint* create_router(const std::string& name);
/** @brief Creates a new route in this NetZone */
virtual void add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
- std::vector<resource::LinkImpl*>& link_list, bool symmetrical);
+ const std::vector<s4u::LinkInRoute>& link_list);
/** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
- virtual void seal() { sealed_ = true; };
- virtual int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
- virtual void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
- kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
- std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
+ void seal();
+ /** @brief Check if netpoint is a member of this NetZone or some of the childrens */
+ bool is_component_recursive(const NetPoint* netpoint) const;
+ virtual unsigned long add_component(NetPoint* elm); /* A host, a router or a netzone, whatever */
+ virtual void add_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
+ const std::vector<s4u::LinkInRoute>& link_list, bool symmetrical);
+ /** @brief Set parent of this Netzone */
+ void set_parent(NetZoneImpl* parent);
+ /** @brief Set network model for this Netzone */
+ void set_network_model(std::shared_ptr<resource::NetworkModel> netmodel);
+ void set_cpu_vm_model(std::shared_ptr<resource::CpuModel> cpu_model);
+ void set_cpu_pm_model(std::shared_ptr<resource::CpuModel> cpu_model);
+ void set_disk_model(std::shared_ptr<resource::DiskModel> disk_model);
+ void set_host_model(std::shared_ptr<resource::HostModel> host_model);
- /* @brief get the route between two nodes in the full platform
+ /** @brief get the route between two nodes in the full platform
*
* @param src where from
* @param dst where to
* @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 get_global_route(routing::NetPoint* src, routing::NetPoint* dst,
- /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency);
+ static void get_global_route(const NetPoint* src, const NetPoint* dst,
+ /* OUT */ std::vector<resource::StandardLinkImpl*>& links, double* latency);
+
+ /** @brief Similar to get_global_route but get the NetZones traversed by route */
+ static void get_global_route_with_netzones(const NetPoint* src, const NetPoint* dst,
+ /* OUT */ std::vector<resource::StandardLinkImpl*>& links, double* latency,
+ std::unordered_set<NetZoneImpl*>& netzones);
+
+ virtual void get_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
+ std::map<std::string, xbt_edge_t, std::less<>>* edges);
+
+ /*** Called on each newly created regular route (not on bypass routes) */
+ static xbt::signal<void(bool symmetrical, NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
+ std::vector<resource::StandardLinkImpl*> const& link_list)>
+ on_route_creation; // FIXME: XBT_ATTRIB_DEPRECATED_v332: should be an internal signal used by NS3.. if necessary,
+ // callback shouldn't use LinkImpl*
- virtual void get_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t>* nodes,
- std::map<std::string, xbt_edge_t>* edges) = 0;
+private:
+ RoutingMode hierarchy_ = RoutingMode::base;
+ std::shared_ptr<resource::NetworkModel> network_model_;
+ std::shared_ptr<resource::CpuModel> cpu_model_vm_;
+ std::shared_ptr<resource::CpuModel> cpu_model_pm_;
+ std::shared_ptr<resource::DiskModel> disk_model_;
+ std::shared_ptr<resource::HostModel> host_model_;
+ /** @brief Perform sealing procedure for derived classes, if necessary */
+ virtual void do_seal()
+ { /* obviously nothing to do by default */
+ }
+ /** @brief Allows subclasses (wi-fi) to have their own create link method, but keep links_ updated */
+ virtual resource::StandardLinkImpl* do_create_link(const std::string& name, const std::vector<double>& bandwidths);
+ void add_child(NetZoneImpl* new_zone);
};
-} // namespace routing
-} // namespace kernel
-} // namespace simgrid
+} // namespace simgrid::kernel::routing
#endif /* SIMGRID_ROUTING_NETZONEIMPL_HPP */