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