Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[SMPI/LB] Normalize load + notify heap of changes
[simgrid.git] / src / smpi / plugins / load_balancer / LoadBalancer.cpp
1 /* Copyright (c) 2006-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 #include <algorithm>
7 #include <map>
8 #include <unordered_map>
9 #include <queue>
10
11 #include <boost/heap/fibonacci_heap.hpp>
12 #include <simgrid/plugins/load.h>
13 #include <src/smpi/plugins/load_balancer/load_balancer.hpp>
14
15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(plugin_load_balancer);
16
17 namespace simgrid {
18 namespace plugin {
19 namespace loadbalancer {
20
21 class XBT_PRIVATE compare_hosts {
22 public:
23   bool operator()(simgrid::s4u::Host* const a, simgrid::s4u::Host* const b) const;
24 };
25
26 typedef boost::heap::fibonacci_heap<simgrid::s4u::Host*, boost::heap::compare<compare_hosts>>::handle_type heap_handle;
27
28 /**
29  * Structure that imitates a std::pair, but it allows us
30  * to use meaningful names instead of .first and .second
31  */
32 struct XBT_PRIVATE pair_handle_load
33 {
34   heap_handle update_handle;
35   double load;
36 };
37
38 static std::map<simgrid::s4u::Host* const, pair_handle_load> additional_load;
39
40 bool compare_hosts::operator()(simgrid::s4u::Host* const a, simgrid::s4u::Host* const b) const {
41   return additional_load[a].load > additional_load[b].load;
42 }
43
44
45 LoadBalancer::LoadBalancer()
46 {
47 }
48
49 LoadBalancer::~LoadBalancer()
50 {
51 }
52
53 void LoadBalancer::run()
54 {
55   simgrid::s4u::Engine* engine                     = simgrid::s4u::Engine::get_instance();
56   std::vector<simgrid::s4u::Host*> available_hosts = engine->get_filtered_hosts([](simgrid::s4u::Host* host) {
57     return not host->is_off();
58   });
59   xbt_assert(available_hosts.size() > 0, "No hosts available; are they all switched off?");
60
61   // TODO: Account for daemon background load (-> use especially the availability file)
62
63   std::vector<simgrid::s4u::ActorPtr> all_actors =
64       engine->get_filtered_actors([](simgrid::s4u::ActorPtr actor) { return not actor->is_daemon(); });
65
66   for (auto& actor : all_actors) {
67     new_mapping.assign(actor, actor->get_host());
68   }
69   // Sort the actors, from highest to lowest load; we then just iterate over these actors
70   std::sort(all_actors.begin(), all_actors.end(), [this](simgrid::s4u::ActorPtr a, simgrid::s4u::ActorPtr b) {
71     return actor_computation[a->get_pid()] > actor_computation[b->get_pid()];
72   });
73
74   // Sort the hosts. Use a heap datastructure, because we have to reorder
75   // after a host got another actor assigned (or moved from).
76   // We can't use std::priorityQueue here because we modify *two* elements: The top element, which
77   // we can access and which has the lowest load, gets a new actor assigned. 
78   // However, the host loosing that actor must be updated as well. 
79   // std::priorityQueue is immutable and hence doesn't work for us.
80   //
81   // This heap contains the least loaded host at the top
82   boost::heap::fibonacci_heap<simgrid::s4u::Host*, boost::heap::compare<compare_hosts>> usable_hosts;
83   for (auto& host : available_hosts) {
84     std::vector<simgrid::s4u::ActorPtr> actors = host->get_all_actors();
85     heap_handle update_handle                  = usable_hosts.push(host); // Required to update elements in the heap
86     additional_load[host]                      = {update_handle, 0};      // Save the handle for later
87     const double total_flops_computed          = sg_host_get_computed_flops(host);
88     for (auto& actor : actors) {
89       additional_load[host].load += actor_computation[actor->get_pid()] / total_flops_computed; // Normalize load - this allows comparison
90                                                                                                 // even between hosts with different frequencies
91       XBT_DEBUG("Actor %li -> %f", actor->get_pid(), actor_computation[actor->get_pid()]);
92     }
93     usable_hosts.increase(update_handle);
94     XBT_DEBUG("Host %s initialized to %f", host->get_cname(), additional_load[host].load);
95   }
96
97   // Implementation of the Greedy algorithm
98   for (auto& actor : all_actors) {
99     simgrid::s4u::Host* target_host = usable_hosts.top(); // This is the host with the lowest load
100
101     simgrid::s4u::Host* cur_mapped_host = new_mapping.get_host(actor);
102     if (target_host != cur_mapped_host
103         && additional_load[target_host].load + actor_computation[actor->get_pid()] < additional_load[cur_mapped_host].load
104         && new_mapping.count_actors(cur_mapped_host) > 1) {
105       usable_hosts.pop();
106       XBT_DEBUG("Assigning %li from %s to %s -- actor_load: %f -- host_load: %f", actor->get_pid(), actor->get_host()->get_cname(), target_host->get_cname(), actor_computation[actor->get_pid()], additional_load[target_host].load);
107       additional_load[cur_mapped_host].load = std::max<double>(0.0, additional_load[cur_mapped_host].load - actor_computation[actor->get_pid()]); // No negative loads, please!
108       usable_hosts.update(additional_load[cur_mapped_host].update_handle, cur_mapped_host);
109       additional_load[target_host].load         += actor_computation[actor->get_pid()];
110
111       new_mapping.assign(actor, target_host);
112
113       XBT_DEBUG("Assigning actor %li to host %s", actor->get_pid(), target_host->get_cname());
114
115       XBT_DEBUG("host_load: %f after the assignment", additional_load[target_host].load);
116       additional_load[target_host].update_handle = usable_hosts.push(target_host); // Save update handle for later
117     }
118   }
119
120   while (!usable_hosts.empty()) {
121     simgrid::s4u::Host* host = usable_hosts.top();
122     usable_hosts.pop();
123
124     sg_host_load_reset(host); // Reset host load for next iterations
125
126     if (XBT_LOG_ISENABLED(plugin_load_balancer, e_xbt_log_priority_t::xbt_log_priority_debug)) {
127       /* Debug messages that allow us to verify the load for each host */
128       XBT_DEBUG("Host: %s, load total: %f", host->get_cname(), additional_load[host].load);
129       double load_verif = 0.0;
130       new_mapping.for_each_actor(host,
131           [this, &load_verif](simgrid::s4u::ActorPtr actor) {
132             load_verif += actor_computation[actor->get_pid()];
133             XBT_DEBUG("        %li (load: %f)", actor->get_pid(), actor_computation[actor->get_pid()]);
134       });
135       XBT_DEBUG("Host load verification: %f", load_verif);
136     }
137   }
138   for (auto& elem : actor_computation) { // Reset actor load
139     elem.second = 0;
140   }
141 }
142
143 simgrid::s4u::Host* LoadBalancer::get_mapping(simgrid::s4u::ActorPtr actor)
144 {
145   return new_mapping.get_host(actor);
146 }
147
148 void LoadBalancer::record_actor_computation(simgrid::s4u::ActorPtr actor, double load)
149 {
150   actor_computation[actor->get_pid()] += load;
151 }
152 }
153 }
154 }