Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
move the routing logic to its own directory
[simgrid.git] / src / surf / AsImpl.hpp
diff --git a/src/surf/AsImpl.hpp b/src/surf/AsImpl.hpp
deleted file mode 100644 (file)
index 5e64ccd..0000000
+++ /dev/null
@@ -1,77 +0,0 @@
-/* Copyright (c) 2016. 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. */
-
-#ifndef SIMGRID_SURF_AS_HPP
-#define SIMGRID_SURF_AS_HPP
-
-#include "xbt/graph.h"
-
-#include "simgrid/s4u/forward.hpp"
-#include "simgrid/s4u/As.hpp"
-
-#include "src/surf/xml/platf_private.hpp" // FIXME: kill sg_platf_route_cbarg_t to remove that UGLY include
-
-namespace simgrid {
-namespace routing {
-  class RoutingPlatf; // FIXME: KILLME
-
-/** @brief Autonomous Systems
- *
- * An AS is a network container, in charge of routing information between elements (hosts) and to the nearby ASes.
- * In SimGrid, there is a hierarchy of ASes, with a unique root AS (that you can retrieve from the s4u::Engine).
- */
-XBT_PUBLIC_CLASS AsImpl : public s4u::As {
-  friend simgrid::routing::RoutingPlatf;
-protected:
-  explicit AsImpl(const char *name);
-  ~AsImpl() override;
-  
-public:
-  /**
-   * @brief Probe the routing path between two points
-   *
-   * 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 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 information 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 Initial point of the routing path
-   * @param dst Final point of the routing path
-   * @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;
-  /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
-  virtual xbt_dynar_t getOneLinkRoutes();
-  std::vector<surf::Link*> *getBypassRoute(routing::NetCard *src, routing::NetCard *dst);
-
-  virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
-  static void getRouteRecursive(routing::NetCard *src, routing::NetCard *dst, /* OUT */ std::vector<surf::Link*> * links, double *latency);
-
-
-  enum class RoutingMode {
-    unset = 0,  /**< Undefined type                                   */
-    base,       /**< Base case: use simple link lists for routing     */
-    recursive   /**< Recursive case: also return gateway information  */
-  };
-  /* FIXME: protect the following fields once the construction madness is sorted out */
-  RoutingMode hierarchy_ = RoutingMode::unset;
-  routing::NetCard *netcard_ = nullptr; // Our representative in the father AS
-};
-
-}}; // Namespace simgrid::s4u
-
-#endif /* SIMGRID_SURF_AS_HPP */