Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
move some content from AsNone into As (AsNone should die)
[simgrid.git] / src / surf / surf_routing.hpp
index 6ed29be..600edf1 100644 (file)
@@ -8,6 +8,7 @@
 #define NETWORK_ROUTING_HPP_
 
 #include <xbt/base.h>
+#include <xbt/signal.hpp>
 
 #include "surf_interface.hpp"
 #include <float.h>
@@ -47,15 +48,15 @@ public:
  */
 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;
+  char *p_name = nullptr;
+  As *p_routingFather = nullptr;
+  xbt_dict_t p_routingSons = xbt_dict_new_homogeneous(NULL);
   NetCard *p_netElem;
-  xbt_dynar_t p_linkUpDownList;
+  xbt_dynar_t p_linkUpDownList = NULL;
 
   /**
    * @brief The As constructor
@@ -66,28 +67,39 @@ public:
    * @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_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(
-    NetCard *src, NetCard *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(
-    NetCard *src, NetCard *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.
@@ -119,20 +131,6 @@ private:
   char *p_name;
 };
 
-struct RoutingEdgeWrapper : public NetCard {
-public:
-  RoutingEdgeWrapper(NetCard *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:
-  NetCard *p_re;
-};
-
 /** @ingroup SURF_routing_interface
  * @brief Link of lenght 1, alongside with its source and destination. This is mainly usefull in the ns3 bindings
  */
@@ -163,8 +161,8 @@ public:
  * Callbacks *
  *************/
 
-XBT_PUBLIC_DATA(simgrid::surf::signal<void(NetCard*)>) routingEdgeCreatedCallbacks;
-XBT_PUBLIC_DATA(simgrid::surf::signal<void(As*)>) asCreatedCallbacks;
+XBT_PUBLIC_DATA(simgrid::xbt::signal<void(NetCard*)>) routingEdgeCreatedCallbacks;
+XBT_PUBLIC_DATA(simgrid::xbt::signal<void(As*)>) asCreatedCallbacks;
 
 }
 }