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