include/simgrid/kernel/routing/DijkstraZone.hpp

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