These changes fix things that I have discovered about Grid load balancing.
[charm.git] / src / ck-ldb / GridCommRefineLB.C
1 /**************************************************************************
2 ** Greg Koenig (koenig@uiuc.edu)
3 ** March 1, 2006
4 **
5 ** This is GridCommRefineLB.C
6 **
7 ** GridCommRefineLB is a load balancer for the Charm++ load balancing
8 ** framework.  It is designed to work in a Grid computing environment
9 ** consisting of two or more clusters separated by wide-area communication
10 ** links.  Communication between objects within a cluster is assumed to be
11 ** light weight (measured in microseconds) while communication between
12 ** objects on different clusters is assumed to be heavy weight (measured in
13 ** milliseconds).
14 **
15 ** The load balancer examines all communications in a computation and
16 ** attempts to spread the objects that communicate with objects on remote
17 ** clusters evenly across the PEs in the local cluster.  No objects are
18 ** ever migrated across cluster boundaries, they are simply distributed
19 ** as evenly as possible across the PEs in the cluster in which they were
20 ** originally placed.  The idea is that by spreading objects that
21 ** communicate over the wide-area evenly, a relatively small number of
22 ** WAN objects will be mixed with a relatively large number of LAN
23 ** objects, allowing the message-driven characteristics of Charm++ the
24 ** greatest possibility of overlapping the high-cost WAN communication
25 ** with locally-driven work.
26 **
27 ** The load balancer secondarily balances on scaled processor load
28 ** (i.e., a processor that is 2x the speed of another processor in
29 ** the local cluster will get 2x the work) as well as the number of
30 ** LAN objects.
31 **
32 ** This load balancer applies a "refinement" approach which attempts to
33 ** avoid disrupting the object-to-PE mapping by causing large numbers of
34 ** objects to migrate with each load balancing iĀ®nvocation.  This may be
35 ** undesirable in some cases.  (For example, if the vmi-linux "eager
36 ** protocol" is used, eager channels may be pinned between two PEs, and
37 ** migrating objects that communicate heavily with each other onto other
38 ** PEs could actually slow the computationif they no longer communicate
39 ** with each other over an eager channel.)  To prevent this, the balancer
40 ** determines the average number of objects per PE that communicate with
41 ** objects on remote clusters, and then migrates objects away from PEs
42 ** that exceed this average plus some tolerance (e.g., 110% of average).
43 ** This means that only the objects on the most overloaded PEs will be
44 ** migrated.
45 */
46
47 #include "GridCommRefineLB.decl.h"
48
49 #include "GridCommRefineLB.h"
50 #include "manager.h"
51
52 CreateLBFunc_Def (GridCommRefineLB, "Grid communication load balancer (refines object mapping within each cluster)");
53
54
55
56 /**************************************************************************
57 **
58 */
59 GridCommRefineLB::GridCommRefineLB (const CkLBOptions &opt) : CentralLB (opt)
60 {
61   char *value;
62
63
64   lbname = (char *) "GridCommRefineLB";
65
66   if (CkMyPe() == 0) {
67     CkPrintf ("[%d] GridCommRefineLB created.\n", CkMyPe());
68   }
69
70   if (value = getenv ("CK_LDB_GRIDCOMMREFINELB_TOLERANCE")) {
71     CK_LDB_GridCommRefineLB_Tolerance = atof (value);
72   } else {
73     CK_LDB_GridCommRefineLB_Tolerance = CK_LDB_GRIDCOMMREFINELB_TOLERANCE;
74   }
75
76   manager_init ();
77 }
78
79
80
81 /**************************************************************************
82 **
83 */
84 GridCommRefineLB::GridCommRefineLB (CkMigrateMessage *msg) : CentralLB (msg)
85 {
86   char *value;
87
88
89   lbname = (char *) "GridCommRefineLB";
90
91   if (value = getenv ("CK_LDB_GRIDCOMMREFINELB_TOLERANCE")) {
92     CK_LDB_GridCommRefineLB_Tolerance = atof (value);
93   } else {
94     CK_LDB_GridCommRefineLB_Tolerance = CK_LDB_GRIDCOMMREFINELB_TOLERANCE;
95   }
96
97   manager_init ();
98 }
99
100
101
102 /**************************************************************************
103 ** The Charm++ load balancing framework invokes this method to determine
104 ** whether load balancing can be performed at a specified time.
105 */
106 CmiBool GridCommRefineLB::QueryBalanceNow (int step)
107 {
108   if (_lb_args.debug() > 2) {
109     CkPrintf ("[%d] GridCommRefineLB is balancing on step %d.\n", CkMyPe(), step);
110   }
111
112   return (CmiTrue);
113 }
114
115
116
117 /**************************************************************************
118 ** The vmi-linux machine layer incorporates the idea that PEs are located
119 ** within identifiable clusters.  This information can be supplied by the
120 ** user or can be probed automatically by the machine layer.  The exposed
121 ** API call CmiGetCluster() returns the integer cluster number for a
122 ** specified PE or -1 if the information is unknown.
123 **
124 ** For machine layers other than vmi-linux, simply return the constant 0.
125 ** GridCommRefineLB will assume a single-cluster computation and will
126 ** balance on the scaled processor load and number of LAN messages.
127 */
128 int GridCommRefineLB::Get_Cluster (int pe)
129 {
130 #if CONVERSE_VERSION_VMI
131   return (CmiGetCluster (pe));
132 #else
133   return (0);
134 #endif
135 }
136
137
138
139 /**************************************************************************
140 ** Instantiate and initialize the PE_Data[] data structure.
141 **
142 ** While doing this...
143 **    - ensure that there is at least one available PE
144 **    - ensure that all PEs are mapped to a cluster
145 **    - determine the maximum cluster number (gives the number of clusters)
146 **    - determine the minimum speed PE (used to compute relative PE speeds)
147 */
148 void GridCommRefineLB::Initialize_PE_Data (CentralLB::LDStats *stats)
149 {
150   int min_speed;
151   int i;
152
153
154   PE_Data = new PE_Data_T[Num_PEs];
155
156   min_speed = MAXINT;
157   for (i = 0; i < Num_PEs; i++) {
158     (&PE_Data[i])->available      = stats->procs[i].available;
159     (&PE_Data[i])->cluster        = Get_Cluster (i);
160     (&PE_Data[i])->num_objs       = 0;
161     (&PE_Data[i])->num_lan_objs   = 0;
162     (&PE_Data[i])->num_lan_msgs   = 0;
163     (&PE_Data[i])->num_wan_objs   = 0;
164     (&PE_Data[i])->num_wan_msgs   = 0;
165     (&PE_Data[i])->relative_speed = 0.0;
166     (&PE_Data[i])->scaled_load    = 0.0;
167
168     if (stats->procs[i].pe_speed < min_speed) {
169       min_speed = stats->procs[i].pe_speed;
170     }
171   }
172
173   // Compute the relative PE speeds.
174   // Also add background CPU time to each PE's scaled load.
175   for (i = 0; i < Num_PEs; i++) {
176     (&PE_Data[i])->relative_speed = (double) (stats->procs[i].pe_speed / min_speed);
177     (&PE_Data[i])->scaled_load += stats->procs[i].bg_cputime;
178   }
179 }
180
181
182
183 /**************************************************************************
184 **
185 */
186 void GridCommLB::Initialize_Object_Data (CentralLB::LDStats *stats)
187 {
188   int i;
189
190
191   Object_Data = new Object_Data_T[Num_Objects];
192
193   for (i = 0; i < Num_Objects; i++) {
194     (&Object_Data[i])->migratable   = (&stats->objData[i])->migratable;
195     (&Object_Data[i])->cluster      = Get_Cluster (stats->from_proc[i]);
196     (&Object_Data[i])->from_pe      = stats->from_proc[i];
197     (&Object_Data[i])->to_pe        = stats->from_proc[i];
198     (&Object_Data[i])->num_lan_msgs = 0;
199     (&Object_Data[i])->num_wan_msgs = 0;
200     (&Object_Data[i])->load         = (&stats->objData[i])->wallTime;
201
202     //(&PE_Data[(&Object_Data[i])->from_pe])->num_objs += 1;
203     //(&PE_Data[(&Object_Data[i])->from_pe])->scaled_load += (&Object_Data[i])->load / (&PE_Data[(&Object_Data[i])->from_pe])->relative_speed;
204   }
205 }
206
207
208
209 /**************************************************************************
210 **
211 */
212 void GridCommLB::Examine_InterObject_Messages (CentralLB::LDStats *stats)
213 {
214   int i;
215   LDCommData *com_data;
216   int send_object;
217   int send_pe;
218   int send_cluster;
219   int recv_object;
220   int recv_pe;
221   int recv_cluster;
222   LDObjKey *recv_objects;
223   int num_objects;
224
225
226   for (i = 0; i < stats->n_comm; i++) {
227     com_data = &(stats->commData[i]);
228     if ((!com_data->from_proc()) && (com_data->recv_type() == LD_OBJ_MSG)) {
229       send_object = stats->getHash (com_data->sender);
230       recv_object = stats->getHash (com_data->receiver.get_destObj());
231
232       if ((send_object < 0) || (send_object > Num_Objects) || (recv_object < 0) || (recv_object > Num_Objects)) {
233         continue;
234       }
235
236       send_pe = (&Object_Data[send_object])->from_pe;
237       recv_pe = (&Object_Data[recv_object])->from_pe;
238
239       send_cluster = Get_Cluster (send_pe);
240       recv_cluster = Get_Cluster (recv_pe);
241
242       if (send_cluster == recv_cluster) {
243         (&Object_Data[send_object])->num_lan_msgs += com_data->messages;
244       } else {
245         (&Object_Data[send_object])->num_wan_msgs += com_data->messages;
246       }
247     } else if (com_data->receiver.get_type() == LD_OBJLIST_MSG) {
248       send_object = stats->getHash (com_data->sender);
249
250       if ((send_object < 0) || (send_object > Num_Objects)) {
251         continue;
252       }
253
254       send_pe = (&Object_Data[send_object])->from_pe;
255       send_cluster = Get_Cluster (send_pe);
256
257       recv_objects = com_data->receiver.get_destObjs (num_objects);   // (num_objects is passed by reference)
258
259       for (j = 0; j < num_objects; j++) {
260         recv_object = stats->getHash (recv_objects[j]);
261
262         if ((recv_object < 0) || (recv_object > Num_Objects)) {
263           continue;
264         }
265
266         recv_pe = (&Object_Data[recv_object])->from_pe;
267         recv_cluster = Get_Cluster (recv_pe);
268
269         if (send_cluster == recv_cluster) {
270           (&Object_Data[send_object])->num_lan_msgs += com_data->messages;
271         } else {
272           (&Object_Data[send_object])->num_wan_msgs += com_data->messages;
273         }
274       }
275     }
276   }
277 }
278
279
280
281 /**************************************************************************
282 **
283 */
284 void GridCommRefineLB::Place_Objects_On_PEs ()
285 {
286   int i;
287
288
289   for (i = 0; i < Num_Objects; i++) {
290     Assign_Object_To_PE (i, (&Object_Data[i])->from_pe);
291   }
292 }
293
294
295
296 /**************************************************************************
297 **
298 */
299 void GridCommRefineLB::Remap_Objects_To_PEs (int cluster)
300 {
301   int num_cluster_pes;
302   int num_wan_msgs;
303   int avg_wan_msgs;
304   int target_object;
305   int target_pe;
306   int i;
307
308
309   // Compute average number of objects per PE for this cluster.
310   num_cluster_pes = 0;
311   num_wan_msgs = 0;
312   for (i = 0; i < Num_PEs; i++) {
313     if (cluster == (&PE_Data[i])->cluster) {
314       num_cluster_pes += 1;
315       num_wan_msgs += (&PE_Data[j])->num_wan_msgs;
316     }
317   }
318   avg_wan_msgs = num_wan_msgs / num_cluster_pes;
319
320   // Move objects away from PEs that exceed the average.
321   for (i = 0; i < Num_PEs; i++) {
322     if (cluster == (&PE_Data[i])->cluster) {
323       while ((&PE_Data[i])->num_wan_msgs > (avg_wan_msgs * CK_LDB_GridCommRefineLB_Tolerance)) {
324         target_object = Find_Maximum_WAN_Object (i);
325         target_pe = Find_Minimum_WAN_PE (cluster);
326
327         if ((target_object == -1) || (target_pe == -1)) {
328           break;
329         }
330
331         Remove_Object_From_PE (target_object, i);
332         Assign_Object_To_PE (target_object, target_pe);
333       }
334     }
335   }
336
337 /*
338   // Compute average number of objects per PE for this cluster.
339   num_cluster_pes = 0;
340   num_wan_objs = 0;
341   for (j = 0; j < Num_PEs; j++) {
342     if (cluster == (&PE_Data[j])->cluster) {
343       num_cluster_pes += 1;
344       num_wan_objs += (&PE_Data[j])->num_wan_objs;
345     }
346   }
347   avg_wan_objs = num_wan_objs / num_cluster_pes;
348
349   // Move objects away from PEs that exceed the average.
350   for (j = 0; j < Num_PEs; j++) {
351     if (cluster == (&PE_Data[j])->cluster) {
352       while ((&PE_Data[j])->num_wan_objs > (avg_wan_objs * CK_LDB_GridCommRefineLB_Tolerance)) {
353         target_object = Find_Maximum_WAN_Object (j);
354         target_pe = Find_Minimum_WAN_PE (i);
355
356         if ((target_object == -1) || (target_pe == -1)) {
357           break;
358         }
359
360         Remove_Object_From_PE (target_object, j);
361         Assign_Object_To_PE (target_object, target_pe);
362       }
363     }
364   }
365 */
366 }
367
368
369
370 /**************************************************************************
371 ** This method locates the maximum WAN object in terms of number of
372 ** messages that traverse a wide-area connection.  The search is
373 ** constrained to objects on the specified PE.
374 **
375 ** The method returns -1 if no matching object is found.
376 */
377 int GridCommRefineLB::Find_Maximum_WAN_Object (int pe)
378 {
379   int i;
380   int max_index;
381   int max_wan_msgs;
382
383
384   max_index = -1;
385   max_wan_msgs = -1;
386
387   for (i = 0; i < Num_Objects; i++) {
388     if ((&Object_Data[i])->from_pe == pe) {
389       if ((&Object_Data[i])->migratable) {
390         if ((&Object_Data[i])->num_wan_msgs > max_wan_msgs) {
391           max_index = i;
392           max_wan_msgs = (&Object_Data[i])->num_wan_msgs;
393         }
394       }
395     }
396   }
397
398   return (max_index);
399 }
400
401
402
403 /**************************************************************************
404 ** This method locates the minimum WAN PE in terms of number of objects
405 ** that communicate with objects across a wide-area connection.  The search
406 ** is constrained to PEs within the specified cluster.
407 **
408 ** In the event of a "tie" (i.e., the number of WAN objects on a candidate
409 ** PE is equal to the minimum number of WAN objects discovered so far) the
410 ** tie is broken by considering the scaled CPU loads on the PEs.  The PE
411 ** with the smaller scaled load is the better candidate.  In the event of
412 ** a secondary tie, the secondary tie is broken by considering the number
413 ** of LAN objects on the two PEs.
414 **
415 ** The method returns -1 if no matching PE is found.
416 */
417 int GridCommRefineLB::Find_Minimum_WAN_PE (int cluster)
418 {
419   int i;
420   int min_index;
421   int min_wan_msgs;
422
423
424   min_index = -1;
425   min_wan_msgs = MAXINT;
426
427   for (i = 0; i < Num_PEs; i++) {
428     if (((&PE_Data[i])->available) && ((&PE_Data[i])->cluster == cluster)) {
429       if ((&PE_Data[i])->num_wan_msgs < min_wan_msgs) {
430         min_index = i;
431         min_wan_msgs = (&PE_Data[i])->num_wan_msgs;
432       } else if (((&PE_Data[i])->num_wan_msgs == min_wan_msgs) &&
433                  ((&PE_Data[i])->scaled_load < (&PE_Data[min_index])->scaled_load)) {
434         min_index = i;
435         min_wan_msgs = (&PE_Data[i])->num_wan_msgs;
436       } else if (((&PE_Data[i])->num_wan_msgs == min_wan_msgs) &&
437                  ((&PE_Data[i])->scaled_load == (&PE_Data[min_index])->scaled_load) &&
438                  ((&PE_Data[i])->num_objs < (&PE_Data[min_index])->num_objs)) {
439         min_index = i;
440         min_wan_msgs = (&PE_Data[i])->num_wan_msgs;
441       }
442     }
443   }
444
445   return (min_index);
446
447 /*
448   int i;
449   int min_index;
450   int min_wan_objs;
451
452
453   min_index = -1;
454   min_wan_objs = MAXINT;
455
456   for (i = 0; i < Num_PEs; i++) {
457     if (((&PE_Data[i])->available) && ((&PE_Data[i])->cluster == cluster)) {
458       if ((&PE_Data[i])->num_wan_objs < min_wan_objs) {
459         min_index = i;
460         min_wan_objs = (&PE_Data[i])->num_wan_objs;
461       } else if (((&PE_Data[i])->num_wan_objs == min_wan_objs) &&
462                  ((&PE_Data[i])->scaled_load < (&PE_Data[min_index])->scaled_load)) {
463         min_index = i;
464         min_wan_objs = (&PE_Data[i])->num_wan_objs;
465       } else if (((&PE_Data[i])->num_wan_objs == min_wan_objs) &&
466                  ((&PE_Data[i])->scaled_load == (&PE_Data[min_index])->scaled_load) &&
467                  ((&PE_Data[i])->num_lan_objs < (&PE_Data[min_index])->num_lan_objs)) {
468         min_index = i;
469         min_wan_objs = (&PE_Data[i])->num_wan_objs;
470       }
471     }
472   }
473
474   return (min_index);
475 */
476 }
477
478
479
480 /**************************************************************************
481 ** This method removes target_object from target_pe.  The data structure
482 ** entry for target_pe is updated appropriately with measurements from
483 ** target_object.
484 */
485 void GridCommRefineLB::Remove_Object_From_PE (int target_object, int target_pe)
486 {
487   (&Object_Data[target_object])->to_pe = -1;
488
489   (&PE_Data[target_pe])->num_objs -= 1;
490
491   if ((&Object_Data[target_object])->num_lan_msgs > 0) {
492     (&PE_Data[target_pe])->num_lan_objs -= 1;
493     (&PE_Data[target_pe])->num_lan_msgs -= (&Object_Data[target_object])->num_lan_msgs;
494   }
495
496   if ((&Object_Data[target_object])->num_wan_msgs > 0) {
497     (&PE_Data[target_pe])->num_wan_objs -= 1;
498     (&PE_Data[target_pe])->num_wan_msgs -= (&Object_Data[target_object])->num_wan_msgs;
499   }
500
501   (&PE_Data[target_pe])->scaled_load -= (&Object_Data[target_object])->load / (&PE_Data[target_pe])->relative_speed;
502 }
503
504
505
506 /**************************************************************************
507 ** This method assigns target_object to target_pe.  The data structure
508 ** entry for target_pe is updated appropriately with measurements from
509 ** target_object.
510 */
511 void GridCommRefineLB::Assign_Object_To_PE (int target_object, int target_pe)
512 {
513   (&Object_Data[target_object])->to_pe = target_pe;
514
515   (&PE_Data[target_pe])->num_objs += 1;
516
517   if ((&Object_Data[target_object])->num_lan_msgs > 0) {
518     (&PE_Data[target_pe])->num_lan_objs += 1;
519     (&PE_Data[target_pe])->num_lan_msgs += (&Object_Data[target_object])->num_lan_msgs;
520   }
521
522   if ((&Object_Data[target_object])->num_wan_msgs > 0) {
523     (&PE_Data[target_pe])->num_wan_objs += 1;
524     (&PE_Data[target_pe])->num_wan_msgs += (&Object_Data[target_object])->num_wan_msgs;
525   }
526
527   (&PE_Data[target_pe])->scaled_load += (&Object_Data[target_object])->load / (&PE_Data[target_pe])->relative_speed;
528 }
529
530
531
532 /**************************************************************************
533 ** The Charm++ load balancing framework invokes this method to cause the
534 ** load balancer to migrate objects to "better" PEs.
535 */
536 void GridCommRefineLB::work (CentralLB::LDStats *stats, int count)
537 {
538   int i;
539   // int j;
540   // CmiBool available;
541   // CmiBool all_pes_mapped;
542   // int max_cluster;
543   // int min_speed;
544   // int send_object;
545   // int send_pe;
546   // int send_cluster;
547   // int recv_object;
548   // int recv_pe;
549   // int recv_cluster;
550   // LDCommData *com_data;
551
552
553   if (_lb_args.debug() > 0) {
554     CkPrintf ("[%d] GridCommRefineLB is working.\n", CkMyPe());
555   }
556
557   // Since this load balancer looks at communications data, it must call stats->makeCommHash().
558   stats->makeCommHash ();
559
560   // Initialize object variables for the number of PEs and number of objects.
561   Num_PEs = count;
562   Num_Objects = stats->n_objs;
563
564   if (_lb_args.debug() > 0) {
565     CkPrintf ("[%d] GridCommRefineLB is examining %d PEs and %d objects.\n", CkMyPe(), Num_PEs, Num_Objects);
566   }
567
568   // Initialize the PE_Data[] data structure.
569   Initialize_PE_Data (stats);
570
571   // If at least one available PE does not exist, return from load balancing.
572   if (Available_PE_Count() < 1) {
573     if (_lb_args.debug() > 0) {
574       CkPrintf ("[%d] GridCommLB finds no available PEs -- no balancing done.\n", CkMyPe());
575     }
576
577     delete [] PE_Data;
578
579     return;
580   }
581
582   // Determine the number of clusters.
583   // If any PE is not mapped to a cluster, return from load balancing.
584   Num_Clusters = Compute_Number_Of_Clusters ();
585   if (Num_Clusters < 1) {
586     if (_lb_args.debug() > 0) {
587       CkPrintf ("[%d] GridCommLB finds incomplete PE cluster map -- no balancing done.\n", CkMyPe());
588     }
589
590     delete [] PE_Data;
591
592     return;
593   }
594
595   if (_lb_args.debug() > 0) {
596     CkPrintf ("[%d] GridCommLB finds %d clusters.\n", CkMyPe(), Num_Clusters);
597   }
598
599   // Initialize the Object_Data[] data structure.
600   Initialize_Object_Data (stats);
601
602   // Examine all object-to-object messages for intra-cluster and inter-cluster communications.
603   Examine_InterObject_Messages (stats);
604
605   // Place objects on the PE they are currently assigned to.
606   Place_Objects_On_PEs ();
607
608   // Remap objects to PEs in each cluster.
609   for (i = 0; i < Num_Clusters; i++) {
610     Remap_Objects_To_PEs (i);
611   }
612
613   // Make the assignment of objects to PEs in the load balancer framework.
614   for (i = 0; i < Num_Objects; i++) {
615     stats->to_proc[i] = (&Object_Data[i])->to_pe;
616
617     if (_lb_args.debug() > 2) {
618       CkPrintf ("[%d] GridCommRefineLB migrates object %d from PE %d to PE %d.\n", CkMyPe(), i, stats->from_proc[i], stats->to_proc[i]);
619     } else if (_lb_args.debug() > 1) {
620       if (stats->to_proc[i] != stats->from_proc[i]) {
621         CkPrintf ("[%d] GridCommRefineLB migrates object %d from PE %d to PE %d.\n", CkMyPe(), i, stats->from_proc[i], stats->to_proc[i]);
622       }
623     }
624   }
625
626   // Free memory.
627   delete [] Object_Data;
628   delete [] PE_Data;
629 }
630
631 #include "GridCommRefineLB.def.h"