include/simgrid/kernel/routing/DijkstraZone.hpp

   1 /* Copyright (c) 2013-2018. 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 Dijsktra
  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 public:
  27   DijkstraZone(NetZoneImpl* father, std::string name, bool cached);
  28   void seal() override;
  29
  30   ~DijkstraZone() override;
  31
  32 private:
  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, RouteCreationArgs* e_route);
  36
  37 public:
  38   /* For each vertex (node) already in the graph,
  39    * make sure it also has a loopback link; this loopback
  40    * can potentially already be in the graph, and in that
  41    * case nothing will be done.
  42    *
  43    * If no loopback is specified for a node, we will use
  44    * the loopback that is provided by the routing platform.
  45    *
  46    * After this function returns, any node in the graph
  47    * will have a loopback attached to it.
  48    */
  49   void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* route, double* lat) override;
  50   void add_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
  51                  std::vector<resource::LinkImpl*>& link_list, bool symmetrical) override;
  52
  53   xbt_graph_t route_graph_ = nullptr;          /* xbt_graph */
  54   std::map<int, xbt_node_t> graph_node_map_;   /* map */
  55   bool cached_;                                /* cache mode */
  56   std::map<int, std::vector<int>> route_cache_; /* use in cache mode */
  57 };
  58 } // namespace routing
  59 } // namespace kernel
  60 } // namespace simgrid
  61
  62 #endif /* SURF_ROUTING_DIJKSTRA_HPP_ */