include/simgrid/kernel/routing/DijkstraZone.hpp

   1 /* Copyright (c) 2013-2020. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SURF_ROUTING_DIJKSTRA_HPP_
   7 #define SURF_ROUTING_DIJKSTRA_HPP_
   8
   9 #include <simgrid/kernel/routing/RoutedZone.hpp>
  10
  11
  12 namespace simgrid {
  13 namespace kernel {
  14 namespace routing {
  15
  16 /** @ingroup ROUTING_API
  17  *  @brief NetZone with an explicit routing computed on need with Dijkstra
  18  *
  19  *  The path between components is computed each time you request it,
  20  *  using the Dijkstra algorithm. A cache can be used to reduce the computation.
  21  *
  22  *  This result in rather small platform file, very fast initialization, and very low memory requirements, but somehow
  23  * long path resolution times.
  24  */
  25 class XBT_PRIVATE DijkstraZone : public RoutedZone {
  26 private:
  27   static void route_graph_delete(xbt_graph_t);
  28
  29   std::unique_ptr<s_xbt_graph_t, decltype(&DijkstraZone::route_graph_delete)> route_graph_{
  30       xbt_graph_new_graph(1, nullptr), &DijkstraZone::route_graph_delete};
  31   std::map<int, xbt_node_t> graph_node_map_;
  32   bool cached_;
  33   std::map<int, std::vector<int>> route_cache_;
  34
  35   xbt_node_t route_graph_new_node(int id);
  36   xbt_node_t node_map_search(int id);
  37   void new_edge(int src_id, int dst_id, RouteCreationArgs* e_route);
  38
  39 public:
  40   DijkstraZone(NetZoneImpl* father, const std::string& name, resource::NetworkModel* netmodel, bool cached);
  41
  42   /* For each vertex (node) already in the graph,
  43    * make sure it also has a loopback link; this loopback
  44    * can potentially already be in the graph, and in that
  45    * case nothing will be done.
  46    *
  47    * If no loopback is specified for a node, we will use
  48    * the loopback that is provided by the routing platform.
  49    *
  50    * After this function returns, any node in the graph
  51    * will have a loopback attached to it.
  52    */
  53   void seal() override;
  54   void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* route, double* lat) override;
  55   void add_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
  56                  std::vector<resource::LinkImpl*>& link_list, bool symmetrical) override;
  57 };
  58 } // namespace routing
  59 } // namespace kernel
  60 } // namespace simgrid
  61
  62 #endif /* SURF_ROUTING_DIJKSTRA_HPP_ */