You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by re...@apache.org on 2015/04/10 14:13:15 UTC

svn commit: r1672626 - in /tomcat/tc8.0.x/trunk: java/org/apache/tomcat/util/net/SecureNio2Channel.java webapps/docs/changelog.xml

Author: remm
Date: Fri Apr 10 12:13:15 2015
New Revision: 1672626

URL: http://svn.apache.org/r1672626
Log:
Merge patch from r1672297.
Investigating 57799 I found some issues in the SSL impl:
- Possibly incomplete writes.
- After some errors (which shouldn't happen however), the pending flag could still be set.
- A bad idea to deal with possible behavior differences for read IO calls between NIO and NIO2 (according to my testing, it doesn't seem to be needed). Test: the byte counter.

Modified:
    tomcat/tc8.0.x/trunk/java/org/apache/tomcat/util/net/SecureNio2Channel.java   (contents, props changed)
    tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml

Modified: tomcat/tc8.0.x/trunk/java/org/apache/tomcat/util/net/SecureNio2Channel.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/tomcat/util/net/SecureNio2Channel.java?rev=1672626&r1=1672625&r2=1672626&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/tomcat/util/net/SecureNio2Channel.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/tomcat/util/net/SecureNio2Channel.java Fri Apr 10 12:13:15 2015
@@ -477,26 +477,29 @@ public class SecureNio2Channel extends N
     }
 
     private class FutureRead implements Future<Integer> {
-        private ByteBuffer dst;
+        private final ByteBuffer dst;
+        private final Future<Integer> integer;
         public FutureRead(ByteBuffer dst) {
             this.dst = dst;
+            this.integer = sc.read(netInBuffer);
         }
         @Override
         public boolean cancel(boolean mayInterruptIfRunning) {
-            return false;
+            readPending = false;
+            return integer.cancel(mayInterruptIfRunning);
         }
         @Override
         public boolean isCancelled() {
-            return false;
+            return integer.isCancelled();
         }
         @Override
         public boolean isDone() {
-            return true;
+            return integer.isDone();
         }
         @Override
         public Integer get() throws InterruptedException, ExecutionException {
             try {
-                return unwrap(netInBuffer.position());
+                return unwrap(integer.get().intValue());
             } finally {
                 readPending = false;
             }
@@ -506,17 +509,17 @@ public class SecureNio2Channel extends N
                 throws InterruptedException, ExecutionException,
                 TimeoutException {
             try {
-                return unwrap(netInBuffer.position());
+                return unwrap(integer.get(timeout, unit).intValue());
             } finally {
                 readPending = false;
             }
         }
-        protected Integer unwrap(int netread) throws ExecutionException {
+        private Integer unwrap(int nRead) throws ExecutionException {
             //are we in the middle of closing or closed?
             if (closing || closed)
                 return Integer.valueOf(-1);
             //did we reach EOF? if so send EOF up one layer.
-            if (netread == -1)
+            if (nRead < 0)
                 return Integer.valueOf(-1);
             //the data read
             int read = 0;
@@ -533,16 +536,18 @@ public class SecureNio2Channel extends N
                 }
                 //compact the buffer
                 netInBuffer.compact();
-                if (unwrap.getStatus()==Status.OK || unwrap.getStatus()==Status.BUFFER_UNDERFLOW) {
+                if (unwrap.getStatus() == Status.OK || unwrap.getStatus() == Status.BUFFER_UNDERFLOW) {
                     //we did receive some data, add it to our total
                     read += unwrap.bytesProduced();
                     //perform any tasks if needed
-                    if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_TASK)
+                    if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_TASK) {
                         tasks();
+                    }
                     //if we need more network data, then bail out for now.
-                    if (unwrap.getStatus() == Status.BUFFER_UNDERFLOW)
+                    if (unwrap.getStatus() == Status.BUFFER_UNDERFLOW) {
                         break;
-                } else if (unwrap.getStatus()==Status.BUFFER_OVERFLOW && read > 0) {
+                    }
+                } else if (unwrap.getStatus() == Status.BUFFER_OVERFLOW && read > 0) {
                     //buffer overflow can happen, if we have read data, then
                     //empty out the dst buffer before we do another read
                     break;
@@ -557,46 +562,6 @@ public class SecureNio2Channel extends N
         }
     }
 
-    private class FutureNetRead extends FutureRead {
-        private Future<Integer> integer;
-        protected FutureNetRead(ByteBuffer dst) {
-            super(dst);
-            this.integer = sc.read(netInBuffer);
-        }
-        @Override
-        public boolean cancel(boolean mayInterruptIfRunning) {
-            return integer.cancel(mayInterruptIfRunning);
-        }
-        @Override
-        public boolean isCancelled() {
-            return integer.isCancelled();
-        }
-        @Override
-        public boolean isDone() {
-            return integer.isDone();
-        }
-        @Override
-        public Integer get() throws InterruptedException, ExecutionException {
-            try {
-                int netread = integer.get().intValue();
-                return unwrap(netread);
-            } finally {
-                readPending = false;
-            }
-        }
-        @Override
-        public Integer get(long timeout, TimeUnit unit)
-                throws InterruptedException, ExecutionException,
-                TimeoutException {
-            try {
-                int netread = integer.get(timeout, unit).intValue();
-                return unwrap(netread);
-            } finally {
-                readPending = false;
-            }
-        }
-    }
-
     /**
      * Reads a sequence of bytes from this channel into the given buffer.
      *
@@ -606,19 +571,15 @@ public class SecureNio2Channel extends N
      */
     @Override
     public Future<Integer> read(ByteBuffer dst) {
+        if (!handshakeComplete) {
+            throw new IllegalStateException(sm.getString("channel.nio.ssl.incompleteHandshake"));
+        }
         if (readPending) {
             throw new ReadPendingException();
         } else {
             readPending = true;
         }
-        //did we finish our handshake?
-        if (!handshakeComplete)
-            throw new IllegalStateException(sm.getString("channel.nio.ssl.incompleteHandshake"));
-        if (netInBuffer.position() > 0) {
-            return new FutureRead(dst);
-        } else {
-            return new FutureNetRead(dst);
-        }
+        return new FutureRead(dst);
     }
 
     private class FutureWrite implements Future<Integer> {
@@ -637,6 +598,7 @@ public class SecureNio2Channel extends N
         }
         @Override
         public boolean cancel(boolean mayInterruptIfRunning) {
+            writePending = false;
             return integer.cancel(mayInterruptIfRunning);
         }
         @Override
@@ -657,6 +619,9 @@ public class SecureNio2Channel extends N
             if (written == 0) {
                 wrap();
                 return get();
+            } else if (netOutBuffer.hasRemaining()) {
+                integer = sc.write(netOutBuffer);
+                return get();
             } else {
                 writePending = false;
                 return Integer.valueOf(written);
@@ -674,6 +639,9 @@ public class SecureNio2Channel extends N
             if (written == 0) {
                 wrap();
                 return get(timeout, unit);
+            } else if (netOutBuffer.hasRemaining()) {
+                integer = sc.write(netOutBuffer);
+                return get(timeout, unit);
             } else {
                 writePending = false;
                 return Integer.valueOf(written);
@@ -747,8 +715,9 @@ public class SecureNio2Channel extends N
                             if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_TASK)
                                 tasks();
                             //if we need more network data, then bail out for now.
-                            if (unwrap.getStatus() == Status.BUFFER_UNDERFLOW)
+                            if (unwrap.getStatus() == Status.BUFFER_UNDERFLOW) {
                                 break;
+                            }
                         } else if (unwrap.getStatus() == Status.BUFFER_OVERFLOW && read > 0) {
                             //buffer overflow can happen, if we have read data, then
                             //empty out the dst buffer before we do another read
@@ -784,21 +753,15 @@ public class SecureNio2Channel extends N
             handler.completed(Integer.valueOf(-1), attachment);
             return;
         }
-        if (readPending) {
-            throw new ReadPendingException();
-        } else {
-            readPending = true;
-        }
         if (!handshakeComplete) {
             throw new IllegalStateException(sm.getString("channel.nio.ssl.incompleteHandshake"));
         }
-
-        ReadCompletionHandler<A> readCompletionHandler = new ReadCompletionHandler<>(dst, handler);
-        if (netInBuffer.position() > 0 ) {
-            readCompletionHandler.completed(Integer.valueOf(netInBuffer.position()), attachment);
+        if (readPending) {
+            throw new ReadPendingException();
         } else {
-            sc.read(netInBuffer, timeout, unit, attachment, readCompletionHandler);
+            readPending = true;
         }
+        sc.read(netInBuffer, timeout, unit, attachment, new ReadCompletionHandler<>(dst, handler));
     }
 
     @Override

Propchange: tomcat/tc8.0.x/trunk/java/org/apache/tomcat/util/net/SecureNio2Channel.java
------------------------------------------------------------------------------
--- svn:mergeinfo (added)
+++ svn:mergeinfo Fri Apr 10 12:13:15 2015
@@ -0,0 +1 @@
+/tomcat/trunk/java/org/apache/tomcat/util/net/SecureNio2Channel.java:1636524,1637156,1637176,1637188,1637331,1637684,1637695,1638720-1638725,1639653,1640010,1640083-1640084,1640088,1640275,1640322,1640347,1640361,1640365,1640403,1640410,1640652,1640655-1640658,1640688,1640700-1640883,1640903,1640976,1640978,1641000,1641026,1641038-1641039,1641051-1641052,1641058,1641064,1641300,1641369,1641374,1641380,1641486,1641634,1641656-1641692,1641704,1641707-1641718,1641720-1641722,1641735,1641981,1642233,1642280,1642554,1642564,1642595,1642606,1642668,1642679,1642697,1642699,1642766,1643002,1643045,1643054-1643055,1643066,1643121,1643128,1643206,1643209-1643210,1643216,1643249,1643270,1643283,1643309-1643310,1643323,1643365-1643366,1643370-1643371,1643465,1643474,1643536,1643570,1643634,1643649,1643651,1643654,1643675,1643731,1643733-1643734,1643761,1643766,1643814,1643937,1643963,1644017,1644169,1644201-1644203,1644321,1644323,1644516,1644523,1644529,1644535,1644730,1644768,1644784-1644785,
 1644790,1644793,1644815,1644884,1644886,1644890,1644892,1644910,1644924,1644929-1644930,1644935,1644989,1645011,1645247,1645355,1645357-1645358,1645455,1645465,1645469,1645471,1645473,1645475,1645486-1645488,1645626,1645641,1645685,1645743,1645763,1645951-1645953,1645955,1645993,1646098-1646106,1646178,1646220,1646302,1646304,1646420,1646470-1646471,1646476,1646559,1646717-1646723,1646773,1647026,1647042,1647530,1647655,1648304,1648815,1648907,1650081,1650365,1651116,1651120,1651280,1651470,1652938,1652970,1653041,1653471,1653550,1653574,1653797,1653815-1653816,1653819,1653840,1653857,1653888,1653972,1654013,1654030,1654050,1654123,1654148,1654159,1654513,1654515,1654517,1654522,1654524,1654725,1654735,1654766,1654785,1654851-1654852,1654978,1655122-1655124,1655126-1655127,1655129-1655130,1655132-1655133,1655312,1655438,1655441,1655454,1655558,1656087,1656299,1656319,1656331,1656345,1656350,1656590,1656648-1656650,1656657,1657041,1657054,1657374,1657492,1657510,1657565,1657580,16575
 84,1657586,1657589,1657592,1657607,1657609,1657682,1657907,1658207,1658734,1658781,1658790,1658799,1658802,1658804,1658833,1658840,1658966,1659043,1659053,1659059,1659188-1659189,1659216,1659263,1659293,1659304,1659306-1659307,1659382,1659384,1659428,1659471,1659486,1659505,1659516,1659521,1659524,1659559,1659562,1659803,1659806,1659814,1659833,1659862,1659905,1659919,1659948,1659967,1659983-1659984,1660060,1660074,1660077,1660133,1660168,1660331-1660332,1660353,1660358,1660924,1661386,1661867,1661972,1661990,1662200,1662308-1662309,1662548,1662614,1662736,1662985,1662988-1662989,1663264,1663277,1663298,1663534,1663562,1663676,1663715,1663754,1663768,1663772,1663781,1663893,1663995,1664143,1664163,1664174,1664301,1664317,1664347,1664657,1664659,1664710,1664863-1664864,1664866,1665085,1665292,1665559,1665653,1665661,1665672,1665694,1665697,1665736,1665779,1665976-1665977,1665980-1665981,1665985-1665986,1665989,1665998,1666004,1666008,1666013,1666017,1666024,1666116,1666386-1666387,16
 66494,1666496,1666552,1666569,1666579,1666637,1666649,1666757,1666966,1666972,1666985,1666995,1666997,1667292,1667402,1667406,1667546,1667615,1667630,1667636,1667688,1667764,1667871,1668026,1668135,1668193,1668593,1668596,1668630,1668639,1668843,1669353,1669370,1669451,1669800,1669838,1669876,1669882,1670394,1670433,1670591,1670598-1670600,1670610,1670631,1670719,1670724,1670726,1670730,1670940,1671112,1672272,1672284,1672297

Modified: tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml?rev=1672626&r1=1672625&r2=1672626&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml Fri Apr 10 12:13:15 2015
@@ -114,6 +114,18 @@
         is under development for Tomcat 9 and may be back-ported to Tomcat 8
         once complete. (markt)
       </scode>
+      <fix>
+        Possible incomplete writes with SSL NIO2. (remm)
+      </fix>
+      <fix>
+        Incorrect reads with SSL NIO2 caused by a bad strategy for handling IO
+        differences between NIO and NIO2 that don't seem to be justified.
+        (remm)
+      </fix>
+      <fix>
+        After some errors, the pending flags could remain set when using SSL
+        NIO2. (remm)
+      </fix>
     </changelog>
   </subsection>
   <subsection name="Cluster">



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org