#define NETWORK_ROUTING_HPP_
#include <xbt/base.h>
+#include <xbt/signal.hpp>
#include "surf_interface.hpp"
#include <float.h>
class RoutingPlatf;
/** @ingroup SURF_routing_interface
- * @brief A routing edge
- * @details [long description]
+ * @brief A network card
+ * @details This represents a position in the network. One can route information between two netcards
*/
-class RoutingEdge {
+class NetCard {
public:
- virtual ~RoutingEdge(){};
+ virtual ~NetCard(){};
virtual int getId()=0;
virtual int *getIdPtr()=0;
virtual void setId(int id)=0;
*/
class As {
public:
- xbt_dynar_t p_indexNetworkElm;
+ xbt_dynar_t p_indexNetworkElm = xbt_dynar_new(sizeof(char*),NULL);
xbt_dict_t p_bypassRoutes; /* store bypass routes */
routing_model_description_t p_modelDesc;
e_surf_routing_hierarchy_t p_hierarchy;
- char *p_name;
- As *p_routingFather;
- xbt_dict_t p_routingSons;
- RoutingEdge *p_netElem;
- xbt_dynar_t p_linkUpDownList;
+ char *p_name = nullptr;
+ As *p_routingFather = nullptr;
+ xbt_dict_t p_routingSons = xbt_dict_new_homogeneous(NULL);
+ NetCard *p_netcard;
+ xbt_dynar_t p_linkUpDownList = NULL;
- /**
- * @brief The As constructor
- */
As(){};
+ /* Close that AS: no more content can be added to it */
+ virtual void Seal()=0;
- /**
- * @brief The As destructor
- */
virtual ~As(){
- xbt_free(p_name);
- if (p_netElem)
- delete p_netElem;
+ xbt_dict_free(&p_routingSons);
+ xbt_dynar_free(&p_indexNetworkElm);
+ xbt_dynar_free(&p_linkUpDownList);
+ xbt_free(p_name);
+ if (p_netcard)
+ delete p_netcard;
};
/**
- * @brief Get the route and latency between two RoutingEdges
- * @details [long description]
+ * @brief Get the characteristics of the routing path between two points
+ *
+ * This function is used by the networking model to find the information it needs when starting a communication.
+ *
+ * The things are not straightforward because the platform can be routed using several routing models.
+ * Some ASes may be routed in full, others may have only some connection information and use a shortest path on top of that, and so on.
+ * Some ASes may even not have any predefined links and use only coordinate informations to compute the latency.
+ *
+ * So, the path is constructed recursively, with each traversed AS adding its information to the set.
+ * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/
*
- * @param src [description]
- * @param dst [description]
- * @param into [description]
- * @param latency [description]
+ * @param src Initial point of the routing path
+ * @param dst Final point of the routing path
+ * @param into Container into which the links should be pushed
+ * @param latency Accumulator in which the latencies should be added
*/
virtual void getRouteAndLatency(
- RoutingEdge *src, RoutingEdge *dst,
- sg_platf_route_cbarg_t into, double *latency)=0;
+ NetCard *src, NetCard *dst,
+ sg_platf_route_cbarg_t into, double *latency)=0;
virtual xbt_dynar_t getOneLinkRoutes()=0;
virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
virtual sg_platf_route_cbarg_t getBypassRoute(
- RoutingEdge *src, RoutingEdge *dst,
- double *lat)=0;
+ NetCard *src, NetCard *dst,
+ double *lat)=0;
/* The parser calls the following functions to inform the routing models
* that a new element is added to the AS currently built.
*
* Of course, only the routing model of this AS is informed, not every ones */
- virtual int parsePU(RoutingEdge *elm)=0; /* A host or a router, whatever */
- virtual int parseAS(RoutingEdge *elm)=0;
+ virtual int parsePU(NetCard *elm)=0; /* A host or a router, whatever */
+ virtual int parseAS(NetCard *elm)=0;
virtual void parseRoute(sg_platf_route_cbarg_t route)=0;
virtual void parseASroute(sg_platf_route_cbarg_t route)=0;
virtual void parseBypassroute(sg_platf_route_cbarg_t e_route)=0;
};
-struct XBT_PRIVATE RoutingEdgeImpl : public RoutingEdge {
-public:
- RoutingEdgeImpl(char *name, int id, e_surf_network_element_type_t rcType, As *rcComponent)
- : p_rcComponent(rcComponent), p_rcType(rcType), m_id(id), p_name(name) {}
- ~RoutingEdgeImpl() { xbt_free(p_name);};
-
- int getId() {return m_id;}
- int *getIdPtr() {return &m_id;}
- void setId(int id) {m_id = id;}
- char *getName() {return p_name;}
- As *getRcComponent() {return p_rcComponent;}
- e_surf_network_element_type_t getRcType() {return p_rcType;}
-private:
- As *p_rcComponent;
- e_surf_network_element_type_t p_rcType;
- int m_id;
- char *p_name;
-};
-
-struct RoutingEdgeWrapper : public RoutingEdge {
+struct XBT_PRIVATE NetCardImpl : public NetCard {
public:
- RoutingEdgeWrapper(RoutingEdge *re) : p_re(re){}
- ~RoutingEdgeWrapper(){}
- int getId() {return p_re->getId();}
- int *getIdPtr() {return p_re->getIdPtr();}
- void setId(int id) {p_re->setId(id);}
- char *getName() {return p_re->getName();}
- As *getRcComponent() {return p_re->getRcComponent();}
- e_surf_network_element_type_t getRcType() {return p_re->getRcType();}
+ NetCardImpl(const char *name, e_surf_network_element_type_t componentType, As *component)
+ : component_(component),
+ componentType_(componentType),
+ name_(xbt_strdup(name)) {}
+ ~NetCardImpl() { xbt_free(name_);};
+
+ int getId() {return id_;}
+ int *getIdPtr() {return &id_;}
+ void setId(int id) {id_ = id;}
+ char *getName() {return name_;}
+ As *getRcComponent() {return component_;}
+ e_surf_network_element_type_t getRcType() {return componentType_;}
private:
- RoutingEdge *p_re;
+ As *component_;
+ e_surf_network_element_type_t componentType_;
+ int id_ = -1;
+ char *name_;
};
/** @ingroup SURF_routing_interface
*/
class Onelink {
public:
- Onelink(void *link, RoutingEdge *src, RoutingEdge *dst)
+ Onelink(void *link, NetCard *src, NetCard *dst)
: p_src(src), p_dst(dst), p_link(link) {};
- RoutingEdge *p_src;
- RoutingEdge *p_dst;
+ NetCard *p_src;
+ NetCard *p_dst;
void *p_link;
};
*/
XBT_PUBLIC_CLASS RoutingPlatf {
public:
+ RoutingPlatf(void *loopback);
~RoutingPlatf();
- As *p_root;
+ As *p_root = nullptr;
void *p_loopback;
- xbt_dynar_t p_lastRoute;
+ xbt_dynar_t p_lastRoute = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
xbt_dynar_t getOneLinkRoutes(void);
xbt_dynar_t recursiveGetOneLinkRoutes(As *rc);
- void getRouteAndLatency(RoutingEdge *src, RoutingEdge *dst, xbt_dynar_t * links, double *latency);
+ void getRouteAndLatency(NetCard *src, NetCard *dst, xbt_dynar_t * links, double *latency);
};
/*************
* Callbacks *
*************/
-XBT_PUBLIC_DATA(surf_callback(void, RoutingEdge*)) routingEdgeCreatedCallbacks;
-XBT_PUBLIC_DATA(surf_callback(void, As*)) asCreatedCallbacks;
+XBT_PUBLIC_DATA(simgrid::xbt::signal<void(NetCard*)>) netcardCreatedCallbacks;
+XBT_PUBLIC_DATA(simgrid::xbt::signal<void(As*)>) asCreatedCallbacks;
}
}
