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(kernel::routing::NetZoneImpl* impl);
  31   ~NetZone();
  32
  33   kernel::routing::NetZoneImpl* pimpl_;
  34
  35 public:
  36   /** @brief Retrieves the name of that netzone as a C++ string */
  37   const std::string& get_name() const;
  38   /** @brief Retrieves the name of that netzone as a C string */
  39   const char* get_cname() const;
  40
  41   NetZone* get_father();
  42
  43   std::vector<Host*> get_all_hosts();
  44   int get_host_count();
  45
  46   kernel::routing::NetZoneImpl* get_impl() { return pimpl_; }
  47
  48 private:
  49   std::unordered_map<std::string, std::string> properties_;
  50
  51 public:
  52   /** Get the properties assigned to a netzone */
  53   std::unordered_map<std::string, std::string>* get_properties();
  54
  55   std::vector<NetZone*> get_children();
  56
  57   /** Retrieve the property value (or nullptr if not set) */
  58   const char* get_property(const char* key);
  59   void set_property(const char* key, const char* value);
  60
  61   /* Add content to the netzone, at parsing time. It should be sealed afterward. */
  62   int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
  63   void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
  64                  kernel::routing::NetPoint* gw_dst, std::vector<kernel::resource::LinkImpl*>& link_list,
  65                  bool symmetrical);
  66   void add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  67                         kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  68                         std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
  69
  70   /*** Called on each newly created regular route (not on bypass routes) */
  71   static simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  72                                    kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  73                                    std::vector<kernel::resource::LinkImpl*>& link_list)>
  74       on_route_creation;
  75   static simgrid::xbt::signal<void(NetZone&)> on_creation;
  76   static simgrid::xbt::signal<void(NetZone&)> on_seal;
  77
  78 public: // Deprecation wrappers
  79   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_father()") NetZone* getFather() { return get_father(); }
  80   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_name()") const std::string& getName() const { return get_name(); }
  81   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_cname()") const char* getCname() const { return get_cname(); }
  82   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_route()") void addRoute(
  83       kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
  84       kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
  85   {
  86     add_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
  87   }
  88   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_bypass_route()") void addBypassRoute(
  89       kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
  90       kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
  91   {
  92     add_bypass_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
  93   }
  94   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_properties()") std::unordered_map<std::string, std::string>* getProperties()
  95   {
  96     return get_properties();
  97   }
  98   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_property()") const char* getProperty(const char* key)
  99   {
 100     return get_property(key);
 101   }
 102   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::set_property()") void setProperty(const char* key, const char* value)
 103   {
 104     set_property(key, value);
 105   }
 106   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_component()") int addComponent(kernel::routing::NetPoint* elm)
 107   {
 108     return add_component(elm);
 109   }
 110   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_vertices()") std::vector<kernel::routing::NetPoint*> getVertices();
 111   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_host_count()") int getHostCount() { return get_host_count(); }
 112   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_all_hosts()") void getHosts(
 113       std::vector<s4u::Host*>* whereto); // retrieve my content as a vector of hosts
 114   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_children()") std::vector<NetZone*>* getChildren()
 115   {
 116     std::vector<NetZone*>* res = new std::vector<NetZone*>();
 117     for (auto child : get_children())
 118       res->push_back(child);
 119     return res;
 120   }
 121 };
 122 }
 123 }; // Namespace simgrid::s4u
 124
 125 #endif /* SIMGRID_S4U_NETZONE_HPP */