[ONOS-2885] Resolve flow installation failure bug

There is a time gap between
controller is elected as the master of a switch
and
controller actually becomes the master of a switch (receives ROLE_REPLY).
During this time gap, OF messages destined for the switch will be sent to this controller.
However, the OF message can only be sent to the switch after controller receives the ROLE_REPLY.

Change-Id: I32d68384226e272658a0c9de2d32ae9e1cc39b6a

@@ -30,6 +30,14 @@ public interface OpenFlowSwitch {
     /**
     /**
      * Writes the message to the driver.
      * Writes the message to the driver.
      *
      *
+     * Note:
+     * Calling {@link #sendMsg(OFMessage)} does NOT guarantee the messages to be
+     * transmitted on the wire in order, especially during role transition.
+     * The messages may be reordered at the switch side.
+     *
+     * Calling {@link #sendMsg(List)} guarantee the messages inside the list
+     * to be transmitted on the wire in order.
+     *
      * @param msg the message to write
      * @param msg the message to write
      */
      */
     void sendMsg(OFMessage msg);
     void sendMsg(OFMessage msg);

@@ -79,6 +79,8 @@ public abstract class AbstractOpenFlowSwitch extends AbstractHandlerBehaviour
     protected OFFeaturesReply features;
     protected OFFeaturesReply features;
     protected OFDescStatsReply desc;
     protected OFDescStatsReply desc;
 
 
+    List<OFMessage> messagesPendingMastership;
+
     @Override
     @Override
     public void init(Dpid dpid, OFDescStatsReply desc, OFVersion ofv) {
     public void init(Dpid dpid, OFDescStatsReply desc, OFVersion ofv) {
         this.dpid = dpid;
         this.dpid = dpid;
@@ -96,16 +98,21 @@ public abstract class AbstractOpenFlowSwitch extends AbstractHandlerBehaviour
     }
     }
 
 
     @Override
     @Override
-    public void sendMsg(OFMessage m) {
-        if (role == RoleState.MASTER && channel.isConnected()) {
-            channel.write(Collections.singletonList(m));
-        }
+    public void sendMsg(OFMessage msg) {
+        this.sendMsg(Collections.singletonList(msg));
     }
     }
 
 
     @Override
     @Override
     public final void sendMsg(List<OFMessage> msgs) {
     public final void sendMsg(List<OFMessage> msgs) {
         if (role == RoleState.MASTER && channel.isConnected()) {
         if (role == RoleState.MASTER && channel.isConnected()) {
             channel.write(msgs);
             channel.write(msgs);
+        } else if (messagesPendingMastership != null) {
+            messagesPendingMastership.addAll(msgs);
+            log.debug("Enqueue message for switch {}. queue size after is {}",
+                      dpid, messagesPendingMastership.size());
+        } else {
+            log.warn("Dropping message for switch {} (role: {}, connected: {}): {}",
+                     dpid, role, channel.isConnected(), msgs);
         }
         }
     }
     }
 
 
@@ -232,6 +239,12 @@ public abstract class AbstractOpenFlowSwitch extends AbstractHandlerBehaviour
     @Override
     @Override
     public final void transitionToMasterSwitch() {
     public final void transitionToMasterSwitch() {
         this.agent.transitionToMasterSwitch(dpid);
         this.agent.transitionToMasterSwitch(dpid);
+        if (messagesPendingMastership != null) {
+            this.sendMsg(messagesPendingMastership);
+            log.debug("Sending {} pending messages to switch {}",
+                     messagesPendingMastership.size(), dpid);
+            messagesPendingMastership = null;
+        }
     }
     }
 
 
     @Override
     @Override
@@ -278,6 +291,11 @@ public abstract class AbstractOpenFlowSwitch extends AbstractHandlerBehaviour
                 log.debug("Sending role {} to switch {}", role, getStringId());
                 log.debug("Sending role {} to switch {}", role, getStringId());
                 if (role == RoleState.SLAVE || role == RoleState.EQUAL) {
                 if (role == RoleState.SLAVE || role == RoleState.EQUAL) {
                     this.role = role;
                     this.role = role;
+                } else {
+                    if (messagesPendingMastership == null) {
+                        log.debug("Initializing new queue for switch {}", dpid);
+                        messagesPendingMastership = new ArrayList<>();
+                    }
                 }
                 }
             } else {
             } else {
                 this.role = role;
                 this.role = role;