docs: instructions on using the new ObjGraph interface
[charm.git] / doc / charm++ / advancedlb.tex
1
2 \subsection{Advanced Load Balancing}
3
4 \label{advancedlb}
5
6 \subsubsection{Control CPU Load Statistics}
7
8 Charm++ programmers can control CPU load data in the load balancing database
9 before a load balancing phase is started (which is the time when load balancing
10 database is collected and used by load balancing strategies).
11
12 In an array element, the following function can be invoked to overwrite the 
13 CPU load that is measured by load balancing framework.
14
15 \begin{alltt}
16    double newTiming;
17    setObjTime(newTiming);
18 \end{alltt}
19
20 {\em setObjTime()} is defined as a method of class {\em CkMigratable}, which is
21 the superclass of all array elements.
22
23 The users can also retrieve the current timing that the load balancing runtime
24 has measured for the current array element. 
25  
26 \begin{alltt} 
27    double measuredTiming; 
28    measuredTiming = getObjTime(); 
29 \end{alltt}
30
31 This is useful when the users want to derive a new CPU load based on the 
32 existing one.
33
34 \subsubsection{Model-based Load Balancing}
35
36 Charm++ programmers can also choose to feed load balancer with their own CPU
37 timing of each Chare based on certain computational model of the applications.
38
39 To do so, first turn off automatic CPU load measurement completely
40 by setting:
41
42 \begin{alltt}
43    usesAutoMeasure = CmiFalse;
44 \end{alltt}
45
46 in array element's constructor.
47
48 Then the users need to implement the following function to the chare array
49 classes:
50
51 \begin{alltt}
52    virtual void CkMigratable::UserSetLBLoad();      // defined in base class
53 \end{alltt}
54
55 This function served as a callback that is called on each chare object when
56 {\em AtSync()} is called and ready to do load balancing. The implementation of
57 {\em UserSetLBLoad()} is simply to set the current chare object's CPU load to
58 load balancer framework. {\em setObjTime()} described above can be used for
59 this.
60
61 \subsubsection{Writing a communication-aware load balancing strategy}
62
63 Charm++ programmers can choose an existing load balancing strategy from
64 Charm++'s built-in strategies(see ~\ref{lbStrategy}) for the best performance
65 based on the characteristics of their applications. However, they can also
66 choose to write their own load balancing strategies.
67
68 The Charm++ load balancing framework provides a simple scheme to incorporate
69 new load balancing strategies. The programmer needs to write their strategy for
70 load balancing based on a instrumented ProcArray and ObjGraph provided by the
71 load balancing framework. This strategy is to be incorporated within this
72 function:
73
74 \begin{alltt}
75 void FooLB::work(LDStats *stats) {
76   /** ========================== INITIALIZATION ============================= */
77   ProcArray *parr = new ProcArray(stats);
78   ObjGraph *ogr = new ObjGraph(stats);
79
80   /** ============================= STRATEGY ================================ */
81   /// The strategy goes here
82   /// The strategy goes here
83   /// The strategy goes here
84   /// The strategy goes here
85   /// The strategy goes here
86
87   /** ============================== CLEANUP ================================ */
88   ogr->convertDecisions(stats);
89 }
90 \end{alltt}
91
92 Figure~\ref{fig:ckgraph} explains the two data structures available to the
93 strategy: ProcArray and ObjGraph. Using these, the strategy should assign new
94 processors for objects it wants to be migrated through the setNewPe() method.
95
96 \begin{figure}[h]
97 \centering
98 \includegraphics[width=6.0in]{fig/ckgraph}
99 \caption{Life cycle of an object with a pup routine.}
100 \label{fig:ckgraph}
101 \end{figure}
102
103 Incorporating this strategy into the Charm++ build framework is explained in
104 the next section.
105
106 \subsubsection{Adding a load balancer to Charm++}
107 \label{writelb}
108
109 Let us assume that we are writing a new centralized load balancer called FooLB.
110 The next few steps explain the addition of the load balancer to the Charm++
111 build system:
112
113 \begin{enumerate}
114 \item Create files named {\em FooLB.ci, FooLB.h and FooLB.C}. One can choose to
115 copy and rename the files GraphPartLB.* and rename the class name in those
116 files.
117
118 \item Implement the strategy in the {\em FooLB} class method --- {\bf
119 FooLB::work(LDStats* stats)} as described in the previous section.
120 %This method takes the load balancing database ({\em stats}) as an input, and
121 %output the new mapping of objects to processors in {\em stats->to\_proc}
122 %array.
123
124 \item Build charm for your platform (This will create the required links in the
125 tmp directory).
126
127 \item To compile the strategy files, first add {\em FooLB} into the load
128 balancer list in charm/tmp/Makefile\_lb.sh. If FooLB will require some
129 libraries at link time, you also need to create the dependency file called
130 libmoduleFooLB.dep. Run the script in charm/tmp, which creates the new Makefile
131 named ``Make.lb''.
132
133 \item Run ``make depends'' to update dependence rule of Charm++ files.  And run
134 ``make charm++'' to compile Charm++ which includes the new load balancing
135 strategy files.
136 \end{enumerate}
137
138
139 \subsubsection{Understand Load Balancing Database Data Structure}
140
141 \label{lbdatabase}
142
143 To write a load balancing strategy, one may want to know 
144 what information is measured during the runtime and how it is represented in
145 the load balancing database data structure?
146
147 There are mainly 3 categories of information: a) processor information including processor speed, background load; b) object information including per object
148 cpu/wallclock compute time and c) communication information .
149
150 The database data structure named {\kw LDStats} is defined in {\em CentralLB.h}:
151
152 \begin{verbatim}
153
154   struct ProcStats {  // per processor
155     double total_walltime;
156     double total_cputime;
157     double idletime;
158     double bg_walltime;
159     double bg_cputime;
160     int pe_speed;
161     double utilization;
162     CmiBool available;
163     int   n_objs;
164   }
165
166   struct LDStats { // load balancing database
167     ProcStats  *procs;
168     int count;
169
170     int   n_objs;
171     int   n_migrateobjs;
172     LDObjData* objData;
173
174     int   n_comm;
175     LDCommData* commData;
176
177     int  *from_proc, *to_proc;
178   }
179
180 \end{verbatim}
181
182 \begin{enumerate}
183 \item {\em procs} array defines processor attributes and usage data for each
184 processor;
185 \item {\em objData} array records per object information, {\em LDObjData} is defined in {\em lbdb.h};
186 \item {\em commData} array records per communication information. {\em LDCommData} is defined in {\em lbdb.h}.
187 \end{enumerate}
188