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