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