From 89fd7625fe97bbcf30d669d38b8ff86697c6c15e Mon Sep 17 00:00:00 2001 From: boris Date: Fri, 13 Mar 2015 13:38:19 +0000 Subject: [PATCH] Synchronize access to the Agent's state. Harden state checks to avoid bugs due to race conditions. Don't fire state change events unless the state indeed changed. Improve logging. --- src/org/ice4j/ice/Agent.java | 40 +++++++++++++++++++++++++++--------- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/src/org/ice4j/ice/Agent.java b/src/org/ice4j/ice/Agent.java index bcc039c..76ec174 100644 --- a/src/org/ice4j/ice/Agent.java +++ b/src/org/ice4j/ice/Agent.java @@ -208,6 +208,11 @@ public class Agent */ private IceProcessingState state = IceProcessingState.WAITING; + /** + * Object used to synchronize access to {@link #state}. + */ + private final Object stateSyncRoot = new Object(); + /** * Contains {@link PropertyChangeListener}s registered with this {@link * Agent} and following its changes of state. @@ -718,13 +723,28 @@ public class Agent * newState and triggers the corresponding change event. * * @param newState the new state of ICE processing for this Agent. + * @return true iff the state of this Agent changed as + * a result of this call. */ - private void setState(IceProcessingState newState) + private boolean setState(IceProcessingState newState) { - IceProcessingState oldState = state; + IceProcessingState oldState; + synchronized (stateSyncRoot) + { + oldState = state; + this.state = newState; + } - this.state = newState; - fireStateChange(oldState, newState); + if (!oldState.equals(newState)) + { + logger.info("ICE state changed from " + oldState + " to " + + newState); + fireStateChange(oldState, newState); + + return true; + } + + return false; } /** @@ -1705,7 +1725,6 @@ public class Agent if(!atLeastOneListSucceeded) { //all lists ended but none succeeded. No love today ;( - logger.info("ICE state is FAILED"); terminate(IceProcessingState.FAILED); return; } @@ -1718,13 +1737,15 @@ public class Agent return; } - logger.info("ICE state is COMPLETED"); - - setState(IceProcessingState.COMPLETED); + // The race condition in which another thread enters COMPLETED right + // under our nose here has been observed (and not in a single instance) + // So check that we did indeed just trigger the change. + if (!setState(IceProcessingState.COMPLETED)) + return; // keep ICE running (answer STUN Binding requests, send STUN Binding // indications or requests) - if(stunKeepAliveThread == null + if (stunKeepAliveThread == null && !StackProperties.getBoolean( StackProperties.NO_KEEP_ALIVES, false)) @@ -2017,7 +2038,6 @@ public class Agent } } - logger.info("ICE state is TERMINATED"); terminate(IceProcessingState.TERMINATED); synchronized (terminationThreadSyncRoot)