X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d0ffc37686edcc803601f76ab51fdfed5fc2f241..c46c0b0d1e605253fa05ccf16251d1a753b3fec7:/src/surf/surf_routing.hpp diff --git a/src/surf/surf_routing.hpp b/src/surf/surf_routing.hpp index 2e5e36bbd9..6877e4c958 100644 --- a/src/surf/surf_routing.hpp +++ b/src/surf/surf_routing.hpp @@ -1,36 +1,35 @@ -#include "surf.hpp" +/* Copyright (c) 2013-2014. 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_ -void routing_model_create( void *loopback); +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); /*********** * Classes * ***********/ -class As; -typedef As *AsPtr; +class As; class RoutingModelDescription; -typedef RoutingModelDescription *RoutingModelDescriptionPtr; - -class RoutingEdge; -typedef RoutingEdge *RoutingEdgePtr; - class Onelink; -typedef Onelink *OnelinkPtr; - class RoutingPlatf; -typedef RoutingPlatf *RoutingPlatfPtr; - - -/*FIXME:class RoutingModelDescription { - const char *p_name; - const char *p_desc; - AsPtr create(); - void end(AsPtr as); -};*/ +/** @ingroup SURF_routing_interface + * @brief The Autonomous System (AS) routing interface + * @details [TODO] + */ class As { public: xbt_dynar_t p_indexNetworkElm; @@ -38,56 +37,120 @@ public: routing_model_description_t p_modelDesc; e_surf_routing_hierarchy_t p_hierarchy; char *p_name; - AsPtr p_routingFather; + As *p_routingFather; xbt_dict_t p_routingSons; - RoutingEdgePtr p_netElem; + RoutingEdge *p_netElem; xbt_dynar_t p_linkUpDownList; + /** + * @brief The As constructor + */ As(){}; - ~As(){}; - virtual void getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, sg_platf_route_cbarg_t into, double *latency)=0; + /** + * @brief The As destructor + */ + virtual ~As(){ + xbt_free(p_name); + }; + + /** + * @brief Get the route and latency between two RoutingEdges + * @details [long description] + * + * @param src [description] + * @param dst [description] + * @param into [description] + * @param latency [description] + */ + virtual void getRouteAndLatency(RoutingEdge *src, RoutingEdge *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(RoutingEdgePtr src, RoutingEdgePtr dst, double *lat)=0; + virtual sg_platf_route_cbarg_t getBypassRoute(RoutingEdge *src, RoutingEdge *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(RoutingEdgePtr elm)=0; /* A host or a router, whatever */ - virtual int parseAS( RoutingEdgePtr elm)=0; + virtual int parsePU(RoutingEdge *elm)=0; /* A host or a router, whatever */ + virtual int parseAS( RoutingEdge *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; }; -class RoutingEdge { +/** @ingroup SURF_routing_interface + * @brief A routing edge + * @details [long description] + */ +struct RoutingEdge { +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: - AsPtr p_rcComponent; + 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; }; -/* - * Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3 +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 */ class Onelink { public: - RoutingEdgePtr p_src; - RoutingEdgePtr p_dst; - void *p_linkPtr; + Onelink(void *link, RoutingEdge *src, RoutingEdge *dst) + : p_src(src), p_dst(dst), p_link(link) {}; + RoutingEdge *p_src; + RoutingEdge *p_dst; + void *p_link; }; -class RoutingPlatf { +/** @ingroup SURF_routing_interface + * @brief The class representing a whole routing platform + */ +XBT_PUBLIC_CLASS RoutingPlatf { public: - AsPtr p_root; + ~RoutingPlatf(); + As *p_root; void *p_loopback; xbt_dynar_t p_lastRoute; xbt_dynar_t getOneLinkRoutes(void); - xbt_dynar_t recursiveGetOneLinkRoutes(AsPtr rc); - void getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, xbt_dynar_t * links, double *latency); + xbt_dynar_t recursiveGetOneLinkRoutes(As *rc); + void getRouteAndLatency(RoutingEdge *src, RoutingEdge *dst, xbt_dynar_t * links, double *latency); }; #endif /* NETWORK_ROUTING_HPP_ */