include/simgrid/s4u/As.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_AS_HPP
   7 #define SIMGRID_S4U_AS_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 routing {
  27   class AsImpl;
  28   class NetCard;
  29 }
  30 namespace s4u {
  31
  32 /** @brief Autonomous Systems
  33  *
  34  * An AS is a network container, in charge of routing information between elements (hosts) and to the nearby ASes.
  35  * In SimGrid, there is a hierarchy of ASes, with a unique root AS (that you can retrieve from the s4u::Engine).
  36  */
  37 XBT_PUBLIC_CLASS As {
  38 protected:
  39   friend simgrid::routing::AsImpl;
  40
  41   explicit As(const char *name);
  42   virtual ~As();
  43
  44 public:
  45   /** @brief Seal your AS once you're done adding content, and before routing stuff through it */
  46   virtual void seal();
  47   char *name();
  48   As *father();;
  49   xbt_dict_t children(); // Sub AS
  50   xbt_dynar_t hosts();   // my content
  51
  52   As *father_ = nullptr; // FIXME: hide me
  53 public:
  54   /* Add content to the AS, at parsing time. It should be sealed afterward. */
  55   virtual int addComponent(routing::NetCard *elm); /* A host, a router or an AS, whatever */
  56   virtual void addRoute(sg_platf_route_cbarg_t route);
  57   void addBypassRoute(sg_platf_route_cbarg_t e_route);
  58
  59 protected:
  60   char *name_ = nullptr;
  61   xbt_dict_t children_ = xbt_dict_new_homogeneous(nullptr); // sub-ASes
  62   xbt_dynar_t vertices_ = xbt_dynar_new(sizeof(char*),nullptr); // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
  63
  64   std::map<std::pair<std::string, std::string>, std::vector<surf::Link*>*> bypassRoutes_; // srcName x dstName -> route
  65
  66 private:
  67   bool sealed_ = false; // We cannot add more content when sealed
  68 };
  69
  70 }}; // Namespace simgrid::s4u
  71
  72 #endif /* SIMGRID_S4U_AS_HPP */