include/simgrid/kernel/routing/DijkstraZone.hpp

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