src/surf/surf_routing.hpp

   1 /* Copyright (c) 2013-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef NETWORK_ROUTING_HPP_
   8 #define NETWORK_ROUTING_HPP_
   9
  10 #include <xbt/base.h>
  11 #include <xbt/signal.hpp>
  12
  13 #include "surf_interface.hpp"
  14 #include "src/surf/xml/platf_private.hpp" // FIXME: including this here is pure madness. KILKILKIL XML.
  15 #include "src/kernel/routing/AsImpl.hpp"
  16
  17 #include <float.h>
  18 #include <vector>
  19
  20 SG_BEGIN_DECL()
  21 XBT_PUBLIC(void) routing_model_create(Link *loopback);
  22 XBT_PRIVATE xbt_node_t new_xbt_graph_node (xbt_graph_t graph, const char *name, xbt_dict_t nodes);
  23 XBT_PRIVATE xbt_edge_t new_xbt_graph_edge (xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xbt_dict_t edges);
  24 SG_END_DECL()
  25
  26 namespace simgrid {
  27 namespace kernel {
  28 namespace routing {
  29
  30   XBT_PUBLIC_DATA(simgrid::xbt::signal<void(s4u::As*)>) asCreatedCallbacks;
  31   XBT_PUBLIC_DATA(simgrid::xbt::signal<void(NetCard*)>) netcardCreatedCallbacks;
  32
  33 /***********
  34  * Classes *
  35  ***********/
  36
  37 class XBT_PRIVATE Onelink;
  38 class RoutingPlatf;
  39
  40 /** @ingroup SURF_routing_interface
  41  * @brief Network cards are the vertices in the graph representing the network, used to compute paths between nodes.
  42  *
  43  * @details This represents a position in the network. One can route information between two netcards
  44  */
  45 class NetCard {
  46 public:
  47   virtual ~NetCard()            = default;
  48   virtual unsigned int id()=0; // Our rank in the vertices_ array of our containing AS.
  49   virtual std::string name()    = 0;
  50   virtual AsImpl *containingAS()=0; // This is the AS in which I am
  51   virtual bool isAS()=0;
  52   virtual bool isHost()=0;
  53   virtual bool isRouter()=0;
  54   enum class Type {
  55     Host, Router, As
  56   };
  57 };
  58
  59 struct XBT_PRIVATE NetCardImpl : public NetCard {
  60 public:
  61   NetCardImpl(std::string name, NetCard::Type componentType, AsImpl* containingAS)
  62       : name_(name), componentType_(componentType), containingAS_(containingAS)
  63   {
  64     if (containingAS != nullptr)
  65       id_ = containingAS->addComponent(this);
  66     simgrid::kernel::routing::netcardCreatedCallbacks(this);
  67   }
  68   ~NetCardImpl() = default;
  69
  70   unsigned int id()  override {return id_;}
  71   std::string name() override { return name_; }
  72   AsImpl *containingAS() override {return containingAS_;}
  73
  74   bool isAS()        override {return componentType_ == Type::As;}
  75   bool isHost()      override {return componentType_ == Type::Host;}
  76   bool isRouter()    override {return componentType_ == Type::Router;}
  77
  78 private:
  79   unsigned int id_;
  80   std::string name_;
  81   NetCard::Type componentType_;
  82   AsImpl *containingAS_;
  83 };
  84
  85 /** @ingroup SURF_routing_interface
  86  * @brief Link of length 1, alongside with its source and destination. This is mainly useful in the ns3 bindings
  87  */
  88 class Onelink {
  89 public:
  90   Onelink(void *link, NetCard *src, NetCard *dst)
  91     : src_(src), dst_(dst), link_(link) {};
  92   NetCard *src_;
  93   NetCard *dst_;
  94   void *link_; // FIXME: void* should die just like the death*
  95 };
  96
  97 /** @ingroup SURF_routing_interface
  98  * @brief The class representing a whole routing platform
  99  */
 100 XBT_PUBLIC_CLASS RoutingPlatf {
 101 public:
 102   explicit RoutingPlatf(Link *loopback);
 103   ~RoutingPlatf();
 104   AsImpl *root_ = nullptr;
 105   Link *loopback_;
 106   xbt_dynar_t getOneLinkRoutes();
 107   void getRouteAndLatency(NetCard *src, NetCard *dst, std::vector<Link*> * links, double *latency);
 108 };
 109
 110 }}}
 111
 112 #endif /* NETWORK_ROUTING_HPP_ */