include/simgrid/s4u/NetZone.hpp

   1 /* Copyright (c) 2016-2017. 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 <string>
  10 #include <unordered_map>
  11 #include <utility>
  12 #include <vector>
  13
  14 #include <xbt/base.h>
  15 #include <xbt/graph.h>
  16 #include <xbt/signal.hpp>
  17
  18 #include <simgrid/forward.h>
  19 #include <simgrid/s4u/forward.hpp>
  20
  21 namespace simgrid {
  22
  23 namespace s4u {
  24
  25 /** @brief Networking Zones
  26  *
  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
  29  * s4u::Engine).
  30  */
  31 XBT_PUBLIC_CLASS NetZone
  32 {
  33 protected:
  34   friend simgrid::kernel::routing::NetZoneImpl;
  35
  36   explicit NetZone(NetZone * father, std::string name);
  37   virtual ~NetZone();
  38
  39 public:
  40   /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
  41   virtual void seal();
  42   /** @brief Retrieves the name of that netzone as a C++ string */
  43   const std::string& getName() const { return name_; }
  44   /** @brief Retrieves the name of that netzone as a C string */
  45   const char* getCname() const;
  46   NetZone* getFather();
  47
  48   std::vector<NetZone*>* getChildren();             // Sub netzones
  49   void getHosts(std::vector<s4u::Host*> * whereto); // retrieve my content as a vector of hosts
  50   int getHostCount();
  51
  52   /** Get the properties assigned to a host */
  53   std::unordered_map<std::string, std::string>* getProperties();
  54
  55   /** Retrieve the property value (or nullptr if not set) */
  56   const char* getProperty(const char* key);
  57   void setProperty(const char* key, const char* value);
  58
  59   /* Add content to the netzone, at parsing time. It should be sealed afterward. */
  60   virtual int addComponent(kernel::routing::NetPoint * elm); /* A host, a router or a netzone, whatever */
  61   virtual void addRoute(kernel::routing::NetPoint * src, kernel::routing::NetPoint * dst,
  62                         kernel::routing::NetPoint * gw_src, kernel::routing::NetPoint * gw_dst,
  63                         std::vector<simgrid::surf::LinkImpl*> & link_list, bool symmetrical);
  64   virtual void addBypassRoute(kernel::routing::NetPoint * src, kernel::routing::NetPoint * dst,
  65                               kernel::routing::NetPoint * gw_src, kernel::routing::NetPoint * gw_dst,
  66                               std::vector<simgrid::surf::LinkImpl*> & link_list, bool symmetrical) = 0;
  67
  68   /*** Called on each newly created regular route (not on bypass routes) */
  69   static simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  70                                    kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  71                                    std::vector<surf::LinkImpl*>& link_list)>
  72       onRouteCreation;
  73   static simgrid::xbt::signal<void(NetZone&)> onCreation;
  74   static simgrid::xbt::signal<void(NetZone&)> onSeal;
  75
  76 protected:
  77   unsigned int getTableSize() { return vertices_.size(); }
  78   std::vector<kernel::routing::NetPoint*> getVertices() { return vertices_; }
  79
  80 private:
  81   // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
  82   std::vector<kernel::routing::NetPoint*> vertices_;
  83
  84   std::unordered_map<std::string, std::string> properties_;
  85   NetZone* father_ = nullptr;
  86   std::string name_;
  87
  88   bool sealed_ = false; // We cannot add more content when sealed
  89
  90   std::vector<NetZone*>* children_ = nullptr; // sub-netzones
  91 };
  92 }
  93 }; // Namespace simgrid::s4u
  94
  95 #endif /* SIMGRID_S4U_NETZONE_HPP */