Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'Adrien.Gougeon/simgrid-master'
[simgrid.git] / include / simgrid / kernel / routing / DragonflyZone.hpp
1 /* Copyright (c) 2014-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_CLUSTER_DRAGONFLY_HPP_
7 #define SURF_ROUTING_CLUSTER_DRAGONFLY_HPP_
8
9 #include <simgrid/kernel/routing/ClusterZone.hpp>
10 #include <simgrid/s4u/Link.hpp>
11
12 namespace simgrid {
13 namespace kernel {
14 namespace routing {
15
16 class DragonflyRouter {
17 public:
18   unsigned int group_;
19   unsigned int chassis_;
20   unsigned int blade_;
21   resource::LinkImpl* blue_link_ = nullptr;
22   std::vector<resource::LinkImpl*> black_links_;
23   std::vector<resource::LinkImpl*> green_links_;
24   std::vector<resource::LinkImpl*> my_nodes_;
25   DragonflyRouter(unsigned group, unsigned chassis, unsigned blade) : group_(group), chassis_(chassis), blade_(blade) {}
26 };
27
28 /** @ingroup ROUTING_API
29  * @brief NetZone using a Dragonfly topology
30  *
31  * Generate dragonfly according to the topology asked for, according to:
32  * Cray Cascade: a Scalable HPC System based on a Dragonfly Network
33  * Greg Faanes, Abdulla Bataineh, Duncan Roweth, Tom Court, Edwin Froese,
34  * Bob Alverson, Tim Johnson, Joe Kopnick, Mike Higgins and James Reinhard
35  * Cray Inc, Chippewa Falls, Wisconsin, USA
36  * or http://www.cray.com/sites/default/files/resources/CrayXCNetwork.pdf
37  *
38  * We use the same denomination for the different levels, with a Green,
39  * Black and Blue color scheme for the three different levels.
40  *
41  * Description of the topology has to be given with a string of type :
42  * "3,4;4,3;5,1;2"
43  *
44  * Last part  : "2"   : 2 nodes per blade
45  * Third part : "5,1" : five blades/routers per chassis, with one link between each (green network)
46  * Second part : "4,3" = four chassis per group, with three links between each nth router of each chassis (black
47  * network)
48  * First part : "3,4" = three electrical groups, linked in an alltoall
49  * pattern by 4 links each (blue network)
50  *
51  * LIMITATIONS (for now):
52  *  - Routing is only static and uses minimal routes.
53  *  - When n links are used between two routers/groups, we consider only one link with n times the bandwidth (needs to
54  *    be validated on a real system)
55  *  - All links have the same characteristics for now
56  *  - Blue links are all attached to routers in the chassis n°0. This limits
57  *    the number of groups possible to the number of blades in a chassis. This
58  *    is also not realistic, as blue level can use more links than a single
59  *    Aries can handle, thus it should use several routers.
60  */
61 class XBT_PUBLIC DragonflyZone : public ClusterZone {
62 public:
63   struct Coords {
64     unsigned group;
65     unsigned chassis;
66     unsigned blade;
67     unsigned node;
68   };
69
70   explicit DragonflyZone(NetZoneImpl* father, const std::string& name, resource::NetworkModel* netmodel);
71   void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) override;
72   void parse_specific_arguments(ClusterCreationArgs* cluster) override;
73   void seal() override;
74
75   Coords rankId_to_coords(int rank_id) const;
76   XBT_ATTRIB_DEPRECATED_v330("Please use rankId_to_coords(int)") void rankId_to_coords(int rank_id,
77                                                                                        unsigned int coords[4]) const;
78
79 private:
80   void generate_routers();
81   void generate_links();
82   void generate_link(const std::string& id, int numlinks, resource::LinkImpl** linkup,
83                      resource::LinkImpl** linkdown) const;
84
85   simgrid::s4u::Link::SharingPolicy sharing_policy_ = simgrid::s4u::Link::SharingPolicy::SHARED;
86   double bw_  = 0;
87   double lat_ = 0;
88
89   unsigned int num_nodes_per_blade_    = 0;
90   unsigned int num_blades_per_chassis_ = 0;
91   unsigned int num_chassis_per_group_  = 0;
92   unsigned int num_groups_             = 0;
93   unsigned int num_links_green_        = 0;
94   unsigned int num_links_black_        = 0;
95   unsigned int num_links_blue_         = 0;
96   unsigned int num_links_per_link_     = 1; // splitduplex -> 2, only for local link
97   std::vector<DragonflyRouter> routers_;
98 };
99 } // namespace routing
100 } // namespace kernel
101 } // namespace simgrid
102 #endif