include/simgrid/s4u/NetZone.hpp

   1 /* Copyright (c) 2016-2019. The SimGrid Team. All rights reserved.               */
   2
   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. */
   5
   6 #ifndef SIMGRID_S4U_NETZONE_HPP
   7 #define SIMGRID_S4U_NETZONE_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <xbt/signal.hpp>
  11
  12 #include <string>
  13 #include <unordered_map>
  14 #include <utility>
  15 #include <vector>
  16
  17 namespace simgrid {
  18 namespace s4u {
  19
  20 /** @brief Networking Zones
  21  *
  22  * A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby
  23  * netzones. In SimGrid, there is a hierarchy of netzones, with a unique root zone (that you can retrieve from the
  24  * s4u::Engine).
  25  */
  26 class XBT_PUBLIC NetZone {
  27 protected:
  28   friend simgrid::kernel::routing::NetZoneImpl;
  29
  30   explicit NetZone(kernel::routing::NetZoneImpl* impl);
  31   ~NetZone();
  32
  33 public:
  34   /** @brief Retrieves the name of that netzone as a C++ string */
  35   const std::string& get_name() const;
  36   /** @brief Retrieves the name of that netzone as a C string */
  37   const char* get_cname() const;
  38
  39   NetZone* get_father();
  40
  41   std::vector<Host*> get_all_hosts();
  42   int get_host_count();
  43
  44   kernel::routing::NetZoneImpl* get_impl() { return pimpl_; }
  45
  46 private:
  47   kernel::routing::NetZoneImpl* const pimpl_;
  48   std::unordered_map<std::string, std::string> properties_;
  49
  50 public:
  51   /** Get the properties assigned to a netzone */
  52   std::unordered_map<std::string, std::string>* get_properties();
  53
  54   std::vector<NetZone*> get_children();
  55
  56   /** Retrieve the property value (or nullptr if not set) */
  57   const char* get_property(const std::string& key);
  58   void set_property(const std::string& key, const std::string& value);
  59
  60   /* Add content to the netzone, at parsing time. It should be sealed afterward. */
  61   int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
  62   void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
  63                  kernel::routing::NetPoint* gw_dst, std::vector<kernel::resource::LinkImpl*>& link_list,
  64                  bool symmetrical);
  65   void add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  66                         kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  67                         std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
  68
  69   /*** Called on each newly created regular route (not on bypass routes) */
  70   static simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  71                                    kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  72                                    std::vector<kernel::resource::LinkImpl*>& link_list)>
  73       on_route_creation;
  74   static simgrid::xbt::signal<void(NetZone&)> on_creation;
  75   static simgrid::xbt::signal<void(NetZone&)> on_seal;
  76
  77 #ifndef DOXYGEN
  78   // Deprecation wrappers
  79   /** @deprecated NetZone::get_father() */
  80   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_father()") NetZone* getFather() { return get_father(); }
  81   /** @deprecated NetZone::get_name() */
  82   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_name()") const std::string& getName() const { return get_name(); }
  83   /** @deprecated NetZone::get_cname() */
  84   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_cname()") const char* getCname() const { return get_cname(); }
  85   /** @deprecated NetZone::add_route() */
  86   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_route()") void addRoute(
  87       kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
  88       kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
  89   {
  90     add_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
  91   }
  92   /** @deprecated NetZone::add_bypass_route() */
  93   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_bypass_route()") void addBypassRoute(
  94       kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
  95       kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
  96   {
  97     add_bypass_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
  98   }
  99   /** @deprecated NetZone::get_properties() */
 100   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_properties()") std::unordered_map<std::string, std::string>* getProperties()
 101   {
 102     return get_properties();
 103   }
 104   /** @deprecated NetZone::get_property() */
 105   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_property()") const char* getProperty(const char* key)
 106   {
 107     return get_property(key);
 108   }
 109   /** @deprecated NetZone::set_property() */
 110   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::set_property()") void setProperty(const char* key, const char* value)
 111   {
 112     set_property(key, value);
 113   }
 114   /** @deprecated NetZone::add_component() */
 115   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_component()") int addComponent(kernel::routing::NetPoint* elm)
 116   {
 117     return add_component(elm);
 118   }
 119   /** @deprecated NetZone::get_vertices() */
 120   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_vertices()") std::vector<kernel::routing::NetPoint*> getVertices();
 121   /** @deprecated NetZone::get_host_count() */
 122   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_host_count()") int getHostCount() { return get_host_count(); }
 123   /** @deprecated NetZone::get_all_hosts() */
 124   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_all_hosts()") void getHosts(
 125       std::vector<s4u::Host*>* whereto); // retrieve my content as a vector of hosts
 126   /** @deprecated NetZone::get_children() */
 127   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_children()") std::vector<NetZone*>* getChildren()
 128   {
 129     std::vector<NetZone*>* res = new std::vector<NetZone*>();
 130     for (auto child : get_children())
 131       res->push_back(child);
 132     return res;
 133   }
 134 #endif
 135 };
 136 }
 137 }; // Namespace simgrid::s4u
 138
 139 #endif /* SIMGRID_S4U_NETZONE_HPP */