include/simgrid/s4u/NetZone.hpp

   1 /* Copyright (c) 2016-2018. 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(NetZone * father, std::string name);
  31   virtual ~NetZone();
  32
  33 public:
  34   /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
  35   virtual void seal();
  36   /** @brief Retrieves the name of that netzone as a C++ string */
  37   const std::string& get_name() const { return name_; }
  38   /** @brief Retrieves the name of that netzone as a C string */
  39   const char* get_cname() const;
  40
  41   NetZone* get_father();
  42   std::vector<NetZone*>* get_children(); // Sub netzones
  43
  44   std::vector<Host*> get_all_hosts();
  45   int get_host_count();
  46
  47 private:
  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   /** Retrieve the property value (or nullptr if not set) */
  55   const char* get_property(const char* key);
  56   void set_property(const char* key, const char* value);
  57
  58   /* Add content to the netzone, at parsing time. It should be sealed afterward. */
  59   virtual int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
  60   virtual void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  61                          kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  62                          std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
  63   virtual void add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  64                                 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  65                                 std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical) = 0;
  66
  67   /*** Called on each newly created regular route (not on bypass routes) */
  68   static simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  69                                    kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  70                                    std::vector<kernel::resource::LinkImpl*>& link_list)>
  71       on_route_creation;
  72   static simgrid::xbt::signal<void(NetZone&)> on_creation;
  73   static simgrid::xbt::signal<void(NetZone&)> on_seal;
  74
  75 private:
  76   // our content, as known to our graph routing algorithm (maps vertex_id -> vertex)
  77   std::vector<kernel::routing::NetPoint*> vertices_;
  78
  79 protected:
  80   unsigned int get_table_size() { return vertices_.size(); }
  81   std::vector<kernel::routing::NetPoint*> get_vertices() { return vertices_; }
  82
  83 private:
  84   NetZone* father_ = nullptr;
  85   std::string name_;
  86
  87   bool sealed_ = false; // We cannot add more content when sealed
  88
  89   std::vector<NetZone*>* children_ = nullptr; // sub-netzones
  90
  91 public: // Deprecation wrappers
  92   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_father()") NetZone* getFather() { return get_father(); }
  93   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_name()") const std::string& getName() const { return get_name(); }
  94   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_cname()") const char* getCname() const { return get_cname(); }
  95   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_route()") void addRoute(
  96       kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
  97       kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
  98   {
  99     add_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
 100   }
 101   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_bypass_route()") void addBypassRoute(
 102       kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
 103       kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
 104   {
 105     add_bypass_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
 106   }
 107   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_properties()") std::unordered_map<std::string, std::string>* getProperties()
 108   {
 109     return get_properties();
 110   }
 111   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_property()") const char* getProperty(const char* key)
 112   {
 113     return get_property(key);
 114   }
 115   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::set_property()") void setProperty(const char* key, const char* value)
 116   {
 117     set_property(key, value);
 118   }
 119   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_component()") virtual int addComponent(
 120       kernel::routing::NetPoint* elm)
 121   {
 122     return add_component(elm);
 123   }
 124   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_vertices()") std::vector<kernel::routing::NetPoint*> getVertices()
 125   {
 126     return get_vertices();
 127   }
 128   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_host_count()") int getHostCount() { return get_host_count(); }
 129   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_all_hosts()") void getHosts(
 130       std::vector<s4u::Host*>* whereto); // retrieve my content as a vector of hosts
 131   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_children()") std::vector<NetZone*>* getChildren()
 132   {
 133     return get_children();
 134   }
 135 };
 136 }
 137 }; // Namespace simgrid::s4u
 138
 139 #endif /* SIMGRID_S4U_NETZONE_HPP */