X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/54e35ebda7e4ffacd769653b8ebb8ba93c7298bf..18801754584f9ffc3e7c2407008ac24c0eb57926:/src/surf/surf_routing.hpp diff --git a/src/surf/surf_routing.hpp b/src/surf/surf_routing.hpp index 6877e4c958..7fdd8601ac 100644 --- a/src/surf/surf_routing.hpp +++ b/src/surf/surf_routing.hpp @@ -1,31 +1,47 @@ -/* Copyright (c) 2013-2014. The SimGrid Team. +/* Copyright (c) 2013-2015. The SimGrid Team. * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ -#include "surf_interface.hpp" -#include - #ifndef NETWORK_ROUTING_HPP_ #define NETWORK_ROUTING_HPP_ +#include +#include + +#include "surf_interface.hpp" +#include + XBT_PUBLIC(void) routing_model_create( void *loopback); -/* ************************************************************************** */ -/* ************************* GRAPH EXPORTING FUNCTIONS ********************** */ -xbt_node_t new_xbt_graph_node (xbt_graph_t graph, const char *name, xbt_dict_t nodes); -xbt_edge_t new_xbt_graph_edge (xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xbt_dict_t edges); +namespace simgrid { +namespace surf { /*********** * Classes * ***********/ class As; -class RoutingModelDescription; -class Onelink; +class XBT_PRIVATE RoutingModelDescription; +class XBT_PRIVATE Onelink; class RoutingPlatf; +/** @ingroup SURF_routing_interface + * @brief A network card + * @details This represents a position in the network. One can route information between two netcards + */ +class NetCard { +public: + virtual ~NetCard(){}; + virtual int getId()=0; + virtual int *getIdPtr()=0; + virtual void setId(int id)=0; + virtual char *getName()=0; + virtual As *getRcComponent()=0; + virtual e_surf_network_element_type_t getRcType()=0; +}; + /** @ingroup SURF_routing_interface * @brief The Autonomous System (AS) routing interface * @details [TODO] @@ -39,7 +55,7 @@ public: char *p_name; As *p_routingFather; xbt_dict_t p_routingSons; - RoutingEdge *p_netElem; + NetCard *p_netElem; xbt_dynar_t p_linkUpDownList; /** @@ -52,53 +68,52 @@ public: */ virtual ~As(){ xbt_free(p_name); + if (p_netElem) + delete p_netElem; }; /** - * @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; + virtual void getRouteAndLatency( + 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; + virtual sg_platf_route_cbarg_t getBypassRoute( + 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; }; -/** @ingroup SURF_routing_interface - * @brief A routing edge - * @details [long description] - */ -struct RoutingEdge { +struct XBT_PRIVATE NetCardImpl : public NetCard { public: - virtual ~RoutingEdge(){}; - virtual int getId()=0; - virtual int *getIdPtr()=0; - virtual void setId(int id)=0; - virtual char *getName()=0; - virtual As *getRcComponent()=0; - virtual e_surf_network_element_type_t getRcType()=0; -}; - -struct RoutingEdgeImpl : public RoutingEdge { -public: - RoutingEdgeImpl(char *name, int id, e_surf_network_element_type_t rcType, As *rcComponent) + NetCardImpl(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);}; + ~NetCardImpl() { xbt_free(p_name);}; int getId() {return m_id;} int *getIdPtr() {return &m_id;} @@ -113,29 +128,15 @@ private: char *p_name; }; -struct RoutingEdgeWrapper : public RoutingEdge { -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();} -private: - RoutingEdge *p_re; -}; - /** @ingroup SURF_routing_interface - * @brief Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3 + * @brief Link of lenght 1, alongside with its source and destination. This is mainly usefull in the ns3 bindings */ 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; }; @@ -150,7 +151,17 @@ public: xbt_dynar_t p_lastRoute; 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(simgrid::xbt::signal) routingEdgeCreatedCallbacks; +XBT_PUBLIC_DATA(simgrid::xbt::signal) asCreatedCallbacks; + +} +} + #endif /* NETWORK_ROUTING_HPP_ */