1 /* Copyright (c) 2013-2015. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #ifndef NETWORK_ROUTING_HPP_
8 #define NETWORK_ROUTING_HPP_
11 #include <xbt/signal.hpp>
13 #include "surf_interface.hpp"
16 XBT_PUBLIC(void) routing_model_create( void *loopback);
26 class XBT_PRIVATE RoutingModelDescription;
27 class XBT_PRIVATE Onelink;
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
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;
45 /** @ingroup SURF_routing_interface
46 * @brief The Autonomous System (AS) routing interface
51 xbt_dynar_t p_indexNetworkElm = xbt_dynar_new(sizeof(char*),NULL);
52 xbt_dict_t p_bypassRoutes; /* store bypass routes */
53 e_surf_routing_hierarchy_t p_hierarchy;
54 char *p_name = nullptr;
55 As *p_routingFather = nullptr;
56 xbt_dict_t p_routingSons = xbt_dict_new_homogeneous(NULL);
58 xbt_dynar_t p_linkUpDownList = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
61 /* Close that AS: no more content can be added to it */
62 virtual void Seal()=0;
65 xbt_dict_free(&p_routingSons);
66 xbt_dynar_free(&p_indexNetworkElm);
67 xbt_dynar_free(&p_linkUpDownList);
74 * @brief Get the characteristics of the routing path between two points
76 * This function is used by the networking model to find the information it needs when starting a communication.
78 * The things are not straightforward because the platform can be routed using several routing models.
79 * 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.
80 * Some ASes may even not have any predefined links and use only coordinate informations to compute the latency.
82 * So, the path is constructed recursively, with each traversed AS adding its information to the set.
83 * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/
85 * @param src Initial point of the routing path
86 * @param dst Final point of the routing path
87 * @param into Container into which the links should be pushed
88 * @param latency Accumulator in which the latencies should be added
90 virtual void getRouteAndLatency(
91 NetCard *src, NetCard *dst,
92 sg_platf_route_cbarg_t into, double *latency)=0;
93 virtual xbt_dynar_t getOneLinkRoutes()=0;
94 virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
95 virtual sg_platf_route_cbarg_t getBypassRoute(
96 NetCard *src, NetCard *dst,
99 /* The parser calls the following functions to inform the routing models
100 * that a new element is added to the AS currently built.
102 * Of course, only the routing model of this AS is informed, not every ones */
103 virtual int parsePU(NetCard *elm)=0; /* A host or a router, whatever */
104 virtual int parseAS(NetCard *elm)=0;
105 virtual void parseRoute(sg_platf_route_cbarg_t route)=0;
106 virtual void parseASroute(sg_platf_route_cbarg_t route)=0;
107 virtual void parseBypassroute(sg_platf_route_cbarg_t e_route)=0;
110 struct XBT_PRIVATE NetCardImpl : public NetCard {
112 NetCardImpl(const char *name, e_surf_network_element_type_t componentType, As *component)
113 : component_(component),
114 componentType_(componentType),
115 name_(xbt_strdup(name)) {}
116 ~NetCardImpl() { xbt_free(name_);};
118 int getId() {return id_;}
119 int *getIdPtr() {return &id_;}
120 void setId(int id) {id_ = id;}
121 char *getName() {return name_;}
122 As *getRcComponent() {return component_;}
123 e_surf_network_element_type_t getRcType() {return componentType_;}
126 e_surf_network_element_type_t componentType_;
131 /** @ingroup SURF_routing_interface
132 * @brief Link of lenght 1, alongside with its source and destination. This is mainly usefull in the ns3 bindings
136 Onelink(void *link, NetCard *src, NetCard *dst)
137 : p_src(src), p_dst(dst), p_link(link) {};
143 /** @ingroup SURF_routing_interface
144 * @brief The class representing a whole routing platform
146 XBT_PUBLIC_CLASS RoutingPlatf {
148 RoutingPlatf(void *loopback);
150 As *p_root = nullptr;
152 xbt_dynar_t p_lastRoute = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
153 xbt_dynar_t getOneLinkRoutes(void);
154 xbt_dynar_t recursiveGetOneLinkRoutes(As *rc);
155 void getRouteAndLatency(NetCard *src, NetCard *dst, xbt_dynar_t * links, double *latency);
162 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(NetCard*)>) netcardCreatedCallbacks;
163 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(As*)>) asCreatedCallbacks;
168 #endif /* NETWORK_ROUTING_HPP_ */