include/simgrid/s4u/NetZone.hpp

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