Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
926f1a669efd8a816047b151deef334b2c8e024c
[simgrid.git] / 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_PRIVATE xbt_node_t new_xbt_graph_node (xbt_graph_t graph, const char *name, xbt_dict_t nodes);
22 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);
23 SG_END_DECL()
24
25 namespace simgrid {
26 namespace kernel {
27 namespace routing {
28
29   XBT_PUBLIC_DATA(simgrid::xbt::signal<void(s4u::As*)>) asCreatedCallbacks;
30   XBT_PUBLIC_DATA(simgrid::xbt::signal<void(NetCard*)>) netcardCreatedCallbacks;
31
32 /***********
33  * Classes *
34  ***********/
35
36 class XBT_PRIVATE Onelink;
37 class RoutingPlatf;
38
39 /** @ingroup SURF_routing_interface
40  * @brief Network cards are the vertices in the graph representing the network, used to compute paths between nodes.
41  *
42  * @details This represents a position in the network. One can route information between two netcards
43  */
44 class NetCard {
45 public:
46   virtual ~NetCard()            = default;
47   virtual unsigned int id()=0; // Our rank in the vertices_ array of our containing AS.
48   virtual std::string name()    = 0;
49   virtual AsImpl *containingAS()=0; // This is the AS in which I am
50   virtual bool isAS()=0;
51   virtual bool isHost()=0;
52   virtual bool isRouter()=0;
53   enum class Type {
54     Host, Router, As
55   };
56 };
57
58 struct XBT_PRIVATE NetCardImpl : public NetCard {
59 public:
60   NetCardImpl(std::string name, NetCard::Type componentType, AsImpl* containingAS)
61       : name_(name), componentType_(componentType), containingAS_(containingAS)
62   {
63     if (containingAS != nullptr)
64       id_ = containingAS->addComponent(this);
65     simgrid::kernel::routing::netcardCreatedCallbacks(this);
66   }
67   ~NetCardImpl() = default;
68
69   unsigned int id()  override {return id_;}
70   std::string name() override { return name_; }
71   AsImpl *containingAS() override {return containingAS_;}
72
73   bool isAS()        override {return componentType_ == Type::As;}
74   bool isHost()      override {return componentType_ == Type::Host;}
75   bool isRouter()    override {return componentType_ == Type::Router;}
76
77 private:
78   unsigned int id_;
79   std::string name_;
80   NetCard::Type componentType_;
81   AsImpl *containingAS_;
82 };
83
84 class AsRoute {
85 public:
86   explicit AsRoute(NetCard* gwSrc, NetCard* gwDst) : gw_src(gwSrc), gw_dst(gwDst) {}
87   const NetCard* gw_src;
88   const NetCard* gw_dst;
89   std::vector<Link*> links;
90 };
91
92 /** @ingroup SURF_routing_interface
93  * @brief Link of length 1, alongside with its source and destination. This is mainly useful in the ns3 bindings
94  */
95 class Onelink {
96 public:
97   Onelink(Link* link, NetCard* src, NetCard* dst) : src_(src), dst_(dst), link_(link){};
98   NetCard* src_;
99   NetCard* dst_;
100   Link* link_;
101 };
102
103 /** @ingroup SURF_routing_interface
104  * @brief The class representing a whole routing platform
105  */
106 XBT_PUBLIC_CLASS RoutingPlatf {
107 public:
108   explicit RoutingPlatf();
109   ~RoutingPlatf();
110   AsImpl *root_ = nullptr;
111   xbt_dynar_t getOneLinkRoutes();
112   void getRouteAndLatency(NetCard *src, NetCard *dst, std::vector<Link*> * links, double *latency);
113 };
114
115 }}}
116
117 #endif /* NETWORK_ROUTING_HPP_ */