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