Author: markt
Date: Mon Sep 5 14:18:53 2016
New Revision: 1759275
URL: http://svn.apache.org/viewvc?rev=1759275&view=rev
Log:
Refactor the code that implements the requirement that a call to complete() or
dispatch() made from a non-container thread before the container initiated
thread that called startAsync() completes must be delayed until the container
initiated thread has completed. Rather than implementing this by blocking the
non-container thread, extend the internal state machine to track this. This
removes the possibility that blocking the non-container thread could trigger a
deadlock.
Modified:
tomcat/tc8.5.x/trunk/ (props changed)
tomcat/tc8.5.x/trunk/java/org/apache/coyote/AsyncStateMachine.java
tomcat/tc8.5.x/trunk/webapps/docs/changelog.xml
Propchange: tomcat/tc8.5.x/trunk/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Sep 5 14:18:53 2016
@@ -1 +1 @@
-/tomcat/trunk:1734785,1734799,1734845,1734928,1735041,1735044,1735480,1735577,1735597,1735599-1735600,1735615,1736145,1736162,1736209,1736280,1736297,1736299,1736489,1736646,1736703,1736836,1736849,1737104-1737105,1737112,1737117,1737119-1737120,1737155,1737157,1737192,1737280,1737339,1737632,1737664,1737715,1737748,1737785,1737834,1737860,1737903,1737959,1738005,1738007,1738014-1738015,1738018,1738022,1738039,1738043,1738059-1738060,1738147,1738149,1738174-1738175,1738261,1738589,1738623-1738625,1738643,1738816,1738850,1738855,1738946-1738948,1738953-1738954,1738979,1738982,1739079-1739081,1739087,1739113,1739153,1739172,1739176,1739191,1739474,1739726,1739762,1739775,1739814,1739817-1739818,1739975,1740131,1740324,1740465,1740495,1740508-1740509,1740520,1740535,1740707,1740803,1740810,1740969,1740980,1740991,1740997,1741015,1741033,1741036,1741058,1741060,1741080,1741147,1741159,1741164,1741173,1741181,1741190,1741197,1741202,1741208,1741213,1741221,1741225,1741232,1741409,1741501
,1741677,1741892,1741896,1741984,1742023,1742042,1742071,1742090,1742093,1742101,1742105,1742111,1742139,1742146,1742148,1742166,1742181,1742184,1742187,1742246,1742248-1742251,1742263-1742264,1742268,1742276,1742369,1742387,1742448,1742509-1742512,1742917,1742919,1742933,1742975-1742976,1742984,1742986,1743019,1743115,1743117,1743124-1743125,1743134,1743425,1743554,1743679,1743696-1743698,1743700-1743701,1744058,1744064-1744065,1744125,1744194,1744229,1744270,1744323,1744432,1744684,1744697,1744705,1744713,1744760,1744786,1745083,1745142-1745143,1745145,1745177,1745179-1745180,1745227,1745248,1745254,1745337,1745467,1745473,1745576,1745735,1745744,1746304,1746306-1746307,1746319,1746327,1746338,1746340-1746341,1746344,1746427,1746441,1746473,1746490,1746492,1746495-1746496,1746499-1746501,1746503-1746507,1746509,1746549,1746551,1746554,1746556,1746558,1746584,1746620,1746649,1746724,1746939,1746989,1747014,1747028,1747035,1747210,1747225,1747234,1747253,1747404,1747506,1747536,1747
924,1747980,1747993,1748001,1748253,1748452,1748547,1748629,1748676,1748715,1749287,1749296,1749328,1749373,1749465,1749506,1749508,1749665-1749666,1749763,1749865-1749866,1749898,1749978,1749980,1750011,1750015,1750056,1750480,1750617,1750634,1750692,1750697,1750700,1750703,1750707,1750714,1750718,1750723,1750774,1750899,1750975,1750995,1751061,1751097,1751173,1751438,1751447,1751463,1751702,1752212,1752737,1752745,1753078,1753080,1753358,1753363,1754111,1754140-1754141,1754281,1754310,1754445,1754467,1754494,1754496,1754528,1754532-1754533,1754613,1754714,1754874,1754941,1754944,1754950-1754951,1755005,1755007,1755009,1755132,1755180-1755181,1755185,1755190,1755204-1755206,1755208,1755214,1755224,1755227,1755230,1755629,1755646-1755647,1755650,1755653,1755675,1755680,1755683,1755693,1755717,1755731-1755737,1755812,1755828,1755884,1755890,1755918-1755919,1755942,1755958,1755960,1755970,1755993,1756013,1756019,1756039,1756056,1756083-1756114,1756175,1756288-1756289,1756408-1756410,1
756778,1756798,1756878,1756898,1756939,1757123-1757124,1757126,1757128,1757132-1757133,1757136,1757145,1757167-1757168,1757175,1757180,1757182,1757195,1757271,1757278,1757347,1757353-1757354,1757363,1757374,1757399,1757406,1757408,1757485,1757495,1757499,1757527,1757578,1757684,1757722,1757727,1757853,1757903,1757997,1758072-1758075,1758078-1758079,1758292,1758369,1758423,1758425-1758427,1758430,1758459,1758483,1758486-1758487,1758499,1758525,1758556,1758582,1758584,1758588,1758842,1759019,1759212,1759224,1759227,1759252
+/tomcat/trunk:1734785,1734799,1734845,1734928,1735041,1735044,1735480,1735577,1735597,1735599-1735600,1735615,1736145,1736162,1736209,1736280,1736297,1736299,1736489,1736646,1736703,1736836,1736849,1737104-1737105,1737112,1737117,1737119-1737120,1737155,1737157,1737192,1737280,1737339,1737632,1737664,1737715,1737748,1737785,1737834,1737860,1737903,1737959,1738005,1738007,1738014-1738015,1738018,1738022,1738039,1738043,1738059-1738060,1738147,1738149,1738174-1738175,1738261,1738589,1738623-1738625,1738643,1738816,1738850,1738855,1738946-1738948,1738953-1738954,1738979,1738982,1739079-1739081,1739087,1739113,1739153,1739172,1739176,1739191,1739474,1739726,1739762,1739775,1739814,1739817-1739818,1739975,1740131,1740324,1740465,1740495,1740508-1740509,1740520,1740535,1740707,1740803,1740810,1740969,1740980,1740991,1740997,1741015,1741033,1741036,1741058,1741060,1741080,1741147,1741159,1741164,1741173,1741181,1741190,1741197,1741202,1741208,1741213,1741221,1741225,1741232,1741409,1741501
,1741677,1741892,1741896,1741984,1742023,1742042,1742071,1742090,1742093,1742101,1742105,1742111,1742139,1742146,1742148,1742166,1742181,1742184,1742187,1742246,1742248-1742251,1742263-1742264,1742268,1742276,1742369,1742387,1742448,1742509-1742512,1742917,1742919,1742933,1742975-1742976,1742984,1742986,1743019,1743115,1743117,1743124-1743125,1743134,1743425,1743554,1743679,1743696-1743698,1743700-1743701,1744058,1744064-1744065,1744125,1744194,1744229,1744270,1744323,1744432,1744684,1744697,1744705,1744713,1744760,1744786,1745083,1745142-1745143,1745145,1745177,1745179-1745180,1745227,1745248,1745254,1745337,1745467,1745473,1745576,1745735,1745744,1746304,1746306-1746307,1746319,1746327,1746338,1746340-1746341,1746344,1746427,1746441,1746473,1746490,1746492,1746495-1746496,1746499-1746501,1746503-1746507,1746509,1746549,1746551,1746554,1746556,1746558,1746584,1746620,1746649,1746724,1746939,1746989,1747014,1747028,1747035,1747210,1747225,1747234,1747253,1747404,1747506,1747536,1747
924,1747980,1747993,1748001,1748253,1748452,1748547,1748629,1748676,1748715,1749287,1749296,1749328,1749373,1749465,1749506,1749508,1749665-1749666,1749763,1749865-1749866,1749898,1749978,1749980,1750011,1750015,1750056,1750480,1750617,1750634,1750692,1750697,1750700,1750703,1750707,1750714,1750718,1750723,1750774,1750899,1750975,1750995,1751061,1751097,1751173,1751438,1751447,1751463,1751702,1752212,1752737,1752745,1753078,1753080,1753358,1753363,1754111,1754140-1754141,1754281,1754310,1754445,1754467,1754494,1754496,1754528,1754532-1754533,1754613,1754714,1754874,1754941,1754944,1754950-1754951,1755005,1755007,1755009,1755132,1755180-1755181,1755185,1755190,1755204-1755206,1755208,1755214,1755224,1755227,1755230,1755629,1755646-1755647,1755650,1755653,1755675,1755680,1755683,1755693,1755717,1755731-1755737,1755812,1755828,1755884,1755890,1755918-1755919,1755942,1755958,1755960,1755970,1755993,1756013,1756019,1756039,1756056,1756083-1756114,1756175,1756288-1756289,1756408-1756410,1
756778,1756798,1756878,1756898,1756939,1757123-1757124,1757126,1757128,1757132-1757133,1757136,1757145,1757167-1757168,1757175,1757180,1757182,1757195,1757271,1757278,1757347,1757353-1757354,1757363,1757374,1757399,1757406,1757408,1757485,1757495,1757499,1757527,1757578,1757684,1757722,1757727,1757853,1757903,1757997,1758072-1758075,1758078-1758079,1758292,1758369,1758423,1758425-1758427,1758430,1758459,1758483,1758486-1758487,1758499,1758525,1758556,1758582,1758584,1758588,1758842,1759019,1759212,1759224,1759227,1759252,1759274
Modified: tomcat/tc8.5.x/trunk/java/org/apache/coyote/AsyncStateMachine.java
URL:
http://svn.apache.org/viewvc/tomcat/tc8.5.x/trunk/java/org/apache/coyote/AsyncStateMachine.java?rev=1759275&r1=1759274&r2=1759275&view=diff
==============================================================================
--- tomcat/tc8.5.x/trunk/java/org/apache/coyote/AsyncStateMachine.java [UTF-8]
(original)
+++ tomcat/tc8.5.x/trunk/java/org/apache/coyote/AsyncStateMachine.java [UTF-8]
Mon Sep 5 14:18:53 2016
@@ -29,28 +29,44 @@ import org.apache.tomcat.util.security.P
*
* <pre>
* The internal states that are used are:
- * DISPATCHED - Standard request. Not in Async mode.
- * STARTING - ServletRequest.startAsync() has been called but the
- * request in which that call was made has not finished
- * processing.
- * STARTED - ServletRequest.startAsync() has been called and the
- * request in which that call was made has finished
- * processing.
- * READ_WRITE_OP - Performing an asynchronous read or write.
- * MUST_COMPLETE - complete() has been called before the request in which
- * ServletRequest.startAsync() has finished. As soon as that
- * request finishes, the complete() will be processed.
- * COMPLETING - The call to complete() was made once the request was in
- * the STARTED state. May or may not be triggered by a
- * container thread - depends if start(Runnable) was used
- * TIMING_OUT - The async request has timed out and is waiting for a call
- * to complete(). If that isn't made, the error state will
- * entered.
- * MUST_DISPATCH - dispatch() has been called before the request in which
- * ServletRequest.startAsync() has finished. As soon as that
- * request finishes, the dispatch() will be processed.
- * DISPATCHING - The dispatch is being processed.
- * ERROR - Something went wrong.
+ * DISPATCHED - Standard request. Not in Async mode.
+ * STARTING - ServletRequest.startAsync() has been called but the
+ * request in which that call was made has not finished
+ * processing.
+ * STARTED - ServletRequest.startAsync() has been called and the
+ * request in which that call was made has finished
+ * processing.
+ * READ_WRITE_OP - Performing an asynchronous read or write.
+ * MUST_COMPLETE - ServletRequest.startAsync() followed by complete() have
+ * been called during a single Servlet.service() method. The
+ * complete() will be processed as soon as the request
+ * finishes.
+ * COMPLETE_PENDING - ServletRequest.startAsync() has been called and before
the
+ * request in which that call was had finished processing,
+ * complete() was called for a non-container thread. The
+ * complete() will be processed as soon as the request
+ * finishes. This is different to MUST_COMPLETE because of
+ * differences required to avoid race conditions during
error
+ * handling.
+ * COMPLETING - The call to complete() was made once the request was in
+ * the STARTED state. May or may not be triggered by a
+ * container thread - depends if start(Runnable) was used.
+ * TIMING_OUT - The async request has timed out and is waiting for a call
+ * to complete(). If that isn't made, the error state will
+ * entered.
+ * MUST_DISPATCH - ServletRequest.startAsync() followed by dispatch() have
+ * been called during a single Servlet.service() method. The
+ * dispatch() will be processed as soon as the request
+ * finishes.
+ * DISPATCH_PENDING - ServletRequest.startAsync() has been called and before
the
+ * request in which that call was had finished processing,
+ * dispatch() was called for a non-container thread. The
+ * dispatch() will be processed as soon as the request
+ * finishes. This is different to MUST_DISPATCH because of
+ * differences required to avoid race conditions during
error
+ * handling.
+ * DISPATCHING - The dispatch is being processed.
+ * ERROR - Something went wrong.
*
* |-----------------»------|
* | \|/
@@ -63,29 +79,33 @@ import org.apache.tomcat.util.security.P
* | | | | |--|timeout() |
|
* | | | post() | | \|/ | post()
|
* | | | |---------- | --»DISPATCHED«---------- |
--------------COMPLETING«-----| |
- * | | | | | /|\/|\ | | |
/|\ | |
- * | | | | |---»- | ---| | | | |--|
| |
- * | | ^ ^ | | | |startAsync() |
timeout() | |
- * | | | | | |-- \ -----| | |
| |
- * | | | | | | \ | |
| |
- * | | | | | | \ | |
| |
- * | | | | | ^ \ | |
| |
- * | \|/ | | | | \ \|/ post() |
| |
+ * | | | | | /|\/|\ | | | /|\
/|\ | |
+ * | | | | |---»- | ---| | |startAsync() | timeout()|--|
| | |
+ * | | ^ ^ | | | | |
| | |
+ * | | | | | |-- \ -----| | complete() |
|post() | |
+ * | | | | | | \ | /--»----- |
---COMPLETE_PENDING-»-| | |
+ * | | | | | | \ | / |
| |
+ * | | | | | ^ \ | / |
| |
+ * | \|/ | | | | \ \|/ / post() |
| |
* | MUST_COMPLETE-«- | - | --«----STARTING--»--------- | -------------|
^ |
- * | /|\ /|\ | | complete() | | |
complete() | |
- * | | | | | | | post() |
/----------| |
- * | | | ^ | |dispatch() | |-----| | /
|
- * | | | | | | | | | | /
|
- * | | | | | \|/ | | \|/ \|/ /
post() |
+ * | /|\ /|\ | | complete() | \ | |
complete() | |
+ * | | | | | | \ | post() |
/----------| |
+ * | | | ^ | dispatch()| \ | |-----| | /
|
+ * | | | | | | \ | | | | /
|
+ * | | | | | \|/ \ | | \|/ \|/ /
post() |
* | | | | |--«--MUST_DISPATCH-----«-----|
|--«--STARTED«---------«---------| |
- * | | | | dispatched() /|\ | / | |
| |
- * | | | | | |post() / | |
^ |
- * ^ | ^ | | | / |
|asyncOperation() | |
- * | | | ^ | | / | |
| |
- * | | | | | | |-------------/ |
|»-READ_WRITE_OP--»---| |
- * | | | | | | | dispatch() |
| | | |
- * | | | |post() | | | timeout()|
| | | error()|
- * | | | |dispatched() | \|/ \|/ |
dispatch()| | |-»--------|
+ * | | | | dispatched() /|\ | \ / | |
| |
+ * | | | | | | \ / | |
| |
+ * | | | | | | \ / | |
| |
+ * | | | | | |post() \ | | |
^ |
+ * ^ | ^ | | | \|/ | |
|asyncOperation() | |
+ * | | | ^ | | DISPATCH_PENDING | | |
| |
+ * | | | | | | |post() | | |
| |
+ * | | | | | | | |----------| |
|»-READ_WRITE_OP--»---| |
+ * | | | | | | | | dispatch() |
| | | |
+ * | | | | | | | | |
| | | |
+ * | | | |post() | | | | timeout()|
| | | error()|
+ * | | | |dispatched() | \|/\|/ \|/ |
dispatch()| | |-»--------|
* | | | |---«---------- | ---DISPATCHING«-----«------ |
------«----| |
* | | | | | ^ |
|
* | | | | |----| |
|
@@ -111,30 +131,30 @@ public class AsyncStateMachine {
private static final StringManager sm =
StringManager.getManager(AsyncStateMachine.class);
private static enum AsyncState {
- DISPATCHED (false, false, false, false, false),
- STARTING (true, true, false, false, true),
- STARTED (true, true, false, false, false),
- MUST_COMPLETE(true, true, true, false, false),
- COMPLETING (true, false, true, false, false),
- TIMING_OUT (true, true, false, false, false),
- MUST_DISPATCH(true, true, false, true, false),
- DISPATCHING (true, false, false, true, false),
- READ_WRITE_OP(true, true, false, false, true),
- ERROR (true, true, false, false, false);
+ DISPATCHED (false, false, false, false),
+ STARTING (true, true, false, false),
+ STARTED (true, true, false, false),
+ MUST_COMPLETE (true, true, true, false),
+ COMPLETE_PENDING(true, true, false, false),
+ COMPLETING (true, false, true, false),
+ TIMING_OUT (true, true, false, false),
+ MUST_DISPATCH (true, true, false, true),
+ DISPATCH_PENDING(true, true, false, false),
+ DISPATCHING (true, false, false, true),
+ READ_WRITE_OP (true, true, false, false),
+ ERROR (true, true, false, false);
private final boolean isAsync;
private final boolean isStarted;
private final boolean isCompleting;
private final boolean isDispatching;
- private final boolean pauseNonContainerThread;
private AsyncState(boolean isAsync, boolean isStarted, boolean
isCompleting,
- boolean isDispatching, boolean pauseNonContainerThread) {
+ boolean isDispatching) {
this.isAsync = isAsync;
this.isStarted = isStarted;
this.isCompleting = isCompleting;
this.isDispatching = isDispatching;
- this.pauseNonContainerThread = pauseNonContainerThread;
}
public boolean isAsync() {
@@ -152,10 +172,6 @@ public class AsyncStateMachine {
public boolean isCompleting() {
return isCompleting;
}
-
- public boolean getPauseNonContainerThread() {
- return pauseNonContainerThread;
- }
}
@@ -234,14 +250,13 @@ public class AsyncStateMachine {
* complete() or dispatch().
*/
public synchronized SocketState asyncPostProcess() {
-
- // Unpause any non-container threads that may be waiting for this
- // container thread to complete this method. Note because of the syncs
- // those non-container threads won't start back up until until this
- // method exits.
- notifyAll();
-
- if (state == AsyncState.STARTING || state == AsyncState.READ_WRITE_OP)
{
+ if (state == AsyncState.COMPLETE_PENDING) {
+ doComplete();
+ return SocketState.ASYNC_END;
+ } else if (state == AsyncState.DISPATCH_PENDING) {
+ doDispatch();
+ return SocketState.ASYNC_END;
+ } else if (state == AsyncState.STARTING || state ==
AsyncState.READ_WRITE_OP) {
state = AsyncState.STARTED;
return SocketState.LONG;
} else if (state == AsyncState.MUST_COMPLETE || state ==
AsyncState.COMPLETING) {
@@ -267,13 +282,22 @@ public class AsyncStateMachine {
public synchronized boolean asyncComplete() {
- pauseNonContainerThread();
+ if (!ContainerThreadMarker.isContainerThread() && state ==
AsyncState.STARTING) {
+ state = AsyncState.COMPLETE_PENDING;
+ return false;
+ } else {
+ return doComplete();
+ }
+ }
+
+
+ private synchronized boolean doComplete() {
clearNonBlockingListeners();
boolean doComplete = false;
if (state == AsyncState.STARTING || state == AsyncState.TIMING_OUT ||
state == AsyncState.ERROR || state ==
AsyncState.READ_WRITE_OP) {
state = AsyncState.MUST_COMPLETE;
- } else if (state == AsyncState.STARTED) {
+ } else if (state == AsyncState.STARTED || state ==
AsyncState.COMPLETE_PENDING) {
state = AsyncState.COMPLETING;
doComplete = true;
} else {
@@ -304,7 +328,16 @@ public class AsyncStateMachine {
public synchronized boolean asyncDispatch() {
- pauseNonContainerThread();
+ if (!ContainerThreadMarker.isContainerThread() && state ==
AsyncState.STARTING) {
+ state = AsyncState.DISPATCH_PENDING;
+ return false;
+ } else {
+ return doDispatch();
+ }
+ }
+
+
+ private synchronized boolean doDispatch() {
boolean doDispatch = false;
if (state == AsyncState.STARTING ||
state == AsyncState.TIMING_OUT ||
@@ -312,7 +345,7 @@ public class AsyncStateMachine {
// In these three cases processing is on a container thread so no
// need to transfer processing to a new container thread
state = AsyncState.MUST_DISPATCH;
- } else if (state == AsyncState.STARTED) {
+ } else if (state == AsyncState.STARTED || state ==
AsyncState.DISPATCH_PENDING) {
state = AsyncState.DISPATCHING;
// A dispatch is always required.
// If on a non-container thread, need to get back onto a container
@@ -427,24 +460,4 @@ public class AsyncStateMachine {
processor.getRequest().listener = null;
processor.getRequest().getResponse().listener = null;
}
-
-
- /*
- * startAsync() has been called but the container thread where this was
- * called has not completed processing. To avoid various race conditions -
- * including several related to error page handling - pause this
- * non-container thread until the container thread has finished processing.
- * The non-container thread will be paused until the container thread
- * completes asyncPostProcess().
- */
- private synchronized void pauseNonContainerThread() {
- while (!ContainerThreadMarker.isContainerThread() &&
- state.getPauseNonContainerThread()) {
- try {
- wait();
- } catch (InterruptedException e) {
- // TODO Log this?
- }
- }
- }
}
Modified: tomcat/tc8.5.x/trunk/webapps/docs/changelog.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc8.5.x/trunk/webapps/docs/changelog.xml?rev=1759275&r1=1759274&r2=1759275&view=diff
==============================================================================
--- tomcat/tc8.5.x/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/tc8.5.x/trunk/webapps/docs/changelog.xml Mon Sep 5 14:18:53 2016
@@ -54,6 +54,20 @@
</add>
</changelog>
</subsection>
+ <subsection name="Coyote">
+ <changelog>
+ <add>
+ Refactor the code that implements the requirement that a call to
+ <code>complete()</code> or <code>dispatch()</code> made from a
+ non-container thread before the container initiated thread that called
+ <code>startAsync()</code> completes must be delayed until the container
+ initiated thread has completed. Rather than implementing this by
+ blocking the non-container thread, extend the internal state machine to
+ track this. This removes the possibility that blocking the
non-container
+ thread could trigger a deadlock. (markt)
+ </add>
+ </changelog>
+ </subsection>
<subsection name="Other">
<changelog>
<fix>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
