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
52 /** @brief Close that AS: no more content can be added to it */
53 virtual void Seal()=0;
56 char *name_ = nullptr;
57 NetCard *netcard_ = nullptr;
58 As *father_ = nullptr;
59 xbt_dict_t sons_ = xbt_dict_new_homogeneous(NULL);
61 xbt_dynar_t p_indexNetworkElm = xbt_dynar_new(sizeof(char*),NULL); // TODO: What is it?
62 xbt_dict_t bypassRoutes_ = nullptr;
63 e_surf_routing_hierarchy_t hierarchy_ = SURF_ROUTING_NULL;
64 xbt_dynar_t upDownLinks = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
69 * @brief Get the characteristics of the routing path between two points
71 * This function is used by the networking model to find the information it needs when starting a communication.
73 * The things are not straightforward because the platform can be routed using several routing models.
74 * 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.
75 * Some ASes may even not have any predefined links and use only coordinate informations to compute the latency.
77 * So, the path is constructed recursively, with each traversed AS adding its information to the set.
78 * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/
80 * @param src Initial point of the routing path
81 * @param dst Final point of the routing path
82 * @param into Container into which the links should be pushed
83 * @param latency Accumulator in which the latencies should be added
85 virtual void getRouteAndLatency(
86 NetCard *src, NetCard *dst,
87 sg_platf_route_cbarg_t into, double *latency)=0;
88 virtual xbt_dynar_t getOneLinkRoutes()=0;
90 virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
92 virtual sg_platf_route_cbarg_t getBypassRoute(NetCard *src, NetCard *dst,double *lat)=0;
94 /* The parser calls the following functions to inform the routing models
95 * that a new element is added to the AS currently built.
97 * Of course, only the routing model of this AS is informed, not every ones */
98 virtual int addComponent(NetCard *elm); /* A host, a router or an AS, whatever */
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;
104 struct XBT_PRIVATE NetCardImpl : public NetCard {
106 NetCardImpl(const char *name, e_surf_network_element_type_t componentType, As *component)
107 : component_(component),
108 componentType_(componentType),
109 name_(xbt_strdup(name))
111 ~NetCardImpl() { xbt_free(name_);};
113 int getId() {return id_;}
114 int *getIdPtr() {return &id_;}
115 void setId(int id) {id_ = id;}
116 char *getName() {return name_;}
117 As *getRcComponent() {return component_;}
118 e_surf_network_element_type_t getRcType() {return componentType_;}
121 e_surf_network_element_type_t componentType_;
126 /** @ingroup SURF_routing_interface
127 * @brief Link of lenght 1, alongside with its source and destination. This is mainly usefull in the ns3 bindings
131 Onelink(void *link, NetCard *src, NetCard *dst)
132 : p_src(src), p_dst(dst), p_link(link) {};
138 /** @ingroup SURF_routing_interface
139 * @brief The class representing a whole routing platform
141 XBT_PUBLIC_CLASS RoutingPlatf {
143 RoutingPlatf(void *loopback);
145 As *p_root = nullptr;
147 xbt_dynar_t p_lastRoute = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
148 xbt_dynar_t getOneLinkRoutes(void);
149 xbt_dynar_t recursiveGetOneLinkRoutes(As *rc);
150 void getRouteAndLatency(NetCard *src, NetCard *dst, xbt_dynar_t * links, double *latency);
157 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(NetCard*)>) netcardCreatedCallbacks;
158 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(As*)>) asCreatedCallbacks;
163 #endif /* NETWORK_ROUTING_HPP_ */