Fixing projections message tracing for [nokeep] multicast messages. Projections messa...
[charm.git] / src / ck-com / OneTimeMulticastStrategy.h
1 /**
2    @addtogroup ComlibCharmStrategy
3    @{
4    
5    @file 
6  
7 */
8
9 #ifndef ONE_TIME_MULTICAST_STRATEGY
10 #define ONE_TIME_MULTICAST_STRATEGY
11
12 #include "ComlibManager.h"
13 #include "ComlibSectionInfo.h"
14
15 /**
16    The simplest multicast strategy. This strategy extracts the array section information, and packs the section information and the user message into a single message. The original message is delivered locally, and the new message is sent using CmiSyncListSendAndFree to all other processors containing destination objects. If the destination entry method is [nokeep], then the multicast is delivered inline without extra copies to the local destination elements. If the destination is not [nokeep], then the message is delivered through the scheduler queue.  
17
18    Projections can trace the messages for the [nokeep] destinations, but the sending entry method will end prematurely because inline calling of local entry methods is not fully supported by Projections. Messages multicast to non [nokeep] methods are displayed incorrectly, probably because the call to deliver overwrites the source pe & event.
19
20 @fixme Fix projections logging for the non [nokeep] version
21
22    This strategy is simpler than those which are derived from the MulticastStrategy class because those maintain a persistant record of previous array section information extracted from the messages, and those provide multiple implementations of the multicast tree (such as ring or multiring or all to all). Those strategies ought to be used when multiple multicasts are sent to the same array section. If an array section is not reused, then this strategy ought to be used.
23
24    A class can be created which inherits from this class, but provides its own determineNextHopPEs method to specify any type of desired spanning tree. For example, OneTimeRingMulticastStrategy forwards the multicast messages in a ring while OneTimeTreeMulticastStrategy forwards messages along a tree of specified degree. In the future, topology aware (both network and core/cpu/node) strategies should be added.
25
26    The local messages are delivered through the array manager using the CharmStrategy::deliverToIndices methods. If a destination chare is remote, the array manager will forward it on to the pe that contains the chare.
27    
28    To create a new strategy:
29    <ul>
30    <li>Add a class declaration similar to the ones below, making sure they inherit from OneTimeMulticastStrategy. 
31    <li>Add a PUPable entry in ComlibManager.ci 
32    <li>Implement determineNextHopPEs in OneTimeMulticastStrategy.C. See information for OneTimeMulticastStrategy::determineNextHopPEs .
33    </ul>
34
35 @todo  Buffer messages until strategy is fully enabled. The current version might have some startup issues if the multicast is used too early.
36
37 @todo  Implement topology aware subclasses. 
38
39 */
40 class OneTimeMulticastStrategy: public Strategy, public CharmStrategy {
41  private:
42   
43   ComlibSectionInfo sinfo; // This is used to create the multicast messages themselves
44
45   void remoteMulticast(ComlibMulticastMsg * multMsg, bool rootPE);
46   void localMulticast(CharmMessageHolder *cmsg);
47   
48  public:
49
50   /** 
51       Determine the set of PEs to which the message should be forwarded from this PE.
52       Fill in pelist and npes to which the multicast message will be forwarded from this PE.
53
54       @param [in] totalDestPEs The number of destination PEs to whom the message needs to be sent. This will always be > 0.
55       @param [in] destPEs The list of PEs that eventually will be sent the message.
56       @param [in] myIndex The index into destPEs for this PE.
57
58       @param [out] pelist A list of PEs to which the message will be sent after this function returns. This function allocates the array with new. The caller will free it with delete[] if npes>0.
59       @param [out] npes The size of pelist
60
61   */
62   virtual void determineNextHopPEs(const int totalDestPEs, const ComlibMulticastIndexCount* destPEs, const int myIndex, int * &pelist, int &npes );
63
64     OneTimeMulticastStrategy(CkMigrateMessage *m): Strategy(m), CharmStrategy(m){}
65   
66   OneTimeMulticastStrategy();
67   ~OneTimeMulticastStrategy();
68   
69   void insertMessage(MessageHolder *msg) {insertMessage((CharmMessageHolder*)msg);}
70   void insertMessage(CharmMessageHolder *msg);
71   
72   ///Called by the converse handler function
73   void handleMessage(void *msg);    
74
75   void pup(PUP::er &p);
76
77   PUPable_decl(OneTimeMulticastStrategy);
78
79 };
80
81
82
83
84
85 /**
86    A strategy that sends along a ring through the destination processors.
87 */
88 class OneTimeRingMulticastStrategy: public OneTimeMulticastStrategy {
89   
90  public:
91   void determineNextHopPEs(const int totalDestPEs, const ComlibMulticastIndexCount* destPEs, const int myIndex, int * &pelist, int &npes );
92
93  OneTimeRingMulticastStrategy(CkMigrateMessage *m): OneTimeMulticastStrategy(m) {}
94  OneTimeRingMulticastStrategy(): OneTimeMulticastStrategy() {}
95   ~OneTimeRingMulticastStrategy() {}
96   
97   void pup(PUP::er &p){ OneTimeMulticastStrategy::pup(p); }
98   
99   PUPable_decl(OneTimeRingMulticastStrategy);
100
101 };
102
103
104
105 /**
106    A strategy that sends along a tree with user specified branching factor.
107 */
108 class OneTimeTreeMulticastStrategy: public OneTimeMulticastStrategy {
109  private:
110   int degree;
111   
112  public:
113   
114   void determineNextHopPEs(const int totalDestPEs, const ComlibMulticastIndexCount* destPEs, const int myIndex, int * &pelist, int &npes );
115   
116  OneTimeTreeMulticastStrategy(CkMigrateMessage *m): OneTimeMulticastStrategy(m) {}
117
118   /** Create a strategy with specified branching factor(which defaults to 4) */
119  OneTimeTreeMulticastStrategy(int treeDegree=4): OneTimeMulticastStrategy(), degree(treeDegree) {}
120
121   ~OneTimeTreeMulticastStrategy() {}
122   
123   void pup(PUP::er &p){ 
124     OneTimeMulticastStrategy::pup(p); 
125     p | degree;
126   }
127   
128   PUPable_decl(OneTimeTreeMulticastStrategy);
129 };
130
131
132
133
134
135
136 /**
137    A node-aware strategy that sends along a node-based tree with user specified branching factor. Once the message reaches the PE representative for each node, it is forwarded from the PE to all other destination PEs on the node. This strategy can result in imbalanced loads. The PEs along the tree have higher load than the other PEs.
138 */
139 class OneTimeNodeTreeMulticastStrategy: public OneTimeMulticastStrategy {
140  private:
141   int degree;
142   
143  public:
144   
145   void determineNextHopPEs(const int totalDestPEs, const ComlibMulticastIndexCount* destPEs, const int myIndex, int * &pelist, int &npes );
146   
147  OneTimeNodeTreeMulticastStrategy(CkMigrateMessage *m): OneTimeMulticastStrategy(m) {}
148   
149   /** Create a strategy with specified branching factor(which defaults to 4) */
150  OneTimeNodeTreeMulticastStrategy(int treeDegree=4): OneTimeMulticastStrategy(), degree(treeDegree) {}
151   
152   ~OneTimeNodeTreeMulticastStrategy() {}
153   
154   void pup(PUP::er &p){ 
155     OneTimeMulticastStrategy::pup(p); 
156     p | degree;
157   }
158   
159   PUPable_decl(OneTimeNodeTreeMulticastStrategy);
160 };
161
162
163
164 /**
165    A node-aware strategy that sends along a node-based tree with user specified branching factor. Once the message arrives at the first PE on the node, it is forwarded to the other PEs on the node through a ring.
166 */
167 class OneTimeNodeTreeRingMulticastStrategy: public OneTimeMulticastStrategy {
168  private:
169   int degree;
170   
171  public:
172   
173   void determineNextHopPEs(const int totalDestPEs, const ComlibMulticastIndexCount* destPEs, const int myIndex, int * &pelist, int &npes );
174   
175  OneTimeNodeTreeRingMulticastStrategy(CkMigrateMessage *m): OneTimeMulticastStrategy(m) {}
176   
177   /** Create a strategy with specified branching factor(which defaults to 4) */
178  OneTimeNodeTreeRingMulticastStrategy(int treeDegree=4): OneTimeMulticastStrategy(), degree(treeDegree) {}
179   
180   ~OneTimeNodeTreeRingMulticastStrategy() {}
181   
182   void pup(PUP::er &p){ 
183     OneTimeMulticastStrategy::pup(p); 
184     p | degree;
185   }
186   
187   PUPable_decl(OneTimeNodeTreeRingMulticastStrategy);
188 };
189
190
191
192
193
194 #endif
195
196 /*@}*/