1 /* Copyright (c) 2016-2018. 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_S4U_NETZONE_HPP
7 #define SIMGRID_S4U_NETZONE_HPP
10 #include <unordered_map>
15 #include <xbt/graph.h>
16 #include <xbt/signal.hpp>
18 #include <simgrid/forward.h>
19 #include <simgrid/s4u/forward.hpp>
25 /** @brief Networking Zones
27 * A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby
28 * netzones. In SimGrid, there is a hierarchy of netzones, with a unique root zone (that you can retrieve from the
31 class XBT_PUBLIC NetZone {
33 friend simgrid::kernel::routing::NetZoneImpl;
35 explicit NetZone(NetZone * father, std::string name);
39 /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
41 /** @brief Retrieves the name of that netzone as a C++ string */
42 const std::string& get_name() const { return name_; }
43 /** @brief Retrieves the name of that netzone as a C string */
44 const char* get_cname() const;
47 XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_name()") const std::string& getName() const { return get_name(); }
48 XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_cname()") const char* getCname() const { return get_cname(); }
50 std::vector<NetZone*>* getChildren(); // Sub netzones
51 void getHosts(std::vector<s4u::Host*> * whereto); // retrieve my content as a vector of hosts
54 /** Get the properties assigned to a host */
55 std::unordered_map<std::string, std::string>* getProperties();
57 /** Retrieve the property value (or nullptr if not set) */
58 const char* getProperty(const char* key);
59 void setProperty(const char* key, const char* value);
61 /* Add content to the netzone, at parsing time. It should be sealed afterward. */
62 virtual int addComponent(kernel::routing::NetPoint * elm); /* A host, a router or a netzone, whatever */
63 virtual void addRoute(kernel::routing::NetPoint * src, kernel::routing::NetPoint * dst,
64 kernel::routing::NetPoint * gw_src, kernel::routing::NetPoint * gw_dst,
65 std::vector<simgrid::surf::LinkImpl*> & link_list, bool symmetrical);
66 virtual void addBypassRoute(kernel::routing::NetPoint * src, kernel::routing::NetPoint * dst,
67 kernel::routing::NetPoint * gw_src, kernel::routing::NetPoint * gw_dst,
68 std::vector<simgrid::surf::LinkImpl*> & link_list, bool symmetrical) = 0;
70 /*** Called on each newly created regular route (not on bypass routes) */
71 static simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
72 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
73 std::vector<surf::LinkImpl*>& link_list)>
75 static simgrid::xbt::signal<void(NetZone&)> onCreation;
76 static simgrid::xbt::signal<void(NetZone&)> onSeal;
79 unsigned int getTableSize() { return vertices_.size(); }
80 std::vector<kernel::routing::NetPoint*> getVertices() { return vertices_; }
83 // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
84 std::vector<kernel::routing::NetPoint*> vertices_;
86 std::unordered_map<std::string, std::string> properties_;
87 NetZone* father_ = nullptr;
90 bool sealed_ = false; // We cannot add more content when sealed
92 std::vector<NetZone*>* children_ = nullptr; // sub-netzones
95 }; // Namespace simgrid::s4u
97 #endif /* SIMGRID_S4U_NETZONE_HPP */