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 <map>
  10 #include <string>
  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
  23 namespace surf {
  24 class Link;
  25 }
  26 namespace kernel {
  27 namespace routing {
  28 class NetZoneImpl;
  29 class NetCard;
  30 }
  31 }
  32 namespace s4u {
  33
  34 /** @brief Networking Zones
  35  *
  36  * A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby
  37  * netzones. In SimGrid, there is a hierarchy of netzones, with a unique root zone (that you can retrieve from the
  38  * s4u::Engine).
  39  */
  40 XBT_PUBLIC_CLASS NetZone
  41 {
  42 protected:
  43   friend simgrid::kernel::routing::NetZoneImpl;
  44
  45   explicit NetZone(NetZone * father, const char* name);
  46   virtual ~NetZone();
  47
  48 public:
  49   /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
  50   virtual void seal();
  51   char* name();
  52   NetZone* father();
  53   ;
  54   xbt_dict_t children(); // Sub netzones
  55   xbt_dynar_t hosts();   // my content as a dynar
  56
  57 public:
  58   /* Add content to the netzone, at parsing time. It should be sealed afterward. */
  59   virtual int addComponent(kernel::routing::NetCard * elm); /* A host, a router or a netzone, whatever */
  60   virtual void addRoute(sg_platf_route_cbarg_t route);
  61   virtual void addBypassRoute(sg_platf_route_cbarg_t e_route) = 0;
  62
  63   /*** Called on each newly created regular route (not on bypass routes) */
  64   static simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetCard* src, kernel::routing::NetCard* dst,
  65                                    kernel::routing::NetCard* gw_src, kernel::routing::NetCard* gw_dst,
  66                                    std::vector<Link*>* link_list)>
  67       onRouteCreation;
  68
  69 protected:
  70   std::vector<kernel::routing::NetCard*>
  71       vertices_; // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
  72
  73 private:
  74   NetZone* father_ = nullptr;
  75   char* name_      = nullptr;
  76
  77   bool sealed_ = false; // We cannot add more content when sealed
  78
  79   xbt_dict_t children_ = xbt_dict_new_homogeneous(nullptr); // sub-netzones
  80 };
  81 }
  82 }; // Namespace simgrid::s4u
  83
  84 #endif /* SIMGRID_S4U_NETZONE_HPP */