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   NetZone* get_father();
  41
  42   std::vector<NetZone*>* getChildren();             // Sub netzones
  43   void getHosts(std::vector<s4u::Host*> * whereto); // retrieve my content as a vector of hosts
  44   int getHostCount();
  45
  46   /** Get the properties assigned to a host */
  47   std::unordered_map<std::string, std::string>* getProperties();
  48
  49   /** Retrieve the property value (or nullptr if not set) */
  50   const char* getProperty(const char* key);
  51   void setProperty(const char* key, const char* value);
  52
  53   /* Add content to the netzone, at parsing time. It should be sealed afterward. */
  54   virtual int addComponent(kernel::routing::NetPoint * elm); /* A host, a router or a netzone, whatever */
  55   virtual void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  56                          kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  57                          std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
  58   virtual void add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  59                                 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  60                                 std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical) = 0;
  61
  62   /*** Called on each newly created regular route (not on bypass routes) */
  63   static simgrid::xbt::signal<void(bool symmetrical, 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)>
  66       on_route_creation;
  67   static simgrid::xbt::signal<void(NetZone&)> on_creation;
  68   static simgrid::xbt::signal<void(NetZone&)> on_seal;
  69
  70   // Deprecation wrappers
  71   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_father()") NetZone* getFather() { return get_father(); }
  72   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_name()") const std::string& getName() const { return get_name(); }
  73   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_cname()") const char* getCname() const { return get_cname(); }
  74   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_route()") void addRoute(
  75       kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
  76       kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
  77   {
  78     add_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
  79   }
  80   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_bypass_route()") void addBypassRoute(
  81       kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
  82       kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
  83   {
  84     add_bypass_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
  85   }
  86
  87 protected:
  88   unsigned int getTableSize() { return vertices_.size(); }
  89   std::vector<kernel::routing::NetPoint*> getVertices() { return vertices_; }
  90
  91 private:
  92   // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
  93   std::vector<kernel::routing::NetPoint*> vertices_;
  94
  95   std::unordered_map<std::string, std::string> properties_;
  96   NetZone* father_ = nullptr;
  97   std::string name_;
  98
  99   bool sealed_ = false; // We cannot add more content when sealed
 100
 101   std::vector<NetZone*>* children_ = nullptr; // sub-netzones
 102 };
 103 }
 104 }; // Namespace simgrid::s4u
 105
 106 #endif /* SIMGRID_S4U_NETZONE_HPP */