Author: kkolinko Date: Wed Oct 19 07:47:53 2011 New Revision: 1186014 URL: http://svn.apache.org/viewvc?rev=1186014&view=rev Log: Merged revisions r1156171, r1184917, r1184919, r1185200, r1186011 from tomcat/trunk: Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=51640 Improve memory leak protection for DriverManager
Modified: tomcat/tc6.0.x/trunk/ (props changed) tomcat/tc6.0.x/trunk/STATUS.txt tomcat/tc6.0.x/trunk/java/org/apache/catalina/core/JreMemoryLeakPreventionListener.java tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml tomcat/tc6.0.x/trunk/webapps/docs/config/listeners.xml tomcat/tc6.0.x/trunk/webapps/docs/jndi-datasource-examples-howto.xml Propchange: tomcat/tc6.0.x/trunk/ ------------------------------------------------------------------------------ --- svn:mergeinfo (original) +++ svn:mergeinfo Wed Oct 19 07:47:53 2011 @@ -1 +1 @@ -/tomcat/trunk:601180,606992,612607,630314,640888,652744,653247,666232,673796,673820,677910,683969,683982,684001,684081,684234,684269-684270,685177,687503,687645,689402,690781,691392,691805,692748,693378,694992,695053,695311,696780,696782,698012,698227,698236,698613,699427,699634,701355,709294,709811,709816,710063,710066,710125,710205,711126,711600,712461,712467,713953,714002,718360,719119,719124,719602,719626,719628,720046,720069,721040,721286,721708,721886,723404,723738,726052,727303,728032,728768,728947,729057,729567,729569,729571,729681,729809,729815,729934,730250,730590,731651,732859,732863,734734,740675,740684,742677,742697,742714,744160,744238,746321,746384,746425,747834,747863,748344,750258,750291,750921,751286-751287,751289,751295,752323,753039,757335,757774,758249,758365,758596,758616,758664,759074,761601,762868,762929,762936-762937,763166,763183,763193,763228,763262,763298,763302,763325,763599,763611,763654,763681,763706,764985,764997,765662,768335,769979,770716,77 0809,770876,772872,776921,776924,776935,776945,777464,777466,777576,777625,778379,778523-778524,781528,781779,782145,782791,783316,783696,783724,783756,783762,783766,783863,783934,784453,784602,784614,785381,785688,785768,785859,786468,786487,786490,786496,786667,787627,787770,787985,789389,790405,791041,791184,791194,791224,791243,791326,791328,791789,792740,793372,793757,793882,793981,794082,794673,794822,795043,795152,795210,795457,795466,797168,797425,797596,797607,802727,802940,804462,804544,804734,805153,809131,809603,810916,810977,812125,812137,812432,813001,813013,813866,814180,814708,814876,815972,816252,817442,817822,819339,819361,820110,820132,820874,820954,821397,828196,828201,828210,828225,828759,830378-830379,830999,831106,831774,831785,831828,831850,831860,832214,832218,833121,833545,834047,835036,835336,836405,881396,881412,883130,883134,883146,883165,883177,883362,883565,884341,885038,885231,885241,885260,885901,885991,886019,888072,889363,889606,889716,8901 39,890265,890349-890350,890417,891185-891187,891583,892198,892341,892415,892464,892555,892812,892814,892817,892843,892887,893321,893493,894580,894586,894805,894831,895013,895045,895057,895191,895392,895703,896370,896384,897380-897381,897776,898126,898256,898468,898527,898555,898558,898718,898836,898906,899284,899348,899420,899653,899769-899770,899783,899788,899792,899916,899918-899919,899935,899949,903916,905020,905151,905722,905728,905735,907311,907513,907538,907652,907819,907825,907864,908002,908721,908754,908759,909097,909206,909212,909525,909636,909869,909875,909887,910266,910370,910442,910471,910485,910974,915226,915737,915861,916097,916141,916157,916170,917598,917633,918093,918489,918594,918684,918787,918792,918799,918803,918885,919851,919914,920025,920055,920298,920449,920596,920824,920840,921444,922010,926716,927062,927621,928482,928695,928732,928798,931709,932357,932967,935105,935983,939491,939551,940064,941356,941463,943112,944409,944416,945231,945808,945835,945841 ,946686,948057,950164,950596,950614,950851,950905,951615,953434,954435,955648,955655,956832,957130,957830,958192,960701,961948,962865,962872,962881,962900,963106,963865,963868,964614,966177-966178,966292,966692,966863,981815,988448,991837,993042,1001955,1002185,1002263,1002274,1002349,1002359,1002362,1002481,1002514,1003461,1003481,1003488,1003556,1003572,1003581,1003861,1004393,1004409,1004415,1004868-1004869,1004912,1005452,1005467,1005647,1005802,1022120,1022134,1022323,1022415,1022606,1022623,1024224,1024251,1026042,1026784,1026912,1026920,1029767,1033415,1033448,1033842,1033897,1037715,1037794,1037887,1037924,1038041,1042022,1042029,1042447,1042452,1042494,1044944,1044987,1050249,1055055,1055236,1055458,1055975,1056264,1056828,1056889,1059881,1061412,1061442,1061446,1062398,1064652,1066244,1066772,1067039,1067139,1069824,1070139,1070420,1070609,1072042,1073393,1075458,1076212,1078409,1078412,1079801,1081334,1088179,1088460,1090022,1094069,1094089,1095138,1097899,1099575 ,1099586,1099772,1099789,1100145,1100822,1101094,1101144,1124680,1130774,1133014,1137862,1137996,1138950,1138953,1140693,1141104,1141441,1142043,1142904,1143134,1143150,1148216,1148471,1152601,1156519,1164567,1167394,1172233-1172234,1172236,1173614,1174353,1175158,1175190,1176799,1177125,1177245,1177850,1177862,1178228,1178233,1185588 +/tomcat/trunk:601180,606992,612607,630314,640888,652744,653247,666232,673796,673820,677910,683969,683982,684001,684081,684234,684269-684270,685177,687503,687645,689402,690781,691392,691805,692748,693378,694992,695053,695311,696780,696782,698012,698227,698236,698613,699427,699634,701355,709294,709811,709816,710063,710066,710125,710205,711126,711600,712461,712467,713953,714002,718360,719119,719124,719602,719626,719628,720046,720069,721040,721286,721708,721886,723404,723738,726052,727303,728032,728768,728947,729057,729567,729569,729571,729681,729809,729815,729934,730250,730590,731651,732859,732863,734734,740675,740684,742677,742697,742714,744160,744238,746321,746384,746425,747834,747863,748344,750258,750291,750921,751286-751287,751289,751295,752323,753039,757335,757774,758249,758365,758596,758616,758664,759074,761601,762868,762929,762936-762937,763166,763183,763193,763228,763262,763298,763302,763325,763599,763611,763654,763681,763706,764985,764997,765662,768335,769979,770716,77 0809,770876,772872,776921,776924,776935,776945,777464,777466,777576,777625,778379,778523-778524,781528,781779,782145,782791,783316,783696,783724,783756,783762,783766,783863,783934,784453,784602,784614,785381,785688,785768,785859,786468,786487,786490,786496,786667,787627,787770,787985,789389,790405,791041,791184,791194,791224,791243,791326,791328,791789,792740,793372,793757,793882,793981,794082,794673,794822,795043,795152,795210,795457,795466,797168,797425,797596,797607,802727,802940,804462,804544,804734,805153,809131,809603,810916,810977,812125,812137,812432,813001,813013,813866,814180,814708,814876,815972,816252,817442,817822,819339,819361,820110,820132,820874,820954,821397,828196,828201,828210,828225,828759,830378-830379,830999,831106,831774,831785,831828,831850,831860,832214,832218,833121,833545,834047,835036,835336,836405,881396,881412,883130,883134,883146,883165,883177,883362,883565,884341,885038,885231,885241,885260,885901,885991,886019,888072,889363,889606,889716,8901 39,890265,890349-890350,890417,891185-891187,891583,892198,892341,892415,892464,892555,892812,892814,892817,892843,892887,893321,893493,894580,894586,894805,894831,895013,895045,895057,895191,895392,895703,896370,896384,897380-897381,897776,898126,898256,898468,898527,898555,898558,898718,898836,898906,899284,899348,899420,899653,899769-899770,899783,899788,899792,899916,899918-899919,899935,899949,903916,905020,905151,905722,905728,905735,907311,907513,907538,907652,907819,907825,907864,908002,908721,908754,908759,909097,909206,909212,909525,909636,909869,909875,909887,910266,910370,910442,910471,910485,910974,915226,915737,915861,916097,916141,916157,916170,917598,917633,918093,918489,918594,918684,918787,918792,918799,918803,918885,919851,919914,920025,920055,920298,920449,920596,920824,920840,921444,922010,926716,927062,927621,928482,928695,928732,928798,931709,932357,932967,935105,935983,939491,939551,940064,941356,941463,943112,944409,944416,945231,945808,945835,945841 ,946686,948057,950164,950596,950614,950851,950905,951615,953434,954435,955648,955655,956832,957130,957830,958192,960701,961948,962865,962872,962881,962900,963106,963865,963868,964614,966177-966178,966292,966692,966863,981815,988448,991837,993042,1001955,1002185,1002263,1002274,1002349,1002359,1002362,1002481,1002514,1003461,1003481,1003488,1003556,1003572,1003581,1003861,1004393,1004409,1004415,1004868-1004869,1004912,1005452,1005467,1005647,1005802,1022120,1022134,1022323,1022415,1022606,1022623,1024224,1024251,1026042,1026784,1026912,1026920,1029767,1033415,1033448,1033842,1033897,1037715,1037794,1037887,1037924,1038041,1042022,1042029,1042447,1042452,1042494,1044944,1044987,1050249,1055055,1055236,1055458,1055975,1056264,1056828,1056889,1059881,1061412,1061442,1061446,1062398,1064652,1066244,1066772,1067039,1067139,1069824,1070139,1070420,1070609,1072042,1073393,1075458,1076212,1078409,1078412,1079801,1081334,1088179,1088460,1090022,1094069,1094089,1095138,1097899,1099575 ,1099586,1099772,1099789,1100145,1100822,1101094,1101144,1124680,1130774,1133014,1137862,1137996,1138950,1138953,1140693,1141104,1141441,1142043,1142904,1143134,1143150,1148216,1148471,1152601,1156171,1156519,1164567,1167394,1172233-1172234,1172236,1173614,1174353,1175158,1175190,1176799,1177125,1177245,1177850,1177862,1178228,1178233,1184917,1184919,1185200,1185588,1186011 Modified: tomcat/tc6.0.x/trunk/STATUS.txt URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/STATUS.txt?rev=1186014&r1=1186013&r2=1186014&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/STATUS.txt (original) +++ tomcat/tc6.0.x/trunk/STATUS.txt Wed Oct 19 07:47:53 2011 @@ -64,16 +64,6 @@ PATCHES PROPOSED TO BACKPORT: - getStuckThreadIds() returns a list of ids. It might be useful to have a similar method that returns Thread.getName() names. -* Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=51640 - Improve memory leak protection for DriverManager - http://svn.apache.org/viewvc?rev=1156171&view=rev - (r1156182 in TC7) - + Documentation updates: - http://svn.apache.org/viewvc?rev=1184917&view=rev - http://svn.apache.org/viewvc?rev=1184919&view=rev - +1: kkolinko, markt, rjung - -1: - * Fix BIO + SSL + Java7 http://svn.apache.org/viewvc?view=revision&revision=1174884 +1: markt, rjung Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/core/JreMemoryLeakPreventionListener.java URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/core/JreMemoryLeakPreventionListener.java?rev=1186014&r1=1186013&r2=1186014&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/java/org/apache/catalina/core/JreMemoryLeakPreventionListener.java (original) +++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/core/JreMemoryLeakPreventionListener.java Wed Oct 19 07:47:53 2011 @@ -23,6 +23,7 @@ import java.lang.reflect.Method; import java.net.MalformedURLException; import java.net.URL; import java.net.URLConnection; +import java.sql.DriverManager; import java.util.StringTokenizer; import javax.imageio.ImageIO; @@ -163,8 +164,8 @@ public class JreMemoryLeakPreventionList } /** - * <code>com.sun.jndi.ldap.LdapPoolManager</code> class spawns a thread when it - * is initialized if the system property + * <code>com.sun.jndi.ldap.LdapPoolManager</code> class spawns a thread when + * it is initialized if the system property * <code>com.sun.jndi.ldap.connect.pool.timeout</code> is greater than 0. * That thread inherits the context class loader of the current thread, so * that there may be a web application class loader leak if the web app @@ -175,7 +176,21 @@ public class JreMemoryLeakPreventionList public void setLdapPoolProtection(boolean ldapPoolProtection) { this.ldapPoolProtection = ldapPoolProtection; } - + + /** + * The first access to {@link DriverManager} will trigger the loading of + * all {@link java.sql.Driver}s in the the current class loader. The web + * application level memory leak protection can take care of this in most + * cases but triggering the loading here has fewer side-effects. + */ + private boolean driverManagerProtection = true; + public boolean isDriverManagerProtection() { + return driverManagerProtection; + } + public void setDriverManagerProtection(boolean driverManagerProtection) { + this.driverManagerProtection = driverManagerProtection; + } + /** * List of comma-separated fully qualified class names to load and initialize during * the startup of this Listener. This allows to pre-load classes that are known to @@ -203,6 +218,14 @@ public class JreMemoryLeakPreventionList ClassLoader.getSystemClassLoader()); /* + * First call to this loads all drivers in the current class + * loader + */ + if (driverManagerProtection) { + DriverManager.getDrivers(); + } + + /* * Several components end up calling: * sun.awt.AppContext.getAppContext() * Modified: tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml?rev=1186014&r1=1186013&r2=1186014&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml (original) +++ tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml Wed Oct 19 07:47:53 2011 @@ -50,6 +50,10 @@ <bug>51550</bug>: Display an error page rather than an empty response for an IllegalStateException caused by too many active sessions. (markt) </fix> + <add> + <bug>51640</bug>: Improve the memory leak prevention for leaks + triggered by java.sql.DriverManager. (markt/kkolinko) + </add> <fix> <bug>51688</bug>: JreMemoryLeakPreventionListener now protects against AWT thread creation. (schultz) Modified: tomcat/tc6.0.x/trunk/webapps/docs/config/listeners.xml URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/config/listeners.xml?rev=1186014&r1=1186013&r2=1186014&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/webapps/docs/config/listeners.xml (original) +++ tomcat/tc6.0.x/trunk/webapps/docs/config/listeners.xml Wed Oct 19 07:47:53 2011 @@ -267,6 +267,14 @@ service:jmx:rmi://<hostname>:10002 protection features managed by other attributes of this Listener.</p> </attribute> + <attribute name="driverManagerProtection" required="false"> + <p>The first use of <code>java.sql.DriverManager</code> will trigger the + loading of JDBC Driver in the the current class loader. The web + application level memory leak protection can take care of this in most + cases but triggering the loading here has fewer side-effects. The + default is <code>true</code>.</p> + </attribute> + <attribute name="gcDaemonProtection" required="false"> <p>Enables protection so that calls to <code>sun.misc.GC.requestLatency(long)</code> triggered by a web Modified: tomcat/tc6.0.x/trunk/webapps/docs/jndi-datasource-examples-howto.xml URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/jndi-datasource-examples-howto.xml?rev=1186014&r1=1186013&r2=1186014&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/webapps/docs/jndi-datasource-examples-howto.xml (original) +++ tomcat/tc6.0.x/trunk/webapps/docs/jndi-datasource-examples-howto.xml Wed Oct 19 07:47:53 2011 @@ -66,6 +66,50 @@ the section about Automatic Application </p> </section> +<section name="DriverManager, the service provider mechanism and memory leaks"> + +<p><code>java.sql.DriverManager</code> supports the +<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/sql/DriverManager.html">service +provider</a> mechanism. However, the implementation is fundamentally broken in +all Java versions for a servlet container environment. +<code>java.sql.DriverManager</code> will only scan the first web application to +use it for JDBC drivers using the service provider mechanism. Any JDBC drivers +present in the web application or any parent class loader will be discovered +correctly (including those in $CATALINA_BASE/lib) but no further scans will be +performed for any other web applications. For example, if there are two web +applications each using a different JDBC driver packaged in WEB-INF/lib, the +service provider mechanism will only work for the first web application to use +DriverManager. The other web application will be required to register the Driver +manually. Given that web application start order is undefined, the service +provider mechanism can not be relied upon for JDBC Driver implementations +packaged in WEB-INF/lib. +</p> + +<p>The <code>java.sql.DriverManager</code> is also a frequent source of memory +leaks. Any Drivers registered with the DriverManager by a web application must +be deregistered when the web application stops. If the service provider +mechanism registers a JDBC driver, it will never deregister it. Tomcat will +attempt to automatically deregister and registered JDBC drivers discovered +when a web application stops. However, it is expected that applications do this +for themselves via a <code>ServletContextListener</code>. +</p> + +<p>There have been reports that the memory leak prevention code that deregisters +JDBC drivers can, in unusual circumstances, trigger a memory leak rather than +fix it. To prevent this, the <a href="config/listeners.html">JRE Memory Leak +Prevention Listener</a> includes protection for the DriverManager. This +protection is enabled by default. Note that a side-effect of enabling this +protection is that while any JDBC Driver implementations packaged with the JVM +or located in $CATALINA_BASE/lib will be correctly discovered by the service +provider mechanism, JDBC Driver implementations packaged in web applications +will not be discovered. It is therefore necessary for applications to manually +register (and deregister) and JDBC drivers they require that are packaged in the +WEB-INF/lib directory. Given the known issues with the service provider +implementation for DriverManager, most web applications will probably be doing +this already.</p> + +</section> + <section name="Database Connection Pool (DBCP) Configurations"> <p>DBCP provides support for JDBC 2.0. On systems using a 1.4 JVM DBCP --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org