Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
port NS3 to the new signals in simgrid::Host
[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 <float.h>
15
16 XBT_PUBLIC(void) routing_model_create( void *loopback);
17
18 namespace simgrid {
19 namespace surf {
20
21 /***********
22  * Classes *
23  ***********/
24
25 class As;
26 class XBT_PRIVATE RoutingModelDescription;
27 class XBT_PRIVATE Onelink;
28 class RoutingPlatf;
29
30 /** @ingroup SURF_routing_interface
31  * @brief A network card
32  * @details This represents a position in the network. One can route information between two netcards
33  */
34 class NetCard {
35 public:
36   virtual ~NetCard(){};
37   virtual int getId()=0;
38   virtual int *getIdPtr()=0;
39   virtual void setId(int id)=0;
40   virtual char *getName()=0;
41   virtual As *getRcComponent()=0;
42   virtual e_surf_network_element_type_t getRcType()=0;
43 };
44
45 /** @ingroup SURF_routing_interface
46  * @brief The Autonomous System (AS) routing interface
47  * @details [TODO]
48  */
49 class As {
50 public:
51   xbt_dynar_t p_indexNetworkElm;
52   xbt_dict_t p_bypassRoutes;    /* store bypass routes */
53   routing_model_description_t p_modelDesc;
54   e_surf_routing_hierarchy_t p_hierarchy;
55   char *p_name;
56   As *p_routingFather;
57   xbt_dict_t p_routingSons;
58   NetCard *p_netElem;
59   xbt_dynar_t p_linkUpDownList;
60
61   /**
62    * @brief The As constructor
63    */
64   As(){};
65
66   /**
67    * @brief The As destructor
68    */
69   virtual ~As(){
70         xbt_free(p_name);
71         if (p_netElem)
72                 delete p_netElem;
73   };
74
75   /**
76    * @brief Get the route and latency between two RoutingEdges
77    * @details [long description]
78    * 
79    * @param src [description]
80    * @param dst [description]
81    * @param into [description]
82    * @param latency [description]
83    */
84   virtual void getRouteAndLatency(
85     NetCard *src, NetCard *dst,
86     sg_platf_route_cbarg_t into, double *latency)=0;
87   virtual xbt_dynar_t getOneLinkRoutes()=0;
88   virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
89   virtual sg_platf_route_cbarg_t getBypassRoute(
90     NetCard *src, NetCard *dst,
91     double *lat)=0;
92
93   /* The parser calls the following functions to inform the routing models
94    * that a new element is added to the AS currently built.
95    *
96    * Of course, only the routing model of this AS is informed, not every ones */
97   virtual int parsePU(NetCard *elm)=0; /* A host or a router, whatever */
98   virtual int parseAS(NetCard *elm)=0;
99   virtual void parseRoute(sg_platf_route_cbarg_t route)=0;
100   virtual void parseASroute(sg_platf_route_cbarg_t route)=0;
101   virtual void parseBypassroute(sg_platf_route_cbarg_t e_route)=0;
102 };
103
104 struct XBT_PRIVATE NetCardImpl : public NetCard {
105 public:
106   NetCardImpl(char *name, int id, e_surf_network_element_type_t rcType, As *rcComponent)
107   : p_rcComponent(rcComponent), p_rcType(rcType), m_id(id), p_name(name) {}
108   ~NetCardImpl() { xbt_free(p_name);};
109
110   int getId() {return m_id;}
111   int *getIdPtr() {return &m_id;}
112   void setId(int id) {m_id = id;}
113   char *getName() {return p_name;}
114   As *getRcComponent() {return p_rcComponent;}
115   e_surf_network_element_type_t getRcType() {return p_rcType;}
116 private:
117   As *p_rcComponent;
118   e_surf_network_element_type_t p_rcType;
119   int m_id;
120   char *p_name;
121 };
122
123 /** @ingroup SURF_routing_interface
124  * @brief Link of lenght 1, alongside with its source and destination. This is mainly usefull in the ns3 bindings
125  */
126 class Onelink {
127 public:
128   Onelink(void *link, NetCard *src, NetCard *dst)
129     : p_src(src), p_dst(dst), p_link(link) {};
130   NetCard *p_src;
131   NetCard *p_dst;
132   void *p_link;
133 };
134
135 /** @ingroup SURF_routing_interface
136  * @brief The class representing a whole routing platform
137  */
138 XBT_PUBLIC_CLASS RoutingPlatf {
139 public:
140   ~RoutingPlatf();
141   As *p_root;
142   void *p_loopback;
143   xbt_dynar_t p_lastRoute;
144   xbt_dynar_t getOneLinkRoutes(void);
145   xbt_dynar_t recursiveGetOneLinkRoutes(As *rc);
146   void getRouteAndLatency(NetCard *src, NetCard *dst, xbt_dynar_t * links, double *latency);
147 };
148
149 /*************
150  * Callbacks *
151  *************/
152
153 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(NetCard*)>) routingEdgeCreatedCallbacks;
154 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(As*)>) asCreatedCallbacks;
155
156 }
157 }
158
159 #endif /* NETWORK_ROUTING_HPP_ */