X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0ef25bc8b50d2820e612d6f416bf2c8657b0658e..5fedb73886fa7c03fcc89ca008fb7a6dc72d80a1:/src/surf/surf_routing.hpp

diff --git a/src/surf/surf_routing.hpp b/src/surf/surf_routing.hpp
index 8ffb46fbf0..b0d8e0a3c7 100644
--- a/src/surf/surf_routing.hpp
+++ b/src/surf/surf_routing.hpp
@@ -28,17 +28,17 @@ class XBT_PRIVATE Onelink;
 class RoutingPlatf;
 
 /** @ingroup SURF_routing_interface
- * @brief A network card
+ * @brief Network cards are the vertices in the graph representing the network, used to compute paths between nodes.
+ *
  * @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 int id()=0; // Our rank in the vertices_ array of our containing AS.
   virtual void setId(int id)=0;
-  virtual char *getName()=0;
-  virtual As *getRcComponent()=0;
+  virtual char *name()=0;
+  virtual As *containingAS()=0; // This is the AS in which I am
   virtual e_surf_network_element_type_t getRcType()=0;
 };
 
@@ -58,7 +58,7 @@ public:
   As *father_ = nullptr;
   xbt_dict_t sons_ = xbt_dict_new_homogeneous(NULL);
 
-  xbt_dynar_t p_indexNetworkElm = xbt_dynar_new(sizeof(char*),NULL); // TODO: What is it?
+  xbt_dynar_t vertices_ = xbt_dynar_new(sizeof(char*),NULL); // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
   xbt_dict_t bypassRoutes_ = nullptr;
   e_surf_routing_hierarchy_t hierarchy_ = SURF_ROUTING_NULL;
   xbt_dynar_t upDownLinks = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
@@ -66,11 +66,18 @@ public:
 
 
   /**
-   * @brief Get the characteristics of the routing path between two points
+   * @brief Probe 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 networking model uses this function when creating a communication
+   * to retrieve both the list of links that the create communication will use,
+   * and the summed latency that these links represent.
    *
-   * The things are not straightforward because the platform can be routed using several routing models.
+   * The network could recompute the latency by itself from the list, but it would
+   * require an additional link set traversal. This operation being on the critical
+   * path of SimGrid, the routing computes the latency in behalf of the network.
+   *
+   * Things are rather complex here because we have to find the path from ASes to ASes, and within each.
+   * In addition, the different ASes may use differing 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.
    *
@@ -79,48 +86,42 @@ public:
    * 
    * @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
+   * @param into Container into which the traversed links should be pushed
+   * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
    */
-  virtual void getRouteAndLatency(
-      NetCard *src, NetCard *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;
+  /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
   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;
+  virtual sg_platf_route_cbarg_t getBypassRoute(NetCard *src, NetCard *dst,double *lat);
 
-  /* 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 */
+  /* Add content to the AS, at parsing time. It should be sealed afterward. */
   virtual int addComponent(NetCard *elm); /* A host, a router or an AS, whatever */
-  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;
+  virtual void parseRoute(sg_platf_route_cbarg_t route);
+  virtual void parseBypassroute(sg_platf_route_cbarg_t e_route);
 };
 
 struct XBT_PRIVATE NetCardImpl : public NetCard {
 public:
-  NetCardImpl(const char *name, e_surf_network_element_type_t componentType, As *component)
-  : component_(component),
+  NetCardImpl(const char *name, e_surf_network_element_type_t componentType, As *as)
+  : name_(xbt_strdup(name)),
     componentType_(componentType),
-    name_(xbt_strdup(name))
+    containingAS_(as)
   {}
   ~NetCardImpl() { xbt_free(name_);};
 
-  int getId() {return id_;}
-  int *getIdPtr() {return &id_;}
-  void setId(int id) {id_ = id;}
-  char *getName() {return name_;}
-  As *getRcComponent() {return component_;}
-  e_surf_network_element_type_t getRcType() {return componentType_;}
+  int id()           override {return id_;}
+  void setId(int id) override {id_ = id;}
+  char *name()       override {return name_;}
+  As *containingAS() override {return containingAS_;}
+  e_surf_network_element_type_t getRcType() override {return componentType_;}
 private:
-  As *component_;
-  e_surf_network_element_type_t componentType_;
   int id_ = -1;
   char *name_;
+  e_surf_network_element_type_t componentType_;
+  As *containingAS_;
 };
 
 /** @ingroup SURF_routing_interface