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/surf/AsImpl.hpp"
  16
  17 #include <float.h>
  18 #include <vector>
  19 #include <map>
  20
  21 SG_BEGIN_DECL()
  22 XBT_PUBLIC(void) routing_model_create(Link *loopback);
  23 XBT_PRIVATE xbt_node_t new_xbt_graph_node (xbt_graph_t graph, const char *name, xbt_dict_t nodes);
  24 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);
  25 SG_END_DECL()
  26
  27 namespace simgrid {
  28 namespace surf {
  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(){};
  48   virtual int id()=0; // Our rank in the vertices_ array of our containing AS.
  49   virtual char *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 };
  55
  56 struct XBT_PRIVATE NetCardImpl : public NetCard {
  57 public:
  58   NetCardImpl(const char *name, e_surf_network_element_type_t componentType, AsImpl *containingAS)
  59   : name_(xbt_strdup(name)),
  60     componentType_(componentType),
  61     containingAS_(containingAS)
  62   {
  63     if (containingAS != nullptr)
  64       id_ = containingAS->addComponent(this);
  65     simgrid::surf::netcardCreatedCallbacks(this);
  66   }
  67   ~NetCardImpl() { xbt_free(name_);};
  68
  69   int id()           override {return id_;}
  70   char *name()       override {return name_;}
  71   AsImpl *containingAS() override {return containingAS_;}
  72
  73   bool isAS()        override {return componentType_ == SURF_NETWORK_ELEMENT_AS;}
  74   bool isHost()      override {return componentType_ == SURF_NETWORK_ELEMENT_HOST;}
  75   bool isRouter()    override {return componentType_ == SURF_NETWORK_ELEMENT_ROUTER;}
  76
  77 private:
  78   int id_ = -1;
  79   char *name_;
  80   e_surf_network_element_type_t componentType_;
  81   AsImpl *containingAS_;
  82 };
  83
  84 /** @ingroup SURF_routing_interface
  85  * @brief Link of length 1, alongside with its source and destination. This is mainly useful in the ns3 bindings
  86  */
  87 class Onelink {
  88 public:
  89   Onelink(void *link, NetCard *src, NetCard *dst)
  90     : src_(src), dst_(dst), link_(link) {};
  91   NetCard *src_;
  92   NetCard *dst_;
  93   void *link_;
  94 };
  95
  96 /** @ingroup SURF_routing_interface
  97  * @brief The class representing a whole routing platform
  98  */
  99 XBT_PUBLIC_CLASS RoutingPlatf {
 100 public:
 101   RoutingPlatf(Link *loopback);
 102   ~RoutingPlatf();
 103   AsImpl *root_ = nullptr;
 104   Link *loopback_;
 105   xbt_dynar_t getOneLinkRoutes(void);
 106   void getRouteAndLatency(NetCard *src, NetCard *dst, std::vector<Link*> * links, double *latency);
 107 };
 108
 109 }
 110 }
 111
 112 #endif /* NETWORK_ROUTING_HPP_ */