Adding a new node aware multicast strategy that sends to PEs within a node along...
[charm.git] / src / ck-com / OneTimeMulticastStrategy.h
index 8f64f522ebf38df958da29ed71cc44232ca1c429..8cbf6a344d447a33c3887320e563842197270f4c 100644 (file)
@@ -47,7 +47,7 @@ class OneTimeMulticastStrategy: public Strategy, public CharmStrategy {
       Determine the set of PEs to which the message should be forwarded from this PE.
       Fill in pelist and npes to which the multicast message will be forwarded from this PE.
 
-      @param [in] totalDestPEs The number of destination PEs to whom the message needs to be sent. 
+      @param [in] totalDestPEs The number of destination PEs to whom the message needs to be sent. This will always be > 0.
       @param [in] destPEs The list of PEs that eventually will be sent the message.
       @param [in] myIndex The index into destPEs for this PE.
 
@@ -130,7 +130,7 @@ class OneTimeTreeMulticastStrategy: public OneTimeMulticastStrategy {
 
 
 /**
-   A node-aware strategy that sends along a node-based tree with user specified branching factor.
+   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.
 */
 class OneTimeNodeTreeMulticastStrategy: public OneTimeMulticastStrategy {
  private:
@@ -157,6 +157,35 @@ class OneTimeNodeTreeMulticastStrategy: public OneTimeMulticastStrategy {
 
 
 
+/**
+   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.
+*/
+class OneTimeNodeTreeRingMulticastStrategy: public OneTimeMulticastStrategy {
+ private:
+  int degree;
+  
+ public:
+  
+  void determineNextHopPEs(const int totalDestPEs, const ComlibMulticastIndexCount* destPEs, const int myIndex, int * &pelist, int &npes );
+  
+ OneTimeNodeTreeRingMulticastStrategy(CkMigrateMessage *m): OneTimeMulticastStrategy(m) {}
+  
+  /** Create a strategy with specified branching factor(which defaults to 4) */
+ OneTimeNodeTreeRingMulticastStrategy(int treeDegree=4): OneTimeMulticastStrategy(), degree(treeDegree) {}
+  
+  ~OneTimeNodeTreeRingMulticastStrategy() {}
+  
+  void pup(PUP::er &p){ 
+    OneTimeMulticastStrategy::pup(p); 
+    p | degree;
+  }
+  
+  PUPable_decl(OneTimeNodeTreeRingMulticastStrategy);
+};
+
+
+
+
 
 #endif