-/* Copyright (c) 2016. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2016-2021. 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. */
#ifndef SIMGRID_S4U_NETZONE_HPP
#define SIMGRID_S4U_NETZONE_HPP
+#include <simgrid/forward.h>
+#include <xbt/graph.h>
+#include <xbt/signal.hpp>
+
+#include <map>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>
-#include <xbt/base.h>
-#include <xbt/graph.h>
-
-#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 {
-namespace routing {
-class NetZoneImpl;
-}
-}
-
namespace s4u {
/** @brief Networking Zones
* netzones. In SimGrid, there is a hierarchy of netzones, with a unique root zone (that you can retrieve from the
* s4u::Engine).
*/
-XBT_PUBLIC_CLASS NetZone
-{
+class XBT_PUBLIC NetZone {
+ kernel::routing::NetZoneImpl* const pimpl_;
+
protected:
- friend simgrid::kernel::routing::NetZoneImpl;
+ friend kernel::routing::NetZoneImpl;
- explicit NetZone(NetZone * father, const char* name);
- virtual ~NetZone();
+ explicit NetZone(kernel::routing::NetZoneImpl* impl) : pimpl_(impl) {}
public:
- /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
- virtual void seal();
- char* name();
- NetZone* father();
+ /** @brief Retrieves the name of that netzone as a C++ string */
+ const std::string& get_name() const;
+ /** @brief Retrieves the name of that netzone as a C string */
+ const char* get_cname() const;
- std::vector<NetZone*>* children(); // Sub netzones
- void hosts(std::vector<s4u::Host*> * whereto); // retrieve my content as a vector of hosts
+ XBT_ATTRIB_DEPRECATED_v331("Please use get_parent()") NetZone* get_father();
+ NetZone* get_parent() const;
+ NetZone* set_parent(const NetZone* parent);
- /** Get the properties assigned to a host */
- std::unordered_map<std::string, std::string>* properties();
+ std::vector<Host*> get_all_hosts() const;
+ int get_host_count() const;
- /** Retrieve the property value (or nullptr if not set) */
- const char* property(const char* key);
- void setProperty(const char* key, const char* value);
+ kernel::routing::NetZoneImpl* get_impl() const { return pimpl_; }
- /* Add content to the netzone, at parsing time. It should be sealed afterward. */
- virtual int addComponent(kernel::routing::NetPoint * elm); /* A host, a router or a netzone, whatever */
- virtual void addRoute(sg_platf_route_cbarg_t route);
- virtual void addBypassRoute(sg_platf_route_cbarg_t e_route) = 0;
-
- /*** Called on each newly created regular route (not on bypass routes) */
- static simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
- kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
- std::vector<surf::LinkImpl*>* link_list)>
- onRouteCreation;
- static simgrid::xbt::signal<void(NetZone&)> onCreation;
+ /** Get the properties assigned to a netzone */
+ const std::unordered_map<std::string, std::string>* get_properties() const;
+ /** Retrieve the property value (or nullptr if not set) */
+ const char* get_property(const std::string& key) const;
+ void set_property(const std::string& key, const std::string& value);
-protected:
- std::vector<kernel::routing::NetPoint*>
- vertices_; // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
+ std::vector<NetZone*> get_children() const;
+ NetZone* add_child(const NetZone* new_zone);
-private:
- std::unordered_map<std::string, std::string> properties_;
- NetZone* father_ = nullptr;
- char* name_ = nullptr;
+ void extract_xbt_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);
- bool sealed_ = false; // We cannot add more content when sealed
+ /* Add content to the netzone, at parsing time. It should be sealed afterward. */
+ int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
+ 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 add_bypass_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);
- std::vector<NetZone*>* children_ = nullptr; // sub-netzones
+ /*** Called on each newly created regular route (not on bypass routes) */
+ static xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
+ kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
+ std::vector<kernel::resource::LinkImpl*> const& link_list)>
+ on_route_creation;
+ static xbt::signal<void(NetZone const&)> on_creation;
+ static xbt::signal<void(NetZone const&)> on_seal;
};
-}
-}; // Namespace simgrid::s4u
+
+} // namespace s4u
+} // namespace simgrid
#endif /* SIMGRID_S4U_NETZONE_HPP */
